@decaf-ts/core 0.5.1 → 0.5.2

package/lib/interfaces/SequenceOptions.d.ts

@@ -1,12 +1,64 @@
+/**
+ * @description Interface for sequence configuration options
+ * @summary Defines the configuration options for creating and managing sequences
+ * @interface SequenceOptions
+ * @memberOf module:core
+ */
 export interface SequenceOptions {
+    /**
+     * @description Optional name for the sequence
+     * @summary A unique identifier for the sequence
+     */
     name?: string;
+    /**
+     * @description The data type of the sequence
+     * @summary Specifies whether the sequence generates Number or BigInt values
+     */
     type: "Number" | "BigInt" | undefined;
+    /**
+     * @description The initial value of the sequence
+     * @summary The value that the sequence starts with
+     */
     startWith: number;
+    /**
+     * @description The increment value for each step in the sequence
+     * @summary The amount by which the sequence increases with each call
+     */
     incrementBy: number;
+    /**
+     * @description Optional minimum value for the sequence
+     * @summary The lowest value that the sequence can generate
+     */
     minValue?: number;
+    /**
+     * @description Optional maximum value for the sequence
+     * @summary The highest value that the sequence can generate
+     */
     maxValue?: number;
+    /**
+     * @description Whether the sequence should cycle when reaching its limits
+     * @summary If true, the sequence will restart from minValue when reaching maxValue
+     */
     cycle: boolean;
 }
+/**
+ * @description Default options for sequences
+ * @summary Provides a standard configuration for number sequences starting at 0 and incrementing by 1
+ * @const DefaultSequenceOptions
+ * @memberOf module:core
+ */
 export declare const DefaultSequenceOptions: SequenceOptions;
+/**
+ * @description Predefined options for numeric sequences
+ * @summary Configuration for standard number sequences starting at 0 and incrementing by 1
+ * @const NumericSequence
+ * @memberOf module:core
+ */
 export declare const NumericSequence: SequenceOptions;
+/**
+ * @description Predefined options for BigInt sequences
+ * @summary Configuration for BigInt sequences starting at 0 and incrementing by 1
+ * @const BigIntSequence
+ * @memberOf module:core
+ */
 export declare const BigIntSequence: SequenceOptions;

package/lib/model/BaseModel.cjs

@@ -12,6 +12,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseModel = void 0;
 const db_decorators_1 = require("@decaf-ts/db-decorators");
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
+/**
+ * @description Base model class for all domain models
+ * @summary An abstract base class that extends the Model class from decorator-validation and adds timestamp functionality.
+ * All domain models in the application should extend this class to inherit common properties and behaviors.
+ * @param {ModelArg<BaseModel>} arg - Optional initialization data for the model
+ * @class BaseModel
+ * @example
+ * ```typescript
+ * class User extends BaseModel {
+ *   @required()
+ *   username!: string;
+ *
+ *   @email()
+ *   email!: string;
+ *
+ *   constructor(data?: ModelArg<User>) {
+ *     super(data);
+ *   }
+ * }
+ *
+ * const user = new User({ username: 'john', email: 'john@example.com' });
+ * ```
+ */
 class BaseModel extends decorator_validation_1.Model {
     constructor(arg) {
         super(arg);
@@ -26,4 +49,4 @@ __decorate([
     (0, db_decorators_1.timestamp)(),
     __metadata("design:type", Date)
 ], BaseModel.prototype, "updatedOn", void 0);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFzZU1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL21vZGVsL0Jhc2VNb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7QUFBQSwyREFBa0U7QUFDbEUseUVBQWlFO0FBRWpFLE1BQXNCLFNBQVUsU0FBUSw0QkFBSztJQU0zQyxZQUFzQixHQUF5QjtRQUM3QyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDYixDQUFDO0NBQ0Y7QUFURCw4QkFTQztBQVBDO0lBREMsSUFBQSx5QkFBUyxFQUFDLDRCQUFZLENBQUMsTUFBTSxDQUFDOzhCQUNuQixJQUFJOzRDQUFDO0FBRWpCO0lBREMsSUFBQSx5QkFBUyxHQUFFOzhCQUNBLElBQUk7NENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBEQk9wZXJhdGlvbnMsIHRpbWVzdGFtcCB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuaW1wb3J0IHsgTW9kZWxBcmcsIE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgQmFzZU1vZGVsIGV4dGVuZHMgTW9kZWwge1xuICBAdGltZXN0YW1wKERCT3BlcmF0aW9ucy5DUkVBVEUpXG4gIGNyZWF0ZWRPbiE6IERhdGU7XG4gIEB0aW1lc3RhbXAoKVxuICB1cGRhdGVkT24hOiBEYXRlO1xuXG4gIHByb3RlY3RlZCBjb25zdHJ1Y3Rvcihhcmc/OiBNb2RlbEFyZzxCYXNlTW9kZWw+KSB7XG4gICAgc3VwZXIoYXJnKTtcbiAgfVxufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFzZU1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL21vZGVsL0Jhc2VNb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7QUFBQSwyREFBa0U7QUFDbEUseUVBQWlFO0FBRWpFOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBc0JHO0FBQ0gsTUFBc0IsU0FBVSxTQUFRLDRCQUFLO0lBZTNDLFlBQXNCLEdBQXlCO1FBQzdDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUNiLENBQUM7Q0FDRjtBQWxCRCw4QkFrQkM7QUFaQztJQURDLElBQUEseUJBQVMsRUFBQyw0QkFBWSxDQUFDLE1BQU0sQ0FBQzs4QkFDbkIsSUFBSTs0Q0FBQztBQU9qQjtJQURDLElBQUEseUJBQVMsR0FBRTs4QkFDQSxJQUFJOzRDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgREJPcGVyYXRpb25zLCB0aW1lc3RhbXAgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcbmltcG9ydCB7IE1vZGVsQXJnLCBNb2RlbCB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQmFzZSBtb2RlbCBjbGFzcyBmb3IgYWxsIGRvbWFpbiBtb2RlbHNcbiAqIEBzdW1tYXJ5IEFuIGFic3RyYWN0IGJhc2UgY2xhc3MgdGhhdCBleHRlbmRzIHRoZSBNb2RlbCBjbGFzcyBmcm9tIGRlY29yYXRvci12YWxpZGF0aW9uIGFuZCBhZGRzIHRpbWVzdGFtcCBmdW5jdGlvbmFsaXR5LlxuICogQWxsIGRvbWFpbiBtb2RlbHMgaW4gdGhlIGFwcGxpY2F0aW9uIHNob3VsZCBleHRlbmQgdGhpcyBjbGFzcyB0byBpbmhlcml0IGNvbW1vbiBwcm9wZXJ0aWVzIGFuZCBiZWhhdmlvcnMuXG4gKiBAcGFyYW0ge01vZGVsQXJnPEJhc2VNb2RlbD59IGFyZyAtIE9wdGlvbmFsIGluaXRpYWxpemF0aW9uIGRhdGEgZm9yIHRoZSBtb2RlbFxuICogQGNsYXNzIEJhc2VNb2RlbFxuICogQGV4YW1wbGVcbiAqIGBgYHR5cGVzY3JpcHRcbiAqIGNsYXNzIFVzZXIgZXh0ZW5kcyBCYXNlTW9kZWwge1xuICogICBAcmVxdWlyZWQoKVxuICogICB1c2VybmFtZSE6IHN0cmluZztcbiAqICAgXG4gKiAgIEBlbWFpbCgpXG4gKiAgIGVtYWlsITogc3RyaW5nO1xuICogICBcbiAqICAgY29uc3RydWN0b3IoZGF0YT86IE1vZGVsQXJnPFVzZXI+KSB7XG4gKiAgICAgc3VwZXIoZGF0YSk7XG4gKiAgIH1cbiAqIH1cbiAqIFxuICogY29uc3QgdXNlciA9IG5ldyBVc2VyKHsgdXNlcm5hbWU6ICdqb2huJywgZW1haWw6ICdqb2huQGV4YW1wbGUuY29tJyB9KTtcbiAqIGBgYFxuICovXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgQmFzZU1vZGVsIGV4dGVuZHMgTW9kZWwge1xuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIENyZWF0aW9uIHRpbWVzdGFtcCBmb3IgdGhlIG1vZGVsXG4gICAqIEBzdW1tYXJ5IEF1dG9tYXRpY2FsbHkgc2V0IHRvIHRoZSBjdXJyZW50IGRhdGUgYW5kIHRpbWUgd2hlbiB0aGUgbW9kZWwgaXMgY3JlYXRlZFxuICAgKi9cbiAgQHRpbWVzdGFtcChEQk9wZXJhdGlvbnMuQ1JFQVRFKVxuICBjcmVhdGVkT24hOiBEYXRlO1xuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gTGFzdCB1cGRhdGUgdGltZXN0YW1wIGZvciB0aGUgbW9kZWxcbiAgICogQHN1bW1hcnkgQXV0b21hdGljYWxseSB1cGRhdGVkIHRvIHRoZSBjdXJyZW50IGRhdGUgYW5kIHRpbWUgd2hlbmV2ZXIgdGhlIG1vZGVsIGlzIG1vZGlmaWVkXG4gICAqL1xuICBAdGltZXN0YW1wKClcbiAgdXBkYXRlZE9uITogRGF0ZTtcblxuICBwcm90ZWN0ZWQgY29uc3RydWN0b3IoYXJnPzogTW9kZWxBcmc8QmFzZU1vZGVsPikge1xuICAgIHN1cGVyKGFyZyk7XG4gIH1cbn1cbiJdfQ==

package/lib/model/BaseModel.d.ts

@@ -1,6 +1,37 @@
 import { ModelArg, Model } from "@decaf-ts/decorator-validation";
+/**
+ * @description Base model class for all domain models
+ * @summary An abstract base class that extends the Model class from decorator-validation and adds timestamp functionality.
+ * All domain models in the application should extend this class to inherit common properties and behaviors.
+ * @param {ModelArg<BaseModel>} arg - Optional initialization data for the model
+ * @class BaseModel
+ * @example
+ * ```typescript
+ * class User extends BaseModel {
+ *   @required()
+ *   username!: string;
+ *
+ *   @email()
+ *   email!: string;
+ *
+ *   constructor(data?: ModelArg<User>) {
+ *     super(data);
+ *   }
+ * }
+ *
+ * const user = new User({ username: 'john', email: 'john@example.com' });
+ * ```
+ */
 export declare abstract class BaseModel extends Model {
+    /**
+     * @description Creation timestamp for the model
+     * @summary Automatically set to the current date and time when the model is created
+     */
     createdOn: Date;
+    /**
+     * @description Last update timestamp for the model
+     * @summary Automatically updated to the current date and time whenever the model is modified
+     */
     updatedOn: Date;
     protected constructor(arg?: ModelArg<BaseModel>);
 }