@helioslx/core 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to this project will be documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and the project follows [Semantic Versioning](https://semver.org/), with the
+pre-1.0 policy described in
+[versioning](https://github.com/helioslx/docs/blob/main/content/docs/core/guides/versioning.mdx).
+
+## 0.2.0 - 2026-07-13
+
+### Changed
+
+- Renamed the public output facade from `SacnController` to `SacnSource` with
+  cached `Universe` handles (`setChannels` maps, `fadeChannels`, `transition`,
+  `write`).
+- Split lifecycle into `start` / `stop` (pause) / `close` (teardown), with
+  implicit start on output mutations and optional `onStart` / `onStop` /
+  `onClose` hooks.
+- Node `createSacnSource` replaces `createNodeSacnController` and registers
+  sources for one-time `SIGINT` / `SIGTERM` / `beforeExit` auto-close.
+- HTTP adapter now takes `source` and uses `durationMs` (maps or channel arrays).
+
+### Added
+
+- Comprehensive public API, architecture, networking, safety, persistence, and
+  release documentation.
+- Runnable TypeScript examples for output, viewing, Redis, HTTP, and shutdown.
+- Open-source governance, contribution, security, conduct, support, and
+  trademark policies.
+- Node/macOS, Node/Linux, Bun, dependency review, and provenance release
+  automation.
+
+## 0.1.0 - 2026-07-12
+
+### Added
+
+- Runtime-neutral controller contracts, validated full-frame and sparse channel
+  writes, linear fades, scheduling, cancellation, persistence, and telemetry.
+- Node sACN sender and receiver adapters.
+- Memory and Redis output/viewer stores.
+- Viewer callbacks and bounded/coalescing async streams.
+- Embedded Elysia REST, OpenAPI, and WebSocket adapter.
+- Deterministic testing utilities.

package/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+Thanks for helping improve `@helioslx/core`.
+
+Community expectations and project policy live in the
+[Helios docs](https://github.com/helioslx/docs) (code of conduct, governance,
+support, trademark).
+
+## Before opening work
+
+Use a discussion or issue for behavior changes, new public API, persistence
+format changes, or substantial architecture work. For defects, include the
+package version, Node/Bun version, operating system, minimal reproduction,
+expected behavior, and actual behavior. Remove credentials, network addresses,
+venue details, and other sensitive data.
+
+Security vulnerabilities must be reported privately under
+[SECURITY.md](SECURITY.md), not in a public issue.
+
+## Development
+
+Requirements:
+
+- Node.js 22+
+- npm
+- optional local Redis for persistence integration work
+- a safe, isolated network for UDP integration work
+
+Install and verify:
+
+```sh
+npm ci
+npm run typecheck
+npm test
+npm run test:coverage
+npm run build
+npm pack --dry-run
+```
+
+Do not run network tests against a live lighting rig. Follow
+[live-lighting safety](https://github.com/helioslx/docs/blob/main/content/docs/core/guides/safety.mdx).
+
+## Pull requests
+
+Keep changes focused and explain the user-visible reason for them. Add or
+update tests for behavior changes and documentation/examples for public API
+changes. Call out:
+
+- breaking API or error-code changes
+- lifecycle and ownership changes
+- new network behavior or safety impact
+- stored-data compatibility and migration requirements
+- optional peer dependency changes
+
+All checks must pass on supported Node platforms and Bun compatibility jobs.
+Generated output, local environment files, credentials, and packed tarballs
+must not be committed.
+
+Contributors retain copyright in their contributions. Unless explicitly stated
+otherwise, intentionally submitted contributions are provided under Apache-2.0
+as described in section 5 of the license. Do not submit code or assets you do
+not have the right to contribute.
+
+## Style and compatibility
+
+- Keep the root module runtime-neutral and free of import-time I/O.
+- Keep Node, Redis, HTTP, and test integrations in explicit subpaths.
+- Preserve strict TypeScript and immutable public snapshots.
+- Validate all public inputs independently of transport or HTTP schemas.
+- Keep bounded queues and explicit dependency ownership.
+- Avoid expanding the core domain into fixtures, personalities, scenes, or
+  product licensing.
+
+Public changes follow
+[versioning](https://github.com/helioslx/docs/blob/main/content/docs/core/guides/versioning.mdx).
+Update [CHANGELOG.md](CHANGELOG.md) under `Unreleased` for user-visible
+changes.
+
+## Review
+
+Maintainers may request changes for correctness, safety, scope, API stability,
+tests, documentation, licensing, or maintainability. Approval does not
+guarantee immediate release.

package/LICENSE

@@ -0,0 +1,256 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 The Helios Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,159 @@
+# Helios Core
+
+[![npm](https://img.shields.io/npm/v/@helioslx/core)](https://www.npmjs.com/package/@helioslx/core)
+[![CI](https://img.shields.io/github/actions/workflow/status/helioslx/core/ci.yml?branch=main&label=CI)](https://github.com/helioslx/core/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/codecov/c/github/helioslx/core)](https://codecov.io/gh/helioslx/core)
+[![Node](https://img.shields.io/node/v/@helioslx/core)](https://nodejs.org)
+[![License](https://img.shields.io/github/license/helioslx/core)](LICENSE)
+
+`@helioslx/core` is a TypeScript toolkit for sending and observing sACN (E1.31)
+from Node.js. Validated 512-slot DMX frames, sparse channel writes, fades,
+optional persistence, and packet viewing — without fixture, personality, scene,
+or show concepts.
+
+> **Live-lighting warning:** Test with disconnected fixtures or a closed test
+> network first. Incorrect values, universes, priorities, or interface
+> selection can move equipment, trigger strobes, or black out a venue. See
+> [live-lighting safety](https://github.com/helioslx/docs/blob/main/content/docs/core/guides/safety.mdx)
+> before connecting to a live rig.
+
+## Requirements
+
+- Node.js 22 or newer for the supported UDP runtime
+- An IPv4 interface that can reach the sACN network
+- TypeScript/ESM recommended
+- Bun is compatibility-tested, but Node.js is the supported production network
+  runtime
+
+The root module is runtime-neutral. UDP, Redis, and HTTP support are isolated in
+optional subpaths, so install only the peers you use.
+
+## Quick start
+
+```sh
+npm install @helioslx/core sacn
+```
+
+```ts
+import { createSacnSource } from "@helioslx/core/node";
+
+const source = createSacnSource({
+  name: "My lighting app",
+  transportOptions: {
+    // Set iface when the host has more than one network interface.
+    iface: "192.168.10.20",
+  },
+});
+
+const universe = source.universe(1, {
+  priority: 100,
+  sourceName: "Dimmers",
+});
+
+await universe.fadeChannels(
+  {
+    1: 255,
+    2: 128,
+  },
+  { durationMs: 1_000 },
+);
+
+// Node sources install SIGINT/SIGTERM/beforeExit handlers that call close().
+```
+
+Public channels are one-based (`1..512`); values are integers from `0..255`.
+Universes are `1..63999`, priorities are `0..200`, and priority defaults to
+`100`. A full frame must contain exactly 512 values.
+
+Mutations auto-start the scheduler. Reads (`get`, `listUniverses`) do not.
+Awaiting a mutation means the write is scheduled and persisted, not that a fade
+has finished.
+
+See the complete [quick-start example](examples/quickstart.ts).
+
+## Common operations
+
+Snap channels immediately:
+
+```ts
+await universe.setChannels({ 1: 255, 2: 128 });
+```
+
+Fade several channels with one shared duration:
+
+```ts
+await universe.fadeChannels({ 1: 0, 2: 0 }, { durationMs: 1_000 });
+```
+
+Per-channel durations:
+
+```ts
+await universe.transition([
+  { channel: 1, value: 0, durationMs: 500 },
+  { channel: 10, value: 255, durationMs: 2_000 },
+]);
+```
+
+Write a complete frame:
+
+```ts
+const frame = new Uint8Array(512);
+frame[0] = 255;
+frame[1] = 128;
+await universe.write(frame, { durationMs: 2_000 });
+```
+
+Later writes win for channels already fading. Unmentioned channels retain their
+current transitions and targets.
+
+Inspect and clear output:
+
+```ts
+const output = await universe.get();
+const outputs = await source.listUniverses();
+const removed = await universe.clear();
+```
+
+## Optional adapters
+
+| Import | Peer dependency | Purpose |
+| --- | --- | --- |
+| `@helioslx/core/node` | `sacn` | Node UDP sender, receiver, process handlers, and runtime telemetry |
+| `@helioslx/core/redis` | `redis` | Versioned output and viewer persistence |
+| `@helioslx/core/http` | `elysia`, `@elysiajs/node`, `@elysiajs/openapi` | Unbound REST, OpenAPI, and viewer WebSocket routes |
+| `@helioslx/core/testing` | none | Fake clock/receiver and recording transport |
+
+The HTTP adapter does not bind a port, configure CORS, rate limit requests, or
+choose an authentication policy. The host application owns those decisions.
+
+## Lifecycle and ownership
+
+1. Construct a source (and optional universe handles).
+2. Mutate output — the first output-demanding op restores state and starts
+   scheduling — or call `start()` explicitly.
+3. Await mutations; they are ordered with persistence.
+4. Call `stop()` to pause the scheduler while keeping state, or `close()` for
+   final teardown. Repeated `close()` calls are safe.
+
+Root sources and viewers do not close injected transports, receivers, or stores
+by default. Set the corresponding ownership option when transferring ownership.
+`createSacnSource` from `@helioslx/core/node` creates and owns its transport and
+registers for process-signal teardown (opt out with
+`installProcessHandlers: false`). Default memory stores and internally-created
+Redis clients are also owned.
+
+Universe mutators accept `signal`. A timed-out send remains serialized until
+the underlying transport promise settles, preventing overlapping sends even
+when a transport ignores cancellation. Source transport shutdown is bounded by
+`shutdownTimeoutMs` (2 seconds by default).
+
+## Documentation
+
+Guides, API reference, examples, and community policies:
+[helioslx/docs](https://github.com/helioslx/docs).
+
+Runnable samples also live in [`examples/`](examples/).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/SECURITY.md

@@ -0,0 +1,67 @@
+# Security policy
+
+## Supported versions
+
+Before `1.0`, security fixes are provided for the latest published minor
+release. After `1.0`, the latest major release receives security fixes; older
+branches may receive fixes at maintainer discretion.
+
+| Version | Supported |
+| --- | --- |
+| Latest published release | Yes |
+| Older releases | No |
+
+## Reporting a vulnerability
+
+Do not open a public issue, discussion, or pull request for a suspected
+vulnerability.
+
+Use GitHub's private vulnerability reporting feature from the repository
+**Security** tab. Include:
+
+- affected versions and export subpaths
+- impact and realistic threat model
+- minimal reproduction or proof of concept
+- required configuration and runtime
+- suggested mitigation, if known
+- whether details have been shared elsewhere
+
+Remove production credentials, personal data, venue identifiers, and unsafe
+live-lighting instructions. Use synthetic data and an isolated environment.
+
+Maintainers aim to acknowledge a complete report within five business days.
+They will validate impact, coordinate a fix and advisory, and provide status
+updates when practical. Timelines depend on severity and release coordination.
+Please allow a reasonable remediation period before disclosure.
+
+## Scope
+
+Relevant reports include authentication-boundary mistakes in the adapter,
+unsafe parsing or resource exhaustion, dependency compromise, Redis record
+trust issues, network-originated crashes, provenance/release compromise, and
+vulnerabilities in package code.
+
+The following are generally out of scope unless they demonstrate a package
+defect:
+
+- exposed applications that did not configure the documented authentication,
+  binding, CORS, TLS, or rate limits
+- denial of service requiring unrestricted access intentionally granted by the
+  host
+- issues only in unsupported Node versions, browsers, or edge runtimes
+- social engineering, physical attacks, and scanner-only reports without
+  demonstrated impact
+- vulnerabilities exclusively in a dependency that should be reported to that
+  dependency first
+
+Operational safety incidents are important but are not automatically security
+vulnerabilities. Follow
+[live-lighting safety](https://github.com/helioslx/docs/blob/main/content/docs/core/guides/safety.mdx)
+immediately and use private reporting if an attacker can trigger the behavior.
+
+## Disclosure
+
+The project follows coordinated disclosure. Confirmed issues may receive a
+GitHub security advisory, CVE where appropriate, patched release with npm
+provenance, changelog entry, and remediation guidance. Reporters may be
+credited with permission.