@driftime/sanity-plugin-link 0.1.0

package/dist/types-BR08fVY8.js

@@ -0,0 +1,188 @@
+import { stegaClean } from "@sanity/client/stega";
+/** Whether the plugin is running in a development build, which decides whether it reports what it recovered from. */
+const isDevelopment = process.env.NODE_ENV === "development", prefixStyle = "color: #2276fc";
+/**
+* Creates the logger a package reports through, so every message names the plugin it came from and
+* only a development build hears it. In a browser console the name is drawn in blue, the way the
+* Studio's own messages are; a terminal ignores the styling and prints it plain.
+*
+* @param name - Name of the package the messages come from.
+* @returns Functions that warn, report an error, or word a message for throwing.
+*/
+function createLogger(name) {
+	let prefix = `[${name}]`;
+	/**
+	* Words a message so it names the package it came from.
+	*
+	* @param message - The message to word.
+	* @returns The message with the package name in front.
+	*/
+	function format(message) {
+		return `${prefix} ${message}`;
+	}
+	return {
+		/**
+		* Reports something the plugin recovered from, in development only.
+		*
+		* @param message - What was recovered from and what to do about it.
+		*/
+		warn(message) {
+			isDevelopment && console.warn(`%c${prefix}%c ${message}`, prefixStyle, "");
+		},
+		/**
+		* Reports something the plugin could not recover from, in development only.
+		*
+		* @param message - What went wrong and what to do about it.
+		*/
+		error(message) {
+			isDevelopment && console.error(`%c${prefix}%c ${message}`, prefixStyle, "");
+		},
+		format
+	};
+}
+/** Name the package is published under, which every message it reports carries. */
+const pluginName = "@driftime/sanity-plugin-link", logger = createLogger(pluginName), defaultTitleField = "title";
+/**
+* Checks whether a value is defined and non-empty, treating `false`, empty strings, and objects with
+* no keys as absent. An array is absent unless one of its elements is itself present, while anything
+* built from a class counts as present on existence alone. Not intended for boolean flags.
+*
+* @param value - The value to check.
+* @returns True if the value is defined and not empty.
+*/
+function isDefined(value) {
+	if (value == null || value === !1) return !1;
+	if (typeof value == "string") return value.trim() !== "";
+	if (Array.isArray(value)) return value.some((element) => isDefined(element));
+	if (typeof value == "object") {
+		let prototype = Reflect.getPrototypeOf(value);
+		return prototype !== Object.prototype && prototype !== null || Object.keys(value).length > 0;
+	}
+	return !0;
+}
+/**
+* Converts a string between different casing formats.
+*
+* @param value - The string to convert.
+* @param format - The target casing format.
+* @returns The converted string.
+*/
+function convertCase(value, format) {
+	let words = value.replaceAll(/(?<lower>[a-z0-9])(?<upper>[A-Z])/gu, "$<lower> $<upper>").replaceAll(/[-_\s]+/gu, " ").trim().toLowerCase();
+	switch (format) {
+		case "kebab": return words.replaceAll(/\s+/gu, "-");
+		case "snake": return words.replaceAll(/\s+/gu, "_");
+		case "camel": return words.replaceAll(/\s+(?<character>.)/gu, (_match, character) => character.toUpperCase());
+		case "pascal": return words.replaceAll(/(?:^|\s+)(?<character>.)/gu, (_match, character) => character.toUpperCase());
+		case "title": return words.replaceAll(/\b\w/gu, (character) => character.toUpperCase());
+		case "sentence": return words.replaceAll(/^(?<character>.)/gu, (character) => character.toUpperCase());
+		default: return value;
+	}
+}
+/**
+* Checks whether a value can be read by key, narrowing what arrives untyped from outside the plugin.
+*
+* @param value - The value to check.
+* @returns True if the value has keys to read.
+*/
+function isRecord(value) {
+	return typeof value == "object" && !!value;
+}
+/**
+* Reads a value out of nested records by following a path of keys, so a caller can name something
+* inside a shape it does not otherwise know.
+*
+* @param value - The object to read from.
+* @param path - Keys leading to the value.
+* @returns The value at the path, or undefined when a key is missing or a step holds no keys to read.
+*/
+function readPath(value, path) {
+	let current = value;
+	for (let segment of path) {
+		if (!isRecord(current)) return;
+		current = current[segment];
+	}
+	return current;
+}
+/**
+* Reads an internal link's parameters as the pairs a query string is built from, dropping any row
+* that names no key so a half-written parameter never reaches an address.
+*
+* @param searchParams - The stored parameters.
+* @returns The parameters that name a key, or undefined when none do.
+*/
+function readSearchParams(searchParams) {
+	if (!isDefined(searchParams)) return;
+	let entries = searchParams.flatMap(({ key, value }) => {
+		let name = stegaClean(key);
+		return isDefined(name) ? [[name, stegaClean(value) ?? ""]] : [];
+	});
+	return entries.length > 0 ? Object.fromEntries(entries) : void 0;
+}
+/**
+* Builds the address that opens a message to a chosen inbox.
+*
+* @param email - The address the message is sent to.
+* @param subject - The subject the message opens with.
+* @returns The address, or undefined when no inbox was named.
+*/
+function composeEmailHref(email, subject) {
+	let address = stegaClean(email);
+	if (!isDefined(address)) return;
+	let line = stegaClean(subject);
+	return isDefined(line) ? `mailto:${address}?subject=${encodeURIComponent(line)}` : `mailto:${address}`;
+}
+/**
+* Builds the address that starts a call to a chosen number. Spacing an author wrote for legibility is
+* dropped, since a dialler reads none of it.
+*
+* @param phone - The number the call is placed to.
+* @returns The address, or undefined when no number was named.
+*/
+function composePhoneHref(phone) {
+	let number = stegaClean(phone);
+	if (isDefined(number)) return `tel:${number.replaceAll(/\s+/gu, "")}`;
+}
+/**
+* Appends the anchor and query string an author added onto the address a route resolved to, merging
+* with any parameters the route already carried.
+*
+* @param href - The address the route resolved to.
+* @param anchor - Section of the destination page to arrive at.
+* @param searchParams - Query string parameters to append.
+* @returns The address carrying the anchor and parameters, in the same absolute or relative form it arrived in.
+*/
+function appendDestination(href, anchor, searchParams) {
+	let params = readSearchParams(searchParams), hash = stegaClean(anchor);
+	if (!isDefined(params) && !isDefined(hash)) return href;
+	let placeholder = "http://append.invalid";
+	try {
+		let url = new URL(href, placeholder);
+		for (let [key, value] of Object.entries(params ?? {})) url.searchParams.set(key, value);
+		return isDefined(hash) && (url.hash = convertCase(hash, "kebab")), url.origin === placeholder ? url.pathname + url.search + url.hash : url.href;
+	} catch {
+		return href;
+	}
+}
+/**
+* Builds the address that moves a visitor within the page they are already reading.
+*
+* @param anchor - Section of the page to arrive at.
+* @returns The address, or undefined when no section was named.
+*/
+function composeAnchorHref(anchor) {
+	let hash = stegaClean(anchor);
+	if (isDefined(hash)) return `#${convertCase(hash, "kebab")}`;
+}
+/** Type name of the link object. */
+const linkTypeName = "link", linkMarkTypeName = "linkMark", searchParamTypeName = "linkSearchParam", linkDestinations = [
+	"page",
+	"anchor",
+	"url",
+	"email",
+	"phone",
+	"file"
+];
+export { appendDestination as a, composePhoneHref as c, readPath as d, defaultTitleField as f, isDevelopment as h, searchParamTypeName as i, convertCase as l, pluginName as m, linkMarkTypeName as n, composeAnchorHref as o, logger as p, linkTypeName as r, composeEmailHref as s, linkDestinations as t, isDefined as u };
+
+//# sourceMappingURL=types-BR08fVY8.js.map

package/dist/types-BR08fVY8.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-BR08fVY8.js","names":["isDevelopment","process","env","isDevelopment","prefixStyle","createLogger","name","prefix","format","message","warn","console","error","createLogger","pluginName","logger","defaultTitleField","Nullable","T","isDefined","value","undefined","trim","Array","isArray","some","element","prototype","Reflect","getPrototypeOf","Object","keys","length","convertCase","format","words","replaceAll","toLowerCase","_match","character","toUpperCase","isRecord","Record","readPath","path","current","segment","convertCase","isDefined","stegaClean","SanityLinkSearchParam","readSearchParams","searchParams","undefined","entries","flatMap","key","value","name","const","length","Object","fromEntries","composeEmailHref","email","subject","address","line","encodeURIComponent","composePhoneHref","phone","number","replaceAll","appendDestination","href","anchor","params","hash","placeholder","url","URL","set","origin","pathname","search","composeAnchorHref","linkTypeName","linkMarkTypeName","searchParamTypeName","linkDestinations","const","SanityLinkDestination","SanityLinkRouteParams","Record","SanityLinkReference","_ref","T","SanityLinkDocument","_id","_type","_routeParams","title","SanityLinkFileAsset","url","originalFilename","SanityLinkFile","asset","SanityLinkSearchParam","_key","key","value","SanityPageLink","type","reference","TDocument","anchor","searchParams","label","SanityAnchorLink","SanityUrlLink","SanityEmailLink","email","subject","SanityPhoneLink","phone","SanityFileLink","file","SanityLink"],"sources":["../../@repo/lib/environment.ts","../../@repo/lib/logger.ts","../src/config/defaults.ts","../../@repo/lib/utils.ts","../src/lib/destinations.ts","../src/types.ts"],"sourcesContent":["/** Whether the plugin is running in a development build, which decides whether it reports what it recovered from. */\nexport const isDevelopment = process.env[\"NODE_ENV\"] === \"development\";\n","import { isDevelopment } from \"./environment\";\n\n/** Style the prefix is drawn with in a browser console, matching the blue the Studio uses for its own. */\nconst prefixStyle = \"color: #2276fc\";\n\n/**\n * Creates the logger a package reports through, so every message names the plugin it came from and\n * only a development build hears it. In a browser console the name is drawn in blue, the way the\n * Studio's own messages are; a terminal ignores the styling and prints it plain.\n *\n * @param name - Name of the package the messages come from.\n * @returns Functions that warn, report an error, or word a message for throwing.\n */\nexport function createLogger(name: string) {\n  const prefix = `[${name}]`;\n\n  /**\n   * Words a message so it names the package it came from.\n   *\n   * @param message - The message to word.\n   * @returns The message with the package name in front.\n   */\n  function format(message: string) {\n    return `${prefix} ${message}`;\n  }\n\n  return {\n    /**\n     * Reports something the plugin recovered from, in development only.\n     *\n     * @param message - What was recovered from and what to do about it.\n     */\n    warn(message: string) {\n      if (isDevelopment) console.warn(`%c${prefix}%c ${message}`, prefixStyle, \"\");\n    },\n    /**\n     * Reports something the plugin could not recover from, in development only.\n     *\n     * @param message - What went wrong and what to do about it.\n     */\n    error(message: string) {\n      if (isDevelopment) console.error(`%c${prefix}%c ${message}`, prefixStyle, \"\");\n    },\n    format,\n  };\n}\n","import { createLogger } from \"@repo/lib/logger\";\n\n/** Name the package is published under, which every message it reports carries. */\nexport const pluginName = \"@driftime/sanity-plugin-link\";\n\n/** Logger every message the package reports goes through. */\nexport const logger = createLogger(pluginName);\n\n/** Field an internal link borrows its label from, and a preview its title from, when none is configured. */\nexport const defaultTitleField = \"title\";\n","/** A value that may be absent, covering both null and undefined. */\ntype Nullable<T> = T | null | undefined;\n\n/**\n * Checks whether a value is defined and non-empty, treating `false`, empty strings, and objects with\n * no keys as absent. An array is absent unless one of its elements is itself present, while anything\n * built from a class counts as present on existence alone. Not intended for boolean flags.\n *\n * @param value - The value to check.\n * @returns True if the value is defined and not empty.\n */\nexport function isDefined<T>(value: Nullable<T> | false): value is T {\n  if (value === undefined || value === null || value === false) return false;\n  if (typeof value === \"string\") return value.trim() !== \"\";\n  if (Array.isArray(value)) return value.some((element) => isDefined(element));\n\n  if (typeof value === \"object\") {\n    const prototype = Reflect.getPrototypeOf(value);\n    if (prototype !== Object.prototype && prototype !== null) return true;\n\n    return Object.keys(value).length > 0;\n  }\n\n  return true;\n}\n\n/**\n * Converts a string between different casing formats.\n *\n * @param value - The string to convert.\n * @param format - The target casing format.\n * @returns The converted string.\n */\nexport function convertCase(value: string, format: \"kebab\" | \"snake\" | \"camel\" | \"pascal\" | \"title\" | \"sentence\") {\n  const words = value\n    .replaceAll(/(?<lower>[a-z0-9])(?<upper>[A-Z])/gu, \"$<lower> $<upper>\")\n    .replaceAll(/[-_\\s]+/gu, \" \")\n    .trim()\n    .toLowerCase();\n\n  switch (format) {\n    case \"kebab\": {\n      return words.replaceAll(/\\s+/gu, \"-\");\n    }\n    case \"snake\": {\n      return words.replaceAll(/\\s+/gu, \"_\");\n    }\n    case \"camel\": {\n      return words.replaceAll(/\\s+(?<character>.)/gu, (_match, character: string) => character.toUpperCase());\n    }\n    case \"pascal\": {\n      return words.replaceAll(/(?:^|\\s+)(?<character>.)/gu, (_match, character: string) => character.toUpperCase());\n    }\n    case \"title\": {\n      return words.replaceAll(/\\b\\w/gu, (character) => character.toUpperCase());\n    }\n    case \"sentence\": {\n      return words.replaceAll(/^(?<character>.)/gu, (character) => character.toUpperCase());\n    }\n    default: {\n      return value;\n    }\n  }\n}\n\n/**\n * Checks whether a value can be read by key, narrowing what arrives untyped from outside the plugin.\n *\n * @param value - The value to check.\n * @returns True if the value has keys to read.\n */\nexport function isRecord(value: unknown): value is Record<string, unknown> {\n  return typeof value === \"object\" && value !== null;\n}\n\n/**\n * Reads a value out of nested records by following a path of keys, so a caller can name something\n * inside a shape it does not otherwise know.\n *\n * @param value - The object to read from.\n * @param path - Keys leading to the value.\n * @returns The value at the path, or undefined when a key is missing or a step holds no keys to read.\n */\nexport function readPath(value: unknown, path: string[]) {\n  let current: unknown = value;\n\n  for (const segment of path) {\n    if (!isRecord(current)) return undefined;\n\n    current = current[segment];\n  }\n\n  return current;\n}\n","import { convertCase, isDefined } from \"@repo/lib/utils\";\nimport { stegaClean } from \"@sanity/client/stega\";\n\nimport type { SanityLinkSearchParam } from \"@/types\";\n\n/**\n * Reads an internal link's parameters as the pairs a query string is built from, dropping any row\n * that names no key so a half-written parameter never reaches an address.\n *\n * @param searchParams - The stored parameters.\n * @returns The parameters that name a key, or undefined when none do.\n */\nfunction readSearchParams(searchParams: SanityLinkSearchParam[] | undefined) {\n  if (!isDefined(searchParams)) return undefined;\n\n  const entries = searchParams.flatMap(({ key, value }) => {\n    const name = stegaClean(key);\n\n    return isDefined(name) ? [[name, stegaClean(value) ?? \"\"] as const] : [];\n  });\n\n  return entries.length > 0 ? Object.fromEntries(entries) : undefined;\n}\n\n/**\n * Builds the address that opens a message to a chosen inbox.\n *\n * @param email - The address the message is sent to.\n * @param subject - The subject the message opens with.\n * @returns The address, or undefined when no inbox was named.\n */\nexport function composeEmailHref(email: string | undefined, subject: string | undefined) {\n  const address = stegaClean(email);\n  if (!isDefined(address)) return undefined;\n\n  const line = stegaClean(subject);\n\n  return isDefined(line) ? `mailto:${address}?subject=${encodeURIComponent(line)}` : `mailto:${address}`;\n}\n\n/**\n * Builds the address that starts a call to a chosen number. Spacing an author wrote for legibility is\n * dropped, since a dialler reads none of it.\n *\n * @param phone - The number the call is placed to.\n * @returns The address, or undefined when no number was named.\n */\nexport function composePhoneHref(phone: string | undefined) {\n  const number = stegaClean(phone);\n  if (!isDefined(number)) return undefined;\n\n  return `tel:${number.replaceAll(/\\s+/gu, \"\")}`;\n}\n\n/**\n * Appends the anchor and query string an author added onto the address a route resolved to, merging\n * with any parameters the route already carried.\n *\n * @param href - The address the route resolved to.\n * @param anchor - Section of the destination page to arrive at.\n * @param searchParams - Query string parameters to append.\n * @returns The address carrying the anchor and parameters, in the same absolute or relative form it arrived in.\n */\nexport function appendDestination(\n  href: string,\n  anchor: string | undefined,\n  searchParams: SanityLinkSearchParam[] | undefined,\n) {\n  const params = readSearchParams(searchParams);\n  const hash = stegaClean(anchor);\n  if (!isDefined(params) && !isDefined(hash)) return href;\n\n  // Stands in for the site's own origin, so a relative address can be parsed and rebuilt as one.\n  const placeholder = \"http://append.invalid\";\n\n  try {\n    const url = new URL(href, placeholder);\n\n    // An author's own parameter wins over one the route already carried, having been written later.\n    for (const [key, value] of Object.entries(params ?? {})) url.searchParams.set(key, value);\n    if (isDefined(hash)) url.hash = convertCase(hash, \"kebab\");\n\n    return url.origin === placeholder ? url.pathname + url.search + url.hash : url.href;\n  } catch {\n    return href;\n  }\n}\n\n/**\n * Builds the address that moves a visitor within the page they are already reading.\n *\n * @param anchor - Section of the page to arrive at.\n * @returns The address, or undefined when no section was named.\n */\nexport function composeAnchorHref(anchor: string | undefined) {\n  const hash = stegaClean(anchor);\n  if (!isDefined(hash)) return undefined;\n\n  return `#${convertCase(hash, \"kebab\")}`;\n}\n","/** Type name of the link object. */\nexport const linkTypeName = \"link\";\n\n/**\n * Type name a link takes as a Portable Text annotation. It is stored as `_type`, which is how the\n * label field and the resolver tell an annotated span from a link field.\n */\nexport const linkMarkTypeName = \"linkMark\";\n\n/** Type name of one search parameter on an internal link. */\nexport const searchParamTypeName = \"linkSearchParam\";\n\n/** Kinds of destination a link may point at, in the order the Studio offers them. */\nexport const linkDestinations = [\"page\", \"anchor\", \"url\", \"email\", \"phone\", \"file\"] as const;\n\n/**\n * Which kind of destination a link points at, discriminating the stored union.\n *\n * @public\n */\nexport type SanityLinkDestination = (typeof linkDestinations)[number];\n\n/**\n * Values filling a document's route parameters, present once a query spreads the route params fragment.\n *\n * @public\n */\nexport type SanityLinkRouteParams = Record<string, string | null | undefined>;\n\n/**\n * A pointer to another document, holding the raw reference until a query expands it into the document\n * itself.\n *\n * @public\n */\nexport type SanityLinkReference<T> = { _ref: string } | T;\n\n/**\n * The document an internal link points at, holding as much of it as resolution reads. Narrow this to\n * a consumer's own routed document type wherever a stored link is typed.\n *\n * @public\n */\nexport interface SanityLinkDocument {\n  _id: string;\n  _type: string;\n  /** Values filling this document's route parameters, absent when its query left them unfetched. */\n  _routeParams?: SanityLinkRouteParams;\n  /** Title the link borrows when no label was written. */\n  title?: string;\n}\n\n/**\n * The file a download link serves, holding as much of it as resolution reads.\n *\n * @public\n */\nexport interface SanityLinkFileAsset {\n  _id: string;\n  _type: string;\n  /** Address the file is served from. */\n  url?: string;\n  /** Name the file was uploaded under, offered to the browser as the name to save it by. */\n  originalFilename?: string;\n}\n\n/**\n * A file field, whose asset stays a raw reference until a query expands it.\n *\n * @public\n */\nexport interface SanityLinkFile {\n  _type: \"file\";\n  /** The uploaded file itself. */\n  asset?: SanityLinkReference<SanityLinkFileAsset>;\n}\n\n/**\n * One query string parameter appended to an internal link's address.\n *\n * @public\n */\nexport interface SanityLinkSearchParam {\n  _type: typeof searchParamTypeName;\n  _key: string;\n  /** Name the parameter is read under. */\n  key?: string;\n  /** Value the parameter carries. */\n  value?: string;\n}\n\n/**\n * A link to a page on the site itself, pointing at the document rather than its address so the link\n * survives that document's slug changing.\n *\n * @public\n */\nexport interface SanityPageLink<TDocument = SanityLinkDocument> {\n  _type: typeof linkTypeName | typeof linkMarkTypeName;\n  type: \"page\";\n  /** Document the link points at. */\n  reference?: SanityLinkReference<TDocument>;\n  /** Section of the destination page to arrive at, stored without its leading hash. */\n  anchor?: string;\n  /** Query string parameters appended to the destination's address. */\n  searchParams?: SanityLinkSearchParam[];\n  /** Text a visitor reads, standing in front of the destination document's own title. */\n  label?: string;\n}\n\n/**\n * A link to a section of the page it is drawn on, for moving a visitor within a page rather than\n * between them.\n *\n * @public\n */\nexport interface SanityAnchorLink {\n  _type: typeof linkTypeName | typeof linkMarkTypeName;\n  type: \"anchor\";\n  /** Section of this page to arrive at, stored without its leading hash. */\n  anchor?: string;\n  /** Text a visitor reads. */\n  label?: string;\n}\n\n/**\n * A link to an address elsewhere, covering any web page the site does not serve itself.\n *\n * @public\n */\nexport interface SanityUrlLink {\n  _type: typeof linkTypeName | typeof linkMarkTypeName;\n  type: \"url\";\n  /** Address the link points at, including the scheme in front of it. */\n  url?: string;\n  /** Text a visitor reads. */\n  label?: string;\n}\n\n/**\n * A link that opens a message to an address, rather than asking an author to know a URI scheme.\n *\n * @public\n */\nexport interface SanityEmailLink {\n  _type: typeof linkTypeName | typeof linkMarkTypeName;\n  type: \"email\";\n  /** Address the message is sent to. */\n  email?: string;\n  /** Subject the message opens with. */\n  subject?: string;\n  /** Text a visitor reads. */\n  label?: string;\n}\n\n/**\n * A link that starts a call to a number, rather than asking an author to know a URI scheme.\n *\n * @public\n */\nexport interface SanityPhoneLink {\n  _type: typeof linkTypeName | typeof linkMarkTypeName;\n  type: \"phone\";\n  /** Number the call is placed to. */\n  phone?: string;\n  /** Text a visitor reads. */\n  label?: string;\n}\n\n/**\n * A link to a file a visitor downloads, held with the link rather than addressed elsewhere.\n *\n * @public\n */\nexport interface SanityFileLink {\n  _type: typeof linkTypeName | typeof linkMarkTypeName;\n  type: \"file\";\n  /** File the link serves. */\n  file?: SanityLinkFile;\n  /** Text a visitor reads. */\n  label?: string;\n}\n\n/**\n * A link an author authored, discriminated by the kind of destination it points at.\n *\n * @public\n */\nexport type SanityLink<TDocument = SanityLinkDocument> =\n  | SanityPageLink<TDocument>\n  | SanityAnchorLink\n  | SanityUrlLink\n  | SanityEmailLink\n  | SanityPhoneLink\n  | SanityFileLink;\n"],"mappings":";;AACA,MAAaA,gBAAgBC,QAAQC,IAAI,aAAgB,eCEnDE,cAAc;;;;;;;;;AAUpB,SAAgBC,aAAaC,MAAc;CACzC,IAAMC,SAAS,IAAID,KAAI;;;;;;;CAQvB,SAASE,OAAOC,SAAiB;EAC/B,OAAO,GAAGF,OAAM,GAAIE;CACtB;CAEA,OAAO;;;;;;EAMLC,KAAKD,SAAiB;GACpB,AAAIN,iBAAeQ,QAAQD,KAAK,KAAKH,OAAM,KAAME,WAAWL,aAAa,EAAE;EAC7E;;;;;;EAMAQ,MAAMH,SAAiB;GACrB,AAAIN,iBAAeQ,QAAQC,MAAM,KAAKL,OAAM,KAAME,WAAWL,aAAa,EAAE;EAC9E;EACAI;CACF;AACF;;AC1CA,MAAaM,aAAa,gCAGbC,SAASF,aAAaC,UAAU,GAGhCE,oBAAoB;;;;;;;;;ACEjC,SAAgBG,UAAaC,OAAwC;CACnE,IAAIA,SAAiC,QAAQA,UAAU,IAAO,OAAO;CACrE,IAAI,OAAOA,SAAU,UAAU,OAAOA,MAAME,KAAK,MAAM;CACvD,IAAIC,MAAMC,QAAQJ,KAAK,GAAG,OAAOA,MAAMK,MAAMC,YAAYP,UAAUO,OAAO,CAAC;CAE3E,IAAI,OAAON,SAAU,UAAU;EAC7B,IAAMO,YAAYC,QAAQC,eAAeT,KAAK;EAG9C,OAFIO,cAAcG,OAAOH,aAAaA,cAAc,QAE7CG,OAAOC,KAAKX,KAAK,CAAC,CAACY,SAAS;CACrC;CAEA,OAAO;AACT;;;;;;;;AASA,SAAgBC,YAAYb,OAAec,QAAuE;CAChH,IAAMC,QAAQf,MACXgB,WAAW,uCAAuC,mBAAmB,CAAC,CACtEA,WAAW,aAAa,GAAG,CAAC,CAC5Bd,KAAK,CAAC,CACNe,YAAY;CAEf,QAAQH,QAAR;EACE,KAAK,SACH,OAAOC,MAAMC,WAAW,SAAS,GAAG;EAEtC,KAAK,SACH,OAAOD,MAAMC,WAAW,SAAS,GAAG;EAEtC,KAAK,SACH,OAAOD,MAAMC,WAAW,yBAAyBE,QAAQC,cAAsBA,UAAUC,YAAY,CAAC;EAExG,KAAK,UACH,OAAOL,MAAMC,WAAW,+BAA+BE,QAAQC,cAAsBA,UAAUC,YAAY,CAAC;EAE9G,KAAK,SACH,OAAOL,MAAMC,WAAW,WAAWG,cAAcA,UAAUC,YAAY,CAAC;EAE1E,KAAK,YACH,OAAOL,MAAMC,WAAW,uBAAuBG,cAAcA,UAAUC,YAAY,CAAC;EAEtF,SACE,OAAOpB;CAEX;AACF;;;;;;;AAQA,SAAgBqB,SAASrB,OAAkD;CACzE,OAAO,OAAOA,SAAU,cAAYA;AACtC;;;;;;;;;AAUA,SAAgBuB,SAASvB,OAAgBwB,MAAgB;CACvD,IAAIC,UAAmBzB;CAEvB,KAAK,IAAM0B,WAAWF,MAAM;EAC1B,IAAI,CAACH,SAASI,OAAO,GAAG;EAExBA,UAAUA,QAAQC;CACpB;CAEA,OAAOD;AACT;;;;;;;;ACjFA,SAASM,iBAAiBC,cAAmD;CAC3E,IAAI,CAACJ,UAAUI,YAAY,GAAG;CAE9B,IAAME,UAAUF,aAAaG,SAAS,EAAEC,KAAKC,YAAY;EACvD,IAAMC,OAAOT,WAAWO,GAAG;EAE3B,OAAOR,UAAUU,IAAI,IAAI,CAAC,CAACA,MAAMT,WAAWQ,KAAK,KAAK,EAAE,CAAU,IAAI,CAAA;CACxE,CAAC;CAED,OAAOH,QAAQM,SAAS,IAAIC,OAAOC,YAAYR,OAAO,IAAID,KAAAA;AAC5D;;;;;;;;AASA,SAAgBU,iBAAiBC,OAA2BC,SAA6B;CACvF,IAAMC,UAAUjB,WAAWe,KAAK;CAChC,IAAI,CAAChB,UAAUkB,OAAO,GAAG;CAEzB,IAAMC,OAAOlB,WAAWgB,OAAO;CAE/B,OAAOjB,UAAUmB,IAAI,IAAI,UAAUD,QAAO,WAAYE,mBAAmBD,IAAI,MAAM,UAAUD;AAC/F;;;;;;;;AASA,SAAgBG,iBAAiBC,OAA2B;CAC1D,IAAMC,SAAStB,WAAWqB,KAAK;CAC1BtB,cAAUuB,MAAM,GAErB,OAAO,OAAOA,OAAOC,WAAW,SAAS,EAAE;AAC7C;;;;;;;;;;AAWA,SAAgBC,kBACdC,MACAC,QACAvB,cACA;CACA,IAAMwB,SAASzB,iBAAiBC,YAAY,GACtCyB,OAAO5B,WAAW0B,MAAM;CAC9B,IAAI,CAAC3B,UAAU4B,MAAM,KAAK,CAAC5B,UAAU6B,IAAI,GAAG,OAAOH;CAGnD,IAAMI,cAAc;CAEpB,IAAI;EACF,IAAMC,MAAM,IAAIC,IAAIN,MAAMI,WAAW;EAGrC,KAAK,IAAM,CAACtB,KAAKC,UAAUI,OAAOP,QAAQsB,UAAU,CAAC,CAAC,GAAGG,IAAI3B,aAAa6B,IAAIzB,KAAKC,KAAK;EAGxF,OAFIT,UAAU6B,IAAI,MAAGE,IAAIF,OAAO9B,YAAY8B,MAAM,OAAO,IAElDE,IAAIG,WAAWJ,cAAcC,IAAII,WAAWJ,IAAIK,SAASL,IAAIF,OAAOE,IAAIL;CACjF,QAAQ;EACN,OAAOA;CACT;AACF;;;;;;;AAQA,SAAgBW,kBAAkBV,QAA4B;CAC5D,IAAME,OAAO5B,WAAW0B,MAAM;CACzB3B,cAAU6B,IAAI,GAEnB,OAAO,IAAI9B,YAAY8B,MAAM,OAAO;AACtC;;AClGA,MAAaS,eAAe,QAMfC,mBAAmB,YAGnBC,sBAAsB,mBAGtBC,mBAAmB;CAAC;CAAQ;CAAU;CAAO;CAAS;CAAS;AAAM"}

package/dist/types-BXseTKgu.d.ts

@@ -0,0 +1,176 @@
+/** Type name of the link object. */
+declare const linkTypeName = "link";
+/**
+ * Type name a link takes as a Portable Text annotation. It is stored as `_type`, which is how the
+ * label field and the resolver tell an annotated span from a link field.
+ */
+declare const linkMarkTypeName = "linkMark";
+/** Type name of one search parameter on an internal link. */
+declare const searchParamTypeName = "linkSearchParam";
+/** Kinds of destination a link may point at, in the order the Studio offers them. */
+declare const linkDestinations: readonly ["page", "anchor", "url", "email", "phone", "file"];
+/**
+ * Which kind of destination a link points at, discriminating the stored union.
+ *
+ * @public
+ */
+type SanityLinkDestination = (typeof linkDestinations)[number];
+/**
+ * Values filling a document's route parameters, present once a query spreads the route params fragment.
+ *
+ * @public
+ */
+type SanityLinkRouteParams = Record<string, string | null | undefined>;
+/**
+ * A pointer to another document, holding the raw reference until a query expands it into the document
+ * itself.
+ *
+ * @public
+ */
+type SanityLinkReference<T> = {
+  _ref: string;
+} | T;
+/**
+ * The document an internal link points at, holding as much of it as resolution reads. Narrow this to
+ * a consumer's own routed document type wherever a stored link is typed.
+ *
+ * @public
+ */
+interface SanityLinkDocument {
+  _id: string;
+  _type: string;
+  /** Values filling this document's route parameters, absent when its query left them unfetched. */
+  _routeParams?: SanityLinkRouteParams;
+  /** Title the link borrows when no label was written. */
+  title?: string;
+}
+/**
+ * The file a download link serves, holding as much of it as resolution reads.
+ *
+ * @public
+ */
+interface SanityLinkFileAsset {
+  _id: string;
+  _type: string;
+  /** Address the file is served from. */
+  url?: string;
+  /** Name the file was uploaded under, offered to the browser as the name to save it by. */
+  originalFilename?: string;
+}
+/**
+ * A file field, whose asset stays a raw reference until a query expands it.
+ *
+ * @public
+ */
+interface SanityLinkFile {
+  _type: "file";
+  /** The uploaded file itself. */
+  asset?: SanityLinkReference<SanityLinkFileAsset>;
+}
+/**
+ * One query string parameter appended to an internal link's address.
+ *
+ * @public
+ */
+interface SanityLinkSearchParam {
+  _type: typeof searchParamTypeName;
+  _key: string;
+  /** Name the parameter is read under. */
+  key?: string;
+  /** Value the parameter carries. */
+  value?: string;
+}
+/**
+ * A link to a page on the site itself, pointing at the document rather than its address so the link
+ * survives that document's slug changing.
+ *
+ * @public
+ */
+interface SanityPageLink<TDocument = SanityLinkDocument> {
+  _type: typeof linkTypeName | typeof linkMarkTypeName;
+  type: "page";
+  /** Document the link points at. */
+  reference?: SanityLinkReference<TDocument>;
+  /** Section of the destination page to arrive at, stored without its leading hash. */
+  anchor?: string;
+  /** Query string parameters appended to the destination's address. */
+  searchParams?: SanityLinkSearchParam[];
+  /** Text a visitor reads, standing in front of the destination document's own title. */
+  label?: string;
+}
+/**
+ * A link to a section of the page it is drawn on, for moving a visitor within a page rather than
+ * between them.
+ *
+ * @public
+ */
+interface SanityAnchorLink {
+  _type: typeof linkTypeName | typeof linkMarkTypeName;
+  type: "anchor";
+  /** Section of this page to arrive at, stored without its leading hash. */
+  anchor?: string;
+  /** Text a visitor reads. */
+  label?: string;
+}
+/**
+ * A link to an address elsewhere, covering any web page the site does not serve itself.
+ *
+ * @public
+ */
+interface SanityUrlLink {
+  _type: typeof linkTypeName | typeof linkMarkTypeName;
+  type: "url";
+  /** Address the link points at, including the scheme in front of it. */
+  url?: string;
+  /** Text a visitor reads. */
+  label?: string;
+}
+/**
+ * A link that opens a message to an address, rather than asking an author to know a URI scheme.
+ *
+ * @public
+ */
+interface SanityEmailLink {
+  _type: typeof linkTypeName | typeof linkMarkTypeName;
+  type: "email";
+  /** Address the message is sent to. */
+  email?: string;
+  /** Subject the message opens with. */
+  subject?: string;
+  /** Text a visitor reads. */
+  label?: string;
+}
+/**
+ * A link that starts a call to a number, rather than asking an author to know a URI scheme.
+ *
+ * @public
+ */
+interface SanityPhoneLink {
+  _type: typeof linkTypeName | typeof linkMarkTypeName;
+  type: "phone";
+  /** Number the call is placed to. */
+  phone?: string;
+  /** Text a visitor reads. */
+  label?: string;
+}
+/**
+ * A link to a file a visitor downloads, held with the link rather than addressed elsewhere.
+ *
+ * @public
+ */
+interface SanityFileLink {
+  _type: typeof linkTypeName | typeof linkMarkTypeName;
+  type: "file";
+  /** File the link serves. */
+  file?: SanityLinkFile;
+  /** Text a visitor reads. */
+  label?: string;
+}
+/**
+ * A link an author authored, discriminated by the kind of destination it points at.
+ *
+ * @public
+ */
+type SanityLink<TDocument = SanityLinkDocument> = SanityPageLink<TDocument> | SanityAnchorLink | SanityUrlLink | SanityEmailLink | SanityPhoneLink | SanityFileLink;
+export { SanityLinkDestination as a, SanityLinkFileAsset as c, SanityLinkSearchParam as d, SanityPageLink as f, linkTypeName as h, SanityLink as i, SanityLinkReference as l, SanityUrlLink as m, SanityEmailLink as n, SanityLinkDocument as o, SanityPhoneLink as p, SanityFileLink as r, SanityLinkFile as s, SanityAnchorLink as t, SanityLinkRouteParams as u };
+//# sourceMappingURL=types-BXseTKgu.d.ts.map

package/dist/types-BXseTKgu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-BXseTKgu.d.ts","names":[],"sources":["../src/types.ts"],"mappings":"AACA;cAAa;;;;;cAMA;;cAGA;;cAGA;;;;;;KAOD,gCAAgC;;;;;;KAOhC,wBAAwB;;;;;;;KAQxB,oBAAoB;EAAO;IAAiB;;;;;;;UAQvC;EACf;EACA;;EAEA,eAAe;;EAEf;;;;;;;UAQe;EACf;EACA;;EAEA;;EAEA;;;;;;;UAQe;EACf;;EAEA,QAAQ,oBAAoB;;;;;;;UAQb;EACf,cAAc;EACd;;EAEA;;EAEA;;;;;;;;UASe,eAAe,YAAY;EAC1C,cAAc,sBAAsB;EACpC;;EAEA,YAAY,oBAAoB;;EAEhC;;EAEA,eAAe;;EAEf;;;;;;;;UASe;EACf,cAAc,sBAAsB;EACpC;;EAEA;;EAEA;;;;;;;UAQe;EACf,cAAc,sBAAsB;EACpC;;EAEA;;EAEA;;;;;;;UAQe;EACf,cAAc,sBAAsB;EACpC;;EAEA;;EAEA;;EAEA;;;;;;;UAQe;EACf,cAAc,sBAAsB;EACpC;;EAEA;;EAEA;;;;;;;UAQe;EACf,cAAc,sBAAsB;EACpC;;EAEA,OAAO;;EAEP;;;;;;;KAQU,WAAW,YAAY,sBAC/B,eAAe,aACf,mBACA,gBACA,kBACA,kBACA"}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@driftime/sanity-plugin-link",
+  "version": "0.1.0",
+  "description": "Links for Sanity Studio, covering every destination and resolved from routes declared once.",
+  "keywords": [
+    "link",
+    "portable-text",
+    "reference",
+    "sanity",
+    "sanity-plugin",
+    "url"
+  ],
+  "homepage": "https://github.com/driftime/sanity-plugins/tree/main/packages/link#readme",
+  "bugs": {
+    "url": "https://github.com/driftime/sanity-plugins/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Kenny Heard",
+    "email": "kenny@driftime.com",
+    "url": "https://driftime.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/driftime/sanity-plugins.git",
+    "directory": "packages/link"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./render": {
+      "source": "./src/render.ts",
+      "default": "./dist/render.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "exports": {
+      ".": "./dist/index.js",
+      "./render": "./dist/render.js",
+      "./package.json": "./package.json"
+    },
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc",
+    "dev": "plugin-kit link-watch",
+    "build": "bun run typecheck && plugin-kit verify-package --silent && pkg-utils build --strict --check --clean && node --check dist/index.js && node --check dist/render.js",
+    "prepublishOnly": "bun run build",
+    "push": "yalc push"
+  },
+  "dependencies": {
+    "@portabletext/editor": "^8.1.3",
+    "@portabletext/html": "^2.0.0",
+    "@sanity/client": "^7.26.2 || ^8.0.0",
+    "@sanity/icons": "^5.2.1",
+    "@sanity/ui": "^4.0.3",
+    "@sanity/util": "^6.13.2"
+  },
+  "devDependencies": {
+    "@repo/components": "workspace:*",
+    "@repo/lib": "workspace:*",
+    "@sanity/pkg-utils": "catalog:"
+  },
+  "peerDependencies": {
+    "react": "19",
+    "sanity": "^6.10.0"
+  },
+  "browserslist": "extends @sanity/browserslist-config",
+  "engines": {
+    "node": ">=20.19 <22 || >=22.12"
+  },
+  "sanityPlugin": {
+    "verifyPackage": {
+      "tsconfig": false,
+      "scripts": false,
+      "oxlint": false,
+      "oxfmt": false
+    }
+  }
+}