@shopware/api-client 0.5.0 → 1.0.1

package/README.md

@@ -1,111 +1,137 @@
 # shopware/frontends - api-client
 
 [![](https://img.shields.io/npm/v/@shopware/api-client?color=blue&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCA0ODggNTUzIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJNNDM5LjA0MSAxMjkuNTkzTDI1OC43NjkgMzEuMzA3NkMyNDQuOTE1IDIzLjc1NDEgMjI4LjExNiAyNC4wMDkzIDIxNC40OTcgMzEuOTgwMkw0Ny4yNjkgMTI5Ljg1OEMzMy40NzYzIDEzNy45MzEgMjUgMTUyLjcxMyAyNSAxNjguNjk1VjM4OC40NjZDMjUgNDA0LjczMiAzMy43Nzg1IDQxOS43MzIgNDcuOTYwMiA0MjcuNjk5TDIxNS4xNzggNTIxLjYzNkMyMjguNDUxIDUyOS4wOTIgMjQ0LjU5MyA1MjkuMzMyIDI1OC4wODIgNTIyLjI3NEw0MzguMzY0IDQyNy45MzRDNDUzLjIwMSA0MjAuMTcgNDYyLjUgNDA0LjgwOSA0NjIuNSAzODguMDYzVjE2OS4xMDJDNDYyLjUgMTUyLjYzMiA0NTMuNTAyIDEzNy40NzcgNDM5LjA0MSAxMjkuNTkzWiIgc3Ryb2tlPSJ1cmwoI3BhaW50MF9saW5lYXJfMTUzXzY5MjY1KSIgc3Ryb2tlLXdpZHRoPSI1MCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIvPgo8ZGVmcz4KPGxpbmVhckdyYWRpZW50IGlkPSJwYWludDBfbGluZWFyXzE1M182OTI2NSIgeDE9Ii0xNi4yOTg5IiB5MT0iMTY1LjM0OSIgeDI9IjI3Ni40MTIiIHkyPSItODkuMzIzNCIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPgo8c3RvcCBzdG9wLWNvbG9yPSIjMDA4NUZGIi8+CjxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iI0MwRTJGNSIvPgo8L2xpbmVhckdyYWRpZW50Pgo8L2RlZnM+Cjwvc3ZnPg==)](https://npmjs.com/package/@shopware/api-client)
-[![](https://img.shields.io/github/package-json/v/shopware/frontends?color=blue&filename=packages%2Fapi-client-next%2Fpackage.json&label=frontends/api-client&logo=github)](https://github.com/shopware/frontends/tree/main/packages/api-client-next)
-![](https://img.shields.io/github/license/shopware/frontends?color=blue)
+[![](https://img.shields.io/github/package-json/v/shopware/frontends?color=blue&filename=packages%2Fapi-client%2Fpackage.json&label=frontends/api-client&logo=github)](https://github.com/shopware/frontends/tree/main/packages/api-client)
 [![](https://img.shields.io/github/issues/shopware/frontends/api-client?label=package%20issues&logo=github)](https://github.com/shopware/frontends/issues?q=is%3Aopen+is%3Aissue+label%3Aapi-client)
+[![](https://img.shields.io/github/license/shopware/frontends?color=blue)](#)
 
-Dynamic and fully typed API Client for Shopware 6. Usable in any JavaScript an TypeScript project.
+Dynamic and fully typed API Client for Shopware 6. Usable in any JavaScript and TypeScript project.
 You can use types generated from your custom API instance to have autocompletion and type safety.
 
+To generate your own types use [@shopware/api-gen](https://www.npmjs.com/package/@shopware/api-gen) CLI.
+
 ## Setup
 
 Install npm package:
 
-```bash
-# Using pnpm
-pnpm add @shopware/api-client
+<!-- automd:pm-install name="@shopware/api-client" -->
+
+```sh
+# ✨ Auto-detect
+npx nypm install @shopware/api-client
 
-# Using yarn
+# npm
+npm install @shopware/api-client
+
+# yarn
 yarn add @shopware/api-client
 
-# Using npm
-npm i @shopware/api-client
+# pnpm
+pnpm install @shopware/api-client
+
+# bun
+bun install @shopware/api-client
 ```
 
-Recommended practice is to create separate module file. For example `src/apiClient.ts`, and import it whenever you need to use API Client.
+<!-- /automd -->
+
+## Store API client setup
+
+Recommended practice is to create a separate module file. For example `src/apiClient.ts`, and import it whenever you need to use API Client.
 
 ```typescript
 import { createAPIClient } from "@shopware/api-client";
 
 // You can pick types of your current API version, the default one:
-import type {
-  operationPaths,
-  operations,
-  components,
-} from "@shopware/api-client/api-types";
-// or (specific version):
-import type {
-  operationPaths,
-  operations,
-  components,
-} from "@shopware/api-client/api-types/apiTypes-6.4.20.0";
-// or your types generated by @shopware/api-gen CLI:
-import { operationPaths, operations, components } from "./apiTypes";
+import type { operations } from "@shopware/api-client/store-api-types";
+// or - RECOMMENDED - your types generated by [@shopware/api-gen](https://www.npmjs.com/package/@shopware/api-gen) CLI:
+import type { operations } from "./api-types/storeApiTypes";
 
 // you can pick cookies library of your choice
 import Cookies from "js-cookie";
 
-export const apiClient = createAPIClient<operations, operationPaths>({
+export const apiClient = createAPIClient<operations>({
   baseURL: "https://demo-frontends.shopware.store/store-api",
   accessToken: "SWSCBHFSNTVMAWNZDNFKSHLAYW",
   contextToken: Cookies.get("sw-context-token"),
-  onContextChanged(newContextToken) {
-    Cookies.set("sw-context-token", newContextToken, {
-      expires: 365, // days
-      path: "/",
-      sameSite: "lax",
-    });
-  },
 });
 
-// reimport schemas to use it in application
-export type ApiSchemas = components["schemas"];
-// reimport operations request parameters to use it in application
-export type ApiRequestParams<OPERATION_NAME extends keyof operations> =
-  RequestParameters<OPERATION_NAME, operations>;
-// reimport operations return types to use it in application
-export type ApiReturnType<OPERATION_NAME extends keyof operations> =
-  RequestReturnType<OPERATION_NAME, operations>;
+apiClient.hook("onContextChanged", (newContextToken) => {
+  Cookies.set("sw-context-token", newContextToken, {
+    expires: 365, // days
+    path: "/",
+    sameSite: "lax",
+    secure: shopwareEndpoint.startsWith("https://"),
+  });
+});
 ```
 
 ## Admin API client setup
 
-The setup works the same way as `creteAPIClient` function, with few differences:
+```typescript
+import { createAdminAPIClient } from "@shopware/api-client";
+```
+
+The setup works the same way as `creteAPIClient` function, with few differences
+
+### credentials (optional) - Quick scripting or token-based authentication
+
+We provide optional `credentials` parameter to `createAdminAPIClient`. Which allows you to use authentication type of your choice whenever you wish to create connection to any endpoint.
+
+Example:
+
+```typescript
+import type {
+  operations,
+} from "@shopware/api-client/admin-api-types"; // we take default admin api types from different directory than store-api - use your own types by generating schema with @shopware/api-gen CLI
+import type { operations } from "./api-types/adminApiTypes"; // or use your own types generated by @shopware/api-gen CLI
+
+const adminApiClient = createAdminAPIClient<operations>({
+  baseURL: `${process.env.SHOP_URL}/api`,
+  credentials: {
+    grant_type: "password",
+    client_id: "administration",
+    scopes: "write",
+    username: process.env.SHOP_ADMIN_USERNAME,
+    password: process.env.SHOP_ADMIN_PASSWORD,
+  },
+  // credentials: { // or token-based example
+  //   grant_type: "client_credentials",
+  //   client_id: "administration",
+  //   client_secret: process.env.SHOP_ADMIN_TOKEN,
+  // },
+});
+
+await adminApiClient.invoke(...); // invoke defined endpoint
+```
+
+### sessionData (optional) - Persistent authentication
+
+This parameter is used to store session data in cookies (or other place you want to store it), so you can keep your session persistent.
+
+You can combine this option with `credentials` property.
 
 ```typescript
 // example adminApiClient.ts file
 import { createAdminAPIClient } from "@shopware/api-client"; // we use different function to create admin api client
 
-import {
-  RequestParameters,
-  RequestReturnType,
-  createAdminAPIClient,
-} from "@shopware/api-client";
-import type {
-  operationPaths,
-  operations,
-  components,
-} from "@shopware/api-client/admin-api-types"; // we take default admin api types from different directory than store-api
+import { createAdminAPIClient } from "@shopware/api-client";
+import type { operations, Schemas } from "@shopware/api-client/admin-api-types"; // we take default admin api types from different directory than store-api
 import Cookies from "js-cookie";
 
-export const adminApiClient = createAdminAPIClient<operations, operationPaths>({
+export const adminApiClient = createAdminAPIClient<operations>({
   baseURL: "https://demo-frontends.shopware.store/api",
   sessionData: JSON.parse(Cookies.get("sw-admin-session-data") || "{}"),
-  onAuthChange(sessionData) {
-    Cookies.set("sw-admin-session-data", JSON.stringify(sessionData), {
-      expires: 1, // days
-      path: "/",
-      sameSite: "lax",
-    });
-  },
 });
 
-export type AdminApiSchemas = components["schemas"];
-export type AdminApiRequestParams<OPERATION_NAME extends keyof operations> =
-  RequestParameters<OPERATION_NAME, operations>;
-export type AdminApiReturnType<OPERATION_NAME extends keyof operations> =
-  RequestReturnType<OPERATION_NAME, operations>;
+adminApiClient.hooks("onAuthChange", (sessionData) => {
+  Cookies.set("sw-admin-session-data", JSON.stringify(sessionData), {
+    expires: 1, // days
+    path: "/",
+    sameSite: "lax",
+    secure: shopwareEndpoint.startsWith("https://"),
+  });
+});
 ```
 
 the rest works the same as store-api client.
@@ -117,10 +143,10 @@ Take a look at [example project using API Client](https://stackblitz.com/github/
 ### Simple invocation
 
 ```typescript
-import { apiClient, ApiReturnType } from "./apiClient";
+import { apiClient, RequestReturnType } from "./apiClient";
 
 // could be reactive value, you can use ApiReturnType to type it properly
-let productsResponse: ApiReturnType<"readProduct">;
+let productsResponse: RequestReturnType<"readProduct">;
 
 async function loadProducts() {
   productsResponse = await apiClient.invoke("readProduct post /product", {
@@ -129,28 +155,79 @@ async function loadProducts() {
 }
 ```
 
+### Fetch features
+
+The new API client is leveraging [ofetch](https://github.com/unjs/ofetch) library, which has built in support for AbortController, timeout and other features.
+
+Example usage of AbortController to cancell your request:
+
+```typescript
+const controller = new AbortController();
+
+const request = client.invoke("readContext get /context", {
+  fetchOptions: {
+    signal: controller.signal,
+  },
+});
+
+controller.abort(); // At this point client will throw an error with the information, that the request has been cancelled
+```
+
+Other example of using `fetchOptions` for setting the timeout:
+
+```typescript
+const request = client.invoke("readContext get /context", {
+  fetchOptions: {
+    timeout: 5000, // 5 seconds
+  },
+});
+```
+
+All exposed options available under `fetchOptions` are:
+
+- `cache`
+- `duplex`
+- `keepalive`
+- `priority`
+- `redirect`
+- `retry`
+- `retryDelay`
+- `retryStatusCodes`
+- `signal`
+- `timeout`
+
 ### Predefining methods
 
 If you prefer to add another layer of abstraction you can use created previously types to define your own concept of methods.
 
 ```typescript
 // add for example into apiClient.ts file
-const readNavigation = (params: ApiRequestParams<"readNavigation">) =>
-  apiClient.invoke(
-    "readNavigation post /navigation/{activeId}/{rootId} sw-include-seo-urls",
-    {
-      depth: 2,
-      ...params,
+const readNavigation = ({
+  depth,
+  type,
+}: {
+  depth: number;
+  type: "main-navigation";
+}) =>
+  apiClient.invoke("readNavigation post /navigation/{activeId}/{rootId}", {
+    headers: {
+      "sw-include-seo-urls": true,
+    },
+    pathParams: {
+      activeId: type,
+      rootId: type,
+    },
+    body: {
+      depth,
     },
-  );
+  });
 
 // in another file you can use it, and depth property will be set to 2 by default
 import { readNavigation } from "./apiClient";
 
 async function loadMainNavigation() {
   const navigation = await readNavigation({
-    activeId: "main-navigation",
-    rootId: "main-navigation",
+    body: { activeId: "main-navigation", rootId: "main-navigation" },
   });
 }
 ```
@@ -184,26 +261,10 @@ try {
 
 ## Changelog
 
-Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-client-next/CHANGELOG.md)
-
-### Latest changes: 0.5.0
+Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-client/CHANGELOG.md)
 
-### Minor Changes
-
-- [#435](https://github.com/shopware/frontends/pull/435) [`a4483ed8`](https://github.com/shopware/frontends/commit/a4483ed8bf9370e87aedeb81846fe9d31880b3e0) Thanks [@patzick](https://github.com/patzick)! - Changed types imports to `import type {...} from "..."`
+### Latest changes: 1.0.1
 
 ### Patch Changes
 
-- [#443](https://github.com/shopware/frontends/pull/443) [`33d54db1`](https://github.com/shopware/frontends/commit/33d54db1bd66146a14781c45b1124547f4276866) Thanks [@patzick](https://github.com/patzick)! - `invoke` method parameters are no longer mandatory when no parameters are defined inside route.
-
-  Now instead of:
-
-  ```ts
-  const result = await apiInstance.invoke("readContext get /context", {});
-  ```
-
-  you can do:
-
-  ```ts
-  const result = await apiInstance.invoke("readContext get /context");
-  ```
+- [#1078](https://github.com/shopware/frontends/pull/1078) [`19f2800`](https://github.com/shopware/frontends/commit/19f28003cf937bcb630257cb7cfd2bd131b7cf9d) Thanks [@patzick](https://github.com/patzick)! - Patch for missing `sw-include-seo-url` in OpenAPI schema.