@shopware/api-client 0.3.0 → 0.5.0

package/README.md

@@ -29,13 +29,13 @@ Recommended practice is to create separate module file. For example `src/apiClie
 import { createAPIClient } from "@shopware/api-client";
 
 // You can pick types of your current API version, the default one:
-import {
+import type {
   operationPaths,
   operations,
   components,
 } from "@shopware/api-client/api-types";
 // or (specific version):
-import {
+import type {
   operationPaths,
   operations,
   components,
@@ -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 type {
+  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,8 +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.3.0
+### Latest changes: 0.5.0
 
 ### Minor Changes
 
-- [#330](https://github.com/shopware/frontends/pull/330) [`3683116`](https://github.com/shopware/frontends/commit/3683116588a7ef75e750fc33deee119f038c88e8) Thanks [@mdanilowicz](https://github.com/mdanilowicz)! - Add `setCurrentCountry` for changing context countryId
+- [#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 "..."`
+
+### 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");
+  ```