@shopware/api-client 1.2.1 → 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
 
@@ -33,6 +32,9 @@ pnpm install @shopware/api-client
 
 # bun
 bun install @shopware/api-client
+
+# deno
+deno install @shopware/api-client
 ```
 
 <!-- /automd -->
@@ -126,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: "/",
@@ -263,15 +265,88 @@ apiClient.hook("onDefaultHeaderChanged", (key, value) => {
 });
 ```
 
+Available hooks:
+
+- `onContextChanged`: Triggered when context token changes
+- `onResponseError`: Triggered when API returns an error
+- `onSuccessResponse`: Triggered when API request succeeds
+- `onDefaultHeaderChanged`: Triggered when default headers are modified
+- `onRequest`: Triggered before each request is made, allowing for request inspection and modification
+
 calling `apiClient.hook` will autocomplete the list of available hooks.
 
-## Links
+### Base Configuration Management
+
+The API client provides methods to manage its base configuration:
+
+```typescript
+// Get current configuration
+const config = apiClient.getBaseConfig();
+console.log(config.baseURL); // "https://demo-frontends.shopware.store/store-api"
+console.log(config.accessToken); // "SWSCBHFSNTVMAWNZDNFKSHLAYW"
+
+// Update configuration
+apiClient.updateBaseConfig({
+  baseURL: "https://new-url.com/store-api",
+  accessToken: "NEW_TOKEN",
+});
+```
+
+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.
+
+## 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
+
+```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: {}
+      }
+    }
+  }
+};
 
-- [🧑‍🎓 Tutorial](https://api-client-tutorial-composable-frontends.pages.dev)
+// 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 -->
 
@@ -279,8 +354,31 @@ calling `apiClient.hook` will autocomplete the list of available hooks.
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-client/CHANGELOG.md)
 
-### Latest changes: 1.2.1
+### Latest changes: 1.4.0
+
+### Minor Changes
 
-### Patch Changes
+- [#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
+
+  This helper is available under the `@shopware/api-client/helpers` import path.
+
+  ```typescript
+  import { encodeForQuery } from "@shopware/api-client/helpers";
+
+  const criteria = {
+    page: 1,
+    limit: 10,
+    ...
+  }
+
+  const encodedCriteria = encodeForQuery(criteria);
+
+  const result = await apiClient.invoke("getProducts get /product", {
+    query: {
+      _criteria: encodedCriteria,
+    },
+  });
+  ```
 
-- [#1685](https://github.com/shopware/frontends/pull/1685) [`7324620`](https://github.com/shopware/frontends/commit/7324620a3f39c1b62f7cc294192a3e8b8b336d09) Thanks [@mdanilowicz](https://github.com/mdanilowicz)! - Overwrite API schemas to remove requirements from 'salutationId` property
+- [#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