@intlayer/core 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/core",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "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": [
@@ -24,7 +24,10 @@
     "url": "git+https://github.com/aypineau/intlayer.git"
   },
   "license": "MIT",
-  "author": "Aymeric PINEAU (https://github.com/aypineau)",
+  "author": {
+    "name": "Aymeric PINEAU",
+    "url": "https://github.com/aypineau"
+  },
   "exports": {
     ".": {
       "types": "./dist/esm/index.d.mts",
@@ -47,7 +50,7 @@
     "./package.json"
   ],
   "dependencies": {
-    "@intlayer/config": "^1.0.0"
+    "@intlayer/config": "^1.0.1"
   },
   "devDependencies": {
     "@types/node": "^20.11.30",
@@ -56,8 +59,8 @@
     "rimraf": "5.0.5",
     "tsup": "^8.0.2",
     "typescript": "^5.4.3",
-    "@utils/ts-config": "^1.0.0",
-    "@utils/eslint-config": "^1.0.0"
+    "@utils/eslint-config": "^1.0.1",
+    "@utils/ts-config": "^1.0.1"
   },
   "peerDependencies": {
     "@types/react": "^18.2.78",

package/src/index.ts

@@ -1,8 +1,10 @@
 export type {
+  CustomizableLanguageContent,
   LanguageContent,
   TranslationContent,
   EnumerationContent,
   QuantityContent,
+  CustomLocales as Locales,
 } from './transpiler/content_transformers/index';
 export {
   t,

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

@@ -2,12 +2,16 @@ import {
   type Locales,
   intlayerIntlConfiguration,
 } from '@intlayer/config/client';
-import type { LanguageContent } from './translations';
+import type { CustomizableLanguageContent } from './types';
 
 const defaultLocale = intlayerIntlConfiguration.defaultLocale;
 
-export const getTranslationContent = <Content>(
-  languageContent: LanguageContent<Content>,
+type GetTranslationContent = <Content = string>(
+  languageContent: CustomizableLanguageContent<Content>,
   locale: Locales
-): Content =>
-  languageContent[locale ?? defaultLocale] ?? languageContent[defaultLocale];
+) => Content;
+
+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,2 +1,3 @@
-export * from './translations';
+export * from './translation';
 export * from './getTranslationContent';
+export * from './types';

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

@@ -0,0 +1,53 @@
+import { intlayerConfiguration } from '@intlayer/config/client';
+import { NodeType } from '../../../types/index';
+import { getStackTraceInfo } from '../../../utils/getStackTraceInfo';
+import type { CustomizableLanguageContent, TranslationContent } from './types';
+
+const { defaultLocale } = intlayerConfiguration.internationalization;
+
+/**
+ * Transpile multilingual dictionary content
+ *
+ * Usage
+ *
+ *  translation<string>({
+ *    "en": "test",
+ *    "fr": "test",
+ *    // ... any other available locale
+ *  })
+ *
+ * translation<number, Locales.ENGLISH>({
+ *  "en": 1
+ * })
+ *
+ * translation<string, Locales.ENGLISH | Locales.FRENCH>({
+ *  "fr": "test",
+ *  "en": "test"
+ * })
+ *
+ */
+const translation = <Content = string>(
+  content?: CustomizableLanguageContent<Content>
+) => {
+  const stackTraceInfo = getStackTraceInfo();
+
+  if (typeof content === 'string') {
+    const result: TranslationContent<Content> = {
+      nodeType: NodeType.Translation,
+      ...stackTraceInfo,
+      [defaultLocale]: content,
+    } as TranslationContent<Content>;
+
+    return result;
+  }
+
+  const result: TranslationContent<Content> = {
+    nodeType: NodeType.Translation,
+    ...stackTraceInfo,
+    ...(content as unknown as object),
+  } as TranslationContent<Content>;
+
+  return result;
+};
+
+export { translation as t };

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

@@ -0,0 +1,72 @@
+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>>;
+export type ConfigLanguageContent<Content> = Record<ConfigLocales, 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>
+    : ConfigLanguageContent<Content>;
+
+export type TranslationContent<Content> = LanguageContent<Content> &
+  NoteStackTraceInfo & {
+    nodeType: NodeType.Translation;
+  };

package/src/transpiler/index.ts

@@ -1,7 +1 @@
-export type {
-  LanguageContent,
-  TranslationContent,
-  EnumerationContent,
-  QuantityContent,
-} from './content_transformers/index';
-export { t, enu } from './content_transformers/index';
+export * from './content_transformers/index';

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/translations.ts"],"sourcesContent":["import { type Locales, intlayerConfiguration } from '@intlayer/config/client';\nimport type { ReactNode } from 'react';\nimport { NodeType } from '../../../types/index';\nimport {\n  getStackTraceInfo,\n  type NoteStackTraceInfo,\n} from '../../../utils/getStackTraceInfo';\n\nexport type LanguageContent<Content> = Record<Locales, Content>;\n\nexport type TranslationContent<Content> = Partial<LanguageContent<Content>> &\n  NoteStackTraceInfo & {\n    nodeType: NodeType.Translation;\n  };\n\n/**\n * Create a JSON with the content and the stack trace information\n */\nconst translations = <Content>(\n  content?: Partial<LanguageContent<Content>> | string\n) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: TranslationContent<Content> = {\n      nodeType: NodeType.Translation,\n      ...stackTraceInfo,\n      [intlayerConfiguration.internationalization.defaultLocale]: content,\n    };\n\n    return result;\n  }\n\n  const result: TranslationContent<Content> = {\n    nodeType: NodeType.Translation,\n    ...stackTraceInfo,\n    ...content,\n  };\n\n  return result;\n};\n\nexport { translations as t };\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAoD;AAEpD,mBAAyB;AACzB,+BAGO;AAYP,MAAM,eAAe,CACnB,YACG;AACH,QAAM,qBAAiB,4CAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,sBAAS;AAAA,MACnB,GAAG;AAAA,MACH,CAAC,oCAAsB,qBAAqB,aAAa,GAAG;AAAA,IAC9D;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/translation/translations.d.ts

@@ -1,17 +0,0 @@
-import { Locales } from "@intlayer/config/client";
-import { NoteStackTraceInfo } from "../../../utils/getStackTraceInfo.js";
-import { NodeType } from "../../../types/nodeType.js";
-
-type LanguageContent<Content> = Record<Locales, Content>;
-type TranslationContent<Content> = Partial<LanguageContent<Content>> &
-  NoteStackTraceInfo & {
-    nodeType: NodeType.Translation;
-  };
-/**
- * Create a JSON with the content and the stack trace information
- */
-declare const translations: <Content>(
-  content?: Partial<LanguageContent<Content>> | string
-) => TranslationContent<Content>;
-
-export { type LanguageContent, type TranslationContent, translations as t };

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

@@ -1,17 +0,0 @@
-import { Locales } from "@intlayer/config/client";
-import { NoteStackTraceInfo } from "../../../utils/getStackTraceInfo.mjs";
-import { NodeType } from "../../../types/nodeType.mjs";
-
-type LanguageContent<Content> = Record<Locales, Content>;
-type TranslationContent<Content> = Partial<LanguageContent<Content>> &
-  NoteStackTraceInfo & {
-    nodeType: NodeType.Translation;
-  };
-/**
- * Create a JSON with the content and the stack trace information
- */
-declare const translations: <Content>(
-  content?: Partial<LanguageContent<Content>> | string
-) => TranslationContent<Content>;
-
-export { type LanguageContent, type TranslationContent, translations as t };

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../../src/transpiler/content_transformers/translation/translations.ts"],"sourcesContent":["import { type Locales, intlayerConfiguration } from '@intlayer/config/client';\nimport type { ReactNode } from 'react';\nimport { NodeType } from '../../../types/index';\nimport {\n  getStackTraceInfo,\n  type NoteStackTraceInfo,\n} from '../../../utils/getStackTraceInfo';\n\nexport type LanguageContent<Content> = Record<Locales, Content>;\n\nexport type TranslationContent<Content> = Partial<LanguageContent<Content>> &\n  NoteStackTraceInfo & {\n    nodeType: NodeType.Translation;\n  };\n\n/**\n * Create a JSON with the content and the stack trace information\n */\nconst translations = <Content>(\n  content?: Partial<LanguageContent<Content>> | string\n) => {\n  const stackTraceInfo = getStackTraceInfo();\n\n  if (typeof content === 'string') {\n    const result: TranslationContent<Content> = {\n      nodeType: NodeType.Translation,\n      ...stackTraceInfo,\n      [intlayerConfiguration.internationalization.defaultLocale]: content,\n    };\n\n    return result;\n  }\n\n  const result: TranslationContent<Content> = {\n    nodeType: NodeType.Translation,\n    ...stackTraceInfo,\n    ...content,\n  };\n\n  return result;\n};\n\nexport { translations as t };\n"],"mappings":"AAAA,SAAuB,6BAA6B;AAEpD,SAAS,gBAAgB;AACzB;AAAA,EACE;AAAA,OAEK;AAYP,MAAM,eAAe,CACnB,YACG;AACH,QAAM,iBAAiB,kBAAkB;AAEzC,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAMA,UAAsC;AAAA,MAC1C,UAAU,SAAS;AAAA,MACnB,GAAG;AAAA,MACH,CAAC,sBAAsB,qBAAqB,aAAa,GAAG;AAAA,IAC9D;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/src/transpiler/content_transformers/translation/translations.ts

@@ -1,42 +0,0 @@
-import { type Locales, intlayerConfiguration } from '@intlayer/config/client';
-import { NodeType } from '../../../types/index';
-import {
-  getStackTraceInfo,
-  type NoteStackTraceInfo,
-} from '../../../utils/getStackTraceInfo';
-
-export type LanguageContent<Content> = Record<Locales, Content>;
-
-export type TranslationContent<Content> = Partial<LanguageContent<Content>> &
-  NoteStackTraceInfo & {
-    nodeType: NodeType.Translation;
-  };
-
-/**
- * Create a JSON with the content and the stack trace information
- */
-const translations = <Content>(
-  content?: Partial<LanguageContent<Content>> | string
-) => {
-  const stackTraceInfo = getStackTraceInfo();
-
-  if (typeof content === 'string') {
-    const result: TranslationContent<Content> = {
-      nodeType: NodeType.Translation,
-      ...stackTraceInfo,
-      [intlayerConfiguration.internationalization.defaultLocale]: content,
-    };
-
-    return result;
-  }
-
-  const result: TranslationContent<Content> = {
-    nodeType: NodeType.Translation,
-    ...stackTraceInfo,
-    ...content,
-  };
-
-  return result;
-};
-
-export { translations as t };