@esri/hub-common 14.178.0 → 14.180.0

package/dist/node/downloads/_internal/getDownloadConfigurationDisplayFormats.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDownloadConfigurationDisplayFormats = void 0;
+const content_1 = require("../../content");
+const get_prop_1 = require("../../objects/get-prop");
+const getDownloadConfiguration_1 = require("../getDownloadConfiguration");
+const getCreateReplicaFormats_1 = require("./format-fetchers/getCreateReplicaFormats");
+const getPagingJobFormats_1 = require("./format-fetchers/getPagingJobFormats");
+const utils_1 = require("./additional-resources/utils");
+/**
+ * @private
+ * Returns configuration objects for each download format that should be displayed
+ * in the editing experience of a content entity. This function should not be used
+ * to calculate the download formats that should be present on the live UI.
+ * @param entity entity to get download format configurations for
+ * @returns download format configurations to display
+ */
+function getDownloadConfigurationDisplayFormats(entity) {
+    const configuration = getDownloadConfiguration_1.getDownloadConfiguration(entity);
+    const flowType = configuration.flowType;
+    let formats = configuration.formats;
+    // For feature or map services that don't meet the criteria to be downloaded (i.e., no flowType)
+    // Product wants to show paging formats as a preview of what _could_ be downloaded should
+    // the criteria be met.
+    if (!flowType && ["Feature Service", "Map Service"].includes(entity.type)) {
+        const pagingFormats = getPagingJobFormats_1.getPagingJobFormats().map((f) => {
+            return {
+                key: f.format,
+                hidden: false,
+            };
+        });
+        // TODO: Should we just show paging formats as a preview or include additional resources?
+        formats = pagingFormats;
+    }
+    // For main entities of a hosted feature service with extract disabled, we want to display
+    // the list of createReplica formats as a preview of what _could_ be downloaded should
+    // the extract capability be enabled
+    if (content_1.isHostedFeatureServiceMainEntity(entity) &&
+        flowType !== "createReplica") {
+        const createReplicaFormats = getCreateReplicaFormats_1.getCreateReplicaFormats(entity).map((f) => {
+            return {
+                key: f.format,
+                hidden: false,
+            };
+        });
+        formats = createReplicaFormats;
+    }
+    const additionalResources = get_prop_1.getProp(entity, "extendedProps.additionalResources") || [];
+    return formats.map((f) => utils_1.isAdditionalResourceConfiguration(f)
+        ? toAdditionalResourceConfigurationDisplay(f, additionalResources)
+        : toDownloadFormatConfigurationDisplay(f));
+}
+exports.getDownloadConfigurationDisplayFormats = getDownloadConfigurationDisplayFormats;
+// Converts a download format configuration storage object to a display object
+// (i.e., adds appropriate labels, etc.)
+function toDownloadFormatConfigurationDisplay(config) {
+    return Object.assign({ label: `{{shared.fields.download.format.${config.key}:translate}}` }, config);
+}
+// Converts an additional resource configuration storage object to a display object
+// (i.e., adds appropriate labels, etc.)
+function toAdditionalResourceConfigurationDisplay(config, additionalResources) {
+    const resourceIndex = utils_1.getAdditionalResourceIndex(config);
+    const { name, isDataSource } = additionalResources[resourceIndex];
+    let label;
+    // Prefer the name of the additional resource if it exists
+    if (name) {
+        label = `{{shared.fields.download.additionalResource|resourceName=${encodeURIComponent(name)}:translate}}`;
+        // If the additional resource is the data source...
+    }
+    else if (isDataSource) {
+        label = "{{shared.fields.download.dataSourceResource:translate}}";
+        // If the additional resource has no name...
+    }
+    else {
+        label = "{{shared.fields.download.noTitleResource:translate}}";
+    }
+    return Object.assign({ label }, config);
+}
+//# sourceMappingURL=getDownloadConfigurationDisplayFormats.js.map

package/dist/node/downloads/_internal/getDownloadConfigurationDisplayFormats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDownloadConfigurationDisplayFormats.js","sourceRoot":"","sources":["../../../../src/downloads/_internal/getDownloadConfigurationDisplayFormats.ts"],"names":[],"mappings":";;;AAAA,2CAAiE;AAOjE,qDAAiD;AACjD,0EAAuE;AACvE,uFAAoF;AAEpF,+EAA4E;AAC5E,wDAGsC;AAEtC;;;;;;;GAOG;AACH,SAAgB,sCAAsC,CACpD,MAA2B;IAE3B,MAAM,aAAa,GAAG,mDAAwB,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IACxC,IAAI,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;IAEpC,gGAAgG;IAChG,yFAAyF;IACzF,uBAAuB;IACvB,IAAI,CAAC,QAAQ,IAAI,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACzE,MAAM,aAAa,GACjB,yCAAmB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC9B,OAAO;gBACL,GAAG,EAAE,CAAC,CAAC,MAAM;gBACb,MAAM,EAAE,KAAK;aACd,CAAC;QACJ,CAAC,CAAC,CAAC;QACL,yFAAyF;QACzF,OAAO,GAAG,aAAa,CAAC;KACzB;IAED,0FAA0F;IAC1F,sFAAsF;IACtF,oCAAoC;IACpC,IACE,0CAAgC,CAAC,MAAM,CAAC;QACxC,QAAQ,KAAK,eAAe,EAC5B;QACA,MAAM,oBAAoB,GACxB,iDAAuB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACxC,OAAO;gBACL,GAAG,EAAE,CAAC,CAAC,MAAM;gBACb,MAAM,EAAE,KAAK;aACd,CAAC;QACJ,CAAC,CAAC,CAAC;QACL,OAAO,GAAG,oBAAoB,CAAC;KAChC;IAED,MAAM,mBAAmB,GACvB,kBAAO,CAAC,MAAM,EAAE,mCAAmC,CAAC,IAAI,EAAE,CAAC;IAE7D,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACvB,yCAAiC,CAAC,CAAC,CAAC;QAClC,CAAC,CAAC,wCAAwC,CAAC,CAAC,EAAE,mBAAmB,CAAC;QAClE,CAAC,CAAC,oCAAoC,CAAC,CAAC,CAAC,CAC5C,CAAC;AACJ,CAAC;AA/CD,wFA+CC;AAED,8EAA8E;AAC9E,wCAAwC;AACxC,SAAS,oCAAoC,CAC3C,MAAoC;IAEpC,uBACE,KAAK,EAAE,mCAAmC,MAAM,CAAC,GAAG,cAAc,IAC/D,MAAM,EACT;AACJ,CAAC;AAED,mFAAmF;AACnF,wCAAwC;AACxC,SAAS,wCAAwC,CAC/C,MAAoC,EACpC,mBAA6C;IAE7C,MAAM,aAAa,GAAG,kCAA0B,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAElE,IAAI,KAAK,CAAC;IACV,0DAA0D;IAC1D,IAAI,IAAI,EAAE;QACR,KAAK,GAAG,4DAA4D,kBAAkB,CACpF,IAAI,CACL,cAAc,CAAC;QAChB,mDAAmD;KACpD;SAAM,IAAI,YAAY,EAAE;QACvB,KAAK,GAAG,yDAAyD,CAAC;QAClE,4CAA4C;KAC7C;SAAM;QACL,KAAK,GAAG,sDAAsD,CAAC;KAChE;IAED,uBACE,KAAK,IACF,MAAM,EACT;AACJ,CAAC"}

package/dist/node/downloads/_internal/getDownloadFlow.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDownloadFlow = void 0;
+const canUseCreateReplica_1 = require("../canUseCreateReplica");
+const canUseHubDownloadSystem_1 = require("../canUseHubDownloadSystem");
+const canUseExportImageFlow_1 = require("./canUseExportImageFlow");
+/**
+ * @private
+ * Determines the download flow that will be used for the current entity.
+ * If the entity cannot be downloaded, returns null.
+ *
+ * @param entity the entity to get the download flow for
+ * @param isEnterprise whether the the download will be executed in an enterprise environment
+ * @returns the download flow that will be used for the current entity
+ */
+function getDownloadFlow(entity, isEnterprise) {
+    let downloadFlow = null;
+    if (canUseCreateReplica_1.canUseCreateReplica(entity)) {
+        downloadFlow = "createReplica";
+    }
+    else if (canUseHubDownloadSystem_1.canUseHubDownloadSystem(entity) && !isEnterprise) {
+        downloadFlow = "paging";
+    }
+    else if (canUseExportImageFlow_1.canUseExportImageFlow(entity)) {
+        downloadFlow = "exportImage";
+    }
+    return downloadFlow;
+}
+exports.getDownloadFlow = getDownloadFlow;
+//# sourceMappingURL=getDownloadFlow.js.map

package/dist/node/downloads/_internal/getDownloadFlow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDownloadFlow.js","sourceRoot":"","sources":["../../../../src/downloads/_internal/getDownloadFlow.ts"],"names":[],"mappings":";;;AACA,gEAA6D;AAC7D,wEAAqE;AACrE,mEAAgE;AAEhE;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,MAA2B,EAC3B,YAAsB;IAEtB,IAAI,YAAY,GAAqB,IAAI,CAAC;IAC1C,IAAI,yCAAmB,CAAC,MAAM,CAAC,EAAE;QAC/B,YAAY,GAAG,eAAe,CAAC;KAChC;SAAM,IAAI,iDAAuB,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE;QAC3D,YAAY,GAAG,QAAQ,CAAC;KACzB;SAAM,IAAI,6CAAqB,CAAC,MAAM,CAAC,EAAE;QACxC,YAAY,GAAG,aAAa,CAAC;KAC9B;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAbD,0CAaC"}

package/dist/node/downloads/_internal/getDownloadFormatsByFlow.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDownloadFormatsByFlow = void 0;
+const getCreateReplicaFormats_1 = require("./format-fetchers/getCreateReplicaFormats");
+const getExportImageFormats_1 = require("./format-fetchers/getExportImageFormats");
+const getPagingJobFormats_1 = require("./format-fetchers/getPagingJobFormats");
+/**
+ * @private
+ * Get the download formats for a given download flow and entity.
+ *
+ * @param downloadFlow DownloadFlowType
+ * @param entity IHubEditableContent
+ * @returns IDynamicDownloadFormat[]
+ */
+function getDownloadFormatsByFlow(downloadFlow, entity) {
+    let downloadFormats = [];
+    const actionsByFlow = {
+        createReplica: () => {
+            downloadFormats = getCreateReplicaFormats_1.getCreateReplicaFormats(entity);
+        },
+        paging: () => {
+            downloadFormats = getPagingJobFormats_1.getPagingJobFormats();
+        },
+        exportImage: () => {
+            downloadFormats = getExportImageFormats_1.getExportImageFormats(entity);
+        },
+    };
+    actionsByFlow[downloadFlow] && actionsByFlow[downloadFlow]();
+    return downloadFormats;
+}
+exports.getDownloadFormatsByFlow = getDownloadFormatsByFlow;
+//# sourceMappingURL=getDownloadFormatsByFlow.js.map

package/dist/node/downloads/_internal/getDownloadFormatsByFlow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDownloadFormatsByFlow.js","sourceRoot":"","sources":["../../../../src/downloads/_internal/getDownloadFormatsByFlow.ts"],"names":[],"mappings":";;;AAKA,uFAAoF;AACpF,mFAAgF;AAChF,+EAA4E;AAE5E;;;;;;;GAOG;AACH,SAAgB,wBAAwB,CACtC,YAA8B,EAC9B,MAA2B;IAE3B,IAAI,eAAe,GAA6B,EAAE,CAAC;IACnD,MAAM,aAAa,GAAyC;QAC1D,aAAa,EAAE,GAAG,EAAE;YAClB,eAAe,GAAG,iDAAuB,CAAC,MAAM,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,EAAE,GAAG,EAAE;YACX,eAAe,GAAG,yCAAmB,EAAE,CAAC;QAC1C,CAAC;QACD,WAAW,EAAE,GAAG,EAAE;YAChB,eAAe,GAAG,6CAAqB,CAAC,MAAM,CAAC,CAAC;QAClD,CAAC;KACF,CAAC;IACF,aAAa,CAAC,YAAY,CAAC,IAAI,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,OAAO,eAAe,CAAC;AACzB,CAAC;AAlBD,4DAkBC"}

package/dist/node/downloads/fetchDownloadFile.js

@@ -4,6 +4,7 @@ exports.fetchDownloadFile = void 0;
 const HubError_1 = require("../HubError");
 const canUseExportImageFlow_1 = require("./_internal/canUseExportImageFlow");
 const canUseHubDownloadApi_1 = require("./canUseHubDownloadApi");
+const getDownloadFormats_1 = require("./getDownloadFormats");
 /**
  * Fetches a download file URL for the given entity and format.
  * @param options options to refine / filter the results of the fetchDownloadFile operation
@@ -11,6 +12,8 @@ const canUseHubDownloadApi_1 = require("./canUseHubDownloadApi");
  * @throws {ArcgisHubDownloadError} if the download file URL cannot be fetched for a well-known reason
  */
 async function fetchDownloadFile(options) {
+    // Make sure that format requested has been enabled for the entity
+    validateFormat(options);
     // If the pollInterval is not set, default to 3 seconds
     const withPollInterval = options.pollInterval == null ? Object.assign(Object.assign({}, options), { pollInterval: 3000 }) : options;
     let fetchingFn;
@@ -26,4 +29,21 @@ async function fetchDownloadFile(options) {
     return fetchingFn(withPollInterval);
 }
 exports.fetchDownloadFile = fetchDownloadFile;
+/**
+ * Validates the format requested is enabled for the entity
+ * @param options options for the fetchDownloadFile operation
+ * @throws {HubError} if the format requested is not enabled for the entity
+ */
+function validateFormat(options) {
+    const { entity, context, format } = options;
+    const validServerFormats = getDownloadFormats_1.getDownloadFormats({
+        entity,
+        context,
+    })
+        .filter((f) => f.type === "dynamic")
+        .map((f) => f.format);
+    if (!validServerFormats.includes(format)) {
+        throw new HubError_1.default("fetchDownloadFile", `The following format is not enabled for the entity: ${format}`);
+    }
+}
 //# sourceMappingURL=fetchDownloadFile.js.map

package/dist/node/downloads/fetchDownloadFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchDownloadFile.js","sourceRoot":"","sources":["../../../src/downloads/fetchDownloadFile.ts"],"names":[],"mappings":";;;AAAA,0CAAmC;AACnC,6EAA0E;AAC1E,iEAA8D;AAG9D;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CACrC,OAAkC;IAElC,uDAAuD;IACvD,MAAM,gBAAgB,GACpB,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,iCAAM,OAAO,KAAE,YAAY,EAAE,IAAI,IAAG,CAAC,CAAC,OAAO,CAAC;IAE9E,IAAI,UAAU,CAAC;IACf,IAAI,2CAAoB,CAAC,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAC3E,UAAU,GAAG,CACX,2CAAa,uDAAuD,EAAC,CACtE,CAAC,uBAAuB,CAAC;KAC3B;SAAM,IAAI,6CAAqB,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;QACzD,UAAU,GAAG,CACX,2CAAa,4DAA4D,EAAC,CAC3E,CAAC,4BAA4B,CAAC;KAChC;SAAM;QACL,MAAM,IAAI,kBAAQ,CAChB,mBAAmB,EACnB,+DAA+D,CAChE,CAAC;KACH;IACD,OAAO,UAAU,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC;AAvBD,8CAuBC"}
+{"version":3,"file":"fetchDownloadFile.js","sourceRoot":"","sources":["../../../src/downloads/fetchDownloadFile.ts"],"names":[],"mappings":";;;AAAA,0CAAmC;AACnC,6EAA0E;AAC1E,iEAA8D;AAC9D,6DAA0D;AAQ1D;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CACrC,OAAkC;IAElC,kEAAkE;IAClE,cAAc,CAAC,OAAO,CAAC,CAAC;IAExB,uDAAuD;IACvD,MAAM,gBAAgB,GACpB,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,iCAAM,OAAO,KAAE,YAAY,EAAE,IAAI,IAAG,CAAC,CAAC,OAAO,CAAC;IAE9E,IAAI,UAAU,CAAC;IACf,IAAI,2CAAoB,CAAC,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAC3E,UAAU,GAAG,CACX,2CAAa,uDAAuD,EAAC,CACtE,CAAC,uBAAuB,CAAC;KAC3B;SAAM,IAAI,6CAAqB,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;QACzD,UAAU,GAAG,CACX,2CAAa,4DAA4D,EAAC,CAC3E,CAAC,4BAA4B,CAAC;KAChC;SAAM;QACL,MAAM,IAAI,kBAAQ,CAChB,mBAAmB,EACnB,+DAA+D,CAChE,CAAC;KACH;IACD,OAAO,UAAU,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC;AA1BD,8CA0BC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,OAAkC;IACxD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC5C,MAAM,kBAAkB,GAA4B,uCAAkB,CAAC;QACrE,MAAM;QACN,OAAO;KACR,CAAC;SACC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC;SACnC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAA4B,CAAC,MAAM,CAAC,CAAC;IACpD,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACxC,MAAM,IAAI,kBAAQ,CAChB,mBAAmB,EACnB,uDAAuD,MAAM,EAAE,CAChE,CAAC;KACH;AACH,CAAC"}

package/dist/node/downloads/fetchDownloadFormats.js

@@ -4,11 +4,15 @@ exports.fetchDownloadFormats = void 0;
 const canUseExportImageFlow_1 = require("./_internal/canUseExportImageFlow");
 const canUseHubDownloadApi_1 = require("./canUseHubDownloadApi");
 /**
+ * DEPRECATED: This will be removed in the next breaking version. Use "getDownloadFormats()" instead.
+ *
  * Fetches download formats for the given entity. Also folds in any additional resources defined on the entity.
  * @param options options to refine / filter the results of the fetchDownloadFormats operation
  * @returns a promise that resolves with the download formats
  */
 async function fetchDownloadFormats(options) {
+    /* tslint:disable no-console */
+    console.warn(`"fetchDownloadFormats()" is deprecated. Please use "getDownloadFormats()"`);
     const { entity, context, layers } = options;
     // fetch base formats for the item
     let baseFormats = [];

package/dist/node/downloads/fetchDownloadFormats.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchDownloadFormats.js","sourceRoot":"","sources":["../../../src/downloads/fetchDownloadFormats.ts"],"names":[],"mappings":";;;AACA,6EAA0E;AAC1E,iEAA8D;AAO9D;;;;GAIG;AACI,KAAK,UAAU,oBAAoB,CACxC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC5C,kCAAkC;IAClC,IAAI,WAAW,GAAsB,EAAE,CAAC;IACxC,IAAI,2CAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACzC,MAAM,EAAE,wBAAwB,EAAE,GAAG,2CACnC,4BAA4B,EAC7B,CAAC;QACF,WAAW,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;KAChD;SAAM,IAAI,6CAAqB,CAAC,MAAM,CAAC,EAAE;QACxC,MAAM,EAAE,qBAAqB,EAAE,GAAG,2CAChC,mDAAmD,EACpD,CAAC;QACF,WAAW,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;KAC7C;IAED,kDAAkD;IAClD,0DAA0D;IAC1D,MAAM,iBAAiB,GAAG,CAAC,MAAM,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC,GAAG,CAC9D,cAAc,CACf,CAAC;IAEF,mCAAmC;IACnC,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,iBAAiB,CAAC,CAAC;AAChD,CAAC;AA1BD,oDA0BC;AAED,SAAS,cAAc,CACrB,QAAgC;IAEhC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EACH,QAAQ,CAAC,IAAI;YACb,CAAC,QAAQ,CAAC,YAAY,IAAI,0BAA0B,CAAC,IAAI,+CAA+C;YACxG,uBAAuB;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;KAClB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"fetchDownloadFormats.js","sourceRoot":"","sources":["../../../src/downloads/fetchDownloadFormats.ts"],"names":[],"mappings":";;;AACA,6EAA0E;AAC1E,iEAA8D;AAO9D;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,OAAqC;IAErC,+BAA+B;IAC/B,OAAO,CAAC,IAAI,CACV,2EAA2E,CAC5E,CAAC;IAEF,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC5C,kCAAkC;IAClC,IAAI,WAAW,GAAsB,EAAE,CAAC;IACxC,IAAI,2CAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACzC,MAAM,EAAE,wBAAwB,EAAE,GAAG,2CACnC,4BAA4B,EAC7B,CAAC;QACF,WAAW,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;KAChD;SAAM,IAAI,6CAAqB,CAAC,MAAM,CAAC,EAAE;QACxC,MAAM,EAAE,qBAAqB,EAAE,GAAG,2CAChC,mDAAmD,EACpD,CAAC;QACF,WAAW,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;KAC7C;IAED,kDAAkD;IAClD,0DAA0D;IAC1D,MAAM,iBAAiB,GAAG,CAAC,MAAM,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC,GAAG,CAC9D,cAAc,CACf,CAAC;IAEF,mCAAmC;IACnC,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,iBAAiB,CAAC,CAAC;AAChD,CAAC;AA/BD,oDA+BC;AAED,SAAS,cAAc,CACrB,QAAgC;IAEhC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EACH,QAAQ,CAAC,IAAI;YACb,CAAC,QAAQ,CAAC,YAAY,IAAI,0BAA0B,CAAC,IAAI,+CAA+C;YACxG,uBAAuB;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;KAClB,CAAC;AACJ,CAAC"}

package/dist/node/downloads/getDownloadConfiguration.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDownloadConfiguration = void 0;
+const get_prop_1 = require("../objects/get-prop");
+const getDownloadFlow_1 = require("./_internal/getDownloadFlow");
+const getDownloadFormatsByFlow_1 = require("./_internal/getDownloadFormatsByFlow");
+/**
+ * Returns the download configuration for an entity at this moment in time.
+ *
+ * If no configuration exists, a default configuration is returned based on the entity's current download flow.
+ * If a configuration exists but is no longer valid, the default configuration will also be returned.
+ *
+ * @param entity entity to get download configuration for
+ * @returns the current download configuration for the entity
+ */
+function getDownloadConfiguration(entity) {
+    // TODO: account for enterprise environments
+    const downloadFlow = getDownloadFlow_1.getDownloadFlow(entity);
+    const serverFormats = getDownloadFormatsByFlow_1.getDownloadFormatsByFlow(downloadFlow, entity);
+    const additionalResources = get_prop_1.getProp(entity, "extendedProps.additionalResources") || [];
+    const existingConfiguration = get_prop_1.getProp(entity, "extendedProps.downloads");
+    // Base combined default formats
+    const combinedDefaultFormats = serverFormats.map((f) => {
+        return {
+            key: f.format,
+            hidden: false,
+        };
+    });
+    additionalResources.forEach((f, idx) => {
+        combinedDefaultFormats.push({
+            key: `additionalResource::${idx}`,
+            hidden: false,
+        });
+    });
+    const shouldUseExistingConfiguration = existingConfiguration && existingConfiguration.flowType === downloadFlow;
+    // Existing configuration matches the current flow
+    if (shouldUseExistingConfiguration) {
+        const missingDefaultFormats = combinedDefaultFormats.filter((f) => {
+            return !existingConfiguration.formats.find((df) => df.key === f.key);
+        });
+        const validConfiguredFormats = existingConfiguration.formats.filter((f) => {
+            return combinedDefaultFormats.find((df) => df.key === f.key);
+        });
+        return {
+            flowType: downloadFlow,
+            formats: [...validConfiguredFormats, ...missingDefaultFormats],
+        };
+    }
+    // Existing configuration does not match the current flow
+    return {
+        flowType: downloadFlow,
+        formats: combinedDefaultFormats,
+    };
+}
+exports.getDownloadConfiguration = getDownloadConfiguration;
+//# sourceMappingURL=getDownloadConfiguration.js.map

package/dist/node/downloads/getDownloadConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDownloadConfiguration.js","sourceRoot":"","sources":["../../../src/downloads/getDownloadConfiguration.ts"],"names":[],"mappings":";;;AAMA,kDAA8C;AAC9C,iEAA8D;AAC9D,mFAAgF;AAEhF;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CACtC,MAA2B;IAE3B,4CAA4C;IAC5C,MAAM,YAAY,GAAG,iCAAe,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,mDAAwB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACrE,MAAM,mBAAmB,GACvB,kBAAO,CAAC,MAAM,EAAE,mCAAmC,CAAC,IAAI,EAAE,CAAC;IAC7D,MAAM,qBAAqB,GAAiC,kBAAO,CACjE,MAAM,EACN,yBAAyB,CAC1B,CAAC;IAEF,gCAAgC;IAChC,MAAM,sBAAsB,GAC1B,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAgC,EAAE;QACpD,OAAO;YACL,GAAG,EAAE,CAAC,CAAC,MAAM;YACb,MAAM,EAAE,KAAK;SACd,CAAC;IACJ,CAAC,CAAC,CAAC;IACL,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;QACrC,sBAAsB,CAAC,IAAI,CAAC;YAC1B,GAAG,EAAE,uBAAuB,GAAG,EAAE;YACjC,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,8BAA8B,GAClC,qBAAqB,IAAI,qBAAqB,CAAC,QAAQ,KAAK,YAAY,CAAC;IAE3E,kDAAkD;IAClD,IAAI,8BAA8B,EAAE;QAClC,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YAChE,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,MAAM,sBAAsB,GAAG,qBAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACxE,OAAO,sBAAsB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QACH,OAAO;YACL,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,CAAC,GAAG,sBAAsB,EAAE,GAAG,qBAAqB,CAAC;SAC/D,CAAC;KACH;IAED,yDAAyD;IACzD,OAAO;QACL,QAAQ,EAAE,YAAY;QACtB,OAAO,EAAE,sBAAsB;KAChC,CAAC;AACJ,CAAC;AAlDD,4DAkDC"}

package/dist/node/downloads/getDownloadFormats.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDownloadFormats = void 0;
+const get_prop_1 = require("../objects/get-prop");
+const canUseExportImageFlow_1 = require("./_internal/canUseExportImageFlow");
+const getExportImageFormats_1 = require("./_internal/format-fetchers/getExportImageFormats");
+const utils_1 = require("./_internal/additional-resources/utils");
+const canUseHubDownloadApi_1 = require("./canUseHubDownloadApi");
+const getDownloadConfiguration_1 = require("./getDownloadConfiguration");
+const getHubDownloadApiFormats_1 = require("./getHubDownloadApiFormats");
+/**
+ * Gets available download formats / additional resources for the given entity in the order they have been configured.
+ * If a format has been configured to be hidden, it will not be included in the results.
+ *
+ * @param options options to refine / filter the results of the fetchDownloadFormats operation
+ * @returns The available download formats and additional resources
+ */
+function getDownloadFormats(options) {
+    const { entity, context } = options;
+    // get the base formats for the item
+    let baseFormats = [];
+    // TODO: use typescript to enforce a branch for each flow type
+    if (canUseHubDownloadApi_1.canUseHubDownloadApi(entity, context)) {
+        baseFormats = getHubDownloadApiFormats_1.getHubDownloadApiFormats(entity);
+    }
+    else if (canUseExportImageFlow_1.canUseExportImageFlow(entity)) {
+        baseFormats = getExportImageFormats_1.getExportImageFormats(entity);
+    }
+    // add additional resource links as static formats
+    const additionalResources = get_prop_1.getProp(entity, "extendedProps.additionalResources") || [];
+    const additionalFormats = additionalResources.map(toStaticFormat);
+    // Respect the order and visibility of the formats as configured for the entity
+    const downloadConfiguration = getDownloadConfiguration_1.getDownloadConfiguration(entity);
+    return downloadConfiguration.formats.reduce((acc, format) => {
+        if (!format.hidden) {
+            let includedFormat;
+            if (utils_1.isAdditionalResourceConfiguration(format)) {
+                const additionalResourceIndex = utils_1.getAdditionalResourceIndex(format);
+                includedFormat = additionalFormats[additionalResourceIndex];
+            }
+            else {
+                baseFormats.forEach((baseFormat) => {
+                    if (baseFormat.format === format.key) {
+                        includedFormat = baseFormat;
+                    }
+                });
+            }
+            acc.push(includedFormat);
+        }
+        return acc;
+    }, []);
+}
+exports.getDownloadFormats = getDownloadFormats;
+function toStaticFormat(resource) {
+    return {
+        type: "static",
+        label: resource.name ||
+            (resource.isDataSource && `{{dataSource:translate}}`) || // if the additional resource is the datasource
+            `{{noTitle:translate}}`,
+        url: resource.url,
+    };
+}
+//# sourceMappingURL=getDownloadFormats.js.map

package/dist/node/downloads/getDownloadFormats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDownloadFormats.js","sourceRoot":"","sources":["../../../src/downloads/getDownloadFormats.ts"],"names":[],"mappings":";;;AACA,kDAA8C;AAC9C,6EAA0E;AAC1E,6FAA0F;AAC1F,kEAGgD;AAChD,iEAA8D;AAC9D,yEAAsE;AACtE,yEAAsE;AAQtE;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACpC,oCAAoC;IACpC,IAAI,WAAW,GAA6B,EAAE,CAAC;IAC/C,8DAA8D;IAC9D,IAAI,2CAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACzC,WAAW,GAAG,mDAAwB,CAAC,MAAM,CAAC,CAAC;KAChD;SAAM,IAAI,6CAAqB,CAAC,MAAM,CAAC,EAAE;QACxC,WAAW,GAAG,6CAAqB,CAAC,MAAM,CAAC,CAAC;KAC7C;IAED,kDAAkD;IAClD,MAAM,mBAAmB,GACvB,kBAAO,CAAC,MAAM,EAAE,mCAAmC,CAAC,IAAI,EAAE,CAAC;IAC7D,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAElE,+EAA+E;IAC/E,MAAM,qBAAqB,GAAG,mDAAwB,CAAC,MAAM,CAAC,CAAC;IAC/D,OAAO,qBAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QAC1D,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,IAAI,cAAc,CAAC;YACnB,IAAI,yCAAiC,CAAC,MAAM,CAAC,EAAE;gBAC7C,MAAM,uBAAuB,GAAG,kCAA0B,CAAC,MAAM,CAAC,CAAC;gBACnE,cAAc,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;aAC7D;iBAAM;gBACL,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;oBACjC,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,GAAG,EAAE;wBACpC,cAAc,GAAG,UAAU,CAAC;qBAC7B;gBACH,CAAC,CAAC,CAAC;aACJ;YACD,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SAC1B;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AArCD,gDAqCC;AAED,SAAS,cAAc,CACrB,QAAgC;IAEhC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EACH,QAAQ,CAAC,IAAI;YACb,CAAC,QAAQ,CAAC,YAAY,IAAI,0BAA0B,CAAC,IAAI,+CAA+C;YACxG,uBAAuB;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;KAClB,CAAC;AACJ,CAAC"}

package/dist/node/downloads/index.js

@@ -9,4 +9,6 @@ tslib_1.__exportStar(require("./canUseCreateReplica"), exports);
 tslib_1.__exportStar(require("./canUseHubDownloadSystem"), exports);
 tslib_1.__exportStar(require("./canUseHubDownloadApi"), exports);
 tslib_1.__exportStar(require("./getHubDownloadApiFormats"), exports);
+tslib_1.__exportStar(require("./getDownloadConfiguration"), exports);
+tslib_1.__exportStar(require("./getDownloadFormats"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/downloads/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,kDAAwB;AACxB,8DAAoC;AACpC,iEAAuC;AACvC,gEAAsC;AACtC,oEAA0C;AAC1C,iEAAuC;AACvC,qEAA2C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/downloads/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,kDAAwB;AACxB,8DAAoC;AACpC,iEAAuC;AACvC,gEAAsC;AACtC,oEAA0C;AAC1C,iEAAuC;AACvC,qEAA2C;AAC3C,qEAA2C;AAC3C,+DAAqC"}

package/dist/types/content/_internal/getDownloadsSection.d.ts

@@ -0,0 +1,13 @@
+import { IUiSchemaElement } from "../../core/schemas/types";
+import { IHubEditableContent } from "../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Constructs the downloads section for an IHubEditableContent entity.
+ * Due to numerous product requirements, the content and state of this section
+ * can vary greatly depending on the entity type and configuration.
+ *
+ * @param i18nScope translation scope
+ * @param entity entity to get the downloads section for
+ * @returns ui schema elements for the downloads section
+ */
+export declare function getDownloadsSection(i18nScope: string, entity: IHubEditableContent): IUiSchemaElement;

package/dist/types/content/_internal/shouldShowDownloadsConfiguration.d.ts

@@ -0,0 +1,13 @@
+import { IHubEditableContent } from "../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Determines if the downloads configuration should be shown for an entity.
+ *
+ * NOTE: product has asked that the download configuration be shown for entities that _can_
+ * be downloaded, as well as certain entities that _cannot_ be downloaded currently, but
+ * could be downloaded with a change in item / service settings.
+ *
+ * @param entity entity to check
+ * @returns whether downloads configuration should be shown
+ */
+export declare function shouldShowDownloadsConfiguration(entity: IHubEditableContent): boolean;

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

@@ -40,6 +40,7 @@ export interface IInfoConfig {
 }
 export interface ICardActionLink {
     action?: string;
+    ariaLabel?: string;
     href?: string;
     i18nKey?: string;
     label?: string;

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

@@ -52,6 +52,49 @@ export interface IHubEditableContent extends IHubItemEntity, IWithSlug, IWithPer
  * This is a discriminated union of the possible additional props.
  */
 export declare type IExtendedProps = IContentExtendedProps | IServiceExtendedProps;
+/**
+ * Represents the download process that the configuration was created for
+ */
+export declare type DownloadFlowType = "createReplica" | "paging" | "exportImage";
+/**
+ * Represents the storage object for configuring a single download format
+ * TODO: Should this be IDownloadFormatConfigurationStorage?
+ */
+export interface IDownloadFormatConfiguration {
+    /**
+     * Key that identifies the download format.
+     */
+    key: string;
+    /**
+     * Whether the download format should be hidden from the UI
+     */
+    hidden?: boolean;
+}
+/**
+ * Represents the display object for configuring a single download format.
+ * To be used in editing contexts rather than user-facing contexts.
+ */
+export interface IDownloadFormatConfigurationDisplay extends IDownloadFormatConfiguration {
+    /**
+     * Translated label to display for the download format
+     */
+    label: string;
+}
+/**
+ * Represents the configurations for downloading an item
+ */
+export interface IEntityDownloadConfiguration {
+    /**
+     * Indicates the download flow that the configuration was created for
+     * (i.e., the download process that would have been used at the time of configuration)
+     */
+    flowType: DownloadFlowType;
+    /**
+     * Configuration for the download formats that are available for the item.
+     * Saved in the order that they should be displayed in the UI.
+     */
+    formats: IDownloadFormatConfiguration[];
+}
 /**
  * Optional enrichments that are common to all content types
  */
@@ -68,6 +111,10 @@ export interface IBaseExtendedProps {
      * Convenience links to additional resources specified in the formal item metadata
      */
     additionalResources?: IHubAdditionalResource[];
+    /**
+     * Download configuration for the item
+     */
+    downloads?: IEntityDownloadConfiguration;
 }
 /**
  * Enrichments specific to items that are not backed by a service
@@ -104,4 +151,13 @@ export interface IServiceExtendedProps extends IBaseExtendedProps {
      */
     serverExtractFormats?: string[];
 }
-export declare type IHubContentEditor = IHubItemEntityEditor<IHubEditableContent> & {};
+export declare type IHubContentEditor = IHubItemEntityEditor<IHubEditableContent> & {
+    /**
+     * Download formats that should be rendered in the editing UI.
+     *
+     * NOTE: The formats present in this array may or may not be actually accessible.
+     * Product has asked that in certain cases, we display formats that _could_ be available
+     * if the user were to make the necessary changes to the item / service.
+     */
+    downloadFormats?: IDownloadFormatConfigurationDisplay[];
+};

package/dist/types/downloads/_internal/additional-resources/utils.d.ts

@@ -0,0 +1,19 @@
+import { IDownloadFormatConfiguration } from "../../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Determines if the given download format configuration is for
+ * an additional resource.
+ *
+ * @param config IDownloadFormatConfiguration
+ * @returns boolean
+ */
+export declare function isAdditionalResourceConfiguration(config: IDownloadFormatConfiguration): boolean;
+/**
+ * @private
+ * Get's the index of the additional resource from the given
+ * download format configuration.
+ *
+ * @param config IDownloadFormatConfiguration
+ * @returns number - The index of the additional resource
+ */
+export declare function getAdditionalResourceIndex(config: IDownloadFormatConfiguration): number;

package/dist/types/downloads/_internal/getDownloadConfigurationDisplayFormats.d.ts

@@ -0,0 +1,10 @@
+import { IDownloadFormatConfigurationDisplay, IHubEditableContent } from "../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Returns configuration objects for each download format that should be displayed
+ * in the editing experience of a content entity. This function should not be used
+ * to calculate the download formats that should be present on the live UI.
+ * @param entity entity to get download format configurations for
+ * @returns download format configurations to display
+ */
+export declare function getDownloadConfigurationDisplayFormats(entity: IHubEditableContent): IDownloadFormatConfigurationDisplay[];

package/dist/types/downloads/_internal/getDownloadFlow.d.ts

@@ -0,0 +1,11 @@
+import { DownloadFlowType, IHubEditableContent } from "../../core";
+/**
+ * @private
+ * Determines the download flow that will be used for the current entity.
+ * If the entity cannot be downloaded, returns null.
+ *
+ * @param entity the entity to get the download flow for
+ * @param isEnterprise whether the the download will be executed in an enterprise environment
+ * @returns the download flow that will be used for the current entity
+ */
+export declare function getDownloadFlow(entity: IHubEditableContent, isEnterprise?: boolean): DownloadFlowType;

package/dist/types/downloads/_internal/getDownloadFormatsByFlow.d.ts

@@ -0,0 +1,11 @@
+import { DownloadFlowType, IHubEditableContent } from "../../core/types/IHubEditableContent";
+import { IDynamicDownloadFormat } from "../types";
+/**
+ * @private
+ * Get the download formats for a given download flow and entity.
+ *
+ * @param downloadFlow DownloadFlowType
+ * @param entity IHubEditableContent
+ * @returns IDynamicDownloadFormat[]
+ */
+export declare function getDownloadFormatsByFlow(downloadFlow: DownloadFlowType, entity: IHubEditableContent): IDynamicDownloadFormat[];

package/dist/types/downloads/fetchDownloadFormats.d.ts

@@ -1,5 +1,7 @@
 import { IDownloadFormat, IFetchDownloadFormatsOptions } from "./types";
 /**
+ * DEPRECATED: This will be removed in the next breaking version. Use "getDownloadFormats()" instead.
+ *
  * Fetches download formats for the given entity. Also folds in any additional resources defined on the entity.
  * @param options options to refine / filter the results of the fetchDownloadFormats operation
  * @returns a promise that resolves with the download formats

package/dist/types/downloads/getDownloadConfiguration.d.ts

@@ -0,0 +1,11 @@
+import { IEntityDownloadConfiguration, IHubEditableContent } from "../core/types/IHubEditableContent";
+/**
+ * Returns the download configuration for an entity at this moment in time.
+ *
+ * If no configuration exists, a default configuration is returned based on the entity's current download flow.
+ * If a configuration exists but is no longer valid, the default configuration will also be returned.
+ *
+ * @param entity entity to get download configuration for
+ * @returns the current download configuration for the entity
+ */
+export declare function getDownloadConfiguration(entity: IHubEditableContent): IEntityDownloadConfiguration;

package/dist/types/downloads/getDownloadFormats.d.ts

@@ -0,0 +1,9 @@
+import { IDownloadFormat, IFetchDownloadFormatsOptions } from "./types";
+/**
+ * Gets available download formats / additional resources for the given entity in the order they have been configured.
+ * If a format has been configured to be hidden, it will not be included in the results.
+ *
+ * @param options options to refine / filter the results of the fetchDownloadFormats operation
+ * @returns The available download formats and additional resources
+ */
+export declare function getDownloadFormats(options: IFetchDownloadFormatsOptions): IDownloadFormat[];

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

@@ -6,3 +6,5 @@ export * from "./canUseCreateReplica";
 export * from "./canUseHubDownloadSystem";
 export * from "./canUseHubDownloadApi";
 export * from "./getHubDownloadApiFormats";
+export * from "./getDownloadConfiguration";
+export * from "./getDownloadFormats";

package/package.json

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