@commercelayer/organization-config 1.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Commerce Layer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# organization-config
+
+Organization config utils for extracting config by market.
+
+## How to use
+
+```shell
+pnpm add @commercelayer/organization-config
+```
+
+you can use the function `getConfig` to manipulate the configuration settings of your organization.
+
+```javascript
+getConfig({
+  jsonConfig: {},
+  market: 'market:id:hashid',
+  params: { lang: 'en', orderId: 'your-order-id' }
+})
+
+```
+
+The function is going to manipulate the organization configuration, extract the `mfe` key and merge `default` configuration with overrides for the market used.

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use strict";var u=Object.create;var o=Object.defineProperty;var C=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var d=Object.getPrototypeOf,y=Object.prototype.hasOwnProperty;var k=(e,n)=>{for(var t in n)o(e,t,{get:n[t],enumerable:!0})},g=(e,n,t,r)=>{if(n&&typeof n=="object"||typeof n=="function")for(let i of p(n))!y.call(e,i)&&i!==t&&o(e,i,{get:()=>n[i],enumerable:!(r=C(n,i))||r.enumerable});return e};var m=(e,n,t)=>(t=e!=null?u(d(e)):{},g(n||!e||!e.__esModule?o(t,"default",{value:e,enumerable:!0}):t,e)),_=e=>g(o({},"__esModule",{value:!0}),e);var h={};k(h,{getConfig:()=>N});module.exports=_(h);var f=m(require("lodash/merge"),1);function N({jsonConfig:e,market:n,params:t}){if(e?.mfe==null)return console.warn("No configuration found."),null;let r=e?.mfe?.default,i=n!=null?e?.mfe[n]:{};function a(s){let c=JSON.stringify(s).replace(/:lang/g,t?.lang??":lang").replace(/:access_token/g,t?.accessToken??":access_token").replace(/:order_id/g,t?.orderId??":order_id");return JSON.parse(c)}let l=(0,f.default)(JSON.parse(JSON.stringify(r)),i);return a(l)}0&&(module.exports={getConfig});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import merge from 'lodash/merge'\n\nexport type NullableType<T> = T | null | undefined\n\ninterface ConfigParams {\n  /**\n   * language used to replace `:lang` placeholder\n   */\n  lang?: NullableType<string>\n  /**\n   * accessToken used to replace `:access_token` placeholder\n   */\n  accessToken?: NullableType<string>\n  /**\n   * order id used to replace `:order_id` placeholder\n   */\n  orderId?: NullableType<string>\n}\n\ninterface LinkConfig {\n  cart?: string\n  checkout?: string\n  my_account?: string\n  identity?: string\n}\n\ninterface Country {\n  value: string\n  label: string\n}\n\ntype StateConfig = Record<string, Country[]>\n\ninterface CheckoutConfig {\n  thankyou_page?: string\n  billing_countries?: Country[]\n  shipping_countries?: Country[]\n  billing_states?: StateConfig[]\n  shipping_states?: StateConfig[]\n  default_country?: string\n}\n\ninterface UrlsConfig {\n  privacy: string\n  terms: string\n}\n\nexport interface DefaultConfig {\n  links?: LinkConfig\n  checkout?: CheckoutConfig\n  urls?: UrlsConfig\n}\n\nexport interface Configs {\n  default: DefaultConfig\n  [key: string]: Partial<DefaultConfig>\n}\n\ninterface GetConfigProps {\n  /**\n   * `config` attribute of the organization\n   */\n  jsonConfig?: { mfe?: Configs }\n  /**\n   * `market:id:hashid` used to override default configuration\n   */\n  market?: string\n  /**\n   * `params` used to replace url placeholders\n   */\n  params?: ConfigParams\n}\n\n/**\n * The function is going to manipulate the organization configuration,\n * extract the `mfe` key and merge `default` configuration with overrides\n * for the market used.\n */\nexport function getConfig({\n  jsonConfig,\n  market,\n  params\n}: GetConfigProps): DefaultConfig | null {\n  if (jsonConfig?.mfe == null) {\n    console.warn('No configuration found.')\n    return null\n  }\n\n  const defaultConfig = jsonConfig?.mfe?.default\n  const overrideConfig = market != null ? jsonConfig?.mfe[market] : {}\n\n  // Replace placeholders in all string values within the object\n  function replacePlaceholders(config: DefaultConfig): DefaultConfig {\n    const replacedConfig = JSON.stringify(config)\n      .replace(/:lang/g, params?.lang ?? ':lang')\n      .replace(/:access_token/g, params?.accessToken ?? ':access_token')\n      .replace(/:order_id/g, params?.orderId ?? ':order_id')\n\n    return JSON.parse(replacedConfig)\n  }\n\n  const mergedConfig: DefaultConfig = merge(\n    JSON.parse(JSON.stringify(defaultConfig)),\n    overrideConfig\n  )\n  return replacePlaceholders(mergedConfig)\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,eAAAE,IAAA,eAAAC,EAAAH,GAAA,IAAAI,EAAkB,6BA8EX,SAASF,EAAU,CACxB,WAAAG,EACA,OAAAC,EACA,OAAAC,CACF,EAAyC,CACvC,GAAIF,GAAY,KAAO,KACrB,eAAQ,KAAK,yBAAyB,EAC/B,KAGT,IAAMG,EAAgBH,GAAY,KAAK,QACjCI,EAAiBH,GAAU,KAAOD,GAAY,IAAIC,CAAM,EAAI,CAAC,EAGnE,SAASI,EAAoBC,EAAsC,CACjE,IAAMC,EAAiB,KAAK,UAAUD,CAAM,EACzC,QAAQ,SAAUJ,GAAQ,MAAQ,OAAO,EACzC,QAAQ,iBAAkBA,GAAQ,aAAe,eAAe,EAChE,QAAQ,aAAcA,GAAQ,SAAW,WAAW,EAEvD,OAAO,KAAK,MAAMK,CAAc,CAClC,CAEA,IAAMC,KAA8B,EAAAC,SAClC,KAAK,MAAM,KAAK,UAAUN,CAAa,CAAC,EACxCC,CACF,EACA,OAAOC,EAAoBG,CAAY,CACzC","names":["src_exports","__export","getConfig","__toCommonJS","import_merge","jsonConfig","market","params","defaultConfig","overrideConfig","replacePlaceholders","config","replacedConfig","mergedConfig","merge"]}

package/dist/index.d.cts

@@ -0,0 +1,71 @@
+type NullableType<T> = T | null | undefined;
+interface ConfigParams {
+    /**
+     * language used to replace `:lang` placeholder
+     */
+    lang?: NullableType<string>;
+    /**
+     * accessToken used to replace `:access_token` placeholder
+     */
+    accessToken?: NullableType<string>;
+    /**
+     * order id used to replace `:order_id` placeholder
+     */
+    orderId?: NullableType<string>;
+}
+interface LinkConfig {
+    cart?: string;
+    checkout?: string;
+    my_account?: string;
+    identity?: string;
+}
+interface Country {
+    value: string;
+    label: string;
+}
+type StateConfig = Record<string, Country[]>;
+interface CheckoutConfig {
+    thankyou_page?: string;
+    billing_countries?: Country[];
+    shipping_countries?: Country[];
+    billing_states?: StateConfig[];
+    shipping_states?: StateConfig[];
+    default_country?: string;
+}
+interface UrlsConfig {
+    privacy: string;
+    terms: string;
+}
+interface DefaultConfig {
+    links?: LinkConfig;
+    checkout?: CheckoutConfig;
+    urls?: UrlsConfig;
+}
+interface Configs {
+    default: DefaultConfig;
+    [key: string]: Partial<DefaultConfig>;
+}
+interface GetConfigProps {
+    /**
+     * `config` attribute of the organization
+     */
+    jsonConfig?: {
+        mfe?: Configs;
+    };
+    /**
+     * `market:id:hashid` used to override default configuration
+     */
+    market?: string;
+    /**
+     * `params` used to replace url placeholders
+     */
+    params?: ConfigParams;
+}
+/**
+ * The function is going to manipulate the organization configuration,
+ * extract the `mfe` key and merge `default` configuration with overrides
+ * for the market used.
+ */
+declare function getConfig({ jsonConfig, market, params }: GetConfigProps): DefaultConfig | null;
+
+export { type Configs, type DefaultConfig, type NullableType, getConfig };

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+type NullableType<T> = T | null | undefined;
+interface ConfigParams {
+    /**
+     * language used to replace `:lang` placeholder
+     */
+    lang?: NullableType<string>;
+    /**
+     * accessToken used to replace `:access_token` placeholder
+     */
+    accessToken?: NullableType<string>;
+    /**
+     * order id used to replace `:order_id` placeholder
+     */
+    orderId?: NullableType<string>;
+}
+interface LinkConfig {
+    cart?: string;
+    checkout?: string;
+    my_account?: string;
+    identity?: string;
+}
+interface Country {
+    value: string;
+    label: string;
+}
+type StateConfig = Record<string, Country[]>;
+interface CheckoutConfig {
+    thankyou_page?: string;
+    billing_countries?: Country[];
+    shipping_countries?: Country[];
+    billing_states?: StateConfig[];
+    shipping_states?: StateConfig[];
+    default_country?: string;
+}
+interface UrlsConfig {
+    privacy: string;
+    terms: string;
+}
+interface DefaultConfig {
+    links?: LinkConfig;
+    checkout?: CheckoutConfig;
+    urls?: UrlsConfig;
+}
+interface Configs {
+    default: DefaultConfig;
+    [key: string]: Partial<DefaultConfig>;
+}
+interface GetConfigProps {
+    /**
+     * `config` attribute of the organization
+     */
+    jsonConfig?: {
+        mfe?: Configs;
+    };
+    /**
+     * `market:id:hashid` used to override default configuration
+     */
+    market?: string;
+    /**
+     * `params` used to replace url placeholders
+     */
+    params?: ConfigParams;
+}
+/**
+ * The function is going to manipulate the organization configuration,
+ * extract the `mfe` key and merge `default` configuration with overrides
+ * for the market used.
+ */
+declare function getConfig({ jsonConfig, market, params }: GetConfigProps): DefaultConfig | null;
+
+export { type Configs, type DefaultConfig, type NullableType, getConfig };

package/dist/index.js

@@ -0,0 +1,2 @@
+import l from"lodash/merge";function c({jsonConfig:e,market:t,params:n}){if(e?.mfe==null)return console.warn("No configuration found."),null;let i=e?.mfe?.default,r=t!=null?e?.mfe[t]:{};function o(f){let a=JSON.stringify(f).replace(/:lang/g,n?.lang??":lang").replace(/:access_token/g,n?.accessToken??":access_token").replace(/:order_id/g,n?.orderId??":order_id");return JSON.parse(a)}let g=l(JSON.parse(JSON.stringify(i)),r);return o(g)}export{c as getConfig};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import merge from 'lodash/merge'\n\nexport type NullableType<T> = T | null | undefined\n\ninterface ConfigParams {\n  /**\n   * language used to replace `:lang` placeholder\n   */\n  lang?: NullableType<string>\n  /**\n   * accessToken used to replace `:access_token` placeholder\n   */\n  accessToken?: NullableType<string>\n  /**\n   * order id used to replace `:order_id` placeholder\n   */\n  orderId?: NullableType<string>\n}\n\ninterface LinkConfig {\n  cart?: string\n  checkout?: string\n  my_account?: string\n  identity?: string\n}\n\ninterface Country {\n  value: string\n  label: string\n}\n\ntype StateConfig = Record<string, Country[]>\n\ninterface CheckoutConfig {\n  thankyou_page?: string\n  billing_countries?: Country[]\n  shipping_countries?: Country[]\n  billing_states?: StateConfig[]\n  shipping_states?: StateConfig[]\n  default_country?: string\n}\n\ninterface UrlsConfig {\n  privacy: string\n  terms: string\n}\n\nexport interface DefaultConfig {\n  links?: LinkConfig\n  checkout?: CheckoutConfig\n  urls?: UrlsConfig\n}\n\nexport interface Configs {\n  default: DefaultConfig\n  [key: string]: Partial<DefaultConfig>\n}\n\ninterface GetConfigProps {\n  /**\n   * `config` attribute of the organization\n   */\n  jsonConfig?: { mfe?: Configs }\n  /**\n   * `market:id:hashid` used to override default configuration\n   */\n  market?: string\n  /**\n   * `params` used to replace url placeholders\n   */\n  params?: ConfigParams\n}\n\n/**\n * The function is going to manipulate the organization configuration,\n * extract the `mfe` key and merge `default` configuration with overrides\n * for the market used.\n */\nexport function getConfig({\n  jsonConfig,\n  market,\n  params\n}: GetConfigProps): DefaultConfig | null {\n  if (jsonConfig?.mfe == null) {\n    console.warn('No configuration found.')\n    return null\n  }\n\n  const defaultConfig = jsonConfig?.mfe?.default\n  const overrideConfig = market != null ? jsonConfig?.mfe[market] : {}\n\n  // Replace placeholders in all string values within the object\n  function replacePlaceholders(config: DefaultConfig): DefaultConfig {\n    const replacedConfig = JSON.stringify(config)\n      .replace(/:lang/g, params?.lang ?? ':lang')\n      .replace(/:access_token/g, params?.accessToken ?? ':access_token')\n      .replace(/:order_id/g, params?.orderId ?? ':order_id')\n\n    return JSON.parse(replacedConfig)\n  }\n\n  const mergedConfig: DefaultConfig = merge(\n    JSON.parse(JSON.stringify(defaultConfig)),\n    overrideConfig\n  )\n  return replacePlaceholders(mergedConfig)\n}\n"],"mappings":"AAAA,OAAOA,MAAW,eA8EX,SAASC,EAAU,CACxB,WAAAC,EACA,OAAAC,EACA,OAAAC,CACF,EAAyC,CACvC,GAAIF,GAAY,KAAO,KACrB,eAAQ,KAAK,yBAAyB,EAC/B,KAGT,IAAMG,EAAgBH,GAAY,KAAK,QACjCI,EAAiBH,GAAU,KAAOD,GAAY,IAAIC,CAAM,EAAI,CAAC,EAGnE,SAASI,EAAoBC,EAAsC,CACjE,IAAMC,EAAiB,KAAK,UAAUD,CAAM,EACzC,QAAQ,SAAUJ,GAAQ,MAAQ,OAAO,EACzC,QAAQ,iBAAkBA,GAAQ,aAAe,eAAe,EAChE,QAAQ,aAAcA,GAAQ,SAAW,WAAW,EAEvD,OAAO,KAAK,MAAMK,CAAc,CAClC,CAEA,IAAMC,EAA8BV,EAClC,KAAK,MAAM,KAAK,UAAUK,CAAa,CAAC,EACxCC,CACF,EACA,OAAOC,EAAoBG,CAAY,CACzC","names":["merge","getConfig","jsonConfig","market","params","defaultConfig","overrideConfig","replacePlaceholders","config","replacedConfig","mergedConfig"]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@commercelayer/organization-config",
+  "version": "1.4.0",
+  "description": "Organization config utils for extracting config by market",
+  "author": {
+    "name": "Matteo Alessani",
+    "email": "matteo@commercelayer.io"
+  },
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "engines": {
+    "node": ">=18",
+    "pnpm": ">=7"
+  },
+  "keywords": [
+    "react",
+    "commercelayer"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/commercelayer/common-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/commercelayer/common-utils/issues"
+  },
+  "devDependencies": {
+    "@commercelayer/eslint-config-ts": "^1.4.0",
+    "@types/lodash": "^4.17.0",
+    "eslint": "^8.57.0",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.2",
+    "vitest": "^1.4.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0",
+    "typescript": ">=5.0"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21"
+  },
+  "scripts": {
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "test": "pnpm run lint && vitest run --silent",
+    "build": "tsup"
+  }
+}