@seamapi/http 2.23.0 → 2.23.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -474,7 +474,8 @@ default.
474
474
 
475
475
  The Axios client and retry behavior may be configured with custom initiation options
476
476
  via [`axiosOptions`][axiosOptions] and [`axiosRetryOptions`][axiosRetryOptions].
477
- Options are deep merged with the default options.
477
+ Options are shallow merged with the default options:
478
+ each provided top-level option replaces the default value.
478
479
 
479
480
  By default, the SDK makes up to three attempts: the initial request and two
480
481
  retries. Retries are limited to `GET`, `HEAD`, `OPTIONS`, `PUT`, and `DELETE`
@@ -54,3 +54,23 @@ export declare class SeamHttpInvalidInputError extends SeamHttpApiError {
54
54
  * Returns true if the error is a {@link SeamHttpInvalidInputError}.
55
55
  */
56
56
  export declare const isSeamHttpInvalidInputError: (error: unknown) => error is SeamHttpInvalidInputError;
57
+ /**
58
+ * Error thrown when the Seam API returns a success response
59
+ * with an unexpected shape,
60
+ * e.g., a response missing the expected response key.
61
+ */
62
+ export declare class SeamHttpInvalidResponseError extends Error {
63
+ /**
64
+ * Path of the endpoint that returned the invalid response.
65
+ */
66
+ path: string;
67
+ /**
68
+ * Key expected to contain the response data.
69
+ */
70
+ responseKey: string;
71
+ constructor(path: string, responseKey: string, reason: string);
72
+ }
73
+ /**
74
+ * Returns true if the error is a {@link SeamHttpInvalidResponseError}.
75
+ */
76
+ export declare const isSeamHttpInvalidResponseError: (error: unknown) => error is SeamHttpInvalidResponseError;
@@ -83,4 +83,31 @@ export class SeamHttpInvalidInputError extends SeamHttpApiError {
83
83
  export const isSeamHttpInvalidInputError = (error) => {
84
84
  return error instanceof SeamHttpInvalidInputError;
85
85
  };
86
+ /**
87
+ * Error thrown when the Seam API returns a success response
88
+ * with an unexpected shape,
89
+ * e.g., a response missing the expected response key.
90
+ */
91
+ export class SeamHttpInvalidResponseError extends Error {
92
+ /**
93
+ * Path of the endpoint that returned the invalid response.
94
+ */
95
+ path;
96
+ /**
97
+ * Key expected to contain the response data.
98
+ */
99
+ responseKey;
100
+ constructor(path, responseKey, reason) {
101
+ super(`Seam returned an invalid response for ${path}: expected "${responseKey}", ${reason}`);
102
+ this.name = this.constructor.name;
103
+ this.path = path;
104
+ this.responseKey = responseKey;
105
+ }
106
+ }
107
+ /**
108
+ * Returns true if the error is a {@link SeamHttpInvalidResponseError}.
109
+ */
110
+ export const isSeamHttpInvalidResponseError = (error) => {
111
+ return error instanceof SeamHttpInvalidResponseError;
112
+ };
86
113
  //# sourceMappingURL=seam-http-error.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"seam-http-error.js","sourceRoot":"","sources":["../src/lib/seam-http-error.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC;;OAEG;IACH,IAAI,CAAQ;IAEZ,UAAU,CAAQ;IAElB;;;OAGG;IACH,SAAS,CAAQ;IAEjB;;OAEG;IACH,IAAI,CAAU;IAEd,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;QACrC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,IAAI,IAAI,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACpC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAc,EACa,EAAE;IAC7B,OAAO,KAAK,YAAY,gBAAgB,CAAA;AAC1C,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAgB;IACpB,UAAU,CAAK;IAExB,YAAY,SAAiB;QAC3B,MAAM,IAAI,GAAG,cAAc,CAAA;QAC3B,MAAM,MAAM,GAAG,GAAG,CAAA;QAClB,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAA;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAiB;IAErB,iBAAiB,CAA4C;IAEtE,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;QAC3B,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,SAAiB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,OAAO,IAAI,EAAE,CAAA;IACzD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA"}
1
+ {"version":3,"file":"seam-http-error.js","sourceRoot":"","sources":["../src/lib/seam-http-error.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC;;OAEG;IACH,IAAI,CAAQ;IAEZ,UAAU,CAAQ;IAElB;;;OAGG;IACH,SAAS,CAAQ;IAEjB;;OAEG;IACH,IAAI,CAAU;IAEd,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;QACrC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,IAAI,IAAI,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACpC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAc,EACa,EAAE;IAC7B,OAAO,KAAK,YAAY,gBAAgB,CAAA;AAC1C,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAgB;IACpB,UAAU,CAAK;IAExB,YAAY,SAAiB;QAC3B,MAAM,IAAI,GAAG,cAAc,CAAA;QAC3B,MAAM,MAAM,GAAG,GAAG,CAAA;QAClB,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAA;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,gBAAgB;IACpD,IAAI,CAAiB;IAErB,iBAAiB,CAA4C;IAEtE,YAAY,KAAe,EAAE,UAAkB,EAAE,SAAiB;QAChE,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;QAC3B,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,SAAiB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,OAAO,IAAI,EAAE,CAAA;IACzD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,KAAc,EACsB,EAAE;IACtC,OAAO,KAAK,YAAY,yBAAyB,CAAA;AACnD,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IACrD;;OAEG;IACH,IAAI,CAAQ;IAEZ;;OAEG;IACH,WAAW,CAAQ;IAEnB,YAAY,IAAY,EAAE,WAAmB,EAAE,MAAc;QAC3D,KAAK,CACH,yCAAyC,IAAI,eAAe,WAAW,MAAM,MAAM,EAAE,CACtF,CAAA;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,KAAc,EACyB,EAAE;IACzC,OAAO,KAAK,YAAY,4BAA4B,CAAA;AACtD,CAAC,CAAA"}
@@ -67,4 +67,10 @@ export declare class SeamHttpRequest<const TResponse, const TResponseKey extends
67
67
  catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null | undefined): Promise<(TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined) | TResult>;
68
68
  finally(onfinally?: (() => void) | null | undefined): Promise<TResponseKey extends keyof TResponse ? TResponse[TResponseKey] : undefined>;
69
69
  }
70
+ /**
71
+ * Reads the response data at the response key,
72
+ * throwing a {@link SeamHttpInvalidResponseError} for a success response
73
+ * that is not an object or does not contain the response key.
74
+ */
75
+ export declare const readResponseData: <TResponse, TResponseKey extends keyof TResponse>(response: TResponse, responseKey: TResponseKey, path: string) => TResponse[TResponseKey];
70
76
  export {};
@@ -1,5 +1,6 @@
1
1
  import { assertValidRequestParameters } from './request-parameters.js';
2
2
  import { resolveActionAttempt, } from './resolve-action-attempt.js';
3
+ import { SeamHttpInvalidResponseError } from './seam-http-error.js';
3
4
  import { serializeUrlSearchParams } from './url-search-params-serializer.js';
4
5
  /**
5
6
  * A lazy request to the Seam API.
@@ -72,7 +73,7 @@ export class SeamHttpRequest {
72
73
  if (this.responseKey === undefined) {
73
74
  return undefined;
74
75
  }
75
- const data = response[this.responseKey];
76
+ const data = readResponseData(response, this.responseKey, this.pathname);
76
77
  if (this.responseKey === 'action_attempt') {
77
78
  const waitForActionAttempt = this.#config.options?.waitForActionAttempt ??
78
79
  this.#parent.defaults.waitForActionAttempt;
@@ -111,8 +112,22 @@ export class SeamHttpRequest {
111
112
  return await this.execute().finally(onfinally);
112
113
  }
113
114
  }
115
+ /**
116
+ * Reads the response data at the response key,
117
+ * throwing a {@link SeamHttpInvalidResponseError} for a success response
118
+ * that is not an object or does not contain the response key.
119
+ */
120
+ export const readResponseData = (response, responseKey, path) => {
121
+ if (response == null || typeof response !== 'object') {
122
+ throw new SeamHttpInvalidResponseError(path, String(responseKey), `got ${response === null ? 'null' : typeof response} instead of a response object`);
123
+ }
124
+ if (!(responseKey in response)) {
125
+ throw new SeamHttpInvalidResponseError(path, String(responseKey), 'which the response does not contain');
126
+ }
127
+ return response[responseKey];
128
+ };
114
129
  const getUrlPrefix = (input) => {
115
- if (canParseUrl(input)) {
130
+ if (isAbsoluteHttpUrl(input)) {
116
131
  const url = new URL(input).toString();
117
132
  if (url.endsWith('/'))
118
133
  return url.slice(0, -1);
@@ -126,11 +141,13 @@ const getUrlPrefix = (input) => {
126
141
  }
127
142
  throw new Error(`Cannot resolve origin from ${input} in a non-browser environment`);
128
143
  };
129
- // UPSTREAM: Prefer URL.canParse when it has wider support.
130
- // https://caniuse.com/mdn-api_url_canparse_static
131
- const canParseUrl = (input) => {
144
+ // An input without an http or https scheme, e.g., localhost:3000,
145
+ // may still parse as a URL with an unintended scheme, e.g., localhost:,
146
+ // and must not be treated as an absolute URL.
147
+ const isAbsoluteHttpUrl = (input) => {
132
148
  try {
133
- return new URL(input) != null;
149
+ const { protocol } = new URL(input);
150
+ return protocol === 'http:' || protocol === 'https:';
134
151
  }
135
152
  catch {
136
153
  return false;
@@ -1 +1 @@
1
- {"version":3,"file":"seam-http-request.js","sourceRoot":"","sources":["../src/lib/seam-http-request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,EAEL,oBAAoB,GACrB,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAqB5E;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,eAAe;IAMjB,CAAC,MAAM,CAAC,WAAW,CAAC,GAAW,iBAAiB,CAAA;IAEhD,OAAO,CAAuB;IAC9B,OAAO,CAAqC;IAErD,YACE,MAA6B,EAC7B,MAA2C;QAE3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;IACjC,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,GAAG;QACZ,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE/B,MAAM,UAAU,GACd,OAAO,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAK,UAAU;YACpD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB;YAClC,CAAC,CAAC,wBAAwB,CAAA;QAE9B,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAA;QAE1D,MAAM,IAAI,GACR,IAAI,CAAC,MAAM,IAAI,IAAI;YACjB,CAAC,CAAC,IAAI,CAAC,QAAQ;YACf,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAA;QAEnD,OAAO,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAA;IACpC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;YAC1C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ;YACvB,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IACjC,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QAGX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAM3C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,SAAqB,CAAA;QAC9B,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAwB,CAAA;QAE9D,IAAI,IAAI,CAAC,WAAW,KAAK,gBAAgB,EAAE,CAAC;YAC1C,MAAM,oBAAoB,GACxB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB;gBAC1C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAA;YAE5C,IAAI,oBAAoB,KAAK,KAAK,EAAE,CAAC;gBACnC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;oBACxC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAA;gBACH,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAC9C,IAAgC,EAChC,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B,OAAO,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CACtE,CAAA;gBACD,OAAO,aAAyB,CAAA;YAClC,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QACjB,4BAA4B,CAC1B,IAAI,CAAC,OAAO,CAAC,UAAU,EACvB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,OAAO,CAAC,qBAAqB,IAAI,KAAK,EAC3C,IAAI,CAAC,OAAO,CAAC,sBAAsB,IAAI,EAAE,CAC1C,CAAA;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAC/B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAA4B,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,IAAI,CAMR,WAOa,EACb,UAGa;QAEb,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,KAAK,CACT,UAC0E;QAO1E,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAA2C;QAI3C,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAChD,CAAC;CACF;AAED,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE;IAC7C,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;QACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAA;QAC5D,OAAO,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;aACvD,QAAQ,EAAE;aACV,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACvB,CAAC;IACD,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,+BAA+B,CACnE,CAAA;AACH,CAAC,CAAA;AAED,2DAA2D;AAC3D,kDAAkD;AAClD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAW,EAAE;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAA;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA"}
1
+ {"version":3,"file":"seam-http-request.js","sourceRoot":"","sources":["../src/lib/seam-http-request.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,EAEL,oBAAoB,GACrB,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAqB5E;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,eAAe;IAMjB,CAAC,MAAM,CAAC,WAAW,CAAC,GAAW,iBAAiB,CAAA;IAEhD,OAAO,CAAuB;IAC9B,OAAO,CAAqC;IAErD,YACE,MAA6B,EAC7B,MAA2C;QAE3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;IACjC,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;IAC5C,CAAC;IAED;;OAEG;IACH,IAAW,GAAG;QACZ,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE/B,MAAM,UAAU,GACd,OAAO,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAK,UAAU;YACpD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB;YAClC,CAAC,CAAC,wBAAwB,CAAA;QAE9B,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAA;QAE1D,MAAM,IAAI,GACR,IAAI,CAAC,MAAM,IAAI,IAAI;YACjB,CAAC,CAAC,IAAI,CAAC,QAAQ;YACf,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAA;QAEnD,OAAO,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAA;IACpC,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;YAC1C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ;YACvB,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IACjC,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QAGX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAA;QAM3C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,SAAqB,CAAA;QAC9B,CAAC;QAED,MAAM,IAAI,GAAG,gBAAgB,CAC3B,QAAQ,EACR,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,QAAQ,CACF,CAAA;QAEb,IAAI,IAAI,CAAC,WAAW,KAAK,gBAAgB,EAAE,CAAC;YAC1C,MAAM,oBAAoB,GACxB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB;gBAC1C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAA;YAE5C,IAAI,oBAAoB,KAAK,KAAK,EAAE,CAAC;gBACnC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;oBACxC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAA;gBACH,CAAC;gBACD,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAC9C,IAAgC,EAChC,IAAI,CAAC,OAAO,CAAC,cAAc,EAC3B,OAAO,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CACtE,CAAA;gBACD,OAAO,aAAyB,CAAA;YAClC,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa;QACjB,4BAA4B,CAC1B,IAAI,CAAC,OAAO,CAAC,UAAU,EACvB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,OAAO,CAAC,qBAAqB,IAAI,KAAK,EAC3C,IAAI,CAAC,OAAO,CAAC,sBAAsB,IAAI,EAAE,CAC1C,CAAA;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAC/B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YACpC,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAA4B,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,IAAI,CAMR,WAOa,EACb,UAGa;QAEb,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,KAAK,CACT,UAC0E;QAO1E,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CACX,SAA2C;QAI3C,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAChD,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAI9B,QAAmB,EACnB,WAAyB,EACzB,IAAY,EACa,EAAE;IAC3B,IAAI,QAAQ,IAAI,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACrD,MAAM,IAAI,4BAA4B,CACpC,IAAI,EACJ,MAAM,CAAC,WAAW,CAAC,EACnB,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,QAAQ,+BAA+B,CACnF,CAAA;IACH,CAAC;IAED,IAAI,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,4BAA4B,CACpC,IAAI,EACJ,MAAM,CAAC,WAAW,CAAC,EACnB,qCAAqC,CACtC,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAC,WAAW,CAAC,CAAA;AAC9B,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE;IAC7C,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;QACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAC9C,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAA;QAC5D,OAAO,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;aACvD,QAAQ,EAAE;aACV,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACvB,CAAC;IACD,MAAM,IAAI,KAAK,CACb,8BAA8B,KAAK,+BAA+B,CACnE,CAAA;AACH,CAAC,CAAA;AAED,kEAAkE;AAClE,wEAAwE;AACxE,8CAA8C;AAC9C,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAW,EAAE;IACnD,IAAI,CAAC;QACH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;QACnC,OAAO,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,QAAQ,CAAA;IACtD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA"}
@@ -1,4 +1,5 @@
1
- import { SeamHttpRequest } from './seam-http-request.js';
1
+ import { SeamHttpInvalidResponseError } from './seam-http-error.js';
2
+ import { readResponseData, SeamHttpRequest } from './seam-http-request.js';
2
3
  /**
3
4
  * Iterates over paginated results from Seam API list endpoints.
4
5
  *
@@ -51,20 +52,20 @@ export class SeamPaginator {
51
52
  : undefined,
52
53
  });
53
54
  const response = await request.fetchResponse();
54
- const data = response[responseKey];
55
- const paginationData = response != null &&
56
- typeof response === 'object' &&
57
- 'pagination' in response
58
- ? response.pagination
59
- : null;
60
- const pagination = {
61
- hasNextPage: paginationData?.has_next_page ?? false,
62
- nextPageCursor: paginationData?.next_page_cursor ?? null,
63
- nextPageUrl: paginationData?.next_page_url ?? null,
64
- };
55
+ const data = readResponseData(response, responseKey, request.pathname);
65
56
  if (!Array.isArray(data)) {
66
- throw new Error(`Expected an array response for ${String(responseKey)} but got ${String(typeof data)}`);
57
+ throw new SeamHttpInvalidResponseError(request.pathname, String(responseKey), `got ${data === null ? 'null' : typeof data} instead of a list`);
58
+ }
59
+ const paginationData = readResponseData(response, 'pagination', request.pathname);
60
+ if (paginationData === null || typeof paginationData !== 'object') {
61
+ throw new SeamHttpInvalidResponseError(request.pathname, 'pagination', `got ${paginationData === null ? 'null' : typeof paginationData} instead of a pagination object`);
67
62
  }
63
+ const paginationResponse = paginationData;
64
+ const pagination = {
65
+ hasNextPage: paginationResponse.has_next_page ?? false,
66
+ nextPageCursor: paginationResponse.next_page_cursor ?? null,
67
+ nextPageUrl: paginationResponse.next_page_url ?? null,
68
+ };
68
69
  return [
69
70
  data,
70
71
  pagination,
@@ -1 +1 @@
1
- {"version":3,"file":"seam-paginator.js","sourceRoot":"","sources":["../src/lib/seam-paginator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAoBxD;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAa;IAIf,QAAQ,CAA0C;IAClD,OAAO,CAAqB;IAErC,YACE,MAA2B,EAC3B,OAAiD;QAEjD,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,OAAO,OAAO,CAAC,QAAQ,uCAAuC,CAC/D,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QAGb,OAAO,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,cAA4C;QAE5C,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;QACxE,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CACV,cAA6C;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAA;QAE7C,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,eAAe,CAA0B,IAAI,CAAC,OAAO,EAAE;YACzE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;YAChC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,WAAW;YACX,MAAM,EACJ,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI;gBAC1B,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1D,CAAC,CAAC,SAAS;YACf,IAAI,EACF,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI;gBACxB,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE;gBACxD,CAAC,CAAC,SAAS;SAChB,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;QAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAA;QAElC,MAAM,cAAc,GAClB,QAAQ,IAAI,IAAI;YAChB,OAAO,QAAQ,KAAK,QAAQ;YAC5B,YAAY,IAAI,QAAQ;YACtB,CAAC,CAAE,QAAQ,CAAC,UAA6B;YACzC,CAAC,CAAC,IAAI,CAAA;QAEV,MAAM,UAAU,GAAe;YAC7B,WAAW,EAAE,cAAc,EAAE,aAAa,IAAI,KAAK;YACnD,cAAc,EAAE,cAAc,EAAE,gBAAgB,IAAI,IAAI;YACxD,WAAW,EAAE,cAAc,EAAE,aAAa,IAAI,IAAI;SACnD,CAAA;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,kCAAkC,MAAM,CAAC,WAAW,CAAC,YAAY,MAAM,CAAC,OAAO,IAAI,CAAC,EAAE,CACvF,CAAA;QACH,CAAC;QAED,OAAO;YACL,IAAoD;YACpD,UAAU;SACF,CAAA;IACZ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAGlB,MAAM,KAAK,GAAG,EAAiD,CAAA;QAC/D,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACtB,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,CAAC;QACD,OAAO,KAAqD,CAAA;IAC9D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,OAAO;QAGZ,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAA;QACZ,CAAC;QACD,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC3B,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAG3B,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,MAAM,OAAO,CAAA;QACb,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,MAAM,OAAO,CAAA;QACf,CAAC;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"seam-paginator.js","sourceRoot":"","sources":["../src/lib/seam-paginator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAoB1E;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAa;IAIf,QAAQ,CAA0C;IAClD,OAAO,CAAqB;IAErC,YACE,MAA2B,EAC3B,OAAiD;QAEjD,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,OAAO,OAAO,CAAC,QAAQ,uCAAuC,CAC/D,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QAGb,OAAO,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,cAA4C;QAE5C,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;QACxE,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CACV,cAA6C;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAA;QAE7C,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,eAAe,CAA0B,IAAI,CAAC,OAAO,EAAE;YACzE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;YAChC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,WAAW;YACX,MAAM,EACJ,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI;gBAC1B,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1D,CAAC,CAAC,SAAS;YACf,IAAI,EACF,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI;gBACxB,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE;gBACxD,CAAC,CAAC,SAAS;SAChB,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,EAAE,CAAA;QAC9C,MAAM,IAAI,GAAG,gBAAgB,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QAEtE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,4BAA4B,CACpC,OAAO,CAAC,QAAQ,EAChB,MAAM,CAAC,WAAW,CAAC,EACnB,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,oBAAoB,CAChE,CAAA;QACH,CAAC;QAED,MAAM,cAAc,GAAG,gBAAgB,CACrC,QAAmC,EACnC,YAAY,EACZ,OAAO,CAAC,QAAQ,CACjB,CAAA;QAED,IAAI,cAAc,KAAK,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YAClE,MAAM,IAAI,4BAA4B,CACpC,OAAO,CAAC,QAAQ,EAChB,YAAY,EACZ,OAAO,cAAc,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,cAAc,iCAAiC,CACjG,CAAA;QACH,CAAC;QAED,MAAM,kBAAkB,GAAG,cAAgC,CAAA;QAE3D,MAAM,UAAU,GAAe;YAC7B,WAAW,EAAE,kBAAkB,CAAC,aAAa,IAAI,KAAK;YACtD,cAAc,EAAE,kBAAkB,CAAC,gBAAgB,IAAI,IAAI;YAC3D,WAAW,EAAE,kBAAkB,CAAC,aAAa,IAAI,IAAI;SACtD,CAAA;QAED,OAAO;YACL,IAAoD;YACpD,UAAU;SACF,CAAA;IACZ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAGlB,MAAM,KAAK,GAAG,EAAiD,CAAA;QAC/D,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACtB,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,CAAC;QACD,OAAO,KAAqD,CAAA;IAC9D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,OAAO;QAGZ,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAA;QACZ,CAAC;QACD,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;gBAC3B,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAG3B,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAA;QAClD,MAAM,OAAO,CAAA;QACb,OAAO,UAAU,CAAC,WAAW,EAAE,CAAC;YAC9B,CAAC;YAAA,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACvE,MAAM,OAAO,CAAA;QACf,CAAC;IACH,CAAC;CACF"}
package/lib/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const seamapiJavascriptHttpVersion = "2.23.0";
1
+ declare const seamapiJavascriptHttpVersion = "2.23.2";
2
2
  export default seamapiJavascriptHttpVersion;
package/lib/version.js CHANGED
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.23.0';
1
+ const seamapiJavascriptHttpVersion = '2.23.2';
2
2
  export default seamapiJavascriptHttpVersion;
3
3
  //# sourceMappingURL=version.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/http",
3
- "version": "2.23.0",
3
+ "version": "2.23.2",
4
4
  "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -103,3 +103,38 @@ export const isSeamHttpInvalidInputError = (
103
103
  ): error is SeamHttpInvalidInputError => {
104
104
  return error instanceof SeamHttpInvalidInputError
105
105
  }
106
+
107
+ /**
108
+ * Error thrown when the Seam API returns a success response
109
+ * with an unexpected shape,
110
+ * e.g., a response missing the expected response key.
111
+ */
112
+ export class SeamHttpInvalidResponseError extends Error {
113
+ /**
114
+ * Path of the endpoint that returned the invalid response.
115
+ */
116
+ path: string
117
+
118
+ /**
119
+ * Key expected to contain the response data.
120
+ */
121
+ responseKey: string
122
+
123
+ constructor(path: string, responseKey: string, reason: string) {
124
+ super(
125
+ `Seam returned an invalid response for ${path}: expected "${responseKey}", ${reason}`,
126
+ )
127
+ this.name = this.constructor.name
128
+ this.path = path
129
+ this.responseKey = responseKey
130
+ }
131
+ }
132
+
133
+ /**
134
+ * Returns true if the error is a {@link SeamHttpInvalidResponseError}.
135
+ */
136
+ export const isSeamHttpInvalidResponseError = (
137
+ error: unknown,
138
+ ): error is SeamHttpInvalidResponseError => {
139
+ return error instanceof SeamHttpInvalidResponseError
140
+ }
@@ -8,6 +8,7 @@ import {
8
8
  resolveActionAttempt,
9
9
  } from './resolve-action-attempt.js'
10
10
  import type { ActionAttempt } from './resources/action-attempt.js'
11
+ import { SeamHttpInvalidResponseError } from './seam-http-error.js'
11
12
  import { serializeUrlSearchParams } from './url-search-params-serializer.js'
12
13
 
13
14
  interface SeamHttpRequestParent {
@@ -132,7 +133,11 @@ export class SeamHttpRequest<
132
133
  return undefined as Response
133
134
  }
134
135
 
135
- const data = response[this.responseKey] as unknown as Response
136
+ const data = readResponseData(
137
+ response,
138
+ this.responseKey,
139
+ this.pathname,
140
+ ) as Response
136
141
 
137
142
  if (this.responseKey === 'action_attempt') {
138
143
  const waitForActionAttempt =
@@ -222,8 +227,40 @@ export class SeamHttpRequest<
222
227
  }
223
228
  }
224
229
 
230
+ /**
231
+ * Reads the response data at the response key,
232
+ * throwing a {@link SeamHttpInvalidResponseError} for a success response
233
+ * that is not an object or does not contain the response key.
234
+ */
235
+ export const readResponseData = <
236
+ TResponse,
237
+ TResponseKey extends keyof TResponse,
238
+ >(
239
+ response: TResponse,
240
+ responseKey: TResponseKey,
241
+ path: string,
242
+ ): TResponse[TResponseKey] => {
243
+ if (response == null || typeof response !== 'object') {
244
+ throw new SeamHttpInvalidResponseError(
245
+ path,
246
+ String(responseKey),
247
+ `got ${response === null ? 'null' : typeof response} instead of a response object`,
248
+ )
249
+ }
250
+
251
+ if (!(responseKey in response)) {
252
+ throw new SeamHttpInvalidResponseError(
253
+ path,
254
+ String(responseKey),
255
+ 'which the response does not contain',
256
+ )
257
+ }
258
+
259
+ return response[responseKey]
260
+ }
261
+
225
262
  const getUrlPrefix = (input: string): string => {
226
- if (canParseUrl(input)) {
263
+ if (isAbsoluteHttpUrl(input)) {
227
264
  const url = new URL(input).toString()
228
265
  if (url.endsWith('/')) return url.slice(0, -1)
229
266
  return url
@@ -239,11 +276,13 @@ const getUrlPrefix = (input: string): string => {
239
276
  )
240
277
  }
241
278
 
242
- // UPSTREAM: Prefer URL.canParse when it has wider support.
243
- // https://caniuse.com/mdn-api_url_canparse_static
244
- const canParseUrl = (input: string): boolean => {
279
+ // An input without an http or https scheme, e.g., localhost:3000,
280
+ // may still parse as a URL with an unintended scheme, e.g., localhost:,
281
+ // and must not be treated as an absolute URL.
282
+ const isAbsoluteHttpUrl = (input: string): boolean => {
245
283
  try {
246
- return new URL(input) != null
284
+ const { protocol } = new URL(input)
285
+ return protocol === 'http:' || protocol === 'https:'
247
286
  } catch {
248
287
  return false
249
288
  }
@@ -1,6 +1,7 @@
1
1
  import type { Client } from './client.js'
2
2
  import type { SeamHttpRequestOptions } from './options.js'
3
- import { SeamHttpRequest } from './seam-http-request.js'
3
+ import { SeamHttpInvalidResponseError } from './seam-http-error.js'
4
+ import { readResponseData, SeamHttpRequest } from './seam-http-request.js'
4
5
 
5
6
  interface SeamPaginatorParent {
6
7
  readonly client: Client
@@ -96,27 +97,38 @@ export class SeamPaginator<
96
97
  })
97
98
 
98
99
  const response = await request.fetchResponse()
99
- const data = response[responseKey]
100
+ const data = readResponseData(response, responseKey, request.pathname)
100
101
 
101
- const paginationData =
102
- response != null &&
103
- typeof response === 'object' &&
104
- 'pagination' in response
105
- ? (response.pagination as PaginationData)
106
- : null
107
-
108
- const pagination: Pagination = {
109
- hasNextPage: paginationData?.has_next_page ?? false,
110
- nextPageCursor: paginationData?.next_page_cursor ?? null,
111
- nextPageUrl: paginationData?.next_page_url ?? null,
102
+ if (!Array.isArray(data)) {
103
+ throw new SeamHttpInvalidResponseError(
104
+ request.pathname,
105
+ String(responseKey),
106
+ `got ${data === null ? 'null' : typeof data} instead of a list`,
107
+ )
112
108
  }
113
109
 
114
- if (!Array.isArray(data)) {
115
- throw new Error(
116
- `Expected an array response for ${String(responseKey)} but got ${String(typeof data)}`,
110
+ const paginationData = readResponseData(
111
+ response as { pagination: unknown },
112
+ 'pagination',
113
+ request.pathname,
114
+ )
115
+
116
+ if (paginationData === null || typeof paginationData !== 'object') {
117
+ throw new SeamHttpInvalidResponseError(
118
+ request.pathname,
119
+ 'pagination',
120
+ `got ${paginationData === null ? 'null' : typeof paginationData} instead of a pagination object`,
117
121
  )
118
122
  }
119
123
 
124
+ const paginationResponse = paginationData as PaginationData
125
+
126
+ const pagination: Pagination = {
127
+ hasNextPage: paginationResponse.has_next_page ?? false,
128
+ nextPageCursor: paginationResponse.next_page_cursor ?? null,
129
+ nextPageUrl: paginationResponse.next_page_url ?? null,
130
+ }
131
+
120
132
  return [
121
133
  data as EnsureReadonlyArray<TResponse[TResponseKey]>,
122
134
  pagination,
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.23.0'
1
+ const seamapiJavascriptHttpVersion = '2.23.2'
2
2
 
3
3
  export default seamapiJavascriptHttpVersion