@spaire/express 1.0.1

package/README.md

@@ -0,0 +1,105 @@
+# @spaire/express
+
+Payments and Checkouts made dead simple with Express.
+
+`pnpm install @spaire/express zod`
+
+## Checkout
+
+Create a Checkout handler which takes care of redirections.
+
+```typescript
+import express from "express";
+import { Checkout } from "@spaire/express";
+
+const app = express();
+
+app.get(
+  "/checkout",
+  Checkout({
+    accessToken: "xxx", // Or set an environment variable to SPAIRE_ACCESS_TOKEN
+    successUrl: process.env.SUCCESS_URL,
+    returnUrl: "https://myapp.com", // Optional Return URL, which renders a Back-button in the Checkout
+    server: "sandbox", // Use sandbox if you're testing Spaire - omit the parameter or pass 'production' otherwise
+    theme: "dark" // Enforces the theme - System-preferred theme will be set if left omitted
+  }),
+);
+```
+
+### Query Params
+
+Pass query params to this route.
+
+- products `?products=123`
+- customerId (optional) `?products=123&customerId=xxx`
+- customerExternalId (optional) `?products=123&customerExternalId=xxx`
+- customerEmail (optional) `?products=123&customerEmail=janedoe@gmail.com`
+- customerName (optional) `?products=123&customerName=Jane`
+- seats (optional) `?products=123&seats=5` - Number of seats for seat-based products
+- metadata (optional) `URL-Encoded JSON string`
+
+## Customer Portal
+
+Create a customer portal where your customer can view orders and subscriptions.
+
+```typescript
+import express from "express";
+import { CustomerPortal } from "@spaire/express";
+
+const app = express();
+
+app.get(
+  "/portal",
+  CustomerPortal({
+    accessToken: "xxx", // Or set an environment variable to SPAIRE_ACCESS_TOKEN
+    getCustomerId: (event) => "", // Fuction to resolve a Spaire Customer ID
+    returnUrl: "https://myapp.com", // Optional Return URL, which renders a Back-button in the Customer Portal
+    server: "sandbox", // Use sandbox if you're testing Spaire - omit the parameter or pass 'production' otherwise
+  }),
+);
+```
+
+## Webhooks
+
+A simple utility which resolves incoming webhook payloads by signing the webhook secret properly.
+
+```typescript
+import express from 'express'
+import { Webhooks } from "@spaire/express";
+
+const app = express()
+
+app
+.use(express.json())
+.post('/spaire/webhooks', Webhooks({
+  webhookSecret: process.env.SPAIRE_WEBHOOK_SECRET!,
+  onPayload: async (payload) => /** Handle payload */,
+}))
+```
+
+#### Payload Handlers
+
+The Webhook handler also supports granular handlers for easy integration.
+
+- onCheckoutCreated: (payload) =>
+- onCheckoutUpdated: (payload) =>
+- onOrderCreated: (payload) =>
+- onOrderUpdated: (payload) =>
+- onOrderPaid: (payload) =>
+- onSubscriptionCreated: (payload) =>
+- onSubscriptionUpdated: (payload) =>
+- onSubscriptionActive: (payload) =>
+- onSubscriptionCanceled: (payload) =>
+- onSubscriptionRevoked: (payload) =>
+- onProductCreated: (payload) =>
+- onProductUpdated: (payload) =>
+- onOrganizationUpdated: (payload) =>
+- onBenefitCreated: (payload) =>
+- onBenefitUpdated: (payload) =>
+- onBenefitGrantCreated: (payload) =>
+- onBenefitGrantUpdated: (payload) =>
+- onBenefitGrantRevoked: (payload) =>
+- onCustomerCreated: (payload) =>
+- onCustomerUpdated: (payload) =>
+- onCustomerDeleted: (payload) =>
+- onCustomerStateChanged: (payload) =>

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@spaire/express",
+  "version": "1.0.1",
+  "description": "Spaire integration for Express",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "type": "module",
+  "scripts": {
+    "test": "vitest",
+    "build": "tsup ./src/index.ts --format esm,cjs --dts --clean --sourcemap",
+    "dev": "tsc --watch",
+    "check": "biome check --write ./src"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "spaire",
+    "express",
+    "payments",
+    "subscriptions"
+  ],
+  "peerDependencies": {
+    "express": "^4.21.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@sindresorhus/tsconfig": "^7.0.0",
+    "@types/express": "^5.0.6",
+    "@types/node": "^20.0.0",
+    "@types/supertest": "^6.0.3",
+    "express": "^4.21.2",
+    "prettier": "^3.7.4",
+    "supertest": "^7.1.4",
+    "tsup": "^8.5.1",
+    "vitest": "^2.1.8"
+  },
+  "dependencies": {
+    "@spaire/adapter-utils": "workspace:*",
+    "@spaire/sdk": "^0.45.1"
+  }
+}