update

Author: zhiyuanliang-ms

rollup.config.mjs

@@ -4,7 +4,15 @@ import dts from "rollup-plugin-dts";
 
 export default [
   {
-    external: ["@azure/app-configuration", "@azure/keyvault-secrets", "@azure/core-rest-pipeline", "crypto", "dns/promises", "@microsoft/feature-management"],
+    external: [
+      "@azure/app-configuration",
+      "@azure/keyvault-secrets",
+      "@azure/core-rest-pipeline",
+      "@azure/identity",
+      "crypto",
+      "dns/promises",
+      "@microsoft/feature-management"
+    ],
     input: "src/index.ts",
     output: [
       {

src/AzureAppConfigurationImpl.ts

@@ -8,7 +8,7 @@ import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions.js"
 import { IKeyValueAdapter } from "./IKeyValueAdapter.js";
 import { JsonKeyValueAdapter } from "./JsonKeyValueAdapter.js";
 import { DEFAULT_STARTUP_TIMEOUT_IN_MS } from "./StartupOptions.js";
-import { DEFAULT_REFRESH_INTERVAL_IN_MS, MIN_REFRESH_INTERVAL_IN_MS } from "./RefreshOptions.js";
+import { DEFAULT_REFRESH_INTERVAL_IN_MS, MIN_REFRESH_INTERVAL_IN_MS } from "./refresh/refreshOptions.js";
 import { Disposable } from "./common/disposable.js";
 import { base64Helper, jsonSorter } from "./common/utils.js";
 import {

src/AzureAppConfigurationOptions.ts

@@ -3,7 +3,7 @@
 
 import { AppConfigurationClientOptions } from "@azure/app-configuration";
 import { KeyVaultOptions } from "./keyvault/KeyVaultOptions.js";
-import { RefreshOptions } from "./RefreshOptions.js";
+import { RefreshOptions } from "./refresh/refreshOptions.js";
 import { SettingSelector } from "./types.js";
 import { FeatureFlagOptions } from "./featureManagement/FeatureFlagOptions.js";
 import { StartupOptions } from "./StartupOptions.js";

src/StartupOptions.ts

@@ -8,7 +8,7 @@ export interface StartupOptions {
      * The amount of time allowed to load data from Azure App Configuration on startup.
      *
      * @remarks
-     * If not specified, the default value is 100 seconds. Must be greater than 1 second.
+     * If not specified, the default value is 100 seconds.
      */
     timeoutInMs?: number;
 }

src/common/utils.ts

@@ -49,4 +49,4 @@ export function getUrlHost(url: string) {
 
 export function instanceOfTokenCredential(obj: unknown) {
     return obj && typeof obj === "object" && "getToken" in obj && typeof obj.getToken === "function";
-}
+}

src/featureManagement/FeatureFlagOptions.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { FeatureFlagRefreshOptions } from "../RefreshOptions.js";
+import { FeatureFlagRefreshOptions } from "../refresh/refreshOptions.js";
 import { SettingSelector } from "../types.js";
 
 /**

src/keyvault/AzureKeyVaultKeyValueAdapter.ts

@@ -50,9 +50,9 @@ export class AzureKeyVaultKeyValueAdapter implements IKeyValueAdapter {
     }
 
     /**
-     * 
+     *
      * @param vaultUrl - The url of the key vault.
-     * @returns 
+     * @returns
      */
     #getSecretClient(vaultUrl: URL): SecretClient | undefined {
         if (this.#secretClients === undefined) {

src/RefreshOptions.ts renamed to src/refresh/refreshOptions.ts

@@ -1,44 +1,44 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-
-import { WatchedSetting } from "./WatchedSetting.js";
-
-export const DEFAULT_REFRESH_INTERVAL_IN_MS = 30 * 1000;
-export const MIN_REFRESH_INTERVAL_IN_MS = 1 * 1000;
-
-export interface RefreshOptions {
-    /**
-     * Specifies whether the provider should automatically refresh when the configuration is changed.
-     */
-    enabled: boolean;
-
-    /**
-     * Specifies the minimum time that must elapse before checking the server for any new changes.
-     * Default value is 30 seconds. Must be greater than 1 second.
-     * Any refresh operation triggered will not update the value for a key until after the interval.
-     */
-    refreshIntervalInMs?: number;
-
-    /**
-     * One or more configuration settings to be watched for changes on the server.
-     * Any modifications to watched settings will refresh all settings loaded by the configuration provider when refresh() is called.
-     *
-     * @remarks
-     * If no watched setting is specified, all configuration settings will be watched.
-     */
-    watchedSettings?: WatchedSetting[];
-}
-
-export interface FeatureFlagRefreshOptions {
-    /**
-     * Specifies whether the provider should automatically refresh all feature flags if any feature flag changes.
-     */
-    enabled: boolean;
-
-    /**
-     * Specifies the minimum time that must elapse before checking the server for any new changes.
-     * Default value is 30 seconds. Must be greater than 1 second.
-     * Any refresh operation triggered will not update the value for a key until after the interval.
-     */
-    refreshIntervalInMs?: number;
-}
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { WatchedSetting } from "../WatchedSetting.js";
+
+export const DEFAULT_REFRESH_INTERVAL_IN_MS = 30 * 1000;
+export const MIN_REFRESH_INTERVAL_IN_MS = 1 * 1000;
+
+export interface RefreshOptions {
+    /**
+     * Specifies whether the provider should automatically refresh when the configuration is changed.
+     */
+    enabled: boolean;
+
+    /**
+     * Specifies the minimum time that must elapse before checking the server for any new changes.
+     * Default value is 30 seconds. Must be greater than 1 second.
+     * Any refresh operation triggered will not update the value for a key until after the interval.
+     */
+    refreshIntervalInMs?: number;
+
+    /**
+     * One or more configuration settings to be watched for changes on the server.
+     * Any modifications to watched settings will refresh all settings loaded by the configuration provider when refresh() is called.
+     *
+     * @remarks
+     * If no watched setting is specified, all configuration settings will be watched.
+     */
+    watchedSettings?: WatchedSetting[];
+}
+
+export interface FeatureFlagRefreshOptions {
+    /**
+     * Specifies whether the provider should automatically refresh all feature flags if any feature flag changes.
+     */
+    enabled: boolean;
+
+    /**
+     * Specifies the minimum time that must elapse before checking the server for any new changes.
+     * Default value is 30 seconds. Must be greater than 1 second.
+     * Any refresh operation triggered will not update the value for a key until after the interval.
+     */
+    refreshIntervalInMs?: number;
+}

test/load.test.ts

@@ -359,7 +359,7 @@ describe("load", function () {
      * When constructConfigurationObject() is called, it first constructs from key "app5.settings.fontColor" and then from key "app5.settings".
      * An error will be thrown when constructing from key "app5.settings" because there is ambiguity between the two keys.
      */
-    it("Edge case 1: Hierarchical key-value pairs with overlapped key prefix.", async () => {
+    it("Edge case 2: Hierarchical key-value pairs with overlapped key prefix.", async () => {
         const connectionString = createMockedConnectionString();
         const settings = await load(connectionString, {
             selectors: [{