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

package/{types/latest/api-management-custom-widgets-tools.d.ts → dist/browser/utils.d.ts}

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

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 /**
  * Key for a search param, from which editor data will be loaded from.
  */
@@ -13,9 +13,8 @@ export const APIM_ON_CHANGE_MESSAGE_KEY = "customInputValueChangedMSAPIM";
  */
 export const APIM_ASK_FOR_SECRETS_MESSAGE_KEY = "askForSecretsMSAPIM";
 function parseWidgetData(urlSearchParams) {
-    var _a;
     try {
-        const urlEditorParams = JSON.parse(decodeURIComponent((_a = urlSearchParams.get(APIM_EDITOR_DATA_KEY)) !== null && _a !== void 0 ? _a : ""));
+        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
@@ -49,11 +48,11 @@ export function getEditorValues() {
     return getEditorValuesPure(new URLSearchParams(self.location.search));
 }
 export function getValuesPure(valuesDefault, urlSearchParams) {
-    const values = Object.assign({}, valuesDefault); // set Obj to contain all possible values and prefill default value
+    const 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 && value !== "")
+        if (value != null)
             values[key] = value; // if value is specified in the URL, replace the default value
     });
     return values;

package/dist/browser/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"]}

package/dist/commonjs/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/commonjs/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/commonjs/index.js

@@ -0,0 +1,29 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployNodeJS = exports.buildBlobConfigPath = exports.buildBlobDataPath = exports.BLOB_CONFIGS_FOLDER = exports.BLOB_DATA_FOLDER = exports.APIM_CONFIG_FILE_NAME = exports.BLOB_ROOT = exports.onChangeWithOrigin = exports.buildOnChange = exports.askForSecrets = exports.getValues = exports.getEditorValues = exports.getWidgetData = exports.APIM_ASK_FOR_SECRETS_MESSAGE_KEY = exports.APIM_ON_CHANGE_MESSAGE_KEY = exports.APIM_EDITOR_DATA_KEY = void 0;
+const tslib_1 = require("tslib");
+/**
+ * @packageDocumentation https://aka.ms/apimdocs/portal/customwidgets
+ */
+var utils_js_1 = require("./utils.js");
+Object.defineProperty(exports, "APIM_EDITOR_DATA_KEY", { enumerable: true, get: function () { return utils_js_1.APIM_EDITOR_DATA_KEY; } });
+Object.defineProperty(exports, "APIM_ON_CHANGE_MESSAGE_KEY", { enumerable: true, get: function () { return utils_js_1.APIM_ON_CHANGE_MESSAGE_KEY; } });
+Object.defineProperty(exports, "APIM_ASK_FOR_SECRETS_MESSAGE_KEY", { enumerable: true, get: function () { return utils_js_1.APIM_ASK_FOR_SECRETS_MESSAGE_KEY; } });
+Object.defineProperty(exports, "getWidgetData", { enumerable: true, get: function () { return utils_js_1.getWidgetData; } });
+Object.defineProperty(exports, "getEditorValues", { enumerable: true, get: function () { return utils_js_1.getEditorValues; } });
+Object.defineProperty(exports, "getValues", { enumerable: true, get: function () { return utils_js_1.getValues; } });
+Object.defineProperty(exports, "askForSecrets", { enumerable: true, get: function () { return utils_js_1.askForSecrets; } });
+Object.defineProperty(exports, "buildOnChange", { enumerable: true, get: function () { return utils_js_1.buildOnChange; } });
+Object.defineProperty(exports, "onChangeWithOrigin", { enumerable: true, get: function () { return utils_js_1.onChangeWithOrigin; } });
+var paths_js_1 = require("./paths.js");
+Object.defineProperty(exports, "BLOB_ROOT", { enumerable: true, get: function () { return paths_js_1.BLOB_ROOT; } });
+Object.defineProperty(exports, "APIM_CONFIG_FILE_NAME", { enumerable: true, get: function () { return paths_js_1.APIM_CONFIG_FILE_NAME; } });
+Object.defineProperty(exports, "BLOB_DATA_FOLDER", { enumerable: true, get: function () { return paths_js_1.BLOB_DATA_FOLDER; } });
+Object.defineProperty(exports, "BLOB_CONFIGS_FOLDER", { enumerable: true, get: function () { return paths_js_1.BLOB_CONFIGS_FOLDER; } });
+Object.defineProperty(exports, "buildBlobDataPath", { enumerable: true, get: function () { return paths_js_1.buildBlobDataPath; } });
+Object.defineProperty(exports, "buildBlobConfigPath", { enumerable: true, get: function () { return paths_js_1.buildBlobConfigPath; } });
+const deploy_js_1 = tslib_1.__importDefault(require("./node/deploy.js"));
+exports.deployNodeJS = deploy_js_1.default;
+//# sourceMappingURL=index.js.map

package/dist/commonjs/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,uCAUoB;AATlB,gHAAA,oBAAoB,OAAA;AACpB,sHAAA,0BAA0B,OAAA;AAC1B,4HAAA,gCAAgC,OAAA;AAChC,yGAAA,aAAa,OAAA;AACb,2GAAA,eAAe,OAAA;AACf,qGAAA,SAAS,OAAA;AACT,yGAAA,aAAa,OAAA;AACb,yGAAA,aAAa,OAAA;AACb,8GAAA,kBAAkB,OAAA;AAWpB,uCAOoB;AANlB,qGAAA,SAAS,OAAA;AACT,iHAAA,qBAAqB,OAAA;AACrB,4GAAA,gBAAgB,OAAA;AAChB,+GAAA,mBAAmB,OAAA;AACnB,6GAAA,iBAAiB,OAAA;AACjB,+GAAA,mBAAmB,OAAA;AAGrB,yEAA4C;AACnC,uBADF,mBAAY,CACE","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/commonjs/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/commonjs/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/commonjs/node/CustomWidgetBlobService.js

@@ -0,0 +1,68 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomWidgetBlobService = void 0;
+const storage_blob_1 = require("@azure/storage-blob");
+const paths_js_1 = require("../paths.js");
+/**
+ * A service wrapping ContainerClient class to simplify blob handling
+ */
+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 storage_blob_1.BlobServiceClient(blobStorageUrl.replace(`/${container}`, ""));
+        this.containerClient = blobServiceClient.getContainerClient(container);
+        this.name = name;
+        this.pathWidget = (0, paths_js_1.buildBlobDataPath)(name);
+        this.pathConfig = (0, paths_js_1.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);
+    }
+}
+exports.CustomWidgetBlobService = CustomWidgetBlobService;
+exports.default = CustomWidgetBlobService;
+//# sourceMappingURL=CustomWidgetBlobService.js.map

package/dist/commonjs/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,sDAAwD;AACxD,0CAAqE;AAIrE;;GAEG;AACH,MAAa,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,gCAAiB,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,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,IAAA,8BAAmB,EAAC,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;AAlED,0DAkEC;AAED,kBAAe,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/commonjs/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

package/dist/commonjs/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/commonjs/node/deploy.js

@@ -0,0 +1,59 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const CustomWidgetBlobService_js_1 = tslib_1.__importDefault(require("./CustomWidgetBlobService.js"));
+const paths_js_1 = require("../paths.js");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const getStorageSasUrl_js_1 = tslib_1.__importDefault(require("./getStorageSasUrl.js"));
+const readdir_js_1 = tslib_1.__importDefault(require("./readdir.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
+ */
+async function deploy(serviceInformation, name, fallbackConfigPath = "./static/" + paths_js_1.APIM_CONFIG_FILE_NAME, { rootLocal = "./dist/", interactiveBrowserCredentialOptions = { redirectUri: "http://localhost:1337" }, } = {}) {
+    console.log("\n\n");
+    console.log("Starting deploy process of custom widget: " + name);
+    console.log("Please, sign in to your Azure account when prompted\n");
+    const blobStorageUrl = await (0, getStorageSasUrl_js_1.default)(serviceInformation, interactiveBrowserCredentialOptions);
+    const customWidgetBlobService = new CustomWidgetBlobService_js_1.default(blobStorageUrl, name);
+    let config;
+    try {
+        console.log("Looking for config file in the Azure blob storage");
+        config = await customWidgetBlobService.getConfig();
+    }
+    catch (e) {
+        console.log("Config not found.");
+    }
+    if (!config) {
+        console.log("Looking for a local config file in: " + fallbackConfigPath);
+        config = JSON.parse(node_fs_1.default.readFileSync(fallbackConfigPath).toString());
+    }
+    if (!config) {
+        throw new Error("Config file could not be loaded.");
+    }
+    console.log("Config file loaded\n");
+    const files = (0, readdir_js_1.default)("", rootLocal);
+    console.log("Starting upload of data files from the '" + rootLocal + "' folder\n");
+    await customWidgetBlobService.cleanDataDir();
+    const promises = [];
+    files.forEach((file) => {
+        const content = node_fs_1.default.readFileSync(rootLocal + file);
+        const promise = customWidgetBlobService
+            .uploadWidgetDataFile(file, content)
+            .then(() => console.log("Uploaded file: " + file));
+        promises.push(promise);
+    });
+    await Promise.all(promises);
+    console.log(files.length + " files has been uploaded\n");
+    config.deployedOn = new Date();
+    await customWidgetBlobService.uploadConfig(config);
+    console.log("Uploaded updated config");
+}
+exports.default = deploy;
+//# sourceMappingURL=deploy.js.map

package/dist/commonjs/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,sGAAmE;AACnE,0CAAoD;AACpD,8DAAyB;AACzB,wFAAqD;AACrD,sEAAmC;AAGnC;;;;;;;GAOG;AACH,KAAK,UAAU,MAAM,CACnB,kBAAsC,EACtC,IAAY,EACZ,kBAAkB,GAAG,WAAW,GAAG,gCAAqB,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,IAAA,6BAAgB,EAC3C,kBAAkB,EAClB,mCAAmC,CACpC,CAAC;IACF,MAAM,uBAAuB,GAAG,IAAI,oCAAuB,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,iBAAE,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,IAAA,oBAAO,EAAC,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,iBAAE,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,kBAAe,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/commonjs/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/commonjs/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"}