@zedtech/zedkit-payload-seo 0.0.0 → 0.1.1

package/README.md

@@ -1,12 +1,20 @@
 # @zedtech/zedkit-payload-seo
 
-Localized Payload SEO group field with length validation.
-Original work by the same author.
+[![npm version](https://img.shields.io/npm/v/@zedtech/zedkit-payload-seo.svg)](https://www.npmjs.com/package/@zedtech/zedkit-payload-seo)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zedtech-fr/zedkit/blob/main/LICENSE)
+
+Drop-in localized SEO group field for Payload CMS: meta tags, JSON-LD
+and length validation, ready for i18n sites. Original work by the same
+author.
+
+## Install
 
 ```sh
 pnpm add @zedtech/zedkit-payload-seo
 ```
 
+## Usage
+
 ```ts
 import { seoGroupField } from "@zedtech/zedkit-payload-seo";
 
@@ -16,6 +24,12 @@ export const Page = {
 };
 ```
 
+## When to use
+
+Reach for this package when your Payload collections need per-locale
+SEO fields. To render the stored values (metadata, sitemaps, JSON-LD),
+pair it with `@zedtech/zedkit-seo`.
+
 `seoFields()` returns the nine leaf fields (meta title/description,
 keywords, canonical URL, OG title/description/image, robots
 noindex/nofollow); `seoGroupField()` wraps them in a group (default

package/dist/fields.d.ts

@@ -0,0 +1,23 @@
+import type { Field } from "payload";
+export declare const SEO_TITLE_MAX = 70;
+export declare const SEO_DESCRIPTION_MAX = 160;
+/** Length validator with a friendly message (empty and non-strings pass). */
+export declare function maxLengthValidator(max: number): (value: unknown) => string | true;
+export interface SeoFieldsOptions {
+    /** Upload collection for the OG image. Defaults to `"media"`. */
+    mediaSlug?: string;
+    /** Meta/OG title cap. Defaults to 70. */
+    titleMaxLength?: number;
+    /** Meta/OG description cap. Defaults to 160. */
+    descriptionMaxLength?: number;
+    /** Group field name. Defaults to `"seo"`. */
+    groupName?: string;
+}
+/**
+ * Localized SEO leaf fields: meta title/description, keywords,
+ * canonical URL, OG title/description/image, robots flags.
+ */
+export declare function seoFields(options?: SeoFieldsOptions): Field[];
+/** The leaf fields wrapped in a group (default name `"seo"`). */
+export declare function seoGroupField(options?: SeoFieldsOptions): Field;
+//# sourceMappingURL=fields.d.ts.map

package/dist/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,eAAO,MAAM,mBAAmB,MAAM,CAAC;AAEvC,6EAA6E;AAC7E,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,GAAG,IAAI,CAKjF;AAED,MAAM,WAAW,gBAAgB;IAC/B,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yCAAyC;IACzC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gDAAgD;IAChD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,KAAK,EAAE,CAkEjE;AAED,iEAAiE;AACjE,wBAAgB,aAAa,CAAC,OAAO,GAAE,gBAAqB,GAAG,KAAK,CAMnE"}

package/dist/fields.js

@@ -0,0 +1,90 @@
+export const SEO_TITLE_MAX = 70;
+export const SEO_DESCRIPTION_MAX = 160;
+/** Length validator with a friendly message (empty and non-strings pass). */
+export function maxLengthValidator(max) {
+    return (value) => {
+        if (typeof value !== "string" || value.length === 0)
+            return true;
+        return value.length <= max ? true : `Must be ${max} characters or fewer (now ${value.length}).`;
+    };
+}
+/**
+ * Localized SEO leaf fields: meta title/description, keywords,
+ * canonical URL, OG title/description/image, robots flags.
+ */
+export function seoFields(options = {}) {
+    const mediaSlug = options.mediaSlug ?? "media";
+    const titleMax = options.titleMaxLength ?? SEO_TITLE_MAX;
+    const descriptionMax = options.descriptionMaxLength ?? SEO_DESCRIPTION_MAX;
+    return [
+        {
+            name: "metaTitle",
+            type: "text",
+            localized: true,
+            maxLength: titleMax,
+            validate: maxLengthValidator(titleMax),
+            admin: { description: `Search result title (${titleMax} chars max).` },
+        },
+        {
+            name: "metaDescription",
+            type: "textarea",
+            localized: true,
+            maxLength: descriptionMax,
+            validate: maxLengthValidator(descriptionMax),
+            admin: { description: `Search result snippet (${descriptionMax} chars max).` },
+        },
+        {
+            name: "keywords",
+            type: "array",
+            localized: true,
+            fields: [{ name: "value", type: "text" }],
+        },
+        {
+            name: "canonicalUrl",
+            type: "text",
+            admin: { description: "Absolute URL; leave empty to use the page URL." },
+        },
+        {
+            name: "ogTitle",
+            type: "text",
+            localized: true,
+            maxLength: titleMax,
+            validate: maxLengthValidator(titleMax),
+            admin: { description: "Social share title; falls back to the meta title." },
+        },
+        {
+            name: "ogDescription",
+            type: "textarea",
+            localized: true,
+            maxLength: descriptionMax,
+            validate: maxLengthValidator(descriptionMax),
+            admin: { description: "Social share text; falls back to the meta description." },
+        },
+        {
+            name: "ogImage",
+            type: "upload",
+            relationTo: mediaSlug,
+        },
+        {
+            name: "robotsNoIndex",
+            type: "checkbox",
+            defaultValue: false,
+            admin: { description: "Hide this page from search results (drafts)." },
+        },
+        {
+            name: "robotsNoFollow",
+            type: "checkbox",
+            defaultValue: false,
+            admin: { description: "Tell crawlers not to follow this page's links." },
+        },
+    ];
+}
+/** The leaf fields wrapped in a group (default name `"seo"`). */
+export function seoGroupField(options = {}) {
+    return {
+        name: options.groupName ?? "seo",
+        type: "group",
+        fields: seoFields(options),
+    };
+}
+//# sourceMappingURL=fields.js.map

package/dist/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAChC,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEvC,6EAA6E;AAC7E,MAAM,UAAU,kBAAkB,CAAC,GAAW;IAC5C,OAAO,CAAC,KAAc,EAAE,EAAE;QACxB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACjE,OAAO,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,GAAG,6BAA6B,KAAK,CAAC,MAAM,IAAI,CAAC;IAClG,CAAC,CAAC;AACJ,CAAC;AAaD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,UAA4B,EAAE;IACtD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC;IAC/C,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,IAAI,aAAa,CAAC;IACzD,MAAM,cAAc,GAAG,OAAO,CAAC,oBAAoB,IAAI,mBAAmB,CAAC;IAC3E,OAAO;QACL;YACE,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;YACtC,KAAK,EAAE,EAAE,WAAW,EAAE,wBAAwB,QAAQ,cAAc,EAAE;SACvE;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,kBAAkB,CAAC,cAAc,CAAC;YAC5C,KAAK,EAAE,EAAE,WAAW,EAAE,0BAA0B,cAAc,cAAc,EAAE;SAC/E;QACD;YACE,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;SAC1C;QACD;YACE,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,EAAE,WAAW,EAAE,gDAAgD,EAAE;SACzE;QACD;YACE,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;YACtC,KAAK,EAAE,EAAE,WAAW,EAAE,mDAAmD,EAAE;SAC5E;QACD;YACE,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,IAAI;YACf,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,kBAAkB,CAAC,cAAc,CAAC;YAC5C,KAAK,EAAE,EAAE,WAAW,EAAE,wDAAwD,EAAE;SACjF;QACD;YACE,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,SAAS;SACtB;QACD;YACE,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,UAAU;YAChB,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,EAAE,WAAW,EAAE,8CAA8C,EAAE;SACvE;QACD;YACE,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,UAAU;YAChB,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,EAAE,WAAW,EAAE,gDAAgD,EAAE;SACzE;KACF,CAAC;AACJ,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,aAAa,CAAC,UAA4B,EAAE;IAC1D,OAAO;QACL,IAAI,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK;QAChC,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC;KAC3B,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { SEO_DESCRIPTION_MAX, SEO_TITLE_MAX, maxLengthValidator, seoFields, seoGroupField, type SeoFieldsOptions, } from "./fields.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EAClB,SAAS,EACT,aAAa,EACb,KAAK,gBAAgB,GACtB,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { SEO_DESCRIPTION_MAX, SEO_TITLE_MAX, maxLengthValidator, seoFields, seoGroupField, } from "./fields.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EAClB,SAAS,EACT,aAAa,GAEd,MAAM,aAAa,CAAC"}

package/package.json

@@ -1,11 +1,28 @@
 {
   "name": "@zedtech/zedkit-payload-seo",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "description": "Localized Payload SEO group field with length validation.",
+  "description": "Drop-in localized SEO group field: meta tags, JSON-LD and length validation, ready for i18n sites.",
+  "keywords": [
+    "payloadcms",
+    "payload",
+    "seo",
+    "cms",
+    "meta-tags",
+    "json-ld",
+    "open-graph",
+    "localization",
+    "i18n",
+    "nextjs",
+    "typescript"
+  ],
+  "homepage": "https://github.com/zedtech-fr/zedkit/tree/main/packages/payload-seo",
+  "bugs": {
+    "url": "https://github.com/zedtech-fr/zedkit/issues"
+  },
   "license": "MIT",
   "repository": {
     "type": "git",