@esri/hub-common 9.49.1 → 10.0.0-next.3

package/dist/node/search/hub-api-search.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hubApiSearch = void 0;
-const __1 = require("..");
-/**
- * Search the Hub API
- *
- * @param requestOptions
- * @returns JSONAPI response
- */
-function hubApiSearch(requestOptions) {
-    // derive default headers if authentication
-    const authentication = requestOptions.authentication;
-    const headers = authentication &&
-        authentication.serialize && { authentication: authentication.serialize() };
-    const defaults = {
-        headers,
-        httpMethod: "POST",
-    };
-    return __1.hubApiRequest("/search", Object.assign(Object.assign({}, defaults), requestOptions));
-}
-exports.hubApiSearch = hubApiSearch;
-//# sourceMappingURL=hub-api-search.js.map

package/dist/node/search/hub-api-search.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hub-api-search.js","sourceRoot":"","sources":["../../../src/search/hub-api-search.ts"],"names":[],"mappings":";;;AAAA,0BAAwE;AACxE;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,cAAkC;IAElC,2CAA2C;IAC3C,MAAM,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC;IACrD,MAAM,OAAO,GAAG,cAAc;QAC5B,cAAc,CAAC,SAAS,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,SAAS,EAAE,EAAE,CAAC;IAC7E,MAAM,QAAQ,GAAuB;QACnC,OAAO;QACP,UAAU,EAAE,MAAM;KACnB,CAAC;IACF,OAAO,iBAAa,CAAC,SAAS,kCACzB,QAAQ,GACR,cAAc,EACjB,CAAC;AACL,CAAC;AAfD,oCAeC"}

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

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

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

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

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

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

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

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

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/node/search/types/IHubApiSearchRequest.js

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

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

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

package/dist/node/search/user-utils.js

@@ -1,145 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeUserFilterForPortal = exports.expandUserFilter = exports.mergeUserFilters = void 0;
-const __1 = require("..");
-// TODO: Remove with _searchContent
-/**
- *
- * 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
- */
-function mergeUserFilters(filters) {
-    // TODO: Remove with _searchContent
-    __1.Logger.warn(`DEPRECATION: mergeUserFilters will be removed. Work with IFilterGroups<"user"> and hubSearch() instead`);
-    // expand all the filters so all prop types are consistent
-    const expanded = filters.map(expandUserFilter);
-    // now we can merge based on fields
-    const dateFields = ["created", "modified", "lastlogin"];
-    const specialFields = ["disabled", "term", "filterType", ...dateFields];
-    // acc is initialized as Filter<group> but also needs it
-    // in the function signature... for reasons?!
-    const result = expanded.reduce((acc, entry) => {
-        // process fields
-        Object.entries(entry).forEach(([key, value]) => {
-            // Note: getProp/setProp are used to get around
-            // typescript issues with string indexing
-            if (acc.hasOwnProperty(key)) {
-                const existingValue = __1.getProp(acc, key);
-                // if the key is not to a special field
-                if (!specialFields.includes(key)) {
-                    // treat as an IMatchOptions
-                    __1.setProp(key, __1.mergeMatchOptions(existingValue, value), acc);
-                }
-                else if (dateFields.includes(key)) {
-                    // treat as IDateRange
-                    __1.setProp(key, __1.mergeDateRange(existingValue, value), acc);
-                }
-                else if (key === "term") {
-                    // append terms
-                    acc[key] = `${acc[key]} ${value}`;
-                }
-            }
-            else {
-                // Acc does not have an entry for this yet
-                // so just clone it
-                __1.setProp(key, __1.cloneObject(value), acc);
-            }
-        });
-        return acc;
-    }, {
-        filterType: "user",
-    });
-    return result;
-}
-exports.mergeUserFilters = mergeUserFilters;
-/**
- * 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
- */
-function expandUserFilter(filter) {
-    // TODO: Remove with _searchContent
-    __1.Logger.warn(`DEPRECATION: expandUserFilter will be removed. Work with IFilterGroups<"user"> and hubSearch() instead`);
-    const result = {};
-    const dateProps = ["created", "modified", "lastlogin"];
-    const specialProps = ["disabled", "term", ...dateProps];
-    Object.entries(filter).forEach(([key, value]) => {
-        // handle Matchish fields
-        if (!specialProps.includes(key)) {
-            // setProp side-steps typescript complaining
-            __1.setProp(key, __1.valueToMatchOptions(value), result);
-        }
-        // Handle date fields
-        if (dateProps.includes(key)) {
-            const dateFieldValue = __1.cloneObject(__1.getProp(filter, key));
-            if (__1.getProp(filter, `${key}.type`) === "relative-date") {
-                __1.setProp(key, __1.relativeDateToDateRange(dateFieldValue), result);
-            }
-            else {
-                __1.setProp(key, dateFieldValue, result);
-            }
-        }
-    });
-    // disabled is boolean, so we check if the prop exists
-    // vs checking if the value is truthy
-    if (filter.hasOwnProperty("disabled")) {
-        result.disabled = filter.disabled;
-    }
-    if (filter.term) {
-        result.term = filter.term;
-    }
-    return result;
-}
-exports.expandUserFilter = expandUserFilter;
-/**
- * @private
- * Serialize an `IUserFilterDefinition` into an `ISearchOptions` for use
- * with `searchUsers`
- * @param filter
- * @returns
- */
-function serializeUserFilterForPortal(filter) {
-    // TODO: Remove with _searchContent
-    __1.Logger.warn(`DEPRECATION: serializeUserFilterForPortal will be removed. Work with IFilterGroups<"user"> and hubSearch() instead`);
-    let result = {
-        q: "",
-        filter: "",
-    };
-    const dateProps = ["created", "modified", "lastlogin"];
-    const specialProps = ["term", "filterType", ...dateProps];
-    Object.entries(filter).forEach(([key, value]) => {
-        // MatchOptions fields
-        if (!specialProps.includes(key)) {
-            result = __1.mergeSearchOptions(result, __1.serializeMatchOptions(key, value), "AND");
-        }
-        // Dates only go into q
-        if (dateProps.includes(key)) {
-            result = __1.mergeSearchOptions(result, __1.serializeDateRange(key, value), "AND");
-        }
-    });
-    // disabled is also a top-level property
-    if (filter.hasOwnProperty("disabled")) {
-        result.disabled = filter.disabled;
-    }
-    // add the term
-    if (filter.term) {
-        // Note: this is slightly different from other types
-        result.q = `(${filter.term}) ${result.q}`.trim();
-    }
-    return result;
-}
-exports.serializeUserFilterForPortal = serializeUserFilterForPortal;
-//# sourceMappingURL=user-utils.js.map

package/dist/node/search/user-utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"user-utils.js","sourceRoot":"","sources":["../../../src/search/user-utils.ts"],"names":[],"mappings":";;;AACA,0BAcY;AAEZ,mCAAmC;AACnC;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAC9B,OAA8B;IAE9B,mCAAmC;IACnC,UAAM,CAAC,IAAI,CACT,wGAAwG,CACzG,CAAC;IACF,0DAA0D;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC/C,mCAAmC;IACnC,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACxD,MAAM,aAAa,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC,CAAC;IAExE,wDAAwD;IACxD,6CAA6C;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAC5B,CAAC,GAAmB,EAAE,KAAK,EAAE,EAAE;QAC7B,iBAAiB;QACjB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,+CAA+C;YAC/C,yCAAyC;YAEzC,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;gBAC3B,MAAM,aAAa,GAAG,WAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBACxC,uCAAuC;gBACvC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAChC,4BAA4B;oBAC5B,WAAO,CAAC,GAAG,EAAE,qBAAiB,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;iBAC5D;qBAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACnC,sBAAsB;oBACtB,WAAO,CAAC,GAAG,EAAE,kBAAc,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;iBACzD;qBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;oBACzB,eAAe;oBACf,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;iBACnC;aACF;iBAAM;gBACL,0CAA0C;gBAC1C,mBAAmB;gBACnB,WAAO,CAAC,GAAG,EAAE,eAAW,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;aACvC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,UAAU,EAAE,MAAM;KACD,CACpB,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAjDD,4CAiDC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,gBAAgB,CAC9B,MAAsB;IAEtB,mCAAmC;IACnC,UAAM,CAAC,IAAI,CACT,wGAAwG,CACzG,CAAC;IACF,MAAM,MAAM,GAAG,EAA2B,CAAC;IAC3C,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACvD,MAAM,YAAY,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IAExD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,yBAAyB;QACzB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC/B,4CAA4C;YAC5C,WAAO,CAAC,GAAG,EAAE,uBAAmB,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;SAClD;QACD,qBAAqB;QACrB,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,cAAc,GAAG,eAAW,CAAC,WAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;YACzD,IAAI,WAAO,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,eAAe,EAAE;gBACtD,WAAO,CAAC,GAAG,EAAE,2BAAuB,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;aAC/D;iBAAM;gBACL,WAAO,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;aACtC;SACF;IACH,CAAC,CAAC,CAAC;IAEH,sDAAsD;IACtD,qCAAqC;IACrC,IAAI,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QACrC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;KACnC;IACD,IAAI,MAAM,CAAC,IAAI,EAAE;QACf,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;KAC3B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AArCD,4CAqCC;AAED;;;;;;GAMG;AACH,SAAgB,4BAA4B,CAC1C,MAA6B;IAE7B,mCAAmC;IACnC,UAAM,CAAC,IAAI,CACT,oHAAoH,CACrH,CAAC;IACF,IAAI,MAAM,GAAG;QACX,CAAC,EAAE,EAAE;QACL,MAAM,EAAE,EAAE;KACO,CAAC;IAEpB,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACvD,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC,CAAC;IAC1D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,sBAAsB;QACtB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC/B,MAAM,GAAG,sBAAkB,CACzB,MAAM,EACN,yBAAqB,CAAC,GAAG,EAAE,KAAK,CAAC,EACjC,KAAK,CACN,CAAC;SACH;QACD,uBAAuB;QACvB,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,GAAG,sBAAkB,CACzB,MAAM,EACN,sBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,EAC9B,KAAK,CACN,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IACH,wCAAwC;IACxC,IAAI,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QACrC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;KACnC;IACD,eAAe;IACf,IAAI,MAAM,CAAC,IAAI,EAAE;QACf,oDAAoD;QACpD,MAAM,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;KAClD;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA3CD,oEA2CC"}

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

@@ -1,9 +0,0 @@
-import { Filter, IHubSearchOptions } from "./types";
-import { IHubContent, ISearchResponse } from "..";
-/**
- * @private
- * Search for content via the Portal or Hub API
- * @param filter
- * @param options
- */
-export declare function _searchContent(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubContent>>;

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

@@ -1,17 +0,0 @@
-import { IGroup } from "@esri/arcgis-rest-portal";
-import { Filter, IHubSearchOptions, IFacet } from "./types";
-import { ISearchResponse } from "..";
-export interface IGroupSearchResult {
-    groups: IGroup[];
-    facets: IFacet[];
-}
-/**
- * @private
- * Search Groups using Filter<"group">
- *
- * Currently just returns ISearchResult<IGroup>
- * @param filter
- * @param options
- * @returns
- */
-export declare function _searchGroups(filter: Filter<"group">, options: IHubSearchOptions): Promise<ISearchResponse<IGroup>>;

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

@@ -1,31 +0,0 @@
-import { IUser, UserSession } from "@esri/arcgis-rest-auth";
-import { Filter, IHubSearchOptions, ISearchResponse } from "..";
-/**
- * Extends IHubSearchOptions to make auth mandatory
- */
-export interface IAuthenticatedHubSearchOptions extends IHubSearchOptions {
-    authentication: UserSession;
-}
-/**
- * Extends `IUser` with url optional props for the user's
- * profile and thumbnail
- */
-export interface IHubUser extends IUser {
-    profileUrl?: string;
-    thumbnailUrl?: string;
-}
-/**
- * @private
- * Search for Users via the Portal API.
- *
- * **Note** Authentication is required
- *
- * Another trivial comment to force a release
- *
- * Note: in the future, there may be options to search via
- * a Hub specific API
- * @param filter
- * @param options
- * @returns
- */
-export declare function _searchUsers(filter: Filter<"user">, options: IAuthenticatedHubSearchOptions): Promise<ISearchResponse<IHubUser>>;

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

@@ -1,83 +0,0 @@
-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 facets
- * Note: Only applicable to an item search
- * @param response
- * @returns
- */
-export declare function convertPortalResponseToFacets(response: ISearchResult<IItem>, operation?: "OR" | "AND"): IFacet[];
-/**
- * @private
- * Convert portal search response to facets
- * Note: Only applicable to an item search
- * @param response
- * @returns
- */
-export declare function convertPortalItemResponseToFacets(response: ISearchResult<IItem>, operation?: "OR" | "AND", optionProp?: "filter" | "filters"): IFacet[];
-/**
- * Merge `Filter<"content">` 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 mergeContentFilter(filters: Array<Filter<"content">>): Filter<"content">;
-/**
- * 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. `title: "Water"` expands into `title: { any: ["Water"]}`
- *
- * - "well known" type values are expanded
- *    - i.e. `type: "$storymap"` expands into two `subFilter` entries
- * - 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 expandContentFilter(filter: Filter<"content">): IContentFilter;
-/**
- * @private
- * Expand from a well-known "type" into it's longer form
- *
- * i.e. `type: "$storymap"` expands into two subFilters entries
- *
- * @param filter
- * @returns
- */
-export declare function expandTypeField(filter: Filter<"content">): Filter<"content">;
-/**
- * @private
- * Convert a `ContentFilterDefinition` to a `ContentFilter`
- *
- * ContentFilter is a narrower version of ContentFilterDefinition, without
- * the union types. Using a ContentFilter makes working with the structure
- * in typescript much easier.
- *
- * @param filter
- * @returns
- */
-export declare function convertContentDefinitionToFilter(filter: IContentFilterDefinition): IContentFilter;
-/**
- * @private
- * Serialize a `ContentFilter` into an `ISearchOptions` for use with `searchItems`
- * @param filter
- * @returns
- */
-export declare function serializeContentFilterForPortal(filter: IContentFilter): ISearchOptions;
-/**
- * @private
- * Convert a ContentFilter to a SearchOptions
- *
- * @param filter
- * @returns
- */
-export declare function convertContentFilterToSearchOptions(filter: IContentFilter): ISearchOptions;

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

@@ -1,13 +0,0 @@
-import { Filter, IFilterGroup, FilterType } from "./types";
-/**
- * Determine if a Filter is "empty"
- * @param filter
- * @returns
- */
-export declare function isEmptyFilter(filter: Filter<FilterType>): boolean;
-/**
- * Determine if a filterGroup is "empty"
- * @param filterGroup
- * @returns
- */
-export declare function isEmptyFilterGroup(filterGroup: IFilterGroup<FilterType>): boolean;

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

@@ -1,36 +0,0 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { Filter, IGroupFilterDefinition } from ".";
-/**
- *
- * Merge `Filter<"group">` 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 mergeGroupFilters(filters: Array<Filter<"group">>): Filter<"group">;
-/**
- * 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. `title: "Water"` expands into `title: { any: ["Water"]}`
- *
- * - 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 expandGroupFilter(filter: Filter<"group">): IGroupFilterDefinition;
-/**
- * @private
- * Serialize an `IGroupFilterDefinition` into an `ISearchOptions` for use
- * with `searchGroups`
- * @param filter
- * @returns
- */
-export declare function serializeGroupFilterForPortal(filter: IGroupFilterDefinition): ISearchOptions;

package/dist/types/search/hub-api-search.d.ts

@@ -1,10 +0,0 @@
-import { DatasetResource, IHubRequestOptions } from "..";
-/**
- * Search the Hub API
- *
- * @param requestOptions
- * @returns JSONAPI response
- */
-export declare function hubApiSearch(requestOptions: IHubRequestOptions): Promise<{
-    data: DatasetResource[];
-}>;

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;
-}