@esri/hub-common 13.0.0-next.2 → 13.0.0

package/dist/node/versioning/updateVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":";;;AACA,kDAA8C;AAC9C,4DAAwD;AACxD,0EAAoE;AAGpE,qDAAkD;AAClD,+DAA4D;AAC5D,qDAG+B;AAC/B,uFAAoF;AACpF,iEAA8D;AAC9D,mCAA+C;AAE/C;;;;GAIG;AACH,MAAM,iBAAkB,SAAQ,KAAK;IACnC,YAAY,EAAU,EAAS,OAAe;QAC5C,KAAK,CAAC,WAAW,EAAE,oCAAoC,CAAC,CAAC;QAD5B,YAAO,GAAP,OAAO,CAAQ;QAE5C,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC,EACtC,KAAe;IAEf,kFAAkF;IAClF,wFAAwF;IAExF,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,eAAe,GAAG,MAAM,4BAAoB,CAChD,KAAK,CAAC,IAAI,CAAC,EAAE,EACb,OAAO,EACP,cAAc,CACf,CAAC;QACF,IAAI,eAAe,CAAC,OAAO,EAAE;YAC3B,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;SAClE;KACF;IAED,MAAM,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,+BAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,sCAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,4BAAY,CAAC,OAAO,EAAE,EAAE,EAAE,uCAA2B,CAAC,CAAC;IAE1E,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,kBAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EAAE,kBAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,OAAO,EAAE,IAAI,EACb,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAzCD,sCAyCC"}
+{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":";;;AACA,kDAA8C;AAC9C,4DAAwD;AACxD,0EAAoE;AAGpE,qDAAkD;AAClD,+DAA4D;AAC5D,qDAG+B;AAC/B,uFAAoF;AACpF,iEAA8D;AAC9D,mCAA+C;AAE/C;;;;GAIG;AACH,MAAM,iBAAkB,SAAQ,KAAK;IACnC,YAAY,EAAU,EAAS,OAAe;QAC5C,KAAK,CAAC,WAAW,EAAE,oCAAoC,CAAC,CAAC;QAD5B,YAAO,GAAP,OAAO,CAAQ;QAE5C,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC,EACtC,KAAe;IAEf,kFAAkF;IAClF,wFAAwF;IAExF,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,eAAe,GAAG,MAAM,4BAAoB,CAChD,KAAK,CAAC,IAAI,CAAC,EAAE,EACb,OAAO,EACP,cAAc,CACf,CAAC;QACF,IAAI,eAAe,CAAC,OAAO,EAAE;YAC3B,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;SAClE;KACF;IAED,MAAM,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,+BAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,sCAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,4BAAY,CAAC,OAAO,EAAE,EAAE,EAAE,uCAA2B,CAAC,CAAC;IAE1E,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,kBAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EAAE,kBAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAxCD,sCAwCC"}

package/dist/node/versioning/updateVersionMetadata.js

@@ -2,21 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateVersionMetadata = void 0;
 const merge_objects_1 = require("../objects/merge-objects");
+const object_to_json_blob_1 = require("../resources/object-to-json-blob");
 const getPrefix_1 = require("./_internal/getPrefix");
 const constants_1 = require("./_internal/constants");
+const getVersion_1 = require("./getVersion");
 const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
 /**
  * Updates the specified version's metadata
  * @param id
- * @param version
+ * @param versionMetadata
+ * @param owner
  * @param requestOptions
  * @returns
  */
-async function updateVersionMetadata(id, version, requestOptions) {
-    const prefix = getPrefix_1.getPrefix(version.id);
-    const properties = merge_objects_1.mergeObjects(version, {}, constants_1.VERSION_RESOURCE_PROPERTIES);
-    await arcgis_rest_portal_1.updateItemResource(Object.assign(Object.assign({}, requestOptions), { id, name: constants_1.VERSION_RESOURCE_NAME, owner: properties.creator, params: { properties }, prefix }));
-    return version;
+async function updateVersionMetadata(id, versionMetadata, owner, requestOptions) {
+    const prefix = getPrefix_1.getPrefix(versionMetadata.id);
+    const properties = merge_objects_1.mergeObjects(versionMetadata, {}, constants_1.VERSION_RESOURCE_PROPERTIES);
+    // fetch the whole version so we can update it
+    const version = await getVersion_1.getVersion(id, versionMetadata.id, requestOptions);
+    // apply the metadata to the version
+    merge_objects_1.mergeObjects(versionMetadata, version, constants_1.VERSION_RESOURCE_PROPERTIES);
+    const versionBlob = object_to_json_blob_1.objectToJsonBlob(version);
+    await arcgis_rest_portal_1.updateItemResource(Object.assign(Object.assign({}, requestOptions), { id, name: constants_1.VERSION_RESOURCE_NAME, owner, params: { properties }, prefix, resource: versionBlob }));
+    return versionMetadata;
 }
 exports.updateVersionMetadata = updateVersionMetadata;
 //# sourceMappingURL=updateVersionMetadata.js.map

package/dist/node/versioning/updateVersionMetadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateVersionMetadata.js","sourceRoot":"","sources":["../../../src/versioning/updateVersionMetadata.ts"],"names":[],"mappings":";;;AACA,4DAAwD;AAExD,qDAAkD;AAClD,qDAG+B;AAC/B,iEAA8D;AAE9D;;;;;;GAMG;AACI,KAAK,UAAU,qBAAqB,CACzC,EAAU,EACV,OAAyB,EACzB,cAAsC;IAEtC,MAAM,MAAM,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,4BAAY,CAAC,OAAO,EAAE,EAAE,EAAE,uCAA2B,CAAC,CAAC;IAE1E,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EACF,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EAAE,UAAU,CAAC,OAAO,EACzB,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,IACN,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAlBD,sDAkBC"}
+{"version":3,"file":"updateVersionMetadata.js","sourceRoot":"","sources":["../../../src/versioning/updateVersionMetadata.ts"],"names":[],"mappings":";;;AACA,4DAAwD;AACxD,0EAAoE;AAEpE,qDAAkD;AAClD,qDAG+B;AAC/B,6CAA0C;AAC1C,iEAA8D;AAE9D;;;;;;;GAOG;AACI,KAAK,UAAU,qBAAqB,CACzC,EAAU,EACV,eAAiC,EACjC,KAAa,EACb,cAAsC;IAEtC,MAAM,MAAM,GAAG,qBAAS,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IAC7C,MAAM,UAAU,GAAG,4BAAY,CAC7B,eAAe,EACf,EAAE,EACF,uCAA2B,CAC5B,CAAC;IAEF,8CAA8C;IAC9C,MAAM,OAAO,GAAG,MAAM,uBAAU,CAAC,EAAE,EAAE,eAAe,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IACzE,oCAAoC;IACpC,4BAAY,CAAC,eAAe,EAAE,OAAO,EAAE,uCAA2B,CAAC,CAAC;IACpE,MAAM,WAAW,GAAG,sCAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EACF,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EACL,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,eAAe,CAAC;AACzB,CAAC;AA9BD,sDA8BC"}

package/dist/types/ArcGISContext.d.ts

@@ -72,6 +72,11 @@ export interface IArcGISContext {
      * For ArcGIS Enterprise this will return `undefined`
      */
     hubUrl: string;
+    /**
+     * Returns the current user's hub-home url. If not authenticated,
+     * returns the Hub Url. If portal, returns undefined
+     */
+    hubHomeUrl: string;
     /**
      * Returns boolean indicating if the backing system
      * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
@@ -215,6 +220,7 @@ export declare class ArcGISContext implements IArcGISContext {
     private _authentication;
     private _portalUrl;
     private _hubUrl;
+    private _hubHomeUrl;
     private _portalSelf;
     private _currentUser;
     private _properties;
@@ -268,6 +274,11 @@ export declare class ArcGISContext implements IArcGISContext {
      * https://{portalHostname}/{webadaptor}
      */
     get portalUrl(): string;
+    /**
+     * Returns the current user's hub-home url. If not authenticated,
+     * returns the Hub Url. If portal, returns undefined
+     */
+    get hubHomeUrl(): string;
     /**
      * Returns the current user's Hub License
      */

package/dist/types/core/behaviors/IWithEditorBehavior.d.ts

@@ -1,4 +1,10 @@
 import { IConfigurationSchema, IUiSchema, UiSchemaElementOptions, EditorType } from "../schemas";
+/**
+ * DEPRECATED: the following will be removed at next breaking version
+ * we will be shifting towards the EditorType defined in the schemas
+ * directory
+ */
+export declare type EditorConfigType = "create" | "edit";
 export interface IEditorConfig {
     schema: IConfigurationSchema;
     uiSchema: IUiSchema;

package/dist/types/core/behaviors/IWithMetricsBehavior.d.ts

@@ -1,4 +1,4 @@
-import { IMetricFeature } from "../types/Metrics";
+import { IResolvedMetric } from "../types/Metrics";
 /**
  * Adds metrics functions to an entity
  */
@@ -6,5 +6,5 @@ export interface IWithMetricsBehavior {
     /**
      * Resolve a single metric
      */
-    resolveMetric(metricId: string): Promise<IMetricFeature[]>;
+    resolveMetric(metricId: string): Promise<IResolvedMetric>;
 }

package/dist/types/core/schemas/getEntityEditorSchemas.d.ts

@@ -5,7 +5,7 @@ import { UiSchemaElementOptions } from "./types";
  * to the supported/defined uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:initiative:edit"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:initiative:edit", "hub:site:edit"];
 /**
  * get the editor schema and uiSchema defined for an entity.
  * The schema and uiSchema that are returned can be used to

package/dist/types/core/schemas/shared/subschemas.d.ts

@@ -7,6 +7,23 @@ export declare const ENTITY_NAME_SCHEMA: {
     minLength: number;
     maxLength: number;
 };
+export declare const ENTITY_ACCESS_SCHEMA: {
+    type: string;
+    enum: string[];
+    default: string;
+};
+export declare const ENTITY_TAGS_SCHEMA: {
+    type: string;
+    items: {
+        type: string;
+    };
+};
+export declare const ENTITY_CATEGORIES_SCHEMA: {
+    type: string;
+    items: {
+        type: string;
+    };
+};
 export declare const ENTITY_EXTENT_SCHEMA: {
     type: string;
     properties: {

package/dist/types/core/traits/IWithViewSettings.d.ts

@@ -16,6 +16,10 @@ export interface IWithViewSettings {
      * entity's featured image url
      */
     featuredImageUrl?: string;
+    /**
+     * alt text of an entity's featured image
+     */
+    featuredImageAltText?: string;
     /**
      * whether the entity should render it's location on a map
      */

package/dist/types/core/types/HubEntityType.d.ts

@@ -1 +1 @@
-export declare type HubEntityType = "site" | "project" | "initiative" | "page" | "discussion" | "content";
+export declare type HubEntityType = "site" | "project" | "initiative" | "page" | "discussion" | "content" | "org";

package/dist/types/core/types/IHubItemEntity.d.ts

@@ -84,6 +84,9 @@ export interface IHubItemEntity extends IHubEntityBase, IWithPermissions {
      * @readonly
      */
     canDelete: boolean;
+    /**
+     * The location of the Entity
+     */
     location?: IHubLocation;
     /**
      * The orgId of the Entity, if available

package/dist/types/core/types/IHubLocation.d.ts

@@ -9,4 +9,9 @@ export interface IHubLocation {
     spatialReference?: ISpatialReference;
     extent?: number[][];
     geometries?: __esri.Geometry[];
+    provenance?: "none" | "custom" | "existing";
+    center?: number[];
+    orgSpatialReference?: ISpatialReference;
+    graphic?: any;
+    geoJson?: any;
 }

package/dist/types/core/types/IHubSite.d.ts

@@ -62,7 +62,8 @@ export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWith
      */
     headerSass: string;
     /**
-     * Classic capabilities
+     * Legacy capabilities
+     * @internal
      */
-    classicCapabilities: string[];
+    legacyCapabilities: string[];
 }

package/dist/types/core/types/Metrics.d.ts

@@ -157,3 +157,10 @@ export interface IMetricFeature {
     attributes: IMetricAttributes;
     geometry?: __esri.Geometry;
 }
+/**
+ * Result of resolving a metric
+ */
+export interface IResolvedMetric {
+    features: IMetricFeature[];
+    generatedAt: number;
+}

package/dist/types/initiatives/HubInitiative.d.ts

@@ -1,4 +1,4 @@
-import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig, IMetricFeature } from "../core";
+import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig, IResolvedMetric } from "../core";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
@@ -76,5 +76,5 @@ export declare class HubInitiative extends HubItemEntity<IHubInitiative> impleme
      * @param metricId
      * @returns
      */
-    resolveMetric(metricId: string): Promise<IMetricFeature[]>;
+    resolveMetric(metricId: string): Promise<IResolvedMetric>;
 }

package/dist/types/initiatives/_internal/applyInitiativeMigrations.d.ts

@@ -0,0 +1,9 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../../types";
+export declare const INITIATIVE_SCHEMA_VERSION = 2;
+/**
+ * Apply all Initiative model migrations
+ * @param model
+ * @returns
+ */
+export declare function applyInitiativeMigrations(model: IModel, requestOptions: IRequestOptions): Promise<IModel>;

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

@@ -16,6 +16,7 @@ export * from "./get-structured-license";
 export * from "./slugs";
 export * from "./normalize-solution-template-item";
 export * from "./setItemThumbnail";
+export * from "./registerBrowserApp";
 export * from "./create-item-from-file";
 export * from "./create-item-from-url";
 export * from "./create-item-from-url-or-file";

package/dist/types/metrics/resolveMetric.d.ts

@@ -1,5 +1,5 @@
 import { IArcGISContext } from "../ArcGISContext";
-import { IMetric, IMetricFeature } from "../core/types/Metrics";
+import { IMetric, IResolvedMetric } from "../core/types/Metrics";
 /**
  * Resolve a Metric into an array of `IMetricFeature` objects.
  * This implementation is similar to DynamicValues, but is just different
@@ -8,4 +8,4 @@ import { IMetric, IMetricFeature } from "../core/types/Metrics";
  * @param context
  * @returns
  */
-export declare function resolveMetric(metric: IMetric, context: IArcGISContext): Promise<IMetricFeature[]>;
+export declare function resolveMetric(metric: IMetric, context: IArcGISContext): Promise<IResolvedMetric>;

package/dist/types/projects/HubProject.d.ts

@@ -1,4 +1,4 @@
-import { IHubProject, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IMetricFeature } from "../core";
+import { IHubProject, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IResolvedMetric } from "../core";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
@@ -76,5 +76,5 @@ export declare class HubProject extends HubItemEntity<IHubProject> implements IW
      * @param metricId
      * @returns
      */
-    resolveMetric(metricId: string): Promise<IMetricFeature[]>;
+    resolveMetric(metricId: string): Promise<IResolvedMetric>;
 }

package/dist/types/projects/_internal/setStatusKeyword.d.ts

@@ -0,0 +1,8 @@
+import { PROJECT_STATUSES } from "../../core";
+/**
+ * adds/updates the project status typekeyword and returns
+ * a new array of typekeywords
+ * @param typeKeywords project's current typekeywords
+ * @param status project status
+ */
+export declare function setStatusKeyword(typeKeywords: string[], status: PROJECT_STATUSES): string[];

package/dist/types/projects/edit.d.ts

@@ -1,5 +1,7 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { IHubProject } from "../core/types";
+import { UiSchemaElementOptions } from "../core/schemas";
+import { EditorConfigType, IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
 /**
  * @private
  * Create a new Hub Project item
@@ -24,3 +26,14 @@ export declare function updateProject(project: IHubProject, requestOptions: IUse
  * @param requestOptions
  */
 export declare function deleteProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
+/**
+ * DEPRECATED: the following will be removed at next breaking version
+ * use the getEntityEditorSchemas function instead (which this function
+ * has already been refactored to consume)
+ *
+ * Get the editor config for for the HubProject entity.
+ * @param i18nScope translation scope to be interpolated into the uiSchema
+ * @param type editor type - corresonds to the returned uiSchema
+ * @param options optional hash of dynamic uiSchema element options
+ */
+export declare function getHubProjectEditorConfig(i18nScope: string, type: EditorConfigType, options?: UiSchemaElementOptions[]): Promise<IEditorConfig>;

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

@@ -1,6 +1,6 @@
 import { IArcGISContext } from "../ArcGISContext";
 import { Collection } from "./Collection";
-import { EntityType, ISearchResponseHash, IContainsOptions, IContainsResponse, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, ICatalogScope, IHubCatalog, IQuery } from "./types";
+import { EntityType, ISearchResponseHash, IContainsOptions, IContainsResponse, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, ICatalogScope, IHubCatalog, IQuery, IFilter, IHubCollection } from "./types";
 /**
  * Catalog Class
  *
@@ -72,7 +72,7 @@ export declare class Catalog implements IHubCatalog {
     /**
      * Get the collections array. Returns simple objects not Collection instances
      */
-    get collections(): import("./types").IHubCollection[];
+    get collections(): IHubCollection[];
     /**
      * Get the names of the collections
      */
@@ -83,6 +83,28 @@ export declare class Catalog implements IHubCatalog {
      * @returns
      */
     getCollection(name: string): Collection;
+    /**
+     * Get the Collection json by name
+     * @param name
+     * @returns
+     */
+    getCollectionJson(name: string): IHubCollection;
+    /**
+     * Get a Collection instance, based on a specific entity type and filters
+     * This extends from the base scope for the entity type
+     * @param type
+     * @param filters
+     * @returns
+     */
+    getCustomCollection(type: EntityType, filters: IFilter[]): Collection;
+    /**
+     * Create a custom collection based on a specific entity type and filters
+     * Returned collection extends from the base scope for the entity type
+     * @param type
+     * @param filters
+     * @returns
+     */
+    getCustomCollectionJson(type: EntityType, filters: IFilter[]): IHubCollection;
     /**
      * Search for Items
      * Will throw if the Catalog does not have a scope defined for items

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

@@ -5,7 +5,8 @@ import { IApiDefinition } from "../../types/types";
  * @private
  * Determines Which API should be hit for the given search parameters.
  * Hierarchy:
- * - Target the OGC API if current parameters allow
+ * - Target options.api if available
+ * - Target the environment-level OGC API if current parameters allow
  * - Target the Portal API based off options.requestOptions.portal
  * @param targetEntity target entity of the query
  * @param options search options

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

@@ -0,0 +1,10 @@
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+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(options: IHubSearchOptions): IApiDefinition;

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

@@ -0,0 +1,9 @@
+export declare type LegacySearchCategory = "Site" | "Event" | "Dataset" | "Document" | "App,Map";
+/**
+ * @private
+ * Determines whether a string corresponds to a search category (as opposed to a collection)
+ *
+ * @param value value to verify
+ * @returns whether the value represents one of the old search categories
+ */
+export declare function isLegacySearchCategory(value: string): boolean;

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

@@ -0,0 +1,10 @@
+import { WellKnownCollection } from "../../wellKnownCatalog";
+import { LegacySearchCategory } from "./isLegacySearchCategory";
+/**
+ * @private
+ * Converts a search category key to its corresponding wellknown collection key
+ *
+ * @param legacySearchCategory search category key to transform
+ * @returns the wellknown collection key
+ */
+export declare function toCollectionKey(legacySearchCategory: LegacySearchCategory): WellKnownCollection;

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

@@ -1,4 +1,4 @@
-import { IApiDefinition, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
+import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
 /**
  * @private
  * Execute item search against the Hub API
@@ -6,4 +6,4 @@ import { IApiDefinition, IHubSearchOptions, IHubSearchResponse, IHubSearchResult
  * @param options
  * @returns
  */
-export declare function hubSearchItems(query: IQuery, options: IHubSearchOptions, api: IApiDefinition): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function hubSearchItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,7 +1,6 @@
-import { IApiDefinition } from "../../types";
 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, api: IApiDefinition): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function formatOgcItemsResponse(response: IOgcItemsResponse, originalQuery: IQuery, originalOptions: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -0,0 +1,11 @@
+import { IQuery } from "../../types/IHubCatalog";
+/**
+ * @private
+ * Extracts the bbox value that the search should be filtered by.
+ * Also validates that the bbox predicate is not combined in some
+ * invalid way with other predicates.
+ *
+ * @param query query to extract the bbox predicate from
+ * @returns the bbox value to filter by
+ */
+export declare function getBboxQueryParam(query: IQuery): string;

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

@@ -1,7 +1,6 @@
-import { IApiDefinition } from "../../types";
 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, api: IApiDefinition): (params?: any) => Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function getNextOgcCallback(response: IOgcItemsResponse, originalQuery: IQuery, originalOptions: IHubSearchOptions): (params?: any) => Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,5 +1,5 @@
 import { IQuery } from "../../types/IHubCatalog";
-import { IApiDefinition } from "../../types/types";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
 /**
  * @private
  *
@@ -8,7 +8,7 @@ import { IApiDefinition } from "../../types/types";
  * the all collection is targeted.
  *
  * @param query the query the request is based on
- * @param api definition object for the OGC API to be targeted
+ * @param options request options, including the base OGC api url
  * @returns the collection url
  */
-export declare function getOgcCollectionUrl(query: IQuery, api: IApiDefinition): string;
+export declare function getOgcCollectionUrl(query: IQuery, options: IHubSearchOptions): string;

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

@@ -1,9 +1,21 @@
 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;
-};
+export interface IOgcItemQueryParams {
+    filter?: string;
+    token?: string;
+    limit?: number;
+    startindex?: number;
+    q?: string;
+    sortBy?: string;
+    bbox?: string;
+}
+/**
+ * @private
+ * Derives a hash of query params that should be included with a request
+ * to the /items endpoint of an OGC API collection
+ *
+ * @param query an IQuery to derive query params from
+ * @param options an IHubSearchOptions object to derive query params from
+ * @returns a hash of query params to be included in the request
+ */
+export declare function getOgcItemQueryParams(query: IQuery, options: IHubSearchOptions): IOgcItemQueryParams;

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

@@ -0,0 +1,10 @@
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+/**
+ * @private
+ * Serializes the sort options provided from the request options
+ * object into a string that the OGC API can understand
+ *
+ * @param options IHubSearchOptions that contain sorting information
+ * @returns a serialized sort string
+ */
+export declare function getSortByQueryParam(options: IHubSearchOptions): string;

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

@@ -1,2 +1,26 @@
 import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+/**
+ * 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
+ * @returns the JSON response from the endpoint
+ */
 export declare function ogcApiRequest(url: string, queryParams: Record<string, any>, options: IHubSearchOptions): Promise<any>;

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

@@ -1,6 +1,5 @@
-import { IApiDefinition } from "../../types";
 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, api: IApiDefinition): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function searchOgcAggregations(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,6 +1,5 @@
-import { IApiDefinition } from "../../types";
 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, api: IApiDefinition): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function searchOgcItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,5 +1,8 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
 import { IHubRequestOptions } from "../../types";
 import { EntityType } from "./IHubCatalog";
+import { NamedApis, IApiDefinition } from "./types";
+export declare type Enrichments = "data" | "metadata" | "org" | "service" | "layers";
 /**
  * Search Options
  */
@@ -13,11 +16,20 @@ export interface IHubSearchOptions {
      * Portal API only supports a single value
      */
     aggLimit?: number;
+    /**
+     * TODO: Deprecate in favor of `requestOptions` and `siteUrl`
+     * Specify API to call. Defaults to ArcGIS Online Portal API
+     */
+    api?: NamedApis | IApiDefinition;
     /**
      * Site whose API should be targeted. Ignored in an enterprise context.
      * e.g., https://my-site.hub.arcgis.com
      */
     site?: string;
+    /**
+     * DEPRECATE in favor of requestOptions
+     */
+    authentication?: UserSession;
     /**
      * While hubSearch requires requestOptions, it is not marked
      * required because that is a breaking change to this
@@ -57,8 +69,4 @@ 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;
 }