@fluid-app/fluid-cli-portal 0.1.61 → 0.1.62

package/authoring/commands.md

@@ -0,0 +1,242 @@
+# fluid portal commands
+
+## fluid portal
+
+```text
+Usage: fluid portal [options] [command]
+
+Build and develop portal applications
+
+Options:
+  -h, --help                   display help for command
+
+Commands:
+  create [options] <app-name>  Create a new Fluid portal application
+  dev [options]                Start the development server with local portal
+                               content serving
+  build [options]              Build the application for production
+  pull [options]               Pull a Fluid OS definition's resources to the
+                               local portal/ directory
+  push [options]               Push local portal content changes to the Fluid
+                               OS API
+  clone [options] [app]        Clone a portal definition's provisioned GitHub
+                               repo (mints a fresh token per call)
+  deploy [options]             Publish company-owned portal widget runtime
+                               artifacts
+  widget                       Manage Remote DOM portal widgets
+  doctor                       Check portal for scaffold drift and report stale
+                               infrastructure files
+  version                      Manage portal definition versions
+  help [command]               display help for command
+```
+
+## fluid portal create
+
+```text
+Usage: fluid portal create [options] <app-name>
+
+Create a new Fluid portal application
+
+Arguments:
+  app-name                Name of the application to create
+
+Options:
+  --skip-install          Create the scaffold only; skip dependency
+                          installation
+  -o, --output-dir <dir>  Directory to create the project in (defaults to cwd)
+  --local                 Use local monorepo packages via file: links (for
+                          development testing)
+  --remote-template       Use the GitHub starter template instead of the
+                          bundled template
+  -h, --help              display help for command
+```
+
+## fluid portal dev
+
+```text
+Usage: fluid portal dev [options]
+
+Start the development server with local portal content serving
+
+Options:
+  -p, --port <port>  Port to run the dev server on (default: "5173")
+  --host             Expose the dev server to the network
+  --skip-pull        Skip auto-pull if portal/ directory is missing
+  -h, --help         display help for command
+```
+
+## fluid portal build
+
+```text
+Usage: fluid portal build [options]
+
+Build the application for production
+
+Options:
+  -o, --out-dir <dir>  Output directory (default: "dist")
+  -h, --help           display help for command
+```
+
+## fluid portal pull
+
+```text
+Usage: fluid portal pull [options]
+
+Pull a Fluid OS definition's resources to the local portal/ directory
+
+Options:
+  --app <name>  Definition name (skips interactive selector)
+  --id <id>     Definition id (avoids ambiguity when names repeat)
+  --force       Overwrite local changes when switching definitions
+  -h, --help    display help for command
+```
+
+## fluid portal push
+
+```text
+Usage: fluid portal push [options]
+
+Push local portal content changes to the Fluid OS API
+
+Options:
+  --yes                    Skip confirmation prompt
+  --allow-network-widgets  Approve widgets that newly request external network
+                           access
+  --activate               Create and activate a live version after a
+                           successful push
+  -h, --help               display help for command
+```
+
+## fluid portal clone
+
+```text
+Usage: fluid portal clone [options] [app]
+
+Clone a portal definition's provisioned GitHub repo (mints a fresh token per
+call)
+
+Arguments:
+  app           Definition name (prompts to select when omitted)
+
+Options:
+  --app <name>  Definition name (same as the positional argument)
+  --id <id>     Definition id (avoids ambiguity when names repeat)
+  --dir <dir>   Target directory (defaults to ./<slug>/)
+  -h, --help    display help for command
+```
+
+## fluid portal deploy
+
+```text
+Usage: fluid portal deploy [options]
+
+Publish company-owned portal widget runtime artifacts
+
+Options:
+  -e, --environment <name>  Target environment label for output reporting
+                            (default: "production")
+  -o, --out-dir <dir>       Widget artifact output directory (default:
+                            ".fluid/widget-dist")
+  --dry-run                 Build and validate upload payload without
+                            publishing
+  -h, --help                display help for command
+```
+
+## fluid portal widget
+
+```text
+Usage: fluid portal widget [options] [command]
+
+Manage Remote DOM portal widgets
+
+Options:
+  -h, --help               display help for command
+
+Commands:
+  create [options] <name>  Scaffold a new Remote DOM widget
+  help [command]           display help for command
+```
+
+## fluid portal widget create
+
+```text
+Usage: fluid portal widget create [options] <name>
+
+Scaffold a new Remote DOM widget
+
+Arguments:
+  name                       Widget name in kebab-case (e.g., stock-ticker)
+
+Options:
+  -c, --category <category>  Widget category for palette grouping (default:
+                             "components")
+  -h, --help                 display help for command
+```
+
+## fluid portal doctor
+
+```text
+Usage: fluid portal doctor [options]
+
+Check portal for scaffold drift and report stale infrastructure files
+
+Options:
+  -h, --help  display help for command
+```
+
+## fluid portal version
+
+```text
+Usage: fluid portal version [options] [command]
+
+Manage portal definition versions
+
+Options:
+  -h, --help                       display help for command
+
+Commands:
+  create [options]                 Create a new version (snapshot) of the
+                                   portal definition
+  list                             List all versions of the portal definition
+  activate [options] <version-id>  Activate a specific version, making it the
+                                   live version
+  help [command]                   display help for command
+```
+
+## fluid portal version create
+
+```text
+Usage: fluid portal version create [options]
+
+Create a new version (snapshot) of the portal definition
+
+Options:
+  --activate  Activate the version immediately after creation
+  -h, --help  display help for command
+```
+
+## fluid portal version list
+
+```text
+Usage: fluid portal version list [options]
+
+List all versions of the portal definition
+
+Options:
+  -h, --help  display help for command
+```
+
+## fluid portal version activate
+
+```text
+Usage: fluid portal version activate [options] <version-id>
+
+Activate a specific version, making it the live version
+
+Arguments:
+  version-id  The version ID to activate
+
+Options:
+  -y, --yes   Skip confirmation prompt
+  -h, --help  display help for command
+```

package/dist/{backend-dev-plugin-20fLk-4t.mjs → backend-dev-plugin-z9IZCHaY.mjs}

@@ -1,4 +1,4 @@
-import { N as __exportAll } from "./pull-BlG6pMwC.mjs";
+import { N as __exportAll } from "./pull-BWnby_pY.mjs";
 //#region src/vite-plugin/backend-dev-plugin.ts
 var backend_dev_plugin_exports = /* @__PURE__ */ __exportAll({ backendDevPlugin: () => backendDevPlugin });
 /**
@@ -61,4 +61,4 @@ function serve(res, contentType, body) {
 //#endregion
 export { backend_dev_plugin_exports as n, backendDevPlugin as t };
 
-//# sourceMappingURL=backend-dev-plugin-20fLk-4t.mjs.map
+//# sourceMappingURL=backend-dev-plugin-z9IZCHaY.mjs.map

package/dist/{backend-dev-plugin-20fLk-4t.mjs.map → backend-dev-plugin-z9IZCHaY.mjs.map}

@@ -1 +1 @@
-{"version":3,"file":"backend-dev-plugin-20fLk-4t.mjs","names":[],"sources":["../src/vite-plugin/backend-dev-plugin.ts"],"sourcesContent":["import type { Plugin } from \"vite\";\n\nexport interface BackendDevPluginOptions {\n  /** Entry module path relative to project root. @default \"/src/main.tsx\" */\n  entry?: string;\n  /** Production chunk filenames to stub as empty ES modules. */\n  chunks?: string[];\n}\n\n/**\n * Serves dev-compatible responses at production asset paths so the Rails\n * backend can point `PORTAL_CDN_BASE` at `http://localhost:5173` and get\n * HMR + live source without any template changes.\n *\n * Handles:\n * - `/portal.js`  → ESM shim that loads `@vite/client` + the real entry\n * - `/portal.css` → empty (Vite injects CSS via JS in dev)\n * - `/vendor.js`, `/query.js` → empty ES modules (no chunks in dev)\n */\nexport function backendDevPlugin(options?: BackendDevPluginOptions): Plugin {\n  const entry = options?.entry ?? \"/src/main.tsx\";\n  const chunks = options?.chunks ?? [\"vendor.js\", \"query.js\"];\n\n  return {\n    name: \"fluid-backend-dev\",\n    apply: \"serve\",\n\n    // Register BEFORE Vite's SPA fallback so these paths don't\n    // get caught by the index.html catch-all.\n    configureServer(server) {\n      // Idempotency guard: the CLI injects this plugin and a vite.config may\n      // also wire it — only register the middleware once.\n      const flagged = server as unknown as { __fluidBackendDevWired?: boolean };\n      if (flagged.__fluidBackendDevWired) return;\n      flagged.__fluidBackendDevWired = true;\n\n      server.middlewares.use((req, res, next) => {\n        const raw = req.url ?? \"\";\n        const qIndex = raw.indexOf(\"?\");\n        const url = qIndex === -1 ? raw : raw.slice(0, qIndex);\n\n        if (url === \"/portal.js\") {\n          serve(\n            res,\n            \"application/javascript\",\n            [\n              `import RefreshRuntime from \"/@react-refresh\";`,\n              `import \"/@vite/client\";`,\n              `RefreshRuntime.injectIntoGlobalHook(window);`,\n              `window.$RefreshReg$ = () => {};`,\n              `window.$RefreshSig$ = () => (type) => type;`,\n              `window.__vite_plugin_react_preamble_installed__ = true;`,\n              `await import(\"${entry}\");`,\n            ].join(\"\\n\"),\n          );\n          return;\n        }\n\n        if (url === \"/portal.css\") {\n          serve(res, \"text/css\", \"/* dev: CSS injected via JS */\");\n          return;\n        }\n\n        const chunkName = url.startsWith(\"/\") ? url.slice(1) : url;\n        if (chunks.includes(chunkName)) {\n          serve(res, \"application/javascript\", \"export {};\");\n          return;\n        }\n\n        next();\n      });\n    },\n  };\n}\n\nfunction serve(\n  res: import(\"http\").ServerResponse,\n  contentType: string,\n  body: string,\n) {\n  res.setHeader(\"Content-Type\", `${contentType}; charset=utf-8`);\n  res.setHeader(\"Cache-Control\", \"no-store\");\n  res.setHeader(\"Access-Control-Allow-Origin\", \"*\");\n  res.statusCode = 200;\n  res.end(body);\n}\n"],"mappings":";;;;;;;;;;;;;AAmBA,SAAgB,iBAAiB,SAA2C;CAC1E,MAAM,QAAQ,SAAS,SAAS;CAChC,MAAM,SAAS,SAAS,UAAU,CAAC,aAAa,WAAW;AAE3D,QAAO;EACL,MAAM;EACN,OAAO;EAIP,gBAAgB,QAAQ;GAGtB,MAAM,UAAU;AAChB,OAAI,QAAQ,uBAAwB;AACpC,WAAQ,yBAAyB;AAEjC,UAAO,YAAY,KAAK,KAAK,KAAK,SAAS;IACzC,MAAM,MAAM,IAAI,OAAO;IACvB,MAAM,SAAS,IAAI,QAAQ,IAAI;IAC/B,MAAM,MAAM,WAAW,KAAK,MAAM,IAAI,MAAM,GAAG,OAAO;AAEtD,QAAI,QAAQ,cAAc;AACxB,WACE,KACA,0BACA;MACE;MACA;MACA;MACA;MACA;MACA;MACA,iBAAiB,MAAM;MACxB,CAAC,KAAK,KAAK,CACb;AACD;;AAGF,QAAI,QAAQ,eAAe;AACzB,WAAM,KAAK,YAAY,iCAAiC;AACxD;;IAGF,MAAM,YAAY,IAAI,WAAW,IAAI,GAAG,IAAI,MAAM,EAAE,GAAG;AACvD,QAAI,OAAO,SAAS,UAAU,EAAE;AAC9B,WAAM,KAAK,0BAA0B,aAAa;AAClD;;AAGF,UAAM;KACN;;EAEL;;AAGH,SAAS,MACP,KACA,aACA,MACA;AACA,KAAI,UAAU,gBAAgB,GAAG,YAAY,iBAAiB;AAC9D,KAAI,UAAU,iBAAiB,WAAW;AAC1C,KAAI,UAAU,+BAA+B,IAAI;AACjD,KAAI,aAAa;AACjB,KAAI,IAAI,KAAK"}
+{"version":3,"file":"backend-dev-plugin-z9IZCHaY.mjs","names":[],"sources":["../src/vite-plugin/backend-dev-plugin.ts"],"sourcesContent":["import type { Plugin } from \"vite\";\n\nexport interface BackendDevPluginOptions {\n  /** Entry module path relative to project root. @default \"/src/main.tsx\" */\n  entry?: string;\n  /** Production chunk filenames to stub as empty ES modules. */\n  chunks?: string[];\n}\n\n/**\n * Serves dev-compatible responses at production asset paths so the Rails\n * backend can point `PORTAL_CDN_BASE` at `http://localhost:5173` and get\n * HMR + live source without any template changes.\n *\n * Handles:\n * - `/portal.js`  → ESM shim that loads `@vite/client` + the real entry\n * - `/portal.css` → empty (Vite injects CSS via JS in dev)\n * - `/vendor.js`, `/query.js` → empty ES modules (no chunks in dev)\n */\nexport function backendDevPlugin(options?: BackendDevPluginOptions): Plugin {\n  const entry = options?.entry ?? \"/src/main.tsx\";\n  const chunks = options?.chunks ?? [\"vendor.js\", \"query.js\"];\n\n  return {\n    name: \"fluid-backend-dev\",\n    apply: \"serve\",\n\n    // Register BEFORE Vite's SPA fallback so these paths don't\n    // get caught by the index.html catch-all.\n    configureServer(server) {\n      // Idempotency guard: the CLI injects this plugin and a vite.config may\n      // also wire it — only register the middleware once.\n      const flagged = server as unknown as { __fluidBackendDevWired?: boolean };\n      if (flagged.__fluidBackendDevWired) return;\n      flagged.__fluidBackendDevWired = true;\n\n      server.middlewares.use((req, res, next) => {\n        const raw = req.url ?? \"\";\n        const qIndex = raw.indexOf(\"?\");\n        const url = qIndex === -1 ? raw : raw.slice(0, qIndex);\n\n        if (url === \"/portal.js\") {\n          serve(\n            res,\n            \"application/javascript\",\n            [\n              `import RefreshRuntime from \"/@react-refresh\";`,\n              `import \"/@vite/client\";`,\n              `RefreshRuntime.injectIntoGlobalHook(window);`,\n              `window.$RefreshReg$ = () => {};`,\n              `window.$RefreshSig$ = () => (type) => type;`,\n              `window.__vite_plugin_react_preamble_installed__ = true;`,\n              `await import(\"${entry}\");`,\n            ].join(\"\\n\"),\n          );\n          return;\n        }\n\n        if (url === \"/portal.css\") {\n          serve(res, \"text/css\", \"/* dev: CSS injected via JS */\");\n          return;\n        }\n\n        const chunkName = url.startsWith(\"/\") ? url.slice(1) : url;\n        if (chunks.includes(chunkName)) {\n          serve(res, \"application/javascript\", \"export {};\");\n          return;\n        }\n\n        next();\n      });\n    },\n  };\n}\n\nfunction serve(\n  res: import(\"http\").ServerResponse,\n  contentType: string,\n  body: string,\n) {\n  res.setHeader(\"Content-Type\", `${contentType}; charset=utf-8`);\n  res.setHeader(\"Cache-Control\", \"no-store\");\n  res.setHeader(\"Access-Control-Allow-Origin\", \"*\");\n  res.statusCode = 200;\n  res.end(body);\n}\n"],"mappings":";;;;;;;;;;;;;AAmBA,SAAgB,iBAAiB,SAA2C;CAC1E,MAAM,QAAQ,SAAS,SAAS;CAChC,MAAM,SAAS,SAAS,UAAU,CAAC,aAAa,WAAW;AAE3D,QAAO;EACL,MAAM;EACN,OAAO;EAIP,gBAAgB,QAAQ;GAGtB,MAAM,UAAU;AAChB,OAAI,QAAQ,uBAAwB;AACpC,WAAQ,yBAAyB;AAEjC,UAAO,YAAY,KAAK,KAAK,KAAK,SAAS;IACzC,MAAM,MAAM,IAAI,OAAO;IACvB,MAAM,SAAS,IAAI,QAAQ,IAAI;IAC/B,MAAM,MAAM,WAAW,KAAK,MAAM,IAAI,MAAM,GAAG,OAAO;AAEtD,QAAI,QAAQ,cAAc;AACxB,WACE,KACA,0BACA;MACE;MACA;MACA;MACA;MACA;MACA;MACA,iBAAiB,MAAM;MACxB,CAAC,KAAK,KAAK,CACb;AACD;;AAGF,QAAI,QAAQ,eAAe;AACzB,WAAM,KAAK,YAAY,iCAAiC;AACxD;;IAGF,MAAM,YAAY,IAAI,WAAW,IAAI,GAAG,IAAI,MAAM,EAAE,GAAG;AACvD,QAAI,OAAO,SAAS,UAAU,EAAE;AAC9B,WAAM,KAAK,0BAA0B,aAAa;AAClD;;AAGF,UAAM;KACN;;EAEL;;AAGH,SAAS,MACP,KACA,aACA,MACA;AACA,KAAI,UAAU,gBAAgB,GAAG,YAAY,iBAAiB;AAC9D,KAAI,UAAU,iBAAiB,WAAW;AAC1C,KAAI,UAAU,+BAA+B,IAAI;AACjD,KAAI,aAAa;AACjB,KAAI,IAAI,KAAK"}