@easy-cms/plugin-redirects 0.24.0 → 0.25.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from '@easy-cms/core';
+import { TypedPlugin } from '@easy-cms/core';
 
 type Doc$1 = Record<string, unknown>;
 interface UrlArgs {
@@ -38,7 +38,51 @@ interface RedirectsPluginOptions {
  * A `redirects` collection under Settings in the admin, `resolveRedirect()` for your app's
  * middleware, and automatic redirects when a page's address changes.
  */
-declare function redirectsPlugin(options?: RedirectsPluginOptions): Plugin;
+/** `to_<slug>`: the field of a redirect that points to a document of collection `S`. */
+type TargetField<S extends string> = `to_${Underscored<S>}`;
+type Underscored<S extends string> = S extends `${infer A}-${infer B}` ? `${A}_${Underscored<B>}` : S;
+/** The redirects collection, as the inferred document types see it. */
+type RedirectsCollection<R extends string, S extends string> = {
+    readonly slug: R;
+    readonly fields: readonly [
+        {
+            readonly name: 'from';
+            readonly type: 'text';
+            readonly required: true;
+        },
+        {
+            readonly name: 'to';
+            readonly type: 'text';
+        },
+        {
+            readonly name: 'locale';
+            readonly type: 'select';
+            readonly options: readonly string[];
+        },
+        {
+            readonly name: 'type';
+            readonly type: 'select';
+            readonly options: readonly ['301', '302', '307', '308'];
+            readonly required: true;
+            readonly defaultValue: '301';
+        },
+        ...{
+            [K in S]: {
+                readonly name: TargetField<K>;
+                readonly type: 'relationship';
+                readonly to: K;
+            };
+        }[S][]
+    ];
+};
+/** What `redirectsPlugin(options)` adds: the redirects collection. */
+type RedirectsPluginTypes<R extends string, S extends string> = {
+    readonly collections: readonly [RedirectsCollection<R, S>];
+};
+declare function redirectsPlugin<const S extends string = never, const R extends string = 'redirects'>(options?: RedirectsPluginOptions & {
+    readonly collections?: readonly S[];
+    readonly slug?: R;
+}): TypedPlugin<RedirectsPluginTypes<R, S>>;
 
 type Doc = Record<string, unknown>;
 /** The part of the Local API the helpers use; a structural type. */
@@ -81,4 +125,4 @@ declare function resolveRedirect(cms: RedirectsCMS, input: string | URL): Promis
 declare const STATUSES: readonly [301, 302, 307, 308];
 type RedirectStatus = (typeof STATUSES)[number];
 
-export { type Redirect, type RedirectStatus, type RedirectsPluginOptions, STATUSES, type UrlArgs, clearRedirects, normalizePath, redirectsPlugin, resolveRedirect };
+export { type Redirect, type RedirectStatus, type RedirectsCollection, type RedirectsPluginOptions, type RedirectsPluginTypes, STATUSES, type UrlArgs, clearRedirects, normalizePath, redirectsPlugin, resolveRedirect };

package/dist/index.js

@@ -1,3 +1,8 @@
+// src/plugin.ts
+import {
+  definePlugin
+} from "@easy-cms/core";
+
 // src/shared.ts
 var REDIRECTS_SOURCE = /* @__PURE__ */ Symbol.for("easy-cms.plugin-redirects.source");
 var STATUSES = [301, 302, 307, 308];
@@ -95,7 +100,7 @@ async function target(cms, source, doc) {
 
 // src/plugin.ts
 function redirectsPlugin(options = {}) {
-  return (config) => {
+  return definePlugin((config) => {
     const slug = options.slug ?? "redirects";
     const collections = options.collections ?? [];
     const missing = collections.filter((s) => !config.collections?.some((c) => c.slug === s));
@@ -273,7 +278,7 @@ function redirectsPlugin(options = {}) {
       collections: [...(config.collections ?? []).map(withAuto), redirects2],
       endpoints: [...config.endpoints ?? [], endpoint]
     };
-  };
+  });
 }
 export {
   STATUSES,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/plugin-redirects",
-  "version": "0.24.0",
+  "version": "0.25.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.24.0"
+    "@easy-cms/core": "^0.25.0"
   },
   "devDependencies": {
-    "@easy-cms/core": "^0.24.0",
-    "@easy-cms/db-sqlite": "^0.24.0"
+    "@easy-cms/core": "^0.25.0",
+    "@easy-cms/db-sqlite": "^0.25.0"
   },
   "engines": {
     "node": ">=22.12"