@sanity/sdk 3.4.0 → 3.5.0-next.20260922182803

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/sdk",
-  "version": "3.4.0",
+  "version": "3.5.0-next.20260922182803",
   "private": false,
   "description": "Sanity SDK",
   "keywords": [

package/src/_exports/dashboard.ts

@@ -26,6 +26,7 @@ export type {
   DocumentActivity,
   EventTopic,
   EventTopicDef,
+  LocalApplication,
   NavigationLocation,
   NavigationTarget,
   PayloadOf,

package/src/applications/applicationOrigin.ts

@@ -9,7 +9,9 @@ type SanityGlobal = typeof globalThis & {__SANITY_STAGING__?: boolean}
  *
  * @internal
  */
-export function getApplicationOrigin(application: ApplicationBase): string | null {
+export function getApplicationOrigin(
+  application: Pick<ApplicationBase, 'externalUrl' | 'slug' | 'isSingleton' | 'organizationId'>,
+): string | null {
   if (application.externalUrl !== null) return new URL(application.externalUrl).origin
   if (application.slug === null) return null
 

package/src/dashboard/messageBus/topics.test.ts

@@ -1,6 +1,7 @@
 import {describe, expect, expectTypeOf, it} from 'vitest'
 
 import {type Application, type ApplicationInclude} from '../../applications/applications'
+import {type Installation, type InstallationInclude} from '../../installations/installations'
 import {type MessageBus} from './bus'
 import {
   type ApplicationActivity,
@@ -12,6 +13,7 @@ import {
   DASHBOARD_TOPIC_MANIFEST,
   type DashboardTopics,
   type EventTopic,
+  type LocalApplication,
   type PayloadOf,
   type ReplyOf,
   type StateTopic,
@@ -25,8 +27,9 @@ type ListedApplication = Extract<
   NonNullable<ValueOf<'applications.list'>>,
   {ok: true}
 >['value'][number]
+// The list value mixes applications and installations; interface shape lives on applications.
 type ListedInterface = NonNullable<
-  NonNullable<ListedApplication['activeDeployment']>['interfaces']
+  NonNullable<Extract<ListedApplication, {type: unknown}>['activeDeployment']>['interfaces']
 >[number]
 
 describe('dashboard topic types', () => {
@@ -59,8 +62,12 @@ describe('dashboard topic types', () => {
     expectTypeOf<ValueOf<'applications.capabilities'>>().toEqualTypeOf<CapabilityRecord>()
     expectTypeOf<ValueOf<'applications.config'>>().toEqualTypeOf<ApplicationConfig[] | null>()
     expectTypeOf<ValueOf<'applications.list'>>().toEqualTypeOf<TopicResult<
-      Application<ApplicationInclude>[]
+      (Application<ApplicationInclude> | LocalApplication | Installation<InstallationInclude>)[]
     > | null>()
+    // Every kind joins the list value element, distinguished by shape rather than a tag.
+    expectTypeOf<Application<ApplicationInclude>>().toMatchTypeOf<ListedApplication>()
+    expectTypeOf<LocalApplication>().toMatchTypeOf<ListedApplication>()
+    expectTypeOf<Installation<InstallationInclude>>().toMatchTypeOf<ListedApplication>()
     expectTypeOf<Extract<ListedInterface, {type: 'tile'}>['metadata']>().toEqualTypeOf<{
       order?: number
       size: 'small' | 'large' | 'banner'

package/src/dashboard/messageBus/topics.ts

@@ -1,6 +1,7 @@
 import {type CurrentUser} from '@sanity/types'
 
 import {type Application, type ApplicationInclude} from '../../applications/applications'
+import {type Installation, type InstallationInclude} from '../../installations/installations'
 import {type OrganizationBase} from '../../organization/organization'
 
 /**
@@ -108,6 +109,15 @@ export interface ApplicationContext {
   readonly document: {readonly id: string} | null
 }
 
+/**
+ * An application served by a CLI dev server. The workbench publishes it in the same shape as a
+ * deployed application; `local` marks it and names the dev server it is served from.
+ * @public
+ */
+export type LocalApplication = Application<ApplicationInclude> & {
+  readonly local: {readonly host: string; readonly port: number}
+}
+
 /**
  * Declares a topic that stores and replays its current value.
  * @public
@@ -180,8 +190,16 @@ export interface DashboardTopics {
   'applications.context.update': EventTopicDef<ApplicationContext | null>
   /** The foreground application ID, or `null` on dashboard-level routes. */
   'applications.foreground': StateTopicDef<Application['id'] | null>
-  /** The dashboard applications available to the current user. */
-  'applications.list': StateTopicDef<TopicResult<Application<ApplicationInclude>[]> | null>
+  /**
+   * The dashboard applications and installations available to the current user. Each member
+   * publishes its own raw serialised record, so the kinds are distinguished by shape: an
+   * {@link Application} has a `type` of `'studio' | 'coreApp'`, a {@link LocalApplication} adds
+   * `local`, and an {@link Installation} has no `type` and carries `applicationId` with a nested
+   * `application` object.
+   */
+  'applications.list': StateTopicDef<TopicResult<
+    (Application<ApplicationInclude> | LocalApplication | Installation<InstallationInclude>)[]
+  > | null>
   'applications.status.update': EventTopicDef<ApplicationStatusUpdate>
   /**
    * The session token for the reading connection, or `null` while signed out. The host

package/src/installations/installations.ts

@@ -67,6 +67,10 @@ export interface InstallationBase {
     /** Qualified, globally-unique handle of the installed singleton (e.g. `sanity/<name>`). */
     reference: string
     slug: string | null
+    /** Sanitized SVG icon markup, or `null` when the singleton has no icon. */
+    icon: string | null
+    /** The singleton's publishing organization; the top-level `organizationId` is the installing one. */
+    organizationId: string
   }
 }
 

package/dist/topicStore-fPK2CfqH.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"topicStore-fPK2CfqH.d.ts","names":[],"sources":["../src/dashboard/messageBus/topics.ts","../src/dashboard/messageBus/bus.ts","../src/dashboard/messageBus/topicStore.ts"],"mappings":";;;;;;;UASiB;WACN;WACA;WACA;;;;;;;;;KAUC;;;;;UAMK,0BAA0B;WAChC,QAAQ;WACR,SAAS;;;;;;;;;cAUP;;;;;KAMD,qBAAqB;;;;;KAMrB,mBAAmB,QAAQ,OAAO;;;;;UAM7B;WACN;WACA;WACA;aACE;aACA;aACA;eACE;eACA;;eAEA;;;;;;;;KASH,sBAAsB;;;;;KAMtB;EAAqB;;;;;;KAMrB;;EAEV;;EAEA,OAAO;;;;;;UAOQ;;WAEN;aACE;aACA;;;WAGF;aAAoB;;;;;;;KAOnB,cAAc;EAAM;EAAe,OAAO;;;;;;KAM1C,cAAc,GAAG;EAC3B;EACA,SAAS;EACT,QAAQ;;;;;;KAOE,YAAY;EAAM;EAAU,OAAO;;EAAM;;;;;;KAMzC;;EAEV,OAAO;;EAEP;;;;;;KAOU,qBAAqB;;EAE/B;;IAEE;;IAEA,IAAI;;;;;;;UAQS;;EAEf,yBAAyB,cAAc;;;;;;EAMvC,0BAA0B,cAAc;;EAExC,6BAA6B,cAAc;;EAE3C,uBAAuB,cAAc;;EAErC,wBAAwB,eACrB;aAA+B,OAAO;;;EAGzC,+BAA+B,cAAc;;EAE7C,2BAA2B,cAAc;;EAEzC,qBAAqB,cAAc,YAAY,YAAY;EAC3D,8BAA8B,cAAc;;;;;EAK5C,cAAc;;EAEd,sBAAsB;;EAEtB,uBAAuB,cAAc;;;;;;;;;EASrC,8BAA8B;IAE1B;IACA;;IAED;;IAAa;IAAW;;;EAG3B,yBAAyB,cAAc,KAAK;;EAE5C,eAAe,cAAc;IACxB;IAAe;IAAc;IAAe;;IAC5C;IAAe;IAAc;;;EAIlC,mBAAmB;IAChB;IAAc;;IAA2B;IAAc;;;EAG1D,4BAA4B;;EAE5B,2BAA2B;;EAE3B,iBAAiB,cAAc;;;;;;UAQhB,eAAe;;;;;KAMpB,mBAAmB,KAAK;;;;;KAMxB,UAAU,UAAU,gBAAgB;KAE3C,cAAc,QAChB,WAAW,IAAI,EAAE;EAAY;IAAiB,mBACzC;;;;;KAMI,WAAW,UAAU,oBAAoB,cAAc;;;;;KA6DvD,WAAW,UAAU,uBAC9B,WAAW,UAAU,QAAQ;EAAY;IAAiB,mBACrD;;;;;KAMI,QAAQ,UAAU,WAAW,UAAU,UAAU,UAC3D,QAAQ,WAAW,oBAAoB,KAAK;;;;;KAMlC,UAAU,UAAU,WAAW,UAAU,UAAU,UAC7D,QAAQ,WAAW,oBAAoB,SAAS,MAAM;;;;;KAM5C,QAAQ,UAAU,WAAW,UAAU,UAAU,UAC3D,QAAQ,WAAW,oBAAoB,UAAU,KAAK;;;;;KChT5C;;;;;cAcC,wBAAwB;;WAE1B,MAAM;;EAGH,YAAA,MAAM,qBAAqB,kBAAkB;IAAW;;;;;;;UAWrD;;EAEf,OAAO;;;;;;EAMP;;EAEA;;;;;;UAOe,kBAAkB,GAAG,WAAW,UAAU,cAAc;;EAEvE,MAAM;;EAEN,SAAS;;EAET,MAAM;;EAEN,MAAM,OAAO;;;;;;EAMb,OAAO;;WAEE,QAAQ;;;;;;UAOF,sBAAsB,WAAW,WAAW;;EAE3D,cAAc;;WAEL,YAAY,QAAQ;;;;;;UAOd;;EAEf,SAAS;;;;;;UAOM,+BAA+B;;EAE9C;;;;;;UAOe,8BAA8B;;EAE7C;;;;;;UAOe,qBAAqB,WAAW,YAAY;;EAE3D,MAAM,WAAW,cAAc,oBAAoB,IAAI,YAAY,KAAK,QAAQ,IAAI;;EAEpF,QAAQ,yBAAyB,QAAQ;;;;;;;;;;UAW1B,WAAW,UAAU;;EAEpC,KAAK,UAAU,WAAW,UACxB,MAAM,MACH,MAAM,UAAU,GAAG,yBACjB,gBAAgB,UAAU,0BAC1B,SAAS,UAAU,GAAG,UAAU,UAAU,yBAC9C,qBAAqB,QAAQ,GAAG;;EAEnC,MAAM,UAAU,WAAW,UACzB,MAAM,GACN,UAAU,yBACT,QAAQ,QAAQ,GAAG;;EAEtB,UAAU,UAAU,WAAW,UAC7B,MAAM,GACN,UAAU,SAAS,kBAAkB,UAAU,GAAG,UAAU,QAAQ,GAAG,UAAU,aACjF,UAAU;;EAGZ,UAAU,UAAU,WAAW,UAC7B,MAAM,GACN,UAAU,OAAO,QAAQ,GAAG,mBAC5B,UAAU;;EAGZ,UAAU,UAAU,WAAW,UAAU,MAAM,IAAI,sBAAsB,QAAQ,GAAG;;EAEpF,UAAU,UAAU,WAAW,UAAU,MAAM,IAAI,WAAW,UAAU,GAAG;;;;;;UAO5D,qBAAqB,UAAU,0BAA0B,WAAW;;WAE1E,OAAO;;;;;;EAMhB;;;;;;UAOe;;WAEN,OAAO;;WAEP;;WAEA,QAAQ;;EAEjB,KAAK,UAAU,YAAY,MAAM,GAAG,OAAO,QAAQ;;;;;;;;;;;;;EAanD,OAAO,UAAU,YAAY,MAAM,GAAG;;;;;;;;;;;;UAavB,eAAe,UAAU,0BAA0B,qBAAqB;;;;;;;WAO9E,aAAa,WAAW;;;;;;UAk9BlB;;EAEf;;EAEA;;;;;;iBAOc,kBACd,UAAS,2BACR;;;;;iBAuBa;;;;;;UAWC;;EAEf;;;;;;;;iBASc,kBAAkB,UAAS,2BAAgC,eAAe;;;;;cCzvC7E,mBAAmB;;WAErB,OAAO;;EAGJ,YAAA,OAAO;;;;;;KAWT,UAAU,UAAU,cAC9B,QAAQ,kBAAiB,SACrB;EAAe;EAAU,aAAa;IACpC,UACA;EAAe;YAEb;UAgBA;;EAER;;EAEA,UAAU;EACV;;UAGQ;EACR;KAAU,gBAAgB;;;;;;;;;;;;;;cAoDf,eAAa,iBAAA,uBAAA,OAAA,aAAA;;;;;;;;;;cAuCb,cAAY,iBAAA,uBAAA,OAAA,aAAA"}