@sanity/sdk 2.8.0 → 3.0.0-rc.0

package/src/store/createSanityInstance.test.ts

@@ -5,14 +5,14 @@ import {createSanityInstance} from './createSanityInstance'
 
 describe('createSanityInstance', () => {
   it('should create an instance with a unique instanceId and given config', () => {
-    const instance = createSanityInstance({projectId: 'proj1', dataset: 'ds1'})
+    const instance = createSanityInstance()
     expect(typeof instance.instanceId).toBe('string')
-    expect(instance.config).toEqual({projectId: 'proj1', dataset: 'ds1'})
+    expect(instance.config).toEqual({})
     expect(instance.isDisposed()).toBe(false)
   })
 
   it('should dispose an instance and call onDispose callbacks', () => {
-    const instance = createSanityInstance({projectId: 'proj1', dataset: 'ds1'})
+    const instance = createSanityInstance()
     const callback = vi.fn()
     instance.onDispose(callback)
     instance.dispose()
@@ -21,7 +21,7 @@ describe('createSanityInstance', () => {
   })
 
   it('should not call onDispose callbacks more than once when disposed multiple times', () => {
-    const instance = createSanityInstance({projectId: 'proj1', dataset: 'ds1'})
+    const instance = createSanityInstance()
     const callback = vi.fn()
     instance.onDispose(callback)
     instance.dispose()
@@ -29,60 +29,6 @@ describe('createSanityInstance', () => {
     expect(callback).toHaveBeenCalledTimes(1)
   })
 
-  it('should create a child instance with merged config and correct parent', () => {
-    const parent = createSanityInstance({projectId: 'proj1', dataset: 'ds1'})
-    const child = parent.createChild({dataset: 'ds2'})
-    expect(child.config).toEqual({projectId: 'proj1', dataset: 'ds2'})
-    expect(child.getParent()).toBe(parent)
-  })
-
-  it('should match an instance in the hierarchy using match', () => {
-    // three-level hierarchy
-    const grandparent = createSanityInstance({projectId: 'proj1', dataset: 'ds1'})
-    const parent = grandparent.createChild({projectId: 'proj2'})
-    const child = parent.createChild({dataset: 'ds2'})
-
-    expect(child.config).toEqual({projectId: 'proj2', dataset: 'ds2'})
-    expect(parent.config).toEqual({projectId: 'proj2', dataset: 'ds1'})
-
-    expect(child.match({dataset: 'ds2'})).toBe(child)
-    expect(child.match({projectId: 'proj2'})).toBe(child)
-    expect(child.match({projectId: 'proj1'})).toBe(grandparent)
-    expect(parent.match({projectId: 'proj1'})).toBe(grandparent)
-    expect(grandparent.match({projectId: 'proj1'})).toBe(grandparent)
-  })
-
-  it('should match `undefined` when the desired resource ID should not be set on an instance', () => {
-    const noProjectOrDataset = createSanityInstance()
-    const noDataset = noProjectOrDataset.createChild({projectId: 'proj1'})
-    const leaf = noDataset.createChild({dataset: 'ds1'})
-
-    // no keys means anything (in this case, self) will match
-    expect(leaf.match({})).toBe(leaf)
-
-    // `[resourceId]: undefined` means match an instance with no dataset set
-    expect(leaf.match({dataset: undefined})).toBe(noDataset)
-    expect(noDataset.match({dataset: undefined})).toBe(noDataset)
-    expect(leaf.match({projectId: undefined})).toBe(noProjectOrDataset)
-    expect(noDataset.match({projectId: undefined})).toBe(noProjectOrDataset)
-    expect(noProjectOrDataset.match({projectId: undefined})).toBe(noProjectOrDataset)
-  })
-
-  it('should return undefined when no match is found', () => {
-    const instance = createSanityInstance({projectId: 'proj1', dataset: 'ds1'})
-    expect(instance.match({dataset: 'non-existent'})).toBeUndefined()
-  })
-
-  it('should inherit and merge auth config', () => {
-    const parent = createSanityInstance({
-      projectId: 'proj1',
-      dataset: 'ds1',
-      auth: {apiHost: 'api.sanity.work'},
-    })
-    const child = parent.createChild({auth: {token: 'my-token'}})
-    expect(child.config.auth).toEqual({apiHost: 'api.sanity.work', token: 'my-token'})
-  })
-
   describe('logging', () => {
     const mockHandler: LogHandler = {
       error: vi.fn(),
@@ -106,31 +52,30 @@ describe('createSanityInstance', () => {
     })
 
     it('should log instance creation at info level', () => {
-      createSanityInstance({projectId: 'test-proj', dataset: 'test-ds'})
+      createSanityInstance()
 
       expect(mockHandler.info).toHaveBeenCalledWith(
         expect.stringContaining('[INFO] [sdk]'),
         expect.objectContaining({
-          hasProjectId: true,
-          hasDataset: true,
+          hasAuth: false,
+          hasPerspective: false,
         }),
       )
     })
 
     it('should log configuration details at debug level', () => {
-      createSanityInstance({projectId: 'test-proj', dataset: 'test-ds'})
+      createSanityInstance({defaultResource: {projectId: 'test-proj', dataset: 'test-dataset'}})
 
       expect(mockHandler.debug).toHaveBeenCalledWith(
         expect.stringContaining('[DEBUG] [sdk]'),
         expect.objectContaining({
-          projectId: 'test-proj',
-          dataset: 'test-ds',
+          hasStudioConfig: false,
         }),
       )
     })
 
     it('should log instance disposal', () => {
-      const instance = createSanityInstance({projectId: 'test-proj'})
+      const instance = createSanityInstance()
       vi.clearAllMocks() // Clear creation logs
 
       instance.dispose()
@@ -141,26 +86,11 @@ describe('createSanityInstance', () => {
       )
     })
 
-    it('should log child instance creation at debug level', () => {
-      const parent = createSanityInstance({projectId: 'parent-proj'})
-      vi.clearAllMocks() // Clear parent creation logs
-
-      parent.createChild({dataset: 'child-ds'})
-
-      expect(mockHandler.debug).toHaveBeenCalledWith(
-        expect.stringContaining('Creating child instance'),
-        expect.objectContaining({
-          overridingDataset: true,
-        }),
-      )
-    })
-
-    it('should include instance context in logs', () => {
-      createSanityInstance({projectId: 'my-project', dataset: 'my-dataset'})
+    it('should include instance id in logs', () => {
+      createSanityInstance()
 
-      // Check that logs include the instance context (project and dataset)
       expect(mockHandler.info).toHaveBeenCalledWith(
-        expect.stringMatching(/\[project:my-project\].*\[dataset:my-dataset\]/),
+        expect.stringMatching(/\[instance:/),
         expect.anything(),
       )
     })

package/src/store/createSanityInstance.ts

@@ -1,12 +1,9 @@
-import {pick} from 'lodash-es'
-
 import {type SanityConfig} from '../config/sanityConfig'
 import {insecureRandomId} from '../utils/ids'
 import {createLogger, type InstanceContext} from '../utils/logger'
 
 /**
- * Represents a Sanity.io resource instance with its own configuration and lifecycle
- * @remarks Instances form a hierarchy through parent/child relationships
+ * Represents a Sanity.io resource instance with its own configuration and lifecycle.
  *
  * @public
  */
@@ -17,10 +14,7 @@ export interface SanityInstance {
    */
   readonly instanceId: string
 
-  /**
-   * Resolved configuration for this instance
-   * @remarks Merges values from parent instances where appropriate
-   */
+  /** Resolved configuration for this instance */
   readonly config: SanityConfig
 
   /**
@@ -41,34 +35,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
-   */
-  getParent(): SanityInstance | undefined
-
-  /**
-   * Creates a child instance with merged configuration
-   * @param config - Configuration to merge with parent values
-   * @remarks Child instances inherit parent configuration but can override values
-   */
-  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.
-   */
-  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
  */
@@ -77,32 +49,21 @@ export function createSanityInstance(config: SanityConfig = {}): SanityInstance
   const disposeListeners = new Map<string, () => void>()
   const disposed = {current: false}
 
-  // Create instance context for logging
   const instanceContext: InstanceContext = {
     instanceId,
-    projectId: config.projectId,
-    dataset: config.dataset,
   }
 
-  // Create logger with instance context
   const logger = createLogger('sdk', {instanceContext})
 
-  // Log instance creation
   logger.info('Sanity instance created', {
-    hasProjectId: !!config.projectId,
-    hasDataset: !!config.dataset,
     hasAuth: !!config.auth,
     hasPerspective: !!config.perspective,
   })
 
-  // Log configuration details at debug level
   logger.debug('Instance configuration', {
-    projectId: config.projectId,
-    dataset: config.dataset,
     perspective: config.perspective,
     hasStudioConfig: !!config.studio,
     hasStudioTokenSource: !!config.studio?.auth?.token,
-    legacyStudioMode: config.studioMode?.enabled,
     hasAuthProviders: !!config.auth?.providers,
     hasAuthToken: !!config.auth?.token,
   })
@@ -132,43 +93,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(pick(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.test.ts

@@ -14,7 +14,7 @@ describe('createStateSourceAction', () => {
   let instance: SanityInstance
 
   beforeEach(() => {
-    instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    instance = createSanityInstance()
     state = createStoreState({count: 0, items: [] as string[]}, {name: 'test-store'})
   })
 
@@ -179,7 +179,7 @@ describe('createStateSourceAction', () => {
 
   // New test: distinct contexts for same state with different instance
   it('should create distinct contexts for same state with different instance', () => {
-    const secondInstance = createSanityInstance({projectId: 'test2', dataset: 'test2'})
+    const secondInstance = createSanityInstance()
     const selector = vi.fn(({state: s}: SelectorContext<CountStoreState>) => s.count)
 
     const source1 = createStateSourceAction(selector)({state, instance, key: null})

package/src/store/createStateSourceAction.ts

@@ -57,9 +57,9 @@ export interface StateSource<T> {
  * ```ts
  * // Using both state and instance in a selector (psuedo example)
  * const getUserByProjectId = createStateSourceAction(
- *   ({ state, instance }: SelectorContext<UsersState>, options?: ProjectHandle) => {
+ *   ({ state, instance }: SelectorContext<UsersState>, options?: ResourceHandle) => {
  *     const allUsers = state.users
- *     const projectId = options?.projectId ?? instance.config.projectId
+ *     const projectId = options?.projectId ?? instance.config.defaultResource?.projectId
  *     return allUsers.filter(user => user.projectId === projectId)
  *   }
  * )
@@ -155,13 +155,13 @@ interface StateSourceOptions<TState, TParams extends unknown[], TReturn, TKey> {
  *   // ...
  * })
  *
- * const getDocument = bindActionByDataset(
+ * const getDocument = bindActionByResource(
  *   documentStore,
- *   createStateSourceAction(({state}, documentId: string) => state.documents[documentId])
+ *   createStateSourceAction(({state}, _options, documentId: string) => state.documents[documentId])
  * )
  *
  * // Usage
- * const documentSource = getDocument(sanityInstance, 'doc123')
+ * const documentSource = getDocument(sanityInstance, {}, 'doc123')
  * const doc = documentSource.getCurrent()
  * const subscription = documentSource.observable.subscribe(updatedDoc => {
  *   console.log('Document changed:', updatedDoc)

package/src/store/createStoreInstance.test.ts

@@ -13,14 +13,12 @@ describe('createStoreInstance', () => {
       randomUUID: () => 'test-uuid-1234',
     })
 
-    instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    instance = createSanityInstance()
   })
 
   const storeDef: StoreDefinition<{count: number}> = {
     name: 'TestStore',
-    getInitialState: (inst) => ({
-      count: inst.config.projectId === 'test' ? 0 : -1,
-    }),
+    getInitialState: () => ({count: 0}),
   }
 
   it('should create store instance with initial state', () => {

package/src/users/reducers.test.ts

@@ -19,15 +19,10 @@ describe('Users Reducers', () => {
   // Mock SanityInstance for testing
   const mockInstance: SanityInstance = {
     instanceId: 'test-instance-id',
-    config: {
-      projectId: 'test-project-id',
-    },
+    config: {},
     isDisposed: () => false,
     dispose: () => {},
     onDispose: () => () => {},
-    getParent: () => undefined,
-    createChild: (_config) => mockInstance,
-    match: () => undefined,
   }
 
   const sampleOptions: GetUsersOptions = {

package/src/users/reducers.ts

@@ -6,12 +6,12 @@ import {DEFAULT_USERS_BATCH_SIZE} from './usersConstants'
 
 /** @internal */
 export const getUsersKey = (
-  instance: SanityInstance,
+  _instance: SanityInstance,
   {
     resourceType,
     organizationId,
     batchSize = DEFAULT_USERS_BATCH_SIZE,
-    projectId = instance.config.projectId,
+    projectId,
     userId,
   }: GetUsersOptions = {},
 ): string =>

package/src/users/types.ts

@@ -1,5 +1,3 @@
-import {type ProjectHandle} from '../config/sanityConfig'
-
 /**
  * @public
  */
@@ -42,7 +40,8 @@ export interface UserProfile {
 /**
  * @public
  */
-export interface GetUsersOptions extends ProjectHandle {
+export interface GetUsersOptions {
+  projectId?: string
   resourceType?: 'organization' | 'project'
   batchSize?: number
   organizationId?: string
@@ -88,7 +87,8 @@ export interface ResolveUsersOptions extends GetUsersOptions {
 /**
  * @public
  */
-export interface GetUserOptions extends ProjectHandle {
+export interface GetUserOptions {
+  projectId?: string
   userId: string
   resourceType?: 'organization' | 'project'
   organizationId?: string

package/src/users/usersStore.test.ts

@@ -87,7 +87,7 @@ describe('usersStore', () => {
   })
 
   it('initializes users state and cleans up after unsubscribe', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const state = getUsersState(instance, {
       resourceType: 'project',
       projectId: 'project1',
@@ -122,7 +122,7 @@ describe('usersStore', () => {
   })
 
   it('maintains state when multiple subscribers exist', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const state = getUsersState(instance, {
       resourceType: 'project',
       projectId: 'project1',
@@ -165,7 +165,7 @@ describe('usersStore', () => {
   })
 
   it('resolveUsers works without affecting subscriber cleanup', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const options: GetUsersOptions = {resourceType: 'project', projectId: 'project1'}
 
     const state = getUsersState(instance, options)
@@ -198,7 +198,7 @@ describe('usersStore', () => {
   })
 
   it('handles abort signal in resolveUsers', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const options: GetUsersOptions = {resourceType: 'project', projectId: 'project1'}
     const abortController = new AbortController()
 
@@ -221,7 +221,7 @@ describe('usersStore', () => {
   })
 
   it('loads more users when loadMoreUsers is called', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const options: GetUsersOptions = {resourceType: 'project', projectId: 'project1'}
 
     // First response has nextCursor
@@ -291,7 +291,7 @@ describe('usersStore', () => {
   })
 
   it('throws error when loadMoreUsers is called without initial data', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
 
     // Expect loadMoreUsers to throw when no data is loaded
     await expect(
@@ -302,7 +302,7 @@ describe('usersStore', () => {
   })
 
   it('throws error when loadMoreUsers is called with no more data available', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const options: GetUsersOptions = {resourceType: 'project', projectId: 'project1'}
 
     // Response with no nextCursor
@@ -325,7 +325,7 @@ describe('usersStore', () => {
   })
 
   it('handles errors in users fetching', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const errorMessage = 'Failed to fetch users'
 
     // Override request to simulate error
@@ -351,7 +351,7 @@ describe('usersStore', () => {
   })
 
   it('delays users state removal after unsubscribe', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const options: GetUsersOptions = {resourceType: 'project', projectId: 'project1'}
     const state = getUsersState(instance, options)
     const unsubscribe = state.subscribe()
@@ -370,7 +370,7 @@ describe('usersStore', () => {
   })
 
   it('preserves users state if a new subscriber subscribes before cleanup delay', async () => {
-    const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+    const instance = createSanityInstance()
     const state = getUsersState(instance, {
       resourceType: 'project',
       projectId: 'project1',
@@ -412,7 +412,7 @@ describe('usersStore', () => {
     })
 
     it('fetches a single user with a project-scoped ID', async () => {
-      const instance = createSanityInstance({projectId: 'test', dataset: 'test'})
+      const instance = createSanityInstance()
       const projectUserId = 'p12345'
       const mockProjectUser: PatchedSanityUserFromClient = {
         id: projectUserId,
@@ -476,10 +476,7 @@ describe('usersStore', () => {
     })
 
     it('fetches a single user with a global-scoped ID', async () => {
-      const instance = createSanityInstance({
-        projectId: 'test',
-        dataset: 'test',
-      })
+      const instance = createSanityInstance()
       const globalUserId = 'g12345'
       const mockGlobalUser: SanityUser = {
         sanityUserId: globalUserId,

package/src/utils/createFetcherStore.test.ts

@@ -9,7 +9,7 @@ describe('createFetcherStore', () => {
   let instance: SanityInstance
 
   beforeEach(() => {
-    instance = createSanityInstance({projectId: 'p', dataset: 'd'})
+    instance = createSanityInstance()
     vi.useRealTimers()
   })
 

package/src/utils/logger.test.ts

@@ -644,7 +644,6 @@ describe('logger', () => {
         instanceContext: {
           instanceId: 'abc123def456',
           projectId: 'my-project',
-          dataset: 'production',
         },
       })
 
@@ -654,10 +653,6 @@ describe('logger', () => {
         expect.stringContaining('[project:my-project]'),
         expect.any(Object),
       )
-      expect(mockHandler.info).toHaveBeenCalledWith(
-        expect.stringContaining('[dataset:production]'),
-        expect.any(Object),
-      )
       expect(mockHandler.info).toHaveBeenCalledWith(
         expect.stringContaining('[instance:abc123de]'), // Truncated to 8 chars
         expect.any(Object),
@@ -694,7 +689,6 @@ describe('logger', () => {
       const logger = createLogger('query', {
         instanceContext: {
           projectId: 'my-project',
-          // No dataset or instanceId
         },
       })
 
@@ -704,17 +698,12 @@ describe('logger', () => {
         expect.stringContaining('[project:my-project]'),
         expect.any(Object),
       )
-      expect(mockHandler.info).not.toHaveBeenCalledWith(
-        expect.stringContaining('[dataset:'),
-        expect.any(Object),
-      )
     })
 
     it('should return instance context', () => {
       const instanceContext = {
         instanceId: 'test-instance',
         projectId: 'test-project',
-        dataset: 'test-dataset',
       }
 
       const logger = createLogger('auth', {instanceContext})
@@ -738,7 +727,6 @@ describe('logger', () => {
       const logger = createLogger('document', {
         instanceContext: {
           projectId: 'my-project',
-          dataset: 'production',
         },
       })
 

package/src/utils/logger.ts

@@ -153,9 +153,9 @@ export interface LogContext {
 export interface InstanceContext {
   /** Unique instance ID */
   instanceId?: string
-  /** Project ID */
+  /** Project ID (derived from default resource) */
   projectId?: string
-  /** Dataset name */
+  /** Dataset name (derived from default resource) */
   dataset?: string
 }
 
@@ -520,14 +520,9 @@ function logRxJSOperator(namespace: string, operator: string, context?: LogConte
  * @internal
  */
 /* c8 ignore next 7 */
-function getInstanceContext(instance: {
-  instanceId?: string
-  config?: {projectId?: string; dataset?: string}
-}): InstanceContext {
+function getInstanceContext(instance: {instanceId?: string}): InstanceContext {
   return {
     instanceId: instance.instanceId,
-    projectId: instance.config?.projectId,
-    dataset: instance.config?.dataset,
   }
 }