@sanity/client 7.26.2 → 8.0.0

package/dist/stega.js

@@ -1,24 +1,31 @@
-import { createClient as createClient$1, requester as requester$1, ObservableSanityClient, SanityClient } from "@sanity/client";
+import { n as vercelStegaCleanAll, t as stegaClean } from "./stegaClean-C18wLWau.js";
+import { r as encodeIntoResult, t as stegaEncodeSourceMap } from "./stegaEncodeSourceMap-B2fGArSf.js";
+import { ObservableSanityClient, SanityClient, createClient as createClient$1, requester as requester$1 } from "@sanity/client";
 export * from "@sanity/client";
-import { encodeIntoResult, stegaEncodeSourceMap } from "./_chunks-es/stegaEncodeSourceMap.js";
-import { stegaClean, vercelStegaCleanAll } from "./_chunks-es/stegaClean.js";
+/**
+* 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
+*/
 function stegaBrand(result) {
-  return result;
-}
-class SanityStegaClient extends SanityClient {
-}
-class ObservableSanityStegaClient extends ObservableSanityClient {
+	return result;
 }
+/**
+* @deprecated -- Use `import {SanityClient} from '@sanity/client'` instead
+* @public
+*/
+var SanityStegaClient = class extends SanityClient {}, ObservableSanityStegaClient = class extends ObservableSanityClient {};
+/**
+* @deprecated -- Use `import {requester} from '@sanity/client'` instead
+* @public
+*/
 const requester = requester$1, createClient = createClient$1;
-export {
-  ObservableSanityStegaClient,
-  SanityStegaClient,
-  createClient,
-  encodeIntoResult,
-  requester,
-  stegaBrand,
-  stegaClean,
-  stegaEncodeSourceMap,
-  vercelStegaCleanAll
-};
-//# sourceMappingURL=stega.js.map
+export { ObservableSanityStegaClient, SanityStegaClient, createClient, encodeIntoResult, requester, stegaBrand, stegaClean, stegaEncodeSourceMap, vercelStegaCleanAll };
+
+//# sourceMappingURL=stega.js.map

package/dist/stega.js.map

@@ -1 +1 @@
-{"version":3,"file":"stega.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;"}
+{"version":3,"file":"stega.js","names":["originalRequester","originalCreateClient"],"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 {type ClientReturnStega, stegaBrand, type StegaBranded, type StegaString} from './stegaBrand'\nexport {stegaClean, type StegaCleaned, vercelStegaCleanAll} from './stegaClean'\nexport {encodeIntoResult, 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"],"mappings":";;;;;;;;;;;;;;;AA8GA,SAAgB,WAAmB,QAAsC;CACvE,OAAO;AACT;;;;;AC/FA,IAAa,oBAAb,cAAuC,aAAa,CAAC,GAMxC,8BAAb,cAAiD,uBAAuB,CAAC;;;;;AAMzE,MAAa,YAAYA,aAMZ,eAAeC"}

package/dist/stegaClean-C18wLWau.js

@@ -0,0 +1,21 @@
+import { t as w } from "./dist-Z8cIRxoB.js";
+/**
+* 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
+*/
+function stegaClean(result) {
+	return w(result);
+}
+/**
+* Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`
+* and remove all stega-encoded data from it.
+* @alpha
+* @deprecated Use `stegaClean` instead
+*/
+const vercelStegaCleanAll = stegaClean;
+export { vercelStegaCleanAll as n, stegaClean as t };
+
+//# sourceMappingURL=stegaClean-C18wLWau.js.map

package/dist/stegaClean-C18wLWau.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stegaClean-C18wLWau.js","names":["vercelStegaClean"],"sources":["../src/stega/stegaClean.ts"],"sourcesContent":["import {vercelStegaClean} from '@vercel/stega'\n\n/**\n * The result of removing stega-encoded data from a value with `stegaClean()`: strings that were\n * branded as `StegaString` are returned to their original type, everything else is left as-is.\n * @public\n */\nexport type StegaCleaned<T> = 0 extends 1 & T\n  ? T\n  : T extends {readonly ' stegaBrand': infer Original extends string}\n    ? Original\n    : T extends string | 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]: StegaCleaned<T[Index]>}\n          : T extends object\n            ? {[K in keyof T]: StegaCleaned<T[K]>}\n            : T\n\n/**\n * Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`\n * and remove all stega-encoded data from it.\n * If the result type has strings branded as `StegaString` (by `ClientReturnStega` or `stegaBrand()`),\n * the brand is stripped and the original string type is restored.\n * @public\n */\nexport function stegaClean<Result = unknown>(result: Result): StegaCleaned<Result> {\n  return vercelStegaClean(result) as StegaCleaned<Result>\n}\n\n/**\n * Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`\n * and remove all stega-encoded data from it.\n * @alpha\n * @deprecated Use `stegaClean` instead\n */\nexport const vercelStegaCleanAll = stegaClean\n"],"mappings":";;;;;;;;AA4BA,SAAgB,WAA6B,QAAsC;CACjF,OAAOA,EAAiB,MAAM;AAChC;;;;;;;AAQA,MAAa,sBAAsB"}

package/dist/stegaEncodeSourceMap-B2fGArSf.js

@@ -0,0 +1,163 @@
+import { t as __exportAll } from "./rolldown-runtime-vyAXikos.js";
+import { n as y } from "./dist-Z8cIRxoB.js";
+import { S as toString, a as resolveMapping, b as reKeySegment, c as parseJsonPath, i as walkMap, n as resolveStudioBaseRoute, r as createEditUrl, s as jsonPathToStudioPath } from "./resolveEditInfo-sq7yF78q.js";
+/**
+* @internal
+*/
+function encodeIntoResult(result, csm, encoder) {
+	return walkMap(result, (value, path) => {
+		if (typeof value != "string") return value;
+		let resolveMappingResult = resolveMapping(path, csm);
+		if (!resolveMappingResult) return value;
+		let { mapping, matchedPath } = resolveMappingResult;
+		if (mapping.type !== "value" || mapping.source.type !== "documentValue") return value;
+		let sourceDocument = csm.documents[mapping.source.document], sourcePath = csm.paths[mapping.source.path], matchPathSegments = parseJsonPath(matchedPath);
+		return encoder({
+			sourcePath: parseJsonPath(sourcePath).concat(path.slice(matchPathSegments.length)),
+			sourceDocument,
+			resultPath: path,
+			value
+		});
+	});
+}
+const filterDefault = ({ sourcePath, resultPath, value }) => {
+	if (isValidDate(value) || isValidURL(value)) return !1;
+	let endPath = sourcePath.at(-1);
+	return !(sourcePath.at(-2) === "slug" && endPath === "current" || typeof endPath == "string" && (endPath.startsWith("_") || endPath.endsWith("Id")) || sourcePath.some((path) => path === "meta" || path === "metadata" || path === "openGraph" || path === "seo") || hasTypeLike(sourcePath) || hasTypeLike(resultPath) || typeof endPath == "string" && denylist.has(endPath));
+}, denylist = /* @__PURE__ */ new Set(/* @__PURE__ */ "color.colour.currency.email.format.gid.hex.href.hsl.hsla.icon.id.index.key.language.layout.link.linkAction.locale.lqip.page.path.ref.rgb.rgba.route.secret.slug.status.tag.template.theme.type.textTheme.unit.url.username.variant.website".split("."));
+function isValidDate(dateString) {
+	return /^\d{4}-\d{2}-\d{2}/.test(dateString) ? !!Date.parse(dateString) : !1;
+}
+const allowedProtocols = /* @__PURE__ */ new Set([
+	"app:",
+	"data:",
+	"discord:",
+	"file:",
+	"ftp:",
+	"ftps:",
+	"geo:",
+	"http:",
+	"https:",
+	"imap:",
+	"javascript:",
+	"magnet:",
+	"mailto:",
+	"maps:",
+	"ms-excel:",
+	"ms-powerpoint:",
+	"ms-word:",
+	"slack:",
+	"sms:",
+	"spotify:",
+	"steam:",
+	"teams:",
+	"tel:",
+	"vscode:",
+	"zoom:"
+]);
+function isValidURL(url) {
+	try {
+		let { protocol } = new URL(url, url.startsWith("/") ? "https://acme.com" : void 0);
+		return allowedProtocols.has(protocol) || protocol.startsWith("web+");
+	} catch {
+		return !1;
+	}
+}
+function hasTypeLike(path) {
+	return path.some((segment) => typeof segment == "string" && segment.match(/type/i) !== null);
+}
+var stegaEncodeSourceMap_exports = /* @__PURE__ */ __exportAll({
+	encodeIntoResult: () => encodeIntoResult,
+	stegaEncodeSourceMap: () => stegaEncodeSourceMap
+});
+/**
+* Uses `@vercel/stega` to embed edit info JSON into strings in your query result.
+* The JSON payloads are added using invisible characters so they don't show up visually.
+* The edit info is generated from the Content Source Map (CSM) that is returned from Sanity for the query.
+* @public
+*/
+function stegaEncodeSourceMap(result, resultSourceMap, config) {
+	let { filter, logger, enabled } = config;
+	if (!enabled) {
+		let msg = "config.enabled must be true, don't call this function otherwise";
+		throw logger?.error?.(`[@sanity/client]: ${msg}`, {
+			result,
+			resultSourceMap,
+			config
+		}), TypeError(msg);
+	}
+	if (!resultSourceMap) return logger?.error?.("[@sanity/client]: Missing Content Source Map from response body", {
+		result,
+		resultSourceMap,
+		config
+	}), result;
+	if (!config.studioUrl) {
+		let msg = "config.studioUrl must be defined";
+		throw logger?.error?.(`[@sanity/client]: ${msg}`, {
+			result,
+			resultSourceMap,
+			config
+		}), TypeError(msg);
+	}
+	let report = {
+		encoded: [],
+		skipped: []
+	}, resultWithStega = encodeIntoResult(result, resultSourceMap, ({ sourcePath, sourceDocument, resultPath, value }) => {
+		if ((typeof filter == "function" ? filter({
+			sourcePath,
+			resultPath,
+			filterDefault,
+			sourceDocument,
+			value
+		}) : filterDefault({
+			sourcePath,
+			resultPath,
+			filterDefault,
+			sourceDocument,
+			value
+		})) === !1) return logger && report.skipped.push({
+			path: prettyPathForLogging(sourcePath),
+			value: `${value.slice(0, 20)}${value.length > 20 ? "..." : ""}`,
+			length: value.length
+		}), value;
+		logger && report.encoded.push({
+			path: prettyPathForLogging(sourcePath),
+			value: `${value.slice(0, 20)}${value.length > 20 ? "..." : ""}`,
+			length: value.length
+		});
+		let { baseUrl, workspace, tool } = resolveStudioBaseRoute(typeof config.studioUrl == "function" ? config.studioUrl(sourceDocument) : config.studioUrl);
+		if (!baseUrl) return value;
+		let { _id: id, _type: type, _projectId: projectId, _dataset: dataset } = sourceDocument;
+		return y(value, {
+			origin: "sanity.io",
+			href: createEditUrl({
+				baseUrl,
+				workspace,
+				tool,
+				id,
+				type,
+				path: sourcePath,
+				...!config.omitCrossDatasetReferenceData && {
+					dataset,
+					projectId
+				}
+			})
+		}, !1);
+	});
+	if (logger) {
+		let isSkipping = report.skipped.length, isEncoding = report.encoded.length;
+		if ((isSkipping || isEncoding) && ((logger?.groupCollapsed || logger.log)?.("[@sanity/client]: Encoding source map into result"), logger.log?.(`[@sanity/client]: Paths encoded: ${report.encoded.length}, skipped: ${report.skipped.length}`)), report.encoded.length > 0 && (logger?.log?.("[@sanity/client]: Table of encoded paths"), (logger?.table || logger.log)?.(report.encoded)), report.skipped.length > 0) {
+			let skipped = /* @__PURE__ */ new Set();
+			for (let { path } of report.skipped) skipped.add(path.replace(reKeySegment, "0").replace(/\[\d+\]/g, "[]"));
+			logger?.log?.("[@sanity/client]: List of skipped paths", [...skipped.values()]);
+		}
+		(isSkipping || isEncoding) && logger?.groupEnd?.();
+	}
+	return resultWithStega;
+}
+function prettyPathForLogging(path) {
+	return toString(jsonPathToStudioPath(path));
+}
+export { stegaEncodeSourceMap_exports as n, encodeIntoResult as r, stegaEncodeSourceMap as t };
+
+//# sourceMappingURL=stegaEncodeSourceMap-B2fGArSf.js.map

package/dist/stegaEncodeSourceMap-B2fGArSf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stegaEncodeSourceMap-B2fGArSf.js","names":["vercelStegaCombine","studioPathToString"],"sources":["../src/stega/encodeIntoResult.ts","../src/stega/filterDefault.ts","../src/stega/stegaEncodeSourceMap.ts"],"sourcesContent":["import type {ContentSourceMap} from '@sanity/client/csm'\n\nimport {parseJsonPath} from '../csm/jsonPath'\nimport {resolveMapping} from '../csm/resolveMapping'\nimport {walkMap} from '../csm/walkMap'\nimport type {Encoder} from './types'\n\n/**\n * @internal\n */\nexport function encodeIntoResult<Result>(\n  result: Result,\n  csm: ContentSourceMap,\n  encoder: Encoder,\n): Result {\n  return walkMap(result, (value, path) => {\n    // Only map strings, we could extend this in the future to support other types like integers...\n    if (typeof value !== 'string') {\n      return value\n    }\n\n    const resolveMappingResult = resolveMapping(path, csm)\n    if (!resolveMappingResult) {\n      return value\n    }\n\n    const {mapping, matchedPath} = resolveMappingResult\n    if (mapping.type !== 'value') {\n      return value\n    }\n\n    if (mapping.source.type !== 'documentValue') {\n      return value\n    }\n\n    const sourceDocument = csm.documents[mapping.source.document!]\n    const sourcePath = csm.paths[mapping.source.path]\n\n    const matchPathSegments = parseJsonPath(matchedPath)\n    const sourcePathSegments = parseJsonPath(sourcePath)\n    const fullSourceSegments = sourcePathSegments.concat(path.slice(matchPathSegments.length))\n\n    return encoder({\n      sourcePath: fullSourceSegments,\n      sourceDocument,\n      resultPath: path,\n      value,\n    })\n  }) as Result\n}\n","import type {ContentSourceMapParsedPath, FilterDefault} from './types'\n\nexport const filterDefault: FilterDefault = ({sourcePath, resultPath, value}) => {\n  // Skips encoding on URL or Date strings, similar to the `skip: 'auto'` parameter in vercelStegaCombine()\n  if (isValidDate(value) || isValidURL(value)) {\n    return false\n  }\n\n  const endPath = sourcePath.at(-1)\n  // Never encode slugs\n  if (sourcePath.at(-2) === 'slug' && endPath === 'current') {\n    return false\n  }\n\n  // Skip underscored keys, and strings that end with `Id`, needs better heuristics but it works for now\n  if (typeof endPath === 'string' && (endPath.startsWith('_') || endPath.endsWith('Id'))) {\n    return false\n  }\n\n  // Don't encode into anything that is suggested it'll render for SEO in meta tags\n  if (\n    sourcePath.some(\n      (path) => path === 'meta' || path === 'metadata' || path === 'openGraph' || path === 'seo',\n    )\n  ) {\n    return false\n  }\n\n  // If the sourcePath or resultPath contains something that sounds like a type, like iconType, we skip encoding, as it's most\n  // of the time used for logic that breaks if it contains stega characters\n  if (hasTypeLike(sourcePath) || hasTypeLike(resultPath)) {\n    return false\n  }\n\n  // Finally, we ignore a bunch of paths that are typically used for page building\n  if (typeof endPath === 'string' && denylist.has(endPath)) {\n    return false\n  }\n\n  return true\n}\n\nconst denylist = new Set([\n  'color',\n  'colour',\n  'currency',\n  'email',\n  'format',\n  'gid',\n  'hex',\n  'href',\n  'hsl',\n  'hsla',\n  'icon',\n  'id',\n  'index',\n  'key',\n  'language',\n  'layout',\n  'link',\n  'linkAction',\n  'locale',\n  'lqip',\n  'page',\n  'path',\n  'ref',\n  'rgb',\n  'rgba',\n  'route',\n  'secret',\n  'slug',\n  'status',\n  'tag',\n  'template',\n  'theme',\n  'type',\n  'textTheme',\n  'unit',\n  'url',\n  'username',\n  'variant',\n  'website',\n])\n\nfunction isValidDate(dateString: string) {\n  return /^\\d{4}-\\d{2}-\\d{2}/.test(dateString) ? Boolean(Date.parse(dateString)) : false\n}\n\nconst allowedProtocols = new Set([\n  'app:',\n  'data:',\n  'discord:',\n  'file:',\n  'ftp:',\n  'ftps:',\n  'geo:',\n  'http:',\n  'https:',\n  'imap:',\n  'javascript:',\n  'magnet:',\n  'mailto:',\n  'maps:',\n  'ms-excel:',\n  'ms-powerpoint:',\n  'ms-word:',\n  'slack:',\n  'sms:',\n  'spotify:',\n  'steam:',\n  'teams:',\n  'tel:',\n  'vscode:',\n  'zoom:',\n])\n\nfunction isValidURL(url: string) {\n  try {\n    const {protocol} = new URL(url, url.startsWith('/') ? 'https://acme.com' : undefined)\n    return allowedProtocols.has(protocol) || protocol.startsWith('web+')\n  } catch {\n    return false\n  }\n}\n\nfunction hasTypeLike(path: ContentSourceMapParsedPath): boolean {\n  return path.some((segment) => typeof segment === 'string' && segment.match(/type/i) !== null)\n}\n","import {vercelStegaCombine} from '@vercel/stega'\n\nimport {createEditUrl} from '../csm/createEditUrl'\nimport {jsonPathToStudioPath} from '../csm/jsonPath'\nimport {resolveStudioBaseRoute} from '../csm/resolveEditInfo'\nimport {reKeySegment, toString as studioPathToString} from '../csm/studioPath'\nimport {encodeIntoResult} from './encodeIntoResult'\n// Re-export so `encodeIntoResult` is a genuine export of this module - which\n// forms its own output chunk via the dynamic import in `dataMethods`. Without\n// this, rolldown absorbs `encodeIntoResult` into the chunk but omits it from\n// the chunk's exports, breaking `@sanity/client/stega`'s re-export of it.\nexport {encodeIntoResult} from './encodeIntoResult'\nimport {filterDefault} from './filterDefault'\nimport {\n  type ContentSourceMap,\n  type ContentSourceMapParsedPath,\n  type InitializedStegaConfig,\n} from './types'\n\nconst TRUNCATE_LENGTH = 20\n\n/**\n * Uses `@vercel/stega` to embed edit info JSON into strings in your query result.\n * The JSON payloads are added using invisible characters so they don't show up visually.\n * The edit info is generated from the Content Source Map (CSM) that is returned from Sanity for the query.\n * @public\n */\nexport function stegaEncodeSourceMap<Result = unknown>(\n  result: Result,\n  resultSourceMap: ContentSourceMap | undefined,\n  config: InitializedStegaConfig,\n): Result {\n  const {filter, logger, enabled} = config\n  if (!enabled) {\n    const msg = \"config.enabled must be true, don't call this function otherwise\"\n    logger?.error?.(`[@sanity/client]: ${msg}`, {result, resultSourceMap, config})\n    throw new TypeError(msg)\n  }\n\n  if (!resultSourceMap) {\n    logger?.error?.('[@sanity/client]: Missing Content Source Map from response body', {\n      result,\n      resultSourceMap,\n      config,\n    })\n    return result\n  }\n\n  if (!config.studioUrl) {\n    const msg = 'config.studioUrl must be defined'\n    logger?.error?.(`[@sanity/client]: ${msg}`, {result, resultSourceMap, config})\n    throw new TypeError(msg)\n  }\n\n  const report: Record<'encoded' | 'skipped', {path: string; length: number; value: string}[]> = {\n    encoded: [],\n    skipped: [],\n  }\n\n  const resultWithStega = encodeIntoResult(\n    result,\n    resultSourceMap,\n    ({sourcePath, sourceDocument, resultPath, value}) => {\n      // Allow userland to control when to opt-out of encoding\n      if (\n        (typeof filter === 'function'\n          ? filter({sourcePath, resultPath, filterDefault, sourceDocument, value})\n          : filterDefault({sourcePath, resultPath, filterDefault, sourceDocument, value})) === false\n      ) {\n        if (logger) {\n          report.skipped.push({\n            path: prettyPathForLogging(sourcePath),\n            value: `${value.slice(0, TRUNCATE_LENGTH)}${\n              value.length > TRUNCATE_LENGTH ? '...' : ''\n            }`,\n            length: value.length,\n          })\n        }\n        return value\n      }\n\n      if (logger) {\n        report.encoded.push({\n          path: prettyPathForLogging(sourcePath),\n          value: `${value.slice(0, TRUNCATE_LENGTH)}${value.length > TRUNCATE_LENGTH ? '...' : ''}`,\n          length: value.length,\n        })\n      }\n\n      const {baseUrl, workspace, tool} = resolveStudioBaseRoute(\n        typeof config.studioUrl === 'function'\n          ? config.studioUrl(sourceDocument)\n          : config.studioUrl!,\n      )\n      if (!baseUrl) return value\n      const {_id: id, _type: type, _projectId: projectId, _dataset: dataset} = sourceDocument\n\n      return vercelStegaCombine(\n        value,\n        {\n          origin: 'sanity.io',\n          href: createEditUrl({\n            baseUrl,\n            workspace,\n            tool,\n            id,\n            type,\n            path: sourcePath,\n            ...(!config.omitCrossDatasetReferenceData && {dataset, projectId}),\n          }),\n        },\n        // We use custom logic to determine if we should skip encoding\n        false,\n      )\n    },\n  )\n\n  if (logger) {\n    const isSkipping = report.skipped.length\n    const isEncoding = report.encoded.length\n    if (isSkipping || isEncoding) {\n      ;(logger?.groupCollapsed || logger.log)?.('[@sanity/client]: Encoding source map into result')\n      logger.log?.(\n        `[@sanity/client]: Paths encoded: ${report.encoded.length}, skipped: ${report.skipped.length}`,\n      )\n    }\n    if (report.encoded.length > 0) {\n      logger?.log?.(`[@sanity/client]: Table of encoded paths`)\n      ;(logger?.table || logger.log)?.(report.encoded)\n    }\n    if (report.skipped.length > 0) {\n      const skipped = new Set<string>()\n      for (const {path} of report.skipped) {\n        skipped.add(path.replace(reKeySegment, '0').replace(/\\[\\d+\\]/g, '[]'))\n      }\n      logger?.log?.(`[@sanity/client]: List of skipped paths`, [...skipped.values()])\n    }\n\n    if (isSkipping || isEncoding) {\n      logger?.groupEnd?.()\n    }\n  }\n\n  return resultWithStega\n}\n\nfunction prettyPathForLogging(path: ContentSourceMapParsedPath): string {\n  return studioPathToString(jsonPathToStudioPath(path))\n}\n"],"mappings":";;;;;;AAUA,SAAgB,iBACd,QACA,KACA,SACQ;CACR,OAAO,QAAQ,SAAS,OAAO,SAAS;EAEtC,IAAI,OAAO,SAAU,UACnB,OAAO;EAGT,IAAM,uBAAuB,eAAe,MAAM,GAAG;EACrD,IAAI,CAAC,sBACH,OAAO;EAGT,IAAM,EAAC,SAAS,gBAAe;EAK/B,IAJI,QAAQ,SAAS,WAIjB,QAAQ,OAAO,SAAS,iBAC1B,OAAO;EAGT,IAAM,iBAAiB,IAAI,UAAU,QAAQ,OAAO,WAC9C,aAAa,IAAI,MAAM,QAAQ,OAAO,OAEtC,oBAAoB,cAAc,WAAW;EAInD,OAAO,QAAQ;GACb,YAJyB,cAAc,UACG,CAAC,CAAC,OAAO,KAAK,MAAM,kBAAkB,MAAM,CAGzD;GAC7B;GACA,YAAY;GACZ;EACF,CAAC;CACH,CAAC;AACH;AC/CA,MAAa,iBAAgC,EAAC,YAAY,YAAY,YAAW;CAE/E,IAAI,YAAY,KAAK,KAAK,WAAW,KAAK,GACxC,OAAO;CAGT,IAAM,UAAU,WAAW,GAAG,EAAE;CA+BhC,OAJA,EAzBI,WAAW,GAAG,EAAE,MAAM,UAAU,YAAY,aAK5C,OAAO,WAAY,aAAa,QAAQ,WAAW,GAAG,KAAK,QAAQ,SAAS,IAAI,MAMlF,WAAW,MACR,SAAS,SAAS,UAAU,SAAS,cAAc,SAAS,eAAe,SAAS,KACvF,KAOE,YAAY,UAAU,KAAK,YAAY,UAAU,KAKjD,OAAO,WAAY,YAAY,SAAS,IAAI,OAAO;AAKzD,GAEM,2BAAW,IAAI,IAAI,sQAwCzB,CAAC;AAED,SAAS,YAAY,YAAoB;CACvC,OAAO,qBAAqB,KAAK,UAAU,IAAI,EAAQ,KAAK,MAAM,UAAU,IAAK;AACnF;AAEA,MAAM,mCAAmB,IAAI,IAAI;CAC/B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC;AAED,SAAS,WAAW,KAAa;CAC/B,IAAI;EACF,IAAM,EAAC,aAAY,IAAI,IAAI,KAAK,IAAI,WAAW,GAAG,IAAI,qBAAqB,KAAA,CAAS;EACpF,OAAO,iBAAiB,IAAI,QAAQ,KAAK,SAAS,WAAW,MAAM;CACrE,QAAQ;EACN,OAAO;CACT;AACF;AAEA,SAAS,YAAY,MAA2C;CAC9D,OAAO,KAAK,MAAM,YAAY,OAAO,WAAY,YAAY,QAAQ,MAAM,OAAO,MAAM,IAAI;AAC9F;;;;;;;;;;;ACpGA,SAAgB,qBACd,QACA,iBACA,QACQ;CACR,IAAM,EAAC,QAAQ,QAAQ,YAAW;CAClC,IAAI,CAAC,SAAS;EACZ,IAAM,MAAM;EAEZ,MADA,QAAQ,QAAQ,qBAAqB,OAAO;GAAC;GAAQ;GAAiB;EAAM,CAAC,GACnE,UAAU,GAAG;CACzB;CAEA,IAAI,CAAC,iBAMH,OALA,QAAQ,QAAQ,mEAAmE;EACjF;EACA;EACA;CACF,CAAC,GACM;CAGT,IAAI,CAAC,OAAO,WAAW;EACrB,IAAM,MAAM;EAEZ,MADA,QAAQ,QAAQ,qBAAqB,OAAO;GAAC;GAAQ;GAAiB;EAAM,CAAC,GACnE,UAAU,GAAG;CACzB;CAEA,IAAM,SAAyF;EAC7F,SAAS,CAAC;EACV,SAAS,CAAC;CACZ,GAEM,kBAAkB,iBACtB,QACA,kBACC,EAAC,YAAY,gBAAgB,YAAY,YAAW;EAEnD,KACG,OAAO,UAAW,aACf,OAAO;GAAC;GAAY;GAAY;GAAe;GAAgB;EAAK,CAAC,IACrE,cAAc;GAAC;GAAY;GAAY;GAAe;GAAgB;EAAK,CAAC,OAAO,IAWvF,OATI,UACF,OAAO,QAAQ,KAAK;GAClB,MAAM,qBAAqB,UAAU;GACrC,OAAO,GAAG,MAAM,MAAM,GAAG,EAAe,IACtC,MAAM,SAAS,KAAkB,QAAQ;GAE3C,QAAQ,MAAM;EAChB,CAAC,GAEI;EAGT,AAAI,UACF,OAAO,QAAQ,KAAK;GAClB,MAAM,qBAAqB,UAAU;GACrC,OAAO,GAAG,MAAM,MAAM,GAAG,EAAe,IAAI,MAAM,SAAS,KAAkB,QAAQ;GACrF,QAAQ,MAAM;EAChB,CAAC;EAGH,IAAM,EAAC,SAAS,WAAW,SAAQ,uBACjC,OAAO,OAAO,aAAc,aACxB,OAAO,UAAU,cAAc,IAC/B,OAAO,SACb;EACA,IAAI,CAAC,SAAS,OAAO;EACrB,IAAM,EAAC,KAAK,IAAI,OAAO,MAAM,YAAY,WAAW,UAAU,YAAW;EAEzE,OAAOA,EACL,OACA;GACE,QAAQ;GACR,MAAM,cAAc;IAClB;IACA;IACA;IACA;IACA;IACA,MAAM;IACN,GAAI,CAAC,OAAO,iCAAiC;KAAC;KAAS;IAAS;GAClE,CAAC;EACH,GAEA,EACF;CACF,CACF;CAEA,IAAI,QAAQ;EACV,IAAM,aAAa,OAAO,QAAQ,QAC5B,aAAa,OAAO,QAAQ;EAWlC,KAVI,cAAc,iBACd,QAAQ,kBAAkB,OAAO,IAAA,GAAO,mDAAmD,GAC7F,OAAO,MACL,oCAAoC,OAAO,QAAQ,OAAO,aAAa,OAAO,QAAQ,QACxF,IAEE,OAAO,QAAQ,SAAS,MAC1B,QAAQ,MAAM,0CAA0C,IACtD,QAAQ,SAAS,OAAO,IAAA,GAAO,OAAO,OAAO,IAE7C,OAAO,QAAQ,SAAS,GAAG;GAC7B,IAAM,0BAAU,IAAI,IAAY;GAChC,KAAK,IAAM,EAAC,UAAS,OAAO,SAC1B,QAAQ,IAAI,KAAK,QAAQ,cAAc,GAAG,CAAC,CAAC,QAAQ,YAAY,IAAI,CAAC;GAEvE,QAAQ,MAAM,2CAA2C,CAAC,GAAG,QAAQ,OAAO,CAAC,CAAC;EAChF;EAEA,CAAI,cAAc,eAChB,QAAQ,WAAW;CAEvB;CAEA,OAAO;AACT;AAEA,SAAS,qBAAqB,MAA0C;CACtE,OAAOC,SAAmB,qBAAqB,IAAI,CAAC;AACtD"}