expo-app-icon 1.0.0

package/plugin/build/icons.d.ts

@@ -0,0 +1,23 @@
+import type { AppleIconVariant, IconConfig, IconPluginInput, IconSet, ResolvedIconProps } from "./types";
+/**
+ * Coerce whatever the user placed in app config into a normalized icon map.
+ * A bare array of image paths is expanded to keyed entries that share the same
+ * image for both platforms.
+ */
+export declare function normalizeIconSet(input: IconPluginInput): IconSet;
+/**
+ * Build the list of Apple icon variants to emit for the given tablet support.
+ */
+export declare function resolveAppleVariants(supportsTablet: boolean): AppleIconVariant[];
+/**
+ * Base name used to reference an icon from the Info.plist (no scale/extension).
+ */
+export declare function appleIconBaseName(iconKey: string, variant: AppleIconVariant): string;
+/**
+ * Concrete asset filename for a variant, including @Nx scale and ~target.
+ */
+export declare function appleIconFileName(iconKey: string, variant: AppleIconVariant): string;
+/**
+ * Visit every (icon, variant) pair in declaration order.
+ */
+export declare function forEachAppleIcon({ icons, variants }: ResolvedIconProps, visit: (iconKey: string, icon: IconConfig, variant: AppleIconVariant) => Promise<void>): Promise<void>;

package/plugin/build/icons.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeIconSet = normalizeIconSet;
+exports.resolveAppleVariants = resolveAppleVariants;
+exports.appleIconBaseName = appleIconBaseName;
+exports.appleIconFileName = appleIconFileName;
+exports.forEachAppleIcon = forEachAppleIcon;
+const APPLE_ICON_BLUEPRINTS = [
+    { size: 60, scale: 2 },
+    { size: 60, scale: 3 },
+    { size: 60, scale: 2, width: 152, height: 152, target: "ipad" },
+    { size: 60, scale: 3, width: 167, height: 167, target: "ipad" },
+];
+/**
+ * Coerce whatever the user placed in app config into a normalized icon map.
+ * A bare array of image paths is expanded to keyed entries that share the same
+ * image for both platforms.
+ */
+function normalizeIconSet(input) {
+    if (Array.isArray(input)) {
+        return input.reduce((acc, image, index) => {
+            acc[String(index)] = { ios: image, android: image };
+            return acc;
+        }, {});
+    }
+    return input ?? {};
+}
+/**
+ * Build the list of Apple icon variants to emit for the given tablet support.
+ */
+function resolveAppleVariants(supportsTablet) {
+    return APPLE_ICON_BLUEPRINTS.filter((blueprint) => blueprint.target == null || supportsTablet).map((blueprint) => ({
+        size: blueprint.size,
+        scale: blueprint.scale,
+        width: blueprint.width ?? blueprint.size * blueprint.scale,
+        height: blueprint.height ?? blueprint.size * blueprint.scale,
+        target: blueprint.target ?? null,
+    }));
+}
+/**
+ * Base name used to reference an icon from the Info.plist (no scale/extension).
+ */
+function appleIconBaseName(iconKey, variant) {
+    return `${iconKey}-Icon-${variant.size}x${variant.size}`;
+}
+/**
+ * Concrete asset filename for a variant, including @Nx scale and ~target.
+ */
+function appleIconFileName(iconKey, variant) {
+    const targetSuffix = variant.target ? `~${variant.target}` : "";
+    return `${appleIconBaseName(iconKey, variant)}@${variant.scale}x${targetSuffix}.png`;
+}
+/**
+ * Visit every (icon, variant) pair in declaration order.
+ */
+async function forEachAppleIcon({ icons, variants }, visit) {
+    for (const [iconKey, icon] of Object.entries(icons)) {
+        for (const variant of variants) {
+            await visit(iconKey, icon, variant);
+        }
+    }
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,8 @@
+import type { ConfigPlugin } from "expo/config-plugins";
+import type { IconPluginInput } from "./types";
+/**
+ * Config plugin entry point. Wires up the per-platform sub-plugins from a
+ * single icon declaration and keeps the shipped `IconName` type in sync.
+ */
+declare const withDynamicIcon: ConfigPlugin<IconPluginInput>;
+export default withDynamicIcon;

package/plugin/build/index.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const android_1 = require("./android");
+const apple_1 = require("./apple");
+const icons_1 = require("./icons");
+const PACKAGE_ROOT = path_1.default.join(__dirname, "..", "..");
+/**
+ * Config plugin entry point. Wires up the per-platform sub-plugins from a
+ * single icon declaration and keeps the shipped `IconName` type in sync.
+ */
+const withDynamicIcon = (config, input) => {
+    const icons = (0, icons_1.normalizeIconSet)(input);
+    const variants = (0, icons_1.resolveAppleVariants)(Boolean(config.ios?.supportsTablet));
+    const props = { icons, variants };
+    config = withTypedIconNames(config, icons);
+    config = (0, apple_1.withAppleIconAssets)(config, props);
+    config = (0, apple_1.withAppleAlternateIcons)(config, props);
+    config = (0, apple_1.withAppleIconImages)(config, props);
+    config = (0, android_1.withAndroidIconAliases)(config, icons);
+    config = (0, android_1.withAndroidIconResources)(config, icons);
+    return config;
+};
+/**
+ * Rewrite the shipped `IconName` union in `build/types.d.ts` to the configured
+ * icon keys, so `getAppIcon()` / `setAppIcon()` are typed to this project.
+ */
+function withTypedIconNames(config, icons) {
+    const union = Object.keys(icons)
+        .map((name) => `"${name}"`)
+        .join(" | ") || "string";
+    const typesFile = path_1.default.join(PACKAGE_ROOT, "build", "types.d.ts");
+    try {
+        const current = fs_1.default.readFileSync(typesFile, "utf8");
+        fs_1.default.writeFileSync(typesFile, current.replace(/IconName:\s.*/, `IconName: ${union}`));
+    }
+    catch {
+        // The types file only exists in a built package; ignore when absent.
+    }
+    return config;
+}
+exports.default = withDynamicIcon;

package/plugin/build/types.d.ts

@@ -0,0 +1,62 @@
+/**
+ * A single icon entry as declared in the plugin config.
+ */
+export type IconConfig = {
+    /**
+     * Path to the iOS source image.
+     */
+    ios?: string;
+    /**
+     * Path to the Android source image.
+     */
+    android?: string;
+    /**
+     * Whether iOS should treat the icon as already rendered (no gloss).
+     */
+    prerendered?: boolean;
+};
+/**
+ * Map of icon key → icon config, as used everywhere internally.
+ */
+export type IconSet = Record<string, IconConfig>;
+/**
+ * What the plugin accepts from the app config: a keyed map, a bare list of
+ * image paths, or nothing.
+ */
+export type IconPluginInput = IconSet | string[] | void;
+/**
+ * Device family an Apple icon variant targets.
+ */
+export type AppleIconTarget = null | "ipad";
+/**
+ * One concrete Apple icon row written into the asset catalog / Info.plist.
+ */
+export type AppleIconVariant = {
+    /**
+     * Logical point size; drives the asset base name.
+     */
+    size: number;
+    /**
+     * @Nx scale; drives the asset file suffix.
+     */
+    scale: number;
+    /**
+     * Pixel width (defaults to `size * scale`).
+     */
+    width: number;
+    /**
+     * Pixel height (defaults to `size * scale`).
+     */
+    height: number;
+    /**
+     * Device family this row applies to, if any.
+     */
+    target: AppleIconTarget;
+};
+/**
+ * Props threaded between the per-platform sub-plugins.
+ */
+export type ResolvedIconProps = {
+    icons: IconSet;
+    variants: AppleIconVariant[];
+};

package/plugin/build/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });