@sanity/sdk 3.0.0-rc.1 → 3.0.0

package/src/store/createSanityInstance.ts

@@ -1,7 +1,6 @@
 import {type SanityConfig} from '../config/sanityConfig'
 import {insecureRandomId} from '../utils/ids'
 import {createLogger, type InstanceContext} from '../utils/logger'
-import {pickProperties} from '../utils/object'
 
 /**
  * Represents a Sanity.io resource instance with its own configuration and lifecycle
@@ -38,36 +37,12 @@ export interface SanityInstance {
    * @returns Function to unsubscribe the callback
    */
   onDispose(cb: () => void): () => void
-
-  /**
-   * Gets the parent instance in the hierarchy
-   * @returns Parent instance or undefined if this is the root
-   * @deprecated The parent/child instance hierarchy is deprecated. Use a single SanityInstance instead.
-   */
-  getParent(): SanityInstance | undefined
-
-  /**
-   * Creates a child instance with merged configuration
-   * @param config - Configuration to merge with parent values
-   * @deprecated The parent/child instance hierarchy is deprecated. Use a single SanityInstance instead.
-   */
-  createChild(config: SanityConfig): SanityInstance
-
-  /**
-   * Traverses the instance hierarchy to find the first instance whose configuration
-   * matches the given target config using a shallow comparison.
-   * @param targetConfig - A partial configuration object containing key-value pairs to match.
-   * @returns The first matching instance or undefined if no match is found.
-   * @deprecated The parent/child instance hierarchy is deprecated. Use a single SanityInstance instead.
-   */
-  match(targetConfig: Partial<SanityConfig>): SanityInstance | undefined
 }
 
 /**
  * Creates a new Sanity resource instance
  * @param config - Configuration for the instance (optional)
  * @returns A configured SanityInstance
- * @remarks When creating child instances, configurations are merged with parent values
  *
  * @public
  */
@@ -101,7 +76,6 @@ export function createSanityInstance(config: SanityConfig = {}): SanityInstance
     perspective: config.perspective,
     hasStudioConfig: !!config.studio,
     hasStudioTokenSource: !!config.studio?.auth?.token,
-    legacyStudioMode: config.studioMode?.enabled,
     hasAuthProviders: !!config.auth?.providers,
     hasAuthToken: !!config.auth?.token,
   })
@@ -131,43 +105,6 @@ export function createSanityInstance(config: SanityConfig = {}): SanityInstance
         disposeListeners.delete(listenerId)
       }
     },
-    getParent: () => undefined,
-    createChild: (next) => {
-      logger.debug('Creating child instance', {
-        parentInstanceId: instanceId.slice(0, 8),
-        overridingProjectId: !!next.projectId,
-        overridingDataset: !!next.dataset,
-        overridingAuth: !!next.auth,
-      })
-      const child = Object.assign(
-        createSanityInstance({
-          ...config,
-          ...next,
-          ...(config.auth === next.auth
-            ? config.auth
-            : config.auth && next.auth && {auth: {...config.auth, ...next.auth}}),
-        }),
-        {getParent: () => instance},
-      )
-      logger.trace('Child instance created', {
-        internal: true,
-        childInstanceId: child.instanceId.slice(0, 8),
-      })
-      return child
-    },
-    match: (targetConfig) => {
-      if (
-        Object.entries(pickProperties(targetConfig, ['auth', 'projectId', 'dataset'])).every(
-          ([key, value]) => config[key as keyof SanityConfig] === value,
-        )
-      ) {
-        return instance
-      }
-
-      const parent = instance.getParent()
-      if (parent) return parent.match(targetConfig)
-      return undefined
-    },
   }
 
   return instance

package/src/store/createStateSourceAction.ts

@@ -155,7 +155,7 @@ interface StateSourceOptions<TState, TParams extends unknown[], TReturn, TKey> {
  *   // ...
  * })
  *
- * const getDocument = bindActionByDataset(
+ * const getDocument = bindActionByResource(
  *   documentStore,
  *   createStateSourceAction(({state}, documentId: string) => state.documents[documentId])
  * )

package/src/store/fetcherStore.test.ts

@@ -1,4 +1,4 @@
-import {NEVER, of, startWith, Subject, throwError} from 'rxjs'
+import {concatWith, NEVER, of, startWith, Subject, throwError} from 'rxjs'
 import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest'
 
 import {createSanityInstance, type SanityInstance} from './createSanityInstance'
@@ -65,6 +65,28 @@ describe('fetcherStore', () => {
     unsub3()
   })
 
+  it('revalidates a stale entry on re-subscribe when the fetch source does not complete', async () => {
+    let n = 0
+    const fetchSpy = vi.fn(() => of(++n).pipe(concatWith(NEVER)))
+    const fetcher = defineFetcher<[], number>({
+      name: 'swr-non-completing',
+      staleTime: 0,
+      getKey: () => 'k',
+      fetch: () => fetchSpy,
+    })
+
+    const first = fetcher.getState(instance)
+    const unsub1 = first.subscribe()
+    await vi.waitFor(() => expect(first.getCurrent().data).toBe(1))
+    unsub1()
+
+    const second = fetcher.getState(instance)
+    const unsub2 = second.subscribe()
+    await vi.waitFor(() => expect(fetchSpy).toHaveBeenCalledTimes(2))
+    expect(second.getCurrent().data).toBe(2)
+    unsub2()
+  })
+
   it('invalidate refetches an actively-subscribed entry', async () => {
     let n = 0
     const fetcher = defineFetcher<[], number>({

package/src/store/fetcherStore.ts

@@ -1,4 +1,4 @@
-import {filter, firstValueFrom, map, type Observable, Subscription} from 'rxjs'
+import {filter, firstValueFrom, map, type Observable, Subscription, take} from 'rxjs'
 
 import {setCleanupInterval, setCleanupTimeout} from '../utils/setCleanupTimeout'
 import {bindActionGlobally} from './createActionBinder'
@@ -490,6 +490,7 @@ const startFetch = (
   sub.add(
     def
       .fetch(instance)(...params)
+      .pipe(take(1))
       .subscribe({
         next: (data) => {
           const current = state.get().entries[key]
@@ -659,8 +660,7 @@ export function defineFetcher<TParams extends unknown[], TData>(
         }))
         startInterval(state, def, instance, params, key)
 
-        // Defer the fetch decision off the subscribe call stack (see the
-        // `delay(0)` precedent in the legacy fetcher store) to avoid a
+        // Defer the fetch decision off the subscribe call stack to avoid a
         // re-entrant cache write during subscription setup.
         queueMicrotask(() => {
           const entry = state.get().entries[key]

package/src/users/reducers.test.ts

@@ -25,9 +25,6 @@ describe('Users Reducers', () => {
     isDisposed: () => false,
     dispose: () => {},
     onDispose: () => () => {},
-    getParent: () => undefined,
-    createChild: (_config) => mockInstance,
-    match: () => undefined,
   }
 
   const sampleOptions: GetUsersOptions = {