becomap 1.2.0 → 1.2.2

package/lib/index.d.ts

@@ -671,6 +671,88 @@ declare class BCEventEmitter<T extends Record<string, any>> {
 	 */
 	emit<K extends keyof T>(event: K, args: T[K]): void;
 }
+declare enum BCHappeningType {
+	OFFER = "OFFER",
+	NEWS = "NEWS",
+	EVENT = "EVENT"
+}
+/**
+ * Represents an event, offer, or news happening at a site or location.
+ */
+export interface BCHappenings {
+	/**
+	 * Unique identifier for the happening.
+	 *
+	 * @returns The event ID as a string.
+	 */
+	id: string;
+	/**
+	 * The name or title of the happening.
+	 *
+	 * @returns The name as a string.
+	 */
+	name: string;
+	/**
+	 * A description providing more details about the happening.
+	 *
+	 * @returns The description as a string.
+	 */
+	description: string;
+	/**
+	 * The start date and time of the happening in ISO 8601 format.
+	 *
+	 * @returns The start date as a string.
+	 */
+	startDate: string;
+	/**
+	 * The end date and time of the happening in ISO 8601 format.
+	 *
+	 * @returns The end date as a string.
+	 */
+	endDate: string;
+	/**
+	 * The date and time when the happening should be displayed or highlighted in ISO 8601 format.
+	 *
+	 * @returns The show date as a string.
+	 */
+	showDate: string;
+	/**
+	 * An external identifier associated with the happening, if available.
+	 *
+	 * @returns The external ID as a string.
+	 */
+	externalId: string;
+	/**
+	 * The unique identifier of the site associated with the happening.
+	 *
+	 * @returns The site ID as a string.
+	 */
+	siteId: string;
+	/**
+	 * The unique identifier of the location associated with the happening.
+	 *
+	 * @returns The location ID as a string.
+	 */
+	locationId: string;
+	/**
+	 * A list of image URLs associated with the happening.
+	 *
+	 * @returns An array of image URLs as strings.
+	 */
+	images: string[];
+	/**
+	 * The type of the happening, such as OFFER, NEWS, or EVENT.
+	 *
+	 * @returns The type as a `BCHappeningType` enum value.
+	 */
+	type: BCHappeningType;
+	/**
+	 * A priority value used to determine the display order of happenings.
+	 *
+	 * @returns The priority as a number.
+	 */
+	priority: number;
+}
 /**
  * Options for configuring the initial view of the map.
  *
@@ -820,6 +902,11 @@ export declare class BCMapView {
 	 * selectLocation(location);
 	*/
 	selectLocation(location: BCLocation): void;
+	/**
+	 * Retrieves all available happenings.
+	 * @returns An array of `BCHappenings` objects.
+	 */
+	getHappenings(type: BCHappeningType): BCHappenings[];
 	/**
 	 * Retrieves all available amenities.
 	 * @returns An array of `BCSiteAmenity` objects representing all map amenities.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "becomap",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "we lib to display becomap",
   "main": "lib/becomap.js",
   "module": "lib/becomap.js",