@thi.ng/quad-edge 2.0.6 → 3.1.2

package/CHANGELOG.md

@@ -1,93 +1,85 @@
 # Change Log
 
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [2.0.6](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@2.0.5...@thi.ng/quad-edge@2.0.6) (2021-10-28)
-
-**Note:** Version bump only for package @thi.ng/quad-edge
-
-
-
-
-
-## [2.0.5](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@2.0.4...@thi.ng/quad-edge@2.0.5) (2021-10-28)
-
-**Note:** Version bump only for package @thi.ng/quad-edge
-
-
-
-
-
-## [2.0.4](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@2.0.3...@thi.ng/quad-edge@2.0.4) (2021-10-25)
-
-**Note:** Version bump only for package @thi.ng/quad-edge
-
+- **Last updated**: 2021-11-21T17:09:28Z
+- **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org/) for commit guidelines.
 
+**Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
+and/or version bumps of transitive dependencies.
 
+## [3.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/quad-edge@3.1.0) (2021-11-17)
 
-## [2.0.3](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@2.0.2...@thi.ng/quad-edge@2.0.3) (2021-10-15)
-
-**Note:** Version bump only for package @thi.ng/quad-edge
-
-
-
-
-
-## [2.0.2](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@2.0.1...@thi.ng/quad-edge@2.0.2) (2021-10-15)
-
-**Note:** Version bump only for package @thi.ng/quad-edge
-
-
-
-
-
-## [2.0.1](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@2.0.0...@thi.ng/quad-edge@2.0.1) (2021-10-13)
-
-**Note:** Version bump only for package @thi.ng/quad-edge
-
-
+#### 🚀 Features
 
+- Using workspaces for local tools ([bf7a404](https://github.com/thi-ng/umbrella/commit/bf7a404))
+  Improving the overall build ergonomics
+  - introduced a tools workspaces
+  - imported it in all needed packages/examples
+  - inclusive project root
 
+#### ♻️ Refactoring
 
-# [2.0.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@1.0.1...@thi.ng/quad-edge@2.0.0) (2021-10-12)
+- testrunner to binary ([4ebbbb2](https://github.com/thi-ng/umbrella/commit/4ebbbb2))
+  this commit reverts (partly) changes made in:
+  ef346d7a8753590dc9094108a3d861a8dbd5dd2c
+  overall purpose is better testament ergonomics:
+  instead of having to pass NODE_OPTIONS with every invocation
+  having a binary to handle this for us.
 
+# [3.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/quad-edge@3.0.0) (2021-11-03)
 
-### Build System
+#### 🛑 Breaking changes
 
-* major update of ALL pkgs (export maps, ESM only) ([0d1d6ea](https://github.com/thi-ng/umbrella/commit/0d1d6ea9fab2a645d6c5f2bf2591459b939c09b6))
+- restructure Edge & ID handling ([9e12172](https://github.com/thi-ng/umbrella/commit/9e12172))
+- BREAKING CHANGE: require explict ID args, add defEdge()
+  - replace static Edge.create() with defEdge()
+  - remove automatic ID generation and require explicit ID args for:
+    - defEdge()
+    - Edge.connect()
 
+### [2.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/quad-edge@2.0.1) (2021-10-13)
 
-### BREAKING CHANGES
+#### ♻️ Refactoring
 
-* discontinue CommonJS & UMD versions
+- update imports in all tests/pkgs ([effd591](https://github.com/thi-ng/umbrella/commit/effd591))
 
-- only ESM modules will be published from now on
-- CJS obsolete due to ESM support in recent versions of node:
-  - i.e. launch NodeJS via:
-  - `node --experimental-specifier-resolution=node --experimental-repl-await`
-  - in the node REPL use `await import(...)` instead of `require()`
-- UMD obsolete due to widespread browser support for ESM
+# [2.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/quad-edge@2.0.0) (2021-10-12)
 
-Also:
-- normalize/restructure/reorg all package.json files
-- cleanup all build scripts, remove obsolete
-- switch from mocha to @thi.ng/testament for all tests
+#### 🛑 Breaking changes
 
+- major update of ALL pkgs (export maps, ESM only) ([0d1d6ea](https://github.com/thi-ng/umbrella/commit/0d1d6ea))
+- BREAKING CHANGE: discontinue CommonJS & UMD versions
+  - only ESM modules will be published from now on
+  - CJS obsolete due to ESM support in recent versions of node:
+    - i.e. launch NodeJS via:
+    - `node --experimental-specifier-resolution=node --experimental-repl-await`
+    - in the node REPL use `await import(...)` instead of `require()`
+  - UMD obsolete due to widespread browser support for ESM
+  Also:
+  - normalize/restructure/reorg all package.json files
+  - cleanup all build scripts, remove obsolete
+  - switch from mocha to [@thi.ng/testament](https://github.com/thi-ng/umbrella/tree/main/packages/testament) for all tests
 
+#### ♻️ Refactoring
 
+- update all test stubs ([f2d6d53](https://github.com/thi-ng/umbrella/commit/f2d6d53))
+- update all tests in _all_ pkgs ([8b582bc](https://github.com/thi-ng/umbrella/commit/8b582bc))
+  - update all to use [@thi.ng/testament](https://github.com/thi-ng/umbrella/tree/main/packages/testament)
 
+### [0.2.22](https://github.com/thi-ng/umbrella/tree/@thi.ng/quad-edge@0.2.22) (2020-08-28)
 
+#### ♻️ Refactoring
 
-#  [0.2.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/quad-edge@0.1.4...@thi.ng/quad-edge@0.2.0) (2019-07-07) 
+- update delete op (TS4.0) ([591c924](https://github.com/thi-ng/umbrella/commit/591c924))
 
-###  Features 
+## [0.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/quad-edge@0.2.0) (2019-07-07)
 
-- **quad-edge:** enable TS strict compiler flags (refactor) ([5a6cec1](https://github.com/thi-ng/umbrella/commit/5a6cec1)) 
+#### 🚀 Features
 
-#  0.1.0 (2019-02-05) 
+- enable TS strict compiler flags (refactor) ([5a6cec1](https://github.com/thi-ng/umbrella/commit/5a6cec1))
 
-###  Features 
+#### ♻️ Refactoring
 
-- **quad-edge:** re-import & update quad edge impl (MBP2010) ([ee76797](https://github.com/thi-ng/umbrella/commit/ee76797))
+- address TS strictNullChecks flag ([c95bc8f](https://github.com/thi-ng/umbrella/commit/c95bc8f))

package/README.md

@@ -68,11 +68,11 @@ node --experimental-repl-await
 > const quadEdge = await import("@thi.ng/quad-edge");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 495 bytes
+Package sizes (gzipped, pre-treeshake): ESM: 521 bytes
 
 ## Dependencies
 
-None
+- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 
 ## API
 

package/index.d.ts

@@ -1,13 +1,24 @@
-/**
- * Helper function to set / reset edge ID counter.
- *
- * @param id -
- */
-export declare const setNextID: (id: number) => number;
 /**
  * Type alias for a 4-tuple of {@link Edge} instances.
  */
 export declare type QuadEdge<T> = [Edge<T>, Edge<T>, Edge<T>, Edge<T>];
+/**
+ * Main edge / quadedge factory function. Use this in preference of direct
+ * invocation of the {@link Edge} constructor.
+ *
+ * Creates new {@link QuadEdge} with 4 child edges and returns the first
+ * child/primary edge. If `src` and `dest` are given, they will be associated
+ * with that new edge as end points.
+ *
+ * @remarks
+ * The given `id` MUST be a multiple of 4.
+ *
+ * @param id -
+ * @param src -
+ * @param dest -
+ */
+export declare function defEdge<T>(id: number): Edge<T>;
+export declare function defEdge<T>(id: number, src: T, dest: T): Edge<T>;
 /**
  * Quad-edge implementation after Guibas & Stolfi. Based on C++ versions
  * by Paul Heckbert, Dani Lischinski et al:
@@ -18,18 +29,6 @@ export declare type QuadEdge<T> = [Edge<T>, Edge<T>, Edge<T>, Edge<T>];
  * - {@link http://www.cs.cmu.edu/afs/andrew/scs/cs/15-463/2001/pub/src/a2/lischinski/114.ps}
  */
 export declare class Edge<T> {
-    /**
-     * Main edge / quadedge factory function. Use this in preference of
-     * direct invocation of the {@link Edge} constructor.
-     *
-     * Creates new {@link QuadEdge} with 4 child edges and returns the first
-     * child/primary edge. If `src` and `dest` are not `null`ish, the
-     * given args will be associated with that new edge as end points.
-     *
-     * @param src -
-     * @param dest -
-     */
-    static create<T>(src?: T, dest?: T): Edge<T>;
     id: number;
     parent: QuadEdge<T>;
     origin: T;
@@ -96,7 +95,7 @@ export declare class Edge<T> {
      * @param d -
      */
     setEnds(o: T, d: T): void;
-    connect(e: Edge<T>): Edge<T>;
+    connect(e: Edge<T>, id: number): Edge<T>;
     swap(): void;
     remove(): void;
     /**

package/index.js

@@ -1,10 +1,18 @@
-let NEXT_ID = 0;
-/**
- * Helper function to set / reset edge ID counter.
- *
- * @param id -
- */
-export const setNextID = (id) => (NEXT_ID = (id + 3) & -4);
+import { assert } from "@thi.ng/errors/assert";
+export function defEdge(id, src, dest) {
+    assert((id & 3) === 0, `id must be multiple of 4`);
+    const quad = new Array(4);
+    const a = (quad[0] = new Edge(quad, id));
+    const b = (quad[1] = new Edge(quad, id + 1));
+    const c = (quad[2] = new Edge(quad, id + 2));
+    const d = (quad[3] = new Edge(quad, id + 3));
+    a.onext = a;
+    c.onext = c;
+    b.onext = d;
+    d.onext = b;
+    src && dest && a.setEnds(src, dest);
+    return a;
+}
 /**
  * Quad-edge implementation after Guibas & Stolfi. Based on C++ versions
  * by Paul Heckbert, Dani Lischinski et al:
@@ -19,31 +27,6 @@ export class Edge {
         this.parent = parent;
         this.id = id;
     }
-    /**
-     * Main edge / quadedge factory function. Use this in preference of
-     * direct invocation of the {@link Edge} constructor.
-     *
-     * Creates new {@link QuadEdge} with 4 child edges and returns the first
-     * child/primary edge. If `src` and `dest` are not `null`ish, the
-     * given args will be associated with that new edge as end points.
-     *
-     * @param src -
-     * @param dest -
-     */
-    static create(src, dest) {
-        const quad = new Array(4);
-        const a = (quad[0] = new Edge(quad, NEXT_ID));
-        const b = (quad[1] = new Edge(quad, NEXT_ID + 1));
-        const c = (quad[2] = new Edge(quad, NEXT_ID + 2));
-        const d = (quad[3] = new Edge(quad, NEXT_ID + 3));
-        a.onext = a;
-        c.onext = c;
-        b.onext = d;
-        d.onext = b;
-        NEXT_ID += 4;
-        src && dest && a.setEnds(src, dest);
-        return a;
-    }
     /**
      * Next CW edge from this edge's origin.
      */
@@ -127,8 +110,8 @@ export class Edge {
         this.origin = o;
         this.sym.origin = d;
     }
-    connect(e) {
-        const n = Edge.create();
+    connect(e, id) {
+        const n = defEdge(id);
         n.splice(this.lnext);
         n.sym.splice(e);
         n.setEnds(this.dest, e.origin);

package/package.json

@@ -1,74 +1,82 @@
 {
-    "name": "@thi.ng/quad-edge",
-    "version": "2.0.6",
-    "description": "Quadedge data structure after Guibas & Stolfi",
-    "type": "module",
-    "module": "./index.js",
-    "typings": "./index.d.ts",
-    "sideEffects": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/thi-ng/umbrella.git"
+  "name": "@thi.ng/quad-edge",
+  "version": "3.1.2",
+  "description": "Quadedge data structure after Guibas & Stolfi",
+  "type": "module",
+  "module": "./index.js",
+  "typings": "./index.d.ts",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thi-ng/umbrella.git"
+  },
+  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/quad-edge#readme",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/postspectacular"
     },
-    "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/quad-edge#readme",
-    "funding": [
-        {
-            "type": "github",
-            "url": "https://github.com/sponsors/postspectacular"
-        },
-        {
-            "type": "patreon",
-            "url": "https://patreon.com/thing_umbrella"
-        }
+    {
+      "type": "patreon",
+      "url": "https://patreon.com/thing_umbrella"
+    }
+  ],
+  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "yarn clean && tsc --declaration",
+    "clean": "rimraf '*.js' '*.d.ts' '*.map' doc",
+    "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
+    "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
+    "doc:readme": "yarn doc:stats && tools:readme",
+    "doc:stats": "tools:module-stats",
+    "pub": "yarn npm publish --access public",
+    "test": "testament test"
+  },
+  "dependencies": {
+    "@thi.ng/errors": "^2.1.2"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.18.19",
+    "@thi.ng/testament": "^0.2.2",
+    "rimraf": "^3.0.2",
+    "tools": "^0.0.1",
+    "typedoc": "^0.22.9",
+    "typescript": "^4.5.2"
+  },
+  "keywords": [
+    "2d",
+    "3d",
+    "adjacency",
+    "datastructure",
+    "dual",
+    "geometry",
+    "graph",
+    "mesh",
+    "quadedge",
+    "topology",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=12.7"
+  },
+  "files": [
+    "*.js",
+    "*.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    }
+  },
+  "thi.ng": {
+    "related": [
+      "geom-voronoi"
     ],
-    "author": "Karsten Schmidt <k+npm@thi.ng>",
-    "license": "Apache-2.0",
-    "scripts": {
-        "build": "yarn clean && tsc --declaration",
-        "clean": "rimraf *.js *.d.ts *.map doc",
-        "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
-        "doc:ae": "mkdir -p .ae/doc .ae/temp && node_modules/.bin/api-extractor run --local --verbose",
-        "doc:readme": "yarn doc:stats && ../../scripts/node-esm ../../tools/src/readme.ts",
-        "doc:stats": "../../scripts/node-esm ../../tools/src/module-stats.ts",
-        "pub": "yarn build && yarn publish --access public",
-        "test": "testament test"
-    },
-    "devDependencies": {
-        "@thi.ng/testament": "^0.1.6"
-    },
-    "keywords": [
-        "2d",
-        "3d",
-        "adjacency",
-        "datastructure",
-        "dual",
-        "geometry",
-        "graph",
-        "mesh",
-        "quadedge",
-        "topology",
-        "typescript"
-    ],
-    "publishConfig": {
-        "access": "public"
-    },
-    "engines": {
-        "node": ">=12.7"
-    },
-    "files": [
-        "*.js",
-        "*.d.ts"
-    ],
-    "exports": {
-        ".": {
-            "import": "./index.js"
-        }
-    },
-    "thi.ng": {
-        "related": [
-            "geom-voronoi"
-        ],
-        "year": 2015
-    },
-    "gitHead": "c17a556ad25f6882dfa8f806a1d9e8ed7ac7cd71"
-}
+    "year": 2015
+  },
+  "gitHead": "e8a7c2a40191b391cef182c2978e5a6c85987a87\n"
+}