@adobe/helix-config 3.13.1 → 4.0.0

package/src/schemas/sidekick.schema.json

@@ -1,112 +0,0 @@
-{
-  "$comment": "https://github.com/adobe/helix-config/blob/main/LICENSE.txt",
-  "$id": "https://ns.adobe.com/helix/config/sidekick",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "definitions": {
-    "sidekickPlugin": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string",
-          "description": "The unique plugin ID"
-        },
-        "title": {
-          "type": "string",
-          "description": "The button text"
-        },
-        "url": {
-          "type": "string",
-          "description": "The URL to open when the button is clicked"
-        },
-        "containerId": {
-          "type": "string",
-          "description": "The ID of the container to add this plugin to"
-        },
-        "environments": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "enum": ["any", "dev", "admin", "edit", "preview", "live", "prod"]
-          },
-          "description": "The environments to display this plugin in",
-          "default": "any"
-        },
-        "event": {
-          "type": "string",
-          "description": "The name of a custom event to fire when the button is clicked (defaults to id)"
-        },
-        "excludePaths": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "Exclude the plugin from these paths",
-          "examples": [
-            "/foo/**",
-            "**/:x:**"
-          ]
-        },
-        "includePaths": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "Include the plugin on these paths (overrides excludePaths)",
-          "examples": [
-            "/foo/bar/**",
-            "**.docx**"
-          ]
-        },
-        "isContainer": {
-          "type": "boolean",
-          "description": "Turns the plugin into a container for other plugins"
-        },
-        "isPalette": {
-          "type": "boolean",
-          "description": "Opens the URL in a palette instead of a new tab"
-        },
-        "paletteRect": {
-          "type": "string",
-          "description": "he dimensions and position of a palette box"
-        },
-        "titleI18n": {
-          "type": "object",
-          "description": "The button text in other supported languages",
-          "patternProperties": {
-            "^[a-z]{2}(-[A-Z]{2})?$": {
-              "type": "string",
-              "description": "ISO language code (`en` or `en-US`) with translated button text"
-            }
-          },
-          "minProperties": 1,
-          "additionalProperties": false
-        },
-        "passConfig": {
-          "type": "boolean",
-          "description": "Append ref, repo, owner, host, and project as query params on new URL button click"
-        },
-        "passReferrer": {
-          "type": "boolean",
-          "description": "Append the referrer URL as a query param on new URL button click"
-        }
-      },
-      "required": [
-        "id"
-      ],
-      "dependentRequired": {
-        "isPalette": ["url"],
-        "paletteRect": ["isPalette"]
-      }
-    }
-  },
-  "title": "Sidekick Config",
-  "type": "object",
-  "properties": {
-    "plugins": {
-      "type": "array",
-      "items": {
-        "$ref": "#/definitions/sidekickPlugin"
-      }
-    }
-  }
-}

package/src/schemas/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('./site.schema.json');

package/src/schemas/site.schema.json

@@ -1,74 +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/site",
-  "title": "Helix Site Config",
-  "type": "object",
-  "properties": {
-    "version": {
-      "type": "integer",
-      "enum": [1],
-      "default": 1
-    },
-    "name": {
-      "type": "string",
-      "description": "Site name; part of the hostname",
-      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
-    },
-    "title": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/title" },
-    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/description" },
-
-    "content": {
-      "$ref": "https://ns.adobe.com/helix/config/content"
-    },
-    "code": {
-      "$ref": "https://ns.adobe.com/helix/config/code"
-    },
-    "folders": {
-      "$ref": "https://ns.adobe.com/helix/config/folders"
-    },
-    "headers": {
-      "$ref": "https://ns.adobe.com/helix/config/headers"
-    },
-    "cdn": {
-      "$ref": "https://ns.adobe.com/helix/config/cdn"
-    },
-    "access": {
-      "$ref": "https://ns.adobe.com/helix/config/access"
-    },
-    "tokens": {
-      "$ref": "https://ns.adobe.com/helix/config/tokens"
-    },
-    "groups": {
-      "$ref": "https://ns.adobe.com/helix/config/groups"
-    },
-    "sidekick": {
-      "$ref": "https://ns.adobe.com/helix/config/sidekick"
-    },
-    "metadata": {
-      "$ref": "https://ns.adobe.com/helix/config/metadata-source"
-    },
-    "robots": {
-      "$ref": "https://ns.adobe.com/helix/config/robots"
-    },
-    "public": {
-      "$ref": "https://ns.adobe.com/helix/config/public"
-    },
-    "extends": {
-      "type": "object",
-      "properties": {
-        "profile": {
-          "type": "string",
-          "pattern": "^[0-9a-zA-Z-_]+$"
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "required": [
-    "version",
-    "content",
-    "code"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/sites.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('./sites.schema.json');

package/src/schemas/sites.schema.json

@@ -1,28 +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/sites",
-  "title": "Helix Sites List",
-  "type": "object",
-  "properties": {
-    "sites": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "name"
-        ],
-        "additionalProperties": false
-      }
-    }
-  },
-  "required": [
-    "sites"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/tokens.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('./tokens.schema.json');

package/src/schemas/tokens.schema.json

@@ -1,28 +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/tokens",
-  "title": "tokens",
-  "type": "object",
-  "patternProperties": {
-    "^[a-zA-Z0-9-_=]+$": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string",
-          "pattern": "^[a-zA-Z0-9-_=]+$"
-        },
-        "hash": {
-          "type": "string",
-          "pattern": "^[a-zA-Z0-9-_=]+$"
-        },
-        "created": {
-          "type": "string",
-          "format": "date-time"
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "additionalProperties": false
-}

package/src/schemas/user.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('./user.schema.json');

package/src/schemas/user.schema.json

@@ -1,42 +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/user",
-  "title": "user",
-  "type": "object",
-  "properties": {
-    "id": {
-      "type": "string",
-      "pattern": "^[a-zA-Z0-9-_=]+$"
-    },
-    "email": {
-      "type": "string",
-      "format": "email"
-    },
-    "name": {
-      "type": "string"
-    },
-    "roles": {
-      "type": "array",
-      "items": {
-        "type": "string",
-        "enum": [
-          "admin",
-          "author",
-          "publish",
-          "develop",
-          "basic_author",
-          "basic_publish",
-          "config",
-          "config_admin"
-        ]
-      }
-    }
-  },
-  "required": [
-    "id",
-    "email",
-    "roles"
-  ],
-  "additionalProperties": false
-}

package/src/schemas/users.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('./users.schema.json');

package/src/schemas/users.schema.json

@@ -1,10 +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/users",
-  "title": "users",
-  "type": "array",
-  "items": {
-    "$ref": "https://ns.adobe.com/helix/config/user"
-  }
-}

package/src/storage/ValidationError.js

@@ -1,95 +0,0 @@
-/*
- * Copyright 2018 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.
- */
-
-/* eslint-disable no-continue,no-param-reassign */
-
-function removeByPrefix(byPath, prefix) {
-  Object.keys(byPath).forEach((path) => {
-    if (path.startsWith(prefix)) {
-      delete byPath[path];
-    }
-  });
-}
-
-function handleContentSource(byPath, msg) {
-  if (byPath['/content/source']) {
-    const type = byPath['/content/source']?.[0]?.data?.type;
-    if (!['onedrive', 'google', 'markup'].includes(type)) {
-      msg.push('/content/source/type must be one of [onedrive, google, markup]');
-      removeByPrefix(byPath, '/content/source');
-      return;
-    }
-
-    // remove other content source errors
-    delete byPath['/content/source'];
-    delete byPath['/content/source/type'];
-  }
-}
-
-function handleCDNProd(byPath, msg) {
-  const cdnErrors = byPath['/cdn/prod'];
-  if (cdnErrors) {
-    const type = byPath['/cdn/prod']?.[0]?.data?.type;
-    if (type && !['fastly', 'cloudflare', 'akamai', 'managed', 'cloudfront'].includes(type)) {
-      msg.push('/cdn/prod/type must be one of [fastly, cloudflare, akamai, managed, cloudfront]');
-      removeByPrefix(byPath, '/cdn/prod');
-      return;
-    }
-    delete byPath['/cdn/prod/type'];
-    // if the type is specified, filter errors from other schemas
-    if (type) {
-      byPath[`/cdn/prod['${type}']`] = cdnErrors.filter(({ parentSchema }) => parentSchema?.$id?.endsWith(type));
-      delete byPath['/cdn/prod'];
-    }
-  }
-}
-
-export class ValidationError extends Error {
-  constructor(msg, errors = []) {
-    super(ValidationError.generateErrorDetail(errors));
-    this._errors = errors;
-  }
-
-  static generateErrorDetail(ajvErrors) {
-    const msg = [];
-    // group errors by instance
-    const byPath = {};
-    for (const error of ajvErrors) {
-      const id = error.instancePath || 'data';
-      if (!byPath[id]) {
-        byPath[id] = [];
-      }
-      byPath[id].push(error);
-    }
-
-    // handle special locations
-    handleContentSource(byPath, msg);
-    handleCDNProd(byPath, msg);
-
-    for (const [id, errors] of Object.entries(byPath)) {
-      // create required properties message
-      const reqErrors = errors.filter((e) => e.keyword === 'required');
-      if (reqErrors.length) {
-        msg.push(`${id} must have required properties: [${reqErrors.map((e) => e.params.missingProperty).join(', ')}]`);
-      }
-
-      // create other errors
-      const otherErrors = errors.filter((e) => e.keyword !== 'required');
-      // make unique messages
-      const uniqueErrors = new Set(otherErrors.map((e) => e.message));
-      if (uniqueErrors.size) {
-        msg.push(`${id} ${Array.from(uniqueErrors).join(', ')}`);
-      }
-    }
-    return msg.join('; ');
-  }
-}