@esri/hub-common 24.7.1 → 25.0.0

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

@@ -2,8 +2,8 @@ import { JSONSchema } from "json-schema-typed";
 import { CardEditorOptions, EntityEditorOptions } from "./internal/EditorOptions";
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { HubActionLink } from "../types/ActionLinks";
-import { UiSchemaRuleEffects } from "../enums/uiSchemaRuleEffects";
-import { UiSchemaMessageTypes } from "../enums/uiSchemaMessageTypes";
+import { TUiSchemaRuleEffect } from "../enums/uiSchemaRuleEffects";
+import { TUiSchemaMessageType } from "../enums/uiSchemaMessageTypes";
 export interface IEditorConfig {
     schema: IConfigurationSchema;
     uiSchema: IUiSchema;
@@ -143,7 +143,7 @@ export interface IUiSchemaComboboxItemContentEnd {
  * NOTE: `.condition` is deprecated and remains for backwards compatibility only. Please use `.conditions` instead.
  */
 export interface IUiSchemaRule {
-    effect: UiSchemaRuleEffects;
+    effect: TUiSchemaRuleEffect;
     condition?: IUiSchemaCondition;
     conditions?: Array<IUiSchemaCondition | boolean>;
 }
@@ -158,7 +158,7 @@ export interface IUiSchemaCondition {
  * NOTE: `.display`, `.title`, `.titleKey`, `.kind`, `.alwaysShow` are deprecated and remain for backwards compatibility only. Please use the new method of notices in the configuration editor instead.
  */
 export interface IUiSchemaMessage {
-    type: UiSchemaMessageTypes;
+    type: TUiSchemaMessageType;
     keyword?: string;
     label?: string;
     labelKey?: string;

package/dist/types/core/traits/IWithStatus.d.ts

@@ -1,4 +1,4 @@
-import { HubEntityStatus } from "../../enums/hubEntityStatus";
+import { THubEntityStatus } from "../../enums/hubEntityStatus";
 export interface IWithStatus {
-    status: HubEntityStatus;
+    status: THubEntityStatus;
 }

package/dist/types/core/traits/IWithViewSettings.d.ts

@@ -1,4 +1,4 @@
-import { HubEntityHero } from "../../enums/hubEntityHero";
+import { THubEntityHero } from "../../enums/hubEntityHero";
 import { HubActionLink } from "../types/ActionLinks";
 import { IHubEmbed } from "../types/Embeds";
 import { IHubMapSettings } from "../types/IHubMapSettings";
@@ -48,7 +48,7 @@ export interface IWithViewSettings {
     /**
      * what to show in the hero field, map/image
      */
-    hero?: HubEntityHero;
+    hero?: THubEntityHero;
     /**
      * array of actions for action links
      */

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

@@ -19,7 +19,7 @@ export interface IHubEmbed {
 export type HubEmbed = IHubEmbedApp | IHubEmbedMap | IHubEmbedSurvey | IHubEmbedExternal;
 /** app-specific embed */
 export interface IHubEmbedApp {
-    kind: EmbedKind.app;
+    kind: typeof EmbedKind.app;
     /** application id */
     id: string;
     /** embed height */
@@ -29,7 +29,7 @@ export interface IHubEmbedApp {
 }
 /** map-specific embed */
 export interface IHubEmbedMap {
-    kind: EmbedKind.map;
+    kind: typeof EmbedKind.map;
     /** web map/scene id */
     id: string;
     /** embed height */
@@ -37,7 +37,7 @@ export interface IHubEmbedMap {
 }
 /** external embed */
 export interface IHubEmbedExternal {
-    kind: EmbedKind.external;
+    kind: typeof EmbedKind.external;
     /** embed url */
     url: string;
     /** embed height */
@@ -45,7 +45,7 @@ export interface IHubEmbedExternal {
 }
 /** survey-specific embed */
 export interface IHubEmbedSurvey {
-    kind: EmbedKind.feedback;
+    kind: typeof EmbedKind.feedback;
     /** survey123 id */
     id: string;
     /** whether to show the survey header */

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

@@ -5,7 +5,7 @@ import { IStructuredLicense } from "../../items/get-structured-license";
 import { IHubContentEnrichments } from "./IHubContentEnrichments";
 import { IHubAdditionalResource } from "./IHubAdditionalResource";
 import { IHubItemEntity } from "./IHubItemEntity";
-import { PublisherSource } from "../enums/publisherSource";
+import { TPublisherSource } from "../enums/publisherSource";
 /**
  * Data model for content
  */
@@ -74,10 +74,10 @@ export interface IHubContent extends Omit<IHubItemEntity, "schemaVersion" | "per
     publisher?: {
         name?: string;
         username?: string;
-        nameSource: PublisherSource;
+        nameSource: TPublisherSource;
         organization?: string;
         orgId?: string;
-        organizationSource: PublisherSource;
+        organizationSource: TPublisherSource;
         isExternal: boolean;
     };
     /** URL of the resource's page in the Portal Home application */

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

@@ -1,5 +1,5 @@
-import { HubEventAttendanceType } from "../../events/enums/hubEventAttendanceType";
-import { HubEventCapacityType } from "../../events/enums/hubEventCapacityType";
+import { THubEventAttendanceType } from "../../events/enums/hubEventAttendanceType";
+import { THubEventCapacityType } from "../../events/enums/hubEventCapacityType";
 import { IWithCatalog } from "../traits/IWithCatalog";
 import { IWithPermissions } from "../traits/IWithPermissions";
 import { IWithSlug } from "../traits/IWithSlug";
@@ -16,7 +16,7 @@ export interface IHubEvent extends IHubItemEntity, IWithPermissions, IWithSlug,
     /**
      * The attendnace type of the event. Either `online`, `inPerson` or `both`
      */
-    attendanceType: HubEventAttendanceType;
+    attendanceType: THubEventAttendanceType;
     /**
      * True when the user can change the access of the event to `public`, `org` or `private`
      */
@@ -68,7 +68,7 @@ export interface IHubEvent extends IHubItemEntity, IWithPermissions, IWithSlug,
     /**
      * The capacity type for an in-person event, either `unlimited` or `fixed`
      */
-    inPersonCapacityType: HubEventCapacityType;
+    inPersonCapacityType: THubEventCapacityType;
     /**
      * The current number of in-person registrants with a registration status of `accepted`
      */
@@ -108,7 +108,7 @@ export interface IHubEvent extends IHubItemEntity, IWithPermissions, IWithSlug,
     /**
      * The capacity type for an online event, either `unlimited` or `fixed`
      */
-    onlineCapacityType: HubEventCapacityType;
+    onlineCapacityType: THubEventCapacityType;
     /**
      * The details for an online event
      */

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

@@ -1,8 +1,8 @@
-import { FeatureLayerStyle } from "../enums/featureLayerStyle";
+import { TFeatureLayerStyle } from "../enums/featureLayerStyle";
 /**
  * Interface for Hub Map settings.  Used to configure the map for an entity.
  */
 export interface IHubMapSettings {
     baseViewItemId: string[];
-    featureLayerStyle?: FeatureLayerStyle;
+    featureLayerStyle?: TFeatureLayerStyle;
 }

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

@@ -1,4 +1,4 @@
-import { TIMELINE_STAGE_STATUSES } from "../enums/timelineStageStatuses";
+import { TTimelineStageStatus } from "../enums/timelineStageStatuses";
 /**
  * Hub Timeline Definition
  */
@@ -37,7 +37,7 @@ export interface IHubStage {
     /**
      * Stage status
      */
-    status: TimelineStageStatus;
+    status: TTimelineStageStatus;
 }
 export interface IHubStageLink {
     /**
@@ -49,5 +49,3 @@ export interface IHubStageLink {
      */
     title?: string;
 }
-type TimelineStageStatus = keyof typeof TIMELINE_STAGE_STATUSES;
-export {};

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

@@ -4,8 +4,8 @@ import type { FieldType } from "@esri/arcgis-rest-request";
 import { IReference } from "./IReference";
 import { ServiceAggregation } from "./ServiceAggregation";
 import { IGeometryInstance } from "./IGeometryInstance";
-import { ExpressionRelationships } from "../enums/expressionRelationships";
-import { MetricVisibility } from "../enums/metricVisibility";
+import { TExpressionRelationship } from "../enums/expressionRelationships";
+import { TMetricVisibility } from "../enums/metricVisibility";
 /**
  * Defines the information required from a Metric
  */
@@ -192,7 +192,7 @@ export interface IExpression {
     /**
      * Relation between the values in an expression
      */
-    relationship?: ExpressionRelationships;
+    relationship?: TExpressionRelationship;
 }
 /**
  * Configuration for how to show a metric in the ui. These are just values that are important to how to
@@ -201,7 +201,7 @@ export interface IExpression {
 export interface IMetricDisplayConfig extends IMetricEditorValues {
     metricId: string;
     displayType: string;
-    visibility?: MetricVisibility;
+    visibility?: TMetricVisibility;
 }
 /**
  * Editor values expected when editing a metric. These are options that are set in the metric editor that

package/dist/types/discussions/api/enums/aclCategory.d.ts

@@ -2,11 +2,12 @@
  * @export
  * @enum {string}
  */
-export declare enum AclCategory {
-    ANONYMOUS_USER = "anonymousUser",
-    AUTHENTICATED_USER = "authenticatedUser",
-    GROUP = "group",
-    ORG = "org",
+export declare const AclCategory: {
+    readonly ANONYMOUS_USER: "anonymousUser";
+    readonly AUTHENTICATED_USER: "authenticatedUser";
+    readonly GROUP: "group";
+    readonly ORG: "org";
     /** Not API supported */
-    USER = "user"
-}
+    readonly USER: "user";
+};
+export type TAclCategory = (typeof AclCategory)[keyof typeof AclCategory];

package/dist/types/discussions/api/enums/aclSubCategory.d.ts

@@ -2,9 +2,10 @@
  * @export
  * @enum {string}
  */
-export declare enum AclSubCategory {
+export declare const AclSubCategory: {
     /** Only valid for category: `group` or `org` */
-    ADMIN = "admin",
+    readonly ADMIN: "admin";
     /** Only valid for category: `group` or `org` */
-    MEMBER = "member"
-}
+    readonly MEMBER: "member";
+};
+export type TAclSubCategory = (typeof AclSubCategory)[keyof typeof AclSubCategory];

package/dist/types/discussions/api/enums/channelFilter.d.ts

@@ -4,6 +4,7 @@
  * @export
  * @enum {string}
  */
-export declare enum ChannelFilter {
-    HAS_USER_POSTS = "has_user_posts"
-}
+export declare const ChannelFilter: {
+    readonly HAS_USER_POSTS: "has_user_posts";
+};
+export type TChannelFilter = (typeof ChannelFilter)[keyof typeof ChannelFilter];

package/dist/types/discussions/api/enums/channelRelation.d.ts

@@ -4,6 +4,7 @@
  * @export
  * @enum {string}
  */
-export declare enum ChannelRelation {
-    CHANNEL_ACL = "channelAcl"
-}
+export declare const ChannelRelation: {
+    readonly CHANNEL_ACL: "channelAcl";
+};
+export type TChannelRelation = (typeof ChannelRelation)[keyof typeof ChannelRelation];

package/dist/types/discussions/api/enums/channelSort.d.ts

@@ -4,12 +4,13 @@
  * @export
  * @enum {string}
  */
-export declare enum ChannelSort {
-    ACCESS = "access",
-    CREATED_AT = "createdAt",
-    CREATOR = "creator",
-    EDITOR = "editor",
-    ID = "id",
-    LAST_ACTIVITY = "last_activity",
-    UPDATED_AT = "updatedAt"
-}
+export declare const ChannelSort: {
+    readonly ACCESS: "access";
+    readonly CREATED_AT: "createdAt";
+    readonly CREATOR: "creator";
+    readonly EDITOR: "editor";
+    readonly ID: "id";
+    readonly LAST_ACTIVITY: "last_activity";
+    readonly UPDATED_AT: "updatedAt";
+};
+export type TChannelSort = (typeof ChannelSort)[keyof typeof ChannelSort];

package/dist/types/discussions/api/enums/commonSort.d.ts

@@ -2,10 +2,11 @@
  * @export
  * @enum {string}
  */
-export declare enum CommonSort {
-    CREATED_AT = "createdAt",
-    CREATOR = "creator",
-    EDITOR = "editor",
-    ID = "id",
-    UPDATED_AT = "updatedAt"
-}
+export declare const CommonSort: {
+    readonly CREATED_AT: "createdAt";
+    readonly CREATOR: "creator";
+    readonly EDITOR: "editor";
+    readonly ID: "id";
+    readonly UPDATED_AT: "updatedAt";
+};
+export type TCommonSort = (typeof CommonSort)[keyof typeof CommonSort];

package/dist/types/discussions/api/enums/discussionSource.d.ts

@@ -4,8 +4,9 @@
  * @export
  * @enum {string}
  */
-export declare enum DiscussionSource {
-    HUB = "hub",
-    AGO = "ago",
-    URBAN = "urban"
-}
+export declare const DiscussionSource: {
+    readonly HUB: "hub";
+    readonly AGO: "ago";
+    readonly URBAN: "urban";
+};
+export type TDiscussionSource = (typeof DiscussionSource)[keyof typeof DiscussionSource];

package/dist/types/discussions/api/enums/discussionType.d.ts

@@ -4,8 +4,9 @@
  * @export
  * @enum {string}
  */
-export declare enum DiscussionType {
-    GROUP = "group",
-    CONTENT = "content",
-    BOARD = "board"
-}
+export declare const DiscussionType: {
+    readonly GROUP: "group";
+    readonly CONTENT: "content";
+    readonly BOARD: "board";
+};
+export type TDiscussionType = (typeof DiscussionType)[keyof typeof DiscussionType];

package/dist/types/discussions/api/enums/entitySettingsType.d.ts

@@ -2,7 +2,8 @@
  * @export
  * @enum {string}
  */
-export declare enum EntitySettingType {
-    CONTENT = "content",
-    GROUP = "group"
-}
+export declare const EntitySettingType: {
+    readonly CONTENT: "content";
+    readonly GROUP: "group";
+};
+export type TEntitySettingType = (typeof EntitySettingType)[keyof typeof EntitySettingType];

package/dist/types/discussions/api/enums/postReaction.d.ts

@@ -4,30 +4,31 @@
  * @export
  * @enum {string}
  */
-export declare enum PostReaction {
-    CLAPPING_HANDS = "clapping_hands",
-    CONFUSED = "confused",
-    DOWN_ARROW = "down_arrow",
-    EYES = "eyes",
-    FACE_WITH_TEARS_OF_JOY = "face_with_tears_of_joy",
-    FIRE = "fire",
-    GRINNING = "grinning",
-    HEART = "heart",
-    LAUGH = "laugh",
-    ONE_HUNDRED = "one_hundred",
-    PARTYING = "partying",
-    PARTY_POPPER = "party_popper",
-    RAISING_HANDS = "raising_hands",
-    ROCKET = "rocket",
-    SAD = "sad",
-    SLIGHTLY_SMILING = "slightly_smiling",
-    SURPRISED = "surprised",
-    THINKING = "thinking",
-    THUMBS_UP = "thumbs_up",
-    THUMBS_DOWN = "thumbs_down",
-    TROPHY = "trophy",
-    UP_ARROW = "up_arrow",
-    WAVING_HAND = "waving_hand",
-    WINKING = "winking",
-    WORLD_MAP = "world_map"
-}
+export declare const PostReaction: {
+    readonly CLAPPING_HANDS: "clapping_hands";
+    readonly CONFUSED: "confused";
+    readonly DOWN_ARROW: "down_arrow";
+    readonly EYES: "eyes";
+    readonly FACE_WITH_TEARS_OF_JOY: "face_with_tears_of_joy";
+    readonly FIRE: "fire";
+    readonly GRINNING: "grinning";
+    readonly HEART: "heart";
+    readonly LAUGH: "laugh";
+    readonly ONE_HUNDRED: "one_hundred";
+    readonly PARTYING: "partying";
+    readonly PARTY_POPPER: "party_popper";
+    readonly RAISING_HANDS: "raising_hands";
+    readonly ROCKET: "rocket";
+    readonly SAD: "sad";
+    readonly SLIGHTLY_SMILING: "slightly_smiling";
+    readonly SURPRISED: "surprised";
+    readonly THINKING: "thinking";
+    readonly THUMBS_UP: "thumbs_up";
+    readonly THUMBS_DOWN: "thumbs_down";
+    readonly TROPHY: "trophy";
+    readonly UP_ARROW: "up_arrow";
+    readonly WAVING_HAND: "waving_hand";
+    readonly WINKING: "winking";
+    readonly WORLD_MAP: "world_map";
+};
+export type TPostReaction = (typeof PostReaction)[keyof typeof PostReaction];

package/dist/types/discussions/api/enums/postRelation.d.ts

@@ -4,11 +4,12 @@
  * @export
  * @enum {string}
  */
-export declare enum PostRelation {
-    REPLIES = "replies",
-    REPLY_COUNT = "replyCount",
-    REACTIONS = "reactions",
-    PARENT = "parent",
-    CHANNEL = "channel",
-    CHANNEL_ACL = "channelAcl"
-}
+export declare const PostRelation: {
+    readonly REPLIES: "replies";
+    readonly REPLY_COUNT: "replyCount";
+    readonly REACTIONS: "reactions";
+    readonly PARENT: "parent";
+    readonly CHANNEL: "channel";
+    readonly CHANNEL_ACL: "channelAcl";
+};
+export type TPostRelation = (typeof PostRelation)[keyof typeof PostRelation];

package/dist/types/discussions/api/enums/postSort.d.ts

@@ -4,16 +4,17 @@
  * @export
  * @enum {string}
  */
-export declare enum PostSort {
-    BODY = "body",
-    CHANNEL_ID = "channelId",
-    CREATED_AT = "createdAt",
-    CREATOR = "creator",
-    DISCUSSION = "discussion",
-    EDITOR = "editor",
-    ID = "id",
-    PARENT_ID = "parentId",
-    STATUS = "status",
-    TITLE = "title",
-    UPDATED_AT = "updatedAt"
-}
+export declare const PostSort: {
+    readonly BODY: "body";
+    readonly CHANNEL_ID: "channelId";
+    readonly CREATED_AT: "createdAt";
+    readonly CREATOR: "creator";
+    readonly DISCUSSION: "discussion";
+    readonly EDITOR: "editor";
+    readonly ID: "id";
+    readonly PARENT_ID: "parentId";
+    readonly STATUS: "status";
+    readonly TITLE: "title";
+    readonly UPDATED_AT: "updatedAt";
+};
+export type TPostSort = (typeof PostSort)[keyof typeof PostSort];

package/dist/types/discussions/api/enums/postStatus.d.ts

@@ -4,11 +4,12 @@
  * @export
  * @enum {string}
  */
-export declare enum PostStatus {
-    PENDING = "pending",
-    APPROVED = "approved",
-    REJECTED = "rejected",
-    DELETED = "deleted",
-    HIDDEN = "hidden",
-    BLOCKED = "blocked"
-}
+export declare const PostStatus: {
+    readonly PENDING: "pending";
+    readonly APPROVED: "approved";
+    readonly REJECTED: "rejected";
+    readonly DELETED: "deleted";
+    readonly HIDDEN: "hidden";
+    readonly BLOCKED: "blocked";
+};
+export type TPostStatus = (typeof PostStatus)[keyof typeof PostStatus];

package/dist/types/discussions/api/enums/postType.d.ts

@@ -4,9 +4,10 @@
  * @export
  * @enum{string}
  */
-export declare enum PostType {
-    Text = "text",
-    Announcement = "announcement",
-    Poll = "poll",
-    Question = "question"
-}
+export declare const PostType: {
+    readonly Text: "text";
+    readonly Announcement: "announcement";
+    readonly Poll: "poll";
+    readonly Question: "question";
+};
+export type TPostType = (typeof PostType)[keyof typeof PostType];

package/dist/types/discussions/api/enums/reactionRelation.d.ts

@@ -4,6 +4,7 @@
  * @export
  * @enum {string}
  */
-export declare enum ReactionRelation {
-    POST = "post"
-}
+export declare const ReactionRelation: {
+    readonly POST: "post";
+};
+export type TReactionRelation = (typeof ReactionRelation)[keyof typeof ReactionRelation];

package/dist/types/discussions/api/enums/role.d.ts

@@ -4,11 +4,12 @@
  * @export
  * @enum {string}
  */
-export declare enum Role {
-    READ = "read",
-    WRITE = "write",
-    READWRITE = "readWrite",
-    MODERATE = "moderate",
-    MANAGE = "manage",
-    OWNER = "owner"
-}
+export declare const Role: {
+    readonly READ: "read";
+    readonly WRITE: "write";
+    readonly READWRITE: "readWrite";
+    readonly MODERATE: "moderate";
+    readonly MANAGE: "manage";
+    readonly OWNER: "owner";
+};
+export type TRole = (typeof Role)[keyof typeof Role];

package/dist/types/discussions/api/enums/searchPostsFormat.d.ts

@@ -2,7 +2,8 @@
  * @export
  * @enum {string}
  */
-export declare enum SearchPostsFormat {
-    CSV = "csv",
-    JSON = "json"
-}
+export declare const SearchPostsFormat: {
+    readonly CSV: "csv";
+    readonly JSON: "json";
+};
+export type TSearchPostsFormat = (typeof SearchPostsFormat)[keyof typeof SearchPostsFormat];

package/dist/types/discussions/api/enums/sharingAccess.d.ts

@@ -4,8 +4,9 @@
  * @export
  * @enum {string}
  */
-export declare enum SharingAccess {
-    PUBLIC = "public",
-    ORG = "org",
-    PRIVATE = "private"
-}
+export declare const SharingAccess: {
+    readonly PUBLIC: "public";
+    readonly ORG: "org";
+    readonly PRIVATE: "private";
+};
+export type TSharingAccess = (typeof SharingAccess)[keyof typeof SharingAccess];

package/dist/types/discussions/api/enums/sortOrder.d.ts

@@ -4,7 +4,8 @@
  * @export
  * @enum {string}
  */
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
+export declare const SortOrder: {
+    readonly ASC: "ASC";
+    readonly DESC: "DESC";
+};
+export type TSortOrder = (typeof SortOrder)[keyof typeof SortOrder];