@esri/hub-common 9.31.2 → 9.32.1

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

@@ -0,0 +1,60 @@
+import { HubFamily, IHubGeography } from "../..";
+import { AccessLevel, IHubEntityBase } from "../../core";
+/**
+ * Standardized light-weight search result structure, applicable to all
+ * types of search results - users, groups, content, events etc
+ */
+export interface IHubSearchResult extends IHubEntityBase {
+    /**
+     * Access level of the backing entity
+     */
+    access: AccessLevel;
+    /**
+     * Hub Family
+     */
+    family: HubFamily;
+    /**
+     * Owner; Applies to Items and Groups
+     */
+    owner?: string;
+    /**
+     * 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;
+    /**
+     * Hash of pre-computed urls
+     */
+    urls: {
+        /**
+         * Canononical ArcGIS Online Url for this entity (if applicable)
+         */
+        portalHome?: string;
+        /**
+         * 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
+         * system so the full url can be computed
+         */
+        relative: string;
+        /**
+         * Allow for arbitrary other urls, including `.customUrl` which
+         * can ben generated client-side in the gallery via a callback
+         */
+        [key: string]: string;
+    };
+    /**
+     * Geometry connected to this entity
+     * For items, it will default to the extent,
+     * but may be derived from a boundary resource
+     * or the extent of a layer
+     */
+    geometry?: IHubGeography;
+    /**
+     * Optional metadata hash
+     * Any specified enrichments will be attached in here, as well
+     * as tags, typekeywords and culture
+     */
+    metadata?: Record<string, any>;
+}

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

@@ -2,4 +2,7 @@ export * from "./ICatalog";
 export * from "./ICollection";
 export * from "./IFacet";
 export * from "./IFacetOption";
+export * from "./IHubApiSearchRequest";
+export * from "./IHubSearchOptions";
+export * from "./IHubSearchResult";
 export * from "./types";

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

@@ -1,5 +1,5 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { IHubContent, IModel } from "../..";
+import { IHubContent, AccessLevel } from "../..";
 import { IFacet } from "./IFacet";
 /**
  * Generic filter used with various search functions.
@@ -24,12 +24,20 @@ import { IFacet } from "./IFacet";
 export declare type Filter<T extends FilterType> = IFilterTypeMap[T] & {
     filterType: T;
 };
+/**
+ * Groups of filters with an operation specifying how the
+ * filters should be connected when serialized
+ */
+export interface IFilterGroup<T extends FilterType> {
+    operation?: "AND" | "OR";
+    filters: Array<Filter<T>>;
+}
 /**
  * Defines the valid FilterTypes for use with `Filter<T extends FilterType>`
  * See [Filter](../Filter)
  */
 export interface IFilterTypeMap {
-    any: IAnyFilterDefinition;
+    item: IItemFilter;
     content: IContentFilterDefinition;
     user: IUserFilterDefinition;
     group: IGroupFilterDefinition;
@@ -40,17 +48,22 @@ export declare type FilterType = keyof IFilterTypeMap;
  * Common set of fields that are reasonable to apply at the
  * top level of a Catalog
  */
-export interface IAnyFilterDefinition {
-    title?: string | string[] | IMatchOptions;
-    access?: string | string[] | IMatchOptions;
+export interface IItemFilter {
+    access?: AccessLevel | AccessLevel[] | IMatchOptions;
     owner?: string | string[] | IMatchOptions;
     tags?: string | string[] | IMatchOptions;
     created?: IDateRange<number> | IRelativeDate;
-    modified?: IDateRange<number> | IRelativeDate;
     description?: string | string[] | IMatchOptions;
+    snippet?: string | string[] | IMatchOptions;
     group?: string | string[] | IMatchOptions;
+    id?: string | string[] | IMatchOptions;
+    modified?: IDateRange<number> | IRelativeDate;
     orgid?: string | string[] | IMatchOptions;
-    type?: string | NamedContentFilter | Array<string | NamedContentFilter> | IMatchOptions;
+    term?: string;
+    title?: string | string[] | IMatchOptions;
+    type?: string | string[] | IMatchOptions;
+    typekeywords?: string | string[] | IMatchOptions;
+    [key: string]: any;
 }
 /**
  * Fields related to Content based searches
@@ -194,24 +207,6 @@ export interface IMatchOptions {
      */
     exact?: string | string[];
 }
-/**
- * Search Options
- */
-export interface IHubSearchOptions {
-    site?: IModel;
-    authentication?: UserSession;
-    sortField?: string;
-    sortOrder?: "desc" | "asc";
-    page?: string;
-    start?: number;
-    num?: number;
-    aggFields?: string[];
-    aggLimit?: number;
-    bbox?: string;
-    fields?: string;
-    api?: NamedApis | IApiDefinition;
-    aggregations?: string[];
-}
 /**
  * searchContent return
  */

package/dist/types/types.d.ts

@@ -134,7 +134,7 @@ export declare type IRevertableTaskResult = IRevertableTaskSuccess | IRevertable
  * DEPRECATED: Use HubFamily instead
  */
 export declare type HubType = "member" | "team" | "event" | "dataset" | "document" | "map" | "app" | "site" | "initiative" | "template" | "organization";
-export declare type HubFamily = "people" | "team" | "event" | "dataset" | "document" | "feedback" | "map" | "app" | "site" | "initiative" | "template" | "content";
+export declare type HubFamily = "app" | "content" | "dataset" | "document" | "event" | "feedback" | "initiative" | "map" | "people" | "site" | "team" | "template";
 /**
  * Visibility levels of a Hub resource
  */

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.31.1 - Thu May 12 2022 18:43:36 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.32.0 - Wed May 18 2022 18:25:39 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6885,7 +6885,7 @@
      */
     var isDataSourceOfItem = function (resource, item) {
         var serviceUrl = item.url && parseServiceUrl(item.url);
-        return serviceUrl && resource.linkage.includes(serviceUrl);
+        return (serviceUrl && resource.linkage && resource.linkage.includes(serviceUrl));
     };
     /**
      * Returns the url for an additional resource.