@sanity/workbench-cli 1.1.3 → 1.3.0

package/dist/actions/deploy/checkBuiltOutput.js

@@ -0,0 +1,25 @@
+import { stat } from 'node:fs/promises';
+import { join } from 'node:path';
+/**
+ * Throws unless `sourceDir` is a directory holding a federation build.
+ * Workbench builds emit a module-federation remote instead of a static SPA,
+ * so the usual `index.html` contract doesn't apply — `mf-manifest.json` is the
+ * marker that `sanity build` produced a federation build.
+ */ export async function checkBuiltOutput(sourceDir) {
+    try {
+        const stats = await stat(sourceDir);
+        if (!stats.isDirectory()) {
+            throw new Error(`"${sourceDir}" is not a directory`);
+        }
+    } catch (err) {
+        throw err.code === 'ENOENT' ? new Error(`Directory "${sourceDir}" does not exist`) : err;
+    }
+    const manifestPath = join(sourceDir, 'mf-manifest.json');
+    try {
+        await stat(manifestPath);
+    } catch (err) {
+        throw err.code === 'ENOENT' ? new Error(`"${manifestPath}" does not exist. ` + 'The deploy directory must contain a federation build created with "sanity build".') : err;
+    }
+}
+
+//# sourceMappingURL=checkBuiltOutput.js.map

package/dist/actions/deploy/checkBuiltOutput.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/deploy/checkBuiltOutput.ts"],"sourcesContent":["import {stat} from 'node:fs/promises'\nimport {join} from 'node:path'\n\n/**\n * Throws unless `sourceDir` is a directory holding a federation build.\n * Workbench builds emit a module-federation remote instead of a static SPA,\n * so the usual `index.html` contract doesn't apply — `mf-manifest.json` is the\n * marker that `sanity build` produced a federation build.\n */\nexport async function checkBuiltOutput(sourceDir: string): Promise<void> {\n  try {\n    const stats = await stat(sourceDir)\n    if (!stats.isDirectory()) {\n      throw new Error(`\"${sourceDir}\" is not a directory`)\n    }\n  } catch (err) {\n    throw err.code === 'ENOENT' ? new Error(`Directory \"${sourceDir}\" does not exist`) : err\n  }\n\n  const manifestPath = join(sourceDir, 'mf-manifest.json')\n  try {\n    await stat(manifestPath)\n  } catch (err) {\n    throw err.code === 'ENOENT'\n      ? new Error(\n          `\"${manifestPath}\" does not exist. ` +\n            'The deploy directory must contain a federation build created with \"sanity build\".',\n        )\n      : err\n  }\n}\n"],"names":["stat","join","checkBuiltOutput","sourceDir","stats","isDirectory","Error","err","code","manifestPath"],"mappings":"AAAA,SAAQA,IAAI,QAAO,mBAAkB;AACrC,SAAQC,IAAI,QAAO,YAAW;AAE9B;;;;;CAKC,GACD,OAAO,eAAeC,iBAAiBC,SAAiB;IACtD,IAAI;QACF,MAAMC,QAAQ,MAAMJ,KAAKG;QACzB,IAAI,CAACC,MAAMC,WAAW,IAAI;YACxB,MAAM,IAAIC,MAAM,CAAC,CAAC,EAAEH,UAAU,oBAAoB,CAAC;QACrD;IACF,EAAE,OAAOI,KAAK;QACZ,MAAMA,IAAIC,IAAI,KAAK,WAAW,IAAIF,MAAM,CAAC,WAAW,EAAEH,UAAU,gBAAgB,CAAC,IAAII;IACvF;IAEA,MAAME,eAAeR,KAAKE,WAAW;IACrC,IAAI;QACF,MAAMH,KAAKS;IACb,EAAE,OAAOF,KAAK;QACZ,MAAMA,IAAIC,IAAI,KAAK,WACf,IAAIF,MACF,CAAC,CAAC,EAAEG,aAAa,kBAAkB,CAAC,GAClC,uFAEJF;IACN;AACF"}

package/dist/actions/deploy/deployConfig.js

@@ -0,0 +1,90 @@
+import { basename, dirname } from 'node:path';
+import { PassThrough } from 'node:stream';
+import { styleText } from 'node:util';
+import { createGzip } from 'node:zlib';
+import { getGlobalCliClient, subdebug } from '@sanity/cli-core';
+import FormData from 'form-data';
+import { pack } from 'tar-fs';
+import { APP_WORKBENCH_API_VERSION } from './apiVersion.js';
+const debug = subdebug('deploy');
+/**
+ * The org's active installation for an app type, or `undefined` when none is
+ * installed. Read-only, so `--dry-run` can report deployability.
+ * @internal
+ */ export async function resolveInstallationId(options) {
+    switch(options.appType){
+        case 'media-library':
+            {
+                return resolveSingletonInstallationId(options.organizationId, 'media-library');
+            }
+        default:
+            {
+                throw new Error(`Cannot create config for unknown app type: ${options.appType}`);
+            }
+    }
+}
+/**
+ * A report heading and item list for a config; a media library's `fields` are
+ * one of potentially many shapes.
+ * @internal
+ */ export function summarizeConfig(config) {
+    switch(config.appType){
+        case 'media-library':
+            {
+                const items = config.fields.map((field)=>`  ${field.title} (${field.name})`).join('\n');
+                return `Media library fields:\n${items}`;
+            }
+        default:
+            {
+                throw new Error(`Cannot create config for unknown app type: ${config.appType}`);
+            }
+    }
+}
+/**
+ * Upload the built module-federation remote to the installation as its config
+ * snapshot. `installationId` is resolved by the caller so `--dry-run` never
+ * reaches this mutating step.
+ * @internal
+ */ export async function deployConfig(options) {
+    const { appType, installationId, output, sourceDir, version } = options;
+    const tarball = pack(dirname(sourceDir), {
+        entries: [
+            basename(sourceDir)
+        ]
+    }).pipe(createGzip());
+    const formData = new FormData();
+    formData.append('version', version);
+    formData.append('tarball', tarball, {
+        contentType: 'application/gzip',
+        filename: 'installation-config.tar.gz'
+    });
+    const client = await getGlobalCliClient({
+        apiVersion: APP_WORKBENCH_API_VERSION,
+        requireUser: true
+    });
+    await client.request({
+        body: formData.pipe(new PassThrough()),
+        headers: formData.getHeaders(),
+        method: 'POST',
+        uri: `/installations/${installationId}/configs`
+    });
+    debug('Deployed config for app type: %s', appType);
+    output.log(`\n🚀 ${styleText('bold', 'Success!')} Config deployed`);
+}
+/** The org's active singleton installation, matched on its slug. */ async function resolveSingletonInstallationId(organizationId, slug) {
+    const client = await getGlobalCliClient({
+        apiVersion: APP_WORKBENCH_API_VERSION,
+        requireUser: true
+    });
+    // `limit=none` returns every installation in one response, no pagination.
+    const { data } = await client.request({
+        query: {
+            limit: 'none',
+            organizationId
+        },
+        uri: '/installations'
+    });
+    return data.find((item)=>item.application?.slug === slug)?.id;
+}
+
+//# sourceMappingURL=deployConfig.js.map

package/dist/actions/deploy/deployConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/deploy/deployConfig.ts"],"sourcesContent":["import {basename, dirname} from 'node:path'\nimport {PassThrough} from 'node:stream'\nimport {styleText} from 'node:util'\nimport {createGzip} from 'node:zlib'\n\nimport {getGlobalCliClient, type Output, subdebug} from '@sanity/cli-core'\nimport FormData from 'form-data'\nimport {pack} from 'tar-fs'\n\nimport {APP_WORKBENCH_API_VERSION} from './apiVersion.js'\n\nconst debug = subdebug('deploy')\n\ninterface InstallationListItem {\n  id: string\n\n  application?: {slug?: string}\n}\n\n/**\n * The org's active installation for an app type, or `undefined` when none is\n * installed. Read-only, so `--dry-run` can report deployability.\n * @internal\n */\nexport async function resolveInstallationId(options: {\n  appType: string\n  organizationId: string\n}): Promise<string | undefined> {\n  switch (options.appType) {\n    case 'media-library': {\n      return resolveSingletonInstallationId(options.organizationId, 'media-library')\n    }\n    default: {\n      throw new Error(`Cannot create config for unknown app type: ${options.appType}`)\n    }\n  }\n}\n\n/**\n * A report heading and item list for a config; a media library's `fields` are\n * one of potentially many shapes.\n * @internal\n */\nexport function summarizeConfig(config: {\n  appType: string\n  fields: {name: string; title: string}[]\n}): string {\n  switch (config.appType) {\n    case 'media-library': {\n      const items = config.fields.map((field) => `  ${field.title} (${field.name})`).join('\\n')\n      return `Media library fields:\\n${items}`\n    }\n    default: {\n      throw new Error(`Cannot create config for unknown app type: ${config.appType}`)\n    }\n  }\n}\n\n/**\n * Upload the built module-federation remote to the installation as its config\n * snapshot. `installationId` is resolved by the caller so `--dry-run` never\n * reaches this mutating step.\n * @internal\n */\nexport async function deployConfig(options: {\n  appType: string\n  installationId: string\n  output: Output\n  sourceDir: string\n  version: string\n}): Promise<void> {\n  const {appType, installationId, output, sourceDir, version} = options\n  const tarball = pack(dirname(sourceDir), {entries: [basename(sourceDir)]}).pipe(createGzip())\n  const formData = new FormData()\n  formData.append('version', version)\n  formData.append('tarball', tarball, {\n    contentType: 'application/gzip',\n    filename: 'installation-config.tar.gz',\n  })\n\n  const client = await getGlobalCliClient({\n    apiVersion: APP_WORKBENCH_API_VERSION,\n    requireUser: true,\n  })\n  await client.request({\n    body: formData.pipe(new PassThrough()),\n    headers: formData.getHeaders(),\n    method: 'POST',\n    uri: `/installations/${installationId}/configs`,\n  })\n\n  debug('Deployed config for app type: %s', appType)\n  output.log(`\\n🚀 ${styleText('bold', 'Success!')} Config deployed`)\n}\n\n/** The org's active singleton installation, matched on its slug. */\nasync function resolveSingletonInstallationId(\n  organizationId: string,\n  slug: string,\n): Promise<string | undefined> {\n  const client = await getGlobalCliClient({\n    apiVersion: APP_WORKBENCH_API_VERSION,\n    requireUser: true,\n  })\n  // `limit=none` returns every installation in one response, no pagination.\n  const {data}: {data: InstallationListItem[]} = await client.request({\n    query: {limit: 'none', organizationId},\n    uri: '/installations',\n  })\n  return data.find((item) => item.application?.slug === slug)?.id\n}\n"],"names":["basename","dirname","PassThrough","styleText","createGzip","getGlobalCliClient","subdebug","FormData","pack","APP_WORKBENCH_API_VERSION","debug","resolveInstallationId","options","appType","resolveSingletonInstallationId","organizationId","Error","summarizeConfig","config","items","fields","map","field","title","name","join","deployConfig","installationId","output","sourceDir","version","tarball","entries","pipe","formData","append","contentType","filename","client","apiVersion","requireUser","request","body","headers","getHeaders","method","uri","log","slug","data","query","limit","find","item","application","id"],"mappings":"AAAA,SAAQA,QAAQ,EAAEC,OAAO,QAAO,YAAW;AAC3C,SAAQC,WAAW,QAAO,cAAa;AACvC,SAAQC,SAAS,QAAO,YAAW;AACnC,SAAQC,UAAU,QAAO,YAAW;AAEpC,SAAQC,kBAAkB,EAAeC,QAAQ,QAAO,mBAAkB;AAC1E,OAAOC,cAAc,YAAW;AAChC,SAAQC,IAAI,QAAO,SAAQ;AAE3B,SAAQC,yBAAyB,QAAO,kBAAiB;AAEzD,MAAMC,QAAQJ,SAAS;AAQvB;;;;CAIC,GACD,OAAO,eAAeK,sBAAsBC,OAG3C;IACC,OAAQA,QAAQC,OAAO;QACrB,KAAK;YAAiB;gBACpB,OAAOC,+BAA+BF,QAAQG,cAAc,EAAE;YAChE;QACA;YAAS;gBACP,MAAM,IAAIC,MAAM,CAAC,2CAA2C,EAAEJ,QAAQC,OAAO,EAAE;YACjF;IACF;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASI,gBAAgBC,MAG/B;IACC,OAAQA,OAAOL,OAAO;QACpB,KAAK;YAAiB;gBACpB,MAAMM,QAAQD,OAAOE,MAAM,CAACC,GAAG,CAAC,CAACC,QAAU,CAAC,EAAE,EAAEA,MAAMC,KAAK,CAAC,EAAE,EAAED,MAAME,IAAI,CAAC,CAAC,CAAC,EAAEC,IAAI,CAAC;gBACpF,OAAO,CAAC,uBAAuB,EAAEN,OAAO;YAC1C;QACA;YAAS;gBACP,MAAM,IAAIH,MAAM,CAAC,2CAA2C,EAAEE,OAAOL,OAAO,EAAE;YAChF;IACF;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAea,aAAad,OAMlC;IACC,MAAM,EAACC,OAAO,EAAEc,cAAc,EAAEC,MAAM,EAAEC,SAAS,EAAEC,OAAO,EAAC,GAAGlB;IAC9D,MAAMmB,UAAUvB,KAAKP,QAAQ4B,YAAY;QAACG,SAAS;YAAChC,SAAS6B;SAAW;IAAA,GAAGI,IAAI,CAAC7B;IAChF,MAAM8B,WAAW,IAAI3B;IACrB2B,SAASC,MAAM,CAAC,WAAWL;IAC3BI,SAASC,MAAM,CAAC,WAAWJ,SAAS;QAClCK,aAAa;QACbC,UAAU;IACZ;IAEA,MAAMC,SAAS,MAAMjC,mBAAmB;QACtCkC,YAAY9B;QACZ+B,aAAa;IACf;IACA,MAAMF,OAAOG,OAAO,CAAC;QACnBC,MAAMR,SAASD,IAAI,CAAC,IAAI/B;QACxByC,SAAST,SAASU,UAAU;QAC5BC,QAAQ;QACRC,KAAK,CAAC,eAAe,EAAEnB,eAAe,QAAQ,CAAC;IACjD;IAEAjB,MAAM,oCAAoCG;IAC1Ce,OAAOmB,GAAG,CAAC,CAAC,KAAK,EAAE5C,UAAU,QAAQ,YAAY,gBAAgB,CAAC;AACpE;AAEA,kEAAkE,GAClE,eAAeW,+BACbC,cAAsB,EACtBiC,IAAY;IAEZ,MAAMV,SAAS,MAAMjC,mBAAmB;QACtCkC,YAAY9B;QACZ+B,aAAa;IACf;IACA,0EAA0E;IAC1E,MAAM,EAACS,IAAI,EAAC,GAAmC,MAAMX,OAAOG,OAAO,CAAC;QAClES,OAAO;YAACC,OAAO;YAAQpC;QAAc;QACrC+B,KAAK;IACP;IACA,OAAOG,KAAKG,IAAI,CAAC,CAACC,OAASA,KAAKC,WAAW,EAAEN,SAASA,OAAOO;AAC/D"}

package/dist/actions/deploy/deployWorkbenchApp.js

@@ -0,0 +1,185 @@
+import { basename, dirname } from 'node:path';
+import { PassThrough } from 'node:stream';
+import { createGzip } from 'node:zlib';
+import { exitCodes, getGlobalCliClient } from '@sanity/cli-core';
+import { spinner } from '@sanity/cli-core/ux';
+import FormData from 'form-data';
+import { pack } from 'tar-fs';
+import { APP_WORKBENCH_API_VERSION } from './apiVersion.js';
+export async function getApplication(applicationId) {
+    const client = await getGlobalCliClient({
+        apiVersion: APP_WORKBENCH_API_VERSION,
+        requireUser: true
+    });
+    try {
+        return await client.request({
+            uri: `/applications/${applicationId}`
+        });
+    } catch (err) {
+        if (err?.statusCode === 404) return null;
+        throw err;
+    }
+}
+/** Create an application and its first deployment in one call. */ export async function createApplication(options) {
+    const { interfaces, isSingleton, organizationId, projectId, slug, tarball, title, type, version, workspaces } = options;
+    const formData = new FormData();
+    formData.append('type', type);
+    formData.append('title', title);
+    formData.append('organizationId', organizationId);
+    formData.append('slug', slug);
+    if (isSingleton !== undefined) formData.append('isSingleton', String(isSingleton));
+    // Studio config is set once, at create — it's immutable on redeploy.
+    if (projectId) appendJson(formData, 'config', {
+        studio: {
+            projectId
+        }
+    });
+    appendDeploymentParts(formData, {
+        interfaces,
+        tarball,
+        version,
+        workspaces
+    });
+    return request(`/applications`, formData);
+}
+/** Deploy a new active version to an existing application. */ export async function createDeployment(options) {
+    const { applicationId, interfaces, isAutoUpdating, tarball, version, workspaces } = options;
+    const formData = new FormData();
+    formData.append('isAutoUpdating', isAutoUpdating.toString());
+    appendDeploymentParts(formData, {
+        interfaces,
+        tarball,
+        version,
+        workspaces
+    });
+    return request(`/applications/${applicationId}/deployments`, formData);
+}
+function appendDeploymentParts(formData, { interfaces, tarball, version, workspaces }) {
+    formData.append('version', version);
+    appendJson(formData, 'interfaces', interfaces);
+    // Studio-only — the server rejects a workspaces part on non-studio types.
+    if (workspaces?.length) appendJson(formData, 'workspaces', workspaces);
+    formData.append('tarball', tarball, {
+        contentType: 'application/gzip',
+        filename: 'app.tar.gz'
+    });
+}
+/** Structured parts must arrive as JSON so the server parses them. */ function appendJson(formData, name, value) {
+    formData.append(name, JSON.stringify(value), {
+        contentType: 'application/json'
+    });
+}
+async function request(uri, formData) {
+    const client = await getGlobalCliClient({
+        apiVersion: APP_WORKBENCH_API_VERSION,
+        requireUser: true
+    });
+    return client.request({
+        body: formData.pipe(new PassThrough()),
+        headers: formData.getHeaders(),
+        method: 'POST',
+        uri
+    });
+}
+/**
+ * Deploy a workbench coreApp through Brett: redeploy when `appId` is set,
+ * otherwise create the application at `slug`. Returns the application id for the
+ * shell to report.
+ * @internal
+ */ export async function deployCoreApp(options) {
+    const { appId, interfaces, isAutoUpdating, isSingleton, organizationId, slug, sourceDir, title, version } = options;
+    const tarball = pack(dirname(sourceDir), {
+        entries: [
+            basename(sourceDir)
+        ]
+    }).pipe(createGzip());
+    const spin = spinner('Deploying...').start();
+    try {
+        if (appId) {
+            await createDeployment({
+                applicationId: appId,
+                interfaces,
+                isAutoUpdating,
+                tarball,
+                version
+            });
+            spin.succeed();
+            return {
+                applicationId: appId
+            };
+        }
+        const { id } = await createApplication({
+            interfaces,
+            isSingleton,
+            organizationId,
+            slug,
+            tarball,
+            title,
+            type: 'coreApp',
+            version
+        });
+        spin.succeed();
+        return {
+            applicationId: id
+        };
+    } catch (error) {
+        spin.clear();
+        throw error;
+    }
+}
+/**
+ * Deploy a workbench studio through Brett: redeploy when `appId` is set,
+ * otherwise create the studio at `studioHost`. Returns the application id for
+ * the shell to report; a missing `studioHost` on create is a usage error.
+ * @internal
+ */ export async function deployStudio(options) {
+    const { appId, interfaces, isAutoUpdating, organizationId, output, projectId, sourceDir, studioHost, title, version, workspaces } = options;
+    const tarball = pack(dirname(sourceDir), {
+        entries: [
+            basename(sourceDir)
+        ]
+    }).pipe(createGzip());
+    const spin = spinner('Deploying to sanity.studio').start();
+    try {
+        if (appId) {
+            await createDeployment({
+                applicationId: appId,
+                interfaces,
+                isAutoUpdating,
+                tarball,
+                version,
+                workspaces
+            });
+            spin.succeed();
+            return {
+                applicationId: appId
+            };
+        }
+        if (!studioHost) {
+            spin.fail();
+            return output.error('No studio hostname configured. Set `studioHost` in sanity.cli.ts to create a studio.', {
+                exit: exitCodes.USAGE_ERROR
+            });
+        }
+        const application = await createApplication({
+            interfaces,
+            organizationId,
+            projectId,
+            slug: studioHost,
+            tarball,
+            title,
+            type: 'studio',
+            version,
+            workspaces
+        });
+        spin.succeed();
+        return {
+            applicationId: application.id
+        };
+    } catch (error) {
+        spin.fail();
+        throw error;
+    }
+}
+
+//# sourceMappingURL=deployWorkbenchApp.js.map

package/dist/actions/deploy/deployWorkbenchApp.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/deploy/deployWorkbenchApp.ts"],"sourcesContent":["import {basename, dirname} from 'node:path'\nimport {PassThrough} from 'node:stream'\nimport {createGzip, type Gzip} from 'node:zlib'\n\nimport {exitCodes, getGlobalCliClient, type Output} from '@sanity/cli-core'\nimport {spinner} from '@sanity/cli-core/ux'\nimport FormData from 'form-data'\nimport {pack} from 'tar-fs'\n\nimport {APP_WORKBENCH_API_VERSION} from './apiVersion.js'\nimport {type BrettInterface} from './buildExposes.js'\n\nexport type ApplicationType = 'coreApp' | 'studio'\n\nexport interface Application {\n  id: string\n  organizationId: string\n  slug: string | null\n  title: string\n  type: ApplicationType\n}\n\n/** A studio workspace as Brett stores it. */\nexport interface BrettWorkspace {\n  dataset: string\n  projectId: string\n\n  basePath?: string\n  icon?: string\n  name?: string\n  subtitle?: string\n  title?: string\n}\n\nexport async function getApplication(applicationId: string): Promise<Application | null> {\n  const client = await getGlobalCliClient({\n    apiVersion: APP_WORKBENCH_API_VERSION,\n    requireUser: true,\n  })\n  try {\n    return await client.request({uri: `/applications/${applicationId}`})\n  } catch (err) {\n    if ((err as {statusCode?: number})?.statusCode === 404) return null\n    throw err\n  }\n}\n\n/** Create an application and its first deployment in one call. */\nexport async function createApplication(options: {\n  interfaces: readonly BrettInterface[]\n  isSingleton?: boolean\n  organizationId: string\n  projectId?: string\n  slug: string\n  tarball: Gzip\n  title: string\n  type: ApplicationType\n  version: string\n  workspaces?: readonly BrettWorkspace[]\n}): Promise<Application> {\n  const {\n    interfaces,\n    isSingleton,\n    organizationId,\n    projectId,\n    slug,\n    tarball,\n    title,\n    type,\n    version,\n    workspaces,\n  } = options\n  const formData = new FormData()\n  formData.append('type', type)\n  formData.append('title', title)\n  formData.append('organizationId', organizationId)\n  formData.append('slug', slug)\n  if (isSingleton !== undefined) formData.append('isSingleton', String(isSingleton))\n  // Studio config is set once, at create — it's immutable on redeploy.\n  if (projectId) appendJson(formData, 'config', {studio: {projectId}})\n  appendDeploymentParts(formData, {interfaces, tarball, version, workspaces})\n  return request(`/applications`, formData)\n}\n\n/** Deploy a new active version to an existing application. */\nexport async function createDeployment(options: {\n  applicationId: string\n  interfaces: readonly BrettInterface[]\n  isAutoUpdating: boolean\n  tarball: Gzip\n  version: string\n  workspaces?: readonly BrettWorkspace[]\n}): Promise<{id: string}> {\n  const {applicationId, interfaces, isAutoUpdating, tarball, version, workspaces} = options\n  const formData = new FormData()\n  formData.append('isAutoUpdating', isAutoUpdating.toString())\n  appendDeploymentParts(formData, {interfaces, tarball, version, workspaces})\n  return request(`/applications/${applicationId}/deployments`, formData)\n}\n\nfunction appendDeploymentParts(\n  formData: FormData,\n  {\n    interfaces,\n    tarball,\n    version,\n    workspaces,\n  }: {\n    interfaces: readonly BrettInterface[]\n    tarball: Gzip\n    version: string\n    workspaces?: readonly BrettWorkspace[]\n  },\n): void {\n  formData.append('version', version)\n  appendJson(formData, 'interfaces', interfaces)\n  // Studio-only — the server rejects a workspaces part on non-studio types.\n  if (workspaces?.length) appendJson(formData, 'workspaces', workspaces)\n  formData.append('tarball', tarball, {contentType: 'application/gzip', filename: 'app.tar.gz'})\n}\n\n/** Structured parts must arrive as JSON so the server parses them. */\nfunction appendJson(formData: FormData, name: string, value: unknown): void {\n  formData.append(name, JSON.stringify(value), {contentType: 'application/json'})\n}\n\nasync function request<T>(uri: string, formData: FormData): Promise<T> {\n  const client = await getGlobalCliClient({\n    apiVersion: APP_WORKBENCH_API_VERSION,\n    requireUser: true,\n  })\n  return client.request({\n    body: formData.pipe(new PassThrough()),\n    headers: formData.getHeaders(),\n    method: 'POST',\n    uri,\n  })\n}\n\n/**\n * Deploy a workbench coreApp through Brett: redeploy when `appId` is set,\n * otherwise create the application at `slug`. Returns the application id for the\n * shell to report.\n * @internal\n */\nexport async function deployCoreApp(options: {\n  appId: string | undefined\n  interfaces: readonly BrettInterface[]\n  isAutoUpdating: boolean\n  isSingleton?: boolean\n  organizationId: string\n  slug: string\n  sourceDir: string\n  title: string\n  version: string\n}): Promise<{applicationId: string}> {\n  const {\n    appId,\n    interfaces,\n    isAutoUpdating,\n    isSingleton,\n    organizationId,\n    slug,\n    sourceDir,\n    title,\n    version,\n  } = options\n  const tarball = pack(dirname(sourceDir), {entries: [basename(sourceDir)]}).pipe(createGzip())\n\n  const spin = spinner('Deploying...').start()\n  try {\n    if (appId) {\n      await createDeployment({applicationId: appId, interfaces, isAutoUpdating, tarball, version})\n      spin.succeed()\n      return {applicationId: appId}\n    }\n\n    const {id} = await createApplication({\n      interfaces,\n      isSingleton,\n      organizationId,\n      slug,\n      tarball,\n      title,\n      type: 'coreApp',\n      version,\n    })\n    spin.succeed()\n    return {applicationId: id}\n  } catch (error) {\n    spin.clear()\n    throw error\n  }\n}\n\n/**\n * Deploy a workbench studio through Brett: redeploy when `appId` is set,\n * otherwise create the studio at `studioHost`. Returns the application id for\n * the shell to report; a missing `studioHost` on create is a usage error.\n * @internal\n */\nexport async function deployStudio(options: {\n  appId: string | undefined\n  interfaces: readonly BrettInterface[]\n  isAutoUpdating: boolean\n  organizationId: string\n  output: Output\n  projectId: string | undefined\n  sourceDir: string\n  studioHost: string | undefined\n  title: string\n  version: string\n  workspaces: readonly BrettWorkspace[]\n}): Promise<{applicationId: string}> {\n  const {\n    appId,\n    interfaces,\n    isAutoUpdating,\n    organizationId,\n    output,\n    projectId,\n    sourceDir,\n    studioHost,\n    title,\n    version,\n    workspaces,\n  } = options\n  const tarball = pack(dirname(sourceDir), {entries: [basename(sourceDir)]}).pipe(createGzip())\n\n  const spin = spinner('Deploying to sanity.studio').start()\n  try {\n    if (appId) {\n      await createDeployment({\n        applicationId: appId,\n        interfaces,\n        isAutoUpdating,\n        tarball,\n        version,\n        workspaces,\n      })\n      spin.succeed()\n      return {applicationId: appId}\n    }\n\n    if (!studioHost) {\n      spin.fail()\n      return output.error(\n        'No studio hostname configured. Set `studioHost` in sanity.cli.ts to create a studio.',\n        {exit: exitCodes.USAGE_ERROR},\n      )\n    }\n\n    const application = await createApplication({\n      interfaces,\n      organizationId,\n      projectId,\n      slug: studioHost,\n      tarball,\n      title,\n      type: 'studio',\n      version,\n      workspaces,\n    })\n    spin.succeed()\n    return {applicationId: application.id}\n  } catch (error) {\n    spin.fail()\n    throw error\n  }\n}\n"],"names":["basename","dirname","PassThrough","createGzip","exitCodes","getGlobalCliClient","spinner","FormData","pack","APP_WORKBENCH_API_VERSION","getApplication","applicationId","client","apiVersion","requireUser","request","uri","err","statusCode","createApplication","options","interfaces","isSingleton","organizationId","projectId","slug","tarball","title","type","version","workspaces","formData","append","undefined","String","appendJson","studio","appendDeploymentParts","createDeployment","isAutoUpdating","toString","length","contentType","filename","name","value","JSON","stringify","body","pipe","headers","getHeaders","method","deployCoreApp","appId","sourceDir","entries","spin","start","succeed","id","error","clear","deployStudio","output","studioHost","fail","exit","USAGE_ERROR","application"],"mappings":"AAAA,SAAQA,QAAQ,EAAEC,OAAO,QAAO,YAAW;AAC3C,SAAQC,WAAW,QAAO,cAAa;AACvC,SAAQC,UAAU,QAAkB,YAAW;AAE/C,SAAQC,SAAS,EAAEC,kBAAkB,QAAoB,mBAAkB;AAC3E,SAAQC,OAAO,QAAO,sBAAqB;AAC3C,OAAOC,cAAc,YAAW;AAChC,SAAQC,IAAI,QAAO,SAAQ;AAE3B,SAAQC,yBAAyB,QAAO,kBAAiB;AAyBzD,OAAO,eAAeC,eAAeC,aAAqB;IACxD,MAAMC,SAAS,MAAMP,mBAAmB;QACtCQ,YAAYJ;QACZK,aAAa;IACf;IACA,IAAI;QACF,OAAO,MAAMF,OAAOG,OAAO,CAAC;YAACC,KAAK,CAAC,cAAc,EAAEL,eAAe;QAAA;IACpE,EAAE,OAAOM,KAAK;QACZ,IAAI,AAACA,KAA+BC,eAAe,KAAK,OAAO;QAC/D,MAAMD;IACR;AACF;AAEA,gEAAgE,GAChE,OAAO,eAAeE,kBAAkBC,OAWvC;IACC,MAAM,EACJC,UAAU,EACVC,WAAW,EACXC,cAAc,EACdC,SAAS,EACTC,IAAI,EACJC,OAAO,EACPC,KAAK,EACLC,IAAI,EACJC,OAAO,EACPC,UAAU,EACX,GAAGV;IACJ,MAAMW,WAAW,IAAIxB;IACrBwB,SAASC,MAAM,CAAC,QAAQJ;IACxBG,SAASC,MAAM,CAAC,SAASL;IACzBI,SAASC,MAAM,CAAC,kBAAkBT;IAClCQ,SAASC,MAAM,CAAC,QAAQP;IACxB,IAAIH,gBAAgBW,WAAWF,SAASC,MAAM,CAAC,eAAeE,OAAOZ;IACrE,qEAAqE;IACrE,IAAIE,WAAWW,WAAWJ,UAAU,UAAU;QAACK,QAAQ;YAACZ;QAAS;IAAC;IAClEa,sBAAsBN,UAAU;QAACV;QAAYK;QAASG;QAASC;IAAU;IACzE,OAAOf,QAAQ,CAAC,aAAa,CAAC,EAAEgB;AAClC;AAEA,4DAA4D,GAC5D,OAAO,eAAeO,iBAAiBlB,OAOtC;IACC,MAAM,EAACT,aAAa,EAAEU,UAAU,EAAEkB,cAAc,EAAEb,OAAO,EAAEG,OAAO,EAAEC,UAAU,EAAC,GAAGV;IAClF,MAAMW,WAAW,IAAIxB;IACrBwB,SAASC,MAAM,CAAC,kBAAkBO,eAAeC,QAAQ;IACzDH,sBAAsBN,UAAU;QAACV;QAAYK;QAASG;QAASC;IAAU;IACzE,OAAOf,QAAQ,CAAC,cAAc,EAAEJ,cAAc,YAAY,CAAC,EAAEoB;AAC/D;AAEA,SAASM,sBACPN,QAAkB,EAClB,EACEV,UAAU,EACVK,OAAO,EACPG,OAAO,EACPC,UAAU,EAMX;IAEDC,SAASC,MAAM,CAAC,WAAWH;IAC3BM,WAAWJ,UAAU,cAAcV;IACnC,0EAA0E;IAC1E,IAAIS,YAAYW,QAAQN,WAAWJ,UAAU,cAAcD;IAC3DC,SAASC,MAAM,CAAC,WAAWN,SAAS;QAACgB,aAAa;QAAoBC,UAAU;IAAY;AAC9F;AAEA,oEAAoE,GACpE,SAASR,WAAWJ,QAAkB,EAAEa,IAAY,EAAEC,KAAc;IAClEd,SAASC,MAAM,CAACY,MAAME,KAAKC,SAAS,CAACF,QAAQ;QAACH,aAAa;IAAkB;AAC/E;AAEA,eAAe3B,QAAWC,GAAW,EAAEe,QAAkB;IACvD,MAAMnB,SAAS,MAAMP,mBAAmB;QACtCQ,YAAYJ;QACZK,aAAa;IACf;IACA,OAAOF,OAAOG,OAAO,CAAC;QACpBiC,MAAMjB,SAASkB,IAAI,CAAC,IAAI/C;QACxBgD,SAASnB,SAASoB,UAAU;QAC5BC,QAAQ;QACRpC;IACF;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeqC,cAAcjC,OAUnC;IACC,MAAM,EACJkC,KAAK,EACLjC,UAAU,EACVkB,cAAc,EACdjB,WAAW,EACXC,cAAc,EACdE,IAAI,EACJ8B,SAAS,EACT5B,KAAK,EACLE,OAAO,EACR,GAAGT;IACJ,MAAMM,UAAUlB,KAAKP,QAAQsD,YAAY;QAACC,SAAS;YAACxD,SAASuD;SAAW;IAAA,GAAGN,IAAI,CAAC9C;IAEhF,MAAMsD,OAAOnD,QAAQ,gBAAgBoD,KAAK;IAC1C,IAAI;QACF,IAAIJ,OAAO;YACT,MAAMhB,iBAAiB;gBAAC3B,eAAe2C;gBAAOjC;gBAAYkB;gBAAgBb;gBAASG;YAAO;YAC1F4B,KAAKE,OAAO;YACZ,OAAO;gBAAChD,eAAe2C;YAAK;QAC9B;QAEA,MAAM,EAACM,EAAE,EAAC,GAAG,MAAMzC,kBAAkB;YACnCE;YACAC;YACAC;YACAE;YACAC;YACAC;YACAC,MAAM;YACNC;QACF;QACA4B,KAAKE,OAAO;QACZ,OAAO;YAAChD,eAAeiD;QAAE;IAC3B,EAAE,OAAOC,OAAO;QACdJ,KAAKK,KAAK;QACV,MAAMD;IACR;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeE,aAAa3C,OAYlC;IACC,MAAM,EACJkC,KAAK,EACLjC,UAAU,EACVkB,cAAc,EACdhB,cAAc,EACdyC,MAAM,EACNxC,SAAS,EACT+B,SAAS,EACTU,UAAU,EACVtC,KAAK,EACLE,OAAO,EACPC,UAAU,EACX,GAAGV;IACJ,MAAMM,UAAUlB,KAAKP,QAAQsD,YAAY;QAACC,SAAS;YAACxD,SAASuD;SAAW;IAAA,GAAGN,IAAI,CAAC9C;IAEhF,MAAMsD,OAAOnD,QAAQ,8BAA8BoD,KAAK;IACxD,IAAI;QACF,IAAIJ,OAAO;YACT,MAAMhB,iBAAiB;gBACrB3B,eAAe2C;gBACfjC;gBACAkB;gBACAb;gBACAG;gBACAC;YACF;YACA2B,KAAKE,OAAO;YACZ,OAAO;gBAAChD,eAAe2C;YAAK;QAC9B;QAEA,IAAI,CAACW,YAAY;YACfR,KAAKS,IAAI;YACT,OAAOF,OAAOH,KAAK,CACjB,wFACA;gBAACM,MAAM/D,UAAUgE,WAAW;YAAA;QAEhC;QAEA,MAAMC,cAAc,MAAMlD,kBAAkB;YAC1CE;YACAE;YACAC;YACAC,MAAMwC;YACNvC;YACAC;YACAC,MAAM;YACNC;YACAC;QACF;QACA2B,KAAKE,OAAO;QACZ,OAAO;YAAChD,eAAe0D,YAAYT,EAAE;QAAA;IACvC,EAAE,OAAOC,OAAO;QACdJ,KAAKS,IAAI;QACT,MAAML;IACR;AACF"}

package/dist/actions/deploy/getWorkbench.js

@@ -1,38 +1,27 @@
 // The deploy command's view of a workbench app: the resolved interfaces plus
-// the two deploy-time guards. `sanity deploy` calls `getWorkbench(config)` once
-// and either gets `null` (plain project — normal deploy) or an object it asks
-// to validate the app and its build output before shipping.
-//
-// Node-only (the build-output guard touches the filesystem).
-import { stat } from 'node:fs/promises';
-import { join } from 'node:path';
+// the deploy-time guards that need the app's declarations. `sanity deploy` calls
+// `getWorkbench(config)` once and either gets `null` (plain project — normal
+// deploy) or an object it asks to validate the app before shipping.
 import { resolveWorkbenchApp } from '../../resolveWorkbenchApp.js';
+import { buildViewDeploymentPayload } from './viewDeployment.js';
 export function getWorkbench(cliConfig) {
     const app = resolveWorkbenchApp(cliConfig);
     if (!app) return null;
-    const { entry, services, views } = app;
+    const { config, entry, isSingleton, services, views } = app;
     return {
         ...app,
+        deploySingletonConfig: !!isSingleton && !!config,
+        hasInterfaces: !!entry || views.length > 0 || services.length > 0,
         assertDeployable () {
-            if (!entry && views.length === 0 && services.length === 0) {
-                throw new Error('Nothing to deploy: `unstable_defineApp` declares no entry, views or services. ' + 'Add at least one to the app config.');
+            if (!entry && views.length === 0 && services.length === 0 && !config) {
+                throw new Error('Nothing to deploy: the app declares no entry, views, services or config. ' + 'Add at least one to the app config.');
             }
         },
-        async checkBuiltOutput (sourceDir) {
-            try {
-                const stats = await stat(sourceDir);
-                if (!stats.isDirectory()) {
-                    throw new Error(`"${sourceDir}" is not a directory`);
-                }
-            } catch (err) {
-                throw err.code === 'ENOENT' ? new Error(`Directory "${sourceDir}" does not exist`) : err;
-            }
-            const manifestPath = join(sourceDir, 'mf-manifest.json');
-            try {
-                await stat(manifestPath);
-            } catch (err) {
-                throw err.code === 'ENOENT' ? new Error(`"${manifestPath}" does not exist. ` + 'The deploy directory must contain a federation build created with "sanity build".') : err;
-            }
+        buildViewDeploymentPayload (applicationId) {
+            return buildViewDeploymentPayload({
+                applicationId,
+                views
+            });
         }
     };
 }

package/dist/actions/deploy/getWorkbench.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/actions/deploy/getWorkbench.ts"],"sourcesContent":["// The deploy command's view of a workbench app: the resolved interfaces plus\n// the two deploy-time guards. `sanity deploy` calls `getWorkbench(config)` once\n// and either gets `null` (plain project — normal deploy) or an object it asks\n// to validate the app and its build output before shipping.\n//\n// Node-only (the build-output guard touches the filesystem).\n\nimport {stat} from 'node:fs/promises'\nimport {join} from 'node:path'\n\nimport {type CliConfig} from '@sanity/cli-core'\n\nimport {type ResolvedWorkbenchApp, resolveWorkbenchApp} from '../../resolveWorkbenchApp.js'\n\ninterface DeployableWorkbenchApp extends ResolvedWorkbenchApp {\n  /**\n   * Throws when the app declares nothing the build can expose — no entry, view\n   * or service. A federated app with none would ship a remote with nothing to\n   * load, so deploy gates on this before any prompts or API calls.\n   */\n  assertDeployable(): void\n  /**\n   * Throws unless `sourceDir` is a directory holding a federation build.\n   * Workbench builds emit a module-federation remote instead of a static SPA,\n   * so the usual `index.html` contract doesn't apply — `mf-manifest.json` is the\n   * marker that `sanity build` produced a federation build.\n   */\n  checkBuiltOutput(sourceDir: string): Promise<void>\n}\n\nexport function getWorkbench(\n  cliConfig: CliConfig | null | undefined,\n): DeployableWorkbenchApp | null {\n  const app = resolveWorkbenchApp(cliConfig)\n  if (!app) return null\n\n  const {entry, services, views} = app\n\n  return {\n    ...app,\n\n    assertDeployable() {\n      if (!entry && views.length === 0 && services.length === 0) {\n        throw new Error(\n          'Nothing to deploy: `unstable_defineApp` declares no entry, views or services. ' +\n            'Add at least one to the app config.',\n        )\n      }\n    },\n\n    async checkBuiltOutput(sourceDir) {\n      try {\n        const stats = await stat(sourceDir)\n        if (!stats.isDirectory()) {\n          throw new Error(`\"${sourceDir}\" is not a directory`)\n        }\n      } catch (err) {\n        throw err.code === 'ENOENT' ? new Error(`Directory \"${sourceDir}\" does not exist`) : err\n      }\n\n      const manifestPath = join(sourceDir, 'mf-manifest.json')\n      try {\n        await stat(manifestPath)\n      } catch (err) {\n        throw err.code === 'ENOENT'\n          ? new Error(\n              `\"${manifestPath}\" does not exist. ` +\n                'The deploy directory must contain a federation build created with \"sanity build\".',\n            )\n          : err\n      }\n    },\n  }\n}\n"],"names":["stat","join","resolveWorkbenchApp","getWorkbench","cliConfig","app","entry","services","views","assertDeployable","length","Error","checkBuiltOutput","sourceDir","stats","isDirectory","err","code","manifestPath"],"mappings":"AAAA,6EAA6E;AAC7E,gFAAgF;AAChF,8EAA8E;AAC9E,4DAA4D;AAC5D,EAAE;AACF,6DAA6D;AAE7D,SAAQA,IAAI,QAAO,mBAAkB;AACrC,SAAQC,IAAI,QAAO,YAAW;AAI9B,SAAmCC,mBAAmB,QAAO,+BAA8B;AAkB3F,OAAO,SAASC,aACdC,SAAuC;IAEvC,MAAMC,MAAMH,oBAAoBE;IAChC,IAAI,CAACC,KAAK,OAAO;IAEjB,MAAM,EAACC,KAAK,EAAEC,QAAQ,EAAEC,KAAK,EAAC,GAAGH;IAEjC,OAAO;QACL,GAAGA,GAAG;QAENI;YACE,IAAI,CAACH,SAASE,MAAME,MAAM,KAAK,KAAKH,SAASG,MAAM,KAAK,GAAG;gBACzD,MAAM,IAAIC,MACR,mFACE;YAEN;QACF;QAEA,MAAMC,kBAAiBC,SAAS;YAC9B,IAAI;gBACF,MAAMC,QAAQ,MAAMd,KAAKa;gBACzB,IAAI,CAACC,MAAMC,WAAW,IAAI;oBACxB,MAAM,IAAIJ,MAAM,CAAC,CAAC,EAAEE,UAAU,oBAAoB,CAAC;gBACrD;YACF,EAAE,OAAOG,KAAK;gBACZ,MAAMA,IAAIC,IAAI,KAAK,WAAW,IAAIN,MAAM,CAAC,WAAW,EAAEE,UAAU,gBAAgB,CAAC,IAAIG;YACvF;YAEA,MAAME,eAAejB,KAAKY,WAAW;YACrC,IAAI;gBACF,MAAMb,KAAKkB;YACb,EAAE,OAAOF,KAAK;gBACZ,MAAMA,IAAIC,IAAI,KAAK,WACf,IAAIN,MACF,CAAC,CAAC,EAAEO,aAAa,kBAAkB,CAAC,GAClC,uFAEJF;YACN;QACF;IACF;AACF"}
+{"version":3,"sources":["../../../src/actions/deploy/getWorkbench.ts"],"sourcesContent":["// The deploy command's view of a workbench app: the resolved interfaces plus\n// the deploy-time guards that need the app's declarations. `sanity deploy` calls\n// `getWorkbench(config)` once and either gets `null` (plain project — normal\n// deploy) or an object it asks to validate the app before shipping.\n\nimport {type CliConfig} from '@sanity/cli-core'\n\nimport {type ResolvedWorkbenchApp, resolveWorkbenchApp} from '../../resolveWorkbenchApp.js'\nimport {buildViewDeploymentPayload, type ViewDeploymentPayload} from './viewDeployment.js'\n\ninterface DeployableWorkbenchApp extends ResolvedWorkbenchApp {\n  /**\n   * Throws when the app exposes nothing (no entry, view, service, or config) —\n   * the remote would have nothing to load. Gated before any prompt or API call.\n   */\n  assertDeployable(): void\n  /**\n   * Validates the app's declared views into the application-service payload.\n   * Throws when a view declaration is malformed.\n   */\n  buildViewDeploymentPayload(applicationId: string): ViewDeploymentPayload\n  /**\n   * A singleton (the Media Library) that carries an config — deploy\n   * persists the config to the org's installation. Independent of the interfaces,\n   * which register regardless; non-singletons never carry a config.\n   */\n  deploySingletonConfig: boolean\n  /** Declares something to host as an application — an entry, view, or service. */\n  hasInterfaces: boolean\n}\n\nexport function getWorkbench(\n  cliConfig: CliConfig | null | undefined,\n): DeployableWorkbenchApp | null {\n  const app = resolveWorkbenchApp(cliConfig)\n  if (!app) return null\n\n  const {config, entry, isSingleton, services, views} = app\n\n  return {\n    ...app,\n\n    deploySingletonConfig: !!isSingleton && !!config,\n    hasInterfaces: !!entry || views.length > 0 || services.length > 0,\n\n    assertDeployable() {\n      if (!entry && views.length === 0 && services.length === 0 && !config) {\n        throw new Error(\n          'Nothing to deploy: the app declares no entry, views, services or config. ' +\n            'Add at least one to the app config.',\n        )\n      }\n    },\n\n    buildViewDeploymentPayload(applicationId) {\n      return buildViewDeploymentPayload({applicationId, views})\n    },\n  }\n}\n"],"names":["resolveWorkbenchApp","buildViewDeploymentPayload","getWorkbench","cliConfig","app","config","entry","isSingleton","services","views","deploySingletonConfig","hasInterfaces","length","assertDeployable","Error","applicationId"],"mappings":"AAAA,6EAA6E;AAC7E,iFAAiF;AACjF,6EAA6E;AAC7E,oEAAoE;AAIpE,SAAmCA,mBAAmB,QAAO,+BAA8B;AAC3F,SAAQC,0BAA0B,QAAmC,sBAAqB;AAuB1F,OAAO,SAASC,aACdC,SAAuC;IAEvC,MAAMC,MAAMJ,oBAAoBG;IAChC,IAAI,CAACC,KAAK,OAAO;IAEjB,MAAM,EAACC,MAAM,EAAEC,KAAK,EAAEC,WAAW,EAAEC,QAAQ,EAAEC,KAAK,EAAC,GAAGL;IAEtD,OAAO;QACL,GAAGA,GAAG;QAENM,uBAAuB,CAAC,CAACH,eAAe,CAAC,CAACF;QAC1CM,eAAe,CAAC,CAACL,SAASG,MAAMG,MAAM,GAAG,KAAKJ,SAASI,MAAM,GAAG;QAEhEC;YACE,IAAI,CAACP,SAASG,MAAMG,MAAM,KAAK,KAAKJ,SAASI,MAAM,KAAK,KAAK,CAACP,QAAQ;gBACpE,MAAM,IAAIS,MACR,8EACE;YAEN;QACF;QAEAb,4BAA2Bc,aAAa;YACtC,OAAOd,2BAA2B;gBAACc;gBAAeN;YAAK;QACzD;IACF;AACF"}

package/dist/actions/deploy/viewDeployment.js

@@ -0,0 +1,32 @@
+import { z } from 'zod/mini';
+/**
+ * A view record as persisted to the application service: `type`, `name`, `src`,
+ * plus any view-type-specific attributes (passed through for storage).
+ */ const viewRecordSchema = z.looseObject({
+    name: z.string().check(z.regex(/^[a-zA-Z0-9_-]+$/, 'View `name` must match /^[a-zA-Z0-9_-]+$/')),
+    src: z.string(),
+    type: z.enum([
+        'panel'
+    ])
+});
+/**
+ * Payload registering an app's views with the application service on deploy.
+ *
+ * Phase 1 stub: the service that stores views does not exist yet, so the
+ * payload is validated and logged only — never sent. Builds the contract the
+ * application-service endpoint will accept.
+ */ const viewDeploymentPayloadSchema = z.object({
+    applicationId: z.string(),
+    views: z.array(viewRecordSchema)
+});
+/**
+ * Validates an app's declared views into the application-service payload.
+ * Throws (via Zod) when a view declaration is malformed.
+ */ export function buildViewDeploymentPayload(input) {
+    return viewDeploymentPayloadSchema.parse({
+        applicationId: input.applicationId,
+        views: input.views ?? []
+    });
+}
+
+//# sourceMappingURL=viewDeployment.js.map

package/dist/actions/deploy/viewDeployment.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/actions/deploy/viewDeployment.ts"],"sourcesContent":["import {z} from 'zod/mini'\n\n/**\n * A view record as persisted to the application service: `type`, `name`, `src`,\n * plus any view-type-specific attributes (passed through for storage).\n */\nconst viewRecordSchema = z.looseObject({\n  name: z.string().check(z.regex(/^[a-zA-Z0-9_-]+$/, 'View `name` must match /^[a-zA-Z0-9_-]+$/')),\n  src: z.string(),\n  type: z.enum(['panel']),\n})\n\n/**\n * Payload registering an app's views with the application service on deploy.\n *\n * Phase 1 stub: the service that stores views does not exist yet, so the\n * payload is validated and logged only — never sent. Builds the contract the\n * application-service endpoint will accept.\n */\nconst viewDeploymentPayloadSchema = z.object({\n  applicationId: z.string(),\n  views: z.array(viewRecordSchema),\n})\n\nexport type ViewDeploymentPayload = z.infer<typeof viewDeploymentPayloadSchema>\n\n/**\n * Validates an app's declared views into the application-service payload.\n * Throws (via Zod) when a view declaration is malformed.\n */\nexport function buildViewDeploymentPayload(input: {\n  applicationId: string\n  views?: ReadonlyArray<Record<string, unknown>>\n}): ViewDeploymentPayload {\n  return viewDeploymentPayloadSchema.parse({\n    applicationId: input.applicationId,\n    views: input.views ?? [],\n  })\n}\n"],"names":["z","viewRecordSchema","looseObject","name","string","check","regex","src","type","enum","viewDeploymentPayloadSchema","object","applicationId","views","array","buildViewDeploymentPayload","input","parse"],"mappings":"AAAA,SAAQA,CAAC,QAAO,WAAU;AAE1B;;;CAGC,GACD,MAAMC,mBAAmBD,EAAEE,WAAW,CAAC;IACrCC,MAAMH,EAAEI,MAAM,GAAGC,KAAK,CAACL,EAAEM,KAAK,CAAC,oBAAoB;IACnDC,KAAKP,EAAEI,MAAM;IACbI,MAAMR,EAAES,IAAI,CAAC;QAAC;KAAQ;AACxB;AAEA;;;;;;CAMC,GACD,MAAMC,8BAA8BV,EAAEW,MAAM,CAAC;IAC3CC,eAAeZ,EAAEI,MAAM;IACvBS,OAAOb,EAAEc,KAAK,CAACb;AACjB;AAIA;;;CAGC,GACD,OAAO,SAASc,2BAA2BC,KAG1C;IACC,OAAON,4BAA4BO,KAAK,CAAC;QACvCL,eAAeI,MAAMJ,aAAa;QAClCC,OAAOG,MAAMH,KAAK,IAAI,EAAE;IAC1B;AACF"}

package/dist/actions/dev/deriveInterfaces.js

@@ -1,10 +1,15 @@
-import { isWorkbenchApp } from '@sanity/cli-core';
+import { hash } from 'node:crypto';
+import { MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION, SERVICE_CONTRACT_VERSION, VIEW_CONTRACT_VERSION } from '../../contract.js';
+import { isWorkbenchApp, readConfig } from '../../defineApp.js';
 /**
- * Map an app's `unstable_defineApp` config to the interface records forwarded on
- * its registry entry: `views` → panels, `services` → workers, `entry` → the
+ * Map a workbench app's declarations to the interface records forwarded on its
+ * registry entry: `views` → panels, `services` → workers, `entry` → the
  * navigable `app` view (`entry_point` is the raw `src`, not a resolved URL).
  * `undefined` for a non-branded app; a studio that declares `entry` is rejected
- * (studio app views are not implemented yet).
+ * (studio app views are not implemented yet). The config is not an
+ * interface — see {@link deriveConfigs}. `version` is the contract version the
+ * interface's generated module exports, known before the module runs; the app
+ * view has no versioned contract, so it carries none.
  */ export function deriveInterfaces(app, options) {
     if (!isWorkbenchApp(app)) return undefined;
     if (!options.isApp && app.entry !== undefined) {
@@ -14,12 +19,14 @@ import { isWorkbenchApp } from '@sanity/cli-core';
         ...app.views?.map((view)=>({
                 entry_point: view.src,
                 interface_type: view.type,
-                name: view.name
+                name: view.name,
+                version: VIEW_CONTRACT_VERSION
             })) ?? [],
         ...app.services?.map((service)=>({
                 entry_point: service.src,
                 interface_type: service.type,
-                name: service.name
+                name: service.name,
+                version: SERVICE_CONTRACT_VERSION
             })) ?? [],
         ...app.entry === undefined ? [] : [
             {
@@ -30,5 +37,55 @@ import { isWorkbenchApp } from '@sanity/cli-core';
         ]
     ];
 }
+/**
+ * The named source files a config's generated module is built from, dispatched
+ * per app type — the projection the exposes-set id keys on, so the generic HMR
+ * tracker owns none of the per-type shape. Throws on an app type it can't
+ * handle, so a new config family has to register its shape here.
+ */ export function deriveConfigEntries(config) {
+    switch(config.appType){
+        case 'media-library':
+            {
+                return config.fields.map((field)=>({
+                        name: field.name,
+                        src: field.src
+                    }));
+            }
+        default:
+            {
+                throw new Error(`Cannot derive entries for unknown config appType: ${config.appType}`);
+            }
+    }
+}
+/**
+ * The fields' schema *values* can't serialize — the workbench loads them from
+ * the federation module. `src` stays on so the exposes-set id keys on it and a
+ * repoint rebuilds. `appType` routes the config to the singleton (no app id to
+ * key on). `id` is a content hash of the entry — it fills the
+ * installation-config id slot deployed apps get from the applications API,
+ * and the workbench keys change detection on it. `version` is the config
+ * contract version the generated module exports, known before the module runs.
+ */ export function deriveConfigs(app) {
+    if (!isWorkbenchApp(app)) return [];
+    const config = readConfig(app);
+    if (!config) return [];
+    const entry = {
+        appType: config.appType,
+        fields: config.fields.map((field)=>({
+                name: field.name,
+                public: field.public,
+                src: field.src,
+                title: field.title
+            })),
+        moduleName: app.name,
+        version: MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION
+    };
+    return [
+        {
+            ...entry,
+            id: hash('sha1', JSON.stringify(entry))
+        }
+    ];
+}
 
 //# sourceMappingURL=deriveInterfaces.js.map

package/dist/actions/dev/deriveInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/actions/dev/deriveInterfaces.ts"],"sourcesContent":["import {type CliConfig, isWorkbenchApp} from '@sanity/cli-core'\n\nimport {type DevServerManifest} from './registry.js'\n\n/** One forwarded interface record on the dev-server registry entry. */\nexport type DevServerInterface = NonNullable<DevServerManifest['interfaces']>[number]\n\n/**\n * Map an app's `unstable_defineApp` config to the interface records forwarded on\n * its registry entry: `views` → panels, `services` → workers, `entry` → the\n * navigable `app` view (`entry_point` is the raw `src`, not a resolved URL).\n * `undefined` for a non-branded app; a studio that declares `entry` is rejected\n * (studio app views are not implemented yet).\n */\nexport function deriveInterfaces(\n  app: CliConfig['app'],\n  options: {isApp: boolean},\n): DevServerInterface[] | undefined {\n  if (!isWorkbenchApp(app)) return undefined\n\n  if (!options.isApp && app.entry !== undefined) {\n    throw new Error('App views for studios are not implemented yet')\n  }\n\n  return [\n    ...(app.views?.map((view) => ({\n      entry_point: view.src,\n      interface_type: view.type,\n      name: view.name,\n    })) ?? []),\n    ...(app.services?.map((service) => ({\n      entry_point: service.src,\n      interface_type: service.type,\n      name: service.name,\n    })) ?? []),\n    ...(app.entry === undefined\n      ? []\n      : [{entry_point: app.entry, interface_type: 'app' as const, name: app.name}]),\n  ]\n}\n"],"names":["isWorkbenchApp","deriveInterfaces","app","options","undefined","isApp","entry","Error","views","map","view","entry_point","src","interface_type","type","name","services","service"],"mappings":"AAAA,SAAwBA,cAAc,QAAO,mBAAkB;AAO/D;;;;;;CAMC,GACD,OAAO,SAASC,iBACdC,GAAqB,EACrBC,OAAyB;IAEzB,IAAI,CAACH,eAAeE,MAAM,OAAOE;IAEjC,IAAI,CAACD,QAAQE,KAAK,IAAIH,IAAII,KAAK,KAAKF,WAAW;QAC7C,MAAM,IAAIG,MAAM;IAClB;IAEA,OAAO;WACDL,IAAIM,KAAK,EAAEC,IAAI,CAACC,OAAU,CAAA;gBAC5BC,aAAaD,KAAKE,GAAG;gBACrBC,gBAAgBH,KAAKI,IAAI;gBACzBC,MAAML,KAAKK,IAAI;YACjB,CAAA,MAAO,EAAE;WACLb,IAAIc,QAAQ,EAAEP,IAAI,CAACQ,UAAa,CAAA;gBAClCN,aAAaM,QAAQL,GAAG;gBACxBC,gBAAgBI,QAAQH,IAAI;gBAC5BC,MAAME,QAAQF,IAAI;YACpB,CAAA,MAAO,EAAE;WACLb,IAAII,KAAK,KAAKF,YACd,EAAE,GACF;YAAC;gBAACO,aAAaT,IAAII,KAAK;gBAAEO,gBAAgB;gBAAgBE,MAAMb,IAAIa,IAAI;YAAA;SAAE;KAC/E;AACH"}
+{"version":3,"sources":["../../../src/actions/dev/deriveInterfaces.ts"],"sourcesContent":["import {hash} from 'node:crypto'\n\nimport {type CliConfig} from '@sanity/cli-core'\n\nimport {\n  MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION,\n  SERVICE_CONTRACT_VERSION,\n  VIEW_CONTRACT_VERSION,\n} from '../../contract.js'\nimport {isWorkbenchApp, readConfig} from '../../defineApp.js'\nimport {type DevServerManifest} from './registry.js'\n\n/** One forwarded interface record on the dev-server registry entry. */\nexport type DevServerInterface = NonNullable<DevServerManifest['interfaces']>[number]\n\n/** One forwarded config on the dev-server registry entry. */\nexport type DevServerConfig = NonNullable<DevServerManifest['configs']>[number]\n\n/**\n * Map a workbench app's declarations to the interface records forwarded on its\n * registry entry: `views` → panels, `services` → workers, `entry` → the\n * navigable `app` view (`entry_point` is the raw `src`, not a resolved URL).\n * `undefined` for a non-branded app; a studio that declares `entry` is rejected\n * (studio app views are not implemented yet). The config is not an\n * interface — see {@link deriveConfigs}. `version` is the contract version the\n * interface's generated module exports, known before the module runs; the app\n * view has no versioned contract, so it carries none.\n */\nexport function deriveInterfaces(\n  app: CliConfig['app'],\n  options: {isApp: boolean},\n): DevServerInterface[] | undefined {\n  if (!isWorkbenchApp(app)) return undefined\n\n  if (!options.isApp && app.entry !== undefined) {\n    throw new Error('App views for studios are not implemented yet')\n  }\n\n  return [\n    ...(app.views?.map((view) => ({\n      entry_point: view.src,\n      interface_type: view.type,\n      name: view.name,\n      version: VIEW_CONTRACT_VERSION,\n    })) ?? []),\n    ...(app.services?.map((service) => ({\n      entry_point: service.src,\n      interface_type: service.type,\n      name: service.name,\n      version: SERVICE_CONTRACT_VERSION,\n    })) ?? []),\n    ...(app.entry === undefined\n      ? []\n      : [{entry_point: app.entry, interface_type: 'app' as const, name: app.name}]),\n  ]\n}\n\n/**\n * The named source files a config's generated module is built from, dispatched\n * per app type — the projection the exposes-set id keys on, so the generic HMR\n * tracker owns none of the per-type shape. Throws on an app type it can't\n * handle, so a new config family has to register its shape here.\n */\nexport function deriveConfigEntries(config: DevServerConfig): {name: string; src: string}[] {\n  switch (config.appType) {\n    case 'media-library': {\n      return config.fields.map((field) => ({name: field.name, src: field.src}))\n    }\n    default: {\n      throw new Error(`Cannot derive entries for unknown config appType: ${config.appType}`)\n    }\n  }\n}\n\n/**\n * The fields' schema *values* can't serialize — the workbench loads them from\n * the federation module. `src` stays on so the exposes-set id keys on it and a\n * repoint rebuilds. `appType` routes the config to the singleton (no app id to\n * key on). `id` is a content hash of the entry — it fills the\n * installation-config id slot deployed apps get from the applications API,\n * and the workbench keys change detection on it. `version` is the config\n * contract version the generated module exports, known before the module runs.\n */\nexport function deriveConfigs(app: CliConfig['app']): DevServerConfig[] {\n  if (!isWorkbenchApp(app)) return []\n  const config = readConfig(app)\n  if (!config) return []\n  const entry = {\n    appType: config.appType,\n    fields: config.fields.map((field) => ({\n      name: field.name,\n      public: field.public,\n      src: field.src,\n      title: field.title,\n    })),\n    moduleName: app.name,\n    version: MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION,\n  }\n  return [{...entry, id: hash('sha1', JSON.stringify(entry))}]\n}\n"],"names":["hash","MEDIA_LIBRARY_CONFIG_CONTRACT_VERSION","SERVICE_CONTRACT_VERSION","VIEW_CONTRACT_VERSION","isWorkbenchApp","readConfig","deriveInterfaces","app","options","undefined","isApp","entry","Error","views","map","view","entry_point","src","interface_type","type","name","version","services","service","deriveConfigEntries","config","appType","fields","field","deriveConfigs","public","title","moduleName","id","JSON","stringify"],"mappings":"AAAA,SAAQA,IAAI,QAAO,cAAa;AAIhC,SACEC,qCAAqC,EACrCC,wBAAwB,EACxBC,qBAAqB,QAChB,oBAAmB;AAC1B,SAAQC,cAAc,EAAEC,UAAU,QAAO,qBAAoB;AAS7D;;;;;;;;;CASC,GACD,OAAO,SAASC,iBACdC,GAAqB,EACrBC,OAAyB;IAEzB,IAAI,CAACJ,eAAeG,MAAM,OAAOE;IAEjC,IAAI,CAACD,QAAQE,KAAK,IAAIH,IAAII,KAAK,KAAKF,WAAW;QAC7C,MAAM,IAAIG,MAAM;IAClB;IAEA,OAAO;WACDL,IAAIM,KAAK,EAAEC,IAAI,CAACC,OAAU,CAAA;gBAC5BC,aAAaD,KAAKE,GAAG;gBACrBC,gBAAgBH,KAAKI,IAAI;gBACzBC,MAAML,KAAKK,IAAI;gBACfC,SAASlB;YACX,CAAA,MAAO,EAAE;WACLI,IAAIe,QAAQ,EAAER,IAAI,CAACS,UAAa,CAAA;gBAClCP,aAAaO,QAAQN,GAAG;gBACxBC,gBAAgBK,QAAQJ,IAAI;gBAC5BC,MAAMG,QAAQH,IAAI;gBAClBC,SAASnB;YACX,CAAA,MAAO,EAAE;WACLK,IAAII,KAAK,KAAKF,YACd,EAAE,GACF;YAAC;gBAACO,aAAaT,IAAII,KAAK;gBAAEO,gBAAgB;gBAAgBE,MAAMb,IAAIa,IAAI;YAAA;SAAE;KAC/E;AACH;AAEA;;;;;CAKC,GACD,OAAO,SAASI,oBAAoBC,MAAuB;IACzD,OAAQA,OAAOC,OAAO;QACpB,KAAK;YAAiB;gBACpB,OAAOD,OAAOE,MAAM,CAACb,GAAG,CAAC,CAACc,QAAW,CAAA;wBAACR,MAAMQ,MAAMR,IAAI;wBAAEH,KAAKW,MAAMX,GAAG;oBAAA,CAAA;YACxE;QACA;YAAS;gBACP,MAAM,IAAIL,MAAM,CAAC,kDAAkD,EAAEa,OAAOC,OAAO,EAAE;YACvF;IACF;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASG,cAActB,GAAqB;IACjD,IAAI,CAACH,eAAeG,MAAM,OAAO,EAAE;IACnC,MAAMkB,SAASpB,WAAWE;IAC1B,IAAI,CAACkB,QAAQ,OAAO,EAAE;IACtB,MAAMd,QAAQ;QACZe,SAASD,OAAOC,OAAO;QACvBC,QAAQF,OAAOE,MAAM,CAACb,GAAG,CAAC,CAACc,QAAW,CAAA;gBACpCR,MAAMQ,MAAMR,IAAI;gBAChBU,QAAQF,MAAME,MAAM;gBACpBb,KAAKW,MAAMX,GAAG;gBACdc,OAAOH,MAAMG,KAAK;YACpB,CAAA;QACAC,YAAYzB,IAAIa,IAAI;QACpBC,SAASpB;IACX;IACA,OAAO;QAAC;YAAC,GAAGU,KAAK;YAAEsB,IAAIjC,KAAK,QAAQkC,KAAKC,SAAS,CAACxB;QAAO;KAAE;AAC9D"}