@adobe/helix-shared-config 2.0.7 → 2.1.2

package/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.1.2](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config@2.1.1...@adobe/helix-shared-config@2.1.2) (2022-06-02)
+
+
+### Bug Fixes
+
+* allow adding sitemap or languages ([#690](https://github.com/adobe/helix-shared/issues/690)) ([5f095ef](https://github.com/adobe/helix-shared/commit/5f095ef276e1a44a36d9f3168d25ecf1074fa4ad))
+
+
+
+
+
+## [2.1.1](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config@2.1.0...@adobe/helix-shared-config@2.1.1) (2022-05-23)
+
+
+### Bug Fixes
+
+* proxy clone to not change original configuration ([#686](https://github.com/adobe/helix-shared/issues/686)) ([96f9ce7](https://github.com/adobe/helix-shared/commit/96f9ce7dc90cd97efc44ecd7a06151451dee9d3e))
+
+
+
+
+
+# [2.1.0](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config@2.0.7...@adobe/helix-shared-config@2.1.0) (2022-05-20)
+
+
+### Features
+
+* add index configuration ([#684](https://github.com/adobe/helix-shared/issues/684)) ([2cdec6f](https://github.com/adobe/helix-shared/commit/2cdec6f0c27b114d239ac524e3776e2d7e65fb18))
+
+
+
+
+
 ## [2.0.7](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config@2.0.6...@adobe/helix-shared-config@2.0.7) (2022-05-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-shared-config",
-  "version": "2.0.7",
+  "version": "2.1.2",
   "description": "Shared modules of the Helix Project - config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -49,5 +49,5 @@
     "mocha": "10.0.0",
     "nock": "13.2.4"
   },
-  "gitHead": "8329b6609872ddb48dfd247f9953f43379907b81"
+  "gitHead": "49e92ebcfa348d3cc01782c116d1ca2c42f20c6f"
 }

package/src/IndexConfig.js

@@ -35,6 +35,34 @@ class IndexConfig extends SchemaDerivedConfig {
     });
   }
 
+  /**
+   * Adds an index definition.
+   *
+   * @param {Object} index index configuration
+   * @param {string} index.name index name
+   * @param {Array} index.include paths to include
+   * @param {Array} index.exclude paths to exclude
+   * @param {string} index.target target
+   * @param {object} index.properties properties to add to the index
+   */
+  addIndex({
+    name, include, exclude, target, properties,
+  }) {
+    const { indices } = this._cfg;
+    if (indices[name]) {
+      throw new Error(`Unable to add index definition with existing name: ${name}`);
+    }
+    indices[name] = {
+      include,
+      exclude,
+      target,
+      properties,
+    };
+
+    // let BaseConfig.toYAML() use the JSON output
+    this._document = null;
+  }
+
   /**
    * Evaluates a variable expression
    * @param {string} expression the expression to encode

package/src/SchemaDerivedConfig.js

@@ -135,10 +135,11 @@ class SchemaDerivedConfig extends BaseConfig {
     await this.loadConfig();
     await this.validate();
 
-    this._content = new Proxy(this._cfg, this.defaultHandler(''));
+    const cfg = JSON.parse(JSON.stringify(this._cfg));
+    this._content = new Proxy(cfg, this.defaultHandler(''));
 
     // redefine getters
-    Object.keys(this._cfg).forEach((key) => {
+    Object.keys(cfg).forEach((key) => {
       if (!(key in this)) {
         this[key] = this._content[key];
       }

package/src/SitemapConfig.js

@@ -41,6 +41,74 @@ class SitemapConfig extends SchemaDerivedConfig {
     this._version = this._cfg.version;
     return this;
   }
+
+  /**
+   * Adds a sitemap definition.
+   *
+   * @param {Object} sitemap sitemap configuration
+   * @param {string} sitemap.name sitemap name
+   * @param {string} sitemap.origin sitemap origin
+   * @param {string} sitemap.source sitemap source
+   * @param {string} sitemap.destination sitemap destination
+   * @param {string} sitemap.lastmod lastmod format
+   * @return new sitemap
+   */
+  addSitemap({
+    name, origin, source, destination, lastmod,
+  }) {
+    const { sitemaps } = this._cfg;
+    if (sitemaps[name]) {
+      throw new Error(`Unable to add sitemap definition with existing name: ${name}`);
+    }
+    sitemaps[name] = {
+      origin,
+      source,
+      destination,
+      lastmod,
+    };
+
+    // let BaseConfig.toYAML() use the JSON output
+    this._document = null;
+    return sitemaps[name];
+  }
+
+  /**
+   * Adds a language definition within a sitemap.
+   *
+   * @param {string} sitemapName sitemap name
+   * @param {Object} language language configuration
+   * @param {string} language.name language name
+   * @param {string} language.source language source
+   * @param {string} language.destination language destination
+   * @param {string} language.hreflang href language
+   * @param {string} language.alternate alternate location of this language
+   * @return new language
+   */
+  addLanguage(sitemapName, {
+    name, source, destination, hreflang, alternate,
+  }) {
+    const { sitemaps } = this._cfg;
+
+    const sitemap = sitemaps[sitemapName];
+    if (!sitemap) {
+      throw new Error(`Unable to add language, sitemap not found: ${sitemapName}`);
+    }
+    // eslint-disable-next-line no-multi-assign
+    const languages = (sitemap.languages = sitemap.languages || {});
+    if (languages[name]) {
+      throw new Error(`Unable to add language definition with existing name: ${name}`);
+    }
+    languages[name] = {
+      source,
+      destination,
+      hreflang,
+      alternate,
+    };
+
+    // let BaseConfig.toYAML() use the JSON output
+    this._document = null;
+    return languages[name];
+  }
 }
 
 module.exports = SitemapConfig;