@adobe/helix-config-storage 1.0.0

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,30 @@
+{
+  "$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",
+  "type": "object",
+  "title": "Content source",
+  "description": "Defines the content 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" },
+    "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" }
+      ]
+    },
+    "overlay": {
+      "oneOf": [
+        { "$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,13 @@
+{
+  "$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/folders",
+  "type": "object",
+  "title": "folders",
+  "patternProperties": {
+    "^/[a-zA-Z0-9-/.]*$": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

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

package/src/schemas/groups.schema.json

@@ -0,0 +1,39 @@
+{
+  "$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/groups",
+  "type": "object",
+  "title": "Groups",
+  "patternProperties": {
+    "^[a-zA-Z0-9-_=]+$": {
+      "type": "object",
+      "title": "Group",
+      "description": "A group of members. Can be referenced in access.admin.role.",
+      "properties": {
+        "members": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "email": {
+                "type": "string",
+                "format": "email"
+              },
+              "name": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "email"
+            ]
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "members"
+      ]
+    }
+  },
+  "additionalProperties": false
+}

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

package/src/schemas/headers.schema.json

@@ -0,0 +1,16 @@
+{
+  "$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/headers",
+  "type": "object",
+  "title": "Helix Headers Config",
+  "patternProperties": {
+    "^/[a-zA-Z0-9-/.]*\\*{0,2}$": {
+      "type": "array",
+      "items": {
+        "$ref": "https://ns.adobe.com/helix/config/common#/definitions/keyValuePair"
+      }
+    }
+  },
+  "additionalProperties": false
+}

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,16 @@
+{
+  "$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/metadata-source",
+  "type": "object",
+  "title": "metadata",
+  "properties": {
+    "source": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": false
+}

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

package/src/schemas/org.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/org",
+  "title": "Helix Org Config",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "integer",
+      "enum": [1],
+      "default": 1
+    },
+    "title": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/title" },
+    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/description" },
+    "users": {
+      "$ref": "https://ns.adobe.com/helix/config/users"
+    },
+    "groups": {
+      "$ref": "https://ns.adobe.com/helix/config/groups"
+    }
+  },
+  "required": [
+    "version"
+  ],
+  "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');

package/src/schemas/profile.schema.json

@@ -0,0 +1,57 @@
+{
+  "$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/profile",
+  "title": "Helix Profile Config",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "integer",
+      "enum": [1],
+      "default": 1
+    },
+    "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"
+    }
+  },
+  "required": [
+    "version"
+  ],
+  "additionalProperties": false
+}

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

package/src/schemas/profiles.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/profiles",
+  "title": "Helix Profiles List",
+  "type": "object",
+  "properties": {
+    "profiles": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "profiles"
+  ],
+  "additionalProperties": false
+}

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

package/src/schemas/public.schema.json

@@ -0,0 +1,8 @@
+{
+  "$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/public",
+  "type": "object",
+  "title": "public",
+  "description": "Public configuration"
+}

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

package/src/schemas/robots.schema.json

@@ -0,0 +1,13 @@
+{
+  "$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/robots",
+  "type": "object",
+  "title": "robots",
+  "properties": {
+    "txt": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

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

package/src/schemas/sidekick.schema.json

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

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

package/src/schemas/site.schema.json

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

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

package/src/schemas/sites.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/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
+}