@esri/hub-common 14.177.1 → 14.179.0

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/dist/types/events/api/orval/api/orval-events.d.ts

@@ -212,6 +212,14 @@ export declare type GetEventsParams = {
      * Comma separated string list of relation fields to include in response. Example: associations,creator,location,onlineMeeting,registrations
      */
     include?: string;
+    /**
+     * Comma separated string list of edit groupIds that event is not shared to
+     */
+    withoutEditGroups?: string;
+    /**
+     * Comma separated string list of read groupIds that event is not shared to
+     */
+    withoutReadGroups?: string;
     /**
      * the max amount of events to return
      */
@@ -241,7 +249,7 @@ export declare type GetEventsParams = {
      */
     startDateTimeBefore?: string;
     /**
-     * comma separated string list of event statuses. Example: PRIVATE,ORG,PUBLIC
+     * comma separated string list of event statuses. Example: PLANNED,CANCELED,REMOVED
      */
     status?: string;
     /**

package/dist/types/events/edit.d.ts

@@ -25,6 +25,7 @@ export declare function createHubEvent(partialEvent: Partial<IHubEvent>, request
  * @returns promise that resolves a IHubEvent
  */
 export declare function updateHubEvent(partialEvent: Partial<IHubEvent>, requestOptions: IHubRequestOptions): Promise<IHubEvent>;
+export declare function deleteHubEvent(id: string, requestOptions: IHubRequestOptions): Promise<void>;
 /**
  * @private
  * Create an Event registration

package/package.json

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