@intlayer/core 1.2.0 → 2.0.0

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

@@ -0,0 +1,64 @@
+import type { EnterFormat, QuantityContent } from './enumeration';
+
+/**
+ * Find the matching condition for a quantity.
+ *
+ * Usage:
+ *
+ * ```ts
+ * const key = findMatchingCondition({
+ *  '<=-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);
+ * // '2'
+ * ```
+ *
+ * The order of the keys will define the priority of the content.
+ *
+ * ```ts
+ * const key = findMatchingCondition({
+ *  '<4': 'You have less than four',
+ *  '2': 'You have two',
+ * }, 2);
+ * // '<4'
+ * ```
+ *
+ * If no keys match, the default key is '1'.
+ */
+export const findMatchingCondition = <Content>(
+  enumerationContent: QuantityContent<Content>,
+  quantity: number
+): EnterFormat => {
+  const numericKeys = Object.keys(enumerationContent);
+
+  for (const key of numericKeys) {
+    const isEqual =
+      (!key.startsWith('>') &&
+        !key.startsWith('<') &&
+        !key.startsWith('=') &&
+        parseFloat(key) === quantity) ||
+      (key.startsWith('=') && parseFloat(key.slice(1)) === quantity);
+    const isSuperior =
+      key.startsWith('>') && quantity > parseFloat(key.slice(1));
+    const isSuperiorOrEqual =
+      key.startsWith('>=') && quantity >= parseFloat(key.slice(2));
+    const isInferior =
+      key.startsWith('<') && quantity < parseFloat(key.slice(1));
+    const isInferiorOrEqual =
+      key.startsWith('<=') && quantity <= parseFloat(key.slice(2));
+
+    if (
+      isEqual ||
+      isSuperior ||
+      isSuperiorOrEqual ||
+      isInferior ||
+      isInferiorOrEqual
+    ) {
+      return key as EnterFormat;
+    }
+  }
+
+  return '1';
+};

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

@@ -1,63 +1,38 @@
+import { findMatchingCondition } from '../..';
 import type { QuantityContent } from './enumeration';
 
-type Key = keyof QuantityContent<string>;
-
 /**
  * Allow to pick a content based on a quantity.
  *
  * Usage:
  *
+ * ```ts
  * 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);
+ * }, 2);
  * // 'You have two'
+ * ```
  *
  * The order of the keys will define the priority of the content.
  *
+ * ```ts
  * const content = getEnumerationContent({
- * '<4': 'You have less than four',
- * '2': 'You have two',
- * });
+ *  '<4': 'You have less than four',
+ *  '2': 'You have two',
+ * }, 2);
  * // 'You have less than four'
+ * ```
  *
  */
 export const getEnumerationContent = <Content>(
   enumerationContent: QuantityContent<Content>,
   quantity: number
 ): Content => {
-  const numericKeys = Object.keys(enumerationContent);
-
-  for (const key of numericKeys) {
-    const isEqual =
-      (!key.startsWith('>') &&
-        !key.startsWith('<') &&
-        !key.startsWith('=') &&
-        parseFloat(key) === quantity) ||
-      (key.startsWith('=') && parseFloat(key.slice(1)) === quantity);
-    const isSuperior =
-      key.startsWith('>') && quantity > parseFloat(key.slice(1));
-    const isSuperiorOrEqual =
-      key.startsWith('>=') && quantity >= parseFloat(key.slice(2));
-    const isInferior =
-      key.startsWith('<') && quantity < parseFloat(key.slice(1));
-    const isInferiorOrEqual =
-      key.startsWith('<=') && quantity <= parseFloat(key.slice(2));
-
-    if (
-      isEqual ||
-      isSuperior ||
-      isSuperiorOrEqual ||
-      isInferior ||
-      isInferiorOrEqual
-    ) {
-      return enumerationContent[key as Key];
-    }
-  }
+  const key = findMatchingCondition<Content>(enumerationContent, quantity);
 
   // Default or error handling if no keys match
-  return enumerationContent['1'];
+  return enumerationContent[key];
 };

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

@@ -1,2 +1,3 @@
 export * from './enumeration';
 export * from './getEnumerationContent';
+export * from './findMatchingCondition';

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

@@ -1,10 +1,7 @@
-import {
-  type Locales,
-  intlayerIntlConfiguration,
-} from '@intlayer/config/client';
+import { type Locales, getConfiguration } from '@intlayer/config/client';
 import type { CustomizableLanguageContent } from './types';
 
-const defaultLocale = intlayerIntlConfiguration.defaultLocale;
+const defaultLocale = getConfiguration().internationalization.defaultLocale;
 
 type GetTranslationContent = <Content = string>(
   languageContent: CustomizableLanguageContent<Content>,
@@ -18,12 +15,13 @@ type GetTranslationContent = <Content = string>(
  *
  * Usage:
  *
+ * ```ts
  * const content = getTranslationContent({
- * en: 'Hello',
- * fr: 'Bonjour',
- * },
- * 'fr');
+ *  en: 'Hello',
+ *  fr: 'Bonjour',
+ * }, 'fr');
  * // 'Bonjour'
+ * ```
  *
  * Using TypeScript:
  * - this function will require each locale to be defined if defined in the project configuration.

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

@@ -1,10 +1,7 @@
-import { intlayerConfiguration } from '@intlayer/config/client';
+import { getConfiguration } from '@intlayer/config/client';
 import { NodeType } from '../../../types/index';
-import { getStackTraceInfo } from '../../../utils/getStackTraceInfo';
 import type { CustomizableLanguageContent, TranslationContent } from './types';
 
-const { defaultLocale } = intlayerConfiguration.internationalization;
-
 /**
  *
  * Function intended to be used to build intlayer dictionaries.
@@ -13,11 +10,13 @@ const { defaultLocale } = intlayerConfiguration.internationalization;
  *
  * Usage:
  *
+ * ```ts
  * 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.
@@ -26,12 +25,13 @@ const { defaultLocale } = intlayerConfiguration.internationalization;
 const translation = <Content = string>(
   content?: CustomizableLanguageContent<Content>
 ) => {
-  const stackTraceInfo = getStackTraceInfo();
+  const {
+    internationalization: { defaultLocale },
+  } = getConfiguration();
 
   if (typeof content === 'string') {
     const result: TranslationContent<Content> = {
       nodeType: NodeType.Translation,
-      ...stackTraceInfo,
       [defaultLocale]: content,
     } as TranslationContent<Content>;
 
@@ -40,7 +40,6 @@ const translation = <Content = string>(
 
   const result: TranslationContent<Content> = {
     nodeType: NodeType.Translation,
-    ...stackTraceInfo,
     ...(content as unknown as object),
   } as TranslationContent<Content>;
 

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

@@ -32,7 +32,6 @@ export type CustomLocales = ConfigLocales extends never
  * }
  */
 export type LanguageContent<Content> = Partial<Record<LocalesValues, Content>>;
-export type ConfigLanguageContent<Content> = Record<ConfigLocales, Content>;
 
 /**
  * Valid
@@ -64,7 +63,7 @@ export type ConfigLanguageContent<Content> = Record<ConfigLocales, Content>;
 export type CustomizableLanguageContent<Content = string> =
   ConfigLocales extends never
     ? LanguageContent<Content>
-    : ConfigLanguageContent<Content>;
+    : IConfigLocales<Content>;
 
 export type TranslationContent<Content> = LanguageContent<Content> &
   NoteStackTraceInfo & {

package/src/types/contentModule.ts

@@ -29,4 +29,5 @@ export type FlatContent = Record<string, FlatContentValue | undefined>;
 
 export type ContentModule = Content & {
   id: string;
+  filePath?: string;
 };

package/src/types/index.ts

@@ -7,3 +7,8 @@ export type {
   ContentModule,
 } from './contentModule';
 export { NodeType } from './nodeType';
+export type {
+  KeyPath,
+  ObjectExpressionNode,
+  TranslationOrEnumerationNode,
+} from './keyPath';

package/src/types/keyPath.ts

@@ -0,0 +1,13 @@
+import type { NodeType } from './nodeType';
+
+export type ObjectExpressionNode = {
+  type: 'ObjectExpression';
+  key: string;
+};
+
+export type TranslationOrEnumerationNode = {
+  type: NodeType;
+  key: string;
+};
+
+export type KeyPath = ObjectExpressionNode | TranslationOrEnumerationNode;