@bloque/payments 0.0.1

package/dist/types/checkout.d.ts

@@ -0,0 +1,173 @@
+import type { Currency, Metadata } from './common';
+import type { Customer } from './customer';
+export interface CreateCheckoutPayload {
+    name: string;
+    description?: string;
+    image_url?: string;
+    asset: 'dUSD/6';
+    payment_type: 'shopping_cart';
+    items: {
+        name: string;
+        price: string;
+        units: number;
+        image_url?: string;
+    }[];
+    redirect_url: string;
+    expires_at?: string;
+    metadata?: Metadata;
+}
+export interface CreateCheckoutResponse {
+    payment: {
+        urn: string;
+        url: string;
+        price: number;
+        image_url?: string | null;
+        metadata?: Metadata;
+        created_at: string;
+        updated_at: string;
+        expires_at: string;
+        summary: {
+            status: CheckoutStatus;
+        };
+    };
+}
+/**
+ * Represents a single item included in a checkout.
+ */
+export interface CheckoutItem {
+    /**
+     * Name of the product or service.
+     */
+    name: string;
+    /**
+     * Optional description of the item.
+     */
+    description?: string;
+    /**
+     * Unit price of the item, expressed in the checkout currency.
+     * Usually represented in the smallest currency unit (e.g. cents).
+     */
+    amount: number;
+    /**
+     * Number of units for this item.
+     */
+    quantity: number;
+    /**
+     * URL of an image representing the item.
+     */
+    image_url?: string;
+}
+/**
+ * Parameters used to create a checkout.
+ */
+export interface CheckoutParams {
+    /**
+     * Name of the checkout session.
+     */
+    name: string;
+    /**
+     * Optional description of the checkout.
+     */
+    description?: string;
+    /**
+     * URL of an image representing the checkout.
+     */
+    image_url?: string;
+    /**
+     * List of items to be charged.
+     * Must contain at least one item.
+     */
+    items: CheckoutItem[];
+    /**
+     * Currency used for the checkout.
+     *
+     * @default 'USD'
+     */
+    currency?: Currency;
+    /**
+     * URL the customer will be redirected to after a successful payment.
+     */
+    success_url: string;
+    /**
+     * URL the customer will be redirected to if the payment is canceled.
+     */
+    cancel_url: string;
+    /**
+     * Arbitrary metadata attached to the checkout.
+     * Useful for internal references or business logic.
+     */
+    metadata?: Metadata;
+    /**
+     * Checkout expiration date and time in ISO 8601 format.
+     * If not provided, the checkout may not expire automatically.
+     */
+    expires_at?: string;
+    /**
+     * Payment methods enabled for this checkout.
+     *
+     * @default ['card', 'pse', 'cash']
+     */
+    payment_methods?: ('card' | 'pse' | 'cash')[];
+}
+/**
+ * Possible states of a checkout.
+ */
+export type CheckoutStatus = 'pending' | 'completed' | 'expired' | 'canceled';
+/**
+ * Represents a checkout object returned by the API.
+ */
+export interface Checkout {
+    /**
+     * Unique identifier of the checkout.
+     */
+    id: string;
+    /**
+     * Object type discriminator.
+     */
+    object: 'checkout';
+    /**
+     * Public URL where the customer can complete the payment.
+     */
+    url: string;
+    /**
+     * Current status of the checkout.
+     */
+    status: CheckoutStatus;
+    /**
+     * Total amount to be paid, including taxes, discounts,
+     * or additional charges.
+     */
+    amount_total: number;
+    /**
+     * Subtotal amount before additional charges.
+     */
+    amount_subtotal: number;
+    /**
+     * Currency used for the checkout.
+     */
+    currency: Currency;
+    /**
+     * Customer associated with the checkout, if any.
+     */
+    customer?: Customer;
+    /**
+     * Items included in the checkout.
+     */
+    items: CheckoutItem[];
+    /**
+     * Metadata attached to the checkout.
+     */
+    metadata?: Metadata;
+    /**
+     * Checkout creation timestamp in ISO 8601 format.
+     */
+    created_at: string;
+    /**
+     * Last update timestamp in ISO 8601 format.
+     */
+    updated_at: string;
+    /**
+     * Checkout expiration timestamp in ISO 8601 format.
+     */
+    expires_at: string;
+}

package/dist/types/common.d.ts

@@ -0,0 +1,12 @@
+export type Currency = 'COP' | 'USD';
+export interface Metadata {
+    [key: string]: string | number | boolean;
+}
+export interface Address {
+    line1: string;
+    line2?: string;
+    city: string;
+    state?: string;
+    postal_code?: string;
+    country: string;
+}

package/dist/types/customer.d.ts

@@ -0,0 +1,12 @@
+import type { Address, Metadata } from './common';
+export interface Customer {
+    id?: string;
+    object?: 'customer';
+    email: string;
+    name: string;
+    phone?: string;
+    address?: Address;
+    metadata?: Metadata;
+    created_at?: string;
+    updated_at?: string;
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@bloque/payments",
+  "version": "0.0.1",
+  "description": "Official Bloque SDK for creating and managing payments and checkouts.",
+  "type": "module",
+  "keywords": [
+    "bloque",
+    "payments",
+    "sdk",
+    "api"
+  ],
+  "author": "Nestor Cortina <nexckycort@gmail.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "homepage": "git+https://github.com/bloque-app/payments.git#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bloque-app/payments.git",
+    "directory": "packages/payments"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "clean": "rm -rf node_modules && rm -rf dist",
+    "check": "biome check --write",
+    "typecheck": "tsgo --noEmit"
+  },
+  "dependencies": {
+    "@bloque/payments-core": "workspace:*"
+  },
+  "devDependencies": {
+    "@rslib/core": "catalog:",
+    "@types/node": "catalog:",
+    "@typescript/native-preview": "catalog:",
+    "typescript": "catalog:"
+  }
+}