@commercetools/history-sdk 3.6.0 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @commercetools/history-sdk
 
+## 4.0.0
+
+### Major Changes
+
+- [#551](https://github.com/commercetools/commercetools-sdk-typescript/pull/551) [`9e7939a`](https://github.com/commercetools/commercetools-sdk-typescript/commit/9e7939a1df234fd1f4f77c60f4ff75b31d7fc3fd) Thanks [@github-actions](https://github.com/apps/github-actions)! - BREAKING CHANGE:
+
+  - fix URI parameters to be URI encoded
+
+### Minor Changes
+
+- [#527](https://github.com/commercetools/commercetools-sdk-typescript/pull/527) [`00c6176`](https://github.com/commercetools/commercetools-sdk-typescript/commit/00c617692543f9a8d0ac64e81d583f89e002e81b) Thanks [@github-actions](https://github.com/apps/github-actions)! - **History changes**
+
+  <details>
+  <summary>Added Property(s)</summary>
+
+  - added property `businessUnit` to type `Record`
+  </details>
+
+  <details>
+  <summary>Changed Property(s)</summary>
+
+  - :warning: changed property `previousValue` of type `SetNameChange` from type `LocalizedString` to `string`
+  - :warning: changed property `nextValue` of type `SetNameChange` from type `LocalizedString` to `string`
+  </details>
+
+  <details>
+  <summary>Added QueryParameter(s)</summary>
+
+  - added query parameter `businessUnit` to method `get /{projectKey}`
+  - added query parameter `businessUnit` to method `get /{projectKey}/{resourceType}`
+  - added query parameter `businessUnit` to method `get /{projectKey}/{resourceType}/{ID}`
+  </details>
+
+### Patch Changes
+
+- Updated dependencies [[`a6d0df2`](https://github.com/commercetools/commercetools-sdk-typescript/commit/a6d0df2034b72504db2aa2d13a8d3726d97cc881)]:
+  - @commercetools/sdk-client-v2@2.2.2
+
 ## 3.6.0
 
 ### Minor Changes

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

@@ -86,7 +86,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

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

@@ -82,7 +82,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

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

@@ -86,7 +86,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

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

@@ -86,7 +86,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

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

@@ -82,7 +82,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

package/dist/declarations/src/generated/client/by-project-key-by-resource-type-by-id-request-builder.d.ts

@@ -40,6 +40,7 @@ export declare class ByProjectKeyByResourceTypeByIDRequestBuilder {
             clientId?: string;
             customerId?: string;
             associateId?: string;
+            businessUnit?: string;
             type?: string;
             source?: string;
             changes?: string | string[];

package/dist/declarations/src/generated/client/by-project-key-by-resource-type-request-builder.d.ts

@@ -42,6 +42,7 @@ export declare class ByProjectKeyByResourceTypeRequestBuilder {
             clientId?: string;
             customerId?: string;
             associateId?: string;
+            businessUnit?: string;
             type?: string;
             resourceKey?: string;
             source?: string;

package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts

@@ -41,6 +41,7 @@ export declare class ByProjectKeyRequestBuilder {
             clientId?: string;
             customerId?: string;
             associateId?: string;
+            businessUnit?: string;
             type?: string;
             resourceId?: string;
             resourceKey?: string;

package/dist/declarations/src/generated/index.d.ts

@@ -9,5 +9,6 @@ export * from "./models/change-history.js";
 export * from "./models/change-value.js";
 export * from "./models/common.js";
 export * from "./models/label.js";
+export * from "./models/scalar-types.js";
 export * from "./shared/utils/common-types.js";
 export * from "./shared/utils/middleware.js";

package/dist/declarations/src/generated/models/change-history.d.ts

@@ -73,6 +73,12 @@ export interface Record {
      *
      */
     readonly stores: KeyReference[];
+    /**
+     *	Reference to the [Business Unit](ctp:api:type:BusinessUnit) associated with the [Change](ctp:history:type:Change).
+     *
+     *
+     */
+    readonly businessUnit?: KeyReference;
     /**
      *	`true` if no change was detected.
      *

package/dist/declarations/src/generated/models/change.d.ts

@@ -5157,12 +5157,7 @@ export interface SetMiddleNameChange {
     readonly nextValue: string;
 }
 /**
- *	Change triggered by the following update actions:
- *
- *	- [Set Name](ctp:api:type:DiscountCodeSetNameAction) on Discount Codes.
- *	- [Set State Name](ctp:api:type:StateSetNameAction) on States.
- *	- [Set Name](ctp:api:type:StoreSetNameAction) on Stores.
- *
+ *	Change triggered by the [Set Name](ctp:api:type:AssociateRoleSetNameAction) update action.
  */
 export interface SetNameChange {
     readonly type: 'SetNameChange';
@@ -5174,13 +5169,21 @@ export interface SetNameChange {
      *	Value before the change.
      *
      */
-    readonly previousValue: LocalizedString;
+    readonly previousValue: string;
     /**
      *	Value after the change.
      *
      */
-    readonly nextValue: LocalizedString;
+    readonly nextValue: string;
 }
+/**
+ *	Change triggered by the following update actions:
+ *
+ *	- [Set Name](ctp:api:type:DiscountCodeSetNameAction) on Discount Codes.
+ *	- [Set State Name](ctp:api:type:StateSetNameAction) on States.
+ *	- [Set Name](ctp:api:type:StoreSetNameAction) on Stores.
+ *
+ */
 export interface SetLocalizedNameChange {
     readonly type: 'SetLocalizedNameChange';
     /**

package/dist/declarations/src/generated/models/scalar-types.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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/.
+ */
+export type Locale = string;

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "name": "@commercetools/history-sdk",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "engines": {
     "node": ">=14"
   },
@@ -32,13 +32,13 @@
     "./dist/commercetools-history-sdk.esm.js": "./dist/commercetools-history-sdk.browser.esm.js"
   },
   "dependencies": {
-    "@commercetools/sdk-client-v2": "^2.1.6",
+    "@commercetools/sdk-client-v2": "^2.2.2",
     "@commercetools/sdk-middleware-auth": "^7.0.0",
     "@commercetools/sdk-middleware-http": "^7.0.0",
     "@commercetools/sdk-middleware-logger": "^3.0.0"
   },
   "devDependencies": {
-    "@commercetools/platform-sdk": "6.0.0",
+    "@commercetools/platform-sdk": "7.0.0",
     "@types/uuid": "9.0.2",
     "organize-imports-cli": "0.10.0",
     "tsconfig-replace-paths": "0.0.13",