@intlayer/backend 3.5.5 → 3.5.6

package/dist/esm/utils/auditDictionaryField/index.mjs

@@ -0,0 +1,56 @@
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+import { getLocaleName } from "@intlayer/core";
+import { logger } from './../../logger/index.mjs';
+import { OpenAI } from "openai";
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const getFileContent = (relativeFilePath) => {
+  const absolutePath = join(__dirname, relativeFilePath);
+  const fileContent = readFileSync(absolutePath, "utf-8");
+  return fileContent;
+};
+const CHAT_GPT_PROMPT = getFileContent("./PROMPT.md");
+const formatLocaleWithName = (locale) => {
+  const localeName = getLocaleName(locale);
+  return `${locale}: ${localeName}`;
+};
+const formatTagInstructions = (tags = []) => tags.map((tag) => `- ${tag.key}: ${tag.instructions}`).join("\n\n");
+const auditDictionaryField = async ({
+  fileContent,
+  model,
+  openAiApiKey,
+  customPrompt,
+  locales,
+  keyPath,
+  tags
+}) => {
+  try {
+    const openai = new OpenAI({
+      apiKey: openAiApiKey
+    });
+    const prompt = customPrompt ?? CHAT_GPT_PROMPT.replace(
+      "{{otherLocales}}",
+      `{${locales.map(formatLocaleWithName).join(", ")}}`
+    ).replace("{{keyPath}}", JSON.stringify(keyPath)).replace("{{fileContent}}", fileContent).replace("{{tagsInstructions}}", formatTagInstructions(tags));
+    const chatCompletion = await openai.chat.completions.create({
+      model: model ?? "gpt-4o-mini",
+      messages: [{ role: "system", content: prompt }]
+    });
+    const newContent = chatCompletion.choices[0].message?.content;
+    logger.info(
+      `${chatCompletion.usage?.total_tokens} tokens used in the request`
+    );
+    console.log("newContent", newContent);
+    return {
+      fileContent: newContent ?? "",
+      tokenUsed: chatCompletion.usage?.total_tokens ?? 0
+    };
+  } catch (error) {
+    console.error(error);
+  }
+};
+export {
+  auditDictionaryField
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/utils/auditDictionaryField/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/auditDictionaryField/index.ts"],"sourcesContent":["import { readFileSync } from 'fs';\nimport { dirname, join } from 'path';\nimport { fileURLToPath } from 'url';\nimport { getLocaleName, type KeyPath } from '@intlayer/core';\nimport { logger } from '@logger';\nimport { Locales } from 'intlayer';\nimport { OpenAI } from 'openai';\nimport { Tag } from '@/types/tag.types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type AuditDictionaryFieldOptions = {\n  locales: Locales[];\n  fileContent: string;\n  model?: string;\n  openAiApiKey: string;\n  customPrompt?: string;\n  keyPath: KeyPath[];\n  tags?: Tag[];\n};\nexport type AuditDictionaryFieldResultData = {\n  fileContent: string;\n  tokenUsed: number;\n};\n\n/**\n * Reads the content of a file synchronously.\n *\n * @function\n * @param relativeFilePath - The relative or absolute path to the target file.\n * @returns The entire contents of the specified file as a UTF-8 encoded string.\n */\nconst getFileContent = (relativeFilePath: string): string => {\n  const absolutePath = join(__dirname, relativeFilePath);\n  const fileContent = readFileSync(absolutePath, 'utf-8');\n  return fileContent;\n};\n\n// The prompt template to send to ChatGPT, requesting an audit of content declaration files.\nconst CHAT_GPT_PROMPT = getFileContent('./PROMPT.md');\n\n/**\n * Formats a locale with its full name and returns a string representation.\n *\n * @function\n * @param locale - A locale from the project's configuration (e.g., 'en-US', 'fr-FR').\n * @returns A formatted string combining the locale's name and code. Example: \"English (US): en-US\".\n */\nconst formatLocaleWithName = (locale: Locales): string => {\n  // getLocaleName returns a human-readable name for the locale.\n  const localeName = getLocaleName(locale);\n\n  // Concatenate both the readable name and the locale code.\n  return `${locale}: ${localeName}`;\n};\n\n/**\n * Formats an array of tags with their keys and instructions.\n *\n * @function\n * @param tags - An array of tags from the project's configuration.\n * @returns A string representation of the tags, with their keys and instructions.\n */\nconst formatTagInstructions = (tags: Tag[] = []) =>\n  tags.map((tag) => `- ${tag.key}: ${tag.instructions}`).join('\\n\\n');\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n */\nexport const auditDictionaryField = async ({\n  fileContent,\n  model,\n  openAiApiKey,\n  customPrompt,\n  locales,\n  keyPath,\n  tags,\n}: AuditDictionaryFieldOptions): Promise<\n  AuditDictionaryFieldResultData | undefined\n> => {\n  try {\n    // Optionally, you could initialize and configure the OpenAI client here, if you intend to make API calls.\n    // Uncomment and configure the following lines if you have `openai` installed and want to call the API:\n\n    const openai = new OpenAI({\n      apiKey: openAiApiKey,\n    });\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      customPrompt ??\n      CHAT_GPT_PROMPT.replace(\n        '{{otherLocales}}',\n        `{${locales.map(formatLocaleWithName).join(', ')}}`\n      )\n        .replace('{{keyPath}}', JSON.stringify(keyPath))\n        .replace('{{fileContent}}', fileContent)\n        .replace('{{tagsInstructions}}', formatTagInstructions(tags));\n\n    // Example of how you might request a completion from ChatGPT:\n    const chatCompletion = await openai.chat.completions.create({\n      model: model ?? 'gpt-4o-mini',\n      messages: [{ role: 'system', content: prompt }],\n    });\n\n    const newContent = chatCompletion.choices[0].message?.content;\n\n    logger.info(\n      `${chatCompletion.usage?.total_tokens} tokens used in the request`\n    );\n\n    console.log('newContent', newContent);\n\n    return {\n      fileContent: newContent ?? '',\n      tokenUsed: chatCompletion.usage?.total_tokens ?? 0,\n    };\n  } catch (error) {\n    console.error(error);\n  }\n};\n"],"mappings":"AAAA,SAAS,oBAAoB;AAC7B,SAAS,SAAS,YAAY;AAC9B,SAAS,qBAAqB;AAC9B,SAAS,qBAAmC;AAC5C,SAAS,cAAc;AAEvB,SAAS,cAAc;AAGvB,MAAM,YAAY,QAAQ,cAAc,YAAY,GAAG,CAAC;AAuBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,eAAe,KAAK,WAAW,gBAAgB;AACrD,QAAM,cAAc,aAAa,cAAc,OAAO;AACtD,SAAO;AACT;AAGA,MAAM,kBAAkB,eAAe,aAAa;AASpD,MAAM,uBAAuB,CAAC,WAA4B;AAExD,QAAM,aAAa,cAAc,MAAM;AAGvC,SAAO,GAAG,MAAM,KAAK,UAAU;AACjC;AASA,MAAM,wBAAwB,CAAC,OAAc,CAAC,MAC5C,KAAK,IAAI,CAAC,QAAQ,KAAK,IAAI,GAAG,KAAK,IAAI,YAAY,EAAE,EAAE,KAAK,MAAM;AAQ7D,MAAM,uBAAuB,OAAO;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAEK;AACH,MAAI;AAIF,UAAM,SAAS,IAAI,OAAO;AAAA,MACxB,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,SACJ,gBACA,gBAAgB;AAAA,MACd;AAAA,MACA,IAAI,QAAQ,IAAI,oBAAoB,EAAE,KAAK,IAAI,CAAC;AAAA,IAClD,EACG,QAAQ,eAAe,KAAK,UAAU,OAAO,CAAC,EAC9C,QAAQ,mBAAmB,WAAW,EACtC,QAAQ,wBAAwB,sBAAsB,IAAI,CAAC;AAGhE,UAAM,iBAAiB,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,MAC1D,OAAO,SAAS;AAAA,MAChB,UAAU,CAAC,EAAE,MAAM,UAAU,SAAS,OAAO,CAAC;AAAA,IAChD,CAAC;AAED,UAAM,aAAa,eAAe,QAAQ,CAAC,EAAE,SAAS;AAEtD,WAAO;AAAA,MACL,GAAG,eAAe,OAAO,YAAY;AAAA,IACvC;AAEA,YAAQ,IAAI,cAAc,UAAU;AAEpC,WAAO;AAAA,MACL,aAAa,cAAc;AAAA,MAC3B,WAAW,eAAe,OAAO,gBAAgB;AAAA,IACnD;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,KAAK;AAAA,EACrB;AACF;","names":[]}

package/dist/esm/utils/auditDictionaryMetadata/PROMPT.md

@@ -0,0 +1,76 @@
+Your role is to review content declaration fields. Correct this fields if they are misspelled or do not match the expected content, and / or complete missing content.
+
+1. **Terminology:**
+
+- **Content Declaration:** A content declaration is a is a file (.ts, .js or .json) that contains the multilingual declaration related to a specific content. A content declaration file is usually related to a specific component, or page or section of a website.
+- **Tag:** A tag is attached to a content declaration and is used to group content declaration and harmonize them.
+
+2. **Audit Requirements:**
+
+   - **Do Not Alter Structure:** If the file structure is correct, do not modify it. Only add, update, or remove content declarations as necessary.
+   - **Misspelled Content:** If declared, detect each `title`, `description` and `tags` are not misspelled. If some content is misspelled, correct it.
+
+3. **Fields functions:**
+
+- **Title:** The title of the content declaration allows to easily identify it. It should be considered as a readable way to represent the `key` (example: `page-metadata` -> `Page metadata`). It should be a short and descriptive title that accurately reflects the dictionary.
+- **Description:** The description of the content declaration provides a brief summary of the content declaration. It should be a concise and informative description that explains the purpose and content of the dictionary.
+- **Tags:** The tags is an array of strings that represent the key of the tags associated with the content declaration.
+
+**Expected Response:**
+
+After completion, provide only the final title, description and tags fields in a JSON without any Markdown, code block formatting or any additional comments or explanations.
+
+**Example of expected response:**
+
+- Entry:
+
+```ts
+import { t, type DeclarationContent } from "intlayer";
+import { Metadata } from "next";
+
+const metadataContent = {
+  key: "pricing-metadata",
+  title: "",
+  description:
+    "here a description that doesn't make any sense and should be replaced",
+  content: {
+    title: t({
+      en: "Pricing | Intlayer",
+      fr: "Tarification | Intlayer",
+      es: "Precios | Intlayer",
+    }),
+    description: t({
+      en: "Discover our pricing plans and get access to premium features with Intlayer. Choose the plan that suits you best.",
+      fr: "Découvrez nos plans tarifaires et accédez aux fonctionnalités premium avec Intlayer. Choisissez le plan qui vous convient le mieux.",
+      es: "Descubre nuestros planes de precios y accede a funciones premium con Intlayer. Elige el plan que mejor te convenga.",
+    }),
+    keywords: t<string[]>({
+      en: ["Pricing", "Subscription"],
+      fr: ["Tarification", "Abonnement"],
+      es: ["Precios", "Suscripción"],
+    }),
+  },
+} satisfies DeclarationContent<Metadata>;
+
+export default metadataContent;
+```
+
+- Response:
+
+```json
+{
+  "title": "Pricing page metadata",
+  "description": "Metadata related to the pricing page, includes title, description, keywords, metadata for SEO purpose. It will help search engines understand the content of the page.",
+  "tags": ["page metadata", "pricing page"]
+}
+```
+
+**List of existing Tags:**
+
+Here the list of existing tags as a context to help you to pick related ones.
+
+{{tags}}
+
+**Content Declaration to complete:**
+
+{{contentDeclaration}}

package/dist/esm/utils/auditDictionaryMetadata/index.mjs

@@ -0,0 +1,53 @@
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+import { logger } from './../../logger/index.mjs';
+import { OpenAI } from "openai";
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const getFileContent = (relativeFilePath) => {
+  const absolutePath = join(__dirname, relativeFilePath);
+  const fileContent = readFileSync(absolutePath, "utf-8");
+  return fileContent;
+};
+const CHAT_GPT_PROMPT = getFileContent("./PROMPT.md");
+const auditDictionaryMetadata = async ({
+  model,
+  openAiApiKey,
+  customPrompt,
+  tags,
+  fileContent
+}) => {
+  try {
+    const openai = new OpenAI({
+      apiKey: openAiApiKey
+    });
+    const prompt = customPrompt ?? CHAT_GPT_PROMPT.replace(
+      "{{tags}}",
+      `${JSON.stringify(
+        tags.map(({ key, description }) => `- ${key}: ${description}`).join("\n\n"),
+        null,
+        2
+      )}`
+    ).replace("{{contentDeclaration}}", fileContent);
+    console.log("prompt", prompt);
+    const chatCompletion = await openai.chat.completions.create({
+      model: model ?? "gpt-4o-mini",
+      messages: [{ role: "system", content: prompt }]
+    });
+    const newContent = chatCompletion.choices[0].message?.content;
+    console.log("newContent", newContent);
+    logger.info(
+      `${chatCompletion.usage?.total_tokens} tokens used in the request`
+    );
+    return {
+      fileContent: newContent ?? "",
+      tokenUsed: chatCompletion.usage?.total_tokens ?? 0
+    };
+  } catch (error) {
+    console.error(error);
+  }
+};
+export {
+  auditDictionaryMetadata
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/utils/auditDictionaryMetadata/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/auditDictionaryMetadata/index.ts"],"sourcesContent":["import { readFileSync } from 'fs';\nimport { dirname, join } from 'path';\nimport { fileURLToPath } from 'url';\nimport { logger } from '@logger';\nimport { OpenAI } from 'openai';\nimport { Tag } from '@/types/tag.types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type AuditOptions = {\n  tags: Tag[];\n  fileContent: string;\n  model?: string;\n  openAiApiKey: string;\n  customPrompt?: string;\n};\nexport type AuditFileResultData = { fileContent: string; tokenUsed: number };\n\n/**\n * Reads the content of a file synchronously.\n *\n * @function\n * @param relativeFilePath - The relative or absolute path to the target file.\n * @returns The entire contents of the specified file as a UTF-8 encoded string.\n */\nconst getFileContent = (relativeFilePath: string): string => {\n  const absolutePath = join(__dirname, relativeFilePath);\n  const fileContent = readFileSync(absolutePath, 'utf-8');\n  return fileContent;\n};\n\n// The prompt template to send to ChatGPT, requesting an audit of content declaration files.\nconst CHAT_GPT_PROMPT = getFileContent('./PROMPT.md');\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n *\n */\nexport const auditDictionaryMetadata = async ({\n  model,\n  openAiApiKey,\n  customPrompt,\n  tags,\n  fileContent,\n}: AuditOptions): Promise<AuditFileResultData | undefined> => {\n  try {\n    // Optionally, you could initialize and configure the OpenAI client here, if you intend to make API calls.\n    // Uncomment and configure the following lines if you have `openai` installed and want to call the API:\n\n    const openai = new OpenAI({\n      apiKey: openAiApiKey,\n    });\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      customPrompt ??\n      CHAT_GPT_PROMPT.replace(\n        '{{tags}}',\n        `${JSON.stringify(\n          tags\n            .map(({ key, description }) => `- ${key}: ${description}`)\n            .join('\\n\\n'),\n          null,\n          2\n        )}`\n      ).replace('{{contentDeclaration}}', fileContent);\n\n    console.log('prompt', prompt);\n\n    // Example of how you might request a completion from ChatGPT:\n    const chatCompletion = await openai.chat.completions.create({\n      model: model ?? 'gpt-4o-mini',\n      messages: [{ role: 'system', content: prompt }],\n    });\n\n    const newContent = chatCompletion.choices[0].message?.content;\n\n    console.log('newContent', newContent);\n\n    logger.info(\n      `${chatCompletion.usage?.total_tokens} tokens used in the request`\n    );\n\n    return {\n      fileContent: newContent ?? '',\n      tokenUsed: chatCompletion.usage?.total_tokens ?? 0,\n    };\n  } catch (error) {\n    console.error(error);\n  }\n};\n"],"mappings":"AAAA,SAAS,oBAAoB;AAC7B,SAAS,SAAS,YAAY;AAC9B,SAAS,qBAAqB;AAC9B,SAAS,cAAc;AACvB,SAAS,cAAc;AAGvB,MAAM,YAAY,QAAQ,cAAc,YAAY,GAAG,CAAC;AAkBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,eAAe,KAAK,WAAW,gBAAgB;AACrD,QAAM,cAAc,aAAa,cAAc,OAAO;AACtD,SAAO;AACT;AAGA,MAAM,kBAAkB,eAAe,aAAa;AAS7C,MAAM,0BAA0B,OAAO;AAAA,EAC5C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA8D;AAC5D,MAAI;AAIF,UAAM,SAAS,IAAI,OAAO;AAAA,MACxB,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,SACJ,gBACA,gBAAgB;AAAA,MACd;AAAA,MACA,GAAG,KAAK;AAAA,QACN,KACG,IAAI,CAAC,EAAE,KAAK,YAAY,MAAM,KAAK,GAAG,KAAK,WAAW,EAAE,EACxD,KAAK,MAAM;AAAA,QACd;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH,EAAE,QAAQ,0BAA0B,WAAW;AAEjD,YAAQ,IAAI,UAAU,MAAM;AAG5B,UAAM,iBAAiB,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,MAC1D,OAAO,SAAS;AAAA,MAChB,UAAU,CAAC,EAAE,MAAM,UAAU,SAAS,OAAO,CAAC;AAAA,IAChD,CAAC;AAED,UAAM,aAAa,eAAe,QAAQ,CAAC,EAAE,SAAS;AAEtD,YAAQ,IAAI,cAAc,UAAU;AAEpC,WAAO;AAAA,MACL,GAAG,eAAe,OAAO,YAAY;AAAA,IACvC;AAEA,WAAO;AAAA,MACL,aAAa,cAAc;AAAA,MAC3B,WAAW,eAAe,OAAO,gBAAgB;AAAA,IACnD;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,KAAK;AAAA,EACrB;AACF;","names":[]}

package/dist/esm/utils/auditTag/PROMPT.md

@@ -0,0 +1,34 @@
+Your role is to review a tag. A tag is attached to a content declaration and is used to group content declarations and harmonize them.
+
+- Here an example of a tag of a random project:
+
+  ````json
+  {
+    "key": "page-metadata",
+    "name": "Page metadata",
+    "description": "Contain all metadata related to the page, such as title, description, keywords, etc for SEO purpose. It will help search engines understand the content of the page.",
+    "instructions": "## Metadata Tag//## Content Declaration structure//A content declaration containing this tag should a least includes the following fields://- title/- description/- keywords//### Example of structure//```json/{/  \"key\": \"...\",/  \"content\": {/    \"title\": \"...\",/    \"description\": \"...\",/    \"keywords\": [\"...\", \"...\", \"...\"]/  }/}/```//## Fields instructions//### 1. **Title Tag**//#### **Purpose**//The title tag defines the title of your webpage. It's displayed on search engine results pages (SERPs) as the clickable headline and is essential for both SEO and user experience.//#### **Best Practices**//- **Length:** Aim for **50-60 characters**. Search engines typically display the first 50-60 characters of a title tag. Titles longer than this may be truncated./- **Keywords:** Include primary keywords relevant to the page content, preferably toward the beginning./- **Clarity and Relevance:** Ensure the title accurately reflects the content of the page./- **Branding:** If appropriate, include your brand name at the end of the title (e.g., \"How to Bake a Cake | YourBrand\")./- **Uniqueness:** Each page on your website should have a unique title to avoid confusion and duplication issues.//### 2. **Meta Description**//#### **Purpose**//The meta description provides a brief summary of the webpage's content. While not a direct ranking factor, a compelling meta description can improve click-through rates (CTR) from SERPs.//#### **Best Practices**//- **Length:** Keep it between **150-160 characters**. Descriptions longer than this may be cut off in search results./- **Engaging and Inviting:** Write a clear, concise, and enticing summary that encourages users to click./- **Include Keywords:** Incorporate relevant keywords naturally, as they may be bolded in SERPs when they match the search query./- **Call to Action (CTA):** Use action-oriented language (e.g., \"Learn more,\" \"Discover,\" \"Get started\")./- **Unique Descriptions:** Ensure each page has a unique meta description to differentiate it from others.//### 3. **Meta Keywords**//#### **Purpose**//Historically used to list important keywords for a webpage. However, most modern search engines no longer use meta keywords for ranking.//#### **Best Practices**//- **Page Related Keywords:** The provided keywords should be relevant to the content of the page./- **Uniqueness:** Each page on your website should have a unique set of keywords to avoid confusion and duplication issues./- **Keyword number:** The number of keywords should be between 3-10."
+  }
+  ````
+
+1. **Audit Requirements:**
+
+   - **Misplaced Content:** Detect each `title`, `description` and `instructions` are defined correct. If not, provide the expected content.
+   - **Ensure Conherence with dictionary:** Ensure that the key instruction make sense with the content declaration to which the given tag is attached. If the instructions doesn't looks appropriate, suggest a new one.
+
+2. **Modification Guidelines:**
+
+   - **Do Not Alter Structure:** If the file structure is correct, do not modify it. Only add, update, or remove content declarations as necessary.
+   - **Return Only Final File Content:** Provide the updated file content without any additional comments or explanations.
+
+**Tags to Audit:**
+
+{{tag}}
+
+**Content Declaration that attach the tag into:**
+
+{{contentDeclarations}}
+
+**Expected Response:**
+
+After auditing, provide only the final content of the file as plain text without any Markdown or code block formatting. If no changes are needed, return the file content exactly as it is.

package/dist/esm/utils/auditTag/index.mjs

@@ -0,0 +1,49 @@
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+import { logger } from './../../logger/index.mjs';
+import { OpenAI } from "openai";
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const getFileContent = (relativeFilePath) => {
+  const absolutePath = join(__dirname, relativeFilePath);
+  const fileContent = readFileSync(absolutePath, "utf-8");
+  return fileContent;
+};
+const CHAT_GPT_PROMPT = getFileContent("./PROMPT.md");
+const auditTag = async ({
+  model,
+  openAiApiKey,
+  customPrompt,
+  tag,
+  dictionaries
+}) => {
+  try {
+    const openai = new OpenAI({
+      apiKey: openAiApiKey
+    });
+    const prompt = customPrompt ?? CHAT_GPT_PROMPT.replace("{{tag}}", `${JSON.stringify(tag)}`).replace(
+      "{{contentDeclarations}}",
+      dictionaries.map((dictionary) => `- ${JSON.stringify(dictionary)}`).join("\n\n")
+    );
+    console.log("prompt", prompt);
+    const chatCompletion = await openai.chat.completions.create({
+      model: model ?? "gpt-4o-mini",
+      messages: [{ role: "system", content: prompt }]
+    });
+    const newContent = chatCompletion.choices[0].message?.content;
+    console.log("newContent", newContent);
+    logger.info(
+      `${chatCompletion.usage?.total_tokens} tokens used in the request`
+    );
+    return {
+      fileContent: newContent ?? "",
+      tokenUsed: chatCompletion.usage?.total_tokens ?? 0
+    };
+  } catch (error) {
+    console.error(error);
+  }
+};
+export {
+  auditTag
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/utils/auditTag/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/auditTag/index.ts"],"sourcesContent":["import { readFileSync } from 'fs';\nimport { dirname, join } from 'path';\nimport { fileURLToPath } from 'url';\nimport { logger } from '@logger';\nimport { OpenAI } from 'openai';\nimport { Dictionary } from '@/types/dictionary.types';\nimport { Tag } from '@/types/tag.types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type AuditOptions = {\n  tag: Tag;\n  dictionaries: Dictionary[];\n  model?: string;\n  openAiApiKey: string;\n  customPrompt?: string;\n};\nexport type AuditFileResultData = { fileContent: string; tokenUsed: number };\n\n/**\n * Reads the content of a file synchronously.\n *\n * @function\n * @param relativeFilePath - The relative or absolute path to the target file.\n * @returns The entire contents of the specified file as a UTF-8 encoded string.\n */\nconst getFileContent = (relativeFilePath: string): string => {\n  const absolutePath = join(__dirname, relativeFilePath);\n  const fileContent = readFileSync(absolutePath, 'utf-8');\n  return fileContent;\n};\n\n// The prompt template to send to ChatGPT, requesting an audit of content declaration files.\nconst CHAT_GPT_PROMPT = getFileContent('./PROMPT.md');\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n *\n * @async\n * @function\n * @param filePath - The relative or absolute path to the target file.\n * @param options - Optional configuration for the audit process.\n * @returns This function returns a Promise that resolves once the audit is complete.\n */\nexport const auditTag = async ({\n  model,\n  openAiApiKey,\n  customPrompt,\n  tag,\n  dictionaries,\n}: AuditOptions): Promise<AuditFileResultData | undefined> => {\n  try {\n    // Optionally, you could initialize and configure the OpenAI client here, if you intend to make API calls.\n    // Uncomment and configure the following lines if you have `openai` installed and want to call the API:\n\n    const openai = new OpenAI({\n      apiKey: openAiApiKey,\n    });\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      customPrompt ??\n      CHAT_GPT_PROMPT.replace('{{tag}}', `${JSON.stringify(tag)}`).replace(\n        '{{contentDeclarations}}',\n        dictionaries\n          .map((dictionary) => `- ${JSON.stringify(dictionary)}`)\n          .join('\\n\\n')\n      );\n\n    console.log('prompt', prompt);\n\n    // Example of how you might request a completion from ChatGPT:\n    const chatCompletion = await openai.chat.completions.create({\n      model: model ?? 'gpt-4o-mini',\n      messages: [{ role: 'system', content: prompt }],\n    });\n\n    const newContent = chatCompletion.choices[0].message?.content;\n\n    console.log('newContent', newContent);\n\n    logger.info(\n      `${chatCompletion.usage?.total_tokens} tokens used in the request`\n    );\n\n    return {\n      fileContent: newContent ?? '',\n      tokenUsed: chatCompletion.usage?.total_tokens ?? 0,\n    };\n  } catch (error) {\n    console.error(error);\n  }\n};\n"],"mappings":"AAAA,SAAS,oBAAoB;AAC7B,SAAS,SAAS,YAAY;AAC9B,SAAS,qBAAqB;AAC9B,SAAS,cAAc;AACvB,SAAS,cAAc;AAIvB,MAAM,YAAY,QAAQ,cAAc,YAAY,GAAG,CAAC;AAkBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,eAAe,KAAK,WAAW,gBAAgB;AACrD,QAAM,cAAc,aAAa,cAAc,OAAO;AACtD,SAAO;AACT;AAGA,MAAM,kBAAkB,eAAe,aAAa;AAc7C,MAAM,WAAW,OAAO;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA8D;AAC5D,MAAI;AAIF,UAAM,SAAS,IAAI,OAAO;AAAA,MACxB,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,SACJ,gBACA,gBAAgB,QAAQ,WAAW,GAAG,KAAK,UAAU,GAAG,CAAC,EAAE,EAAE;AAAA,MAC3D;AAAA,MACA,aACG,IAAI,CAAC,eAAe,KAAK,KAAK,UAAU,UAAU,CAAC,EAAE,EACrD,KAAK,MAAM;AAAA,IAChB;AAEF,YAAQ,IAAI,UAAU,MAAM;AAG5B,UAAM,iBAAiB,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,MAC1D,OAAO,SAAS;AAAA,MAChB,UAAU,CAAC,EAAE,MAAM,UAAU,SAAS,OAAO,CAAC;AAAA,IAChD,CAAC;AAED,UAAM,aAAa,eAAe,QAAQ,CAAC,EAAE,SAAS;AAEtD,YAAQ,IAAI,cAAc,UAAU;AAEpC,WAAO;AAAA,MACL,GAAG,eAAe,OAAO,YAAY;AAAA,IACvC;AAEA,WAAO;AAAA,MACL,aAAa,cAAc;AAAA,MAC3B,WAAW,eAAe,OAAO,gBAAgB;AAAA,IACnD;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,KAAK;AAAA,EACrB;AACF;","names":[]}

package/dist/esm/utils/ensureArrayQueryFilter.mjs

@@ -0,0 +1,15 @@
+const ensureArrayQueryFilter = (filter) => {
+  let idsArray;
+  if (typeof filter === "string") {
+    idsArray = filter.split(",");
+  } else if (Array.isArray(filter)) {
+    idsArray = filter;
+  } else {
+    idsArray = [];
+  }
+  return idsArray;
+};
+export {
+  ensureArrayQueryFilter
+};
+//# sourceMappingURL=ensureArrayQueryFilter.mjs.map

package/dist/esm/utils/ensureArrayQueryFilter.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/ensureArrayQueryFilter.ts"],"sourcesContent":["export const ensureArrayQueryFilter = (\n  filter: string | string[] | undefined\n): string[] | undefined => {\n  let idsArray: string[];\n\n  if (typeof filter === 'string') {\n    idsArray = filter.split(',');\n  } else if (Array.isArray(filter)) {\n    idsArray = filter;\n  } else {\n    idsArray = [];\n  }\n\n  return idsArray;\n};\n"],"mappings":"AAAO,MAAM,yBAAyB,CACpC,WACyB;AACzB,MAAI;AAEJ,MAAI,OAAO,WAAW,UAAU;AAC9B,eAAW,OAAO,MAAM,GAAG;AAAA,EAC7B,WAAW,MAAM,QAAQ,MAAM,GAAG;AAChC,eAAW;AAAA,EACb,OAAO;AACL,eAAW,CAAC;AAAA,EACd;AAEA,SAAO;AACT;","names":[]}

package/dist/esm/utils/ensureMongoDocumentToObject.mjs

@@ -0,0 +1,11 @@
+const ensureMongoDocumentToObject = (potentialDocument) => {
+  let potentialObject = potentialDocument;
+  if (typeof potentialDocument.toObject === "function") {
+    potentialObject = potentialDocument.toObject();
+  }
+  return potentialObject;
+};
+export {
+  ensureMongoDocumentToObject
+};
+//# sourceMappingURL=ensureMongoDocumentToObject.mjs.map

package/dist/esm/utils/ensureMongoDocumentToObject.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/ensureMongoDocumentToObject.ts"],"sourcesContent":["import type { Document } from 'mongoose';\n\n/**\n * If the dictionary is a mongoose document, convert it to an object\n * @param potentialDocument - The potential document to convert.\n * @returns The potential document converted to an object.\n */\nexport const ensureMongoDocumentToObject = <T extends object | Document>(\n  potentialDocument: T\n): T => {\n  let potentialObject: T = potentialDocument as T;\n\n  // If the user is a mongoose document, convert it to an object\n  if (typeof (potentialDocument as Document).toObject === 'function') {\n    potentialObject = (potentialDocument as Document).toObject();\n  }\n\n  return potentialObject as T;\n};\n"],"mappings":"AAOO,MAAM,8BAA8B,CACzC,sBACM;AACN,MAAI,kBAAqB;AAGzB,MAAI,OAAQ,kBAA+B,aAAa,YAAY;AAClE,sBAAmB,kBAA+B,SAAS;AAAA,EAC7D;AAEA,SAAO;AACT;","names":[]}

package/dist/esm/utils/errors/errorCodes.mjs

@@ -1234,6 +1234,97 @@ const errorData = {
       es: "Error al auditar los archivos de declaraci\xF3n de contenido."
     },
     statusCode: HttpStatusCodes.INTERNAL_SERVER_ERROR_500
+  },
+  TAG_NOT_FOUND: {
+    title: {
+      en: "Tag Not Found",
+      fr: "Tag non trouv\xE9",
+      es: "Tag no encontrado"
+    },
+    message: {
+      en: "The specified tag could not be found.",
+      fr: "Le tag sp\xE9cifi\xE9 est introuvable.",
+      es: "El tag especificado no se pudo encontrar."
+    },
+    statusCode: HttpStatusCodes.NOT_FOUND_404
+  },
+  TAG_ID_NOT_FOUND: {
+    title: {
+      en: "Tag ID Not Found",
+      fr: "Identifiant de tag non trouv\xE9",
+      es: "Identificador de tag no encontrado"
+    },
+    message: {
+      en: "The tag ID was not found.",
+      fr: "L'identifiant de tag n'a pas \xE9t\xE9 trouv\xE9.",
+      es: "El identificador de tag no se ha encontrado."
+    },
+    statusCode: HttpStatusCodes.NOT_FOUND_404
+  },
+  TAG_ID_MISMATCH: {
+    title: {
+      en: "Tag ID Mismatch",
+      fr: "Identifiant de tag non correspondant",
+      es: "Identificador de tag no coincidente"
+    },
+    message: {
+      en: "The provided tag ID does not match the expected value. Please verify and try again.",
+      fr: "L'identifiant de tag fourni ne correspond pas \xE0 la valeur attendue. Veuillez v\xE9rifier et r\xE9essayer.",
+      es: "El identificador de tag proporcionado no coincide con el valor esperado. Verifique e intente nuevamente."
+    },
+    statusCode: HttpStatusCodes.BAD_REQUEST_400
+  },
+  TAG_COUNT_FAILED: {
+    title: {
+      en: "Tag Count Failed",
+      fr: "\xC9chec du comptage du tag",
+      es: "Error al contar el tag"
+    },
+    message: {
+      en: "Failed to count tags.",
+      fr: "Le comptage des tags a \xE9chou\xE9.",
+      es: "No se pudo contar los tags."
+    },
+    statusCode: HttpStatusCodes.INTERNAL_SERVER_ERROR_500
+  },
+  TAG_INVALID_FIELDS: {
+    title: {
+      en: "Tag Invalid Fields",
+      fr: "Champs du tag invalides",
+      es: "Campos del tag no v\xE1lidos"
+    },
+    message: {
+      en: "The provided tag fields are invalid.",
+      fr: "Les champs fournis pour le tag sont invalides.",
+      es: "Los campos proporcionados para el tag no son v\xE1lidos."
+    },
+    statusCode: HttpStatusCodes.BAD_REQUEST_400
+  },
+  TAG_UPDATE_FAILED: {
+    title: {
+      en: "Tag Update Failed",
+      fr: "\xC9chec de la mise \xE0 jour du tag",
+      es: "Error al actualizar el tag"
+    },
+    message: {
+      en: "Failed to update the specified tag.",
+      fr: "La mise \xE0 jour du tag a \xE9chou\xE9.",
+      es: "No se pudo actualizar el tag especificado."
+    },
+    statusCode: HttpStatusCodes.INTERNAL_SERVER_ERROR_500
+  },
+  TAG_NOT_IN_ORGANIZATION: {
+    title: {
+      en: "Tag Not In Organization",
+      fr: "Tag non dans l'organisation",
+      es: "Etiqueta no en la organizaci\xF3n"
+    },
+    message: {
+      en: "The specified tag is not in the organization.",
+      fr: "Le tag sp\xE9cifi\xE9 n'est pas dans l'organisation.",
+      es: "La etiqueta especificada no est\xE1 en la organizaci\xF3n."
+    },
+    statusCode: HttpStatusCodes.FORBIDDEN_403
   }
 };
 export {