jikan0 0.2.0 → 2.0.0

package/README.md

@@ -1,19 +1,16 @@
-Jikan0 strongly typed exercise timer core library
+# jikan0
 
-Consist of object-oriented Timer interface and functional timer finite state machine API under the hood.
+Convenience exports for the timer engine and stateful adapters.
 
-Timer is modeled as a queue data structure with a `step(n: milliseconds)` function over it.
+```ts
+import { empty, push, tick } from 'jikan0';
 
-TODO more docs
+const queued = push([{ kind: 'exercise', duration: 1000 }])(empty);
+if (queued.ok) {
+  const elapsed = tick(400)(queued.state);
+  if (elapsed.ok) console.log(elapsed.state);
+}
+```
 
-# Publishing
-
-Npm package exposed API
-
-`npx nx release p` - will release dependencies
-
-`npx nx build facade`
-
-`node tools/scripts/publish.mjs facade 0.0.4 latest`
-
-used https://github.com/nrwl/nx/issues/4620#issuecomment-1546737883 as build solution for now
+Consumers own state and supply elapsed time. See the [engine](../fsm/README.md)
+and [adapters](../adapters/README.md) for APIs and constraints.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { empty, isEmpty, current, currentNE, tick, push, pop, restart, reset, } from '@jikan0/fsm';
+export { StatefulSimulation as Timer } from '@jikan0/adapters';
+export { MAX_DURATION, MAX_PROGRAM_STAGES, validateDuration, } from '@jikan0/fsm';
+export { createElapsedDriver } from '@jikan0/adapters';
+export type { State, QueueItem, ValidationIssue, TransitionResult, } from '@jikan0/fsm';

package/{src → dist}/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Timer = exports.reset = exports.restart = exports.pop = exports.push = exports.tick = exports.currentNE = exports.current = exports.isEmpty = exports.empty = void 0;
+exports.createElapsedDriver = exports.validateDuration = exports.MAX_PROGRAM_STAGES = exports.MAX_DURATION = exports.Timer = exports.reset = exports.restart = exports.pop = exports.push = exports.tick = exports.currentNE = exports.current = exports.isEmpty = exports.empty = void 0;
 var fsm_1 = require("@jikan0/fsm");
 Object.defineProperty(exports, "empty", { enumerable: true, get: function () { return fsm_1.empty; } });
 Object.defineProperty(exports, "isEmpty", { enumerable: true, get: function () { return fsm_1.isEmpty; } });
@@ -13,4 +13,10 @@ Object.defineProperty(exports, "restart", { enumerable: true, get: function () {
 Object.defineProperty(exports, "reset", { enumerable: true, get: function () { return fsm_1.reset; } });
 var adapters_1 = require("@jikan0/adapters");
 Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return adapters_1.StatefulSimulation; } });
+var fsm_2 = require("@jikan0/fsm");
+Object.defineProperty(exports, "MAX_DURATION", { enumerable: true, get: function () { return fsm_2.MAX_DURATION; } });
+Object.defineProperty(exports, "MAX_PROGRAM_STAGES", { enumerable: true, get: function () { return fsm_2.MAX_PROGRAM_STAGES; } });
+Object.defineProperty(exports, "validateDuration", { enumerable: true, get: function () { return fsm_2.validateDuration; } });
+var adapters_2 = require("@jikan0/adapters");
+Object.defineProperty(exports, "createElapsedDriver", { enumerable: true, get: function () { return adapters_2.createElapsedDriver; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAUqB;AATnB,4FAAA,KAAK,OAAA;AACL,8FAAA,OAAO,OAAA;AACP,8FAAA,OAAO,OAAA;AACP,gGAAA,SAAS,OAAA;AACT,2FAAA,IAAI,OAAA;AACJ,2FAAA,IAAI,OAAA;AACJ,0FAAA,GAAG,OAAA;AACH,8FAAA,OAAO,OAAA;AACP,4FAAA,KAAK,OAAA;AAGP,6CAA+D;AAAtD,iGAAA,kBAAkB,OAAS;AACpC,mCAIqB;AAHnB,mGAAA,YAAY,OAAA;AACZ,yGAAA,kBAAkB,OAAA;AAClB,uGAAA,gBAAgB,OAAA;AAElB,6CAAuD;AAA9C,+GAAA,mBAAmB,OAAA"}

package/package.json

@@ -1,15 +1,40 @@
 {
   "name": "jikan0",
-  "version": "0.2.0",
-  "dependencies": {
-    "tslib": "^2.3.0",
-    "@jikan0/fsm": "1.3.0",
-    "@jikan0/adapters": "1.3.0"
+  "version": "2.0.0",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "license": "MIT",
+  "sideEffects": false,
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
-  "type": "commonjs",
-  "main": "./src/index.js",
-  "typings": "./src/index.d.ts"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dearlordylord/jikan.git",
+    "directory": "facade"
+  },
+  "scripts": {
+    "build": "node ../tools/build-package.cjs",
+    "prepack": "cd .. && npx turbo run build --filter=jikan0..."
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "dependencies": {
+    "@jikan0/adapters": "2.0.0",
+    "@jikan0/fsm": "2.0.0"
+  }
 }

package/src/index.d.ts

@@ -1,2 +0,0 @@
-export { empty, State, QueueItem, isEmpty, current, currentNE, tick, push, pop, restart, reset, } from '@jikan0/fsm';
-export { StatefulSimulation as Timer } from '@jikan0/adapters';

package/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../facade/src/index.ts"],"names":[],"mappings":";;;AAAA,mCAYqB;AAXnB,4FAAA,KAAK,OAAA;AAGL,8FAAA,OAAO,OAAA;AACP,8FAAA,OAAO,OAAA;AACP,gGAAA,SAAS,OAAA;AACT,2FAAA,IAAI,OAAA;AACJ,2FAAA,IAAI,OAAA;AACJ,0FAAA,GAAG,OAAA;AACH,8FAAA,OAAO,OAAA;AACP,4FAAA,KAAK,OAAA;AAGP,6CAA+D;AAAtD,iGAAA,kBAAkB,OAAS"}