@frigear-nu/subscriptions 0.0.7 → 0.0.9

package/dist/module.d.mts

@@ -14,11 +14,25 @@ type PlanConfig = {
     description?: string;
     /** Drives upgrade vs. downgrade: a higher rank is a higher tier. */
     rank: number;
+    /** Bullet points shown on the plan card. The UI prefers `subscriptions.catalog.<planKey>.features` (array) from i18n. */
+    features?: string[];
+    /** Hide the plan during date windows (existing subscribers still see it). */
+    availability?: PlanAvailability;
+};
+/** Dates are anything `new Date()` parses; `{fullYear}` is replaced with the current year (e.g. `{fullYear}-06-01`). */
+type PlanDisabledRange = {
+    from: string;
+    to: string;
+};
+type PlanAvailability = {
+    /** The plan is hidden for new subscribers while today falls within any of these ranges (inclusive). */
+    disabledRanges?: PlanDisabledRange[];
 };
 type ModuleOptions = {
     /** Plans keyed by plan key. Leave empty to use the module as "any active subscription". */
     plans?: Record<string, PlanConfig>;
     settings?: {
+        mcp?: boolean;
         pages?: {
             /** Default `/account/membership`. */
             membership?: string | boolean;
@@ -36,6 +50,7 @@ type PublicPlan = {
     label: string;
     description?: string;
     rank: number;
+    features?: string[];
 };
 /** Exposed as `useRuntimeConfig().public.subscriptions`. */
 type PublicModuleOptions = {
@@ -54,6 +69,8 @@ type SubscriptionsRuntimeConfig = {
         label?: string;
         description?: string;
         rank: number;
+        features?: string[];
+        availability?: PlanAvailability;
     }>;
 };
 type PlanPrice = {
@@ -80,6 +97,8 @@ type SubscriptionDto = {
     currentPeriodStart: string | null;
     currentPeriodEnd: string | null;
     endedAt: string | null;
+    /** `manual` for free grants made by staff. */
+    source?: 'stripe' | 'manual';
 };
 type MeResponse = {
     subscriptions: SubscriptionDto[];
@@ -95,7 +114,7 @@ type CheckoutResponse = {
     url: string;
 } | {
     updated: true;
-    kind: 'upgrade' | 'downgrade';
+    kind: 'upgrade' | 'downgrade' | 'resume';
 };
 type PortalBody = {
     returnUrl?: string;
@@ -121,6 +140,46 @@ type PlansFilterContext = {
     /** The plans about to be returned. Mutate or reassign `plans` to hide / reorder them. */
     plans: ResolvedPlan[];
 };
+/** `GET /api/admin/users/:id/subscription` (staff). */
+type AdminMembershipResponse = {
+    plans: Array<{
+        key: string;
+        label: string;
+        rank: number;
+    }>;
+    current: {
+        id: string;
+        planKey: string | null;
+        status: string;
+        source: 'stripe' | 'manual';
+        currentPeriodEnd: string | null;
+        cancelAtPeriodEnd: boolean;
+    } | null;
+};
+/** `POST /api/admin/users/:id/subscription/payment-link` (staff). */
+type AdminPaymentLinkResponse = {
+    url: string;
+    emailed: boolean;
+};
+/**
+ * A membership invoice announced through the `subscriptions:invoice` hook (only when `@frigear-nu/payments` is
+ * installed, which stores it as a payment with `referenceType` `subscription`).
+ */
+type InvoicePaymentEvent = {
+    userId: number;
+    invoiceId: string;
+    status: 'paid' | 'failed' | 'expired';
+    /** Total in the currency's minor unit. */
+    amount: number;
+    currency: string;
+    description: string | null;
+    referenceType: 'subscription';
+    /** The Stripe subscription id. */
+    referenceId: string;
+    paymentIntentId: string | null;
+    paidAt: Date | null;
+    createdAt: Date;
+};
 
 declare module '@nuxt/schema' {
     interface NuxtConfig {
@@ -147,9 +206,13 @@ declare module 'nitropack' {
         'subscriptions:checkout:before': (ctx: CheckoutBeforeContext) => void | Promise<void>;
         /** Policy hook: hide or reorder plans by changing `ctx.plans` in place. */
         'subscriptions:plans:filter': (ctx: PlansFilterContext) => void | Promise<void>;
+        /** A membership invoice was paid, failed or voided. Only fired when `@frigear-nu/payments` is installed, which stores it. */
+        'subscriptions:invoice': (ctx: {
+            invoice: InvoicePaymentEvent;
+        }) => void | Promise<void>;
     }
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { _default as default };
-export type { CheckoutBeforeContext, CheckoutBody, CheckoutResponse, MeResponse, ModuleOptions, PlanConfig, PlanPrice, PlanPriceRef, PlansFilterContext, PlansResponse, PortalBody, PublicModuleOptions, PublicPlan, ResolvedPlan, SubscriptionDto, SubscriptionsRuntimeConfig };
+export type { AdminMembershipResponse, AdminPaymentLinkResponse, CheckoutBeforeContext, CheckoutBody, CheckoutResponse, InvoicePaymentEvent, MeResponse, ModuleOptions, PlanAvailability, PlanConfig, PlanDisabledRange, PlanPrice, PlanPriceRef, PlansFilterContext, PlansResponse, PortalBody, PublicModuleOptions, PublicPlan, ResolvedPlan, SubscriptionDto, SubscriptionsRuntimeConfig };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@frigear-nu/subscriptions",
   "configKey": "subscriptions",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,13 +1,11 @@
-import { defineNuxtModule, createResolver, hasNuxtModule, addServerHandler, addServerImportsDir, addImports, addComponentsDir, addRouteMiddleware, extendPages } from '@nuxt/kit';
-import { registerModule, registerLocales, registerDatabaseTable, moduleApiUrl, defineModulePage } from '@frigear-nu/module-kit/utils';
+import { defineNuxtModule, createResolver, hasNuxtModule, addServerHandler, addServerImportsDir, addImports, addComponentsDir, addPlugin, addRouteMiddleware } from '@nuxt/kit';
+import { registerModule, registerTailwindSource, registerLocales, resolvePagePath, registerDatabaseTable, moduleApiUrl, inlineModuleRuntime, addModulePages, addOptionalMenuSource } from '@frigear-nu/module-kit/utils';
+import { addAuthScope } from '@frigear-nu/auth/utils';
+import { extendUsersAdmin } from '@frigear-nu/users/utils';
+import { addMcpDefinitions } from '@frigear-nu/mcp/utils';
 import { registerStripeEventHandler } from '@frigear-nu/stripe/utils';
 
 const MODULE_NAME = "@frigear-nu/subscriptions";
-function resolvePagePath(setting, defaultPath) {
-  if (typeof setting === "string") return setting;
-  if (setting === true) return defaultPath;
-  return void 0;
-}
 const module$1 = defineNuxtModule({
   meta: { name: MODULE_NAME, configKey: "subscriptions" },
   defaults: {
@@ -20,17 +18,29 @@ const module$1 = defineNuxtModule({
       defaults: { kv: true }
     },
     "@frigear-nu/module-kit": { version: ">=0.0.1" },
+    "@frigear-nu/auth": { version: ">=0.0.1" },
+    "@frigear-nu/mcp": { version: ">=0.0.1" },
     "@frigear-nu/users": { version: ">=0.0.1" },
     "@frigear-nu/stripe": { version: ">=0.0.1" },
-    "@frigear-nu/menu": { version: ">=0.0.1", optional: true }
+    "@frigear-nu/menu": { version: ">=0.0.1", optional: true },
+    // Membership invoices are only announced (and stored as payments) when it is installed.
+    "@frigear-nu/payments": { version: ">=0.0.0", optional: true },
+    "@frigear-nu/widget": { version: ">=0.0.0", optional: true },
+    // The admin user tab and card are built from its components, so they are only added with it.
+    "@frigear-nu/admin": { version: ">=0.0.0", optional: true }
   },
   async setup(options, nuxt) {
     registerModule(MODULE_NAME, nuxt);
+    addAuthScope(
+      nuxt,
+      { name: "subscriptions:read", description: "Read your subscription and plans" },
+      { name: "subscriptions:write", description: "Start a subscription checkout" }
+    );
     const resolver = createResolver(import.meta.url);
+    registerTailwindSource(nuxt, resolver.resolve("./runtime/app"));
     registerLocales(nuxt, resolver.resolve("./runtime/i18n/lang"));
     const settings = options.settings ?? {};
     const plans = options.plans ?? {};
-    const withMenus = hasNuxtModule("@frigear-nu/menu");
     if (!nuxt.options.hub?.kv) {
       throw new Error("[@frigear-nu/subscriptions] NuxtHub KV is required (plans cache). Set `hub: { kv: true }` in your Nuxt config.");
     }
@@ -43,12 +53,14 @@ const module$1 = defineNuxtModule({
         prices: plan.prices,
         label: plan.label,
         description: plan.description,
-        rank: plan.rank
+        rank: plan.rank,
+        features: plan.features,
+        availability: plan.availability
       }]))
     };
     nuxt.options.runtimeConfig.public.subscriptions = {
       pages: { membership: membershipPath, success: successPath, cancel: cancelPath },
-      plans: planEntries.map(([key, plan]) => ({ key, label: plan.label ?? key, description: plan.description, rank: plan.rank })).sort((a, b) => a.rank - b.rank),
+      plans: planEntries.map(([key, plan]) => ({ key, label: plan.label ?? key, description: plan.description, rank: plan.rank, features: plan.features })).sort((a, b) => a.rank - b.rank),
       allowChangeInPortal: settings.allowChangeInPortal === true
     };
     await registerDatabaseTable(nuxt, {
@@ -66,6 +78,12 @@ const module$1 = defineNuxtModule({
       ],
       handler: resolver.resolve("./runtime/server/stripe/subscription-events")
     });
+    if (hasNuxtModule("@frigear-nu/payments", nuxt)) {
+      registerStripeEventHandler(nuxt, {
+        events: ["invoice.paid", "invoice.payment_failed", "invoice.voided", "invoice.marked_uncollectible"],
+        handler: resolver.resolve("./runtime/server/stripe/invoice-events")
+      });
+    }
     addServerHandler({
       route: moduleApiUrl("subscriptions", "plans"),
       method: "get",
@@ -86,34 +104,48 @@ const module$1 = defineNuxtModule({
       method: "post",
       handler: resolver.resolve("./runtime/server/routes/subscriptions/portal.post")
     });
+    await extendUsersAdmin(nuxt, {
+      routes: [
+        ["get", "subscription", "subscription.get"],
+        ["get", "subscriptions", "subscriptions.get"],
+        ["post", "subscription", "subscription.post"],
+        ["delete", "subscription", "subscription.delete"],
+        ["post", "subscription/payment-link", "payment-link.post"]
+      ].map(([method, path, file]) => ({ method, path, handler: resolver.resolve(`./runtime/server/routes/admin/${file}`) })),
+      tab: {
+        id: "subscription",
+        component: resolver.resolve("./runtime/app/tabs/Membership.vue"),
+        order: 10,
+        label: "Subscription",
+        labelKey: "subscriptions.admin.tab",
+        icon: "i-lucide-badge-check"
+      },
+      widget: {
+        id: "subscriptions-current",
+        component: resolver.resolve("./runtime/app/widgets/AdminCurrentSubscription.vue"),
+        order: 10,
+        span: 2
+      }
+    });
     addServerImportsDir(resolver.resolve("./runtime/server/utils"));
+    inlineModuleRuntime(nuxt, resolver);
+    if (settings.mcp === true) addMcpDefinitions(nuxt, resolver.resolve("./runtime/server/mcp"));
     addImports([
       { name: "usePlans", from: resolver.resolve("./runtime/app/composables/usePlans") },
       { name: "useSubscription", from: resolver.resolve("./runtime/app/composables/useSubscription") }
     ]);
     addComponentsDir({ path: resolver.resolve("./runtime/app/components") });
+    addPlugin({ src: resolver.resolve("./runtime/app/plugins/warm-plans.client"), mode: "client" });
     addRouteMiddleware({
       name: "subscription",
       path: resolver.resolve("./runtime/app/middleware/subscription")
     });
-    if (membershipPath || successPath || cancelPath) {
-      extendPages((pages) => {
-        const existingPaths = new Set(pages.map((page) => page.path));
-        if (membershipPath && !existingPaths.has(membershipPath)) {
-          pages.push(defineModulePage(MODULE_NAME, { name: "subscriptions-membership", path: membershipPath, file: resolver.resolve("./runtime/app/pages/membership.vue") }));
-        }
-        if (successPath && !existingPaths.has(successPath)) {
-          pages.push(defineModulePage(MODULE_NAME, { name: "subscriptions-success", path: successPath, file: resolver.resolve("./runtime/app/pages/success.vue") }));
-        }
-        if (cancelPath && !existingPaths.has(cancelPath)) {
-          pages.push(defineModulePage(MODULE_NAME, { name: "subscriptions-cancel", path: cancelPath, file: resolver.resolve("./runtime/app/pages/cancel.vue") }));
-        }
-      });
-    }
-    if (withMenus) {
-      const { registerMenuSource } = await import('@frigear-nu/menu/utils');
-      registerMenuSource(nuxt, { file: resolver.resolve("./runtime/menus"), menu: "dashboard.account" });
-    }
+    addModulePages(MODULE_NAME, resolver, [
+      { name: "subscriptions-membership", path: membershipPath, file: "./runtime/app/pages/membership.vue" },
+      { name: "subscriptions-success", path: successPath, file: "./runtime/app/pages/success.vue" },
+      { name: "subscriptions-cancel", path: cancelPath, file: "./runtime/app/pages/cancel.vue" }
+    ]);
+    addOptionalMenuSource(nuxt, { file: resolver.resolve("./runtime/menus"), menu: "dashboard.account" });
   }
 });
 

package/dist/runtime/app/components/SubscriptionPlans.d.vue.ts

@@ -8,59 +8,63 @@ type __VLS_Props = {
     plans?: string[];
     /** Ask for confirmation (modal) before changing an existing subscription. */
     confirmChange?: boolean;
+    /** `list` shows all plans side by side, `tabs` one at a time. `auto` uses tabs on small screens. */
+    mode?: 'auto' | 'list' | 'tabs';
+    /** Plan key to emphasise (defaults to the current plan, when subscribed). */
+    highlight?: string;
 };
 declare function formatPrice(price: SubscriptionPlanPrice): string;
 declare function intervalLabel(price: SubscriptionPlanPrice): any;
-declare var __VLS_1: {}, __VLS_3: {}, __VLS_17: {
-    plan: any;
-    state: "upgrade" | "downgrade" | "subscribe" | "current";
-}, __VLS_19: {
-    plan: any;
-    state: "upgrade" | "downgrade" | "subscribe" | "current";
-}, __VLS_27: {
-    plan: any;
+declare var __VLS_14: {
+    plan: SubscriptionPlan;
+    state: "upgrade" | "downgrade" | "resume" | "subscribe" | "current";
+}, __VLS_17: {
+    plan: SubscriptionPlan;
+    state: "upgrade" | "downgrade" | "resume" | "subscribe" | "current";
+}, __VLS_20: {
+    plan: SubscriptionPlan;
     price: SubscriptionPlanPrice | undefined;
     formatPrice: typeof formatPrice;
     intervalLabel: typeof intervalLabel;
-}, __VLS_29: {
-    plan: any;
-}, __VLS_32: {
-    plan: any;
-    state: "upgrade" | "downgrade" | "subscribe" | "current";
+}, __VLS_23: {
+    plan: SubscriptionPlan;
+}, __VLS_26: {
+    plan: SubscriptionPlan;
+    state: "upgrade" | "downgrade" | "resume" | "subscribe" | "current";
     pending: any;
     select: () => void;
-}, __VLS_48: {
+}, __VLS_35: {}, __VLS_37: {}, __VLS_66: {
     plan: any;
     price: any;
-}, __VLS_51: {
+}, __VLS_74: {
     plan: any;
     price: any;
     confirm: () => any;
 };
 type __VLS_Slots = {} & {
-    loading?: (props: typeof __VLS_1) => any;
+    header?: (props: typeof __VLS_14) => any;
 } & {
-    empty?: (props: typeof __VLS_3) => any;
+    badge?: (props: typeof __VLS_17) => any;
 } & {
-    header?: (props: typeof __VLS_17) => any;
+    price?: (props: typeof __VLS_20) => any;
 } & {
-    badge?: (props: typeof __VLS_19) => any;
+    features?: (props: typeof __VLS_23) => any;
 } & {
-    price?: (props: typeof __VLS_27) => any;
+    action?: (props: typeof __VLS_26) => any;
 } & {
-    features?: (props: typeof __VLS_29) => any;
+    loading?: (props: typeof __VLS_35) => any;
 } & {
-    action?: (props: typeof __VLS_32) => any;
+    empty?: (props: typeof __VLS_37) => any;
 } & {
-    confirm?: (props: typeof __VLS_48) => any;
+    confirm?: (props: typeof __VLS_66) => any;
 } & {
-    'confirm-actions'?: (props: typeof __VLS_51) => any;
+    'confirm-actions'?: (props: typeof __VLS_74) => any;
 };
-declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const __VLS_base: import("@vue/runtime-core").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("@vue/runtime-core").ComponentOptionsMixin, import("@vue/runtime-core").ComponentOptionsMixin, {
     select: (plan: SubscriptionPlan, price: SubscriptionPlanPrice) => any;
-}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+}, string, import("@vue/runtime-core").PublicProps, Readonly<__VLS_Props> & Readonly<{
     onSelect?: ((plan: SubscriptionPlan, price: SubscriptionPlanPrice) => any) | undefined;
-}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, import("@vue/runtime-core").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 export default _default;