@esri/hub-common 9.43.3 → 9.44.0

package/dist/node/search/hubSearch.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hubSearch = void 0;
+exports.hubSearchQuery = exports.hubSearch = void 0;
 const HubError_1 = require("../HubError");
 const objects_1 = require("../objects");
 const util_1 = require("../util");
@@ -35,6 +35,42 @@ async function hubSearch(filterGroups, options) {
     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);
+}
+exports.hubSearch = hubSearch;
+async function hubSearchQuery(query, options) {
+    // Validate inputs
+    if (!query) {
+        throw new HubError_1.default("hubSearch", "Query is required.");
+    }
+    if (!query.filters || !query.filters.length) {
+        throw new HubError_1.default("hubSearch", "Query must contain at least one Filter.");
+    }
+    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 = query.targetEntity;
+    // get the API
+    const apiType = utils_1.expandApi(options.api || "arcgis").type;
     const fnHash = {
         arcgis: {
             item: _internal_1.portalSearchItems,
@@ -49,7 +85,7 @@ async function hubSearch(filterGroups, options) {
     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);
+    return fn(util_1.cloneObject(query), options);
 }
-exports.hubSearch = hubSearch;
+exports.hubSearchQuery = hubSearchQuery;
 //# 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;AAStC,mCAAoC;AACpC,2CAIqB;AACrB,qEAAkE;AAElE;;;;;;;;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,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,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAtDD,8BAsDC"}
+{"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;AAEM,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"}

package/dist/node/search/types/IHubCatalog.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IHubCatalog.js.map

package/dist/node/search/types/IHubCatalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubCatalog.js","sourceRoot":"","sources":["../../../../src/search/types/IHubCatalog.ts"],"names":[],"mappings":""}

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

@@ -10,4 +10,5 @@ tslib_1.__exportStar(require("./IHubSearchOptions"), exports);
 tslib_1.__exportStar(require("./IHubSearchResult"), exports);
 tslib_1.__exportStar(require("./IHubSearchResponse"), exports);
 tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./IHubCatalog"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,wDAA8B;AAC9B,mDAAyB;AACzB,yDAA+B;AAC/B,iEAAuC;AACvC,8DAAoC;AACpC,6DAAmC;AACnC,+DAAqC;AACrC,kDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,wDAA8B;AAC9B,mDAAyB;AACzB,yDAA+B;AAC/B,iEAAuC;AACvC,8DAAoC;AACpC,6DAAmC;AACnC,+DAAqC;AACrC,kDAAwB;AACxB,wDAA8B"}

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

@@ -0,0 +1,18 @@
+import { IArcGISContext } from "..";
+import { IHubCollection, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "./types";
+/**
+ * Implements Collection behavior
+ */
+export declare class Collection implements IHubCollection {
+    private _context;
+    private _collection;
+    private constructor();
+    static create(collection: IHubCollection, context?: IArcGISContext): Promise<Collection>;
+    get label(): string;
+    get key(): string;
+    get include(): string[];
+    get scope(): IQuery;
+    get sortField(): string;
+    get sortDirection(): "asc" | "desc";
+    search(query: string | IQuery, options?: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+}

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

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

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

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

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

@@ -1,12 +1,20 @@
-import { Filter, IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult } from "../types";
+import { Filter, IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IMatchOptions, IQuery } from "../types";
 /**
  * @private
- * Portal Search Implementation for Items
+ * DEPRECATED
  * @param filterGroups
  * @param options
  * @returns
  */
-export declare function portalSearchItems(filterGroups: Array<IFilterGroup<"item">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function portalSearchItemsFilterGroups(filterGroups: Array<IFilterGroup<"item">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+/**
+ * @private
+ * Portal Search Implementation for Items
+ * @param query
+ * @param options
+ * @returns
+ */
+export declare function portalSearchItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
 interface IWellKnownItemFilters {
     $application: Array<Filter<"item">>;
     $feedback: Array<Filter<"item">>;
@@ -39,5 +47,21 @@ export declare const WellKnownItemFilters: IWellKnownItemFilters;
  * Only exported to enable extensive testing
  * @param filterGroups
  */
-export declare function applyWellKnownItemFilters(filterGroups: Array<IFilterGroup<"item">>): Array<IFilterGroup<"item">>;
+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"
+ *
+ * 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;
 export {};

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

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

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

@@ -1,4 +1,4 @@
-import { IFilterGroup, FilterType, IHubSearchOptions, IHubSearchResponse, IHubSearchResult } from "./types";
+import { IFilterGroup, FilterType, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "./types";
 /**
  * Main Search function for ArcGIS Hub
  *
@@ -9,3 +9,4 @@ import { IFilterGroup, FilterType, IHubSearchOptions, IHubSearchResponse, IHubSe
  * @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>>;

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

@@ -0,0 +1,71 @@
+export interface IHubCatalog {
+    /**
+     * Title for the Gallery
+     */
+    title?: string;
+    /**
+     * Filter defines the "scopes" of the Catalog, on a per entity type basis
+     */
+    scopes?: ICatalogScope;
+    /**
+     * Collections within the Catalog
+     */
+    collections?: IHubCollection[];
+}
+export interface ICatalogScope extends Record<EntityType, IQuery> {
+}
+export interface IHubCollection {
+    /**
+     * String to show in the UI. translated.
+     */
+    label: string;
+    /**
+     * Unique key, used for query params and telemetry
+     */
+    key: string;
+    /**
+     * Specify the includes to be requested when working with this collection
+     */
+    include?: string[];
+    /**
+     * Default query for the Collection
+     */
+    scope: IQuery;
+    /**
+     * Default sort field for the Collection
+     */
+    sortField?: string;
+    /**
+     * Default sort direction for the Collection
+     */
+    sortDirection?: "asc" | "desc";
+}
+export declare type EntityType = "item" | "group" | "user" | "groupMember" | "event";
+export interface IQuery {
+    /**
+     * What entity is this query targeting. This is used internally to
+     * ensure we query the correct API
+     */
+    targetEntity: EntityType;
+    /**
+     * Filters that make up the query
+     */
+    filters: IFilter[];
+    /**
+     * Additional properties. Useful for groupMember queries
+     * where we need to send in the groupId to construct the url
+     */
+    properties?: Record<string, any>;
+}
+export interface IFilter {
+    /**
+     * Operation used to combine the predicates
+     */
+    operation?: "AND" | "OR";
+    /**
+     * Predicates
+     */
+    predicates: IPredicate[];
+}
+export interface IPredicate extends Record<string, any> {
+}

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

@@ -7,3 +7,4 @@ export * from "./IHubSearchOptions";
 export * from "./IHubSearchResult";
 export * from "./IHubSearchResponse";
 export * from "./types";
+export * from "./IHubCatalog";