@commercetools-frontend/application-config 0.0.0-CRAFT-1791-20251006162610

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) commercetools GmbH
+
+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,7 @@
+# @commercetools-frontend/application-config
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@commercetools-frontend/application-config"><img src="https://badgen.net/npm/v/@commercetools-frontend/application-config" alt="Latest release (latest dist-tag)" /></a> <a href="https://www.npmjs.com/package/@commercetools-frontend/application-config"><img src="https://badgen.net/npm/v/@commercetools-frontend/application-config/next" alt="Latest release (next dist-tag)" /></a> <a href="https://bundlephobia.com/result?p=@commercetools-frontend/application-config"><img src="https://badgen.net/bundlephobia/minzip/@commercetools-frontend/application-config" alt="Minified + GZipped size" /></a> <a href="https://github.com/commercetools/merchant-center-application-kit/blob/main/LICENSE"><img src="https://badgen.net/github/license/commercetools/merchant-center-application-kit" alt="GitHub license" /></a>
+</p>
+
+Check out the documentation for [configuring a Custom Application](https://docs.commercetools.com/merchant-center-customizations/api-reference/custom-application-config) and for [configuring a Custom View](https://docs.commercetools.com/merchant-center-customizations/api-reference/custom-view-config).

package/client.d.ts

@@ -0,0 +1,26 @@
+type CSSModuleClasses = { readonly [key: string]: string };
+
+declare module '*.mod.css' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.css' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+
+declare module '*.png' {
+  const src: string;
+  export default src;
+}
+declare module '*.react.svg' {
+  import type { FunctionComponent, SVGProps } from 'react';
+  const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
+  export default ReactComponent;
+}
+declare module '*.svg' {
+  const src: string;
+  export default src;
+}

package/custom-application.schema.json

@@ -0,0 +1,301 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://docs.commercetools.com/merchant-center-customizations/custom-application.schema.json",
+  "title": "JSON schema for Custom Application configuration files",
+  "type": "object",
+  "definitions": {
+    "cspDirective": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true
+    }
+  },
+  "properties": {
+    "name": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#name",
+      "type": "string"
+    },
+    "description": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#description",
+      "type": "string"
+    },
+    "entryPointUriPath": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#entrypointuripath",
+      "type": "string"
+    },
+    "cloudIdentifier": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#cloudidentifier",
+      "type": "string"
+    },
+    "mcApiUrl": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#mcapiurl",
+      "type": "string"
+    },
+    "oAuthScopes": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#oauthscopes",
+      "type": "object",
+      "properties": {
+        "view": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#oauthscopesview",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string",
+            "pattern": "view_(.*)"
+          },
+          "uniqueItems": true
+        },
+        "manage": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#oauthscopesmanage",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string",
+            "pattern": "manage_(.*)"
+          },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false,
+      "required": ["view", "manage"]
+    },
+    "additionalOAuthScopes": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#additionaloauthscopes",
+      "type": "array",
+      "default": [],
+      "uniqueItems": true,
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#additionaloauthscopesname",
+            "type": "string"
+          },
+          "view": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#additionaloauthscopesview",
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string",
+              "pattern": "view_(.*)"
+            },
+            "uniqueItems": true
+          },
+          "manage": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#additionaloauthscopesmanage",
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string",
+              "pattern": "manage_(.*)"
+            },
+            "uniqueItems": true
+          }
+        },
+        "additionalProperties": false,
+        "required": ["name", "view", "manage"]
+      }
+    },
+    "env": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#env",
+      "type": "object",
+      "properties": {
+        "development": {
+          "type": "object",
+          "properties": {
+            "initialProjectKey": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#envdevelopmentinitialprojectkey",
+              "type": "string"
+            },
+            "teamId": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": ["initialProjectKey"]
+        },
+        "production": {
+          "type": "object",
+          "properties": {
+            "applicationId": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#envproductionapplicationid",
+              "type": "string"
+            },
+            "url": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#envproductionurl",
+              "type": "string"
+            },
+            "cdnUrl": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#envproductioncdnurl",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": ["applicationId", "url"]
+        }
+      },
+      "additionalProperties": false,
+      "required": ["development", "production"]
+    },
+    "additionalEnv": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#additionalenv",
+      "type": "object"
+    },
+    "headers": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#headers",
+      "type": "object",
+      "properties": {
+        "csp": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#headerscsp",
+          "type": "object",
+          "properties": {
+            "connect-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "font-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "img-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "script-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "style-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "frame-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "media-src": {
+              "$ref": "#/definitions/cspDirective"
+            }
+          },
+          "additionalProperties": false,
+          "required": ["connect-src"]
+        },
+        "permissionsPolicies": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#headerspermissionspolicies",
+          "type": "object"
+        },
+        "strictTransportSecurity": {
+          "type": "array",
+          "items": {
+            "enum": ["includeSubDomains", "preload"]
+          },
+          "uniqueItems": true,
+          "deprecated": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "icon": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#icon",
+      "type": "string"
+    },
+    "mainMenuLink": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#mainmenulink",
+      "type": "object",
+      "properties": {
+        "defaultLabel": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#mainmenulinkdefaultlabel",
+          "type": "string"
+        },
+        "labelAllLocales": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#mainmenulinklabelalllocales",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "object",
+            "properties": {
+              "locale": {
+                "type": "string",
+                "enum": ["en", "de", "es", "fr-FR", "pt-BR"]
+              },
+              "value": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": false,
+            "required": ["locale", "value"]
+          }
+        },
+        "permissions": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#mainmenulinkpermissions",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": true,
+      "required": ["defaultLabel", "labelAllLocales", "permissions"]
+    },
+    "submenuLinks": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#submenulinks",
+      "default": [],
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "uriPath": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#submenulinksuripath",
+            "type": "string"
+          },
+          "defaultLabel": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#submenulinksdefaultlabel",
+            "type": "string"
+          },
+          "labelAllLocales": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#submenulinkslabelalllocales",
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "object",
+              "properties": {
+                "locale": {
+                  "type": "string",
+                  "enum": ["en", "de", "es", "fr-FR", "pt-BR"]
+                },
+                "value": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": ["locale", "value"]
+            }
+          },
+          "permissions": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-application-config#submenulinkspermissions",
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "uriPath",
+          "defaultLabel",
+          "labelAllLocales",
+          "permissions"
+        ]
+      }
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+    "name",
+    "entryPointUriPath",
+    "cloudIdentifier",
+    "env",
+    "oAuthScopes",
+    "icon",
+    "mainMenuLink",
+    "submenuLinks"
+  ]
+}

package/custom-view.schema.json

@@ -0,0 +1,248 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://docs.commercetools.com/merchant-center-customizations/custom-view.schema.json",
+  "title": "JSON schema for Custom View configuration files",
+  "type": "object",
+  "definitions": {
+    "cspDirective": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true
+    }
+  },
+  "properties": {
+    "name": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#name",
+      "type": "string"
+    },
+    "description": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#description",
+      "type": "string"
+    },
+    "cloudIdentifier": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#cloudidentifier",
+      "type": "string"
+    },
+    "mcApiUrl": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#mcapiurl",
+      "type": "string"
+    },
+    "oAuthScopes": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#oauthscopes",
+      "type": "object",
+      "properties": {
+        "view": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#oauthscopesview",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string",
+            "pattern": "view_(.*)"
+          },
+          "uniqueItems": true
+        },
+        "manage": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#oauthscopesmanage",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string",
+            "pattern": "manage_(.*)"
+          },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false,
+      "required": ["view", "manage"]
+    },
+    "additionalOAuthScopes": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#additionaloauthscopes",
+      "type": "array",
+      "default": [],
+      "uniqueItems": true,
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#additionaloauthscopesname",
+            "type": "string"
+          },
+          "view": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#additionaloauthscopesview",
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string",
+              "pattern": "view_(.*)"
+            },
+            "uniqueItems": true
+          },
+          "manage": {
+            "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#additionaloauthscopesmanage",
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string",
+              "pattern": "manage_(.*)"
+            },
+            "uniqueItems": true
+          }
+        },
+        "additionalProperties": false,
+        "required": ["name", "view", "manage"]
+      }
+    },
+    "env": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#env",
+      "type": "object",
+      "properties": {
+        "development": {
+          "type": "object",
+          "properties": {
+            "initialProjectKey": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#envdevelopmentinitialprojectkey",
+              "type": "string"
+            },
+            "teamId": {
+              "type": "string"
+            },
+            "hostUriPath": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#envdevelopmenthosturipath",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": ["initialProjectKey"]
+        },
+        "production": {
+          "type": "object",
+          "properties": {
+            "customViewId": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#envproductioncustomviewid",
+              "type": "string"
+            },
+            "url": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#envproductionurl",
+              "type": "string"
+            },
+            "cdnUrl": {
+              "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#envproductioncdnurl",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": ["customViewId", "url"]
+        }
+      },
+      "additionalProperties": false,
+      "required": ["development", "production"]
+    },
+    "additionalEnv": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#additionalenv",
+      "type": "object"
+    },
+    "headers": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#headers",
+      "type": "object",
+      "properties": {
+        "csp": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#headerscsp",
+          "type": "object",
+          "properties": {
+            "connect-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "font-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "img-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "script-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "style-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "frame-src": {
+              "$ref": "#/definitions/cspDirective"
+            },
+            "media-src": {
+              "$ref": "#/definitions/cspDirective"
+            }
+          },
+          "additionalProperties": false,
+          "required": ["connect-src"]
+        },
+        "permissionsPolicies": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#headerspermissionspolicies",
+          "type": "object"
+        },
+        "strictTransportSecurity": {
+          "type": "array",
+          "items": {
+            "enum": ["includeSubDomains", "preload"]
+          },
+          "uniqueItems": true,
+          "deprecated": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "labelAllLocales": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#labelalllocales",
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "properties": {
+          "locale": {
+            "type": "string",
+            "enum": ["en", "de", "es", "fr-FR", "pt-BR"]
+          },
+          "value": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["locale", "value"]
+      }
+    },
+    "type": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#type",
+      "type": "string",
+      "enum": ["CustomPanel"]
+    },
+    "typeSettings": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#typesettings",
+      "type": "object",
+      "properties": {
+        "size": {
+          "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#typesettingssize",
+          "type": "string",
+          "enum": ["SMALL", "LARGE"]
+        }
+      }
+    },
+    "locators": {
+      "description": "See https://docs.commercetools.com/merchant-center-customizations/tooling-and-configuration/custom-view-config#locators",
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+    "name",
+    "cloudIdentifier",
+    "env",
+    "oAuthScopes",
+    "labelAllLocales",
+    "type",
+    "locators"
+  ]
+}

package/dist/commercetools-frontend-application-config.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./declarations/src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy1mcm9udGVuZC1hcHBsaWNhdGlvbi1jb25maWcuY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuL2RlY2xhcmF0aW9ucy9zcmMvaW5kZXguZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSJ9