@sanity/sdk 3.0.0-rc.0 → 3.0.0-rc.2

package/package.json

@@ -1,96 +1,91 @@
 {
   "name": "@sanity/sdk",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.0-rc.2",
   "private": false,
   "description": "Sanity SDK",
   "keywords": [
-    "sanity",
-    "sdk",
-    "content operating system",
     "cms",
+    "content",
+    "content operating system",
     "headless",
     "realtime",
-    "content"
+    "sanity",
+    "sdk"
   ],
   "homepage": "https://github.com/sanity-io/sdk/tree/main/packages/core/README.md",
   "bugs": {
     "url": "https://github.com/sanity-io/sdk/issues"
   },
+  "license": "MIT",
+  "author": "Sanity <developers@sanity.io>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sanity-io/sdk.git",
     "directory": "packages/core"
   },
-  "license": "MIT",
-  "author": "Sanity <developers@sanity.io>",
-  "sideEffects": false,
-  "type": "module",
-  "exports": {
-    ".": {
-      "source": "./src/_exports/index.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "files": [
     "dist",
     "src"
   ],
-  "browserslist": "extends @sanity/browserslist-config",
-  "prettier": "@sanity/prettier-config",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json",
+    "./_internal": "./dist/_exports/_internal.js",
+    "./agent": "./dist/_exports/agent.js",
+    "./comlink": "./dist/_exports/comlink.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
-    "@sanity/bifur-client": "^0.4.1",
-    "@sanity/client": "^7.14.1",
-    "@sanity/comlink": "^3.0.4",
+    "@sanity/bifur-client": "^1.0.0",
+    "@sanity/client": "^7.26.2",
+    "@sanity/comlink": "^4.0.3",
     "@sanity/diff-match-patch": "^3.2.0",
     "@sanity/diff-patch": "^6.0.0",
     "@sanity/id-utils": "^1.0.0",
-    "@sanity/image-url": "^2.0.3",
+    "@sanity/image-url": "^2.1.1",
     "@sanity/json-match": "^1.0.5",
-    "@sanity/message-protocol": "^0.18.0",
-    "@sanity/mutate": "^0.12.4",
-    "@sanity/types": "^5.2.0",
-    "groq-js": "^1.19.0",
-    "lodash-es": "^4.17.21",
+    "@sanity/message-protocol": "^0.24.0",
+    "@sanity/mutate": "^0.18.1",
+    "@sanity/telemetry": "^1.1.0",
+    "@sanity/types": "^6.9.1",
+    "groq": "3.88.1-typegen-experimental.0",
+    "groq-js": "^2.0.0",
     "reselect": "^5.1.1",
     "rxjs": "^7.8.2",
-    "zustand": "^5.0.4"
+    "zustand": "^5.0.13"
   },
   "devDependencies": {
     "@sanity/browserslist-config": "^1.0.5",
-    "@sanity/pkg-utils": "^8.1.29",
-    "@sanity/prettier-config": "^1.0.6",
-    "@types/lodash-es": "^4.17.12",
-    "@vitest/coverage-v8": "3.2.4",
-    "eslint": "^9.22.0",
-    "prettier": "^3.7.3",
-    "rollup-plugin-visualizer": "^5.14.0",
-    "typescript": "^5.8.3",
-    "vite": "^6.3.4",
-    "vitest": "^3.2.4",
+    "@sanity/pkg-utils": "^12.1.0",
+    "@types/node": "^24.13.3",
+    "@vitest/coverage-v8": "^4.1.10",
+    "eslint": "^10.6.0",
+    "oxfmt": "^0.58.0",
+    "rolldown": "^1.2.3",
+    "typescript": "^6.0.3",
+    "vite": "^8.1.5",
+    "vitest": "^4.1.10",
     "@repo/config-eslint": "0.0.0",
-    "@repo/config-test": "0.0.1",
     "@repo/package.bundle": "3.82.0",
-    "@repo/tsconfig": "0.0.1",
-    "@repo/package.config": "0.0.1"
-  },
-  "engines": {
-    "node": ">=20.19"
-  },
-  "publishConfig": {
-    "access": "public"
+    "@repo/config-test": "0.0.1",
+    "@repo/package.config": "0.0.1",
+    "@repo/tsconfig": "0.0.1"
   },
+  "browserslist": "extends @sanity/browserslist-config",
   "scripts": {
     "build": "pkg build --strict --clean --check",
     "build:bundle": "vite build --configLoader runner --config package.bundle.ts",
     "clean": "rimraf dist",
     "dev": "pkg watch",
     "docs": "typedoc --json docs/typedoc.json --tsconfig ./tsconfig.dist.json",
-    "format": "prettier --write --cache --ignore-unknown .",
+    "format": "oxfmt",
     "lint": "eslint .",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",

package/src/_exports/_internal.ts

@@ -0,0 +1,27 @@
+export {isStudioConfig} from '../auth/authMode'
+export {
+  type ApiErrorBody,
+  getClientErrorApiBody,
+  getClientErrorApiDescription,
+  getClientErrorApiType,
+  isProjectUserNotFoundClientError,
+} from '../auth/utils'
+export {getCommentsOptionsKey, parseCommentsOptionsKey} from '../comments/commentsStore' // only used for memoizing in React, not needed for actual functionality
+export {PREVIEW_PROJECTION} from '../preview/previewConstants'
+export {transformProjectionToPreview} from '../preview/previewProjectionUtils'
+export {getQueryKey, parseQueryKey} from '../query/queryStore' // only used for memoizing in React, not needed for actual functionality
+export {
+  type CacheTag,
+  type CacheWriter,
+  defineFetcher,
+  defineMutation,
+  type Fetcher,
+  type FetcherDefinition,
+  type FetcherSnapshot,
+  type MutationDefinition,
+  type MutationResult,
+} from '../store/fetcherStore'
+export {getTelemetryManager, initTelemetry, trackHookMounted} from '../telemetry/initTelemetry'
+export {getUsersKey, parseUsersKey} from '../users/reducers' // only used for memoizing in React, not needed for actual functionality
+export {createGroqSearchFilter} from '../utils/createGroqSearchFilter'
+export {isDeepEqual, pickProperties} from '../utils/object'

package/src/_exports/agent.ts

@@ -0,0 +1,19 @@
+export type {
+  AgentGenerateOptions,
+  AgentGenerateResult,
+  AgentPatchOptions,
+  AgentPatchResult,
+  AgentPromptOptions,
+  AgentPromptResult,
+  AgentTransformOptions,
+  AgentTransformResult,
+  AgentTranslateOptions,
+  AgentTranslateResult,
+} from '../agent/agentActions'
+export {
+  agentGenerate,
+  agentPatch,
+  agentPrompt,
+  agentTransform,
+  agentTranslate,
+} from '../agent/agentActions'

package/src/_exports/comlink.ts

@@ -0,0 +1,16 @@
+export {
+  type ComlinkControllerState,
+  destroyController,
+  getOrCreateChannel,
+  getOrCreateController,
+  releaseChannel,
+} from '../comlink/controller/comlinkControllerStore'
+export type {ComlinkNodeState} from '../comlink/node/comlinkNodeStore'
+export {getOrCreateNode, releaseNode} from '../comlink/node/comlinkNodeStore'
+export {getNodeState, type NodeState} from '../comlink/node/getNodeState'
+export {
+  type FrameMessage,
+  type NewTokenResponseMessage,
+  type RequestNewTokenMessage,
+  type WindowMessage,
+} from '../comlink/types'

package/src/_exports/index.ts

@@ -5,27 +5,30 @@ import {type SanityProject as _SanityProject} from '@sanity/client'
  */
 export type SanityProject = _SanityProject
 
-export type {
-  AgentGenerateOptions,
-  AgentGenerateResult,
-  AgentPatchOptions,
-  AgentPatchResult,
-  AgentPromptOptions,
-  AgentPromptResult,
-  AgentResourceOptions,
-  AgentTransformOptions,
-  AgentTransformResult,
-  AgentTranslateOptions,
-  AgentTranslateResult,
-} from '../agent/agentActions'
-export {
-  agentGenerate,
-  agentPatch,
-  agentPrompt,
-  agentTransform,
-  agentTranslate,
-} from '../agent/agentActions'
-export {isStudioConfig} from '../auth/authMode'
+export {checkPermissions} from '../access/checkPermissions'
+export {type AccessResourceType} from '../access/checkPermissions'
+export {
+  application,
+  applications,
+  deleteApplication,
+  updateApplication,
+} from '../applications/applications'
+export {
+  type Application,
+  type ApplicationAccess,
+  type ApplicationBase,
+  type ApplicationDeployment,
+  type ApplicationInclude,
+  type ApplicationInterface,
+  type ApplicationsOptions,
+  type ApplicationsResponse,
+  type ApplicationStudioConfig,
+  type ApplicationVisibility,
+  type ApplicationWorkspace,
+  type DeleteApplicationInput,
+  type DeletedResult,
+  type UpdateApplicationInput,
+} from '../applications/applications'
 export {AuthStateType} from '../auth/authStateType'
 export {
   type AuthState,
@@ -45,36 +48,44 @@ export {
 export {observeOrganizationVerificationState} from '../auth/getOrganizationVerificationState'
 export {handleAuthCallback} from '../auth/handleAuthCallback'
 export {logout} from '../auth/logout'
-export {
-  type ApiErrorBody,
-  getClientErrorApiBody,
-  getClientErrorApiDescription,
-  getClientErrorApiType,
-  isProjectUserNotFoundClientError,
-} from '../auth/utils'
 export type {ClientStoreState as ClientState} from '../client/clientStore'
 export {type ClientOptions, getClient, getClientState} from '../client/clientStore'
 export {
-  type ComlinkControllerState,
-  destroyController,
-  getOrCreateChannel,
-  getOrCreateController,
-  releaseChannel,
-} from '../comlink/controller/comlinkControllerStore'
-export type {ComlinkNodeState} from '../comlink/node/comlinkNodeStore'
-export {getOrCreateNode, releaseNode} from '../comlink/node/comlinkNodeStore'
-export {getNodeState, type NodeState} from '../comlink/node/getNodeState'
-export {
-  type FrameMessage,
-  type NewTokenResponseMessage,
-  type RequestNewTokenMessage,
-  type WindowMessage,
-} from '../comlink/types'
+  createComment,
+  type CreateCommentOptions,
+  removeComment,
+  type RemoveCommentOptions,
+  replyToComment,
+  type ReplyToCommentOptions,
+  setCommentStatus,
+  type SetCommentStatusOptions,
+  updateComment,
+  type UpdateCommentOptions,
+} from '../comments/commentActions'
+export {
+  type CommentsOptions,
+  getCommentsState,
+  getCommentThreadsState,
+  resolveComments,
+  type ResolveCommentsOptions,
+  resolveCommentThreads,
+} from '../comments/commentsStore'
+export {
+  type Comment,
+  type CommentLocalState,
+  type CommentMessage,
+  type CommentReaction,
+  type CommentStatus,
+  type CommentTextSelection,
+  type CommentTextSelectionItem,
+  type CommentThread,
+} from '../comments/types'
 export {type AuthConfig, type AuthProvider} from '../config/authConfig'
 export {
+  createDatasetHandle,
   createDocumentHandle,
   createDocumentTypeHandle,
-  createResourceHandle,
+  createProjectHandle,
 } from '../config/handles'
 export {
   configureLogging,
@@ -87,8 +98,8 @@ export {
 } from '../config/loggingConfig'
 export {
   type CanvasResource,
+  type DatasetHandle,
   type DatasetResource,
-  DEFAULT_RESOURCE_NAME,
   type DocumentHandle,
   type DocumentResource,
   type DocumentTypeHandle,
@@ -97,27 +108,47 @@ export {
   isMediaLibraryResource,
   type MediaLibraryResource,
   type PerspectiveHandle,
+  type ProjectHandle,
+  type ReleaseHandle,
   type ReleasePerspective,
-  type ResourceHandle,
   type SanityConfig,
   type StudioConfig,
   type TokenSource,
 } from '../config/sanityConfig'
 export {getDatasetsState, resolveDatasets} from '../datasets/datasets'
 export {
+  type Action,
+  archiveRelease,
+  type ArchiveReleaseAction,
   createDocument,
   type CreateDocumentAction,
+  createRelease,
+  type CreateReleaseAction,
   deleteDocument,
   type DeleteDocumentAction,
+  deleteRelease,
+  type DeleteReleaseAction,
   discardDocument,
   type DiscardDocumentAction,
   type DocumentAction,
   editDocument,
   type EditDocumentAction,
+  type EditDocumentOptions,
+  editRelease,
+  type EditReleaseAction,
   publishDocument,
   type PublishDocumentAction,
+  publishRelease,
+  type PublishReleaseAction,
+  type ReleaseAction,
+  scheduleRelease,
+  type ScheduleReleaseAction,
+  unarchiveRelease,
+  type UnarchiveReleaseAction,
   unpublishDocument,
   type UnpublishDocumentAction,
+  unscheduleRelease,
+  type UnscheduleReleaseAction,
 } from '../document/actions'
 export {
   type ActionsResult,
@@ -141,44 +172,74 @@ export {
   type DocumentEditedEvent,
   type DocumentEvent,
   type DocumentPublishedEvent,
+  type DocumentRemotePatchesEvent,
+  type DocumentTransactionSubmissionResult,
   type DocumentUnpublishedEvent,
   type TransactionAcceptedEvent,
   type TransactionRevertedEvent,
 } from '../document/events'
+export {type JsonMatch} from '../document/patchOperations'
 export {type DocumentPermissionsResult, type PermissionDeniedReason} from '../document/permissions'
+export {getReleaseDocumentId} from '../document/processActions/releaseUtil'
 export type {FavoriteStatusResponse} from '../favorites/favorites'
 export {getFavoritesState, resolveFavoritesState} from '../favorites/favorites'
-export {getPresence} from '../presence/presenceStore'
+export {installation, installations} from '../installations/installations'
+export {
+  type Installation,
+  type InstallationAccess,
+  type InstallationActiveConfig,
+  type InstallationBase,
+  type InstallationInclude,
+  type InstallationInterface,
+  type InstallationsOptions,
+  type InstallationsResponse,
+} from '../installations/installations'
+export {organization} from '../organization/organization'
+export {
+  type Organization,
+  type OrganizationBase,
+  type OrganizationMember,
+  type OrganizationOptions,
+} from '../organization/organization'
+export {organizations} from '../organizations/organizations'
+export {type Organizations, type OrganizationsOptions} from '../organizations/organizations'
+export {getDocumentPresence, getPresence, reportPresence} from '../presence/presenceStore'
 export type {
   DisconnectEvent,
+  DocumentPresence,
+  DocumentPresenceOptions,
   PresenceLocation,
+  PresencePerspectiveOptions,
+  PresenceSelection,
+  PresenceSelectionPoint,
+  ReportPresenceOptions,
   RollCallEvent,
   StateEvent,
   TransportEvent,
   UserPresence,
 } from '../presence/types'
-export {PREVIEW_PROJECTION} from '../preview/previewConstants'
-export {transformProjectionToPreview} from '../preview/previewProjectionUtils'
-export type {PreviewMedia, PreviewQueryResult, PreviewValue, ValuePending} from '../preview/types'
+export type {PreviewMedia, PreviewQueryResult, PreviewValue} from '../preview/types'
 export {type OrgVerificationResult} from '../project/organizationVerification'
-export {getProjectState, type ProjectHandle, resolveProject} from '../project/project'
+export {project} from '../project/project'
+export {
+  type Project,
+  type ProjectBase,
+  type ProjectMember,
+  type ProjectMemberRole,
+  type ProjectMetadata,
+  type ProjectOptions,
+} from '../project/project'
 export {getProjectionState} from '../projection/getProjectionState'
 export {resolveProjection} from '../projection/resolveProjection'
 export {type ProjectionValuePending} from '../projection/types'
-export {getProjectsState, resolveProjects} from '../projects/projects'
-export {
-  getQueryKey,
-  getQueryState,
-  parseQueryKey,
-  type QueryOptions,
-  resolveQuery,
-} from '../query/queryStore'
+export {projects} from '../projects/projects'
+export {type ProjectsOptions} from '../projects/projects'
+export {getQueryState, type QueryOptions, resolveQuery} from '../query/queryStore'
 export {getPerspectiveState} from '../releases/getPerspectiveState'
-export type {ReleaseDocument} from '../releases/releasesStore'
-export {getActiveReleasesState} from '../releases/releasesStore'
+export type {ReleaseState} from '../releases/releasesStore'
+export {getActiveReleasesState, getAllReleasesState} from '../releases/releasesStore'
 export {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
 export {type Selector, type StateSource} from '../store/createStateSourceAction'
-export {getUsersKey, parseUsersKey} from '../users/reducers'
 export {
   type GetUserOptions,
   type GetUsersOptions,
@@ -199,10 +260,10 @@ export {
   resolveUsers,
 } from '../users/usersStore'
 export {type FetcherStore, type FetcherStoreState} from '../utils/createFetcherStore'
-export {createGroqSearchFilter} from '../utils/createGroqSearchFilter'
-export {defineIntent, type Intent, type IntentFilter} from '../utils/defineIntent'
 export {getCorsErrorProjectId} from '../utils/getCorsErrorProjectId'
+export {isImportError} from '../utils/isImportError'
 export {CORE_SDK_VERSION} from '../version'
+export type {ReleaseDocument} from '@sanity/client'
 export {
   getIndexForKey,
   getPathDepth,

package/src/access/checkPermissions.test.ts

@@ -0,0 +1,55 @@
+import {type SanityClient} from '@sanity/client'
+import {of} from 'rxjs'
+import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest'
+
+import {getClientState} from '../client/clientStore'
+import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
+import {type StateSource} from '../store/createStateSourceAction'
+import {checkPermissions} from './checkPermissions'
+
+vi.mock('../client/clientStore')
+
+describe('checkPermissions', () => {
+  let instance: SanityInstance
+  const request = vi.fn()
+
+  beforeEach(() => {
+    instance = createSanityInstance({projectId: 'p', dataset: 'd'})
+    request.mockReset()
+    vi.mocked(getClientState).mockReturnValue({
+      observable: of({observable: {request}} as unknown as SanityClient),
+    } as StateSource<SanityClient>)
+  })
+
+  afterEach(() => {
+    instance.dispose()
+  })
+
+  it('checks permissions on the global client and unwraps the data envelope', async () => {
+    request.mockReturnValue(of({data: {'sanity.project.read': true}}))
+
+    const result = await checkPermissions.resolveState(instance, 'project', 'p1', [
+      'sanity.project.read',
+    ])
+
+    expect(result).toEqual({'sanity.project.read': true})
+    expect(getClientState).toHaveBeenCalledWith(instance, {
+      apiVersion: 'v2025-07-11',
+      scope: 'global',
+    })
+    expect(request).toHaveBeenCalledWith({
+      uri: '/access/project/p1/user-permissions/me/check',
+      query: {permissions: ['sanity.project.read']},
+      tag: 'access.check',
+    })
+  })
+
+  it('does not create distinct cache entries for different permission orderings', async () => {
+    request.mockReturnValue(of({data: {a: true, b: false}}))
+
+    await checkPermissions.resolveState(instance, 'organization', 'org1', ['b', 'a'])
+    await checkPermissions.resolveState(instance, 'organization', 'org1', ['a', 'b'])
+
+    expect(request).toHaveBeenCalledTimes(1)
+  })
+})

package/src/access/checkPermissions.ts

@@ -0,0 +1,54 @@
+import {map, switchMap} from 'rxjs'
+
+import {getClientState} from '../client/clientStore'
+import {defineFetcher} from '../store/fetcherStore'
+
+const API_VERSION = 'v2025-07-11'
+
+/**
+ * The resource types the Access API can scope a permission check to.
+ *
+ * @see https://www.sanity.io/docs/http-reference/access-api
+ * @public
+ */
+export type AccessResourceType =
+  | 'organization'
+  | 'project'
+  | 'media-library'
+  | 'canvas'
+  | 'dashboard'
+  | 'view'
+
+/**
+ * Fetcher checking whether the current user holds the given permissions on a
+ * resource (`GET /access/:resourceType/:resourceId/user-permissions/me/check`),
+ * on the shared fetcher cache. Resolves to a map of each requested permission
+ * to whether the user has it. The key sorts the permission list, so permission
+ * order doesn't create distinct cache entries.
+ *
+ * @see https://www.sanity.io/docs/http-reference/access-api
+ * @internal
+ */
+export const checkPermissions = defineFetcher<
+  [resourceType: AccessResourceType, resourceId: string, permissions: string[]],
+  Record<string, boolean>
+>({
+  name: 'checkPermissions',
+  getKey: (_instance, resourceType, resourceId, permissions) =>
+    `${resourceType}:${resourceId}:${[...permissions].sort().join(',')}`,
+  fetch: (instance) => (resourceType, resourceId, permissions) =>
+    getClientState(instance, {apiVersion: API_VERSION, scope: 'global'}).observable.pipe(
+      switchMap((client) =>
+        client.observable
+          .request<{data: Record<string, boolean>}>({
+            uri: `/access/${resourceType}/${resourceId}/user-permissions/me/check`,
+            query: {permissions},
+            tag: 'access.check',
+          })
+          .pipe(map((response) => response.data)),
+      ),
+    ),
+  tags: (_data, resourceType, resourceId) => [
+    {type: 'access', id: `${resourceType}:${resourceId}`},
+  ],
+})