@swiftbrowser/cli 0.1.0 → 0.3.0

package/dist/config.d.ts

@@ -1,5 +1,19 @@
-export type FoundationMode = 'lean' | 'full';
 export type SwiftLanguageMode = '5' | '6';
+/**
+ * A Swift package the app depends on, for a folder of sources (an Xcode
+ * project lists its own): a remote `url` with one rule (`from`: up to the next
+ * major version, `exact`, `branch` or `revision`), or a local `path` (relative
+ * to the project), and the products the app imports.
+ */
+export interface ConfigPackage {
+    url?: string;
+    path?: string;
+    from?: string;
+    exact?: string;
+    branch?: string;
+    revision?: string;
+    products: string[];
+}
 export interface Config {
     /** Module name of the app (letters, digits, `_`); defaults to the target or folder name. */
     name?: string;
@@ -24,22 +38,46 @@ export interface Config {
     /** Swift language mode the sources are compiled in (default 5, like Xcode's default for apps). */
     swiftLanguageMode?: SwiftLanguageMode;
     /**
-     * `full` (default): the wasm SDK's Foundation, nothing rewritten, its ICU
-     * data trimmed to `locales` (see below); about 19 MB optimized, 6.6 MB
-     * gzipped. `lean`: `import Foundation` is rewritten to FoundationEssentials
-     * + FoundationLite, a smaller module (4.5 to 9 MB) with a smaller API.
+     * The languages whose ICU locale data stays in the module (`["en"]` by
+     * default; `["*"]` keeps everything). The viewer's language is chosen among
+     * them at launch. Each language adds roughly 100 to 300 kB, Chinese 1.7 MB.
      */
-    foundation?: FoundationMode;
+    locales?: string[];
     /**
-     * In full mode, the languages whose ICU locale data is kept (BCP 47 tags;
-     * the region part is ignored, every regional variant of the language stays).
-     * Default `["en"]`, about 5.5 MB; `["*"]` keeps the SDK's whole 34 MB.
+     * Whether ICU's collation tables ship (default true). `false` saves 0.9 MB
+     * when the app never compares strings in a locale (`localizedCompare`,
+     * `localizedStandardCompare`, `.localizedStandard` sorting fall back to
+     * Unicode scalar order).
      */
-    locales?: string[];
+    collation?: boolean;
     /** Extra `-D` compilation conditions (SWIFTBROWSER is always defined). */
     defines?: string[];
+    /**
+     * The app's URL schemes, whose OAuth redirects come back through the page
+     * (docs/ops-protocol.md, "Signing in"); replaces those of the Info.plist's
+     * `CFBundleURLTypes`.
+     */
+    urlSchemes?: string[];
+    /**
+     * A CORS proxy (packages/cors-proxy, deployed on Cloudflare): the page
+     * retries a cross-origin GET or HEAD the browser refused through
+     * `<corsProxy>?url=<target>`. For apps whose servers do not allow the page's
+     * origin (images, mostly), as in screenshots and demos. `--cors-proxy`
+     * overrides it.
+     */
+    corsProxy?: string;
+    /**
+     * Hosts (and their subdomains) the app's requests may not reach in the
+     * browser: they fail as a network error does. For a public deploy of an app
+     * whose analytics belong to someone else. `--block-host` adds to them.
+     */
+    blockHosts?: string[];
+    /** Swift packages the app depends on, added to the Xcode target's (see `ConfigPackage`). */
+    packages?: ConfigPackage[];
 }
 export declare const CONFIG_FILE = "swiftbrowser.json";
 /** Reads and validates `swiftbrowser.json` in `dir` (or the file at `file`); `{}` when absent. */
 export declare function loadConfig(dir: string, file?: string): Config;
 export declare function validateConfig(raw: unknown, source?: string): Config;
+/** Whether `value` is an absolute http(s) URL (a CORS proxy's). */
+export declare function isHTTPURL(value: string): boolean;

package/dist/config.js

@@ -3,10 +3,10 @@
 // need no file at all.
 import { existsSync, readFileSync } from 'node:fs';
 import path from 'node:path';
-import { CliError } from './log.js';
+import { CliError, info, warn } from './log.js';
 export const CONFIG_FILE = 'swiftbrowser.json';
-const STRING_KEYS = ['name', 'displayName', 'target', 'icon'];
-const LIST_KEYS = ['sources', 'exclude', 'catalogs', 'resources', 'defines', 'locales'];
+const STRING_KEYS = ['name', 'displayName', 'target', 'icon', 'corsProxy'];
+const LIST_KEYS = ['sources', 'exclude', 'catalogs', 'resources', 'defines', 'locales', 'urlSchemes', 'blockHosts'];
 /** Reads and validates `swiftbrowser.json` in `dir` (or the file at `file`); `{}` when absent. */
 export function loadConfig(dir, file) {
     const configPath = file ?? path.join(dir, CONFIG_FILE);
@@ -45,26 +45,82 @@ export function validateConfig(raw, source = CONFIG_FILE) {
             throw new CliError(`${source}: "${key}" must be an array of strings`);
         config[key] = value;
     }
+    if (record['collation'] !== undefined) {
+        if (typeof record['collation'] !== 'boolean')
+            throw new CliError(`${source}: "collation" must be true or false`);
+        config.collation = record['collation'];
+    }
     if (record['swiftLanguageMode'] !== undefined) {
         const mode = String(record['swiftLanguageMode']);
         if (mode !== '5' && mode !== '6')
             throw new CliError(`${source}: "swiftLanguageMode" must be "5" or "6"`);
         config.swiftLanguageMode = mode;
     }
+    if (record['packages'] !== undefined)
+        config.packages = validatePackages(record['packages'], source);
     if (record['foundation'] !== undefined) {
-        const mode = record['foundation'];
-        if (mode !== 'lean' && mode !== 'full')
-            throw new CliError(`${source}: "foundation" must be "lean" or "full"`);
-        config.foundation = mode;
+        // Phase 14: there is one Foundation now. Old files may still say "lean" or "full".
+        info(warn(`${source}: "foundation" is ignored; the real Foundation is always used (lean mode was removed)`));
+    }
+    if (config.corsProxy !== undefined && !isHTTPURL(config.corsProxy)) {
+        throw new CliError(`${source}: "corsProxy" must be an http(s) URL`);
     }
     if (config.name !== undefined && !/^[A-Za-z_][A-Za-z0-9_]*$/.test(config.name)) {
         throw new CliError(`${source}: "name" must be a Swift module name (letters, digits, underscores)`);
     }
     for (const key of Object.keys(record)) {
-        if (!STRING_KEYS.includes(key) && !LIST_KEYS.includes(key) && key !== 'swiftLanguageMode' && key !== 'foundation' && key !== '$schema') {
+        if (!STRING_KEYS.includes(key) && !LIST_KEYS.includes(key) && key !== 'swiftLanguageMode' && key !== 'collation' && key !== 'packages' && key !== 'foundation' && key !== '$schema') {
             throw new CliError(`${source}: unknown key "${key}"`);
         }
     }
     return config;
 }
+const PACKAGE_KEYS = ['url', 'path', 'from', 'exact', 'branch', 'revision'];
+const PACKAGE_RULES = ['from', 'exact', 'branch', 'revision'];
+function validatePackages(value, source) {
+    if (!Array.isArray(value))
+        throw new CliError(`${source}: "packages" must be an array`);
+    return value.map((entry, index) => {
+        const where = `${source}: packages[${index}]`;
+        if (typeof entry !== 'object' || entry === null || Array.isArray(entry))
+            throw new CliError(`${where} must be an object`);
+        const record = entry;
+        const pkg = { products: [] };
+        for (const key of Object.keys(record)) {
+            if (!PACKAGE_KEYS.includes(key) && key !== 'products')
+                throw new CliError(`${where}: unknown key "${key}"`);
+        }
+        for (const key of PACKAGE_KEYS) {
+            const field = record[key];
+            if (field === undefined)
+                continue;
+            if (typeof field !== 'string' || field === '')
+                throw new CliError(`${where}: "${key}" must be a string`);
+            pkg[key] = field;
+        }
+        const products = record['products'];
+        if (!Array.isArray(products) || products.length === 0 || !products.every((p) => typeof p === 'string')) {
+            throw new CliError(`${where}: "products" must be a non-empty array of strings`);
+        }
+        pkg.products = products;
+        if (!pkg.url === !pkg.path)
+            throw new CliError(`${where}: give either "url" or "path"`);
+        const rules = PACKAGE_RULES.filter((key) => pkg[key] !== undefined);
+        if (pkg.url && rules.length !== 1)
+            throw new CliError(`${where}: a "url" needs one of "from", "exact", "branch" or "revision"`);
+        if (pkg.path && rules.length > 0)
+            throw new CliError(`${where}: a "path" takes no version rule`);
+        return pkg;
+    });
+}
+/** Whether `value` is an absolute http(s) URL (a CORS proxy's). */
+export function isHTTPURL(value) {
+    try {
+        const url = new URL(value);
+        return url.protocol === 'http:' || url.protocol === 'https:';
+    }
+    catch {
+        return false;
+    }
+}
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,4EAA4E;AAC5E,uBAAuB;AAEvB,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AA6CpC,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAE/C,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AACvE,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,CAAU,CAAC;AAEjG,kGAAkG;AAClG,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,IAAa;IACnD,MAAM,UAAU,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,IAAI,IAAI;YAAE,MAAM,IAAI,QAAQ,CAAC,0BAA0B,UAAU,EAAE,CAAC,CAAC;QACrE,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,QAAQ,CAAC,GAAG,UAAU,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjG,CAAC;IACD,OAAO,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAY,EAAE,MAAM,GAAG,WAAW;IAC/D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,0BAA0B,CAAC,CAAC;IAC3H,MAAM,MAAM,GAAG,GAA8B,CAAC;IAC9C,MAAM,MAAM,GAAW,EAAE,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,MAAM,GAAG,oBAAoB,CAAC,CAAC;QAC1F,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,MAAM,GAAG,+BAA+B,CAAC,CAAC;QAC/I,MAAM,CAAC,GAAG,CAAC,GAAG,KAAiB,CAAC;IAClC,CAAC;IACD,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,SAAS,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACjD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,0CAA0C,CAAC,CAAC;QAC1G,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAClC,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;QAClC,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,MAAM;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,yCAAyC,CAAC,CAAC;QAC/G,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IAC3B,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,qEAAqE,CAAC,CAAC;IACrG,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,IAAI,CAAE,WAAiC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAE,SAA+B,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,mBAAmB,IAAI,GAAG,KAAK,YAAY,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACrL,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,kBAAkB,GAAG,GAAG,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,4EAA4E;AAC5E,uBAAuB;AAEvB,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAkFhD,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAE/C,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAU,CAAC;AACpF,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,CAAU,CAAC;AAE7H,kGAAkG;AAClG,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,IAAa;IACnD,MAAM,UAAU,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IACvD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,IAAI,IAAI;YAAE,MAAM,IAAI,QAAQ,CAAC,0BAA0B,UAAU,EAAE,CAAC,CAAC;QACrE,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,QAAQ,CAAC,GAAG,UAAU,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjG,CAAC;IACD,OAAO,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAY,EAAE,MAAM,GAAG,WAAW;IAC/D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,0BAA0B,CAAC,CAAC;IAC3H,MAAM,MAAM,GAAG,GAA8B,CAAC;IAC9C,MAAM,MAAM,GAAW,EAAE,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,MAAM,GAAG,oBAAoB,CAAC,CAAC;QAC1F,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,MAAM,GAAG,+BAA+B,CAAC,CAAC;QAC/I,MAAM,CAAC,GAAG,CAAC,GAAG,KAAiB,CAAC;IAClC,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,OAAO,MAAM,CAAC,WAAW,CAAC,KAAK,SAAS;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,qCAAqC,CAAC,CAAC;QACjH,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,SAAS,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACjD,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,0CAA0C,CAAC,CAAC;QAC1G,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAClC,CAAC;IACD,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,MAAM,CAAC,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;IACrG,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,SAAS,EAAE,CAAC;QACvC,mFAAmF;QACnF,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,uFAAuF,CAAC,CAAC,CAAC;IAC/G,CAAC;IACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,sCAAsC,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,qEAAqE,CAAC,CAAC;IACrG,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,IAAI,CAAE,WAAiC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAE,SAA+B,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,mBAAmB,IAAI,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,UAAU,IAAI,GAAG,KAAK,YAAY,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YAClO,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,kBAAkB,GAAG,GAAG,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAU,CAAC;AACrF,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAU,CAAC;AAEvE,SAAS,gBAAgB,CAAC,KAAc,EAAE,MAAc;IACtD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,MAAM,+BAA+B,CAAC,CAAC;IACxF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAChC,MAAM,KAAK,GAAG,GAAG,MAAM,cAAc,KAAK,GAAG,CAAC;QAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,KAAK,oBAAoB,CAAC,CAAC;QAC1H,MAAM,MAAM,GAAG,KAAgC,CAAC;QAChD,MAAM,GAAG,GAAkB,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAC5C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,IAAI,CAAE,YAAkC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,UAAU;gBAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,KAAK,kBAAkB,GAAG,GAAG,CAAC,CAAC;QACrI,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,KAAK,KAAK,SAAS;gBAAE,SAAS;YAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE;gBAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,KAAK,MAAM,GAAG,oBAAoB,CAAC,CAAC;YACzG,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACnB,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;YACvG,MAAM,IAAI,QAAQ,CAAC,GAAG,KAAK,mDAAmD,CAAC,CAAC;QAClF,CAAC;QACD,GAAG,CAAC,QAAQ,GAAG,QAAoB,CAAC;QACpC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,KAAK,+BAA+B,CAAC,CAAC;QACxF,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC;QACpE,IAAI,GAAG,CAAC,GAAG,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,KAAK,gEAAgE,CAAC,CAAC;QAChI,IAAI,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;QACjG,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,OAAO,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/coreml.d.ts

@@ -0,0 +1,194 @@
+import { CliError } from './log.js';
+export type ArrayDataType = 'double' | 'float32' | 'float16' | 'int32' | 'int8';
+export type FeatureType = {
+    type: 'int64';
+} | {
+    type: 'double';
+} | {
+    type: 'string';
+} | {
+    type: 'multiArray';
+    shape: number[];
+    dataType: ArrayDataType;
+} | {
+    type: 'dictionary';
+    keyType: 'int64' | 'string';
+};
+export type FeatureDescription = FeatureType & {
+    name: string;
+    optional?: true;
+    /** The feature's description in the model; a doc comment in the generated code, not part of the JSON. */
+    shortDescription?: string;
+};
+export interface ModelMetadata {
+    shortDescription?: string;
+    versionString?: string;
+    author?: string;
+    license?: string;
+    creatorDefined?: Record<string, string>;
+}
+export interface ModelDescription {
+    inputs: FeatureDescription[];
+    outputs: FeatureDescription[];
+    predictedFeatureName?: string;
+    predictedProbabilitiesName?: string;
+    metadata?: ModelMetadata;
+}
+export type ClassLabels = {
+    strings: string[];
+} | {
+    int64s: number[];
+};
+/**
+ * One tree of an ensemble, its nodes in columns, the root first. Children
+ * are positions in these arrays (-1 for a leaf); a leaf's values are
+ * `leafIndices` / `leafValues` from `leafStarts[node]` up to `leafStarts[node + 1]`.
+ */
+export interface Tree {
+    /** TreeNodeBehavior: 0 ≤, 1 <, 2 ≥, 3 >, 4 ==, 5 ≠ (branches), 6 leaf. */
+    behaviors: number[];
+    features: number[];
+    thresholds: number[];
+    trueChildren: number[];
+    falseChildren: number[];
+    /** Whether a missing value (NaN) takes the true branch. */
+    missingTrue: boolean[];
+    leafStarts: number[];
+    leafIndices: number[];
+    leafValues: number[];
+}
+export type TreeTransform = 'none' | 'softmax' | 'logistic' | 'softmaxWithZeroClassReference';
+export interface TreeEnsemble {
+    dimensions: number;
+    base: number[];
+    trees: Tree[];
+    transform: TreeTransform;
+}
+export type ImputedValue = {
+    double: number;
+} | {
+    int64: number;
+} | {
+    string: string;
+} | {
+    doubles: number[];
+} | {
+    int64s: number[];
+} | {
+    stringDictionary: Record<string, number>;
+}
+/** Keys are the int64 keys in decimal (JSON object keys are strings). */
+ | {
+    int64Dictionary: Record<string, number>;
+};
+export type ReplaceValue = {
+    double: number;
+} | {
+    int64: number;
+} | {
+    string: string;
+};
+export type ModelKind = {
+    kind: 'pipeline' | 'pipelineClassifier' | 'pipelineRegressor';
+    models: ModelSpec[];
+} | {
+    kind: 'glmRegressor';
+    weights: number[][];
+    offsets: number[];
+    transform: 'none' | 'logit' | 'probit';
+} | {
+    kind: 'glmClassifier';
+    weights: number[][];
+    offsets: number[];
+    transform: 'logit' | 'probit';
+    encoding: 'referenceClass' | 'oneVsRest';
+    labels: ClassLabels;
+} | ({
+    kind: 'treeEnsembleRegressor';
+} & TreeEnsemble) | ({
+    kind: 'treeEnsembleClassifier';
+    labels: ClassLabels;
+} & TreeEnsemble) | {
+    kind: 'featureVectorizer';
+    columns: {
+        name: string;
+        dimensions: number;
+    }[];
+} | {
+    kind: 'oneHotEncoder';
+    categories: ClassLabels;
+    sparse: boolean;
+    ignoreUnknown: boolean;
+} | {
+    kind: 'normalizer';
+    norm: 'max' | 'l1' | 'l2';
+} | {
+    kind: 'imputer';
+    imputed: ImputedValue;
+    replace?: ReplaceValue;
+} | {
+    kind: 'scaler';
+    shift: number[];
+    scale: number[];
+} | {
+    kind: 'dictVectorizer';
+    keys: ClassLabels;
+} | {
+    kind: 'arrayFeatureExtractor';
+    indices: number[];
+} | {
+    kind: 'categoricalMapping';
+    stringToInt64?: Record<string, number>;
+    int64ToString?: Record<string, string>;
+    defaultString?: string;
+    defaultInt64?: number;
+} | {
+    kind: 'identity';
+};
+export interface ModelSpec {
+    specificationVersion: number;
+    description: ModelDescription;
+    model: ModelKind;
+}
+export declare const SUPPORTED_SUMMARY = "linear and logistic regression (GLM), boosted trees and random forests (tree ensembles), and pipelines of them with feature vectorizers, one-hot encoders, imputers, normalizers, scalers and the other feature-engineering models";
+/** A model the CLI cannot compile: names the file and what is wrong. */
+export declare class ModelError extends CliError {
+}
+/** Parses a model's protobuf bytes; `file` names it in errors. */
+export declare function parseModel(bytes: Uint8Array, file: string): ModelSpec;
+/**
+ * The protobuf of an `.mlmodel` file, or of the root model of an `.mlpackage`
+ * (its Manifest.json names the specification file under Data/).
+ */
+export declare function readModelBytes(file: string): Uint8Array;
+/** The class Xcode generates for `file`: its base name as a Swift identifier. */
+export declare function modelClassName(file: string): string;
+/** A feature name as a Swift identifier, as Xcode spells it: other characters become `_`, keywords get backticks. */
+export declare function swiftIdentifier(name: string): string;
+/** The Swift type Xcode gives a feature. */
+export declare function swiftType(feature: FeatureType): string;
+/**
+ * The spec as JSON for the generated file: objects one key per line (a short
+ * one whose values are all numbers, strings or lists of them on one line),
+ * lists of numbers and strings on one line, NaN and infinities as the strings
+ * the CoreML module's decoder converts back ("nan", "inf", "-inf").
+ */
+export declare function specJSON(value: unknown, indent?: string): string;
+/**
+ * The Swift Xcode would generate for the model, with the model itself
+ * embedded: the class with `model: MLModel`, `urlOfModelInThisBundle`, the
+ * initializers and `load` functions, `prediction` with one argument per input
+ * and with an `Input`, `predictions(inputs:)`; the Input and Output feature
+ * providers. `file` is the model's path (for the header comment).
+ */
+export declare function generateModelSource(className: string, spec: ModelSpec, file: string): string;
+export interface CompiledModel {
+    /** The model file (`.mlmodel`) or package (`.mlpackage`). */
+    file: string;
+    className: string;
+    spec: ModelSpec;
+    /** The generated Swift. */
+    source: string;
+}
+/** Reads, checks and generates the Swift for one model. */
+export declare function compileModel(file: string): CompiledModel;