@shopware/api-client 1.3.0 → 1.4.0

package/README.md

@@ -10,7 +10,6 @@ You can use types generated from your custom API instance to have autocompletion
 
 To generate your own types use [@shopware/api-gen](https://www.npmjs.com/package/@shopware/api-gen) CLI.
 
-To take a deep dive into the topic visit the [🧑‍🎓 API Client Tutorial](https://api-client-tutorial-composable-frontends.pages.dev) first.
 
 ## Setup
 
@@ -129,7 +128,7 @@ export const adminApiClient = createAdminAPIClient<operations>({
   sessionData: JSON.parse(Cookies.get("sw-admin-session-data") || "{}"),
 });
 
-adminApiClient.hooks("onAuthChange", (sessionData) => {
+adminApiClient.hook("onAuthChange", (sessionData) => {
   Cookies.set("sw-admin-session-data", JSON.stringify(sessionData), {
     expires: 1, // days
     path: "/",
@@ -295,13 +294,59 @@ apiClient.updateBaseConfig({
 
 This allows you to dynamically change the API endpoint or access token during runtime, for example when switching between different environments or when the access token needs to be updated.
 
-## Links
+## Helper Functions
+
+The API client provides helper functions that can be imported separately to keep your main bundle size smaller.
+
+### encodeForQuery
+
+The `encodeForQuery` function compresses and encodes objects into base64url format for use in query strings. This is particularly useful for complex criteria objects that need to be passed as URL parameters.
+
+Related issue: https://github.com/shopware/shopware/issues/12388
 
-- [🧑‍🎓 Tutorial](https://api-client-tutorial-composable-frontends.pages.dev)
+```typescript
+import { encodeForQuery } from "@shopware/api-client/helpers";
+
+// Example: Encoding complex search criteria
+const criteria = {
+  page: 1,
+  limit: 10,
+  filter: [
+    {
+      type: "equals",
+      field: "active",
+      value: true
+    },
+    {
+      type: "contains",
+      field: "name",
+      value: "smartphone"
+    }
+  ],
+  associations: {
+    manufacturer: {},
+    categories: {
+      associations: {
+        media: {}
+      }
+    }
+  }
+};
+
+// Use in URL
+apiClient.invoke("getProducts get /product", {
+  query: {
+    _criteria: encodeForQuery(encodedCriteria),
+  },
+});
+```
+
+
+## Links
 
 - [📘 Documentation](https://frontends.shopware.com)
 
-- [👥 Community Slack](https://shopwarecommunity.slack.com) (`#composable-frontends` channel)
+- [👥 Community Discord](https://discord.com/channels/1308047705309708348/1405501315160739951) (`#composable-frontend` channel)
 
 <!-- AUTO GENERATED CHANGELOG -->
 
@@ -309,19 +354,31 @@ This allows you to dynamically change the API endpoint or access token during ru
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-client/CHANGELOG.md)
 
-### Latest changes: 1.3.0
+### Latest changes: 1.4.0
 
 ### Minor Changes
 
-- [#1865](https://github.com/shopware/frontends/pull/1865) [`d016d6b`](https://github.com/shopware/frontends/commit/d016d6b845bff9a148405a74dae88d7fc81ec99c) Thanks [@patzick](https://github.com/patzick)! - Added new methods to manage API client base configuration:
+- [#2012](https://github.com/shopware/frontends/pull/2012) [`70dcf95`](https://github.com/shopware/frontends/commit/70dcf95d4370c63964d877a5cab113a53f93ca19) Thanks [@patzick](https://github.com/patzick)! - Added helper to support encoded `_criteria` field in GET query parameters.
+  Context information: https://github.com/shopware/shopware/issues/12388
 
-  - `updateBaseConfig`: Allows updating baseURL and accessToken in a single call
-  - `getBaseConfig`: Returns current baseURL and accessToken values
+  This helper is available under the `@shopware/api-client/helpers` import path.
 
-  This change replaces the previous `updateBaseUrl` method with a more flexible configuration management system that can be extended in the future.
+  ```typescript
+  import { encodeForQuery } from "@shopware/api-client/helpers";
 
-### Patch Changes
+  const criteria = {
+    page: 1,
+    limit: 10,
+    ...
+  }
+
+  const encodedCriteria = encodeForQuery(criteria);
 
-- [#1801](https://github.com/shopware/frontends/pull/1801) [`a7ff606`](https://github.com/shopware/frontends/commit/a7ff60681d1a164d5c9f2020c506262e96fad5dc) Thanks [@joostaasman](https://github.com/joostaasman)! - fix: Undefined mergedHeaders["content-type"] when content-type is multipart/form-data
+  const result = await apiClient.invoke("getProducts get /product", {
+    query: {
+      _criteria: encodedCriteria,
+    },
+  });
+  ```
 
-- [#1865](https://github.com/shopware/frontends/pull/1865) [`d016d6b`](https://github.com/shopware/frontends/commit/d016d6b845bff9a148405a74dae88d7fc81ec99c) Thanks [@patzick](https://github.com/patzick)! - Added `onRequest` hook to the API client that is triggered before each request is made. This hook provides access to the request context, allowing for request inspection and modification before it's sent.
+- [#1959](https://github.com/shopware/frontends/pull/1959) [`c77daa6`](https://github.com/shopware/frontends/commit/c77daa6a11e96c7f3688b16f7da010b54c7f5e8b) Thanks [@patzick](https://github.com/patzick)! - Updated default types to Shopware 6.7