@aistrike-dev/ui-shell-dev 1.0.3 → 1.0.5

package/README.md

@@ -53,7 +53,12 @@ Read from the Vite root when present (or from the plugin's `devFile` option).
 
 `profile` defaults to `local`, `overrides` point other domains at their own dev servers (bare origins, no path; your
 own domain is overridden automatically), `idleTimeoutMs` defaults to `0` (idle timeout off), and `claims` is merged
-over the default dev claims. The plugin's `claims`, `ttlMs` and `noToken` options win over the file.
+over the default dev claims. The plugin's `claims`, `ttlMs` and `noToken` options win over the file. `"lab": true`
+shows Octopus UI's Design Lab (its live controls for the open design questions, in a Picture-in-Picture window) over
+your pages, so you can judge them on your own screens. `"lab": { "designSystem": "../octopus-ui" }` also names an
+Octopus checkout (relative to the Vite root): **Lock in** then writes a work-loop item into its `.backlog/`, through
+Octopus's Lock-in plugin (`@aistrike-dev/ui/lab/vite`, loaded from the installed `@aistrike-dev/ui`). Without one, or
+when the path is not an Octopus checkout, Lock in downloads the same item instead.
 
 ## Commands
 

package/dist/devfile.d.ts

@@ -2,6 +2,9 @@ import type { DevConfig, DevDomain } from '@aistrike-dev/ui-shell-sdk/shell';
 import type { Session } from '@aistrike-dev/ui-shell-sdk';
 import type { DevClaimsInput } from './token.js';
 export declare const DEV_FILE = "shell.dev.json";
+export interface DevLab {
+    designSystem?: string;
+}
 export interface DevFile {
     profile?: string;
     overrides?: {
@@ -10,6 +13,11 @@ export interface DevFile {
     domains?: DevDomain[];
     idleTimeoutMs?: number;
     landing?: string;
+    /**
+     * Shows Octopus UI's Design Lab over this MFE's pages, to judge open design questions on them. As an object, it is on,
+     * and `designSystem` is the path (from the Vite root) of the Octopus checkout its locks are written to.
+     */
+    lab?: boolean | DevLab;
     claims?: DevClaimsInput;
 }
 /** Dev claims must be a plain object of known keys; `iss`/`exp`/`iat` and friends cannot be smuggled into the token. */

package/dist/devfile.js

@@ -41,7 +41,7 @@ function normalizeOverrides(overrides) {
     }
     return result;
 }
-const FILE_KEYS = ['profile', 'overrides', 'domains', 'idleTimeoutMs', 'landing', 'claims'];
+const FILE_KEYS = ['profile', 'overrides', 'domains', 'idleTimeoutMs', 'landing', 'lab', 'claims'];
 const DOMAIN_KEYS = ['id', 'route', 'nav', 'devPort'];
 const NAV_KEYS = ['label', 'icon'];
 const ROUTE = /^\/[a-z0-9-]+$/;
@@ -111,6 +111,24 @@ function validateLanding(value) {
     }
     return value;
 }
+const LAB_KEYS = ['designSystem'];
+function validateLab(lab) {
+    if (typeof lab === 'boolean') {
+        return lab;
+    }
+    if (!isPlainObject(lab)) {
+        throw new Error('lab must be true, false or an object');
+    }
+    rejectUnknownKeys(lab, LAB_KEYS, 'lab');
+    const { designSystem } = lab;
+    if (designSystem === undefined) {
+        return {};
+    }
+    if (typeof designSystem !== 'string' || designSystem === '') {
+        throw new Error('lab.designSystem must be a non-empty string');
+    }
+    return { designSystem };
+}
 function readExtras(parsed, result) {
     if (parsed.idleTimeoutMs !== undefined) {
         result.idleTimeoutMs = validateIdle(parsed.idleTimeoutMs);
@@ -118,6 +136,9 @@ function readExtras(parsed, result) {
     if (parsed.landing !== undefined) {
         result.landing = validateLanding(parsed.landing);
     }
+    if (parsed.lab !== undefined) {
+        result.lab = validateLab(parsed.lab);
+    }
     if (parsed.claims !== undefined) {
         result.claims = assertClaimsInput(parsed.claims, 'claims');
     }
@@ -169,6 +190,10 @@ export function loadDevFile(path, cwd = process.cwd()) {
 function landingOf(file, args) {
     return args.landing ?? file?.landing;
 }
+/** The lab flag, only when the file sets it: a config without one is the same config it always was. */
+function labOf(file) {
+    return file?.lab === undefined ? {} : { lab: file.lab !== false };
+}
 /** Explicit overrides win over the file; the profile defaults to `local`; the idle timeout defaults to off for local work. */
 export function buildDevConfig(file, args, session) {
     return {
@@ -177,6 +202,7 @@ export function buildDevConfig(file, args, session) {
         domains: file?.domains ?? [],
         idleTimeoutMs: file?.idleTimeoutMs ?? 0,
         landing: landingOf(file, args),
+        ...labOf(file),
         session,
     };
 }

package/dist/vite/plugin.js

@@ -31,6 +31,30 @@ const SHELL_ASSET_TAG = /<(script|link)\b([^>]*?\s(?:src|href)=["']\/assets\/)/g
 export function markShellAssets(html) {
     return html.replace(SHELL_ASSET_TAG, '<$1 vite-ignore$2');
 }
+/**
+ * Mounts Octopus UI's Lock-in endpoint when the dev file names a design-system checkout (`lab.designSystem`), so the
+ * Design Lab's "Lock in" writes a work-loop item into that checkout's backlog. The plugin is Octopus's, loaded from the
+ * copy installed beside this package. Without a checkout, nothing is mounted and the lab downloads the lock instead.
+ */
+async function mountLabLock(context, server, file, root) {
+    const lab = file?.lab;
+    if (typeof lab !== 'object' || lab.designSystem === undefined) {
+        return;
+    }
+    let plugin;
+    try {
+        const { labLockPlugin } = await import('@aistrike-dev/ui/lab/vite');
+        plugin = labLockPlugin({ designSystem: lab.designSystem, root });
+    }
+    catch {
+        console.warn('[octopus-lab] lock-in is disabled: @aistrike-dev/ui/lab/vite could not be loaded');
+        return;
+    }
+    const { configureServer } = plugin;
+    if (typeof configureServer === 'function') {
+        await configureServer.call(context, server);
+    }
+}
 function sendHtml(res, html) {
     res.statusCode = 200;
     res.setHeader('Content-Type', CONTENT_TYPES['.html'] ?? 'text/html');
@@ -104,13 +128,14 @@ export function shellDevHost(options = {}) {
             config = resolved;
             id = mfeId(resolved);
         },
-        configureServer(server) {
+        async configureServer(server) {
             if (!config) {
                 throw new Error('aistrike:shell-dev-host: configureServer ran before configResolved');
             }
             const base = config.base;
             const scheme = server.config.server.https ? 'https' : 'http';
             const file = loadDevFile(options.devFile, config.root);
+            await mountLabLock(this, server, file, config.root);
             let session;
             if (options.noToken !== true) {
                 const claims = { ...(file?.claims ?? {}), ...(options.claims ?? {}) };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aistrike-dev/ui-shell-dev",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "A Vite plugin that serves the AiStrike UI shell from your micro front-end's dev server, plus a dev-token CLI.",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {
@@ -46,14 +46,19 @@
     "e2e": "node scripts/check-pack.mjs && playwright test"
   },
   "peerDependencies": {
+    "@aistrike-dev/ui": ">=6.0.0-alpha.6",
     "vite": "^8.0.0"
   },
   "peerDependenciesMeta": {
+    "@aistrike-dev/ui": {
+      "optional": true
+    },
     "vite": {
       "optional": true
     }
   },
   "devDependencies": {
+    "@aistrike-dev/ui": "6.0.0-alpha.6",
     "@aistrike-dev/ui-shell-sdk": "workspace:*",
     "@playwright/test": "^1.63.0",
     "@types/node": "^24.0.0",