@soga/types 0.2.58 → 0.5.0

package/dist/index.d.mts

@@ -0,0 +1,843 @@
+type PaginationParams = {
+    page?: number;
+    pagesize?: number;
+};
+type ApiResponse<T = never> = {
+    data: T;
+    code: number;
+    message: string;
+};
+type ApiListResponse<T = never> = {
+    data: T;
+    currentPage: number;
+    perPage: number;
+    total: number;
+    previousPage: null | number;
+    nextPage: null | number;
+    lastPage: number;
+    code: number;
+    message: string;
+};
+type LocalListResponse<T = never> = {
+    list: T;
+    perpage: number;
+    pages: number;
+    total: number;
+};
+type UpyunSignInfo = {
+    bucket: string;
+    domain: string;
+    policy: string;
+    signature: string;
+    authorization: string;
+    api: string;
+};
+type WithP<T = never> = {
+    page?: number;
+    pagesize?: number;
+} & T;
+type WithPK<T = never> = WithP<{
+    keyword: string;
+}> & T;
+
+declare enum HostType {
+    BAIDU = "baidu",
+    ALI = "ali"
+}
+declare enum CloudType {
+    BAIDU = 1,
+    ALI = 2
+}
+interface CommonHostDetail {
+    id: number;
+    access_token: string;
+    account_level: string;
+    account_name: string;
+    avatar_url: string;
+    cloud_type: CloudType;
+    created_at: string;
+    quota_total: number;
+    quota_used: number;
+    refresh_at: string;
+    user_id: number;
+    vip_type: number;
+    remark: string;
+    uk: string;
+    is_save: number;
+}
+interface BaiduHostDetail extends CommonHostDetail {
+    cloud_type: CloudType.BAIDU;
+    api_info: null;
+}
+interface AliHostDetail extends CommonHostDetail {
+    cloud_type: CloudType.ALI;
+    api_info: {
+        drive_id: string;
+        dpan_file_id: string;
+        cache_file_id: string;
+        space_file_id: string;
+    };
+}
+type HostDetail = BaiduHostDetail | AliHostDetail;
+type HostListItem = HostDetail;
+
+type ManifestBaiduType = {
+    host_id: number;
+    info: Record<string, {
+        fs_id: number;
+        md4: string;
+    }>;
+};
+type ManifestAliType = {
+    host_id: number;
+    info: Record<string, {
+        file_id: string;
+        sha1: string;
+    }>;
+    drive_id: string;
+};
+type ManifestPartsType = Record<string, {
+    md5: string;
+    size: number;
+    preview: boolean;
+    source: boolean;
+}>;
+type ManifestSourceType = {
+    head: string;
+    parts: string[];
+};
+type ManifestTxtType = {
+    pad: number;
+    pages: number;
+    entrance: {
+        file: string;
+        start: number;
+        end: number;
+    };
+    parts: string[];
+};
+type ManifestImgType = {
+    meta: {
+        height: number;
+        size: number;
+        t_height: number;
+        t_size: number;
+        t_width: number;
+        width: number;
+    };
+    preview: {
+        file: string;
+        start: number;
+        end: number;
+    }[];
+    parts: string[];
+};
+type ManifestMetaType = {
+    btime: number;
+    ctime: number;
+    mtime: number;
+    filename: string;
+    filesize: number;
+    host_size: number;
+};
+type ManifestCoverInfo = {
+    file: string;
+    size: number;
+    width: number;
+    height: number;
+    start: number;
+    end: number;
+};
+type ManifestTextItem = {
+    uuid: string;
+    builtin: boolean;
+    end: number;
+    file: string;
+    lang: string;
+    size: number;
+    source?: {
+        end: number;
+        file: string;
+        size: number;
+        start: number;
+        ext: string;
+    };
+    start: number;
+    name: string;
+    title: string;
+};
+type ManifestAudioItem = {
+    average_band: number;
+    band: number;
+    channels: number;
+    codec: string;
+    codec_name: string;
+    end: number;
+    file: string;
+    language: string;
+    order: number;
+    size: number;
+    start: number;
+    hash?: string;
+    high?: ManifestAudioItem;
+};
+type ManifestThumbnailInfo = {
+    col: number;
+    end: number;
+    file: string;
+    height: number;
+    row: number;
+    size: number;
+    start: number;
+    width: number;
+};
+type ManifestThumbnailItem = {
+    e: number;
+    et: number;
+    file: string;
+    h: number;
+    s: number;
+    st: number;
+    w: number;
+    x: number;
+    y: number;
+};
+type ManifestVideoItem = {
+    average_band: number;
+    band: number;
+    bitdepth: number;
+    codec: string;
+    codec_name: string;
+    end: number;
+    file: string;
+    framerate: number;
+    height: number;
+    label: string;
+    size: number;
+    start: number;
+    width: number;
+    hash?: string;
+};
+type ManifestAudioMetaInfo = {
+    channels: number;
+    codec: string;
+    codec_name: string;
+    duration: number;
+    lossless: boolean;
+};
+type ManifestVideoMetaInfo = {
+    bitdepth: number;
+    codec: string;
+    codec_name: string;
+    duration: number;
+    framerate: number;
+    height: number;
+    label: string;
+    width: number;
+};
+type ManifestMediaType = {
+    cover: ManifestCoverInfo;
+    texts: ManifestTextItem[];
+    audios: ManifestAudioItem[];
+    videos: ManifestVideoItem[];
+    thumbnail: ManifestThumbnailInfo;
+    audio_meta: ManifestAudioMetaInfo;
+    video_meta: ManifestVideoMetaInfo;
+    parts: string[];
+};
+type ManifestAffixItem = {
+    filename: string;
+    head: string;
+    size: number;
+    uuid: string;
+    parts: string[];
+    btime: number;
+    ctime: number;
+    mtime: number;
+};
+type Manifest = {
+    baidu: ManifestBaiduType;
+    ali: ManifestAliType;
+    parts: ManifestPartsType;
+    source?: ManifestSourceType;
+    img?: ManifestImgType;
+    media?: ManifestMediaType;
+    txt?: ManifestTxtType;
+    affix?: ManifestAffixItem[];
+    meta: ManifestMetaType;
+};
+
+declare enum RecordType {
+    FOLDER = 0,
+    VIDEO = 1,
+    AUDIO = 2,
+    IMAGE = 3,
+    TXT = 4,
+    TEXT = 5,
+    OTHER = 6,
+    TEXT_RELATION = 120,
+    AFFIX = 127
+}
+declare enum RecordFtype {
+    NONE = 0,
+    VIDEO_NORMAL = 11,
+    VIDEO_VR = 12,
+    VIDEO_3D = 13,
+    IMAGE_NORMAL = 31,
+    IMAGE_VR = 32,
+    TEXT_PDF = 52,
+    TEXT_WORD = 53,
+    TEXT_EXCEL = 55,
+    TEXT_PPT = 55,
+    TEXT_OTHER = 56
+}
+declare enum RecordInsertLast {
+    NULL = 0,
+    YES = 1,
+    NO = -1
+}
+declare enum RecordFileKeep {
+    NULL = 0,
+    SOURCE = 1,
+    PREVIEW = 2,
+    BOTH = 3
+}
+declare enum RecordAdaptResolution {
+    NULL = 0,
+    YES = 1,
+    NO = -1
+}
+type RecordFolderConfig = {
+    insert_last: RecordInsertLast;
+    file_keeps: RecordFileKeep;
+    adapt_resolution: RecordAdaptResolution;
+};
+type RecordCommonFields = {
+    id: number;
+    space_id: number;
+    parent_id: number;
+    name: string;
+    type: RecordType;
+    ftype: RecordFtype;
+    manifest: Manifest;
+    manifest_md5: string;
+    sort: number;
+    parts_num: number;
+    share_text: null | {
+        baidu: string | null;
+        ali: string | null;
+    };
+    share_status: number;
+    creator_id: number;
+    cover: string;
+    intro: string;
+    cloud_ids: string;
+    cloud_info: {
+        ali: {
+            id: number;
+            name: string;
+            remark: string;
+            isdir: number;
+            file_id: string;
+            drive_id: string;
+            account_level: string;
+            account_name: string;
+            avatar_url: string;
+            openPath: string;
+            vip_type: number;
+        };
+        baidu: {
+            id: number;
+            name: string;
+            remark: string;
+            path: string;
+            fs_id: number;
+            isdir: number;
+            account_level: string;
+            account_name: string;
+            avatar_url: string;
+            openPath: string;
+            vip_type: number;
+        };
+    };
+    config: RecordFolderConfig;
+    created_at: string;
+    updated_at: string;
+};
+type RecordListItem = RecordCommonFields & {
+    size: number;
+    duration: number;
+};
+type RecordDetail = RecordCommonFields & {
+    album: RecordListItem;
+    navs: {
+        id: number;
+        name: string;
+    }[];
+};
+type CloudInfoField = {
+    id: number;
+    name: string;
+    hosts: {
+        ali?: {
+            id: number;
+            name: string;
+            drive_id: string;
+            file_id: string;
+        };
+        baidu?: {
+            id: number;
+            name: string;
+            fs_id: number;
+            path: string;
+        };
+    };
+};
+
+declare enum UploadProcessStep {
+    prepare = "PREPARE",
+    separate_video = "SEPARATE_VIDEO",
+    separate_audio = "SEPARATE_AUDIO",
+    separate_text = "SEPARATE_TEXT",
+    transcode_video = "TRANSCODE_VIDEO",
+    transcode_audio = "TRANSCODE_AUDIO",
+    transcode_thumbnail = "TRANSCODE_THUMBNAIL",
+    transcode_source = "TRANSCODE_SOURCE",
+    transcode_txt = "TRANSCODE_TXT",
+    transcode_img = "TRANSCODE_IMG",
+    transcode_affix = "TRANSCODE_AFFIX",
+    group_media = "GROUP_MEDIA",
+    upload_baidu = "UPLOAD_BAIDU",
+    upload_ali = "UPLOAD_ALI",
+    end = "END"
+}
+type UploadPrepareData = Partial<Record<UploadProcessStep, {
+    weight: number;
+    percent: number;
+}>>;
+type UploadPrepareOptions = {
+    keep_preview?: boolean;
+    keep_source?: boolean;
+};
+type PrepareResult = {
+    options: UploadPrepareOptions;
+    data: UploadPrepareData;
+};
+type GroupFileInfo = {
+    file: string;
+    size: number;
+    start: number;
+    end: number;
+    hash?: string;
+};
+type MediaGroupQualityAudioItem = {
+    average_band: number;
+    band: number;
+    channels: number;
+    codec: string;
+    codec_name: string;
+    language: string;
+    order: number;
+} & GroupFileInfo;
+type MediaGroupAudioItem = MediaGroupQualityAudioItem & {
+    high?: MediaGroupQualityAudioItem;
+};
+type MediaGroupVideoItem = {
+    label: string;
+    average_band: number;
+    band: number;
+    codec: string;
+    codec_name: string;
+    framerate: number;
+    bitdepth: number;
+    width: number;
+    height: number;
+} & GroupFileInfo;
+type MediaGroupThumbnailInfo = {
+    row: number;
+    col: number;
+    width: number;
+    height: number;
+} & GroupFileInfo;
+type MediaGroupCoverInfo = {
+    width: number;
+    height: number;
+} & GroupFileInfo;
+type FilePartItem = {
+    start: number;
+    end: number;
+    size: number;
+    file: string;
+    path: string;
+    index?: number;
+    md4?: string;
+    md5?: string;
+    sha1?: string;
+};
+type MediaGroupData = {
+    video_meta: ManifestVideoMetaInfo;
+    audio_meta: ManifestAudioMetaInfo;
+    texts: ManifestTextItem[];
+    audios: MediaGroupAudioItem[];
+    videos: MediaGroupVideoItem[];
+    thumbnail: MediaGroupThumbnailInfo;
+    cover: MediaGroupCoverInfo;
+    parts: FilePartItem[];
+};
+type SourceGroupData = {
+    size: number;
+    head: string;
+    filename: string;
+    btime: number;
+    ctime: number;
+    mtime: number;
+    parts: FilePartItem[];
+};
+type AffixItemData = {
+    filename: string;
+    uuid: string;
+    size: number;
+    head: string;
+    btime: number;
+    ctime: number;
+    mtime: number;
+    parts: FilePartItem[];
+};
+type TxtGroupData = {
+    pad: number;
+    pages: number;
+    map: {
+        file: string;
+        start: number;
+        end: number;
+    };
+    parts: FilePartItem[];
+};
+type EncoderResult = {
+    source?: SourceGroupData;
+    media?: MediaGroupData;
+};
+type ImgGroupData = {
+    meta: {
+        width: number;
+        height: number;
+        size: number;
+        t_width: number;
+        t_height: number;
+        t_size: number;
+    };
+    parts: FilePartItem[];
+};
+type EncodeResult = {
+    source?: SourceGroupData;
+    media?: MediaGroupData;
+    txt?: TxtGroupData;
+    img?: ImgGroupData;
+};
+type EncodeWorkerPercent = {
+    id: number;
+    type: 'percent';
+    data: {
+        step: UploadProcessStep;
+        percent: number;
+    };
+};
+type UploadWorkerPercent = {
+    id: number;
+    type: 'percent';
+    data: {
+        part_id: number;
+        host_type: HostType;
+        percent: number;
+    };
+};
+type WorkerError = {
+    id: number;
+    type: 'error';
+    data: {
+        code: number;
+        message: string;
+        cause?: string;
+        stack?: string;
+    };
+};
+type EncodeWorkerMessage = EncodeWorkerPercent | WorkerError;
+type UploadWorkerMessage = UploadWorkerPercent | WorkerError;
+
+declare enum EncodeStatus {
+    NULL = 0,
+    PROCESS = 1,
+    SUCCESS = 2,
+    ERROR = 4
+}
+declare enum UploadStatus {
+    NULL = 0,
+    PROCESS = 1,
+    SUCCESS = 2,
+    ERROR = 4
+}
+declare enum RootStatus {
+    NULL = 0,
+    PROCESS = 1,
+    SUCCESS = 2,
+    PAUSED = 3,
+    ERROR = 4
+}
+type UploadInputItem = {
+    filename: string;
+    filepath: string;
+    filesize: number;
+    local_btime: number;
+    local_ctime: number;
+    local_mtime: number;
+};
+type EncodedData = {
+    media?: MediaGroupData;
+    txt?: TxtGroupData;
+    img?: ImgGroupData;
+    source?: SourceGroupData;
+    affix?: AffixItemData[];
+};
+type UploadedData = Record<HostType, Record<string, object>>;
+type UploadFileItem = {
+    id: number;
+    total_count: number;
+    completed_count: number;
+    inputs: UploadInputItem[];
+    filepath: string;
+    root_id: number;
+    root_status: RootStatus;
+    space_id: number;
+    space_name: string;
+    is_ready: boolean;
+    config: RecordFolderConfig;
+    uid: number;
+    aid: number;
+    encode_status: EncodeStatus;
+    baidu_host_id: number;
+    baidu_upload_status: UploadStatus;
+    ali_host_id: number;
+    ali_upload_status: UploadStatus;
+    some_parts_uploaded: boolean;
+    upload_status: UploadStatus;
+    is_paused: boolean;
+    pid: number;
+    type: RecordType;
+    task_record_id: number;
+    cloud_info: CloudInfoField;
+    output_root: string;
+    external_texts: string[];
+    progress: UploadPrepareData;
+    percent: number;
+    encoded: EncodedData;
+    uploaded: UploadedData;
+    order: number;
+    updated_at: string;
+    created_at: string;
+};
+type UploadFileSuceessItem = {
+    id: number;
+    space_id: number;
+    space_name: string;
+    uid: number;
+    title: string;
+    path: string;
+    cloud_id: number;
+    type: RecordType;
+    updated_at: string;
+    created_at: string;
+};
+
+type MemberInfo = {
+    id: number;
+    name: string;
+    phone: string;
+    email: string;
+    nick: string;
+    avatar: string;
+    invite_code: string;
+    points: number;
+    private_space_id: number;
+    created_at: string;
+    updated_at: string;
+};
+
+type UserGroupListItem = {
+    id: number;
+    name: string;
+    sort: number;
+    space_id: number;
+    users_count: number;
+};
+type UserListItem = {
+    id: number;
+    space_id: number;
+    user_id: number;
+    remark: string;
+    group_ids: string;
+    user_name: string;
+    avatar: string;
+    groups: {
+        id: number;
+        name: string;
+        join_time: string;
+    }[];
+};
+
+type ShareListItem = {
+    created_at: string;
+    expire_at: string | null;
+    file_id: number;
+    id: number;
+    keywords: string;
+    name: string;
+    space_id: number;
+    to_id: number;
+    to_type: number;
+    updated_at: string;
+};
+type ShareUserListItem = {
+    share_id: number;
+    user_id: number;
+    user_name: string;
+    user_nick: string;
+    remark: string;
+    groups: {
+        id: number;
+        name: string;
+    }[];
+    status: string;
+    expire_at: string;
+};
+type ShareHistoryListItem = {
+    id: number;
+    space_id: number;
+    file_id: number;
+    name: string;
+    to_type: number;
+    to_id: number;
+    expire_at: string | null;
+    created_at: string;
+    remaining_days: string;
+    to_name: string;
+    to_remark: string;
+};
+
+type SubListItem = {
+    id: number;
+    share_id: number;
+    space_id: number;
+    file_id: number;
+    name: string;
+    space_name: string;
+    status: string;
+    sub_status: number;
+    expire_at: string;
+    created_at: string;
+    cloud_id: number;
+    cloud_info: null;
+    needUpdate: number;
+    share_text: {
+        ali?: string;
+        baidu?: string;
+    };
+};
+
+type SpaceLevelItem = {
+    id: number;
+    name: string;
+    price: number;
+    user_limit: number;
+    member_limit: number;
+    album_limit: number;
+    cloud_limit: number;
+    file_limit: number;
+    filesize_limit: number;
+    created_at: string;
+    updated_at: string;
+};
+type SpaceListItem = {
+    id: number;
+    name: string;
+    intro: string;
+    img: string;
+    package_id: number;
+    fromtime: number;
+    totime: number;
+    package: SpaceLevelItem;
+    is_dynamic: 0 | 1;
+    watermark: string;
+};
+type SpaceDetail = SpaceListItem;
+
+type ErrorData = {
+    code: number;
+    message: string;
+    reason: string[];
+    detail: string;
+    retryMax: number;
+    remark?: string;
+    stack?: unknown;
+    manual?: boolean;
+};
+
+declare enum DownloadStatus {
+    NULL = 0,
+    PROCESS = 1,
+    SUCCESS = 2,
+    ERROR = 4
+}
+type DownloadProgressStep = 'PREPARE' | 'DOWNLOAD_CHUNK' | 'COMBINE_CHUNK' | 'UNPACK' | 'ENDING';
+type DownloadProgressData = Record<DownloadProgressStep, {
+    weight: number;
+    percent: number;
+}>;
+type DownloadFileItem = {
+    id: number;
+    is_affix: boolean;
+    is_paused: boolean;
+    type: RecordType;
+    ftype: RecordFtype;
+    routes: string[];
+    download_root: string;
+    download_temp: string;
+    download_name: string;
+    pid: number;
+    root_id: number;
+    space_id: number;
+    uid: number;
+    record: RecordListItem;
+    order: number;
+    status: DownloadStatus;
+    file_total: number;
+    file_successed: number;
+    file_size: number;
+    percent: number;
+    progress: DownloadProgressData;
+    error: ErrorData;
+    update_at: string;
+    create_at: string;
+};
+
+declare enum NetType {
+    DOWNLOAD = "download",
+    UPLOAD = "upload"
+}
+type NetSuccessItem = {
+    id: number;
+    uid: number;
+    net_type: NetType;
+    is_affix: boolean;
+    type: RecordType;
+    ftype: RecordFtype;
+    space_id: number;
+    title: string;
+    local_path: string;
+    record_id: number;
+    file_total: number;
+    file_size: number;
+    updated_at: Date;
+    created_at: Date;
+};
+
+export { type AffixItemData, type AliHostDetail, type ApiListResponse, type ApiResponse, type BaiduHostDetail, type CloudInfoField, CloudType, type DownloadFileItem, type DownloadProgressData, type DownloadProgressStep, DownloadStatus, type EncodeResult, EncodeStatus, type EncodeWorkerMessage, type EncodeWorkerPercent, type EncodedData, type EncoderResult, type ErrorData, type FilePartItem, type HostDetail, type HostListItem, HostType, type ImgGroupData, type LocalListResponse, type Manifest, type ManifestAffixItem, type ManifestAliType, type ManifestAudioItem, type ManifestAudioMetaInfo, type ManifestBaiduType, type ManifestCoverInfo, type ManifestImgType, type ManifestMediaType, type ManifestMetaType, type ManifestPartsType, type ManifestSourceType, type ManifestTextItem, type ManifestThumbnailInfo, type ManifestThumbnailItem, type ManifestTxtType, type ManifestVideoItem, type ManifestVideoMetaInfo, type MediaGroupAudioItem, type MediaGroupCoverInfo, type MediaGroupData, type MediaGroupQualityAudioItem, type MediaGroupThumbnailInfo, type MediaGroupVideoItem, type MemberInfo, type NetSuccessItem, NetType, type PaginationParams, type PrepareResult, RecordAdaptResolution, type RecordDetail, RecordFileKeep, type RecordFolderConfig, RecordFtype, RecordInsertLast, type RecordListItem, RecordType, RootStatus, type ShareHistoryListItem, type ShareListItem, type ShareUserListItem, type SourceGroupData, type SpaceDetail, type SpaceLevelItem, type SpaceListItem, type SubListItem, type TxtGroupData, type UploadFileItem, type UploadFileSuceessItem, type UploadInputItem, type UploadPrepareData, type UploadPrepareOptions, UploadProcessStep, UploadStatus, type UploadWorkerMessage, type UploadWorkerPercent, type UploadedData, type UpyunSignInfo, type UserGroupListItem, type UserListItem, type WithP, type WithPK, type WorkerError };