feat(views): implement dev mode

[danielgroves]

Add dev mode to views client:

Outbound requests need to look something like this:

POST /v2025-01-01/views/my-view-id/emulate?returnQuery=false HTTP/1.1
Host: apicdn.sanity.url
Content-Type: application/json
Accept: application/json

{
  "query": "*[_type == \"article\" && category == $cat]",
  "params": {
    "cat": "technology"
  },
  "connections": [
    {
      "query": "*[_type == \"document\"]",
      "resourceType": "dataset",
      "resourceId": "project123.dataset456"
    }
  ]
}

We make the request by calling the views client like this:

import { createViewClient, ViewResourceType } from '@sanity/client/views'

const client = createViewClient({
  apiVersion: '2025-01-01',
  viewOverrides: [
    {
      id: 'my-view-id',
      connections: [
        {
          query: '*[_type == "document"]',
          resourceType: ViewResourceType.Dataset,
          resourceId: 'project123.dataset456'
        }
      ]
    }
  ]
})

// This automatically uses the emulate endpoint because dataset connections are detected
const result = await client.fetch(
  'my-view-id', 
  '*[_type == "article" && category == $cat]',
  { cat: 'technology' }
)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
tsdocs-client	⬜️ Ignored (Inspect)			Jun 16, 2025 10:42am

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	88.3%	3671 / 4157
🔵	Statements	88.3%	3671 / 4157
🔵	Functions	88.01%	301 / 342
🔵	Branches	89.68%	1078 / 1202

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
src/SanityClient.ts	65.65%	97.95%	57.44%	65.65%	108-109, 140-151, 212-224, 233-237, 249-253, 311-328, 386-402, 460-471, 558-585, 692-703, 734-747, 831-856, 880-892, 950-961, 998-999, 1007-1010, 1019-1023, 1041-1042, 1051-1052, 2060-2063
src/config.ts	88.57%	88.57%	100%	88.57%	27-28, 53, 69-71, 96-97, 99-100, 104, 106-109, 138
src/types.ts	100%	100%	100%	100%
src/data/dataMethods.ts	98.18%	95.37%	100%	98.18%	113, 481, 690-692, 730-731, 738-739, 756
src/datasets/DatasetsClient.ts	85.33%	100%	69.23%	85.33%	24-25, 34-35, 43-44, 50-54
src/projects/ProjectsClient.ts	77.27%	100%	75%	77.27%	27-31, 39-43
src/releases/ReleasesClient.ts	100%	100%	100%	100%
src/users/UsersClient.ts	80%	100%	83.33%	80%	22-29
src/views/index.ts	100%	92.85%	100%	100%

Generated in workflow #3479 for commit 096e554 by the Vitest Coverage Report Action

[mwain]

this seems like a new concept to expose, is there any other way?

[danielgroves]

Just tyring to keep the conventions in the right direction for consistency everywhere.

The existing client makes assumptions about the resoure type, which we could do, but in my opinion with a new client we shouldn't be afraid to move in the target direction.

sanityClient({
  projectId: xxxx,
  dataset: xxxx
})

We could follow that here too, but to me that just feels like we're intentionally adding something to fix later.