Remove unnecessary options

Author: Eskibear

src/AzureAppConfiguration.ts

@@ -32,18 +32,6 @@ export interface ConfigurationObjectConstructionOptions {
      * Default is '.'.
      */
     separator?: string;
-
-    /**
-     * The prefix of hierarchical keys to be converted object properties, usefull when converting a subset of the keys.
-     * Default is '', representing the root of the object.
-     */
-    prefix?: string;
-
-    /**
-     * The behavior when error or amibiguity occurs on converting hierarchical keys.
-     * Default is 'error'.
-     */
-    onError?: "error" | "ignore";
 }
 
 interface IGettable {

src/AzureAppConfigurationImpl.ts

@@ -184,47 +184,31 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
      */
     constructConfigurationObject(options?: ConfigurationObjectConstructionOptions): Record<string, any> {
         const separator = options?.separator ?? ".";
-        const prefix = options?.prefix ?? "";
-        const onError = options?.onError ?? "error";
 
         // construct hierarchical data object from map
         const data: Record<string, any> = {};
         for (const [key, value] of this.#configMap) {
-            if (key.startsWith(prefix)) {
-                const segments = key.slice(prefix.length).split(separator);
-                let current = data;
-                // construct hierarchical data object along the path
-                for (let i = 0; i < segments.length - 1; i++) {
-                    const segment = segments[i];
-                    // undefined or empty string
-                    if (!segment) {
-                        if (onError === "error") {
-                            throw new Error(`invalid key: ${key}`);
-                        } else if (onError === "ignore") {
-                            continue;
-                        } else {
-                            throw new Error(`The value of 'onError' is not supported: ${onError}`);
-                        }
-                    }
-                    // create path if not exist
-                    if (current[segment] === undefined) {
-                        current[segment] = {};
-                    }
-                    // The path has been occupied by a non-object value, causing ambiguity.
-                    if (typeof current[segment] !== "object") {
-                        if (onError === "error") {
-                            throw new Error(`The key '${prefix}${segments.slice(0, i + 1).join(separator)}' is not a valid path.`);
-                        } else if (onError === "ignore") {
-                            current[segment] = {}; // overwrite the non-object value
-                        } else {
-                            throw new Error(`The value of 'onError' is not supported: ${onError}`);
-                        }
-                    }
-                    current = current[segment];
+            const segments = key.split(separator);
+            let current = data;
+            // construct hierarchical data object along the path
+            for (let i = 0; i < segments.length - 1; i++) {
+                const segment = segments[i];
+                // undefined or empty string
+                if (!segment) {
+                    throw new Error(`invalid key: ${key}`);
+                }
+                // create path if not exist
+                if (current[segment] === undefined) {
+                    current[segment] = {};
+                }
+                // The path has been occupied by a non-object value, causing ambiguity.
+                if (typeof current[segment] !== "object") {
+                    throw new Error(`The key '${segments.slice(0, i + 1).join(separator)}' is not a valid path.`);
                 }
-                // set value to the last segment
-                current[segments[segments.length - 1]] = value;
+                current = current[segment];
             }
+            // set value to the last segment
+            current[segments[segments.length - 1]] = value;
         }
         return data;
     }

test/load.test.ts

@@ -38,7 +38,14 @@ const mockedKVs = [{
 }, {
     key: "app3.settings.fontColor",
     value: "yellow"
-}].map(createMockedKeyValue);
+}, {
+    key: "app4.excludedFolders.0",
+    value: "node_modules"
+}, {
+    key: "app4.excludedFolders.1",
+    value: "dist"
+}
+].map(createMockedKeyValue);
 
 describe("load", function () {
     this.timeout(10000);
@@ -226,33 +233,31 @@ describe("load", function () {
      * get() will return "placeholder" for "app3.settings" and "yellow" for "app3.settings.fontColor", as expected.
      * data.app3.settings will return "placeholder" as a whole JSON object, which is not guarenteed to be correct.
      */
-    it("Edge case: Hierarchical key-value pairs with overlapped key prefix. Ignore error.", async () => {
+    it("Edge case: Hierarchical key-value pairs with overlapped key prefix.", async () => {
         const connectionString = createMockedConnectionString();
         const settings = await load(connectionString, {
             selectors: [{
                 keyFilter: "app3.settings*"
             }]
         });
         expect(settings).not.undefined;
-        // use get() method
-        expect(settings.get("app3.settings")).eq("placeholder");
-        expect(settings.get("app3.settings.fontColor")).eq("yellow");
-        // use data property
-        const data = settings.constructConfigurationObject({ onError: "ignore" }); // ignore error on hierarchical key conversion
-        expect(data.app3.settings).not.eq("placeholder"); // not as expected.
-        expect(data.app3.settings.fontColor).eq("yellow");
+        expect(() => {
+            settings.constructConfigurationObject();
+        }).to.throw("The key 'app3.settings' is not a valid path.");
     });
 
-    it("Edge case: Hierarchical key-value pairs with overlapped key prefix. Default error.", async () => {
+    it("should construct configuration object with array", async () => {
         const connectionString = createMockedConnectionString();
         const settings = await load(connectionString, {
             selectors: [{
-                keyFilter: "app3.settings*"
+                keyFilter: "app4.*"
             }]
         });
         expect(settings).not.undefined;
-        expect(() => {
-            settings.constructConfigurationObject();
-        }).to.throw("The key 'app3.settings' is not a valid path.");
+        const data = settings.constructConfigurationObject();
+        expect(data).not.undefined;
+        // Both { '0': 'node_modules', '1': 'dist' } and ['node_modules', 'dist'] are valid.
+        expect(data.app4.excludedFolders[0]).eq("node_modules");
+        expect(data.app4.excludedFolders[1]).eq("dist");
     });
 });