@azure/app-configuration-importer 1.1.3-preview → 3.0.0-preview

package/dist/index.js

@@ -417,34 +417,6 @@
         'default': _tslib
     });
 
-    // Copyright (c) Microsoft Corporation.
-    // Licensed under the MIT license.
-    /**
-     * Enums of configuration Format.
-     */
-    exports.ConfigurationFormat = void 0;
-    (function (ConfigurationFormat) {
-        ConfigurationFormat[ConfigurationFormat["Json"] = 0] = "Json";
-        ConfigurationFormat[ConfigurationFormat["Properties"] = 1] = "Properties";
-        ConfigurationFormat[ConfigurationFormat["Yaml"] = 2] = "Yaml";
-    })(exports.ConfigurationFormat || (exports.ConfigurationFormat = {}));
-    /**
-     * Enums of configuration Profile.
-     */
-    exports.ConfigurationProfile = void 0;
-    (function (ConfigurationProfile) {
-        ConfigurationProfile[ConfigurationProfile["Default"] = 0] = "Default";
-        ConfigurationProfile[ConfigurationProfile["KvSet"] = 1] = "KvSet";
-    })(exports.ConfigurationProfile || (exports.ConfigurationProfile = {}));
-    /**
-     * Enums of import mode.
-     */
-    exports.ImportMode = void 0;
-    (function (ImportMode) {
-        ImportMode[ImportMode["All"] = 0] = "All";
-        ImportMode[ImportMode["IgnoreMatch"] = 1] = "IgnoreMatch";
-    })(exports.ImportMode || (exports.ImportMode = {}));
-
     // Copyright (c) Microsoft Corporation.
     // Licensed under the MIT license.
     /**
@@ -498,6 +470,75 @@
         }
     }
 
+    // Copyright (c) Microsoft Corporation.
+    /**
+     * A ConfigurationSettingsSource that wraps pre-calculated configuration changes.
+     *
+     * Use this class to import changes that were previously obtained via GetConfigurationChanges().
+     *
+     * Example usage:
+     * ```ts
+     * // First, get the configuration changes
+     * const changes = await importer.GetConfigurationChanges(source);
+     *
+     * // Import the pre-calculated changes
+     * const changesSource = new ConfigurationChangesSource(changes);
+     * await importer.Import(changesSource, { timeout: 60 });
+     * ```
+     */
+    class ConfigurationChangesSource {
+        constructor(configurationChanges, filterOptions) {
+            if (filterOptions && Object.keys(filterOptions).length > 0) {
+                throw new ArgumentError("FilterOptions are not supported for ConfigurationChangesSource.");
+            }
+            this.configurationChanges = configurationChanges;
+        }
+        /**
+           * @inheritdoc
+           */
+        async GetConfigurationSettings() {
+            return this.configurationChanges;
+        }
+    }
+
+    // Copyright (c) Microsoft Corporation.
+    // Licensed under the MIT license.
+    /**
+     * Enums of configuration Format.
+     */
+    exports.ConfigurationFormat = void 0;
+    (function (ConfigurationFormat) {
+        ConfigurationFormat[ConfigurationFormat["Json"] = 0] = "Json";
+        ConfigurationFormat[ConfigurationFormat["Properties"] = 1] = "Properties";
+        ConfigurationFormat[ConfigurationFormat["Yaml"] = 2] = "Yaml";
+    })(exports.ConfigurationFormat || (exports.ConfigurationFormat = {}));
+    /**
+     * Enums of configuration Profile.
+     */
+    exports.ConfigurationProfile = void 0;
+    (function (ConfigurationProfile) {
+        ConfigurationProfile[ConfigurationProfile["Default"] = 0] = "Default";
+        ConfigurationProfile[ConfigurationProfile["KvSet"] = 1] = "KvSet";
+    })(exports.ConfigurationProfile || (exports.ConfigurationProfile = {}));
+    /**
+     * Enums of import mode.
+     */
+    exports.ImportMode = void 0;
+    (function (ImportMode) {
+        ImportMode[ImportMode["All"] = 0] = "All";
+        ImportMode[ImportMode["IgnoreMatch"] = 1] = "IgnoreMatch";
+    })(exports.ImportMode || (exports.ImportMode = {}));
+    /**
+     * Enums of change type for configuration settings changes
+     */
+    exports.ChangeType = void 0;
+    (function (ChangeType) {
+        ChangeType[ChangeType["None"] = 0] = "None";
+        ChangeType[ChangeType["Create"] = 1] = "Create";
+        ChangeType[ChangeType["Delete"] = 2] = "Delete";
+        ChangeType[ChangeType["Update"] = 3] = "Update";
+    })(exports.ChangeType || (exports.ChangeType = {}));
+
     function isFunction(value) {
         return typeof value === 'function';
     }
@@ -18995,31 +19036,88 @@
             this.configurationClient = configurationClient;
         }
         /**
-         * Import source settings into the Azure App Configuration service
+         * Import settings into the Azure App Configuration service.
          *
          * Example usage:
          * ```ts
          * const fileData = fs.readFileSync("mylocalPath").toString();
-         * const result = await asyncClient.Import(new StringConfigurationSettingsSource({data:fileData, format: ConfigurationFormat.Json}));
+         * const source = new StringConfigurationSettingsSource({data:fileData, format: ConfigurationFormat.Json});
+         * await importer.Import(source, { timeout: 60 });
+         * ```
+         *
+         * @param configurationSettingsSource - A ConfigurationSettingsSource instance.
+         * @param options - Import options including timeout, progress callback, strict mode, and import mode.
+         * @returns Promise<void>
+         */
+        async Import(configurationSettingsSource, options) {
+            if (configurationSettingsSource instanceof ConfigurationChangesSource) {
+                // When using ConfigurationChanges, strict and importMode parameters are not applicable
+                if ((options === null || options === void 0 ? void 0 : options.strict) || (options === null || options === void 0 ? void 0 : options.importMode)) {
+                    throw new ArgumentError("Parameters 'strict' and 'importMode' are not applicable when importing pre-calculated changes.");
+                }
+            }
+            // Generate correlationRequestId for operations in the same activity
+            const customCorrelationRequestId = v4();
+            const customHeadersOption = {
+                requestOptions: {
+                    customHeaders: {
+                        [Constants.CorrelationRequestIdHeader]: customCorrelationRequestId
+                    }
+                }
+            };
+            const configurationChanges = await this.GetConfigurationChanges(configurationSettingsSource, options === null || options === void 0 ? void 0 : options.strict, options === null || options === void 0 ? void 0 : options.importMode, customHeadersOption);
+            const settingsToWrite = configurationChanges
+                .filter(c => (c.changeType === exports.ChangeType.Create || c.changeType === exports.ChangeType.Update || c.changeType === exports.ChangeType.None) && c.newValue)
+                .map(c => c.newValue);
+            const settingsToDelete = configurationChanges
+                .filter(c => c.changeType === exports.ChangeType.Delete && c.currentValue)
+                .map(c => c.currentValue);
+            return await this.applyUpdatesToServer(settingsToWrite, settingsToDelete, options.timeout, customHeadersOption, options.progressCallback);
+        }
+        /**
+         * Get configuration changes between source settings and existing settings in Azure App Configuration service without applying any changes
+         *
+         * Example usage:
+         * ```ts
+         * const fileData = fs.readFileSync("mylocalPath").toString();
+         * const configurationChanges = await client.GetConfigurationChanges(
+         *   new StringConfigurationSettingsSource({data:fileData, format: ConfigurationFormat.Json}),
+         *   false,
+         *   ImportMode.All,
+         *   options
+         * );
          * ```
          * @param configSettingsSource - A ConfigurationSettingsSource instance.
-         * @param strict - Use strict mode or not.
-         * @param timeout - Seconds of entire import progress timeout
-         * @param progressCallback - Callback for report the progress of import
-         * @param importMode - Determines the behavior when importing key-values. The default value, 'All' will import all key-values in the input file to App Configuration. 'Ignore-Match' will only import settings that have no matching key-value in App Configuration.
-         * @param dryRun - When dry run is enabled, no updates  will be performed to App Configuration. Instead, any updates that would have been performed in a normal run will be printed to the console for review
+         * @param strict - Use strict mode to delete settings not in source.
+         * @param importMode - Determines the behavior when analyzing key-values.
+         *  'All' will include all key-values.
+         *  'Ignore-Match' will exclude settings that have matching key-values in App Configuration.
+         * @param customHeadersOption - Custom headers for the operation.
+         * @returns Array of ConfigurationSettingChange objects representing the changes
          */
-        async Import(configSettingsSource, timeout, strict = false, progressCallback, importMode, dryRun) {
+        async GetConfigurationChanges(configSettingsSource, strict = false, importMode = exports.ImportMode.IgnoreMatch, customHeadersOption) {
             var _a, e_1, _b, _c;
-            if (importMode == undefined) {
-                importMode = exports.ImportMode.IgnoreMatch;
+            this.validateImportMode(importMode);
+            // Generate correlationRequestId for operations in the same activity
+            if (!customHeadersOption) {
+                const customCorrelationRequestId = v4();
+                customHeadersOption = {
+                    requestOptions: {
+                        customHeaders: {
+                            [Constants.CorrelationRequestIdHeader]: customCorrelationRequestId
+                        }
+                    }
+                };
             }
-            if (dryRun == undefined) {
-                dryRun = false;
+            const configSettingsResult = await configSettingsSource.GetConfigurationSettings();
+            // If the source returns ConfigurationChanges (e.g., ConfigurationChangesSource), 
+            // return them directly without further processing since changes are already calculated
+            if (this.isConfigurationChanges(configSettingsResult)) {
+                return configSettingsResult;
             }
-            this.validateImportMode(importMode);
-            const configSettings = await configSettingsSource.GetConfigurationSettings();
-            const configurationSettingToDelete = [];
+            const configSettings = configSettingsResult;
+            const configurationChanges = [];
+            const configurationSettingToAdd = [];
             const srcKeyLabelLookUp = {};
             configSettings.forEach((config) => {
                 if (!srcKeyLabelLookUp[config.key]) {
@@ -19027,72 +19125,70 @@
                 }
                 srcKeyLabelLookUp[config.key][config.label || ""] = true;
             });
-            // generate correlationRequestId for operations in the same activity
-            const customCorrelationRequestId = v4();
-            const customHeadersOption = {
-                requestOptions: {
-                    customHeaders: {
-                        [Constants.CorrelationRequestIdHeader]: customCorrelationRequestId
-                    }
-                }
-            };
-            if (strict || importMode == exports.ImportMode.IgnoreMatch) {
-                try {
-                    for (var _d = true, _e = __asyncValues(this.configurationClient.listConfigurationSettings(Object.assign(Object.assign({}, configSettingsSource.FilterOptions), customHeadersOption))), _f; _f = await _e.next(), _a = _f.done, !_a;) {
-                        _c = _f.value;
-                        _d = false;
-                        try {
-                            const existing = _c;
-                            const isKeyLabelPresent = srcKeyLabelLookUp[existing.key] && srcKeyLabelLookUp[existing.key][existing.label || ""];
-                            if (strict && !isKeyLabelPresent) {
-                                configurationSettingToDelete.push(existing);
+            configurationSettingToAdd.push(...configSettings);
+            try {
+                for (var _d = true, _e = __asyncValues(this.configurationClient.listConfigurationSettings(Object.assign(Object.assign({}, configSettingsSource.FilterOptions), customHeadersOption))), _f; _f = await _e.next(), _a = _f.done, !_a;) {
+                    _c = _f.value;
+                    _d = false;
+                    try {
+                        const existing = _c;
+                        const isKeyLabelPresent = srcKeyLabelLookUp[existing.key] && srcKeyLabelLookUp[existing.key][existing.label || ""];
+                        if (strict && !isKeyLabelPresent) {
+                            configurationChanges.push({
+                                changeType: exports.ChangeType.Delete,
+                                currentValue: existing,
+                                newValue: null
+                            });
+                        }
+                        const incoming = configSettings.find(configSetting => configSetting.key == existing.key && configSetting.label === existing.label);
+                        if (incoming) {
+                            // Remove from add list since it already exists
+                            configurationSettingToAdd.splice(configurationSettingToAdd.indexOf(incoming), 1);
+                            if (!isConfigSettingEqual(incoming, existing)) {
+                                configurationChanges.push({
+                                    changeType: exports.ChangeType.Update,
+                                    currentValue: existing,
+                                    newValue: incoming
+                                });
                             }
-                            if (importMode == exports.ImportMode.IgnoreMatch) {
-                                const incoming = configSettings.find(configSetting => configSetting.key == existing.key &&
-                                    configSetting.label == existing.label);
-                                if (incoming && isConfigSettingEqual(incoming, existing)) {
-                                    configSettings.splice(configSettings.indexOf(incoming), 1);
-                                }
+                            else if (importMode === exports.ImportMode.All) {
+                                configurationChanges.push({
+                                    changeType: exports.ChangeType.None,
+                                    currentValue: existing,
+                                    newValue: incoming
+                                });
                             }
                         }
-                        finally {
-                            _d = true;
-                        }
                     }
-                }
-                catch (e_1_1) { e_1 = { error: e_1_1 }; }
-                finally {
-                    try {
-                        if (!_d && !_a && (_b = _e.return)) await _b.call(_e);
+                    finally {
+                        _d = true;
                     }
-                    finally { if (e_1) throw e_1.error; }
                 }
             }
-            if (dryRun) {
-                this.printUpdatesToConsole(configSettings, configurationSettingToDelete);
-            }
-            else {
-                await this.applyUpdatesToServer(configSettings, configurationSettingToDelete, timeout, customHeadersOption, progressCallback);
-            }
-        }
-        printUpdatesToConsole(settingsToAdd, settingsToDelete) {
-            console.log("The following settings will be removed from App Configuration:");
-            for (const setting of settingsToDelete) {
-                console.log(JSON.stringify({ key: setting.key, label: setting.label, contentType: setting.contentType, tags: setting.tags }));
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = _e.return)) await _b.call(_e);
+                }
+                finally { if (e_1) throw e_1.error; }
             }
-            console.log("\nThe following settings will be written to App Configuration:");
-            for (const setting of settingsToAdd) {
-                console.log(JSON.stringify({ key: setting.key, label: setting.label, contentType: setting.contentType, tags: setting.tags }));
+            for (const setting of configurationSettingToAdd) {
+                configurationChanges.push({
+                    changeType: exports.ChangeType.Create,
+                    currentValue: null,
+                    newValue: setting
+                });
             }
+            return configurationChanges;
         }
-        async applyUpdatesToServer(settingsToAdd, settingsToDelete, timeout, options, progressCallback) {
+        async applyUpdatesToServer(settingsToPut, settingsToDelete, timeout, options, progressCallback) {
             const deleteTaskManager = this.newAdaptiveTaskManager((setting) => this.configurationClient.deleteConfigurationSetting(setting, options), settingsToDelete);
             const startTime = Date.now();
             await this.executeTasksWithTimeout(deleteTaskManager, timeout);
             const endTime = Date.now();
             const deleteTimeConsumed = (endTime - startTime) / 1000;
             timeout -= deleteTimeConsumed;
-            const importTaskManager = this.newAdaptiveTaskManager((setting) => this.configurationClient.setConfigurationSetting(setting, options), settingsToAdd);
+            const importTaskManager = this.newAdaptiveTaskManager((setting) => this.configurationClient.setConfigurationSetting(setting, options), settingsToPut);
             await this.executeTasksWithTimeout(importTaskManager, timeout, progressCallback);
         }
         newAdaptiveTaskManager(task, configurationSettings) {
@@ -19123,6 +19219,22 @@
                 throw new ArgumentError("Only options supported for Import Mode are 'All' and 'Ignore-Match'.");
             }
         }
+        /**
+         * Type guard to detect a ConfigurationChanges object.
+         * @internal
+         */
+        isConfigurationChanges(obj) {
+            if (!Array.isArray(obj)) {
+                return false;
+            }
+            // Validate it's an array of ConfigurationSettingChange objects
+            return obj.every(item => item &&
+                typeof item === "object" &&
+                "changeType" in item &&
+                "currentValue" in item &&
+                "newValue" in item &&
+                Object.values(exports.ChangeType).includes(item.changeType));
+        }
     }
 
     /*! js-yaml 4.1.0 https://github.com/nodeca/js-yaml @license MIT */
@@ -29452,6 +29564,7 @@
     exports.AppConfigurationImporter = AppConfigurationImporter;
     exports.ArgumentError = ArgumentError;
     exports.ArgumentNullError = ArgumentNullError;
+    exports.ConfigurationChangesSource = ConfigurationChangesSource;
     exports.IterableConfigurationSettingsSource = IterableConfigurationSettingsSource;
     exports.OperationTimeoutError = OperationTimeoutError;
     exports.ParseError = ParseError;