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

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

@@ -1,14 +1,8 @@
 export * from "./hub-api-search";
-export * from "./content-utils";
-export * from "./group-utils";
-export * from "./user-utils";
 export * from "./utils";
-export * from "./_searchContent";
-export * from "./_searchGroups";
-export * from "./_searchUsers";
 export * from "./types";
-export * from "./collectionState";
-export * from "./convertCatalog";
-export * from "./filter-utils";
+export * from "./upgradeCatalogSchema";
 export * from "./serializeQueryForPortal";
 export * from "./hubSearch";
+export * from "./Catalog";
+export * from "./Collection";

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

@@ -1,5 +1,5 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { IHubRequestOptions, IModel } from "../..";
+import { EntityType, IHubRequestOptions, IModel } from "../../index";
 import { NamedApis, IApiDefinition } from "./types";
 export declare type Enrichments = "data" | "metadata" | "org" | "service" | "layers";
 /**
@@ -42,6 +42,10 @@ export interface IHubSearchOptions {
      * DEPRECATED: Use `include` instead
      */
     enrichments?: Enrichments[];
+    /**
+     * Specify what entity to search for; For use with hubSearch
+     */
+    targetEntity?: EntityType;
     /**
      * Maximum number of results to return, per-page
      */

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

@@ -1,4 +1,4 @@
-import { IFacet } from "./IFacet";
+import { IMessage } from "../../types/IMessage";
 import { IHubAggregation } from "./IHubAggregation";
 /**
  * Defines a generic search response interface with parameterized result type
@@ -31,7 +31,7 @@ export interface IHubSearchResponse<T> {
      */
     aggregations?: IHubAggregation[];
     /**
-     * DEPRECATED - hub.js no longer computes facets; consumers need to construct them from aggregations
+     * Array of messages / warnings
      */
-    facets?: IFacet[];
+    messages?: IMessage[];
 }

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

@@ -1,9 +1,4 @@
-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";

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

@@ -1,179 +1,3 @@
-import { UserSession } from "@esri/arcgis-rest-auth";
-import { IHubContent, AccessLevel } from "../..";
-import { IFacet } from "./IFacet";
-/**
- * Generic filter used with various search functions.
- *
- * `Filter<T extends FilterType>` [FilterType](../FilterType) is constrained to
- *
- * - `Filter<"item">` [IContentFilterDefinition](../IContentFilterDefinition)
- * - `Filter<"user">` [IUserFilterDefinition](../IUserFilterDefinition)
- * - `Filter<"group">` [IGroupFilterDefinition](../IGroupFilterDefinition)
- *
- * When constructing a Filter as json, the `filterType` must be specified,
- * and it must be `keyof` [FilterTypeMap](../FilterTypeMap)
- *
- * ```ts
- * const f:Filter<"item"> = {
- *   filterType: "item" // must match the FilterType
- *   term: "water"
- * }
- * ```
- */
-export declare type Filter<T extends FilterType> = IFilterTypeMap[T] & {
-    filterType: T;
-};
-/**
- * Groups of filters with an operation specifying how the
- * filters should be connected when serialized
- */
-export interface IFilterGroup<T extends FilterType> {
-    filterType: T;
-    operation?: "AND" | "OR";
-    filters: Array<Filter<T>>;
-}
-/**
- * Defines the valid FilterTypes for use with `Filter<T extends FilterType>`
- * See [Filter](../Filter)
- */
-export interface IFilterTypeMap {
-    item: IItemFilter;
-    user: IUserFilterDefinition;
-    group: IGroupFilterDefinition;
-    groupMember: IGroupMemberFilterDefinition;
-    event: IEventFilterDefinition;
-    /**
-     * DEPRECATED use item
-     * // TODO: Remove with _searchContent
-     */
-    content: IContentFilterDefinition;
-}
-export declare type FilterType = keyof IFilterTypeMap;
-export interface IItemFilter {
-    access?: AccessLevel | AccessLevel[] | IMatchOptions;
-    owner?: string | string[] | IMatchOptions;
-    tags?: string | string[] | IMatchOptions;
-    categories?: string | string[] | IMatchOptions;
-    created?: IDateRange<number> | IRelativeDate;
-    description?: string | string[] | IMatchOptions;
-    snippet?: string | string[] | IMatchOptions;
-    group?: string | string[] | IMatchOptions;
-    id?: string | string[] | IMatchOptions;
-    modified?: IDateRange<number> | IRelativeDate;
-    orgid?: string | string[] | IMatchOptions;
-    term?: string;
-    title?: string | string[] | IMatchOptions;
-    type?: string | string[] | IMatchOptions;
-    typekeywords?: string | string[] | IMatchOptions;
-    [key: string]: any;
-}
-/**
- * Fields related to Content based searches
- * // TODO: Remove with _searchContent
- */
-export interface IContentFilterDefinition {
-    access?: string | string[] | IMatchOptions;
-    owner?: string | string[] | IMatchOptions;
-    tags?: string | string[] | IMatchOptions;
-    categories?: string | string[] | IMatchOptions;
-    created?: IDateRange<number> | IRelativeDate;
-    description?: string | string[] | IMatchOptions;
-    snippet?: string | string[] | IMatchOptions;
-    group?: string | string[] | IMatchOptions;
-    id?: string | string[] | IMatchOptions;
-    modified?: IDateRange<number> | IRelativeDate;
-    orgid?: string | string[] | IMatchOptions;
-    term?: string;
-    title?: string | string[] | IMatchOptions;
-    type?: string | NamedContentFilter | Array<string | NamedContentFilter> | IMatchOptions;
-    typekeywords?: string | string[] | IMatchOptions;
-    [key: string]: any;
-    /**
-     * @internal
-     * Support for complex OR queries; Used with various expansions
-     */
-    subFilters?: Array<IContentFilterDefinition | NamedContentFilter>;
-}
-export interface IContentFilter {
-    access?: IMatchOptions;
-    created?: IDateRange<number>;
-    description?: IMatchOptions;
-    group?: IMatchOptions;
-    id?: IMatchOptions;
-    modified?: IDateRange<number>;
-    orgid?: IMatchOptions;
-    owner?: IMatchOptions;
-    tags?: IMatchOptions;
-    term?: string;
-    title?: IMatchOptions;
-    type?: IMatchOptions;
-    typekeywords?: IMatchOptions;
-    [key: string]: any;
-    subFilters?: IContentFilter[];
-}
-export interface IWellKnownContentFilters {
-    $apps: IContentFilterDefinition[];
-    $dashboard: IContentFilterDefinition[];
-    $dataset: IContentFilterDefinition[];
-    $experience: IContentFilterDefinition[];
-    $site: IContentFilterDefinition[];
-    $storymap: IContentFilterDefinition[];
-    $initiative: IContentFilterDefinition[];
-    $document: IContentFilterDefinition[];
-}
-export declare type NamedContentFilter = keyof IWellKnownContentFilters;
-export interface IUserFilterDefinition {
-    created?: IDateRange<number> | IRelativeDate;
-    disabled?: boolean;
-    email?: string | string[] | IMatchOptions;
-    firstname?: string | string[] | IMatchOptions;
-    fullname?: string | string[] | IMatchOptions;
-    group?: string | string[] | IMatchOptions;
-    lastlogin?: IDateRange<number> | IRelativeDate;
-    lastname?: string | string[] | IMatchOptions;
-    modified?: IDateRange<number> | IRelativeDate;
-    role?: string | string[] | IMatchOptions;
-    term?: string;
-    userlicensetype?: string | string[] | IMatchOptions;
-    username?: string | string[] | IMatchOptions;
-    emailstatus?: string | string[] | IMatchOptions;
-    provider?: string | string[] | IMatchOptions;
-}
-/**
- * These properties must all be passed through
- * so they are sent in separate fields and *not*
- * serialized into a q
- * Also `joined` does not take the same format as
- * dates in `q`
- */
-export interface IGroupMemberFilterDefinition {
-    memberType?: "admin" | "member";
-    joined?: IDateRange<number> | IRelativeDate;
-    name?: string | string[] | IMatchOptions;
-    orgIds?: string | string[] | IMatchOptions;
-}
-export interface IGroupFilterDefinition {
-    access?: string | string[] | IMatchOptions;
-    created?: IDateRange<number> | IRelativeDate;
-    id?: string | string[] | IMatchOptions;
-    isInvitationOnly?: boolean;
-    modified?: IDateRange<number> | IRelativeDate;
-    orgid?: string | string[] | IMatchOptions;
-    owner?: string | string[] | IMatchOptions;
-    searchUserAccess?: "groupMember";
-    searchUserName?: string;
-    tags?: string | string[] | IMatchOptions;
-    term?: string;
-    title?: string | string[] | IMatchOptions;
-    typekeywords?: string | string[] | IMatchOptions;
-    isopendata?: boolean;
-}
-export interface IEventFilterDefinition {
-    created?: IDateRange<number> | IRelativeDate;
-    modified?: IDateRange<number> | IRelativeDate;
-    orgid?: string | string[] | IMatchOptions;
-    title?: string | string[] | IMatchOptions;
-}
 /**
  * Sort Option to be displayed in a UI
  */
@@ -228,17 +52,6 @@ export interface IMatchOptions {
      */
     exact?: string | string[];
 }
-/**
- * searchContent return
- * // TODO: Remove with _searchContent
- */
-export interface IContentSearchResult {
-    total: number;
-    results: IHubContent[];
-    facets?: IFacet[];
-    hasNext: boolean;
-    next: (params?: any) => Promise<IContentSearchResult>;
-}
 export interface IWellKnownApis {
     arcgis: IApiDefinition;
     arcgisQA: IApiDefinition;
@@ -252,23 +65,4 @@ export interface IApiDefinition {
     label?: string;
     url: string;
     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/upgradeCatalogSchema.d.ts

@@ -0,0 +1,12 @@
+import { IHubCatalog } from "./types";
+/**
+ * Apply schema upgrades to Catalog objects
+ * @param catalog
+ * @returns
+ */
+export declare function upgradeCatalogSchema(catalog: any): IHubCatalog;
+/**
+ * DEPRECATED: Use upgradeCatalogSchema(...)
+ * @param original
+ */
+export declare function convertCatalog(original: any): IHubCatalog;

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

@@ -1,4 +1,4 @@
-import { IUser } from "@esri/arcgis-rest-auth";
+import { IUser, UserSession } 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/types";
@@ -22,25 +22,6 @@ export declare function expandApis(apis: Array<NamedApis | IApiDefinition>): IAp
  * @returns
  */
 export declare function expandApi(api: NamedApis | IApiDefinition): IApiDefinition;
-/**
- * @private
- * Merge two date ranges by taking the longest span
- * @param dr1
- * @param dr2
- * @returns
- */
-export declare function mergeDateRange(dr1: IDateRange<number>, dr2: IDateRange<number>): IDateRange<number>;
-/**
- * @private
- * Merge two [`MatchOptions`](../MatchOptions)
- *
- * Currently a naieve implementation where the arrays are simply merged
- *
- * @param mo1
- * @param mo2
- * @returns
- */
-export declare function mergeMatchOptions(mo1: IMatchOptions, mo2: IMatchOptions): IMatchOptions;
 /**
  * @private
  * Convert a field value into a MatchOptions if it's not already one
@@ -55,43 +36,6 @@ export declare function valueToMatchOptions(value: string | string[] | IMatchOpt
  * @returns
  */
 export declare function relativeDateToDateRange(relative: IRelativeDate): IDateRange<number>;
-/**
- * @private
- * As a final `ISearchOptions` object gets created, many such objects are created, and
- * need to be systematically "merged" so as to return consistently structured `q` and `filter`
- * values.
- * @param so1
- * @param so2
- * @param join
- * @returns
- */
-export declare function mergeSearchOptions(so1: ISearchOptions, so2: ISearchOptions, join: "AND" | "OR"): ISearchOptions;
-/**
- * @private
- * Serialize a `MatchOptions` into `q` or `filter` on an `ISearchOptions`
- * DEPRECATED: Serialization should be handled in filter-utils.ts
- * @param key
- * @param opts
- * @returns
- */
-export declare function serializeMatchOptions(key: string, opts: IMatchOptions): ISearchOptions;
-/**
- * @private
- * Serialize a DateRange<number> into a Portal Query string
- * @param key
- * @param range
- * @returns
- */
-export declare function serializeDateRange(key: string, range: IDateRange<number>): ISearchOptions;
-/**
- * @private
- * Serialize a `string` or `string[]` into a string
- * @param join
- * @param key
- * @param value
- * @returns
- */
-export declare function serializeStringOrArray(join: "AND" | "OR", key: string, value: string | string[]): string;
 /**
  * Create a `.next()` function for a type
  * @param request
@@ -100,7 +44,7 @@ export declare function serializeStringOrArray(join: "AND" | "OR", key: string,
  * @param fn
  * @returns
  */
-export declare function getNextFunction<T>(request: ISearchOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): () => Promise<ISearchResponse<T>>;
+export declare function getNextFunction<T>(request: ISearchOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): (authentication?: UserSession) => Promise<ISearchResponse<T>>;
 /**
  * Construct a the full url to a group thumbnail
  *

package/dist/types/types/IMessage.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Generic structure for returning a translatable message from
+ * one package to another, such that the calling package is responsible
+ * for the translation
+ *
+ * @export
+ * @interface IMessage
+ */
+export interface IMessage {
+    /**
+     * Unique key that can be used with a i18n system in a consuming application
+     *
+     * @type {string}
+     * @memberof IMessage
+     */
+    code: string;
+    /**
+     * English message describing the issue, for debugging only. Not intended to be shown
+     * in an application interface.
+     *
+     * @type {string}
+     * @memberof IMessage
+     */
+    message: string;
+    /**
+     * Optional data that can be sent along
+     *
+     * @type {Record<string, unknown>}
+     * @memberof IMessage
+     */
+    data?: Record<string, unknown>;
+}

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

@@ -0,0 +1 @@
+export * from "./IMessage";

package/dist/types/types.d.ts

@@ -2,7 +2,6 @@ import { IItem, IUser, IGroup, IPolygon, ISpatialReference, IGeometry } from "@e
 import { IPortal, ISearchResult } from "@esri/arcgis-rest-portal";
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IFacet } from "./search";
 /**
  * Generic Model, used with all items that have a json
  * `/data` payload
@@ -337,7 +336,6 @@ export interface ISearchResponse<T> {
     results: T[];
     hasNext: boolean;
     next: (params?: any) => Promise<ISearchResponse<T>>;
-    facets?: IFacet[];
 }
 /**
  * ENUM which defines File extensions.