@commercetools/connect-payments-sdk 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @commercetools/connect-payments-sdk
 
+## 0.8.0
+
+### Minor Changes
+
+- ae4e53a: - Add and expose a new order-service and order-api
+  - Add functionality to retrieve a order via a paymentId
+  - Add functionality to retrieve a cart via a paymentId
+
 ## 0.7.0
 
 ### Minor Changes

package/dist/commercetools/api/cart-api.d.ts

@@ -1,8 +1,9 @@
-import { Cart } from '@commercetools/platform-sdk';
+import { Cart, CartPagedQueryResponse } from '@commercetools/platform-sdk';
 import { APIOpts, AddPayment, CartAPI } from '../types/api.type';
 import { CommercetoolsBaseAPI } from './base-api';
 export declare class CommercetoolsCartAPI extends CommercetoolsBaseAPI implements CartAPI {
     constructor(opts: APIOpts);
+    find(queryPredicate: string): Promise<CartPagedQueryResponse>;
     getCartById(id: string): Promise<Cart>;
     addPayment(opts: AddPayment): Promise<Cart>;
 }

package/dist/commercetools/api/cart-api.js

@@ -7,6 +7,12 @@ class CommercetoolsCartAPI extends base_api_1.CommercetoolsBaseAPI {
         super(opts);
         Object.setPrototypeOf(this, CommercetoolsCartAPI.prototype);
     }
+    async find(queryPredicate) {
+        return this.executeCall(this.client
+            .carts()
+            .get({ queryArgs: { where: queryPredicate } })
+            .execute());
+    }
     async getCartById(id) {
         return this.executeCall(this.client.carts().withId({ ID: id }).get().execute());
     }

package/dist/commercetools/api/order-api.d.ts

@@ -0,0 +1,7 @@
+import { OrderPagedQueryResponse } from '@commercetools/platform-sdk';
+import { APIOpts, OrderAPI } from '../types/api.type';
+import { CommercetoolsBaseAPI } from './base-api';
+export declare class CommercetoolsOrderAPI extends CommercetoolsBaseAPI implements OrderAPI {
+    constructor(opts: APIOpts);
+    find(queryPredicate: string): Promise<OrderPagedQueryResponse>;
+}

package/dist/commercetools/api/order-api.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommercetoolsOrderAPI = void 0;
+const base_api_1 = require("./base-api");
+class CommercetoolsOrderAPI extends base_api_1.CommercetoolsBaseAPI {
+    constructor(opts) {
+        super(opts);
+        Object.setPrototypeOf(this, CommercetoolsOrderAPI.prototype);
+    }
+    async find(queryPredicate) {
+        return this.executeCall(this.client
+            .orders()
+            .get({ queryArgs: { where: queryPredicate } })
+            .execute());
+    }
+}
+exports.CommercetoolsOrderAPI = CommercetoolsOrderAPI;

package/dist/commercetools/api/root-api.d.ts

@@ -1,10 +1,11 @@
 import { ContextProvider, RequestContextData } from '../../api';
-import { CartAPI, CommercetoolsAPI, CommercetoolsClient, PaymentAPI } from '../types/api.type';
+import { CartAPI, CommercetoolsAPI, CommercetoolsClient, OrderAPI, PaymentAPI } from '../types/api.type';
 import { Logger } from '../..';
 export declare class DefaultCommercetoolsAPI implements CommercetoolsAPI {
     client: CommercetoolsClient;
     cart: CartAPI;
     payment: PaymentAPI;
+    order: OrderAPI;
     private logger;
     constructor(opts: {
         clientId: string;

package/dist/commercetools/api/root-api.js

@@ -5,15 +5,18 @@ const platform_sdk_1 = require("@commercetools/platform-sdk");
 const sdk_client_v2_1 = require("@commercetools/sdk-client-v2");
 const cart_api_1 = require("./cart-api");
 const payment_api_1 = require("./payment-api");
+const order_api_1 = require("./order-api");
 class DefaultCommercetoolsAPI {
     client;
     cart;
     payment;
+    order;
     logger;
     constructor(opts) {
         this.client = createClient(opts);
         this.cart = new cart_api_1.CommercetoolsCartAPI({ client: this.client });
         this.payment = new payment_api_1.CommercetoolsPaymentAPI({ client: this.client });
+        this.order = new order_api_1.CommercetoolsOrderAPI({ client: this.client });
         this.logger = opts.logger;
     }
 }

package/dist/commercetools/index.d.ts

@@ -2,4 +2,5 @@ export { CartService as CommercetoolsCartService } from './types/cart.type';
 export { PaymentService as CommercetoolsPaymentService, TransactionData, UpdatePayment } from './types/payment.type';
 export { SessionService as CommercetoolsSessionService, Session } from './types/session.type';
 export { AuthorizationService as CommercetoolsAuthorizationService } from './types/authorization.type';
-export { Cart, Payment, PaymentDraft, Money, LineItem, CustomLineItem, Address, Transaction, TransactionType, TransactionState, ShippingInfo, } from '@commercetools/platform-sdk';
+export { OrderService as CommercetoolsOrderService } from './types/order.type';
+export { Cart, Order, OrderPagedQueryResponse, Payment, PaymentDraft, Money, LineItem, CustomLineItem, Address, Transaction, TransactionType, TransactionState, ShippingInfo, } from '@commercetools/platform-sdk';

package/dist/commercetools/services/ct-cart.service.d.ts

@@ -1,4 +1,4 @@
-import { CartService, CartServiceOptions, GetCart, GetPaymentAmount } from '../types/cart.type';
+import { CartService, CartServiceOptions, GetCart, GetCartByPaymentIdRequest, GetPaymentAmount } from '../types/cart.type';
 import { Cart } from '@commercetools/platform-sdk';
 import { PaymentAmount } from '../types/payment.type';
 import { AddPayment } from '../types/api.type';
@@ -9,6 +9,7 @@ export declare class DefaultCartService implements CartService {
     private ctAPI;
     private logger;
     constructor(opts: CartServiceOptions);
+    getCartByPaymentId(opts: GetCartByPaymentIdRequest): Promise<Cart>;
     getCart(opts: GetCart): Promise<Cart>;
     getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
     addPayment(opts: AddPayment): Promise<Cart>;

package/dist/commercetools/services/ct-cart.service.js

@@ -13,6 +13,20 @@ class DefaultCartService {
         this.ctAPI = opts.ctAPI;
         this.logger = opts.logger;
     }
+    async getCartByPaymentId(opts) {
+        const queryPredicate = `paymentInfo(payments(id = "${opts.paymentId}"))`;
+        const result = await this.ctAPI.cart.find(queryPredicate);
+        if (result.count != 1) {
+            throw new __1.ErrorReferencedResourceNotFound('cart', queryPredicate, {
+                privateFields: {
+                    queryPredicate,
+                    paymentId: opts.paymentId,
+                },
+                privateMessage: 'Could not find a cart with the given paymentId',
+            });
+        }
+        return result.results[0];
+    }
     async getCart(opts) {
         return await this.ctAPI.cart.getCartById(opts.id);
     }

package/dist/commercetools/services/ct-order.service.d.ts

@@ -0,0 +1,11 @@
+import { GetOrderByPaymentIdRequest, OrderService, OrderServiceOptions } from '../types/order.type';
+import { Order } from '@commercetools/platform-sdk';
+/**
+ * This is the default implementation of the OrderService interface.
+ */
+export declare class DefaultOrderService implements OrderService {
+    private ctAPI;
+    private logger;
+    constructor(opts: OrderServiceOptions);
+    getOrderByPaymentId(opts: GetOrderByPaymentIdRequest): Promise<Order>;
+}

package/dist/commercetools/services/ct-order.service.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultOrderService = void 0;
+const errorx_1 = require("../../errorx");
+/**
+ * This is the default implementation of the OrderService interface.
+ */
+class DefaultOrderService {
+    ctAPI;
+    logger;
+    constructor(opts) {
+        this.ctAPI = opts.ctAPI;
+        this.logger = opts.logger;
+    }
+    async getOrderByPaymentId(opts) {
+        const queryPredicate = `paymentInfo(payments(id = "${opts.paymentId}"))`;
+        const result = await this.ctAPI.order.find(queryPredicate);
+        if (result.count != 1) {
+            throw new errorx_1.ErrorReferencedResourceNotFound('order', queryPredicate, {
+                privateFields: {
+                    queryPredicate,
+                    paymentId: opts.paymentId,
+                },
+                privateMessage: 'Could not find a order with the given paymentId',
+            });
+        }
+        return result.results[0];
+    }
+}
+exports.DefaultOrderService = DefaultOrderService;

package/dist/commercetools/types/api.type.d.ts

@@ -1,4 +1,4 @@
-import { Cart, Payment, PaymentDraft, PaymentPagedQueryResponse, PaymentUpdateAction } from '@commercetools/platform-sdk';
+import { Cart, CartPagedQueryResponse, OrderPagedQueryResponse, Payment, PaymentDraft, PaymentPagedQueryResponse, PaymentUpdateAction } from '@commercetools/platform-sdk';
 import { ByProjectKeyRequestBuilder } from '@commercetools/platform-sdk/dist/declarations/src/generated/client/by-project-key-request-builder';
 export type CommercetoolsClient = ByProjectKeyRequestBuilder;
 export type CommercetoolsSessionClient = ByProjectKeyRequestBuilder;
@@ -29,6 +29,7 @@ export interface AuthorizationAPI {
 }
 export interface CartAPI {
     getCartById(id: string): Promise<Cart>;
+    find(queryPredicate: string): Promise<CartPagedQueryResponse>;
     addPayment(opts: AddPayment): Promise<Cart>;
 }
 export interface PaymentAPI {
@@ -37,7 +38,11 @@ export interface PaymentAPI {
     createPayment(paymentDraft: PaymentDraft): Promise<Payment>;
     updatePayment(opts: UpdatePayment): Promise<Payment>;
 }
+export interface OrderAPI {
+    find(queryPredicate: string): Promise<OrderPagedQueryResponse>;
+}
 export interface CommercetoolsAPI {
     cart: CartAPI;
     payment: PaymentAPI;
+    order: OrderAPI;
 }

package/dist/commercetools/types/cart.type.d.ts

@@ -13,10 +13,14 @@ export type CartServiceOptions = {
     ctAPI: CommercetoolsAPI;
     logger: Logger;
 };
+export type GetCartByPaymentIdRequest = {
+    paymentId: string;
+};
 /**
  * Cart service interface exposes methods to interact with the commercetools platform API.
  */
 export interface CartService {
+    getCartByPaymentId(opts: GetCartByPaymentIdRequest): Promise<Cart>;
     getCart(opts: GetCart): Promise<Cart>;
     getPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
     addPayment(opts: AddPayment): Promise<Cart>;

package/dist/commercetools/types/order.type.d.ts

@@ -0,0 +1,16 @@
+import { Order } from '@commercetools/platform-sdk';
+import { CommercetoolsAPI } from './api.type';
+import { Logger } from '../../logger';
+export type OrderServiceOptions = {
+    ctAPI: CommercetoolsAPI;
+    logger: Logger;
+};
+export type GetOrderByPaymentIdRequest = {
+    paymentId: string;
+};
+/**
+ * Order service interface exposes methods to interact with the commercetools platform API.
+ */
+export interface OrderService {
+    getOrderByPaymentId(opts: GetOrderByPaymentIdRequest): Promise<Order>;
+}

package/dist/commercetools/types/order.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/errorx/errorx.d.ts

@@ -118,7 +118,7 @@ export declare class ErrorReferenceExists extends Errorx {
  * Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
  */
 export declare class ErrorReferencedResourceNotFound extends Errorx {
-    constructor(typeId: string, id?: string, key?: string, additionalOpts?: ErrorxAdditionalOpts);
+    constructor(typeId: string, predicate: string, additionalOpts?: ErrorxAdditionalOpts);
 }
 /**
  * ReferencedResourceNotFound (https://docs.commercetools.com/api/errors#referencedresourcenotfound)

package/dist/errorx/errorx.js

@@ -233,16 +233,15 @@ exports.ErrorReferenceExists = ErrorReferenceExists;
  * Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
  */
 class ErrorReferencedResourceNotFound extends Errorx {
-    constructor(typeId, id, key, additionalOpts) {
+    constructor(typeId, predicate, additionalOpts) {
         const { fields, ...rest } = additionalOpts || {};
         super({
             code: 'ReferencedResourceNotFound',
             httpErrorStatus: 400,
-            message: `The referenced object of type ${typeId} ${id || key} was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account).`,
+            message: `The referenced object of type '${typeId}' '${predicate}' was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account).`,
             fields: {
                 ...fields,
-                id,
-                key,
+                predicate,
                 typeId,
             },
             ...rest,

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { JWTAuthenticationHook, Oauth2AuthenticationHook, RequestContextData, Re
 import { DefaultCommercetoolsAPI } from './commercetools/api/root-api';
 import { DefaultAuthorizationService } from './commercetools/services/ct-authorization.service';
 import { DefaultCartService } from './commercetools/services/ct-cart.service';
+import { DefaultOrderService } from './commercetools/services/ct-order.service';
 import { DefaultPaymentService } from './commercetools/services/ct-payment.service';
 import { Logger } from './logger';
 export * from './api';
@@ -24,6 +25,7 @@ export declare const setupPaymentSDK: (opts: {
 }) => {
     ctAPI: DefaultCommercetoolsAPI;
     ctCartService: DefaultCartService;
+    ctOrderService: DefaultOrderService;
     ctPaymentService: DefaultPaymentService;
     ctAuthorizationService: DefaultAuthorizationService;
     contextProvider: RequestContextProvider;

package/dist/index.js

@@ -19,6 +19,7 @@ const api_1 = require("./api");
 const root_api_1 = require("./commercetools/api/root-api");
 const ct_authorization_service_1 = require("./commercetools/services/ct-authorization.service");
 const ct_cart_service_1 = require("./commercetools/services/ct-cart.service");
+const ct_order_service_1 = require("./commercetools/services/ct-order.service");
 const ct_payment_service_1 = require("./commercetools/services/ct-payment.service");
 const ct_session_service_1 = require("./commercetools/services/ct-session.service");
 const base_decorator_1 = require("./fetch/decorators/base.decorator");
@@ -48,6 +49,7 @@ const setupPaymentSDK = (opts) => {
         logger,
     });
     const ctCartService = new ct_cart_service_1.DefaultCartService({ ctAPI, logger });
+    const ctOrderService = new ct_order_service_1.DefaultOrderService({ ctAPI, logger });
     const ctPaymentService = new ct_payment_service_1.DefaultPaymentService({ ctAPI, logger });
     const ctAuthorizationService = new ct_authorization_service_1.DefaultAuthorizationService({
         authUrl: opts.authUrl,
@@ -128,6 +130,7 @@ const setupPaymentSDK = (opts) => {
     return {
         ctAPI,
         ctCartService,
+        ctOrderService,
         ctPaymentService,
         ctAuthorizationService,
         contextProvider,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,7 +16,7 @@
   "license": "ISC",
   "dependencies": {
     "@commercetools-backend/loggers": "22.27.0",
-    "@commercetools/platform-sdk": "7.8.0",
+    "@commercetools/platform-sdk": "7.9.0",
     "@commercetools/sdk-client-v2": "2.5.0",
     "jsonwebtoken": "9.0.2",
     "jwks-rsa": "3.1.0",