@moneymq/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MoneyMQ
+
+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/README.md

@@ -0,0 +1,262 @@
+# @moneymq/sdk
+
+Core SDK for the MoneyMQ payment platform. Accept stablecoin payments with a Stripe-like API.
+
+## Installation
+
+```bash
+npm install @moneymq/sdk
+# or
+pnpm add @moneymq/sdk
+# or
+yarn add @moneymq/sdk
+```
+
+## Quick Start
+
+```typescript
+import { MoneyMQ } from '@moneymq/sdk';
+
+const moneymq = new MoneyMQ({
+  url: 'http://localhost:8488',
+});
+
+// Create a product
+const product = await moneymq.catalog.products.create({
+  name: 'Pro Plan',
+  description: 'Full access to all features',
+});
+
+// Create a price
+const price = await moneymq.catalog.prices.create({
+  product: product.id,
+  currency: 'USDC',
+  amount: 1000,
+  type: 'one_time',
+});
+
+// Create a checkout session
+const session = await moneymq.payment.checkout.create({
+  lineItems: [{ price: price.id, quantity: 1 }],
+  successUrl: 'https://example.com/success',
+  cancelUrl: 'https://example.com/cancel',
+});
+```
+
+## Configuration
+
+```typescript
+const moneymq = new MoneyMQ({
+  // Required: MoneyMQ API URL
+  url: 'http://localhost:8488',
+
+  // Optional: Secret key for authenticated requests
+  secret: process.env.MONEYMQ_SECRET,
+
+  // Optional: Request timeout in milliseconds (default: 30000)
+  timeout: 30000,
+});
+```
+
+## API Reference
+
+### Catalog
+
+#### Products
+
+```typescript
+// Create a product
+const product = await moneymq.catalog.products.create({
+  name: 'Pro Plan',
+  description: 'Full access',
+  active: true,
+  metadata: { tier: 'premium' },
+});
+
+// Retrieve a product
+const product = await moneymq.catalog.products.retrieve('prod_123');
+
+// List products
+const { data, hasMore } = await moneymq.catalog.products.list({
+  active: true,
+  limit: 10,
+});
+
+// Update a product
+const updated = await moneymq.catalog.products.update('prod_123', {
+  name: 'Enterprise Plan',
+});
+
+// Delete a product
+await moneymq.catalog.products.delete('prod_123');
+```
+
+#### Prices
+
+```typescript
+// Create a one-time price
+const price = await moneymq.catalog.prices.create({
+  product: 'prod_123',
+  currency: 'USDC',
+  amount: 1000,
+  type: 'one_time',
+});
+
+// Create a recurring price
+const subscription = await moneymq.catalog.prices.create({
+  product: 'prod_123',
+  currency: 'USDC',
+  amount: 9900,
+  type: 'recurring',
+  recurring: {
+    interval: 'month',
+    intervalCount: 1,
+  },
+});
+
+// Retrieve a price
+const price = await moneymq.catalog.prices.retrieve('price_123');
+
+// List prices
+const { data } = await moneymq.catalog.prices.list({
+  product: 'prod_123',
+  active: true,
+});
+```
+
+### Payment
+
+#### Checkout Sessions
+
+```typescript
+// Create a checkout session
+const session = await moneymq.payment.checkout.create({
+  lineItems: [
+    { price: 'price_123', quantity: 1 },
+  ],
+  successUrl: 'https://example.com/success?session_id={CHECKOUT_SESSION_ID}',
+  cancelUrl: 'https://example.com/cancel',
+  customer: 'cus_123', // Optional
+  customerEmail: 'user@example.com', // Optional
+  metadata: { orderId: '12345' },
+});
+
+// Retrieve a session
+const session = await moneymq.payment.checkout.retrieve('cs_123');
+```
+
+#### Payment Links
+
+```typescript
+// Create a payment link
+const link = await moneymq.payment.links.create({
+  lineItems: [{ price: 'price_123', quantity: 1 }],
+  expiresAt: new Date('2025-12-31'),
+});
+
+// Retrieve a link
+const link = await moneymq.payment.links.retrieve('plink_123');
+
+// Deactivate a link
+await moneymq.payment.links.deactivate('plink_123');
+```
+
+#### Customers
+
+```typescript
+// Create a customer
+const customer = await moneymq.payment.customers.create({
+  email: 'user@example.com',
+  name: 'John Doe',
+  metadata: { userId: '123' },
+});
+
+// Retrieve with expanded fields
+const customer = await moneymq.payment.customers.retrieve('cus_123', {
+  expand: ['payments', 'subscriptions'],
+});
+
+// Update a customer
+await moneymq.payment.customers.update('cus_123', {
+  name: 'Jane Doe',
+});
+
+// List customers
+const { data } = await moneymq.payment.customers.list({
+  email: 'user@example.com',
+});
+```
+
+#### Payments
+
+```typescript
+// Retrieve a payment
+const payment = await moneymq.payment.retrieve('pay_123');
+
+// List payments
+const { data } = await moneymq.payment.list({
+  customerId: 'cus_123',
+  status: 'completed',
+  limit: 20,
+});
+```
+
+#### Payouts
+
+```typescript
+// Create a payout
+const payout = await moneymq.payment.payouts.create({
+  amount: 100000,
+  currency: 'USDC',
+  destination: 'wallet_address',
+});
+
+// Get payout settings
+const settings = await moneymq.payment.payouts.settings.retrieve();
+
+// Update payout settings
+await moneymq.payment.payouts.settings.update({
+  schedule: 'daily',
+  minimumAmount: 10000,
+});
+```
+
+## Error Handling
+
+```typescript
+import { MoneyMQ, MoneyMQError } from '@moneymq/sdk';
+
+try {
+  await moneymq.catalog.products.retrieve('invalid_id');
+} catch (error) {
+  if (error instanceof MoneyMQError) {
+    console.error('Status:', error.statusCode);
+    console.error('Message:', error.message);
+    console.error('Raw:', error.raw);
+  }
+}
+```
+
+## TypeScript Support
+
+This package includes full TypeScript definitions. All types are exported:
+
+```typescript
+import type {
+  MoneyMQConfig,
+  Product,
+  ProductCreateParams,
+  Price,
+  PriceCreateParams,
+  CheckoutSession,
+  CheckoutCreateParams,
+  PaymentLink,
+  Customer,
+  Payment,
+  Payout,
+} from '@moneymq/sdk';
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,418 @@
+interface Product {
+    id: string;
+    object: 'product';
+    name: string;
+    description?: string;
+    active: boolean;
+    metadata?: Record<string, string>;
+    created: number;
+    updated: number;
+}
+interface ProductCreateParams {
+    name: string;
+    description?: string;
+    active?: boolean;
+    metadata?: Record<string, string>;
+}
+interface ProductListParams {
+    active?: boolean;
+    limit?: number;
+    startingAfter?: string;
+}
+interface Price {
+    id: string;
+    object: 'price';
+    product: string;
+    currency: string;
+    amount: number;
+    type: 'one_time' | 'recurring';
+    recurring?: {
+        interval: 'day' | 'week' | 'month' | 'year';
+        intervalCount: number;
+    };
+    active: boolean;
+    metadata?: Record<string, string>;
+    created: number;
+}
+interface PriceCreateParams {
+    product: string;
+    currency: string;
+    amount: number;
+    type: 'one_time' | 'recurring';
+    recurring?: {
+        interval: 'day' | 'week' | 'month' | 'year';
+        intervalCount?: number;
+    };
+    metadata?: Record<string, string>;
+}
+declare class ProductsAPI {
+    private config;
+    constructor(config: MoneyMQConfig);
+    private request;
+    /**
+     * Create a new product
+     */
+    create(params: ProductCreateParams): Promise<Product>;
+    /**
+     * Retrieve a product by ID
+     */
+    retrieve(id: string): Promise<Product>;
+    /**
+     * List all products
+     */
+    list(params?: ProductListParams): Promise<{
+        data: Product[];
+        hasMore: boolean;
+    }>;
+    /**
+     * Update a product
+     */
+    update(id: string, params: Partial<ProductCreateParams>): Promise<Product>;
+    /**
+     * Delete a product
+     */
+    delete(id: string): Promise<{
+        deleted: boolean;
+    }>;
+}
+declare class PricesAPI {
+    private config;
+    constructor(config: MoneyMQConfig);
+    private request;
+    /**
+     * Create a new price
+     */
+    create(params: PriceCreateParams): Promise<Price>;
+    /**
+     * Retrieve a price by ID
+     */
+    retrieve(id: string): Promise<Price>;
+    /**
+     * List all prices
+     */
+    list(params?: {
+        product?: string;
+        active?: boolean;
+        limit?: number;
+    }): Promise<{
+        data: Price[];
+        hasMore: boolean;
+    }>;
+}
+/**
+ * Catalog API for managing products and prices
+ */
+declare class CatalogAPI {
+    /** Products API */
+    readonly products: ProductsAPI;
+    /** Prices API */
+    readonly prices: PricesAPI;
+    constructor(config: MoneyMQConfig);
+}
+
+interface LineItem {
+    price: string;
+    quantity: number;
+}
+interface CheckoutSession {
+    id: string;
+    object: 'checkout.session';
+    url: string;
+    status: 'open' | 'complete' | 'expired';
+    paymentStatus: 'unpaid' | 'paid';
+    customer?: string;
+    lineItems: LineItem[];
+    successUrl: string;
+    cancelUrl: string;
+    expiresAt: number;
+    created: number;
+}
+interface CheckoutCreateParams {
+    lineItems: LineItem[];
+    successUrl: string;
+    cancelUrl: string;
+    customerEmail?: string;
+    customer?: string;
+    metadata?: Record<string, string>;
+}
+interface PaymentLink {
+    id: string;
+    object: 'payment_link';
+    url: string;
+    active: boolean;
+    lineItems: LineItem[];
+    expiresAt?: number;
+    created: number;
+}
+interface PaymentLinkCreateParams {
+    lineItems: LineItem[];
+    expiresAt?: Date | number;
+    metadata?: Record<string, string>;
+}
+interface Payment {
+    id: string;
+    object: 'payment';
+    amount: number;
+    currency: string;
+    status: 'completed' | 'pending' | 'failed';
+    customer?: string;
+    checkout?: string;
+    signature?: string;
+    metadata?: Record<string, string>;
+    created: number;
+}
+interface PaymentListParams {
+    customerId?: string;
+    status?: 'completed' | 'pending' | 'failed';
+    limit?: number;
+    startingAfter?: string;
+}
+interface Customer {
+    id: string;
+    object: 'customer';
+    email: string;
+    name?: string;
+    metadata?: Record<string, string>;
+    subscriptions?: unknown[];
+    payments?: Payment[];
+    created: number;
+}
+interface CustomerCreateParams {
+    email: string;
+    name?: string;
+    metadata?: Record<string, string>;
+}
+interface CustomerUpdateParams {
+    email?: string;
+    name?: string;
+    metadata?: Record<string, string>;
+}
+interface Payout {
+    id: string;
+    object: 'payout';
+    amount: number;
+    currency: string;
+    status: 'pending' | 'completed' | 'failed';
+    destination: string;
+    created: number;
+}
+interface PayoutCreateParams {
+    amount: number;
+    currency: string;
+    destination: string;
+}
+interface PayoutListParams {
+    status?: 'pending' | 'completed' | 'failed';
+    limit?: number;
+    startingAfter?: string;
+}
+interface PayoutSettings {
+    destination: {
+        type: 'wallet';
+        address: string;
+        currency: string;
+    };
+    schedule: 'instant' | 'daily' | 'weekly' | 'monthly';
+    minimumAmount?: number;
+}
+interface PayoutSettingsUpdateParams {
+    destination?: PayoutSettings['destination'];
+    schedule?: PayoutSettings['schedule'];
+    minimumAmount?: number;
+}
+declare class CheckoutAPI {
+    private request;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Create a checkout session
+     */
+    create(params: CheckoutCreateParams): Promise<CheckoutSession>;
+    /**
+     * Retrieve a checkout session
+     */
+    retrieve(id: string): Promise<CheckoutSession>;
+}
+declare class LinksAPI {
+    private request;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Create a payment link
+     */
+    create(params: PaymentLinkCreateParams): Promise<PaymentLink>;
+    /**
+     * Retrieve a payment link
+     */
+    retrieve(id: string): Promise<PaymentLink>;
+    /**
+     * Deactivate a payment link
+     */
+    deactivate(id: string): Promise<PaymentLink>;
+}
+declare class CustomersAPI {
+    private request;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Create a customer
+     */
+    create(params: CustomerCreateParams): Promise<Customer>;
+    /**
+     * Retrieve a customer
+     */
+    retrieve(id: string, options?: {
+        expand?: string[];
+    }): Promise<Customer>;
+    /**
+     * Update a customer
+     */
+    update(id: string, params: CustomerUpdateParams): Promise<Customer>;
+    /**
+     * List customers
+     */
+    list(params?: {
+        email?: string;
+        limit?: number;
+    }): Promise<{
+        data: Customer[];
+        hasMore: boolean;
+    }>;
+}
+declare class PayoutsAPI {
+    private request;
+    /** Payout settings */
+    readonly settings: PayoutSettingsAPI;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Create a manual payout
+     */
+    create(params: PayoutCreateParams): Promise<Payout>;
+    /**
+     * Retrieve a payout
+     */
+    retrieve(id: string): Promise<Payout>;
+    /**
+     * List payouts
+     */
+    list(params?: PayoutListParams): Promise<{
+        data: Payout[];
+        hasMore: boolean;
+    }>;
+}
+declare class PayoutSettingsAPI {
+    private request;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Get payout settings
+     */
+    retrieve(): Promise<PayoutSettings>;
+    /**
+     * Update payout settings
+     */
+    update(params: PayoutSettingsUpdateParams): Promise<PayoutSettings>;
+}
+declare class WebhooksAPI {
+    private request;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Trigger a test webhook event (for testing)
+     */
+    trigger(event: string, data: Record<string, unknown>): Promise<{
+        success: boolean;
+    }>;
+}
+/**
+ * Payment API for checkout, links, customers, and payouts
+ */
+declare class PaymentAPI {
+    private request;
+    /** Checkout sessions API */
+    readonly checkout: CheckoutAPI;
+    /** Payment links API */
+    readonly links: LinksAPI;
+    /** Customers API */
+    readonly customers: CustomersAPI;
+    /** Payouts API */
+    readonly payouts: PayoutsAPI;
+    /** Webhooks API */
+    readonly webhooks: WebhooksAPI;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Retrieve a payment by ID
+     */
+    retrieve(id: string): Promise<Payment>;
+    /**
+     * List payments
+     */
+    list(params?: PaymentListParams): Promise<{
+        data: Payment[];
+        hasMore: boolean;
+    }>;
+}
+
+/**
+ * Configuration options for the MoneyMQ client
+ *
+ * @example
+ * ```typescript
+ * const config: MoneyMQConfig = {
+ *   url: 'https://api.moneymq.com',
+ *   secret: 'your-api-secret', // Optional
+ *   timeout: 30000,
+ * };
+ * ```
+ */
+interface MoneyMQConfig {
+    /**
+     * MoneyMQ API URL
+     * @example 'http://localhost:8488' or 'https://api.moneymq.com'
+     */
+    url: string;
+    /**
+     * Optional secret key for authenticated requests
+     * Used for server-side operations that require authentication
+     */
+    secret?: string;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+}
+/**
+ * MoneyMQ SDK client for accepting stablecoin payments
+ *
+ * @example
+ * ```typescript
+ * import { MoneyMQ } from '@moneymq/sdk';
+ *
+ * const moneymq = new MoneyMQ({
+ *   url: process.env.MONEYMQ_URL ?? 'http://localhost:8488',
+ * });
+ *
+ * // Create a product
+ * const product = await moneymq.catalog.products.create({
+ *   name: 'Pro Plan',
+ *   description: 'Full access to all features',
+ * });
+ *
+ * // Create a checkout session
+ * const session = await moneymq.payment.checkout.create({
+ *   lineItems: [{ price: 'price_xxx', quantity: 1 }],
+ *   successUrl: 'https://example.com/success',
+ *   cancelUrl: 'https://example.com/cancel',
+ * });
+ * ```
+ */
+declare class MoneyMQ {
+    private config;
+    /** Catalog API for products and prices */
+    readonly catalog: CatalogAPI;
+    /** Payment API for checkout, links, customers, and payouts */
+    readonly payment: PaymentAPI;
+    constructor(config: MoneyMQConfig);
+    /**
+     * Make an authenticated request to the MoneyMQ API
+     */
+    request<T>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, body?: unknown): Promise<T>;
+}
+
+export { type CheckoutCreateParams, type CheckoutSession, type Customer, type CustomerCreateParams, type CustomerUpdateParams, MoneyMQ, type MoneyMQConfig, type Payment, type PaymentLink, type PaymentLinkCreateParams, type PaymentListParams, type Payout, type PayoutCreateParams, type PayoutListParams, type PayoutSettings, type PayoutSettingsUpdateParams, type Price, type PriceCreateParams, type Product, type ProductCreateParams, type ProductListParams };