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

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

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../../src/node/deploy.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEnE;;;;;;;GAOG;AACH,iBAAe,MAAM,CACnB,kBAAkB,EAAE,kBAAkB,EACtC,IAAI,EAAE,MAAM,EACZ,kBAAkB,SAAsC,EACxD,EACE,SAAqB,EACrB,mCAA8E,GAC/E,GAAE,YAAiB,GACnB,OAAO,CAAC,IAAI,CAAC,CAiDf;AAED,eAAe,MAAM,CAAC"}

package/{dist-esm/src → dist/esm}/node/deploy.js

@@ -1,10 +1,10 @@
 // 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";
+// Licensed under the MIT License.
+import CustomWidgetBlobService from "./CustomWidgetBlobService.js";
+import { APIM_CONFIG_FILE_NAME } from "../paths.js";
+import fs from "node:fs";
+import getStorageSasUrl from "./getStorageSasUrl.js";
+import readdir from "./readdir.js";
 /**
  * Deploys everything from /dist folder to the API Management DevPortals' blob storage.
  *

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

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../src/node/deploy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,gBAAgB,MAAM,uBAAuB,CAAC;AACrD,OAAO,OAAO,MAAM,cAAc,CAAC;AAGnC;;;;;;;GAOG;AACH,KAAK,UAAU,MAAM,CACnB,kBAAsC,EACtC,IAAY,EACZ,kBAAkB,GAAG,WAAW,GAAG,qBAAqB,EACxD,EACE,SAAS,GAAG,SAAS,EACrB,mCAAmC,GAAG,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAC9D,EAAE;IAEpB,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,CAC3C,kBAAkB,EAClB,mCAAmC,CACpC,CAAC;IACF,MAAM,uBAAuB,GAAG,IAAI,uBAAuB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAElF,IAAI,MAA0B,CAAC;IAC/B,IAAI,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;QACjE,MAAM,GAAG,MAAM,uBAAuB,CAAC,SAAS,EAAE,CAAC;IACrD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,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;IACtE,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;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 type { Config } from \"./CustomWidgetBlobService.js\";\nimport CustomWidgetBlobService from \"./CustomWidgetBlobService.js\";\nimport { APIM_CONFIG_FILE_NAME } from \"../paths.js\";\nimport fs from \"node:fs\";\nimport getStorageSasUrl from \"./getStorageSasUrl.js\";\nimport readdir from \"./readdir.js\";\nimport type { DeployConfig, ServiceInformation } from \"./types.js\";\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 config - optional config object\n */\nasync function deploy(\n  serviceInformation: ServiceInformation,\n  name: string,\n  fallbackConfigPath = \"./static/\" + APIM_CONFIG_FILE_NAME,\n  {\n    rootLocal = \"./dist/\",\n    interactiveBrowserCredentialOptions = { redirectUri: \"http://localhost:1337\" },\n  }: DeployConfig = {},\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(\n    serviceInformation,\n    interactiveBrowserCredentialOptions,\n  );\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/node/getStorageSasUrl.d.ts

@@ -0,0 +1,10 @@
+import { type InteractiveBrowserCredentialNodeOptions as IBCNOptions } from "@azure/identity";
+import type { ServiceInformation } from "./types.js";
+/**
+ * Function to get storage SAS URL.
+ *
+ * @returns storage SAS URL
+ */
+declare function getStorageSasUrl({ managementApiEndpoint, resourceId, apiVersion, tokenOverride, }: ServiceInformation, interactiveBrowserCredentialOptions?: IBCNOptions): Promise<string>;
+export default getStorageSasUrl;
+//# sourceMappingURL=getStorageSasUrl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getStorageSasUrl.d.ts","sourceRoot":"","sources":["../../../src/node/getStorageSasUrl.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,uCAAuC,IAAI,WAAW,EAC5D,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAarD;;;;GAIG;AACH,iBAAe,gBAAgB,CAC7B,EACE,qBAAqB,EACrB,UAAU,EACV,UAAyB,EACzB,aAAa,GACd,EAAE,kBAAkB,EACrB,mCAAmC,CAAC,EAAE,WAAW,GAChD,OAAO,CAAC,MAAM,CAAC,CAgBjB;AAED,eAAe,gBAAgB,CAAC"}

package/dist/esm/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, options = {}) {
+    const credentials = new 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 = 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;
+}
+export default getStorageSasUrl;
+//# sourceMappingURL=getStorageSasUrl.js.map

package/dist/esm/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,EACL,4BAA4B,GAE7B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,KAAK,UAAU,cAAc,CAC3B,qBAA6B,EAC7B,UAAuB,EAAE;IAEzB,MAAM,WAAW,GAAG,IAAI,4BAA4B,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,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,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,eAAe,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/esm/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/esm/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-esm/src → dist/esm}/node/readdir.js

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import fs from "fs";
-import path from "path";
+// Licensed under the MIT License.
+import fs from "node:fs";
+import path from "node:path";
 function readdir(dir, root) {
     const results = [];
     fs.readdirSync(root + dir).forEach((file) => {

package/dist/esm/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,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,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,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,GAAG,IAAI,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,eAAe,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/esm/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/esm/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/esm/node/types.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/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/esm/package.json

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

package/dist/esm/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/esm/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/esm/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/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/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/esm/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/esm/utils.js

@@ -0,0 +1,122 @@
+// 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) {
+    try {
+        const urlEditorParams = JSON.parse(decodeURIComponent(urlSearchParams.get(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 '${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 = { ...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
+ */
+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/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,CAAC;QACH,MAAM,eAAe,GAAuB,IAAI,CAAC,KAAK,CACpD,kBAAkB,CAAC,eAAe,CAAC,GAAG,CAAC,oBAAoB,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,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;IACnE,CAAC;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,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,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;AA4BD;;;;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,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,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,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"]}