@esri/hub-common 20.5.1 → 20.5.2

package/dist/types/models/getModel.d.ts

@@ -0,0 +1,8 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Gets the full item/data model for an item id
+ * @param {string} id
+ * @param {Object} requestOptions
+ */
+export declare function getModel(id: string, requestOptions: IRequestOptions): Promise<IModel>;

package/dist/types/models/getModelBySlug.d.ts

@@ -0,0 +1,16 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Get a model by it's slug
+ *
+ * This uses the [Filter](https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm) option of the
+ * to search for an item that has a typekeyword of `slug|{slug-value}`
+ *
+ * This is useful for applications that want to use human-readable urls instead
+ * of using item ids.
+ *
+ * @param slug
+ * @param requestOptions
+ * @returns
+ */
+export declare function getModelBySlug(slug: string, requestOptions: IRequestOptions): Promise<IModel>;

package/dist/types/models/updateModel.d.ts

@@ -0,0 +1,12 @@
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Update an IModel. Generic function that will be used across all
+ * type-specific update functions
+ *
+ * @export
+ * @param {IModel} "model" object (i.e. `{item:{...}, data:{...}}`)
+ * @param {IRequestOptions} requestOptions
+ * @returns {Promise<IModel>}
+ */
+export declare function updateModel(model: IModel, requestOptions: IUserRequestOptions): Promise<IModel>;

package/dist/types/models/upsertModelResource.d.ts

@@ -0,0 +1,20 @@
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Takes an IModel and an array of resources and upserts them to the
+ * backing item. Then searches for the resources that were upserted
+ * and attaches them to the model, which is returned.
+ *
+ * @export
+ * @param {IModel} model
+ * @param {Array<{
+ *     resource: Record<string, any>;
+ *     filename: string;
+ *   }>} resources
+ * @param {IUserRequestOptions} requestOptions
+ * @return {*}  {Promise<IModel>}
+ */
+export declare function upsertModelResources(model: IModel, resources: Array<{
+    resource: Record<string, any>;
+    filename: string;
+}>, requestOptions: IUserRequestOptions): Promise<IModel>;

package/dist/types/pages/_internal/pageEditorTypes.d.ts

@@ -0,0 +1,2 @@
+export declare const PageEditorTypes: readonly ["hub:page:edit", "hub:page:create"];
+export declare type PageEditorType = (typeof PageEditorTypes)[number];

package/dist/types/permissions/_internal/checkPlatformVersion.d.ts

@@ -0,0 +1,14 @@
+import { IArcGISContext } from "../../types/IArcGISContext";
+import { IPermissionPolicy } from "../types/IPermissionPolicy";
+import { IPolicyCheck } from "../types/IPolicyCheck";
+/**
+ * Gate access based on the platform version (portal.currentVersion).
+ * If the currentVersion is less than the policy.platformVersion, access is denied.
+ * This is used to limit access to features that need to roll out with a
+ * specific ArcGISOnline version. This should not be used with Enterprise.
+ * @param policy
+ * @param context
+ * @param _entity
+ * @returns
+ */
+export declare function checkPlatformVersion(policy: IPermissionPolicy, context: IArcGISContext, _entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/permissions/_internal/checkReleaseGating.d.ts

@@ -0,0 +1,13 @@
+import { IArcGISContext } from "../../types/IArcGISContext";
+import { IPermissionPolicy } from "../types/IPermissionPolicy";
+import { IPolicyCheck } from "../types/IPolicyCheck";
+/**
+ * @internal
+ * Verify that the policy.releaseAfter and policy.retireAfter requirements are met.
+ * These checks only apply in the "production" environment.
+ * @param policy
+ * @param context
+ * @param entity
+ * @returns
+ */
+export declare function checkReleaseGating(policy: IPermissionPolicy, context: IArcGISContext, _entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/projects/_internal/projectEditorTypes.d.ts

@@ -0,0 +1,2 @@
+export declare type ProjectEditorType = (typeof ProjectEditorTypes)[number];
+export declare const ProjectEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings"];

package/dist/types/search/_internal/applyWellKnownItemPredicates.d.ts

@@ -0,0 +1,19 @@
+import { IQuery } from "../types/IHubCatalog";
+/**
+ * @private
+ * Convert a Filter Group to expand well-known type filters
+ *
+ * The purpose of this function is to allow for the use of short-hand
+ * names for commonly used, complex queries.
+ *
+ * It works by looking for filters using the .type property, the value
+ * of which is a key in the WellKnownItemFilters hash. If found in the
+ * hash, the filters array of the active filterGroup is replaced with the
+ * filters specified in the hash.
+ *
+ * NOTE: Any other properties specified in a filter will be removed
+ *
+ * Only exported to enable extensive testing
+ * @param query
+ */
+export declare function applyWellKnownItemPredicates(query: IQuery): IQuery;

package/dist/types/search/_internal/bboxStringToGeoJSONPolygon.d.ts

@@ -0,0 +1,8 @@
+import { Polygon } from "geojson";
+/**
+ * Given a bounding box string, e.g. "126.2274169922485, -42.559149812106845, -25.647583007805757, 83.1100826092665",
+ * convert it into a geojson Polygon object
+ * @param bbox The bounding box string
+ * @returns a geojson Polygon object derived from the given bounding box string
+ */
+export declare function bboxStringToGeoJSONPolygon(bbox: string): Polygon;

package/dist/types/search/_internal/constants.d.ts

@@ -0,0 +1,2 @@
+import { IWellKnownItemPredicates } from "./types";
+export declare const WellKnownItemPredicates: IWellKnownItemPredicates;

package/dist/types/search/_internal/expandPredicates.d.ts

@@ -0,0 +1,8 @@
+import { IQuery } from "../types/IHubCatalog";
+/**
+ * Expand the predicates in a query without applying
+ * the well-known type expansions
+ * @param query
+ * @returns
+ */
+export declare function expandPredicates(query: IQuery): IQuery;

package/dist/types/search/_internal/hubDiscussionsHelpers/postToSearchResult.d.ts

@@ -0,0 +1,8 @@
+import { IPost } from "../../../discussions/api/types";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+/**
+ * Resolves an IHubSearchResult for the given IPost record
+ * @param post An IPost record
+ * @returns a IHubSearchResult for the given IPost record
+ */
+export declare function postToSearchResult(post: IPost): IHubSearchResult;

package/dist/types/search/_internal/hubDiscussionsHelpers/processPostFilters.d.ts

@@ -0,0 +1,8 @@
+import { ISearchPosts } from "../../../discussions/api/types";
+import { IFilter } from "../../types/IHubCatalog";
+/**
+ * Builds a Partial<ISearchPosts> given an Array of IFilter objects
+ * @param filters An Array of IFilter
+ * @returns A Partial<ISearchPosts> for the given Array of IFilter objects
+ */
+export declare function processPostFilters(filters: IFilter[]): Partial<ISearchPosts>;

package/dist/types/search/_internal/hubDiscussionsHelpers/processPostOptions.d.ts

@@ -0,0 +1,8 @@
+import { ISearchPosts } from "../../../discussions/api/types";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+/**
+ * Builds a Partial<ISearchPosts> for the given IHubSearchOptions
+ * @param options An IHubSearchOptions object
+ * @returns a Partial<ISearchPosts> for the given IHubSearchOptions
+ */
+export declare function processPostOptions(options: IHubSearchOptions): Partial<ISearchPosts>;

package/dist/types/search/_internal/hubDiscussionsHelpers/processRelations.d.ts

@@ -0,0 +1,7 @@
+import { PostRelation } from "../../../discussions/api/types";
+/**
+ * Convert an array of `include` into an array of PostRelation enum values.
+ * @param relations array of include (e.g. ["channel", "replies"]).
+ * @returns PostRelation[] with order of first appearance preserved and duplicates removed.
+ */
+export declare function processRelations(relations?: string[]): PostRelation[];

package/dist/types/search/_internal/hubSearchPosts.d.ts

@@ -0,0 +1,59 @@
+import { IHubSearchResult } from "../types/IHubSearchResult";
+import { IHubSearchOptions } from "../types/IHubSearchOptions";
+import { IHubSearchResponse } from "../types/IHubSearchResponse";
+import { IQuery } from "../types/IHubCatalog";
+/**
+ * @private
+ * Executes a Discussions API (v2) post search and resolves an IHubSearchResponse<IHubSearchResult>.
+ * Currently supported filters include (filter predicate key => accepted values):
+ *   - access: 'public' | 'private' | 'org' | Array<'public' | 'private' | 'org'>
+ *   - channel: string | string[]
+ *   - owner: string
+ *   - discussion: string
+ *   - editor: string
+ *   - status: 'pending' | 'approved' | 'rejected' | 'deleted' | 'hidden' | 'blocked' | Array<...>
+ *   - term: string
+ *   - title: string
+ *   - body: string
+ *   - bbox: string
+ *   - parentId: string | string[]
+ *   - groups: string | string[]
+ *   - postType: 'text' | 'announcement' | 'poll' | 'question'
+ *   - created: IDateRange<string | number> (mapped to createdAfter / createdBefore)
+ *   - modified: IDateRange<string | number> (mapped to updatedAfter / updatedBefore)
+ *
+ * Notes / constraints:
+ *   - For single-value filters where an array is provided (e.g., owner, editor, discussion, term, title, body, bbox), only the first value is used.
+ *   - title & body are ignored if term is provied, as term searches against both title and body
+ *   - Date range predicates use the shape: { from: string|number; to: string|number }.
+ *   - Unsupported filters are ignored silently.
+ *
+ * INCLUDE SUPPORT (options.include tokens mapped to post relations - bare tokens only)
+ *   channel     -> PostRelation.CHANNEL
+ *   parent      -> PostRelation.PARENT
+ *   replies     -> PostRelation.REPLIES (returns replies collection or paging info)
+ *   replyCount  -> PostRelation.REPLY_COUNT (numeric aggregate)
+ *   reactions   -> PostRelation.REACTIONS
+ *   channelAcl  -> PostRelation.CHANNEL_ACL
+ *   Unknown tokens are ignored; no namespaced forms (e.g. `post:channel`) are supported.
+ *
+ * Currently supported sort fields include (pass via `options.sortField`):
+ *   - body
+ *   - channelId
+ *   - created  (maps to createdAt)
+ *   - modified (maps to updatedAt)
+ *   - owner    (maps to creator)
+ *   - discussion
+ *   - editor
+ *   - id
+ *   - parentId
+ *   - status
+ *   - title
+ * Sort order: 'ASC' | 'DESC' (via `options.sortOrder`).
+ * Pagination options: `options.num` (page size), `options.start` (1-based offset handled by API).
+ *
+ * @param query An IQuery object (must include `filters` and `targetEntity: 'post'` upstream)
+ * @param options An IHubSearchOptions object
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult>
+ */
+export declare function hubSearchPosts(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/_internal/isFamilyExpansionType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Checks to see if our type is a family expansion,
+ * i.e. our type is a key in HubFamilies and it begins with a dollar sign
+ *
+ * $content, $site, etc.
+ * @param key
+ * @returns
+ */
+export declare function isFamilyExpansionType(key: string): boolean;

package/dist/types/search/_internal/isWellKnownTypeFilter.d.ts

@@ -0,0 +1,11 @@
+import { IMatchOptions } from "../types/types";
+/**
+ * Is the argument a well-known type "key"
+ *
+ * Accepts `string`, `string[]` or `IMatchOptions`
+ * but only string values can possibly be keys
+ * on `WellKnownItemFilters`
+ * @param key
+ * @returns
+ */
+export declare function isWellKnownTypeFilter(key: string | string[] | IMatchOptions): boolean;

package/dist/types/search/_internal/types.d.ts

@@ -0,0 +1,15 @@
+import { IPredicate } from "../types/IHubCatalog";
+export interface IWellKnownItemPredicates {
+    $application: IPredicate[];
+    $feedback: IPredicate[];
+    $dashboard: IPredicate[];
+    $dataset: IPredicate[];
+    $experience: IPredicate[];
+    $site: IPredicate[];
+    $storymap: IPredicate[];
+    $initiative: IPredicate[];
+    $document: IPredicate[];
+    $webmap: IPredicate[];
+    $template: IPredicate[];
+    $page: IPredicate[];
+}

package/dist/types/search/getCOrgOrEOrgId.d.ts

@@ -0,0 +1,8 @@
+import { IArcGISContext } from "../types/IArcGISContext";
+/**
+ * Get the c-org or e-org ID. Defaults to the communityOrgId if the user is currently authed into
+ * an e-org; otherwise it looks up the trusted org relationship to get the e-org id
+ * @param context IArcGISContext
+ * @returns orgid of the c-org or e-org
+ */
+export declare function getCOrgOrEOrgId(context: IArcGISContext): string;

package/dist/types/search/relativeDateToDateRange.d.ts

@@ -0,0 +1,8 @@
+import { IDateRange, IRelativeDate } from "./types/types";
+/**
+ * @private
+ * Convert a RelativeDate to a DateRange<number>
+ * @param relative
+ * @returns
+ */
+export declare function relativeDateToDateRange(relative: IRelativeDate): IDateRange<number>;

package/dist/types/search/types/ICatalogSearchResponse.d.ts

@@ -0,0 +1,9 @@
+import { ISearchResponseHash } from "./IHubSearchResponseHash";
+/**
+ * Response from a search operation on a Catalog
+ */
+export interface ICatalogSearchResponse {
+    catalogTitle: string;
+    collectionResults: ISearchResponseHash;
+    scopeResults?: ISearchResponseHash;
+}

package/dist/types/search/types/IHubSearchResponseHash.d.ts

@@ -0,0 +1,7 @@
+import { IHubSearchResponse } from "./IHubSearchResponse";
+import { IHubSearchResult } from "./IHubSearchResult";
+/**
+ * Response from a Catalog search operation where the responses for different collections
+ * or entities are grouped into a single object.
+ */
+export declare type ISearchResponseHash = Record<string, IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/types/ISearchAssociatedContentOptions.d.ts

@@ -0,0 +1,32 @@
+import { HubEntity } from "../../core/types/HubEntity";
+import { IHubRequestOptions } from "../../hub-types";
+import { IQuery } from "./IHubCatalog";
+/**
+ * Options for searching associated content for a given entity
+ */
+export interface ISearchAssociatedContentOptions {
+    /**
+     * The entity to search for associated content
+     */
+    entity: HubEntity;
+    /**
+     * The type of association to search for (e.g., "related", "connected")
+     */
+    association: "related" | "connected";
+    /**
+     * The request options to use for the search
+     */
+    requestOptions: IHubRequestOptions;
+    /**
+     * The scope of the search. Must have targetEntity of "item"
+     */
+    scope: IQuery;
+    /**
+     * Which layer within the entity should be searched. Required for "connected" associations
+     */
+    layerId?: string;
+    /**
+     * The number of results to return
+     */
+    num?: number;
+}

package/dist/types/search/valueToMatchOptions.d.ts

@@ -0,0 +1,8 @@
+import { IMatchOptions } from "./types/types";
+/**
+ * @private
+ * Convert a field value into a MatchOptions if it's not already one
+ * @param value
+ * @returns
+ */
+export declare function valueToMatchOptions(value: string | string[] | IMatchOptions): IMatchOptions;

package/dist/types/sites/_internal/removeCatalogFromUpgradedSite.d.ts

@@ -0,0 +1,13 @@
+import { IModel } from "../../hub-types";
+/**
+ * Removes the `catalog` property from upgraded site models. We use site.data.useCatalogV2
+ * (a temporary property) to determine if the upgrade has been completed.
+ *
+ * We need this temporary migration because earlier versions of the site schema upgrade
+ * force data.catalog to be present, even if the site is using catalogV2.
+ *
+ * TODO: Remove this function once we force all sites to use catalogV2.
+ * @param model
+ * @returns
+ */
+export declare function removeCatalogFromUpgradedSite(model: IModel): IModel;

package/dist/types/sites/_internal/removeCatalogV1FromUpgradedSite.d.ts

@@ -0,0 +1,13 @@
+import { IModel } from "../../hub-types";
+/**
+ * Removes the `catalog` property from upgraded site models. We use site.data.useCatalogV2
+ * (a temporary property) to determine if the upgrade has been completed.
+ *
+ * We need this temporary migration because earlier versions of the site schema upgrade
+ * force data.catalog to be present, even if the site is using catalogV2.
+ *
+ * TODO: Remove this function once we force all sites to use catalogV2.
+ * @param model
+ * @returns
+ */
+export declare function removeCatalogV1FromUpgradedSite(model: IModel): IModel;

package/dist/types/sites/_internal/siteEditorTypes.d.ts

@@ -0,0 +1,2 @@
+export declare type SiteEditorType = (typeof SiteEditorTypes)[number];
+export declare const SiteEditorTypes: readonly ["hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:settings", "hub:site:assistant", "hub:site:settings:discussions"];

package/dist/types/templates/_internal/templateEditorTypes.d.ts

@@ -0,0 +1,2 @@
+export declare type TemplateEditorType = (typeof TemplateEditorTypes)[number];
+export declare const TemplateEditorTypes: readonly ["hub:template:edit"];

package/dist/types/urls/feature-service-urls.d.ts

@@ -0,0 +1,13 @@
+/**
+ *
+ * @param url
+ * @returns true if the url is of a map or feature service
+ */
+export declare const isMapOrFeatureServerUrl: (url: string) => boolean;
+/**
+ * parses map or feature service type from URL
+ * @param url map or feature service URL
+ * @returns item type, either "Map Service" or "Feature Service"
+ * or undefined for other types of URLs
+ */
+export declare const getServiceTypeFromUrl: (url: string) => string;

package/dist/types/users/_internal/userEditorTypes.d.ts

@@ -0,0 +1,2 @@
+export declare type UserEditorType = (typeof UserEditorTypes)[number];
+export declare const UserEditorTypes: readonly ["hub:user:settings"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "20.5.1",
+  "version": "20.5.2",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",