@fluid-app/fluid-cli-widget 0.1.0

package/README.md

@@ -0,0 +1,41 @@
+# Fluid Widget CLI
+
+`@fluid-app/fluid-cli-widget` provides the dedicated workflow for standalone Fluid widget packages owned by existing Droplets.
+
+Droplets are not created by this CLI. Create and approve the Droplet first, then pass its UUID with `--droplet` or save it in `fluid.widget.config.ts` with `fluid widget link`.
+
+## Commands
+
+```bash
+fluid widget create my-widget --droplet <uuid>
+fluid widget link --droplet <uuid>
+pnpm dev
+fluid widget build
+fluid widget publish
+fluid widget status
+fluid widget logs
+```
+
+- `fluid widget create <project-name>` — scaffold a standalone widget package project.
+- `fluid widget link` — link the current project to an existing Droplet and package name.
+- `pnpm dev` — run the generated project's local Vite preview for widget development.
+- `fluid widget build` — validate and build runtime artifacts into `.fluid/widget-dist`.
+- `fluid widget publish` — publish a droplet-owned widget package version.
+- `fluid widget status` — show published widget package status for a Droplet.
+- `fluid widget logs` — show recent widget package publish logs for a Droplet.
+
+`fluid widget validate` is also available for checking package metadata without building.
+
+## Typical workflow
+
+```bash
+fluid login
+fluid widget create reviews-widget --droplet <existing-droplet-uuid>
+cd reviews-widget
+pnpm dev
+fluid widget build
+fluid widget publish
+fluid widget status
+```
+
+Use `--dry-run` with `fluid widget publish` to build and inspect the upload payload without creating a widget package version.

package/dist/index.d.mts

@@ -0,0 +1,185 @@
+import { Command } from "commander";
+import { ValidatedWidgetPackageBuild, WidgetPackageValidationError } from "@fluid-app/fluid-cli-portal";
+import { FluidPlugin } from "@fluid-app/fluid-cli";
+
+//#region src/types.d.ts
+interface WidgetTemplateVariables {
+  readonly projectName: string;
+  readonly widgetScope: string;
+  readonly widgetPackageVersion: string;
+  readonly sdkVersion: string;
+  readonly coreVersion: string;
+  readonly fluidCliVersion: string;
+  readonly widgetCliVersion: string;
+  readonly droplet?: string;
+}
+interface WidgetCreateOptions {
+  readonly skipInstall?: boolean;
+  readonly outputDir?: string;
+  readonly scope?: string;
+  readonly local?: boolean;
+  readonly droplet?: string;
+  /** Initial widget package version written into manifest.ts. */
+  readonly packageVersion?: string;
+}
+interface WidgetLinkOptions {
+  readonly droplet?: string;
+}
+interface WidgetCommandOptions {
+  readonly cwd?: string;
+}
+//#endregion
+//#region src/commands/build.d.ts
+interface BuildWidgetOptions {
+  readonly outDir?: string;
+  readonly skipTypecheck?: boolean;
+}
+interface BuildWidgetPackageOptions {
+  readonly projectDir: string;
+  readonly outDir: string;
+  readonly skipTypecheck?: boolean;
+}
+interface BuildWidgetPackageResult {
+  readonly outDir: string;
+  readonly packageId: string;
+  readonly version: string;
+}
+declare function buildWidgetPackage(options: BuildWidgetPackageOptions): Promise<BuildWidgetPackageResult>;
+declare const buildCommand: Command;
+//#endregion
+//#region src/commands/create.d.ts
+declare const createCommand: Command;
+declare function createWidgetProject(projectName: string, options: WidgetCreateOptions): Promise<void>;
+//#endregion
+//#region src/commands/dev.d.ts
+declare const DEFAULT_WIDGET_DEV_PORT = 5174;
+declare const WIDGET_DEV_ROUTES: readonly ["/", "/builder-preview", "/__manifests__", "/__preview__", "/__runtime-entry__"];
+interface WidgetDevOptions {
+  readonly port?: string;
+  readonly host?: boolean | string;
+  readonly mode?: string;
+}
+interface WidgetDevProjectSummary {
+  readonly projectDir: string;
+  readonly packageName: string;
+  readonly viteConfigPath: string;
+  readonly localUrl: string;
+  readonly target: string;
+  readonly mode: string;
+  readonly routes: readonly string[];
+}
+declare const devCommand: Command;
+declare function resolveWidgetDevProject(projectDir: string, options?: WidgetDevOptions): Promise<WidgetDevProjectSummary>;
+declare function buildViteDevArgs(options?: WidgetDevOptions): string[];
+declare function printWidgetDevSummary(summary: WidgetDevProjectSummary): void;
+declare function runViteDevServer(projectDir: string, options?: WidgetDevOptions): Promise<void>;
+//#endregion
+//#region src/commands/link.d.ts
+declare const linkCommand: Command;
+//#endregion
+//#region src/commands/logs.d.ts
+interface LogsCommandOptions {
+  readonly droplet?: string;
+  readonly limit?: string;
+  readonly json?: boolean;
+}
+declare const logsCommand: Command;
+//#endregion
+//#region src/commands/publish.d.ts
+interface PublishWidgetPackageOptions {
+  readonly projectDir: string;
+  readonly outDir: string;
+  readonly droplet?: string;
+  readonly dryRun?: boolean;
+  readonly skipTypecheck?: boolean;
+  readonly client?: unknown;
+}
+interface PublishWidgetPackageResult {
+  readonly dryRun: boolean;
+  readonly uploaded: boolean;
+  readonly outDir: string;
+  readonly droplet?: string;
+}
+interface PublishWidgetPackageDependencies {
+  readonly buildWidgetPackage: (options: {
+    readonly projectDir: string;
+    readonly outDir: string;
+  }) => Promise<void>;
+  readonly uploadWidgetPackage: (options: {
+    readonly outDir: string;
+    readonly droplet?: string;
+    readonly client?: unknown;
+  }) => Promise<void>;
+}
+declare function publishWidgetPackage(options: PublishWidgetPackageOptions, dependencies?: PublishWidgetPackageDependencies): Promise<PublishWidgetPackageResult>;
+interface PublishCommandOptions {
+  readonly outDir?: string;
+  readonly droplet?: string;
+  readonly dryRun?: boolean;
+  readonly skipTypecheck?: boolean;
+}
+declare const publishCommand: Command;
+//#endregion
+//#region src/commands/status.d.ts
+interface StatusCommandOptions {
+  readonly droplet?: string;
+  readonly json?: boolean;
+}
+declare const statusCommand: Command;
+//#endregion
+//#region src/commands/validate.d.ts
+interface ValidateWidgetOptions {
+  readonly json?: boolean;
+}
+declare const validateCommand: Command;
+//#endregion
+//#region src/utils/config.d.ts
+declare const WIDGET_CONFIG_FILE = "fluid.widget.config.ts";
+interface FluidWidgetConfig {
+  readonly droplet?: string;
+}
+interface LoadedWidgetConfig {
+  readonly path: string;
+  readonly config: Partial<FluidWidgetConfig>;
+}
+declare function resolveWidgetConfigPath(projectDir: string): string;
+declare function loadWidgetConfig(projectDir: string): Promise<LoadedWidgetConfig>;
+declare function writeWidgetConfig(projectDir: string, config: FluidWidgetConfig): Promise<void>;
+declare function formatWidgetConfig(config: FluidWidgetConfig): string;
+declare function parseWidgetConfigSource(source: string): Partial<FluidWidgetConfig>;
+declare function mergeWidgetConfig(current: Partial<FluidWidgetConfig>, updates: Partial<FluidWidgetConfig>): FluidWidgetConfig;
+declare function validateDropletUuid(dropletUuid: string): string | undefined;
+//#endregion
+//#region src/utils/source-package.d.ts
+declare const DEFAULT_WIDGET_OUT_DIR = ".fluid/widget-dist";
+declare const ROOT_WIDGET_CONFIG_FILE: string;
+interface WidgetValidationResult {
+  readonly projectDir: string;
+  readonly sourceConfigPath?: string;
+  readonly validated: ValidatedWidgetPackageBuild;
+}
+declare class WidgetValidationError extends Error {
+  readonly errors: readonly WidgetPackageValidationError[];
+  constructor(errors: readonly WidgetPackageValidationError[]);
+}
+declare function validateDropletWidgetProject(projectDir: string, packageKeyOverride?: string): Promise<WidgetValidationResult>;
+declare function withRootWidgetConfigBridge<T>(projectDir: string, callback: () => Promise<T>, packageKeyOverride?: string): Promise<T>;
+declare function resolveWidgetSourceConfig(projectDir: string): {
+  readonly path: string;
+  readonly relativePath: string;
+} | undefined;
+declare function formatValidationSuccess(result: WidgetValidationResult): string;
+//#endregion
+//#region src/utils/validation.d.ts
+interface WidgetCliValidationError {
+  readonly path?: string;
+  readonly message: string;
+}
+declare function formatValidationErrors(errors: readonly WidgetCliValidationError[]): string;
+//#endregion
+//#region src/index.d.ts
+declare const widgetCommand: Command;
+declare const plugin: FluidPlugin;
+//#endregion
+export { type BuildWidgetOptions, type BuildWidgetPackageOptions, type BuildWidgetPackageResult, DEFAULT_WIDGET_DEV_PORT, DEFAULT_WIDGET_OUT_DIR, type FluidWidgetConfig, type LoadedWidgetConfig, type LogsCommandOptions, type PublishCommandOptions, type PublishWidgetPackageDependencies, type PublishWidgetPackageOptions, type PublishWidgetPackageResult, ROOT_WIDGET_CONFIG_FILE, type StatusCommandOptions, type ValidateWidgetOptions, WIDGET_CONFIG_FILE, WIDGET_DEV_ROUTES, type WidgetCliValidationError, type WidgetCommandOptions, type WidgetCreateOptions, type WidgetDevOptions, type WidgetDevProjectSummary, type WidgetLinkOptions, type WidgetTemplateVariables, WidgetValidationError, type WidgetValidationResult, buildCommand, buildViteDevArgs, buildWidgetPackage, createCommand, createWidgetProject, plugin as default, devCommand, formatValidationErrors, formatValidationSuccess, formatWidgetConfig, linkCommand, loadWidgetConfig, logsCommand, mergeWidgetConfig, parseWidgetConfigSource, printWidgetDevSummary, publishCommand, publishWidgetPackage, resolveWidgetConfigPath, resolveWidgetDevProject, resolveWidgetSourceConfig, runViteDevServer, statusCommand, validateCommand, validateDropletUuid, validateDropletWidgetProject, widgetCommand, withRootWidgetConfigBridge, writeWidgetConfig };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/commands/build.ts","../src/commands/create.ts","../src/commands/dev.ts","../src/commands/link.ts","../src/commands/logs.ts","../src/commands/publish.ts","../src/commands/status.ts","../src/commands/validate.ts","../src/utils/config.ts","../src/utils/source-package.ts","../src/utils/validation.ts","../src/index.ts"],"mappings":";;;;;UAAiB,uBAAA;EAAA,SACN,WAAA;EAAA,SACA,WAAA;EAAA,SACA,oBAAA;EAAA,SACA,UAAA;EAAA,SACA,WAAA;EAAA,SACA,eAAA;EAAA,SACA,gBAAA;EAAA,SACA,OAAA;AAAA;AAAA,UAGM,mBAAA;EAAA,SACN,WAAA;EAAA,SACA,SAAA;EAAA,SACA,KAAA;EAAA,SACA,KAAA;EAAA,SACA,OAAA;;WAEA,cAAA;AAAA;AAAA,UAGM,iBAAA;EAAA,SACN,OAAA;AAAA;AAAA,UAGM,oBAAA;EAAA,SACN,GAAA;AAAA;;;UCXM,kBAAA;EAAA,SACN,MAAA;EAAA,SACA,aAAA;AAAA;AAAA,UAGM,yBAAA;EAAA,SACN,UAAA;EAAA,SACA,MAAA;EAAA,SACA,aAAA;AAAA;AAAA,UAGM,wBAAA;EAAA,SACN,MAAA;EAAA,SACA,SAAA;EAAA,SACA,OAAA;AAAA;AAAA,iBAGW,kBAAA,CACpB,OAAA,EAAS,yBAAA,GACR,OAAA,CAAQ,wBAAA;AAAA,cAoCE,YAAA,EAAc,OAAA;;;cC1Cd,aAAA,EAAe,OAAA;AAAA,iBAsCN,mBAAA,CACpB,WAAA,UACA,OAAA,EAAS,mBAAA,GACR,OAAA;;;cC7DU,uBAAA;AAAA,cAEA,iBAAA;AAAA,UAQI,gBAAA;EAAA,SACN,IAAA;EAAA,SACA,IAAA;EAAA,SACA,IAAA;AAAA;AAAA,UAGM,uBAAA;EAAA,SACN,UAAA;EAAA,SACA,WAAA;EAAA,SACA,cAAA;EAAA,SACA,QAAA;EAAA,SACA,MAAA;EAAA,SACA,IAAA;EAAA,SACA,MAAA;AAAA;AAAA,cAGE,UAAA,EAAY,OAAA;AAAA,iBAmBH,uBAAA,CACpB,UAAA,UACA,OAAA,GAAS,gBAAA,GACR,OAAA,CAAQ,uBAAA;AAAA,iBAkCK,gBAAA,CAAiB,OAAA,GAAS,gBAAA;AAAA,iBAa1B,qBAAA,CAAsB,OAAA,EAAS,uBAAA;AAAA,iBAazB,gBAAA,CACpB,UAAA,UACA,OAAA,GAAS,gBAAA,GACR,OAAA;;;cCxGU,WAAA,EAAa,OAAA;;;UCRT,kBAAA;EAAA,SACN,OAAA;EAAA,SACA,KAAA;EAAA,SACA,IAAA;AAAA;AAAA,cAGE,WAAA,EAAa,OAAA;;;UCMT,2BAAA;EAAA,SACN,UAAA;EAAA,SACA,MAAA;EAAA,SACA,OAAA;EAAA,SACA,MAAA;EAAA,SACA,aAAA;EAAA,SACA,MAAA;AAAA;AAAA,UAGM,0BAAA;EAAA,SACN,MAAA;EAAA,SACA,QAAA;EAAA,SACA,MAAA;EAAA,SACA,OAAA;AAAA;AAAA,UAGM,gCAAA;EAAA,SACN,kBAAA,GAAqB,OAAA;IAAA,SACnB,UAAA;IAAA,SACA,MAAA;EAAA,MACL,OAAA;EAAA,SACG,mBAAA,GAAsB,OAAA;IAAA,SACpB,MAAA;IAAA,SACA,OAAA;IAAA,SACA,MAAA;EAAA,MACL,OAAA;AAAA;AAAA,iBAGc,oBAAA,CACpB,OAAA,EAAS,2BAAA,EACT,YAAA,GAAe,gCAAA,GACd,OAAA,CAAQ,0BAAA;AAAA,UAwDM,qBAAA;EAAA,SACN,MAAA;EAAA,SACA,OAAA;EAAA,SACA,MAAA;EAAA,SACA,aAAA;AAAA;AAAA,cAGE,cAAA,EAAgB,OAAA;;;UCvGZ,oBAAA;EAAA,SACN,OAAA;EAAA,SACA,IAAA;AAAA;AAAA,cAGE,aAAA,EAAe,OAAA;;;UCPX,qBAAA;EAAA,SACN,IAAA;AAAA;AAAA,cAGE,eAAA,EAAiB,OAAA;;;cCTjB,kBAAA;AAAA,UAEI,iBAAA;EAAA,SACN,OAAA;AAAA;AAAA,UAGM,kBAAA;EAAA,SACN,IAAA;EAAA,SACA,MAAA,EAAQ,OAAA,CAAQ,iBAAA;AAAA;AAAA,iBAUX,uBAAA,CAAwB,UAAA;AAAA,iBAIlB,gBAAA,CACpB,UAAA,WACC,OAAA,CAAQ,kBAAA;AAAA,iBAiBW,iBAAA,CACpB,UAAA,UACA,MAAA,EAAQ,iBAAA,GACP,OAAA;AAAA,iBAQa,kBAAA,CAAmB,MAAA,EAAQ,iBAAA;AAAA,iBAwB3B,uBAAA,CACd,MAAA,WACC,OAAA,CAAQ,iBAAA;AAAA,iBAOK,iBAAA,CACd,OAAA,EAAS,OAAA,CAAQ,iBAAA,GACjB,OAAA,EAAS,OAAA,CAAQ,iBAAA,IAChB,iBAAA;AAAA,iBAQa,mBAAA,CAAoB,WAAA;;;cCjFvB,sBAAA;AAAA,cACA,uBAAA;AAAA,UAQI,sBAAA;EAAA,SACN,UAAA;EAAA,SACA,gBAAA;EAAA,SACA,SAAA,EAAW,2BAAA;AAAA;AAAA,cAGT,qBAAA,SAA8B,KAAA;EAAA,SACzB,MAAA,WAAiB,4BAAA;EAEjC,WAAA,CAAY,MAAA,WAAiB,4BAAA;AAAA;AAAA,iBAOT,4BAAA,CACpB,UAAA,UACA,kBAAA,YACC,OAAA,CAAQ,sBAAA;AAAA,iBA+DW,0BAAA,GAAA,CACpB,UAAA,UACA,QAAA,QAAgB,OAAA,CAAQ,CAAA,GACxB,kBAAA,YACC,OAAA,CAAQ,CAAA;AAAA,iBA+DK,yBAAA,CACd,UAAA;EAAA,SACY,IAAA;EAAA,SAAuB,YAAA;AAAA;AAAA,iBASrB,uBAAA,CACd,MAAA,EAAQ,sBAAA;;;UC5LO,wBAAA;EAAA,SACN,IAAA;EAAA,SACA,OAAA;AAAA;AAAA,iBAGK,sBAAA,CACd,MAAA,WAAiB,wBAAA;;;cCKN,aAAA,EAAe,OAAA;AAAA,cAatB,MAAA,EAAQ,WAAA"}