@intlayer/backend 3.5.4 → 3.5.6

package/dist/esm/services/tag.service.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/services/tag.service.ts"],"sourcesContent":["import { TagModel } from '@models/tag.model';\nimport { GenericError } from '@utils/errors';\nimport type { TagFilters } from '@utils/filtersAndPagination/getTagFiltersAndPagination';\nimport { type TagFields, validateTag } from '@utils/validation/validateTag';\nimport type { ObjectId } from 'mongoose';\nimport { Organization } from '@/export';\nimport type { Tag, TagData, TagDocument } from '@/types/tag.types';\n\n/**\n * Finds tags based on filters and pagination options.\n * @param filters - MongoDB filter query.\n * @param skip - Number of documents to skip.\n * @param limit - Number of documents to limit.\n * @returns List of tags matching the filters.\n */\nexport const findTags = async (\n  filters: TagFilters,\n  skip = 0,\n  limit = 100\n): Promise<TagDocument[]> =>\n  await TagModel.find(filters).skip(skip).limit(limit);\n\n/**\n * Finds a tag by its ID.\n * @param tagId - The ID of the tag to find.\n * @returns The tag matching the ID.\n */\nexport const getTagById = async (\n  tagId: string | ObjectId\n): Promise<TagDocument> => {\n  const tag = await TagModel.findById(tagId);\n\n  if (!tag) {\n    throw new GenericError('TAG_NOT_FOUND', { tagId });\n  }\n\n  return tag;\n};\n\nexport const getTagsByKeys = async (\n  keys: string[],\n  organizationId: string | Organization['_id']\n): Promise<TagDocument[]> => {\n  const tags = await TagModel.find({ key: { $in: keys }, organizationId });\n\n  return tags;\n};\n\n/**\n * Counts the total number of tags that match the filters.\n * @param filters - MongoDB filter query.\n * @returns Total number of tags.\n */\nexport const countTags = async (filters: TagFilters): Promise<number> => {\n  const result = await TagModel.countDocuments(filters);\n\n  if (typeof result === 'undefined') {\n    throw new GenericError('TAG_COUNT_FAILED', { filters });\n  }\n\n  return result;\n};\n\n/**\n * Creates a new tag in the database.\n * @param  tag - The tag data to create.\n * @returns The created tag.\n */\nexport const createTag = async (tag: TagData): Promise<TagDocument> => {\n  const errors = await validateTag(tag, ['key']);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('TAG_INVALID_FIELDS', { errors });\n  }\n\n  return await TagModel.create(tag);\n};\n\n/**\n * Updates an existing tag in the database by its ID.\n * @param tagId - The ID of the tag to update.\n * @param tag - The updated tag data.\n * @returns The updated tag.\n */\nexport const updateTagById = async (\n  tagId: string | ObjectId,\n  tag: Partial<Tag>\n): Promise<TagDocument> => {\n  const updatedKeys = Object.keys(tag) as TagFields;\n\n  const errors = validateTag(tag, updatedKeys);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('TAG_INVALID_FIELDS', {\n      tagId,\n      errors,\n    });\n  }\n\n  const result = await TagModel.updateOne({ _id: tagId }, tag);\n\n  if (result.matchedCount === 0) {\n    throw new GenericError('TAG_UPDATE_FAILED', { tagId });\n  }\n\n  return await getTagById(tagId);\n};\n\n/**\n * Deletes a tag from the database by its ID.\n * @param tagId - The ID of the tag to delete.\n * @returns The result of the deletion operation.\n */\nexport const deleteTagById = async (\n  tagId: string | ObjectId\n): Promise<TagDocument> => {\n  const tag = await TagModel.findByIdAndDelete(tagId);\n\n  if (!tag) {\n    throw new GenericError('TAG_NOT_FOUND', { tagId });\n  }\n\n  return tag;\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AACzB,SAAS,oBAAoB;AAE7B,SAAyB,mBAAmB;AAYrC,MAAM,WAAW,OACtB,SACA,OAAO,GACP,QAAQ,QAER,MAAM,SAAS,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,KAAK;AAO9C,MAAM,aAAa,OACxB,UACyB;AACzB,QAAM,MAAM,MAAM,SAAS,SAAS,KAAK;AAEzC,MAAI,CAAC,KAAK;AACR,UAAM,IAAI,aAAa,iBAAiB,EAAE,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;AAEO,MAAM,gBAAgB,OAC3B,MACA,mBAC2B;AAC3B,QAAM,OAAO,MAAM,SAAS,KAAK,EAAE,KAAK,EAAE,KAAK,KAAK,GAAG,eAAe,CAAC;AAEvE,SAAO;AACT;AAOO,MAAM,YAAY,OAAO,YAAyC;AACvE,QAAM,SAAS,MAAM,SAAS,eAAe,OAAO;AAEpD,MAAI,OAAO,WAAW,aAAa;AACjC,UAAM,IAAI,aAAa,oBAAoB,EAAE,QAAQ,CAAC;AAAA,EACxD;AAEA,SAAO;AACT;AAOO,MAAM,YAAY,OAAO,QAAuC;AACrE,QAAM,SAAS,MAAM,YAAY,KAAK,CAAC,KAAK,CAAC;AAE7C,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,aAAa,sBAAsB,EAAE,OAAO,CAAC;AAAA,EACzD;AAEA,SAAO,MAAM,SAAS,OAAO,GAAG;AAClC;AAQO,MAAM,gBAAgB,OAC3B,OACA,QACyB;AACzB,QAAM,cAAc,OAAO,KAAK,GAAG;AAEnC,QAAM,SAAS,YAAY,KAAK,WAAW;AAE3C,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,aAAa,sBAAsB;AAAA,MAC3C;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAEA,QAAM,SAAS,MAAM,SAAS,UAAU,EAAE,KAAK,MAAM,GAAG,GAAG;AAE3D,MAAI,OAAO,iBAAiB,GAAG;AAC7B,UAAM,IAAI,aAAa,qBAAqB,EAAE,MAAM,CAAC;AAAA,EACvD;AAEA,SAAO,MAAM,WAAW,KAAK;AAC/B;AAOO,MAAM,gBAAgB,OAC3B,UACyB;AACzB,QAAM,MAAM,MAAM,SAAS,kBAAkB,KAAK;AAElD,MAAI,CAAC,KAAK;AACR,UAAM,IAAI,aAAa,iBAAiB,EAAE,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;","names":[]}

package/dist/esm/types/tag.types.mjs

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

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

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

package/dist/esm/utils/auditDictionary/CJS_FORMAT.md

@@ -0,0 +1,23 @@
+```javascript
+const { t, enu } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+module.exports = {
+  key: "my-key",
+  content: {
+    exampleText: t({
+      en: "Example of content in English",
+      fr: "Example de contenu en français",
+      es: "Ejemplo de contenido en español",
+    }),
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      0: "No cars",
+      1: "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+};
+```

package/dist/esm/utils/auditDictionary/JSON_FORMAT.md

@@ -0,0 +1,26 @@
+```json
+{
+  "key": "my-key",
+  "content": {
+    "profileText": {
+      "NodeType": "translation",
+      "translation": {
+        "en": "Manage profile",
+        "fr": "Gérer le profil",
+        "es": "Administrar perfil"
+      }
+    },
+    "numberOfCar": {
+      "NodeType": "enumeration",
+      "enumeration": {
+        "<-1": "Less than minus one car",
+        "-1": "Minus one car",
+        "0": "No cars",
+        "1": "One car",
+        ">5": "Some cars",
+        ">19": "Many cars"
+      }
+    }
+  }
+}
+```

package/dist/esm/utils/auditDictionary/JSX_FORMAT.md

@@ -0,0 +1,28 @@
+```tsx
+import React from "react";
+import { t, enu, type DeclarationContent } from "intlayer";
+
+export default {
+  key: "my-key",
+  content: {
+    exampleText: t({
+      en: "Example of content in English",
+      fr: "Example de contenu en français",
+      es: "Ejemplo de contenido en español",
+    }),
+    exampleOfReactNode: t({
+      en: <h1>Example of ReactNode in English</h1>,
+      fr: <h1>Example de ReactNode en français</h1>,
+      es: <h1>Ejemplo de ReactNode en español</h1>,
+    }),
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      "0": "No cars",
+      "1": "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+};
+```

package/dist/esm/utils/auditDictionary/MJS_FORMAT.md

@@ -0,0 +1,23 @@
+```javascript
+import { t, enu } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+export default {
+  key: "my-key",
+  content: {
+    exampleText: t({
+      en: "Example of content in English",
+      fr: "Example de contenu en français",
+      es: "Ejemplo de contenido en español",
+    }),
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      0: "No cars",
+      1: "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+};
+```

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

@@ -0,0 +1,151 @@
+You are an expert in internationalization, copy writing and content management. Your task is to audit the content declaration files in the project and identify any potential issues or inconsistencies. Provide a detailed report of any issues found, including the file path, line number, and a brief explanation of the issue.
+
+**Instructions:**
+
+1. **File Location:**
+
+   - The content declaration files are located in the `{{filePath}}` directory relative to the project root.
+
+2. **Locales:**
+
+   - Default locale: {{defaultLocale}}
+   - Required Locales: {{otherLocales}} (add the missing locales in `t({ ... })` function)
+
+3. **Content Declaration Format:**
+
+   - Example format:
+
+   {{declarationsContentTemplate}}
+
+4. **Audit Requirements:**
+
+   - **Consistency:** Ensure that all keys have translations for all specified locales.
+   - **Missing Content:** Identify any missing translations and specify the expected content.
+   - **Misplaced Content:** Detect if any translations are placed under incorrect keys.
+   - **Type Compliance:** Verify that the content types match the declarations (e.g., strings, string arrays).
+
+5. **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.
+   - **Do Not Change a value type** If a key value is like `exampleKey: "exampleValue"`, avoid a maximum to not change the value type to `exampleKey: t({ en: "exampleValue" })`.
+   - **Return Only Final File Content:** Provide the updated file content without any additional comments or explanations.
+   - **Ensure No Translations are Missing:** If an element is a multilingual content and a translation is missing, add it. Including localized content as `es-MX` or `en-UK`.
+   - **Manage Localizations:** If the required languages contains similar languages, as `en` and `en-GB`, consider `en` as English US and `en-GB` as English UK, and insert or review both translations to maintain clarity and correctness.
+   - **Order Translations:** If the translations are not in the same order as the required languages list, consider reordering the translations to maintain clarity and correctness.
+   - **Escape Special Characters:** If the translations contain special characters, escape them using the appropriate escape sequence.
+   - **Respect the tags instructions:** If the tags instructions are provided, ensure that the audited file adheres to them.
+
+6. **Example Scenario:**
+
+   - **Example 1:**
+
+     - **Input File:**
+
+     ```typescript
+     import { t, type DeclarationContent } from "intlayer";
+
+     export default {
+       key: "creative-work-structured-data",
+       content: {
+         audienceType: t({
+           en: "Developers, Content Managers",
+           fr: "Développeurs, Responsables de contenu",
+           es: "Desarrolladores, Gestores de Contenido",
+         }),
+       },
+     } satisfies DeclarationContent;
+     ```
+
+     - **Expected Output (No Changes Needed):**
+
+       ```typescript
+       import { t, type DeclarationContent } from "intlayer";
+
+       export default {
+         key: "creative-work-structured-data",
+         content: {
+           audienceType: t({
+             en: "Developers, Content Managers",
+             fr: "Développeurs, Responsables de contenu",
+             es: "Desarrolladores, Gestores de Contenido",
+           }),
+         },
+       } satisfies DeclarationContent;
+       ```
+
+     - **Incorrect Output (Unwanted Structural Change):**
+
+       ```typescript
+       import { t, type DeclarationContent } from "intlayer";
+
+       export default {
+         key: "creative-work-structured-data",
+         content: {
+           audienceType: t({
+             en: "Developers, Content Managers",
+             fr: "Développeurs, Responsables de contenu",
+             es: "Desarrolladores, Gestores de Contenido",
+           }),
+           // Missing multilingual content for 'projectDescription'
+           projectDescription: t({
+             en: "This project involves structured data for creative work.",
+             fr: "Ce projet implique des données structurées pour le travail créatif.",
+             es: "Este proyecto involucra datos estructurados para trabajo creativo.",
+           }),
+         },
+       } satisfies DeclarationContent;
+       ```
+
+     - **Clarification:** In this scenario, since the input file is already valid and complete, the expected output should be identical to the input without any additional fields or comments.
+
+   - **Example 2:**
+
+     - **Input File:**
+
+     ```typescript
+     import { t } from "react-intlayer";
+
+     const content = {
+       key: "creative-work-structured-data",
+       content: {
+         audienceType: t({
+           en: "Developers, Content Managers",
+           es: "Desarrolladores, Gestores de Contenido",
+         }),
+       },
+     };
+     ```
+
+     - **Expected Output (No Changes Needed):**
+
+       ```typescript
+       import { t, type DeclarationContent } from "intlayer";
+
+       const content = {
+         key: "creative-work-structured-data",
+         content: {
+           audienceType: t({
+             en: "Developers, Content Managers",
+             fr: "Développeurs, Responsables de contenu",
+             es: "Desarrolladores, Gestores de Contenido",
+           }),
+         },
+       } satisfies DeclarationContent;
+       ```
+
+     - **Clarification:** In this scenario:
+       - A missing translation for the `audienceType` key was added.
+       - The import of the `t` function was imported from `react-intlayer` instead of `intlayer`.
+       - A type `DeclarationContent` was added to the file to strengthen the content declaration.
+
+**Tags Instructions:**
+
+{{tagsInstructions}}
+
+**File to Audit:**
+
+{{fileContent}}
+
+**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/auditDictionary/TSX_FORMAT.md

@@ -0,0 +1,28 @@
+```tsx
+import React, { type ReactNode } from "react";
+import { t, enu, type DeclarationContent } from "intlayer";
+
+export default {
+  key: "my-key",
+  content: {
+    exampleText: t({
+      en: "Example of content in English",
+      fr: "Example de contenu en français",
+      es: "Ejemplo de contenido en español",
+    }),
+    exampleOfReactNode: t<ReactNode>({
+      en: <h1>Example of ReactNode in English</h1>,
+      fr: <h1>Example de ReactNode en français</h1>,
+      es: <h1>Ejemplo de ReactNode en español</h1>,
+    }),
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      "0": "No cars",
+      "1": "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+} satisfies DeclarationContent;
+```

package/dist/esm/utils/auditDictionary/TS_FORMAT.md

@@ -0,0 +1,22 @@
+```typescript
+import { t, enu, type DeclarationContent } from "intlayer";
+
+export default {
+  key: "my-key",
+  content: {
+    exampleText: t({
+      en: "Example of content in English",
+      fr: "Example de contenu en français",
+      es: "Ejemplo de contenido en español",
+    }),
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      "0": "No cars",
+      "1": "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+} satisfies DeclarationContent;
+```

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

@@ -0,0 +1,73 @@
+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 FILE_TEMPLATE = {
+  ts: getFileContent("./TS_FORMAT.md"),
+  tsx: getFileContent("./TSX_FORMAT.md"),
+  js: getFileContent("./MJS_FORMAT.md"),
+  mjs: getFileContent("./MJS_FORMAT.md"),
+  cjs: getFileContent("./CJS_FORMAT.md"),
+  jsx: getFileContent("./JSX_FORMAT.md"),
+  json: getFileContent("./JSON_FORMAT.md")
+};
+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 auditDictionary = async ({
+  fileContent,
+  filePath,
+  model,
+  openAiApiKey,
+  customPrompt,
+  locales,
+  defaultLocale,
+  tags
+}) => {
+  try {
+    const openai = new OpenAI({
+      apiKey: openAiApiKey
+    });
+    const splitted = (filePath ?? ".json").split(".");
+    const fileExtension = splitted[splitted.length - 1];
+    const prompt = customPrompt ?? CHAT_GPT_PROMPT.replace("{{filePath}}", filePath ?? "Not provided").replace(
+      "{{defaultLocale}}",
+      `{${formatLocaleWithName(defaultLocale)}}`
+    ).replace(
+      "{{otherLocales}}",
+      `{${locales.map(formatLocaleWithName).join(", ")}}`
+    ).replace(
+      "{{declarationsContentTemplate}}",
+      FILE_TEMPLATE[fileExtension]
+    ).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`
+    );
+    return {
+      fileContent: newContent ?? "",
+      tokenUsed: chatCompletion.usage?.total_tokens ?? 0
+    };
+  } catch (error) {
+    console.error(error);
+  }
+};
+export {
+  auditDictionary
+};
+//# sourceMappingURL=index.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/auditDictionary/index.ts"],"sourcesContent":["import { readFileSync } from 'fs';\nimport { dirname, join } from 'path';\nimport { fileURLToPath } from 'url';\nimport { getLocaleName } 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 AuditOptions = {\n  locales: Locales[];\n  defaultLocale: Locales;\n  fileContent: string;\n  filePath?: string;\n  model?: string;\n  openAiApiKey: string;\n  customPrompt?: string;\n  tags?: Tag[];\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\nconst FILE_TEMPLATE: Record<string, string> = {\n  ts: getFileContent('./TS_FORMAT.md'),\n  tsx: getFileContent('./TSX_FORMAT.md'),\n  js: getFileContent('./MJS_FORMAT.md'),\n  mjs: getFileContent('./MJS_FORMAT.md'),\n  cjs: getFileContent('./CJS_FORMAT.md'),\n  jsx: getFileContent('./JSX_FORMAT.md'),\n  json: getFileContent('./JSON_FORMAT.md'),\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 auditDictionary = async ({\n  fileContent,\n  filePath,\n  model,\n  openAiApiKey,\n  customPrompt,\n  locales,\n  defaultLocale,\n  tags,\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    // Read the file's content.\n    const splitted = (filePath ?? '.json').split('.');\n    const fileExtension = splitted[splitted.length - 1];\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      customPrompt ??\n      CHAT_GPT_PROMPT.replace('{{filePath}}', filePath ?? 'Not provided')\n        .replace(\n          '{{defaultLocale}}',\n          `{${formatLocaleWithName(defaultLocale)}}`\n        )\n        .replace(\n          '{{otherLocales}}',\n          `{${locales.map(formatLocaleWithName).join(', ')}}`\n        )\n        .replace(\n          '{{declarationsContentTemplate}}',\n          FILE_TEMPLATE[fileExtension]\n        )\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    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,qBAAqB;AAC9B,SAAS,cAAc;AAEvB,SAAS,cAAc;AAGvB,MAAM,YAAY,QAAQ,cAAc,YAAY,GAAG,CAAC;AAqBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,eAAe,KAAK,WAAW,gBAAgB;AACrD,QAAM,cAAc,aAAa,cAAc,OAAO;AACtD,SAAO;AACT;AAEA,MAAM,gBAAwC;AAAA,EAC5C,IAAI,eAAe,gBAAgB;AAAA,EACnC,KAAK,eAAe,iBAAiB;AAAA,EACrC,IAAI,eAAe,iBAAiB;AAAA,EACpC,KAAK,eAAe,iBAAiB;AAAA,EACrC,KAAK,eAAe,iBAAiB;AAAA,EACrC,KAAK,eAAe,iBAAiB;AAAA,EACrC,MAAM,eAAe,kBAAkB;AACzC;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,kBAAkB,OAAO;AAAA,EACpC;AAAA,EACA;AAAA,EACA;AAAA,EACA;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,YAAY,YAAY,SAAS,MAAM,GAAG;AAChD,UAAM,gBAAgB,SAAS,SAAS,SAAS,CAAC;AAGlD,UAAM,SACJ,gBACA,gBAAgB,QAAQ,gBAAgB,YAAY,cAAc,EAC/D;AAAA,MACC;AAAA,MACA,IAAI,qBAAqB,aAAa,CAAC;AAAA,IACzC,EACC;AAAA,MACC;AAAA,MACA,IAAI,QAAQ,IAAI,oBAAoB,EAAE,KAAK,IAAI,CAAC;AAAA,IAClD,EACC;AAAA,MACC;AAAA,MACA,cAAc,aAAa;AAAA,IAC7B,EACC,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,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/auditDictionaryField/PROMPT.md

@@ -0,0 +1,115 @@
+You are an expert in internationalization, copy writing and content management. Your task is to audit the given element into the content declaration file. If the element is not declared, review it. If this element is missing, write it by considering the given context of the content declaration, and by following instructions.
+
+**Instructions:**
+
+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.
+- **KeyPath** The KeyPath correspond to to the path to retrieve the targeted element from the `content` key of the content declaration file.
+
+2.  **Locales:**
+
+    - Required Locales: {{otherLocales}}
+
+3.  **Audit Requirements:**
+
+    - **Consistency:** Ensure that all keys have translations for all specified locales.
+    - **Missing Content:** Identify any missing translations and specify the expected content.
+    - **Misplaced Content:** Detect if any translations are placed under incorrect keys.
+    - **Type Compliance:** Verify that the content types match the declarations (e.g., strings, string arrays).
+
+4.  **Modification Guidelines:**
+
+    - **Return Only the Targeted Content:** Provide the updated targeted content as plain text without any markdown, additional comments or explanations.
+    - **Consider the locale context:** If the targeted field correspond to a specific language, contains similar languages, as `zh` or `en-GB`, consider return the content in this specified language.
+    - **Escape Special Characters:** If the translations contain special characters, escape them using the appropriate escape sequence.
+    - **Respect the tags instructions:** If the tags instructions are provided, ensure that the audited file adheres to them.
+
+5.  **Example Scenario:**
+
+    - **Example 1:**
+
+      - **Input File:**
+
+      ```typescript
+      import { t, type DeclarationContent } from "intlayer";
+
+      export default {
+        key: "creative-work-structured-data",
+        content: {
+          audienceType: t({
+            en: "Developers, Content Managers",
+            fr: "Développeurs, Responsables de contenu",
+            es: "",
+          }),
+        },
+      } satisfies DeclarationContent;
+      ```
+
+      - **Input keyPath:**
+
+        `[{type: "object", key: "audienceType"},{type: "translation", key: "es"}]`
+
+      - **Expected Output:**
+
+        Desarrolladores, Gestores de Contenido
+
+    - **Example 2:**
+
+      - **Input File:**
+
+      ```typescript
+      import { t, enu, type DeclarationContent } from "intlayer";
+
+      const content = {
+        key: "creative-work-structured-data",
+        content: {
+          en: {
+            audienceType: t({
+              en: "Developers, Content Managers",
+              fr: "Développeurs, Responsables de contenu",
+              es: "Desarrolladores, Gestores de Contenido",
+            }),
+          },
+          audienceType: {
+            object1: enu({
+              "1": t({
+                en: "Developers, Content Managers",
+                es: "Desarrolladores, Gestores de Contenido",
+                fr: "Développeurs, Responsables de contenu",
+              }),
+              ">2": t({
+                en: "Developers, Content Managers",
+                es: "Desarrolladores, Gestores de Contenido",
+                fr: "Here content thst make no sense and should be replaced",
+              }),
+            }),
+          },
+        },
+      } satisfies DeclarationContent;
+      ```
+
+      - **Input target:**
+
+      `[{type: "object", key: "audienceType"},{type: "enumeration", key: ">2"},{type: "object", key: "audienceType"},{type: "translation", key: "es"}]`
+
+      - **Expected Output:**
+
+      Développeurs, Responsables de contenu
+
+**Tags Instructions:**
+
+{{tagsInstructions}}
+
+**File to Audit:**
+
+{{fileContent}}
+
+**KeyPath:**
+
+{{keyPath}}
+
+**Expected Response:**
+
+After auditing, provide only the targeted content as plain text without any Markdown or code block formatting. If no changes are needed, return the targeted content

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":[]}