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

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,7 +1,5 @@
 export * from "./ICatalog";
 export * from "./ICollection";
-export * from "./IFacet";
-export * from "./IFacetOption";
 export * from "./IHubAggregation";
 export * from "./IHubApiSearchRequest";
 export * from "./IHubSearchOptions";

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

@@ -1,6 +1,5 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { IHubContent, AccessLevel } from "../..";
-import { IFacet } from "./IFacet";
 /**
  * Generic filter used with various search functions.
  *
@@ -235,7 +234,6 @@ export interface IMatchOptions {
 export interface IContentSearchResult {
     total: number;
     results: IHubContent[];
-    facets?: IFacet[];
     hasNext: boolean;
     next: (params?: any) => Promise<IContentSearchResult>;
 }

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/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.