@azure/app-configuration-importer 1.0.0-preview → 1.0.1-preview

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,67 @@
+# Azure App Configuration - JavaScript Importer
+
+The [Azure App Configuration](https://docs.microsoft.com/azure/azure-app-configuration/overview) Importer for JavaScript enables developers to import their configuration settings from a configuration sources to Azure App Configuration service.
+
+Key links:
+
+- [Source code](https://github.com/Azure/AppConfiguration-JavaScriptImporter/tree/main/libraries/azure-app-configuration-importer)
+- [Package (NPM)](https://www.npmjs.com/package/@azure/app-configuration-importer)
+- [Product documentation](https://docs.microsoft.com/azure/azure-app-configuration/)
+- [Examples](https://github.com/Azure/AppConfiguration-JavaScriptImporter/tree/main/libraries/azure-app-configuration-importer/examples)
+
+## Getting started
+
+### Currently supported environments
+
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
+- Latest versions of Safari, Chrome, Edge, and Firefox.
+
+### Prerequisites
+
+- An [Azure Subscription](https://azure.microsoft.com)
+- An [App Configuration store](https://learn.microsoft.com/azure/azure-app-configuration/quickstart-azure-app-configuration-create?tabs=azure-portal) resource
+
+### Install the package
+
+```bash
+npm install @azure/app-configuration-importer
+```
+
+### Use the API
+
+```ts
+   import { AppConfigurationImporter, StringConfigurationSettingsSource } from "@azure/app-configuration-importer";
+
+   const client = new AppConfigurationClient("<app-configuration-connection-string>");
+   const appConfigurationImporterClient = new AppConfigurationImporter(client);
+
+   // Import settings
+   const result = await appConfigurationImporterClient.Import(new StringConfigurationSettingsSource({data: "{\"app:Settings:FontSize\": \"45\"}", format: ConfigurationFormat.Json}));
+```
+
+
+## Examples
+
+See code snippets under [examples/](./examples/) folder.
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
+trademarks or logos is subject to and must follow 
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos are subject to those third-party's policies.

package/dist/index.js

@@ -1,8 +1,12 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('stream')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'stream'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["azure-app-configuration-importer"] = {}, global.stream));
-})(this, (function (exports, stream) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('node:crypto'), require('stream')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'node:crypto', 'stream'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["azure-app-configuration-importer"] = {}, global.crypto, global.stream));
+})(this, (function (exports, crypto, stream) { 'use strict';
+
+    function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+    var crypto__default = /*#__PURE__*/_interopDefaultLegacy(crypto);
 
     /******************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -18157,7 +18161,8 @@
             "__",
             "/",
             ":"
-        ]
+        ],
+        CorrelationRequestIdHeader: "x-ms-correlation-request-id"
     };
 
     // Copyright (c) Microsoft Corporation.
@@ -18283,6 +18288,59 @@
         };
     }
 
+    /**
+     * Convert array of 16 byte values to UUID string format of the form:
+     * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+     */
+    const byteToHex = [];
+    for (let i = 0; i < 256; ++i) {
+      byteToHex.push((i + 0x100).toString(16).slice(1));
+    }
+    function unsafeStringify(arr, offset = 0) {
+      // Note: Be careful editing this code!  It's been tuned for performance
+      // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
+      //
+      // Note to future-self: No, you can't remove the `toLowerCase()` call.
+      // REF: https://github.com/uuidjs/uuid/pull/677#issuecomment-1757351351
+      return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
+    }
+
+    const rnds8Pool = new Uint8Array(256); // # of random values to pre-allocate
+    let poolPtr = rnds8Pool.length;
+    function rng() {
+      if (poolPtr > rnds8Pool.length - 16) {
+        crypto__default["default"].randomFillSync(rnds8Pool);
+        poolPtr = 0;
+      }
+      return rnds8Pool.slice(poolPtr, poolPtr += 16);
+    }
+
+    var native = {
+      randomUUID: crypto__default["default"].randomUUID
+    };
+
+    function v4(options, buf, offset) {
+      if (native.randomUUID && !buf && !options) {
+        return native.randomUUID();
+      }
+      options = options || {};
+      const rnds = options.random || (options.rng || rng)();
+
+      // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
+      rnds[6] = rnds[6] & 0x0f | 0x40;
+      rnds[8] = rnds[8] & 0x3f | 0x80;
+
+      // Copy bytes to buffer, if provided
+      if (buf) {
+        offset = offset || 0;
+        for (let i = 0; i < 16; ++i) {
+          buf[offset + i] = rnds[i];
+        }
+        return buf;
+      }
+      return unsafeStringify(rnds);
+    }
+
     // Copyright (c) Microsoft Corporation.
     /**
      * Entrypoint class for sync configuration
@@ -18328,9 +18386,18 @@
                 }
                 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(configSettingsSource.FilterOptions)), _f; _f = await _e.next(), _a = _f.done, !_a;) {
+                    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 {
@@ -18364,7 +18431,7 @@
                 this.printUpdatesToConsole(configSettings, configurationSettingToDelete);
             }
             else {
-                await this.applyUpdatesToServer(configSettings, configurationSettingToDelete, timeout, progressCallback);
+                await this.applyUpdatesToServer(configSettings, configurationSettingToDelete, timeout, customHeadersOption, progressCallback);
             }
         }
         printUpdatesToConsole(settingsToAdd, settingsToDelete) {
@@ -18377,14 +18444,14 @@
                 console.log(JSON.stringify({ key: setting.key, label: setting.label, contentType: setting.contentType, tags: setting.tags }));
             }
         }
-        async applyUpdatesToServer(settingsToAdd, settingsToDelete, timeout, progressCallback) {
-            const deleteTaskManager = this.newAdaptiveTaskManager((setting) => this.configurationClient.deleteConfigurationSetting(setting), settingsToDelete);
+        async applyUpdatesToServer(settingsToAdd, 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), settingsToAdd);
+            const importTaskManager = this.newAdaptiveTaskManager((setting) => this.configurationClient.setConfigurationSetting(setting, options), settingsToAdd);
             await this.executeTasksWithTimeout(importTaskManager, timeout, progressCallback);
         }
         newAdaptiveTaskManager(task, configurationSettings) {