@noorm/broccolidb 2.0.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.
Files changed (56) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +219 -0
  3. package/dist/TokenCompressionService.d.ts +59 -0
  4. package/dist/TokenCompressionService.d.ts.map +1 -0
  5. package/dist/TokenCompressionService.js +179 -0
  6. package/dist/TokenCompressionService.js.map +1 -0
  7. package/dist/broccolidb-aggregation.d.ts +14 -0
  8. package/dist/broccolidb-aggregation.d.ts.map +1 -0
  9. package/dist/broccolidb-aggregation.js +158 -0
  10. package/dist/broccolidb-aggregation.js.map +1 -0
  11. package/dist/broccolidb-cas.d.ts +56 -0
  12. package/dist/broccolidb-cas.d.ts.map +1 -0
  13. package/dist/broccolidb-cas.js +285 -0
  14. package/dist/broccolidb-cas.js.map +1 -0
  15. package/dist/broccolidb-kernel.d.ts +63 -0
  16. package/dist/broccolidb-kernel.d.ts.map +1 -0
  17. package/dist/broccolidb-kernel.js +287 -0
  18. package/dist/broccolidb-kernel.js.map +1 -0
  19. package/dist/broccolidb-mutex.d.ts +37 -0
  20. package/dist/broccolidb-mutex.d.ts.map +1 -0
  21. package/dist/broccolidb-mutex.js +121 -0
  22. package/dist/broccolidb-mutex.js.map +1 -0
  23. package/dist/broccolidb-natural-query.d.ts +13 -0
  24. package/dist/broccolidb-natural-query.d.ts.map +1 -0
  25. package/dist/broccolidb-natural-query.js +188 -0
  26. package/dist/broccolidb-natural-query.js.map +1 -0
  27. package/dist/broccolidb-table.d.ts +62 -0
  28. package/dist/broccolidb-table.d.ts.map +1 -0
  29. package/dist/broccolidb-table.js +893 -0
  30. package/dist/broccolidb-table.js.map +1 -0
  31. package/dist/broccolidb-wal.d.ts +49 -0
  32. package/dist/broccolidb-wal.d.ts.map +1 -0
  33. package/dist/broccolidb-wal.js +168 -0
  34. package/dist/broccolidb-wal.js.map +1 -0
  35. package/dist/broccolidb.contracts.d.ts +232 -0
  36. package/dist/broccolidb.contracts.d.ts.map +1 -0
  37. package/dist/broccolidb.contracts.js +7 -0
  38. package/dist/broccolidb.contracts.js.map +1 -0
  39. package/dist/index.d.ts +17 -0
  40. package/dist/index.d.ts.map +1 -0
  41. package/dist/index.js +17 -0
  42. package/dist/index.js.map +1 -0
  43. package/docs/API.md +208 -0
  44. package/docs/ARCHITECTURE.md +160 -0
  45. package/docs/BRIEF.md +56 -0
  46. package/docs/CONTRIBUTING.md +82 -0
  47. package/docs/GLOSSARY.md +23 -0
  48. package/docs/OPERATIONS.md +176 -0
  49. package/docs/PHILOSOPHY.md +91 -0
  50. package/docs/README.md +116 -0
  51. package/docs/RELEASE_NOTES.md +34 -0
  52. package/docs/TROUBLESHOOTING.md +145 -0
  53. package/docs/adr/ADR-001-portable-inmemory-kernel.md +74 -0
  54. package/docs/adr/README.md +38 -0
  55. package/docs/adr/TEMPLATE.md +35 -0
  56. package/package.json +43 -0
@@ -0,0 +1,35 @@
1
+ # ADR-NNN: Decision title
2
+
3
+ - **Status:** Proposed
4
+ - **Date:** YYYY-MM-DD
5
+ - **Owners:**
6
+ - **Scope:**
7
+
8
+ ## Context
9
+
10
+ What problem or constraint requires a decision?
11
+
12
+ ## Decision
13
+
14
+ What is the supported choice? Name affected exports, files, and lifecycle
15
+ semantics precisely.
16
+
17
+ ## Alternatives considered
18
+
19
+ ### Alternative A
20
+
21
+ Why it was considered and why it was accepted or rejected.
22
+
23
+ ## Consequences
24
+
25
+ ### Positive
26
+
27
+ -
28
+
29
+ ### Trade-offs
30
+
31
+ -
32
+
33
+ ## Compatibility impact
34
+
35
+ Describe API, on-disk, runtime dependency, and upgrade implications.
package/package.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "name": "@noorm/broccolidb",
3
+ "version": "2.0.1",
4
+ "description": "Portable, dependency-free in-memory tables with WAL, CAS, checkpoints, and deterministic query helpers.",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.js"
12
+ }
13
+ },
14
+ "files": [
15
+ "dist",
16
+ "docs",
17
+ "README.md",
18
+ "LICENSE"
19
+ ],
20
+ "scripts": {
21
+ "build": "tsc -p tsconfig.json",
22
+ "test": "npm run build && node --test --import tsx/esm test/*.test.ts",
23
+ "docs:check": "node scripts/check-docs.mjs",
24
+ "check": "npm run docs:check && npm test"
25
+ },
26
+ "engines": {
27
+ "node": ">=18"
28
+ },
29
+ "keywords": [
30
+ "broccolidb",
31
+ "database",
32
+ "in-memory",
33
+ "wal",
34
+ "cas",
35
+ "portable"
36
+ ],
37
+ "license": "MIT",
38
+ "devDependencies": {
39
+ "@types/node": "^20.19.43",
40
+ "tsx": "^4.21.1",
41
+ "typescript": "^5.4.5"
42
+ }
43
+ }