@payloadcms/plugin-seo 1.0.0

package/README.md

@@ -0,0 +1,120 @@
+# Payload SEO Plugin
+
+[![NPM](https://img.shields.io/npm/v/@payloadcms/plugin-seo)](https://www.npmjs.com/package/@payloadcms/plugin-seo)
+
+A plugin for [Payload CMS](https://github.com/payloadcms/payload) to auto-generate SEO meta data based on the content of your documents.
+
+Core features:
+  - Adds a `meta` field to every SEO-enabled collection that:
+    - Includes title, description, and image subfields
+    - Auto-generates meta data from your document's content
+    - Displays hints and indicators to help content editors
+    - Renders a snippet of what a search engine might display
+    - Soon: variable injection
+
+## Installation
+
+```bash
+  yarn add @payloadcms/plugin-seo
+  # OR
+  npm i @payloadcms/plugin-seo
+```
+
+## Basic Usage
+
+In the `plugins` array of your [Payload config](https://payloadcms.com/docs/configuration/overview), call the plugin with [options](#options):
+
+```js
+import { buildConfig } from 'payload/config';
+import seo from '@payloadcms/plugin-seo';
+
+const config = buildConfig({
+  collections: [
+    {
+      slug: 'pages',
+      fields: []
+    },
+    {
+      slug: 'media',
+      upload: {
+        staticDir: // path to your static directory,
+      },
+      fields: []
+    }
+  ],
+  plugins: [
+    seo({
+      collections: [
+        'pages',
+      ],
+      uploadsCollection: 'media',
+      generateTitle: ({ doc }) => `Website.com — ${doc.title.value}`,
+      generateDescription: ({ doc }) => doc.excerpt
+    })
+  ]
+});
+
+export default config;
+```
+
+### Options
+
+- `collections`
+
+    An array of collections slugs to enable SEO. Enabled collections receive a `meta` field which is an object of title, description, and image subfields.
+
+
+- `uploadsCollection`
+
+    An upload-enabled collection slug, for the meta image to access.
+
+- `generateTitle`
+
+    A function that allows you to return any meta title, including from document's content.
+
+    ```js
+    seo({
+      ...
+      generateTitle: ({ doc }) => `Website.com — ${doc?.title?.value}`,
+    })
+    ```
+
+  - `generateDescription`
+
+    A function that allows you to return any meta description, including from document's content.
+
+    ```js
+    seo({
+      ...
+      generateDescription: ({ doc }) => doc?.excerpt?.value
+    })
+    ```
+
+  - `generateURL`
+
+    A function called by the search preview component to display the actual URL of your page.
+
+    ```js
+    seo({
+      ...
+      generateURL: ({ doc }) => `https://yoursite.com/${doc?.slug?.value}`
+    })
+    ```
+
+  ## TypeScript
+
+  All types can be directly imported:
+
+  ```js
+  import {
+    SEOConfig,
+    GenerateTitle,
+    GenerateDescription
+    GenerateURL
+   } from '@payloadcms/plugin-seo/dist/types';
+  ```
+
+  ## Screenshots
+  ![image](https://user-images.githubusercontent.com/70709113/163850633-f3da5f8e-2527-4688-bc79-17233307a883.png)
+
+  <!-- ![screenshot 1](https://github.com/trouble/@payloadcms/plugin-seo/blob/main/images/screenshot-1.jpg?raw=true) -->

package/dist/defaults.d.ts

@@ -0,0 +1,10 @@
+export declare const defaults: {
+    title: {
+        minLength: number;
+        maxLength: number;
+    };
+    description: {
+        minLength: number;
+        maxLength: number;
+    };
+};

package/dist/defaults.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaults = void 0;
+exports.defaults = {
+    title: {
+        minLength: 50,
+        maxLength: 60,
+    },
+    description: {
+        minLength: 100,
+        maxLength: 150,
+    },
+};
+//# sourceMappingURL=defaults.js.map

package/dist/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../src/defaults.ts"],"names":[],"mappings":";;;AAAa,QAAA,QAAQ,GAAG;IACtB,KAAK,EAAE;QACL,SAAS,EAAE,EAAE;QACb,SAAS,EAAE,EAAE;KACd;IACD,WAAW,EAAE;QACX,SAAS,EAAE,GAAG;QACd,SAAS,EAAE,GAAG;KACf;CACF,CAAC"}

package/dist/fields/MetaDescription.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { TextareaField } from 'payload/dist/fields/config/types';
+import { SEOConfig } from '../types';
+declare type TextareaFieldWithProps = TextareaField & {
+    path: string;
+    seoConfig: SEOConfig;
+};
+export declare const MetaDescription: React.FC<(TextareaFieldWithProps | {}) & {
+    seoConfig: SEOConfig;
+}>;
+export declare const getMetaDescriptionField: (props: any) => JSX.Element;
+export {};

package/dist/fields/MetaDescription.js

@@ -0,0 +1,158 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetaDescriptionField = exports.MetaDescription = void 0;
+var react_1 = __importStar(require("react"));
+var forms_1 = require("payload/components/forms");
+var LengthIndicator_1 = require("../ui/LengthIndicator");
+var defaults_1 = require("../defaults");
+var Input_1 = __importDefault(require("payload/dist/admin/components/forms/field-types/Textarea/Input"));
+var _a = defaults_1.defaults.description, minLength = _a.minLength, maxLength = _a.maxLength;
+var MetaDescription = function (props) {
+    var _a = props || {}, path = _a.path, label = _a.label, name = _a.name, seoConfig = _a.seoConfig; // TODO: this typing is temporary until payload types are updated for custom field props
+    var fields = (0, forms_1.useWatchForm)().fields;
+    var field = (0, forms_1.useField)({
+        label: label,
+        name: name,
+        path: path
+    });
+    var value = field.value, setValue = field.setValue, showError = field.showError;
+    var regenerateDescription = (0, react_1.useCallback)(function () {
+        var generateDescription = seoConfig.generateDescription;
+        var getDescription = function () { return __awaiter(void 0, void 0, void 0, function () {
+            var generatedDescription;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!(typeof generateDescription === 'function')) return [3 /*break*/, 2];
+                        return [4 /*yield*/, generateDescription({ doc: __assign({}, fields) })];
+                    case 1:
+                        generatedDescription = _a.sent();
+                        _a.label = 2;
+                    case 2:
+                        setValue(generatedDescription);
+                        return [2 /*return*/];
+                }
+            });
+        }); };
+        getDescription();
+    }, [
+        fields,
+        setValue,
+        seoConfig
+    ]);
+    return (react_1.default.createElement("div", { style: {
+            marginBottom: '20px',
+        } },
+        react_1.default.createElement("div", { style: {
+                marginBottom: '5px',
+                position: 'relative',
+            } },
+            react_1.default.createElement("div", null,
+                label,
+                "\u00A0 \u2014 \u00A0",
+                react_1.default.createElement("button", { onClick: regenerateDescription, type: "button", style: {
+                        padding: 0,
+                        background: 'none',
+                        border: 'none',
+                        backgroundColor: 'transparent',
+                        cursor: 'pointer',
+                        textDecoration: 'underline',
+                    } }, "Auto-generate")),
+            react_1.default.createElement("div", { style: {
+                    color: '#9A9A9A',
+                } }, "This should be between ".concat(minLength, " and ").concat(maxLength, " characters. Auto-generation will format a description using the page content. For help in writing quality meta descriptions, see "),
+                react_1.default.createElement("a", { href: "https://developers.google.com/search/docs/advanced/appearance/snippet#meta-descriptions", rel: "noopener noreferrer", target: "_blank", style: {
+                        color: '-webkit-link',
+                        textDecoration: 'none',
+                    } }, "best practices"))),
+        react_1.default.createElement("div", { style: {
+                marginBottom: '10px',
+                position: 'relative',
+            } },
+            react_1.default.createElement(Input_1.default, { path: name, name: name, onChange: setValue, value: value, showError: showError, style: {
+                    marginBottom: 0
+                } })),
+        react_1.default.createElement("div", { style: {
+                display: 'flex',
+                alignItems: 'center',
+                width: '100%',
+            } },
+            react_1.default.createElement(LengthIndicator_1.LengthIndicator, { text: value, minLength: minLength, maxLength: maxLength }))));
+};
+exports.MetaDescription = MetaDescription;
+var getMetaDescriptionField = function (props) { return (react_1.default.createElement(exports.MetaDescription, __assign({}, props))); };
+exports.getMetaDescriptionField = getMetaDescriptionField;
+//# sourceMappingURL=MetaDescription.js.map

package/dist/fields/MetaDescription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetaDescription.js","sourceRoot":"","sources":["../../src/fields/MetaDescription.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA2C;AAC3C,kDAAkE;AAElE,yDAAwD;AACxD,wCAAuC;AACvC,yGAA2F;AAIrF,IAAA,KAGF,mBAAQ,CAAC,WAAW,EAFtB,SAAS,eAAA,EACT,SAAS,eACa,CAAC;AAOlB,IAAM,eAAe,GAEvB,UAAC,KAAK;IACH,IAAA,KAKF,KAA+B,IAAI,EAAE,EAJvC,IAAI,UAAA,EACJ,KAAK,WAAA,EACL,IAAI,UAAA,EACJ,SAAS,eAC8B,CAAC,CAAC,wFAAwF;IAE3H,IAAA,MAAM,GAAK,IAAA,oBAAY,GAAE,OAAnB,CAAoB;IAElC,IAAM,KAAK,GAAsB,IAAA,gBAAQ,EAAC;QACxC,KAAK,OAAA;QACL,IAAI,MAAA;QACJ,IAAI,MAAA;KACM,CAAC,CAAC;IAGZ,IAAA,KAAK,GAGH,KAAK,MAHF,EACL,QAAQ,GAEN,KAAK,SAFC,EACR,SAAS,GACP,KAAK,UADE,CACD;IAEV,IAAM,qBAAqB,GAAG,IAAA,mBAAW,EAAC;QAChC,IAAA,mBAAmB,GAAK,SAAS,oBAAd,CAAe;QAE1C,IAAM,cAAc,GAAG;;;;;6BAEjB,CAAA,OAAO,mBAAmB,KAAK,UAAU,CAAA,EAAzC,wBAAyC;wBACpB,qBAAM,mBAAmB,CAAC,EAAE,GAAG,eAAO,MAAM,CAAE,EAAE,CAAC,EAAA;;wBAAxE,oBAAoB,GAAG,SAAiD,CAAC;;;wBAE3E,QAAQ,CAAC,oBAAoB,CAAC,CAAC;;;;aAChC,CAAA;QACD,cAAc,EAAE,CAAC;IACnB,CAAC,EAAE;QACD,MAAM;QACN,QAAQ;QACR,SAAS;KACV,CAAC,CAAC;IAEH,OAAO,CACL,uCACE,KAAK,EAAE;YACL,YAAY,EAAE,MAAM;SACrB;QAED,uCACE,KAAK,EAAE;gBACL,YAAY,EAAE,KAAK;gBACnB,QAAQ,EAAE,UAAU;aACrB;YAED;gBACG,KAAK;;gBAIN,0CACE,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAC,QAAQ,EACb,KAAK,EAAE;wBACL,OAAO,EAAE,CAAC;wBACV,UAAU,EAAE,MAAM;wBAClB,MAAM,EAAE,MAAM;wBACd,eAAe,EAAE,aAAa;wBAC9B,MAAM,EAAE,SAAS;wBACjB,cAAc,EAAE,WAAW;qBAC5B,oBAGM,CACL;YACN,uCACE,KAAK,EAAE;oBACL,KAAK,EAAE,SAAS;iBACjB,IAEA,iCAA0B,SAAS,kBAAQ,SAAS,uIAAoI;gBACzL,qCACE,IAAI,EAAC,yFAAyF,EAC9F,GAAG,EAAC,qBAAqB,EACzB,MAAM,EAAC,QAAQ,EACf,KAAK,EAAE;wBACL,KAAK,EAAE,cAAc;wBACrB,cAAc,EAAE,MAAM;qBACvB,qBAGC,CACA,CACF;QACN,uCACE,KAAK,EAAE;gBACL,YAAY,EAAE,MAAM;gBACpB,QAAQ,EAAE,UAAU;aACrB;YAED,8BAAC,eAAa,IACZ,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE;oBACL,YAAY,EAAE,CAAC;iBAChB,GACD,CACE;QACN,uCACE,KAAK,EAAE;gBACL,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE,QAAQ;gBACpB,KAAK,EAAE,MAAM;aACd;YAED,8BAAC,iCAAe,IACd,IAAI,EAAE,KAAe,EACrB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,GACpB,CACE,CACF,CACP,CAAC;AACJ,CAAC,CAAC;AA5HW,QAAA,eAAe,mBA4H1B;AAEK,IAAM,uBAAuB,GAAG,UAAC,KAAU,IAAK,OAAA,CACrD,8BAAC,uBAAe,eAAK,KAAK,EAAI,CAC/B,EAFsD,CAEtD,CAAA;AAFY,QAAA,uBAAuB,2BAEnC"}

package/dist/fields/MetaImage.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { Props as UploadFieldType } from 'payload/dist/admin/components/forms/field-types/Upload/types';
+import { SEOConfig } from '../types';
+declare type UploadFieldWithProps = UploadFieldType & {
+    path: string;
+    seoConfig: SEOConfig;
+};
+export declare const MetaImage: React.FC<UploadFieldWithProps | {}>;
+export declare const getMetaImageField: (props: any) => JSX.Element;
+export {};

package/dist/fields/MetaImage.js

@@ -0,0 +1,161 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetaImageField = exports.MetaImage = void 0;
+var react_1 = __importStar(require("react"));
+var config_provider_1 = require("@payloadcms/config-provider");
+var Input_1 = __importDefault(require("payload/dist/admin/components/forms/field-types/Upload/Input"));
+var forms_1 = require("payload/components/forms");
+var Pill_1 = require("../ui/Pill");
+var MetaImage = function (props) {
+    var _a = props || {}, label = _a.label, relationTo = _a.relationTo, fieldTypes = _a.fieldTypes, name = _a.name, seoConfig = _a.seoConfig; // TODO: this typing is temporary until payload types are updated for custom field props
+    var field = (0, forms_1.useField)(props);
+    var fields = (0, forms_1.useWatchForm)().fields;
+    var value = field.value, setValue = field.setValue, showError = field.showError;
+    var regenerateImage = (0, react_1.useCallback)(function () {
+        var generateImage = seoConfig.generateImage;
+        var getDescription = function () { return __awaiter(void 0, void 0, void 0, function () {
+            var generatedImage;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!(typeof generateImage === 'function')) return [3 /*break*/, 2];
+                        return [4 /*yield*/, generateImage({ doc: __assign({}, fields) })];
+                    case 1:
+                        generatedImage = _a.sent();
+                        _a.label = 2;
+                    case 2:
+                        setValue(generatedImage);
+                        return [2 /*return*/];
+                }
+            });
+        }); };
+        getDescription();
+    }, [
+        fields,
+        setValue,
+        seoConfig
+    ]);
+    var hasImage = Boolean(value);
+    var config = (0, config_provider_1.useConfig)();
+    var collections = config.collections, serverURL = config.serverURL, _b = config.routes, _c = _b === void 0 ? {} : _b, api = _c.api;
+    var collection = (collections === null || collections === void 0 ? void 0 : collections.find(function (coll) { return coll.slug === relationTo; })) || undefined;
+    return (react_1.default.createElement("div", { style: {
+            marginBottom: '20px',
+        } },
+        react_1.default.createElement("div", { style: {
+                marginBottom: '5px',
+                position: 'relative',
+            } },
+            react_1.default.createElement("div", null,
+                label,
+                "\u00A0 \u2014 \u00A0",
+                react_1.default.createElement("button", { onClick: regenerateImage, type: "button", style: {
+                        padding: 0,
+                        background: 'none',
+                        border: 'none',
+                        backgroundColor: 'transparent',
+                        cursor: 'pointer',
+                        textDecoration: 'underline',
+                    } }, "Auto-generate")),
+            react_1.default.createElement("div", { style: {
+                    color: '#9A9A9A',
+                } }, "Auto-generation will retrieve the selected hero image.")),
+        react_1.default.createElement("div", { style: {
+                marginBottom: '10px',
+                position: 'relative',
+            } },
+            react_1.default.createElement(Input_1.default, { path: name, fieldTypes: fieldTypes, name: name, relationTo: relationTo, value: value, onChange: function (incomingImage) {
+                    if (incomingImage !== null) {
+                        var incomingID = incomingImage.id;
+                        setValue(incomingID);
+                    }
+                    else {
+                        setValue(null);
+                    }
+                }, label: undefined, showError: showError, api: api, collection: collection, serverURL: serverURL, filterOptions: {}, style: {
+                    marginBottom: 0,
+                } })),
+        react_1.default.createElement("div", { style: {
+                display: 'flex',
+                alignItems: 'center',
+                width: '100%',
+            } },
+            react_1.default.createElement(Pill_1.Pill, { backgroundColor: hasImage ? 'green' : 'red', color: "white", label: hasImage ? 'Good' : 'No Image' }))));
+};
+exports.MetaImage = MetaImage;
+var getMetaImageField = function (props) { return (react_1.default.createElement(exports.MetaImage, __assign({}, props))); };
+exports.getMetaImageField = getMetaImageField;
+//# sourceMappingURL=MetaImage.js.map

package/dist/fields/MetaImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetaImage.js","sourceRoot":"","sources":["../../src/fields/MetaImage.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA2C;AAC3C,+DAAwD;AAExD,uGAAuF;AACvF,kDAAkE;AAElE,mCAAkC;AAQ3B,IAAM,SAAS,GAAwC,UAAC,KAAK;IAC5D,IAAA,KAMF,KAA6B,IAAI,EAAE,EALrC,KAAK,WAAA,EACL,UAAU,gBAAA,EACV,UAAU,gBAAA,EACV,IAAI,UAAA,EACJ,SAAS,eAC4B,CAAC,CAAC,wFAAwF;IAEjI,IAAM,KAAK,GAAsB,IAAA,gBAAQ,EAAC,KAAgB,CAAC,CAAC;IAEpD,IAAA,MAAM,GAAK,IAAA,oBAAY,GAAE,OAAnB,CAAoB;IAGhC,IAAA,KAAK,GAGH,KAAK,MAHF,EACL,QAAQ,GAEN,KAAK,SAFC,EACR,SAAS,GACP,KAAK,UADE,CACD;IAEV,IAAM,eAAe,GAAG,IAAA,mBAAW,EAAC;QAC1B,IAAA,aAAa,GAAK,SAAS,cAAd,CAAe;QACpC,IAAM,cAAc,GAAG;;;;;6BAEjB,CAAA,OAAO,aAAa,KAAK,UAAU,CAAA,EAAnC,wBAAmC;wBACpB,qBAAM,aAAa,CAAC,EAAE,GAAG,eAAO,MAAM,CAAE,EAAE,CAAC,EAAA;;wBAA5D,cAAc,GAAG,SAA2C,CAAC;;;wBAE/D,QAAQ,CAAC,cAAc,CAAC,CAAC;;;;aAC1B,CAAA;QACD,cAAc,EAAE,CAAC;IACnB,CAAC,EAAE;QACD,MAAM;QACN,QAAQ;QACR,SAAS;KACV,CAAC,CAAC;IAEH,IAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAEhC,IAAM,MAAM,GAAG,IAAA,2BAAS,GAAE,CAAC;IAGzB,IAAA,WAAW,GAKT,MAAM,YALG,EACX,SAAS,GAIP,MAAM,UAJC,EACT,KAGE,MAAM,OADF,EAFN,qBAEI,EAAE,KAAA,EADJ,GAAG,SACC,CACG;IAEX,IAAM,UAAU,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,KAAK,UAAU,EAAxB,CAAwB,CAAC,KAAI,SAAS,CAAC;IAEtF,OAAO,CACL,uCACE,KAAK,EAAE;YACL,YAAY,EAAE,MAAM;SACrB;QAED,uCACE,KAAK,EAAE;gBACL,YAAY,EAAE,KAAK;gBACnB,QAAQ,EAAE,UAAU;aACrB;YAED;gBACG,KAAK;;gBAIN,0CACE,OAAO,EAAE,eAAe,EACxB,IAAI,EAAC,QAAQ,EACb,KAAK,EAAE;wBACL,OAAO,EAAE,CAAC;wBACV,UAAU,EAAE,MAAM;wBAClB,MAAM,EAAE,MAAM;wBACd,eAAe,EAAE,aAAa;wBAC9B,MAAM,EAAE,SAAS;wBACjB,cAAc,EAAE,WAAW;qBAC5B,oBAGM,CACL;YACN,uCACE,KAAK,EAAE;oBACL,KAAK,EAAE,SAAS;iBACjB,6DAGG,CACF;QACN,uCACE,KAAK,EAAE;gBACL,YAAY,EAAE,MAAM;gBACpB,QAAQ,EAAE,UAAU;aACrB;YAED,8BAAC,eAAW,IACV,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,UAAC,aAAa;oBACtB,IAAI,aAAa,KAAK,IAAI,EAAE;wBAClB,IAAI,UAAU,GAAK,aAAa,GAAlB,CAAmB;wBACzC,QAAQ,CAAC,UAAU,CAAC,CAAC;qBACtB;yBAAM;wBACL,QAAQ,CAAC,IAAI,CAAC,CAAC;qBAChB;gBACH,CAAC,EACD,KAAK,EAAE,SAAS,EAChB,SAAS,EAAE,SAAS,EACpB,GAAG,EAAE,GAAG,EACR,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,EAAE,EACjB,KAAK,EAAE;oBACL,YAAY,EAAE,CAAC;iBAChB,GACD,CACE;QACN,uCACE,KAAK,EAAE;gBACL,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE,QAAQ;gBACpB,KAAK,EAAE,MAAM;aACd;YAED,8BAAC,WAAI,IACH,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAC3C,KAAK,EAAC,OAAO,EACb,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,GACrC,CACE,CACF,CACP,CAAC;AACJ,CAAC,CAAC;AAvIW,QAAA,SAAS,aAuIpB;AAEK,IAAM,iBAAiB,GAAG,UAAC,KAAU,IAAK,OAAA,CAC/C,8BAAC,iBAAS,eAAK,KAAK,EAAI,CACzB,EAFgD,CAEhD,CAAA;AAFY,QAAA,iBAAiB,qBAE7B"}

package/dist/fields/MetaTitle.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { Props as TextFieldType } from 'payload/dist/admin/components/forms/field-types/Text/types';
+import { SEOConfig } from '../types';
+declare type TextFieldWithProps = TextFieldType & {
+    path: string;
+    seoConfig: SEOConfig;
+};
+export declare const MetaTitle: React.FC<TextFieldWithProps | {}>;
+export declare const getMetaTitleField: (props: any) => JSX.Element;
+export {};