@seamapi/http 1.0.0-rc.1 → 1.0.0-rc.2

package/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021-2023 Seam Labs, Inc.
+Copyright (c) 2021-2024 Seam Labs, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -170,7 +170,7 @@ or create a new empty client session.
 
 A Personal Access Token is scoped to a Seam Console user.
 Obtain one from the Seam Console.
-A workspace id must be provided when using this method
+A workspace ID must be provided when using this method
 and all requests will be scoped to that workspace.
 
 ```ts
@@ -192,7 +192,7 @@ const seam = SeamHttp.fromPersonalAccessToken(
 
 A Console Session Token is used by the Seam Console.
 This authentication method is only used by internal Seam applications.
-A workspace id must be provided when using this method
+A workspace ID must be provided when using this method
 and all requests will be scoped to that workspace.
 
 ```ts
@@ -212,53 +212,62 @@ const seam = SeamHttp.fromConsoleSessionToken(
 ### Action Attempts
 
 Some asynchronous operations, e.g., unlocking a door, return an [action attempt].
-Seam tracks the progress of requested operation and updates the action attempt.
+Seam tracks the progress of the requested operation and updates the action attempt
+when it succeeds or fails.
 
 To make working with action attempts more convenient for applications,
-this library provides the `waitForActionAttempt` option.
+this library provides the `waitForActionAttempt` option and enables it by default.
 
-Pass the option per-request,
+When the `waitForActionAttempt` option is enabled, the SDK:
+
+- Polls the action attempt up to the `timeout`
+  at the `pollingInterval` (both in milliseconds).
+- Resolves with a fresh copy of the successful action attempt.
+- Rejects with a `SeamActionAttemptFailedError` if the action attempt is unsuccessful.
+- Rejects with a `SeamActionAttemptTimeoutError` if the action attempt is still pending when the `timeout` is reached.
+- Both errors expose an `actionAttempt` property.
+
+If you already have an action attempt ID
+and want to wait for it to resolve, simply use
 
 ```ts
-await seam.locks.unlockDoor(
-  { device_id },
+await seam.actionAttempts.get({ action_attempt_id })
+```
+
+Or, to get the current state of an action attempt by ID without waiting,
+
+```ts
+await seam.actionAttempts.get(
+  { action_attempt_id },
   {
-    waitForActionAttempt: true,
+    waitForActionAttempt: false,
   },
 )
 ```
 
-or set the default option for the client:
+To disable this behavior, set the default option for the client,
 
 ```ts
 const seam = new SeamHttp({
   apiKey: 'your-api-key',
-  waitForActionAttempt: true,
+  waitForActionAttempt: false,
 })
 
 await seam.locks.unlockDoor({ device_id })
 ```
 
-If you have already have an action attempt id
-and want to wait for it to resolve, simply use
+or the behavior may be configured per-request,
 
 ```ts
-await seam.actionAttempts.get(
-  { action_attempt_id },
+await seam.locks.unlockDoor(
+  { device_id },
   {
-    waitForActionAttempt: true,
+    waitForActionAttempt: false,
   },
 )
 ```
 
-Using the `waitForActionAttempt` option:
-
-- Polls the action attempt up to the `timeout`
-  at the `pollingInterval` (both in milliseconds).
-- Resolves with a fresh copy of the successful action attempt.
-- Rejects with a `SeamActionAttemptFailedError` if the action attempt is unsuccessful.
-- Rejects with a `SeamActionAttemptTimeoutError` if the action attempt is still pending when the `timeout` is reached.
-- Both errors expose an `actionAttempt` property.
+The `pollingInterval` and `timeout` may be configured for the client or per-request, for example
 
 ```ts
 import {
@@ -267,22 +276,19 @@ import {
   isSeamActionAttemptTimeoutError,
 } from '@seamapi/http/connect'
 
-const seam = new SeamHttp('your-api-key')
+const seam = new SeamHttp('your-api-key', {
+  waitForActionAttempt: {
+    pollingInterval: 1000,
+    timeout: 5000,
+  },
+})
 
 const [lock] = await seam.locks.list()
 
 if (lock == null) throw new Error('No locks in this workspace')
 
 try {
-  await seam.locks.unlockDoor(
-    { device_id: lock.device_id },
-    {
-      waitForActionAttempt: {
-        pollingInterval: 1000,
-        timeout: 5000,
-      },
-    },
-  )
+  await seam.locks.unlockDoor({ device_id: lock.device_id })
   console.log('Door unlocked')
 } catch (err: unknown) {
   if (isSeamActionAttemptFailedError(err)) {

package/dist/connect.cjs

@@ -11,24 +11,13 @@ var axios__default = /*#__PURE__*/_interopDefault(axios);
 var axiosBetterStacktrace__default = /*#__PURE__*/_interopDefault(axiosBetterStacktrace);
 var axiosRetry__default = /*#__PURE__*/_interopDefault(axiosRetry);
 
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
+var __typeError = (msg) => {
+  throw TypeError(msg);
 };
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value);
 
 // src/lib/lts-version.ts
 var seamApiLtsVersion = "1.0.0";
@@ -46,10 +35,8 @@ var sdkHeaders = {
 };
 var parseOptions = (apiKeyOrOptions) => {
   const options = getNormalizedOptions(apiKeyOrOptions);
-  if (isSeamHttpOptionsWithClient(options))
-    return options;
-  if (isSeamHttpMultiWorkspaceOptionsWithClient(options))
-    return options;
+  if (isSeamHttpOptionsWithClient(options)) return options;
+  if (isSeamHttpMultiWorkspaceOptionsWithClient(options)) return options;
   return {
     ...options,
     axiosOptions: {
@@ -70,7 +57,7 @@ var parseOptions = (apiKeyOrOptions) => {
 var getNormalizedOptions = (apiKeyOrOptions) => {
   const options = typeof apiKeyOrOptions === "string" ? { apiKey: apiKeyOrOptions } : apiKeyOrOptions;
   const requestOptions = {
-    waitForActionAttempt: options.waitForActionAttempt ?? false
+    waitForActionAttempt: options.waitForActionAttempt ?? true
   };
   if (isSeamHttpOptionsWithClient(options)) {
     return {
@@ -129,10 +116,8 @@ var isSeamHttpRequestOption = (key) => {
 // src/lib/seam/connect/options.ts
 var isSeamHttpMultiWorkspaceOptionsWithClient = (options) => isSeamHttpOptionsWithClient(options);
 var isSeamHttpOptionsWithClient = (options) => {
-  if (!("client" in options))
-    return false;
-  if (options.client == null)
-    return false;
+  if (!("client" in options)) return false;
+  if (options.client == null) return false;
   const keys = Object.keys(options).filter((k) => k !== "client");
   if (keys.filter((k) => !isSeamHttpRequestOption(k)).length > 0) {
     throw new SeamHttpInvalidOptionsError(
@@ -144,10 +129,8 @@ var isSeamHttpOptionsWithClient = (options) => {
   return true;
 };
 var isSeamHttpOptionsWithApiKey = (options) => {
-  if (!("apiKey" in options))
-    return false;
-  if (options.apiKey == null)
-    return false;
+  if (!("apiKey" in options)) return false;
+  if (options.apiKey == null) return false;
   if ("clientSessionToken" in options && options.clientSessionToken != null) {
     throw new SeamHttpInvalidOptionsError(
       "The clientSessionToken option cannot be used with the apiKey option"
@@ -166,10 +149,8 @@ var isSeamHttpOptionsWithApiKey = (options) => {
   return true;
 };
 var isSeamHttpOptionsWithClientSessionToken = (options) => {
-  if (!("clientSessionToken" in options))
-    return false;
-  if (options.clientSessionToken == null)
-    return false;
+  if (!("clientSessionToken" in options)) return false;
+  if (options.clientSessionToken == null) return false;
   if ("apiKey" in options && options.apiKey != null) {
     throw new SeamHttpInvalidOptionsError(
       "The apiKey option cannot be used with the clientSessionToken option"
@@ -188,10 +169,8 @@ var isSeamHttpOptionsWithClientSessionToken = (options) => {
   return true;
 };
 var isSeamHttpMultiWorkspaceOptionsWithConsoleSessionToken = (options) => {
-  if (!("consoleSessionToken" in options))
-    return false;
-  if (options.consoleSessionToken == null)
-    return false;
+  if (!("consoleSessionToken" in options)) return false;
+  if (options.consoleSessionToken == null) return false;
   if ("apiKey" in options && options.apiKey != null) {
     throw new SeamHttpInvalidOptionsError(
       "The apiKey option cannot be used with the consoleSessionToken option"
@@ -221,10 +200,8 @@ var isSeamHttpOptionsWithConsoleSessionToken = (options) => {
   return true;
 };
 var isSeamHttpMultiWorkspaceOptionsWithPersonalAccessToken = (options) => {
-  if (!("personalAccessToken" in options))
-    return false;
-  if (options.personalAccessToken == null)
-    return false;
+  if (!("personalAccessToken" in options)) return false;
+  if (options.personalAccessToken == null) return false;
   if ("apiKey" in options && options.apiKey != null) {
     throw new SeamHttpInvalidOptionsError(
       "The apiKey option cannot be used with the personalAccessToken option"
@@ -479,8 +456,7 @@ var SeamHttpApiError = class extends Error {
     this.code = type;
     this.statusCode = statusCode;
     this.requestId = requestId;
-    if (data != null)
-      this.data = data;
+    if (data != null) this.data = data;
   }
 };
 var isSeamHttpApiError = (error) => {
@@ -513,30 +489,24 @@ var isSeamHttpInvalidInputError = (error) => {
 
 // src/lib/seam/connect/error-interceptor.ts
 var errorInterceptor = async (err) => {
-  if (!axios.isAxiosError(err))
-    throw err;
+  if (!axios.isAxiosError(err)) throw err;
   const { response } = err;
   const status = response?.status;
   const requestId = getRequestId(err);
-  if (status == null)
-    throw err;
+  if (status == null) throw err;
   if (status === 401) {
     throw new SeamHttpUnauthorizedError(requestId);
   }
-  if (!isApiErrorResponse(response))
-    throw err;
+  if (!isApiErrorResponse(response)) throw err;
   const { type } = response.data.error;
   const args = [response.data.error, status, requestId];
-  if (type === "invalid_input")
-    throw new SeamHttpInvalidInputError(...args);
+  if (type === "invalid_input") throw new SeamHttpInvalidInputError(...args);
   throw new SeamHttpApiError(...args);
 };
 var isApiErrorResponse = (response) => {
-  if (response == null)
-    return false;
+  if (response == null) return false;
   const { headers, data } = response;
-  if (headers == null)
-    return false;
+  if (headers == null) return false;
   const contentType = headers["Content-Type"];
   if (typeof contentType === "string" && !contentType.startsWith("application/json")) {
     return false;
@@ -548,11 +518,9 @@ var isApiErrorResponse = (response) => {
 };
 var getRequestId = (err) => {
   const headers = err.response?.headers;
-  if (headers == null)
-    return "";
+  if (headers == null) return "";
   const requestId = headers["seam-request-id"];
-  if (requestId == null)
-    return "";
+  if (requestId == null) return "";
   return requestId;
 };
 var createClient = (options) => {
@@ -598,8 +566,7 @@ var resolveActionAttempt = async (actionAttempt, actionAttempts, { timeout = 5e3
       timeoutPromise
     ]);
   } finally {
-    if (timeoutRef != null)
-      globalThis.clearTimeout(timeoutRef);
+    if (timeoutRef != null) globalThis.clearTimeout(timeoutRef);
   }
 };
 var pollActionAttempt = async (actionAttempt, actionAttempts, options) => {
@@ -654,11 +621,12 @@ var SeamActionAttemptTimeoutError = class extends SeamActionAttemptError {
 var isSuccessfulActionAttempt = (actionAttempt) => actionAttempt.status === "success";
 var isFailedActionAttempt = (actionAttempt) => actionAttempt.status === "error";
 var _a, _parent, _config;
+_a = Symbol.toStringTag;
 var SeamHttpRequest = class {
   constructor(parent, config) {
     this[_a] = "SeamHttpRequest";
-    __privateAdd(this, _parent, void 0);
-    __privateAdd(this, _config, void 0);
+    __privateAdd(this, _parent);
+    __privateAdd(this, _config);
     __privateSet(this, _parent, parent);
     __privateSet(this, _config, config);
   }
@@ -717,14 +685,12 @@ var SeamHttpRequest = class {
     return await this.execute().finally(onfinally);
   }
 };
-_a = Symbol.toStringTag;
 _parent = new WeakMap();
 _config = new WeakMap();
 var getUrlPrefix = (input) => {
   if (canParseUrl(input)) {
     const url = new URL(input).toString();
-    if (url.endsWith("/"))
-      return url.slice(0, -1);
+    if (url.endsWith("/")) return url.slice(0, -1);
     return url;
   }
   if (globalThis.location != null) {