zibri 2.1.7 → 2.2.1

package/dist/cjs/plugin/payment/providers/pay-pal/pay-pal-client.js

@@ -0,0 +1,468 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayPalClient = exports.RefundCaptureResp = exports.AuthorizationCaptureResp = exports.GetOrderResp = exports.CaptureOrderResp = exports.PayPalCapture = void 0;
+const zibri_di_tokens_default_1 = require("../../../../di/default/zibri-di-tokens.default");
+const inject_function_1 = require("../../../../di/inject.function");
+const property_decorator_1 = require("../../../../entity/decorators/property.decorator");
+const known_header_enum_1 = require("../../../../http/known-header.enum");
+const mime_type_enum_1 = require("../../../../http/mime-type.enum");
+/**
+ * Response for authenticating with pay-pal.
+ */
+class AuthResp {
+    /**
+     * The actual access token value.
+     */
+    access_token;
+    /**
+     * In how much seconds the access token becomes invalid.
+     */
+    expires_in;
+}
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], AuthResp.prototype, "access_token", void 0);
+__decorate([
+    property_decorator_1.Property.number(),
+    __metadata("design:type", Number)
+], AuthResp.prototype, "expires_in", void 0);
+/**
+ * A payment amount, consisting of the value and the currency.
+ */
+class PaymentAmount {
+    /**
+     * The value of the payment.
+     */
+    value;
+    /**
+     * The currency of the payment.
+     */
+    currency_code;
+}
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], PaymentAmount.prototype, "value", void 0);
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], PaymentAmount.prototype, "currency_code", void 0);
+/**
+ * A PayPal link.
+ */
+class PayPalLink {
+    /**
+     * The html href => the actual link.
+     */
+    href;
+    /**
+     * The html rel.
+     */
+    rel;
+    /**
+     * The method of the link.
+     */
+    method;
+}
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], PayPalLink.prototype, "href", void 0);
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], PayPalLink.prototype, "rel", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], PayPalLink.prototype, "method", void 0);
+/**
+ * Response for creating a order.
+ */
+class CreateOrderResp {
+    /**
+     * The id of the order.
+     */
+    id;
+    /**
+     * The status of the order.
+     */
+    status;
+    /**
+     * The links of the order.
+     */
+    links;
+}
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], CreateOrderResp.prototype, "id", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], CreateOrderResp.prototype, "status", void 0);
+__decorate([
+    property_decorator_1.Property.array({ required: false, items: { type: 'object', cls: () => PayPalLink } }),
+    __metadata("design:type", Array)
+], CreateOrderResp.prototype, "links", void 0);
+/**
+ * Represents a capture returned inside purchase_units[].payments.captures.
+ */
+class PayPalCapture {
+    /**
+     * The id of a captured payment.
+     */
+    id;
+    /**
+     * The status of the capture.
+     */
+    status;
+}
+exports.PayPalCapture = PayPalCapture;
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], PayPalCapture.prototype, "id", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], PayPalCapture.prototype, "status", void 0);
+/**
+ * Payments object inside a purchase_unit.
+ */
+class PayPalPayments {
+    /**
+     * The payment captures.
+     */
+    captures;
+}
+__decorate([
+    property_decorator_1.Property.array({ required: false, items: { type: 'object', cls: () => PayPalCapture } }),
+    __metadata("design:type", Array)
+], PayPalPayments.prototype, "captures", void 0);
+/**
+ * Purchase_unit in capture response.
+ */
+class PayPalPurchaseUnit {
+    /**
+     * Any payments that belong to this purchase unit.
+     */
+    payments;
+}
+__decorate([
+    property_decorator_1.Property.object({ required: false, cls: () => PayPalPayments }),
+    __metadata("design:type", PayPalPayments)
+], PayPalPurchaseUnit.prototype, "payments", void 0);
+/**
+ * Typed response for captureOrder.
+ */
+class CaptureOrderResp {
+    /**
+     * The id of the captured order.
+     */
+    id;
+    /**
+     * The status of the capture.
+     */
+    status;
+    /**
+     * The purchase units of the capture.
+     */
+    purchase_units;
+}
+exports.CaptureOrderResp = CaptureOrderResp;
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], CaptureOrderResp.prototype, "id", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], CaptureOrderResp.prototype, "status", void 0);
+__decorate([
+    property_decorator_1.Property.array({ required: false, items: { type: 'object', cls: () => PayPalPurchaseUnit } }),
+    __metadata("design:type", Array)
+], CaptureOrderResp.prototype, "purchase_units", void 0);
+/**
+ * Authorization (Reservation) of a payment.
+ */
+class PayPalAuthorization {
+    /**
+     * The id of the authorization.
+     */
+    id;
+    /**
+     * The status of the authorization.
+     */
+    status;
+    /**
+     * The amount that has been authorized.
+     */
+    amount;
+}
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], PayPalAuthorization.prototype, "id", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], PayPalAuthorization.prototype, "status", void 0);
+__decorate([
+    property_decorator_1.Property.object({ required: false, cls: () => PaymentAmount }),
+    __metadata("design:type", PaymentAmount)
+], PayPalAuthorization.prototype, "amount", void 0);
+/**
+ * Payments with their authorizations.
+ */
+class PayPalPaymentsWithAuth {
+    /**
+     * The authorizations for the payments.
+     */
+    authorizations;
+}
+__decorate([
+    property_decorator_1.Property.array({ required: false, items: { type: 'object', cls: () => PayPalAuthorization } }),
+    __metadata("design:type", Array)
+], PayPalPaymentsWithAuth.prototype, "authorizations", void 0);
+/**
+ * Purchase units with their authorizations.
+ */
+class PayPalPurchaseUnitWithAuth {
+    /**
+     * The payments including the authorizations.
+     */
+    payments;
+}
+__decorate([
+    property_decorator_1.Property.object({ required: false, cls: () => PayPalPaymentsWithAuth }),
+    __metadata("design:type", PayPalPaymentsWithAuth)
+], PayPalPurchaseUnitWithAuth.prototype, "payments", void 0);
+/**
+ * Response for getting a order.
+ */
+class GetOrderResp {
+    /**
+     * The id of the order.
+     */
+    id;
+    /**
+     * The status of the order.
+     */
+    status;
+    /**
+     * The purchase units of this order.
+     */
+    purchase_units;
+}
+exports.GetOrderResp = GetOrderResp;
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], GetOrderResp.prototype, "id", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], GetOrderResp.prototype, "status", void 0);
+__decorate([
+    property_decorator_1.Property.array({ required: false, items: { type: 'object', cls: () => PayPalPurchaseUnitWithAuth } }),
+    __metadata("design:type", Array)
+], GetOrderResp.prototype, "purchase_units", void 0);
+/**
+ * Response for capturing an authorization.
+ */
+class AuthorizationCaptureResp {
+    /**
+     * The id of the authorization.
+     */
+    id;
+    /**
+     * The status of the authorization.
+     */
+    status;
+    /**
+     * Any links that belong to this authorization.
+     */
+    links;
+}
+exports.AuthorizationCaptureResp = AuthorizationCaptureResp;
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], AuthorizationCaptureResp.prototype, "id", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], AuthorizationCaptureResp.prototype, "status", void 0);
+__decorate([
+    property_decorator_1.Property.array({ required: false, items: { type: 'object', cls: () => PayPalLink } }),
+    __metadata("design:type", Array)
+], AuthorizationCaptureResp.prototype, "links", void 0);
+/**
+ * Result for capturing a refund.
+ */
+class RefundCaptureResp {
+    /**
+     * The id of the refund.
+     */
+    id;
+    /**
+     * The status of the refund.
+     */
+    status;
+    /**
+     * Any links that belong to this refund.
+     */
+    links;
+}
+exports.RefundCaptureResp = RefundCaptureResp;
+__decorate([
+    property_decorator_1.Property.string(),
+    __metadata("design:type", String)
+], RefundCaptureResp.prototype, "id", void 0);
+__decorate([
+    property_decorator_1.Property.string({ required: false }),
+    __metadata("design:type", String)
+], RefundCaptureResp.prototype, "status", void 0);
+__decorate([
+    property_decorator_1.Property.array({ required: false, items: { type: 'object', cls: () => PayPalLink } }),
+    __metadata("design:type", Array)
+], RefundCaptureResp.prototype, "links", void 0);
+/**
+ * Client for handling anything related with the PayPal API.
+ */
+class PayPalClient {
+    options;
+    baseUrl;
+    token;
+    http;
+    constructor(options) {
+        this.options = options;
+        this.baseUrl = options.env === 'live' ? 'https://api-m.paypal.com' : 'https://api-m.sandbox.paypal.com';
+        this.http = (0, inject_function_1.inject)(zibri_di_tokens_default_1.ZIBRI_DI_TOKENS.HTTP_CLIENT);
+    }
+    async getAccessToken() {
+        const nowInMs = Date.now();
+        if (this.token && this.token.expiresAt > nowInMs + 5000) {
+            return this.token.accessToken;
+        }
+        const url = `${this.baseUrl}/v1/oauth2/token`;
+        const auth = Buffer.from(`${this.options.clientId}:${this.options.clientSecret}`).toString('base64');
+        const body = 'grant_type=client_credentials';
+        const resp = (await this.http.post(url, body, {
+            headers: {
+                [known_header_enum_1.KnownHeader.AUTHORIZATION]: `Basic ${auth}`,
+                [known_header_enum_1.KnownHeader.CONTENT_TYPE]: mime_type_enum_1.MimeType.FORM_URL_ENCODED
+            },
+            responseBody: AuthResp
+        })).body;
+        this.token = {
+            accessToken: resp.access_token,
+            expiresAt: Date.now() + (resp.expires_in * 1000)
+        };
+        return this.token.accessToken;
+    }
+    /**
+     * Creates a new Order.
+     * @param body - The create body as required by the api.
+     * @returns The created order.
+     */
+    async createOrder(body) {
+        const token = await this.getAccessToken();
+        const url = `${this.baseUrl}/v2/checkout/orders`;
+        return (await this.http.post(url, body, {
+            responseBody: CreateOrderResp,
+            headers: {
+                Authorization: `Bearer ${token}`
+            }
+        })).body;
+    }
+    /**
+     * Captures a completed order with the given id.
+     * @param orderId - The id of the order to capture.
+     * @returns The captured order.
+     */
+    async captureOrder(orderId) {
+        const token = await this.getAccessToken();
+        const url = `${this.baseUrl}/v2/checkout/orders/${encodeURIComponent(orderId)}/capture`;
+        const resp = (await this.http.post(url, {}, {
+            responseBody: CaptureOrderResp,
+            headers: {
+                Authorization: `Bearer ${token}`
+            }
+        })).body;
+        return resp;
+    }
+    /**
+     * Gets an order with the given id.
+     * @param orderId - The id of the order to retrieve.
+     * @returns The found order.
+     */
+    async getOrder(orderId) {
+        const token = await this.getAccessToken();
+        const url = `${this.baseUrl}/v2/checkout/orders/${encodeURIComponent(orderId)}`;
+        return (await this.http.get(url, {
+            responseBody: GetOrderResp,
+            headers: {
+                Authorization: `Bearer ${token}`
+            }
+        })).body;
+    }
+    /**
+     * Captures authorization with the given id.
+     * @param authorizationId - The id of the (already confirmed) authorization.
+     * @param amount - The amount to capture.
+     * @returns The captured authorization.
+     */
+    async captureAuthorization(authorizationId, amount) {
+        const token = await this.getAccessToken();
+        const url = `${this.baseUrl}/v2/payments/authorizations/${encodeURIComponent(authorizationId)}/capture`;
+        return (await this.http.post(url, { amount }, {
+            responseBody: AuthorizationCaptureResp,
+            headers: {
+                Authorization: `Bearer ${token}`
+            }
+        })).body;
+    }
+    /**
+     * Cancels the existing authorization with the given id.
+     * @param authorizationId - The id of the authorization to cancel.
+     */
+    async voidAuthorization(authorizationId) {
+        const token = await this.getAccessToken();
+        const url = `${this.baseUrl}/v2/payments/authorizations/${encodeURIComponent(authorizationId)}/void`;
+        await this.http.post(url, {}, {
+            headers: {
+                Authorization: `Bearer ${token}`
+            }
+        });
+    }
+    /**
+     * Refunds the payment of the capture with the given id.
+     * @param captureId - The id of the capture to refund.
+     * @param amount - The amount to refund.
+     * @returns The refund result.
+     */
+    async refundCapture(captureId, amount) {
+        const token = await this.getAccessToken();
+        const url = `${this.baseUrl}/v2/payments/captures/${encodeURIComponent(captureId)}/refund`;
+        return (await this.http.post(url, { amount }, {
+            responseBody: RefundCaptureResp,
+            headers: {
+                Authorization: `Bearer ${token}`
+            }
+        })).body;
+    }
+}
+exports.PayPalClient = PayPalClient;
+//# sourceMappingURL=pay-pal-client.js.map

package/dist/cjs/plugin/payment/providers/pay-pal/pay-pal-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay-pal-client.js","sourceRoot":"","sources":["../../../../../../src/plugin/payment/providers/pay-pal/pay-pal-client.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,4FAAiF;AACjF,oEAAwD;AACxD,yFAA4E;AAC5E,0EAAiE;AACjE,oEAA2D;AAwB3D;;GAEG;AACH,MAAM,QAAQ;IACV;;OAEG;IAEH,YAAY,CAAU;IACtB;;OAEG;IAEH,UAAU,CAAU;CACvB;AANG;IADC,6BAAQ,CAAC,MAAM,EAAE;;8CACI;AAKtB;IADC,6BAAQ,CAAC,MAAM,EAAE;;4CACE;AAGxB;;GAEG;AACH,MAAM,aAAa;IACf;;OAEG;IAEH,KAAK,CAAU;IACf;;OAEG;IAEH,aAAa,CAAU;CAC1B;AANG;IADC,6BAAQ,CAAC,MAAM,EAAE;;4CACH;AAKf;IADC,6BAAQ,CAAC,MAAM,EAAE;;oDACK;AAG3B;;GAEG;AACH,MAAM,UAAU;IACZ;;OAEG;IAEH,IAAI,CAAU;IACd;;OAEG;IAEH,GAAG,CAAU;IACb;;OAEG;IAEH,MAAM,CAAU;CACnB;AAXG;IADC,6BAAQ,CAAC,MAAM,EAAE;;wCACJ;AAKd;IADC,6BAAQ,CAAC,MAAM,EAAE;;uCACL;AAKb;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;0CACrB;AAGpB;;GAEG;AACH,MAAM,eAAe;IACjB;;OAEG;IAEH,EAAE,CAAU;IACZ;;OAEG;IAEH,MAAM,CAAU;IAChB;;OAEG;IAEH,KAAK,CAAgB;CACxB;AAXG;IADC,6BAAQ,CAAC,MAAM,EAAE;;2CACN;AAKZ;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;+CACrB;AAKhB;IADC,6BAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;;8CACjE;AAmCzB;;GAEG;AACH,MAAa,aAAa;IACtB;;OAEG;IAEH,EAAE,CAAU;IAEZ;;OAEG;IAEH,MAAM,CAAU;CACnB;AAZD,sCAYC;AAPG;IADC,6BAAQ,CAAC,MAAM,EAAE;;yCACN;AAMZ;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;6CACrB;AAGpB;;GAEG;AACH,MAAM,cAAc;IAChB;;OAEG;IAEH,QAAQ,CAAmB;CAC9B;AADG;IADC,6BAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC;;gDAC9D;AAG/B;;GAEG;AACH,MAAM,kBAAkB;IACpB;;OAEG;IAEH,QAAQ,CAAkB;CAC7B;AADG;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC;8BACrD,cAAc;oDAAC;AAG9B;;GAEG;AACH,MAAa,gBAAgB;IACzB;;OAEG;IAEH,EAAE,CAAU;IAEZ;;OAEG;IAEH,MAAM,CAAU;IAEhB;;OAEG;IAEH,cAAc,CAAwB;CACzC;AAlBD,4CAkBC;AAbG;IADC,6BAAQ,CAAC,MAAM,EAAE;;4CACN;AAMZ;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;gDACrB;AAMhB;IADC,6BAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,kBAAkB,EAAE,EAAE,CAAC;;wDACxD;AAG1C;;GAEG;AACH,MAAM,mBAAmB;IACrB;;OAEG;IAEH,EAAE,CAAU;IAEZ;;OAEG;IAEH,MAAM,CAAU;IAEhB;;OAEG;IAEH,MAAM,CAAiB;CAC1B;AAbG;IADC,6BAAQ,CAAC,MAAM,EAAE;;+CACN;AAMZ;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;mDACrB;AAMhB;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC;8BACtD,aAAa;mDAAC;AAG3B;;GAEG;AACH,MAAM,sBAAsB;IACxB;;OAEG;IAEH,cAAc,CAAyB;CAC1C;AADG;IADC,6BAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,mBAAmB,EAAE,EAAE,CAAC;;8DACxD;AAG3C;;GAEG;AACH,MAAM,0BAA0B;IAC5B;;OAEG;IAEH,QAAQ,CAA0B;CACrC;AADG;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,sBAAsB,EAAE,CAAC;8BAC7D,sBAAsB;4DAAC;AAGtC;;GAEG;AACH,MAAa,YAAY;IACrB;;OAEG;IAEH,EAAE,CAAU;IAEZ;;OAEG;IAEH,MAAM,CAAU;IAEhB;;OAEG;IAEH,cAAc,CAAgC;CACjD;AAlBD,oCAkBC;AAbG;IADC,6BAAQ,CAAC,MAAM,EAAE;;wCACN;AAMZ;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;4CACrB;AAMhB;IADC,6BAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,0BAA0B,EAAE,EAAE,CAAC;;oDACxD;AAGlD;;GAEG;AACH,MAAa,wBAAwB;IACjC;;OAEG;IAEH,EAAE,CAAU;IAEZ;;OAEG;IAEH,MAAM,CAAU;IAEhB;;OAEG;IAEH,KAAK,CAAgB;CACxB;AAlBD,4DAkBC;AAbG;IADC,6BAAQ,CAAC,MAAM,EAAE;;oDACN;AAMZ;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;wDACrB;AAMhB;IADC,6BAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;;uDACjE;AAGzB;;GAEG;AACH,MAAa,iBAAiB;IAC1B;;OAEG;IAEH,EAAE,CAAU;IAEZ;;OAEG;IAEH,MAAM,CAAU;IAEhB;;OAEG;IAEH,KAAK,CAAgB;CACxB;AAlBD,8CAkBC;AAbG;IADC,6BAAQ,CAAC,MAAM,EAAE;;6CACN;AAMZ;IADC,6BAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;iDACrB;AAMhB;IADC,6BAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;;gDACjE;AAGzB;;GAEG;AACH,MAAa,YAAY;IAKQ;IAJZ,OAAO,CAAS;IACzB,KAAK,CAAqB;IACjB,IAAI,CAAsB;IAE3C,YAA6B,OAA8B;QAA9B,YAAO,GAAP,OAAO,CAAuB;QACvD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,kCAAkC,CAAC;QACxG,IAAI,CAAC,IAAI,GAAG,IAAA,wBAAM,EAAC,yCAAe,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IAEO,KAAK,CAAC,cAAc;QACxB,MAAM,OAAO,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;YACtD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;QAClC,CAAC;QAED,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,OAAO,kBAAkB,CAAC;QACtD,MAAM,IAAI,GAAW,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE7G,MAAM,IAAI,GAAW,+BAA+B,CAAC;QAErD,MAAM,IAAI,GAAa,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE;YACpD,OAAO,EAAE;gBACL,CAAC,+BAAW,CAAC,aAAa,CAAC,EAAE,SAAS,IAAI,EAAE;gBAC5C,CAAC,+BAAW,CAAC,YAAY,CAAC,EAAE,yBAAQ,CAAC,gBAAgB;aACxD;YACD,YAAY,EAAE,QAAQ;SACzB,CAAC,CAAC,CAAC,IAAI,CAAC;QAET,IAAI,CAAC,KAAK,GAAG;YACT,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;SACnD,CAAC;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,IAAqB;QACnC,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,OAAO,qBAAqB,CAAC;QAEzD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CACxB,GAAG,EACH,IAAI,EACJ;YACI,YAAY,EAAE,eAAe;YAC7B,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,KAAK,EAAE;aACnC;SACJ,CACJ,CAAC,CAAC,IAAI,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAAe;QAC9B,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,OAAO,uBAAuB,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC;QAEhG,MAAM,IAAI,GAAqB,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAChD,GAAG,EACH,EAAE,EACF;YACI,YAAY,EAAE,gBAAgB;YAC9B,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,KAAK,EAAE;aACnC;SACJ,CACJ,CAAC,CAAC,IAAI,CAAC;QAER,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC1B,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,OAAO,uBAAuB,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QACxF,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;YAC7B,YAAY,EAAE,YAAY;YAC1B,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,KAAK,EAAE;aACnC;SACJ,CAAC,CAAC,CAAC,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CAAC,eAAuB,EAAE,MAAqB;QACrE,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,OAAO,+BAA+B,kBAAkB,CAAC,eAAe,CAAC,UAAU,CAAC;QAEhH,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE;YAC1C,YAAY,EAAE,wBAAwB;YACtC,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,KAAK,EAAE;aACnC;SACJ,CAAC,CAAC,CAAC,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,eAAuB;QAC3C,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,OAAO,+BAA+B,kBAAkB,CAAC,eAAe,CAAC,OAAO,CAAC;QAE7G,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE;YAC1B,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,KAAK,EAAE;aACnC;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,MAAqB;QACxD,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,GAAG,GAAW,GAAG,IAAI,CAAC,OAAO,yBAAyB,kBAAkB,CAAC,SAAS,CAAC,SAAS,CAAC;QAEnG,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE;YAC1C,YAAY,EAAE,iBAAiB;YAC/B,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,KAAK,EAAE;aACnC;SACJ,CAAC,CAAC,CAAC,IAAI,CAAC;IACb,CAAC;CACJ;AAlJD,oCAkJC"}

package/dist/cjs/plugin/payment/providers/pay-pal/pay-pal.payment-provider.d.ts

@@ -0,0 +1,184 @@
+import { PaymentProviderInterface } from '../payment-provider.interface';
+import { PayPalClient } from './pay-pal-client';
+import { Repository } from '../../../../data-source/repository';
+import { KnownPaymentMethod } from '../../models/payment-method.model';
+import { Payment } from '../../models/payment.model';
+/**
+ * The environment of the pay-pal client.
+ */
+type PayPalEnv = 'sandbox' | 'live';
+/**
+ * The supported methods of the PayPalPaymentProvider.
+ */
+type SupportedMethods = [KnownPaymentMethod.PAY_PAL];
+/**
+ * The data for creating a new payment.
+ */
+type PayPalPaymentData = {
+    /**
+     * The amount of the payment.
+     */
+    amount: number;
+    /**
+     * The currency of the payment.
+     */
+    currencyCode: string;
+    /**
+     * The url to return to to confirm the payment.
+     */
+    returnUrl?: string;
+    /**
+     * The url to return to to cancel the payment.
+     */
+    cancelUrl?: string;
+    /**
+     * The transactionId, used to prevent duplicate payments.
+     */
+    transactionId: string;
+};
+/**
+ * The validated payment data.
+ */
+type PayPalValidatedPaymentData = PayPalPaymentData;
+/**
+ * The payment data stored by the provider.
+ */
+type PayPalProviderPaymentData = {
+    /**
+     * The id of the order.
+     */
+    orderId?: string;
+    /**
+     * The url to navigate to for approval.
+     */
+    approvalUrl?: string;
+    /**
+     * The id of the authorization.
+     */
+    authorizationId?: string;
+    /**
+     * The id of the payment capture.
+     */
+    captureId?: string;
+};
+/**
+ * The payment reservation data.
+ */
+type PayPalProviderReservationPaymentData = PayPalProviderPaymentData;
+/**
+ * Maps payment methods to their payment data.
+ */
+type PaymentDataMap = {
+    /**
+     * The payment data for the PayPal payment method.
+     */
+    PAY_PAL: PayPalPaymentData;
+};
+/**
+ * Maps payment methods to their validated payment data.
+ */
+type ValidatedPaymentDataMap = {
+    /**
+     * The validated payment data for the PayPal payment method.
+     */
+    PAY_PAL: PayPalValidatedPaymentData;
+};
+/**
+ * Maps payment methods to their provider payment data.
+ */
+type ProviderPaymentDataMap = {
+    /**
+     * The provider payment data for the PayPal payment method.
+     */
+    PAY_PAL: PayPalProviderPaymentData;
+};
+/**
+ * Maps payment methods to their provider reservation payment data.
+ */
+type ProviderReservationPaymentDataMap = {
+    /**
+     * The provider reservation payment data for the PayPal payment method.
+     */
+    PAY_PAL: PayPalProviderReservationPaymentData;
+};
+/**
+ * Defines whether a given method supports cancellation.
+ */
+type CancellationSupport = {
+    /**
+     * PayPal.
+     */
+    PAY_PAL: true;
+};
+/**
+ * Defines whether a given method supports refunding.
+ */
+type RefundSupport = {
+    /**
+     * PayPal.
+     */
+    PAY_PAL: true;
+};
+/**
+ * Defines whether a given method supports reservation.
+ */
+type ReservationSupport = {
+    /**
+     * PayPal.
+     */
+    PAY_PAL: true;
+};
+/**
+ * Options for configuring the PayPalPaymentProvider.
+ */
+export type PayPalProviderOptions = {
+    /**
+     * The clientId needed to authenticate with the api.
+     */
+    clientId: string;
+    /**
+     * The clientSecret needed to authenticate with the api.
+     */
+    clientSecret: string;
+    /**
+     * The PayPal environment, either 'sandbox' or 'live'.
+     */
+    env: PayPalEnv;
+};
+/**
+ * Payment Provider that uses the PayPal API.
+ */
+export declare class PayPalPaymentProvider implements PaymentProviderInterface<SupportedMethods, PaymentDataMap, ValidatedPaymentDataMap, ProviderPaymentDataMap, ProviderReservationPaymentDataMap, CancellationSupport, RefundSupport, ReservationSupport> {
+    readonly name: string;
+    readonly cancellationSupported: CancellationSupport;
+    readonly refundSupported: RefundSupport;
+    readonly reservationSupported: ReservationSupport;
+    /**
+     * Client that encapsulates the PayPal API.
+     */
+    protected readonly client: PayPalClient;
+    constructor(name: string, options: PayPalProviderOptions);
+    /**
+     * Injects a correctly typed payment repository.
+     * @returns A correctly typed payment repository.
+     */
+    protected getPaymentRepository<M extends SupportedMethods[number], Data extends ProviderPaymentDataMap[M] | ProviderReservationPaymentDataMap[M]>(): Repository<Payment<M, Data>>;
+    validatePaymentData<M extends SupportedMethods[number]>(method: M, data: PaymentDataMap[M]): ValidatedPaymentDataMap[M];
+    startPayment<M extends SupportedMethods[number]>(method: M, data: ValidatedPaymentDataMap[M]): Promise<Payment<M, ProviderPaymentDataMap[M]>>;
+    startPaymentReservation<M extends {
+        [K in SupportedMethods[number]]: ReservationSupport[K] extends true ? K : never;
+    }[SupportedMethods[number]]>(method: M, data: ValidatedPaymentDataMap[M]): Promise<Payment<M, ProviderReservationPaymentDataMap[M]>>;
+    confirmPaymentReservation<M extends {
+        [K in SupportedMethods[number]]: ReservationSupport[K] extends true ? K : never;
+    }[SupportedMethods[number]]>(payment: Payment<M, ProviderReservationPaymentDataMap[M]>): Promise<void>;
+    confirmPayment<M extends SupportedMethods[number]>(payment: Payment<M, ProviderPaymentDataMap[M]>): Promise<void>;
+    collectPaymentFromReservation<M extends {
+        [K in SupportedMethods[number]]: ReservationSupport[K] extends true ? K : never;
+    }[SupportedMethods[number]]>(payment: Payment<M, ProviderReservationPaymentDataMap[M]>): Promise<void>;
+    cancelPayment<M extends KnownPaymentMethod.PAY_PAL>(payment: Payment<M, ProviderPaymentDataMap[M]> | Payment<M, ProviderReservationPaymentDataMap[M]>): Promise<void>;
+    refundPayment<M extends {
+        [K in SupportedMethods[number]]: RefundSupport[K] extends true ? K : never;
+    }[SupportedMethods[number]]>(payment: Payment<M, ProviderPaymentDataMap[M]>): Promise<void>;
+}
+export {};
+//# sourceMappingURL=pay-pal.payment-provider.d.ts.map

package/dist/cjs/plugin/payment/providers/pay-pal/pay-pal.payment-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay-pal.payment-provider.d.ts","sourceRoot":"","sources":["../../../../../../src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAA2E,YAAY,EAAqB,MAAM,kBAAkB,CAAC;AAC5I,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAGhE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAErD;;GAEG;AACH,KAAK,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,KAAK,gBAAgB,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;AAErD;;GAEG;AACH,KAAK,iBAAiB,GAAG;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACxB,CAAC;AAEF;;GAEG;AACH,KAAK,0BAA0B,GAAG,iBAAiB,CAAC;AAEpD;;GAEG;AACH,KAAK,yBAAyB,GAAG;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACrB,CAAC;AAEF;;GAEG;AACH,KAAK,oCAAoC,GAAG,yBAAyB,CAAC;AAEtE;;GAEG;AACH,KAAK,cAAc,GAAG;IAClB;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAA;CAC7B,CAAC;AAEF;;GAEG;AACH,KAAK,uBAAuB,GAAG;IAC3B;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAA;CACtC,CAAC;AAEF;;GAEG;AACH,KAAK,sBAAsB,GAAG;IAC1B;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAA;CACrC,CAAC;AAEF;;GAEG;AACH,KAAK,iCAAiC,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,oCAAoC,CAAA;CAChD,CAAC;AAEF;;GAEG;AACH,KAAK,mBAAmB,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,IAAI,CAAA;CAChB,CAAC;AAEF;;GAEG;AACH,KAAK,aAAa,GAAG;IACjB;;OAEG;IACH,OAAO,EAAE,IAAI,CAAA;CAChB,CAAC;AAEF;;GAEG;AACH,KAAK,kBAAkB,GAAG;IACtB;;OAEG;IACH,OAAO,EAAE,IAAI,CAAA;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,GAAG,EAAE,SAAS,CAAA;CACjB,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,YAAW,wBAAwB,CAClE,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,sBAAsB,EACtB,iCAAiC,EACjC,mBAAmB,EACnB,aAAa,EACb,kBAAkB,CACrB;IAcO,QAAQ,CAAC,IAAI,EAAE,MAAM;IAZzB,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAqB;IAExE,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAqB;IAE5D,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAqB;IAEtE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;gBAG3B,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,qBAAqB;IAKlC;;;OAGG;IACH,SAAS,CAAC,oBAAoB,CAC1B,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,EAClC,IAAI,SAAS,sBAAsB,CAAC,CAAC,CAAC,GAAG,iCAAiC,CAAC,CAAC,CAAC,KAC5E,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAKjC,mBAAmB,CAAC,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,EAClD,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GACxB,uBAAuB,CAAC,CAAC,CAAC;IAmBvB,YAAY,CAAC,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACjD,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC;IAyB3C,uBAAuB,CACzB,CAAC,SAAS;SACL,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK;KAClF,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAE3B,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,GACjC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,iCAAiC,CAAC,CAAC,CAAC,CAAC,CAAC;IA0BtD,yBAAyB,CAC3B,CAAC,SAAS;SACL,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK;KAClF,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAC7B,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,iCAAiC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCrE,cAAc,CAAC,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACnD,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAC/C,OAAO,CAAC,IAAI,CAAC;IA+BV,6BAA6B,CAC/B,CAAC,SAAS;SACL,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK;KAClF,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAC7B,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,iCAAiC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAkDrE,aAAa,CAAC,CAAC,SAAS,kBAAkB,CAAC,OAAO,EACpD,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,iCAAiC,CAAC,CAAC,CAAC,CAAC,GAClG,OAAO,CAAC,IAAI,CAAC;IAqCV,aAAa,CACf,CAAC,SAAS;SACL,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK;KAC7E,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAC7B,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CA6BnE"}