@sanity/client 7.1.0-views.0 → 7.1.0-views.2

package/src/{csm → util}/isRecord.ts

@@ -1,4 +1,4 @@
 /** @internal */
 export function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === 'object' && value !== null
+  return typeof value === 'object' && value !== null && !Array.isArray(value)
 }

package/src/validators.ts

@@ -1,4 +1,4 @@
-import type {Any, InitializedClientConfig} from './types'
+import type {Any, InitializedClientConfig, SanityDocumentStub} from './types'
 
 const VALID_ASSET_TYPES = ['image', 'file']
 const VALID_INSERT_LOCATIONS = ['before', 'after', 'replace']
@@ -43,6 +43,28 @@ export const requireDocumentId = (op: string, doc: Record<string, Any>) => {
   validateDocumentId(op, doc._id)
 }
 
+export const validateDocumentType = (op: string, type: string) => {
+  if (typeof type !== 'string') {
+    throw new Error(`\`${op}()\`: \`${type}\` is not a valid document type`)
+  }
+}
+
+export const requireDocumentType = (op: string, doc: Record<string, Any>) => {
+  if (!doc._type) {
+    throw new Error(`\`${op}()\` requires that the document contains a type (\`_type\` property)`)
+  }
+
+  validateDocumentType(op, doc._type)
+}
+
+export const validateVersionIdMatch = (builtVersionId: string, document: SanityDocumentStub) => {
+  if (document._id && document._id !== builtVersionId) {
+    throw new Error(
+      `The provided document ID (\`${document._id}\`) does not match the generated version ID (\`${builtVersionId}\`)`,
+    )
+  }
+}
+
 export const validateInsert = (at: string, selector: string, items: Any[]) => {
   const signature = 'insert(at, selector, items)'
   if (VALID_INSERT_LOCATIONS.indexOf(at) === -1) {

package/src/views/index.ts

@@ -1,20 +1,42 @@
+import {
+  type QueryParams,
+  type QueryWithoutParams,
+  type ViewOverride,
+  ViewResourceType,
+} from '@sanity/client'
 import {lastValueFrom, Observable} from 'rxjs'
-import {type QueryParams, type QueryWithoutParams} from '@sanity/client'
+
+import {initConfig} from '../config'
+import {_fetch} from '../data/dataMethods'
+import {defineHttpRequest} from '../http/request'
 import type {
+  Any,
+  ClientConfig,
   ClientReturn,
-  RawQueryResponse,
   HttpRequest,
-  QueryOptions,
-  ClientConfig,
-  Any,
+  RawQueryResponse,
+  ViewQueryOptions,
 } from '../types'
-import {_fetch} from '../data/dataMethods'
-import {initConfig} from '../config'
-import {defineHttpRequest} from '../http/request'
+
+/**
+ * Helper function to check if a view has any dataset connections
+ * @internal
+ */
+function hasDatasetConnections(viewId: string, viewOverrides?: ViewOverride[]): boolean {
+  if (!viewOverrides) return false
+
+  const viewOverride = viewOverrides.find((override) => override.resourceId === viewId)
+  if (!viewOverride || !viewOverride.connections.length) return false
+
+  // Check if any connection has dataset resourceType
+  return viewOverride.connections.some((conn) => conn.resourceType === ViewResourceType.Dataset)
+}
 
 /** @public */
-export interface ViewClientConfig extends Omit<ClientConfig, 'dataset' | 'projectId' | 'useCdn' | 'useProjectHostname'> {
-  // TODO: Add our own config options
+export interface ViewClientConfig
+  extends Omit<ClientConfig, 'dataset' | 'projectId' | 'useCdn' | 'useProjectHostname'> {
+  viewOverrides?: ViewOverride[]
+  apiVersion: string
 }
 
 /**
@@ -24,6 +46,16 @@ export interface ViewClientConfig extends Omit<ClientConfig, 'dataset' | 'projec
  * @public
  */
 export function createViewClient(config: ViewClientConfig): ViewClient {
+  // Validate we have the correct view resourceType
+  // Fail early if we don't.
+  if (config.viewOverrides) {
+    config.viewOverrides.forEach((override: ViewOverride) => {
+      if (override.resourceType !== ViewResourceType.View) {
+        throw new Error('View overrides only support resource type "view"')
+      }
+    })
+  }
+
   const clientRequester = defineHttpRequest([])
   return new ViewClient(
     (options, requester) =>
@@ -37,9 +69,6 @@ export function createViewClient(config: ViewClientConfig): ViewClient {
   )
 }
 
-/** @public */
-export type ViewQueryOptions = Pick<QueryOptions, 'perspective' | 'resultSourceMap' | 'filterResponse'>
-
 /** @public */
 export class ViewClient {
   #config: ViewClientConfig
@@ -104,6 +133,15 @@ export class ViewClient {
     params?: Q,
     options?: ViewQueryOptions,
   ): Promise<RawQueryResponse<ClientReturn<G, R>> | ClientReturn<G, R>> {
+    // Check if this view has dataset connections
+    const useEmulate = hasDatasetConnections(viewId, this.#config.viewOverrides)
+
+    // Get connections for this view if using emulate endpoint
+    const viewOverride = this.#config.viewOverrides?.find(
+      (override) => override.resourceId === viewId,
+    )
+    const connections = useEmulate ? viewOverride?.connections || [] : undefined
+
     const cfg = initConfig(
       {
         '~experimental_resource': {
@@ -117,6 +155,8 @@ export class ViewClient {
       returnQuery: false,
       ...options,
       useCdn: true,
+      useEmulate,
+      connections,
     }
 
     return lastValueFrom(_fetch(cfg, this.#httpRequest, {enabled: false}, query, params, opts))
@@ -172,6 +212,15 @@ export class ObservableViewClient {
     params?: Q,
     options?: ViewQueryOptions,
   ): Observable<RawQueryResponse<ClientReturn<G, R>> | ClientReturn<G, R>> {
+    // Check if this view has dataset connections
+    const useEmulateEndpoint = hasDatasetConnections(viewId, this.#config.viewOverrides)
+
+    // Get connections for this view if using emulate endpoint
+    const viewOverride = this.#config.viewOverrides?.find(
+      (override) => override.resourceId === viewId,
+    )
+    const connections = useEmulateEndpoint ? viewOverride?.connections || [] : undefined
+
     const cfg = initConfig(
       {
         '~experimental_resource': {
@@ -181,11 +230,12 @@ export class ObservableViewClient {
       },
       this.#config,
     )
-    const opts: QueryOptions = {
+    const opts = {
       returnQuery: false,
       ...options,
       useCdn: true,
-      perspective: 'published',
+      useEmulate: useEmulateEndpoint,
+      connections,
     }
 
     return _fetch(cfg, this.#httpRequest, {enabled: false}, query, params, opts)