@commercetools/history-sdk 1.18.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @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
+
+- [#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
+
+### Patch Changes
+
+- [#137](https://github.com/commercetools/commercetools-sdk-typescript/pull/137) [`f119f8a`](https://github.com/commercetools/commercetools-sdk-typescript/commit/f119f8a26255790a6faf3667e07b500497a08c21) Thanks [@github-actions](https://github.com/apps/github-actions)! - Update generated SDKs
+
+## 1.19.0
+
+### Minor Changes
+
+- [#120](https://github.com/commercetools/commercetools-sdk-typescript/pull/120) [`4d01dba`](https://github.com/commercetools/commercetools-sdk-typescript/commit/4d01dbac9cfe38faaa0a11d3154a016759856772) Thanks [@github-actions](https://github.com/apps/github-actions)! - Update generated SDKs
+
+## 1.18.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
+
 ## 1.18.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({
@@ -59,7 +149,7 @@ apiRoot
   })
   .get()
   .execute()
-  .then(x => {
+  .then((x) => {
     /*...*/
   })
 
@@ -76,7 +166,7 @@ apiRoot
     },
   })
   .execute()
-  .then(x => {
+  .then((x) => {
     /*...*/
   })
 ```

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

@@ -19,86 +19,36 @@ function _defineProperty(obj, key, value) {
   return obj;
 }
 
-function ownKeys(object, enumerableOnly) {
-  var keys = Object.keys(object);
-
-  if (Object.getOwnPropertySymbols) {
-    var symbols = Object.getOwnPropertySymbols(object);
-
-    if (enumerableOnly) {
-      symbols = symbols.filter(function (sym) {
-        return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-      });
-    }
-
-    keys.push.apply(keys, symbols);
-  }
-
-  return keys;
-}
-
-function _objectSpread2(target) {
-  for (var i = 1; i < arguments.length; i++) {
-    var source = arguments[i] != null ? arguments[i] : {};
-
-    if (i % 2) {
-      ownKeys(Object(source), true).forEach(function (key) {
-        _defineProperty(target, key, source[key]);
-      });
-    } else if (Object.getOwnPropertyDescriptors) {
-      Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
-    } else {
-      ownKeys(Object(source)).forEach(function (key) {
-        Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-      });
-    }
-  }
-
-  return target;
-}
-
-function _classCallCheck(instance, Constructor) {
-  if (!(instance instanceof Constructor)) {
-    throw new TypeError("Cannot call a class as a function");
-  }
-}
-
-function _defineProperties(target, props) {
-  for (var i = 0; i < props.length; i++) {
-    var descriptor = props[i];
-    descriptor.enumerable = descriptor.enumerable || false;
-    descriptor.configurable = true;
-    if ("value" in descriptor) descriptor.writable = true;
-    Object.defineProperty(target, descriptor.key, descriptor);
-  }
-}
-
-function _createClass(Constructor, protoProps, staticProps) {
-  if (protoProps) _defineProperties(Constructor.prototype, protoProps);
-  if (staticProps) _defineProperties(Constructor, staticProps);
-  return Constructor;
-}
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate <raml_file_path> -o <output_path> -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
 
 function isDefined(value) {
   return typeof value !== 'undefined' && value !== null;
 }
 
 function cleanObject(obj) {
-  return Object.keys(obj).reduce(function (result, key) {
-    var value = obj[key];
+  return Object.keys(obj).reduce((result, key) => {
+    const value = obj[key];
 
     if (Array.isArray(value)) {
-      var values = value.filter(isDefined);
+      const values = value.filter(isDefined);
 
       if (!values.length) {
         return result;
       }
 
-      return _objectSpread2(_objectSpread2({}, result), {}, _defineProperty({}, key, values));
+      return { ...result,
+        [key]: values
+      };
     }
 
     if (isDefined(value)) {
-      return _objectSpread2(_objectSpread2({}, result), {}, _defineProperty({}, key, value));
+      return { ...result,
+        [key]: value
+      };
     }
 
     return result;
@@ -106,152 +56,145 @@ function cleanObject(obj) {
 }
 
 function formatQueryString(variableMap) {
-  var map = cleanObject(variableMap);
-  var result = querystring.stringify(map);
+  const map = cleanObject(variableMap);
+  const result = querystring.stringify(map);
 
   if (result === '') {
     return '';
   }
 
-  return "?".concat(result);
+  return `?${result}`;
 }
 
 function buildRelativeUri(commonRequest) {
-  var pathMap = commonRequest.pathVariables;
+  const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
 
-  for (var param in pathMap) {
-    uri = uri.replace("{".concat(param, "}"), "".concat(pathMap[param]));
+  for (const param in pathMap) {
+    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
   }
 
-  var resQuery = formatQueryString(commonRequest.queryParams || {});
-  return "".concat(uri).concat(resQuery);
+  const resQuery = formatQueryString(commonRequest.queryParams || {});
+  return `${uri}${resQuery}`;
 }
 
-var ApiRequest = /*#__PURE__*/function () {
-  function ApiRequest(request, requestExecutor) {
-    _classCallCheck(this, ApiRequest);
-
+class ApiRequest {
+  constructor(request, requestExecutor) {
     this.requestExecutor = requestExecutor;
 
     _defineProperty(this, "request", void 0);
 
-    this.request = _objectSpread2(_objectSpread2({}, request), {}, {
+    this.request = { ...request,
       uri: buildRelativeUri(request)
-    });
+    };
   }
 
-  _createClass(ApiRequest, [{
-    key: "clientRequest",
-    value: function clientRequest() {
-      return this.request;
-    }
-  }, {
-    key: "execute",
-    value: function execute() {
-      return this.requestExecutor(this.request);
-    }
-  }]);
+  clientRequest() {
+    return this.request;
+  }
 
-  return ApiRequest;
-}();
+  execute() {
+    return this.requestExecutor(this.request);
+  }
 
-var ByProjectKeyByResourceTypeByIDRequestBuilder = /*#__PURE__*/function () {
-  function ByProjectKeyByResourceTypeByIDRequestBuilder(args) {
-    _classCallCheck(this, ByProjectKeyByResourceTypeByIDRequestBuilder);
+}
 
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+class ByProjectKeyByResourceTypeByIDRequestBuilder {
+  constructor(args) {
     this.args = args;
   }
 
-  _createClass(ByProjectKeyByResourceTypeByIDRequestBuilder, [{
-    key: "get",
-    value: function get(methodArgs) {
-      return new ApiRequest({
-        baseUri: this.args.baseUri,
-        method: 'GET',
-        uriTemplate: '/{projectKey}/{resourceType}/{ID}',
-        pathVariables: this.args.pathArgs,
-        headers: _objectSpread2({}, methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers),
-        queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
-      }, this.args.executeRequest);
-    }
-  }]);
-
-  return ByProjectKeyByResourceTypeByIDRequestBuilder;
-}();
+  get(methodArgs) {
+    return new ApiRequest({
+      baseUri: this.args.baseUri,
+      method: 'GET',
+      uriTemplate: '/{projectKey}/{resourceType}/{ID}',
+      pathVariables: this.args.pathArgs,
+      headers: { ...(methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers)
+      },
+      queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
+    }, this.args.executeRequest);
+  }
 
-var ByProjectKeyByResourceTypeRequestBuilder = /*#__PURE__*/function () {
-  function ByProjectKeyByResourceTypeRequestBuilder(args) {
-    _classCallCheck(this, ByProjectKeyByResourceTypeRequestBuilder);
+}
 
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+class ByProjectKeyByResourceTypeRequestBuilder {
+  constructor(args) {
     this.args = args;
   }
 
-  _createClass(ByProjectKeyByResourceTypeRequestBuilder, [{
-    key: "withIDValue",
-    value: function withIDValue(childPathArgs) {
-      return new ByProjectKeyByResourceTypeByIDRequestBuilder({
-        pathArgs: _objectSpread2(_objectSpread2({}, this.args.pathArgs), childPathArgs),
-        executeRequest: this.args.executeRequest,
-        baseUri: this.args.baseUri
-      });
-    }
-  }, {
-    key: "get",
-    value: function get(methodArgs) {
-      return new ApiRequest({
-        baseUri: this.args.baseUri,
-        method: 'GET',
-        uriTemplate: '/{projectKey}/{resourceType}',
-        pathVariables: this.args.pathArgs,
-        headers: _objectSpread2({}, methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers),
-        queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
-      }, this.args.executeRequest);
-    }
-  }]);
+  withIDValue(childPathArgs) {
+    return new ByProjectKeyByResourceTypeByIDRequestBuilder({
+      pathArgs: { ...this.args.pathArgs,
+        ...childPathArgs
+      },
+      executeRequest: this.args.executeRequest,
+      baseUri: this.args.baseUri
+    });
+  }
 
-  return ByProjectKeyByResourceTypeRequestBuilder;
-}();
+  get(methodArgs) {
+    return new ApiRequest({
+      baseUri: this.args.baseUri,
+      method: 'GET',
+      uriTemplate: '/{projectKey}/{resourceType}',
+      pathVariables: this.args.pathArgs,
+      headers: { ...(methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers)
+      },
+      queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
+    }, this.args.executeRequest);
+  }
 
-var ByProjectKeyRequestBuilder = /*#__PURE__*/function () {
-  function ByProjectKeyRequestBuilder(args) {
-    _classCallCheck(this, ByProjectKeyRequestBuilder);
+}
 
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+class ByProjectKeyRequestBuilder {
+  constructor(args) {
     this.args = args;
   }
 
-  _createClass(ByProjectKeyRequestBuilder, [{
-    key: "withResourceTypeValue",
-    value: function withResourceTypeValue(childPathArgs) {
-      return new ByProjectKeyByResourceTypeRequestBuilder({
-        pathArgs: _objectSpread2(_objectSpread2({}, this.args.pathArgs), childPathArgs),
-        executeRequest: this.args.executeRequest,
-        baseUri: this.args.baseUri
-      });
-    }
-  }, {
-    key: "get",
-    value: function get(methodArgs) {
-      return new ApiRequest({
-        baseUri: this.args.baseUri,
-        method: 'GET',
-        uriTemplate: '/{projectKey}',
-        pathVariables: this.args.pathArgs,
-        headers: _objectSpread2({}, methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers),
-        queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
-      }, this.args.executeRequest);
-    }
-  }]);
+  withResourceTypeValue(childPathArgs) {
+    return new ByProjectKeyByResourceTypeRequestBuilder({
+      pathArgs: { ...this.args.pathArgs,
+        ...childPathArgs
+      },
+      executeRequest: this.args.executeRequest,
+      baseUri: this.args.baseUri
+    });
+  }
+
+  get(methodArgs) {
+    return new ApiRequest({
+      baseUri: this.args.baseUri,
+      method: 'GET',
+      uriTemplate: '/{projectKey}',
+      pathVariables: this.args.pathArgs,
+      headers: { ...(methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers)
+      },
+      queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
+    }, this.args.executeRequest);
+  }
 
-  return ByProjectKeyRequestBuilder;
-}();
+}
 
-var ApiRoot = /*#__PURE__*/function () {
-  function ApiRoot(args) {
+class ApiRoot {
+  constructor(args) {
     var _args$baseUri;
 
-    _classCallCheck(this, ApiRoot);
-
     _defineProperty(this, "executeRequest", void 0);
 
     _defineProperty(this, "baseUri", void 0);
@@ -260,51 +203,37 @@ var ApiRoot = /*#__PURE__*/function () {
     this.baseUri = (_args$baseUri = args.baseUri) !== null && _args$baseUri !== void 0 ? _args$baseUri : 'https://history.europe-west1.gcp.commercetools.com';
   }
 
-  _createClass(ApiRoot, [{
-    key: "withProjectKeyValue",
-    value: function withProjectKeyValue(childPathArgs) {
-      return new ByProjectKeyRequestBuilder({
-        pathArgs: _objectSpread2({}, childPathArgs),
-        executeRequest: this.executeRequest,
-        baseUri: this.baseUri
-      });
-    }
-  }]);
+  withProjectKeyValue(childPathArgs) {
+    return new ByProjectKeyRequestBuilder({
+      pathArgs: { ...childPathArgs
+      },
+      executeRequest: this.executeRequest,
+      baseUri: this.baseUri
+    });
+  }
 
-  return ApiRoot;
-}();
+}
 
 /**
- *
- *    Generated file, please do not change!!!
- *    From http://www.commercetools.com/ with love
- *
- *                ,d88b.d88b,
- *                88888888888
- *                `Y8888888Y'
- *                  `Y888Y'
- *                    `Y'
- *
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate <raml_file_path> -o <output_path> -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
  */
-var createExecutorFromMiddlewares = function createExecutorFromMiddlewares(executor, midds) {
+const createExecutorFromMiddlewares = (executor, midds) => {
   if (!midds || midds.length == 0) {
     return executor;
   }
 
-  var reduced = midds.reduce(reduceMiddleware);
+  const reduced = midds.reduce(reduceMiddleware);
   return middlewareToExecutor(reduced, executor);
 };
 
 function reduceMiddleware(middleware1, middleware2) {
-  return function (request, executor) {
-    return middleware1(request, middlewareToExecutor(middleware2, executor));
-  };
+  return (request, executor) => middleware1(request, middlewareToExecutor(middleware2, executor));
 }
 
 function middlewareToExecutor(middleware, executor) {
-  return function (request) {
-    return middleware(request, executor);
-  };
+  return request => middleware(request, executor);
 }
 
 function createApiBuilderFromCtpClient(ctpClient, baseUri) {