@buerli.io/headless 0.9.0 → 0.9.1-beta.0

package/build/cjs/history.js

@@ -249,9 +249,48 @@ class CAD {
                         for (var instances_1 = __asyncValues(instances), instances_1_1; instances_1_1 = await instances_1.next(), !instances_1_1.done;) {
                             const instance = instances_1_1.value;
                             const [rProductId, rOwnerId] = await new Promise(res => this.resolve(id => res(id), instance.productId, instance.ownerId));
+                            // Looking for the productId given by an identifier or name
+                            // Priorities:
+                            //    1. Look for the identifier then for the name in the part templates
+                            //    2. Look for the identifier then for the name in the assembly templates
+                            let product = rProductId;
+                            if (typeof rProductId === 'string') {
+                                let products = asmUtils.getPartTemplate(drawingId, rProductId);
+                                if (products.length > 1) {
+                                    throw 'More than one product has been found for given name or ident: ' + rProductId;
+                                }
+                                else if (products.length < 1) {
+                                    products = asmUtils.getAssemblyTemplate(drawingId, rProductId);
+                                    if (products.length < 1) {
+                                        throw 'No product found for given name or ident: ' + rProductId;
+                                    }
+                                    else if (products.length > 1) {
+                                        throw 'More than one product has been found for given name or ident: ' + rProductId;
+                                    }
+                                }
+                                product = products[0];
+                            }
+                            let owner = rOwnerId;
+                            if (typeof rOwnerId === 'string') {
+                                owner = baseUtils.findObject(drawingId, {
+                                    ident: rOwnerId,
+                                    name: rOwnerId,
+                                });
+                                if (!owner) {
+                                    throw 'The owner to add instances on given by name or ident "' + rOwnerId + '" does not exist.';
+                                }
+                                const clazz = (0, core_1.getDrawing)(drawingId).structure.tree[owner].class;
+                                if (!baseUtils.isA(clazz, classcad_1.CCClasses.IProductReference) && !baseUtils.isA(clazz, classcad_1.CCClasses.CCAssembly)) {
+                                    throw ('The owner to add instances on given by name or ident "' +
+                                        rOwnerId +
+                                        '" is of the wrong type: "' +
+                                        clazz +
+                                        '". Make sure the owner is an instance, a root assembly or an assembly template.');
+                                }
+                            }
                             const instanceParam = {
-                                productId: rProductId,
-                                ownerId: rOwnerId,
+                                productId: product,
+                                ownerId: owner,
                                 transformation: instance.transformation,
                                 name: instance.name,
                                 options: Object.assign(Object.assign({}, instance.options), { isLocal: true }), // in non-interactive mode, the transformation is local to the owner
@@ -1248,6 +1287,24 @@ class CAD {
                         return null;
                     }, id);
                 },
+                findInstance: (options) => {
+                    return this.resolve(async () => {
+                        const instance = baseUtils.findObject(drawingId, {
+                            ident: options.instanceIdent,
+                            name: options.instanceName,
+                        });
+                        if (!instance) {
+                            return null;
+                        }
+                        const clazz = (0, core_1.getDrawing)(drawingId).structure.tree[instance].class;
+                        if (!baseUtils.isA(clazz, classcad_1.CCClasses.IProductReference)) {
+                            return null;
+                        }
+                        else {
+                            return instance;
+                        }
+                    });
+                },
                 getProductsOfInstances: (instanceIds) => {
                     return this.resolve(async ([rInstanceIds]) => {
                         const drawing = (0, core_1.getDrawing)(drawingId);
@@ -1467,10 +1524,43 @@ class CAD {
                         return null;
                     }, id);
                 },
-                removeInstances: (...instances) => {
-                    return this.resolve(async ([...rInstances]) => {
-                        return assemblyBuilderAPI.removeInstances(drawingId, rInstances);
-                    }, ...instances);
+                removeInstances: async (...instances) => {
+                    var e_11, _a;
+                    const instancesToRemove = [];
+                    try {
+                        for (var instances_2 = __asyncValues(instances), instances_2_1; instances_2_1 = await instances_2.next(), !instances_2_1.done;) {
+                            const instance = instances_2_1.value;
+                            const [rInstanceId] = await new Promise(res => this.resolve(id => res(id), instance.id));
+                            let instanceId = rInstanceId;
+                            if (typeof rInstanceId === 'string') {
+                                instanceId = baseUtils.findObject(drawingId, {
+                                    ident: rInstanceId,
+                                    name: rInstanceId,
+                                });
+                                if (!instanceId) {
+                                    throw 'The instance to remove given by name or ident "' + rInstanceId + '" does not exist.';
+                                }
+                                const clazz = (0, core_1.getDrawing)(drawingId).structure.tree[instanceId].class;
+                                if (!baseUtils.isA(clazz, classcad_1.CCClasses.IProductReference)) {
+                                    throw ('The instance to remove given by name or ident "' +
+                                        rInstanceId +
+                                        '" is of the wrong type "' +
+                                        clazz +
+                                        '". Make sure the object is an instance.');
+                                }
+                            }
+                            const instanceParam = { id: instanceId };
+                            instancesToRemove.push(instanceParam);
+                        }
+                    }
+                    catch (e_11_1) { e_11 = { error: e_11_1 }; }
+                    finally {
+                        try {
+                            if (instances_2_1 && !instances_2_1.done && (_a = instances_2.return)) await _a.call(instances_2);
+                        }
+                        finally { if (e_11) throw e_11.error; }
+                    }
+                    return assemblyBuilderAPI.removeInstances(drawingId, instancesToRemove);
                 },
                 importFeature: (partId, content, format, name) => {
                     return this.resolve(async ([rPartId]) => {
@@ -1527,26 +1617,44 @@ class CAD {
                     }, sketchId, planeId, axisId, originId);
                 },
                 transformInstances: async (...instances) => {
-                    var e_11, _a;
+                    var e_12, _a;
                     const instancesToTransform = [];
                     try {
-                        for (var instances_2 = __asyncValues(instances), instances_2_1; instances_2_1 = await instances_2.next(), !instances_2_1.done;) {
-                            const instance = instances_2_1.value;
+                        for (var instances_3 = __asyncValues(instances), instances_3_1; instances_3_1 = await instances_3.next(), !instances_3_1.done;) {
+                            const instance = instances_3_1.value;
                             const [rInstanceId] = await new Promise(res => this.resolve(id => res(id), instance.id));
+                            let instanceId = rInstanceId;
+                            if (typeof rInstanceId === 'string') {
+                                instanceId = baseUtils.findObject(drawingId, {
+                                    ident: rInstanceId,
+                                    name: rInstanceId,
+                                });
+                                if (!instanceId) {
+                                    throw 'The instance to transform given by name or ident "' + rInstanceId + '" does not exist.';
+                                }
+                                const clazz = (0, core_1.getDrawing)(drawingId).structure.tree[instanceId].class;
+                                if (!baseUtils.isA(clazz, classcad_1.CCClasses.IProductReference)) {
+                                    throw ('The instance to transform given by name or ident "' +
+                                        rInstanceId +
+                                        '" is of the wrong type "' +
+                                        clazz +
+                                        '". Make sure the object is an instance.');
+                                }
+                            }
                             const instanceParam = {
-                                id: rInstanceId,
+                                id: instanceId,
                                 transformation: instance.transformation,
                                 options: { isLocal: true }, // in non-interactive mode, the transformation is local to the owner
                             };
                             instancesToTransform.push(instanceParam);
                         }
                     }
-                    catch (e_11_1) { e_11 = { error: e_11_1 }; }
+                    catch (e_12_1) { e_12 = { error: e_12_1 }; }
                     finally {
                         try {
-                            if (instances_2_1 && !instances_2_1.done && (_a = instances_2.return)) await _a.call(instances_2);
+                            if (instances_3_1 && !instances_3_1.done && (_a = instances_3.return)) await _a.call(instances_3);
                         }
-                        finally { if (e_11) throw e_11.error; }
+                        finally { if (e_12) throw e_12.error; }
                     }
                     return assemblyBuilderAPI.transformInstances(drawingId, instancesToTransform);
                 },
@@ -1627,8 +1735,22 @@ class CAD {
                                 };
                                 membersToModify.push({ name: mem.name, value: featureAPIParam });
                             });
+                            // Looking for the partId given by an identifier or name
+                            let part = expr.partId;
+                            if (typeof part === 'string') {
+                                const products = asmUtils.getPartTemplate(drawingId, part);
+                                if (products.length > 1) {
+                                    throw 'More than one product has been found for given name or ident: ' + part;
+                                }
+                                else if (products.length < 1) {
+                                    throw 'No product found for given name or ident: ' + part;
+                                }
+                                else {
+                                    part = products[0];
+                                }
+                            }
                             expressionsToSet.push({
-                                productId: expr.partId,
+                                productId: part,
                                 toAddMembers: [],
                                 toModifyMembers: membersToModify,
                                 toDeleteList: [],

package/build/esm/history.js

@@ -247,9 +247,48 @@ export default class CAD {
                         for (var instances_1 = __asyncValues(instances), instances_1_1; instances_1_1 = await instances_1.next(), !instances_1_1.done;) {
                             const instance = instances_1_1.value;
                             const [rProductId, rOwnerId] = await new Promise(res => this.resolve(id => res(id), instance.productId, instance.ownerId));
+                            // Looking for the productId given by an identifier or name
+                            // Priorities:
+                            //    1. Look for the identifier then for the name in the part templates
+                            //    2. Look for the identifier then for the name in the assembly templates
+                            let product = rProductId;
+                            if (typeof rProductId === 'string') {
+                                let products = asmUtils.getPartTemplate(drawingId, rProductId);
+                                if (products.length > 1) {
+                                    throw 'More than one product has been found for given name or ident: ' + rProductId;
+                                }
+                                else if (products.length < 1) {
+                                    products = asmUtils.getAssemblyTemplate(drawingId, rProductId);
+                                    if (products.length < 1) {
+                                        throw 'No product found for given name or ident: ' + rProductId;
+                                    }
+                                    else if (products.length > 1) {
+                                        throw 'More than one product has been found for given name or ident: ' + rProductId;
+                                    }
+                                }
+                                product = products[0];
+                            }
+                            let owner = rOwnerId;
+                            if (typeof rOwnerId === 'string') {
+                                owner = baseUtils.findObject(drawingId, {
+                                    ident: rOwnerId,
+                                    name: rOwnerId,
+                                });
+                                if (!owner) {
+                                    throw 'The owner to add instances on given by name or ident "' + rOwnerId + '" does not exist.';
+                                }
+                                const clazz = getDrawing(drawingId).structure.tree[owner].class;
+                                if (!baseUtils.isA(clazz, CCClasses.IProductReference) && !baseUtils.isA(clazz, CCClasses.CCAssembly)) {
+                                    throw ('The owner to add instances on given by name or ident "' +
+                                        rOwnerId +
+                                        '" is of the wrong type: "' +
+                                        clazz +
+                                        '". Make sure the owner is an instance, a root assembly or an assembly template.');
+                                }
+                            }
                             const instanceParam = {
-                                productId: rProductId,
-                                ownerId: rOwnerId,
+                                productId: product,
+                                ownerId: owner,
                                 transformation: instance.transformation,
                                 name: instance.name,
                                 options: Object.assign(Object.assign({}, instance.options), { isLocal: true }), // in non-interactive mode, the transformation is local to the owner
@@ -1246,6 +1285,24 @@ export default class CAD {
                         return null;
                     }, id);
                 },
+                findInstance: (options) => {
+                    return this.resolve(async () => {
+                        const instance = baseUtils.findObject(drawingId, {
+                            ident: options.instanceIdent,
+                            name: options.instanceName,
+                        });
+                        if (!instance) {
+                            return null;
+                        }
+                        const clazz = getDrawing(drawingId).structure.tree[instance].class;
+                        if (!baseUtils.isA(clazz, CCClasses.IProductReference)) {
+                            return null;
+                        }
+                        else {
+                            return instance;
+                        }
+                    });
+                },
                 getProductsOfInstances: (instanceIds) => {
                     return this.resolve(async ([rInstanceIds]) => {
                         const drawing = getDrawing(drawingId);
@@ -1465,10 +1522,43 @@ export default class CAD {
                         return null;
                     }, id);
                 },
-                removeInstances: (...instances) => {
-                    return this.resolve(async ([...rInstances]) => {
-                        return assemblyBuilderAPI.removeInstances(drawingId, rInstances);
-                    }, ...instances);
+                removeInstances: async (...instances) => {
+                    var e_11, _a;
+                    const instancesToRemove = [];
+                    try {
+                        for (var instances_2 = __asyncValues(instances), instances_2_1; instances_2_1 = await instances_2.next(), !instances_2_1.done;) {
+                            const instance = instances_2_1.value;
+                            const [rInstanceId] = await new Promise(res => this.resolve(id => res(id), instance.id));
+                            let instanceId = rInstanceId;
+                            if (typeof rInstanceId === 'string') {
+                                instanceId = baseUtils.findObject(drawingId, {
+                                    ident: rInstanceId,
+                                    name: rInstanceId,
+                                });
+                                if (!instanceId) {
+                                    throw 'The instance to remove given by name or ident "' + rInstanceId + '" does not exist.';
+                                }
+                                const clazz = getDrawing(drawingId).structure.tree[instanceId].class;
+                                if (!baseUtils.isA(clazz, CCClasses.IProductReference)) {
+                                    throw ('The instance to remove given by name or ident "' +
+                                        rInstanceId +
+                                        '" is of the wrong type "' +
+                                        clazz +
+                                        '". Make sure the object is an instance.');
+                                }
+                            }
+                            const instanceParam = { id: instanceId };
+                            instancesToRemove.push(instanceParam);
+                        }
+                    }
+                    catch (e_11_1) { e_11 = { error: e_11_1 }; }
+                    finally {
+                        try {
+                            if (instances_2_1 && !instances_2_1.done && (_a = instances_2.return)) await _a.call(instances_2);
+                        }
+                        finally { if (e_11) throw e_11.error; }
+                    }
+                    return assemblyBuilderAPI.removeInstances(drawingId, instancesToRemove);
                 },
                 importFeature: (partId, content, format, name) => {
                     return this.resolve(async ([rPartId]) => {
@@ -1525,26 +1615,44 @@ export default class CAD {
                     }, sketchId, planeId, axisId, originId);
                 },
                 transformInstances: async (...instances) => {
-                    var e_11, _a;
+                    var e_12, _a;
                     const instancesToTransform = [];
                     try {
-                        for (var instances_2 = __asyncValues(instances), instances_2_1; instances_2_1 = await instances_2.next(), !instances_2_1.done;) {
-                            const instance = instances_2_1.value;
+                        for (var instances_3 = __asyncValues(instances), instances_3_1; instances_3_1 = await instances_3.next(), !instances_3_1.done;) {
+                            const instance = instances_3_1.value;
                             const [rInstanceId] = await new Promise(res => this.resolve(id => res(id), instance.id));
+                            let instanceId = rInstanceId;
+                            if (typeof rInstanceId === 'string') {
+                                instanceId = baseUtils.findObject(drawingId, {
+                                    ident: rInstanceId,
+                                    name: rInstanceId,
+                                });
+                                if (!instanceId) {
+                                    throw 'The instance to transform given by name or ident "' + rInstanceId + '" does not exist.';
+                                }
+                                const clazz = getDrawing(drawingId).structure.tree[instanceId].class;
+                                if (!baseUtils.isA(clazz, CCClasses.IProductReference)) {
+                                    throw ('The instance to transform given by name or ident "' +
+                                        rInstanceId +
+                                        '" is of the wrong type "' +
+                                        clazz +
+                                        '". Make sure the object is an instance.');
+                                }
+                            }
                             const instanceParam = {
-                                id: rInstanceId,
+                                id: instanceId,
                                 transformation: instance.transformation,
                                 options: { isLocal: true }, // in non-interactive mode, the transformation is local to the owner
                             };
                             instancesToTransform.push(instanceParam);
                         }
                     }
-                    catch (e_11_1) { e_11 = { error: e_11_1 }; }
+                    catch (e_12_1) { e_12 = { error: e_12_1 }; }
                     finally {
                         try {
-                            if (instances_2_1 && !instances_2_1.done && (_a = instances_2.return)) await _a.call(instances_2);
+                            if (instances_3_1 && !instances_3_1.done && (_a = instances_3.return)) await _a.call(instances_3);
                         }
-                        finally { if (e_11) throw e_11.error; }
+                        finally { if (e_12) throw e_12.error; }
                     }
                     return assemblyBuilderAPI.transformInstances(drawingId, instancesToTransform);
                 },
@@ -1625,8 +1733,22 @@ export default class CAD {
                                 };
                                 membersToModify.push({ name: mem.name, value: featureAPIParam });
                             });
+                            // Looking for the partId given by an identifier or name
+                            let part = expr.partId;
+                            if (typeof part === 'string') {
+                                const products = asmUtils.getPartTemplate(drawingId, part);
+                                if (products.length > 1) {
+                                    throw 'More than one product has been found for given name or ident: ' + part;
+                                }
+                                else if (products.length < 1) {
+                                    throw 'No product found for given name or ident: ' + part;
+                                }
+                                else {
+                                    part = products[0];
+                                }
+                            }
                             expressionsToSet.push({
-                                productId: expr.partId,
+                                productId: part,
                                 toAddMembers: [],
                                 toModifyMembers: membersToModify,
                                 toDeleteList: [],

package/build/types/history.d.ts

@@ -29,8 +29,8 @@ export declare type ApiHistory = {
      * - If the owner is an instance in the expanded tree, its template in the assembly container will also be updated.
      * - If the onwer is an assembly template, all instances of the template will also be updated
      * @param instances array of objects containing the information of "to add" instances. See following parameter descriptions.
-     * @param productId id or identifier of the product to instantiate
-     * @param ownerId id or identifier of the owner of to adding instance, owner can be root assembly, assembly instance or assembly template.
+     * @param productId id, identifier or name of the product to instantiate
+     * @param ownerId id, identifier or name of the owner of to adding instance, owner can be root assembly, assembly instance or assembly template.
      * @param transformation transformation (origin, x-Dir, y-Dir) of the instance
      * @param name optional name for the instance
      * @param options optional object containing ident property, to define a identifier for the adding instance
@@ -991,6 +991,21 @@ export declare type ApiHistory = {
      * @return array containing the ids of the found instances
      */
     getInstance: (id: VID, instanceName?: string) => IDs;
+    /**
+     * Find first instance which can be identified by given identifier or name.
+     * If both optional parameters has been set, the identifier is treated with priority.
+     * If no instance with given identifier will be found, the name is used to find an instance.
+     *
+     * @param drawingId The drawing id.
+     * @param options Optional parameters to identify to find instance.
+     * @param options.instanceIdent Identifier to find the instance by an identifier
+     * @param options.instanceName Name to find the instance by its name
+     * @returns first found instance which meets the searching conditions or null if nothing could be found
+     */
+    findInstance: (options: {
+        instanceIdent?: ObjectIdent;
+        instanceName?: string;
+    }) => ID;
     /**
      * Returns the product ids of the given instance ids.
      * @param instanceIds ids of the instances to get the product ids from
@@ -1261,7 +1276,7 @@ export declare type ApiHistory = {
     /**
      * Removes instances from root assembly, other instances or assembly templates.
      * @param instances array of instance objects. See following parameter descriptions.
-     * @param id id or identifier of the instance to remove
+     * @param id id, identifier or name of the instance to remove
      * @example // tbd
      */
     removeInstances: (...instances: {
@@ -1271,7 +1286,7 @@ export declare type ApiHistory = {
      * Transforms instances by the given transformation.
      * The transformations are local to the instances parent, which is an assembly.
      * @param instances array of instance objects. See following descriptions.
-     * @param id id or identifier of the instance to transform
+     * @param id id, identifier or name of the instance to transform
      * @param transformation transformation (origin, xDir, yDir) of the instance local to the owner.
      * @example // tbd
      */
@@ -1320,7 +1335,7 @@ export declare type ApiHistory = {
     /**
      * 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 or identifier of part to update expression
+     * @param partId id, identifier or name 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 // tbd
      * @returns true, if updating expressions in all parts was successfull
@@ -1356,7 +1371,7 @@ export declare type ApiHistory = {
      * @param instanceId id of the instance to get the mate path from
      * @return array containing the ids as a path from given instance to current instance
      */
-    getMatePath: (instanceId: VID) => Promise<ObjectID[]>;
+    getMatePath: (instanceId: VID | ObjectIdent) => Promise<ObjectID[]>;
     /**
      * Creates a slice operation.
      * Slices the entities of the given operations by the given reference.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buerli.io/headless",
-  "version": "0.9.0",
+  "version": "0.9.1-beta.0",
   "description": "A non-manifold CAD workflow for the web",
   "author": "AWV Informatik AG <info@awv-informatik.ch>",
   "license": "ISC",
@@ -32,7 +32,7 @@
     "three-stdlib": ">=2.11.0"
   },
   "dependencies": {
-    "@buerli.io/classcad": "0.9.0",
+    "@buerli.io/classcad": "0.9.1-beta.0",
     "flat-promise": "^1.0.3"
   }
 }