@esri/hub-common 9.26.2 → 9.29.0

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

@@ -0,0 +1,19 @@
+import { ICollection, ICollectionState } from "./types";
+/**
+ * Apply ICollectionState to an ICollection
+ *
+ * Typically used in a Gallery or Catalog component to
+ * set the inital state, based on values deserialized
+ * from a query string
+ * @param collection
+ * @param state
+ * @returns
+ */
+export declare function applyCollectionState(collection: ICollection, state: ICollectionState): ICollection;
+/**
+ * Serialize the current state of a collection into a hash that
+ * can be converted into a query string
+ * @param collection
+ * @returns
+ */
+export declare function serializeCollectionState(collection: ICollection): ICollectionState;

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

@@ -1,12 +1,14 @@
-import { IGroup, IItem, ISearchOptions, ISearchResult } from "@esri/arcgis-rest-portal";
-import { IContentFilter, IContentFilterDefinition, Filter, IFacet } from "./types";
+import { IItem, ISearchOptions, ISearchResult } from "@esri/arcgis-rest-portal";
+import { IContentFilter, IContentFilterDefinition, Filter } from "./types/types";
+import { IFacet } from "./types/IFacet";
 /**
  * @private
- * Convert portal search response to items
+ * Convert portal search response to facets
+ * Note: Only applicable to a "content" search
  * @param response
  * @returns
  */
-export declare function convertPortalResponseToFacets(response: ISearchResult<IItem> | ISearchResult<IGroup>): IFacet[];
+export declare function convertPortalResponseToFacets(response: ISearchResult<IItem>, operation?: "OR" | "AND"): IFacet[];
 /**
  * Merge `Filter<"content">` objects
  *

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

@@ -0,0 +1,6 @@
+import { ICatalog } from "./types";
+/**
+ * Convert the original site catalog structure into a formal ICatalog
+ * @param original
+ */
+export declare function convertCatalog(original: any): ICatalog;

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

@@ -3,7 +3,9 @@ export * from "./content-utils";
 export * from "./group-utils";
 export * from "./user-utils";
 export * from "./utils";
-export * from "./types";
 export * from "./_searchContent";
 export * from "./_searchGroups";
 export * from "./_searchUsers";
+export * from "./types";
+export * from "./collectionState";
+export * from "./convertCatalog";

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

@@ -0,0 +1,76 @@
+import { ICollection } from "./ICollection";
+import { IFacet } from "./IFacet";
+import { Filter, FilterType, ISortOption } from "./types";
+/**
+ * Catalog is the definition which powers what options
+ * are available in a Gallery. It controls not only
+ * the scoping of the search, but also the options
+ * available to the UX.
+ *
+ * Thus the lower-level `searchContent`, `searchUser`, `searchGroup` functions
+ * do not take Catalogs, rather they accept [Filters](../Filter)
+ *
+ * ```ts
+ * const simpleCatalog:Catalog = {
+ *   title: "Select Map",
+ *   filter: {
+ *     filterType: "content",
+ *     type: "Web Map",
+ *     owner: "jsmith"
+ *   }
+ * }
+ * ```
+ *
+ * ## Collections
+ * The key feature of a Catalog is the ability to defined [Collections](../Collection).
+ * These are essentially sub-sets of content, typically organized around
+ * generalized content types, i.e. "Datasets", vs "Maps", vs "Documents"
+ *
+ *
+ * ```ts
+ * const complex:Catalog = {
+ *   filter: {
+ *    type: "content",
+ *    groups: ["3ef", "bc4"]
+ *   },
+ *   collections: [
+ *     {
+ *       label: "Documents",
+ *       filter: {
+ *         filterType: "content",
+ *         type: ["Microsoft Word", "PDF", "Microsoft Excel"]
+ *       }
+ *     },
+ *     {
+ *       label: "Datasets",
+ *       filter: {
+ *         filterType: "content",
+ *         type: ["Feature Layer", "Feature Service", "Map Service", "CSV"]
+ *       }
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export interface ICatalog {
+    /**
+     * Title for the Gallery
+     */
+    title?: string;
+    /**
+     * Filter defines the "scope" of the Catalog, typically a set of groups or orgids
+     */
+    filter: Filter<FilterType>;
+    /**
+     * Sort options to be shown in the Gallery
+     */
+    sort?: ISortOption[];
+    /**
+     * Collections within the Catalog
+     */
+    collections?: ICollection[];
+    /**
+     * Facets to use with all Collections
+     */
+    facets?: IFacet[];
+}

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

@@ -0,0 +1,14 @@
+import { IFacet } from "./IFacet";
+import { Filter, FilterType, ISortOption } from "./types";
+/**
+ * A Collection is a subset of a Catalog, but can be used independently
+ * in Galleries
+ */
+export interface ICollection {
+    label: string;
+    key: string;
+    defaultQuery?: string;
+    sortOption: ISortOption;
+    filter: Filter<FilterType>;
+    facets?: IFacet[];
+}

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

@@ -0,0 +1,15 @@
+import { IFacetOption } from "./IFacetOption";
+export interface IFacet {
+    label: string;
+    key: string;
+    aggField?: string;
+    aggLimit?: number;
+    display: "single-select" | "multi-select" | "date-range" | "histogram";
+    state?: "open" | "closed";
+    options?: IFacetOption[];
+    operation?: ("OR" | "AND")[];
+    optionLimit?: number;
+    accordionClosed?: boolean;
+    type?: "single-select" | "multi-select" | "date-range" | "histogram";
+    pageSize?: number;
+}

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

@@ -0,0 +1,8 @@
+import { Filter, FilterType } from "./types";
+export interface IFacetOption {
+    label: string;
+    key: string;
+    count?: number;
+    selected: boolean;
+    filter: Filter<FilterType>;
+}

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

@@ -0,0 +1,5 @@
+export * from "./ICatalog";
+export * from "./ICollection";
+export * from "./IFacet";
+export * from "./IFacetOption";
+export * from "./types";

package/dist/types/search/{types.d.ts → types/types.d.ts}

@@ -1,5 +1,6 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { IHubContent, IModel } from "..";
+import { IHubContent, IModel } from "../..";
+import { IFacet } from "./IFacet";
 /**
  * Generic filter used with various search functions.
  *
@@ -139,82 +140,6 @@ export interface IEventFilterDefinition {
     orgid?: string | string[] | IMatchOptions;
     title?: string | string[] | IMatchOptions;
 }
-export interface IFacet {
-    label: string;
-    attribute?: string;
-    type: "single-select" | "multi-select" | "date-range" | "histogram";
-    options?: IFacetOption[];
-    accordionClosed?: boolean;
-    pageSize?: number;
-}
-export interface IFacetOption {
-    label: string;
-    value: string;
-    count?: number;
-    selected: boolean;
-    filter: Filter<FilterType>;
-}
-/**
- * Catalog is the definition which powers what options
- * are available in a Gallery. It controls not only
- * the scoping of the search, but also the options
- * available to the UX.
- *
- * Thus the lower-level `searchContent`, `searchUser`, `searchGroup` functions
- * do not take Catalogs, rather they accept [Filters](../Filter)
- *
- * ```ts
- * const simpleCatalog:Catalog = {
- *   title: "Select Map",
- *   filter: {
- *     filterType: "content",
- *     type: "Web Map",
- *     owner: "jsmith"
- *   }
- * }
- * ```
- *
- * ## Collections
- * The key feature of a Catalog is the ability to defined [Collections](../Collection).
- * These are essentially sub-sets of content, typically organized around
- * generalized content types, i.e. "Datasets", vs "Maps", vs "Documents"
- *
- *
- * ```ts
- * const complex:Catalog = {
- *   filter: {
- *    type: "content",
- *    groups: ["3ef", "bc4"]
- *   },
- *   collections: [
- *     {
- *       label: "Documents",
- *       filter: {
- *         filterType: "content",
- *         type: ["Microsoft Word", "PDF", "Microsoft Excel"]
- *       }
- *     },
- *     {
- *       label: "Datasets",
- *       filter: {
- *         filterType: "content",
- *         type: ["Feature Layer", "Feature Service", "Map Service", "CSV"]
- *       }
- *     }
- *   ]
- * }
- * ```
- */
-export interface ICatalog {
-    /**
-     * Title for the Gallery
-     */
-    title?: string;
-    filter: Filter<FilterType>;
-    sort?: ISortOption[];
-    collections?: ICollection[];
-    facets?: IFacet[];
-}
 /**
  * Sort Option to be displayed in a UI
  */
@@ -224,14 +149,6 @@ export interface ISortOption {
     defaultOrder: string;
     order: string;
 }
-/**
- * A Filter that defines a subset of a Catalog, aka a Collection
- */
-export interface ICollection {
-    label: string;
-    filter: Filter<FilterType>;
-    facets?: IFacet[];
-}
 /**
  * Defines a span of time by specifying a `from` and `to` Date
  * as either a number or a ISO string
@@ -288,10 +205,12 @@ export interface IHubSearchOptions {
     page?: string;
     start?: number;
     num?: number;
-    aggregations?: string[];
+    aggFields?: string[];
+    aggLimit?: number;
     bbox?: string;
     fields?: string;
     api?: NamedApis | IApiDefinition;
+    aggregations?: string[];
 }
 /**
  * searchContent return
@@ -318,3 +237,21 @@ export interface IApiDefinition {
     type: "arcgis" | "arcgis-hub";
     authentication?: UserSession;
 }
+export interface IFacetState {
+    [key: string]: string;
+}
+export interface ICollectionState {
+    query?: string;
+    sort?: string;
+    [key: string]: string;
+}
+export interface ICatalogState {
+    collection: string;
+    collectionState?: ICollectionState;
+}
+/**
+ * Generic key/value type for storing component state
+ */
+export interface IComponentState {
+    [key: string]: string;
+}

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

@@ -1,7 +1,7 @@
 import { IUser } from "@esri/arcgis-rest-auth";
 import { IGroup, ISearchOptions } from "@esri/arcgis-rest-portal";
 import { ISearchResponse } from "../types";
-import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis } from "./types";
+import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis } from "./types/types";
 /**
  * Well known APIs
  * Short-forms for specifying common APIs