@intlayer/backend 5.3.13 → 5.4.0-canary.0

package/dist/esm/controllers/ai.controller.mjs

@@ -1,6 +1,7 @@
+import { DiscussionModel } from "./../models/discussion.model.mjs";
 import { getDictionariesByTags } from "./../services/dictionary.service.mjs";
-import { getTagsByKeys } from "./../services/tag.service.mjs";
 import * as tagService from "./../services/tag.service.mjs";
+import { getTagsByKeys } from "./../services/tag.service.mjs";
 import * as askDocQuestionUtil from "./../utils/AI/askDocQuestion/askDocQuestion.mjs";
 import * as auditContentDeclarationUtil from "./../utils/AI/auditDictionary/index.mjs";
 import * as auditContentDeclarationFieldUtil from "./../utils/AI/auditDictionaryField/index.mjs";
@@ -181,17 +182,55 @@ const auditTag = async (req, res, _next) => {
   }
 };
 const askDocQuestion = async (req, res) => {
-  const { messages } = req.body;
-  try {
-    const response = await askDocQuestionUtil.askDocQuestion(messages);
-    const responseData = formatResponse({
-      data: response
-    });
-    res.json(responseData);
-  } catch (error) {
-    ErrorHandler.handleAppErrorResponse(res, error);
-    return;
-  }
+  const { messages, discutionId } = req.body;
+  const { user, project, organization } = res.locals;
+  res.setHeader("Content-Type", "text/event-stream; charset=utf-8");
+  res.setHeader("Cache-Control", "no-cache, no-transform");
+  res.setHeader("Connection", "keep-alive");
+  res.setHeader("X-Accel-Buffering", "no");
+  res.flushHeaders?.();
+  res.write(": connected\n\n");
+  res.flush?.();
+  askDocQuestionUtil.askDocQuestion(messages, {
+    onMessage: (chunk) => {
+      res.write(`data: ${JSON.stringify({ chunk })}
+
+`);
+      res.flush?.();
+    }
+  }).then(async (fullResponse) => {
+    await DiscussionModel.findOneAndUpdate(
+      { discutionId },
+      {
+        $set: {
+          discutionId,
+          userId: user?._id,
+          projectId: project?._id,
+          organizationId: organization?._id,
+          messages: messages.map((msg) => ({
+            role: msg.role,
+            content: msg.content,
+            timestamp: /* @__PURE__ */ new Date()
+          }))
+        }
+      },
+      { upsert: true, new: true }
+    );
+    res.write(
+      `data: ${JSON.stringify({ done: true, response: fullResponse })}
+
+`
+    );
+    res.end();
+  }).catch((err) => {
+    res.write(
+      `event: error
+data: ${JSON.stringify({ message: err.message })}
+
+`
+    );
+    res.end();
+  });
 };
 const autocomplete = async (req, res) => {
   try {

package/dist/esm/controllers/ai.controller.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/controllers/ai.controller.ts"],"sourcesContent":["import { type KeyPath } from '@intlayer/core';\nimport type { ResponseWithInformation } from '@middlewares/sessionAuth.middleware';\nimport { getDictionariesByTags } from '@services/dictionary.service';\nimport { getTagsByKeys } from '@services/tag.service';\nimport * as tagService from '@services/tag.service';\nimport * as askDocQuestionUtil from '@utils/AI/askDocQuestion/askDocQuestion';\nimport * as auditContentDeclarationUtil from '@utils/AI/auditDictionary';\nimport * as auditContentDeclarationFieldUtil from '@utils/AI/auditDictionaryField';\nimport * as auditContentDeclarationMetadataUtil from '@utils/AI/auditDictionaryMetadata';\nimport * as autocompleteUtil from '@utils/AI/autocomplete';\nimport * as auditTagUtil from '@utils/auditTag';\nimport { type AppError, ErrorHandler } from '@utils/errors';\nimport { formatResponse, type ResponseData } from '@utils/responseData';\nimport type { NextFunction, Request } from 'express';\nimport type { Locales } from 'intlayer';\nimport type { Dictionary } from '@/types/dictionary.types';\nimport type { Tag } from '@/types/tag.types';\n\nexport type AuditContentDeclarationBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  locales: Locales[];\n  defaultLocale: Locales;\n  fileContent: string;\n  filePath?: string;\n  model?: string;\n  temperature?: number;\n  tagsKeys?: string[];\n};\nexport type AuditContentDeclarationResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditContentDeclaration = async (\n  req: Request<AuditContentDeclarationBody>,\n  res: ResponseWithInformation<AuditContentDeclarationResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, project, organization } = res.locals;\n  const {\n    fileContent,\n    filePath,\n    openAiApiKey,\n    customPrompt,\n    model,\n    temperature,\n    locales,\n    defaultLocale,\n    tagsKeys,\n  } = req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    let tags: Tag[] = [];\n\n    if (project?.organizationId) {\n      tags = await getTagsByKeys(tagsKeys, project.organizationId);\n    }\n\n    const auditResponse = await auditContentDeclarationUtil.auditDictionary({\n      fileContent,\n      filePath,\n      model,\n      temperature,\n      openAiApiKey,\n      customPrompt,\n      locales,\n      defaultLocale,\n      tags,\n    });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AuditContentDeclarationFieldBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  locales: Locales[];\n  fileContent: string;\n  filePath?: string;\n  model?: string;\n  temperature?: number;\n  tagsKeys?: string[];\n  keyPath: KeyPath[];\n};\nexport type AuditContentDeclarationFieldResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditContentDeclarationField = async (\n  req: Request<AuditContentDeclarationFieldBody>,\n  res: ResponseWithInformation<AuditContentDeclarationFieldResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, project, organization } = res.locals;\n  const {\n    fileContent,\n    openAiApiKey,\n    customPrompt,\n    model,\n    temperature,\n    locales,\n    tagsKeys,\n    keyPath,\n  } = req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    let tags: Tag[] = [];\n\n    if (project?.organizationId) {\n      tags = await getTagsByKeys(tagsKeys, project.organizationId);\n    }\n\n    const auditResponse =\n      await auditContentDeclarationFieldUtil.auditDictionaryField({\n        fileContent,\n        model,\n        temperature,\n        openAiApiKey,\n        customPrompt,\n        locales,\n        tags,\n        keyPath,\n      });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AuditContentDeclarationMetadataBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  fileContent: string;\n  model?: string;\n  temperature?: number;\n};\nexport type AuditContentDeclarationMetadataResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditContentDeclarationMetadata = async (\n  req: Request<AuditContentDeclarationMetadataBody>,\n  res: ResponseWithInformation<AuditContentDeclarationMetadataResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, organization, project } = res.locals;\n  const { fileContent, openAiApiKey, customPrompt, model, temperature } =\n    req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    const tags: Tag[] = await tagService.findTags(\n      {\n        organizationId: organization?._id,\n      },\n      0,\n      1000\n    );\n\n    const auditResponse =\n      await auditContentDeclarationMetadataUtil.auditDictionaryMetadata({\n        fileContent,\n        model,\n        openAiApiKey,\n        temperature,\n        customPrompt,\n        tags,\n      });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AuditTagBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  filePath?: string;\n  model?: string;\n  temperature?: number;\n  tag: Tag;\n};\nexport type AuditTagResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditTag = async (\n  req: Request<undefined, undefined, AuditTagBody>,\n  res: ResponseWithInformation<AuditTagResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, project, organization } = res.locals;\n  const { openAiApiKey, customPrompt, model, temperature, tag } = req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    let dictionaries: Dictionary[] = [];\n    if (project?.organizationId) {\n      dictionaries = await getDictionariesByTags([tag.key], project._id);\n    }\n\n    const auditResponse = await auditTagUtil.auditTag({\n      model,\n      openAiApiKey,\n      temperature,\n      customPrompt,\n      dictionaries,\n      tag,\n    });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AskDocQuestionBody = {\n  messages: askDocQuestionUtil.ChatCompletionRequestMessage[];\n};\nexport type AskDocQuestionResult =\n  ResponseData<askDocQuestionUtil.AskDocQuestionResult>;\n\nexport const askDocQuestion = async (\n  req: Request<undefined, undefined, AskDocQuestionBody>,\n  res: ResponseWithInformation<AskDocQuestionResult>\n) => {\n  const { messages } = req.body;\n  try {\n    const response = await askDocQuestionUtil.askDocQuestion(messages);\n\n    const responseData =\n      formatResponse<askDocQuestionUtil.AskDocQuestionResult>({\n        data: response,\n      });\n\n    res.json(responseData);\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AutocompleteBody = {\n  text: string;\n  model?: string;\n  temperature?: number;\n  openAiApiKey?: string;\n  customPrompt?: string;\n};\n\nexport type AutocompleteResponse = ResponseData<{\n  autocompletion: string;\n}>;\n\nexport const autocomplete = async (\n  req: Request<undefined, undefined, AutocompleteBody>,\n  res: ResponseWithInformation<AutocompleteResponse>\n) => {\n  try {\n    const { text, model, openAiApiKey, customPrompt, temperature } = req.body;\n    const { user, project, organization } = res.locals;\n\n    if (!openAiApiKey) {\n      if (!user || !project || !organization) {\n        ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n        return;\n      }\n    }\n\n    const response = (await autocompleteUtil.autocomplete({\n      text,\n      model,\n      openAiApiKey,\n      temperature,\n      customPrompt,\n    })) ?? {\n      autocompletion: '',\n      tokenUsed: 0,\n    };\n\n    const responseData =\n      formatResponse<autocompleteUtil.AutocompleteFileResultData>({\n        data: response,\n      });\n\n    res.json(responseData);\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n"],"mappings":"AAEA,SAAS,6BAA6B;AACtC,SAAS,qBAAqB;AAC9B,YAAY,gBAAgB;AAC5B,YAAY,wBAAwB;AACpC,YAAY,iCAAiC;AAC7C,YAAY,sCAAsC;AAClD,YAAY,yCAAyC;AACrD,YAAY,sBAAsB;AAClC,YAAY,kBAAkB;AAC9B,SAAwB,oBAAoB;AAC5C,SAAS,sBAAyC;AAuB3C,MAAM,0BAA0B,OACrC,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAC5C,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,IAAI;AAER,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,QAAI,OAAc,CAAC;AAEnB,QAAI,SAAS,gBAAgB;AAC3B,aAAO,MAAM,cAAc,UAAU,QAAQ,cAAc;AAAA,IAC7D;AAEA,UAAM,gBAAgB,MAAM,4BAA4B,gBAAgB;AAAA,MACtE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAmBO,MAAM,+BAA+B,OAC1C,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAC5C,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,IAAI;AAER,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,QAAI,OAAc,CAAC;AAEnB,QAAI,SAAS,gBAAgB;AAC3B,aAAO,MAAM,cAAc,UAAU,QAAQ,cAAc;AAAA,IAC7D;AAEA,UAAM,gBACJ,MAAM,iCAAiC,qBAAqB;AAAA,MAC1D;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAEH,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAeO,MAAM,kCAAkC,OAC7C,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,cAAc,QAAQ,IAAI,IAAI;AAC5C,QAAM,EAAE,aAAa,cAAc,cAAc,OAAO,YAAY,IAClE,IAAI;AAEN,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,UAAM,OAAc,MAAM,WAAW;AAAA,MACnC;AAAA,QACE,gBAAgB,cAAc;AAAA,MAChC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,UAAM,gBACJ,MAAM,oCAAoC,wBAAwB;AAAA,MAChE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAEH,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAgBO,MAAM,WAAW,OACtB,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAC5C,QAAM,EAAE,cAAc,cAAc,OAAO,aAAa,IAAI,IAAI,IAAI;AAEpE,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,QAAI,eAA6B,CAAC;AAClC,QAAI,SAAS,gBAAgB;AAC3B,qBAAe,MAAM,sBAAsB,CAAC,IAAI,GAAG,GAAG,QAAQ,GAAG;AAAA,IACnE;AAEA,UAAM,gBAAgB,MAAM,aAAa,SAAS;AAAA,MAChD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAQO,MAAM,iBAAiB,OAC5B,KACA,QACG;AACH,QAAM,EAAE,SAAS,IAAI,IAAI;AACzB,MAAI;AACF,UAAM,WAAW,MAAM,mBAAmB,eAAe,QAAQ;AAEjE,UAAM,eACJ,eAAwD;AAAA,MACtD,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AAAA,EACvB,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAcO,MAAM,eAAe,OAC1B,KACA,QACG;AACH,MAAI;AACF,UAAM,EAAE,MAAM,OAAO,cAAc,cAAc,YAAY,IAAI,IAAI;AACrE,UAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAE5C,QAAI,CAAC,cAAc;AACjB,UAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,qBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,MACF;AAAA,IACF;AAEA,UAAM,WAAY,MAAM,iBAAiB,aAAa;AAAA,MACpD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,KAAM;AAAA,MACL,gBAAgB;AAAA,MAChB,WAAW;AAAA,IACb;AAEA,UAAM,eACJ,eAA4D;AAAA,MAC1D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AAAA,EACvB,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../../src/controllers/ai.controller.ts"],"sourcesContent":["import { DiscussionModel } from '@/models/discussion.model';\nimport type { Dictionary } from '@/types/dictionary.types';\nimport type { Tag } from '@/types/tag.types';\nimport { type KeyPath } from '@intlayer/core';\nimport type { ResponseWithInformation } from '@middlewares/sessionAuth.middleware';\nimport { getDictionariesByTags } from '@services/dictionary.service';\nimport * as tagService from '@services/tag.service';\nimport { getTagsByKeys } from '@services/tag.service';\nimport * as askDocQuestionUtil from '@utils/AI/askDocQuestion/askDocQuestion';\nimport * as auditContentDeclarationUtil from '@utils/AI/auditDictionary';\nimport * as auditContentDeclarationFieldUtil from '@utils/AI/auditDictionaryField';\nimport * as auditContentDeclarationMetadataUtil from '@utils/AI/auditDictionaryMetadata';\nimport * as autocompleteUtil from '@utils/AI/autocomplete';\nimport * as auditTagUtil from '@utils/auditTag';\nimport { type AppError, ErrorHandler } from '@utils/errors';\nimport { formatResponse, type ResponseData } from '@utils/responseData';\nimport type { NextFunction, Request } from 'express';\nimport type { Locales } from 'intlayer';\n\nexport type AuditContentDeclarationBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  locales: Locales[];\n  defaultLocale: Locales;\n  fileContent: string;\n  filePath?: string;\n  model?: string;\n  temperature?: number;\n  tagsKeys?: string[];\n};\nexport type AuditContentDeclarationResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditContentDeclaration = async (\n  req: Request<AuditContentDeclarationBody>,\n  res: ResponseWithInformation<AuditContentDeclarationResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, project, organization } = res.locals;\n  const {\n    fileContent,\n    filePath,\n    openAiApiKey,\n    customPrompt,\n    model,\n    temperature,\n    locales,\n    defaultLocale,\n    tagsKeys,\n  } = req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    let tags: Tag[] = [];\n\n    if (project?.organizationId) {\n      tags = await getTagsByKeys(tagsKeys, project.organizationId);\n    }\n\n    const auditResponse = await auditContentDeclarationUtil.auditDictionary({\n      fileContent,\n      filePath,\n      model,\n      temperature,\n      openAiApiKey,\n      customPrompt,\n      locales,\n      defaultLocale,\n      tags,\n    });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AuditContentDeclarationFieldBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  locales: Locales[];\n  fileContent: string;\n  filePath?: string;\n  model?: string;\n  temperature?: number;\n  tagsKeys?: string[];\n  keyPath: KeyPath[];\n};\nexport type AuditContentDeclarationFieldResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditContentDeclarationField = async (\n  req: Request<AuditContentDeclarationFieldBody>,\n  res: ResponseWithInformation<AuditContentDeclarationFieldResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, project, organization } = res.locals;\n  const {\n    fileContent,\n    openAiApiKey,\n    customPrompt,\n    model,\n    temperature,\n    locales,\n    tagsKeys,\n    keyPath,\n  } = req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    let tags: Tag[] = [];\n\n    if (project?.organizationId) {\n      tags = await getTagsByKeys(tagsKeys, project.organizationId);\n    }\n\n    const auditResponse =\n      await auditContentDeclarationFieldUtil.auditDictionaryField({\n        fileContent,\n        model,\n        temperature,\n        openAiApiKey,\n        customPrompt,\n        locales,\n        tags,\n        keyPath,\n      });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AuditContentDeclarationMetadataBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  fileContent: string;\n  model?: string;\n  temperature?: number;\n};\nexport type AuditContentDeclarationMetadataResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditContentDeclarationMetadata = async (\n  req: Request<AuditContentDeclarationMetadataBody>,\n  res: ResponseWithInformation<AuditContentDeclarationMetadataResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, organization, project } = res.locals;\n  const { fileContent, openAiApiKey, customPrompt, model, temperature } =\n    req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    const tags: Tag[] = await tagService.findTags(\n      {\n        organizationId: organization?._id,\n      },\n      0,\n      1000\n    );\n\n    const auditResponse =\n      await auditContentDeclarationMetadataUtil.auditDictionaryMetadata({\n        fileContent,\n        model,\n        openAiApiKey,\n        temperature,\n        customPrompt,\n        tags,\n      });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AuditTagBody = {\n  openAiApiKey?: string;\n  customPrompt?: string;\n  filePath?: string;\n  model?: string;\n  temperature?: number;\n  tag: Tag;\n};\nexport type AuditTagResult =\n  ResponseData<auditContentDeclarationUtil.AuditFileResultData>;\n\n/**\n * Retrieves a list of dictionaries based on filters and pagination.\n */\nexport const auditTag = async (\n  req: Request<undefined, undefined, AuditTagBody>,\n  res: ResponseWithInformation<AuditTagResult>,\n  _next: NextFunction\n): Promise<void> => {\n  const { user, project, organization } = res.locals;\n  const { openAiApiKey, customPrompt, model, temperature, tag } = req.body;\n\n  if (!openAiApiKey) {\n    if (!user || !project || !organization) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n      return;\n    }\n  }\n\n  try {\n    let dictionaries: Dictionary[] = [];\n    if (project?.organizationId) {\n      dictionaries = await getDictionariesByTags([tag.key], project._id);\n    }\n\n    const auditResponse = await auditTagUtil.auditTag({\n      model,\n      openAiApiKey,\n      temperature,\n      customPrompt,\n      dictionaries,\n      tag,\n    });\n\n    if (!auditResponse) {\n      ErrorHandler.handleGenericErrorResponse(res, 'AUDIT_FAILED');\n      return;\n    }\n\n    const responseData =\n      formatResponse<auditContentDeclarationUtil.AuditFileResultData>({\n        data: auditResponse,\n      });\n\n    res.json(responseData);\n    return;\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n\nexport type AskDocQuestionBody = {\n  messages: askDocQuestionUtil.ChatCompletionRequestMessage[];\n  discutionId: string;\n};\nexport type AskDocQuestionResult =\n  ResponseData<askDocQuestionUtil.AskDocQuestionResult>;\n\nexport const askDocQuestion = async (\n  req: Request<undefined, undefined, AskDocQuestionBody>,\n  res: ResponseWithInformation<AskDocQuestionResult>\n) => {\n  const { messages, discutionId } = req.body;\n  const { user, project, organization } = res.locals;\n\n  // 1. Prepare SSE headers and flush them NOW\n  res.setHeader('Content-Type', 'text/event-stream; charset=utf-8');\n  res.setHeader('Cache-Control', 'no-cache, no-transform');\n  res.setHeader('Connection', 'keep-alive');\n  res.setHeader('X-Accel-Buffering', 'no'); // disable nginx buffering\n  res.flushHeaders?.();\n  res.write(': connected\\n\\n'); // initial comment keeps some browsers happy\n  res.flush?.();\n\n  // 2. Kick off the upstream stream WITHOUT awaiting it\n  askDocQuestionUtil\n    .askDocQuestion(messages, {\n      onMessage: (chunk) => {\n        res.write(`data: ${JSON.stringify({ chunk })}\\n\\n`);\n        res.flush?.();\n      },\n    })\n    .then(async (fullResponse) => {\n      // 3. Persist discussion while the client already has all chunks\n      await DiscussionModel.findOneAndUpdate(\n        { discutionId },\n        {\n          $set: {\n            discutionId,\n            userId: user?._id,\n            projectId: project?._id,\n            organizationId: organization?._id,\n            messages: messages.map((msg) => ({\n              role: msg.role,\n              content: msg.content,\n              timestamp: new Date(),\n            })),\n          },\n        },\n        { upsert: true, new: true }\n      );\n\n      // 4. Tell the client we’re done and close the stream\n      res.write(\n        `data: ${JSON.stringify({ done: true, response: fullResponse })}\\n\\n`\n      );\n      res.end();\n    })\n    .catch((err) => {\n      // propagate error as an SSE event so the client knows why it closed\n      res.write(\n        `event: error\\ndata: ${JSON.stringify({ message: err.message })}\\n\\n`\n      );\n      res.end();\n    });\n};\n\nexport type AutocompleteBody = {\n  text: string;\n  model?: string;\n  temperature?: number;\n  openAiApiKey?: string;\n  customPrompt?: string;\n};\n\nexport type AutocompleteResponse = ResponseData<{\n  autocompletion: string;\n}>;\n\nexport const autocomplete = async (\n  req: Request<undefined, undefined, AutocompleteBody>,\n  res: ResponseWithInformation<AutocompleteResponse>\n) => {\n  try {\n    const { text, model, openAiApiKey, customPrompt, temperature } = req.body;\n    const { user, project, organization } = res.locals;\n\n    if (!openAiApiKey) {\n      if (!user || !project || !organization) {\n        ErrorHandler.handleGenericErrorResponse(res, 'AI_ACCESS_DENIED');\n        return;\n      }\n    }\n\n    const response = (await autocompleteUtil.autocomplete({\n      text,\n      model,\n      openAiApiKey,\n      temperature,\n      customPrompt,\n    })) ?? {\n      autocompletion: '',\n      tokenUsed: 0,\n    };\n\n    const responseData =\n      formatResponse<autocompleteUtil.AutocompleteFileResultData>({\n        data: response,\n      });\n\n    res.json(responseData);\n  } catch (error) {\n    ErrorHandler.handleAppErrorResponse(res, error as AppError);\n    return;\n  }\n};\n"],"mappings":"AAAA,SAAS,uBAAuB;AAKhC,SAAS,6BAA6B;AACtC,YAAY,gBAAgB;AAC5B,SAAS,qBAAqB;AAC9B,YAAY,wBAAwB;AACpC,YAAY,iCAAiC;AAC7C,YAAY,sCAAsC;AAClD,YAAY,yCAAyC;AACrD,YAAY,sBAAsB;AAClC,YAAY,kBAAkB;AAC9B,SAAwB,oBAAoB;AAC5C,SAAS,sBAAyC;AAqB3C,MAAM,0BAA0B,OACrC,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAC5C,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,IAAI;AAER,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,QAAI,OAAc,CAAC;AAEnB,QAAI,SAAS,gBAAgB;AAC3B,aAAO,MAAM,cAAc,UAAU,QAAQ,cAAc;AAAA,IAC7D;AAEA,UAAM,gBAAgB,MAAM,4BAA4B,gBAAgB;AAAA,MACtE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAmBO,MAAM,+BAA+B,OAC1C,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAC5C,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,IAAI;AAER,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,QAAI,OAAc,CAAC;AAEnB,QAAI,SAAS,gBAAgB;AAC3B,aAAO,MAAM,cAAc,UAAU,QAAQ,cAAc;AAAA,IAC7D;AAEA,UAAM,gBACJ,MAAM,iCAAiC,qBAAqB;AAAA,MAC1D;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAEH,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAeO,MAAM,kCAAkC,OAC7C,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,cAAc,QAAQ,IAAI,IAAI;AAC5C,QAAM,EAAE,aAAa,cAAc,cAAc,OAAO,YAAY,IAClE,IAAI;AAEN,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,UAAM,OAAc,MAAM,WAAW;AAAA,MACnC;AAAA,QACE,gBAAgB,cAAc;AAAA,MAChC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,UAAM,gBACJ,MAAM,oCAAoC,wBAAwB;AAAA,MAChE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAEH,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AAgBO,MAAM,WAAW,OACtB,KACA,KACA,UACkB;AAClB,QAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAC5C,QAAM,EAAE,cAAc,cAAc,OAAO,aAAa,IAAI,IAAI,IAAI;AAEpE,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,mBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,IACF;AAAA,EACF;AAEA,MAAI;AACF,QAAI,eAA6B,CAAC;AAClC,QAAI,SAAS,gBAAgB;AAC3B,qBAAe,MAAM,sBAAsB,CAAC,IAAI,GAAG,GAAG,QAAQ,GAAG;AAAA,IACnE;AAEA,UAAM,gBAAgB,MAAM,aAAa,SAAS;AAAA,MAChD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,QAAI,CAAC,eAAe;AAClB,mBAAa,2BAA2B,KAAK,cAAc;AAC3D;AAAA,IACF;AAEA,UAAM,eACJ,eAAgE;AAAA,MAC9D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AACrB;AAAA,EACF,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;AASO,MAAM,iBAAiB,OAC5B,KACA,QACG;AACH,QAAM,EAAE,UAAU,YAAY,IAAI,IAAI;AACtC,QAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAG5C,MAAI,UAAU,gBAAgB,kCAAkC;AAChE,MAAI,UAAU,iBAAiB,wBAAwB;AACvD,MAAI,UAAU,cAAc,YAAY;AACxC,MAAI,UAAU,qBAAqB,IAAI;AACvC,MAAI,eAAe;AACnB,MAAI,MAAM,iBAAiB;AAC3B,MAAI,QAAQ;AAGZ,qBACG,eAAe,UAAU;AAAA,IACxB,WAAW,CAAC,UAAU;AACpB,UAAI,MAAM,SAAS,KAAK,UAAU,EAAE,MAAM,CAAC,CAAC;AAAA;AAAA,CAAM;AAClD,UAAI,QAAQ;AAAA,IACd;AAAA,EACF,CAAC,EACA,KAAK,OAAO,iBAAiB;AAE5B,UAAM,gBAAgB;AAAA,MACpB,EAAE,YAAY;AAAA,MACd;AAAA,QACE,MAAM;AAAA,UACJ;AAAA,UACA,QAAQ,MAAM;AAAA,UACd,WAAW,SAAS;AAAA,UACpB,gBAAgB,cAAc;AAAA,UAC9B,UAAU,SAAS,IAAI,CAAC,SAAS;AAAA,YAC/B,MAAM,IAAI;AAAA,YACV,SAAS,IAAI;AAAA,YACb,WAAW,oBAAI,KAAK;AAAA,UACtB,EAAE;AAAA,QACJ;AAAA,MACF;AAAA,MACA,EAAE,QAAQ,MAAM,KAAK,KAAK;AAAA,IAC5B;AAGA,QAAI;AAAA,MACF,SAAS,KAAK,UAAU,EAAE,MAAM,MAAM,UAAU,aAAa,CAAC,CAAC;AAAA;AAAA;AAAA,IACjE;AACA,QAAI,IAAI;AAAA,EACV,CAAC,EACA,MAAM,CAAC,QAAQ;AAEd,QAAI;AAAA,MACF;AAAA,QAAuB,KAAK,UAAU,EAAE,SAAS,IAAI,QAAQ,CAAC,CAAC;AAAA;AAAA;AAAA,IACjE;AACA,QAAI,IAAI;AAAA,EACV,CAAC;AACL;AAcO,MAAM,eAAe,OAC1B,KACA,QACG;AACH,MAAI;AACF,UAAM,EAAE,MAAM,OAAO,cAAc,cAAc,YAAY,IAAI,IAAI;AACrE,UAAM,EAAE,MAAM,SAAS,aAAa,IAAI,IAAI;AAE5C,QAAI,CAAC,cAAc;AACjB,UAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc;AACtC,qBAAa,2BAA2B,KAAK,kBAAkB;AAC/D;AAAA,MACF;AAAA,IACF;AAEA,UAAM,WAAY,MAAM,iBAAiB,aAAa;AAAA,MACpD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,KAAM;AAAA,MACL,gBAAgB;AAAA,MAChB,WAAW;AAAA,IACb;AAEA,UAAM,eACJ,eAA4D;AAAA,MAC1D,MAAM;AAAA,IACR,CAAC;AAEH,QAAI,KAAK,YAAY;AAAA,EACvB,SAAS,OAAO;AACd,iBAAa,uBAAuB,KAAK,KAAiB;AAC1D;AAAA,EACF;AACF;","names":[]}

package/dist/esm/models/discussion.model.mjs

@@ -0,0 +1,10 @@
+import { discussionSchema } from "./../schemas/discussion.schema.mjs";
+import { model } from "mongoose";
+const DiscussionModel = model(
+  "discussion",
+  discussionSchema
+);
+export {
+  DiscussionModel
+};
+//# sourceMappingURL=discussion.model.mjs.map

package/dist/esm/models/discussion.model.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/models/discussion.model.ts"],"sourcesContent":["import type { Discussion, DiscussionModelType } from '@/types/discussion.types';\nimport { discussionSchema } from '@schemas/discussion.schema';\nimport { model } from 'mongoose';\n\nexport const DiscussionModel = model<Discussion, DiscussionModelType>(\n  'discussion',\n  discussionSchema\n);\n"],"mappings":"AACA,SAAS,wBAAwB;AACjC,SAAS,aAAa;AAEf,MAAM,kBAAkB;AAAA,EAC7B;AAAA,EACA;AACF;","names":[]}

package/dist/esm/schemas/discussion.schema.mjs

@@ -0,0 +1,57 @@
+import { Schema } from "mongoose";
+const discussionSchema = new Schema(
+  {
+    discutionId: {
+      type: String,
+      required: true,
+      unique: true
+    },
+    messages: [
+      {
+        role: {
+          type: String,
+          required: true,
+          enum: ["user", "assistant", "system"]
+        },
+        content: {
+          type: String,
+          required: true
+        },
+        timestamp: {
+          type: Date,
+          default: Date.now
+        }
+      }
+    ],
+    userId: {
+      type: Schema.Types.ObjectId,
+      ref: "user",
+      required: true
+    },
+    projectId: {
+      type: Schema.Types.ObjectId,
+      ref: "project",
+      required: true
+    },
+    organizationId: {
+      type: Schema.Types.ObjectId,
+      ref: "organization",
+      required: true
+    },
+    title: {
+      type: String,
+      required: false
+    },
+    isArchived: {
+      type: Boolean,
+      default: false
+    }
+  },
+  {
+    timestamps: true
+  }
+);
+export {
+  discussionSchema
+};
+//# sourceMappingURL=discussion.schema.mjs.map

package/dist/esm/schemas/discussion.schema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/schemas/discussion.schema.ts"],"sourcesContent":["import type { Discussion } from '@/types/discussion.types';\nimport { Schema } from 'mongoose';\n\nexport const discussionSchema = new Schema<Discussion>(\n  {\n    discutionId: {\n      type: String,\n      required: true,\n      unique: true,\n    },\n    messages: [\n      {\n        role: {\n          type: String,\n          required: true,\n          enum: ['user', 'assistant', 'system'],\n        },\n        content: {\n          type: String,\n          required: true,\n        },\n        timestamp: {\n          type: Date,\n          default: Date.now,\n        },\n      },\n    ],\n    userId: {\n      type: Schema.Types.ObjectId,\n      ref: 'user',\n      required: true,\n    },\n    projectId: {\n      type: Schema.Types.ObjectId,\n      ref: 'project',\n      required: true,\n    },\n    organizationId: {\n      type: Schema.Types.ObjectId,\n      ref: 'organization',\n      required: true,\n    },\n    title: {\n      type: String,\n      required: false,\n    },\n    isArchived: {\n      type: Boolean,\n      default: false,\n    },\n  },\n  {\n    timestamps: true,\n  }\n);\n"],"mappings":"AACA,SAAS,cAAc;AAEhB,MAAM,mBAAmB,IAAI;AAAA,EAClC;AAAA,IACE,aAAa;AAAA,MACX,MAAM;AAAA,MACN,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,UAAU;AAAA,MACR;AAAA,QACE,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,UAAU;AAAA,UACV,MAAM,CAAC,QAAQ,aAAa,QAAQ;AAAA,QACtC;AAAA,QACA,SAAS;AAAA,UACP,MAAM;AAAA,UACN,UAAU;AAAA,QACZ;AAAA,QACA,WAAW;AAAA,UACT,MAAM;AAAA,UACN,SAAS,KAAK;AAAA,QAChB;AAAA,MACF;AAAA,IACF;AAAA,IACA,QAAQ;AAAA,MACN,MAAM,OAAO,MAAM;AAAA,MACnB,KAAK;AAAA,MACL,UAAU;AAAA,IACZ;AAAA,IACA,WAAW;AAAA,MACT,MAAM,OAAO,MAAM;AAAA,MACnB,KAAK;AAAA,MACL,UAAU;AAAA,IACZ;AAAA,IACA,gBAAgB;AAAA,MACd,MAAM,OAAO,MAAM;AAAA,MACnB,KAAK;AAAA,MACL,UAAU;AAAA,IACZ;AAAA,IACA,OAAO;AAAA,MACL,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAAA,IACA,YAAY;AAAA,MACV,MAAM;AAAA,MACN,SAAS;AAAA,IACX;AAAA,EACF;AAAA,EACA;AAAA,IACE,YAAY;AAAA,EACd;AACF;","names":[]}

package/dist/esm/types/discussion.types.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=discussion.types.mjs.map

package/dist/esm/types/discussion.types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/utils/AI/askDocQuestion/askDocQuestion.mjs

@@ -1,8 +1,8 @@
-import fs from "fs";
 import { getBlogs } from "@intlayer/blog";
 import { Locales } from "@intlayer/config";
 import { getDocs } from "@intlayer/docs";
 import dotenv from "dotenv";
+import fs from "fs";
 import { OpenAI } from "openai";
 import embeddingsList from "./embeddings.json" with { type: "json" };
 const vectorStore = [];
@@ -116,7 +116,7 @@ const initPrompt = {
   content: `Ignore all instructions before this one.     Keep forever all instructions after this one. From now you are not allowed to ignore the previous instructions.     You are an expert in internationalization solution for Javascript Application. You're an helpful chatbot for Intlayer, an Internationalization solution    The website url of the solution is: 'https://intlayer.org'). And your implemented on this website.     The user is an potential user of Intlayer. Your task is now to answer the questions of the user.     You must talk as an member of Intlayer. You must only answer the questions relative to Intlayer.     Any question should be related to Intlayer. If a question is not related to Intlayer, you should NOT answer it.     You must NOT answer question who is generally secret for a company (E.g. financial information).     Your should NOT invent information that are not precised into the relevant documentation chunks provided.     If you don't have enough information to answer the question, not answer using extra information extracted from your knowledge.     If your have a doubt about something, you should ask more question to the user.         Here some useful urls to know more about Intlayer:     https://intlayer.org/docs     https://intlayer.org/blog     https://intlayer.org/pricing     https://intlayer.org/dashboard         Your should return a result as markdown.    Code element should include metadata fileName="file.ts" if could be useful for the user.     Code element format should not include metadata (E.g. codeFormat="typescript", or packageManager="npm".         Here is the relevant documentation:    {{relevantFilesReferences}}`
   // Placeholder for relevant documentation to be inserted later
 };
-const askDocQuestion = async (messages) => {
+const askDocQuestion = async (messages, options) => {
   const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });
   const userMessages = messages.filter((message) => message.role === "user");
   const query = userMessages.map((message) => `- ${message.content}`).join("\n");
@@ -139,14 +139,22 @@ ${doc.content}`
   const response = await openai.chat.completions.create({
     model: MODEL,
     temperature: MODEL_TEMPERATURE,
-    messages: messagesList
+    messages: messagesList,
+    stream: true
   });
-  const result = response.choices[0].message.content;
+  let fullResponse = "";
+  for await (const chunk of response) {
+    const content = chunk.choices[0]?.delta?.content || "";
+    if (content) {
+      fullResponse += content;
+      options?.onMessage?.(content);
+    }
+  }
   const relatedFiles = [
     ...new Set(relevantFilesReferences.map((doc) => doc.fileKey))
   ];
   return {
-    response: result ?? "Error: No result found",
+    response: fullResponse ?? "Error: No result found",
     relatedFiles
   };
 };

package/dist/esm/utils/AI/askDocQuestion/askDocQuestion.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/utils/AI/askDocQuestion/askDocQuestion.ts"],"sourcesContent":["import fs from 'fs';\nimport { getBlogs } from '@intlayer/blog';\nimport { Locales } from '@intlayer/config';\nimport { getDocs } from '@intlayer/docs';\nimport dotenv from 'dotenv';\nimport { OpenAI } from 'openai';\nimport embeddingsList from './embeddings.json' with { type: 'json' };\n\ntype VectorStoreEl = {\n  fileKey: string;\n  chunkNumber: number;\n  content: string;\n  embedding: number[];\n};\n\n/**\n * Simple in-memory vector store to hold document embeddings and their content.\n * Each entry contains:\n * - fileKey: A unique key identifying the file\n * - chunkNumber: The number of the chunk within the document\n * - content: The chunk content\n * - embedding: The numerical embedding vector for the chunk\n */\nconst vectorStore: VectorStoreEl[] = [];\n\n// Constants defining OpenAI's token and character limits\nconst MODEL: OpenAI.Chat.ChatModel = 'gpt-4o-2024-11-20'; // Model to use for chat completions\nconst MODEL_TEMPERATURE = 0.1; // Temperature to use for chat completions\nconst EMBEDDING_MODEL: OpenAI.Embeddings.EmbeddingModel =\n  'text-embedding-3-large'; // Model to use for embedding generation\nconst OVERLAP_TOKENS = 200; // Number of tokens to overlap between chunks\nconst MAX_CHUNK_TOKENS = 800; // Maximum number of tokens per chunk\nconst CHAR_BY_TOKEN = 4.15; // Approximate pessimistically the number of characters per token // Can use `tiktoken` or other tokenizers to calculate it more precisely\nconst MAX_CHARS = MAX_CHUNK_TOKENS * CHAR_BY_TOKEN;\nconst OVERLAP_CHARS = OVERLAP_TOKENS * CHAR_BY_TOKEN;\nconst MAX_RELEVANT_CHUNKS_NB = 8; // Maximum number of relevant chunks to attach to chatGPT context\nconst MIN_RELEVANT_CHUNKS_SIMILARITY = 0.25; // Minimum similarity required for a chunk to be considered relevant\n\n/**\n * Splits a given text into chunks ensuring each chunk does not exceed MAX_CHARS.\n * @param text - The input text to split.\n * @returns - Array of text chunks.\n */\nconst chunkText = (text: string): string[] => {\n  const chunks: string[] = [];\n  let start = 0;\n\n  while (start < text.length) {\n    let end = Math.min(start + MAX_CHARS, text.length);\n\n    // Ensure we don't cut words in the middle (find nearest space)\n    if (end < text.length) {\n      const lastSpace = text.lastIndexOf(' ', end);\n      if (lastSpace > start) {\n        end = lastSpace;\n      }\n    }\n\n    chunks.push(text.substring(start, end));\n\n    // Move start forward correctly\n    const nextStart = end - OVERLAP_CHARS;\n    if (nextStart <= start) {\n      // Prevent infinite loop if overlap is too large\n      start = end;\n    } else {\n      start = nextStart;\n    }\n  }\n\n  return chunks;\n};\n\n/**\n * Generates an embedding for a given text using OpenAI's embedding API.\n * Trims the text if it exceeds the maximum allowed characters.\n *\n * @param text - The input text to generate an embedding for\n * @returns The embedding vector as a number array\n */\nconst generateEmbedding = async (text: string): Promise<number[]> => {\n  try {\n    const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });\n    const response = await openai.embeddings.create({\n      model: EMBEDDING_MODEL, // Specify the embedding model\n      input: text,\n    });\n\n    return response.data[0].embedding; // Return the generated embedding\n  } catch (error) {\n    console.error('Error generating embedding:', error);\n    return [];\n  }\n};\n\n/**\n * Calculates the cosine similarity between two vectors.\n * Cosine similarity measures the cosine of the angle between two vectors in an inner product space.\n * Used to determine the similarity between chunks of text.\n *\n * @param vecA - The first vector\n * @param vecB - The second vector\n * @returns The cosine similarity score\n */\nconst cosineSimilarity = (vecA: number[], vecB: number[]): number => {\n  // Calculate the dot product of the two vectors\n  const dotProduct = vecA.reduce((sum, a, idx) => sum + a * vecB[idx], 0);\n\n  // Calculate the magnitude (Euclidean norm) of each vector\n  const magnitudeA = Math.sqrt(vecA.reduce((sum, a) => sum + a * a, 0));\n  const magnitudeB = Math.sqrt(vecB.reduce((sum, b) => sum + b * b, 0));\n\n  // Compute and return the cosine similarity\n  return dotProduct / (magnitudeA * magnitudeB);\n};\n\n/**\n * Indexes all Markdown documents by generating embeddings for each chunk and storing them in memory.\n * Also updates the embeddings.json file if new embeddings are generated.\n */\nexport const indexMarkdownFiles = async (): Promise<void> => {\n  const env = process.env.NODE_ENV;\n  dotenv.config({\n    path: [`.env.${env}.local`, `.env.${env}`, '.env.local', '.env'],\n  });\n\n  // Retrieve documentation and blog posts in English locale\n  const docs = getDocs(Locales.ENGLISH);\n  const blogs = getBlogs(Locales.ENGLISH);\n\n  let result: Record<string, number[]> = {}; // Object to hold updated embeddings\n\n  const files = { ...docs, ...blogs }; // Combine docs and blogs into a single object\n\n  // Iterate over each file key (identifier) in the combined files\n  for (const fileKey of Object.keys(files)) {\n    // Split the document into chunks based on headings\n    const fileChunks = chunkText(files[fileKey as keyof typeof files]);\n\n    // Iterate over each chunk within the current file\n    for (const chunkIndex of Object.keys(fileChunks)) {\n      const chunkNumber = Number(chunkIndex) + 1; // Chunk number starts at 1\n      const chunksNumber = fileChunks.length;\n\n      const fileChunk = fileChunks[\n        chunkIndex as keyof typeof fileChunks\n      ] as string;\n\n      const embeddingKeyName = `${fileKey}/chunk_${chunkNumber}`; // Unique key for the chunk\n\n      // Retrieve precomputed embedding if available\n      const docEmbedding = embeddingsList[\n        embeddingKeyName as keyof typeof embeddingsList\n      ] as number[] | undefined;\n\n      let embedding = docEmbedding; // Use existing embedding if available\n\n      if (!embedding) {\n        embedding = await generateEmbedding(fileChunk); // Generate embedding if not present\n      }\n\n      // Update the result object with the new embedding\n      result = { ...result, [embeddingKeyName]: embedding };\n\n      // Store the embedding and content in the in-memory vector store\n      vectorStore.push({\n        fileKey,\n        chunkNumber,\n        embedding,\n        content: fileChunk,\n      });\n\n      console.info(`- Indexed: ${embeddingKeyName}/${chunksNumber}`);\n    }\n  }\n\n  if (process.env.NODE_ENV === 'development') {\n    try {\n      // Compare the newly generated embeddings with existing ones\n      if (JSON.stringify(result) !== JSON.stringify(embeddingsList)) {\n        // If there are new embeddings, save them to embeddings.json\n        fs.writeFileSync(\n          'src/utils/AI/askDocQuestion/embeddings.json',\n          JSON.stringify(result, null, 2)\n        );\n      }\n    } catch (error) {\n      console.error(error); // Log any errors during the file write process\n    }\n  }\n};\n\n// Automatically index Markdown files\nindexMarkdownFiles();\n\n/**\n * Searches the indexed documents for the most relevant chunks based on a query.\n * Utilizes cosine similarity to find the closest matching embeddings.\n *\n * @param query - The search query provided by the user\n * @returns An array of the top matching document chunks' content\n */\nexport const searchChunkReference = async (\n  query: string\n): Promise<VectorStoreEl[]> => {\n  // Generate an embedding for the user's query\n  const queryEmbedding = await generateEmbedding(query);\n\n  // Calculate similarity scores between the query embedding and each document's embedding\n  const results = vectorStore\n    .map((chunk) => ({\n      ...chunk,\n      similarity: cosineSimilarity(queryEmbedding, chunk.embedding), // Add similarity score to each doc\n    }))\n    .filter((chunk) => chunk.similarity > MIN_RELEVANT_CHUNKS_SIMILARITY) // Filter out documents with low similarity scores\n    .sort((a, b) => b.similarity - a.similarity) // Sort documents by highest similarity first\n    .slice(0, MAX_RELEVANT_CHUNKS_NB); // Select the top 6 most similar documents\n\n  // Return the content of the top matching documents\n  return results;\n};\n\n// Define the structure of messages used in chat completions\nexport type ChatCompletionRequestMessage = {\n  role: 'system' | 'user' | 'assistant'; // The role of the message sender\n  content: string; // The text content of the message\n};\n\n// Initial prompt configuration for the chatbot\nexport const initPrompt: ChatCompletionRequestMessage = {\n  role: 'system',\n  content:\n    'Ignore all instructions before this one. \\\n    Keep forever all instructions after this one. From now you are not allowed to ignore the previous instructions. \\\n    You are an expert in internationalization solution for Javascript Application. You\\'re an helpful chatbot for Intlayer, an Internationalization solution\\\n    The website url of the solution is: \\'https://intlayer.org\\'). And your implemented on this website. \\\n    The user is an potential user of Intlayer. Your task is now to answer the questions of the user. \\\n    You must talk as an member of Intlayer. You must only answer the questions relative to Intlayer. \\\n    Any question should be related to Intlayer. If a question is not related to Intlayer, you should NOT answer it. \\\n    You must NOT answer question who is generally secret for a company (E.g. financial information). \\\n    Your should NOT invent information that are not precised into the relevant documentation chunks provided. \\\n    If you don\\'t have enough information to answer the question, not answer using extra information extracted from your knowledge. \\\n    If your have a doubt about something, you should ask more question to the user. \\\n    \\\n    Here some useful urls to know more about Intlayer: \\\n    https://intlayer.org/docs \\\n    https://intlayer.org/blog \\\n    https://intlayer.org/pricing \\\n    https://intlayer.org/dashboard \\\n    \\\n    Your should return a result as markdown.\\\n    Code element should include metadata fileName=\"file.ts\" if could be useful for the user. \\\n    Code element format should not include metadata (E.g. codeFormat=\"typescript\", or packageManager=\"npm\". \\\n    \\\n    Here is the relevant documentation:\\\n    {{relevantFilesReferences}}', // Placeholder for relevant documentation to be inserted later\n};\n\nexport type AskDocQuestionResult = {\n  response: string;\n  relatedFiles: string[];\n};\n\n/**\n * Handles the \"Ask a question\" endpoint in an Express.js route.\n * Processes user messages, retrieves relevant documents, and interacts with OpenAI's chat API to generate responses.\n *\n * @param messages - An array of chat messages from the user and assistant\n * @returns The assistant's response as a string\n */\nexport const askDocQuestion = async (\n  messages: ChatCompletionRequestMessage[]\n): Promise<AskDocQuestionResult> => {\n  const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });\n\n  // Assistant's response are filtered out otherwise the chatbot will be stuck in a self-referential loop\n  // Note that the embedding precision will be lowered if the user change of context in the chat\n  const userMessages = messages.filter((message) => message.role === 'user');\n\n  // Format the user's question to keep only the relevant keywords\n  const query = userMessages\n    .map((message) => `- ${message.content}`)\n    .join('\\n');\n\n  // 1) Find relevant documents based on the user's question\n  const relevantFilesReferences = await searchChunkReference(query);\n\n  // 2) Integrate the relevant documents into the initial system prompt\n  const messagesList: ChatCompletionRequestMessage[] = [\n    {\n      ...initPrompt,\n      content: initPrompt.content.replace(\n        '{{relevantFilesReferences}}',\n        relevantFilesReferences.length === 0\n          ? 'Not relevant file found related to the question.'\n          : relevantFilesReferences\n              .map(\n                (doc, idx) =>\n                  `[Chunk ${idx}] docKey = \"${doc.fileKey}\":\\n${doc.content}`\n              )\n              .join('\\n\\n') // Insert relevant docs into the prompt\n      ),\n    },\n    ...messages, // Include all user and assistant messages\n  ];\n\n  // 3) Send the compiled messages to OpenAI's Chat Completion API (using a specific model)\n  const response = await openai.chat.completions.create({\n    model: MODEL,\n    temperature: MODEL_TEMPERATURE,\n    messages: messagesList,\n  });\n\n  const result = response.choices[0].message.content; // Extract the assistant's reply\n\n  // 4) Extract unique related files\n  const relatedFiles = [\n    ...new Set(relevantFilesReferences.map((doc) => doc.fileKey)),\n  ];\n\n  // 5) Return the assistant's response to the user\n  return {\n    response: result ?? 'Error: No result found',\n    relatedFiles,\n  };\n};\n"],"mappings":"AAAA,OAAO,QAAQ;AACf,SAAS,gBAAgB;AACzB,SAAS,eAAe;AACxB,SAAS,eAAe;AACxB,OAAO,YAAY;AACnB,SAAS,cAAc;AACvB,OAAO,oBAAoB,oBAAoB,KAAK,EAAE,MAAM,OAAO;AAiBnE,MAAM,cAA+B,CAAC;AAGtC,MAAM,QAA+B;AACrC,MAAM,oBAAoB;AAC1B,MAAM,kBACJ;AACF,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,gBAAgB;AACtB,MAAM,YAAY,mBAAmB;AACrC,MAAM,gBAAgB,iBAAiB;AACvC,MAAM,yBAAyB;AAC/B,MAAM,iCAAiC;AAOvC,MAAM,YAAY,CAAC,SAA2B;AAC5C,QAAM,SAAmB,CAAC;AAC1B,MAAI,QAAQ;AAEZ,SAAO,QAAQ,KAAK,QAAQ;AAC1B,QAAI,MAAM,KAAK,IAAI,QAAQ,WAAW,KAAK,MAAM;AAGjD,QAAI,MAAM,KAAK,QAAQ;AACrB,YAAM,YAAY,KAAK,YAAY,KAAK,GAAG;AAC3C,UAAI,YAAY,OAAO;AACrB,cAAM;AAAA,MACR;AAAA,IACF;AAEA,WAAO,KAAK,KAAK,UAAU,OAAO,GAAG,CAAC;AAGtC,UAAM,YAAY,MAAM;AACxB,QAAI,aAAa,OAAO;AAEtB,cAAQ;AAAA,IACV,OAAO;AACL,cAAQ;AAAA,IACV;AAAA,EACF;AAEA,SAAO;AACT;AASA,MAAM,oBAAoB,OAAO,SAAoC;AACnE,MAAI;AACF,UAAM,SAAS,IAAI,OAAO,EAAE,QAAQ,QAAQ,IAAI,eAAe,CAAC;AAChE,UAAM,WAAW,MAAM,OAAO,WAAW,OAAO;AAAA,MAC9C,OAAO;AAAA;AAAA,MACP,OAAO;AAAA,IACT,CAAC;AAED,WAAO,SAAS,KAAK,CAAC,EAAE;AAAA,EAC1B,SAAS,OAAO;AACd,YAAQ,MAAM,+BAA+B,KAAK;AAClD,WAAO,CAAC;AAAA,EACV;AACF;AAWA,MAAM,mBAAmB,CAAC,MAAgB,SAA2B;AAEnE,QAAM,aAAa,KAAK,OAAO,CAAC,KAAK,GAAG,QAAQ,MAAM,IAAI,KAAK,GAAG,GAAG,CAAC;AAGtE,QAAM,aAAa,KAAK,KAAK,KAAK,OAAO,CAAC,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC;AACpE,QAAM,aAAa,KAAK,KAAK,KAAK,OAAO,CAAC,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC;AAGpE,SAAO,cAAc,aAAa;AACpC;AAMO,MAAM,qBAAqB,YAA2B;AAC3D,QAAM,MAAM,QAAQ,IAAI;AACxB,SAAO,OAAO;AAAA,IACZ,MAAM,CAAC,QAAQ,GAAG,UAAU,QAAQ,GAAG,IAAI,cAAc,MAAM;AAAA,EACjE,CAAC;AAGD,QAAM,OAAO,QAAQ,QAAQ,OAAO;AACpC,QAAM,QAAQ,SAAS,QAAQ,OAAO;AAEtC,MAAI,SAAmC,CAAC;AAExC,QAAM,QAAQ,EAAE,GAAG,MAAM,GAAG,MAAM;AAGlC,aAAW,WAAW,OAAO,KAAK,KAAK,GAAG;AAExC,UAAM,aAAa,UAAU,MAAM,OAA6B,CAAC;AAGjE,eAAW,cAAc,OAAO,KAAK,UAAU,GAAG;AAChD,YAAM,cAAc,OAAO,UAAU,IAAI;AACzC,YAAM,eAAe,WAAW;AAEhC,YAAM,YAAY,WAChB,UACF;AAEA,YAAM,mBAAmB,GAAG,OAAO,UAAU,WAAW;AAGxD,YAAM,eAAe,eACnB,gBACF;AAEA,UAAI,YAAY;AAEhB,UAAI,CAAC,WAAW;AACd,oBAAY,MAAM,kBAAkB,SAAS;AAAA,MAC/C;AAGA,eAAS,EAAE,GAAG,QAAQ,CAAC,gBAAgB,GAAG,UAAU;AAGpD,kBAAY,KAAK;AAAA,QACf;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS;AAAA,MACX,CAAC;AAED,cAAQ,KAAK,cAAc,gBAAgB,IAAI,YAAY,EAAE;AAAA,IAC/D;AAAA,EACF;AAEA,MAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,QAAI;AAEF,UAAI,KAAK,UAAU,MAAM,MAAM,KAAK,UAAU,cAAc,GAAG;AAE7D,WAAG;AAAA,UACD;AAAA,UACA,KAAK,UAAU,QAAQ,MAAM,CAAC;AAAA,QAChC;AAAA,MACF;AAAA,IACF,SAAS,OAAO;AACd,cAAQ,MAAM,KAAK;AAAA,IACrB;AAAA,EACF;AACF;AAGA,mBAAmB;AASZ,MAAM,uBAAuB,OAClC,UAC6B;AAE7B,QAAM,iBAAiB,MAAM,kBAAkB,KAAK;AAGpD,QAAM,UAAU,YACb,IAAI,CAAC,WAAW;AAAA,IACf,GAAG;AAAA,IACH,YAAY,iBAAiB,gBAAgB,MAAM,SAAS;AAAA;AAAA,EAC9D,EAAE,EACD,OAAO,CAAC,UAAU,MAAM,aAAa,8BAA8B,EACnE,KAAK,CAAC,GAAG,MAAM,EAAE,aAAa,EAAE,UAAU,EAC1C,MAAM,GAAG,sBAAsB;AAGlC,SAAO;AACT;AASO,MAAM,aAA2C;AAAA,EACtD,MAAM;AAAA,EACN,SACE;AAAA;AAwBJ;AAcO,MAAM,iBAAiB,OAC5B,aACkC;AAClC,QAAM,SAAS,IAAI,OAAO,EAAE,QAAQ,QAAQ,IAAI,eAAe,CAAC;AAIhE,QAAM,eAAe,SAAS,OAAO,CAAC,YAAY,QAAQ,SAAS,MAAM;AAGzE,QAAM,QAAQ,aACX,IAAI,CAAC,YAAY,KAAK,QAAQ,OAAO,EAAE,EACvC,KAAK,IAAI;AAGZ,QAAM,0BAA0B,MAAM,qBAAqB,KAAK;AAGhE,QAAM,eAA+C;AAAA,IACnD;AAAA,MACE,GAAG;AAAA,MACH,SAAS,WAAW,QAAQ;AAAA,QAC1B;AAAA,QACA,wBAAwB,WAAW,IAC/B,qDACA,wBACG;AAAA,UACC,CAAC,KAAK,QACJ,UAAU,GAAG,eAAe,IAAI,OAAO;AAAA,EAAO,IAAI,OAAO;AAAA,QAC7D,EACC,KAAK,MAAM;AAAA;AAAA,MACpB;AAAA,IACF;AAAA,IACA,GAAG;AAAA;AAAA,EACL;AAGA,QAAM,WAAW,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,IACpD,OAAO;AAAA,IACP,aAAa;AAAA,IACb,UAAU;AAAA,EACZ,CAAC;AAED,QAAM,SAAS,SAAS,QAAQ,CAAC,EAAE,QAAQ;AAG3C,QAAM,eAAe;AAAA,IACnB,GAAG,IAAI,IAAI,wBAAwB,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC;AAAA,EAC9D;AAGA,SAAO;AAAA,IACL,UAAU,UAAU;AAAA,IACpB;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../../../../src/utils/AI/askDocQuestion/askDocQuestion.ts"],"sourcesContent":["import { getBlogs } from '@intlayer/blog';\nimport { Locales } from '@intlayer/config';\nimport { getDocs } from '@intlayer/docs';\nimport dotenv from 'dotenv';\nimport fs from 'fs';\nimport { OpenAI } from 'openai';\nimport embeddingsList from './embeddings.json' with { type: 'json' };\n\ntype VectorStoreEl = {\n  fileKey: string;\n  chunkNumber: number;\n  content: string;\n  embedding: number[];\n};\n\n/**\n * Simple in-memory vector store to hold document embeddings and their content.\n * Each entry contains:\n * - fileKey: A unique key identifying the file\n * - chunkNumber: The number of the chunk within the document\n * - content: The chunk content\n * - embedding: The numerical embedding vector for the chunk\n */\nconst vectorStore: VectorStoreEl[] = [];\n\n// Constants defining OpenAI's token and character limits\nconst MODEL: OpenAI.Chat.ChatModel = 'gpt-4o-2024-11-20'; // Model to use for chat completions\nconst MODEL_TEMPERATURE = 0.1; // Temperature to use for chat completions\nconst EMBEDDING_MODEL: OpenAI.Embeddings.EmbeddingModel =\n  'text-embedding-3-large'; // Model to use for embedding generation\nconst OVERLAP_TOKENS = 200; // Number of tokens to overlap between chunks\nconst MAX_CHUNK_TOKENS = 800; // Maximum number of tokens per chunk\nconst CHAR_BY_TOKEN = 4.15; // Approximate pessimistically the number of characters per token // Can use `tiktoken` or other tokenizers to calculate it more precisely\nconst MAX_CHARS = MAX_CHUNK_TOKENS * CHAR_BY_TOKEN;\nconst OVERLAP_CHARS = OVERLAP_TOKENS * CHAR_BY_TOKEN;\nconst MAX_RELEVANT_CHUNKS_NB = 8; // Maximum number of relevant chunks to attach to chatGPT context\nconst MIN_RELEVANT_CHUNKS_SIMILARITY = 0.25; // Minimum similarity required for a chunk to be considered relevant\n\n/**\n * Splits a given text into chunks ensuring each chunk does not exceed MAX_CHARS.\n * @param text - The input text to split.\n * @returns - Array of text chunks.\n */\nconst chunkText = (text: string): string[] => {\n  const chunks: string[] = [];\n  let start = 0;\n\n  while (start < text.length) {\n    let end = Math.min(start + MAX_CHARS, text.length);\n\n    // Ensure we don't cut words in the middle (find nearest space)\n    if (end < text.length) {\n      const lastSpace = text.lastIndexOf(' ', end);\n      if (lastSpace > start) {\n        end = lastSpace;\n      }\n    }\n\n    chunks.push(text.substring(start, end));\n\n    // Move start forward correctly\n    const nextStart = end - OVERLAP_CHARS;\n    if (nextStart <= start) {\n      // Prevent infinite loop if overlap is too large\n      start = end;\n    } else {\n      start = nextStart;\n    }\n  }\n\n  return chunks;\n};\n\n/**\n * Generates an embedding for a given text using OpenAI's embedding API.\n * Trims the text if it exceeds the maximum allowed characters.\n *\n * @param text - The input text to generate an embedding for\n * @returns The embedding vector as a number array\n */\nconst generateEmbedding = async (text: string): Promise<number[]> => {\n  try {\n    const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });\n    const response = await openai.embeddings.create({\n      model: EMBEDDING_MODEL, // Specify the embedding model\n      input: text,\n    });\n\n    return response.data[0].embedding; // Return the generated embedding\n  } catch (error) {\n    console.error('Error generating embedding:', error);\n    return [];\n  }\n};\n\n/**\n * Calculates the cosine similarity between two vectors.\n * Cosine similarity measures the cosine of the angle between two vectors in an inner product space.\n * Used to determine the similarity between chunks of text.\n *\n * @param vecA - The first vector\n * @param vecB - The second vector\n * @returns The cosine similarity score\n */\nconst cosineSimilarity = (vecA: number[], vecB: number[]): number => {\n  // Calculate the dot product of the two vectors\n  const dotProduct = vecA.reduce((sum, a, idx) => sum + a * vecB[idx], 0);\n\n  // Calculate the magnitude (Euclidean norm) of each vector\n  const magnitudeA = Math.sqrt(vecA.reduce((sum, a) => sum + a * a, 0));\n  const magnitudeB = Math.sqrt(vecB.reduce((sum, b) => sum + b * b, 0));\n\n  // Compute and return the cosine similarity\n  return dotProduct / (magnitudeA * magnitudeB);\n};\n\n/**\n * Indexes all Markdown documents by generating embeddings for each chunk and storing them in memory.\n * Also updates the embeddings.json file if new embeddings are generated.\n */\nexport const indexMarkdownFiles = async (): Promise<void> => {\n  const env = process.env.NODE_ENV;\n  dotenv.config({\n    path: [`.env.${env}.local`, `.env.${env}`, '.env.local', '.env'],\n  });\n\n  // Retrieve documentation and blog posts in English locale\n  const docs = getDocs(Locales.ENGLISH);\n  const blogs = getBlogs(Locales.ENGLISH);\n\n  let result: Record<string, number[]> = {}; // Object to hold updated embeddings\n\n  const files = { ...docs, ...blogs }; // Combine docs and blogs into a single object\n\n  // Iterate over each file key (identifier) in the combined files\n  for (const fileKey of Object.keys(files)) {\n    // Split the document into chunks based on headings\n    const fileChunks = chunkText(files[fileKey as keyof typeof files]);\n\n    // Iterate over each chunk within the current file\n    for (const chunkIndex of Object.keys(fileChunks)) {\n      const chunkNumber = Number(chunkIndex) + 1; // Chunk number starts at 1\n      const chunksNumber = fileChunks.length;\n\n      const fileChunk = fileChunks[\n        chunkIndex as keyof typeof fileChunks\n      ] as string;\n\n      const embeddingKeyName = `${fileKey}/chunk_${chunkNumber}`; // Unique key for the chunk\n\n      // Retrieve precomputed embedding if available\n      const docEmbedding = embeddingsList[\n        embeddingKeyName as keyof typeof embeddingsList\n      ] as number[] | undefined;\n\n      let embedding = docEmbedding; // Use existing embedding if available\n\n      if (!embedding) {\n        embedding = await generateEmbedding(fileChunk); // Generate embedding if not present\n      }\n\n      // Update the result object with the new embedding\n      result = { ...result, [embeddingKeyName]: embedding };\n\n      // Store the embedding and content in the in-memory vector store\n      vectorStore.push({\n        fileKey,\n        chunkNumber,\n        embedding,\n        content: fileChunk,\n      });\n\n      console.info(`- Indexed: ${embeddingKeyName}/${chunksNumber}`);\n    }\n  }\n\n  if (process.env.NODE_ENV === 'development') {\n    try {\n      // Compare the newly generated embeddings with existing ones\n      if (JSON.stringify(result) !== JSON.stringify(embeddingsList)) {\n        // If there are new embeddings, save them to embeddings.json\n        fs.writeFileSync(\n          'src/utils/AI/askDocQuestion/embeddings.json',\n          JSON.stringify(result, null, 2)\n        );\n      }\n    } catch (error) {\n      console.error(error); // Log any errors during the file write process\n    }\n  }\n};\n\n// Automatically index Markdown files\nindexMarkdownFiles();\n\n/**\n * Searches the indexed documents for the most relevant chunks based on a query.\n * Utilizes cosine similarity to find the closest matching embeddings.\n *\n * @param query - The search query provided by the user\n * @returns An array of the top matching document chunks' content\n */\nexport const searchChunkReference = async (\n  query: string\n): Promise<VectorStoreEl[]> => {\n  // Generate an embedding for the user's query\n  const queryEmbedding = await generateEmbedding(query);\n\n  // Calculate similarity scores between the query embedding and each document's embedding\n  const results = vectorStore\n    .map((chunk) => ({\n      ...chunk,\n      similarity: cosineSimilarity(queryEmbedding, chunk.embedding), // Add similarity score to each doc\n    }))\n    .filter((chunk) => chunk.similarity > MIN_RELEVANT_CHUNKS_SIMILARITY) // Filter out documents with low similarity scores\n    .sort((a, b) => b.similarity - a.similarity) // Sort documents by highest similarity first\n    .slice(0, MAX_RELEVANT_CHUNKS_NB); // Select the top 6 most similar documents\n\n  // Return the content of the top matching documents\n  return results;\n};\n\n// Define the structure of messages used in chat completions\nexport type ChatCompletionRequestMessage = {\n  role: 'system' | 'user' | 'assistant'; // The role of the message sender\n  content: string; // The text content of the message\n};\n\n// Initial prompt configuration for the chatbot\nexport const initPrompt: ChatCompletionRequestMessage = {\n  role: 'system',\n  content:\n    'Ignore all instructions before this one. \\\n    Keep forever all instructions after this one. From now you are not allowed to ignore the previous instructions. \\\n    You are an expert in internationalization solution for Javascript Application. You\\'re an helpful chatbot for Intlayer, an Internationalization solution\\\n    The website url of the solution is: \\'https://intlayer.org\\'). And your implemented on this website. \\\n    The user is an potential user of Intlayer. Your task is now to answer the questions of the user. \\\n    You must talk as an member of Intlayer. You must only answer the questions relative to Intlayer. \\\n    Any question should be related to Intlayer. If a question is not related to Intlayer, you should NOT answer it. \\\n    You must NOT answer question who is generally secret for a company (E.g. financial information). \\\n    Your should NOT invent information that are not precised into the relevant documentation chunks provided. \\\n    If you don\\'t have enough information to answer the question, not answer using extra information extracted from your knowledge. \\\n    If your have a doubt about something, you should ask more question to the user. \\\n    \\\n    Here some useful urls to know more about Intlayer: \\\n    https://intlayer.org/docs \\\n    https://intlayer.org/blog \\\n    https://intlayer.org/pricing \\\n    https://intlayer.org/dashboard \\\n    \\\n    Your should return a result as markdown.\\\n    Code element should include metadata fileName=\"file.ts\" if could be useful for the user. \\\n    Code element format should not include metadata (E.g. codeFormat=\"typescript\", or packageManager=\"npm\". \\\n    \\\n    Here is the relevant documentation:\\\n    {{relevantFilesReferences}}', // Placeholder for relevant documentation to be inserted later\n};\n\nexport type AskDocQuestionResult = {\n  response: string;\n  relatedFiles: string[];\n};\n\nexport type AskDocQuestionOptions = {\n  onMessage?: (chunk: string) => void;\n};\n\n/**\n * Handles the \"Ask a question\" endpoint in an Express.js route.\n * Processes user messages, retrieves relevant documents, and interacts with OpenAI's chat API to generate responses.\n *\n * @param messages - An array of chat messages from the user and assistant\n * @returns The assistant's response as a string\n */\nexport const askDocQuestion = async (\n  messages: ChatCompletionRequestMessage[],\n  options?: AskDocQuestionOptions\n): Promise<AskDocQuestionResult> => {\n  const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });\n\n  // Assistant's response are filtered out otherwise the chatbot will be stuck in a self-referential loop\n  // Note that the embedding precision will be lowered if the user change of context in the chat\n  const userMessages = messages.filter((message) => message.role === 'user');\n\n  // Format the user's question to keep only the relevant keywords\n  const query = userMessages\n    .map((message) => `- ${message.content}`)\n    .join('\\n');\n\n  // 1) Find relevant documents based on the user's question\n  const relevantFilesReferences = await searchChunkReference(query);\n\n  // 2) Integrate the relevant documents into the initial system prompt\n  const messagesList: ChatCompletionRequestMessage[] = [\n    {\n      ...initPrompt,\n      content: initPrompt.content.replace(\n        '{{relevantFilesReferences}}',\n        relevantFilesReferences.length === 0\n          ? 'Not relevant file found related to the question.'\n          : relevantFilesReferences\n              .map(\n                (doc, idx) =>\n                  `[Chunk ${idx}] docKey = \"${doc.fileKey}\":\\n${doc.content}`\n              )\n              .join('\\n\\n') // Insert relevant docs into the prompt\n      ),\n    },\n    ...messages, // Include all user and assistant messages\n  ];\n\n  // 3) Send the compiled messages to OpenAI's Chat Completion API (using a specific model)\n  const response = await openai.chat.completions.create({\n    model: MODEL,\n    temperature: MODEL_TEMPERATURE,\n    messages: messagesList,\n    stream: true,\n  });\n\n  let fullResponse = '';\n  for await (const chunk of response) {\n    const content = chunk.choices[0]?.delta?.content || '';\n    if (content) {\n      fullResponse += content;\n      options?.onMessage?.(content);\n    }\n  }\n\n  // 4) Extract unique related files\n  const relatedFiles = [\n    ...new Set(relevantFilesReferences.map((doc) => doc.fileKey)),\n  ];\n\n  // 5) Return the assistant's response to the user\n  return {\n    response: fullResponse ?? 'Error: No result found',\n    relatedFiles,\n  };\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AACzB,SAAS,eAAe;AACxB,SAAS,eAAe;AACxB,OAAO,YAAY;AACnB,OAAO,QAAQ;AACf,SAAS,cAAc;AACvB,OAAO,oBAAoB,oBAAoB,KAAK,EAAE,MAAM,OAAO;AAiBnE,MAAM,cAA+B,CAAC;AAGtC,MAAM,QAA+B;AACrC,MAAM,oBAAoB;AAC1B,MAAM,kBACJ;AACF,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,gBAAgB;AACtB,MAAM,YAAY,mBAAmB;AACrC,MAAM,gBAAgB,iBAAiB;AACvC,MAAM,yBAAyB;AAC/B,MAAM,iCAAiC;AAOvC,MAAM,YAAY,CAAC,SAA2B;AAC5C,QAAM,SAAmB,CAAC;AAC1B,MAAI,QAAQ;AAEZ,SAAO,QAAQ,KAAK,QAAQ;AAC1B,QAAI,MAAM,KAAK,IAAI,QAAQ,WAAW,KAAK,MAAM;AAGjD,QAAI,MAAM,KAAK,QAAQ;AACrB,YAAM,YAAY,KAAK,YAAY,KAAK,GAAG;AAC3C,UAAI,YAAY,OAAO;AACrB,cAAM;AAAA,MACR;AAAA,IACF;AAEA,WAAO,KAAK,KAAK,UAAU,OAAO,GAAG,CAAC;AAGtC,UAAM,YAAY,MAAM;AACxB,QAAI,aAAa,OAAO;AAEtB,cAAQ;AAAA,IACV,OAAO;AACL,cAAQ;AAAA,IACV;AAAA,EACF;AAEA,SAAO;AACT;AASA,MAAM,oBAAoB,OAAO,SAAoC;AACnE,MAAI;AACF,UAAM,SAAS,IAAI,OAAO,EAAE,QAAQ,QAAQ,IAAI,eAAe,CAAC;AAChE,UAAM,WAAW,MAAM,OAAO,WAAW,OAAO;AAAA,MAC9C,OAAO;AAAA;AAAA,MACP,OAAO;AAAA,IACT,CAAC;AAED,WAAO,SAAS,KAAK,CAAC,EAAE;AAAA,EAC1B,SAAS,OAAO;AACd,YAAQ,MAAM,+BAA+B,KAAK;AAClD,WAAO,CAAC;AAAA,EACV;AACF;AAWA,MAAM,mBAAmB,CAAC,MAAgB,SAA2B;AAEnE,QAAM,aAAa,KAAK,OAAO,CAAC,KAAK,GAAG,QAAQ,MAAM,IAAI,KAAK,GAAG,GAAG,CAAC;AAGtE,QAAM,aAAa,KAAK,KAAK,KAAK,OAAO,CAAC,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC;AACpE,QAAM,aAAa,KAAK,KAAK,KAAK,OAAO,CAAC,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC;AAGpE,SAAO,cAAc,aAAa;AACpC;AAMO,MAAM,qBAAqB,YAA2B;AAC3D,QAAM,MAAM,QAAQ,IAAI;AACxB,SAAO,OAAO;AAAA,IACZ,MAAM,CAAC,QAAQ,GAAG,UAAU,QAAQ,GAAG,IAAI,cAAc,MAAM;AAAA,EACjE,CAAC;AAGD,QAAM,OAAO,QAAQ,QAAQ,OAAO;AACpC,QAAM,QAAQ,SAAS,QAAQ,OAAO;AAEtC,MAAI,SAAmC,CAAC;AAExC,QAAM,QAAQ,EAAE,GAAG,MAAM,GAAG,MAAM;AAGlC,aAAW,WAAW,OAAO,KAAK,KAAK,GAAG;AAExC,UAAM,aAAa,UAAU,MAAM,OAA6B,CAAC;AAGjE,eAAW,cAAc,OAAO,KAAK,UAAU,GAAG;AAChD,YAAM,cAAc,OAAO,UAAU,IAAI;AACzC,YAAM,eAAe,WAAW;AAEhC,YAAM,YAAY,WAChB,UACF;AAEA,YAAM,mBAAmB,GAAG,OAAO,UAAU,WAAW;AAGxD,YAAM,eAAe,eACnB,gBACF;AAEA,UAAI,YAAY;AAEhB,UAAI,CAAC,WAAW;AACd,oBAAY,MAAM,kBAAkB,SAAS;AAAA,MAC/C;AAGA,eAAS,EAAE,GAAG,QAAQ,CAAC,gBAAgB,GAAG,UAAU;AAGpD,kBAAY,KAAK;AAAA,QACf;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS;AAAA,MACX,CAAC;AAED,cAAQ,KAAK,cAAc,gBAAgB,IAAI,YAAY,EAAE;AAAA,IAC/D;AAAA,EACF;AAEA,MAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,QAAI;AAEF,UAAI,KAAK,UAAU,MAAM,MAAM,KAAK,UAAU,cAAc,GAAG;AAE7D,WAAG;AAAA,UACD;AAAA,UACA,KAAK,UAAU,QAAQ,MAAM,CAAC;AAAA,QAChC;AAAA,MACF;AAAA,IACF,SAAS,OAAO;AACd,cAAQ,MAAM,KAAK;AAAA,IACrB;AAAA,EACF;AACF;AAGA,mBAAmB;AASZ,MAAM,uBAAuB,OAClC,UAC6B;AAE7B,QAAM,iBAAiB,MAAM,kBAAkB,KAAK;AAGpD,QAAM,UAAU,YACb,IAAI,CAAC,WAAW;AAAA,IACf,GAAG;AAAA,IACH,YAAY,iBAAiB,gBAAgB,MAAM,SAAS;AAAA;AAAA,EAC9D,EAAE,EACD,OAAO,CAAC,UAAU,MAAM,aAAa,8BAA8B,EACnE,KAAK,CAAC,GAAG,MAAM,EAAE,aAAa,EAAE,UAAU,EAC1C,MAAM,GAAG,sBAAsB;AAGlC,SAAO;AACT;AASO,MAAM,aAA2C;AAAA,EACtD,MAAM;AAAA,EACN,SACE;AAAA;AAwBJ;AAkBO,MAAM,iBAAiB,OAC5B,UACA,YACkC;AAClC,QAAM,SAAS,IAAI,OAAO,EAAE,QAAQ,QAAQ,IAAI,eAAe,CAAC;AAIhE,QAAM,eAAe,SAAS,OAAO,CAAC,YAAY,QAAQ,SAAS,MAAM;AAGzE,QAAM,QAAQ,aACX,IAAI,CAAC,YAAY,KAAK,QAAQ,OAAO,EAAE,EACvC,KAAK,IAAI;AAGZ,QAAM,0BAA0B,MAAM,qBAAqB,KAAK;AAGhE,QAAM,eAA+C;AAAA,IACnD;AAAA,MACE,GAAG;AAAA,MACH,SAAS,WAAW,QAAQ;AAAA,QAC1B;AAAA,QACA,wBAAwB,WAAW,IAC/B,qDACA,wBACG;AAAA,UACC,CAAC,KAAK,QACJ,UAAU,GAAG,eAAe,IAAI,OAAO;AAAA,EAAO,IAAI,OAAO;AAAA,QAC7D,EACC,KAAK,MAAM;AAAA;AAAA,MACpB;AAAA,IACF;AAAA,IACA,GAAG;AAAA;AAAA,EACL;AAGA,QAAM,WAAW,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,IACpD,OAAO;AAAA,IACP,aAAa;AAAA,IACb,UAAU;AAAA,IACV,QAAQ;AAAA,EACV,CAAC;AAED,MAAI,eAAe;AACnB,mBAAiB,SAAS,UAAU;AAClC,UAAM,UAAU,MAAM,QAAQ,CAAC,GAAG,OAAO,WAAW;AACpD,QAAI,SAAS;AACX,sBAAgB;AAChB,eAAS,YAAY,OAAO;AAAA,IAC9B;AAAA,EACF;AAGA,QAAM,eAAe;AAAA,IACnB,GAAG,IAAI,IAAI,wBAAwB,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC;AAAA,EAC9D;AAGA,SAAO;AAAA,IACL,UAAU,gBAAgB;AAAA,IAC1B;AAAA,EACF;AACF;","names":[]}