Merge branch 'main' into subscription

Author: theSherwood

.github/workflows/tests.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Use Node.js latest
         uses: actions/setup-node@v3
         with:
-          node-version: 17
+          node-version: 20
       - name: npm install, build, and test
         # Note, we run bench and cov just to make sure they run successfully, but we're not doing anything with the result yet.
         run: |

README.md

@@ -13,33 +13,30 @@ compiler).
 
 ## Index
 
+- [Demo](#demo)
 - [Install](#install)
 - [Usage](#usage)
 - [Documentation](#documentation)
 - [Benchmarks](#benchmarks)
 - [Tests](#tests)
 
+## Demo
+
+[Live demo on CodePen.](https://codepen.io/trusktr/pen/abMLVxa?editors=1010)
+
 ## Install
 
+### Local Install
+
 Install using NPM:
 
 ```sh
 npm install @lume/kiwi
 ```
 
-then import it into your project:
-
-```js
-import * as kiwi from '@lume/kiwi'
-
-console.log(kiwi)
-
-// ...use kiwi...
-```
-
 If you have a plain web app with no build, or a non-browser JS runtime that also
 supports import maps like Deno, you'll need to add `@lume/kiwi` to your
-`importmap` script so that the browser knows where to import kiwi from. F.e.
+`importmap` script so that the browser or JS runtime knows where to import kiwi from. F.e.
 something like this:
 
 ```html
@@ -52,8 +49,32 @@ something like this:
 </script>
 ```
 
+### CDN Install
+
+Note, if using importmaps and native ES Modules in a browser, or in a JS runtime like Deno, you can get Kiwi directly from the UNPKG CDN without installing it locally (just as the [live CodePen demo](#demo) does):
+
+```html
+<script type="importmap">
+  {
+    "imports": {
+      "@lume/kiwi": "https://unpkg.com/@lume/[email protected]/dist/kiwi.js"
+    }
+  }
+</script>
+```
+
 ## Usage
 
+After installing, import kiwi into your project:
+
+```js
+import * as kiwi from '@lume/kiwi'
+
+console.log(kiwi)
+
+// ...use kiwi...
+```
+
 The following example creates a solver which automatically calculates a width based on some constraints:
 
 ```js
@@ -76,6 +97,16 @@ solver.addConstraint(new kiwi.Constraint(new kiwi.Expression([-1, right], left,
 solver.updateVariables()
 
 console.assert(right.value() === 500)
+
+// later, update the constraints and re-calculate
+setTimeout(() => {
+  solver.suggestValue(left, 200)
+  solver.suggestValue(width, 600)
+
+  solver.updateVariables() // update
+
+  console.assert(right.value() === 800)
+}, 2000)
 ```
 
 ## Documentation
@@ -84,7 +115,7 @@ console.assert(right.value() === 500)
 
 ## Benchmarks
 
-To run the benchmark in the browser, [just visit this page](https://rawgit.com/IjzerenHein/kiwi/master/bench/index.html).
+To run the benchmark in the browser, [just visit this page](https://raw.githack.com/lume/kiwi/main/bench/index.html).
 
 To run the benchmark locally using nodejs, _clone or download this repository_ and execute the following steps:
 
@@ -111,7 +142,7 @@ Fastest is kiwi (± 2.29x faster)
 
 ## Tests
 
-To run the tests in the browser, [just visit this page](https://rawgit.com/IjzerenHein/kiwi/master/test/index.html).
+To run the tests in the browser, [just visit this page](https://raw.githack.com/lume/kiwi/main/test/index.html).
 
 To run the tests locally using nodejs, _clone or download this repository_ and execute the following steps:
 
@@ -135,12 +166,11 @@ open a pull request!
 
 [![License](https://img.shields.io/badge/license-BDS%203--clause-brightgreen)](<https://tldrlegal.com/license/bsd-3-clause-license-(revised)>)
 
-<!--
-TODO
-
 ## Status
 
-[![Build Status](https://travis-ci.org/IjzerenHein/kiwi.js.svg?branch=master)](https://travis-ci.org/IjzerenHein/kiwi.js)
-[![codecov](https://codecov.io/gh/IjzerenHein/kiwi.js/branch/master/graph/badge.svg)](https://codecov.io/gh/IjzerenHein/kiwi.js)
+[![Build Status](https://github.com/lume/kiwi/actions/workflows/tests.yml/badge.svg)](https://github.com/lume/kiwi/actions/workflows/tests.yml)
 
+<!--
+TODO coverage status
+[![codecov](https://codecov.io/gh/IjzerenHein/kiwi.js/branch/master/graph/badge.svg)](https://codecov.io/gh/IjzerenHein/kiwi.js)
 -->

dist/solver.d.ts

@@ -44,6 +44,12 @@ export declare class Solver {
      * @return {Bool} true or false
      */
     hasConstraint(constraint: Constraint): boolean;
+    /**
+     * Get an array of the current constraints.
+     *
+     * @return {Constraint[]}
+     */
+    getConstraints(): Constraint[];
     /**
      * Add an edit variable to the solver.
      *

dist/solver.d.ts.map

@@ -124,6 +124,14 @@ export class Solver {
     hasConstraint(constraint) {
         return this._cnMap.contains(constraint);
     }
+    /**
+     * Get an array of the current constraints.
+     *
+     * @return {Constraint[]}
+     */
+    getConstraints() {
+        return this._cnMap.array.map(({ first }) => first);
+    }
     /**
      * Add an edit variable to the solver.
      *

dist/solver.js

@@ -80,6 +80,7 @@ console.assert(centerX.value() === 250)
     - [.addConstraint(constraint)](#module_@lume/kiwi..Solver+addConstraint)
     - [.removeConstraint(constraint)](#module_@lume/kiwi..Solver+removeConstraint)
     - [.hasConstraint(constraint)](#module_@lume/kiwi..Solver+hasConstraint) ⇒ <code>Bool</code>
+    - [.getConstraints()](#module_@lume/kiwi..Solver+getConstraints) ⇒ <code>[ &#x27;Array&#x27; ].&lt;Constraint&gt;</code>
     - [.addEditVariable(variable, strength)](#module_@lume/kiwi..Solver+addEditVariable)
     - [.removeEditVariable(variable)](#module_@lume/kiwi..Solver+removeEditVariable)
     - [.hasEditVariable(variable)](#module_@lume/kiwi..Solver+hasEditVariable) ⇒ <code>Bool</code>
@@ -430,6 +431,7 @@ The constraint solver class.
   - [.addConstraint(constraint)](#module_@lume/kiwi..Solver+addConstraint)
   - [.removeConstraint(constraint)](#module_@lume/kiwi..Solver+removeConstraint)
   - [.hasConstraint(constraint)](#module_@lume/kiwi..Solver+hasConstraint) ⇒ <code>Bool</code>
+  - [.getConstraints()](#module_@lume/kiwi..Solver+getConstraints) ⇒ <code>[ &#x27;Array&#x27; ].&lt;Constraint&gt;</code>
   - [.addEditVariable(variable, strength)](#module_@lume/kiwi..Solver+addEditVariable)
   - [.removeEditVariable(variable)](#module_@lume/kiwi..Solver+removeEditVariable)
   - [.hasEditVariable(variable)](#module_@lume/kiwi..Solver+hasEditVariable) ⇒ <code>Bool</code>
@@ -501,6 +503,13 @@ Test whether the solver contains the constraint.
 | ---------- | ----------------------- | ---------------------- |
 | constraint | <code>Constraint</code> | Constraint to test for |
 
+<a name="module_@lume/kiwi..Solver+getConstraints"></a>
+
+### solver.getConstraints() ⇒ <code>[ &#x27;Array&#x27; ].&lt;Constraint&gt;</code>
+
+Get an array of the current constraints.
+
+**Kind**: instance method of [<code>Solver</code>](#module_@lume/kiwi..Solver)  
 <a name="module_@lume/kiwi..Solver+addEditVariable"></a>
 
 ### solver.addEditVariable(variable, strength)

docs/Kiwi.md

@@ -1,7 +1,7 @@
 {
 	"name": "@lume/kiwi",
 	"description": "High speed Cassowary constraint solver in JavaScript.",
-	"version": "0.4.1",
+	"version": "0.4.3",
 	"homepage": "https://github.com/lume/kiwi",
 	"repository": "https://github.com/lume/kiwi",
 	"type": "module",

package.json

@@ -143,6 +143,15 @@ export class Solver {
 		return this._cnMap.contains(constraint)
 	}
 
+	/**
+	 * Get an array of the current constraints.
+	 *
+	 * @return {Constraint[]}
+	 */
+	public getConstraints(): Constraint[] {
+		return this._cnMap.array.map(({first}) => first)
+	}
+
 	/**
 	 * Add an edit variable to the solver.
 	 *

src/solver.ts

@@ -205,6 +205,31 @@ describe('import kiwi', function () {
 					assert.equal(err.message, 'unsatisfiable constraint')
 				}
 			})
+			it('solver.addConstraint() => solver.getConstraints()', function () {
+				solver = new kiwi.Solver()
+				var width = new kiwi.Variable()
+				var width2 = new kiwi.Variable()
+				var cn_1 = new kiwi.Constraint(new kiwi.Expression(width, 100), kiwi.Operator.Eq)
+				solver.addConstraint(cn_1)
+				var cn_2 = new kiwi.Constraint(new kiwi.Expression(width2, 100), kiwi.Operator.Eq)
+				solver.addConstraint(cn_2)
+				var cns = solver.getConstraints()
+				assert(cns.indexOf(cn_1) > -1)
+				assert(cns.indexOf(cn_2) > -1)
+			})
+			it('solver.removeConstraint() => solver.getConstraints()', function () {
+				solver = new kiwi.Solver()
+				var width = new kiwi.Variable()
+				var width2 = new kiwi.Variable()
+				var cn_1 = new kiwi.Constraint(new kiwi.Expression(width, 100), kiwi.Operator.Eq)
+				solver.addConstraint(cn_1)
+				var cn_2 = new kiwi.Constraint(new kiwi.Expression(width2, 100), kiwi.Operator.Eq)
+				solver.addConstraint(cn_2)
+				solver.removeConstraint(cn_1)
+				var cns = solver.getConstraints()
+				assert(cns.indexOf(cn_1) === -1)
+				assert(cns.indexOf(cn_2) > -1)
+			})
 		})
 
 		describe('Constraint raw syntax: (expr, operator, undefined, strength)', function () {