@intlayer/config 4.0.0 → 4.0.3

package/README.md

@@ -0,0 +1,143 @@
+<div align="center">
+  <a href="https://www.npmjs.com/package/intlayer">
+    <img src="https://raw.githubusercontent.com/aymericzip/intlayer/572ae9c9acafb74307b81530c1931a8e98990aef/docs/assets/logo.png" width="500" alt="intlayer" />
+  </a>
+</div>
+
+<div align="center">
+  <a href="https://www.npmjs.com/package/intlayer">
+    <img alt="npm" src="https://img.shields.io/npm/v/intlayer.svg?labelColor=49516F&color=8994BC" />
+  </a>
+  <a href="https://npmjs.org/package/intlayer">
+    <img alt="downloads" src="https://badgen.net/npm/dm/intlayer?labelColor=49516F&color=8994BC" />
+  </a>
+  <a href="https://npmjs.org/package/intlayer">
+    <img alt="types included" src="https://badgen.net/npm/types/intlayer?labelColor=49516F&color=8994BC" 
+  />
+  </a>
+</div>
+
+# @intlayer/config: Retrieve Intlayer configuration
+
+**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
+
+The **`@intlayer/config`** package is a NPM package that allows you to retrieve the configuration of Intlayer and define the environment variables related to the current environment.
+
+## Installation
+
+Install the necessary package using your preferred package manager:
+
+```bash packageManager="npm"
+npm install @intlayer/config
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/config
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/config
+```
+
+## Usage
+
+### Read the configuration of Intlayer using file system
+
+Example:
+
+```ts
+import { getConfiguration, type IntlayerConfig } from "@intlayer/config";
+
+const config: IntlayerConfig = getConfiguration();
+
+console.log(config);
+// Output:
+// {
+//   internationalization: { ... },
+//   middleware: { ... },
+//   content: { ... },
+//   editor: { ... }
+// }
+```
+
+> This function use `fs` packages and will only work on the server side.
+
+### Read the configuration of Intlayer using environment variables
+
+Example:
+
+```ts
+import { getConfiguration, type IntlayerConfig } from "@intlayer/config/client";
+
+const config: IntlayerConfig = getConfiguration({
+  env: "production",
+});
+
+console.log(config);
+// Output:
+// {
+//   internationalization: { ... },
+//   middleware: { ... },
+//   content: { ... },
+//   editor: { ... }
+// }
+```
+
+> This function will not return anything if the environment variables are not defined.
+
+### Define the environment variables
+
+1. Create a configuration file.
+
+```ts fileName="intlayer.config.ts"
+import { type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    /* ... */
+  },
+  middleware: {
+    /* ... */
+  },
+  content: {
+    /* ... */
+  },
+  editor: {
+    /* ... */
+  },
+};
+
+export default config;
+```
+
+> See [Intlayer configuration documentation](https://github.com/aymericzip/intlayer/blob/main/docs/en/configuration.md) for more details.
+
+2. Define the environment variables.
+
+```ts
+import { getConfiguration } from "@intlayer/config";
+
+const intlayerConfig = getConfiguration();
+
+// Format all configuration values as environment variables
+const env = formatEnvVariable();
+
+// Set each formatted environment variable in process.env
+Object.assign(process.env, env);
+```
+
+3. Import the configuration file.
+
+```ts
+import { getConfiguration } from "@intlayer/config/client";
+
+const intlayerConfig = getConfiguration();
+```
+
+## Read about Intlayer
+
+- [Intlayer Website](https://intlayer.org)
+- [Intlayer Documentation](https://intlayer.org/docs)
+- [Intlayer GitHub](https://github.com/aymericzip/intlayer)
+
+- [Ask your questions to our smart documentation](https://intlayer.org/docs/chat)

package/dist/cjs/envVariables/formatEnvVariable.cjs

@@ -23,6 +23,7 @@ __export(formatEnvVariable_exports, {
 module.exports = __toCommonJS(formatEnvVariable_exports);
 var import_getConfiguration = require('../configFile/getConfiguration.cjs');
 var import_detectPlatform = require('./detectPlatform.cjs');
+var import_removeUndefinedValueObject = require('./removeUndefinedValueObject.cjs');
 const formatEnvName = (key, prefix) => prefix + key.replace(/([a-z0-9])([A-Z])/g, "$1_$2").toUpperCase();
 const formatEnvVariable = (platform) => {
   const intlayerConfig = (0, import_getConfiguration.getConfiguration)();
@@ -40,7 +41,7 @@ const formatEnvVariable = (platform) => {
       env[formatEnvName(key, prefix)] = JSON.stringify(value);
     }
   }
-  return env;
+  return (0, import_removeUndefinedValueObject.removeUndefinedValueObject)(env);
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/envVariables/formatEnvVariable.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/envVariables/formatEnvVariable.ts"],"sourcesContent":["import { getConfiguration } from '../configFile/getConfiguration';\nimport { getPrefix, type Platform } from './detectPlatform';\n\n/**\n * Format a key to corresponding environment variable name\n *\n * Example:\n *  toEnvVariable('mainDir') => 'INTLAYER_MAIN_DIR'\n */\nconst formatEnvName = (key: string, prefix: string): string =>\n  prefix + key.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toUpperCase();\n\n/**\n * Format all configuration values as environment variables\n */\nexport const formatEnvVariable = (\n  platform: Platform\n): Record<string, string> => {\n  const intlayerConfig = getConfiguration();\n\n  const prefix = getPrefix(platform);\n\n  // Set all configuration values as environment variables\n  const env: Record<string, string> = {};\n  for (const [key, value] of Object.entries({\n    ...intlayerConfig.content,\n    ...intlayerConfig.internationalization,\n    ...intlayerConfig.middleware,\n    ...intlayerConfig.editor,\n  })) {\n    if (typeof value === 'string') {\n      env[formatEnvName(key, prefix)] = value;\n    } else {\n      env[formatEnvName(key, prefix)] = JSON.stringify(value);\n    }\n  }\n\n  return env;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8BAAiC;AACjC,4BAAyC;AAQzC,MAAM,gBAAgB,CAAC,KAAa,WAClC,SAAS,IAAI,QAAQ,sBAAsB,OAAO,EAAE,YAAY;AAK3D,MAAM,oBAAoB,CAC/B,aAC2B;AAC3B,QAAM,qBAAiB,0CAAiB;AAExC,QAAM,aAAS,iCAAU,QAAQ;AAGjC,QAAM,MAA8B,CAAC;AACrC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ;AAAA,IACxC,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,EACpB,CAAC,GAAG;AACF,QAAI,OAAO,UAAU,UAAU;AAC7B,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI;AAAA,IACpC,OAAO;AACL,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI,KAAK,UAAU,KAAK;AAAA,IACxD;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../../src/envVariables/formatEnvVariable.ts"],"sourcesContent":["import { getConfiguration } from '../configFile/getConfiguration';\nimport { getPrefix, type Platform } from './detectPlatform';\nimport { removeUndefinedValueObject } from './removeUndefinedValueObject';\n\n/**\n * Format a key to corresponding environment variable name\n *\n * Example:\n *  toEnvVariable('mainDir') => 'INTLAYER_MAIN_DIR'\n */\nconst formatEnvName = (key: string, prefix: string): string =>\n  prefix + key.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toUpperCase();\n\n/**\n * Format all configuration values as environment variables\n */\nexport const formatEnvVariable = (\n  platform: Platform\n): Record<string, string> => {\n  const intlayerConfig = getConfiguration();\n\n  const prefix = getPrefix(platform);\n\n  // Set all configuration values as environment variables\n  const env: Record<string, string> = {};\n  for (const [key, value] of Object.entries({\n    ...intlayerConfig.content,\n    ...intlayerConfig.internationalization,\n    ...intlayerConfig.middleware,\n    ...intlayerConfig.editor,\n  })) {\n    if (typeof value === 'string') {\n      env[formatEnvName(key, prefix)] = value;\n    } else {\n      env[formatEnvName(key, prefix)] = JSON.stringify(value);\n    }\n  }\n\n  return removeUndefinedValueObject(env);\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8BAAiC;AACjC,4BAAyC;AACzC,wCAA2C;AAQ3C,MAAM,gBAAgB,CAAC,KAAa,WAClC,SAAS,IAAI,QAAQ,sBAAsB,OAAO,EAAE,YAAY;AAK3D,MAAM,oBAAoB,CAC/B,aAC2B;AAC3B,QAAM,qBAAiB,0CAAiB;AAExC,QAAM,aAAS,iCAAU,QAAQ;AAGjC,QAAM,MAA8B,CAAC;AACrC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ;AAAA,IACxC,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,EACpB,CAAC,GAAG;AACF,QAAI,OAAO,UAAU,UAAU;AAC7B,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI;AAAA,IACpC,OAAO;AACL,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI,KAAK,UAAU,KAAK;AAAA,IACxD;AAAA,EACF;AAEA,aAAO,8DAA2B,GAAG;AACvC;","names":[]}

package/dist/cjs/envVariables/removeUndefinedValueObject.cjs

@@ -0,0 +1,38 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  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 });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var removeUndefinedValueObject_exports = {};
+__export(removeUndefinedValueObject_exports, {
+  removeUndefinedValueObject: () => removeUndefinedValueObject
+});
+module.exports = __toCommonJS(removeUndefinedValueObject_exports);
+const removeUndefinedValueObject = (obj) => {
+  const newObj = {};
+  for (const key in obj) {
+    if (obj[key] !== void 0) {
+      newObj[key] = obj[key];
+    }
+  }
+  Object.freeze(newObj);
+  return newObj;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  removeUndefinedValueObject
+});
+//# sourceMappingURL=removeUndefinedValueObject.cjs.map

package/dist/cjs/envVariables/removeUndefinedValueObject.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/envVariables/removeUndefinedValueObject.ts"],"sourcesContent":["export const removeUndefinedValueObject = <T extends Record<string, unknown>>(\n  obj: T\n): T => {\n  const newObj: T = {} as T;\n\n  for (const key in obj) {\n    if (obj[key] !== undefined) {\n      newObj[key] = obj[key];\n    }\n  }\n\n  Object.freeze(newObj);\n\n  return newObj;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,MAAM,6BAA6B,CACxC,QACM;AACN,QAAM,SAAY,CAAC;AAEnB,aAAW,OAAO,KAAK;AACrB,QAAI,IAAI,GAAG,MAAM,QAAW;AAC1B,aAAO,GAAG,IAAI,IAAI,GAAG;AAAA,IACvB;AAAA,EACF;AAEA,SAAO,OAAO,MAAM;AAEpB,SAAO;AACT;","names":[]}

package/dist/esm/envVariables/formatEnvVariable.mjs

@@ -1,5 +1,6 @@
 import { getConfiguration } from '../configFile/getConfiguration.mjs';
 import { getPrefix } from './detectPlatform.mjs';
+import { removeUndefinedValueObject } from './removeUndefinedValueObject.mjs';
 const formatEnvName = (key, prefix) => prefix + key.replace(/([a-z0-9])([A-Z])/g, "$1_$2").toUpperCase();
 const formatEnvVariable = (platform) => {
   const intlayerConfig = getConfiguration();
@@ -17,7 +18,7 @@ const formatEnvVariable = (platform) => {
       env[formatEnvName(key, prefix)] = JSON.stringify(value);
     }
   }
-  return env;
+  return removeUndefinedValueObject(env);
 };
 export {
   formatEnvVariable

package/dist/esm/envVariables/formatEnvVariable.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/envVariables/formatEnvVariable.ts"],"sourcesContent":["import { getConfiguration } from '../configFile/getConfiguration';\nimport { getPrefix, type Platform } from './detectPlatform';\n\n/**\n * Format a key to corresponding environment variable name\n *\n * Example:\n *  toEnvVariable('mainDir') => 'INTLAYER_MAIN_DIR'\n */\nconst formatEnvName = (key: string, prefix: string): string =>\n  prefix + key.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toUpperCase();\n\n/**\n * Format all configuration values as environment variables\n */\nexport const formatEnvVariable = (\n  platform: Platform\n): Record<string, string> => {\n  const intlayerConfig = getConfiguration();\n\n  const prefix = getPrefix(platform);\n\n  // Set all configuration values as environment variables\n  const env: Record<string, string> = {};\n  for (const [key, value] of Object.entries({\n    ...intlayerConfig.content,\n    ...intlayerConfig.internationalization,\n    ...intlayerConfig.middleware,\n    ...intlayerConfig.editor,\n  })) {\n    if (typeof value === 'string') {\n      env[formatEnvName(key, prefix)] = value;\n    } else {\n      env[formatEnvName(key, prefix)] = JSON.stringify(value);\n    }\n  }\n\n  return env;\n};\n"],"mappings":"AAAA,SAAS,wBAAwB;AACjC,SAAS,iBAAgC;AAQzC,MAAM,gBAAgB,CAAC,KAAa,WAClC,SAAS,IAAI,QAAQ,sBAAsB,OAAO,EAAE,YAAY;AAK3D,MAAM,oBAAoB,CAC/B,aAC2B;AAC3B,QAAM,iBAAiB,iBAAiB;AAExC,QAAM,SAAS,UAAU,QAAQ;AAGjC,QAAM,MAA8B,CAAC;AACrC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ;AAAA,IACxC,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,EACpB,CAAC,GAAG;AACF,QAAI,OAAO,UAAU,UAAU;AAC7B,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI;AAAA,IACpC,OAAO;AACL,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI,KAAK,UAAU,KAAK;AAAA,IACxD;AAAA,EACF;AAEA,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../../src/envVariables/formatEnvVariable.ts"],"sourcesContent":["import { getConfiguration } from '../configFile/getConfiguration';\nimport { getPrefix, type Platform } from './detectPlatform';\nimport { removeUndefinedValueObject } from './removeUndefinedValueObject';\n\n/**\n * Format a key to corresponding environment variable name\n *\n * Example:\n *  toEnvVariable('mainDir') => 'INTLAYER_MAIN_DIR'\n */\nconst formatEnvName = (key: string, prefix: string): string =>\n  prefix + key.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toUpperCase();\n\n/**\n * Format all configuration values as environment variables\n */\nexport const formatEnvVariable = (\n  platform: Platform\n): Record<string, string> => {\n  const intlayerConfig = getConfiguration();\n\n  const prefix = getPrefix(platform);\n\n  // Set all configuration values as environment variables\n  const env: Record<string, string> = {};\n  for (const [key, value] of Object.entries({\n    ...intlayerConfig.content,\n    ...intlayerConfig.internationalization,\n    ...intlayerConfig.middleware,\n    ...intlayerConfig.editor,\n  })) {\n    if (typeof value === 'string') {\n      env[formatEnvName(key, prefix)] = value;\n    } else {\n      env[formatEnvName(key, prefix)] = JSON.stringify(value);\n    }\n  }\n\n  return removeUndefinedValueObject(env);\n};\n"],"mappings":"AAAA,SAAS,wBAAwB;AACjC,SAAS,iBAAgC;AACzC,SAAS,kCAAkC;AAQ3C,MAAM,gBAAgB,CAAC,KAAa,WAClC,SAAS,IAAI,QAAQ,sBAAsB,OAAO,EAAE,YAAY;AAK3D,MAAM,oBAAoB,CAC/B,aAC2B;AAC3B,QAAM,iBAAiB,iBAAiB;AAExC,QAAM,SAAS,UAAU,QAAQ;AAGjC,QAAM,MAA8B,CAAC;AACrC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ;AAAA,IACxC,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,IAClB,GAAG,eAAe;AAAA,EACpB,CAAC,GAAG;AACF,QAAI,OAAO,UAAU,UAAU;AAC7B,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI;AAAA,IACpC,OAAO;AACL,UAAI,cAAc,KAAK,MAAM,CAAC,IAAI,KAAK,UAAU,KAAK;AAAA,IACxD;AAAA,EACF;AAEA,SAAO,2BAA2B,GAAG;AACvC;","names":[]}

package/dist/esm/envVariables/removeUndefinedValueObject.mjs

@@ -0,0 +1,14 @@
+const removeUndefinedValueObject = (obj) => {
+  const newObj = {};
+  for (const key in obj) {
+    if (obj[key] !== void 0) {
+      newObj[key] = obj[key];
+    }
+  }
+  Object.freeze(newObj);
+  return newObj;
+};
+export {
+  removeUndefinedValueObject
+};
+//# sourceMappingURL=removeUndefinedValueObject.mjs.map

package/dist/esm/envVariables/removeUndefinedValueObject.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/envVariables/removeUndefinedValueObject.ts"],"sourcesContent":["export const removeUndefinedValueObject = <T extends Record<string, unknown>>(\n  obj: T\n): T => {\n  const newObj: T = {} as T;\n\n  for (const key in obj) {\n    if (obj[key] !== undefined) {\n      newObj[key] = obj[key];\n    }\n  }\n\n  Object.freeze(newObj);\n\n  return newObj;\n};\n"],"mappings":"AAAO,MAAM,6BAA6B,CACxC,QACM;AACN,QAAM,SAAY,CAAC;AAEnB,aAAW,OAAO,KAAK;AACrB,QAAI,IAAI,GAAG,MAAM,QAAW;AAC1B,aAAO,GAAG,IAAI,IAAI,GAAG;AAAA,IACvB;AAAA,EACF;AAEA,SAAO,OAAO,MAAM;AAEpB,SAAO;AACT;","names":[]}

package/dist/types/envVariables/formatEnvVariable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatEnvVariable.d.ts","sourceRoot":"","sources":["../../../src/envVariables/formatEnvVariable.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAW5D;;GAEG;AACH,eAAO,MAAM,iBAAiB,aAClB,QAAQ,KACjB,MAAM,CAAC,MAAM,EAAE,MAAM,CAqBvB,CAAC"}
+{"version":3,"file":"formatEnvVariable.d.ts","sourceRoot":"","sources":["../../../src/envVariables/formatEnvVariable.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAY5D;;GAEG;AACH,eAAO,MAAM,iBAAiB,aAClB,QAAQ,KACjB,MAAM,CAAC,MAAM,EAAE,MAAM,CAqBvB,CAAC"}

package/dist/types/envVariables/removeUndefinedValueObject.d.ts

@@ -0,0 +1,2 @@
+export declare const removeUndefinedValueObject: <T extends Record<string, unknown>>(obj: T) => T;
+//# sourceMappingURL=removeUndefinedValueObject.d.ts.map

package/dist/types/envVariables/removeUndefinedValueObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeUndefinedValueObject.d.ts","sourceRoot":"","sources":["../../../src/envVariables/removeUndefinedValueObject.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,0BAA0B,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OACrE,CAAC,KACL,CAYF,CAAC"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@intlayer/config",
-  "version": "4.0.0",
+  "version": "4.0.3",
   "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.",
+  "description": "Retrieve Intlayer configurations and manage environment variables for both server-side and client-side environments.",
   "keywords": [
     "intlayer",
     "layer",
@@ -77,14 +77,14 @@
     "tsc-alias": "^1.8.10",
     "tsup": "^8.3.5",
     "typescript": "^5.7.3",
-    "@utils/eslint-config": "1.0.4",
     "@utils/ts-config": "1.0.4",
-    "@utils/tsup-config": "1.0.4",
-    "@utils/ts-config-types": "1.0.4"
+    "@utils/ts-config-types": "1.0.4",
+    "@utils/eslint-config": "1.0.4",
+    "@utils/tsup-config": "1.0.4"
   },
   "peerDependencies": {
     "react": ">=16.0.0",
-    "intlayer": "4.0.0"
+    "intlayer": "4.0.3"
   },
   "engines": {
     "node": ">=14.18"