@esri/hub-common 14.60.1 → 14.61.0

package/dist/esm/core/index.js

@@ -6,6 +6,7 @@ export * from "./fetchHubEntity";
 export * from "./getTypeFromEntity";
 export * from "./getRelativeWorkspaceUrl";
 export * from "./isValidEntityType";
+export * from "./processActionLinks";
 // For sme reason, if updateHubEntity is exported here,
 // it is not actually exported in the final package.
 // export * from "./updateHubEntity";

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AAEpC,uDAAuD;AACvD,oDAAoD;AACpD,qCAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AAErC,uDAAuD;AACvD,oDAAoD;AACpD,qCAAqC"}

package/dist/esm/core/processActionLinks.js

@@ -0,0 +1,62 @@
+import { hubSearch } from "../search";
+/**
+ * Given an array of IHubActionLinks, the following util will
+ * "pre-process" the action links. This includes:
+ *
+ * 1. For kind = "content": Fetching the content item, grabbing
+ * its site relative href, and transforming the link into an
+ * external action link that can be consumed in the UI
+ *
+ * Note: we can add other pre-processing as necessary
+ *
+ * @param links hub action links
+ * @param requestOptions hub request options
+ */
+export async function processActionLinks(links, requestOptions) {
+    const processedActionLinks = await Promise.all(links.map(async (link) => {
+        return processActionLink(link, requestOptions);
+    }));
+    return processedActionLinks;
+}
+/**
+ * Given a single IHubActionLink, the following util will
+ * "pre-process" the action link. This includes:
+ *
+ * 1. For kind = "content": Fetching the content item, grabbing
+ * its site relative href, and transforming the link into an
+ * external action link that can be consumed in the UI
+ *
+ * Note: we can add other pre-processing as necessary
+ *
+ * @param link hub action link
+ * @param requestOptions hub request options
+ */
+export async function processActionLink(link, requestOptions) {
+    // recursively process nested links
+    if (link.kind === "section") {
+        link.children = await processActionLinks(link.children, requestOptions);
+    }
+    if (link.kind === "content") {
+        try {
+            // 1. query for the content item so we can grab its
+            // siteRelative href
+            const query = {
+                targetEntity: "item",
+                filters: [{ predicates: [{ id: link.contentId }] }],
+            };
+            const { results } = await hubSearch(query, { requestOptions });
+            // 2. construct a new "external" action link
+            // with the content item's site relative href
+            delete link.contentId;
+            const processedLink = Object.assign(Object.assign({}, link), { kind: "external", href: results[0].links.siteRelative });
+            return processedLink;
+        }
+        catch (error) {
+            throw new Error(`Unable to fetch entity: ${link.contentId}`);
+        }
+    }
+    else {
+        return link;
+    }
+}
+//# sourceMappingURL=processActionLinks.js.map

package/dist/esm/core/processActionLinks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processActionLinks.js","sourceRoot":"","sources":["../../../src/core/processActionLinks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,SAAS,EAAE,MAAM,WAAW,CAAC;AAQ9C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAsB,EACtB,cAAkC;IAElC,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC5C,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAmB,EAAE,EAAE;QACtC,OAAO,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,IAAmB,EACnB,cAAkC;IAElC,mCAAmC;IACnC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,IAAI,CAAC,QAAQ,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;KACzE;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,IAAI;YACF,mDAAmD;YACnD,oBAAoB;YACpB,MAAM,KAAK,GAAW;gBACpB,YAAY,EAAE,MAAM;gBACpB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;aACpD,CAAC;YACF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;YAE/D,4CAA4C;YAC5C,6CAA6C;YAC7C,OAAO,IAAI,CAAC,SAAS,CAAC;YACtB,MAAM,aAAa,mCACd,IAAI,KACP,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,GACpC,CAAC;YAEF,OAAO,aAAa,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;SAC9D;KACF;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC"}

package/dist/node/core/index.js

@@ -9,6 +9,7 @@ tslib_1.__exportStar(require("./fetchHubEntity"), exports);
 tslib_1.__exportStar(require("./getTypeFromEntity"), exports);
 tslib_1.__exportStar(require("./getRelativeWorkspaceUrl"), exports);
 tslib_1.__exportStar(require("./isValidEntityType"), exports);
+tslib_1.__exportStar(require("./processActionLinks"), exports);
 // For sme reason, if updateHubEntity is exported here,
 // it is not actually exported in the final package.
 // export * from "./updateHubEntity";

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,kDAAwB;AACxB,sDAA4B;AAC5B,oDAA0B;AAC1B,2DAAiC;AACjC,8DAAoC;AACpC,oEAA0C;AAC1C,8DAAoC;AAEpC,uDAAuD;AACvD,oDAAoD;AACpD,qCAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,kDAAwB;AACxB,sDAA4B;AAC5B,oDAA0B;AAC1B,2DAAiC;AACjC,8DAAoC;AACpC,oEAA0C;AAC1C,8DAAoC;AACpC,+DAAqC;AAErC,uDAAuD;AACvD,oDAAoD;AACpD,qCAAqC"}

package/dist/node/core/processActionLinks.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processActionLink = exports.processActionLinks = void 0;
+const search_1 = require("../search");
+/**
+ * Given an array of IHubActionLinks, the following util will
+ * "pre-process" the action links. This includes:
+ *
+ * 1. For kind = "content": Fetching the content item, grabbing
+ * its site relative href, and transforming the link into an
+ * external action link that can be consumed in the UI
+ *
+ * Note: we can add other pre-processing as necessary
+ *
+ * @param links hub action links
+ * @param requestOptions hub request options
+ */
+async function processActionLinks(links, requestOptions) {
+    const processedActionLinks = await Promise.all(links.map(async (link) => {
+        return processActionLink(link, requestOptions);
+    }));
+    return processedActionLinks;
+}
+exports.processActionLinks = processActionLinks;
+/**
+ * Given a single IHubActionLink, the following util will
+ * "pre-process" the action link. This includes:
+ *
+ * 1. For kind = "content": Fetching the content item, grabbing
+ * its site relative href, and transforming the link into an
+ * external action link that can be consumed in the UI
+ *
+ * Note: we can add other pre-processing as necessary
+ *
+ * @param link hub action link
+ * @param requestOptions hub request options
+ */
+async function processActionLink(link, requestOptions) {
+    // recursively process nested links
+    if (link.kind === "section") {
+        link.children = await processActionLinks(link.children, requestOptions);
+    }
+    if (link.kind === "content") {
+        try {
+            // 1. query for the content item so we can grab its
+            // siteRelative href
+            const query = {
+                targetEntity: "item",
+                filters: [{ predicates: [{ id: link.contentId }] }],
+            };
+            const { results } = await search_1.hubSearch(query, { requestOptions });
+            // 2. construct a new "external" action link
+            // with the content item's site relative href
+            delete link.contentId;
+            const processedLink = Object.assign(Object.assign({}, link), { kind: "external", href: results[0].links.siteRelative });
+            return processedLink;
+        }
+        catch (error) {
+            throw new Error(`Unable to fetch entity: ${link.contentId}`);
+        }
+    }
+    else {
+        return link;
+    }
+}
+exports.processActionLink = processActionLink;
+//# sourceMappingURL=processActionLinks.js.map

package/dist/node/core/processActionLinks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processActionLinks.js","sourceRoot":"","sources":["../../../src/core/processActionLinks.ts"],"names":[],"mappings":";;;AAAA,sCAA8C;AAQ9C;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,kBAAkB,CACtC,KAAsB,EACtB,cAAkC;IAElC,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC5C,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAmB,EAAE,EAAE;QACtC,OAAO,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC,CAAC,CACH,CAAC;IAEF,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAXD,gDAWC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAmB,EACnB,cAAkC;IAElC,mCAAmC;IACnC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,IAAI,CAAC,QAAQ,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;KACzE;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,IAAI;YACF,mDAAmD;YACnD,oBAAoB;YACpB,MAAM,KAAK,GAAW;gBACpB,YAAY,EAAE,MAAM;gBACpB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;aACpD,CAAC;YACF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,kBAAS,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;YAE/D,4CAA4C;YAC5C,6CAA6C;YAC7C,OAAO,IAAI,CAAC,SAAS,CAAC;YACtB,MAAM,aAAa,mCACd,IAAI,KACP,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,GACpC,CAAC;YAEF,OAAO,aAAa,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;SAC9D;KACF;SAAM;QACL,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAlCD,8CAkCC"}

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

@@ -6,3 +6,4 @@ export * from "./fetchHubEntity";
 export * from "./getTypeFromEntity";
 export * from "./getRelativeWorkspaceUrl";
 export * from "./isValidEntityType";
+export * from "./processActionLinks";

package/dist/types/core/processActionLinks.d.ts

@@ -0,0 +1,30 @@
+import { IHubRequestOptions } from "../types";
+import { HubActionLink, IHubContentActionLink } from "./types";
+/**
+ * Given an array of IHubActionLinks, the following util will
+ * "pre-process" the action links. This includes:
+ *
+ * 1. For kind = "content": Fetching the content item, grabbing
+ * its site relative href, and transforming the link into an
+ * external action link that can be consumed in the UI
+ *
+ * Note: we can add other pre-processing as necessary
+ *
+ * @param links hub action links
+ * @param requestOptions hub request options
+ */
+export declare function processActionLinks(links: HubActionLink[], requestOptions: IHubRequestOptions): Promise<Array<Exclude<HubActionLink, IHubContentActionLink>>>;
+/**
+ * Given a single IHubActionLink, the following util will
+ * "pre-process" the action link. This includes:
+ *
+ * 1. For kind = "content": Fetching the content item, grabbing
+ * its site relative href, and transforming the link into an
+ * external action link that can be consumed in the UI
+ *
+ * Note: we can add other pre-processing as necessary
+ *
+ * @param link hub action link
+ * @param requestOptions hub request options
+ */
+export declare function processActionLink(link: HubActionLink, requestOptions: IHubRequestOptions): Promise<Exclude<HubActionLink, IHubContentActionLink>>;

package/package.json

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