@esri/hub-common 17.2.0 → 17.4.0

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

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

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

@@ -1,5 +1,5 @@
 import { IQuery } from "../../types/IHubCatalog";
-import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { ISearchOgcItemsOptions } from "./interfaces";
 export interface IOgcItemQueryParams {
     filter?: string;
     token?: string;
@@ -17,7 +17,7 @@ export interface IOgcItemQueryParams {
  * 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
+ * @param options an ISearchOgcItemsOptions 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;
+export declare function getOgcItemQueryParams(query: IQuery, options: ISearchOgcItemsOptions): IOgcItemQueryParams;

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

@@ -1,10 +1,10 @@
-import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { ISearchOgcItemsOptions } from "./interfaces";
 /**
  * @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
+ * @param options ISearchOgcItemsOptions that contain sorting information
  * @returns a serialized sort string
  */
-export declare function getSortByQueryParam(options: IHubSearchOptions): string;
+export declare function getSortByQueryParam(options: ISearchOgcItemsOptions): string;

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

@@ -1,3 +1,4 @@
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
 export interface IOgcItem {
     id: string;
     type: "Feature";
@@ -34,4 +35,11 @@ export interface IOgcAggregationsResponse {
     timestamp: string;
     links: IOgcLink[];
 }
+/**
+ * @private
+ * Interface for the options object passed to the searchOgcItems function.
+ * Unlike IHubSearchOptions, this interface does not accept aggregation
+ * properties or properties marked for deprecation.
+ */
+export declare type ISearchOgcItemsOptions = Omit<IHubSearchOptions, "aggFields" | "aggLimit" | "api" | "authentication" | "page">;
 export {};

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

@@ -1,4 +1,4 @@
-import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+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
@@ -23,4 +23,4 @@ import { IHubSearchOptions } from "../../types/IHubSearchOptions";
  * @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>;
+export declare function ogcApiRequest(url: string, queryParams: Record<string, any>, options: ISearchOgcItemsOptions): Promise<any>;

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

@@ -1,5 +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>>;
+import { ISearchOgcItemsOptions } from "./interfaces";
+export declare function searchOgcItems(url: string, query: IQuery, options: ISearchOgcItemsOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -6,3 +6,4 @@ export * from "./types";
 export * from "./upgradeCatalogSchema";
 export * from "./utils";
 export * from "./wellKnownCatalog";
+export * from "./searchAssociatedContent";

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

@@ -0,0 +1,12 @@
+import { IHubSearchResponse, IHubSearchResult, ISearchAssociatedContentOptions } from "./types";
+/**
+ * Searches for content that is associated with a given entity.
+ * Current associations supported are "related" and "connected".
+ *
+ * If unspecified, the number of results returned is 4.
+ *
+ * NOTE: only item based entities are supported for now.
+ *
+ * @returns Search results for the associated content
+ */
+export declare function searchAssociatedContent(opts: ISearchAssociatedContentOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,5 +1,6 @@
-import { HubEntityType } from "../../core";
-import { EntityType, IHubCatalog } from "./IHubCatalog";
+import { HubEntity, HubEntityType } from "../../core";
+import { IHubRequestOptions } from "../../hub-types";
+import { EntityType, IHubCatalog, IQuery } from "./IHubCatalog";
 import { IHubSearchResponse } from "./IHubSearchResponse";
 import { IHubSearchResult } from "./IHubSearchResult";
 /**
@@ -141,3 +142,32 @@ export interface ISearchResponseHash extends Record<string, IHubSearchResponse<I
  * with units as a type
  */
 export declare type Kilobyte = number;
+/**
+ * Options for searching associated content for a given entity
+ */
+export interface ISearchAssociatedContentOptions {
+    /**
+     * The entity to search for associated content
+     */
+    entity: HubEntity;
+    /**
+     * The type of association to search for (e.g., "related", "connected")
+     */
+    association: "related" | "connected";
+    /**
+     * The request options to use for the search
+     */
+    requestOptions: IHubRequestOptions;
+    /**
+     * The scope of the search. Must have targetEntity of "item"
+     */
+    scope: IQuery;
+    /**
+     * Which layer within the entity should be searched. Required for "connected" associations
+     */
+    layerId?: string;
+    /**
+     * The number of results to return
+     */
+    num?: number;
+}

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

@@ -1,5 +1,5 @@
 import { IItem } from "@esri/arcgis-rest-portal";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
+import type { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubSite } from "../core/types/IHubSite";
 import { IHubRequestOptions, IModel } from "../hub-types";
 import { IHubSearchResult } from "../search/types/IHubSearchResult";

package/dist/types/surveys/_internal/SurveyBusinessRules.d.ts

@@ -4,7 +4,7 @@ import { IPermissionPolicy } from "../../permissions/types/IPermissionPolicy";
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const SurveyPermissions: readonly ["hub:survey", "hub:survey:create", "hub:survey:delete", "hub:survey:edit", "hub:survey:view", "hub:survey:owner", "hub:survey:canChangeAccess", "hub:survey:workspace", "hub:survey:workspace:dashboard", "hub:survey:workspace:details", "hub:survey:workspace:settings", "hub:survey:workspace:collaborators", "hub:survey:manage"];
+export declare const SurveyPermissions: readonly ["hub:survey", "hub:survey:create", "hub:survey:delete", "hub:survey:edit", "hub:survey:view", "hub:survey:view:related", "hub:survey:owner", "hub:survey:canChangeAccess", "hub:survey:workspace", "hub:survey:workspace:dashboard", "hub:survey:workspace:details", "hub:survey:workspace:settings", "hub:survey:workspace:collaborators", "hub:survey:manage"];
 /**
  * Survey permission policies
  * @private

package/dist/types/templates/_internal/TemplateBusinessRules.d.ts

@@ -9,7 +9,7 @@ export declare const TemplateDefaultFeatures: IFeatureFlags;
  * Template permissions: these define the requirements
  * any user must meet to perform related actions
  */
-export declare const TemplatePermissions: readonly ["hub:template", "hub:template:create", "hub:template:delete", "hub:template:edit", "hub:template:manage", "hub:template:view", "hub:template:canChangeAccess", "hub:template:workspace", "hub:template:workspace:details", "hub:template:workspace:dashboard", "hub:template:workspace:collaborators", "hub:template:workspace:settings"];
+export declare const TemplatePermissions: readonly ["hub:template", "hub:template:create", "hub:template:delete", "hub:template:edit", "hub:template:manage", "hub:template:view", "hub:template:view:related", "hub:template:canChangeAccess", "hub:template:workspace", "hub:template:workspace:details", "hub:template:workspace:dashboard", "hub:template:workspace:collaborators", "hub:template:workspace:settings"];
 /**
  * @private
  * Template permission policies

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "17.2.0",
+  "version": "17.4.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",
@@ -22,9 +22,9 @@
     "tslib": "^1.13.0"
   },
   "peerDependencies": {
-    "@esri/arcgis-rest-feature-service": "~4.0.5",
-    "@esri/arcgis-rest-portal": "~4.4.0",
-    "@esri/arcgis-rest-request": "~4.2.3"
+    "@esri/arcgis-rest-feature-service": "^4.0.0",
+    "@esri/arcgis-rest-portal": "^4.0.0",
+    "@esri/arcgis-rest-request": "^4.0.0"
   },
   "devDependencies": {
     "@types/adlib": "^3.0.1",