@okf/ootils 1.3.10 → 1.4.0

package/dist/node.d.mts

@@ -1,4 +1,4 @@
-import mongoose, { Connection, Document, Schema, Model, Types } from 'mongoose';
+import mongoose, { Connection, Document, Types } from 'mongoose';
 import IORedis from 'ioredis';
 import * as bullmq from 'bullmq';
 import { Queue } from 'bullmq/dist/esm/classes/queue';
@@ -157,42 +157,45 @@ declare const _recursExtractBlocks: ({ data, cb, sectionStack, blockPathPrefix }
     blockPathPrefix?: string;
 }) => void;
 
-interface DbConnections {
-    [clusterName: string]: Connection;
+declare class MongoConnector {
+    static getInstance(): any;
+    static getClusterConnections(): any;
+    static getEnv(): any;
+    static getDbConfigs(): any;
+    constructor(options: any);
+    clusterConnections: {};
+    env: any;
+    dbConfigs: any;
+    mongoOptions: any;
+    /**
+     * Creates multiple MongoDB clusterConnections based on configuration (SYNCHRONOUS)
+     * @returns Object containing named database clusterConnections
+     */
+    multiConnectToMongoDB(): {};
+    multiConnectToMongoDBAsync(): Promise<{}>;
+    /**
+     * Helper function to close clusterConnections object
+     */
+    closeConnectionsObject(clusterConnections: any): Promise<void>;
+    /**
+     * Graceful shutdown - close all MongoDB clusterConnections
+     */
+    closeAllConnections(): Promise<void>;
+}
+declare namespace MongoConnector {
+    let instance: any;
 }
-interface DatabaseConfig {
-    connectTo: string[];
-    CLUSTER_NAME: string;
-    DB_URI: string;
-}
-interface DbConfigs {
-    [env: string]: DatabaseConfig;
-}
-interface MultiConnectParams {
-    env?: string;
-    dbConfigs?: DbConfigs;
-}
-/**
- * Creates multiple MongoDB connections based on environment configuration
- * @param params - Object containing env and dbConfigs (optional, uses global config if not provided)
- * @param params.env - Environment string (e.g., 'development', 'production', 'staging')
- * @param params.dbConfigs - Database configuration object
- * @returns Object containing named database connections
- */
-declare const multiConnectToMongoDB: ({ env, dbConfigs }?: MultiConnectParams) => DbConnections;
 
 /**
- * passing env is optional.
- * cuz it usually defaults to 'this env' provided by .env file.
- *
- * However, in some cases where we are syncing tpls &
- * configs across envs, we need to be able to specify env
- * as well
+ * Get database connection by tenant
+ * @param tenant - Tenant identifier for the database
+ * @param env - Optional environment override (defaults to current environment)
+ * @returns Mongoose Connection instance for the tenant-specific database
  */
-declare const getDbByTenant: ({ tenant, env }: {
-    tenant: string;
-    env?: string;
-}) => Connection;
+declare function getDbByTenant({ tenant, env: _env }: {
+    tenant: any;
+    env: any;
+}): any;
 
 interface GlobalConfigType {
     env?: string;
@@ -216,58 +219,37 @@ declare const initializeGlobalConfig: (config: GlobalConfigType) => void;
  */
 declare const updateGlobalConfig: (updates: Partial<GlobalConfigType>) => void;
 
-interface GetModelByTenantParams {
-    tenant: string;
-    modelName: string;
-    schema: Schema;
-    env?: string;
-    mongodb?: {
-        [clusterName: string]: Connection;
-    };
-    dbConfigs?: {
-        [env: string]: {
-            CLUSTER_NAME: string;
-            DB_URI: string;
-            connectTo?: string[];
-        };
-    };
-}
-interface GetModelShortParams {
-    tenant: string;
-    env?: string;
-    mongodb?: {
-        [clusterName: string]: Connection;
-    };
-    dbConfigs?: {
-        [env: string]: {
-            CLUSTER_NAME: string;
-            DB_URI: string;
-            connectTo?: string[];
-        };
-    };
-    modelName?: string;
-}
-declare const getModelByTenant: <T extends Document = Document>({ tenant, modelName, schema, env, }: GetModelByTenantParams) => Model<T>;
-declare const getAnnotationsModelByTenant: ({ tenant, env, mongodb, dbConfigs, modelName }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
-declare const getPlatformConfigsModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
-declare const getTplModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
-declare const getAIChatModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
+declare function getModelByTenant({ tenant, modelName, schema, env }: {
+    tenant: any;
+    modelName: any;
+    schema: any;
+    env: any;
+}): any;
+declare function getAIChatModelByTenant({ tenant, env, mongodb, dbConfigs }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+}): any;
+declare function getAnnotationsModelByTenant({ tenant, env, mongodb, dbConfigs, modelName }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+    modelName: any;
+}): any;
+declare function getPlatformConfigsModelByTenant({ tenant, env, mongodb, dbConfigs }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+}): any;
+declare function getTplModelByTenant({ tenant, env, mongodb, dbConfigs }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+}): any;
 
 interface GetTplParams {
     name: string;
@@ -396,7 +378,7 @@ declare const AIChatSchema: mongoose.Schema<IAIChat, mongoose.Model<IAIChat, any
     __v: number;
 }>;
 
-declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "AI"];
+declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "ai"];
 type PlatformConfigType = typeof platformConfigTypes[number];
 interface IPlatformConfig extends Document {
     type: PlatformConfigType;
@@ -589,4 +571,4 @@ declare function GET_GLOBAL_BULLMQ_CONFIG({ env, redisCredentials }: {
     };
 }): Object;
 
-export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, GET_GLOBAL_BULLMQ_CONFIG, PlatformConfigsSchema, TplSchema, WorkerManager, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, multiConnectToMongoDB, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };
+export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, GET_GLOBAL_BULLMQ_CONFIG, MongoConnector, PlatformConfigsSchema, TplSchema, WorkerManager, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };

package/dist/node.d.ts

@@ -1,4 +1,4 @@
-import mongoose, { Connection, Document, Schema, Model, Types } from 'mongoose';
+import mongoose, { Connection, Document, Types } from 'mongoose';
 import IORedis from 'ioredis';
 import * as bullmq from 'bullmq';
 import { Queue } from 'bullmq/dist/esm/classes/queue';
@@ -157,42 +157,45 @@ declare const _recursExtractBlocks: ({ data, cb, sectionStack, blockPathPrefix }
     blockPathPrefix?: string;
 }) => void;
 
-interface DbConnections {
-    [clusterName: string]: Connection;
+declare class MongoConnector {
+    static getInstance(): any;
+    static getClusterConnections(): any;
+    static getEnv(): any;
+    static getDbConfigs(): any;
+    constructor(options: any);
+    clusterConnections: {};
+    env: any;
+    dbConfigs: any;
+    mongoOptions: any;
+    /**
+     * Creates multiple MongoDB clusterConnections based on configuration (SYNCHRONOUS)
+     * @returns Object containing named database clusterConnections
+     */
+    multiConnectToMongoDB(): {};
+    multiConnectToMongoDBAsync(): Promise<{}>;
+    /**
+     * Helper function to close clusterConnections object
+     */
+    closeConnectionsObject(clusterConnections: any): Promise<void>;
+    /**
+     * Graceful shutdown - close all MongoDB clusterConnections
+     */
+    closeAllConnections(): Promise<void>;
+}
+declare namespace MongoConnector {
+    let instance: any;
 }
-interface DatabaseConfig {
-    connectTo: string[];
-    CLUSTER_NAME: string;
-    DB_URI: string;
-}
-interface DbConfigs {
-    [env: string]: DatabaseConfig;
-}
-interface MultiConnectParams {
-    env?: string;
-    dbConfigs?: DbConfigs;
-}
-/**
- * Creates multiple MongoDB connections based on environment configuration
- * @param params - Object containing env and dbConfigs (optional, uses global config if not provided)
- * @param params.env - Environment string (e.g., 'development', 'production', 'staging')
- * @param params.dbConfigs - Database configuration object
- * @returns Object containing named database connections
- */
-declare const multiConnectToMongoDB: ({ env, dbConfigs }?: MultiConnectParams) => DbConnections;
 
 /**
- * passing env is optional.
- * cuz it usually defaults to 'this env' provided by .env file.
- *
- * However, in some cases where we are syncing tpls &
- * configs across envs, we need to be able to specify env
- * as well
+ * Get database connection by tenant
+ * @param tenant - Tenant identifier for the database
+ * @param env - Optional environment override (defaults to current environment)
+ * @returns Mongoose Connection instance for the tenant-specific database
  */
-declare const getDbByTenant: ({ tenant, env }: {
-    tenant: string;
-    env?: string;
-}) => Connection;
+declare function getDbByTenant({ tenant, env: _env }: {
+    tenant: any;
+    env: any;
+}): any;
 
 interface GlobalConfigType {
     env?: string;
@@ -216,58 +219,37 @@ declare const initializeGlobalConfig: (config: GlobalConfigType) => void;
  */
 declare const updateGlobalConfig: (updates: Partial<GlobalConfigType>) => void;
 
-interface GetModelByTenantParams {
-    tenant: string;
-    modelName: string;
-    schema: Schema;
-    env?: string;
-    mongodb?: {
-        [clusterName: string]: Connection;
-    };
-    dbConfigs?: {
-        [env: string]: {
-            CLUSTER_NAME: string;
-            DB_URI: string;
-            connectTo?: string[];
-        };
-    };
-}
-interface GetModelShortParams {
-    tenant: string;
-    env?: string;
-    mongodb?: {
-        [clusterName: string]: Connection;
-    };
-    dbConfigs?: {
-        [env: string]: {
-            CLUSTER_NAME: string;
-            DB_URI: string;
-            connectTo?: string[];
-        };
-    };
-    modelName?: string;
-}
-declare const getModelByTenant: <T extends Document = Document>({ tenant, modelName, schema, env, }: GetModelByTenantParams) => Model<T>;
-declare const getAnnotationsModelByTenant: ({ tenant, env, mongodb, dbConfigs, modelName }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
-declare const getPlatformConfigsModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
-declare const getTplModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
-declare const getAIChatModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetModelShortParams) => Model<Document<unknown, any, any, Record<string, any>>, {}, {}, {}, Document<unknown, {}, Document<unknown, any, any, Record<string, any>>, {}> & Document<unknown, any, any, Record<string, any>> & Required<{
-    _id: unknown;
-}> & {
-    __v: number;
-}, any>;
+declare function getModelByTenant({ tenant, modelName, schema, env }: {
+    tenant: any;
+    modelName: any;
+    schema: any;
+    env: any;
+}): any;
+declare function getAIChatModelByTenant({ tenant, env, mongodb, dbConfigs }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+}): any;
+declare function getAnnotationsModelByTenant({ tenant, env, mongodb, dbConfigs, modelName }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+    modelName: any;
+}): any;
+declare function getPlatformConfigsModelByTenant({ tenant, env, mongodb, dbConfigs }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+}): any;
+declare function getTplModelByTenant({ tenant, env, mongodb, dbConfigs }: {
+    tenant: any;
+    env: any;
+    mongodb: any;
+    dbConfigs: any;
+}): any;
 
 interface GetTplParams {
     name: string;
@@ -396,7 +378,7 @@ declare const AIChatSchema: mongoose.Schema<IAIChat, mongoose.Model<IAIChat, any
     __v: number;
 }>;
 
-declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "AI"];
+declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "ai"];
 type PlatformConfigType = typeof platformConfigTypes[number];
 interface IPlatformConfig extends Document {
     type: PlatformConfigType;
@@ -589,4 +571,4 @@ declare function GET_GLOBAL_BULLMQ_CONFIG({ env, redisCredentials }: {
     };
 }): Object;
 
-export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, GET_GLOBAL_BULLMQ_CONFIG, PlatformConfigsSchema, TplSchema, WorkerManager, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, multiConnectToMongoDB, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };
+export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, GET_GLOBAL_BULLMQ_CONFIG, MongoConnector, PlatformConfigsSchema, TplSchema, WorkerManager, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };