@sanity/client 7.23.2 → 7.25.0

package/dist/stega.browser.cjs

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: !0 });
 var client = require("@sanity/client"), stegaEncodeSourceMap = require("./_chunks-cjs/stegaEncodeSourceMap.cjs"), stegaClean = require("./_chunks-cjs/stegaClean.cjs");
+function stegaBrand(result) {
+  return result;
+}
 class SanityStegaClient extends client.SanityClient {
 }
 class ObservableSanityStegaClient extends client.ObservableSanityClient {
@@ -14,6 +17,7 @@ exports.ObservableSanityStegaClient = ObservableSanityStegaClient;
 exports.SanityStegaClient = SanityStegaClient;
 exports.createClient = createClient;
 exports.requester = requester;
+exports.stegaBrand = stegaBrand;
 Object.keys(client).forEach(function(k) {
   k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k) && Object.defineProperty(exports, k, {
     enumerable: !0,

package/dist/stega.browser.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"stega.browser.cjs","sources":["../src/stega/index.ts"],"sourcesContent":["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 {stegaClean, 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":";;;AAiBO,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 *\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;;;;;;;;;;;;;;;;;;"}

package/dist/stega.browser.d.cts

@@ -719,6 +719,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -874,12 +878,44 @@ export declare type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
+/**
+ * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use
+ * as the first generic of `client.fetch` when stega is enabled:
+ * ```ts
+ * import {createClient} from '@sanity/client'
+ * import type {ClientReturnStega} from '@sanity/client/stega'
+ *
+ * const query = '*[_type == "post"][0]'
+ * const post = await client.fetch<ClientReturnStega<typeof query>>(query)
+ * ```
+ * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),
+ * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to
+ * `Fallback`, which defaults to `any`, just like `ClientReturn`.
+ *
+ * @beta
+ */
+export declare type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<
+  ClientReturn<GroqString, Fallback>
+>
+
 /**
  * @public
  * @deprecated -- use `ClientConfig` instead
  */
 export declare interface ClientStegaConfig extends ClientConfig {}
 
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariant = ClientVariantConditions | string
+
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariantConditions = Record<string, string>
+
 /**
  * Sanity API specific EventSource handler shared between the listen and live APIs
  *
@@ -4526,6 +4562,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   perspective?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  variant?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   query?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
@@ -5066,6 +5104,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -5114,6 +5156,10 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean
@@ -6142,12 +6188,118 @@ export declare interface SingleMutationResult {
 /** @public */
 export declare type StackablePerspective = ('published' | 'drafts' | string) & {}
 
+/**
+ * Marks strings in an already fetched query result as potentially containing stega-encoded data,
+ * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error
+ * until they're cleaned with `stegaClean()`, which recovers the original type.
+ *
+ * This is an identity function, it only changes the type of the input, not its value.
+ * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use
+ * this function for data that has already been fetched.
+ *
+ * @beta
+ */
+export declare function stegaBrand<Result>(result: Result): StegaBranded<Result>
+
+/**
+ * Deeply brands the string properties of a query result as `StegaString`, marking them as
+ * potentially containing stega-encoded data.
+ *
+ * String properties that the stega encoder is guaranteed to never encode keep their plain type:
+ * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and
+ *   so on), which also preserves discriminated union narrowing on `_type`
+ * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued
+ *   `slug` keys (covering `"slug": slug.current` projections)
+ * - 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
+ *
+ * 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
+ * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.
+ *
+ * The `Key` and `ParentKey` type parameters track the key the current value is found under, and
+ * the key of the object containing it, they're only used internally during recursion.
+ *
+ * @beta
+ */
+export declare type StegaBranded<
+  T,
+  Key extends PropertyKey = number,
+  ParentKey extends PropertyKey = number,
+> = 0 extends 1 & T
+  ? T
+  : T extends string
+    ? T extends {
+        readonly ' stegaBrand': string
+      }
+      ? T
+      : Key extends `_${string}` | 'slug'
+        ? T
+        : Key extends 'current'
+          ? ParentKey extends 'slug'
+            ? T
+            : StegaString<T>
+          : StegaString<T>
+    : T extends number | bigint | boolean | null | undefined
+      ? T
+      : T extends Date | RegExp | ((...args: never[]) => unknown)
+        ? T
+        : T extends readonly unknown[]
+          ? {
+              [Index in keyof T]: StegaBranded<T[Index], number, number>
+            }
+          : T extends {
+                _type: 'block'
+              }
+            ? {
+                [K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]
+              }
+            : T extends {
+                  _type: 'span'
+                }
+              ? {
+                  [K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]
+                }
+              : T extends object
+                ? {
+                    [K in keyof T]: StegaBranded<T[K], K, Key>
+                  }
+                : T
+
 /**
  * Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`
  * and remove all stega-encoded data from it.
+ * If the result type has strings branded as `StegaString` (by `ClientReturnStega` or `stegaBrand()`),
+ * the brand is stripped and the original string type is restored.
  * @public
  */
-export declare function stegaClean<Result = unknown>(result: Result): Result
+export declare function stegaClean<Result = unknown>(result: Result): StegaCleaned<Result>
+
+/**
+ * The result of removing stega-encoded data from a value with `stegaClean()`: strings that were
+ * branded as `StegaString` are returned to their original type, everything else is left as-is.
+ * @public
+ */
+export declare type StegaCleaned<T> = 0 extends 1 & T
+  ? T
+  : T extends {
+        readonly ' stegaBrand': infer Original extends string
+      }
+    ? Original
+    : T extends string | number | bigint | boolean | null | undefined
+      ? T
+      : T extends Date | RegExp | ((...args: never[]) => unknown)
+        ? T
+        : T extends readonly unknown[]
+          ? {
+              [Index in keyof T]: StegaCleaned<T[Index]>
+            }
+          : T extends object
+            ? {
+                [K in keyof T]: StegaCleaned<T[K]>
+              }
+            : T
 
 /** @public */
 export declare interface StegaConfig {
@@ -6227,6 +6379,29 @@ export declare function stegaEncodeSourceMap<Result = unknown>(
   config: InitializedStegaConfig_2,
 ): Result
 
+/**
+ * A string that might contain stega-encoded data, and is unsafe to compare against string literals
+ * until it's been cleaned with `stegaClean()`.
+ *
+ * The type intersects a template literal that has a human readable suffix, with a brand property
+ * that holds the original string type:
+ * - The suffix makes TypeScript report "This comparison appears to be unintentional" (TS2367) when
+ *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to
+ *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,
+ *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime
+ *   value never ends with that text.
+ * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's
+ *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally
+ *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in
+ *   the type system and is never present at runtime.
+ *
+ * @beta
+ */
+export declare type StegaString<T extends string = string> =
+  `${T} (may contain hidden stega characters)` & {
+    readonly ' stegaBrand': T
+  }
+
 /**
  * Allowed still image formats (thumbnail + storyboard).
  * @public

package/dist/stega.browser.d.ts

@@ -719,6 +719,10 @@ export declare interface ClientConfig {
    * @defaultValue 'published'
    */
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   apiHost?: string
   /**
      @remarks
@@ -874,12 +878,44 @@ export declare type ClientReturn<
   Fallback = Any,
 > = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback
 
+/**
+ * Drop-in replacement for `ClientReturn` that brands the result strings as `StegaString`, for use
+ * as the first generic of `client.fetch` when stega is enabled:
+ * ```ts
+ * import {createClient} from '@sanity/client'
+ * import type {ClientReturnStega} from '@sanity/client/stega'
+ *
+ * const query = '*[_type == "post"][0]'
+ * const post = await client.fetch<ClientReturnStega<typeof query>>(query)
+ * ```
+ * When the query is registered in the `SanityQueries` interface (for example by `sanity typegen`),
+ * the result type is looked up and deeply branded with `StegaBranded`. Otherwise it falls back to
+ * `Fallback`, which defaults to `any`, just like `ClientReturn`.
+ *
+ * @beta
+ */
+export declare type ClientReturnStega<GroqString extends string, Fallback = Any> = StegaBranded<
+  ClientReturn<GroqString, Fallback>
+>
+
 /**
  * @public
  * @deprecated -- use `ClientConfig` instead
  */
 export declare interface ClientStegaConfig extends ClientConfig {}
 
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariant = ClientVariantConditions | string
+
+/**
+ * @public
+ * @beta
+ */
+export declare type ClientVariantConditions = Record<string, string>
+
 /**
  * Sanity API specific EventSource handler shared between the listen and live APIs
  *
@@ -4526,6 +4562,8 @@ export declare interface QueryParams {
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   perspective?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
+  variant?: never
+  /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   query?: never
   /** @deprecated you're using a fetch option as a GROQ parameter, this is likely a mistake */
   resultSourceMap?: never
@@ -5066,6 +5104,10 @@ export declare interface RequestObservableOptions extends Omit<RequestOptions, '
   returnQuery?: boolean
   resultSourceMap?: boolean | 'withKeyArraySelector'
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   lastLiveEventId?: string
   cacheMode?: 'noStale'
 }
@@ -5114,6 +5156,10 @@ export declare interface ResponseEvent<T = unknown> {
 /** @public */
 export declare interface ResponseQueryOptions extends RequestOptions {
   perspective?: ClientPerspective
+  /**
+   * @beta
+   */
+  variant?: ClientVariant
   resultSourceMap?: boolean | 'withKeyArraySelector'
   returnQuery?: boolean
   useCdn?: boolean
@@ -6142,12 +6188,118 @@ export declare interface SingleMutationResult {
 /** @public */
 export declare type StackablePerspective = ('published' | 'drafts' | string) & {}
 
+/**
+ * Marks strings in an already fetched query result as potentially containing stega-encoded data,
+ * by re-typing them as `StegaString`. Comparing branded strings to string literals is a type error
+ * until they're cleaned with `stegaClean()`, which recovers the original type.
+ *
+ * This is an identity function, it only changes the type of the input, not its value.
+ * Prefer passing `ClientReturnStega` as the first generic to `client.fetch` when possible, and use
+ * this function for data that has already been fetched.
+ *
+ * @beta
+ */
+export declare function stegaBrand<Result>(result: Result): StegaBranded<Result>
+
+/**
+ * Deeply brands the string properties of a query result as `StegaString`, marking them as
+ * potentially containing stega-encoded data.
+ *
+ * String properties that the stega encoder is guaranteed to never encode keep their plain type:
+ * - keys starting with `_` (`_id`, `_type`, `_createdAt`, `_updatedAt`, `_key`, `_ref`, `_rev` and
+ *   so on), which also preserves discriminated union narrowing on `_type`
+ * - `slug.current` patterns: a `current` key directly under a `slug` key, as well as string valued
+ *   `slug` keys (covering `"slug": slug.current` projections)
+ * - 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
+ *
+ * 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
+ * is a redundant `stegaClean()` call, whereas under-branding would hide real bugs.
+ *
+ * The `Key` and `ParentKey` type parameters track the key the current value is found under, and
+ * the key of the object containing it, they're only used internally during recursion.
+ *
+ * @beta
+ */
+export declare type StegaBranded<
+  T,
+  Key extends PropertyKey = number,
+  ParentKey extends PropertyKey = number,
+> = 0 extends 1 & T
+  ? T
+  : T extends string
+    ? T extends {
+        readonly ' stegaBrand': string
+      }
+      ? T
+      : Key extends `_${string}` | 'slug'
+        ? T
+        : Key extends 'current'
+          ? ParentKey extends 'slug'
+            ? T
+            : StegaString<T>
+          : StegaString<T>
+    : T extends number | bigint | boolean | null | undefined
+      ? T
+      : T extends Date | RegExp | ((...args: never[]) => unknown)
+        ? T
+        : T extends readonly unknown[]
+          ? {
+              [Index in keyof T]: StegaBranded<T[Index], number, number>
+            }
+          : T extends {
+                _type: 'block'
+              }
+            ? {
+                [K in keyof T]: K extends 'children' ? StegaBranded<T[K], K, Key> : T[K]
+              }
+            : T extends {
+                  _type: 'span'
+                }
+              ? {
+                  [K in keyof T]: K extends 'text' ? StegaBranded<T[K], K, Key> : T[K]
+                }
+              : T extends object
+                ? {
+                    [K in keyof T]: StegaBranded<T[K], K, Key>
+                  }
+                : T
+
 /**
  * Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`
  * and remove all stega-encoded data from it.
+ * If the result type has strings branded as `StegaString` (by `ClientReturnStega` or `stegaBrand()`),
+ * the brand is stripped and the original string type is restored.
  * @public
  */
-export declare function stegaClean<Result = unknown>(result: Result): Result
+export declare function stegaClean<Result = unknown>(result: Result): StegaCleaned<Result>
+
+/**
+ * The result of removing stega-encoded data from a value with `stegaClean()`: strings that were
+ * branded as `StegaString` are returned to their original type, everything else is left as-is.
+ * @public
+ */
+export declare type StegaCleaned<T> = 0 extends 1 & T
+  ? T
+  : T extends {
+        readonly ' stegaBrand': infer Original extends string
+      }
+    ? Original
+    : T extends string | number | bigint | boolean | null | undefined
+      ? T
+      : T extends Date | RegExp | ((...args: never[]) => unknown)
+        ? T
+        : T extends readonly unknown[]
+          ? {
+              [Index in keyof T]: StegaCleaned<T[Index]>
+            }
+          : T extends object
+            ? {
+                [K in keyof T]: StegaCleaned<T[K]>
+              }
+            : T
 
 /** @public */
 export declare interface StegaConfig {
@@ -6227,6 +6379,29 @@ export declare function stegaEncodeSourceMap<Result = unknown>(
   config: InitializedStegaConfig_2,
 ): Result
 
+/**
+ * A string that might contain stega-encoded data, and is unsafe to compare against string literals
+ * until it's been cleaned with `stegaClean()`.
+ *
+ * The type intersects a template literal that has a human readable suffix, with a brand property
+ * that holds the original string type:
+ * - The suffix makes TypeScript report "This comparison appears to be unintentional" (TS2367) when
+ *   the string is compared to a literal (`===`, `switch` cases), and makes it unassignable to
+ *   literal unions like `'left' | 'right'`, while keeping it assignable to `string` so rendering,
+ *   interpolation and string methods keep working. The suffix is a type-level fiction, the runtime
+ *   value never ends with that text.
+ * - The brand property preserves the original type so `stegaClean()` can recover it exactly. It's
+ *   a string-keyed property rather than a `unique symbol` so that branded types stay structurally
+ *   compatible across duplicated copies of `@sanity/client` in `node_modules`. It only exists in
+ *   the type system and is never present at runtime.
+ *
+ * @beta
+ */
+export declare type StegaString<T extends string = string> =
+  `${T} (may contain hidden stega characters)` & {
+    readonly ' stegaBrand': T
+  }
+
 /**
  * Allowed still image formats (thumbnail + storyboard).
  * @public

package/dist/stega.browser.js

@@ -2,6 +2,9 @@ import { createClient as createClient$1, requester as requester$1, ObservableSan
 export * from "@sanity/client";
 import { encodeIntoResult, stegaEncodeSourceMap } from "./_chunks-es/stegaEncodeSourceMap.js";
 import { stegaClean, vercelStegaCleanAll } from "./_chunks-es/stegaClean.js";
+function stegaBrand(result) {
+  return result;
+}
 class SanityStegaClient extends SanityClient {
 }
 class ObservableSanityStegaClient extends ObservableSanityClient {
@@ -13,6 +16,7 @@ export {
   createClient,
   encodeIntoResult,
   requester,
+  stegaBrand,
   stegaClean,
   stegaEncodeSourceMap,
   vercelStegaCleanAll

package/dist/stega.browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"stega.browser.js","sources":["../src/stega/index.ts"],"sourcesContent":["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 {stegaClean, 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":";;;;AAiBO,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 *\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;"}

package/dist/stega.cjs

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: !0 });
 var client = require("@sanity/client"), stegaEncodeSourceMap = require("./_chunks-cjs/stegaEncodeSourceMap.cjs"), stegaClean = require("./_chunks-cjs/stegaClean.cjs");
+function stegaBrand(result) {
+  return result;
+}
 class SanityStegaClient extends client.SanityClient {
 }
 class ObservableSanityStegaClient extends client.ObservableSanityClient {
@@ -14,6 +17,7 @@ exports.ObservableSanityStegaClient = ObservableSanityStegaClient;
 exports.SanityStegaClient = SanityStegaClient;
 exports.createClient = createClient;
 exports.requester = requester;
+exports.stegaBrand = stegaBrand;
 Object.keys(client).forEach(function(k) {
   k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k) && Object.defineProperty(exports, k, {
     enumerable: !0,

package/dist/stega.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"stega.cjs","sources":["../src/stega/index.ts"],"sourcesContent":["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 {stegaClean, 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":";;;AAiBO,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 *\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;;;;;;;;;;;;;;;;;;"}