@genrojs/tytx 0.16.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 ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 Softwell S.r.l.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,9 @@
1
+ Genro Project
2
+ Copyright 2025-2026 Softwell S.r.l.
3
+
4
+ This product includes software developed by Softwell S.r.l.
5
+
6
+ Licensed under the Apache License 2.0.
7
+ You may obtain a copy of the License at:
8
+
9
+ https://www.apache.org/licenses/LICENSE-2.0
package/README.md ADDED
@@ -0,0 +1,334 @@
1
+ <p align="center">
2
+ <img src="docs/assets/logo.png" alt="TYTX Logo" width="200">
3
+ </p>
4
+
5
+ <p align="center">
6
+ <a href="https://pypi.org/project/genro-tytx/"><img src="https://img.shields.io/pypi/v/genro-tytx?color=blue" alt="PyPI"></a>
7
+ <a href="https://jsr.io/@genro/tytx"><img src="https://jsr.io/badges/@genro/tytx" alt="JSR"></a>
8
+ <img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+">
9
+ <a href="https://github.com/genro-org/genro-tytx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-green" alt="License"></a>
10
+ <img src="https://img.shields.io/badge/status-beta-yellow" alt="Status">
11
+ <br>
12
+ <a href="https://github.com/genro-org/genro-tytx/actions/workflows/tests.yml"><img src="https://github.com/genro-org/genro-tytx/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
13
+ <a href="https://codecov.io/gh/genro-org/genro-tytx"><img src="https://codecov.io/gh/genro-org/genro-tytx/branch/main/graph/badge.svg" alt="Coverage"></a>
14
+ <a href="https://genro-tytx.readthedocs.io/"><img src="https://readthedocs.org/projects/genro-tytx/badge/?version=latest" alt="Documentation"></a>
15
+ </p>
16
+
17
+ # genro-tytx
18
+
19
+ **A lightweight multi-transport typed data interchange system.**
20
+
21
+ TYTX eliminates manual type conversions between Python and JavaScript, and makes switching to MessagePack for better performance as simple as changing a parameter.
22
+
23
+ You send a `Decimal` from Python, JavaScript receives a string. You convert it back. Every. Single. Time. TYTX fixes this—types flow automatically between Python and JavaScript, over JSON, XML, or MessagePack.
24
+
25
+ ## The Pain You Know
26
+
27
+ ```python
28
+ # Your Python API
29
+ return {"price": Decimal("99.99"), "due_date": date(2025, 1, 15)}
30
+ ```
31
+
32
+ ```javascript
33
+ // Your JavaScript client
34
+ const data = await response.json();
35
+ // data.price is "99.99" (string) - need to convert
36
+ // data.due_date is "2025-01-15" (string) - need to convert
37
+
38
+ const price = new Decimal(data.price); // Manual conversion
39
+ const dueDate = new Date(data.due_date); // Manual conversion
40
+ ```
41
+
42
+ **This leads to:**
43
+
44
+ - Conversion code scattered everywhere
45
+ - Bugs when someone forgets to convert
46
+ - Financial calculations with floating-point errors
47
+ - Different date formats causing off-by-one-day bugs
48
+
49
+ ## The TYTX Solution
50
+
51
+ ```python
52
+ # Server - just return native types
53
+ return {"price": Decimal("99.99"), "due_date": date(2025, 1, 15)}
54
+ ```
55
+
56
+ ```javascript
57
+ // Client - types arrive ready to use
58
+ const data = await fetchTytx('/api/order');
59
+ data.price // → Decimal (not string)
60
+ data.due_date // → Date (not string)
61
+ ```
62
+
63
+ **Zero conversion code. Types just work.**
64
+
65
+ ## 30-Second Demo
66
+
67
+ **Python:**
68
+
69
+ ```bash
70
+ pip install genro-tytx
71
+ ```
72
+
73
+ ```python
74
+ from decimal import Decimal
75
+ from datetime import date
76
+ from genro_tytx import to_tytx, from_tytx
77
+
78
+ # Encode
79
+ data = {"price": Decimal("99.99"), "date": date(2025, 1, 15)}
80
+ encoded = to_tytx(data)
81
+ # '{"price": "99.99::N", "date": "2025-01-15::D"}::JS'
82
+
83
+ # Decode
84
+ decoded = from_tytx(encoded)
85
+ # {"price": Decimal("99.99"), "date": date(2025, 1, 15)}
86
+ ```
87
+
88
+ **JavaScript:**
89
+
90
+ ```bash
91
+ npm install @genrojs/tytx # npm
92
+ bunx jsr add @genro/tytx # JSR
93
+ ```
94
+
95
+ ```javascript
96
+ import { fetchTytx } from '@genro/tytx';
97
+ import Big from 'big.js';
98
+
99
+ const result = await fetchTytx('/api/invoice', {
100
+ body: { price: new Big('99.99'), date: new Date() }
101
+ });
102
+ // result.total → Big (ready to use)
103
+ ```
104
+
105
+ ## Untyped JSON codec
106
+
107
+ Besides the typed `to_tytx` / `from_tytx` API, TYTX exposes a plain JSON codec for the untyped path — no type suffixes, just fast JSON (orjson when available, stdlib otherwise):
108
+
109
+ ```python
110
+ from genro_tytx import json_dumps, json_loads
111
+
112
+ json_dumps({"a": 1}) # -> b'{"a":1}' (UTF-8 bytes)
113
+ json_loads('{"a": 1}') # accepts str or bytes -> {"a": 1}
114
+ ```
115
+
116
+ `json_dumps` returns UTF-8 `bytes` (ready for ASGI/WebSocket send), `json_loads` accepts `str` or `bytes`. Use these when you want plain JSON; use `to_tytx` / `from_tytx` when you want typed values to flow.
117
+
118
+ ## Custom types
119
+
120
+ `register_type` lets an external package teach TYTX a new type — a serialize hook (object → string) and a deserialize hook (string → object) under a custom suffix. The package registers at its own import time, so TYTX gains no dependency on it:
121
+
122
+ ```python
123
+ from genro_tytx import register_type, to_tytx, from_tytx
124
+
125
+ class Point:
126
+ def __init__(self, x, y): self.x, self.y = x, y
127
+
128
+ register_type(Point, "PT", lambda p: f"{p.x},{p.y}",
129
+ lambda s: Point(*map(int, s.split(","))))
130
+
131
+ to_tytx([1, Point(5, 6), "k"]) # '[1,"5,6::PT","k"]::JS'
132
+ from_tytx('5,6::PT') # Point(5, 6)
133
+ ```
134
+
135
+ The custom type flows like any built-in scalar, including nested inside dicts and lists. The exact type is matched first; an unregistered subclass of a registered type travels under that type's code, written by its own serializer (genro-builders' `SourceBag` travels as genro-bag's `X`). Built-in types keep the exact-type rule. A class cannot be registered under a code another class owns. A code is one or more uppercase ASCII letters, any length; registration refuses anything else. Re-registering the same class replaces its hooks; reusing a suffix owned by a different type raises an error. An unknown code on the receiving side is not an error: the string comes back untouched. The same semantics apply to the JavaScript client (`registerType` / `registerClass`). The rules and the codes reserved by consumers are in `spec/TYTX-SPEC.md` §2.5.
136
+
137
+ When the type owns its serialization, `register_class` reads the hooks from the class itself — usable as a decorator. It needs `__tytx_suffix__`, an instance `to_tytx()` and a `from_tytx` classmethod (`from_tytx` must be a classmethod: decoding starts from the suffix and rebuilds the instance from scratch):
138
+
139
+ ```python
140
+ from genro_tytx import register_class
141
+
142
+ @register_class
143
+ class Point:
144
+ __tytx_suffix__ = "PT"
145
+ def __init__(self, x, y): self.x, self.y = x, y
146
+ def to_tytx(self): return f"{self.x},{self.y}"
147
+ @classmethod
148
+ def from_tytx(cls, s): return cls(*map(int, s.split(",")))
149
+ ```
150
+
151
+ The concrete class of a subclass is the type's own business. TYTX keeps one subtype dictionary per code and never reads it: `set_subtype_dict(suffix, dict)` replaces it, `get_subtype_dict(suffix)` returns it (`{}` if none was set). JavaScript: `setSubtypeDict` / `getSubtypeDict`. The type's `to_tytx`/`from_tytx` use it; whoever adds a subclass reads the dictionary, adds its entries and sets it again. genro-bag maps symbolic names to Bag classes this way.
152
+
153
+ ## Installation
154
+
155
+ ```bash
156
+ # Python
157
+ pip install genro-tytx
158
+
159
+ # JavaScript/TypeScript, from npm
160
+ npm install @genrojs/tytx
161
+
162
+ # JavaScript/TypeScript, from JSR
163
+ bunx jsr add @genro/tytx
164
+ # With npm: npx jsr add @genro/tytx
165
+ ```
166
+
167
+ JavaScript includes Decimal, Big, MessagePack and XML dependencies. No separate
168
+ codec installation is needed. Python extras remain unchanged.
169
+
170
+ ## Real-World Example: Order Processing
171
+
172
+ A typical business scenario: process an order with 8 typed fields, return 6 typed results.
173
+
174
+ ### 1. The Data
175
+
176
+ **JavaScript Client** has order data with proper types:
177
+
178
+ ```javascript
179
+ import Big from 'big.js';
180
+
181
+ const orderData = {
182
+ unit_price: new Big('149.99'), // Decimal
183
+ quantity: 3,
184
+ discount: new Big('10.00'), // Decimal
185
+ order_date: new Date(2025, 0, 15), // Date
186
+ delivery_date: new Date(2025, 0, 20),
187
+ express: true,
188
+ customer_id: 12345,
189
+ notes: 'Handle with care'
190
+ };
191
+
192
+ // Expects response: { subtotal, tax, shipping, total, ship_date, arrival_date }
193
+ ```
194
+
195
+ **Python Server** has business logic expecting proper types:
196
+
197
+ ```python
198
+ async def process_order(unit_price, quantity, discount, order_date,
199
+ delivery_date, express, customer_id, notes):
200
+ """Business logic - expects Decimal and date types."""
201
+ subtotal = unit_price * quantity
202
+ tax = subtotal * Decimal('0.22')
203
+ shipping = Decimal('15.00') if express else Decimal('5.00')
204
+ total = subtotal - discount + tax + shipping
205
+ ship_date = order_date + timedelta(days=1 if express else 3)
206
+ return {
207
+ 'subtotal': subtotal, 'tax': tax, 'shipping': shipping,
208
+ 'total': total, 'ship_date': ship_date, 'arrival_date': delivery_date
209
+ }
210
+ ```
211
+
212
+ ---
213
+
214
+ ### 2. ❌ WITHOUT TYTX: 20 Manual Conversions
215
+
216
+ **JavaScript** - must convert to/from strings:
217
+
218
+ ```javascript
219
+ // Send: convert types → strings
220
+ const response = await fetch('/api/process_order', {
221
+ method: 'POST',
222
+ headers: { 'Content-Type': 'application/json' },
223
+ body: JSON.stringify({
224
+ unit_price: orderData.unit_price.toString(), // Decimal → string
225
+ discount: orderData.discount.toString(), // Decimal → string
226
+ order_date: orderData.order_date.toISOString().slice(0, 10), // Date → string
227
+ delivery_date: orderData.delivery_date.toISOString().slice(0, 10),
228
+ quantity: orderData.quantity, express: orderData.express,
229
+ customer_id: orderData.customer_id, notes: orderData.notes
230
+ })
231
+ });
232
+
233
+ // Receive: convert strings → types
234
+ const json = await response.json();
235
+ const result = {
236
+ subtotal: new Big(json.subtotal), tax: new Big(json.tax),
237
+ shipping: new Big(json.shipping), total: new Big(json.total),
238
+ ship_date: new Date(json.ship_date), arrival_date: new Date(json.arrival_date)
239
+ };
240
+ ```
241
+
242
+ **Python** - must convert to/from strings:
243
+
244
+ ```python
245
+ @app.post("/api/process_order")
246
+ async def handle_order(request: Request):
247
+ json_data = await request.json()
248
+
249
+ # Receive: convert strings → types
250
+ unit_price = Decimal(json_data['unit_price'])
251
+ discount = Decimal(json_data['discount'])
252
+ order_date = date.fromisoformat(json_data['order_date'])
253
+ delivery_date = date.fromisoformat(json_data['delivery_date'])
254
+
255
+ result = await process_order(unit_price, json_data['quantity'], discount,
256
+ order_date, delivery_date, json_data['express'],
257
+ json_data['customer_id'], json_data['notes'])
258
+
259
+ # Send: convert types → strings
260
+ return JSONResponse({
261
+ 'subtotal': str(result['subtotal']), 'tax': str(result['tax']),
262
+ 'shipping': str(result['shipping']), 'total': str(result['total']),
263
+ 'ship_date': result['ship_date'].isoformat(),
264
+ 'arrival_date': result['arrival_date'].isoformat()
265
+ })
266
+ ```
267
+
268
+ **Total: 20 manual conversions** (4 JS→string + 4 string→Python + 6 Python→string + 6 string→JS).
269
+
270
+ ---
271
+
272
+ ### 3. ✅ WITH TYTX: Zero Conversions
273
+
274
+ ```javascript
275
+ import { fetchTytx } from '@genro/tytx';
276
+
277
+ const result = await fetchTytx('/api/process_order', { body: orderData });
278
+ console.log(result.total.toFixed(2)); // Big, ready to use
279
+ ```
280
+
281
+ **Total: 0 conversions. Types flow naturally.**
282
+
283
+ ### Bonus: Switch to MessagePack in One Line
284
+
285
+ Need binary format for better performance? Just add `transport: 'msgpack'`:
286
+
287
+ ```javascript
288
+ // JSON (default)
289
+ const result = await fetchTytx('/api/process_order', { body: orderData });
290
+
291
+ // MessagePack - same API, binary format
292
+ const result = await fetchTytx('/api/process_order', { body: orderData, transport: 'msgpack' });
293
+ ```
294
+
295
+ ## Supported Types
296
+
297
+ | Python | JavaScript | Wire Format |
298
+ |--------|------------|-------------|
299
+ | `Decimal` | `Decimal` (big.js) | `"99.99::N"` |
300
+ | `date` | `Date` (midnight UTC) | `"2025-01-15::D"` |
301
+ | `datetime` | `Date` | `"2025-01-15T10:30:00.000Z::DHZ"` |
302
+ | `time` | `Date` (epoch date) | `"10:30:00.000::H"` |
303
+ | `bytes` | `Uint8Array` | `"AAEC::RAW"` (base64; native bin on MessagePack) |
304
+
305
+ Native JSON types (string, number, boolean, null) pass through unchanged.
306
+
307
+ ## When to Use TYTX
308
+
309
+ **Good fit:**
310
+
311
+ - Web apps with forms containing dates/decimals
312
+ - Financial applications requiring decimal precision
313
+ - APIs that send/receive typed data frequently
314
+ - Excel-like grids with mixed types
315
+
316
+ **Not needed:**
317
+
318
+ - APIs that only use strings and integers
319
+ - Simple CRUD with no special types
320
+ - Already using GraphQL/Protobuf with full type support
321
+
322
+ ## Documentation
323
+
324
+ | I want to... | Go to... |
325
+ |--------------|----------|
326
+ | Try it in 5 minutes | [Quick Start](docs/quickstart.md) |
327
+ | Use it over HTTP | [HTTP Integration](docs/http-integration.md) |
328
+ | Understand the wire format | [How It Works](docs/how-it-works.md) |
329
+ | See API reference | [API Reference](docs/api-reference.md) |
330
+ | Compare with alternatives | [Alternatives](docs/alternatives.md) |
331
+
332
+ ## License
333
+
334
+ Apache License 2.0 - Copyright 2025 Softwell S.r.l.
package/js/README.md ADDED
@@ -0,0 +1,79 @@
1
+ # genro-tytx
2
+
3
+ **A lightweight multi-transport typed data interchange system.**
4
+
5
+ TYTX eliminates manual type conversions between Python and JavaScript, and makes switching to MessagePack for better performance as simple as changing a parameter.
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install @genrojs/tytx big.js
11
+ ```
12
+
13
+ ## Quick Start
14
+
15
+ ```javascript
16
+ import { toTytx, fromTytx, setDecimalLibrary } from '@genrojs/tytx';
17
+ import Big from 'big.js';
18
+
19
+ // Configure decimal library
20
+ setDecimalLibrary({
21
+ name: 'big.js',
22
+ constructor: Big,
23
+ isDecimal: (v) => v instanceof Big
24
+ });
25
+
26
+ // Encode
27
+ const data = {
28
+ price: new Big('99.99'),
29
+ date: new Date('2025-01-15')
30
+ };
31
+ const encoded = toTytx(data, 'json');
32
+
33
+ // Decode
34
+ const decoded = fromTytx(encoded, 'json');
35
+ // decoded.price is Big('99.99')
36
+ // decoded.date is Date
37
+ ```
38
+
39
+ ## Supported Transports
40
+
41
+ - **JSON** - Default, human-readable
42
+ - **MessagePack** - Binary, better performance
43
+ - **XML** - For XML-based systems
44
+
45
+ ```javascript
46
+ // Switch transport with a single parameter
47
+ const jsonEncoded = toTytx(data, 'json');
48
+ const msgpackEncoded = toTytx(data, 'msgpack');
49
+ const xmlEncoded = toTytx(data, 'xml');
50
+ ```
51
+
52
+ ## HTTP Client
53
+
54
+ ```javascript
55
+ import { fetchTytx } from '@genrojs/tytx';
56
+
57
+ // Fetch with automatic TYTX encoding/decoding
58
+ const result = await fetchTytx('/api/data', {
59
+ method: 'POST',
60
+ body: { price: new Big('99.99') }
61
+ });
62
+ ```
63
+
64
+ ## Supported Types
65
+
66
+ | Type | JavaScript | Python |
67
+ |------|------------|--------|
68
+ | Decimal | `Big` / `Decimal` | `decimal.Decimal` |
69
+ | Date | `Date` (date only) | `datetime.date` |
70
+ | DateTime | `Date` (with time) | `datetime.datetime` |
71
+ | Time | `Date` (time only) | `datetime.time` |
72
+
73
+ ## Documentation
74
+
75
+ Full documentation: https://genro-tytx.readthedocs.io/
76
+
77
+ ## License
78
+
79
+ Apache-2.0