@adobe/helix-shared-config 2.0.7 → 2.1.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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.0",
   "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": "e77cc809f42f4b6b13e4274ddf106a6c84f8abfa"
 }

package/src/IndexConfig.js

@@ -35,6 +35,35 @@ 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] = {
+      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