lzh-common 0.0.16 → 0.0.17

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "lzh-common",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Shared TypeScript interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc"
   },
+  "files": [
+    "./dist"
+  ],
   "author": "Your Name",
   "license": "MIT",
   "devDependencies": {

package/.github/workflows/deploy.yml

@@ -1,59 +0,0 @@
-name: Publish npm Package
-
-on:
-  push:
-    branches:
-      - main # 当推送到 main 分支时触发
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      # 检出代码仓库
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      # 设置 Node.js 版本
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: '18'
-          registry-url: 'https://registry.npmjs.org/'
-
-      # 安装依赖
-      - name: Install dependencies
-        run: npm install
-
-      # 设置 Git 用户信息，避免 "empty ident" 错误
-      - name: Set git user
-        run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-
-      # 使用 npm token 登录
-      - name: Authenticate with npm
-        run: npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
-
-      # 构建项目
-      - name: Build the project
-        run: npm run build
-
-      # 自动递增版本号，更新 package.json 并创建 git 标签
-      - name: Bump version and push changes
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm version patch -m "ci: bump version to %s"
-
-          # 设置 git 远程 URL 使用 GITHUB_TOKEN 进行身份验证
-          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/lixingjuan/lzh-common.git
-          
-          # 推送代码和标签
-          git push --follow-tags
-
-      # 发布 npm 包
-      - name: Publish to npm
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/src/base.ts

@@ -1,41 +0,0 @@
-export type GameZoneTS = 'wx' | 'qq';
-
-/** 订单状态 */
-export type OrderStatusTS =
-  /** 未接单/等待接单 */
-  | 'pending'
-  /** 服务中/已接单 */
-  | 'in_progress'
-  /** 等待老板确认结单 */
-  | 'awaiting_completion'
-  /** 已结单 */
-  | 'completed';
-
-/** 退款状态 */
-export type RefundStatusTS =
-  /** 默认值 */
-  | 'no_refund'
-  /** 正在申请退款 */
-  | 'applying_refund'
-  /** 已经人工退款 */
-  | 'refunded_manual'
-  /** 已经原路退还 */
-  | 'refunded_original';
-
-
-
-/** 分页的数据 */
-export interface IF2ePaginationListData<T> {
-  list: T[];
-  pagination: {
-    total: number;
-    page: number;
-    pageSize: number;
-  };
-}
-
-/** 分页的请求参数 */
-export interface IF2ePaginationReqData {
-  page: number;
-  pageSize: number;
-}

package/src/category.ts

@@ -1,24 +0,0 @@
-/** 分类 */
-export interface ICategoryDB {
-  /** 数据库自增id */
-  id: number;
-  /** 分类的名称 */
-  name: string;
-  /** 用来控制该分类的顺序，越大越靠前 */
-  sequence: number;
-  /** 分类的封面url */
-  cover_url: string;
-  /** 该分类的创建时间 */
-  create_time: string;
-  /** 该分类的新增时间 */
-  update_time: string;
-}
-
-/** 返回给前端的类型 */
-export type ICategoryF2e = ICategoryDB
-
-/** 新增分类的请求参数 */
-export type ICategoryReqAdd = Pick<ICategoryDB, 'name' | 'sequence' | 'cover_url'>
-
-/** 编辑分类的请求参数 */
-export type ICategoryReqEdit = Partial<Omit<ICategoryDB, 'create_time' | 'update_time'>> & Pick<ICategoryDB, 'id'>

package/src/goods.ts

@@ -1,39 +0,0 @@
-/** 商品状态 */
-export type GoodsStatusTS = 'active' | 'inactive';
-
-/** 商品的详情 */
-export interface IGoodsInfoDB {
-  id: number;
-  /** 类别 */
-  category_id: number;
-  /** 排序 */
-  sequence: number;
-
-  /** 商品名称 */
-  name: string;
-  /** 价格 */
-  price: number;
-  /** 手续费 */
-  service_charge: number;
-
-  /** 商品描述 */
-  description: string;
-  /** 封面图片 */
-  cover_url: string;
-  /** 是否允许购买 */
-  status: GoodsStatusTS;
-
-  /** 创建时间, YYYY-MM-DD HH:mm:ss */
-  create_time: string;
-  /** 更新时间, YYYY-MM-DD HH:mm:ss */
-  update_time: string;
-}
-
-/** 返回给前端的类型 */
-export type IGoodsInfoF2e = IGoodsInfoDB
-
-/** 新增商品的请求参数 */
-export type IGoodsInfoReqAdd = Omit<IGoodsInfoF2e, 'id' | 'create_time' | 'update_time'>
-
-/** 编辑商品的请求参数 */
-export type IGoodsInfoReqEdit = Partial<Omit<IGoodsInfoF2e, 'create_time' | 'update_time'>> & Pick<IGoodsInfoF2e, 'id'>

package/src/index.ts

@@ -1,11 +0,0 @@
-export * from './base'
-export * from './category'
-export * from './goods'
-export * from './level'
-export * from './manager'
-export * from './material'
-export * from './order'
-export * from './tenant'
-export * from './user'
-export * from './withdrawal'
-export * from './transaction'

package/src/level.ts

@@ -1,18 +0,0 @@
-
-export interface IAssigneeLevelDB {
-  id: number;
-  /** 登记描述 */
-  name: string;
-  /** 延时时间，单位为秒 */
-  delay_second: number;
-}
-
-export type IAssigneeLevelF2e = IAssigneeLevelDB
-
-/** 新增打手登记的请求参数 */
-export type IAssigneeLevelInfoReqAdd = Omit<IAssigneeLevelF2e, 'name' | 'delay_second'>
-
-/** 编辑打手登记的请求参数 */
-export type IAssigneeLevelInfoReqEdit = IAssigneeLevelDB
-
-

package/src/manager.ts

@@ -1,46 +0,0 @@
-/** 管理员角色类型 */
-export type ManagerRole =
-  /** 超级用户 */
-  | 'super'
-  /** 管理用户 */
-  | 'admin'
-  /** 一般用户 */
-  | 'user';
-
-
-/** 管理员, 数据库存储的类型 */
-export interface IManagerInfoDB {
-  /** id */
-  id: number;
-  /** id */
-  tenant_id: number;
-  /** 账号 */
-  username: string;
-  /** 密码 */
-  password: string;
-  /** 权限码列表 */
-  permissions: string;
-  /** 名称 */
-  description: string;
-  /** 角色 */
-  role: ManagerRole;
-
-  /** 创建时间 */
-  create_time: string;
-  /** 更新时间 */
-  update_time: string;
-}
-
-/** 管理员, 吐给前端的类型 */
-export type IManagerInfoF2e = Omit<IManagerInfoDB, 'permissions' | 'password'> & {
-  /** 权限码列表 */
-  permissions: string[];
-};
-
-/** 新增管理员的请求参数 */
-export type IManagerInfoReqAdd = Omit<IManagerInfoF2e, 'id' | 'create_time' | 'update_time'>
-
-/** 编辑管理员的请求参数 */
-export type IManagerInfoReqEdit = Partial<Omit<IManagerInfoF2e, 'create_time' | 'update_time'>> & Pick<IManagerInfoF2e, 'id' | 'tenant_id'>
-
-

package/src/material.ts

@@ -1,17 +0,0 @@
-/** 素材，数据库 */
-export interface IMaterialInfoDB {
-  id: number;
-  size: number;
-  url: string;
-  name: string;
-  create_time: string;
-}
-
-/** 素材，给前端 */
-export type IMaterialInfoF2e = IMaterialInfoDB
-
-/** 新增素材的请求参数 */
-export type IMaterialInfoReqAdd = Pick<IMaterialInfoF2e, 'size' | 'url' | 'name'>
-
-/** 编辑素材的请求参数 */
-export type IMaterialInfoReqEdit = Partial<Omit<IMaterialInfoF2e, 'create_time'>> & Pick<IMaterialInfoF2e, 'id'>

package/src/order.ts

@@ -1,96 +0,0 @@
-import { GameZoneTS, OrderStatusTS, RefundStatusTS } from './base';
-import { IGoodsInfoF2e } from './goods';
-import { IUserInfoF2e } from './user';
-
-/** 数据库存储的订单详情 */
-export interface IOrderInfoDB {
-  /** 订单id */
-  id: number;
-  /** 商品ID，对应goods表的id字段 */
-  goods_id: number;
-  /** 用户付款的时候，商品的价格 */
-  goods_price: number;
-
-  /** 订单的状态 */
-  status: OrderStatusTS;
-  /** 付款交易单号,创建订单的时候生成 */
-  out_trade_no: string;
-  /** 用户实付款价格, 单位是元 */
-  pay_price: number;
-
-  /** 顾客的open_id */
-  customer_open_id: string | null;
-  /** 顾客游戏id */
-  customer_game_id: string;
-  /** 顾客游戏区服 */
-  customer_game_zone: GameZoneTS;
-  /** 顾客下单备注 */
-  customer_remark: string;
-
-  /** 接单的人的openId */
-  assignee_open_id: string | null;
-  /** 队友1的open_id, 不是一定有的 */
-  assignee_open_id_b1: string | null;
-  /** 队友2的open_id, 不是一定有的 */
-  assignee_open_id_b2: string | null;
-  /** 接单支持图片 */
-  support_images: string;
-
-  /** 退款相关 */
-
-  /** 退款申请状态 */
-  refund_status: RefundStatusTS;
-  /** 申请退款原因 */
-  refund_reason: string;
-  /** 申请退款备注 */
-  refund_remark: string;
-  /** 退款交易单号 */
-  refund_out_trade_no: string;
-
-  /** 支付成功的时间 */
-  pay_success_time: string;
-  /** 创建时间 */
-  create_time: string;
-  /** 更新时间 */
-  update_time: string;
-}
-
-export type IOrderInfoToF2e = Omit<IOrderInfoDB, 'support_images'> & {
-  support_images: { name: string; url: string }[];
-}
-
-/** 给前端的order-item */
-export type IOrderInfoReturnToF2e = {
-  id: IOrderInfoDB['id'];
-  /** 订单详情 */
-  order_detail: IOrderInfoToF2e;
-  /** 商品详情 */
-  goods_detail: IGoodsInfoF2e | null;
-  /** 下单老板 */
-  custom_user_detail: IUserInfoF2e | null;
-  /** 接单打手 */
-  assignee_user_detail: IUserInfoF2e | null;
-};
-
-
-/** 创建订单的请求参数：TODO: 待定 */
-export type IOrderInfoReqAdd = Omit<IOrderInfoToF2e,
-  'id' |
-  'status' |
-  'assignee_open_id' |
-  'assignee_open_id_b1' |
-  'assignee_open_id_b2' |
-  'support_images' |
-
-  'refund_status' |
-  'refund_reason' |
-  'refund_remark' |
-  'refund_out_trade_no' |
-
-  'create_time' |
-  'update_time'
->
-
-
-/** 编辑订单的请求参数：TODO: 待定 */
-export type IOrderInfoReqEdit = Partial<Omit<IOrderInfoToF2e, 'create_time' | 'update_time'>> & Pick<IOrderInfoToF2e, 'id'>

package/src/tenant.ts

@@ -1,32 +0,0 @@
-/** 数据库存储的类型 */
-export interface ITenantInfoDB {
-  id: number;
-  /** 该租户的管理员id */
-  admin_manager_id: number;
-  name: string;
-  domain: string;
-  status: 'active' | 'inactive';
-  config: string;
-  create_time: string;
-  update_time: string;
-}
-
-export interface ITenantConfigF2e {
-  id: number;
-  notice: string;
-  banner_list: string[];
-  // 是否展示申请退款
-  show_withdrawal: boolean;
-}
-
-/** 吐给前端的类型 */
-export type ITenantInfoToF2e = Omit<ITenantInfoDB, 'config'> & {
-  config: ITenantConfigF2e;
-};
-
-/** 新增租户的请求参数 */
-export type ITenantInfoReqAdd = Omit<ITenantInfoToF2e, 'id' | 'create_time' | 'update_time'>
-
-/** 编辑租户的请求参数 */
-export type ITenantInfoReqEdit = Partial<Omit<ITenantInfoToF2e, 'create_time' | 'update_time'>> & Pick<ITenantInfoToF2e, 'id'>
-

package/src/transaction.ts

@@ -1,35 +0,0 @@
-
-type ShareType =
-  /** 主要接单人 */
-  | 'a'
-  /** 队友 */
-  | 'b';
-
-/** 交易记录 */
-export interface ITransactionInfoDB {
-  /** 订单id */
-  _id: string;
-  /** 用户的id */
-  open_id: string;
-  /** 订单的id */
-  order_id: string;
-  /** 关联订单的总金额 */
-  total_amount: string;
-  /** 分钱的类型 */
-  share_type: ShareType;
-  /** 每个人分到的钱（总金额平均分） */
-  share_amount: number;
-
-  /** 该笔交易关联的订单，我可以抽成的佣金 */
-  brokerage: number;
-
-  /** 创建时间 */
-  create_time: number;
-  /** 更新时间 */
-  update_time: number;
-}
-
-export type ITransactionInfoDBF2e = ITransactionInfoDB
-
-/** 新增交易记录的请求参数 */
-export type ITransactionInfoReqAdd = Omit<ITransactionInfoDBF2e, 'id' | 'create_time' | 'update_time'>

package/src/user.ts

@@ -1,72 +0,0 @@
-import { GameZoneTS } from './base';
-
-type AssigneeStatusTS =
-  /** 未申请打手的普通用户 */
-  | 'unapply'
-  /** 申请审核中 */
-  | 'applying'
-  /** 激活的打手 */
-  | 'active'
-  /** 被禁用的打手 */
-  | 'disabled';
-
-interface PayInfo {
-  account: string;
-  image_url: string;
-  name: string;
-}
-
-export interface IUserInfoDB {
-  id: number;
-  open_id: string;
-  /** 昵称 */
-  nickname: string;
-  /** 头像 */
-  avatar: string;
-  /** 打手姓名 */
-  assignee_name: string;
-  /** 打手性别 */
-  assignee_gender: '男' | '女';
-  /** 打手申请状态 */
-  assignee_status: AssigneeStatusTS;
-  /** 打手游戏区服 */
-  assignee_game_zone: GameZoneTS;
-  /** 打手个人简介 */
-  assignee_self_info: string;
-  /** 个人认证图像 */
-  assignee_certified_images: string;
-  /** 打手等级id */
-  assignee_level_id: number;
-  /** 提交申请打手的时间 */
-  assignee_apply_time?: string;
-  /** 手机号 */
-  phone_number: string;
-  /** 手机区码 */
-  phone_country_code: string;
-  /** 余额 */
-  balance: number;
-  /** 微信支付方式 */
-  wx_pay_info: string;
-  /** 支付宝支付方式 */
-  zfb_pay_info: string;
-
-  /** 更新时间 */
-  update_time?: string;
-  /** 用户初次小程序的时间 */
-  create_time?: string;
-}
-
-export type IUserInfoF2e = IUserInfoDB & {
-  /** 个人认证图像 */
-  assignee_certified_images: string[];
-  /** 微信支付方式 */
-  wx_pay_info: PayInfo;
-  /** 支付宝支付方式 */
-  zfb_pay_info: PayInfo;
-};
-
-/** 新增客户端用户的请求参数 */
-export type IUserInfoReqAdd = Pick<IUserInfoF2e, 'open_id'>
-
-/** 编辑客户端用户的请求参数 */
-export type IUserInfoReqEdit = Partial<Omit<IUserInfoF2e, 'create_time' | 'update_time'>> & Pick<IUserInfoF2e, 'id'>

package/src/withdrawal.ts

@@ -1,38 +0,0 @@
-import { IUserInfoF2e } from './user';
-
-/** 数据库存储的, 提现记录 */
-export interface IWithdrawalInfoDB {
-  /** 提现记录的id */
-  id: number;
-  /** 发起提现人的id */
-  open_id: string;
-  /** 支付方式 */
-  pay_way: 'wx' | 'zfb';
-  /** 支付状态 */
-  status: 'paid' | 'unpaid';
-
-  /** 提现金额 */
-  currency: number;
-  /** 打款凭证 */
-  attachments: string;
-
-  /** 解决时间 */
-  solve_time: null;
-  /** 创建时间 */
-  create_time: number;
-}
-
-/** 返回给前端的 */
-export type IWithdrawalDatumReturnToF2e = Omit<IWithdrawalInfoDB, 'attachments'> & {
-  /** 申请人的信息, 需要根据open_id，关联其他表查询 */
-  user_detail: IUserInfoF2e;
-  /** 打款凭证 */
-  attachments: { name: string; url: string }[];
-};
-
-
-/** 新增“提现记录”的请求参数 */
-export type IWithdrawalInfoReqAdd = Omit<IWithdrawalDatumReturnToF2e, 'id' | 'create_time' | 'solve_time'>
-
-/** 修改“提现记录”为已完成 */
-export type IWithdrawalInfoReqEdit = Pick<IWithdrawalInfoDB, 'id' | 'attachments'>

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "./dist",               // 编译输出目录
-    "declaration": true,              // 生成 .d.ts 类型定义文件
-    "declarationMap": true,           // 生成 .d.ts.map 文件
-    "module": "ESNext",               // ES 模块系统
-    "target": "ESNext",               // 编译目标
-    "strict": true,                   // 启用严格模式
-    "esModuleInterop": true,          // 兼容 ES 模块
-    "skipLibCheck": true,             // 跳过库文件检查
-    "forceConsistentCasingInFileNames": true  // 文件名大小写一致
-  },
-  "include": ["src/**/*"],             // 需要编译的源文件
-  "exclude": ["node_modules"]          // 排除目录
-}