Packages

Version 20.22.0

@esri/hub-common

Common TypeScript types and utility functions for @esri/hub.js.

npm install:

npm install @esri/hub-common @esri/arcgis-rest-feature-service@^4.0.0  @esri/arcgis-rest-portal@^4.0.0  @esri/arcgis-rest-request@^4.7.1

Module Import:

import {
  _getPortalSettings,
  _prepareUploadRequests,
  _waitForItemReady,
  addContextToSlug,
  addDays,
  addDefaultItemSearchPredicates,
  addDomain,
  addDynamicSlugValidation,
  addGroupMembers,
  addHistoryEntry,
  addPermissionPolicy,
  addSiteDomains,
  addSolutionResourceUrlToAssets,
  addUsersToGroup,
  aggregateMetrics,
  aggregateValues,
  allCoordinatesPossiblyWGS84,
  apiRequest,
  appendIdToSlug,
  applyCatalogStructureMigration,
  applyDefaultCollectionMigration,
  applyDiscussionMigrations,
  applyHubSettingsMigrations,
  applyInitiativeMigrations,
  applyPageMigrations,
  applyPermissionMigration,
  applyProjectMigrations,
  applyPropertiesToItems,
  applySiteSettingsMigrations,
  applyVersion,
  arrayToObject,
  asyncForEach,
  authenticateRequest,
  authenticateRequest,
  authenticateRequest,
  authenticateRequest,
  autoAddUsers,
  base64ToUnicode,
  batch,
  bboxStringToGeoJSONPolygon,
  bBoxToExtent,
  bboxToString,
  breakAssociation,
  buildCatalog,
  buildDefaultEventEntity,
  buildDefaultEventRecord,
  buildDraft,
  buildEventAssociations,
  buildExistingExportsPortalQuery,
  buildReferencedContentSchema,
  buildSchema,
  buildWhereClause,
  cacheBustUrl,
  camelize,
  canCreateChannel,
  canCreateChannelV2,
  canCreatePost,
  canCreatePostV2,
  canCreateReaction,
  canCreateReactionV2,
  canCreateReply,
  canCreateReplyV2,
  canDeleteChannel,
  canDeleteChannelV2,
  canDeletePost,
  canDeletePostV2,
  canEditChannel,
  canEditChannelV2,
  canEditEvent,
  canEditItem,
  canEditPost,
  canEditPostStatus,
  canEditPostStatusV2,
  canEditPostV2,
  canEditSite,
  canEditSiteContent,
  canModifyChannel,
  canModifyPost,
  canModifyPostStatus,
  cannotCreatePostGroupsBlockedV2,
  canPostToChannel,
  canReadChannel,
  canReadChannelV2,
  canReadFromChannel,
  canUseCreateReplica,
  canUseHubDownloadApi,
  canUseHubDownloadSystem,
  capitalize,
  catalogContains,
  catalogToLegacy,
  channelToSearchResult,
  checkAll,
  checkAny,
  checkAssertion,
  checkAssertions,
  checkAuthentication,
  checkAvailability,
  checkDelete,
  checkEdit,
  checkEntityFeature,
  checkEntityPolicy,
  checkEnvironment,
  checkForStaleVersion,
  checkLicense,
  checkNot,
  checkOwner,
  checkPermission,
  checkPlatformVersion,
  checkPrivileges,
  checkReleaseGating,
  checkServiceStatus,
  chunkArray,
  clearMemoizedCache,
  cloneObject,
  combineQueries,
  commitItemUpload,
  compareAccess,
  compose,
  composeContent,
  composeHubContent,
  computeItemLinks,
  computeItemProps,
  computeLinks,
  computeLinks,
  computeLinks,
  computeLinks,
  computeLinks,
  computeLinks,
  computeLinks,
  computeLinks,
  computeProps,
  computeProps,
  configureBaseResources,
  constructSlug,
  convertCatalogToLegacyFormat,
  convertFeaturesToLegacyCapabilities,
  convertGroupToHubGroup,
  convertHubGroupToGroup,
  convertItemToContent,
  convertItemToSite,
  convertModelToPage,
  convertModelToSite,
  convertSolutionTemplateResourcesToAssets,
  convertToWellKnownLocale,
  convertUrlsToAnchorTags,
  convertUserToHubUser,
  createChannel,
  createChannelNotificationOptOut,
  createChannelNotificationOptOutV2,
  createChannelV2,
  createEvent,
  createEvent,
  createExtent,
  createHubChannel,
  createHubGroup,
  createId,
  createItem,
  createItemFromFile,
  createItemFromUrl,
  createItemFromUrlOrFile,
  createModel,
  createNotificationSpec,
  createOperationPipeline,
  createOrUpdateEntitySettings,
  createPost,
  createPostV2,
  createReaction,
  createReactionV2,
  createRegistration,
  createRegistration,
  createReply,
  createReplyV2,
  createSetting,
  createSettingV2,
  createSite,
  createSubscription,
  createSubscription,
  createUser,
  createUser,
  createVersion,
  customClient,
  customClient,
  customClient,
  dasherize,
  datasetToContent,
  datasetToItem,
  deepCatalogContains,
  deepContains,
  deepDeletePropByValue,
  deepEqual,
  deepFilter,
  deepFind,
  deepFindById,
  deepGetPropValues,
  deepSet,
  deepStringReplace,
  deleteEvent,
  deleteEvent,
  deleteGroupThumbnail,
  deleteHubChannel,
  deleteHubEvent,
  deleteItemThumbnail,
  deleteNotificationSpec,
  deleteProp,
  deleteRegistration,
  deleteRegistration,
  deleteSchedule,
  deleteSite,
  deleteSubscription,
  deleteUser,
  deleteUser,
  deleteVersion,
  deriveLocationFromItem,
  deriveUserRoleV2,
  detectDataTypeFromExtension,
  detectDataTypeFromHeader,
  discussionsApiRequest,
  discussionsApiRequestV2,
  doesItemExistWithTitle,
  doesResourceExist,
  domainExists,
  domainExistsPortal,
  dotifyString,
  editorToContent,
  editorToMetric,
  editorToTemplate,
  emailOrgUsers,
  enrichContentSearchResult,
  enrichEntity,
  enrichGroupSearchResult,
  enrichImageSearchResult,
  enrichInitiativeTemplateSearchResult,
  enrichPageSearchResult,
  enrichSiteSearchResult,
  enrichUserSearchResult,
  ensureLowercaseOrgUrlKeySlugAndKeyword,
  ensureProp,
  ensureUniqueDomainName,
  ensureUniqueEntitySlug,
  ensureUniqueString,
  eventAttendeeToSearchResult,
  eventToSearchResult,
  expandPortalQuery,
  expandPredicates,
  explainDatePredicate,
  explainFilter,
  explainMatchOptionPredicate,
  explainPredicate,
  explainPropPredicate,
  explainQueryResult,
  exportPosts,
  exportPostsV2,
  extend,
  extentToBBox,
  extentToPolygon,
  failSafe,
  failSafeUpdate,
  fetchAllPages,
  fetchAndUploadResource,
  fetchAndUploadThumbnail,
  fetchChannel,
  fetchChannelNotifcationOptOut,
  fetchChannelNotifcationOptOutV2,
  fetchChannelV2,
  fetchContent,
  fetchDownloadFile,
  fetchEntityCatalog,
  fetchGroupEnrichments,
  fetchHubChannel,
  fetchHubContent,
  fetchHubEntity,
  fetchHubGroup,
  fetchHubTranslation,
  fetchHubUser,
  fetchImageAsBlob,
  fetchInitiativeTemplate,
  fetchItem,
  fetchItemJobRecords,
  fetchMaxNumUserGroupsLimit,
  fetchModelFromItem,
  fetchModelResources,
  fetchOrg,
  fetchOrganization,
  fetchOrgCategories,
  fetchOrgLimits,
  fetchPost,
  fetchPostV2,
  fetchQueryCategories,
  fetchSetting,
  fetchSettingV2,
  fetchSiteModel,
  fetchUserEnrichments,
  fetchUserHubSettings,
  fetchUserSiteSettings,
  filterBy,
  findBy,
  findItemsBySlug,
  flattenArray,
  followEntity,
  forceUpdateContent,
  formatDiscussionPostTargetEntityResponse,
  formatFilterBlock,
  formatItemTargetEntityResponse,
  formatOgcAggregationsResponse,
  formatOgcItemsResponse,
  formatPredicate,
  generateRandomString,
  GeoJSONPolygonToBBox,
  getAssociatedEntitiesQuery,
  getAssociationHierarchy,
  getAssociationStats,
  getAuthedImageUrl,
  getAvailableToRequestAssociationCatalogs,
  getAvailableToRequestEntitiesQuery,
  getBasePropertyMap,
  getCampaignUrl,
  getCardEditorSchemas,
  getCardModelUrlFromEntity,
  getCardModelUrlFromResult,
  getCardType,
  getCatalogFromSiteModel,
  getCatalogGroups,
  getCategory,
  getCategoryTree,
  getCdnAssetUrl,
  getChannelAccess,
  getChannelGroupIds,
  getChannelOrgIds,
  getChannelUsersQuery,
  getContentEditUrl,
  getContentHomeUrl,
  getContentIdentifier,
  getContentTypeIcon,
  getContentTypeLabel,
  getCOrgOrEOrgId,
  getCulture,
  getDatePickerDate,
  getDefaultEntitySettings,
  getDefaultTemplates,
  getDeployedTemplateType,
  getDomainsForSite,
  getDownloadConfiguration,
  getDownloadFormats,
  getEditorConfig,
  getEditorSchemas,
  getEditorSlug,
  getEntityFollowersGroupId,
  getEntityGroups,
  getEntityMetrics,
  getEntityThumbnailUrl,
  getEntityTypeFromHubEntityType,
  getEnvironmentFromPortalUrl,
  getEvent,
  getEvent,
  getEventGroups,
  getEventSlug,
  getEventThumbnail,
  getExtentCenter,
  getExtentObject,
  getFamily,
  getFamilyTypes,
  getFeaturedContentCatalogs,
  getFeatureLayerItem,
  getFeatureServiceItem,
  getFeatureServiceTitle,
  getFeedConfiguration,
  getFeedTemplate,
  getFileName,
  getFilterQueryParam,
  getGroupHomeUrl,
  getGroupPredicate,
  getGroupThumbnailUrl,
  getHubApiFromPortalUrl,
  getHubApiUrl,
  getHubApiUrlFromPortal,
  getHubApiUrlRoot,
  getHubDownloadApiFormats,
  getHubEntityTypeFromPath,
  getHubLocaleAssetUrl,
  getHubProduct,
  getHubTypeFromItemType,
  getHubUrlFromPortal,
  getIdsFromAssociationGroups,
  getIdsFromKeywords,
  getIncludeListFromItemType,
  getIncludesAndReferencesQuery,
  getIncludesDoesNotReferenceQuery,
  getInputFeatureServiceModel,
  getItemApiUrl,
  getItemAssets,
  getItemBySlug,
  getItemDataUrl,
  getItemHomeUrl,
  getItemHubId,
  getItemIdentifier,
  getItemLayerId,
  getItemOrgId,
  getItemThumbnailUrl,
  getKilobyteSizeOfQuery,
  getLayerIdFromUrl,
  getLocationExtent,
  getLocationFromEvent,
  getLocationOptions,
  getModel,
  getModelBySlug,
  getModelFromOptions,
  getNextOgcCallback,
  getNotificationSpec,
  getNotificationSpecs,
  getObjectSize,
  getOgcAggregationQueryParams,
  getOptionalPredicateStringsByKey,
  getOrgDefaultTheme,
  getOrgExtentAsBBox,
  getOrgThumbnailUrl,
  getPathForHubEntityType,
  getPendingEntitiesQuery,
  getPendingProjectsQuery,
  getPermissionPolicy,
  getPolicyResponseCode,
  getPortalApiUrl,
  getPortalBaseFromOrgUrl,
  getPortalSignInSettings,
  getPortalUrl,
  getPortalUrls,
  getPostCSVFileName,
  getPredicateValues,
  getPredicateValuesByKey,
  getProp,
  getPropertyMap,
  getProps,
  getProxyUrl,
  getPublisherInfo,
  getQQueryParam,
  getQueryString,
  getRecommendedTemplatesCatalog,
  getReferencedEntityIds,
  getReferencesDoesNotIncludeQuery,
  getRegistration,
  getRegistration,
  getRegistrations,
  getRegistrations,
  getRelativeWorkspaceUrl,
  getRequestingEntitiesQuery,
  getResultSiteRelativeLink,
  getS123EditUrl,
  getS123ShareUrl,
  getSchedule,
  getSchedulerApiUrl,
  getScopeGroupPredicate,
  getServiceStatus,
  getServiceTypeFromUrl,
  getSharableGroupsComboBoxItems,
  getShortenedCategories,
  getSiteById,
  getSiteSchema,
  getSlugMaxLength,
  getSlugSchemaElement,
  getSourceFeatureServiceModelFromFieldworker,
  getStakeholderModel,
  getStructuredLicense,
  getSubdomainKeyword,
  getSubscription,
  getSubscription,
  getSubscriptions,
  getSubscriptions,
  getSubscriptionType,
  getSurveyModels,
  getTagItems,
  getTemplate,
  getTimePickerTime,
  getTopLevelPredicate,
  getTypeCategories,
  getTypeFromEntity,
  getTypes,
  getTypesFromEntityType,
  getUniqueDomainName,
  getUniqueDomainNamePortal,
  getUniqueItemTitle,
  getUniqueSlug,
  getUser,
  getUser,
  getUserGroupsByMembership,
  getUserGroupsFromQuery,
  getUserHomeUrl,
  getUsers,
  getUserThumbnailUrl,
  getVersion,
  getWellKnownAssociationsCatalog,
  getWellKnownCatalog,
  getWellKnownCatalogs,
  getWellknownCollection,
  getWellknownCollections,
  getWellKnownGroup,
  getWithDefault,
  guessTimeZone,
  handleSubdomainChange,
  hasBasePriv,
  hasOwnProperty,
  hasServiceCapability,
  hubApiRequest,
  hubItemEntityFromEditor,
  hubSearch,
  includes,
  incrementString,
  initCatalogOnEntityCreate,
  initiativeResultToCardModel,
  initiativeTemplateResultToCardModel,
  initiativeTemplateToCardModel,
  initiativeToCardModel,
  interpolate,
  interpolateItemId,
  inviteUsers,
  isAggregationCategory,
  isAGOFeatureServiceUrl,
  isArrayEqual,
  isAssociationSupported,
  isBBox,
  isComboboxItemSelected,
  isCuid,
  isDiscussable,
  isDomainForLegacySite,
  isDomainUsedElsewhere,
  isDownloadable,
  isDownloadSchedulingAvailable,
  isDraft,
  isEnterprisePortalUrl,
  isFamilyExpansionType,
  isFeatureLayer,
  isFeatureService,
  isFeatureService,
  isFieldworkerView,
  isFindable,
  isFullyQualifiedCategory,
  isGuid,
  isHostedFeatureServiceMainEntity,
  isHostedFeatureServiceMainItem,
  isHubService,
  isMapOrFeatureServerUrl,
  isNil,
  isNilOrEmptyString,
  isOpenDataGroup,
  isOrgAdmin,
  isOrgAdminInOrg,
  isOrganizationCategory,
  isOrgChannel,
  isPermission,
  isPrivateChannel,
  isPublicChannel,
  isSafeRedirectUrl,
  isSecureProxyServiceUrl,
  isService,
  isServicesDirectoryDisabled,
  isSiteType,
  isSlug,
  isUpdateGroup,
  isUrl,
  isUserFollowing,
  isUserInOrg,
  isValidDomain,
  isValidEntityType,
  isValidExtent,
  isWellKnownTypeFilter,
  itemToContent,
  itemToSearchResult,
  keywordSlugToUriSlug,
  last,
  lookupDomain,
  mapBy,
  mapEntityToStore,
  mapStoreToEntity,
  maybeAdd,
  maybePush,
  maybeUpdateSchedule,
  memoize,
  mergeObjects,
  metricToEditor,
  migrateDiscussionSlugAndOrgUrlKey,
  migrateEnsureHeaderComponentName,
  migrateInitiativeAddDefaultCatalog,
  migrateInitiativeSlugAndOrgUrlKey,
  migrateInvalidTimelineStages,
  migrateInvalidTimelineStages,
  migrateLegacyCapabilitiesToFeatures,
  migratePageSlugAndOrgUrlKey,
  migrateProjectSlugAndOrgUrlKey,
  migrateSlugAndOrgUrlKey,
  migrateToCollectionKey,
  modelToHubEditableContent,
  negateGroupPredicates,
  normalizeItemType,
  normalizeSolutionTemplateItem,
  notify,
  notify,
  objectToArray,
  objectToJsonBlob,
  ogcApiRequest,
  ogcItemToDiscussionPostResult,
  ogcItemToSearchResult,
  orgExtent,
  parseContainmentPath,
  parseDatasetId,
  parseDiscussionURI,
  parseIdentifier,
  parseInclude,
  parseMentionedUsers,
  pathToCatalogInfo,
  pickProps,
  pingFeatureService,
  pingUrl,
  poll,
  portalFetchOrgs,
  portalSearchGroupMembers,
  portalSearchItems,
  portalSearchItemsAsItems,
  portalToOrganization,
  portalToSearchResult,
  postToSearchResult,
  previewFeed,
  processActionLink,
  processActionLinks,
  processAttendeeFilters,
  processAttendeeOptions,
  processEntityFeatures,
  processFilters,
  processOptions,
  processPostFilters,
  processPostOptions,
  processRelations,
  processRevertableTasks,
  projectResultToCardModel,
  projectToCardModel,
  propifyString,
  reduceByGroupMembership,
  reflectCollectionsToSearchCategories,
  reharvestSiteCatalog,
  removeAssociationKeyword,
  removeChannel,
  removeChannelActivity,
  removeChannelActivityV2,
  removeChannelNotificationOptOut,
  removeChannelNotificationOptOutV2,
  removeChannelV2,
  removeContextFromSlug,
  removeDomain,
  removeDomainByHostname,
  removeDomainsBySiteId,
  removeEmptyProps,
  removeHistoryEntry,
  removePermissionPolicy,
  removePost,
  removePostV2,
  removeReaction,
  removeReactionV2,
  removeResource,
  removeSetting,
  removeSettingV2,
  replaceItemId,
  requestAssociation,
  resolveDynamicValue,
  resolveDynamicValues,
  resolveItemQueryValues,
  resolveMetric,
  resolvePortalValues,
  resolveReferences,
  resolveServiceQueryValues,
  runRevertableTask,
  searchAssociatedContent,
  searchCatalogs,
  searchCategoriesToCollections,
  searchChannels,
  searchChannelsV2,
  searchEntityCatalogs,
  searchEvents,
  searchEvents,
  searchOgcAggregations,
  searchOgcItems,
  searchPosts,
  searchPostsV2,
  searchVersions,
  serializeCatalogScope,
  serializeItemParams,
  serializeModel,
  serializeQueryForPortal,
  serializeSpatialReference,
  setAssociationKeyword,
  setContentType,
  setDiscussableKeyword,
  setEntityAccess,
  setEntityAssociationGroup,
  setEntityStatusKeyword,
  setFeedConfiguration,
  setFeedTemplate,
  setGroupThumbnail,
  setItemThumbnail,
  setMetricAndDisplay,
  setProp,
  setSchedule,
  setSlugKeyword,
  setSubdomainKeyword,
  shareEntityWithGroups,
  shareEventWithGroups,
  shareItemToGroups,
  shouldFetchData,
  shouldHaveDataUrl,
  slugify,
  splitArrayByLength,
  stringToBlob,
  stripProtocol,
  subscribe,
  subscribe,
  subsetSchema,
  templateResultToCardModel,
  templateToCardModel,
  titleize,
  toEnum,
  toEnums,
  toggleServiceCapability,
  truncateSlug,
  unfollowEntity,
  unicodeToBase64,
  unique,
  uniqueBy,
  unprotectModel,
  unshareEntityWithGroups,
  unshareEventWithGroups,
  unshareItemFromGroups,
  updateChannel,
  updateChannelV2,
  updateCommunityOrgSettings,
  updateDomain,
  updateEvent,
  updateEvent,
  updateHubChannel,
  updateHubEntity,
  updateItem,
  updateModel,
  updateNotificationSpec,
  updatePortalOrgSettings,
  updatePost,
  updatePostStatus,
  updatePostStatusV2,
  updatePostV2,
  updateRegistration,
  updateRegistration,
  updateSetting,
  updateSettingV2,
  updateSite,
  updateSubscription,
  updateSubscription,
  updateUser,
  updateUser,
  updateUserHubSettings,
  updateUserSiteSettings,
  updateVersion,
  updateVersionMetadata,
  upgradeCatalogSchema,
  upgradeProtocol,
  upgradeSiteSchema,
  uploadImageResource,
  uploadResourcesFromUrl,
  upsertModelResources,
  upsertResource,
  uriSlugToKeywordSlug,
  userHasPrivilege,
  userHasPrivileges,
  userResultToCardModel,
  validateUrl,
  wait,
  without,
  withoutByProp,
  ArcGISContext,
  ArcGISContextManager,
  ArcgisHubDownloadError,
  ArcgisHubDownloadFileTooLargeError,
  Catalog,
  Collection,
  EntityEditor,
  Hub,
  HubChannel,
  HubContent,
  HubDiscussion,
  HubError,
  HubEvent,
  HubGroup,
  HubInitiative,
  HubInitiativeTemplate,
  HubItemEntity,
  HubPage,
  HubProject,
  HubSite,
  HubTemplate,
  HubUser,
  Logger,
  OperationError,
  OperationStack,
  RemoteServerError,
  RemoteServerError,
} from "@esri/hub-common";

v20.22.0