@elsikora/nestjs-crud-config 5.0.0-dev.1 → 5.0.0-dev.2

package/README.md

@@ -175,7 +175,7 @@ import { CrudConfigModule, TOKEN_CONSTANT } from "@elsikora/nestjs-crud-config";
    // Entity customization
    entityOptions: {
     tablePrefix: "app_",
-    timestampColumnType: "timestamptz", // PostgreSQL; defaults to "timestamp"
+    timestampColumnType: "timestamptz", // PostgreSQL; defaults to Date, the timestamp type of the driver
     configSection: {
      tableName: "config_sections",
      maxNameLength: 128,
@@ -1024,7 +1024,7 @@ CrudConfigModule.register({
 });
 ```
 
-`timestampColumnType` applies to all nine temporal columns in the section, data, and migration entities. It defaults to `"timestamp"`; choose a TypeORM `ColumnType` supported by your database driver, such as `"timestamptz"` for PostgreSQL or `"datetime"` for SQL.js/SQLite. Changing it for an existing database still requires the corresponding schema migration.
+`timestampColumnType` applies to all nine temporal columns in the section, data, and migration entities. It defaults to `Date`, which TypeORM maps to the timestamp type of each driver: `timestamp` on PostgreSQL and `datetime` on MySQL, MariaDB, SQLite (`better-sqlite3`) and SQL.js, so the default entities work on every one of them. Set a driver-specific type, such as `"timestamptz"` for PostgreSQL, only when the application needs it. Changing it for an existing database still requires the corresponding schema migration.
 
 ### What happens if the database is unavailable?
 

package/dist/index.js

@@ -9,6 +9,7 @@ export { ConfigMigrationService } from './modules/config/migration/migration.ser
 export { createConfigSectionEntity } from './modules/config/section/entity/entity.js';
 export { API_PROPERTY_CONSTANT } from './shared/constant/api-property.constant.js';
 export { CONFIG_DATA_CONSTANT } from './shared/constant/config/data.constant.js';
+export { CONFIG_ENTITY_CONSTANT } from './shared/constant/config/entity.constant.js';
 export { CONFIG_MIGRATION_CONSTANT } from './shared/constant/config/migration.constant.js';
 export { CONFIG_SECTION_CONSTANT } from './shared/constant/config/section.constant.js';
 export { CRYPTO_CONSTANT } from './shared/constant/crypto.constant.js';

package/dist/modules/config/config.module.js

@@ -11,6 +11,7 @@ import { CacheModule } from '@nestjs/cache-manager';
 import { Global, Module } from '@nestjs/common';
 import { getRepositoryToken, getDataSourceToken } from '@nestjs/typeorm';
 import { CONFIG_DATA_CONSTANT } from '../../shared/constant/config/data.constant.js';
+import { CONFIG_ENTITY_CONSTANT } from '../../shared/constant/config/entity.constant.js';
 import { CONFIG_MIGRATION_CONSTANT } from '../../shared/constant/config/migration.constant.js';
 import { CONFIG_SECTION_CONSTANT } from '../../shared/constant/config/section.constant.js';
 import { TOKEN_CONSTANT } from '../../shared/constant/token.constant.js';
@@ -24,7 +25,8 @@ var CrudConfigModule_1;
 let CrudConfigModule = CrudConfigModule_1 = class CrudConfigModule {
     static register(options) {
         const prefix = options.entityOptions?.tablePrefix ?? "";
-        const timestampColumnType = options.entityOptions?.timestampColumnType ?? "timestamp";
+        const timestampColumnType = options.entityOptions?.timestampColumnType ??
+            CONFIG_ENTITY_CONSTANT.DEFAULT_TIMESTAMP_COLUMN_TYPE;
         const sectionEntity = createConfigSectionEntity({
             maxDescriptionLength: options.entityOptions?.configSection?.maxDescriptionLength ??
                 CONFIG_SECTION_CONSTANT.MAX_DESCRIPTION_LENGTH,
@@ -183,7 +185,7 @@ let CrudConfigModule = CrudConfigModule_1 = class CrudConfigModule {
     static registerAsync(properties) {
         const staticEntityOptions = properties.staticOptions?.entityOptions;
         const prefix = staticEntityOptions?.tablePrefix ?? "";
-        const timestampColumnType = staticEntityOptions?.timestampColumnType ?? "timestamp";
+        const timestampColumnType = staticEntityOptions?.timestampColumnType ?? CONFIG_ENTITY_CONSTANT.DEFAULT_TIMESTAMP_COLUMN_TYPE;
         const sectionEntity = createConfigSectionEntity({
             maxDescriptionLength: staticEntityOptions?.configSection?.maxDescriptionLength ??
                 CONFIG_SECTION_CONSTANT.MAX_DESCRIPTION_LENGTH,

package/dist/modules/config/data/entity/entity.d.ts

@@ -11,7 +11,7 @@ import { IConfigData } from '../interface/index.js';
  * @param {number} options.maxNameLength - Maximum length for name field
  * @param {number} options.maxValueLength - Maximum length for value field
  * @param {string} options.tableName - Name of the database table
- * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `timestamp`
+ * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `Date`, the timestamp type of the driver
  * @returns {TDynamicEntity} Dynamically created ConfigData entity class
  */
 export declare function createConfigDataEntity(options: {

package/dist/modules/config/data/entity/entity.js

@@ -1,5 +1,6 @@
 import { ApiPropertyDescribe, EApiPropertyDescribeType, EApiPropertyStringType, EApiPropertyDateIdentifier, EApiPropertyDateType } from '@elsikora/nestjs-crud-automator';
 import { API_PROPERTY_CONSTANT } from '../../../../shared/constant/api-property.constant.js';
+import { CONFIG_ENTITY_CONSTANT } from '../../../../shared/constant/config/entity.constant.js';
 import { createDynamicEntityClass } from '../../../../shared/utility/create-dynamic/entity.utility.js';
 import '../../../../external/tslib/tslib.es6.js';
 import '@nestjs/common';
@@ -17,11 +18,11 @@ import '../../../../shared/utility/logger.utility.js';
  * @param {number} options.maxNameLength - Maximum length for name field
  * @param {number} options.maxValueLength - Maximum length for value field
  * @param {string} options.tableName - Name of the database table
- * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `timestamp`
+ * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `Date`, the timestamp type of the driver
  * @returns {TDynamicEntity} Dynamically created ConfigData entity class
  */
 function createConfigDataEntity(options) {
-    const timestampColumnType = options.timestampColumnType ?? "timestamp";
+    const timestampColumnType = options.timestampColumnType ?? CONFIG_ENTITY_CONSTANT.DEFAULT_TIMESTAMP_COLUMN_TYPE;
     return createDynamicEntityClass({
         columns: {
             createdAt: {

package/dist/modules/config/migration/entity/entity.d.ts

@@ -6,7 +6,7 @@ import { IConfigMigration } from '../interface/index.js';
  * @param {object} options - Configuration options for the entity
  * @param {number} options.maxNameLength - Maximum length for migration name field
  * @param {string} options.tableName - Name of the database table
- * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `timestamp`
+ * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `Date`, the timestamp type of the driver
  * @returns {TDynamicEntity} Dynamically created ConfigMigration entity class
  */
 export declare function createConfigMigrationEntity(options: {

package/dist/modules/config/migration/entity/entity.js

@@ -1,5 +1,6 @@
 import { ApiPropertyDescribe, EApiPropertyDescribeType, EApiPropertyDateIdentifier, EApiPropertyDateType, EApiPropertyStringType } from '@elsikora/nestjs-crud-automator';
 import { API_PROPERTY_CONSTANT } from '../../../../shared/constant/api-property.constant.js';
+import { CONFIG_ENTITY_CONSTANT } from '../../../../shared/constant/config/entity.constant.js';
 import { CONFIG_MIGRATION_CONSTANT } from '../../../../shared/constant/config/migration.constant.js';
 import { createDynamicEntityClass } from '../../../../shared/utility/create-dynamic/entity.utility.js';
 import '../../../../external/tslib/tslib.es6.js';
@@ -14,11 +15,11 @@ import '../../../../shared/utility/logger.utility.js';
  * @param {object} options - Configuration options for the entity
  * @param {number} options.maxNameLength - Maximum length for migration name field
  * @param {string} options.tableName - Name of the database table
- * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `timestamp`
+ * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `Date`, the timestamp type of the driver
  * @returns {TDynamicEntity} Dynamically created ConfigMigration entity class
  */
 function createConfigMigrationEntity(options) {
-    const timestampColumnType = options.timestampColumnType ?? "timestamp";
+    const timestampColumnType = options.timestampColumnType ?? CONFIG_ENTITY_CONSTANT.DEFAULT_TIMESTAMP_COLUMN_TYPE;
     return createDynamicEntityClass({
         columns: {
             createdAt: {
@@ -47,7 +48,7 @@ function createConfigMigrationEntity(options) {
                 default: "PENDING",
                 enum: ["PENDING", "RUNNING", "COMPLETED", "FAILED", "STUCK"],
                 nullable: false,
-                type: "enum",
+                type: "simple-enum",
             },
             updatedAt: {
                 default: () => "CURRENT_TIMESTAMP",

package/dist/modules/config/migration/migration.service.js

@@ -1,23 +1,25 @@
 import { __decorate, __param, __metadata } from '../../../external/tslib/tslib.es6.js';
 import { ApiFunctionTransactionScope } from '@elsikora/nestjs-crud-automator';
 import { CrudConfigService } from '../config.service.js';
-import { Injectable, Inject, Logger } from '@nestjs/common';
+import { Injectable, Inject } from '@nestjs/common';
 import { CONFIG_MIGRATION_CONSTANT } from '../../../shared/constant/config/migration.constant.js';
 import { TOKEN_CONSTANT } from '../../../shared/constant/token.constant.js';
 import { DataSource } from 'typeorm';
+import '@nestjs/typeorm';
+import '../../../shared/utility/crypto.utility.js';
+import { LoggerUtility } from '../../../shared/utility/logger.utility.js';
 import { EConfigMigrationStatus } from './enum/status.js';
 
-var ConfigMigrationService_1;
 /**
  * Service responsible for coordinating and tracking execution of migrations.
  * @see {@link https://elsikora.com/docs/nestjs-crud-config/migration-system | Migration System}
  * @see {@link https://elsikora.com/docs/nestjs-crud-config/api-reference/classes/config-migration-service | API Reference - ConfigMigrationService}
  */
-let ConfigMigrationService = ConfigMigrationService_1 = class ConfigMigrationService {
+let ConfigMigrationService = class ConfigMigrationService {
     dataSource;
     options;
     configService;
-    LOGGER = new Logger(ConfigMigrationService_1.name);
+    LOGGER = LoggerUtility.getLogger("ConfigMigrationService");
     MIGRATION_SERVICE;
     constructor(dataSource, options, configService, migrationService) {
         this.dataSource = dataSource;
@@ -362,7 +364,7 @@ let ConfigMigrationService = ConfigMigrationService_1 = class ConfigMigrationSer
         }
     }
 };
-ConfigMigrationService = ConfigMigrationService_1 = __decorate([
+ConfigMigrationService = __decorate([
     Injectable(),
     __param(0, Inject(DataSource)),
     __param(1, Inject(TOKEN_CONSTANT.CONFIG_OPTIONS)),

package/dist/modules/config/section/entity/entity.d.ts

@@ -7,7 +7,7 @@ import { IConfigSection } from '../interface/index.js';
  * @param {number} options.maxDescriptionLength - Maximum length for description field
  * @param {number} options.maxNameLength - Maximum length for name field
  * @param {string} options.tableName - Name of the database table
- * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `timestamp`
+ * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `Date`, the timestamp type of the driver
  * @returns {TDynamicEntity} Dynamically created ConfigSection entity class
  */
 export declare function createConfigSectionEntity(options: {

package/dist/modules/config/section/entity/entity.js

@@ -1,5 +1,6 @@
 import { ApiPropertyDescribe, EApiPropertyDescribeType, EApiPropertyDateIdentifier, EApiPropertyDateType, EApiPropertyStringType } from '@elsikora/nestjs-crud-automator';
 import { API_PROPERTY_CONSTANT } from '../../../../shared/constant/api-property.constant.js';
+import { CONFIG_ENTITY_CONSTANT } from '../../../../shared/constant/config/entity.constant.js';
 import { createDynamicEntityClass } from '../../../../shared/utility/create-dynamic/entity.utility.js';
 import '../../../../external/tslib/tslib.es6.js';
 import '@nestjs/common';
@@ -14,11 +15,11 @@ import '../../../../shared/utility/logger.utility.js';
  * @param {number} options.maxDescriptionLength - Maximum length for description field
  * @param {number} options.maxNameLength - Maximum length for name field
  * @param {string} options.tableName - Name of the database table
- * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `timestamp`
+ * @param {ColumnType} [options.timestampColumnType] - TypeORM type for timestamp fields; defaults to `Date`, the timestamp type of the driver
  * @returns {TDynamicEntity} Dynamically created ConfigSection entity class
  */
 function createConfigSectionEntity(options) {
-    const timestampColumnType = options.timestampColumnType ?? "timestamp";
+    const timestampColumnType = options.timestampColumnType ?? CONFIG_ENTITY_CONSTANT.DEFAULT_TIMESTAMP_COLUMN_TYPE;
     return createDynamicEntityClass({
         columns: {
             createdAt: {

package/dist/shared/constant/config/entity.constant.d.ts

@@ -0,0 +1,4 @@
+import { ColumnType } from 'typeorm';
+export declare const CONFIG_ENTITY_CONSTANT: {
+    readonly DEFAULT_TIMESTAMP_COLUMN_TYPE: ColumnType;
+};

package/dist/shared/constant/config/entity.constant.js

@@ -0,0 +1,7 @@
+// TypeORM maps Date to each driver's timestamp type: timestamp on PostgreSQL, datetime on MySQL, MariaDB and SQLite
+const DEFAULT_TIMESTAMP_COLUMN_TYPE = Date;
+const CONFIG_ENTITY_CONSTANT = {
+    DEFAULT_TIMESTAMP_COLUMN_TYPE,
+};
+
+export { CONFIG_ENTITY_CONSTANT };

package/dist/shared/constant/config/index.d.ts

@@ -1,3 +1,4 @@
 export { CONFIG_DATA_CONSTANT } from './data.constant.js';
+export { CONFIG_ENTITY_CONSTANT } from './entity.constant.js';
 export { CONFIG_MIGRATION_CONSTANT } from './migration.constant.js';
 export { CONFIG_SECTION_CONSTANT } from './section.constant.js';

package/dist/shared/interface/config/entity/options.interface.d.ts

@@ -19,7 +19,8 @@ export interface ICrudConfigEntityOptions {
     tablePrefix?: string;
     /**
      * TypeORM column type used by all ConfigSection, ConfigData, and ConfigMigration timestamp fields.
-     * Defaults to `timestamp`.
+     * Defaults to `Date`, which TypeORM maps to the timestamp type of the driver: `timestamp` on PostgreSQL,
+     * `datetime` on MySQL, MariaDB and SQLite.
      */
     timestampColumnType?: ColumnType;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@elsikora/nestjs-crud-config",
- "version": "5.0.0-dev.1",
+ "version": "5.0.0-dev.2",
  "description": "NestJS application configuration via database storage",
  "homepage": "https://github.com/ElsiKora/NestJS-Crud-Config#readme",
  "bugs": {
@@ -8,7 +8,7 @@
  },
  "repository": {
   "type": "git",
-  "url": "https://github.com/ElsiKora/NestJS-Crud-Config"
+  "url": "git+https://github.com/ElsiKora/NestJS-Crud-Config.git"
  },
  "license": "MIT",
  "author": "ElsiKora",