@adobe/helix-config-storage 1.0.0

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-site.schema.json

@@ -0,0 +1,24 @@
+{
+  "$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

@@ -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,22 @@
+{
+  "$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

@@ -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-prod-akamai.schema.json');

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

@@ -0,0 +1,45 @@
+{
+  "$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

@@ -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-prod-cloudflare.schema.json');

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

@@ -0,0 +1,41 @@
+{
+  "$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

@@ -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-prod-cloudfront.schema.json');

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

@@ -0,0 +1,41 @@
+{
+  "$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

@@ -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-prod-fastly.schema.json');

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

@@ -0,0 +1,40 @@
+{
+  "$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

@@ -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-prod-managed.schema.json');

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

@@ -0,0 +1,29 @@
+{
+  "$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

@@ -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,75 @@
+{
+  "$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

@@ -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,43 @@
+{
+  "$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/code",
+  "title": "Code source",
+  "type": "object",
+  "description": "Defines the code bus location and source.",
+  "properties": {
+    "title": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/title" },
+    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/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/common.schema.json

@@ -0,0 +1,27 @@
+{
+  "$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/common",
+  "definitions": {
+    "title": {
+      "type": "string",
+      "description": "human readable title. has no influence on the configuration."
+    },
+    "description": {
+      "type": "string",
+      "description": "description for clarity. has no influence on the configuration."
+    },
+    "keyValuePair": {
+      "type": "object",
+      "properties": {
+        "key": {"type": "string"},
+        "value": {"type": "string"}
+      },
+      "required": [
+        "key",
+        "value"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

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-google.schema.json

@@ -0,0 +1,26 @@
+{
+  "$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/content-source/google",
+  "title": "Google Content Source",
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "google"
+    },
+    "url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "id": {
+      "description": "Google drive ID of the root folder; updated automatically when updating the url.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "url",
+    "id"
+  ],
+  "additionalProperties": false
+}

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-markup.schema.json

@@ -0,0 +1,24 @@
+{
+  "$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/content-source/markup",
+  "title": "Markup Content Source",
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "markup"
+    },
+    "url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "suffix": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "url"
+  ],
+  "additionalProperties": false
+}

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-source-onedrive.schema.json

@@ -0,0 +1,28 @@
+{
+  "$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/content-source/onedrive",
+  "title": "Onedrive Content Source",
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "onedrive"
+    },
+    "url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "tenantId": {
+      "type": "string"
+    },
+    "itemId": {
+      "description": "onedrive item ID of the root folder; currently not required as we don't know how setup will work.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "url"
+  ],
+  "additionalProperties": false
+}