@adobe/helix-config 2.5.5 → 2.7.0

package/src/schemas/profile.schema.json

@@ -0,0 +1,55 @@
+{
+  "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/profile",
+  "title": "Helix Profile Config",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "integer",
+      "enum": [1],
+      "default": 1
+    },
+    "title": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/title" },
+    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/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/common#/$defs/modifier-map"
+    },
+    "cdn": {
+      "$ref": "https://ns.adobe.com/helix/config/cdn"
+    },
+    "access": {
+      "$ref": "https://ns.adobe.com/helix/config/access"
+    },
+    "sidekick": {
+      "$ref": "https://ns.adobe.com/helix/config/sidekick"
+    },
+    "metadata": {
+      "$ref": "https://ns.adobe.com/helix/config/metadata-source"
+    }
+  },
+  "required": [
+    "version"
+  ],
+  "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/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,62 @@
+{
+  "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],
+      "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#/$defs/title" },
+    "description": { "$ref": "https://ns.adobe.com/helix/config/common#/$defs/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/common#/$defs/modifier-map"
+    },
+    "cdn": {
+      "$ref": "https://ns.adobe.com/helix/config/cdn"
+    },
+    "access": {
+      "$ref": "https://ns.adobe.com/helix/config/access"
+    },
+    "sidekick": {
+      "$ref": "https://ns.adobe.com/helix/config/sidekick"
+    },
+    "metadata": {
+      "$ref": "https://ns.adobe.com/helix/config/metadata-source"
+    }
+  },
+  "required": [
+    "version",
+    "content",
+    "code"
+  ],
+  "additionalProperties": false
+}

package/src/storage/ValidationError.js

@@ -0,0 +1,46 @@
+/*
+ * 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 max-classes-per-file */
+
+export class ValidationError extends Error {
+  constructor(
+    msg,
+    errors = [],
+    mapError = ValidationError.mapError,
+    prettyname = ValidationError.prettyname,
+  ) {
+    const detail = errors.map((e) => mapError(e, prettyname)).join('\n');
+    super(`Invalid configuration:
+${detail}
+
+${msg}`);
+    this._errors = errors;
+  }
+
+  static prettyname(path, schema) {
+    /* c8 ignore next */
+    return path ? `${schema.title || schema.$id} ${path}` : `${schema.title || schema.$id}`;
+  }
+
+  static mapError({
+    keyword, dataPath, message, data, params, parentSchema,
+  }, prettyname) {
+    /* c8 ignore next 7 */
+    if (keyword === 'additionalProperties') {
+      return `${prettyname(dataPath, parentSchema)} has unknown property '${params.additionalProperty}'`;
+    }
+    if (keyword === 'required') {
+      return `${prettyname(dataPath, parentSchema)} ${message}`;
+    }
+    return `${prettyname(dataPath, parentSchema)} ${message}: ${keyword}(${JSON.stringify(data)}, ${JSON.stringify(params)})`;
+  }
+}

package/src/storage/config-store.js

@@ -11,7 +11,13 @@
  */
 import { HelixStorage } from './storage.js';
 import { StatusCodeError } from './status-code-error.js';
-import { jsonGet, jsonPut, updateContentBusId } from './utils.js';
+import {
+  jsonGet,
+  jsonPut,
+  updateCodeSource,
+  updateContentSource,
+} from './utils.js';
+import { validate } from './config-validator.js';
 
 const FRAGMENTS = {
   sites: {
@@ -65,7 +71,9 @@ export class ConfigStore {
     if (await storage.head(this.key)) {
       throw new StatusCodeError(409, 'config already exists.');
     }
-    updateContentBusId(ctx, data);
+    updateContentSource(ctx, data.content);
+    updateCodeSource(ctx, data.code);
+    await validate(data, this.type);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, null, data);
   }
@@ -99,10 +107,18 @@ export class ConfigStore {
       if (!fragment) {
         throw new StatusCodeError(400, 'invalid object path.');
       }
+      if (relPath === 'code') {
+        updateCodeSource(ctx, data);
+      } else if (relPath === 'content') {
+        updateContentSource(ctx, data);
+      }
       // eslint-disable-next-line no-param-reassign
       data = jsonPut(JSON.parse(buf), relPath, data);
+    } else {
+      updateContentSource(ctx, data.content);
+      updateCodeSource(ctx, data.code);
     }
-    updateContentBusId(ctx, data);
+    await validate(data, this.type);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, old, data);
   }
@@ -119,6 +135,7 @@ export class ConfigStore {
         throw new StatusCodeError(400, 'invalid object path.');
       }
       const data = jsonPut(JSON.parse(buf), relPath, null);
+      await validate(data, this.type);
       await storage.put(this.key, JSON.stringify(data), 'application/json');
       await this.purge(ctx, JSON.parse(buf), data);
       return;

package/src/storage/config-validator.js

@@ -0,0 +1,77 @@
+/*
+ * 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.
+ */
+import Ajv from 'ajv';
+import ajvFormats from 'ajv-formats';
+import { ValidationError } from './ValidationError.js';
+
+import accessAdminSchema from '../schemas/access-admin.schema.cjs';
+import accessSchema from '../schemas/access.schema.cjs';
+import accessSiteSchema from '../schemas/access-site.schema.cjs';
+import cdnSchema from '../schemas/cdn.schema.cjs';
+import commonSchema from '../schemas/common.schema.cjs';
+import codeSchema from '../schemas/code.schema.cjs';
+import contentSchema from '../schemas/content.schema.cjs';
+import foldersSchema from '../schemas/folders.schema.cjs';
+import googleSchema from '../schemas/content-source-google.schema.cjs';
+import markupSchema from '../schemas/content-source-markup.schema.cjs';
+import metadataSchema from '../schemas/metadata-source.schema.cjs';
+import onedriveSchema from '../schemas/content-source-onedrive.schema.cjs';
+import profileSchema from '../schemas/profile.schema.cjs';
+import sidekickSchema from '../schemas/sidekick.schema.cjs';
+import siteSchema from '../schemas/site.schema.cjs';
+
+const SCHEMAS = [
+  accessSchema,
+  accessAdminSchema,
+  accessSiteSchema,
+  cdnSchema,
+  commonSchema,
+  contentSchema,
+  codeSchema,
+  foldersSchema,
+  googleSchema,
+  markupSchema,
+  metadataSchema,
+  onedriveSchema,
+  profileSchema,
+  sidekickSchema,
+  siteSchema,
+];
+
+const SCHEMA_TYPES = {
+  profiles: profileSchema,
+  sites: siteSchema,
+};
+
+/**
+ * Validates the loaded configuration and coerces types and sets defaults
+ * @param {object} config The configuration to validate
+ * @param {string} type the config type
+ * @returns {object} The validated configuration
+ */
+export async function validate(config, type) {
+  const ajv = new Ajv({
+    allErrors: true,
+    verbose: true,
+    useDefaults: true,
+    coerceTypes: 'array',
+    strict: false,
+  });
+  ajvFormats(ajv);
+
+  ajv.addSchema(SCHEMAS);
+  const res = ajv.validate(SCHEMA_TYPES[type], config);
+  if (res) {
+    return res;
+  }
+  throw new ValidationError(ajv.errorsText(), ajv.errors);
+}

package/src/storage/utils.js

@@ -9,7 +9,9 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+/* eslint-disable no-param-reassign */
 import crypto from 'crypto';
+import { GitUrl } from '@adobe/helix-shared-git';
 
 export function jsonGet(obj, path) {
   return path.split('/').reduce((o, p) => o[p], obj);
@@ -36,24 +38,76 @@ export function jsonPut(obj, path, value) {
 /**
  * Update the contentBusId field of the content object based on the source URL.
  * @param ctx
- * @param data
+ * @param content
  * @returns {boolean}
  */
-export function updateContentBusId(ctx, data) {
-  if (!data.content?.source?.url) {
+export function updateContentSource(ctx, content) {
+  if (!content?.source?.url) {
     return false;
   }
+  const url = new URL(content.source.url);
+  let modified = false;
   const sha256 = crypto
     .createHash('sha256')
-    .update(data.content.source.url)
+    .update(url.toString())
     .digest('hex');
   const contentBusId = `${sha256.substring(0, 59)}`;
-  if (contentBusId === data.content.contentBusId) {
-    ctx.log.info(`contentBusId is already correct for ${data.content.source.url}: ${contentBusId}`);
-    return false;
+  if (contentBusId === content.contentBusId) {
+    ctx.log.info(`contentBusId is already correct for ${url}: ${contentBusId}`);
+  } else {
+    ctx.log.info(`Updating contentBusId for ${url}: ${contentBusId}`);
+    content.contentBusId = contentBusId;
+    modified = true;
+  }
+
+  // calculate type based on source URL
+  if (!content.source.type) {
+    if (url.hostname === 'drive.google.com') {
+      content.source.type = 'google';
+      content.source.id = url.pathname.split('/').pop();
+      modified = true;
+    } else if (url.protocol === 'gdrive:') {
+      content.source.type = 'google';
+      content.source.id = url.pathname;
+      modified = true;
+    } else if (url.hostname.endsWith('.sharepoint.com') || url.hostname === '1drv.ms') {
+      content.source.type = 'onedrive';
+      modified = true;
+    } else if (url.protocol === 'onedrive:') {
+      content.source.type = 'onedrive';
+      content.source.itemId = url.pathname;
+      modified = true;
+    }
+  }
+  return modified;
+}
+
+/**
+ * updates the code source information
+ * @param ctx
+ * @param code
+ * @return {boolean} true if the code source was updated
+ */
+export function updateCodeSource(ctx, code) {
+  let modified = false;
+  if (code?.source?.url) {
+    // recompute owner, repo and type
+    code.source.type = 'github';
+    const url = new GitUrl(code.source.url);
+    if (url.owner !== code.owner) {
+      code.owner = url.owner;
+      modified = true;
+    }
+    if (url.repo !== code.repo) {
+      code.repo = url.repo;
+      modified ||= true;
+    }
+  } else if (code?.owner && code?.repo) {
+    code.source = {
+      type: 'github',
+      url: `https://github.com/${code.owner}/${code.repo}`,
+    };
+    modified = true;
   }
-  ctx.log.info(`Updating contentBusId for ${data.content.source.url}: ${contentBusId}`);
-  // eslint-disable-next-line no-param-reassign
-  data.content.contentBusId = contentBusId;
-  return true;
+  return modified;
 }

package/types/profile-config.d.ts

@@ -0,0 +1,249 @@
+/*
+ * 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.
+ */
+
+// NOTE: this file is autogenerated via 'npm run docs:types'
+import {MountConfig} from '@adobe/helix-shared-config';
+
+export interface HelixProfileConfig {
+  version: 1;
+  /**
+   * human readable title. has no influence on the configuration.
+   */
+  title?: string;
+  /**
+   * description for clarity. has no influence on the configuration.
+   */
+  description?: string;
+  content?: ContentBus;
+  code?: CodeBus;
+  folders?: Folders;
+  headers?: ModifierMap;
+  cdn?: CDNConfig;
+  access?: Access;
+  sidekick?: SidekickConfig;
+  metadata?: Metadata;
+}
+/**
+ * Defines the content bus location and source.
+ */
+export interface ContentBus {
+  /**
+   * human readable title. has no influence on the configuration.
+   */
+  title?: string;
+  /**
+   * description for clarity. has no influence on the configuration.
+   */
+  description?: string;
+  contentBusId: string;
+  source: GoogleContentSource | OnedriveContentSource | MarkupContentSource;
+}
+export interface GoogleContentSource {
+  type: 'google';
+  url: string;
+  /**
+   * Google drive ID of the root folder; updated automatically when updating the url.
+   */
+  id: string;
+}
+export interface OnedriveContentSource {
+  type: 'onedrive';
+  url: string;
+  tenantId?: string;
+  /**
+   * onedrive item ID of the root folder; currently not required as we don't know how setup will work.
+   */
+  itemId?: string;
+}
+export interface MarkupContentSource {
+  type: 'markup';
+  url: string;
+  suffix?: string;
+}
+/**
+ * Defines the code bus location and source.
+ */
+export interface CodeBus {
+  /**
+   * human readable title. has no influence on the configuration.
+   */
+  title?: string;
+  /**
+   * description for clarity. has no influence on the configuration.
+   */
+  description?: string;
+  owner: string;
+  repo: string;
+  source: {
+    type: 'github';
+    url: string;
+  };
+  [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
+   * via the `patternProperty` "^/[a-zA-Z0-9-/.]+[*]{0,2}$".
+   */
+  [k: string]: [] | [KeyValuePair];
+}
+export interface KeyValuePair {
+  key: string;
+  value: string;
+}
+export interface CDNConfig {
+  prod: FastlyConfig | AkamaiConfig | CloudflareConfig | ManagedConfig | EmptyConfig;
+  live?: {
+    /**
+     * Sidekick config to override the default preview host. it supports parameters $owner and $repo
+     */
+    host: string;
+  };
+  preview?: {
+    /**
+     * Sidekick config to override the default live host. it supports parameters $owner and $repo
+     */
+    host: string;
+  };
+}
+/**
+ * Production CDN configuration for Fastly
+ */
+export interface FastlyConfig {
+  type: 'fastly';
+  /**
+   * production host
+   */
+  host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
+  /**
+   * The Fastly Service ID
+   */
+  serviceId: string;
+  /**
+   * A Fastly token for purging
+   */
+  authToken: string;
+}
+export interface AkamaiConfig {
+  type: 'akamai';
+  /**
+   * production host
+   */
+  host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
+  endpoint: string;
+  clientSecret: string;
+  clientToken: string;
+  accessToken: string;
+}
+export interface CloudflareConfig {
+  type: 'cloudflare';
+  /**
+   * production host
+   */
+  host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
+  origin: string;
+  plan: string;
+  zoneId: string;
+  apiToken: string;
+}
+export interface ManagedConfig {
+  type: 'managed';
+  /**
+   * production host
+   */
+  host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
+}
+export interface EmptyConfig {
+  /**
+   * production host
+   */
+  host: string;
+}
+export interface Access {
+  admin?: AdminAccessConfig;
+  preview?: SiteAccessConfig;
+  live?: SiteAccessConfig;
+}
+export interface AdminAccessConfig {
+  role?: Role;
+  /**
+   * Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'.
+   */
+  requireAuth?: boolean | 'auto';
+  /**
+   * the default roles assigned to the users. defaults to `basic_publish` for unauthenticated setups.
+   */
+  defaultRole?: string[];
+  /**
+   * the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.
+   */
+  apiKeyId?: string[];
+}
+export interface Role {
+  /**
+   * The email glob of the users with respective role.
+   *
+   * This interface was referenced by `Role`'s JSON-Schema definition
+   * via the `patternProperty` "^(?:author|publish|admin)$".
+   */
+  [k: string]: string[];
+}
+export interface SiteAccessConfig {
+  /**
+   * The email glob of the users that are allowed.
+   */
+  allow?: string[];
+  /**
+   * IDs of the api keys that are allowed.
+   */
+  apiKeyId?: string[];
+  /**
+   * the DNs of the client certificates that are allowed.
+   */
+  clientCertDN?: string[];
+}
+export interface SidekickConfig {
+  plugins?: [] | [SidekickPlugin];
+  [k: string]: unknown;
+}
+export interface SidekickPlugin {
+  id: string;
+  title: string;
+  url: string;
+  [k: string]: unknown;
+}
+export interface Metadata {
+  source?: [] | [string];
+}