@payloadcms/plugin-redirects 0.0.1

package/README.md

@@ -0,0 +1,92 @@
+# Payload Redirects Plugin
+
+[![NPM](https://img.shields.io/npm/v/@payloadcms/plugin-redirects)](https://www.npmjs.com/package/@payloadcms/plugin-redirects)
+
+A plugin for [Payload CMS](https://github.com/payloadcms/payload) to easily manage your redirects.
+
+Core features:
+
+- Adds a `redirects` collection to your config that:
+  - includes a `from` and `to` fields
+  - allows `to` to be a document reference
+
+## Installation
+
+```bash
+  yarn add @payloadcms/plugin-redirects
+  # OR
+  npm i @payloadcms/plugin-redirects
+```
+
+## 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 redirects from "@payloadcms/plugin-redirects";
+
+const config = buildConfig({
+  collections: [
+    {
+      slug: "pages",
+      fields: [],
+    },
+  ],
+  plugins: [
+    redirects({
+      collections: ["pages"],
+    }),
+  ],
+});
+
+export default config;
+```
+
+### Options
+
+- `collections` : string[] | optional
+
+  An array of collections slugs to populate in the `to` field of each redirect.
+
+- `overrides` : object | optional
+
+  A partial collection config that allows you to override anything on the `redirects` collection.
+
+## TypeScript
+
+All types can be directly imported:
+
+```js
+import { PluginConfig } from "@payloadcms/plugin-redirects/types";
+```
+
+## Development
+
+To actively develop or debug this plugin you can either work directly within the demo directory of this repo, or link your own project.
+
+1. #### Internal Demo
+
+   This repo includes a fully working, self-seeding instance of Payload that installs the plugin directly from the source code. This is the easiest way to get started. To spin up this demo, follow these steps:
+
+   1. First clone the repo
+   1. Then, `cd YOUR_PLUGIN_REPO && yarn && cd demo && yarn && yarn dev`
+   1. Now open `http://localhost:3000/admin` in your browser
+   1. Enter username `dev@payloadcms.com` and password `test`
+
+   That's it! Changes made in `./src` will be reflected in your demo. Keep in mind that the demo database is automatically seeded on every startup, any changes you make to the data get destroyed each time you reboot the app.
+
+1. #### Linked Project
+
+   You can alternatively link your own project to the source code:
+
+   1. First clone the repo
+   1. Then, `cd YOUR_PLUGIN_REPO && yarn && cd demo && cp env.example .env && yarn && yarn dev`
+   1. Now `cd` back into your own project and run, `yarn link @payloadcms/plugin-redirects`
+   1. If this plugin using React in any way, continue to the next step. Otherwise skip to step 7.
+   1. From your own project, `cd node_modules/react && yarn link && cd ../react-dom && yarn link && cd ../../`
+   1. Then, `cd YOUR_PLUGIN_REPO && yarn link react react-dom`
+
+   All set! You can now boot up your own project as normal, and your local copy of the plugin source code will be used. Keep in mind that changes to the source code require a rebuild, `yarn build`.
+
+## Screenshots

package/dist/deepMerge.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Simple object check.
+ * @param item
+ * @returns {boolean}
+ */
+export declare function isObject(item: unknown): boolean;
+/**
+ * Deep merge two objects.
+ * @param target
+ * @param ...sources
+ */
+export default function deepMerge<T, R>(target: T, source: R): T;

package/dist/deepMerge.js

@@ -0,0 +1,51 @@
+"use strict";
+// @ts-nocheck
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = void 0;
+/**
+ * Simple object check.
+ * @param item
+ * @returns {boolean}
+ */
+function isObject(item) {
+    return (item && typeof item === 'object' && !Array.isArray(item));
+}
+exports.isObject = isObject;
+/**
+ * Deep merge two objects.
+ * @param target
+ * @param ...sources
+ */
+function deepMerge(target, source) {
+    var output = __assign({}, target);
+    if (isObject(target) && isObject(source)) {
+        Object.keys(source).forEach(function (key) {
+            var _a, _b;
+            if (isObject(source[key])) {
+                if (!(key in target)) {
+                    Object.assign(output, (_a = {}, _a[key] = source[key], _a));
+                }
+                else {
+                    output[key] = deepMerge(target[key], source[key]);
+                }
+            }
+            else {
+                Object.assign(output, (_b = {}, _b[key] = source[key], _b));
+            }
+        });
+    }
+    return output;
+}
+exports.default = deepMerge;
+//# sourceMappingURL=deepMerge.js.map

package/dist/deepMerge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepMerge.js","sourceRoot":"","sources":["../src/deepMerge.ts"],"names":[],"mappings":";AAAA,cAAc;;;;;;;;;;;;;;AAEd;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,IAAa;IACpC,OAAO,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AACpE,CAAC;AAFD,4BAEC;AAED;;;;GAIG;AACH,SAAwB,SAAS,CAAO,MAAS,EAAE,MAAS;IAC1D,IAAM,MAAM,gBAAQ,MAAM,CAAE,CAAC;IAC7B,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE;QACxC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,UAAC,GAAG;;YAC9B,IAAI,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACzB,IAAI,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE;oBACpB,MAAM,CAAC,MAAM,CAAC,MAAM,YAAI,GAAC,GAAG,IAAG,MAAM,CAAC,GAAG,CAAC,MAAG,CAAC;iBAC/C;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;iBACnD;aACF;iBAAM;gBACL,MAAM,CAAC,MAAM,CAAC,MAAM,YAAI,GAAC,GAAG,IAAG,MAAM,CAAC,GAAG,CAAC,MAAG,CAAC;aAC/C;QACH,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,4BAiBC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { Config } from 'payload/config';
+import { PluginConfig } from './types';
+declare const redirects: (pluginConfig: PluginConfig) => (incomingConfig: Config) => Config;
+export default redirects;

package/dist/index.js

@@ -0,0 +1,97 @@
+"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 __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var deepMerge_1 = __importDefault(require("./deepMerge"));
+var redirects = function (pluginConfig) { return function (incomingConfig) { return (__assign(__assign({}, incomingConfig), { collections: __spreadArray(__spreadArray([], (incomingConfig === null || incomingConfig === void 0 ? void 0 : incomingConfig.collections) || [], true), [
+        (0, deepMerge_1.default)({
+            slug: 'redirects',
+            admin: {
+                defaultColumns: [
+                    'from',
+                    'to.type',
+                    'createdAt',
+                ],
+            },
+            access: {
+                read: function () { return true; },
+            },
+            fields: [
+                {
+                    name: 'from',
+                    label: 'From URL',
+                    index: true,
+                    required: true,
+                    type: 'text',
+                },
+                {
+                    name: 'to',
+                    label: false,
+                    type: 'group',
+                    fields: [
+                        {
+                            name: 'type',
+                            label: 'To URL Type',
+                            type: 'radio',
+                            options: [
+                                {
+                                    label: 'Internal link',
+                                    value: 'reference',
+                                },
+                                {
+                                    label: 'Custom URL',
+                                    value: 'custom',
+                                },
+                            ],
+                            defaultValue: 'reference',
+                            admin: {
+                                layout: 'horizontal',
+                            },
+                        },
+                        {
+                            name: 'reference',
+                            label: 'Document to redirect to',
+                            type: 'relationship',
+                            relationTo: (pluginConfig === null || pluginConfig === void 0 ? void 0 : pluginConfig.collections) || [],
+                            required: true,
+                            admin: {
+                                condition: function (_, siblingData) { return (siblingData === null || siblingData === void 0 ? void 0 : siblingData.type) === 'reference'; },
+                            },
+                        },
+                        {
+                            name: 'url',
+                            label: 'Custom URL',
+                            type: 'text',
+                            required: true,
+                            admin: {
+                                condition: function (_, siblingData) { return (siblingData === null || siblingData === void 0 ? void 0 : siblingData.type) === 'custom'; },
+                            },
+                        },
+                    ],
+                },
+            ],
+        }, (pluginConfig === null || pluginConfig === void 0 ? void 0 : pluginConfig.overrides) || {}),
+    ], false) })); }; };
+exports.default = redirects;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACA,0DAAoC;AAGpC,IAAM,SAAS,GAAG,UAAC,YAA0B,IAAK,OAAA,UAAC,cAAsB,IAAa,OAAA,uBACjF,cAAc,KACjB,WAAW,kCACN,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW,KAAI,EAAE;QACpC,IAAA,mBAAS,EAAC;YACR,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE;gBACL,cAAc,EAAE;oBACd,MAAM;oBACN,SAAS;oBACT,WAAW;iBACZ;aACF;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,cAAe,OAAA,IAAI,EAAJ,CAAI;aAC1B;YACD,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,UAAU;oBACjB,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,IAAI;oBACd,IAAI,EAAE,MAAM;iBACb;gBACD;oBACE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,KAAK;oBACZ,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE;wBACN;4BACE,IAAI,EAAE,MAAM;4BACZ,KAAK,EAAE,aAAa;4BACpB,IAAI,EAAE,OAAO;4BACb,OAAO,EAAE;gCACP;oCACE,KAAK,EAAE,eAAe;oCACtB,KAAK,EAAE,WAAW;iCACnB;gCACD;oCACE,KAAK,EAAE,YAAY;oCACnB,KAAK,EAAE,QAAQ;iCAChB;6BACF;4BACD,YAAY,EAAE,WAAW;4BACzB,KAAK,EAAE;gCACL,MAAM,EAAE,YAAY;6BACrB;yBACF;wBACD;4BACE,IAAI,EAAE,WAAW;4BACjB,KAAK,EAAE,yBAAyB;4BAChC,IAAI,EAAE,cAAc;4BACpB,UAAU,EAAE,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,WAAW,KAAI,EAAE;4BAC3C,QAAQ,EAAE,IAAI;4BACd,KAAK,EAAE;gCACL,SAAS,EAAE,UAAC,CAAC,EAAE,WAAW,IAAK,OAAA,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,MAAK,WAAW,EAAjC,CAAiC;6BACjE;yBACF;wBACD;4BACE,IAAI,EAAE,KAAK;4BACX,KAAK,EAAE,YAAY;4BACnB,IAAI,EAAE,MAAM;4BACZ,QAAQ,EAAE,IAAI;4BACd,KAAK,EAAE;gCACL,SAAS,EAAE,UAAC,CAAC,EAAE,WAAW,IAAK,OAAA,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,MAAK,QAAQ,EAA9B,CAA8B;6BAC9D;yBACF;qBACF;iBACF;aACF;SACF,EAAE,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,SAAS,KAAI,EAAE,CAAC;iBAEnC,EAxEoF,CAwEpF,EAxEgD,CAwEhD,CAAC;AAEH,kBAAe,SAAS,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,5 @@
+import { CollectionConfig } from "payload/types";
+export type PluginConfig = {
+    overrides?: Partial<CollectionConfig>;
+    collections?: string[];
+};

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@payloadcms/plugin-redirects",
+  "version": "0.0.1",
+  "homepage:": "https://payloadcms.com",
+  "repository": "git@github.com:payloadcms/plugin-redirects.git",
+  "description": "Redirects plugin for Payload CMS",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "payload",
+    "cms",
+    "plugin",
+    "typescript",
+    "react",
+    "redirects",
+    "nextjs"
+  ],
+  "author": "dev@payloadcms.com",
+  "license": "MIT",
+  "peerDependencies": {
+    "payload": "^0.18.5 || ^1.0.0",
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
+  },
+  "devDependencies": {
+    "payload": "^1.0.9",
+    "react": "^18.0.0",
+    "typescript": "^4.5.5"
+  },
+  "files": [
+    "dist",
+    "types.js",
+    "types.d.ts"
+  ]
+}

package/types.d.ts

@@ -0,0 +1 @@
+export * from './dist/types';

package/types.js

@@ -0,0 +1 @@
+module.exports = require('./dist/types');