@buerli.io/headless 0.5.0-beta.2 → 0.5.0-beta.4

package/build/types/history.d.ts

@@ -1,6 +1,6 @@
-import { BooleanOperationType, ChamferType, FlipType, ReorientedType, WorkAxisType, WorkCoordSystemType, WorkPlaneType, WorkPointType, ViewType, OrientationType, ExtrusionType, BrepElemType, SVGModusType } from '@buerli.io/classcad';
+import { BooleanOperationType, ChamferType, FlipType, ReorientedType, WorkAxisType, WorkCoordSystemType, WorkPlaneType, WorkPointType, ViewType, OrientationType, ExtrusionType, BrepElemType, WorkGeomType, SVGModusType, LimitsParam, LimitedValue } from '@buerli.io/classcad';
 import { ObjectID, PointMemValue } from '@buerli.io/core';
-import { BufferGeometry, Scene } from 'three';
+import { BufferGeometry, Group, Mesh, Scene } from 'three';
 /**
  * History based modeling is similar to solid modeling, but it is non-destructive and
  * parametric. You can move back and forth in the modeling history and create feature
@@ -25,39 +25,13 @@ import { BufferGeometry, Scene } from 'three';
  */
 export declare type ApiHistory = {
     /**
-     * Adds the product template as a node to an assembly.
+     * Adds multiple products as nodes to an existing assembly at once
+     * @param nodes array of node parameter objects. See following descriptions.
      * @param productId id of the product template to add
      * @param ownerId id of the owner where the product template will be added to
      * @param transformation transformation of the product template in x-, y- and z-axis
      * @param name optional name for adding node
-     * @example
-     * // Defines some consts
-     * const orig = { x: 0, y: 0, z: 0 }
-     * const xDir = { x: 1, y: 0, z: 0 }
-     * const yDir = { x: 0, y: 1, z: 0 }
-     * const rot = { x: 0, y: 0, z: 0 }
-     * const offset = { x: 20, y: 0, z: 0 }
-     *
-     * // Creates the root assembly first
-     * const rootAsm = await api.createRootAssembly('Root_Assembly')
-     *
-     * // Creates a part template and adds geometry to it
-     * const partTempl = await api.createPartAsTemplate('Part_Template')
-     * const wcs = await api.createWorkCoordSystem(partTempl, 'Custom', [], offset, rot, 0, false, 'wcs')
-     * api.box(partTempl, [wcs], 30, 30, 10)
-     *
-     * // Adds the created part template as a node to the root assembly
-     * const partRef = await api.addNode(partTempl, rootAsm, [orig, xDir, yDir])
-     * const geoms = await api.createBufferGeometry(rootAsm)
-     * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image /doc/assets/history/addNode.jpg
-     */
-    addNode: (productId: VID, ownerId: VID, transformation: Transform, name?: string) => ID;
-    /**
-     * Adds multiple products as nodes to an existing assembly at once
-     * @param nodes array of node parameter objects. See also addNode().
      * @example // tbd
-     * @image // tbd
      */
     addNodes: (...nodes: {
         productId: VID;
@@ -65,34 +39,6 @@ export declare type ApiHistory = {
         transformation: Transform;
         name?: string;
     }[]) => Promise<ObjectID[] | null>;
-    /**
-     * Adds a dimension to the product in the 3D view
-     * @param dimension dimension to be added to a product
-     * @example
-     * // Get the current product
-     * const productId = await api.getCurrentProduct()
-     *
-     * // Create a dimension
-     * const dimension: DimensionType = {
-     *   productId: productId,
-     *   dimParam: {
-     *     dimType: 'LinearDimension',
-     *     dimLabel: 'Breite = ',
-     *     dimStartPos: { x: 0, y: 0, z: 0 },
-     *     dimEndPos: { x: 100, y: 0, z: 0 },
-     *     dimTextPos: { x: 50, y: -10, z: 0 },
-     *     dimTextAngle: 0,
-     *     dimOrientation: 'Horizontal',
-     *   },
-     *   dxfView: 'Top',
-     * }
-     *
-     * // Add the dimension
-     * const dimensionId = await api.addDimension(dimension)
-     * @image // tbd
-     * @return id of the added dimension
-     */
-    addDimension: (dimension: DimensionType) => ID;
     /**
      * Adds multiple dimensions to products in the 3D view
      * @param dimensions dimensions to be added to products
@@ -131,7 +77,6 @@ export declare type ApiHistory = {
      *
      * // Add the dimensions
      * const dimensionIds = await api.addDimensions(dimension1, dimension2)
-     * @image // tbd
      * @return array of ids of the added dimensions
      */
     addDimensions: (...dimensions: {
@@ -165,7 +110,6 @@ export declare type ApiHistory = {
      *
      * // Create the wanted views
      * await api.create2DViews(productId, [ViewType.TOP, ViewType.RIGHT_90, ViewType.ISO], { color: 2, layer: '6'})
-     * @image // tbd
      */
     create2DViews: (productId: VID, viewTypes: ViewType[], viewOptions?: ViewOptionsType) => IDs;
     /**
@@ -178,7 +122,6 @@ export declare type ApiHistory = {
      *
      * // Returns for each view a min and max point
      * console.info(bbs) // [[{x: -105, y: -89, z: 0}, {x: 105, y: 55, z: 0}], [...], [...]]
-     * @image // tbd
      */
     getBoundaryBoxFromViews: (productId: VID, viewTypes?: ViewType[]) => Promise<[PointMemValue, PointMemValue][]>;
     /**
@@ -191,7 +134,6 @@ export declare type ApiHistory = {
      *   { viewType: 'Iso', vector: { x: 500, y: 500, z: 0 } },
      *   { viewType: 'Right_90°', vector: { x: 500, y: 0, z: 0 } },
      * ])
-     * @image // tbd
      */
     place2DViews: (productId: VID, viewPositions: {
         viewType: ViewType;
@@ -205,7 +147,6 @@ export declare type ApiHistory = {
      * // After creating and placing the views, see place2DViews(), you can export them
      * // You will get the dxf stream back
      * await api.exportDXF(productId)
-     * @image // tbd
      */
     exportDXF: (productId: VID, dxfTemplateFilename?: string) => Promise<Uint8Array | null>;
     /**
@@ -223,7 +164,6 @@ export declare type ApiHistory = {
      * // After creating and placing the views, see place2DViews(), you can export them
      * // You will get the svg stream back
      * await api.exportSVG(productId)
-     * @image // tbd
      */
     exportSVG: (productId: VID, modus?: SVGModusType, renderSize?: {
         x: number;
@@ -235,7 +175,6 @@ export declare type ApiHistory = {
      * @example
      * // You can remove existing dimensions
      * await api.removeDimensions(dimensionIds)
-     * @image // tbd
      */
     removeDimensions: (dimensionIds: VID[]) => Promise<void>;
     /**
@@ -306,7 +245,6 @@ export declare type ApiHistory = {
      * api.boolean(part, BooleanOperationType.Subtraction, [box, cyl])
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image /doc/assets/history/boolean.jpg
      */
     boolean: (partId: VID, type: BooleanOperationType, entities: VID[]) => ID;
     /**
@@ -322,7 +260,6 @@ export declare type ApiHistory = {
      * const box = api.box(part, [], 20, 20, 20)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image /doc/assets/history/box.jpg
      */
     box: (partId: VID, references: VID[], width: number | string, length: number | string, height: number | string) => ID;
     /**
@@ -337,7 +274,6 @@ export declare type ApiHistory = {
      * api.cylinder(part, [], 20, 50)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image /doc/assets/history/cylinder.jpg
      */
     cylinder: (partId: VID, references: VID[], diameter: number | string, height: number | string) => ID;
     /**
@@ -356,7 +292,6 @@ export declare type ApiHistory = {
      * api.chamfer(part, ChamferType.Equal_Distance, bottomEdges, 2, 0, 0)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     chamfer: (partId: VID, type: ChamferType, references: VIDs, dist1: number | string, dist2: number | string, angle: number | string) => ID;
     /**
@@ -372,11 +307,10 @@ export declare type ApiHistory = {
      * api.cone(part, [], 20, 0, 20)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image /doc/assets/history/cone.jpg
      */
     cone: (partId: VID, references: VID[], bDiameter: number | string, tDiameter: number | string, height: number | string) => ID;
     /**
-     * Creates a fastened constraint between two mates of an assembly.
+     * Creates a fastened constraint between mate1 and mate2 within an assembly.
      * @param asmId id of the assembly to create constraints on
      * @param mate1 contains the mate path ids to its 1st part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
      * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
@@ -416,61 +350,22 @@ export declare type ApiHistory = {
      * await api.createFastenedConstraint(rootAsm, { matePath: [prt1], wcsId: wcs3 }, { matePath: [prt2], wcsId: wcs2 }, 0, 0, 0, 0, 0, 'FC')
      * const geoms = await api.createBufferGeometry(rootAsm)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image /doc/assets/history/fastenedConstraint.jpg
-     */
-    createFastenedConstraint: (asmId: VID, mate1: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: FlipType;
-        reoriented: ReorientedType;
-    }, mate2: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: FlipType;
-        reoriented: ReorientedType;
-    }, xOffset: number | string, yOffset: number | string, zOffset: number | string, name: string) => Promise<ObjectID | null>;
-    /**
-     * Updates a fastened constraint.
-     * @param constrId id of the constraint to update
+     */
+    createFastenedConstraint: (asmId: VID, mate1: MateParam, mate2: MateParam, xOffset: number | string, yOffset: number | string, zOffset: number | string, name: string) => Promise<ObjectID | null>;
+    /**
+     * Updates multiple fastened constraints
+     * @param constraints array of constraint parameter objects. See following descriptions.
      * @param mate1 contains the mate path ids to its 1st part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
      * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
      * @param xOffset defines a offset in x-axis from mate1 to mate2
      * @param yOffset defines a offset in y-axis from mate1 to mate2
      * @param zOffset defines a offset in z-axis from mate1 to mate2
      * @example // tbd
-     * @image // tbd
-     */
-    updateFastenedConstraint: (constrId: VID, mate1: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: FlipType;
-        reoriented: ReorientedType;
-    }, mate2: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: FlipType;
-        reoriented: ReorientedType;
-    }, xOffset: number | string, yOffset: number | string, zOffset: number | string) => Promise<void>;
-    /**
-     * Updates multiple fastened constraints
-     * @param constraints array of constraint parameter objects
-     * @example // tbd
-     * @image // tbd
      */
     updateFastenedConstraints: (...constraints: {
         constrId: VID;
-        mate1: {
-            matePath: VID[];
-            wcsId: VID;
-            flip: number;
-            reoriented: number;
-        };
-        mate2: {
-            matePath: VID[];
-            wcsId: VID;
-            flip: number;
-            reoriented: number;
-        };
+        mate1: MateParam;
+        mate2: MateParam;
         xOffset: number | string;
         yOffset: number | string;
         zOffset: number | string;
@@ -509,47 +404,186 @@ export declare type ApiHistory = {
      *
      * const geoms = await api.createBufferGeometry(rootAsm)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial({ transparent: true, opacity: 0.5 })))
-     * @image /doc/assets/history/fastenedOriginConstraint.jpg
      */
-    createFastenedOriginConstraint: (asmId: VID, mate1: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: FlipType;
-        reoriented: ReorientedType;
-    }, xOffset: number | string, yOffset: number | string, zOffset: number | string, name: string) => Promise<ObjectID | null>;
+    createFastenedOriginConstraint: (asmId: VID, mate1: MateParam, xOffset: number | string, yOffset: number | string, zOffset: number | string, name: string) => Promise<ObjectID | null>;
     /**
-     * Updates a fastened origin constraint.
-     * @param constrId id of the constraint to update
+     * Updates multiple fastened origin constraints
+     * @param constraints array of constraint parameter objects. See following descriptions.
      * @param mate1 contains the mate path ids to its 1st part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
      * @param xOffset defines a offset in x-axis from mate1 to mate2
      * @param yOffset defines a offset in y-axis from mate1 to mate2
      * @param zOffset defines a offset in z-axis from mate1 to mate2
      * @example // tbd
-     * @image // tbd
      */
-    updateFastenedOriginConstraint: (constrId: VID, mate1: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: FlipType;
-        reoriented: ReorientedType;
-    }, xOffset: number | string, yOffset: number | string, zOffset: number | string) => Promise<void>;
+    updateFastenedOriginConstraints: (...constraints: {
+        constrId: VID;
+        mate1: MateParam;
+        xOffset: number | string;
+        yOffset: number | string;
+        zOffset: number | string;
+    }[]) => Promise<void>;
     /**
-     * Updates multiple fastened origin constraints
-     * @param constraints array of constraint parameter objects
+     * Creates a cylindrical constraint between mate1 and mate2 within an assembly.
+     * @param asmId id of the assembly to create constraints on
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param zOffsetLimits min and max value of offset along z
+     * @param zRotationLimits min and max value of rotation around z
+     * @param name name of the constraint
      * @example // tbd
-     * @image // tbd
      */
-    updateFastenedOriginConstraints: (...constraints: {
+    createCylindricalConstraint: (asmId: VID, mate1: MateParam, mate2: MateParam, zOffsetLimits: LimitsParam, zRotationLimits: LimitsParam, name: string) => Promise<ObjectID | null>;
+    /**
+     * Updates multiple cylindrical constraints.
+     * @param constraints array of constraint parameter objects. See following descriptions.
+     * @param constrId id of the constraint to update
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param zOffsetLimits min and max value of offset along z
+     * @param zRotationLimits min and max value of rotation around z
+     * @example // tbd
+     */
+    updateCylindricalConstraints: (...constraints: {
         constrId: VID;
-        mate1: {
-            matePath: VID[];
-            wcsId: VID;
-            flip: number;
-            reoriented: number;
-        };
+        mate1: MateParam;
+        mate2: MateParam;
+        zOffsetLimits: LimitsParam;
+        zRotationLimits: LimitsParam;
+    }[]) => Promise<void>;
+    /**
+     * Creates a revolute constraint between mate1 and mate2 within an assembly.
+     * @param asmId id of the assembly to create constraints on
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param zOffset defines a offset in z-axis from mate1 to mate2
+     * @param zRotationLimits min and max value of rotation around z
+     * @param name name of the constraint
+     * @example // tbd
+     */
+    createRevoluteConstraint: (asmId: VID, mate1: MateParam, mate2: MateParam, zOffset: number | string, zRotationLimits: LimitsParam, name: string) => Promise<ObjectID | null>;
+    /**
+     * Updates multiple revolute constraints.
+     * @param constraints array of constraint parameter objects. See following descriptions.
+     * @param constrId id of the constraint to update
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param zOffset defines a offset in z-axis from mate1 to mate2
+     * @param zRotationLimits min and max value of rotation around z
+     * @example // tbd
+     */
+    updateRevoluteConstraints: (...constraints: {
+        constrId: VID;
+        mate1: MateParam;
+        mate2: MateParam;
+        zOffset: number | string;
+        zRotationLimits: LimitsParam;
+    }[]) => Promise<void>;
+    /**
+     * Creates a slider constraint between mate1 and mate2 within an assembly.
+     * @param asmId id of the assembly to create constraints on
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param xOffset defines a offset in x-axis from mate1 to mate2
+     * @param yOffset defines a offset in y-axis from mate1 to mate2
+     * @param zOffsetLimits min and max value of offset along z
+     * @param name name of the constraint
+     * @example // tbd
+     */
+    createSliderConstraint: (asmId: VID, mate1: MateParam, mate2: MateParam, xOffset: number | string, yOffset: number | string, zOffsetLimits: LimitsParam, name: string) => Promise<ObjectID | null>;
+    /**
+     * Updates multiple slider constraints.
+     * @param constraints array of constraint parameter objects. See following descriptions.
+     * @param constrId id of the constraint to update
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param xOffset defines a offset in x-axis from mate1 to mate2
+     * @param yOffset defines a offset in y-axis from mate1 to mate2
+     * @param zOffsetLimits min and max value of offset along z
+     * @example // tbd
+     */
+    updateSliderConstraints: (...constraints: {
+        constrId: VID;
+        mate1: MateParam;
+        mate2: MateParam;
         xOffset: number | string;
         yOffset: number | string;
+        zOffsetLimits: LimitsParam;
+    }[]) => Promise<void>;
+    /**
+     * Creates a planar constraint between mate1 and mate2 within an assembly.
+     * @param asmId id of the assembly to create constraints on
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param zOffset defines a offset in z-axis from mate1 to mate2
+     * @param xOffsetLimits min and max value of offset along x
+     * @param yOffsetLimits min and max value of offset along y
+     * @param zRotationLimits min and max value of rotation around z
+     * @param name name of the constraint
+     * @example // tbd
+     */
+    createPlanarConstraint: (asmId: VID, mate1: MateParam, mate2: MateParam, zOffset: number | string, xOffsetLimits: LimitsParam, yOffsetLimits: LimitsParam, zRotationLimits: LimitsParam, name: string) => Promise<ObjectID | null>;
+    /**
+     * Updates multiple planar constraints.
+     * @param constraints array of constraint parameter objects. See following descriptions.
+     * @param constrId id of the constraint to update
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param zOffset defines a offset in z-axis from mate1 to mate2
+     * @param xOffsetLimits min and max value of offset along x
+     * @param yOffsetLimits min and max value of offset along y
+     * @param zRotationLimits min and max value of rotation around z
+     * @example // tbd
+     */
+    updatePlanarConstraints: (...constraints: {
+        constrId: VID;
+        mate1: MateParam;
+        mate2: MateParam;
         zOffset: number | string;
+        xOffsetLimits: LimitsParam;
+        yOffsetLimits: LimitsParam;
+        zRotationLimits: LimitsParam;
+    }[]) => Promise<void>;
+    /**
+     * Creates a parallel constraint between mate1 and mate2 within an assembly.
+     * @param asmId id of the assembly to create constraints on
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param xOffsetLimits min and max value of offset along x
+     * @param yOffsetLimits min and max value of offset along y
+     * @param zOffsetLimits min and max value of offset along z
+     * @param zRotationLimits min and max value of rotation around z
+     * @param name name of the constraint
+     * @example // tbd
+     */
+    createParallelConstraint: (asmId: VID, mate1: MateParam, mate2: MateParam, xOffsetLimits: LimitsParam, yOffsetLimits: LimitsParam, zOffsetLimits: LimitsParam, zRotationLimits: LimitsParam, name: string) => Promise<ObjectID | null>;
+    /**
+     * Updates multiple parallel constraints.
+     * @param constraints array of constraint parameter objects. See following descriptions.
+     * @param constrId id of the constraint to update
+     * @param mate1 contains the mate path ids to its part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param mate2 contains the mate path ids to its 2nd part and its work coordinate system id, and also the flip (0-5) and reoriented (0-3) states
+     * @param xOffsetLimits min and max value of offset along x
+     * @param yOffsetLimits min and max value of offset along y
+     * @param zOffsetLimits min and max value of offset along z
+     * @param zRotationLimits min and max value of rotation around z
+     * @example // tbd
+     */
+    updateParallelConstraints: (...constraints: {
+        constrId: VID;
+        mate1: MateParam;
+        mate2: MateParam;
+        xOffsetLimits: LimitsParam;
+        yOffsetLimits: LimitsParam;
+        zOffsetLimits: LimitsParam;
+        zRotationLimits: LimitsParam;
+    }[]) => Promise<void>;
+    /**
+     * Updates limited value specified (with 'paramName') of multiple constraints
+     */
+    update3dConstraintValues: (...constrValues: {
+        constrId: VID;
+        paramName: LimitedValue;
+        value: number;
     }[]) => Promise<void>;
     /**
      * Creates the buffer geometry of the product (part or assembly).
@@ -560,21 +594,25 @@ export declare type ApiHistory = {
      * api.cone(part, [], 20, 0, 30)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     createBufferGeometry: (productId: VID) => Promise<BufferGeometry[] | undefined>;
     /**
      * Creates ThreeJS scene from current product
      * @param productId id of the product to create scene from
      * @param options optional object to define different settings.
-     * @param meshPerFace boolean flag to define if a part/solid will have a mesh for each face
-     * or if the faces will be combined to one mesh
+     * @param meshPerGeometry boolean flag to define if a part/solid will have a mesh for each
+     * geometry element or if the elements will be merged to one mesh
+     * @return object containing all the created THREE objects like scene, nodes, solids and meshes
      * @example // tbd
-     * @image // tbd
      */
     createScene: (productId: VID, options?: {
-        meshPerFace?: boolean;
-    }) => Promise<Scene>;
+        meshPerGeometry?: boolean;
+    }) => Promise<{
+        scene: Scene;
+        nodes: Group[];
+        solids: Group[];
+        meshes: Mesh[];
+    }>;
     /**
      * Creates one or more expressions.
      * @param partId id of part where to create the expression
@@ -586,7 +624,6 @@ export declare type ApiHistory = {
      * api.box(part, [], 'ExpressionSet.width', 20, 20)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     createExpressions: (partId: VID, ...members: {
         name: string;
@@ -630,7 +667,6 @@ export declare type ApiHistory = {
      *
      * const geoms = await api.createBufferGeometry(rootAsm)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image /doc/assets/history/assemblyTemplate.jpg
      */
     createAssemblyAsTemplate: (name?: string) => ID;
     /**
@@ -656,7 +692,6 @@ export declare type ApiHistory = {
      * const partRef = await api.addNode(partTempl, rootAsm, [orig, xDir, yDir])
      * const geoms = await api.createBufferGeometry(rootAsm)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     createRootAssembly: (name?: string) => ID;
     /**
@@ -668,7 +703,6 @@ export declare type ApiHistory = {
      * api.cylinder(part, [], 10, 100)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     createPart: (name?: string) => ID;
     /**
@@ -694,7 +728,6 @@ export declare type ApiHistory = {
      * const partRef = await api.addNode(partTempl, rootAsm, [orig, xDir, yDir])
      * const geoms = await api.createBufferGeometry(rootAsm)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     createPartAsTemplate: (name?: string) => ID;
     /**
@@ -707,7 +740,6 @@ export declare type ApiHistory = {
      * @param local if true, work axis is set in local coordinates of part???
      * @param name name of the work axis, if not set default name = 'WorkAxis'
      * @example //tbd
-     * @image // tbd
      */
     createWorkAxis: (partId: VID, type: WorkAxisType, references: VID[], position: PointMemValue, direction: PointMemValue, local: boolean, name?: string) => ID;
     /**
@@ -752,7 +784,6 @@ export declare type ApiHistory = {
      * await api.createFastenedConstraint(rootAsm, { matePath: [prt1], wcsId: wcs3 }, { matePath: [prt2], wcsId: wcs2 }, 0, 0, 0, 0, 0, 'FC')
      * const geoms = await api.createBufferGeometry(rootAsm)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     createWorkCoordSystem: (partId: VID, type: WorkCoordSystemType, references: VID[], coordinateSystem: PointMemValue[], offset: PointMemValue, rotation: PointMemValue, inverted: 0 | 1, local: boolean, name?: string) => ID;
     /**
@@ -767,7 +798,6 @@ export declare type ApiHistory = {
      * @param local if true, work plane is set in local coordinates of part???
      * @param name name of the work plane, if not set default name = 'WorkAxis'
      * @example // tbd
-     * @image // tbd
      */
     createWorkPlane: (partId: VID, type: WorkPlaneType, references: VID[], offset: number, angle: number, position: PointMemValue, normal: PointMemValue, local: boolean, name?: string) => ID;
     /**
@@ -780,7 +810,6 @@ export declare type ApiHistory = {
      * @param local if true, work point is set in local coordinates of part???
      * @param name name of the work point, if not set default name = 'WorkPoint'
      * @example // tbd
-     * @image // tbd
      */
     createWorkPoint: (partId: VID, type: WorkPointType, references: VID[], position: PointMemValue, local: boolean, name?: string) => ID;
     /**
@@ -795,7 +824,6 @@ export declare type ApiHistory = {
      * await api.box(part, [], 'ExpressionSet.width', 20, 20)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     deleteExpressions: (partId: VID, members: string[]) => Promise<boolean>;
     /**
@@ -841,7 +869,6 @@ export declare type ApiHistory = {
      * api.sphere(part, [], 20)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     sphere: (partId: VID, references: VID[], radius: number | string) => ID;
     /**
@@ -857,7 +884,6 @@ export declare type ApiHistory = {
      * api.fillet(part, topEdges, 2)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     fillet: (partId: VID, references: VIDs, radius: number | string) => ID;
     /**
@@ -875,7 +901,6 @@ export declare type ApiHistory = {
      * If asmName is empty, all assemblies from assembly container will be returned.
      * @param asmName Name of assembly to look for
      * @example // tbd
-     * @image // tbd
      */
     getAssemblyFromContainer: (asmName?: string) => IDs;
     /**
@@ -884,13 +909,11 @@ export declare type ApiHistory = {
      * @param refId Reference of the assembly to look for the node
      * @param nodeName Name of the node to look for
      * @example // tbd
-     * @image // tbd
      */
     getAssemblyNode: (refId: VID, nodeName?: string) => IDs;
     /**
      * Returns the id of the current product
      * @example // tbd
-     * @image // tbd
      */
     getCurrentProduct: () => ID;
     /**
@@ -898,7 +921,6 @@ export declare type ApiHistory = {
      *
      * @param refId Reference id of the node to set as the current
      * @example // tbd
-     * @image // tbd
      */
     setCurrentNode: (refId: VID) => Promise<void>;
     /**
@@ -906,13 +928,11 @@ export declare type ApiHistory = {
      *
      * @param productId Id of the product to set as the current
      * @example // tbd
-     * @image // tbd
      */
     setCurrentProduct: (productId: VID) => Promise<void>;
     /**
      * Returns the id of the current node
      * @example // tbd
-     * @image // tbd
      */
     getCurrentNode: () => ID;
     /**
@@ -921,7 +941,6 @@ export declare type ApiHistory = {
      *
      * @param refId Reference id of the node to get the coordinate system from
      * @example // tbd
-     * @image // tbd
      */
     getCoordSysFromNode: (refId: VID) => Promise<number[][]>;
     /**
@@ -929,10 +948,11 @@ export declare type ApiHistory = {
      * If partName is empty, all parts from part container will be returned.
      * @param partName Name of part to look for
      * @example // tbd
-     * @image // tbd
      */
     getPartFromContainer: (partName?: string) => IDs;
     /**
+     * @deprecated use getWorkGeometry() instead, getWorkCoordSystem() will be removed in a future release.
+     *
      * Returns the work coord system with the given wcsName from the given reference.
      * If wcsName is not set, all work coord systems of the reference will be returned.
      * @param refId id of the reference to look for the work coord system
@@ -950,15 +970,23 @@ export declare type ApiHistory = {
      * await api.createFastenedOriginConstraint(nutBoltAsm, { refId: boltRefId, wcsId: wcsIdOrigin[0] }, 0, 0, 0, 0, 0, 'FOC')
      * const geoms = await api.createBufferGeometry(nutBoltAsm)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     getWorkCoordSystem: (refId: VID, wcsName?: string) => IDs;
     /**
+     * Returns the work geometry of given type with given name. If the name of the work geometry is empty,
+     * all found work geometry of given type is returned
+     * @param refId id of the reference to look for the work geometry
+     * @param type type of the work geometry to look for
+     * @param wgName optional name of the work geometry to look for
+     */
+    getWorkGeometry: (refId: VID, type: WorkGeomType, wgName?: string) => IDs;
+    /**
+     * @deprecated use specific methods e.g. getFastenedConstraint() instead, getConstraint() will be removed in a future release.
+     *
      * Returns information about a constraint in the given reference
      * @param refId id of the reference to look for the constraint
      * @param constrName name of the constraint to look for
      * @example // tbd
-     * @image // tbd
      * @returns
      * [
      *    constraintId,
@@ -970,13 +998,68 @@ export declare type ApiHistory = {
      * ]
      */
     getConstraint: (refId: VID, constrName?: string) => Promise<ConstraintType>;
+    /**
+     * Returns the fastened constraint of given reference with specified name.
+     * @param refId id of the reference to look for the constraint
+     * @param constrName name of the constraint to look for
+     * @example // tbd
+     * @returns found fastened constraint as object.
+     */
+    getFastenedConstraint: (refId: VID, constrName: string) => Promise<FastenedConstraintType>;
+    /**
+     * Returns the fastened origin constraint of given reference with specified name.
+     * @param refId id of the reference to look for the constraint
+     * @param constrName name of the constraint to look for
+     * @example // tbd
+     * @returns found fastened origin constraint as object.
+     */
+    getFastenedOriginConstraint: (refId: VID, constrName: string) => Promise<FastenedOriginConstraintType>;
+    /**
+     * Returns the revolute constraint of given reference with specified name.
+     * @param refId id of the reference to look for the constraint
+     * @param constrName name of the constraint to look for
+     * @example // tbd
+     * @returns found revolute constraint as object.
+     */
+    getRevoluteConstraint: (refId: VID, constrName: string) => Promise<RevoluteConstraintType>;
+    /**
+     * Returns the slider constraint of given reference with specified name.
+     * @param refId id of the reference to look for the constraint
+     * @param constrName name of the constraint to look for
+     * @example // tbd
+     * @returns found slider constraint as object.
+     */
+    getSliderConstraint: (refId: VID, constrName: string) => Promise<SliderConstraintType>;
+    /**
+     * Returns the planar constraint of given reference with specified name.
+     * @param refId id of the reference to look for the constraint
+     * @param constrName name of the constraint to look for
+     * @example // tbd
+     * @returns found planar constraint as object.
+     */
+    getPlanarConstraint: (refId: VID, constrName: string) => Promise<PlanarConstraintType>;
+    /**
+     * Returns the parallel constraint of given reference with specified name.
+     * @param refId id of the reference to look for the constraint
+     * @param constrName name of the constraint to look for
+     * @example // tbd
+     * @returns found parallel constraint as object.
+     */
+    getParallelConstraint: (refId: VID, constrName: string) => Promise<ParallelConstraintType>;
+    /**
+     * Returns the cylindrical constraint of given reference with specified name.
+     * @param refId id of the reference to look for the constraint
+     * @param constrName name of the constraint to look for
+     * @example // tbd
+     * @returns found cylindrical constraint as object.
+     */
+    getCylindricalConstraint: (refId: VID, constrName: string) => Promise<CylindricalConstraintType>;
     /**
      * Returns the id of the feature with name = featureName. The feature can then
      * be used for further operations, like boolean, transformations and so on.
      * @param partId id of the part where to look for the feature
      * @param featureName name of the feature to look for
      * @example // tbd
-     * @image // tbd
      */
     getFeatureByName: (partId: VID, featureName: string) => ID;
     /**
@@ -988,7 +1071,6 @@ export declare type ApiHistory = {
      *
      * @param type type to write
      * @example // tbd
-     * @image // tbd
      */
     save: (type: 'ofb' | 'stp') => Promise<Uint8Array | null>;
     /**
@@ -996,7 +1078,6 @@ export declare type ApiHistory = {
      * @param url The url to POST the model to.
      * @param filetype The file type be saved (ofb, stp).
      * @example // tbd
-     * @image // tbd
      */
     saveToUrl: (url: string, filetype: 'ofb' | 'stp') => Promise<boolean>;
     /**
@@ -1004,7 +1085,6 @@ export declare type ApiHistory = {
      * @param content data as arraybuffer
      * @param type type of the data to load
      * @example // tbd
-     * @image // tbd
      */
     load: (content: ArrayBuffer, type: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
@@ -1012,7 +1092,6 @@ export declare type ApiHistory = {
      * @param url The url to load data from.
      * @param filetype The type of data delivered by the url (ofb, stp).
      * @example // tbd
-     * @image // tbd
      */
     loadFromUrl: (url: string, filetype: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
@@ -1024,7 +1103,6 @@ export declare type ApiHistory = {
      * const part = api.loadProduct(arraybuffer, 'ofb')
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     loadProduct: (content: ArrayBuffer, type: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
@@ -1032,7 +1110,6 @@ export declare type ApiHistory = {
      * @param url The url to load data from.
      * @param filetype The type of data delivered by the url ('ofb', 'stp').
      * @example // tbd
-     * @image // tbd
      */
     loadProductFromUrl: (url: string, filetype: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
@@ -1043,22 +1120,14 @@ export declare type ApiHistory = {
      * @param format the content format
      * @param name optional name for the feature, default = 'Import'
      * @example // tbd
-     * @image // tbd
      */
     importFeature: (partId: VID, content: ArrayBuffer, format: 'stp' | 'step', name?: string) => ID;
     /**
-     * Removes a node from an assembly node
+     * Removes multiple nodes from an assembly node at once
+     * @param nodes array of node parameter objects. See following descriptions.
      * @param referenceId id of the node to remove
      * @param ownerId id of the assembly node to remove the node from
      * @example // tbd
-     * @image // tbd
-     */
-    removeNode: (referenceId: VID, ownerId: VID) => Promise<void>;
-    /**
-     * Removes multiple nodes from an assembly node at once
-     * @param nodes array of node parameter objects. See also removeNode().
-     * @example // tbd
-     * @image // tbd
      */
     removeNodes: (...nodes: {
         referenceId: VID;
@@ -1071,7 +1140,6 @@ export declare type ApiHistory = {
      * @param ownerId id of the owner (parent) of node we want to transform
      * @param transformation array of three vectors [origin, xAxis, yAxis]
      * @example // tbd
-     * @image // tbd
      */
     transformNode: (referenceId: VID, ownerId: VID, transformation: Transform) => Promise<void>;
     /**
@@ -1082,15 +1150,15 @@ export declare type ApiHistory = {
      * @param inverted flag if direction is inverted or not
      * @param distance distance of translation
      * @example // tbd
-     * @image // tbd
      */
     translate: (partId: VID, featureIds: VID[], references: VID[], inverted: 0 | 1, distance: number | string) => ID;
     /**
+     * @deprecated use translate() instead, updateTranslate() will be removed in a future release.
+     *
      * Updates a already created translation. To update value will be distance of translation
      * @param translationId id of the translation (feature id) which will be updated
      * @param distance new value for distance
      * @example // tbd
-     * @image // tbd
      */
     updateTranslate: (translationId: VID, distance: number) => Promise<void>;
     /**
@@ -1107,43 +1175,39 @@ export declare type ApiHistory = {
      * api.fillet(part, edges, 2)
      * const geoms = await api.createBufferGeometry(part)
      * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
      */
     pick: (partId: VID, type: 'vertex' | 'edge' | 'face', points: PointMemValue[]) => IDs;
     /**
-     * Updates an existing expression
+     * Updates multiple expressions in different parts at once
+     *
+     * @param expressions array of expression objects containing the part id and the expression to set
      * @param partId id of part to update expression
      * @param members array of members to update which contain a name and a value. Value can be an expression, e.g. '2 * laenge'
-     * @example
-     * // Sets expression height to value = 30
-     * const part = api.createPart('Part')
-     * api.createExpressions(part, { name: 'width', value: 20 }, { name: 'height', value: 40 })
-     * api.setExpressions(part, { name: 'height', value: 30 })
-     * await api.box(part, [], 'ExpressionSet.width', 20, 'ExpressionSet.height')
-     * const geoms = await api.createBufferGeometry(part)
-     * return geoms.map(geom => new THREE.Mesh(geom, new THREE.MeshStandardMaterial()))
-     * @image // tbd
-     * @returns true, if updating expressions was successfull
-     */
-    setExpressions: (partId: VID, ...members: {
-        name: string;
-        value: number | string;
-    }[]) => Promise<boolean>;
-    /**
-     * Updates multiple expression sets in different parts at once
-     *
-     * @param exprSets array of expression objects containing the part id and the expression to set
      * @example // tbd
-     * @image // tbd
-     * @returns true, if updating expressions in all expression sets was successfull
+     * @returns true, if updating expressions in all parts was successfull
      */
-    setExpressionSets: (...exprSets: {
+    setExpressions: (...expressions: {
         partId: number;
         members: {
             name: string;
             value: number | string;
         }[];
     }[]) => Promise<boolean>;
+    /**
+     * Mirrors the entities of a feature at the position of the plane reference
+     * @param partId id of the part where the mirror will be created
+     * @param entities id of the feature/operation we want to use entities from
+     * @param references id of the references which will be used to mirror (e.g. Workplane)
+     */
+    mirror: (partId: VID, entities: VID[], references: VID[]) => Promise<ObjectID | null>;
+    /**
+     * Removes the given operations or the operations which are added after 'toOperation' in history, depending
+     * on whether operations or toOperation parameter is given.
+     * @param operations ids of all to remove operations. First element in the array will be removed first.
+     * This means operations which depend on eacht other, need to be removed from newest to oldest.
+     * @param toOperation all operations, from rollback bar until the id of this operation, will be deleted
+     */
+    removeOperations: (operations: VID[], toOperation: VID) => Promise<void>;
 };
 export default class CAD {
     private drawingId;
@@ -1162,6 +1226,12 @@ declare type Point = {
     y: number;
     z: number;
 };
+declare type MateParam = {
+    matePath: VID[];
+    wcsId: VID;
+    flip: FlipType;
+    reoriented: ReorientedType;
+};
 export declare type Transform = [Point, Point, Point];
 export declare type DimensionType = {
     productId: VID;
@@ -1186,34 +1256,59 @@ export declare type ViewOptionsType = {
 };
 export declare type FastenedOriginConstraintType = {
     constrId: VID;
-    mate1: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: number;
-        reoriented: number;
-    };
+    mate1: MateParam;
     xOffset: number | string;
     yOffset: number | string;
     zOffset: number | string;
 };
 export declare type FastenedConstraintType = {
     constrId: VID;
-    mate1: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: number;
-        reoriented: number;
-    };
-    mate2: {
-        matePath: VID[];
-        wcsId: VID;
-        flip: number;
-        reoriented: number;
-    };
+    mate1: MateParam;
+    mate2: MateParam;
     xOffset: number | string;
     yOffset: number | string;
     zOffset: number | string;
 };
+export declare type RevoluteConstraintType = {
+    constrId: VID;
+    mate1: MateParam;
+    mate2: MateParam;
+    zOffset: number | string;
+    zRotationLimits: LimitsParam;
+};
+export declare type SliderConstraintType = {
+    constrId: VID;
+    mate1: MateParam;
+    mate2: MateParam;
+    xOffset: number | string;
+    yOffset: number | string;
+    zOffsetLimits: LimitsParam;
+};
+export declare type PlanarConstraintType = {
+    constrId: VID;
+    mate1: MateParam;
+    mate2: MateParam;
+    zOffset: number | string;
+    xOffsetLimits: LimitsParam;
+    yOffsetLimits: LimitsParam;
+    zRotationLimits: LimitsParam;
+};
+export declare type ParallelConstraintType = {
+    constrId: VID;
+    mate1: MateParam;
+    mate2: MateParam;
+    xOffsetLimits: LimitsParam;
+    yOffsetLimits: LimitsParam;
+    zOffsetLimits: LimitsParam;
+    zRotationLimits: LimitsParam;
+};
+export declare type CylindricalConstraintType = {
+    constrId: VID;
+    mate1: MateParam;
+    mate2: MateParam;
+    zOffsetLimits: LimitsParam;
+    zRotationLimits: LimitsParam;
+};
 /**
  * Information about constraint.
  * [