@dyrected/core 2.5.14 → 2.5.17

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { D as DyrectedConfig, C as CollectionConfig, G as GlobalConfig } from './app-DnX9mNsh.cjs';
-export { A as AccessFunction, a as AdminConfig, B as Block, b as DatabaseAdapter, c as DyrectedContext, F as Field, d as FieldHook, e as FieldType, f as FileData, H as HookFunction, I as ImageService, P as PaginatedResult, S as StorageAdapter, U as UploadConfig, g as createDyrectedApp } from './app-DnX9mNsh.cjs';
+import { D as DyrectedConfig, F as Field, C as CollectionConfig, P as Prettify, I as InferDocShape, S as SystemDocFields, A as AuthDocFields, U as UploadDocFields, G as GlobalConfig } from './app-BElen1tP.cjs';
+export { a as AccessFunction, b as AdminConfig, c as AuthenticatedUser, B as BaseDocument, d as Block, e as CollectionAfterChangeHook, f as CollectionAfterDeleteHook, g as CollectionAfterReadHook, h as CollectionBeforeChangeHook, i as CollectionBeforeDeleteHook, j as CollectionBeforeReadHook, k as DatabaseAdapter, l as DynamicOptionItem, m as DynamicOptionsConfig, n as DynamicOptionsResolver, o as DynamicOptionsResolverArgs, p as DyrectedContext, q as FieldAfterReadHook, r as FieldBeforeChangeHook, s as FieldHook, t as FieldType, u as FileData, v as GlobalAfterChangeHook, w as GlobalAfterReadHook, x as GlobalBeforeChangeHook, y as GlobalBeforeReadHook, H as HookFunction, z as HookRequestContext, E as ImageService, J as PaginatedResult, K as StorageAdapter, L as UploadConfig, M as createDyrectedApp } from './app-BElen1tP.cjs';
 import 'hono/types';
 import 'hono';
 
@@ -84,17 +84,133 @@ declare function parseSqlWhere(where: WhereClause, getJsonField: (field: string)
  */
 declare function parseMongoWhere(where: WhereClause): Record<string, any>;
 
+type AnyHookFn = (args: any) => any;
 /**
- * Define a collection configuration with full type safety.
+ * Run a list of hook functions sequentially.
+ *
+ * Each hook receives the output of the previous hook merged back into the
+ * original `args`. When a hook returns a non-undefined value it becomes the
+ * `data` / `doc` for the next hook in the chain.
+ *
+ * Pass `{ isolated: true }` for hooks that run **after** a DB write has already
+ * been committed (`afterChange`, `afterDelete`). In isolated mode each hook is
+ * wrapped in a try/catch so a failing side-effect (email, webhook, etc.) never
+ * surfaces as an HTTP 500 to the caller — the write already succeeded.
+ */
+declare function runCollectionHooks(hooks: AnyHookFn[] | undefined, args: {
+    data?: unknown;
+    doc?: unknown;
+    user?: unknown;
+    req?: unknown;
+    operation?: "create" | "update" | "delete";
+    [key: string]: unknown;
+}, options?: {
+    isolated?: boolean;
+}): Promise<any>;
+/**
+ * Execute field-level `beforeChange` hooks recursively on a data payload.
+ *
+ * Traverses `array`, `object`, and `blocks` fields depth-first so that nested
+ * field hooks fire on every item automatically.
+ */
+declare function executeFieldBeforeChange(fields: Field[], data: Record<string, unknown>, originalDoc: Record<string, unknown> | null, user: unknown): Promise<Record<string, unknown>>;
+/**
+ * Execute field-level `afterRead` hooks recursively on a document.
+ *
+ * Traverses `array`, `object`, and `blocks` fields depth-first so that nested
+ * field hooks fire on every item automatically.
+ */
+declare function executeFieldAfterRead(fields: Field[], doc: Record<string, unknown>, user: unknown): Promise<Record<string, unknown>>;
+
+/**
+ * Define a collection. When called without an explicit type argument, TypeScript
+ * automatically infers the document shape from the `fields` array you provide —
+ * no manual interface required:
+ *
+ * ```ts
+ * export const Posts = defineCollection({
+ *   slug: 'posts',
+ *   fields: [
+ *     { name: 'title', type: 'text', required: true },
+ *     { name: 'status', type: 'select', options: ['draft', 'published'], required: true },
+ *   ],
+ *   hooks: {
+ *     beforeChange: [({ data }) => {
+ *       // data is { title: string; status: 'draft' | 'published' } — fully inferred
+ *     }],
+ *   },
+ * })
+ * ```
+ *
+ * When you need a richer interface (e.g. with methods, JSDoc, or types that
+ * can't be derived from fields), pass it explicitly:
+ *
+ * ```ts
+ * interface Post { id: string; title: string; status: 'draft' | 'published' }
+ *
+ * export const Posts = defineCollection<Post>({ ... })
+ * ```
  */
-declare function defineCollection(config: CollectionConfig): CollectionConfig;
+declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>, 'fields' | 'auth'> & {
+    fields: TFields;
+    auth: true;
+}): CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>;
+declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>, 'fields' | 'upload'> & {
+    fields: TFields;
+    upload: true;
+}): CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>;
+declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields>>, 'fields'> & {
+    fields: TFields;
+}): CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields>>;
+declare function defineCollection<TDoc extends object>(config: CollectionConfig<TDoc>): CollectionConfig<TDoc>;
 /**
- * Define a global configuration with full type safety.
+ * Define a global (singleton document). TypeScript automatically infers the
+ * document shape from the `fields` array, or you can pass an explicit type:
+ *
+ * ```ts
+ * // Inferred — no interface needed
+ * export const Settings = defineGlobal({
+ *   slug: 'site-settings',
+ *   fields: [
+ *     { name: 'siteName', type: 'text', required: true },
+ *     { name: 'maintenanceMode', type: 'boolean' },
+ *   ],
+ *   hooks: {
+ *     afterChange: [({ doc }) => {
+ *       // doc.siteName is string, doc.maintenanceMode is boolean | undefined
+ *       if (doc.maintenanceMode) alertOnCall()
+ *     }],
+ *   },
+ * })
+ *
+ * // Explicit type
+ * interface SiteSettings { siteName: string; maintenanceMode?: boolean }
+ * export const Settings = defineGlobal<SiteSettings>({ ... })
+ * ```
  */
-declare function defineGlobal(config: GlobalConfig): GlobalConfig;
+declare function defineGlobal<const TFields extends Field[]>(config: Omit<GlobalConfig<Prettify<InferDocShape<TFields>>>, 'fields'> & {
+    fields: TFields;
+}): GlobalConfig<Prettify<InferDocShape<TFields>>>;
+declare function defineGlobal<TDoc extends object>(config: GlobalConfig<TDoc>): GlobalConfig<TDoc>;
 /**
- * Define the main Dyrected configuration.
+ * Define the root Dyrected configuration.
+ *
+ * This is the single object passed to `createDyrectedApp`. It wires together
+ * the database adapter, collections, globals, storage, email, and all other
+ * server-level configuration.
  */
 declare function defineConfig(config: DyrectedConfig): DyrectedConfig;
 
-export { CollectionConfig, DyrectedConfig, GlobalConfig, type SetupPromptConfig, type SqlWhereResult, type WhereClause, type WhereOperator, type WhereOperatorName, defineCollection, defineConfig, defineGlobal, generateAIPrompt, generateFreshSetupPrompt, normalizeConfig, parseMongoWhere, parseSqlWhere };
+export { AuthDocFields, CollectionConfig, DyrectedConfig, Field, GlobalConfig, InferDocShape, Prettify, type SetupPromptConfig, type SqlWhereResult, SystemDocFields, UploadDocFields, type WhereClause, type WhereOperator, type WhereOperatorName, defineCollection, defineConfig, defineGlobal, executeFieldAfterRead, executeFieldBeforeChange, generateAIPrompt, generateFreshSetupPrompt, normalizeConfig, parseMongoWhere, parseSqlWhere, runCollectionHooks };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { D as DyrectedConfig, C as CollectionConfig, G as GlobalConfig } from './app-DnX9mNsh.js';
-export { A as AccessFunction, a as AdminConfig, B as Block, b as DatabaseAdapter, c as DyrectedContext, F as Field, d as FieldHook, e as FieldType, f as FileData, H as HookFunction, I as ImageService, P as PaginatedResult, S as StorageAdapter, U as UploadConfig, g as createDyrectedApp } from './app-DnX9mNsh.js';
+import { D as DyrectedConfig, F as Field, C as CollectionConfig, P as Prettify, I as InferDocShape, S as SystemDocFields, A as AuthDocFields, U as UploadDocFields, G as GlobalConfig } from './app-BElen1tP.js';
+export { a as AccessFunction, b as AdminConfig, c as AuthenticatedUser, B as BaseDocument, d as Block, e as CollectionAfterChangeHook, f as CollectionAfterDeleteHook, g as CollectionAfterReadHook, h as CollectionBeforeChangeHook, i as CollectionBeforeDeleteHook, j as CollectionBeforeReadHook, k as DatabaseAdapter, l as DynamicOptionItem, m as DynamicOptionsConfig, n as DynamicOptionsResolver, o as DynamicOptionsResolverArgs, p as DyrectedContext, q as FieldAfterReadHook, r as FieldBeforeChangeHook, s as FieldHook, t as FieldType, u as FileData, v as GlobalAfterChangeHook, w as GlobalAfterReadHook, x as GlobalBeforeChangeHook, y as GlobalBeforeReadHook, H as HookFunction, z as HookRequestContext, E as ImageService, J as PaginatedResult, K as StorageAdapter, L as UploadConfig, M as createDyrectedApp } from './app-BElen1tP.js';
 import 'hono/types';
 import 'hono';
 
@@ -84,17 +84,133 @@ declare function parseSqlWhere(where: WhereClause, getJsonField: (field: string)
  */
 declare function parseMongoWhere(where: WhereClause): Record<string, any>;
 
+type AnyHookFn = (args: any) => any;
 /**
- * Define a collection configuration with full type safety.
+ * Run a list of hook functions sequentially.
+ *
+ * Each hook receives the output of the previous hook merged back into the
+ * original `args`. When a hook returns a non-undefined value it becomes the
+ * `data` / `doc` for the next hook in the chain.
+ *
+ * Pass `{ isolated: true }` for hooks that run **after** a DB write has already
+ * been committed (`afterChange`, `afterDelete`). In isolated mode each hook is
+ * wrapped in a try/catch so a failing side-effect (email, webhook, etc.) never
+ * surfaces as an HTTP 500 to the caller — the write already succeeded.
+ */
+declare function runCollectionHooks(hooks: AnyHookFn[] | undefined, args: {
+    data?: unknown;
+    doc?: unknown;
+    user?: unknown;
+    req?: unknown;
+    operation?: "create" | "update" | "delete";
+    [key: string]: unknown;
+}, options?: {
+    isolated?: boolean;
+}): Promise<any>;
+/**
+ * Execute field-level `beforeChange` hooks recursively on a data payload.
+ *
+ * Traverses `array`, `object`, and `blocks` fields depth-first so that nested
+ * field hooks fire on every item automatically.
+ */
+declare function executeFieldBeforeChange(fields: Field[], data: Record<string, unknown>, originalDoc: Record<string, unknown> | null, user: unknown): Promise<Record<string, unknown>>;
+/**
+ * Execute field-level `afterRead` hooks recursively on a document.
+ *
+ * Traverses `array`, `object`, and `blocks` fields depth-first so that nested
+ * field hooks fire on every item automatically.
+ */
+declare function executeFieldAfterRead(fields: Field[], doc: Record<string, unknown>, user: unknown): Promise<Record<string, unknown>>;
+
+/**
+ * Define a collection. When called without an explicit type argument, TypeScript
+ * automatically infers the document shape from the `fields` array you provide —
+ * no manual interface required:
+ *
+ * ```ts
+ * export const Posts = defineCollection({
+ *   slug: 'posts',
+ *   fields: [
+ *     { name: 'title', type: 'text', required: true },
+ *     { name: 'status', type: 'select', options: ['draft', 'published'], required: true },
+ *   ],
+ *   hooks: {
+ *     beforeChange: [({ data }) => {
+ *       // data is { title: string; status: 'draft' | 'published' } — fully inferred
+ *     }],
+ *   },
+ * })
+ * ```
+ *
+ * When you need a richer interface (e.g. with methods, JSDoc, or types that
+ * can't be derived from fields), pass it explicitly:
+ *
+ * ```ts
+ * interface Post { id: string; title: string; status: 'draft' | 'published' }
+ *
+ * export const Posts = defineCollection<Post>({ ... })
+ * ```
  */
-declare function defineCollection(config: CollectionConfig): CollectionConfig;
+declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>, 'fields' | 'auth'> & {
+    fields: TFields;
+    auth: true;
+}): CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>;
+declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>, 'fields' | 'upload'> & {
+    fields: TFields;
+    upload: true;
+}): CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>;
+declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields>>, 'fields'> & {
+    fields: TFields;
+}): CollectionConfig<Prettify<{
+    id: string;
+} & InferDocShape<TFields> & SystemDocFields>>;
+declare function defineCollection<TDoc extends object>(config: CollectionConfig<TDoc>): CollectionConfig<TDoc>;
 /**
- * Define a global configuration with full type safety.
+ * Define a global (singleton document). TypeScript automatically infers the
+ * document shape from the `fields` array, or you can pass an explicit type:
+ *
+ * ```ts
+ * // Inferred — no interface needed
+ * export const Settings = defineGlobal({
+ *   slug: 'site-settings',
+ *   fields: [
+ *     { name: 'siteName', type: 'text', required: true },
+ *     { name: 'maintenanceMode', type: 'boolean' },
+ *   ],
+ *   hooks: {
+ *     afterChange: [({ doc }) => {
+ *       // doc.siteName is string, doc.maintenanceMode is boolean | undefined
+ *       if (doc.maintenanceMode) alertOnCall()
+ *     }],
+ *   },
+ * })
+ *
+ * // Explicit type
+ * interface SiteSettings { siteName: string; maintenanceMode?: boolean }
+ * export const Settings = defineGlobal<SiteSettings>({ ... })
+ * ```
  */
-declare function defineGlobal(config: GlobalConfig): GlobalConfig;
+declare function defineGlobal<const TFields extends Field[]>(config: Omit<GlobalConfig<Prettify<InferDocShape<TFields>>>, 'fields'> & {
+    fields: TFields;
+}): GlobalConfig<Prettify<InferDocShape<TFields>>>;
+declare function defineGlobal<TDoc extends object>(config: GlobalConfig<TDoc>): GlobalConfig<TDoc>;
 /**
- * Define the main Dyrected configuration.
+ * Define the root Dyrected configuration.
+ *
+ * This is the single object passed to `createDyrectedApp`. It wires together
+ * the database adapter, collections, globals, storage, email, and all other
+ * server-level configuration.
  */
 declare function defineConfig(config: DyrectedConfig): DyrectedConfig;
 
-export { CollectionConfig, DyrectedConfig, GlobalConfig, type SetupPromptConfig, type SqlWhereResult, type WhereClause, type WhereOperator, type WhereOperatorName, defineCollection, defineConfig, defineGlobal, generateAIPrompt, generateFreshSetupPrompt, normalizeConfig, parseMongoWhere, parseSqlWhere };
+export { AuthDocFields, CollectionConfig, DyrectedConfig, Field, GlobalConfig, InferDocShape, Prettify, type SetupPromptConfig, type SqlWhereResult, SystemDocFields, UploadDocFields, type WhereClause, type WhereOperator, type WhereOperatorName, defineCollection, defineConfig, defineGlobal, executeFieldAfterRead, executeFieldBeforeChange, generateAIPrompt, generateFreshSetupPrompt, normalizeConfig, parseMongoWhere, parseSqlWhere, runCollectionHooks };

package/dist/index.js

@@ -1,7 +1,10 @@
 import {
   createDyrectedApp,
-  normalizeConfig
-} from "./chunk-JJN4J5NS.js";
+  executeFieldAfterRead,
+  executeFieldBeforeChange,
+  normalizeConfig,
+  runCollectionHooks
+} from "./chunk-YNJ3YC4N.js";
 
 // src/utils/setup-prompt.ts
 function buildEnvironmentSection(frameworkLabel, isSelfHosted, config) {
@@ -996,9 +999,12 @@ export {
   defineCollection,
   defineConfig,
   defineGlobal,
+  executeFieldAfterRead,
+  executeFieldBeforeChange,
   generateAIPrompt,
   generateFreshSetupPrompt,
   normalizeConfig,
   parseMongoWhere,
-  parseSqlWhere
+  parseSqlWhere,
+  runCollectionHooks
 };