@adobe/helix-config 2.5.5 → 2.6.0

package/types/site-config.d.ts

@@ -28,24 +28,12 @@ export interface HelixSiteConfig {
   description?: string;
   content: ContentBus;
   code: CodeBus;
-  folders?: {
-    /**
-     * This interface was referenced by `undefined`'s JSON-Schema definition
-     * via the `patternProperty` "^/[a-zA-Z0-9-/.]+$".
-     */
-    [k: string]: [] | [string];
-  };
+  folders?: Folders;
   headers?: ModifierMap;
   cdn?: CDNConfig;
-  access?: {
-    admin?: AdminAccessConfig;
-    preview?: SiteAccessConfig;
-    live?: SiteAccessConfig;
-  };
+  access?: Access;
   sidekick?: SidekickConfig;
-  metadata?: {
-    source?: [] | [string];
-  };
+  metadata?: Metadata;
 }
 /**
  * Defines the content bus location and source.
@@ -104,6 +92,13 @@ export interface CodeBus {
   };
   [k: string]: unknown;
 }
+export interface Folders {
+  /**
+   * This interface was referenced by `Folders`'s JSON-Schema definition
+   * via the `patternProperty` "^/[a-zA-Z0-9-/.]+$".
+   */
+  [k: string]: [] | [string];
+}
 export interface ModifierMap {
   /**
    * This interface was referenced by `ModifierMap`'s JSON-Schema definition
@@ -116,7 +111,7 @@ export interface KeyValuePair {
   value: string;
 }
 export interface CDNConfig {
-  prod: FastlyConfig | AkamaiConfig | CloudflareConfig | ManagedConfig;
+  prod: FastlyConfig | AkamaiConfig | CloudflareConfig | ManagedConfig | EmptyConfig;
   live?: {
     /**
      * Sidekick config to override the default preview host. it supports parameters $owner and $repo
@@ -193,6 +188,17 @@ export interface ManagedConfig {
    */
   route?: string[];
 }
+export interface EmptyConfig {
+  /**
+   * production host
+   */
+  host: string;
+}
+export interface Access {
+  admin?: AdminAccessConfig;
+  preview?: SiteAccessConfig;
+  live?: SiteAccessConfig;
+}
 export interface AdminAccessConfig {
   role?: Role;
   /**
@@ -241,3 +247,6 @@ export interface SidekickPlugin {
   url: string;
   [k: string]: unknown;
 }
+export interface Metadata {
+  source?: [] | [string];
+}

package/src/schemas/cdn-config.schema.json

@@ -1,182 +0,0 @@
-{
-  "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
-      }]
-    },
-    "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/site-config.schema.json

@@ -1,146 +0,0 @@
-{
-  "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/site",
-  "title": "Helix Site Config",
-  "type": "object",
-  "properties": {
-    "version": {
-      "type": "integer",
-      "enum": [1]
-    },
-    "name": {
-      "type": "string",
-      "description": "Site name; part of the hostname",
-      "format": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
-    },
-    "title": { "$ref": "common.schema.json#/$defs/title" },
-    "description": { "$ref": "common.schema.json#/$defs/description" },
-
-    "content": {
-      "type": "object",
-      "title": "Content Bus",
-      "description": "Defines the content bus location and source.",
-      "properties": {
-        "title": { "$ref": "common.schema.json#/$defs/title" },
-        "description": { "$ref": "common.schema.json#/$defs/description" },
-        "contentBusId": {"type": "string" },
-        "source": {
-          "oneOf": [
-            { "$ref": "content-google.schema.json" },
-            { "$ref": "content-onedrive.schema.json" },
-            { "$ref": "content-markup.schema.json" }
-          ]
-        }
-      },
-      "required": [
-        "contentBusId",
-        "source"
-      ],
-      "additionalProperties": false
-    },
-    "code": {
-      "type": "object",
-      "title": "Code Bus",
-      "description": "Defines the code bus location and source.",
-      "properties": {
-        "title": { "$ref": "common.schema.json#/$defs/title" },
-        "description": { "$ref": "common.schema.json#/$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",
-          "format": "[a-zA-Z0-9_-]+"
-        },
-        "repo": {
-          "type": "string",
-          "format": "[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"
-      ]
-    },
-    "folders": {
-      "type": "object",
-      "patternProperties": {
-        "^/[a-zA-Z0-9-/.]+$": {
-          "type": "array",
-          "items": [
-            { "type": "string" }
-          ]
-        }
-      }
-    },
-    "headers": {
-      "$ref": "common.schema.json#/$defs/modifier-map"
-    },
-    "cdn": {
-      "$ref": "cdn-config.schema.json"
-    },
-    "access": {
-      "type": "object",
-      "properties": {
-        "admin": {
-          "$ref": "admin-access-config.schema.json"
-        },
-        "preview": {
-          "$ref": "access-config.schema.json"
-        },
-        "live": {
-          "$ref": "access-config.schema.json"
-        }
-      },
-      "additionalProperties": false
-    },
-    "sidekick": {
-      "$ref": "sidekick-config.schema.json"
-    },
-    "metadata": {
-      "type": "object",
-      "properties": {
-        "source": {
-          "type": "array",
-          "items": [
-            { "type": "string" }
-          ]
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "required": [
-    "version",
-    "content",
-    "code"
-  ],
-  "additionalProperties": false
-}