@sanity/workbench 0.1.0-alpha.7 → 0.1.0-alpha.8

package/dist/core.d.ts

@@ -1,12 +1,8 @@
 import type { ApplicationResource } from "@sanity/message-protocol";
 import type { CanvasResource } from "@sanity/message-protocol";
-import type { CoreApplication } from "@sanity/message-protocol";
 import type { MediaResource } from "@sanity/message-protocol";
 import type { Resource } from "@sanity/message-protocol";
-import type { StudioApplication as StudioApplication_2 } from "@sanity/message-protocol";
 import type { StudioResource } from "@sanity/message-protocol";
-import type { UserApplication as UserApplication_2 } from "@sanity/message-protocol";
-import type { WorkspaceManifest } from "@sanity/message-protocol";
 import { z } from "zod";
 
 /**
@@ -44,6 +40,25 @@ export declare type AbstractApplicationType =
   | "media-library"
   | "workspace";
 
+/**
+ * @public
+ */
+export declare const ActiveDeployment: z.ZodObject<
+  {
+    id: z.ZodString;
+    version: z.ZodString;
+    isActiveDeployment: z.ZodBoolean;
+    userApplicationId: z.ZodString;
+    isAutoUpdating: z.ZodBoolean;
+    size: z.ZodNumber;
+    deployedAt: z.ZodString;
+    deployedBy: z.ZodString;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+  },
+  z.core.$strip
+>;
+
 declare type Application =
   | CoreAppApplication
   | StudioApplication
@@ -196,7 +211,7 @@ declare type Canvas = z.output<typeof Canvas_2>;
  * @public
  */
 export declare class CanvasApplication extends AbstractApplication<"canvas"> {
-  private readonly canvas;
+  readonly canvas: Canvas;
   constructor(canvas: Canvas);
   get id(): CanvasId;
   get href(): string;
@@ -222,6 +237,34 @@ declare const CanvasId_2: z.core.$ZodBranded<z.ZodString, "CanvasId", "out">;
  */
 declare type CanvasId = z.output<typeof CanvasId_2>;
 
+/**
+ * @public
+ */
+export declare const ClientManifest: z.ZodObject<
+  {
+    version: z.ZodNumber;
+    createdAt: z.ZodString;
+    studioVersion: z.ZodOptional<z.ZodString>;
+    workspaces: z.ZodArray<
+      z.ZodObject<
+        {
+          name: z.ZodString;
+          title: z.ZodString;
+          subtitle: z.ZodOptional<z.ZodString>;
+          basePath: z.ZodString;
+          projectId: z.core.$ZodBranded<z.ZodString, "ProjectId", "out">;
+          dataset: z.ZodOptional<z.ZodString>;
+          icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+          schema: z.ZodString;
+          tools: z.ZodOptional<z.ZodString>;
+        },
+        z.core.$strip
+      >
+    >;
+  },
+  z.core.$strip
+>;
+
 declare type CompatibilityStatus =
   (typeof StudioApplication.CompatibilityStatuses)[keyof typeof StudioApplication.CompatibilityStatuses];
 
@@ -241,20 +284,140 @@ export declare interface Config {
  * @internal
  */
 export declare class CoreAppApplication extends UserApplication<
-  CoreApplication,
+  CoreAppUserApplication,
   "coreApp",
   ApplicationResource
 > {
-  readonly activeDeployment: CoreApplication["activeDeployment"];
-  constructor(application: CoreApplication);
+  readonly activeDeployment: CoreAppUserApplication["activeDeployment"];
+  constructor(application: CoreAppUserApplication);
   get href(): string;
   get title(): string;
   get subtitle(): undefined;
   get updatedAt(): string;
-  get<TKey extends keyof CoreApplication>(attr: TKey): CoreApplication[TKey];
+  get<TKey extends keyof CoreAppUserApplication>(
+    attr: TKey,
+  ): CoreAppUserApplication[TKey];
   toProtocolResource(): ApplicationResource;
 }
 
+/**
+ * @public
+ */
+export declare type CoreAppUserApplication = z.output<
+  typeof CoreAppUserApplication_2
+>;
+
+/**
+ * Core application schema — validates and brands API
+ * responses from the `/user-applications?appType=coreApp`
+ * endpoint. Uses a discriminated union on `urlType`.
+ * @public
+ */
+declare const CoreAppUserApplication_2: z.ZodDiscriminatedUnion<
+  [
+    z.ZodObject<
+      {
+        id: z.core.$ZodBranded<z.ZodString, "UserApplicationId", "out">;
+        appHost: z.ZodString;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        dashboardStatus: z.ZodEnum<{
+          default: "default";
+          disabled: "disabled";
+        }>;
+        title: z.ZodString;
+        organizationId: z.core.$ZodBranded<
+          z.ZodString,
+          "OrganizationId",
+          "out"
+        >;
+        type: z.ZodLiteral<"coreApp">;
+        manifest: z.ZodOptional<
+          z.ZodNullable<
+            z.ZodObject<
+              {
+                version: z.ZodString;
+                icon: z.ZodOptional<z.ZodString>;
+                title: z.ZodOptional<z.ZodString>;
+              },
+              z.core.$strip
+            >
+          >
+        >;
+        urlType: z.ZodLiteral<"internal">;
+        activeDeployment: z.ZodObject<
+          {
+            id: z.ZodString;
+            version: z.ZodString;
+            isActiveDeployment: z.ZodBoolean;
+            userApplicationId: z.ZodString;
+            isAutoUpdating: z.ZodBoolean;
+            size: z.ZodNumber;
+            deployedAt: z.ZodString;
+            deployedBy: z.ZodString;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+            manifest: z.ZodOptional<
+              z.ZodNullable<
+                z.ZodObject<
+                  {
+                    version: z.ZodString;
+                    icon: z.ZodOptional<z.ZodString>;
+                    title: z.ZodOptional<z.ZodString>;
+                  },
+                  z.core.$strip
+                >
+              >
+            >;
+          },
+          z.core.$strip
+        >;
+      },
+      z.core.$strip
+    >,
+    z.ZodObject<
+      {
+        id: z.core.$ZodBranded<z.ZodString, "UserApplicationId", "out">;
+        appHost: z.ZodString;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        dashboardStatus: z.ZodEnum<{
+          default: "default";
+          disabled: "disabled";
+        }>;
+        title: z.ZodString;
+        organizationId: z.core.$ZodBranded<
+          z.ZodString,
+          "OrganizationId",
+          "out"
+        >;
+        type: z.ZodLiteral<"coreApp">;
+        manifest: z.ZodOptional<
+          z.ZodNullable<
+            z.ZodObject<
+              {
+                version: z.ZodString;
+                icon: z.ZodOptional<z.ZodString>;
+                title: z.ZodOptional<z.ZodString>;
+              },
+              z.core.$strip
+            >
+          >
+        >;
+        urlType: z.ZodLiteral<"external">;
+        activeDeployment: z.ZodNull;
+      },
+      z.core.$strip
+    >,
+  ],
+  "urlType"
+>;
+
+/**
+ * @public
+ */
+declare type CoreAppUserApplication = z.output<typeof CoreAppUserApplication_2>;
+
 /**
  * @public
  */
@@ -279,6 +442,7 @@ export declare class LocalApplication extends AbstractApplication<
   get id(): string;
   get title(): string;
   get href(): string;
+  get url(): URL;
   toProtocolResource(): never;
 }
 
@@ -308,6 +472,15 @@ export declare interface Logger {
   debug: (message: string, context?: LogContext) => void;
 }
 
+/**
+ * Shared workbench logger instance. Use this from both the workbench host
+ * and its remotes so lifecycle and diagnostic logs appear under a single
+ * namespace.
+ *
+ * @public
+ */
+export declare const logger: Logger;
+
 declare interface LoggerOptions {
   namespace?: LogNamespace;
   context?: LogContext;
@@ -367,7 +540,7 @@ declare type MediaLibrary = z.output<typeof MediaLibrary_2>;
  * @public
  */
 export declare class MediaLibraryApplication extends AbstractApplication<"media-library"> {
-  private readonly library;
+  readonly library: MediaLibrary;
   constructor(library: MediaLibrary);
   get id(): string;
   get href(): string;
@@ -509,6 +682,15 @@ declare type OrganizationMember = z.output<typeof OrganizationMember_2>;
  */
 export declare function parseCanvas(data: unknown): Canvas;
 
+/**
+ * Validates and parses a raw API response into a branded
+ * CoreAppUserApplicationData.
+ * @public
+ */
+export declare function parseCoreApplication(
+  data: unknown,
+): CoreAppUserApplication;
+
 /**
  * Validates and parses a raw API response into a branded
  * MediaLibrary.
@@ -550,6 +732,15 @@ export declare function parseProject<
   },
 ): Project<IncludeMembers, IncludeFeatures>;
 
+/**
+ * Validates and parses a raw API response into a branded
+ * StudioUserApplication.
+ * @public
+ */
+export declare function parseStudioUserApplication(
+  data: unknown,
+): StudioUserApplication;
+
 /**
  * Project schema — validates and brands API responses
  * from the `/projects/:id` endpoint.
@@ -675,7 +866,7 @@ export declare type ResolvedConfig = Omit<Config, "organizationId"> & {
  * @internal
  */
 export declare class StudioApplication extends UserApplication<
-  StudioApplication_2,
+  StudioUserApplication,
   "studio",
   never
 > {
@@ -685,6 +876,13 @@ export declare class StudioApplication extends UserApplication<
    */
   readonly workspaces: readonly StudioWorkspace[];
   readonly project: Project<false, false>;
+  /**
+   * The projects actually referenced by this studio — the application's own
+   * project plus any project used by a workspace. Preserved so the instance
+   * can be re-constructed (e.g. by dock wrappers) without having to thread
+   * the full organization project list through again.
+   */
+  readonly projects: Project<false, false>[];
   /**
    * @param application - The studio application to create a list of workspaces for
    * @param projects - The projects available in the organization. It's not enough to just pass
@@ -692,15 +890,15 @@ export declare class StudioApplication extends UserApplication<
    * The workspaces may have different projects completely.
    */
   constructor(
-    application: StudioApplication_2,
+    application: StudioUserApplication,
     projects: Project<false, false>[],
   );
   get href(): string;
   get title(): string;
   get subtitle(): string;
-  get<TKey extends keyof StudioApplication_2>(
+  get<TKey extends keyof StudioUserApplication>(
     attr: TKey,
-  ): StudioApplication_2[TKey];
+  ): StudioUserApplication[TKey];
   get hasManifest(): boolean;
   get hasSchema(): boolean;
   private resolveVersion;
@@ -800,6 +998,326 @@ declare type StudioIssues = Array<{
   version?: string;
 }>;
 
+/**
+ * Studio user application schema — validates and brands API
+ * responses from the `/user-applications?appType=studio`
+ * endpoint. Uses a discriminated union on `urlType`.
+ * @public
+ */
+export declare const StudioUserApplication: z.ZodDiscriminatedUnion<
+  [
+    z.ZodObject<
+      {
+        id: z.core.$ZodBranded<z.ZodString, "UserApplicationId", "out">;
+        appHost: z.ZodString;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        dashboardStatus: z.ZodEnum<{
+          default: "default";
+          disabled: "disabled";
+        }>;
+        title: z.ZodNullable<z.ZodString>;
+        projectId: z.core.$ZodBranded<z.ZodString, "ProjectId", "out">;
+        type: z.ZodLiteral<"studio">;
+        manifest: z.ZodNullable<
+          z.ZodObject<
+            {
+              version: z.ZodNumber;
+              createdAt: z.ZodString;
+              studioVersion: z.ZodOptional<z.ZodString>;
+              workspaces: z.ZodArray<
+                z.ZodObject<
+                  {
+                    name: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodOptional<z.ZodString>;
+                    basePath: z.ZodString;
+                    projectId: z.core.$ZodBranded<
+                      z.ZodString,
+                      "ProjectId",
+                      "out"
+                    >;
+                    dataset: z.ZodOptional<z.ZodString>;
+                    icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    schema: z.ZodString;
+                    tools: z.ZodOptional<z.ZodString>;
+                  },
+                  z.core.$strip
+                >
+              >;
+            },
+            z.core.$strip
+          >
+        >;
+        manifestData: z.ZodNullable<
+          z.ZodObject<
+            {
+              value: z.ZodObject<
+                {
+                  version: z.ZodNumber;
+                  createdAt: z.ZodString;
+                  studioVersion: z.ZodOptional<z.ZodString>;
+                  workspaces: z.ZodArray<
+                    z.ZodObject<
+                      {
+                        name: z.ZodString;
+                        title: z.ZodString;
+                        subtitle: z.ZodOptional<z.ZodString>;
+                        basePath: z.ZodString;
+                        projectId: z.core.$ZodBranded<
+                          z.ZodString,
+                          "ProjectId",
+                          "out"
+                        >;
+                        dataset: z.ZodOptional<z.ZodString>;
+                        icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        schema: z.ZodString;
+                        tools: z.ZodOptional<z.ZodString>;
+                      },
+                      z.core.$strip
+                    >
+                  >;
+                },
+                z.core.$strip
+              >;
+            },
+            z.core.$strip
+          >
+        >;
+        autoUpdatingVersion: z.ZodNullable<z.ZodString>;
+        config: z.ZodObject<
+          {
+            "live-manifest": z.ZodOptional<
+              z.ZodObject<
+                {
+                  createdAt: z.ZodString;
+                  updatedAt: z.ZodString;
+                  updatedBy: z.ZodString;
+                  value: z.ZodObject<
+                    {
+                      buildId: z.ZodOptional<z.ZodString>;
+                      bundleVersion: z.ZodOptional<z.ZodString>;
+                      version: z.ZodOptional<z.ZodString>;
+                      workspaces: z.ZodOptional<
+                        z.ZodArray<
+                          z.ZodObject<
+                            {
+                              name: z.ZodString;
+                              title: z.ZodString;
+                              subtitle: z.ZodOptional<z.ZodString>;
+                              basePath: z.ZodString;
+                              projectId: z.core.$ZodBranded<
+                                z.ZodString,
+                                "ProjectId",
+                                "out"
+                              >;
+                              icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                              dataset: z.ZodString;
+                              schemaDescriptorId: z.ZodString;
+                            },
+                            z.core.$strip
+                          >
+                        >
+                      >;
+                    },
+                    z.core.$strip
+                  >;
+                },
+                z.core.$strip
+              >
+            >;
+          },
+          z.core.$strip
+        >;
+        urlType: z.ZodLiteral<"internal">;
+        activeDeployment: z.ZodObject<
+          {
+            id: z.ZodString;
+            version: z.ZodString;
+            isActiveDeployment: z.ZodBoolean;
+            userApplicationId: z.ZodString;
+            isAutoUpdating: z.ZodBoolean;
+            size: z.ZodNumber;
+            deployedAt: z.ZodString;
+            deployedBy: z.ZodString;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+            manifest: z.ZodNullable<
+              z.ZodObject<
+                {
+                  buildId: z.ZodOptional<z.ZodString>;
+                  bundleVersion: z.ZodOptional<z.ZodString>;
+                  version: z.ZodOptional<z.ZodString>;
+                  workspaces: z.ZodOptional<
+                    z.ZodArray<
+                      z.ZodObject<
+                        {
+                          name: z.ZodString;
+                          title: z.ZodString;
+                          subtitle: z.ZodOptional<z.ZodString>;
+                          basePath: z.ZodString;
+                          projectId: z.core.$ZodBranded<
+                            z.ZodString,
+                            "ProjectId",
+                            "out"
+                          >;
+                          icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                          dataset: z.ZodString;
+                          schemaDescriptorId: z.ZodString;
+                        },
+                        z.core.$strip
+                      >
+                    >
+                  >;
+                },
+                z.core.$strip
+              >
+            >;
+          },
+          z.core.$strip
+        >;
+      },
+      z.core.$strip
+    >,
+    z.ZodObject<
+      {
+        id: z.core.$ZodBranded<z.ZodString, "UserApplicationId", "out">;
+        appHost: z.ZodString;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        dashboardStatus: z.ZodEnum<{
+          default: "default";
+          disabled: "disabled";
+        }>;
+        title: z.ZodNullable<z.ZodString>;
+        projectId: z.core.$ZodBranded<z.ZodString, "ProjectId", "out">;
+        type: z.ZodLiteral<"studio">;
+        manifest: z.ZodNullable<
+          z.ZodObject<
+            {
+              version: z.ZodNumber;
+              createdAt: z.ZodString;
+              studioVersion: z.ZodOptional<z.ZodString>;
+              workspaces: z.ZodArray<
+                z.ZodObject<
+                  {
+                    name: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodOptional<z.ZodString>;
+                    basePath: z.ZodString;
+                    projectId: z.core.$ZodBranded<
+                      z.ZodString,
+                      "ProjectId",
+                      "out"
+                    >;
+                    dataset: z.ZodOptional<z.ZodString>;
+                    icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    schema: z.ZodString;
+                    tools: z.ZodOptional<z.ZodString>;
+                  },
+                  z.core.$strip
+                >
+              >;
+            },
+            z.core.$strip
+          >
+        >;
+        manifestData: z.ZodNullable<
+          z.ZodObject<
+            {
+              value: z.ZodObject<
+                {
+                  version: z.ZodNumber;
+                  createdAt: z.ZodString;
+                  studioVersion: z.ZodOptional<z.ZodString>;
+                  workspaces: z.ZodArray<
+                    z.ZodObject<
+                      {
+                        name: z.ZodString;
+                        title: z.ZodString;
+                        subtitle: z.ZodOptional<z.ZodString>;
+                        basePath: z.ZodString;
+                        projectId: z.core.$ZodBranded<
+                          z.ZodString,
+                          "ProjectId",
+                          "out"
+                        >;
+                        dataset: z.ZodOptional<z.ZodString>;
+                        icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        schema: z.ZodString;
+                        tools: z.ZodOptional<z.ZodString>;
+                      },
+                      z.core.$strip
+                    >
+                  >;
+                },
+                z.core.$strip
+              >;
+            },
+            z.core.$strip
+          >
+        >;
+        autoUpdatingVersion: z.ZodNullable<z.ZodString>;
+        config: z.ZodObject<
+          {
+            "live-manifest": z.ZodOptional<
+              z.ZodObject<
+                {
+                  createdAt: z.ZodString;
+                  updatedAt: z.ZodString;
+                  updatedBy: z.ZodString;
+                  value: z.ZodObject<
+                    {
+                      buildId: z.ZodOptional<z.ZodString>;
+                      bundleVersion: z.ZodOptional<z.ZodString>;
+                      version: z.ZodOptional<z.ZodString>;
+                      workspaces: z.ZodOptional<
+                        z.ZodArray<
+                          z.ZodObject<
+                            {
+                              name: z.ZodString;
+                              title: z.ZodString;
+                              subtitle: z.ZodOptional<z.ZodString>;
+                              basePath: z.ZodString;
+                              projectId: z.core.$ZodBranded<
+                                z.ZodString,
+                                "ProjectId",
+                                "out"
+                              >;
+                              icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                              dataset: z.ZodString;
+                              schemaDescriptorId: z.ZodString;
+                            },
+                            z.core.$strip
+                          >
+                        >
+                      >;
+                    },
+                    z.core.$strip
+                  >;
+                },
+                z.core.$strip
+              >
+            >;
+          },
+          z.core.$strip
+        >;
+        urlType: z.ZodLiteral<"external">;
+        activeDeployment: z.ZodNull;
+      },
+      z.core.$strip
+    >,
+  ],
+  "urlType"
+>;
+
+/**
+ * @public
+ */
+export declare type StudioUserApplication = z.output<
+  typeof StudioUserApplication
+>;
+
 /**
  * @internal
  */
@@ -829,7 +1347,7 @@ export declare class StudioWorkspace extends AbstractApplication<
   get id(): string;
   get href(): string;
   get title(): string;
-  get subtitle(): string | null | undefined;
+  get subtitle(): string | undefined;
   get<TKey extends Exclude<keyof Workspace, "id" | "icon" | "title">>(
     attr: TKey,
   ): Workspace[TKey];
@@ -856,7 +1374,7 @@ export declare class StudioWorkspace extends AbstractApplication<
  * @internal
  */
 export declare abstract class UserApplication<
-  TUserApplication extends UserApplication_2,
+  TUserApplication extends UserApplicationBase,
   TType extends Extract<AbstractApplicationType, "coreApp" | "studio">,
   TProtocolResource extends Resource = Extract<
     Resource,
@@ -878,6 +1396,32 @@ export declare abstract class UserApplication<
   get url(): URL;
 }
 
+/**
+ * @public
+ */
+export declare const UserApplicationBase: z.ZodObject<
+  {
+    id: z.core.$ZodBranded<z.ZodString, "UserApplicationId", "out">;
+    appHost: z.ZodString;
+    urlType: z.ZodEnum<{
+      internal: "internal";
+      external: "external";
+    }>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    dashboardStatus: z.ZodEnum<{
+      default: "default";
+      disabled: "disabled";
+    }>;
+  },
+  z.core.$strip
+>;
+
+/**
+ * @public
+ */
+export declare type UserApplicationBase = z.output<typeof UserApplicationBase>;
+
 /**
  * User application ID schema, branded for type safety.
  * @public
@@ -894,13 +1438,27 @@ export declare const UserApplicationId: z.core.$ZodBranded<
  */
 export declare type UserApplicationId = z.output<typeof UserApplicationId>;
 
-declare type Workspace = Omit<
-  WorkspaceManifest,
-  "dataset" | "schema" | "projectId"
-> & {
-  projectId: ProjectId;
-  dataset?: string;
-  schema?: string;
-};
+/**
+ * @public
+ */
+export declare type Workspace = z.output<typeof Workspace_2>;
+
+declare const Workspace_2: z.ZodObject<
+  {
+    name: z.ZodString;
+    title: z.ZodString;
+    subtitle: z.ZodOptional<z.ZodString>;
+    basePath: z.ZodString;
+    projectId: z.core.$ZodBranded<z.ZodString, "ProjectId", "out">;
+    dataset: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  },
+  z.core.$strip
+>;
+
+/**
+ * @public
+ */
+declare type Workspace = z.output<typeof Workspace_2>;
 
 export {};