@ikas/component-cli 1.4.0-beta.160 → 1.4.0-beta.161

package/dist/utils/theme-source-archive.d.ts

@@ -0,0 +1,25 @@
+export interface ThemeSourceArchiveResult {
+    /** Absolute path of the zip file that was written. */
+    filePath: string;
+    /** Number of files written into the archive. */
+    fileCount: number;
+    /** Compressed size of the archive, in bytes. */
+    sizeBytes: number;
+}
+/**
+ * Zip the developer's theme source code — everything under `projectRoot` that
+ * isn't a dependency, build artifact, or dotfile — into a zip file on disk at
+ * `outputPath`.
+ *
+ * Uses the same `archiver` library the code-generator relies on, streaming
+ * straight to a write stream so large themes don't have to be buffered whole.
+ * The caller is responsible for deleting `outputPath` once it has been uploaded.
+ *
+ * @param projectRoot Absolute path to the theme project root (the directory
+ *   containing `ikas.config.json`).
+ * @param outputPath Absolute path of the zip file to create.
+ * @param extraIgnore Additional glob patterns to exclude, merged with the
+ *   defaults above.
+ */
+export declare function createThemeSourceZipFile(projectRoot: string, outputPath: string, extraIgnore?: string[]): Promise<ThemeSourceArchiveResult>;
+//# sourceMappingURL=theme-source-archive.d.ts.map

package/dist/utils/theme-source-archive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme-source-archive.d.ts","sourceRoot":"","sources":["../../src/utils/theme-source-archive.ts"],"names":[],"mappings":"AAoBA,MAAM,WAAW,wBAAwB;IACvC,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,wBAAwB,CAC5C,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,WAAW,GAAE,MAAM,EAAO,GACzB,OAAO,CAAC,wBAAwB,CAAC,CAqCnC"}

package/dist/utils/theme-source-archive.js

@@ -0,0 +1,70 @@
+import archiver from "archiver";
+import * as fs from "fs";
+/**
+ * Glob patterns never included in the theme source archive: dependencies, build
+ * artifacts, VCS metadata and incidental junk. Dotfiles are excluded separately
+ * via `dot: false` (so `.env`, `.git`, etc. never leak into the upload).
+ */
+const DEFAULT_IGNORE = [
+    "node_modules/**",
+    "dist/**",
+    "build/**",
+    ".turbo/**",
+    // Output of `ikas-component publish` (compiled bundle, not source).
+    "ikas-components.json",
+    "**/*.zip",
+    "**/*.log",
+    "**/.DS_Store",
+];
+/**
+ * Zip the developer's theme source code — everything under `projectRoot` that
+ * isn't a dependency, build artifact, or dotfile — into a zip file on disk at
+ * `outputPath`.
+ *
+ * Uses the same `archiver` library the code-generator relies on, streaming
+ * straight to a write stream so large themes don't have to be buffered whole.
+ * The caller is responsible for deleting `outputPath` once it has been uploaded.
+ *
+ * @param projectRoot Absolute path to the theme project root (the directory
+ *   containing `ikas.config.json`).
+ * @param outputPath Absolute path of the zip file to create.
+ * @param extraIgnore Additional glob patterns to exclude, merged with the
+ *   defaults above.
+ */
+export async function createThemeSourceZipFile(projectRoot, outputPath, extraIgnore = []) {
+    return new Promise((resolve, reject) => {
+        const output = fs.createWriteStream(outputPath);
+        const archive = archiver("zip", { zlib: { level: 9 } });
+        let fileCount = 0;
+        // `close` fires once all bytes have been flushed to disk — only then is the
+        // pointer (total size) final and the file safe to upload.
+        output.on("close", () => {
+            resolve({
+                filePath: outputPath,
+                fileCount,
+                sizeBytes: archive.pointer(),
+            });
+        });
+        output.on("error", reject);
+        archive.on("entry", () => {
+            fileCount += 1;
+        });
+        // A file vanishing mid-walk (ENOENT) is non-fatal; anything else is a real
+        // failure and should reject.
+        archive.on("warning", (err) => {
+            if (err?.code === "ENOENT")
+                return;
+            reject(err);
+        });
+        archive.on("error", reject);
+        archive.pipe(output);
+        archive.glob("**/*", {
+            cwd: projectRoot,
+            dot: false,
+            nodir: true,
+            ignore: [...DEFAULT_IGNORE, ...extraIgnore],
+        });
+        void archive.finalize();
+    });
+}
+//# sourceMappingURL=theme-source-archive.js.map

package/dist/utils/theme-source-archive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme-source-archive.js","sourceRoot":"","sources":["../../src/utils/theme-source-archive.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB;;;;GAIG;AACH,MAAM,cAAc,GAAG;IACrB,iBAAiB;IACjB,SAAS;IACT,UAAU;IACV,WAAW;IACX,oEAAoE;IACpE,sBAAsB;IACtB,UAAU;IACV,UAAU;IACV,cAAc;CACf,CAAC;AAWF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,WAAmB,EACnB,UAAkB,EAClB,cAAwB,EAAE;IAE1B,OAAO,IAAI,OAAO,CAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC/D,MAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,IAAI,SAAS,GAAG,CAAC,CAAC;QAElB,4EAA4E;QAC5E,0DAA0D;QAC1D,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,OAAO,CAAC;gBACN,QAAQ,EAAE,UAAU;gBACpB,SAAS;gBACT,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE;aAC7B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAE3B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACvB,SAAS,IAAI,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,2EAA2E;QAC3E,6BAA6B;QAC7B,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAA0B,EAAE,EAAE;YACnD,IAAI,GAAG,EAAE,IAAI,KAAK,QAAQ;gBAAE,OAAO;YACnC,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAE5B,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE;YACnB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,KAAK;YACV,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,CAAC,GAAG,cAAc,EAAE,GAAG,WAAW,CAAC;SAC5C,CAAC,CAAC;QACH,KAAK,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/utils/upload-theme-source.d.ts

@@ -0,0 +1,32 @@
+export interface ThemeSourceUploadInput {
+    /** Stable project id from ikas.config.json (may be absent on legacy projects). */
+    projectId?: string;
+    /** Human-readable theme name from ikas.config.json. */
+    name: string;
+    /** Theme version from ikas.config.json. */
+    version: string;
+    /** Absolute path to the zipped theme source code on disk. */
+    zipPath: string;
+    /** Compressed size of the zip, in bytes. */
+    sizeBytes: number;
+    /** Number of files inside the zip. */
+    fileCount: number;
+}
+/**
+ * Send the zipped theme source code to the theme-source API.
+ *
+ * TODO(API): intentionally left unimplemented — this is the seam where the
+ * actual upload goes. Read the file at `input.zipPath` (e.g.
+ * `fs.createReadStream(input.zipPath)`) and POST it together with `projectId` /
+ * `name` / `version`. Throw on a non-2xx response so the caller can surface a
+ * warning. The caller deletes `input.zipPath` after this resolves or rejects,
+ * so don't delete it here.
+ *
+ * Reference fields available:
+ *   - input.zipPath    string  absolute path to the zip to upload
+ *   - input.sizeBytes  number  compressed size
+ *   - input.fileCount  number  files in the archive
+ *   - input.projectId / input.name / input.version
+ */
+export declare function uploadThemeSource(input: ThemeSourceUploadInput): Promise<void>;
+//# sourceMappingURL=upload-theme-source.d.ts.map

package/dist/utils/upload-theme-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-theme-source.d.ts","sourceRoot":"","sources":["../../src/utils/upload-theme-source.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,kFAAkF;IAClF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,iBAAiB,CACrC,KAAK,EAAE,sBAAsB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/dist/utils/upload-theme-source.js

@@ -0,0 +1,21 @@
+/**
+ * Send the zipped theme source code to the theme-source API.
+ *
+ * TODO(API): intentionally left unimplemented — this is the seam where the
+ * actual upload goes. Read the file at `input.zipPath` (e.g.
+ * `fs.createReadStream(input.zipPath)`) and POST it together with `projectId` /
+ * `name` / `version`. Throw on a non-2xx response so the caller can surface a
+ * warning. The caller deletes `input.zipPath` after this resolves or rejects,
+ * so don't delete it here.
+ *
+ * Reference fields available:
+ *   - input.zipPath    string  absolute path to the zip to upload
+ *   - input.sizeBytes  number  compressed size
+ *   - input.fileCount  number  files in the archive
+ *   - input.projectId / input.name / input.version
+ */
+export async function uploadThemeSource(input) {
+    // Intentionally empty. Implement the API call here.
+    void input;
+}
+//# sourceMappingURL=upload-theme-source.js.map

package/dist/utils/upload-theme-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-theme-source.js","sourceRoot":"","sources":["../../src/utils/upload-theme-source.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,KAA6B;IAE7B,oDAAoD;IACpD,KAAK,KAAK,CAAC;AACb,CAAC"}

package/dist/utils/vendor-storefront.d.ts

@@ -0,0 +1,13 @@
+import type { Plugin } from "esbuild";
+export declare function isVendoredDependencyFile(file: string): boolean;
+/**
+ * Bundle the storefront SDK into the component artifact.
+ *
+ * Deep imports stay forbidden for *component* source — the public contract is still "import only
+ * from the package root", and a component reaching into `/src/...` is still a bug worth failing
+ * on. But the SDK's own modules deep-import each other constantly (97 lazy `import()` calls into
+ * `@ikas/bp-storefront-api/src/__api/...` alone), and those are internal business. So the rule is
+ * keyed on who is importing, not on what is imported.
+ */
+export declare function vendorStorefrontPlugin(): Plugin;
+//# sourceMappingURL=vendor-storefront.d.ts.map

package/dist/utils/vendor-storefront.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vendor-storefront.d.ts","sourceRoot":"","sources":["../../src/utils/vendor-storefront.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAqCtC,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAK9D;AAqBD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CA+B/C"}

package/dist/utils/vendor-storefront.js

@@ -0,0 +1,91 @@
+import * as fs from "fs";
+import * as os from "os";
+import * as path from "path";
+/**
+ * Compile the storefront SDK *into* the artifact instead of resolving it against the host.
+ *
+ * The default path (`forbidDeepStorefrontImportsPlugin`) leaves `@ikas/bp-storefront*` external,
+ * so a theme has to hand the component every named export it uses at runtime. That makes the set
+ * of names a contract between two independently-released things: publish a component that reaches
+ * for a name older themes lack and the page renders an error box for every visitor, with nothing
+ * to fall back to.
+ *
+ * Vendoring removes the contract rather than versioning it. The artifact carries the SDK code it
+ * was built against, so what a host must still provide shrinks to the handful of packages that
+ * genuinely have to be shared (`preact`, `preact/hooks`, `mobx` — see the externals in compile.ts)
+ * and cannot grow when we add a feature.
+ *
+ * The trade is duplication: a page rendering a vendored component ships this code even though the
+ * theme already has its own copy. That is the point — the two copies are free to be different
+ * versions.
+ */
+/** `@ikas/bp-storefront` and its siblings, with an optional subpath. */
+const VENDORED_PKG = /^(@ikas\/bp-storefront(?:-(?:models|config|api|api-client))?)(\/.*)?$/;
+/**
+ * True for files that belong to a vendored dependency rather than to component source.
+ *
+ * Two shapes, because the SDK resolves differently depending on where the build runs: an npm
+ * install puts it under `node_modules/@ikas/bp-storefront*`, while inside this monorepo npm
+ * workspaces symlink it and esbuild reports the real path under `packages/storefront*`.
+ */
+const VENDORED_FILE = /[\\/](?:node_modules[\\/]@ikas[\\/]bp-storefront[^\\/]*|packages[\\/]storefront(?:-(?:api|api-client|config|models))?)[\\/]/;
+export function isVendoredDependencyFile(file) {
+    if (!file)
+        return false;
+    // Anything already inside node_modules is a transitive dependency of a package we chose to
+    // vendor, not something a component author wrote — the allowlist has no say over it.
+    return file.includes(`${path.sep}node_modules${path.sep}`) || VENDORED_FILE.test(file);
+}
+/**
+ * Stand-in for `isomorphic-fetch`, which the SDK imports in three places.
+ *
+ * That package pulls `node-fetch` in, which references `global` and dies in a browser with
+ * "global is not defined" — a failure the monorepo never sees while the SDK is merely *external*,
+ * because nothing bundles it there. Vendoring is exactly what makes it reachable, so it has to be
+ * aliased away here rather than left to be discovered at runtime.
+ *
+ * Both build targets already have a native `fetch` (browsers, and Node 18+ for the SSR build), so
+ * the shim is a forwarder. It calls through `globalThis` on every invocation instead of capturing
+ * the function, which keeps `this` correct (a bare reference throws "Illegal invocation") and lets
+ * a host install a polyfill after this module is evaluated.
+ */
+const FETCH_SHIM = path.join(os.tmpdir(), "ikas-vendored-fetch-shim.mjs");
+fs.writeFileSync(FETCH_SHIM, "const f = (...args) => globalThis.fetch(...args);\nexport default f;\nexport { f as fetch };\n");
+/**
+ * Bundle the storefront SDK into the component artifact.
+ *
+ * Deep imports stay forbidden for *component* source — the public contract is still "import only
+ * from the package root", and a component reaching into `/src/...` is still a bug worth failing
+ * on. But the SDK's own modules deep-import each other constantly (97 lazy `import()` calls into
+ * `@ikas/bp-storefront-api/src/__api/...` alone), and those are internal business. So the rule is
+ * keyed on who is importing, not on what is imported.
+ */
+export function vendorStorefrontPlugin() {
+    return {
+        name: "ikas-vendor-storefront",
+        setup(build) {
+            build.onResolve({ filter: /^isomorphic-fetch$/ }, () => ({ path: FETCH_SHIM }));
+            build.onResolve({ filter: VENDORED_PKG }, (args) => {
+                const [, root, subpath] = args.path.match(VENDORED_PKG);
+                if (subpath && subpath !== "/" && !isVendoredDependencyFile(args.importer)) {
+                    return {
+                        errors: [
+                            {
+                                text: `Deep import "${args.path}" is not allowed. Import only from the package root ` +
+                                    `"${root}" — e.g. import { saveCouponCode, getCart } from "${root}". ` +
+                                    `Subpaths like "/dist/..." or "/src/..." are private and may be renamed without ` +
+                                    `notice. If a helper seems missing from the root, it almost always has a public ` +
+                                    `name there (coupon code, for instance, is getCouponCodeForm / ` +
+                                    `setCouponCodeFormCouponCode / submitCouponCodeForm).`,
+                            },
+                        ],
+                    };
+                }
+                // Returning nothing hands the specifier back to esbuild's normal resolution, which is
+                // what pulls the source into the bundle. The default path returns `external: true` here.
+                return undefined;
+            });
+        },
+    };
+}
+//# sourceMappingURL=vendor-storefront.js.map

package/dist/utils/vendor-storefront.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vendor-storefront.js","sourceRoot":"","sources":["../../src/utils/vendor-storefront.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B;;;;;;;;;;;;;;;;;GAiBG;AAEH,wEAAwE;AACxE,MAAM,YAAY,GAAG,uEAAuE,CAAC;AAE7F;;;;;;GAMG;AACH,MAAM,aAAa,GACjB,6HAA6H,CAAC;AAEhI,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,2FAA2F;IAC3F,qFAAqF;IACrF,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,eAAe,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzF,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,8BAA8B,CAAC,CAAC;AAC1E,EAAE,CAAC,aAAa,CACd,UAAU,EACV,gGAAgG,CACjG,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO;QACL,IAAI,EAAE,wBAAwB;QAC9B,KAAK,CAAC,KAAK;YACT,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,oBAAoB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAEhF,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;gBACjD,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAE,CAAC;gBAEzD,IAAI,OAAO,IAAI,OAAO,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC3E,OAAO;wBACL,MAAM,EAAE;4BACN;gCACE,IAAI,EACF,gBAAgB,IAAI,CAAC,IAAI,sDAAsD;oCAC/E,IAAI,IAAI,qDAAqD,IAAI,KAAK;oCACtE,iFAAiF;oCACjF,iFAAiF;oCACjF,gEAAgE;oCAChE,sDAAsD;6BACzD;yBACF;qBACF,CAAC;gBACJ,CAAC;gBAED,sFAAsF;gBACtF,yFAAyF;gBACzF,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikas/component-cli",
-  "version": "1.4.0-beta.160",
+  "version": "1.4.0-beta.161",
   "description": "CLI for developing ikas code components",
   "type": "module",
   "main": "./dist/index.js",
@@ -10,7 +10,10 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./build-tools": "./src/build-tools.ts",
+    "./build-tools": {
+      "types": "./dist/build-tools.d.ts",
+      "default": "./dist/build-tools.js"
+    },
     "./package.json": "./package.json"
   },
   "bin": {