valkyries 0.1.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.
Files changed (164) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +120 -0
  3. package/dist/bloom-filter/batching.d.mts +3 -0
  4. package/dist/bloom-filter/batching.d.mts.map +1 -0
  5. package/dist/bloom-filter/batching.mjs +18 -0
  6. package/dist/bloom-filter/batching.mjs.map +1 -0
  7. package/dist/bloom-filter/lookups.d.mts +6 -0
  8. package/dist/bloom-filter/lookups.d.mts.map +1 -0
  9. package/dist/bloom-filter/lookups.mjs +101 -0
  10. package/dist/bloom-filter/lookups.mjs.map +1 -0
  11. package/dist/bloom-filter/rebuilds.d.mts +9 -0
  12. package/dist/bloom-filter/rebuilds.d.mts.map +1 -0
  13. package/dist/bloom-filter/rebuilds.mjs +66 -0
  14. package/dist/bloom-filter/rebuilds.mjs.map +1 -0
  15. package/dist/bloom-filter/results.d.mts +3 -0
  16. package/dist/bloom-filter/results.d.mts.map +1 -0
  17. package/dist/bloom-filter/results.mjs +23 -0
  18. package/dist/bloom-filter/results.mjs.map +1 -0
  19. package/dist/bloom-filter/scripts.d.mts +9 -0
  20. package/dist/bloom-filter/scripts.d.mts.map +1 -0
  21. package/dist/bloom-filter/scripts.mjs +10 -0
  22. package/dist/bloom-filter/scripts.mjs.map +1 -0
  23. package/dist/bloom-filter/types.d.mts +12 -0
  24. package/dist/bloom-filter/types.d.mts.map +1 -0
  25. package/dist/bloom-filter/types.mjs +2 -0
  26. package/dist/bloom-filter/types.mjs.map +1 -0
  27. package/dist/bloom-filter/writes.d.mts +5 -0
  28. package/dist/bloom-filter/writes.d.mts.map +1 -0
  29. package/dist/bloom-filter/writes.mjs +54 -0
  30. package/dist/bloom-filter/writes.mjs.map +1 -0
  31. package/dist/bloom-filter.d.mts +90 -0
  32. package/dist/bloom-filter.d.mts.map +1 -0
  33. package/dist/bloom-filter.mjs +154 -0
  34. package/dist/bloom-filter.mjs.map +1 -0
  35. package/dist/cache/batch-read.d.mts +7 -0
  36. package/dist/cache/batch-read.d.mts.map +1 -0
  37. package/dist/cache/batch-read.mjs +142 -0
  38. package/dist/cache/batch-read.mjs.map +1 -0
  39. package/dist/cache/constants.d.mts +7 -0
  40. package/dist/cache/constants.d.mts.map +1 -0
  41. package/dist/cache/constants.mjs +8 -0
  42. package/dist/cache/constants.mjs.map +1 -0
  43. package/dist/cache/core.d.mts +38 -0
  44. package/dist/cache/core.d.mts.map +1 -0
  45. package/dist/cache/core.mjs +171 -0
  46. package/dist/cache/core.mjs.map +1 -0
  47. package/dist/cache/deletes.d.mts +8 -0
  48. package/dist/cache/deletes.d.mts.map +1 -0
  49. package/dist/cache/deletes.mjs +44 -0
  50. package/dist/cache/deletes.mjs.map +1 -0
  51. package/dist/cache/mutations.d.mts +25 -0
  52. package/dist/cache/mutations.d.mts.map +1 -0
  53. package/dist/cache/mutations.mjs +181 -0
  54. package/dist/cache/mutations.mjs.map +1 -0
  55. package/dist/cache/set-if-not-invalidated-events.d.mts +4 -0
  56. package/dist/cache/set-if-not-invalidated-events.d.mts.map +1 -0
  57. package/dist/cache/set-if-not-invalidated-events.mjs +21 -0
  58. package/dist/cache/set-if-not-invalidated-events.mjs.map +1 -0
  59. package/dist/cache/single-read.d.mts +11 -0
  60. package/dist/cache/single-read.d.mts.map +1 -0
  61. package/dist/cache/single-read.mjs +73 -0
  62. package/dist/cache/single-read.mjs.map +1 -0
  63. package/dist/cache/stale-refresh.d.mts +15 -0
  64. package/dist/cache/stale-refresh.d.mts.map +1 -0
  65. package/dist/cache/stale-refresh.mjs +70 -0
  66. package/dist/cache/stale-refresh.mjs.map +1 -0
  67. package/dist/cache-metrics.d.mts +10 -0
  68. package/dist/cache-metrics.d.mts.map +1 -0
  69. package/dist/cache-metrics.mjs +12 -0
  70. package/dist/cache-metrics.mjs.map +1 -0
  71. package/dist/cache-utils.d.mts +20 -0
  72. package/dist/cache-utils.d.mts.map +1 -0
  73. package/dist/cache-utils.mjs +67 -0
  74. package/dist/cache-utils.mjs.map +1 -0
  75. package/dist/cache.d.mts +4 -0
  76. package/dist/cache.d.mts.map +1 -0
  77. package/dist/cache.mjs +4 -0
  78. package/dist/cache.mjs.map +1 -0
  79. package/dist/clients.d.mts +51 -0
  80. package/dist/clients.d.mts.map +1 -0
  81. package/dist/clients.mjs +95 -0
  82. package/dist/clients.mjs.map +1 -0
  83. package/dist/config.d.mts +6 -0
  84. package/dist/config.d.mts.map +1 -0
  85. package/dist/config.mjs +10 -0
  86. package/dist/config.mjs.map +1 -0
  87. package/dist/delete.d.mts +3 -0
  88. package/dist/delete.d.mts.map +1 -0
  89. package/dist/delete.mjs +23 -0
  90. package/dist/delete.mjs.map +1 -0
  91. package/dist/dynamic-config/fields.d.mts +6 -0
  92. package/dist/dynamic-config/fields.d.mts.map +1 -0
  93. package/dist/dynamic-config/fields.mjs +50 -0
  94. package/dist/dynamic-config/fields.mjs.map +1 -0
  95. package/dist/dynamic-config/storage.d.mts +33 -0
  96. package/dist/dynamic-config/storage.d.mts.map +1 -0
  97. package/dist/dynamic-config/storage.mjs +55 -0
  98. package/dist/dynamic-config/storage.mjs.map +1 -0
  99. package/dist/dynamic-config.d.mts +34 -0
  100. package/dist/dynamic-config.d.mts.map +1 -0
  101. package/dist/dynamic-config.mjs +173 -0
  102. package/dist/dynamic-config.mjs.map +1 -0
  103. package/dist/errors.d.mts +4 -0
  104. package/dist/errors.d.mts.map +1 -0
  105. package/dist/errors.mjs +15 -0
  106. package/dist/errors.mjs.map +1 -0
  107. package/dist/events.d.mts +84 -0
  108. package/dist/events.d.mts.map +1 -0
  109. package/dist/events.mjs +18 -0
  110. package/dist/events.mjs.map +1 -0
  111. package/dist/index.d.mts +14 -0
  112. package/dist/index.d.mts.map +1 -0
  113. package/dist/index.mjs +13 -0
  114. package/dist/index.mjs.map +1 -0
  115. package/dist/key-normalization.d.mts +2 -0
  116. package/dist/key-normalization.d.mts.map +1 -0
  117. package/dist/key-normalization.mjs +4 -0
  118. package/dist/key-normalization.mjs.map +1 -0
  119. package/dist/rate-limiter.d.mts +40 -0
  120. package/dist/rate-limiter.d.mts.map +1 -0
  121. package/dist/rate-limiter.mjs +123 -0
  122. package/dist/rate-limiter.mjs.map +1 -0
  123. package/dist/scripts/bloom-filter-add.lua +26 -0
  124. package/dist/scripts/bloom-filter-ensure-exists.lua +13 -0
  125. package/dist/scripts/bloom-filter-exists-if-ready.lua +14 -0
  126. package/dist/scripts/bloom-filter-exists.lua +14 -0
  127. package/dist/scripts/bloom-filter-mexists-if-ready.lua +19 -0
  128. package/dist/scripts/bloom-filter-mexists.lua +17 -0
  129. package/dist/scripts/bloom-filter-reserve.lua +11 -0
  130. package/dist/scripts/cache-delete-with-invalidation.lua +29 -0
  131. package/dist/scripts/cache-set-if-not-invalidated.lua +47 -0
  132. package/dist/scripts/dynamic-config-set-fields.lua +23 -0
  133. package/dist/scripts/get-value-with-ttl.lua +35 -0
  134. package/dist/scripts/get-values-with-ttl.lua +81 -0
  135. package/dist/scripts/rate-limiter-add-and-check.lua +34 -0
  136. package/dist/scripts/rate-limiter-add.lua +26 -0
  137. package/dist/scripts/rate-limiter-get.lua +22 -0
  138. package/dist/scripts.d.mts +4 -0
  139. package/dist/scripts.d.mts.map +1 -0
  140. package/dist/scripts.mjs +31 -0
  141. package/dist/scripts.mjs.map +1 -0
  142. package/dist/shutdown.d.mts +3 -0
  143. package/dist/shutdown.d.mts.map +1 -0
  144. package/dist/shutdown.mjs +27 -0
  145. package/dist/shutdown.mjs.map +1 -0
  146. package/dist/types.d.mts +76 -0
  147. package/dist/types.d.mts.map +1 -0
  148. package/dist/types.mjs +2 -0
  149. package/dist/types.mjs.map +1 -0
  150. package/dist/utils.d.mts +16 -0
  151. package/dist/utils.d.mts.map +1 -0
  152. package/dist/utils.mjs +35 -0
  153. package/dist/utils.mjs.map +1 -0
  154. package/docs/bloom-filters.md +12 -0
  155. package/docs/cache.md +19 -0
  156. package/docs/clients.md +13 -0
  157. package/docs/configuration.md +16 -0
  158. package/docs/dynamic-config.md +13 -0
  159. package/docs/events-and-metrics.md +15 -0
  160. package/docs/lua-scripts.md +7 -0
  161. package/docs/migration.md +74 -0
  162. package/docs/rate-limiter.md +17 -0
  163. package/docs/testing-and-ci.md +21 -0
  164. package/package.json +80 -0
@@ -0,0 +1,21 @@
1
+ # Testing And CI
2
+
3
+ Tests use Vitest and require a Valkey instance with Bloom support.
4
+
5
+ Local example:
6
+
7
+ ```sh
8
+ docker run --rm -p 6379:6379 valkey/valkey-bundle:latest
9
+ pnpm run test:coverage
10
+ ```
11
+
12
+ CI starts `valkey/valkey-bundle:latest` as a service and enforces 100% line, statement, branch, and function coverage.
13
+
14
+ Validation commands:
15
+
16
+ ```sh
17
+ pnpm run typecheck
18
+ pnpm run build
19
+ pnpm run lint
20
+ pnpm run test:coverage
21
+ ```
package/package.json ADDED
@@ -0,0 +1,80 @@
1
+ {
2
+ "name": "valkyries",
3
+ "version": "0.1.0",
4
+ "description": "Valkey utilities for caches, bloom filters, dynamic configuration, and rate limiting.",
5
+ "license": "MIT",
6
+ "author": "",
7
+ "files": [
8
+ "dist",
9
+ "README.md",
10
+ "docs",
11
+ "LICENSE"
12
+ ],
13
+ "type": "module",
14
+ "main": "./dist/index.mjs",
15
+ "types": "./dist/index.d.mts",
16
+ "exports": {
17
+ ".": {
18
+ "types": "./dist/index.d.mts",
19
+ "import": "./dist/index.mjs",
20
+ "default": "./dist/index.mjs"
21
+ },
22
+ "./cache": {
23
+ "types": "./dist/cache.d.mts",
24
+ "import": "./dist/cache.mjs",
25
+ "default": "./dist/cache.mjs"
26
+ },
27
+ "./bloom-filter": {
28
+ "types": "./dist/bloom-filter.d.mts",
29
+ "import": "./dist/bloom-filter.mjs",
30
+ "default": "./dist/bloom-filter.mjs"
31
+ },
32
+ "./dynamic-config": {
33
+ "types": "./dist/dynamic-config.d.mts",
34
+ "import": "./dist/dynamic-config.mjs",
35
+ "default": "./dist/dynamic-config.mjs"
36
+ },
37
+ "./rate-limiter": {
38
+ "types": "./dist/rate-limiter.d.mts",
39
+ "import": "./dist/rate-limiter.mjs",
40
+ "default": "./dist/rate-limiter.mjs"
41
+ }
42
+ },
43
+ "scripts": {
44
+ "build": "tsc --project tsconfig.build.json && pnpm run copy:scripts",
45
+ "copy:scripts": "tsx build-scripts/copy-lua-scripts.mts",
46
+ "typecheck": "tsc --noEmit --project tsconfig.json",
47
+ "test": "vitest run",
48
+ "test:coverage": "vitest run --coverage",
49
+ "lint": "pnpm run oxlint && pnpm run oxfmt:check",
50
+ "oxlint": "oxlint --type-aware --deny-warnings",
51
+ "oxlint:fix": "oxlint --type-aware --fix --deny-warnings",
52
+ "oxfmt": "oxfmt",
53
+ "oxfmt:check": "oxfmt --check",
54
+ "actionlint": "actionlint"
55
+ },
56
+ "dependencies": {
57
+ "@valkey/valkey-glide": "^2.4.0"
58
+ },
59
+ "devDependencies": {
60
+ "@types/node": "^25.8.0",
61
+ "@vitest/coverage-v8": "^4.1.6",
62
+ "actionlint": "^2.0.6",
63
+ "oxfmt": "^0.50.0",
64
+ "oxlint": "^1.65.0",
65
+ "oxlint-tsgolint": "^0.22.1",
66
+ "tsx": "^4.22.1",
67
+ "typescript": "^6.0.3",
68
+ "vitest": "^4.1.6"
69
+ },
70
+ "engines": {
71
+ "node": ">=24.0.0"
72
+ },
73
+ "packageManager": "pnpm@11.1.2",
74
+ "pnpm": {
75
+ "onlyBuiltDependencies": [
76
+ "esbuild",
77
+ "protobufjs"
78
+ ]
79
+ }
80
+ }