@adobe/helix-config 3.13.2 → 4.0.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [4.0.0](https://github.com/adobe/helix-config/compare/v3.13.2...v4.0.0) (2024-08-15)
+
+
+### Features
+
+* (re)move storage parts to helix-config-storage ([#165](https://github.com/adobe/helix-config/issues/165)) ([59732ed](https://github.com/adobe/helix-config/commit/59732edea8372641fcecb79684dab049ac956f69))
+
+
+### BREAKING CHANGES
+
+* the /storage package was moved to helix-config-storage
+
 ## [3.13.2](https://github.com/adobe/helix-config/compare/v3.13.1...v3.13.2) (2024-08-15)
 
 

package/package.json

@@ -1,18 +1,16 @@
 {
   "name": "@adobe/helix-config",
-  "version": "3.13.2",
+  "version": "4.0.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "exports": {
-    ".": "./src/index.js",
-    "./storage": "./src/storage/index.js"
+    ".": "./src/index.js"
   },
   "type": "module",
   "scripts": {
     "test": "c8 mocha --spec 'test/**/*.test.js'",
-    "lint": "eslint . && ./validate-json-schemas.sh",
-    "docs:types": "node ./test/dev/generate-types.js",
+    "lint": "eslint .",
     "semantic-release": "semantic-release",
     "semantic-release-dry": "semantic-release --dry-run --branches $CI_BRANCH",
     "prepare": "husky"
@@ -41,19 +39,16 @@
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "12.0.1",
-    "ajv-cli": "5.0.0",
     "c8": "10.1.2",
     "eslint": "8.57.0",
     "husky": "9.1.4",
-    "json-schema-to-typescript": "15.0.0",
     "junit-report-builder": "5.0.0",
     "lint-staged": "15.2.8",
     "mocha": "10.7.3",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "nock": "13.5.4",
-    "semantic-release": "24.0.0",
-    "xml2js": "0.6.2"
+    "semantic-release": "24.0.0"
   },
   "lint-staged": {
     "*.js": "eslint",
@@ -62,11 +57,6 @@
   "dependencies": {
     "@adobe/fetch": "4.1.8",
     "@adobe/helix-shared-config": "10.6.5",
-    "@adobe/helix-shared-git": "3.0.13",
-    "@adobe/helix-shared-storage": "1.0.5",
-    "@adobe/helix-shared-utils": "3.0.2",
-    "ajv": "8.17.1",
-    "ajv-formats": "3.0.1",
-    "jose": "5.6.3"
+    "@adobe/helix-shared-utils": "3.0.2"
   }
 }

package/src/utils.js

@@ -39,39 +39,3 @@ export function deepGetOrCreate(obj, path, create = false) {
   }
   return o;
 }
-
-/**
- * Sets the property addressed by the given path in the object.
- * @param {object} obj the object to search
- * @param {string|string[]} path the path or path segments
- * @param {*} value the value to set on the object
- * @returns {object} the passed in `obj`
- */
-export function deepPut(obj, path, value) {
-  const parts = Array.isArray(path) ? path : path.split('/');
-  const last = parts.pop();
-  const parent = parts.reduce((o, prop) => {
-    if (!(prop in o)) {
-      // eslint-disable-next-line no-param-reassign
-      o[prop] = {};
-    }
-    return o[prop];
-  }, obj);
-
-  if (Array.isArray(parent)) {
-    // todo: better support for non id keys
-    const idx = parent.findIndex((e) => e.id === last);
-    if (idx >= 0 && value === null) {
-      parent.splice(idx, 1);
-    } else if (idx >= 0) {
-      parent[idx] = value;
-    } else if (value !== null) {
-      parent.push(value);
-    }
-  } else if (value === null) {
-    delete parent[last];
-  } else {
-    parent[last] = value;
-  }
-  return obj;
-}

package/src/schemas/access-admin.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./access-admin.schema.json');

package/src/schemas/access-admin.schema.json

@@ -1,57 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/access/admin",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "Admin Access Config",
-  "type": "object",
-  "properties": {
-    "role": {
-      "title": "Role",
-      "type": "object",
-      "patternProperties": {
-        "^[a-z-_]+$": {
-          "description": "The email glob of the users or a group reference for the respective role.",
-          "type": "array",
-          "items": {"type": "string"}
-        }
-      },
-      "additionalProperties": false
-    },
-    "requireAuth": {
-      "description": "Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'.",
-      "default": "auto",
-      "oneOf": [
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "string",
-          "enum": ["auto"]
-        }
-      ]
-    },
-    "defaultRole": {
-      "description": "the default roles assigned to the users. defaults to `basic_publish` for unauthenticated setups.",
-      "type": "array",
-      "items": {
-        "type": "string",
-        "enum": [
-          "admin",
-          "author",
-          "publish",
-          "develop",
-          "basic_author",
-          "basic_publish",
-          "config",
-          "config_admin"
-        ]
-      }
-    },
-    "apiKeyId": {
-      "description": "the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.",
-      "type": "array",
-      "items": {"type": "string"}
-    }
-  },
-  "additionalProperties": false
-}

package/src/schemas/access-site.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./access-site.schema.json');

package/src/schemas/access-site.schema.json

@@ -1,24 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/access/site",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "Site Access Config",
-  "type": "object",
-  "properties": {
-    "apiKeyId": {
-      "description": "IDs of the api keys (tokens) that are allowed.",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "clientCertDN": {
-      "description": "the DNs of the client certificates that are allowed.",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    }
-  },
-  "additionalProperties": false
-}

package/src/schemas/access.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./access.schema.json');

package/src/schemas/access.schema.json

@@ -1,22 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "$id": "https://ns.adobe.com/helix/config/access",
-  "type": "object",
-  "title": "Access",
-  "properties": {
-    "admin": {
-      "$ref": "https://ns.adobe.com/helix/config/access/admin"
-    },
-    "site": {
-      "$ref": "https://ns.adobe.com/helix/config/access/site"
-    },
-    "preview": {
-      "$ref": "https://ns.adobe.com/helix/config/access/site"
-    },
-    "live": {
-      "$ref": "https://ns.adobe.com/helix/config/access/site"
-    }
-  },
-  "additionalProperties": false
-}

package/src/schemas/cdn-prod-akamai.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./cdn-prod-akamai.schema.json');

package/src/schemas/cdn-prod-akamai.schema.json

@@ -1,45 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/cdn/prod/akamai",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "Akamai CDN Config",
-  "type": "object",
-  "properties": {
-    "type": {
-      "type": "string",
-      "const": "akamai"
-    },
-    "host": {
-      "description": "production host",
-      "type": "string"
-    },
-    "route": {
-      "description": "Routes on the CDN that are rendered with Franklin",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "endpoint": {
-      "type": "string"
-    },
-    "clientSecret": {
-      "type": "string"
-    },
-    "clientToken": {
-      "type": "string"
-    },
-    "accessToken": {
-      "type": "string"
-    }
-  },
-  "required": [
-    "type",
-    "host",
-    "endpoint",
-    "clientSecret",
-    "clientToken",
-    "accessToken"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/cdn-prod-cloudflare.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./cdn-prod-cloudflare.schema.json');

package/src/schemas/cdn-prod-cloudflare.schema.json

@@ -1,41 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/cdn/prod/cloudflare",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "Cloudflare CDN Config",
-  "type": "object",
-  "properties": {
-    "type": {
-      "type": "string",
-      "const": "cloudflare"
-    },
-    "host": {
-      "description": "production host",
-      "type": "string"
-    },
-    "route": {
-      "description": "Routes on the CDN that are rendered with Franklin",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "plan": {
-      "type": "string"
-    },
-    "zoneId": {
-      "type": "string"
-    },
-    "apiToken": {
-      "type": "string"
-    }
-  },
-  "required": [
-    "type",
-    "host",
-    "plan",
-    "zoneId",
-    "apiToken"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/cdn-prod-cloudfront.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./cdn-prod-cloudfront.schema.json');

package/src/schemas/cdn-prod-cloudfront.schema.json

@@ -1,41 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/cdn/prod/cloudfront",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "Cloudfront CDN Config",
-  "type": "object",
-  "properties": {
-    "type": {
-      "type": "string",
-      "const": "cloudfront"
-    },
-    "host": {
-      "description": "production host",
-      "type": "string"
-    },
-    "route": {
-      "description": "Routes on the CDN that are rendered with Franklin",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "distributionId": {
-      "type": "string"
-    },
-    "accessKeyId": {
-      "type": "string"
-    },
-    "secretAccessKey": {
-      "type": "string"
-    }
-  },
-  "required": [
-    "type",
-    "host",
-    "distributionId",
-    "accessKeyId",
-    "secretAccessKey"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/cdn-prod-fastly.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./cdn-prod-fastly.schema.json');

package/src/schemas/cdn-prod-fastly.schema.json

@@ -1,40 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/cdn/prod/fastly",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "Fastly CDN Config",
-  "type": "object",
-  "description": "Production CDN configuration for Fastly",
-  "properties": {
-    "type": {
-      "type": "string",
-      "const": "fastly"
-    },
-    "host": {
-      "description": "production host",
-      "type": "string"
-    },
-    "route": {
-      "description": "Routes on the CDN that are rendered with Franklin",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "serviceId": {
-      "description": "The Fastly Service ID",
-      "type": "string"
-    },
-    "authToken": {
-      "description": "A Fastly token for purging",
-      "type": "string"
-    }
-  },
-  "required": [
-    "type",
-    "host",
-    "serviceId",
-    "authToken"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/cdn-prod-managed.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./cdn-prod-managed.schema.json');

package/src/schemas/cdn-prod-managed.schema.json

@@ -1,29 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/cdn/prod/managed",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "Managed CDN Config",
-  "type": "object",
-  "properties": {
-    "type": {
-      "type": "string",
-      "const": "managed"
-    },
-    "host": {
-      "description": "production host",
-      "type": "string"
-    },
-    "route": {
-      "description": "Routes on the CDN that are rendered with Franklin",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    }
-  },
-  "required": [
-    "type",
-    "host"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/cdn.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./cdn.schema.json');

package/src/schemas/cdn.schema.json

@@ -1,75 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/cdn",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "CDN Config",
-  "type": "object",
-  "properties": {
-    "prod": {
-      "oneOf": [
-        {
-          "$ref": "https://ns.adobe.com/helix/config/cdn/prod/fastly"
-        },
-        {
-          "$ref": "https://ns.adobe.com/helix/config/cdn/prod/cloudflare"
-        },
-        {
-          "$ref": "https://ns.adobe.com/helix/config/cdn/prod/akamai"
-        },
-        {
-          "$ref": "https://ns.adobe.com/helix/config/cdn/prod/managed"
-        },
-        {
-          "$ref": "https://ns.adobe.com/helix/config/cdn/prod/cloudfront"
-        },
-        {
-          "type": "object",
-          "title": "EmptyConfig",
-          "properties": {
-            "host": {
-              "description": "production host",
-              "type": "string"
-            }
-          },
-          "required": [
-            "host"
-          ],
-          "additionalProperties": false
-        }
-      ]
-    },
-    "live": {
-      "type": "object",
-      "properties": {
-        "host": {
-          "description": "Sidekick config to override the default preview host. it supports parameters $owner and $repo",
-          "examples": [
-            "main--$repo--page.example.com"
-          ],
-          "type": "string"
-        }
-      },
-      "required": [
-        "host"
-      ],
-      "additionalProperties": false
-    },
-    "preview": {
-      "type": "object",
-      "properties": {
-        "host": {
-          "description": "Sidekick config to override the default live host. it supports parameters $owner and $repo",
-          "examples": [
-            "main--$repo--live.example.com\""
-          ],
-          "type": "string"
-        }
-      },
-      "required": [
-        "host"
-      ],
-      "additionalProperties": false
-    }
-  },
-  "additionalProperties": false
-}

package/src/schemas/code.schema.cjs

@@ -1,12 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-module.exports = require('./code.schema.json');