@envoy/envoy-integrations-sdk 2.2.3 → 2.3.0

package/README.md

@@ -183,6 +183,8 @@ const { sub: visitorId } = await jwt.decode(token);
  */
 res.send({ foo: 'bar' }); // will save foo in the installation config.
 // or
+res.send({ foo: null }); // will remove foo from the installation config.
+// or
 res.sendFailed('This step has failed validation.'); // prevent the installer from progressing.
 
 /**

package/dist/index.d.ts

@@ -18,6 +18,7 @@ import EnvoyResponse from './sdk/EnvoyResponse';
 import EnvoyStorageItem from './sdk/EnvoyStorageItem';
 import EnvoyUserAPI from './sdk/EnvoyUserAPI';
 import EnvoyPluginAPI from './sdk/EnvoyPluginAPI';
+import EnvoyValidationRouteResponseBody from './sdk/EnvoyValidationRouteResponseBody';
 import EnvoyJWT from './util/EnvoyJWT';
 import EnvoySignatureVerifier from './util/EnvoySignatureVerifier';
 import JSONAPIData from './util/json-api/JSONAPIData';
@@ -48,5 +49,5 @@ export * from './sdk/loggers';
 export * from './sdk/middleware';
 export * from './util/EnvoySignatureVerifier';
 export * from './util/axiosConstructor';
-export { EntryPayload, InvitePayload, EnvoyJWT, EnvoyMeta, EnvoyPluginJob, EnvoyPluginJobMock, EnvoyPluginSDK, EnvoyPluginStorage, EnvoyPluginStoragePipeline, EnvoyPluginStoragePipelineMock, EnvoyRequest, EnvoyResponse, EnvoySignatureVerifier, EnvoyStorageItem, EnvoyPluginAPI, EnvoyUserAPI, JSONAPIData, HttpStatus, entryEventBodyFactory, eventBodyFactory, inviteEventBodyFactory, routeBodyFactory, };
+export { EntryPayload, InvitePayload, EnvoyJWT, EnvoyMeta, EnvoyPluginJob, EnvoyPluginJobMock, EnvoyPluginSDK, EnvoyPluginStorage, EnvoyPluginStoragePipeline, EnvoyPluginStoragePipelineMock, EnvoyRequest, EnvoyResponse, EnvoySignatureVerifier, EnvoyStorageItem, EnvoyPluginAPI, EnvoyUserAPI, EnvoyValidationRouteResponseBody, JSONAPIData, HttpStatus, entryEventBodyFactory, eventBodyFactory, inviteEventBodyFactory, routeBodyFactory, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAErB,OAAO,0BAA0B,MAAM,mCAAmC,CAAC;AAE3E,OAAO,qBAAqB,MAAM,mCAAmC,CAAC;AACtE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AACxE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAE5D,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAE/C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,8BAA8B,MAAM,wCAAwC,CAAC;AAEpF,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,aAAa,MAAM,0BAA0B,CAAC;AAErD,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,kBAAkB,MAAM,0BAA0B,CAAC;AAC1D,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAElD,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,sBAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,WAAW,MAAM,6BAA6B,CAAC;AAEtD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oCAAoC,CAAC;AACnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AAEzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AAEjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AAExC,OAAO,EACL,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,SAAS,EACT,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,8BAA8B,EAC9B,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,WAAW,EACX,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,GACjB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAErB,OAAO,0BAA0B,MAAM,mCAAmC,CAAC;AAE3E,OAAO,qBAAqB,MAAM,mCAAmC,CAAC;AACtE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AACxE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAE5D,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAE/C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,8BAA8B,MAAM,wCAAwC,CAAC;AAEpF,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,aAAa,MAAM,0BAA0B,CAAC;AAErD,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,kBAAkB,MAAM,0BAA0B,CAAC;AAC1D,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,gCAAgC,MAAM,wCAAwC,CAAC;AAEtF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,sBAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,WAAW,MAAM,6BAA6B,CAAC;AAEtD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oCAAoC,CAAC;AACnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AAEzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AAEjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AAExC,OAAO,EACL,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,SAAS,EACT,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,8BAA8B,EAC9B,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,gCAAgC,EAChC,WAAW,EACX,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,GACjB,CAAC"}

package/dist/internal/EnvoyOption.d.ts

@@ -1,6 +1,7 @@
 declare type EnvoyOption = {
     label: string;
     value: string;
+    isDisabled?: boolean;
 };
 export default EnvoyOption;
 //# sourceMappingURL=EnvoyOption.d.ts.map

package/dist/internal/EnvoyOption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EnvoyOption.d.ts","sourceRoot":"","sources":["../../src/internal/EnvoyOption.ts"],"names":[],"mappings":"AAAA,aAAK,WAAW,GAAG;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,eAAe,WAAW,CAAC"}
+{"version":3,"file":"EnvoyOption.d.ts","sourceRoot":"","sources":["../../src/internal/EnvoyOption.ts"],"names":[],"mappings":"AAAA,aAAK,WAAW,GAAG;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/payloads/InvitePayload.d.ts

@@ -56,9 +56,15 @@ declare type InvitePayload = {
         'agreeable-ndas'?: {
             data: Array<JSONAPIData<'agreeable-ndas'>>;
         };
-        'tenant'?: {
+        tenant?: {
             data: JSONAPIData<'tenants'>;
         };
+        'invitee-employee'?: {
+            data: JSONAPIData<'employees'>;
+        };
+        creator?: {
+            data: JSONAPIData<'users'>;
+        };
     };
 };
 export declare function normalizeInvitePayload(payload: InvitePayload): InvitePayload;

package/dist/payloads/InvitePayload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InvitePayload.d.ts","sourceRoot":"","sources":["../../src/payloads/InvitePayload.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,8BAA8B,CAAC;AAEvD;;GAEG;AACH,aAAK,aAAa,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE;QACV,yBAAyB,EAAE,OAAO,CAAC;QACnC,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAC9B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,OAAO,EAAE,OAAO,CAAC;QACjB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,KAAK,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;QACjC,0BAA0B,EAAE,OAAO,CAAC;QACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,YAAY,CAAC,EAAE,KAAK,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC;YACX,GAAG,EAAE,MAAM,CAAC;YACZ,WAAW,EAAE,MAAM,CAAC;YACpB,SAAS,EAAE;gBACT,EAAE,EAAE,MAAM,CAAC;aACZ,CAAC;SACH,CAAC,CAAC;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,aAAa,EAAE;QACb,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;SAC9B,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;SAChC,CAAC;QACF,IAAI,CAAC,EAAE;YACL,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;SAC5B,CAAC;QACF,QAAQ,CAAC,EAAE;YACT,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;SAChC,CAAC;QACF,gBAAgB,CAAC,EAAE;YACjB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;SAC5C,CAAC;QACF,QAAQ,CAAC,EAAE;YACT,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;SAC9B,CAAC;KACH,CAAA;CACF,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAU5E;AAED,eAAe,aAAa,CAAC"}
+{"version":3,"file":"InvitePayload.d.ts","sourceRoot":"","sources":["../../src/payloads/InvitePayload.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,8BAA8B,CAAC;AAEvD;;GAEG;AACH,aAAK,aAAa,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE;QACV,yBAAyB,EAAE,OAAO,CAAC;QACnC,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAC9B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,OAAO,EAAE,OAAO,CAAC;QACjB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,KAAK,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;QACjC,0BAA0B,EAAE,OAAO,CAAC;QACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,YAAY,CAAC,EAAE,KAAK,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC;YACX,GAAG,EAAE,MAAM,CAAC;YACZ,WAAW,EAAE,MAAM,CAAC;YACpB,SAAS,EAAE;gBACT,EAAE,EAAE,MAAM,CAAC;aACZ,CAAC;SACH,CAAC,CAAC;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,aAAa,EAAE;QACb,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;SAC9B,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;SAChC,CAAC;QACF,IAAI,CAAC,EAAE;YACL,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;SAC5B,CAAC;QACF,QAAQ,CAAC,EAAE;YACT,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;SAChC,CAAC;QACF,gBAAgB,CAAC,EAAE;YACjB,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;SAC5C,CAAC;QACF,MAAM,CAAC,EAAE;YACP,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;SAC9B,CAAC;QACF,kBAAkB,CAAC,EAAE;YACnB,IAAI,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;SAChC,CAAC;QACF,OAAO,CAAC,EAAE;YACR,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;SAC5B,CAAC;KACH,CAAA;CACF,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CAU5E;AAED,eAAe,aAAa,CAAC"}

package/dist/payloads/TakeoverPayload.d.ts

@@ -0,0 +1,7 @@
+import { TakeoverModel } from '../resources/TakeoverResource';
+/**
+ * @category Event
+ */
+declare type TakeoverPayload = TakeoverModel;
+export default TakeoverPayload;
+//# sourceMappingURL=TakeoverPayload.d.ts.map

package/dist/payloads/TakeoverPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TakeoverPayload.d.ts","sourceRoot":"","sources":["../../src/payloads/TakeoverPayload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D;;GAEG;AACH,aAAK,eAAe,GAAG,aAAa,CAAC;AAErC,eAAe,eAAe,CAAC"}

package/dist/payloads/TakeoverPayload.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/resources/TakeoverResource.d.ts

@@ -0,0 +1,22 @@
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
+/**
+ * @category API Resource
+ */
+export interface TakeoverAttributes {
+    metadata: {
+        title: string;
+        message: string;
+        created_at: string;
+    };
+    'start-at': number;
+    'end-at': number | null;
+}
+/**
+ * @category API Resource
+ */
+export declare type TakeoverRelationships = 'location' | 'company';
+/**
+ * @category API Resource
+ */
+export declare type TakeoverModel = JSONAPIModel<TakeoverAttributes, TakeoverRelationships>;
+//# sourceMappingURL=TakeoverResource.d.ts.map

package/dist/resources/TakeoverResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TakeoverResource.d.ts","sourceRoot":"","sources":["../../src/resources/TakeoverResource.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,+BAA+B,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE;QACR,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,qBAAqB,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3D;;GAEG;AACH,oBAAY,aAAa,GAAG,YAAY,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,CAAC"}

package/dist/resources/TakeoverResource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/EnvoyRequest.d.ts

@@ -5,6 +5,7 @@ import EntryPayload from '../payloads/EntryPayload';
 import InvitePayload from '../payloads/InvitePayload';
 import LocationPayload from '../payloads/LocationPayload';
 import NotificationPayload from '../payloads/NotificationPayload';
+import TakeoverPayload from '../payloads/TakeoverPayload';
 import EnvoyEntryEvent from '../internal/EnvoyEntryEvent';
 import EnvoyInviteEvent from '../internal/EnvoyInviteEvent';
 import EnvoyLocationEvent from '../internal/EnvoyLocationEvent';
@@ -72,7 +73,7 @@ export declare type EnvoyRemoteValueRouteRequest<Config = Record<string, unknown
 export declare type EnvoyValidationRouteRequest<Payload = Record<string, unknown>, Config = Record<string, unknown>> = EnvoyRouteRequest<Payload, Config, never>;
 /**
  * Base type for event requests.
- * You should use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}.
+ * You should prefer specific types such as {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}.
  *
  * @category Request
  */
@@ -104,6 +105,12 @@ export declare type EnvoyLocationEventRequest<Config = Record<string, unknown>>
  * @category Request
  */
 export declare type EnvoyNotificationEventRequest<Config = Record<string, unknown>> = EnvoyEventRequest<string, NotificationPayload, Config>;
+/**
+ * Use to type your `req` object in your takeover event handler.
+ *
+ * @category Request
+ */
+export declare type EnvoyTakeoverEventRequest<Config = Record<string, unknown>> = EnvoyEventRequest<string, TakeoverPayload, Config>;
 /**
  * You probably won't need to use this type directly.
  * For routes, use {@link EnvoyRouteRequest},

package/dist/sdk/EnvoyRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EnvoyRequest.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,SAAS,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,aAAa,MAAM,2BAA2B,CAAC;AACtD,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,mBAAmB,MAAM,iCAAiC,CAAC;AAClE,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,kBAAkB,MAAM,gCAAgC,CAAC;AAChE,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,uBAAuB,MAAM,qCAAqC,CAAC;AAC1E,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,8BAA8B,MAAM,4CAA4C,CAAC;AACxF,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAqB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI,GAAG,SAAS,EAAE,OAAO,GAAG,OAAO,CAAE,SAAQ,eAAe;IAC5F,KAAK,EAAE,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;CACrC;AAED;;;;GAIG;AACH,oBAAY,iBAAiB,CAC3B,OAAO,GAAG,OAAO,EACjB,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC5B,gBAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAEhE;;;;GAIG;AACH,oBAAY,0BAA0B,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxE,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAE7C;;;;GAIG;AACH,oBAAY,wBAAwB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACnE,iBAAiB,CAAC,6BAA6B,EAAE,MAAM,EAAE,uBAAuB,CAAC,CAAC;AAEpF;;;;GAIG;AACH,oBAAY,+BAA+B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1E,iBAAiB,CAAC,oCAAoC,EAAE,MAAM,EAAE,8BAA8B,CAAC,CAAC;AAElG;;;;GAIG;AACH,oBAAY,4BAA4B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACvE,iBAAiB,CAAC,iCAAiC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAEtE;;;;GAIG;AACH,oBAAY,2BAA2B,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACzG,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAE5C;;;;;GAKG;AACH,oBAAY,iBAAiB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,EAAE,OAAO,GAAG,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC9G,gBAAgB,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAE3D;;;;;GAKG;AACH,oBAAY,sBAAsB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACjE,iBAAiB,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AAE3D;;;;;GAKG;AACH,oBAAY,uBAAuB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAClE,iBAAiB,CAAC,gBAAgB,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,oBAAY,yBAAyB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACpE,iBAAiB,CAAC,kBAAkB,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;AAEjE;;;;GAIG;AACH,oBAAY,6BAA6B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxE,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAEzD;;;;;;GAMG;AACH,aAAK,YAAY,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACnE,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AACrF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"EnvoyRequest.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,SAAS,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,aAAa,MAAM,2BAA2B,CAAC;AACtD,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,mBAAmB,MAAM,iCAAiC,CAAC;AAClE,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,kBAAkB,MAAM,gCAAgC,CAAC;AAChE,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,uBAAuB,MAAM,qCAAqC,CAAC;AAC1E,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,8BAA8B,MAAM,4CAA4C,CAAC;AACxF,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAqB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI,GAAG,SAAS,EAAE,OAAO,GAAG,OAAO,CAAE,SAAQ,eAAe;IAC5F,KAAK,EAAE,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;CACrC;AAED;;;;GAIG;AACH,oBAAY,iBAAiB,CAC3B,OAAO,GAAG,OAAO,EACjB,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC5B,gBAAgB,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAEhE;;;;GAIG;AACH,oBAAY,0BAA0B,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxE,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;AAE7C;;;;GAIG;AACH,oBAAY,wBAAwB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACnE,iBAAiB,CAAC,6BAA6B,EAAE,MAAM,EAAE,uBAAuB,CAAC,CAAC;AAEpF;;;;GAIG;AACH,oBAAY,+BAA+B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC1E,iBAAiB,CAAC,oCAAoC,EAAE,MAAM,EAAE,8BAA8B,CAAC,CAAC;AAElG;;;;GAIG;AACH,oBAAY,4BAA4B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACvE,iBAAiB,CAAC,iCAAiC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAEtE;;;;GAIG;AACH,oBAAY,2BAA2B,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACzG,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAE5C;;;;;GAKG;AACH,oBAAY,iBAAiB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,EAAE,OAAO,GAAG,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC9G,gBAAgB,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAE3D;;;;;GAKG;AACH,oBAAY,sBAAsB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACjE,iBAAiB,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AAE3D;;;;;GAKG;AACH,oBAAY,uBAAuB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAClE,iBAAiB,CAAC,gBAAgB,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,oBAAY,yBAAyB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACpE,iBAAiB,CAAC,kBAAkB,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;AAEjE;;;;GAIG;AACH,oBAAY,6BAA6B,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACxE,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAEzD;;;;GAIG;AACH,oBAAY,yBAAyB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACpE,iBAAiB,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;AAErD;;;;;;GAMG;AACH,aAAK,YAAY,CAAC,OAAO,GAAG,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACnE,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AACrF,eAAe,YAAY,CAAC"}

package/dist/sdk/EnvoyResponse.d.ts

@@ -3,6 +3,7 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
 import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody';
 import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody';
 import EnvoyRemoteValueRouteResponseBody from '../internal/EnvoyRemoteValueRouteResponseBody';
+import EnvoyValidationRouteResponseBody from './EnvoyValidationRouteResponseBody';
 /**
  * Use to type your `res` object in Envoy event handlers.
  * @category Response
@@ -39,4 +40,11 @@ export declare type EnvoyRemoteValueRouteResponse = EnvoyResponse<EnvoyRemoteVal
  * @category Response
  */
 export declare type EnvoySelectedValuesRouteResponse = EnvoyResponse<EnvoySelectedValuesRouteResponseBody>;
+/**
+ * Use to type your `res` object in Envoy "validation URL" route handlers.
+ * The response body should likely include validated values from the request payload
+ * and optionally additional config values.
+ * @category Response
+ */
+export declare type EnvoyValidationRouteResponse<Config> = EnvoyResponse<EnvoyValidationRouteResponseBody<Config>>;
 //# sourceMappingURL=EnvoyResponse.d.ts.map

package/dist/sdk/EnvoyResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EnvoyResponse.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAClE,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAE9F;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC,IAAI,GAAG,OAAO,CAAE,SAAQ,QAAQ;IACrE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;IAC5B;;;;OAIG;IACH,WAAW,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;IAE7G;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;CAC7G;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC;AAErF;;;GAGG;AACH,oBAAY,6BAA6B,GAAG,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE7F;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,aAAa,CAAC,oCAAoC,CAAC,CAAC"}
+{"version":3,"file":"EnvoyResponse.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAClE,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAC9F,OAAO,gCAAgC,MAAM,oCAAoC,CAAC;AAElF;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC,IAAI,GAAG,OAAO,CAAE,SAAQ,QAAQ;IACrE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;IAC5B;;;;OAIG;IACH,WAAW,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;IAE7G;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;CAC7G;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC;AAErF;;;GAGG;AACH,oBAAY,6BAA6B,GAAG,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE7F;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,aAAa,CAAC,oCAAoC,CAAC,CAAC;AAEnG;;;;;GAKG;AACH,oBAAY,4BAA4B,CAAC,MAAM,IAAI,aAAa,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/dist/sdk/EnvoyValidationRouteResponseBody.d.ts

@@ -0,0 +1,12 @@
+declare type Nullable<T> = {
+    [P in keyof T]: T[P] | null;
+};
+/**
+ * Config to merge with existing config.
+ * It should likely include validated values from the request payload and optionally additional config values.
+ *
+ * @category Response Body
+ */
+declare type EnvoyValidationRouteResponseBody<Config> = Nullable<Partial<Config>>;
+export default EnvoyValidationRouteResponseBody;
+//# sourceMappingURL=EnvoyValidationRouteResponseBody.d.ts.map

package/dist/sdk/EnvoyValidationRouteResponseBody.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyValidationRouteResponseBody.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyValidationRouteResponseBody.ts"],"names":[],"mappings":"AAAA,aAAK,QAAQ,CAAC,CAAC,IAAI;KAChB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,aAAK,gCAAgC,CAAC,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAC1E,eAAe,gCAAgC,CAAC"}

package/dist/sdk/EnvoyValidationRouteResponseBody.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/handlers.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="qs" />
 import { RequestHandler, Request, Response } from 'express';
-import { EnvoyEntryEventRequest, EnvoyEventRequest, EnvoyInviteEventRequest, EnvoyLocationEventRequest, EnvoyMigrationRouteRequest, EnvoyNotificationEventRequest, EnvoyOptionsRouteRequest, EnvoyRemoteValueRouteRequest, EnvoySelectedValuesRouteRequest, EnvoyValidationRouteRequest } from './EnvoyRequest';
-import EnvoyResponse, { EnvoyOptionsRouteResponse, EnvoyRemoteValueRouteResponse, EnvoySelectedValuesRouteResponse } from './EnvoyResponse';
+import { EnvoyEntryEventRequest, EnvoyEventRequest, EnvoyInviteEventRequest, EnvoyLocationEventRequest, EnvoyMigrationRouteRequest, EnvoyNotificationEventRequest, EnvoyOptionsRouteRequest, EnvoyRemoteValueRouteRequest, EnvoySelectedValuesRouteRequest, EnvoyTakeoverEventRequest, EnvoyValidationRouteRequest } from './EnvoyRequest';
+import EnvoyResponse, { EnvoyOptionsRouteResponse, EnvoyRemoteValueRouteResponse, EnvoySelectedValuesRouteResponse, EnvoyValidationRouteResponse } from './EnvoyResponse';
 declare type SomeObject = Record<string, unknown>;
 declare type Result = Promise<void> | void;
 /**
@@ -24,6 +24,11 @@ export declare type LocationEventHandler<Config = SomeObject, Additions = SomeOb
  * @category Handler
  */
 export declare type NotificationEventHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyNotificationEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
+/**
+ * Handle a takeover event.
+ * @category Handler
+ */
+export declare type TakeoverEventHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyTakeoverEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
 /**
  * Handle a `plugin_uninstalled` event for cleaning up.
  * @category Handler
@@ -53,7 +58,7 @@ export declare type SelectedValuesRouteHandler<Config = SomeObject, Additions =
  * Handle a "validation" route.
  * @category Handler
  */
-export declare type ValidationRouteHandler<Config = SomeObject, Payload = SomeObject, Additions = SomeObject> = (req: EnvoyValidationRouteRequest<Payload, Config> & Additions, res: EnvoyResponse<Partial<Config>>) => Result;
+export declare type ValidationRouteHandler<Config = SomeObject, Payload = SomeObject, Additions = SomeObject> = (req: EnvoyValidationRouteRequest<Payload, Config> & Additions, res: EnvoyValidationRouteResponse<Config>) => Result;
 /**
  * Wraps any express.js-based handlers
  * to catch Promise-based errors.
@@ -91,6 +96,12 @@ export declare function migrationRouteHandler<OldConfig, NewConfig, Additions =
  * @category Handler
  */
 export declare function notificationEventHandler<Config = SomeObject, Additions = SomeObject>(handler: NotificationEventHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for takeover events.
+ *
+ * @category Handler
+ */
+export declare function takeoverEventHandler<Config = SomeObject, Additions = SomeObject>(handler: TakeoverEventHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
 /**
  * Handler for options URL routes.
  *

package/dist/sdk/handlers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../src/sdk/handlers.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,cAAc,EACd,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,6BAA6B,EAC7B,wBAAwB,EACxB,4BAA4B,EAC5B,+BAA+B,EAC/B,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,aAAa,EAAE,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,iBAAiB,CAAC;AAEzB,aAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1C,aAAK,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEnC;;;GAGG;AACH,oBAAY,iBAAiB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACvE,CAAC,GAAG,EAAE,sBAAsB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAElF;;;GAGG;AACH,oBAAY,kBAAkB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACxE,CAAC,GAAG,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAEnF;;;GAGG;AACH,oBAAY,oBAAoB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC1E,CAAC,GAAG,EAAE,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAErF;;;GAGG;AACH,oBAAY,wBAAwB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC9E,CAAC,GAAG,EAAE,6BAA6B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAEzF;;;GAGG;AACH,oBAAY,6BAA6B,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACnF,CAAC,GAAG,EAAE,iBAAiB,CAAC,oBAAoB,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAE1G;;;GAGG;AACH,oBAAY,qBAAqB,CAAC,SAAS,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACtG,CAAC,GAAG,EAAE,0BAA0B,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC;AAEpG;;;GAGG;AACH,oBAAY,mBAAmB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACzE,CAAC,GAAG,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,yBAAyB,KAAK,MAAM,CAAC;AAEhG;;;GAGG;AACH,oBAAY,uBAAuB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC7E,CAAC,GAAG,EAAE,4BAA4B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,6BAA6B,KAAK,MAAM,CAAC;AAExG;;;GAGG;AACH,oBAAY,0BAA0B,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAChF,CAAC,GAAG,EAAE,+BAA+B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,gCAAgC,KAAK,MAAM,CAAC;AAE9G;;;GAGG;AACH,oBAAY,sBAAsB,CAAC,MAAM,GAAG,UAAU,EAAE,OAAO,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAClG,CAAC,GAAG,EAAE,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,MAAM,CAAC;AAEjH;;;;;GAKG;AAEH,wBAAgB,YAAY,CAAC,GAAG,SAAS,OAAO,EAAE,GAAG,SAAS,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,cAAc,CAM/H;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEhD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,kBAAkB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEjD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEnD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EACT,SAAS,EACT,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,8HAElE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEvD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,mBAAmB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAElD;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,6BAA6B,CAAC,MAAM,EAAE,SAAS,CAAC,8HAE5D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEtD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,0BAA0B,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEzD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,UAAU,EACpB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,8HAE9D"}
+{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../src/sdk/handlers.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,cAAc,EACd,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,6BAA6B,EAC7B,wBAAwB,EACxB,4BAA4B,EAC5B,+BAA+B,EAC/B,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,aAAa,EAAE,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,gCAAgC,EAChC,4BAA4B,EAC7B,MAAM,iBAAiB,CAAC;AAEzB,aAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1C,aAAK,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEnC;;;GAGG;AACH,oBAAY,iBAAiB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACvE,CAAC,GAAG,EAAE,sBAAsB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAElF;;;GAGG;AACH,oBAAY,kBAAkB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACxE,CAAC,GAAG,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAEnF;;;GAGG;AACH,oBAAY,oBAAoB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC1E,CAAC,GAAG,EAAE,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAErF;;;GAGG;AACH,oBAAY,wBAAwB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC9E,CAAC,GAAG,EAAE,6BAA6B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAEzF;;;GAGG;AACH,oBAAY,oBAAoB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC1E,CAAC,GAAG,EAAE,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAErF;;;GAGG;AACH,oBAAY,6BAA6B,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACnF,CAAC,GAAG,EAAE,iBAAiB,CAAC,oBAAoB,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAE1G;;;GAGG;AACH,oBAAY,qBAAqB,CAAC,SAAS,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACtG,CAAC,GAAG,EAAE,0BAA0B,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC;AAEpG;;;GAGG;AACH,oBAAY,mBAAmB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACzE,CAAC,GAAG,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,yBAAyB,KAAK,MAAM,CAAC;AAEhG;;;GAGG;AACH,oBAAY,uBAAuB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC7E,CAAC,GAAG,EAAE,4BAA4B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,6BAA6B,KAAK,MAAM,CAAC;AAExG;;;GAGG;AACH,oBAAY,0BAA0B,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAChF,CAAC,GAAG,EAAE,+BAA+B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,gCAAgC,KAAK,MAAM,CAAC;AAE9G;;;GAGG;AACH,oBAAY,sBAAsB,CAAC,MAAM,GAAG,UAAU,EAAE,OAAO,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAClG,CAAC,GAAG,EAAE,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,4BAA4B,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;AAEvH;;;;;GAKG;AAEH,wBAAgB,YAAY,CAAC,GAAG,SAAS,OAAO,EAAE,GAAG,SAAS,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,cAAc,CAM/H;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEhD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,kBAAkB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEjD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEnD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EACT,SAAS,EACT,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,8HAElE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEvD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEnD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,mBAAmB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAElD;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,6BAA6B,CAAC,MAAM,EAAE,SAAS,CAAC,8HAE5D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEtD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,0BAA0B,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEzD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,UAAU,EACpB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,8HAE9D"}

package/dist/sdk/handlers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validationRouteHandler = exports.selectedValuesRouteHandler = exports.remoteValueRouteHandler = exports.pluginUninstalledEventHandler = exports.optionsRouteHandler = exports.notificationEventHandler = exports.migrationRouteHandler = exports.locationEventHandler = exports.inviteEventHandler = exports.entryEventHandler = exports.asyncHandler = void 0;
+exports.validationRouteHandler = exports.selectedValuesRouteHandler = exports.remoteValueRouteHandler = exports.pluginUninstalledEventHandler = exports.optionsRouteHandler = exports.takeoverEventHandler = exports.notificationEventHandler = exports.migrationRouteHandler = exports.locationEventHandler = exports.inviteEventHandler = exports.entryEventHandler = exports.asyncHandler = void 0;
 /**
  * Wraps any express.js-based handlers
  * to catch Promise-based errors.
@@ -61,6 +61,15 @@ function notificationEventHandler(handler) {
     return asyncHandler(handler);
 }
 exports.notificationEventHandler = notificationEventHandler;
+/**
+ * Handler for takeover events.
+ *
+ * @category Handler
+ */
+function takeoverEventHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.takeoverEventHandler = takeoverEventHandler;
 /**
  * Handler for options URL routes.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "SDK for building Envoy integrations.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
     "src"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest",
     "docs:generate": "typedoc",
     "prepublishOnly": "tsc",
     "compile": "tsc"
@@ -59,8 +59,9 @@
     "eslint": "^7.27.0",
     "eslint-config-airbnb-typescript": "^12.3.1",
     "eslint-plugin-import": "^2.23.4",
+    "jest": "^29.5.0",
     "jsdoc-to-markdown": "^5.0.0",
-    "mocha": "^6.1.4",
+    "mocha": "^10.2.0",
     "proxyquire": "^2.1.0",
     "sinon": "^7.3.2",
     "typedoc": "^0.20.36",

package/src/index.ts

@@ -24,6 +24,7 @@ import EnvoyResponse from './sdk/EnvoyResponse';
 import EnvoyStorageItem from './sdk/EnvoyStorageItem';
 import EnvoyUserAPI from './sdk/EnvoyUserAPI';
 import EnvoyPluginAPI from './sdk/EnvoyPluginAPI';
+import EnvoyValidationRouteResponseBody from './sdk/EnvoyValidationRouteResponseBody';
 
 import EnvoyJWT from './util/EnvoyJWT';
 import EnvoySignatureVerifier from './util/EnvoySignatureVerifier';
@@ -77,6 +78,7 @@ export {
   EnvoyStorageItem,
   EnvoyPluginAPI,
   EnvoyUserAPI,
+  EnvoyValidationRouteResponseBody,
   JSONAPIData,
   HttpStatus,
   entryEventBodyFactory,

package/src/internal/EnvoyOption.ts

@@ -1,6 +1,7 @@
 type EnvoyOption = {
   label: string,
   value: string,
+  isDisabled?: boolean,
 };
 
 export default EnvoyOption;

package/src/payloads/InvitePayload.ts

@@ -58,9 +58,15 @@ type InvitePayload = {
     'agreeable-ndas'?: {
       data: Array<JSONAPIData<'agreeable-ndas'>>,
     },
-    'tenant'?: {
+    tenant?: {
       data: JSONAPIData<'tenants'>,
     },
+    'invitee-employee'?: {
+      data: JSONAPIData<'employees'>,
+    },
+    creator?: {
+      data: JSONAPIData<'users'>,
+    },
   }
 };
 

package/src/payloads/TakeoverPayload.ts

@@ -0,0 +1,8 @@
+import { TakeoverModel } from '../resources/TakeoverResource';
+
+/**
+ * @category Event
+ */
+type TakeoverPayload = TakeoverModel;
+
+export default TakeoverPayload;

package/src/resources/TakeoverResource.ts

@@ -0,0 +1,24 @@
+import JSONAPIModel from '../util/json-api/JSONAPIModel';
+
+/**
+ * @category API Resource
+ */
+export interface TakeoverAttributes {
+  metadata: {
+    title: string;
+    message: string;
+    created_at: string;
+  };
+  'start-at': number;
+  'end-at': number | null;
+}
+
+/**
+ * @category API Resource
+ */
+export type TakeoverRelationships = 'location' | 'company';
+
+/**
+ * @category API Resource
+ */
+export type TakeoverModel = JSONAPIModel<TakeoverAttributes, TakeoverRelationships>;

package/src/sdk/EnvoyRequest.ts

@@ -5,6 +5,7 @@ import EntryPayload from '../payloads/EntryPayload';
 import InvitePayload from '../payloads/InvitePayload';
 import LocationPayload from '../payloads/LocationPayload';
 import NotificationPayload from '../payloads/NotificationPayload';
+import TakeoverPayload from '../payloads/TakeoverPayload';
 import EnvoyEntryEvent from '../internal/EnvoyEntryEvent';
 import EnvoyInviteEvent from '../internal/EnvoyInviteEvent';
 import EnvoyLocationEvent from '../internal/EnvoyLocationEvent';
@@ -91,7 +92,7 @@ export type EnvoyValidationRouteRequest<Payload = Record<string, unknown>, Confi
 
 /**
  * Base type for event requests.
- * You should use {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}.
+ * You should prefer specific types such as {@link EnvoyEntryEventRequest} or {@link EnvoyInviteEventRequest}.
  *
  * @category Request
  */
@@ -133,6 +134,14 @@ export type EnvoyLocationEventRequest<Config = Record<string, unknown>> =
 export type EnvoyNotificationEventRequest<Config = Record<string, unknown>> =
   EnvoyEventRequest<string, NotificationPayload, Config>;
 
+/**
+ * Use to type your `req` object in your takeover event handler.
+ *
+ * @category Request
+ */
+export type EnvoyTakeoverEventRequest<Config = Record<string, unknown>> =
+  EnvoyEventRequest<string, TakeoverPayload, Config>;
+
 /**
  * You probably won't need to use this type directly.
  * For routes, use {@link EnvoyRouteRequest},

package/src/sdk/EnvoyResponse.ts

@@ -3,6 +3,7 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
 import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody';
 import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody';
 import EnvoyRemoteValueRouteResponseBody from '../internal/EnvoyRemoteValueRouteResponseBody';
+import EnvoyValidationRouteResponseBody from './EnvoyValidationRouteResponseBody';
 
 /**
  * Use to type your `res` object in Envoy event handlers.
@@ -44,3 +45,11 @@ export type EnvoyRemoteValueRouteResponse = EnvoyResponse<EnvoyRemoteValueRouteR
  * @category Response
  */
 export type EnvoySelectedValuesRouteResponse = EnvoyResponse<EnvoySelectedValuesRouteResponseBody>;
+
+/**
+ * Use to type your `res` object in Envoy "validation URL" route handlers.
+ * The response body should likely include validated values from the request payload
+ * and optionally additional config values.
+ * @category Response
+ */
+export type EnvoyValidationRouteResponse<Config> = EnvoyResponse<EnvoyValidationRouteResponseBody<Config>>;

package/src/sdk/EnvoyValidationRouteResponseBody.ts

@@ -0,0 +1,12 @@
+type Nullable<T> = {
+  [P in keyof T]: T[P] | null;
+};
+
+/**
+ * Config to merge with existing config.
+ * It should likely include validated values from the request payload and optionally additional config values.
+ *
+ * @category Response Body
+ */
+type EnvoyValidationRouteResponseBody<Config> = Nullable<Partial<Config>>;
+export default EnvoyValidationRouteResponseBody;

package/src/sdk/handlers.ts

@@ -14,12 +14,14 @@ import {
   EnvoyOptionsRouteRequest,
   EnvoyRemoteValueRouteRequest,
   EnvoySelectedValuesRouteRequest,
+  EnvoyTakeoverEventRequest,
   EnvoyValidationRouteRequest,
 } from './EnvoyRequest';
 import EnvoyResponse, {
   EnvoyOptionsRouteResponse,
   EnvoyRemoteValueRouteResponse,
   EnvoySelectedValuesRouteResponse,
+  EnvoyValidationRouteResponse,
 } from './EnvoyResponse';
 
 type SomeObject = Record<string, unknown>;
@@ -54,6 +56,13 @@ export type LocationEventHandler<Config = SomeObject, Additions = SomeObject> =
 export type NotificationEventHandler<Config = SomeObject, Additions = SomeObject> =
   (req: EnvoyNotificationEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
 
+/**
+ * Handle a takeover event.
+ * @category Handler
+ */
+export type TakeoverEventHandler<Config = SomeObject, Additions = SomeObject> =
+  (req: EnvoyTakeoverEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
+
 /**
  * Handle a `plugin_uninstalled` event for cleaning up.
  * @category Handler
@@ -94,7 +103,7 @@ export type SelectedValuesRouteHandler<Config = SomeObject, Additions = SomeObje
  * @category Handler
  */
 export type ValidationRouteHandler<Config = SomeObject, Payload = SomeObject, Additions = SomeObject> =
-  (req: EnvoyValidationRouteRequest<Payload, Config> & Additions, res: EnvoyResponse<Partial<Config>>) => Result;
+  (req: EnvoyValidationRouteRequest<Payload, Config> & Additions, res: EnvoyValidationRouteResponse<Config>) => Result;
 
 /**
  * Wraps any express.js-based handlers
@@ -172,6 +181,18 @@ export function notificationEventHandler<
   return asyncHandler(handler);
 }
 
+/**
+ * Handler for takeover events.
+ *
+ * @category Handler
+ */
+export function takeoverEventHandler<
+  Config = SomeObject,
+  Additions = SomeObject,
+  >(handler: TakeoverEventHandler<Config, Additions>) {
+  return asyncHandler(handler);
+}
+
 /**
  * Handler for options URL routes.
  *