npm - @firmer/mesh - Versions diffs - 0.0.6 → 0.0.8 - Mend

@firmer/mesh 0.0.6 → 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

package/dist/cause/errors.d.ts +5 -1
package/dist/codec/json.d.ts +2 -2
package/dist/http/consumer.d.ts +2 -1
package/dist/index.d.ts +13 -5
package/dist/mesh.js +9246 -7004
package/dist/mesh.umd.cjs +8 -8
package/dist/mpc/hook.d.ts +11 -11
package/dist/mpc/reference.d.ts +1 -0
package/dist/mpc/urn.d.ts +3 -1
package/dist/psi/builtin.d.ts +10 -11
package/dist/psi/cache.d.ts +15 -5
package/dist/psi/cipher.d.ts +27 -24
package/dist/psi/cluster.d.ts +2 -0
package/dist/psi/commerce.d.ts +4 -0
package/dist/psi/cryptor.d.ts +5 -0
package/dist/psi/daler.d.ts +42 -20
package/dist/psi/datahouse.d.ts +13 -8
package/dist/psi/devops.d.ts +49 -0
package/dist/psi/endpoint.d.ts +2 -2
package/dist/psi/firewall.d.ts +24 -0
package/dist/psi/index.d.ts +3 -1
package/dist/psi/kms.d.ts +40 -6
package/dist/psi/kv.d.ts +6 -1
package/dist/psi/licenser.d.ts +5 -0
package/dist/psi/locker.d.ts +4 -0
package/dist/psi/network.d.ts +20 -5
package/dist/psi/pipeline.d.ts +7 -9
package/dist/psi/publisher.d.ts +4 -2
package/dist/psi/registry.d.ts +14 -5
package/dist/psi/subscriber.d.ts +1 -3
package/dist/psi/tokenizer.d.ts +17 -8
package/dist/psi/vm.d.ts +34 -0
package/dist/tool/addrs.d.ts +2 -0
package/dist/tool/tool.d.ts +3 -2
package/dist/types/builtin.d.ts +28 -0
package/dist/types/cipher.d.ts +27 -0
package/dist/types/daler.d.ts +97 -8
package/dist/types/devops.d.ts +114 -0
package/dist/types/document.d.ts +11 -0
package/dist/types/entity.d.ts +15 -0
package/dist/types/environ.d.ts +19 -0
package/dist/types/event.d.ts +16 -0
package/dist/types/firewall.d.ts +127 -0
package/dist/types/index.d.ts +3 -0
package/dist/types/keys.d.ts +92 -0
package/dist/types/license.d.ts +26 -0
package/dist/types/oauth2.d.ts +64 -10
package/dist/types/payload.d.ts +6 -0
package/dist/types/principal.d.ts +8 -0
package/dist/types/registration.d.ts +97 -0
package/dist/types/route.d.ts +52 -0
package/dist/types/savepoint.d.ts +10 -0
package/dist/types/schema.d.ts +206 -0
package/dist/types/script.d.ts +56 -9
package/dist/types/status.d.ts +3 -0
package/dist/types/transport.d.ts +18 -0
package/dist/types/version.d.ts +2 -0
package/dist/types/workflow.d.ts +43 -0
package/package.json +9 -9
package/dist/psi/evaluator.d.ts +0 -20

package/dist/psi/kv.d.ts CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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>;
 }

package/dist/psi/network.d.ts CHANGED Viewed

@@ -3,47 +3,62 @@ import { Environ, Page, Paging, Route, Versions } from '../types';
 export declare abstract class Network {
     /**
      * Environ Get the meth network environment fixed information.
+     * 获取MESH网络中的当前节点环境信息.
      */
     environ(ctx?: Context): Promise<Environ>;
     /**
      * Accessible Check the mesh network is accessible.
+     * 组网信息网络可达性检测.
      */
     accessible(route: Route, ctx?: Context): Promise<boolean>;
     /**
      * Refresh the routes to mesh network.
+     * 更新组网信息，若状态为删除态会直接物理删除.
      */
     refresh(routes: Route[], ctx?: Context): Promise<void>;
     /**
      * Route the network edge route.
+     * 获取当前节点到目标节点到组网信息.
      */
     route(mdc: string, ctx?: Context): Promise<Route>;
     /**
      * Routes the network edge routes.
+     * 获取所有的组网信息.
      */
     routes(ctx?: Context): Promise<Route[]>;
     /**
-     * Disable the network
+     * Disable the network.
+     * 禁用当前节点到目标节点的所有网络通信.
      */
     disable(mdc: string, ctx?: Context): Promise<void>;
     /**
      * Enable the network
+     * 启用当前节点到目标节点的所有网络通信.
      */
     enable(mdc: string, ctx?: Context): Promise<void>;
     /**
-     * Index the network edges
+     * Index the network routes.
+     * 分页检索组网列表.
      */
     index(index: Paging, ctx?: Context): Promise<Page<Route>>;
     /**
-     * Version
-     * Network environment version.
+     * Version Network environment version.
+     * 获取对应节点的版本信息.
      */
     version(mdc: string, ctx?: Context): Promise<Versions>;
     /**
      * Exports the weave certificate.
+     * 导出当前节点到目标节点网络的证书信息.
      */
     exports(mdc: string, ctx?: Context): Promise<string>;
     /**
      * Imports the weave certificate.
+     * 导入当前节点到目标节点网络的证书信息.
      */
-    imports(crt: string, ctx?: Context): Promise<void>;
+    imports(mdc: string, crt: string, ctx?: Context): Promise<void>;
+    /**
+     * Remove the network route.
+     * 删除组网信息.
+     */
+    remove(sid: string, did: string, ctx?: Context): Promise<void>;
 }

package/dist/psi/pipeline.d.ts CHANGED Viewed

@@ -1,28 +1,26 @@
 import { Context } from './context';
 export declare abstract class Pipeline {
     /**
-     * Peek
-     * Retrieves, but does not remove, the head of this queue,
-     * or returns None if this queue is empty.
+     * Peek Retrieves, but does not remove, the head of this queue, or returns None if this queue is empty.
+     * 从管道中根据主题取队头值.
      */
     peek(topic: string, ctx?: Context): Promise<Uint8Array>;
     /**
-     * Pop
-     * Retrieves and removes the head of this queue,
-     * or returns None if this queue is empty.
+     * Pop Retrieves and removes the head of this queue, or returns None if this queue is empty.
+     * 从管道中根据主题取队头值.
      */
     pop(timeout: number, topic: string, ctx?: Context): Promise<Uint8Array>;
     /**
-     * Push
-     * Inserts the specified element into this queue if it is possible to do
-     * so immediately without violating capacity restrictions.
+     * Push Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.
      * When using a capacity-restricted queue, this method is generally
      * preferable to add, which can fail to insert an element only
      * by throwing an exception.
+     * 从管道中根据主题写队尾值
      */
     push(payload: Uint8Array, metadata: Record<string, string>, topic: string, ctx?: Context): Promise<void>;
     /**
      * Release the channel session.
+     * 释放主题对应管道资源.
      */
     release(timeout: number, topic: string, ctx?: Context): Promise<void>;
 }

package/dist/psi/publisher.d.ts CHANGED Viewed

@@ -2,11 +2,13 @@ import { Context } from './context';
 import { Event } from '../types';
 export declare abstract class Publisher {
     /**
-     * Publish
+     * Publish the envent in queue.
+     * 发布事件到消息队列.
      */
     publish(events: Event[], ctx?: Context): Promise<string[]>;
     /**
-     * Broadcast
+     * Broadcast the envent in queue.
+     * 广播事件到消息队列，会给所有数联网上的组网节点广播.
      */
     broadcast(events: Event[], ctx?: Context): Promise<string[]>;
 }

package/dist/psi/registry.d.ts CHANGED Viewed

@@ -1,20 +1,29 @@
 import { Context } from './context';
-import { Registration } from '../types';
+import { Appdata, Registration } from '../types';
 export declare abstract class Registry {
     /**
-     * Register
+     * Register the metadata into registry.
+     * 元数据注册.
      */
     register(registration: Registration<any>, ctx?: Context): Promise<void>;
     /**
-     * Registers
+     * Registers the batch metadata into registry.
+     * 元数据批量注册.
      */
     registers(registrations: Registration<any>[], ctx?: Context): Promise<void>;
     /**
-     * Unregister
+     * Unregister the metadata from registry.
+     * 元数据解注册.
      */
     unregister(registration: Registration<any>, ctx?: Context): Promise<void>;
     /**
-     * Export
+     * Export the metadata from registry.
+     * 元数据导出.
      */
     export(kind: string, ctx?: Context): Promise<Registration<any>[]>;
+    /**
+     * Appset export the appset from registry.
+     * 应用元数据导出.
+     */
+    appset(kind: string, ctx?: Context): Promise<Appdata[]>;
 }

package/dist/psi/subscriber.d.ts CHANGED Viewed

@@ -3,9 +3,7 @@ import { Event } from '../types';
 export declare abstract class Subscriber {
     /**
      * Subscribe the event with {@link tech.firmer.mesh.macro.Bindings} or {@link tech.firmer.mesh.macro.Binding}
-     *
-     * Parameters:
-     * event - uniform event payload.
+     * 消息订阅服务接口，主要是实现该接口订阅对应的topic-code.
      */
     subscribe(event: Event, ctx?: Context): Promise<void>;
 }

package/dist/psi/tokenizer.d.ts CHANGED Viewed

@@ -1,30 +1,35 @@
 import { Context } from './context';
-import { AccessCode, AccessGrant, AccessToken, Captcha, Credential, Session } from '../types';
+import { AccessCode, AccessGrant, AccessToken, Captcha, Credential, GrantCode, Session } from '../types';
 export declare abstract class Tokenizer {
     /**
      * Captcha apply a graphics captcha.
+     * 获取验证码.
      */
     captcha(kind: string, features: Record<string, string>, ctx?: Context): Promise<Captcha>;
     /**
      * Matches a graphics captcha value.
+     * 验证码校验.
      */
     matches(mno: string, value: string, ctx?: Context): Promise<boolean>;
     /**
-     * Apply
+     * Apply trust authenticate token.
+     * 申请信任登录令牌.
      */
     apply(kind: string, duration: number, ctx?: Context): Promise<string>;
     /**
-     * Verify
+     * Verify the trust token.
+     * 验证信任登录令牌.
      */
     verify(token: string, ctx?: Context): Promise<boolean>;
     /**
      * Quickauth OAuth2 quick authorize, contains grant code and code authorize.
+     * 快速授权，OAuth2多阶段合并为一阶段.
      */
     quickauth(credential: Credential, ctx?: Context): Promise<AccessToken>;
     /**
-     * Grant OAuth2 code grant.
+     * Grant OAuth2 code authorize.
      */
-    grant(credential: Credential, ctx?: Context): Promise<AccessGrant>;
+    grant(grant: AccessGrant, ctx?: Context): Promise<GrantCode>;
     /**
      * Accept OAuth2 accept grant code.
      */
@@ -45,10 +50,14 @@ export declare abstract class Tokenizer {
      * Refresh OAuth2 auth token refresh.
      */
     refresh(token: string, ctx?: Context): Promise<AccessToken>;
+    /**
+     * Destroy OAuth2 auth token destroy.
+     */
+    destroy(token: string, ctx?: Context): Promise<void>;
 }
-export declare abstract class TokenProvider {
+export declare abstract class AuthProvider {
     /**
-     * Provide
+     * Session
      */
-    provide(token: string, ctx?: Context): Promise<Session>;
+    session(credential: Credential, ctx?: Context): Promise<Session>;
 }

package/dist/psi/vm.d.ts ADDED Viewed

@@ -0,0 +1,34 @@
+import { Context } from './context';
+import { Page, Paging, Script } from '../types';
+export declare abstract class VM {
+    /**
+     * Compile the script.
+     * 编译脚本，编译通即会保存快照.
+     */
+    compile(script: Script, ctx?: Context): Promise<string>;
+    /**
+     * Setup set up the script.
+     * 编译安装脚本到运行时中，为发布语意.
+     */
+    setup(code: string, version: string, ctx?: Context): Promise<void>;
+    /**
+     * Remove the script.
+     * 删除脚本.
+     */
+    remove(code: string, ctx?: Context): Promise<void>;
+    /**
+     * Describe the script.
+     * 获取脚本详情.
+     */
+    describe(code: string, ctx?: Context): Promise<Script>;
+    /**
+     * Exec the script with name.
+     * 执行脚本，此处为规则引擎服务化执行接口.
+     */
+    exec(code: string, args: Record<string, string>, dft: string, ctx?: Context): Promise<string>;
+    /**
+     * Index the scripts.
+     * 分页检索脚本数据.
+     */
+    index(idx: Paging, ctx?: Context): Promise<Page<Script>>;
+}

package/dist/tool/addrs.d.ts CHANGED Viewed

@@ -1,8 +1,10 @@
 export declare class Addrs {
     private readonly servers;
     private readonly availableAddrs;
+    private relativePath;
     constructor(addrs: string);
     any(): string;
+    relative(ok: boolean): void;
 }
 export declare class StatefulServer {
     private available;

package/dist/tool/tool.d.ts CHANGED Viewed

@@ -1,4 +1,5 @@
 import { Addrs } from './addrs';
+import { Type } from '../macro';
 import { Body, CacheBody, Cause } from '../types';
 declare class Once<T> {
     private value?;
@@ -12,10 +13,10 @@ export declare class Tool {
     static anyone(...varg: (string | undefined)[]): string;
     static traceId(): string;
     static spanId(spanId: string, calls: number): string;
-    static MESH_ADDRESS: Once<Addrs>;
+    static readonly MESH_ADDRESS: Once<Addrs>;
     static newEntity(value: any): Body;
     static newCacheEntity(key: string, value: any, duration: number): CacheBody;
-    static readObject<T>(entity: Body): T | null;
+    static readObject<T>(entity: Body, k: Type<T>): T | null;
     /**
      * Is the version less than the appointed version.
      *

package/dist/types/builtin.d.ts CHANGED Viewed

@@ -1,121 +1,149 @@
 import { Stacktrace } from '../macro';
 export declare class Paging {
     /**
+     * Session ID
      * Session ID
      */
     sid: string;
     /**
+     * Start index
      * Start index
      */
     index: number;
     /**
+     * Start limit
      * Start limit
      */
     limit: number;
     /**
+     * Paging factor
      * Paging factor
      */
     factor: Record<string, any>;
     /**
+     * Sort order
      * Sort order
      */
     order: string;
 }
 export declare class Page<T> {
     /**
+     * Session ID
      * Session ID
      */
     sid: string;
     /**
+     * Start index
      * Start index
      */
     index: number;
     /**
+     * Start limit
      * Start limit
      */
     limit: number;
     /**
+     * Start total
      * Start total
      */
     total: number;
     /**
+     * Has next
      * Has next
      */
     next: boolean;
     /**
+     * Index data
      * Index data
      */
     data: T[];
 }
 export declare class DataLord {
     /**
+     * 节点编码
      * 节点编码
      */
     nodeId: string;
     /**
+     * 节点名称
      * 节点名称
      */
     nodeName: string;
     /**
+     * 机构编码
      * 机构编码
      */
     instId: string;
     /**
+     * 机构名称
      * 机构名称
      */
     instName: string;
 }
 export declare class Mani {
     /**
+     * 状态
      * 状态
      */
     status: number;
     /**
+     * 创建时间
      * 创建时间
      */
     createAt?: Date;
     /**
+     * 更新时间
      * 更新时间
      */
     updateAt?: Date;
     /**
+     * 创建人
      * 创建人
      */
     createBy: string;
     /**
+     * 更新人
      * 更新人
      */
     updateBy: string;
 }
 export declare class Cause implements Stacktrace {
     /**
+     * Cause name
      * Cause name
      */
     name: string;
     /**
+     * Cause position
      * Cause position
      */
     pos: string;
     /**
+     * Cause descriptor
      * Cause descriptor
      */
     text: string;
     /**
+     * Cause stack
      * Cause stack
      */
     buff: Uint8Array;
 }
 export declare class Topic {
     /**
+     *
      */
     topic: string;
     /**
+     *
      */
     code: string;
     /**
+     *
      */
     group: string;
     /**
+     *
      */
     sets: string;
 }

package/dist/types/cipher.d.ts CHANGED Viewed

@@ -1,111 +1,138 @@
 export declare class CRL {
     /**
+     * Resource suite
      * Resource suite
      */
     suite: string;
     /**
+     * Resource project
      * Resource project
      */
     project: string;
     /**
+     * Resource name
      * Resource name
      */
     name: string;
     /**
+     * Resource version
      * Resource version
      */
     version: string;
 }
 export declare class CipherHello {
     /**
+     *
      */
     name: string;
     /**
+     * ReAnonymize/ReCipher/Homomorphic
      * ReAnonymize/ReCipher/Homomorphic
      */
     proto: string;
     /**
+     * SM2/RSA2/BFV etc.
      * SM2/RSA2/BFV etc.
      */
     algo: string;
     /**
+     *
      */
     parties: string[];
     /**
+     *
      */
     message: string;
 }
 export declare class CipherSuite {
     /**
+     * Handshake suite
      * Handshake suite
      */
     suite: string;
     /**
+     * Cipher sign request
      * Cipher sign request
      */
     csr: Uint8Array;
 }
 export declare class CipherKeygen {
     /**
+     *
      */
     hello: CipherHello;
     /**
+     *
      */
     suite: CipherSuite;
     /**
+     * Local party
      * Local party
      */
     local: string;
 }
 export declare class CipherRegen extends CipherKeygen {
     /**
+     * Generate keys
      * Generate keys
      */
     keys: Record<string, Uint8Array>;
 }
 export declare class CipherKey {
     /**
+     * Generate keys
      * Generate keys
      */
     keys: Record<string, Uint8Array>;
 }
 export declare class CipherEntity {
     /**
+     *
      */
     suite: string;
     /**
+     *
      */
     body: Uint8Array;
 }
 export declare class CipherTxEntity extends CipherEntity {
     /**
+     *
      */
     reKey: Uint8Array;
 }
 export declare class CipherObject {
     /**
+     *
      */
     code: string;
     /**
+     *
      */
     name: string;
     /**
+     *
      */
     memo: string;
     /**
+     *
      */
     uri: string;
     /**
+     * Confidential level
      * Confidential level
      */
     level: string;
     /**
+     *
      */
     nodeId: string;
     /**
+     *
      */
     instId: string;
     /**
+     *
      */
     raw: string;
 }