@esri/hub-common 14.122.0 → 14.123.0

package/dist/types/search/_internal/hubEventsHelpers/eventToSearchResult.d.ts

@@ -0,0 +1,10 @@
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { IHubSearchResult } from "../../types/IHubSearchResult";
+import { IEvent } from "../../../events/api/orval/api/orval-events";
+/**
+ * Resolves an IHubSearchResult for the given IEvent record
+ * @param event An IEvent record
+ * @param options An IHubSearchOptions object
+ * @returns a IHubSearchResult for the given IEvent record
+ */
+export declare function eventToSearchResult(event: IEvent, options: IHubSearchOptions): Promise<IHubSearchResult>;

package/dist/types/search/_internal/hubEventsHelpers/processFilters.d.ts

@@ -0,0 +1,8 @@
+import { IFilter } from "../../types/IHubCatalog";
+import { GetEventsParams } from "../../../events/api/orval/api/orval-events";
+/**
+ * Builds a Partial<GetEventsParams> given an Array of IFilter objects
+ * @param filters An Array of IFilter
+ * @returns a Partial<GetEventsParams> for the given Array of IFilter objects
+ */
+export declare function processFilters(filters: IFilter[]): Partial<GetEventsParams>;

package/dist/types/search/_internal/hubEventsHelpers/processOptions.d.ts

@@ -0,0 +1,8 @@
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+import { GetEventsParams } from "../../../events/api/orval/api/orval-events";
+/**
+ * Builds a Partial<GetEventsParams> for the given IHubSearchOptions
+ * @param options An IHubSearchOptions object
+ * @returns a Partial<GetEventsParams> for the given IHubSearchOptions
+ */
+export declare function processOptions(options: IHubSearchOptions): Partial<GetEventsParams>;

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

@@ -0,0 +1,11 @@
+import { IQuery } from "../types/IHubCatalog";
+import { IHubSearchOptions } from "../types/IHubSearchOptions";
+import { IHubSearchResponse } from "../types/IHubSearchResponse";
+import { IHubSearchResult } from "../types/IHubSearchResult";
+/**
+ * Searches for events against the Events 3 API using the given `query` and `options`
+ * @param query An IQuery object
+ * @param options An IHubSearchOptions object
+ * @returns a promise that resolves a <IHubSearchResponse<IHubSearchResult> object
+ */
+export declare function hubSearchEvents(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -3,3 +3,4 @@ export * from "./hubSearchItems";
 export * from "./portalSearchGroups";
 export * from "./portalSearchUsers";
 export * from "./hubSearchChannels";
+export * from "./hubSearchEvents";

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

@@ -50,7 +50,7 @@ export interface IHubCollection {
      */
     targetEntity: EntityType;
 }
-export declare type EntityType = "item" | "group" | "user" | "portalUser" | "communityUser" | "groupMember" | "event" | "channel" | "discussionPost";
+export declare type EntityType = "item" | "group" | "user" | "portalUser" | "communityUser" | "groupMember" | "event" | "channel" | "discussionPost" | "event";
 /**
  * @private
  *

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

@@ -3,6 +3,7 @@ import { AccessLevel, IHubEntityBase, IHubLocation } from "../../core";
 import { HubFamily, IHubGeography } from "../../types";
 import { IOgcItem } from "../_internal/hubSearchItemsHelpers/interfaces";
 import { IChannel } from "../../discussions/api/types";
+import { IEvent } from "../../events/api/orval/api/orval-events";
 /**
  * Standardized light-weight search result structure, applicable to all
  * types of search results - users, groups, content, events etc
@@ -58,7 +59,7 @@ export interface IHubSearchResult extends IHubEntityBase {
      * Note: We will need to cast to the approproate type
      * in order to access the properties
      */
-    rawResult?: IItem | IGroup | IUser | IOgcItem | IChannel;
+    rawResult?: IItem | IGroup | IUser | IOgcItem | IChannel | IEvent;
     /** Allow any additional properties to be added */
     [key: string]: any;
 }

package/package.json

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