boom-format 0.9.0
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 +127 -0
- package/README.md +1079 -0
- package/SPECIFICATION.md +404 -0
- package/deno.json +15 -0
- package/dist/boom.min.cjs +17 -0
- package/dist/boom.min.js +1 -0
- package/dist/boom.obf.js +1 -0
- package/dist/chunk-5PQH6SJJ.js +5148 -0
- package/dist/cli.cjs +4241 -0
- package/dist/cli.d.cts +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.global.js +4249 -0
- package/dist/cli.js +313 -0
- package/dist/index.cjs +5211 -0
- package/dist/index.d.cts +779 -0
- package/dist/index.d.ts +779 -0
- package/dist/index.global.js +5172 -0
- package/dist/index.js +82 -0
- package/package.json +96 -0
- package/samples/README.md +114 -0
- package/samples/api-response.boom +0 -0
- package/samples/api-response.boom.txt +1 -0
- package/samples/api-response.json +19 -0
- package/samples/config.boom +0 -0
- package/samples/config.boom.txt +1 -0
- package/samples/config.json +22 -0
- package/samples/users.boom +0 -0
- package/samples/users.boom.txt +1 -0
- package/samples/users.json +31 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# BOOM Format - Dual License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024-2025 Tom Taylor (github.com/t0mtaylor)
|
|
4
|
+
|
|
5
|
+
BOOM Format is available under a dual license:
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. SDKs & Client Libraries - MIT License
|
|
10
|
+
|
|
11
|
+
The SDK implementations in the following directories are licensed under the MIT License:
|
|
12
|
+
|
|
13
|
+
- `/php/` - PHP SDK
|
|
14
|
+
- `/go/` - Go SDK
|
|
15
|
+
- `/java/` - Java SDK
|
|
16
|
+
- `/rust/` - Rust SDK
|
|
17
|
+
- `/dotnet/` - .NET SDK
|
|
18
|
+
- `/swift/` - Swift SDK
|
|
19
|
+
- `/cpp/` - C++ SDK
|
|
20
|
+
- `/python/` - Python SDK (when available)
|
|
21
|
+
- `/docs/` - Documentation website
|
|
22
|
+
|
|
23
|
+
### MIT License (for SDKs)
|
|
24
|
+
|
|
25
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
26
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
27
|
+
in the Software without restriction, including without limitation the rights
|
|
28
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
29
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
30
|
+
furnished to do so, subject to the following conditions:
|
|
31
|
+
|
|
32
|
+
The above copyright notice and this permission notice shall be included in all
|
|
33
|
+
copies or substantial portions of the Software.
|
|
34
|
+
|
|
35
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
36
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
37
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
38
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
39
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
40
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
41
|
+
SOFTWARE.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## 2. Core Encoder/Decoder - Proprietary License
|
|
46
|
+
|
|
47
|
+
The core BOOM encoding/decoding algorithms in the following directories are proprietary:
|
|
48
|
+
|
|
49
|
+
- `/src/` - Core TypeScript/JavaScript implementation
|
|
50
|
+
- `/dist/` - Compiled JavaScript output
|
|
51
|
+
- `/benchmark/` - Benchmark code
|
|
52
|
+
|
|
53
|
+
### Proprietary License Terms
|
|
54
|
+
|
|
55
|
+
**Personal & Educational Use:** You may use, study, and modify the core algorithms
|
|
56
|
+
for personal, educational, and non-commercial purposes.
|
|
57
|
+
|
|
58
|
+
**Commercial Use:** Commercial use of the core algorithms requires a commercial license.
|
|
59
|
+
Contact tom@boomformat.dev for licensing inquiries.
|
|
60
|
+
|
|
61
|
+
**Restrictions:**
|
|
62
|
+
- You may NOT redistribute the core algorithms in source or compiled form
|
|
63
|
+
- You may NOT use the core algorithms in commercial products without a license
|
|
64
|
+
- You may NOT create derivative works for commercial distribution
|
|
65
|
+
|
|
66
|
+
**What IS allowed without a commercial license:**
|
|
67
|
+
- Using the published SDKs (which are MIT licensed) in your projects
|
|
68
|
+
- Using the npm/pip/cargo/nuget/etc. packages in your applications
|
|
69
|
+
- Building applications that consume BOOM-encoded data
|
|
70
|
+
- Contributing bug fixes and improvements back to the project
|
|
71
|
+
|
|
72
|
+
**What REQUIRES a commercial license:**
|
|
73
|
+
- Embedding the core encoder/decoder in a commercial product without using the officially released plugins and SDKs
|
|
74
|
+
- Creating a competing serialisation format based on BOOM algorithms
|
|
75
|
+
- Offering BOOM encoding/decoding as a service
|
|
76
|
+
- Distributing modified versions of the core algorithms
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 3. BOOM Format Specification & Dictionary - Proprietary/Confidential
|
|
81
|
+
|
|
82
|
+
The BOOM binary format specification, type markers, encoding algorithms, and shared
|
|
83
|
+
dictionary are **proprietary and confidential**. They are NOT open source.
|
|
84
|
+
|
|
85
|
+
**Strictly Prohibited:**
|
|
86
|
+
- Reverse engineering, decompiling, or disassembling the binary format
|
|
87
|
+
- Creating independent implementations based on observed behavior
|
|
88
|
+
- Extracting, publishing, or redistributing the specification details
|
|
89
|
+
- Using specification details to create competing or compatible formats
|
|
90
|
+
- Scraping or indexing documentation for the purpose of replication
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 4. AI/ML Training Prohibition
|
|
95
|
+
|
|
96
|
+
**This repository and all associated content are explicitly excluded from use in
|
|
97
|
+
training artificial intelligence or machine learning models.**
|
|
98
|
+
|
|
99
|
+
This prohibition applies to:
|
|
100
|
+
- Large Language Models (LLMs) including but not limited to GPT, Claude, Gemini, LLaMA
|
|
101
|
+
- Code generation models including but not limited to Copilot, CodeWhisperer, Cursor
|
|
102
|
+
- Any automated learning, scraping, or indexing systems
|
|
103
|
+
- Any derivative datasets created from this content
|
|
104
|
+
|
|
105
|
+
Violation of this restriction constitutes copyright infringement and will be
|
|
106
|
+
pursued to the fullest extent of applicable law.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 5. Enforcement
|
|
111
|
+
|
|
112
|
+
Unauthorized use will be pursued under:
|
|
113
|
+
- Copyright law (UK Copyright, Designs and Patents Act 1988)
|
|
114
|
+
- Trade secret law
|
|
115
|
+
- Breach of contract / Terms of Service
|
|
116
|
+
- Computer Misuse Act 1990 (where applicable)
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Contact
|
|
121
|
+
|
|
122
|
+
For commercial licensing inquiries:
|
|
123
|
+
|
|
124
|
+
- Email: tom@boomformat.dev
|
|
125
|
+
- GitHub: github.com/t0mtaylor
|
|
126
|
+
- Twitter: @tom_taylor
|
|
127
|
+
- Website: https://boomformat.dev
|