@esri/hub-common 9.43.2 → 9.44.1

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

@@ -0,0 +1,11 @@
+/**
+ * Structure for Search Aggregations in ArcGIS Hub
+ */
+export interface IHubAggregation {
+    mode: string;
+    field: string;
+    values: Array<{
+        value: any;
+        count: number;
+    }>;
+}

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/IHubSearchResponse.d.ts

@@ -1,4 +1,5 @@
 import { IFacet } from "./IFacet";
+import { IHubAggregation } from "./IHubAggregation";
 /**
  * Defines a generic search response interface with parameterized result type
  * for different types of searches
@@ -13,5 +14,6 @@ export interface IHubSearchResponse<T> {
     results: T[];
     hasNext: boolean;
     next: (params?: any) => Promise<IHubSearchResponse<T>>;
+    aggregations?: IHubAggregation[];
     facets?: IFacet[];
 }

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

@@ -2,8 +2,10 @@ export * from "./ICatalog";
 export * from "./ICollection";
 export * from "./IFacet";
 export * from "./IFacetOption";
+export * from "./IHubAggregation";
 export * from "./IHubApiSearchRequest";
 export * from "./IHubSearchOptions";
 export * from "./IHubSearchResult";
 export * from "./IHubSearchResponse";
 export * from "./types";
+export * from "./IHubCatalog";