@esri/hub-common 9.37.0 → 9.40.0

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

@@ -1,5 +1,18 @@
 import { HubFamily, IHubGeography } from "../..";
 import { AccessLevel, IHubEntityBase } from "../../core";
+/**
+ * Simple interface for Links
+ */
+export interface ILink {
+    /**
+     * Link url
+     */
+    href: string;
+    /**
+     * Additional optional properties
+     */
+    [key: string]: string;
+}
 /**
  * Standardized light-weight search result structure, applicable to all
  * types of search results - users, groups, content, events etc
@@ -18,20 +31,24 @@ export interface IHubSearchResult extends IHubEntityBase {
      */
     owner?: string;
     /**
+     * DEPRECATED use links.thumbnail
      * Fully qualified thumbnail url for items, groups, users
      * Will not have the token appended. Consuming app needs to
      * check the value of `access` and apply the token as needed
      */
-    thumbnailUrl: string;
+    thumbnailUrl?: string;
     /**
+     * DEPRECATED - use links
      * Hash of pre-computed urls
      */
-    urls: {
+    urls?: {
         /**
+         * DEPRECATED - use links
          * Canononical ArcGIS Online Url for this entity (if applicable)
          */
         portalHome?: string;
         /**
+         * DEPRECATED - use links
          * Relative url, which can be appended to a Site's root Url
          * e.g. /datasets/3ef8c7a, or /events/june-meeting
          * This is much easier than passing a Site into the search
@@ -39,11 +56,35 @@ export interface IHubSearchResult extends IHubEntityBase {
          */
         relative: string;
         /**
+         * DEPRECATED - use links
          * Allow for arbitrary other urls, including `.customUrl` which
          * can ben generated client-side in the gallery via a callback
          */
         [key: string]: string;
     };
+    /**
+     * Links to related things
+     */
+    links?: {
+        /**
+         * Url to Thumbnail. Will not include a token
+         */
+        thumbnail?: string;
+        /**
+         * Url to the entities canonical "self"
+         * For Items/Groups/Users, this will be the Home App url
+         * For other entities, it will be the canonical url
+         */
+        self: string;
+        /**
+         * Relative url of the entity, within a site
+         */
+        siteRelative: string;
+        /**
+         * Additional urls
+         */
+        [key: string]: string | ILink;
+    };
     /**
      * Geometry connected to this entity
      * For items, it will default to the extent,
@@ -52,9 +93,12 @@ export interface IHubSearchResult extends IHubEntityBase {
      */
     geometry?: IHubGeography;
     /**
+     * DEPRECATED - includes/enrichments are directly attached
      * Optional metadata hash
      * Any specified enrichments will be attached in here, as well
      * as tags, typekeywords and culture
      */
     metadata?: Record<string, any>;
+    /** Allow any additional properties to be added */
+    [key: string]: any;
 }

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

@@ -6,8 +6,7 @@ import { IFacet } from "./IFacet";
  *
  * `Filter<T extends FilterType>` [FilterType](../FilterType) is constrained to
  *
- * - `Filter<"any">` [IAnyFilterDefinition](../IAnyFilterDefinition)
- * - `Filter<"content">` [IContentFilterDefinition](../IContentFilterDefinition)
+ * - `Filter<"item">` [IContentFilterDefinition](../IContentFilterDefinition)
  * - `Filter<"user">` [IUserFilterDefinition](../IUserFilterDefinition)
  * - `Filter<"group">` [IGroupFilterDefinition](../IGroupFilterDefinition)
  *
@@ -15,8 +14,8 @@ import { IFacet } from "./IFacet";
  * and it must be `keyof` [FilterTypeMap](../FilterTypeMap)
  *
  * ```ts
- * const f:Filter<"content"> = {
- *   filterType: "content" // must match the FilterType
+ * const f:Filter<"item"> = {
+ *   filterType: "item" // must match the FilterType
  *   term: "water"
  * }
  * ```
@@ -24,15 +23,12 @@ import { IFacet } from "./IFacet";
 export declare type Filter<T extends FilterType> = IFilterTypeMap[T] & {
     filterType: T;
 };
-export interface IFilterGroup<T extends FilterType> {
-    operation?: "AND" | "OR";
-    filters: Array<Filter<T>>;
-}
 /**
  * Groups of filters with an operation specifying how the
  * filters should be connected when serialized
  */
 export interface IFilterGroup<T extends FilterType> {
+    filterType: T;
     operation?: "AND" | "OR";
     filters: Array<Filter<T>>;
 }
@@ -42,23 +38,21 @@ export interface IFilterGroup<T extends FilterType> {
  */
 export interface IFilterTypeMap {
     item: IItemFilter;
+    user: IUserFilterDefinition;
+    group: IGroupFilterDefinition;
+    event: IEventFilterDefinition;
     /**
      * DEPRECATED use item
+     * // TODO: Remove with _searchContent
      */
     content: IContentFilterDefinition;
-    user: IUserFilterDefinition;
-    group: IGroupFilterDefinition;
-    event: IEventFilterDefinition;
 }
 export declare type FilterType = keyof IFilterTypeMap;
-/**
- * Common set of fields that are reasonable to apply at the
- * top level of a Catalog
- */
 export interface IItemFilter {
     access?: AccessLevel | AccessLevel[] | IMatchOptions;
     owner?: string | string[] | IMatchOptions;
     tags?: string | string[] | IMatchOptions;
+    categories?: string | string[] | IMatchOptions;
     created?: IDateRange<number> | IRelativeDate;
     description?: string | string[] | IMatchOptions;
     snippet?: string | string[] | IMatchOptions;
@@ -74,11 +68,13 @@ export interface IItemFilter {
 }
 /**
  * Fields related to Content based searches
+ * // TODO: Remove with _searchContent
  */
 export interface IContentFilterDefinition {
     access?: string | string[] | IMatchOptions;
     owner?: string | string[] | IMatchOptions;
     tags?: string | string[] | IMatchOptions;
+    categories?: string | string[] | IMatchOptions;
     created?: IDateRange<number> | IRelativeDate;
     description?: string | string[] | IMatchOptions;
     snippet?: string | string[] | IMatchOptions;
@@ -153,6 +149,7 @@ export interface IGroupFilterDefinition {
     term?: string;
     title?: string | string[] | IMatchOptions;
     typekeywords?: string | string[] | IMatchOptions;
+    isopendata?: boolean;
 }
 export interface IEventFilterDefinition {
     created?: IDateRange<number> | IRelativeDate;
@@ -216,6 +213,7 @@ export interface IMatchOptions {
 }
 /**
  * searchContent return
+ * // TODO: Remove with _searchContent
  */
 export interface IContentSearchResult {
     total: number;

package/dist/types/sites/HubSites.d.ts

@@ -1,5 +1,5 @@
 import { IItem } from "@esri/arcgis-rest-portal";
-import { Filter, IHubRequestOptions, IHubSearchOptions, IHubSite, ISearchResponse } from "..";
+import { Filter, IHubRequestOptions, IHubSearchOptions, IHubSearchResult, IHubSite, ISearchResponse } from "..";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 export declare const HUB_SITE_ITEM_TYPE = "Hub Site Application";
 export declare const ENTERPRISE_SITE_ITEM_TYPE = "Site Application";
@@ -54,3 +54,11 @@ export declare function convertItemToSite(item: IItem, requestOptions: IRequestO
  * @returns
  */
 export declare function searchSites(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
+/**
+ * Fetch Site specific enrichments
+ * @param item
+ * @param include
+ * @param requestOptions
+ * @returns
+ */
+export declare function enrichSiteSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

package/dist/types/urls/getGroupHomeUrl.d.ts

@@ -0,0 +1,10 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../types";
+/**
+ * Return the URL of the group's page in the Portal Home application
+ * @param groupId The group's ID
+ * @param portalUrlOrObject a portal base or API URL, a portal object, or request options containing either of those
+ * @returns URL to the groups's url, defaults to `https://www.arcgis.com/home/group.html?id={group.id}`
+ */
+export declare function getGroupHomeUrl(groupId: string, portalUrlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions): string;

package/dist/types/urls/index.d.ts

@@ -15,6 +15,7 @@ export * from "./get-item-data-url";
 export * from "./convert-urls-to-anchor-tags";
 export * from "./getHubApiFromPortalUrl";
 export * from "./getPortalBaseFromOrgUrl";
+export * from "./getGroupHomeUrl";
 /**
  *
  * @param url