@esri/hub-common 9.45.2 → 9.45.3

package/dist/node/search/hubSearch.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hubSearchQuery = exports.hubSearch = void 0;
+exports.hubSearch = exports.hubSearchQuery = void 0;
 const HubError_1 = require("../HubError");
 const objects_1 = require("../objects");
 const util_1 = require("../util");
 const utils_1 = require("./utils");
 const _internal_1 = require("./_internal");
-const portalSearchUsers_1 = require("./_internal/portalSearchUsers");
 /**
- * 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.
@@ -16,42 +18,11 @@ const portalSearchUsers_1 = require("./_internal/portalSearchUsers");
  * @param options
  * @returns
  */
-async function hubSearch(filterGroups, options) {
-    // Validate inputs
-    if (!filterGroups || !Array.isArray(filterGroups)) {
-        throw new HubError_1.default("hubSearch", "FilterGroups are required and must be an array.");
-    }
-    if (!filterGroups.length) {
-        throw new HubError_1.default("hubSearch", "FilterGrous array must contain at least one entry.");
-    }
-    if (!options.requestOptions) {
-        throw new HubError_1.default("hubSearch", "requestOptions: IHubRequestOptions is required.");
-    }
-    // Ensure includes is an array
-    if (!options.include) {
-        options.include = [];
-    }
-    // Get the type of the first filterGroup
-    const filterType = filterGroups[0].filterType;
-    // get the API
-    const apiType = utils_1.expandApi(options.api || "arcgis").type;
-    const fnHash = {
-        arcgis: {
-            item: _internal_1.portalSearchItemsFilterGroups,
-            group: _internal_1.portalSearchGroupsFilterGroups,
-            user: portalSearchUsers_1.portalSearchUsersFilterGroups,
-        },
-        "arcgis-hub": {
-            item: _internal_1.hubSearchItems,
-        },
-    };
-    const fn = objects_1.getProp(fnHash, `${apiType}.${filterType}`);
-    if (!fn) {
-        throw new HubError_1.default(`hubSearch`, `Search via "${filterType}" filter against "${apiType}" api is not implemented`);
-    }
-    return fn(util_1.cloneObject(filterGroups), options);
+async function hubSearchQuery(query, options) {
+    // delegate
+    return hubSearch(query, options);
 }
-exports.hubSearch = hubSearch;
+exports.hubSearchQuery = hubSearchQuery;
 /**
  * Main entrypoint for searching via Hub
  *
@@ -61,7 +32,7 @@ exports.hubSearch = hubSearch;
  * @param options
  * @returns
  */
-async function hubSearchQuery(query, options) {
+async function hubSearch(query, options) {
     // Validate inputs
     if (!query) {
         throw new HubError_1.default("hubSearch", "Query is required.");
@@ -84,7 +55,7 @@ async function hubSearchQuery(query, options) {
         arcgis: {
             item: _internal_1.portalSearchItems,
             group: _internal_1.portalSearchGroups,
-            user: portalSearchUsers_1.portalSearchUsers,
+            user: _internal_1.portalSearchUsers,
         },
         "arcgis-hub": {
             item: _internal_1.hubSearchItems,
@@ -96,5 +67,5 @@ async function hubSearchQuery(query, options) {
     }
     return fn(util_1.cloneObject(query), options);
 }
-exports.hubSearchQuery = hubSearchQuery;
+exports.hubSearch = hubSearch;
 //# sourceMappingURL=hubSearch.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"hubSearch.js","sourceRoot":"","sources":["../../../src/search/hubSearch.ts"],"names":[],"mappings":";;;AAAA,0CAAmC;AACnC,wCAAqC;AACrC,kCAAsC;AAUtC,mCAAoC;AACpC,2CAMqB;AACrB,qEAGuC;AAEvC;;;;;;;;GAQG;AACI,KAAK,UAAU,SAAS,CAC7B,YAA6C,EAC7C,OAA0B;IAE1B,kBAAkB;IAClB,IAAI,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACjD,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,iDAAiD,CAClD,CAAC;KACH;IACD,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QACxB,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,oDAAoD,CACrD,CAAC;KACH;IAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC3B,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,iDAAiD,CAClD,CAAC;KACH;IAED,8BAA8B;IAC9B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QACpB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;KACtB;IAED,wCAAwC;IACxC,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;IAC5D,cAAc;IACd,MAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAC,IAAI,CAAC;IAExD,MAAM,MAAM,GAAG;QACb,MAAM,EAAE;YACN,IAAI,EAAE,yCAA6B;YACnC,KAAK,EAAE,0CAA8B;YACrC,IAAI,EAAE,iDAA6B;SACpC;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,0BAAc;SACrB;KACF,CAAC;IAEF,MAAM,EAAE,GAAG,iBAAO,CAAC,MAAM,EAAE,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,EAAE;QACP,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,eAAe,UAAU,qBAAqB,OAAO,0BAA0B,CAChF,CAAC;KACH;IACD,OAAO,EAAE,CAAC,kBAAW,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAtDD,8BAsDC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,OAA0B;IAE1B,kBAAkB;IAClB,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,kBAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;KACvD;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;QAC3C,MAAM,IAAI,kBAAQ,CAAC,WAAW,EAAE,yCAAyC,CAAC,CAAC;KAC5E;IAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC3B,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,iDAAiD,CAClD,CAAC;KACH;IAED,8BAA8B;IAC9B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QACpB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;KACtB;IAED,wCAAwC;IACxC,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC;IACtC,cAAc;IACd,MAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAC,IAAI,CAAC;IAExD,MAAM,MAAM,GAAG;QACb,MAAM,EAAE;YACN,IAAI,EAAE,6BAAiB;YACvB,KAAK,EAAE,8BAAkB;YACzB,IAAI,EAAE,qCAAiB;SACxB;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,0BAAc;SACrB;KACF,CAAC;IAEF,MAAM,EAAE,GAAG,iBAAO,CAAC,MAAM,EAAE,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,EAAE;QACP,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,eAAe,UAAU,qBAAqB,OAAO,0BAA0B,CAChF,CAAC;KACH;IACD,OAAO,EAAE,CAAC,kBAAW,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AAhDD,wCAgDC"}
+{"version":3,"file":"hubSearch.js","sourceRoot":"","sources":["../../../src/search/hubSearch.ts"],"names":[],"mappings":";;;AAAA,0CAAmC;AACnC,wCAAqC;AACrC,kCAAsC;AAQtC,mCAAoC;AACpC,2CAKqB;AAErB;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,OAA0B;IAE1B,WAAW;IACX,OAAO,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC;AAND,wCAMC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,SAAS,CAC7B,KAAa,EACb,OAA0B;IAE1B,kBAAkB;IAClB,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,kBAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;KACvD;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;QAC3C,MAAM,IAAI,kBAAQ,CAAC,WAAW,EAAE,yCAAyC,CAAC,CAAC;KAC5E;IAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC3B,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,iDAAiD,CAClD,CAAC;KACH;IAED,8BAA8B;IAC9B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QACpB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;KACtB;IAED,wCAAwC;IACxC,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC;IACtC,cAAc;IACd,MAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,GAAG,IAAI,QAAQ,CAAC,CAAC,IAAI,CAAC;IAExD,MAAM,MAAM,GAAG;QACb,MAAM,EAAE;YACN,IAAI,EAAE,6BAAiB;YACvB,KAAK,EAAE,8BAAkB;YACzB,IAAI,EAAE,6BAAiB;SACxB;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,0BAAc;SACrB;KACF,CAAC;IAEF,MAAM,EAAE,GAAG,iBAAO,CAAC,MAAM,EAAE,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,EAAE;QACP,MAAM,IAAI,kBAAQ,CAChB,WAAW,EACX,eAAe,UAAU,qBAAqB,OAAO,0BAA0B,CAChF,CAAC;KACH;IACD,OAAO,EAAE,CAAC,kBAAW,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AAhDD,8BAgDC"}

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/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/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;
 }