@manycore/custom-sdk 1.13.3 → 1.13.4-beta.0

package/index.d.ts

@@ -1,9 +1,7 @@
-import { ELineType as ELineType_2 } from '@manycore/custom-miniapp-sdk';
 import { IExportModelData } from '@manycore/custom-miniapp-sdk';
 import { IParamModelPhotoResponse } from '@manycore/custom-miniapp-sdk';
 import { IServClientService } from 'servkit';
-import { Number2 } from '@manycore/custom-miniapp-sdk';
-import { Number3 } from '@manycore/custom-miniapp-sdk';
+import { Number2 as Number2_2 } from '@manycore/custom-miniapp-sdk';
 import { ServService } from 'servkit';
 
 declare interface AMap<K, V> {
@@ -28,6 +26,7 @@ export declare class Application {
     private serviceMap;
     private sappSDK;
     constructor();
+    private startOnApiCalledEvent;
     /**
      * 判断当前是否在定制小程序下运行
      */
@@ -352,7 +351,7 @@ export declare enum EFittingType {
     /**
      * 交接面信息
      */
-    INTERSECTED = 'intersected',
+    INTERSECTED = "intersected"
 }
 
 /**
@@ -362,11 +361,11 @@ export declare enum EIntersectedCreatedType {
     /**
      * 板与板之间产生的交界
      */
-    BOTH_PLANK,
+    BOTH_PLANK = 0,
     /**
      * 板与五金之间产生的交界信息
      */
-    PLANK_FURNITURE,
+    PLANK_FURNITURE = 1
 }
 
 /**
@@ -376,11 +375,29 @@ export declare enum EIntersectedType {
     /**
      * 交接体
      */
-    SHELL = '1',
+    SHELL = "1",
     /**
      * 交界面
      */
-    FACE = '2',
+    FACE = "2"
+}
+
+/**
+ * 交接对象类型
+ */
+export declare enum EIntersectModelType {
+    /**
+     * 板件
+     */
+    PLANK = 0,
+    /**
+     * 五金
+     */
+    HARDWARE = 1,
+    /**
+     * 商品
+     */
+    PRODUCT = 2
 }
 
 /**
@@ -435,25 +452,6 @@ declare enum ElementType {
  * 线的类型
  */
 export declare enum ELineType {
-    /**
-     * 直线
-     */
-    SEGMENT = 0,
-    /**
-     * 圆弧
-     */
-    CIRCLE_ARC = 1,
-    /**
-     * 椭圆
-     * 当前代码中，暂不支持
-     */
-    ELLIPSE_ARC = 3,
-}
-
-/**
- * 线的类型
- */
-declare enum ELineType_3 {
     /**
      * 直线
      */
@@ -621,33 +619,16 @@ export declare enum EPointType {
     /**
      * 椭圆
      */
-    ELLIPSE = 4,
+    ELLIPSE = 4
 }
 
 /**
- * 点的类型
+ * 商品建模方向
  */
-declare enum EPointType_2 {
-    /**
-     * 普通点
-     */
-    NONE = 0,
-    /**
-     * 倒圆
-     */
-    CIRCLE = 1,
-    /**
-     * 倒角
-     */
-    LINE = 2,
-    /**
-     * 切圆，就是内挖一个倒圆的形状
-     */
-    CUT_CIRCLE = 3,
-    /**
-     * 椭圆
-     */
-    ELLIPSE = 4
+export declare enum EProductDirection {
+    XY = 0,
+    YZ = 1,
+    XZ = 2
 }
 
 /**
@@ -854,6 +835,9 @@ export declare class FittingDesignService extends BaseService {
       * 保存孔/槽数据至方案
       * 如果design不传，即表示将分步保存数据存储至后端
       *
+      * 之前的孔槽会被design直接替换
+      *
+      * 如果只想展示孔槽可使用 {@link FittingDesignService.appendFittingDesign}
       * @example
       * ```typescript
       * await fittingDesignService.saveDesign({
@@ -981,17 +965,14 @@ export declare class FittingDesignService extends BaseService {
          * 孔/槽的深度
          */
         depth: number;
-
         /**
          * 所处的板面
          */
         plankFaceId: number;
-
         /**
          * 起点
          */
         start: Number3;
-
         /**
          * 终点
          */
@@ -1000,6 +981,7 @@ export declare class FittingDesignService extends BaseService {
 
     /**
      * 交接信息
+     * @vm-type UnknownType
      */
     export declare interface IBaseIntersected {
         /**
@@ -1012,7 +994,6 @@ export declare class FittingDesignService extends BaseService {
          * * 如果为交接体，length为8
          */
         points: Number3[];
-
         /**
          * 当前交接信息产生的元件ID
          */
@@ -1162,19 +1143,19 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 所有的孔的数据
          */
-        holes: IFittingHoleCollect;
+        holes: IFittingHoleCollect_2;
         /**
          * 槽的数据
          */
-        grooves: IFittingGrooveCollect;
+        grooves: IFittingGrooveCollect_2;
         /**
          * 五金数据
          */
-        hardwares: IFittingHardwareCollect;
+        hardwares: IFittingHardwareCollect_2;
         /**
          * 五金槽数据
          */
-        hardwareGrooves: IFittingHardwareGrooves;
+        hardwareGrooves: IFittingHardwareGrooves_2;
     }
 
     export declare interface IFittingDesignValidateResult {
@@ -1189,16 +1170,31 @@ export declare class FittingDesignService extends BaseService {
      */
     export declare type IFittingGrooveCollect = Record<string, IGrooveData[]>;
 
+    /**
+     * 方案中的所有槽的数据
+     */
+    declare type IFittingGrooveCollect_2 = Record<string, IGrooveData[]>;
+
     /**
      * 五金数据
      */
     export declare type IFittingHardwareCollect = Record<string, IHardwareData[]>;
 
+    /**
+     * 五金数据
+     */
+    declare type IFittingHardwareCollect_2 = Record<string, IHardwareData[]>;
+
     /**
      * 五金槽数据
      */
     export declare type IFittingHardwareGrooves = Record<string, IHardwareGrooveData[]>;
 
+    /**
+     * 五金槽数据
+     */
+    declare type IFittingHardwareGrooves_2 = Record<string, IHardwareGrooveData[]>;
+
     /**
      * 五金孔槽模型ID - 标识信息
      *
@@ -1222,6 +1218,11 @@ export declare class FittingDesignService extends BaseService {
      */
     export declare type IFittingHoleCollect = Record<string, IHoleData[]>;
 
+    /**
+     * 方案中，所有孔的数据
+     */
+    declare type IFittingHoleCollect_2 = Record<string, IHoleData[]>;
+
     /**
      * 五金孔槽通用模型
      */
@@ -1270,17 +1271,71 @@ export declare class FittingDesignService extends BaseService {
     }
 
     /**
-     * 获取交接面配置信息
+     * 获取模型的交接信息
      */
-    export declare interface IGetModelIntersectedOption extends IBaseOptions {
+    declare interface IGetIntersectedOption {
         /**
+         * 模型ID
+         */
+        modelId: string;
+        /**
+         * @deprecated 可使用bodyDistTol/faceDistTol分别指定交接体/面阈值
          * 含义为交接面/体进行运算过程中的阈值容差；即两个平行面之间，生成交接信息时，最大距离
          * 默认值为 0.1mm
          * 单位：毫米
          */
         tolerance?: number;
+        /**
+         * 超时时间
+         * 单位：秒
+         */
+        timeout?: number;
+        /**
+         * 交接体阈值
+         * 单位：毫米
+         * @default 0.1
+         */
+        bodyDistTol?: number;
+        /**
+         * 交接面阈值
+         * 单位：毫米
+         * @default 0.1
+         */
+        faceDistTol?: number;
+        /**
+         * 是否过滤板厚
+         * @default true
+         */
+        thicknessFilter?: boolean;
+        /**
+         * 参与计算的对象
+         * 传入商品需要明确指定prodCatIds
+         * @default [EIntersectModelType.PLANK,EIntersectModelType.HARDWARE]
+         */
+        computeModelTypes?: Array<EIntersectModelType>;
+        /**
+         * 参与计算的商品
+         */
+        products?: Array<{
+            /**
+             * 真分类
+             */
+            category: number;
+        }>;
+        /**
+         * 商品统一建模方向
+         * @default EProductDirection.XY
+         */
+        direction?: EProductDirection;
     }
 
+    /**
+     * 获取交接面配置信息
+     */
+    export declare interface IGetModelIntersectedOption
+    extends Omit<IGetIntersectedOption, 'modelId'>,
+    IBaseOptions {}
+
     /**
      * 获取模型数据
      */
@@ -1297,7 +1352,6 @@ export declare class FittingDesignService extends BaseService {
     }
 
     export declare interface IGrooveData extends IBaseHoleGrooveData {
-        // 槽宽
         width: number;
     }
 
@@ -1309,22 +1363,18 @@ export declare class FittingDesignService extends BaseService {
          * 建模原点在板件坐标系下的坐标
          */
         position: Number3;
-
         /**
          * 相对建模坐标系中夹角，不传默认没有任何基于板件坐标的旋转，会将五金以建模原点放在 position 上，五金建模方向和板件建模方向一致进行摆放。
          */
         rotate: Number3;
-
         /**
          * 相对建模坐标系中缩放，不传默认五金和上传大小完全一致
          */
         scale: Number3;
-
         /**
          * 商品ID
          */
         brandGoodId: string;
-
         /**
          * 关联孔槽ID
          */
@@ -1339,7 +1389,6 @@ export declare class FittingDesignService extends BaseService {
          * 槽的深度
          */
         depth: number;
-
         /**
          * 所处的板面
          */
@@ -1429,6 +1478,16 @@ export declare class FittingDesignService extends BaseService {
         diameter: number;
     }
 
+    /**
+     * 交接信息
+     */
+    export declare interface IIntersectedData {
+        /**
+         * 交接信息集合
+         */
+        intersectedGroups: IIntersectedGroup[];
+    }
+
     /**
      * 一组交接信息
      */
@@ -1450,12 +1509,7 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 交接信息
      */
-    export declare interface IIntersectedResult {
-        /**
-         * 交接信息集合
-         */
-        intersectedGroups: IIntersectedGroup[];
-    }
+    export declare type IIntersectedResult = IIntersectedData;
 
     /**
      * 轮廓路径线段表示
@@ -1465,7 +1519,7 @@ export declare class FittingDesignService extends BaseService {
          * 获取实际渲染端点
          * >线段两端
          */
-        getRenderPoints(): [Number2, Number2];
+        getRenderPoints(): [Number2_2, Number2_2];
         /**
          * 设置线段的高亮，高亮深度为板件厚度
          * @param hint 高亮配置
@@ -1520,26 +1574,21 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 直线
      */
-    export declare interface ILineDataBase
-    extends Omit<
-    ILineBase,
-    'ellipseCenter' | 'clockwise' | 'minorArc' | 'radius' | 'majorRadius' | 'minorRadius'
-    > {
+    export declare interface ILineDataBase extends Omit<ILineBase, 'ellipseCenter' | 'clockwise' | 'minorArc' | 'radius' | 'majorRadius' | 'minorRadius'> {
         /**
          * 线条类型
          */
-        type: ELineType_2.SEGMENT;
+        type: ELineType.SEGMENT;
     }
 
     /**
      * 弧线
      */
-    export declare interface ILineDataCircle
-    extends Omit<ILineBase, 'ellipseCenter' | 'majorRadius' | 'minorRadius'> {
+    export declare interface ILineDataCircle extends Omit<ILineBase, 'ellipseCenter' | 'majorRadius' | 'minorRadius'> {
         /**
          * 线条类型
          */
-        type: ELineType_2.CIRCLE_ARC;
+        type: ELineType.CIRCLE_ARC;
         /**
          * 是否顺时针
          */
@@ -1729,7 +1778,7 @@ export declare class FittingDesignService extends BaseService {
          * @public
          * @typedef Number3
          */
-        position: Number3_2;
+        position: Number3;
         /**
          * 当前模型的旋转信息
          * @readonly
@@ -1737,21 +1786,21 @@ export declare class FittingDesignService extends BaseService {
          * @typedef Number3
          * @deprecated 将废弃，推荐使用 rotation
          */
-        rotate: Number3_2;
+        rotate: Number3;
         /**
          * 当前模型的旋转信息
          * @readonly
          * @public
          * @typedef Number3
          */
-        rotation: Number3_2;
+        rotation: Number3;
         /**
          * 当前尺寸信息
          * @readonly
          * @public
          * @typedef Number3
          */
-        size: Number3_2;
+        size: Number3;
         /**
          * 模型当中自定议的参数信息
          * @readonly
@@ -1830,34 +1879,34 @@ export declare class FittingDesignService extends BaseService {
          * 更新当前模型的位置信息
          * @param position {Number3} 坐标
          */
-        setPosition(position: Number3_2): void;
+        setPosition(position: Number3): void;
         /**
          * 获取当前模型的坐标信息
          * @return Number3 相对父模型坐标，如果为顶层模型，则为世界坐标
          */
-        getPosition(): Number3_2;
+        getPosition(): Number3;
         /**
          * 更新当前模型的旋转信息
          * @description 特别说明，定制模型，使用的是右手坐标系，rotate字段中
          * @param rotate {Number3} 旋转的弧度
          * @deprecated 将废弃，推荐使用 rotation
          */
-        setRotate(rotate: Number3_2): void;
+        setRotate(rotate: Number3): void;
         /**
          * 获取当前模型相对父级的旋转信息
          * @deprecated 将废弃，推荐使用 rotation
          */
-        getRotate(): Number3_2;
+        getRotate(): Number3;
         /**
          * 更新当前模型的旋转信息
          * @description 特别说明，定制模型，使用的是右手坐标系，rotation字段中
          * @param rotation {Number3} 旋转的弧度
          */
-        setRotation(rotation: Number3_2): void;
+        setRotation(rotation: Number3): void;
         /**
          * 获取当前模型相对父级的旋转信息
          */
-        getRotation(): Number3_2;
+        getRotation(): Number3;
         /**
          * 获取当前模型所处的工具线
          */
@@ -2038,13 +2087,21 @@ export declare class FittingDesignService extends BaseService {
     export declare interface IPlankArea {
         /**
          * 由板件原始轮廓数据解析出的所有路径
+         * >包含一个外轮廓路径和任意个内部轮廓路径
          */
         paths: IPlankPath[];
 
         /**
-         * 对板件原始轮廓数据进行非直角端点处理、重合、偏移计算后的实际展示路径
+         * 对板件原始轮廓数据进行非直角端点处理、重合、偏移计算后的实际展示路径，高亮时会将轮廓中心点放置到 (0, 0)
+         * @param option.resetCenter 是否重置轮廓中心点为 (0, 0)，默认为true
+         * @param option.force 忽略计算缓存，同一个PlankArea对象，getRealPaths计算结果会被缓存，默认为false
          */
-        getRealPaths(): IPlankArea;
+        getRealPaths(option?: { resetCenter?: boolean; force?: boolean }): IPlankArea;
+
+        /**
+         * 获取外轮廓路径中心点坐标
+         */
+        getCenterPoint(): Number2_2;
     }
 
     /**
@@ -2082,7 +2139,7 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 获取路径上实际渲染的端点
          */
-        getRenderPoints(): Number2[];
+        getRenderPoints(): Number2_2[];
     }
 
     declare interface IPlankPathData {
@@ -2098,7 +2155,7 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 线条类型
          */
-        type: ELineType_3;
+        type: ELineType;
         /**
          * 是否顺时针
          */
@@ -2139,7 +2196,7 @@ export declare class FittingDesignService extends BaseService {
         /**
          * 点的类型
          */
-        type: EPointType_2;
+        type: EPointType;
         /**
          * 切角两边上切点距离当前点的距离（切角专用）
          */
@@ -2182,7 +2239,7 @@ export declare class FittingDesignService extends BaseService {
          * 获取实际渲染端点
          * >非直角端点为渲染线段的两端，直角端点两个端点相同
          */
-        getRenderPoints(): [Number2, Number2];
+        getRenderPoints(): [Number2_2, Number2_2];
         /**
          * 设置非直角端点渲染线段的高亮，高亮深度为板件厚度
          * @param hint 高亮配置
@@ -2205,6 +2262,9 @@ export declare class FittingDesignService extends BaseService {
         type: EPointType;
         /**
          * 点的位置
+         *
+         * @example
+         * "123,-345"
          */
         position: Number3 | Number2;
         /**
@@ -2241,11 +2301,7 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 倒圆
      */
-    export declare interface IPointWithCircle
-    extends Omit<
-    IPointBase,
-    'clockwise' | 'majorRadius' | 'minorRadius' | 'cornerCutDistance' | 'offset'
-    > {
+    export declare interface IPointWithCircle extends Omit<IPointBase, 'clockwise' | 'majorRadius' | 'minorRadius' | 'cornerCutDistance' | 'offset'> {
         /**
          * 切角类型
          */
@@ -2276,8 +2332,7 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 切角
      */
-    export declare interface IPointWithLine
-    extends Omit<IPointBase, 'clockwise' | 'majorRadius' | 'minorRadius' | 'radius' | 'offset'> {
+    export declare interface IPointWithLine extends Omit<IPointBase, 'clockwise' | 'majorRadius' | 'minorRadius' | 'radius' | 'offset'> {
         /**
          * 切角类型
          */
@@ -2291,11 +2346,7 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 普通点类型
      */
-    export declare interface IPointWithNone
-    extends Omit<
-    IPointBase,
-    'cornerCutDistance' | 'majorRadius' | 'minorRadius' | 'radius' | 'offset'
-    > {
+    export declare interface IPointWithNone extends Omit<IPointBase, 'cornerCutDistance' | 'majorRadius' | 'minorRadius' | 'radius' | 'offset'> {
         /**
          * 普通点
          */
@@ -2892,12 +2943,22 @@ export declare class FittingDesignService extends BaseService {
          * const json = await service.getModelJsonDataByModelId('请输入模型ID');
          * ```
          *
-         * > 以上 API 暂不建议在非对接 2.0 环境下使用，主要是与孔/槽方案数据存在关联关系。
-         > > 替代的 service 为`CustomDesignExportService`，将会在 9 月底最新的`@manycore/custom-miniapp-sdk`中提供。
+         * > 以上 API 暂不建议在非对接 2.0 环境下使用，主要是与孔/槽方案数据存在关联关系
+         > > 耗时API 建议后台异步请求并配合做好缓存
+         > > >替代的 service 为`CustomDesignExportService`，将会在 9 月底最新的`@manycore/custom-miniapp-sdk`中提供。
          *
-         * @example
+         * @example 最佳实践
          * ```typescript
-         * await modelService.getParamData();
+         * // 后台异步任务 串行执行不建议并发
+         * const cache = new Map<string, any>();
+         * for (const model of models) {
+         *     const { id } = model;
+         *     const data = await getParamData({ modelId: id });
+         *     cache.set(id, data)
+         * }
+         *
+         * // 主线程获取
+         * cache.get(id);
          * ```
          *
          * @param options
@@ -2905,10 +2966,19 @@ export declare class FittingDesignService extends BaseService {
         getParamData(options?: IGetParamModelJsonOption): Promise<any>;
         /**
          * 获取模型的交接数据
-         *
+         * > 耗时API 建议后台异步请求并配合做好缓存
          * @example
          * ```typescript
-         * await modelService.getParamIntersected();
+         * // 后台异步任务 串行执行不建议并发
+         * const cache = new Map<string, any>();
+         * for (const model of models) {
+         *     const { id } = model;
+         *     const data = await getParamIntersected({ modelId: id });
+         *     cache.set(id, data)
+         * }
+         *
+         * // 主线程获取
+         * cache.get(id);
          * ```
          *
          * @param options
@@ -3172,7 +3242,7 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 二维空间下：坐标/向量/旋转/尺寸的基础表示
      */
-    declare interface Number2_2 {
+    declare interface Number2 {
         /**
          * x轴上的数据
          */
@@ -3186,7 +3256,7 @@ export declare class FittingDesignService extends BaseService {
     /**
      * 三维空间下，坐标/向量/旋转/尺寸的基础表示
      */
-    declare interface Number3_2 extends Number2_2 {
+    declare interface Number3 extends Number2 {
         /**
          * z轴方向数据
          */