@thi.ng/axidraw 1.1.38 → 1.1.40

package/commands.js

@@ -1,94 +1,58 @@
-export const START = ["start"];
-export const STOP = ["stop"];
-export const HOME = ["home"];
-export const RESET = ["reset"];
-export const ON = ["on"];
-export const OFF = ["off"];
-export const SAVE = ["save"];
-export const RESTORE = ["restore"];
-/**
- * Creates a {@link PenConfigCommand} using provided down/up positions.
- *
- * @param posDown
- * @param posUp
- */
-export const PEN = (posDown, posUp) => [
-    "pen",
-    posDown,
-    posUp,
+const START = ["start"];
+const STOP = ["stop"];
+const HOME = ["home"];
+const RESET = ["reset"];
+const ON = ["on"];
+const OFF = ["off"];
+const SAVE = ["save"];
+const RESTORE = ["restore"];
+const PEN = (posDown, posUp) => [
+  "pen",
+  posDown,
+  posUp
 ];
-/**
- * Creates a {@link PenUpDownCommand} to move the pen up. Both args are optional
- * and if omitted globally configured values are used.
- *
- * @param delay
- * @param level
- */
-export const UP = (delay, level) => [
-    "u",
-    delay,
-    level,
+const UP = (delay, level) => [
+  "u",
+  delay,
+  level
 ];
-/**
- * Creates a {@link PenUpDownCommand} to move the pen down. Both args are
- * optional and if omitted globally configured values are used.
- *
- * @param delay
- * @param level
- */
-export const DOWN = (delay, level) => [
-    "d",
-    delay,
-    level,
+const DOWN = (delay, level) => [
+  "d",
+  delay,
+  level
 ];
-/**
- * Creates a {@link MoveXYCommand} command (absolute coordinates).
- *
- * @param pos
- * @param speed
- */
-export const MOVE = (pos, speed = 1) => [
-    "M",
-    pos,
-    speed,
+const MOVE = (pos, speed = 1) => [
+  "M",
+  pos,
+  speed
 ];
-/**
- * Creates a {@link MoveRelCommand} command (relative coordinates).
- *
- * @param delta
- * @param speed
- */
-export const MOVE_REL = (delta, speed = 1) => [
-    "m",
-    delta,
-    speed,
+const MOVE_REL = (delta, speed = 1) => [
+  "m",
+  delta,
+  speed
 ];
-/**
- * Creates a {@link WaitCommand}. Default delay is 1000 ms.
- *
- * @param delay
- */
-export const WAIT = (delay = 1000) => ["w", delay];
-/**
- * Creates a {@link CommentCommand}.
- *
- * @param msg
- */
-export const COMMENT = (msg) => ["comment", msg];
-/**
- * Syntax sugar. Takes an iterable of draw commands, adds {@link START} as
- * prefix and {@link STOP} as suffix. I.e. it creates a "complete" drawing...
- *
- * @example
- * ```ts
- * [...complete([ MOVE([0, 0]) ])]
- * // [ ["start"], ["M", [0, 0]], ["stop"] ]
- * ```
- *
- * @param commands
- */
-export function* complete(commands) {
-    yield START;
-    yield* commands;
-    yield STOP;
+const WAIT = (delay = 1e3) => ["w", delay];
+const COMMENT = (msg) => ["comment", msg];
+function* complete(commands) {
+  yield START;
+  yield* commands;
+  yield STOP;
 }
+export {
+  COMMENT,
+  DOWN,
+  HOME,
+  MOVE,
+  MOVE_REL,
+  OFF,
+  ON,
+  PEN,
+  RESET,
+  RESTORE,
+  SAVE,
+  START,
+  STOP,
+  UP,
+  WAIT,
+  complete
+};

package/control.js

@@ -1,35 +1,30 @@
 import { AxiDrawState } from "./api.js";
-/**
- * Default implementation with easy-to-use API to control the processing of draw
- * commands via {@link AxiDraw.draw}.
- *
- * @remarks
- * See {@link AxiDrawOpts.control} for further details.
- */
-export class AxiDrawControl {
-    interval;
-    state = AxiDrawState.CONTINUE;
-    constructor(interval = 1000) {
-        this.interval = interval;
+class AxiDrawControl {
+  constructor(interval = 1e3) {
+    this.interval = interval;
+  }
+  state = AxiDrawState.CONTINUE;
+  deref() {
+    return this.state;
+  }
+  reset() {
+    this.state = AxiDrawState.CONTINUE;
+    return this;
+  }
+  pause() {
+    if (this.state === AxiDrawState.CONTINUE) {
+      this.state = AxiDrawState.PAUSE;
     }
-    deref() {
-        return this.state;
-    }
-    reset() {
-        this.state = AxiDrawState.CONTINUE;
-        return this;
-    }
-    pause() {
-        if (this.state === AxiDrawState.CONTINUE) {
-            this.state = AxiDrawState.PAUSE;
-        }
-    }
-    resume() {
-        if (this.state === AxiDrawState.PAUSE) {
-            this.state = AxiDrawState.CONTINUE;
-        }
-    }
-    cancel() {
-        this.state = AxiDrawState.CANCEL;
+  }
+  resume() {
+    if (this.state === AxiDrawState.PAUSE) {
+      this.state = AxiDrawState.CONTINUE;
     }
+  }
+  cancel() {
+    this.state = AxiDrawState.CANCEL;
+  }
 }
+export {
+  AxiDrawControl
+};

package/dip.js

@@ -1,52 +1,17 @@
 import { flatten1 } from "@thi.ng/transducers/flatten1";
 import { repeatedly } from "@thi.ng/transducers/repeatedly";
 import { DOWN, RESTORE, SAVE, UP } from "./commands.js";
-/**
- * Yields a **sequence** of `n` repetitions of {@link DOWN}, {@link UP}
- * commands, optionally interspersed with other user provided
- * {@link DrawCommand}s, e.g. for dipping & moving a brush a few times into a
- * paint reservoir to refill.
- *
- * @example
- * ```ts
- * // simple 2x up/down
- * [...DIP(2)]
- * // [
- * //   [ "d", undefined ],
- * //   [ "u", undefined ],
- * //   [ "d", undefined ],
- * //   [ "u", undefined ],
- * // ]
- *
- * // 3x dipping with custom up/down delays, each time at a random position
- * [...DIP(3, {
- *   down: 300,
- *   up: 400,
- *   commands: () => [ MOVE([Math.random()* 5, Math.random()* 5]) ]
- * })]
- * // [
- * //   [ "d", 300 ],
- * //   [ "M", [ 3.996, 1.707 ], 1 ],
- * //   [ "u", 400 ],
- * //   [ "d", 300 ],
- * //   [ "M", [ 4.747, 4.925 ], 1 ],
- * //   [ "u", 400 ],
- * //   [ "d", 300 ],
- * //   [ "M", [ 1.751, 0.670 ], 1 ],
- * //   [ "u", 400 ]
- * // ]
- * ```
- *
- * @param n
- * @param opts
- */
-export const dip = (n, opts = {}) => {
-    const down = DOWN(opts.downDelay, opts.down);
-    const up = UP(opts.upDelay, opts.up);
-    const main = flatten1(repeatedly(opts.commands
-        ? () => [down, ...opts.commands(), up]
-        : () => [down, up], n));
-    return opts.down !== undefined || opts.up !== undefined
-        ? [SAVE, ...main, RESTORE]
-        : main;
+const dip = (n, opts = {}) => {
+  const down = DOWN(opts.downDelay, opts.down);
+  const up = UP(opts.upDelay, opts.up);
+  const main = flatten1(
+    repeatedly(
+      opts.commands ? () => [down, ...opts.commands(), up] : () => [down, up],
+      n
+    )
+  );
+  return opts.down !== void 0 || opts.up !== void 0 ? [SAVE, ...main, RESTORE] : main;
+};
+export {
+  dip
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/axidraw",
-  "version": "1.1.38",
+  "version": "1.1.40",
   "description": "Minimal AxiDraw plotter/drawing machine controller for Node.js",
   "type": "module",
   "module": "./index.js",
@@ -24,7 +24,9 @@
   "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
-    "build": "yarn clean && tsc --declaration",
+    "build": "yarn build:esbuild && yarn build:decl",
+    "build:decl": "tsc --declaration --emitDeclarationOnly",
+    "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "rimraf --glob '*.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",
@@ -33,21 +35,21 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.10",
-    "@thi.ng/checks": "^3.4.10",
-    "@thi.ng/compose": "^2.1.49",
-    "@thi.ng/date": "^2.5.4",
-    "@thi.ng/errors": "^2.4.4",
-    "@thi.ng/logger": "^2.0.1",
-    "@thi.ng/math": "^5.7.5",
-    "@thi.ng/transducers": "^8.8.13",
-    "@thi.ng/units": "^0.4.17",
-    "@thi.ng/vectors": "^7.8.7",
+    "@thi.ng/api": "^8.9.12",
+    "@thi.ng/checks": "^3.4.12",
+    "@thi.ng/compose": "^2.1.51",
+    "@thi.ng/date": "^2.5.6",
+    "@thi.ng/errors": "^2.4.6",
+    "@thi.ng/logger": "^2.0.2",
+    "@thi.ng/math": "^5.7.7",
+    "@thi.ng/transducers": "^8.8.15",
+    "@thi.ng/units": "^0.4.19",
+    "@thi.ng/vectors": "^7.8.9",
     "serialport": "^12.0.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.38.3",
-    "@thi.ng/testament": "^0.4.3",
+    "esbuild": "^0.19.8",
     "rimraf": "^5.0.5",
     "tools": "^0.0.1",
     "typedoc": "^0.25.4",
@@ -114,5 +116,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "04d1de79f256d7a53c6b5fd157b37f49bc88e11d\n"
+  "gitHead": "5e7bafedfc3d53bc131469a28de31dd8e5b4a3ff\n"
 }

package/palettes.js

@@ -7,139 +7,75 @@ import { madd2 } from "@thi.ng/vectors/madd";
 import { maddN2 } from "@thi.ng/vectors/maddn";
 import { MOVE } from "./commands.js";
 import { dip } from "./dip.js";
-/**
- * Higher order {@link DrawCommand} sequence generator for working with paint
- * brushes. Takes an config object describing a linear paint palette layout and
- * behavior options for dipping the brush. Returns a function which takes a
- * palette slot index as argument and returns a command sequence moving the
- * plotter to the palette slot and dipping the brush to refill.
- *
- * @remarks
- * Can be used with
- * [InterleaveOpts](https://docs.thi.ng/umbrella/geom-axidraw/interfaces/InterleaveOpts.html)
- * of https://thi.ng/geom-axidraw.
- *
- * Also see:
- * - {@link LinearPaletteOpts} for options
- * - {@link radialPalette} for circular/elliptical palette layouts
- * - {@link dip} (used internally for dipping sequence)
- *
- * @example
- * ```ts
- * import { points } from "@thi.ng/geom";
- * import { asAxiDraw } from "@thi.ng/geom-axidraw";
- * import { repeatedly } from "@thi.ng/transducers";
- * import { randMinMax2 } from "@thi.ng/vectors";
- *
- * // configure palette
- * const palette = linearPalette({
- *   // first palette slot is near the world origin (slight offset)
- *   pos: [2, 0],
- *   // palette has 5 paint slots
- *   num: 5,
- *   // each slot 40mm separation along Y-axis
- *   // (needs to be measured/determined manually)
- *   step: [0, 40],
- *   // 2mm jitter radius (to not always move to exact same position)
- *   jitter: 2,
- *   // dip brush 3x each time
- *   repeat: 3,
- * });
- *
- * // investigate command sequence for requesting slot #1
- * palette(1)
- * // [
- * //   [ "M", [ 0.8949, 41.6697 ], 1 ],
- * //   [ "d", undefined, undefined ],
- * //   [ "u", undefined, undefined ],
- * //   [ "d", undefined, undefined ],
- * //   [ "u", undefined, undefined ],
- * //   [ "d", undefined, undefined ],
- * //   [ "u", undefined, undefined ]
- * // ]
- *
- * // define point cloud of 100 random points
- * // using a random palette slot each time (for each refill)
- * // assign axidraw-specific attribs to refill brush every 10 dots
- * const cloud = points(
- *   [...repeatedly(() => randMinMax2([], [10, 10], [190, 190]), 100)],
- *   {
- *     __axi: {
- *       interleave: {
- *         num: 10,
- *         commands: () => palette((Math.random() * 5) | 0)
- *       }
- *     }
- *   }
- * );
- *
- * // AxiDraw setup
- * const axi = new AxiDraw();
- * ...
- *
- * // convert geometry into axidraw commands and send to plotter
- * axi.draw(asAxiDraw(cloud));
- * ```
- *
- * @param opts
- */
-export const linearPalette = (opts) => {
-    const $opts = {
-        pos: [0, 0],
-        repeat: 1,
-        jitter: 0,
-        ...opts,
-    };
-    const dipOpts = __dipOpts($opts);
-    return (id) => {
-        if (id < 0 || id >= $opts.num) {
-            illegalArgs(`invalid palette index: ${id}`);
-        }
-        return [
-            MOVE(jitter(null, maddN2([], $opts.step, id, $opts.pos), $opts.jitter)),
-            ...dip($opts.repeat, dipOpts),
-        ];
-    };
+const linearPalette = (opts) => {
+  const $opts = {
+    pos: [0, 0],
+    repeat: 1,
+    jitter: 0,
+    ...opts
+  };
+  const dipOpts = __dipOpts($opts);
+  return (id) => {
+    if (id < 0 || id >= $opts.num) {
+      illegalArgs(`invalid palette index: ${id}`);
+    }
+    return [
+      MOVE(
+        jitter(
+          null,
+          maddN2([], $opts.step, id, $opts.pos),
+          $opts.jitter
+        )
+      ),
+      ...dip($opts.repeat, dipOpts)
+    ];
+  };
 };
-/**
- * Higher order {@link DrawCommand} sequence generator for working with paint
- * brushes. Similar to {@link linearPalette}, but for circular or elliptic
- * palette layouts.
- *
- * @remarks
- * Also see:
- * - {@link RadialPaletteOpts} for options
- * - {@link linearPalette} for more details & code example
- * - {@link dip} (used internally for dipping sequence)
- *
- * @param opts
- */
-export const radialPalette = (opts) => {
-    const $opts = {
-        repeat: 1,
-        jitter: 0,
-        startTheta: 0,
-        endTheta: Math.PI * 2,
-        ...opts,
-    };
-    const radius = isNumber($opts.radius)
-        ? [$opts.radius, $opts.radius]
-        : $opts.radius;
-    const dipOpts = __dipOpts($opts);
-    return (id) => {
-        if (id < 0 || id >= $opts.num) {
-            illegalArgs(`invalid palette index: ${id}`);
-        }
-        return [
-            MOVE(jitter(null, madd2(null, cossin(mix($opts.startTheta, $opts.endTheta, id / $opts.num)), radius, $opts.pos), $opts.jitter)),
-            ...dip($opts.repeat, dipOpts),
-        ];
-    };
+const radialPalette = (opts) => {
+  const $opts = {
+    repeat: 1,
+    jitter: 0,
+    startTheta: 0,
+    endTheta: Math.PI * 2,
+    ...opts
+  };
+  const radius = isNumber($opts.radius) ? [$opts.radius, $opts.radius] : $opts.radius;
+  const dipOpts = __dipOpts($opts);
+  return (id) => {
+    if (id < 0 || id >= $opts.num) {
+      illegalArgs(`invalid palette index: ${id}`);
+    }
+    return [
+      MOVE(
+        jitter(
+          null,
+          madd2(
+            null,
+            cossin(
+              mix(
+                $opts.startTheta,
+                $opts.endTheta,
+                id / $opts.num
+              )
+            ),
+            radius,
+            $opts.pos
+          ),
+          $opts.jitter
+        )
+      ),
+      ...dip($opts.repeat, dipOpts)
+    ];
+  };
 };
 const __dipOpts = (opts) => ({
-    down: opts.down,
-    downDelay: opts.downDelay,
-    up: opts.up,
-    upDelay: opts.upDelay,
-    commands: opts.commands,
+  down: opts.down,
+  downDelay: opts.downDelay,
+  up: opts.up,
+  upDelay: opts.upDelay,
+  commands: opts.commands
 });
+export {
+  linearPalette,
+  radialPalette
+};

package/polyline.js

@@ -1,37 +1,27 @@
 import { DOWN, MOVE, PEN, UP } from "./commands.js";
-/**
- * Takes an array of 2D points and yields an iterable of {@link DrawCommand}s.
- * The drawing behavior can be customized via additional {@link PolylineOpts}
- * given.
- *
- * @remarks
- * The resulting command sequence assumes the pen is in the **up** position at
- * the beginning of the line. Each polyline will end with a {@link UP} command.
- *
- * @param pts
- * @param opts
- */
-export function* polyline(pts, opts) {
-    if (!pts.length)
-        return;
-    const { speed, delayDown, delayUp, down, onlyGeo } = {
-        speed: 1,
-        onlyGeo: false,
-        ...opts,
-    };
-    if (onlyGeo) {
-        for (let p of pts)
-            yield MOVE(p, speed);
-        return;
-    }
-    yield MOVE(pts[0]);
-    if (down !== undefined)
-        yield PEN(down);
-    yield DOWN(delayDown);
-    for (let i = 1, n = pts.length; i < n; i++)
-        yield MOVE(pts[i], speed);
-    yield UP(delayUp);
-    // reset pen to configured defaults
-    if (down !== undefined)
-        yield PEN();
+function* polyline(pts, opts) {
+  if (!pts.length)
+    return;
+  const { speed, delayDown, delayUp, down, onlyGeo } = {
+    speed: 1,
+    onlyGeo: false,
+    ...opts
+  };
+  if (onlyGeo) {
+    for (let p of pts)
+      yield MOVE(p, speed);
+    return;
+  }
+  yield MOVE(pts[0]);
+  if (down !== void 0)
+    yield PEN(down);
+  yield DOWN(delayDown);
+  for (let i = 1, n = pts.length; i < n; i++)
+    yield MOVE(pts[i], speed);
+  yield UP(delayUp);
+  if (down !== void 0)
+    yield PEN();
 }
+export {
+  polyline
+};

package/registration.js

@@ -2,35 +2,28 @@ import { map } from "@thi.ng/transducers/map";
 import { normRange } from "@thi.ng/transducers/norm-range";
 import { cartesian2 } from "@thi.ng/vectors/cartesian";
 import { DOWN, MOVE, UP } from "./commands.js";
-/**
- * Generates a {@link DrawCommand} sequence to draw a registration mark
- * (crosshair + circle) centered around `pos`.
- *
- * @example
- * ```ts
- * axi.draw(registrationMark([20, 20]))
- * ```
- *
- * @param pos
- * @param size
- * @param r
- */
-export const registrationMark = ([x, y], size = 5, r = size * 0.75) => [
-    // crosshair
-    // horizontal
-    MOVE([x - size, y]),
-    DOWN(),
-    MOVE([x + size, y]),
-    UP(),
-    // vertical
-    MOVE([x, y - size]),
-    DOWN(),
-    MOVE([x, y + size]),
-    UP(),
-    // circle
-    MOVE([x + r, y]),
-    DOWN(),
-    ...map((t) => MOVE(cartesian2([], [r, t * Math.PI * 2], [x, y])), normRange(40)),
-    UP(),
-    MOVE([x, y]),
+const registrationMark = ([x, y], size = 5, r = size * 0.75) => [
+  // crosshair
+  // horizontal
+  MOVE([x - size, y]),
+  DOWN(),
+  MOVE([x + size, y]),
+  UP(),
+  // vertical
+  MOVE([x, y - size]),
+  DOWN(),
+  MOVE([x, y + size]),
+  UP(),
+  // circle
+  MOVE([x + r, y]),
+  DOWN(),
+  ...map(
+    (t) => MOVE(cartesian2([], [r, t * Math.PI * 2], [x, y])),
+    normRange(40)
+  ),
+  UP(),
+  MOVE([x, y])
 ];
+export {
+  registrationMark
+};