@dan-uni/dan-any 0.5.0 → 0.6.8

package/src/utils/dm-gen.ts

@@ -1,4 +1,19 @@
+import { Expose, plainToInstance } from 'class-transformer'
+import {
+  IsDate,
+  IsEmail,
+  IsEnum,
+  IsInt,
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsString,
+  Max,
+  Min,
+  validateOrReject,
+} from 'class-validator'
 import TimeFormat from 'hh-mm-ss'
+import JSONbig from 'json-bigint'
 import type { DM_JSON_BiliCommandGrpc } from '..'
 import type { PlatformDanmakuSource } from './platform'
 
@@ -9,8 +24,7 @@ import {
   PlatformVideoSource,
 } from './platform'
 
-const BigIntSerializer = (k: string, v: any) =>
-  typeof v === 'bigint' ? v.toString() : v
+const JSON = JSONbig({ useNativeBigInt: true })
 
 function cleanEmptyObjects(obj: object): object {
   if (obj === null || typeof obj !== 'object') {
@@ -60,23 +74,24 @@ const toBits = (number: number) => {
   return bits.reverse()
 }
 
-export type DMAttr =
-  | 'Protect'
-  | 'FromLive'
-  | 'HighLike'
-  | 'Compatible' // 由dan-any进行过兼容处理的弹幕，可能丢失部分信息
-  | 'Reported' // 在DanUni上被多人举报过的弹幕
-  | 'Unchecked' // 在DanUni上未被审核过的弹幕
-  | 'HasEvent' // 该弹幕当前在DanUni上存在事件(如点赞/举报等)
-  | 'Hide' // 由于其它原因需要隐藏的弹幕(建议在server端不返回该类弹幕)
+export enum DMAttr {
+  Protect = 'Protect',
+  FromLive = 'FromLive',
+  HighLike = 'HighLike',
+  Compatible = 'Compatible', // 由dan-any进行过兼容处理的弹幕，可能丢失部分信息
+  Reported = 'Reported', // 在DanUni上被多人举报过的弹幕
+  Unchecked = 'Unchecked', // 在DanUni上未被审核过的弹幕
+  HasEvent = 'HasEvent', // 该弹幕当前在DanUni上存在事件(如点赞/举报等)
+  Hide = 'Hide', // 由于其它原因需要隐藏的弹幕(建议在server端不返回该类弹幕)
+}
 const DMAttrUtils = {
   fromBin(bin: number = 0, format?: PlatformDanmakuSource) {
     const array = toBits(bin),
       attr: DMAttr[] = []
     if (format === 'bili') {
-      if (array[0]) attr.push('Protect')
-      if (array[1]) attr.push('FromLive')
-      if (array[2]) attr.push('HighLike')
+      if (array[0]) attr.push(DMAttr.Protect)
+      if (array[1]) attr.push(DMAttr.FromLive)
+      if (array[2]) attr.push(DMAttr.HighLike)
     }
     return attr
   },
@@ -91,9 +106,9 @@ const DMAttrUtils = {
   ) {
     const bin = new SetBin(0)
     if (format === 'bili') {
-      if (attr.includes('Protect')) bin.set1(0)
-      if (attr.includes('FromLive')) bin.set1(1)
-      if (attr.includes('HighLike')) bin.set1(2)
+      if (attr.includes(DMAttr.Protect)) bin.set1(0)
+      if (attr.includes(DMAttr.FromLive)) bin.set1(1)
+      if (attr.includes(DMAttr.HighLike)) bin.set1(2)
     }
     return bin.bin
   },
@@ -319,133 +334,194 @@ export interface UniDMObj {
   DMID: string
 }
 
-/**
- * 所有 number/bigint 值设为0自动转换为默认
- */
 export class UniDM {
   /**
-   * 同步时确认位置的参数
+   * 资源ID
+   * @description 由某一danuni服务确定的某一剧集下不同资源(不同视频站/字幕组具有细节差异)的ID
    */
-  // syncAnchor = BigInt(Date.now())
-  constructor(
-    /**
-     * 资源ID
-     * @description 由某一danuni服务确定的某一剧集下不同资源(不同视频站/字幕组具有细节差异)的ID
-     */
-    public SOID: string,
-    /**
-     * 弹幕出现位置(单位s;精度为ms,即保留三位小数)
-     */
-    public progress: number = 0,
-    /**
-     * 弹幕类型
-     */
-    public mode: Modes = Modes.Normal,
-    /**
-     * 字号
-     * @default 25
-     * - 12
-     * - 16
-     * - 18：小
-     * - 25：标准
-     * - 36：大
-     * - 45
-     * - 64
-     */
-    public fontsize: number = 25,
-    /**
-     * 颜色
-     * @description 为DEC值(十进制RGB888值)，默认白色
-     * @default 16777215
-     */
-    public color: number = 16777215,
-    /**
-     * 发送者 senderID
-     */
-    public senderID: string = ID.fromNull().toString(),
-    /**
-     * 正文
-     */
-    public content: string = '',
-    /**
-     * 发送时间
-     */
-    // public ctime: bigint = BigInt(Date.now()),
-    public ctime: Date = new Date(),
-    /**
-     * 权重 用于屏蔽等级 区间:[1,10]
-     * @description 参考B站，源弹幕有该参数则直接利用，
-     * 本实现默认取5，再经过ruleset匹配加减分数
-     * @description 为0时表示暂时未计算权重
-     */
-    public weight: number = 0,
-    /**
-     * 弹幕池 0:普通池 1:字幕池 2:特殊池(代码/BAS弹幕) 3:互动池(互动弹幕中选择投票快速发送的弹幕)
-     */
-    public pool: Pools = Pools.Def,
-    /**
-     * 弹幕属性位(bin求AND)
-     * bit0:保护 bit1:直播 bit2:高赞
-     */
-    public attr: DMAttr[] = [],
-    /**
-     * 初始来源平台
-     * `danuni`与任意空值(可隐式转换为false的值)等价
-     */
-    public platform?: PlatformDanmakuSource | string,
-    /**
-     * 弹幕原始数据(不推荐使用)
-     * @description 适用于无法解析的B站代码弹幕、Artplayer弹幕样式等
-     * @description 初步约定:
-     * - Artplayer: style不为空时，将其JSON.stringify()存入
-     */
-    public extraStr?: string,
-    public DMID?: string,
-  ) {
-    //TODO 引入class-validator
-    if (progress < 0) this.progress = 0
-    if (mode < Modes.Normal || mode > Modes.Ext) this.mode = Modes.Normal
-    if (fontsize < 10 || fontsize > 127) this.fontsize = 25
-    if (color <= 0) this.color = 16777215 //虽然不知道为0是否为可用值，但过为少见，利用其作为默认位
-    // if (ctime <= 0n) this.ctime = BigInt(Date.now())
-    if (weight < 0 || weight > 11) this.weight = 5
-    if (pool < Pools.Def || pool > Pools.Ix) this.pool = Pools.Def
-    // if (attr < 0 || attr > 0b111) this.attr = 0
-    if (!DMID) DMID = this.toDMID()
+  @IsEmail({ require_tld: false })
+  @IsString()
+  @IsNotEmpty()
+  @Expose()
+  public SOID: string = ID.fromNull().toString()
+  /**
+   * 弹幕出现位置(单位s;精度为ms,即保留三位小数)
+   */
+  @Min(0)
+  @IsNumber()
+  @IsNotEmpty()
+  @Expose()
+  public progress: number = 0
+  /**
+   * 弹幕类型
+   */
+  @IsEnum(Modes)
+  @IsNotEmpty()
+  @Expose()
+  public mode: Modes = Modes.Normal
+  /**
+   * 字号
+   * @default 25
+   * - 12
+   * - 16
+   * - 18：小
+   * - 25：标准
+   * - 36：大
+   * - 45
+   * - 64
+   */
+  @Max(64)
+  @Min(12)
+  @IsNumber()
+  @IsNotEmpty()
+  @Expose()
+  public fontsize: number = 25
+  /**
+   * 颜色
+   * @description 为DEC值(十进制RGB888值)，默认白色
+   * @default 16777215
+   */
+  @IsNumber()
+  @IsNotEmpty()
+  @Expose()
+  public color: number = 16777215
+  /**
+   * 发送者 senderID
+   */
+  @IsEmail({ require_tld: false })
+  @IsString()
+  @IsNotEmpty()
+  @Expose()
+  public senderID: string = ID.fromNull().toString()
+  /**
+   * 正文
+   */
+  @IsString()
+  @IsNotEmpty()
+  @Expose()
+  public content: string = ''
+  /**
+   * 发送时间
+   */
+  @IsDate()
+  @IsNotEmpty()
+  @Expose()
+  public ctime: Date = new Date()
+  /**
+   * 权重 用于屏蔽等级 区间:[0,11]
+   * @description 参考B站，源弹幕有该参数则直接利用，
+   * 本实现默认取5，再经过ruleset匹配加减分数
+   * @description 为0时表示暂时未计算权重
+   */
+  @Max(11)
+  @Min(0)
+  @IsInt()
+  @IsNotEmpty()
+  @Expose()
+  public weight: number = 0
+  /**
+   * 弹幕池 0:普通池 1:字幕池 2:特殊池(代码/BAS弹幕) 3:互动池(互动弹幕中选择投票快速发送的弹幕)
+   */
+  @IsEnum(Pools)
+  @IsNotEmpty()
+  @Expose()
+  public pool: Pools = Pools.Def
+  /**
+   * 弹幕属性位(bin求AND)
+   * bit0:保护 bit1:直播 bit2:高赞
+   */
+  @IsEnum(DMAttr, { each: true })
+  @IsNotEmpty()
+  @Expose()
+  public attr: DMAttr[] = []
+  /**
+   * 初始来源平台
+   * `danuni`与任意空值(可隐式转换为false的值)等价
+   */
+  @IsString()
+  @IsOptional()
+  @Expose()
+  public platform?: PlatformDanmakuSource | string
+  /**
+   * 弹幕原始数据(不推荐使用)
+   * @description 适用于无法解析的B站代码弹幕、Artplayer弹幕样式等
+   * @description 初步约定:
+   * - Artplayer: style不为空时，将其JSON.stringify()存入
+   */
+  @IsString()
+  @IsOptional()
+  @Expose()
+  public extraStr?: string
+  @IsString()
+  @IsOptional()
+  @Expose()
+  public DMID?: string
+  @Expose()
+  init() {
+    const def = new UniDM()
+    if (!this.SOID) this.SOID = def.SOID
+    if (!this.progress) this.progress = def.progress
+    if (!this.mode) this.mode = def.mode
+    if (!this.fontsize) this.fontsize = def.mode
+    if (!this.color) this.color = def.color
+    if (!this.senderID) this.senderID = def.senderID
+    if (!this.content) this.content = def.content
+    if (!this.ctime) this.ctime = def.ctime
+    if (!this.weight) this.weight = def.weight
+    if (!this.pool) this.pool = def.pool
+    if (!this.attr) this.attr = def.attr
 
-    this.progress = Number.parseFloat(progress.toFixed(3))
-    if (extraStr)
-      this.extraStr = JSON.stringify(cleanEmptyObjects(JSON.parse(extraStr)))
-    if (extraStr === '{}') this.extraStr = undefined
+    if (!this.DMID) this.DMID = this.toDMID()
+    this.progress = Number.parseFloat(this.progress.toFixed(3))
+    if (this.extraStr)
+      this.extraStr = JSON.stringify(
+        cleanEmptyObjects(JSON.parse(this.extraStr)),
+      )
+    if (this.extraStr === '{}') this.extraStr = undefined
+    else if (this.mode !== Modes.Ext) {
+      const checkExtraBili = (obj?: ExtraBili) =>
+        obj
+          ? (['adv', 'bas', 'code', 'command'] as (keyof ExtraBili)[]).some(
+              (k) => obj[k],
+            )
+          : false
+      if (
+        this.extra.artplayer ||
+        this.extra.danuni?.chapter ||
+        checkExtraBili(this.extra.bili)
+      )
+        this.mode = Modes.Ext
+    }
+    return this
   }
-  static create(args?: Partial<UniDMObj>) {
-    return args
-      ? new UniDM(
-          args.SOID || ID.fromNull().toString(),
-          args.progress,
-          args.mode,
-          args.fontsize,
-          args.color,
-          args.senderID,
-          args.content,
-          args.ctime,
-          args.weight,
-          args.pool,
-          args.attr,
-          args.platform,
-          typeof args.extra === 'object'
-            ? JSON.stringify(args.extra)
-            : args.extra || args.extraStr,
-          args.DMID,
-        )
-      : new UniDM(ID.fromNull().toString())
+  @Expose()
+  async validate() {
+    return validateOrReject(this)
   }
+  static create(pjson?: Partial<UniDMObj>) {
+    return pjson
+      ? plainToInstance(
+          UniDM,
+          pjson.extra
+            ? {
+                ...pjson,
+                extraStr: pjson.extra
+                  ? JSON.stringify(pjson.extra)
+                  : pjson.extraStr,
+              }
+            : pjson,
+          { excludeExtraneousValues: true },
+        ).init()
+      : new UniDM()
+  }
+  @Expose()
   get extra(): Extra {
     const extra = JSON.parse(this.extraStr || '{}')
     // this.extraStr = JSON.stringify(cleanEmptyObjects(extra))
     return extra
     // return cleanEmptyObjects(extra) as Extra
   }
+  @Expose()
   get isFrom3rdPlatform() {
     if (
       this.platform &&
@@ -459,10 +535,20 @@ export class UniDM {
    * @description sha3-256(content+senderID+ctime)截取前8位
    * @description 同一SOID下唯一
    */
+  @Expose()
   toDMID() {
-    return createDMID(this.content, this.senderID, this.ctime)
+    return createDMID(this.content, this.senderID, this.ctime, this.extraStr)
   }
-  isSameAs(dan: UniDM, _check2 = false): boolean {
+  @Expose()
+  isSameAs(dan: UniDM, options?: { skipDanuniMerge?: boolean }): boolean {
+    // 不支持比较高级弹幕
+    if (this.mode === Modes.Ext || dan.mode === Modes.Ext) return false
+    // 合并过视为不同，防止存在合并完成弹幕后再次合并造成计数错误
+    if (
+      !options?.skipDanuniMerge &&
+      (this.extra.danuni?.merge || dan.extra.danuni?.merge)
+    )
+      return false
     const isSame = (k: keyof UniDMObj) => this[k] === dan[k],
       checks = (
         [
@@ -473,39 +559,10 @@ export class UniDM {
           'pool',
         ] satisfies (keyof UniDMObj)[]
       ).every((k) => isSame(k))
-    // 如果两个对象的extra都是空对象，只检查基本字段
-    if (
-      JSON.stringify(this.extra) === '{}' &&
-      JSON.stringify(dan.extra) === '{}'
-    ) {
-      return checks
-    }
-    // 特殊情况：只包含danuni.merge的情况
-    const thisHasOnlyMerge =
-      this.extra.danuni?.merge &&
-      !this.extra.artplayer &&
-      !this.extra.bili &&
-      !this.extra.danuni.chapter
-    const danHasOnlyMerge =
-      dan.extra.danuni?.merge &&
-      !dan.extra.artplayer &&
-      !dan.extra.bili &&
-      !dan.extra.danuni.chapter
-    if (thisHasOnlyMerge && danHasOnlyMerge) {
-      return checks
-    }
-    if (_check2) {
-      return isSame('extraStr') && checks
-    }
-    const a = { ...this.extra }
-    const b = { ...dan.extra }
-    if (a.danuni) delete a.danuni.merge
-    if (b.danuni) delete b.danuni.merge
-    return UniDM.create({ ...a, extraStr: JSON.stringify(a) }).isSameAs(
-      UniDM.create({ ...b, extraStr: JSON.stringify(b) }),
-      true,
-    )
+    // 忽略使用了extra字段却不在mode里标记的弹幕
+    return checks
   }
+  @Expose()
   minify() {
     type UObj = Partial<UniDMObj> & Pick<UniDMObj, 'SOID'>
     const def: UObj = UniDM.create(),
@@ -525,6 +582,7 @@ export class UniDM {
     }
     return JSON.parse(JSON.stringify(dan)) as UObj
   }
+  @Expose()
   downgradeAdvcancedDan(
     {
       include,
@@ -570,7 +628,7 @@ export class UniDM {
         }
       }
       clone.senderID = 'compat[bot]@dan-any'
-      clone.attr.push('Compatible')
+      clone.attr.push(DMAttr.Compatible)
       if (cleanExtra) clone.extraStr = undefined
       return clone
     }
@@ -664,7 +722,7 @@ export class UniDM {
       bili: ExtraBili
     }
     if (args.oid && !cid) cid = args.oid
-    const SOID = `def::${ID.fromBili({ cid })}`,
+    const SOID = `def_${PlatformVideoSource.Bilibili}+${ID.fromBili({ cid })}`,
       senderID = ID.fromBili({ midHash: args.midHash })
     let mode = Modes.Normal
     const pool = args.pool, //暂时不做处理，兼容bili的pool格式
@@ -716,11 +774,14 @@ export class UniDM {
       // 需改进，7=>advanced 8=>code 9=>bas 互动=>command
       // 同时塞进无法/无需直接解析的数据
       // 另开一个解析器，为大部分播放器（无法解析该类dm）做文本类型降级处理
-      extra:
-        args.mode >= 7 ? JSON.stringify(extra, BigIntSerializer) : undefined,
+      extra,
     })
   }
-  toBiliXML() {
+  @Expose()
+  toBiliXML(options?: { skipBiliCommand: boolean }) {
+    if (options?.skipBiliCommand && this.extra.bili?.command) {
+      return null
+    }
     const recMode = (mode: Modes, extra?: ExtraBili) => {
       switch (mode) {
         case Modes.Normal:
@@ -788,16 +849,13 @@ export class UniDM {
       ctime: new Date(`${args.ctime} GMT+0800`), // 无视本地时区，按照B站的东8区计算时间
       weight: 10,
       pool: Pools.Adv,
-      attr: ['Protect'],
+      attr: [DMAttr.Protect],
       platform: PlatformVideoSource.Bilibili,
-      extra: JSON.stringify(
-        {
-          bili: {
-            command: args,
-          },
+      extra: {
+        bili: {
+          command: args,
         },
-        BigIntSerializer,
-      ),
+      },
     })
   }
   static fromDplayer(args: DMDplayer, playerID: string, domain: string) {
@@ -815,6 +873,7 @@ export class UniDM {
       platform: domain,
     })
   }
+  @Expose()
   toDplayer(): DMDplayer {
     let mode = 0
     if (this.mode === Modes.Top) mode = 1
@@ -851,9 +910,10 @@ export class UniDM {
       senderID: senderID.toString(),
       // content: args.content,
       platform: domain,
-      extra: JSON.stringify(extra, BigIntSerializer), //optional BigINt parser
+      extra, //optional BigINt parser
     })
   }
+  @Expose()
   toArtplayer(): DMArtplayer {
     let mode = 0
     if (this.mode === Modes.Top) mode = 1
@@ -885,6 +945,7 @@ export class UniDM {
       DMID: args.cid.toString(), //无需 new ID() 获取带suffix的ID
     })
   }
+  @Expose()
   toDDplay(): DMDDplay {
     let mode = 1
     if (this.mode === Modes.Top) mode = 5

package/src/utils/id-gen.ts

@@ -66,10 +66,13 @@ export function createDMID(
   content: string = '',
   senderID: string,
   ctime: ctime,
+  extraStr?: string,
   slice = 8,
 ) {
   return new jsSHA('SHA3-256', 'TEXT')
-    .update(content + senderID + UniDM.transCtime(ctime).toISOString())
+    .update(
+      `${content}|${senderID}|${UniDM.transCtime(ctime).toISOString()}|${extraStr}`,
+    )
     .getHash('HEX')
     .slice(0, slice)
 }

package/tsconfig.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     /* Visit https://aka.ms/tsconfig to read more about this file */
     /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    "incremental": true /* Save .tsbuildinfo files to allow for incremental compilation of projects. */,
     // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
     // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
     // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
@@ -10,10 +10,10 @@
     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
     /* Language and Environment */
     "target": "ES2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
     // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    "experimentalDecorators": true /* Enable experimental support for legacy experimental decorators. */,
     // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
     // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
     // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */

package/types/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"5.8.3"}