@winkjs/composer 0.0.2 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +106 -80
- package/package.json +56 -28
- package/src/composer.js +75 -0
- package/src/core/batch/aoo-encoder.js +148 -0
- package/src/core/batch/index.js +12 -0
- package/src/core/batch/sliding-window.js +91 -0
- package/src/core/codec/index.js +137 -0
- package/src/core/emitter-manager/mqtt/constants.js +102 -0
- package/src/core/emitter-manager/mqtt/emitter.js +780 -0
- package/src/core/emitter-manager/mqtt/index.js +190 -0
- package/src/core/emitter-manager/mqtt/mqtt-store.js +538 -0
- package/src/core/emitter-manager/terminal/assert-columns.js +98 -0
- package/src/core/emitter-manager/terminal/formatters.js +160 -0
- package/src/core/emitter-manager/terminal/index.js +341 -0
- package/src/core/env-vars.js +245 -0
- package/src/core/mqtt-protocol.js +47 -0
- package/src/core/partition-manager/index.js +7 -0
- package/src/core/partition-manager/init.js +44 -0
- package/src/core/partition-manager/introspect.js +15 -0
- package/src/core/partition-manager/publish-to.js +6 -0
- package/src/core/partition-manager/recompute.js +5 -0
- package/src/core/partition-manager/reset.js +5 -0
- package/src/core/partition-manager/update.js +264 -0
- package/src/core/partition-manager/validate-flow.js +157 -0
- package/src/core/semantics/digest.js +128 -0
- package/src/core/semantics/index.js +83 -0
- package/src/core/semantics/loader.js +571 -0
- package/src/core/semantics/schemas/asset-class-schema.js +218 -0
- package/src/core/semantics/schemas/column-schema.js +651 -0
- package/src/core/semantics/schemas/enum-schema.js +153 -0
- package/src/core/semantics/schemas/index.js +51 -0
- package/src/core/semantics/warnings.js +141 -0
- package/src/core/shutdown-manager/index.js +289 -0
- package/src/core/source-manager/csv/index.js +171 -0
- package/src/core/source-manager/csv/start.js +456 -0
- package/src/core/source-manager/mqtt/client.js +406 -0
- package/src/core/source-manager/mqtt/constants.js +147 -0
- package/src/core/source-manager/mqtt/dedup.js +244 -0
- package/src/core/source-manager/mqtt/index.js +260 -0
- package/src/core/source-manager/mqtt/status.js +546 -0
- package/src/core/source-manager/test-harness/comparator.js +226 -0
- package/src/core/source-manager/test-harness/field-generator.js +85 -0
- package/src/core/source-manager/test-harness/fuzz.js +87 -0
- package/src/core/source-manager/test-harness/index.js +115 -0
- package/src/core/source-manager/test-harness/prng.js +57 -0
- package/src/core/source-manager/test-harness/start.js +232 -0
- package/src/core/source-manager/test-harness/validate.js +213 -0
- package/src/core/storage-manager/questdb/assert-columns.js +120 -0
- package/src/core/storage-manager/questdb/ensure-tables.js +187 -0
- package/src/core/storage-manager/questdb/index.js +1251 -0
- package/src/core/storage-manager/questdb/persist-plan.js +488 -0
- package/src/core/storage-manager/questdb/writers.js +142 -0
- package/src/core/test-utils/sealed-record.js +80 -0
- package/src/core/test-utils/soak-signature.js +149 -0
- package/src/core/test-utils/tcp-proxy.js +106 -0
- package/src/core/tunable/helpers.js +254 -0
- package/src/core/tunable/index.js +87 -0
- package/src/core/utils/console-formatter/index.js +207 -0
- package/src/core/utils/create-smart-store-as/index.js +98 -0
- package/src/core/utils/create-smart-store-as/sanitize-field.js +46 -0
- package/src/core/utils/create-smart-store-as/smart-truncate.js +93 -0
- package/src/core/utils/flow/index.js +5 -0
- package/src/core/utils/flow/make-collision-checker.js +23 -0
- package/src/core/utils/flow/to-kebab.js +20 -0
- package/src/core/utils/half-life/index.js +111 -0
- package/src/core/utils/node/disable.js +11 -0
- package/src/core/utils/node/enable.js +11 -0
- package/src/core/utils/node/execute-triggers.js +40 -0
- package/src/core/utils/node/index.js +10 -0
- package/src/core/utils/node/pause.js +11 -0
- package/src/core/utils/node/populate-predicate-inputs.js +14 -0
- package/src/core/utils/node/publish-nan.js +19 -0
- package/src/core/utils/node/reset-predicate-inputs.js +11 -0
- package/src/core/utils/node/unpause.js +11 -0
- package/src/core/utils/node/validate-spec.js +22 -0
- package/src/core/utils/options/resolve-field-keyed.js +115 -0
- package/src/core/utils/quantize/index.js +75 -0
- package/src/core/utils/stats/formulas.js +67 -0
- package/src/core/utils/stats/index.js +3 -0
- package/src/core/utils/validate/composer-validators.js +141 -0
- package/src/core/utils/validate/helpers.js +206 -0
- package/src/core/utils/validate/index.js +12 -0
- package/src/core/utils/validate/type-validators.js +538 -0
- package/src/core/utils/validate/validate.js +107 -0
- package/src/core/utils/validate/validators.js +177 -0
- package/src/core/wiring/assert-handle.js +57 -0
- package/src/core/wiring/assert-module.js +63 -0
- package/src/core/wiring/index.js +5 -0
- package/src/core/wiring/node-type-to-module.js +17 -0
- package/src/core/wiring/wire-emitters.js +256 -0
- package/src/core/wiring/wire-linear-graph.js +25 -0
- package/src/core/wiring/wire-node.js +157 -0
- package/src/core/wiring/wire-semantics.js +173 -0
- package/src/core/wiring/wire-storages.js +344 -0
- package/src/flow/check-output-collisions.js +93 -0
- package/src/flow/consts.js +9 -0
- package/src/flow/deep-clone-spec.js +64 -0
- package/src/flow/driver.js +171 -0
- package/src/flow/expand-single-input-array.js +76 -0
- package/src/flow/expand-template-spec.js +93 -0
- package/src/flow/flow-api-schemas.js +300 -0
- package/src/flow/flow.js +658 -0
- package/src/flow/for-each.js +225 -0
- package/src/flow/get-signature-pattern.js +31 -0
- package/src/flow/get-target-array.js +46 -0
- package/src/flow/inspect.js +67 -0
- package/src/flow/load-node-module.js +81 -0
- package/src/flow/make-node-method.js +112 -0
- package/src/flow/resolve-pick-by-field.js +77 -0
- package/src/flow/resolve-tunables.js +76 -0
- package/src/flow/run.js +392 -0
- package/src/flow/serialize.js +161 -0
- package/src/flow/signatures-schema.js +222 -0
- package/src/flow/spec-builder.js +65 -0
- package/src/flow/validate-triggers.js +250 -0
- package/src/flow/validate.js +261 -0
- package/src/nodes/accumulate/index.js +21 -0
- package/src/nodes/accumulate/init.js +48 -0
- package/src/nodes/accumulate/introspect.js +123 -0
- package/src/nodes/accumulate/publish-to.js +34 -0
- package/src/nodes/accumulate/recompute.js +27 -0
- package/src/nodes/accumulate/reset.js +25 -0
- package/src/nodes/accumulate/update.js +42 -0
- package/src/nodes/appraise/calibrate.js +64 -0
- package/src/nodes/appraise/decision.js +66 -0
- package/src/nodes/appraise/deviation.js +140 -0
- package/src/nodes/appraise/index.js +23 -0
- package/src/nodes/appraise/init.js +165 -0
- package/src/nodes/appraise/integrate.js +45 -0
- package/src/nodes/appraise/introspect.js +352 -0
- package/src/nodes/appraise/publish-to.js +93 -0
- package/src/nodes/appraise/receptor.js +69 -0
- package/src/nodes/appraise/recompute.js +79 -0
- package/src/nodes/appraise/reset.js +53 -0
- package/src/nodes/appraise/update.js +130 -0
- package/src/nodes/archive/csv/index.js +6 -0
- package/src/nodes/archive/csv/init.js +36 -0
- package/src/nodes/archive/csv/load.js +70 -0
- package/src/nodes/archive/csv/reset.js +14 -0
- package/src/nodes/archive/csv/simple-parser.js +216 -0
- package/src/nodes/archive/csv/test.js +173 -0
- package/src/nodes/archive/csv/update.js +63 -0
- package/src/nodes/butterworth-filter/index.js +18 -0
- package/src/nodes/butterworth-filter/init.js +184 -0
- package/src/nodes/butterworth-filter/introspect.js +228 -0
- package/src/nodes/butterworth-filter/publish-to.js +21 -0
- package/src/nodes/butterworth-filter/recompute.js +13 -0
- package/src/nodes/butterworth-filter/reset.js +30 -0
- package/src/nodes/butterworth-filter/update.js +38 -0
- package/src/nodes/categorize/index.js +19 -0
- package/src/nodes/categorize/init.js +58 -0
- package/src/nodes/categorize/introspect.js +177 -0
- package/src/nodes/categorize/publish-to.js +29 -0
- package/src/nodes/categorize/recompute.js +14 -0
- package/src/nodes/categorize/reset.js +16 -0
- package/src/nodes/categorize/update.js +53 -0
- package/src/nodes/controller/index.js +9 -0
- package/src/nodes/controller/init.js +55 -0
- package/src/nodes/controller/introspect.js +91 -0
- package/src/nodes/controller/publish-to.js +8 -0
- package/src/nodes/controller/recompute.js +9 -0
- package/src/nodes/controller/reset.js +17 -0
- package/src/nodes/controller/update.js +63 -0
- package/src/nodes/diff/index.js +19 -0
- package/src/nodes/diff/init.js +37 -0
- package/src/nodes/diff/introspect.js +132 -0
- package/src/nodes/diff/publish-to.js +21 -0
- package/src/nodes/diff/recompute.js +12 -0
- package/src/nodes/diff/reset.js +12 -0
- package/src/nodes/diff/update.js +37 -0
- package/src/nodes/digest-moments/formulas.js +12 -0
- package/src/nodes/digest-moments/index.js +14 -0
- package/src/nodes/digest-moments/init.js +67 -0
- package/src/nodes/digest-moments/introspect.js +154 -0
- package/src/nodes/digest-moments/publish-to.js +34 -0
- package/src/nodes/digest-moments/recompute.js +14 -0
- package/src/nodes/digest-moments/reset.js +14 -0
- package/src/nodes/digest-moments/update.js +120 -0
- package/src/nodes/dwell-time-tracker/index.js +14 -0
- package/src/nodes/dwell-time-tracker/init.js +59 -0
- package/src/nodes/dwell-time-tracker/introspect.js +137 -0
- package/src/nodes/dwell-time-tracker/publish-to.js +22 -0
- package/src/nodes/dwell-time-tracker/recompute.js +8 -0
- package/src/nodes/dwell-time-tracker/reset.js +23 -0
- package/src/nodes/dwell-time-tracker/update.js +103 -0
- package/src/nodes/emit-if/helpers.js +94 -0
- package/src/nodes/emit-if/index.js +16 -0
- package/src/nodes/emit-if/init.js +67 -0
- package/src/nodes/emit-if/introspect.js +102 -0
- package/src/nodes/emit-if/publish-to.js +13 -0
- package/src/nodes/emit-if/recompute.js +12 -0
- package/src/nodes/emit-if/reset.js +27 -0
- package/src/nodes/emit-if/update.js +93 -0
- package/src/nodes/es-correlation/index.js +19 -0
- package/src/nodes/es-correlation/init.js +73 -0
- package/src/nodes/es-correlation/introspect.js +176 -0
- package/src/nodes/es-correlation/publish-to.js +32 -0
- package/src/nodes/es-correlation/recompute.js +56 -0
- package/src/nodes/es-correlation/reset.js +27 -0
- package/src/nodes/es-correlation/update.js +110 -0
- package/src/nodes/es-mean/index.js +20 -0
- package/src/nodes/es-mean/init.js +58 -0
- package/src/nodes/es-mean/introspect.js +129 -0
- package/src/nodes/es-mean/publish-to.js +19 -0
- package/src/nodes/es-mean/recompute.js +16 -0
- package/src/nodes/es-mean/reset.js +24 -0
- package/src/nodes/es-mean/update.js +69 -0
- package/src/nodes/es-pairwise-correlation/index.js +19 -0
- package/src/nodes/es-pairwise-correlation/init.js +98 -0
- package/src/nodes/es-pairwise-correlation/introspect.js +187 -0
- package/src/nodes/es-pairwise-correlation/publish-to.js +31 -0
- package/src/nodes/es-pairwise-correlation/recompute.js +69 -0
- package/src/nodes/es-pairwise-correlation/reset.js +29 -0
- package/src/nodes/es-pairwise-correlation/update.js +89 -0
- package/src/nodes/es-stats/index.js +21 -0
- package/src/nodes/es-stats/init.js +105 -0
- package/src/nodes/es-stats/introspect.js +157 -0
- package/src/nodes/es-stats/publish-to.js +42 -0
- package/src/nodes/es-stats/recompute.js +74 -0
- package/src/nodes/es-stats/reset.js +49 -0
- package/src/nodes/es-stats/update-envelope.js +44 -0
- package/src/nodes/es-stats/update-welford.js +64 -0
- package/src/nodes/es-stats/update.js +59 -0
- package/src/nodes/index.js +83 -0
- package/src/nodes/invert-flag/index.js +20 -0
- package/src/nodes/invert-flag/init.js +36 -0
- package/src/nodes/invert-flag/introspect.js +115 -0
- package/src/nodes/invert-flag/publish-to.js +23 -0
- package/src/nodes/invert-flag/recompute.js +12 -0
- package/src/nodes/invert-flag/reset.js +12 -0
- package/src/nodes/invert-flag/update.js +32 -0
- package/src/nodes/kalman1d/index.js +20 -0
- package/src/nodes/kalman1d/init.js +103 -0
- package/src/nodes/kalman1d/introspect.js +250 -0
- package/src/nodes/kalman1d/publish-to.js +34 -0
- package/src/nodes/kalman1d/recompute.js +23 -0
- package/src/nodes/kalman1d/reset.js +29 -0
- package/src/nodes/kalman1d/update.js +144 -0
- package/src/nodes/kernel/index.js +18 -0
- package/src/nodes/kernel/init.js +66 -0
- package/src/nodes/kernel/introspect.js +163 -0
- package/src/nodes/kernel/presets.js +74 -0
- package/src/nodes/kernel/publish-to.js +25 -0
- package/src/nodes/kernel/recompute.js +14 -0
- package/src/nodes/kernel/reset.js +20 -0
- package/src/nodes/kernel/update.js +69 -0
- package/src/nodes/lag/index.js +21 -0
- package/src/nodes/lag/init.js +87 -0
- package/src/nodes/lag/introspect.js +202 -0
- package/src/nodes/lag/publish-to.js +64 -0
- package/src/nodes/lag/recompute.js +33 -0
- package/src/nodes/lag/reset.js +49 -0
- package/src/nodes/lag/update.js +133 -0
- package/src/nodes/median3/index.js +19 -0
- package/src/nodes/median3/init.js +40 -0
- package/src/nodes/median3/introspect.js +116 -0
- package/src/nodes/median3/publish-to.js +21 -0
- package/src/nodes/median3/recompute.js +12 -0
- package/src/nodes/median3/reset.js +15 -0
- package/src/nodes/median3/update.js +58 -0
- package/src/nodes/moments-digest/copy-from.js +12 -0
- package/src/nodes/moments-digest/flush.js +17 -0
- package/src/nodes/moments-digest/index.js +132 -0
- package/src/nodes/moments-digest/init.js +84 -0
- package/src/nodes/moments-digest/introspect.js +122 -0
- package/src/nodes/moments-digest/prelude.js +28 -0
- package/src/nodes/moments-digest/publish-to.js +31 -0
- package/src/nodes/moments-digest/recompute.js +9 -0
- package/src/nodes/moments-digest/reset.js +20 -0
- package/src/nodes/moments-digest/update.js +182 -0
- package/src/nodes/node-names.js +67 -0
- package/src/nodes/page-hinkley/index.js +20 -0
- package/src/nodes/page-hinkley/init.js +66 -0
- package/src/nodes/page-hinkley/introspect.js +193 -0
- package/src/nodes/page-hinkley/publish-to.js +28 -0
- package/src/nodes/page-hinkley/recompute.js +14 -0
- package/src/nodes/page-hinkley/reset.js +23 -0
- package/src/nodes/page-hinkley/update.js +105 -0
- package/src/nodes/pass-if/index.js +21 -0
- package/src/nodes/pass-if/init.js +37 -0
- package/src/nodes/pass-if/introspect.js +93 -0
- package/src/nodes/pass-if/publish-to.js +15 -0
- package/src/nodes/pass-if/recompute.js +15 -0
- package/src/nodes/pass-if/reset.js +18 -0
- package/src/nodes/pass-if/update.js +37 -0
- package/src/nodes/persist-if/helpers.js +111 -0
- package/src/nodes/persist-if/index.js +9 -0
- package/src/nodes/persist-if/init.js +98 -0
- package/src/nodes/persist-if/introspect.js +106 -0
- package/src/nodes/persist-if/publish-to.js +21 -0
- package/src/nodes/persist-if/recompute.js +20 -0
- package/src/nodes/persist-if/reset.js +35 -0
- package/src/nodes/persist-if/update.js +112 -0
- package/src/nodes/persistence-check/index.js +14 -0
- package/src/nodes/persistence-check/init.js +38 -0
- package/src/nodes/persistence-check/introspect.js +144 -0
- package/src/nodes/persistence-check/publish-to.js +11 -0
- package/src/nodes/persistence-check/recompute.js +7 -0
- package/src/nodes/persistence-check/reset.js +12 -0
- package/src/nodes/persistence-check/update.js +57 -0
- package/src/nodes/process-index/index.js +15 -0
- package/src/nodes/process-index/init.js +48 -0
- package/src/nodes/process-index/introspect.js +182 -0
- package/src/nodes/process-index/publish-to.js +29 -0
- package/src/nodes/process-index/recompute.js +8 -0
- package/src/nodes/process-index/reset.js +8 -0
- package/src/nodes/process-index/update.js +75 -0
- package/src/nodes/ratio/index.js +14 -0
- package/src/nodes/ratio/init.js +37 -0
- package/src/nodes/ratio/introspect.js +155 -0
- package/src/nodes/ratio/publish-to.js +15 -0
- package/src/nodes/ratio/recompute.js +7 -0
- package/src/nodes/ratio/reset.js +7 -0
- package/src/nodes/ratio/update.js +47 -0
- package/src/nodes/sanitize/index.js +82 -0
- package/src/nodes/sanitize/init.js +82 -0
- package/src/nodes/sanitize/introspect.js +194 -0
- package/src/nodes/sanitize/publish-to.js +15 -0
- package/src/nodes/sanitize/recompute.js +8 -0
- package/src/nodes/sanitize/reset.js +14 -0
- package/src/nodes/sanitize/update.js +102 -0
- package/src/nodes/spike-guard/index.js +14 -0
- package/src/nodes/spike-guard/init.js +47 -0
- package/src/nodes/spike-guard/introspect.js +130 -0
- package/src/nodes/spike-guard/publish-to.js +35 -0
- package/src/nodes/spike-guard/recompute.js +14 -0
- package/src/nodes/spike-guard/reset.js +19 -0
- package/src/nodes/spike-guard/update.js +89 -0
- package/src/nodes/sse-emitter/index.js +7 -0
- package/src/nodes/sse-emitter/init.js +105 -0
- package/src/nodes/sse-emitter/introspect.js +134 -0
- package/src/nodes/sse-emitter/publish-to.js +6 -0
- package/src/nodes/sse-emitter/recompute.js +16 -0
- package/src/nodes/sse-emitter/reset.js +19 -0
- package/src/nodes/sse-emitter/update.js +69 -0
- package/src/nodes/sse-emitter/utils/broadcast-heartbeat.js +36 -0
- package/src/nodes/sse-emitter/utils/build-message.js +31 -0
- package/src/nodes/sse-emitter/utils/connection-manager.js +45 -0
- package/src/nodes/sse-emitter/utils/endpoint-initializer.js +20 -0
- package/src/nodes/sse-emitter/utils/health-monitor.js +38 -0
- package/src/nodes/sse-emitter/utils/qos-handler.js +41 -0
- package/src/nodes/state-change-detector/helpers.js +35 -0
- package/src/nodes/state-change-detector/index.js +12 -0
- package/src/nodes/state-change-detector/init.js +56 -0
- package/src/nodes/state-change-detector/introspect.js +146 -0
- package/src/nodes/state-change-detector/publish-to.js +20 -0
- package/src/nodes/state-change-detector/recompute.js +6 -0
- package/src/nodes/state-change-detector/reset.js +20 -0
- package/src/nodes/state-change-detector/update.js +97 -0
- package/src/nodes/sw-stats/index.js +14 -0
- package/src/nodes/sw-stats/init.js +51 -0
- package/src/nodes/sw-stats/introspect.js +131 -0
- package/src/nodes/sw-stats/publish-to.js +45 -0
- package/src/nodes/sw-stats/recompute.js +33 -0
- package/src/nodes/sw-stats/reset.js +15 -0
- package/src/nodes/sw-stats/update.js +39 -0
- package/src/nodes/swing-watch/index.js +17 -0
- package/src/nodes/swing-watch/init.js +144 -0
- package/src/nodes/swing-watch/introspect.js +188 -0
- package/src/nodes/swing-watch/publish-to.js +53 -0
- package/src/nodes/swing-watch/recompute.js +22 -0
- package/src/nodes/swing-watch/reset.js +55 -0
- package/src/nodes/swing-watch/update.js +767 -0
- package/src/nodes/tally/index.js +15 -0
- package/src/nodes/tally/init.js +32 -0
- package/src/nodes/tally/introspect.js +116 -0
- package/src/nodes/tally/publish-to.js +28 -0
- package/src/nodes/tally/recompute.js +10 -0
- package/src/nodes/tally/reset.js +10 -0
- package/src/nodes/tally/update.js +44 -0
- package/src/nodes/threshold/index.js +14 -0
- package/src/nodes/threshold/init.js +121 -0
- package/src/nodes/threshold/introspect.js +192 -0
- package/src/nodes/threshold/publish-to.js +11 -0
- package/src/nodes/threshold/recompute.js +8 -0
- package/src/nodes/threshold/reset.js +14 -0
- package/src/nodes/threshold/update.js +54 -0
- package/src/nodes/transform/helpers.js +39 -0
- package/src/nodes/transform/index.js +15 -0
- package/src/nodes/transform/init.js +35 -0
- package/src/nodes/transform/introspect.js +118 -0
- package/src/nodes/transform/publish-to.js +23 -0
- package/src/nodes/transform/recompute.js +12 -0
- package/src/nodes/transform/reset.js +11 -0
- package/src/nodes/transform/update.js +32 -0
- package/src/nodes/trend/compute-confidence.js +112 -0
- package/src/nodes/trend/index.js +14 -0
- package/src/nodes/trend/init.js +81 -0
- package/src/nodes/trend/introspect.js +151 -0
- package/src/nodes/trend/publish-to.js +22 -0
- package/src/nodes/trend/recompute.js +15 -0
- package/src/nodes/trend/reset.js +26 -0
- package/src/nodes/trend/update.js +93 -0
- package/src/nodes/tw-stats/copy-from.js +16 -0
- package/src/nodes/tw-stats/flush.js +12 -0
- package/src/nodes/tw-stats/index.js +41 -0
- package/src/nodes/tw-stats/init.js +92 -0
- package/src/nodes/tw-stats/introspect.js +171 -0
- package/src/nodes/tw-stats/publish-to.js +108 -0
- package/src/nodes/tw-stats/recompute.js +9 -0
- package/src/nodes/tw-stats/reset.js +16 -0
- package/src/nodes/tw-stats/update.js +113 -0
- package/src/nodes/unbalance/index.js +15 -0
- package/src/nodes/unbalance/init.js +59 -0
- package/src/nodes/unbalance/introspect.js +167 -0
- package/src/nodes/unbalance/publish-to.js +52 -0
- package/src/nodes/unbalance/recompute.js +11 -0
- package/src/nodes/unbalance/reset.js +10 -0
- package/src/nodes/unbalance/update.js +83 -0
- package/src/nodes/vector-distance/index.js +14 -0
- package/src/nodes/vector-distance/init.js +54 -0
- package/src/nodes/vector-distance/introspect.js +149 -0
- package/src/nodes/vector-distance/publish-to.js +35 -0
- package/src/nodes/vector-distance/recompute.js +11 -0
- package/src/nodes/vector-distance/reset.js +20 -0
- package/src/nodes/vector-distance/update.js +139 -0
- package/src/nodes/winnow/index.js +12 -0
- package/src/nodes/winnow/init.js +82 -0
- package/src/nodes/winnow/introspect.js +253 -0
- package/src/nodes/winnow/publish-to.js +51 -0
- package/src/nodes/winnow/recompute.js +14 -0
- package/src/nodes/winnow/reset.js +34 -0
- package/src/nodes/winnow/update.js +203 -0
- package/src/tools/training/features.js +227 -0
- package/src/tools/training/index.js +21 -0
- package/src/tools/training/logistic.js +238 -0
- package/src/tools/training/metrics.js +126 -0
- package/src/tools/training/scale.js +239 -0
- package/src/tools/training/validate.js +103 -0
- package/src/windowing/count-sliding/create.js +16 -0
- package/src/windowing/count-sliding/get-reverse-chronological-index.js +19 -0
- package/src/windowing/count-sliding/index.js +6 -0
- package/src/windowing/count-sliding/is-not-full.js +5 -0
- package/src/windowing/count-sliding/push.js +15 -0
- package/src/windowing/count-sliding/reset.js +11 -0
- package/src/windowing/count-sliding/size.js +5 -0
- package/src/windowing/time-sliding/create.js +25 -0
- package/src/windowing/time-sliding/push.js +42 -0
- package/CODE_OF_CONDUCT.md +0 -46
- package/CONTRIBUTING.md +0 -132
- package/docs/.nojekyll +0 -0
- package/docs/CONTRIBUTING.md +0 -134
- package/docs/README.md +0 -132
- package/docs/_coverpage.md +0 -26
- package/docs/_media/bg.png +0 -0
- package/docs/_media/wink-logo.png +0 -0
- package/docs/_navbar.md +0 -14
- package/docs/_sidebar.md +0 -2
- package/docs/index.html +0 -44
- package/eslint.config.js +0 -283
package/CONTRIBUTING.md
DELETED
|
@@ -1,132 +0,0 @@
|
|
|
1
|
-
# Contributing to Wink Composer
|
|
2
|
-
|
|
3
|
-
Thank you for taking time to contribute. We are delighted to receive contributions from the community. For `wink-composer` every contribution matters — whether you are reporting a **bug**, posting a **question** or **suggestion**, submitting a **pull request** or updating the **documentation**.
|
|
4
|
-
|
|
5
|
-
This document will guide you through the contribution process and guidelines.
|
|
6
|
-
|
|
7
|
-
## Getting Started
|
|
8
|
-
If you spot a bug/issue and the same has not yet been reported, [raise a new issue](https://github.com/winkjs/wink-composer/issues) or consider fixing it and sending a PR. If you have questions and/or suggestions, post them at our [discussions](https://github.com/winkjs/wink-composer/discussions). New features may also be discussed there; eventually you may consider developing the same and sending a PR.
|
|
9
|
-
|
|
10
|
-
### How to send a PR?
|
|
11
|
-
|
|
12
|
-
1. Fork the repository from github
|
|
13
|
-
2. Develop your code changes
|
|
14
|
-
4. Capture the logic in comments
|
|
15
|
-
3. Ensure that the API is properly documented
|
|
16
|
-
4. Ensure proper linting
|
|
17
|
-
2. Write test cases to cover each and every change and/or new feature
|
|
18
|
-
2. Review security and performance
|
|
19
|
-
5. Run the entire test suite
|
|
20
|
-
6. Make sure coverage either stays at the current levels or improves; note minimum acceptable level is ≥99.5%
|
|
21
|
-
7. Commit your changes in compliance with commit guidelines
|
|
22
|
-
8. Push to your fork
|
|
23
|
-
9. [Sign the CLA](https://cla-assistant.io/winkjs/wink-composer) if you are contributing for the first time
|
|
24
|
-
|
|
25
|
-
After completing the above steps, you are ready to submit the pull request.
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
## Code of Conduct
|
|
29
|
-
By contributing, you are expected to uphold [wink’s code of conduct](CODE_OF_CONDUCT.md). In essence, each one of us should:
|
|
30
|
-
|
|
31
|
-
1. respect fellow contributors, irrespective of their level of experience, race, religion, gender, sexual orientation, and age;
|
|
32
|
-
2. collaborate constructively;
|
|
33
|
-
3. never engage in any form of offense, harassment, insult, personal attack, provocation and/or use of inappropriate language;
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
## Development Guidelines
|
|
38
|
-
Wink-composer is an open-source JavaScript library that aims to simplify the creation of LLM-driven applications.
|
|
39
|
-
|
|
40
|
-
Do take out some time in understanding the structure of APIs, before attempting any enhancements.
|
|
41
|
-
|
|
42
|
-
In wink composer, we prefer **functions** and **closures** over objects/classes.
|
|
43
|
-
|
|
44
|
-
Like artisans, we too need a toolset and process to create beautiful software. The process is orchestrated by Github Actions in accordance with the configuration files present in the repository. The details are outlined below:
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
### Linting
|
|
48
|
-
Well defined linting rules or **coding standards** help us in making code more consistent and avoid bugs. [ESLint](https://eslint.org) enforces these rules automatically. These rules are defined in a configuration file named `.eslintrc.json`, which is located at the root of the repository. These rules cover basic formatting, naming conventions, limits of code complexity, and many more; please refer to the configuration file for further details.
|
|
49
|
-
|
|
50
|
-
We recommend using a suitable ESLint plugin/add-on for the code editor. Use script **`npm run pretest`** at command line to run linting on the entire code.
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
### Documenting
|
|
54
|
-
We believe that the documentation must not only explain the API but also narrate the story of logic, algorithms and references used. Wink Composer uses the [JSDoc](https://jsdoc.app) standard for API documentation. It is inspired by [Literate-Programming Standards](https://en.wikipedia.org/wiki/Literate_programming) for documenting the logic using [docker](http://jbt.github.io/docker/src/docker.js.html); the **`npm run sourcedocs`** script generates a well formatted code documentation in HTML.
|
|
55
|
-
|
|
56
|
-
### Testing
|
|
57
|
-
Test cases should cover each and every feature and/or change; use of standard test heuristics such as equivalence partition, boundary values, empty/null value, and decision tree is recommended to write effective test cases.
|
|
58
|
-
|
|
59
|
-
Wink Composer requires a test coverage of **at least ≥99.5%** and aims for 100%. Any new contribution must maintain the existing test coverage level. We use [Chai](http://chaijs.com/), [Mocha](https://mochajs.org/) and [nyc](https://github.com/istanbuljs/nyc), [Coveralls](https://coveralls.io/) to run tests and determine coverage.
|
|
60
|
-
|
|
61
|
-
Use script **`npm run test`** at command line to run the entire test suite and obtain test coverage report.
|
|
62
|
-
|
|
63
|
-
#### Performance Considerations
|
|
64
|
-
It is important to maintain the performance of wink composer, whenever a change is made and/or a new feature is added. We use the [benchmark](https://benchmarkjs.com) package to measure performance.
|
|
65
|
-
|
|
66
|
-
#### Security Considerations
|
|
67
|
-
Our security review/testing is inspired from the recommendations in [OWASP's NodeJS Security Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Nodejs_Security_Cheat_Sheet.html) that are applicable to wink-composer — since it is a library used by developers to create LLM web/mobile/CLI apps/tools, only Platform Security specific recommendations apply. We follow the guidelines outlined below:
|
|
68
|
-
|
|
69
|
-
1. Minimize external dependencies.
|
|
70
|
-
2. Use ESLint as a Static Analysis Security Testing (SAST) tool.
|
|
71
|
-
3. Never use `eval()` function.
|
|
72
|
-
4. Avoid prototype pollution by using objects created via **`Object.create( null )`**.
|
|
73
|
-
5. Perform input validation with defined default behavior.
|
|
74
|
-
6. Use tools like [regexploit](https://github.com/doyensec/regexploit) to detect potential ReDoS apart from reviewing regexes using [regex 101](https://regex101.com) on Chrome browser (Latest stable version), Node.js (LTS version).
|
|
75
|
-
|
|
76
|
-
### Committing
|
|
77
|
-
We follow [commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) from Google's [Angular Project](https://angular.io/), whose documentation is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). See important excerpts for quick reference below:
|
|
78
|
-
|
|
79
|
-
#### Commit Message Format
|
|
80
|
-
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
|
|
81
|
-
|
|
82
|
-
<type>(<scope>): <subject>
|
|
83
|
-
<BLANK LINE>
|
|
84
|
-
<body>
|
|
85
|
-
<BLANK LINE>
|
|
86
|
-
<footer>
|
|
87
|
-
|
|
88
|
-
The header is **mandatory** and the scope of the header is optional. Any line of the commit message should not be longer than 100 characters!
|
|
89
|
-
|
|
90
|
-
**Type** should be one of the following:
|
|
91
|
-
|
|
92
|
-
- `build`: Changes that affect the build system or external dependencies
|
|
93
|
-
- `ci`: Changes to our CI configuration files and scripts
|
|
94
|
-
- `docs`: Documentation only changes
|
|
95
|
-
- `feat`: A new feature
|
|
96
|
-
- `fix`: A bug fix
|
|
97
|
-
- `perf`: A code change that improves performance
|
|
98
|
-
- `refactor`: A code change that neither fixes a bug nor adds a feature
|
|
99
|
-
- `test`: Adding missing tests or correcting existing tests
|
|
100
|
-
- `revert:` When you have to revert to an older commit. Ths subject should be the header of the old commit and the body should contain `This reverts commit <hash>.` Use the `git revert` command to accomplish this.
|
|
101
|
-
|
|
102
|
-
**Scope** specifies the place of the commit change. You can use `*` when the change affects more than a single scope.
|
|
103
|
-
|
|
104
|
-
**Subject** must contain a crisp description of the change and it must (a) use the imperative, present tense: "change" not "changed" nor "changes", (b) not capitalize the first letter, and (c) not use period (.) at the end.
|
|
105
|
-
|
|
106
|
-
**Body** just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change.
|
|
107
|
-
|
|
108
|
-
**Footer** should contain any information about **Breaking Changes** and is also the place to reference [GitHub issues that this commit closes](https://help.github.com/articles/closing-issues-via-commit-messages/). Breaking Changes should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
|
109
|
-
|
|
110
|
-
## Versioning
|
|
111
|
-
Wink Composer follows [semantic versioning](https://semver.org/) for every release.
|
|
112
|
-
|
|
113
|
-
## Governance
|
|
114
|
-
This section outlines wink-composer’s governance guidelines:
|
|
115
|
-
1. This is a project of [Graype Systems Private Limited (Graype)](http://graype.in), which is a micro-size company incorporated in India.
|
|
116
|
-
1. The project team consists of 3-core members, including a technical lead.
|
|
117
|
-
1. The project welcomes contributions from the community. For wink-composer every contribution matters — whether it is [reporting a bug/issue](https://github.com/winkjs/wink-composer/issues), [posting a question/suggestion](https://github.com/winkjs/wink-composer/discussions), submitting a pull request or updating the documentation.
|
|
118
|
-
1. Everyone is entitled to state their opinion and may present their arguments. There is an effort to achieve consensus but in absence of obvious consensus, the technical lead has the final say in decision making. It roughly matches a standard BDFL (Benevolent Dictator For Life) style project.
|
|
119
|
-
1. Wink Composer is licensed under the terms of the MIT license; therefore there are no limitations on forking and developing it further separately.
|
|
120
|
-
1. The technical lead has commit and administrative rights on the project's [organization](https://github.com/winkjs) and [repository](https://github.com/winkjs/wink-composer) at Github. Therefore the technical lead can make changes and accept changes — typically pull requests submitted by others. These changes may include changes to the process and contribution requirements.
|
|
121
|
-
1. [Graype](http://graype.in) offers commercial support and/or services around the project.
|
|
122
|
-
1. The key roles are (a) User — who uses or has used the package; (b) Contributor — who has reported one or more issues, participated in one or more discussions OR sent one or more PRs; (c) Core Team Member as stated above and (d) Technical Lead.
|
|
123
|
-
1. Core team members are Prateek Saxena, Rachna Chakraborty and Sanjaya Kumar Saxena (Technical Lead).
|
|
124
|
-
1. Current opportunities to participate are outlined in the [roadmap](ROADMAP.md).
|
|
125
|
-
1. Every PR must comply with our [development guidelines](CONTRIBUTING.md#development-guidelines) before they can be accepted/merged.
|
|
126
|
-
1. Participation requires adherence to our [code of conduct](CODE_OF_CONDUCT.md).
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
## Contributor License Agreement (CLA)
|
|
131
|
-
|
|
132
|
-
The [CLA](https://gist.github.com/sanjayaksaxena/8b96d3d4f2be6cdc0f28a5839d5a5b2a) is for your protection as well as the protection of [Graype](http://graype.in) and it’s licensees; it does not change your rights to use your own Contributions for any other purpose. Our CLA is a short and easy to understand agreement and can be signed using a simple click-through form. Please [sign our Contributor License Agreement (CLA)](https://cla-assistant.io/winkjs/wink-composer) before sending pull requests. It's a quick process, we promise!
|
package/docs/.nojekyll
DELETED
|
File without changes
|
package/docs/CONTRIBUTING.md
DELETED
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
# Contributing to Wink Composer
|
|
2
|
-
|
|
3
|
-
Thank you for taking time to contribute. We are delighted to receive contributions from the community. For `wink-composer` every contribution matters — whether you are reporting a **bug**, posting a **question** or **suggestion**, submitting a **pull request** or updating the **documentation**.
|
|
4
|
-
|
|
5
|
-
This document will guide you through the contribution process and guidelines.
|
|
6
|
-
|
|
7
|
-
## Getting Started
|
|
8
|
-
If you spot a bug/issue and the same has not yet been reported, [raise a new issue](https://github.com/winkjs/wink-composer/issues) or consider fixing it and sending a PR. If you have questions and/or suggestions, post them at our [discussions](https://github.com/winkjs/wink-composer/discussions). New features may also be discussed there; eventually you may consider developing the same and sending a PR.
|
|
9
|
-
|
|
10
|
-
### How to send a PR?
|
|
11
|
-
|
|
12
|
-
1. Fork the repository from github
|
|
13
|
-
2. Develop your code changes
|
|
14
|
-
4. Capture the logic in comments
|
|
15
|
-
3. Ensure that the API is properly documented
|
|
16
|
-
4. Ensure proper linting
|
|
17
|
-
2. Write test cases to cover each and every change and/or new feature
|
|
18
|
-
2. Review security and performance
|
|
19
|
-
5. Run the entire test suite
|
|
20
|
-
6. Make sure coverage either stays at the current levels or improves; note minimum acceptable level is ≥99.5%
|
|
21
|
-
* [Home](/)
|
|
22
|
-
* [Guide](guide.md)
|
|
23
|
-
7. Commit your changes in compliance with commit guidelines
|
|
24
|
-
8. Push to your fork
|
|
25
|
-
9. [Sign the CLA](https://cla-assistant.io/winkjs/wink-composer) if you are contributing for the first time
|
|
26
|
-
|
|
27
|
-
After completing the above steps, you are ready to submit the pull request.
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
## Code of Conduct
|
|
31
|
-
By contributing, you are expected to uphold [wink’s code of conduct](CODE_OF_CONDUCT.md). In essence, each one of us should:
|
|
32
|
-
|
|
33
|
-
1. respect fellow contributors, irrespective of their level of experience, race, religion, gender, sexual orientation, and age;
|
|
34
|
-
2. collaborate constructively;
|
|
35
|
-
3. never engage in any form of offense, harassment, insult, personal attack, provocation and/or use of inappropriate language;
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
## Development Guidelines
|
|
40
|
-
Wink-composer is an open-source JavaScript library that aims to simplify the creation of LLM-driven applications.
|
|
41
|
-
|
|
42
|
-
Do take out some time in understanding the structure of APIs, before attempting any enhancements.
|
|
43
|
-
|
|
44
|
-
In wink composer, we prefer **functions** and **closures** over objects/classes.
|
|
45
|
-
|
|
46
|
-
Like artisans, we too need a toolset and process to create beautiful software. The process is orchestrated by Github Actions in accordance with the configuration files present in the repository. The details are outlined below:
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
### Linting
|
|
50
|
-
Well defined linting rules or **coding standards** help us in making code more consistent and avoid bugs. [ESLint](https://eslint.org) enforces these rules automatically. These rules are defined in a configuration file named `.eslintrc.json`, which is located at the root of the repository. These rules cover basic formatting, naming conventions, limits of code complexity, and many more; please refer to the configuration file for further details.
|
|
51
|
-
|
|
52
|
-
We recommend using a suitable ESLint plugin/add-on for the code editor. Use script **`npm run pretest`** at command line to run linting on the entire code.
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
### Documenting
|
|
56
|
-
We believe that the documentation must not only explain the API but also narrate the story of logic, algorithms and references used. Wink Composer uses the [JSDoc](https://jsdoc.app) standard for API documentation. It is inspired by [Literate-Programming Standards](https://en.wikipedia.org/wiki/Literate_programming) for documenting the logic using [docker](http://jbt.github.io/docker/src/docker.js.html); the **`npm run sourcedocs`** script generates a well formatted code documentation in HTML.
|
|
57
|
-
|
|
58
|
-
### Testing
|
|
59
|
-
Test cases should cover each and every feature and/or change; use of standard test heuristics such as equivalence partition, boundary values, empty/null value, and decision tree is recommended to write effective test cases.
|
|
60
|
-
|
|
61
|
-
Wink Composer requires a test coverage of **at least ≥99.5%** and aims for 100%. Any new contribution must maintain the existing test coverage level. We use [Chai](http://chaijs.com/), [Mocha](https://mochajs.org/) and [nyc](https://github.com/istanbuljs/nyc), [Coveralls](https://coveralls.io/) to run tests and determine coverage.
|
|
62
|
-
|
|
63
|
-
Use script **`npm run test`** at command line to run the entire test suite and obtain test coverage report.
|
|
64
|
-
|
|
65
|
-
#### Performance Considerations
|
|
66
|
-
It is important to maintain the performance of wink composer, whenever a change is made and/or a new feature is added. We use the [benchmark](https://benchmarkjs.com) package to measure performance.
|
|
67
|
-
|
|
68
|
-
#### Security Considerations
|
|
69
|
-
Our security review/testing is inspired from the recommendations in [OWASP's NodeJS Security Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Nodejs_Security_Cheat_Sheet.html) that are applicable to wink-composer — since it is a library used by developers to create LLM web/mobile/CLI apps/tools, only Platform Security specific recommendations apply. We follow the guidelines outlined below:
|
|
70
|
-
|
|
71
|
-
1. Minimize external dependencies.
|
|
72
|
-
2. Use ESLint as a Static Analysis Security Testing (SAST) tool.
|
|
73
|
-
3. Never use `eval()` function.
|
|
74
|
-
4. Avoid prototype pollution by using objects created via **`Object.create( null )`**.
|
|
75
|
-
5. Perform input validation with defined default behavior.
|
|
76
|
-
6. Use tools like [regexploit](https://github.com/doyensec/regexploit) to detect potential ReDoS apart from reviewing regexes using [regex 101](https://regex101.com) on Chrome browser (Latest stable version), Node.js (LTS version).
|
|
77
|
-
|
|
78
|
-
### Committing
|
|
79
|
-
We follow [commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) from Google's [Angular Project](https://angular.io/), whose documentation is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). See important excerpts for quick reference below:
|
|
80
|
-
|
|
81
|
-
#### Commit Message Format
|
|
82
|
-
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
|
|
83
|
-
|
|
84
|
-
<type>(<scope>): <subject>
|
|
85
|
-
<BLANK LINE>
|
|
86
|
-
<body>
|
|
87
|
-
<BLANK LINE>
|
|
88
|
-
<footer>
|
|
89
|
-
|
|
90
|
-
The header is **mandatory** and the scope of the header is optional. Any line of the commit message should not be longer than 100 characters!
|
|
91
|
-
|
|
92
|
-
**Type** should be one of the following:
|
|
93
|
-
|
|
94
|
-
- `build`: Changes that affect the build system or external dependencies
|
|
95
|
-
- `ci`: Changes to our CI configuration files and scripts
|
|
96
|
-
- `docs`: Documentation only changes
|
|
97
|
-
- `feat`: A new feature
|
|
98
|
-
- `fix`: A bug fix
|
|
99
|
-
- `perf`: A code change that improves performance
|
|
100
|
-
- `refactor`: A code change that neither fixes a bug nor adds a feature
|
|
101
|
-
- `test`: Adding missing tests or correcting existing tests
|
|
102
|
-
- `revert:` When you have to revert to an older commit. Ths subject should be the header of the old commit and the body should contain `This reverts commit <hash>.` Use the `git revert` command to accomplish this.
|
|
103
|
-
|
|
104
|
-
**Scope** specifies the place of the commit change. You can use `*` when the change affects more than a single scope.
|
|
105
|
-
|
|
106
|
-
**Subject** must contain a crisp description of the change and it must (a) use the imperative, present tense: "change" not "changed" nor "changes", (b) not capitalize the first letter, and (c) not use period (.) at the end.
|
|
107
|
-
|
|
108
|
-
**Body** just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change.
|
|
109
|
-
|
|
110
|
-
**Footer** should contain any information about **Breaking Changes** and is also the place to reference [GitHub issues that this commit closes](https://help.github.com/articles/closing-issues-via-commit-messages/). Breaking Changes should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
|
|
111
|
-
|
|
112
|
-
## Versioning
|
|
113
|
-
Wink Composer follows [semantic versioning](https://semver.org/) for every release.
|
|
114
|
-
|
|
115
|
-
## Governance
|
|
116
|
-
This section outlines wink-composer’s governance guidelines:
|
|
117
|
-
1. This is a project of [Graype Systems Private Limited (Graype)](http://graype.in), which is a micro-size company incorporated in India.
|
|
118
|
-
1. The project team consists of 3-core members, including a technical lead.
|
|
119
|
-
1. The project welcomes contributions from the community. For wink-composer every contribution matters — whether it is [reporting a bug/issue](https://github.com/winkjs/wink-composer/issues), [posting a question/suggestion](https://github.com/winkjs/wink-composer/discussions), submitting a pull request or updating the documentation.
|
|
120
|
-
1. Everyone is entitled to state their opinion and may present their arguments. There is an effort to achieve consensus but in absence of obvious consensus, the technical lead has the final say in decision making. It roughly matches a standard BDFL (Benevolent Dictator For Life) style project.
|
|
121
|
-
1. Wink Composer is licensed under the terms of the MIT license; therefore there are no limitations on forking and developing it further separately.
|
|
122
|
-
1. The technical lead has commit and administrative rights on the project's [organization](https://github.com/winkjs) and [repository](https://github.com/winkjs/wink-composer) at Github. Therefore the technical lead can make changes and accept changes — typically pull requests submitted by others. These changes may include changes to the process and contribution requirements.
|
|
123
|
-
1. [Graype](http://graype.in) offers commercial support and/or services around the project.
|
|
124
|
-
1. The key roles are (a) User — who uses or has used the package; (b) Contributor — who has reported one or more issues, participated in one or more discussions OR sent one or more PRs; (c) Core Team Member as stated above and (d) Technical Lead.
|
|
125
|
-
1. Core team members are Prateek Saxena, Rachna Chakraborty and Sanjaya Kumar Saxena (Technical Lead).
|
|
126
|
-
1. Current opportunities to participate are outlined in the [roadmap](ROADMAP.md).
|
|
127
|
-
1. Every PR must comply with our [development guidelines](CONTRIBUTING.md#development-guidelines) before they can be accepted/merged.
|
|
128
|
-
1. Participation requires adherence to our [code of conduct](CODE_OF_CONDUCT.md).
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
## Contributor License Agreement (CLA)
|
|
133
|
-
|
|
134
|
-
The [CLA](https://gist.github.com/sanjayaksaxena/8b96d3d4f2be6cdc0f28a5839d5a5b2a) is for your protection as well as the protection of [Graype](http://graype.in) and it’s licensees; it does not change your rights to use your own Contributions for any other purpose. Our CLA is a short and easy to understand agreement and can be signed using a simple click-through form. Please [sign our Contributor License Agreement (CLA)](https://cla-assistant.io/winkjs/wink-composer) before sending pull requests. It's a quick process, we promise!
|
package/docs/README.md
DELETED
|
@@ -1,132 +0,0 @@
|
|
|
1
|
-
# wink-composer ♫
|
|
2
|
-
|
|
3
|
-
### [](https://nodejs.org/api/documentation.html#documentation_stability_index)
|
|
4
|
-
|
|
5
|
-
## ✨ Real-time analytics that sparks joy
|
|
6
|
-
|
|
7
|
-
[<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://winkjs.org/)
|
|
8
|
-
|
|
9
|
-
WinkComposer is an upcoming open-source framework that makes building streaming intelligence playfully simple. Connect intuitive nodes, experiment freely, perfect it in an iteration or two. From edge-ready AI algorithms to built-in resilience, everything you need for production comes standard. No complexity, no black boxes - just the joy of creating exactly what you need.
|
|
10
|
-
|
|
11
|
-
## Why Composability Matters
|
|
12
|
-
|
|
13
|
-
**🎯 Create What You Need** — With composability, you're the inventor: Correlate vibration with weather? Done. Detect micro-trends before they become macro? Built.
|
|
14
|
-
|
|
15
|
-
**💫 Countless Possibilities** — Dozens of nodes → Endless pipelines. Like few music notes creating captivating symphonies.
|
|
16
|
-
|
|
17
|
-
**🌱 Evolve Naturally** — Start: `sensor → threshold → alert`. Grow: Add intelligence: `sensor → normalize → smooth → detect → confirm → alert`. Unconstrained by vendor feature lists.
|
|
18
|
-
|
|
19
|
-
**🔍 Total Transparency** — See which node triggered, what threshold crossed, why it alerted. Every decision is explainable.
|
|
20
|
-
|
|
21
|
-
## Build Exactly What You Need
|
|
22
|
-
|
|
23
|
-
Build precise analytics for your unique patterns:
|
|
24
|
-
|
|
25
|
-
```javascript
|
|
26
|
-
// Detect bearing failure in rotating equipment
|
|
27
|
-
vibration → isolateSignal → extractPeaks → measureIntensity →
|
|
28
|
-
trackChanges → triggerAlert
|
|
29
|
-
|
|
30
|
-
// Monitor chemical process quality
|
|
31
|
-
temperature → removeNoise → smoothFast → smoothSlow → findDivergence →
|
|
32
|
-
detectChange → waitForPersistence
|
|
33
|
-
|
|
34
|
-
// Find correlated sensor behaviors
|
|
35
|
-
[sensor1, sensor2] → trackCorrelation → compareToNormal → raiseFlag
|
|
36
|
-
|
|
37
|
-
// Calculate real-time OEE
|
|
38
|
-
machine → trackState → sumTime → countOutput →
|
|
39
|
-
checkQuality → calculateScore
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
Each node is simple:
|
|
43
|
-
- `removeNoise`: Median of last few values (removes sensor spikes).
|
|
44
|
-
- `smoothFast`: Average of last 10 values (recent trend).
|
|
45
|
-
- `smoothSlow`: Average of last 100 values (baseline trend).
|
|
46
|
-
- `findDivergence`: Fast trend - slow trend (unusual behavior?).
|
|
47
|
-
- `trackCorrelation`: Smart correlation (learns relationships between sensors)
|
|
48
|
-
|
|
49
|
-
_Node names and details are illustrative - actual implementations may vary._
|
|
50
|
-
|
|
51
|
-
Every arrow is a conscious choice. Every node has a purpose. No magic, just simple intuitive math.
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
## Your Analytics Journey
|
|
55
|
-
|
|
56
|
-
**Start Simple**
|
|
57
|
-
`sensor → threshold → alert`
|
|
58
|
-
|
|
59
|
-
**Evolve Naturally**
|
|
60
|
-
`sensor → validate → normalize → threshold → debounce → alert`
|
|
61
|
-
|
|
62
|
-
**Scale Intelligently**
|
|
63
|
-
`sensor → [parallel: statistics | patterns | anomalies] → correlate → decide → act`
|
|
64
|
-
|
|
65
|
-
Your analytics grow with your understanding, and are never limited by any tool's feature list.
|
|
66
|
-
|
|
67
|
-
## Designed for the Real World
|
|
68
|
-
|
|
69
|
-
### Industrial IoT
|
|
70
|
-
From simple threshold monitoring to complex predictive maintenance - compose what fits your equipment, your patterns, your physics. **Move intelligence to the edge** with analytics that run on industrial Raspberry Pis. Works alongside your existing systems to handle your unique requirements.
|
|
71
|
-
|
|
72
|
-
### Financial Services
|
|
73
|
-
Build fraud detection you can explain to auditors. Every decision traceable, every threshold justified.
|
|
74
|
-
|
|
75
|
-
### Smart Infrastructure
|
|
76
|
-
Energy optimization with transparent logic. See why the system made each decision.
|
|
77
|
-
|
|
78
|
-
## Production-Grade Resilience
|
|
79
|
-
Real streams have noise. Sensors fail. Networks hiccup. WinkComposer handles it all:
|
|
80
|
-
|
|
81
|
-
- **Node-level fault isolation** - One bad reading doesn't crash your pipeline
|
|
82
|
-
- **Automatic state recovery** - Snapshot and restore without missing a beat
|
|
83
|
-
- **Built-in observability** - Know what's happening in every node, every partition
|
|
84
|
-
- **Adaptive execution** - Maintains responsiveness under varying load
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
## Core Principles
|
|
88
|
-
|
|
89
|
-
| Principle | What it means |
|
|
90
|
-
|-----------|---------------|
|
|
91
|
-
| **Atomic Operations** | Each node does one thing perfectly |
|
|
92
|
-
| **Pure Functions** | Predictable, testable, composable |
|
|
93
|
-
| **Transparent Logic** | Understand every decision |
|
|
94
|
-
| **Production Ready** | Built for high-throughput streaming with microsecond-scale latency |
|
|
95
|
-
| **AI-Native Intelligence** | From statistical learning nodes to LLM reasoning - intelligence at every level |
|
|
96
|
-
| **Built for Reality** | Node-level fault isolation, automatic recovery, and comprehensive observability |
|
|
97
|
-
|
|
98
|
-
## What's Coming
|
|
99
|
-
|
|
100
|
-
### 🎉 **Opening Our Doors in 2025**
|
|
101
|
-
WinkComposer is transitioning to open source development in 2025. Join the [early conversation](https://github.com/winkjs/wink-composer/discussions) and help shape the future of composable streaming analytics. You can even reach out directly at wink@graype.in.
|
|
102
|
-
|
|
103
|
-
**Together, we're building:**
|
|
104
|
-
|
|
105
|
-
- **Rich Node Library**: Statistical, filtering, detection, transformation, and control nodes
|
|
106
|
-
- **Edge-Ready Intelligence**: Advanced algorithms like smart correlation, change point detection, and regression inference - AI-like capabilities without heavyweight frameworks
|
|
107
|
-
- **Pipeline Builder**: Define your analytics flows declaratively (visual tools planned)
|
|
108
|
-
- **Edge-Ready Performance**: Process data efficiently, even on resource-constrained devices (**tested on Raspberry Pi**)
|
|
109
|
-
- **Knowledge Graph Integration**: Build digital twins with Neo4j/ArangoDB for contextual intelligence
|
|
110
|
-
- **AI-Native Reasoning**: When patterns emerge, LLMs explain why. When anomalies occur, get actionable recommendations. Open-source models keep intelligence at the edge.
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
## The Vision
|
|
114
|
-
|
|
115
|
-
Finally, build solutions that fit your exact problems, not the other way around.
|
|
116
|
-
|
|
117
|
-
Every industry has unique patterns. Every process has specific physics. Every business has particular rules. WinkComposer gives you the building blocks to create exactly what you need.
|
|
118
|
-
|
|
119
|
-
Domain-specific platforms excel at standard use cases. WinkComposer shines when you need something unique, beyond standard use cases. Standard use cases always included - they're just the beginning of what's possible!
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
## About winkJS
|
|
124
|
-
|
|
125
|
-
WinkComposer joins the winkJS family - production-grade open-source packages for Natural Language Processing, Machine Learning, and Statistical Analysis in JavaScript. Built for reliability with ~100% test coverage.
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
## Copyright & License
|
|
129
|
-
|
|
130
|
-
**Wink Composer** is copyright 2017-25 [GRAYPE Systems Private Limited](https://graype.in/).
|
|
131
|
-
|
|
132
|
-
It is licensed under the terms of the MIT License.
|
package/docs/_coverpage.md
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-

|
|
3
|
-
|
|
4
|
-
# wink-composer <small>♫</small>
|
|
5
|
-
|
|
6
|
-
**Composable Streaming Intelligence**
|
|
7
|
-
|
|
8
|
-
<br>
|
|
9
|
-
|
|
10
|
-
> **🎯 Build exactly what you need, playfully simple**
|
|
11
|
-
|
|
12
|
-
- ✨ **Real-time Analytics** that Sparks Joy
|
|
13
|
-
- 💫 **Compose from Simple Nodes** — Countless Possibilities
|
|
14
|
-
- 🔍 **Total Transparency** — Every Decision Explainable
|
|
15
|
-
- ⚡ **Edge-Ready Performance** — Runs on Raspberry Pi!
|
|
16
|
-
- 🧠 **Intelligent by Design** — Statistical Learning to LLMs
|
|
17
|
-
- 🚀 **Production Resilient** — Fault isolation, recovery, & observability
|
|
18
|
-
|
|
19
|
-
<br>
|
|
20
|
-
|
|
21
|
-
> 🎉 **Transitioning to Open Source in 2025**
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
[**Explore on GitHub** →](https://github.com/winkjs/wink-composer)
|
|
26
|
-
[**Read the Docs** →](#docsify)
|
package/docs/_media/bg.png
DELETED
|
Binary file
|
|
Binary file
|
package/docs/_navbar.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
* Getting started
|
|
3
|
-
|
|
4
|
-
* [Quick start](quickstart.md)
|
|
5
|
-
* [Writing more pages](more-pages.md)
|
|
6
|
-
* [Custom navbar](custom-navbar.md)
|
|
7
|
-
* [Cover page](cover.md)
|
|
8
|
-
|
|
9
|
-
* Configuration
|
|
10
|
-
* [Configuration](configuration.md)
|
|
11
|
-
* [Themes](themes.md)
|
|
12
|
-
* [Using plugins](plugins.md)
|
|
13
|
-
* [Markdown configuration](markdown.md)
|
|
14
|
-
* [Language highlight](language-highlight.md)
|
package/docs/_sidebar.md
DELETED
package/docs/index.html
DELETED
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<title>Document</title>
|
|
6
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
|
7
|
-
<meta name="description" content="Composable Streaming Intelligence">
|
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
9
|
-
<!-- <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"> -->
|
|
10
|
-
<!-- Theme: Simple (light + dark) -->
|
|
11
|
-
<link rel="stylesheet" media="(prefers-color-scheme: light)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
|
|
12
|
-
<link rel="stylesheet" media="(prefers-color-scheme: dark)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
|
|
13
|
-
|
|
14
|
-
<style>
|
|
15
|
-
:root {
|
|
16
|
-
--theme-color: #886496;
|
|
17
|
-
--cover-background-color: #262626;
|
|
18
|
-
--cover-background-mask-opacity: 0.2;
|
|
19
|
-
--cover-background-image: none;
|
|
20
|
-
--cover-blockquote-color: #886496;
|
|
21
|
-
}
|
|
22
|
-
</style>
|
|
23
|
-
|
|
24
|
-
</head>
|
|
25
|
-
<body>
|
|
26
|
-
<div id="app"></div>
|
|
27
|
-
<script>
|
|
28
|
-
window.$docsify = {
|
|
29
|
-
name: 'wink-composer',
|
|
30
|
-
repo: 'https://github.com/winkjs/wink-composer',
|
|
31
|
-
loadSidebar: true,
|
|
32
|
-
coverpage: true,
|
|
33
|
-
search: 'auto',
|
|
34
|
-
loadNavbar: true
|
|
35
|
-
}
|
|
36
|
-
</script>
|
|
37
|
-
<!-- Docsify v4 -->
|
|
38
|
-
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
|
|
39
|
-
<!-- docsify-themeable -->
|
|
40
|
-
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
|
|
41
|
-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
|
|
42
|
-
|
|
43
|
-
</body>
|
|
44
|
-
</html>
|