@esri/hub-common 17.20.0 → 18.0.0

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

@@ -1,26 +1,16 @@
+import { IOgcAggregationQueryParams } from "./getOgcAggregationQueryParams";
+import { IOgcItemQueryParams } from "./getOgcItemQueryParams";
 import { ISearchOgcItemsOptions } from "./interfaces";
 /**
  * Wrapper over fetch for performing common operations when executing a request to an OGC API, such as:
  * - Creating the query string
  * - URL encoding query string values
- * - Appending the ?target query param if needed
  * - Checking whether the response is ok
  * - Returning the .json() of the response body
  *
- * Note: the ?target query param is only appended if the target site (options.site) is _different_ from the
- * the site that will have its OGC API hit (url). This allows us to use the environment-level OGC API's url while
- * actually targeting a specific Hub Site's catalog. It's a powerful capability that significantly eases local development.
- *
- * Example: https://hubqa.arcgis.com/api/search/v1?target="my-actual-hub.hub.arcgis.com"
- *
- * We omit the ?target query when the site and url are the same because it would be redundant.
- *
- * Bad example: https://hubqa.arcgis.com/api/search/v1?target="hubqa.arcgis.com"
- * Good example: https://hubqa.arcgis.com/api/search/v1
- *
  * @param url the OGC API endpoint that should actually be hit
- * @param queryParams query params that should be serialized with the request (excluding `target`)
- * @param options options to customize the search, such as the site whose catalogs we're targeting
+ * @param queryParams query params that should be serialized with the request
+ * @param options options to customize the search
  * @returns the JSON response from the endpoint
  */
-export declare function ogcApiRequest(url: string, queryParams: Record<string, any>, options: ISearchOgcItemsOptions): Promise<any>;
+export declare function ogcApiRequest(url: string, queryParams: IOgcItemQueryParams | IOgcAggregationQueryParams, options: ISearchOgcItemsOptions): Promise<unknown>;

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

@@ -1,4 +1,7 @@
-import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "./types";
+import { IQuery } from "./types/IHubCatalog";
+import { IHubSearchResponse } from "./types/IHubSearchResponse";
+import { IHubSearchOptions } from "./types/IHubSearchOptions";
+import { IHubSearchResult } from "./types/IHubSearchResult";
 /**
  * Main entrypoint for searching via Hub
  *

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

@@ -1,8 +1,8 @@
 import type { ArcGISIdentityManager } from "@esri/arcgis-rest-request";
 import { IHubRequestOptions } from "../../hub-types";
 import { EntityType } from "./IHubCatalog";
-import { NamedApis, IApiDefinition } from "./types";
 import { HTTPMethods } from "@esri/arcgis-rest-request";
+import { ApiTarget } from "./types";
 export declare type Enrichments = "data" | "metadata" | "org" | "service" | "layers";
 /**
  * Paging Options
@@ -46,15 +46,9 @@ export interface IHubSearchOptions extends IPagingOptions, ISortOptions {
      */
     aggLimit?: number;
     /**
-     * TODO: Deprecate in favor of `requestOptions` and `siteUrl`
-     * Specify API to call. Defaults to ArcGIS Online Portal API
+     * Specify API to call. Defaults to Portal API defined in requestOptions.
      */
-    api?: NamedApis | IApiDefinition;
-    /**
-     * Site whose API should be targeted. Ignored in an enterprise context.
-     * e.g., https://my-site.hub.arcgis.com
-     */
-    site?: string;
+    api?: ApiTarget;
     /**
      * DEPRECATE in favor of requestOptions
      */

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

@@ -61,20 +61,7 @@ export interface IMatchOptions {
      */
     exact?: string | string[];
 }
-export interface IWellKnownApis {
-    arcgis: IApiDefinition;
-    arcgisQA: IApiDefinition;
-    arcgisDEV: IApiDefinition;
-    hub: IApiDefinition;
-    hubQA: IApiDefinition;
-    hubDEV: IApiDefinition;
-}
-export declare type NamedApis = keyof IWellKnownApis;
-export interface IApiDefinition {
-    label?: string;
-    url: string;
-    type: "arcgis" | "arcgis-hub";
-}
+export declare type ApiTarget = "portal" | "hub";
 /**
  * Base options when checking catalog containment
  */
@@ -92,8 +79,7 @@ export interface IContainsOptions {
 /**
  * Basic information about a catalog
  */
-export interface ICatalogInfo extends Partial<IDeepCatalogInfo> {
-}
+export declare type ICatalogInfo = Partial<IDeepCatalogInfo>;
 /**
  * Cacheable information about a catalog
  */
@@ -134,8 +120,7 @@ export interface ICatalogSearchResponse {
  * Response from a Catalog search operation where the responses for different collections
  * or entities are grouped into a single object.
  */
-export interface ISearchResponseHash extends Record<string, IHubSearchResponse<IHubSearchResult>> {
-}
+export declare type ISearchResponseHash = Record<string, IHubSearchResponse<IHubSearchResult>>;
 /**
  * Type wrapper for a kilobyte
  * This is complete syntactic sugar, it makes sizes easier to understand

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

@@ -3,29 +3,9 @@ import { IGroup, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
 import { IHubSite } from "../core";
 import { IHubSearchResult } from "./types";
 import { IPredicate, IQuery } from "./types/IHubCatalog";
-import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis, Kilobyte } from "./types/types";
+import { IMatchOptions, IDateRange, IRelativeDate, Kilobyte } from "./types/types";
 import { WellKnownCollection } from "./wellKnownCatalog";
 import { LegacySearchCategory } from "./_internal/commonHelpers/isLegacySearchCategory";
-/**
- * Well known APIs
- * Short-forms for specifying common APIs
- * We will likely deprecate this
- */
-export declare const SEARCH_APIS: IWellKnownApis;
-/**
- * @private
- * Convert array of api "names" into full ApiDefinitions
- * @param apis
- * @returns
- */
-export declare function expandApis(apis: Array<NamedApis | IApiDefinition>): IApiDefinition[];
-/**
- * @private
- * Convert an api "name" into a full ApiDefinition
- * @param api
- * @returns
- */
-export declare function expandApi(api: NamedApis | IApiDefinition): IApiDefinition;
 /**
  * @private
  * Convert a field value into a MatchOptions if it's not already one

package/package.json

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

package/dist/esm/search/_internal/commonHelpers/getDiscussionsApiDefinition.js

@@ -1,10 +0,0 @@
-export function getDiscussionsApiDefinition() {
-    // Currently, url is null because this is handled internally by the
-    // discussions request method called by searchChannels, which relies on
-    // the URL defined in the request options.hubApiUrl
-    return {
-        type: "arcgis-hub",
-        url: null,
-    };
-}
-//# sourceMappingURL=getDiscussionsApiDefinition.js.map

package/dist/esm/search/_internal/commonHelpers/getDiscussionsApiDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDiscussionsApiDefinition.js","sourceRoot":"","sources":["../../../../../src/search/_internal/commonHelpers/getDiscussionsApiDefinition.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,2BAA2B;IACzC,mEAAmE;IACnE,uEAAuE;IACvE,mDAAmD;IACnD,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,IAAI;KACV,CAAC;AACJ,CAAC"}

package/dist/esm/search/_internal/commonHelpers/getOgcApiDefinition.js

@@ -1,20 +0,0 @@
-/**
- * @private
- * Returns information about the current environment's OGC API
- *
- * @param options IHubRequestOptions to derive OGC API info from
- * @returns an IApiDefinition with needed info to target the OGC API
- */
-export function getOgcApiDefinition(targetEntity, requestOptions) {
-    const umbrellaDomain = new URL(requestOptions.hubApiUrl).hostname;
-    return targetEntity === "discussionPost"
-        ? {
-            type: "arcgis-hub",
-            url: `https://${umbrellaDomain}/api/search/v2`,
-        }
-        : {
-            type: "arcgis-hub",
-            url: `https://${umbrellaDomain}/api/search/v1`,
-        };
-}
-//# sourceMappingURL=getOgcApiDefinition.js.map

package/dist/esm/search/_internal/commonHelpers/getOgcApiDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getOgcApiDefinition.js","sourceRoot":"","sources":["../../../../../src/search/_internal/commonHelpers/getOgcApiDefinition.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,YAAwB,EACxB,cAAkC;IAElC,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;IAClE,OAAO,YAAY,KAAK,gBAAgB;QACtC,CAAC,CAAC;YACE,IAAI,EAAE,YAAY;YAClB,GAAG,EAAE,WAAW,cAAc,gBAAgB;SAC/C;QACH,CAAC,CAAC;YACE,IAAI,EAAE,YAAY;YAClB,GAAG,EAAE,WAAW,cAAc,gBAAgB;SAC/C,CAAC;AACR,CAAC"}

package/dist/node/search/_internal/commonHelpers/getDiscussionsApiDefinition.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDiscussionsApiDefinition = void 0;
-function getDiscussionsApiDefinition() {
-    // Currently, url is null because this is handled internally by the
-    // discussions request method called by searchChannels, which relies on
-    // the URL defined in the request options.hubApiUrl
-    return {
-        type: "arcgis-hub",
-        url: null,
-    };
-}
-exports.getDiscussionsApiDefinition = getDiscussionsApiDefinition;
-//# sourceMappingURL=getDiscussionsApiDefinition.js.map

package/dist/node/search/_internal/commonHelpers/getDiscussionsApiDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDiscussionsApiDefinition.js","sourceRoot":"","sources":["../../../../../src/search/_internal/commonHelpers/getDiscussionsApiDefinition.ts"],"names":[],"mappings":";;;AAEA,SAAgB,2BAA2B;IACzC,mEAAmE;IACnE,uEAAuE;IACvE,mDAAmD;IACnD,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,GAAG,EAAE,IAAI;KACV,CAAC;AACJ,CAAC;AARD,kEAQC"}

package/dist/node/search/_internal/commonHelpers/getOgcApiDefinition.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOgcApiDefinition = void 0;
-/**
- * @private
- * Returns information about the current environment's OGC API
- *
- * @param options IHubRequestOptions to derive OGC API info from
- * @returns an IApiDefinition with needed info to target the OGC API
- */
-function getOgcApiDefinition(targetEntity, requestOptions) {
-    const umbrellaDomain = new URL(requestOptions.hubApiUrl).hostname;
-    return targetEntity === "discussionPost"
-        ? {
-            type: "arcgis-hub",
-            url: `https://${umbrellaDomain}/api/search/v2`,
-        }
-        : {
-            type: "arcgis-hub",
-            url: `https://${umbrellaDomain}/api/search/v1`,
-        };
-}
-exports.getOgcApiDefinition = getOgcApiDefinition;
-//# sourceMappingURL=getOgcApiDefinition.js.map

package/dist/node/search/_internal/commonHelpers/getOgcApiDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getOgcApiDefinition.js","sourceRoot":"","sources":["../../../../../src/search/_internal/commonHelpers/getOgcApiDefinition.ts"],"names":[],"mappings":";;;AAIA;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,YAAwB,EACxB,cAAkC;IAElC,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;IAClE,OAAO,YAAY,KAAK,gBAAgB;QACtC,CAAC,CAAC;YACE,IAAI,EAAE,YAAY;YAClB,GAAG,EAAE,WAAW,cAAc,gBAAgB;SAC/C;QACH,CAAC,CAAC;YACE,IAAI,EAAE,YAAY;YAClB,GAAG,EAAE,WAAW,cAAc,gBAAgB;SAC/C,CAAC;AACR,CAAC;AAdD,kDAcC"}

package/dist/types/search/_internal/commonHelpers/getDiscussionsApiDefinition.d.ts

@@ -1,2 +0,0 @@
-import { IApiDefinition } from "../../types/types";
-export declare function getDiscussionsApiDefinition(): IApiDefinition;

package/dist/types/search/_internal/commonHelpers/getOgcApiDefinition.d.ts

@@ -1,11 +0,0 @@
-import { IHubRequestOptions } from "../../../hub-types";
-import { EntityType } from "../../types";
-import { IApiDefinition } from "../../types/types";
-/**
- * @private
- * Returns information about the current environment's OGC API
- *
- * @param options IHubRequestOptions to derive OGC API info from
- * @returns an IApiDefinition with needed info to target the OGC API
- */
-export declare function getOgcApiDefinition(targetEntity: EntityType, requestOptions: IHubRequestOptions): IApiDefinition;