web-dc-api 0.0.69 → 0.0.71

package/dist/index.d.ts

@@ -26984,7 +26984,7 @@ interface IKeyValueOperations {
      * @param key 键名
      * @param writerPubkey 写入者的公钥,如果不指定，则获取所有用户写入的该key的最新值
      * @param vaccount 可选的虚拟账户
-     * @returns [值内容, 错误信息]
+     * @returns [值内容, 错误信息] 值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
      */
     get(kvdb: KeyValueDB, key: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
@@ -26996,7 +26996,7 @@ interface IKeyValueOperations {
       * @param direction 查询方向
       * @param offset 结果偏移量
       * @param vaccount 可选的虚拟账户
-      * @returns [值列表生成的json字符串, 错误信息]
+      * @returns [值列表生成的json字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
       */
     getValues(kvdb: KeyValueDB, key: string, options: {
         limit?: number;
@@ -27010,7 +27010,7 @@ interface IKeyValueOperations {
      * @param keys 多个键名，逗号分隔
      * @param writerPubkey 写入者的公钥,可选,默认为主题作者
      * @param vaccount 可选的虚拟账户
-     * @returns [JSON格式值内容, 错误信息]
+     * @returns [JSON格式值内容, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
      */
     getBatch(kvdb: KeyValueDB, keys: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
@@ -27024,7 +27024,7 @@ interface IKeyValueOperations {
      * @param direction 查询方向 (Forward/Backward)
      * @param limit 返回结果数量限制
      * @param vaccount 可选的虚拟账户
-     * @returns [JSON格式查询结果, 错误信息]
+     * @returns [JSON格式查询结果, 错误信息] 每个值的格式: value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
      */
     getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, options: {
         type?: string;
@@ -28076,6 +28076,14 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
     getAuthList(kvdb: KeyValueDB, vaccount?: string): Promise<[ThemeAuthInfo[] | null, ThemeComment[] | null, Error | null]>;
     set(kvdb: KeyValueDB, key: string, value: string, indexs: string, //索引列表,格式为json字符串:[{key:"indexkey1",type:"string",value:"value"},{key:"indexkey2",type:"number", value:12}],这里统一转换格式为key1:value1$$$key2:value2
     vaccount?: string): Promise<[boolean | null, Error | null]>;
+    /**
+     * 获取指定键的元数据
+     * @param kvdb
+     * @param key
+     * @param writerPubkey
+     * @param vaccount
+     * @returns  [值, 错误信息],值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+     */
     get(kvdb: KeyValueDB, key: string, writerPubkey?: string, vaccount?: string): Promise<[string | null, Error | null]>;
     /**
     * 获取指定键的值列表
@@ -28085,7 +28093,7 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
     * @param seekKey 查询起始键,用于分页查询
     * @param offset 结果偏移量
     * @param vaccount 可选的虚拟账户
-    * @returns [值列表生成的json字符串, 错误信息]
+    * @returns [值列表生成的json字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
     */
     getValues(kvdb: KeyValueDB, key: string, options: {
         limit?: number;
@@ -28093,7 +28101,27 @@ declare class KeyValueModule implements DCModule, IKeyValueOperations {
         direction?: Direction;
         offset?: number;
     }, vaccount?: string): Promise<[string | null, Error | null]>;
+    /**
+     * 批量获取指定键的值
+     * @param kvdb KeyValueDB实例
+     * @param keys 逗号分隔的键列表
+     * @param writerPubkey 可选，指定写入者公钥
+     * @param vaccount 可选的虚拟账户
+     * @returns [值的JSON字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','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 direction 查询方向
+     * @param offset 结果偏移量
+     * @param vaccount 可选的虚拟账户
+     * @returns [值的JSON字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+     */
     getWithIndex(kvdb: KeyValueDB, indexKey: string, indexValue: string, options: {
         type?: string;
         limit?: number;

package/lib/dc.ts

@@ -84,7 +84,7 @@ export class DC implements DCContext {
     this.dcChain = new ChainUtil();
     this.dcutil = new DcUtil(this.dcChain);
     // //todo 发布注释 remove
-  //    this.dcutil.defaultPeerId= "12D3KooWEGzh4AcbJrfZMfQb63wncBUpscMEEyiMemSWzEnjVCPf";
+    //  this.dcutil.defaultPeerId= "12D3KooWEGzh4AcbJrfZMfQb63wncBUpscMEEyiMemSWzEnjVCPf";
     // //todo remove end
     this.appInfo = options.appInfo || ({} as APPInfo);
     this.accountInfo = {} as AccountInfo;

package/lib/interfaces/keyvalue-interface.ts

@@ -78,7 +78,7 @@ export interface IKeyValueOperations {
    * @param key 键名
    * @param writerPubkey 写入者的公钥,如果不指定，则获取所有用户写入的该key的最新值
    * @param vaccount 可选的虚拟账户
-   * @returns [值内容, 错误信息]
+   * @returns [值内容, 错误信息] 值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
    */
   get(
     kvdb: KeyValueDB,
@@ -97,7 +97,7 @@ export interface IKeyValueOperations {
    * @param direction 查询方向
    * @param offset 结果偏移量
    * @param vaccount 可选的虚拟账户
-   * @returns [值列表生成的json字符串, 错误信息]
+   * @returns [值列表生成的json字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
    */
   getValues(
     kvdb: KeyValueDB,
@@ -113,7 +113,7 @@ export interface IKeyValueOperations {
    * @param keys 多个键名，逗号分隔
    * @param writerPubkey 写入者的公钥,可选,默认为主题作者
    * @param vaccount 可选的虚拟账户
-   * @returns [JSON格式值内容, 错误信息]
+   * @returns [JSON格式值内容, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
    */
   getBatch(
     kvdb: KeyValueDB,
@@ -133,7 +133,7 @@ export interface IKeyValueOperations {
    * @param direction 查询方向 (Forward/Backward)
    * @param limit 返回结果数量限制
    * @param vaccount 可选的虚拟账户
-   * @returns [JSON格式查询结果, 错误信息]
+   * @returns [JSON格式查询结果, 错误信息] 每个值的格式: value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
    */
   getWithIndex(
     kvdb: KeyValueDB,

package/lib/modules/keyvalue-module.ts

@@ -193,7 +193,14 @@ export class KeyValueModule implements DCModule, IKeyValueOperations {
     }
   }
 
-  
+  /**
+   * 获取指定键的元数据
+   * @param kvdb 
+   * @param key 
+   * @param writerPubkey 
+   * @param vaccount 
+   * @returns  [值, 错误信息],值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+   */
   async get(
     kvdb: KeyValueDB,
     key: string,
@@ -223,7 +230,7 @@ export class KeyValueModule implements DCModule, IKeyValueOperations {
    * @param seekKey 查询起始键,用于分页查询
    * @param offset 结果偏移量
    * @param vaccount 可选的虚拟账户
-   * @returns [值列表生成的json字符串, 错误信息]
+   * @returns [值列表生成的json字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
    */
   async getValues(
     kvdb: KeyValueDB,
@@ -248,12 +255,20 @@ export class KeyValueModule implements DCModule, IKeyValueOperations {
     }
   }
   
+  /**
+   * 批量获取指定键的值
+   * @param kvdb KeyValueDB实例
+   * @param keys 逗号分隔的键列表
+   * @param writerPubkey 可选，指定写入者公钥
+   * @param vaccount 可选的虚拟账户
+   * @returns [值的JSON字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+   */
   async getBatch(
     kvdb: KeyValueDB,
     keys: string,
     writerPubkey: string = "",
     vaccount: string = ""
-  ): Promise<[string | null, Error | null]> {
+  ): Promise<[string | null, Error | null]> { 
     const err = this.assertInitialized();
     if (err) {
       return [null, err];
@@ -268,6 +283,18 @@ export class KeyValueModule implements DCModule, IKeyValueOperations {
     }
   }
 
+  /**
+   * 获取指定索引的值
+   * @param kvdb KeyValueDB实例
+   * @param indexKey 索引键名
+   * @param indexValue 索引值
+   * @param type 索引值类型
+   * @param seekKey 查询起始键,用于分页查询
+   * @param direction 查询方向
+   * @param offset 结果偏移量
+   * @param vaccount 可选的虚拟账户
+   * @returns [值的JSON字符串, 错误信息] 每个值的格式:  value$$$dckv_extra$$${'timestamp':'%d','opuser':'%s'}
+   */ 
    async getWithIndex(
     kvdb: KeyValueDB,
     indexKey:string,

package/lib/proto/dcnet.proto

@@ -915,6 +915,20 @@ message GetThemeAuthListReply{
     bytes authListCid = 2; //获取的授权列表结果集存入ipfs网络中后反馈的cid,客户端再通过 getFile获取，结果集是PublishCommentToThemeRequest的数组 json序列化
 }
 
+
+message GetUserThemeConfigInfoRequest {
+    bytes theme = 1; //主题
+    bytes appId = 2; //应用标志
+    bytes themeAuthor = 3;//发布主题的的作者pubkey
+    bytes UserPubkey = 4;//申请访问配置的用户pubkey
+    bytes Vaccount = 5; //虚拟账号,可选,如果有虚拟账号
+}
+
+message GetUserThemeConfigInfoReply {
+   uint32 flag = 1;//获取结果 0:成功 1:权限不足 2:获取失败
+   bytes authInfo = 2; //获取的配置结果,返回请求用户的授权信息,userpubkey:permission:remark(remark可选,存放应用自定义的任何信息),userpubkey为用户的公钥16进制表示(all为特殊情况)，permission为用户的权限，remark为备注信息,应用自定义
+}
+
 message GetUserCommentsRequest{
     bytes appId = 1; //应用标志
     bytes UserPubkey = 2;//发布评论的用户pubkey
@@ -1483,6 +1497,9 @@ service Service {
     rpc GetThemeComments(GetThemeCommentsRequest) returns (GetThemeCommentsReply){}
 
 
+    //获取用户主题配置的相关信息,包括用户的权限等
+    rpc GetUserThemeConfigInfo(GetUserThemeConfigInfoRequest) returns (GetUserThemeConfigInfoReply) {}
+   
 
      //获取指定已开通对象的权限列表(对GetThemeComments进行包装，增加权限判断)//ok
      rpc GetThemeAuthList(GetThemeAuthListRequest) returns (GetThemeAuthListReply){}