@decaf-ts/core 0.18.0 → 0.19.0

package/lib/types/overrides/Metadata.d.cts

@@ -0,0 +1,22 @@
+import "@decaf-ts/decoration";
+import type { Model } from "@decaf-ts/decorator-validation";
+import { OperationKeys } from "@decaf-ts/db-decorators";
+import type { Adapter } from "../persistence/index.cjs";
+import type { Constructor } from "@decaf-ts/decoration";
+import type { ExtendedRelationsMetadata } from "../model/index.cjs";
+import { Context } from "../persistence/Context.cjs";
+import type { AdapterFlags } from "../persistence/types.cjs";
+import { TaskHandler } from "../tasks/TaskHandler.cjs";
+import { Migration } from "../migrations/types.cjs";
+declare module "@decaf-ts/decoration" {
+    namespace Metadata {
+        function tasks(): Record<string, Constructor<TaskHandler<any, any>>> | undefined;
+        function taskHandlerFor(type: string): Constructor<TaskHandler<any, any>> | undefined;
+        function validationExceptions<M extends Model>(model: Constructor<M>, op: OperationKeys): string[];
+        function migrationsFor<A extends Adapter<CONF, CONN, QUERY, CONTEXT>, CONF, CONN, QUERY, FLAGS extends AdapterFlags = AdapterFlags, CONTEXT extends Context<FLAGS> = Context<FLAGS>>(adapter?: A): Constructor<Migration<any, A>>[];
+        function migrations(): [string, Constructor<Migration<any, any>>][];
+        function relations<M extends Model>(m: Constructor<M>): string[] | undefined;
+        function relations<M extends Model>(m: Constructor<M>, prop: keyof M): ExtendedRelationsMetadata;
+        function relations<M extends Model>(m: Constructor<M>, prop?: keyof M): string[] | ExtendedRelationsMetadata | undefined;
+    }
+}

package/lib/types/overrides/Metadata.d.mts

@@ -0,0 +1,22 @@
+import "@decaf-ts/decoration";
+import type { Model } from "@decaf-ts/decorator-validation";
+import { OperationKeys } from "@decaf-ts/db-decorators";
+import type { Adapter } from "../persistence/index.js";
+import type { Constructor } from "@decaf-ts/decoration";
+import type { ExtendedRelationsMetadata } from "../model/index.js";
+import { Context } from "../persistence/Context.js";
+import type { AdapterFlags } from "../persistence/types.js";
+import { TaskHandler } from "../tasks/TaskHandler.js";
+import { Migration } from "../migrations/types.js";
+declare module "@decaf-ts/decoration" {
+    namespace Metadata {
+        function tasks(): Record<string, Constructor<TaskHandler<any, any>>> | undefined;
+        function taskHandlerFor(type: string): Constructor<TaskHandler<any, any>> | undefined;
+        function validationExceptions<M extends Model>(model: Constructor<M>, op: OperationKeys): string[];
+        function migrationsFor<A extends Adapter<CONF, CONN, QUERY, CONTEXT>, CONF, CONN, QUERY, FLAGS extends AdapterFlags = AdapterFlags, CONTEXT extends Context<FLAGS> = Context<FLAGS>>(adapter?: A): Constructor<Migration<any, A>>[];
+        function migrations(): [string, Constructor<Migration<any, any>>][];
+        function relations<M extends Model>(m: Constructor<M>): string[] | undefined;
+        function relations<M extends Model>(m: Constructor<M>, prop: keyof M): ExtendedRelationsMetadata;
+        function relations<M extends Model>(m: Constructor<M>, prop?: keyof M): string[] | ExtendedRelationsMetadata | undefined;
+    }
+}

package/lib/types/overrides/Model.d.cts

@@ -0,0 +1,94 @@
+import { Constructor } from "@decaf-ts/decoration";
+import { OperationKeys } from "@decaf-ts/db-decorators";
+import "@decaf-ts/decorator-validation";
+import { ModelErrorDefinition } from "@decaf-ts/decorator-validation";
+import { SequenceOptions } from "../interfaces/SequenceOptions.cjs";
+import type { ExtendedRelationsMetadata } from "../model/types.cjs";
+import { IndexMetadata } from "../repository/types.cjs";
+declare module "@decaf-ts/decorator-validation" {
+    namespace Model {
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @param {string[]} existingRelations - Optional parameter, the existing relations to be included.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function nestedRelations<M extends Model>(model: Constructor<M> | M, existingRelations?: string[]): string[];
+        function fromTable<M extends Model>(tableName: string): Constructor<M>;
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function relations<M extends Model>(m: Constructor<M> | M): string[];
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function relations<M extends Model>(m: Constructor<M> | M, prop: keyof M): ExtendedRelationsMetadata;
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function generated<M extends Model>(m: Constructor<M> | M, prop: keyof M): boolean;
+        function createdBy<M extends Model>(m: Constructor<M> | M): keyof M;
+        function updatedBy<M extends Model>(m: Constructor<M> | M): keyof M;
+        function defaultQueryAttributes<M extends Model>(m: Constructor<M> | M, useDefault?: boolean): string[];
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function relations<M extends Model>(m: Constructor<M> | M, prop?: keyof M): string[] | ExtendedRelationsMetadata;
+        /**
+         * @description Gets all indexes defined on a model.
+         * @summary Retrieves all index metadata from a model's property decorators.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {Record<string, Record<string, IndexMetadata>>} A nested record of property names to index metadata.
+         */
+        function indexes<M extends Model>(model: M | Constructor<M>): Record<string, Record<string, IndexMetadata>>;
+        /**
+         * @description Gets sequence options for a model's primary key.
+         * @summary Retrieves the sequence configuration for a model's primary key from metadata.
+         * @template M - The model type that extends Model.
+         * @param {M} model - The model instance.
+         * @return {SequenceOptions} The sequence options for the model's primary key.
+         * @throws {InternalError} If no sequence options are defined for the model.
+         */
+        function sequenceFor<M extends Model<boolean>>(model: Constructor<M> | M, property?: keyof M): SequenceOptions;
+        /**
+         * @description Generates a sequence name for a model
+         * @summary Creates a standardized sequence name by combining the table name with additional arguments
+         * @template M - Type that extends Model
+         * @param {M | Constructor<M>} model - The model instance or constructor to generate the sequence name for
+         * @param {...string} args - Additional string arguments to append to the sequence name
+         * @return {string} The generated sequence name
+         */
+        function sequenceName<M extends Model>(model: M | Constructor<M>, ...args: string[]): string;
+        /**
+         * @description Gets the table name for a model
+         * @summary Retrieves the table name associated with a model by checking metadata or falling back to the constructor name
+         * @template M - Type that extends Model
+         * @param {M | Constructor<M>} model - The model instance or constructor to get the table name for
+         * @return {string} The table name for the model
+         */
+        function tableName<M extends Model<boolean>>(model: Constructor<M> | M): string;
+        function columnName<M extends Model<boolean>>(model: Constructor<M> | M, prop: keyof M): string;
+        function nonValidatableFor<M extends Model<boolean>>(m: Constructor<M> | M, op: OperationKeys.CREATE | OperationKeys.UPDATE | string): string[];
+        function validateOn<M extends Model<boolean>>(m: Constructor<M> | M, op: OperationKeys.CREATE | OperationKeys): M extends Model<true> ? Promise<ModelErrorDefinition | undefined> : ModelErrorDefinition | undefined;
+        function generatedBySequence<M extends Model>(model: M | Constructor<M>, prop?: keyof M): boolean;
+    }
+}

package/lib/types/overrides/Model.d.mts

@@ -0,0 +1,94 @@
+import { Constructor } from "@decaf-ts/decoration";
+import { OperationKeys } from "@decaf-ts/db-decorators";
+import "@decaf-ts/decorator-validation";
+import { ModelErrorDefinition } from "@decaf-ts/decorator-validation";
+import { SequenceOptions } from "../interfaces/SequenceOptions.js";
+import type { ExtendedRelationsMetadata } from "../model/types.js";
+import { IndexMetadata } from "../repository/types.js";
+declare module "@decaf-ts/decorator-validation" {
+    namespace Model {
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @param {string[]} existingRelations - Optional parameter, the existing relations to be included.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function nestedRelations<M extends Model>(model: Constructor<M> | M, existingRelations?: string[]): string[];
+        function fromTable<M extends Model>(tableName: string): Constructor<M>;
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function relations<M extends Model>(m: Constructor<M> | M): string[];
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function relations<M extends Model>(m: Constructor<M> | M, prop: keyof M): ExtendedRelationsMetadata;
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function generated<M extends Model>(m: Constructor<M> | M, prop: keyof M): boolean;
+        function createdBy<M extends Model>(m: Constructor<M> | M): keyof M;
+        function updatedBy<M extends Model>(m: Constructor<M> | M): keyof M;
+        function defaultQueryAttributes<M extends Model>(m: Constructor<M> | M, useDefault?: boolean): string[];
+        /**
+         * @description Gets all relation properties defined on a model.
+         * @summary Retrieves the names of all properties marked as relations in the model hierarchy.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {string[]} An array of property names that are relations.
+         */
+        function relations<M extends Model>(m: Constructor<M> | M, prop?: keyof M): string[] | ExtendedRelationsMetadata;
+        /**
+         * @description Gets all indexes defined on a model.
+         * @summary Retrieves all index metadata from a model's property decorators.
+         * @template M - The model type that extends Model.
+         * @param {M | Constructor<M>} model - The model instance or constructor.
+         * @return {Record<string, Record<string, IndexMetadata>>} A nested record of property names to index metadata.
+         */
+        function indexes<M extends Model>(model: M | Constructor<M>): Record<string, Record<string, IndexMetadata>>;
+        /**
+         * @description Gets sequence options for a model's primary key.
+         * @summary Retrieves the sequence configuration for a model's primary key from metadata.
+         * @template M - The model type that extends Model.
+         * @param {M} model - The model instance.
+         * @return {SequenceOptions} The sequence options for the model's primary key.
+         * @throws {InternalError} If no sequence options are defined for the model.
+         */
+        function sequenceFor<M extends Model<boolean>>(model: Constructor<M> | M, property?: keyof M): SequenceOptions;
+        /**
+         * @description Generates a sequence name for a model
+         * @summary Creates a standardized sequence name by combining the table name with additional arguments
+         * @template M - Type that extends Model
+         * @param {M | Constructor<M>} model - The model instance or constructor to generate the sequence name for
+         * @param {...string} args - Additional string arguments to append to the sequence name
+         * @return {string} The generated sequence name
+         */
+        function sequenceName<M extends Model>(model: M | Constructor<M>, ...args: string[]): string;
+        /**
+         * @description Gets the table name for a model
+         * @summary Retrieves the table name associated with a model by checking metadata or falling back to the constructor name
+         * @template M - Type that extends Model
+         * @param {M | Constructor<M>} model - The model instance or constructor to get the table name for
+         * @return {string} The table name for the model
+         */
+        function tableName<M extends Model<boolean>>(model: Constructor<M> | M): string;
+        function columnName<M extends Model<boolean>>(model: Constructor<M> | M, prop: keyof M): string;
+        function nonValidatableFor<M extends Model<boolean>>(m: Constructor<M> | M, op: OperationKeys.CREATE | OperationKeys.UPDATE | string): string[];
+        function validateOn<M extends Model<boolean>>(m: Constructor<M> | M, op: OperationKeys.CREATE | OperationKeys): M extends Model<true> ? Promise<ModelErrorDefinition | undefined> : ModelErrorDefinition | undefined;
+        function generatedBySequence<M extends Model>(model: M | Constructor<M>, prop?: keyof M): boolean;
+    }
+}

package/lib/types/overrides/ModelBuilder.d.cts

@@ -0,0 +1,31 @@
+import "@decaf-ts/decorator-validation";
+declare module "@decaf-ts/decorator-validation" {
+    interface ModelBuilder<M> {
+        table(tableName: string): ModelBuilder<M>;
+        unique(attr: keyof M): ModelBuilder<M>;
+        createdBy(attr: keyof M): ModelBuilder<M>;
+        updatedBy(attr: keyof M): ModelBuilder<M>;
+        createdAt(attr: keyof M): ModelBuilder<M>;
+        updatedAt(attr: keyof M): ModelBuilder<M>;
+        oneToOne<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinColumnOpts?: any, fk?: string): ModelBuilder<M>;
+        oneToMany<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinTableOpts?: any, fk?: string): ModelBuilder<M>;
+        manyToOne<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinTableOpts?: any, fk?: string): ModelBuilder<M>;
+        manyToMany<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinTableOpts?: any, fk?: string): ModelBuilder<M>;
+        noValidateOn(attr: keyof M, ...ops: any[]): ModelBuilder<M>;
+        noValidateOnCreate(attr: keyof M): ModelBuilder<M>;
+        noValidateOnUpdate(attr: keyof M): ModelBuilder<M>;
+        noValidateOnCreateUpdate(attr: keyof M): ModelBuilder<M>;
+    }
+    interface AttributeBuilder<M, N extends keyof M, T> {
+        column<N2 extends keyof M>(columnName?: string): AttributeBuilder<M, N2, T>;
+        unique<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        createdBy<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        updatedBy<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        createdAt<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        updatedAt<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        noValidateOn<N2 extends keyof M>(...ops: any[]): AttributeBuilder<M, N2, T>;
+        noValidateOnCreate<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        noValidateOnUpdate<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        noValidateOnCreateUpdate<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+    }
+}

package/lib/types/overrides/ModelBuilder.d.mts

@@ -0,0 +1,31 @@
+import "@decaf-ts/decorator-validation";
+declare module "@decaf-ts/decorator-validation" {
+    interface ModelBuilder<M> {
+        table(tableName: string): ModelBuilder<M>;
+        unique(attr: keyof M): ModelBuilder<M>;
+        createdBy(attr: keyof M): ModelBuilder<M>;
+        updatedBy(attr: keyof M): ModelBuilder<M>;
+        createdAt(attr: keyof M): ModelBuilder<M>;
+        updatedAt(attr: keyof M): ModelBuilder<M>;
+        oneToOne<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinColumnOpts?: any, fk?: string): ModelBuilder<M>;
+        oneToMany<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinTableOpts?: any, fk?: string): ModelBuilder<M>;
+        manyToOne<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinTableOpts?: any, fk?: string): ModelBuilder<M>;
+        manyToMany<N extends keyof M>(attr: N, clazz: any | (() => any), cascade?: any, populate?: boolean, joinTableOpts?: any, fk?: string): ModelBuilder<M>;
+        noValidateOn(attr: keyof M, ...ops: any[]): ModelBuilder<M>;
+        noValidateOnCreate(attr: keyof M): ModelBuilder<M>;
+        noValidateOnUpdate(attr: keyof M): ModelBuilder<M>;
+        noValidateOnCreateUpdate(attr: keyof M): ModelBuilder<M>;
+    }
+    interface AttributeBuilder<M, N extends keyof M, T> {
+        column<N2 extends keyof M>(columnName?: string): AttributeBuilder<M, N2, T>;
+        unique<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        createdBy<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        updatedBy<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        createdAt<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        updatedAt<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        noValidateOn<N2 extends keyof M>(...ops: any[]): AttributeBuilder<M, N2, T>;
+        noValidateOnCreate<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        noValidateOnUpdate<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+        noValidateOnCreateUpdate<N2 extends keyof M>(): AttributeBuilder<M, N2, T>;
+    }
+}

package/lib/types/overrides/index.d.cts

@@ -0,0 +1,11 @@
+/**
+ * @description Exports for the overrides module.
+ * @summary This file exports all the necessary components for the overrides functionality, including Metadata, injectables, Model, and overrides.
+ * @module core/overrides
+ */
+import "./overrides";
+export * from "./Metadata.cjs";
+export * from "./injectables.cjs";
+export * from "./Model.cjs";
+export * from "./overrides.cjs";
+export * from "./ModelBuilder.cjs";

package/lib/types/overrides/index.d.mts

@@ -0,0 +1,11 @@
+/**
+ * @description Exports for the overrides module.
+ * @summary This file exports all the necessary components for the overrides functionality, including Metadata, injectables, Model, and overrides.
+ * @module core/overrides
+ */
+import "./overrides";
+export * from "./Metadata.js";
+export * from "./injectables.js";
+export * from "./Model.js";
+export * from "./overrides.js";
+export * from "./ModelBuilder.js";

package/lib/types/overrides/injectables.d.cts

@@ -0,0 +1,10 @@
+import "@decaf-ts/injectable-decorators";
+import { Repository } from "../repository/Repository.cjs";
+import type { Service } from "../services/services.cjs";
+import { Constructor } from "@decaf-ts/decoration";
+declare module "@decaf-ts/injectable-decorators" {
+    namespace Injectables {
+        function repositories<R extends Repository<any, any>>(flavour: string): Record<string, Record<string, Constructor<R>>>;
+        function services<S extends Service>(): Record<string, Constructor<S>>;
+    }
+}

package/lib/types/overrides/injectables.d.mts

@@ -0,0 +1,10 @@
+import "@decaf-ts/injectable-decorators";
+import { Repository } from "../repository/Repository.js";
+import type { Service } from "../services/services.js";
+import { Constructor } from "@decaf-ts/decoration";
+declare module "@decaf-ts/injectable-decorators" {
+    namespace Injectables {
+        function repositories<R extends Repository<any, any>>(flavour: string): Record<string, Record<string, Constructor<R>>>;
+        function services<S extends Service>(): Record<string, Constructor<S>>;
+    }
+}

package/lib/types/overrides/overrides.d.cts

@@ -0,0 +1 @@
+export {};

package/lib/types/overrides/overrides.d.mts

@@ -0,0 +1 @@
+export {};