feat: Merge pull request #33 from seamapi/feat-login-flow

Author: codetheweb

docs/classes/Seam.md

@@ -95,7 +95,7 @@ ___
 
 ### client
 
-• `Private` **client**: `AxiosInstance`
+• **client**: `AxiosInstance`
 
 #### Defined in
 

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

@@ -42,6 +42,7 @@
     "node-inspect-extracted": "1.1.0",
     "ora": "5.4.1",
     "p-retry": "4.6.1",
+    "prompts": "2.4.2",
     "svix": "0.54.2",
     "typed-emitter": "2.1.0",
     "yargs": "17.3.1"
@@ -56,6 +57,7 @@
     "@types/lodash": "^4.14.179",
     "@types/ms": "0.7.31",
     "@types/node": "17.0.10",
+    "@types/prompts": "2.0.14",
     "@types/uuid": "8.3.4",
     "@types/yargs": "17.0.8",
     "ajv": "8.9.0",
@@ -76,6 +78,7 @@
     "pkg": "5.5.2",
     "playwright": "1.19.2",
     "prettier": "2.5.1",
+    "seamapi-types": "1.1.0",
     "testcontainers": "8.4.0",
     "ts-json-schema-generator": "0.98.0",
     "tsup": "5.11.11",

package.json

@@ -1,5 +1,6 @@
 import { CommandModule } from "yargs"
 import { Provider } from "../../types/models"
+import completeInteractiveLogin from "../lib/interactive-login/complete-interactive-login"
 import executeCommand from "../lib/execute-command"
 import { GlobalOptions } from "../lib/global-options"
 
@@ -32,6 +33,20 @@ const command: CommandModule<GlobalOptions> = {
           await executeCommand("connectWebviews.get", [argv.id], argv)
         }
       )
+      .command(
+        "login <id>",
+        "login to a connect webview",
+        (yargs) => {
+          return yargs.positional("id", {
+            describe: "the connect webview ID",
+            demandOption: true,
+            type: "string",
+          })
+        },
+        async (argv) => {
+          await completeInteractiveLogin(argv.id, argv)
+        }
+      )
       .command(
         "create",
         "create a connect webview",
@@ -44,6 +59,10 @@ const command: CommandModule<GlobalOptions> = {
               choices: Object.values(Provider),
               alias: "ap",
             })
+            .option("login", {
+              describe: "start interactive login flow after creating",
+              type: "boolean",
+            })
             .check((argv) => {
               if (argv["accepted-providers"].length === 0) {
                 throw new Error(
@@ -54,7 +73,7 @@ const command: CommandModule<GlobalOptions> = {
             })
         },
         async (argv) => {
-          await executeCommand(
+          const { connect_webview_id } = await executeCommand(
             "connectWebviews.create",
             [
               {
@@ -63,6 +82,10 @@ const command: CommandModule<GlobalOptions> = {
             ],
             argv
           )
+
+          if (argv.login) {
+            await completeInteractiveLogin(connect_webview_id, argv)
+          }
         }
       )
   },

src/cli/commands/connect-webviews.ts

@@ -4,6 +4,7 @@ import { paramCase } from "change-case"
 import Seam, { SeamAPIError } from "../.."
 import { GlobalOptions } from "./global-options"
 import _ from "lodash"
+import getClientFromArgs from "./get-client-from-args"
 
 type ParametersByPath<Path extends string> = Parameters<
   Exclude<Get<Seam, Path>, Seam>
@@ -33,16 +34,7 @@ const executeCommand = async <MethodPath extends string>(
       .start()
   }
 
-  const seam = new Seam(
-    _.omitBy(
-      {
-        apiKey: executeArgs["api-key"],
-        endpoint: executeArgs["endpoint"],
-        workspaceId: executeArgs["workspace-id"],
-      },
-      _.isUndefined
-    )
-  )
+  const seam = getClientFromArgs(executeArgs)
 
   let method: any = seam
   for (const path of methodName.split(".")) {
@@ -62,6 +54,7 @@ const executeCommand = async <MethodPath extends string>(
     }
 
     process.stdout.write("\n")
+    return result
   } catch (error) {
     let message = "Unknown error"
     if (error instanceof SeamAPIError) {

src/cli/lib/execute-command.ts

@@ -0,0 +1,18 @@
+import _ from "lodash"
+import { Seam } from "../.."
+import { GlobalOptions } from "./global-options"
+
+const getClientFromArgs = (options: GlobalOptions) => {
+  return new Seam(
+    _.omitBy(
+      {
+        apiKey: options["api-key"],
+        endpoint: options["endpoint"],
+        workspaceId: options["workspace-id"],
+      },
+      _.isUndefined
+    )
+  )
+}
+
+export default getClientFromArgs

src/cli/lib/get-client-from-args.ts

@@ -0,0 +1,71 @@
+import type ora from "ora"
+import getClientFromArgs from "../get-client-from-args"
+import { GlobalOptions } from "../global-options"
+import panes from "./panes"
+import { formatErrorMsg } from "./utils"
+
+const completeInteractiveLogin = async (
+  connectWebviewId: string,
+  args: GlobalOptions
+) => {
+  const { client } = getClientFromArgs(args)
+
+  const displaySpinner = typeof window === "undefined" && !args.quiet
+  let spinner: ora.Ora | undefined
+  if (displaySpinner) {
+    // Dynamic import so we don't bundle this for the browser
+    const ora = await import("ora")
+
+    spinner = ora.default("Logging in...")
+  }
+
+  let submit_args: any
+  while (true) {
+    console.clear()
+
+    try {
+      spinner?.start("Loading...")
+      const { data } = await client.post(
+        "/internal/connect_webviews/login/next",
+        {
+          connect_webview_id: connectWebviewId,
+          submit_args,
+        }
+      )
+      spinner?.stop()
+
+      const currentPane = data.pane
+
+      if (currentPane.name === "finished_pane") {
+        if (currentPane.render_props.error_msg) {
+          throw new Error(currentPane.render_props.error_msg)
+        }
+
+        break
+      }
+
+      const handler = panes.find((p) => p.name === currentPane.name)
+      if (!handler) {
+        throw new Error(`Unknown pane ${currentPane.name}`)
+      }
+
+      if (currentPane.render_props.error_msg) {
+        console.error(formatErrorMsg(currentPane.render_props.error_msg))
+      }
+
+      submit_args = await handler.getInput(currentPane.render_props)
+    } catch (error) {
+      if (spinner) {
+        spinner.fail((error as Error).message)
+      } else {
+        console.error(error)
+      }
+
+      process.exit(1)
+    }
+  }
+
+  spinner?.succeed("🎉 login successful!")
+}
+
+export default completeInteractiveLogin