@esri/hub-common 9.48.0 → 10.0.0-next.2

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

@@ -1,87 +0,0 @@
-import { ICollection } from "./ICollection";
-import { IFacet } from "./IFacet";
-import { Filter, FilterType, IFilterGroup, 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",
- *   filters: [
- *    {
- *     fitlerType: "item",
- *      operation: "AND",
- *      fitlers
- *     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;
-    /**
-     * Scope is a set of FilterGroups which define the limits of the Catalog.
-     * Typically it is just a set of group ids, but it may be arbitrarily complex.
-     * If one was to "search a catalog", this is the description of what would be returned.
-     */
-    scope?: Array<IFilterGroup<FilterType>>;
-    /**
-     * Filter defines the "scope" of the Catalog, typically a set of groups or orgids
-     * DEPRECATED: Use `scope`
-     */
-    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

@@ -1,28 +0,0 @@
-import { IFacet } from "./IFacet";
-import { Filter, FilterType, IFilterGroup, 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;
-    /**
-     * Filter Type used in this collection
-     */
-    filterType?: FilterType;
-    /**
-     * Scope is a set of FilterGroups which define the limits of the Collection.
-     * Typically it is just a set of group ids, but it may be arbitrarily complex.
-     * If one was to "search the collection", this is the description of what would be returned.
-     */
-    scope?: Array<IFilterGroup<FilterType>>;
-    /**
-     * Specify the includes to be requested when working with this collection
-     */
-    include?: string[];
-    sortOption: ISortOption;
-    facets?: IFacet[];
-    filter?: Filter<FilterType>;
-    defaultQuery?: string;
-}

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

@@ -1,62 +0,0 @@
-import { IFacetOption } from "./IFacetOption";
-/**
- * Definition of a Facet shown in the Gallery UI.
- *
- * If a `field` is specified, the Facet will be "dynamic" in that
- * it will request aggregations for the field and use the returned
- * values to create the FacetOptions.
- *
- * `Facet` contains and array if `FacetOptions`. When selected
- * in the UI, a FilterGroup is constructed from the `Facet.operation`
- * and the `Filters` are from the selected `FacetOptions`.
- */
-export interface IFacet {
-    /**
-     * Translated label for the facet
-     */
-    label?: string;
-    /**
-     * Unique key, used for query params and telemetry
-     */
-    key?: string;
-    /**
-     * field to generate the facet from
-     */
-    field?: string;
-    /**
-     * limit of aggregates returned. Max 200
-     */
-    aggLimit?: number;
-    /**
-     * Display for this facet. Not all facets will be compatible with all displays
-     */
-    display?: "map" | "single-select" | "multi-select" | "date-range" | "histogram";
-    /**
-     * State of the Facet
-     */
-    state?: "open" | "closed";
-    /**
-     * Individual options for this Facet
-     */
-    options?: IFacetOption[];
-    /**
-     * Operation is passed into the FilterGroup that is constructed
-     * when the Facet is serialized.
-     * Implemetations should default to "OR" if not specified
-     */
-    operation?: "OR" | "AND";
-    /**
-     * Number of facet options to show by default. Only applies to `multi-select`, and defaults to all.
-     */
-    optionLimit?: number;
-    /**
-     * Specifies how to order the facet options. Only applies to `multi-select`, and defaults to count.
-     * - count: orders by `option.count` in descending order of frequency
-     * - label: orders by `option.label` in ascending alphabetical order
-     */
-    orderBy?: "count" | "label";
-    accordionClosed?: boolean;
-    type?: "single-select" | "multi-select" | "date-range" | "histogram";
-    pageSize?: number;
-    aggField?: string;
-}

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

@@ -1,30 +0,0 @@
-import { Filter, FilterType } from "./types";
-/**
- * Facet Option shown in the UI as either a radio button or checkbox
- */
-export interface IFacetOption {
-    /**
-     * Translated label for the option
-     */
-    label: string;
-    /**
-     * Unique key, used for query params and telemetry
-     */
-    key: string;
-    /**
-     * For aggregate based Facets, the count of entries in the index with this value
-     */
-    count?: number;
-    /**
-     * Is this option selected when the UI loads
-     */
-    selected: boolean;
-    /**
-     * Filters to be applied when this option is selected
-     */
-    filters?: Array<Filter<FilterType>>;
-    /**
-     * DEPRECATED: Filter to be applied when this option is selected
-     */
-    filter?: Filter<FilterType>;
-}

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

@@ -1,16 +0,0 @@
-import { Filter, IFilterGroup, FilterType } from "./types";
-import { IHubSearchOptions } from "./IHubSearchOptions";
-/**
- * Structure for making Hub API Search Requests
- */
-export interface IHubApiSearchRequest {
-    /**
-     * Can be a string like `term:"water"`, a single filter like `{ filterType: "item", term: "water" }`
-     * or an array of IFilterGroups, which allows for complex queries.
-     */
-    q: string | Filter<FilterType> | Array<IFilterGroup<FilterType>>;
-    /**
-     * Search options like the number of results to return, sorting, aggregations etc
-     */
-    options: IHubSearchOptions;
-}

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

@@ -1,35 +0,0 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { Filter, IUserFilterDefinition } from "..";
-/**
- *
- * Merge `Filter<"user">` objects
- *
- * Useful in components which may get partial filters from a variety of
- * sub-components, which are then combined into a single filter prior
- * to executing the search.
- * @param filters
- * @returns
- */
-export declare function mergeUserFilters(filters: Array<Filter<"user">>): Filter<"user">;
-/**
- * Prior to serialization into the query syntax for the backing APIs, we first expand [Filters](../Filter)
- *
- * Filter's can express their intent in a very terse form, but to ensure consistent structures
- * we expand them into their more verbose form.
- *
- * i.e. `firstname: "John"` expands into `firstname: { any: ["John"]}`
- *
- * - Fields defined as `string | string[] | MatchOptions` will be converted to a `MatchOptions`
- * - RelativeDate fields are converted to DateRange<number>
- * @param filter
- * @returns
- */
-export declare function expandUserFilter(filter: Filter<"user">): IUserFilterDefinition;
-/**
- * @private
- * Serialize an `IUserFilterDefinition` into an `ISearchOptions` for use
- * with `searchUsers`
- * @param filter
- * @returns
- */
-export declare function serializeUserFilterForPortal(filter: IUserFilterDefinition): ISearchOptions;