coily 0.1.1 → 0.3.0

package/dist/index.cjs

@@ -17,7 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -51,13 +58,14 @@ var getArrivalFunction = (behavior) => {
   return result;
 };
 var createSpringImpl = (initial, config, options) => {
+  var _a, _b, _c;
   let state = "resting";
   let velocity = 0;
   let target = initial;
   let value = initial;
-  const restingDistance = Math.max((options == null ? void 0 : options.restingDistance) ?? 1e-4, 0);
-  const restingVelocity = Math.max((options == null ? void 0 : options.restingVelocity) ?? 1e-4, 0);
-  const arrivalFunction = getArrivalFunction((options == null ? void 0 : options.arrivalBehavior) ?? 1);
+  const restingDistance = Math.max((_a = options == null ? void 0 : options.restingDistance) != null ? _a : 1e-4, 0);
+  const restingVelocity = Math.max((_b = options == null ? void 0 : options.restingVelocity) != null ? _b : 1e-4, 0);
+  const arrivalFunction = getArrivalFunction((_c = options == null ? void 0 : options.arrivalBehavior) != null ? _c : 1);
   const emitter = (0, import_mitt.default)();
   const { emit, ...emitterApi } = emitter;
   const spring = {
@@ -67,26 +75,38 @@ var createSpringImpl = (initial, config, options) => {
     },
     set target(val) {
       target = val;
-      if (Math.abs(value - target) > restingDistance) {
+      if (state !== "moving" && Math.abs(value - target) > restingDistance) {
         state = "moving";
         emit("update:state", state);
       }
     },
+    getTarget: () => target,
     get value() {
       return value;
     },
+    getValue: () => value,
     get velocity() {
       return velocity;
     },
+    getVelocity: () => velocity,
     get state() {
       return state;
     },
+    getState: () => state,
     get config() {
       return config;
     },
     set config(value2) {
       config = value2;
     },
+    getConfig: () => config,
+    jumpTo: (_value, killVelocity = true) => {
+      value = _value;
+      if (killVelocity) {
+        velocity = 0;
+      }
+      state = Math.abs(velocity) > restingVelocity || Math.abs(value - target) > restingDistance ? "moving" : "resting";
+    },
     freeze: () => {
       state = "frozen";
       emit("update:state", state);
@@ -96,13 +116,15 @@ var createSpringImpl = (initial, config, options) => {
       emit("update:state", state);
     }
   };
+  const tension = -config.tension * 1e-6;
+  const friction = -config.friction * 1e-3;
   const simulate = (deltaTime) => {
     if (state === "moving") {
       const iterations = Math.ceil(deltaTime);
       for (let n = 0; n < iterations; n++) {
         const previousDelta = value - target;
-        const springForce = -config.tension * 1e-6 * previousDelta;
-        const dampingForce = -config.friction * 1e-3 * velocity;
+        const springForce = tension * previousDelta;
+        const dampingForce = friction * velocity;
         const acceleration = (springForce + dampingForce) / config.mass;
         velocity = velocity + acceleration;
         value = value + velocity;
@@ -161,7 +183,12 @@ var createSpringChainImpl = (initial, links, config, options) => {
         if (typeof link === "number") {
           spring.target = previousSpring.value + link;
         } else {
-          spring.target = link(previousSpring.value, previousSpring.target, spring.value, spring.target);
+          spring.target = link(
+            previousSpring.value,
+            previousSpring.target,
+            spring.value,
+            spring.target
+          );
         }
         targets[index + 1] = spring.target;
         states[index + 1] = spring.state;
@@ -169,7 +196,11 @@ var createSpringChainImpl = (initial, links, config, options) => {
           state = "moving";
         }
       } else {
-        const [spring, simulate2] = createSpringImpl(typeof link === "number" ? previousSpring.value + link : link(previousSpring.value, previousSpring.target), config, options);
+        const [spring, simulate2] = createSpringImpl(
+          typeof link === "number" ? previousSpring.value + link : link(previousSpring.value, previousSpring.target),
+          config,
+          options
+        );
         springs.push(spring);
         simulateFns.push(simulate2);
         targets[index + 1] = spring.target;
@@ -224,9 +255,11 @@ var createSpringChainImpl = (initial, links, config, options) => {
         currentTarget = val;
         updateChainState(currentTarget, currentLinks);
       },
+      getTarget: () => targets[0],
       get targets() {
         return targets;
       },
+      getTargets: () => targets,
       get links() {
         return links;
       },
@@ -237,18 +270,23 @@ var createSpringChainImpl = (initial, links, config, options) => {
       get config() {
         return config;
       },
+      getConfig: () => config,
       get values() {
         return values;
       },
+      getValues: () => values,
       get velocities() {
         return velocities;
       },
+      getVelocities: () => velocities,
       get state() {
         return state;
       },
+      getState: () => state,
       get states() {
         return states;
       },
+      getStates: () => states,
       freeze: () => {
         for (const spring of springs) {
           spring.freeze();

package/dist/index.d.ts

@@ -5,46 +5,59 @@ interface SpringConfig {
     tension: number;
     friction: number;
 }
-declare type SpringArrivalBehavior = 'bounce' | 'clamp' | 'none' | number | ((velocity: number) => number);
+type SpringArrivalBehavior = 'bounce' | 'clamp' | 'none' | number | ((velocity: number) => number);
 interface SpringOptions {
     restingDistance?: number;
     restingVelocity?: number;
     arrivalBehavior?: SpringArrivalBehavior;
 }
-declare type SpringState = 'moving' | 'frozen' | 'resting';
-declare type SpringEmitter = Emitter<{
+type SpringState = 'moving' | 'frozen' | 'resting';
+type SpringEmitter = Emitter<{
     'update:value': number;
     'update:state': SpringState;
     '*': number | SpringState;
 }>;
 interface Spring extends Omit<SpringEmitter, 'emit'> {
     target: number;
+    readonly getTarget: () => number;
     config: Readonly<SpringConfig>;
+    readonly getConfig: () => Readonly<SpringConfig>;
     readonly value: number;
+    readonly getValue: () => number;
     readonly velocity: number;
+    readonly getVelocity: () => number;
     readonly state: SpringState;
+    readonly getState: () => SpringState;
+    readonly jumpTo: (value: number, killVelocity?: boolean) => void;
     readonly freeze: () => void;
     readonly unfreeze: () => void;
 }
-declare type SimulateFn = (delta: number) => void;
+type SimulateFn = (delta: number) => void;
 interface StandaloneSpring extends Spring {
     readonly simulate: SimulateFn;
 }
-declare type SpringChainLinkGetter = number | ((previousValue: number, previousTarget: number, currentValue?: number, currentTarget?: number) => number);
-declare type SpringChainEmitter = Emitter<{
+type SpringChainLinkGetter = number | ((previousValue: number, previousTarget: number, currentValue?: number, currentTarget?: number) => number);
+type SpringChainEmitter = Emitter<{
     'update:value': number[];
     'update:state': SpringState;
     '*': number[] | SpringState;
 }>;
 interface SpringChain extends Omit<SpringChainEmitter, 'emit'> {
     target: number;
+    readonly getTarget: () => number;
     links: SpringChainLinkGetter[];
     config: Readonly<SpringConfig>;
+    readonly getConfig: () => Readonly<SpringConfig>;
     readonly targets: ReadonlyArray<number>;
+    readonly getTargets: () => ReadonlyArray<number>;
     readonly values: ReadonlyArray<number>;
+    readonly getValues: () => ReadonlyArray<number>;
     readonly velocities: ReadonlyArray<number>;
+    readonly getVelocities: () => ReadonlyArray<number>;
     readonly state: SpringState;
+    readonly getState: () => SpringState;
     readonly states: ReadonlyArray<SpringState>;
+    readonly getStates: () => ReadonlyArray<SpringState>;
     readonly freeze: () => void;
     readonly unfreeze: () => void;
 }

package/dist/index.js

@@ -20,13 +20,14 @@ var getArrivalFunction = (behavior) => {
   return result;
 };
 var createSpringImpl = (initial, config, options) => {
+  var _a, _b, _c;
   let state = "resting";
   let velocity = 0;
   let target = initial;
   let value = initial;
-  const restingDistance = Math.max((options == null ? void 0 : options.restingDistance) ?? 1e-4, 0);
-  const restingVelocity = Math.max((options == null ? void 0 : options.restingVelocity) ?? 1e-4, 0);
-  const arrivalFunction = getArrivalFunction((options == null ? void 0 : options.arrivalBehavior) ?? 1);
+  const restingDistance = Math.max((_a = options == null ? void 0 : options.restingDistance) != null ? _a : 1e-4, 0);
+  const restingVelocity = Math.max((_b = options == null ? void 0 : options.restingVelocity) != null ? _b : 1e-4, 0);
+  const arrivalFunction = getArrivalFunction((_c = options == null ? void 0 : options.arrivalBehavior) != null ? _c : 1);
   const emitter = mitt();
   const { emit, ...emitterApi } = emitter;
   const spring = {
@@ -36,26 +37,38 @@ var createSpringImpl = (initial, config, options) => {
     },
     set target(val) {
       target = val;
-      if (Math.abs(value - target) > restingDistance) {
+      if (state !== "moving" && Math.abs(value - target) > restingDistance) {
         state = "moving";
         emit("update:state", state);
       }
     },
+    getTarget: () => target,
     get value() {
       return value;
     },
+    getValue: () => value,
     get velocity() {
       return velocity;
     },
+    getVelocity: () => velocity,
     get state() {
       return state;
     },
+    getState: () => state,
     get config() {
       return config;
     },
     set config(value2) {
       config = value2;
     },
+    getConfig: () => config,
+    jumpTo: (_value, killVelocity = true) => {
+      value = _value;
+      if (killVelocity) {
+        velocity = 0;
+      }
+      state = Math.abs(velocity) > restingVelocity || Math.abs(value - target) > restingDistance ? "moving" : "resting";
+    },
     freeze: () => {
       state = "frozen";
       emit("update:state", state);
@@ -65,13 +78,15 @@ var createSpringImpl = (initial, config, options) => {
       emit("update:state", state);
     }
   };
+  const tension = -config.tension * 1e-6;
+  const friction = -config.friction * 1e-3;
   const simulate = (deltaTime) => {
     if (state === "moving") {
       const iterations = Math.ceil(deltaTime);
       for (let n = 0; n < iterations; n++) {
         const previousDelta = value - target;
-        const springForce = -config.tension * 1e-6 * previousDelta;
-        const dampingForce = -config.friction * 1e-3 * velocity;
+        const springForce = tension * previousDelta;
+        const dampingForce = friction * velocity;
         const acceleration = (springForce + dampingForce) / config.mass;
         velocity = velocity + acceleration;
         value = value + velocity;
@@ -130,7 +145,12 @@ var createSpringChainImpl = (initial, links, config, options) => {
         if (typeof link === "number") {
           spring.target = previousSpring.value + link;
         } else {
-          spring.target = link(previousSpring.value, previousSpring.target, spring.value, spring.target);
+          spring.target = link(
+            previousSpring.value,
+            previousSpring.target,
+            spring.value,
+            spring.target
+          );
         }
         targets[index + 1] = spring.target;
         states[index + 1] = spring.state;
@@ -138,7 +158,11 @@ var createSpringChainImpl = (initial, links, config, options) => {
           state = "moving";
         }
       } else {
-        const [spring, simulate2] = createSpringImpl(typeof link === "number" ? previousSpring.value + link : link(previousSpring.value, previousSpring.target), config, options);
+        const [spring, simulate2] = createSpringImpl(
+          typeof link === "number" ? previousSpring.value + link : link(previousSpring.value, previousSpring.target),
+          config,
+          options
+        );
         springs.push(spring);
         simulateFns.push(simulate2);
         targets[index + 1] = spring.target;
@@ -193,9 +217,11 @@ var createSpringChainImpl = (initial, links, config, options) => {
         currentTarget = val;
         updateChainState(currentTarget, currentLinks);
       },
+      getTarget: () => targets[0],
       get targets() {
         return targets;
       },
+      getTargets: () => targets,
       get links() {
         return links;
       },
@@ -206,18 +232,23 @@ var createSpringChainImpl = (initial, links, config, options) => {
       get config() {
         return config;
       },
+      getConfig: () => config,
       get values() {
         return values;
       },
+      getValues: () => values,
       get velocities() {
         return velocities;
       },
+      getVelocities: () => velocities,
       get state() {
         return state;
       },
+      getState: () => state,
       get states() {
         return states;
       },
+      getStates: () => states,
       freeze: () => {
         for (const spring of springs) {
           spring.freeze();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coily",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Simulate values using spring physics",
   "author": "Tim Morris <timthewebguy@gmail.com>",
   "homepage": "https://github.com/tkofh/coily#readme",
@@ -32,18 +32,18 @@
     "test": "vitest run",
     "test:watch": "vitest watch",
     "test:ui": "vitest --ui",
-    "prepublish": "yarn test && yarn build"
+    "prepublish": "pnpm test && pnpm build"
   },
   "bugs": {
     "url": "https://github.com/tkofh/coily/issues"
   },
   "devDependencies": {
-    "@vitest/ui": "^0.11.0",
-    "tsup": "^6.1.3",
-    "vitest": "^0.16.0"
+    "@vitest/ui": "^0.29.2",
+    "tsup": "^6.6.3",
+    "vitest": "^0.29.2"
   },
   "dependencies": {
     "mitt": "^3.0.0"
   },
-  "gitHead": "ed6733ca1768b44341f0ed05f8750466089ddbc1"
+  "gitHead": "f6f52d538e85578e1d734a729e4161f54c5b900f"
 }