@firmer/mesh 0.0.7 → 0.0.9

package/dist/psi/builtin.d.ts

@@ -3,33 +3,32 @@ import { Versions } from '../types';
 export declare abstract class Builtin {
     /**
      * Doc export the documents.
-     *
-     * Parameters:
-     * name      - mesh.name
-     * formatter - document formatter
-     * formatted - document
-     * Returns:
-     * formatted document
+     * 按格式导出文档.
      */
     doc(name: string, formatter: string, ctx?: Context): Promise<string>;
     /**
-     * Version will get the builtin application version.
+     * Version get the builtin application version.
+     * 内置的应用版本信息.
      */
     version(ctx?: Context): Promise<Versions>;
     /**
-     * Debug set the application log level.
+     * Debug set the application debug features like log.level=126.
+     * 设置应用调试信息，如日志级别log.level.
      */
     debug(features: Record<string, string>, ctx?: Context): Promise<void>;
     /**
-     * Stats will collect health check stats.
+     * Stats collect health check stats.
+     * 收集应用状态信息并输出.
      */
     stats(features: string[], ctx?: Context): Promise<Record<string, string>>;
     /**
-     * Fallback is fallback service
+     * Fallback is fallback service.
+     * GRPC降级服务能力，用于一些状态的降级，用于返回给客户端结构化数据结果.
      */
     fallback(ctx?: Context): Promise<void>;
     /**
      * Dump the application data.
+     * 导出应用相关数据用于分析应用运行情况.
      */
     dump(names: string[], ctx?: Context): Promise<Record<string, string>>;
 }

package/dist/psi/cache.d.ts

@@ -3,42 +3,52 @@ import { CacheBody } from '../types';
 export declare abstract class Cache {
     /**
      * Get the value from cache.
+     * 从缓存中取数据.
      */
     get(key: string, ctx?: Context): Promise<CacheBody>;
     /**
      * Put the value to cache.
+     * 写入数据到缓存.
      */
     put(cell: CacheBody, ctx?: Context): Promise<void>;
     /**
      * Remove the cache value.
+     * 从缓存删除数据.
      */
     remove(key: string, ctx?: Context): Promise<void>;
     /**
      * Incr the cache of expire time.
+     * 缓存计数器增加计数.
      */
     incr(key: string, value: number, ctx?: Context): Promise<number>;
     /**
      * Decr the cache of expire time.
+     * 缓存计数器减少计数.
      */
     decr(key: string, value: number, ctx?: Context): Promise<number>;
     /**
-     * Keys the cache key set.
+     * Keys return the cache key set.
+     * 获取缓存中的KEY集合.
      */
     keys(pattern: string, ctx?: Context): Promise<string[]>;
     /**
-     * HGet get value in hash
+     * HGet get value in hashtable.
+     * 从缓存哈希表中取值.
      */
     hget(key: string, name: string, ctx?: Context): Promise<CacheBody>;
     /**
-     * HSet put value in hash
+     * HSet put value in hashtable.
+     * 从缓存哈希表中写值.
      */
     hset(key: string, cell: CacheBody, ctx?: Context): Promise<void>;
     /**
-     * HDel put value in hash
+     * HDel del value in hashtable.
+     * 从缓存哈希表中删除值.
      */
     hdel(key: string, name: string, ctx?: Context): Promise<void>;
     /**
-     * HKeys get the hash keys
+     * HKeys get the hash keys.
+     * 从缓存哈希表中获取KEY集合.
      */
     hkeys(key: string, ctx?: Context): Promise<string[]>;
 }

package/dist/psi/cipher.d.ts

@@ -1,68 +1,71 @@
 import { Context } from './context';
-import { CipherEntity, CipherHello, CipherKey, CipherKeygen, CipherObject, CipherRegen, CipherSuite, CipherTxEntity, Keys, Page, Paging } from '../types';
+import { CipherEntity, CipherHello, CipherKey, CipherKeygen, CipherObject, CipherRegen, CipherSuite, CipherTxEntity, Keys, Page, Paging, Script } from '../types';
 export declare abstract class CipherEconomy {
     /**
      * Handshake negotiate multiparty cipher keys.
-     *
-     * Parameters:
-     * - hello: hello
-     * Returns:
-     * - string cipher group
+     * 多方密钥协商握手.
      */
     handshake(hello: CipherHello, ctx?: Context): Promise<string>;
     /**
      * Collect cipher objects with group. Asyncable can be invoked by multi times.
-     *
-     * Parameters:
-     * - obj: obj
-     * Returns:
-     * - int 1 for success, 0 for failed
+     * 中心化归集多方密钥加密的密态数据包（胶囊）用于中心化密态计算（重加密/重匿名/全同态等）
      */
     collect(obj: CipherObject, ctx?: Context): Promise<number>;
     /**
-     * Serve will Encrypt or Anonymize
+     * Serve will Encrypt or Anonymize.
+     * 提供加密或匿名服务托管能力，会把对应的密态服务发布为一个服务接口.
      */
     serve(suite: string, ctx?: Context): Promise<string>;
     /**
-     * Deposit cipher object deposit
+     * Deposit cipher object deposit.
+     * 密态数据包（胶囊）归档到密态数据胶囊中心仓库.
      */
     deposit(rco: CipherObject, ctx?: Context): Promise<string>;
     /**
-     * Objects cipher object index
+     * Objects cipher object index.
+     * 分页检索仓库中的密态数据胶囊.
      */
-    objects(index: Paging, ctx?: Context): Promise<Page<CipherObject>>;
+    objects(idx: Paging, ctx?: Context): Promise<Page<CipherObject>>;
     /**
-     * Keys key index
+     * Keys key index.
+     * 分页检索仓库中的密态数据胶囊ID，即Manifest列表检索.
      */
     keys(idx: Paging, ctx?: Context): Promise<Page<Keys>>;
     /**
-     * Invoke
+     * Invoke the script in cipher objects.
+     * 在密态数据包上执行计算脚本，SQL等.
      */
-    invoke(index: Paging, ctx?: Context): Promise<Uint8Array>;
+    invoke(script: Script, ctx?: Context): Promise<Uint8Array>;
 }
 export declare abstract class CipherProvider {
     /**
-     * Suite
+     * Suite cipher suite in local party.
+     * 产生本方密钥协商套件.
      */
     suite(hello: CipherHello, ctx?: Context): Promise<CipherSuite>;
     /**
-     * Keygen
+     * Keygen generate first phase keys.
+     * 协商签发第一阶段密钥，各方只提供自己的公钥或公钥片段.
      */
     keygen(keygen: CipherKeygen, ctx?: Context): Promise<CipherKey>;
     /**
-     * Regen
+     * Regen generate second phase keys.
+     * 协商签发第二阶段密钥，各方只提供自己的公钥或公钥片段.
      */
     regen(keygen: CipherRegen, ctx?: Context): Promise<CipherKey>;
     /**
-     * Encode
+     * Encode the data object, actual encrypt or anonymize.
+     * 数据编码，实际根据不同的密态场景底层可能是加密或匿名化.
      */
     encode(explain: CipherEntity, ctx?: Context): Promise<Uint8Array>;
     /**
-     * Decode
+     * Decode the data object, actual dencrypt or deanonymize.
+     * 数据解码，实际根据不同的密态场景底层可能是解密或去匿名化.
      */
     decode(cipher: CipherEntity, ctx?: Context): Promise<Uint8Array>;
     /**
-     * Recode
+     * Recode the data object, actual rencrypt or reanonymize.
+     * 数据重编码，实际根据不同的密态场景底层可能是重加密或重匿名.
      */
     recode(cipher: CipherTxEntity, ctx?: Context): Promise<Uint8Array>;
 }

package/dist/psi/cluster.d.ts

@@ -2,10 +2,12 @@ import { Context } from './context';
 export declare abstract class Cluster {
     /**
      * Election will election leader of instances.
+     * 集群选主服务.
      */
     election(buff: Uint8Array, ctx?: Context): Promise<Uint8Array>;
     /**
      * IsLeader if same level.
+     * 判断自己是否Leader.
      */
     isLeader(ctx?: Context): Promise<boolean>;
 }

package/dist/psi/commerce.d.ts

@@ -3,18 +3,22 @@ import { CommerceEnviron, CommerceLicense, License } from '../types';
 export declare abstract class Commercialize {
     /**
      * Sign license, only glab has permission to sign.
+     * 签发许可证书.
      */
     sign(lsr: License, ctx?: Context): Promise<CommerceLicense>;
     /**
      * History list the sign license in history, the latest is the first index.
+     * 查询历史签发许可证书列表.
      */
     history(instId: string, ctx?: Context): Promise<CommerceLicense[]>;
     /**
      * Issued mesh node identity.
+     * 签发节点身份证.
      */
     issued(name: string, kind: string, cname: string, ctx?: Context): Promise<CommerceEnviron>;
     /**
      * Dump the node identity.
+     * 导出所有的节点身份证.
      */
     dump(nodeId: string, ctx?: Context): Promise<CommerceEnviron[]>;
 }

package/dist/psi/cryptor.d.ts

@@ -2,22 +2,27 @@ import { Context } from './context';
 export declare abstract class Cryptor {
     /**
      * Encrypt binary to encrypted binary.
+     * 加密二进制数据.
      */
     encrypt(buf: Uint8Array, keys: Record<string, Uint8Array>, ctx?: Context): Promise<Uint8Array>;
     /**
      * Decrypt binary to decrypted binary.
+     * 解密二进制数据.
      */
     decrypt(buf: Uint8Array, keys: Record<string, Uint8Array>, ctx?: Context): Promise<Uint8Array>;
     /**
      * Hash compute the hash value.
+     * 对二进制数据计算摘要.
      */
     hash(buf: Uint8Array, keys: Record<string, Uint8Array>, ctx?: Context): Promise<Uint8Array>;
     /**
      * Sign compute the signature value.
+     * 对二进制数据计算签名.
      */
     sign(buf: Uint8Array, keys: Record<string, Uint8Array>, ctx?: Context): Promise<Uint8Array>;
     /**
      * Verify the signature value.
+     * 对二进制数据摘要验签.
      */
     verify(buf: Uint8Array, keys: Record<string, Uint8Array>, ctx?: Context): Promise<boolean>;
 }

package/dist/psi/daler.d.ts

@@ -2,71 +2,93 @@ import { Context } from './context';
 import { DalerBinlog, DalerCluster, DalerDTSJob, DalerSource, DalerTest, Page, Paging } from '../types';
 export declare abstract class Daler {
     /**
-     * Query
+     * Query execute the script in on datasource.
+     * 在数据源上执行计算脚本.
      */
     query(test: DalerTest, ctx?: Context): Promise<any>;
     /**
-     * SaveSource
+     * SaveSource save datasource.
+     * 保存数据源.
      */
     saveSource(ds: DalerSource, ctx?: Context): Promise<string>;
     /**
-     * IndexSource
+     * IndexSource index datasource.
+     * 分页检索数据源.
      */
     indexSource(idx: Paging, ctx?: Context): Promise<Page<DalerSource>>;
     /**
-     * DescribeSource
+     * DescribeSource describe the datasource.
+     * 获取数据源详情.
      */
     describeSource(id: string, ctx?: Context): Promise<DalerSource>;
     /**
-     * RemoveSource
+     * RemoveSource remove the datasource.
+     * 删除数据源.
      */
     removeSource(id: string, ctx?: Context): Promise<void>;
     /**
-     * SaveCluster
+     * SaveCluster save data cluster.
+     * 保存数据源集群.
      */
     saveCluster(cluster: DalerCluster, ctx?: Context): Promise<string>;
     /**
-     * IndexCluster
+     * IndexCluster index data cluster.
+     * 分页检索数据集群.
      */
     indexCluster(idx: Paging, ctx?: Context): Promise<Page<DalerCluster>>;
     /**
-     * DescribeCluster
+     * DescribeCluster describe data cluster.
+     * 获取数据集群详情.
      */
     describeCluster(id: string, ctx?: Context): Promise<DalerCluster>;
     /**
-     * RemoveCluster
+     * RemoveCluster remove data cluster.
+     * 删除数据集群.
      */
     removeCluster(id: string, ctx?: Context): Promise<void>;
     /**
-     * SaveDTS
+     * DeployCluster deploy data cluster as tcp service.
+     * 把数据集群发布为TCP服务，用于客户端链接数据集群.
+     */
+    deployCluster(id: string, ctx?: Context): Promise<void>;
+    /**
+     * SaveDTS dave data transfer service.
+     * 保存数据同步传输服务.
      */
     saveDTS(dts: DalerDTSJob, ctx?: Context): Promise<string>;
     /**
-     * RunDTS
+     * RunDTS run data transfer service once.
+     * 运行一次数据同步服务.
      */
     runDTS(id: string, ctx?: Context): Promise<void>;
     /**
-     * IndexDTS
+     * IndexDTS index data transfer service.
+     * 分页检索数据同步服务.
      */
     indexDTS(idx: Paging, ctx?: Context): Promise<Page<DalerDTSJob>>;
     /**
-     * RemoveDTS
+     * RemoveDTS remove data transfer service.
+     * 删除数据同步服务.
      */
     removeDTS(id: string, ctx?: Context): Promise<void>;
     /**
-     * ToggleDTS
-     */
-    toggleDTS(id: string, ctx?: Context): Promise<void>;
-    /**
-     * IndexBinlog
+     * IndexBinlog index data cluster binlog.
+     * 分页检索数据集群binlog.
      */
     indexBinlog(idx: Paging, ctx?: Context): Promise<Page<DalerBinlog>>;
     /**
-     * TailBinlog
+     * TailBinlog tail binlog information.
+     * 查看binlog详情.
      */
     tailBinlog(idx: Paging, ctx?: Context): Promise<Page<Record<string, string>>>;
     /**
-     * RedoBinlog
+     * RedoBinlog redo binlog.
+     * 重做binlog，实际是fallback.log.
      */
     redoBinlog(id: string, ctx?: Context): Promise<void>;
+    /**
+     * RemoveBinlog remove binlog.
+     * 删除binlog，实际是fallback.log.
+     */
+    removeBinlog(id: string, ctx?: Context): Promise<void>;
 }

package/dist/psi/datahouse.d.ts

@@ -2,23 +2,28 @@ import { Context } from './context';
 import { Document, Page, Paging } from '../types';
 export declare abstract class DataHouse {
     /**
-     * Writes
+     * Writes bigdata to data house.
+     * 大数据批量写入.
      */
     writes(docs: Document[], ctx?: Context): Promise<void>;
     /**
-     * Write
+     * Write bigdata to data house.
+     * 大数据单文档写入.
      */
     write(doc: Document, ctx?: Context): Promise<void>;
     /**
-     * Read
+     * Read bigdata from data house.
+     * 大数据批量读.
      */
-    read(index: Paging, ctx?: Context): Promise<Page<any>>;
+    read(idx: Paging, ctx?: Context): Promise<Page<any>>;
     /**
-     * Indies
+     * Indies bigdata manifest index.
+     * 读取大数据索引明细.
      */
-    indies(index: Paging, ctx?: Context): Promise<Page<any>>;
+    indies(idx: Paging, ctx?: Context): Promise<Page<any>>;
     /**
-     * Tables
+     * Tables bigdata tables.
+     * 读取大数据存储表信息.
      */
-    tables(index: Paging, ctx?: Context): Promise<Page<any>>;
+    tables(idx: Paging, ctx?: Context): Promise<Page<any>>;
 }

package/dist/psi/devops.d.ts

@@ -2,31 +2,48 @@ import { Context } from './context';
 import { Page, Paging, Replica, Settings } from '../types';
 export declare abstract class Devops {
     /**
-     * Init
+     * Init the system data.
+     * 初始化系统数据.
      */
     init(flags: string, ctx?: Context): Promise<void>;
     /**
-     * Settings
+     * Settings get the system settings.
+     * 获取系统设置信息，这是一个通用接口，可以设置所有的应用设置信息.
      */
     settings(ctx?: Context): Promise<Record<string, Settings>>;
     /**
-     * Setting
+     * Setting write the system settings.
+     * 覆盖系统设置信息，按appset进行覆盖.
      */
     setting(appset: string, setting: Settings, ctx?: Context): Promise<void>;
     /**
-     * IndexReplica
+     * IndexReplica index system data backups.
+     * 分页检索系统备份数据.
      */
     indexReplica(idx: Paging, ctx?: Context): Promise<Page<Replica>>;
     /**
-     * ImportReplica
+     * ImportReplica import system data backup.
+     * 导入系统备份.
      */
     importReplica(raw: Uint8Array, ctx?: Context): Promise<string>;
     /**
-     * Replicate
+     * RemoveReplica remove system data backup.
+     * 删除系统备份.
+     */
+    removeReplica(code: string, ctx?: Context): Promise<void>;
+    /**
+     * ReadReplica read system data backup.
+     * 读取系统备份.
+     */
+    readReplica(code: string, ctx?: Context): Promise<Uint8Array>;
+    /**
+     * Replicate make a system data backup.
+     * 按应用备份系统数据.
      */
     replicate(appset: string, ctx?: Context): Promise<string>;
     /**
-     * Recover
+     * Recover recover backup.
+     * 备份数据恢复.
      */
-    recover(id: string, ctx?: Context): Promise<string>;
+    recover(id: string, ctx?: Context): Promise<void>;
 }

package/dist/psi/endpoint.d.ts

@@ -1,8 +1,8 @@
 import { Context } from './context';
 export declare abstract class Endpoint {
     /**
-     * Fuzzy call with generic param
-     * In multi returns, it's an array.
+     * Fuzzy call with generic param, In multi returns, it's an array.
+     * MPI泛化实现，对于无API声明服务场景提供服务直接调用能力，典型扩展点调用模式.
      */
     fuzzy(buff: Uint8Array, ctx?: Context): Promise<Uint8Array>;
 }

package/dist/psi/firewall.d.ts

@@ -2,19 +2,23 @@ import { Context } from './context';
 import { Firewall, Page, Paging } from '../types';
 export declare abstract class Firewalld {
     /**
-     * Save 保存防火墙规则，支持保存包括黑白名单、限流熔断等逻辑.
+     * Save the firewalld rules.
+     * 保存防火墙规则，支持保存包括黑白名单、限流熔断等逻辑.
      */
     save(wall: Firewall, ctx?: Context): Promise<string>;
     /**
-     * Remove 删除防火墙规则.
+     * Remove the firewalld rule.
+     * 删除防火墙规则.
      */
     remove(code: string, ctx?: Context): Promise<void>;
     /**
-     * Describe 查看防火墙规则.
+     * Describe the firewalld rule.
+     * 查看防火墙规则.
      */
     describe(code: string, ctx?: Context): Promise<Firewall>;
     /**
-     * Index 分页查看防火墙规则.
+     * Index the firewalld rules.
+     * 分页查看防火墙规则.
      */
     index(idx: Paging, ctx?: Context): Promise<Page<Firewall>>;
 }

package/dist/psi/kms.d.ts

@@ -1,40 +1,74 @@
 import { Context } from './context';
-import { CrtRevokeRequest, CrtRotateRequest, Environ, KeyCsr, Keys, Page, Paging } from '../types';
+import { CrtRevokeRequest, CrtRotateRequest, Environ, KeyCsr, Keys, Page, Paging, SecretCsr, SecretKey } from '../types';
 export declare abstract class KMS {
     /**
      * Reset will override the keystore environ.
+     * 重置MESH网络中当前节点的环境信息.
      */
     reset(env: Environ, ctx?: Context): Promise<void>;
     /**
      * Environ will return the keystore environ.
+     * 获取MESH网络中当前节点的环境信息.
      */
     environ(ctx?: Context): Promise<Environ>;
     /**
      * Issue will apply the certification.
+     * 签发证书，签发根证书和通信证书均使用该接口.
      */
     issue(csr: KeyCsr, ctx?: Context): Promise<Keys>;
+    /**
+     * Describe will return the keys by code.
+     * 检索KMS中存储的证书详情.
+     */
+    describe(id: string, ctx?: Context): Promise<Keys>;
     /**
      * Index will return the keystore environ.
+     * 分页检索KMS中存储的所有证书列表.
      */
     index(idx: Paging, ctx?: Context): Promise<Page<Keys>>;
     /**
-     * Revoke will revoke the keys
+     * Revoke will revoke the keys.
+     * 撤销证书.
      */
     revoke(crr: CrtRevokeRequest, ctx?: Context): Promise<void>;
     /**
-     * Rotate will rotate the keys
+     * Rotate will rotate the keys.
+     * 证书轮换.
      */
     rotate(crr: CrtRotateRequest, ctx?: Context): Promise<void>;
     /**
-     * Remove
+     * Remove the keys.
+     * 证书删除.
      */
     remove(id: string, ctx?: Context): Promise<void>;
     /**
-     * Append
+     * Append the keys.
+     * 上传证书.
      */
     append(car: Keys, ctx?: Context): Promise<void>;
     /**
-     * Explain
+     * Explain the keys.
+     * 证书解释.
      */
     explain(algo: string, keys: string, ctx?: Context): Promise<string>;
+    /**
+     * IndexSecret the crypt keys.
+     * 分页检索密钥列表.
+     */
+    indexSecret(idx: Paging, ctx?: Context): Promise<Page<SecretKey>>;
+    /**
+     * RemoveSecret the crypt keys.
+     * 删除密钥.
+     */
+    removeSecret(id: string, ctx?: Context): Promise<void>;
+    /**
+     * DescribeSecret the crypt keys.
+     * 删除密钥.
+     */
+    describeSecret(id: string, ctx?: Context): Promise<SecretKey>;
+    /**
+     * GenerateSecret the crypt keys.
+     * 生成密钥.
+     */
+    generateSecret(csr: SecretCsr, ctx?: Context): Promise<string>;
 }

package/dist/psi/kv.d.ts

@@ -3,22 +3,27 @@ import { Body, Entry, Page, Paging } from '../types';
 export declare abstract class KV {
     /**
      * Get the value from kv store.
+     * 从KV存储读值.
      */
     get(key: string, ctx?: Context): Promise<Body>;
     /**
      * Put the value to kv store.
+     * 从KV写入值.
      */
     put(key: string, value: Body, ctx?: Context): Promise<void>;
     /**
      * Remove the kv store.
+     * 从KV删除值.
      */
     remove(key: string, ctx?: Context): Promise<void>;
     /**
      * Keys with the pattern of kv store.
+     * 检索KV存储中的所有KEY.
      */
     keys(pattern: string, ctx?: Context): Promise<string[]>;
     /**
      * Index the kv for webui
+     * 分页检索KV存储内容.
      */
-    index(index: Paging, ctx?: Context): Promise<Page<Entry>>;
+    index(idx: Paging, ctx?: Context): Promise<Page<Entry>>;
 }

package/dist/psi/licenser.d.ts

@@ -3,22 +3,27 @@ import { License } from '../types';
 export declare abstract class Licenser {
     /**
      * Imports the licenses.
+     * 导入许可证书.
      */
     imports(license: string, ctx?: Context): Promise<void>;
     /**
      * Exports the licenses.
+     * 导出许可证书.
      */
     exports(ctx?: Context): Promise<string>;
     /**
      * Explain the license.
+     * 解释许可证书.
      */
     explain(ctx?: Context): Promise<License>;
     /**
      * Verify the license.
+     * 验证许可证书.
      */
     verify(ctx?: Context): Promise<number>;
     /**
      * Features is license features.
+     * 查询系统提供的证书签发因子.
      */
     features(ctx?: Context): Promise<Record<string, string>>;
 }

package/dist/psi/locker.d.ts

@@ -2,18 +2,22 @@ import { Context } from './context';
 export declare abstract class Locker {
     /**
      * Lock create write lock.
+     * 按ID加写锁.
      */
     lock(rid: string, timeout: number, ctx?: Context): Promise<boolean>;
     /**
      * Unlock release write lock.
+     * 按ID解写锁.
      */
     unlock(rid: string, ctx?: Context): Promise<void>;
     /**
      * ReadLock create read lock.
+     * 按ID加读锁.
      */
     readLock(rid: string, timeout: number, ctx?: Context): Promise<boolean>;
     /**
      * ReadUnlock release read lock.
+     * 按ID解读锁.
      */
     readUnlock(rid: string, ctx?: Context): Promise<void>;
 }