@sanity/sdk 0.0.1 → 0.0.3

package/README.md

@@ -2,16 +2,18 @@
   <a href="https://sanity.io">
     <img src="https://cdn.sanity.io/images/3do82whm/next/1dfce9dde7a62ccaa8e8377254a1e919f6c07ad3-128x128.svg" />
   </a>
-  <h1 align="center">Sanity Core App SDK</h1>
+  <h1 align="center">Sanity App SDK (Core)</h1>
 </p>
 
-Core functionality powering the React SDK.
+The App SDK Core is a pure TypeScript implementation of the App SDK’s business logic. It powers our React App SDK under the hood, and leaves the door open for future framework specific implementations, too.
 
-## Documentation
+We highly recommend that users default to using the hooks provided by the React SDK for building custom apps on the Sanity platform, unless you’re looking to create your own Sanity App SDK using this core layer.
 
-- Familiarize yourself with the App SDK via a conceptual overview, a quickstart guide, and a step by step walkthrough on **[the Sanity Docs site](https://sanity.io/docs/app-sdk)**
-- Go in depth with the **[App SDK reference docs](https://sdk-docs.sanity.dev)**
-- View example implementations on the **[SDK Explorer](https://sdk-examples.sanity.dev)**
+**Looking for our React SDK?** You’ll find it on:
+
+- [GitHub](https://github.com/sanity-io/sdk/tree/main/packages/react)
+- [Sanity Docs](https://sanity.io/docs/app-sdk)
+- [App SDK (React) reference docs](https://reference.sanity.io/_sanity/sdk-react)
 
 ## License
 

package/dist/index.d.ts

@@ -27,15 +27,17 @@ import {ResponseQueryOptions} from '@sanity/client'
 import {Role} from '@sanity/types'
 import {SanityClient} from '@sanity/client'
 import {SanityDocument} from '@sanity/types'
-import {SanityDocument as SanityDocument_2} from '@sanity/client'
+import {SanityDocument as SanityDocument_2} from 'groq'
+import {SanityDocument as SanityDocument_3} from '@sanity/client'
 import {SanityDocumentLike} from '@sanity/types'
-import {SanityDocumentResult} from 'groq'
 import {SanityProject as SanityProject_2} from '@sanity/client'
 import {SanityProjectionResult} from 'groq'
 import {SanityQueryResult} from 'groq'
 import {SanityUser as SanityUser_2} from './types'
 import {StackablePerspective} from '@sanity/client'
 import {StateSource as StateSource_2} from '../_exports'
+import {StateSource as StateSource_3} from '../../_exports'
+import {Status} from '@sanity/comlink'
 import {StudioResource} from '@sanity/message-protocol'
 import {Subject} from 'rxjs'
 import {ValuePending as ValuePending_2} from './previewStore'
@@ -75,9 +77,7 @@ declare type ActionMap = {
 }
 
 /** @beta */
-export declare interface ActionsResult<
-  TDocument extends SanityDocumentResult = SanityDocumentResult,
-> {
+export declare interface ActionsResult<TDocument extends SanityDocument_2 = SanityDocument_2> {
   transactionId: string
   documents: DocumentSet<TDocument>
   previous: DocumentSet<TDocument>
@@ -184,7 +184,7 @@ export declare function applyDocumentActions<
     | DocumentAction<TDocumentType, TDataset, TProjectId>
     | DocumentAction<TDocumentType, TDataset, TProjectId>[],
   options?: ApplyDocumentActionsOptions,
-): Promise<ActionsResult<SanityDocumentResult<TDocumentType, TDataset, TProjectId>>>
+): Promise<ActionsResult<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>>>
 
 /** @beta */
 export declare function applyDocumentActions(
@@ -429,6 +429,7 @@ export declare interface ComlinkControllerState {
  */
 export declare interface ComlinkNodeState {
   nodes: Map<string, NodeEntry>
+  subscriptions: Map<string, Set<symbol>>
 }
 
 declare interface Context {
@@ -847,12 +848,12 @@ declare 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?: SanityDocument_2 | null
   /**
    * the current ephemeral working copy that includes local optimistic changes
    * that have not yet been confirmed by the server
    */
-  local?: SanityDocument | null
+  local?: SanityDocument_2 | null
   /**
    * the revision that our remote document is at
    */
@@ -888,7 +889,7 @@ declare interface DocumentStoreState {
   grants?: Record<Grant, ExprNode>
   error?: unknown
   sharedListener: SharedListener
-  fetchDocument: (documentId: string) => Observable<SanityDocument | null>
+  fetchDocument: (documentId: string) => Observable<SanityDocument_2 | null>
   events: Subject<DocumentEvent>
 }
 
@@ -1165,7 +1166,7 @@ export declare function getDocumentState<
 >(
   instance: SanityInstance,
   options: DocumentOptions<undefined, TDocumentType, TDataset, TProjectId>,
-): StateSource<SanityDocumentResult<TDocumentType, TDataset, TProjectId> | undefined | null>
+): StateSource<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`> | undefined | null>
 
 /** @beta */
 export declare function getDocumentState<
@@ -1177,7 +1178,7 @@ export declare function getDocumentState<
   instance: SanityInstance,
   options: DocumentOptions<TPath, TDocumentType, TDataset, TProjectId>,
 ): StateSource<
-  JsonMatch<SanityDocumentResult<TDocumentType, TDataset, TProjectId>, TPath> | undefined
+  JsonMatch<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`>, TPath> | undefined
 >
 
 /** @beta */
@@ -1211,6 +1212,20 @@ export declare const getFavoritesState: BoundStoreAction<
  */
 export declare const getLoginUrlState: BoundStoreAction<AuthStoreState, [], StateSource_2<string>>
 
+/**
+ * Provides a subscribable state source for a node by name
+ * @param instance - The Sanity instance to get the node state for
+ * @param nodeInput - The configuration for the node to get the state for
+
+ * @returns A subscribable state source for the node
+ * @public
+ */
+export declare const getNodeState: BoundStoreAction_2<
+  ComlinkNodeState,
+  [NodeInput],
+  StateSource_3<NodeState | undefined>
+>
+
 /**
  * Retrieve or create a channel to be used for communication between
  * an application and the controller.
@@ -1233,18 +1248,6 @@ export declare const getOrCreateController: BoundStoreAction_2<
   Controller
 >
 
-/**
- * Retrieve or create a node to be used for communication between
- * an application and the controller -- specifically, a node should
- * be created within a frame / window to communicate with the controller.
- * @public
- */
-export declare const getOrCreateNode: BoundStoreAction_2<
-  ComlinkNodeState,
-  [options: NodeInput],
-  Node_2<Message, Message>
->
-
 /** @beta */
 export declare const getPermissionsState: BoundStoreAction<
   DocumentStoreState,
@@ -1303,7 +1306,9 @@ export declare function getProjectionState<
   instance: SanityInstance,
   options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
 ): StateSource<
-  | ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, TDataset, TProjectId>>
+  | ProjectionValuePending<
+      SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
+    >
   | undefined
 >
 
@@ -1363,7 +1368,7 @@ export declare function getQueryState<
 >(
   instance: SanityInstance,
   queryOptions: QueryOptions<TQuery, TDataset, TProjectId>,
-): StateSource<SanityQueryResult<TQuery, TDataset, TProjectId> | undefined>
+): StateSource<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`> | undefined>
 
 /** @beta */
 export declare function getQueryState<TData>(
@@ -1634,7 +1639,16 @@ declare interface NegNode extends BaseNode {
 declare interface NodeEntry {
   node: Node_2<WindowMessage, FrameMessage>
   options: NodeInput
-  refCount: number
+  status: Status
+  statusUnsub?: () => void
+}
+
+/**
+ * @public
+ */
+export declare interface NodeState {
+  node: Node_2<WindowMessage, FrameMessage>
+  status: Status | undefined
 }
 
 declare interface NotNode extends BaseNode {
@@ -1995,12 +2009,6 @@ export declare type ReleaseDocument = SanityDocument & {
   }
 }
 
-/**
- * Signals to the store that the consumer has stopped using the node
- * @public
- */
-export declare const releaseNode: BoundStoreAction_2<ComlinkNodeState, [name: string], void>
-
 /**
  * @public
  */
@@ -2029,10 +2037,10 @@ export declare function resolveDocument<
 >(
   instance: SanityInstance,
   docHandle: DocumentHandle<TDocumentType, TDataset, TProjectId>,
-): Promise<SanityDocumentResult<TDocumentType, TDataset, TProjectId> | null>
+): Promise<SanityDocument_2<TDocumentType, `${TProjectId}.${TDataset}`> | null>
 
 /** @beta */
-export declare function resolveDocument<TData extends SanityDocument>(
+export declare function resolveDocument<TData extends SanityDocument_2>(
   instance: SanityInstance,
   docHandle: DocumentHandle<string, string, string>,
 ): Promise<TData | null>
@@ -2088,7 +2096,9 @@ export declare function resolveProjection<
   instance: SanityInstance,
   options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>,
 ): Promise<
-  ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, TDataset, TProjectId>>
+  ProjectionValuePending<
+    SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>
+  >
 >
 
 /** @beta */
@@ -2125,7 +2135,7 @@ export declare function resolveQuery<
 >(
   instance: SanityInstance,
   queryOptions: ResolveQueryOptions<TQuery, TDataset, TProjectId>,
-): Promise<SanityQueryResult<TQuery, TDataset, TProjectId>>
+): Promise<SanityQueryResult<TQuery, `${TProjectId}.${TDataset}`>>
 
 /** @beta */
 export declare function resolveQuery<TData>(
@@ -2342,7 +2352,7 @@ declare interface SelectorNode extends BaseNode {
 }
 
 declare interface SharedListener {
-  events: Observable<ListenEvent<SanityDocument_2>>
+  events: Observable<ListenEvent<SanityDocument_3>>
   dispose: () => void
 }
 

package/dist/index.js

@@ -1,13 +1,13 @@
 import { createClient } from "@sanity/client";
-import { Observable, share, map, distinctUntilChanged, skip, filter, exhaustMap, timer, from, takeWhile, switchMap, firstValueFrom, fromEvent, EMPTY, defer, asapScheduler, combineLatest, of, concatMap, withLatestFrom, concat, throwError, first as first$1, Subject, takeUntil, partition, merge, shareReplay, tap as tap$1, catchError as catchError$1, startWith as startWith$1, pairwise as pairwise$1, groupBy as groupBy$1, mergeMap as mergeMap$1, throttle, race, timeout, retry, NEVER, debounceTime as debounceTime$1, Subscription } from "rxjs";
+import { Observable, share, map, distinctUntilChanged, skip, filter, exhaustMap, timer, from, takeWhile, switchMap, firstValueFrom, fromEvent, EMPTY, defer, asapScheduler, combineLatest, of, concatMap, withLatestFrom, concat, throwError, first as first$1, Subject, takeUntil, partition, merge, shareReplay, tap as tap$1, catchError as catchError$1, startWith as startWith$1, pairwise as pairwise$1, groupBy as groupBy$1, mergeMap as mergeMap$1, throttle, race, retry, NEVER, debounceTime as debounceTime$1, Subscription } from "rxjs";
 import { devtools } from "zustand/middleware";
 import { createStore } from "zustand/vanilla";
 import { pick, omit, isEqual, isObject } from "lodash-es";
 import { first, switchMap as switchMap$1, groupBy, mergeMap, startWith, pairwise, filter as filter$1, map as map$1, delay, tap, catchError, scan, share as share$1, take, debounceTime } from "rxjs/operators";
 import { createController, createNode } from "@sanity/comlink";
+import { createSelector } from "reselect";
 import { SanityEncoder } from "@sanity/mutate";
 import { getPublishedId as getPublishedId$1 } from "@sanity/client/csm";
-import { createSelector } from "reselect";
 import { applyPatches, parsePatch, makePatches, stringifyPatches } from "@sanity/diff-match-patch";
 import { isKeySegment, isKeyedObject } from "@sanity/types";
 import { createDocumentLoaderFromClient } from "@sanity/mutate/_unstable_store";
@@ -894,35 +894,38 @@ const handleAuthCallback = bindActionGlobally(
   if (existing) {
     if (!isEqual(existing.options, options))
       throw new Error(`Node "${options.name}" already exists with different options`);
-    return state.set("incrementNodeRefCount", {
-      nodes: new Map(nodes).set(options.name, {
-        ...existing,
-        refCount: existing.refCount + 1
-      })
-    }), existing.node.start(), existing.node;
+    return existing.node.start(), existing.node;
   }
   const node = createNode(options);
-  return node.start(), nodes.set(options.name, { node, options, refCount: 1 }), state.set("createNode", { nodes }), node;
+  node.start();
+  const statusUnsub = node.onStatus((status) => {
+    const currentNodes = state.get().nodes, currentEntry = currentNodes.get(options.name);
+    if (!currentEntry) return;
+    const updatedEntry = {
+      ...currentEntry,
+      status
+    };
+    state.set("updateNodeStatus", {
+      nodes: new Map(currentNodes).set(options.name, updatedEntry)
+    });
+  }), entry = {
+    node,
+    options,
+    status: "idle",
+    statusUnsub
+  };
+  return nodes.set(options.name, entry), state.set("createNode", { nodes }), node;
 }, releaseNode$1 = ({ state }, name) => {
   const nodes = state.get().nodes, existing = nodes.get(name);
   if (existing) {
-    const newRefCount = existing.refCount - 1;
-    if (newRefCount <= 0) {
-      existing.node.stop(), nodes.delete(name), state.set("removeNode", { nodes });
-      return;
-    }
-    state.set("decrementNodeRefCount", {
-      nodes: new Map(nodes).set(name, {
-        ...existing,
-        refCount: newRefCount
-      })
-    });
+    existing.statusUnsub && existing.statusUnsub(), existing.node.stop(), nodes.delete(name), state.set("removeNode", { nodes });
     return;
   }
 }, comlinkNodeStore = {
   name: "nodeStore",
   getInitialState: () => ({
-    nodes: /* @__PURE__ */ new Map()
+    nodes: /* @__PURE__ */ new Map(),
+    subscriptions: /* @__PURE__ */ new Map()
   }),
   initialize({ state }) {
     return () => {
@@ -931,7 +934,26 @@ const handleAuthCallback = bindActionGlobally(
       });
     };
   }
-}, releaseNode = bindActionGlobally(comlinkNodeStore, releaseNode$1), getOrCreateNode = bindActionGlobally(comlinkNodeStore, getOrCreateNode$1);
+}, releaseNode = bindActionGlobally(comlinkNodeStore, releaseNode$1), getOrCreateNode = bindActionGlobally(comlinkNodeStore, getOrCreateNode$1), NODE_RELEASE_TIME = 5e3, selectNode = (context, nodeInput) => context.state.nodes.get(nodeInput.name), getNodeState = bindActionGlobally(
+  comlinkNodeStore,
+  createStateSourceAction({
+    selector: createSelector([selectNode], (nodeEntry) => nodeEntry?.status === "connected" ? {
+      node: nodeEntry.node,
+      status: nodeEntry.status
+    } : void 0),
+    onSubscribe: ({ state, instance }, nodeInput) => {
+      const nodeName = nodeInput.name, subscriberId = Symbol("comlink-node-subscriber");
+      getOrCreateNode(instance, nodeInput);
+      let subs = state.get().subscriptions.get(nodeName);
+      return subs || (subs = /* @__PURE__ */ new Set(), state.get().subscriptions.set(nodeName, subs)), subs.add(subscriberId), () => {
+        setTimeout(() => {
+          const activeSubs = state.get().subscriptions.get(nodeName);
+          activeSubs && (activeSubs.delete(subscriberId), activeSubs.size === 0 && (state.get().subscriptions.delete(nodeName), releaseNode(instance, nodeName)));
+        }, NODE_RELEASE_TIME);
+      };
+    }
+  })
+);
 function createDocumentHandle(handle) {
   return handle;
 }
@@ -1017,7 +1039,7 @@ function discardDocument(doc) {
     documentId: getPublishedId(doc.documentId)
   };
 }
-const DOCUMENT_STATE_CLEAR_DELAY = 1e3, INITIAL_OUTGOING_THROTTLE_TIME = 1e3, API_VERSION$3 = "vX";
+const DOCUMENT_STATE_CLEAR_DELAY = 1e3, INITIAL_OUTGOING_THROTTLE_TIME = 1e3, API_VERSION$3 = "v2025-05-06";
 function parseBracketContent(content) {
   const rangeMatch = content.match(/^(\d*):(\d*)$/);
   if (rangeMatch) {
@@ -4114,7 +4136,7 @@ function getDocumentEvents(outgoing) {
     )
   );
 }
-const API_VERSION$2 = "vX";
+const API_VERSION$2 = "v2025-05-06";
 function createSharedListener(instance) {
   const dispose$ = new Subject(), events$ = getClientState(instance, {
     apiVersion: API_VERSION$2
@@ -4441,7 +4463,6 @@ async function _applyDocumentActions({ instance, state }, actionOrActions, { tra
     submitted
   };
 }
-const FAVORITES_FETCH_TIMEOUT = 3e3;
 function createFavoriteKey(context) {
   return `${context.documentId}:${context.documentType}:${context.resourceId}:${context.resourceType}${context.schemaName ? `:${context.schemaName}` : ""}`;
 }
@@ -4449,7 +4470,7 @@ const favorites = createFetcherStore({
   name: "Favorites",
   getKey: (_instance, context) => createFavoriteKey(context),
   fetcher: (instance) => (context) => {
-    const node = getOrCreateNode(instance, {
+    const nodeStateSource = getNodeState(instance, {
       name: SDK_NODE_NAME,
       connectTo: SDK_CHANNEL_NAME
     }), payload = {
@@ -4462,28 +4483,25 @@ const favorites = createFetcherStore({
           schemaName: context.schemaName
         }
       }
-    }, dashboardFetch = from(
-      node.fetch(
-        // @ts-expect-error -- getOrCreateNode should be refactored to take type arguments
-        "dashboard/v1/events/favorite/query",
-        payload
-      )
-    ).pipe(
-      timeout({
-        first: FAVORITES_FETCH_TIMEOUT,
-        with: () => throwError(() => new Error("Favorites service connection timeout"))
-      }),
-      map((response) => ({ isFavorited: response.isFavorited })),
-      catchError$1((err) => (console.error("Favorites service connection error", err), of({ isFavorited: !1 }))),
-      // Share the same subscription between multiple subscribers
-      shareReplay(1)
+    };
+    return nodeStateSource.observable.pipe(
+      filter((nodeState) => !!nodeState),
+      // Only proceed when connected
+      shareReplay(1),
+      switchMap((nodeState) => {
+        const node = nodeState.node;
+        return from(
+          node.fetch(
+            // @ts-expect-error -- getOrCreateNode should be refactored to take type arguments
+            "dashboard/v1/events/favorite/query",
+            payload
+          )
+        ).pipe(
+          map((response) => ({ isFavorited: response.isFavorited })),
+          catchError$1((err) => (console.error("Favorites service connection error", err), of({ isFavorited: !1 })))
+        );
+      })
     );
-    return new Observable((subscriber) => {
-      const subscription = dashboardFetch.subscribe(subscriber);
-      return () => {
-        subscription.unsubscribe(), subscription.closed && releaseNode(instance, SDK_NODE_NAME);
-      };
-    });
   }
 }), getFavoritesState = favorites.getState, resolveFavoritesState = favorites.resolveState, fetch = (client, query, params, options) => defer(
   () => client.observable.fetch(query, params, {
@@ -4608,7 +4626,7 @@ const DEFAULT_PERSPECTIVE = "drafts", optionsCache = /* @__PURE__ */ new Map(),
       }
     )
   })
-), QUERY_STATE_CLEAR_DELAY = 1e3, QUERY_STORE_API_VERSION = "vX", setQueryError = (key, error) => (prev) => {
+), QUERY_STATE_CLEAR_DELAY = 1e3, QUERY_STORE_API_VERSION = "v2025-05-06", setQueryError = (key, error) => (prev) => {
   const prevQuery = prev.queries[key];
   return prevQuery ? { ...prev, queries: { ...prev.queries, [key]: { ...prevQuery, error } } } : prev;
 }, setQueryData = (key, result, syncTags) => (prev) => {
@@ -4806,7 +4824,7 @@ const TITLE_CANDIDATES = ["title", "name", "label", "heading", "header", "captio
   _type,
   _id,
   _updatedAt
-}`, PREVIEW_TAG = "preview", PREVIEW_PERSPECTIVE = "drafts", STABLE_EMPTY_PREVIEW = { data: null, isPending: !1 }, STABLE_ERROR_PREVIEW = {
+}`, PREVIEW_TAG = "preview", PREVIEW_PERSPECTIVE = "raw", STABLE_EMPTY_PREVIEW = { data: null, isPending: !1 }, STABLE_ERROR_PREVIEW = {
   data: {
     title: "Preview Error",
     ...!!getEnv("DEV") && { subtitle: "Check the console for more details" }
@@ -5031,7 +5049,7 @@ function processProjectionQuery({ ids, results }) {
   }
   return finalValues;
 }
-const PROJECTION_TAG = "sdk.projection", PROJECTION_PERSPECTIVE = "drafts", PROJECTION_STATE_CLEAR_DELAY = 1e3, STABLE_EMPTY_PROJECTION = {
+const PROJECTION_TAG = "sdk.projection", PROJECTION_PERSPECTIVE = "raw", PROJECTION_STATE_CLEAR_DELAY = 1e3, STABLE_EMPTY_PROJECTION = {
   data: null,
   isPending: !1
 };
@@ -5387,7 +5405,7 @@ function createGroqSearchFilter(query) {
     `${finalIncrementalToken}${WILDCARD_TOKEN}`
   ), `[@] match text::query("${processedTokens.join(" ").replace(/"/g, '\\"')}")`;
 }
-var version = "0.0.1";
+var version = "0.0.3";
 const CORE_SDK_VERSION = getEnv("PKG_VERSION") || `${version}-development`;
 export {
   AuthStateType,
@@ -5415,9 +5433,9 @@ export {
   getDocumentSyncStatus,
   getFavoritesState,
   getLoginUrlState,
+  getNodeState,
   getOrCreateChannel,
   getOrCreateController,
-  getOrCreateNode,
   getPermissionsState,
   getPerspectiveState,
   getPreviewState,
@@ -5438,7 +5456,6 @@ export {
   parseUsersKey,
   publishDocument,
   releaseChannel,
-  releaseNode,
   resolveDatasets,
   resolveDocument,
   resolveFavoritesState,