@azure/api-management-custom-widgets-tools 1.0.0-beta.1

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,51 @@
+# Tools for working with custom widgets of Developer portal of Azure API Management service
+
+This repository is managed by the [Microsoft Azure API Management](https://aka.ms/apimrocks) team and contains the
+source code of tools for development of custom widgets for the Developer portal. Refer to
+the [official Azure documentation](https://aka.ms/apimdocs/portal/customwidgets) for more information and instructions.
+
+[Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/apimanagement/api-management-custom-widgets-scaffolder/) |
+[Package (NPM)](https://www.npmjs.com/package/@azure/api-management-custom-widgets-scaffolder) |
+[Product documentation](https://aka.ms/apimdocs/portal/)
+
+## Getting started
+
+### Currently supported environments
+
+- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- Latest versions of Safari, Chrome, Edge, and Firefox
+
+### Prerequisites
+
+- An [Azure Subscription](https://azure.microsoft.com)
+- An [API Management](https://aka.ms/apimdocs/) resource
+- Active [Developer portal](https://aka.ms/apimdocs/portal/)
+- A project of a custom widget generated by the [`@azure/api-management-custom-widgets-scaffolder` package](https://www.npmjs.com/package/@azure/api-management-custom-widgets-scaffolder)
+
+### Create your first Custom widget
+
+Navigate to [Custom widgets for Developer portal documentation](https://aka.ms/apimdocs/portal/customwidgets) to learn how to create and manage Custom widgets.
+
+## Key concepts
+
+Package provides tools for communication between scaffolded widgets and the Developer Portal
+
+This package should not be confused with `@azure/api-management-custom-widgets-scaffolder` package, which contains template files and a function to generate Custom widgets for the API Management services' Developer Portal.
+
+## Contributing
+
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
+
+To execute the tests you'll need to run:
+
+1. `rush update`
+2. `rush build -t @azure/api-management-custom-widgets-tools`
+3. `cd sdk\apimanagement\api-management-custom-widgets-tools`
+4. `npm run test`
+
+View our [tests](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/apimanagement/api-management-custom-widgets-scaffolder/test)
+folder for more details.
+
+## Related projects
+
+- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)

package/dist/index.js

@@ -0,0 +1,344 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var storageBlob = require('@azure/storage-blob');
+var mime = require('mime');
+var fs = require('fs');
+var identity = require('@azure/identity');
+var coreClient = require('@azure-rest/core-client');
+var path = require('path');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var mime__default = /*#__PURE__*/_interopDefaultLegacy(mime);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Key for a search param, from which editor data will be loaded from.
+ */
+const APIM_EDITOR_DATA_KEY = "editorData";
+/**
+ * Key for a post message object, it's used to propagate changes from editor to the DevPortal. Used to prevent interference with other applications.
+ */
+const APIM_ON_CHANGE_MESSAGE_KEY = "customInputValueChangedMSAPIM";
+/**
+ * Key for a post message object, it's used to request and send secrets - token and user id, from the DevPortal. Used to prevent interference with other applications.
+ */
+const APIM_ASK_FOR_SECRETS_MESSAGE_KEY = "askForSecretsMSAPIM";
+function parseWidgetData(urlSearchParams) {
+    var _a;
+    try {
+        const urlEditorParams = JSON.parse(decodeURIComponent((_a = urlSearchParams.get(APIM_EDITOR_DATA_KEY)) !== null && _a !== void 0 ? _a : ""));
+        // if (!("origin" in urlEditorParams)) {
+        //   console.error(
+        //     "Could not get 'origin' from the search params of the URL:\n" + self.location.href
+        //   );
+        // }
+        return urlEditorParams;
+    }
+    catch (e) {
+        console.error(`Could not get '${APIM_EDITOR_DATA_KEY}' from the search params of the URL:\n` +
+            self.location, e);
+        return { values: {}, environment: "error", instanceId: "error" };
+    }
+}
+function getWidgetDataPure(urlSearchParams) {
+    return parseWidgetData(urlSearchParams);
+}
+/**
+ * Function to get all data related to the widget including technical values not expected to be needed in most cases.
+ * Intended mostly for internal use, API might change. Consider using getValues or getEditorValues instead.
+ */
+function getWidgetData() {
+    return getWidgetDataPure(new URLSearchParams(self.location.search));
+}
+function getEditorValuesPure(urlSearchParams) {
+    return getWidgetDataPure(urlSearchParams).values;
+}
+/**
+ * Function to get values you've set in the admin editor window.
+ */
+function getEditorValues() {
+    return getEditorValuesPure(new URLSearchParams(self.location.search));
+}
+function getValuesPure(valuesDefault, urlSearchParams) {
+    const values = Object.assign({}, valuesDefault); // set Obj to contain all possible values and prefill default value
+    const urlValues = parseWidgetData(urlSearchParams).values;
+    Object.keys(values).forEach((key) => {
+        const value = urlValues[key];
+        if (value != null && value !== "")
+            values[key] = value; // if value is specified in the URL, replace the default value
+    });
+    return values;
+}
+/**
+ * Function to get values you've set in the admin editor window. Undefined/empty values are replaced with default values.
+ *
+ * @param valuesDefault - object with your default values to use, just import valuesDefault object from values.ts folder
+ */
+function getValues(valuesDefault) {
+    return getValuesPure(valuesDefault, new URLSearchParams(self.location.search));
+}
+/**
+ * The onChange function itself with 'origin' provided as a param.
+ *
+ * @param origin - web content's origin (URL) of your Dev Portal to send changes to
+ * @param instanceId - ID of this particular instance of the widget
+ * @param values - values that changed
+ */
+function onChangeWithOrigin(origin, instanceId, values) {
+    Object.entries(values).forEach(([key, value]) => {
+        self.parent.postMessage({ [APIM_ON_CHANGE_MESSAGE_KEY]: { key, value, instanceId } }, origin);
+    });
+}
+/**
+ * Build onChange function, which you can use, to send changed data from the editor.
+ */
+function buildOnChange() {
+    const { instanceId } = getWidgetData();
+    return (values) => onChangeWithOrigin("*", instanceId, values);
+}
+/**
+ * Request secrets - token & userId, from the Dev portal parent window.
+ *
+ * @param targetModule - is the function invoke from the main "app" window or the admin "editor"?
+ */
+async function askForSecrets(targetModule) {
+    let receiveSecrets;
+    const promise = new Promise((resolve, reject) => {
+        const { instanceId, environment } = getWidgetData();
+        receiveSecrets = ({ data }) => {
+            if (!(APIM_ASK_FOR_SECRETS_MESSAGE_KEY in data))
+                return;
+            const secrets = data[APIM_ASK_FOR_SECRETS_MESSAGE_KEY];
+            if (typeof secrets !== "object" || !("managementApiUrl" in secrets)) {
+                reject("Secrets send by Dev Portal are invalid");
+            }
+            resolve(secrets);
+        };
+        self.addEventListener("message", receiveSecrets);
+        const message = {
+            [APIM_ASK_FOR_SECRETS_MESSAGE_KEY]: {
+                instanceId,
+                origin: self.location.origin,
+                targetModule,
+            },
+        };
+        if (targetModule === "app" && environment === "development") {
+            self.parent.parent.postMessage(message, "*");
+        }
+        else {
+            self.parent.postMessage(message, "*");
+        }
+    });
+    return promise.finally(() => self.removeEventListener("message", receiveSecrets));
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/** root of the blob storage folder */
+const BLOB_ROOT = "custom-widgets";
+/** name of the blob storage folder with widget implementation */
+const BLOB_DATA_FOLDER = "data";
+/** name of the blob storage folder with widget configs */
+const BLOB_CONFIGS_FOLDER = "configs";
+/** name of the configuration file */
+const APIM_CONFIG_FILE_NAME = "config.msapim.json";
+/**
+ * Generate relative path for widgets' data on the blob storage
+ *
+ * @param name - name of the widget
+ */
+function buildBlobDataPath(name) {
+    return `${BLOB_ROOT}/${BLOB_DATA_FOLDER}/${name}/`;
+}
+/**
+ * Generate relative path for widgets' config on the blob storage
+ *
+ * @param name - name of the widget
+ */
+function buildBlobConfigPath(name) {
+    return `${BLOB_ROOT}/${BLOB_CONFIGS_FOLDER}/${name}/${APIM_CONFIG_FILE_NAME}`;
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * A service wrapping ContainerClient class to simplify blob handling
+ */
+class CustomWidgetBlobService {
+    /**
+     * @param blobStorageUrl - blob storage SAS URL
+     * @param name - name of the custom widget to be taken care of
+     */
+    constructor(blobStorageUrl, name) {
+        const container = "content";
+        const blobServiceClient = new storageBlob.BlobServiceClient(blobStorageUrl.replace(`/${container}`, ""));
+        this.containerClient = blobServiceClient.getContainerClient(container);
+        this.name = name;
+        this.pathWidget = buildBlobDataPath(name);
+        this.pathConfig = buildBlobConfigPath(name);
+    }
+    extractFileName(path) {
+        return path.split("/").pop();
+    }
+    async blobUpload(absolutePath, content) {
+        const fileName = this.extractFileName(absolutePath);
+        if (!fileName)
+            throw new Error("a fileName was not found in the absolutePath");
+        return this.containerClient.getBlockBlobClient(absolutePath).upload(content, content.length, {
+            blobHTTPHeaders: { blobContentType: mime__default["default"].getType(fileName) || "application/octet-stream" },
+        });
+    }
+    async jsonUpload(absolutePath, json) {
+        return this.blobUpload(absolutePath, Buffer.from(JSON.stringify(json)));
+    }
+    async blobDownload(absolutePath) {
+        return this.containerClient.getBlockBlobClient(absolutePath).downloadToBuffer();
+    }
+    async dirDelete(absolutePath) {
+        var e_1, _a;
+        try {
+            for (var _b = tslib.__asyncValues(await this.containerClient.listBlobsFlat({ prefix: absolutePath })), _c; _c = await _b.next(), !_c.done;) {
+                const blob = _c.value;
+                await this.containerClient.deleteBlob(blob.name);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) await _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    }
+    async uploadWidgetDataFile(file, content) {
+        return this.blobUpload(this.pathWidget + file, content);
+    }
+    async cleanDataDir() {
+        return this.dirDelete(this.pathWidget);
+    }
+    async getConfig() {
+        const buffer = await this.blobDownload(this.pathConfig);
+        return JSON.parse(buffer.toString());
+    }
+    async uploadConfig(config) {
+        return this.jsonUpload(this.pathConfig, config);
+    }
+}
+var CustomWidgetBlobService$1 = CustomWidgetBlobService;
+
+// Copyright (c) Microsoft Corporation.
+async function getAccessToken(managementApiEndpoint) {
+    const credentials = new identity.InteractiveBrowserCredential();
+    const scope = `${managementApiEndpoint}/user_impersonation`;
+    const { token } = await credentials.getToken(scope);
+    return `Bearer ${token}`;
+}
+/**
+ * Function to get storage SAS URL.
+ *
+ * @returns storage SAS URL
+ */
+async function getStorageSasUrl({ managementApiEndpoint, resourceId, apiVersion = "2019-01-01", tokenOverride, }) {
+    var _a;
+    const httpClient = coreClient.getClient(`${managementApiEndpoint}/${resourceId}`, { apiVersion });
+    const response = await httpClient
+        .pathUnchecked(`/portalSettings/mediaContent/listSecrets?apiVersion=${apiVersion}`) // TODO
+        .post({
+        headers: {
+            "If-Match": "*",
+            "Content-Type": "application/json",
+            Authorization: tokenOverride !== null && tokenOverride !== void 0 ? tokenOverride : (await getAccessToken(managementApiEndpoint)),
+        },
+    });
+    if (!((_a = response === null || response === void 0 ? void 0 : response.body) === null || _a === void 0 ? void 0 : _a.containerSasUrl))
+        throw new Error("Could not get storage SAS URL");
+    return response.body.containerSasUrl;
+}
+
+// Copyright (c) Microsoft Corporation.
+function readdir(dir, root) {
+    const results = [];
+    fs__default["default"].readdirSync(root + dir).forEach((file) => {
+        const stat = fs__default["default"].statSync(root + dir + path__default["default"].sep + file);
+        if (stat && stat.isDirectory()) {
+            results.push(...readdir(dir + file + path__default["default"].sep, root));
+        }
+        else {
+            results.push(dir + file);
+        }
+    });
+    return results;
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Deploys everything from /dist folder to the API Management DevPortals' blob storage.
+ *
+ * @param serviceInformation - service information for deployment
+ * @param name - name of the widget to be deployed
+ * @param fallbackConfigPath - local path to the config file (by default "./static/config.msapim.json")
+ * @param rootLocal - optional, root of the local folder with compiled project to be exported (by default "./dist")
+ */
+async function deploy(serviceInformation, name, fallbackConfigPath = "./static/" + APIM_CONFIG_FILE_NAME, rootLocal = "./dist/") {
+    console.log("\n\n");
+    console.log("Starting deploy process of custom widget: " + name);
+    console.log("Please, sign in to your Azure account when prompted\n");
+    const blobStorageUrl = await getStorageSasUrl(serviceInformation);
+    const customWidgetBlobService = new CustomWidgetBlobService$1(blobStorageUrl, name);
+    let config;
+    try {
+        console.log("Looking for config file in the Azure blob storage");
+        config = await customWidgetBlobService.getConfig();
+    }
+    catch (e) {
+        console.log("Config not found.");
+    }
+    if (!config) {
+        console.log("Looking for a local config file in: " + fallbackConfigPath);
+        config = JSON.parse(fs__default["default"].readFileSync(fallbackConfigPath).toString());
+    }
+    if (!config) {
+        throw new Error("Config file could not be loaded.");
+    }
+    console.log("Config file loaded\n");
+    const files = readdir("", rootLocal);
+    console.log("Starting upload of data files from the '" + rootLocal + "' folder\n");
+    await customWidgetBlobService.cleanDataDir();
+    const promises = [];
+    files.forEach((file) => {
+        const content = fs__default["default"].readFileSync(rootLocal + file);
+        const promise = customWidgetBlobService
+            .uploadWidgetDataFile(file, content)
+            .then(() => console.log("Uploaded file: " + file));
+        promises.push(promise);
+    });
+    await Promise.all(promises);
+    console.log(files.length + " files has been uploaded\n");
+    config.deployedOn = new Date();
+    await customWidgetBlobService.uploadConfig(config);
+    console.log("Uploaded updated config");
+}
+
+exports.APIM_ASK_FOR_SECRETS_MESSAGE_KEY = APIM_ASK_FOR_SECRETS_MESSAGE_KEY;
+exports.APIM_CONFIG_FILE_NAME = APIM_CONFIG_FILE_NAME;
+exports.APIM_EDITOR_DATA_KEY = APIM_EDITOR_DATA_KEY;
+exports.APIM_ON_CHANGE_MESSAGE_KEY = APIM_ON_CHANGE_MESSAGE_KEY;
+exports.BLOB_CONFIGS_FOLDER = BLOB_CONFIGS_FOLDER;
+exports.BLOB_DATA_FOLDER = BLOB_DATA_FOLDER;
+exports.BLOB_ROOT = BLOB_ROOT;
+exports.askForSecrets = askForSecrets;
+exports.buildBlobConfigPath = buildBlobConfigPath;
+exports.buildBlobDataPath = buildBlobDataPath;
+exports.buildOnChange = buildOnChange;
+exports.deployNodeJS = deploy;
+exports.getEditorValues = getEditorValues;
+exports.getValues = getValues;
+exports.getWidgetData = getWidgetData;
+exports.onChangeWithOrigin = onChangeWithOrigin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/utils.ts","../src/paths.ts","../src/node/CustomWidgetBlobService.ts","../src/node/getStorageSasUrl.ts","../src/node/readdir.ts","../src/node/deploy.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Key for a search param, from which editor data will be loaded from.\n */\nexport const APIM_EDITOR_DATA_KEY = \"editorData\";\n/**\n * Key for a post message object, it's used to propagate changes from editor to the DevPortal. Used to prevent interference with other applications.\n */\nexport const APIM_ON_CHANGE_MESSAGE_KEY = \"customInputValueChangedMSAPIM\";\n/**\n * Key for a post message object, it's used to request and send secrets - token and user id, from the DevPortal. Used to prevent interference with other applications.\n */\nexport const APIM_ASK_FOR_SECRETS_MESSAGE_KEY = \"askForSecretsMSAPIM\";\n\n/**\n * Base of a values obj\n */\nexport type ValuesCommon = Record<string, unknown>;\n/**\n * All possible runtime environments\n */\nexport type Environment = \"development\" | \"publishing\" | \"runtime\" | \"error\";\n\n/** Information about the widget instance received from the Dev Portal */\nexport interface PortalData {\n  // /** web content's origin (URL) of your Dev Portal */\n  // origin: string;\n  /** current runtime environment */\n  environment: Environment;\n  /** ID of this particular instance of the widget */\n  instanceId: string;\n}\n\n/** JSON object with all the data you'll receive from the Dev Portal */\nexport interface EditorData<Values extends ValuesCommon> extends PortalData {\n  /** values you've set in the admin editor window */\n  values: Partial<Values>;\n}\n\nfunction parseWidgetData<Values extends ValuesCommon>(\n  urlSearchParams: URLSearchParams\n): EditorData<Values> {\n  try {\n    const urlEditorParams: EditorData<Values> = JSON.parse(\n      decodeURIComponent(urlSearchParams.get(APIM_EDITOR_DATA_KEY) ?? \"\")\n    );\n\n    // if (!(\"origin\" in urlEditorParams)) {\n    //   console.error(\n    //     \"Could not get 'origin' from the search params of the URL:\\n\" + self.location.href\n    //   );\n    // }\n    return urlEditorParams;\n  } catch (e) {\n    console.error(\n      `Could not get '${APIM_EDITOR_DATA_KEY}' from the search params of the URL:\\n` +\n        self.location,\n      e\n    );\n    return { values: {}, environment: \"error\", instanceId: \"error\" };\n  }\n}\n\nexport function getWidgetDataPure<Values extends ValuesCommon>(\n  urlSearchParams: URLSearchParams\n): EditorData<Values> {\n  return parseWidgetData<Values>(urlSearchParams);\n}\n\n/**\n * Function to get all data related to the widget including technical values not expected to be needed in most cases.\n * Intended mostly for internal use, API might change. Consider using getValues or getEditorValues instead.\n */\nexport function getWidgetData<Values extends ValuesCommon>(): EditorData<Values> {\n  return getWidgetDataPure(new URLSearchParams(self.location.search));\n}\n\nexport function getEditorValuesPure<Values extends ValuesCommon>(\n  urlSearchParams: URLSearchParams\n): Partial<Values> {\n  return getWidgetDataPure<Values>(urlSearchParams).values;\n}\n\n/**\n * Function to get values you've set in the admin editor window.\n */\nexport function getEditorValues<Values extends ValuesCommon>(): Partial<Values> {\n  return getEditorValuesPure<Values>(new URLSearchParams(self.location.search));\n}\n\nexport function getValuesPure<Values extends ValuesCommon>(\n  valuesDefault: Values,\n  urlSearchParams: URLSearchParams\n): Values {\n  const values = { ...valuesDefault }; // set Obj to contain all possible values and prefill default value\n  const urlValues = parseWidgetData<Values>(urlSearchParams).values;\n\n  Object.keys(values).forEach((key: keyof Values) => {\n    const value = urlValues[key];\n    if (value != null && value !== \"\") values[key] = value as Values[typeof key]; // if value is specified in the URL, replace the default value\n  });\n  return values;\n}\n\n/**\n * Function to get values you've set in the admin editor window. Undefined/empty values are replaced with default values.\n *\n * @param valuesDefault - object with your default values to use, just import valuesDefault object from values.ts folder\n */\nexport function getValues<Values extends ValuesCommon>(valuesDefault: Values): Values {\n  return getValuesPure(valuesDefault, new URLSearchParams(self.location.search));\n}\n\n/**\n * Type of the onChange function.\n */\nexport type OnChange<Values extends ValuesCommon> = (values: Partial<Values>) => void;\n\n/**\n * The onChange function itself with 'origin' provided as a param.\n *\n * @param origin - web content's origin (URL) of your Dev Portal to send changes to\n * @param instanceId - ID of this particular instance of the widget\n * @param values - values that changed\n */\nexport function onChangeWithOrigin<Values extends ValuesCommon>(\n  origin: string,\n  instanceId: string,\n  values: Values\n): void {\n  Object.entries(values).forEach(([key, value]) => {\n    self.parent.postMessage({ [APIM_ON_CHANGE_MESSAGE_KEY]: { key, value, instanceId } }, origin);\n  });\n}\n\n/**\n * Build onChange function, which you can use, to send changed data from the editor.\n */\nexport function buildOnChange<Values extends ValuesCommon>(): OnChange<Values> {\n  const { instanceId } = getWidgetData();\n  return (values: Partial<Values>) => onChangeWithOrigin(\"*\", instanceId, values);\n}\n\n/**\n * Possible target modules\n * \"app\" for main application which is embedded in your Dev Portal\n * \"editor\" for form in admin panel\n */\nexport type TargetModule = \"app\" | \"editor\";\n/**\n * Secrets needed for communication with Dev Portal back-end\n */\nexport type Secrets = {\n  managementApiUrl: string;\n  apiVersion: string;\n  userId?: string;\n  token?: string;\n};\n\n/**\n * Request secrets - token & userId, from the Dev portal parent window.\n *\n * @param targetModule - is the function invoke from the main \"app\" window or the admin \"editor\"?\n */\nexport async function askForSecrets(targetModule: TargetModule): Promise<Secrets> {\n  let receiveSecrets: (e: MessageEvent) => void;\n\n  const promise = new Promise<Secrets>((resolve, reject) => {\n    const { instanceId, environment }: PortalData = getWidgetData();\n\n    receiveSecrets = ({ data }) => {\n      if (!(APIM_ASK_FOR_SECRETS_MESSAGE_KEY in data)) return;\n\n      const secrets = data[APIM_ASK_FOR_SECRETS_MESSAGE_KEY];\n      if (typeof secrets !== \"object\" || !(\"managementApiUrl\" in secrets)) {\n        reject(\"Secrets send by Dev Portal are invalid\");\n      }\n\n      resolve(secrets);\n    };\n\n    self.addEventListener(\"message\", receiveSecrets);\n\n    const message = {\n      [APIM_ASK_FOR_SECRETS_MESSAGE_KEY]: {\n        instanceId,\n        origin: self.location.origin,\n        targetModule,\n      },\n    };\n\n    if (targetModule === \"app\" && environment === \"development\") {\n      self.parent.parent.postMessage(message, \"*\");\n    } else {\n      self.parent.postMessage(message, \"*\");\n    }\n  });\n\n  return promise.finally(() => self.removeEventListener(\"message\", receiveSecrets));\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** root of the blob storage folder */\nexport const BLOB_ROOT = \"custom-widgets\";\n/** name of the blob storage folder with widget implementation */\nexport const BLOB_DATA_FOLDER = \"data\";\n/** name of the blob storage folder with widget configs */\nexport const BLOB_CONFIGS_FOLDER = \"configs\";\n/** name of the configuration file */\nexport const APIM_CONFIG_FILE_NAME = \"config.msapim.json\";\n\n/**\n * Generate relative path for widgets' data on the blob storage\n *\n * @param name - name of the widget\n */\nexport function buildBlobDataPath(name: string): string {\n  return `${BLOB_ROOT}/${BLOB_DATA_FOLDER}/${name}/`;\n}\n\n/**\n * Generate relative path for widgets' config on the blob storage\n *\n * @param name - name of the widget\n */\nexport function buildBlobConfigPath(name: string): string {\n  return `${BLOB_ROOT}/${BLOB_CONFIGS_FOLDER}/${name}/${APIM_CONFIG_FILE_NAME}`;\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { BlobServiceClient, BlockBlobUploadResponse } from \"@azure/storage-blob\";\nimport { buildBlobConfigPath, buildBlobDataPath } from \"../paths\";\nimport mime from \"mime\";\n\nexport type Config = Record<string, unknown>;\n\n/**\n * A service wrapping ContainerClient class to simplify blob handling\n */\nexport class CustomWidgetBlobService {\n  readonly containerClient;\n  readonly name;\n  readonly pathWidget;\n  readonly pathConfig;\n\n  /**\n   * @param blobStorageUrl - blob storage SAS URL\n   * @param name - name of the custom widget to be taken care of\n   */\n  constructor(blobStorageUrl: string, name: string) {\n    const container = \"content\";\n    const blobServiceClient = new BlobServiceClient(blobStorageUrl.replace(`/${container}`, \"\"));\n    this.containerClient = blobServiceClient.getContainerClient(container);\n    this.name = name;\n    this.pathWidget = buildBlobDataPath(name);\n    this.pathConfig = buildBlobConfigPath(name);\n  }\n\n  private extractFileName(path: string): string | undefined {\n    return path.split(\"/\").pop();\n  }\n\n  async blobUpload(absolutePath: string, content: Buffer): Promise<BlockBlobUploadResponse> {\n    const fileName = this.extractFileName(absolutePath);\n    if (!fileName) throw new Error(\"a fileName was not found in the absolutePath\");\n    return this.containerClient.getBlockBlobClient(absolutePath).upload(content, content.length, {\n      blobHTTPHeaders: { blobContentType: mime.getType(fileName) || \"application/octet-stream\" },\n    });\n  }\n\n  async jsonUpload(\n    absolutePath: string,\n    json: Record<string, unknown>\n  ): Promise<BlockBlobUploadResponse> {\n    return this.blobUpload(absolutePath, Buffer.from(JSON.stringify(json)));\n  }\n\n  async blobDownload(absolutePath: string): Promise<Buffer> {\n    return this.containerClient.getBlockBlobClient(absolutePath).downloadToBuffer();\n  }\n\n  async dirDelete(absolutePath: string): Promise<void> {\n    for await (const blob of await this.containerClient.listBlobsFlat({ prefix: absolutePath })) {\n      await this.containerClient.deleteBlob(blob.name);\n    }\n  }\n\n  async uploadWidgetDataFile(file: string, content: Buffer): Promise<BlockBlobUploadResponse> {\n    return this.blobUpload(this.pathWidget + file, content);\n  }\n\n  async cleanDataDir(): Promise<void> {\n    return this.dirDelete(this.pathWidget);\n  }\n\n  async getConfig(): Promise<Config> {\n    const buffer = await this.blobDownload(this.pathConfig);\n    return JSON.parse(buffer.toString());\n  }\n\n  async uploadConfig(config: Config): Promise<BlockBlobUploadResponse> {\n    return this.jsonUpload(this.pathConfig, config);\n  }\n}\n\nexport default CustomWidgetBlobService;\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { InteractiveBrowserCredential } from \"@azure/identity\";\nimport { ServiceInformation } from \"./deploy\";\nimport { getClient } from \"@azure-rest/core-client\";\n\nasync function getAccessToken(managementApiEndpoint: string): Promise<string> {\n  const credentials = new InteractiveBrowserCredential();\n  const scope = `${managementApiEndpoint}/user_impersonation`;\n  const { token } = await credentials.getToken(scope);\n  return `Bearer ${token}`;\n}\n\n/**\n * Function to get storage SAS URL.\n *\n * @returns storage SAS URL\n */\nasync function getStorageSasUrl({\n  managementApiEndpoint,\n  resourceId,\n  apiVersion = \"2019-01-01\",\n  tokenOverride,\n}: ServiceInformation): Promise<string> {\n  const httpClient = getClient(`${managementApiEndpoint}/${resourceId}`, { apiVersion });\n  const response = await httpClient\n    .pathUnchecked(`/portalSettings/mediaContent/listSecrets?apiVersion=${apiVersion}`) // TODO\n    .post({\n      headers: {\n        \"If-Match\": \"*\",\n        \"Content-Type\": \"application/json\",\n        Authorization: tokenOverride ?? (await getAccessToken(managementApiEndpoint)),\n      },\n    });\n\n  if (!response?.body?.containerSasUrl) throw new Error(\"Could not get storage SAS URL\");\n  return response.body.containerSasUrl;\n}\n\nexport default getStorageSasUrl;\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport fs from \"fs\";\nimport path from \"path\";\n\nfunction readdir(dir: string, root: string): string[] {\n  const results: string[] = [];\n\n  fs.readdirSync(root + dir).forEach((file) => {\n    const stat = fs.statSync(root + dir + path.sep + file);\n    if (stat && stat.isDirectory()) {\n      results.push(...readdir(dir + file + path.sep, root));\n    } else {\n      results.push(dir + file);\n    }\n  });\n\n  return results;\n}\n\nexport default readdir;\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport CustomWidgetBlobService, { Config } from \"./CustomWidgetBlobService\";\nimport { APIM_CONFIG_FILE_NAME } from \"../paths\";\nimport fs from \"fs\";\nimport getStorageSasUrl from \"./getStorageSasUrl\";\nimport readdir from \"./readdir\";\n\n/**\n * resourceId - resource ID of API Management service \"subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]\"\n * managementApiEndpoint - URL with protocol (e.g. https://management.azure.com)\n * apiVersion - optional to override default (e.g. \"2019-01-01\")\n * tokenOverride - optional, provides token to use for auth, instead of 'az login' approach\n */\nexport type ServiceInformation = {\n  resourceId: string;\n  managementApiEndpoint: string;\n  apiVersion?: string;\n  tokenOverride?: string;\n};\n\n/**\n * Deploys everything from /dist folder to the API Management DevPortals' blob storage.\n *\n * @param serviceInformation - service information for deployment\n * @param name - name of the widget to be deployed\n * @param fallbackConfigPath - local path to the config file (by default \"./static/config.msapim.json\")\n * @param rootLocal - optional, root of the local folder with compiled project to be exported (by default \"./dist\")\n */\nasync function deploy(\n  serviceInformation: ServiceInformation,\n  name: string,\n  fallbackConfigPath = \"./static/\" + APIM_CONFIG_FILE_NAME,\n  rootLocal: string = \"./dist/\"\n): Promise<void> {\n  console.log(\"\\n\\n\");\n  console.log(\"Starting deploy process of custom widget: \" + name);\n  console.log(\"Please, sign in to your Azure account when prompted\\n\");\n\n  const blobStorageUrl = await getStorageSasUrl(serviceInformation);\n  const customWidgetBlobService = new CustomWidgetBlobService(blobStorageUrl, name);\n\n  let config: Config | undefined;\n  try {\n    console.log(\"Looking for config file in the Azure blob storage\");\n    config = await customWidgetBlobService.getConfig();\n  } catch (e) {\n    console.log(\"Config not found.\");\n  }\n  if (!config) {\n    console.log(\"Looking for a local config file in: \" + fallbackConfigPath);\n    config = JSON.parse(fs.readFileSync(fallbackConfigPath).toString());\n  }\n  if (!config) {\n    throw new Error(\"Config file could not be loaded.\");\n  }\n\n  console.log(\"Config file loaded\\n\");\n\n  const files = readdir(\"\", rootLocal);\n\n  console.log(\"Starting upload of data files from the '\" + rootLocal + \"' folder\\n\");\n\n  await customWidgetBlobService.cleanDataDir();\n\n  const promises: Promise<void>[] = [];\n  files.forEach((file) => {\n    const content = fs.readFileSync(rootLocal + file);\n    const promise = customWidgetBlobService\n      .uploadWidgetDataFile(file, content)\n      .then(() => console.log(\"Uploaded file: \" + file));\n    promises.push(promise);\n  });\n  await Promise.all(promises);\n\n  console.log(files.length + \" files has been uploaded\\n\");\n\n  config.deployedOn = new Date();\n  await customWidgetBlobService.uploadConfig(config);\n  console.log(\"Uploaded updated config\");\n}\n\nexport default deploy;\n"],"names":["BlobServiceClient","mime","__asyncValues","InteractiveBrowserCredential","getClient","fs","path","CustomWidgetBlobService"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AACA;AAEA;;AAEG;AACI,MAAM,oBAAoB,GAAG,aAAa;AACjD;;AAEG;AACI,MAAM,0BAA0B,GAAG,gCAAgC;AAC1E;;AAEG;AACI,MAAM,gCAAgC,GAAG,sBAAsB;AA2BtE,SAAS,eAAe,CACtB,eAAgC,EAAA;;IAEhC,IAAI;AACF,QAAA,MAAM,eAAe,GAAuB,IAAI,CAAC,KAAK,CACpD,kBAAkB,CAAC,CAAA,EAAA,GAAA,eAAe,CAAC,GAAG,CAAC,oBAAoB,CAAC,mCAAI,EAAE,CAAC,CACpE,CAAC;;;;;;AAOF,QAAA,OAAO,eAAe,CAAC;AACxB,KAAA;AAAC,IAAA,OAAO,CAAC,EAAE;AACV,QAAA,OAAO,CAAC,KAAK,CACX,CAAA,eAAA,EAAkB,oBAAoB,CAAwC,sCAAA,CAAA;AAC5E,YAAA,IAAI,CAAC,QAAQ,EACf,CAAC,CACF,CAAC;AACF,QAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;AAClE,KAAA;AACH,CAAC;AAEK,SAAU,iBAAiB,CAC/B,eAAgC,EAAA;AAEhC,IAAA,OAAO,eAAe,CAAS,eAAe,CAAC,CAAC;AAClD,CAAC;AAED;;;AAGG;SACa,aAAa,GAAA;AAC3B,IAAA,OAAO,iBAAiB,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACtE,CAAC;AAEK,SAAU,mBAAmB,CACjC,eAAgC,EAAA;AAEhC,IAAA,OAAO,iBAAiB,CAAS,eAAe,CAAC,CAAC,MAAM,CAAC;AAC3D,CAAC;AAED;;AAEG;SACa,eAAe,GAAA;AAC7B,IAAA,OAAO,mBAAmB,CAAS,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAChF,CAAC;AAEe,SAAA,aAAa,CAC3B,aAAqB,EACrB,eAAgC,EAAA;AAEhC,IAAA,MAAM,MAAM,GAAQ,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,aAAa,CAAE,CAAC;IACpC,MAAM,SAAS,GAAG,eAAe,CAAS,eAAe,CAAC,CAAC,MAAM,CAAC;IAElE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAiB,KAAI;AAChD,QAAA,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;AAC7B,QAAA,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE;AAAE,YAAA,MAAM,CAAC,GAAG,CAAC,GAAG,KAA2B,CAAC;AAC/E,KAAC,CAAC,CAAC;AACH,IAAA,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;AAIG;AACG,SAAU,SAAS,CAA8B,aAAqB,EAAA;AAC1E,IAAA,OAAO,aAAa,CAAC,aAAa,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACjF,CAAC;AAOD;;;;;;AAMG;SACa,kBAAkB,CAChC,MAAc,EACd,UAAkB,EAClB,MAAc,EAAA;AAEd,IAAA,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAI;QAC9C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,0BAA0B,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;AAChG,KAAC,CAAC,CAAC;AACL,CAAC;AAED;;AAEG;SACa,aAAa,GAAA;AAC3B,IAAA,MAAM,EAAE,UAAU,EAAE,GAAG,aAAa,EAAE,CAAC;AACvC,IAAA,OAAO,CAAC,MAAuB,KAAK,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAClF,CAAC;AAkBD;;;;AAIG;AACI,eAAe,aAAa,CAAC,YAA0B,EAAA;AAC5D,IAAA,IAAI,cAAyC,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,KAAI;QACvD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAe,aAAa,EAAE,CAAC;AAEhE,QAAA,cAAc,GAAG,CAAC,EAAE,IAAI,EAAE,KAAI;AAC5B,YAAA,IAAI,EAAE,gCAAgC,IAAI,IAAI,CAAC;gBAAE,OAAO;AAExD,YAAA,MAAM,OAAO,GAAG,IAAI,CAAC,gCAAgC,CAAC,CAAC;YACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,EAAE,kBAAkB,IAAI,OAAO,CAAC,EAAE;gBACnE,MAAM,CAAC,wCAAwC,CAAC,CAAC;AAClD,aAAA;YAED,OAAO,CAAC,OAAO,CAAC,CAAC;AACnB,SAAC,CAAC;AAEF,QAAA,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AAEjD,QAAA,MAAM,OAAO,GAAG;YACd,CAAC,gCAAgC,GAAG;gBAClC,UAAU;AACV,gBAAA,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;gBAC5B,YAAY;AACb,aAAA;SACF,CAAC;AAEF,QAAA,IAAI,YAAY,KAAK,KAAK,IAAI,WAAW,KAAK,aAAa,EAAE;YAC3D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAC9C,SAAA;AAAM,aAAA;YACL,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACvC,SAAA;AACH,KAAC,CAAC,CAAC;AAEH,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;AACpF;;ACzMA;AACA;AAEA;AACO,MAAM,SAAS,GAAG,iBAAiB;AAC1C;AACO,MAAM,gBAAgB,GAAG,OAAO;AACvC;AACO,MAAM,mBAAmB,GAAG,UAAU;AAC7C;AACO,MAAM,qBAAqB,GAAG,qBAAqB;AAE1D;;;;AAIG;AACG,SAAU,iBAAiB,CAAC,IAAY,EAAA;AAC5C,IAAA,OAAO,GAAG,SAAS,CAAA,CAAA,EAAI,gBAAgB,CAAI,CAAA,EAAA,IAAI,GAAG,CAAC;AACrD,CAAC;AAED;;;;AAIG;AACG,SAAU,mBAAmB,CAAC,IAAY,EAAA;IAC9C,OAAO,CAAA,EAAG,SAAS,CAAI,CAAA,EAAA,mBAAmB,IAAI,IAAI,CAAA,CAAA,EAAI,qBAAqB,CAAA,CAAE,CAAC;AAChF;;AC5BA;AASA;;AAEG;MACU,uBAAuB,CAAA;AAMlC;;;AAGG;IACH,WAAY,CAAA,cAAsB,EAAE,IAAY,EAAA;QAC9C,MAAM,SAAS,GAAG,SAAS,CAAC;AAC5B,QAAA,MAAM,iBAAiB,GAAG,IAAIA,6BAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA,CAAA,EAAI,SAAS,CAAE,CAAA,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7F,IAAI,CAAC,eAAe,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;AACvE,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACjB,QAAA,IAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAC1C,QAAA,IAAI,CAAC,UAAU,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;KAC7C;AAEO,IAAA,eAAe,CAAC,IAAY,EAAA;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;KAC9B;AAED,IAAA,MAAM,UAAU,CAAC,YAAoB,EAAE,OAAe,EAAA;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;AACpD,QAAA,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;AAC/E,QAAA,OAAO,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE;AAC3F,YAAA,eAAe,EAAE,EAAE,eAAe,EAAEC,wBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,0BAA0B,EAAE;AAC3F,SAAA,CAAC,CAAC;KACJ;AAED,IAAA,MAAM,UAAU,CACd,YAAoB,EACpB,IAA6B,EAAA;AAE7B,QAAA,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACzE;IAED,MAAM,YAAY,CAAC,YAAoB,EAAA;QACrC,OAAO,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,gBAAgB,EAAE,CAAC;KACjF;IAED,MAAM,SAAS,CAAC,YAAoB,EAAA;;;AAClC,YAAA,KAAyB,IAAA,EAAA,GAAAC,mBAAA,CAAA,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA,EAAA,EAAA,EAAA,EAAA,GAAA,MAAA,EAAA,CAAA,IAAA,EAAA,EAAA,CAAA,EAAA,CAAA,IAAA,GAAA;gBAAhF,MAAM,IAAI,WAAA,CAAA;gBACnB,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClD,aAAA;;;;;;;;;KACF;AAED,IAAA,MAAM,oBAAoB,CAAC,IAAY,EAAE,OAAe,EAAA;AACtD,QAAA,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,OAAO,CAAC,CAAC;KACzD;AAED,IAAA,MAAM,YAAY,GAAA;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;KACxC;AAED,IAAA,MAAM,SAAS,GAAA;QACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;KACtC;IAED,MAAM,YAAY,CAAC,MAAc,EAAA;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;KACjD;AACF,CAAA;AAED,gCAAe,uBAAuB;;AC9EtC;AAOA,eAAe,cAAc,CAAC,qBAA6B,EAAA;AACzD,IAAA,MAAM,WAAW,GAAG,IAAIC,qCAA4B,EAAE,CAAC;AACvD,IAAA,MAAM,KAAK,GAAG,CAAG,EAAA,qBAAqB,qBAAqB,CAAC;IAC5D,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,CAAA,OAAA,EAAU,KAAK,CAAA,CAAE,CAAC;AAC3B,CAAC;AAED;;;;AAIG;AACH,eAAe,gBAAgB,CAAC,EAC9B,qBAAqB,EACrB,UAAU,EACV,UAAU,GAAG,YAAY,EACzB,aAAa,GACM,EAAA;;AACnB,IAAA,MAAM,UAAU,GAAGC,oBAAS,CAAC,GAAG,qBAAqB,CAAA,CAAA,EAAI,UAAU,CAAA,CAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAG,MAAM,UAAU;AAC9B,SAAA,aAAa,CAAC,CAAuD,oDAAA,EAAA,UAAU,CAAE,CAAA,CAAC;AAClF,SAAA,IAAI,CAAC;AACJ,QAAA,OAAO,EAAE;AACP,YAAA,UAAU,EAAE,GAAG;AACf,YAAA,cAAc,EAAE,kBAAkB;AAClC,YAAA,aAAa,EAAE,aAAa,KAAb,IAAA,IAAA,aAAa,KAAb,KAAA,CAAA,GAAA,aAAa,IAAK,MAAM,cAAc,CAAC,qBAAqB,CAAC,CAAC;AAC9E,SAAA;AACF,KAAA,CAAC,CAAC;AAEL,IAAA,IAAI,EAAC,CAAA,EAAA,GAAA,QAAQ,KAAR,IAAA,IAAA,QAAQ,KAAR,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,QAAQ,CAAE,IAAI,MAAE,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,eAAe,CAAA;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;AACvF,IAAA,OAAO,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC;AACvC;;ACtCA;AAMA,SAAS,OAAO,CAAC,GAAW,EAAE,IAAY,EAAA;IACxC,MAAM,OAAO,GAAa,EAAE,CAAC;AAE7B,IAAAC,sBAAE,CAAC,WAAW,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,KAAI;AAC1C,QAAA,MAAM,IAAI,GAAGA,sBAAE,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,GAAGC,wBAAI,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;AACvD,QAAA,IAAI,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;AAC9B,YAAA,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,GAAGA,wBAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AACvD,SAAA;AAAM,aAAA;AACL,YAAA,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;AAC1B,SAAA;AACH,KAAC,CAAC,CAAC;AAEH,IAAA,OAAO,OAAO,CAAC;AACjB;;ACnBA;AAsBA;;;;;;;AAOG;AACH,eAAe,MAAM,CACnB,kBAAsC,EACtC,IAAY,EACZ,kBAAkB,GAAG,WAAW,GAAG,qBAAqB,EACxD,YAAoB,SAAS,EAAA;AAE7B,IAAA,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACpB,IAAA,OAAO,CAAC,GAAG,CAAC,4CAA4C,GAAG,IAAI,CAAC,CAAC;AACjE,IAAA,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;AAErE,IAAA,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;IAClE,MAAM,uBAAuB,GAAG,IAAIC,yBAAuB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;AAElF,IAAA,IAAI,MAA0B,CAAC;IAC/B,IAAI;AACF,QAAA,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;AACjE,QAAA,MAAM,GAAG,MAAM,uBAAuB,CAAC,SAAS,EAAE,CAAC;AACpD,KAAA;AAAC,IAAA,OAAO,CAAC,EAAE;AACV,QAAA,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAClC,KAAA;IACD,IAAI,CAAC,MAAM,EAAE;AACX,QAAA,OAAO,CAAC,GAAG,CAAC,sCAAsC,GAAG,kBAAkB,CAAC,CAAC;AACzE,QAAA,MAAM,GAAG,IAAI,CAAC,KAAK,CAACF,sBAAE,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AACrE,KAAA;IACD,IAAI,CAAC,MAAM,EAAE;AACX,QAAA,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;AACrD,KAAA;AAED,IAAA,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAEpC,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAErC,OAAO,CAAC,GAAG,CAAC,0CAA0C,GAAG,SAAS,GAAG,YAAY,CAAC,CAAC;AAEnF,IAAA,MAAM,uBAAuB,CAAC,YAAY,EAAE,CAAC;IAE7C,MAAM,QAAQ,GAAoB,EAAE,CAAC;AACrC,IAAA,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,KAAI;QACrB,MAAM,OAAO,GAAGA,sBAAE,CAAC,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,uBAAuB;AACpC,aAAA,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC;AACnC,aAAA,IAAI,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC;AACrD,QAAA,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACzB,KAAC,CAAC,CAAC;AACH,IAAA,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE5B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,4BAA4B,CAAC,CAAC;AAEzD,IAAA,MAAM,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;AAC/B,IAAA,MAAM,uBAAuB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;AACnD,IAAA,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AACzC;;;;;;;;;;;;;;;;;;;"}

package/dist-esm/src/index.js

@@ -0,0 +1,10 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * @packageDocumentation https://aka.ms/apimdocs/portal/customwidgets
+ */
+export { APIM_EDITOR_DATA_KEY, APIM_ON_CHANGE_MESSAGE_KEY, APIM_ASK_FOR_SECRETS_MESSAGE_KEY, getWidgetData, getEditorValues, getValues, askForSecrets, buildOnChange, onChangeWithOrigin, } from "./utils";
+export { BLOB_ROOT, APIM_CONFIG_FILE_NAME, BLOB_DATA_FOLDER, BLOB_CONFIGS_FOLDER, buildBlobDataPath, buildBlobConfigPath, } from "./paths";
+import deployNodeJS from "./node/deploy";
+export { deployNodeJS };
+//# sourceMappingURL=index.js.map

package/dist-esm/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;GAEG;AAEH,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,gCAAgC,EAChC,aAAa,EACb,eAAe,EACf,SAAS,EACT,aAAa,EACb,aAAa,EACb,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAUjB,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,SAAS,CAAC;AAEjB,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * @packageDocumentation https://aka.ms/apimdocs/portal/customwidgets\n */\n\nexport {\n  APIM_EDITOR_DATA_KEY,\n  APIM_ON_CHANGE_MESSAGE_KEY,\n  APIM_ASK_FOR_SECRETS_MESSAGE_KEY,\n  getWidgetData,\n  getEditorValues,\n  getValues,\n  askForSecrets,\n  buildOnChange,\n  onChangeWithOrigin,\n} from \"./utils\";\nexport type {\n  PortalData,\n  EditorData,\n  OnChange,\n  Secrets,\n  TargetModule,\n  ValuesCommon,\n  Environment,\n} from \"./utils\";\nexport {\n  BLOB_ROOT,\n  APIM_CONFIG_FILE_NAME,\n  BLOB_DATA_FOLDER,\n  BLOB_CONFIGS_FOLDER,\n  buildBlobDataPath,\n  buildBlobConfigPath,\n} from \"./paths\";\n\nimport deployNodeJS from \"./node/deploy\";\nexport { deployNodeJS };\nexport type { ServiceInformation } from \"./node/deploy\";\n"]}

package/dist-esm/src/node/CustomWidgetBlobService.js

@@ -0,0 +1,71 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { __asyncValues } from "tslib";
+import { BlobServiceClient } from "@azure/storage-blob";
+import { buildBlobConfigPath, buildBlobDataPath } from "../paths";
+import mime from "mime";
+/**
+ * A service wrapping ContainerClient class to simplify blob handling
+ */
+export class CustomWidgetBlobService {
+    /**
+     * @param blobStorageUrl - blob storage SAS URL
+     * @param name - name of the custom widget to be taken care of
+     */
+    constructor(blobStorageUrl, name) {
+        const container = "content";
+        const blobServiceClient = new BlobServiceClient(blobStorageUrl.replace(`/${container}`, ""));
+        this.containerClient = blobServiceClient.getContainerClient(container);
+        this.name = name;
+        this.pathWidget = buildBlobDataPath(name);
+        this.pathConfig = buildBlobConfigPath(name);
+    }
+    extractFileName(path) {
+        return path.split("/").pop();
+    }
+    async blobUpload(absolutePath, content) {
+        const fileName = this.extractFileName(absolutePath);
+        if (!fileName)
+            throw new Error("a fileName was not found in the absolutePath");
+        return this.containerClient.getBlockBlobClient(absolutePath).upload(content, content.length, {
+            blobHTTPHeaders: { blobContentType: mime.getType(fileName) || "application/octet-stream" },
+        });
+    }
+    async jsonUpload(absolutePath, json) {
+        return this.blobUpload(absolutePath, Buffer.from(JSON.stringify(json)));
+    }
+    async blobDownload(absolutePath) {
+        return this.containerClient.getBlockBlobClient(absolutePath).downloadToBuffer();
+    }
+    async dirDelete(absolutePath) {
+        var e_1, _a;
+        try {
+            for (var _b = __asyncValues(await this.containerClient.listBlobsFlat({ prefix: absolutePath })), _c; _c = await _b.next(), !_c.done;) {
+                const blob = _c.value;
+                await this.containerClient.deleteBlob(blob.name);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) await _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    }
+    async uploadWidgetDataFile(file, content) {
+        return this.blobUpload(this.pathWidget + file, content);
+    }
+    async cleanDataDir() {
+        return this.dirDelete(this.pathWidget);
+    }
+    async getConfig() {
+        const buffer = await this.blobDownload(this.pathConfig);
+        return JSON.parse(buffer.toString());
+    }
+    async uploadConfig(config) {
+        return this.jsonUpload(this.pathConfig, config);
+    }
+}
+export default CustomWidgetBlobService;
+//# sourceMappingURL=CustomWidgetBlobService.js.map

package/dist-esm/src/node/CustomWidgetBlobService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomWidgetBlobService.js","sourceRoot":"","sources":["../../../src/node/CustomWidgetBlobService.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,OAAO,EAAE,iBAAiB,EAA2B,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,IAAI,MAAM,MAAM,CAAC;AAIxB;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAMlC;;;OAGG;IACH,YAAY,cAAsB,EAAE,IAAY;QAC9C,MAAM,SAAS,GAAG,SAAS,CAAC;QAC5B,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7F,IAAI,CAAC,eAAe,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEO,eAAe,CAAC,IAAY;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,OAAe;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAC/E,OAAO,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE;YAC3F,eAAe,EAAE,EAAE,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,0BAA0B,EAAE;SAC3F,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU,CACd,YAAoB,EACpB,IAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,YAAoB;QACrC,OAAO,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,gBAAgB,EAAE,CAAC;IAClF,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,YAAoB;;;YAClC,KAAyB,IAAA,KAAA,cAAA,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAA,IAAA;gBAAhF,MAAM,IAAI,WAAA,CAAA;gBACnB,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAClD;;;;;;;;;IACH,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,IAAY,EAAE,OAAe;QACtD,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;CACF;AAED,eAAe,uBAAuB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { BlobServiceClient, BlockBlobUploadResponse } from \"@azure/storage-blob\";\nimport { buildBlobConfigPath, buildBlobDataPath } from \"../paths\";\nimport mime from \"mime\";\n\nexport type Config = Record<string, unknown>;\n\n/**\n * A service wrapping ContainerClient class to simplify blob handling\n */\nexport class CustomWidgetBlobService {\n  readonly containerClient;\n  readonly name;\n  readonly pathWidget;\n  readonly pathConfig;\n\n  /**\n   * @param blobStorageUrl - blob storage SAS URL\n   * @param name - name of the custom widget to be taken care of\n   */\n  constructor(blobStorageUrl: string, name: string) {\n    const container = \"content\";\n    const blobServiceClient = new BlobServiceClient(blobStorageUrl.replace(`/${container}`, \"\"));\n    this.containerClient = blobServiceClient.getContainerClient(container);\n    this.name = name;\n    this.pathWidget = buildBlobDataPath(name);\n    this.pathConfig = buildBlobConfigPath(name);\n  }\n\n  private extractFileName(path: string): string | undefined {\n    return path.split(\"/\").pop();\n  }\n\n  async blobUpload(absolutePath: string, content: Buffer): Promise<BlockBlobUploadResponse> {\n    const fileName = this.extractFileName(absolutePath);\n    if (!fileName) throw new Error(\"a fileName was not found in the absolutePath\");\n    return this.containerClient.getBlockBlobClient(absolutePath).upload(content, content.length, {\n      blobHTTPHeaders: { blobContentType: mime.getType(fileName) || \"application/octet-stream\" },\n    });\n  }\n\n  async jsonUpload(\n    absolutePath: string,\n    json: Record<string, unknown>\n  ): Promise<BlockBlobUploadResponse> {\n    return this.blobUpload(absolutePath, Buffer.from(JSON.stringify(json)));\n  }\n\n  async blobDownload(absolutePath: string): Promise<Buffer> {\n    return this.containerClient.getBlockBlobClient(absolutePath).downloadToBuffer();\n  }\n\n  async dirDelete(absolutePath: string): Promise<void> {\n    for await (const blob of await this.containerClient.listBlobsFlat({ prefix: absolutePath })) {\n      await this.containerClient.deleteBlob(blob.name);\n    }\n  }\n\n  async uploadWidgetDataFile(file: string, content: Buffer): Promise<BlockBlobUploadResponse> {\n    return this.blobUpload(this.pathWidget + file, content);\n  }\n\n  async cleanDataDir(): Promise<void> {\n    return this.dirDelete(this.pathWidget);\n  }\n\n  async getConfig(): Promise<Config> {\n    const buffer = await this.blobDownload(this.pathConfig);\n    return JSON.parse(buffer.toString());\n  }\n\n  async uploadConfig(config: Config): Promise<BlockBlobUploadResponse> {\n    return this.jsonUpload(this.pathConfig, config);\n  }\n}\n\nexport default CustomWidgetBlobService;\n"]}

package/dist-esm/src/node/deploy.browser.js

@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+async function deploy(_serviceInformation, _name, _fallbackConfigPath) {
+    throw new Error("Only for Node.js");
+}
+export default deploy;
+//# sourceMappingURL=deploy.browser.js.map

package/dist-esm/src/node/deploy.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.browser.js","sourceRoot":"","sources":["../../../src/node/deploy.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,KAAK,UAAU,MAAM,CACnB,mBAA4B,EAC5B,KAAa,EACb,mBAA2B;IAE3B,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;AACtC,CAAC;AAED,eAAe,MAAM,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nasync function deploy(\n  _serviceInformation: unknown,\n  _name: string,\n  _fallbackConfigPath: string\n): Promise<void> {\n  throw new Error(\"Only for Node.js\");\n}\n\nexport default deploy;\n"]}

package/dist-esm/src/node/deploy.js

@@ -0,0 +1,56 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import CustomWidgetBlobService from "./CustomWidgetBlobService";
+import { APIM_CONFIG_FILE_NAME } from "../paths";
+import fs from "fs";
+import getStorageSasUrl from "./getStorageSasUrl";
+import readdir from "./readdir";
+/**
+ * Deploys everything from /dist folder to the API Management DevPortals' blob storage.
+ *
+ * @param serviceInformation - service information for deployment
+ * @param name - name of the widget to be deployed
+ * @param fallbackConfigPath - local path to the config file (by default "./static/config.msapim.json")
+ * @param rootLocal - optional, root of the local folder with compiled project to be exported (by default "./dist")
+ */
+async function deploy(serviceInformation, name, fallbackConfigPath = "./static/" + APIM_CONFIG_FILE_NAME, rootLocal = "./dist/") {
+    console.log("\n\n");
+    console.log("Starting deploy process of custom widget: " + name);
+    console.log("Please, sign in to your Azure account when prompted\n");
+    const blobStorageUrl = await getStorageSasUrl(serviceInformation);
+    const customWidgetBlobService = new CustomWidgetBlobService(blobStorageUrl, name);
+    let config;
+    try {
+        console.log("Looking for config file in the Azure blob storage");
+        config = await customWidgetBlobService.getConfig();
+    }
+    catch (e) {
+        console.log("Config not found.");
+    }
+    if (!config) {
+        console.log("Looking for a local config file in: " + fallbackConfigPath);
+        config = JSON.parse(fs.readFileSync(fallbackConfigPath).toString());
+    }
+    if (!config) {
+        throw new Error("Config file could not be loaded.");
+    }
+    console.log("Config file loaded\n");
+    const files = readdir("", rootLocal);
+    console.log("Starting upload of data files from the '" + rootLocal + "' folder\n");
+    await customWidgetBlobService.cleanDataDir();
+    const promises = [];
+    files.forEach((file) => {
+        const content = fs.readFileSync(rootLocal + file);
+        const promise = customWidgetBlobService
+            .uploadWidgetDataFile(file, content)
+            .then(() => console.log("Uploaded file: " + file));
+        promises.push(promise);
+    });
+    await Promise.all(promises);
+    console.log(files.length + " files has been uploaded\n");
+    config.deployedOn = new Date();
+    await customWidgetBlobService.uploadConfig(config);
+    console.log("Uploaded updated config");
+}
+export default deploy;
+//# sourceMappingURL=deploy.js.map

package/dist-esm/src/node/deploy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../src/node/deploy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,uBAAmC,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,OAAO,MAAM,WAAW,CAAC;AAehC;;;;;;;GAOG;AACH,KAAK,UAAU,MAAM,CACnB,kBAAsC,EACtC,IAAY,EACZ,kBAAkB,GAAG,WAAW,GAAG,qBAAqB,EACxD,YAAoB,SAAS;IAE7B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpB,OAAO,CAAC,GAAG,CAAC,4CAA4C,GAAG,IAAI,CAAC,CAAC;IACjE,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;IAErE,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;IAClE,MAAM,uBAAuB,GAAG,IAAI,uBAAuB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAElF,IAAI,MAA0B,CAAC;IAC/B,IAAI;QACF,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;QACjE,MAAM,GAAG,MAAM,uBAAuB,CAAC,SAAS,EAAE,CAAC;KACpD;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;KAClC;IACD,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,CAAC,GAAG,CAAC,sCAAsC,GAAG,kBAAkB,CAAC,CAAC;QACzE,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;KACrE;IACD,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;KACrD;IAED,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAEpC,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAErC,OAAO,CAAC,GAAG,CAAC,0CAA0C,GAAG,SAAS,GAAG,YAAY,CAAC,CAAC;IAEnF,MAAM,uBAAuB,CAAC,YAAY,EAAE,CAAC;IAE7C,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,uBAAuB;aACpC,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC;aACnC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC;QACrD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE5B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,4BAA4B,CAAC,CAAC;IAEzD,MAAM,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;IAC/B,MAAM,uBAAuB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AACzC,CAAC;AAED,eAAe,MAAM,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport CustomWidgetBlobService, { Config } from \"./CustomWidgetBlobService\";\nimport { APIM_CONFIG_FILE_NAME } from \"../paths\";\nimport fs from \"fs\";\nimport getStorageSasUrl from \"./getStorageSasUrl\";\nimport readdir from \"./readdir\";\n\n/**\n * resourceId - resource ID of API Management service \"subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]\"\n * managementApiEndpoint - URL with protocol (e.g. https://management.azure.com)\n * apiVersion - optional to override default (e.g. \"2019-01-01\")\n * tokenOverride - optional, provides token to use for auth, instead of 'az login' approach\n */\nexport type ServiceInformation = {\n  resourceId: string;\n  managementApiEndpoint: string;\n  apiVersion?: string;\n  tokenOverride?: string;\n};\n\n/**\n * Deploys everything from /dist folder to the API Management DevPortals' blob storage.\n *\n * @param serviceInformation - service information for deployment\n * @param name - name of the widget to be deployed\n * @param fallbackConfigPath - local path to the config file (by default \"./static/config.msapim.json\")\n * @param rootLocal - optional, root of the local folder with compiled project to be exported (by default \"./dist\")\n */\nasync function deploy(\n  serviceInformation: ServiceInformation,\n  name: string,\n  fallbackConfigPath = \"./static/\" + APIM_CONFIG_FILE_NAME,\n  rootLocal: string = \"./dist/\"\n): Promise<void> {\n  console.log(\"\\n\\n\");\n  console.log(\"Starting deploy process of custom widget: \" + name);\n  console.log(\"Please, sign in to your Azure account when prompted\\n\");\n\n  const blobStorageUrl = await getStorageSasUrl(serviceInformation);\n  const customWidgetBlobService = new CustomWidgetBlobService(blobStorageUrl, name);\n\n  let config: Config | undefined;\n  try {\n    console.log(\"Looking for config file in the Azure blob storage\");\n    config = await customWidgetBlobService.getConfig();\n  } catch (e) {\n    console.log(\"Config not found.\");\n  }\n  if (!config) {\n    console.log(\"Looking for a local config file in: \" + fallbackConfigPath);\n    config = JSON.parse(fs.readFileSync(fallbackConfigPath).toString());\n  }\n  if (!config) {\n    throw new Error(\"Config file could not be loaded.\");\n  }\n\n  console.log(\"Config file loaded\\n\");\n\n  const files = readdir(\"\", rootLocal);\n\n  console.log(\"Starting upload of data files from the '\" + rootLocal + \"' folder\\n\");\n\n  await customWidgetBlobService.cleanDataDir();\n\n  const promises: Promise<void>[] = [];\n  files.forEach((file) => {\n    const content = fs.readFileSync(rootLocal + file);\n    const promise = customWidgetBlobService\n      .uploadWidgetDataFile(file, content)\n      .then(() => console.log(\"Uploaded file: \" + file));\n    promises.push(promise);\n  });\n  await Promise.all(promises);\n\n  console.log(files.length + \" files has been uploaded\\n\");\n\n  config.deployedOn = new Date();\n  await customWidgetBlobService.uploadConfig(config);\n  console.log(\"Uploaded updated config\");\n}\n\nexport default deploy;\n"]}

package/dist-esm/src/node/getStorageSasUrl.js

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { InteractiveBrowserCredential } from "@azure/identity";
+import { getClient } from "@azure-rest/core-client";
+async function getAccessToken(managementApiEndpoint) {
+    const credentials = new InteractiveBrowserCredential();
+    const scope = `${managementApiEndpoint}/user_impersonation`;
+    const { token } = await credentials.getToken(scope);
+    return `Bearer ${token}`;
+}
+/**
+ * Function to get storage SAS URL.
+ *
+ * @returns storage SAS URL
+ */
+async function getStorageSasUrl({ managementApiEndpoint, resourceId, apiVersion = "2019-01-01", tokenOverride, }) {
+    var _a;
+    const httpClient = getClient(`${managementApiEndpoint}/${resourceId}`, { apiVersion });
+    const response = await httpClient
+        .pathUnchecked(`/portalSettings/mediaContent/listSecrets?apiVersion=${apiVersion}`) // TODO
+        .post({
+        headers: {
+            "If-Match": "*",
+            "Content-Type": "application/json",
+            Authorization: tokenOverride !== null && tokenOverride !== void 0 ? tokenOverride : (await getAccessToken(managementApiEndpoint)),
+        },
+    });
+    if (!((_a = response === null || response === void 0 ? void 0 : response.body) === null || _a === void 0 ? void 0 : _a.containerSasUrl))
+        throw new Error("Could not get storage SAS URL");
+    return response.body.containerSasUrl;
+}
+export default getStorageSasUrl;
+//# sourceMappingURL=getStorageSasUrl.js.map

package/dist-esm/src/node/getStorageSasUrl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getStorageSasUrl.js","sourceRoot":"","sources":["../../../src/node/getStorageSasUrl.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,KAAK,UAAU,cAAc,CAAC,qBAA6B;IACzD,MAAM,WAAW,GAAG,IAAI,4BAA4B,EAAE,CAAC;IACvD,MAAM,KAAK,GAAG,GAAG,qBAAqB,qBAAqB,CAAC;IAC5D,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,UAAU,KAAK,EAAE,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,gBAAgB,CAAC,EAC9B,qBAAqB,EACrB,UAAU,EACV,UAAU,GAAG,YAAY,EACzB,aAAa,GACM;;IACnB,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,qBAAqB,IAAI,UAAU,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAG,MAAM,UAAU;SAC9B,aAAa,CAAC,uDAAuD,UAAU,EAAE,CAAC,CAAC,OAAO;SAC1F,IAAI,CAAC;QACJ,OAAO,EAAE;YACP,UAAU,EAAE,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,CAAC,MAAM,cAAc,CAAC,qBAAqB,CAAC,CAAC;SAC9E;KACF,CAAC,CAAC;IAEL,IAAI,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,eAAe,CAAA;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACvF,OAAO,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC;AACvC,CAAC;AAED,eAAe,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { InteractiveBrowserCredential } from \"@azure/identity\";\nimport { ServiceInformation } from \"./deploy\";\nimport { getClient } from \"@azure-rest/core-client\";\n\nasync function getAccessToken(managementApiEndpoint: string): Promise<string> {\n  const credentials = new InteractiveBrowserCredential();\n  const scope = `${managementApiEndpoint}/user_impersonation`;\n  const { token } = await credentials.getToken(scope);\n  return `Bearer ${token}`;\n}\n\n/**\n * Function to get storage SAS URL.\n *\n * @returns storage SAS URL\n */\nasync function getStorageSasUrl({\n  managementApiEndpoint,\n  resourceId,\n  apiVersion = \"2019-01-01\",\n  tokenOverride,\n}: ServiceInformation): Promise<string> {\n  const httpClient = getClient(`${managementApiEndpoint}/${resourceId}`, { apiVersion });\n  const response = await httpClient\n    .pathUnchecked(`/portalSettings/mediaContent/listSecrets?apiVersion=${apiVersion}`) // TODO\n    .post({\n      headers: {\n        \"If-Match\": \"*\",\n        \"Content-Type\": \"application/json\",\n        Authorization: tokenOverride ?? (await getAccessToken(managementApiEndpoint)),\n      },\n    });\n\n  if (!response?.body?.containerSasUrl) throw new Error(\"Could not get storage SAS URL\");\n  return response.body.containerSasUrl;\n}\n\nexport default getStorageSasUrl;\n"]}

package/dist-esm/src/node/readdir.js

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import fs from "fs";
+import path from "path";
+function readdir(dir, root) {
+    const results = [];
+    fs.readdirSync(root + dir).forEach((file) => {
+        const stat = fs.statSync(root + dir + path.sep + file);
+        if (stat && stat.isDirectory()) {
+            results.push(...readdir(dir + file + path.sep, root));
+        }
+        else {
+            results.push(dir + file);
+        }
+    });
+    return results;
+}
+export default readdir;
+//# sourceMappingURL=readdir.js.map

package/dist-esm/src/node/readdir.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readdir.js","sourceRoot":"","sources":["../../../src/node/readdir.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,SAAS,OAAO,CAAC,GAAW,EAAE,IAAY;IACxC,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,EAAE,CAAC,WAAW,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;QACvD,IAAI,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YAC9B,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;SACvD;aAAM;YACL,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,eAAe,OAAO,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport fs from \"fs\";\nimport path from \"path\";\n\nfunction readdir(dir: string, root: string): string[] {\n  const results: string[] = [];\n\n  fs.readdirSync(root + dir).forEach((file) => {\n    const stat = fs.statSync(root + dir + path.sep + file);\n    if (stat && stat.isDirectory()) {\n      results.push(...readdir(dir + file + path.sep, root));\n    } else {\n      results.push(dir + file);\n    }\n  });\n\n  return results;\n}\n\nexport default readdir;\n"]}

package/dist-esm/src/paths.js

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/** root of the blob storage folder */
+export const BLOB_ROOT = "custom-widgets";
+/** name of the blob storage folder with widget implementation */
+export const BLOB_DATA_FOLDER = "data";
+/** name of the blob storage folder with widget configs */
+export const BLOB_CONFIGS_FOLDER = "configs";
+/** name of the configuration file */
+export const APIM_CONFIG_FILE_NAME = "config.msapim.json";
+/**
+ * Generate relative path for widgets' data on the blob storage
+ *
+ * @param name - name of the widget
+ */
+export function buildBlobDataPath(name) {
+    return `${BLOB_ROOT}/${BLOB_DATA_FOLDER}/${name}/`;
+}
+/**
+ * Generate relative path for widgets' config on the blob storage
+ *
+ * @param name - name of the widget
+ */
+export function buildBlobConfigPath(name) {
+    return `${BLOB_ROOT}/${BLOB_CONFIGS_FOLDER}/${name}/${APIM_CONFIG_FILE_NAME}`;
+}
+//# sourceMappingURL=paths.js.map

package/dist-esm/src/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/paths.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,sCAAsC;AACtC,MAAM,CAAC,MAAM,SAAS,GAAG,gBAAgB,CAAC;AAC1C,iEAAiE;AACjE,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACvC,0DAA0D;AAC1D,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAC7C,qCAAqC;AACrC,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,OAAO,GAAG,SAAS,IAAI,gBAAgB,IAAI,IAAI,GAAG,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,OAAO,GAAG,SAAS,IAAI,mBAAmB,IAAI,IAAI,IAAI,qBAAqB,EAAE,CAAC;AAChF,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/** root of the blob storage folder */\nexport const BLOB_ROOT = \"custom-widgets\";\n/** name of the blob storage folder with widget implementation */\nexport const BLOB_DATA_FOLDER = \"data\";\n/** name of the blob storage folder with widget configs */\nexport const BLOB_CONFIGS_FOLDER = \"configs\";\n/** name of the configuration file */\nexport const APIM_CONFIG_FILE_NAME = \"config.msapim.json\";\n\n/**\n * Generate relative path for widgets' data on the blob storage\n *\n * @param name - name of the widget\n */\nexport function buildBlobDataPath(name: string): string {\n  return `${BLOB_ROOT}/${BLOB_DATA_FOLDER}/${name}/`;\n}\n\n/**\n * Generate relative path for widgets' config on the blob storage\n *\n * @param name - name of the widget\n */\nexport function buildBlobConfigPath(name: string): string {\n  return `${BLOB_ROOT}/${BLOB_CONFIGS_FOLDER}/${name}/${APIM_CONFIG_FILE_NAME}`;\n}\n"]}

package/dist-esm/src/utils.js

@@ -0,0 +1,123 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Key for a search param, from which editor data will be loaded from.
+ */
+export const APIM_EDITOR_DATA_KEY = "editorData";
+/**
+ * Key for a post message object, it's used to propagate changes from editor to the DevPortal. Used to prevent interference with other applications.
+ */
+export const APIM_ON_CHANGE_MESSAGE_KEY = "customInputValueChangedMSAPIM";
+/**
+ * Key for a post message object, it's used to request and send secrets - token and user id, from the DevPortal. Used to prevent interference with other applications.
+ */
+export const APIM_ASK_FOR_SECRETS_MESSAGE_KEY = "askForSecretsMSAPIM";
+function parseWidgetData(urlSearchParams) {
+    var _a;
+    try {
+        const urlEditorParams = JSON.parse(decodeURIComponent((_a = urlSearchParams.get(APIM_EDITOR_DATA_KEY)) !== null && _a !== void 0 ? _a : ""));
+        // if (!("origin" in urlEditorParams)) {
+        //   console.error(
+        //     "Could not get 'origin' from the search params of the URL:\n" + self.location.href
+        //   );
+        // }
+        return urlEditorParams;
+    }
+    catch (e) {
+        console.error(`Could not get '${APIM_EDITOR_DATA_KEY}' from the search params of the URL:\n` +
+            self.location, e);
+        return { values: {}, environment: "error", instanceId: "error" };
+    }
+}
+export function getWidgetDataPure(urlSearchParams) {
+    return parseWidgetData(urlSearchParams);
+}
+/**
+ * Function to get all data related to the widget including technical values not expected to be needed in most cases.
+ * Intended mostly for internal use, API might change. Consider using getValues or getEditorValues instead.
+ */
+export function getWidgetData() {
+    return getWidgetDataPure(new URLSearchParams(self.location.search));
+}
+export function getEditorValuesPure(urlSearchParams) {
+    return getWidgetDataPure(urlSearchParams).values;
+}
+/**
+ * Function to get values you've set in the admin editor window.
+ */
+export function getEditorValues() {
+    return getEditorValuesPure(new URLSearchParams(self.location.search));
+}
+export function getValuesPure(valuesDefault, urlSearchParams) {
+    const values = Object.assign({}, valuesDefault); // set Obj to contain all possible values and prefill default value
+    const urlValues = parseWidgetData(urlSearchParams).values;
+    Object.keys(values).forEach((key) => {
+        const value = urlValues[key];
+        if (value != null && value !== "")
+            values[key] = value; // if value is specified in the URL, replace the default value
+    });
+    return values;
+}
+/**
+ * Function to get values you've set in the admin editor window. Undefined/empty values are replaced with default values.
+ *
+ * @param valuesDefault - object with your default values to use, just import valuesDefault object from values.ts folder
+ */
+export function getValues(valuesDefault) {
+    return getValuesPure(valuesDefault, new URLSearchParams(self.location.search));
+}
+/**
+ * The onChange function itself with 'origin' provided as a param.
+ *
+ * @param origin - web content's origin (URL) of your Dev Portal to send changes to
+ * @param instanceId - ID of this particular instance of the widget
+ * @param values - values that changed
+ */
+export function onChangeWithOrigin(origin, instanceId, values) {
+    Object.entries(values).forEach(([key, value]) => {
+        self.parent.postMessage({ [APIM_ON_CHANGE_MESSAGE_KEY]: { key, value, instanceId } }, origin);
+    });
+}
+/**
+ * Build onChange function, which you can use, to send changed data from the editor.
+ */
+export function buildOnChange() {
+    const { instanceId } = getWidgetData();
+    return (values) => onChangeWithOrigin("*", instanceId, values);
+}
+/**
+ * Request secrets - token & userId, from the Dev portal parent window.
+ *
+ * @param targetModule - is the function invoke from the main "app" window or the admin "editor"?
+ */
+export async function askForSecrets(targetModule) {
+    let receiveSecrets;
+    const promise = new Promise((resolve, reject) => {
+        const { instanceId, environment } = getWidgetData();
+        receiveSecrets = ({ data }) => {
+            if (!(APIM_ASK_FOR_SECRETS_MESSAGE_KEY in data))
+                return;
+            const secrets = data[APIM_ASK_FOR_SECRETS_MESSAGE_KEY];
+            if (typeof secrets !== "object" || !("managementApiUrl" in secrets)) {
+                reject("Secrets send by Dev Portal are invalid");
+            }
+            resolve(secrets);
+        };
+        self.addEventListener("message", receiveSecrets);
+        const message = {
+            [APIM_ASK_FOR_SECRETS_MESSAGE_KEY]: {
+                instanceId,
+                origin: self.location.origin,
+                targetModule,
+            },
+        };
+        if (targetModule === "app" && environment === "development") {
+            self.parent.parent.postMessage(message, "*");
+        }
+        else {
+            self.parent.postMessage(message, "*");
+        }
+    });
+    return promise.finally(() => self.removeEventListener("message", receiveSecrets));
+}
+//# sourceMappingURL=utils.js.map

package/dist-esm/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,YAAY,CAAC;AACjD;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,+BAA+B,CAAC;AAC1E;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,qBAAqB,CAAC;AA2BtE,SAAS,eAAe,CACtB,eAAgC;;IAEhC,IAAI;QACF,MAAM,eAAe,GAAuB,IAAI,CAAC,KAAK,CACpD,kBAAkB,CAAC,MAAA,eAAe,CAAC,GAAG,CAAC,oBAAoB,CAAC,mCAAI,EAAE,CAAC,CACpE,CAAC;QAEF,wCAAwC;QACxC,mBAAmB;QACnB,yFAAyF;QACzF,OAAO;QACP,IAAI;QACJ,OAAO,eAAe,CAAC;KACxB;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CACX,kBAAkB,oBAAoB,wCAAwC;YAC5E,IAAI,CAAC,QAAQ,EACf,CAAC,CACF,CAAC;QACF,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;KAClE;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,eAAgC;IAEhC,OAAO,eAAe,CAAS,eAAe,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,iBAAiB,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,eAAgC;IAEhC,OAAO,iBAAiB,CAAS,eAAe,CAAC,CAAC,MAAM,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,mBAAmB,CAAS,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,aAAqB,EACrB,eAAgC;IAEhC,MAAM,MAAM,qBAAQ,aAAa,CAAE,CAAC,CAAC,mEAAmE;IACxG,MAAM,SAAS,GAAG,eAAe,CAAS,eAAe,CAAC,CAAC,MAAM,CAAC;IAElE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAiB,EAAE,EAAE;QAChD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,KAA2B,CAAC,CAAC,8DAA8D;IAC9I,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAA8B,aAAqB;IAC1E,OAAO,aAAa,CAAC,aAAa,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACjF,CAAC;AAOD;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAc,EACd,UAAkB,EAClB,MAAc;IAEd,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,0BAA0B,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,EAAE,UAAU,EAAE,GAAG,aAAa,EAAE,CAAC;IACvC,OAAO,CAAC,MAAuB,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAClF,CAAC;AAkBD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,YAA0B;IAC5D,IAAI,cAAyC,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACvD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAe,aAAa,EAAE,CAAC;QAEhE,cAAc,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;YAC5B,IAAI,CAAC,CAAC,gCAAgC,IAAI,IAAI,CAAC;gBAAE,OAAO;YAExD,MAAM,OAAO,GAAG,IAAI,CAAC,gCAAgC,CAAC,CAAC;YACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,kBAAkB,IAAI,OAAO,CAAC,EAAE;gBACnE,MAAM,CAAC,wCAAwC,CAAC,CAAC;aAClD;YAED,OAAO,CAAC,OAAO,CAAC,CAAC;QACnB,CAAC,CAAC;QAEF,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAEjD,MAAM,OAAO,GAAG;YACd,CAAC,gCAAgC,CAAC,EAAE;gBAClC,UAAU;gBACV,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;gBAC5B,YAAY;aACb;SACF,CAAC;QAEF,IAAI,YAAY,KAAK,KAAK,IAAI,WAAW,KAAK,aAAa,EAAE;YAC3D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;SAC9C;aAAM;YACL,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;SACvC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;AACpF,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Key for a search param, from which editor data will be loaded from.\n */\nexport const APIM_EDITOR_DATA_KEY = \"editorData\";\n/**\n * Key for a post message object, it's used to propagate changes from editor to the DevPortal. Used to prevent interference with other applications.\n */\nexport const APIM_ON_CHANGE_MESSAGE_KEY = \"customInputValueChangedMSAPIM\";\n/**\n * Key for a post message object, it's used to request and send secrets - token and user id, from the DevPortal. Used to prevent interference with other applications.\n */\nexport const APIM_ASK_FOR_SECRETS_MESSAGE_KEY = \"askForSecretsMSAPIM\";\n\n/**\n * Base of a values obj\n */\nexport type ValuesCommon = Record<string, unknown>;\n/**\n * All possible runtime environments\n */\nexport type Environment = \"development\" | \"publishing\" | \"runtime\" | \"error\";\n\n/** Information about the widget instance received from the Dev Portal */\nexport interface PortalData {\n  // /** web content's origin (URL) of your Dev Portal */\n  // origin: string;\n  /** current runtime environment */\n  environment: Environment;\n  /** ID of this particular instance of the widget */\n  instanceId: string;\n}\n\n/** JSON object with all the data you'll receive from the Dev Portal */\nexport interface EditorData<Values extends ValuesCommon> extends PortalData {\n  /** values you've set in the admin editor window */\n  values: Partial<Values>;\n}\n\nfunction parseWidgetData<Values extends ValuesCommon>(\n  urlSearchParams: URLSearchParams\n): EditorData<Values> {\n  try {\n    const urlEditorParams: EditorData<Values> = JSON.parse(\n      decodeURIComponent(urlSearchParams.get(APIM_EDITOR_DATA_KEY) ?? \"\")\n    );\n\n    // if (!(\"origin\" in urlEditorParams)) {\n    //   console.error(\n    //     \"Could not get 'origin' from the search params of the URL:\\n\" + self.location.href\n    //   );\n    // }\n    return urlEditorParams;\n  } catch (e) {\n    console.error(\n      `Could not get '${APIM_EDITOR_DATA_KEY}' from the search params of the URL:\\n` +\n        self.location,\n      e\n    );\n    return { values: {}, environment: \"error\", instanceId: \"error\" };\n  }\n}\n\nexport function getWidgetDataPure<Values extends ValuesCommon>(\n  urlSearchParams: URLSearchParams\n): EditorData<Values> {\n  return parseWidgetData<Values>(urlSearchParams);\n}\n\n/**\n * Function to get all data related to the widget including technical values not expected to be needed in most cases.\n * Intended mostly for internal use, API might change. Consider using getValues or getEditorValues instead.\n */\nexport function getWidgetData<Values extends ValuesCommon>(): EditorData<Values> {\n  return getWidgetDataPure(new URLSearchParams(self.location.search));\n}\n\nexport function getEditorValuesPure<Values extends ValuesCommon>(\n  urlSearchParams: URLSearchParams\n): Partial<Values> {\n  return getWidgetDataPure<Values>(urlSearchParams).values;\n}\n\n/**\n * Function to get values you've set in the admin editor window.\n */\nexport function getEditorValues<Values extends ValuesCommon>(): Partial<Values> {\n  return getEditorValuesPure<Values>(new URLSearchParams(self.location.search));\n}\n\nexport function getValuesPure<Values extends ValuesCommon>(\n  valuesDefault: Values,\n  urlSearchParams: URLSearchParams\n): Values {\n  const values = { ...valuesDefault }; // set Obj to contain all possible values and prefill default value\n  const urlValues = parseWidgetData<Values>(urlSearchParams).values;\n\n  Object.keys(values).forEach((key: keyof Values) => {\n    const value = urlValues[key];\n    if (value != null && value !== \"\") values[key] = value as Values[typeof key]; // if value is specified in the URL, replace the default value\n  });\n  return values;\n}\n\n/**\n * Function to get values you've set in the admin editor window. Undefined/empty values are replaced with default values.\n *\n * @param valuesDefault - object with your default values to use, just import valuesDefault object from values.ts folder\n */\nexport function getValues<Values extends ValuesCommon>(valuesDefault: Values): Values {\n  return getValuesPure(valuesDefault, new URLSearchParams(self.location.search));\n}\n\n/**\n * Type of the onChange function.\n */\nexport type OnChange<Values extends ValuesCommon> = (values: Partial<Values>) => void;\n\n/**\n * The onChange function itself with 'origin' provided as a param.\n *\n * @param origin - web content's origin (URL) of your Dev Portal to send changes to\n * @param instanceId - ID of this particular instance of the widget\n * @param values - values that changed\n */\nexport function onChangeWithOrigin<Values extends ValuesCommon>(\n  origin: string,\n  instanceId: string,\n  values: Values\n): void {\n  Object.entries(values).forEach(([key, value]) => {\n    self.parent.postMessage({ [APIM_ON_CHANGE_MESSAGE_KEY]: { key, value, instanceId } }, origin);\n  });\n}\n\n/**\n * Build onChange function, which you can use, to send changed data from the editor.\n */\nexport function buildOnChange<Values extends ValuesCommon>(): OnChange<Values> {\n  const { instanceId } = getWidgetData();\n  return (values: Partial<Values>) => onChangeWithOrigin(\"*\", instanceId, values);\n}\n\n/**\n * Possible target modules\n * \"app\" for main application which is embedded in your Dev Portal\n * \"editor\" for form in admin panel\n */\nexport type TargetModule = \"app\" | \"editor\";\n/**\n * Secrets needed for communication with Dev Portal back-end\n */\nexport type Secrets = {\n  managementApiUrl: string;\n  apiVersion: string;\n  userId?: string;\n  token?: string;\n};\n\n/**\n * Request secrets - token & userId, from the Dev portal parent window.\n *\n * @param targetModule - is the function invoke from the main \"app\" window or the admin \"editor\"?\n */\nexport async function askForSecrets(targetModule: TargetModule): Promise<Secrets> {\n  let receiveSecrets: (e: MessageEvent) => void;\n\n  const promise = new Promise<Secrets>((resolve, reject) => {\n    const { instanceId, environment }: PortalData = getWidgetData();\n\n    receiveSecrets = ({ data }) => {\n      if (!(APIM_ASK_FOR_SECRETS_MESSAGE_KEY in data)) return;\n\n      const secrets = data[APIM_ASK_FOR_SECRETS_MESSAGE_KEY];\n      if (typeof secrets !== \"object\" || !(\"managementApiUrl\" in secrets)) {\n        reject(\"Secrets send by Dev Portal are invalid\");\n      }\n\n      resolve(secrets);\n    };\n\n    self.addEventListener(\"message\", receiveSecrets);\n\n    const message = {\n      [APIM_ASK_FOR_SECRETS_MESSAGE_KEY]: {\n        instanceId,\n        origin: self.location.origin,\n        targetModule,\n      },\n    };\n\n    if (targetModule === \"app\" && environment === \"development\") {\n      self.parent.parent.postMessage(message, \"*\");\n    } else {\n      self.parent.postMessage(message, \"*\");\n    }\n  });\n\n  return promise.finally(() => self.removeEventListener(\"message\", receiveSecrets));\n}\n"]}

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "@azure/api-management-custom-widgets-tools",
+  "version": "1.0.0-beta.1",
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "sdk-type": "client",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/apimanagement/api-management-custom-widgets-tools/README.md",
+  "repository": "github:Azure/azure-sdk-for-js",
+  "browser": {
+    "./dist-esm/src/node/deploy.js": "./dist-esm/src/node/deploy.browser.js"
+  },
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "keywords": [
+    "azure",
+    "cloud",
+    "typescript",
+    "apimanagement",
+    "developer-portal"
+  ],
+  "sideEffects": false,
+  "files": [
+    "dist/",
+    "dist-esm/src/",
+    "types/latest/api-management-custom-widgets-tools.d.ts",
+    "LICENSE"
+  ],
+  "main": "dist/index.js",
+  "module": "dist-esm/src/index.js",
+  "types": "types/latest/api-management-custom-widgets-tools.d.ts",
+  "scripts": {
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build:browser": "tsc -p . && dev-tool run bundle --browser-test=false",
+    "build:node": "tsc -p . && dev-tool run bundle",
+    "build:test": "npm run clean && tsc -p . && dev-tool run bundle",
+    "build:samples": "echo skip",
+    "build": "npm run clean && tsc -p . && dev-tool run bundle --browser-test=false && api-extractor run --local",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore --ignore-path ./.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-* types *.tgz *.log",
+    "extract-api": "tsc -p . && api-extractor run --local",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore --ignore-path ./.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "dev-tool run test:browser",
+    "integration-test:node": "echo skip",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json src test --ext .ts",
+    "pack": "npm pack 2>&1",
+    "test:browser": "echo skip",
+    "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
+    "test": "npm run clean && npm run build:test && npm run unit-test && npm run integration-test",
+    "unit-test:browser": "echo skip",
+    "unit-test:node": "npm run integration-test:node",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+  },
+  "devDependencies": {
+    "@azure/dev-tool": "^1.0.0",
+    "@azure-tools/test-recorder": "^2.0.0",
+    "@microsoft/api-extractor": "7.18.11",
+    "@types/chai": "^4.1.6",
+    "@types/mocha": "^7.0.2",
+    "@types/mime": "~2.0.3",
+    "@types/node": "^12.0.0",
+    "@types/glob": "^7.1.1",
+    "@types/inquirer": "^8.2.1",
+    "@types/yargs": "^17.0.10",
+    "@types/yargs-parser": "^21.0.0",
+    "@azure/eslint-plugin-azure-sdk": "^3.0.0",
+    "chai": "^4.2.0",
+    "cross-env": "^7.0.2",
+    "eslint": "^7.15.0",
+    "mocha": "^7.1.1",
+    "mocha-junit-reporter": "^2.0.0",
+    "prettier": "^2.5.1",
+    "nyc": "^15.0.0",
+    "rimraf": "^3.0.0",
+    "typescript": "~4.6.0",
+    "util": "^0.12.1",
+    "dotenv": "^8.2.0",
+    "@azure/test-utils": "^1.0.0",
+    "@types/mustache": "4.1.2",
+    "sinon": "^9.0.4",
+    "karma": "^6.2.0",
+    "karma-chrome-launcher": "^3.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-edge-launcher": "^0.4.2",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-ie-launcher": "^1.0.0",
+    "karma-json-preprocessor": "^0.3.3",
+    "karma-json-to-file-reporter": "^1.0.1",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "@types/sinon": "^9.0.4"
+  },
+  "dependencies": {
+    "@azure/identity": "^2.1.0",
+    "@azure-rest/core-client": "^1.0.0-beta.10",
+    "@azure/storage-blob": "^12.9.0",
+    "mime": "^3.0.0",
+    "mustache": "^4.2.0",
+    "prettier": "^2.5.1",
+    "glob": "^7.1.2",
+    "tslib": "^2.2.0",
+    "typescript": "~4.6.4",
+    "rollup": "~2.75.5",
+    "@rollup/plugin-node-resolve": "~13.3.0"
+  }
+}

package/types/latest/api-management-custom-widgets-tools.d.ts

@@ -0,0 +1,154 @@
+/**
+ * @packageDocumentation https://aka.ms/apimdocs/portal/customwidgets
+ */
+
+/**
+ * Key for a post message object, it's used to request and send secrets - token and user id, from the DevPortal. Used to prevent interference with other applications.
+ */
+export declare const APIM_ASK_FOR_SECRETS_MESSAGE_KEY = "askForSecretsMSAPIM";
+
+/** name of the configuration file */
+export declare const APIM_CONFIG_FILE_NAME = "config.msapim.json";
+
+/**
+ * Key for a search param, from which editor data will be loaded from.
+ */
+export declare const APIM_EDITOR_DATA_KEY = "editorData";
+
+/**
+ * Key for a post message object, it's used to propagate changes from editor to the DevPortal. Used to prevent interference with other applications.
+ */
+export declare const APIM_ON_CHANGE_MESSAGE_KEY = "customInputValueChangedMSAPIM";
+
+/**
+ * Request secrets - token & userId, from the Dev portal parent window.
+ *
+ * @param targetModule - is the function invoke from the main "app" window or the admin "editor"?
+ */
+export declare function askForSecrets(targetModule: TargetModule): Promise<Secrets>;
+
+/** name of the blob storage folder with widget configs */
+export declare const BLOB_CONFIGS_FOLDER = "configs";
+
+/** name of the blob storage folder with widget implementation */
+export declare const BLOB_DATA_FOLDER = "data";
+
+/** root of the blob storage folder */
+export declare const BLOB_ROOT = "custom-widgets";
+
+/**
+ * Generate relative path for widgets' config on the blob storage
+ *
+ * @param name - name of the widget
+ */
+export declare function buildBlobConfigPath(name: string): string;
+
+/**
+ * Generate relative path for widgets' data on the blob storage
+ *
+ * @param name - name of the widget
+ */
+export declare function buildBlobDataPath(name: string): string;
+
+/**
+ * Build onChange function, which you can use, to send changed data from the editor.
+ */
+export declare function buildOnChange<Values extends ValuesCommon>(): OnChange<Values>;
+
+/**
+ * Deploys everything from /dist folder to the API Management DevPortals' blob storage.
+ *
+ * @param serviceInformation - service information for deployment
+ * @param name - name of the widget to be deployed
+ * @param fallbackConfigPath - local path to the config file (by default "./static/config.msapim.json")
+ * @param rootLocal - optional, root of the local folder with compiled project to be exported (by default "./dist")
+ */
+export declare function deployNodeJS(serviceInformation: ServiceInformation, name: string, fallbackConfigPath?: string, rootLocal?: string): Promise<void>;
+
+/** JSON object with all the data you'll receive from the Dev Portal */
+export declare interface EditorData<Values extends ValuesCommon> extends PortalData {
+    /** values you've set in the admin editor window */
+    values: Partial<Values>;
+}
+
+/**
+ * All possible runtime environments
+ */
+export declare type Environment = "development" | "publishing" | "runtime" | "error";
+
+/**
+ * Function to get values you've set in the admin editor window.
+ */
+export declare function getEditorValues<Values extends ValuesCommon>(): Partial<Values>;
+
+/**
+ * Function to get values you've set in the admin editor window. Undefined/empty values are replaced with default values.
+ *
+ * @param valuesDefault - object with your default values to use, just import valuesDefault object from values.ts folder
+ */
+export declare function getValues<Values extends ValuesCommon>(valuesDefault: Values): Values;
+
+/**
+ * Function to get all data related to the widget including technical values not expected to be needed in most cases.
+ * Intended mostly for internal use, API might change. Consider using getValues or getEditorValues instead.
+ */
+export declare function getWidgetData<Values extends ValuesCommon>(): EditorData<Values>;
+
+/**
+ * Type of the onChange function.
+ */
+export declare type OnChange<Values extends ValuesCommon> = (values: Partial<Values>) => void;
+
+/**
+ * The onChange function itself with 'origin' provided as a param.
+ *
+ * @param origin - web content's origin (URL) of your Dev Portal to send changes to
+ * @param instanceId - ID of this particular instance of the widget
+ * @param values - values that changed
+ */
+export declare function onChangeWithOrigin<Values extends ValuesCommon>(origin: string, instanceId: string, values: Values): void;
+
+/** Information about the widget instance received from the Dev Portal */
+export declare interface PortalData {
+    /** current runtime environment */
+    environment: Environment;
+    /** ID of this particular instance of the widget */
+    instanceId: string;
+}
+
+/**
+ * Secrets needed for communication with Dev Portal back-end
+ */
+export declare type Secrets = {
+    managementApiUrl: string;
+    apiVersion: string;
+    userId?: string;
+    token?: string;
+};
+
+/**
+ * resourceId - resource ID of API Management service "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]"
+ * managementApiEndpoint - URL with protocol (e.g. https://management.azure.com)
+ * apiVersion - optional to override default (e.g. "2019-01-01")
+ * tokenOverride - optional, provides token to use for auth, instead of 'az login' approach
+ */
+export declare type ServiceInformation = {
+    resourceId: string;
+    managementApiEndpoint: string;
+    apiVersion?: string;
+    tokenOverride?: string;
+};
+
+/**
+ * Possible target modules
+ * "app" for main application which is embedded in your Dev Portal
+ * "editor" for form in admin panel
+ */
+export declare type TargetModule = "app" | "editor";
+
+/**
+ * Base of a values obj
+ */
+export declare type ValuesCommon = Record<string, unknown>;
+
+export { }