@rakun-kit/core 1.5.11 → 1.5.12

package/README.md

@@ -427,6 +427,9 @@ Main properties:
 - `withHooks()`: attaches lifecycle hooks such as `beforeInsert`, `beforeUpdate`, and `onGet`.
 - Dynamic data bindings are available on manager-visible fields by default; use
   field-level `.noDynamic()` to opt out.
+- A string field can initialize a new document's SEO dynamic data with
+  `.seo('title')`, `.seo('description')`, or another string field from Rakun's
+  built-in SEO model. This does not change existing documents.
 
 When a content type has a configured route with `hasPage: true`, Rakun adds an
 optional reserved `_seo` relation automatically. If that content type has an
@@ -469,6 +472,21 @@ selected, while reserved SEO metadata is omitted from dynamic data mappings.
 The generated `href` source is only shown for content types that have a
 configured route with `hasPage: true`.
 
+For example, a routeable category can pre-link its SEO title when a new category
+is created:
+
+```ts
+const Category = new ContentType({
+  name: 'Category',
+  fields: {
+    title: f.string().required().seo('title'),
+  },
+})
+```
+
+The manager stores this as a normal editable dynamic data binding from
+`seo.title` to `Current document · title`.
+
 ```ts
 const Project = new ContentType({
   name: 'Project',

package/dist/cjs/lib/fields/String.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringUis = void 0;
+exports.seoStringFields = exports.stringUis = void 0;
 exports.stringField = stringField;
 const zod_1 = __importDefault(require("zod"));
 const Field_1 = require("./Field");
@@ -19,6 +19,20 @@ exports.stringUis = [
     "Id",
     "Url",
 ];
+exports.seoStringFields = [
+    "title",
+    "description",
+    "canonicalUrl",
+    "imageAlt",
+    "openGraphTitle",
+    "openGraphDescription",
+    "openGraphUrl",
+    "openGraphSiteName",
+    "openGraphImageAlt",
+    "twitterTitle",
+    "twitterDescription",
+    "twitterImageAlt",
+];
 function stringField() {
     return makeStringField({ ui: "Text" }, Field_1.defaultFieldState);
 }
@@ -28,6 +42,7 @@ function makeStringField(options, state) {
         ui: options.ui,
         minLength: options.minLength,
         maxLength: options.maxLength,
+        seo: options.seo,
     };
     const field = {
         ...(0, Field_1.createField)({
@@ -36,6 +51,9 @@ function makeStringField(options, state) {
             schemas: (0, Field_1.sameSchemas)(() => buildStringSchema(options)),
         }),
         type: function (ui) {
+            if (ui === "RichText" && options.seo) {
+                throw new Error("RichText fields cannot initialize string SEO fields.");
+            }
             return makeStringField({ ...options, ui }, this.state);
         },
         min: function (length) {
@@ -44,6 +62,12 @@ function makeStringField(options, state) {
         max: function (length) {
             return makeStringField({ ...options, maxLength: length }, this.state);
         },
+        seo: function (seo) {
+            if (options.ui === "RichText") {
+                throw new Error("RichText fields cannot initialize string SEO fields.");
+            }
+            return makeStringField({ ...options, seo }, this.state);
+        },
     };
     return (0, Field_1.withFieldModifiers)({
         field,

package/dist/cjs/lib/fields/String.js.map

@@ -1 +1 @@
-{"version":3,"file":"String.js","sourceRoot":"","sources":["../../../../src/lib/fields/String.ts"],"names":[],"mappings":";;;;;;AAqFA,kCAEC;AAvFD,8CAAoB;AAEpB,mCAYiB;AACjB,oCAAiC;AACjC,8CAA2C;AAE9B,QAAA,SAAS,GAAG;IACvB,MAAM;IACN,UAAU;IACV,UAAU;IACV,OAAO;IACP,MAAM;IACN,UAAU;IACV,IAAI;IACJ,KAAK;CACG,CAAC;AA0DX,SAAgB,WAAW;IACzB,OAAO,eAAe,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,yBAAiB,CAAC,CAAC;AAC5D,CAAC;AAID,SAAS,eAAe,CACtB,OAA0B,EAC1B,KAAY;IAEZ,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;KACK,CAAC;IAEpC,MAAM,KAAK,GAA+B;QACxC,GAAG,IAAA,mBAAW,EAAC;YACb,IAAI;YACJ,KAAK;YACL,OAAO,EAAE,IAAA,mBAAW,EAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;SACvD,CAAC;QACF,IAAI,EAAE,UAGS,EAAU;YACvB,OAAO,eAAe,CACpB,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,EAClB,IAAI,CAAC,KAA4B,CAClC,CAAC;QACJ,CAAC;QACD,GAAG,EAAE,UAEH,MAAc;YAEd,OAAO,eAAe,CACpB,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,EACjC,IAAI,CAAC,KAA4B,CAClC,CAAC;QACJ,CAAC;QACD,GAAG,EAAE,UAEH,MAAc;YAEd,OAAO,eAAe,CACpB,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,EACjC,IAAI,CAAC,KAA4B,CAClC,CAAC;QACJ,CAAC;KACF,CAAC;IAEF,OAAO,IAAA,0BAAkB,EAAC;QACxB,KAAK;QACL,OAAO,EAAE,CAA+B,SAAoB,EAAE,EAAE,CAC9D,eAAe,CAAC,OAAO,EAAE,SAAS,CAGjC;KACJ,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CACxB,OAA0B;IAE1B,IAAI,OAAO,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;QAC9B,OAAO,aAAC;aACL,MAAM,CAAC,aAAC,CAAC,MAAM,EAAE,EAAE,aAAC,CAAC,OAAO,EAAE,CAEhC,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,GACR,OAAO,CAAC,EAAE,KAAK,OAAO;QACpB,CAAC,CAAC,aAAC,CAAC,KAAK,EAAE;QACX,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,KAAK;YACpB,CAAC,CAAC,aAAC,CAAC,GAAG,EAAE;YACT,CAAC,CAAC,aAAC,CAAC,MAAM,EAAE,CAAC;IAEnB,IAAI,OAAO,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;QACxB,MAAM,GAAG,OAAE,CAAC;IACd,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,OAAO,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC,SAAS,CAAC,iBAAO,CAA0C,CAAC;IAC5E,CAAC;IAED,OAAO,MAA+C,CAAC;AACzD,CAAC"}
+{"version":3,"file":"String.js","sourceRoot":"","sources":["../../../../src/lib/fields/String.ts"],"names":[],"mappings":";;;;;;AA4GA,kCAEC;AA9GD,8CAAoB;AAEpB,mCAYiB;AACjB,oCAAiC;AACjC,8CAA2C;AAE9B,QAAA,SAAS,GAAG;IACvB,MAAM;IACN,UAAU;IACV,UAAU;IACV,OAAO;IACP,MAAM;IACN,UAAU;IACV,IAAI;IACJ,KAAK;CACG,CAAC;AAIE,QAAA,eAAe,GAAG;IAC7B,OAAO;IACP,aAAa;IACb,cAAc;IACd,UAAU;IACV,gBAAgB;IAChB,sBAAsB;IACtB,cAAc;IACd,mBAAmB;IACnB,mBAAmB;IACnB,cAAc;IACd,oBAAoB;IACpB,iBAAiB;CACT,CAAC;AAgEX,SAAgB,WAAW;IACzB,OAAO,eAAe,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,yBAAiB,CAAC,CAAC;AAC5D,CAAC;AAID,SAAS,eAAe,CACtB,OAA0B,EAC1B,KAAY;IAEZ,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,QAAQ;QACd,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,GAAG,EAAE,OAAO,CAAC,GAAG;KACiB,CAAC;IAEpC,MAAM,KAAK,GAA+B;QACxC,GAAG,IAAA,mBAAW,EAAC;YACb,IAAI;YACJ,KAAK;YACL,OAAO,EAAE,IAAA,mBAAW,EAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;SACvD,CAAC;QACF,IAAI,EAAE,UAGS,EAAU;YACvB,IAAI,EAAE,KAAK,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YAED,OAAO,eAAe,CACpB,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,EAClB,IAAI,CAAC,KAA4B,CAClC,CAAC;QACJ,CAAC;QACD,GAAG,EAAE,UAEH,MAAc;YAEd,OAAO,eAAe,CACpB,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,EACjC,IAAI,CAAC,KAA4B,CAClC,CAAC;QACJ,CAAC;QACD,GAAG,EAAE,UAEH,MAAc;YAEd,OAAO,eAAe,CACpB,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,EACjC,IAAI,CAAC,KAA4B,CAClC,CAAC;QACJ,CAAC;QACD,GAAG,EAAE,UAEH,GAAmB;YAEnB,IAAI,OAAO,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;YAC1E,CAAC;YAED,OAAO,eAAe,CACpB,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,EACnB,IAAI,CAAC,KAA4B,CAClC,CAAC;QACJ,CAAC;KACF,CAAC;IAEF,OAAO,IAAA,0BAAkB,EAAC;QACxB,KAAK;QACL,OAAO,EAAE,CAA+B,SAAoB,EAAE,EAAE,CAC9D,eAAe,CAAC,OAAO,EAAE,SAAS,CAGjC;KACJ,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CACxB,OAA0B;IAE1B,IAAI,OAAO,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;QAC9B,OAAO,aAAC;aACL,MAAM,CAAC,aAAC,CAAC,MAAM,EAAE,EAAE,aAAC,CAAC,OAAO,EAAE,CAEhC,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,GACR,OAAO,CAAC,EAAE,KAAK,OAAO;QACpB,CAAC,CAAC,aAAC,CAAC,KAAK,EAAE;QACX,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,KAAK;YACpB,CAAC,CAAC,aAAC,CAAC,GAAG,EAAE;YACT,CAAC,CAAC,aAAC,CAAC,MAAM,EAAE,CAAC;IAEnB,IAAI,OAAO,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;QACxB,MAAM,GAAG,OAAE,CAAC;IACd,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,OAAO,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC,SAAS,CAAC,iBAAO,CAA0C,CAAC;IAC5E,CAAC;IAED,OAAO,MAA+C,CAAC;AACzD,CAAC"}

package/dist/docs/index.md

@@ -110,6 +110,14 @@ blocks and array/list forms. Chain field modifiers such as `.required()`,
 Special manager editors are selected with `.type(...)`, for example `Slug`,
 `RichText`, `Email`, `Password` and `Image`.
 
+Routeable content types can initialize SEO string fields from the document being
+created. Add `.seo('<seoField>')` to a source string field; the argument is
+restricted to string properties of Rakun's built-in SEO model. For example,
+`title: f.string().required().seo('title')` initializes `seo.title` as a dynamic
+data binding to the document's `title`. This only initializes create forms: it
+does not modify existing documents, and editors can change or clear the binding
+before saving.
+
 Date fields support the `Date`, `DateTime` and `Time` manager modes. `Date` and
 `DateTime` persist JavaScript `Date` values; their write schema also accepts the
 ISO datetime strings produced when those values cross JSON and normalizes them

package/dist/esm/api/context.d.ts

@@ -1,4 +1,4 @@
-import { ManagerUserSchema } from "../internal-content-types";
+import { ManagerUserSchema } from "../internal-content-types/index.js";
 export type CookieOptions = {
     httpOnly?: boolean;
     secure?: boolean;

package/dist/esm/api/context.js

@@ -1,6 +1,6 @@
-import { throwAppError } from "../lib/errors";
-import { Logger } from "../lib/Logger";
-import { getUser } from "./utils/getUser";
+import { throwAppError } from "../lib/errors/index.js";
+import { Logger } from "../lib/Logger.js";
+import { getUser } from "./utils/getUser.js";
 export const createRequestContext = async (input) => {
     const ctx = {
         req: {

package/dist/esm/api/hooks/context.d.ts

@@ -1,4 +1,4 @@
-import type { ContentHookContextStorage } from "../../lib/hooks";
+import type { ContentHookContextStorage } from "../../lib/hooks.js";
 export declare function runContentHookContext<T>(context: ContentHookContextStorage, callback: () => T): T;
 export declare function getContentHookContext(): ContentHookContextStorage;
 //# sourceMappingURL=context.d.ts.map

package/dist/esm/api/hooks/runContentHooks.d.ts

@@ -1,7 +1,7 @@
-import type ContentType from "../../lib/ContentType";
-import type { DataFront, DataInput, DataPopulatedWithoutApiOnly, DBOutput, Filter } from "../../lib/types";
-import type { ContentHookContext, ContentHookOperation, ContentHookSurface } from "../../lib/hooks";
-import type { DBMutationOptions, DBService } from "../../orm/dbService";
+import type ContentType from "../../lib/ContentType.js";
+import type { DataFront, DataInput, DataPopulatedWithoutApiOnly, DBOutput, Filter } from "../../lib/types/index.js";
+import type { ContentHookContext, ContentHookOperation, ContentHookSurface } from "../../lib/hooks.js";
+import type { DBMutationOptions, DBService } from "../../orm/dbService.js";
 type HookContextInput<T extends ContentType> = {
     db: DBService;
     contentType: T;

package/dist/esm/api/hooks/runContentHooks.js

@@ -1,4 +1,4 @@
-import { getContentHookContext } from "./context";
+import { getContentHookContext } from "./context.js";
 export const hasContentHooks = (contentType, names) => names.some((name) => !!contentType.hooks?.[name]);
 export const createContentHookContext = ({ db, contentType, operation, surface, options, }) => {
     const stored = getContentHookContext();

package/dist/esm/api/operations/apiEventLog.d.ts

@@ -1,6 +1,6 @@
-import type { EventLogJsonValue } from '../../eventLog';
-import type { RakunRequestContext } from '../context';
-import type { AnyRakunOperation } from './types';
+import type { EventLogJsonValue } from '../../eventLog/index.js';
+import type { RakunRequestContext } from '../context.js';
+import type { AnyRakunOperation } from './types.js';
 export declare const setApiErrorEventData: (ctx: RakunRequestContext | undefined, data: Record<string, EventLogJsonValue>) => void;
 export declare const setApiSuccessEventData: (ctx: RakunRequestContext, data: Record<string, EventLogJsonValue>) => void;
 export type ApiErrorLogInput = {

package/dist/esm/api/operations/apiEventLog.js

@@ -1,6 +1,6 @@
-import { getEventLogService, hasEventLogService } from '../../eventLog';
-import { getAppErrorShape, getAppErrorStatusCode } from '../../lib/errors';
-import { Logger } from '../../lib/Logger';
+import { getEventLogService, hasEventLogService } from '../../eventLog/index.js';
+import { getAppErrorShape, getAppErrorStatusCode } from '../../lib/errors/index.js';
+import { Logger } from '../../lib/Logger.js';
 const loggedApiErrors = new WeakSet();
 const apiErrorEventData = new WeakMap();
 const apiSuccessEventData = new WeakMap();

package/dist/esm/api/operations/catalog.d.ts

@@ -1,4 +1,4 @@
-import type { ApiOperationsOutput } from "../../schemas/manager/apiOperations";
-import { type RakunOperationMap } from "./types";
+import type { ApiOperationsOutput } from "../../schemas/manager/apiOperations.js";
+import { type RakunOperationMap } from "./types.js";
 export declare const createApiOperationCatalog: (operations: RakunOperationMap) => ApiOperationsOutput;
 //# sourceMappingURL=catalog.d.ts.map

package/dist/esm/api/operations/catalog.js

@@ -1,5 +1,5 @@
 import z from "zod";
-import { createOperationPath } from "./types";
+import { createOperationPath } from "./types.js";
 const toJsonSchema = (schema) => z.toJSONSchema(schema, { unrepresentable: "any" });
 export const createApiOperationCatalog = (operations) => Object.entries(operations)
     .map(([name, operation]) => ({

package/dist/esm/api/operations/custom.d.ts

@@ -1,4 +1,4 @@
-import type { RakunOperationMap } from "./types";
+import type { RakunOperationMap } from "./types.js";
 export type RakunOperationNamespace = "manager" | "web" | "unscoped";
 export declare const getCustomApiOperationDefinitions: (namespace?: RakunOperationNamespace) => RakunOperationMap;
 export declare const mergeOperationMaps: <TBase extends RakunOperationMap, TExtra extends RakunOperationMap>(base: TBase, extra: TExtra) => TBase & TExtra;

package/dist/esm/api/operations/custom.js

@@ -1,4 +1,4 @@
-import { getRakunBootstrapOptions } from "../../bootstrapState";
+import { getRakunBootstrapOptions } from "../../bootstrapState.js";
 const filterOperationsByNamespace = (operations, namespace) => {
     if (!namespace) {
         return operations;