Add back ReadonlyMap APIs (#52)

Author: Eskibear

src/AzureAppConfiguration.ts

@@ -16,7 +16,7 @@ export type AzureAppConfiguration = {
      * @param thisArg - Optional. Value to use as `this` when executing callback.
      */
     onRefresh(listener: () => any, thisArg?: any): Disposable;
-} & IGettable & IConfigurationObject;
+} & IGettable & ReadonlyMap<string, any> & IConfigurationObject;
 
 interface IConfigurationObject {
     /**

src/AzureAppConfigurationImpl.ts

@@ -91,10 +91,39 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         this.#adapters.push(new JsonKeyValueAdapter());
     }
 
+    // ReadonlyMap APIs
     get<T>(key: string): T | undefined {
         return this.#configMap.get(key);
     }
 
+    forEach(callbackfn: (value: any, key: string, map: ReadonlyMap<string, any>) => void, thisArg?: any): void {
+        this.#configMap.forEach(callbackfn, thisArg);
+    }
+
+    has(key: string): boolean {
+        return this.#configMap.has(key);
+    }
+
+    get size(): number {
+        return this.#configMap.size;
+    }
+
+    entries(): IterableIterator<[string, any]> {
+        return this.#configMap.entries();
+    }
+
+    keys(): IterableIterator<string> {
+        return this.#configMap.keys();
+    }
+
+    values(): IterableIterator<any> {
+        return this.#configMap.values();
+    }
+
+    [Symbol.iterator](): IterableIterator<[string, any]> {
+        return this.#configMap[Symbol.iterator]();
+    }
+
     get #refreshEnabled(): boolean {
         return !!this.#options?.refreshOptions?.enabled;
     }

test/load.test.ts

@@ -110,6 +110,74 @@ describe("load", function () {
         return expect(load("invalid-endpoint-url", credential)).eventually.rejectedWith("Invalid endpoint URL.");
     });
 
+    it("should filter by key and label, has(key) and get(key) should work", async () => {
+        const connectionString = createMockedConnectionString();
+        const settings = await load(connectionString, {
+            selectors: [{
+                keyFilter: "app.settings.*",
+                labelFilter: "\0"
+            }]
+        });
+        expect(settings).not.undefined;
+        expect(settings.has("app.settings.fontColor")).true;
+        expect(settings.has("app.settings.fontSize")).true;
+        expect(settings.has("app.settings.fontFamily")).false;
+        expect(settings.get("app.settings.fontColor")).eq("red");
+        expect(settings.get("app.settings.fontSize")).eq("40");
+        expect(settings.get("app.settings.fontFamily")).undefined;
+    });
+
+    it("should also work with other ReadonlyMap APIs", async () => {
+        const connectionString = createMockedConnectionString();
+        const settings = await load(connectionString, {
+            selectors: [{
+                keyFilter: "app.settings.*",
+                labelFilter: "\0"
+            }]
+        });
+        expect(settings).not.undefined;
+        // size
+        expect(settings.size).eq(2);
+        // keys()
+        expect(Array.from(settings.keys())).deep.eq(["app.settings.fontColor", "app.settings.fontSize"]);
+        // values()
+        expect(Array.from(settings.values())).deep.eq(["red", "40"]);
+        // entries()
+        expect(Array.from(settings.entries())).deep.eq([["app.settings.fontColor", "red"], ["app.settings.fontSize", "40"]]);
+        // forEach()
+        const keys: string[] = [];
+        const values: string[] = [];
+        settings.forEach((value, key) => {
+            keys.push(key);
+            values.push(value);
+        });
+        expect(keys).deep.eq(["app.settings.fontColor", "app.settings.fontSize"]);
+        expect(values).deep.eq(["red", "40"]);
+        // [Symbol.iterator]()
+        const entries: [string, string][] = [];
+        for (const [key, value] of settings) {
+            entries.push([key, value]);
+        }
+        expect(entries).deep.eq([["app.settings.fontColor", "red"], ["app.settings.fontSize", "40"]]);
+    });
+
+    it("should be read-only, set(key, value) should not work", async () => {
+        const connectionString = createMockedConnectionString();
+        const settings = await load(connectionString, {
+            selectors: [{
+                keyFilter: "app.settings.*",
+                labelFilter: "\0"
+            }]
+        });
+        expect(settings).not.undefined;
+        expect(() => {
+            // Here force to turn if off for testing purpose, as JavaScript does not have type checking.
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            settings.set("app.settings.fontColor", "blue");
+        }).to.throw("settings.set is not a function");
+    });
+
     it("should trim key prefix if applicable", async () => {
         const connectionString = createMockedConnectionString();
         const settings = await load(connectionString, {