@esri/hub-common 14.122.1 → 14.123.1

package/dist/types/events/_internal/computeLinks.d.ts

@@ -0,0 +1,10 @@
+import { IHubEntityLinks } from "../../core/types";
+import { IEvent } from "../api/orval/api/orval-events";
+/**
+ * Compute the links that get appended to a Hub Event
+ * search result and entity
+ *
+ * @param item
+ * @param requestOptions
+ */
+export declare function computeLinks(event: IEvent): IHubEntityLinks;

package/dist/types/events/_internal/getEventSlug.d.ts

@@ -0,0 +1,7 @@
+import { IEvent } from "../api/orval/api/orval-events";
+/**
+ * Builds a slug for the given IEvent record.
+ * @param event An IEvent record
+ * @returns the slug for the given IEvent record
+ */
+export declare function getEventSlug(event: IEvent): string;

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

@@ -0,0 +1,11 @@
+import { EntityType } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+/**
+ * @private
+ * Determines if the Events API can be targeted with the given
+ * search parameters
+ * @param targetEntity
+ * @param options
+ * @returns boolean
+ */
+export declare function shouldUseEventsApi(targetEntity: EntityType, options: IHubSearchOptions): boolean;

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.1",
+  "version": "14.123.1",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",

package/dist/esm/events/_internal/getISOStringFromClientDateTime.js

@@ -1,28 +0,0 @@
-/**
- * @private
- * A utility method to aid in generating an ISO-8601 UTC date/time string from separate date & time
- * inputs for the client's current locale.
- *
- *   // a user in the America/New_York timeZone
- *   getTimeZoneISOStringFromLocalDateTime('2024-03-29', '13:00:00')
- *     // => `2024-03-29T17:00:00.000Z`
- *
- *   // a user in America/Los_Angeles timeZone
- *   getTimeZoneISOStringFromLocalDateTime('2024-03-29', '13:00:00')
- *     // => `2024-03-29T20:00:00.000Z`
- *
- * @param date A date string in the format of `2024-03-29`
- * @param time A time string in 24-hour format of `13:00:00`
- * @returns an ISO-8601 UTC date/time string, e.g. `2024-03-29T16:00:00.000Z`
- */
-export function getISOStringFromClientDateTime(date, time) {
-    const [yr, mon, day] = date
-        .split("-")
-        .map((segment) => parseInt(segment, 10));
-    const [hr, min, sec] = time
-        .split(":")
-        .map((segment) => parseInt(segment, 10));
-    const timeZoneDateTime = new Date(yr, mon - 1, day, hr, min, sec, 0);
-    return timeZoneDateTime.toISOString();
-}
-//# sourceMappingURL=getISOStringFromClientDateTime.js.map

package/dist/esm/events/_internal/getISOStringFromClientDateTime.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getISOStringFromClientDateTime.js","sourceRoot":"","sources":["../../../../src/events/_internal/getISOStringFromClientDateTime.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,8BAA8B,CAC5C,IAAY,EACZ,IAAY;IAEZ,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI;SACxB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI;SACxB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3C,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACrE,OAAO,gBAAgB,CAAC,WAAW,EAAE,CAAC;AACxC,CAAC"}

package/dist/node/events/_internal/getISOStringFromClientDateTime.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getISOStringFromClientDateTime = void 0;
-/**
- * @private
- * A utility method to aid in generating an ISO-8601 UTC date/time string from separate date & time
- * inputs for the client's current locale.
- *
- *   // a user in the America/New_York timeZone
- *   getTimeZoneISOStringFromLocalDateTime('2024-03-29', '13:00:00')
- *     // => `2024-03-29T17:00:00.000Z`
- *
- *   // a user in America/Los_Angeles timeZone
- *   getTimeZoneISOStringFromLocalDateTime('2024-03-29', '13:00:00')
- *     // => `2024-03-29T20:00:00.000Z`
- *
- * @param date A date string in the format of `2024-03-29`
- * @param time A time string in 24-hour format of `13:00:00`
- * @returns an ISO-8601 UTC date/time string, e.g. `2024-03-29T16:00:00.000Z`
- */
-function getISOStringFromClientDateTime(date, time) {
-    const [yr, mon, day] = date
-        .split("-")
-        .map((segment) => parseInt(segment, 10));
-    const [hr, min, sec] = time
-        .split(":")
-        .map((segment) => parseInt(segment, 10));
-    const timeZoneDateTime = new Date(yr, mon - 1, day, hr, min, sec, 0);
-    return timeZoneDateTime.toISOString();
-}
-exports.getISOStringFromClientDateTime = getISOStringFromClientDateTime;
-//# sourceMappingURL=getISOStringFromClientDateTime.js.map

package/dist/node/events/_internal/getISOStringFromClientDateTime.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getISOStringFromClientDateTime.js","sourceRoot":"","sources":["../../../../src/events/_internal/getISOStringFromClientDateTime.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,8BAA8B,CAC5C,IAAY,EACZ,IAAY;IAEZ,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI;SACxB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI;SACxB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3C,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACrE,OAAO,gBAAgB,CAAC,WAAW,EAAE,CAAC;AACxC,CAAC;AAZD,wEAYC"}

package/dist/types/events/_internal/getISOStringFromClientDateTime.d.ts

@@ -1,18 +0,0 @@
-/**
- * @private
- * A utility method to aid in generating an ISO-8601 UTC date/time string from separate date & time
- * inputs for the client's current locale.
- *
- *   // a user in the America/New_York timeZone
- *   getTimeZoneISOStringFromLocalDateTime('2024-03-29', '13:00:00')
- *     // => `2024-03-29T17:00:00.000Z`
- *
- *   // a user in America/Los_Angeles timeZone
- *   getTimeZoneISOStringFromLocalDateTime('2024-03-29', '13:00:00')
- *     // => `2024-03-29T20:00:00.000Z`
- *
- * @param date A date string in the format of `2024-03-29`
- * @param time A time string in 24-hour format of `13:00:00`
- * @returns an ISO-8601 UTC date/time string, e.g. `2024-03-29T16:00:00.000Z`
- */
-export declare function getISOStringFromClientDateTime(date: string, time: string): string;