@esri/hub-common 9.49.0 → 10.0.0-next.1

package/dist/node/search/collectionState.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeCollectionState = exports.applyCollectionState = void 0;
-const util_1 = require("../util");
-const state_1 = require("./_internal/state");
-/**
- * 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
- */
-function applyCollectionState(collection, state) {
-    const updated = util_1.cloneObject(collection);
-    // Apply default query
-    if (state.query) {
-        updated.defaultQuery = state.query;
-    }
-    // Apply Sort State
-    updated.sortOption = state_1.applySortState(updated.sortOption, state.sort);
-    // Look for state props for the facets and apply them
-    updated.facets = updated.facets.map((facet) => {
-        // see if there is a key for this facet on the state
-        if (Object.keys(state).includes(facet.key)) {
-            const facetState = {};
-            facetState[facet.key] = state[facet.key];
-            return state_1.applyFacetState(facet, facetState);
-        }
-        else {
-            // Ensure all options are not selected
-            // because they were not included in the state
-            facet.options.forEach((opt) => {
-                opt.selected = false;
-            });
-            return facet;
-        }
-    });
-    //
-    return updated;
-}
-exports.applyCollectionState = applyCollectionState;
-/**
- * Serialize the current state of a collection into a hash that
- * can be converted into a query string
- * @param collection
- * @returns
- */
-function serializeCollectionState(collection) {
-    const state = {};
-    if (collection.defaultQuery) {
-        state.query = collection.defaultQuery;
-    }
-    if (collection.sortOption) {
-        state.sort = state_1.serializeSortState(collection.sortOption);
-    }
-    const facetState = (collection.facets || []).reduce((s, facet) => {
-        return Object.assign(Object.assign({}, s), state_1.serializeFacetState(facet));
-    }, {});
-    return Object.assign(Object.assign({}, state), facetState);
-}
-exports.serializeCollectionState = serializeCollectionState;
-//# sourceMappingURL=collectionState.js.map

package/dist/node/search/collectionState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"collectionState.js","sourceRoot":"","sources":["../../../src/search/collectionState.ts"],"names":[],"mappings":";;;AACA,kCAAsC;AAEtC,6CAK2B;AAE3B;;;;;;;;;GASG;AAEH,SAAgB,oBAAoB,CAClC,UAAuB,EACvB,KAAuB;IAEvB,MAAM,OAAO,GAAG,kBAAW,CAAC,UAAU,CAAC,CAAC;IAExC,sBAAsB;IACtB,IAAI,KAAK,CAAC,KAAK,EAAE;QACf,OAAO,CAAC,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC;KACpC;IAED,mBAAmB;IACnB,OAAO,CAAC,UAAU,GAAG,sBAAc,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEpE,qDAAqD;IACrD,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5C,oDAAoD;QACpD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAC1C,MAAM,UAAU,GAAG,EAAiB,CAAC;YACrC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzC,OAAO,uBAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;SAC3C;aAAM;YACL,sCAAsC;YACtC,8CAA8C;YAC9C,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC5B,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,OAAO,KAAK,CAAC;SACd;IACH,CAAC,CAAC,CAAC;IAEH,EAAE;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAlCD,oDAkCC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CACtC,UAAuB;IAEvB,MAAM,KAAK,GAAqB,EAAE,CAAC;IAEnC,IAAI,UAAU,CAAC,YAAY,EAAE;QAC3B,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC;KACvC;IAED,IAAI,UAAU,CAAC,UAAU,EAAE;QACzB,KAAK,CAAC,IAAI,GAAG,0BAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;KACxD;IAED,MAAM,UAAU,GAAG,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;QAC/D,uCAAY,CAAC,GAAK,2BAAmB,CAAC,KAAK,CAAC,EAAG;IACjD,CAAC,EAAE,EAAiB,CAAC,CAAC;IAEtB,uCAAY,KAAK,GAAK,UAAU,EAAG;AACrC,CAAC;AAlBD,4DAkBC"}

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

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

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

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

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

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

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

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

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

@@ -1,70 +0,0 @@
-import { IFacet, IFacetState, ISortOption } from "../types";
-/**
- * @private
- * Apply the sortState to SortOptions
- *
- * @param sortOptions
- * @param sortState
- * @returns
- */
-export declare function applySortState(sortOptions: ISortOption, sortState: string): ISortOption;
-/**
- * @private
- * Apply FacetState to a Facet
- * @param facet
- * @param state
- * @returns
- */
-export declare function applyFacetState(facet: IFacet, state: IFacetState): IFacet;
-/**
- * @private
- * Apply the Facet State onto a single-select facet
- *
- * Intentionally mutates the facet.
- * @param facet
- * @param state
- * @returns
- */
-export declare function applySingleSelectFacetState(facet: IFacet, state: IFacetState): IFacet;
-/**
- * @private
- * Serialize single-select facet into IFacetState
- * @param facet
- * @returns
- */
-export declare function serializeSingleSelectFacetState(facet: IFacet): IFacetState;
-/**
- * @private
- * Apply the Facet State onto a multi-select Facet
- *
- * Intentionally mutates the facet.
- * @param facet
- * @param state
- * @returns
- */
-export declare function applyMultiSelectFacetState(facet: IFacet, state: IFacetState): IFacet;
-/**
- * @private
- * Serialize multi-select facet into IFacetState
- * @param facet
- * @returns
- */
-export declare function serializeMultiSelectFacetState(facet: IFacet): IFacetState;
-/**
- * @private
- * Serialize the state of the SortOption into a key/value pair
- *
- * Called from the Sort component
- * @param sort
- * @returns
- */
-export declare function serializeSortState(sort: ISortOption): string;
-/**
- * @private
- * Serialize the state of a facet into a key/value pair
- *
- * Called from the various facet components
- * @param facet
- * @returns
- */
-export declare function serializeFacetState(facet: IFacet): IFacetState;

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

@@ -1,19 +0,0 @@
-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/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>;
-}