@okf/ootils 1.5.6 → 1.6.0

package/dist/node.d.mts

@@ -1,6 +1,6 @@
 import { Client } from '@elastic/elasticsearch';
+import Redis from 'ioredis';
 import mongoose, { Connection, Document, Types } from 'mongoose';
-import IORedis from 'ioredis';
 import * as bullmq from 'bullmq';
 import { Queue } from 'bullmq/dist/esm/classes/queue';
 import { Worker } from 'bullmq/dist/esm/classes/worker';
@@ -79,7 +79,7 @@ interface Section {
     [key: string]: any;
     blocks?: Block[];
 }
-interface Template$1 {
+interface Template {
     category: string;
     kp_templates?: {
         [spaceId: string]: SpaceConfig;
@@ -128,7 +128,7 @@ type BuilderType = 'FormBuilder' | 'MetaBuilder' | 'kp_settings' | string;
  * ```
  */
 declare const extractAllBlocksFromTpl: ({ tpl, buildersWhitelist }: {
-    tpl: Template$1;
+    tpl: Template;
     buildersWhitelist?: BuilderType[];
 }) => ExtractedBlock[];
 /**
@@ -208,6 +208,116 @@ declare namespace ElasticSearchConnector {
     let instance: any;
 }
 
+declare class RedisCacheConnector {
+    static getEnv(): any;
+    static getInstance(): any;
+    static getClient(): any;
+    /**
+     * Find documents in Redis cache
+     * @param {Object} params - Search parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The collection to search in
+     * @param {string} [params.type] - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string. If omitted, returns all documents for the collection.
+     * @returns {Promise<Array>} Array of matching documents
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     */
+    static findConfigsInCache({ tenant, modelName, type }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type?: string | undefined;
+    }): Promise<any[]>;
+    /**
+     * Find a single document in Redis cache (returns first match)
+     * @param {Object} params - Search parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The collection to search in
+     * @param {string} [params.type] - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string. If omitted, returns first document of any type.
+     * @returns {Promise<Object|undefined>} First matching document or undefined if none found
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     */
+    static findOneConfigInCache({ tenant, modelName, type }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type?: string | undefined;
+    }): Promise<Object | undefined>;
+    /**
+     * Generate Redis key for config caching
+     * @private
+     * @param {Object} params - Parameters for key generation
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The model/collection name
+     * @param {string} params.type - The document type
+     * @param {string} [params.env] - Environment (defaults to current env)
+     * @returns {string} The Redis key
+     */
+    private static _getRedisKeyForConfig;
+    /**
+     * Set a single config document in Redis cache
+     * @param {Object} params - Cache parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The model/collection name
+     * @param {string} params.type - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string
+     * @param {Object} params.val - The value to cache
+     * @param {string} [params.env] - Environment (defaults to current env)
+     * @returns {Promise<void>}
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     */
+    static setOneConfigInCache({ tenant, modelName, type, val, env }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type: string;
+        val: Object;
+        env?: string | undefined;
+    }): Promise<void>;
+    /**
+     * Invalidate (delete) a config from Redis cache and optionally set a new value
+     * @param {Object} params - Cache parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The model/collection name
+     * @param {string} params.type - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string
+     * @param {Object} [params.newVal] - New value to set after deletion
+     * @param {string} [params.env] - Environment (defaults to current env)
+     * @returns {Promise<void>}
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     * @note According to the current usecases this function is called only after a database operation.
+     * We should include this function call within the MongoDB transaction.
+     * Otherwise, if the database operation succeeds but cache deletion fails, the cache will hold the outdated data.
+     * We can ignore setAsync failure as we are checking db also if cache is not present (inside findInCache function)
+     */
+    static invalidateOneConfigInCache({ tenant, modelName, type, newVal, env, }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type: string;
+        newVal?: Object | undefined;
+        env?: string | undefined;
+    }): Promise<void>;
+    /**
+     * Load all collections and templates into Redis cache for all tenants
+     * Clears existing cache and rebuilds it from database
+     * @returns {Promise<void>}
+     * @param {string} [params.tenant] - Tenant (either a single tenant or an array of tenants for whom the config cache should be refreshed)
+     * @static
+     */
+    static loadTplsAndPlatformConfigsToCache({ tenant }?: string): Promise<void>;
+    constructor(options?: {});
+    client: Redis | null;
+    host: any;
+    env: any;
+    port: any;
+    password: any;
+    /**
+     * Initialize Redis client
+     */
+    connect: () => Promise<Redis>;
+    /**
+     * Close the Redis client
+     */
+    close(): Promise<void>;
+}
+declare namespace RedisCacheConnector {
+    let instance: any;
+}
+
 /**
  * Get database connection by tenant
  * @param tenant - Tenant identifier for the database
@@ -273,41 +383,6 @@ declare function getTplModelByTenant({ tenant, env, mongodb, dbConfigs }: {
     dbConfigs: any;
 }): any;
 
-interface GetTplParams {
-    name: string;
-    tenant: string;
-}
-interface GetAIConfigsParams {
-    tenant: string;
-}
-interface Template {
-    kp_content_type: string;
-    category: Record<string, string>;
-    kp_templates: Record<string, any>;
-    listing: Record<string, any>;
-    general: Record<string, any>;
-}
-interface Config {
-    enable: boolean;
-    contentTypes?: [{
-        name: string;
-        config?: Record<string, any>;
-    }];
-    defaultConfig: Record<string, any>;
-}
-interface AIconfig {
-    contentChunking: Config;
-    contentEnhance: Config;
-    annoChunking: Config;
-    embedding: Config;
-    aiAnnotation: Config;
-}
-declare const getTpl: ({ name, tenant }: GetTplParams) => Promise<Template>;
-declare const getAIConfigs: ({ tenant }: GetAIConfigsParams) => Promise<AIconfig>;
-
-declare const connectToRedis: () => Promise<void>;
-declare const getRedisClient: () => IORedis;
-
 interface ITagData {
     _id?: Types.ObjectId;
     display: string;
@@ -401,6 +476,7 @@ declare const AIChatSchema: mongoose.Schema<IAIChat, mongoose.Model<IAIChat, any
 }>;
 
 declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "ai"];
+
 type PlatformConfigType = typeof platformConfigTypes[number];
 interface IPlatformConfig extends Document {
     type: PlatformConfigType;
@@ -629,4 +705,4 @@ declare function GET_GLOBAL_BULLMQ_CONFIG({ env, redisCredentials }: {
     };
 }): Object;
 
-export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, ElasticSearchConnector, GET_GLOBAL_BULLMQ_CONFIG, MongoConnector, PlatformConfigsSchema, ProducerManager, TplSchema, WorkerManager, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };
+export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, ElasticSearchConnector, GET_GLOBAL_BULLMQ_CONFIG, MongoConnector, PlatformConfigsSchema, ProducerManager, RedisCacheConnector, TplSchema, WorkerManager, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getTplModelByTenant, getVal, initializeGlobalConfig, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };

package/dist/node.d.ts

@@ -1,6 +1,6 @@
 import { Client } from '@elastic/elasticsearch';
+import Redis from 'ioredis';
 import mongoose, { Connection, Document, Types } from 'mongoose';
-import IORedis from 'ioredis';
 import * as bullmq from 'bullmq';
 import { Queue } from 'bullmq/dist/esm/classes/queue';
 import { Worker } from 'bullmq/dist/esm/classes/worker';
@@ -79,7 +79,7 @@ interface Section {
     [key: string]: any;
     blocks?: Block[];
 }
-interface Template$1 {
+interface Template {
     category: string;
     kp_templates?: {
         [spaceId: string]: SpaceConfig;
@@ -128,7 +128,7 @@ type BuilderType = 'FormBuilder' | 'MetaBuilder' | 'kp_settings' | string;
  * ```
  */
 declare const extractAllBlocksFromTpl: ({ tpl, buildersWhitelist }: {
-    tpl: Template$1;
+    tpl: Template;
     buildersWhitelist?: BuilderType[];
 }) => ExtractedBlock[];
 /**
@@ -208,6 +208,116 @@ declare namespace ElasticSearchConnector {
     let instance: any;
 }
 
+declare class RedisCacheConnector {
+    static getEnv(): any;
+    static getInstance(): any;
+    static getClient(): any;
+    /**
+     * Find documents in Redis cache
+     * @param {Object} params - Search parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The collection to search in
+     * @param {string} [params.type] - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string. If omitted, returns all documents for the collection.
+     * @returns {Promise<Array>} Array of matching documents
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     */
+    static findConfigsInCache({ tenant, modelName, type }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type?: string | undefined;
+    }): Promise<any[]>;
+    /**
+     * Find a single document in Redis cache (returns first match)
+     * @param {Object} params - Search parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The collection to search in
+     * @param {string} [params.type] - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string. If omitted, returns first document of any type.
+     * @returns {Promise<Object|undefined>} First matching document or undefined if none found
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     */
+    static findOneConfigInCache({ tenant, modelName, type }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type?: string | undefined;
+    }): Promise<Object | undefined>;
+    /**
+     * Generate Redis key for config caching
+     * @private
+     * @param {Object} params - Parameters for key generation
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The model/collection name
+     * @param {string} params.type - The document type
+     * @param {string} [params.env] - Environment (defaults to current env)
+     * @returns {string} The Redis key
+     */
+    private static _getRedisKeyForConfig;
+    /**
+     * Set a single config document in Redis cache
+     * @param {Object} params - Cache parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The model/collection name
+     * @param {string} params.type - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string
+     * @param {Object} params.val - The value to cache
+     * @param {string} [params.env] - Environment (defaults to current env)
+     * @returns {Promise<void>}
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     */
+    static setOneConfigInCache({ tenant, modelName, type, val, env }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type: string;
+        val: Object;
+        env?: string | undefined;
+    }): Promise<void>;
+    /**
+     * Invalidate (delete) a config from Redis cache and optionally set a new value
+     * @param {Object} params - Cache parameters
+     * @param {string} params.tenant - The tenant identifier
+     * @param {'platformConfigs'|'tpl'} params.modelName - The model/collection name
+     * @param {string} params.type - When modelName='platformConfigs': one of platformConfigTypes array values; when modelName='tpl': content type string
+     * @param {Object} [params.newVal] - New value to set after deletion
+     * @param {string} [params.env] - Environment (defaults to current env)
+     * @returns {Promise<void>}
+     * @see {platformConfigTypes} for valid platformConfigs type values
+     * @note According to the current usecases this function is called only after a database operation.
+     * We should include this function call within the MongoDB transaction.
+     * Otherwise, if the database operation succeeds but cache deletion fails, the cache will hold the outdated data.
+     * We can ignore setAsync failure as we are checking db also if cache is not present (inside findInCache function)
+     */
+    static invalidateOneConfigInCache({ tenant, modelName, type, newVal, env, }: {
+        tenant: string;
+        modelName: "platformConfigs" | "tpl";
+        type: string;
+        newVal?: Object | undefined;
+        env?: string | undefined;
+    }): Promise<void>;
+    /**
+     * Load all collections and templates into Redis cache for all tenants
+     * Clears existing cache and rebuilds it from database
+     * @returns {Promise<void>}
+     * @param {string} [params.tenant] - Tenant (either a single tenant or an array of tenants for whom the config cache should be refreshed)
+     * @static
+     */
+    static loadTplsAndPlatformConfigsToCache({ tenant }?: string): Promise<void>;
+    constructor(options?: {});
+    client: Redis | null;
+    host: any;
+    env: any;
+    port: any;
+    password: any;
+    /**
+     * Initialize Redis client
+     */
+    connect: () => Promise<Redis>;
+    /**
+     * Close the Redis client
+     */
+    close(): Promise<void>;
+}
+declare namespace RedisCacheConnector {
+    let instance: any;
+}
+
 /**
  * Get database connection by tenant
  * @param tenant - Tenant identifier for the database
@@ -273,41 +383,6 @@ declare function getTplModelByTenant({ tenant, env, mongodb, dbConfigs }: {
     dbConfigs: any;
 }): any;
 
-interface GetTplParams {
-    name: string;
-    tenant: string;
-}
-interface GetAIConfigsParams {
-    tenant: string;
-}
-interface Template {
-    kp_content_type: string;
-    category: Record<string, string>;
-    kp_templates: Record<string, any>;
-    listing: Record<string, any>;
-    general: Record<string, any>;
-}
-interface Config {
-    enable: boolean;
-    contentTypes?: [{
-        name: string;
-        config?: Record<string, any>;
-    }];
-    defaultConfig: Record<string, any>;
-}
-interface AIconfig {
-    contentChunking: Config;
-    contentEnhance: Config;
-    annoChunking: Config;
-    embedding: Config;
-    aiAnnotation: Config;
-}
-declare const getTpl: ({ name, tenant }: GetTplParams) => Promise<Template>;
-declare const getAIConfigs: ({ tenant }: GetAIConfigsParams) => Promise<AIconfig>;
-
-declare const connectToRedis: () => Promise<void>;
-declare const getRedisClient: () => IORedis;
-
 interface ITagData {
     _id?: Types.ObjectId;
     display: string;
@@ -401,6 +476,7 @@ declare const AIChatSchema: mongoose.Schema<IAIChat, mongoose.Model<IAIChat, any
 }>;
 
 declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "ai"];
+
 type PlatformConfigType = typeof platformConfigTypes[number];
 interface IPlatformConfig extends Document {
     type: PlatformConfigType;
@@ -629,4 +705,4 @@ declare function GET_GLOBAL_BULLMQ_CONFIG({ env, redisCredentials }: {
     };
 }): Object;
 
-export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, ElasticSearchConnector, GET_GLOBAL_BULLMQ_CONFIG, MongoConnector, PlatformConfigsSchema, ProducerManager, TplSchema, WorkerManager, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };
+export { AIChatSchema, AnnotationSchema, BaseProducer, BaseWorker, ElasticSearchConnector, GET_GLOBAL_BULLMQ_CONFIG, MongoConnector, PlatformConfigsSchema, ProducerManager, RedisCacheConnector, TplSchema, WorkerManager, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getTplModelByTenant, getVal, initializeGlobalConfig, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };