@commercetools/ts-client 1.0.0 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @commercetools/ts-client
 
+## 1.1.1
+
+### Patch Changes
+
+- [#620](https://github.com/commercetools/commercetools-sdk-typescript/pull/620) [`f0028a3`](https://github.com/commercetools/commercetools-sdk-typescript/commit/f0028a343fe3417bbc3caeb76cc6658a5d7bff73) Thanks [@lojzatran](https://github.com/lojzatran)! - Fix issue with concurrent modification middleware functionality.
+
+## 1.1.0
+
+### Minor Changes
+
+- [#478](https://github.com/commercetools/commercetools-sdk-typescript/pull/478) [`98c6bac`](https://github.com/commercetools/commercetools-sdk-typescript/commit/98c6bace1608889c16373e1a83451cf5d7a7d140) Thanks [@ajimae](https://github.com/ajimae)! - remove all remaining `querystring` package instances.
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -124,3 +124,58 @@ apiRoot
     /*...*/
   })
 ```
+
+## Create a client
+
+To create a client, use the `ClientBuilder` class. The `ClientBuilder` class provides a fluent API to configure the client.
+
+```ts
+const authMiddlewareOptions = {
+  credentials: {
+    clientId: 'xxx',
+    clientSecret: 'xxx',
+  },
+  host: 'https://auth.europe-west1.gcp.commercetools.com',
+  projectKey: 'xxx',
+}
+
+const httpMiddlewareOptions = {
+  host: 'https://api.europe-west1.gcp.commercetools.com',
+  httpClient: fetch,
+}
+
+const client = new ClientBuilder()
+  .withHttpMiddleware(httpMiddlewareOptions)
+  .withConcurrentModificationMiddleware()
+  .withClientCredentialsFlow(authMiddlewareOptions)
+  .build()
+```
+
+> [!WARNING]
+> Do not add the built-in middlewares using `withMiddleware` method. Adding by this method does not respect the ordering of the middlewares and could lead to unexpected behavior.
+
+```ts
+// WRONG CODE!!!!!
+const authMiddlewareOptions = {
+  credentials: {
+    clientId: 'xxx',
+    clientSecret: 'xxx',
+  },
+  host: 'https://auth.europe-west1.gcp.commercetools.com',
+  projectKey: 'xxx',
+}
+
+const httpMiddlewareOptions = {
+  host: 'https://api.europe-west1.gcp.commercetools.com',
+  httpClient: fetch,
+}
+
+const client = new ClientBuilder()
+  .withMiddleware(
+    createAuthMiddlewareForClientCredentialsFlow(authMiddlewareOptions)
+  )
+  .withMiddleware(createHttpMiddleware(httpMiddlewareOptions))
+  .withMiddleware(createConcurrentModificationMiddleware())
+  .build()
+// WRONG CODE!!!!!
+```