@intlayer/core 1.0.1 → 1.2.0

package/dist/cjs/transpiler/content_transformers/enumeration/enumeration.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/enumeration.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { NodeType } from '../../../types/index';\nimport {\n  getStackTraceInfo,\n  type NoteStackTraceInfo,\n} from '../../../utils/getStackTraceInfo';\n\ntype Positif = number | `${number}`;\ntype Negatif = `-${number}`;\ntype Numbers = Positif | Negatif;\n\ntype Equal = Numbers;\ntype EqualString = `=${Numbers}`;\ntype Superior = `>${Numbers}`;\ntype SuperiorOrEqual = `>=${Numbers}`;\ntype Inferior = `<${Numbers}`;\ntype InferiorOrEqual = `<=${Numbers}`;\n\ntype EnterFormat =\n  | Equal\n  | EqualString\n  | Superior\n  | SuperiorOrEqual\n  | Inferior\n  | InferiorOrEqual;\n\nexport type QuantityContent<Content> = Record<EnterFormat, Content>;\n\nexport type EnumerationContent<Content> = Partial<QuantityContent<Content>> &\n  NoteStackTraceInfo & {\n    nodeType: NodeType.Enumeration;\n  };\n\n/**\n * Create a JSON string with the content and the stack trace information\n */\nconst enumeration = <Content>(content?: Partial<QuantityContent<Content>>) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: EnumerationContent<Content> = {\n      nodeType: NodeType.Enumeration,\n      ...stackTraceInfo,\n      1: content,\n    };\n\n    return result;\n  }\n\n  const result: EnumerationContent<Content> = {\n    nodeType: NodeType.Enumeration,\n    ...stackTraceInfo,\n    ...content,\n  };\n\n  return result;\n};\n\nexport { enumeration as enu };\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,mBAAyB;AACzB,+BAGO;AA+BP,MAAM,cAAc,CAAU,YAAgD;AAC5E,QAAM,qBAAiB,4CAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,sBAAS;AAAA,MACnB,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,sBAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAG;AAAA,EACL;AAEA,SAAO;AACT;","names":["result"]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/enumeration.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { NodeType } from '../../../types/index';\nimport {\n  getStackTraceInfo,\n  type NoteStackTraceInfo,\n} from '../../../utils/getStackTraceInfo';\n\ntype Positif = number | `${number}`;\ntype Negatif = `-${number}`;\ntype Numbers = Positif | Negatif;\n\ntype Equal = Numbers;\ntype EqualString = `=${Numbers}`;\ntype Superior = `>${Numbers}`;\ntype SuperiorOrEqual = `>=${Numbers}`;\ntype Inferior = `<${Numbers}`;\ntype InferiorOrEqual = `<=${Numbers}`;\n\ntype EnterFormat =\n  | Equal\n  | EqualString\n  | Superior\n  | SuperiorOrEqual\n  | Inferior\n  | InferiorOrEqual;\n\nexport type QuantityContent<Content> = Record<EnterFormat, Content>;\n\nexport type EnumerationContent<Content> = Partial<QuantityContent<Content>> &\n  NoteStackTraceInfo & {\n    nodeType: NodeType.Enumeration;\n  };\n\n/**\n * Function intended to be used to build intlayer dictionaries.\n *\n * Allow to pick a content based on a quantity.\n *\n * Usage:\n *\n * const content = enu({\n *  '<=-2.3': 'You have less than -2.3',\n *  '<1': 'You have less than one',\n *  '2': 'You have two',\n *  '>=3': 'You have three or more',\n * });\n *\n * The order of the keys will define the priority of the content.\n *\n */\nconst enumeration = <Content>(content?: Partial<QuantityContent<Content>>) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: EnumerationContent<Content> = {\n      nodeType: NodeType.Enumeration,\n      ...stackTraceInfo,\n      1: content,\n    };\n\n    return result;\n  }\n\n  const result: EnumerationContent<Content> = {\n    nodeType: NodeType.Enumeration,\n    ...stackTraceInfo,\n    ...content,\n  };\n\n  return result;\n};\n\nexport { enumeration as enu };\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,mBAAyB;AACzB,+BAGO;AA6CP,MAAM,cAAc,CAAU,YAAgD;AAC5E,QAAM,qBAAiB,4CAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,sBAAS;AAAA,MACnB,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,sBAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAG;AAAA,EACL;AAEA,SAAO;AACT;","names":["result"]}

package/dist/cjs/transpiler/content_transformers/enumeration/enumeration.d.ts

@@ -16,7 +16,21 @@ type EnumerationContent<Content> = Partial<QuantityContent<Content>> & NoteStack
     nodeType: NodeType.Enumeration;
 };
 /**
- * Create a JSON string with the content and the stack trace information
+ * Function intended to be used to build intlayer dictionaries.
+ *
+ * Allow to pick a content based on a quantity.
+ *
+ * Usage:
+ *
+ * const content = enu({
+ *  '<=-2.3': 'You have less than -2.3',
+ *  '<1': 'You have less than one',
+ *  '2': 'You have two',
+ *  '>=3': 'You have three or more',
+ * });
+ *
+ * The order of the keys will define the priority of the content.
+ *
  */
 declare const enumeration: <Content>(content?: Partial<QuantityContent<Content>>) => EnumerationContent<Content>;
 

package/dist/cjs/transpiler/content_transformers/enumeration/getEnumerationContent.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/getEnumerationContent.ts"],"sourcesContent":["import type { QuantityContent } from './enumeration';\n\ntype Key = keyof QuantityContent<string>;\n\nexport const getEnumerationContent = <Content>(\n  enumerationContent: QuantityContent<Content>,\n  quantity: number\n): Content => {\n  const numericKeys = Object.keys(enumerationContent);\n\n  for (const key of numericKeys) {\n    const isEqual =\n      (!key.startsWith('>') &&\n        !key.startsWith('<') &&\n        !key.startsWith('=') &&\n        parseFloat(key) === quantity) ||\n      (key.startsWith('=') && parseFloat(key.slice(1)) === quantity);\n    const isSuperior =\n      key.startsWith('>') && quantity > parseFloat(key.slice(1));\n    const isSuperiorOrEqual =\n      key.startsWith('>=') && quantity >= parseFloat(key.slice(2));\n    const isInferior =\n      key.startsWith('<') && quantity < parseFloat(key.slice(1));\n    const isInferiorOrEqual =\n      key.startsWith('<=') && quantity <= parseFloat(key.slice(2));\n\n    if (\n      isEqual ||\n      isSuperior ||\n      isSuperiorOrEqual ||\n      isInferior ||\n      isInferiorOrEqual\n    ) {\n      return enumerationContent[key as Key];\n    }\n  }\n\n  // Default or error handling if no keys match\n  return enumerationContent['1'];\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,MAAM,wBAAwB,CACnC,oBACA,aACY;AACZ,QAAM,cAAc,OAAO,KAAK,kBAAkB;AAElD,aAAW,OAAO,aAAa;AAC7B,UAAM,UACH,CAAC,IAAI,WAAW,GAAG,KAClB,CAAC,IAAI,WAAW,GAAG,KACnB,CAAC,IAAI,WAAW,GAAG,KACnB,WAAW,GAAG,MAAM,YACrB,IAAI,WAAW,GAAG,KAAK,WAAW,IAAI,MAAM,CAAC,CAAC,MAAM;AACvD,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAC7D,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAE7D,QACE,WACA,cACA,qBACA,cACA,mBACA;AACA,aAAO,mBAAmB,GAAU;AAAA,IACtC;AAAA,EACF;AAGA,SAAO,mBAAmB,GAAG;AAC/B;","names":[]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/getEnumerationContent.ts"],"sourcesContent":["import type { QuantityContent } from './enumeration';\n\ntype Key = keyof QuantityContent<string>;\n\n/**\n * Allow to pick a content based on a quantity.\n *\n * Usage:\n *\n * const content = getEnumerationContent({\n *  '<=-2.3': 'You have less than -2.3',\n *  '<1': 'You have less than one',\n *  '2': 'You have two',\n *  '>=3': 'You have three or more',\n * },\n * 2);\n * // 'You have two'\n *\n * The order of the keys will define the priority of the content.\n *\n * const content = getEnumerationContent({\n * '<4': 'You have less than four',\n * '2': 'You have two',\n * });\n * // 'You have less than four'\n *\n */\nexport const getEnumerationContent = <Content>(\n  enumerationContent: QuantityContent<Content>,\n  quantity: number\n): Content => {\n  const numericKeys = Object.keys(enumerationContent);\n\n  for (const key of numericKeys) {\n    const isEqual =\n      (!key.startsWith('>') &&\n        !key.startsWith('<') &&\n        !key.startsWith('=') &&\n        parseFloat(key) === quantity) ||\n      (key.startsWith('=') && parseFloat(key.slice(1)) === quantity);\n    const isSuperior =\n      key.startsWith('>') && quantity > parseFloat(key.slice(1));\n    const isSuperiorOrEqual =\n      key.startsWith('>=') && quantity >= parseFloat(key.slice(2));\n    const isInferior =\n      key.startsWith('<') && quantity < parseFloat(key.slice(1));\n    const isInferiorOrEqual =\n      key.startsWith('<=') && quantity <= parseFloat(key.slice(2));\n\n    if (\n      isEqual ||\n      isSuperior ||\n      isSuperiorOrEqual ||\n      isInferior ||\n      isInferiorOrEqual\n    ) {\n      return enumerationContent[key as Key];\n    }\n  }\n\n  // Default or error handling if no keys match\n  return enumerationContent['1'];\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA2BO,MAAM,wBAAwB,CACnC,oBACA,aACY;AACZ,QAAM,cAAc,OAAO,KAAK,kBAAkB;AAElD,aAAW,OAAO,aAAa;AAC7B,UAAM,UACH,CAAC,IAAI,WAAW,GAAG,KAClB,CAAC,IAAI,WAAW,GAAG,KACnB,CAAC,IAAI,WAAW,GAAG,KACnB,WAAW,GAAG,MAAM,YACrB,IAAI,WAAW,GAAG,KAAK,WAAW,IAAI,MAAM,CAAC,CAAC,MAAM;AACvD,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAC7D,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAE7D,QACE,WACA,cACA,qBACA,cACA,mBACA;AACA,aAAO,mBAAmB,GAAU;AAAA,IACtC;AAAA,EACF;AAGA,SAAO,mBAAmB,GAAG;AAC/B;","names":[]}

package/dist/cjs/transpiler/content_transformers/enumeration/getEnumerationContent.d.ts

@@ -2,6 +2,29 @@ import { QuantityContent } from './enumeration.js';
 import '../../../utils/getStackTraceInfo.js';
 import '../../../types/nodeType.js';
 
+/**
+ * Allow to pick a content based on a quantity.
+ *
+ * Usage:
+ *
+ * const content = getEnumerationContent({
+ *  '<=-2.3': 'You have less than -2.3',
+ *  '<1': 'You have less than one',
+ *  '2': 'You have two',
+ *  '>=3': 'You have three or more',
+ * },
+ * 2);
+ * // 'You have two'
+ *
+ * The order of the keys will define the priority of the content.
+ *
+ * const content = getEnumerationContent({
+ * '<4': 'You have less than four',
+ * '2': 'You have two',
+ * });
+ * // 'You have less than four'
+ *
+ */
 declare const getEnumerationContent: <Content>(enumerationContent: QuantityContent<Content>, quantity: number) => Content;
 
 export { getEnumerationContent };

package/dist/cjs/transpiler/content_transformers/translation/getTranslationContent.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/getTranslationContent.ts"],"sourcesContent":["import {\n  type Locales,\n  intlayerIntlConfiguration,\n} from '@intlayer/config/client';\nimport type { CustomizableLanguageContent } from './types';\n\nconst defaultLocale = intlayerIntlConfiguration.defaultLocale;\n\ntype GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => Content;\n\nexport const getTranslationContent: GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => languageContent[locale ?? defaultLocale] ?? languageContent[defaultLocale];\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAGO;AAGP,MAAM,gBAAgB,wCAA0B;AAOzC,MAAM,wBAA+C,CAC1D,iBACA,WACG,gBAAgB,UAAU,aAAa,KAAK,gBAAgB,aAAa;","names":[]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/getTranslationContent.ts"],"sourcesContent":["import {\n  type Locales,\n  intlayerIntlConfiguration,\n} from '@intlayer/config/client';\nimport type { CustomizableLanguageContent } from './types';\n\nconst defaultLocale = intlayerIntlConfiguration.defaultLocale;\n\ntype GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => Content;\n\n/**\n *\n * Allow to pick a content based on a locale.\n * If not locale found, it will return the content related to the default locale.\n *\n * Usage:\n *\n * const content = getTranslationContent({\n * en: 'Hello',\n * fr: 'Bonjour',\n * },\n * 'fr');\n * // 'Bonjour'\n *\n * Using TypeScript:\n * - this function will require each locale to be defined if defined in the project configuration.\n * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.\n */\nexport const getTranslationContent: GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => languageContent[locale ?? defaultLocale] ?? languageContent[defaultLocale];\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAGO;AAGP,MAAM,gBAAgB,wCAA0B;AAyBzC,MAAM,wBAA+C,CAC1D,iBACA,WACG,gBAAgB,UAAU,aAAa,KAAK,gBAAgB,aAAa;","names":[]}

package/dist/cjs/transpiler/content_transformers/translation/getTranslationContent.d.ts

@@ -5,6 +5,24 @@ import '../../../utils/getStackTraceInfo.js';
 import '../../../types/nodeType.js';
 
 type GetTranslationContent = <Content = string>(languageContent: CustomizableLanguageContent<Content>, locale: Locales) => Content;
+/**
+ *
+ * Allow to pick a content based on a locale.
+ * If not locale found, it will return the content related to the default locale.
+ *
+ * Usage:
+ *
+ * const content = getTranslationContent({
+ * en: 'Hello',
+ * fr: 'Bonjour',
+ * },
+ * 'fr');
+ * // 'Bonjour'
+ *
+ * Using TypeScript:
+ * - this function will require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
+ */
 declare const getTranslationContent: GetTranslationContent;
 
 export { getTranslationContent };

package/dist/cjs/transpiler/content_transformers/translation/translation.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/translation.ts"],"sourcesContent":["import { intlayerConfiguration } from '@intlayer/config/client';\nimport { NodeType } from '../../../types/index';\nimport { getStackTraceInfo } from '../../../utils/getStackTraceInfo';\nimport type { CustomizableLanguageContent, TranslationContent } from './types';\n\nconst { defaultLocale } = intlayerConfiguration.internationalization;\n\n/**\n * Transpile multilingual dictionary content\n *\n * Usage\n *\n *  translation<string>({\n *    \"en\": \"test\",\n *    \"fr\": \"test\",\n *    // ... any other available locale\n *  })\n *\n * translation<number, Locales.ENGLISH>({\n *  \"en\": 1\n * })\n *\n * translation<string, Locales.ENGLISH | Locales.FRENCH>({\n *  \"fr\": \"test\",\n *  \"en\": \"test\"\n * })\n *\n */\nconst translation = <Content = string>(\n  content?: CustomizableLanguageContent<Content>\n) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: TranslationContent<Content> = {\n      nodeType: NodeType.Translation,\n      ...stackTraceInfo,\n      [defaultLocale]: content,\n    } as TranslationContent<Content>;\n\n    return result;\n  }\n\n  const result: TranslationContent<Content> = {\n    nodeType: NodeType.Translation,\n    ...stackTraceInfo,\n    ...(content as unknown as object),\n  } as TranslationContent<Content>;\n\n  return result;\n};\n\nexport { translation as t };\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAsC;AACtC,mBAAyB;AACzB,+BAAkC;AAGlC,MAAM,EAAE,cAAc,IAAI,oCAAsB;AAuBhD,MAAM,cAAc,CAClB,YACG;AACH,QAAM,qBAAiB,4CAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,sBAAS;AAAA,MACnB,GAAG;AAAA,MACH,CAAC,aAAa,GAAG;AAAA,IACnB;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,sBAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAI;AAAA,EACN;AAEA,SAAO;AACT;","names":["result"]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/translation.ts"],"sourcesContent":["import { intlayerConfiguration } from '@intlayer/config/client';\nimport { NodeType } from '../../../types/index';\nimport { getStackTraceInfo } from '../../../utils/getStackTraceInfo';\nimport type { CustomizableLanguageContent, TranslationContent } from './types';\n\nconst { defaultLocale } = intlayerConfiguration.internationalization;\n\n/**\n *\n * Function intended to be used to build intlayer dictionaries.\n *\n * Get the content of a translation based on the locale.\n *\n * Usage:\n *\n * translation<string>({\n *   \"en\": \"Hello\",\n *   \"fr\": \"Bonjour\",\n *   // ... any other available locale\n * })\n *\n * Using TypeScript:\n * - this function require each locale to be defined if defined in the project configuration.\n * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.\n */\nconst translation = <Content = string>(\n  content?: CustomizableLanguageContent<Content>\n) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: TranslationContent<Content> = {\n      nodeType: NodeType.Translation,\n      ...stackTraceInfo,\n      [defaultLocale]: content,\n    } as TranslationContent<Content>;\n\n    return result;\n  }\n\n  const result: TranslationContent<Content> = {\n    nodeType: NodeType.Translation,\n    ...stackTraceInfo,\n    ...(content as unknown as object),\n  } as TranslationContent<Content>;\n\n  return result;\n};\n\nexport { translation as t };\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAsC;AACtC,mBAAyB;AACzB,+BAAkC;AAGlC,MAAM,EAAE,cAAc,IAAI,oCAAsB;AAoBhD,MAAM,cAAc,CAClB,YACG;AACH,QAAM,qBAAiB,4CAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,sBAAS;AAAA,MACnB,GAAG;AAAA,MACH,CAAC,aAAa,GAAG;AAAA,IACnB;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,sBAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAI;AAAA,EACN;AAEA,SAAO;AACT;","names":["result"]}

package/dist/cjs/transpiler/content_transformers/translation/translation.d.ts

@@ -5,25 +5,22 @@ import '../../../utils/getStackTraceInfo.js';
 import '../../../types/nodeType.js';
 
 /**
- * Transpile multilingual dictionary content
  *
- * Usage
+ * Function intended to be used to build intlayer dictionaries.
  *
- *  translation<string>({
- *    "en": "test",
- *    "fr": "test",
- *    // ... any other available locale
- *  })
+ * Get the content of a translation based on the locale.
  *
- * translation<number, Locales.ENGLISH>({
- *  "en": 1
- * })
+ * Usage:
  *
- * translation<string, Locales.ENGLISH | Locales.FRENCH>({
- *  "fr": "test",
- *  "en": "test"
+ * translation<string>({
+ *   "en": "Hello",
+ *   "fr": "Bonjour",
+ *   // ... any other available locale
  * })
  *
+ * Using TypeScript:
+ * - this function require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
  */
 declare const translation: <Content = string>(content?: CustomizableLanguageContent<Content>) => TranslationContent<Content>;
 

package/dist/cjs/utils/getStackTraceInfo.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/utils/getStackTraceInfo.ts"],"sourcesContent":["export type NoteStackTraceInfo = {\n  file?: string;\n  line?: string;\n  column?: string;\n};\n\n/**\n * Get the file path, line number, and column number of the caller of this function\n * @returns {Object} An object containing file, line, and column numbers\n */\nexport const getStackTraceInfo = (): NoteStackTraceInfo => {\n  // Create a new Error object to capture the stack trace\n  const err = new Error();\n  const stack = err.stack ?? '';\n\n  // Split the stack trace into lines and find the line where this function was called\n  // Adjust the line index as necessary based on how your environment's stack trace format\n  const stackLines = stack.split('\\n');\n  const callerLine = stackLines[2] ?? ''; // Adjust the index 2 if needed\n\n  // Extract file path, line number, and column number using a regular expression\n  // This regex pattern might need adjustments based on your environment\n  const match = callerLine.match(/at\\s[^(:]+\\([^:]+:(\\d+):(\\d+)\\)?/);\n\n  // const file = match?.[1];\n  const line = match?.[1];\n  const column = match?.[2];\n\n  if (match) {\n    return {\n      // file,\n      line,\n      column,\n    };\n  }\n\n  // Return empty object if parsing fails\n  return {};\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUO,MAAM,oBAAoB,MAA0B;AAEzD,QAAM,MAAM,IAAI,MAAM;AACtB,QAAM,QAAQ,IAAI,SAAS;AAI3B,QAAM,aAAa,MAAM,MAAM,IAAI;AACnC,QAAM,aAAa,WAAW,CAAC,KAAK;AAIpC,QAAM,QAAQ,WAAW,MAAM,kCAAkC;AAGjE,QAAM,OAAO,QAAQ,CAAC;AACtB,QAAM,SAAS,QAAQ,CAAC;AAExB,MAAI,OAAO;AACT,WAAO;AAAA;AAAA,MAEL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAGA,SAAO,CAAC;AACV;","names":[]}
+{"version":3,"sources":["../../../src/utils/getStackTraceInfo.ts"],"sourcesContent":["export type NoteStackTraceInfo = {\n  file?: string;\n  line?: string;\n  column?: string;\n};\n\n/**\n * Get the file path, line number, and column number of the caller of this function\n * Return an object containing file, line, and column numbers\n */\nexport const getStackTraceInfo = (): NoteStackTraceInfo => {\n  // Create a new Error object to capture the stack trace\n  const err = new Error();\n  const stack = err.stack ?? '';\n\n  // Split the stack trace into lines and find the line where this function was called\n  // Adjust the line index as necessary based on how your environment's stack trace format\n  const stackLines = stack.split('\\n');\n  const callerLine = stackLines[2] ?? ''; // Adjust the index 2 if needed\n\n  // Extract file path, line number, and column number using a regular expression\n  // This regex pattern might need adjustments based on your environment\n  const match = callerLine.match(/at\\s[^(:]+\\([^:]+:(\\d+):(\\d+)\\)?/);\n\n  // const file = match?.[1];\n  const line = match?.[1];\n  const column = match?.[2];\n\n  if (match) {\n    return {\n      // file,\n      line,\n      column,\n    };\n  }\n\n  // Return empty object if parsing fails\n  return {};\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUO,MAAM,oBAAoB,MAA0B;AAEzD,QAAM,MAAM,IAAI,MAAM;AACtB,QAAM,QAAQ,IAAI,SAAS;AAI3B,QAAM,aAAa,MAAM,MAAM,IAAI;AACnC,QAAM,aAAa,WAAW,CAAC,KAAK;AAIpC,QAAM,QAAQ,WAAW,MAAM,kCAAkC;AAGjE,QAAM,OAAO,QAAQ,CAAC;AACtB,QAAM,SAAS,QAAQ,CAAC;AAExB,MAAI,OAAO;AACT,WAAO;AAAA;AAAA,MAEL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAGA,SAAO,CAAC;AACV;","names":[]}

package/dist/cjs/utils/getStackTraceInfo.d.ts

@@ -5,7 +5,7 @@ type NoteStackTraceInfo = {
 };
 /**
  * Get the file path, line number, and column number of the caller of this function
- * @returns {Object} An object containing file, line, and column numbers
+ * Return an object containing file, line, and column numbers
  */
 declare const getStackTraceInfo: () => NoteStackTraceInfo;
 

package/dist/esm/transpiler/content_transformers/enumeration/enumeration.d.mts

@@ -16,7 +16,21 @@ type EnumerationContent<Content> = Partial<QuantityContent<Content>> & NoteStack
     nodeType: NodeType.Enumeration;
 };
 /**
- * Create a JSON string with the content and the stack trace information
+ * Function intended to be used to build intlayer dictionaries.
+ *
+ * Allow to pick a content based on a quantity.
+ *
+ * Usage:
+ *
+ * const content = enu({
+ *  '<=-2.3': 'You have less than -2.3',
+ *  '<1': 'You have less than one',
+ *  '2': 'You have two',
+ *  '>=3': 'You have three or more',
+ * });
+ *
+ * The order of the keys will define the priority of the content.
+ *
  */
 declare const enumeration: <Content>(content?: Partial<QuantityContent<Content>>) => EnumerationContent<Content>;
 

package/dist/esm/transpiler/content_transformers/enumeration/enumeration.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/enumeration.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { NodeType } from '../../../types/index';\nimport {\n  getStackTraceInfo,\n  type NoteStackTraceInfo,\n} from '../../../utils/getStackTraceInfo';\n\ntype Positif = number | `${number}`;\ntype Negatif = `-${number}`;\ntype Numbers = Positif | Negatif;\n\ntype Equal = Numbers;\ntype EqualString = `=${Numbers}`;\ntype Superior = `>${Numbers}`;\ntype SuperiorOrEqual = `>=${Numbers}`;\ntype Inferior = `<${Numbers}`;\ntype InferiorOrEqual = `<=${Numbers}`;\n\ntype EnterFormat =\n  | Equal\n  | EqualString\n  | Superior\n  | SuperiorOrEqual\n  | Inferior\n  | InferiorOrEqual;\n\nexport type QuantityContent<Content> = Record<EnterFormat, Content>;\n\nexport type EnumerationContent<Content> = Partial<QuantityContent<Content>> &\n  NoteStackTraceInfo & {\n    nodeType: NodeType.Enumeration;\n  };\n\n/**\n * Create a JSON string with the content and the stack trace information\n */\nconst enumeration = <Content>(content?: Partial<QuantityContent<Content>>) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: EnumerationContent<Content> = {\n      nodeType: NodeType.Enumeration,\n      ...stackTraceInfo,\n      1: content,\n    };\n\n    return result;\n  }\n\n  const result: EnumerationContent<Content> = {\n    nodeType: NodeType.Enumeration,\n    ...stackTraceInfo,\n    ...content,\n  };\n\n  return result;\n};\n\nexport { enumeration as enu };\n"],"mappings":"AACA,SAAS,gBAAgB;AACzB;AAAA,EACE;AAAA,OAEK;AA+BP,MAAM,cAAc,CAAU,YAAgD;AAC5E,QAAM,iBAAiB,kBAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,SAAS;AAAA,MACnB,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,SAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAG;AAAA,EACL;AAEA,SAAO;AACT;","names":["result"]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/enumeration.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { NodeType } from '../../../types/index';\nimport {\n  getStackTraceInfo,\n  type NoteStackTraceInfo,\n} from '../../../utils/getStackTraceInfo';\n\ntype Positif = number | `${number}`;\ntype Negatif = `-${number}`;\ntype Numbers = Positif | Negatif;\n\ntype Equal = Numbers;\ntype EqualString = `=${Numbers}`;\ntype Superior = `>${Numbers}`;\ntype SuperiorOrEqual = `>=${Numbers}`;\ntype Inferior = `<${Numbers}`;\ntype InferiorOrEqual = `<=${Numbers}`;\n\ntype EnterFormat =\n  | Equal\n  | EqualString\n  | Superior\n  | SuperiorOrEqual\n  | Inferior\n  | InferiorOrEqual;\n\nexport type QuantityContent<Content> = Record<EnterFormat, Content>;\n\nexport type EnumerationContent<Content> = Partial<QuantityContent<Content>> &\n  NoteStackTraceInfo & {\n    nodeType: NodeType.Enumeration;\n  };\n\n/**\n * Function intended to be used to build intlayer dictionaries.\n *\n * Allow to pick a content based on a quantity.\n *\n * Usage:\n *\n * const content = enu({\n *  '<=-2.3': 'You have less than -2.3',\n *  '<1': 'You have less than one',\n *  '2': 'You have two',\n *  '>=3': 'You have three or more',\n * });\n *\n * The order of the keys will define the priority of the content.\n *\n */\nconst enumeration = <Content>(content?: Partial<QuantityContent<Content>>) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: EnumerationContent<Content> = {\n      nodeType: NodeType.Enumeration,\n      ...stackTraceInfo,\n      1: content,\n    };\n\n    return result;\n  }\n\n  const result: EnumerationContent<Content> = {\n    nodeType: NodeType.Enumeration,\n    ...stackTraceInfo,\n    ...content,\n  };\n\n  return result;\n};\n\nexport { enumeration as enu };\n"],"mappings":"AACA,SAAS,gBAAgB;AACzB;AAAA,EACE;AAAA,OAEK;AA6CP,MAAM,cAAc,CAAU,YAAgD;AAC5E,QAAM,iBAAiB,kBAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,SAAS;AAAA,MACnB,GAAG;AAAA,MACH,GAAG;AAAA,IACL;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,SAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAG;AAAA,EACL;AAEA,SAAO;AACT;","names":["result"]}

package/dist/esm/transpiler/content_transformers/enumeration/getEnumerationContent.d.mts

@@ -2,6 +2,29 @@ import { QuantityContent } from './enumeration.mjs';
 import '../../../utils/getStackTraceInfo.mjs';
 import '../../../types/nodeType.mjs';
 
+/**
+ * Allow to pick a content based on a quantity.
+ *
+ * Usage:
+ *
+ * const content = getEnumerationContent({
+ *  '<=-2.3': 'You have less than -2.3',
+ *  '<1': 'You have less than one',
+ *  '2': 'You have two',
+ *  '>=3': 'You have three or more',
+ * },
+ * 2);
+ * // 'You have two'
+ *
+ * The order of the keys will define the priority of the content.
+ *
+ * const content = getEnumerationContent({
+ * '<4': 'You have less than four',
+ * '2': 'You have two',
+ * });
+ * // 'You have less than four'
+ *
+ */
 declare const getEnumerationContent: <Content>(enumerationContent: QuantityContent<Content>, quantity: number) => Content;
 
 export { getEnumerationContent };

package/dist/esm/transpiler/content_transformers/enumeration/getEnumerationContent.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/getEnumerationContent.ts"],"sourcesContent":["import type { QuantityContent } from './enumeration';\n\ntype Key = keyof QuantityContent<string>;\n\nexport const getEnumerationContent = <Content>(\n  enumerationContent: QuantityContent<Content>,\n  quantity: number\n): Content => {\n  const numericKeys = Object.keys(enumerationContent);\n\n  for (const key of numericKeys) {\n    const isEqual =\n      (!key.startsWith('>') &&\n        !key.startsWith('<') &&\n        !key.startsWith('=') &&\n        parseFloat(key) === quantity) ||\n      (key.startsWith('=') && parseFloat(key.slice(1)) === quantity);\n    const isSuperior =\n      key.startsWith('>') && quantity > parseFloat(key.slice(1));\n    const isSuperiorOrEqual =\n      key.startsWith('>=') && quantity >= parseFloat(key.slice(2));\n    const isInferior =\n      key.startsWith('<') && quantity < parseFloat(key.slice(1));\n    const isInferiorOrEqual =\n      key.startsWith('<=') && quantity <= parseFloat(key.slice(2));\n\n    if (\n      isEqual ||\n      isSuperior ||\n      isSuperiorOrEqual ||\n      isInferior ||\n      isInferiorOrEqual\n    ) {\n      return enumerationContent[key as Key];\n    }\n  }\n\n  // Default or error handling if no keys match\n  return enumerationContent['1'];\n};\n"],"mappings":"AAIO,MAAM,wBAAwB,CACnC,oBACA,aACY;AACZ,QAAM,cAAc,OAAO,KAAK,kBAAkB;AAElD,aAAW,OAAO,aAAa;AAC7B,UAAM,UACH,CAAC,IAAI,WAAW,GAAG,KAClB,CAAC,IAAI,WAAW,GAAG,KACnB,CAAC,IAAI,WAAW,GAAG,KACnB,WAAW,GAAG,MAAM,YACrB,IAAI,WAAW,GAAG,KAAK,WAAW,IAAI,MAAM,CAAC,CAAC,MAAM;AACvD,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAC7D,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAE7D,QACE,WACA,cACA,qBACA,cACA,mBACA;AACA,aAAO,mBAAmB,GAAU;AAAA,IACtC;AAAA,EACF;AAGA,SAAO,mBAAmB,GAAG;AAC/B;","names":[]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/enumeration/getEnumerationContent.ts"],"sourcesContent":["import type { QuantityContent } from './enumeration';\n\ntype Key = keyof QuantityContent<string>;\n\n/**\n * Allow to pick a content based on a quantity.\n *\n * Usage:\n *\n * const content = getEnumerationContent({\n *  '<=-2.3': 'You have less than -2.3',\n *  '<1': 'You have less than one',\n *  '2': 'You have two',\n *  '>=3': 'You have three or more',\n * },\n * 2);\n * // 'You have two'\n *\n * The order of the keys will define the priority of the content.\n *\n * const content = getEnumerationContent({\n * '<4': 'You have less than four',\n * '2': 'You have two',\n * });\n * // 'You have less than four'\n *\n */\nexport const getEnumerationContent = <Content>(\n  enumerationContent: QuantityContent<Content>,\n  quantity: number\n): Content => {\n  const numericKeys = Object.keys(enumerationContent);\n\n  for (const key of numericKeys) {\n    const isEqual =\n      (!key.startsWith('>') &&\n        !key.startsWith('<') &&\n        !key.startsWith('=') &&\n        parseFloat(key) === quantity) ||\n      (key.startsWith('=') && parseFloat(key.slice(1)) === quantity);\n    const isSuperior =\n      key.startsWith('>') && quantity > parseFloat(key.slice(1));\n    const isSuperiorOrEqual =\n      key.startsWith('>=') && quantity >= parseFloat(key.slice(2));\n    const isInferior =\n      key.startsWith('<') && quantity < parseFloat(key.slice(1));\n    const isInferiorOrEqual =\n      key.startsWith('<=') && quantity <= parseFloat(key.slice(2));\n\n    if (\n      isEqual ||\n      isSuperior ||\n      isSuperiorOrEqual ||\n      isInferior ||\n      isInferiorOrEqual\n    ) {\n      return enumerationContent[key as Key];\n    }\n  }\n\n  // Default or error handling if no keys match\n  return enumerationContent['1'];\n};\n"],"mappings":"AA2BO,MAAM,wBAAwB,CACnC,oBACA,aACY;AACZ,QAAM,cAAc,OAAO,KAAK,kBAAkB;AAElD,aAAW,OAAO,aAAa;AAC7B,UAAM,UACH,CAAC,IAAI,WAAW,GAAG,KAClB,CAAC,IAAI,WAAW,GAAG,KACnB,CAAC,IAAI,WAAW,GAAG,KACnB,WAAW,GAAG,MAAM,YACrB,IAAI,WAAW,GAAG,KAAK,WAAW,IAAI,MAAM,CAAC,CAAC,MAAM;AACvD,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAC7D,UAAM,aACJ,IAAI,WAAW,GAAG,KAAK,WAAW,WAAW,IAAI,MAAM,CAAC,CAAC;AAC3D,UAAM,oBACJ,IAAI,WAAW,IAAI,KAAK,YAAY,WAAW,IAAI,MAAM,CAAC,CAAC;AAE7D,QACE,WACA,cACA,qBACA,cACA,mBACA;AACA,aAAO,mBAAmB,GAAU;AAAA,IACtC;AAAA,EACF;AAGA,SAAO,mBAAmB,GAAG;AAC/B;","names":[]}

package/dist/esm/transpiler/content_transformers/translation/getTranslationContent.d.mts

@@ -5,6 +5,24 @@ import '../../../utils/getStackTraceInfo.mjs';
 import '../../../types/nodeType.mjs';
 
 type GetTranslationContent = <Content = string>(languageContent: CustomizableLanguageContent<Content>, locale: Locales) => Content;
+/**
+ *
+ * Allow to pick a content based on a locale.
+ * If not locale found, it will return the content related to the default locale.
+ *
+ * Usage:
+ *
+ * const content = getTranslationContent({
+ * en: 'Hello',
+ * fr: 'Bonjour',
+ * },
+ * 'fr');
+ * // 'Bonjour'
+ *
+ * Using TypeScript:
+ * - this function will require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
+ */
 declare const getTranslationContent: GetTranslationContent;
 
 export { getTranslationContent };

package/dist/esm/transpiler/content_transformers/translation/getTranslationContent.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/getTranslationContent.ts"],"sourcesContent":["import {\n  type Locales,\n  intlayerIntlConfiguration,\n} from '@intlayer/config/client';\nimport type { CustomizableLanguageContent } from './types';\n\nconst defaultLocale = intlayerIntlConfiguration.defaultLocale;\n\ntype GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => Content;\n\nexport const getTranslationContent: GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => languageContent[locale ?? defaultLocale] ?? languageContent[defaultLocale];\n"],"mappings":"AAAA;AAAA,EAEE;AAAA,OACK;AAGP,MAAM,gBAAgB,0BAA0B;AAOzC,MAAM,wBAA+C,CAC1D,iBACA,WACG,gBAAgB,UAAU,aAAa,KAAK,gBAAgB,aAAa;","names":[]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/getTranslationContent.ts"],"sourcesContent":["import {\n  type Locales,\n  intlayerIntlConfiguration,\n} from '@intlayer/config/client';\nimport type { CustomizableLanguageContent } from './types';\n\nconst defaultLocale = intlayerIntlConfiguration.defaultLocale;\n\ntype GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => Content;\n\n/**\n *\n * Allow to pick a content based on a locale.\n * If not locale found, it will return the content related to the default locale.\n *\n * Usage:\n *\n * const content = getTranslationContent({\n * en: 'Hello',\n * fr: 'Bonjour',\n * },\n * 'fr');\n * // 'Bonjour'\n *\n * Using TypeScript:\n * - this function will require each locale to be defined if defined in the project configuration.\n * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.\n */\nexport const getTranslationContent: GetTranslationContent = <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => languageContent[locale ?? defaultLocale] ?? languageContent[defaultLocale];\n"],"mappings":"AAAA;AAAA,EAEE;AAAA,OACK;AAGP,MAAM,gBAAgB,0BAA0B;AAyBzC,MAAM,wBAA+C,CAC1D,iBACA,WACG,gBAAgB,UAAU,aAAa,KAAK,gBAAgB,aAAa;","names":[]}

package/dist/esm/transpiler/content_transformers/translation/translation.d.mts

@@ -5,25 +5,22 @@ import '../../../utils/getStackTraceInfo.mjs';
 import '../../../types/nodeType.mjs';
 
 /**
- * Transpile multilingual dictionary content
  *
- * Usage
+ * Function intended to be used to build intlayer dictionaries.
  *
- *  translation<string>({
- *    "en": "test",
- *    "fr": "test",
- *    // ... any other available locale
- *  })
+ * Get the content of a translation based on the locale.
  *
- * translation<number, Locales.ENGLISH>({
- *  "en": 1
- * })
+ * Usage:
  *
- * translation<string, Locales.ENGLISH | Locales.FRENCH>({
- *  "fr": "test",
- *  "en": "test"
+ * translation<string>({
+ *   "en": "Hello",
+ *   "fr": "Bonjour",
+ *   // ... any other available locale
  * })
  *
+ * Using TypeScript:
+ * - this function require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
  */
 declare const translation: <Content = string>(content?: CustomizableLanguageContent<Content>) => TranslationContent<Content>;
 

package/dist/esm/transpiler/content_transformers/translation/translation.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/translation.ts"],"sourcesContent":["import { intlayerConfiguration } from '@intlayer/config/client';\nimport { NodeType } from '../../../types/index';\nimport { getStackTraceInfo } from '../../../utils/getStackTraceInfo';\nimport type { CustomizableLanguageContent, TranslationContent } from './types';\n\nconst { defaultLocale } = intlayerConfiguration.internationalization;\n\n/**\n * Transpile multilingual dictionary content\n *\n * Usage\n *\n *  translation<string>({\n *    \"en\": \"test\",\n *    \"fr\": \"test\",\n *    // ... any other available locale\n *  })\n *\n * translation<number, Locales.ENGLISH>({\n *  \"en\": 1\n * })\n *\n * translation<string, Locales.ENGLISH | Locales.FRENCH>({\n *  \"fr\": \"test\",\n *  \"en\": \"test\"\n * })\n *\n */\nconst translation = <Content = string>(\n  content?: CustomizableLanguageContent<Content>\n) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: TranslationContent<Content> = {\n      nodeType: NodeType.Translation,\n      ...stackTraceInfo,\n      [defaultLocale]: content,\n    } as TranslationContent<Content>;\n\n    return result;\n  }\n\n  const result: TranslationContent<Content> = {\n    nodeType: NodeType.Translation,\n    ...stackTraceInfo,\n    ...(content as unknown as object),\n  } as TranslationContent<Content>;\n\n  return result;\n};\n\nexport { translation as t };\n"],"mappings":"AAAA,SAAS,6BAA6B;AACtC,SAAS,gBAAgB;AACzB,SAAS,yBAAyB;AAGlC,MAAM,EAAE,cAAc,IAAI,sBAAsB;AAuBhD,MAAM,cAAc,CAClB,YACG;AACH,QAAM,iBAAiB,kBAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,SAAS;AAAA,MACnB,GAAG;AAAA,MACH,CAAC,aAAa,GAAG;AAAA,IACnB;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,SAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAI;AAAA,EACN;AAEA,SAAO;AACT;","names":["result"]}
+{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/translation.ts"],"sourcesContent":["import { intlayerConfiguration } from '@intlayer/config/client';\nimport { NodeType } from '../../../types/index';\nimport { getStackTraceInfo } from '../../../utils/getStackTraceInfo';\nimport type { CustomizableLanguageContent, TranslationContent } from './types';\n\nconst { defaultLocale } = intlayerConfiguration.internationalization;\n\n/**\n *\n * Function intended to be used to build intlayer dictionaries.\n *\n * Get the content of a translation based on the locale.\n *\n * Usage:\n *\n * translation<string>({\n *   \"en\": \"Hello\",\n *   \"fr\": \"Bonjour\",\n *   // ... any other available locale\n * })\n *\n * Using TypeScript:\n * - this function require each locale to be defined if defined in the project configuration.\n * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.\n */\nconst translation = <Content = string>(\n  content?: CustomizableLanguageContent<Content>\n) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: TranslationContent<Content> = {\n      nodeType: NodeType.Translation,\n      ...stackTraceInfo,\n      [defaultLocale]: content,\n    } as TranslationContent<Content>;\n\n    return result;\n  }\n\n  const result: TranslationContent<Content> = {\n    nodeType: NodeType.Translation,\n    ...stackTraceInfo,\n    ...(content as unknown as object),\n  } as TranslationContent<Content>;\n\n  return result;\n};\n\nexport { translation as t };\n"],"mappings":"AAAA,SAAS,6BAA6B;AACtC,SAAS,gBAAgB;AACzB,SAAS,yBAAyB;AAGlC,MAAM,EAAE,cAAc,IAAI,sBAAsB;AAoBhD,MAAM,cAAc,CAClB,YACG;AACH,QAAM,iBAAiB,kBAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,SAAS;AAAA,MACnB,GAAG;AAAA,MACH,CAAC,aAAa,GAAG;AAAA,IACnB;AAEA,WAAOA;AAAA,EACT;AAEA,QAAM,SAAsC;AAAA,IAC1C,UAAU,SAAS;AAAA,IACnB,GAAG;AAAA,IACH,GAAI;AAAA,EACN;AAEA,SAAO;AACT;","names":["result"]}

package/dist/esm/utils/getStackTraceInfo.d.mts

@@ -5,7 +5,7 @@ type NoteStackTraceInfo = {
 };
 /**
  * Get the file path, line number, and column number of the caller of this function
- * @returns {Object} An object containing file, line, and column numbers
+ * Return an object containing file, line, and column numbers
  */
 declare const getStackTraceInfo: () => NoteStackTraceInfo;
 

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/utils/getStackTraceInfo.ts"],"sourcesContent":["export type NoteStackTraceInfo = {\n  file?: string;\n  line?: string;\n  column?: string;\n};\n\n/**\n * Get the file path, line number, and column number of the caller of this function\n * @returns {Object} An object containing file, line, and column numbers\n */\nexport const getStackTraceInfo = (): NoteStackTraceInfo => {\n  // Create a new Error object to capture the stack trace\n  const err = new Error();\n  const stack = err.stack ?? '';\n\n  // Split the stack trace into lines and find the line where this function was called\n  // Adjust the line index as necessary based on how your environment's stack trace format\n  const stackLines = stack.split('\\n');\n  const callerLine = stackLines[2] ?? ''; // Adjust the index 2 if needed\n\n  // Extract file path, line number, and column number using a regular expression\n  // This regex pattern might need adjustments based on your environment\n  const match = callerLine.match(/at\\s[^(:]+\\([^:]+:(\\d+):(\\d+)\\)?/);\n\n  // const file = match?.[1];\n  const line = match?.[1];\n  const column = match?.[2];\n\n  if (match) {\n    return {\n      // file,\n      line,\n      column,\n    };\n  }\n\n  // Return empty object if parsing fails\n  return {};\n};\n"],"mappings":"AAUO,MAAM,oBAAoB,MAA0B;AAEzD,QAAM,MAAM,IAAI,MAAM;AACtB,QAAM,QAAQ,IAAI,SAAS;AAI3B,QAAM,aAAa,MAAM,MAAM,IAAI;AACnC,QAAM,aAAa,WAAW,CAAC,KAAK;AAIpC,QAAM,QAAQ,WAAW,MAAM,kCAAkC;AAGjE,QAAM,OAAO,QAAQ,CAAC;AACtB,QAAM,SAAS,QAAQ,CAAC;AAExB,MAAI,OAAO;AACT,WAAO;AAAA;AAAA,MAEL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAGA,SAAO,CAAC;AACV;","names":[]}
+{"version":3,"sources":["../../../src/utils/getStackTraceInfo.ts"],"sourcesContent":["export type NoteStackTraceInfo = {\n  file?: string;\n  line?: string;\n  column?: string;\n};\n\n/**\n * Get the file path, line number, and column number of the caller of this function\n * Return an object containing file, line, and column numbers\n */\nexport const getStackTraceInfo = (): NoteStackTraceInfo => {\n  // Create a new Error object to capture the stack trace\n  const err = new Error();\n  const stack = err.stack ?? '';\n\n  // Split the stack trace into lines and find the line where this function was called\n  // Adjust the line index as necessary based on how your environment's stack trace format\n  const stackLines = stack.split('\\n');\n  const callerLine = stackLines[2] ?? ''; // Adjust the index 2 if needed\n\n  // Extract file path, line number, and column number using a regular expression\n  // This regex pattern might need adjustments based on your environment\n  const match = callerLine.match(/at\\s[^(:]+\\([^:]+:(\\d+):(\\d+)\\)?/);\n\n  // const file = match?.[1];\n  const line = match?.[1];\n  const column = match?.[2];\n\n  if (match) {\n    return {\n      // file,\n      line,\n      column,\n    };\n  }\n\n  // Return empty object if parsing fails\n  return {};\n};\n"],"mappings":"AAUO,MAAM,oBAAoB,MAA0B;AAEzD,QAAM,MAAM,IAAI,MAAM;AACtB,QAAM,QAAQ,IAAI,SAAS;AAI3B,QAAM,aAAa,MAAM,MAAM,IAAI;AACnC,QAAM,aAAa,WAAW,CAAC,KAAK;AAIpC,QAAM,QAAQ,WAAW,MAAM,kCAAkC;AAGjE,QAAM,OAAO,QAAQ,CAAC;AACtB,QAAM,SAAS,QAAQ,CAAC;AAExB,MAAI,OAAO;AACT,WAAO;AAAA;AAAA,MAEL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAGA,SAAO,CAAC;AACV;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/core",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "private": false,
   "description": "IntLayer - Layer of abstraction between the business logic and the data access layer. Manage internationalization in a simple way, through TypeScript, JavaScript or JSON declaration file.",
   "keywords": [
@@ -50,15 +50,16 @@
     "./package.json"
   ],
   "dependencies": {
-    "@intlayer/config": "^1.0.1"
+    "chokidar": "^3.6.0",
+    "@intlayer/config": "^1.2.0"
   },
   "devDependencies": {
-    "@types/node": "^20.11.30",
-    "@types/react": "^18.2.78",
+    "@types/node": "^20.12.7",
+    "@types/react": "^18.2.79",
     "react": "^18.2.0",
     "rimraf": "5.0.5",
     "tsup": "^8.0.2",
-    "typescript": "^5.4.3",
+    "typescript": "^5.4.5",
     "@utils/eslint-config": "^1.0.1",
     "@utils/ts-config": "^1.0.1"
   },

package/src/transpiler/content_transformers/enumeration/enumeration.ts

@@ -32,7 +32,21 @@ export type EnumerationContent<Content> = Partial<QuantityContent<Content>> &
   };
 
 /**
- * Create a JSON string with the content and the stack trace information
+ * Function intended to be used to build intlayer dictionaries.
+ *
+ * Allow to pick a content based on a quantity.
+ *
+ * Usage:
+ *
+ * const content = enu({
+ *  '<=-2.3': 'You have less than -2.3',
+ *  '<1': 'You have less than one',
+ *  '2': 'You have two',
+ *  '>=3': 'You have three or more',
+ * });
+ *
+ * The order of the keys will define the priority of the content.
+ *
  */
 const enumeration = <Content>(content?: Partial<QuantityContent<Content>>) => {
   const stackTraceInfo = getStackTraceInfo();

package/src/transpiler/content_transformers/enumeration/getEnumerationContent.ts

@@ -2,6 +2,29 @@ import type { QuantityContent } from './enumeration';
 
 type Key = keyof QuantityContent<string>;
 
+/**
+ * Allow to pick a content based on a quantity.
+ *
+ * Usage:
+ *
+ * const content = getEnumerationContent({
+ *  '<=-2.3': 'You have less than -2.3',
+ *  '<1': 'You have less than one',
+ *  '2': 'You have two',
+ *  '>=3': 'You have three or more',
+ * },
+ * 2);
+ * // 'You have two'
+ *
+ * The order of the keys will define the priority of the content.
+ *
+ * const content = getEnumerationContent({
+ * '<4': 'You have less than four',
+ * '2': 'You have two',
+ * });
+ * // 'You have less than four'
+ *
+ */
 export const getEnumerationContent = <Content>(
   enumerationContent: QuantityContent<Content>,
   quantity: number

package/src/transpiler/content_transformers/translation/getTranslationContent.ts

@@ -11,6 +11,24 @@ type GetTranslationContent = <Content = string>(
   locale: Locales
 ) => Content;
 
+/**
+ *
+ * Allow to pick a content based on a locale.
+ * If not locale found, it will return the content related to the default locale.
+ *
+ * Usage:
+ *
+ * const content = getTranslationContent({
+ * en: 'Hello',
+ * fr: 'Bonjour',
+ * },
+ * 'fr');
+ * // 'Bonjour'
+ *
+ * Using TypeScript:
+ * - this function will require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
+ */
 export const getTranslationContent: GetTranslationContent = <Content = string>(
   languageContent: CustomizableLanguageContent<Content>,
   locale: Locales

package/src/transpiler/content_transformers/translation/translation.ts

@@ -6,25 +6,22 @@ import type { CustomizableLanguageContent, TranslationContent } from './types';
 const { defaultLocale } = intlayerConfiguration.internationalization;
 
 /**
- * Transpile multilingual dictionary content
  *
- * Usage
+ * Function intended to be used to build intlayer dictionaries.
  *
- *  translation<string>({
- *    "en": "test",
- *    "fr": "test",
- *    // ... any other available locale
- *  })
+ * Get the content of a translation based on the locale.
  *
- * translation<number, Locales.ENGLISH>({
- *  "en": 1
- * })
+ * Usage:
  *
- * translation<string, Locales.ENGLISH | Locales.FRENCH>({
- *  "fr": "test",
- *  "en": "test"
+ * translation<string>({
+ *   "en": "Hello",
+ *   "fr": "Bonjour",
+ *   // ... any other available locale
  * })
  *
+ * Using TypeScript:
+ * - this function require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
  */
 const translation = <Content = string>(
   content?: CustomizableLanguageContent<Content>

package/src/utils/getStackTraceInfo.ts

@@ -6,7 +6,7 @@ export type NoteStackTraceInfo = {
 
 /**
  * Get the file path, line number, and column number of the caller of this function
- * @returns {Object} An object containing file, line, and column numbers
+ * Return an object containing file, line, and column numbers
  */
 export const getStackTraceInfo = (): NoteStackTraceInfo => {
   // Create a new Error object to capture the stack trace