@evoke-platform/payment 1.0.0-dev.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 System Automation Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './payment';
+export * from './paymentGateway';

package/dist/index.js

@@ -0,0 +1,5 @@
+// Copyright (c) 2023 System Automation Corporation.
+// This file is licensed under the MIT License.
+export * from './payment';
+export * from './paymentGateway';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,+CAA+C;AAE/C,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC"}

package/dist/payment.d.ts

@@ -0,0 +1,83 @@
+export type PaymentStatus = 'NotStarted' | 'InProgress' | 'Cancelled' | 'Declined' | 'Paid';
+export type PaymentMethod = 'CreditCard' | 'eCheck' | 'Cash' | 'Check';
+export type CreditCardType = 'Visa' | 'Mastercard' | 'Discover' | 'AmericanExpress';
+export type PaymentReference = {
+    id: string;
+    name: string;
+};
+export interface PaymentItem {
+    id: string;
+    /**
+     * Description of the payment item.
+     */
+    name: string;
+    contextObjectId?: string;
+    contextInstanceId?: string;
+    quantity: number;
+    unitPrice: number;
+    sku: string;
+    /**
+     * Total amount for the item based on the quantity and unit price.
+     */
+    totalAmount?: number;
+    /**
+     * Refernce to the payment that this item is associated with.
+     */
+    payment?: PaymentReference;
+    customField1?: string;
+    customField2?: string;
+    customField3?: string;
+    customField4?: string;
+    customField5?: string;
+}
+export interface Payment {
+    id: string;
+    /**
+     * Payment number associted with the transaction.
+     */
+    name: string;
+    /**
+     * User initiating the payment transaction.
+     */
+    userId: string;
+    status: PaymentStatus;
+    contextObjectId?: string;
+    contextInstanceId?: string;
+    /**
+     * Timestamp when the payment transaction was started in ISO date time format.
+     */
+    transactionStart?: string;
+    /**
+     * Timestamp when the payment transaction was completed in ISO date time
+     * format.
+     */
+    transactionEnd?: string;
+    /**
+     * Total fees associated with the payment based on the payment items.
+     */
+    feeTotal?: number;
+    paymentItems?: PaymentItem[];
+    successUrl?: string;
+    cancelUrl?: string;
+    customField1?: string;
+    customField2?: string;
+    customField3?: string;
+    customField4?: string;
+    customField5?: string;
+    customField6?: string;
+    customField7?: string;
+    customField8?: string;
+    customField9?: string;
+    customField10?: string;
+    method?: PaymentMethod;
+    cardType?: CreditCardType;
+    amountPaid?: number;
+    /**
+     * Name of the person paying for the transaction.
+     */
+    payer?: string;
+    gatewayTransactionId?: string;
+    gatewayResultCode?: string;
+    gatewayResultMessage?: string;
+    authorizationCode?: string;
+}

package/dist/payment.js

@@ -0,0 +1,4 @@
+// Copyright (c) 2023 System Automation Corporation.
+// This file is licensed under the MIT License.
+export {};
+//# sourceMappingURL=payment.js.map

package/dist/payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.js","sourceRoot":"","sources":["../src/payment.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,+CAA+C"}

package/dist/paymentGateway.d.ts

@@ -0,0 +1,13 @@
+import { Payment } from './payment';
+export interface ParsedQueryString {
+    [key: string]: undefined | string | string[] | ParsedQueryString | ParsedQueryString[];
+}
+export interface TransferData {
+    method: 'GET' | 'POST';
+    url: string;
+    parameters: Record<string, string>;
+}
+export interface PaymentGateway {
+    prepare(payment: Payment, returnUrl: string): TransferData | PromiseLike<TransferData>;
+    postPaymentResult(payment: Payment, resultData: ParsedQueryString): Payment | null | PromiseLike<Payment | null>;
+}

package/dist/paymentGateway.js

@@ -0,0 +1,4 @@
+// Copyright (c) 2023 System Automation Corporation.
+// This file is licensed under the MIT License.
+export {};
+//# sourceMappingURL=paymentGateway.js.map

package/dist/paymentGateway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paymentGateway.js","sourceRoot":"","sources":["../src/paymentGateway.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,+CAA+C"}

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@evoke-platform/payment",
+    "version": "1.0.0-dev.1",
+    "description": "Support for payment gateway integrations in Evoke",
+    "homepage": "https://github.com/Evoke-Platform/evoke-sdk/blob/main/packages/payment/README.md",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Evoke-Platform/evoke-sdk",
+        "directory": "packages/payment"
+    },
+    "bugs": {
+        "url": "https://github.com/Evoke-Platform/evoke-sdk/issues"
+    },
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "build": "tsc",
+        "release": "commit-and-tag-version -t payment@ --releaseCommitMessageFormat \"chore(release): payment@{{currentTag}} [skip ci]\"",
+        "predeploy": "cp ../../LICENSE .",
+        "deploy": "npm publish"
+    },
+    "author": "System Automation Corp.",
+    "license": "MIT",
+    "devDependencies": {
+        "commit-and-tag-version": "^11.2.2",
+        "typescript": "^5.1.6"
+    }
+}