@dyrected/core 2.5.29 → 2.5.32

package/dist/index.d.cts

@@ -1,16 +1,6 @@
-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 './index-Bp7PDOYG.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 FieldAfterReadHook, q as FieldBeforeChangeHook, r as FieldHook, s as FieldType, t as FileData, u as GlobalAfterChangeHook, v as GlobalAfterReadHook, w as GlobalBeforeChangeHook, x as GlobalBeforeReadHook, H as HookFunction, y as HookRequestContext, z as ImageService, E as PaginatedResult, R as ReadonlyDatabaseAdapter, J as StorageAdapter, K as UploadConfig } from './index-Bp7PDOYG.cjs';
-
-interface SetupPromptConfig {
-    siteName?: string;
-    siteId?: string;
-    apiKey?: string;
-    baseUrl?: string;
-    isSelfHosted?: boolean;
-    existingSite?: boolean;
-}
-declare function generateFreshSetupPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
-declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
+import { D as DyrectedConfig, F as Field, W as WorkflowConfig, A as AuthenticatedUser, a as WorkflowTransition, L as LifecycleEventName, b as LifecycleEvent, C as CollectionConfig, B as BaseDocument, H as HookRequestContext, P as Prettify, I as InferDocShape, S as SystemDocFields, c as AuthDocFields, U as UploadDocFields, G as GlobalConfig } from './index-CdQwnbfh.cjs';
+export { d as AccessFunction, e as AdminConfig, f as AdminDashboardComponentSlots, g as AdminIconName, h as Block, i as CollectionAfterChangeHook, j as CollectionAfterDeleteHook, k as CollectionAfterReadHook, l as CollectionAfterTransitionHook, m as CollectionBeforeChangeHook, n as CollectionBeforeDeleteHook, o as CollectionBeforeReadHook, p as CollectionBeforeTransitionHook, q as CollectionListComponentSlots, r as DatabaseAdapter, s as DynamicOptionItem, t as DynamicOptionsConfig, u as DynamicOptionsResolver, v as DynamicOptionsResolverArgs, w as FieldAfterReadHook, x as FieldBeforeChangeHook, y as FieldHook, z as FieldType, E as FileData, J as GlobalAfterChangeHook, K as GlobalAfterReadHook, M as GlobalBeforeChangeHook, N as GlobalBeforeReadHook, O as HookFunction, Q as ImageService, R as LIFECYCLE_EVENT_NAMES, T as LifecycleEventHandler, V as PaginatedResult, X as ReadonlyDatabaseAdapter, Y as StorageAdapter, Z as UploadConfig, _ as WorkflowMetadata, $ as WorkflowRole, a0 as WorkflowState, a1 as WorkflowTransitionContext } from './index-CdQwnbfh.cjs';
+import 'lucide-react';
 
 /**
  * Normalizes the Dyrected configuration by injecting system fields
@@ -128,6 +118,64 @@ declare function executeFieldBeforeChange(fields: Field[], data: Record<string,
  */
 declare function executeFieldAfterRead(fields: Field[], doc: Record<string, unknown>, user: unknown, db?: unknown): Promise<Record<string, unknown>>;
 
+/**
+ * Generate an OpenAPI 3.0 specification based on the Dyrected configuration.
+ */
+declare function generateOpenApi(config: DyrectedConfig): any;
+
+declare const WORKFLOW_HISTORY_COLLECTION = "__workflow_history";
+declare const LIFECYCLE_EVENTS_COLLECTION = "__lifecycle_events";
+declare function publishingWorkflow(): WorkflowConfig;
+declare function workflowCapabilities(workflow: WorkflowConfig, user?: AuthenticatedUser): Set<string>;
+declare function canViewWorkflowDraft(workflow: WorkflowConfig, user?: AuthenticatedUser): boolean;
+declare function availableWorkflowTransitions(workflow: WorkflowConfig, state: string, user?: AuthenticatedUser): WorkflowTransition[];
+declare function initializeWorkflowDocument(data: Record<string, unknown>, workflow: WorkflowConfig): {
+    __workflow: {
+        state: string;
+        revision: number;
+    };
+};
+declare function materializeWorkflowDocument(doc: BaseDocument, workflow: WorkflowConfig, user?: AuthenticatedUser): BaseDocument | null;
+declare function createLifecycleEvent(args: {
+    name: LifecycleEventName;
+    collection: string;
+    documentId: string;
+    actorId?: string;
+    payload: Record<string, unknown>;
+}): LifecycleEvent;
+declare function dispatchLifecycleEvent(config: DyrectedConfig, event: LifecycleEvent): Promise<void>;
+declare function dispatchPendingLifecycleEvents(config: DyrectedConfig, limit?: number): Promise<number>;
+declare function saveWorkflowDraft(args: {
+    config: DyrectedConfig;
+    collection: CollectionConfig;
+    id: string;
+    originalDoc: BaseDocument;
+    data: Record<string, unknown>;
+    user?: AuthenticatedUser;
+}): Promise<{
+    doc: BaseDocument;
+    event: LifecycleEvent;
+}>;
+declare function createWorkflowDocument(args: {
+    config: DyrectedConfig;
+    collection: CollectionConfig;
+    data: Record<string, unknown>;
+    user?: AuthenticatedUser;
+}): Promise<{
+    doc: BaseDocument;
+    event: LifecycleEvent;
+}>;
+declare function transitionWorkflow(args: {
+    config: DyrectedConfig;
+    collection: CollectionConfig;
+    id: string;
+    transitionName: string;
+    expectedRevision?: number;
+    comment?: string;
+    user?: AuthenticatedUser;
+    req: HookRequestContext;
+}): Promise<BaseDocument>;
+
 /**
  * Define a collection. When called without an explicit type argument, TypeScript
  * automatically infers the document shape from the `fields` array you provide —
@@ -159,7 +207,7 @@ declare function executeFieldAfterRead(fields: Field[], doc: Record<string, unkn
  */
 declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
     id: string;
-} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>, 'fields' | 'auth'> & {
+} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>, "fields" | "auth"> & {
     fields: TFields;
     auth: true;
 }): CollectionConfig<Prettify<{
@@ -167,7 +215,7 @@ declare function defineCollection<const TFields extends Field[]>(config: Omit<Co
 } & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>;
 declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
     id: string;
-} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>, 'fields' | 'upload'> & {
+} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>, "fields" | "upload"> & {
     fields: TFields;
     upload: true;
 }): CollectionConfig<Prettify<{
@@ -175,7 +223,7 @@ declare function defineCollection<const TFields extends Field[]>(config: Omit<Co
 } & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>;
 declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
     id: string;
-} & InferDocShape<TFields> & SystemDocFields>>, 'fields'> & {
+} & InferDocShape<TFields> & SystemDocFields>>, "fields"> & {
     fields: TFields;
 }): CollectionConfig<Prettify<{
     id: string;
@@ -206,7 +254,7 @@ declare function defineCollection<TDoc extends object>(config: CollectionConfig<
  * export const Settings = defineGlobal<SiteSettings>({ ... })
  * ```
  */
-declare function defineGlobal<const TFields extends Field[]>(config: Omit<GlobalConfig<Prettify<InferDocShape<TFields>>>, 'fields'> & {
+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>;
@@ -219,4 +267,4 @@ declare function defineGlobal<TDoc extends object>(config: GlobalConfig<TDoc>):
  */
 declare function defineConfig(config: DyrectedConfig): DyrectedConfig;
 
-export { AuthDocFields, CollectionConfig, DyrectedConfig, Field, GlobalConfig, InferDocShape, Prettify, type SetupPromptConfig, type SortClause, type SortDirection, type SqlWhereResult, SystemDocFields, UploadDocFields, type WhereClause, type WhereOperator, type WhereOperatorName, defineCollection, defineConfig, defineGlobal, executeFieldAfterRead, executeFieldBeforeChange, generateAIPrompt, generateFreshSetupPrompt, normalizeConfig, parseMongoWhere, parseSort, parseSqlWhere, runCollectionHooks };
+export { AuthDocFields, AuthenticatedUser, BaseDocument, CollectionConfig, DyrectedConfig, Field, GlobalConfig, HookRequestContext, InferDocShape, LIFECYCLE_EVENTS_COLLECTION, LifecycleEvent, LifecycleEventName, Prettify, type SortClause, type SortDirection, type SqlWhereResult, SystemDocFields, UploadDocFields, WORKFLOW_HISTORY_COLLECTION, type WhereClause, type WhereOperator, type WhereOperatorName, WorkflowConfig, WorkflowTransition, availableWorkflowTransitions, canViewWorkflowDraft, createLifecycleEvent, createWorkflowDocument, defineCollection, defineConfig, defineGlobal, dispatchLifecycleEvent, dispatchPendingLifecycleEvents, executeFieldAfterRead, executeFieldBeforeChange, generateOpenApi, initializeWorkflowDocument, materializeWorkflowDocument, normalizeConfig, parseMongoWhere, parseSort, parseSqlWhere, publishingWorkflow, runCollectionHooks, saveWorkflowDraft, transitionWorkflow, workflowCapabilities };

package/dist/index.d.ts

@@ -1,16 +1,6 @@
-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 './index-Bp7PDOYG.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 FieldAfterReadHook, q as FieldBeforeChangeHook, r as FieldHook, s as FieldType, t as FileData, u as GlobalAfterChangeHook, v as GlobalAfterReadHook, w as GlobalBeforeChangeHook, x as GlobalBeforeReadHook, H as HookFunction, y as HookRequestContext, z as ImageService, E as PaginatedResult, R as ReadonlyDatabaseAdapter, J as StorageAdapter, K as UploadConfig } from './index-Bp7PDOYG.js';
-
-interface SetupPromptConfig {
-    siteName?: string;
-    siteId?: string;
-    apiKey?: string;
-    baseUrl?: string;
-    isSelfHosted?: boolean;
-    existingSite?: boolean;
-}
-declare function generateFreshSetupPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
-declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
+import { D as DyrectedConfig, F as Field, W as WorkflowConfig, A as AuthenticatedUser, a as WorkflowTransition, L as LifecycleEventName, b as LifecycleEvent, C as CollectionConfig, B as BaseDocument, H as HookRequestContext, P as Prettify, I as InferDocShape, S as SystemDocFields, c as AuthDocFields, U as UploadDocFields, G as GlobalConfig } from './index-CdQwnbfh.js';
+export { d as AccessFunction, e as AdminConfig, f as AdminDashboardComponentSlots, g as AdminIconName, h as Block, i as CollectionAfterChangeHook, j as CollectionAfterDeleteHook, k as CollectionAfterReadHook, l as CollectionAfterTransitionHook, m as CollectionBeforeChangeHook, n as CollectionBeforeDeleteHook, o as CollectionBeforeReadHook, p as CollectionBeforeTransitionHook, q as CollectionListComponentSlots, r as DatabaseAdapter, s as DynamicOptionItem, t as DynamicOptionsConfig, u as DynamicOptionsResolver, v as DynamicOptionsResolverArgs, w as FieldAfterReadHook, x as FieldBeforeChangeHook, y as FieldHook, z as FieldType, E as FileData, J as GlobalAfterChangeHook, K as GlobalAfterReadHook, M as GlobalBeforeChangeHook, N as GlobalBeforeReadHook, O as HookFunction, Q as ImageService, R as LIFECYCLE_EVENT_NAMES, T as LifecycleEventHandler, V as PaginatedResult, X as ReadonlyDatabaseAdapter, Y as StorageAdapter, Z as UploadConfig, _ as WorkflowMetadata, $ as WorkflowRole, a0 as WorkflowState, a1 as WorkflowTransitionContext } from './index-CdQwnbfh.js';
+import 'lucide-react';
 
 /**
  * Normalizes the Dyrected configuration by injecting system fields
@@ -128,6 +118,64 @@ declare function executeFieldBeforeChange(fields: Field[], data: Record<string,
  */
 declare function executeFieldAfterRead(fields: Field[], doc: Record<string, unknown>, user: unknown, db?: unknown): Promise<Record<string, unknown>>;
 
+/**
+ * Generate an OpenAPI 3.0 specification based on the Dyrected configuration.
+ */
+declare function generateOpenApi(config: DyrectedConfig): any;
+
+declare const WORKFLOW_HISTORY_COLLECTION = "__workflow_history";
+declare const LIFECYCLE_EVENTS_COLLECTION = "__lifecycle_events";
+declare function publishingWorkflow(): WorkflowConfig;
+declare function workflowCapabilities(workflow: WorkflowConfig, user?: AuthenticatedUser): Set<string>;
+declare function canViewWorkflowDraft(workflow: WorkflowConfig, user?: AuthenticatedUser): boolean;
+declare function availableWorkflowTransitions(workflow: WorkflowConfig, state: string, user?: AuthenticatedUser): WorkflowTransition[];
+declare function initializeWorkflowDocument(data: Record<string, unknown>, workflow: WorkflowConfig): {
+    __workflow: {
+        state: string;
+        revision: number;
+    };
+};
+declare function materializeWorkflowDocument(doc: BaseDocument, workflow: WorkflowConfig, user?: AuthenticatedUser): BaseDocument | null;
+declare function createLifecycleEvent(args: {
+    name: LifecycleEventName;
+    collection: string;
+    documentId: string;
+    actorId?: string;
+    payload: Record<string, unknown>;
+}): LifecycleEvent;
+declare function dispatchLifecycleEvent(config: DyrectedConfig, event: LifecycleEvent): Promise<void>;
+declare function dispatchPendingLifecycleEvents(config: DyrectedConfig, limit?: number): Promise<number>;
+declare function saveWorkflowDraft(args: {
+    config: DyrectedConfig;
+    collection: CollectionConfig;
+    id: string;
+    originalDoc: BaseDocument;
+    data: Record<string, unknown>;
+    user?: AuthenticatedUser;
+}): Promise<{
+    doc: BaseDocument;
+    event: LifecycleEvent;
+}>;
+declare function createWorkflowDocument(args: {
+    config: DyrectedConfig;
+    collection: CollectionConfig;
+    data: Record<string, unknown>;
+    user?: AuthenticatedUser;
+}): Promise<{
+    doc: BaseDocument;
+    event: LifecycleEvent;
+}>;
+declare function transitionWorkflow(args: {
+    config: DyrectedConfig;
+    collection: CollectionConfig;
+    id: string;
+    transitionName: string;
+    expectedRevision?: number;
+    comment?: string;
+    user?: AuthenticatedUser;
+    req: HookRequestContext;
+}): Promise<BaseDocument>;
+
 /**
  * Define a collection. When called without an explicit type argument, TypeScript
  * automatically infers the document shape from the `fields` array you provide —
@@ -159,7 +207,7 @@ declare function executeFieldAfterRead(fields: Field[], doc: Record<string, unkn
  */
 declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
     id: string;
-} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>, 'fields' | 'auth'> & {
+} & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>, "fields" | "auth"> & {
     fields: TFields;
     auth: true;
 }): CollectionConfig<Prettify<{
@@ -167,7 +215,7 @@ declare function defineCollection<const TFields extends Field[]>(config: Omit<Co
 } & InferDocShape<TFields> & SystemDocFields & AuthDocFields>>;
 declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
     id: string;
-} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>, 'fields' | 'upload'> & {
+} & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>, "fields" | "upload"> & {
     fields: TFields;
     upload: true;
 }): CollectionConfig<Prettify<{
@@ -175,7 +223,7 @@ declare function defineCollection<const TFields extends Field[]>(config: Omit<Co
 } & InferDocShape<TFields> & SystemDocFields & UploadDocFields>>;
 declare function defineCollection<const TFields extends Field[]>(config: Omit<CollectionConfig<Prettify<{
     id: string;
-} & InferDocShape<TFields> & SystemDocFields>>, 'fields'> & {
+} & InferDocShape<TFields> & SystemDocFields>>, "fields"> & {
     fields: TFields;
 }): CollectionConfig<Prettify<{
     id: string;
@@ -206,7 +254,7 @@ declare function defineCollection<TDoc extends object>(config: CollectionConfig<
  * export const Settings = defineGlobal<SiteSettings>({ ... })
  * ```
  */
-declare function defineGlobal<const TFields extends Field[]>(config: Omit<GlobalConfig<Prettify<InferDocShape<TFields>>>, 'fields'> & {
+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>;
@@ -219,4 +267,4 @@ declare function defineGlobal<TDoc extends object>(config: GlobalConfig<TDoc>):
  */
 declare function defineConfig(config: DyrectedConfig): DyrectedConfig;
 
-export { AuthDocFields, CollectionConfig, DyrectedConfig, Field, GlobalConfig, InferDocShape, Prettify, type SetupPromptConfig, type SortClause, type SortDirection, type SqlWhereResult, SystemDocFields, UploadDocFields, type WhereClause, type WhereOperator, type WhereOperatorName, defineCollection, defineConfig, defineGlobal, executeFieldAfterRead, executeFieldBeforeChange, generateAIPrompt, generateFreshSetupPrompt, normalizeConfig, parseMongoWhere, parseSort, parseSqlWhere, runCollectionHooks };
+export { AuthDocFields, AuthenticatedUser, BaseDocument, CollectionConfig, DyrectedConfig, Field, GlobalConfig, HookRequestContext, InferDocShape, LIFECYCLE_EVENTS_COLLECTION, LifecycleEvent, LifecycleEventName, Prettify, type SortClause, type SortDirection, type SqlWhereResult, SystemDocFields, UploadDocFields, WORKFLOW_HISTORY_COLLECTION, type WhereClause, type WhereOperator, type WhereOperatorName, WorkflowConfig, WorkflowTransition, availableWorkflowTransitions, canViewWorkflowDraft, createLifecycleEvent, createWorkflowDocument, defineCollection, defineConfig, defineGlobal, dispatchLifecycleEvent, dispatchPendingLifecycleEvents, executeFieldAfterRead, executeFieldBeforeChange, generateOpenApi, initializeWorkflowDocument, materializeWorkflowDocument, normalizeConfig, parseMongoWhere, parseSort, parseSqlWhere, publishingWorkflow, runCollectionHooks, saveWorkflowDraft, transitionWorkflow, workflowCapabilities };