@intlayer/config 1.2.1 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/config",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "private": false,
   "description": "Shared configuration package for 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": [
@@ -57,7 +57,7 @@
     "@types/node": "^20.12.7",
     "esbuild": "^0.20.2",
     "swc-loader": "^0.2.6",
-    "intlayer": "^1.2.1"
+    "intlayer": "^2.0.0"
   },
   "devDependencies": {
     "rimraf": "5.0.5",

package/src/client.ts

@@ -1,10 +1,10 @@
 export type {
   CustomIntlayerConfig,
-  PatternsContentConfig as FixedIntlayerConfig,
+  PatternsContentConfig,
   IntlayerConfig,
-  BaseContentConfig as NotDerivedConfiguration,
-  BaseDerivedConfig as BaseDirDerivedConfiguration,
-  ResultDirDerivedConfig as ResultDirDerivedConfiguration,
+  BaseContentConfig,
+  BaseDerivedConfig,
+  ResultDirDerivedConfig,
 } from './types/config';
 export type { LocalesValues } from './types/locales';
 export { Locales } from './types/locales';

package/src/configFile/buildConfigurationFields.ts

@@ -1,5 +1,9 @@
 import { join } from 'path';
-import { DEFAULT_LOCALE, LOCALES } from '../defaultValues/internationalization';
+import {
+  DEFAULT_LOCALE,
+  LOCALES,
+  STRICT_MODE,
+} from '../defaultValues/internationalization';
 import {
   BASE_PATH,
   COOKIE_NAME,
@@ -30,6 +34,7 @@ import type {
   MiddlewareConfig,
   BaseContentConfig,
   ResultDirDerivedConfig,
+  EditorConfig,
 } from '../types/config';
 import type { GetConfigurationOptions } from './getConfiguration';
 
@@ -48,6 +53,16 @@ const buildInternationalizationFields = (
    */
   locales: customConfiguration?.locales ?? LOCALES,
 
+  /**
+   * Ensure strong implementations of internationalized content using typescript.
+   * - If set to "strict", the translation `t` function will require each declared locales to be defined. If one locale is missing, or if a locale is not declared in your config, it will throw an error.
+   * - If set to "required_only", the translation `t` function will require each declared locales to be defined. If one locale is missing, it will throw a warning. But will accept if a locale is not declared in your config, but exist.
+   * - If set to "loose", the translation `t` function will accept any existing locale.
+   *
+   * Default: "required_only"
+   */
+  strictMode: customConfiguration?.strictMode ?? STRICT_MODE,
+
   /**
    * Default locale of the application for fallback
    *
@@ -447,6 +462,17 @@ const buildContentFields = (
   };
 };
 
+const buildEditorFields = (
+  customConfiguration?: Partial<EditorConfig>
+): EditorConfig => ({
+  /**
+   * Port of the editor server
+   *
+   * Default: 4000
+   */
+  port: customConfiguration?.port ?? 4000,
+});
+
 /**
  * Build the configuration fields by merging the default values with the custom configuration
  */
@@ -464,10 +490,13 @@ export const buildConfigurationFields = (
 
   const contentConfig = buildContentFields(customConfiguration?.content);
 
+  const editorConfig = buildEditorFields(customConfiguration?.editor);
+
   storedConfiguration = {
     internationalization: internationalizationConfig,
     middleware: middlewareConfig,
     content: contentConfig,
+    editor: editorConfig,
   };
 
   return storedConfiguration;

package/src/defaultValues/editor.ts

@@ -0,0 +1 @@
+export const PORT = 4000;

package/src/defaultValues/internationalization.ts

@@ -1,5 +1,8 @@
+import type { StrictMode } from '../types/config';
 import { Locales } from '../types/locales';
 
 export const LOCALES: Locales[] = [Locales.ENGLISH];
 
 export const DEFAULT_LOCALE: Locales = Locales.ENGLISH;
+
+export const STRICT_MODE: StrictMode = 'required_only';

package/src/envVariables/extractEnvVariable/next.ts

@@ -2,12 +2,14 @@ import type {
   InternationalizationConfig,
   MiddlewareConfig,
   ContentConfig,
+  EditorConfig,
 } from '../../types/config';
 import type { IntlayerConfigEnvVariable, ReplaceValue } from './types';
 
 export const extractNextEnvVariable = (): IntlayerConfigEnvVariable => {
   const internationalization: ReplaceValue<InternationalizationConfig> = {
     locales: process.env.NEXT_PUBLIC_INTLAYER_LOCALES,
+    strictMode: process.env.NEXT_PUBLIC_INTLAYER_STRICT_MODE,
     defaultLocale: process.env.NEXT_PUBLIC_INTLAYER_DEFAULT_LOCALE,
   };
 
@@ -49,9 +51,14 @@ export const extractNextEnvVariable = (): IntlayerConfigEnvVariable => {
     dictionaryOutput: process.env.NEXT_PUBLIC_INTLAYER_DICTIONARY_OUTPUT,
   };
 
+  const editor: ReplaceValue<EditorConfig> = {
+    port: process.env.NEXT_PUBLIC_INTLAYER_PORT,
+  };
+
   return {
     internationalization,
     middleware,
     content,
+    editor,
   };
 };

package/src/envVariables/extractEnvVariable/react_app.ts

@@ -2,12 +2,14 @@ import type {
   InternationalizationConfig,
   MiddlewareConfig,
   ContentConfig,
+  EditorConfig,
 } from '../../types/config';
 import type { IntlayerConfigEnvVariable, ReplaceValue } from './types';
 
 export const extractReactAppEnvVariable = (): IntlayerConfigEnvVariable => {
   const internationalization: ReplaceValue<InternationalizationConfig> = {
     locales: process.env.REACT_APP_INTLAYER_LOCALES,
+    strictMode: process.env.REACT_APP_INTLAYER_STRICT_MODE,
     defaultLocale: process.env.REACT_APP_INTLAYER_DEFAULT_LOCALE,
   };
 
@@ -49,9 +51,14 @@ export const extractReactAppEnvVariable = (): IntlayerConfigEnvVariable => {
     dictionaryOutput: process.env.REACT_APP_INTLAYER_DICTIONARY_OUTPUT,
   };
 
+  const editor: ReplaceValue<EditorConfig> = {
+    port: process.env.REACT_APP_INTLAYER_PORT,
+  };
+
   return {
     internationalization,
     middleware,
     content,
+    editor,
   };
 };

package/src/envVariables/extractEnvVariable/undefined_platform.ts

@@ -2,12 +2,14 @@ import type {
   InternationalizationConfig,
   MiddlewareConfig,
   ContentConfig,
+  EditorConfig,
 } from '../../types/config';
 import type { ReplaceValue, IntlayerConfigEnvVariable } from './types';
 
 export const extractEmptyEnvVariable = (): IntlayerConfigEnvVariable => {
   const internationalization: ReplaceValue<InternationalizationConfig> = {
     locales: undefined,
+    strictMode: undefined,
     defaultLocale: undefined,
   };
 
@@ -44,9 +46,14 @@ export const extractEmptyEnvVariable = (): IntlayerConfigEnvVariable => {
     dictionaryOutput: undefined,
   };
 
+  const editor: ReplaceValue<EditorConfig> = {
+    port: undefined,
+  };
+
   return {
     internationalization,
     middleware,
     content,
+    editor,
   };
 };

package/src/envVariables/extractEnvVariable/vite.ts

@@ -2,6 +2,7 @@ import type {
   InternationalizationConfig,
   MiddlewareConfig,
   ContentConfig,
+  EditorConfig,
 } from '../../types/config';
 import type { IntlayerConfigEnvVariable, ReplaceValue } from './types';
 import { extractEmptyEnvVariable } from './undefined_platform';
@@ -16,6 +17,7 @@ export const extractViteEnvVariable = (): IntlayerConfigEnvVariable => {
 
   const internationalization: ReplaceValue<InternationalizationConfig> = {
     locales: import.meta.env.VITE_INTLAYER_LOCALES,
+    strictMode: import.meta.env.VITE_INTLAYER_STRICT_MODE,
     defaultLocale: import.meta.env.VITE_INTLAYER_DEFAULT_LOCALE,
   };
 
@@ -57,9 +59,14 @@ export const extractViteEnvVariable = (): IntlayerConfigEnvVariable => {
     dictionaryOutput: import.meta.env.VITE_INTLAYER_DICTIONARY_OUTPUT,
   };
 
+  const editor: ReplaceValue<EditorConfig> = {
+    port: import.meta.env.VITE_INTLAYER_PORT,
+  };
+
   return {
     internationalization,
     middleware,
     content,
+    editor,
   };
 };

package/src/envVariables/formatEnvVariable.ts

@@ -26,6 +26,7 @@ export const formatEnvVariable = (
     ...intlayerConfig.content,
     ...intlayerConfig.internationalization,
     ...intlayerConfig.middleware,
+    ...intlayerConfig.editor,
   })) {
     if (typeof value === 'string') {
       env[formatEnvName(key, prefix)] = value;

package/src/envVariables/getConfiguration.ts

@@ -5,6 +5,7 @@ import type {
   IntlayerConfig,
   MiddlewareConfig,
   ServerSetCookieRule,
+  StrictMode,
 } from '../types/config';
 import type { Locales } from '../types/locales';
 import { extractEnvVariable } from './extractEnvVariable/index';
@@ -20,6 +21,10 @@ export const getConfiguration = (): IntlayerConfig => {
 
   const intlayerIntlConfiguration: InternationalizationConfig = {
     locales: getEnvValue<Locales>(env.internationalization.locales, 'array')!,
+    strictMode: getEnvValue<StrictMode>(
+      env.internationalization.strictMode,
+      'string'
+    )!,
     defaultLocale: getEnvValue<Locales>(
       env?.internationalization.defaultLocale,
       'string'
@@ -89,10 +94,15 @@ export const getConfiguration = (): IntlayerConfig => {
     )!,
   };
 
+  const intlayerEditorConfiguration = {
+    port: getEnvValue(env.editor.port, 'number')!,
+  };
+
   const intlayerConfiguration: IntlayerConfig = {
     internationalization: intlayerIntlConfiguration,
     middleware: intlayerMiddlewareConfiguration,
     content: intlayerContentConfiguration,
+    editor: intlayerEditorConfiguration,
   };
 
   return intlayerConfiguration;

package/src/index.ts

@@ -10,6 +10,7 @@ export type {
   ResultDirDerivedConfig,
   PatternsContentConfig,
   ContentConfig,
+  StrictMode,
   IntlayerConfig,
 } from './types/config';
 export type { LocalesValues } from './types/locales';

package/src/types/config.ts

@@ -1,5 +1,7 @@
 import type { Locales } from './locales';
 
+export type StrictMode = 'strict' | 'required_only' | 'loose';
+
 /**
  * Configuration for internationalization settings
  */
@@ -13,6 +15,15 @@ export type InternationalizationConfig = {
    */
   locales: Locales[];
 
+  /**
+   * Ensure strong implementations of internationalized content using typescript.
+   * - If set to "strict", the translation `t` function will require each declared locales to be defined. If one locale is missing, or if a locale is not declared in your config, it will throw an error.
+   * - If set to "required_only", the translation `t` function will require each declared locales to be defined. If one locale is missing, it will throw a warning. But will accept if a locale is not declared in your config, but exist.
+   * - If set to "loose", the translation `t` function will accept any existing locale.
+   *
+   * Default: "required_only"
+   */
+  strictMode: StrictMode;
   /**
    * Default locale of the application for fallback
    *
@@ -84,6 +95,20 @@ export type MiddlewareConfig = {
   noPrefix: boolean;
 };
 
+/**
+ * Configuration for intlayer editor
+ */
+export type EditorConfig = {
+  /**
+   * Port number for the editor server
+   *
+   * Default: 4000
+   *
+   * The port number where the editor server runs.
+   */
+  port: number;
+};
+
 /**
  * Custom configuration that can be provided to override default settings
  */
@@ -102,6 +127,11 @@ export type CustomIntlayerConfig = {
    * Custom content configuration
    */
   content?: Partial<ContentConfig>;
+
+  /**
+   * Custom editor configuration
+   */
+  editor?: Partial<EditorConfig>;
 };
 
 /**
@@ -122,6 +152,11 @@ export type IntlayerConfig = {
    * Content configuration
    */
   content: ContentConfig;
+
+  /**
+   * Intlayer editor configuration
+   */
+  editor: EditorConfig;
 };
 
 /**