@esri/hub-common 12.33.0 → 13.0.0-next.1

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

@@ -16,7 +16,6 @@ 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/items/registerBrowserApp.d.ts

@@ -1,5 +1,7 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 /**
+ * @private
+ * @internal
  * Register an Item as an application, enabling oAuth flows at custom
  * domains. Only item types with "Application" in the name are valid
  * with this API call.

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

@@ -1,7 +1,5 @@
 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
@@ -26,14 +24,3 @@ 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/_internal/commonHelpers/getApi.d.ts

@@ -5,8 +5,7 @@ import { IApiDefinition } from "../../types/types";
  * @private
  * Determines Which API should be hit for the given search parameters.
  * Hierarchy:
- * - Target options.api if available
- * - Target the OGC API current parameters allow
+ * - Target the 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/hubSearchItems.d.ts

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

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

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

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

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

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

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

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

@@ -1,5 +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";
-export declare function searchOgcAggregations(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function searchOgcAggregations(query: IQuery, options: IHubSearchOptions, api: IApiDefinition): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,5 +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";
-export declare function searchOgcItems(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function searchOgcItems(query: IQuery, options: IHubSearchOptions, api: IApiDefinition): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -0,0 +1,28 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { ISearchOptions } from "@esri/arcgis-rest-portal";
+import { ISearchResponse } from "../../types";
+import { IMatchOptions, IDateRange, IRelativeDate } from "../types/types";
+/**
+ * @private
+ * Convert a field value into a MatchOptions if it's not already one
+ * @param value
+ * @returns
+ */
+export declare function valueToMatchOptions(value: string | string[] | IMatchOptions): IMatchOptions;
+/**
+ * @private
+ * Convert a RelativeDate to a DateRange<number>
+ * @param relative
+ * @returns
+ */
+export declare function relativeDateToDateRange(relative: IRelativeDate): IDateRange<number>;
+/**
+ * @private
+ * Create a `.next()` function for a type
+ * @param request
+ * @param nextStart
+ * @param total
+ * @param fn
+ * @returns
+ */
+export declare function getNextFunction<T>(request: ISearchOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): (authentication?: UserSession) => Promise<ISearchResponse<T>>;

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

@@ -1,8 +1,5 @@
-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
  */
@@ -16,20 +13,11 @@ 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

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

@@ -1,51 +1,5 @@
-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";
-/**
- * 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
- * @param value
- * @returns
- */
-export declare function valueToMatchOptions(value: string | string[] | IMatchOptions): IMatchOptions;
-/**
- * @private
- * Convert a RelativeDate to a DateRange<number>
- * @param relative
- * @returns
- */
-export declare function relativeDateToDateRange(relative: IRelativeDate): IDateRange<number>;
-/**
- * @private
- * Create a `.next()` function for a type
- * @param request
- * @param nextStart
- * @param total
- * @param fn
- * @returns
- */
-export declare function getNextFunction<T>(request: ISearchOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): (authentication?: UserSession) => Promise<ISearchResponse<T>>;
+import { IUser } from "@esri/arcgis-rest-auth";
+import { IGroup } from "@esri/arcgis-rest-portal";
 /**
  * Construct a the full url to a group thumbnail
  *

package/dist/types/sites/HubSites.d.ts

@@ -22,18 +22,6 @@ export declare function createSite(partialSite: Partial<IHubSite>, requestOption
  * @returns
  */
 export declare function updateSite(site: IHubSite, requestOptions: IHubRequestOptions): Promise<IHubSite>;
-/**
- * @private
- * Remove a Hub Site
- *
- * This simply removes the Site item, and it's associated domain records.
- * This does not remove any Teams/Groups or content associated with the
- * Site
- * @param id
- * @param requestOptions
- * @returns
- */
-export declare function destroySite(id: string, requestOptions: IHubRequestOptions): Promise<void>;
 /**
  * Remove a Hub Site
  *

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

@@ -7,7 +7,6 @@ export * from "./fetchSiteModel";
 export * from "./get-site-by-id";
 export * from "./HubSite";
 export * from "./HubSites";
-export * from "./registerSiteAsApplication";
 export * from "./site-schema-version";
 export * from "./themes";
 export * from "./upgrade-site-schema";

package/dist/types/sites/registerSiteAsApplication.d.ts

@@ -1,5 +1,7 @@
 import { IHubRequestOptions, IModel } from "../types";
 /**
+ * @private
+ * @internal
  * Register the Site item as an application so we can oauth against it
  * @param {string} siteId Item Id of the site
  * @param {Array} uris Arrayf valid uris for the site

package/dist/types/types.d.ts

@@ -239,7 +239,7 @@ export interface IUpdatePageOptions extends IHubUserRequestOptions {
     allowList?: string[];
 }
 export interface IDomainEntry {
-    clientKey: string;
+    clientKey?: string;
     createdAt?: string;
     hostname: string;
     id: string;

package/package.json

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