Packages

Version 13.4.0

@esri/hub-common

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

npm install:

npm install @esri/hub-common @esri/arcgis-rest-auth@^2.14.0 || 3  @esri/arcgis-rest-feature-layer@^3.2.0  @esri/arcgis-rest-portal@^2.18.0 || 3  @esri/arcgis-rest-request@^2.14.0 || 3  @esri/arcgis-rest-types@^2.15.0 || 3

Module Import:

import {
  _prepareUploadRequests,
  _waitForItemReady,
  addContextToSlug,
  addDays,
  addDomain,
  addPermissionPolicy,
  addSiteDomains,
  addSolutionResourceUrlToAssets,
  addUsersToGroup,
  aggregateMetrics,
  aggregateValues,
  applyInitiativeMigrations,
  applyPermissionMigration,
  applyPropertiesToItems,
  applyUiSchemaElementOptions,
  applyVersion,
  arrayToObject,
  asyncForEach,
  autoAddUsers,
  batch,
  bBoxToExtent,
  bboxToString,
  buildDraft,
  buildExistingExportsPortalQuery,
  camelize,
  canEditEvent,
  canEditItem,
  canEditSite,
  canEditSiteContent,
  capitalize,
  catalogMigration,
  checkAlphaGating,
  checkAssertion,
  checkAssertions,
  checkAuthentication,
  checkCapability,
  checkCapabilityAccess,
  checkEdit,
  checkEntityPolicy,
  checkForStaleVersion,
  checkLicense,
  checkOwner,
  checkPermission,
  checkPrivileges,
  chunkArray,
  clearMemoizedCache,
  clearSession,
  cloneObject,
  combineQueries,
  completeOAuth2,
  compose,
  composeContent,
  configureBaseResources,
  constructSlug,
  convertItemToSite,
  convertModelToSite,
  convertSiteToModel,
  convertSolutionTemplateResourcesToAssets,
  convertToWellKnownLocale,
  convertUrlsToAnchorTags,
  createExtent,
  createId,
  createItemFromFile,
  createItemFromUrl,
  createItemFromUrlOrFile,
  createModel,
  createOperationPipeline,
  createSite,
  createVersion,
  dasherize,
  datasetToContent,
  datasetToItem,
  deepContains,
  deepFind,
  deepFindById,
  deepGetPropValues,
  deepSet,
  deepStringReplace,
  deleteProp,
  deleteSite,
  deleteVersion,
  detectDataTypeFromExtension,
  detectDataTypeFromHeader,
  doesItemExistWithTitle,
  domainExists,
  domainExistsPortal,
  dotifyString,
  emailOrgUsers,
  enrichContentSearchResult,
  enrichGroupSearchResult,
  enrichPageSearchResult,
  enrichSiteSearchResult,
  enrichUserSearchResult,
  ensureProp,
  ensureUniqueDomainName,
  ensureUniqueString,
  extend,
  extentToBBox,
  extentToPolygon,
  failSafe,
  failSafeUpdate,
  fetchAllPages,
  fetchAndUploadResource,
  fetchAndUploadThumbnail,
  fetchCatalog,
  fetchContent,
  fetchGroupEnrichments,
  fetchHubContent,
  fetchHubEntity,
  fetchHubTranslation,
  fetchImageAsBlob,
  fetchMaxNumUserGroupsLimit,
  fetchModelFromItem,
  fetchModelResources,
  fetchOrg,
  fetchOrgLimits,
  fetchSiteModel,
  fetchUserEnrichments,
  filterBy,
  filterSchemaToUiSchema,
  findBy,
  findItemsBySlug,
  flattenArray,
  formatFilterBlock,
  formatOgcAggregationsResponse,
  formatOgcItemsResponse,
  formatPredicate,
  generateRandomString,
  getBasePropertyMap,
  getCampaignUrl,
  getCategory,
  getContentIdentifier,
  getContentTypeIcon,
  getContentTypeLabel,
  getCulture,
  getDomainsForSite,
  getEntityEditorSchemas,
  getEntityMetrics,
  getExtentCenter,
  getFamily,
  getFamilyTypes,
  getFeatureLayerItem,
  getFeatureServiceItem,
  getFeatureServiceTitle,
  getFileName,
  getFilterQueryParam,
  getGeographicOrgExtent,
  getGroupHomeUrl,
  getGroupThumbnailUrl,
  getHubApiFromPortalUrl,
  getHubApiUrl,
  getHubApiUrlFromPortal,
  getHubLocaleAssetUrl,
  getHubProduct,
  getHubProjectEditorConfig,
  getHubUrlFromPortal,
  getIncludeListFromItemType,
  getInputFeatureServiceModel,
  getItemApiUrl,
  getItemAssets,
  getItemBySlug,
  getItemDataUrl,
  getItemHomeUrl,
  getItemHubId,
  getItemIdentifier,
  getItemLayerId,
  getItemOrgId,
  getItemThumbnailUrl,
  getLayerIdFromUrl,
  getModel,
  getModelBySlug,
  getModelFromOptions,
  getNextOgcCallback,
  getOgcAggregationQueryParams,
  getOrgDefaultTheme,
  getOrgExtentAsBBox,
  getPermissionPolicy,
  getPolicyResponseCode,
  getPortalApiUrl,
  getPortalBaseFromOrgUrl,
  getPortalUrl,
  getPortalUrls,
  getProp,
  getPropertyMap,
  getProps,
  getProxyUrl,
  getPublisherInfo,
  getQQueryParam,
  getQueryString,
  getServiceTypeFromUrl,
  getSession,
  getSiteById,
  getSourceFeatureServiceModelFromFieldworker,
  getStakeholderModel,
  getStructuredLicense,
  getSubscriptionType,
  getSurveyModels,
  getTopLevelPredicate,
  getTypeCategories,
  getTypeFromEntity,
  getTypes,
  getUiSchemaProps,
  getUniqueDomainName,
  getUniqueDomainNamePortal,
  getUniqueItemTitle,
  getUniqueSlug,
  getUserHomeUrl,
  getUserThumbnailUrl,
  getVersion,
  getWellKnownCatalog,
  getWellknownCollection,
  getWellknownCollections,
  getWithDefault,
  getWorkspaceCapabilities,
  hasBasePriv,
  hubApiRequest,
  hubSearch,
  includes,
  incrementString,
  interpolate,
  interpolateItemId,
  inviteUsers,
  isBBox,
  isCapability,
  isDomainForLegacySite,
  isDomainUsedElsewhere,
  isDownloadable,
  isFeatureLayer,
  isFeatureService,
  isFeatureService,
  isFieldworkerView,
  isGuid,
  isMapOrFeatureServerUrl,
  isNil,
  isPermission,
  isSafeRedirectUrl,
  isService,
  isServicesDirectoryDisabled,
  isSiteType,
  isSlug,
  isSubsystem,
  isUpdateGroup,
  isUrl,
  isValidDomain,
  isValidExtent,
  isWellKnownTypeFilter,
  itemToContent,
  itemToSearchResult,
  keywordSlugToUriSlug,
  last,
  lookupDomain,
  mapBy,
  mapModelToObject,
  mapObjectToModel,
  maybeAdd,
  maybePush,
  memoize,
  mergeObjects,
  migrateToCollectionKey,
  normalizeItemType,
  normalizeSolutionTemplateItem,
  objectToArray,
  objectToJsonBlob,
  ogcApiRequest,
  ogcItemToSearchResult,
  parseDatasetId,
  parseInclude,
  pingFeatureService,
  pingUrl,
  portalSearchItems,
  portalSearchItemsAsItems,
  processEntityCapabilities,
  processRevertableTasks,
  propifyString,
  removeContextFromSlug,
  removeDomain,
  removeDomainByHostname,
  removeDomainsBySiteId,
  removeEmptyProps,
  removePermissionPolicy,
  removeResource,
  replaceItemId,
  resolveDynamicValue,
  resolveDynamicValues,
  resolveItemQueryValues,
  resolveMetric,
  resolvePortalValues,
  resolveReferences,
  resolveServiceQueryValues,
  runRevertableTask,
  saveSession,
  searchOgcAggregations,
  searchOgcItems,
  searchVersions,
  serializeModel,
  serializeQueryForPortal,
  serializeSpatialReference,
  setContentType,
  setItemThumbnail,
  setProp,
  setSlugKeyword,
  setStatusKeyword,
  shareItemToGroups,
  shouldHaveDataUrl,
  slugify,
  stringToBlob,
  stripProtocol,
  subsetSchema,
  titleize,
  unique,
  uniqueBy,
  unprotectModel,
  unshareItemFromGroups,
  updateDomain,
  updateHubEntity,
  updateModel,
  updateSite,
  updateVersion,
  updateVersionMetadata,
  upgradeCatalogSchema,
  upgradeProtocol,
  upgradeSiteSchema,
  uploadImageResource,
  uploadResourcesFromUrl,
  upsertModelResources,
  upsertResource,
  uriSlugToKeywordSlug,
  validateUrl,
  without,
  withoutByProp,
  ArcGISContext,
  ArcGISContextManager,
  Catalog,
  Collection,
  Hub,
  HubContent,
  HubDiscussion,
  HubError,
  HubInitiative,
  HubItemEntity,
  HubProject,
  HubSite,
  Logger,
  OperationError,
  OperationStack,
  RemoteServerError,
} from "@esri/hub-common";

Version 24.2.0

@esri/hub-discussions

Module to interact with ArcGIS Hub Discussions API in Node.js and modern browsers.

npm install:

npm install @esri/hub-discussions @esri/arcgis-rest-auth@^2.14.0 || 3  @esri/arcgis-rest-request@^2.14.0 || 3  @esri/hub-common@^12.4.0 || 13

Module Import:

import {
  apiRequest,
  authenticateRequest,
  canCreateChannel,
  canCreateReaction,
  canDeletePost,
  canModifyChannel,
  canModifyPost,
  canModifyPostStatus,
  canPostToChannel,
  canReadFromChannel,
  createChannel,
  createChannelNotificationOptOut,
  createPost,
  createReaction,
  createReply,
  fetchChannel,
  fetchChannelNotifcationOptOut,
  fetchPost,
  isChannelInclusive,
  isDiscussable,
  isOrgAdmin,
  parseDiscussionURI,
  parseMentionedUsers,
  reduceByGroupMembership,
  removeChannel,
  removeChannelActivity,
  removeChannelNotificationOptOut,
  removePost,
  removeReaction,
  request,
  searchChannels,
  searchPosts,
  updateChannel,
  updatePost,
  updatePostSharing,
  updatePostStatus,
  ChannelPermission,
  RemoteServerError,
} from "@esri/hub-discussions";

Version 13.0.0

@esri/hub-downloads

Service for Hub downloads

npm install:

npm install @esri/hub-downloads @esri/arcgis-rest-auth@^3.1.0  @esri/arcgis-rest-feature-layer@^3.1.0  @esri/arcgis-rest-portal@^3.5.0  @esri/arcgis-rest-request@^3.1.0  @esri/hub-common@^12.4.0 || 13

Module Import:

import {
  pollDownloadMetadata,
  requestDatasetExport,
  requestDownloadMetadata,
} from "@esri/hub-downloads";

Version 13.0.0

@esri/hub-events

Module to interact with ArcGIS Hub Events in Node.js and modern browsers.

npm install:

npm install @esri/hub-events @esri/arcgis-rest-auth@^2.13.0 || 3  @esri/arcgis-rest-feature-layer@^2.13.0 || 3  @esri/arcgis-rest-portal@^2.15.0 || 3  @esri/arcgis-rest-request@^2.13.0 || 3  @esri/arcgis-rest-types@^2.13.0 || 3  @esri/hub-common@^12.4.0 || 13

Module Import:

import {
  addUsersToEvent,
  getEventFeatureServiceUrl,
  getEventQueryFromType,
  getEventServiceItem,
  getEventServiceUrl,
  registerForEvent,
  searchEvents,
  unregisterForEvent,
} from "@esri/hub-events";

Version 13.0.0

@esri/hub-search

Module to search for ArcGIS items and format them for display in ArcGIS Hub.

npm install:

npm install @esri/hub-search @esri/arcgis-rest-auth@^2.13.0 || 3  @esri/arcgis-rest-feature-layer@^2.13.0 || 3  @esri/arcgis-rest-portal@^2.6.1 || 3  @esri/arcgis-rest-request@^2.13.0 || 3  @esri/arcgis-rest-types@^2.13.0 || 3  @esri/hub-common@^12.4.0 || 13

Module Import:

import {
  agoSearch,
  flattenCategories,
  kMerge,
  mergeAggregations,
  mergePages,
  serialize,
  BinaryHeap,
  InvalidPaginationInputError,
} from "@esri/hub-search";

Version 13.0.0

@esri/hub-sites

Module to interact with ArcGIS Hub Sites in Node.js and modern browsers.

npm install:

npm install @esri/hub-sites @esri/arcgis-rest-auth@^2.13.0 || 3  @esri/arcgis-rest-portal@^2.19.0 || 3  @esri/arcgis-rest-request@^2.13.0 || 3  @esri/hub-common@^13  @esri/hub-initiatives@^13.0.0  @esri/hub-teams@^13.0.0

Module Import:

import {
  _getSharingEligibleModels,
  applyDraft,
  convertCard,
  convertLayoutToTemplate,
  convertPageToTemplate,
  convertRow,
  convertSection,
  convertSiteToTemplate,
  createPage,
  createPageModelFromTemplate,
  createSite,
  createSiteModelFromTemplate,
  deleteDraft,
  ensureOptionalGroupsTemplating,
  ensurePageHasSiteEntry,
  ensureRequiredPageProperties,
  ensureRequiredSiteProperties,
  extractAssets,
  fetchAndApplyDraft,
  fetchDraft,
  getCardDependencies,
  getDataForSiteItem,
  getDomain,
  getDomains,
  getDraftDate,
  getLayoutDependencies,
  getMembers,
  getPageDependencies,
  getPageEditUrl,
  getPageItemType,
  getPortalSiteHostname,
  getPortalSiteUrl,
  getRowDependencies,
  getSectionDependencies,
  getSiteDependencies,
  getSiteEditUrl,
  getSiteItemType,
  hasUnpublishedChanges,
  interpolateSite,
  isPage,
  isSite,
  linkSiteAndPage,
  markPublished,
  markUnpublished,
  removePage,
  removeSite,
  removeSiteFromPage,
  removeUnusedResources,
  saveDraft,
  savePublishedStatus,
  shareItemsToSiteGroups,
  siteSecondPass,
  unlinkPagesFromSite,
  unlinkSiteAndPage,
  updateAppRedirectUris,
  updatePage,
  updateSite,
  updateSiteApplicationUris,
  upgradeDraftSchema,
} from "@esri/hub-sites";

Version 13.0.0

@esri/hub-surveys

Module to interact with ArcGIS Hub Surveys in Node.js and modern browsers.

npm install:

npm install @esri/hub-surveys @esri/arcgis-rest-auth@^2.13.0 || 3  @esri/arcgis-rest-feature-layer@^2.13.0 || 3  @esri/arcgis-rest-portal@^2.13.0 || 3  @esri/arcgis-rest-request@^2.13.0 || 3  @esri/arcgis-rest-types@^2.13.0 || 3  @esri/hub-common@^12.4.0 || 13

Module Import:

import {
  getDetailedSurveyStatus,
  getGroupSharingDetails,
  getSurveyStatus,
  getSurveyStatusFromSchedule,
  isDraft,
  isPublished,
  migrateFormPropertiesSettings,
  setAccess,
  setAccessRevertable,
  shareWithGroup,
  shareWithGroupRevertable,
  shouldDisplayResults,
  unshareWithGroup,
  unshareWithGroupRevertable,
} from "@esri/hub-surveys";

Version 13.0.0

@esri/hub-teams

Module to interact with ArcGIS Hub Teams in Node.js and modern browsers.

npm install:

npm install @esri/hub-teams @esri/arcgis-rest-auth@^2.13.0 || 3  @esri/arcgis-rest-portal@^2.15.0 || 3  @esri/arcgis-rest-request@^2.13.0 || 3  @esri/arcgis-rest-types@^2.13.0 || 3  @esri/hub-common@^12.4.0 || 13

Module Import:

import {
  addOrInviteUsersToTeam,
  addOrInviteUsersToTeams,
  addUsersToTeam,
  applyPrivPropValuesToTemplate,
  canEditTeam,
  canUserCreateTeam,
  canUserCreateTeamInProduct,
  createHubTeam,
  createHubTeams,
  doesGroupExist,
  getAllowedGroupAccess,
  getOrgGroupLimit,
  getTeamById,
  getTeamMembers,
  getTeamPropertiesMapForProduct,
  getTeamsAvailableInProduct,
  getTeamsForProduct,
  getTeamStatus,
  getTeamTemplate,
  getTeamTypesAvailableInProduct,
  getUniqueGroupTitle,
  getUserCreatableTeams,
  hasAllPrivileges,
  removeInvalidPrivs,
  removeTeam,
  removeTeamFromItems,
  removeUsersFromTeam,
  removeUsersFromTeams,
  searchTeamContent,
  searchTeamMembers,
  teamsToAddUsersTo,
  updateTeam,
  updateUserMembership,
} from "@esri/hub-teams";