@monkeyplus/payscope 1.0.0

package/dist/_chunks/index.d.mts

@@ -0,0 +1,178 @@
+import { Checkout, ItemTable, Product, ProductStock, Provider, ResponsePay, Store, Transaction } from "./db.mjs";
+import { Model } from "@monkeyplus/unorm";
+interface CustomerObjectBase<T> {
+  id: string;
+  customerId: string;
+  storeId: number;
+  data: T;
+}
+interface Address {
+  zip: string;
+  city: string;
+  phone: string;
+  country: string;
+  address1: string;
+  address2: string;
+  lastName: string;
+  firstName: string;
+  province?: string;
+}
+type CustomerAddress = CustomerObjectBase<Address>;
+interface Discount {
+  coupon: string;
+  customerId: string;
+  storeId: number;
+}
+interface Graphql {
+  session: Model;
+  checkout: Model<Checkout>;
+  transaction: Model<Transaction>;
+  refunds: Model;
+  products: Model<Product>;
+  orders: Model;
+  taxes: Model;
+  stores: Model<Store>;
+  extensions: Model;
+  users: Model;
+  customers: Model;
+  customerBillings: Model;
+  customerAddresses: Model<CustomerAddress>;
+  customerWhislists: Model;
+  customerReturns: Model;
+  links: Model;
+  productStocks: Model<ProductStock>;
+  discounts: Model<Discount>;
+  keys: Model;
+  namespaceKeys: Model;
+}
+/**
+ * Checkout
+ */
+interface OptionsCheckout {
+  billingInfo: any;
+  shippingInfo: any;
+  sessionId?: string;
+}
+type CreateCheckout = (items: ItemTable[], options: OptionsCheckout) => Promise<Checkout>;
+type ReadCheckout = (id: string) => Promise<Checkout>;
+type AssociateCheckout = (id: string, sessionId: string, data?: {
+  billingInfo?: any;
+  shippingInfo?: any;
+}) => Promise<Checkout>;
+type PreparePayment = (provider: string, body: {
+  checkoutId: string;
+  sessionId: string;
+  description?: string;
+  extras?: any;
+}, options?: {
+  card?: any;
+  [key: string]: any;
+}) => Promise<any>;
+type PostPreparePayment = (provider: string, body: {
+  transactionId: string;
+  extras?: any;
+}, options?: {
+  card?: any;
+  [key: string]: any;
+}) => Promise<any>;
+type VerifyPayment = (provider: string, uid: string, override?: boolean) => Promise<any>;
+type RefundPayment = (provider: string, uid: string, options?: any) => Promise<any>;
+interface PayPayment {
+  (provider: string, params: {
+    uid: string;
+    [key: string]: unknown;
+  }, checkoutId?: string): Promise<ResponsePay>;
+}
+type WebhookPayment = (provider: string, uid: string, body: any) => Promise<ResponsePay | false>;
+interface SessionOptions {
+  email: string;
+  identification: string;
+  customer: {
+    givenName: string;
+    middleName?: string;
+    surname: string;
+    phone?: string;
+  };
+}
+interface Session {
+  id: string;
+  email: string;
+  storeId: number;
+  hash: string;
+}
+/**
+ * Session
+ */
+type CreateSession = (options: SessionOptions) => Promise<Session>;
+type VerifySession = (options: SessionOptions, hash: string) => Promise<boolean>;
+type CreateTransaction = (payload: {
+  checkoutId: string;
+  sessionId: string;
+  provider: string;
+}) => Promise<Transaction>;
+type ReadTransaction = (id: string) => Promise<Transaction>;
+type UpdateStateTransaction = (poyload: {
+  id: string;
+  status: 'success' | 'failure' | 'pending' | 'created' | 'refund';
+  details: any;
+  extras?: any;
+  ref?: string;
+}) => Promise<Transaction>;
+type RefundTransaction = (poyload: {
+  id: string;
+  details: any;
+}) => Promise<Transaction>;
+/**
+ * Payment object
+ */
+interface Payment {
+  _providers: Record<string, Provider<any>>;
+  $graphql: Graphql;
+  $tasks: UseTasks;
+  providers: string[];
+  getStore: () => Promise<Store>;
+  session: {
+    create: CreateSession;
+    verify: VerifySession;
+  };
+  transaction: {
+    create: CreateTransaction;
+    read: ReadTransaction;
+    updateState: UpdateStateTransaction;
+    refund: RefundTransaction;
+  };
+  checkout: {
+    create: CreateCheckout;
+    read: ReadCheckout;
+    associate: AssociateCheckout;
+  };
+  payment: {
+    prepare: PreparePayment;
+    postPrepare: PostPreparePayment;
+    pay: PayPayment;
+    verify: VerifyPayment;
+    refund: RefundPayment;
+    webhook?: WebhookPayment;
+  };
+}
+interface PaymentOptions {
+  storeId: number;
+  secret: string;
+  providers: Record<string, Provider>;
+  graphql: Graphql;
+  tasks: {
+    url: string;
+    headers?: any;
+  };
+}
+interface CreatePayment {
+  (options: PaymentOptions): Payment;
+}
+interface UseTasks {
+  addJob: (identifier: string, payload: any, spec?: {
+    queueName?: string;
+    priority?: number;
+    runAt?: Date;
+  }) => Promise<void>;
+}
+export { CreatePayment, Graphql, Payment, UseTasks };