Version 12.32.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,
applyPermissionMigration,
applyPropertiesToItems,
applyUiSchemaElementOptions,
applyVersion,
arrayToObject,
asyncForEach,
autoAddUsers,
batch,
bBoxToExtent,
bboxToString,
buildDraft,
buildExistingExportsPortalQuery,
camelize,
canEditEvent,
canEditItem,
canEditSite,
canEditSiteContent,
capitalize,
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,
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,
getItemLayerId,
getItemOrgId,
getItemThumbnailUrl,
getLayerIdFromUrl,
getModel,
getModelBySlug,
getModelFromOptions,
getNextOgcCallback,
getOgcAggregationQueryParams,
getOgcItemQueryParams,
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,
last,
lookupDomain,
mapBy,
mapModelToObject,
mapObjectToModel,
maybeAdd,
maybePush,
memoize,
mergeObjects,
normalizeItemType,
normalizeSolutionTemplateItem,
objectToArray,
objectToJsonBlob,
ogcApiRequest,
ogcItemToSearchResult,
parseDatasetId,
parseInclude,
pingFeatureService,
pingUrl,
portalSearchItems,
portalSearchItemsAsItems,
processEntityCapabilities,
processRevertableTasks,
propifyString,
registerBrowserApp,
registerSiteAsApplication,
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,
shareItemToGroups,
shouldHaveDataUrl,
slugify,
stringToBlob,
stripProtocol,
subsetSchema,
titleize,
unique,
uniqueBy,
unprotectModel,
unshareItemFromGroups,
updateDomain,
updateHubEntity,
updateModel,
updateSite,
updateVersion,
updateVersionMetadata,
upgradeCatalogSchema,
upgradeProtocol,
upgradeSiteSchema,
uploadImageResource,
uploadResourcesFromUrl,
upsertModelResources,
upsertResource,
validateUrl,
without,
withoutByProp,
ArcGISContext,
ArcGISContextManager,
Catalog,
Collection,
Hub,
HubContent,
HubDiscussion,
HubError,
HubInitiative,
HubItemEntity,
HubProject,
HubSite,
Logger,
OperationError,
OperationStack,
RemoteServerError,
} from "@esri/hub-common";
- _prepareUploadRequests
- _waitForItemReady
- addContextToSlug
- addDays
- addDomain
- addPermissionPolicy
- addSiteDomains
- addSolutionResourceUrlToAssets
- addUsersToGroup
- aggregateMetrics
- aggregateValues
- applyPermissionMigration
- applyPropertiesToItems
- applyUiSchemaElementOptions
- applyVersion
- arrayToObject
- asyncForEach
- autoAddUsers
- batch
- bBoxToExtent
- bboxToString
- buildDraft
- buildExistingExportsPortalQuery
- camelize
- canEditEvent
- canEditItem
- canEditSite
- canEditSiteContent
- capitalize
- 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
- 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
- getItemLayerId
- getItemOrgId
- getItemThumbnailUrl
- getLayerIdFromUrl
- getModel
- getModelBySlug
- getModelFromOptions
- getNextOgcCallback
- getOgcAggregationQueryParams
- getOgcItemQueryParams
- 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
- last
- lookupDomain
- mapBy
- mapModelToObject
- mapObjectToModel
- maybeAdd
- maybePush
- memoize
- mergeObjects
- normalizeItemType
- normalizeSolutionTemplateItem
- objectToArray
- objectToJsonBlob
- ogcApiRequest
- ogcItemToSearchResult
- parseDatasetId
- parseInclude
- pingFeatureService
- pingUrl
- portalSearchItems
- portalSearchItemsAsItems
- processEntityCapabilities
- processRevertableTasks
- propifyString
- registerBrowserApp
- registerSiteAsApplication
- 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
- shareItemToGroups
- shouldHaveDataUrl
- slugify
- stringToBlob
- stripProtocol
- subsetSchema
- titleize
- unique
- uniqueBy
- unprotectModel
- unshareItemFromGroups
- updateDomain
- updateHubEntity
- updateModel
- updateSite
- updateVersion
- updateVersionMetadata
- upgradeCatalogSchema
- upgradeProtocol
- upgradeSiteSchema
- uploadImageResource
- uploadResourcesFromUrl
- upsertModelResources
- upsertResource
- validateUrl
- without
- withoutByProp
- ArcGISContext
- ArcGISContextManager
- Catalog
- Collection
- Hub
- HubContent
- HubDiscussion
- HubError
- HubInitiative
- HubItemEntity
- HubProject
- HubSite
- Logger
- OperationError
- OperationStack
- RemoteServerError
- addCreateItemTypes
- categories
- collections
- DEFAULT_DISCUSSION
- DEFAULT_INITIATIVE
- DEFAULT_PROJECT
- DEFAULT_SITE
- DEFAULT_THEME
- ENTITY_EXTENT_SCHEMA
- ENTITY_NAME_SCHEMA
- EntityResourceMap
- GLOBAL_EXTENT
- HUB_CDN_URLMAP
- PORTAL_EXPORT_TYPES
- SEARCH_APIS
- uiSchema
- uiSchema
- uiSchema
- WellKnownItemPredicates
- CapabilityPermissions
- DEFAULT_DISCUSSION_MODEL
- DEFAULT_INITIATIVE_MODEL
- DEFAULT_PROJECT_MODEL
- DEFAULT_SITE_MODEL
- ENTERPRISE_SITE_ITEM_TYPE
- HUB_DISCUSSION_ITEM_TYPE
- HUB_INITIATIVE_ITEM_TYPE
- HUB_LOCALES
- HUB_PROJECT_ITEM_TYPE
- HUB_SITE_ITEM_TYPE
- HUB_SITE_ITEM_TYPE
- HubPermissionsPolicies
- InitiativeEditorTypes
- InitiativeSchema
- itemPropsNotInTemplates
- PageVersionIncludeList
- ProjectEditorTypes
- ProjectSchema
- REQUIRED_PRIVS
- SITE_SCHEMA_VERSION
- SiteCapabilityPermissions
- SitePermissions
- SiteVersionIncludeList
- STANDARD_LICENSES
- validEditorTypes
- VERSION_RESOURCE_NAME
- VERSION_RESOURCE_PROPERTIES
- WGS84_WKID
- DatePrecision
- FileExtension
- ItemType
- Level
- PROJECT_STATUSES
- PublisherSource
- UiSchemaElementTypes
- UiSchemaRuleEffects
- UiSchemaSectionTypes
- UpdateFrequency
- AccessControl
- AccessLevel
- AssertionType
- BBox
- Capability
- CollaborationType
- CountByValue
- DatasetResource
- DynamicAggregation
- DynamicValue
- DynamicValueDefinition
- DynamicValueResult
- DynamicValues
- DynamicValueType
- EditorConfigType
- EditorType
- Enrichments
- EntityCapabilities
- EntityType
- GenericAsyncFunc
- GeographyProvenance
- GroupEnrichment
- HubEntity
- HubEntityType
- HubFamily
- HubLicense
- HubProduct
- HubSubsystem
- HubSystemStatus
- IBatch
- IBatchTransform
- IHubLocationType
- IItemTemplate
- InitiativeEditorType
- IRevertableTaskResult
- ItemOrServerEnrichment
- MetricSource
- NamedApis
- OrgLimitType
- Permission
- PipelineFn
- PlatformPrivilege
- PolicyResponse
- ProjectEditorType
- SearchableType
- SearchFunction
- ServiceAggregation
- SettableAccessLevel
- SystemStatus
- UiSchemaElementOptions
- UserEnrichment
- Visibility
- WellKnownCatalog
- WellKnownCollection
- IAccessResponse
- IActionLink
- IAddMemberContext
- IAllowedFileTypes
- IApiDefinition
- IArcGISContext
- IArcGISContextManagerOptions
- IArcGISContextOptions
- ICapabilityAccessResponse
- ICapabilityPermission
- ICatalogInfo
- ICatalogScope
- IChangeEventDetail
- IComposeContentOptions
- IConfigurationSchema
- IConfigurationValues
- IConsolidatedResult
- IContainsOptions
- IContainsResponse
- ICreateVersionOptions
- IDatasetEnrichments
- IDateRange
- IDeepCatalogInfo
- IDomainEntry
- IDraft
- IDynamicItemQueryDefinition
- IDynamicPortalSelfDefinition
- IDynamicServiceQueryDefinition
- IEditorConfig
- IEmail
- IEnrichmentErrorInfo
- IEntityInfo
- IEntityPermissionPolicy
- IEntityResource
- IEventModel
- IFetchContentOptions
- IFileType
- IFilter
- IGeometryProperties
- IGetGroupSharingDetailsResults
- IGetSurveyModelsResponse
- IGetWellKnownCatalogOptions
- IGroupAndEnrichments
- IGroupEnrichments
- IGroupMembershipSummary
- IHubAdditionalResource
- IHubAggregation
- IHubCatalog
- IHubCollection
- IHubContent
- IHubContentEnrichments
- IHubDiscussion
- IHubEditableContent
- IHubEntityBase
- IHubEvent
- IHubExtent
- IHubGeography
- IHubImage
- IHubImageOptions
- IHubInitiative
- IHubItemEntity
- IHubLayout
- IHubLocation
- IHubOptions
- IHubPage
- IHubProject
- IHubRequestOptions
- IHubRequestOptionsPortalSelf
- IHubSearchOptions
- IHubSearchResponse
- IHubSearchResult
- IHubSite
- IHubSiteTheme
- IHubStage
- IHubStageLink
- IHubTeam
- IHubTimeline
- IHubUserRequestOptions
- IInitiativeItem
- IInitiativeModel
- IInitiativeModelTemplate
- IItemAndEnrichments
- IItemEnrichments
- IItemQueryMetricSource
- IItemResource
- IItemResource
- ILink
- IMatchOptions
- IMessage
- IMetadataPaths
- IMetric
- IMetricAttributes
- IMetricFeature
- IModel
- IModelTemplate
- IOgcAggregationsResponse
- IOgcItem
- IOgcItemsResponse
- IOperation
- IOrgLimit
- IPermissionAccessResponse
- IPermissionPolicy
- IPipeable
- IPolicyAssertion
- IPolicyCheck
- IPolygonProperties
- IPredicate
- IPropertyMap
- IQuery
- IQueryParams
- IReference
- IRelativeDate
- IRevertableTaskFailed
- IRevertableTaskSuccess
- ISearchResponse
- ISearchResponseHash
- ISerializedOperationStack
- IServerEnrichments
- IServiceQuery
- IServiceQueryMetricSource
- IServiceQueryOptions
- ISimpleResult
- ISolutionTemplate
- ISortOption
- IStaticValueDefinition
- IStaticValueMetricSource
- IStructuredLicense
- ITemplateAsset
- IThumbnailOptions
- IUiSchema
- IUiSchemaElement
- IUiSchemaRule
- IUpdatePageOptions
- IUpdateSiteOptions
- IUserAndEnrichments
- IUserEnrichments
- IValidationResult
- IVersion
- IVersionMetadata
- IWellKnownApis
- IWithBannerImage
- IWithBannerImageStore
- IWithCapabilityBehavior
- IWithCatalog
- IWithCatalogBehavior
- IWithEditorBehavior
- IWithFeaturedImageBehavior
- IWithLayout
- IWithLayoutStore
- IWithMetrics
- IWithMetricsBehavior
- IWithPermissionBehavior
- IWithPermissions
- IWithSharingBehavior
- IWithSlug
- IWithStoreBehavior
- IWithThumbnailBehavior
- IWithVersioningBehavior
- IWithViewSettings
- IWorkspaceCapabilityResponse