@esri/hub-common 14.121.2 → 14.122.0

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

@@ -0,0 +1,152 @@
+/// <reference types="arcgis-js-api" />
+import { IArcGISContext } from "../ArcGISContext";
+import { IHubEditableContent } from "../core/types/IHubEditableContent";
+/**
+ * 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.
+ */
+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;
+    };
+};
+export declare type LegacyExportItemFormat = keyof typeof PORTAL_EXPORT_TYPES;
+/**
+ * Comprehensive enum of all the download formats that are supported by service-backed items across the ArcGIS platform.
+ */
+export declare enum ServiceDownloadFormat {
+    BIP = "bip",
+    BMP = "bmp",
+    BSQ = "bsq",
+    GIF = "gif",
+    JPG = "jpg",
+    JPG_PNG = "jpgpng",
+    LERC = "lerc",
+    PNG = "png",
+    PNG8 = "png8",
+    PNG24 = "png24",
+    PNG32 = "png32",
+    TIFF = "tiff",
+    CSV = "csv",
+    EXCEL = "excel",
+    FEATURE_COLLECTION = "featureCollection",
+    FILE_GDB = "filegdb",
+    GEOJSON = "geojson",
+    GEO_PACKAGE = "geoPackage",
+    JSON = "json",
+    KML = "kml",
+    SHAPEFILE = "shapefile",
+    SQLITE = "sqlite"
+}
+/**
+ * Represents a file format related to a content entity that can be downloaded.
+ * Formats can either be dynamic (i.e., generated on-the-fly) or static (i.e., pre-generated)
+ */
+export interface IDownloadFormat {
+    type: "static" | "dynamic";
+}
+/**
+ * Represents a static download format that is pre-generated and available for download.
+ * If the format is a service-backed format, the `format` property will be set to the corresponding
+ * service format. If the format is to an arbitrary static file, the `format` property should be undefined.
+ */
+export interface IStaticDownloadFormat extends IDownloadFormat {
+    type: "static";
+    format?: ServiceDownloadFormat;
+    label: string;
+    url: string;
+}
+/**
+ * Represents a dynamic download format that is generated on-the-fly when requested.
+ * The `format` property will be set to the corresponding service format.
+ */
+export interface IDynamicDownloadFormat extends IDownloadFormat {
+    type: "dynamic";
+    format: ServiceDownloadFormat;
+}
+/**
+ * A callback function that is invoked to report the progress of a download operation.
+ */
+export declare type downloadProgressCallback = (status: DownloadOperationStatus, percent?: number) => void;
+/**
+ * Options for refining / filtering the results of the fetchDownloadFileUrl operation.
+ */
+export interface IFetchDownloadFileUrlOptions {
+    entity: IHubEditableContent;
+    format: ServiceDownloadFormat;
+    context: IArcGISContext;
+    layers?: number[];
+    geometry?: __esri.Geometry;
+    where?: string;
+    progressCallback?: downloadProgressCallback;
+    pollInterval?: number;
+}
+/**
+ * Human-readable status of a download operation. Operation specific statuses
+ * should be converted to one of these statuses before being reported to the user.
+ */
+export declare enum DownloadOperationStatus {
+    PENDING = "pending",
+    PROCESSING = "processing",
+    CONVERTING = "converting",
+    COMPLETED = "completed",
+    FAILED = "failed"
+}
+/**
+ * Options for fetching download formats for an entity.
+ */
+export interface IFetchDownloadFormatsOptions {
+    entity: IHubEditableContent;
+    context: IArcGISContext;
+    layers?: number[];
+}
+/**
+ * Options for instantiating an ArcgisHubDownloadError object.
+ */
+interface IArcgisHubDownloadErrorOptions {
+    rawMessage: string;
+    messageId?: string;
+    operation?: string;
+}
+/**
+ * Error class for reporting well-known download errors that occur during the download process.
+ */
+export declare class ArcgisHubDownloadError extends Error {
+    messageId?: string;
+    operation?: string;
+    constructor(options: IArcgisHubDownloadErrorOptions);
+}
+export {};

package/package.json

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