@easy-cms/plugin-redirects 0.48.0 → 0.49.0

package/dist/index.d.ts

@@ -26,13 +26,15 @@ interface RedirectsPluginOptions {
      */
     readonly autoRedirect?: boolean | readonly string[];
     /** Slug of the redirects collection. Default `redirects`. */
-    readonly slug?: string;
+    readonly slugs?: {
+        readonly redirects?: string;
+    };
     /**
-     * How long a server keeps the redirects in memory, in ms. Changes clear it at once on the
-     * server that made them; other servers (serverless instances) catch up within this time.
-     * Default 60000.
+     * How long a server keeps the redirects in memory, in seconds. Changes clear it at once on
+     * the server that made them; other servers (serverless instances) catch up within this time.
+     * Default 60.
      */
-    readonly cacheTTL?: number;
+    readonly cacheMaxAge?: number;
 }
 /**
  * A `redirects` collection under Settings in the admin, `resolveRedirect()` for your app's
@@ -81,7 +83,9 @@ type RedirectsPluginTypes<R extends string, S extends string> = {
 };
 declare function redirectsPlugin<const S extends string = never, const R extends string = 'redirects'>(options?: RedirectsPluginOptions & {
     readonly collections?: readonly S[];
-    readonly slug?: R;
+    readonly slugs?: {
+        readonly redirects?: R;
+    };
 }): TypedPlugin<RedirectsPluginTypes<R, S>>;
 
 type Doc = Record<string, unknown>;
@@ -122,7 +126,7 @@ interface ResolveRedirectOptions {
 declare function clearRedirects(cms: object): void;
 /**
  * The redirect for a request's path, or `null`. Pass the request's URL to keep its query
- * string. Redirects are read once and kept in memory (see `cacheTTL`), so calling this on every
+ * string. Redirects are read once and kept in memory (see `cacheMaxAge`), so calling this on every
  * request is cheap.
  *
  * ```ts

package/dist/index.js

@@ -2,11 +2,14 @@
 import {
   definePlugin
 } from "@easy-cms/core";
+import { checkRenamedOptions } from "@easy-cms/core/internal";
 
 // src/info.ts
 var INFO = {
   name: "@easy-cms/plugin-redirects",
-  ...true ? { version: "0.48.0" } : {}
+  // The plugin API it is written for (`PLUGIN_API_VERSION` of @easy-cms/core).
+  apiVersion: 1,
+  ...true ? { version: "0.49.0" } : {}
 };
 
 // src/shared.ts
@@ -63,7 +66,7 @@ async function redirects(cms, options) {
   holder[CACHE] ??= /* @__PURE__ */ new Map();
   const caches = holder[CACHE];
   const cached = caches.get(key);
-  if (cached && Date.now() - cached.at < source.cacheTTL) return cached.map;
+  if (cached && Date.now() - cached.at < source.cacheMs) return cached.map;
   const map = load(cms, source, scope);
   caches.set(key, { at: Date.now(), map });
   map.catch(() => {
@@ -117,8 +120,12 @@ async function target(cms, source, doc) {
 
 // src/plugin.ts
 function redirectsPlugin(options = {}) {
+  checkRenamedOptions("redirectsPlugin", options, {
+    slug: "slugs.redirects",
+    cacheTTL: "cacheMaxAge (in seconds)"
+  });
   return definePlugin((config) => {
-    const slug = options.slug ?? "redirects";
+    const slug = options.slugs?.redirects ?? "redirects";
     const collections = options.collections ?? [];
     const missing = collections.filter((s) => !config.collections?.some((c) => c.slug === s));
     if (missing.length > 0)
@@ -130,8 +137,10 @@ function redirectsPlugin(options = {}) {
         "redirectsPlugin: set `url` to give the address of documents in `collections`"
       );
     if (config.collections?.some((c) => c.slug === slug))
-      throw new Error(`redirectsPlugin: there is already a collection "${slug}"; set \`slug\``);
-    const locales = config.localization?.locales ?? [];
+      throw new Error(
+        `redirectsPlugin: there is already a collection "${slug}"; set \`slugs.redirects\``
+      );
+    const locales = (config.localization || void 0)?.locales ?? [];
     const auto = options.autoRedirect === false ? [] : options.autoRedirect === true || options.autoRedirect === void 0 ? collections : options.autoRedirect.filter((s) => collections.includes(s));
     const urlOf = async (cms, collection, id, locale) => {
       const doc = await cms.findById(collection, id, {
@@ -147,7 +156,7 @@ function redirectsPlugin(options = {}) {
       slug,
       collections,
       url: options.url,
-      cacheTTL: options.cacheTTL ?? 6e4
+      cacheMs: (options.cacheMaxAge ?? 60) * 1e3
     };
     const targets = collections.map((collection) => {
       const label = config.collections?.find((c) => c.slug === collection)?.labels?.singular;
@@ -199,7 +208,7 @@ function redirectsPlugin(options = {}) {
         defaultValue: "301",
         required: true,
         label: { en: "Type", th: "\u0E0A\u0E19\u0E34\u0E14" },
-        position: "sidebar"
+        admin: { position: "sidebar" }
       }
     ];
     const clear = ({ cms }) => clearRedirects(cms);
@@ -209,10 +218,8 @@ function redirectsPlugin(options = {}) {
         singular: { en: "Redirect", th: "\u0E01\u0E32\u0E23\u0E40\u0E1B\u0E25\u0E35\u0E48\u0E22\u0E19\u0E40\u0E2A\u0E49\u0E19\u0E17\u0E32\u0E07" },
         plural: { en: "Redirects", th: "\u0E01\u0E32\u0E23\u0E40\u0E1B\u0E25\u0E35\u0E48\u0E22\u0E19\u0E40\u0E2A\u0E49\u0E19\u0E17\u0E32\u0E07" }
       },
-      icon: "link",
       useAsTitle: "from",
-      editIn: "drawer",
-      admin: { group: "settings" },
+      admin: { editIn: "drawer", icon: "link", group: "settings" },
       fields: redirectFields,
       hooks: {
         beforeChange: [
@@ -223,11 +230,11 @@ function redirectsPlugin(options = {}) {
       }
     };
     const before = /* @__PURE__ */ new Map();
-    const remember = async ({ data, operation, originalDoc, cms, slug: s }) => {
-      if (operation === "update" && originalDoc?.id !== void 0)
+    const remember = async ({ data, operation, previousDoc, cms, slug: s }) => {
+      if (operation === "update" && previousDoc?.id !== void 0)
         before.set(
-          `${s}:${originalDoc.id}`,
-          await Promise.all(localeList.map((l) => urlOf(cms, s, originalDoc.id, l)))
+          `${s}:${previousDoc.id}`,
+          await Promise.all(localeList.map((l) => urlOf(cms, s, previousDoc.id, l)))
         );
       return data;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/plugin-redirects",
-  "version": "0.48.0",
+  "version": "0.49.0",
   "description": "Redirects for Easy CMS: 301s managed in the admin, automatic redirects when a page's address changes",
   "license": "MIT",
   "type": "module",
@@ -16,11 +16,11 @@
     "dist"
   ],
   "peerDependencies": {
-    "@easy-cms/core": "^0.48.0"
+    "@easy-cms/core": "^0.49.0"
   },
   "devDependencies": {
-    "@easy-cms/core": "^0.48.0",
-    "@easy-cms/db-sqlite": "^0.48.0"
+    "@easy-cms/core": "^0.49.0",
+    "@easy-cms/db-sqlite": "^0.49.0"
   },
   "engines": {
     "node": ">=22.12"