Merge branch 'main' into feat-cli

Author: codetheweb

docs/classes/SeamActionAttemptError.md

@@ -0,0 +1,190 @@
+[seamapi](../README.md) / [Exports](../modules.md) / SeamActionAttemptError
+
+# Class: SeamActionAttemptError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`SeamActionAttemptError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SeamActionAttemptError.md#constructor)
+
+### Properties
+
+- [action\_type](SeamActionAttemptError.md#action_type)
+- [message](SeamActionAttemptError.md#message)
+- [name](SeamActionAttemptError.md#name)
+- [stack](SeamActionAttemptError.md#stack)
+- [type](SeamActionAttemptError.md#type)
+- [prepareStackTrace](SeamActionAttemptError.md#preparestacktrace)
+- [stackTraceLimit](SeamActionAttemptError.md#stacktracelimit)
+
+### Methods
+
+- [toString](SeamActionAttemptError.md#tostring)
+- [captureStackTrace](SeamActionAttemptError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new SeamActionAttemptError**(`type`, `message`, `action_type`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | `string` |
+| `message` | `string` |
+| `action_type` | `string` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[src/lib/api-error.ts:22](https://github.com/hello-seam/seamapi-javascript/blob/main/src/lib/api-error.ts#L22)
+
+## Properties
+
+### action\_type
+
+• **action\_type**: `string`
+
+___
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### type
+
+• **type**: `string`
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### toString
+
+▸ **toString**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/lib/api-error.ts:34](https://github.com/hello-seam/seamapi-javascript/blob/main/src/lib/api-error.ts#L34)
+
+___
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

docs/classes/default.md

@@ -70,7 +70,7 @@ Routes.accessCodes
 
 #### Defined in
 
-[src/routes.ts:162](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L162)
+[src/routes.ts:168](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L168)
 
 ___
 
@@ -90,7 +90,7 @@ Routes.actionAttempts
 
 #### Defined in
 
-[src/routes.ts:219](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L219)
+[src/routes.ts:227](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L227)
 
 ___
 
@@ -122,7 +122,7 @@ Routes.connectWebviews
 
 #### Defined in
 
-[src/routes.ts:142](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L142)
+[src/routes.ts:148](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L148)
 
 ___
 
@@ -143,7 +143,7 @@ Routes.connectedAccounts
 
 #### Defined in
 
-[src/routes.ts:204](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L204)
+[src/routes.ts:212](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L212)
 
 ___
 
@@ -164,7 +164,7 @@ Routes.devices
 
 #### Defined in
 
-[src/routes.ts:123](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L123)
+[src/routes.ts:129](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L129)
 
 ___
 
@@ -187,7 +187,7 @@ Routes.locks
 
 #### Defined in
 
-[src/routes.ts:88](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L88)
+[src/routes.ts:94](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L94)
 
 ___
 
@@ -209,7 +209,7 @@ Routes.workspaces
 
 #### Defined in
 
-[src/routes.ts:72](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L72)
+[src/routes.ts:78](https://github.com/hello-seam/seamapi-javascript/blob/main/src/routes.ts#L78)
 
 ## Methods
 

docs/modules.md

@@ -11,6 +11,7 @@
 ### Classes
 
 - [SeamAPIError](classes/SeamAPIError.md)
+- [SeamActionAttemptError](classes/SeamActionAttemptError.md)
 - [default](classes/default.md)
 
 ### Interfaces

package.json

@@ -7,7 +7,7 @@
     "iot",
     "device"
   ],
-  "version": "2.0.0",
+  "version": "2.0.1",
   "license": "MIT",
   "sideEffects": false,
   "main": "./cjs-wrapper.js",

src/lib/api-error.ts

@@ -17,3 +17,21 @@ export class SeamAPIError extends Error {
     return `SeamAPIError: ${this.status}, ${this.metadata?.message} (${this.metadata?.type})`
   }
 }
+
+export class SeamActionAttemptError extends Error {
+  constructor(
+    public type: string,
+    public message: string,
+    public action_type: string
+  ) {
+    super(`${type} performing ${action_type}: ${message}`)
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, this.constructor)
+    }
+  }
+
+  toString() {
+    return `SeamActionAttemptError: ${this.type} performing ${this.action_type}: ${this.message}`
+  }
+}

src/routes.ts

@@ -13,6 +13,7 @@ import {
   AccessCodeCreateScheduledRequest,
   ConnectWebviewCreateRequest,
 } from "./types/route-requests"
+import { SeamActionAttemptError } from "./lib/api-error"
 
 type Promisable<T> = T | Promise<T>
 
@@ -40,6 +41,13 @@ export abstract class Routes {
       if (actionAttempt.status !== "pending") break
       await new Promise((resolve) => setTimeout(resolve, 250))
     }
+    if (actionAttempt.status === "error") {
+      throw new SeamActionAttemptError(
+        actionAttempt.error.type,
+        actionAttempt.error.message,
+        actionAttempt.action_type
+      )
+    }
     return actionAttempt as SuccessfulActionAttempt<T>
   }
 
@@ -62,11 +70,9 @@ export abstract class Routes {
       "action_attempt",
       request
     )
-    const successfulActionAttempt = await this.awaitActionAttempt<T>(
-      pendingActionAttempt
-    )
-    if (innerObjectName === null) return successfulActionAttempt.result as any
-    return (successfulActionAttempt as any).result[innerObjectName]
+    const actionAttempt = await this.awaitActionAttempt<T>(pendingActionAttempt)
+    if (innerObjectName === null) return actionAttempt.result as any
+    return (actionAttempt as any).result[innerObjectName]
   }
 
   public readonly workspaces = {
@@ -170,16 +176,18 @@ export abstract class Routes {
       const parsedParams: any = Object.assign({}, params)
 
       if (
-        typeof (params as AccessCodeCreateScheduledRequest).starts_at ===
-        "object"
+        (params as AccessCodeCreateScheduledRequest).starts_at === "object" &&
+        (params as AccessCodeCreateScheduledRequest).starts_at !== null
       ) {
         parsedParams.starts_at = (
           (params as AccessCodeCreateScheduledRequest).starts_at as Date
         ).toISOString()
       }
 
       if (
-        typeof (params as AccessCodeCreateScheduledRequest).ends_at === "object"
+        typeof (params as AccessCodeCreateScheduledRequest).ends_at ===
+          "object" &&
+        (params as AccessCodeCreateScheduledRequest).starts_at !== null
       ) {
         parsedParams.ends_at = (
           (params as AccessCodeCreateScheduledRequest).ends_at as Date