@wippy-fe/vite-plugin 0.0.27 → 0.0.28

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+import { Plugin } from 'vite';
+export { WIPPY_PACKAGE_DATA_ROLE } from '@wippy-fe/shared';
+
+/**
+ * Vite plugins shared across Wippy apps and web components.
+ *
+ * **Status: Draft 1 (preview).** API may change between minor releases.
+ */
+
+interface WippyPackagePluginOptions {
+    /**
+     * Path to the project's `package.json`. Defaults to `package.json`
+     * relative to Vite's resolved root (which is the directory containing
+     * `vite.config.ts` for typical app layouts).
+     */
+    packageJsonPath?: string;
+    /**
+     * If `true`, fail the build when `package.json` cannot be read. If
+     * `false` (default), the plugin silently no-ops — useful for shared
+     * configs where some target apps don't need the injection.
+     */
+    required?: boolean;
+}
+/**
+ * Injects the consuming app's `package.json` content into `app.html` as
+ * `<script type="application/json" data-role="@wippy/package">`. The
+ * script is placed at the top of `<head>` so it lands in the DOM before
+ * `dev-proxy.js` runs in host-less mode.
+ *
+ * dev-proxy reads the JSON synchronously at boot to seed proxy injection
+ * defaults from `wippy.proxy.injections` and per-page theme defaults
+ * from `wippy.configOverrides.customization`. Under a real Wippy host
+ * the script tag is harmless metadata — the host reads `package.json`
+ * from the registry server-side and ignores the inline copy.
+ *
+ * Usage:
+ *
+ * ```ts
+ * // vite.config.ts
+ * import { defineConfig } from 'vite'
+ * import vue from '@vitejs/plugin-vue'
+ * import { wippyPackagePlugin } from '@wippy-fe/vite-plugin'
+ *
+ * export default defineConfig({
+ *   plugins: [vue(), wippyPackagePlugin()],
+ *   // …
+ * })
+ * ```
+ */
+declare function wippyPackagePlugin(options?: WippyPackagePluginOptions): Plugin;
+
+export { type WippyPackagePluginOptions, wippyPackagePlugin };

package/dist/index.js

@@ -0,0 +1,43 @@
+// src/index.ts
+import { readFileSync } from "fs";
+import { resolve } from "path";
+
+// ../@wippy-fe--shared/src/index.ts
+var WIPPY_PACKAGE_DATA_ROLE = "@wippy/package";
+
+// src/index.ts
+function wippyPackagePlugin(options = {}) {
+  let root;
+  return {
+    name: "@wippy-fe/vite-plugin:wippy-package",
+    enforce: "pre",
+    configResolved(config) {
+      root = config.root;
+    },
+    transformIndexHtml: {
+      order: "pre",
+      handler(html) {
+        const pkgPath = options.packageJsonPath ?? resolve(root, "package.json");
+        let raw;
+        try {
+          raw = readFileSync(pkgPath, "utf-8");
+        } catch (err) {
+          if (options.required)
+            throw new Error(`[@wippy-fe/vite-plugin] failed to read ${pkgPath}: ${err.message}`);
+          return html;
+        }
+        const safeJson = raw.replace(/<\/script/gi, "<\\/script");
+        const tag = `<script type="application/json" data-role="${WIPPY_PACKAGE_DATA_ROLE}">${safeJson}</script>`;
+        if (html.includes("<head>"))
+          return html.replace("<head>", `<head>
+    ${tag}`);
+        return tag + html;
+      }
+    }
+  };
+}
+export {
+  WIPPY_PACKAGE_DATA_ROLE,
+  wippyPackagePlugin
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../../@wippy-fe--shared/src/index.ts"],"sourcesContent":["/**\n * Vite plugins shared across Wippy apps and web components.\n *\n * **Status: Draft 1 (preview).** API may change between minor releases.\n */\n\nimport type { Plugin, ResolvedConfig } from 'vite'\nimport { readFileSync } from 'node:fs'\nimport { resolve } from 'node:path'\nimport { WIPPY_PACKAGE_DATA_ROLE } from '@wippy-fe/shared'\n\nexport { WIPPY_PACKAGE_DATA_ROLE }\n\nexport interface WippyPackagePluginOptions {\n  /**\n   * Path to the project's `package.json`. Defaults to `package.json`\n   * relative to Vite's resolved root (which is the directory containing\n   * `vite.config.ts` for typical app layouts).\n   */\n  packageJsonPath?: string\n  /**\n   * If `true`, fail the build when `package.json` cannot be read. If\n   * `false` (default), the plugin silently no-ops — useful for shared\n   * configs where some target apps don't need the injection.\n   */\n  required?: boolean\n}\n\n/**\n * Injects the consuming app's `package.json` content into `app.html` as\n * `<script type=\"application/json\" data-role=\"@wippy/package\">`. The\n * script is placed at the top of `<head>` so it lands in the DOM before\n * `dev-proxy.js` runs in host-less mode.\n *\n * dev-proxy reads the JSON synchronously at boot to seed proxy injection\n * defaults from `wippy.proxy.injections` and per-page theme defaults\n * from `wippy.configOverrides.customization`. Under a real Wippy host\n * the script tag is harmless metadata — the host reads `package.json`\n * from the registry server-side and ignores the inline copy.\n *\n * Usage:\n *\n * ```ts\n * // vite.config.ts\n * import { defineConfig } from 'vite'\n * import vue from '@vitejs/plugin-vue'\n * import { wippyPackagePlugin } from '@wippy-fe/vite-plugin'\n *\n * export default defineConfig({\n *   plugins: [vue(), wippyPackagePlugin()],\n *   // …\n * })\n * ```\n */\nexport function wippyPackagePlugin(options: WippyPackagePluginOptions = {}): Plugin {\n  let root: string\n\n  return {\n    name: '@wippy-fe/vite-plugin:wippy-package',\n    enforce: 'pre',\n    configResolved(config: ResolvedConfig) {\n      root = config.root\n    },\n    transformIndexHtml: {\n      order: 'pre',\n      handler(html) {\n        const pkgPath = options.packageJsonPath ?? resolve(root, 'package.json')\n        let raw: string\n        try {\n          raw = readFileSync(pkgPath, 'utf-8')\n        }\n        catch (err) {\n          if (options.required)\n            throw new Error(`[@wippy-fe/vite-plugin] failed to read ${pkgPath}: ${(err as Error).message}`)\n          return html\n        }\n        // Defang `</script>` sequences inside the JSON so the script tag\n        // can't be terminated early. JSON.stringify(JSON.parse(raw))\n        // would also collapse whitespace; we keep formatting for\n        // readability and just escape the close tag.\n        const safeJson = raw.replace(/<\\/script/gi, '<\\\\/script')\n        const tag = `<script type=\"application/json\" data-role=\"${WIPPY_PACKAGE_DATA_ROLE}\">${safeJson}</script>`\n        if (html.includes('<head>'))\n          return html.replace('<head>', `<head>\\n    ${tag}`)\n        // No <head> tag — best effort prepend.\n        return tag + html\n      },\n    },\n  }\n}\n","/**\n * Cross-boundary contracts shared between the gen-2-chat host and the\n * `@wippy-fe/*` consumer packages.\n *\n * **Pure types and string-name constants.** No runtime code, no\n * `@wippy-fe/proxy` dependency. Importing from this module never loads\n * the proxy globals checker — it is safe to import from anywhere in the\n * host source tree without tripping the `host-import-guard` Vite plugin\n * (this package is on the allowlist).\n *\n * **Status: Draft 1 (preview).** Field names and shapes may change\n * between minor releases until a production consumer drives the corner\n * cases out.\n */\n\n// ─── Layout bus envelopes ────────────────────────────────────────────\n\n/**\n * In-tab broadcast envelope. Same shape on both sides of the bus —\n * iframe panels, host-mounted web components, and headless services\n * all see this object.\n */\nexport interface BroadcastEnvelope {\n  channel: string\n  payload: unknown\n  sourcePanelId: string | null\n  targetPanelId: string | null\n}\n\n/**\n * Panel-bound layout bus exposed on `el.__wippyHostBus` for web\n * components mounted as `kind: 'component'` panels. Source / target\n * attribution is set by the host — publishers cannot spoof it.\n */\nexport interface LayoutBusBound {\n  /** 1:N broadcast — every other panel receives, sender excluded. */\n  broadcast: (channel: string, payload: unknown) => void\n  /** 1:1 send — only `target` receives. Unknown targets are no-ops. */\n  send: (target: string, channel: string, payload: unknown) => void\n  /** Subscribe; returns an `off()` for cleanup. */\n  subscribe: (handler: (env: BroadcastEnvelope) => void) => () => void\n}\n\n// ─── Layout mutation targets ─────────────────────────────────────────\n\n/**\n * Drop target positions (relative to a slot rect). Reserved for the\n * future panelDrag capability; declared in v1 for forward compat.\n */\nexport type DropPosition = 'left' | 'right' | 'top' | 'bottom' | 'center' | 'none'\n\n/**\n * Slot size grammar (mirrors `@wippy-fe/layout` `SizeValue`). Tight\n * whitelist — `clamp()`, `minmax()`, `min-content`, `calc()`, em/rem/\n * vh/vw are rejected at validateLayout time. See `@wippy-fe/layout`\n * `helpers.ts` \"Size grammar\" for rationale.\n */\nexport type SizeValue\n  = | 'auto'\n    | `${number}fr`\n    | `${number}px`\n    | `${number}%`\n\n/** Pixel-only size, used for min/max and drawer dimensions. */\nexport type PixelSize = `${number}px`\n\n/**\n * Target for addPanel / movePanel. `relativeTo` names a panel already in\n * the tree; `position` picks the drop relative to that panel's rect.\n * Omit `relativeTo` to attach to the root tree (position becomes\n * direction-aware).\n */\nexport interface PanelTarget {\n  relativeTo?: string\n  position: DropPosition\n  size?: SizeValue\n}\n\n// ─── Global-name constants ───────────────────────────────────────────\n//\n// These literal strings name the four `window.*` globals that the host\n// writes and consumer code reads. Both sides MUST agree on the spelling\n// — moving a typo here would silently break communication across the\n// host/proxy boundary. No `Window` augmentation is declared in this\n// package because the augmentation references host-side types\n// (`AppConfig`, `ProxyApiInstance`); host-side `src/shared/constants/global.ts`\n// keeps the `declare global` block.\n\nexport const GLOBAL_CONFIG_VAR = '__WIPPY_APP_CONFIG__' as const\nexport const GLOBAL_PROXY_CONFIG_VAR = '__WIPPY_PROXY_CONFIG__' as const\nexport const GLOBAL_API_PROVIDER = '__WIPPY_APP_API__' as const\nexport const GLOBAL_WEB_COMPONENT_CACHE = '__WIPPY_WEB_COMPONENT_CACHE__' as const\n\n// ─── HTML data-role markers ─────────────────────────────────────────\n//\n// `data-role` attributes that the host and dev-proxy use to find anchor\n// elements in the consuming app's `app.html`. The host removes / inserts\n// scripts at the `@wippy/scripts` element; dev-proxy reads the consuming\n// app's package.json from the `@wippy/package` JSON script (injected at\n// build time by `@wippy-fe/vite-plugin`'s `wippyPackagePlugin()`).\n\nexport const WIPPY_SCRIPTS_DATA_ROLE = '@wippy/scripts' as const\nexport const WIPPY_PACKAGE_DATA_ROLE = '@wippy/package' as const\n"],"mappings":";AAOA,SAAS,oBAAoB;AAC7B,SAAS,eAAe;;;AC8FjB,IAAM,0BAA0B;;;ADhDhC,SAAS,mBAAmB,UAAqC,CAAC,GAAW;AAClF,MAAI;AAEJ,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS;AAAA,IACT,eAAe,QAAwB;AACrC,aAAO,OAAO;AAAA,IAChB;AAAA,IACA,oBAAoB;AAAA,MAClB,OAAO;AAAA,MACP,QAAQ,MAAM;AACZ,cAAM,UAAU,QAAQ,mBAAmB,QAAQ,MAAM,cAAc;AACvE,YAAI;AACJ,YAAI;AACF,gBAAM,aAAa,SAAS,OAAO;AAAA,QACrC,SACO,KAAK;AACV,cAAI,QAAQ;AACV,kBAAM,IAAI,MAAM,0CAA0C,OAAO,KAAM,IAAc,OAAO,EAAE;AAChG,iBAAO;AAAA,QACT;AAKA,cAAM,WAAW,IAAI,QAAQ,eAAe,YAAY;AACxD,cAAM,MAAM,8CAA8C,uBAAuB,KAAK,QAAQ;AAC9F,YAAI,KAAK,SAAS,QAAQ;AACxB,iBAAO,KAAK,QAAQ,UAAU;AAAA,MAAe,GAAG,EAAE;AAEpD,eAAO,MAAM;AAAA,MACf;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,20 +1,24 @@
 {
   "name": "@wippy-fe/vite-plugin",
   "type": "module",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "Vite plugins for Wippy apps and web components — package metadata injection, future build-time helpers.",
   "license": "UNLICENSED",
   "sideEffects": false,
-  "main": "src/index.ts",
-  "types": "src/index.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "package.json",
-    "src/"
+    "dist/"
   ],
   "peerDependencies": {
     "vite": "^5 || ^6 || ^7"
   },
-  "dependencies": {
-    "@wippy-fe/shared": "0.0.27"
+  "devDependencies": {
+    "@wippy-fe/shared": "0.0.28"
+  },
+  "scripts": {
+    "build": "tsup"
   }
 }

package/src/index.test.ts

@@ -1,84 +0,0 @@
-/**
- * @vitest-environment node
- *
- * Vite plugin runs at build time and reads the file system — node env,
- * not jsdom. We mock `node:fs.readFileSync` so the test doesn't touch
- * the actual repo's package.json.
- */
-import type { IndexHtmlTransformContext } from 'vite'
-import { describe, expect, it, vi } from 'vitest'
-import { wippyPackagePlugin } from './index'
-
-vi.mock('node:fs', () => ({
-  readFileSync: vi.fn(),
-}))
-
-const { readFileSync } = await import('node:fs')
-
-interface InvokablePlugin {
-  configResolved?: (config: unknown) => void
-  transformIndexHtml: {
-    handler: (html: string, ctx?: IndexHtmlTransformContext) => string
-  }
-}
-
-function invokePlugin(html: string, packageJson: string | Error): string {
-  if (packageJson instanceof Error) {
-    vi.mocked(readFileSync).mockImplementationOnce(() => {
-      throw packageJson
-    })
-  }
-  else {
-    vi.mocked(readFileSync).mockReturnValueOnce(packageJson)
-  }
-
-  const plugin = wippyPackagePlugin() as unknown as InvokablePlugin
-  plugin.configResolved?.({ root: '/fake' })
-  return plugin.transformIndexHtml.handler(html)
-}
-
-describe('wippyPackagePlugin', () => {
-  it('injects the package JSON as a data-role script at the top of <head>', () => {
-    const out = invokePlugin('<html><head><meta charset="utf-8"></head></html>', '{"name":"demo"}')
-    expect(out).toContain('<script type="application/json" data-role="@wippy/package">{"name":"demo"}</script>')
-    expect(out.indexOf('data-role="@wippy/package"')).toBeLessThan(out.indexOf('charset'))
-  })
-
-  it('defangs `</script>` sequences inside the JSON so the tag cannot be terminated early', () => {
-    const malicious = '{"trick": "</script><img src=x onerror=alert(1)>"}'
-    const out = invokePlugin('<html><head></head></html>', malicious)
-    // The literal `</script` must not survive intact between the script
-    // tag we opened and the matching close — otherwise the browser
-    // would parse the rest of the JSON as HTML.
-    const inside = out.split('data-role="@wippy/package">')[1].split('</script>')[0]
-    expect(inside).not.toContain('</script')
-    expect(inside).toContain('<\\/script')
-  })
-
-  it('defangs case-insensitively (`</SCRIPT`, `</Script`)', () => {
-    const out = invokePlugin('<html><head></head></html>', '{"a":"</SCRIPT</Script"}')
-    const inside = out.split('data-role="@wippy/package">')[1].split('</script>')[0]
-    expect(inside).not.toMatch(/<\/script/i)
-  })
-
-  it('silently no-ops when package.json is missing and required is false (default)', () => {
-    const html = '<html><head></head></html>'
-    const out = invokePlugin(html, new Error('ENOENT'))
-    expect(out).toBe(html)
-    expect(out).not.toContain('@wippy/package')
-  })
-
-  it('throws when package.json is missing and required: true', () => {
-    vi.mocked(readFileSync).mockImplementationOnce(() => {
-      throw new Error('ENOENT: missing')
-    })
-    const plugin = wippyPackagePlugin({ required: true }) as unknown as InvokablePlugin
-    plugin.configResolved?.({ root: '/fake' })
-    expect(() => plugin.transformIndexHtml.handler('<html><head></head></html>')).toThrow(/ENOENT/)
-  })
-
-  it('best-effort prepends the script tag when <head> is missing', () => {
-    const out = invokePlugin('<html><body>no head</body></html>', '{"name":"x"}')
-    expect(out.startsWith('<script type="application/json" data-role="@wippy/package">')).toBe(true)
-  })
-})

package/src/index.ts

@@ -1,90 +0,0 @@
-/**
- * Vite plugins shared across Wippy apps and web components.
- *
- * **Status: Draft 1 (preview).** API may change between minor releases.
- */
-
-import type { Plugin, ResolvedConfig } from 'vite'
-import { readFileSync } from 'node:fs'
-import { resolve } from 'node:path'
-import { WIPPY_PACKAGE_DATA_ROLE } from '@wippy-fe/shared'
-
-export { WIPPY_PACKAGE_DATA_ROLE }
-
-export interface WippyPackagePluginOptions {
-  /**
-   * Path to the project's `package.json`. Defaults to `package.json`
-   * relative to Vite's resolved root (which is the directory containing
-   * `vite.config.ts` for typical app layouts).
-   */
-  packageJsonPath?: string
-  /**
-   * If `true`, fail the build when `package.json` cannot be read. If
-   * `false` (default), the plugin silently no-ops — useful for shared
-   * configs where some target apps don't need the injection.
-   */
-  required?: boolean
-}
-
-/**
- * Injects the consuming app's `package.json` content into `app.html` as
- * `<script type="application/json" data-role="@wippy/package">`. The
- * script is placed at the top of `<head>` so it lands in the DOM before
- * `dev-proxy.js` runs in host-less mode.
- *
- * dev-proxy reads the JSON synchronously at boot to seed proxy injection
- * defaults from `wippy.proxy.injections` and per-page theme defaults
- * from `wippy.configOverrides.customization`. Under a real Wippy host
- * the script tag is harmless metadata — the host reads `package.json`
- * from the registry server-side and ignores the inline copy.
- *
- * Usage:
- *
- * ```ts
- * // vite.config.ts
- * import { defineConfig } from 'vite'
- * import vue from '@vitejs/plugin-vue'
- * import { wippyPackagePlugin } from '@wippy-fe/vite-plugin'
- *
- * export default defineConfig({
- *   plugins: [vue(), wippyPackagePlugin()],
- *   // …
- * })
- * ```
- */
-export function wippyPackagePlugin(options: WippyPackagePluginOptions = {}): Plugin {
-  let root: string
-
-  return {
-    name: '@wippy-fe/vite-plugin:wippy-package',
-    enforce: 'pre',
-    configResolved(config: ResolvedConfig) {
-      root = config.root
-    },
-    transformIndexHtml: {
-      order: 'pre',
-      handler(html) {
-        const pkgPath = options.packageJsonPath ?? resolve(root, 'package.json')
-        let raw: string
-        try {
-          raw = readFileSync(pkgPath, 'utf-8')
-        }
-        catch (err) {
-          if (options.required)
-            throw new Error(`[@wippy-fe/vite-plugin] failed to read ${pkgPath}: ${(err as Error).message}`)
-          return html
-        }
-        // Defang `</script>` sequences inside the JSON so the script tag
-        // can't be terminated early. JSON.stringify(JSON.parse(raw))
-        // would also collapse whitespace; we keep formatting for
-        // readability and just escape the close tag.
-        const safeJson = raw.replace(/<\/script/gi, '<\\/script')
-        const tag = `<script type="application/json" data-role="${WIPPY_PACKAGE_DATA_ROLE}">${safeJson}</script>`
-        if (html.includes('<head>'))
-          return html.replace('<head>', `<head>\n    ${tag}`)
-        // No <head> tag — best effort prepend.
-        return tag + html
-      },
-    },
-  }
-}