@adobe/helix-config 2.5.5 → 2.6.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.6.0](https://github.com/adobe/helix-config/compare/v2.5.5...v2.6.0) (2024-04-23)
+
+
+### Features
+
+* validate config ([e7011df](https://github.com/adobe/helix-config/commit/e7011dfda45a13bc847e1df304a53c93c93434fb))
+
 ## [2.5.5](https://github.com/adobe/helix-config/compare/v2.5.4...v2.5.5) (2024-04-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "2.5.5",
+  "version": "2.6.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -44,7 +44,7 @@
     "c8": "9.1.0",
     "eslint": "8.57.0",
     "husky": "9.0.11",
-    "json-schema-to-typescript": "13.1.2",
+    "json-schema-to-typescript": "14.0.0",
     "junit-report-builder": "3.2.1",
     "lint-staged": "15.2.2",
     "mocha": "10.4.0",
@@ -61,10 +61,13 @@
   "dependencies": {
     "@adobe/fetch": "4.1.2",
     "@adobe/helix-shared-config": "10.4.2",
+    "@adobe/helix-shared-git": "3.0.8",
     "@adobe/helix-shared-process-queue": "3.0.4",
     "@adobe/helix-shared-utils": "3.0.2",
     "@aws-sdk/client-s3": "3.556.0",
     "@smithy/node-http-handler": "2.5.0",
+    "ajv": "8.12.0",
+    "ajv-formats": "3.0.1",
     "mime": "4.0.1"
   }
 }

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

@@ -0,0 +1,12 @@
+/*
+ * 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-site.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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

@@ -0,0 +1,29 @@
+{
+  "meta:license": [
+    "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."
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://ns.adobe.com/helix/config/access",
+  "type": "object",
+  "title": "Access",
+  "properties": {
+    "admin": {
+      "$ref": "https://ns.adobe.com/helix/config/access/admin"
+    },
+    "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.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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

@@ -0,0 +1,233 @@
+{
+  "meta:license": [
+    "Copyright 2023 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."
+  ],
+  "$id": "https://ns.adobe.com/helix/config/cdn",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$defs": {
+    "stringOrArray": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ]
+    }
+  },
+  "title": "CDN Config",
+  "type": "object",
+  "properties": {
+    "prod": {
+      "oneOf": [
+        {
+          "type": "object",
+          "title": "FastlyConfig",
+          "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
+        },
+        {
+          "type": "object",
+          "title": "AkamaiConfig",
+          "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
+        },
+        {
+          "type": "object",
+          "title": "CloudflareConfig",
+          "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"
+              }
+            },
+            "origin": {
+              "type": "string"
+            },
+            "plan": {
+              "type": "string"
+            },
+            "zoneId": {
+              "type": "string"
+            },
+            "apiToken": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "type",
+            "host",
+            "origin",
+            "plan",
+            "zoneId",
+            "apiToken"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "title": "ManagedConfig",
+          "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
+        },
+        {
+          "type": "object",
+          "title": "EmptyConfig",
+          "properties": {
+            "host": {
+              "description": "production host",
+              "type": "string"
+            }
+          },
+          "required": [
+            "host"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "live": {
+      "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": {
+      "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
+    }
+  },
+  "required": [
+    "prod"
+  ],
+  "additionalProperties": false
+}

package/src/schemas/code.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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');

package/src/schemas/code.schema.json

@@ -0,0 +1,53 @@
+{
+  "meta:license": [
+    "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."
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://ns.adobe.com/helix/config/code",
+  "title": "Code Bus",
+  "type": "object",
+  "description": "Defines the code bus location and source.",
+  "properties": {
+    "title": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/title" },
+    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/description" },
+    "owner": {
+      "$comment": "Note, that owner/repo are no longer part of the hostname and can therefor have more allowed characters than in helix4",
+      "type": "string",
+      "pattern": "[a-zA-Z0-9_-]+"
+    },
+    "repo": {
+      "type": "string",
+      "pattern": "[a-zA-Z0-9_-]+"
+    },
+    "source": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "const": "github"
+        },
+        "url": {
+          "type":  "string",
+          "format": "uri"
+        }
+      },
+      "required": [
+        "type",
+        "url"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "owner",
+    "repo",
+    "source"
+  ]
+}

package/src/schemas/common.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./common.schema.json');

package/src/schemas/content-source-google.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./content-source-google.schema.json');

package/src/schemas/content-source-markup.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./content-source-markup.schema.json');

package/src/schemas/content-source-onedrive.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./content-source-onedrive.schema.json');

package/src/schemas/content.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./content.schema.json');

package/src/schemas/content.schema.json

@@ -0,0 +1,35 @@
+{
+  "meta:license": [
+    "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."
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://ns.adobe.com/helix/config/content",
+  "type": "object",
+  "title": "Content Bus",
+  "description": "Defines the content bus location and source.",
+  "properties": {
+    "title": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/title" },
+    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/description" },
+    "contentBusId": {"type": "string" },
+    "source": {
+      "oneOf": [
+        { "$ref": "https://ns.adobe.com/helix/config/content-source/google" },
+        { "$ref": "https://ns.adobe.com/helix/config/content-source/onedrive" },
+        { "$ref": "https://ns.adobe.com/helix/config/content-source/markup" }
+      ]
+    }
+  },
+  "required": [
+    "contentBusId",
+    "source"
+  ],
+  "additionalProperties": false
+}

package/src/schemas/folders.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./folders.schema.json');

package/src/schemas/folders.schema.json

@@ -0,0 +1,25 @@
+{
+  "meta:license": [
+    "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."
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://ns.adobe.com/helix/config/folders",
+  "type": "object",
+  "title": "folders",
+  "patternProperties": {
+    "^/[a-zA-Z0-9-/.]+$": {
+      "type": "array",
+      "items": [
+        { "type": "string" }
+      ]
+    }
+  }
+}

package/src/schemas/metadata-source.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./metadata-source.schema.json');

package/src/schemas/metadata-source.schema.json

@@ -0,0 +1,26 @@
+{
+  "meta:license": [
+    "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."
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://ns.adobe.com/helix/config/metadata-source",
+  "type": "object",
+  "title": "metadata",
+  "properties": {
+    "source": {
+      "type": "array",
+      "items": [
+        { "type": "string" }
+      ]
+    }
+  },
+  "additionalProperties": false
+}

package/src/schemas/profile.schema.cjs

@@ -0,0 +1,12 @@
+/*
+ * 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('./profile.schema.json');