payment-kit 1.13.158 → 1.13.159

package/api/src/routes/refunds.ts

@@ -15,7 +15,16 @@ import {
 } from '../store/models';
 
 const router = Router();
-const auth = authenticate<Refund>({ component: true, roles: ['owner', 'admin'] });
+const auth = authenticate<Invoice>({
+  component: true,
+  roles: ['owner', 'admin'],
+  mine: true,
+  record: {
+    // @ts-ignore
+    model: Refund,
+    field: 'customer_id',
+  },
+});
 
 const paginationSchema = Joi.object<{
   page: number;
@@ -24,6 +33,7 @@ const paginationSchema = Joi.object<{
   status?: string;
   invoice_id: string;
   subscription_id: string;
+  customer_id: string;
 }>({
   page: Joi.number().integer().min(1).default(1),
   pageSize: Joi.number().integer().min(1).max(100).default(20),
@@ -31,6 +41,7 @@ const paginationSchema = Joi.object<{
   status: Joi.string().empty(''),
   invoice_id: Joi.string().empty(''),
   subscription_id: Joi.string().empty(''),
+  customer_id: Joi.string().empty(''),
 });
 router.get('/', auth, async (req, res) => {
   const { page, pageSize, livemode, status, ...query } = await paginationSchema.validateAsync(req.query, {
@@ -47,6 +58,10 @@ router.get('/', auth, async (req, res) => {
     where.invoice_id = query.invoice_id;
   }
 
+  if (query.customer_id) {
+    where.customer_id = query.customer_id;
+  }
+
   if (query.subscription_id) {
     where.subscription_id = query.subscription_id;
   }

package/api/src/routes/subscriptions.ts

@@ -29,7 +29,7 @@ import { Product } from '../store/models/product';
 import { Refund } from '../store/models/refund';
 import { Subscription, TSubscription } from '../store/models/subscription';
 import { SubscriptionItem } from '../store/models/subscription-item';
-import type { LineItem, SubscriptionUpdateItem } from '../store/models/types';
+import type { LineItem, ServiceAction, SubscriptionUpdateItem } from '../store/models/types';
 import { UsageRecord } from '../store/models/usage-record';
 import { ensureInvoiceAndItems } from './connect/shared';
 import { createUsageRecordQueryFn } from './usage-records';
@@ -598,6 +598,7 @@ const updateSchema = Joi.object<{
   proration_behavior?: string;
   billing_cycle_anchor?: string;
   items: SubscriptionUpdateItem[];
+  service_actions?: ServiceAction[];
 }>({
   description: Joi.string().min(1).optional(),
   metadata: Joi.any().optional(),
@@ -616,6 +617,18 @@ const updateSchema = Joi.object<{
     )
     .optional()
     .default([]),
+  service_actions: Joi.array()
+    .items(
+      Joi.object({
+        name: Joi.string().required(),
+        color: Joi.string().allow('primary', 'secondary', 'success', 'error', 'warning').required(),
+        variant: Joi.string().allow('text', 'contained', 'outlined').required(),
+        text: Joi.object().required(),
+        link: Joi.string().uri().required(),
+      })
+    )
+    .optional()
+    .default([]),
 });
 // eslint-disable-next-line consistent-return
 router.put('/:id', authPortal, async (req, res) => {
@@ -638,6 +651,9 @@ router.put('/:id', authPortal, async (req, res) => {
     if (req.body.metadata) {
       updates.metadata = formatMetadata(req.body.metadata);
     }
+    if (req.body.service_actions) {
+      updates.service_actions = req.body.service_actions;
+    }
     if (subscription.isImmutable()) {
       await subscription.update(updates);
       return res.json(subscription);

package/api/src/store/migrations/20240228-service-actions.ts

@@ -0,0 +1,23 @@
+/* eslint-disable no-await-in-loop */
+import { DataTypes } from 'sequelize';
+
+import { Migration, safeApplyColumnChanges } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  await safeApplyColumnChanges(context, {
+    subscriptions: [
+      {
+        name: 'service_actions',
+        field: {
+          type: DataTypes.JSON,
+          allowNull: true,
+          defaultValue: '[]',
+        },
+      },
+    ],
+  });
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.removeColumn('subscriptions', 'service_actions');
+};

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

@@ -7,7 +7,7 @@ import { createCustomEvent, createEvent, createStatusEvent } from '../../libs/au
 import logger from '../../libs/logger';
 import { createIdGenerator } from '../../libs/util';
 import { Invoice } from './invoice';
-import type { PaymentDetails, PaymentSettings, PriceRecurring } from './types';
+import type { PaymentDetails, PaymentSettings, PriceRecurring, ServiceAction } from './types';
 
 export const nextSubscriptionId = createIdGenerator('sub', 24);
 
@@ -108,6 +108,8 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
   declare proration_behavior?: LiteralUnion<'always_invoice' | 'create_prorations' | 'none', string>;
   declare payment_behavior?: LiteralUnion<'allow_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete', string>;
 
+  declare service_actions?: ServiceAction[];
+
   // TODO: following fields not supported
   // application
   // application_fee_percent
@@ -287,6 +289,11 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
           type: DataTypes.NUMBER,
           allowNull: true,
         },
+        service_actions: {
+          type: DataTypes.JSON,
+          allowNull: true,
+          defaultValue: [],
+        },
       },
       {
         sequelize,

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

@@ -43,6 +43,14 @@ export type PriceCurrency = {
   custom_unit_amount: CustomUnitAmount | null;
 };
 
+export type ServiceAction = {
+  name: string;
+  color: string;
+  variant: string;
+  text: { [key: string]: string };
+  link: string;
+};
+
 export type CustomUnitAmount = {
   maximum: string;
   minimum: string;

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.158
+version: 1.13.159
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.158",
+  "version": "1.13.159",
   "scripts": {
     "dev": "cross-env COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev --open",
     "eject": "vite eject",
@@ -50,7 +50,7 @@
     "@arcblock/jwt": "^1.18.110",
     "@arcblock/ux": "^2.9.29",
     "@blocklet/logger": "1.16.23",
-    "@blocklet/payment-react": "1.13.158",
+    "@blocklet/payment-react": "1.13.159",
     "@blocklet/sdk": "1.16.23",
     "@blocklet/ui-react": "^2.9.29",
     "@blocklet/uploader": "^0.0.73",
@@ -110,7 +110,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.23",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@blocklet/payment-types": "1.13.158",
+    "@blocklet/payment-types": "1.13.159",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -149,5 +149,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "f53ad79f77852d57376924819e1fb81044462fa5"
+  "gitHead": "2663776fb04b0446e2d053eedfb66d1910c507f8"
 }

package/src/components/subscription/portal/actions.tsx

@@ -3,7 +3,7 @@ import { useLocaleContext } from '@arcblock/ux/lib/Locale/context';
 import Toast from '@arcblock/ux/lib/Toast';
 import { ConfirmDialog, api, formatError, formatToDate, getSubscriptionAction } from '@blocklet/payment-react';
 import type { TSubscriptionExpanded } from '@blocklet/payment-types';
-import { Button, Stack } from '@mui/material';
+import { Button, Link, Stack } from '@mui/material';
 import { useRequest, useSetState } from 'ahooks';
 import { FormProvider, useForm, useFormContext } from 'react-hook-form';
 import { useNavigate } from 'react-router-dom';
@@ -29,7 +29,7 @@ const fetchUpdateOptions = ({ id, showUpdate }: { id: string; showUpdate: boolea
 };
 
 export function SubscriptionActionsInner({ subscription, showUpdate, onChange }: Props) {
-  const { t } = useLocaleContext();
+  const { t, locale } = useLocaleContext();
   const { reset, getValues } = useFormContext();
   const navigate = useNavigate();
   const action = getSubscriptionAction(subscription);
@@ -106,6 +106,19 @@ export function SubscriptionActionsInner({ subscription, showUpdate, onChange }:
           {t('payment.customer.upgrade.button')}
         </Button>
       )}
+      {subscription.service_actions?.map((x) => (
+        // @ts-ignore
+        <Button
+          component={Link}
+          key={x.name}
+          variant={x.variant}
+          color={x.color}
+          href={x.link}
+          size="small"
+          sx={{ textDecoration: 'none !important' }}>
+          {x.text[locale] || x.text.en || x.name}
+        </Button>
+      ))}
       {state.action === 'cancel' && state.subscription && (
         <ConfirmDialog
           onConfirm={handleCancel}