@cntryl/fitz 0.0.1

package/LICENSE

@@ -0,0 +1,160 @@
+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

package/README.md

@@ -0,0 +1,195 @@
+# fitz-ts
+
+TypeScript client SDK for [Fitz](https://github.com/cntryl/fitz).
+
+## Install
+
+Requires Node.js 20.19 or later.
+
+```bash
+npm install @cntryl/fitz
+```
+
+## Quick Start
+
+```typescript
+import { Client } from "@cntryl/fitz";
+
+const client = Client({
+  url: "ws://localhost:4090/ws",
+  tokenProvider: async () => "your-jwt-token",
+  reconnect: { enabled: true },
+  asyncHandlers: {
+    maxConcurrency: 32,
+    timeoutMs: 5000,
+  },
+});
+
+await client.connect();
+
+const tx = await client.kv().begin("kv://realm/area/users", "ReadWrite");
+await tx.put(new TextEncoder().encode("user-1"), new TextEncoder().encode('{"name":"Alice"}'));
+await tx.commit();
+
+await client.close();
+```
+
+## Observability
+
+`fitz-ts` now supports additive observability hooks through `ClientConfig.observability`.
+
+```typescript
+import { Client } from "@cntryl/fitz";
+
+const client = Client({
+  url: "ws://localhost:4090/ws",
+  reconnect: { enabled: true },
+  observability: {
+    logger: {
+      log(level, event, fields) {
+        console.log(level, event, fields);
+      },
+    },
+    onLifecycleEvent(event) {
+      console.log(event.event, event.state);
+    },
+  },
+});
+```
+
+See `docs/OPERATIONS.md` for lifecycle events, metric names, and production guidance.
+
+## Stream Replay
+
+```typescript
+import type { StreamFilterSet } from "@cntryl/fitz";
+
+const filter: StreamFilterSet = {
+  clauses: [{ kind: "Equals", value: "proj.alpha" }],
+};
+
+const records = await client.stream().read("stream://realm/app/events", 0n, 100, {
+  filter,
+  maxBytes: 64_000n,
+});
+
+const page = await client.stream().readPage("stream://realm/app/events", 0n, 100, {
+  filter,
+  maxBytes: 64_000n,
+});
+
+// read() keeps the compatibility projection and returns event records only.
+// readPage() exposes synthetic filtered markers and cursor metadata.
+void records;
+void page.cursor.lastResourceOffset;
+```
+
+## Concurrency Notes
+
+- Different domains can operate concurrently on one client connection.
+- Multiple independent KV transactions and stream sessions can also be active concurrently.
+- Do not issue overlapping operations against the same KV transaction or the same stream session. Those stateful handles are intended to be used sequentially.
+- Notification and RPC worker handlers run through a shared async dispatcher. Use `asyncHandlers.maxConcurrency` and `asyncHandlers.timeoutMs` to bound handler fan-out in production.
+
+## Transport Support
+
+- WebSocket: browser and Node.js
+- TCP: Node.js only
+- Auto transport detection: defaults to WebSocket when the URL omits a scheme
+
+## Verification
+
+Fast local checks:
+
+```bash
+npm ci
+npm run verify:fast
+```
+
+Broker-backed verification:
+
+```bash
+docker compose -f ../fitz-go/compose.yml up -d
+npm run verify
+docker compose -f ../fitz-go/compose.yml down --volumes
+```
+
+Package smoke verification:
+
+```bash
+npm run pack:smoke
+```
+
+Suggested release checklist:
+
+```bash
+npm ci
+npm run verify:fast
+docker compose -f ../fitz-go/compose.yml up -d
+npm run verify
+npm run bench
+docker compose -f ../fitz-go/compose.yml down --volumes
+```
+
+Tiered benchmark commands:
+
+```bash
+npm run bench:tier1
+npm run bench:tier2
+npm run bench:tier3
+npm run bench:tier4
+npm run bench
+```
+
+> Run the full suite repeatedly before relying on benchmark automation. `tier4` is broader and more integration-style, so it should be stabilized over multiple executions before adding CI thresholds.
+
+Benchmark tiers:
+
+- `tier1`: hot-path microbenchmarks for core frame, codec, and multiplexer/parse runtime costs.
+- `tier2`: subsystem benchmarks for domain-level payload and request-encoding workloads.
+- `tier3`: system benchmarks for combined protocol and client flow payloads.
+- `tier4`: integration benchmarks for realistic multi-message encode and frame assembly scenarios.
+
+The conformance harness writes JSON results to `artifacts/conformance-results.json` by default.
+
+Tooling is direct:
+
+- `vp check` for combined format, lint, and type checks
+- `vp fmt` for formatting
+- `vp lint` for linting
+- `vp test` for unit, integration, and conformance tests
+- `vp pack` for JS bundle output
+- `tsc` for declaration emit
+- `tsc` for typechecking and declaration emit
+
+Published artifacts are smoke-tested from the packed tarball in both ESM and
+CommonJS consumer fixtures before release.
+
+## Repository Layout
+
+- `src/client`: public client facade and connection management
+- `src/transport`: WebSocket and TCP transports
+- `src/domains`: domain clients and codecs
+- `tests/unit`: fast unit coverage
+- `tests/integration`: broker-backed integration coverage
+- `tests/conformance`: release-gate conformance suite
+
+Broker-backed connection hardening coverage now includes automatic reconnect subscription replay and token-provider replay checks in `tests/integration/connection.test.ts`.
+
+## Canonical Docs
+
+`fitz-ts` follows the canonical Fitz client docs in the server repo:
+
+- [`../fitz/docs/clients/CLIENT_SPEC.md`](../fitz/docs/clients/CLIENT_SPEC.md)
+- [`../fitz/docs/clients/CLIENT_ACCEPTANCE_CRITERIA.md`](../fitz/docs/clients/CLIENT_ACCEPTANCE_CRITERIA.md)
+- [`../fitz/docs/clients/CLIENT_IMPLEMENTATION_GUIDE.md`](../fitz/docs/clients/CLIENT_IMPLEMENTATION_GUIDE.md)
+- [`../fitz/docs/clients/CONNECTION_FLOW.md`](../fitz/docs/clients/CONNECTION_FLOW.md)
+
+## Documentation
+
+- [`docs/README.md`](docs/README.md)
+- [`docs/OPERATIONS.md`](docs/OPERATIONS.md)
+- [`docs/PUBLIC_CONTRACT.md`](docs/PUBLIC_CONTRACT.md)
+- [`CLIENT_SPEC.md`](CLIENT_SPEC.md)
+- [`CLIENT_ACCEPTANCE_CRITERIA.md`](CLIENT_ACCEPTANCE_CRITERIA.md)
+- [`CHANGELOG.md`](CHANGELOG.md)