ce-storefront 0.13.2 → 0.14.0

package/src/funcs/ordersRetryOrderPayment.ts

@@ -10,7 +10,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
-import { CeError } from "../models/errors/ceerror.js";
+import { CeStorefrontError } from "../models/errors/cestorefronterror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -19,6 +19,7 @@ import {
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
 import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
@@ -40,13 +41,14 @@ export function ordersRetryOrderPayment(
     | errors.BadRequest
     | errors.Unauthorized
     | errors.NotFound
-    | CeError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | CeStorefrontError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -67,13 +69,14 @@ async function $do(
       | errors.BadRequest
       | errors.Unauthorized
       | errors.NotFound
-      | CeError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | CeStorefrontError
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -157,13 +160,14 @@ async function $do(
     | errors.BadRequest
     | errors.Unauthorized
     | errors.NotFound
-    | CeError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | CeStorefrontError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.json(200, operations.RetryOrderPaymentResponseBody$inboundSchema),
     M.jsonErr(400, errors.BadRequest$inboundSchema),
@@ -171,7 +175,7 @@ async function $do(
     M.jsonErr(404, errors.NotFound$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, { extraFields: responseFields });
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/shippingShippingMethods.ts

@@ -11,7 +11,7 @@ import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import * as components from "../models/components/index.js";
-import { CeError } from "../models/errors/ceerror.js";
+import { CeStorefrontError } from "../models/errors/cestorefronterror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -20,6 +20,7 @@ import {
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
 import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
@@ -41,13 +42,14 @@ export function shippingShippingMethods(
     | errors.BadRequest
     | errors.Unauthorized
     | errors.NotFound
-    | CeError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | CeStorefrontError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -68,13 +70,14 @@ async function $do(
       | errors.BadRequest
       | errors.Unauthorized
       | errors.NotFound
-      | CeError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | CeStorefrontError
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -152,13 +155,14 @@ async function $do(
     | errors.BadRequest
     | errors.Unauthorized
     | errors.NotFound
-    | CeError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | CeStorefrontError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.json(200, operations.GetShippingMethodsResponseBody$inboundSchema),
     M.jsonErr(400, errors.BadRequest$inboundSchema),
@@ -166,7 +170,7 @@ async function $do(
     M.jsonErr(404, errors.NotFound$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
-  )(response, { extraFields: responseFields });
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/lib/config.ts

@@ -80,7 +80,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.13.2",
-  genVersion: "2.620.2",
-  userAgent: "speakeasy-sdk/typescript 0.13.2 2.620.2 1.0 ce-storefront",
+  sdkVersion: "0.14.0",
+  genVersion: "2.623.0",
+  userAgent: "speakeasy-sdk/typescript 0.14.0 2.623.0 1.0 ce-storefront",
 } as const;

package/src/lib/matchers.ts

@@ -3,11 +3,10 @@
  */
 
 import { CeError } from "../models/errors/ceerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import { Result } from "../types/fp.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { ERR, OK, Result } from "../types/fp.js";
 import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js";
 import { isPlainObject } from "./is-plain-object.js";
-import { safeParse } from "./schemas.js";
 
 export type Encoding =
   | "jsonl"
@@ -176,17 +175,19 @@ export type MatchedError<Matchers> = Matchers extends Matcher<any, infer E>[]
   : never;
 export type MatchFunc<T, E> = (
   response: Response,
+  request: Request,
   options?: { resultKey?: string; extraFields?: Record<string, unknown> },
 ) => Promise<[result: Result<T, E>, raw: unknown]>;
 
 export function match<T, E>(
   ...matchers: Array<Matcher<T, E>>
-): MatchFunc<T, E | CeError | SDKValidationError> {
+): MatchFunc<T, E | CeError | ResponseValidationError> {
   return async function matchFunc(
     response: Response,
+    request: Request,
     options?: { resultKey?: string; extraFields?: Record<string, unknown> },
   ): Promise<
-    [result: Result<T, E | CeError | SDKValidationError>, raw: unknown]
+    [result: Result<T, E | CeError | ResponseValidationError>, raw: unknown]
   > {
     let raw: unknown;
     let matcher: Matcher<T, E> | undefined;
@@ -205,21 +206,22 @@ export function match<T, E>(
     }
 
     if (!matcher) {
-      const responseBody = await response.text();
       return [{
         ok: false,
-        error: new CeError(
-          "Unexpected API response status or content-type",
+        error: new CeError("Unexpected Status or Content-Type", {
           response,
-          responseBody,
-        ),
-      }, responseBody];
+          request,
+          body: await response.text().catch(() => ""),
+        }),
+      }, raw];
     }
 
     const encoding = matcher.enc;
+    let body = "";
     switch (encoding) {
       case "json":
-        raw = await response.json();
+        body = await response.text();
+        raw = JSON.parse(body);
         break;
       case "jsonl":
         raw = response.body;
@@ -231,16 +233,19 @@ export function match<T, E>(
         raw = response.body;
         break;
       case "text":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       case "sse":
         raw = response.body;
         break;
       case "nil":
-        raw = await discardResponseBody(response);
+        body = await response.text();
+        raw = undefined;
         break;
       case "fail":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       default:
         encoding satisfies never;
@@ -250,11 +255,7 @@ export function match<T, E>(
     if (matcher.enc === "fail") {
       return [{
         ok: false,
-        error: new CeError(
-          "API error occurred",
-          response,
-          typeof raw === "string" ? raw : "",
-        ),
+        error: new CeError("API error occurred", { request, response, body }),
       }, raw];
     }
 
@@ -266,6 +267,9 @@ export function match<T, E>(
         ...options?.extraFields,
         ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
         ...(isPlainObject(raw) ? raw : null),
+        request$: request,
+        response$: response,
+        body$: body,
       };
     } else if (resultKey) {
       data = {
@@ -284,18 +288,20 @@ export function match<T, E>(
     }
 
     if ("err" in matcher) {
-      const result = safeParse(
+      const result = safeParseResponse(
         data,
         (v: unknown) => matcher.schema.parse(v),
         "Response validation failed",
+        { request, response, body },
       );
       return [result.ok ? { ok: false, error: result.value } : result, raw];
     } else {
       return [
-        safeParse(
+        safeParseResponse(
           data,
           (v: unknown) => matcher.schema.parse(v),
           "Response validation failed",
+          { request, response, body },
         ),
         raw,
       ];
@@ -318,25 +324,22 @@ export function unpackHeaders(headers: Headers): Record<string, string[]> {
   return out;
 }
 
-/**
- * Discards the response body to free up resources.
- *
- * To learn why this is need, see the undici docs:
- * https://undici.nodejs.org/#/?id=garbage-collection
- */
-export async function discardResponseBody(res: Response) {
-  const reader = res.body?.getReader();
-  if (reader == null) {
-    return;
-  }
-
+function safeParseResponse<Inp, Out>(
+  rawValue: Inp,
+  fn: (value: Inp) => Out,
+  errorMessage: string,
+  httpMeta: { response: Response; request: Request; body: string },
+): Result<Out, ResponseValidationError> {
   try {
-    let done = false;
-    while (!done) {
-      const res = await reader.read();
-      done = res.done;
-    }
-  } finally {
-    reader.releaseLock();
+    return OK(fn(rawValue));
+  } catch (err) {
+    return ERR(
+      new ResponseValidationError(errorMessage, {
+        cause: err,
+        rawValue,
+        rawMessage: errorMessage,
+        ...httpMeta,
+      }),
+    );
   }
 }

package/src/models/components/product.ts

@@ -8,6 +8,12 @@ import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Category,
+  Category$inboundSchema,
+  Category$Outbound,
+  Category$outboundSchema,
+} from "./category.js";
 import {
   ProductAttribute,
   ProductAttribute$inboundSchema,
@@ -101,6 +107,7 @@ export type Product = {
   hasVariant: boolean;
   tags: Array<string> | null;
   categoryIds: Array<string>;
+  categories: Array<Category>;
   reviewsRatingSum: number;
   reviewsCount: number;
   attributes: Array<ProductAttribute>;
@@ -153,6 +160,7 @@ export const Product$inboundSchema: z.ZodType<Product, z.ZodTypeDef, unknown> =
     has_variant: z.boolean(),
     tags: z.nullable(z.array(z.string())),
     category_ids: z.array(z.string()),
+    categories: z.array(Category$inboundSchema),
     reviews_rating_sum: z.number(),
     reviews_count: z.number().int(),
     attributes: z.array(ProductAttribute$inboundSchema),
@@ -197,6 +205,7 @@ export type Product$Outbound = {
   has_variant: boolean;
   tags: Array<string> | null;
   category_ids: Array<string>;
+  categories: Array<Category$Outbound>;
   reviews_rating_sum: number;
   reviews_count: number;
   attributes: Array<ProductAttribute$Outbound>;
@@ -230,6 +239,7 @@ export const Product$outboundSchema: z.ZodType<
   hasVariant: z.boolean(),
   tags: z.nullable(z.array(z.string())),
   categoryIds: z.array(z.string()),
+  categories: z.array(Category$outboundSchema),
   reviewsRatingSum: z.number(),
   reviewsCount: z.number().int(),
   attributes: z.array(ProductAttribute$outboundSchema),

package/src/models/components/productdetail.ts

@@ -8,6 +8,12 @@ import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Category,
+  Category$inboundSchema,
+  Category$Outbound,
+  Category$outboundSchema,
+} from "./category.js";
 import {
   ProductAttribute,
   ProductAttribute$inboundSchema,
@@ -121,6 +127,7 @@ export type ProductDetail = {
   hasVariant: boolean;
   tags: Array<string> | null;
   categoryIds: Array<string>;
+  categories: Array<Category>;
   reviewsRatingSum: number;
   reviewsCount: number;
   attributes: Array<ProductAttribute>;
@@ -192,6 +199,7 @@ export const ProductDetail$inboundSchema: z.ZodType<
   has_variant: z.boolean(),
   tags: z.nullable(z.array(z.string())),
   category_ids: z.array(z.string()),
+  categories: z.array(Category$inboundSchema),
   reviews_rating_sum: z.number(),
   reviews_count: z.number().int(),
   attributes: z.array(ProductAttribute$inboundSchema),
@@ -247,6 +255,7 @@ export type ProductDetail$Outbound = {
   has_variant: boolean;
   tags: Array<string> | null;
   category_ids: Array<string>;
+  categories: Array<Category$Outbound>;
   reviews_rating_sum: number;
   reviews_count: number;
   attributes: Array<ProductAttribute$Outbound>;
@@ -288,6 +297,7 @@ export const ProductDetail$outboundSchema: z.ZodType<
   hasVariant: z.boolean(),
   tags: z.nullable(z.array(z.string())),
   categoryIds: z.array(z.string()),
+  categories: z.array(Category$outboundSchema),
   reviewsRatingSum: z.number(),
   reviewsCount: z.number().int(),
   attributes: z.array(ProductAttribute$outboundSchema),

package/src/models/components/productreview.ts

@@ -14,9 +14,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export const Status = {
   Approved: "approved",
-  Rejected: "rejected",
-  Archived: "archived",
-  Pending: "pending",
 } as const;
 /**
  * Reviews with approved status will be displayed.
@@ -303,7 +300,7 @@ export const ProductReview$inboundSchema: z.ZodType<
   review_text: z.string().optional(),
   name: z.string().optional(),
   email: z.string().optional(),
-  status: Status$inboundSchema.default("pending"),
+  status: Status$inboundSchema.optional(),
   is_featured: z.boolean().default(false),
   tags: z.array(z.string()).optional(),
   review_date: z.string().datetime({ offset: true }).transform(v => new Date(v))
@@ -330,7 +327,7 @@ export type ProductReview$Outbound = {
   review_text?: string | undefined;
   name?: string | undefined;
   email?: string | undefined;
-  status: string;
+  status?: string | undefined;
   is_featured: boolean;
   tags?: Array<string> | undefined;
   review_date?: string | undefined;
@@ -350,7 +347,7 @@ export const ProductReview$outboundSchema: z.ZodType<
   reviewText: z.string().optional(),
   name: z.string().optional(),
   email: z.string().optional(),
-  status: Status$outboundSchema.default("pending"),
+  status: Status$outboundSchema.optional(),
   isFeatured: z.boolean().default(false),
   tags: z.array(z.string()).optional(),
   reviewDate: z.date().transform(v => v.toISOString()).optional(),

package/src/models/errors/badrequest.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { CeStorefrontError } from "./cestorefronterror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 export type ErrorT = {
@@ -24,7 +25,7 @@ export type BadRequestData = {
 /**
  * Bad request
  */
-export class BadRequest extends Error {
+export class BadRequest extends CeStorefrontError {
   success: boolean;
   code: string;
   error?: ErrorT | undefined;
@@ -32,11 +33,13 @@ export class BadRequest extends Error {
   /** The original data that was passed to this error instance. */
   data$: BadRequestData;
 
-  constructor(err: BadRequestData) {
+  constructor(
+    err: BadRequestData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.success = err.success;
     this.code = err.code;
     if (err.error != null) this.error = err.error;
@@ -102,9 +105,16 @@ export const BadRequest$inboundSchema: z.ZodType<
   success: z.boolean(),
   code: z.string(),
   error: z.lazy(() => ErrorT$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new BadRequest(v);
+    return new BadRequest(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/ceerror.ts

@@ -2,41 +2,33 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class CeError extends Error {
-  /**
-   * HTTP status code
-   */
-  public readonly statusCode: number;
-  /**
-   * HTTP content type
-   */
-  public readonly contentType: string;
-  /**
-   * HTTP body
-   */
-  public readonly body: string;
-  /**
-   * Raw response
-   */
-  public readonly rawResponse: Response;
+import { CeStorefrontError } from "./cestorefronterror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class CeError extends CeStorefrontError {
   constructor(
     message: string,
-    rawResponse: Response,
-    body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
   ) {
-    const statusCode = rawResponse.status;
-    const contentType = rawResponse.headers.get("content-type") || "";
-    const bodyString = body.length > 0 ? `\n${body}` : "";
-    super(
-      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
-    );
-
-    this.body = body;
-    this.rawResponse = rawResponse;
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : " ";
+    message += `Body ${body}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "CeError";
   }
 }

package/src/models/errors/cestorefronterror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class CeStorefrontError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "CeStorefrontError";
+  }
+}

package/src/models/errors/index.ts

@@ -6,5 +6,6 @@ export * from "./badrequest.js";
 export * from "./ceerror.js";
 export * from "./httpclienterrors.js";
 export * from "./notfound.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./unauthorized.js";