@esri/hub-common 20.20.0 → 20.21.0

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

@@ -9,7 +9,7 @@ import { EntityEditorOptions } from "../EditorOptions";
  * @param context
  * @returns
  */
-export declare const buildUiSchema: (i18nScope: string, config: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (_i18nScope: string, _config: EntityEditorOptions, _context: IArcGISContext) => Promise<IUiSchema>;
 /**
  * @private
  * constructs the default values for the project metrics editor.
@@ -21,4 +21,4 @@ export declare const buildUiSchema: (i18nScope: string, config: EntityEditorOpti
  * @param context
  * @returns
  */
-export declare const buildDefaults: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;
+export declare const buildDefaults: (_i18nScope: string, _options: EntityEditorOptions, _context: IArcGISContext) => Promise<IConfigurationValues>;

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

@@ -1,4 +1,4 @@
-import { SOURCE } from "./interfaces";
+import { SOURCE } from "./enums/source";
 export declare const IF_STATIC_THEN_REQUIRE_VALUE: {
     if: {
         type: string;

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

@@ -0,0 +1,5 @@
+export declare enum ICONS {
+    caretUp = "caret-up",
+    caretDown = "caret-down",
+    caretDouble = "caret-double-horizontal"
+}

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

@@ -0,0 +1,4 @@
+export declare enum LAYOUTS {
+    simple = "simple",
+    informational = "informational"
+}

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

@@ -0,0 +1,5 @@
+export declare enum SCALE {
+    small = "s",
+    medium = "m",
+    large = "l"
+}

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

@@ -0,0 +1,5 @@
+export declare enum SOURCE {
+    dynamic = "dynamic",
+    static = "static",
+    itemQuery = "itemQuery"
+}

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

@@ -0,0 +1,5 @@
+export declare enum UNIT_POSITIONS {
+    before = "before",
+    after = "after",
+    below = "below"
+}

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

@@ -0,0 +1,4 @@
+export declare enum VISUAL_INTEREST {
+    none = "none",
+    icon = "icon"
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Alignment values allowed for a display
+ *
+ * values = start | center | end
+ */
+export declare enum ALIGNMENTS {
+    start = "start",
+    center = "center",
+    end = "end"
+}

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

@@ -0,0 +1,11 @@
+/**
+ * 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"
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Corner values allowed for a display
+ *
+ * values = square | round
+ */
+export declare enum CORNERS {
+    square = "square",
+    round = "round"
+}

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

@@ -0,0 +1,11 @@
+/**
+ * Drop shadow values allowed for a display
+ *
+ * values = none | low | medium | heavy
+ */
+export declare enum DROP_SHADOWS {
+    none = "none",
+    low = "low",
+    medium = "medium",
+    heavy = "heavy"
+}

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

@@ -2,6 +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";
 export interface IEditorConfig {
     schema: IConfigurationSchema;
     uiSchema: IUiSchema;
@@ -75,36 +77,6 @@ export interface ICardEditorModuleType {
     buildUiSchema: (i18nScope: string, config: CardEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
     buildDefaults?: (i18nScope: string, options: CardEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;
 }
-export declare enum UiSchemaRuleEffects {
-    SHOW = "SHOW",
-    HIDE = "HIDE",
-    DISABLE = "DISABLE",
-    ENABLE = "ENABLE",
-    NONE = "",
-    RESET = "RESET"
-}
-export declare enum UiSchemaElementTypes {
-    section = "Section",
-    control = "Control",
-    layout = "Layout",
-    slot = "Slot",
-    notice = "Notice",
-    text = "Text"
-}
-export declare enum UiSchemaSectionTypes {
-    accordion = "accordion",
-    accordionItem = "accordionItem",
-    block = "block",
-    stepper = "stepper",
-    step = "step",
-    subblock = "subblock",
-    card = "card"
-}
-export declare enum UiSchemaMessageTypes {
-    error = "ERROR",
-    success = "SUCCESS",
-    custom = "CUSTOM"
-}
 export interface IConfigurationSchema extends JSONSchema {
     type?: "object";
 }

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

@@ -19,16 +19,11 @@ export interface ICapabilityConfig {
  * We intentionally want these interfaces to exist even if they are empty
  * as they are used to determine if a capability can be enabled
  */
-export interface IEventsConfig extends ICapabilityConfig {
-}
-export interface IProjectsConfig extends ICapabilityConfig {
-}
-export interface IInitiativesConfig extends ICapabilityConfig {
-}
-export interface IDiscussionsConfig extends ICapabilityConfig {
-}
-export interface IPagesConfig extends ICapabilityConfig {
-}
+export declare type IEventsConfig = ICapabilityConfig;
+export declare type IProjectsConfig = ICapabilityConfig;
+export declare type IInitiativesConfig = ICapabilityConfig;
+export declare type IDiscussionsConfig = ICapabilityConfig;
+export declare type IPagesConfig = ICapabilityConfig;
 export interface IContentConfig extends ICapabilityConfig {
     feeds?: any;
 }

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

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

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

@@ -1,4 +1,4 @@
-import { HubEntityHero } from "../../hub-types";
+import { HubEntityHero } from "../../enums/hubEntityHero";
 import { HubActionLink } from "../types/ActionLinks";
 import { IHubEmbed } from "../types/Embeds";
 import { IHubMapSettings } from "../types/IHubMapSettings";

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

@@ -1,10 +1,4 @@
-/** enum to discriminate between embed union members */
-export declare enum EmbedKind {
-    app = "app",
-    map = "map",
-    feedback = "feedback",
-    external = "external"
-}
+import { EmbedKind } from "../enums/embedKind";
 /** Interface to represent a Hub embed */
 export interface IHubEmbed {
     /** unique identifier */

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

@@ -5,13 +5,7 @@ import { IStructuredLicense } from "../../items/get-structured-license";
 import { IHubContentEnrichments } from "./IHubContentEnrichments";
 import { IHubAdditionalResource } from "./IHubAdditionalResource";
 import { IHubItemEntity } from "./IHubItemEntity";
-export declare enum PublisherSource {
-    CitationContact = "metadata.resource.citation.contact",
-    ResourceContact = "metadata.resource.contact",
-    MetadataContact = "metadata.contact",
-    ItemOwner = "item.owner",
-    None = "none"
-}
+import { PublisherSource } from "../enums/publisherSource";
 /**
  * Data model for content
  */
@@ -95,7 +89,7 @@ export interface IHubContent extends Omit<IHubItemEntity, "schemaVersion" | "per
     /** Optional links to show in the Hub application for this content */
     actionLinks?: IActionLink[];
     /** Configure which Hub application actions (i.e. create web map) are available for this content */
-    hubActions?: object;
+    hubActions?: Record<string, unknown>;
     /** Information about the layer referenced by this content (geometryType, fields, etc) */
     layer?: Partial<ILayerDefinition>;
     /** Whether or not the layer or table is actually a proxied CSV */

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

@@ -8,4 +8,4 @@ import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
  */
 export interface IHubDiscussion extends IHubItemEntity, IWithSlug, IWithCatalog, IWithPermissions {
 }
-export declare type IHubDiscussionEditor = IHubItemEntityEditor<IHubDiscussion> & {};
+export declare type IHubDiscussionEditor = IHubItemEntityEditor<IHubDiscussion> & Record<string, unknown>;

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

@@ -1,4 +1,5 @@
-import { HubEventAttendanceType, HubEventCapacityType } from "../../events/types";
+import { HubEventAttendanceType } from "../../events/enums/hubEventAttendanceType";
+import { HubEventCapacityType } from "../../events/enums/hubEventCapacityType";
 import { IWithCatalog } from "../traits/IWithCatalog";
 import { IWithPermissions } from "../traits/IWithPermissions";
 import { IWithSlug } from "../traits/IWithSlug";
@@ -148,4 +149,4 @@ export interface IHubEvent extends IHubItemEntity, IWithPermissions, IWithSlug,
      */
     timeZone: string;
 }
-export declare type IHubEventEditor = IHubItemEntityEditor<IHubEvent> & {};
+export declare type IHubEventEditor = IHubItemEntityEditor<IHubEvent> & Record<string, unknown>;

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

@@ -10,4 +10,4 @@ import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
  */
 export interface IHubInitiative extends IHubItemEntity, IWithSlug, IWithCatalog, IWithMetrics, IWithPermissions, IWithStatus {
 }
-export declare type IHubInitiativeEditor = IHubItemEntityEditor<IHubInitiative> & {};
+export declare type IHubInitiativeEditor = IHubItemEntityEditor<IHubInitiative> & Record<string, unknown>;

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

@@ -1,11 +1,4 @@
-/**
- * Enum for describing the feature layer styles.
- */
-export declare enum FeatureLayerStyle {
-    Hub = "hub",
-    Item = "item",
-    Service = "service"
-}
+import { FeatureLayerStyle } from "../enums/featureLayerStyle";
 /**
  * Interface for Hub Map settings.  Used to configure the map for an entity.
  */

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

@@ -1,3 +1,4 @@
+import { TIMELINE_STAGE_STATUSES } from "../enums/timelineStageStatuses";
 /**
  * Hub Timeline Definition
  */
@@ -49,11 +50,4 @@ export interface IHubStageLink {
     title?: string;
 }
 declare type TimelineStageStatus = keyof typeof TIMELINE_STAGE_STATUSES;
-export declare enum TIMELINE_STAGE_STATUSES {
-    notStarted = "notStarted",
-    inProgress = "inProgress",
-    skipped = "skipped",
-    onHold = "onHold",
-    complete = "complete"
-}
 export {};

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

@@ -4,6 +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";
 /**
  * Defines the information required from a Metric
  */
@@ -192,16 +194,6 @@ export interface IExpression {
      */
     relationship?: ExpressionRelationships;
 }
-/**
- * Possible relationships for an expression
- * 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"
-}
 /**
  * Configuration for how to show a metric in the ui. These are just values that are important to how to
  * display the metric; values that are configured in the editor should be added to IMetricEditorValues instead.
@@ -211,15 +203,6 @@ export interface IMetricDisplayConfig extends IMetricEditorValues {
     displayType: string;
     visibility?: MetricVisibility;
 }
-/**
- * Types of states of visibility a metric can be in
- * featured, visible, or hidden
- */
-export declare enum MetricVisibility {
-    visible = "visible",
-    hidden = "hidden",
-    featured = "featured"
-}
 /**
  * Editor values expected when editing a metric. These are options that are set in the metric editor that
  * help build the IMetricDisplayConfig.

package/dist/types/discussions/_internal/DiscussionUiSchemaSettings.d.ts

@@ -7,4 +7,4 @@ import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
  * defines how the schema properties should be
  * rendered in the Discussions settings experience
  */
-export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, _options: EntityEditorOptions, _context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -0,0 +1,12 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum AclCategory {
+    ANONYMOUS_USER = "anonymousUser",
+    AUTHENTICATED_USER = "authenticatedUser",
+    GROUP = "group",
+    ORG = "org",
+    /** Not API supported */
+    USER = "user"
+}

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

@@ -0,0 +1,10 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum AclSubCategory {
+    /** Only valid for category: `group` or `org` */
+    ADMIN = "admin",
+    /** Only valid for category: `group` or `org` */
+    MEMBER = "member"
+}

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

@@ -0,0 +1,9 @@
+/**
+ * filters of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ChannelFilter {
+    HAS_USER_POSTS = "has_user_posts"
+}

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

@@ -0,0 +1,9 @@
+/**
+ * relations of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ChannelRelation {
+    CHANNEL_ACL = "channelAcl"
+}

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

@@ -0,0 +1,15 @@
+/**
+ * Channel sorting fields
+ *
+ * @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"
+}

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

@@ -0,0 +1,11 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum CommonSort {
+    CREATED_AT = "createdAt",
+    CREATOR = "creator",
+    EDITOR = "editor",
+    ID = "id",
+    UPDATED_AT = "updatedAt"
+}

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

@@ -0,0 +1,11 @@
+/**
+ * source of a post, i.e. app context
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum DiscussionSource {
+    HUB = "hub",
+    AGO = "ago",
+    URBAN = "urban"
+}

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

@@ -0,0 +1,11 @@
+/**
+ * possible discussion content types, i.e. a post can be about an item, dataset, or group
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum DiscussionType {
+    GROUP = "group",
+    CONTENT = "content",
+    BOARD = "board"
+}

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

@@ -0,0 +1,8 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum EntitySettingType {
+    CONTENT = "content",
+    GROUP = "group"
+}

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

@@ -0,0 +1,33 @@
+/**
+ * reactions to posts
+ *
+ * @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"
+}

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

@@ -0,0 +1,14 @@
+/**
+ * relations of post entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum PostRelation {
+    REPLIES = "replies",
+    REPLY_COUNT = "replyCount",
+    REACTIONS = "reactions",
+    PARENT = "parent",
+    CHANNEL = "channel",
+    CHANNEL_ACL = "channelAcl"
+}

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

@@ -0,0 +1,19 @@
+/**
+ * Post sorting fields
+ *
+ * @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"
+}

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

@@ -0,0 +1,14 @@
+/**
+ * possible statuses of a post
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum PostStatus {
+    PENDING = "pending",
+    APPROVED = "approved",
+    REJECTED = "rejected",
+    DELETED = "deleted",
+    HIDDEN = "hidden",
+    BLOCKED = "blocked"
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Post types
+ *
+ * @export
+ * @enum{string}
+ */
+export declare enum PostType {
+    Text = "text",
+    Announcement = "announcement",
+    Poll = "poll",
+    Question = "question"
+}

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

@@ -0,0 +1,9 @@
+/**
+ * relations of reaction entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ReactionRelation {
+    POST = "post"
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Role types
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum Role {
+    READ = "read",
+    WRITE = "write",
+    READWRITE = "readWrite",
+    MODERATE = "moderate",
+    MANAGE = "manage",
+    OWNER = "owner"
+}

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

@@ -0,0 +1,8 @@
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum SearchPostsFormat {
+    CSV = "csv",
+    JSON = "json"
+}

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

@@ -0,0 +1,11 @@
+/**
+ * platform sharing access values
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum SharingAccess {
+    PUBLIC = "public",
+    ORG = "org",
+    PRIVATE = "private"
+}

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

@@ -0,0 +1,10 @@
+/**
+ * sort orders
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}