@esri/hub-common 24.8.0 → 26.0.0

package/dist/types/hub-types.d.ts

@@ -1,7 +1,7 @@
 import type { IGroup, IItem, IPortal, ISearchResult, IUser } from "@esri/arcgis-rest-portal";
 import type { ArcGISIdentityManager, IGeometry, IPolygon, IRequestOptions, ISpatialReference } from "@esri/arcgis-rest-request";
-import { FileExtension } from "./enums/fileExtension";
-import { ItemType } from "./enums/itemType";
+import { TFileExtension } from "./enums/fileExtension";
+import { TItemType } from "./enums/itemType";
 /**
  * App keys for User Resources used in Hub
  */
@@ -299,16 +299,16 @@ export interface IHubTeam extends IGroup {
  * File type to extension interface
  */
 export interface IFileType {
-    type: ItemType;
+    type: TItemType;
     typeKeywords: string[];
-    fileExt?: FileExtension[];
+    fileExt?: TFileExtension[];
 }
 /**
  * Array of ItemTypes and/or array of extensions. Primarily used for the create new content flow
  */
 export interface IAllowedFileTypes {
-    types?: ItemType[];
-    extensions?: FileExtension[];
+    types?: TItemType[];
+    extensions?: TFileExtension[];
 }
 /**
  * Maps human readable file names to extensions IE Image === jpg, png, etc

package/dist/types/index.d.ts

@@ -30,10 +30,10 @@ export { composeContent, getContentTypeIcon, getItemHubId, getItemLayer, getItem
 export { composeHubContent } from "./content/composeHubContent";
 export { datasetToContent, datasetToItem, getCategory, getContentIdentifier, getContentTypeLabel, getServiceStatus, getTypeCategories, getTypes, IGetServiceStatusOptions, itemToContent, setContentType, } from "./content/contentUtils";
 export { createContent, deleteContent, editorToContent, updateContent, } from "./content/edit";
-export { JobRecordType } from "./content/enums/jobRecordType";
-export { JobRecordStatus } from "./content/enums/jobRecordStatus";
-export { ServiceCapabilities } from "./content/enums/serviceCapabilities";
-export { UpdateFrequency } from "./content/enums/updateFrequency";
+export { JobRecordType, TJobRecordType } from "./content/enums/jobRecordType";
+export { JobRecordStatus, TJobRecordStatus, } from "./content/enums/jobRecordStatus";
+export { ServiceCapabilities, TServiceCapability, } from "./content/enums/serviceCapabilities";
+export { UpdateFrequency, TUpdateFrequency, } from "./content/enums/updateFrequency";
 export { fetchContent } from "./content/fetchContent";
 export { IFetchContentOptions } from "./content/types";
 export { fetchHubContent } from "./content/fetchHubContent";
@@ -58,10 +58,10 @@ export { IWithVersioningBehavior } from "./core/behaviors/IWithVersioningBehavio
 export { catalogContains } from "./core/catalogContains";
 export { deepCatalogContains } from "./core/deepCatalogContains";
 export { EntityEditor } from "./core/EntityEditor";
-export { ExpressionRelationships } from "./core/enums/expressionRelationships";
-export { FeatureLayerStyle } from "./core/enums/featureLayerStyle";
-export { MetricVisibility } from "./core/enums/metricVisibility";
-export { TIMELINE_STAGE_STATUSES } from "./core/enums/timelineStageStatuses";
+export { ExpressionRelationships, TExpressionRelationship, } from "./core/enums/expressionRelationships";
+export { FeatureLayerStyle, TFeatureLayerStyle, } from "./core/enums/featureLayerStyle";
+export { MetricVisibility, TMetricVisibility, } from "./core/enums/metricVisibility";
+export { TIMELINE_STAGE_STATUSES, TTimelineStageStatus, } from "./core/enums/timelineStageStatuses";
 export { fetchHubEntity } from "./core/fetchHubEntity";
 export { getEntityGroups } from "./core/getEntityGroups";
 export { getEntityThumbnailUrl } from "./core/getEntityThumbnailUrl";
@@ -81,13 +81,13 @@ export { getEditorConfig } from "./core/schemas/getEditorConfig";
 export { fetchCategoriesUiSchemaElement, IFetchCategoriesUiSchemaElementOptions, } from "./core/schemas/internal/fetchCategoriesUiSchemaElement";
 export { getTagItems } from "./core/schemas/internal/getTagItems";
 export { CatalogSchema, CollectionSchema, FilterSchema, GalleryDisplayConfigSchema, PredicateSchema, QuerySchema, } from "./core/schemas/shared/CatalogSchema";
-export { CARD_TITLE_TAGS } from "./core/schemas/shared/enums/cardTitleTags";
+export { CARD_TITLE_TAGS, TCardTitleTag, } from "./core/schemas/shared/enums/cardTitleTags";
 export { DISCUSSION_SETTINGS_SCHEMA, ENTERPRISE_SITE_ENTITY_NAME_SCHEMA, ENTITY_ACCESS_SCHEMA, ENTITY_CATALOG_SETUP_SCHEMA, ENTITY_CATEGORIES_SCHEMA, ENTITY_FEATURED_CONTENT_SCHEMA, ENTITY_IMAGE_SCHEMA, ENTITY_IS_DISCUSSABLE_SCHEMA, ENTITY_LAYOUT_SETUP_SCHEMA, ENTITY_LOCATION_SCHEMA, ENTITY_MAP_SCHEMA, ENTITY_NAME_SCHEMA, ENTITY_SUMMARY_SCHEMA, ENTITY_TAGS_SCHEMA, ENTITY_TIMELINE_SCHEMA, PRIVACY_CONFIG_SCHEMA, SITE_ENTITY_NAME_SCHEMA, SLUG_SCHEMA, } from "./core/schemas/shared/subschemas";
 export { CardEditorType, DiscussionSettingsEditorType, EditorType, EmbedCardEditorType, EntityEditorType, EventGalleryCardEditorType, FollowCardEditorType, IAsyncConfigurationSchema, ICardEditorModuleType, IChangeEventDetail, IConfigurationSchema, IConfigurationValues, IEditorConfig, IEditorModuleType, IEntityEditorModuleType, IUiSchema, IUiSchemaComboboxItem, IUiSchemaComboboxItemGroup, IUiSchemaComboboxItemContentEnd, IUiSchemaCondition, IUiSchemaElement, IUiSchemaMessage, IUiSchemaRule, StatCardEditorType, UiSchemaElementOptions, validCardEditorTypes, validDiscussionSettingsEditorTypes, validEditorTypes, validEmbedCardEditorTypes, validEntityEditorTypes, validEventGalleryCardEditorTypes, validFollowCardEditorTypes, validStatCardEditorTypes, } from "./core/schemas/types";
-export { UiSchemaMessageTypes } from "./core/enums/uiSchemaMessageTypes";
-export { UiSchemaSectionTypes } from "./core/enums/uiSchemaSectionTypes";
-export { UiSchemaElementTypes } from "./core/enums/uiSchemaElementTypes";
-export { UiSchemaRuleEffects } from "./core/enums/uiSchemaRuleEffects";
+export { UiSchemaMessageTypes, TUiSchemaMessageType, } from "./core/enums/uiSchemaMessageTypes";
+export { UiSchemaSectionTypes, TUiSchemaSectionType, } from "./core/enums/uiSchemaSectionTypes";
+export { UiSchemaElementTypes, TUiSchemaElementType, } from "./core/enums/uiSchemaElementTypes";
+export { UiSchemaRuleEffects, TUiSchemaRuleEffect, } from "./core/enums/uiSchemaRuleEffects";
 export { setEntityAccess } from "./core/setEntityAccess";
 export { shareEntityWithGroups } from "./core/shareEntityWithGroups";
 export { HubCapability, ICapabilityConfig, IContentConfig, IDiscussionsConfig, IEventsConfig, IInitiativesConfig, IPagesConfig, IProjectsConfig, IWithContent, IWithEvents, IWithInitiatives, IWithPages, IWithProjects, } from "./core/traits/ICapabilityConfig";
@@ -103,7 +103,7 @@ export { IWithViewSettings } from "./core/traits/IWithViewSettings";
 export { HubActionLink, IHubActionLinkSection, IHubContentActionLink, IHubExternalActionLink, IHubWellKnownActionLink, } from "./core/types/ActionLinks";
 export { CountByValue, DynamicAggregation, DynamicValue, DynamicValueDefinition, DynamicValueResult, DynamicValues, DynamicValueType, IDynamicItemQueryDefinition, IDynamicPortalSelfDefinition, IDynamicServiceQueryDefinition, IStaticValueDefinition, } from "./core/types/DynamicValues";
 export { HubEmbed, IHubEmbed, IHubEmbedApp, IHubEmbedExternal, IHubEmbedMap, IHubEmbedSurvey, } from "./core/types/Embeds";
-export { EmbedKind } from "./core/enums/embedKind";
+export { EmbedKind, TEmbedKind } from "./core/enums/embedKind";
 export { HubEntity } from "./core/types/HubEntity";
 export { HubEntityEditor, IEntityEditorContext, } from "./core/types/HubEntityEditor";
 export { HUB_ENTITY_TYPES, HUB_ITEM_ENTITY_TYPES, HubEntityType, HubItemEntityType, } from "./core/types/HubEntityType";
@@ -111,7 +111,7 @@ export { IGeometryInstance } from "./core/types/IGeometryInstance";
 export { CardModelTarget, EntityToCardModelFn, IBadgeConfig, ICardActionLink, IConvertToCardModelOpts, IHubCardViewModel, IInfoConfig, ResultToCardModelFn, } from "./core/types/IHubCardViewModel";
 export { IHubChannel, IHubChannelEditor, IHubRoleConfigValue, } from "./core/types/IHubChannel";
 export { IHubContent } from "./core/types/IHubContent";
-export { PublisherSource } from "./core/enums/publisherSource";
+export { PublisherSource, TPublisherSource, } from "./core/enums/publisherSource";
 export { IHubContentEnrichments } from "./core/types/IHubContentEnrichments";
 export { IHubDiscussion, IHubDiscussionEditor, } from "./core/types/IHubDiscussion";
 export { DownloadFlowType, IBaseExtendedProps, IContentExtendedProps, IDownloadFormatConfiguration, IDownloadFormatConfigurationDisplay, IEntityDownloadConfiguration, IExtendedProps, IHubContentEditor, IHubEditableContent, IServiceExtendedProps, } from "./core/types/IHubEditableContent";
@@ -146,25 +146,25 @@ export { unshareEntityWithGroups } from "./core/unshareEntityWithGroups";
 export { updateHubEntity } from "./core/updateHubEntity";
 export { createChannelNotificationOptOutV2, createChannelV2, fetchChannelNotifcationOptOutV2, fetchChannelV2, removeChannelActivityV2, removeChannelNotificationOptOutV2, removeChannelV2, searchChannelsV2, updateChannelV2, } from "./discussions/api/channels/channels";
 export { discussionsApiRequestV2 } from "./discussions/api/discussions-api-request";
-export { AclCategory } from "./discussions/api/enums/aclCategory";
-export { AclSubCategory } from "./discussions/api/enums/aclSubCategory";
-export { ChannelFilter } from "./discussions/api/enums/channelFilter";
-export { ChannelRelation } from "./discussions/api/enums/channelRelation";
-export { ChannelSort } from "./discussions/api/enums/channelSort";
-export { CommonSort } from "./discussions/api/enums/commonSort";
-export { DiscussionSource } from "./discussions/api/enums/discussionSource";
-export { DiscussionType } from "./discussions/api/enums/discussionType";
-export { EntitySettingType } from "./discussions/api/enums/entitySettingsType";
-export { PostReaction } from "./discussions/api/enums/postReaction";
-export { PostRelation } from "./discussions/api/enums/postRelation";
-export { PostSort } from "./discussions/api/enums/postSort";
-export { PostStatus } from "./discussions/api/enums/postStatus";
-export { PostType } from "./discussions/api/enums/postType";
-export { ReactionRelation } from "./discussions/api/enums/reactionRelation";
-export { Role } from "./discussions/api/enums/role";
-export { SearchPostsFormat } from "./discussions/api/enums/searchPostsFormat";
-export { SharingAccess } from "./discussions/api/enums/sharingAccess";
-export { SortOrder } from "./discussions/api/enums/sortOrder";
+export { AclCategory, TAclCategory } from "./discussions/api/enums/aclCategory";
+export { AclSubCategory, TAclSubCategory, } from "./discussions/api/enums/aclSubCategory";
+export { ChannelFilter, TChannelFilter, } from "./discussions/api/enums/channelFilter";
+export { ChannelRelation, TChannelRelation, } from "./discussions/api/enums/channelRelation";
+export { ChannelSort, TChannelSort } from "./discussions/api/enums/channelSort";
+export { CommonSort, TCommonSort } from "./discussions/api/enums/commonSort";
+export { DiscussionSource, TDiscussionSource, } from "./discussions/api/enums/discussionSource";
+export { DiscussionType, TDiscussionType, } from "./discussions/api/enums/discussionType";
+export { EntitySettingType, TEntitySettingType, } from "./discussions/api/enums/entitySettingsType";
+export { PostReaction, TPostReaction, } from "./discussions/api/enums/postReaction";
+export { PostRelation, TPostRelation, } from "./discussions/api/enums/postRelation";
+export { PostSort, TPostSort } from "./discussions/api/enums/postSort";
+export { PostStatus, TPostStatus } from "./discussions/api/enums/postStatus";
+export { PostType, TPostType } from "./discussions/api/enums/postType";
+export { ReactionRelation, TReactionRelation, } from "./discussions/api/enums/reactionRelation";
+export { Role, TRole } from "./discussions/api/enums/role";
+export { SearchPostsFormat, TSearchPostsFormat, } from "./discussions/api/enums/searchPostsFormat";
+export { SharingAccess, TSharingAccess, } from "./discussions/api/enums/sharingAccess";
+export { SortOrder, TSortOrder } from "./discussions/api/enums/sortOrder";
 export { createPostV2, createReplyV2, exportPostsV2, fetchPostV2, removePostV2, searchPostsV2, updatePostStatusV2, updatePostV2, } from "./discussions/api/posts/posts";
 export { createReactionV2, removeReactionV2, } from "./discussions/api/reactions/reactions";
 export { getDefaultEntitySettings } from "./discussions/api/settings/getDefaultEntitySettings";
@@ -194,8 +194,8 @@ export { buildExistingExportsPortalQuery, getExportItemTypeKeyword, getExportLay
 export { canUseCreateReplica } from "./downloads/canUseCreateReplica";
 export { canUseHubDownloadApi } from "./downloads/canUseHubDownloadApi";
 export { canUseHubDownloadSystem } from "./downloads/canUseHubDownloadSystem";
-export { DownloadOperationStatus } from "./downloads/enums/downloadOperationStatus";
-export { ServiceDownloadFormat } from "./downloads/enums/serviceDownloadFormat";
+export { DownloadOperationStatus, TDownloadOperationStatus, } from "./downloads/enums/downloadOperationStatus";
+export { ServiceDownloadFormat, TServiceDownloadFormat, } from "./downloads/enums/serviceDownloadFormat";
 export { fetchDownloadFile } from "./downloads/fetchDownloadFile";
 export { getDownloadConfiguration } from "./downloads/getDownloadConfiguration";
 export { getDownloadFormats } from "./downloads/getDownloadFormats";
@@ -203,8 +203,8 @@ export { getHubDownloadApiFormats } from "./downloads/getHubDownloadApiFormats";
 export { ArcgisHubDownloadError, ArcgisHubDownloadFileTooLargeError, DownloadCacheStatus, downloadProgressCallback, IDownloadFormat, IDynamicDownloadFormat, IFetchDownloadFileBlobResponse, IFetchDownloadFileOptions, IFetchDownloadFileResponse, IFetchDownloadFileUrlResponse, IFetchDownloadFormatsOptions, IStaticDownloadFormat, LegacyExportItemFormat, PORTAL_EXPORT_TYPES, } from "./downloads/types";
 export { IEvent, IRegistration } from "./events/api/types";
 export { createHubEvent, createHubEventRegistration, deleteHubEvent, deleteHubEventRegistration, IHubCreateEventRegistration, updateHubEvent, } from "./events/edit";
-export { HubEventAttendanceType } from "./events/enums/hubEventAttendanceType";
-export { HubEventCapacityType } from "./events/enums/hubEventCapacityType";
+export { HubEventAttendanceType, THubEventAttendanceType, } from "./events/enums/hubEventAttendanceType";
+export { HubEventCapacityType, THubEventCapacityType, } from "./events/enums/hubEventCapacityType";
 export { convertClientEventToHubEvent, fetchEvent } from "./events/fetch";
 export { getEventGroups } from "./events/getEventGroups";
 export { HubEvent } from "./events/HubEvent";
@@ -233,10 +233,10 @@ export { inviteUsers } from "./groups/inviteUsers";
 export { isOpenDataGroup } from "./groups/isOpenDataGroup";
 export { IGroupMembershipSummary } from "./groups/types/IGroupMembershipSummary";
 export { IAddGroupMembersResult, IAddOrInviteMemberResponse, IEmail, } from "./groups/types/types";
-export { FileExtension } from "./enums/fileExtension";
-export { HubEntityHero } from "./enums/hubEntityHero";
-export { HubEntityStatus } from "./enums/hubEntityStatus";
-export { ItemType } from "./enums/itemType";
+export { FileExtension, TFileExtension } from "./enums/fileExtension";
+export { HubEntityHero, THubEntityHero } from "./enums/hubEntityHero";
+export { HubEntityStatus, THubEntityStatus } from "./enums/hubEntityStatus";
+export { ItemType, TItemType } from "./enums/itemType";
 export { _unprotectAndRemoveGroup } from "./groups/_unprotect-and-remove-group";
 export { AccessControl, addCreateItemTypes, BBox, GenericAsyncFunc, GeographyProvenance, HubFamilies, HubFamily, IActionLink, IAllowedFileTypes, IBatch, IBatchTransform, IDomainEntry, IDraft, IEnrichmentErrorInfo, IFileType, IGeometryProperties, IGetGroupSharingDetailsResults, IGetSurveyModelsResponse, IHubGeography, IHubRequestOptions, IHubRequestOptionsPortalSelf, IHubTeam, IHubTrustedOrgsRelationship, IHubTrustedOrgsResponse, IHubUserRequestOptions, IInitiativeItem, IInitiativeModel, IInitiativeModelTemplate, IItemResource, IItemTemplate, IModel, IModelTemplate, IOperation, IPolygonProperties, IRevertableTaskFailed, IRevertableTaskResult, IRevertableTaskSuccess, ISerializedOperationStack, ISolutionTemplate, ITemplateAsset, IUpdatePageOptions, IUpdateSiteOptions, SearchableType, SearchFunction, UserResourceApp, Visibility, } from "./hub-types";
 export { convertToWellKnownLocale } from "./i18n/convert-to-well-known-locale";

package/dist/types/resources/_internal/_validate-url-helpers.d.ts

@@ -1,5 +1,5 @@
 import type { IExtent, IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-feature-service";
-import { ItemType } from "../../enums/itemType";
+import { TItemType } from "../../enums/itemType";
 /**
  * Feature service / Doc Links Should not have data urls. Let"s exclude them from that.
  *
@@ -95,5 +95,5 @@ export declare function pingFeatureService(url: string): Promise<{
     ok: boolean;
     item?: any;
 }>;
-export declare function detectDataTypeFromHeader(headers: Headers): ItemType;
-export declare function detectDataTypeFromExtension(url: string): ItemType;
+export declare function detectDataTypeFromHeader(headers: Headers): TItemType;
+export declare function detectDataTypeFromExtension(url: string): TItemType;

package/dist/types/search/_internal/hubDiscussionsHelpers/processRelations.d.ts

@@ -1,7 +1,7 @@
-import { PostRelation } from "../../../discussions/api/enums/postRelation";
+import { TPostRelation } from "../../../discussions/api/enums/postRelation";
 /**
  * Convert an array of `include` into an array of PostRelation enum values.
  * @param relations array of include (e.g. ["channel", "replies"]).
  * @returns PostRelation[] with order of first appearance preserved and duplicates removed.
  */
-export declare function processRelations(relations?: string[]): PostRelation[];
+export declare function processRelations(relations?: string[]): TPostRelation[];

package/dist/types/search/types/IHubCatalog.d.ts

@@ -1,6 +1,6 @@
-import { CARD_TITLE_TAGS } from "../../core/schemas/shared/enums/cardTitleTags";
-import { CORNERS } from "../../core/schemas/shared/enums/corners";
-import { DROP_SHADOWS } from "../../core/schemas/shared/enums/dropShadows";
+import { TCardTitleTag } from "../../core/schemas/shared/enums/cardTitleTags";
+import { TCorner } from "../../core/schemas/shared/enums/corners";
+import { TDropShadow } from "../../core/schemas/shared/enums/dropShadows";
 export type CatalogType = "content" | "exclusion";
 export interface IHubCatalog {
     /**
@@ -157,7 +157,7 @@ export interface IGalleryDisplayConfig {
     /**  Gallery layout options to expose in the layout switcher */
     layouts?: Array<"list" | "grid" | "map" | "table" | "calendar" | "compact" | "grid-filled">;
     /** header tag for the gallery card titles - needed for a11y */
-    cardTitleTag?: CARD_TITLE_TAGS;
+    cardTitleTag?: TCardTitleTag;
     /** Type of media to render in the layout card */
     imageType?: "thumbnail" | "icon";
     /**
@@ -167,9 +167,9 @@ export interface IGalleryDisplayConfig {
      */
     showThumbnail?: "show" | "hide" | "grid";
     /** card corner appearance */
-    corners?: CORNERS;
+    corners?: TCorner;
     /** card drop shadow */
-    shadow?: DROP_SHADOWS;
+    shadow?: TDropShadow;
     /**
      * whether to show a button on the gallery card linking
      * out to the content - redundant with the title link,

package/dist/types/sites/_internal/enums/searchCategories.d.ts

@@ -1,8 +1,9 @@
-export declare enum SearchCategories {
-    DATA = "components.search.category_tabs.data",
-    SITES = "components.search.category_tabs.sites",
-    DOCUMENTS = "components.search.category_tabs.documents",
-    APPS_AND_MAPS = "components.search.category_tabs.apps_and_maps",
-    EVENTS = "components.search.category_tabs.events",
-    INITIATIVES = "components.search.category_tabs.initiatives"
-}
+export declare const SearchCategories: {
+    readonly DATA: "components.search.category_tabs.data";
+    readonly SITES: "components.search.category_tabs.sites";
+    readonly DOCUMENTS: "components.search.category_tabs.documents";
+    readonly APPS_AND_MAPS: "components.search.category_tabs.apps_and_maps";
+    readonly EVENTS: "components.search.category_tabs.events";
+    readonly INITIATIVES: "components.search.category_tabs.initiatives";
+};
+export type TSearchCategory = (typeof SearchCategories)[keyof typeof SearchCategories];

package/dist/types/sites/searchCategoriesToCollections.d.ts

@@ -1,5 +1,5 @@
 import { IHubCollection } from "../search/types/IHubCatalog";
-import { SearchCategories } from "./_internal/enums/searchCategories";
+import { TSearchCategory } from "./_internal/enums/searchCategories";
 /**
  * Convert searchCategories to collections. If no searchCategories are provided,
  * the default collections will be returned.
@@ -7,4 +7,4 @@ import { SearchCategories } from "./_internal/enums/searchCategories";
  * @param searchCategories searchCategories from site model (data.values.searchCategories)
  * @returns IHubCollections that respect the searchCategories configuration
  */
-export declare function searchCategoriesToCollections(searchCategories?: SearchCategories[]): IHubCollection[];
+export declare function searchCategoriesToCollections(searchCategories?: TSearchCategory[]): IHubCollection[];

package/dist/types/utils/internal/setEntityStatusKeyword.d.ts

@@ -1,8 +1,8 @@
-import { HubEntityStatus } from "../../enums/hubEntityStatus";
+import { THubEntityStatus } from "../../enums/hubEntityStatus";
 /**
  * adds/updates the entity status typekeyword and returns
  * a new array of typekeywords
  * @param typeKeywords entity's current typekeywords
  * @param status entity status
  */
-export declare function setEntityStatusKeyword(typeKeywords: string[], status: HubEntityStatus): string[];
+export declare function setEntityStatusKeyword(typeKeywords: string[], status: THubEntityStatus): string[];

package/package.json

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