@commercetools/history-sdk 1.20.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/history-sdk
 
+## 2.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
+
 ## 1.20.0
 
 ### Minor Changes

package/README.md

@@ -1,36 +1,126 @@
-# Typescript SDK for commercetools Audit log APIs.
+# Typescript SDK for commercetools Audit log (history) APIs.
 
-## Install
+## Usage examples
 
-```bash
-npm install --save @commercetools/history-sdk
-```
+### Browser environment
 
-### Browser
+```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/history-sdk@latest/dist/commercetools-history-sdk.umd.js"></script>
+```
 
 ```html
-<script src="https://unpkg.com/browse/@commercetools/history-sdk/dist/history-sdk.umd.js"></script>
 <script>
-  // global: historySdk
+  // global: @commercetools/sdk-client-v2
+  // global: @commercetools/history-sdk
+  ;(function () {
+    //  We can now access the sdk-client-v2 and history-sdk object as:
+    //  const { ClientBuilder } = this['@commercetools/sdk-client-v2']
+    //  const { createApiBuilderFromCtpClient } = this['@commercetools/history-sdk']
+    //  or
+    //  const { ClientBuilder } = window['@commercetools/sdk-client-v2']
+    //  const { createApiBuilderFromCtpClient } = window['@commercetools/history-sdk']
+  })()
 </script>
 ```
 
-### Usage example
+### Node environment
+
+```bash
+npm install --save @commercetools/sdk-client-v2
+npm install --save @commercetools/history-sdk
+```
 
 ```ts
-import { createAuthMiddlewareForClientCredentialsFlow } from '@commercetools/sdk-middleware-auth'
-import { createHttpMiddleware } from '@commercetools/sdk-middleware-http'
-import { createClient } from '@commercetools/sdk-client'
+const {
+  ClientBuilder,
+  createAuthForClientCredentialsFlow,
+  createHttpClient,
+} = require('@commercetools/sdk-client-v2')
+const { createApiBuilderFromCtpClient } = require('@commercetools/history-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://history.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 history-sdk functions
+// get project details
+apiRoot
+  .withProjectKey({ projectKey })
+  .recommendations()
+  .projectCategories()
+  .withProductId({
+    productId: product.id,
+  })
+  .get()
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+
+apiRoot
+  .withProjectKey({ projectKey })
+  .imageSearch()
+  .post({
+    queryArgs: {
+      limit: 20,
+    },
+    body: image,
+    headers: {
+      'Content-Type': 'image/jpeg',
+    },
+  })
+  .execute()
+  .then((x) => {
+    /*...*/
+  })
+
+// -----------------------------------------------------------------------
+// The sdk-client-v2 also has support for the old syntax
 import {
-  createApiBuilderFromCtpClient,
-  ApiRoot,
-} from '@commercetools/history-sdk'
+  createClient,
+  createHttpClient,
+  createAuthForClientCredentialsFlow,
+} from '@commercetools/sdk-client-v2'
+import { createApiBuilderFromCtpClient } from '@commercetools/history-sdk'
 import fetch from 'node-fetch'
 
 const projectKey = 'some_project_key'
 
-const authMiddleware = createAuthMiddlewareForClientCredentialsFlow({
-  host: 'https://auth.europe-west1.gcp.commercetools.com/',
+const authMiddleware = createAuthForClientCredentialsFlow({
+  host: 'https://auth.europe-west1.gcp.commercetools.com',
   projectKey,
   credentials: {
     clientId: 'some_id',
@@ -39,7 +129,7 @@ const authMiddleware = createAuthMiddlewareForClientCredentialsFlow({
   fetch,
 })
 
-const httpMiddleware = createHttpMiddleware({
+const httpMiddleware = createHttpClient({
   host: 'https://history.europe-west1.gcp.commercetools.com',
   fetch,
 })
@@ -48,10 +138,10 @@ const ctpClient = createClient({
   middlewares: [authMiddleware, httpMiddleware],
 })
 
-const apiRoot: ApiRoot = createApiBuilderFromCtpClient(ctpClient)
+const apiRoot = createApiBuilderFromCtpClient(ctpClient)
 
 apiRoot
-  .withProjectKeyValue({ projectKey })
+  .withProjectKey({ projectKey })
   .recommendations()
   .projectCategories()
   .withProductId({

package/dist/commercetools-history-sdk.browser.cjs.js

@@ -193,12 +193,14 @@ class ByProjectKeyRequestBuilder {
 
 class ApiRoot {
   constructor(args) {
+    var _args$baseUri;
+
     _defineProperty(this, "executeRequest", void 0);
 
     _defineProperty(this, "baseUri", void 0);
 
     this.executeRequest = args.executeRequest;
-    this.baseUri = args.baseUri ?? 'https://history.europe-west1.gcp.commercetools.com';
+    this.baseUri = (_args$baseUri = args.baseUri) !== null && _args$baseUri !== void 0 ? _args$baseUri : 'https://history.europe-west1.gcp.commercetools.com';
   }
 
   withProjectKeyValue(childPathArgs) {

package/dist/commercetools-history-sdk.browser.esm.js

@@ -189,12 +189,14 @@ class ByProjectKeyRequestBuilder {
 
 class ApiRoot {
   constructor(args) {
+    var _args$baseUri;
+
     _defineProperty(this, "executeRequest", void 0);
 
     _defineProperty(this, "baseUri", void 0);
 
     this.executeRequest = args.executeRequest;
-    this.baseUri = args.baseUri ?? 'https://history.europe-west1.gcp.commercetools.com';
+    this.baseUri = (_args$baseUri = args.baseUri) !== null && _args$baseUri !== void 0 ? _args$baseUri : 'https://history.europe-west1.gcp.commercetools.com';
   }
 
   withProjectKeyValue(childPathArgs) {

package/dist/commercetools-history-sdk.cjs.dev.js

@@ -193,12 +193,14 @@ class ByProjectKeyRequestBuilder {
 
 class ApiRoot {
   constructor(args) {
+    var _args$baseUri;
+
     _defineProperty(this, "executeRequest", void 0);
 
     _defineProperty(this, "baseUri", void 0);
 
     this.executeRequest = args.executeRequest;
-    this.baseUri = args.baseUri ?? 'https://history.europe-west1.gcp.commercetools.com';
+    this.baseUri = (_args$baseUri = args.baseUri) !== null && _args$baseUri !== void 0 ? _args$baseUri : 'https://history.europe-west1.gcp.commercetools.com';
   }
 
   withProjectKeyValue(childPathArgs) {

package/dist/commercetools-history-sdk.cjs.prod.js

@@ -193,12 +193,14 @@ class ByProjectKeyRequestBuilder {
 
 class ApiRoot {
   constructor(args) {
+    var _args$baseUri;
+
     _defineProperty(this, "executeRequest", void 0);
 
     _defineProperty(this, "baseUri", void 0);
 
     this.executeRequest = args.executeRequest;
-    this.baseUri = args.baseUri ?? 'https://history.europe-west1.gcp.commercetools.com';
+    this.baseUri = (_args$baseUri = args.baseUri) !== null && _args$baseUri !== void 0 ? _args$baseUri : 'https://history.europe-west1.gcp.commercetools.com';
   }
 
   withProjectKeyValue(childPathArgs) {

package/dist/commercetools-history-sdk.esm.js

@@ -189,12 +189,14 @@ class ByProjectKeyRequestBuilder {
 
 class ApiRoot {
   constructor(args) {
+    var _args$baseUri;
+
     _defineProperty(this, "executeRequest", void 0);
 
     _defineProperty(this, "baseUri", void 0);
 
     this.executeRequest = args.executeRequest;
-    this.baseUri = args.baseUri ?? 'https://history.europe-west1.gcp.commercetools.com';
+    this.baseUri = (_args$baseUri = args.baseUri) !== null && _args$baseUri !== void 0 ? _args$baseUri : 'https://history.europe-west1.gcp.commercetools.com';
   }
 
   withProjectKeyValue(childPathArgs) {

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "name": "@commercetools/history-sdk",
-  "version": "1.20.0",
+  "version": "2.0.0",
   "description": "Type script sdk for commercetools audit log features",
   "keywords": ["commercetools", "typescript", "sdk", "history"],
   "homepage": "https://github.com/commercetools/commercetools-typescript-sdks/packages/history-sdk",
@@ -30,8 +30,8 @@
     "querystring": "^0.2.1"
   },
   "devDependencies": {
-    "@commercetools/platform-sdk": "1.20.0",
-    "@commercetools/sdk-client-v2": "^0.2.0",
+    "@commercetools/platform-sdk": "2.0.0",
+    "@commercetools/sdk-client-v2": "^1.0.0",
     "@types/uuid": "8.3.3",
     "organize-imports-cli": "0.8.0",
     "tsconfig-replace-paths": "0.0.11",