intlayer 1.0.0 → 1.2.0

package/README.md

@@ -0,0 +1,176 @@
+# Intlayer: Next-Level Content Management in JavaScript
+
+**Intlayer** is an innovative Content Management System (CMS) designed specifically for JavaScript developers. It enables seamless transpilation of JavaScript content into structured dictionaries, making integration into your codebase straightforward and efficient.
+
+## Why Choose Intlayer?
+
+- **JavaScript-Powered Content Management**: Harness the flexibility of JavaScript to define and manage your content efficiently.
+- **Type-Safe Environment**: Leverage TypeScript to ensure all your content definitions are precise and error-free.
+- **Integrated Content Files**: Keep your translations close to their respective components, enhancing maintainability and clarity.
+
+## intlayer package
+
+`intlayer` package intend to declare your content in a structured way, using JavaScript.
+
+To build dictionaries from this declaration, you can use [intlayer-cli](https://github.com/aypineau/intlayer/blob/main/packages/intlayer-cli/readme.md).
+And to interpret intlayer dictionaries you can interpreters, such as [react-intlayer](https://github.com/aypineau/intlayer/blob/main/packages/react-intlayer/readme.md), or [next-intlayer](https://github.com/aypineau/intlayer/blob/main/packages/next-intlayer/readme.md)
+
+## Getting Started with Intlayer
+
+[See how to use intlayer with NextJS](https://github.com/aypineau/intlayer/blob/main/readme.md)
+
+### Install Package
+
+Install the necessary packages using npm:
+
+```bash
+npm install intlayer
+```
+
+```bash
+yarn install intlayer
+```
+
+```bash
+pnpm install intlayer
+```
+
+### Manage Your Content
+
+Create and manage your content dictionaries:
+
+#### Using typescript
+
+```typescript
+// src/app/[locale]/page.content.ts
+import { t, enu, type ContentModule } from "intlayer";
+
+const pageContent: ContentModule = {
+  id: "page",
+  getStarted: {
+    main: t({
+      en: "Get started by editing",
+      fr: "Commencez par éditer",
+      es: "Comience por editar",
+    }),
+    pageLink: "src/app/page.tsx",
+  },
+  nestedContent: {
+    id: "enumeration",
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      "0": "No cars",
+      "1": "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+};
+
+// Content should be exported as default
+export default pageContent;
+```
+
+#### Using ECMAScript modules
+
+```javascript
+// src/app/[locale]/page.content.mjs
+
+import { t } from "intlayer";
+
+/** @type {import('intlayer').ContentModule} */
+const pageContent = {
+  id: "page",
+  getStarted: {
+    main: t({
+      en: "Get started by editing",
+      fr: "Commencez par éditer",
+      es: "Comience por editar",
+    }),
+    pageLink: "src/app/page.tsx",
+  },
+  nestedContent: {
+    id: "enumeration",
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      "0": "No cars",
+      "1": "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+};
+
+// Content should be exported as default
+export default pageContent;
+```
+
+#### Using CommonJS modules
+
+```javascript
+// src/app/[locale]/page.content.cjs
+
+const { t } = require("intlayer");
+
+/** @type {import('intlayer').ContentModule} */
+const pageContent = {
+  id: "page",
+  getStarted: {
+    main: t({
+      en: "Get started by editing",
+      fr: "Commencez par éditer",
+      es: "Comience por editar",
+    }),
+    pageLink: "src/app/page.tsx",
+  },
+  nestedContent: {
+    id: "enumeration",
+    numberOfCar: enu({
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      "0": "No cars",
+      "1": "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    }),
+  },
+};
+
+// Content should be exported as default
+module.exports = pageContent;
+```
+
+#### Using CommonJS modules
+
+```json
+// src/app/[locale]/page.content.json
+
+{
+  "id": "page",
+  "getStarted": {
+    "main": {
+      "nodeType": "translation",
+      "en": "Get started by editing",
+      "fr": "Commencez par éditer",
+      "es": "Comience por editar",
+    },
+    "pageLink": "src/app/page.tsx",
+  },
+  "nestedContent": {
+    "id": "enumeration",
+    "nodeType": "enumeration",
+    "numberOfCar": {
+      "<-1": "Less than minus one car",
+      "-1": "Minus one car",
+      "0": "No cars",
+      "1": "One car",
+      ">5": "Some cars",
+      ">19": "Many cars",
+    },
+  },
+};
+```
+
+This version emphasizes ease of use, practical steps, and the professional application of Intlayer in a Next.js environment.

package/dist/cjs/index.cjs

@@ -8,38 +8,36 @@ var __export = (target, all) => {
     __defProp(target, name, { get: all[name], enumerable: true });
 };
 var __copyProps = (to, from, except, desc) => {
-  if ((from && typeof from === "object") || typeof from === "function") {
+  if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
       if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, {
-          get: () => from[key],
-          enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable,
-        });
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
   return to;
 };
-var __toCommonJS = (mod) =>
-  __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var src_exports = {};
 __export(src_exports, {
   Locales: () => import_client.Locales,
-  enu: () => import_core.enu,
-  getEnumerationContent: () => import_core.getEnumerationContent,
-  getLocaleName: () => import_core.getLocaleName,
-  getTranslationContent: () => import_core.getTranslationContent,
-  t: () => import_core.t,
+  enu: () => import_core2.enu,
+  getEnumerationContent: () => import_core2.getEnumerationContent,
+  getLocaleName: () => import_core2.getLocaleName,
+  getTranslationContent: () => getTranslationContent,
+  t: () => t
 });
 module.exports = __toCommonJS(src_exports);
 var import_core = require("@intlayer/core");
+var import_core2 = require("@intlayer/core");
 var import_client = require("@intlayer/config/client");
+const t = import_core.t;
+const getTranslationContent = import_core.getTranslationContent;
 // Annotate the CommonJS export names for ESM import in node:
-0 &&
-  (module.exports = {
-    Locales,
-    enu,
-    getEnumerationContent,
-    getLocaleName,
-    getTranslationContent,
-    t,
-  });
-//# sourceMappingURL=index.cjs.map
+0 && (module.exports = {
+  Locales,
+  enu,
+  getEnumerationContent,
+  getLocaleName,
+  getTranslationContent,
+  t
+});
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export type {\n  LanguageContent,\n  TranslationContent,\n  ContentValue,\n  Content,\n  FlatContentValue,\n  FlatContent,\n  ContentModule,\n} from '@intlayer/core';\nexport {\n  t,\n  getLocaleName,\n  enu,\n  getEnumerationContent,\n  getTranslationContent,\n} from '@intlayer/core';\nexport {\n  type CustomIntlayerConfig as IntlayerConfig,\n  Locales,\n} from '@intlayer/config/client';\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,kBAMO;AACP,oBAGO;","names":[]}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import type { Locales } from '@intlayer/config/client';\nimport {\n  type TranslationContent,\n  t as tCore,\n  getTranslationContent as getTranslationContentCore,\n  type LanguageContent,\n} from '@intlayer/core';\n\n/* eslint-disable @typescript-eslint/no-unused-vars */\n/* eslint-disable @typescript-eslint/no-empty-interface */\nexport interface IConfigLocales<Content> {\n  // This interface should be augmented in the consuming app\n}\n\ntype ConfigLocales = keyof IConfigLocales<unknown>;\n\ntype ConfigLanguageContent<Content> = Record<ConfigLocales, Content>;\n\nexport type CustomizableLanguageContent<Content = string> =\n  ConfigLocales extends never\n    ? LanguageContent<Content>\n    : ConfigLanguageContent<Content>;\n\n// Re-exporting the following functions from the core package: to use module augmentation\nexport const t: <Content = string>(\n  content?: CustomizableLanguageContent<Content>\n) => TranslationContent<Content> = tCore;\nexport const getTranslationContent: <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => Content = getTranslationContentCore;\n\nexport type {\n  LanguageContent,\n  QuantityContent,\n  ContentValue,\n  ContentModule,\n} from '@intlayer/core';\nexport { getLocaleName, enu, getEnumerationContent } from '@intlayer/core';\nexport {\n  type CustomIntlayerConfig as IntlayerConfig,\n  Locales,\n} from '@intlayer/config/client';\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,kBAKO;AAgCP,IAAAA,eAA0D;AAC1D,oBAGO;AAlBA,MAAM,IAEsB,YAAAC;AAC5B,MAAM,wBAGE,YAAAC;","names":["import_core","tCore","getTranslationContentCore"]}

package/dist/cjs/index.d.ts

@@ -1,18 +1,14 @@
-export {
-  Content,
-  ContentModule,
-  ContentValue,
-  FlatContent,
-  FlatContentValue,
-  LanguageContent,
-  TranslationContent,
-  enu,
-  getEnumerationContent,
-  getLocaleName,
-  getTranslationContent,
-  t,
-} from "@intlayer/core";
-export {
-  CustomIntlayerConfig as IntlayerConfig,
-  Locales,
-} from "@intlayer/config/client";
+import { Locales } from '@intlayer/config/client';
+export { CustomIntlayerConfig as IntlayerConfig, Locales } from '@intlayer/config/client';
+import { LanguageContent, TranslationContent } from '@intlayer/core';
+export { ContentModule, ContentValue, LanguageContent, QuantityContent, enu, getEnumerationContent, getLocaleName } from '@intlayer/core';
+
+interface IConfigLocales<Content> {
+}
+type ConfigLocales = keyof IConfigLocales<unknown>;
+type ConfigLanguageContent<Content> = Record<ConfigLocales, Content>;
+type CustomizableLanguageContent<Content = string> = ConfigLocales extends never ? LanguageContent<Content> : ConfigLanguageContent<Content>;
+declare const t: <Content = string>(content?: CustomizableLanguageContent<Content>) => TranslationContent<Content>;
+declare const getTranslationContent: <Content = string>(languageContent: CustomizableLanguageContent<Content>, locale: Locales) => Content;
+
+export { type CustomizableLanguageContent, type IConfigLocales, getTranslationContent, t };

package/dist/esm/index.d.mts

@@ -1,18 +1,14 @@
-export {
-  Content,
-  ContentModule,
-  ContentValue,
-  FlatContent,
-  FlatContentValue,
-  LanguageContent,
-  TranslationContent,
-  enu,
-  getEnumerationContent,
-  getLocaleName,
-  getTranslationContent,
-  t,
-} from "@intlayer/core";
-export {
-  CustomIntlayerConfig as IntlayerConfig,
-  Locales,
-} from "@intlayer/config/client";
+import { Locales } from '@intlayer/config/client';
+export { CustomIntlayerConfig as IntlayerConfig, Locales } from '@intlayer/config/client';
+import { LanguageContent, TranslationContent } from '@intlayer/core';
+export { ContentModule, ContentValue, LanguageContent, QuantityContent, enu, getEnumerationContent, getLocaleName } from '@intlayer/core';
+
+interface IConfigLocales<Content> {
+}
+type ConfigLocales = keyof IConfigLocales<unknown>;
+type ConfigLanguageContent<Content> = Record<ConfigLocales, Content>;
+type CustomizableLanguageContent<Content = string> = ConfigLocales extends never ? LanguageContent<Content> : ConfigLanguageContent<Content>;
+declare const t: <Content = string>(content?: CustomizableLanguageContent<Content>) => TranslationContent<Content>;
+declare const getTranslationContent: <Content = string>(languageContent: CustomizableLanguageContent<Content>, locale: Locales) => Content;
+
+export { type CustomizableLanguageContent, type IConfigLocales, getTranslationContent, t };

package/dist/esm/index.mjs

@@ -1,17 +1,19 @@
 import {
-  t,
-  getLocaleName,
-  enu,
-  getEnumerationContent,
-  getTranslationContent,
+  t as tCore,
+  getTranslationContent as getTranslationContentCore
 } from "@intlayer/core";
-import { Locales } from "@intlayer/config/client";
+const t = tCore;
+const getTranslationContent = getTranslationContentCore;
+import { getLocaleName, enu, getEnumerationContent } from "@intlayer/core";
+import {
+  Locales
+} from "@intlayer/config/client";
 export {
   Locales,
   enu,
   getEnumerationContent,
   getLocaleName,
   getTranslationContent,
-  t,
+  t
 };
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export type {\n  LanguageContent,\n  TranslationContent,\n  ContentValue,\n  Content,\n  FlatContentValue,\n  FlatContent,\n  ContentModule,\n} from '@intlayer/core';\nexport {\n  t,\n  getLocaleName,\n  enu,\n  getEnumerationContent,\n  getTranslationContent,\n} from '@intlayer/core';\nexport {\n  type CustomIntlayerConfig as IntlayerConfig,\n  Locales,\n} from '@intlayer/config/client';\n"],"mappings":"AASA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EAEE;AAAA,OACK;","names":[]}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import type { Locales } from '@intlayer/config/client';\nimport {\n  type TranslationContent,\n  t as tCore,\n  getTranslationContent as getTranslationContentCore,\n  type LanguageContent,\n} from '@intlayer/core';\n\n/* eslint-disable @typescript-eslint/no-unused-vars */\n/* eslint-disable @typescript-eslint/no-empty-interface */\nexport interface IConfigLocales<Content> {\n  // This interface should be augmented in the consuming app\n}\n\ntype ConfigLocales = keyof IConfigLocales<unknown>;\n\ntype ConfigLanguageContent<Content> = Record<ConfigLocales, Content>;\n\nexport type CustomizableLanguageContent<Content = string> =\n  ConfigLocales extends never\n    ? LanguageContent<Content>\n    : ConfigLanguageContent<Content>;\n\n// Re-exporting the following functions from the core package: to use module augmentation\nexport const t: <Content = string>(\n  content?: CustomizableLanguageContent<Content>\n) => TranslationContent<Content> = tCore;\nexport const getTranslationContent: <Content = string>(\n  languageContent: CustomizableLanguageContent<Content>,\n  locale: Locales\n) => Content = getTranslationContentCore;\n\nexport type {\n  LanguageContent,\n  QuantityContent,\n  ContentValue,\n  ContentModule,\n} from '@intlayer/core';\nexport { getLocaleName, enu, getEnumerationContent } from '@intlayer/core';\nexport {\n  type CustomIntlayerConfig as IntlayerConfig,\n  Locales,\n} from '@intlayer/config/client';\n"],"mappings":"AACA;AAAA,EAEE,KAAK;AAAA,EACL,yBAAyB;AAAA,OAEpB;AAkBA,MAAM,IAEsB;AAC5B,MAAM,wBAGE;AAQf,SAAS,eAAe,KAAK,6BAA6B;AAC1D;AAAA,EAEE;AAAA,OACK;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intlayer",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "private": false,
   "description": "IntLayer is a 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": [
@@ -15,7 +15,7 @@
   "homepage": "https://github.com/aypineau/intlayer",
   "repository": {
     "type": "git",
-    "url": "https://github.com/aypineau/intlayer"
+    "url": "git+https://github.com/aypineau/intlayer.git"
   },
   "license": "MIT",
   "author": {
@@ -28,6 +28,11 @@
       "require": "./dist/cjs/index.cjs",
       "import": "./dist/esm/index.mjs"
     },
+    "./augmentation": {
+      "types": "./dist/esm/augmentation.d.mts",
+      "require": "./dist/cjs/augmentation.cjs",
+      "import": "./dist/esm/augmentation.mjs"
+    },
     "./package.json": "./package.json"
   },
   "main": "src/index.ts",
@@ -46,8 +51,9 @@
   ],
   "dependencies": {
     "webpack": "^5.91.0",
-    "@intlayer/core": "^1.0.0",
-    "@intlayer/config": "^1.0.0"
+    "@intlayer/config": "^1.2.0",
+    "@intlayer/core": "^1.2.0",
+    "intlayer": "^1.2.0"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.5.0",
@@ -55,9 +61,9 @@
     "@types/node": "^20.12.7",
     "rimraf": "5.0.5",
     "tsup": "^8.0.2",
-    "typescript": "^5.3.3",
-    "@utils/eslint-config": "^1.0.0",
-    "@utils/ts-config": "^1.0.0"
+    "typescript": "^5.4.5",
+    "@utils/eslint-config": "^1.0.1",
+    "@utils/ts-config": "^1.0.1"
   },
   "engines": {
     "node": ">=14.18"

package/src/index.ts

@@ -1,19 +1,42 @@
+import type { Locales } from '@intlayer/config/client';
+import {
+  type TranslationContent,
+  t as tCore,
+  getTranslationContent as getTranslationContentCore,
+  type LanguageContent,
+} from '@intlayer/core';
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-empty-interface */
+export interface IConfigLocales<Content> {
+  // This interface should be augmented in the consuming app
+}
+
+type ConfigLocales = keyof IConfigLocales<unknown>;
+
+type ConfigLanguageContent<Content> = Record<ConfigLocales, Content>;
+
+export type CustomizableLanguageContent<Content = string> =
+  ConfigLocales extends never
+    ? LanguageContent<Content>
+    : ConfigLanguageContent<Content>;
+
+// Re-exporting the following functions from the core package: to use module augmentation
+export const t: <Content = string>(
+  content?: CustomizableLanguageContent<Content>
+) => TranslationContent<Content> = tCore;
+export const getTranslationContent: <Content = string>(
+  languageContent: CustomizableLanguageContent<Content>,
+  locale: Locales
+) => Content = getTranslationContentCore;
+
 export type {
   LanguageContent,
-  TranslationContent,
+  QuantityContent,
   ContentValue,
-  Content,
-  FlatContentValue,
-  FlatContent,
   ContentModule,
 } from '@intlayer/core';
-export {
-  t,
-  getLocaleName,
-  enu,
-  getEnumerationContent,
-  getTranslationContent,
-} from '@intlayer/core';
+export { getLocaleName, enu, getEnumerationContent } from '@intlayer/core';
 export {
   type CustomIntlayerConfig as IntlayerConfig,
   Locales,