@shopware/api-client 0.1.0 → 0.2.0

package/README.md

@@ -101,7 +101,7 @@ const readNavigation = (params: ApiRequestParams<"readNavigation">) =>
     {
       depth: 2,
       ...params,
-    }
+    },
   );
 
 // in another file you can use it, and depth property will be set to 2 by default
@@ -115,6 +115,25 @@ async function loadMainNavigation() {
 }
 ```
 
+### Error handling
+
+Client is throwing `ApiClientError` with detailed information returned from the API. It will display clear message in the console or you can access `details` property to get raw information from the response.
+
+```typescript
+import { ApiClientError } from "@shopware/api-client";
+
+try {
+  // ... your request
+} catch (error) {
+  if (error instanceof ApiClientError) {
+    console.error(error); // This prints message summary
+    console.error("Details:", error.details); // Raw response from API
+  } else {
+    console.error("==>", error); // Another type of error, not recognized by API client
+  }
+}
+```
+
 ## Links
 
 - [📘 Documentation](https://frontends.shopware.com)
@@ -127,17 +146,29 @@ async function loadMainNavigation() {
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-client-next/CHANGELOG.md)
 
-### Latest changes: 0.1.0
+### Latest changes: 0.2.0
 
 ### Minor Changes
 
-- [#300](https://github.com/shopware/frontends/pull/300) [`da347b5`](https://github.com/shopware/frontends/commit/da347b548aea93afaab1cc9ebab63f732ecdb964) Thanks [@patzick](https://github.com/patzick)! - Predefining methods: exported `RequestReturnType ` and `RequestParameters` types. You can now create predefined methods:
+- [#316](https://github.com/shopware/frontends/pull/316) [`589c09c`](https://github.com/shopware/frontends/commit/589c09cdd9dee0db172c371afc5ecd740bdb4723) Thanks [@patzick](https://github.com/patzick)! - Improved error handling. Api client now throws `ApiClientError` with detailed information about what went wrong with request.
+
+  example:
 
   ```typescript
-  const readCart = (params: RequestParameters<"readCart", operations>) =>
-    apiInstance.invoke("readCart get /checkout/cart?name", params);
+  import { ApiClientError } from "@shopware/api-client";
+
+  try {
+    // ... your request
+  } catch (error) {
+    if (error instanceof ApiClientError) {
+      console.error(error); // This prints message summary
+      console.error("Details:", error.details); // Raw response from API
+    } else {
+      console.error("==>", error); // Another type of error, not recognized by API client
+    }
+  }
   ```
 
 ### Patch Changes
 
-- [#295](https://github.com/shopware/frontends/pull/295) [`23a0a53`](https://github.com/shopware/frontends/commit/23a0a532410990c0075ea7fff622949ccdecfd49) Thanks [@patzick](https://github.com/patzick)! - bump dependencies
+- [#303](https://github.com/shopware/frontends/pull/303) [`aeb639a`](https://github.com/shopware/frontends/commit/aeb639a3244f812c275145345618e5bc0045be0d) Thanks [@patzick](https://github.com/patzick)! - Improved linting in packages. Types should be more reliable

package/api-types/apiTypes-6.4.19.0.d.ts

@@ -1888,7 +1888,7 @@ export type components = {
            */
           href: string;
           meta?: components["schemas"]["meta"];
-        }
+        },
       ]
     >;
     /** The "type" and "id" to non-empty members. */

package/api-types/apiTypes-6.4.20.0.d.ts

@@ -1888,7 +1888,7 @@ export type components = {
            */
           href: string;
           meta?: components["schemas"]["meta"];
-        }
+        },
       ]
     >;
     /** The "type" and "id" to non-empty members. */

package/api-types/apiTypes-6.5.0.0.d.ts

@@ -1875,7 +1875,7 @@ export type components = {
            */
           href: string;
           meta?: components["schemas"]["meta"];
-        }
+        },
       ]
     >;
     /** The "type" and "id" to non-empty members. */

package/api-types/apiTypes-6.5.2.0.d.ts

@@ -2006,7 +2006,7 @@ export type components = {
            */
           href: string;
           meta?: components["schemas"]["meta"];
-        }
+        },
       ]
     >;
     /** The "type" and "id" to non-empty members. */

package/api-types/apiTypes-6.5.3.0.d.ts

@@ -2006,7 +2006,7 @@ export type components = {
            */
           href: string;
           meta?: components["schemas"]["meta"];
-        }
+        },
       ]
     >;
     /** The "type" and "id" to non-empty members. */

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { FetchResponse } from 'ofetch';
+
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
@@ -2004,7 +2006,7 @@ type components = {
            */
           href: string;
           meta?: components["schemas"]["meta"];
-        }
+        },
       ]
     >;
     /** The "type" and "id" to non-empty members. */
@@ -7662,6 +7664,48 @@ type operations = {
   };
 };
 
+type ApiError = {
+    title?: string;
+    detail?: string;
+    code?: string;
+    status?: string;
+    source?: {
+        pointer?: string;
+    };
+    meta?: {
+        parameters?: Record<string, string>;
+    };
+};
+declare class ApiClientError<T extends {
+    errors: Array<ApiError>;
+}> extends Error {
+    /**
+     * Flag to indicate if the request was successful.
+     */
+    ok: boolean;
+    /**
+     * HTTP status code of the response.
+     */
+    status: number;
+    /**
+     * HTTP status text of the response.
+     */
+    statusText?: string;
+    /**
+     * URL of the request.
+     */
+    url: string;
+    /**
+     * Details of the error.
+     */
+    details: T;
+    /**
+     * Headers of the response.
+     */
+    headers: Headers;
+    constructor(response: FetchResponse<T>);
+}
+
 type Operations = Record<string, unknown>;
 type HttpMethod = "post" | "get" | "put" | "delete" | "patch";
 type GetInferKey<T, NAME extends string> = T extends {
@@ -7706,4 +7750,4 @@ declare function transformPathToQuery<T extends Record<string, unknown>>(path: s
     }
 ];
 
-export { RequestParameters, RequestReturnType, createAPIClient, transformPathToQuery };
+export { ApiClientError, RequestParameters, RequestReturnType, createAPIClient, transformPathToQuery };

package/dist/index.mjs

@@ -1,5 +1,32 @@
 import { ofetch } from 'ofetch';
 
+class ApiClientError extends Error {
+  constructor(response) {
+    let message = "Failed request";
+    message += response._data?.errors.reduce((message2, error) => {
+      let pointer = "";
+      if (error.source?.pointer) {
+        pointer = `[${error.source.pointer}]`;
+      }
+      return `${message2}
+ - [${error.title}]${pointer} ${error.detail}`;
+    }, "");
+    super(message);
+    this.name = "ApiClientError";
+    this.details = response._data || {
+      errors: [{ title: "Unknown error", detail: "" }]
+    };
+    this.ok = response.ok;
+    this.status = response.status;
+    this.statusText = response.statusText;
+    this.url = response.url;
+    this.headers = response.headers;
+  }
+}
+function errorInterceptor(response) {
+  throw new ApiClientError(response);
+}
+
 function createAPIClient(params) {
   const defaultHeaders = {
     "sw-access-key": params.accessToken,
@@ -15,8 +42,10 @@ function createAPIClient(params) {
         defaultHeaders["sw-context-token"] = newContextToken;
         params.onContextChanged?.(newContextToken);
       }
+    },
+    async onResponseError({ request, response, options }) {
+      errorInterceptor(response);
     }
-    // async onResponseError({ request, response, options }) {},
   });
   async function invoke(pathParam, params2) {
     const [requestPath, options] = transformPathToQuery(
@@ -69,4 +98,4 @@ function transformPathToQuery(path, params) {
   return [requestPathWithParams, returnOptions];
 }
 
-export { createAPIClient, transformPathToQuery };
+export { ApiClientError, createAPIClient, transformPathToQuery };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware/api-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Shopware client for API connection.",
   "author": "Shopware",
   "repository": {
@@ -28,11 +28,11 @@
   },
   "devDependencies": {
     "@types/prettier": "^2.7.3",
-    "@vitest/coverage-c8": "^0.32.2",
-    "prettier": "^2.8.8",
-    "vitest": "^0.32.2",
-    "eslint-config-shopware": "0.0.3",
-    "@shopware/api-gen": "0.0.4",
+    "@vitest/coverage-c8": "^0.33.0",
+    "prettier": "^3.0.0",
+    "vitest": "^0.33.0",
+    "@shopware/api-gen": "0.0.5",
+    "eslint-config-shopware": "0.0.4",
     "tsconfig": "0.0.0"
   },
   "dependencies": {