@commercetools/sdk-client-v2 0.1.0 → 1.0.0

package/CHANGELOG.md

@@ -1,8 +1,31 @@
 # @commercetools/sdk-client-v2
 
-## 0.1.0
+## 1.0.0
+
+### Major Changes
+
+- [#154](https://github.com/commercetools/commercetools-sdk-typescript/pull/154) [`25f1dea`](https://github.com/commercetools/commercetools-sdk-typescript/commit/25f1dea23eccdfdda01e9144ec2afe968ead58f2) Thanks [@jherey](https://github.com/jherey)! - This is the first major release of the sdk client
+
+## 0.2.0
+
 ### Minor Changes
 
+- [#146](https://github.com/commercetools/commercetools-sdk-typescript/pull/146) [`1f6f830`](https://github.com/commercetools/commercetools-sdk-typescript/commit/1f6f830bb25d98c15ac96e06635c5e2aa07fe1e8) Thanks [@ajimae](https://github.com/ajimae)! - release a new version of typescript
+
+## 0.1.2
+
+### Patch Changes
 
+- [#123](https://github.com/commercetools/commercetools-sdk-typescript/pull/123) [`1bdcdcf`](https://github.com/commercetools/commercetools-sdk-typescript/commit/1bdcdcf71669f38c3a157e9d03c8106bb8c7c4d5) Thanks [@ajimae](https://github.com/ajimae)! - Fix issues with SDK not working with Browsers
+
+## 0.1.1
+
+### Patch Changes
+
+- [#108](https://github.com/commercetools/commercetools-sdk-typescript/pull/108) [`026d91a`](https://github.com/commercetools/commercetools-sdk-typescript/commit/026d91a747b445b0913eabb7eb91ecc7f3eb257e) Thanks [@github-actions](https://github.com/apps/github-actions)! - Update generated SDKs
+
+## 0.1.0
+
+### Minor Changes
 
 - [#105](https://github.com/commercetools/commercetools-sdk-typescript/pull/105) [`274baaf`](https://github.com/commercetools/commercetools-sdk-typescript/commit/274baaf85d1cac0379842fea68315a8d28c87821) Thanks [@ajimae](https://github.com/ajimae)! - new sdk version release

package/README.md

@@ -1 +1,196 @@
-# `@commercetools/sdk-client-v2`
+# Commercetools TypeScript SDK client.
+
+## Usage examples
+
+### Browser environment
+
+```html
+<script src="https://unpkg.com/@commercetools/sdk-client-v2@latest/dist/commercetools-sdk-client-v2.umd.js"></script>
+<script src="https://unpkg.com/@commercetools/platform-sdk@latest/dist/commercetools-platform-sdk.umd.js"></script>
+```
+
+```html
+<script>
+  // global: @commercetools/sdk-client-v2
+  // global: @commercetools/platform-sdk
+  ;(function () {
+    //  We can now access the sdk-client-v2 and platform-sdk object as:
+    //  const { ClientBuilder } = this['@commercetools/sdk-client-v2']
+    //  const { createApiBuilderFromCtpClient } = this['@commercetools/platform-sdk']
+    //  or
+    //  const { ClientBuilder } = window['@commercetools/sdk-client-v2']
+    //  const { createApiBuilderFromCtpClient } = window['@commercetools/platform-sdk']
+  })()
+</script>
+```
+
+See full usage example [here](https://github.com/commercetools/commercetools-sdk-typescript/blob/master/examples/browser/browser.html)
+
+### Node environment
+
+```bash
+npm install --save @commercetools/sdk-client-v2
+npm install --save @commercetools/platform-sdk
+```
+
+```ts
+const {
+  ClientBuilder,
+  createAuthForClientCredentialsFlow,
+  createHttpClient,
+} = require('@commercetools/sdk-client-v2')
+const { createApiBuilderFromCtpClient } = require('@commercetools/platform-sdk')
+const fetch = require('node-fetch')
+
+const projectKey = 'mc-project-key'
+const authMiddlewareOptions = {
+  host: 'https://auth.europe-west1.gcp.commercetools.com',
+  projectKey,
+  credentials: {
+    clientId: 'mc-client-id',
+    clientSecret: 'mc-client-secrets',
+  },
+  oauthUri: 'https://auth.europe-west1.gcp.commercetools.com',
+  scopes: [`manage_project:${projectKey}`],
+  fetch,
+}
+
+const httpMiddlewareOptions = {
+  host: 'https://api.europe-west1.gcp.commercetools.com',
+  fetch,
+}
+
+const client = new ClientBuilder()
+  .withProjectKey(projectKey)
+  .withMiddleware(createAuthForClientCredentialsFlow(authMiddlewareOptions))
+  .withMiddleware(createHttpClient(httpMiddlewareOptions))
+  .withUserAgentMiddleware()
+  .build()
+
+// or
+const client = new ClientBuilder()
+  .withProjectKey(projectKey)
+  .withClientCredentialsFlow(authMiddlewareOptions)
+  .withHttpMiddleware(httpMiddlewareOptions)
+  .withUserAgentMiddleware()
+  .build()
+
+const apiRoot = createApiBuilderFromCtpClient(client)
+
+// calling the platform functions
+// get project details
+apiRoot
+  .withProjectKey({
+    projectKey,
+  })
+  .get()
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+
+// create a productType
+apiRoot
+  .withProjectKey({ projectKey })
+  .productTypes()
+  .post({
+    body: { name: 'product-type-name', description: 'some description' },
+  })
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+
+// create a product
+apiRoot
+  .withProjectKey({ projectKey })
+  .products()
+  .post({
+    body: {
+      name: { en: 'our-great-product-name' },
+      productType: {
+        typeId: 'product-type',
+        id: 'some-product-type-id',
+      },
+      slug: { en: 'some-slug' },
+    },
+  })
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+
+// -----------------------------------------------------------------------
+// The sdk-client-v2 also has support for the old syntax
+import {
+  createClient,
+  createHttpClient,
+  createAuthForClientCredentialsFlow,
+} from '@commercetools/sdk-client-v2'
+import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
+import fetch from 'node-fetch'
+
+const projectKey = 'some_project_key'
+
+const authMiddleware = createAuthForClientCredentialsFlow({
+  host: 'https://auth.europe-west1.gcp.commercetools.com',
+  projectKey,
+  credentials: {
+    clientId: 'some_id',
+    clientSecret: 'some_secret',
+  },
+  fetch,
+})
+
+const httpMiddleware = createHttpClient({
+  host: 'https://api.europe-west1.gcp.commercetools.com',
+  fetch,
+})
+
+const ctpClient = createClient({
+  middlewares: [authMiddleware, httpMiddleware],
+})
+
+const apiRoot = createApiBuilderFromCtpClient(ctpClient)
+
+apiRoot
+  .withProjectKey({
+    projectKey,
+  })
+  .get()
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+
+apiRoot
+  .withProjectKey({ projectKey })
+  .productTypes()
+  .post({
+    body: { name: 'product-type-name', description: 'some description' },
+  })
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+
+apiRoot
+  .withProjectKey({ projectKey })
+  .products()
+  .post({
+    body: {
+      name: { en: 'our-great-product-name' },
+      productType: {
+        typeId: 'product-type',
+        id: 'some-product-type-id',
+      },
+      slug: { en: 'some-slug' },
+    },
+  })
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+```
+
+See full usage example [here](https://github.com/commercetools/commercetools-sdk-typescript/blob/master/examples/node/node.js)