@esri/hub-common 11.2.0 → 11.3.0

package/dist/esm/urls/get-campaign-url.js

@@ -0,0 +1,25 @@
+import { __rest } from "tslib";
+import { getPortalUrl } from "./get-portal-url";
+import { btoa } from "abab";
+import { _getHubUrlFromPortalHostname } from "./_get-hub-url-from-portal-hostname";
+/**
+ * Builds a Hub "campaign" URL used as a single entry-point into
+ * Hub from external links, i.e. push notifications, emails, sms, etc,
+ * from which we can capture campaign-related telemetry before redirecting
+ * the user off to a provided destination.
+ * @param options.portal A string IPortal IHubRequestOptions or IRequestOptions object
+ * @param options.uri A URI that provides additional context for how to parse the provide meta
+ * @param options.meta An object of metadata for the campaign URL
+ * @param options.redirectURL A redirect URL
+ * @returns string A campaign URL
+ */
+export function getCampaignUrl(options) {
+    const { portal } = options, data = __rest(options, ["portal"]);
+    const portalUrl = getPortalUrl(portal);
+    const hubURL = _getHubUrlFromPortalHostname(portalUrl);
+    const url = new URL(`${hubURL}/c`);
+    const b64Data = btoa(JSON.stringify(data));
+    url.searchParams.set("d", b64Data);
+    return url.toString();
+}
+//# sourceMappingURL=get-campaign-url.js.map

package/dist/esm/urls/get-campaign-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-campaign-url.js","sourceRoot":"","sources":["../../../src/urls/get-campaign-url.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AASnF;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAC,OAA6B;IAC1D,MAAM,EAAE,MAAM,KAAc,OAAO,EAAhB,IAAI,UAAK,OAAO,EAA7B,UAAmB,CAAU,CAAC;IACpC,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC"}

package/dist/esm/urls/index.js

@@ -18,6 +18,7 @@ export * from "./getHubApiFromPortalUrl";
 export * from "./getPortalBaseFromOrgUrl";
 export * from "./getGroupHomeUrl";
 export * from "./getUserHomeUrl";
+export * from "./get-campaign-url";
 const MAP_OR_FEATURE_SERVER_URL_REGEX = /\/(map|feature)server/i;
 /**
  *

package/dist/esm/urls/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/urls/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AAEjC,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,GAAW,EAAE,EAAE;IACrD,OAAO,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IACnD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,YAAY,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC;AAC/D,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/urls/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AAEnC,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AAEjE;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,GAAW,EAAE,EAAE;IACrD,OAAO,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IACnD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,YAAY,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC;AAC/D,CAAC,CAAC"}

package/dist/node/urls/get-campaign-url.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCampaignUrl = void 0;
+const tslib_1 = require("tslib");
+const get_portal_url_1 = require("./get-portal-url");
+const abab_1 = require("abab");
+const _get_hub_url_from_portal_hostname_1 = require("./_get-hub-url-from-portal-hostname");
+/**
+ * Builds a Hub "campaign" URL used as a single entry-point into
+ * Hub from external links, i.e. push notifications, emails, sms, etc,
+ * from which we can capture campaign-related telemetry before redirecting
+ * the user off to a provided destination.
+ * @param options.portal A string IPortal IHubRequestOptions or IRequestOptions object
+ * @param options.uri A URI that provides additional context for how to parse the provide meta
+ * @param options.meta An object of metadata for the campaign URL
+ * @param options.redirectURL A redirect URL
+ * @returns string A campaign URL
+ */
+function getCampaignUrl(options) {
+    const { portal } = options, data = tslib_1.__rest(options, ["portal"]);
+    const portalUrl = get_portal_url_1.getPortalUrl(portal);
+    const hubURL = _get_hub_url_from_portal_hostname_1._getHubUrlFromPortalHostname(portalUrl);
+    const url = new URL(`${hubURL}/c`);
+    const b64Data = abab_1.btoa(JSON.stringify(data));
+    url.searchParams.set("d", b64Data);
+    return url.toString();
+}
+exports.getCampaignUrl = getCampaignUrl;
+//# sourceMappingURL=get-campaign-url.js.map

package/dist/node/urls/get-campaign-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-campaign-url.js","sourceRoot":"","sources":["../../../src/urls/get-campaign-url.ts"],"names":[],"mappings":";;;;AACA,qDAAgD;AAGhD,+BAA4B;AAC5B,2FAAmF;AASnF;;;;;;;;;;GAUG;AACH,SAAgB,cAAc,CAAC,OAA6B;IAC1D,MAAM,EAAE,MAAM,KAAc,OAAO,EAAhB,IAAI,kBAAK,OAAO,EAA7B,UAAmB,CAAU,CAAC;IACpC,MAAM,SAAS,GAAG,6BAAY,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,gEAA4B,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,WAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AARD,wCAQC"}

package/dist/node/urls/index.js

@@ -22,6 +22,7 @@ tslib_1.__exportStar(require("./getHubApiFromPortalUrl"), exports);
 tslib_1.__exportStar(require("./getPortalBaseFromOrgUrl"), exports);
 tslib_1.__exportStar(require("./getGroupHomeUrl"), exports);
 tslib_1.__exportStar(require("./getUserHomeUrl"), exports);
+tslib_1.__exportStar(require("./get-campaign-url"), exports);
 const MAP_OR_FEATURE_SERVER_URL_REGEX = /\/(map|feature)server/i;
 /**
  *

package/dist/node/urls/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/urls/index.ts"],"names":[],"mappings":";;;;AAAA,kCAAqC;AACrC,sDAA4B;AAC5B,qEAA2C;AAC3C,+DAAqC;AACrC,2DAAiC;AACjC,2DAAiC;AACjC,6DAAmC;AACnC,2DAAiC;AACjC,qEAA2C;AAC3C,0DAAgC;AAChC,wEAA8C;AAC9C,oEAA0C;AAC1C,8DAAoC;AACpC,6DAAmC;AACnC,8DAAoC;AACpC,wEAA8C;AAC9C,mEAAyC;AACzC,oEAA0C;AAC1C,4DAAkC;AAClC,2DAAiC;AAEjC,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AAEjE;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,CAAC,GAAW,EAAE,EAAE;IACrD,OAAO,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;GAKG;AACU,QAAA,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IACnD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,YAAY,IAAI,GAAG,iBAAU,CAAC,YAAY,CAAC,UAAU,CAAC;AAC/D,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/urls/index.ts"],"names":[],"mappings":";;;;AAAA,kCAAqC;AACrC,sDAA4B;AAC5B,qEAA2C;AAC3C,+DAAqC;AACrC,2DAAiC;AACjC,2DAAiC;AACjC,6DAAmC;AACnC,2DAAiC;AACjC,qEAA2C;AAC3C,0DAAgC;AAChC,wEAA8C;AAC9C,oEAA0C;AAC1C,8DAAoC;AACpC,6DAAmC;AACnC,8DAAoC;AACpC,wEAA8C;AAC9C,mEAAyC;AACzC,oEAA0C;AAC1C,4DAAkC;AAClC,2DAAiC;AACjC,6DAAmC;AAEnC,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AAEjE;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,CAAC,GAAW,EAAE,EAAE;IACrD,OAAO,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;GAKG;AACU,QAAA,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IACnD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,YAAY,IAAI,GAAG,iBAAU,CAAC,YAAY,CAAC,UAAU,CAAC;AAC/D,CAAC,CAAC"}

package/dist/types/urls/get-campaign-url.d.ts

@@ -0,0 +1,22 @@
+import { IHubRequestOptions } from "../types";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+interface IBuildHubCampaignUrl {
+    portal: string | IPortal | IHubRequestOptions | IRequestOptions;
+    uri: string;
+    meta: any;
+    redirectUrl: string;
+}
+/**
+ * Builds a Hub "campaign" URL used as a single entry-point into
+ * Hub from external links, i.e. push notifications, emails, sms, etc,
+ * from which we can capture campaign-related telemetry before redirecting
+ * the user off to a provided destination.
+ * @param options.portal A string IPortal IHubRequestOptions or IRequestOptions object
+ * @param options.uri A URI that provides additional context for how to parse the provide meta
+ * @param options.meta An object of metadata for the campaign URL
+ * @param options.redirectURL A redirect URL
+ * @returns string A campaign URL
+ */
+export declare function getCampaignUrl(options: IBuildHubCampaignUrl): string;
+export {};

package/dist/types/urls/index.d.ts

@@ -17,6 +17,7 @@ export * from "./getHubApiFromPortalUrl";
 export * from "./getPortalBaseFromOrgUrl";
 export * from "./getGroupHomeUrl";
 export * from "./getUserHomeUrl";
+export * from "./get-campaign-url";
 /**
  *
  * @param url

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "11.2.0",
+  "version": "11.3.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",