znode-plugin 0.1.10 → 0.1.11

package/README.md

@@ -248,11 +248,20 @@ package. The store then renders your copy in its place; everything else stays th
 npx znode eject ProductBasicInfo      # or by its slot: npx znode eject product.basicInfo
 ```
 
-It copies the store's file to `src/components/ProductBasicInfo.tsx` (imports turned into the store's `@znode/...`
-aliases), registers it in `src/browser.tsx` under its slot, and prints any npm package the copy needs
-(`npm install zustand@4.5.5`). Edit the copy, then `npm run build` and `npm run dev`. The copy is yours: store fixes to
-the component no longer reach it, so compare it with the store's file after a store upgrade. `npx znode eject` with no
-name lists what can be ejected.
+It copies the store's file to `src/components/ProductBasicInfo.tsx` and registers it in `src/browser.tsx` under its
+slot. On the way:
+
+- **Store imports** become the store's `@znode/...` aliases, or the store barrel that re-exports them
+  (`../../stores/modal` -> `@znode/base-components/stores`).
+- **npm packages** the copy needs are installed at the **store's exact version** (`installed (store versions):
+  zustand@4.5.7`); the ones the store shares (`next-intl`, `lodash`) are not installed: the store's copy is used, and
+  `link-store` gives you their types. `--no-install` only prints the `npm install` line.
+- **Images** it imports from the store (`../../assets/no-image.png`) are copied into `src/images/`. The build ships them
+  with the package and turns the import into `{ src, width, height }`, as Next.js does, so `<Image src={noImage}>` works
+  unchanged. Your own code can import images the same way (`import logo from "../images/logo.png"`).
+
+Edit the copy, then `npm run build` and `npm run dev`. The copy is yours: store fixes to the component no longer reach
+it, so compare it with the store's file after a store upgrade. `npx znode eject` with no name lists what can be ejected.
 
 **The component has no slot yet?** `eject` offers to create one in the **base store** (the store you linked), then ejects:
 

package/lib/next-imports.mjs

@@ -150,6 +150,40 @@ const VALUES = {
 
 const FONT_MODULE = "next/font/google";
 const VIRTUAL = "\0znode-next:";
+
+// Image imports, as Next.js does them (import noImage from "./no-image.png"): the file goes into the package (dist; the
+// store serves a package's files at /api/extensions/files/<file>) and the import becomes { src, width, height }, what
+// next/image takes for a static import, so code written for the store works unchanged.
+const IMAGE = /\.(png|jpe?g|gif|webp|avif|svg|ico)$/i;
+const FILES_URL = "/api/extensions/files";
+
+// the image's size from its header (png, gif, jpeg, svg); 0 when it cannot be read (webp, avif, ico: pass width and
+// height to next/image yourself)
+function imageSize(b, ext) {
+  try {
+    if (ext === ".png" && b.readUInt32BE(0) === 0x89504e47) return { width: b.readUInt32BE(16), height: b.readUInt32BE(20) };
+    if (ext === ".gif" && b.toString("ascii", 0, 3) === "GIF") return { width: b.readUInt16LE(6), height: b.readUInt16LE(8) };
+    if ((ext === ".jpg" || ext === ".jpeg") && b[0] === 0xff && b[1] === 0xd8) {
+      for (let i = 2; i + 9 < b.length; ) {
+        if (b[i] !== 0xff) break;
+        const marker = b[i + 1];
+        if (marker >= 0xc0 && marker <= 0xcf && ![0xc4, 0xc8, 0xcc].includes(marker)) return { width: b.readUInt16BE(i + 7), height: b.readUInt16BE(i + 5) };
+        i += 2 + b.readUInt16BE(i + 2);
+      }
+    }
+    if (ext === ".svg") {
+      const text = b.toString("utf8");
+      const tag = /<svg\b[^>]*>/i.exec(text)?.[0] || "";
+      const width = /\bwidth=["']([\d.]+)/.exec(tag)?.[1];
+      const height = /\bheight=["']([\d.]+)/.exec(tag)?.[1];
+      const box = /\bviewBox=["'][\d.\s,-]*?([\d.]+)[\s,]+([\d.]+)["']/.exec(tag);
+      return { width: Number(width || box?.[1] || 0), height: Number(height || box?.[2] || 0) };
+    }
+  } catch {
+    // a header too short to read: no size
+  }
+  return { width: 0, height: 0 };
+}
 const CHROME = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0 Safari/537.36";
 
 // the stand-in module: each name reads the store's module when used, never at load (a server part is also loaded where
@@ -321,11 +355,22 @@ async function transformFonts(code, id, context) {
  * The rollup plugin. part: "server" | "browser"; prefix: "<name>-<version>"; outDir: dist; fonts: collects what
  * next/font/google built (files, css), which the build adds to the package's assets and stylesheet.
  */
-export function znodeNext({ part, prefix, outDir, fonts, store, storeImports = [] }) {
+export function znodeNext({ part, prefix, outDir, fonts, store, storeImports = [], sourceRoot, buildRoot }) {
   return {
     name: "znode-next",
-    resolveId(source) {
+    resolveId(source, importer) {
       if (MODULES[source]) return VIRTUAL + source;
+      // an image the package's own code imports: the build compiles src/ into .build/ (code only), so a relative image
+      // path is looked up next to the source file the compiled one came from
+      if (IMAGE.test(source) && importer && source.startsWith(".")) {
+        const beside = path.resolve(path.dirname(importer), source);
+        if (fs.existsSync(beside)) return beside;
+        if (sourceRoot && buildRoot) {
+          const inSource = path.resolve(sourceRoot, path.relative(buildRoot, path.dirname(importer)), source);
+          if (fs.existsSync(inSource)) return inSource;
+        }
+        this.error(`image "${source}" (imported by ${path.basename(importer)}) not found: put it under src/ (e.g. src/assets/) and import it from there`);
+      }
       if (SHARED_PACKAGES.has(source) || source.startsWith("@znode/") || source.startsWith(STORE_FILE)) {
         if (!store) this.error(`"${source}" is a store module: connect the store first (npm run link-store -- <store repo>), which writes tsconfig.store.json`);
         // a server part imports from the store's server registry (an allow-list: agents, texts and store context, logger,
@@ -356,6 +401,18 @@ export function znodeNext({ part, prefix, outDir, fonts, store, storeImports = [
       return null;
     },
     load(id) {
+      if (IMAGE.test(id) && fs.existsSync(id)) {
+        // one copy per image, named by the package and a hash of its content (all packages' files share the store's
+        // plugin folder); it goes into the package's assets through the fonts list, whose files the build ships
+        const content = fs.readFileSync(id);
+        const hash = crypto.createHash("sha1").update(content).digest("hex").slice(0, 8);
+        const ext = path.extname(id).toLowerCase();
+        const name = `${prefix}-${path.basename(id, path.extname(id)).replace(/[^a-zA-Z0-9_-]/g, "-")}-${hash}${ext}`;
+        fs.writeFileSync(path.join(outDir, name), content);
+        if (!fonts.some((font) => font.files?.includes(name))) fonts.push({ files: [name], css: "" });
+        const { width, height } = imageSize(content, ext);
+        return `export default ${JSON.stringify({ src: `${FILES_URL}/${name}`, width, height })};`;
+      }
       if (!id.startsWith(VIRTUAL)) return null;
       const name = id.slice(VIRTUAL.length);
       if (name.startsWith(STORE)) return { code: storeStandIn(name.slice(STORE.length), part), syntheticNamedExports: "__store" };

package/lib/znode-package.mjs

@@ -50,6 +50,7 @@ import fs from "node:fs";
 import path from "node:path";
 import { execFileSync, spawnSync } from "node:child_process";
 import { builtinModules, createRequire } from "node:module";
+import { createHash } from "node:crypto";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import vm from "node:vm";
 import { TEMPLATES } from "./templates.mjs";
@@ -313,7 +314,8 @@ function build(target) {
         `  input: ${JSON.stringify(compiled)},`,
         `  output: { file: ${JSON.stringify(path.join(out, target))}, format: "es", sourcemap: true },`,
         `  plugins: [`,
-        `    znodeNext({ part: ${JSON.stringify(part)}, prefix: ${JSON.stringify(prefix)}, outDir: ${JSON.stringify(out)}, fonts, store, storeImports }),`,
+        // sourceRoot / buildRoot: an image a compiled file imports is found next to its source file (src/ -> .build/)
+        `    znodeNext({ part: ${JSON.stringify(part)}, prefix: ${JSON.stringify(prefix)}, outDir: ${JSON.stringify(out)}, fonts, store, storeImports, sourceRoot: ${JSON.stringify(path.dirname(path.join(dir, entry)))}, buildRoot: ${JSON.stringify(tmp)} }),`,
         `    { name: "fonts-out", writeBundle() { fs.writeFileSync(${JSON.stringify(fontsFile)}, JSON.stringify(fonts)); fs.writeFileSync(${JSON.stringify(storeImportsFile)}, JSON.stringify(storeImports)); } },`,
         `  ],`,
         `};`,
@@ -329,9 +331,10 @@ function build(target) {
 
   // styles: concatenated into one stylesheet, after the fonts next/font/google built; assets (fonts, images) keep their
   // names, which the stylesheet refers to
-  if (manifest.styles?.length || fonts.length) {
+  // (the fonts list also carries the images the code imports, with no CSS: next-imports.mjs)
+  if (manifest.styles?.length || fonts.some((font) => font.css)) {
     const css = [
-      ...fonts.map((font) => font.css),
+      ...fonts.map((font) => font.css).filter(Boolean),
       ...(manifest.styles || []).flatMap((pattern) => glob(dir, pattern)).map((file) => fs.readFileSync(file, "utf8")),
     ].join("\n");
     files.styles = [`${prefix}.css`];
@@ -569,7 +572,10 @@ function create(kind, name, dir) {
     fs.mkdirSync(path.dirname(full), { recursive: true });
     fs.writeFileSync(full, typeof content === "string" ? content : JSON.stringify(content, null, 2) + "\n");
   }
-  if (kind !== "content") fs.copyFileSync(path.join(HERE, "..", "types", "extension-api.d.ts"), path.join(target, "src", "extension-api.d.ts"));
+  if (kind !== "content") {
+    // the API types, with the image-import types they reference
+    for (const file of ["extension-api.d.ts", "images.d.ts"]) fs.copyFileSync(path.join(HERE, "..", "types", file), path.join(target, "src", file));
+  }
   console.log(`created ${kind} ${name} in ${target}`);
   console.log("  next: fill in label, publisher and description in znode-package.json, then run its build-and-upload.sh");
 }
@@ -919,6 +925,26 @@ function ejectableComponents(root) {
   return found.sort((a, b) => a.name.localeCompare(b.name));
 }
 
+// a store image a copied file imports (../../assets/no-image.png): copied into the package's src/images (not src/assets,
+// which a package ships as it is: an imported image is shipped by the build, which turns the import into
+// { src, width, height }), and the import's new path from the copy
+const STORE_ASSET = /\.(png|jpe?g|gif|webp|avif|svg|ico)$/i;
+function copyStoreAsset(project, absolute, copyFile) {
+  if (!fs.existsSync(absolute)) return null;
+  const assets = path.join(project, "src", "images");
+  fs.mkdirSync(assets, { recursive: true });
+  const content = fs.readFileSync(absolute);
+  let local = path.join(assets, path.basename(absolute));
+  // another image with the same name already there: this one gets a hash in its name
+  if (fs.existsSync(local) && !fs.readFileSync(local).equals(content)) {
+    const ext = path.extname(absolute);
+    local = path.join(assets, `${path.basename(absolute, ext)}-${createHash("sha1").update(content).digest("hex").slice(0, 6)}${ext}`);
+  }
+  if (!fs.existsSync(local)) fs.writeFileSync(local, content);
+  const spec = path.relative(path.dirname(copyFile), local).split(path.sep).join("/");
+  return { spec: spec.startsWith(".") ? spec : `./${spec}`, file: path.relative(project, local).split(path.sep).join("/") };
+}
+
 // a store file that re-exports `target` (export * from / export { … } from), followed through nested barrels
 function reExports(barrel, target, seen = new Set()) {
   if (!barrel || seen.has(barrel) || !fs.existsSync(barrel)) return false;
@@ -1003,9 +1029,18 @@ function ejectRouteCopy(project, s, store) {
   // relative imports become the store's aliases (the package lives elsewhere)
   const warnings = [];
   text = text.replace(/((?:from|import)\s*\(?\s*["'])(\.{1,2}\/[^"']+)(["'])/g, (whole, before, spec, after, offset, source) => {
+    // a store image: copied into src/images, imported from there (the build ships it)
+    if (STORE_ASSET.test(spec)) {
+      const asset = copyStoreAsset(project, path.resolve(path.dirname(storeFile), spec), path.join(project, "src", "server", "pages", `${name}.tsx`));
+      if (!asset) {
+        warnings.push(`image ${spec}: not found in the store; add it under src/images and import it from there`);
+        return whole;
+      }
+      return `${before}${asset.spec}${after}`;
+    }
     const alias = storeAlias(store, path.resolve(path.dirname(storeFile), spec), { statement: source.slice(source.lastIndexOf("import", offset), offset) });
     if (!alias) {
-      warnings.push(`import ${spec}: no store alias for it; change it by hand`);
+      warnings.push(`import ${spec}: no store alias for it (nor a store barrel that re-exports its names); change it by hand`);
       return whole;
     }
     return `${before}${alias}${after}`;
@@ -1189,6 +1224,8 @@ async function eject(name, force, { slot: slotArg, yes, noInstall } = {}) {
   const out = path.join(project, "src", "components", `${c.name}.tsx`);
   if (fs.existsSync(out) && !force) fail(`${path.relative(project, out)} exists: delete it or run znode eject ${c.name} --force`);
   const warnings = [];
+  // the store images the copy imports, copied into src/images
+  const copiedAssets = new Set();
   let text = fs.readFileSync(c.file, "utf8");
   // relative imports become the store's aliases (the package lives elsewhere); a style file stays the store's
   text = text.replace(/((?:from|import)\s*\(?\s*["'])(\.{1,2}\/[^"']+)(["'])/g, (whole, before, spec, after, offset, source) => {
@@ -1197,6 +1234,15 @@ async function eject(name, force, { slot: slotArg, yes, noInstall } = {}) {
       warnings.push(`style import ${spec}: kept out of the copy; the store's own stylesheet is loaded where the store renders it, add your CSS to src/styles/`);
       return `${before}${spec}${after}`;
     }
+    if (STORE_ASSET.test(spec)) {
+      const asset = copyStoreAsset(project, absolute, out);
+      if (!asset) {
+        warnings.push(`image ${spec}: not found in the store; add it under src/images and import it from there`);
+        return whole;
+      }
+      copiedAssets.add(asset.file);
+      return `${before}${asset.spec}${after}`;
+    }
     const alias = storeAlias(store, absolute, { statement: source.slice(source.lastIndexOf("import", offset), offset) });
     if (!alias) {
       warnings.push(`import ${spec}: no store alias for it (nor a store barrel that re-exports its names); change it by hand`);
@@ -1217,6 +1263,7 @@ async function eject(name, force, { slot: slotArg, yes, noInstall } = {}) {
   fs.mkdirSync(path.dirname(out), { recursive: true });
   fs.writeFileSync(out, text);
   console.log(`ejected ${c.name} -> ${path.relative(project, out)}`);
+  if (copiedAssets.size) console.log(`copied the store's images it imports: ${[...copiedAssets].join(", ")} (shipped with the package)`);
 
   // npm packages the copy imports: the store's shared ones are used from the store (types through link-store), the others
   // are installed in this package at the store's version (bundled into the package when it builds)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "znode-plugin",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Build, check, pack and deploy Znode runtime plugins and themes: the SDK behind every create-znode-plugin project.",
   "license": "UNLICENSED",
   "type": "module",

package/types/extension-api.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="./images.d.ts" />
 // Znode runtime extension API, version 1: what a theme, plugin or widget package builds against.
 // A package imports nothing from the webstore; everything comes in through these hooks and the browser host.
 

package/types/images.d.ts

@@ -0,0 +1,40 @@
+// Image imports in a package, as in a Next.js app: import noImage from "./no-image.png". The build ships the file with the
+// package and the import is { src, width, height } (what next/image takes for a static import; width and height are 0
+// for webp, avif and ico: pass them to next/image yourself).
+interface IZnodeStaticImage {
+  src: string;
+  width: number;
+  height: number;
+}
+declare module "*.png" {
+  const image: IZnodeStaticImage;
+  export default image;
+}
+declare module "*.jpg" {
+  const image: IZnodeStaticImage;
+  export default image;
+}
+declare module "*.jpeg" {
+  const image: IZnodeStaticImage;
+  export default image;
+}
+declare module "*.gif" {
+  const image: IZnodeStaticImage;
+  export default image;
+}
+declare module "*.webp" {
+  const image: IZnodeStaticImage;
+  export default image;
+}
+declare module "*.avif" {
+  const image: IZnodeStaticImage;
+  export default image;
+}
+declare module "*.ico" {
+  const image: IZnodeStaticImage;
+  export default image;
+}
+declare module "*.svg" {
+  const image: IZnodeStaticImage;
+  export default image;
+}