@vtex/faststore 0.0.6 → 0.0.8

package/dist/sdk/navigation/not-found-log.js

@@ -0,0 +1,133 @@
+import { normalizePath as normalizePath$1 } from "./path.js";
+//#region src/sdk/navigation/not-found-log.ts
+/** First segments no page may occupy (the page model's `RESERVED_SEGMENTS`): platform routes live there. */
+const RESERVED_SEGMENTS = /* @__PURE__ */ new Set(["api", "_next"]);
+function isProduction() {
+	return process.env.NODE_ENV === "production";
+}
+/** Lower-case, one trailing dot, then a trailing `:80` or `:443`. */
+function normalizeHost(host) {
+	return host.toLowerCase().replace(/\.$/, "").replace(/:(?:80|443)$/, "");
+}
+function stripQueryAndHash(raw) {
+	return raw.split(/[?#]/, 1)[0] ?? "";
+}
+/** The resolver's slash rule: `''` and `'/'` become `'/'`. */
+function normalizePath(raw) {
+	return normalizePath$1(stripQueryAndHash(raw));
+}
+/** `'/'` has no segments. Do not decode. */
+function segmentsOf(raw) {
+	const normalized = normalizePath(raw);
+	if (normalized === "/") return [];
+	return normalized.split("/").slice(1);
+}
+function isReserved(path) {
+	const [first] = segmentsOf(path);
+	return first !== void 0 && RESERVED_SEGMENTS.has(first);
+}
+function isOptionalCatchAll(segment) {
+	return segment.startsWith("[[...") && segment.endsWith("]]");
+}
+function isCatchAll(segment) {
+	return segment.startsWith("[...") && segment.endsWith("]");
+}
+function isDynamic(segment) {
+	return segment.startsWith("[") && segment.endsWith("]") && !segment.includes("...");
+}
+/**
+* A pattern matches a path when each literal equals the next segment, `[name]` consumes one, and a
+* catch-all is last: `[...name]` takes one or more, `[[...name]]` takes the rest including none.
+*/
+function patternMatches(pattern, path) {
+	const patternSegments = segmentsOf(pattern);
+	const pathSegments = segmentsOf(path);
+	let pathIndex = 0;
+	for (let index = 0; index < patternSegments.length; index += 1) {
+		const segment = patternSegments[index] ?? "";
+		const last = index === patternSegments.length - 1;
+		if (isOptionalCatchAll(segment)) return last;
+		if (isCatchAll(segment)) return last && pathIndex < pathSegments.length;
+		const next = pathSegments[pathIndex];
+		if (next === void 0) return false;
+		if (!isDynamic(segment) && segment !== next) return false;
+		pathIndex += 1;
+	}
+	return pathIndex === pathSegments.length;
+}
+/**
+* Whether the entry serves this logical path. With a binding, only the path the binding serves the
+* page at counts (its alias, or the pattern), and only when the page is served there. Without one,
+* the pattern or any alias counts.
+*/
+function matchesEntry(entry, logicalPath, bindingId) {
+	if (bindingId === null) {
+		if (patternMatches(entry.pattern, logicalPath)) return true;
+		return Object.values(entry.aliases ?? {}).some((alias) => patternMatches(alias, logicalPath));
+	}
+	if (entry.bindings !== void 0 && !entry.bindings.includes(bindingId)) return false;
+	return patternMatches((entry.aliases && Object.hasOwn(entry.aliases, bindingId) ? entry.aliases[bindingId] : void 0) ?? entry.pattern, logicalPath);
+}
+/**
+* A referrer on a host this store serves. A synthesized binding bakes `host: ""`, so `knownHost` is
+* false for every real host and `knownHost("")` is true — that empty host is not consulted. The
+* fallback is the two hosts matching after normalisation, and only when the request host itself is
+* not a known host.
+*/
+function isSameStore(refererHost, requestHost, knownHost) {
+	if (knownHost(refererHost)) return true;
+	if (knownHost(requestHost)) return false;
+	return normalizeHost(refererHost) === normalizeHost(requestHost);
+}
+/** The request's logical path, and the binding it falls in when the resolver knows one. */
+function logicalRequest(requestHost, requestPath, resolveBinding, toLogicalPath) {
+	const resolved = resolveBinding(requestHost, requestPath);
+	if (!resolved) return {
+		logicalPath: normalizePath(requestPath),
+		bindingId: null
+	};
+	return {
+		logicalPath: normalizePath(toLogicalPath(resolved.context, requestPath)),
+		bindingId: resolved.context.bindingId
+	};
+}
+function warnNotFound(ref, path) {
+	console.warn(`link.not-found: ${JSON.stringify(ref)} was requested from ${JSON.stringify(path)}, and the store declares no page there.`);
+}
+/**
+* Logs `link.not-found` for a request whose referrer is a page of this store and whose path is not
+* a page the store declared. Silent for an external referrer, a reload of this 404, a reserved
+* first segment (`api`, `_next`), and an entity or content 404 whose path is one the binding serves
+* a page at.
+* Not deduplicated.
+*/
+function reportNotFoundRequest({ referer, requestHost, requestPath, routeMap, knownHost, resolveBinding, toLogicalPath }) {
+	if (referer === null) return;
+	let refererUrl;
+	try {
+		refererUrl = new URL(referer);
+	} catch {
+		return;
+	}
+	if (!isSameStore(refererUrl.host, requestHost, knownHost)) return;
+	const ref = normalizePath(requestPath);
+	const path = normalizePath(refererUrl.pathname);
+	if (ref === path) return;
+	const { logicalPath, bindingId } = logicalRequest(requestHost, requestPath, resolveBinding, toLogicalPath);
+	if (isReserved(ref) || isReserved(logicalPath)) return;
+	if (Object.values(routeMap).some((entry) => matchesEntry(entry, logicalPath, bindingId))) return;
+	if (!isProduction()) {
+		warnNotFound(ref, path);
+		return;
+	}
+	console.error(JSON.stringify({
+		event: "link.not-found",
+		reason: "not-found",
+		ref,
+		path
+	}));
+}
+//#endregion
+export { reportNotFoundRequest };
+
+//# sourceMappingURL=not-found-log.js.map

package/dist/sdk/navigation/not-found-log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"not-found-log.js","names":["normalizeSlashes"],"sources":["../../../src/sdk/navigation/not-found-log.ts"],"sourcesContent":["import { normalizePath as normalizeSlashes } from './path.js';\nimport type { ToLogicalPath } from './route-map-provider.js';\nimport type { RouteMap, RouteMapEntry } from './types.js';\n\ntype ResolvedBinding = { context: { basePath: string; bindingId: string } } | null;\n\ntype ReportNotFoundRequestInput = Readonly<{\n  referer: string | null;\n  requestHost: string;\n  requestPath: string;\n  routeMap: RouteMap;\n  knownHost: (host: string) => boolean;\n  resolveBinding: (host: string, pathname: string) => ResolvedBinding;\n  toLogicalPath: ToLogicalPath;\n}>;\n\n/** First segments no page may occupy (the page model's `RESERVED_SEGMENTS`): platform routes live there. */\nconst RESERVED_SEGMENTS = new Set(['api', '_next']);\n\nfunction isProduction(): boolean {\n  return process.env.NODE_ENV === 'production';\n}\n\n/** Lower-case, one trailing dot, then a trailing `:80` or `:443`. */\nfunction normalizeHost(host: string): string {\n  return host\n    .toLowerCase()\n    .replace(/\\.$/, '')\n    .replace(/:(?:80|443)$/, '');\n}\n\nfunction stripQueryAndHash(raw: string): string {\n  return raw.split(/[?#]/, 1)[0] ?? '';\n}\n\n/** The resolver's slash rule: `''` and `'/'` become `'/'`. */\nfunction normalizePath(raw: string): string {\n  return normalizeSlashes(stripQueryAndHash(raw));\n}\n\n/** `'/'` has no segments. Do not decode. */\nfunction segmentsOf(raw: string): string[] {\n  const normalized = normalizePath(raw);\n  if (normalized === '/') return [];\n  return normalized.split('/').slice(1);\n}\n\nfunction isReserved(path: string): boolean {\n  const [first] = segmentsOf(path);\n  return first !== undefined && RESERVED_SEGMENTS.has(first);\n}\n\nfunction isOptionalCatchAll(segment: string): boolean {\n  return segment.startsWith('[[...') && segment.endsWith(']]');\n}\n\nfunction isCatchAll(segment: string): boolean {\n  return segment.startsWith('[...') && segment.endsWith(']');\n}\n\nfunction isDynamic(segment: string): boolean {\n  return segment.startsWith('[') && segment.endsWith(']') && !segment.includes('...');\n}\n\n/**\n * A pattern matches a path when each literal equals the next segment, `[name]` consumes one, and a\n * catch-all is last: `[...name]` takes one or more, `[[...name]]` takes the rest including none.\n */\nfunction patternMatches(pattern: string, path: string): boolean {\n  const patternSegments = segmentsOf(pattern);\n  const pathSegments = segmentsOf(path);\n  let pathIndex = 0;\n\n  for (let index = 0; index < patternSegments.length; index += 1) {\n    const segment = patternSegments[index] ?? '';\n    const last = index === patternSegments.length - 1;\n    if (isOptionalCatchAll(segment)) return last;\n    if (isCatchAll(segment)) return last && pathIndex < pathSegments.length;\n    const next = pathSegments[pathIndex];\n    if (next === undefined) return false;\n    if (!isDynamic(segment) && segment !== next) return false;\n    pathIndex += 1;\n  }\n\n  return pathIndex === pathSegments.length;\n}\n\n/**\n * Whether the entry serves this logical path. With a binding, only the path the binding serves the\n * page at counts (its alias, or the pattern), and only when the page is served there. Without one,\n * the pattern or any alias counts.\n */\nfunction matchesEntry(entry: RouteMapEntry, logicalPath: string, bindingId: string | null): boolean {\n  if (bindingId === null) {\n    if (patternMatches(entry.pattern, logicalPath)) return true;\n    return Object.values(entry.aliases ?? {}).some((alias) => patternMatches(alias, logicalPath));\n  }\n  if (entry.bindings !== undefined && !entry.bindings.includes(bindingId)) return false;\n  const alias = entry.aliases && Object.hasOwn(entry.aliases, bindingId) ? entry.aliases[bindingId] : undefined;\n  return patternMatches(alias ?? entry.pattern, logicalPath);\n}\n\n/**\n * A referrer on a host this store serves. A synthesized binding bakes `host: \"\"`, so `knownHost` is\n * false for every real host and `knownHost(\"\")` is true — that empty host is not consulted. The\n * fallback is the two hosts matching after normalisation, and only when the request host itself is\n * not a known host.\n */\nfunction isSameStore(refererHost: string, requestHost: string, knownHost: (host: string) => boolean): boolean {\n  if (knownHost(refererHost)) return true;\n  if (knownHost(requestHost)) return false;\n  return normalizeHost(refererHost) === normalizeHost(requestHost);\n}\n\n/** The request's logical path, and the binding it falls in when the resolver knows one. */\nfunction logicalRequest(\n  requestHost: string,\n  requestPath: string,\n  resolveBinding: ReportNotFoundRequestInput['resolveBinding'],\n  toLogicalPath: ToLogicalPath,\n): { logicalPath: string; bindingId: string | null } {\n  const resolved = resolveBinding(requestHost, requestPath);\n  if (!resolved) return { logicalPath: normalizePath(requestPath), bindingId: null };\n  return {\n    logicalPath: normalizePath(toLogicalPath(resolved.context, requestPath)),\n    bindingId: resolved.context.bindingId,\n  };\n}\n\nfunction warnNotFound(ref: string, path: string): void {\n  console.warn(\n    `link.not-found: ${JSON.stringify(ref)} was requested from ${JSON.stringify(path)}, ` +\n      'and the store declares no page there.',\n  );\n}\n\n/**\n * Logs `link.not-found` for a request whose referrer is a page of this store and whose path is not\n * a page the store declared. Silent for an external referrer, a reload of this 404, a reserved\n * first segment (`api`, `_next`), and an entity or content 404 whose path is one the binding serves\n * a page at.\n * Not deduplicated.\n */\nexport function reportNotFoundRequest({\n  referer,\n  requestHost,\n  requestPath,\n  routeMap,\n  knownHost,\n  resolveBinding,\n  toLogicalPath,\n}: ReportNotFoundRequestInput): void {\n  if (referer === null) return;\n\n  let refererUrl: URL;\n  try {\n    refererUrl = new URL(referer);\n  } catch {\n    return;\n  }\n\n  if (!isSameStore(refererUrl.host, requestHost, knownHost)) return;\n\n  const ref = normalizePath(requestPath);\n  const path = normalizePath(refererUrl.pathname);\n  if (ref === path) return;\n\n  const { logicalPath, bindingId } = logicalRequest(requestHost, requestPath, resolveBinding, toLogicalPath);\n  if (isReserved(ref) || isReserved(logicalPath)) return;\n\n  const declared = Object.values(routeMap).some((entry) => matchesEntry(entry, logicalPath, bindingId));\n  if (declared) return;\n\n  if (!isProduction()) {\n    warnNotFound(ref, path);\n    return;\n  }\n\n  console.error(JSON.stringify({ event: 'link.not-found', reason: 'not-found', ref, path }));\n}\n"],"mappings":";;;AAiBA,MAAM,oCAAoB,IAAI,IAAI,CAAC,OAAO,OAAO,CAAC;AAElD,SAAS,eAAwB;CAC/B,OAAO,QAAQ,IAAI,aAAa;AAClC;;AAGA,SAAS,cAAc,MAAsB;CAC3C,OAAO,KACJ,YAAY,CAAC,CACb,QAAQ,OAAO,EAAE,CAAC,CAClB,QAAQ,gBAAgB,EAAE;AAC/B;AAEA,SAAS,kBAAkB,KAAqB;CAC9C,OAAO,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,MAAM;AACpC;;AAGA,SAAS,cAAc,KAAqB;CAC1C,OAAOA,gBAAiB,kBAAkB,GAAG,CAAC;AAChD;;AAGA,SAAS,WAAW,KAAuB;CACzC,MAAM,aAAa,cAAc,GAAG;CACpC,IAAI,eAAe,KAAK,OAAO,CAAC;CAChC,OAAO,WAAW,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;AACtC;AAEA,SAAS,WAAW,MAAuB;CACzC,MAAM,CAAC,SAAS,WAAW,IAAI;CAC/B,OAAO,UAAU,KAAA,KAAa,kBAAkB,IAAI,KAAK;AAC3D;AAEA,SAAS,mBAAmB,SAA0B;CACpD,OAAO,QAAQ,WAAW,OAAO,KAAK,QAAQ,SAAS,IAAI;AAC7D;AAEA,SAAS,WAAW,SAA0B;CAC5C,OAAO,QAAQ,WAAW,MAAM,KAAK,QAAQ,SAAS,GAAG;AAC3D;AAEA,SAAS,UAAU,SAA0B;CAC3C,OAAO,QAAQ,WAAW,GAAG,KAAK,QAAQ,SAAS,GAAG,KAAK,CAAC,QAAQ,SAAS,KAAK;AACpF;;;;;AAMA,SAAS,eAAe,SAAiB,MAAuB;CAC9D,MAAM,kBAAkB,WAAW,OAAO;CAC1C,MAAM,eAAe,WAAW,IAAI;CACpC,IAAI,YAAY;CAEhB,KAAK,IAAI,QAAQ,GAAG,QAAQ,gBAAgB,QAAQ,SAAS,GAAG;EAC9D,MAAM,UAAU,gBAAgB,UAAU;EAC1C,MAAM,OAAO,UAAU,gBAAgB,SAAS;EAChD,IAAI,mBAAmB,OAAO,GAAG,OAAO;EACxC,IAAI,WAAW,OAAO,GAAG,OAAO,QAAQ,YAAY,aAAa;EACjE,MAAM,OAAO,aAAa;EAC1B,IAAI,SAAS,KAAA,GAAW,OAAO;EAC/B,IAAI,CAAC,UAAU,OAAO,KAAK,YAAY,MAAM,OAAO;EACpD,aAAa;CACf;CAEA,OAAO,cAAc,aAAa;AACpC;;;;;;AAOA,SAAS,aAAa,OAAsB,aAAqB,WAAmC;CAClG,IAAI,cAAc,MAAM;EACtB,IAAI,eAAe,MAAM,SAAS,WAAW,GAAG,OAAO;EACvD,OAAO,OAAO,OAAO,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,UAAU,eAAe,OAAO,WAAW,CAAC;CAC9F;CACA,IAAI,MAAM,aAAa,KAAA,KAAa,CAAC,MAAM,SAAS,SAAS,SAAS,GAAG,OAAO;CAEhF,OAAO,gBADO,MAAM,WAAW,OAAO,OAAO,MAAM,SAAS,SAAS,IAAI,MAAM,QAAQ,aAAa,KAAA,MACrE,MAAM,SAAS,WAAW;AAC3D;;;;;;;AAQA,SAAS,YAAY,aAAqB,aAAqB,WAA+C;CAC5G,IAAI,UAAU,WAAW,GAAG,OAAO;CACnC,IAAI,UAAU,WAAW,GAAG,OAAO;CACnC,OAAO,cAAc,WAAW,MAAM,cAAc,WAAW;AACjE;;AAGA,SAAS,eACP,aACA,aACA,gBACA,eACmD;CACnD,MAAM,WAAW,eAAe,aAAa,WAAW;CACxD,IAAI,CAAC,UAAU,OAAO;EAAE,aAAa,cAAc,WAAW;EAAG,WAAW;CAAK;CACjF,OAAO;EACL,aAAa,cAAc,cAAc,SAAS,SAAS,WAAW,CAAC;EACvE,WAAW,SAAS,QAAQ;CAC9B;AACF;AAEA,SAAS,aAAa,KAAa,MAAoB;CACrD,QAAQ,KACN,mBAAmB,KAAK,UAAU,GAAG,EAAE,sBAAsB,KAAK,UAAU,IAAI,EAAE,wCAEpF;AACF;;;;;;;;AASA,SAAgB,sBAAsB,EACpC,SACA,aACA,aACA,UACA,WACA,gBACA,iBACmC;CACnC,IAAI,YAAY,MAAM;CAEtB,IAAI;CACJ,IAAI;EACF,aAAa,IAAI,IAAI,OAAO;CAC9B,QAAQ;EACN;CACF;CAEA,IAAI,CAAC,YAAY,WAAW,MAAM,aAAa,SAAS,GAAG;CAE3D,MAAM,MAAM,cAAc,WAAW;CACrC,MAAM,OAAO,cAAc,WAAW,QAAQ;CAC9C,IAAI,QAAQ,MAAM;CAElB,MAAM,EAAE,aAAa,cAAc,eAAe,aAAa,aAAa,gBAAgB,aAAa;CACzG,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,GAAG;CAGhD,IADiB,OAAO,OAAO,QAAQ,CAAC,CAAC,MAAM,UAAU,aAAa,OAAO,aAAa,SAAS,CACxF,GAAG;CAEd,IAAI,CAAC,aAAa,GAAG;EACnB,aAAa,KAAK,IAAI;EACtB;CACF;CAEA,QAAQ,MAAM,KAAK,UAAU;EAAE,OAAO;EAAkB,QAAQ;EAAa;EAAK;CAAK,CAAC,CAAC;AAC3F"}

package/dist/sdk/navigation/path.js

@@ -0,0 +1,25 @@
+//#region src/sdk/navigation/path.ts
+/**
+* The resolver's slash rule, shared by what resolves a link and what logs a 404: `''` and `'/'`
+* become `'/'`, and any other path keeps one leading slash and no trailing slash.
+*/
+function normalizePath(pathname) {
+	const trimmed = pathname.replaceAll(/^\/+|\/+$/g, "");
+	return trimmed.length === 0 ? "/" : `/${trimmed}`;
+}
+/**
+* A site-relative href that already carries `basePath` (a URL pasted from the address bar, a
+* bookmark) as the logical path it names, so prefixing it does not double the base path. Any other
+* href is returned as is.
+*/
+function withoutBasePath(href, basePath) {
+	if (basePath === "/") return href;
+	if (href === basePath) return "/";
+	const rest = href.slice(basePath.length);
+	if (!href.startsWith(basePath) || !/^[/?#]/.test(rest)) return href;
+	return rest.startsWith("/") ? rest : `/${rest}`;
+}
+//#endregion
+export { normalizePath, withoutBasePath };
+
+//# sourceMappingURL=path.js.map

package/dist/sdk/navigation/path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","names":[],"sources":["../../../src/sdk/navigation/path.ts"],"sourcesContent":["/**\n * The resolver's slash rule, shared by what resolves a link and what logs a 404: `''` and `'/'`\n * become `'/'`, and any other path keeps one leading slash and no trailing slash.\n */\nexport function normalizePath(pathname: string): string {\n  const trimmed = pathname.replaceAll(/^\\/+|\\/+$/g, '');\n  return trimmed.length === 0 ? '/' : `/${trimmed}`;\n}\n\n/**\n * A site-relative href that already carries `basePath` (a URL pasted from the address bar, a\n * bookmark) as the logical path it names, so prefixing it does not double the base path. Any other\n * href is returned as is.\n */\nexport function withoutBasePath(href: string, basePath: string): string {\n  if (basePath === '/') return href;\n  if (href === basePath) return '/';\n  const rest = href.slice(basePath.length);\n  if (!href.startsWith(basePath) || !/^[/?#]/.test(rest)) return href;\n  return rest.startsWith('/') ? rest : `/${rest}`;\n}\n"],"mappings":";;;;;AAIA,SAAgB,cAAc,UAA0B;CACtD,MAAM,UAAU,SAAS,WAAW,cAAc,EAAE;CACpD,OAAO,QAAQ,WAAW,IAAI,MAAM,IAAI;AAC1C;;;;;;AAOA,SAAgB,gBAAgB,MAAc,UAA0B;CACtE,IAAI,aAAa,KAAK,OAAO;CAC7B,IAAI,SAAS,UAAU,OAAO;CAC9B,MAAM,OAAO,KAAK,MAAM,SAAS,MAAM;CACvC,IAAI,CAAC,KAAK,WAAW,QAAQ,KAAK,CAAC,SAAS,KAAK,IAAI,GAAG,OAAO;CAC/D,OAAO,KAAK,WAAW,GAAG,IAAI,OAAO,IAAI;AAC3C"}

package/dist/sdk/navigation/redirect.d.ts

@@ -0,0 +1,11 @@
+import { StorefrontContext } from "../../core/dist/schema/generated/schema.js";
+import "../../core/dist/index.js";
+import { PageRef, RouteMap } from "./types.js";
+//#region src/sdk/navigation/redirect.d.ts
+type BindingContext = Pick<StorefrontContext, 'bindingId' | 'basePath'>;
+/** Next's `redirect` to a page reference or a logical path, resolved for the binding. */
+export declare function redirectToStorefrontPage(context: BindingContext, routeMap: RouteMap, target: PageRef | string): never;
+/** Next's `permanentRedirect` to a page reference or a logical path, resolved for the binding. */
+export declare function permanentRedirectToStorefrontPage(context: BindingContext, routeMap: RouteMap, target: PageRef | string): never;
+//#endregion
+//# sourceMappingURL=redirect.d.ts.map

package/dist/sdk/navigation/redirect.js

@@ -0,0 +1,22 @@
+import { resolveStorefrontHref } from "./resolve-storefront-href.js";
+import { reportUnresolved } from "./report.js";
+import { permanentRedirect, redirect } from "next/navigation";
+//#region src/sdk/navigation/redirect.ts
+function resolveOrThrow(context, routeMap, target) {
+	const result = resolveStorefrontHref(context, routeMap, target);
+	if (result.href !== null) return result.href;
+	reportUnresolved(result.reason, target);
+	throw new Error(`Cannot redirect: ${JSON.stringify(target)} resolved to no href (${result.reason}) on binding ${JSON.stringify(context.bindingId)}.`);
+}
+/** Next's `redirect` to a page reference or a logical path, resolved for the binding. */
+function redirectToStorefrontPage(context, routeMap, target) {
+	return redirect(resolveOrThrow(context, routeMap, target));
+}
+/** Next's `permanentRedirect` to a page reference or a logical path, resolved for the binding. */
+function permanentRedirectToStorefrontPage(context, routeMap, target) {
+	return permanentRedirect(resolveOrThrow(context, routeMap, target));
+}
+//#endregion
+export { permanentRedirectToStorefrontPage, redirectToStorefrontPage };
+
+//# sourceMappingURL=redirect.js.map

package/dist/sdk/navigation/redirect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.js","names":[],"sources":["../../../src/sdk/navigation/redirect.ts"],"sourcesContent":["import type { StorefrontContext } from '@vtex/fs-core';\nimport { permanentRedirect, redirect } from 'next/navigation';\nimport { reportUnresolved } from './report.js';\nimport { resolveStorefrontHref } from './resolve-storefront-href.js';\nimport type { PageRef, RouteMap } from './types.js';\n\ntype BindingContext = Pick<StorefrontContext, 'bindingId' | 'basePath'>;\n\nfunction resolveOrThrow(context: BindingContext, routeMap: RouteMap, target: PageRef | string): string {\n  const result = resolveStorefrontHref(context, routeMap, target);\n  if (result.href !== null) return result.href;\n  reportUnresolved(result.reason, target);\n  throw new Error(\n    `Cannot redirect: ${JSON.stringify(target)} resolved to no href (${result.reason}) on ` +\n      `binding ${JSON.stringify(context.bindingId)}.`,\n  );\n}\n\n/** Next's `redirect` to a page reference or a logical path, resolved for the binding. */\nexport function redirectToStorefrontPage(context: BindingContext, routeMap: RouteMap, target: PageRef | string): never {\n  return redirect(resolveOrThrow(context, routeMap, target));\n}\n\n/** Next's `permanentRedirect` to a page reference or a logical path, resolved for the binding. */\nexport function permanentRedirectToStorefrontPage(\n  context: BindingContext,\n  routeMap: RouteMap,\n  target: PageRef | string,\n): never {\n  return permanentRedirect(resolveOrThrow(context, routeMap, target));\n}\n"],"mappings":";;;;AAQA,SAAS,eAAe,SAAyB,UAAoB,QAAkC;CACrG,MAAM,SAAS,sBAAsB,SAAS,UAAU,MAAM;CAC9D,IAAI,OAAO,SAAS,MAAM,OAAO,OAAO;CACxC,iBAAiB,OAAO,QAAQ,MAAM;CACtC,MAAM,IAAI,MACR,oBAAoB,KAAK,UAAU,MAAM,EAAE,wBAAwB,OAAO,OAAO,eACpE,KAAK,UAAU,QAAQ,SAAS,EAAE,EACjD;AACF;;AAGA,SAAgB,yBAAyB,SAAyB,UAAoB,QAAiC;CACrH,OAAO,SAAS,eAAe,SAAS,UAAU,MAAM,CAAC;AAC3D;;AAGA,SAAgB,kCACd,SACA,UACA,QACO;CACP,OAAO,kBAAkB,eAAe,SAAS,UAAU,MAAM,CAAC;AACpE"}

package/dist/sdk/navigation/report.js

@@ -0,0 +1,70 @@
+//#region src/sdk/navigation/report.ts
+/** Reasons a store produces on purpose, such as a page it does not serve on this binding. */
+const DEGRADATION_REASONS = /* @__PURE__ */ new Set([
+	"unknown-page",
+	"unknown-standard",
+	"outside-bindings"
+]);
+const warned = /* @__PURE__ */ new Set();
+function isProduction() {
+	return process.env.NODE_ENV === "production";
+}
+/**
+* Logs one link that resolved to `null`. In production: one-line JSON `link.unresolved`, on
+* `console.info` for an intended degradation and `console.error` for a bug. Elsewhere: a readable
+* `console.warn`. Callers deduplicate: `useStorefrontNavigation` reports a link once per component.
+*/
+function reportUnresolved(reason, ref) {
+	if (!isProduction()) {
+		console.warn(`hrefFor: ${JSON.stringify(ref)} resolved to no href (${reason}).`);
+		return;
+	}
+	const line = JSON.stringify({
+		event: "link.unresolved",
+		reason,
+		ref,
+		path: globalThis.location?.pathname ?? null
+	});
+	if (DEGRADATION_REASONS.has(reason)) console.info(line);
+	else console.error(line);
+}
+function warnOnce(message) {
+	if (warned.has(message)) return;
+	warned.add(message);
+	console.warn(message);
+}
+/** The path without query and hash, and without trailing slashes (`'/'` stays `'/'`). */
+function barePath(raw) {
+	const trimmed = (raw.split(/[?#]/, 1)[0] ?? "").replace(/\/+$/, "");
+	return trimmed.length === 0 ? "/" : trimmed;
+}
+/**
+* Development-only warnings for a logical path that should not be one: a path that already carries
+* this binding's base path, and a path equal to a singleton page's pattern or alias. Warns once per
+* message. Changes nothing about the resolved href.
+*/
+function warnSuspiciousPath(context, routeMap, raw) {
+	if (isProduction()) return;
+	const trimmed = raw.trim();
+	if (!trimmed.startsWith("/")) return;
+	const { basePath } = context;
+	if (basePath !== "/" && (trimmed === basePath || trimmed.startsWith(`${basePath}/`))) warnOnce(`hrefFor: ${JSON.stringify(raw)} already starts with this binding's base path ${JSON.stringify(basePath)}, which hrefFor adds. Pass the logical path instead.`);
+	for (const name of singletonsAt(routeMap).get(barePath(trimmed)) ?? []) warnOnce(`hrefFor: ${JSON.stringify(raw)} is the path of page ${JSON.stringify(name)}. Reference the page instead: { page: '${name}' }.`);
+}
+const singletonPaths = /* @__PURE__ */ new WeakMap();
+/** The singleton pages at each pattern or alias of this route map, built once per map. */
+function singletonsAt(routeMap) {
+	const cached = singletonPaths.get(routeMap);
+	if (cached) return cached;
+	const table = /* @__PURE__ */ new Map();
+	for (const [name, entry] of Object.entries(routeMap)) {
+		if (entry.kind !== "singleton") continue;
+		for (const literal of /* @__PURE__ */ new Set([entry.pattern, ...Object.values(entry.aliases ?? {})])) table.set(literal, [...table.get(literal) ?? [], name]);
+	}
+	singletonPaths.set(routeMap, table);
+	return table;
+}
+//#endregion
+export { reportUnresolved, warnSuspiciousPath };
+
+//# sourceMappingURL=report.js.map

package/dist/sdk/navigation/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","names":[],"sources":["../../../src/sdk/navigation/report.ts"],"sourcesContent":["import type { StorefrontContext } from '@vtex/fs-core';\nimport type { PageRef, ResolveHrefReason, RouteMap } from './types.js';\n\n/** Reasons a store produces on purpose, such as a page it does not serve on this binding. */\nconst DEGRADATION_REASONS: ReadonlySet<ResolveHrefReason> = new Set([\n  'unknown-page',\n  'unknown-standard',\n  'outside-bindings',\n]);\n\nconst warned = new Set<string>();\n\nfunction isProduction(): boolean {\n  return process.env.NODE_ENV === 'production';\n}\n\n/**\n * Logs one link that resolved to `null`. In production: one-line JSON `link.unresolved`, on\n * `console.info` for an intended degradation and `console.error` for a bug. Elsewhere: a readable\n * `console.warn`. Callers deduplicate: `useStorefrontNavigation` reports a link once per component.\n */\nexport function reportUnresolved(reason: ResolveHrefReason, ref: PageRef | string): void {\n  if (!isProduction()) {\n    console.warn(`hrefFor: ${JSON.stringify(ref)} resolved to no href (${reason}).`);\n    return;\n  }\n  const line = JSON.stringify({\n    event: 'link.unresolved',\n    reason,\n    ref,\n    path: globalThis.location?.pathname ?? null,\n  });\n  if (DEGRADATION_REASONS.has(reason)) console.info(line);\n  else console.error(line);\n}\n\nfunction warnOnce(message: string): void {\n  if (warned.has(message)) return;\n  warned.add(message);\n  console.warn(message);\n}\n\n/** The path without query and hash, and without trailing slashes (`'/'` stays `'/'`). */\nfunction barePath(raw: string): string {\n  const path = raw.split(/[?#]/, 1)[0] ?? '';\n  const trimmed = path.replace(/\\/+$/, '');\n  return trimmed.length === 0 ? '/' : trimmed;\n}\n\n/**\n * Development-only warnings for a logical path that should not be one: a path that already carries\n * this binding's base path, and a path equal to a singleton page's pattern or alias. Warns once per\n * message. Changes nothing about the resolved href.\n */\nexport function warnSuspiciousPath(\n  context: Pick<StorefrontContext, 'basePath'>,\n  routeMap: RouteMap,\n  raw: string,\n): void {\n  if (isProduction()) return;\n  const trimmed = raw.trim();\n  if (!trimmed.startsWith('/')) return;\n\n  const { basePath } = context;\n  if (basePath !== '/' && (trimmed === basePath || trimmed.startsWith(`${basePath}/`))) {\n    warnOnce(\n      `hrefFor: ${JSON.stringify(raw)} already starts with this binding's base path ${JSON.stringify(basePath)}, ` +\n        'which hrefFor adds. Pass the logical path instead.',\n    );\n  }\n\n  for (const name of singletonsAt(routeMap).get(barePath(trimmed)) ?? []) {\n    warnOnce(\n      `hrefFor: ${JSON.stringify(raw)} is the path of page ${JSON.stringify(name)}. ` +\n        `Reference the page instead: { page: '${name}' }.`,\n    );\n  }\n}\n\nconst singletonPaths = new WeakMap<RouteMap, Map<string, string[]>>();\n\n/** The singleton pages at each pattern or alias of this route map, built once per map. */\nfunction singletonsAt(routeMap: RouteMap): Map<string, string[]> {\n  const cached = singletonPaths.get(routeMap);\n  if (cached) return cached;\n  const table = new Map<string, string[]>();\n  for (const [name, entry] of Object.entries(routeMap)) {\n    if (entry.kind !== 'singleton') continue;\n    for (const literal of new Set([entry.pattern, ...Object.values(entry.aliases ?? {})])) {\n      table.set(literal, [...(table.get(literal) ?? []), name]);\n    }\n  }\n  singletonPaths.set(routeMap, table);\n  return table;\n}\n"],"mappings":";;AAIA,MAAM,sCAAsD,IAAI,IAAI;CAClE;CACA;CACA;AACF,CAAC;AAED,MAAM,yBAAS,IAAI,IAAY;AAE/B,SAAS,eAAwB;CAC/B,OAAO,QAAQ,IAAI,aAAa;AAClC;;;;;;AAOA,SAAgB,iBAAiB,QAA2B,KAA6B;CACvF,IAAI,CAAC,aAAa,GAAG;EACnB,QAAQ,KAAK,YAAY,KAAK,UAAU,GAAG,EAAE,wBAAwB,OAAO,GAAG;EAC/E;CACF;CACA,MAAM,OAAO,KAAK,UAAU;EAC1B,OAAO;EACP;EACA;EACA,MAAM,WAAW,UAAU,YAAY;CACzC,CAAC;CACD,IAAI,oBAAoB,IAAI,MAAM,GAAG,QAAQ,KAAK,IAAI;MACjD,QAAQ,MAAM,IAAI;AACzB;AAEA,SAAS,SAAS,SAAuB;CACvC,IAAI,OAAO,IAAI,OAAO,GAAG;CACzB,OAAO,IAAI,OAAO;CAClB,QAAQ,KAAK,OAAO;AACtB;;AAGA,SAAS,SAAS,KAAqB;CAErC,MAAM,WADO,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,MAAM,GAAA,CACnB,QAAQ,QAAQ,EAAE;CACvC,OAAO,QAAQ,WAAW,IAAI,MAAM;AACtC;;;;;;AAOA,SAAgB,mBACd,SACA,UACA,KACM;CACN,IAAI,aAAa,GAAG;CACpB,MAAM,UAAU,IAAI,KAAK;CACzB,IAAI,CAAC,QAAQ,WAAW,GAAG,GAAG;CAE9B,MAAM,EAAE,aAAa;CACrB,IAAI,aAAa,QAAQ,YAAY,YAAY,QAAQ,WAAW,GAAG,SAAS,EAAE,IAChF,SACE,YAAY,KAAK,UAAU,GAAG,EAAE,gDAAgD,KAAK,UAAU,QAAQ,EAAE,qDAE3G;CAGF,KAAK,MAAM,QAAQ,aAAa,QAAQ,CAAC,CAAC,IAAI,SAAS,OAAO,CAAC,KAAK,CAAC,GACnE,SACE,YAAY,KAAK,UAAU,GAAG,EAAE,uBAAuB,KAAK,UAAU,IAAI,EAAE,yCAClC,KAAK,KACjD;AAEJ;AAEA,MAAM,iCAAiB,IAAI,QAAyC;;AAGpE,SAAS,aAAa,UAA2C;CAC/D,MAAM,SAAS,eAAe,IAAI,QAAQ;CAC1C,IAAI,QAAQ,OAAO;CACnB,MAAM,wBAAQ,IAAI,IAAsB;CACxC,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,QAAQ,GAAG;EACpD,IAAI,MAAM,SAAS,aAAa;EAChC,KAAK,MAAM,2BAAW,IAAI,IAAI,CAAC,MAAM,SAAS,GAAG,OAAO,OAAO,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC,GAClF,MAAM,IAAI,SAAS,CAAC,GAAI,MAAM,IAAI,OAAO,KAAK,CAAC,GAAI,IAAI,CAAC;CAE5D;CACA,eAAe,IAAI,UAAU,KAAK;CAClC,OAAO;AACT"}

package/dist/sdk/navigation/resolve-storefront-href.d.ts

@@ -0,0 +1,12 @@
+import { StorefrontContext } from "../../core/dist/schema/generated/schema.js";
+import "../../core/dist/index.js";
+import { PageRef, ResolveHrefResult, RouteMap } from "./types.js";
+//#region src/sdk/navigation/resolve-storefront-href.d.ts
+/**
+ * The public href for one binding: a page reference looked up in the route map, or a logical path
+ * prefixed with `basePath`. An anchor is returned as written. A rejected string and a page that
+ * cannot be built return `href: null` and a reason. Never throws and never logs.
+ */
+export declare function resolveStorefrontHref(context: Pick<StorefrontContext, 'bindingId' | 'basePath'>, routeMap: RouteMap, target: PageRef | string): ResolveHrefResult;
+//#endregion
+//# sourceMappingURL=resolve-storefront-href.d.ts.map

package/dist/sdk/navigation/resolve-storefront-href.js

@@ -0,0 +1,214 @@
+import { resolveSafeHref } from "../../utils/safe-href.js";
+import { normalizePath, withoutBasePath } from "./path.js";
+//#region src/sdk/navigation/resolve-storefront-href.ts
+/**
+* A param name is what Next and the compiler accept between brackets: word characters and hyphens.
+* Shared: `matchAll` iterates a clone, so the `g` flag's `lastIndex` never leaks between calls.
+*/
+const PARAM_TOKEN = /\[\[(?:\.{3})([\w-]+)\]\]|\[\.{3}([\w-]+)\]|\[([\w-]+)\]/g;
+/**
+* The public href for one binding: a page reference looked up in the route map, or a logical path
+* prefixed with `basePath`. An anchor is returned as written. A rejected string and a page that
+* cannot be built return `href: null` and a reason. Never throws and never logs.
+*/
+function resolveStorefrontHref(context, routeMap, target) {
+	const value = target;
+	if (typeof value === "string") return resolveString(context, value);
+	if (!isRecord(value)) return {
+		href: null,
+		reason: "invalid-ref"
+	};
+	const page = value.page;
+	if (typeof page === "string") {
+		const entry = ownPage(routeMap, page);
+		if (entry === void 0) return {
+			href: null,
+			reason: "unknown-page"
+		};
+		return resolveEntry(context, entry, value);
+	}
+	const standard = value.standard;
+	if (typeof standard !== "string") return {
+		href: null,
+		reason: "invalid-ref"
+	};
+	const matches = standardIndex(routeMap).get(standard) ?? [];
+	const entry = matches[0];
+	if (entry === void 0) return {
+		href: null,
+		reason: "unknown-standard"
+	};
+	if (matches.length > 1) return {
+		href: null,
+		reason: "ambiguous-standard"
+	};
+	return resolveEntry(context, entry, value);
+}
+const standardIndexes = /* @__PURE__ */ new WeakMap();
+/** The entries that declare each standard, built once per route map: links resolve on every render. */
+function standardIndex(routeMap) {
+	const cached = standardIndexes.get(routeMap);
+	if (cached) return cached;
+	const index = /* @__PURE__ */ new Map();
+	for (const entry of Object.values(routeMap)) {
+		if (!isRouteMapEntry(entry) || entry.standard === void 0) continue;
+		index.set(entry.standard, [...index.get(entry.standard) ?? [], entry]);
+	}
+	standardIndexes.set(routeMap, index);
+	return index;
+}
+function resolveString(context, raw) {
+	const trimmed = raw.trim();
+	if (trimmed.startsWith("#")) return { href: trimmed };
+	const checked = resolveSafeHref(raw);
+	if (!checked.safe) return {
+		href: null,
+		reason: safeHrefReason(checked.reason)
+	};
+	if (checked.href.startsWith("/")) return { href: prefixBasePath(withoutBasePath(checked.href, context.basePath), context.basePath) };
+	return { href: checked.href };
+}
+function resolveEntry(context, entry, target) {
+	if (entry.bindings !== void 0 && !entry.bindings.includes(context.bindingId)) return {
+		href: null,
+		reason: "outside-bindings"
+	};
+	const filled = fillPattern(logicalPath(entry, context.bindingId), target.params);
+	if (filled === void 0) return {
+		href: null,
+		reason: "missing-param"
+	};
+	return { href: prefixBasePath(appendHash(appendQuery(filled, target.query), target.hash), context.basePath) };
+}
+/**
+* The map entry stored on `page` itself. Bracket access also sees `Object.prototype`
+* (`toString`, `constructor`, `hasOwnProperty`, `__proto__`), and those values are not pages.
+*/
+function ownPage(routeMap, page) {
+	if (!Object.hasOwn(routeMap, page)) return void 0;
+	const entry = routeMap[page];
+	return isRouteMapEntry(entry) ? entry : void 0;
+}
+function isRouteMapEntry(value) {
+	return isRecord(value) && typeof value.pattern === "string";
+}
+function logicalPath(entry, bindingId) {
+	const aliases = entry.aliases;
+	if (aliases === void 0 || !Object.hasOwn(aliases, bindingId)) return entry.pattern;
+	return aliases[bindingId] ?? entry.pattern;
+}
+function fillPattern(pattern, params) {
+	const table = isRecord(params) ? params : void 0;
+	let path = "";
+	let last = 0;
+	for (const match of pattern.matchAll(PARAM_TOKEN)) {
+		const index = match.index ?? 0;
+		path += pattern.slice(last, index);
+		const filled = fillToken(match, table);
+		if (filled === void 0) return void 0;
+		if (filled === null) {
+			if (path.endsWith("/")) path = path.slice(0, -1);
+		} else path += filled;
+		last = index + match[0].length;
+	}
+	return path + pattern.slice(last);
+}
+/**
+* The text one param token contributes: `null` for an omitted `[[...name]]`, which drops its
+* preceding slash, and `undefined` for a missing param.
+*/
+function fillToken(match, table) {
+	const [, optionalName, catchAllName, singleName] = match;
+	if (optionalName !== void 0) {
+		const filled = fillOptional(table?.[optionalName]);
+		if (filled === void 0) return void 0;
+		return filled.omit ? null : filled.text;
+	}
+	if (catchAllName !== void 0) return fillCatchAll(table?.[catchAllName]);
+	if (singleName !== void 0) return fillSingle(table?.[singleName]);
+	return "";
+}
+/** `[name]` takes one non-empty string. An array, `''`, or a missing key is a missing param. */
+function fillSingle(value) {
+	if (typeof value !== "string" || value.length === 0) return void 0;
+	return encodeURIComponent(value);
+}
+/**
+* `[...name]` takes one non-empty string (a single segment, slash included) or a non-empty list of
+* non-empty segments. Each segment is encoded on its own.
+*/
+function fillCatchAll(value) {
+	if (typeof value === "string") {
+		if (value.length === 0) return void 0;
+		return encodeURIComponent(value);
+	}
+	if (!Array.isArray(value) || value.length === 0) return void 0;
+	const segments = [];
+	for (const segment of value) {
+		if (typeof segment !== "string" || segment.length === 0) return void 0;
+		segments.push(encodeURIComponent(segment));
+	}
+	return segments.join("/");
+}
+/** `[[...name]]` omits the segment when the value is missing, `''`, or `[]`. */
+function fillOptional(value) {
+	if (value === void 0 || value === "" || Array.isArray(value) && value.length === 0) return { omit: true };
+	const text = fillCatchAll(value);
+	if (text === void 0) return void 0;
+	return {
+		omit: false,
+		text
+	};
+}
+function appendQuery(path, query) {
+	if (!isRecord(query)) return path;
+	const search = new URLSearchParams();
+	for (const [key, value] of Object.entries(query)) {
+		const values = Array.isArray(value) ? value : [value];
+		for (const item of values) if (typeof item === "string") search.append(key, item);
+	}
+	const text = search.toString();
+	return text.length === 0 ? path : `${path}?${text}`;
+}
+function appendHash(path, hash) {
+	if (typeof hash !== "string" || hash.length === 0 || hash === "#") return path;
+	return `${path}${hash.startsWith("#") ? hash : `#${hash}`}`;
+}
+/**
+* The `buildUrl` join, without an origin. `'/'` contributes no prefix, so a root path stays `'/'`
+* and a root plus a query or hash stays `'/?…'` or `'/#…'`. Any other base path joins in front, and
+* a root suffix is the bare base path (`/pt-BR`): Next.js 308-redirects `/pt-BR/` to it.
+*/
+function prefixBasePath(href, basePath) {
+	const cut = splitPath(href);
+	const pathPart = cut === -1 ? href : href.slice(0, cut);
+	const tail = cut === -1 ? "" : href.slice(cut);
+	const suffix = normalizePath(pathPart);
+	const prefix = basePath === "/" ? "" : basePath;
+	return `${suffix === "/" ? prefix || "/" : `${prefix}${suffix}`}${tail}`;
+}
+/** The first `?` or `#`, or `-1` when the href is only a path. */
+function splitPath(href) {
+	const query = href.indexOf("?");
+	const hash = href.indexOf("#");
+	if (query === -1) return hash;
+	if (hash === -1) return query;
+	return Math.min(query, hash);
+}
+function safeHrefReason(reason) {
+	switch (reason) {
+		case "blank":
+		case "malformed":
+		case "protocol-relative":
+		case "forbidden-scheme": return reason;
+		case "absolute":
+		case "sign-in-route": return "malformed";
+	}
+}
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+//#endregion
+export { resolveStorefrontHref };
+
+//# sourceMappingURL=resolve-storefront-href.js.map

package/dist/sdk/navigation/resolve-storefront-href.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-storefront-href.js","names":[],"sources":["../../../src/sdk/navigation/resolve-storefront-href.ts"],"sourcesContent":["import type { StorefrontContext } from '@vtex/fs-core';\nimport { resolveSafeHref, type SafeHrefRejection } from '../../utils/safe-href.js';\nimport { normalizePath, withoutBasePath } from './path.js';\nimport type { PageRef, ResolveHrefReason, ResolveHrefResult, RouteMap, RouteMapEntry } from './types.js';\n\ntype BindingContext = Pick<StorefrontContext, 'bindingId' | 'basePath'>;\n\n/**\n * A param name is what Next and the compiler accept between brackets: word characters and hyphens.\n * Shared: `matchAll` iterates a clone, so the `g` flag's `lastIndex` never leaks between calls.\n */\nconst PARAM_TOKEN = /\\[\\[(?:\\.{3})([\\w-]+)\\]\\]|\\[\\.{3}([\\w-]+)\\]|\\[([\\w-]+)\\]/g;\n\n/**\n * The public href for one binding: a page reference looked up in the route map, or a logical path\n * prefixed with `basePath`. An anchor is returned as written. A rejected string and a page that\n * cannot be built return `href: null` and a reason. Never throws and never logs.\n */\nexport function resolveStorefrontHref(\n  context: Pick<StorefrontContext, 'bindingId' | 'basePath'>,\n  routeMap: RouteMap,\n  target: PageRef | string,\n): ResolveHrefResult {\n  // `PageRef` is an exclusive union, so which field is present is a runtime check.\n  const value: unknown = target;\n  if (typeof value === 'string') return resolveString(context, value);\n  if (!isRecord(value)) return { href: null, reason: 'invalid-ref' };\n\n  const page = value.page;\n  if (typeof page === 'string') {\n    const entry = ownPage(routeMap, page);\n    if (entry === undefined) return { href: null, reason: 'unknown-page' };\n    return resolveEntry(context, entry, value);\n  }\n\n  const standard = value.standard;\n  if (typeof standard !== 'string') return { href: null, reason: 'invalid-ref' };\n\n  const matches = standardIndex(routeMap).get(standard) ?? [];\n  const entry = matches[0];\n  if (entry === undefined) return { href: null, reason: 'unknown-standard' };\n  if (matches.length > 1) return { href: null, reason: 'ambiguous-standard' };\n  return resolveEntry(context, entry, value);\n}\n\nconst standardIndexes = new WeakMap<RouteMap, Map<string, RouteMapEntry[]>>();\n\n/** The entries that declare each standard, built once per route map: links resolve on every render. */\nfunction standardIndex(routeMap: RouteMap): Map<string, RouteMapEntry[]> {\n  const cached = standardIndexes.get(routeMap);\n  if (cached) return cached;\n  const index = new Map<string, RouteMapEntry[]>();\n  for (const entry of Object.values(routeMap)) {\n    if (!isRouteMapEntry(entry) || entry.standard === undefined) continue;\n    index.set(entry.standard, [...(index.get(entry.standard) ?? []), entry]);\n  }\n  standardIndexes.set(routeMap, index);\n  return index;\n}\n\nfunction resolveString(context: BindingContext, raw: string): ResolveHrefResult {\n  const trimmed = raw.trim();\n  if (trimmed.startsWith('#')) return { href: trimmed };\n\n  const checked = resolveSafeHref(raw);\n  if (!checked.safe) return { href: null, reason: safeHrefReason(checked.reason) };\n  if (checked.href.startsWith('/')) {\n    // A string that already carries this binding's base path is read as public: a CMS link is\n    // published after the build, so the gate's `base-path-in-link` never sees it.\n    return { href: prefixBasePath(withoutBasePath(checked.href, context.basePath), context.basePath) };\n  }\n  return { href: checked.href };\n}\n\nfunction resolveEntry(\n  context: BindingContext,\n  entry: RouteMapEntry,\n  target: Record<string, unknown>,\n): ResolveHrefResult {\n  if (entry.bindings !== undefined && !entry.bindings.includes(context.bindingId)) {\n    return { href: null, reason: 'outside-bindings' };\n  }\n\n  const filled = fillPattern(logicalPath(entry, context.bindingId), target.params);\n  if (filled === undefined) return { href: null, reason: 'missing-param' };\n\n  return { href: prefixBasePath(appendHash(appendQuery(filled, target.query), target.hash), context.basePath) };\n}\n\n/**\n * The map entry stored on `page` itself. Bracket access also sees `Object.prototype`\n * (`toString`, `constructor`, `hasOwnProperty`, `__proto__`), and those values are not pages.\n */\nfunction ownPage(routeMap: RouteMap, page: string): RouteMapEntry | undefined {\n  if (!Object.hasOwn(routeMap, page)) return undefined;\n  const entry: unknown = routeMap[page];\n  return isRouteMapEntry(entry) ? entry : undefined;\n}\n\nfunction isRouteMapEntry(value: unknown): value is RouteMapEntry {\n  return isRecord(value) && typeof value.pattern === 'string';\n}\n\nfunction logicalPath(entry: RouteMapEntry, bindingId: string): string {\n  const aliases = entry.aliases;\n  if (aliases === undefined || !Object.hasOwn(aliases, bindingId)) return entry.pattern;\n  return aliases[bindingId] ?? entry.pattern;\n}\n\nfunction fillPattern(pattern: string, params: unknown): string | undefined {\n  const table = isRecord(params) ? params : undefined;\n  let path = '';\n  let last = 0;\n\n  for (const match of pattern.matchAll(PARAM_TOKEN)) {\n    const index = match.index ?? 0;\n    path += pattern.slice(last, index);\n\n    const filled = fillToken(match, table);\n    if (filled === undefined) return undefined;\n    if (filled === null) {\n      if (path.endsWith('/')) path = path.slice(0, -1);\n    } else {\n      path += filled;\n    }\n\n    last = index + match[0].length;\n  }\n\n  return path + pattern.slice(last);\n}\n\n/**\n * The text one param token contributes: `null` for an omitted `[[...name]]`, which drops its\n * preceding slash, and `undefined` for a missing param.\n */\nfunction fillToken(match: RegExpMatchArray, table: Record<string, unknown> | undefined): string | null | undefined {\n  const [, optionalName, catchAllName, singleName] = match;\n  if (optionalName !== undefined) {\n    const filled = fillOptional(table?.[optionalName]);\n    if (filled === undefined) return undefined;\n    return filled.omit ? null : filled.text;\n  }\n  if (catchAllName !== undefined) return fillCatchAll(table?.[catchAllName]);\n  if (singleName !== undefined) return fillSingle(table?.[singleName]);\n  return '';\n}\n\n/** `[name]` takes one non-empty string. An array, `''`, or a missing key is a missing param. */\nfunction fillSingle(value: unknown): string | undefined {\n  if (typeof value !== 'string' || value.length === 0) return undefined;\n  return encodeURIComponent(value);\n}\n\n/**\n * `[...name]` takes one non-empty string (a single segment, slash included) or a non-empty list of\n * non-empty segments. Each segment is encoded on its own.\n */\nfunction fillCatchAll(value: unknown): string | undefined {\n  if (typeof value === 'string') {\n    if (value.length === 0) return undefined;\n    return encodeURIComponent(value);\n  }\n  if (!Array.isArray(value) || value.length === 0) return undefined;\n\n  const segments: string[] = [];\n  for (const segment of value) {\n    if (typeof segment !== 'string' || segment.length === 0) return undefined;\n    segments.push(encodeURIComponent(segment));\n  }\n  return segments.join('/');\n}\n\n/** `[[...name]]` omits the segment when the value is missing, `''`, or `[]`. */\nfunction fillOptional(value: unknown): { omit: true } | { omit: false; text: string } | undefined {\n  if (value === undefined || value === '' || (Array.isArray(value) && value.length === 0)) return { omit: true };\n  const text = fillCatchAll(value);\n  if (text === undefined) return undefined;\n  return { omit: false, text };\n}\n\nfunction appendQuery(path: string, query: unknown): string {\n  if (!isRecord(query)) return path;\n\n  const search = new URLSearchParams();\n  for (const [key, value] of Object.entries(query)) {\n    const values: unknown[] = Array.isArray(value) ? value : [value];\n    for (const item of values) {\n      if (typeof item === 'string') search.append(key, item);\n    }\n  }\n  const text = search.toString();\n  return text.length === 0 ? path : `${path}?${text}`;\n}\n\nfunction appendHash(path: string, hash: unknown): string {\n  if (typeof hash !== 'string' || hash.length === 0 || hash === '#') return path;\n  const fragment = hash.startsWith('#') ? hash : `#${hash}`;\n  return `${path}${fragment}`;\n}\n\n/**\n * The `buildUrl` join, without an origin. `'/'` contributes no prefix, so a root path stays `'/'`\n * and a root plus a query or hash stays `'/?…'` or `'/#…'`. Any other base path joins in front, and\n * a root suffix is the bare base path (`/pt-BR`): Next.js 308-redirects `/pt-BR/` to it.\n */\nfunction prefixBasePath(href: string, basePath: string): string {\n  const cut = splitPath(href);\n  const pathPart = cut === -1 ? href : href.slice(0, cut);\n  const tail = cut === -1 ? '' : href.slice(cut);\n  const suffix = normalizePath(pathPart);\n  const prefix = basePath === '/' ? '' : basePath;\n  const path = suffix === '/' ? prefix || '/' : `${prefix}${suffix}`;\n  return `${path}${tail}`;\n}\n\n/** The first `?` or `#`, or `-1` when the href is only a path. */\nfunction splitPath(href: string): number {\n  const query = href.indexOf('?');\n  const hash = href.indexOf('#');\n  if (query === -1) return hash;\n  if (hash === -1) return query;\n  return Math.min(query, hash);\n}\n\nfunction safeHrefReason(reason: SafeHrefRejection): ResolveHrefReason {\n  switch (reason) {\n    case 'blank':\n    case 'malformed':\n    case 'protocol-relative':\n    case 'forbidden-scheme':\n      return reason;\n    // `resolveSafeHref` never returns these. They belong to the narrower helpers that share its type.\n    case 'absolute':\n    case 'sign-in-route':\n      return 'malformed';\n  }\n}\n\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return typeof value === 'object' && value !== null && !Array.isArray(value);\n}\n"],"mappings":";;;;;;;AAWA,MAAM,cAAc;;;;;;AAOpB,SAAgB,sBACd,SACA,UACA,QACmB;CAEnB,MAAM,QAAiB;CACvB,IAAI,OAAO,UAAU,UAAU,OAAO,cAAc,SAAS,KAAK;CAClE,IAAI,CAAC,SAAS,KAAK,GAAG,OAAO;EAAE,MAAM;EAAM,QAAQ;CAAc;CAEjE,MAAM,OAAO,MAAM;CACnB,IAAI,OAAO,SAAS,UAAU;EAC5B,MAAM,QAAQ,QAAQ,UAAU,IAAI;EACpC,IAAI,UAAU,KAAA,GAAW,OAAO;GAAE,MAAM;GAAM,QAAQ;EAAe;EACrE,OAAO,aAAa,SAAS,OAAO,KAAK;CAC3C;CAEA,MAAM,WAAW,MAAM;CACvB,IAAI,OAAO,aAAa,UAAU,OAAO;EAAE,MAAM;EAAM,QAAQ;CAAc;CAE7E,MAAM,UAAU,cAAc,QAAQ,CAAC,CAAC,IAAI,QAAQ,KAAK,CAAC;CAC1D,MAAM,QAAQ,QAAQ;CACtB,IAAI,UAAU,KAAA,GAAW,OAAO;EAAE,MAAM;EAAM,QAAQ;CAAmB;CACzE,IAAI,QAAQ,SAAS,GAAG,OAAO;EAAE,MAAM;EAAM,QAAQ;CAAqB;CAC1E,OAAO,aAAa,SAAS,OAAO,KAAK;AAC3C;AAEA,MAAM,kCAAkB,IAAI,QAAgD;;AAG5E,SAAS,cAAc,UAAkD;CACvE,MAAM,SAAS,gBAAgB,IAAI,QAAQ;CAC3C,IAAI,QAAQ,OAAO;CACnB,MAAM,wBAAQ,IAAI,IAA6B;CAC/C,KAAK,MAAM,SAAS,OAAO,OAAO,QAAQ,GAAG;EAC3C,IAAI,CAAC,gBAAgB,KAAK,KAAK,MAAM,aAAa,KAAA,GAAW;EAC7D,MAAM,IAAI,MAAM,UAAU,CAAC,GAAI,MAAM,IAAI,MAAM,QAAQ,KAAK,CAAC,GAAI,KAAK,CAAC;CACzE;CACA,gBAAgB,IAAI,UAAU,KAAK;CACnC,OAAO;AACT;AAEA,SAAS,cAAc,SAAyB,KAAgC;CAC9E,MAAM,UAAU,IAAI,KAAK;CACzB,IAAI,QAAQ,WAAW,GAAG,GAAG,OAAO,EAAE,MAAM,QAAQ;CAEpD,MAAM,UAAU,gBAAgB,GAAG;CACnC,IAAI,CAAC,QAAQ,MAAM,OAAO;EAAE,MAAM;EAAM,QAAQ,eAAe,QAAQ,MAAM;CAAE;CAC/E,IAAI,QAAQ,KAAK,WAAW,GAAG,GAG7B,OAAO,EAAE,MAAM,eAAe,gBAAgB,QAAQ,MAAM,QAAQ,QAAQ,GAAG,QAAQ,QAAQ,EAAE;CAEnG,OAAO,EAAE,MAAM,QAAQ,KAAK;AAC9B;AAEA,SAAS,aACP,SACA,OACA,QACmB;CACnB,IAAI,MAAM,aAAa,KAAA,KAAa,CAAC,MAAM,SAAS,SAAS,QAAQ,SAAS,GAC5E,OAAO;EAAE,MAAM;EAAM,QAAQ;CAAmB;CAGlD,MAAM,SAAS,YAAY,YAAY,OAAO,QAAQ,SAAS,GAAG,OAAO,MAAM;CAC/E,IAAI,WAAW,KAAA,GAAW,OAAO;EAAE,MAAM;EAAM,QAAQ;CAAgB;CAEvE,OAAO,EAAE,MAAM,eAAe,WAAW,YAAY,QAAQ,OAAO,KAAK,GAAG,OAAO,IAAI,GAAG,QAAQ,QAAQ,EAAE;AAC9G;;;;;AAMA,SAAS,QAAQ,UAAoB,MAAyC;CAC5E,IAAI,CAAC,OAAO,OAAO,UAAU,IAAI,GAAG,OAAO,KAAA;CAC3C,MAAM,QAAiB,SAAS;CAChC,OAAO,gBAAgB,KAAK,IAAI,QAAQ,KAAA;AAC1C;AAEA,SAAS,gBAAgB,OAAwC;CAC/D,OAAO,SAAS,KAAK,KAAK,OAAO,MAAM,YAAY;AACrD;AAEA,SAAS,YAAY,OAAsB,WAA2B;CACpE,MAAM,UAAU,MAAM;CACtB,IAAI,YAAY,KAAA,KAAa,CAAC,OAAO,OAAO,SAAS,SAAS,GAAG,OAAO,MAAM;CAC9E,OAAO,QAAQ,cAAc,MAAM;AACrC;AAEA,SAAS,YAAY,SAAiB,QAAqC;CACzE,MAAM,QAAQ,SAAS,MAAM,IAAI,SAAS,KAAA;CAC1C,IAAI,OAAO;CACX,IAAI,OAAO;CAEX,KAAK,MAAM,SAAS,QAAQ,SAAS,WAAW,GAAG;EACjD,MAAM,QAAQ,MAAM,SAAS;EAC7B,QAAQ,QAAQ,MAAM,MAAM,KAAK;EAEjC,MAAM,SAAS,UAAU,OAAO,KAAK;EACrC,IAAI,WAAW,KAAA,GAAW,OAAO,KAAA;EACjC,IAAI,WAAW,MACT;OAAA,KAAK,SAAS,GAAG,GAAG,OAAO,KAAK,MAAM,GAAG,EAAE;EAAA,OAE/C,QAAQ;EAGV,OAAO,QAAQ,MAAM,EAAE,CAAC;CAC1B;CAEA,OAAO,OAAO,QAAQ,MAAM,IAAI;AAClC;;;;;AAMA,SAAS,UAAU,OAAyB,OAAuE;CACjH,MAAM,GAAG,cAAc,cAAc,cAAc;CACnD,IAAI,iBAAiB,KAAA,GAAW;EAC9B,MAAM,SAAS,aAAa,QAAQ,aAAa;EACjD,IAAI,WAAW,KAAA,GAAW,OAAO,KAAA;EACjC,OAAO,OAAO,OAAO,OAAO,OAAO;CACrC;CACA,IAAI,iBAAiB,KAAA,GAAW,OAAO,aAAa,QAAQ,aAAa;CACzE,IAAI,eAAe,KAAA,GAAW,OAAO,WAAW,QAAQ,WAAW;CACnE,OAAO;AACT;;AAGA,SAAS,WAAW,OAAoC;CACtD,IAAI,OAAO,UAAU,YAAY,MAAM,WAAW,GAAG,OAAO,KAAA;CAC5D,OAAO,mBAAmB,KAAK;AACjC;;;;;AAMA,SAAS,aAAa,OAAoC;CACxD,IAAI,OAAO,UAAU,UAAU;EAC7B,IAAI,MAAM,WAAW,GAAG,OAAO,KAAA;EAC/B,OAAO,mBAAmB,KAAK;CACjC;CACA,IAAI,CAAC,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,GAAG,OAAO,KAAA;CAExD,MAAM,WAAqB,CAAC;CAC5B,KAAK,MAAM,WAAW,OAAO;EAC3B,IAAI,OAAO,YAAY,YAAY,QAAQ,WAAW,GAAG,OAAO,KAAA;EAChE,SAAS,KAAK,mBAAmB,OAAO,CAAC;CAC3C;CACA,OAAO,SAAS,KAAK,GAAG;AAC1B;;AAGA,SAAS,aAAa,OAA4E;CAChG,IAAI,UAAU,KAAA,KAAa,UAAU,MAAO,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,GAAI,OAAO,EAAE,MAAM,KAAK;CAC7G,MAAM,OAAO,aAAa,KAAK;CAC/B,IAAI,SAAS,KAAA,GAAW,OAAO,KAAA;CAC/B,OAAO;EAAE,MAAM;EAAO;CAAK;AAC7B;AAEA,SAAS,YAAY,MAAc,OAAwB;CACzD,IAAI,CAAC,SAAS,KAAK,GAAG,OAAO;CAE7B,MAAM,SAAS,IAAI,gBAAgB;CACnC,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,GAAG;EAChD,MAAM,SAAoB,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK;EAC/D,KAAK,MAAM,QAAQ,QACjB,IAAI,OAAO,SAAS,UAAU,OAAO,OAAO,KAAK,IAAI;CAEzD;CACA,MAAM,OAAO,OAAO,SAAS;CAC7B,OAAO,KAAK,WAAW,IAAI,OAAO,GAAG,KAAK,GAAG;AAC/C;AAEA,SAAS,WAAW,MAAc,MAAuB;CACvD,IAAI,OAAO,SAAS,YAAY,KAAK,WAAW,KAAK,SAAS,KAAK,OAAO;CAE1E,OAAO,GAAG,OADO,KAAK,WAAW,GAAG,IAAI,OAAO,IAAI;AAErD;;;;;;AAOA,SAAS,eAAe,MAAc,UAA0B;CAC9D,MAAM,MAAM,UAAU,IAAI;CAC1B,MAAM,WAAW,QAAQ,KAAK,OAAO,KAAK,MAAM,GAAG,GAAG;CACtD,MAAM,OAAO,QAAQ,KAAK,KAAK,KAAK,MAAM,GAAG;CAC7C,MAAM,SAAS,cAAc,QAAQ;CACrC,MAAM,SAAS,aAAa,MAAM,KAAK;CAEvC,OAAO,GADM,WAAW,MAAM,UAAU,MAAM,GAAG,SAAS,WACzC;AACnB;;AAGA,SAAS,UAAU,MAAsB;CACvC,MAAM,QAAQ,KAAK,QAAQ,GAAG;CAC9B,MAAM,OAAO,KAAK,QAAQ,GAAG;CAC7B,IAAI,UAAU,IAAI,OAAO;CACzB,IAAI,SAAS,IAAI,OAAO;CACxB,OAAO,KAAK,IAAI,OAAO,IAAI;AAC7B;AAEA,SAAS,eAAe,QAA8C;CACpE,QAAQ,QAAR;EACE,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,oBACH,OAAO;EAET,KAAK;EACL,KAAK,iBACH,OAAO;CACX;AACF;AAEA,SAAS,SAAS,OAAkD;CAClE,OAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E"}

package/dist/sdk/navigation/route-identity-provider.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from "react";
+//#region src/sdk/navigation/route-identity-provider.d.ts
+export type RouteIdentityProviderProps = Readonly<{
+  /** The page name: the key of the route map. */
+  name: string;
+  children: ReactNode;
+}>;
+/** The route marker the generator wraps around each page's JSX. */
+export declare function RouteIdentityProvider({ name, children }: RouteIdentityProviderProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//# sourceMappingURL=route-identity-provider.d.ts.map

package/dist/sdk/navigation/route-identity-provider.js

@@ -0,0 +1,20 @@
+"use client";
+import { createContext, useContext } from "react";
+import { jsx } from "react/jsx-runtime";
+//#region src/sdk/navigation/route-identity-provider.tsx
+const Context = createContext(null);
+/** The route marker the generator wraps around each page's JSX. */
+function RouteIdentityProvider({ name, children }) {
+	return /* @__PURE__ */ jsx(Context.Provider, {
+		value: name,
+		children
+	});
+}
+/** The nearest marker's page name, or `null` outside one (a layout, for example). */
+function useRouteIdentityName() {
+	return useContext(Context);
+}
+//#endregion
+export { RouteIdentityProvider, useRouteIdentityName };
+
+//# sourceMappingURL=route-identity-provider.js.map

package/dist/sdk/navigation/route-identity-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-identity-provider.js","names":[],"sources":["../../../src/sdk/navigation/route-identity-provider.tsx"],"sourcesContent":["'use client';\n\nimport { createContext, type ReactNode, useContext } from 'react';\n\nexport type RouteIdentityProviderProps = Readonly<{\n  /** The page name: the key of the route map. */\n  name: string;\n  children: ReactNode;\n}>;\n\nconst Context = createContext<string | null>(null);\n\n/** The route marker the generator wraps around each page's JSX. */\nexport function RouteIdentityProvider({ name, children }: RouteIdentityProviderProps) {\n  return <Context.Provider value={name}>{children}</Context.Provider>;\n}\n\n/** The nearest marker's page name, or `null` outside one (a layout, for example). */\nexport function useRouteIdentityName(): string | null {\n  return useContext(Context);\n}\n"],"mappings":";;;;AAUA,MAAM,UAAU,cAA6B,IAAI;;AAGjD,SAAgB,sBAAsB,EAAE,MAAM,YAAwC;CACpF,OAAO,oBAAC,QAAQ,UAAT;EAAkB,OAAO;EAAO;CAA2B,CAAA;AACpE;;AAGA,SAAgB,uBAAsC;CACpD,OAAO,WAAW,OAAO;AAC3B"}

package/dist/sdk/navigation/route-map-provider.d.ts

@@ -0,0 +1,19 @@
+import { RouteMap } from "./types.js";
+import { ReactNode } from "react";
+//#region src/sdk/navigation/route-map-provider.d.ts
+/** The generated resolver's `toLogicalPath`: the path under a binding's base path. */
+export type ToLogicalPath = (entry: {
+  basePath: string;
+}, pathname: string) => string;
+export type RouteMapProviderProps = Readonly<{
+  routeMap: RouteMap;
+  toLogicalPath: ToLogicalPath;
+  children: ReactNode;
+}>;
+/**
+ * Publishes the generated route map and `toLogicalPath` to the Client tree. `toLogicalPath` is a prop
+ * because the SDK cannot import the generated resolver and must not reimplement the prefix rule.
+ */
+export declare function RouteMapProvider({ routeMap, toLogicalPath, children }: RouteMapProviderProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//# sourceMappingURL=route-map-provider.d.ts.map