@ghentcdh/crouton-api 0.0.1-alpha.1

package/dist/index.d.cts

@@ -0,0 +1,344 @@
+import { OnModuleDestroy, DynamicModule } from '@nestjs/common';
+import { FieldInput, JsonAction, JsonIncludeEntry, CalculatedColumn, JsonActionCondition, SidebarGroupConfig } from '@ghentcdh/crouton-core';
+import { ZodObject, ZodRawShape } from 'zod';
+
+type ResourceProcedureAction = {
+    type?: 'procedure';
+    /** URL segment used in the endpoint: `POST /{route}/procedure/{id}/:recordId` */
+    id: string;
+    /** Human-readable label shown as a button in the table. */
+    label: string;
+    /** HTTP method for the endpoint. Defaults to `"post"`. */
+    method?: string;
+    /** Static data payload merged into the request body by the frontend. */
+    data?: Record<string, unknown>;
+    /** The procedure function to call with (prisma, recordId). */
+    procedure: (prisma: any, recordId: string | number) => Promise<any>;
+    /** Optional condition evaluated per row. Button is hidden when false. */
+    condition?: JsonActionCondition;
+};
+type ResourceLinkAction = {
+    type: 'link';
+    /** Unique identifier for the action. */
+    id: string;
+    /** Human-readable label shown as a button in the table. */
+    label: string;
+    /**
+     * URL pattern to open in a new tab. May contain `{id}` which the frontend
+     * replaces with the record id, e.g. `"/preview/{id}"`.
+     */
+    href: string;
+    /** Optional condition evaluated per row. Button is hidden when false. */
+    condition?: JsonActionCondition;
+};
+type ResourceAction = ResourceProcedureAction | ResourceLinkAction;
+/** Table-level procedure action — no record id is passed to the procedure. */
+type ResourceTableProcedureAction = {
+    type?: 'procedure';
+    id: string;
+    label?: string;
+    icon?: string;
+    tooltip?: string;
+    method?: string;
+    data?: Record<string, unknown>;
+    /** The procedure function called with only prisma (no record id). */
+    procedure: (prisma: any) => Promise<any>;
+};
+type ResourceTableLinkAction = {
+    type: 'link';
+    id: string;
+    label?: string;
+    icon?: string;
+    tooltip?: string;
+    href: string;
+};
+type ResourceTableAction = ResourceTableProcedureAction | ResourceTableLinkAction;
+type CrudOperation = 'findAll' | 'findOne' | 'create' | 'update' | 'upsert' | 'delete';
+type SchemaInput = ZodObject<ZodRawShape> | JsonSchemaInput;
+interface JsonSchemaInput {
+    type: 'object';
+    properties: Record<string, unknown>;
+    required?: string[];
+    additionalProperties?: boolean;
+}
+/** @deprecated Use `JsonSchemaInput` instead — `JsonSchema` clashes with the `@jsonforms/core` type of the same name. */
+type JsonSchema = JsonSchemaInput;
+type WriteOp = 'create' | 'update' | 'upsert' | 'delete';
+type ReadOp = 'findAll' | 'findOne';
+interface WriteHookContext<PRISMACLIENT> {
+    prisma: PRISMACLIENT;
+    op: WriteOp;
+    /** The record id for `update`; `undefined` for `create`/`upsert`. */
+    id?: string | number;
+}
+interface ReadHookContext<PRISMACLIENT> {
+    prisma: PRISMACLIENT;
+    op: ReadOp;
+}
+interface ResourceHooks<PRISMACLIENT = any> {
+    /**
+     * Runs before the data is passed to Prisma for create/update/upsert.
+     * Use this to connect-or-create related entities.
+     */
+    beforeWrite?: (data: any, ctx: WriteHookContext<PRISMACLIENT>) => Promise<any> | any;
+    /**
+     * Runs after Prisma has persisted the record for create/update/delete.
+     * For upsert the op is resolved to `'create'` or `'update'` depending on
+     * whether a matching record existed before the operation.
+     * Receives the persisted record; the return value replaces the response.
+     */
+    afterWrite?: (result: any, ctx: WriteHookContext<PRISMACLIENT>) => Promise<any> | any;
+    /**
+     * Runs on every row returned by findAll / findOne. Use this to
+     * decorate rows with derived fields (e.g. URIs).
+     */
+    afterRead?: (row: any, ctx: ReadHookContext<PRISMACLIENT>) => Promise<any> | any;
+}
+/**
+ * Per-operation descriptor. Use `true` to enable with no schema, or
+ * an object to also attach a schema (request body for write ops, row
+ * projection for read ops). For read operations the schema also drives
+ * the Prisma `select` — nested zod objects/arrays become nested
+ * `select` clauses, which transparently load relations.
+ */
+type OperationDef = true | {
+    schema?: SchemaInput;
+};
+type UpsertOperationDef = {
+    schema?: SchemaInput;
+    upsertOn: string | string[];
+};
+interface ResourceDefinition {
+    findAll?: OperationDef;
+    findOne?: OperationDef;
+    create?: OperationDef;
+    update?: OperationDef;
+    upsert?: UpsertOperationDef;
+    delete?: OperationDef;
+}
+type DefinitionCallback = () => ResourceDefinition;
+type ViewColumnConfig = {
+    id: string;
+    label?: string;
+    sortable?: boolean;
+    searchable?: boolean;
+    fieldInput?: FieldInput;
+};
+type ViewConfig = {
+    json_schema: Record<string, unknown>;
+    ui_schema: Record<string, unknown>;
+    columns: ViewColumnConfig[];
+    defaultSort?: string;
+};
+type ResourceDisplay = {
+    mode: 'page' | 'modal';
+    customComponent: string | null;
+};
+/**
+ * A column whose stored scalar is serialized as `{ value, label }` on read and
+ * normalized back to the scalar on write. Computed at load time from columns
+ * flagged `fieldInput.options.emitObject` that carry an `options.values` list.
+ */
+type ValueLabelColumn = {
+    /** Row field/key to transform. */
+    field: string;
+    values: {
+        value: unknown;
+        label: string;
+    }[];
+};
+type LookupConfig = {
+    /** The primary key field name (used for id-based lookups). */
+    key: string;
+    /**
+     * The field used for text search (`?q=`). When absent, `?q=` is silently ignored.
+     * Derived from the first `showInLookup` column, then first `searchable` column.
+     */
+    label?: string;
+};
+/**
+ * Describes a sub-resource relation exposed as `GET /:id/{childRoute}`.
+ * The parent `findAll` response includes a count for the relation column.
+ */
+type SubResourceConfig = {
+    /** Column id in the parent resource that holds the count, e.g. `"text_author"`. */
+    column: string;
+    /** Prisma relation field name on the parent model, e.g. `"text_author"`. */
+    relation: string;
+    /** Route segment for the sub-resource endpoint, e.g. `"author"`. */
+    childRoute: string;
+    /** Prisma model name of the child, e.g. `"text_author"`. */
+    childModel: string;
+    /** FK field on the child model pointing back to the parent, e.g. `"text_id"`. */
+    foreignKey: string;
+    /** Human-readable name for the child resource. */
+    name?: string;
+    /** Display title for the child resource. */
+    title?: string;
+    /** Primary key field name on the child model. */
+    idField?: string;
+    /** Primary key type on the child model. */
+    idType?: 'string' | 'number';
+    /** View schemas (table/form/view) for the child resource. */
+    views?: Record<string, ViewConfig>;
+    /** Enabled operations on the child resource. */
+    operations?: Partial<Record<'findAll' | 'findOne' | 'create' | 'update' | 'delete', boolean>>;
+    /** Actions declared in the child resource.json (serializable form, no procedure functions). */
+    actions?: JsonAction[];
+    /** Modal width when opening a form for this sub-resource. */
+    modalSize?: 'xs' | 'sm' | 'lg' | 'xl';
+    /** Relations to include when querying this sub-resource. Supports nested includes — see `JsonIncludeEntry`. */
+    include?: JsonIncludeEntry[];
+    /** Calculated columns to compute and merge for each row of this sub-resource. */
+    calculatedColumns?: CalculatedColumn[];
+    /** When true, the relation is included in findOne responses (column is visible in form or view). */
+    includeInFindOne?: boolean;
+    /** Lifecycle hooks for this sub-resource (beforeWrite, afterRead). */
+    hooks?: ResourceHooks;
+    /** Columns serialized as `{ value, label }` on read / unwrapped on write. */
+    valueLabelColumns?: ValueLabelColumn[];
+};
+type ResourceConfig = {
+    name: string;
+    route: string;
+    model: string;
+    tag: string;
+    title?: string;
+    /** Primary key field name on the model. Defaults to `"id"`. */
+    idField?: string;
+    idType?: 'number' | 'string';
+    database?: string;
+    sidebar?: {
+        hide?: boolean;
+        position?: number;
+    };
+    hooks?: ResourceHooks;
+    definition: ResourceDefinition | DefinitionCallback;
+    views?: Record<string, ViewConfig>;
+    lookup?: LookupConfig;
+    subResources?: SubResourceConfig[];
+    calculatedColumns?: CalculatedColumn[];
+    actions?: ResourceAction[];
+    /** Global table-level actions (no record id). Shown as toolbar buttons. */
+    tableActions?: ResourceTableAction[];
+    /** Relations to eagerly include when querying this resource. Supports nested includes — see `JsonIncludeEntry`. */
+    include?: JsonIncludeEntry[];
+    /** Modal width when opening a form for this resource. */
+    modalSize?: 'xs' | 'sm' | 'lg' | 'xl';
+    /** Columns serialized as `{ value, label }` on read / unwrapped on write. */
+    valueLabelColumns?: ValueLabelColumn[];
+    display: ResourceDisplay;
+};
+declare const resolveDefinition: (config: ResourceConfig) => ResourceDefinition;
+declare const isOperationEnabled: (def: ResourceDefinition, op: CrudOperation) => boolean;
+declare const schemaFor: (def: ResourceDefinition, op: CrudOperation) => SchemaInput | undefined;
+declare const upsertOnFor: (def: ResourceDefinition) => string | string[] | undefined;
+
+type DataSourceJsonConfig = {
+    type: string;
+    name: string;
+    default?: boolean;
+};
+type DataSourceEntry = {
+    config: DataSourceJsonConfig;
+    client: any;
+};
+
+declare class DataSourceRegistry implements OnModuleDestroy {
+    private readonly clients;
+    private defaultName;
+    constructor(entries: DataSourceEntry[]);
+    get(name: string): any;
+    getDefault(): any;
+    resolve(database?: string): any;
+    onModuleDestroy(): Promise<void>;
+}
+
+/**
+ * Scan a directory for data-source subdirectories and load their configs + clients.
+ *
+ * Each subdirectory must contain:
+ * - `data-source.json` — config with `name`, `type`, and optional `default`
+ * - `index.ts` (or `.js`) — default export of a PrismaClient instance
+ */
+declare const loadDataSourcesFromDir: (dirPath: string) => Promise<DataSourceEntry[]>;
+
+declare abstract class ResourceConfigLoader {
+    abstract loadAll(): Promise<ResourceConfig[]>;
+    abstract loadByRoute(route: string): Promise<ResourceConfig | undefined>;
+}
+
+type CroutonConfig = {
+    baseUrl: string;
+    /**
+     * Explicit path to the project enum registry (`crouton.enums.json`).
+     * When omitted, the loader walks up from the resources dir to find it.
+     */
+    enumsFile?: string;
+    /**
+     * Sidebar group definitions, keyed by group slug.
+     * Matches `sidebarGroups` in `crouton.json`.
+     * Resources reference a group via `sidebar.group` in their `resource.json`.
+     */
+    sidebarGroups?: Record<string, SidebarGroupConfig>;
+    /**
+     * Application title served to the frontend via `GET /_app/layout`.
+     * Displayed in the admin sidebar header.
+     */
+    title?: string;
+    /**
+     * Whether form fields are saved automatically as the user edits them.
+     * Served to the frontend via `GET /_app/layout`. Defaults to `true`.
+     * Set to `false` to restore explicit Save/Cancel buttons across the app.
+     * Matches `autoSave` in `crouton.json`.
+     */
+    autoSave?: boolean;
+};
+declare class CroutonApiModule {
+    static forResources(configs: ResourceConfig[], dataSources: DataSourceEntry[], loader: ResourceConfigLoader, config: CroutonConfig): DynamicModule;
+    static forResourceDir(dirPath: string, dataSourcesPath: string, config: CroutonConfig): Promise<DynamicModule>;
+    static forLoader(loader: ResourceConfigLoader, configs: ResourceConfig[], dataSources: DataSourceEntry[], config: CroutonConfig): DynamicModule;
+}
+
+/**
+ * Filesystem-driven resource loader.
+ *
+ * Two sources feed the resource registry:
+ *
+ *   1. `<dir>/<name>/resource.json` — declarative configuration
+ *      (route / operations / columns / …).
+ *
+ *   2. `<dir>/<name>/resource.ts` — imperative configuration as a
+ *      plain `ResourceConfig` default export.
+ *
+ * When both exist for the same name, the JSON wins.
+ *
+ * The JSON only carries operation toggles; actual Zod schemas come from
+ * a sibling `schema.ts` (default export). If the JSON lists `columns`,
+ * the loader narrows the Zod schema down to those column ids via
+ * `.pick()` before attaching it to every enabled operation.
+ *
+ * `resource.ts` / `hooks.ts` / `schema.ts` do **not** import from each
+ * other — this loader is the only place that stitches them together.
+ */
+
+declare const loadResourceConfigsFromDir: (dirPath: string, baseUrl?: string, enumsFile?: string) => Promise<ResourceConfig[]>;
+
+declare class FileSystemResourceConfigLoader extends ResourceConfigLoader {
+    private readonly dirPath;
+    private readonly baseUrl?;
+    private readonly enumsFile?;
+    constructor(dirPath: string, baseUrl?: string | undefined, enumsFile?: string | undefined);
+    loadAll(): Promise<ResourceConfig[]>;
+    loadByRoute(route: string): Promise<ResourceConfig | undefined>;
+}
+
+declare class ResourceConfigRegistry {
+    private readonly loader;
+    private configs;
+    constructor(loader: ResourceConfigLoader, initialConfigs: ResourceConfig[]);
+    getAll(): Promise<ResourceConfig[]>;
+    getByRoute(route: string): Promise<ResourceConfig | undefined>;
+}
+
+export { CroutonApiModule, type CrudOperation, type DataSourceEntry, type DataSourceJsonConfig, DataSourceRegistry, type DefinitionCallback, FileSystemResourceConfigLoader, type JsonSchema, type JsonSchemaInput, type LookupConfig, type OperationDef, type ReadHookContext, type ReadOp, type ResourceAction, type ResourceConfig, ResourceConfigLoader, ResourceConfigRegistry, type ResourceDefinition, type ResourceDisplay, type ResourceHooks, type ResourceLinkAction, type ResourceProcedureAction, type ResourceTableAction, type ResourceTableLinkAction, type ResourceTableProcedureAction, type SchemaInput, type SubResourceConfig, type UpsertOperationDef, type ValueLabelColumn, type ViewColumnConfig, type ViewConfig, type WriteHookContext, type WriteOp, isOperationEnabled, loadDataSourcesFromDir, loadResourceConfigsFromDir, resolveDefinition, schemaFor, upsertOnFor };

package/dist/index.d.ts

@@ -0,0 +1,344 @@
+import { OnModuleDestroy, DynamicModule } from '@nestjs/common';
+import { FieldInput, JsonAction, JsonIncludeEntry, CalculatedColumn, JsonActionCondition, SidebarGroupConfig } from '@ghentcdh/crouton-core';
+import { ZodObject, ZodRawShape } from 'zod';
+
+type ResourceProcedureAction = {
+    type?: 'procedure';
+    /** URL segment used in the endpoint: `POST /{route}/procedure/{id}/:recordId` */
+    id: string;
+    /** Human-readable label shown as a button in the table. */
+    label: string;
+    /** HTTP method for the endpoint. Defaults to `"post"`. */
+    method?: string;
+    /** Static data payload merged into the request body by the frontend. */
+    data?: Record<string, unknown>;
+    /** The procedure function to call with (prisma, recordId). */
+    procedure: (prisma: any, recordId: string | number) => Promise<any>;
+    /** Optional condition evaluated per row. Button is hidden when false. */
+    condition?: JsonActionCondition;
+};
+type ResourceLinkAction = {
+    type: 'link';
+    /** Unique identifier for the action. */
+    id: string;
+    /** Human-readable label shown as a button in the table. */
+    label: string;
+    /**
+     * URL pattern to open in a new tab. May contain `{id}` which the frontend
+     * replaces with the record id, e.g. `"/preview/{id}"`.
+     */
+    href: string;
+    /** Optional condition evaluated per row. Button is hidden when false. */
+    condition?: JsonActionCondition;
+};
+type ResourceAction = ResourceProcedureAction | ResourceLinkAction;
+/** Table-level procedure action — no record id is passed to the procedure. */
+type ResourceTableProcedureAction = {
+    type?: 'procedure';
+    id: string;
+    label?: string;
+    icon?: string;
+    tooltip?: string;
+    method?: string;
+    data?: Record<string, unknown>;
+    /** The procedure function called with only prisma (no record id). */
+    procedure: (prisma: any) => Promise<any>;
+};
+type ResourceTableLinkAction = {
+    type: 'link';
+    id: string;
+    label?: string;
+    icon?: string;
+    tooltip?: string;
+    href: string;
+};
+type ResourceTableAction = ResourceTableProcedureAction | ResourceTableLinkAction;
+type CrudOperation = 'findAll' | 'findOne' | 'create' | 'update' | 'upsert' | 'delete';
+type SchemaInput = ZodObject<ZodRawShape> | JsonSchemaInput;
+interface JsonSchemaInput {
+    type: 'object';
+    properties: Record<string, unknown>;
+    required?: string[];
+    additionalProperties?: boolean;
+}
+/** @deprecated Use `JsonSchemaInput` instead — `JsonSchema` clashes with the `@jsonforms/core` type of the same name. */
+type JsonSchema = JsonSchemaInput;
+type WriteOp = 'create' | 'update' | 'upsert' | 'delete';
+type ReadOp = 'findAll' | 'findOne';
+interface WriteHookContext<PRISMACLIENT> {
+    prisma: PRISMACLIENT;
+    op: WriteOp;
+    /** The record id for `update`; `undefined` for `create`/`upsert`. */
+    id?: string | number;
+}
+interface ReadHookContext<PRISMACLIENT> {
+    prisma: PRISMACLIENT;
+    op: ReadOp;
+}
+interface ResourceHooks<PRISMACLIENT = any> {
+    /**
+     * Runs before the data is passed to Prisma for create/update/upsert.
+     * Use this to connect-or-create related entities.
+     */
+    beforeWrite?: (data: any, ctx: WriteHookContext<PRISMACLIENT>) => Promise<any> | any;
+    /**
+     * Runs after Prisma has persisted the record for create/update/delete.
+     * For upsert the op is resolved to `'create'` or `'update'` depending on
+     * whether a matching record existed before the operation.
+     * Receives the persisted record; the return value replaces the response.
+     */
+    afterWrite?: (result: any, ctx: WriteHookContext<PRISMACLIENT>) => Promise<any> | any;
+    /**
+     * Runs on every row returned by findAll / findOne. Use this to
+     * decorate rows with derived fields (e.g. URIs).
+     */
+    afterRead?: (row: any, ctx: ReadHookContext<PRISMACLIENT>) => Promise<any> | any;
+}
+/**
+ * Per-operation descriptor. Use `true` to enable with no schema, or
+ * an object to also attach a schema (request body for write ops, row
+ * projection for read ops). For read operations the schema also drives
+ * the Prisma `select` — nested zod objects/arrays become nested
+ * `select` clauses, which transparently load relations.
+ */
+type OperationDef = true | {
+    schema?: SchemaInput;
+};
+type UpsertOperationDef = {
+    schema?: SchemaInput;
+    upsertOn: string | string[];
+};
+interface ResourceDefinition {
+    findAll?: OperationDef;
+    findOne?: OperationDef;
+    create?: OperationDef;
+    update?: OperationDef;
+    upsert?: UpsertOperationDef;
+    delete?: OperationDef;
+}
+type DefinitionCallback = () => ResourceDefinition;
+type ViewColumnConfig = {
+    id: string;
+    label?: string;
+    sortable?: boolean;
+    searchable?: boolean;
+    fieldInput?: FieldInput;
+};
+type ViewConfig = {
+    json_schema: Record<string, unknown>;
+    ui_schema: Record<string, unknown>;
+    columns: ViewColumnConfig[];
+    defaultSort?: string;
+};
+type ResourceDisplay = {
+    mode: 'page' | 'modal';
+    customComponent: string | null;
+};
+/**
+ * A column whose stored scalar is serialized as `{ value, label }` on read and
+ * normalized back to the scalar on write. Computed at load time from columns
+ * flagged `fieldInput.options.emitObject` that carry an `options.values` list.
+ */
+type ValueLabelColumn = {
+    /** Row field/key to transform. */
+    field: string;
+    values: {
+        value: unknown;
+        label: string;
+    }[];
+};
+type LookupConfig = {
+    /** The primary key field name (used for id-based lookups). */
+    key: string;
+    /**
+     * The field used for text search (`?q=`). When absent, `?q=` is silently ignored.
+     * Derived from the first `showInLookup` column, then first `searchable` column.
+     */
+    label?: string;
+};
+/**
+ * Describes a sub-resource relation exposed as `GET /:id/{childRoute}`.
+ * The parent `findAll` response includes a count for the relation column.
+ */
+type SubResourceConfig = {
+    /** Column id in the parent resource that holds the count, e.g. `"text_author"`. */
+    column: string;
+    /** Prisma relation field name on the parent model, e.g. `"text_author"`. */
+    relation: string;
+    /** Route segment for the sub-resource endpoint, e.g. `"author"`. */
+    childRoute: string;
+    /** Prisma model name of the child, e.g. `"text_author"`. */
+    childModel: string;
+    /** FK field on the child model pointing back to the parent, e.g. `"text_id"`. */
+    foreignKey: string;
+    /** Human-readable name for the child resource. */
+    name?: string;
+    /** Display title for the child resource. */
+    title?: string;
+    /** Primary key field name on the child model. */
+    idField?: string;
+    /** Primary key type on the child model. */
+    idType?: 'string' | 'number';
+    /** View schemas (table/form/view) for the child resource. */
+    views?: Record<string, ViewConfig>;
+    /** Enabled operations on the child resource. */
+    operations?: Partial<Record<'findAll' | 'findOne' | 'create' | 'update' | 'delete', boolean>>;
+    /** Actions declared in the child resource.json (serializable form, no procedure functions). */
+    actions?: JsonAction[];
+    /** Modal width when opening a form for this sub-resource. */
+    modalSize?: 'xs' | 'sm' | 'lg' | 'xl';
+    /** Relations to include when querying this sub-resource. Supports nested includes — see `JsonIncludeEntry`. */
+    include?: JsonIncludeEntry[];
+    /** Calculated columns to compute and merge for each row of this sub-resource. */
+    calculatedColumns?: CalculatedColumn[];
+    /** When true, the relation is included in findOne responses (column is visible in form or view). */
+    includeInFindOne?: boolean;
+    /** Lifecycle hooks for this sub-resource (beforeWrite, afterRead). */
+    hooks?: ResourceHooks;
+    /** Columns serialized as `{ value, label }` on read / unwrapped on write. */
+    valueLabelColumns?: ValueLabelColumn[];
+};
+type ResourceConfig = {
+    name: string;
+    route: string;
+    model: string;
+    tag: string;
+    title?: string;
+    /** Primary key field name on the model. Defaults to `"id"`. */
+    idField?: string;
+    idType?: 'number' | 'string';
+    database?: string;
+    sidebar?: {
+        hide?: boolean;
+        position?: number;
+    };
+    hooks?: ResourceHooks;
+    definition: ResourceDefinition | DefinitionCallback;
+    views?: Record<string, ViewConfig>;
+    lookup?: LookupConfig;
+    subResources?: SubResourceConfig[];
+    calculatedColumns?: CalculatedColumn[];
+    actions?: ResourceAction[];
+    /** Global table-level actions (no record id). Shown as toolbar buttons. */
+    tableActions?: ResourceTableAction[];
+    /** Relations to eagerly include when querying this resource. Supports nested includes — see `JsonIncludeEntry`. */
+    include?: JsonIncludeEntry[];
+    /** Modal width when opening a form for this resource. */
+    modalSize?: 'xs' | 'sm' | 'lg' | 'xl';
+    /** Columns serialized as `{ value, label }` on read / unwrapped on write. */
+    valueLabelColumns?: ValueLabelColumn[];
+    display: ResourceDisplay;
+};
+declare const resolveDefinition: (config: ResourceConfig) => ResourceDefinition;
+declare const isOperationEnabled: (def: ResourceDefinition, op: CrudOperation) => boolean;
+declare const schemaFor: (def: ResourceDefinition, op: CrudOperation) => SchemaInput | undefined;
+declare const upsertOnFor: (def: ResourceDefinition) => string | string[] | undefined;
+
+type DataSourceJsonConfig = {
+    type: string;
+    name: string;
+    default?: boolean;
+};
+type DataSourceEntry = {
+    config: DataSourceJsonConfig;
+    client: any;
+};
+
+declare class DataSourceRegistry implements OnModuleDestroy {
+    private readonly clients;
+    private defaultName;
+    constructor(entries: DataSourceEntry[]);
+    get(name: string): any;
+    getDefault(): any;
+    resolve(database?: string): any;
+    onModuleDestroy(): Promise<void>;
+}
+
+/**
+ * Scan a directory for data-source subdirectories and load their configs + clients.
+ *
+ * Each subdirectory must contain:
+ * - `data-source.json` — config with `name`, `type`, and optional `default`
+ * - `index.ts` (or `.js`) — default export of a PrismaClient instance
+ */
+declare const loadDataSourcesFromDir: (dirPath: string) => Promise<DataSourceEntry[]>;
+
+declare abstract class ResourceConfigLoader {
+    abstract loadAll(): Promise<ResourceConfig[]>;
+    abstract loadByRoute(route: string): Promise<ResourceConfig | undefined>;
+}
+
+type CroutonConfig = {
+    baseUrl: string;
+    /**
+     * Explicit path to the project enum registry (`crouton.enums.json`).
+     * When omitted, the loader walks up from the resources dir to find it.
+     */
+    enumsFile?: string;
+    /**
+     * Sidebar group definitions, keyed by group slug.
+     * Matches `sidebarGroups` in `crouton.json`.
+     * Resources reference a group via `sidebar.group` in their `resource.json`.
+     */
+    sidebarGroups?: Record<string, SidebarGroupConfig>;
+    /**
+     * Application title served to the frontend via `GET /_app/layout`.
+     * Displayed in the admin sidebar header.
+     */
+    title?: string;
+    /**
+     * Whether form fields are saved automatically as the user edits them.
+     * Served to the frontend via `GET /_app/layout`. Defaults to `true`.
+     * Set to `false` to restore explicit Save/Cancel buttons across the app.
+     * Matches `autoSave` in `crouton.json`.
+     */
+    autoSave?: boolean;
+};
+declare class CroutonApiModule {
+    static forResources(configs: ResourceConfig[], dataSources: DataSourceEntry[], loader: ResourceConfigLoader, config: CroutonConfig): DynamicModule;
+    static forResourceDir(dirPath: string, dataSourcesPath: string, config: CroutonConfig): Promise<DynamicModule>;
+    static forLoader(loader: ResourceConfigLoader, configs: ResourceConfig[], dataSources: DataSourceEntry[], config: CroutonConfig): DynamicModule;
+}
+
+/**
+ * Filesystem-driven resource loader.
+ *
+ * Two sources feed the resource registry:
+ *
+ *   1. `<dir>/<name>/resource.json` — declarative configuration
+ *      (route / operations / columns / …).
+ *
+ *   2. `<dir>/<name>/resource.ts` — imperative configuration as a
+ *      plain `ResourceConfig` default export.
+ *
+ * When both exist for the same name, the JSON wins.
+ *
+ * The JSON only carries operation toggles; actual Zod schemas come from
+ * a sibling `schema.ts` (default export). If the JSON lists `columns`,
+ * the loader narrows the Zod schema down to those column ids via
+ * `.pick()` before attaching it to every enabled operation.
+ *
+ * `resource.ts` / `hooks.ts` / `schema.ts` do **not** import from each
+ * other — this loader is the only place that stitches them together.
+ */
+
+declare const loadResourceConfigsFromDir: (dirPath: string, baseUrl?: string, enumsFile?: string) => Promise<ResourceConfig[]>;
+
+declare class FileSystemResourceConfigLoader extends ResourceConfigLoader {
+    private readonly dirPath;
+    private readonly baseUrl?;
+    private readonly enumsFile?;
+    constructor(dirPath: string, baseUrl?: string | undefined, enumsFile?: string | undefined);
+    loadAll(): Promise<ResourceConfig[]>;
+    loadByRoute(route: string): Promise<ResourceConfig | undefined>;
+}
+
+declare class ResourceConfigRegistry {
+    private readonly loader;
+    private configs;
+    constructor(loader: ResourceConfigLoader, initialConfigs: ResourceConfig[]);
+    getAll(): Promise<ResourceConfig[]>;
+    getByRoute(route: string): Promise<ResourceConfig | undefined>;
+}
+
+export { CroutonApiModule, type CrudOperation, type DataSourceEntry, type DataSourceJsonConfig, DataSourceRegistry, type DefinitionCallback, FileSystemResourceConfigLoader, type JsonSchema, type JsonSchemaInput, type LookupConfig, type OperationDef, type ReadHookContext, type ReadOp, type ResourceAction, type ResourceConfig, ResourceConfigLoader, ResourceConfigRegistry, type ResourceDefinition, type ResourceDisplay, type ResourceHooks, type ResourceLinkAction, type ResourceProcedureAction, type ResourceTableAction, type ResourceTableLinkAction, type ResourceTableProcedureAction, type SchemaInput, type SubResourceConfig, type UpsertOperationDef, type ValueLabelColumn, type ViewColumnConfig, type ViewConfig, type WriteHookContext, type WriteOp, isOperationEnabled, loadDataSourcesFromDir, loadResourceConfigsFromDir, resolveDefinition, schemaFor, upsertOnFor };