web-dc-api 0.1.5 → 0.1.7

package/lib/interfaces/database-interface.ts

@@ -1,169 +0,0 @@
-import ThreadID from "@textile/threads-id";
-import { ICollectionConfig, IDBInfo } from "../implements/threaddb/core/core";
-
-/**
- * 数据库操作接口,这个数据库主要由threadid确保唯一,servicekey,readkey多重加密来确保数据安全,其中readkey永远不离开用户,servicekey会在DC云端的TEE环境中参与数据备份
- * 提供基于ThreadDB的分布式数据库管理功能
- */
-export interface IDatabaseOperations {
-
-  
-  /**
-   * 初始化数据库管理器
-   * 创建数据库操作所需的组件和服务
-   * @returns 错误信息
-   */
-  initDBManager(): Promise<Error| null>;
-  
-  /**
-   * 创建新数据库
-   * @param name 数据库名称
-   * @param b32Rk base32编码的读取密钥
-   * @param b32Sk base32编码的服务密钥
-   * @param jsonCollections 集合配置数组，定义数据库中的集合结构
-   * @returns 创建的线程ID和错误信息
-   */
-  newDB(
-    name: string,
-    b32Rk: string,
-    b32Sk: string,
-    jsonCollections: ICollectionConfig[]
-  ): Promise<[string| null, Error | null]>;
-  
-  /**
-   * 从分布式网络同步数据库
-   * @param threadid 线程ID
-   * @param dbname 数据库名称  
-   * @param dbAddr 数据库地址
-   * @param b32Rk base32编码的读取密钥
-   * @param b32Sk base32编码的服务密钥  
-   * @param block 是否阻塞等待同步完成
-   * @param collectionInfos 集合配置数组，定义数据库中的集合结构
-   * @returns 错误信息或null表示成功
-   */
-  syncDbFromDC(
-    threadid: string,  
-    dbname: string,  
-    dbAddr: string,  
-    b32Rk: string,  
-    b32Sk: string,  
-    block: boolean,  
-    collectionInfos: ICollectionConfig[]  
-  ): Promise<Error| null>;
-  
-  /**
-   * 刷新数据库，从分布式网络获取最新数据
-   * @param threadid 数据库线程ID
-   * @returns 错误信息或null表示成功
-   */
-  refreshDBFromDC(threadid: string): Promise<Error | null>;
-  
-  /**
-   * 同步数据库到分布式网络
-   * @param tId 线程ID
-   * @returns 错误信息或null表示成功
-   */
-  syncDBToDC(tId: string): Promise<Error | null>;
-  
-
-/**
- * 获取数据库信息
- * @param id threaddbID
- * @returns 数据库信息字符串,或错误
- */ 
- getDBInfo(id: string): Promise<[IDBInfo|null, Error|null]>  ;
-
-
-  /**
-   * 升级集合结构
-   * @param threadId 线程ID
-   * @param collections 集合配置列表
-   * @returns 错误信息或null
-   */
-  upgradeCollections(threadId: string, collections: ICollectionConfig[]): Promise<Error | null> ;
-
-  /**
-   * 关闭数据库管理器
-   * @throws 关闭失败时抛出错误
-   */
-  close(): Promise<Error | null>;
-  
-  /**
-   * 在集合中创建新对象实例
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param jsonInstance JSON字符串表示的实例对象
-   * @returns 创建的实例ID,或错误
-   */
-  create(threadId: string, collectionName: string, jsonInstance: string): Promise<[string| null, Error | null]>;
-  
-  /**
-   * 通过ID删除实例
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param instanceID 要删除的实例ID
-   * @throws 删除失败时抛出错误
-   */
-  delete(threadId: string, collectionName: string, instanceID: string): Promise<Error | null>;
-  
-  /**
-   * 更新已存在的实例
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param instance JSON字符串表示的实例对象
-   * @throws 更新失败时抛出错误
-   */
-  save(threadId: string, collectionName: string, instance: string): Promise<Error | null>;
-  
-  /**
-   * 批量删除多个实例
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param instanceIDs 逗号分隔或JSON数组表示的实例ID列表
-   * @throws 删除失败时抛出错误
-   */
-  deleteMany(threadId: string, collectionName: string, instanceIDs: string): Promise<Error | null>;
-  
-  /**
-   * 检查指定实例是否存在
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param instanceID 要检查的实例ID
-   * @returns 布尔值表示实例是否存在
-   */
-  has(threadId: string, collectionName: string, instanceID: string): Promise<boolean>;
-  
-  /**
-   * 根据查询条件查找实例
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param queryString JSON字符串表示的查询条件,
-   * 格式举例:(condition表示and条件组合, ors表示或条件组合, sort表示排序, seek表示分页)
-   * 格式1: `{"condition":"age=80 and name='John'"}`,"sort":{"fieldPath":"age","desc":true}}`
-   * 格式2: `{"ors":[{"condition":"age = 21 and name = 'foo'"}]}`
-   * 格式3: `{"condition":"age > 21 ","ors":[{"condition":"age = 21 and name = 'foo'"}],"sort":{"fieldPath":"age","desc":true},skip:10,"seek":"01fyc691gh671nf0s8qpt0ych8"}`
-   * @returns JSON字符串表示的查询结果
-   * @throws 查询失败时抛出错误
-   */
-  find(threadId: string, collectionName: string, queryString?: string): Promise<[string | null, Error | null]>;
-  
-  /**
-   * 通过ID查找实例
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param instanceID 实例ID
-   * @returns JSON字符串表示的实例
-   * @throws 查询失败时抛出错误
-   */
-  findByID(threadId: string, collectionName: string, instanceID: string): Promise<[string | null, Error | null]>;
-  
-  /**
-   * 获取在指定时间后被修改的实例ID列表
-   * @param threadId 线程ID
-   * @param collectionName 集合名称
-   * @param time 时间戳（毫秒）
-   * @returns JSON字符串表示的实例ID列表
-   * @throws 查询失败时抛出错误
-   */
-  modifiedSince(threadId: string, collectionName: string, time: number): Promise<[string | null, Error | null]>;
-}

package/lib/interfaces/file-interface.ts

@@ -1,120 +0,0 @@
-import { SeekableFileStream } from "../implements/file/seekableFileStream";
-
-/**
- * 文件操作接口
- * 提供文件上传、下载、缓存等功能
- */
-export interface IFileOperations {
-  /**
-   * 获取可寻址文件流
-   * @param ipfsPath IPFS路径或CID
-   * @param decryptKey 解密密钥,base32的symmetric key
-   * @returns 可寻址文件流实例
-   */
-  getSeekableFileStream(
-    ipfsPath: string,
-    decryptKey: string
-  ): Promise<SeekableFileStream>;
-
-  /**
-   * 清理文件缓存
-   * @param pathname 可选的特定路径，不提供则清除所有缓存
-   */
-  clearFileCache(pathname?: string): void;
-
-  /**
-   * 获取缓存统计信息
-   * @returns 包含缓存总数和键列表的统计对象
-   */
-  getCacheStats(): [{ total: number, keys: string[] } | null, Error | null];
-
-  /**
-   * 获取文件内容
-   * @param cid 文件的内容标识符
-   * @param decryptKey 解密密钥
-   * @returns 文件的字节数组，失败则返回undefined
-   */
-  getFile(cid: string, decryptKey: string): Promise<[Uint8Array | null, Error | null]>;
-
-  /**
-   * 创建文件可读流
-   * @param cid 文件的内容标识符
-   * @param decryptKey 解密密钥
-   * @returns 可读流对象，失败则返回null
-   */
-  createFileStream(
-    cid: string,
-    decryptKey: string
-  ): Promise<ReadableStream<Uint8Array> | null>;
-
-  /**
-   * 添加文件到存储
-   * @param file 要上传的文件对象
-   * @param enkey 加密密钥
-   * @param onUpdateTransmitSize 传输进度回调函数
-   * @returns 添加结果
-   */
-  addFile(
-    file: File,
-    enkey: string,
-    onUpdateTransmitSize: (status: number, size: number) => void
-  ): Promise<[string | null, Error | null]>;
-
-  /**
-   * 添加文件夹到存储
-   * @param files 要上传的文件夹下的文件列表
-   * @param enkey 加密密钥,base32的symmetric key
-   * @param onUpdateTransmitCount 传输进度回调函数
-   * @returns 添加结果
-   */
-  addFolder(
-    files: FileList,
-    enkey: string,
-    onUpdateTransmitCount: (
-      status: number,
-      total: number,
-      process: number
-    ) => void
-  ): Promise<[string | null, Error | null]>;
-
-
-
-
-/**
- * 获取文件夹下的所有文件,包括内容（支持多级目录递归）
- * @param cid 根目录的CID
- * @param decryptKey 解密密钥
- * @param recursive 是否递归获取子目录，默认false（保持向后兼容）
- * @returns 文件列表：[{Name:文件或目录名，Type：0-文件 1-目录，Size：大小，Hash：文件或目录cid，Path：完整路径}]
- */
-getFolderFileListWithContent(
-  cid: string, 
-  decryptKey: string, 
-  recursive: boolean
-): Promise<[Array<{Name: string; Type: number; Size: number; Hash: string; Path: string, Content?: Uint8Array}> | null, Error | null]> ;
-
-/**
- * 获取文件夹下的文件列表（支持多级目录递归）
- * @param cid 根目录的CID
- * @param flag 是否需要连接节点
- * @param recursive 是否递归获取子目录，默认false（保持向后兼容）
- * @returns 返回JSON格式的文件列表：[{Name:文件或目录名，Type：0-文件 1-目录，Size：大小，Hash：文件或目录cid，Path：完整路径}]
- */
- getFolderFileList(
-  cid: string, 
-  flag: number,
-  recursive: boolean
-): Promise<[Array<{Name: string; Type: number; Size: number; Hash: string; Path: string, Content?: Uint8Array}> | null, Error | null]> ;
-  /**
-   * 创建自定义文件列表
-   * @param filesMap 文件列表，可以是Map或Record对象
-   * @param rootFolderName 根文件夹名称
-   * @returns 自定义文件列表对象
-   */
-  createCustomFileList(
-    filesMap:
-      | Map<string, string | Uint8Array | ArrayBuffer>
-      | Record<string, string | Uint8Array | ArrayBuffer>,
-    rootFolderName: string
-  ): [FileList | null, Error | null];
-}

package/lib/interfaces/index.ts

@@ -1,10 +0,0 @@
-export type {IAuthOperations} from './auth-interface';
-export type {IClientOperations} from './client-interface';
-export type {IDatabaseOperations} from './database-interface';
-export type {IFileOperations} from './file-interface';
-export type {IMessageOperations} from './message-interface';
-export type {IKeyValueOperations} from './keyvalue-interface';
-export type {ICommentOperations} from './comment-interface';
-export type {ICacheOperations} from './cache-interface';
-export type {DCContext} from  './DCContext';
-export type {IUtilOperations} from './util-interface';

package/lib/interfaces/keyvalue-interface.ts

@@ -1,156 +0,0 @@
-import { Direction } from "../common/define";
-import { ThemePermission } from "../common/constants";
-import { ThemeAuthInfo, ThemeComment } from "../common/types/types";
-import { KeyValueStoreType, KeyValueDB } from "../implements/keyvalue/manager";
-
-/**
- * 键值存储操作接口
- * 提供分布式键值存储的创建、权限管理和数据操作功能
- */
-export interface IKeyValueOperations {
-  /**
-   * 创建key-value存储库
-   * @param appId 应用ID
-   * @param theme 库主题名称
-   * @param space 分配的存储空间大小（字节）
-   * @param type 存储主题类型 1:鉴权主题(读写都需要鉴权) 2:公共主题(默认所有用户可读,写需要鉴权)
-   * @returns 创建的keyvalue数据库实例和可能的错误信息
-   */
-  createStore(appId: string,theme: string, space: number, type: KeyValueStoreType): Promise<[KeyValueDB|null, Error | null]>;
-
-  /**
-   * 获取指定主题的keyvalue数据库
-   * @param appId 应用ID
-   * @param theme 主题名称
-   * @param themeAuthor 数据库创建者的公钥
-   * @returns keyvalue数据库实例
-   */
-  getStore(appId: string, theme: string, themeAuthor: string): Promise<[KeyValueDB|null, Error | null]> ;
-
-  /**
-   * 配置主题的授权信息
-   * @param kvdb keyvalue数据库实例
-   * @param authPubkey 被授权者的公钥
-   * @param permission 权限级别
-   * @param remark 备注信息
-   * @param vaccount 可选的虚拟账户
-   * @returns [授权状态码, 错误信息]
-   */
-  configAuth(
-    kvdb: KeyValueDB,
-    authPubkey: string,
-    permission: ThemePermission,
-    remark: string,
-    vaccount?: string
-  ): Promise<[number | null, Error | null]>;
-
-  /**
-   * 获取主题的授权列表
-   * @param kvdb keyvalue数据库实例
-   * @param vaccount 可选的虚拟账户
-   * @returns [授权列表,含签名的原始授权列表, 错误信息]
-   */
-  getAuthList(
-    kvdb: KeyValueDB,
-    vaccount?: string
-  ): Promise<[ThemeAuthInfo[]|null,ThemeComment[] | null, Error | null]>;
-
-  /**
-   * 设置键值对，支持索引功能
-   * @param kvdb: KeyValueDB,
-   * @param key 键名
-   * @param value 值内容
-   * @param indexs 索引列表，格式为json字符串:[{key:"indexkey1",type:"string",value:"value"},{key:"indexkey2",type:"number", value:12}],设置索引后,后续查询可以通过索引快速定位
-   * @param vaccount 可选的虚拟账户
-   * @returns [是否设置成功, 时间戳, 错误信息]
-   */
-  set(
-    kvdb: KeyValueDB,
-    key: string,
-    value: string,
-    indexs: string,
-    vaccount?: string
-  ): Promise<[boolean | null, number | null, Error | null]>;
-
-
-/**
-   * 获取当前用户设置的指定键的元数据
-   * @param kvdb 
-   * @param key 
-   * @param vaccount 
-   * @returns  [值, 错误信息],值的格式:  value$$$dckv_extra$$${'dc_timestamp':'%d','dc_opuser':'%s'}
-   */
-   getValueSetByCurrentUser(kvdb: KeyValueDB, key: string,vaccount?: string): Promise<[string | null, Error | null]> ;
- 
-
-  /**
-   * 获取指定键的值
-   * @param kvdb: KeyValueDB,
-   * @param key 键名
-   * @param writerPubkey 写入者的公钥,如果不指定，则获取所有用户写入的该key的最新值
-   * @param vaccount 可选的虚拟账户
-   * @returns [值内容, 错误信息] 值的格式:  value$$$dckv_extra$$${'dc_timestamp':'%d','dc_opuser':'%s'}
-   */
-  get(
-    kvdb: KeyValueDB,
-    key: string,
-    writerPubkey?: string,
-    vaccount?: string
-  ): Promise<[string | null, Error | null]>;
-
-
- /**
-   * 获取指定键的值列表,按key的字典序排序
-   * @param kvdb: KeyValueDB,
-   * @param key 键名
-   * @param limit 返回结果数量限制
-   * @param seekKey 查询起始键,用于分页查询
-   * @param direction 查询方向
-   * @param offset 结果偏移量
-   * @param vaccount 可选的虚拟账户
-   * @returns [值列表数组生成的json字符串, 错误信息] 数组的每个元素的格式:  key:value$$$dckv_extra$$${'dc_timestamp':'%d','dc_opuser':'%s'}
-   */
-  getValues(
-    kvdb: KeyValueDB,
-    key: string,
-    options: { limit?: number; seekKey?: string; direction?: Direction; offset?: number } ,
-    vaccount?: string
-  ): Promise<[string | null, Error | null]>;
-
-
-  /**
-   * 批量获取多个键的值
-   * @param kvdb: KeyValueDB,
-   * @param keys 多个键名，逗号分隔
-   * @param writerPubkey 写入者的公钥,可选,默认为主题作者
-   * @param vaccount 可选的虚拟账户
-   * @returns [值列表数组生成的json字符串, 错误信息] 数组的每个元素的格式:  key:value$$$dckv_extra$$${'dc_timestamp':'%d','dc_opuser':'%s'}
-   */
-  getBatch(
-    kvdb: KeyValueDB,
-    keys: string,
-    writerPubkey?: string,
-    vaccount?: string
-  ): Promise<[string | null, Error | null]>;
-
-  /**
-   * 通过索引查询键值对
-   * @param kvdb: KeyValueDB,
-   * @param indexKey 索引键名
-   * @param indexValue 索引值
-   * @param type 索引值类型
-   * @param seekKey 查询起始键
-   * @param offset 结果偏移量
-   * @param direction 查询方向 (Forward/Backward)
-   * @param limit 返回结果数量限制
-   * @param vaccount 可选的虚拟账户
-   * @returns [值列表数组生成的json字符串, 错误信息] 数组的每个元素的格式:  key:value$$$dckv_extra$$${'dc_timestamp':'%d','dc_opuser':'%s'}
-   */
-  getWithIndex(
-    kvdb: KeyValueDB,
-    indexKey: string,
-    indexValue: string,
-    options: { type?:string; limit?: number; seekKey?: string; direction?: Direction; offset?: number } ,
-    vaccount?: string
-  ): Promise<[string | null, Error | null]>;
-}

package/lib/interfaces/message-interface.ts

@@ -1,22 +0,0 @@
-import { dcnet } from "../../lib/proto/dcnet_proto";
-
-/**
- * 消息操作接口
- * 提供用户消息盒子的收发功能
- */
-export interface IMessageOperations {
-  /**
-   * 发送消息到用户消息盒子
-   * @param receiver 接收者的公钥或账号标识
-   * @param msg 消息内容
-   * @returns 发送结果，包含消息ID和时间戳
-   */
-  sendMsgToUserBox(receiver: string, msg: string): Promise<[number | null, Error | null]>;
-
-  /**
-   * 从用户消息盒子获取消息
-   * @param limit 可选，限制返回消息的最大数量，默认由系统决定
-   * @returns 消息列表，按时间顺序排列
-   */
-  getMsgFromUserBox(limit?: number): Promise<[dcnet.pb.IUserMsg[] | null, Error | null]>;
-}

package/lib/interfaces/util-interface.ts

@@ -1,31 +0,0 @@
-import { IAppInfo } from '../../lib/common/types/types';
-import { SymmetricKey, Key as ThreadKey } from '../implements/threaddb/common/key';
-import { IFileOperations } from './file-interface';
-
-
-export interface IUtilOperations {
-    createSymmetricKey(): SymmetricKey;
-    createThreadKey(): ThreadKey;
-    /**
-     * 设置应用信息,发布应用时调用  
-     * @param appId string 应用ID
-     * @param fid 
-     * @param domain 
-     * @param owner 
-     * @param rewarder 
-     */
-    setAppInfo(appId: string,fid:string,domain:string,owner?: string,rewarder?: string): Promise<[boolean|null, Error | null]>;
-    getAppInfo(appId: string): Promise<[IAppInfo|null, Error | null]>;
-
-    /**
-     * 处理IPFS请求
-     * @param data 请求数据
-     * @param port 消息端口
-     * @param fileOps 文件操作对象
-     */
-     handleIpfsRequest(
-      data: { id: string, pathname: string, range?: string }, 
-      port: MessagePort, 
-      fileOps?: IFileOperations
-    ): Promise<void>
-}