@shopware/api-client 0.2.1 → 0.4.0

package/README.md

@@ -50,7 +50,6 @@ export const apiClient = createAPIClient<operations, operationPaths>({
   baseURL: "https://demo-frontends.shopware.store/store-api",
   accessToken: "SWSCBHFSNTVMAWNZDNFKSHLAYW",
   contextToken: Cookies.get("sw-context-token"),
-  apiType: "store-api",
   onContextChanged(newContextToken) {
     Cookies.set("sw-context-token", newContextToken, {
       expires: 365, // days
@@ -70,6 +69,47 @@ export type ApiReturnType<OPERATION_NAME extends keyof operations> =
   RequestReturnType<OPERATION_NAME, operations>;
 ```
 
+## Admin API client setup
+
+The setup works the same way as `creteAPIClient` function, with few differences:
+
+```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 {
+  operationPaths,
+  operations,
+  components,
+} 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>({
+  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>;
+```
+
+the rest works the same as store-api client.
+
 ## Basic usage
 
 Take a look at [example project using API Client](https://stackblitz.com/github/shopware/frontends/tree/main/examples/new-api-client).
@@ -146,11 +186,24 @@ try {
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-client-next/CHANGELOG.md)
 
-### Latest changes: 0.2.1
+### Latest changes: 0.4.0
+
+### Minor Changes
+
+- [#371](https://github.com/shopware/frontends/pull/371) [`83c94e9b`](https://github.com/shopware/frontends/commit/83c94e9bb609533c4a1275cbf3822b0fc2ea1dd5) Thanks [@patzick](https://github.com/patzick)! - New method `createAdminAPIClient` supporting Admin API 🅰🅿🅸
+
+- [#373](https://github.com/shopware/frontends/pull/373) [`5510bb02`](https://github.com/shopware/frontends/commit/5510bb028b1fea4c63d677850f50bb7b5a1cf01a) Thanks [@patzick](https://github.com/patzick)! - Added `getSessionData` and `setSessionData` methods in admin API client for test purposes.
 
 ### Patch Changes
 
-- [#339](https://github.com/shopware/frontends/pull/339) [`b2fe2bc`](https://github.com/shopware/frontends/commit/b2fe2bc84bc4f3381bc16b9216a935f3c317b0d4) Thanks [@patzick](https://github.com/patzick)! - Query param arrays. This fixes the way how query params are serialized. Previously, array query params were serialized as `?ids=1&ids=2`, now they are serialized as `?ids[]=1&ids[]=2`. This is the proper way of serialization in the Shopware API.
-  The definition of the endpoints hasn't changed, so you don't need to change anything in your code.
+- [#385](https://github.com/shopware/frontends/pull/385) [`5d7e7973`](https://github.com/shopware/frontends/commit/5d7e7973437a4d74d19ec2fa0765c6d927bf8b2a) Thanks [@patzick](https://github.com/patzick)! - Dependency changes:
+
+  - Changed dependency _ofetch_ from **^1.2.1** to **^1.3.3**
+
+- [#375](https://github.com/shopware/frontends/pull/375) [`bd88d6fa`](https://github.com/shopware/frontends/commit/bd88d6fa95de2b90f8a1e08e34159b46c5932b3b) Thanks [@patzick](https://github.com/patzick)! - Dependency changes:
+
+  - Changed dependency _ofetch_ from **^1.1.1** to **^1.2.1**
+
+- [`15d6e696`](https://github.com/shopware/frontends/commit/15d6e69616bd9bc5ad32f2a5f697e00c45a94784) Thanks [@patzick](https://github.com/patzick)! - Emit cjs bundle
 
-- [#320](https://github.com/shopware/frontends/pull/320) [`8e499e3`](https://github.com/shopware/frontends/commit/8e499e35b3a1a7dc4d1382f8f99b8fc3426e4ac9) Thanks [@mkucmus](https://github.com/mkucmus)! - Prevent setting "null" or "undefined" as token on session init
+- [#371](https://github.com/shopware/frontends/pull/371) [`83c94e9b`](https://github.com/shopware/frontends/commit/83c94e9bb609533c4a1275cbf3822b0fc2ea1dd5) Thanks [@patzick](https://github.com/patzick)! - Deprecated `apiType` param in `createAPIClient`, for Admin API client use `createAdminAPIClient` instead.