payment-kit 1.13.65 → 1.13.67

package/api/src/schedule/interface/diff.ts

@@ -0,0 +1,9 @@
+import type { ManipulateType } from 'dayjs';
+
+export interface Diff {
+  value: number;
+  unit: ManipulateType;
+
+  // 这个 job 必须跑吗?
+  required?: false | true;
+}

package/api/src/schedule/subscription-trail-will-end.ts

@@ -0,0 +1,197 @@
+/* eslint-disable no-console */
+import dayjs from 'dayjs';
+import { clone } from 'lodash';
+import pAll from 'p-all';
+import { Op } from 'sequelize';
+
+import { NotificationQueueJob, notificationQueue } from '../jobs/notification';
+import { notificationCronConcurrency } from '../libs/env';
+import logger from '../libs/logger';
+import type { SubscriptionTrialWillEndEmailTemplateOptions } from '../libs/notification/template/subscription-trial-will-end';
+import { Subscription } from '../store/models';
+import type { Diff } from './interface/diff';
+
+interface SubscriptionForTrailWillEnd extends Subscription {
+  diffs: Diff[];
+}
+
+export class SubscriptionTrailWillEndSchedule {
+  private start: number;
+
+  private end: number;
+
+  constructor() {
+    this.start = Date.now();
+    this.end = dayjs(this.start).add(1, 'M').add(1, 'd').toDate().getTime();
+  }
+
+  async run() {
+    const label: string = new Date().toISOString();
+
+    logger.info(`${label}: SubscriptionTrailWillEndSchedule.run start`);
+
+    const subscriptions = await this.getSubscriptions();
+    const subscriptionForWillRenew = this.getSubscriptionsForWillRenew(subscriptions);
+
+    await this.addTaskToQueue(subscriptionForWillRenew);
+
+    logger.info(`${label}: SubscriptionTrailWillEndSchedule.run end`);
+  }
+
+  async getSubscriptions(): Promise<Subscription[]> {
+    const subscriptions = await Subscription.findAll({
+      where: {
+        // @note: 之所以除 1000,是因为时间的精确度是 s
+        current_period_start: {
+          [Op.lte]: this.start / 1000,
+        },
+        current_period_end: {
+          [Op.lt]: this.end / 1000,
+        },
+        trail_start: {
+          [Op.gt]: 0,
+        },
+      },
+      attributes: ['id', 'current_period_start', 'current_period_end'],
+      raw: true,
+    });
+
+    return subscriptions;
+  }
+
+  static DIFFS: Diff[] = [
+    {
+      value: 1,
+      unit: 'M',
+    },
+    {
+      value: 7,
+      unit: 'd',
+    },
+    {
+      value: 3,
+      unit: 'd',
+    },
+    {
+      value: 1,
+      unit: 'd',
+    },
+    {
+      value: 6,
+      unit: 'h',
+    },
+  ];
+
+  /**
+   * @see https://github.com/blocklet/payment-kit/issues/236#issuecomment-1824129965
+   * @description
+   * @param {Subscription[]} subscriptions
+   * @return {*}  {SubscriptionForWillRenew[]}
+   * @memberof SubscriptionWillRenewSchedule
+   */
+  getSubscriptionsForWillRenew(subscriptions: Subscription[]): SubscriptionForTrailWillEnd[] {
+    return subscriptions.map((subscription: Subscription): SubscriptionForTrailWillEnd => {
+      const s: SubscriptionForTrailWillEnd = clone(subscription) as SubscriptionForTrailWillEnd;
+      const currentPeriodStart: number = s.current_period_start * 1000;
+      const currentPeriodEnd: number = s.current_period_end * 1000;
+
+      if (
+        dayjs(currentPeriodEnd).diff(this.start, 'M') >= 1 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'M') > 1
+      ) {
+        s.diffs = SubscriptionTrailWillEndSchedule.DIFFS.slice(0);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'd') >= 7 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 7
+      ) {
+        s.diffs = SubscriptionTrailWillEndSchedule.DIFFS.slice(1);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'd') >= 3 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 3
+      ) {
+        s.diffs = SubscriptionTrailWillEndSchedule.DIFFS.slice(2);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'd') >= 1 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 1
+      ) {
+        s.diffs = SubscriptionTrailWillEndSchedule.DIFFS.slice(3);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'h') >= 6 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'h') > 6
+      ) {
+        s.diffs = SubscriptionTrailWillEndSchedule.DIFFS.slice(4);
+      } else {
+        s.diffs = [];
+      }
+
+      // 每一个周期都至少收到一封邮件
+      if (dayjs(currentPeriodEnd).diff(currentPeriodStart, 'M') > 1) {
+        s.diffs.forEach((x) => {
+          if (x.value === 7 && x.unit === 'd') {
+            x.required = true;
+          }
+        });
+      } else if (dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 7) {
+        s.diffs.forEach((x) => {
+          if (x.value === 3 && x.unit === 'd') {
+            x.required = true;
+          }
+        });
+      } else if (dayjs(currentPeriodEnd).diff(currentPeriodStart, 'h') >= 6) {
+        s.diffs.forEach((x) => {
+          if (x.value === 6 && x.unit === 'h') {
+            x.required = true;
+          }
+        });
+      }
+
+      return s;
+    });
+  }
+
+  async addTaskToQueue(subscriptions: SubscriptionForTrailWillEnd[]): Promise<void> {
+    const tasks: {
+      id: string;
+      job: { type: NotificationQueueJob['type']; options: SubscriptionTrialWillEndEmailTemplateOptions };
+      delay: number;
+    }[] = [];
+
+    for (const subscription of subscriptions) {
+      for (const diff of subscription.diffs) {
+        const id: string = `${subscription.id}.${diff.value}.${diff.unit}`;
+        const job: { type: NotificationQueueJob['type']; options: SubscriptionTrialWillEndEmailTemplateOptions } = {
+          type: 'customer.subscription.trial_will_end',
+          options: {
+            subscriptionId: subscription.id,
+            willRenewValue: diff.value,
+            willRenewUnit: diff.unit,
+            required: !!diff.required,
+          },
+        };
+        const delay: number = dayjs(subscription.current_period_end * 1000)
+          .subtract(diff.value, diff.unit)
+          .diff(this.start, 's');
+
+        tasks.push({
+          id,
+          job,
+          delay,
+        });
+      }
+    }
+
+    await pAll(
+      tasks.map((x) => {
+        return async () => {
+          const job = await notificationQueue.get(x.id);
+          if (job) {
+            return;
+          }
+
+          notificationQueue.push(x);
+        };
+      }),
+      { concurrency: notificationCronConcurrency }
+    );
+  }
+}

package/api/src/schedule/subscription-will-renew.ts

@@ -0,0 +1,195 @@
+/* eslint-disable no-console */
+import dayjs from 'dayjs';
+import { clone } from 'lodash';
+import pAll from 'p-all';
+import { Op } from 'sequelize';
+
+import { NotificationQueueJob, notificationQueue } from '../jobs/notification';
+import { notificationCronConcurrency } from '../libs/env';
+import logger from '../libs/logger';
+import type { SubscriptionWillRenewEmailTemplateOptions } from '../libs/notification/template/subscription-will-renew';
+import { Subscription } from '../store/models';
+import type { Diff } from './interface/diff';
+
+interface SubscriptionForWillRenew extends Subscription {
+  diffs: Diff[];
+}
+
+export class SubscriptionWillRenewSchedule {
+  private start: number;
+
+  private end: number;
+
+  constructor() {
+    this.start = Date.now();
+    this.end = dayjs(this.start).add(1, 'M').add(1, 'd').toDate().getTime();
+  }
+
+  async run() {
+    const label: string = new Date().toISOString();
+
+    logger.info(`${label}: SubscriptionWillRenewSchedule.run start`);
+
+    const subscriptions = await this.getSubscriptions();
+    const subscriptionForWillRenew = this.getSubscriptionsForWillRenew(subscriptions);
+
+    await this.addTaskToQueue(subscriptionForWillRenew);
+
+    logger.info(`${label}: SubscriptionWillRenewSchedule.run end`);
+  }
+
+  async getSubscriptions(): Promise<Subscription[]> {
+    const subscriptions = await Subscription.findAll({
+      where: {
+        // @note: 之所以除 1000,是因为时间的精确度是 s
+        current_period_start: {
+          [Op.lte]: this.start / 1000,
+        },
+        current_period_end: {
+          [Op.lt]: this.end / 1000,
+        },
+        trail_start: 0,
+      },
+      attributes: ['id', 'current_period_start', 'current_period_end'],
+      raw: true,
+    });
+
+    return subscriptions;
+  }
+
+  static DIFFS: Diff[] = [
+    {
+      value: 1,
+      unit: 'M',
+    },
+    {
+      value: 7,
+      unit: 'd',
+    },
+    {
+      value: 3,
+      unit: 'd',
+    },
+    {
+      value: 1,
+      unit: 'd',
+    },
+    {
+      value: 6,
+      unit: 'h',
+    },
+  ];
+
+  /**
+   * @see https://github.com/blocklet/payment-kit/issues/236#issuecomment-1824129965
+   * @description
+   * @param {Subscription[]} subscriptions
+   * @return {*}  {SubscriptionForWillRenew[]}
+   * @memberof SubscriptionWillRenewSchedule
+   */
+  getSubscriptionsForWillRenew(subscriptions: Subscription[]): SubscriptionForWillRenew[] {
+    return subscriptions.map((subscription: Subscription): SubscriptionForWillRenew => {
+      const s: SubscriptionForWillRenew = clone(subscription) as SubscriptionForWillRenew;
+      const currentPeriodStart: number = s.current_period_start * 1000;
+      const currentPeriodEnd: number = s.current_period_end * 1000;
+
+      if (
+        dayjs(currentPeriodEnd).diff(this.start, 'M') >= 1 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'M') > 1
+      ) {
+        s.diffs = SubscriptionWillRenewSchedule.DIFFS.slice(0);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'd') >= 7 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 7
+      ) {
+        s.diffs = SubscriptionWillRenewSchedule.DIFFS.slice(1);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'd') >= 3 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 3
+      ) {
+        s.diffs = SubscriptionWillRenewSchedule.DIFFS.slice(2);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'd') >= 1 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 1
+      ) {
+        s.diffs = SubscriptionWillRenewSchedule.DIFFS.slice(3);
+      } else if (
+        dayjs(currentPeriodEnd).diff(this.start, 'h') >= 6 &&
+        dayjs(currentPeriodEnd).diff(currentPeriodStart, 'h') > 6
+      ) {
+        s.diffs = SubscriptionWillRenewSchedule.DIFFS.slice(4);
+      } else {
+        s.diffs = [];
+      }
+
+      // 每一个周期都至少收到一封邮件
+      if (dayjs(currentPeriodEnd).diff(currentPeriodStart, 'M') > 1) {
+        s.diffs.forEach((x) => {
+          if (x.value === 7 && x.unit === 'd') {
+            x.required = true;
+          }
+        });
+      } else if (dayjs(currentPeriodEnd).diff(currentPeriodStart, 'd') > 7) {
+        s.diffs.forEach((x) => {
+          if (x.value === 3 && x.unit === 'd') {
+            x.required = true;
+          }
+        });
+      } else if (dayjs(currentPeriodEnd).diff(currentPeriodStart, 'h') >= 6) {
+        s.diffs.forEach((x) => {
+          if (x.value === 6 && x.unit === 'h') {
+            x.required = true;
+          }
+        });
+      }
+
+      return s;
+    });
+  }
+
+  async addTaskToQueue(subscriptions: SubscriptionForWillRenew[]): Promise<void> {
+    const tasks: {
+      id: string;
+      job: { type: NotificationQueueJob['type']; options: SubscriptionWillRenewEmailTemplateOptions };
+      delay: number;
+    }[] = [];
+
+    for (const subscription of subscriptions) {
+      for (const diff of subscription.diffs) {
+        const id: string = `${subscription.id}.${diff.value}.${diff.unit}`;
+        const job: { type: NotificationQueueJob['type']; options: SubscriptionWillRenewEmailTemplateOptions } = {
+          type: 'customer.subscription.will_renew',
+          options: {
+            subscriptionId: subscription.id,
+            willRenewValue: diff.value,
+            willRenewUnit: diff.unit,
+            required: !!diff.required,
+          },
+        };
+        const delay: number = dayjs(subscription.current_period_end * 1000)
+          .subtract(diff.value, diff.unit)
+          .diff(this.start, 's');
+
+        tasks.push({
+          id,
+          job,
+          delay,
+        });
+      }
+    }
+
+    await pAll(
+      tasks.map((x) => {
+        return async () => {
+          const job = await notificationQueue.get(x.id);
+          if (job) {
+            return;
+          }
+
+          notificationQueue.push(x);
+        };
+      }),
+      { concurrency: notificationCronConcurrency }
+    );
+  }
+}

package/api/src/store/models/subscription.ts

@@ -5,6 +5,7 @@ import type { LiteralUnion } from 'type-fest';
 
 import { createCustomEvent, createEvent, createStatusEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
+import { Invoice } from './invoice';
 import type { PaymentDetails, PaymentSettings, PriceRecurring } from './types';
 
 const nextId = createIdGenerator('sub', 24);
@@ -266,10 +267,36 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
       createdAt: 'created_at',
       updatedAt: 'updated_at',
       hooks: {
-        afterCreate: (model: Subscription, options) =>
-          createEvent('Subscription', 'customer.subscription.created', model, options).catch(console.error),
-        afterUpdate: (model: Subscription, options) => {
+        afterCreate: (model: Subscription, options) => {
+          createEvent('Subscription', 'customer.subscription.created', model, options).catch(console.error);
+        },
+        afterUpdate: async (model: Subscription, options) => {
           createEvent('Subscription', 'customer.subscription.updated', model, options).catch(console.error);
+
+          if (model.trail_start) {
+            const previousLatestInvoiceId = model.previous('latest_invoice_id');
+
+            if (!previousLatestInvoiceId && model.latest_invoice_id) {
+              createEvent('Subscription', 'customer.subscription.trial_start', model, options).catch(console.error);
+            } else if (
+              previousLatestInvoiceId &&
+              model.latest_invoice_id &&
+              previousLatestInvoiceId !== model.latest_invoice_id
+            ) {
+              const count: number = await Invoice.count({
+                where: {
+                  subscription_id: model.id,
+                },
+              });
+              if (count === 2) {
+                // 当且仅当 有试用期的订阅更新了 && 恰好有 2 次发票,此时订阅的试用期刚好结束
+                createEvent('Subscription', 'customer.subscription.trial_end', model, options).catch(console.error);
+              }
+            }
+          } else if (!model.previous('latest_invoice_id') && model.latest_invoice_id) {
+            createEvent('Subscription', 'customer.subscription.started', model, options).catch(console.error);
+          }
+
           createStatusEvent('Subscription', 'customer.subscription', { canceled: 'deleted' }, model, options).catch(
             console.error
           );
@@ -313,15 +340,6 @@ export function getSubscriptionEventType(current: TSubscription, previous: Parti
   if (!current.pause_collection && previous.pause_collection) {
     return 'resumed';
   }
-  if (
-    current.status === 'active' &&
-    current.current_period_end &&
-    current.current_period_end !== previous.current_period_end &&
-    current.current_period_start &&
-    current.current_period_start !== previous.current_period_start
-  ) {
-    return 'renewed';
-  }
 
   return '';
 }

package/api/src/store/models/types.ts

@@ -276,20 +276,17 @@ export type NftMintSettings = {
   inputs?: Record<string, string>;
 };
 
+export interface NftMintItem {
+  tx_hash?: string;
+  address: string;
+  owner: string;
+  error?: string;
+}
+
 export type NftMintDetails = {
   type: LiteralUnion<'arcblock' | 'ethereum' | 'bitcoin', string>;
-  arcblock?: {
-    tx_hash?: string;
-    address: string;
-    owner: string;
-    error?: string;
-  };
-  ethereum?: {
-    tx_hash?: string;
-    address: string;
-    owner: string;
-    error?: string;
-  };
+  arcblock?: NftMintItem;
+  ethereum?: NftMintItem;
 };
 
 // Very similar to PaymentLink
@@ -406,7 +403,11 @@ export type EventType = LiteralUnion<
   | 'customer.subscription.pending_update_expired'
   | 'customer.subscription.resumed'
   | 'customer.subscription.renewed'
+  | 'customer.subscription.renew_failed'
+  | 'customer.subscription.trial_start'
   | 'customer.subscription.trial_will_end'
+  | 'customer.subscription.trial_end'
+  | 'customer.subscription.started'
   | 'customer.subscription.updated'
   | 'customer.tax_id.created'
   | 'customer.tax_id.deleted'

package/api/third.d.ts

@@ -30,3 +30,5 @@ namespace Express {
     stripeClient?: any;
   }
 }
+
+declare module 'pretty-ms-i18n';

package/blocklet.yml

@@ -14,7 +14,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/payment-kit.git
 specVersion: 1.2.8
-version: 1.13.65
+version: 1.13.67
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.65",
+  "version": "1.13.67",
   "scripts": {
     "dev": "COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev",
     "eject": "vite eject",
@@ -40,6 +40,7 @@
     ]
   },
   "dependencies": {
+    "@abtnode/cron": "^1.16.19",
     "@arcblock/did": "^1.18.103",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
     "@arcblock/did-connect": "^2.8.20",
@@ -51,10 +52,10 @@
     "@blocklet/ui-react": "^2.8.20",
     "@blocklet/uploader": "^0.0.38",
     "@mui/icons-material": "^5.14.19",
-    "@mui/lab": "^5.0.0-alpha.154",
-    "@mui/material": "^5.14.19",
-    "@mui/styles": "^5.14.19",
-    "@mui/system": "^5.14.19",
+    "@mui/lab": "^5.0.0-alpha.155",
+    "@mui/material": "^5.14.20",
+    "@mui/styles": "^5.14.20",
+    "@mui/system": "^5.14.20",
     "@ocap/asset": "^1.18.103",
     "@ocap/client": "^1.18.103",
     "@ocap/mcrypto": "^1.18.103",
@@ -82,6 +83,7 @@
     "lodash": "^4.17.21",
     "morgan": "^1.10.0",
     "nanoid": "3",
+    "p-all": "3.0.0",
     "p-wait-for": "3",
     "pretty-ms-i18n": "^1.0.3",
     "react": "^18.2.0",
@@ -104,7 +106,7 @@
     "@abtnode/types": "^1.16.19",
     "@arcblock/eslint-config": "^0.2.4",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@did-pay/types": "1.13.65",
+    "@did-pay/types": "1.13.67",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -141,5 +143,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "8af4c34686bae8cf09c114b4e3afce2671f320f0"
+  "gitHead": "37b1d2ce195a256f8743a6cc53fd24d3d01579b0"
 }

package/src/app.tsx

@@ -19,6 +19,7 @@ const CheckoutPage = React.lazy(() => import('./pages/checkout'));
 const AdminPage = React.lazy(() => import('./pages/admin'));
 const CustomerHome = React.lazy(() => import('./pages/customer/index'));
 const CustomerInvoice = React.lazy(() => import('./pages/customer/invoice'));
+const CustomerSubscription = React.lazy(() => import('./pages/customer/subscription'));
 
 const theme = createTheme({
   typography: {
@@ -48,6 +49,7 @@ function App() {
               <Route key="admin-sub" path="/admin/:group/:page" element={<AdminPage />} />,
               <Route key="admin-fallback" path="/admin/*" element={<AdminPage />} />,
               <Route key="customer-home" path="/customer" element={<CustomerHome />} />,
+              <Route key="customer-subscription" path="/customer/subscription/:id" element={<CustomerSubscription />} />
               <Route key="customer-invoice" path="/customer/invoice/:id" element={<CustomerInvoice />} />,
               <Route key="customer-fallback" path="/customer/*" element={<Navigate to="/customer" />} />,
               <Route path="*" element={<Navigate to="/" />} />

package/src/components/invoice/action.tsx

@@ -15,13 +15,17 @@ type Props = {
   data: TInvoiceExpanded;
   variant?: LiteralUnion<'compact' | 'normal', string>;
   onChange: (action: string) => void;
+
+  mode?: 'admin' | 'customer';
 };
 
 InvoiceActions.defaultProps = {
   variant: 'compact',
+
+  mode: 'admin',
 };
 
-export default function InvoiceActions({ data, variant, onChange }: Props) {
+export default function InvoiceActions({ data, variant, onChange, mode }: Props) {
   const { t } = useLocaleContext();
   const navigate = useNavigate();
   const [state, setState] = useSetState({
@@ -43,6 +47,8 @@ export default function InvoiceActions({ data, variant, onChange }: Props) {
     }
   };
 
+  const isAdmin = mode === 'admin';
+
   const actions = [
     {
       label: t('admin.invoice.download'),
@@ -50,13 +56,13 @@ export default function InvoiceActions({ data, variant, onChange }: Props) {
       color: 'primary',
       disabled: data.status !== 'paid',
     },
-    {
+    isAdmin && {
       label: t('admin.invoice.edit'),
       handler: () => setState({ action: 'edit' }),
       color: 'primary',
       disabled: data.status !== 'draft',
     },
-    {
+    isAdmin && {
       label: t('admin.invoice.duplicate'),
       handler: () => setState({ action: 'duplicate' }),
       color: 'primary',
@@ -65,22 +71,34 @@ export default function InvoiceActions({ data, variant, onChange }: Props) {
     },
     {
       label: t('admin.customer.view'),
-      handler: () => navigate(`/admin/customers/${data.customer_id}`),
+      handler: () => {
+        if (isAdmin) {
+          navigate(`/admin/customers/${data.customer_id}`);
+        } else {
+          navigate('/customer');
+        }
+      },
       color: 'primary',
     },
-  ];
+  ].filter(Boolean);
 
   if (variant === 'compact') {
     actions.push({
       label: t('admin.invoice.view'),
-      handler: () => navigate(`/admin/billing/${data.id}`),
+      handler: () => {
+        if (isAdmin) {
+          navigate(`/admin/billing/${data.id}`);
+        } else {
+          navigate(`/customer/invoice/${data.id}`);
+        }
+      },
       color: 'primary',
     });
   }
 
   return (
     <ClickBoundary>
-      <Actions variant={variant} actions={actions} />
+      <Actions variant={variant} actions={actions as any} />
       {state.action === 'xxx' && (
         <ConfirmDialog
           onConfirm={handleAction}