@flusys/nestjs-core 1.0.0-beta → 1.0.0

package/cjs/docs/docs.config.js

@@ -2,10 +2,18 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "setupModuleSwaggerDocs", {
-    enumerable: true,
-    get: function() {
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get setupModuleSwaggerDocs () {
         return setupModuleSwaggerDocs;
+    },
+    get setupSwaggerDocs () {
+        return setupSwaggerDocs;
     }
 });
 const _swagger = require("@nestjs/swagger");
@@ -94,6 +102,65 @@ const _swagger = require("@nestjs/swagger");
         paths: filteredPaths
     };
 }
+/**
+ * Filter OpenAPI document to exclude examples from endpoint responses
+ */ function filterExamples(document, exclusions) {
+    if (!exclusions?.length || !document.paths) {
+        return document;
+    }
+    const filteredPaths = {};
+    for (const [path, pathItem] of Object.entries(document.paths)){
+        const filteredPathItem = {};
+        for (const [method, operation] of Object.entries(pathItem)){
+            // Skip non-operation properties
+            if (!operation || typeof operation !== 'object') {
+                filteredPathItem[method] = operation;
+                continue;
+            }
+            // Check if this endpoint matches any exclusion pattern
+            const matchingExclusions = exclusions.filter((exclusion)=>{
+                const pathMatches = pathMatchesPattern(path, exclusion.pathPattern);
+                const methodMatches = !exclusion.method || exclusion.method === method;
+                return pathMatches && methodMatches;
+            });
+            if (matchingExclusions.length > 0) {
+                // Collect all examples to exclude
+                const examplesToExclude = new Set();
+                matchingExclusions.forEach((exclusion)=>{
+                    exclusion.examples.forEach((example)=>examplesToExclude.add(example));
+                });
+                // Deep clone the operation to avoid mutating original
+                const filteredOperation = JSON.parse(JSON.stringify(operation));
+                // Filter examples from responses
+                if (filteredOperation.responses) {
+                    for (const [statusCode, response] of Object.entries(filteredOperation.responses)){
+                        const responseObj = response;
+                        if (responseObj?.content) {
+                            const content = responseObj.content;
+                            for (const [mediaType, mediaTypeObj] of Object.entries(content)){
+                                const media = mediaTypeObj;
+                                if (media?.examples && typeof media.examples === 'object') {
+                                    const examples = media.examples;
+                                    for (const exampleName of examplesToExclude){
+                                        delete examples[exampleName];
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+                filteredPathItem[method] = filteredOperation;
+            } else {
+                filteredPathItem[method] = operation;
+            }
+        }
+        filteredPaths[path] = filteredPathItem;
+    }
+    return {
+        ...document,
+        paths: filteredPaths
+    };
+}
 /**
  * Check if a path matches a pattern (supports wildcards)
  */ function pathMatchesPattern(path, pattern) {
@@ -187,6 +254,13 @@ function setupModuleSwaggerDocs(app, configs) {
         if (config.excludeQueryParameters?.length) {
             document = filterQueryParameters(document, config.excludeQueryParameters);
         }
+        // Filter out excluded examples
+        if (config.excludeExamples?.length) {
+            document = filterExamples(document, config.excludeExamples);
+        }
         _swagger.SwaggerModule.setup(config.path, app, document);
     });
 }
+function setupSwaggerDocs(app, ...modules) {
+    setupModuleSwaggerDocs(app, modules);
+}

package/cjs/docs/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _export_star(require("./docs.config"), exports);
-_export_star(require("./docs.setup"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/cjs/interfaces/base-entity.interface.js

@@ -1,7 +1,9 @@
 /**
- * Base Entity Interface
- * All entities should implement this for consistency
- */ "use strict";
+ * Entity Contract Interfaces
+ *
+ * These interfaces define the standard fields that entities should have.
+ * Use them as contracts when implementing new entities.
+ */ /** Base entity with UUID, timestamps, and soft delete */ "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });

package/cjs/interfaces/database.interface.js

@@ -1,6 +1,4 @@
-/**
- * Supported database types
- */ "use strict";
+"use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });

package/cjs/migration/datasource.factory.js

@@ -22,10 +22,9 @@ const _datasourceconfigbuilder = require("../utils/datasource-config.builder");
 function createMigrationDataSource(options) {
     const { config, tenantId } = options;
     const { database, tenant, tenantConfig } = (0, _datasourceconfigbuilder.getDatabaseForTenant)(config, tenantId);
-    // Log target info
     console.log(`\n📦 Database: ${database}${tenant ? ` [${tenant.name}]` : ' [default]'}`);
     console.log(`📁 Migrations: migrations/${tenantId || 'default'}/`);
-    if (config.bootstrapAppConfig?.databaseMode == 'multi-tenant' && !tenantId && config.tenants && config.tenants.length > 0) {
+    if (config.bootstrapAppConfig?.databaseMode === 'multi-tenant' && !tenantId && config.tenants && config.tenants.length > 0) {
         console.log(`\n💡 Multi-tenant mode. Available tenants:`);
         config.tenants.forEach((t)=>console.log(`   - TENANT_ID=${t.id} → ${t.database}`));
     }
@@ -40,7 +39,6 @@ function createMigrationDataSource(options) {
         ...config.defaultDatabaseConfig,
         database
     };
-    // Resolve entities based on tenant config
     const entities = (0, _datasourceconfigbuilder.resolveEntities)(config, tenantConfig);
     const dsOptions = (0, _datasourceconfigbuilder.buildDataSourceOptions)(dbConfig, entities, (0, _datasourceconfigbuilder.getMigrationsGlobPattern)(config.migrationsPath, tenantId), config.migrationsTableName);
     return new _typeorm.DataSource({

package/cjs/migration/index.js

@@ -1,15 +1,3 @@
-/**
- * Migration Module Exports
- *
- * Public API for TypeORM migration management in single and multi-tenant databases.
- *
- * Main exports:
- * - createMigrationDataSource: Create DataSource for migrations
- * - initializeDataSource: Create and initialize DataSource
- * - runMigrationCli: Programmatic CLI execution
- *
- * The CLI entry point is at ./cli.ts (used by npm scripts)
- */ // DataSource factory for migration config files
 "use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true

package/cjs/migration/migration.cli.js

@@ -53,23 +53,7 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
-/**
- * Migration CLI Service
- *
- * Handles migration command execution for single and multi-tenant databases.
- *
- * Commands:
- * - generate: Create new migration
- * - run: Execute pending migrations
- * - revert: Rollback last migration
- * - status: Check migration status
- * - run:all/revert:all/status:all: Batch operations for all tenants
- *
- * Configuration:
- * - TENANT_ID: Target tenant (optional, defaults to default database)
- * - --config=<path>: Migration config file path
- * - --datasource=<path>: DataSource file path for TypeORM CLI
- */ function showHelp() {
+function showHelp() {
     console.log(`
 Migration CLI
 

package/cjs/migration/migration.runner.js

@@ -75,6 +75,36 @@ function _interop_require_wildcard(obj, nodeInterop) {
     }
     return newObj;
 }
+function getLabel(tenantId) {
+    return tenantId ? `[${tenantId}]` : '[default]';
+}
+async function withDataSource(config, tenantId, operation) {
+    const { database } = (0, _utils.getDatabaseForTenant)(config, tenantId);
+    const label = getLabel(tenantId);
+    try {
+        const ds = await (0, _datasourcefactory.initializeDataSource)({
+            config,
+            tenantId
+        });
+        const partial = await operation(ds, label);
+        await ds.destroy();
+        return {
+            tenantId,
+            database,
+            success: true,
+            ...partial
+        };
+    } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        console.error(`${label} ✗ Failed: ${errorMessage}`);
+        return {
+            tenantId,
+            database,
+            success: false,
+            error: errorMessage
+        };
+    }
+}
 function ensureMigrationsFolder(basePath, tenantId) {
     const folder = (0, _utils.getMigrationsFolderPath)(basePath, tenantId);
     if (!_fs.existsSync(folder)) {
@@ -116,15 +146,8 @@ function findDatasourcePath() {
     throw new Error('Could not find datasource file. Specify with --datasource=<path>');
 }
 async function runMigrations(config, tenantId) {
-    const { database } = (0, _utils.getDatabaseForTenant)(config, tenantId);
-    const label = tenantId ? `[${tenantId}]` : '[default]';
-    try {
-        const ds = await (0, _datasourcefactory.initializeDataSource)({
-            config,
-            tenantId
-        });
+    return withDataSource(config, tenantId, async (ds, label)=>{
         const migrations = await ds.runMigrations();
-        await ds.destroy();
         if (migrations.length === 0) {
             console.log(`${label} No pending migrations.`);
         } else {
@@ -132,78 +155,27 @@ async function runMigrations(config, tenantId) {
             migrations.forEach((m)=>console.log(`   - ${m.name}`));
         }
         return {
-            tenantId,
-            database,
-            success: true,
             migrationsRun: migrations.map((m)=>m.name)
         };
-    } catch (error) {
-        const errorMessage = error instanceof Error ? error.message : String(error);
-        console.error(`${label} ✗ Failed: ${errorMessage}`);
-        return {
-            tenantId,
-            database,
-            success: false,
-            error: errorMessage
-        };
-    }
+    });
 }
 async function revertMigration(config, tenantId) {
-    const { database } = (0, _utils.getDatabaseForTenant)(config, tenantId);
-    const label = tenantId ? `[${tenantId}]` : '[default]';
-    try {
-        const ds = await (0, _datasourcefactory.initializeDataSource)({
-            config,
-            tenantId
-        });
+    return withDataSource(config, tenantId, async (ds, label)=>{
         await ds.undoLastMigration();
-        await ds.destroy();
         console.log(`${label} ✓ Reverted!`);
-        return {
-            tenantId,
-            database,
-            success: true
-        };
-    } catch (error) {
-        const errorMessage = error instanceof Error ? error.message : String(error);
-        console.error(`${label} ✗ Failed: ${errorMessage}`);
-        return {
-            tenantId,
-            database,
-            success: false,
-            error: errorMessage
-        };
-    }
+        return {};
+    });
 }
 async function migrationStatus(config, tenantId) {
-    const { database } = (0, _utils.getDatabaseForTenant)(config, tenantId);
-    const label = tenantId ? `[${tenantId}]` : '[default]';
-    try {
-        const ds = await (0, _datasourcefactory.initializeDataSource)({
-            config,
-            tenantId
-        });
+    return withDataSource(config, tenantId, async (ds, label)=>{
         const hasPending = await ds.showMigrations();
-        await ds.destroy();
         console.log(`${label} Pending: ${hasPending ? 'Yes' : 'No'}`);
         return {
-            tenantId,
-            database,
-            success: true,
             migrationsRun: [
                 hasPending ? 'Has pending' : 'Up to date'
             ]
         };
-    } catch (error) {
-        const errorMessage = error instanceof Error ? error.message : String(error);
-        console.error(`${label} ✗ Failed: ${errorMessage}`);
-        return {
-            tenantId,
-            database,
-            success: false,
-            error: errorMessage
-        };
-    }
+    });
 }
 async function runForAllTenants(config, command) {
     const tenants = (0, _utils.getActiveTenants)(config);

package/cjs/seeders/base-seeder.js

@@ -22,25 +22,15 @@ function _define_property(obj, key, value) {
     return obj;
 }
 let BaseSeeder = class BaseSeeder {
-    /**
-   * Clear all records from the entity table
-   * Respects soft delete if entity has deletedAt column
-   * @param hard If true, perform hard delete (ignore soft delete)
-   */ async clear(hard = false) {
+    async clear(hard = false) {
         const hasSoftDelete = this.metadata.deleteDateColumn !== undefined;
         if (hard || !hasSoftDelete) {
-            // Hard delete - remove all records
             await this.repository.clear();
         } else {
-            // Soft delete - set deletedAt
             await this.repository.createQueryBuilder().softDelete().where('id IS NOT NULL').execute();
         }
     }
-    /**
-   * Get count of existing records
-   * @param includeDeleted If true, count soft-deleted records
-   * @returns Total record count
-   */ async count(includeDeleted = false) {
+    async count(includeDeleted = false) {
         const hasSoftDelete = this.metadata.deleteDateColumn !== undefined;
         if (hasSoftDelete && !includeDeleted) {
             return this.repository.count({
@@ -51,22 +41,13 @@ let BaseSeeder = class BaseSeeder {
         }
         return this.repository.count();
     }
-    /**
-   * Check if entity has any records
-   * @returns True if no records exist
-   */ async isEmpty() {
-        const total = await this.count();
-        return total === 0;
+    async isEmpty() {
+        return await this.count() === 0;
     }
-    /**
-   * Get entity name for logging
-   */ getEntityName() {
+    getEntityName() {
         return this.metadata.tableName;
     }
-    /**
-   * Wrap operation in transaction
-   * @param operation Function to execute in transaction
-   */ async withTransaction(operation) {
+    async withTransaction(operation) {
         const queryRunner = this.dataSource.createQueryRunner();
         await queryRunner.connect();
         await queryRunner.startTransaction();