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

package/build/{history.d.ts → types/history.d.ts}

@@ -64,7 +64,7 @@ export declare type ApiHistory = {
         ownerId: VID;
         transformation: Transform;
         name?: string;
-    }[]) => IDs;
+    }[]) => Promise<ObjectID[] | null>;
     /**
      * Adds a dimension to the product in the 3D view
      * @param dimension dimension to be added to a product
@@ -150,7 +150,7 @@ export declare type ApiHistory = {
             dimLayer?: string;
         };
         dxfView: ViewType;
-    }[]) => IDs;
+    }[]) => Promise<ObjectID[] | null>;
     /**
      * Creates different 2D views, depending on the given view types, in the given product.
      * @param productId id of the product where the view will be created in
@@ -590,7 +590,7 @@ export declare type ApiHistory = {
      */
     createExpressions: (partId: VID, ...members: {
         name: string;
-        value: number | PointMemValue | string;
+        value: number | string;
     }[]) => Promise<boolean>;
     /**
      * Creates a new assembly template. This template can be used multiple times as a sub assembly in the root assembly.
@@ -799,11 +799,11 @@ export declare type ApiHistory = {
      */
     deleteExpressions: (partId: VID, members: string[]) => Promise<boolean>;
     /**
-     * Loads a sketch from a of1 filestream and adds its elements to a new sketch.
+     * Loads a sketch from a ofb filestream and adds its elements to a new sketch.
      * The id of this new created sketch will be returned.
      *
      * @param partId id of the part we want to create the new sketch and copy the sketch elements into it
-     * @param strm stream of of1 file which contains the sketch
+     * @param strm stream of ofb file which contains the sketch
      * @param planeId id of the face or workplane to set the new sketch on
      * @param name optional name of the sketch to load from filestream
      */
@@ -944,7 +944,7 @@ export declare type ApiHistory = {
      * const xDir = { x: 1, y: 0, z: 0 }
      * const yDir = { x: 0, y: 1, z: 0 }
      * const nutBoltAsm = await api.createRootAssembly('NutBolt_Asm')
-     * const bolt = await api.loadProduct(arraybuffer, 'of1')
+     * const bolt = await api.loadProduct(arraybuffer, 'ofb')
      * const boltRefId = await api.addNode(bolt, nutBoltAsm, [pt0, xDir, yDir])
      * const wcsIdOrigin = await api.getWorkCoordSystem(boltRefId, 'WCS_Origin')
      * await api.createFastenedOriginConstraint(nutBoltAsm, { refId: boltRefId, wcsId: wcsIdOrigin[0] }, 0, 0, 0, 0, 0, 'FOC')
@@ -982,7 +982,7 @@ export declare type ApiHistory = {
     /**
      * Writes the current drawing to a stream and returns the data.
      *
-     * Important notes about the of1 format:
+     * Important notes about the ofb format:
      *    - It contains binary geometry blocks.
      *    - Do not try to convert it to text, the geometry blocks will get damaged!
      *
@@ -990,15 +990,15 @@ export declare type ApiHistory = {
      * @example // tbd
      * @image // tbd
      */
-    save: (type: DataTypes) => Promise<Uint8Array | null>;
+    save: (type: 'ofb' | 'stp') => Promise<Uint8Array | null>;
     /**
      * POSTs the result to the given url.
      * @param url The url to POST the model to.
-     * @param filetype The file type be saved (of1, stp).
+     * @param filetype The file type be saved (ofb, stp).
      * @example // tbd
      * @image // tbd
      */
-    saveToUrl: (url: string, filetype: 'of1' | 'stp') => Promise<boolean>;
+    saveToUrl: (url: string, filetype: 'ofb' | 'stp') => Promise<boolean>;
     /**
      * Loads the given buffer.
      * @param content data as arraybuffer
@@ -1006,35 +1006,35 @@ export declare type ApiHistory = {
      * @example // tbd
      * @image // tbd
      */
-    load: (content: ArrayBuffer, type: DataTypes) => Promise<number[] | null>;
+    load: (content: ArrayBuffer, type: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
      * Loads from the given url.
      * @param url The url to load data from.
-     * @param filetype The type of data delivered by the url (of1, stp).
+     * @param filetype The type of data delivered by the url (ofb, stp).
      * @example // tbd
      * @image // tbd
      */
-    loadFromUrl: (url: string, filetype: 'of1' | 'stp') => Promise<number[] | null>;
+    loadFromUrl: (url: string, filetype: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
      * Loads a product into the current drawing.
      * @param content data as arraybuffer
      * @param type type of the data to load
      * @example
      * // Loads an existing product
-     * const part = api.loadProduct(arraybuffer, 'of1')
+     * 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: DataTypes) => Promise<number[] | null>;
+    loadProduct: (content: ArrayBuffer, type: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
      * Loads a product from the given URL into the current drawing.
      * @param url The url to load data from.
-     * @param filetype The type of data delivered by the url (of1, stp).
+     * @param filetype The type of data delivered by the url ('ofb', 'stp').
      * @example // tbd
      * @image // tbd
      */
-    loadProductFromUrl: (url: string, filetype: string) => Promise<number[] | null>;
+    loadProductFromUrl: (url: string, filetype: 'ofb' | 'stp') => Promise<number[] | null>;
     /**
      * Creates a new feature and appends geometry to it. This method can be used to import specific geometry
      * which can be used for further operations like boolean, translations and so on.
@@ -1045,7 +1045,7 @@ export declare type ApiHistory = {
      * @example // tbd
      * @image // tbd
      */
-    importFeature: (partId: VID, content: ArrayBuffer, format: SupportedImportFormats, name?: string) => ID;
+    importFeature: (partId: VID, content: ArrayBuffer, format: 'stp' | 'step', name?: string) => ID;
     /**
      * Removes a node from an assembly node
      * @param referenceId id of the node to remove
@@ -1127,7 +1127,7 @@ export declare type ApiHistory = {
      */
     setExpressions: (partId: VID, ...members: {
         name: string;
-        value: number | PointMemValue | string;
+        value: number | string;
     }[]) => Promise<boolean>;
     /**
      * Updates multiple expression sets in different parts at once
@@ -1141,7 +1141,7 @@ export declare type ApiHistory = {
         partId: number;
         members: {
             name: string;
-            value: number | PointMemValue | string;
+            value: number | string;
         }[];
     }[]) => Promise<boolean>;
 };
@@ -1163,8 +1163,6 @@ declare type Point = {
     z: number;
 };
 export declare type Transform = [Point, Point, Point];
-declare type DataTypes = 'of1' | 'stp' | 'step';
-declare type SupportedImportFormats = 'STEP' | 'STP' | 'SAT' | 'IWB' | 'IWP' | 'IWC' | 'IGS' | 'STL' | 'DXF' | 'DWG';
 export declare type DimensionType = {
     productId: VID;
     dimParam: {
@@ -1186,6 +1184,36 @@ export declare type ViewOptionsType = {
     color?: number;
     layer?: string;
 };
+export declare type FastenedOriginConstraintType = {
+    constrId: VID;
+    mate1: {
+        matePath: VID[];
+        wcsId: VID;
+        flip: number;
+        reoriented: number;
+    };
+    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;
+    };
+    xOffset: number | string;
+    yOffset: number | string;
+    zOffset: number | string;
+};
 /**
  * Information about constraint.
  * [

package/build/{solid.d.ts → types/solid.d.ts}

@@ -223,9 +223,9 @@ export declare type ApiNoHistory = {
     intersect: (solidId: VID, keepSolid: boolean, ...bodies: VID[]) => ID;
     /**
      * Loads an arraybuffer in native file format. Native file format
-     * is 'of1', if you want to load 'stp' file formats, use import function.
+     * is 'ofb', if you want to load 'stp' file formats, use import function.
      * Current drawing will be overwritten by loaded data.
-     * @param data data as arraybuffer in of1 format
+     * @param data data as arraybuffer in ofb format
      * @example // tbd
      * @image // tbd
      */
@@ -321,14 +321,14 @@ export declare type ApiNoHistory = {
     rotateTo: (solidId: VID, rotationVec: Vec) => Promise<void>;
     /**
      * Writes the current drawing as native file format to a stream and returns the data.
-     * Native file is 'of1', for 'stp' file format use export method.
+     * Native file is 'ofb', for 'stp' file format use export method.
      *
-     * Important notes about the of1 format:
+     * Important notes about the ofb format:
      *    - It contains binary geometry blocks.
      *    - Do not try to convert it to text, the geometry blocks will get damaged!
      *
      * @example
-     * // Creates a rotated box and gets the of1 data.
+     * // Creates a rotated box and gets the ofb data.
      * const boxId = api.box(10, 10, 10)
      * api.rotateTo(boxId, [Math.PI / 4, 0, Math.PI / 4])
      * const data = api.save()

package/package.json

@@ -1,36 +1,36 @@
 {
   "name": "@buerli.io/headless",
-  "version": "0.4.1",
+  "version": "0.5.0-beta.2",
   "description": "A non-manifold CAD workflow for the web",
   "author": "AWV Informatik AG <info@awv-informatik.ch>",
   "license": "ISC",
   "repository": {},
-  "main": "build/index.js",
-  "module": "build/index.js",
-  "types": "build/index.d.ts",
+  "main": "build/cjs/index.js",
+  "module": "build/esm/index.js",
+  "types": "build/types/index.d.ts",
   "sideEffects": false,
   "scripts": {
     "ver": "npm version",
-    "prepack": "npm run clean && npm run build",
-    "clean": "rimraf ./build && rimraf ./tsconfig.tsbuildinfo",
+    "prepack": "npm run clean && npm run build -- --sourceMap false && npm run build:cjs -- --sourceMap false",
+    "clean": "rimraf ./build* && rimraf tsconfig.tsbuildinfo",
     "build": "tsc -v && tsc",
-    "build:dev": "tsc --sourceMap true --declarationMap true",
+    "build:cjs": "tsc --target es2017 --module commonjs --composite false --declaration false --declarationDir null --outDir ./build/cjs",
     "test": "echo no tests yet",
     "lint": "eslint \"./src/**/*.ts?(x)\"",
     "prettify": "prettier --write \"./{src,tests}/**/*.{js,jsx,ts,tsx,json}\""
   },
   "devDependencies": {
-    "@types/three": "^0.137",
+    "@types/three": "^0.143",
     "copyfiles": "^2.1.1",
     "rimraf": "^2.6.3",
-    "three": "^0.138",
-    "typescript": "4.1.2"
+    "three": "^0.143",
+    "typescript": "4.8.4"
   },
   "peerDependencies": {
     "three": ">=0.138"
   },
   "dependencies": {
-    "@buerli.io/classcad": "0.4.1",
+    "@buerli.io/classcad": "0.5.0-beta.2",
     "flat-promise": "^1.0.3"
   }
 }