@kudashi/kds-api 2.13.31 → 2.13.33

package/README.md

@@ -1,274 +1,282 @@
-# 酷大师api
-
-# api changelog
-
-# version 2.13.31(2025-03-18)
-- 新增createPluginModelLibrary
-
-# version 2.13.30(2025-02-27)
-- 新增KArchFace, KArchWall, KArchRoom, KArchPillar, KArchOpening相关api
-- 新增KDesign.isShellSolid, KApplicationObserver.onGroupInstanceActivated, KApplicationObserver.onGroupInstanceDeactivated
-
-# version 2.13.29(2025-02-20)
-- 新增KGroupInstance.getInstanceParentGroupDefinition
-- 新增KDesign.getEditPathsToGroupInstance KDesign.activateEditPath KDesign.toggleEntitiesVisible
-- 新增isVisible判断模型是否可见
-
-# version 2.13.28(2025-02-11)
-- 支持三方插件存储模型库
-- 插件标题支持多语言机制，详情参考：https://manual.kujiale.com/kds-plugin-document/1.0.0/docs/tutorial/%E9%85%B7%E5%A4%A7%E5%B8%88%E6%8F%92%E4%BB%B6%E6%A0%BC%E5%BC%8F%E8%A6%81%E6%B1%82
-
-# version 2.13.27(2028-01-07)
-- KDesign.startOperation和KDesign.commitOperation之间的操作更加兼容undo/redo
-- KGroupInstance.setCustomProperty和KGroupDefinition.setCustomProperty兼容undo/redo
-- 增加KView.getModelSnapshot
-
-# version 2.13.26(2024-11-26)
-- 增加KTopoEdge.getKey()
-
-# version 2.13.25(2024-11-25)
-- 增加KSurface.getPoint()
-
-# version 2.13.25(2024-11-25)
-- 增加KSurface.getPoint()
-
-# version 2.13.24
-- deactivateGroupInstance改为异步
-
-# version 2.13.23
-- 个人库材质上传限制
-- 增加KDesign.inflateFaces
-
-# version 2.13.22
-- 增加KDesign.saveInstanceAsLibraryProject
-
-# version 2.13.21
-- 增加KApplicationUI.getSelectControlAxises
-- 增加KGroupInstance.getLocalBoundingBox
-
-# version 2.13.20
-- 增加KDesign.enterExpressMode
-
-# version 2.13.19
-- 支持插件multiViews
-
-# version 2.13.14(2023-0919)
-- 增加KPluginView接口对应multiViews中每个View
-- 增加一些apaas api
-    - KApplication.getPluginViewById
-    - KApplication.registerMessageHandler
-    - KApplication.unRegisterMessageHandler
-    - KApplicationUI.toggleSketchToolBar
-    - KApplicationUI.togglePropertyPanelVisibility
-    - KApplicationUI.switchToCurrentPluginAssetPanel
-    - KApplicationUI.injectMenuItems
-    - KApplicationUI.injectToolItems
-    - KApplicationUI.toggleMaterialReplacePanel
-    - KDesign.createInstanceFromAnotherProject
-    - KPluginView
-# version 2.13.12(2023-0718)
-- 增加了一些apaas api：
-    - KDesign.thickenFaces
-    - KDesign.uploadMaterial
-    - KTestHelper增加了turnOffShellValidation和undefineShellValidation命令
-
-# version 2.13.11(2023-07-0-7)
-- 在KDesign中增加了:
-    - exitExpressMode
-
-# version 2.13.10(2023-06-20)
-- 在KDesign中增加了:
-    - breakGroupReference
-    - reparentGroupInstance
-
-# version 2.13.9(2023-05-30)
-- 在KDesign中增加了:
-    - assignMaterialForEntities()
-    - assignDecorationMaterialForEntities()
-    - brushDecorationMaterialToEntities()
-    - editMaterialParamsOfFace()
-    - adjustMaterialMapping()
-    - clearMaterial()
-    - getFacePavingGroupByFace()
-- 在KCamera中增加了:
-    - setPosition()
-    - setTarget()
-- 在KPickHelper中增加了:
-    - pickByPoint3d()
-- 在KView中增加了:
-    - getScreenSnopShot()
-- 添加材质连续对象KFacePavingGroup
-
-# version 2.13.7(2023-05-18)
-- 在KFace中增加了：
-    - getCustomProperty()
-    - setCustomProperty()
-    - deleteCustomProperty()
-- 在KGroupDefinition和KGroupInstance中增加了：
-    - getCustomProperty()
-    - setCustomProperty()
-    - getAllCustomPropertiesKey()
-- 在KGroupInstance中增加了：
-    - isInvisible()
-- 在KDesign中增加了:
-    - shareModel()
-    - addFaceHoles()
-    - getMaterialOfFace()
-    - getMaterialParamsOfFace()
-    - findGroupInstancesByAppKey()
-    - findGroupInstancesByResource()
-    - toggleGroupInstancesVisible()
-    - alignShells()
-    - flipFace(face: KFace)
-- 在KApplicationObserver中增加了：
-    - onModelChanged()
-- 在KApplicationUI中增加了：
-    - toggleShowInvisibleModel()
-    - getActivePluginEntrancePosition()
-    - showPopover()
-    - isShownInvisibleModel()
-- 增加了枚举类型：
-    - KGroupDefinitionType.Variable来表示变量化成组
-- 在KTestHelper中增加了:
-    - purgeMaterialsInDesign()
-    - clearAllDecorationMaterials()
-- 更新了math的apaas api版本，引入了很多新类型：
-    - "@qunhe/math-apaas-api": "3.0.0",
-    - "@qunhe/math-apaas-impl": "3.0.0",
-- 修复了如下问题：
-    - boolean()没有导出KBooleanType类型的问题
-    - fillet()返回类型不能使用map类型的问题
-    - KSelection.getAllEntities()增加了默认参数，来控制是否包含vertex；默认为false保持和原来行为一致
-    - 吸附结果中添加了吸附点的normal值
-
-# version 2.13.6(2022-11-29)
-- Adjust the parameters of the following APIs:
-    - drawArrow3d
-    - drawCylinder
-
-# version 2.13.5(2022-11-28)
-- Add API:
-    - drawArrow3d
-    - getShortestPath
-
-# version 2.13.4(2022-11-01)
-- Add API:
-    - drawCylinder
-    - clearTemporaryShapesByIds
-    - getYunDesignInfo
-    - executeRequest
-- Rebuilding API, change the return value of the following API from boolean to "{ id: string }":
-    - drawPoints
-    - drawLines
-    - drawPolylines
-    - drawText
-    - drawPromptLine
-
-# version 2.13.3
-
-# version 2.13.2(2022-07-15)
-- Add KApplication Chinese comment
-- Add KPluginUIAndStorage Chinese comment
-
-# version 2.13.2(2022-07-15)
-- Remove the qunhe brep api
-- Add KApplication Chinese comment
-- Add KPluginUIAndStorage Chinese comment
-
-# version 2.13.1(2022-02-23)
-- Added KEuler and KQuaternion.
-- Modified the return type of KGeomLib.faces2dBoolean.
-- Added some Chinese comments.
-- Add the KTestHelper class.
-- Add the getTestHelper method in the KApplication class.
-- Add the fillet method in the KDesign class.
-- Add the transformVertices in the KDesign class.
-- Added an API createAlignCCSMatrix4.
-- Add the getHoveredItem method in the KToolHelper class.
-- Add the loadMaterial method in the KDesign class.
-- Add the getBoundingBox method in the KGroupDefinition class.
-- Add the assignMaterialForFaces method in the KDesign class.
-- Add the assignMaterialForGroupInstance method in the KDesign class.
-- Add the isInExpressMode method in the KGroupDefinition class.
-- Add the setExcludedInferenceEntities method in the KToolHelper class.
-- Add the clearExcludedInferenceEntities method in the KToolHelper class.
-- The KApplication.onPluginClosed will be called after 200ms of closing plugin.
-- Add the closable param in the KToastOption.
-- Add the success method in the KToast.
-- Added parameter propagateContinuousEdge in the moveVertices method.
-- Remove the withMerge parameter in the moveVertices method.
-- Remove the withMerge parameter in the moveEdge method.
-- Remove the withMerge parameter in the transformShells method.
-- Make version consistent with KuDaShi.
-- Change KGeomLib.faces2dBoolean API.
-
-# version 1.0.26
-- Add the mergeFaces method in the KDesign class.
-- Add the bulkCopyGroupInstances method in the KDesign class.
-- Modify the createInstanceFromExternalResources method in the KDesign class.
-- Add the matchEntities method in the KGroupDefinition class.
-
-# version 1.0.25
-- Add the KApplicationObserver class, which provides additional utilities for KApplication.
-- Add the save method in the KDesign class.
-- Add the KToolHelper class, which provides additional utilities for KTool.
-- Add removeEdges and getEditPath two methods in the KDesign class.
-- Add isReversed method in the KFace and KHalfEdge classes.
-- Add drawPolylines method in KView class.
-- Add signedDistanceTo method in KSurface class.
-- Add isOnSameSide method in KVector3d class.
-
-## version 1.0.24
-- Add the KPickHelper class, which is used to pick entities.
-
-## version 1.0.23
-- Add the setSoftEdgesVisible method in the KDesign class.
-
-## version 1.0.22
-- modify parameters of the boolean method in the KDesign class.
-
-## version 1.0.21
-- Add the faceSplitByFace method in the KDesign class.
-- Add the faceSplitByGroup method in the KDesign class.
-- Add the createInstanceFromExternalResources method in the KDesign class.
-- Add the createShellFromMesh method in the KDesign class.
-
-## version 1.0.20
-- Rename the withMerge argument to beCopyToInstance in the copyFaces method in the KDesign class.
-- Add KApplicationUI interface to enable/disable tool bar, menu bar, resource panel, etc.
-- The copyFaces method in the KDesign class will return group instance if we set withMerge false.
-- Add the createEmptyGroupInstance method in the KDesign class.
-- Add the activateGroupInstance method in the KDesign class.
-- Add the deactivateGroupInstance method in the KDesign class.
-- Add the getDesignId method in the KDesign class.
-
-## version 1.0.19
-- Add the onKeyUp method in the KTool class.
-- Add the getUp method in the KCamera class.
-- Rename the 'getCameraMode' method in KCamera to 'getMode'.
-- Rename the 'getCameraPosition' method in KCamera to 'getPosition'.
-- Rename the 'getCameraTarget' method in KCamera to 'getTarget'.
-
-## version 1.0.18
-- Add the addFaces method in the KDesign class.
-- Add the setEdgesSoft method in the KDesign class.
-- Add the setVerticesSoft method in the KDesign class.
-- Add the boolean method in the KDesign class.
-- Add the offset method in the KDesign class.
-
-## version 1.0.17
-- Modify the KTool to support to get the inference entity and the inference instance path.
-
-## version 1.0.16
-- Rename KGeometry to KGeomLib.
-- Add the moveVertices method in the KDesign class.
-- Rename the 'onUseInference' method in KTool to 'allowUsingInference'.
-- Delete the 'startAngle' and 'endAngle' properties from the KArc3d and KArc2d classes.
-- The interfaces to get continuous edges and continuous faces infos are provided in the KEdge and KFace class.
-- The selection event is provided. You can create a selection observer to observe the selection change.
-- Drawing temporary interfaces in the KView class are provided, which can be use to draw temporary shaped in KTool.
-
-## version 1.0.15
-- The sweepFollowEdges and sweepFollowCurves methods will remove the face that the contour belongs to.
-- The sweepFollowEdges and sweepFollowCurves methods returns a new parameter 'addedShells'.
-
+# 酷大师api
+
+# api changelog
+
+# version 2.13.33(2025-06-24)
+- 支持KApplication.getProductManager获取酷家乐商品库管理器
+- 支持PublicProductLibrary公共商品库
+- sweepFollowEdges && sweepFollowCurves新增可选参数
+
+# version 2.13.32(2025-04-28)
+- support setPluginCursor and KAuxiliaryPiecewiseBezierCurve
+
+# version 2.13.31(2025-03-18)
+- 新增createPluginModelLibrary
+
+# version 2.13.30(2025-02-27)
+- 新增KArchFace, KArchWall, KArchRoom, KArchPillar, KArchOpening相关api
+- 新增KDesign.isShellSolid, KApplicationObserver.onGroupInstanceActivated, KApplicationObserver.onGroupInstanceDeactivated
+
+# version 2.13.29(2025-02-20)
+- 新增KGroupInstance.getInstanceParentGroupDefinition
+- 新增KDesign.getEditPathsToGroupInstance KDesign.activateEditPath KDesign.toggleEntitiesVisible
+- 新增isVisible判断模型是否可见
+
+# version 2.13.28(2025-02-11)
+- 支持三方插件存储模型库
+- 插件标题支持多语言机制，详情参考：https://manual.kujiale.com/kds-plugin-document/1.0.0/docs/tutorial/%E9%85%B7%E5%A4%A7%E5%B8%88%E6%8F%92%E4%BB%B6%E6%A0%BC%E5%BC%8F%E8%A6%81%E6%B1%82
+
+# version 2.13.27(2028-01-07)
+- KDesign.startOperation和KDesign.commitOperation之间的操作更加兼容undo/redo
+- KGroupInstance.setCustomProperty和KGroupDefinition.setCustomProperty兼容undo/redo
+- 增加KView.getModelSnapshot
+
+# version 2.13.26(2024-11-26)
+- 增加KTopoEdge.getKey()
+
+# version 2.13.25(2024-11-25)
+- 增加KSurface.getPoint()
+
+# version 2.13.25(2024-11-25)
+- 增加KSurface.getPoint()
+
+# version 2.13.24
+- deactivateGroupInstance改为异步
+
+# version 2.13.23
+- 个人库材质上传限制
+- 增加KDesign.inflateFaces
+
+# version 2.13.22
+- 增加KDesign.saveInstanceAsLibraryProject
+
+# version 2.13.21
+- 增加KApplicationUI.getSelectControlAxises
+- 增加KGroupInstance.getLocalBoundingBox
+
+# version 2.13.20
+- 增加KDesign.enterExpressMode
+
+# version 2.13.19
+- 支持插件multiViews
+
+# version 2.13.14(2023-0919)
+- 增加KPluginView接口对应multiViews中每个View
+- 增加一些apaas api
+    - KApplication.getPluginViewById
+    - KApplication.registerMessageHandler
+    - KApplication.unRegisterMessageHandler
+    - KApplicationUI.toggleSketchToolBar
+    - KApplicationUI.togglePropertyPanelVisibility
+    - KApplicationUI.switchToCurrentPluginAssetPanel
+    - KApplicationUI.injectMenuItems
+    - KApplicationUI.injectToolItems
+    - KApplicationUI.toggleMaterialReplacePanel
+    - KDesign.createInstanceFromAnotherProject
+    - KPluginView
+# version 2.13.12(2023-0718)
+- 增加了一些apaas api：
+    - KDesign.thickenFaces
+    - KDesign.uploadMaterial
+    - KTestHelper增加了turnOffShellValidation和undefineShellValidation命令
+
+# version 2.13.11(2023-07-0-7)
+- 在KDesign中增加了:
+    - exitExpressMode
+
+# version 2.13.10(2023-06-20)
+- 在KDesign中增加了:
+    - breakGroupReference
+    - reparentGroupInstance
+
+# version 2.13.9(2023-05-30)
+- 在KDesign中增加了:
+    - assignMaterialForEntities()
+    - assignDecorationMaterialForEntities()
+    - brushDecorationMaterialToEntities()
+    - editMaterialParamsOfFace()
+    - adjustMaterialMapping()
+    - clearMaterial()
+    - getFacePavingGroupByFace()
+- 在KCamera中增加了:
+    - setPosition()
+    - setTarget()
+- 在KPickHelper中增加了:
+    - pickByPoint3d()
+- 在KView中增加了:
+    - getScreenSnopShot()
+- 添加材质连续对象KFacePavingGroup
+
+# version 2.13.7(2023-05-18)
+- 在KFace中增加了：
+    - getCustomProperty()
+    - setCustomProperty()
+    - deleteCustomProperty()
+- 在KGroupDefinition和KGroupInstance中增加了：
+    - getCustomProperty()
+    - setCustomProperty()
+    - getAllCustomPropertiesKey()
+- 在KGroupInstance中增加了：
+    - isInvisible()
+- 在KDesign中增加了:
+    - shareModel()
+    - addFaceHoles()
+    - getMaterialOfFace()
+    - getMaterialParamsOfFace()
+    - findGroupInstancesByAppKey()
+    - findGroupInstancesByResource()
+    - toggleGroupInstancesVisible()
+    - alignShells()
+    - flipFace(face: KFace)
+- 在KApplicationObserver中增加了：
+    - onModelChanged()
+- 在KApplicationUI中增加了：
+    - toggleShowInvisibleModel()
+    - getActivePluginEntrancePosition()
+    - showPopover()
+    - isShownInvisibleModel()
+- 增加了枚举类型：
+    - KGroupDefinitionType.Variable来表示变量化成组
+- 在KTestHelper中增加了:
+    - purgeMaterialsInDesign()
+    - clearAllDecorationMaterials()
+- 更新了math的apaas api版本，引入了很多新类型：
+    - "@qunhe/math-apaas-api": "3.0.0",
+    - "@qunhe/math-apaas-impl": "3.0.0",
+- 修复了如下问题：
+    - boolean()没有导出KBooleanType类型的问题
+    - fillet()返回类型不能使用map类型的问题
+    - KSelection.getAllEntities()增加了默认参数，来控制是否包含vertex；默认为false保持和原来行为一致
+    - 吸附结果中添加了吸附点的normal值
+
+# version 2.13.6(2022-11-29)
+- Adjust the parameters of the following APIs:
+    - drawArrow3d
+    - drawCylinder
+
+# version 2.13.5(2022-11-28)
+- Add API:
+    - drawArrow3d
+    - getShortestPath
+
+# version 2.13.4(2022-11-01)
+- Add API:
+    - drawCylinder
+    - clearTemporaryShapesByIds
+    - getYunDesignInfo
+    - executeRequest
+- Rebuilding API, change the return value of the following API from boolean to "{ id: string }":
+    - drawPoints
+    - drawLines
+    - drawPolylines
+    - drawText
+    - drawPromptLine
+
+# version 2.13.3
+
+# version 2.13.2(2022-07-15)
+- Add KApplication Chinese comment
+- Add KPluginUIAndStorage Chinese comment
+
+# version 2.13.2(2022-07-15)
+- Remove the qunhe brep api
+- Add KApplication Chinese comment
+- Add KPluginUIAndStorage Chinese comment
+
+# version 2.13.1(2022-02-23)
+- Added KEuler and KQuaternion.
+- Modified the return type of KGeomLib.faces2dBoolean.
+- Added some Chinese comments.
+- Add the KTestHelper class.
+- Add the getTestHelper method in the KApplication class.
+- Add the fillet method in the KDesign class.
+- Add the transformVertices in the KDesign class.
+- Added an API createAlignCCSMatrix4.
+- Add the getHoveredItem method in the KToolHelper class.
+- Add the loadMaterial method in the KDesign class.
+- Add the getBoundingBox method in the KGroupDefinition class.
+- Add the assignMaterialForFaces method in the KDesign class.
+- Add the assignMaterialForGroupInstance method in the KDesign class.
+- Add the isInExpressMode method in the KGroupDefinition class.
+- Add the setExcludedInferenceEntities method in the KToolHelper class.
+- Add the clearExcludedInferenceEntities method in the KToolHelper class.
+- The KApplication.onPluginClosed will be called after 200ms of closing plugin.
+- Add the closable param in the KToastOption.
+- Add the success method in the KToast.
+- Added parameter propagateContinuousEdge in the moveVertices method.
+- Remove the withMerge parameter in the moveVertices method.
+- Remove the withMerge parameter in the moveEdge method.
+- Remove the withMerge parameter in the transformShells method.
+- Make version consistent with KuDaShi.
+- Change KGeomLib.faces2dBoolean API.
+
+# version 1.0.26
+- Add the mergeFaces method in the KDesign class.
+- Add the bulkCopyGroupInstances method in the KDesign class.
+- Modify the createInstanceFromExternalResources method in the KDesign class.
+- Add the matchEntities method in the KGroupDefinition class.
+
+# version 1.0.25
+- Add the KApplicationObserver class, which provides additional utilities for KApplication.
+- Add the save method in the KDesign class.
+- Add the KToolHelper class, which provides additional utilities for KTool.
+- Add removeEdges and getEditPath two methods in the KDesign class.
+- Add isReversed method in the KFace and KHalfEdge classes.
+- Add drawPolylines method in KView class.
+- Add signedDistanceTo method in KSurface class.
+- Add isOnSameSide method in KVector3d class.
+
+## version 1.0.24
+- Add the KPickHelper class, which is used to pick entities.
+
+## version 1.0.23
+- Add the setSoftEdgesVisible method in the KDesign class.
+
+## version 1.0.22
+- modify parameters of the boolean method in the KDesign class.
+
+## version 1.0.21
+- Add the faceSplitByFace method in the KDesign class.
+- Add the faceSplitByGroup method in the KDesign class.
+- Add the createInstanceFromExternalResources method in the KDesign class.
+- Add the createShellFromMesh method in the KDesign class.
+
+## version 1.0.20
+- Rename the withMerge argument to beCopyToInstance in the copyFaces method in the KDesign class.
+- Add KApplicationUI interface to enable/disable tool bar, menu bar, resource panel, etc.
+- The copyFaces method in the KDesign class will return group instance if we set withMerge false.
+- Add the createEmptyGroupInstance method in the KDesign class.
+- Add the activateGroupInstance method in the KDesign class.
+- Add the deactivateGroupInstance method in the KDesign class.
+- Add the getDesignId method in the KDesign class.
+
+## version 1.0.19
+- Add the onKeyUp method in the KTool class.
+- Add the getUp method in the KCamera class.
+- Rename the 'getCameraMode' method in KCamera to 'getMode'.
+- Rename the 'getCameraPosition' method in KCamera to 'getPosition'.
+- Rename the 'getCameraTarget' method in KCamera to 'getTarget'.
+
+## version 1.0.18
+- Add the addFaces method in the KDesign class.
+- Add the setEdgesSoft method in the KDesign class.
+- Add the setVerticesSoft method in the KDesign class.
+- Add the boolean method in the KDesign class.
+- Add the offset method in the KDesign class.
+
+## version 1.0.17
+- Modify the KTool to support to get the inference entity and the inference instance path.
+
+## version 1.0.16
+- Rename KGeometry to KGeomLib.
+- Add the moveVertices method in the KDesign class.
+- Rename the 'onUseInference' method in KTool to 'allowUsingInference'.
+- Delete the 'startAngle' and 'endAngle' properties from the KArc3d and KArc2d classes.
+- The interfaces to get continuous edges and continuous faces infos are provided in the KEdge and KFace class.
+- The selection event is provided. You can create a selection observer to observe the selection change.
+- Drawing temporary interfaces in the KView class are provided, which can be use to draw temporary shaped in KTool.
+
+## version 1.0.15
+- The sweepFollowEdges and sweepFollowCurves methods will remove the face that the contour belongs to.
+- The sweepFollowEdges and sweepFollowCurves methods returns a new parameter 'addedShells'.
+

package/api.d.ts

@@ -1,4 +1,4 @@
-// version: 2.13.30
+// version: 2.13.33
 
 declare global {
     /**
@@ -450,11 +450,20 @@ declare global {
          *
          * 获取插件模型库帮助器，包含模型公库和私库
          *
-         * Get the KPluginModelLibraryHelper object.
+         * Get the plugin model library helper, covering both public and private model library.
          * @returns The KPluginModelLibraryHelper object.
          */
         getPluginModelLibraryHelper(): KPluginModelLibraryHelper;
 
+        /**
+         *
+         * 获取酷家乐商品库管理器
+         *
+         * get the product library manager
+         *
+         */
+        getProductManager(): ProductManager;
+
         /**
          *
          * 将沙盒代码中的自定义消息处理函数注册到酷大师
@@ -735,6 +744,17 @@ declare global {
          * @returns current axises of SelectControl: [axisX, axisY, axisZ]
          */
         getSelectControlAxises(): KVector3d[] | undefined;
+
+        /**
+         *
+         * 设置鼠标icon样式，仅在CustomTool激活时生效
+         *
+         * Set the mouse icon style to take effect only when CustomTool is active
+         *
+         * @param icon icon svg string such as <svg>content</svg>
+         *
+         */
+        setCursorIcon(icon: string): boolean;
     }
 
     /*
@@ -1161,6 +1181,59 @@ declare global {
         isVisible(): boolean;
     }
 
+    /*
+     *  KAuxiliaryPiecewiseBezierCurve.ts
+     *  Copyright 2025 Qunhe Tech, all rights reserved.
+     *  Qunhe PROPRIETARY/CONFIDENTIAL, any form of usage is subject to approval.
+     */
+    /**
+     *
+     * 贝塞尔贝塞尔参考线对象。即用户在酷大师界面中，用“贝塞尔曲线段”命令画出的贝塞尔参考线，由多条顺次连接的贝塞尔曲线生成
+     *
+     * The KAuxiliaryPiecewiseBezierCurve class represents the piecewise auxiliary curve which is composed of multiple sequentially connected Bézier curves.
+     */
+    interface KAuxiliaryPiecewiseBezierCurve extends KAuxiliaryCurve {
+
+        /**
+         *
+         * 获取贝塞尔参考线的离散点集
+         *
+         * Get discrete points of KAuxiliaryPiecewiseBezierCurve
+         *
+         */
+        getPoints(): KPoint3d[];
+
+        /**
+         *
+         * 获取贝塞尔参考线的起始顶点
+         *
+         * Get the auxiliary vertex at the start of the KAuxiliaryPiecewiseBezierCurve.
+         * NOTE: Even if the KAuxiliaryPiecewiseBezierCurve is not connected to other KAuxiliaryPiecewiseBezierCurves at the start,
+         * we can still get the auxiliary vertex.
+         * @returns The auxiliary vertex at the start of the KAuxiliaryPiecewiseBezierCurve.
+         */
+        getStartVertex(): KAuxiliaryVertex;
+
+        /**
+         *
+         * 获取贝塞尔参考线的终止顶点
+         *
+         * Get the auxiliary vertex at the end of the KAuxiliaryPiecewiseBezierCurve.
+         * NOTE: Even if the KAuxiliaryPiecewiseBezierCurve is not connected to other KAuxiliaryPiecewiseBezierCurves at the end,
+         * we can still get the auxiliary vertex.
+         * @returns The auxiliary vertex at the end of the KAuxiliaryPiecewiseBezierCurve.
+         */
+        getEndVertex(): KAuxiliaryVertex;
+
+        /**
+         *
+         * 获取该贝塞尔参考线是否可见
+         *
+         * Get the KAuxiliaryPiecewiseBezierCurve property of it is visible or not.
+         */
+        isVisible(): boolean;
+    }
+
     /*
      *  KAuxiliaryVertex.ts
      *  Copyright 2022 Qunhe Tech, all rights reserved.
@@ -1176,7 +1249,7 @@ declare global {
      * Through the auxiliary vertex you can get all auxiliary bounded curves connected through this vertex.
      * If you move the auxiliary point, all auxiliary bounded curves connected through this vertex will also be moved.
      */
-    interface KAuxiliaryVertex extends KEntity{
+    interface KAuxiliaryVertex extends KEntity {
         /**
          *
          * 获取唯一标识符
@@ -1197,12 +1270,12 @@ declare global {
 
         /**
          *
-         * 获取相邻的参考线段
+         * 获取相邻的参考线
          *
-         * Get all auxiliary bounded curves connected through this vertex.
-         * @returns An array of bounded curves connected through this vertex.
+         * Get all auxiliary curves connected through this vertex.
+         * @returns An array of curves connected through this vertex.
          */
-        getAuxiliaryBoundedCurve(): KAuxiliaryBoundedCurve[];
+        getNeighborCurves(): KAuxiliaryCurve[];
     }
 
     /*
@@ -1689,9 +1762,9 @@ declare global {
          * The method is used to move the auxiliary vertex to the target position.
          * @param auxiliaryVertex The auxiliary vertex to move.
          * @param targetPosition The target position.
-         * @returns Return an object that contains moved auxiliary bounded curves if successful, otherwise return null.
+         * @returns Return an object that contains moved auxiliary curves if successful, otherwise return null.
          */
-        moveAuxiliaryVertex(auxiliaryVertex: KAuxiliaryVertex, targetPosition: KPoint3d): { movedCurves: KAuxiliaryBoundedCurve[] } | null;
+        moveAuxiliaryVertex(auxiliaryVertex: KAuxiliaryVertex, targetPosition: KPoint3d): { movedCurves: KAuxiliaryCurve[] } | null;
 
         /**
          *
@@ -1766,9 +1839,21 @@ declare global {
          * NOTE: The method will remove the face that the contour belongs to.
          * @param contour The face's contour.
          * @param path An array of edges to follow.
+         * @param sweepWithPathAlignmentParams Optional parameters for path alignment, including
+         *  - contourCCS: Coordinate system defining the local space of the profile contour.
+         *                  Specifies the origin, x-axis, and y-axis of the profile's local coordinate system before path alignment.
+         *  - pathStartSeg: Line segment on the path where the sweep operation begins.
+         *                  This segment determines the initial position and orientation for aligning the profile to the path.
+         *                  It's the Z-axis of the path's local coordinate system.
+         *  - pathXAxis: Vector defining the desired X-axis direction in the path coordinate system.
+         *              This vector, combined with the path direction, determines how the profile is oriented along the path.
          * @returns Return an object that contains success flag and added shells.
          */
-        sweepFollowEdges(contour: KLoop, path: KEdge[]): { isSuccess: boolean, addedShells: KShell[] };
+        sweepFollowEdges(contour: KLoop, path: KEdge[], sweepWithPathAlignmentParams?: {
+            contourCCS: KCCS3d;
+            pathStartSeg: KLineSegment3d;
+            pathXAxis: KVector3d;
+        }): { isSuccess: boolean, addedShells: KShell[] };
 
         /**
          *
@@ -1778,10 +1863,22 @@ declare global {
          * The method is used to create a shape by making the face follow along an array of auxiliary bounded curves.
          * NOTE: The method will remove the face that the contour belongs to.
          * @param contour The face's contour.
-         * @param path An array of auxiliary bounded curves to follow.
+         * @param path An array of auxiliary bounded curves or auxiliary piecewise bezier curves to follow.
+         * @param sweepWithPathAlignmentParams Optional parameters for path alignment, including
+         *  - contourCCS: Coordinate system defining the local space of the profile contour.
+         *                  Specifies the origin, x-axis, and y-axis of the profile's local coordinate system before path alignment.
+         *  - pathStartSeg: Line segment on the path where the sweep operation begins.
+         *                  This segment determines the initial position and orientation for aligning the profile to the path.
+         *                  It's the Z-axis of the path's local coordinate system.
+         *  - pathXAxis: Vector defining the desired X-axis direction in the path coordinate system.
+         *              This vector, combined with the path direction, determines how the profile is oriented along the path.
          * @returns Return an object that contains success flag and added shells.
          */
-        sweepFollowCurves(contour: KLoop, path: KAuxiliaryBoundedCurve[]): { isSuccess: boolean, addedShells: KShell[] };
+        sweepFollowCurves(contour: KLoop, path: KAuxiliaryCurve[], sweepWithPathAlignmentParams?: {
+            contourCCS: KCCS3d;
+            pathStartSeg: KLineSegment3d;
+            pathXAxis: KVector3d;
+        }): { isSuccess: boolean, addedShells: KShell[] };
 
         /**
          *
@@ -2491,6 +2588,15 @@ declare global {
          * @param shell
          */
         isShellSolid(shell: KShell): boolean;
+
+        /**
+         * 通过商品模型创建资源成组
+         *
+         * create one groupInstance from brandgood, the type of groupDefinition for groupInstance created in this way is 'KGroupDefinitionType.Asset'.
+         * @param brandgoodId brandgood id
+         * @returns the newInstance or undefined.
+         */
+        createInstanceFromBrandgood(brandgoodId: string): HostPromise<{ newInstance: KGroupInstance } | undefined>;
     }
 
 
@@ -2630,13 +2736,17 @@ declare global {
          * KAuxiliaryVertex Type.
          */
         AuxiliaryVertex = 'auxiliaryVertex',
+        /**
+         * KAuxiliaryPiecewiseBezierCurve Type.
+         */
+        AuxiliaryPiecewiseBezierCurve = 'auxiliaryPiecewiseBezierCurve',
     }
     /**
      * 酷大师图形实体类型
      */
     type KEntityType = KTopoType | KAppEntityType;
     // https://github.com/microsoft/TypeScript/issues/17592
-    const KEntityType = {...KTopoType, ...KAppEntityType};
+    const KEntityType = { ...KTopoType, ...KAppEntityType };
 
     /**
      * 酷大师图形实体的基类
@@ -2883,6 +2993,13 @@ declare global {
          * It means the definition is based on a variable model, such as Cube/Sphere/Text3d/Bend, etc.
          */
         Variable = 'variable',
+        /**
+         * 资源成组
+         *
+         * Asset Type
+         * It means the definition is based on a asset model, such as brandgood model, etc.
+         */
+        Asset = 'asset',
     }
 
     /**
@@ -5993,6 +6110,39 @@ declare global {
         isOverlapping(other: KBoundingBox3d, tolerance?: number): boolean;
     }
 
+    /**
+     * Represents a 3D coordinate system.
+     * Provides access to the origin and axis vectors, as well as transformation methods.
+     */
+    interface KCCS3d {
+        /** The origin point of the coordinate system. */
+        origin: KPoint3d;
+        /** The X-axis direction vector of the coordinate system. */
+        dx: KVector3d;
+        /** The Y-axis direction vector of the coordinate system. */
+        dy: KVector3d;
+        /** The Z-axis direction vector of the coordinate system. */
+        dz: KVector3d;
+        /**
+         * Gets the transformation matrix from world to local coordinates.
+         */
+        getWorldToLocalMatrix(): KMatrix4;
+        /**
+         * Gets the transformation matrix from local to world coordinates.
+         */
+        getLocalToWorldMatrix(): KMatrix4;
+        /**
+         * Applies a transformation to this coordinate system in place.
+         * @param matrix The transformation matrix to apply.
+         */
+        transform(matrix: KMatrix4): boolean;
+        /**
+         * Returns a new KCCS3d instance transformed by the given matrix.
+         * @param matrix The transformation matrix to apply.
+         */
+        transformed(matrix: KMatrix4): KCCS3d;
+    }
+
     /**
      * KCircle2d类代表着二维空间中的一个圆。
      *
@@ -7485,6 +7635,28 @@ declare global {
          * The transformation matrix.
          */
         createAlignCCSMatrix4(x: KVector3d, y: KVector3d, z: KVector3d, origin: KPoint3d): KMatrix4;
+        /**
+         * 创建一个三维坐标系对象。
+         *
+         * Creates an instance of KCCS3d.
+         * 
+         * @param origin
+         * 三维坐标系的原点。
+         * The origin point of the 3D coordinate system.
+         * 
+         * @param dx
+         * 三维坐标系的X轴方向向量。
+         * The X-axis direction vector of the 3D coordinate system.
+         * 
+         * @param dy
+         * 三维坐标系的Y轴方向向量。
+         * The Y-axis direction vector of the 3D coordinate system.
+         * 
+         * @returns
+         * 三维坐标系对象。
+         * The 3D coordinate system object.
+         */
+        createCCS3d(origin: KPoint3d, dx: KVector3d, dy: KVector3d): KCCS3d;
         /**
          * 创建一个KLine2d对象。
          *
@@ -11271,6 +11443,59 @@ declare global {
     }
 
 
+    // QunHe Product API:
+    /**
+     *
+     * 酷家乐商品库管理器
+     *
+     * The product manager.
+     */
+    interface ProductManager {
+        /**
+         *
+         * 获取公共商品库
+         *
+         * Get public product library.
+         * @returns The public product library.
+         */
+        getPublicProductLibrary: () => PublicProductLibrary;
+    }
+
+    /**
+     *
+     * 酷家乐公共商品库
+     *
+     * The public product library.
+     */
+    interface PublicProductLibrary {
+        /**
+         *
+         * 获取公共商品库类目
+         *
+         * Get category list of public product.
+         * @returns The category id and name.
+         */
+        getCategory: () => Promise<{ categoryId: number; name: string }[] | undefined>;
+        /**
+         *
+         * 获取某一类目下的商品列表
+         *
+         * Get product list of a category.
+         * @param categoryId category id
+         * @param start start
+         * @param count count
+         * @param lang the language
+         * @returns The brandgoodId, name and previewImgUrl.
+         */
+        getProductList: (
+            categoryId: number,
+            start: number,
+            count: number,
+            lang?: string
+        ) => Promise<{ brandgoodId: string; name: string; previewImgUrl: string }[] | undefined>;
+    }
+
+
 }
 
 export {}

package/package.json

@@ -1,18 +1,18 @@
-{
-  "name": "@kudashi/kds-api",
-  "version": "2.13.31",
-  "description": "kds api",
-  "main": "api.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "typings": "api.d.ts",
-  "files": [
-    "api.d.ts"
-  ],
-  "keywords": [
-    "kds"
-  ],
-  "author": "kds",
-  "license": "ISC"
-}
+{
+  "name": "@kudashi/kds-api",
+  "version": "2.13.33",
+  "description": "kds api",
+  "main": "api.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "typings": "api.d.ts",
+  "files": [
+    "api.d.ts"
+  ],
+  "keywords": [
+    "kds"
+  ],
+  "author": "kds",
+  "license": "ISC"
+}