@bacons/apple-targets 0.1.6 → 0.1.7

package/README.md

@@ -312,3 +312,82 @@ Some workarounds:
 
 - Prebuild without React Native: `npx expo prebuild --template node_modules/@bacons/apple-targets/prebuild-blank.tgz --clean`
 - If the widget doesn't show on the home screen when building the app, use iOS 18. You can long press the app icon and select the widget display options to transform the app icon into the widget.
+
+## Sharing data between targets
+
+To share values between the app and the target, you must use App Groups and NSUserDefaults. I've added a native module to make the React Native API a bit easier.
+
+### Configuring App Groups
+
+Start by defining an App Group, a good default is `group.<bundle identifier>`. App Groups can be used across apps so you may want something more generic or less generic if you plan on having multiple extensions.
+
+First, define your main App Group entitlement in your `app.json`:
+
+```json
+{
+  "expo": {
+    "ios": {
+      "entitlements": {
+        "com.apple.security.application-groups": ["group.bacon.data"]
+      }
+    },
+    "plugins": ["@bacons/apple-targets"]
+  }
+}
+```
+
+Second, define the same App Group in your target's `expo-target.config.js`:
+
+```js
+/** @type {import('@bacons/apple-targets').ConfigFunction} */
+module.exports = (config) => ({
+  type: "widget",
+  entitlements: {
+    // Use the same app groups:
+    "com.apple.security.application-groups":
+      config.ios.entitlements["com.apple.security.application-groups"],
+  },
+});
+```
+
+Now you can prebuild to generate the entitlements. You may need to create an EAS Build or open Xcode to sync the entitlements.
+
+### Setting shared data
+
+To define shared data, we'll use a native module (`ExtensionStorage`) that interacts with `NSUserDefaults`.
+
+Somewhere in your Expo app, you can set a value:
+
+```js
+import { ExtensionStorage } from "@bacons/apple-targets";
+
+// Create a storage object with the App Group.
+const storage = new ExtensionStorage(
+  // Your app group identifier. Should match the values in the app.json and expo-target.config.json.
+  "group.bacon.data"
+);
+
+// Then you can set data:
+storage.set("myKey", "myValue");
+
+// Finally, you can reload the widget:
+ExtensionStorage.reloadWidget();
+```
+
+`ExtensionStorage` has the following API:
+
+- `set(key: string, value: string | number | Record<string, string | number> | Array<Record<string, string | number>> | undefined): void` - Sets a value in the shared storage for a given key. Setting `undefined` will remove the key.
+- `ExtensionStorage.reloadWidget(name?: string): void` - A static method for reloading the widget. Behind the scenes, this calls `WidgetCenter.shared.reloadAllTimelines()`. If given a name, it will reload a specific widget using `WidgetCenter.shared.reloadTimelines(ofKind: timeline)`.
+
+### Accessing shared data
+
+Assuming this is done using Swift code, you'll access data using `NSUserDefaults` directly. Here's an example of how you might access the data in a widget:
+
+```swift
+let defaults = UserDefaults(suiteName:
+  // Use the App Group from earlier.
+  "group.bacon.data"
+)
+// Access the value you set:
+let index = defaults?.string(forKey: "myKey")
+```

package/app.plugin.js

@@ -1 +1 @@
-module.exports = require('./build')
+module.exports = require("./build/config-plugin");

package/build/ExtensionStorage.d.ts

@@ -0,0 +1,6 @@
+export declare class ExtensionStorage {
+    private readonly appGroup;
+    static reloadWidget(name?: string): void;
+    constructor(appGroup: string);
+    set(key: string, value?: string | number | Record<string, string | number> | Array<Record<string, string | number>>): void;
+}

package/build/ExtensionStorage.js

@@ -0,0 +1,48 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionStorage = void 0;
+// @ts-expect-error
+const ExtensionStorageModule = (_a = expo === null || expo === void 0 ? void 0 : expo.modules) === null || _a === void 0 ? void 0 : _a.ExtensionStorage;
+const nativeModule = ExtensionStorageModule !== null && ExtensionStorageModule !== void 0 ? ExtensionStorageModule : {
+    setInt() { },
+    setString() { },
+    reloadWidget() { },
+    setObject() { },
+    remove() { },
+    setArray() { },
+};
+const originalSetObject = nativeModule.setObject;
+// Sweet API doesn't support doing this natively.
+nativeModule.setObject = (key, value, suite) => {
+    if (Array.isArray(value)) {
+        return nativeModule.setArray(key, value, suite);
+    }
+    return originalSetObject(key, value, suite);
+};
+class ExtensionStorage {
+    static reloadWidget(name) {
+        nativeModule.reloadWidget(name);
+    }
+    constructor(appGroup) {
+        this.appGroup = appGroup;
+    }
+    set(key, value) {
+        if (typeof value === "number") {
+            nativeModule.setInt(key, value, this.appGroup);
+        }
+        else if (Array.isArray(value)) {
+            nativeModule.setArray(key, value, this.appGroup);
+        }
+        else if (typeof value === "string") {
+            nativeModule.setString(key, value, this.appGroup);
+        }
+        else if (value == null) {
+            nativeModule.remove(key, this.appGroup);
+        }
+        else {
+            nativeModule.setObject(key, value, this.appGroup);
+        }
+    }
+}
+exports.ExtensionStorage = ExtensionStorage;

package/expo-module.config.json

@@ -0,0 +1,6 @@
+{
+  "platforms": ["ios"],
+  "ios": {
+    "modules": ["ExtensionStorageModule"]
+  }
+}

package/ios/ExtensionStorage.podspec

@@ -0,0 +1,21 @@
+Pod::Spec.new do |s|
+  s.name           = 'ExtensionStorage'
+  s.version        = '1.0.0'
+  s.summary        = 'A sample project summary'
+  s.description    = 'A sample project description'
+  s.author         = ''
+  s.homepage       = 'https://docs.expo.dev/modules/'
+  s.platform       = :ios, '15.1'
+  s.source         = { git: '' }
+  s.static_framework = true
+
+  s.dependency 'ExpoModulesCore'
+
+  # Swift/Objective-C compatibility
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES',
+    'SWIFT_COMPILATION_MODE' => 'wholemodule'
+  }
+  
+  s.source_files = "**/*.{h,m,mm,swift,hpp,cpp}"
+end

package/ios/ExtensionStorageModule.swift

@@ -0,0 +1,53 @@
+import ExpoModulesCore
+import WidgetKit
+
+public class ExtensionStorageModule: Module {
+    public func definition() -> ModuleDefinition {
+        Name("ExtensionStorage")
+        
+        Function("remove") { (forKey: String, suiteName: String?) in
+            UserDefaults(suiteName: suiteName)?.removeObject(forKey: forKey)
+        }
+        
+        Function("reloadWidget") { (timeline: String?) in
+            if let timeline = timeline {
+                WidgetCenter.shared.reloadTimelines(ofKind: timeline)
+            } else {
+                WidgetCenter.shared.reloadAllTimelines()
+            }
+        }
+        
+        Function("setArray") { (forKey: String, data: [[String: Any]], suiteName: String?) -> Bool in
+            // Convert the incoming array of dictionaries directly to JSON data
+            do {
+                let jsonData = try JSONSerialization.data(withJSONObject: data, options: [])
+                UserDefaults(suiteName: suiteName)?.set(jsonData, forKey: forKey)
+                return true
+            } catch {
+                // If encoding fails for some reason, return false
+                return false
+            }
+        }
+        
+        Function("setObject") { (forKey: String, data: [String: Any], suiteName: String?) -> Bool in
+            do {
+                let jsonData = try JSONSerialization.data(withJSONObject: data, options: [])
+                UserDefaults(suiteName: suiteName)?.set(jsonData, forKey: forKey)
+                return true
+            } catch {
+                // If encoding fails for some reason, return false
+                return false
+            }
+        }
+        
+        Function("setInt") { (key: String, value: Int, group: String?) in
+            let userDefaults = UserDefaults(suiteName: group)
+            userDefaults?.set(value, forKey: key)
+        }
+        
+        Function("setString") { (key: String, value: String, group: String?) in
+            let userDefaults = UserDefaults(suiteName: group)
+            userDefaults?.set(value, forKey: key)
+        }
+    }
+}

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@bacons/apple-targets",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Generate Apple Targets with Expo Prebuild",
-  "main": "build/index.js",
+  "main": "build/ExtensionStorage.js",
+  "types": "build/ExtensionStorage.d.ts",
   "files": [
     "app.plugin.js",
     "build",
+    "ios",
+    "expo-module.config.json",
     "prebuild-blank.tgz"
   ],
   "scripts": {