@esri/hub-common 9.45.4 → 9.46.0

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

@@ -1,6 +1,7 @@
 import { Filter, IHubSearchOptions } from "./types";
 import { IHubContent, ISearchResponse } from "..";
 /**
+ * @private
  * Search for content via the Portal or Hub API
  * @param filter
  * @param options

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

@@ -6,6 +6,7 @@ export interface IGroupSearchResult {
     facets: IFacet[];
 }
 /**
+ * @private
  * Search Groups using Filter<"group">
  *
  * Currently just returns ISearchResult<IGroup>

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

@@ -15,6 +15,7 @@ export interface IHubUser extends IUser {
     thumbnailUrl?: string;
 }
 /**
+ * @private
  * Search for Users via the Portal API.
  *
  * **Note** Authentication is required

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

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

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

@@ -1,3 +1,8 @@
 import { ISearchOptions } from "@esri/arcgis-rest-portal";
 import { IQuery } from "./types";
+/**
+ * Serialize IQuery into ISearchOptions for ArcGIS Portal
+ * @param query
+ * @returns
+ */
 export declare function serializeQueryForPortal(query: IQuery): ISearchOptions;

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

@@ -2,8 +2,17 @@
  * Structure for Search Aggregations in ArcGIS Hub
  */
 export interface IHubAggregation {
+    /**
+     * What type of aggregation is returned
+     */
     mode: string;
+    /**
+     * Field the aggregation was creatd for
+     */
     field: string;
+    /**
+     * Array of the field values and counts
+     */
     values: Array<{
         value: any;
         count: number;

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

@@ -16,11 +16,11 @@ export interface IHubSearchOptions {
      */
     aggLimit?: number;
     /**
-     * Deprecate in favor of context
+     * Specify API to call. Defaults to ArcGIS Online Portal API
      */
     api?: NamedApis | IApiDefinition;
     /**
-     * TODO: Deprecate in requestOptions
+     * DEPRECATE in favor of requestOptions
      */
     authentication?: UserSession;
     /**
@@ -30,15 +30,16 @@ export interface IHubSearchOptions {
      * hubSearch
      */
     requestOptions?: IHubRequestOptions;
+    /**
+     * Bounding box for the search (NOT IMPLEMENTED)
+     */
     bbox?: string;
     /**
-     * Objects or fields to include
-     * e.g. `server.layers AS serverLayers`
+     * Objects or fields to include e.g. `server.layers AS serverLayers`
      */
     include?: string[];
     /**
-     * Enrichments
-     * Deprecated in favor of `include`
+     * DEPRECATED: Use `include` instead
      */
     enrichments?: Enrichments[];
     /**
@@ -46,7 +47,7 @@ export interface IHubSearchOptions {
      */
     num?: number;
     /**
-     * What page of results to return
+     * LEGACY. Use `start` and `num` instead
      */
     page?: string;
     /**
@@ -58,10 +59,19 @@ export interface IHubSearchOptions {
      */
     sortOrder?: "desc" | "asc";
     /**
-     * TODO: Determine if this is used or can be removed
+     * The result number of the first entry in the result set response. The start parameter, along with the num parameter, can be used to paginate the search results.
      */
     start?: number;
+    /**
+     * DEPRECATED
+     */
     aggregations?: string[];
+    /**
+     * DEPRECATED
+     */
     site?: IModel;
+    /**
+     * DEPRECATED
+     */
     fields?: string;
 }

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

@@ -10,10 +10,28 @@ import { IHubAggregation } from "./IHubAggregation";
  * next - invokable function for obtaining next page of results
  */
 export interface IHubSearchResponse<T> {
+    /**
+     * Total number of matches for the query
+     */
     total: number;
+    /**
+     * Array if results
+     */
     results: T[];
+    /**
+     * Can more results be fetched?
+     */
     hasNext: boolean;
+    /**
+     * Function that fetches the next page of results
+     */
     next: (params?: any) => Promise<IHubSearchResponse<T>>;
+    /**
+     * Array of requested aggregations
+     */
     aggregations?: IHubAggregation[];
+    /**
+     * DEPRECATED - hub.js no longer computes facets; consumers need to construct them from aggregations
+     */
     facets?: IFacet[];
 }

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

@@ -2,7 +2,7 @@ import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { IArcGISContext } from "../ArcGISContext";
 import { IHubEntityManager, IHubItemEntityManager, IHubSite } from "../core/types";
 import { ArcGISContextManager } from "../ArcGISContextManager";
-import { Filter, IHubSearchOptions } from "../search";
+import { IHubSearchOptions, IQuery } from "../search";
 import { IHubRequestOptions, ISearchResponse } from "../types";
 import { IItem } from "@esri/arcgis-rest-types";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
@@ -84,7 +84,7 @@ export declare class HubSiteManager implements IHubEntityManager<IHubSite>, IHub
      * @param filter
      * @param opts
      */
-    search(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
+    search(query: string | IQuery, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
     /**
      * Set the thumbnail for the Site
      * @param id

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

@@ -1,5 +1,5 @@
 import { IItem } from "@esri/arcgis-rest-portal";
-import { Filter, IHubRequestOptions, IHubSearchOptions, IHubSearchResult, IHubSite, ISearchResponse } from "..";
+import { IHubRequestOptions, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IHubSite, IQuery } from "../index";
 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";
@@ -53,7 +53,7 @@ export declare function convertItemToSite(item: IItem, requestOptions: IRequestO
  * @param options
  * @returns
  */
-export declare function searchSites(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
+export declare function searchSites(query: string | IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSite>>;
 /**
  * Fetch Site specific enrichments
  * @param item