@fluid-app/fluid-cli-mist 0.1.0 → 0.1.2

package/dist/index.d.mts

@@ -24,6 +24,16 @@ interface Droplet {
   name: string;
   uuid: string;
 }
+/**
+* Managed env keys the backend writes onto a Mist once a droplet is
+* attached (backfill + redeploy). The CLI VERIFIES these appear with
+* `managed_by: "mist"` — it never sets them (the API 422s on write).
+*
+* Source: settled backend contract (#19685 auto-provisions the droplet
+* env on integration-point create).
+*/
+declare const MANAGED_DROPLET_ENV_KEYS: readonly ["FLUID_DROPLET_UUID", "FLUID_DROPLET_SECRET", "FLUID_WEBHOOK_AUTH_TOKEN"];
+type ManagedDropletEnvKey = (typeof MANAGED_DROPLET_ENV_KEYS)[number];
 interface Mist {
   id: string;
   slug: string;
@@ -32,8 +42,14 @@ interface Mist {
   name: string | null;
   state: MistState;
   kind: MistKind;
-  hostable_type: HostableType | null;
-  hostable_id: number | null;
+  /**
+  * @deprecated Hostable is retired (#19684/#19687). Droplet attach now
+  * lives on integration points. These fields remain optional so reads of
+  * older serializer payloads don't break, but nothing writes them anymore.
+  */
+  hostable_type?: HostableType | null;
+  /** @deprecated see `hostable_type`. */
+  hostable_id?: number | null;
   vendor_name: string;
   public_url: string | null;
   /** ISO-8601 when state === "pending_destroy"; null otherwise. */
@@ -71,27 +87,158 @@ type MistShowResponse = {
 interface MistCreateRequest {
   mist: {
     name?: string;
-    kind?: MistKind; /** Must be paired with `hostable_id`; both null/absent = standalone. */
-    hostable_type?: HostableType;
-    hostable_id?: number;
+    kind?: MistKind;
   };
 }
 /**
-* `PATCH /api/v202604/mists/:id` body. Three operations on one endpoint:
-*
-* - **Rename** — pass `name` (and/or `kind`)
-* - **Attach / replace** — pass both `hostable_type` and `hostable_id`
-* - **Detach** — pass both as **explicit `null`**. `maybe(...)` on the Rails
-*   side means absent keys leave attachment alone; explicit nulls clear it.
+* `PATCH /api/v202604/mists/:id` body. Rename only — attach/detach moved
+* off the Mist record onto integration points (#19684/#19687), so hostable
+* fields no longer belong here.
 */
 interface MistUpdateRequest {
   mist: {
     name?: string;
     kind?: MistKind;
-    hostable_type?: HostableType | null;
-    hostable_id?: number | null;
   };
 }
+interface DropletCreateInput {
+  name: string;
+  /** The Mist's `public_url`. Optional so we can create before first deploy
+  *  finishes and PATCH the embed URL in once it's ready. */
+  embed_url?: string;
+  install_webhook_url?: string;
+  uninstall_webhook_url?: string;
+  requested_scopes?: string[];
+  settings?: Record<string, unknown>;
+}
+interface DropletUpdateInput {
+  embed_url?: string;
+  install_webhook_url?: string;
+  uninstall_webhook_url?: string;
+}
+interface DropletCreateRequest {
+  droplet: DropletCreateInput;
+}
+interface DropletUpdateRequest {
+  droplet: DropletUpdateInput;
+}
+interface DropletRecord {
+  /**
+  * Numeric id is NOT returned by `POST /api/droplets` and isn't exposed
+  * anywhere the CLI can read it — attach by `uuid` instead (see
+  * `IntegrationPointCreateInput.integratable_uuid`).
+  */
+  id?: number;
+  uuid: string;
+  name: string;
+  embed_url?: string | null;
+}
+interface DropletCreateResponse {
+  droplet: DropletRecord;
+  /** Returned exactly once on create. We do NOT forward it — the backend
+  *  reads it server-side during env backfill. */
+  webhook_secret?: string;
+  meta?: ApiMeta;
+  status?: number;
+}
+interface DropletShowResponse {
+  droplet: DropletRecord;
+  meta?: ApiMeta;
+  status?: number;
+}
+/** Hyphenated wire kinds the integration-points API speaks. */
+type IntegrationPointKind = "droplet" | "drop-zone" | "mobile-embed";
+interface IntegrationPoint {
+  /** The integration point's own id — a uuid string on the wire. */
+  id: string;
+  kind: IntegrationPointKind | string;
+  /** Numeric id of the attached resource (server-resolved; present in reads). */
+  integratable_id?: number;
+  /**
+  * Public uuid of the attached surface (drp_/dz_ for droplets/drop-zones;
+  * a synthetic uuid for mobile embeds). Echoed on every row since #19689 —
+  * the read path uses it for display + resolution.
+  */
+  integratable_uuid?: string | null;
+  integratable_type?: string | null;
+  mist_id?: string;
+}
+/**
+* Attach input. Name the surface by EXACTLY ONE identifier:
+* - droplet + drop-zone attach by `integratable_uuid` (their records carry a
+*   drp_/dz_ uuid and no readable numeric id).
+* - mobile-embed attaches by `integratable_id` (a mobile widget has a numeric
+*   id and no uuid — `integratable_uuid` 404s for it).
+* The API rejects neither/both with a 400. The link is immutable (no update
+* route, no `active`): toggling is destroy + create.
+*/
+interface IntegrationPointCreateInput {
+  kind: IntegrationPointKind;
+  integratable_uuid?: string;
+  integratable_id?: number;
+}
+interface IntegrationPointCreateRequest {
+  integration_point: IntegrationPointCreateInput;
+}
+interface IntegrationPointsListResponse {
+  integration_points: IntegrationPoint[];
+  meta: ApiMeta;
+  status: number;
+}
+interface IntegrationPointShowResponse {
+  integration_point: IntegrationPoint;
+  meta: ApiMeta;
+  status: number;
+}
+interface DropZoneCreateInput {
+  name: string;
+  embed_url?: string;
+  /** Slot placement: { page, zone, height }. Without it the zone won't render. */
+  settings?: {
+    page?: string;
+    zone?: string;
+    height?: number;
+  };
+}
+interface DropZoneCreateRequest {
+  drop_zone: DropZoneCreateInput;
+}
+interface DropZoneRecord {
+  uuid: string;
+  name: string;
+  embed_url?: string | null;
+  active?: boolean;
+  settings?: Record<string, unknown>;
+}
+interface DropZoneCreateResponse {
+  drop_zone: DropZoneRecord;
+  meta?: ApiMeta;
+  status?: number;
+}
+interface MobileWidgetCreateInput {
+  name: string;
+  embed_url: string;
+  /** REQUIRED by the API (422 without it). */
+  cover_image_url: string;
+  /** REQUIRED by the API (422 without it). */
+  height: number;
+  scrollable?: boolean;
+}
+interface MobileWidgetCreateRequest {
+  mobile_widget: MobileWidgetCreateInput;
+}
+interface MobileWidgetRecord {
+  id: number;
+  name: string;
+  embed_url?: string | null;
+  cover_image_url?: string | null;
+  height?: number;
+}
+interface MobileWidgetCreateResponse {
+  mobile_widget: MobileWidgetRecord;
+  meta?: ApiMeta;
+  status?: number;
+}
 interface EnvVar {
   key: string;
   value: string;
@@ -154,5 +301,5 @@ interface MistFile {
 //#region src/index.d.ts
 declare const plugin: FluidPlugin;
 //#endregion
-export { ApiCollection, ApiMeta, Deployment, DeploymentShowResponse, DeploymentState, DeploymentsListResponse, Droplet, EnvVar, EnvVarsListResponse, GitCredential, GitCredentialResponse, HostableType, LogEntry, LogsResponse, Mist, MistCreateRequest, MistFile, MistKind, MistListResponse, MistShowResponse, MistState, MistUpdateRequest, PaginationCursor, plugin as default };
+export { ApiCollection, ApiMeta, Deployment, DeploymentShowResponse, DeploymentState, DeploymentsListResponse, DropZoneCreateInput, DropZoneCreateRequest, DropZoneCreateResponse, DropZoneRecord, Droplet, DropletCreateInput, DropletCreateRequest, DropletCreateResponse, DropletRecord, DropletShowResponse, DropletUpdateInput, DropletUpdateRequest, EnvVar, EnvVarsListResponse, GitCredential, GitCredentialResponse, HostableType, IntegrationPoint, IntegrationPointCreateInput, IntegrationPointCreateRequest, IntegrationPointKind, IntegrationPointShowResponse, IntegrationPointsListResponse, LogEntry, LogsResponse, MANAGED_DROPLET_ENV_KEYS, ManagedDropletEnvKey, Mist, MistCreateRequest, MistFile, MistKind, MistListResponse, MistShowResponse, MistState, MistUpdateRequest, MobileWidgetCreateInput, MobileWidgetCreateRequest, MobileWidgetCreateResponse, MobileWidgetRecord, PaginationCursor, plugin as default };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;;;AASA;;;;;KAAY,QAAA;AAAA,KAEA,SAAA;;;;AAeZ;;;;KAAY,YAAA;AAAA,UAEK,OAAA;EACf,EAAA;EACA,IAAA;EACA,IAAA;AAAA;AAAA,UAGe,IAAA;EACf,EAAA;EACA,IAAA;EALA;AAGF;EAKE,IAAA;EACA,KAAA,EAAO,SAAA;EACP,IAAA,EAAM,QAAA;EACN,aAAA,EAAe,YAAA;EACf,WAAA;EACA,WAAA;EACA,UAAA;EAGS;EADT,oBAAA;EACA,OAAA,EAAS,OAAA;EACT,cAAA;EACA,UAAA;EACA,UAAA;AAAA;AAAA,UAGe,gBAAA;EACf,MAAA;EACA,KAAA;EACA,WAAA;EACA,WAAA;AAAA;AAAA,UAGe,OAAA;EACf,UAAA;EACA,SAAA;EACA,UAAA,GAAa,gBAAA;AAAA;AAAA,UAGE,aAAA;EACf,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,KAGU,gBAAA;EACV,KAAA,EAAO,IAAA;EACP,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,KAGU,gBAAA;EACV,IAAA,EAAM,IAAA;EACN,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,iBAAA;EACf,IAAA;IACE,IAAA;IACA,IAAA,GAAO,QAAA,EAvBI;IAyBX,aAAA,GAAgB,YAAA;IAChB,WAAA;EAAA;AAAA;;;;;;;;;UAYa,iBAAA;EACf,IAAA;IACE,IAAA;IACA,IAAA,GAAO,QAAA;IACP,aAAA,GAAgB,YAAA;IAChB,WAAA;EAAA;AAAA;AAAA,UAIa,MAAA;EACf,GAAA;EACA,KAAA;EACA,OAAA;EACA,UAAA;AAAA;AAAA,UAGe,mBAAA;EACf,QAAA,EAAU,MAAA;EACV,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,aAAA;EACf,UAAA;EACA,UAAA;AAAA;AAAA,UAGe,qBAAA;EACf,cAAA,EAAgB,aAAA;EAChB,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,KAGU,eAAA;AAAA,UAOK,UAAA;EACf,EAAA;EACA,KAAA,EAAO,eAAA;EACP,GAAA;EACA,UAAA;EACA,cAAA;EACA,UAAA;EACA,MAAA;AAAA;AAAA,UAGe,uBAAA;EACf,WAAA,EAAa,UAAA;EACb,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,sBAAA;EACf,UAAA,EAAY,UAAA;EACZ,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,QAAA;EACf,SAAA;EACA,KAAA;EACA,OAAA;EACA,MAAA;AAAA;AAAA,UAGe,YAAA;EACf,aAAA;EACA,IAAA,EAAM,QAAA;EACN,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;;UAIe,QAAA;EACf,IAAA;EACA,WAAA;EACA,UAAA;AAAA;;;cC5JI,MAAA,EAAQ,WAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;;;AASA;;;;;KAAY,QAAA;AAAA,KAEA,SAAA;;;;AAeZ;;;;KAAY,YAAA;AAAA,UAEK,OAAA;EACf,EAAA;EACA,IAAA;EACA,IAAA;AAAA;;;;;AAWF;;;;cAAa,wBAAA;AAAA,KAMD,oBAAA,WAA+B,wBAAA;AAAA,UAE1B,IAAA;EACf,EAAA;EACA,IAAA;EAJyC;AAE3C;EAKE,IAAA;EACA,KAAA,EAAO,SAAA;EACP,IAAA,EAAM,QAAA;;;;;;EAMN,aAAA,GAAgB,YAAA;;EAEhB,WAAA;EACA,WAAA;EACA,UAAA;;EAEA,oBAAA;EACA,OAAA,EAAS,OAAA;EACT,cAAA;EACA,UAAA;EACA,UAAA;AAAA;AAAA,UAGe,gBAAA;EACf,MAAA;EACA,KAAA;EACA,WAAA;EACA,WAAA;AAAA;AAAA,UAGe,OAAA;EACf,UAAA;EACA,SAAA;EACA,UAAA,GAAa,gBAAA;AAAA;AAAA,UAGE,aAAA;EACf,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,KAGU,gBAAA;EACV,KAAA,EAAO,IAAA;EACP,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,KAGU,gBAAA;EACV,IAAA,EAAM,IAAA;EACN,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,iBAAA;EACf,IAAA;IACE,IAAA;IACA,IAAA,GAAO,QAAA;EAAA;AAAA;;;;;;UASM,iBAAA;EACf,IAAA;IACE,IAAA;IACA,IAAA,GAAO,QAAA;EAAA;AAAA;AAAA,UAQM,kBAAA;EACf,IAAA;;;EAGA,SAAA;EACA,mBAAA;EACA,qBAAA;EACA,gBAAA;EACA,QAAA,GAAW,MAAA;AAAA;AAAA,UAGI,kBAAA;EACf,SAAA;EACA,mBAAA;EACA,qBAAA;AAAA;AAAA,UAGe,oBAAA;EACf,OAAA,EAAS,kBAAA;AAAA;AAAA,UAGM,oBAAA;EACf,OAAA,EAAS,kBAAA;AAAA;AAAA,UAGM,aAAA;;;;;AApCjB;EA0CE,EAAA;EACA,IAAA;EACA,IAAA;EACA,SAAA;AAAA;AAAA,UAGe,qBAAA;EACf,OAAA,EAAS,aAAA;;;EAGT,cAAA;EACA,IAAA,GAAO,OAAA;EACP,MAAA;AAAA;AAAA,UAGe,mBAAA;EACf,OAAA,EAAS,aAAA;EACT,IAAA,GAAO,OAAA;EACP,MAAA;AAAA;;KASU,oBAAA;AAAA,UAEK,gBAAA;EApDJ;EAsDX,EAAA;EACA,IAAA,EAAM,oBAAA;;EAEN,eAAA;;;;;;EAMA,iBAAA;EACA,iBAAA;EACA,OAAA;AAAA;;AApDF;;;;;AAIA;;;UA4DiB,2BAAA;EACf,IAAA,EAAM,oBAAA;EACN,iBAAA;EACA,eAAA;AAAA;AAAA,UAGe,6BAAA;EACf,iBAAA,EAAmB,2BAAA;AAAA;AAAA,UAGJ,6BAAA;EACf,kBAAA,EAAoB,gBAAA;EACpB,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,4BAAA;EACf,iBAAA,EAAmB,gBAAA;EACnB,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAOe,mBAAA;EACf,IAAA;EACA,SAAA;;EAEA,QAAA;IAAa,IAAA;IAAe,IAAA;IAAe,MAAA;EAAA;AAAA;AAAA,UAG5B,qBAAA;EACf,SAAA,EAAW,mBAAA;AAAA;AAAA,UAGI,cAAA;EACf,IAAA;EACA,IAAA;EACA,SAAA;EACA,MAAA;EACA,QAAA,GAAW,MAAA;AAAA;AAAA,UAGI,sBAAA;EACf,SAAA,EAAW,cAAA;EACX,IAAA,GAAO,OAAA;EACP,MAAA;AAAA;AAAA,UAOe,uBAAA;EACf,IAAA;EACA,SAAA;;EAEA,eAAA;EA3DF;EA6DE,MAAA;EACA,UAAA;AAAA;AAAA,UAGe,yBAAA;EACf,aAAA,EAAe,uBAAA;AAAA;AAAA,UAGA,kBAAA;EACf,EAAA;EACA,IAAA;EACA,SAAA;EACA,eAAA;EACA,MAAA;AAAA;AAAA,UAGe,0BAAA;EACf,aAAA,EAAe,kBAAA;EACf,IAAA,GAAO,OAAA;EACP,MAAA;AAAA;AAAA,UAGe,MAAA;EACf,GAAA;EACA,KAAA;EACA,OAAA;EACA,UAAA;AAAA;AAAA,UAGe,mBAAA;EACf,QAAA,EAAU,MAAA;EACV,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,aAAA;EACf,UAAA;EACA,UAAA;AAAA;AAAA,UAGe,qBAAA;EACf,cAAA,EAAgB,aAAA;EAChB,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,KAGU,eAAA;AAAA,UAOK,UAAA;EACf,EAAA;EACA,KAAA,EAAO,eAAA;EACP,GAAA;EACA,UAAA;EACA,cAAA;EACA,UAAA;EACA,MAAA;AAAA;AAAA,UAGe,uBAAA;EACf,WAAA,EAAa,UAAA;EACb,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,sBAAA;EACf,UAAA,EAAY,UAAA;EACZ,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;AAAA,UAGe,QAAA;EACf,SAAA;EACA,KAAA;EACA,OAAA;EACA,MAAA;AAAA;AAAA,UAGe,YAAA;EACf,aAAA;EACA,IAAA,EAAM,QAAA;EACN,IAAA,EAAM,OAAA;EACN,MAAA;AAAA;;UAIe,QAAA;EACf,IAAA;EACA,WAAA;EACA,UAAA;AAAA;;;cCpVI,MAAA,EAAQ,WAAA"}