next-flow-interface 0.23.6 → 0.23.7

package/dist/service/sync/attribute/attribute-service-api.d.ts

@@ -1,5 +1,104 @@
+import { RvPath } from 'rhine-var';
+import { AttributeType } from './dto/attribute-type.enum';
 import { IAttribute } from './dto/instance/attribute.interface';
+import { default as IGlobalAttribute } from './dto/instance/global-attribute.interface';
+import { default as INodeAttribute } from './dto/instance/node-attribute.interface';
+import { default as IStepAttribute } from './dto/instance/step-attribute.interface';
+/**
+ * 属性服务 API 接口
+ *
+ * 负责管理和注册所有类型的属性（Node、Step、Global）
+ * 提供属性的注册、查询、黑名单管理等功能
+ */
 export default interface AttributeServiceApi {
-    register(definition: IAttribute): void;
+    /**
+     * 通用路径黑名单
+     *
+     * 包含所有类型属性都禁止使用的路径
+     * @example [['parent'], ['subscribe'], ['unsubscribe']]
+     */
+    commonBlacklist: RvPath[];
+    /**
+     * Node 类型属性的路径黑名单
+     */
+    nodeBlacklist: RvPath[];
+    /**
+     * Step 类型属性的路径黑名单
+     * @example [['nodes']]
+     */
+    stepBlacklist: RvPath[];
+    /**
+     * Global 类型属性的路径黑名单
+     * @example [['steps']]
+     */
+    globalBlacklist: RvPath[];
+    /**
+     * 已注册的 Node 类型属性列表
+     */
+    nodeAttributes: INodeAttribute[];
+    /**
+     * 已注册的 Step 类型属性列表
+     */
+    stepAttributes: IStepAttribute[];
+    /**
+     * 已注册的 Global 类型属性列表
+     */
+    globalAttributes: IGlobalAttribute[];
+    /**
+     * 注册属性
+     *
+     * 将属性实例注册到对应的属性列表中
+     * 注册前会检查路径是否在黑名单中以及是否与已有路径冲突
+     *
+     * @param attribute - 要注册的属性实例
+     * @throws 如果路径在黑名单中
+     * @throws 如果路径与已注册的路径冲突
+     * @throws 如果属性类型与实例类型不匹配
+     */
+    register(attribute: IAttribute): void;
+    /**
+     * 通过路径精确匹配获取属性
+     *
+     * @param type - 属性类型
+     * @param path - 属性路径，支持 RvPath 数组或字符串格式
+     * @returns 匹配的属性实例，未找到返回 undefined
+     */
+    get(type: AttributeType, path: RvPath | string): IAttribute | undefined;
+    /**
+     * 通过路径获取 NodeAttribute
+     *
+     * @param path - 属性路径，支持 RvPath 数组或字符串格式
+     * @returns 匹配的 NodeAttribute 实例，未找到返回 undefined
+     */
+    getNodeAttribute(path: RvPath | string): INodeAttribute | undefined;
+    /**
+     * 通过路径获取 StepAttribute
+     *
+     * @param path - 属性路径，支持 RvPath 数组或字符串格式
+     * @returns 匹配的 StepAttribute 实例，未找到返回 undefined
+     */
+    getStepAttribute(path: RvPath | string): IStepAttribute | undefined;
+    /**
+     * 通过路径获取 GlobalAttribute
+     *
+     * @param path - 属性路径，支持 RvPath 数组或字符串格式
+     * @returns 匹配的 GlobalAttribute 实例，未找到返回 undefined
+     */
+    getGlobalAttribute(path: RvPath | string): IGlobalAttribute | undefined;
+    /**
+     * 根据类型获取属性列表
+     *
+     * @param type - 属性类型，不传入时返回所有类型的属性
+     * @returns 属性列表
+     */
+    getList(type?: AttributeType): IAttribute[];
+    /**
+     * 检查路径是否与已注册的属性路径冲突
+     *
+     * @param type - 属性类型
+     * @param path - 要检查的路径
+     * @returns 如果存在冲突返回 true，否则返回 false
+     */
+    isPathConflict(type: AttributeType, path: RvPath): boolean;
 }
 //# sourceMappingURL=attribute-service-api.d.ts.map

package/dist/service/sync/attribute/attribute-service-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"attribute-service-api.d.ts","sourceRoot":"","sources":["../../../../src/service/sync/attribute/attribute-service-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,2DAA2D,CAAA;AAEtF,MAAM,CAAC,OAAO,WAAW,mBAAmB;IAC1C,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;CACvC"}
+{"version":3,"file":"attribute-service-api.d.ts","sourceRoot":"","sources":["../../../../src/service/sync/attribute/attribute-service-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,kDAAkD,CAAA;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,2DAA2D,CAAA;AACtF,OAAO,gBAAgB,MAAM,kEAAkE,CAAA;AAC/F,OAAO,cAAc,MAAM,gEAAgE,CAAA;AAC3F,OAAO,cAAc,MAAM,gEAAgE,CAAA;AAE3F;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,mBAAmB;IAC1C;;;;;OAKG;IACH,eAAe,EAAE,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB;;;OAGG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB;;;OAGG;IACH,eAAe,EAAE,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAA;IAEhC;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAA;IAEhC;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,EAAE,CAAA;IAEpC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAS,EAAE,UAAU,GAAG,IAAI,CAAA;IAErC;;;;;;OAMG;IACH,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;IAEvE;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,cAAc,GAAG,SAAS,CAAA;IAEnE;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,cAAc,GAAG,SAAS,CAAA;IAEnE;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAA;IAEvE;;;;;OAKG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,UAAU,EAAE,CAAA;IAE3C;;;;;;OAMG;IACH,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CAC3D"}

package/dist/utils/rv-utils.d.ts

@@ -6,6 +6,9 @@ export declare function ensureRvPathString(path: string | RvPath): string;
 export declare function getByRvPath(source: StoredRhineVar | Record<string | number, unknown>, path: string | RvPath): unknown;
 export declare function setByRvPath(source: StoredRhineVar, path: string | RvPath, value: unknown): void;
 export declare function checkRvPathOverlay(from: RvPath | string, target: RvPath | string): boolean;
+export declare function checkAnyRvPathOverlay(from: RvPath | string, targetList: (RvPath | string)[]): boolean;
+export declare function checkRvPathSame(from: RvPath | string, target: RvPath | string): boolean;
+export declare function checkAnyRvPathSame(from: RvPath | string, targetList: (RvPath | string)[]): boolean;
 declare const RvUtils: {
     makeRvPath: typeof makeRvPath;
     makeRvPathString: typeof makeRvPathString;
@@ -13,7 +16,10 @@ declare const RvUtils: {
     ensureRvPathString: typeof ensureRvPathString;
     getByRvPath: typeof getByRvPath;
     setByRvPath: typeof setByRvPath;
+    checkRvPathSame: typeof checkRvPathSame;
+    checkAnyRvPathSame: typeof checkAnyRvPathSame;
     checkRvPathOverlay: typeof checkRvPathOverlay;
+    checkAnyRvPathOverlay: typeof checkAnyRvPathOverlay;
 };
 export default RvUtils;
 //# sourceMappingURL=rv-utils.d.ts.map

package/dist/utils/rv-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rv-utils.d.ts","sourceRoot":"","sources":["../../src/utils/rv-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAElD,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW/C;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAK1D;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAKhE;AAED,wBAAgB,WAAW,CACzB,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EACzD,IAAI,EAAE,MAAM,GAAG,MAAM,GACpB,OAAO,CAUT;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAO/F;AAGD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,WAUhF;AAGD,QAAA,MAAM,OAAO;;;;;;;;CAQZ,CAAA;AAED,eAAe,OAAO,CAAA"}
+{"version":3,"file":"rv-utils.d.ts","sourceRoot":"","sources":["../../src/utils/rv-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAElD,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAW/C;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAK1D;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAKhE;AAED,wBAAgB,WAAW,CACzB,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EACzD,IAAI,EAAE,MAAM,GAAG,MAAM,GACpB,OAAO,CAUT;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAO/F;AAGD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAU1F;AAED,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,UAAU,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAC9B,OAAO,CAGT;AAGD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAYvF;AAED,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,UAAU,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAC9B,OAAO,CAGT;AAGD,QAAA,MAAM,OAAO;;;;;;;;;;;CAWZ,CAAA;AAED,eAAe,OAAO,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-flow-interface",
-  "version": "0.23.6",
+  "version": "0.23.7",
   "description": "Interface package for NEXT FlOW. You can use this package to build your own plugin that can control anything.",
   "type": "module",
   "module": "dist/index.js",