@gradientedge/commercetools-utils 5.3.1 → 5.5.0

package/dist/typings/models/subscription.d.ts

@@ -1,7 +1,21 @@
 import { BaseResource, CreatedBy, LastModifiedBy, Reference } from './common';
 import { UserProvidedIdentifiers } from './message';
+export type AwsAuthenticationMode = 'Credentials' | 'IAM' | string;
 export interface ChangeSubscription {
-    readonly resourceTypeId: string;
+    readonly resourceTypeId: ChangeSubscriptionResourceTypeId;
+}
+export type ChangeSubscriptionResourceTypeId = 'business-unit' | 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-price' | 'product-selection' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'standalone-price' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone' | string;
+export interface CloudEventsPayload {
+    readonly specversion: string;
+    readonly id: string;
+    readonly type: string;
+    readonly source: string;
+    readonly subject: string;
+    readonly time: string;
+    readonly sequence?: string;
+    readonly sequencetype?: string;
+    readonly dataref?: string;
+    readonly data: DeliveryPayload;
 }
 export type DeliveryFormat = CloudEventsFormat | PlatformFormat;
 export interface CloudEventsFormat {
@@ -9,7 +23,7 @@ export interface CloudEventsFormat {
     readonly cloudEventsVersion: string;
 }
 export type DeliveryPayload = MessageDeliveryPayload | ResourceCreatedDeliveryPayload | ResourceDeletedDeliveryPayload | ResourceUpdatedDeliveryPayload;
-export type Destination = AzureEventGridDestination | AzureServiceBusDestination | EventBridgeDestination | GoogleCloudPubSubDestination | IronMqDestination | SnsDestination | SqsDestination;
+export type Destination = AzureEventGridDestination | AzureServiceBusDestination | EventBridgeDestination | GoogleCloudPubSubDestination | SnsDestination | SqsDestination;
 export interface AzureEventGridDestination {
     readonly type: 'EventGrid';
     readonly uri: string;
@@ -29,10 +43,6 @@ export interface GoogleCloudPubSubDestination {
     readonly projectId: string;
     readonly topic: string;
 }
-export interface IronMqDestination {
-    readonly type: 'IronMQ';
-    readonly uri: string;
-}
 export interface MessageDeliveryPayload {
     readonly notificationType: 'Message';
     readonly projectKey: string;
@@ -44,12 +54,13 @@ export interface MessageDeliveryPayload {
     readonly lastModifiedAt: string;
     readonly sequenceNumber: number;
     readonly resourceVersion: number;
-    readonly payloadNotIncluded: PayloadNotIncluded;
+    readonly payloadNotIncluded?: PayloadNotIncluded;
 }
 export interface MessageSubscription {
-    readonly resourceTypeId: string;
+    readonly resourceTypeId: MessageSubscriptionResourceTypeId;
     readonly types?: string[];
 }
+export type MessageSubscriptionResourceTypeId = 'associate-role' | 'business-unit' | 'category' | 'customer' | 'inventory-entry' | 'order' | 'payment' | 'product' | 'product-selection' | 'quote' | 'quote-request' | 'review' | 'staged-quote' | 'standalone-price' | 'store' | string;
 export interface PayloadNotIncluded {
     readonly reason: string;
     readonly payloadType: string;
@@ -85,16 +96,18 @@ export interface ResourceUpdatedDeliveryPayload {
 }
 export interface SnsDestination {
     readonly type: 'SNS';
-    readonly accessKey: string;
-    readonly accessSecret: string;
+    readonly accessKey?: string;
+    readonly accessSecret?: string;
     readonly topicArn: string;
+    readonly authenticationMode?: AwsAuthenticationMode;
 }
 export interface SqsDestination {
     readonly type: 'SQS';
-    readonly accessKey: string;
-    readonly accessSecret: string;
+    readonly accessKey?: string;
+    readonly accessSecret?: string;
     readonly queueUrl: string;
     readonly region: string;
+    readonly authenticationMode?: AwsAuthenticationMode;
 }
 export interface Subscription extends BaseResource {
     readonly id: string;
@@ -117,12 +130,12 @@ export interface SubscriptionDraft {
     readonly messages?: MessageSubscription[];
     readonly format?: DeliveryFormat;
 }
-export type SubscriptionHealthStatus = 'ConfigurationError' | 'ConfigurationErrorDeliveryStopped' | 'Healthy' | 'TemporaryError';
+export type SubscriptionHealthStatus = 'ConfigurationError' | 'ConfigurationErrorDeliveryStopped' | 'Healthy' | 'TemporaryError' | string;
 export interface SubscriptionPagedQueryResponse {
     readonly limit: number;
+    readonly offset: number;
     readonly count: number;
     readonly total?: number;
-    readonly offset: number;
     readonly results: Subscription[];
 }
 export interface SubscriptionUpdate {

package/dist/typings/models/tax-category.d.ts

@@ -45,6 +45,7 @@ export interface TaxCategoryUpdate {
 export type TaxCategoryUpdateAction = TaxCategoryAddTaxRateAction | TaxCategoryChangeNameAction | TaxCategoryRemoveTaxRateAction | TaxCategoryReplaceTaxRateAction | TaxCategorySetDescriptionAction | TaxCategorySetKeyAction;
 export interface TaxRate {
     readonly id?: string;
+    readonly key?: string;
     readonly name: string;
     readonly amount: number;
     readonly includedInPrice: boolean;
@@ -59,6 +60,7 @@ export interface TaxRateDraft {
     readonly country: string;
     readonly state?: string;
     readonly subRates?: SubRate[];
+    readonly key?: string;
 }
 export interface TaxCategoryAddTaxRateAction {
     readonly action: 'addTaxRate';
@@ -70,11 +72,13 @@ export interface TaxCategoryChangeNameAction {
 }
 export interface TaxCategoryRemoveTaxRateAction {
     readonly action: 'removeTaxRate';
-    readonly taxRateId: string;
+    readonly taxRateId?: string;
+    readonly taxRateKey?: string;
 }
 export interface TaxCategoryReplaceTaxRateAction {
     readonly action: 'replaceTaxRate';
-    readonly taxRateId: string;
+    readonly taxRateId?: string;
+    readonly taxRateKey?: string;
     readonly taxRate: TaxRateDraft;
 }
 export interface TaxCategorySetDescriptionAction {

package/dist/typings/models/type.d.ts

@@ -7,7 +7,7 @@ export interface CustomFieldLocalizedEnumValue {
     readonly key: string;
     readonly label: LocalizedString;
 }
-export type CustomFieldReferenceValue = 'cart' | 'category' | 'channel' | 'customer' | 'key-value-document' | 'order' | 'product' | 'product-type' | 'review' | 'shipping-method' | 'state' | 'zone';
+export type CustomFieldReferenceValue = 'cart' | 'category' | 'channel' | 'customer' | 'key-value-document' | 'order' | 'product' | 'product-type' | 'review' | 'shipping-method' | 'state' | 'zone' | string;
 export interface CustomFields {
     readonly type: TypeReference;
     readonly fields: FieldContainer;
@@ -67,7 +67,7 @@ export interface CustomFieldStringType {
 export interface CustomFieldTimeType {
     readonly name: 'Time';
 }
-export type ResourceTypeId = 'address' | 'asset' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'quote' | 'review' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'store' | 'transaction';
+export type ResourceTypeId = 'address' | 'asset' | 'associate-role' | 'business-unit' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'quote' | 'review' | 'shipping' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'standalone-price' | 'store' | 'transaction' | string;
 export interface Type extends BaseResource {
     readonly id: string;
     readonly version: number;
@@ -105,7 +105,7 @@ export interface TypeResourceIdentifier {
     readonly id?: string;
     readonly key?: string;
 }
-export type TypeTextInputHint = 'MultiLine' | 'SingleLine';
+export type TypeTextInputHint = 'MultiLine' | 'SingleLine' | string;
 export interface TypeUpdate {
     readonly version: number;
     readonly actions: TypeUpdateAction[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/commercetools-utils",
-  "version": "5.3.1",
+  "version": "5.5.0",
   "description": "Provide utility classes and functions for interacting with the commercetools API",
   "main": "./dist/ge-commercetools-utils-node.cjs.js",
   "module": "./dist/ge-commercetools-utils-node.esm.js",
@@ -25,7 +25,7 @@
     "prettify": "prettier --write \"**/*.{ts,js,json,graphql}\"",
     "test": "TZ=UTC jest --passWithNoTests --runInBand",
     "validate": "npm run prettier && npm run lint && npm run test",
-    "docs": "typedoc",
+    "docs": "typedoc --readme ./README.md",
     "semantic-release": "semantic-release",
     "bundle": "npm run bundle-browser && npm run bundle-node",
     "bundle-browser": "webpack --config=webpack.config.browser.js",
@@ -55,42 +55,42 @@
   },
   "homepage": "https://github.com/gradientedge/commercetools-utils#readme",
   "devDependencies": {
-    "@sinonjs/fake-timers": "10.0.2",
-    "@types/jest": "29.5.0",
+    "@sinonjs/fake-timers": "10.3.0",
+    "@types/jest": "29.5.2",
     "@types/json-stringify-safe": "5.0.0",
-    "@types/lodash": "4.14.192",
+    "@types/lodash": "4.14.195",
     "@types/lodash.clonedeep": "4.5.7",
-    "@types/node": "18.15.11",
+    "@types/node": "20.3.1",
     "@types/qs": "6.9.7",
     "@types/sinonjs__fake-timers": "8.1.2",
     "@types/traverse": "0.6.32",
-    "@typescript-eslint/eslint-plugin": "5.57.1",
-    "@typescript-eslint/parser": "5.57.1",
+    "@typescript-eslint/eslint-plugin": "5.60.0",
+    "@typescript-eslint/parser": "5.60.0",
     "codecov": "3.8.3",
     "commitizen": "4.3.0",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "8.37.0",
+    "eslint": "8.43.0",
     "eslint-config-prettier": "8.8.0",
     "husky": "8.0.3",
     "jest": "29.5.0",
     "jest-matcher-specific-error": "1.0.0",
     "jest-mock": "29.5.0",
-    "nock": "13.3.0",
-    "prettier": "2.8.7",
-    "rimraf": "4.4.1",
-    "semantic-release": "21.0.1",
+    "nock": "13.3.1",
+    "prettier": "2.8.8",
+    "rimraf": "5.0.1",
+    "semantic-release": "21.0.5",
     "ts-jest": "29.1.0",
     "ts-node": "^10.9.1",
-    "typedoc": "0.23.28",
-    "typescript": "5.0.3",
-    "webpack": "5.78.0",
-    "webpack-cli": "5.0.1"
+    "typedoc": "0.24.8",
+    "typescript": "5.1.3",
+    "webpack": "5.87.0",
+    "webpack-cli": "5.1.4"
   },
   "dependencies": {
     "@tshttp/status": "^2.0.0",
-    "axios": "1.3.5",
+    "axios": "1.4.0",
     "json-stringify-safe": "5.0.1",
-    "qs": "6.11.1",
+    "qs": "6.11.2",
     "traverse": "0.6.7"
   },
   "config": {