added location event support

Author: Shaun Persad

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.1",
   "description": "SDK for building Envoy integrations.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/index.ts

@@ -12,6 +12,7 @@ import EnvoyUserAPI from './sdk/EnvoyUserAPI';
 import EnvoyPluginAPI from './sdk/EnvoyPluginAPI';
 
 import EnvoyJWT from './util/EnvoyJWT';
+import EnvoySignatureVerifier from './util/EnvoySignatureVerifier';
 import JSONAPIData from './util/json-api/JSONAPIData';
 
 export * from './resources/AgreementPageResource';
@@ -43,6 +44,7 @@ export {
   EnvoyPluginStorage,
   EnvoyRequest,
   EnvoyResponse,
+  EnvoySignatureVerifier,
   EnvoyStorageItem,
   EnvoyPluginAPI,
   EnvoyUserAPI,

src/internal/EnvoyLocationEvent.ts

@@ -0,0 +1,3 @@
+type EnvoyLocationEvent = 'location_capacity_updated' | string;
+
+export default EnvoyLocationEvent;

src/payloads/LocationPayload.ts

@@ -0,0 +1,8 @@
+import { LocationModel } from '../resources/LocationResource';
+
+/**
+ * @category Event
+ */
+type LocationPayload = LocationModel;
+
+export default LocationPayload;

src/sdk/EnvoyRequest.ts

@@ -3,8 +3,10 @@ import EnvoyPluginSDK from './EnvoyPluginSDK';
 import EnvoyMeta, { EnvoyEventMeta, EnvoyRouteMeta } from './EnvoyMeta';
 import EntryPayload from '../payloads/EntryPayload';
 import InvitePayload from '../payloads/InvitePayload';
+import LocationPayload from '../payloads/LocationPayload';
 import EnvoyEntryEvent from '../internal/EnvoyEntryEvent';
 import EnvoyInviteEvent from '../internal/EnvoyInviteEvent';
+import EnvoyLocationEvent from '../internal/EnvoyLocationEvent';
 import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody';
 import EnvoyOptionsRouteParams from '../internal/EnvoyOptionsRouteParams';
 import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody';
@@ -113,6 +115,15 @@ export type EnvoyEntryEventRequest<Config = Record<string, unknown>> =
 export type EnvoyInviteEventRequest<Config = Record<string, unknown>> =
   EnvoyEventRequest<EnvoyInviteEvent, InvitePayload, Config>;
 
+/**
+ * Use to type your `req` object in location event handlers,
+ * such as handlers for `location_capacity_updated`.
+ *
+ * @category Request
+ */
+export type EnvoyLocationEventRequest<Config = Record<string, unknown>> =
+  EnvoyEventRequest<EnvoyLocationEvent, LocationPayload, Config>;
+
 /**
  * You probably won't need to use this type directly.
  * For routes, use {@link EnvoyRouteRequest},

src/sdk/handlers.ts

@@ -8,6 +8,7 @@ import {
   EnvoyEntryEventRequest,
   EnvoyEventRequest,
   EnvoyInviteEventRequest,
+  EnvoyLocationEventRequest,
   EnvoyMigrationRouteRequest,
   EnvoyOptionsRouteRequest,
   EnvoyRemoteValueRouteRequest,
@@ -38,6 +39,13 @@ export type EntryEventHandler<Config = SomeObject, Additions = SomeObject> =
 export type InviteEventHandler<Config = SomeObject, Additions = SomeObject> =
   (req: EnvoyInviteEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
 
+/**
+ * Handle an location event, such as `location_capacity_updated`.
+ * @category Handler
+ */
+export type LocationEventHandler<Config = SomeObject, Additions = SomeObject> =
+  (req: EnvoyLocationEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
+
 /**
  * Handle a `plugin_uninstalled` event for cleaning up.
  * @category Handler
@@ -119,6 +127,18 @@ export function inviteEventHandler<
   return asyncHandler(handler);
 }
 
+/**
+ * Handler for location events.
+ *
+ * @category Handler
+ */
+export function locationEventHandler<
+  Config = SomeObject,
+  Additions = SomeObject,
+  >(handler: LocationEventHandler<Config, Additions>) {
+  return asyncHandler(handler);
+}
+
 /**
  * Handler for `plugin_uninstalled` events.
  *