@intlayer/config 1.2.1 → 2.0.1

package/dist/esm/types/config.d.mts

@@ -1,5 +1,6 @@
 import { Locales } from './locales.mjs';
 
+type StrictMode = 'strict' | 'required_only' | 'loose';
 /**
  * Configuration for internationalization settings
  */
@@ -12,6 +13,15 @@ type InternationalizationConfig = {
      * You can define a list of available locales to support in the application.
      */
     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
      *
@@ -75,6 +85,39 @@ type MiddlewareConfig = {
      */
     noPrefix: boolean;
 };
+/**
+ * Configuration for intlayer editor
+ */
+type EditorConfig = {
+    /**
+     * Port number for the editor server
+     *
+     * Default: 4000
+     *
+     * The port number where the editor server runs.
+     */
+    port: number;
+    /**
+     * Indicates if the editor is active
+     *
+     * Default: true;
+     *
+     * If true, the editor is active and can be accessed.
+     * If false, the editor is inactive and cannot be accessed.
+     *
+     * Usage:
+     * ```js
+     * {
+     *  // Other configurations
+     *  editor: {
+     *   enabled: process.env.NODE_ENV === 'development',
+     *  }
+     * };
+     * ```
+     *
+     */
+    enabled: boolean;
+};
 /**
  * Custom configuration that can be provided to override default settings
  */
@@ -91,6 +134,10 @@ type CustomIntlayerConfig = {
      * Custom content configuration
      */
     content?: Partial<ContentConfig>;
+    /**
+     * Custom editor configuration
+     */
+    editor?: Partial<EditorConfig>;
 };
 /**
  * Combined configuration for internationalization, middleware, and content
@@ -108,6 +155,10 @@ type IntlayerConfig = {
      * Content configuration
      */
     content: ContentConfig;
+    /**
+     * Intlayer editor configuration
+     */
+    editor: EditorConfig;
 };
 /**
  * Base configuration for content handling
@@ -318,4 +369,4 @@ type PatternsContentConfig = {
  */
 type ContentConfig = BaseContentConfig & BaseDerivedConfig & ResultDirDerivedConfig & PatternsContentConfig;
 
-export type { BaseContentConfig, BaseDerivedConfig, ContentConfig, CustomIntlayerConfig, DictionaryOutput, InternationalizationConfig, IntlayerConfig, MiddlewareConfig, PatternsContentConfig, ResultDirDerivedConfig, ServerSetCookieRule };
+export type { BaseContentConfig, BaseDerivedConfig, ContentConfig, CustomIntlayerConfig, DictionaryOutput, EditorConfig, InternationalizationConfig, IntlayerConfig, MiddlewareConfig, PatternsContentConfig, ResultDirDerivedConfig, ServerSetCookieRule, StrictMode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/config",
-  "version": "1.2.1",
+  "version": "2.0.1",
   "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": [
@@ -48,7 +48,6 @@
   },
   "files": [
     "./dist",
-    "./src",
     "./package.json"
   ],
   "dependencies": {
@@ -57,7 +56,7 @@
     "@types/node": "^20.12.7",
     "esbuild": "^0.20.2",
     "swc-loader": "^0.2.6",
-    "intlayer": "^1.2.1"
+    "intlayer": "^2.0.1"
   },
   "devDependencies": {
     "rimraf": "5.0.5",

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/client.ts

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

package/src/configFile/buildConfigurationFields.ts

@@ -1,474 +0,0 @@
-import { join } from 'path';
-import { DEFAULT_LOCALE, LOCALES } from '../defaultValues/internationalization';
-import {
-  BASE_PATH,
-  COOKIE_NAME,
-  HEADER_NAME,
-  NO_PREFIX,
-  PREFIX_DEFAULT,
-  SERVER_SET_COOKIE,
-} from '../defaultValues/middleware';
-import {
-  CONTENT_DIR_NAME,
-  DICTIONARIES_DIR_NAME,
-  FILE_EXTENSIONS,
-  RESULT_DIR_NAME,
-  EXCLUDED_PATHS,
-  TYPES_DIR_NAME,
-  MAIN_DIR_NAME,
-  MODULE_AUGMENTATION_DIR_NAME,
-  I18N_DICTIONARIES_DIR_NAME,
-  DICTIONARY_OUTPUT,
-} from '../defaultValues/server';
-import type {
-  BaseDerivedConfig,
-  ContentConfig,
-  CustomIntlayerConfig,
-  PatternsContentConfig,
-  InternationalizationConfig,
-  IntlayerConfig,
-  MiddlewareConfig,
-  BaseContentConfig,
-  ResultDirDerivedConfig,
-} from '../types/config';
-import type { GetConfigurationOptions } from './getConfiguration';
-
-let storedConfiguration: IntlayerConfig;
-
-// @TODO - Add possibility of directories configurations to be arrays to allow multiple packages management
-
-const buildInternationalizationFields = (
-  customConfiguration?: Partial<InternationalizationConfig>
-): InternationalizationConfig => ({
-  /**
-   * Locales available in the application
-   *
-   * Default: ['en']
-   *
-   */
-  locales: customConfiguration?.locales ?? LOCALES,
-
-  /**
-   * Default locale of the application for fallback
-   *
-   * Default: 'en'
-   */
-  defaultLocale: customConfiguration?.defaultLocale ?? DEFAULT_LOCALE,
-});
-
-const buildMiddlewareFields = (
-  customConfiguration?: Partial<MiddlewareConfig>
-): MiddlewareConfig => ({
-  /**
-   * Header name to get the locale
-   *
-   * Default: 'x-intlayer-locale'
-   */
-  headerName: customConfiguration?.headerName ?? HEADER_NAME,
-
-  /**
-   * Cookie name to get the locale
-   *
-   * Default: 'intlayer-locale'
-   */
-  cookieName: customConfiguration?.cookieName ?? COOKIE_NAME,
-
-  /**
-   * Prefix the default locale in the URL
-   *
-   * Default: true
-   */
-  prefixDefault: customConfiguration?.prefixDefault ?? PREFIX_DEFAULT,
-
-  /**
-   * Base path of the application URL
-   *
-   * Default: ''
-   *
-   * Example:
-   * - If the application is hosted at https://example.com/my-app
-   * - The base path is '/my-app'
-   * - The URL will be https://example.com/my-app/en
-   * - If the base path is not set, the URL will be https://example.com/en
-   */
-  basePath: customConfiguration?.basePath ?? BASE_PATH,
-
-  /**
-   * Rule to set the cookie on the server
-   * - 'always': Set the cookie on every request
-   * - 'never': Never set the cookie
-   */
-  serverSetCookie: customConfiguration?.serverSetCookie ?? SERVER_SET_COOKIE,
-
-  /**
-   * No prefix in the URL
-   * - true: No prefix in the URL
-   * - false: Prefix in the URL
-   *
-   * Example:
-   * - If the application is hosted at https://example.com/my-app
-   * - The base path is '/my-app'
-   * - The URL will be https://example.com/my-app/en
-   * - If the base path is not set, the URL will be https://example.com/en
-   * - If no prefix is set, the URL will be https://example.com/en
-   * - If the no prefix is set to true, the URL will be https://example.com
-   *
-   * Default: false
-   */
-  noPrefix: customConfiguration?.noPrefix ?? NO_PREFIX,
-});
-
-const buildContentFields = (
-  customConfiguration?: Partial<ContentConfig>
-): ContentConfig => {
-  const notDerivedContentConfig: BaseContentConfig = {
-    /**
-     * File extensions of content to look for to build the dictionaries
-     *
-     * - Default: ['.content.ts', '.content.js', '.content.cjs', '.content.mjs', '.content.json', '.content.tsx', '.content.jsx']
-     *
-     * - Example: ['.data.ts', '.data.js', '.data.json']
-     *
-     * Note:
-     * - Can exclude unused file extensions to improve performance
-     * - Avoid using common file extensions like '.ts', '.js', '.json' to avoid conflicts
-     */
-    fileExtensions: customConfiguration?.fileExtensions ?? FILE_EXTENSIONS,
-
-    /**
-     * Absolute path of the directory of the project
-     * - Default: process.cwd()
-     * - Example: '/path/to/project'
-     *
-     * Will be used to resolve all intlayer directories
-     *
-     * Note:
-     * - The base directory should be the root of the project
-     * - Can be changed to a custom directory to externalize either the content used in the project, or the intlayer application from the project
-     */
-    baseDir: customConfiguration?.baseDir ?? process.cwd(),
-
-    /**
-     * Directory name where the content is stored
-     *
-     * Default: 'src'
-     *
-     * Example:
-     *  - 'data' -> '/path/to/project/data'
-     *  - 'content' -> '/path/to/project/content'
-     *  - 'locales' -> '/path/to/project/locales'
-     *
-     * Note: If this directory is not at the base directory level, update the contentDir field instead
-     */
-    contentDirName: customConfiguration?.contentDirName ?? CONTENT_DIR_NAME,
-
-    /**
-     * Directory name where the result will be stored
-     *
-     * Default: '.intlayer'
-     *
-     * Example:
-     *  - '.next'
-     *  - 'outputOFIntlayer'
-     *
-     * Note: If this directory is not at the base directory level, update the resultDir field instead
-     */
-    resultDirName: customConfiguration?.resultDirName ?? RESULT_DIR_NAME,
-
-    /**
-     *
-     * Directory name where the module augmentation will be stored
-     *
-     * Module augmentation allow better IDE suggestions and type checking
-     *
-     * Default: 'types'
-     *
-     * Example: 'intlayer-types'
-     *
-     * Note:
-     * - If this path changed, be sure to include it from the tsconfig.json file
-     * - If this directory is not at the base directory level, update the moduleAugmentationDir field instead
-     */
-    moduleAugmentationDirName:
-      customConfiguration?.moduleAugmentationDirName ??
-      MODULE_AUGMENTATION_DIR_NAME,
-    // @TODO: Make Module Augmentation optional by adding a flag in the configuration
-
-    /**
-     * Related to the intlayer result directory
-     *
-     * Directory name where the dictionaries will be stored
-     *
-     * Default: 'dictionary'
-     *
-     * Example: 'translations'
-     *
-     * Note:
-     * - If this directory is not at the result directory level, update the dictionariesDir field instead
-     *
-     */
-    dictionariesDirName:
-      customConfiguration?.dictionariesDirName ?? DICTIONARIES_DIR_NAME,
-
-    /**
-     * Related to the intlayer result directory
-     *
-     * Directory name where the dictionaries will be stored
-     *
-     * Default: 'dictionary'
-     *
-     * Example: 'translations'
-     *
-     * Note:
-     * - If this directory is not at the result directory level, update the dictionariesDir field instead
-     *
-     */
-    i18nDictionariesDirName:
-      customConfiguration?.i18nDictionariesDirName ??
-      I18N_DICTIONARIES_DIR_NAME,
-
-    /**
-     *  Related to the intlayer result directory
-     *
-     * Directory name where the dictionaries types will be stored
-     *
-     * Default: 'types'
-     *
-     * Example: 'intlayer-types'
-     *
-     * Note:
-     * - If this directory is not at the result directory level, update the typesDir field instead
-     *
-     */
-    typeDirName: customConfiguration?.typeDirName ?? TYPES_DIR_NAME,
-
-    /**
-     * Related to the intlayer result directory
-     *
-     * Directory name where the main files will be stored
-     *
-     * Default: 'main'
-     *
-     * Example: 'intlayer-main'
-     *
-     * Note:
-     * - If this directory is not at the result directory level, update the mainDir field instead
-     */
-    mainDirName: customConfiguration?.mainDirName ?? MAIN_DIR_NAME,
-
-    /**
-     * Should exclude some directories from the content search
-     *
-     * Default: ['node_modules']
-     *
-     * Not used yet
-     * @TODO Implement the exclusion or remove it
-     */
-    excludedPath: customConfiguration?.excludedPath ?? EXCLUDED_PATHS,
-  };
-
-  const baseDirDerivedConfiguration: BaseDerivedConfig = {
-    /**
-     * Directory where the content is stored
-     *
-     * Relative to the base directory of the project
-     *
-     * Default: {{baseDir}} / {{contentDirName}}
-     *
-     * Example: '/path/to/project/src'
-     *
-     * Note:
-     * - Can be changed to a custom directory to externalize the content used in the project
-     * - If the content is not at the base directory level, update the contentDirName field instead
-     */
-    contentDir: join(
-      notDerivedContentConfig.baseDir,
-      notDerivedContentConfig.contentDirName
-    ),
-
-    /**
-     * Directory where the result will be stored
-     *
-     * Relative to the base directory of the project
-     *
-     * Default: {{baseDir}} / {{resultDirName}}
-     *
-     * Example: '/path/to/project/.intlayer'
-     *
-     * Note:
-     * - Can be changed to a custom directory to externalize the intlayer application from the project
-     * - If the result is not at the base directory level, update the resultDirName field instead
-     */
-    resultDir: join(
-      notDerivedContentConfig.baseDir,
-      notDerivedContentConfig.resultDirName
-    ),
-
-    /**
-     * Directory where the module augmentation will be stored
-     *
-     * Module augmentation allow better IDE suggestions and type checking
-     *
-     * Relative to the base directory of the project
-     *
-     * Default: {{baseDir}} / {{moduleAugmentationDirName}}
-     *
-     * Example: '/path/to/project/types'
-     *
-     * Note:
-     * - If this path changed, be sure to include it from the tsconfig.json file
-     * - If the module augmentation is not at the base directory level, update the moduleAugmentationDirName field instead
-     *
-     */
-    moduleAugmentationDir: join(
-      notDerivedContentConfig.baseDir,
-      notDerivedContentConfig.moduleAugmentationDirName
-    ),
-
-    /**
-     * Output format of the dictionary
-     *
-     * Default: ['intlayer']
-     *
-     * Note:
-     * - 'i18next' is not yet ensure a 1:1 mapping with the i18next library.
-     * - Removing 'intlayer' will break the compatibility with react-intlayer or next-intlayer
-     */
-    dictionaryOutput:
-      customConfiguration?.dictionaryOutput ?? DICTIONARY_OUTPUT,
-  };
-
-  const resultDirDerivedConfiguration: ResultDirDerivedConfig = {
-    /**
-     * Directory where the dictionaries will be stored
-     *
-     * Relative to the result directory
-     *
-     * Default: {{resultDir}} / {{dictionariesDirName}}
-     *
-     * Example: '/path/to/project/.intlayer/dictionary'
-     *
-     * Note:
-     * - If the types are not at the result directory level, update the dictionariesDirName field instead
-     * - The dictionaries are stored in JSON format
-     * - The dictionaries are used to translate the content
-     * - The dictionaries are built from the content files
-     */
-    dictionariesDir: join(
-      baseDirDerivedConfiguration.resultDir,
-      notDerivedContentConfig.dictionariesDirName
-    ),
-
-    /**
-     * Directory where the 18n dictionaries will be stored
-     *
-     * Relative to the result directory
-     *
-     * Default: {{resultDir}} / {{i18nDictionariesDirName}}
-     *
-     * Example: '/path/to/project/.intlayer/dictionary/i18n'
-     *
-     * Note:
-     * - If the types are not at the result directory level, update the i18nDictionariesDirName field instead
-     */
-    i18nDictionariesDir: join(
-      baseDirDerivedConfiguration.resultDir,
-      notDerivedContentConfig.i18nDictionariesDirName
-    ),
-
-    /**
-     * Directory where the dictionaries types will be stored
-     *
-     * Relative to the result directory
-     *
-     * Default: {{resultDir}} / {{typeDirName}}
-     *
-     * Example: '/path/to/project/.intlayer/types'
-     *
-     * Note:
-     * - If the types are not at the result directory level, update the typesDirName field instead
-     */
-    typesDir: join(
-      baseDirDerivedConfiguration.resultDir,
-      notDerivedContentConfig.typeDirName
-    ),
-
-    /**
-     * Directory where the main files will be stored
-     *
-     * Relative to the result directory
-     *
-     * Default: {{resultDir}} / {{mainDirName}}
-     *
-     * Example: '/path/to/project/.intlayer/main'
-     *
-     * Note:
-     *
-     * - If the main files are not at the result directory level, update the mainDirName field instead
-     */
-    mainDir: join(
-      baseDirDerivedConfiguration.resultDir,
-      notDerivedContentConfig.mainDirName
-    ),
-  };
-
-  const patternsConfiguration: PatternsContentConfig = {
-    /**
-     * Pattern of files to watch
-     *
-     * Default: ['/**\/*.content.ts', '/**\/*.content.js', '/**\/*.content.json', '/**\/*.content.cjs', '/**\/*.content.mjs', '/**\/*.content.tsx', '/**\/*.content.jsx']
-     */
-    watchedFilesPattern: notDerivedContentConfig.fileExtensions.map(
-      (ext) => `/**/*${ext}`
-    ),
-
-    /**
-     * Pattern of files to watch including the relative path
-     *
-     * Default: ['{{contentDir}}/**\/*.content.ts', '{{contentDir}}/**\/*.content.js', '{{contentDir}}/**\/*.content.json', '{{contentDir}}/**\/*.content.cjs', '{{contentDir}}/**\/*.content.mjs', '{{contentDir}}/**\/*.content.tsx', '{{contentDir}}/**\/*.content.jsx']
-     */
-    watchedFilesPatternWithPath: notDerivedContentConfig.fileExtensions.map(
-      (ext) => `${baseDirDerivedConfiguration.contentDir}/**/*${ext}`
-    ),
-
-    /**
-     * Pattern of dictionary to interpret
-     *
-     * Default: '{{dictionariesDir}}/**\/*.json'
-     */
-    outputFilesPatternWithPath: `${resultDirDerivedConfiguration.dictionariesDir}/**/*.json`,
-  };
-
-  return {
-    ...notDerivedContentConfig,
-    ...baseDirDerivedConfiguration,
-    ...resultDirDerivedConfiguration,
-    ...patternsConfiguration,
-  };
-};
-
-/**
- * Build the configuration fields by merging the default values with the custom configuration
- */
-export const buildConfigurationFields = (
-  options: GetConfigurationOptions,
-  customConfiguration?: CustomIntlayerConfig
-): IntlayerConfig => {
-  const internationalizationConfig = buildInternationalizationFields(
-    customConfiguration?.internationalization
-  );
-
-  const middlewareConfig = buildMiddlewareFields(
-    customConfiguration?.middleware
-  );
-
-  const contentConfig = buildContentFields(customConfiguration?.content);
-
-  storedConfiguration = {
-    internationalization: internationalizationConfig,
-    middleware: middlewareConfig,
-    content: contentConfig,
-  };
-
-  return storedConfiguration;
-};

package/src/configFile/getConfiguration.ts

@@ -1,78 +0,0 @@
-import { relative } from 'path';
-import type { CustomIntlayerConfig, IntlayerConfig } from '../types/config';
-import { buildConfigurationFields } from './buildConfigurationFields';
-import { loadConfigurationFile } from './loadConfigurationFile';
-import { searchConfigurationFile } from './searchConfigurationFile';
-
-let storedConfiguration: IntlayerConfig | undefined;
-let storedConfigurationFilePath: string | undefined;
-let storedNumCustomConfiguration: number | undefined;
-
-export type GetConfigurationOptions = {
-  baseDir: string;
-  verbose: boolean;
-};
-
-const BASE_DIR_PATH = process.env.INTLAYER_BASE_DIR_PATH ?? process.cwd();
-const defaultOptions: GetConfigurationOptions = {
-  baseDir: BASE_DIR_PATH,
-  verbose: false,
-};
-
-/**
- * Get the configuration for the intlayer by reading the configuration file (e.g. intlayer.config.js)
- */
-export const getConfiguration = (
-  options?: Partial<GetConfigurationOptions>
-): IntlayerConfig => {
-  const mergedOptions = { ...defaultOptions, ...options };
-  const { baseDir, verbose } = mergedOptions;
-
-  if (!storedConfiguration) {
-    // Search for configuration files
-    const { configurationFilePath, numCustomConfiguration } =
-      searchConfigurationFile(baseDir);
-
-    // Load the custom configuration
-    let customConfiguration: CustomIntlayerConfig | undefined;
-    if (configurationFilePath) {
-      customConfiguration = loadConfigurationFile(configurationFilePath);
-    }
-
-    // Save the configuration to avoid reading the file again
-    storedConfiguration = buildConfigurationFields(
-      mergedOptions,
-      customConfiguration
-    );
-    storedConfigurationFilePath = configurationFilePath;
-    storedNumCustomConfiguration = numCustomConfiguration;
-  }
-
-  // Log warning if multiple configuration files are found
-  if (verbose)
-    logConfigFileResult(
-      storedNumCustomConfiguration,
-      storedConfigurationFilePath
-    );
-
-  return storedConfiguration;
-};
-
-const logConfigFileResult = (
-  numCustomConfiguration?: number,
-  configurationFilePath?: string
-) => {
-  if (numCustomConfiguration === 0) {
-    console.info('Configuration file not found, using default configuration.');
-  } else {
-    const relativeOutputPath = relative(BASE_DIR_PATH, configurationFilePath!);
-
-    if (numCustomConfiguration === 1) {
-      console.info(`Configuration file found: ${relativeOutputPath}.`);
-    } else {
-      console.warn(
-        `Multiple configuration files found, using ${relativeOutputPath}.`
-      );
-    }
-  }
-};

package/src/configFile/index.ts

@@ -1,2 +0,0 @@
-export * from './getConfiguration';
-export * from './searchConfigurationFile';