@sanity/client 7.26.0 → 7.26.2

package/dist/stega.browser.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"stega.browser.cjs","sources":["../src/stega/stegaBrand.ts","../src/stega/index.ts"],"sourcesContent":["import type {Any, ClientReturn} from '@sanity/client'\n\n/**\n * A string that might contain stega-encoded data, and is unsafe to compare against string literals\n * until it's been cleaned with `stegaClean()`.\n *\n * The type intersects a template literal that has a human readable suffix, with a brand property\n * that holds the original string type:\n * - The suffix makes TypeScript report \"This comparison appears to be unintentional\" (TS2367) when\n *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to\n *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,\n *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime\n *   value never ends with that text.\n * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's\n *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally\n *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in\n *   the type system and is never present at runtime.\n *\n * @beta\n */\nexport type StegaString<T extends string = string> =\n  `${T} (may contain hidden stega characters)` & {\n    readonly ' stegaBrand': T\n  }\n\n/**\n * Deeply brands the string properties of a query result as `StegaString`, marking them as\n * potentially containing stega-encoded data.\n *\n * String properties that the stega encoder is guaranteed to never encode keep their plain type:\n * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and\n *   so on), which also preserves discriminated union narrowing on `_type`\n * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued\n *   `slug` keys (covering `\"slug\": slug.current` projections)\n * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and\n *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay\n *   plain\n *\n * Every other string is assumed to be \"poisoned\", even if the runtime `filter` happens to skip it\n * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case\n * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.\n *\n * The `Key` and `ParentKey` type parameters track the key the current value is found under, and\n * the key of the object containing it, they're only used internally during recursion.\n *\n * @beta\n */\nexport type StegaBranded<\n  T,\n  Key extends PropertyKey = number,\n  ParentKey extends PropertyKey = number,\n> = 0 extends 1 & T\n  ? T\n  : T extends string\n    ? T extends {readonly ' stegaBrand': string}\n      ? T\n      : Key extends `_${string}` | 'slug'\n        ? T\n        : Key extends 'current'\n          ? ParentKey extends 'slug'\n            ? T\n            : StegaString<T>\n          : StegaString<T>\n    : T extends number | bigint | boolean | null | undefined\n      ? T\n      : T extends Date | RegExp | ((...args: never[]) => unknown)\n        ? T\n        : T extends readonly unknown[]\n          ? {[Index in keyof T]: StegaBranded<T[Index], number, number>}\n          : T extends {_type: 'block'}\n            ? {[K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]}\n            : T extends {_type: 'span'}\n              ? {[K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]}\n              : T extends object\n                ? {[K in keyof T]: StegaBranded<T[K], K, Key>}\n                : T\n\n/**\n * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use\n * as the first generic of `client.fetch` when stega is enabled:\n * ```ts\n * import {createClient} from '@sanity/client'\n * import type {ClientReturnStega} from '@sanity/client/stega'\n *\n * const query = '*[_type == \"post\"][0]'\n * const post = await client.fetch<ClientReturnStega<typeof query>>(query)\n * ```\n * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),\n * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to\n * `Fallback`, which defaults to `any`, just like `ClientReturn`.\n *\n * @beta\n */\nexport type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<\n  ClientReturn<GroqString, Fallback>\n>\n\n/**\n * Marks strings in an already fetched query result as potentially containing stega-encoded data,\n * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error\n * until they're cleaned with `stegaClean()`, which recovers the original type.\n *\n * This is an identity function, it only changes the type of the input, not its value.\n * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use\n * this function for data that has already been fetched.\n *\n * @beta\n */\nexport function stegaBrand<Result>(result: Result): StegaBranded<Result> {\n  return result as StegaBranded<Result>\n}\n","export * from '@sanity/client'\nimport {\n  createClient as originalCreateClient,\n  ObservableSanityClient,\n  requester as originalRequester,\n  SanityClient,\n} from '@sanity/client'\n\nexport {encodeIntoResult} from './encodeIntoResult'\nexport {type ClientReturnStega, stegaBrand, type StegaBranded, type StegaString} from './stegaBrand'\nexport {stegaClean, type StegaCleaned, vercelStegaCleanAll} from './stegaClean'\nexport {stegaEncodeSourceMap} from './stegaEncodeSourceMap'\nexport * from './types'\n\n/**\n * @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class SanityStegaClient extends SanityClient {}\n\n/**\n * @deprecated -- Use `import {ObservableSanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class ObservableSanityStegaClient extends ObservableSanityClient {}\n\n/**\n * @deprecated -- Use `import {requester} from '@sanity/client'` instead\n * @public\n */\nexport const requester = originalRequester\n\n/**\n * @deprecated -- Use `import {createClient} from '@sanity/client'` instead\n * @public\n */\nexport const createClient = originalCreateClient\n"],"names":["SanityClient","ObservableSanityClient","originalRequester","originalCreateClient"],"mappings":";;;AA4GO,SAAS,WAAmB,QAAsC;AACvE,SAAO;AACT;AC5FO,MAAM,0BAA0BA,OAAAA,aAAa;AAAC;AAM9C,MAAM,oCAAoCC,OAAAA,uBAAuB;AAAC;AAMlE,MAAM,YAAYC,OAAAA,WAMZ,eAAeC,OAAAA;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"stega.browser.cjs","sources":["../src/stega/stegaBrand.ts","../src/stega/index.ts"],"sourcesContent":["import type {Any, ClientReturn} from '@sanity/client'\n\n/**\n * A string that might contain stega-encoded data, and is unsafe to compare against string literals\n * until it's been cleaned with `stegaClean()`.\n *\n * The type intersects a template literal that has a human readable suffix, with a brand property\n * that holds the original string type:\n * - The suffix makes TypeScript report \"This comparison appears to be unintentional\" (TS2367) when\n *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to\n *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,\n *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime\n *   value never ends with that text.\n * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's\n *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally\n *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in\n *   the type system and is never present at runtime.\n *\n * @beta\n */\nexport type StegaString<T extends string = string> =\n  `${T} (may contain hidden stega characters)` & {\n    readonly ' stegaBrand': T\n  }\n\n/**\n * Deeply brands the string properties of a query result as `StegaString`, marking them as\n * potentially containing stega-encoded data.\n *\n * String properties that the stega encoder is guaranteed to never encode keep their plain type:\n * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and\n *   so on), which also preserves discriminated union narrowing on `_type`\n * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued\n *   `slug` keys (covering `\"slug\": slug.current` projections)\n * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and\n *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay\n *   plain\n * - symbol-keyed properties (like TypeGen's `internalGroqTypeReferenceTo` reference marker): JSON\n *   can't contain symbol keys, so they only exist in the type system and are never encoded\n *\n * Every other string is assumed to be \"poisoned\", even if the runtime `filter` happens to skip it\n * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case\n * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.\n *\n * The `Key` and `ParentKey` type parameters track the key the current value is found under, and\n * the key of the object containing it, they're only used internally during recursion.\n *\n * @beta\n */\nexport type StegaBranded<\n  T,\n  Key extends PropertyKey = number,\n  ParentKey extends PropertyKey = number,\n> = 0 extends 1 & T\n  ? T\n  : T extends string\n    ? T extends {readonly ' stegaBrand': string}\n      ? T\n      : Key extends `_${string}` | 'slug' | symbol\n        ? T\n        : Key extends 'current'\n          ? ParentKey extends 'slug'\n            ? T\n            : StegaString<T>\n          : StegaString<T>\n    : T extends number | bigint | boolean | null | undefined\n      ? T\n      : T extends Date | RegExp | ((...args: never[]) => unknown)\n        ? T\n        : T extends readonly unknown[]\n          ? {[Index in keyof T]: StegaBranded<T[Index], number, number>}\n          : T extends {_type: 'block'}\n            ? {[K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]}\n            : T extends {_type: 'span'}\n              ? {[K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]}\n              : T extends object\n                ? {[K in keyof T]: StegaBranded<T[K], K, Key>}\n                : T\n\n/**\n * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use\n * as the first generic of `client.fetch` when stega is enabled:\n * ```ts\n * import {createClient} from '@sanity/client'\n * import type {ClientReturnStega} from '@sanity/client/stega'\n *\n * const query = '*[_type == \"post\"][0]'\n * const post = await client.fetch<ClientReturnStega<typeof query>>(query)\n * ```\n * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),\n * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to\n * `Fallback`, which defaults to `any`, just like `ClientReturn`.\n *\n * @beta\n */\nexport type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<\n  ClientReturn<GroqString, Fallback>\n>\n\n/**\n * Marks strings in an already fetched query result as potentially containing stega-encoded data,\n * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error\n * until they're cleaned with `stegaClean()`, which recovers the original type.\n *\n * This is an identity function, it only changes the type of the input, not its value.\n * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use\n * this function for data that has already been fetched.\n *\n * @beta\n */\nexport function stegaBrand<Result>(result: Result): StegaBranded<Result> {\n  return result as StegaBranded<Result>\n}\n","export * from '@sanity/client'\nimport {\n  createClient as originalCreateClient,\n  ObservableSanityClient,\n  requester as originalRequester,\n  SanityClient,\n} from '@sanity/client'\n\nexport {encodeIntoResult} from './encodeIntoResult'\nexport {type ClientReturnStega, stegaBrand, type StegaBranded, type StegaString} from './stegaBrand'\nexport {stegaClean, type StegaCleaned, vercelStegaCleanAll} from './stegaClean'\nexport {stegaEncodeSourceMap} from './stegaEncodeSourceMap'\nexport * from './types'\n\n/**\n * @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class SanityStegaClient extends SanityClient {}\n\n/**\n * @deprecated -- Use `import {ObservableSanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class ObservableSanityStegaClient extends ObservableSanityClient {}\n\n/**\n * @deprecated -- Use `import {requester} from '@sanity/client'` instead\n * @public\n */\nexport const requester = originalRequester\n\n/**\n * @deprecated -- Use `import {createClient} from '@sanity/client'` instead\n * @public\n */\nexport const createClient = originalCreateClient\n"],"names":["SanityClient","ObservableSanityClient","originalRequester","originalCreateClient"],"mappings":";;;AA8GO,SAAS,WAAmB,QAAsC;AACvE,SAAO;AACT;AC9FO,MAAM,0BAA0BA,OAAAA,aAAa;AAAC;AAM9C,MAAM,oCAAoCC,OAAAA,uBAAuB;AAAC;AAMlE,MAAM,YAAYC,OAAAA,WAMZ,eAAeC,OAAAA;;;;;;;;;;;;;;;;;;"}

package/dist/stega.browser.d.cts

@@ -417,14 +417,7 @@ export declare interface ArchiveReleaseAction {
 
 /** @public */
 export declare type AssetMetadataType =
-  | 'location'
-  | 'exif'
-  | 'image'
-  | 'palette'
-  | 'lqip'
-  | 'blurhash'
-  | 'thumbhash'
-  | 'none'
+  'location' | 'exif' | 'image' | 'palette' | 'lqip' | 'blurhash' | 'thumbhash' | 'none'
 
 /** @internal */
 export declare class AssetsClient {
@@ -866,11 +859,7 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | DeprecatedPreviewDrafts
-  | 'published'
-  | 'drafts'
-  | 'raw'
-  | StackablePerspective[]
+  DeprecatedPreviewDrafts | 'published' | 'drafts' | 'raw' | StackablePerspective[]
 
 /** @public */
 export declare type ClientReturn<
@@ -1041,14 +1030,12 @@ declare interface ContentSourceMapDocumentBase_2 {
 
 /** @public */
 export declare type ContentSourceMapDocuments = (
-  | ContentSourceMapDocument
-  | ContentSourceMapRemoteDocument
+  ContentSourceMapDocument | ContentSourceMapRemoteDocument
 )[]
 
 /** @public */
 declare type ContentSourceMapDocuments_2 = (
-  | ContentSourceMapDocument_2
-  | ContentSourceMapRemoteDocument_2
+  ContentSourceMapDocument_2 | ContentSourceMapRemoteDocument_2
 )[]
 
 /**
@@ -1101,9 +1088,7 @@ declare type ContentSourceMapMappings_2 = Record<string, ContentSourceMapMapping
 
 /** @alpha */
 export declare type ContentSourceMapParsedPath = (
-  | string
-  | number
-  | ContentSourceMapParsedPathKeyedSegment
+  string | number | ContentSourceMapParsedPathKeyedSegment
 )[]
 
 /** @alpha */
@@ -1120,8 +1105,7 @@ declare type ContentSourceMapPaths_2 = string[]
 
 /** @public */
 export declare type ContentSourceMapQueryResponse =
-  | RawQueryResponse<unknown>
-  | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
+  RawQueryResponse<unknown> | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
 
 /** @public */
 export declare interface ContentSourceMapRemoteDocument extends ContentSourceMapDocumentBase {
@@ -1775,8 +1759,7 @@ export declare function formatQueryParseError(
 
 /** @beta */
 declare type GenerateAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionAsync
@@ -1795,8 +1778,7 @@ declare interface GenerateExistingDocumentRequest {
 
 /** @beta */
 export declare type GenerateInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  | GenerateSyncInstruction<T>
-  | GenerateAsyncInstruction<T>
+  GenerateSyncInstruction<T> | GenerateAsyncInstruction<T>
 
 /**  @beta */
 export declare type GenerateOperation = 'set' | 'append' | 'mixed'
@@ -1927,8 +1909,7 @@ declare interface GenerateRequestBase extends AgentActionRequestBase {
 
 /** @beta */
 declare type GenerateSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionSync
@@ -2275,12 +2256,7 @@ export declare function _listen<
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any> = Record<string, Any>> =
-  | MutationEvent<R>
-  | ReconnectEvent
-  | WelcomeBackEvent
-  | ResetEvent
-  | WelcomeEvent
-  | OpenEvent
+  MutationEvent<R> | ReconnectEvent | WelcomeBackEvent | ResetEvent | WelcomeEvent | OpenEvent
 
 /**
  * Maps a ListenOptions object and returns the Listen events opted for, e.g:
@@ -2420,11 +2396,7 @@ export declare class LiveClient {
 
 /** @public */
 export declare type LiveEvent =
-  | LiveEventRestart
-  | LiveEventReconnect
-  | LiveEventMessage
-  | LiveEventWelcome
-  | LiveEventGoAway
+  LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome | LiveEventGoAway
 
 /**
  * The `id` field is the position at which the connection was rejected or closed.
@@ -2486,8 +2458,7 @@ declare type Logger_2 =
 declare type MapListenEventNamesToListenEvents<
   R extends Record<string, Any> = Record<string, Any>,
   Events extends (ResumableListenEventNames | ListenEventName)[] = (
-    | ResumableListenEventNames
-    | ListenEventName
+    ResumableListenEventNames | ListenEventName
   )[],
 > = Events extends (infer E)[]
   ? E extends 'welcome'
@@ -4214,21 +4185,18 @@ export declare type PatchBuilder = (patch: Patch) => Patch
 
 /** @beta */
 export declare type PatchDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | PatchDocumentSync<T>
-  | PatchDocumentAsync<T>
+  PatchDocumentSync<T> | PatchDocumentAsync<T>
 
 /** @beta */
 declare type PatchDocumentAsync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionAsync
 
 /** @beta */
 declare type PatchDocumentSync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionSync
@@ -4394,8 +4362,7 @@ declare interface PromptJsonResponse<T extends Record<string, Any> = Record<stri
 
 /** @beta */
 export declare type PromptRequest<T extends Record<string, Any> = Record<string, Any>> = (
-  | PromptTextResponse
-  | PromptJsonResponse<T>
+  PromptTextResponse | PromptJsonResponse<T>
 ) &
   PromptRequestBase
 
@@ -4540,9 +4507,7 @@ export declare interface PublishReleaseAction {
 
 /** @public */
 export declare type QueryOptions =
-  | FilteredResponseQueryOptions
-  | UnfilteredResponseQueryOptions
-  | UnfilteredResponseWithoutQuery
+  FilteredResponseQueryOptions | UnfilteredResponseQueryOptions | UnfilteredResponseWithoutQuery
 
 /** @public */
 export declare interface QueryParams {
@@ -5185,8 +5150,10 @@ export declare type ResumableListenEventNames =
   | 'reset'
 
 /** @public */
-export declare interface ResumableListenOptions
-  extends Omit<ListenOptions, 'events' | 'enableResume'> {
+export declare interface ResumableListenOptions extends Omit<
+  ListenOptions,
+  'events' | 'enableResume'
+> {
   /**
    * If this is enabled, the client will normally resume events upon reconnect
    * Note that you should also subscribe to `reset`-events and handle the case where the backend is unable to resume
@@ -6213,6 +6180,8 @@ export declare function stegaBrand<Result>(result: Result): StegaBranded<Result>
  * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and
  *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay
  *   plain
+ * - symbol-keyed properties (like TypeGen's `internalGroqTypeReferenceTo` reference marker): JSON
+ *   can't contain symbol keys, so they only exist in the type system and are never encoded
  *
  * Every other string is assumed to be "poisoned", even if the runtime `filter` happens to skip it
  * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case
@@ -6234,7 +6203,7 @@ export declare type StegaBranded<
         readonly ' stegaBrand': string
       }
       ? T
-      : Key extends `_${string}` | 'slug'
+      : Key extends `_${string}` | 'slug' | symbol
         ? T
         : Key extends 'current'
           ? ParentKey extends 'slug'
@@ -6426,10 +6395,7 @@ export declare type StudioBaseRoute = {
 
 /** @alpha */
 export declare type StudioBaseUrl =
-  | `/${string}`
-  | `${string}.sanity.studio`
-  | `https://${string}`
-  | string
+  `/${string}` | `${string}.sanity.studio` | `https://${string}` | string
 
 /** @alpha */
 export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
@@ -6553,8 +6519,7 @@ export declare type TransactionMutationOptions =
 
 /** @beta */
 export declare type TransformDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TransformDocumentSync<T>
-  | TransformDocumentAsync
+  TransformDocumentSync<T> | TransformDocumentAsync
 
 /** @beta */
 declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
@@ -6818,8 +6783,7 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
 
 /** @beta */
 export declare type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TranslateDocumentSync<T>
-  | TranslateDocumentAsync
+  TranslateDocumentSync<T> | TranslateDocumentAsync
 
 /** @beta */
 declare type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
@@ -7104,10 +7068,7 @@ export declare const vercelStegaCleanAll: typeof stegaClean
 
 /** @public */
 export declare type VersionAction =
-  | CreateVersionAction
-  | DiscardVersionAction
-  | ReplaceVersionAction
-  | UnpublishVersionAction
+  CreateVersionAction | DiscardVersionAction | ReplaceVersionAction | UnpublishVersionAction
 
 /** @public */
 export declare interface VideoPlaybackInfo<
@@ -7132,8 +7093,7 @@ export declare interface VideoPlaybackInfo<
 
 /** @public */
 export declare type VideoPlaybackInfoItem =
-  | VideoPlaybackInfoItemPublic
-  | VideoPlaybackInfoItemSigned
+  VideoPlaybackInfoItemPublic | VideoPlaybackInfoItemSigned
 
 /** @public */
 export declare interface VideoPlaybackInfoItemPublic {

package/dist/stega.browser.d.ts

@@ -417,14 +417,7 @@ export declare interface ArchiveReleaseAction {
 
 /** @public */
 export declare type AssetMetadataType =
-  | 'location'
-  | 'exif'
-  | 'image'
-  | 'palette'
-  | 'lqip'
-  | 'blurhash'
-  | 'thumbhash'
-  | 'none'
+  'location' | 'exif' | 'image' | 'palette' | 'lqip' | 'blurhash' | 'thumbhash' | 'none'
 
 /** @internal */
 export declare class AssetsClient {
@@ -866,11 +859,7 @@ export declare class ClientError extends Error {
 
 /** @public */
 export declare type ClientPerspective =
-  | DeprecatedPreviewDrafts
-  | 'published'
-  | 'drafts'
-  | 'raw'
-  | StackablePerspective[]
+  DeprecatedPreviewDrafts | 'published' | 'drafts' | 'raw' | StackablePerspective[]
 
 /** @public */
 export declare type ClientReturn<
@@ -1041,14 +1030,12 @@ declare interface ContentSourceMapDocumentBase_2 {
 
 /** @public */
 export declare type ContentSourceMapDocuments = (
-  | ContentSourceMapDocument
-  | ContentSourceMapRemoteDocument
+  ContentSourceMapDocument | ContentSourceMapRemoteDocument
 )[]
 
 /** @public */
 declare type ContentSourceMapDocuments_2 = (
-  | ContentSourceMapDocument_2
-  | ContentSourceMapRemoteDocument_2
+  ContentSourceMapDocument_2 | ContentSourceMapRemoteDocument_2
 )[]
 
 /**
@@ -1101,9 +1088,7 @@ declare type ContentSourceMapMappings_2 = Record<string, ContentSourceMapMapping
 
 /** @alpha */
 export declare type ContentSourceMapParsedPath = (
-  | string
-  | number
-  | ContentSourceMapParsedPathKeyedSegment
+  string | number | ContentSourceMapParsedPathKeyedSegment
 )[]
 
 /** @alpha */
@@ -1120,8 +1105,7 @@ declare type ContentSourceMapPaths_2 = string[]
 
 /** @public */
 export declare type ContentSourceMapQueryResponse =
-  | RawQueryResponse<unknown>
-  | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
+  RawQueryResponse<unknown> | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>
 
 /** @public */
 export declare interface ContentSourceMapRemoteDocument extends ContentSourceMapDocumentBase {
@@ -1775,8 +1759,7 @@ export declare function formatQueryParseError(
 
 /** @beta */
 declare type GenerateAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionAsync
@@ -1795,8 +1778,7 @@ declare interface GenerateExistingDocumentRequest {
 
 /** @beta */
 export declare type GenerateInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  | GenerateSyncInstruction<T>
-  | GenerateAsyncInstruction<T>
+  GenerateSyncInstruction<T> | GenerateAsyncInstruction<T>
 
 /**  @beta */
 export declare type GenerateOperation = 'set' | 'append' | 'mixed'
@@ -1927,8 +1909,7 @@ declare interface GenerateRequestBase extends AgentActionRequestBase {
 
 /** @beta */
 declare type GenerateSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | GenerateExistingDocumentRequest
-  | GenerateTargetDocumentRequest<T>
+  GenerateExistingDocumentRequest | GenerateTargetDocumentRequest<T>
 ) &
   GenerateRequestBase &
   AgentActionSync
@@ -2275,12 +2256,7 @@ export declare function _listen<
 
 /** @public */
 export declare type ListenEvent<R extends Record<string, Any> = Record<string, Any>> =
-  | MutationEvent<R>
-  | ReconnectEvent
-  | WelcomeBackEvent
-  | ResetEvent
-  | WelcomeEvent
-  | OpenEvent
+  MutationEvent<R> | ReconnectEvent | WelcomeBackEvent | ResetEvent | WelcomeEvent | OpenEvent
 
 /**
  * Maps a ListenOptions object and returns the Listen events opted for, e.g:
@@ -2420,11 +2396,7 @@ export declare class LiveClient {
 
 /** @public */
 export declare type LiveEvent =
-  | LiveEventRestart
-  | LiveEventReconnect
-  | LiveEventMessage
-  | LiveEventWelcome
-  | LiveEventGoAway
+  LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome | LiveEventGoAway
 
 /**
  * The `id` field is the position at which the connection was rejected or closed.
@@ -2486,8 +2458,7 @@ declare type Logger_2 =
 declare type MapListenEventNamesToListenEvents<
   R extends Record<string, Any> = Record<string, Any>,
   Events extends (ResumableListenEventNames | ListenEventName)[] = (
-    | ResumableListenEventNames
-    | ListenEventName
+    ResumableListenEventNames | ListenEventName
   )[],
 > = Events extends (infer E)[]
   ? E extends 'welcome'
@@ -4214,21 +4185,18 @@ export declare type PatchBuilder = (patch: Patch) => Patch
 
 /** @beta */
 export declare type PatchDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | PatchDocumentSync<T>
-  | PatchDocumentAsync<T>
+  PatchDocumentSync<T> | PatchDocumentAsync<T>
 
 /** @beta */
 declare type PatchDocumentAsync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionAsync
 
 /** @beta */
 declare type PatchDocumentSync<T extends Record<string, Any> = Record<string, Any>> = (
-  | PatchExistingDocumentRequest
-  | PatchTargetDocumentRequest<T>
+  PatchExistingDocumentRequest | PatchTargetDocumentRequest<T>
 ) &
   PatchRequestBase &
   AgentActionSync
@@ -4394,8 +4362,7 @@ declare interface PromptJsonResponse<T extends Record<string, Any> = Record<stri
 
 /** @beta */
 export declare type PromptRequest<T extends Record<string, Any> = Record<string, Any>> = (
-  | PromptTextResponse
-  | PromptJsonResponse<T>
+  PromptTextResponse | PromptJsonResponse<T>
 ) &
   PromptRequestBase
 
@@ -4540,9 +4507,7 @@ export declare interface PublishReleaseAction {
 
 /** @public */
 export declare type QueryOptions =
-  | FilteredResponseQueryOptions
-  | UnfilteredResponseQueryOptions
-  | UnfilteredResponseWithoutQuery
+  FilteredResponseQueryOptions | UnfilteredResponseQueryOptions | UnfilteredResponseWithoutQuery
 
 /** @public */
 export declare interface QueryParams {
@@ -5185,8 +5150,10 @@ export declare type ResumableListenEventNames =
   | 'reset'
 
 /** @public */
-export declare interface ResumableListenOptions
-  extends Omit<ListenOptions, 'events' | 'enableResume'> {
+export declare interface ResumableListenOptions extends Omit<
+  ListenOptions,
+  'events' | 'enableResume'
+> {
   /**
    * If this is enabled, the client will normally resume events upon reconnect
    * Note that you should also subscribe to `reset`-events and handle the case where the backend is unable to resume
@@ -6213,6 +6180,8 @@ export declare function stegaBrand<Result>(result: Result): StegaBranded<Result>
  * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and
  *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay
  *   plain
+ * - symbol-keyed properties (like TypeGen's `internalGroqTypeReferenceTo` reference marker): JSON
+ *   can't contain symbol keys, so they only exist in the type system and are never encoded
  *
  * Every other string is assumed to be "poisoned", even if the runtime `filter` happens to skip it
  * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case
@@ -6234,7 +6203,7 @@ export declare type StegaBranded<
         readonly ' stegaBrand': string
       }
       ? T
-      : Key extends `_${string}` | 'slug'
+      : Key extends `_${string}` | 'slug' | symbol
         ? T
         : Key extends 'current'
           ? ParentKey extends 'slug'
@@ -6426,10 +6395,7 @@ export declare type StudioBaseRoute = {
 
 /** @alpha */
 export declare type StudioBaseUrl =
-  | `/${string}`
-  | `${string}.sanity.studio`
-  | `https://${string}`
-  | string
+  `/${string}` | `${string}.sanity.studio` | `https://${string}` | string
 
 /** @alpha */
 export declare type StudioUrl = StudioBaseUrl | StudioBaseRoute
@@ -6553,8 +6519,7 @@ export declare type TransactionMutationOptions =
 
 /** @beta */
 export declare type TransformDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TransformDocumentSync<T>
-  | TransformDocumentAsync
+  TransformDocumentSync<T> | TransformDocumentAsync
 
 /** @beta */
 declare type TransformDocumentAsync = TransformRequestBase & AgentActionAsync
@@ -6818,8 +6783,7 @@ export declare interface TransformTargetInclude extends AgentActionTargetInclude
 
 /** @beta */
 export declare type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> =
-  | TranslateDocumentSync<T>
-  | TranslateDocumentAsync
+  TranslateDocumentSync<T> | TranslateDocumentAsync
 
 /** @beta */
 declare type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync
@@ -7104,10 +7068,7 @@ export declare const vercelStegaCleanAll: typeof stegaClean
 
 /** @public */
 export declare type VersionAction =
-  | CreateVersionAction
-  | DiscardVersionAction
-  | ReplaceVersionAction
-  | UnpublishVersionAction
+  CreateVersionAction | DiscardVersionAction | ReplaceVersionAction | UnpublishVersionAction
 
 /** @public */
 export declare interface VideoPlaybackInfo<
@@ -7132,8 +7093,7 @@ export declare interface VideoPlaybackInfo<
 
 /** @public */
 export declare type VideoPlaybackInfoItem =
-  | VideoPlaybackInfoItemPublic
-  | VideoPlaybackInfoItemSigned
+  VideoPlaybackInfoItemPublic | VideoPlaybackInfoItemSigned
 
 /** @public */
 export declare interface VideoPlaybackInfoItemPublic {

package/dist/stega.browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"stega.browser.js","sources":["../src/stega/stegaBrand.ts","../src/stega/index.ts"],"sourcesContent":["import type {Any, ClientReturn} from '@sanity/client'\n\n/**\n * A string that might contain stega-encoded data, and is unsafe to compare against string literals\n * until it's been cleaned with `stegaClean()`.\n *\n * The type intersects a template literal that has a human readable suffix, with a brand property\n * that holds the original string type:\n * - The suffix makes TypeScript report \"This comparison appears to be unintentional\" (TS2367) when\n *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to\n *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,\n *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime\n *   value never ends with that text.\n * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's\n *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally\n *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in\n *   the type system and is never present at runtime.\n *\n * @beta\n */\nexport type StegaString<T extends string = string> =\n  `${T} (may contain hidden stega characters)` & {\n    readonly ' stegaBrand': T\n  }\n\n/**\n * Deeply brands the string properties of a query result as `StegaString`, marking them as\n * potentially containing stega-encoded data.\n *\n * String properties that the stega encoder is guaranteed to never encode keep their plain type:\n * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and\n *   so on), which also preserves discriminated union narrowing on `_type`\n * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued\n *   `slug` keys (covering `\"slug\": slug.current` projections)\n * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and\n *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay\n *   plain\n *\n * Every other string is assumed to be \"poisoned\", even if the runtime `filter` happens to skip it\n * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case\n * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.\n *\n * The `Key` and `ParentKey` type parameters track the key the current value is found under, and\n * the key of the object containing it, they're only used internally during recursion.\n *\n * @beta\n */\nexport type StegaBranded<\n  T,\n  Key extends PropertyKey = number,\n  ParentKey extends PropertyKey = number,\n> = 0 extends 1 & T\n  ? T\n  : T extends string\n    ? T extends {readonly ' stegaBrand': string}\n      ? T\n      : Key extends `_${string}` | 'slug'\n        ? T\n        : Key extends 'current'\n          ? ParentKey extends 'slug'\n            ? T\n            : StegaString<T>\n          : StegaString<T>\n    : T extends number | bigint | boolean | null | undefined\n      ? T\n      : T extends Date | RegExp | ((...args: never[]) => unknown)\n        ? T\n        : T extends readonly unknown[]\n          ? {[Index in keyof T]: StegaBranded<T[Index], number, number>}\n          : T extends {_type: 'block'}\n            ? {[K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]}\n            : T extends {_type: 'span'}\n              ? {[K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]}\n              : T extends object\n                ? {[K in keyof T]: StegaBranded<T[K], K, Key>}\n                : T\n\n/**\n * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use\n * as the first generic of `client.fetch` when stega is enabled:\n * ```ts\n * import {createClient} from '@sanity/client'\n * import type {ClientReturnStega} from '@sanity/client/stega'\n *\n * const query = '*[_type == \"post\"][0]'\n * const post = await client.fetch<ClientReturnStega<typeof query>>(query)\n * ```\n * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),\n * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to\n * `Fallback`, which defaults to `any`, just like `ClientReturn`.\n *\n * @beta\n */\nexport type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<\n  ClientReturn<GroqString, Fallback>\n>\n\n/**\n * Marks strings in an already fetched query result as potentially containing stega-encoded data,\n * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error\n * until they're cleaned with `stegaClean()`, which recovers the original type.\n *\n * This is an identity function, it only changes the type of the input, not its value.\n * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use\n * this function for data that has already been fetched.\n *\n * @beta\n */\nexport function stegaBrand<Result>(result: Result): StegaBranded<Result> {\n  return result as StegaBranded<Result>\n}\n","export * from '@sanity/client'\nimport {\n  createClient as originalCreateClient,\n  ObservableSanityClient,\n  requester as originalRequester,\n  SanityClient,\n} from '@sanity/client'\n\nexport {encodeIntoResult} from './encodeIntoResult'\nexport {type ClientReturnStega, stegaBrand, type StegaBranded, type StegaString} from './stegaBrand'\nexport {stegaClean, type StegaCleaned, vercelStegaCleanAll} from './stegaClean'\nexport {stegaEncodeSourceMap} from './stegaEncodeSourceMap'\nexport * from './types'\n\n/**\n * @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class SanityStegaClient extends SanityClient {}\n\n/**\n * @deprecated -- Use `import {ObservableSanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class ObservableSanityStegaClient extends ObservableSanityClient {}\n\n/**\n * @deprecated -- Use `import {requester} from '@sanity/client'` instead\n * @public\n */\nexport const requester = originalRequester\n\n/**\n * @deprecated -- Use `import {createClient} from '@sanity/client'` instead\n * @public\n */\nexport const createClient = originalCreateClient\n"],"names":["originalRequester","originalCreateClient"],"mappings":";;;;AA4GO,SAAS,WAAmB,QAAsC;AACvE,SAAO;AACT;AC5FO,MAAM,0BAA0B,aAAa;AAAC;AAM9C,MAAM,oCAAoC,uBAAuB;AAAC;AAMlE,MAAM,YAAYA,aAMZ,eAAeC;"}
+{"version":3,"file":"stega.browser.js","sources":["../src/stega/stegaBrand.ts","../src/stega/index.ts"],"sourcesContent":["import type {Any, ClientReturn} from '@sanity/client'\n\n/**\n * A string that might contain stega-encoded data, and is unsafe to compare against string literals\n * until it's been cleaned with `stegaClean()`.\n *\n * The type intersects a template literal that has a human readable suffix, with a brand property\n * that holds the original string type:\n * - The suffix makes TypeScript report \"This comparison appears to be unintentional\" (TS2367) when\n *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to\n *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,\n *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime\n *   value never ends with that text.\n * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's\n *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally\n *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in\n *   the type system and is never present at runtime.\n *\n * @beta\n */\nexport type StegaString<T extends string = string> =\n  `${T} (may contain hidden stega characters)` & {\n    readonly ' stegaBrand': T\n  }\n\n/**\n * Deeply brands the string properties of a query result as `StegaString`, marking them as\n * potentially containing stega-encoded data.\n *\n * String properties that the stega encoder is guaranteed to never encode keep their plain type:\n * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and\n *   so on), which also preserves discriminated union narrowing on `_type`\n * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued\n *   `slug` keys (covering `\"slug\": slug.current` projections)\n * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and\n *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay\n *   plain\n * - symbol-keyed properties (like TypeGen's `internalGroqTypeReferenceTo` reference marker): JSON\n *   can't contain symbol keys, so they only exist in the type system and are never encoded\n *\n * Every other string is assumed to be \"poisoned\", even if the runtime `filter` happens to skip it\n * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case\n * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.\n *\n * The `Key` and `ParentKey` type parameters track the key the current value is found under, and\n * the key of the object containing it, they're only used internally during recursion.\n *\n * @beta\n */\nexport type StegaBranded<\n  T,\n  Key extends PropertyKey = number,\n  ParentKey extends PropertyKey = number,\n> = 0 extends 1 & T\n  ? T\n  : T extends string\n    ? T extends {readonly ' stegaBrand': string}\n      ? T\n      : Key extends `_${string}` | 'slug' | symbol\n        ? T\n        : Key extends 'current'\n          ? ParentKey extends 'slug'\n            ? T\n            : StegaString<T>\n          : StegaString<T>\n    : T extends number | bigint | boolean | null | undefined\n      ? T\n      : T extends Date | RegExp | ((...args: never[]) => unknown)\n        ? T\n        : T extends readonly unknown[]\n          ? {[Index in keyof T]: StegaBranded<T[Index], number, number>}\n          : T extends {_type: 'block'}\n            ? {[K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]}\n            : T extends {_type: 'span'}\n              ? {[K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]}\n              : T extends object\n                ? {[K in keyof T]: StegaBranded<T[K], K, Key>}\n                : T\n\n/**\n * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use\n * as the first generic of `client.fetch` when stega is enabled:\n * ```ts\n * import {createClient} from '@sanity/client'\n * import type {ClientReturnStega} from '@sanity/client/stega'\n *\n * const query = '*[_type == \"post\"][0]'\n * const post = await client.fetch<ClientReturnStega<typeof query>>(query)\n * ```\n * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),\n * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to\n * `Fallback`, which defaults to `any`, just like `ClientReturn`.\n *\n * @beta\n */\nexport type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<\n  ClientReturn<GroqString, Fallback>\n>\n\n/**\n * Marks strings in an already fetched query result as potentially containing stega-encoded data,\n * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error\n * until they're cleaned with `stegaClean()`, which recovers the original type.\n *\n * This is an identity function, it only changes the type of the input, not its value.\n * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use\n * this function for data that has already been fetched.\n *\n * @beta\n */\nexport function stegaBrand<Result>(result: Result): StegaBranded<Result> {\n  return result as StegaBranded<Result>\n}\n","export * from '@sanity/client'\nimport {\n  createClient as originalCreateClient,\n  ObservableSanityClient,\n  requester as originalRequester,\n  SanityClient,\n} from '@sanity/client'\n\nexport {encodeIntoResult} from './encodeIntoResult'\nexport {type ClientReturnStega, stegaBrand, type StegaBranded, type StegaString} from './stegaBrand'\nexport {stegaClean, type StegaCleaned, vercelStegaCleanAll} from './stegaClean'\nexport {stegaEncodeSourceMap} from './stegaEncodeSourceMap'\nexport * from './types'\n\n/**\n * @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class SanityStegaClient extends SanityClient {}\n\n/**\n * @deprecated -- Use `import {ObservableSanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class ObservableSanityStegaClient extends ObservableSanityClient {}\n\n/**\n * @deprecated -- Use `import {requester} from '@sanity/client'` instead\n * @public\n */\nexport const requester = originalRequester\n\n/**\n * @deprecated -- Use `import {createClient} from '@sanity/client'` instead\n * @public\n */\nexport const createClient = originalCreateClient\n"],"names":["originalRequester","originalCreateClient"],"mappings":";;;;AA8GO,SAAS,WAAmB,QAAsC;AACvE,SAAO;AACT;AC9FO,MAAM,0BAA0B,aAAa;AAAC;AAM9C,MAAM,oCAAoC,uBAAuB;AAAC;AAMlE,MAAM,YAAYA,aAMZ,eAAeC;"}

package/dist/stega.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"stega.cjs","sources":["../src/stega/stegaBrand.ts","../src/stega/index.ts"],"sourcesContent":["import type {Any, ClientReturn} from '@sanity/client'\n\n/**\n * A string that might contain stega-encoded data, and is unsafe to compare against string literals\n * until it's been cleaned with `stegaClean()`.\n *\n * The type intersects a template literal that has a human readable suffix, with a brand property\n * that holds the original string type:\n * - The suffix makes TypeScript report \"This comparison appears to be unintentional\" (TS2367) when\n *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to\n *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,\n *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime\n *   value never ends with that text.\n * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's\n *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally\n *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in\n *   the type system and is never present at runtime.\n *\n * @beta\n */\nexport type StegaString<T extends string = string> =\n  `${T} (may contain hidden stega characters)` & {\n    readonly ' stegaBrand': T\n  }\n\n/**\n * Deeply brands the string properties of a query result as `StegaString`, marking them as\n * potentially containing stega-encoded data.\n *\n * String properties that the stega encoder is guaranteed to never encode keep their plain type:\n * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and\n *   so on), which also preserves discriminated union narrowing on `_type`\n * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued\n *   `slug` keys (covering `\"slug\": slug.current` projections)\n * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and\n *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay\n *   plain\n *\n * Every other string is assumed to be \"poisoned\", even if the runtime `filter` happens to skip it\n * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case\n * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.\n *\n * The `Key` and `ParentKey` type parameters track the key the current value is found under, and\n * the key of the object containing it, they're only used internally during recursion.\n *\n * @beta\n */\nexport type StegaBranded<\n  T,\n  Key extends PropertyKey = number,\n  ParentKey extends PropertyKey = number,\n> = 0 extends 1 & T\n  ? T\n  : T extends string\n    ? T extends {readonly ' stegaBrand': string}\n      ? T\n      : Key extends `_${string}` | 'slug'\n        ? T\n        : Key extends 'current'\n          ? ParentKey extends 'slug'\n            ? T\n            : StegaString<T>\n          : StegaString<T>\n    : T extends number | bigint | boolean | null | undefined\n      ? T\n      : T extends Date | RegExp | ((...args: never[]) => unknown)\n        ? T\n        : T extends readonly unknown[]\n          ? {[Index in keyof T]: StegaBranded<T[Index], number, number>}\n          : T extends {_type: 'block'}\n            ? {[K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]}\n            : T extends {_type: 'span'}\n              ? {[K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]}\n              : T extends object\n                ? {[K in keyof T]: StegaBranded<T[K], K, Key>}\n                : T\n\n/**\n * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use\n * as the first generic of `client.fetch` when stega is enabled:\n * ```ts\n * import {createClient} from '@sanity/client'\n * import type {ClientReturnStega} from '@sanity/client/stega'\n *\n * const query = '*[_type == \"post\"][0]'\n * const post = await client.fetch<ClientReturnStega<typeof query>>(query)\n * ```\n * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),\n * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to\n * `Fallback`, which defaults to `any`, just like `ClientReturn`.\n *\n * @beta\n */\nexport type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<\n  ClientReturn<GroqString, Fallback>\n>\n\n/**\n * Marks strings in an already fetched query result as potentially containing stega-encoded data,\n * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error\n * until they're cleaned with `stegaClean()`, which recovers the original type.\n *\n * This is an identity function, it only changes the type of the input, not its value.\n * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use\n * this function for data that has already been fetched.\n *\n * @beta\n */\nexport function stegaBrand<Result>(result: Result): StegaBranded<Result> {\n  return result as StegaBranded<Result>\n}\n","export * from '@sanity/client'\nimport {\n  createClient as originalCreateClient,\n  ObservableSanityClient,\n  requester as originalRequester,\n  SanityClient,\n} from '@sanity/client'\n\nexport {encodeIntoResult} from './encodeIntoResult'\nexport {type ClientReturnStega, stegaBrand, type StegaBranded, type StegaString} from './stegaBrand'\nexport {stegaClean, type StegaCleaned, vercelStegaCleanAll} from './stegaClean'\nexport {stegaEncodeSourceMap} from './stegaEncodeSourceMap'\nexport * from './types'\n\n/**\n * @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class SanityStegaClient extends SanityClient {}\n\n/**\n * @deprecated -- Use `import {ObservableSanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class ObservableSanityStegaClient extends ObservableSanityClient {}\n\n/**\n * @deprecated -- Use `import {requester} from '@sanity/client'` instead\n * @public\n */\nexport const requester = originalRequester\n\n/**\n * @deprecated -- Use `import {createClient} from '@sanity/client'` instead\n * @public\n */\nexport const createClient = originalCreateClient\n"],"names":["SanityClient","ObservableSanityClient","originalRequester","originalCreateClient"],"mappings":";;;AA4GO,SAAS,WAAmB,QAAsC;AACvE,SAAO;AACT;AC5FO,MAAM,0BAA0BA,OAAAA,aAAa;AAAC;AAM9C,MAAM,oCAAoCC,OAAAA,uBAAuB;AAAC;AAMlE,MAAM,YAAYC,OAAAA,WAMZ,eAAeC,OAAAA;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"stega.cjs","sources":["../src/stega/stegaBrand.ts","../src/stega/index.ts"],"sourcesContent":["import type {Any, ClientReturn} from '@sanity/client'\n\n/**\n * A string that might contain stega-encoded data, and is unsafe to compare against string literals\n * until it's been cleaned with `stegaClean()`.\n *\n * The type intersects a template literal that has a human readable suffix, with a brand property\n * that holds the original string type:\n * - The suffix makes TypeScript report \"This comparison appears to be unintentional\" (TS2367) when\n *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to\n *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,\n *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime\n *   value never ends with that text.\n * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's\n *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally\n *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in\n *   the type system and is never present at runtime.\n *\n * @beta\n */\nexport type StegaString<T extends string = string> =\n  `${T} (may contain hidden stega characters)` & {\n    readonly ' stegaBrand': T\n  }\n\n/**\n * Deeply brands the string properties of a query result as `StegaString`, marking them as\n * potentially containing stega-encoded data.\n *\n * String properties that the stega encoder is guaranteed to never encode keep their plain type:\n * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and\n *   so on), which also preserves discriminated union narrowing on `_type`\n * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued\n *   `slug` keys (covering `\"slug\": slug.current` projections)\n * - Portable Text internals: the encoder only visits `children` of `_type: 'block'` objects and\n *   `text` of `_type: 'span'` objects, so properties like `style`, `listItem` and `marks` stay\n *   plain\n * - symbol-keyed properties (like TypeGen's `internalGroqTypeReferenceTo` reference marker): JSON\n *   can't contain symbol keys, so they only exist in the type system and are never encoded\n *\n * Every other string is assumed to be \"poisoned\", even if the runtime `filter` happens to skip it\n * (URLs, dates, keys ending in `Id`, denylisted keys). Being conservative is safe: the worst case\n * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.\n *\n * The `Key` and `ParentKey` type parameters track the key the current value is found under, and\n * the key of the object containing it, they're only used internally during recursion.\n *\n * @beta\n */\nexport type StegaBranded<\n  T,\n  Key extends PropertyKey = number,\n  ParentKey extends PropertyKey = number,\n> = 0 extends 1 & T\n  ? T\n  : T extends string\n    ? T extends {readonly ' stegaBrand': string}\n      ? T\n      : Key extends `_${string}` | 'slug' | symbol\n        ? T\n        : Key extends 'current'\n          ? ParentKey extends 'slug'\n            ? T\n            : StegaString<T>\n          : StegaString<T>\n    : T extends number | bigint | boolean | null | undefined\n      ? T\n      : T extends Date | RegExp | ((...args: never[]) => unknown)\n        ? T\n        : T extends readonly unknown[]\n          ? {[Index in keyof T]: StegaBranded<T[Index], number, number>}\n          : T extends {_type: 'block'}\n            ? {[K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]}\n            : T extends {_type: 'span'}\n              ? {[K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]}\n              : T extends object\n                ? {[K in keyof T]: StegaBranded<T[K], K, Key>}\n                : T\n\n/**\n * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use\n * as the first generic of `client.fetch` when stega is enabled:\n * ```ts\n * import {createClient} from '@sanity/client'\n * import type {ClientReturnStega} from '@sanity/client/stega'\n *\n * const query = '*[_type == \"post\"][0]'\n * const post = await client.fetch<ClientReturnStega<typeof query>>(query)\n * ```\n * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),\n * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to\n * `Fallback`, which defaults to `any`, just like `ClientReturn`.\n *\n * @beta\n */\nexport type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<\n  ClientReturn<GroqString, Fallback>\n>\n\n/**\n * Marks strings in an already fetched query result as potentially containing stega-encoded data,\n * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error\n * until they're cleaned with `stegaClean()`, which recovers the original type.\n *\n * This is an identity function, it only changes the type of the input, not its value.\n * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use\n * this function for data that has already been fetched.\n *\n * @beta\n */\nexport function stegaBrand<Result>(result: Result): StegaBranded<Result> {\n  return result as StegaBranded<Result>\n}\n","export * from '@sanity/client'\nimport {\n  createClient as originalCreateClient,\n  ObservableSanityClient,\n  requester as originalRequester,\n  SanityClient,\n} from '@sanity/client'\n\nexport {encodeIntoResult} from './encodeIntoResult'\nexport {type ClientReturnStega, stegaBrand, type StegaBranded, type StegaString} from './stegaBrand'\nexport {stegaClean, type StegaCleaned, vercelStegaCleanAll} from './stegaClean'\nexport {stegaEncodeSourceMap} from './stegaEncodeSourceMap'\nexport * from './types'\n\n/**\n * @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class SanityStegaClient extends SanityClient {}\n\n/**\n * @deprecated -- Use `import {ObservableSanityClient} from '@sanity/client'` instead\n * @public\n */\nexport class ObservableSanityStegaClient extends ObservableSanityClient {}\n\n/**\n * @deprecated -- Use `import {requester} from '@sanity/client'` instead\n * @public\n */\nexport const requester = originalRequester\n\n/**\n * @deprecated -- Use `import {createClient} from '@sanity/client'` instead\n * @public\n */\nexport const createClient = originalCreateClient\n"],"names":["SanityClient","ObservableSanityClient","originalRequester","originalCreateClient"],"mappings":";;;AA8GO,SAAS,WAAmB,QAAsC;AACvE,SAAO;AACT;AC9FO,MAAM,0BAA0BA,OAAAA,aAAa;AAAC;AAM9C,MAAM,oCAAoCC,OAAAA,uBAAuB;AAAC;AAMlE,MAAM,YAAYC,OAAAA,WAMZ,eAAeC,OAAAA;;;;;;;;;;;;;;;;;;"}