@unify-payment/node 0.0.4 → 0.0.6

package/README.md

@@ -13,9 +13,8 @@ UnifyPayment is a TypeScript package that provides a unified interface for integ
 
 - **Stripe:** (Checkout, Webhook) will add more functionality later.
 - **LemonSqueezy:** (Checkout, Webhook) will add more functionality later.
-- **Paddle:** (Checkout, Webhook) will add more functionality later.
 - **SSLCommerz:** (Checkout) will add more functionality later.
-- **PayPal:** (upcoming).
+- **PayPal:** (Checkout) will add more functionality later.
 - **RazorPay:** (upcoming).
 - **GooglePay:** (planing).
 - **Shopify:** (planing).
@@ -32,30 +31,36 @@ npm install @unify-payment/node
 
 ```typescript
 // Stripe
-const unify = new UnifyPayment({
-  stripe: new Stripe(process.env.STRIPE_API_SECRET_KEY!),
-});
-const redirect = await unify.stripe.getCheckoutUrl(stripePayload);
+const stripe = new UnifyPayment.Stripe(process.env.STRIPE_SECRET_KEY!);
+const redirect = await stripe.getCheckoutUrl(stripePayload);
 
 // LemonSqueezy
-const unify = new UnifyPayment({
-  lemonsqueezy: new LemonSqueezy(process.env.LEMON_SECRET_KEY!),
+const lemon = new UnifyPayment.LemonSqueezy(process.env.LEMON_SECRET_KEY!);
+const redirect = await lemon.getCheckoutUrl(lemonsqueezyPayload);
+
+// Paypal
+const paypal = new UnifyPayment.Paypal(process.env.PAYPAL_SECRET_KEY!);
+const redirect = await paypal.getCheckoutUrl(lemonsqueezyPayload);
+
+// SSLCommerz
+const ssl = new UnifyPayment.SSLCommerz({
+  apiUrl: process.env.SSLCOMMERZ_API_URL!,
+  store_id: process.env.SSLCOMMERZ_STORE_ID!,
+  store_passwd: process.env.SSLCOMMERZ_SECRET_KEY!,
 });
-const redirect = await unify.lemonsqueezy.getCheckoutUrl(lemonsqueezyPayload);
+const redirect = await ssl.getCheckoutUrl(sslCommerzPayload);
 ```
 
 ## Webhook
 
 ```typescript
 // Stripe
-const unify = new UnifyPayment({
-  stripe: new Stripe(stripeKey),
-});
+const stripe = new UnifyPayment.Stripe(process.env.STRIPE_SECRET_KEY!);
 
 const sign = c.req.header("Stripe-Signature");
 if (!sign) throw new Error("No Signature");
 
-const webhookEvent = await unify.stripe.webhook.verifySignature({
+const webhookEvent = await stripe.verifySignature({
   signature: sign,
   secret: "PUT YOUR WEBHOOK SECRET HERE",
   body: await c.req.text(),
@@ -72,14 +77,12 @@ switch (webhookEvent.event.type) {
 }
 
 // LemonSqueezy
-const unify = new UnifyPayment({
-  lemonsqueezy: new LemonSqueezy(lemonsqueezyKey),
-});
+const lemon = new UnifyPayment.LemonSqueezy(process.env.LEMON_SECRET_KEY!);
 
 const sign = c.req.header("X-Signature");
 if (!sign) throw new Error("No Signature");
 
-const webhookEvent = await unify.lemonsqueezy.webhook.verifySignature({
+const webhookEvent = await lemon.verifySignature({
   signature: sign,
   secret: "PUT YOUR WEBHOOK SECRET HERE",
   body: await c.req.text(),

package/dist/index.d.mts

@@ -0,0 +1,345 @@
+import Stripe$1, { Stripe as Stripe$2 } from 'stripe';
+
+interface IBkashCheckoutOptions {
+    mode: "0011";
+    payerReference: string;
+    callbackURL: string;
+    amount: string;
+    currency: "BDT";
+    intent: "sale";
+    merchantInvoiceNumber: string;
+    merchantAssociationInfo?: string;
+}
+interface IBkashPayloadProps {
+    apiUrl: string;
+    username: string;
+    password: string;
+    app_key: string;
+    app_secret: string;
+}
+
+type TFetchOptions = {
+    method?: string;
+    headers?: HeadersInit;
+    body?: BodyInit;
+};
+declare class UnifyFetch {
+    jsonFetch<T>(url: string, options?: TFetchOptions): Promise<[T, Response]>;
+    axios<T>(url: string, options?: TFetchOptions): Promise<void>;
+}
+
+declare class Bkash extends UnifyFetch {
+    private options;
+    constructor(options: IBkashPayloadProps);
+    private getAppKey;
+    private getApiBaseUrl;
+    private getApiRequestHeaders;
+    getAccessToken(): Promise<string>;
+    getCheckoutUrl(options: IBkashCheckoutOptions): Promise<string>;
+}
+
+type TLemonSqueezyWebhookEvents = "order_created" | "order_refunded" | "subscription_created" | "subscription_updated" | "subscription_cancelled" | "subscription_resumed" | "subscription_expired" | "subscription_paused" | "subscription_unpaused" | "subscription_payment_success" | "subscription_payment_failed" | "subscription_payment_recovered" | "subscription_payment_refunded" | "license_key_created" | "license_key_updated";
+type TWebhookEventResponse = {
+    error: Error;
+} | {
+    event: ILemonSqueezyWebhookEeventResponse;
+    type: TLemonSqueezyWebhookEvents;
+};
+interface ILemonSqueezyWebhookEeventResponse {
+    meta: {
+        event_name: string;
+        custom_data: {
+            customer_id: number;
+        };
+    };
+    data: {
+        type: "orders" | "subscriptions";
+        id: string;
+        attributes: {
+            store_id: number;
+            customer_id: number;
+            identifier: string;
+            order_number: number;
+            user_name: string;
+            user_email: string;
+            currency: string;
+            currency_rate: string;
+            subtotal: number;
+            discount_total: number;
+            tax: number;
+            total: number;
+            subtotal_usd: number;
+            discount_total_usd: number;
+            tax_usd: number;
+            total_usd: number;
+            tax_name: string;
+            tax_rate: string;
+            status: string;
+            status_formatted: string;
+            refunded: boolean;
+            refunded_at: any;
+            subtotal_formatted: string;
+            discount_total_formatted: string;
+            tax_formatted: string;
+            total_formatted: string;
+            first_order_item: {
+                id: number;
+                order_id: number;
+                product_id: number;
+                variant_id: number;
+                product_name: string;
+                variant_name: string;
+                price: number;
+                created_at: string;
+                updated_at: string;
+                deleted_at: any;
+                test_mode: boolean;
+            };
+            urls: {
+                receipt: string;
+            };
+            created_at: string;
+            updated_at: string;
+        };
+        relationships: {
+            store: {
+                links: {
+                    related: string;
+                    self: string;
+                };
+            };
+            customer: {
+                links: {
+                    related: string;
+                    self: string;
+                };
+            };
+            "order-items": {
+                links: {
+                    related: string;
+                    self: string;
+                };
+            };
+            subscriptions: {
+                links: {
+                    related: string;
+                    self: string;
+                };
+            };
+            "license-keys": {
+                links: {
+                    related: string;
+                    self: string;
+                };
+            };
+            "discount-redemptions": {
+                links: {
+                    related: string;
+                    self: string;
+                };
+            };
+        };
+        links: {
+            self: string;
+        };
+    };
+}
+interface ILemonSqueezyCheckoutOptions {
+    type: "checkouts";
+    attributes?: {
+        custom_price?: number;
+        product_options?: {
+            redirect_url?: string;
+            enabled_variants?: number[];
+        };
+        checkout_options?: {
+            button_color: string;
+        };
+        checkout_data?: {
+            discount_code?: string;
+            custom?: {
+                user_id: number;
+            };
+        };
+        expires_at?: string;
+        preview?: boolean;
+    };
+    relationships: {
+        store: {
+            data: {
+                type: string;
+                id: string;
+            };
+        };
+        variant: {
+            data: {
+                type: string;
+                id: string;
+            };
+        };
+    };
+}
+
+declare class LemonSqueezy extends UnifyFetch {
+    private apiKey;
+    constructor(apiKey: string);
+    private getApiBaseUrl;
+    private getApiRequestHeaders;
+    getCheckoutUrl(options: ILemonSqueezyCheckoutOptions): Promise<string>;
+    verifySignature(payload: {
+        signature: string;
+        secret: string;
+        body: string;
+        x_event: string;
+    }): Promise<TWebhookEventResponse>;
+}
+
+interface IPaypalOptions {
+    clientId: string;
+    clientSecret: string;
+    sandbox?: boolean;
+}
+interface IPaypalPayload {
+    intent: "CAPTURE";
+    purchase_units: {
+        items: {
+            name: string;
+            description: string;
+            quantity: number;
+            unit_amount: {
+                currency_code: "USD" | "EUR";
+                value: string;
+            };
+        }[];
+        amount: {
+            currency_code: "USD" | "EUR";
+            value: string;
+            breakdown: {
+                item_total: {
+                    currency_code: "USD" | "EUR";
+                    value: string;
+                };
+            };
+        };
+    }[];
+    application_context: {
+        return_url: string;
+        cancel_url: string;
+        shipping_preference?: "NO_SHIPPING";
+        user_action?: "PAY_NOW";
+        brand_name?: string;
+    };
+}
+
+declare class Paypal extends UnifyFetch {
+    private options;
+    constructor(options: IPaypalOptions);
+    private getApiBaseUrl;
+    private getClientId;
+    private getClientSecret;
+    private getApiCheckoutUrl;
+    getAccessToken(): Promise<string>;
+    getCheckoutUrl(payload: IPaypalPayload): Promise<string>;
+}
+
+type ISSLCommerzCreateCheckoutPayload = {
+    tran_id: string;
+    store_id: string;
+    store_passwd: string;
+    total_amount: number;
+    currency: "USD" | "EUR";
+    success_url?: string;
+    cancel_url?: string;
+    cus_name: string;
+    cus_email: string;
+    cus_add1: string;
+    cus_add2?: string;
+    cus_city: string;
+    cus_state: string;
+    cus_postcode: string;
+    cus_country: string;
+    cus_phone: string;
+    cus_fax?: string;
+    shipping_method: "NO";
+    product_name: string;
+    product_category: string;
+    product_profile: "general" | "physical-goods" | "non-physical-goods" | "airline-tickets" | "travel-vertical" | "telecom-vertical";
+} | {
+    tran_id: string;
+    store_id: string;
+    store_passwd: string;
+    total_amount: number;
+    currency: "USD" | "EUR";
+    success_url?: string;
+    cancel_url?: string;
+    cus_name: string;
+    cus_email: string;
+    cus_add1: string;
+    cus_add2?: string;
+    cus_city: string;
+    cus_state: string;
+    cus_postcode: string;
+    cus_country: string;
+    cus_phone: string;
+    cus_fax?: string;
+    shipping_method: "YES";
+    ship_name: string;
+    ship_add1: string;
+    ship_add2?: string;
+    ship_city: string;
+    ship_state: string;
+    ship_postcode: string;
+    ship_country: string;
+    product_name: string;
+    product_category: string;
+    product_profile: "general" | "physical-goods" | "non-physical-goods" | "airline-tickets" | "travel-vertical" | "telecom-vertical";
+};
+type ISSLCommerzOptions = {
+    apiUrl: string;
+    store_id: string;
+    store_url?: string;
+    store_passwd: string;
+};
+
+declare class SSLCommerz extends UnifyFetch {
+    private options;
+    constructor(options: ISSLCommerzOptions);
+    private getApiBaseUrl;
+    private getApiCheckoutUrl;
+    private getApiValidationUrl;
+    private getApiRefundUrl;
+    private getApiRefundQueryUrl;
+    private getApiTransactionQueryBySessionIdUrl;
+    private getApiTransactionQueryByTransactionIdUrl;
+    private getApiHeaders;
+    private urlFormEncode;
+    getCheckoutUrl(payload: ISSLCommerzCreateCheckoutPayload): Promise<string>;
+}
+
+type TStripeWebhookEventResponse = {
+    error: Error;
+} | {
+    event: Stripe$1.Event;
+};
+
+declare class Stripe {
+    private apiKey;
+    private stripe;
+    constructor(apiKey: string, config?: Stripe$2.StripeConfig);
+    getCheckoutUrl(params: Stripe$2.Checkout.SessionCreateParams): Promise<string>;
+    verifySignature(payload: {
+        signature: string;
+        secret: string;
+        body: string;
+    }): Promise<TStripeWebhookEventResponse>;
+}
+
+declare const UnifyPayment: {
+    LemonSqueezy: typeof LemonSqueezy;
+    Bkash: typeof Bkash;
+    Paypal: typeof Paypal;
+    SSLCommerz: typeof SSLCommerz;
+    Stripe: typeof Stripe;
+};
+
+export { UnifyPayment };