@sanity/sdk 3.0.0-rc.1 → 3.0.0

package/src/preview/getPreviewState.ts

@@ -1,69 +0,0 @@
-import {map} from 'rxjs'
-
-import {type DocumentHandle} from '../config/sanityConfig'
-import {getProjectionState} from '../projection/getProjectionState'
-import {type SanityInstance} from '../store/createSanityInstance'
-import {type StateSource} from '../store/createStateSourceAction'
-import {PREVIEW_PROJECTION} from './previewConstants'
-import {transformProjectionToPreview} from './previewProjectionUtils'
-import {type PreviewQueryResult, type PreviewValue, type ValuePending} from './types'
-
-/**
- * @beta
- * @deprecated This type is deprecated and will be removed in a future release.
- */
-export type GetPreviewStateOptions = DocumentHandle
-
-/**
- * @beta
- * @deprecated This function is deprecated and will be removed in a future release.
- */
-export function getPreviewState<TResult extends object>(
-  instance: SanityInstance,
-  options: GetPreviewStateOptions,
-): StateSource<ValuePending<TResult>>
-/**
- * @beta
- * @deprecated This function is deprecated and will be removed in a future release.
- */
-export function getPreviewState(
-  instance: SanityInstance,
-  options: GetPreviewStateOptions,
-): StateSource<ValuePending<PreviewValue>>
-/**
- * @beta
- * @deprecated This function is deprecated and will be removed in a future release.
- */
-export function getPreviewState(
-  instance: SanityInstance,
-  options: GetPreviewStateOptions,
-): StateSource<ValuePending<PreviewValue>> {
-  // Get the projection state
-  const projectionState = getProjectionState<PreviewQueryResult>(instance, {
-    ...options,
-    projection: PREVIEW_PROJECTION,
-  })
-
-  // Transform helper to convert projection result to preview format
-  const transformResult = (
-    current: ReturnType<typeof projectionState.getCurrent>,
-  ): ValuePending<PreviewValue> => {
-    if (!current || current.data === null) {
-      return {data: null, isPending: current?.isPending ?? false}
-    }
-
-    const previewValue = transformProjectionToPreview(instance, current.data, options.resource)
-
-    return {
-      data: previewValue,
-      isPending: current.isPending,
-    }
-  }
-
-  // Wrap the state source to transform projection results to preview format
-  return {
-    getCurrent: () => transformResult(projectionState.getCurrent()),
-    subscribe: (callback) => projectionState.subscribe(callback),
-    observable: projectionState.observable.pipe(map(transformResult)),
-  }
-}

package/src/preview/resolvePreview.test.ts

@@ -1,64 +0,0 @@
-import {beforeEach, describe, expect, it, vi} from 'vitest'
-
-import {resolveProjection} from '../projection/resolveProjection'
-import {type ProjectionValuePending} from '../projection/types'
-import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
-import {resolvePreview} from './resolvePreview'
-import {type PreviewQueryResult} from './types'
-
-vi.mock('../projection/resolveProjection')
-
-describe('resolvePreview', () => {
-  let instance: SanityInstance
-  beforeEach(() => {
-    vi.clearAllMocks()
-    instance = createSanityInstance({projectId: 'p', dataset: 'd'})
-  })
-
-  afterEach(() => {
-    instance.dispose()
-  })
-
-  it('resolves and transforms projection result to preview format', async () => {
-    const mockProjectionResult: PreviewQueryResult = {
-      _id: 'doc1',
-      _type: 'article',
-      _updatedAt: '2024-01-01',
-      titleCandidates: {title: 'Resolved Title'},
-      subtitleCandidates: {description: 'Resolved Description'},
-      media: null,
-    }
-
-    vi.mocked(resolveProjection).mockResolvedValue({
-      data: mockProjectionResult,
-      isPending: false,
-    } as ProjectionValuePending<PreviewQueryResult>)
-
-    const result = await resolvePreview(instance, {
-      documentId: 'doc1',
-      documentType: 'article',
-    })
-
-    expect(result.data).toEqual({
-      title: 'Resolved Title',
-      subtitle: 'Resolved Description',
-      media: null,
-    })
-    expect(result.isPending).toBe(false)
-  })
-
-  it('returns null data when projection resolves with null', async () => {
-    vi.mocked(resolveProjection).mockResolvedValue({
-      data: null,
-      isPending: false,
-    })
-
-    const result = await resolvePreview(instance, {
-      documentId: 'doc1',
-      documentType: 'article',
-    })
-
-    expect(result.data).toBeNull()
-    expect(result.isPending).toBe(false)
-  })
-})

package/src/preview/resolvePreview.ts

@@ -1,43 +0,0 @@
-import {type DocumentHandle} from '../config/sanityConfig'
-import {resolveProjection} from '../projection/resolveProjection'
-import {type SanityInstance} from '../store/createSanityInstance'
-import {PREVIEW_PROJECTION} from './previewConstants'
-import {transformProjectionToPreview} from './previewProjectionUtils'
-import {type PreviewQueryResult, type PreviewValue, type ValuePending} from './types'
-
-/**
- * @beta
- * @deprecated This type is deprecated and will be removed in a future release.
- */
-export type ResolvePreviewOptions = DocumentHandle
-
-/**
- * @beta
- * @deprecated This function is deprecated and will be removed in a future release.
- */
-export async function resolvePreview(
-  instance: SanityInstance,
-  options: ResolvePreviewOptions,
-): Promise<ValuePending<PreviewValue>> {
-  // Resolve the projection
-  const projectionResult = await resolveProjection<PreviewQueryResult>(instance, {
-    ...options,
-    projection: PREVIEW_PROJECTION,
-  })
-
-  if (!projectionResult.data) {
-    return {data: null, isPending: projectionResult.isPending}
-  }
-
-  // Transform to preview format
-  const previewValue = transformProjectionToPreview(
-    instance,
-    projectionResult.data,
-    options.resource,
-  )
-
-  return {
-    data: previewValue,
-    isPending: projectionResult.isPending,
-  }
-}

package/src/utils/createFetcherStore.test.ts

@@ -1,171 +0,0 @@
-import {delay, firstValueFrom, of, throwError} from 'rxjs'
-import {filter, skip} from 'rxjs/operators'
-import {beforeEach, describe, expect, it, vi} from 'vitest'
-
-import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
-import {createFetcherStore} from './createFetcherStore'
-
-describe('createFetcherStore', () => {
-  let instance: SanityInstance
-
-  beforeEach(() => {
-    instance = createSanityInstance({projectId: 'p', dataset: 'd'})
-    vi.useRealTimers()
-  })
-
-  afterEach(() => {
-    instance.dispose()
-  })
-
-  it('should fetch data and update state when subscribed', async () => {
-    const store = createFetcherStore({
-      name: 'test',
-      fetcher: () => (param: number) => of(`data-${param}`).pipe(delay(100)),
-      getKey: (_instance, param: number) => `key-${param}`,
-    })
-
-    const stateSource = store.getState(instance, 1)
-    const dataPromise = firstValueFrom(
-      stateSource.observable.pipe(filter((data) => data !== undefined)),
-    )
-
-    vi.useFakeTimers()
-    await vi.advanceTimersByTimeAsync(100)
-    const data = await dataPromise
-    expect(data).toBe('data-1')
-    vi.useRealTimers()
-
-    expect(stateSource.getCurrent()).toBe('data-1')
-  })
-
-  it('should only fetch once for multiple subscriptions within throttle interval', async () => {
-    const fetchSpy = vi.fn().mockImplementation((param: number) => of(`data-${param}`))
-    const store = createFetcherStore({
-      name: 'test-throttle',
-      fetcher: () => fetchSpy,
-      getKey: (_instance, param: number) => `key-${param}`,
-      fetchThrottleInternal: 1000,
-    })
-
-    const stateSource = store.getState(instance, 1)
-    const sub1 = stateSource.subscribe()
-    const sub2 = stateSource.subscribe()
-
-    await firstValueFrom(stateSource.observable)
-    expect(fetchSpy).toHaveBeenCalledTimes(1)
-
-    sub1()
-    sub2()
-  })
-
-  it('should propagate errors correctly', async () => {
-    const store = createFetcherStore({
-      name: 'test-error',
-      fetcher: () => () => throwError(() => new Error('test error')),
-      getKey: () => 'key',
-    })
-
-    const stateSource = store.getState(instance)
-    const dataPromise = firstValueFrom(
-      stateSource.observable.pipe(
-        // the first value will be `undefined` since the store is not populated
-        skip(1),
-      ),
-    )
-
-    await expect(dataPromise).rejects.toThrow()
-    expect(() => stateSource.getCurrent()).toThrow()
-  })
-
-  it('should clear state after expiration delay', async () => {
-    const fetchSpy = vi
-      .fn()
-      .mockImplementation((param: number) => of(`data-${param}`).pipe(delay(100)))
-    const store = createFetcherStore({
-      name: 'test-expiration',
-      fetcher: () => fetchSpy,
-      getKey: (_instance, param: number) => `key-${param}`,
-      stateExpirationDelay: 1000,
-    })
-
-    // First subscription
-    const stateSource1 = store.getState(instance, 1)
-    const sub1 = stateSource1.subscribe()
-    await firstValueFrom(stateSource1.observable.pipe(filter((data) => data !== undefined)))
-    expect(fetchSpy).toHaveBeenCalledTimes(1)
-
-    sub1()
-
-    // Wait for expiration delay
-    vi.useFakeTimers()
-    await vi.advanceTimersByTimeAsync(1000)
-
-    // Second subscription
-    const stateSource2 = store.getState(instance, 1)
-    const sub2 = stateSource2.subscribe()
-    await firstValueFrom(stateSource2.observable.pipe(filter((data) => data !== undefined)))
-    expect(fetchSpy).toHaveBeenCalledTimes(2)
-
-    sub2()
-    vi.useRealTimers()
-  })
-
-  it('should throttle fetches based on fetchThrottleInternal', async () => {
-    const fetchSpy = vi.fn().mockImplementation((param: number) => of(`data-${param}`))
-    const store = createFetcherStore({
-      name: 'test-throttle',
-      fetcher: () => fetchSpy,
-      getKey: (_instance, param: number) => `key-${param}`,
-      fetchThrottleInternal: 1000,
-    })
-
-    const stateSource = store.getState(instance, 1)
-
-    // First subscription
-    const sub1 = stateSource.subscribe()
-    await firstValueFrom(stateSource.observable)
-    expect(fetchSpy).toHaveBeenCalledTimes(1)
-
-    // Second subscription within throttle interval
-    const stateSource2 = store.getState(instance, 1)
-    const sub2 = stateSource2.subscribe()
-    await firstValueFrom(stateSource2.observable)
-    expect(fetchSpy).toHaveBeenCalledTimes(1)
-
-    // Advance past throttle interval
-    vi.useFakeTimers()
-    await vi.advanceTimersByTimeAsync(1000)
-
-    // Third subscription after throttle interval
-    const stateSource3 = store.getState(instance, 1)
-    const sub3 = stateSource3.subscribe()
-    await firstValueFrom(stateSource3.observable)
-    expect(fetchSpy).toHaveBeenCalledTimes(2)
-
-    sub1()
-    sub2()
-    sub3()
-    vi.useRealTimers()
-  })
-
-  it('should handle different parameters with different keys', async () => {
-    const store = createFetcherStore({
-      name: 'test-params',
-      fetcher: () => (param: number) => of(`data-${param}`),
-      getKey: (_instance, param: number) => `key-${param}`,
-    })
-
-    const stateSource1 = store.getState(instance, 1)
-    const stateSource2 = store.getState(instance, 2)
-
-    const data1 = await firstValueFrom(
-      stateSource1.observable.pipe(filter((data) => data !== undefined)),
-    )
-    const data2 = await firstValueFrom(
-      stateSource2.observable.pipe(filter((data) => data !== undefined)),
-    )
-
-    expect(data1).toBe('data-1')
-    expect(data2).toBe('data-2')
-  })
-})

package/src/utils/createFetcherStore.ts

@@ -1,284 +0,0 @@
-import {asapScheduler, EMPTY, firstValueFrom, from, Observable} from 'rxjs'
-import {
-  catchError,
-  delay,
-  filter,
-  first,
-  groupBy,
-  map,
-  mergeMap,
-  pairwise,
-  startWith,
-  switchMap,
-  tap,
-} from 'rxjs/operators'
-
-import {bindActionGlobally, type BoundStoreAction} from '../store/createActionBinder'
-import {type SanityInstance} from '../store/createSanityInstance'
-import {
-  createStateSourceAction,
-  type SelectorContext,
-  type StateSource,
-} from '../store/createStateSourceAction'
-import {defineStore, type StoreContext} from '../store/defineStore'
-import {insecureRandomId} from '../utils/ids'
-import {omitProperty} from '../utils/object'
-import {setCleanupTimeout} from './setCleanupTimeout'
-
-interface CreateFetcherStoreOptions<TParams extends unknown[], TData> {
-  /**
-   * A unique name for this store (for devtools)
-   */
-  name: string
-  /**
-   * A function that creates the observable that will be used to fetch the data.
-   */
-  fetcher: (instance: SanityInstance) => (...params: TParams) => Observable<TData>
-  /**
-   * The function used to convert the params into keys that state related to
-   * those params will be stored.
-   */
-  getKey: (instance: SanityInstance, ...params: TParams) => string
-  /**
-   * Delay in ms before clearing state after the last subscription is removed.
-   * This results in react components suspending again due to no previous state
-   * to show.
-   */
-  stateExpirationDelay?: number
-  /**
-   * The minimum time (ms) that must elapse since the last fetch for the same key
-   */
-  fetchThrottleInternal?: number
-}
-
-interface StoreEntry<TParams extends unknown[], TData> {
-  params: TParams
-  instance: SanityInstance
-  key: string
-  data?: TData
-  error?: unknown
-  subscriptions: string[]
-  lastFetchInitiatedAt?: string
-}
-
-/**
- * Internal helper type
- * @public
- */
-export interface FetcherStoreState<TParams extends unknown[], TData> {
-  stateByParams: {[TSerializedKey in string]?: StoreEntry<TParams, TData>}
-  error?: unknown
-}
-
-/**
- * Internal helper type
- * @public
- */
-export interface FetcherStore<TParams extends unknown[], TData> {
-  getState: BoundStoreAction<
-    FetcherStoreState<TParams, TData>,
-    TParams,
-    StateSource<TData | undefined>
-  >
-  resolveState: BoundStoreAction<FetcherStoreState<TParams, TData>, TParams, Promise<TData>>
-}
-
-/**
- * Creates a store from a function that returns an observable that fetches data
- * that supports parameterized state caching.
- *
- * This function creates a resource store keyed by parameter values (using the
- * provided `getKey` function) and returns a state source (via `getState`)
- * that components can subscribe to. When a new subscription is added, and if
- * enough time has passed since the last fetch (controlled by
- * `fetchThrottleInternal`), it invokes the observable factory (via
- * `getObservable`) to fetch fresh data. The data is stored in state and can be
- * accessed reactively.
- *
- * Additionally, the store provides a `resolveState` function that returns a
- * Promise resolving with the next non-undefined value from the state source.
- *
- * State expiration is implemented: after the last subscription for a key is
- * removed, its state is cleared after `stateExpirationDelay` ms, causing
- * components to suspend until fresh data is fetched.
- */
-export function createFetcherStore<TParams extends unknown[], TData>({
-  name,
-  fetcher: getObservable,
-  getKey,
-  fetchThrottleInternal = 1000,
-  stateExpirationDelay = 5000,
-}: CreateFetcherStoreOptions<TParams, TData>): FetcherStore<TParams, TData> {
-  const store = defineStore<FetcherStoreState<TParams, TData>>({
-    name,
-    getInitialState: () => ({
-      stateByParams: {},
-    }),
-    initialize: (context) => {
-      const subscription = subscribeToSubscriptionsAndFetch(context)
-      return () => subscription.unsubscribe()
-    },
-  })
-
-  /**
-   * For each key in state.stateByParams we set up a grouped stream.
-   * When a subscription is added (i.e. the subscriptions array length increases)
-   * and if enough time has elapsed since the last fetch, we update the timestamp
-   * and call the factory function for that key.
-   */
-  const subscribeToSubscriptionsAndFetch = ({
-    state,
-  }: StoreContext<FetcherStoreState<TParams, TData>>) => {
-    return state.observable
-      .pipe(
-        // Map the state to an array of [serialized, entry] pairs.
-        switchMap((s: FetcherStoreState<TParams, TData>) => {
-          const entries = Object.entries(s.stateByParams)
-          return entries.length > 0 ? from(entries) : EMPTY
-        }),
-        // Group by the serialized key.
-        groupBy(([key]) => key),
-        mergeMap((group$) =>
-          group$.pipe(
-            // Emit an initial value for pairwise comparisons.
-            startWith<[string, StoreEntry<TParams, TData> | undefined]>([group$.key, undefined]),
-            pairwise(),
-            // Trigger only when the subscriptions array grows.
-            filter(([[, prevEntry], [, currEntry]]) => {
-              const prevSubs = prevEntry?.subscriptions ?? []
-              const currSubs = currEntry?.subscriptions ?? []
-              return currSubs.length > prevSubs.length
-            }),
-            map(([, [, currEntry]]) => currEntry),
-
-            // Only trigger if we haven't fetched recently.
-            filter((entry) => {
-              const lastFetch = entry?.lastFetchInitiatedAt
-              if (!lastFetch) return true
-              return Date.now() - new Date(lastFetch).getTime() >= fetchThrottleInternal
-            }),
-            switchMap((entry) => {
-              // Retrieve params from the entry
-              if (!entry) return EMPTY
-
-              // Record that a fetch is being initiated.
-              state.set('setLastFetchInitiatedAt', (prev: FetcherStoreState<TParams, TData>) => ({
-                stateByParams: {
-                  ...prev.stateByParams,
-                  [entry.key]: {
-                    ...entry,
-                    ...prev.stateByParams[entry.key],
-                    lastFetchInitiatedAt: new Date().toISOString(),
-                  },
-                },
-              }))
-
-              const factoryFn = getObservable(entry.instance)
-              return factoryFn(...entry.params).pipe(
-                // the `createStateSourceAction` util requires the update
-                // to
-                delay(0, asapScheduler),
-                tap((data: TData) =>
-                  state.set('setData', (prev: FetcherStoreState<TParams, TData>) => ({
-                    stateByParams: {
-                      ...prev.stateByParams,
-                      [entry.key]: {
-                        ...omitProperty(entry, 'error'),
-                        ...(prev.stateByParams[entry.key]
-                          ? omitProperty(prev.stateByParams[entry.key], 'error')
-                          : {}),
-                        data,
-                      },
-                    },
-                  })),
-                ),
-                catchError((error) => {
-                  state.set('setError', (prev) => ({
-                    stateByParams: {
-                      ...prev.stateByParams,
-                      [entry.key]: {
-                        ...entry,
-                        ...prev.stateByParams[entry.key],
-                        error,
-                      },
-                    },
-                  }))
-
-                  return EMPTY
-                }),
-              )
-            }),
-          ),
-        ),
-      )
-      .subscribe({
-        error: (error) => state.set('setError', {error}),
-      })
-  }
-
-  const getState = bindActionGlobally(
-    store,
-    createStateSourceAction({
-      selector: (
-        {
-          instance,
-          state: {stateByParams, error},
-        }: SelectorContext<FetcherStoreState<TParams, TData>>,
-        ...params: TParams
-      ) => {
-        if (error) throw error
-        const key = getKey(instance, ...params)
-        const entry = stateByParams[key]
-        if (entry?.error) throw entry.error
-        return entry?.data
-      },
-      onSubscribe: ({instance, state}, ...params: TParams) => {
-        const subscriptionId = insecureRandomId()
-        const key = getKey(instance, ...params)
-
-        state.set('addSubscription', (prev: FetcherStoreState<TParams, TData>) => ({
-          stateByParams: {
-            ...prev.stateByParams,
-            [key]: {
-              ...prev.stateByParams[key],
-              instance,
-              key,
-              params: prev.stateByParams[key]?.params || params,
-              subscriptions: [...(prev.stateByParams[key]?.subscriptions || []), subscriptionId],
-            },
-          },
-        }))
-
-        return () => {
-          setCleanupTimeout(() => {
-            state.set('removeSubscription', (prev: FetcherStoreState<TParams, TData>) => {
-              const entry = prev.stateByParams[key]
-              if (!entry) return prev
-
-              const newSubs = (entry.subscriptions || []).filter((id) => id !== subscriptionId)
-              if (newSubs.length === 0) {
-                return {stateByParams: omitProperty(prev.stateByParams, key)}
-              }
-
-              return {
-                stateByParams: {
-                  ...prev.stateByParams,
-                  [key]: {
-                    ...entry,
-                    subscriptions: newSubs,
-                  },
-                },
-              }
-            })
-          }, stateExpirationDelay)
-        }
-      },
-    }),
-  )
-
-  const resolveState = bindActionGlobally(store, ({instance}, ...params: TParams) =>
-    firstValueFrom(getState(instance, ...params).observable.pipe(first((i) => i !== undefined))),
-  )
-
-  return {getState, resolveState}
-}