Merge pull request #742 from atsign-foundation/onboarding-uti-macos

fix: Onboarding UTI for macOS
atsign-foundation · Sep 21, 2023 · f32e1c4 · f32e1c4
2 parents 03f5bb6 + 6614d20
commit f32e1c4
Show file tree

Hide file tree

Showing 20 changed files with 382 additions and 45 deletions.
diff --git a/packages/at_backupkey_flutter/example/macos/Runner/Info.plist b/packages/at_backupkey_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_chat_flutter/example/macos/Runner/Info.plist b/packages/at_chat_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_common_flutter/example/macos/Runner/Info.plist b/packages/at_common_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_contacts_flutter/example/macos/Runner/Info.plist b/packages/at_contacts_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_contacts_group_flutter/example/macos/Runner/Info.plist b/packages/at_contacts_group_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_events_flutter/example/macos/Runner/Info.plist b/packages/at_events_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_follows_flutter/example/ios/Runner/Info.plist b/packages/at_follows_flutter/example/ios/Runner/Info.plist
@@ -45,5 +45,27 @@
 	<true/>
 	<key>UIApplicationSupportsIndirectInputEvents</key>
 	<true/>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_invitation_flutter/example/macos/Runner/Info.plist b/packages/at_invitation_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_location_flutter/example/macos/Runner/Info.plist b/packages/at_location_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_login_flutter/example/ios/Runner/Info.plist b/packages/at_login_flutter/example/ios/Runner/Info.plist
@@ -45,5 +45,27 @@
 	<true/>
 	<key>UIApplicationSupportsIndirectInputEvents</key>
 	<true/>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_notify_flutter/example/macos/Runner/Info.plist b/packages/at_notify_flutter/example/macos/Runner/Info.plist
@@ -28,5 +28,27 @@
 	<string>MainMenu</string>
 	<key>NSPrincipalClass</key>
 	<string>NSApplication</string>
+	<key>UTImportedTypeDeclarations</key>
+	<array>
+		<dict>
+			<key>UTTypeIdentifier</key>
+			<string>com.atsign.atkeys</string>
+			<key>UTTypeConformsTo</key>
+			<array>
+				<string>public.json</string>
+			</array>
+			<key>UTTypeDescription</key>
+			<string>Atsign Cryptographic Key File</string>
+			<key>UTTypeTagSpecification</key>
+			<dict>
+				<key>public.filename-extension</key>
+				<array>
+					<string>atkeys</string>
+				</array>
+			</dict>
+			<key>UTTypeReferenceURL</key>
+			<string>https://github.com/atsign-foundation/at_protocol</string>
+		</dict>
+	</array>
 </dict>
 </plist>
diff --git a/packages/at_onboarding_flutter/README.md b/packages/at_onboarding_flutter/README.md
@@ -136,6 +136,33 @@ and add the following keys:
 <true/>
 ```
 
+Then to ensure that the .atKeys file type is supported by macOS, open
+macos/Runner/Info.plist and add the following array:
+```
+<key>UTImportedTypeDeclarations</key>
+<array>
+  <dict>
+    <key>UTTypeIdentifier</key>
+    <string>com.atsign.atkeys</string>
+    <key>UTTypeConformsTo</key>
+    <array>
+      <string>public.json</string>
+    </array>
+    <key>UTTypeDescription</key>
+    <string>Atsign Cryptographic Key File</string>
+    <key>UTTypeTagSpecification</key>
+    <dict>
+      <key>public.filename-extension</key>
+      <array>
+        <string>atkeys</string>
+      </array>
+    </dict>
+    <key>UTTypeReferenceURL</key>
+    <string>https://github.com/atsign-foundation/at_protocol</string>
+  </dict>
+</array>
+```
+
 </details>
 
 ### 3. Migration guide
@@ -153,14 +180,14 @@ and add the following keys:
 
 ## Usage
 
-| Parameters              | Description                                                                                                                      |
-| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
-| domain                  | Domain can differ based on the environment you are using.Default the plugin connects to 'root.atsign.org' to perform onboarding. |
-| atClientPreference      | The atClientPreference to continue with the onboarding.                                                                          |
-| rootEnvironment         | Permission to access the device's location is allowed even when the App is running in the background.                            |
-| appAPIKey               | API authentication key for getting free atsigns.                                                                                 |
-| isSwitchingAtsign       | Param specifies whether this action is switching atsign or not. Default is false                                                 |
-| atsign                  | The atsign name when change the primary atsign. Default is null                                                                  |
+| Parameters         | Description                                                                                                                      |
+| ------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
+| domain             | Domain can differ based on the environment you are using.Default the plugin connects to 'root.atsign.org' to perform onboarding. |
+| atClientPreference | The atClientPreference to continue with the onboarding.                                                                          |
+| rootEnvironment    | Permission to access the device's location is allowed even when the App is running in the background.                            |
+| appAPIKey          | API authentication key for getting free atsigns.                                                                                 |
+| isSwitchingAtsign  | Param specifies whether this action is switching atsign or not. Default is false                                                 |
+| atsign             | The atsign name when change the primary atsign. Default is null                                                                  |
 
 ```dart
 TextButton