react-native-icon-switcher 0.0.0-stage → 0.1.1

package/lib/typescript/src/types.d.ts

@@ -0,0 +1,59 @@
+/** A path to a square PNG master, ideally 1024 px. Relative to the project root. */
+export type ImagePath = string;
+/** Hex colour, `#RGB` or `#RRGGBB`. */
+export type HexColor = string;
+export interface IosIconVariants {
+    light: ImagePath;
+    /** Phase 2. */
+    dark?: ImagePath;
+    /** Phase 2. */
+    tinted?: ImagePath;
+}
+export interface AndroidAdaptiveIcon {
+    foreground: ImagePath;
+    background: ImagePath | HexColor;
+    /** Phase 2. Android 13+ themed icons. */
+    monochrome?: ImagePath;
+}
+export interface IconSpec {
+    ios?: ImagePath | IosIconVariants;
+    android?: ImagePath | AndroidAdaptiveIcon;
+}
+/** A bare path means "same master for both platforms". */
+export type IconSource = ImagePath | IconSpec;
+export interface IconSwitcherConfig {
+    /** Primary icon. Omit on Expo to reuse `icon` / `android.adaptiveIcon`. */
+    default?: IconSource;
+    icons: Record<string, IconSource>;
+    ios?: {
+        /** Background colour that transparent pixels are flattened onto. Default `#FFFFFF`. */
+        flattenOn?: HexColor;
+    };
+    android?: {
+        /** Default `'background'`. */
+        applyOn?: 'background' | 'immediate';
+        /** Lower-cased `Build.BRAND` values where switching is disabled. Default `[]`. */
+        skipBrands?: string[];
+    };
+}
+/** Config after validation and defaults; every icon normalised to per-platform specs. */
+export interface ResolvedIcon {
+    name: string;
+    isDefault: boolean;
+    ios: IosIconVariants | null;
+    android: AndroidAdaptiveIcon | {
+        legacy: ImagePath;
+    } | null;
+}
+export interface ResolvedConfig {
+    /** `default` first, then alternates in declaration order. */
+    icons: ResolvedIcon[];
+    ios: {
+        flattenOn: HexColor;
+    };
+    android: {
+        applyOn: 'background' | 'immediate';
+        skipBrands: string[];
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/typescript/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B,uCAAuC;AACvC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,SAAS,CAAC;IACjB,eAAe;IACf,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,eAAe;IACf,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,SAAS,CAAC;IACtB,UAAU,EAAE,SAAS,GAAG,QAAQ,CAAC;IACjC,yCAAyC;IACzC,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,CAAC,EAAE,SAAS,GAAG,eAAe,CAAC;IAClC,OAAO,CAAC,EAAE,SAAS,GAAG,mBAAmB,CAAC;CAC3C;AAED,0DAA0D;AAC1D,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE9C,MAAM,WAAW,kBAAkB;IACjC,2EAA2E;IAC3E,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClC,GAAG,CAAC,EAAE;QACJ,uFAAuF;QACvF,SAAS,CAAC,EAAE,QAAQ,CAAC;KACtB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,8BAA8B;QAC9B,OAAO,CAAC,EAAE,YAAY,GAAG,WAAW,CAAC;QACrC,kFAAkF;QAClF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;CACH;AAED,yFAAyF;AACzF,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,GAAG,EAAE,eAAe,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,mBAAmB,GAAG;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,cAAc;IAC7B,6DAA6D;IAC7D,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,GAAG,EAAE;QAAE,SAAS,EAAE,QAAQ,CAAA;KAAE,CAAC;IAC7B,OAAO,EAAE;QAAE,OAAO,EAAE,YAAY,GAAG,WAAW,CAAC;QAAC,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACxE"}

package/package.json

@@ -1,6 +1,255 @@
 {
   "name": "react-native-icon-switcher",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Switch the app icon at runtime on React Native and Expo from one config file, with the native wiring generated for you",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "react-native-icon-switcher-source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./config": {
+      "react-native-icon-switcher-source": "./src/config.ts",
+      "types": "./lib/typescript/src/config.d.ts",
+      "default": "./lib/module/config.js"
+    },
+    "./remote": {
+      "react-native-icon-switcher-source": "./src/remote/index.ts",
+      "types": "./lib/typescript/src/remote/index.d.ts",
+      "default": "./lib/module/remote/index.js"
+    },
+    "./jest": {
+      "types": "./jest/index.d.ts",
+      "default": "./jest/index.js"
+    },
+    "./app.plugin.js": "./app.plugin.js",
+    "./package.json": "./package.json"
+  },
+  "bin": "./plugin/build/cli.js",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "jest",
+    "app.plugin.js",
+    "plugin/build",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*",
+    "!plugin/build/**/__tests__",
+    "!**/typetests"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-icon-switcher-example",
+    "clean": "del-cli lib plugin/build",
+    "prepare": "bob build && yarn build:plugin",
+    "build:plugin": "tsc -p plugin",
+    "typecheck": "tsc && tsc -p plugin --noEmit",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "release": "release-it --only-version",
+    "check:exports": "node -e \"for (const s of ['react-native-icon-switcher/app.plugin.js','react-native-icon-switcher/jest','react-native-icon-switcher/package.json','react-native-icon-switcher/config','react-native-icon-switcher/remote']) require.resolve(s); console.log('exports ok')\"",
+    "example-bare": "yarn workspace react-native-icon-switcher-example-bare"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android",
+    "expo",
+    "expo-config-plugin",
+    "app-icon",
+    "alternate-icons",
+    "icon"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RRigueira/react-native-icon-switcher.git"
+  },
+  "author": "Rui Rigueira <14238908+RRigueira@users.noreply.github.com> (https://github.com/RRigueira)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/RRigueira/react-native-icon-switcher/issues"
+  },
+  "homepage": "https://github.com/RRigueira/react-native-icon-switcher#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@expo/config-plugins": "^58.0.10",
+    "@expo/plist": "^0.10.1",
+    "jiti": "^2.7.0",
+    "sharp": "^0.35.5",
+    "xcode": "^4.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^21.2.4",
+    "@commitlint/config-conventional": "^21.2.3",
+    "@eslint/compat": "^2.1.1",
+    "@eslint/eslintrc": "^3.3.7",
+    "@eslint/js": "^9.39.5",
+    "@react-native/babel-preset": "0.88.0",
+    "@react-native/eslint-config": "0.88.0",
+    "@react-native/jest-preset": "0.88.0",
+    "@release-it/conventional-changelog": "^12.0.2",
+    "@testing-library/react-native": "^14.1.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^26.6.3",
+    "@types/react": "^19.2.0",
+    "@types/react-test-renderer": "^19",
+    "del-cli": "^8.0.1",
+    "eslint": "^9.39.5",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-ft-flow": "^3.0.11",
+    "eslint-plugin-prettier": "^5.5.7",
+    "expo": "~58.0.19",
+    "jest": "^30.5.2",
+    "lefthook": "^2.2.2",
+    "prettier": "^3.9.10",
+    "react": "19.3.0",
+    "react-native": "0.88.0",
+    "react-native-builder-bob": "^0.44.1",
+    "react-test-renderer": "19.3.0",
+    "release-it": "^21.1.1",
+    "turbo": "^2.11.10",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "expo": ">=52",
+    "react": "*",
+    "react-native": "*"
+  },
+  "peerDependenciesMeta": {
+    "expo": {
+      "optional": true
+    }
+  },
+  "workspaces": [
+    "example",
+    "example-bare"
+  ],
+  "packageManager": "yarn@4.18.1",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ],
+    "exclude": "**/{__tests__,__fixtures__,__mocks__,typetests}/**"
+  },
+  "codegenConfig": {
+    "name": "IconSwitcherSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.iconswitcher"
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "@react-native/jest-preset",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/example-bare/node_modules",
+      "<rootDir>/lib/",
+      "<rootDir>/plugin/build"
+    ],
+    "testPathIgnorePatterns": [
+      "<rootDir>/plugin/build",
+      "<rootDir>/jest",
+      "<rootDir>/example/",
+      "<rootDir>/example-bare/"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.{ts,tsx}",
+      "!src/**/__tests__/**",
+      "!src/**/__mocks__/**",
+      "!src/typetests/**",
+      "!src/NativeIconSwitcher.ts",
+      "!src/types.ts",
+      "!src/register.ts",
+      "plugin/src/**/*.ts",
+      "!plugin/src/**/__tests__/**",
+      "!plugin/src/__fixtures__/**",
+      "!plugin/src/types.ts",
+      "!**/*.d.ts"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "statements": 95,
+        "branches": 90,
+        "functions": 85,
+        "lines": 95
+      }
+    }
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}",
+      "requireBranch": "main",
+      "requireCleanWorkingDir": true
+    },
+    "npm": {
+      "publish": false
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        },
+        "infile": "CHANGELOG.md"
+      }
+    }
+  },
+  "create-react-native-library": {
+    "type": "turbo-module",
+    "languages": "kotlin-objc",
+    "tools": [
+      "eslint"
+    ],
+    "version": "0.64.0"
+  },
+  "resolutions": {
+    "release-it/undici": "7.29.1"
+  }
+}

package/plugin/build/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export { syncProject } from './sync';
+export declare function run(argv: string[]): Promise<number>;

package/plugin/build/cli.js

@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncProject = void 0;
+exports.run = run;
+const node_path_1 = __importDefault(require("node:path"));
+const errors_1 = require("./core/errors");
+const errors_2 = require("./transforms/errors");
+const paths_1 = require("./paths");
+const sync_1 = require("./sync");
+var sync_2 = require("./sync");
+Object.defineProperty(exports, "syncProject", { enumerable: true, get: function () { return sync_2.syncProject; } });
+function _printError(message) {
+    process.stderr.write(`${message}\n`);
+}
+async function run(argv) {
+    const command = argv[0];
+    if (command !== 'sync') {
+        _printError('Usage: react-native-icon-switcher sync [--check] [--project-root <dir>] [--config <path>]');
+        return 2;
+    }
+    let check = false;
+    let projectRoot = process.cwd();
+    let configPath;
+    for (let i = 1; i < argv.length; i += 1) {
+        const arg = argv[i];
+        if (arg === '--check') {
+            check = true;
+            continue;
+        }
+        if (arg === '--project-root') {
+            const value = argv[i + 1];
+            if (!value) {
+                _printError('--project-root requires a directory');
+                return 2;
+            }
+            projectRoot = value;
+            i += 1;
+            continue;
+        }
+        if (arg === '--config') {
+            const value = argv[i + 1];
+            if (!value) {
+                _printError('--config requires a path');
+                return 2;
+            }
+            configPath = value;
+            i += 1;
+            continue;
+        }
+        _printError(`Unknown argument: ${arg}`);
+        return 2;
+    }
+    try {
+        const result = await (0, sync_1.syncProject)({
+            projectRoot: node_path_1.default.resolve(projectRoot),
+            configPath,
+            check,
+        });
+        if (check) {
+            if (result.driftedPaths.length > 0) {
+                for (const rel of result.driftedPaths.sort()) {
+                    _printError(rel);
+                }
+                return 1;
+            }
+            return 0;
+        }
+        process.stdout.write(`updated ${result.updated} files, unchanged ${result.unchanged}\n`);
+        return 0;
+    }
+    catch (err) {
+        if (err instanceof errors_1.ConfigError ||
+            err instanceof errors_2.TransformError ||
+            err instanceof paths_1.ProjectLayoutError) {
+            _printError(err.message);
+            return 2;
+        }
+        throw err;
+    }
+}
+if (require.main === module) {
+    void run(process.argv.slice(2)).then((code) => {
+        process.exitCode = code;
+    });
+}

package/plugin/build/core/assets.d.ts

@@ -0,0 +1,80 @@
+import type { HexColor, ResolvedConfig } from '../types';
+export type IosVariant = 'light' | 'dark' | 'tinted';
+export type AssetJob = {
+    kind: 'ios-png';
+    iconName: string;
+    isDefault: boolean;
+    variant: IosVariant;
+    sourcePath: string;
+    flattenOn: HexColor;
+    width: number;
+    height: number;
+} | {
+    kind: 'ios-contents';
+    iconName: string;
+    isDefault: boolean;
+    variants: IosVariant[];
+} | {
+    kind: 'android-legacy';
+    iconName: string;
+    isDefault: boolean;
+    round: boolean;
+    sourcePath: string;
+    density: string;
+    size: number;
+    backgroundColor?: HexColor;
+    backgroundImagePath?: string;
+} | {
+    kind: 'android-adaptive-foreground';
+    iconName: string;
+    isDefault: boolean;
+    sourcePath: string;
+    density: string;
+    size: number;
+} | {
+    kind: 'android-adaptive-background-image';
+    iconName: string;
+    isDefault: boolean;
+    sourcePath: string;
+    density: string;
+    size: number;
+} | {
+    kind: 'android-adaptive-xml';
+    iconName: string;
+    isDefault: boolean;
+    round: boolean;
+    backgroundIsColor: boolean;
+    hasMonochrome: boolean;
+} | {
+    kind: 'android-colors-xml';
+    entries: {
+        resourceName: string;
+        color: HexColor;
+    }[];
+};
+export interface PlannedAsset {
+    /** Path relative to `iosAssetCatalog` or `androidResDir`. */
+    relativePath: string;
+    job: AssetJob;
+}
+export interface AssetPlan {
+    projectRoot: string;
+    flattenOn: HexColor;
+    assets: PlannedAsset[];
+}
+export interface WrittenFile {
+    relativePath: string;
+    absolutePath: string;
+    sha256: string;
+}
+export declare function planAssets(cfg: ResolvedConfig, projectRoot: string): AssetPlan;
+export declare function writeAssets(plan: AssetPlan, opts: {
+    iosAssetCatalog: string;
+    androidResDir: string;
+}): Promise<WrittenFile[]>;
+/** Test helper: corner pixel RGB after iOS flatten (alpha removed). */
+export declare function _readCornerRgb(pngPath: string): Promise<{
+    r: number;
+    g: number;
+    b: number;
+}>;