@esri/hub-common 14.121.2 → 14.122.0

package/dist/node/downloads/fetchDownloadFileUrl.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchDownloadFileUrl = void 0;
+const HubError_1 = require("../HubError");
+const canUseExportImageFlow_1 = require("./_internal/canUseExportImageFlow");
+const canUseExportItemFlow_1 = require("./_internal/canUseExportItemFlow");
+const canUseHubDownloadApi_1 = require("./canUseHubDownloadApi");
+/**
+ * Fetches a download file URL for the given entity and format.
+ * @param options options to refine / filter the results of the fetchDownloadFileUrl operation
+ * @returns a promise that resolves with the download file URL
+ * @throws {ArcgisHubDownloadError} if the download file URL cannot be fetched for a well-known reason
+ */
+async function fetchDownloadFileUrl(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;
+    if (canUseHubDownloadApi_1.canUseHubDownloadApi(withPollInterval.entity, withPollInterval.context)) {
+        fetchingFn = (await Promise.resolve().then(() => require("./_internal/file-url-fetchers/fetchHubApiDownloadFileUrl"))).fetchHubApiDownloadFileUrl;
+    }
+    else if (canUseExportItemFlow_1.canUseExportItemFlow(withPollInterval.entity)) {
+        fetchingFn = (await Promise.resolve().then(() => require("./_internal/file-url-fetchers/fetchExportItemDownloadFileUrl"))).fetchExportItemDownloadFileUrl;
+    }
+    else if (canUseExportImageFlow_1.canUseExportImageFlow(withPollInterval.entity)) {
+        fetchingFn = (await Promise.resolve().then(() => require("./_internal/file-url-fetchers/fetchExportImageDownloadFileUrl"))).fetchExportImageDownloadFileUrl;
+    }
+    else {
+        throw new HubError_1.default("fetchDownloadFileUrl", "Downloads are not supported for this item in this environment");
+    }
+    return fetchingFn(withPollInterval);
+}
+exports.fetchDownloadFileUrl = fetchDownloadFileUrl;
+//# sourceMappingURL=fetchDownloadFileUrl.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetchDownloadFileUrl.js","sourceRoot":"","sources":["../../../src/downloads/fetchDownloadFileUrl.ts"],"names":[],"mappings":";;;AAAA,0CAAmC;AAEnC,6EAA0E;AAC1E,2EAAwE;AACxE,iEAA8D;AAG9D;;;;;GAKG;AACI,KAAK,UAAU,oBAAoB,CACxC,OAAqC;IAErC,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,0DAA0D,EAAC,CACzE,CAAC,0BAA0B,CAAC;KAC9B;SAAM,IAAI,2CAAoB,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;QACxD,UAAU,GAAG,CACX,2CACE,8DAA8D,EAC/D,CACF,CAAC,8BAA8B,CAAC;KAClC;SAAM,IAAI,6CAAqB,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;QACzD,UAAU,GAAG,CACX,2CACE,+DAA+D,EAChE,CACF,CAAC,+BAA+B,CAAC;KACnC;SAAM;QACL,MAAM,IAAI,kBAAQ,CAChB,sBAAsB,EACtB,+DAA+D,CAChE,CAAC;KACH;IACD,OAAO,UAAU,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC;AA/BD,oDA+BC"}

package/dist/node/downloads/fetchDownloadFormats.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchDownloadFormats = void 0;
+const canUseExportImageFlow_1 = require("./_internal/canUseExportImageFlow");
+const canUseExportItemFlow_1 = require("./_internal/canUseExportItemFlow");
+const canUseHubDownloadApi_1 = require("./canUseHubDownloadApi");
+/**
+ * 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) {
+    const { entity, context, layers } = options;
+    // fetch base formats for the item
+    let baseFormats = [];
+    if (canUseHubDownloadApi_1.canUseHubDownloadApi(entity, context)) {
+        const { getHubDownloadApiFormats } = await Promise.resolve().then(() => require("./_internal/format-fetchers/getHubDownloadApiFormats"));
+        baseFormats = getHubDownloadApiFormats(entity);
+    }
+    else if (canUseExportItemFlow_1.canUseExportItemFlow(entity)) {
+        const { fetchExportItemFormats } = await Promise.resolve().then(() => require("./_internal/format-fetchers/fetchExportItemFormats"));
+        baseFormats = await fetchExportItemFormats(entity, context, layers);
+    }
+    else if (canUseExportImageFlow_1.canUseExportImageFlow(entity)) {
+        const { getExportImageFormats } = await Promise.resolve().then(() => require("./_internal/format-fetchers/getExportImageFormats"));
+        baseFormats = getExportImageFormats();
+    }
+    // add additional resource links as static formats
+    const additionalFormats = (entity.additionalResources || []).map(toStaticFormat);
+    // combine formats into single list
+    return [...baseFormats, ...additionalFormats];
+}
+exports.fetchDownloadFormats = fetchDownloadFormats;
+function toStaticFormat(resource) {
+    return {
+        type: "static",
+        label: resource.name,
+        url: resource.url,
+    };
+}
+//# sourceMappingURL=fetchDownloadFormats.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetchDownloadFormats.js","sourceRoot":"","sources":["../../../src/downloads/fetchDownloadFormats.ts"],"names":[],"mappings":";;;AACA,6EAA0E;AAC1E,2EAAwE;AACxE,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,sDAAsD,EACvD,CAAC;QACF,WAAW,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;KAChD;SAAM,IAAI,2CAAoB,CAAC,MAAM,CAAC,EAAE;QACvC,MAAM,EAAE,sBAAsB,EAAE,GAAG,2CACjC,oDAAoD,EACrD,CAAC;QACF,WAAW,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;KACrE;SAAM,IAAI,6CAAqB,CAAC,MAAM,CAAC,EAAE;QACxC,MAAM,EAAE,qBAAqB,EAAE,GAAG,2CAChC,mDAAmD,EACpD,CAAC;QACF,WAAW,GAAG,qBAAqB,EAAE,CAAC;KACvC;IAED,kDAAkD;IAClD,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;AA9BD,oDA8BC;AAED,SAAS,cAAc,CACrB,QAAgC;IAEhC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ,CAAC,IAAI;QACpB,GAAG,EAAE,QAAQ,CAAC,GAAG;KAClB,CAAC;AACJ,CAAC"}

package/dist/node/downloads/index.js

@@ -2,4 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./build-existing-exports-portal-query"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./fetchDownloadFileUrl"), exports);
+tslib_1.__exportStar(require("./fetchDownloadFormats"), exports);
+tslib_1.__exportStar(require("./canUseCreateReplica"), exports);
+tslib_1.__exportStar(require("./canUseHubDownloadApi"), 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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/downloads/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,kDAAwB;AACxB,iEAAuC;AACvC,iEAAuC;AACvC,gEAAsC;AACtC,iEAAuC"}

package/dist/node/downloads/types.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcgisHubDownloadError = exports.DownloadOperationStatus = exports.ServiceDownloadFormat = exports.PORTAL_EXPORT_TYPES = void 0;
+/**
+ * This hash map was defined to support the previous implementation of the export item flow.
+ * We are currently working on a new implementation that will replace this hash map, but we
+ * need to keep this around for now to support the existing implementation.
+ */
+exports.PORTAL_EXPORT_TYPES = {
+    csv: {
+        name: "CSV",
+        itemTypes: ["CSV", "CSV Collection"],
+        supportsProjection: true,
+    },
+    kml: {
+        name: "KML",
+        itemTypes: ["KML", "KML Collection"],
+        supportsProjection: false,
+    },
+    shapefile: {
+        name: "Shapefile",
+        itemTypes: ["Shapefile"],
+        supportsProjection: true,
+    },
+    fileGeodatabase: {
+        name: "File Geodatabase",
+        itemTypes: ["File Geodatabase"],
+        supportsProjection: true,
+    },
+    geojson: {
+        name: "GeoJson",
+        itemTypes: ["GeoJson"],
+        supportsProjection: false,
+    },
+    excel: {
+        name: "Excel",
+        itemTypes: ["Microsoft Excel"],
+        supportsProjection: true,
+    },
+    featureCollection: {
+        name: "Feature Collection",
+        itemTypes: ["Feature Collection"],
+        supportsProjection: true,
+    },
+};
+/**
+ * Comprehensive enum of all the download formats that are supported by service-backed items across the ArcGIS platform.
+ */
+var ServiceDownloadFormat;
+(function (ServiceDownloadFormat) {
+    // Image Service Formats
+    ServiceDownloadFormat["BIP"] = "bip";
+    ServiceDownloadFormat["BMP"] = "bmp";
+    ServiceDownloadFormat["BSQ"] = "bsq";
+    ServiceDownloadFormat["GIF"] = "gif";
+    ServiceDownloadFormat["JPG"] = "jpg";
+    ServiceDownloadFormat["JPG_PNG"] = "jpgpng";
+    ServiceDownloadFormat["LERC"] = "lerc";
+    ServiceDownloadFormat["PNG"] = "png";
+    ServiceDownloadFormat["PNG8"] = "png8";
+    ServiceDownloadFormat["PNG24"] = "png24";
+    ServiceDownloadFormat["PNG32"] = "png32";
+    ServiceDownloadFormat["TIFF"] = "tiff";
+    // Map & Feature Service Formats
+    ServiceDownloadFormat["CSV"] = "csv";
+    ServiceDownloadFormat["EXCEL"] = "excel";
+    ServiceDownloadFormat["FEATURE_COLLECTION"] = "featureCollection";
+    ServiceDownloadFormat["FILE_GDB"] = "filegdb";
+    ServiceDownloadFormat["GEOJSON"] = "geojson";
+    ServiceDownloadFormat["GEO_PACKAGE"] = "geoPackage";
+    ServiceDownloadFormat["JSON"] = "json";
+    ServiceDownloadFormat["KML"] = "kml";
+    ServiceDownloadFormat["SHAPEFILE"] = "shapefile";
+    ServiceDownloadFormat["SQLITE"] = "sqlite";
+})(ServiceDownloadFormat = exports.ServiceDownloadFormat || (exports.ServiceDownloadFormat = {}));
+/**
+ * Human-readable status of a download operation. Operation specific statuses
+ * should be converted to one of these statuses before being reported to the user.
+ */
+var DownloadOperationStatus;
+(function (DownloadOperationStatus) {
+    DownloadOperationStatus["PENDING"] = "pending";
+    DownloadOperationStatus["PROCESSING"] = "processing";
+    DownloadOperationStatus["CONVERTING"] = "converting";
+    DownloadOperationStatus["COMPLETED"] = "completed";
+    DownloadOperationStatus["FAILED"] = "failed";
+})(DownloadOperationStatus = exports.DownloadOperationStatus || (exports.DownloadOperationStatus = {}));
+/**
+ * Error class for reporting well-known download errors that occur during the download process.
+ */
+class ArcgisHubDownloadError extends Error {
+    constructor(options) {
+        super(options.rawMessage);
+        this.name = "ArcgisHubDownloadError";
+        this.message = options.rawMessage;
+        this.messageId = options.messageId;
+        this.operation = options.operation;
+    }
+}
+exports.ArcgisHubDownloadError = ArcgisHubDownloadError;
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/downloads/types.ts"],"names":[],"mappings":";;;AAGA;;;;GAIG;AACU,QAAA,mBAAmB,GAAG;IACjC,GAAG,EAAE;QACH,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC;QACpC,kBAAkB,EAAE,IAAI;KACzB;IACD,GAAG,EAAE;QACH,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC;QACpC,kBAAkB,EAAE,KAAK;KAC1B;IACD,SAAS,EAAE;QACT,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,CAAC,WAAW,CAAC;QACxB,kBAAkB,EAAE,IAAI;KACzB;IACD,eAAe,EAAE;QACf,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,CAAC,kBAAkB,CAAC;QAC/B,kBAAkB,EAAE,IAAI;KACzB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,SAAS;QACf,SAAS,EAAE,CAAC,SAAS,CAAC;QACtB,kBAAkB,EAAE,KAAK;KAC1B;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,CAAC,iBAAiB,CAAC;QAC9B,kBAAkB,EAAE,IAAI;KACzB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,oBAAoB;QAC1B,SAAS,EAAE,CAAC,oBAAoB,CAAC;QACjC,kBAAkB,EAAE,IAAI;KACzB;CAOF,CAAC;AAKF;;GAEG;AACH,IAAY,qBA0BX;AA1BD,WAAY,qBAAqB;IAC/B,wBAAwB;IACxB,oCAAW,CAAA;IACX,oCAAW,CAAA;IACX,oCAAW,CAAA;IACX,oCAAW,CAAA;IACX,oCAAW,CAAA;IACX,2CAAkB,CAAA;IAClB,sCAAa,CAAA;IACb,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,wCAAe,CAAA;IACf,sCAAa,CAAA;IAEb,gCAAgC;IAChC,oCAAW,CAAA;IACX,wCAAe,CAAA;IACf,iEAAwC,CAAA;IACxC,6CAAoB,CAAA;IACpB,4CAAmB,CAAA;IACnB,mDAA0B,CAAA;IAC1B,sCAAa,CAAA;IACb,oCAAW,CAAA;IACX,gDAAuB,CAAA;IACvB,0CAAiB,CAAA;AACnB,CAAC,EA1BW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QA0BhC;AAqDD;;;GAGG;AACH,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,oDAAyB,CAAA;IACzB,oDAAyB,CAAA;IACzB,kDAAuB,CAAA;IACvB,4CAAiB,CAAA;AACnB,CAAC,EANW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAMlC;AAoBD;;GAEG;AACH,MAAa,sBAAuB,SAAQ,KAAK;IAK/C,YAAY,OAAuC;QACjD,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IACrC,CAAC;CACF;AAZD,wDAYC"}

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

@@ -8,7 +8,7 @@ export declare const ContentDefaultFeatures: IFeatureFlags;
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const ContentPermissions: readonly ["hub:content:create", "hub:content:delete", "hub:content:edit", "hub:content:view", "hub:content:canChangeAccess", "hub:content:workspace", "hub:content:workspace:overview", "hub:content:workspace:dashboard", "hub:content:workspace:details", "hub:content:workspace:discussion", "hub:content:workspace:settings", "hub:content:workspace:settings:schedule", "hub:content:workspace:collaborators", "hub:content:manage", "hub:content:canRecordDownloadErrors", "hub:content:downloads:displayErrors"];
+export declare const ContentPermissions: readonly ["hub:content:create", "hub:content:delete", "hub:content:edit", "hub:content:view", "hub:content:canChangeAccess", "hub:content:workspace", "hub:content:workspace:overview", "hub:content:workspace:dashboard", "hub:content:workspace:details", "hub:content:workspace:discussion", "hub:content:workspace:settings", "hub:content:workspace:settings:schedule", "hub:content:workspace:collaborators", "hub:content:manage", "hub:content:canRecordDownloadErrors", "hub:content:downloads:displayErrors", "temp:hub:content:downloads:unifiedList"];
 /**
  * Content permission policies
  * No need to specify license for permissions that are available to all licenses

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

@@ -53,6 +53,13 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     publisher?: {
         name?: string;
         username?: string;
+        /**
+         * Derives proper IHubLocation given an ArcGIS Item.  If no
+         * location (item.properties.location) is present, one will be
+         * constructed from the item's extent.
+         * @param item ArcGIS Item
+         * @returns IHubLocation
+         */
         nameSource: PublisherSource;
         organization?: string;
         orgId?: string;

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

@@ -1,4 +1,5 @@
 import { IWithPermissions, IWithSlug } from "../traits/index";
+import { IHubAdditionalResource } from "./IHubAdditionalResource";
 import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
 import { IHubSchedule } from "./IHubSchedule";
 /**
@@ -15,6 +16,15 @@ export interface IHubEditableContent extends IHubItemEntity, IWithSlug, IWithPer
      * capability enabled. This is a pre-requisite for Hosted Downloads to work.
      */
     serverExtractCapability?: boolean;
+    /**
+     * If the item represents a hosted feature service with "Extract enabled", shows the formats that
+     * can be extracted from the service via the "createReplica" operation.
+     */
+    serverExtractFormats?: string[];
+    /**
+     * links to additional resources specified in the formal item metadata
+     */
+    additionalResources?: IHubAdditionalResource[];
     /**
      * The schedule at which the reharvest of the item will occur
      */

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

@@ -8,7 +8,7 @@ export declare type SystemStatus = "online" | "offline" | "maintenance" | "not-a
 export declare type HubServiceStatus = {
     [key in HubService]: SystemStatus;
 };
-declare const validServices: readonly ["portal", "discussions", "events", "metrics", "notifications", "hub-search", "domains"];
+declare const validServices: readonly ["portal", "discussions", "events", "metrics", "notifications", "hub-search", "domains", "hub-downloads"];
 export declare type HubService = (typeof validServices)[number];
 /**
  * Validate a Service

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

@@ -0,0 +1,22 @@
+import { ServiceDownloadFormat } from "../types";
+/**
+ * Formats supported by the /export endpoint of the Portal API.
+ */
+export declare const EXPORT_ITEM_FORMATS: readonly [ServiceDownloadFormat.CSV, ServiceDownloadFormat.KML, ServiceDownloadFormat.SHAPEFILE, ServiceDownloadFormat.FILE_GDB, ServiceDownloadFormat.GEOJSON, ServiceDownloadFormat.EXCEL, ServiceDownloadFormat.FEATURE_COLLECTION];
+export declare type ExportItemFormat = (typeof EXPORT_ITEM_FORMATS)[number];
+/**
+ * Formats supported by the /exportImage endpoint of Image Services.
+ */
+export declare const EXPORT_IMAGE_FORMATS: readonly [ServiceDownloadFormat.BIP, ServiceDownloadFormat.BMP, ServiceDownloadFormat.BSQ, ServiceDownloadFormat.GIF, ServiceDownloadFormat.JPG, ServiceDownloadFormat.JPG_PNG, ServiceDownloadFormat.LERC, ServiceDownloadFormat.PNG, ServiceDownloadFormat.PNG24, ServiceDownloadFormat.PNG32, ServiceDownloadFormat.PNG8, ServiceDownloadFormat.TIFF];
+export declare type ExportImageFormat = (typeof EXPORT_IMAGE_FORMATS)[number];
+/**
+ * Formats supported by the paging operation endpoint of the Hub Download API.
+ */
+export declare const HUB_PAGING_JOB_FORMATS: readonly [ServiceDownloadFormat.CSV, ServiceDownloadFormat.GEOJSON, ServiceDownloadFormat.KML, ServiceDownloadFormat.SHAPEFILE];
+export declare type HubPagingJobFormat = (typeof HUB_PAGING_JOB_FORMATS)[number];
+/**
+ * Known formats supported by the /createReplica endpoint of the Hub Download API.
+ * NOTE: this is may be incomplete and should be updated as needed.
+ */
+export declare const CREATE_REPLICA_FORMATS: readonly [ServiceDownloadFormat.CSV, ServiceDownloadFormat.EXCEL, ServiceDownloadFormat.FEATURE_COLLECTION, ServiceDownloadFormat.FILE_GDB, ServiceDownloadFormat.GEOJSON, ServiceDownloadFormat.GEO_PACKAGE, ServiceDownloadFormat.JSON, ServiceDownloadFormat.SHAPEFILE, ServiceDownloadFormat.SQLITE];
+export declare type CreateReplicaFormat = (typeof CREATE_REPLICA_FORMATS)[number];

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

@@ -0,0 +1,13 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IHubEditableContent } from "../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Determines if the current user can create an export item for the given entity.
+ *
+ * NOTE: This function is a placeholder. Various permissions and logic branches are not yet implemented.
+ *
+ * @param _entity
+ * @param _context
+ * @returns
+ */
+export declare function canCreateExportItem(_entity: IHubEditableContent, _context: IArcGISContext): boolean;

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

@@ -0,0 +1,8 @@
+import { IHubEditableContent } from "../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Determines if the export image flow can be used for the given entity.
+ * @param entity entity to check if export image flow can be used
+ * @returns whether the export image flow can be used
+ */
+export declare function canUseExportImageFlow(entity: IHubEditableContent): boolean;

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

@@ -0,0 +1,8 @@
+import { IHubEditableContent } from "../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Determines if the export item flow can be used for the given entity.
+ * @param entity entity to check if export item flow can be used
+ * @returns whether the export item flow can be used
+ */
+export declare function canUseExportItemFlow(entity: IHubEditableContent): boolean;

package/dist/types/downloads/_internal/file-url-fetchers/fetchExportImageDownloadFileUrl.d.ts

@@ -0,0 +1,12 @@
+import { IFetchDownloadFileUrlOptions } from "../../types";
+/**
+ * @private
+ * Fetches a download file url from an Image Service via the exportImage endpoint
+ *
+ * NOTE: This function is incomplete and needs various parameters to be validated
+ * and implemented. It is a work in progress.
+ *
+ * @param options options for refining / filtering the resulting download file
+ * @returns a url to download the file
+ */
+export declare function fetchExportImageDownloadFileUrl(options: IFetchDownloadFileUrlOptions): Promise<string>;

package/dist/types/downloads/_internal/file-url-fetchers/fetchExportItemDownloadFileUrl.d.ts

@@ -0,0 +1,20 @@
+import { IFetchDownloadFileUrlOptions } from "../../types";
+/**
+ * @private
+ * Fetches a download file url the Portal API via the item /export endpoint.
+ *
+ * NOTE: This function is incomplete and various permissions / branching paths need to be
+ * validated and implemented. It is a work in progress.
+ *
+ * NOTE: This is a last resort approach for current Enterprise environments, but it will be replaced
+ * by calling the service's /createReplica endpoint directly in the future (i.e., once the Enterprise
+ * team achieves feature parity with the Online team's implementation).
+ *
+ * This is because The item /export endpoint can only be used on Hosted Feature Services
+ * with the "Extract" capability enabled, which means the service will also have the /createReplica
+ * endpoint available. As /createReplica is a more flexible operation, /export becomes obsolete.
+ *
+ * @param options options for refining / filtering the resulting download file
+ * @returns a url to download the file
+ */
+export declare function fetchExportItemDownloadFileUrl(options: IFetchDownloadFileUrlOptions): Promise<string>;

package/dist/types/downloads/_internal/file-url-fetchers/fetchHubApiDownloadFileUrl.d.ts

@@ -0,0 +1,16 @@
+import { IFetchDownloadFileUrlOptions } from "../../types";
+/**
+ * @private
+ * Fetches a download file url from the Hub Download API
+ *
+ * NOTE: The Hub Download API only works with a certain subset of Feature and Map services
+ * and performs different operations (i.e., calling createReplica or paging the service's
+ * features) depending on the service type and capabilities.
+ *
+ * This function does it's best to abstract those differences and provide a consistent
+ * interface for downloading data from any service supported by the Hub Download API.
+ *
+ * @param options options for refining / filtering the resulting download file
+ * @returns a url to download the file
+ */
+export declare function fetchHubApiDownloadFileUrl(options: IFetchDownloadFileUrlOptions): Promise<string>;

package/dist/types/downloads/_internal/format-fetchers/fetchAvailableExportItemFormats.d.ts

@@ -0,0 +1,26 @@
+import { IStaticDownloadFormat } from "../../types";
+import { IHubEditableContent } from "../../../core/types/IHubEditableContent";
+import { IArcGISContext } from "../../../ArcGISContext";
+/**
+ * @private
+ * Fetches an entity's available download formats that were previously created by the Portal API's item /export
+ * endpoint. This is useful for anonymous enterprise users who need to download data from a Hosted Feature Service,
+ * but do not have the privileges to create their own item export. As the exports have been previously created, they
+ * can be downloaded statically by anyone with the URL.
+ *
+ * NOTE: This function is a work-in-progress. Various permissions and logic branches are not yet implemented.
+ *
+ * NOTE: This is a last resort approach for current Enterprise environments, but it will be replaced
+ * with using the formats defined the service's /createReplica endpoint directly in the future (i.e.,
+ * once the Enterprise team achieves feature parity with the Online team's implementation).
+ *
+ * This is because The item /export endpoint can only be used on Hosted Feature Services with the "Extract" capability
+ * enabled, which means the service will also have the /createReplica endpoint available. As /createReplica is a more
+ * flexible operation that can be invoked by anonymous users, /export becomes obsolete.
+ *
+ * @param entity Hosted Feature Service entity to fetch download formats for
+ * @param context ArcGIS application context
+ * @param layers target layers that the download will be filtered to
+ * @returns available download formats for the entity
+ */
+export declare function fetchAvailableExportItemFormats(entity: IHubEditableContent, context: IArcGISContext, layers: number[]): Promise<IStaticDownloadFormat[]>;

package/dist/types/downloads/_internal/format-fetchers/fetchExportItemFormats.d.ts

@@ -0,0 +1,25 @@
+import { IArcGISContext } from "../../../ArcGISContext";
+import { IHubEditableContent } from "../../../core/types/IHubEditableContent";
+import { IDownloadFormat } from "../../types";
+/**
+ * @private
+ * Fetches an entity's available download formats. Owners of the entity can create all formats supported by
+ * the Portal API's item /export endpoint, while users that don't have privileges to the item /export endpoint
+ * can only download formats that were previously exported by the entity's owner.
+ *
+ * NOTE: This function is a work-in-progress. Various permissions and logic branches are not yet implemented.
+ *
+ * NOTE: This is a last resort approach for current Enterprise environments, but it will be replaced
+ * with using the formats defined the service's /createReplica endpoint directly in the future (i.e.,
+ * once the Enterprise team achieves feature parity with the Online team's implementation).
+ *
+ * This is because The item /export endpoint can only be used on Hosted Feature Services with the "Extract" capability
+ * enabled, which means the service will also have the /createReplica endpoint available. As /createReplica is a more
+ * flexible operation that can be invoked by anonymous users, /export becomes obsolete.
+ *
+ * @param entity Hosted Feature Service entity to fetch download formats for
+ * @param context ArcGIS application context
+ * @param layers target layers that the download will be filtered to
+ * @returns available download formats for the entity
+ */
+export declare function fetchExportItemFormats(_entity: IHubEditableContent, _context: IArcGISContext, _layers?: number[]): Promise<IDownloadFormat[]>;

package/dist/types/downloads/_internal/format-fetchers/getAllExportItemFormats.d.ts

@@ -0,0 +1,6 @@
+import { IDynamicDownloadFormat } from "../../types";
+/**
+ * @private
+ * Returns all the download formats that are available via the Portal API's item /export endpoint.
+ */
+export declare function getAllExportItemFormats(): IDynamicDownloadFormat[];

package/dist/types/downloads/_internal/format-fetchers/getCreateReplicaFormats.d.ts

@@ -0,0 +1,10 @@
+import { IHubEditableContent } from "../../../core/types/IHubEditableContent";
+import { IDynamicDownloadFormat } from "../../types";
+/**
+ * @private
+ * Returns all the download formats that are defined by the service's /createReplica endpoint.
+ *
+ * @param entity Hosted Feature Service entity to return download formats for
+ * @returns available download formats for the entity
+ */
+export declare function getCreateReplicaFormats(entity: IHubEditableContent): IDynamicDownloadFormat[];

package/dist/types/downloads/_internal/format-fetchers/getExportImageFormats.d.ts

@@ -0,0 +1,8 @@
+import { IDynamicDownloadFormat } from "../../types";
+/**
+ * @private
+ * Returns all the download formats that are exposed by Image Services via the /exportImage operation.
+ *
+ * NOTE: This function is a work-in-progress. Various permissions and logic branches are not yet implemented.
+ */
+export declare function getExportImageFormats(): IDynamicDownloadFormat[];

package/dist/types/downloads/_internal/format-fetchers/getHubDownloadApiFormats.d.ts

@@ -0,0 +1,12 @@
+import { IDynamicDownloadFormat } from "../../types";
+import { IHubEditableContent } from "../../../core/types/IHubEditableContent";
+/**
+ * @private
+ * Returns all the formats that are available for download via the Hub Download API for a given entity.
+ * Formats will vary from entity to entity depending on actual operation that the Hub Download API will
+ * perform under the hood (e.g., hitting /createReplica or paging through the service's features).
+ *
+ * @param entity Service entity to return download formats for
+ * @returns available download formats for the entity
+ */
+export declare function getHubDownloadApiFormats(entity: IHubEditableContent): IDynamicDownloadFormat[];

package/dist/types/downloads/_internal/format-fetchers/getPagingJobFormats.d.ts

@@ -0,0 +1,7 @@
+import { IDynamicDownloadFormat } from "../../types";
+/**
+ * @private
+ * Returns all the download formats that are available for the Hub Download API's paging job operation.
+ * @returns available download formats for the paging job operation
+ */
+export declare function getPagingJobFormats(): IDynamicDownloadFormat[];

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

@@ -0,0 +1,9 @@
+import { IArcGISContext } from "../../ArcGISContext";
+/**
+ * @private
+ * Generates a URL to download the data of an export item.
+ * @param exportItemId ID of the export item
+ * @param context ArcGIS application context
+ * @returns URL to download the data of the export item
+ */
+export declare function getExportItemDataUrl(exportItemId: string, context: IArcGISContext): string;

package/dist/types/downloads/build-existing-exports-portal-query.d.ts

@@ -1,42 +1,5 @@
 import { ISpatialReference } from "@esri/arcgis-rest-types";
 export declare const WGS84_WKID = "4326";
-export declare const PORTAL_EXPORT_TYPES: {
-    csv: {
-        name: string;
-        itemTypes: string[];
-        supportsProjection: boolean;
-    };
-    kml: {
-        name: string;
-        itemTypes: string[];
-        supportsProjection: boolean;
-    };
-    shapefile: {
-        name: string;
-        itemTypes: string[];
-        supportsProjection: boolean;
-    };
-    fileGeodatabase: {
-        name: string;
-        itemTypes: string[];
-        supportsProjection: boolean;
-    };
-    geojson: {
-        name: string;
-        itemTypes: string[];
-        supportsProjection: boolean;
-    };
-    excel: {
-        name: string;
-        itemTypes: string[];
-        supportsProjection: boolean;
-    };
-    featureCollection: {
-        name: string;
-        itemTypes: string[];
-        supportsProjection: boolean;
-    };
-};
 interface IExistingExportsPortalQueryOptions {
     layerId?: number | string;
     onlyTypes?: string[];

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

@@ -0,0 +1,7 @@
+import { IHubEditableContent } from "../core/types/IHubEditableContent";
+/**
+ * Determines whether Hub can perform the /createReplica operation on a given service entity.
+ * @param entity entity to check
+ * @returns whether the /createReplica operation can be used
+ */
+export declare function canUseCreateReplica(entity: IHubEditableContent): boolean;

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

@@ -0,0 +1,9 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { IHubEditableContent } from "../core/types/IHubEditableContent";
+/**
+ * Determines if the Hub Download API can be used for the given entity.
+ * @param entity entity to check if Hub Download API can be used
+ * @param context ArcGIS context
+ * @returns whether the Hub Download API can be used
+ */
+export declare function canUseHubDownloadApi(entity: IHubEditableContent, context: IArcGISContext): boolean;

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

@@ -0,0 +1,8 @@
+import { IFetchDownloadFileUrlOptions } from "./types";
+/**
+ * Fetches a download file URL for the given entity and format.
+ * @param options options to refine / filter the results of the fetchDownloadFileUrl operation
+ * @returns a promise that resolves with the download file URL
+ * @throws {ArcgisHubDownloadError} if the download file URL cannot be fetched for a well-known reason
+ */
+export declare function fetchDownloadFileUrl(options: IFetchDownloadFileUrlOptions): Promise<string>;

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

@@ -0,0 +1,7 @@
+import { IDownloadFormat, IFetchDownloadFormatsOptions } from "./types";
+/**
+ * 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
+ */
+export declare function fetchDownloadFormats(options: IFetchDownloadFormatsOptions): Promise<IDownloadFormat[]>;

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

@@ -1 +1,6 @@
 export * from "./build-existing-exports-portal-query";
+export * from "./types";
+export * from "./fetchDownloadFileUrl";
+export * from "./fetchDownloadFormats";
+export * from "./canUseCreateReplica";
+export * from "./canUseHubDownloadApi";