@abinnovision/payloadcms-wayfinder 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 abi group GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,132 @@
+# @abinnovision/payloadcms-wayfinder
+
+![An editor-authored map of path patterns turns collections into URLs and URLs back into documents](https://raw.githubusercontent.com/abinnovision/payloadcms-commons/main/packages/wayfinder/assets/header.png)
+
+Editor-authored URL routing for [Payload CMS](https://payloadcms.com/).
+
+Wayfinder owns one thing: the map from collections to the URL patterns their documents are served
+at. That map is authored in the CMS, so adding a page type is an editorial act rather than a code
+change. Everything else in the package falls out of it. `buildHref` turns a document into an href,
+`buildPath` builds a path from parameter values alone for sitemaps and feeds,
+`resolvePathToDocument` turns a request path back into a document for a catch-all route, and
+`resolveLink` plus `linkField` give editors a link that follows its target when that collection's
+pattern changes. [`docs/concepts.md`](./docs/concepts.md) describes the model;
+[`docs/limitations.md`](./docs/limitations.md) states what is out of scope and why.
+
+## Install
+
+```sh
+yarn add @abinnovision/payloadcms-wayfinder
+```
+
+Only `payload` is required. Every other peer is optional and pulled in solely by the surface that
+uses it, so a project that only needs the URL layer installs nothing else:
+
+| Peer                                 | Range              | Needed for                |
+| ------------------------------------ | ------------------ | ------------------------- |
+| `payload`                            | `>=3.88.0 <4`      | everything (required)     |
+| `@payloadcms/richtext-lexical`       | `>=3.88.0 <4`      | `./lexical` and `./admin` |
+| `react`, `lexical`, `@lexical/react` | `^19`, `>=0.35 <1` | `./admin`                 |
+| `@payloadcms/ui`                     | `>=3.88.0 <4`      | `./admin`                 |
+| `@abinnovision/payloadcms-montage`   | `>=1.0.0-beta.1`   | `./montage`               |
+
+## Setup
+
+Register the plugin in `payload.config.ts`. It adds the mapping global and the package's admin
+translations:
+
+```ts
+// payload.config.ts
+import { wayfinderPlugin } from "@abinnovision/payloadcms-wayfinder/config";
+import { buildConfig } from "payload";
+
+export default buildConfig({
+  // ...
+  plugins: [wayfinderPlugin({ linkableCollections: ["pages", "articles"] })],
+});
+```
+
+Then open the global in the admin panel and author one row per collection. A row is a collection
+slug and a path pattern:
+
+```
+pages      /*path
+articles   /journal/:slug
+sections   /:slug
+```
+
+The last parameter of a pattern identifies the document; earlier parameters narrow the lookup. A
+pattern is validated on save against the collection's own fields, so a parameter that names
+nothing queryable is rejected before it can produce a URL that resolves to nothing.
+
+Read the mapping and hand it to a catch-all route:
+
+```tsx
+// app/[[...path]]/page.tsx
+import { resolvePathToDocument } from "@abinnovision/payloadcms-wayfinder";
+import { loadMappings } from "@abinnovision/payloadcms-wayfinder/config";
+import { notFound } from "next/navigation";
+import { getPayload } from "payload";
+
+import config from "@payload-config";
+
+const Page = async ({ params }: { params: Promise<{ path?: string[] }> }) => {
+  const payload = await getPayload({ config });
+  const mappings = await loadMappings({ payload });
+  const { path } = await params;
+
+  const resolved = await resolvePathToDocument({
+    payload,
+    mappings,
+    path: `/${(path ?? []).join("/")}`,
+    locale: "en",
+  });
+
+  if (!resolved) {
+    notFound();
+  }
+
+  return <Document collection={resolved.collection} data={resolved.document} />;
+};
+
+export default Page;
+```
+
+[`docs/integration.md`](./docs/integration.md) covers the rest: caching the mapping, the
+`defaultPopulate` prerequisite for linkable collections, and sitemap and feed usage.
+
+## Entrypoints
+
+```
+"."         buildHref, buildPath, resolvePathToDocument, resolveLink, defineMappings, defineLinks, types
+"./config"  wayfinderPlugin, createMappingGlobal, loadMappings, linkField
+"./lexical" wayfinderLinkFeature, linkLabelFeature, resolveLinkNode
+"./admin"   LinkLabelFeatureClient, mounted by linkLabelFeature through the import map
+"./montage" initWayfinder, getMappings, wayfinderExtension
+```
+
+`.` is the runtime half. It takes mappings as plain data and never reads the CMS, so it runs in a
+route handler, a sitemap, a script or a test alike. `./config` is loaded by the CLI, by migrations
+and by `payload generate:types`, so it must stay React-free. `./lexical`, `./admin` and
+`./montage` each pull in an optional peer and are separate for that reason.
+[`docs/layers.md`](./docs/layers.md) explains the split.
+
+## Documentation
+
+- [`docs/concepts.md`](./docs/concepts.md): the mapping global, patterns, specificity and the
+  wildcard contract.
+- [`docs/layers.md`](./docs/layers.md): the three layers, the optional surfaces, and what each one
+  works without.
+- [`docs/integration.md`](./docs/integration.md): plugin setup, caching, catch-all routes,
+  sitemaps and `defaultPopulate`.
+- [`docs/linking.md`](./docs/linking.md): `linkField`, `defineLinks`, `resolveLink` and the Lexical
+  feature.
+- [`docs/code-defined-mappings.md`](./docs/code-defined-mappings.md): `defineMappings`, with no CMS
+  global at all.
+- [`docs/recipes.md`](./docs/recipes.md): link components, locale and preview prefixing, admin
+  preview URLs, and request-scoped mappings.
+- [`docs/limitations.md`](./docs/limitations.md): what wayfinder does not do, and why.
+
+## License
+
+Apache-2.0

package/dist/admin/LinkLabelFeature.client.d.mts

@@ -0,0 +1,5 @@
+//#region src/admin/LinkLabelFeature.client.d.ts
+/** Client feature registering {@link LinkLabelPlugin} on the editor. */
+declare const LinkLabelFeatureClient: import("@payloadcms/richtext-lexical").FeatureProviderProviderClient<undefined, undefined>;
+//#endregion
+export { LinkLabelFeatureClient };

package/dist/admin/LinkLabelFeature.client.mjs

@@ -0,0 +1,35 @@
+"use client";
+import { deriveLinkLabel } from "../pattern/derive-link-label.mjs";
+import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext";
+import { TOGGLE_LINK_COMMAND, createClientFeature } from "@payloadcms/richtext-lexical/client";
+import { COMMAND_PRIORITY_HIGH } from "lexical";
+import { useEffect } from "react";
+//#region src/admin/LinkLabelFeature.client.tsx
+/**
+* Gives a link a top-level `label` derived from its destination whenever it is
+* created or edited.
+*
+* `TOGGLE_LINK_COMMAND` is dispatched both when a link is created from the
+* toolbar and on every drawer submit, so intercepting it at high priority and
+* enriching the payload leaves Payload's own lower-priority handler to create
+* the node with the label already on it.
+*
+* Doing this on the create/edit path rather than as an always-on node
+* transform means documents are never mutated merely by being opened.
+*/ const LinkLabelPlugin = () => {
+	const [editor] = useLexicalComposerContext();
+	useEffect(() => editor.registerCommand(TOGGLE_LINK_COMMAND, (payload) => {
+		if (payload?.fields && "link" in payload.fields) {
+			const label = deriveLinkLabel(payload.fields["link"]);
+			if (label) payload.fields["label"] = label;
+		}
+		return false;
+	}, COMMAND_PRIORITY_HIGH), [editor]);
+	return null;
+};
+/** Client feature registering {@link LinkLabelPlugin} on the editor. */ const LinkLabelFeatureClient = createClientFeature(() => ({ plugins: [{
+	Component: LinkLabelPlugin,
+	position: "normal"
+}] }));
+//#endregion
+export { LinkLabelFeatureClient };

package/dist/admin/index.d.mts

@@ -0,0 +1,2 @@
+import { LinkLabelFeatureClient } from "./LinkLabelFeature.client.mjs";
+export { LinkLabelFeatureClient };

package/dist/admin/index.mjs

@@ -0,0 +1,3 @@
+"use client";
+import { LinkLabelFeatureClient } from "./LinkLabelFeature.client.mjs";
+export { LinkLabelFeatureClient };

package/dist/config/collection-string-field.d.mts

@@ -0,0 +1,20 @@
+import { Field, TextField } from "payload";
+//#region src/config/collection-string-field.d.ts
+interface CreateCollectionStringFieldArgs {
+  name: string;
+  required?: boolean;
+  label?: TextField["label"];
+  admin?: TextField["admin"];
+}
+/**
+ * A text field holding a collection slug, validated against the collections
+ * actually registered on this Payload instance.
+ *
+ * A select would need its options frozen at config-build time, which would
+ * make the field go stale whenever a collection is added.
+ *
+ * @param args Field name and presentation overrides.
+ */
+declare const createCollectionStringField: (args: CreateCollectionStringFieldArgs) => Field;
+//#endregion
+export { CreateCollectionStringFieldArgs, createCollectionStringField };

package/dist/config/collection-string-field.mjs

@@ -0,0 +1,33 @@
+import { translate } from "./translations.mjs";
+import { text } from "payload/shared";
+//#region src/config/collection-string-field.ts
+/**
+* A text field holding a collection slug, validated against the collections
+* actually registered on this Payload instance.
+*
+* A select would need its options frozen at config-build time, which would
+* make the field go stale whenever a collection is added.
+*
+* @param args Field name and presentation overrides.
+*/ const createCollectionStringField = (args) => {
+	return {
+		name: args.name,
+		type: "text",
+		required: args.required ?? false,
+		...args.label !== void 0 ? { label: args.label } : {},
+		...args.admin !== void 0 ? { admin: args.admin } : {},
+		validate: (value, opts) => {
+			const base = text(value, opts);
+			if (base !== true) return base;
+			if (value === void 0 || value === null || value === "") return true;
+			const known = Object.keys(opts.req.payload.collections);
+			if (!known.includes(value)) return translate(opts.req.t, "unknownCollection", {
+				value,
+				known: known.join(", ")
+			});
+			return true;
+		}
+	};
+};
+//#endregion
+export { createCollectionStringField };

package/dist/config/has-duplicates.d.mts

@@ -0,0 +1,15 @@
+//#region src/config/has-duplicates.d.ts
+/**
+ * Whether a list of authored keys names the same thing twice.
+ *
+ * An array field's `validate` receives whatever the admin form holds, so the
+ * undefined entries are kept rather than filtered: two rows with no key yet
+ * are still two rows claiming the same empty name, and an editor should hear
+ * that at the point they save rather than at the point the second one
+ * silently wins.
+ *
+ * @param keys The authored keys, in row order.
+ */
+declare const hasDuplicates: (keys: (string | undefined)[]) => boolean;
+//#endregion
+export { hasDuplicates };

package/dist/config/has-duplicates.mjs

@@ -0,0 +1,14 @@
+//#region src/config/has-duplicates.ts
+/**
+* Whether a list of authored keys names the same thing twice.
+*
+* An array field's `validate` receives whatever the admin form holds, so the
+* undefined entries are kept rather than filtered: two rows with no key yet
+* are still two rows claiming the same empty name, and an editor should hear
+* that at the point they save rather than at the point the second one
+* silently wins.
+*
+* @param keys The authored keys, in row order.
+*/ const hasDuplicates = (keys) => new Set(keys).size !== keys.length;
+//#endregion
+export { hasDuplicates };

package/dist/config/index.d.mts

@@ -0,0 +1,8 @@
+import { CreateCollectionStringFieldArgs, createCollectionStringField } from "./collection-string-field.mjs";
+import { hasDuplicates } from "./has-duplicates.mjs";
+import { LinkFieldArgs, LinkFieldLabels, linkField } from "./link-field.mjs";
+import { LoadMappingsArgs, MappingCache, loadMappings } from "./load-mappings.mjs";
+import { CreateMappingGlobalArgs, DEFAULT_MAPPING_GLOBAL_SLUG, createMappingGlobal } from "./mapping-global.mjs";
+import { WayfinderPluginArgs, wayfinderPlugin } from "./plugin.mjs";
+import { wayfinderTranslations } from "./translations.mjs";
+export { type CreateCollectionStringFieldArgs, type CreateMappingGlobalArgs, DEFAULT_MAPPING_GLOBAL_SLUG, type LinkFieldArgs, type LinkFieldLabels, type LoadMappingsArgs, type MappingCache, type WayfinderPluginArgs, createCollectionStringField, createMappingGlobal, hasDuplicates, linkField, loadMappings, wayfinderPlugin, wayfinderTranslations };

package/dist/config/index.mjs

@@ -0,0 +1,8 @@
+import { wayfinderTranslations } from "./translations.mjs";
+import { createCollectionStringField } from "./collection-string-field.mjs";
+import { hasDuplicates } from "./has-duplicates.mjs";
+import { linkField } from "./link-field.mjs";
+import { DEFAULT_MAPPING_GLOBAL_SLUG, createMappingGlobal } from "./mapping-global.mjs";
+import { loadMappings } from "./load-mappings.mjs";
+import { wayfinderPlugin } from "./plugin.mjs";
+export { DEFAULT_MAPPING_GLOBAL_SLUG, createCollectionStringField, createMappingGlobal, hasDuplicates, linkField, loadMappings, wayfinderPlugin, wayfinderTranslations };

package/dist/config/link-field.d.mts

@@ -0,0 +1,35 @@
+import { LabelLike } from "../pattern/types.mjs";
+import { LinkDeclaration, LinkVariantSource } from "../pattern/define-links.mjs";
+import { Field } from "payload";
+//#region src/config/link-field.d.ts
+/** Admin labels for the built-in link types. */
+interface LinkFieldLabels {
+  label?: LabelLike;
+  none?: LabelLike;
+  reference?: LabelLike;
+  custom?: LabelLike;
+  samePage?: LabelLike;
+  newTab?: LabelLike;
+  referenceField?: LabelLike;
+  urlField?: LabelLike;
+  samePageField?: LabelLike;
+}
+interface LinkFieldArgs<TDeclaration extends LinkDeclaration = LinkDeclaration> extends LinkVariantSource<TDeclaration> {
+  /**
+   * Every collection that has a URL. A target missing here cannot be linked
+   * to from the admin panel even if its mapping exists.
+   */
+  relationTo: string[];
+  required?: boolean;
+  withLabel?: boolean;
+  localizedLabel?: boolean;
+  labels?: LinkFieldLabels;
+  /**
+   * Generated-type name. Unset by default: a package cannot claim a global
+   * type name, and two calls with different targets would collide on it.
+   */
+  interfaceName?: string;
+}
+declare const linkField: <TDeclaration extends LinkDeclaration = LinkDeclaration>(args: LinkFieldArgs<TDeclaration>) => Field;
+//#endregion
+export { LinkFieldArgs, LinkFieldLabels, linkField };