@sanity/sdk 3.1.0 → 3.3.0-rc.0

package/src/dashboard/messageBus/topics.ts

@@ -0,0 +1,260 @@
+import {type CurrentUser} from '@sanity/types'
+
+import {type Application, type ApplicationInclude} from '../../applications/applications'
+import {type OrganizationBase} from '../../organization/organization'
+
+/**
+ * Identifies a module federation expose and the manifest that serves it.
+ * @public
+ */
+export interface RemoteModuleRef {
+  readonly entry: string
+  readonly moduleId: string
+  readonly version: string
+}
+
+/**
+ * Application types that can receive configuration modules.
+ *
+ * The dashboard supplies this value over the message bus, so any string is accepted; known
+ * types are listed for autocomplete. `& {}` keeps the literal from collapsing into `string`.
+ * @public
+ */
+export type ApplicationConfigAppType = 'media-library' | (string & {})
+
+/**
+ * Identifies a configuration module for an application or application type.
+ * @public
+ */
+export interface ApplicationConfig extends RemoteModuleRef {
+  readonly appId?: Application['id']
+  readonly appType: ApplicationConfigAppType
+}
+
+/**
+ * Declares a topic that stores and replays its current value.
+ * @public
+ */
+export type StateTopicDef<T> = {kind: 'state'; value: T}
+
+/**
+ * Declares a topic that delivers events and an optional reply.
+ * @public
+ */
+export type EventTopicDef<P, R = never> = {
+  kind: 'event'
+  payload: P
+  reply?: R
+}
+
+/**
+ * Represents a successful topic value or a failed topic operation.
+ * @public
+ */
+export type TopicResult<T> = {ok: true; value: T} | {ok: false}
+
+/**
+ * Identifies a dashboard application and a route within it.
+ * @public
+ */
+export type NavigationTarget = {
+  /** The application ID, or `null` for dashboard-level routes. */
+  appId: Application['id'] | null
+  /** The route path, including its query string and fragment. */
+  path: string
+}
+
+/**
+ * Describes the current dashboard location and an active navigation.
+ * @public
+ */
+export type NavigationLocation = NavigationTarget & {
+  /** The active navigation, or `null` when navigation is idle. */
+  transition: {
+    /** Whether the navigation pushes or replaces browser history. */
+    navigationType: 'push' | 'replace'
+    /** The requested destination. */
+    to: NavigationTarget
+  } | null
+}
+
+/**
+ * Declares the topics provided by the dashboard.
+ * @public
+ */
+export interface DashboardTopics {
+  /** The available application configuration modules. */
+  'applications.config': StateTopicDef<ApplicationConfig[] | 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 session token for the reading connection, or `null` while signed out. The host
+   * writes it to each connection separately, so one application never sees another's token.
+   */
+  'auth.token': StateTopicDef<string | null>
+  /** Requests a dashboard session token. */
+  'auth.token.refresh': EventTopicDef<void, string>
+  /** The current dashboard location and active navigation. */
+  'navigation.location': StateTopicDef<NavigationLocation | null>
+  /**
+   * Requests navigation and replies when the location commits.
+   *
+   * `ok: false` reasons:
+   * - `not-navigable`: the URL cannot be handled by a dashboard application
+   * - `interrupted`: another navigation superseded the request
+   * - `failed`: the router rejected or did not commit the request
+   */
+  'navigation.location.update': EventTopicDef<
+    {
+      url: string
+      history?: 'push' | 'replace'
+    },
+    {ok: true} | {ok: false; reason: 'not-navigable' | 'interrupted' | 'failed'}
+  >
+  /** The current organization, or `null` without an active organization. */
+  'organizations.current': StateTopicDef<Pick<OrganizationBase, 'id' | 'name' | 'slug'> | null>
+  /** The open panel, its application, display mode, and optional width in pixels. */
+  'panels.mode': StateTopicDef<TopicResult<
+    | {appId: string; name: string; mode: 'aside'; size?: number}
+    | {appId: string; name: string; mode: 'full'}
+    | null
+  > | null>
+  /** Opens, updates, resizes, or closes an application's panel. */
+  'panels.mode.set': EventTopicDef<
+    {name: string; mode: 'aside' | 'full'} | {name: string; size: number} | null
+  >
+  /** The resolved dashboard color scheme. */
+  'preferences.color-scheme': StateTopicDef<'light' | 'dark'>
+  /** Whether the dashboard dock is pinned open. */
+  'preferences.dock-locked': StateTopicDef<boolean>
+  /** The signed-in user, or `null` while signed out. */
+  'users.current': StateTopicDef<Pick<CurrentUser, 'id' | 'name' | 'email' | 'profileImage'> | null>
+}
+
+/**
+ * Declares every topic available through the message bus.
+ * @public
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Declaration merging extends the SDK manifest.
+export interface Topics extends DashboardTopics {}
+
+/**
+ * Every declared topic name.
+ * @public
+ */
+export type TopicName = keyof Topics
+
+type StateTopicsOf<T> = {
+  [K in keyof T]: T[K] extends {kind: 'state'} ? K : never
+}[keyof T]
+
+/**
+ * Names of all declared state topics.
+ * @public
+ */
+export type StateTopic = StateTopicsOf<Topics>
+
+type TopicOwnership = {readonly type: 'same_app'} | {readonly type: 'any_app'}
+
+// State is only ever written by the host, one connection at a time, so it carries no ownership.
+type TopicManifestEntry<T> = T extends {kind: 'state'; value: infer V}
+  ? {readonly kind: 'state'; readonly seed: V | undefined}
+  : {readonly kind: 'event'; readonly ownership: TopicOwnership}
+
+// The value a connection's copy of the topic starts with; `undefined` means unpublished.
+const stateTopic = <const V>(seed: V) => ({kind: 'state', seed}) as const
+
+// `same_app` restricts responding to the application that installed the bus.
+const dashboardEvent = {kind: 'event', ownership: {type: 'same_app'}} as const
+
+/**
+ * Defines the runtime kind, ownership, and initial value of dashboard topics.
+ * @internal
+ */
+export const DASHBOARD_TOPIC_MANIFEST: {
+  readonly [K in keyof DashboardTopics]: TopicManifestEntry<DashboardTopics[K]>
+} = {
+  'applications.config': stateTopic(undefined),
+  'applications.foreground': stateTopic(undefined),
+  'applications.list': stateTopic(undefined),
+  'auth.token': stateTopic(undefined),
+  'auth.token.refresh': dashboardEvent,
+  'navigation.location': stateTopic(undefined),
+  'navigation.location.update': dashboardEvent,
+  'organizations.current': stateTopic(undefined),
+  'panels.mode': stateTopic({ok: true, value: null}),
+  'panels.mode.set': dashboardEvent,
+  'preferences.color-scheme': stateTopic(undefined),
+  'preferences.dock-locked': stateTopic(undefined),
+  'users.current': stateTopic(undefined),
+}
+
+/**
+ * Defines the runtime manifest accepted from any message bus version.
+ * @internal
+ */
+export type TopicManifest = Readonly<
+  Record<
+    string,
+    | {readonly kind: 'state'; readonly seed: unknown}
+    | {readonly kind: 'event'; readonly ownership: TopicOwnership}
+  >
+>
+
+/**
+ * Names of all declared event topics.
+ * @public
+ */
+export type EventTopic = {
+  [K in TopicName]: Topics[K] extends {kind: 'event'} ? K : never
+}[TopicName]
+
+/**
+ * The value type of a state topic.
+ * @public
+ */
+export type ValueOf<K extends StateTopic> = Topics[K] extends StateTopicDef<infer T> ? T : never
+
+/**
+ * The payload type of an event topic.
+ * @public
+ */
+export type PayloadOf<K extends EventTopic> =
+  Topics[K] extends EventTopicDef<infer P, infer _R> ? P : never
+
+/**
+ * The reply type of an event topic (`never` if it declares none).
+ * @public
+ */
+export type ReplyOf<K extends EventTopic> =
+  Topics[K] extends EventTopicDef<infer _P, infer R> ? R : never
+
+/**
+ * Converts a topic value between 2 adjacent versions.
+ * @internal
+ */
+export interface TopicMigration {
+  /** The older version. */
+  readonly from: number
+  /** The newer version. */
+  readonly to: number
+  /** Converts an older state value or event payload to the newer version. */
+  up(older: unknown): unknown
+  /** Converts a newer state value or event payload to the older version. */
+  down(newer: unknown): unknown
+  /** Converts event replies between these versions. */
+  readonly reply?: {
+    /** Converts an older reply to the newer version. */
+    up(older: unknown): unknown
+    /** Converts a newer reply to the older version. */
+    down(newer: unknown): unknown
+  }
+}
+
+/**
+ * Defines the bundled migration chain for each topic.
+ * @internal
+ */
+export const topicMigrations: Partial<Record<TopicName, readonly TopicMigration[]>> = {}

package/src/document/actions.ts

@@ -2,13 +2,13 @@ import {type ReleaseDocument} from '@sanity/client'
 import {SanityEncoder} from '@sanity/mutate'
 import {type PatchMutation as SanityMutatePatchMutation} from '@sanity/mutate/_unstable_store'
 import {type PatchMutation, type PatchOperations} from '@sanity/types'
-import {type SanityDocument} from 'groq'
 
 import {
   type DocumentHandle,
   type DocumentTypeHandle,
   type ReleaseHandle,
 } from '../config/sanityConfig'
+import {type ResolveDocument} from '../typegen/resolve'
 import {getEffectiveDocumentId} from './util'
 
 const isSanityMutatePatch = (value: unknown): value is SanityMutatePatchMutation => {
@@ -37,7 +37,7 @@ export interface CreateDocumentAction<
    */
   initialValue?: Partial<
     Omit<
-      SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
+      ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
       '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'
     >
   >
@@ -166,7 +166,7 @@ export function createDocument<
   doc: DocumentTypeHandle<TDocumentType, TDataset, TProjectId>,
   initialValue?: Partial<
     Omit<
-      SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
+      ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
       '_id' | '_type' | '_rev' | '_createdAt' | '_updatedAt'
     >
   >,

package/src/document/applyDocumentActions.ts

@@ -1,10 +1,10 @@
-import {type SanityDocument} from 'groq'
 import {distinctUntilChanged, filter, first, firstValueFrom, map, race} from 'rxjs'
 
 import {type DocumentResource} from '../config/sanityConfig'
 import {bindActionByResource} from '../store/createActionBinder'
 import {type SanityInstance} from '../store/createSanityInstance'
 import {type StoreContext} from '../store/defineStore'
+import {type ResolveDocument} from '../typegen/resolve'
 import {randomUuid} from '../utils/ids'
 import {type Action} from './actions'
 import {documentStore, type DocumentStoreState} from './documentStore'
@@ -14,7 +14,7 @@ import {type AppliedTransaction, type QueuedTransaction, queueTransaction} from
 import {normalizeActionsForResource} from './resourceRules'
 
 /** @beta */
-export interface ActionsResult<TDocument extends SanityDocument = SanityDocument> {
+export interface ActionsResult<TDocument extends ResolveDocument = ResolveDocument> {
   transactionId: string
   documents: DocumentSet<TDocument>
   previous: DocumentSet<TDocument>
@@ -56,7 +56,7 @@ export function applyDocumentActions<
 >(
   instance: SanityInstance,
   options: ApplyDocumentActionsOptions,
-): Promise<ActionsResult<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>>>
+): Promise<ActionsResult<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>>>
 /** @beta */
 export function applyDocumentActions(
   instance: SanityInstance,

package/src/document/documentStore.ts

@@ -1,7 +1,6 @@
 import {type Action, ClientError, CorsOriginError, type Mutation} from '@sanity/client'
 import {DocumentId, getDraftId, getPublishedId, getVersionId} from '@sanity/id-utils'
 import {jsonMatch} from '@sanity/json-match'
-import {type SanityDocument} from 'groq'
 import {type ExprNode} from 'groq-js'
 import {
   catchError,
@@ -46,6 +45,7 @@ import {
 import {type SanityInstance} from '../store/createSanityInstance'
 import {createStateSourceAction, type StateSource} from '../store/createStateSourceAction'
 import {defineStore, type StoreContext} from '../store/defineStore'
+import {type ResolveDocument} from '../typegen/resolve'
 import {type DocumentAction} from './actions'
 import {
   ACL_RETRY_BASE_DELAY,
@@ -98,7 +98,7 @@ export interface DocumentStoreState {
   identity?: string
   error?: unknown
   sharedListener: SharedListener
-  fetchDocument: (documentId: string) => Observable<SanityDocument | null>
+  fetchDocument: (documentId: string) => Observable<ResolveDocument | null>
   events: Subject<DocumentEvent>
 }
 
@@ -108,12 +108,12 @@ export interface DocumentState {
    * the "remote" local copy that matches the server. represents the last known
    * server state. this gets updated every time we confirm remote patches
    */
-  remote?: SanityDocument | null
+  remote?: ResolveDocument | null
   /**
    * the current ephemeral working copy that includes local optimistic changes
    * that have not yet been confirmed by the server
    */
-  local?: SanityDocument | null
+  local?: ResolveDocument | null
   /**
    * the revision that our remote document is at
    */
@@ -194,7 +194,7 @@ export function getDocumentState<
 >(
   instance: SanityInstance,
   options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>,
-): StateSource<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`> | undefined | null>
+): StateSource<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`> | undefined | null>
 
 /** @beta */
 export function getDocumentState<
@@ -206,7 +206,7 @@ export function getDocumentState<
   instance: SanityInstance,
   options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>,
 ): StateSource<
-  JsonMatch<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined
+  JsonMatch<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined
 >
 
 /** @beta */
@@ -229,12 +229,12 @@ const _getDocumentState = bindActionByResource(
       const {documentId: docId, path, liveEdit, perspective} = options
       const documentId = DocumentId(docId)
       if (error) throw error
-      let document: SanityDocument | null | undefined
+      let document: ResolveDocument | null | undefined
 
       if (liveEdit) {
         document = documentStates[documentId]?.local
       } else {
-        let version: SanityDocument | null | undefined
+        let version: ResolveDocument | null | undefined
         if (isReleasePerspective(perspective)) {
           const versionId = getVersionId(documentId, perspective.releaseName)
           version = documentStates[versionId]?.local
@@ -267,16 +267,16 @@ export function resolveDocument<
 >(
   instance: SanityInstance,
   docHandle: DocumentHandle<TDocumentType, TDataset, TProjectId>,
-): Promise<SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`> | null>
+): Promise<ResolveDocument<TDocumentType, `${TProjectId}.${TDataset}`> | null>
 /** @beta */
-export function resolveDocument<TData extends SanityDocument>(
+export function resolveDocument<TData extends ResolveDocument>(
   instance: SanityInstance,
   docHandle: DocumentHandle<string, string, string>,
 ): Promise<TData | null>
 /** @beta */
 export function resolveDocument(
   ...args: Parameters<typeof _resolveDocument>
-): Promise<SanityDocument | null> {
+): Promise<ResolveDocument | null> {
   return _resolveDocument(...args)
 }
 const _resolveDocument = bindActionByResource(
@@ -287,7 +287,7 @@ const _resolveDocument = bindActionByResource(
         ...docHandle,
         path: undefined,
       }).observable.pipe(filter((i) => i !== undefined)),
-    ) as Promise<SanityDocument | null>
+    ) as Promise<ResolveDocument | null>
   },
 )
 

package/src/document/processMutations.ts

@@ -18,10 +18,9 @@ import {
 } from './patchOperations'
 
 /**
- * Represents a set of document that will go into `applyMutations`. Before
- * applying a mutation, it's expected that all relevant documents that the
- * mutations affect are included, including those that do not exist yet.
- * Documents that don't exist have a `null` value.
+ * Maps document IDs to documents, using `null` for documents that do not exist.
+ *
+ * @beta
  */
 export type DocumentSet<TDocument extends SanityDocument = SanityDocument> = {
   [TDocumentId in string]?: TDocument | null
@@ -29,10 +28,29 @@ export type DocumentSet<TDocument extends SanityDocument = SanityDocument> = {
 
 type SupportedPatchOperation = Exclude<keyof PatchOperations, 'merge'>
 
-// > If multiple patches are included, then the order of execution is as follows:
-// > - set, setIfMissing, unset, inc, dec, insert.
-// > https://www.sanity.io/docs/http-mutations#5b4db1396e56
-const patchOperations = {
+/**
+ * Exposes the patch operations used by {@link processMutations}.
+ *
+ * @remarks
+ * Property order determines execution order in {@link processMutations}:
+ * `ifRevisionID`, `set`, `setIfMissing`, `unset`, `inc`, `dec`, `insert`,
+ * then `diffMatchPatch`. Reordering the properties changes mutation results.
+ * Freezes the collection to prevent callers from replacing the functions
+ * used by the SDK's mutation evaluator.
+ *
+ * @see https://www.sanity.io/docs/http-mutations#5b4db1396e56
+ *
+ * @example
+ * ```ts
+ * const document = {items: [{_key: 'a', title: 'Before'}]}
+ * const updated = patchOperations.set<typeof document>(document, {
+ *   'items[_key=="a"].title': 'After',
+ * })
+ * ```
+ *
+ * @internal
+ */
+export const patchOperations = Object.freeze({
   ifRevisionID,
   set,
   setIfMissing,
@@ -46,7 +64,7 @@ const patchOperations = {
     input: unknown,
     pathExpressions: NonNullable<PatchOperations[K]>,
   ) => unknown
-}
+})
 
 /**
  * Implements ID generation:
@@ -69,7 +87,12 @@ export function getId(id?: string): string {
   return id
 }
 
-interface ProcessMutationsOptions {
+/**
+ * Configures {@link processMutations}.
+ *
+ * @internal
+ */
+export interface ProcessMutationsOptions {
   /**
    * The transaction ID that will become the next `_rev` for documents mutated
    * by the given mutations.
@@ -84,8 +107,8 @@ interface ProcessMutationsOptions {
    */
   mutations: Mutation[]
   /**
-   * An optional timestamp that will be used for `_createdAt` and `_updatedAt`
-   * timestamp when applicable.
+   * Supplies the default `_createdAt` and `_updatedAt` timestamps.
+   * Uses the current time when omitted or empty.
    */
   timestamp?: string
 }
@@ -108,18 +131,31 @@ export function getDocumentIds(selection: MutationSelection): string[] {
 }
 
 /**
- * Applies the given mutation to the given document set. Note, it is expected
- * that all relevant documents that the mutations affect should be within the
- * given `document` set. If a document does not exist, it should have the value
- * `null`. If a document is deleted as a result of the mutations, it will still
- * have its document ID present in the returns documents, but it will have a
- * value of `null`.
+ * Applies mutations to an in-memory set of Sanity documents.
+ * Deleted documents remain in the returned set with a value of `null`.
+ *
+ * Include every document affected by `mutations` in `documents`, using `null`
+ * for documents that do not exist.
+ *
+ * Returns `documents` itself when `mutations` is empty. Otherwise, returns a
+ * shallow copy of that object. The result can reuse document objects and
+ * nested objects from `documents`. Mutating a reused object through the
+ * result also changes the input.
+ *
+ * Sets `_rev` to `transactionId` on created, replaced, and patched documents.
+ * Uses `timestamp` for timestamps unless the mutation preserves them.
+ * Ignores `merge` patches; `inc` and `dec` skip values that are not numbers.
+ * Generates document IDs when omitted or ending in `.`.
+ * Patch operations can generate missing array keys.
+ *
+ * Does not persist documents or run Content Lake's server validation.
  *
- * The given `transactionId` will be used as the resulting `_rev` for documents
- * affected by the given set of mutations.
+ * @throws If a selection uses a query, a `create` targets an existing document,
+ * or a `patch` targets a document that does not exist.
+ * @throws If a patch operation fails, including a revision check failure or
+ * `diffMatchPatch` applied to a value other than a string or `undefined`.
  *
- * If a `timestamp` is given, that will be used as for the relevant `_updatedAt`
- * and `_createdAt` timestamps.
+ * @internal
  */
 export function processMutations({
   documents,

package/src/installations/installations.test-d.ts

@@ -1,5 +1,6 @@
 import {expectTypeOf, test} from 'vitest'
 
+import {type ApplicationInterface} from '../applications/applications'
 import {type SanityInstance} from '../store/createSanityInstance'
 import {type StateSource} from '../store/createStateSourceAction'
 import {type FetcherSnapshot} from '../store/fetcherStore'
@@ -10,7 +11,6 @@ import {
   type InstallationActiveConfig,
   type InstallationBase,
   type InstallationInclude,
-  type InstallationInterface,
   installations,
   type InstallationsResponse,
 } from './installations'
@@ -40,7 +40,7 @@ test('Installation — each token adds its top-level field, required, others abs
     Extract<keyof Installation<'access'>, 'activeConfig' | 'interfaces'>
   >().toEqualTypeOf<never>()
 
-  expectTypeOf<Installation<'interfaces'>['interfaces']>().toEqualTypeOf<InstallationInterface[]>()
+  expectTypeOf<Installation<'interfaces'>['interfaces']>().toEqualTypeOf<ApplicationInterface[]>()
   expectTypeOf<
     Installation<'activeConfig'>['activeConfig']
   >().toEqualTypeOf<InstallationActiveConfig | null>()
@@ -49,7 +49,7 @@ test('Installation — each token adds its top-level field, required, others abs
 test('Installation — multiple tokens add each field', () => {
   type Both = Installation<'access' | 'interfaces'>
   expectTypeOf<Both['access']>().toEqualTypeOf<InstallationAccess[]>()
-  expectTypeOf<Both['interfaces']>().toEqualTypeOf<InstallationInterface[]>()
+  expectTypeOf<Both['interfaces']>().toEqualTypeOf<ApplicationInterface[]>()
   expectTypeOf<Extract<keyof Both, 'activeConfig'>>().toEqualTypeOf<never>()
 })
 

package/src/installations/installations.ts

@@ -1,5 +1,6 @@
 import {switchMap} from 'rxjs'
 
+import {type ApplicationInterface} from '../applications/applications'
 import {getClientState} from '../client/clientStore'
 import {defineFetcher} from '../store/fetcherStore'
 import {buildQuery} from '../utils/buildQuery'
@@ -29,24 +30,6 @@ export interface InstallationAccess {
   resourceId: string
 }
 
-/**
- * An interface exposed by an installation, embedded when `interfaces` is
- * included.
- *
- * @see https://www.sanity.io/docs/http-reference/applications-api
- * @public
- */
-export interface InstallationInterface {
-  id: string
-  type: 'app' | 'worker' | 'asset_source' | 'panel'
-  name: string
-  title: string
-  version: string
-  /** Module federation module ID; resolved from the host mf-manifest at runtime */
-  moduleId: string
-  metadata: {group?: string; priority?: number} | null
-}
-
 /**
  * The active config of an installation, embedded when `activeConfig` is
  * included. `null` when nothing is deployed.
@@ -104,7 +87,7 @@ export type Installation<Include extends InstallationInclude = never> = Installa
     {activeConfig: InstallationActiveConfig | null}
   > &
   Included<InstallationInclude, 'access', Include, {access: InstallationAccess[]}> &
-  Included<InstallationInclude, 'interfaces', Include, {interfaces: InstallationInterface[]}>
+  Included<InstallationInclude, 'interfaces', Include, {interfaces: ApplicationInterface[]}>
 
 /**
  * Options for listing an organization's installations.

package/src/projection/getProjectionState.ts

@@ -1,5 +1,4 @@
 import {DocumentId, getPublishedId} from '@sanity/id-utils'
-import {type SanityProjectionResult} from 'groq'
 
 import {type DocumentHandle} from '../config/sanityConfig'
 import {bindActionByResourceAndPerspective} from '../store/createActionBinder'
@@ -9,6 +8,7 @@ import {
   type SelectorContext,
   type StateSource,
 } from '../store/createStateSourceAction'
+import {type ResolveProjectionResult} from '../typegen/resolve'
 import {hashString} from '../utils/hashString'
 import {randomId} from '../utils/ids'
 import {omitProperty} from '../utils/object'
@@ -39,7 +39,7 @@ export function getProjectionState<
   options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
 ): StateSource<
   | ProjectionValuePending<
-      SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
+      ResolveProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
     >
   | undefined
 >

package/src/projection/resolveProjection.ts

@@ -1,8 +1,8 @@
-import {type SanityProjectionResult} from 'groq'
 import {filter, firstValueFrom} from 'rxjs'
 
 import {bindActionByResourceAndPerspective} from '../store/createActionBinder'
 import {type SanityInstance} from '../store/createSanityInstance'
+import {type ResolveProjectionResult} from '../typegen/resolve'
 import {getProjectionState, type ProjectionOptions} from './getProjectionState'
 import {projectionStore} from './projectionStore'
 import {type ProjectionValuePending} from './types'
@@ -18,7 +18,7 @@ export function resolveProjection<
   options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
 ): Promise<
   ProjectionValuePending<
-    SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
+    ResolveProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
   >
 >