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

package/dist/commonjs/node/getStorageSasUrl.js

@@ -0,0 +1,35 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const identity_1 = require("@azure/identity");
+const core_client_1 = require("@azure-rest/core-client");
+async function getAccessToken(managementApiEndpoint, options = {}) {
+    const credentials = new identity_1.InteractiveBrowserCredential(options);
+    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, }, interactiveBrowserCredentialOptions) {
+    const httpClient = (0, core_client_1.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 ??
+                (await getAccessToken(managementApiEndpoint, interactiveBrowserCredentialOptions)),
+        },
+    });
+    if (!response?.body?.containerSasUrl)
+        throw new Error("Could not get storage SAS URL");
+    return response.body.containerSasUrl;
+}
+exports.default = getStorageSasUrl;
+//# sourceMappingURL=getStorageSasUrl.js.map

package/dist/commonjs/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,8CAGyB;AAEzB,yDAAoD;AAEpD,KAAK,UAAU,cAAc,CAC3B,qBAA6B,EAC7B,UAAuB,EAAE;IAEzB,MAAM,WAAW,GAAG,IAAI,uCAA4B,CAAC,OAAO,CAAC,CAAC;IAC9D,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,CAC7B,EACE,qBAAqB,EACrB,UAAU,EACV,UAAU,GAAG,YAAY,EACzB,aAAa,GACM,EACrB,mCAAiD;IAEjD,MAAM,UAAU,GAAG,IAAA,uBAAS,EAAC,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,EACX,aAAa;gBACb,CAAC,MAAM,cAAc,CAAC,qBAAqB,EAAE,mCAAmC,CAAC,CAAC;SACrF;KACF,CAAC,CAAC;IAEL,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,eAAe;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACvF,OAAO,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC;AACvC,CAAC;AAED,kBAAe,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  InteractiveBrowserCredential,\n  type InteractiveBrowserCredentialNodeOptions as IBCNOptions,\n} from \"@azure/identity\";\nimport type { ServiceInformation } from \"./types.js\";\nimport { getClient } from \"@azure-rest/core-client\";\n\nasync function getAccessToken(\n  managementApiEndpoint: string,\n  options: IBCNOptions = {},\n): Promise<string> {\n  const credentials = new InteractiveBrowserCredential(options);\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  {\n    managementApiEndpoint,\n    resourceId,\n    apiVersion = \"2019-01-01\",\n    tokenOverride,\n  }: ServiceInformation,\n  interactiveBrowserCredentialOptions?: IBCNOptions,\n): 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:\n          tokenOverride ??\n          (await getAccessToken(managementApiEndpoint, interactiveBrowserCredentialOptions)),\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/commonjs/node/readdir.d.ts

@@ -0,0 +1,3 @@
+declare function readdir(dir: string, root: string): string[];
+export default readdir;
+//# sourceMappingURL=readdir.d.ts.map

package/dist/commonjs/node/readdir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readdir.d.ts","sourceRoot":"","sources":["../../../src/node/readdir.ts"],"names":[],"mappings":"AAMA,iBAAS,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAapD;AAED,eAAe,OAAO,CAAC"}

package/dist/commonjs/node/readdir.js

@@ -0,0 +1,22 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+function readdir(dir, root) {
+    const results = [];
+    node_fs_1.default.readdirSync(root + dir).forEach((file) => {
+        const stat = node_fs_1.default.statSync(root + dir + node_path_1.default.sep + file);
+        if (stat && stat.isDirectory()) {
+            results.push(...readdir(dir + file + node_path_1.default.sep, root));
+        }
+        else {
+            results.push(dir + file);
+        }
+    });
+    return results;
+}
+exports.default = readdir;
+//# sourceMappingURL=readdir.js.map

package/dist/commonjs/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,8DAAyB;AACzB,kEAA6B;AAE7B,SAAS,OAAO,CAAC,GAAW,EAAE,IAAY;IACxC,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,iBAAE,CAAC,WAAW,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,iBAAE,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,GAAG,mBAAI,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;QACvD,IAAI,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,GAAG,mBAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,kBAAe,OAAO,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport fs from \"node:fs\";\nimport path from \"node: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/commonjs/node/types.d.ts

@@ -0,0 +1,24 @@
+import type { InteractiveBrowserCredentialNodeOptions } from "@azure/identity";
+/**
+ * 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 type ServiceInformation = {
+    resourceId: string;
+    managementApiEndpoint: string;
+    apiVersion?: string;
+    tokenOverride?: string;
+};
+/**
+ * Optional options object for configuring the deployment function.
+ *
+ * @param rootLocal - optional, root of the local folder with compiled project to be exported (by default "./dist")
+ * @param interactiveBrowserCredentialOptions - options for InteractiveBrowserCredential for Node or InBrowser from \@azure/identity
+ */
+export type DeployConfig = {
+    rootLocal?: string;
+    interactiveBrowserCredentialOptions?: InteractiveBrowserCredentialNodeOptions;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/commonjs/node/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/node/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,iBAAiB,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC,CAAC,EAAE,uCAAuC,CAAC;CAC/E,CAAC"}

package/dist/commonjs/node/types.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/commonjs/node/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/node/types.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { InteractiveBrowserCredentialNodeOptions } from \"@azure/identity\";\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 * Optional options object for configuring the deployment function.\n *\n * @param rootLocal - optional, root of the local folder with compiled project to be exported (by default \"./dist\")\n * @param interactiveBrowserCredentialOptions - options for InteractiveBrowserCredential for Node or InBrowser from \\@azure/identity\n */\nexport type DeployConfig = {\n  rootLocal?: string;\n  interactiveBrowserCredentialOptions?: InteractiveBrowserCredentialNodeOptions;\n};\n"]}

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/paths.d.ts

@@ -0,0 +1,21 @@
+/** root of the blob storage folder */
+export declare const BLOB_ROOT = "custom-widgets";
+/** name of the blob storage folder with widget implementation */
+export declare const BLOB_DATA_FOLDER = "data";
+/** name of the blob storage folder with widget configs */
+export declare const BLOB_CONFIGS_FOLDER = "configs";
+/** name of the configuration file */
+export declare 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 declare function buildBlobDataPath(name: string): string;
+/**
+ * Generate relative path for widgets' config on the blob storage
+ *
+ * @param name - name of the widget
+ */
+export declare function buildBlobConfigPath(name: string): string;
+//# sourceMappingURL=paths.d.ts.map

package/dist/commonjs/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/paths.ts"],"names":[],"mappings":"AAGA,sCAAsC;AACtC,eAAO,MAAM,SAAS,mBAAmB,CAAC;AAC1C,iEAAiE;AACjE,eAAO,MAAM,gBAAgB,SAAS,CAAC;AACvC,0DAA0D;AAC1D,eAAO,MAAM,mBAAmB,YAAY,CAAC;AAC7C,qCAAqC;AACrC,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAExD"}

package/dist/commonjs/paths.js

@@ -0,0 +1,32 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIM_CONFIG_FILE_NAME = exports.BLOB_CONFIGS_FOLDER = exports.BLOB_DATA_FOLDER = exports.BLOB_ROOT = void 0;
+exports.buildBlobDataPath = buildBlobDataPath;
+exports.buildBlobConfigPath = buildBlobConfigPath;
+/** root of the blob storage folder */
+exports.BLOB_ROOT = "custom-widgets";
+/** name of the blob storage folder with widget implementation */
+exports.BLOB_DATA_FOLDER = "data";
+/** name of the blob storage folder with widget configs */
+exports.BLOB_CONFIGS_FOLDER = "configs";
+/** name of the configuration file */
+exports.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 `${exports.BLOB_ROOT}/${exports.BLOB_DATA_FOLDER}/${name}/`;
+}
+/**
+ * Generate relative path for widgets' config on the blob storage
+ *
+ * @param name - name of the widget
+ */
+function buildBlobConfigPath(name) {
+    return `${exports.BLOB_ROOT}/${exports.BLOB_CONFIGS_FOLDER}/${name}/${exports.APIM_CONFIG_FILE_NAME}`;
+}
+//# sourceMappingURL=paths.js.map

package/dist/commonjs/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/paths.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAgBlC,8CAEC;AAOD,kDAEC;AAzBD,sCAAsC;AACzB,QAAA,SAAS,GAAG,gBAAgB,CAAC;AAC1C,iEAAiE;AACpD,QAAA,gBAAgB,GAAG,MAAM,CAAC;AACvC,0DAA0D;AAC7C,QAAA,mBAAmB,GAAG,SAAS,CAAC;AAC7C,qCAAqC;AACxB,QAAA,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,IAAY;IAC5C,OAAO,GAAG,iBAAS,IAAI,wBAAgB,IAAI,IAAI,GAAG,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,IAAY;IAC9C,OAAO,GAAG,iBAAS,IAAI,2BAAmB,IAAI,IAAI,IAAI,6BAAqB,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/commonjs/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.10"
+    }
+  ]
+}

package/dist/commonjs/utils.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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";
+/**
+ * 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";
+/**
+ * Base of a values obj
+ */
+export type ValuesCommon = Record<string, unknown>;
+/**
+ * All possible runtime environments
+ */
+export type Environment = "development" | "publishing" | "runtime" | "error";
+/** Information about the widget instance received from the Dev Portal */
+export interface PortalData {
+    /** current runtime environment */
+    environment: Environment;
+    /** ID of this particular instance of the widget */
+    instanceId: string;
+}
+/** JSON object with all the data you'll receive from the Dev Portal */
+export interface EditorData<Values extends ValuesCommon> extends PortalData {
+    /** values you've set in the admin editor window */
+    values: Partial<Values>;
+}
+export declare function getWidgetDataPure<Values extends ValuesCommon>(urlSearchParams: URLSearchParams): EditorData<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>;
+export declare function getEditorValuesPure<Values extends ValuesCommon>(urlSearchParams: URLSearchParams): Partial<Values>;
+/**
+ * Function to get values you've set in the admin editor window.
+ */
+export declare function getEditorValues<Values extends ValuesCommon>(): Partial<Values>;
+export declare function getValuesPure<Values extends ValuesCommon>(valuesDefault: Values, urlSearchParams: URLSearchParams): 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;
+/**
+ * Type of the onChange function.
+ */
+export 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;
+/**
+ * Build onChange function, which you can use, to send changed data from the editor.
+ */
+export declare function buildOnChange<Values extends ValuesCommon>(): OnChange<Values>;
+/**
+ * Possible target modules
+ * "app" for main application which is embedded in your Dev Portal
+ * "editor" for form in admin panel
+ */
+export type TargetModule = "app" | "editor";
+/**
+ * Secrets needed for communication with Dev Portal back-end and other runtime data
+ */
+export type Secrets = {
+    managementApiUrl: string;
+    apiVersion: string;
+    userId?: string;
+    token?: string;
+    parentLocation: {
+        host: string;
+        hostname: string;
+        href: string;
+        origin: string;
+        pathname: string;
+        port: string;
+        protocol: string;
+        search: string;
+    };
+};
+/**
+ * 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>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/commonjs/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,oBAAoB,eAAe,CAAC;AACjD;;GAEG;AACH,eAAO,MAAM,0BAA0B,kCAAkC,CAAC;AAC1E;;GAEG;AACH,eAAO,MAAM,gCAAgC,wBAAwB,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACnD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC;AAE7E,yEAAyE;AACzE,MAAM,WAAW,UAAU;IAGzB,kCAAkC;IAClC,WAAW,EAAE,WAAW,CAAC;IACzB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,uEAAuE;AACvE,MAAM,WAAW,UAAU,CAAC,MAAM,SAAS,YAAY,CAAE,SAAQ,UAAU;IACzE,mDAAmD;IACnD,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AA0BD,wBAAgB,iBAAiB,CAAC,MAAM,SAAS,YAAY,EAC3D,eAAe,EAAE,eAAe,GAC/B,UAAU,CAAC,MAAM,CAAC,CAEpB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,SAAS,YAAY,KAAK,UAAU,CAAC,MAAM,CAAC,CAE/E;AAED,wBAAgB,mBAAmB,CAAC,MAAM,SAAS,YAAY,EAC7D,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,SAAS,YAAY,KAAK,OAAO,CAAC,MAAM,CAAC,CAE9E;AAED,wBAAgB,aAAa,CAAC,MAAM,SAAS,YAAY,EACvD,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,eAAe,GAC/B,MAAM,CASR;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,SAAS,YAAY,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,CAEpF;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,MAAM,SAAS,YAAY,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;AAEtF;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,YAAY,EAC5D,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,IAAI,CAIN;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,SAAS,YAAY,KAAK,QAAQ,CAAC,MAAM,CAAC,CAG7E;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,QAAQ,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE;QACd,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAmChF"}

package/dist/commonjs/utils.js

@@ -0,0 +1,134 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIM_ASK_FOR_SECRETS_MESSAGE_KEY = exports.APIM_ON_CHANGE_MESSAGE_KEY = exports.APIM_EDITOR_DATA_KEY = void 0;
+exports.getWidgetDataPure = getWidgetDataPure;
+exports.getWidgetData = getWidgetData;
+exports.getEditorValuesPure = getEditorValuesPure;
+exports.getEditorValues = getEditorValues;
+exports.getValuesPure = getValuesPure;
+exports.getValues = getValues;
+exports.onChangeWithOrigin = onChangeWithOrigin;
+exports.buildOnChange = buildOnChange;
+exports.askForSecrets = askForSecrets;
+/**
+ * Key for a search param, from which editor data will be loaded from.
+ */
+exports.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.
+ */
+exports.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.
+ */
+exports.APIM_ASK_FOR_SECRETS_MESSAGE_KEY = "askForSecretsMSAPIM";
+function parseWidgetData(urlSearchParams) {
+    try {
+        const urlEditorParams = JSON.parse(decodeURIComponent(urlSearchParams.get(exports.APIM_EDITOR_DATA_KEY) ?? ""));
+        // 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 '${exports.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 = { ...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)
+            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({ [exports.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 (!(exports.APIM_ASK_FOR_SECRETS_MESSAGE_KEY in data))
+                return;
+            const secrets = data[exports.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 = {
+            [exports.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/commonjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAgElC,8CAIC;AAMD,sCAEC;AAED,kDAIC;AAKD,0CAEC;AAED,sCAYC;AAOD,8BAEC;AAcD,gDAQC;AAKD,sCAGC;AAiCD,sCAmCC;AAhND;;GAEG;AACU,QAAA,oBAAoB,GAAG,YAAY,CAAC;AACjD;;GAEG;AACU,QAAA,0BAA0B,GAAG,+BAA+B,CAAC;AAC1E;;GAEG;AACU,QAAA,gCAAgC,GAAG,qBAAqB,CAAC;AA2BtE,SAAS,eAAe,CACtB,eAAgC;IAEhC,IAAI,CAAC;QACH,MAAM,eAAe,GAAuB,IAAI,CAAC,KAAK,CACpD,kBAAkB,CAAC,eAAe,CAAC,GAAG,CAAC,4BAAoB,CAAC,IAAI,EAAE,CAAC,CACpE,CAAC;QAEF,wCAAwC;QACxC,mBAAmB;QACnB,yFAAyF;QACzF,OAAO;QACP,IAAI;QACJ,OAAO,eAAe,CAAC;IACzB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CACX,kBAAkB,4BAAoB,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;IACnE,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAC/B,eAAgC;IAEhC,OAAO,eAAe,CAAS,eAAe,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa;IAC3B,OAAO,iBAAiB,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,SAAgB,mBAAmB,CACjC,eAAgC;IAEhC,OAAO,iBAAiB,CAAS,eAAe,CAAC,CAAC,MAAM,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe;IAC7B,OAAO,mBAAmB,CAAS,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,SAAgB,aAAa,CAC3B,aAAqB,EACrB,eAAgC;IAEhC,MAAM,MAAM,GAAG,EAAE,GAAG,aAAa,EAAE,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;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,KAA2B,CAAC,CAAC,8DAA8D;IAC9H,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAgB,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,SAAgB,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,kCAA0B,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,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;AA4BD;;;;GAIG;AACI,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,wCAAgC,IAAI,IAAI,CAAC;gBAAE,OAAO;YAExD,MAAM,OAAO,GAAG,IAAI,CAAC,wCAAgC,CAAC,CAAC;YACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,kBAAkB,IAAI,OAAO,CAAC,EAAE,CAAC;gBACpE,MAAM,CAAC,wCAAwC,CAAC,CAAC;YACnD,CAAC;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,wCAAgC,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,CAAC;YAC5D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACxC,CAAC;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) 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 and other runtime data\n */\nexport type Secrets = {\n  managementApiUrl: string;\n  apiVersion: string;\n  userId?: string;\n  token?: string;\n  parentLocation: {\n    host: string;\n    hostname: string;\n    href: string;\n    origin: string;\n    pathname: string;\n    port: string;\n    protocol: string;\n    search: string;\n  };\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/dist/esm/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @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.js";
+export type { PortalData, EditorData, OnChange, Secrets, TargetModule, ValuesCommon, Environment, } from "./utils.js";
+export { BLOB_ROOT, APIM_CONFIG_FILE_NAME, BLOB_DATA_FOLDER, BLOB_CONFIGS_FOLDER, buildBlobDataPath, buildBlobConfigPath, } from "./paths.js";
+import deployNodeJS from "./node/deploy.js";
+export { deployNodeJS };
+export type { ServiceInformation, DeployConfig } from "./node/types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;GAEG;AAEH,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,gCAAgC,EAChC,aAAa,EACb,eAAe,EACf,SAAS,EACT,aAAa,EACb,aAAa,EACb,kBAAkB,GACnB,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,UAAU,EACV,UAAU,EACV,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/esm/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.js";
+export { BLOB_ROOT, APIM_CONFIG_FILE_NAME, BLOB_DATA_FOLDER, BLOB_CONFIGS_FOLDER, buildBlobDataPath, buildBlobConfigPath, } from "./paths.js";
+import deployNodeJS from "./node/deploy.js";
+export { deployNodeJS };
+//# sourceMappingURL=index.js.map

package/dist/esm/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,YAAY,CAAC;AAUpB,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAC5C,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.js\";\nexport type {\n  PortalData,\n  EditorData,\n  OnChange,\n  Secrets,\n  TargetModule,\n  ValuesCommon,\n  Environment,\n} from \"./utils.js\";\nexport {\n  BLOB_ROOT,\n  APIM_CONFIG_FILE_NAME,\n  BLOB_DATA_FOLDER,\n  BLOB_CONFIGS_FOLDER,\n  buildBlobDataPath,\n  buildBlobConfigPath,\n} from \"./paths.js\";\n\nimport deployNodeJS from \"./node/deploy.js\";\nexport { deployNodeJS };\nexport type { ServiceInformation, DeployConfig } from \"./node/types.js\";\n"]}

package/dist/esm/node/CustomWidgetBlobService.d.ts

@@ -0,0 +1,27 @@
+import type { BlockBlobUploadResponse } from "@azure/storage-blob";
+export type Config = Record<string, unknown>;
+/**
+ * A service wrapping ContainerClient class to simplify blob handling
+ */
+export declare class CustomWidgetBlobService {
+    readonly containerClient: import("@azure/storage-blob").ContainerClient;
+    readonly name: string;
+    readonly pathWidget: string;
+    readonly pathConfig: string;
+    /**
+     * @param blobStorageUrl - blob storage SAS URL
+     * @param name - name of the custom widget to be taken care of
+     */
+    constructor(blobStorageUrl: string, name: string);
+    private extractFileName;
+    blobUpload(absolutePath: string, content: Buffer): Promise<BlockBlobUploadResponse>;
+    jsonUpload(absolutePath: string, json: Record<string, unknown>): Promise<BlockBlobUploadResponse>;
+    blobDownload(absolutePath: string): Promise<Buffer>;
+    dirDelete(absolutePath: string): Promise<void>;
+    uploadWidgetDataFile(file: string, content: Buffer): Promise<BlockBlobUploadResponse>;
+    cleanDataDir(): Promise<void>;
+    getConfig(): Promise<Config>;
+    uploadConfig(config: Config): Promise<BlockBlobUploadResponse>;
+}
+export default CustomWidgetBlobService;
+//# sourceMappingURL=CustomWidgetBlobService.d.ts.map

package/dist/esm/node/CustomWidgetBlobService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomWidgetBlobService.d.ts","sourceRoot":"","sources":["../../../src/node/CustomWidgetBlobService.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAInE,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE7C;;GAEG;AACH,qBAAa,uBAAuB;IAClC,QAAQ,CAAC,eAAe,gDAAC;IACzB,QAAQ,CAAC,IAAI,SAAC;IACd,QAAQ,CAAC,UAAU,SAAC;IACpB,QAAQ,CAAC,UAAU,SAAC;IAEpB;;;OAGG;gBACS,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAShD,OAAO,CAAC,eAAe;IAIjB,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAUnF,UAAU,CACd,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,uBAAuB,CAAC;IAI7B,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAInD,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM9C,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIrF,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAK5B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAGrE;AAED,eAAe,uBAAuB,CAAC"}

package/dist/esm/node/CustomWidgetBlobService.js

@@ -0,0 +1,64 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { BlobServiceClient } from "@azure/storage-blob";
+import { buildBlobConfigPath, buildBlobDataPath } from "../paths.js";
+/**
+ * A service wrapping ContainerClient class to simplify blob handling
+ */
+export class CustomWidgetBlobService {
+    containerClient;
+    name;
+    pathWidget;
+    pathConfig;
+    /**
+     * @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 mimeImport = await import("mime");
+        const mime = mimeImport.default;
+        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) {
+        for await (const blob of await this.containerClient.listBlobsFlat({ prefix: absolutePath })) {
+            await this.containerClient.deleteBlob(blob.name);
+        }
+    }
+    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/node/CustomWidgetBlobService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomWidgetBlobService.js","sourceRoot":"","sources":["../../../src/node/CustomWidgetBlobService.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAIrE;;GAEG;AACH,MAAM,OAAO,uBAAuB;IACzB,eAAe,CAAC;IAChB,IAAI,CAAC;IACL,UAAU,CAAC;IACX,UAAU,CAAC;IAEpB;;;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,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC;QAChC,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;QAClC,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;YAC5F,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;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 type { BlockBlobUploadResponse } from \"@azure/storage-blob\";\nimport { BlobServiceClient } from \"@azure/storage-blob\";\nimport { buildBlobConfigPath, buildBlobDataPath } from \"../paths.js\";\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 mimeImport = await import(\"mime\");\n    const mime = mimeImport.default;\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/node/deploy.d.ts

@@ -0,0 +1,12 @@
+import type { DeployConfig, ServiceInformation } from "./types.js";
+/**
+ * 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 config - optional config object
+ */
+declare function deploy(serviceInformation: ServiceInformation, name: string, fallbackConfigPath?: string, { rootLocal, interactiveBrowserCredentialOptions, }?: DeployConfig): Promise<void>;
+export default deploy;
+//# sourceMappingURL=deploy.d.ts.map