@forge-cms/runtime 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ForgeCMS contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# @forge-cms/runtime
+
+Runtime orchestrator for ForgeCMS. Binds schema definitions, database/auth/storage adapters, and HTTP handlers into a cohesive CMS runtime.
+
+## Responsibility
+
+- Initialise and wire all adapters
+- Sync database schema from collection definitions
+- Provide CRUD request handlers that validate, authorise, and persist
+- Expose a typed configuration API
+
+## Status
+
+**Early design phase** — contracts and config types are stabilising. No real request handling is implemented yet.

package/dist/access.d.ts

@@ -0,0 +1,30 @@
+import type { AccessArgs, AccessQuery, AccessRule, CmsUser, CollectionDefinition, FieldAccessArgs, FieldAccessRule } from '@forge-cms/core';
+import type { DatabaseWhere } from '@forge-cms/db';
+/**
+ * The outcome of an access check. `allowed: false` denies outright; `allowed: true` with a `where`
+ * grants access only to documents matching it (spec 020).
+ */
+export interface AccessDecision {
+    allowed: boolean;
+    where?: DatabaseWhere;
+}
+/**
+ * Resolves a collection-level access rule.
+ *
+ * An `undefined` rule means "this rule is not configured" — the caller decides the fallback (the
+ * HTTP layer falls back to its route-level `allowedRoles`, the Local API treats it as public).
+ */
+export declare function resolveAccess(rule: AccessRule | undefined, args: AccessArgs): Promise<AccessDecision | undefined>;
+/** AND-merges an access constraint into a user-supplied query. Access conditions always win. */
+export declare function mergeWhere(base: DatabaseWhere | undefined, constraint: DatabaseWhere | undefined): DatabaseWhere | undefined;
+/**
+ * Checks an already-loaded document against an access constraint. Used for update/delete, where the
+ * constraint cannot be pushed into the query because the document is addressed by id.
+ */
+export declare function documentMatches(doc: Record<string, unknown>, where: AccessQuery): boolean;
+/** Resolves a field-level rule. `undefined` means unrestricted. */
+export declare function resolveFieldAccess(rule: FieldAccessRule | undefined, args: FieldAccessArgs): Promise<boolean>;
+/** The role string an access check will see for this user — exported for the HTTP layer's messages. */
+export declare function userRoleOf(user: CmsUser | null): string | undefined;
+export declare function accessArgs(collection: CollectionDefinition, args: Omit<AccessArgs, 'collection'>): AccessArgs;
+//# sourceMappingURL=access.d.ts.map

package/dist/access.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.d.ts","sourceRoot":"","sources":["../src/access.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,UAAU,EACV,OAAO,EACP,oBAAoB,EACpB,eAAe,EACf,eAAe,EAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGnD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAkBD;;;;;GAKG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,UAAU,GAAG,SAAS,EAC5B,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAOrC;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CACxB,IAAI,EAAE,aAAa,GAAG,SAAS,EAC/B,UAAU,EAAE,aAAa,GAAG,SAAS,GACpC,aAAa,GAAG,SAAS,CAI3B;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAEzF;AAED,mEAAmE;AACnE,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,eAAe,GAAG,SAAS,EACjC,IAAI,EAAE,eAAe,GACpB,OAAO,CAAC,OAAO,CAAC,CAIlB;AAED,uGAAuG;AACvG,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAEnE;AAED,wBAAgB,UAAU,CACxB,UAAU,EAAE,oBAAoB,EAChC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,GACnC,UAAU,CAEZ"}

package/dist/access.js

@@ -0,0 +1,64 @@
+import { matchesCondition } from '@forge-cms/db';
+const DENIED = { allowed: false };
+const ALLOWED = { allowed: true };
+function roleOf(user) {
+    if (!user)
+        return undefined;
+    if (typeof user.role === 'string')
+        return user.role;
+    return user.roles?.[0];
+}
+/** `string[]` rules keep their spec-010 meaning: the user's role must appear in the list. */
+function decideByRoles(allowedRoles, user) {
+    const role = roleOf(user);
+    if (role === undefined)
+        return DENIED;
+    return allowedRoles.includes(role) ? ALLOWED : DENIED;
+}
+/**
+ * Resolves a collection-level access rule.
+ *
+ * An `undefined` rule means "this rule is not configured" — the caller decides the fallback (the
+ * HTTP layer falls back to its route-level `allowedRoles`, the Local API treats it as public).
+ */
+export async function resolveAccess(rule, args) {
+    if (rule === undefined)
+        return undefined;
+    if (Array.isArray(rule))
+        return decideByRoles(rule, args.user);
+    const result = await rule(args);
+    if (typeof result === 'boolean')
+        return result ? ALLOWED : DENIED;
+    return { allowed: true, where: result };
+}
+/** AND-merges an access constraint into a user-supplied query. Access conditions always win. */
+export function mergeWhere(base, constraint) {
+    if (!constraint || Object.keys(constraint).length === 0)
+        return base;
+    if (!base || Object.keys(base).length === 0)
+        return constraint;
+    return { ...base, ...constraint };
+}
+/**
+ * Checks an already-loaded document against an access constraint. Used for update/delete, where the
+ * constraint cannot be pushed into the query because the document is addressed by id.
+ */
+export function documentMatches(doc, where) {
+    return Object.entries(where).every(([key, condition]) => matchesCondition(doc[key], condition));
+}
+/** Resolves a field-level rule. `undefined` means unrestricted. */
+export async function resolveFieldAccess(rule, args) {
+    if (rule === undefined)
+        return true;
+    if (Array.isArray(rule))
+        return decideByRoles(rule, args.user).allowed;
+    return rule(args);
+}
+/** The role string an access check will see for this user — exported for the HTTP layer's messages. */
+export function userRoleOf(user) {
+    return roleOf(user);
+}
+export function accessArgs(collection, args) {
+    return { ...args, collection };
+}
+//# sourceMappingURL=access.js.map

package/dist/access.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.js","sourceRoot":"","sources":["../src/access.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAWjD,MAAM,MAAM,GAAmB,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAClD,MAAM,OAAO,GAAmB,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAElD,SAAS,MAAM,CAAC,IAAoB;IAClC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,IAAI,CAAC;IACpD,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AACzB,CAAC;AAED,6FAA6F;AAC7F,SAAS,aAAa,CAAC,YAAsB,EAAE,IAAoB;IACjE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACtC,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;AACxD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,IAA4B,EAC5B,IAAgB;IAEhB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,OAAO,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IAClE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAuB,EAAE,CAAC;AAC3D,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,UAAU,CACxB,IAA+B,EAC/B,UAAqC;IAErC,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACrE,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC;IAC/D,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,EAAE,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,GAA4B,EAAE,KAAkB;IAC9E,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AAClG,CAAC;AAED,mEAAmE;AACnE,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,IAAiC,EACjC,IAAqB;IAErB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACpC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;IACvE,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,UAAU,CAAC,IAAoB;IAC7C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,UAAU,CACxB,UAAgC,EAChC,IAAoC;IAEpC,OAAO,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,20 @@
+import type { CollectionDefinition, GlobalDefinition } from '@forge-cms/core';
+import type { DatabaseAdapter } from '@forge-cms/db';
+import type { AuthAdapter } from '@forge-cms/auth';
+import type { StorageAdapter } from '@forge-cms/storage';
+export interface AdapterSet {
+    database: DatabaseAdapter;
+    auth: AuthAdapter;
+    storage: StorageAdapter;
+}
+export interface ForgeCmsConfig<TEnv = unknown> {
+    /** Schema definitions for all collections */
+    collections: CollectionDefinition[];
+    /** Singleton documents (site-wide config: nav, footer, SEO defaults). */
+    globals?: GlobalDefinition[];
+    /** Adapter instances (must be initialised separately or via runtime.init()) */
+    adapters: AdapterSet;
+    /** Cloudflare/environment bindings passed to adapters */
+    env?: TEnv;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,eAAe,CAAC;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,cAAc,CAAC,IAAI,GAAG,OAAO;IAC5C,6CAA6C;IAC7C,WAAW,EAAE,oBAAoB,EAAE,CAAC;IACpC,yEAAyE;IACzE,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,+EAA+E;IAC/E,QAAQ,EAAE,UAAU,CAAC;IACrB,yDAAyD;IACzD,GAAG,CAAC,EAAE,IAAI,CAAC;CACZ"}

package/dist/config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

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

package/dist/context.d.ts

@@ -0,0 +1,16 @@
+import type { CollectionDefinition, GlobalDefinition } from '@forge-cms/core';
+import type { AdapterSet } from './config.js';
+/**
+ * The slice of `ForgeCmsRuntime` the operations need. Declared structurally rather than importing
+ * the class so `operations.ts` / `populate.ts` never import `runtime.ts` — `runtime.ts` imports
+ * *them*, and `import/no-cycle` is an error in this repo.
+ *
+ * `ForgeCmsRuntime` satisfies this interface structurally; no explicit `implements` is needed.
+ */
+export interface OperationContext {
+    readonly adapters: AdapterSet;
+    getCollection(slug: string): CollectionDefinition | undefined;
+    getGlobal(slug: string): GlobalDefinition | undefined;
+    getCollections(): readonly CollectionDefinition[];
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CAAC;IAC9D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IACtD,cAAc,IAAI,SAAS,oBAAoB,EAAE,CAAC;CACnD"}

package/dist/context.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=context.js.map

package/dist/context.js.map

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

package/dist/defaults.d.ts

@@ -0,0 +1,20 @@
+import type { CollectionDefinition } from '@forge-cms/core';
+/**
+ * The two field options that used to be declared and never read (spec 040, demo finding 1):
+ * `defaultValue` on any field, and `autoGenerate`/`sourceField` on a `slug`.
+ *
+ * Both run at the very start of a write, before `beforeValidate` hooks, so a hook can still override
+ * whatever they produced — and so validation sees the final value.
+ */
+/** Fields whose incoming value is `undefined` take their `defaultValue`. Create only. */
+export declare function applyFieldDefaults(collection: CollectionDefinition, data: Record<string, unknown>): Record<string, unknown>;
+/**
+ * Fills `slug` fields marked `autoGenerate` from their source field, and normalises any slug the
+ * caller did provide.
+ *
+ * Runs on create and update. `existing` is the stored document on update, so renaming nothing but
+ * the title of a document whose slug was auto-generated does **not** silently break its URL — an
+ * existing non-empty slug is kept unless the caller explicitly clears it.
+ */
+export declare function applyAutoSlugs(collection: CollectionDefinition, data: Record<string, unknown>, existing?: Record<string, unknown>): Record<string, unknown>;
+//# sourceMappingURL=defaults.d.ts.map

package/dist/defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../src/defaults.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAoB,MAAM,iBAAiB,CAAC;AAE9E;;;;;;GAMG;AAEH,yFAAyF;AACzF,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,oBAAoB,EAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAYzB;AAKD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,UAAU,EAAE,oBAAoB,EAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAyCzB"}

package/dist/defaults.js

@@ -0,0 +1,73 @@
+import { slugify } from '@forge-cms/core';
+/**
+ * The two field options that used to be declared and never read (spec 040, demo finding 1):
+ * `defaultValue` on any field, and `autoGenerate`/`sourceField` on a `slug`.
+ *
+ * Both run at the very start of a write, before `beforeValidate` hooks, so a hook can still override
+ * whatever they produced — and so validation sees the final value.
+ */
+/** Fields whose incoming value is `undefined` take their `defaultValue`. Create only. */
+export function applyFieldDefaults(collection, data) {
+    let result = data;
+    for (const [name, field] of Object.entries(collection.fields)) {
+        const defaultValue = field.options.defaultValue;
+        if (defaultValue === undefined || result[name] !== undefined)
+            continue;
+        // Copy lazily: most writes set every field they care about and need no new object at all.
+        if (result === data)
+            result = { ...data };
+        result[name] = defaultValue;
+    }
+    return result;
+}
+/** Candidate source fields when a `slug` declares `autoGenerate` without naming one. */
+const IMPLICIT_SLUG_SOURCES = ['title', 'name'];
+/**
+ * Fills `slug` fields marked `autoGenerate` from their source field, and normalises any slug the
+ * caller did provide.
+ *
+ * Runs on create and update. `existing` is the stored document on update, so renaming nothing but
+ * the title of a document whose slug was auto-generated does **not** silently break its URL — an
+ * existing non-empty slug is kept unless the caller explicitly clears it.
+ */
+export function applyAutoSlugs(collection, data, existing) {
+    let result = data;
+    for (const [name, field] of Object.entries(collection.fields)) {
+        if (field.kind !== 'slug')
+            continue;
+        const provided = result[name];
+        const hasProvided = typeof provided === 'string' && provided.trim() !== '';
+        if (hasProvided) {
+            const normalised = slugify(provided);
+            if (normalised !== provided) {
+                if (result === data)
+                    result = { ...data };
+                result[name] = normalised;
+            }
+            continue;
+        }
+        const options = field.options;
+        if (options.autoGenerate !== true)
+            continue;
+        // On update, an untouched field is absent from a partial body — leave the stored slug alone.
+        const clearedExplicitly = provided !== undefined;
+        const storedSlug = existing?.[name];
+        if (!clearedExplicitly && typeof storedSlug === 'string' && storedSlug !== '')
+            continue;
+        const merged = { ...existing, ...result };
+        const sourceNames = options.sourceField ? [options.sourceField] : IMPLICIT_SLUG_SOURCES;
+        const source = sourceNames
+            .map((sourceName) => merged[sourceName])
+            .find((value) => typeof value === 'string' && value.trim() !== '');
+        if (source === undefined)
+            continue;
+        const generated = slugify(source);
+        if (generated === '')
+            continue;
+        if (result === data)
+            result = { ...data };
+        result[name] = generated;
+    }
+    return result;
+}
+//# 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,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAG1C;;;;;;GAMG;AAEH,yFAAyF;AACzF,MAAM,UAAU,kBAAkB,CAChC,UAAgC,EAChC,IAA6B;IAE7B,IAAI,MAAM,GAAG,IAAI,CAAC;IAElB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9D,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;QAChD,IAAI,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS;YAAE,SAAS;QACvE,0FAA0F;QAC1F,IAAI,MAAM,KAAK,IAAI;YAAE,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC;IAC9B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,wFAAwF;AACxF,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,UAAgC,EAChC,IAA6B,EAC7B,QAAkC;IAElC,IAAI,MAAM,GAAG,IAAI,CAAC;IAElB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM;YAAE,SAAS;QAEpC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9B,MAAM,WAAW,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QAE3E,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;YACrC,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,MAAM,KAAK,IAAI;oBAAE,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;gBAC1C,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;YAC5B,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAA2B,CAAC;QAClD,IAAI,OAAO,CAAC,YAAY,KAAK,IAAI;YAAE,SAAS;QAE5C,6FAA6F;QAC7F,MAAM,iBAAiB,GAAG,QAAQ,KAAK,SAAS,CAAC;QACjD,MAAM,UAAU,GAAG,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,iBAAiB,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,EAAE;YAAE,SAAS;QAExF,MAAM,MAAM,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC;QACxF,MAAM,MAAM,GAAG,WAAW;aACvB,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;aACvC,IAAI,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACtF,IAAI,MAAM,KAAK,SAAS;YAAE,SAAS;QAEnC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,SAAS,KAAK,EAAE;YAAE,SAAS;QAE/B,IAAI,MAAM,KAAK,IAAI;YAAE,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAC3B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/describe.d.ts

@@ -0,0 +1,54 @@
+import type { CollectionDefinition, FieldMap, GlobalDefinition } from '@forge-cms/core';
+/** One selectable shape of a `blocks` field. Mirrors `BlockMeta` in `@forge-cms/angular`. */
+export interface BlockDescription {
+    slug: string;
+    label: string;
+    fields: FieldDescription[];
+}
+/**
+ * The client-facing description of a field. Mirrors `FieldMeta` in `@forge-cms/angular` — the admin
+ * UI builds its form from this, so composite fields have to carry their nested structure or the form
+ * has no way to render them.
+ */
+export interface FieldDescription {
+    name: string;
+    kind: string;
+    label: string;
+    required: boolean;
+    options?: string[];
+    relation?: {
+        collection: string;
+        many: boolean;
+    };
+    fields?: FieldDescription[];
+    blocks?: BlockDescription[];
+    minRows?: number;
+    maxRows?: number;
+    localized?: boolean;
+}
+export interface CollectionDescription {
+    slug: string;
+    name: string;
+    description: string;
+    fieldDefinitions: FieldDescription[];
+    /** `true` when the collection has draft/published status. The admin renders a status column. */
+    drafts?: boolean;
+    /** `true` when the collection accepts multipart uploads. The admin offers a file input. */
+    upload?: boolean;
+    /** Supported locales when the collection has localized fields. */
+    locales?: string[];
+}
+export interface GlobalDescription {
+    slug: string;
+    name: string;
+    description: string;
+    fieldDefinitions: FieldDescription[];
+    /** `true` when the global has draft/published status. */
+    drafts?: boolean;
+}
+export declare function describeFields(fields: FieldMap): FieldDescription[];
+export declare function describeCollection(collection: CollectionDefinition): CollectionDescription;
+export declare function describeCollections(collections: readonly CollectionDefinition[]): CollectionDescription[];
+export declare function describeGlobal(global: GlobalDefinition): GlobalDescription;
+export declare function describeGlobals(globals: readonly GlobalDefinition[]): GlobalDescription[];
+//# sourceMappingURL=describe.d.ts.map

package/dist/describe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.d.ts","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAIV,oBAAoB,EACpB,QAAQ,EACR,gBAAgB,EAKjB,MAAM,iBAAiB,CAAC;AAEzB,6FAA6F;AAC7F,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IACjD,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC5B,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;IACrC,gGAAgG;IAChG,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2FAA2F;IAC3F,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;IACrC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAqED,wBAAgB,cAAc,CAAC,MAAM,EAAE,QAAQ,GAAG,gBAAgB,EAAE,CAEnE;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,oBAAoB,GAAG,qBAAqB,CAW1F;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,SAAS,oBAAoB,EAAE,GAC3C,qBAAqB,EAAE,CAEzB;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,CAQ1E;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,SAAS,gBAAgB,EAAE,GAAG,iBAAiB,EAAE,CAEzF"}

package/dist/describe.js

@@ -0,0 +1,88 @@
+/** `durationMinutes` → `Duration minutes`, for fields that declare no explicit label. */
+function humaniseFieldName(name) {
+    const spaced = name.replace(/([a-z0-9])([A-Z])/g, '$1 $2').replace(/[_-]+/g, ' ');
+    return spaced.charAt(0).toUpperCase() + spaced.slice(1).toLowerCase();
+}
+/** `service_categories` → `Service categories`. Slugs are what the admin shows as a title. */
+function humanise(slug) {
+    const spaced = slug.replace(/[_-]+/g, ' ').trim();
+    return spaced.charAt(0).toUpperCase() + spaced.slice(1);
+}
+function describeField(name, field) {
+    const base = {
+        name,
+        kind: field.kind,
+        label: field.options.label ?? humaniseFieldName(name),
+        required: field.options.required ?? false,
+        ...(field.options.localized === true && { localized: true })
+    };
+    switch (field.kind) {
+        case 'select':
+            return { ...base, options: field.options.options };
+        case 'relation': {
+            const options = field.options;
+            return { ...base, relation: { collection: options.collection, many: options.many ?? false } };
+        }
+        case 'upload': {
+            const options = field.options;
+            return { ...base, relation: { collection: options.collection, many: false } };
+        }
+        case 'group':
+            return { ...base, fields: describeFields(field.options.fields) };
+        case 'array': {
+            const options = field.options;
+            return {
+                ...base,
+                fields: describeFields(options.fields),
+                ...(options.minRows !== undefined && { minRows: options.minRows }),
+                ...(options.maxRows !== undefined && { maxRows: options.maxRows })
+            };
+        }
+        case 'blocks': {
+            const options = field.options;
+            return {
+                ...base,
+                blocks: options.blocks.map((block) => ({
+                    slug: block.slug,
+                    label: block.label ?? block.slug,
+                    fields: describeFields(block.fields)
+                })),
+                ...(options.minRows !== undefined && { minRows: options.minRows }),
+                ...(options.maxRows !== undefined && { maxRows: options.maxRows })
+            };
+        }
+        default:
+            return base;
+    }
+}
+export function describeFields(fields) {
+    return Object.entries(fields).map(([name, field]) => describeField(name, field));
+}
+export function describeCollection(collection) {
+    return {
+        slug: collection.slug,
+        name: humanise(collection.slug),
+        description: `Content collection for ${collection.slug}`,
+        fieldDefinitions: describeFields(collection.fields),
+        ...(collection.drafts === true && { drafts: true }),
+        ...(collection.upload === true && { upload: true }),
+        ...(collection.locales !== undefined &&
+            collection.locales.length > 0 && { locales: collection.locales })
+    };
+}
+export function describeCollections(collections) {
+    return collections.map(describeCollection);
+}
+export function describeGlobal(global) {
+    return {
+        slug: global.slug,
+        name: humanise(global.slug),
+        description: `Singleton configuration for ${global.slug}`,
+        fieldDefinitions: describeFields(global.fields),
+        ...(global.drafts === true && { drafts: true })
+    };
+}
+export function describeGlobals(globals) {
+    return globals.map(describeGlobal);
+}
+//# sourceMappingURL=describe.js.map

package/dist/describe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AA6DA,yFAAyF;AACzF,SAAS,iBAAiB,CAAC,IAAY;IACrC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAClF,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;AACxE,CAAC;AAED,8FAA8F;AAC9F,SAAS,QAAQ,CAAC,IAAY;IAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAClD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,KAAe;IAClD,MAAM,IAAI,GAAqB;QAC7B,IAAI;QACJ,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,iBAAiB,CAAC,IAAI,CAAC;QACrD,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,IAAI,KAAK;QACzC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,KAAK,IAAI,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;KAC7D,CAAC;IAEF,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,QAAQ;YACX,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAG,KAAK,CAAC,OAA8B,CAAC,OAAO,EAAE,CAAC;QAE7E,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,OAAO,GAAG,KAAK,CAAC,OAA+B,CAAC;YACtD,OAAO,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QAChG,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,OAAO,GAAG,KAAK,CAAC,OAA6B,CAAC;YACpD,OAAO,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAChF,CAAC;QAED,KAAK,OAAO;YACV,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,cAAc,CAAE,KAAK,CAAC,OAA6B,CAAC,MAAM,CAAC,EAAE,CAAC;QAE1F,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,OAAO,GAAG,KAAK,CAAC,OAA4B,CAAC;YACnD,OAAO;gBACL,GAAG,IAAI;gBACP,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC;gBACtC,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;aACnE,CAAC;QACJ,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,OAAO,GAAG,KAAK,CAAC,OAA6B,CAAC;YACpD,OAAO;gBACL,GAAG,IAAI;gBACP,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACrC,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI;oBAChC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC;iBACrC,CAAC,CAAC;gBACH,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;aACnE,CAAC;QACJ,CAAC;QAED;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAAgB;IAC7C,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAgC;IACjE,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;QAC/B,WAAW,EAAE,0BAA0B,UAAU,CAAC,IAAI,EAAE;QACxD,gBAAgB,EAAE,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC;QACnD,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACnD,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACnD,GAAG,CAAC,UAAU,CAAC,OAAO,KAAK,SAAS;YAClC,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC;KACpE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,WAA4C;IAE5C,OAAO,WAAW,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAAwB;IACrD,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;QAC3B,WAAW,EAAE,+BAA+B,MAAM,CAAC,IAAI,EAAE;QACzD,gBAAgB,EAAE,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC;QAC/C,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;KAChD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAAoC;IAClE,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AACrC,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,39 @@
+import type { ValidationError } from '@forge-cms/core';
+export type ForgeErrorCode = 'NOT_FOUND' | 'INVALID_INPUT' | 'VALIDATION_ERROR' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'UNKNOWN_FIELD' | 'INVALID_QUERY' | 'INTERNAL_ERROR';
+export declare class ForgeError extends Error {
+    readonly status: number;
+    readonly code: ForgeErrorCode;
+    constructor(message: string, status: number, code: ForgeErrorCode);
+}
+export declare class NotFoundError extends ForgeError {
+    constructor(message: string);
+}
+export declare class InvalidInputError extends ForgeError {
+    constructor(message: string);
+}
+export declare class InvalidQueryError extends ForgeError {
+    constructor(message: string);
+}
+export declare class UnknownFieldError extends ForgeError {
+    constructor(message: string);
+}
+export declare class ValidationFailedError extends ForgeError {
+    readonly details: ValidationError[];
+    constructor(details: ValidationError[]);
+}
+export declare class UnauthorizedError extends ForgeError {
+    constructor(message?: string);
+}
+export declare class AccessDeniedError extends ForgeError {
+    constructor(message?: string);
+}
+export declare function isForgeError(err: unknown): err is ForgeError;
+export interface ForgeApiErrorBody {
+    error: {
+        code: ForgeErrorCode;
+        message: string;
+        details?: unknown;
+    };
+}
+export declare function toApiErrorBody(err: ForgeError): ForgeApiErrorBody;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,MAAM,MAAM,cAAc,GACtB,WAAW,GACX,eAAe,GACf,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,eAAe,GACf,eAAe,GACf,gBAAgB,CAAC;AAErB,qBAAa,UAAW,SAAQ,KAAK;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;gBAElB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc;CAMlE;AAED,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,iBAAkB,SAAQ,UAAU;gBACnC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,iBAAkB,SAAQ,UAAU;gBACnC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,iBAAkB,SAAQ,UAAU;gBACnC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,qBAAsB,SAAQ,UAAU;IACnD,QAAQ,CAAC,OAAO,EAAE,eAAe,EAAE,CAAC;gBAExB,OAAO,EAAE,eAAe,EAAE;CAIvC;AAED,qBAAa,iBAAkB,SAAQ,UAAU;gBACnC,OAAO,SAAiB;CAGrC;AAED,qBAAa,iBAAkB,SAAQ,UAAU;gBACnC,OAAO,SAAc;CAGlC;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU,CAE5D;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE;QACL,IAAI,EAAE,cAAc,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,UAAU,GAAG,iBAAiB,CAgBjE"}

package/dist/errors.js

@@ -0,0 +1,68 @@
+export class ForgeError extends Error {
+    status;
+    code;
+    constructor(message, status, code) {
+        super(message);
+        this.name = new.target.name;
+        this.status = status;
+        this.code = code;
+    }
+}
+export class NotFoundError extends ForgeError {
+    constructor(message) {
+        super(message, 404, 'NOT_FOUND');
+    }
+}
+export class InvalidInputError extends ForgeError {
+    constructor(message) {
+        super(message, 400, 'INVALID_INPUT');
+    }
+}
+export class InvalidQueryError extends ForgeError {
+    constructor(message) {
+        super(message, 400, 'INVALID_QUERY');
+    }
+}
+export class UnknownFieldError extends ForgeError {
+    constructor(message) {
+        super(message, 400, 'UNKNOWN_FIELD');
+    }
+}
+export class ValidationFailedError extends ForgeError {
+    details;
+    constructor(details) {
+        super('Document validation failed', 400, 'VALIDATION_ERROR');
+        this.details = details;
+    }
+}
+export class UnauthorizedError extends ForgeError {
+    constructor(message = 'Unauthorized') {
+        super(message, 401, 'UNAUTHORIZED');
+    }
+}
+export class AccessDeniedError extends ForgeError {
+    constructor(message = 'Forbidden') {
+        super(message, 403, 'FORBIDDEN');
+    }
+}
+export function isForgeError(err) {
+    return err instanceof ForgeError;
+}
+export function toApiErrorBody(err) {
+    if (err instanceof ValidationFailedError) {
+        return {
+            error: {
+                code: err.code,
+                message: err.message,
+                details: err.details
+            }
+        };
+    }
+    return {
+        error: {
+            code: err.code,
+            message: err.message
+        }
+    };
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAYA,MAAM,OAAO,UAAW,SAAQ,KAAK;IAC1B,MAAM,CAAS;IACf,IAAI,CAAiB;IAE9B,YAAY,OAAe,EAAE,MAAc,EAAE,IAAoB;QAC/D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;IACnC,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;IACvC,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;IACvC,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;IACvC,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,UAAU;IAC1C,OAAO,CAAoB;IAEpC,YAAY,OAA0B;QACpC,KAAK,CAAC,4BAA4B,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC;QAC7D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C,YAAY,OAAO,GAAG,cAAc;QAClC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAC/C,YAAY,OAAO,GAAG,WAAW;QAC/B,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;IACnC,CAAC;CACF;AAED,MAAM,UAAU,YAAY,CAAC,GAAY;IACvC,OAAO,GAAG,YAAY,UAAU,CAAC;AACnC,CAAC;AAUD,MAAM,UAAU,cAAc,CAAC,GAAe;IAC5C,IAAI,GAAG,YAAY,qBAAqB,EAAE,CAAC;QACzC,OAAO;YACL,KAAK,EAAE;gBACL,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,OAAO,EAAE,GAAG,CAAC,OAAO;aACrB;SACF,CAAC;IACJ,CAAC;IACD,OAAO;QACL,KAAK,EAAE;YACL,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB;KACF,CAAC;AACJ,CAAC"}

package/dist/field-access.d.ts

@@ -0,0 +1,14 @@
+import type { CmsUser, CollectionDefinition } from '@forge-cms/core';
+import type { DatabaseRecord } from '@forge-cms/db';
+export declare class FieldAccessError extends Error {
+    readonly field: string;
+    constructor(field: string);
+}
+/**
+ * Omits fields the user may not read (`field.options.access.read`). A rule can now be a predicate as
+ * well as a role list (spec 020), so resolution is async.
+ */
+export declare function filterReadableFields(record: DatabaseRecord, collection: CollectionDefinition, user: CmsUser | null): Promise<DatabaseRecord>;
+/** Throws {@link FieldAccessError} naming the first field the user may not write. */
+export declare function assertWritableFields(body: Record<string, unknown>, collection: CollectionDefinition, user: CmsUser | null, operation?: 'create' | 'update'): Promise<void>;
+//# sourceMappingURL=field-access.d.ts.map

package/dist/field-access.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-access.d.ts","sourceRoot":"","sources":["../src/field-access.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGpD,qBAAa,gBAAiB,SAAQ,KAAK;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM;gBAAb,KAAK,EAAE,MAAM;CAGnC;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,oBAAoB,EAChC,IAAI,EAAE,OAAO,GAAG,IAAI,GACnB,OAAO,CAAC,cAAc,CAAC,CAiBzB;AAED,qFAAqF;AACrF,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,UAAU,EAAE,oBAAoB,EAChC,IAAI,EAAE,OAAO,GAAG,IAAI,EACpB,SAAS,GAAE,QAAQ,GAAG,QAAmB,GACxC,OAAO,CAAC,IAAI,CAAC,CAcf"}