@okf/ootils 1.3.6 → 1.3.7

package/dist/node.d.mts

@@ -1,4 +1,4 @@
-import { Connection, Document, Schema, Model } from 'mongoose';
+import mongoose, { Connection, Document, Schema, Model, Types } from 'mongoose';
 import IORedis from 'ioredis';
 
 declare const deleteVal: (data: any, valuePath: string) => any;
@@ -242,9 +242,10 @@ interface GetModelShortParams {
             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 }: 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<{
+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;
@@ -259,6 +260,11 @@ declare const getTplModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetMode
 }> & {
     __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>;
 
 interface GetTplParams {
     name: string;
@@ -295,4 +301,199 @@ declare const getAIConfigs: ({ tenant }: GetAIConfigsParams) => Promise<AIconfig
 declare const connectToRedis: () => Promise<void>;
 declare const getRedisClient: () => IORedis;
 
-export { connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, multiConnectToMongoDB, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };
+interface ITagData {
+    _id?: Types.ObjectId;
+    display: string;
+    tagId: string;
+}
+interface ITagCollection {
+    data: ITagData[];
+    collectionId: string;
+}
+interface IMeta {
+    contentType: string;
+    kp_contributed_by?: Types.ObjectId;
+    valuePath?: string;
+    documentId?: Types.ObjectId;
+}
+interface IAuthor {
+    id?: Types.ObjectId;
+    name?: string;
+}
+interface IFragment {
+    isLexical?: boolean;
+    editorState?: any;
+    allText?: string;
+}
+interface IAnnotations {
+    tags?: Map<string, ITagCollection>;
+    fragment?: IFragment;
+    annoKey?: string;
+    author?: IAuthor;
+}
+interface IAnnotation extends Document {
+    tags?: Map<string, ITagCollection>;
+    meta: IMeta;
+    main?: any;
+    annotations?: IAnnotations;
+    embeddings?: any[];
+    contentEnhancedText?: string;
+    clusterId?: string;
+    kp_date_published?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+    topicId?: Types.ObjectId[];
+    translations?: any;
+    displayTitle: string;
+    getMainField(fieldPath?: string): any;
+}
+declare const AnnotationSchema: mongoose.Schema<IAnnotation, mongoose.Model<IAnnotation, any, any, any, mongoose.Document<unknown, any, IAnnotation, any> & IAnnotation & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IAnnotation, mongoose.Document<unknown, {}, mongoose.FlatRecord<IAnnotation>, {}> & mongoose.FlatRecord<IAnnotation> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+interface IMessage {
+    id: string;
+    author: "system" | "user" | "assistant";
+    content: {
+        type: string;
+        value: string;
+    };
+    vectorSearchInfo: {
+        chunks: typeof AnnotationSchema[];
+    };
+    args: {
+        query: string;
+        reframedQuery: string;
+        summary: object;
+    };
+    userFeedback: {
+        reaction: "positive" | "negative";
+        comments: string;
+    };
+}
+interface IAIChat extends Document {
+    userId: mongoose.Schema.Types.ObjectId;
+    createdAt: Date;
+    lastAcitivity: Date;
+    messages: IMessage[];
+}
+declare const AIChatSchema: mongoose.Schema<IAIChat, mongoose.Model<IAIChat, any, any, any, mongoose.Document<unknown, any, IAIChat, any> & IAIChat & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IAIChat, mongoose.Document<unknown, {}, mongoose.FlatRecord<IAIChat>, {}> & mongoose.FlatRecord<IAIChat> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "AI"];
+type PlatformConfigType = typeof platformConfigTypes[number];
+interface IPlatformConfig extends Document {
+    type: PlatformConfigType;
+    roles?: any[];
+    data?: any;
+}
+declare const PlatformConfigsSchema: mongoose.Schema<IPlatformConfig, mongoose.Model<IPlatformConfig, any, any, any, mongoose.Document<unknown, any, IPlatformConfig, any> & IPlatformConfig & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IPlatformConfig, mongoose.Document<unknown, {}, mongoose.FlatRecord<IPlatformConfig>, {}> & mongoose.FlatRecord<IPlatformConfig> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+interface IGeneral {
+    content?: {
+        title?: string;
+        singular?: string;
+        ctaText?: string;
+        listingDesc?: string;
+    };
+    allowQuickTagCreation?: {
+        enable?: boolean;
+    };
+    segment?: string;
+    settingsUIStyle?: string;
+    hasUpdateType?: boolean;
+    annotation?: {
+        enable?: boolean;
+    };
+    participantModule?: {
+        enable?: boolean;
+    };
+    formFieldNumbering?: {
+        enable?: boolean;
+    };
+    postPblRedirPath?: object;
+    templateIndex?: object;
+    sharing?: {
+        enable?: boolean;
+        trackShareCount?: boolean;
+    };
+    viewsCount?: {
+        enable?: boolean;
+    };
+    comments?: {
+        enable?: boolean;
+    };
+    reactions?: Map<string, {
+        enable?: boolean;
+        icon?: string;
+    }>;
+    csvExport?: {
+        enable?: boolean;
+        excludeFields?: any[];
+        enableUpdateExport?: boolean;
+        fieldsToSortAtEnd?: any[];
+        fetchBatches?: {
+            enable?: boolean;
+            batchSize?: number;
+        };
+    };
+    onboardingFlow?: object;
+    selfServeSurveyConfig?: object;
+    disableKPSettings?: boolean;
+}
+interface ITplDocument extends Document {
+    dateFirstPublished?: Date;
+    dateCreated?: Date;
+    dateLastPublished?: Date;
+    dateLastEdited?: Date;
+    status: 'unpublished' | 'editPublished' | 'published';
+    version: number;
+    versionPublishedBy?: mongoose.Schema.Types.ObjectId;
+    firstPublishedBy?: mongoose.Schema.Types.ObjectId;
+    kp_content_type: string;
+    category: string;
+    kp_settings: object[];
+    kp_templates?: object;
+    tplMeta?: object;
+    tplLocales?: object;
+    indexed?: object;
+    drafts?: {
+        active?: object;
+    };
+    rollbacks?: object;
+    listing?: object;
+    general?: IGeneral;
+    layout: string;
+}
+declare const TplSchema: mongoose.Schema<ITplDocument, mongoose.Model<ITplDocument, any, any, any, mongoose.Document<unknown, any, ITplDocument, any> & ITplDocument & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, ITplDocument, mongoose.Document<unknown, {}, mongoose.FlatRecord<ITplDocument>, {}> & mongoose.FlatRecord<ITplDocument> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+export { AIChatSchema, AnnotationSchema, PlatformConfigsSchema, TplSchema, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, multiConnectToMongoDB, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };

package/dist/node.d.ts

@@ -1,4 +1,4 @@
-import { Connection, Document, Schema, Model } from 'mongoose';
+import mongoose, { Connection, Document, Schema, Model, Types } from 'mongoose';
 import IORedis from 'ioredis';
 
 declare const deleteVal: (data: any, valuePath: string) => any;
@@ -242,9 +242,10 @@ interface GetModelShortParams {
             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 }: 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<{
+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;
@@ -259,6 +260,11 @@ declare const getTplModelByTenant: ({ tenant, env, mongodb, dbConfigs }: GetMode
 }> & {
     __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>;
 
 interface GetTplParams {
     name: string;
@@ -295,4 +301,199 @@ declare const getAIConfigs: ({ tenant }: GetAIConfigsParams) => Promise<AIconfig
 declare const connectToRedis: () => Promise<void>;
 declare const getRedisClient: () => IORedis;
 
-export { connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, multiConnectToMongoDB, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };
+interface ITagData {
+    _id?: Types.ObjectId;
+    display: string;
+    tagId: string;
+}
+interface ITagCollection {
+    data: ITagData[];
+    collectionId: string;
+}
+interface IMeta {
+    contentType: string;
+    kp_contributed_by?: Types.ObjectId;
+    valuePath?: string;
+    documentId?: Types.ObjectId;
+}
+interface IAuthor {
+    id?: Types.ObjectId;
+    name?: string;
+}
+interface IFragment {
+    isLexical?: boolean;
+    editorState?: any;
+    allText?: string;
+}
+interface IAnnotations {
+    tags?: Map<string, ITagCollection>;
+    fragment?: IFragment;
+    annoKey?: string;
+    author?: IAuthor;
+}
+interface IAnnotation extends Document {
+    tags?: Map<string, ITagCollection>;
+    meta: IMeta;
+    main?: any;
+    annotations?: IAnnotations;
+    embeddings?: any[];
+    contentEnhancedText?: string;
+    clusterId?: string;
+    kp_date_published?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+    topicId?: Types.ObjectId[];
+    translations?: any;
+    displayTitle: string;
+    getMainField(fieldPath?: string): any;
+}
+declare const AnnotationSchema: mongoose.Schema<IAnnotation, mongoose.Model<IAnnotation, any, any, any, mongoose.Document<unknown, any, IAnnotation, any> & IAnnotation & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IAnnotation, mongoose.Document<unknown, {}, mongoose.FlatRecord<IAnnotation>, {}> & mongoose.FlatRecord<IAnnotation> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+interface IMessage {
+    id: string;
+    author: "system" | "user" | "assistant";
+    content: {
+        type: string;
+        value: string;
+    };
+    vectorSearchInfo: {
+        chunks: typeof AnnotationSchema[];
+    };
+    args: {
+        query: string;
+        reframedQuery: string;
+        summary: object;
+    };
+    userFeedback: {
+        reaction: "positive" | "negative";
+        comments: string;
+    };
+}
+interface IAIChat extends Document {
+    userId: mongoose.Schema.Types.ObjectId;
+    createdAt: Date;
+    lastAcitivity: Date;
+    messages: IMessage[];
+}
+declare const AIChatSchema: mongoose.Schema<IAIChat, mongoose.Model<IAIChat, any, any, any, mongoose.Document<unknown, any, IAIChat, any> & IAIChat & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IAIChat, mongoose.Document<unknown, {}, mongoose.FlatRecord<IAIChat>, {}> & mongoose.FlatRecord<IAIChat> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+declare const platformConfigTypes: readonly ["roles", "nav", "deployment", "userAgreement", "localeData", "theme", "AI"];
+type PlatformConfigType = typeof platformConfigTypes[number];
+interface IPlatformConfig extends Document {
+    type: PlatformConfigType;
+    roles?: any[];
+    data?: any;
+}
+declare const PlatformConfigsSchema: mongoose.Schema<IPlatformConfig, mongoose.Model<IPlatformConfig, any, any, any, mongoose.Document<unknown, any, IPlatformConfig, any> & IPlatformConfig & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, IPlatformConfig, mongoose.Document<unknown, {}, mongoose.FlatRecord<IPlatformConfig>, {}> & mongoose.FlatRecord<IPlatformConfig> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+interface IGeneral {
+    content?: {
+        title?: string;
+        singular?: string;
+        ctaText?: string;
+        listingDesc?: string;
+    };
+    allowQuickTagCreation?: {
+        enable?: boolean;
+    };
+    segment?: string;
+    settingsUIStyle?: string;
+    hasUpdateType?: boolean;
+    annotation?: {
+        enable?: boolean;
+    };
+    participantModule?: {
+        enable?: boolean;
+    };
+    formFieldNumbering?: {
+        enable?: boolean;
+    };
+    postPblRedirPath?: object;
+    templateIndex?: object;
+    sharing?: {
+        enable?: boolean;
+        trackShareCount?: boolean;
+    };
+    viewsCount?: {
+        enable?: boolean;
+    };
+    comments?: {
+        enable?: boolean;
+    };
+    reactions?: Map<string, {
+        enable?: boolean;
+        icon?: string;
+    }>;
+    csvExport?: {
+        enable?: boolean;
+        excludeFields?: any[];
+        enableUpdateExport?: boolean;
+        fieldsToSortAtEnd?: any[];
+        fetchBatches?: {
+            enable?: boolean;
+            batchSize?: number;
+        };
+    };
+    onboardingFlow?: object;
+    selfServeSurveyConfig?: object;
+    disableKPSettings?: boolean;
+}
+interface ITplDocument extends Document {
+    dateFirstPublished?: Date;
+    dateCreated?: Date;
+    dateLastPublished?: Date;
+    dateLastEdited?: Date;
+    status: 'unpublished' | 'editPublished' | 'published';
+    version: number;
+    versionPublishedBy?: mongoose.Schema.Types.ObjectId;
+    firstPublishedBy?: mongoose.Schema.Types.ObjectId;
+    kp_content_type: string;
+    category: string;
+    kp_settings: object[];
+    kp_templates?: object;
+    tplMeta?: object;
+    tplLocales?: object;
+    indexed?: object;
+    drafts?: {
+        active?: object;
+    };
+    rollbacks?: object;
+    listing?: object;
+    general?: IGeneral;
+    layout: string;
+}
+declare const TplSchema: mongoose.Schema<ITplDocument, mongoose.Model<ITplDocument, any, any, any, mongoose.Document<unknown, any, ITplDocument, any> & ITplDocument & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, ITplDocument, mongoose.Document<unknown, {}, mongoose.FlatRecord<ITplDocument>, {}> & mongoose.FlatRecord<ITplDocument> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+
+export { AIChatSchema, AnnotationSchema, PlatformConfigsSchema, TplSchema, connectToRedis, deleteVal, extractAllBlocksFromTpl, genTagId, getAIChatModelByTenant, getAIConfigs, getAnnotationsModelByTenant, getDbByTenant, getModelByTenant, getPlatformConfigsModelByTenant, getRedisClient, getTpl, getTplModelByTenant, getVal, initializeGlobalConfig, multiConnectToMongoDB, _recursExtractBlocks as recursivelyExtractBlocks, setVal, toArray, updateGlobalConfig };