@frigear-nu/stripe

中文文档
0.4.0发布于 2026/11/12MITTypeScriptES Module构建来源已验证近 30 天下载 2688

Core Stripe plumbing for the frigear ecosystem: SDK access, customer linking, and a verified, idempotent webhook that other modules can subscribe to.

原始使用文档
文档目录5 节
  1. Setup
  2. Database
  3. Server utils (auto-imported in Nitro)
  4. Webhook
  5. Subscribing to events

@frigear-nu/stripe

Core Stripe plumbing for the frigear ecosystem. It owns the SDK, the user <-> Stripe customer link and a single verified, idempotent webhook that other modules (subscriptions, payments, ...) subscribe to. It contains no product logic itself.

Setup

export default defineNuxtConfig({
  modules: ['@nuxthub/core', '@frigear-nu/users', '@frigear-nu/stripe'],
  hub: { db: { dialect: 'sqlite', driver: 'libsql' }, kv: true }, // kv is required (webhook idempotency)
  stripe: { settings: { webhookPath: '/api/stripe/webhook' } }, // optional, this is the default
})

unstorage must be resolvable by the host app (NuxtHub KV needs it).

Environment variables:

VariablePurpose
NUXT_STRIPE_SECRET_KEYStripe secret key (runtimeConfig.stripe.secretKey)
NUXT_STRIPE_WEBHOOK_SECRETWebhook signing secret (whsec_...)
NUXT_STRIPE_API_VERSIONOptional override, defaults to the pinned 2026-09-30.endive
NUXT_PUBLIC_STRIPE_PUBLISHABLE_KEYPublishable key (runtimeConfig.public.stripe.publishableKey)

Database

Extends the users table with a nullable stripe_customer_id column. Generate and commit migrations in the host app.

Server utils (auto-imported in Nitro)

  • useStripe() - the Stripe SDK, using the fetch HTTP client (Cloudflare Workers compatible).
  • ensureStripeCustomer(userId) - returns the user's Stripe customer id: stored id, else a Stripe search by email, else a new customer (persisted).
  • getStripeCustomerUser(customerId) - the local user row for a Stripe customer id, or null.

Webhook

POST /api/stripe/webhook reads the raw body, verifies the signature (constructEventAsync + SubtleCrypto), and dispatches to handlers. Processed event ids are stored in NuxtHub KV for 7 days, so duplicates are ignored. If any handler throws, the others still run, the response is 500 (Stripe retries) and the event is not marked processed - handlers must be idempotent. The Nitro hook stripe:event is fired for every dispatched event.

Subscribing to events

From a module (build time, bundled into the server - no runtime scanning):

import { registerStripeEventHandler } from '@frigear-nu/stripe/utils'

registerStripeEventHandler(nuxt, {
  events: ['customer.subscription.updated', 'checkout.session.completed'], // or '*'
  handler: resolver.resolve('./runtime/server/stripe/subscription-events'),
  order: 100, // optional, lower runs first
})
// runtime/server/stripe/subscription-events.ts
import { defineStripeEventHandler } from '@frigear-nu/stripe/utils'

export default defineStripeEventHandler<'customer.subscription.updated' | 'checkout.session.completed'>(
  async (event, { stripe, userId, event: h3Event }) => {
    // `event` is narrowed by `event.type`; `userId` is null for unknown customers
  },
)

From a host app's Nitro plugin:

export default defineNitroPlugin(() => {
  onStripeEvent('invoice.payment_failed', (event, ctx) => { /* ... */ })
})

版本与发布记录

@frigear-nu/stripe 共发布 22 个版本,首次发布于 2026/10/09;过去 12 个月发布了 22 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.0latest2026/11/123 天前
0.3.12026/11/123 天前
0.3.02026/11/123 天前
0.2.52026/11/0411 天前
0.2.32026/11/0411 天前
0.2.22026/11/0312 天前

关于 @frigear-nu/stripe 的常见问题

@frigear-nu/stripe 是什么?

Core Stripe plumbing for the frigear ecosystem: SDK access, customer linking, and a verified, idempotent webhook that other modules can subscribe to.

如何安装 @frigear-nu/stripe?

在项目目录运行 npm install @frigear-nu/stripe,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@nuxthub/core(^0.10.12)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@frigear-nu/stripe 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@frigear-nu/stripe 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@frigear-nu/stripe 可以商用吗?

@frigear-nu/stripe 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@frigear-nu/stripe 的下载量有多少?

根据 npm 官方下载统计,@frigear-nu/stripe 在 2026/10/16 – 2026/11/14 这 30 天内被下载 2,688 次,日均约 90 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@frigear-nu/stripe 还在维护吗?

最新版本 0.4.0 发布于 2026/11/12(3 天前);至今共发布 22 个版本,其中过去 12 个月发布了 22 个;首次发布于 2026/10/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。