@esri/hub-common 24.8.0 → 26.0.0

package/dist/types/core/enums/expressionRelationships.d.ts

@@ -3,8 +3,9 @@
  * BETWEEN -- used to show between two values, i.e. 7 < x < 10
  * IS_EXACTLY -- for exact matching, i.e. two same strings
  */
-export declare enum ExpressionRelationships {
-    BETWEEN = "between",
-    IS_EXACTLY = "isExactly",
-    LIKE = "like"
-}
+export declare const ExpressionRelationships: {
+    readonly BETWEEN: "between";
+    readonly IS_EXACTLY: "isExactly";
+    readonly LIKE: "like";
+};
+export type TExpressionRelationship = (typeof ExpressionRelationships)[keyof typeof ExpressionRelationships];

package/dist/types/core/enums/featureLayerStyle.d.ts

@@ -1,8 +1,9 @@
 /**
  * Enum for describing the feature layer styles.
  */
-export declare enum FeatureLayerStyle {
-    Hub = "hub",
-    Item = "item",
-    Service = "service"
-}
+export declare const FeatureLayerStyle: {
+    readonly Hub: "hub";
+    readonly Item: "item";
+    readonly Service: "service";
+};
+export type TFeatureLayerStyle = (typeof FeatureLayerStyle)[keyof typeof FeatureLayerStyle];

package/dist/types/core/enums/metricVisibility.d.ts

@@ -2,8 +2,9 @@
  * Types of states of visibility a metric can be in
  * featured, visible, or hidden
  */
-export declare enum MetricVisibility {
-    visible = "visible",
-    hidden = "hidden",
-    featured = "featured"
-}
+export declare const MetricVisibility: {
+    readonly visible: "visible";
+    readonly hidden: "hidden";
+    readonly featured: "featured";
+};
+export type TMetricVisibility = (typeof MetricVisibility)[keyof typeof MetricVisibility];

package/dist/types/core/enums/publisherSource.d.ts

@@ -1,7 +1,8 @@
-export declare enum PublisherSource {
-    CitationContact = "metadata.resource.citation.contact",
-    ResourceContact = "metadata.resource.contact",
-    MetadataContact = "metadata.contact",
-    ItemOwner = "item.owner",
-    None = "none"
-}
+export declare const PublisherSource: {
+    readonly CitationContact: "metadata.resource.citation.contact";
+    readonly ResourceContact: "metadata.resource.contact";
+    readonly MetadataContact: "metadata.contact";
+    readonly ItemOwner: "item.owner";
+    readonly None: "none";
+};
+export type TPublisherSource = (typeof PublisherSource)[keyof typeof PublisherSource];

package/dist/types/core/enums/timelineStageStatuses.d.ts

@@ -1,7 +1,8 @@
-export declare enum TIMELINE_STAGE_STATUSES {
-    notStarted = "notStarted",
-    inProgress = "inProgress",
-    skipped = "skipped",
-    onHold = "onHold",
-    complete = "complete"
-}
+export declare const TIMELINE_STAGE_STATUSES: {
+    readonly notStarted: "notStarted";
+    readonly inProgress: "inProgress";
+    readonly skipped: "skipped";
+    readonly onHold: "onHold";
+    readonly complete: "complete";
+};
+export type TTimelineStageStatus = (typeof TIMELINE_STAGE_STATUSES)[keyof typeof TIMELINE_STAGE_STATUSES];

package/dist/types/core/enums/uiSchemaElementTypes.d.ts

@@ -1,8 +1,9 @@
-export declare enum UiSchemaElementTypes {
-    section = "Section",
-    control = "Control",
-    layout = "Layout",
-    slot = "Slot",
-    notice = "Notice",
-    text = "Text"
-}
+export declare const UiSchemaElementTypes: {
+    readonly section: "Section";
+    readonly control: "Control";
+    readonly layout: "Layout";
+    readonly slot: "Slot";
+    readonly notice: "Notice";
+    readonly text: "Text";
+};
+export type TUiSchemaElementType = (typeof UiSchemaElementTypes)[keyof typeof UiSchemaElementTypes];

package/dist/types/core/enums/uiSchemaMessageTypes.d.ts

@@ -1,5 +1,6 @@
-export declare enum UiSchemaMessageTypes {
-    error = "ERROR",
-    success = "SUCCESS",
-    custom = "CUSTOM"
-}
+export declare const UiSchemaMessageTypes: {
+    readonly error: "ERROR";
+    readonly success: "SUCCESS";
+    readonly custom: "CUSTOM";
+};
+export type TUiSchemaMessageType = (typeof UiSchemaMessageTypes)[keyof typeof UiSchemaMessageTypes];

package/dist/types/core/enums/uiSchemaRuleEffects.d.ts

@@ -1,8 +1,9 @@
-export declare enum UiSchemaRuleEffects {
-    SHOW = "SHOW",
-    HIDE = "HIDE",
-    DISABLE = "DISABLE",
-    ENABLE = "ENABLE",
-    NONE = "",
-    RESET = "RESET"
-}
+export declare const UiSchemaRuleEffects: {
+    readonly SHOW: "SHOW";
+    readonly HIDE: "HIDE";
+    readonly DISABLE: "DISABLE";
+    readonly ENABLE: "ENABLE";
+    readonly NONE: "";
+    readonly RESET: "RESET";
+};
+export type TUiSchemaRuleEffect = (typeof UiSchemaRuleEffects)[keyof typeof UiSchemaRuleEffects];

package/dist/types/core/enums/uiSchemaSectionTypes.d.ts

@@ -1,9 +1,10 @@
-export declare enum UiSchemaSectionTypes {
-    accordion = "accordion",
-    accordionItem = "accordionItem",
-    block = "block",
-    stepper = "stepper",
-    step = "step",
-    subblock = "subblock",
-    card = "card"
-}
+export declare const UiSchemaSectionTypes: {
+    readonly accordion: "accordion";
+    readonly accordionItem: "accordionItem";
+    readonly block: "block";
+    readonly stepper: "stepper";
+    readonly step: "step";
+    readonly subblock: "subblock";
+    readonly card: "card";
+};
+export type TUiSchemaSectionType = (typeof UiSchemaSectionTypes)[keyof typeof UiSchemaSectionTypes];

package/dist/types/core/schemas/internal/metrics/definitions.d.ts

@@ -1,4 +1,3 @@
-import { SOURCE } from "./enums/source";
 export declare const IF_STATIC_THEN_REQUIRE_VALUE: {
     if: {
         type: string;
@@ -98,7 +97,7 @@ export declare const IF_STATIC_THEN_URL_FORMAT: {
             _metric: {
                 properties: {
                     type: {
-                        const: SOURCE;
+                        const: "static";
                     };
                 };
             };

package/dist/types/core/schemas/internal/metrics/enums/icons.d.ts

@@ -1,5 +1,6 @@
-export declare enum ICONS {
-    caretUp = "caret-up",
-    caretDown = "caret-down",
-    caretDouble = "caret-double-horizontal"
-}
+export declare const ICONS: {
+    readonly caretUp: "caret-up";
+    readonly caretDown: "caret-down";
+    readonly caretDouble: "caret-double-horizontal";
+};
+export type TIcon = (typeof ICONS)[keyof typeof ICONS];

package/dist/types/core/schemas/internal/metrics/enums/layouts.d.ts

@@ -1,4 +1,5 @@
-export declare enum LAYOUTS {
-    simple = "simple",
-    informational = "informational"
-}
+export declare const LAYOUTS: {
+    readonly simple: "simple";
+    readonly informational: "informational";
+};
+export type TLayout = (typeof LAYOUTS)[keyof typeof LAYOUTS];

package/dist/types/core/schemas/internal/metrics/enums/scale.d.ts

@@ -1,5 +1,6 @@
-export declare enum SCALE {
-    small = "s",
-    medium = "m",
-    large = "l"
-}
+export declare const SCALE: {
+    readonly small: "s";
+    readonly medium: "m";
+    readonly large: "l";
+};
+export type TScale = (typeof SCALE)[keyof typeof SCALE];

package/dist/types/core/schemas/internal/metrics/enums/source.d.ts

@@ -1,5 +1,6 @@
-export declare enum SOURCE {
-    dynamic = "dynamic",
-    static = "static",
-    itemQuery = "itemQuery"
-}
+export declare const SOURCE: {
+    readonly dynamic: "dynamic";
+    readonly static: "static";
+    readonly itemQuery: "itemQuery";
+};
+export type TSource = (typeof SOURCE)[keyof typeof SOURCE];

package/dist/types/core/schemas/internal/metrics/enums/unitPositions.d.ts

@@ -1,5 +1,6 @@
-export declare enum UNIT_POSITIONS {
-    before = "before",
-    after = "after",
-    below = "below"
-}
+export declare const UNIT_POSITIONS: {
+    readonly before: "before";
+    readonly after: "after";
+    readonly below: "below";
+};
+export type TUnitPosition = (typeof UNIT_POSITIONS)[keyof typeof UNIT_POSITIONS];

package/dist/types/core/schemas/internal/metrics/enums/visualInterest.d.ts

@@ -1,4 +1,5 @@
-export declare enum VISUAL_INTEREST {
-    none = "none",
-    icon = "icon"
-}
+export declare const VISUAL_INTEREST: {
+    readonly none: "none";
+    readonly icon: "icon";
+};
+export type TVisualInterest = (typeof VISUAL_INTEREST)[keyof typeof VISUAL_INTEREST];

package/dist/types/core/schemas/shared/enums/alignments.d.ts

@@ -3,8 +3,9 @@
  *
  * values = start | center | end
  */
-export declare enum ALIGNMENTS {
-    start = "start",
-    center = "center",
-    end = "end"
-}
+export declare const ALIGNMENTS: {
+    readonly start: "start";
+    readonly center: "center";
+    readonly end: "end";
+};
+export type TAlignment = (typeof ALIGNMENTS)[keyof typeof ALIGNMENTS];

package/dist/types/core/schemas/shared/enums/cardTitleTags.d.ts

@@ -1,11 +1,12 @@
 /**
  * Tags to wrap the title on each card
  */
-export declare enum CARD_TITLE_TAGS {
-    h1 = "h1",
-    h2 = "h2",
-    h3 = "h3",
-    h4 = "h4",
-    h5 = "h5",
-    h6 = "h6"
-}
+export declare const CARD_TITLE_TAGS: {
+    readonly h1: "h1";
+    readonly h2: "h2";
+    readonly h3: "h3";
+    readonly h4: "h4";
+    readonly h5: "h5";
+    readonly h6: "h6";
+};
+export type TCardTitleTag = (typeof CARD_TITLE_TAGS)[keyof typeof CARD_TITLE_TAGS];

package/dist/types/core/schemas/shared/enums/corners.d.ts

@@ -3,7 +3,8 @@
  *
  * values = square | round
  */
-export declare enum CORNERS {
-    square = "square",
-    round = "round"
-}
+export declare const CORNERS: {
+    readonly square: "square";
+    readonly round: "round";
+};
+export type TCorner = (typeof CORNERS)[keyof typeof CORNERS];

package/dist/types/core/schemas/shared/enums/dropShadows.d.ts

@@ -3,9 +3,10 @@
  *
  * values = none | low | medium | heavy
  */
-export declare enum DROP_SHADOWS {
-    none = "none",
-    low = "low",
-    medium = "medium",
-    heavy = "heavy"
-}
+export declare const DROP_SHADOWS: {
+    readonly none: "none";
+    readonly low: "low";
+    readonly medium: "medium";
+    readonly heavy: "heavy";
+};
+export type TDropShadow = (typeof DROP_SHADOWS)[keyof typeof DROP_SHADOWS];

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];