@intlayer/core 2.0.0 → 2.0.1

package/src/localeList.ts

@@ -1,229 +0,0 @@
-import { Locales } from '@intlayer/config/client';
-
-export const localeList: Locales[] = [
-  Locales.AFRIKAANS,
-  Locales.AFRIKAANS_SOUTH_AFRICA,
-  Locales.ARABIC,
-  Locales.ARABIC_UNITED_ARAB_EMIRATES,
-  Locales.ARABIC_BAHRAIN,
-  Locales.ARABIC_ALGERIA,
-  Locales.ARABIC_EGYPT,
-  Locales.ARABIC_IRAQ,
-  Locales.ARABIC_JORDAN,
-  Locales.ARABIC_KUWAIT,
-  Locales.ARABIC_LEBANON,
-  Locales.ARABIC_LIBYA,
-  Locales.ARABIC_MOROCCO,
-  Locales.ARABIC_OMAN,
-  Locales.ARABIC_QATAR,
-  Locales.ARABIC_SAUDI_ARABIA,
-  Locales.ARABIC_SYRIA,
-  Locales.ARABIC_TUNISIA,
-  Locales.ARABIC_YEMEN,
-  Locales.AZERI_LATIN,
-  Locales.AZERI_LATIN_AZERBAIJAN,
-  Locales.BELARUSIAN,
-  Locales.BELARUSIAN_BELARUS,
-  Locales.BULGARIAN,
-  Locales.BULGARIAN_BULGARIA,
-  Locales.BOSNIAN_BOSNIA_AND_HERZEGOVINA,
-  Locales.CATALAN,
-  Locales.CATALAN_SPAIN,
-  Locales.CZECH,
-  Locales.CZECH_CZECH_REPUBLIC,
-  Locales.WELSH,
-  Locales.WELSH_UNITED_KINGDOM,
-  Locales.DANISH,
-  Locales.DANISH_DENMARK,
-  Locales.GERMAN,
-  Locales.GERMAN_AUSTRIA,
-  Locales.GERMAN_SWITZERLAND,
-  Locales.GERMAN_GERMANY,
-  Locales.GERMAN_LIECHTENSTEIN,
-  Locales.GERMAN_LUXEMBOURG,
-  Locales.DIVEHI,
-  Locales.DIVEHI_MALDIVES,
-  Locales.GREEK,
-  Locales.GREEK_GREECE,
-  Locales.ENGLISH,
-  Locales.ENGLISH_AUSTRALIA,
-  Locales.ENGLISH_BELIZE,
-  Locales.ENGLISH_CANADA,
-  Locales.ENGLISH_CARIBBEAN,
-  Locales.ENGLISH_UNITED_KINGDOM,
-  Locales.ENGLISH_IRELAND,
-  Locales.ENGLISH_JAMAICA,
-  Locales.ENGLISH_NEW_ZEALAND,
-  Locales.ENGLISH_PHILIPPINES,
-  Locales.ENGLISH_TRINIDAD_AND_TOBAGO,
-  Locales.ENGLISH_UNITED_STATES,
-  Locales.ENGLISH_SOUTH_AFRICA,
-  Locales.ENGLISH_ZIMBABWE,
-  Locales.ESPERANTO,
-  Locales.SPANISH,
-  Locales.SPANISH_ARGENTINA,
-  Locales.SPANISH_BOLIVIA,
-  Locales.SPANISH_CHILE,
-  Locales.SPANISH_COLOMBIA,
-  Locales.SPANISH_COSTA_RICA,
-  Locales.SPANISH_DOMINICAN_REPUBLIC,
-  Locales.SPANISH_ECUADOR,
-  Locales.SPANISH_SPAIN,
-  Locales.SPANISH_GUATEMALA,
-  Locales.SPANISH_HONDURAS,
-  Locales.SPANISH_MEXICO,
-  Locales.SPANISH_NICARAGUA,
-  Locales.SPANISH_PANAMA,
-  Locales.SPANISH_PERU,
-  Locales.SPANISH_PUERTO_RICO,
-  Locales.SPANISH_PARAGUAY,
-  Locales.SPANISH_EL_SALVADOR,
-  Locales.SPANISH_URUGUAY,
-  Locales.SPANISH_VENEZUELA,
-  Locales.ESTONIAN,
-  Locales.ESTONIAN_ESTONIA,
-  Locales.BASQUE,
-  Locales.BASQUE_SPAIN,
-  Locales.FARSI,
-  Locales.FARSI_IRAN,
-  Locales.FINNISH,
-  Locales.FINNISH_FINLAND,
-  Locales.FAROESE,
-  Locales.FAROESE_FAROE_ISLANDS,
-  Locales.FRENCH,
-  Locales.FRENCH_BELGIUM,
-  Locales.FRENCH_CANADA,
-  Locales.FRENCH_SWITZERLAND,
-  Locales.FRENCH_FRANCE,
-  Locales.FRENCH_LUXEMBOURG,
-  Locales.FRENCH_PRINCIPALITY_OF_MONACO,
-  Locales.GALICIAN,
-  Locales.GALICIAN_SPAIN,
-  Locales.GUJARATI,
-  Locales.GUJARATI_INDIA,
-  Locales.HEBREW,
-  Locales.HEBREW_ISRAEL,
-  Locales.HINDI,
-  Locales.HINDI_INDIA,
-  Locales.CROATIAN,
-  Locales.CROATIAN_BOSNIA_AND_HERZEGOVINA,
-  Locales.CROATIAN_CROATIA,
-  Locales.HUNGARIAN,
-  Locales.HUNGARIAN_HUNGARY,
-  Locales.ARMENIAN,
-  Locales.ARMENIAN_ARMENIA,
-  Locales.INDONESIAN,
-  Locales.INDONESIAN_INDONESIA,
-  Locales.ICELANDIC,
-  Locales.ICELANDIC_ICELAND,
-  Locales.ITALIAN,
-  Locales.ITALIAN_SWITZERLAND,
-  Locales.ITALIAN_ITALY,
-  Locales.JAPANESE,
-  Locales.JAPANESE_JAPAN,
-  Locales.GEORGIAN,
-  Locales.GEORGIAN_GEORGIA,
-  Locales.KAZAKH,
-  Locales.KAZAKH_KAZAKHSTAN,
-  Locales.KANNADA,
-  Locales.KANNADA_INDIA,
-  Locales.KOREAN,
-  Locales.KOREAN_KOREA,
-  Locales.KONKANI,
-  Locales.KONKANI_INDIA,
-  Locales.KYRGYZ,
-  Locales.KYRGYZ_KYRGYZSTAN,
-  Locales.LITHUANIAN,
-  Locales.LITHUANIAN_LITHUANIA,
-  Locales.LATVIAN,
-  Locales.LATVIAN_LATVIA,
-  Locales.MAORI,
-  Locales.MAORI_NEW_ZEALAND,
-  Locales.FYRO_MACEDONIAN,
-  Locales.FYRO_MACEDONIAN_MACEDONIA,
-  Locales.MONGOLIAN,
-  Locales.MONGOLIAN_MONGOLIA,
-  Locales.MARATHI,
-  Locales.MARATHI_INDIA,
-  Locales.MALAY,
-  Locales.MALAY_BRUNEI_DARUSSALAM,
-  Locales.MALAY_MALAYSIA,
-  Locales.MALTESE,
-  Locales.MALTESE_MALTA,
-  Locales.NORWEGIAN_BOKMAL,
-  Locales.NORWEGIAN_BOKMAL_NORWAY,
-  Locales.DUTCH,
-  Locales.DUTCH_BELGIUM,
-  Locales.DUTCH_NETHERLANDS,
-  Locales.NORWEGIAN_NYNORSK_NORWAY,
-  Locales.NORTHERN_SOTHO,
-  Locales.NORTHERN_SOTHO_SOUTH_AFRICA,
-  Locales.PUNJABI,
-  Locales.PUNJABI_INDIA,
-  Locales.POLISH,
-  Locales.POLISH_POLAND,
-  Locales.PASHTO,
-  Locales.PASHTO_AFGHANISTAN,
-  Locales.PORTUGUESE,
-  Locales.PORTUGUESE_BRAZIL,
-  Locales.PORTUGUESE_PORTUGAL,
-  Locales.QUECHUA,
-  Locales.QUECHUA_BOLIVIA,
-  Locales.QUECHUA_ECUADOR,
-  Locales.QUECHUA_PERU,
-  Locales.ROMANIAN,
-  Locales.ROMANIAN_ROMANIA,
-  Locales.RUSSIAN,
-  Locales.RUSSIAN_RUSSIA,
-  Locales.SANSKRIT,
-  Locales.SANSKRIT_INDIA,
-  Locales.SAMI_NORTHERN,
-  Locales.SAMI_NORTHERN_FINLAND,
-  Locales.SAMI_NORTHERN_NORWAY,
-  Locales.SAMI_NORTHERN_SWEDEN,
-  Locales.SLOVAK,
-  Locales.SLOVAK_SLOVAKIA,
-  Locales.SLOVENIAN,
-  Locales.SLOVENIAN_SLOVENIA,
-  Locales.ALBANIAN,
-  Locales.ALBANIAN_ALBANIA,
-  Locales.SERBIAN_LATIN_BOSNIA_AND_HERZEGOVINA,
-  Locales.SERBIAN_LATIN_SERBIA_AND_MONTENEGRO,
-  Locales.SWEDISH,
-  Locales.SWEDISH_FINLAND,
-  Locales.SWEDISH_SWEDEN,
-  Locales.SWAHILI_KENYA,
-  Locales.SYRIAC_SYRIA,
-  Locales.TAMIL,
-  Locales.TAMIL_INDIA,
-  Locales.TELUGU,
-  Locales.TELUGU_INDIA,
-  Locales.THAI,
-  Locales.THAI_THAILAND,
-  Locales.TAGALOG,
-  Locales.TAGALOG_PHILIPPINES,
-  Locales.TSWANA,
-  Locales.TSWANA_SOUTH_AFRICA,
-  Locales.TURKISH,
-  Locales.TURKISH_TURKEY,
-  Locales.TATAR,
-  Locales.TATAR_RUSSIA,
-  Locales.TSOGA,
-  Locales.UKRAINIAN,
-  Locales.UKRAINIAN_UKRAINE,
-  Locales.URDU,
-  Locales.URDU_ISLAMIC_REPUBLIC_OF_PAKISTAN,
-  Locales.UZBEK_LATIN,
-  Locales.UZBEK_LATIN_UZBEKISTAN,
-  Locales.VIETNAMESE,
-  Locales.VIETNAMESE_VIET_NAM,
-  Locales.XHOSA,
-  Locales.XHOSA_SOUTH_AFRICA,
-  Locales.CHINESE,
-  Locales.CHINESE_SIMPLIFIED,
-  Locales.CHINESE_HONG_KONG,
-  Locales.CHINESE_MACAU,
-  Locales.CHINESE_SINGAPORE,
-  Locales.CHINESE_TRADITIONAL,
-  Locales.ZULU_SOUTH_AFRICA,
-];

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

@@ -1,66 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { NodeType } from '../../../types/index';
-
-type Positif = number | `${number}`;
-type Negatif = `-${number}`;
-type Numbers = Positif | Negatif;
-
-type Equal = Numbers;
-type EqualString = `=${Numbers}`;
-type Superior = `>${Numbers}`;
-type SuperiorOrEqual = `>=${Numbers}`;
-type Inferior = `<${Numbers}`;
-type InferiorOrEqual = `<=${Numbers}`;
-
-export type EnterFormat =
-  | Equal
-  | EqualString
-  | Superior
-  | SuperiorOrEqual
-  | Inferior
-  | InferiorOrEqual;
-
-export type QuantityContent<Content> = Record<EnterFormat, Content>;
-
-export type EnumerationContent<Content> = Partial<QuantityContent<Content>> & {
-  nodeType: NodeType.Enumeration;
-};
-
-/**
- * Function intended to be used to build intlayer dictionaries.
- *
- * Allow to pick a content based on a quantity.
- *
- * Usage:
- *
- * ```ts
- * 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>>) => {
-  if (typeof content === 'string') {
-    const result: EnumerationContent<Content> = {
-      nodeType: NodeType.Enumeration,
-      1: content,
-    };
-
-    return result;
-  }
-
-  const result: EnumerationContent<Content> = {
-    nodeType: NodeType.Enumeration,
-    ...content,
-  };
-
-  return result;
-};
-
-export { enumeration as enu };

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

@@ -1,64 +0,0 @@
-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,38 +0,0 @@
-import { findMatchingCondition } from '../..';
-import type { QuantityContent } from './enumeration';
-
-/**
- * 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);
- * // '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',
- * }, 2);
- * // 'You have less than four'
- * ```
- *
- */
-export const getEnumerationContent = <Content>(
-  enumerationContent: QuantityContent<Content>,
-  quantity: number
-): Content => {
-  const key = findMatchingCondition<Content>(enumerationContent, quantity);
-
-  // Default or error handling if no keys match
-  return enumerationContent[key];
-};

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

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

package/src/transpiler/content_transformers/index.ts

@@ -1,2 +0,0 @@
-export * from './translation/index';
-export * from './enumeration/index';

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

@@ -1,33 +0,0 @@
-import { type Locales, getConfiguration } from '@intlayer/config/client';
-import type { CustomizableLanguageContent } from './types';
-
-const defaultLocale = getConfiguration().internationalization.defaultLocale;
-
-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:
- *
- * ```ts
- * 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
-) => languageContent[locale ?? defaultLocale] ?? languageContent[defaultLocale];

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

@@ -1,3 +0,0 @@
-export * from './translation';
-export * from './getTranslationContent';
-export * from './types';

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

@@ -1,49 +0,0 @@
-import { getConfiguration } from '@intlayer/config/client';
-import { NodeType } from '../../../types/index';
-import type { CustomizableLanguageContent, TranslationContent } from './types';
-
-/**
- *
- * Function intended to be used to build intlayer dictionaries.
- *
- * Get the content of a translation based on the locale.
- *
- * 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.
- * - 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>
-) => {
-  const {
-    internationalization: { defaultLocale },
-  } = getConfiguration();
-
-  if (typeof content === 'string') {
-    const result: TranslationContent<Content> = {
-      nodeType: NodeType.Translation,
-      [defaultLocale]: content,
-    } as TranslationContent<Content>;
-
-    return result;
-  }
-
-  const result: TranslationContent<Content> = {
-    nodeType: NodeType.Translation,
-    ...(content as unknown as object),
-  } as TranslationContent<Content>;
-
-  return result;
-};
-
-export { translation as t };

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

@@ -1,71 +0,0 @@
-import type { LocalesValues } from '@intlayer/config/client';
-// @ts-expect-error intlayer declared for module augmentation
-import type { IConfigLocales } from 'intlayer';
-import type { NodeType } from '../../../types';
-import type { NoteStackTraceInfo } from '../../../utils/getStackTraceInfo';
-
-/**
- * If module augmented, it will return the configured locales such as Locales.ENGLISH | Locales.FRENCH | Locales.SPANISH | ...
- * If not, it will return never
- */
-export type ConfigLocales = keyof IConfigLocales<unknown>;
-
-/**
- * If module augmented, it will return the configured locales such as Locales.ENGLISH | Locales.FRENCH | Locales.SPANISH | ...
- * If not, it will return all available locales such as Locales.ENGLISH | Locales.FRENCH | Locales.SPANISH | ...
- */
-export type CustomLocales = ConfigLocales extends never
-  ? LocalesValues
-  : ConfigLocales;
-
-/**
- * Record of locales and content
- *
- * const myVar1: LanguageContent<string> = {
- *  "en": "",
- *  "fr": ""
- * }
- *
- * const myVar2: LanguageContent<{age: number, name: string}> = {
- *  "en": {age: 1, name: "test"},
- *  "fr": {age: 1, name: "test"}
- * }
- */
-export type LanguageContent<Content> = Partial<Record<LocalesValues, Content>>;
-
-/**
- * Valid
- * const test: CustomizableLanguageContent<string, Locales.ENGLISH | Locales.FRENCH> = {
- *  "en": "test",
- *  "fr": "test"
- * }
- *
- * const test: CustomizableLanguageContent<number> = {
- *  "fr": 1,
- *  "en": 1,
- *  ... any other available locale
- * }
- *
- * Invalid
- *
- * const test: CustomizableLanguageContent<string> = {
- * "en": "test",
- * "fr": "test",
- * "sss": "test" // Does not exist in Locales
- * }
- *
- * const test: CustomizableLanguageContent<string, Locales.ENGLISH | Locales.FRENCH> = {
- *  "fr": "test"
- *  // Locales.ENGLISH is missing
- * }
- *
- */
-export type CustomizableLanguageContent<Content = string> =
-  ConfigLocales extends never
-    ? LanguageContent<Content>
-    : IConfigLocales<Content>;
-
-export type TranslationContent<Content> = LanguageContent<Content> &
-  NoteStackTraceInfo & {
-    nodeType: NodeType.Translation;
-  };

package/src/transpiler/index.ts

@@ -1 +0,0 @@
-export * from './content_transformers/index';

package/src/types/contentModule.ts

@@ -1,33 +0,0 @@
-import type {
-  EnumerationContent,
-  TranslationContent,
-} from '../transpiler/index';
-
-export type TypedNode =
-  | TranslationContent<unknown>
-  | EnumerationContent<unknown>;
-
-export type ContentValue =
-  | string
-  | {
-      [key: string]: ContentValue;
-    }
-  | (() => ContentValue)
-  | Promise<ContentValue>
-  | TypedNode;
-
-export type Content = Record<string, ContentValue | undefined>;
-
-export type FlatContentValue =
-  | string
-  | {
-      [key: string]: FlatContentValue;
-    }
-  | TypedNode;
-
-export type FlatContent = Record<string, FlatContentValue | undefined>;
-
-export type ContentModule = Content & {
-  id: string;
-  filePath?: string;
-};

package/src/types/index.ts

@@ -1,14 +0,0 @@
-export type {
-  ContentValue,
-  Content,
-  FlatContentValue,
-  FlatContent,
-  TypedNode,
-  ContentModule,
-} from './contentModule';
-export { NodeType } from './nodeType';
-export type {
-  KeyPath,
-  ObjectExpressionNode,
-  TranslationOrEnumerationNode,
-} from './keyPath';

package/src/types/keyPath.ts

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

package/src/types/nodeType.ts

@@ -1,4 +0,0 @@
-export enum NodeType {
-  Translation = 'translation',
-  Enumeration = 'enumeration',
-}

package/src/utils/getStackTraceInfo.ts

@@ -1,39 +0,0 @@
-export type NoteStackTraceInfo = {
-  file?: string;
-  line?: string;
-  column?: string;
-};
-
-/**
- * Get the file path, line number, and column number of the caller of this function
- * Return an object containing file, line, and column numbers
- */
-export const getStackTraceInfo = (): NoteStackTraceInfo => {
-  // Create a new Error object to capture the stack trace
-  const err = new Error();
-  const stack = err.stack ?? '';
-
-  // Split the stack trace into lines and find the line where this function was called
-  // Adjust the line index as necessary based on how your environment's stack trace format
-  const stackLines = stack.split('\n');
-  const callerLine = stackLines[2] ?? ''; // Adjust the index 2 if needed
-
-  // Extract file path, line number, and column number using a regular expression
-  // This regex pattern might need adjustments based on your environment
-  const match = callerLine.match(/at\s[^(:]+\([^:]+:(\d+):(\d+)\)?/);
-
-  // const file = match?.[1];
-  const line = match?.[1];
-  const column = match?.[2];
-
-  if (match) {
-    return {
-      // file,
-      line,
-      column,
-    };
-  }
-
-  // Return empty object if parsing fails
-  return {};
-};