@esri/hub-common 9.45.2 → 9.45.5

package/dist/node/search/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,0DAAgC;AAChC,wDAA8B;AAC9B,uDAA6B;AAC7B,kDAAwB;AACxB,2DAAiC;AACjC,0DAAgC;AAChC,yDAA+B;AAC/B,kDAAwB;AACxB,4DAAkC;AAClC,2DAAiC;AACjC,yDAA+B;AAC/B,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,0DAAgC;AAChC,wDAA8B;AAC9B,uDAA6B;AAC7B,kDAAwB;AACxB,2DAAiC;AACjC,0DAAgC;AAChC,yDAA+B;AAC/B,kDAAwB;AACxB,4DAAkC;AAClC,2DAAiC;AACjC,yDAA+B;AAC/B,0DAAgC;AAChC,sDAA4B"}

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

@@ -3,3 +3,4 @@ export * from "./state";
 export * from "./portalSearchItems";
 export * from "./hubSearchItems";
 export * from "./portalSearchGroups";
+export * from "./portalSearchUsers";

package/dist/types/search/_internal/ipredicate-utils.d.ts

@@ -0,0 +1,2 @@
+import { IPredicate } from "../types";
+export declare function expandPredicate(predicate: IPredicate): IPredicate;

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

@@ -1,13 +1,4 @@
-import { IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
-/**
- * @private
- * DEPRECATED: Use `portalSerchGroups`
- * Portal Search Implementation for Groups
- * @param filterGroups
- * @param options
- * @returns
- */
-export declare function portalSearchGroupsFilterGroups(filterGroups: Array<IFilterGroup<"group">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
 /**
  * @private
  * Portal Search Implementation for Groups

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

@@ -1,12 +1,4 @@
-import { Filter, IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IMatchOptions, IQuery } from "../types";
-/**
- * @private
- * DEPRECATED
- * @param filterGroups
- * @param options
- * @returns
- */
-export declare function portalSearchItemsFilterGroups(filterGroups: Array<IFilterGroup<"item">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+import { Filter, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IMatchOptions, IQuery } from "../types";
 /**
  * @private
  * Portal Search Implementation for Items
@@ -48,12 +40,6 @@ export declare const WellKnownItemFilters: IWellKnownItemFilters;
  * @param filterGroups
  */
 export declare function applyWellKnownItemPredicates(query: IQuery): IQuery;
-/**
- * DEPRECATED
- * @param filterGroups
- * @returns
- */
-export declare function applyWellKnownItemFilterGroups(filterGroups: Array<IFilterGroup<"item">>): Array<IFilterGroup<"item">>;
 /**
  * Is the argument a well-known type "key"
  *

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

@@ -1,12 +1,4 @@
-import { IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
-/**
- * @private
- * DEPRECATED: Use `portalSearchUsers`
- * Portal Search implementation for Users
- * @param filterGroups
- * @param options
- */
-export declare function portalSearchUsersFilterGroups(filterGroups: Array<IFilterGroup<"user">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
 /**
  * @private
  * Portal Search Implementation for Users

package/dist/types/search/filter-utils.d.ts

@@ -1,21 +1,4 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
 import { Filter, IFilterGroup, FilterType } from "./types";
-/**
- * Expand a Filter into it's more expressive structure so it can be
- * serialized deterministically.
- *
- * Props with type `string | string[] | MatchOptions` expand into `IMatchOptions`
- * Props relative-dates are expanded into formal date-ranges
- * @param filter
- * @returns
- */
-export declare function expandFilter<T>(filter: T): T;
-/**
- * Serialize a FilterGroup of any type for Portal
- * @param filterGroups
- * @returns
- */
-export declare function serializeFilterGroupsForPortal(filterGroups: Array<IFilterGroup<FilterType>>): ISearchOptions;
 /**
  * Determine if a Filter is "empty"
  * @param filter

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

@@ -1,6 +1,9 @@
-import { IFilterGroup, FilterType, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "./types";
+import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "./types";
 /**
- * Main Search function for ArcGIS Hub
+ * @private
+ * TEMPORARY - this function only exists to allow incremental
+ * changes and should be removed as soon as arcgis-hub-gallery
+ * is changed to call `hubSearch(...)` directly
  *
  * Default's to search ArcGIS Portal but can delegate
  * to Hub API when it's available.
@@ -8,7 +11,7 @@ import { IFilterGroup, FilterType, IHubSearchOptions, IHubSearchResponse, IHubSe
  * @param options
  * @returns
  */
-export declare function hubSearch(filterGroups: Array<IFilterGroup<FilterType>>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function hubSearchQuery(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
 /**
  * Main entrypoint for searching via Hub
  *
@@ -18,4 +21,4 @@ export declare function hubSearch(filterGroups: Array<IFilterGroup<FilterType>>,
  * @param options
  * @returns
  */
-export declare function hubSearchQuery(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function hubSearch(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/{_internal/ifilter-utils.d.ts → ifilter-utils.d.ts}

@@ -1,4 +1,3 @@
 import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { IPredicate, IQuery } from "../types";
-export declare function expandPredicate(predicate: IPredicate): IPredicate;
+import { IQuery } from "./types";
 export declare function serializeQueryForPortal(query: IQuery): ISearchOptions;

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

@@ -10,4 +10,5 @@ export * from "./types";
 export * from "./collectionState";
 export * from "./convertCatalog";
 export * from "./filter-utils";
+export * from "./ifilter-utils";
 export * from "./hubSearch";

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

@@ -50,6 +50,12 @@ export interface IHubCollection {
     targetEntity: EntityType;
 }
 export declare type EntityType = "item" | "group" | "user" | "groupMember" | "event";
+/**
+ * IQuery is the fundamental unit used to execute a search. By composing
+ * `Filter`'s and `IPredicate`s, we can express very complex queries
+ *
+ *  The [Hub Search Guide](/hub.js/guides/hub-search) contains many examples.
+ */
 export interface IQuery {
     /**
      * What entity is this query targeting. This is used internally to
@@ -66,15 +72,45 @@ export interface IQuery {
      */
     properties?: Record<string, any>;
 }
+/**
+ * Queries are composed from a set of `IFilter` objects.
+ * All Filters are combined via `AND`, but the predicates
+ * that make up a filter are combined using the specified `operation`
+ * thereby allowing queries to be composed dynamically and deterministically.
+ *
+ *  The [Hub Search Guide](/hub.js/guides/hub-search) contains many examples.
+ */
 export interface IFilter {
     /**
      * Operation used to combine the predicates
      */
     operation?: "AND" | "OR";
     /**
-     * Predicates
+     * Predicates which specify the properties and values to match in the search
      */
     predicates: IPredicate[];
 }
-export interface IPredicate extends Record<string, any> {
+/**
+ * An `IPredicate` is a set of key/value pairs
+ * that can be evaluated into a boolean value in a search system.
+ *
+ * For example, a predicate like
+ * ```js
+ * const p = { type: "Web Map"}
+ * ```
+ * equates to a search `where type = "Web Map"`
+ *
+ * Properties can be `string`, `string[]`, `IMatchOption`,
+ * `IDateRange<number>` or  `IRelativeDate`. Some properties are booleans
+ * and other properties have a limited set of values that can be passed.
+ *
+ * The [Hub Search Guide](/hub.js/guides/hub-search) contains a list
+ * of properties that can be sent to the ArcGIS Portal API.
+ */
+export interface IPredicate {
+    /**
+     * This is intentionally loosely typed to allow flexibility
+     * in implementation without constantly updates to this interface
+     */
+    [key: string]: any;
 }