@esri/hub-common 20.20.0 → 20.21.0

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

@@ -1,60 +1,21 @@
 import { IPagingParams, IPagedResponse as IRestPagedResponse, IUser } from "@esri/arcgis-rest-portal";
 import type { Geometry, Polygon } from "geojson";
 import { IHubRequestOptions } from "../../hub-types";
-/**
- * sort orders
- *
- * @export
- * @enum {string}
- */
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-/**
- * 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"
-}
-/**
- * platform sharing access values
- *
- * @export
- * @enum {string}
- */
-export declare enum SharingAccess {
-    PUBLIC = "public",
-    ORG = "org",
-    PRIVATE = "private"
-}
+import { SharingAccess } from "./enums/sharingAccess";
+import { PostStatus } from "./enums/postStatus";
+import { PostType } from "./enums/postType";
+import { PostReaction } from "./enums/postReaction";
+import { SortOrder } from "./enums/sortOrder";
+import { PostRelation } from "./enums/postRelation";
+import { PostSort } from "./enums/postSort";
+import { SearchPostsFormat } from "./enums/searchPostsFormat";
+import { Role } from "./enums/role";
+import { ChannelFilter } from "./enums/channelFilter";
+import { AclCategory } from "./enums/aclCategory";
+import { AclSubCategory } from "./enums/aclSubCategory";
+import { ChannelRelation } from "./enums/channelRelation";
+import { ChannelSort } from "./enums/channelSort";
+import { EntitySettingType } from "./enums/entitySettingsType";
 /**
  * representation of AGOL platform sharing ACL
  * NOTE: orgs is an array to enable future org-org sharing/discussion
@@ -67,42 +28,6 @@ export interface IPlatformSharing {
     orgs: string[];
     access: SharingAccess;
 }
-/**
- * possible statuses of a post
- *
- * @export
- * @enum {string}
- */
-export declare enum PostStatus {
-    PENDING = "pending",
-    APPROVED = "approved",
-    REJECTED = "rejected",
-    DELETED = "deleted",
-    HIDDEN = "hidden",
-    BLOCKED = "blocked"
-}
-/**
- * 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"
-}
-/**
- * source of a post, i.e. app context
- *
- * @export
- * @enum {string}
- */
-export declare enum DiscussionSource {
-    HUB = "hub",
-    AGO = "ago",
-    URBAN = "urban"
-}
 /**
  * named parts of a discussion URI, follows this convention:
  * ${source}://${type}/${id}_${layer}?features=${...features}&attribute=${attribute}
@@ -123,57 +48,6 @@ export interface IDiscussionParams {
     features: string[] | null;
     attribute: string | null;
 }
-/**
- * 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"
-}
-/**
- * relations of reaction entity
- *
- * @export
- * @enum {string}
- */
-export declare enum ReactionRelation {
-    POST = "post"
-}
-/**
- * filters of channel entity
- *
- * @export
- * @enum {string}
- */
-export declare enum ChannelFilter {
-    HAS_USER_POSTS = "has_user_posts"
-}
-/**
- * @export
- * @enum {string}
- */
-export declare enum CommonSort {
-    CREATED_AT = "createdAt",
-    CREATOR = "creator",
-    EDITOR = "editor",
-    ID = "id",
-    UPDATED_AT = "updatedAt"
-}
-/**
- * @export
- * @enum {string}
- */
-export declare enum SearchPostsFormat {
-    CSV = "csv",
-    JSON = "json"
-}
 /**
  * creator property
  *
@@ -291,20 +165,6 @@ export interface IDiscussionsRequestOptions extends Omit<IHubRequestOptions, "ht
         [key: string]: any;
     };
 }
-/**
- * Role types
- *
- * @export
- * @enum {string}
- */
-export declare enum Role {
-    READ = "read",
-    WRITE = "write",
-    READWRITE = "readWrite",
-    MODERATE = "moderate",
-    MANAGE = "manage",
-    OWNER = "owner"
-}
 /**
  * Interface representing the meta data associated with a discussions
  * mention email
@@ -381,37 +241,6 @@ export interface IRemoveReactionResponse {
     success: boolean;
     reactionId: string;
 }
-/**
- * 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"
-}
-/**
- * Post types
- *
- * @export
- * @enum{string}
- */
-export declare enum PostType {
-    Text = "text",
-    Announcement = "announcement",
-    Poll = "poll",
-    Question = "question"
-}
 /**
  * representation of post from service
  *
@@ -643,52 +472,6 @@ export interface IRemovePostResponse {
     success: boolean;
     postId: string;
 }
-/**
- * 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"
-}
-/**
- * relations of channel entity
- *
- * @export
- * @enum {string}
- */
-export declare enum ChannelRelation {
-    CHANNEL_ACL = "channelAcl"
-}
-/**
- * @export
- * @enum {string}
- */
-export declare enum AclCategory {
-    ANONYMOUS_USER = "anonymousUser",
-    AUTHENTICATED_USER = "authenticatedUser",
-    GROUP = "group",
-    ORG = "org",
-    /** Not API supported */
-    USER = "user"
-}
-/**
- * @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"
-}
 /**
  * request option for creating a channel ACL permission
  *
@@ -1090,14 +873,6 @@ export interface IEntitySetting extends IWithAuthor, IWithEditor, IWithTimestamp
     type: EntitySettingType;
     settings: IEntitySettings;
 }
-/**
- * @export
- * @enum {string}
- */
-export declare enum EntitySettingType {
-    CONTENT = "content",
-    GROUP = "group"
-}
 /**
  * @export
  * @interface IEntitySettings

package/dist/types/discussions/api/utils/channel-permission.d.ts

@@ -1,4 +1,5 @@
-import { IChannel, IDiscussionsUser, IUpdateChannelV2, Role } from "../types";
+import { IChannel, IDiscussionsUser, IUpdateChannelV2 } from "../types";
+import { Role } from "../enums/role";
 /**
  * A map of update operations & ACL roles where the key is the update operation
  * and the value is an array of roles that are permitted to perform the update operation.

package/dist/types/discussions/api/utils/channels/derive-user-role-v2.d.ts

@@ -1,5 +1,6 @@
 import type { IUser } from "@esri/arcgis-rest-portal";
-import { IChannel, IDiscussionsUser, Role } from "../../types";
+import { IChannel, IDiscussionsUser } from "../../types";
+import { Role } from "../../enums/role";
 /**
  * Derives the user role for the given channel and user
  * @param channel an IChannel object

package/dist/types/discussions/api/utils/reactions/can-create-reaction-v2.d.ts

@@ -1,5 +1,6 @@
 import type { IUser } from "@esri/arcgis-rest-portal";
-import { PostReaction, IChannel, IDiscussionsUser } from "../../types";
+import { IChannel, IDiscussionsUser } from "../../types";
+import { PostReaction } from "../../enums/postReaction";
 /**
  * Utility that determines whether a Channel allows a given PostReaction
  * and whether the User has permissions to create it

package/dist/types/discussions/api/utils/reactions/can-create-reaction.d.ts

@@ -1,5 +1,6 @@
 import type { IUser } from "@esri/arcgis-rest-portal";
-import { PostReaction, IChannel, IDiscussionsUser } from "../../types";
+import { IChannel, IDiscussionsUser } from "../../types";
+import { PostReaction } from "../../enums/postReaction";
 /**
  * Utility that determines whether a Channel allows a given PostReaction
  * and whether the User has permissions to create it

package/dist/types/discussions/utils.d.ts

@@ -1,10 +1,11 @@
 import type { IGroup, IItem } from "@esri/arcgis-rest-portal";
 import type { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IChannel, SharingAccess } from "./api/types";
+import { IChannel } from "./api/types";
 import { IHubContent } from "../core/types/IHubContent";
 import { IHubItemEntity } from "../core/types/IHubItemEntity";
 import { IQuery } from "../search/types/IHubCatalog";
 import { IHubSearchResult } from "../search/types/IHubSearchResult";
+import { SharingAccess } from "./api/enums/sharingAccess";
 /**
  * Utility to determine if a given IGroup, IItem, IHubContent, or IHubItemEntity
  * is discussable.

package/dist/types/downloads/_internal/_types.d.ts

@@ -1,4 +1,4 @@
-import { ServiceDownloadFormat } from "../types";
+import { ServiceDownloadFormat } from "../enums/serviceDownloadFormat";
 /**
  * Formats supported by the /exportImage endpoint of Image Services.
  * Listed in the default order of appearance in the UI.

package/dist/types/downloads/enums/downloadOperationStatus.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Human-readable status of a download operation. Operation specific statuses
+ * should be converted to one of these statuses before being reported to the user.
+ */
+export declare enum DownloadOperationStatus {
+    PENDING = "pending",
+    PROCESSING = "processing",
+    CONVERTING = "converting",
+    COMPLETED = "completed",
+    FAILED = "failed"
+}

package/dist/types/downloads/enums/serviceDownloadFormat.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Comprehensive enum of all the download formats that are supported by service-backed items across the ArcGIS platform.
+ */
+export declare enum ServiceDownloadFormat {
+    BMP = "bmp",
+    GIF = "gif",
+    JPG = "jpg",
+    JPG_PNG = "jpgpng",
+    PNG = "png",
+    PNG8 = "png8",
+    PNG24 = "png24",
+    TIFF = "tiff",
+    PNG32 = "png32",
+    BIP = "bip",
+    BSQ = "bsq",
+    LERC = "lerc",
+    CSV = "csv",
+    EXCEL = "excel",
+    FEATURE_COLLECTION = "featureCollection",
+    FILE_GDB = "filegdb",
+    GEOJSON = "geojson",
+    GEO_PACKAGE = "geoPackage",
+    JSON = "json",
+    KML = "kml",
+    SHAPEFILE = "shapefile",
+    SQLITE = "sqlite"
+}

package/dist/types/downloads/types.d.ts

@@ -1,6 +1,8 @@
 import { IGeometryInstance } from "../core/types/IGeometryInstance";
 import { IHubEditableContent } from "../core/types/IHubEditableContent";
 import type { IArcGISContext } from "../types/IArcGISContext";
+import { DownloadOperationStatus } from "./enums/downloadOperationStatus";
+import { ServiceDownloadFormat } from "./enums/serviceDownloadFormat";
 /**
  * This hash map was defined to support the previous implementation of the export item flow.
  * We are currently working on a new implementation that will replace this hash map, but we
@@ -44,33 +46,6 @@ export declare const PORTAL_EXPORT_TYPES: {
     };
 };
 export declare type LegacyExportItemFormat = keyof typeof PORTAL_EXPORT_TYPES;
-/**
- * Comprehensive enum of all the download formats that are supported by service-backed items across the ArcGIS platform.
- */
-export declare enum ServiceDownloadFormat {
-    BMP = "bmp",
-    GIF = "gif",
-    JPG = "jpg",
-    JPG_PNG = "jpgpng",
-    PNG = "png",
-    PNG8 = "png8",
-    PNG24 = "png24",
-    TIFF = "tiff",
-    PNG32 = "png32",
-    BIP = "bip",
-    BSQ = "bsq",
-    LERC = "lerc",
-    CSV = "csv",
-    EXCEL = "excel",
-    FEATURE_COLLECTION = "featureCollection",
-    FILE_GDB = "filegdb",
-    GEOJSON = "geojson",
-    GEO_PACKAGE = "geoPackage",
-    JSON = "json",
-    KML = "kml",
-    SHAPEFILE = "shapefile",
-    SQLITE = "sqlite"
-}
 /**
  * Represents a file format related to a content entity that can be downloaded.
  * Formats can either be dynamic (i.e., generated on-the-fly) or static (i.e., pre-generated)
@@ -164,17 +139,6 @@ export interface IFetchDownloadFileUrlResponse extends IBaseFetchDownloadFileRes
     type: "url";
     href: string;
 }
-/**
- * Human-readable status of a download operation. Operation specific statuses
- * should be converted to one of these statuses before being reported to the user.
- */
-export declare enum DownloadOperationStatus {
-    PENDING = "pending",
-    PROCESSING = "processing",
-    CONVERTING = "converting",
-    COMPLETED = "completed",
-    FAILED = "failed"
-}
 /**
  * Options for fetching download formats for an entity.
  */

package/dist/types/enums/fileExtension.d.ts

@@ -0,0 +1,78 @@
+/**
+ * ENUM which defines File extensions.
+ */
+export declare enum FileExtension {
+    aptx = "aptx",
+    bpk = "bpk",
+    csv = "csv",
+    eaz = "eaz",
+    esriaddin = "esriaddin",
+    esriaddinx = "esriaddinx",
+    doc = "doc",
+    docx = "docx",
+    dlpk = "dlpk",
+    featurecollection = "featurecollection",
+    geojson = "geojson",
+    gcpk = "gcpk",
+    gpk = "gpk",
+    gpkg = "gpkg",
+    gpkx = "gpkx",
+    insightswbk = "insightswbk",
+    ipynb = "ipynb",
+    jpg = "jpg",
+    jpeg = "jpeg",
+    json = "json",
+    key = "key",
+    kml = "kml",
+    kmz = "kmz",
+    lpk = "lpk",
+    lpkx = "lpkx",
+    lyr = "lyr",
+    lyrx = "lyrx",
+    mapx = "mapx",
+    mmpk = "mmpk",
+    mpk = "mpk",
+    mpkx = "mpkx",
+    msd = "msd",
+    mspk = "mspk",
+    mxd = "mxd",
+    ncfg = "ncfg",
+    nmc = "nmc",
+    nmf = "nmf",
+    numbers = "numbers",
+    pages = "pages",
+    pagx = "pagx",
+    parquet = "parquet",
+    pdf = "pdf",
+    pmf = "pmf",
+    png = "png",
+    ppkx = "ppkx",
+    ppt = "ppt",
+    pptx = "pptx",
+    proconfigx = "proconfigx",
+    rpk = "rpk",
+    rptx = "rptx",
+    sd = "sd",
+    slpk = "slpk",
+    spk = "spk",
+    stylx = "stylx",
+    surveyaddin = "surveyaddin",
+    sxd = "sxd",
+    tif = "tif",
+    tiff = "tiff",
+    tpk = "tpk",
+    tpkx = "tpkx",
+    vsd = "vsd",
+    vtpk = "vtpk",
+    wmpk = "wmpk",
+    wpk = "wpk",
+    xls = "xls",
+    xml = "xml",
+    xlsx = "xlsx",
+    zip = "zip",
+    "3dd" = "3dd",
+    "3vr" = "3vr",
+    "3ws" = "3ws",
+    "rft.json" = "rft.json",
+    "rft.xml" = "rft.xml"
+}

package/dist/types/enums/hubEntityHero.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Types of entity heroes
+ */
+export declare enum HubEntityHero {
+    map = "map",
+    image = "image"
+}

package/dist/types/enums/hubEntityStatus.d.ts

@@ -0,0 +1,9 @@
+/**
+ * ENUM which defines entity statuses
+ */
+export declare enum HubEntityStatus {
+    notStarted = "notStarted",
+    inProgress = "inProgress",
+    onHold = "onHold",
+    complete = "complete"
+}

package/dist/types/enums/itemType.d.ts

@@ -0,0 +1,126 @@
+/**
+ * ENUM which defines human readable Item Type names
+ * DO **NOT** UPDATE THIS ENUM W/O RESOLVING https://devtopia.esri.com/dc/hub/issues/6990
+ */
+export declare enum ItemType {
+    "360 VR Experience" = "360 VR Experience",
+    "Apache Parquet" = "Apache Parquet",
+    "AppBuilder Widget Package" = "AppBuilder Widget Package",
+    "Desktop Add In" = "Desktop Add In",
+    "Explorer Add In" = "Explorer Add In",
+    "Explorer Map" = "Explorer Map",
+    "Explorer Layer" = "Explorer Layer",
+    "Windows Mobile Package" = "Windows Mobile Package",
+    "ArcGIS Pro Add In" = "ArcGIS Pro Add In",
+    "ArcGIS Pro Configuration" = "ArcGIS Pro Configuration",
+    "Globe Document" = "Globe Document",
+    "Map Document" = "Map Document",
+    "ArcPad Package" = "ArcPad Package",
+    "Published Map" = "Published Map",
+    "Scene Document" = "Scene Document",
+    "CityEngine Web Scene" = "CityEngine Web Scene",
+    "Code Sample" = "Code Sample",
+    "CSV Collection" = "CSV Collection",
+    "CSV" = "CSV",
+    "CAD Drawing" = "CAD Drawing",
+    "Deep Learning Package" = "Deep Learning Package",
+    "Desktop Application" = "Desktop Application",
+    "Desktop Application Template" = "Desktop Application Template",
+    "Desktop Style" = "Desktop Style",
+    "Earth Configuration" = "Earth Configuration",
+    "Feature Collection" = "Feature Collection",
+    "File Geodatabase" = "File Geodatabase",
+    "GeoJson" = "GeoJson",
+    "Geoprocessing Package" = "Geoprocessing Package",
+    "GeoPackage" = "GeoPackage",
+    "Geoprocessing Sample" = "Geoprocessing Sample",
+    "GML" = "GML",
+    "Image Collection" = "Image Collection",
+    "Image" = "Image",
+    "iWork Keynote" = "iWork Keynote",
+    "iWork Numbers" = "iWork Numbers",
+    "iWork Pages" = "iWork Pages",
+    "KML Collection" = "KML Collection",
+    "KML" = "KML",
+    "Layer" = "Layer",
+    "Layer Package" = "Layer Package",
+    "Layout" = "Layout",
+    "Locator Package" = "Locator Package",
+    "Map Package" = "Map Package",
+    "Map Template" = "Map Template",
+    "Microsoft Excel" = "Microsoft Excel",
+    "Microsoft Powerpoint" = "Microsoft Powerpoint",
+    "Visio Document" = "Visio Document",
+    "Microsoft Word" = "Microsoft Word",
+    "Mobile Basemap Package" = "Mobile Basemap Package",
+    "Mobile Map Package" = "Mobile Map Package",
+    "Mobile Scene Package" = "Mobile Scene Package",
+    "Notebook" = "Notebook",
+    "PDF" = "PDF",
+    "Pro Map" = "Pro Map",
+    "Pro Report" = "Pro Report",
+    "Project Package" = "Project Package",
+    "Project Template" = "Project Template",
+    "Raster function template" = "Raster function template",
+    "Rule Package" = "Rule Package",
+    "Scene Package" = "Scene Package",
+    "Service Definition" = "Service Definition",
+    "Shapefile" = "Shapefile",
+    "Survey123 Add In" = "Survey123 Add In",
+    "Tile Package" = "Tile Package",
+    "Vector Tile Package" = "Vector Tile Package",
+    "Workflow Manager Package" = "Workflow Manager Package",
+    "Document Link" = "Document Link",
+    "Feature Service" = "Feature Service",
+    "Geocoding Service" = "Geocoding Service",
+    "Geodata Service" = "Geodata Service",
+    "Geometry Service" = "Geometry Service",
+    "Geoprocessing Service" = "Geoprocessing Service",
+    "Geoenrichment Service" = "Geoenrichment Service",
+    "Globe Service" = "Globe Service",
+    "Image Service" = "Image Service",
+    "Map Service" = "Map Service",
+    "Network Analysis Service" = "Network Analysis Service",
+    "Vector Tile Service" = "Vector Tile Service",
+    "WFS" = "WFS",
+    "WMS" = "WMS",
+    "WMTS" = "WMTS",
+    "OGCFeatureServer" = "OGCFeatureServer",
+    "Scene Service" = "Scene Service",
+    "Stream Service" = "Stream Service",
+    "Workflow Manager Service" = "Workflow Manager Service",
+    "Web Mapping Application" = "Web Mapping Application",
+    "Mobile Application" = "Mobile Application",
+    "AppBuilder Extension" = "AppBuilder Extension",
+    "Google Drive" = "Google Drive",
+    "Dropbox" = "Dropbox",
+    "OneDrive" = "OneDrive",
+    "StoryMap" = "StoryMap",
+    "Dashboard" = "Dashboard",
+    "Hub Project" = "Hub Project",
+    "Hub Initiative" = "Hub Initiative",
+    "Hub Site Application" = "Hub Site Application",
+    "Web Experience" = "Web Experience",
+    "Insights Workbook Package" = "Insights Workbook Package",
+    "Application" = "Application",
+    "ArcGIS Explorer Application Configuration" = "ArcGIS Explorer Application Configuration",
+    "ArcMap Document" = "ArcMap Document",
+    "Layer File" = "Layer File",
+    "ogcFeature" = "ogcFeature",
+    FeatureServer = "Feature Service",
+    GeocodeServer = "GeocodeServer",
+    GeoDataServer = "GeoDataServer",
+    GeometryServer = "GeometryServer",
+    GeoenrichmentServer = "GeoenrichmentServer",
+    GPServer = "GPServer",
+    GlobeServer = "GlobeServer",
+    ImageServer = "ImageServer",
+    MapServer = "MapServer",
+    NAServer = "NAServer",
+    ElevationServer = "ElevationServer",
+    VectorTileServer = "VectorTileServer",
+    "Scene Server" = "Scene Server",
+    StreamServer = "StreamServer",
+    WMServer = "WMServer",
+    TiledImageServer = "TiledImageServer"
+}