@dan-uni/dan-any 1.0.1 → 1.2.2

package/dist/node/src/proto/gen/danuni_pb.d.ts

@@ -0,0 +1,172 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file danuni.proto.
+ */
+export declare const file_danuni: GenFile;
+/**
+ * @generated from message danuni.danmaku.v1.listDanReq
+ */
+export type listDanReq = Message<"danuni.danmaku.v1.listDanReq"> & {
+    /**
+     * @generated from field: string ID = 1;
+     */
+    ID: string;
+    /**
+     * @generated from field: optional int32 seg = 2;
+     */
+    seg?: number;
+};
+/**
+ * Describes the message danuni.danmaku.v1.listDanReq.
+ * Use `create(listDanReqSchema)` to create a new message.
+ */
+export declare const listDanReqSchema: GenMessage<listDanReq>;
+/**
+ * @generated from message danuni.danmaku.v1.Danmaku
+ */
+export type Danmaku = Message<"danuni.danmaku.v1.Danmaku"> & {
+    /**
+     * @generated from field: string SOID = 1;
+     */
+    SOID: string;
+    /**
+     * @generated from field: string DMID = 2;
+     */
+    DMID: string;
+    /**
+     * @generated from field: int32 progress = 3;
+     */
+    progress: number;
+    /**
+     * @generated from field: danuni.danmaku.v1.Mode mode = 4;
+     */
+    mode: Mode;
+    /**
+     * @generated from field: int32 fontsize = 5;
+     */
+    fontsize: number;
+    /**
+     * @generated from field: int32 color = 6;
+     */
+    color: number;
+    /**
+     * @generated from field: string senderID = 7;
+     */
+    senderID: string;
+    /**
+     * @generated from field: string content = 8;
+     */
+    content: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp ctime = 9;
+     */
+    ctime?: Timestamp;
+    /**
+     * @generated from field: int32 weight = 10;
+     */
+    weight: number;
+    /**
+     * @generated from field: danuni.danmaku.v1.Pool pool = 11;
+     */
+    pool: Pool;
+    /**
+     * @generated from field: repeated string attr = 12;
+     */
+    attr: string[];
+    /**
+     * @generated from field: optional string platform = 13;
+     */
+    platform?: string;
+    /**
+     * @generated from field: optional string extra = 14;
+     */
+    extra?: string;
+};
+/**
+ * Describes the message danuni.danmaku.v1.Danmaku.
+ * Use `create(DanmakuSchema)` to create a new message.
+ */
+export declare const DanmakuSchema: GenMessage<Danmaku>;
+/**
+ * @generated from message danuni.danmaku.v1.DanmakuReply
+ */
+export type DanmakuReply = Message<"danuni.danmaku.v1.DanmakuReply"> & {
+    /**
+     * @generated from field: repeated danuni.danmaku.v1.Danmaku danmakus = 1;
+     */
+    danmakus: Danmaku[];
+};
+/**
+ * Describes the message danuni.danmaku.v1.DanmakuReply.
+ * Use `create(DanmakuReplySchema)` to create a new message.
+ */
+export declare const DanmakuReplySchema: GenMessage<DanmakuReply>;
+/**
+ * @generated from enum danuni.danmaku.v1.Mode
+ */
+export declare enum Mode {
+    /**
+     * @generated from enum value: Normal = 0;
+     */
+    Normal = 0,
+    /**
+     * @generated from enum value: Bottom = 1;
+     */
+    Bottom = 1,
+    /**
+     * @generated from enum value: Top = 2;
+     */
+    Top = 2,
+    /**
+     * @generated from enum value: Reverse = 3;
+     */
+    Reverse = 3,
+    /**
+     * @generated from enum value: Ext = 4;
+     */
+    Ext = 4
+}
+/**
+ * Describes the enum danuni.danmaku.v1.Mode.
+ */
+export declare const ModeSchema: GenEnum<Mode>;
+/**
+ * @generated from enum danuni.danmaku.v1.Pool
+ */
+export declare enum Pool {
+    /**
+     * @generated from enum value: Def = 0;
+     */
+    Def = 0,
+    /**
+     * @generated from enum value: Sub = 1;
+     */
+    Sub = 1,
+    /**
+     * @generated from enum value: Adv = 2;
+     */
+    Adv = 2,
+    /**
+     * @generated from enum value: Ix = 3;
+     */
+    Ix = 3
+}
+/**
+ * Describes the enum danuni.danmaku.v1.Pool.
+ */
+export declare const PoolSchema: GenEnum<Pool>;
+/**
+ * @generated from service danuni.danmaku.v1.DanmakuService
+ */
+export declare const DanmakuService: GenService<{
+    /**
+     * @generated from rpc danuni.danmaku.v1.DanmakuService.listDan
+     */
+    listDan: {
+        methodKind: "unary";
+        input: typeof listDanReqSchema;
+        output: typeof DanmakuReplySchema;
+    };
+}>;

package/dist/node/src/utils/dm-gen.d.ts

@@ -0,0 +1,309 @@
+import type { DM_JSON_BiliCommandGrpc } from '..';
+import type { PlatformDanmakuSource } from './platform';
+import { DMIDGenerator } from './id-gen';
+import { PlatformDanmakuOnlySource } from './platform';
+export declare enum DMAttr {
+    Protect = "Protect",
+    FromLive = "FromLive",
+    HighLike = "HighLike",
+    Compatible = "Compatible",// 由dan-any进行过兼容处理的弹幕，可能丢失部分信息
+    Reported = "Reported",// 在DanUni上被多人举报过的弹幕
+    Unchecked = "Unchecked",// 在DanUni上未被审核过的弹幕
+    HasEvent = "HasEvent",// 该弹幕当前在DanUni上存在事件(如点赞/举报等)
+    Hide = "Hide"
+}
+interface DMBili {
+    id: bigint;
+    progress: number;
+    mode: number;
+    fontsize: number;
+    color: number;
+    mid?: bigint;
+    midHash: string;
+    /**
+     * 特殊类型解析：
+     * - [ohh] : /oh{2,}/gi
+     * - [前方高能]
+     * - [...] (JS数组) : 高级弹幕
+     */
+    content: string;
+    ctime: bigint;
+    pool: number;
+    weight?: number;
+    action?: string;
+    idStr?: string;
+    attr?: number;
+    animation?: string;
+    extra?: string;
+    colorful?: number;
+    type?: number;
+    oid?: bigint;
+}
+interface DMBiliCommand extends DM_JSON_BiliCommandGrpc {
+}
+interface DMDplayer {
+    /**
+     * 进度(秒)
+     */
+    progress: number;
+    mode: number;
+    color: number;
+    midHash: string;
+    content: string;
+}
+interface DMArtplayer {
+    /**
+     * 进度(秒)
+     */
+    progress: number;
+    mode: number;
+    color: number;
+    content: string;
+    border?: boolean;
+    style?: object;
+}
+interface DMDDplay {
+    cid: bigint;
+    /**
+     * content
+     */
+    m: string;
+    /**
+     * p[0]
+     */
+    progress: number;
+    /**
+     * p[1]
+     */
+    mode: number;
+    /**
+     * p[2]
+     */
+    color: number;
+    /**
+     * p[3]
+     */
+    uid: string;
+}
+export interface Extra {
+    artplayer?: ExtraArtplayer;
+    bili?: ExtraBili;
+    danuni?: ExtraDanUni;
+}
+interface ExtraArtplayer {
+    style?: object;
+    border?: boolean;
+}
+interface ExtraBili {
+    mode?: number;
+    pool?: number;
+    dmid?: bigint;
+    attr?: number;
+    mid?: bigint;
+    adv?: string;
+    code?: string;
+    bas?: string;
+    command?: DMBiliCommand;
+}
+export interface ExtraDanUni {
+    chapter?: ExtraDanUniChapter;
+    merge?: ExtraDanUniMerge;
+}
+export interface ExtraDanUniChapter {
+    duration: number;
+    type: ExtraDanUniChapterType;
+}
+export interface ExtraDanUniMerge {
+    duration: number;
+    count: number;
+    senders: string[];
+    taolu_count: number;
+    taolu_senders: string[];
+}
+export declare enum ExtraDanUniChapterType {
+    Chapter = "ch",//其它片段(用于标记章节)
+    Review = "rev",//回顾
+    OP = "op",//片头
+    Intermission = "int",//中场
+    ED = "ed",//片尾
+    Preview = "prvw",//预告
+    Cut = "cut",//删减(删减版中提供删减说明,提供开始位置、长度)
+    Duplicate = "dup",//补档(完整版中指明其它平台中删减位置)
+    AdBiz = "biz",//商业广告
+    AdUnpaid = "promo"
+}
+export declare enum ExtraDanUniChapterAction {
+    Disabled = -1,
+    ShowOverlay = 0,
+    ManualSkip = 1,
+    AutoSkip = 2
+}
+export declare enum Modes {
+    Normal = 0,
+    Bottom = 1,
+    Top = 2,
+    Reverse = 3,//逆向弹幕
+    Ext = 4
+}
+export declare enum Pools {
+    Def = 0,//默认池
+    Sub = 1,//重要池，建议强制加载，含字幕、科普、空降等
+    Adv = 2,//高级弹幕专用池，均需读取extra
+    Ix = 3
+}
+export type ctime = string | number | bigint | Date;
+export interface UniDMObj {
+    SOID: string;
+    progress: number;
+    mode: Modes;
+    fontsize: number;
+    color: number;
+    senderID: string;
+    content: string;
+    ctime: Date;
+    weight: number;
+    pool: Pools;
+    attr: DMAttr[];
+    platform: PlatformDanmakuSource | string;
+    extra: string | Extra;
+    extraStr: string;
+    DMID: string;
+}
+interface Options {
+    dmid?: boolean | number | DMIDGenerator;
+}
+export declare class UniDM {
+    /**
+     * 资源ID
+     * @description 由某一danuni服务确定的某一剧集下不同资源(不同视频站/字幕组具有细节差异)的ID
+     */
+    SOID: string;
+    /**
+     * 弹幕出现位置(单位s;精度为ms,即保留三位小数)
+     */
+    progress: number;
+    /**
+     * 弹幕类型
+     */
+    mode: Modes;
+    /**
+     * 字号
+     * @default 25
+     * - 12
+     * - 16
+     * - 18：小
+     * - 25：标准
+     * - 36：大
+     * - 45
+     * - 64
+     */
+    fontsize: number;
+    /**
+     * 颜色
+     * @description 为DEC值(十进制RGB888值)，默认白色
+     * @default 16777215
+     */
+    color: number;
+    /**
+     * 发送者 senderID
+     */
+    senderID: string;
+    /**
+     * 正文
+     */
+    content: string;
+    /**
+     * 发送时间
+     */
+    ctime: Date;
+    /**
+     * 权重 用于屏蔽等级 区间:[0,11]
+     * @description 参考B站，源弹幕有该参数则直接利用，
+     * 本实现默认取5，再经过ruleset匹配加减分数
+     * @description 为0时表示暂时未计算权重
+     */
+    weight: number;
+    /**
+     * 弹幕池 0:普通池 1:字幕池 2:特殊池(代码/BAS弹幕) 3:互动池(互动弹幕中选择投票快速发送的弹幕)
+     */
+    pool: Pools;
+    /**
+     * 弹幕属性位(bin求AND)
+     * bit0:保护 bit1:直播 bit2:高赞
+     */
+    attr: DMAttr[];
+    /**
+     * 初始来源平台
+     * `danuni`与任意空值(可隐式转换为false的值)等价
+     */
+    platform?: PlatformDanmakuSource | string;
+    /**
+     * 弹幕原始数据(不推荐使用)
+     * @description 适用于无法解析的B站代码弹幕、Artplayer弹幕样式等
+     * @description 初步约定:
+     * - Artplayer: style不为空时，将其JSON.stringify()存入
+     */
+    extraStr?: string;
+    DMID?: string;
+    private options;
+    init(options?: Options): this;
+    validate(): Promise<void>;
+    static create(pjson?: Partial<UniDMObj>, options?: Options): UniDM;
+    get extra(): Extra;
+    get isFrom3rdPlatform(): boolean;
+    /**
+     * 弹幕id
+     * @description sha3-256(content+senderID+ctime)截取前8位
+     * @description 同一SOID下唯一
+     */
+    toDMID(): string | undefined;
+    isSameAs(dan: UniDM, options?: {
+        skipDanuniMerge?: boolean;
+    }): boolean;
+    minify(): Partial<UniDMObj> & Pick<UniDMObj, "SOID">;
+    downgradeAdvcancedDan({ include, exclude, cleanExtra, }?: {
+        include?: (keyof Extra)[];
+        exclude?: (keyof Extra)[];
+        cleanExtra?: boolean;
+    }): UniDM;
+    /**
+     * 将各种类型的时间进行格式化
+     * @param oriCtime
+     * @param tsUnit 当`oriCtime`为数字类型表时间戳时的单位;
+     * 为 毫秒(ms)/秒(s)
+     * @returns {Date} Date格式时间
+     */
+    static transCtime(oriCtime: ctime, tsUnit?: 'ms' | 's'): Date;
+    static transMode(oriMode: number, fmt: 'bili' | 'dplayer' | 'artplayer' | 'ddplay'): Modes;
+    static parseBiliSingle(p: string, c: string): {
+        content: string;
+        progress: number;
+        mode: number;
+        fontsize: number;
+        color: number;
+        ctime: bigint;
+        pool: number;
+        midHash: string;
+        id: bigint;
+        weight: number;
+    };
+    static fromBili(args: DMBili, cid?: bigint, options?: Options, recSOID?: string): UniDM;
+    toBiliXML(options?: {
+        skipBiliCommand?: boolean;
+        /**
+         * 见 ../index.ts UniPool.toBiliXML() 的 options，该option不宜手动调用，判断逻辑未封装
+         */
+        avoidSenderIDWithAt?: boolean;
+    }): {
+        '#text': string;
+        '@_p': string;
+    } | null;
+    static fromBiliCommand(args: DMBiliCommand, cid?: bigint, options?: Options): UniDM;
+    static fromDplayer(args: DMDplayer, playerID: string, domain: string, options?: Options): UniDM;
+    toDplayer(): DMDplayer;
+    static fromArtplayer(args: DMArtplayer, playerID: string, domain: string, options?: Options): UniDM;
+    toArtplayer(): DMArtplayer;
+    static fromDDplay(args: DMDDplay, episodeId: string, domain?: PlatformDanmakuOnlySource, options?: Options): UniDM;
+    toDDplay(): DMDDplay;
+}
+export {};

package/dist/node/src/utils/dm-gen.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/node/src/utils/id-gen.d.ts

@@ -0,0 +1,50 @@
+import type { PlatformSource } from './platform';
+import { UniDM } from './dm-gen';
+export declare class UniID {
+    /**
+     * @description 每个domain下应为唯一值
+     * @example danuni: 推荐为UUID/ULID/NanoID
+     * bili: midHash hash算法为CRC32
+     */
+    id: string;
+    /**
+     * @description 弹幕首次出现的平台域名(注意可以为如localhost等根域名)
+     * ### 预设
+     * - `{any}.danuni` (若使用IP或无域名，请使用该domain，防止隐私泄露/无法解析)
+     * #### 注意
+     * - `any`值建议为UUID/ULID/NanoID以防同步错误
+     * ### 非DanUni弹幕服务建议使用预设，或自行填写域名
+     */
+    domain: PlatformSource | string;
+    constructor(
+    /**
+     * @description 每个domain下应为唯一值
+     * @example danuni: 推荐为UUID/ULID/NanoID
+     * bili: midHash hash算法为CRC32
+     */
+    id: string, 
+    /**
+     * @description 弹幕首次出现的平台域名(注意可以为如localhost等根域名)
+     * ### 预设
+     * - `{any}.danuni` (若使用IP或无域名，请使用该domain，防止隐私泄露/无法解析)
+     * #### 注意
+     * - `any`值建议为UUID/ULID/NanoID以防同步错误
+     * ### 非DanUni弹幕服务建议使用预设，或自行填写域名
+     */
+    domain: PlatformSource | string);
+    static fromString(str: string): UniID;
+    toString(): string;
+    static fromNull(domain?: PlatformSource | 'runtime' | string): UniID;
+    static fromBili({ cid, mid, midHash, }: {
+        cid?: number | bigint | string;
+        mid?: number | bigint;
+        midHash?: string;
+    }): UniID;
+    static fromUnknown(id: string, 
+    /**
+     * 可使用预设
+     */
+    domain: PlatformSource | string): UniID;
+}
+export type DMIDGenerator = (dan: UniDM, slice?: number) => string;
+export declare function createDMID(dan: UniDM, slice?: number): string;

package/dist/node/src/utils/platform.d.ts

@@ -0,0 +1,24 @@
+export declare enum PlatformInfoSource {
+    Bangumi = "bgm",
+    TMDB = "tmdb"
+}
+export declare const PlatformInfoSources: PlatformInfoSource[];
+export declare enum PlatformVideoSource {
+    Acfun = "acfun",
+    Baha = "baha",
+    Bilibili = "bili",
+    BilibiliGlobal = "bglobal",
+    Iqiyi = "iqiyi",
+    Tencent = "tencent",
+    Youku = "youku"
+}
+export declare const PlatformVideoSources: PlatformVideoSource[];
+export declare enum PlatformDanmakuOnlySource {
+    DanDanPlay = "ddplay",
+    TuCao = "tucao"
+}
+export declare const PlatformDanmakuOnlySources: PlatformDanmakuOnlySource[];
+export type PlatformDanmakuSource = PlatformVideoSource | PlatformDanmakuOnlySource;
+export declare const PlatformDanmakuSources: (PlatformVideoSource | PlatformDanmakuOnlySource)[];
+export type PlatformSource = PlatformInfoSource | PlatformDanmakuSource;
+export declare const PlatformSources: (PlatformInfoSource | PlatformVideoSource | PlatformDanmakuOnlySource)[];