@spaire/nuxt 2.0.0

package/README.md

@@ -0,0 +1,129 @@
+# @spaire/nuxt
+
+Payments and Checkouts made dead simple with Nuxt.
+
+## Installation
+
+### Install the package
+
+Choose your preferred package manager to install the module:
+
+`pnpm add @spaire/nuxt`
+
+### Register the module
+
+Add the module to your `nuxt.config.ts`:
+
+```typescript
+export default defineNuxtConfig({
+  modules: ["@spaire/nuxt"],
+});
+```
+
+## Checkout
+
+Create a Checkout handler which takes care of redirections.
+
+```typescript
+// server/routes/api/checkout.post.ts
+export default defineEventHandler((event) => {
+  const {
+    private: { spaireAccessToken, spaireCheckoutSuccessUrl, spaireServer },
+  } = useRuntimeConfig();
+
+  const checkoutHandler = Checkout({
+    accessToken: spaireAccessToken,
+    successUrl: spaireCheckoutSuccessUrl,
+    returnUrl: "https://myapp.com", // Optional Return URL, which renders a Back-button in the Checkout
+    server: spaireServer as "sandbox" | "production",
+    theme: "dark" // Enforces the theme - System-preferred theme will be set if left omitted
+  });
+
+  return checkoutHandler(event);
+});
+```
+
+### 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`
+- metadata (optional) `URL-Encoded JSON string`
+
+## Customer Portal
+
+Create a customer portal where your customer can view orders and subscriptions.
+
+```typescript
+// server/routes/api/portal.get.ts
+export default defineEventHandler((event) => {
+  const {
+    private: { spaireAccessToken, spaireCheckoutSuccessUrl, spaireServer },
+  } = useRuntimeConfig();
+
+  const customerPortalHandler = CustomerPortal({
+    accessToken: spaireAccessToken,
+    server: spaireServer as "sandbox" | "production",
+    getCustomerId: (event) => {
+      return Promise.resolve("9d89909b-216d-475e-8005-053dba7cff07");
+    },
+    returnUrl: "https://myapp.com", // Optional Return URL, which renders a Back-button in the Customer Portal
+  });
+
+  return customerPortalHandler(event);
+});
+```
+
+## Webhooks
+
+A simple utility which resolves incoming webhook payloads by signing the webhook secret properly.
+
+```typescript
+// server/routes/webhook/spaire.post.ts
+export default defineEventHandler((event) => {
+  const {
+    private: { spaireWebhookSecret },
+  } = useRuntimeConfig();
+
+  const webhooksHandler = Webhooks({
+    webhookSecret: spaireWebhookSecret,
+    onPayload: async (payload: any) => {
+      // Handle the payload
+      // No need to return an acknowledge response
+    },
+  });
+
+  return webhooksHandler(event);
+});
+```
+
+### 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/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,7 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+type ModuleOptions = Record<string, unknown>;
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.d.ts

@@ -0,0 +1,7 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+type ModuleOptions = Record<string, unknown>;
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "@spaire/nuxt",
+  "configKey": "spaire",
+  "version": "2.0.0",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "unknown"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,16 @@
+import { defineNuxtModule, createResolver, addServerImportsDir } from '@nuxt/kit';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "@spaire/nuxt",
+    configKey: "spaire"
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {},
+  setup(_options, _nuxt) {
+    const resolver = createResolver(import.meta.url);
+    addServerImportsDir(resolver.resolve("./runtime/server"));
+  }
+});
+
+export { module as default };

package/dist/runtime/server/checkoutHandler.d.ts

@@ -0,0 +1,10 @@
+import type { H3Event } from "h3";
+export interface CheckoutConfig {
+    accessToken?: string;
+    successUrl?: string;
+    returnUrl?: string;
+    includeCheckoutId?: boolean;
+    server?: "sandbox" | "production";
+    theme?: "light" | "dark";
+}
+export declare const Checkout: ({ accessToken, successUrl, returnUrl, server, theme, includeCheckoutId, }: CheckoutConfig) => (event: H3Event) => Promise<void>;

package/dist/runtime/server/checkoutHandler.js

@@ -0,0 +1,78 @@
+import { Spaire } from "@spaire/sdk";
+import { createError, getValidatedQuery, sendRedirect } from "h3";
+import { z } from "zod";
+const checkoutQuerySchema = z.object({
+  products: z.string().transform((value) => value.split(",")).pipe(z.string().array()),
+  customerId: z.string().nonempty().optional(),
+  customerExternalId: z.string().nonempty().optional(),
+  customerEmail: z.string().email().optional(),
+  customerName: z.string().nonempty().optional(),
+  customerBillingAddress: z.string().nonempty().optional(),
+  customerTaxId: z.string().nonempty().optional(),
+  customerIpAddress: z.string().nonempty().optional(),
+  customerMetadata: z.string().nonempty().optional(),
+  allowDiscountCodes: z.string().toLowerCase().transform((x) => x === "true").pipe(z.boolean()).optional(),
+  discountId: z.string().nonempty().optional(),
+  metadata: z.string().nonempty().optional()
+});
+export const Checkout = ({
+  accessToken,
+  successUrl,
+  returnUrl,
+  server,
+  theme,
+  includeCheckoutId = true
+}) => {
+  return async (event) => {
+    const {
+      products,
+      customerId,
+      customerExternalId,
+      customerEmail,
+      customerName,
+      customerBillingAddress,
+      customerTaxId,
+      customerIpAddress,
+      customerMetadata,
+      allowDiscountCodes,
+      discountId,
+      metadata
+    } = await getValidatedQuery(event, checkoutQuerySchema.parse);
+    try {
+      const success = successUrl ? new URL(successUrl) : void 0;
+      if (success && includeCheckoutId) {
+        success.searchParams.set("checkoutId", "{CHECKOUT_ID}");
+      }
+      const retUrl = returnUrl ? new URL(returnUrl) : void 0;
+      const spaire = new Spaire({ accessToken, server });
+      const result = await spaire.checkouts.create({
+        products,
+        successUrl: success ? decodeURI(success.toString()) : void 0,
+        customerId,
+        externalCustomerId: customerExternalId,
+        customerEmail,
+        customerName,
+        customerBillingAddress: customerBillingAddress ? JSON.parse(customerBillingAddress) : void 0,
+        customerTaxId,
+        customerIpAddress,
+        customerMetadata: customerMetadata ? JSON.parse(customerMetadata) : void 0,
+        allowDiscountCodes,
+        discountId,
+        metadata: metadata ? JSON.parse(metadata) : void 0,
+        returnUrl: retUrl ? decodeURI(retUrl.toString()) : void 0
+      });
+      const redirectUrl = new URL(result.url);
+      if (theme) {
+        redirectUrl.searchParams.set("theme", theme);
+      }
+      return sendRedirect(event, redirectUrl.toString());
+    } catch (error) {
+      console.error("Failed to checkout:", error);
+      throw createError({
+        statusCode: 500,
+        statusMessage: error.message,
+        message: error.message ?? "Internal server error"
+      });
+    }
+  };
+};

package/dist/runtime/server/customerPortalHandler.d.ts

@@ -0,0 +1,8 @@
+import type { H3Event } from "h3";
+export interface CustomerPortalConfig {
+    accessToken: string;
+    server?: "sandbox" | "production";
+    getCustomerId: (event: H3Event) => Promise<string>;
+    returnUrl?: string;
+}
+export declare const CustomerPortal: ({ accessToken, server, getCustomerId, returnUrl, }: CustomerPortalConfig) => (event: H3Event) => Promise<void>;

package/dist/runtime/server/customerPortalHandler.js

@@ -0,0 +1,40 @@
+import { Spaire } from "@spaire/sdk";
+import { createError, sendRedirect } from "h3";
+export const CustomerPortal = ({
+  accessToken,
+  server,
+  getCustomerId,
+  returnUrl
+}) => {
+  return async (event) => {
+    const retUrl = returnUrl ? new URL(returnUrl) : void 0;
+    const customerId = await getCustomerId(event);
+    if (!customerId) {
+      console.error(
+        "Failed to redirect to customer portal, customerId not defined"
+      );
+      throw createError({
+        statusCode: 400,
+        message: "customerId not defined"
+      });
+    }
+    try {
+      const spaire = new Spaire({
+        accessToken,
+        server
+      });
+      const result = await spaire.customerSessions.create({
+        customerId,
+        returnUrl: retUrl ? decodeURI(retUrl.toString()) : void 0
+      });
+      return sendRedirect(event, result.customerPortalUrl);
+    } catch (error) {
+      console.error("Failed to redirect to customer portal", error);
+      throw createError({
+        statusCode: 500,
+        statusMessage: error.message,
+        message: error.message ?? "Internal server error"
+      });
+    }
+  };
+};

package/dist/runtime/server/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./checkoutHandler.js";
+export * from "./customerPortalHandler.js";
+export * from "./webhookHandler.js";

package/dist/runtime/server/index.js

@@ -0,0 +1,3 @@
+export * from "./checkoutHandler.js";
+export * from "./customerPortalHandler.js";
+export * from "./webhookHandler.js";

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+	"extends": "../../../.nuxt/tsconfig.server.json"
+}

package/dist/runtime/server/webhookHandler.d.ts

@@ -0,0 +1,5 @@
+import type { WebhooksConfig } from "@spaire/adapter-utils";
+import type { H3Event } from "h3";
+export declare const Webhooks: ({ webhookSecret, onPayload, entitlements, ...eventHandlers }: WebhooksConfig) => (event: H3Event) => Promise<{
+    received: boolean;
+}>;

package/dist/runtime/server/webhookHandler.js

@@ -0,0 +1,54 @@
+import { handleWebhookPayload } from "@spaire/adapter-utils";
+import { WebhookVerificationError, validateEvent } from "@spaire/sdk/webhooks";
+import { createError, getHeader, readRawBody, setResponseStatus } from "h3";
+export const Webhooks = ({
+  webhookSecret,
+  onPayload,
+  entitlements,
+  ...eventHandlers
+}) => {
+  return async (event) => {
+    const requestBody = await readRawBody(event);
+    const webhookHeaders = {
+      "webhook-id": getHeader(event, "webhook-id") ?? "",
+      "webhook-timestamp": getHeader(event, "webhook-timestamp") ?? "",
+      "webhook-signature": getHeader(event, "webhook-signature") ?? ""
+    };
+    let webhookPayload;
+    try {
+      webhookPayload = validateEvent(
+        requestBody || "",
+        webhookHeaders,
+        webhookSecret
+      );
+    } catch (error) {
+      if (error instanceof WebhookVerificationError) {
+        console.error("Failed to verify webhook event", error);
+        setResponseStatus(event, 403);
+        return { received: false };
+      }
+      console.error("Failed to validate webhook event", error);
+      throw createError({
+        statusCode: 500,
+        statusMessage: error.message,
+        message: error.message ?? "Internal server error"
+      });
+    }
+    try {
+      await handleWebhookPayload(webhookPayload, {
+        webhookSecret,
+        entitlements,
+        onPayload,
+        ...eventHandlers
+      });
+      return { received: true };
+    } catch (error) {
+      console.error("Webhook error", error);
+      throw createError({
+        statusCode: 500,
+        statusMessage: error.message,
+        message: error.message ?? "Internal server error"
+      });
+    }
+  };
+};

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.js'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module'

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@spaire/nuxt",
+  "version": "2.0.0",
+  "description": "Spaire integration for Nuxt",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spaire/spaire.git"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "nuxt-module-build build",
+    "prepare": "nuxt-module-build prepare",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
+    "check": "biome check --write ./src"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.15.4",
+    "@spaire/adapter-utils": "^2.0.0",
+    "@spaire/sdk": "^0.45.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@nuxt/devtools": "^2.6.5",
+    "@nuxt/eslint-config": "^1.11.0",
+    "@nuxt/module-builder": "^0.8.4",
+    "@nuxt/schema": "^3.15.4",
+    "@nuxt/test-utils": "^3.21.0",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "eslint": "^9.39.1",
+    "nuxt": "^3.15.4",
+    "typescript": "5.9.3",
+    "vitest": "^3.2.4",
+    "vue-tsc": "2.1.6",
+    "zod": "^3.24.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}