@esri/hub-common 12.3.1 → 12.4.0

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

@@ -1,4 +1,3 @@
-import { IHubContent } from "../../core";
 import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
 /**
  * @private
@@ -8,11 +7,3 @@ import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from
  * @returns
  */
 export declare function hubSearchItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
-/**
- * Re-structure a jsonApi data entry into a flat object cast into
- * IHubContent
- * @param data
- * @returns
- */
-export declare function jsonApiToHubContent(data: Record<string, any>): IHubContent;
-export declare function hubContentToSearchResult(content: IHubContent): Promise<IHubSearchResult>;

package/dist/types/search/_internal/hubSearchItemsHelpers/formatOgcAggregationsResponse.d.ts

@@ -0,0 +1,4 @@
+import { IHubSearchResponse } from "../../types/IHubSearchResponse";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+import { IOgcAggregationsResponse } from "./interfaces";
+export declare function formatOgcAggregationsResponse(response: IOgcAggregationsResponse): IHubSearchResponse<IHubSearchResult>;

package/dist/types/search/_internal/hubSearchItemsHelpers/formatOgcItemsResponse.d.ts

@@ -0,0 +1,6 @@
+import { IQuery } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { IHubSearchResponse } from "../../types/IHubSearchResponse";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+import { IOgcItemsResponse } from "./interfaces";
+export declare function formatOgcItemsResponse(response: IOgcItemsResponse, originalQuery: IQuery, originalOptions: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/_internal/hubSearchItemsHelpers/getFilterQueryParam.d.ts

@@ -0,0 +1,4 @@
+import { IFilter, IPredicate, IQuery } from "../../types/IHubCatalog";
+export declare function getFilterQueryParam(query: IQuery): string;
+export declare function formatFilterBlock(filter: IFilter): string;
+export declare function formatPredicate(predicate: IPredicate): string;

package/dist/types/search/_internal/hubSearchItemsHelpers/getNextOgcCallback.d.ts

@@ -0,0 +1,6 @@
+import { IQuery } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { IHubSearchResponse } from "../../types/IHubSearchResponse";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+import { IOgcItemsResponse } from "./interfaces";
+export declare function getNextOgcCallback(response: IOgcItemsResponse, originalQuery: IQuery, originalOptions: IHubSearchOptions): (params?: any) => Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/_internal/hubSearchItemsHelpers/getOgcAggregationQueryParams.d.ts

@@ -0,0 +1,6 @@
+import { IQuery } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+export declare function getOgcAggregationQueryParams(_query: IQuery, options: IHubSearchOptions): {
+    aggregations: string;
+    token: any;
+};

package/dist/types/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.d.ts

@@ -0,0 +1,9 @@
+import { IQuery } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+export declare function getOgcItemQueryParams(query: IQuery, options: IHubSearchOptions): {
+    filter: string;
+    token: any;
+    limit: number;
+    startindex: number;
+    q: any;
+};

package/dist/types/search/_internal/hubSearchItemsHelpers/getQQueryParam.d.ts

@@ -0,0 +1,3 @@
+import { IFilter, IQuery } from "../../types/IHubCatalog";
+export declare function getQQueryParam(query: IQuery): any;
+export declare function getQPredicate(filters: IFilter[]): import("../../types/IHubCatalog").IPredicate;

package/dist/types/search/_internal/hubSearchItemsHelpers/getQueryString.d.ts

@@ -0,0 +1 @@
+export declare function getQueryString(queryParams: Record<string, any>): string;

package/dist/types/search/_internal/hubSearchItemsHelpers/interfaces.d.ts

@@ -0,0 +1,37 @@
+export interface IOgcItem {
+    id: string;
+    type: "Feature";
+    geometry: any;
+    time: any;
+    links: any[];
+    properties: Record<string, any>;
+}
+interface IOgcLink {
+    rel: "self" | "next" | "prev" | "collection";
+    type: string;
+    title: string;
+    href: string;
+}
+export interface IOgcItemsResponse {
+    type: "FeatureCollection";
+    features: IOgcItem[];
+    timestamp: string;
+    numberMatched: number;
+    numberReturned: number;
+    links: IOgcLink[];
+}
+interface IOgcItemFieldAggregation {
+    field: string;
+    aggregations: Array<{
+        label: string;
+        value: any;
+    }>;
+}
+export interface IOgcAggregationsResponse {
+    aggregations: {
+        aggregations: IOgcItemFieldAggregation[];
+    };
+    timestamp: string;
+    links: IOgcLink[];
+}
+export {};

package/dist/types/search/_internal/hubSearchItemsHelpers/ogcApiRequest.d.ts

@@ -0,0 +1,2 @@
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+export declare function ogcApiRequest(url: string, queryParams: Record<string, any>, options: IHubSearchOptions): Promise<any>;

package/dist/types/search/_internal/hubSearchItemsHelpers/ogcItemToSearchResult.d.ts

@@ -0,0 +1,4 @@
+import { IHubRequestOptions } from "../../../types";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+import { IOgcItem } from "./interfaces";
+export declare function ogcItemToSearchResult(ogcItem: IOgcItem, includes?: string[], requestOptions?: IHubRequestOptions): Promise<IHubSearchResult>;

package/dist/types/search/_internal/hubSearchItemsHelpers/searchOgcAggregations.d.ts

@@ -0,0 +1,5 @@
+import { IQuery } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { IHubSearchResponse } from "../../types/IHubSearchResponse";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+export declare function searchOgcAggregations(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/_internal/hubSearchItemsHelpers/searchOgcItems.d.ts

@@ -0,0 +1,5 @@
+import { IQuery } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { IHubSearchResponse } from "../../types/IHubSearchResponse";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+export declare function searchOgcItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,3 +1,5 @@
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../../types";
 import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IMatchOptions, IPredicate, IQuery } from "../types";
 /**
  * @private
@@ -7,6 +9,15 @@ import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IMatchOptions,
  * @returns
  */
 export declare function portalSearchItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+/**
+ * Convert an `IItem` to a `IHubSearchResult`
+ * Fetches the enrichments, and attaches them as directed in the `include` list
+ * @param item
+ * @param includes
+ * @param requestOptions
+ * @returns
+ */
+export declare function itemToSearchResult(item: IItem, includes?: string[], requestOptions?: IHubRequestOptions): Promise<IHubSearchResult>;
 interface IWellKnownItemPredicates {
     $application: IPredicate[];
     $feedback: IPredicate[];

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

@@ -63,4 +63,8 @@ export interface IHubSearchOptions {
      * The result number of the first entry in the result set response. The start parameter, along with the num parameter, can be used to paginate the search results.
      */
     start?: number;
+    /**
+     * Enables experimental functionality.
+     */
+    useBeta?: boolean;
 }

package/dist/types/urls/build-url.d.ts

@@ -1,5 +1,5 @@
-interface IQueryParams {
-    [key: string]: string;
+export interface IQueryParams {
+    [key: string]: string | number;
 }
 /**
  * @private
@@ -9,4 +9,3 @@ export declare function buildUrl(params: {
     path: string;
     query?: IQueryParams;
 }): string;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "12.3.1",
+  "version": "12.4.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",