@blotch/angular-lynx-native 0.0.0-placeholder → 22.2.2

package/dist/index.js

@@ -0,0 +1,72 @@
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import path from 'node:path';
+import { androidGenerator } from "./android/project.js";
+import { buildAndroid, resolveAndroidSigning } from "./android/build.js";
+import { prepareProject, removeLegacyWorkDir, } from "./generate.js";
+import { buildIos, resolveIosSigning } from "./ios/build.js";
+import { resolveLynxFrameworks } from "./ios/frameworks.js";
+import { iosGenerator } from "./ios/project.js";
+import { resolveAppOptions } from "./options.js";
+export { EJECT_MARKER, copyBundle, prepareProject } from "./generate.js";
+export { renderEjectedProject } from "./eject.js";
+export { LYNX_IOS, FRAMEWORKS_ENV } from "./ios/frameworks.js";
+export { NativeConfigError, resolveAppOptions } from "./options.js";
+export { NativeBuildError } from "./process.js";
+export const PACKAGE_VERSION = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')).version;
+/**
+ * Turns a built Lynx bundle into native binaries: generates (or reuses) the
+ * shell project, copies the bundle in, and runs xcodebuild or Gradle.
+ * Returns the paths of the binaries it wrote to `outputDir`.
+ */
+export const buildNativeApp = async (options) => {
+    const { platform, projectRoot, workDir, log } = options;
+    if (platform === 'ios' && process.platform !== 'darwin') {
+        throw new Error('Building for iOS needs macOS with Xcode installed: Apple only ships its build tools for macOS.');
+    }
+    const app = resolveAppOptions(options.app, {
+        projectName: options.projectName,
+        packageVersion: options.packageVersion,
+    });
+    // Resolved before generating anything, so a missing secret fails in
+    // milliseconds rather than after a native build.
+    const iosSigning = platform === 'ios' ? resolveIosSigning(app) : undefined;
+    const androidSigning = platform === 'android' ? resolveAndroidSigning(app) : undefined;
+    removeLegacyWorkDir(projectRoot, log);
+    const logFile = path.join(workDir, 'logs', `${platform}.log`);
+    mkdirSync(path.dirname(logFile), { recursive: true });
+    writeFileSync(logFile, '');
+    const project = prepareProject({
+        platform,
+        generator: platform === 'ios' ? iosGenerator : androidGenerator,
+        projectRoot,
+        workDir,
+        app,
+        bundleDir: options.bundleDir,
+        packageVersion: PACKAGE_VERSION,
+    });
+    log(project.ejected
+        ? `Using the ejected ${platform}/ project`
+        : project.regenerated
+            ? `Generated the ${platform} project`
+            : `Reusing the generated ${platform} project (no config changes)`);
+    const artifacts = platform === 'ios'
+        ? await buildIos({
+            project,
+            app,
+            frameworksDir: await resolveLynxFrameworks(logFile, log),
+            buildDir: path.join(workDir, 'build', 'ios'),
+            outputDir: options.outputDir,
+            logFile,
+            log,
+            signing: iosSigning,
+        })
+        : await buildAndroid({
+            project,
+            app,
+            outputDir: options.outputDir,
+            logFile,
+            log,
+            signing: androidSigning,
+        });
+    return { artifacts, projectDir: project.dir };
+};

package/dist/ios/build.d.ts

@@ -0,0 +1,32 @@
+import type { PreparedProject } from '../generate.ts';
+import type { ResolvedApp } from '../options.ts';
+export type IosSigning = {
+    readonly teamId: string;
+    readonly keyPath: string;
+    readonly keyId: string;
+    readonly issuerId: string;
+};
+/**
+ * Reads the App Store Connect API key from the environment variables the
+ * options name. Returns undefined when signing isn't configured at all, so a
+ * build without credentials still produces the simulator app, and throws when
+ * it's configured halfway, which is always a mistake.
+ */
+export declare const resolveIosSigning: (app: ResolvedApp, env?: NodeJS.ProcessEnv) => IosSigning | undefined;
+/**
+ * Builds the iOS shell: always a simulator `.app`, plus an App Store `.ipa`
+ * when signing is configured. Returns the artifacts' paths.
+ */
+export declare const buildIos: ({ project, app, frameworksDir, buildDir, outputDir, logFile, log, signing, }: {
+    readonly project: PreparedProject;
+    readonly app: ResolvedApp;
+    readonly frameworksDir: string;
+    /** Xcode's derived data, kept between builds for incremental builds. */
+    readonly buildDir: string;
+    readonly outputDir: string;
+    readonly logFile: string;
+    readonly log: (message: string) => void;
+    readonly signing: IosSigning | undefined;
+}) => Promise<string[]>;
+export declare const exportOptionsPlist: (teamId: string) => string;
+//# sourceMappingURL=build.d.ts.map

package/dist/ios/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/ios/build.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAIjD,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC5B,KAAK,WAAW,EAChB,MAAK,MAAM,CAAC,UAAwB,KACnC,UAAU,GAAG,SAgCf,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAU,8EAS5B;IACD,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CAAC;CAC1C,KAAG,OAAO,CAAC,MAAM,EAAE,CAwFnB,CAAC;AAgBF,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,KACb,MAkBF,CAAC"}

package/dist/ios/build.js

@@ -0,0 +1,149 @@
+import { cpSync, existsSync, lstatSync, mkdirSync, rmSync, symlinkSync, writeFileSync, } from 'node:fs';
+import path from 'node:path';
+import { run } from "../process.js";
+import { escapeXml } from "../xml.js";
+/**
+ * Reads the App Store Connect API key from the environment variables the
+ * options name. Returns undefined when signing isn't configured at all, so a
+ * build without credentials still produces the simulator app, and throws when
+ * it's configured halfway, which is always a mistake.
+ */
+export const resolveIosSigning = (app, env = process.env) => {
+    const signing = app.ios.signing;
+    if (!signing && !app.ios.teamId) {
+        return undefined;
+    }
+    const read = (option, name) => {
+        if (!name) {
+            throw new Error(`ios.signing.${option} must name the environment variable that holds it.`);
+        }
+        const value = env[name];
+        if (!value) {
+            throw new Error(`ios.signing.${option} names ${name}, which isn't set in the environment.`);
+        }
+        return value;
+    };
+    if (!app.ios.teamId) {
+        throw new Error('ios.signing is set, but ios.teamId is not.');
+    }
+    const keyPath = read('keyPathEnv', signing?.keyPathEnv);
+    if (!existsSync(keyPath)) {
+        throw new Error(`The App Store Connect key ${keyPath} doesn't exist.`);
+    }
+    return {
+        teamId: app.ios.teamId,
+        keyPath,
+        keyId: read('keyIdEnv', signing?.keyIdEnv),
+        issuerId: read('issuerIdEnv', signing?.issuerIdEnv),
+    };
+};
+/**
+ * Builds the iOS shell: always a simulator `.app`, plus an App Store `.ipa`
+ * when signing is configured. Returns the artifacts' paths.
+ */
+export const buildIos = async ({ project, app, frameworksDir, buildDir, outputDir, logFile, log, signing, }) => {
+    linkFrameworks(project.dir, frameworksDir);
+    const xcodebuild = (args) => run('xcodebuild', args, { cwd: project.dir, logFile });
+    const common = ['-project', 'App.xcodeproj', '-scheme', 'App'];
+    const artifacts = [];
+    mkdirSync(outputDir, { recursive: true });
+    log('Building the iOS Simulator app');
+    await xcodebuild([
+        'build',
+        ...common,
+        '-configuration',
+        'Release',
+        '-sdk',
+        'iphonesimulator',
+        '-destination',
+        'generic/platform=iOS Simulator',
+        '-derivedDataPath',
+        buildDir,
+    ]);
+    const simulatorApp = path.join(outputDir, `${app.productName}-simulator.app`);
+    rmSync(simulatorApp, { recursive: true, force: true });
+    cpSync(path.join(buildDir, 'Build/Products/Release-iphonesimulator', `${app.productName}.app`), simulatorApp, { recursive: true, verbatimSymlinks: true });
+    artifacts.push(simulatorApp);
+    if (!signing) {
+        log('Skipping the App Store .ipa: set ios.teamId and ios.signing in angular.json to build one.');
+        return artifacts;
+    }
+    // Headless signing: the API key lets xcodebuild create and download the
+    // certificate and provisioning profile itself, so nobody opens Xcode.
+    const auth = [
+        '-allowProvisioningUpdates',
+        '-authenticationKeyPath',
+        signing.keyPath,
+        '-authenticationKeyID',
+        signing.keyId,
+        '-authenticationKeyIssuerID',
+        signing.issuerId,
+    ];
+    const archive = path.join(buildDir, `${app.productName}.xcarchive`);
+    log('Archiving the iOS app for the App Store');
+    await xcodebuild([
+        'archive',
+        ...common,
+        '-configuration',
+        'Release',
+        '-destination',
+        'generic/platform=iOS',
+        '-archivePath',
+        archive,
+        '-derivedDataPath',
+        buildDir,
+        ...auth,
+        `DEVELOPMENT_TEAM=${signing.teamId}`,
+    ]);
+    const exportOptions = path.join(buildDir, 'ExportOptions.plist');
+    writeFileSync(exportOptions, exportOptionsPlist(signing.teamId));
+    const exportDir = path.join(buildDir, 'export');
+    rmSync(exportDir, { recursive: true, force: true });
+    log('Exporting the .ipa');
+    await xcodebuild([
+        '-exportArchive',
+        '-archivePath',
+        archive,
+        '-exportPath',
+        exportDir,
+        '-exportOptionsPlist',
+        exportOptions,
+        ...auth,
+    ]);
+    const ipa = path.join(outputDir, `${app.productName}.ipa`);
+    cpSync(path.join(exportDir, `${app.productName}.ipa`), ipa);
+    artifacts.push(ipa);
+    return artifacts;
+};
+/**
+ * Points the project's `Frameworks` folder at the cached XCFrameworks. A
+ * symlink, so the ~100 MB of frameworks aren't copied into every project. An
+ * ejected project that vendors its own Frameworks folder keeps it.
+ */
+const linkFrameworks = (projectDir, frameworksDir) => {
+    const link = path.join(projectDir, 'Frameworks');
+    if (existsSync(link) && !lstatSync(link).isSymbolicLink()) {
+        return;
+    }
+    rmSync(link, { force: true });
+    symlinkSync(frameworksDir, link, 'dir');
+};
+export const exportOptionsPlist = (teamId) => `<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>method</key>
+	<string>app-store-connect</string>
+	<key>destination</key>
+	<string>export</string>
+	<key>signingStyle</key>
+	<string>automatic</string>
+	<key>teamID</key>
+	<string>${escapeXml(teamId)}</string>
+	<key>uploadSymbols</key>
+	<true/>
+	<key>manageAppVersionAndBuildNumber</key>
+	<false/>
+</dict>
+</plist>
+`;

package/dist/ios/frameworks.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The prebuilt Lynx XCFrameworks the iOS shell links.
+ *
+ * Lynx publishes iOS only as source pods, and compiling them takes minutes and
+ * needs CocoaPods (and so Ruby). scripts/build-lynx-ios-frameworks.sh compiles
+ * them once per Lynx version in CI; the zip it produces is attached to a
+ * GitHub release and pinned here by SHA-256, so every user links the same
+ * binaries we tested.
+ */
+export declare const LYNX_IOS: {
+    readonly version: "4.1.0";
+    readonly url: "https://github.com/Blotch-Smart-Frames/AngularLynx/releases/download/lynx-ios-4.1.0/lynx-ios-4.1.0.zip";
+    readonly sha256: string | undefined;
+};
+/**
+ * The frameworks in the zip. The template project (APP_PROJECT in
+ * scripts/generate-ios-project.ts) and the frameworks build both read this
+ * list, so it is the only place to change it.
+ */
+export declare const LYNX_IOS_FRAMEWORKS: readonly ["Lynx", "LynxBase", "LynxServiceAPI", "LynxService", "PrimJS", "SDWebImage", "SDWebImageWebPCoder", "libwebp"];
+/**
+ * Overrides the download with a local folder of XCFrameworks, e.g. the
+ * `out/LynxFrameworks` folder build-lynx-ios-frameworks.sh writes. For testing
+ * a new Lynx version before its zip is published.
+ */
+export declare const FRAMEWORKS_ENV = "ANGULAR_LYNX_IOS_FRAMEWORKS";
+/** Returns a folder holding every XCFramework, downloading it on first use. */
+export declare const resolveLynxFrameworks: (logFile: string, log: (message: string) => void) => Promise<string>;
+/** The Lynx version a frameworks folder was built from, if it says. */
+export declare const readFrameworksVersion: (dir: string) => string | undefined;
+//# sourceMappingURL=frameworks.d.ts.map

package/dist/ios/frameworks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameworks.d.ts","sourceRoot":"","sources":["../../src/ios/frameworks.ts"],"names":[],"mappings":"AAcA;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ;;;qBAIf,MAAM,GACN,SAAS;CACL,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,0HAStB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,cAAc,gCAAgC,CAAC;AAS5D,+EAA+E;AAC/E,eAAO,MAAM,qBAAqB,GAChC,SAAS,MAAM,EACf,KAAK,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,KAC7B,OAAO,CAAC,MAAM,CAmDhB,CAAC;AAaF,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,GAAI,KAAK,MAAM,KAAG,MAAM,GAAG,SAM5D,CAAC"}

package/dist/ios/frameworks.js

@@ -0,0 +1,99 @@
+import { createHash } from 'node:crypto';
+import { existsSync, mkdirSync, readFileSync, renameSync, rmSync, writeFileSync, } from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { run } from "../process.js";
+/**
+ * The prebuilt Lynx XCFrameworks the iOS shell links.
+ *
+ * Lynx publishes iOS only as source pods, and compiling them takes minutes and
+ * needs CocoaPods (and so Ruby). scripts/build-lynx-ios-frameworks.sh compiles
+ * them once per Lynx version in CI; the zip it produces is attached to a
+ * GitHub release and pinned here by SHA-256, so every user links the same
+ * binaries we tested.
+ */
+export const LYNX_IOS = {
+    version: '4.1.0',
+    url: 'https://github.com/Blotch-Smart-Frames/AngularLynx/releases/download/lynx-ios-4.1.0/lynx-ios-4.1.0.zip',
+    sha256: '8f00fbd9eddc885175ea526136197222b5a8bd892c6b4d97e131abf88b9a39f4',
+};
+/**
+ * The frameworks in the zip. The template project (APP_PROJECT in
+ * scripts/generate-ios-project.ts) and the frameworks build both read this
+ * list, so it is the only place to change it.
+ */
+export const LYNX_IOS_FRAMEWORKS = [
+    'Lynx',
+    'LynxBase',
+    'LynxServiceAPI',
+    'LynxService',
+    'PrimJS',
+    'SDWebImage',
+    'SDWebImageWebPCoder',
+    'libwebp',
+];
+/**
+ * Overrides the download with a local folder of XCFrameworks, e.g. the
+ * `out/LynxFrameworks` folder build-lynx-ios-frameworks.sh writes. For testing
+ * a new Lynx version before its zip is published.
+ */
+export const FRAMEWORKS_ENV = 'ANGULAR_LYNX_IOS_FRAMEWORKS';
+const cacheRoot = () => path.join(process.env['XDG_CACHE_HOME'] ?? path.join(os.homedir(), '.cache'), 'angular-lynx', 'lynx-ios');
+/** Returns a folder holding every XCFramework, downloading it on first use. */
+export const resolveLynxFrameworks = async (logFile, log) => {
+    const override = process.env[FRAMEWORKS_ENV];
+    if (override) {
+        assertComplete(override, `${FRAMEWORKS_ENV} (${override})`);
+        return path.resolve(override);
+    }
+    const dir = path.join(cacheRoot(), LYNX_IOS.version);
+    const frameworks = path.join(dir, 'LynxFrameworks');
+    if (existsSync(path.join(dir, '.complete'))) {
+        return frameworks;
+    }
+    if (!LYNX_IOS.sha256) {
+        throw new Error(`Prebuilt Lynx ${LYNX_IOS.version} frameworks for iOS aren't published yet. Build them with packages/native/scripts/build-lynx-ios-frameworks.sh from the AngularLynx repository, then set ${FRAMEWORKS_ENV} to the LynxFrameworks folder it creates.`);
+    }
+    log(`Downloading Lynx ${LYNX_IOS.version} for iOS (once per Lynx version)`);
+    const response = await fetch(LYNX_IOS.url);
+    if (!response.ok) {
+        throw new Error(`Downloading ${LYNX_IOS.url} failed with HTTP ${response.status}.`);
+    }
+    const zip = Buffer.from(await response.arrayBuffer());
+    const digest = createHash('sha256').update(zip).digest('hex');
+    if (digest !== LYNX_IOS.sha256) {
+        throw new Error(`${LYNX_IOS.url} has SHA-256 ${digest}, not the pinned ${LYNX_IOS.sha256}. Not using it.`);
+    }
+    // Extract next to the final folder and rename, so an interrupted download
+    // never leaves a half-extracted cache that looks complete.
+    const staging = `${dir}.partial`;
+    rmSync(staging, { recursive: true, force: true });
+    mkdirSync(staging, { recursive: true });
+    const zipFile = path.join(staging, 'frameworks.zip');
+    writeFileSync(zipFile, zip);
+    // ditto keeps the frameworks' symlinks and code signatures intact.
+    await run('ditto', ['-x', '-k', zipFile, staging], {
+        cwd: staging,
+        logFile,
+    });
+    rmSync(zipFile);
+    assertComplete(path.join(staging, 'LynxFrameworks'), LYNX_IOS.url);
+    writeFileSync(path.join(staging, '.complete'), LYNX_IOS.sha256);
+    rmSync(dir, { recursive: true, force: true });
+    renameSync(staging, dir);
+    return frameworks;
+};
+const assertComplete = (dir, source) => {
+    const missing = LYNX_IOS_FRAMEWORKS.filter((name) => !existsSync(path.join(dir, `${name}.xcframework`, 'Info.plist')));
+    if (missing.length > 0) {
+        throw new Error(`${source} is missing ${missing.map((name) => `${name}.xcframework`).join(', ')}.`);
+    }
+};
+/** The Lynx version a frameworks folder was built from, if it says. */
+export const readFrameworksVersion = (dir) => {
+    const versions = path.join(dir, 'VERSIONS');
+    if (!existsSync(versions)) {
+        return undefined;
+    }
+    return /^lynx=(.+)$/m.exec(readFileSync(versions, 'utf8'))?.[1];
+};

package/dist/ios/project.d.ts

@@ -0,0 +1,11 @@
+import type { PlatformGenerator } from '../generate.ts';
+import type { ResolvedApp } from '../options.ts';
+/**
+ * Writes the app options into the iOS template: build settings go in
+ * Config/App.xcconfig (which App.xcodeproj reads), and Info.plist entries go
+ * between the template's `angular-lynx:info` markers.
+ */
+export declare const iosGenerator: PlatformGenerator;
+export declare const xcconfig: (app: ResolvedApp) => string;
+export declare const infoPlistEntries: (app: ResolvedApp) => string;
+//# sourceMappingURL=project.d.ts.map

package/dist/ios/project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../src/ios/project.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,KAAK,EAAe,WAAW,EAAE,MAAM,eAAe,CAAC;AAiB9D;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,iBA6B1B,CAAC;AAQF,eAAO,MAAM,QAAQ,GAAI,KAAK,WAAW,KAAG,MAY9B,CAAC;AAEf,eAAO,MAAM,gBAAgB,GAAI,KAAK,WAAW,KAAG,MAqCnD,CAAC"}

package/dist/ios/project.js

@@ -0,0 +1,73 @@
+import { copyFileSync, readFileSync, writeFileSync } from 'node:fs';
+import path from 'node:path';
+import { readPngSize } from "../png.js";
+import { PERMISSION_MAP } from "../permissions.js";
+import { escapeXml, replaceMarker } from "../xml.js";
+const ORIENTATIONS = {
+    portrait: ['UIInterfaceOrientationPortrait'],
+    landscape: [
+        'UIInterfaceOrientationLandscapeLeft',
+        'UIInterfaceOrientationLandscapeRight',
+    ],
+    all: [
+        'UIInterfaceOrientationPortrait',
+        'UIInterfaceOrientationLandscapeLeft',
+        'UIInterfaceOrientationLandscapeRight',
+    ],
+};
+/**
+ * Writes the app options into the iOS template: build settings go in
+ * Config/App.xcconfig (which App.xcodeproj reads), and Info.plist entries go
+ * between the template's `angular-lynx:info` markers.
+ */
+export const iosGenerator = {
+    configure: (dir, app, projectRoot) => {
+        writeFileSync(path.join(dir, 'Config/App.xcconfig'), xcconfig(app));
+        const plistPath = path.join(dir, 'App/Info.plist');
+        writeFileSync(plistPath, replaceMarker(readFileSync(plistPath, 'utf8'), 'info', infoPlistEntries(app)));
+        if (app.icon) {
+            const icon = path.resolve(projectRoot, app.icon);
+            const size = readPngSize(icon);
+            if (size.width !== 1024 || size.height !== 1024) {
+                throw new Error(`${app.icon} is ${size.width}×${size.height}. The app icon must be a 1024×1024 PNG.`);
+            }
+            copyFileSync(icon, path.join(dir, 'App/Assets.xcassets/AppIcon.appiconset/AppIcon.png'));
+        }
+    },
+    bundleDir: (dir) => path.join(dir, 'LynxBundle'),
+};
+/**
+ * xcconfig values can't be quoted; `$` and `//` would start a variable or a comment.
+ */
+const xcconfigValue = (value) => value.replace(/\$/g, '$$$$').replace(/\/\//g, '/$()/');
+export const xcconfig = (app) => [
+    '// Written by @blotch/angular-lynx-native from the builder options in',
+    '// angular.json on every build. Edits here are overwritten; change',
+    '// angular.json instead (or eject).',
+    `ANGULAR_LYNX_PRODUCT_NAME = ${app.productName}`,
+    `ANGULAR_LYNX_DISPLAY_NAME = ${xcconfigValue(app.name)}`,
+    `PRODUCT_BUNDLE_IDENTIFIER = ${app.id}`,
+    `MARKETING_VERSION = ${app.version}`,
+    `CURRENT_PROJECT_VERSION = ${app.buildNumber}`,
+    `DEVELOPMENT_TEAM = ${app.ios.teamId ?? ''}`,
+    '',
+].join('\n');
+export const infoPlistEntries = (app) => {
+    const lines = [];
+    const array = (key, values) => {
+        lines.push(`<key>${key}</key>`, '<array>');
+        values.forEach((value) => lines.push(`\t<string>${escapeXml(value)}</string>`));
+        lines.push('</array>');
+    };
+    array('UISupportedInterfaceOrientations', ORIENTATIONS[app.orientation]);
+    for (const [permission, reason] of Object.entries(app.permissions)) {
+        for (const key of PERMISSION_MAP[permission]
+            .ios) {
+            lines.push(`<key>${key}</key>`, `<string>${escapeXml(reason)}</string>`);
+        }
+    }
+    if (app.deepLinkSchemes.length > 0) {
+        lines.push('<key>CFBundleURLTypes</key>', '<array>', '\t<dict>', '\t\t<key>CFBundleURLName</key>', `\t\t<string>${escapeXml(app.id)}</string>`, '\t\t<key>CFBundleURLSchemes</key>', '\t\t<array>', ...app.deepLinkSchemes.map((scheme) => `\t\t\t<string>${escapeXml(scheme)}</string>`), '\t\t</array>', '\t</dict>', '</array>');
+    }
+    return lines.join('\n');
+};

package/dist/options.d.ts

@@ -0,0 +1,95 @@
+/**
+ * The app identity and native settings a project declares in angular.json, as
+ * options of the `@blotch/angular-lynx-build:application` builder.
+ *
+ * The options are flat on purpose. Angular merges a `configurations` entry
+ * into the base options one key deep, so a nested `app: { id }` override in a
+ * "staging" configuration would drop every other `app` field. With flat keys,
+ * `"staging": { "appId": "com.example.app.staging" }` changes only the ID.
+ * The `ios` and `android` objects are still replaced as a whole when a
+ * configuration sets them.
+ */
+export type NativeAppOptions = {
+    /** The name under the icon. Defaults to the project name. */
+    readonly appName?: string;
+    /** iOS bundle ID and Android applicationId, e.g. `com.example.myapp`. */
+    readonly appId?: string;
+    /** The user-facing version (CFBundleShortVersionString / versionName). */
+    readonly version?: string;
+    /** The store build number (CFBundleVersion / versionCode). */
+    readonly buildNumber?: number;
+    readonly orientation?: Orientation;
+    /** Each permission the app uses, with the reason shown to the user. */
+    readonly permissions?: Partial<Record<Permission, string>>;
+    /** Custom URL schemes that open the app, e.g. `["myapp"]`. */
+    readonly deepLinkSchemes?: readonly string[];
+    /** A 1024×1024 PNG without transparency, relative to the project root. */
+    readonly icon?: string;
+    readonly ios?: IosOptions;
+    readonly android?: AndroidOptions;
+};
+export type Orientation = 'portrait' | 'landscape' | 'all';
+export type Permission = 'camera' | 'microphone' | 'location' | 'photos' | 'contacts' | 'notifications';
+export type IosOptions = {
+    /** The Apple Developer team that signs the app. */
+    readonly teamId?: string;
+    /**
+     * Headless signing with an App Store Connect API key. Each field names the
+     * environment variable that holds the value, so no secret is ever written
+     * to angular.json.
+     */
+    readonly signing?: {
+        readonly keyIdEnv?: string;
+        readonly issuerIdEnv?: string;
+        readonly keyPathEnv?: string;
+    };
+};
+export type AndroidOptions = {
+    /**
+     * The upload key for Google Play. The `*Env` fields name environment
+     * variables, so no secret is ever written to angular.json.
+     */
+    readonly signing?: {
+        readonly storeFileEnv?: string;
+        readonly storePasswordEnv?: string;
+        readonly keyAlias?: string;
+        readonly keyPasswordEnv?: string;
+    };
+};
+/** {@link NativeAppOptions} with every default applied and every value checked. */
+export type ResolvedApp = {
+    readonly name: string;
+    readonly id: string;
+    readonly version: string;
+    readonly buildNumber: number;
+    readonly orientation: Orientation;
+    readonly permissions: Partial<Record<Permission, string>>;
+    readonly deepLinkSchemes: readonly string[];
+    readonly icon?: string;
+    /** `MyApp`: the iOS product (and so .app/.ipa) name. */
+    readonly productName: string;
+    /** `my-app`: the base name of Android artifacts. */
+    readonly artifactName: string;
+    readonly ios: IosOptions;
+    readonly android: AndroidOptions;
+};
+export declare class NativeConfigError extends Error {
+}
+/**
+ * Applies defaults and validates the options, so the generators never see a
+ * value that would produce a project Xcode or Gradle rejects later with a
+ * less helpful message.
+ */
+export declare const resolveAppOptions: (rawOptions: NativeAppOptions, defaults: {
+    readonly projectName: string;
+    readonly packageVersion?: string;
+}) => ResolvedApp;
+/**
+ * Drops `undefined` values and the objects left empty by that. Angular CLI
+ * fills in every property its schema declares for a nested option object,
+ * as `undefined` when the user didn't set it, so `ios: {}` arrives as
+ * `{ teamId: undefined, signing: { keyIdEnv: undefined, ... } }`, which
+ * would read as "signing configured, but incomplete".
+ */
+export declare const compact: (value: unknown) => unknown;
+//# sourceMappingURL=options.d.ts.map

package/dist/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,yEAAyE;IACzE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,0EAA0E;IAC1E,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,8DAA8D;IAC9D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;IACnC,uEAAuE;IACvE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3D,8DAA8D;IAC9D,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7C,0EAA0E;IAC1E,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,WAAW,GAAG,KAAK,CAAC;AAE3D,MAAM,MAAM,UAAU,GAClB,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,UAAU,GACV,eAAe,CAAC;AAEpB,MAAM,MAAM,UAAU,GAAG;IACvB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAC3B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,mFAAmF;AACnF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,oDAAoD;IACpD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;CAClC,CAAC;AAEF,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAsB/C;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,YAAY,gBAAgB,EAC5B,UAAU;IAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;CAAE,KAC3E,WAoFF,CAAC;AAUF;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,OAAO,KAAG,OAWxC,CAAC"}