@commercetools/sdk-client-v2 0.2.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @commercetools/sdk-client-v2
 
+## 1.1.0
+
+### Minor Changes
+
+- [#188](https://github.com/commercetools/commercetools-sdk-typescript/pull/188) [`4c2d9b6`](https://github.com/commercetools/commercetools-sdk-typescript/commit/4c2d9b64b204200dffbeb18130239138dd2ad7d3) Thanks [@ajimae](https://github.com/ajimae)! - February package release
+
+### Patch Changes
+
+- [#149](https://github.com/commercetools/commercetools-sdk-typescript/pull/149) [`08caea9`](https://github.com/commercetools/commercetools-sdk-typescript/commit/08caea93560c01e2158f018538b7a2b9f4be39c1) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update all dependencies
+
+## 1.0.2
+
+### Patch Changes
+
+- [#167](https://github.com/commercetools/commercetools-sdk-typescript/pull/167) [`b31612d`](https://github.com/commercetools/commercetools-sdk-typescript/commit/b31612dbcc3d644847cb42cf67bce407ab202cb0) Thanks [@ajimae](https://github.com/ajimae)! - Add Buffer Dependency
+
+## 1.0.1
+
+### Patch Changes
+
+- [#163](https://github.com/commercetools/commercetools-sdk-typescript/pull/163) [`fcd35a0`](https://github.com/commercetools/commercetools-sdk-typescript/commit/fcd35a0f26b2780d0004c4e9d7b48233a86c2453) Thanks [@ajimae](https://github.com/ajimae)! - Fix issues with Buffer and node process
+
+## 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

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: '/oauth/token', // - optional: custom oauthUri
+  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)

package/dist/commercetools-sdk-client-v2.browser.cjs.js

@@ -177,6 +177,8 @@ function createClient(options) {
 
 // POST https://{host}/oauth/token?grant_type=client_credentials&scope={scope}
 // Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+const Buffer$2 = require('buffer/').Buffer;
+
 function buildRequestForClientCredentialsFlow(options) {
   if (!options) throw new Error('Missing required options');
   if (!options.host) throw new Error('Missing required option (host)');
@@ -188,7 +190,7 @@ function buildRequestForClientCredentialsFlow(options) {
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
   const scope = options.scopes ? options.scopes.join(' ') : undefined;
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -219,7 +221,7 @@ function buildRequestForPasswordFlow(options) {
   if (!(username && password)) throw new Error('Missing required user credentials (username, password)');
   const scope = (options.scopes || []).join(' ');
   const scopeStr = scope ? `&scope=${scope}` : '';
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64');
   /**
    * This is mostly useful for internal testing purposes to be able to check
    * other oauth endpoints.
@@ -246,7 +248,7 @@ function buildRequestForRefreshTokenFlow(options) {
     clientSecret
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -269,6 +271,8 @@ function buildRequestForAnonymousSessionFlow(options) {
   };
 }
 
+const Buffer$1 = require('buffer/').Buffer;
+
 function mergeAuthHeader(token, req) {
   return { ...req,
     headers: { ...req.headers,
@@ -298,7 +302,7 @@ async function executeRequest({
       method: 'POST',
       headers: {
         Authorization: `Basic ${basicAuth}`,
-        'Content-Length': Buffer.byteLength(body).toString(),
+        'Content-Length': Buffer$1.byteLength(body).toString(),
         'Content-Type': 'application/x-www-form-urlencoded'
       },
       body
@@ -703,6 +707,8 @@ function parseHeaders(headers) {
   return map;
 }
 
+const Buffer = require('buffer/').Buffer;
+
 function createError({
   statusCode,
   message,
@@ -976,7 +982,7 @@ function createQueueMiddleware({
 
 var packageJson = {
 	name: "@commercetools/sdk-client-v2",
-	version: "0.2.0",
+	version: "1.1.0",
 	description: "commercetools TypeScript SDK client.",
 	keywords: [
 		"commercetools",
@@ -1005,6 +1011,7 @@ var packageJson = {
 		url: "https://github.com/commercetools/commercetools-sdk-typescript/issues"
 	},
 	dependencies: {
+		buffer: "^6.0.3",
 		"node-fetch": "^2.6.1",
 		querystring: "^0.2.1"
 	},
@@ -1023,9 +1030,9 @@ var packageJson = {
 		"abort-controller": "3.0.0",
 		"common-tags": "1.8.2",
 		dotenv: "10.0.0",
-		jest: "27.3.1",
+		jest: "27.4.7",
 		nock: "12.0.3",
-		"organize-imports-cli": "0.8.0"
+		"organize-imports-cli": "0.9.0"
 	},
 	scripts: {
 		organize_imports: "find src -type f -name '*.ts' | xargs organize-imports-cli",
@@ -1045,8 +1052,11 @@ var packageJson = {
 const isBrowser = () => window.document && window.document.nodeType === 9;
 
 function getSystemInfo() {
+  var _process;
+
   if (isBrowser()) return window.navigator.userAgent;
-  const nodeVersion = process.version.slice(1); // const platformInfo = `(${process.platform}; ${process.arch})`
+  const nodeVersion = ((_process = process) === null || _process === void 0 ? void 0 : _process.version.slice(1)) || '12'; // temporary fix for rn environment
+  // const platformInfo = `(${process.platform}; ${process.arch})`
   // return `Node.js/${nodeVersion} ${platformInfo}`
 
   return `node.js/${nodeVersion}`;
@@ -1153,8 +1163,8 @@ class ClientBuilder {
       host: options.host || 'https://auth.europe-west1.gcp.commercetools.com',
       projectKey: options.projectKey || this.projectKey,
       credentials: {
-        clientId: process.env.myClientId,
-        clientSecret: process.env.myClientSecret,
+        clientId: options.credentials.clientId || '',
+        clientSecret: options.credentials.clientSecret || '',
         user: {
           username: options.credentials.user.username || '',
           password: options.credentials.user.password || ''

package/dist/commercetools-sdk-client-v2.browser.esm.js

@@ -168,6 +168,8 @@ function createClient(options) {
 
 // POST https://{host}/oauth/token?grant_type=client_credentials&scope={scope}
 // Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+const Buffer$2 = require('buffer/').Buffer;
+
 function buildRequestForClientCredentialsFlow(options) {
   if (!options) throw new Error('Missing required options');
   if (!options.host) throw new Error('Missing required option (host)');
@@ -179,7 +181,7 @@ function buildRequestForClientCredentialsFlow(options) {
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
   const scope = options.scopes ? options.scopes.join(' ') : undefined;
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -210,7 +212,7 @@ function buildRequestForPasswordFlow(options) {
   if (!(username && password)) throw new Error('Missing required user credentials (username, password)');
   const scope = (options.scopes || []).join(' ');
   const scopeStr = scope ? `&scope=${scope}` : '';
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64');
   /**
    * This is mostly useful for internal testing purposes to be able to check
    * other oauth endpoints.
@@ -237,7 +239,7 @@ function buildRequestForRefreshTokenFlow(options) {
     clientSecret
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -260,6 +262,8 @@ function buildRequestForAnonymousSessionFlow(options) {
   };
 }
 
+const Buffer$1 = require('buffer/').Buffer;
+
 function mergeAuthHeader(token, req) {
   return { ...req,
     headers: { ...req.headers,
@@ -289,7 +293,7 @@ async function executeRequest({
       method: 'POST',
       headers: {
         Authorization: `Basic ${basicAuth}`,
-        'Content-Length': Buffer.byteLength(body).toString(),
+        'Content-Length': Buffer$1.byteLength(body).toString(),
         'Content-Type': 'application/x-www-form-urlencoded'
       },
       body
@@ -694,6 +698,8 @@ function parseHeaders(headers) {
   return map;
 }
 
+const Buffer = require('buffer/').Buffer;
+
 function createError({
   statusCode,
   message,
@@ -967,7 +973,7 @@ function createQueueMiddleware({
 
 var packageJson = {
 	name: "@commercetools/sdk-client-v2",
-	version: "0.2.0",
+	version: "1.1.0",
 	description: "commercetools TypeScript SDK client.",
 	keywords: [
 		"commercetools",
@@ -996,6 +1002,7 @@ var packageJson = {
 		url: "https://github.com/commercetools/commercetools-sdk-typescript/issues"
 	},
 	dependencies: {
+		buffer: "^6.0.3",
 		"node-fetch": "^2.6.1",
 		querystring: "^0.2.1"
 	},
@@ -1014,9 +1021,9 @@ var packageJson = {
 		"abort-controller": "3.0.0",
 		"common-tags": "1.8.2",
 		dotenv: "10.0.0",
-		jest: "27.3.1",
+		jest: "27.4.7",
 		nock: "12.0.3",
-		"organize-imports-cli": "0.8.0"
+		"organize-imports-cli": "0.9.0"
 	},
 	scripts: {
 		organize_imports: "find src -type f -name '*.ts' | xargs organize-imports-cli",
@@ -1036,8 +1043,11 @@ var packageJson = {
 const isBrowser = () => window.document && window.document.nodeType === 9;
 
 function getSystemInfo() {
+  var _process;
+
   if (isBrowser()) return window.navigator.userAgent;
-  const nodeVersion = process.version.slice(1); // const platformInfo = `(${process.platform}; ${process.arch})`
+  const nodeVersion = ((_process = process) === null || _process === void 0 ? void 0 : _process.version.slice(1)) || '12'; // temporary fix for rn environment
+  // const platformInfo = `(${process.platform}; ${process.arch})`
   // return `Node.js/${nodeVersion} ${platformInfo}`
 
   return `node.js/${nodeVersion}`;
@@ -1144,8 +1154,8 @@ class ClientBuilder {
       host: options.host || 'https://auth.europe-west1.gcp.commercetools.com',
       projectKey: options.projectKey || this.projectKey,
       credentials: {
-        clientId: process.env.myClientId,
-        clientSecret: process.env.myClientSecret,
+        clientId: options.credentials.clientId || '',
+        clientSecret: options.credentials.clientSecret || '',
         user: {
           username: options.credentials.user.username || '',
           password: options.credentials.user.password || ''

package/dist/commercetools-sdk-client-v2.cjs.dev.js

@@ -177,6 +177,8 @@ function createClient(options) {
 
 // POST https://{host}/oauth/token?grant_type=client_credentials&scope={scope}
 // Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+const Buffer$2 = require('buffer/').Buffer;
+
 function buildRequestForClientCredentialsFlow(options) {
   if (!options) throw new Error('Missing required options');
   if (!options.host) throw new Error('Missing required option (host)');
@@ -188,7 +190,7 @@ function buildRequestForClientCredentialsFlow(options) {
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
   const scope = options.scopes ? options.scopes.join(' ') : undefined;
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -219,7 +221,7 @@ function buildRequestForPasswordFlow(options) {
   if (!(username && password)) throw new Error('Missing required user credentials (username, password)');
   const scope = (options.scopes || []).join(' ');
   const scopeStr = scope ? `&scope=${scope}` : '';
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64');
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64');
   /**
    * This is mostly useful for internal testing purposes to be able to check
    * other oauth endpoints.
@@ -246,7 +248,7 @@ function buildRequestForRefreshTokenFlow(options) {
     clientSecret
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
-  const basicAuth = Buffer.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -269,6 +271,8 @@ function buildRequestForAnonymousSessionFlow(options) {
   };
 }
 
+const Buffer$1 = require('buffer/').Buffer;
+
 function mergeAuthHeader(token, req) {
   return { ...req,
     headers: { ...req.headers,
@@ -298,7 +302,7 @@ async function executeRequest({
       method: 'POST',
       headers: {
         Authorization: `Basic ${basicAuth}`,
-        'Content-Length': Buffer.byteLength(body).toString(),
+        'Content-Length': Buffer$1.byteLength(body).toString(),
         'Content-Type': 'application/x-www-form-urlencoded'
       },
       body
@@ -703,6 +707,8 @@ function parseHeaders(headers) {
   return map;
 }
 
+const Buffer = require('buffer/').Buffer;
+
 function createError({
   statusCode,
   message,
@@ -976,7 +982,7 @@ function createQueueMiddleware({
 
 var packageJson = {
 	name: "@commercetools/sdk-client-v2",
-	version: "0.2.0",
+	version: "1.1.0",
 	description: "commercetools TypeScript SDK client.",
 	keywords: [
 		"commercetools",
@@ -1005,6 +1011,7 @@ var packageJson = {
 		url: "https://github.com/commercetools/commercetools-sdk-typescript/issues"
 	},
 	dependencies: {
+		buffer: "^6.0.3",
 		"node-fetch": "^2.6.1",
 		querystring: "^0.2.1"
 	},
@@ -1023,9 +1030,9 @@ var packageJson = {
 		"abort-controller": "3.0.0",
 		"common-tags": "1.8.2",
 		dotenv: "10.0.0",
-		jest: "27.3.1",
+		jest: "27.4.7",
 		nock: "12.0.3",
-		"organize-imports-cli": "0.8.0"
+		"organize-imports-cli": "0.9.0"
 	},
 	scripts: {
 		organize_imports: "find src -type f -name '*.ts' | xargs organize-imports-cli",
@@ -1045,8 +1052,11 @@ var packageJson = {
 const isBrowser = () => typeof window !== 'undefined' && window.document && window.document.nodeType === 9;
 
 function getSystemInfo() {
+  var _process;
+
   if (isBrowser()) return window.navigator.userAgent;
-  const nodeVersion = process.version.slice(1); // const platformInfo = `(${process.platform}; ${process.arch})`
+  const nodeVersion = ((_process = process) === null || _process === void 0 ? void 0 : _process.version.slice(1)) || '12'; // temporary fix for rn environment
+  // const platformInfo = `(${process.platform}; ${process.arch})`
   // return `Node.js/${nodeVersion} ${platformInfo}`
 
   return `node.js/${nodeVersion}`;
@@ -1153,8 +1163,8 @@ class ClientBuilder {
       host: options.host || 'https://auth.europe-west1.gcp.commercetools.com',
       projectKey: options.projectKey || this.projectKey,
       credentials: {
-        clientId: process.env.myClientId,
-        clientSecret: process.env.myClientSecret,
+        clientId: options.credentials.clientId || '',
+        clientSecret: options.credentials.clientSecret || '',
         user: {
           username: options.credentials.user.username || '',
           password: options.credentials.user.password || ''