Use type package

Author: codetheweb

docs/classes/SeamWebhook.md

@@ -50,7 +50,7 @@ Create a new instance of SeamWebhook.
 
 ### verify
 
-▸ **verify**(`payload`, `headers`): [`SeamEvent`](../modules.md#seamevent)
+▸ **verify**(`payload`, `headers`): [`SeamWebhookEvent`](../modules.md#seamwebhookevent)
 
 Verify a payload received from a webhook and return the typed event.
 
@@ -63,7 +63,7 @@ Verify a payload received from a webhook and return the typed event.
 
 #### Returns
 
-[`SeamEvent`](../modules.md#seamevent)
+[`SeamWebhookEvent`](../modules.md#seamwebhookevent)
 
 event
 

docs/interfaces/CommonDeviceEvent.md

@@ -32,7 +32,6 @@
 - [ActionAttemptGetResponse](interfaces/ActionAttemptGetResponse.md)
 - [ActionAttemptResultTypeMap](interfaces/ActionAttemptResultTypeMap.md)
 - [ActionAttemptWithError](interfaces/ActionAttemptWithError.md)
-- [CommonDeviceEvent](interfaces/CommonDeviceEvent.md)
 - [ConnectWebview](interfaces/ConnectWebview.md)
 - [ConnectWebviewCreateRequest](interfaces/ConnectWebviewCreateRequest.md)
 - [ConnectWebviewCreateResponse](interfaces/ConnectWebviewCreateResponse.md)
@@ -69,18 +68,12 @@
 - [ActionType](modules.md#actiontype)
 - [AnyDevice](modules.md#anydevice)
 - [CommonDeviceProperties](modules.md#commondeviceproperties)
-- [CreateAccessCodeEvent](modules.md#createaccesscodeevent)
-- [DeviceConnectedEvent](modules.md#deviceconnectedevent)
-- [DeviceDisconnectEvent](modules.md#devicedisconnectevent)
-- [DeviceLowBatteryEvent](modules.md#devicelowbatteryevent)
-- [DeviceTamperEvent](modules.md#devicetamperevent)
 - [DeviceType](modules.md#devicetype)
 - [DeviceUpdateRequest](modules.md#deviceupdaterequest)
 - [LockDevice](modules.md#lockdevice)
 - [LockDeviceType](modules.md#lockdevicetype)
-- [NoiseDetectedEvent](modules.md#noisedetectedevent)
 - [NoiseDetectionDeviceType](modules.md#noisedetectiondevicetype)
-- [SeamEvent](modules.md#seamevent)
+- [SeamWebhookEvent](modules.md#seamwebhookevent)
 - [SuccessfulAPIResponse](modules.md#successfulapiresponse)
 
 ### Functions
@@ -201,56 +194,6 @@ ___
 
 ___
 
-### CreateAccessCodeEvent
-
-Ƭ **CreateAccessCodeEvent**: [`CommonDeviceEvent`](interfaces/CommonDeviceEvent.md)<``"access_codes.created"``, { `access_code_id`: `string`  }\>
-
-#### Defined in
-
-[src/types/webhook-events.ts:21](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L21)
-
-___
-
-### DeviceConnectedEvent
-
-Ƭ **DeviceConnectedEvent**: [`CommonDeviceEvent`](interfaces/CommonDeviceEvent.md)<``"device.connected"``\>
-
-#### Defined in
-
-[src/types/webhook-events.ts:14](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L14)
-
-___
-
-### DeviceDisconnectEvent
-
-Ƭ **DeviceDisconnectEvent**: [`CommonDeviceEvent`](interfaces/CommonDeviceEvent.md)<``"devices.disconnected"``\>
-
-#### Defined in
-
-[src/types/webhook-events.ts:15](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L15)
-
-___
-
-### DeviceLowBatteryEvent
-
-Ƭ **DeviceLowBatteryEvent**: [`CommonDeviceEvent`](interfaces/CommonDeviceEvent.md)<``"devices.triggered_low_battery"``\>
-
-#### Defined in
-
-[src/types/webhook-events.ts:17](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L17)
-
-___
-
-### DeviceTamperEvent
-
-Ƭ **DeviceTamperEvent**: [`CommonDeviceEvent`](interfaces/CommonDeviceEvent.md)<``"devices.tampered"``\>
-
-#### Defined in
-
-[src/types/webhook-events.ts:16](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L16)
-
-___
-
 ### DeviceType
 
 Ƭ **DeviceType**: [`LockDeviceType`](modules.md#lockdevicetype) \| [`NoiseDetectionDeviceType`](modules.md#noisedetectiondevicetype)
@@ -300,16 +243,6 @@ ___
 
 ___
 
-### NoiseDetectedEvent
-
-Ƭ **NoiseDetectedEvent**: [`CommonDeviceEvent`](interfaces/CommonDeviceEvent.md)<``"noise_thresholds.detected_noise"``\>
-
-#### Defined in
-
-[src/types/webhook-events.ts:29](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L29)
-
-___
-
 ### NoiseDetectionDeviceType
 
 Ƭ **NoiseDetectionDeviceType**: ``"noiseaware_activity_zone"``
@@ -320,13 +253,13 @@ ___
 
 ___
 
-### SeamEvent
+### SeamWebhookEvent
 
-Ƭ **SeamEvent**: [`DeviceConnectedEvent`](modules.md#deviceconnectedevent) \| [`DeviceDisconnectEvent`](modules.md#devicedisconnectevent) \| [`DeviceTamperEvent`](modules.md#devicetamperevent) \| [`DeviceLowBatteryEvent`](modules.md#devicelowbatteryevent) \| [`CreateAccessCodeEvent`](modules.md#createaccesscodeevent) \| [`NoiseDetectedEvent`](modules.md#noisedetectedevent)
+Ƭ **SeamWebhookEvent**: `Distribute`<`SeamEvent`[``"event_type"``]\>
 
 #### Defined in
 
-[src/types/webhook-events.ts:32](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L32)
+[src/types/webhook-events.ts:10](https://github.com/seamapi/seamapi-javascript/blob/main/src/types/webhook-events.ts#L10)
 
 ___
 

docs/modules.md

@@ -35,6 +35,7 @@
     "cjs-wrapper.js"
   ],
   "dependencies": {
+    "@seamapi/seam-connect-public-types": "1.0.0",
     "axios": "0.25.0",
     "change-case": "4.1.2",
     "eventemitter3": "4.0.7",

package.json

@@ -1,7 +1,8 @@
 import prompts from "prompts"
+import { TwoFactorOption } from "@seamapi/seam-connect-public-types"
 import { PaneImplementation } from "./types"
 
-const formatOption = (option: any) => {
+const formatOption = (option: TwoFactorOption) => {
   switch (option.method) {
     case "otp":
       return `📱 authenticator app`
@@ -14,15 +15,15 @@ const formatOption = (option: any) => {
   }
 }
 
-const initiateTwoFactorPane: PaneImplementation = {
+const initiateTwoFactorPane: PaneImplementation<"initiate_two_factor_pane"> = {
   name: "initiate_two_factor_pane",
   getInput: async ({ options }) => {
     const { id } = await prompts(
       {
         type: "select",
         name: "id",
         message: "Select a 2FA option",
-        choices: options.map((o: any) => ({
+        choices: options.map((o) => ({
           title: formatOption(o),
           value: o.id,
         })),

src/cli/lib/interactive-login/panes/initiate-two-factor-pane.ts

@@ -2,7 +2,7 @@ import prompts from "prompts"
 import { formatErrorMsg } from "../utils"
 import { PaneImplementation } from "./types"
 
-const loginPane: PaneImplementation = {
+const loginPane: PaneImplementation<"login_pane"> = {
   name: "login_pane",
   getInput: async (props) => {
     let userIdentifier

src/cli/lib/interactive-login/panes/login-pane.ts

@@ -1,15 +1,15 @@
 import { PaneImplementation } from "./types"
 import prompts from "prompts"
 
-const searchAndSelectPane: PaneImplementation = {
+const searchAndSelectPane: PaneImplementation<"search_and_select_pane"> = {
   name: "search_and_select_pane",
   getInput: async ({ title, options }) => {
     const { selection } = await prompts(
       {
         name: "selection",
         type: "autocomplete",
         message: title,
-        choices: options.map((o: any) => ({
+        choices: options.map((o) => ({
           title: o.label,
           value: o.value,
         })),

src/cli/lib/interactive-login/panes/search-and-select-pane.ts

@@ -1,7 +1,7 @@
 import prompts from "prompts"
 import { PaneImplementation } from "./types"
 
-const twoFactorPane: PaneImplementation = {
+const twoFactorPane: PaneImplementation<"two_factor_pane"> = {
   name: "two_factor_pane",
   getInput: async ({ code_length }) => {
     const { code } = await prompts(

src/cli/lib/interactive-login/panes/two-factor-pane.ts

@@ -1,4 +1,8 @@
-export interface PaneImplementation {
-  name: string
-  getInput: (props: any) => Promise<any>
+import { AnyPane } from "@seamapi/seam-connect-public-types"
+
+export interface PaneImplementation<PaneName extends AnyPane["name"]> {
+  name: PaneName
+  getInput: (
+    props: Extract<AnyPane, { name: PaneName }>["render_props"]
+  ) => Promise<Extract<AnyPane, { name: PaneName }>["submit_props"]>
 }

src/cli/lib/interactive-login/panes/types.ts

@@ -1,38 +1,10 @@
-// todo: remove this file when we move to a monorepo?
-export interface CommonDeviceEvent<
-  EventType extends string,
-  Payload extends Record<string, unknown> | {} = {}
-> {
-  event_type: EventType
-  data: Payload & {
-    workspace_id: string
-    device_id: string
-  }
-}
+import { SeamEvent } from "@seamapi/seam-connect-public-types"
 
-// Devices
-export type DeviceConnectedEvent = CommonDeviceEvent<"device.connected">
-export type DeviceDisconnectEvent = CommonDeviceEvent<"devices.disconnected">
-export type DeviceTamperEvent = CommonDeviceEvent<"devices.tampered">
-export type DeviceLowBatteryEvent =
-  CommonDeviceEvent<"devices.triggered_low_battery">
+type Distribute<EventType> = EventType extends SeamEvent["event_type"]
+  ? {
+      event_type: EventType
+      data: Extract<SeamEvent, { event_type: EventType }>["payload"]
+    }
+  : never
 
-// Access codes
-export type CreateAccessCodeEvent = CommonDeviceEvent<
-  "access_codes.created",
-  {
-    access_code_id: string
-  }
->
-
-// Noise thresholds
-export type NoiseDetectedEvent =
-  CommonDeviceEvent<"noise_thresholds.detected_noise">
-
-export type SeamEvent =
-  | DeviceConnectedEvent
-  | DeviceDisconnectEvent
-  | DeviceTamperEvent
-  | DeviceLowBatteryEvent
-  | CreateAccessCodeEvent
-  | NoiseDetectedEvent
+export type SeamWebhookEvent = Distribute<SeamEvent["event_type"]>