@bacons/apple-targets 0.1.18 → 0.2.0

package/README.md

@@ -178,8 +178,6 @@ The name of the target must match the name of the target directory.
 
 Some files are required to be linked to both your target and the main target. To support this, you can add a top-level `_shared` directory. Any file in this directory will be linked to both the main target and the sub-target. You'll need to re-run prebuild every time you add, rename, or remove a file in this directory.
 
-This is especially useful for Live Activities and Intents.
-
 ## `exportJs`
 
 The `exportJs` option should be used when the target uses React Native (App Clip, Share extension). It works by linking the main target's `Bundle React Native code and images` build phase to the target. This will ensure that production builds (`Release`) bundle the main JS entry file with Metro, and embed the bundle/assets for offline use.
@@ -319,6 +317,7 @@ If you experience issues building widgets, it might be because React Native is s
 
 Some workarounds:
 
+- Clear the SwiftUI previews cache: `xcrun simctl --set previews delete all`
 - 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.
 
@@ -401,6 +400,12 @@ let defaults = UserDefaults(suiteName:
 let index = defaults?.string(forKey: "myKey")
 ```
 
+### More data updates
+
+For more advanced uses, I recommend the following resources:
+
+- Updating widgets when the app is in the background: [Keeping A Widget Up-to-Date](https://developer.apple.com/documentation/widgetkit/keeping-a-widget-up-to-date).
+
 ## Xcode parsing
 
 This plugin makes use of my proprietary Xcode parsing library, [`@bacons/xcode`](https://github.com/evanbacon/xcode). It's mostly typed, very untested, and possibly full of bugs––however, it's still 10x nicer than the alternative.

package/build/config-plugin.js

@@ -38,6 +38,9 @@ const withTargetsDir = (config, _props) => {
         else if (typeof targetConfig !== "object") {
             throw new Error(`Expected target config to be an object or function that returns an object, but got ${typeof targetConfig}`);
         }
+        if (!evaluatedTargetConfigObject.type) {
+            throw new Error(`Expected target config to have a 'type' property denoting the type of target it is, e.g. 'widget'`);
+        }
         config = (0, withWidget_1.default)(config, {
             appleTeamId,
             ...evaluatedTargetConfigObject,

package/build/withWidget.js

@@ -45,30 +45,32 @@ function createLogQueue() {
 }
 // Queue up logs so they only run when prebuild is actually running and not during standard config reads.
 const prebuildLogQueue = createLogQueue();
-function kebabToCamelCase(str) {
-    return str.replace(/-([a-z])/g, function (g) {
-        return g[1].toUpperCase();
-    });
-}
 const withWidget = (config, props) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     prebuildLogQueue.add(() => warnOnce((0, chalk_1.default) `\nUsing experimental Config Plugin {bold @bacons/apple-targets} that is subject to breaking changes.`));
     // TODO: Magically based on the top-level folders in the `ios-widgets/` folder
     if (props.icon && !/https?:\/\//.test(props.icon)) {
         props.icon = path_1.default.join(props.directory, props.icon);
     }
-    const widgetDir = path_1.default
-        .basename(props.directory)
-        .replace(/\/+$/, "")
-        .replace(/^\/+/, "");
-    const widget = kebabToCamelCase(widgetDir);
-    const widgetFolderAbsolutePath = path_1.default.join((_b = (_a = config._internal) === null || _a === void 0 ? void 0 : _a.projectRoot) !== null && _b !== void 0 ? _b : "", props.directory);
+    // This value should be used for the target name and other internal uses.
+    const targetDirName = path_1.default.basename(path_1.default.dirname(props.configPath));
+    // Sanitized for general usage. This name just needs to resemble the input value since it shouldn't be used for user-facing values such as the home screen or app store.
+    const productName = sanitizeNameForNonDisplayUse(props.name || targetDirName) ||
+        sanitizeNameForNonDisplayUse(targetDirName) ||
+        sanitizeNameForNonDisplayUse(props.type);
+    // This should never happen.
+    if (!productName) {
+        throw new Error(`[bacons/apple-targets][${props.type}] Target name does not contain any valid characters: ${targetDirName}`);
+    }
+    // TODO: Are there characters that aren't allowed in `CFBundleDisplayName`?
+    const targetDisplayName = (_a = props.name) !== null && _a !== void 0 ? _a : productName;
+    const targetDirAbsolutePath = path_1.default.join((_c = (_b = config._internal) === null || _b === void 0 ? void 0 : _b.projectRoot) !== null && _c !== void 0 ? _c : "", props.directory);
     const entitlementsFiles = (0, glob_1.sync)("*.entitlements", {
         absolute: true,
-        cwd: widgetFolderAbsolutePath,
+        cwd: targetDirAbsolutePath,
     });
     if (entitlementsFiles.length > 1) {
-        throw new Error(`[bacons/apple-targets][${props.type}] Found more than one '*.entitlements' file in ${widgetFolderAbsolutePath}`);
+        throw new Error(`[bacons/apple-targets][${props.type}] Found more than one '*.entitlements' file in ${targetDirAbsolutePath}`);
     }
     let entitlementsJson = props.entitlements;
     if (entitlementsJson) {
@@ -87,7 +89,7 @@ const withWidget = (config, props) => {
                     if (!associatedDomains ||
                         !Array.isArray(associatedDomains) ||
                         associatedDomains.length === 0) {
-                        warnOnce((0, chalk_1.default) `{yellow [${widget}]} Apple App Clip may require the associated domains entitlement but none were found in the Expo config.\nExample:\n${JSON.stringify({
+                        warnOnce((0, chalk_1.default) `{yellow [${targetDirName}]} Apple App Clip may require the associated domains entitlement but none were found in the Expo config.\nExample:\n${JSON.stringify({
                             ios: {
                                 associatedDomains: [`applinks:placeholder.expo.app`],
                             },
@@ -110,7 +112,7 @@ const withWidget = (config, props) => {
                             .filter(Boolean);
                         const unique = [...new Set(sanitizedUrls)];
                         if (unique.length) {
-                            warnOnce((0, chalk_1.default) `{gray [${widget}]} Apple App Clip expo-target.config.js missing associated domains entitlements in the target config. Using the following defaults:\n${JSON.stringify({
+                            warnOnce((0, chalk_1.default) `{gray [${targetDirName}]} Apple App Clip expo-target.config.js missing associated domains entitlements in the target config. Using the following defaults:\n${JSON.stringify({
                                 entitlements: {
                                     [associatedDomainsKey]: [
                                         `appclips:${unique[0] || "mywebsite.expo.app"}`,
@@ -137,13 +139,13 @@ const withWidget = (config, props) => {
                     // Then set the target app groups to match the main app.
                     entitlements[APP_GROUP_KEY] = mainAppGroups;
                     prebuildLogQueue.add(() => {
-                        logOnce((0, chalk_1.default) `[${widget}] Syncing app groups with main app. {dim Define entitlements[${JSON.stringify(APP_GROUP_KEY)}] in the {bold expo-target.config} file to override.}`);
+                        logOnce((0, chalk_1.default) `[${targetDirName}] Syncing app groups with main app. {dim Define entitlements[${JSON.stringify(APP_GROUP_KEY)}] in the {bold expo-target.config} file to override.}`);
                     });
                 }
                 else {
                     prebuildLogQueue.add(() => {
                         var _a, _b;
-                        return warnOnce((0, chalk_1.default) `{yellow [${widget}]} Apple target may require the App Groups entitlement but none were found in the Expo config.\nExample:\n${JSON.stringify({
+                        return warnOnce((0, chalk_1.default) `{yellow [${targetDirName}]} Apple target may require the App Groups entitlement but none were found in the Expo config.\nExample:\n${JSON.stringify({
                             ios: {
                                 entitlements: {
                                     [APP_GROUP_KEY]: [
@@ -168,11 +170,11 @@ const withWidget = (config, props) => {
                 const GENERATED_ENTITLEMENTS_FILE_NAME = "generated.entitlements";
                 const entitlementsFilePath = (_a = entitlementsFiles[0]) !== null && _a !== void 0 ? _a : 
                 // Use the name `generated` to help indicate that this file should be in sync with the config
-                path_1.default.join(widgetFolderAbsolutePath, GENERATED_ENTITLEMENTS_FILE_NAME);
+                path_1.default.join(targetDirAbsolutePath, GENERATED_ENTITLEMENTS_FILE_NAME);
                 if (entitlementsFiles[0]) {
-                    const relativeName = path_1.default.relative(widgetFolderAbsolutePath, entitlementsFiles[0]);
+                    const relativeName = path_1.default.relative(targetDirAbsolutePath, entitlementsFiles[0]);
                     if (relativeName !== GENERATED_ENTITLEMENTS_FILE_NAME) {
-                        console.log(`[${widget}] Replacing ${path_1.default.relative(widgetFolderAbsolutePath, entitlementsFiles[0])} with entitlements JSON from config`);
+                        console.log(`[${targetDirName}] Replacing ${path_1.default.relative(targetDirAbsolutePath, entitlementsFiles[0])} with entitlements JSON from config`);
                     }
                 }
                 fs_1.default.writeFileSync(entitlementsFilePath, plist_1.default.build(entitlementsJson));
@@ -190,7 +192,7 @@ const withWidget = (config, props) => {
         "ios",
         async (config) => {
             prebuildLogQueue.flush();
-            fs_1.default.mkdirSync(widgetFolderAbsolutePath, { recursive: true });
+            fs_1.default.mkdirSync(targetDirAbsolutePath, { recursive: true });
             const files = [
                 ["Info.plist", (0, target_1.getTargetInfoPlistForType)(props.type)],
             ];
@@ -208,7 +210,7 @@ const withWidget = (config, props) => {
             //   );
             // }
             files.forEach(([filename, content]) => {
-                const filePath = path_1.default.join(widgetFolderAbsolutePath, filename);
+                const filePath = path_1.default.join(targetDirAbsolutePath, filename);
                 if (!fs_1.default.existsSync(filePath)) {
                     fs_1.default.writeFileSync(filePath, content);
                 }
@@ -216,41 +218,54 @@ const withWidget = (config, props) => {
             return config;
         },
     ]);
-    const targetName = (_c = props.name) !== null && _c !== void 0 ? _c : widget;
     const mainAppBundleId = config.ios.bundleIdentifier;
-    const bundleId = ((_d = props.bundleIdentifier) === null || _d === void 0 ? void 0 : _d.startsWith("."))
-        ? mainAppBundleId + props.bundleIdentifier
-        : (_e = props.bundleIdentifier) !== null && _e !== void 0 ? _e : `${mainAppBundleId}.${props.type === "clip"
-            ? // Use a more standardized bundle identifier for App Clips.
-                "clip"
-            : getSanitizedBundleIdentifier(targetName)}`;
-    const deviceFamilies = ((_f = config.ios) === null || _f === void 0 ? void 0 : _f.isTabletOnly)
+    const bundleId = (() => {
+        var _a;
+        // Support the bundle identifier being appended to the main app's bundle identifier.
+        if ((_a = props.bundleIdentifier) === null || _a === void 0 ? void 0 : _a.startsWith(".")) {
+            return mainAppBundleId + props.bundleIdentifier;
+        }
+        else if (props.bundleIdentifier) {
+            return props.bundleIdentifier;
+        }
+        if (props.type === "clip") {
+            // Use a more standardized bundle identifier for App Clips.
+            return mainAppBundleId + ".clip";
+        }
+        let bundleId = mainAppBundleId;
+        bundleId += ".";
+        // Generate the bundle identifier. This logic needs to remain generally stable since it's used for a permanent value.
+        // Key here is simplicity and predictability since it's already appended to the main app's bundle identifier.
+        return mainAppBundleId + "." + getSanitizedBundleIdentifier(props.type);
+    })();
+    const deviceFamilies = ((_d = config.ios) === null || _d === void 0 ? void 0 : _d.isTabletOnly)
         ? ["tablet"]
-        : ((_g = config.ios) === null || _g === void 0 ? void 0 : _g.supportsTablet)
+        : ((_e = config.ios) === null || _e === void 0 ? void 0 : _e.supportsTablet)
             ? ["phone", "tablet"]
             : ["phone"];
     (0, withXcodeChanges_1.withXcodeChanges)(config, {
+        productName,
         configPath: props.configPath,
-        name: targetName,
+        name: targetDisplayName,
         cwd: "../" +
             path_1.default.relative(config._internal.projectRoot, path_1.default.resolve(props.directory)),
-        deploymentTarget: (_h = props.deploymentTarget) !== null && _h !== void 0 ? _h : DEFAULT_DEPLOYMENT_TARGET,
+        deploymentTarget: (_f = props.deploymentTarget) !== null && _f !== void 0 ? _f : DEFAULT_DEPLOYMENT_TARGET,
         bundleId,
         icon: props.icon,
         orientation: config.orientation,
-        hasAccentColor: !!((_j = props.colors) === null || _j === void 0 ? void 0 : _j.$accent),
+        hasAccentColor: !!((_g = props.colors) === null || _g === void 0 ? void 0 : _g.$accent),
         deviceFamilies,
         // @ts-expect-error: who cares
-        currentProjectVersion: ((_k = config.ios) === null || _k === void 0 ? void 0 : _k.buildNumber) || 1,
+        currentProjectVersion: ((_h = config.ios) === null || _h === void 0 ? void 0 : _h.buildNumber) || 1,
         frameworks: (0, target_1.getFrameworksForType)(props.type).concat(props.frameworks || []),
         type: props.type,
         teamId: props.appleTeamId,
-        exportJs: (_l = props.exportJs) !== null && _l !== void 0 ? _l : 
+        exportJs: (_j = props.exportJs) !== null && _j !== void 0 ? _j : 
         // Assume App Clips are used for React Native.
         props.type === "clip",
     });
     config = (0, withEasCredentials_1.withEASTargets)(config, {
-        targetName,
+        targetName: productName,
         bundleIdentifier: bundleId,
         entitlements: entitlementsJson,
     });
@@ -306,3 +321,9 @@ function getSanitizedBundleIdentifier(value) {
     // Can have empty segments (e.g. com.example..app).
     return value.replace(/(^[^a-zA-Z.-]|[^a-zA-Z0-9-.])/g, "-");
 }
+function sanitizeNameForNonDisplayUse(name) {
+    return name
+        .replace(/[\W_]+/g, "")
+        .normalize("NFD")
+        .replace(/[\u0300-\u036f]/g, "");
+}

package/build/withXcodeChanges.d.ts

@@ -2,6 +2,8 @@ import { ConfigPlugin } from "@expo/config-plugins";
 import { ExtensionType } from "./target";
 export type XcodeSettings = {
     name: string;
+    /** Name used for internal purposes. This has more strict rules and should be generated. */
+    productName: string;
     /** Directory relative to the project root, (i.e. outside of the `ios` directory) where the widget code should live. */
     cwd: string;
     bundleId: string;

package/build/withXcodeChanges.js

@@ -589,7 +589,7 @@ function createConfigurationList(project, { name, cwd, bundleId, deploymentTarge
             SWIFT_ACTIVE_COMPILATION_CONDITIONS: "DEBUG",
             SWIFT_EMIT_LOC_STRINGS: "YES",
             SWIFT_OPTIMIZATION_LEVEL: "-Onone",
-            SWIFT_VERSION: "5",
+            SWIFT_VERSION: "5.0",
             TARGETED_DEVICE_FAMILY: "1,2",
         },
     });
@@ -628,7 +628,7 @@ function createConfigurationList(project, { name, cwd, bundleId, deploymentTarge
             SWIFT_EMIT_LOC_STRINGS: "YES",
             SWIFT_COMPILATION_MODE: "wholemodule",
             SWIFT_OPTIMIZATION_LEVEL: "-O",
-            SWIFT_VERSION: "5",
+            SWIFT_VERSION: "5.0",
             TARGETED_DEVICE_FAMILY: "1,2",
         },
     });
@@ -684,7 +684,7 @@ async function applyXcodeChanges(config, project, props) {
         });
     }
     const targets = getExtensionTargets();
-    const productName = props.name;
+    const productName = props.productName;
     let targetToUpdate = (_a = targets.find((target) => target.props.productName === productName)) !== null && _a !== void 0 ? _a : targets[0];
     if (targetToUpdate) {
         console.log(`Target "${targetToUpdate.props.productName}" already exists, updating instead of creating a new one`);
@@ -833,7 +833,7 @@ async function applyXcodeChanges(config, project, props) {
                     ? "wrapper.extensionkit-extension"
                     : "wrapper.app-extension",
                 includeInIndex: 0,
-                path: productName + (isExtension ? ".appex" : ".app"),
+                path: props.name + (isExtension ? ".appex" : ".app"),
                 sourceTree: "BUILT_PRODUCTS_DIR",
             }),
             settings: {
@@ -845,7 +845,7 @@ async function applyXcodeChanges(config, project, props) {
         appExtensionBuildFile.props.fileRef);
         targetToUpdate = project.rootObject.createNativeTarget({
             buildConfigurationList: createConfigurationListForType(project, props),
-            name: productName,
+            name: props.name,
             productName,
             // @ts-expect-error
             productReference: appExtensionBuildFile.props.fileRef /* alphaExtension.appex */,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bacons/apple-targets",
-  "version": "0.1.18",
+  "version": "0.2.0",
   "description": "Generate Apple Targets with Expo Prebuild",
   "main": "build/ExtensionStorage.js",
   "types": "build/ExtensionStorage.d.ts",