orvex-pay 1.0.0

package/README.md

@@ -0,0 +1,56 @@
+# OrvexPay Node.js SDK
+
+The official Node.js SDK for integrating with the OrvexPay API. Fast, type-safe, and easy to use.
+
+## Installation
+
+```bash
+npm install orvex-pay
+```
+
+## Getting Started
+
+Initialize the client with your API Key (from the Merchant Dashboard).
+
+```typescript
+import { OrvexClient } from 'orvex-pay';
+
+const orvex = new OrvexClient({
+  apiKey: 'your_api_key_here.xxxxxxxxxxxxxxxxxxxxxxxx',
+});
+
+// Create a new invoice payment link
+async function main() {
+  try {
+    const invoice = await orvex.invoices.create({
+      priceAmount: 50.00,
+      priceCurrency: "USD",
+      payCurrency: "USDT",
+      orderId: "ORDER-12345",
+      successUrl: "https://yourwebsite.com/success",
+      cancelUrl: "https://yourwebsite.com/cancel",
+      orderDescription: "Premium Subscription"
+    });
+
+    console.log("Payment URL:", invoice.payUrl);
+  } catch (error) {
+    console.error("Error creating invoice:", error);
+  }
+}
+
+main();
+```
+
+## Resources
+
+Currently, this SDK supports the `invoices` resource.
+
+### `orvex.invoices.create(params)`
+Creates a new payment invoice and returns an `InvoiceResponse` containing the `payUrl`.
+
+### `orvex.invoices.retrieve(invoiceId)`
+Gets the status of an existing invoice using its `invoiceId`. 
+
+---
+
+*For full API documentation, visit the [OrvexPay Developer Portal](https://orvexpay.com/developers/docs).*

package/dist/index.d.mts

@@ -0,0 +1,65 @@
+import { AxiosInstance } from 'axios';
+
+interface CreateInvoiceRequest {
+    /** The amount the merchant wants to receive, e.g. "100.00" */
+    priceAmount: string | number;
+    /** The fiat currency of the price, e.g. "TRY", "USD", "EUR" */
+    priceCurrency: string;
+    /** The cryptocurrency the user will pay in, e.g. "USDT", "BTC" */
+    payCurrency: string;
+    /** Customer's return URL after successful payment */
+    successUrl: string;
+    /** Customer's return URL after choosing to cancel */
+    cancelUrl: string;
+    /** Merchant's internal reference ID for this order */
+    orderId: string;
+    /** Optional description for the order to display on the checkout page */
+    orderDescription?: string;
+    /** Whether the merchant or customer pays the network fee (Merchant or Customer) */
+    feePayer?: 'Merchant' | 'Customer';
+}
+interface InvoiceResponse {
+    id: string;
+    invoiceId: string;
+    orderId: string;
+    priceAmount: number;
+    priceCurrency: string;
+    payAmount: number;
+    payCurrency: string;
+    payAddress: string;
+    status: string;
+    createdAt: string;
+    expiresAt: string;
+    payUrl: string;
+}
+interface OrvexApiClientOptions {
+    /** The API Key generated from your Merchant Dashboard */
+    apiKey: string;
+    /** Optional custom base URL. Defaults to https://api.orvexpay.com */
+    baseURL?: string;
+}
+
+declare class InvoicesResource {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Creates a new payment invoice.
+     * @param params
+     * @returns
+     */
+    create(params: CreateInvoiceRequest): Promise<InvoiceResponse>;
+    /**
+     * Retrieves an invoice by its invoiceId.
+     * @param id The invoice ID returned by the initial API call
+     * @returns
+     */
+    retrieve(invoiceId: string): Promise<InvoiceResponse>;
+}
+
+declare class OrvexClient {
+    invoices: InvoicesResource;
+    private readonly client;
+    constructor(options: OrvexApiClientOptions);
+}
+
+export { type CreateInvoiceRequest, type InvoiceResponse, InvoicesResource, type OrvexApiClientOptions, OrvexClient };

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import { AxiosInstance } from 'axios';
+
+interface CreateInvoiceRequest {
+    /** The amount the merchant wants to receive, e.g. "100.00" */
+    priceAmount: string | number;
+    /** The fiat currency of the price, e.g. "TRY", "USD", "EUR" */
+    priceCurrency: string;
+    /** The cryptocurrency the user will pay in, e.g. "USDT", "BTC" */
+    payCurrency: string;
+    /** Customer's return URL after successful payment */
+    successUrl: string;
+    /** Customer's return URL after choosing to cancel */
+    cancelUrl: string;
+    /** Merchant's internal reference ID for this order */
+    orderId: string;
+    /** Optional description for the order to display on the checkout page */
+    orderDescription?: string;
+    /** Whether the merchant or customer pays the network fee (Merchant or Customer) */
+    feePayer?: 'Merchant' | 'Customer';
+}
+interface InvoiceResponse {
+    id: string;
+    invoiceId: string;
+    orderId: string;
+    priceAmount: number;
+    priceCurrency: string;
+    payAmount: number;
+    payCurrency: string;
+    payAddress: string;
+    status: string;
+    createdAt: string;
+    expiresAt: string;
+    payUrl: string;
+}
+interface OrvexApiClientOptions {
+    /** The API Key generated from your Merchant Dashboard */
+    apiKey: string;
+    /** Optional custom base URL. Defaults to https://api.orvexpay.com */
+    baseURL?: string;
+}
+
+declare class InvoicesResource {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Creates a new payment invoice.
+     * @param params
+     * @returns
+     */
+    create(params: CreateInvoiceRequest): Promise<InvoiceResponse>;
+    /**
+     * Retrieves an invoice by its invoiceId.
+     * @param id The invoice ID returned by the initial API call
+     * @returns
+     */
+    retrieve(invoiceId: string): Promise<InvoiceResponse>;
+}
+
+declare class OrvexClient {
+    invoices: InvoicesResource;
+    private readonly client;
+    constructor(options: OrvexApiClientOptions);
+}
+
+export { type CreateInvoiceRequest, type InvoiceResponse, InvoicesResource, type OrvexApiClientOptions, OrvexClient };

package/dist/index.js

@@ -0,0 +1,104 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  InvoicesResource: () => InvoicesResource,
+  OrvexClient: () => OrvexClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var import_axios = __toESM(require("axios"));
+
+// src/resources/invoices.ts
+var InvoicesResource = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Creates a new payment invoice.
+   * @param params 
+   * @returns 
+   */
+  async create(params) {
+    try {
+      const response = await this.client.post("/api/invoice", params);
+      return response.data;
+    } catch (error) {
+      if (error.response && error.response.data) {
+        throw new Error(`OrvexPay API Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+  /**
+   * Retrieves an invoice by its invoiceId.
+   * @param id The invoice ID returned by the initial API call
+   * @returns 
+   */
+  async retrieve(invoiceId) {
+    try {
+      const response = await this.client.get(`/api/invoice/${invoiceId}`);
+      return response.data;
+    } catch (error) {
+      if (error.response && error.response.data) {
+        throw new Error(`OrvexPay API Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+};
+
+// src/client.ts
+var OrvexClient = class {
+  invoices;
+  client;
+  constructor(options) {
+    if (!options.apiKey) {
+      throw new Error("OrvexPay: apiKey is required to initialize the client.");
+    }
+    this.client = import_axios.default.create({
+      baseURL: options.baseURL ? options.baseURL.replace(/\/$/, "") : "https://api.orvexpay.com",
+      headers: {
+        "x-api-key": options.apiKey,
+        "Content-Type": "application/json"
+      },
+      timeout: 3e4
+    });
+    this.invoices = new InvoicesResource(this.client);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  InvoicesResource,
+  OrvexClient
+});

package/dist/index.mjs

@@ -0,0 +1,66 @@
+// src/client.ts
+import axios from "axios";
+
+// src/resources/invoices.ts
+var InvoicesResource = class {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Creates a new payment invoice.
+   * @param params 
+   * @returns 
+   */
+  async create(params) {
+    try {
+      const response = await this.client.post("/api/invoice", params);
+      return response.data;
+    } catch (error) {
+      if (error.response && error.response.data) {
+        throw new Error(`OrvexPay API Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+  /**
+   * Retrieves an invoice by its invoiceId.
+   * @param id The invoice ID returned by the initial API call
+   * @returns 
+   */
+  async retrieve(invoiceId) {
+    try {
+      const response = await this.client.get(`/api/invoice/${invoiceId}`);
+      return response.data;
+    } catch (error) {
+      if (error.response && error.response.data) {
+        throw new Error(`OrvexPay API Error: ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+};
+
+// src/client.ts
+var OrvexClient = class {
+  invoices;
+  client;
+  constructor(options) {
+    if (!options.apiKey) {
+      throw new Error("OrvexPay: apiKey is required to initialize the client.");
+    }
+    this.client = axios.create({
+      baseURL: options.baseURL ? options.baseURL.replace(/\/$/, "") : "https://api.orvexpay.com",
+      headers: {
+        "x-api-key": options.apiKey,
+        "Content-Type": "application/json"
+      },
+      timeout: 3e4
+    });
+    this.invoices = new InvoicesResource(this.client);
+  }
+};
+export {
+  InvoicesResource,
+  OrvexClient
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "orvex-pay",
+  "version": "1.0.0",
+  "description": "Official Node.js SDK for the OrvexPay API",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "orvexpay",
+    "crypto",
+    "payment",
+    "sdk"
+  ],
+  "author": "OrvexPay",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  }
+}

package/src/client.ts

@@ -0,0 +1,25 @@
+import axios, { AxiosInstance } from 'axios';
+import { OrvexApiClientOptions } from './types';
+import { InvoicesResource } from './resources/invoices';
+
+export class OrvexClient {
+    public invoices: InvoicesResource;
+    private readonly client: AxiosInstance;
+
+    constructor(options: OrvexApiClientOptions) {
+        if (!options.apiKey) {
+            throw new Error('OrvexPay: apiKey is required to initialize the client.');
+        }
+
+        this.client = axios.create({
+            baseURL: options.baseURL ? options.baseURL.replace(/\/$/, '') : 'https://api.orvexpay.com',
+            headers: {
+                'x-api-key': options.apiKey,
+                'Content-Type': 'application/json',
+            },
+            timeout: 30000,
+        });
+
+        this.invoices = new InvoicesResource(this.client);
+    }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './types';
+export * from './resources/invoices';

package/src/resources/invoices.ts

@@ -0,0 +1,44 @@
+import { AxiosInstance } from 'axios';
+import { CreateInvoiceRequest, InvoiceResponse } from '../types';
+
+export class InvoicesResource {
+    private client: AxiosInstance;
+
+    constructor(client: AxiosInstance) {
+        this.client = client;
+    }
+
+    /**
+     * Creates a new payment invoice.
+     * @param params 
+     * @returns 
+     */
+    async create(params: CreateInvoiceRequest): Promise<InvoiceResponse> {
+        try {
+            const response = await this.client.post<InvoiceResponse>('/api/invoice', params);
+            return response.data;
+        } catch (error: any) {
+            if (error.response && error.response.data) {
+                throw new Error(`OrvexPay API Error: ${JSON.stringify(error.response.data)}`);
+            }
+            throw error;
+        }
+    }
+
+    /**
+     * Retrieves an invoice by its invoiceId.
+     * @param id The invoice ID returned by the initial API call
+     * @returns 
+     */
+    async retrieve(invoiceId: string): Promise<InvoiceResponse> {
+        try {
+            const response = await this.client.get<InvoiceResponse>(`/api/invoice/${invoiceId}`);
+            return response.data;
+        } catch (error: any) {
+            if (error.response && error.response.data) {
+                throw new Error(`OrvexPay API Error: ${JSON.stringify(error.response.data)}`);
+            }
+            throw error;
+        }
+    }
+}

package/src/types.ts

@@ -0,0 +1,40 @@
+export interface CreateInvoiceRequest {
+    /** The amount the merchant wants to receive, e.g. "100.00" */
+    priceAmount: string | number;
+    /** The fiat currency of the price, e.g. "TRY", "USD", "EUR" */
+    priceCurrency: string;
+    /** The cryptocurrency the user will pay in, e.g. "USDT", "BTC" */
+    payCurrency: string;
+    /** Customer's return URL after successful payment */
+    successUrl: string;
+    /** Customer's return URL after choosing to cancel */
+    cancelUrl: string;
+    /** Merchant's internal reference ID for this order */
+    orderId: string;
+    /** Optional description for the order to display on the checkout page */
+    orderDescription?: string;
+    /** Whether the merchant or customer pays the network fee (Merchant or Customer) */
+    feePayer?: 'Merchant' | 'Customer';
+}
+
+export interface InvoiceResponse {
+    id: string;
+    invoiceId: string;
+    orderId: string;
+    priceAmount: number;
+    priceCurrency: string;
+    payAmount: number;
+    payCurrency: string;
+    payAddress: string;
+    status: string;
+    createdAt: string;
+    expiresAt: string;
+    payUrl: string;
+}
+
+export interface OrvexApiClientOptions {
+    /** The API Key generated from your Merchant Dashboard */
+    apiKey: string;
+    /** Optional custom base URL. Defaults to https://api.orvexpay.com */
+    baseURL?: string;
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "declaration": true,
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "outDir": "./dist"
+    },
+    "include": [
+        "src/**/*"
+    ]
+}