@sanity/sdk 2.2.0 → 2.3.1

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import * as _sanity_comlink3 from "@sanity/comlink";
 import { ChannelInput, ChannelInstance, Controller, Message, Node, NodeInput, Status } from "@sanity/comlink";
 import { PatchMutation } from "@sanity/mutate/_unstable_store";
 import { SanityDocument as SanityDocument$3, SanityProjectionResult, SanityQueryResult } from "groq";
+import { ExprNode } from "groq-js";
 import { CanvasResource, MediaResource, StudioResource } from "@sanity/message-protocol";
 import { getIndexForKey, getPathDepth, joinPaths, jsonMatch, slicePath, stringifyPath } from "@sanity/json-match";
 /**
@@ -287,6 +288,10 @@ interface DashboardContext {
   env?: string;
   orgId?: string;
 }
+/**
+ * The method of authentication used.
+ * @internal
+ */
 type AuthMethodOptions = 'localstorage' | 'cookie' | undefined;
 /**
  * @public
@@ -742,337 +747,6 @@ interface ApplyDocumentActionsOptions {
 declare function applyDocumentActions<TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, action: DocumentAction<TDocumentType, TDataset, TProjectId> | DocumentAction<TDocumentType, TDataset, TProjectId>[], options?: ApplyDocumentActionsOptions): Promise<ActionsResult<SanityDocument$3<TDocumentType, `${TProjectId}.${TDataset}`>>>;
 /** @beta */
 declare function applyDocumentActions(instance: SanityInstance, action: DocumentAction | DocumentAction[], options?: ApplyDocumentActionsOptions): Promise<ActionsResult>;
-declare interface AccessAttributeNode extends BaseNode {
-  type: 'AccessAttribute';
-  base?: ExprNode;
-  name: string;
-}
-declare interface AccessElementNode extends BaseNode {
-  type: 'AccessElement';
-  base: ExprNode;
-  index: number;
-}
-declare interface AndNode extends BaseNode {
-  type: 'And';
-  left: ExprNode;
-  right: ExprNode;
-}
-declare type AnyStaticValue = StringValue | NumberValue | NullValue | BooleanValue | DateTimeValue | ObjectValue | ArrayValue | PathValue;
-declare interface ArrayCoerceNode extends BaseNode {
-  type: 'ArrayCoerce';
-  base: ExprNode;
-}
-declare interface ArrayElementNode extends BaseNode {
-  type: 'ArrayElement';
-  value: ExprNode;
-  isSplat: boolean;
-}
-declare interface ArrayNode extends BaseNode {
-  type: 'Array';
-  elements: ArrayElementNode[];
-}
-
-/** Describes a type node for array values. */
-
-declare type ArrayValue = StaticValue<unknown[], 'array'>;
-declare interface AscNode extends BaseNode {
-  type: 'Asc';
-  base: ExprNode;
-}
-
-/** The base interface for SyntaxNode. */
-declare interface BaseNode {
-  type: string;
-}
-
-/** Describes a type node for boolean values, optionally including a value. If a value is provided it will always be the given boolean value. */
-
-declare type BooleanValue = StaticValue<boolean, 'boolean'>;
-declare interface Context {
-  timestamp: Date;
-  identity: string;
-  before: Value | null;
-  after: Value | null;
-  sanity?: {
-    projectId: string;
-    dataset: string;
-  };
-  dereference?: DereferenceFunction;
-}
-declare interface ContextNode extends BaseNode {
-  type: 'Context';
-  key: string;
-}
-
-/**
- * createReferenceTypeNode creates a ObjectTypeNode representing a reference type
- * it adds required attributes for a reference type.
- * @param name - The name of the reference type
- * @param inArray - Whether the reference is in an array
- * @returns A ObjectTypeNode representing a reference type
- * @internal
- */
-
-declare class DateTime {
-  date: Date;
-  constructor(date: Date);
-  static parseToValue(str: string): Value;
-  equals(other: DateTime): boolean;
-  add(secs: number): DateTime;
-  difference(other: DateTime): number;
-  compareTo(other: DateTime): number;
-  toString(): string;
-  toJSON(): string;
-}
-declare type DateTimeValue = StaticValue<DateTime, 'datetime'>;
-declare type DereferenceFunction = (obj: {
-  _ref: string;
-}) => PromiseLike<Document_2 | null | undefined>;
-declare interface DerefNode extends BaseNode {
-  type: 'Deref';
-  base: ExprNode;
-}
-declare interface DescNode extends BaseNode {
-  type: 'Desc';
-  base: ExprNode;
-}
-declare type Document_2 = {
-  _id?: string;
-  _type?: string;
-  [T: string]: unknown;
-};
-declare interface EverythingNode extends BaseNode {
-  type: 'Everything';
-}
-declare type Executor<N = ExprNode> = (node: N, scope: Scope) => Value | PromiseLike<Value>;
-
-/**
- * A node which can be evaluated into a value.
- * @public
- */
-declare type ExprNode = AccessAttributeNode | AccessElementNode | AndNode | ArrayNode | ArrayCoerceNode | AscNode | ContextNode | DerefNode | DescNode | EverythingNode | FilterNode | FlatMapNode | FuncCallNode | GroupNode | InRangeNode | MapNode | NegNode | NotNode | ObjectNode | OpCallNode | OrNode | ParameterNode | ParentNode_2 | PipeFuncCallNode | PosNode | ProjectionNode | SelectNode | SelectorNode | SliceNode | ThisNode | TupleNode | ValueNode;
-declare interface FilterNode extends BaseNode {
-  type: 'Filter';
-  base: ExprNode;
-  expr: ExprNode;
-}
-declare interface FlatMapNode extends BaseNode {
-  type: 'FlatMap';
-  base: ExprNode;
-  expr: ExprNode;
-}
-declare interface FuncCallNode extends BaseNode {
-  type: 'FuncCall';
-  func: GroqFunction;
-  namespace: string;
-  name: string;
-  args: ExprNode[];
-}
-
-/** @public */
-declare type GroqFunction = (args: GroqFunctionArg[], scope: Scope, execute: Executor) => PromiseLike<Value>;
-
-/** @public */
-declare type GroqFunctionArg = ExprNode;
-declare type GroqPipeFunction = (base: Value, args: ExprNode[], scope: Scope, execute: Executor) => PromiseLike<Value>;
-
-/**
- * A type of a value in GROQ.
- */
-declare type GroqType = 'null' | 'boolean' | 'number' | 'string' | 'array' | 'object' | 'path' | 'datetime';
-declare interface GroupNode extends BaseNode {
-  type: 'Group';
-  base: ExprNode;
-}
-
-/** Describes a type node for inline values, including a name that references another type. */
-
-declare interface InRangeNode extends BaseNode {
-  type: 'InRange';
-  base: ExprNode;
-  left: ExprNode;
-  right: ExprNode;
-  isInclusive: boolean;
-}
-declare interface MapNode extends BaseNode {
-  type: 'Map';
-  base: ExprNode;
-  expr: ExprNode;
-}
-declare interface NegNode extends BaseNode {
-  type: 'Neg';
-  base: ExprNode;
-}
-declare interface NotNode extends BaseNode {
-  type: 'Not';
-  base: ExprNode;
-}
-
-/** Describes a type node for null values, always being the null value. */
-
-declare type NullValue = StaticValue<null, 'null'>;
-
-/** Describes a type node for number values, optionally including a value. If a value is provided it will always be the given numeric value.*/
-
-declare type NumberValue = StaticValue<number, 'number'>;
-
-/** Describes a type node for object attributes, including a type and an optional flag for being optional. */
-
-declare type ObjectAttributeNode = ObjectAttributeValueNode | ObjectConditionalSplatNode | ObjectSplatNode;
-declare interface ObjectAttributeValueNode extends BaseNode {
-  type: 'ObjectAttributeValue';
-  name: string;
-  value: ExprNode;
-}
-declare interface ObjectConditionalSplatNode extends BaseNode {
-  type: 'ObjectConditionalSplat';
-  condition: ExprNode;
-  value: ExprNode;
-}
-declare interface ObjectNode extends BaseNode {
-  type: 'Object';
-  attributes: ObjectAttributeNode[];
-}
-declare interface ObjectSplatNode extends BaseNode {
-  type: 'ObjectSplat';
-  value: ExprNode;
-}
-
-/**
- * Describes a type node for object values, including a collection of attributes and an optional rest value.
- * The rest value can be another ObjectTypeNode, an UnknownTypeNode, or an InlineTypeNode.
- * If the rest value is an ObjectTypeNode, it means that the object can have additional attributes.
- * If the rest value is an UnknownTypeNode, the entire object is unknown.
- * If the rest value is an InlineTypeNode, it means that the object has additional attributes from the referenced type.
- */
-
-declare type ObjectValue = StaticValue<Record<string, unknown>, 'object'>;
-declare type OpCall = '==' | '!=' | '>' | '>=' | '<' | '<=' | '+' | '-' | '*' | '/' | '%' | '**' | 'in' | 'match';
-declare interface OpCallNode extends BaseNode {
-  type: 'OpCall';
-  op: OpCall;
-  left: ExprNode;
-  right: ExprNode;
-}
-declare interface OrNode extends BaseNode {
-  type: 'Or';
-  left: ExprNode;
-  right: ExprNode;
-}
-declare interface ParameterNode extends BaseNode {
-  type: 'Parameter';
-  name: string;
-}
-declare interface ParentNode_2 extends BaseNode {
-  type: 'Parent';
-  n: number;
-}
-declare class Path {
-  private pattern;
-  private patternRe;
-  constructor(pattern: string);
-  matches(str: string): boolean;
-  toJSON(): string;
-}
-declare type PathValue = StaticValue<Path, 'path'>;
-declare interface PipeFuncCallNode extends BaseNode {
-  type: 'PipeFuncCall';
-  func: GroqPipeFunction;
-  base: ExprNode;
-  name: string;
-  args: ExprNode[];
-}
-declare interface PosNode extends BaseNode {
-  type: 'Pos';
-  base: ExprNode;
-}
-
-/** Union of any primitive type nodes. */
-
-declare interface ProjectionNode extends BaseNode {
-  type: 'Projection';
-  base: ExprNode;
-  expr: ExprNode;
-}
-
-/** A schema consisting of a list of Document or TypeDeclaration items, allowing for complex type definitions. */
-
-declare class Scope {
-  params: Record<string, unknown>;
-  source: Value;
-  value: Value;
-  parent: Scope | null;
-  context: Context;
-  isHidden: boolean;
-  constructor(params: Record<string, unknown>, source: Value, value: Value, context: Context, parent: Scope | null);
-  createNested(value: Value): Scope;
-  createHidden(value: Value): Scope;
-}
-declare interface SelectAlternativeNode extends BaseNode {
-  type: 'SelectAlternative';
-  condition: ExprNode;
-  value: ExprNode;
-}
-declare interface SelectNode extends BaseNode {
-  type: 'Select';
-  alternatives: SelectAlternativeNode[];
-  fallback?: ExprNode;
-}
-declare interface SelectorNode extends BaseNode {
-  type: 'Selector';
-}
-declare interface SliceNode extends BaseNode {
-  type: 'Slice';
-  base: ExprNode;
-  left: number;
-  right: number;
-  isInclusive: boolean;
-}
-declare class StaticValue<P, T extends GroqType> {
-  data: P;
-  type: T;
-  constructor(data: P, type: T);
-  isArray(): boolean;
-  get(): Promise<any>;
-  [Symbol.asyncIterator](): Generator<Value, void, unknown>;
-}
-declare class StreamValue {
-  type: 'stream';
-  private generator;
-  private ticker;
-  private isDone;
-  private data;
-  constructor(generator: () => AsyncGenerator<Value, void, unknown>);
-  isArray(): boolean;
-  get(): Promise<any>;
-  [Symbol.asyncIterator](): AsyncGenerator<Value, void, unknown>;
-  _nextTick(): Promise<void>;
-}
-
-/** Describes a type node for string values, optionally including a value. If a value is provided it will always be the given string value. */
-
-declare type StringValue = StaticValue<string, 'string'>;
-
-/** Any sort of node which appears as syntax */
-
-declare interface ThisNode extends BaseNode {
-  type: 'This';
-}
-declare interface TupleNode extends BaseNode {
-  type: 'Tuple';
-  members: Array<ExprNode>;
-}
-
-/** Defines a type declaration with a specific name and a value that describes the structure of the type using a TypeNode. */
-
-/**
- * The result of an expression.
- */
-declare type Value = AnyStaticValue | StreamValue;
-declare interface ValueNode<P = any> {
-  type: 'Value';
-  value: P;
-}
 /**
  * Represents a reactive state source that provides synchronized access to store data
  *
@@ -1761,10 +1435,6 @@ declare const resolvePreview: BoundStoreAction<PreviewStoreState, [docHandle: Re
 declare const getProjectState: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client12.SanityProject>, [options?: ProjectHandle<string> | undefined], StateSource<_sanity_client12.SanityProject | undefined>>;
 /** @public */
 declare const resolveProject: BoundStoreAction<FetcherStoreState<[options?: ProjectHandle<string> | undefined], _sanity_client12.SanityProject>, [options?: ProjectHandle<string> | undefined], Promise<_sanity_client12.SanityProject>>;
-/**
- * @public
- */
-type ValidProjection = `{${string}}`;
 /**
  * @public
  * The result of a projection query
@@ -1773,13 +1443,20 @@ interface ProjectionValuePending<TValue extends object> {
   data: TValue | null;
   isPending: boolean;
 }
-interface ProjectionOptions<TProjection extends ValidProjection = ValidProjection, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
+/**
+ * @public
+ * @deprecated
+ * Template literals are a bit too limited, so this type is deprecated.
+ * Use `string` instead. Projection strings are validated at runtime.
+ */
+type ValidProjection = string;
+interface ProjectionOptions<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string> extends DocumentHandle<TDocumentType, TDataset, TProjectId> {
   projection: TProjection;
 }
 /**
  * @beta
  */
-declare function getProjectionState<TProjection extends ValidProjection = ValidProjection, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): StateSource<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>> | undefined>;
+declare function getProjectionState<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): StateSource<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>> | undefined>;
 /**
  * @beta
  */
@@ -1792,7 +1469,7 @@ declare function getProjectionState(instance: SanityInstance, options: Projectio
  * @beta
  */
 /** @beta */
-declare function resolveProjection<TProjection extends ValidProjection = ValidProjection, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): Promise<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>>>;
+declare function resolveProjection<TProjection extends string = string, TDocumentType extends string = string, TDataset extends string = string, TProjectId extends string = string>(instance: SanityInstance, options: ProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>): Promise<ProjectionValuePending<SanityProjectionResult<TProjection, TDocumentType, `${TProjectId}.${TDataset}`>>>;
 /** @beta */
 declare function resolveProjection<TData extends object>(instance: SanityInstance, options: ProjectionOptions): Promise<ProjectionValuePending<TData>>;
 /** @public */
@@ -2177,6 +1854,13 @@ interface Intent {
  * @public
  */
 declare function defineIntent(intent: Intent): Intent;
+/**
+ * @public
+ * Extracts the project ID from a CorsOriginError message.
+ * @param error - The error to extract the project ID from.
+ * @returns The project ID or null if the error is not a CorsOriginError.
+ */
+declare function getCorsErrorProjectId(error: Error): string | null;
 /**
  * This version is provided by pkg-utils at build time
  * @internal
@@ -2186,4 +1870,4 @@ declare const CORE_SDK_VERSION: {};
  * @public
  */
 type SanityProject = SanityProject$1;
-export { type ActionErrorEvent, type ActionsResult, type ApplyDocumentActionsOptions, type AuthConfig, type AuthProvider, type AuthState, AuthStateType, type AuthStoreState, CORE_SDK_VERSION, type ClientOptions, type ClientStoreState as ClientState, type ComlinkControllerState, type ComlinkNodeState, type CreateDocumentAction, type CurrentUser, type DatasetHandle, type DeleteDocumentAction, type DiscardDocumentAction, type DisconnectEvent, type DocumentAction, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentDiscardedEvent, type DocumentEditedEvent, type DocumentEvent, type DocumentHandle, type DocumentOptions, type DocumentPermissionsResult, type DocumentPublishedEvent, type DocumentTypeHandle, type DocumentUnpublishedEvent, type EditDocumentAction, type ErrorAuthState, type FavoriteStatusResponse, type FetcherStore, type FetcherStoreState, type FrameMessage, type GetPreviewStateOptions, type GetUserOptions, type GetUsersOptions, type Intent, type IntentFilter, type JsonMatch, type LoggedInAuthState, type LoggedOutAuthState, type LoggingInAuthState, type Membership, type NewTokenResponseMessage, type NodeState, type OrgVerificationResult, type PermissionDeniedReason, type PerspectiveHandle, type PresenceLocation, type PreviewStoreState, type PreviewValue, type ProjectHandle, type ProjectionValuePending, type PublishDocumentAction, type QueryOptions, type ReleaseDocument, type ReleasePerspective, type RequestNewTokenMessage, type ResolvePreviewOptions, type ResolveUserOptions, type ResolveUsersOptions, type Role, type RollCallEvent, type SanityConfig, type SanityDocument, type SanityInstance, SanityProject, type SanityUser, type SanityUserResponse, type Selector, type StateEvent, type StateSource, type TransactionAcceptedEvent, type TransactionRevertedEvent, type TransportEvent, type UnpublishDocumentAction, type UserPresence, type UserProfile, type UsersGroupState, type UsersStoreState, type ValidProjection, type ValuePending, type WindowMessage, applyDocumentActions, createDatasetHandle, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createProjectHandle, createSanityInstance, defineIntent, deleteDocument, destroyController, discardDocument, editDocument, getActiveReleasesState, getAuthState, getClient, getClientState, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getPreviewState, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, joinPaths, jsonMatch, loadMoreUsers, logout, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolvePermissions, resolvePreview, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, unpublishDocument };
+export { type ActionErrorEvent, type ActionsResult, type ApplyDocumentActionsOptions, type AuthConfig, type AuthProvider, type AuthState, AuthStateType, type AuthStoreState, CORE_SDK_VERSION, type ClientOptions, type ClientStoreState as ClientState, type ComlinkControllerState, type ComlinkNodeState, type CreateDocumentAction, type CurrentUser, type DatasetHandle, type DeleteDocumentAction, type DiscardDocumentAction, type DisconnectEvent, type DocumentAction, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentDiscardedEvent, type DocumentEditedEvent, type DocumentEvent, type DocumentHandle, type DocumentOptions, type DocumentPermissionsResult, type DocumentPublishedEvent, type DocumentTypeHandle, type DocumentUnpublishedEvent, type EditDocumentAction, type ErrorAuthState, type FavoriteStatusResponse, type FetcherStore, type FetcherStoreState, type FrameMessage, type GetPreviewStateOptions, type GetUserOptions, type GetUsersOptions, type Intent, type IntentFilter, type JsonMatch, type LoggedInAuthState, type LoggedOutAuthState, type LoggingInAuthState, type Membership, type NewTokenResponseMessage, type NodeState, type OrgVerificationResult, type PermissionDeniedReason, type PerspectiveHandle, type PresenceLocation, type PreviewStoreState, type PreviewValue, type ProjectHandle, type ProjectionValuePending, type PublishDocumentAction, type QueryOptions, type ReleaseDocument, type ReleasePerspective, type RequestNewTokenMessage, type ResolvePreviewOptions, type ResolveUserOptions, type ResolveUsersOptions, type Role, type RollCallEvent, type SanityConfig, type SanityDocument, type SanityInstance, SanityProject, type SanityUser, type SanityUserResponse, type Selector, type StateEvent, type StateSource, type TransactionAcceptedEvent, type TransactionRevertedEvent, type TransportEvent, type UnpublishDocumentAction, type UserPresence, type UserProfile, type UsersGroupState, type UsersStoreState, type ValidProjection, type ValuePending, type WindowMessage, applyDocumentActions, createDatasetHandle, createDocument, createDocumentHandle, createDocumentTypeHandle, createGroqSearchFilter, createProjectHandle, createSanityInstance, defineIntent, deleteDocument, destroyController, discardDocument, editDocument, getActiveReleasesState, getAuthState, getClient, getClientState, getCorsErrorProjectId, getCurrentUserState, getDashboardOrganizationId, getDatasetsState, getDocumentState, getDocumentSyncStatus, getFavoritesState, getIndexForKey, getIsInDashboardState, getLoginUrlState, getNodeState, getOrCreateChannel, getOrCreateController, getOrCreateNode, getPathDepth, getPermissionsState, getPerspectiveState, getPresence, getPreviewState, getProjectState, getProjectionState, getProjectsState, getQueryKey, getQueryState, getTokenState, getUserState, getUsersKey, getUsersState, handleAuthCallback, joinPaths, jsonMatch, loadMoreUsers, logout, observeOrganizationVerificationState, parseQueryKey, parseUsersKey, publishDocument, releaseChannel, releaseNode, resolveDatasets, resolveDocument, resolveFavoritesState, resolvePermissions, resolvePreview, resolveProject, resolveProjection, resolveProjects, resolveQuery, resolveUser, resolveUsers, setAuthToken, slicePath, stringifyPath, subscribeDocumentEvents, unpublishDocument };