@intlayer/backend 3.5.5 → 3.5.6

package/dist/types/utils/validation/validateProject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validateProject.d.ts","sourceRoot":"","sources":["../../../../src/utils/validation/validateProject.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,OAAO,CAAC,EAAE,CAAC;AAE9C,QAAA,MAAM,oBAAoB,EAAE,aAK3B,CAAC;AAGF,KAAK,gBAAgB,GAAG,OAAO,CAC7B,MAAM,CAAC,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CACxD,CAAC;AAEF,eAAO,MAAM,eAAe,IAAI,CAAC;AACjC,eAAO,MAAM,eAAe,MAAM,CAAC;AAEnC,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,eAAe,YACjB,OAAO,CAAC,OAAO,CAAC,oCAExB,OAAO,CAAC,gBAAgB,CAuE1B,CAAC"}
+{"version":3,"file":"validateProject.d.ts","sourceRoot":"","sources":["../../../../src/utils/validation/validateProject.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,OAAO,CAAC,EAAE,CAAC;AAE9C,QAAA,MAAM,oBAAoB,EAAE,aAK3B,CAAC;AAGF,KAAK,gBAAgB,GAAG,OAAO,CAC7B,MAAM,CAAC,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CACxD,CAAC;AAEF,eAAO,MAAM,eAAe,IAAI,CAAC;AACjC,eAAO,MAAM,eAAe,MAAM,CAAC;AAEnC,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,eAAe,YACjB,OAAO,CAAC,OAAO,CAAC,oCAExB,OAAO,CAAC,gBAAgB,CA6E1B,CAAC"}

package/dist/types/utils/validation/validateTag.d.ts

@@ -0,0 +1,16 @@
+import type { Tag } from '../../types/tag.types';
+export type TagFields = (keyof Tag)[];
+declare const defaultFieldsToCheck: TagFields;
+type ValidationErrors = Partial<Record<(typeof defaultFieldsToCheck)[number], string[]>>;
+export declare const KEY_MIN_LENGTH = 4;
+export declare const KEY_MAX_LENGTH = 20;
+export declare const NAME_MIN_LENGTH = 4;
+export declare const NAME_MAX_LENGTH = 50;
+/**
+ * Validates an tag object.
+ * @param tag The tag object to validate.
+ * @returns An object containing the validation errors for each field.
+ */
+export declare const validateTag: (tag: Partial<Tag>, fieldsToCheck?: TagFields) => Promise<ValidationErrors>;
+export {};
+//# sourceMappingURL=validateTag.d.ts.map

package/dist/types/utils/validation/validateTag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateTag.d.ts","sourceRoot":"","sources":["../../../../src/utils/validation/validateTag.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;AAEtC,QAAA,MAAM,oBAAoB,EAAE,SAAoB,CAAC;AAGjD,KAAK,gBAAgB,GAAG,OAAO,CAC7B,MAAM,CAAC,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CACxD,CAAC;AAEF,eAAO,MAAM,cAAc,IAAI,CAAC;AAChC,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC,eAAO,MAAM,eAAe,IAAI,CAAC;AACjC,eAAO,MAAM,eAAe,KAAK,CAAC;AAElC;;;;GAIG;AACH,eAAO,MAAM,WAAW,QACjB,OAAO,CAAC,GAAG,CAAC,gCAEhB,OAAO,CAAC,gBAAgB,CAqE1B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/backend",
-  "version": "3.5.5",
+  "version": "3.5.6",
   "private": false,
   "description": "IntLayer Backend is a an application that allow you to manage your IntLayer content and interact with the intlayer editor.",
   "keywords": [
@@ -61,7 +61,6 @@
     "dotenv": "^16.4.5",
     "express": "^5.0.1",
     "helmet": "^8.0.0",
-    "highlight.js": "^11.11.0",
     "jsonwebtoken": "^9.0.2",
     "mongodb": "^6.10.0",
     "mongoose": "^8.8.1",
@@ -103,7 +102,7 @@
     "@utils/ts-config": "^1.0.4",
     "@utils/ts-config-types": "^1.0.4",
     "@utils/tsup-config": "^1.0.4",
-    "intlayer": "^3.5.5"
+    "intlayer": "^3.5.6"
   },
   "scripts": {
     "build": "pnpm build:package & pnpm build:types",

package/dist/cjs/utils/audit/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/utils/audit/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';\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};\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 * 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 auditFile = async ({\n  fileContent,\n  filePath,\n  model,\n  openAiApiKey,\n  customPrompt,\n  locales,\n  defaultLocale,\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\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;AAAA;AAAA;AAAA;AAAA;AAAA,gBAA6B;AAC7B,kBAA8B;AAC9B,iBAA8B;AAC9B,kBAA8B;AAC9B,oBAAuB;AAEvB,oBAAuB;AANvB;AAQA,MAAM,gBAAY,yBAAQ,0BAAc,YAAY,GAAG,CAAC;AAoBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,mBAAe,kBAAK,WAAW,gBAAgB;AACrD,QAAM,kBAAc,wBAAa,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,iBAAa,2BAAc,MAAM;AAGvC,SAAO,GAAG,MAAM,KAAK,UAAU;AACjC;AAcO,MAAM,YAAY,OAAO;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA8D;AAC5D,MAAI;AAIF,UAAM,SAAS,IAAI,qBAAO;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;AAG3C,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,yBAAO;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/audit/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/utils/audit/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';\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};\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 * 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 auditFile = async ({\n  fileContent,\n  filePath,\n  model,\n  openAiApiKey,\n  customPrompt,\n  locales,\n  defaultLocale,\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\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;AAEvB,MAAM,YAAY,QAAQ,cAAc,YAAY,GAAG,CAAC;AAoBxD,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;AAcO,MAAM,YAAY,OAAO;AAAA,EAC9B;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;AAG3C,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":[]}