@farukada/aws-langgraph-dynamodb-ts 1.0.0-rc.2 → 1.0.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 (409) hide show
  1. package/README.md +390 -193
  2. package/dist/{backfill → cjs/backfill}/backfill.d.ts +15 -12
  3. package/dist/cjs/backfill/backfill.js +177 -0
  4. package/dist/{checkpointer → cjs/checkpointer}/actions/delete-thread.d.ts +1 -1
  5. package/dist/cjs/checkpointer/actions/delete-thread.js +26 -0
  6. package/dist/{checkpointer → cjs/checkpointer}/actions/get-tuple.d.ts +4 -3
  7. package/dist/cjs/checkpointer/actions/get-tuple.js +22 -0
  8. package/dist/{checkpointer → cjs/checkpointer}/actions/list.d.ts +7 -4
  9. package/dist/cjs/checkpointer/actions/list.js +70 -0
  10. package/dist/{checkpointer → cjs/checkpointer}/actions/put-writes.d.ts +8 -6
  11. package/dist/cjs/checkpointer/actions/put-writes.js +21 -0
  12. package/dist/{checkpointer → cjs/checkpointer}/actions/put.d.ts +21 -15
  13. package/dist/cjs/checkpointer/actions/put.js +79 -0
  14. package/dist/{checkpointer → cjs/checkpointer}/internal/delta-history.d.ts +38 -26
  15. package/dist/cjs/checkpointer/internal/delta-history.js +131 -0
  16. package/dist/{checkpointer → cjs/checkpointer}/internal/listing.d.ts +4 -4
  17. package/dist/cjs/checkpointer/internal/listing.js +104 -0
  18. package/dist/{checkpointer → cjs/checkpointer}/internal/parse.d.ts +51 -15
  19. package/dist/cjs/checkpointer/internal/parse.js +184 -0
  20. package/dist/{checkpointer → cjs/checkpointer}/internal/pending-writes.d.ts +64 -25
  21. package/dist/cjs/checkpointer/internal/pending-writes.js +241 -0
  22. package/dist/{checkpointer → cjs/checkpointer}/internal/read.d.ts +15 -10
  23. package/dist/cjs/checkpointer/internal/read.js +132 -0
  24. package/dist/{checkpointer → cjs/checkpointer}/internal/rows.d.ts +94 -21
  25. package/dist/cjs/checkpointer/internal/rows.js +356 -0
  26. package/dist/{checkpointer → cjs/checkpointer}/internal/setup.d.ts +13 -20
  27. package/dist/cjs/checkpointer/internal/setup.js +25 -0
  28. package/dist/{checkpointer → cjs/checkpointer}/saver.d.ts +72 -36
  29. package/dist/cjs/checkpointer/saver.js +56 -0
  30. package/dist/{checkpointer → cjs/checkpointer}/types.d.ts +1 -1
  31. package/dist/cjs/checkpointer/types.js +2 -0
  32. package/dist/{factory → cjs/factory}/factory.d.ts +25 -20
  33. package/dist/cjs/factory/factory.js +137 -0
  34. package/dist/{factory → cjs/factory}/types.d.ts +12 -12
  35. package/dist/cjs/factory/types.js +2 -0
  36. package/dist/{history → cjs/history}/actions/add-messages.d.ts +18 -10
  37. package/dist/cjs/history/actions/add-messages.js +17 -0
  38. package/dist/{history → cjs/history}/actions/clear.d.ts +1 -1
  39. package/dist/cjs/history/actions/clear.js +29 -0
  40. package/dist/{history → cjs/history}/actions/get-messages.d.ts +11 -9
  41. package/dist/cjs/history/actions/get-messages.js +58 -0
  42. package/dist/{history → cjs/history}/actions/list-sessions.d.ts +3 -3
  43. package/dist/cjs/history/actions/list-sessions.js +67 -0
  44. package/dist/{history → cjs/history}/actions/reconcile-count.d.ts +13 -9
  45. package/dist/cjs/history/actions/reconcile-count.js +8 -0
  46. package/dist/{history → cjs/history}/chat-message-history.d.ts +62 -30
  47. package/dist/cjs/history/chat-message-history.js +61 -0
  48. package/dist/{history → cjs/history}/internal/append.d.ts +64 -32
  49. package/dist/cjs/history/internal/append.js +267 -0
  50. package/dist/{history → cjs/history}/internal/message-read.d.ts +3 -3
  51. package/dist/cjs/history/internal/message-read.js +93 -0
  52. package/dist/{history → cjs/history}/internal/parse.d.ts +2 -2
  53. package/dist/cjs/history/internal/parse.js +113 -0
  54. package/dist/{history → cjs/history}/internal/rows.d.ts +11 -10
  55. package/dist/cjs/history/internal/rows.js +96 -0
  56. package/dist/{history → cjs/history}/internal/session.d.ts +41 -22
  57. package/dist/cjs/history/internal/session.js +296 -0
  58. package/dist/{history → cjs/history}/internal/setup.d.ts +2 -2
  59. package/dist/cjs/history/internal/setup.js +60 -0
  60. package/dist/{history → cjs/history}/session-adapter.d.ts +0 -6
  61. package/dist/cjs/history/session-adapter.js +38 -0
  62. package/dist/{history → cjs/history}/types.d.ts +18 -15
  63. package/dist/cjs/history/types.js +2 -0
  64. package/dist/{index.d.ts → cjs/index.d.ts} +27 -27
  65. package/dist/cjs/index.js +25 -0
  66. package/dist/cjs/package.json +1 -0
  67. package/dist/{shared → cjs/shared}/adapter.d.ts +27 -16
  68. package/dist/cjs/shared/adapter.js +70 -0
  69. package/dist/cjs/shared/clock.js +14 -0
  70. package/dist/{shared → cjs/shared}/codec/codec.d.ts +37 -20
  71. package/dist/cjs/shared/codec/codec.js +162 -0
  72. package/dist/{shared → cjs/shared}/codec/compression.d.ts +9 -4
  73. package/dist/cjs/shared/codec/compression.js +45 -0
  74. package/dist/cjs/shared/codec/json-serde.js +58 -0
  75. package/dist/{shared → cjs/shared}/codec/s3/client-types.d.ts +2 -1
  76. package/dist/cjs/shared/codec/s3/client-types.js +6 -0
  77. package/dist/{shared → cjs/shared}/codec/s3/client.d.ts +25 -7
  78. package/dist/cjs/shared/codec/s3/client.js +78 -0
  79. package/dist/{shared → cjs/shared}/codec/s3/config.d.ts +12 -7
  80. package/dist/cjs/shared/codec/s3/config.js +92 -0
  81. package/dist/{shared → cjs/shared}/codec/s3/lifecycle.d.ts +71 -17
  82. package/dist/cjs/shared/codec/s3/lifecycle.js +223 -0
  83. package/dist/{shared → cjs/shared}/codec/s3/offloader.d.ts +42 -29
  84. package/dist/cjs/shared/codec/s3/offloader.js +289 -0
  85. package/dist/cjs/shared/concurrency.js +31 -0
  86. package/dist/{shared → cjs/shared}/dynamodb/abort.d.ts +2 -2
  87. package/dist/cjs/shared/dynamodb/abort.js +16 -0
  88. package/dist/{shared → cjs/shared}/dynamodb/batch-write.d.ts +2 -2
  89. package/dist/cjs/shared/dynamodb/batch-write.js +79 -0
  90. package/dist/cjs/shared/dynamodb/cancellation.js +37 -0
  91. package/dist/{shared → cjs/shared}/dynamodb/client.d.ts +24 -22
  92. package/dist/cjs/shared/dynamodb/client.js +40 -0
  93. package/dist/{shared → cjs/shared}/dynamodb/idempotent-write.d.ts +64 -19
  94. package/dist/cjs/shared/dynamodb/idempotent-write.js +173 -0
  95. package/dist/{shared → cjs/shared}/dynamodb/paginate.d.ts +2 -2
  96. package/dist/cjs/shared/dynamodb/paginate.js +90 -0
  97. package/dist/{shared → cjs/shared}/dynamodb/partition-delete.d.ts +6 -6
  98. package/dist/cjs/shared/dynamodb/partition-delete.js +177 -0
  99. package/dist/{shared → cjs/shared}/dynamodb/recency-index.d.ts +27 -15
  100. package/dist/cjs/shared/dynamodb/recency-index.js +146 -0
  101. package/dist/{shared → cjs/shared}/dynamodb/retry.d.ts +37 -6
  102. package/dist/cjs/shared/dynamodb/retry.js +193 -0
  103. package/dist/cjs/shared/dynamodb/row-size.d.ts +33 -0
  104. package/dist/cjs/shared/dynamodb/row-size.js +30 -0
  105. package/dist/{shared → cjs/shared}/dynamodb/table-schema.d.ts +27 -18
  106. package/dist/cjs/shared/dynamodb/table-schema.js +52 -0
  107. package/dist/{shared → cjs/shared}/errors/base-error.d.ts +42 -7
  108. package/dist/cjs/shared/errors/base-error.js +73 -0
  109. package/dist/{shared → cjs/shared}/errors/boundary.d.ts +29 -14
  110. package/dist/cjs/shared/errors/boundary.js +61 -0
  111. package/dist/cjs/shared/errors/classify.d.ts +206 -0
  112. package/dist/cjs/shared/errors/classify.js +232 -0
  113. package/dist/{shared → cjs/shared}/errors/error-code.d.ts +17 -10
  114. package/dist/cjs/shared/errors/error-code.js +27 -0
  115. package/dist/{shared → cjs/shared}/errors/errors.d.ts +75 -9
  116. package/dist/cjs/shared/errors/errors.js +123 -0
  117. package/dist/cjs/shared/logging/logger.js +30 -0
  118. package/dist/{shared → cjs/shared}/logging/redaction.d.ts +8 -4
  119. package/dist/cjs/shared/logging/redaction.js +145 -0
  120. package/dist/{shared → cjs/shared}/logging/secret-patterns.d.ts +30 -7
  121. package/dist/cjs/shared/logging/secret-patterns.js +93 -0
  122. package/dist/cjs/shared/logging/truncate.js +31 -0
  123. package/dist/{shared → cjs/shared}/options.d.ts +27 -11
  124. package/dist/cjs/shared/options.js +2 -0
  125. package/dist/cjs/shared/ulid.js +83 -0
  126. package/dist/{shared → cjs/shared}/validation/collaborators.d.ts +21 -2
  127. package/dist/cjs/shared/validation/collaborators.js +79 -0
  128. package/dist/{shared → cjs/shared}/validation/option-shape.d.ts +7 -5
  129. package/dist/cjs/shared/validation/option-shape.js +31 -0
  130. package/dist/{shared → cjs/shared}/validation/options.d.ts +4 -4
  131. package/dist/cjs/shared/validation/options.js +166 -0
  132. package/dist/cjs/shared/validation/primitives.js +114 -0
  133. package/dist/{shared → cjs/shared}/validation/ttl.d.ts +26 -9
  134. package/dist/cjs/shared/validation/ttl.js +52 -0
  135. package/dist/{store → cjs/store}/actions/list-namespaces.d.ts +5 -5
  136. package/dist/cjs/store/actions/list-namespaces.js +92 -0
  137. package/dist/{store → cjs/store}/actions/put.d.ts +11 -4
  138. package/dist/cjs/store/actions/put.js +49 -0
  139. package/dist/{store → cjs/store}/actions/reconcile-vector-index.d.ts +5 -5
  140. package/dist/cjs/store/actions/reconcile-vector-index.js +13 -0
  141. package/dist/{store → cjs/store}/actions/search.d.ts +2 -2
  142. package/dist/cjs/store/actions/search.js +26 -0
  143. package/dist/cjs/store/internal/batch-plan.d.ts +56 -0
  144. package/dist/cjs/store/internal/batch-plan.js +32 -0
  145. package/dist/{store → cjs/store}/internal/filter.d.ts +3 -3
  146. package/dist/cjs/store/internal/filter.js +64 -0
  147. package/dist/cjs/store/internal/get-item.d.ts +77 -0
  148. package/dist/cjs/store/internal/get-item.js +58 -0
  149. package/dist/{store → cjs/store}/internal/item-write.d.ts +72 -32
  150. package/dist/cjs/store/internal/item-write.js +181 -0
  151. package/dist/{store → cjs/store}/internal/parse.d.ts +15 -10
  152. package/dist/cjs/store/internal/parse.js +180 -0
  153. package/dist/{store → cjs/store}/internal/rows.d.ts +38 -34
  154. package/dist/cjs/store/internal/rows.js +166 -0
  155. package/dist/{store → cjs/store}/internal/semantic-search.d.ts +2 -2
  156. package/dist/cjs/store/internal/semantic-search.js +211 -0
  157. package/dist/{store → cjs/store}/internal/setup.d.ts +10 -15
  158. package/dist/cjs/store/internal/setup.js +103 -0
  159. package/dist/{store → cjs/store}/internal/table-search.d.ts +5 -5
  160. package/dist/cjs/store/internal/table-search.js +123 -0
  161. package/dist/{store → cjs/store}/internal/vector-index.d.ts +26 -15
  162. package/dist/cjs/store/internal/vector-index.js +269 -0
  163. package/dist/{store → cjs/store}/store.d.ts +82 -39
  164. package/dist/cjs/store/store.js +97 -0
  165. package/dist/{store → cjs/store}/types.d.ts +25 -10
  166. package/dist/cjs/store/types.js +2 -0
  167. package/dist/cjs/store/vector-backend.js +4 -0
  168. package/dist/esm/backfill/backfill.d.ts +171 -0
  169. package/dist/esm/backfill/backfill.js +170 -0
  170. package/dist/{checkpointer/actions/delete-thread.js → esm/checkpointer/actions/delete-thread.d.ts} +4 -26
  171. package/dist/esm/checkpointer/actions/delete-thread.js +23 -0
  172. package/dist/{checkpointer/actions/get-tuple.js → esm/checkpointer/actions/get-tuple.d.ts} +7 -24
  173. package/dist/esm/checkpointer/actions/get-tuple.js +19 -0
  174. package/dist/esm/checkpointer/actions/list.d.ts +55 -0
  175. package/dist/esm/checkpointer/actions/list.js +67 -0
  176. package/dist/{checkpointer/actions/put-writes.js → esm/checkpointer/actions/put-writes.d.ts} +10 -37
  177. package/dist/esm/checkpointer/actions/put-writes.js +18 -0
  178. package/dist/esm/checkpointer/actions/put.d.ts +95 -0
  179. package/dist/esm/checkpointer/actions/put.js +75 -0
  180. package/dist/esm/checkpointer/internal/delta-history.d.ts +124 -0
  181. package/dist/esm/checkpointer/internal/delta-history.js +126 -0
  182. package/dist/{checkpointer/internal/listing.js → esm/checkpointer/internal/listing.d.ts} +22 -118
  183. package/dist/esm/checkpointer/internal/listing.js +95 -0
  184. package/dist/esm/checkpointer/internal/parse.d.ts +298 -0
  185. package/dist/esm/checkpointer/internal/parse.js +169 -0
  186. package/dist/esm/checkpointer/internal/pending-writes.d.ts +314 -0
  187. package/dist/esm/checkpointer/internal/pending-writes.js +229 -0
  188. package/dist/esm/checkpointer/internal/read.d.ts +135 -0
  189. package/dist/esm/checkpointer/internal/read.js +125 -0
  190. package/dist/esm/checkpointer/internal/rows.d.ts +644 -0
  191. package/dist/esm/checkpointer/internal/rows.js +323 -0
  192. package/dist/esm/checkpointer/internal/setup.d.ts +47 -0
  193. package/dist/esm/checkpointer/internal/setup.js +21 -0
  194. package/dist/{checkpointer/saver.js → esm/checkpointer/saver.d.ts} +84 -87
  195. package/dist/esm/checkpointer/saver.js +52 -0
  196. package/dist/esm/checkpointer/types.d.ts +51 -0
  197. package/dist/esm/checkpointer/types.js +1 -0
  198. package/dist/esm/factory/factory.d.ts +154 -0
  199. package/dist/esm/factory/factory.js +133 -0
  200. package/dist/esm/factory/types.d.ts +76 -0
  201. package/dist/esm/factory/types.js +1 -0
  202. package/dist/{history/actions/add-messages.js → esm/history/actions/add-messages.d.ts} +20 -26
  203. package/dist/esm/history/actions/add-messages.js +14 -0
  204. package/dist/{history/actions/clear.js → esm/history/actions/clear.d.ts} +4 -35
  205. package/dist/esm/history/actions/clear.js +26 -0
  206. package/dist/esm/history/actions/get-messages.d.ts +60 -0
  207. package/dist/esm/history/actions/get-messages.js +55 -0
  208. package/dist/esm/history/actions/list-sessions.d.ts +55 -0
  209. package/dist/esm/history/actions/list-sessions.js +64 -0
  210. package/dist/{history/actions/reconcile-count.js → esm/history/actions/reconcile-count.d.ts} +14 -16
  211. package/dist/esm/history/actions/reconcile-count.js +5 -0
  212. package/dist/{history/chat-message-history.js → esm/history/chat-message-history.d.ts} +76 -87
  213. package/dist/esm/history/chat-message-history.js +57 -0
  214. package/dist/esm/history/internal/append.d.ts +244 -0
  215. package/dist/esm/history/internal/append.js +259 -0
  216. package/dist/esm/history/internal/message-read.d.ts +84 -0
  217. package/dist/esm/history/internal/message-read.js +89 -0
  218. package/dist/esm/history/internal/parse.d.ts +153 -0
  219. package/dist/esm/history/internal/parse.js +105 -0
  220. package/dist/{history/internal/rows.js → esm/history/internal/rows.d.ts} +58 -112
  221. package/dist/esm/history/internal/rows.js +83 -0
  222. package/dist/esm/history/internal/session.d.ts +350 -0
  223. package/dist/esm/history/internal/session.js +285 -0
  224. package/dist/esm/history/internal/setup.d.ts +64 -0
  225. package/dist/esm/history/internal/setup.js +56 -0
  226. package/dist/{history/session-adapter.js → esm/history/session-adapter.d.ts} +25 -39
  227. package/dist/esm/history/session-adapter.js +34 -0
  228. package/dist/esm/history/types.d.ts +102 -0
  229. package/dist/esm/history/types.js +1 -0
  230. package/dist/esm/index.d.ts +53 -0
  231. package/dist/esm/index.js +10 -0
  232. package/dist/esm/shared/adapter.d.ts +146 -0
  233. package/dist/esm/shared/adapter.js +65 -0
  234. package/dist/{shared/clock.js → esm/shared/clock.d.ts} +3 -14
  235. package/dist/esm/shared/clock.js +9 -0
  236. package/dist/esm/shared/codec/codec.d.ts +336 -0
  237. package/dist/esm/shared/codec/codec.js +150 -0
  238. package/dist/esm/shared/codec/compression.d.ts +66 -0
  239. package/dist/esm/shared/codec/compression.js +40 -0
  240. package/dist/esm/shared/codec/json-serde.d.ts +80 -0
  241. package/dist/esm/shared/codec/json-serde.js +54 -0
  242. package/dist/esm/shared/codec/s3/client-types.d.ts +54 -0
  243. package/dist/esm/shared/codec/s3/client-types.js +3 -0
  244. package/dist/esm/shared/codec/s3/client.d.ts +63 -0
  245. package/dist/esm/shared/codec/s3/client.js +40 -0
  246. package/dist/{shared/codec/s3/config.js → esm/shared/codec/s3/config.d.ts} +45 -93
  247. package/dist/esm/shared/codec/s3/config.js +79 -0
  248. package/dist/esm/shared/codec/s3/lifecycle.d.ts +220 -0
  249. package/dist/esm/shared/codec/s3/lifecycle.js +214 -0
  250. package/dist/esm/shared/codec/s3/offloader.d.ts +428 -0
  251. package/dist/esm/shared/codec/s3/offloader.js +278 -0
  252. package/dist/{shared/concurrency.js → esm/shared/concurrency.d.ts} +2 -37
  253. package/dist/esm/shared/concurrency.js +27 -0
  254. package/dist/{shared/dynamodb/abort.js → esm/shared/dynamodb/abort.d.ts} +4 -16
  255. package/dist/esm/shared/dynamodb/abort.js +12 -0
  256. package/dist/esm/shared/dynamodb/batch-write.d.ts +86 -0
  257. package/dist/esm/shared/dynamodb/batch-write.js +74 -0
  258. package/dist/{shared/dynamodb/cancellation.js → esm/shared/dynamodb/cancellation.d.ts} +25 -53
  259. package/dist/esm/shared/dynamodb/cancellation.js +30 -0
  260. package/dist/{shared/dynamodb/client.js → esm/shared/dynamodb/client.d.ts} +74 -64
  261. package/dist/esm/shared/dynamodb/client.js +35 -0
  262. package/dist/{shared/dynamodb/idempotent-write.js → esm/shared/dynamodb/idempotent-write.d.ts} +172 -169
  263. package/dist/esm/shared/dynamodb/idempotent-write.js +153 -0
  264. package/dist/esm/shared/dynamodb/paginate.d.ts +111 -0
  265. package/dist/esm/shared/dynamodb/paginate.js +84 -0
  266. package/dist/esm/shared/dynamodb/partition-delete.d.ts +204 -0
  267. package/dist/esm/shared/dynamodb/partition-delete.js +171 -0
  268. package/dist/esm/shared/dynamodb/recency-index.d.ts +243 -0
  269. package/dist/esm/shared/dynamodb/recency-index.js +136 -0
  270. package/dist/esm/shared/dynamodb/retry.d.ts +317 -0
  271. package/dist/esm/shared/dynamodb/retry.js +180 -0
  272. package/dist/esm/shared/dynamodb/row-size.d.ts +33 -0
  273. package/dist/esm/shared/dynamodb/row-size.js +26 -0
  274. package/dist/{shared/dynamodb/table-schema.js → esm/shared/dynamodb/table-schema.d.ts} +57 -67
  275. package/dist/esm/shared/dynamodb/table-schema.js +43 -0
  276. package/dist/esm/shared/errors/base-error.d.ts +231 -0
  277. package/dist/esm/shared/errors/base-error.js +64 -0
  278. package/dist/esm/shared/errors/boundary.d.ts +86 -0
  279. package/dist/esm/shared/errors/boundary.js +54 -0
  280. package/dist/esm/shared/errors/classify.d.ts +206 -0
  281. package/dist/esm/shared/errors/classify.js +220 -0
  282. package/dist/{shared/errors/error-code.js → esm/shared/errors/error-code.d.ts} +39 -43
  283. package/dist/esm/shared/errors/error-code.js +24 -0
  284. package/dist/{shared/errors/errors.js → esm/shared/errors/errors.d.ts} +92 -98
  285. package/dist/esm/shared/errors/errors.js +110 -0
  286. package/dist/{shared/logging/logger.js → esm/shared/logging/logger.d.ts} +22 -52
  287. package/dist/esm/shared/logging/logger.js +25 -0
  288. package/dist/esm/shared/logging/redaction.d.ts +123 -0
  289. package/dist/esm/shared/logging/redaction.js +140 -0
  290. package/dist/{shared/logging/secret-patterns.js → esm/shared/logging/secret-patterns.d.ts} +46 -87
  291. package/dist/esm/shared/logging/secret-patterns.js +83 -0
  292. package/dist/{shared/logging/truncate.js → esm/shared/logging/truncate.d.ts} +6 -40
  293. package/dist/esm/shared/logging/truncate.js +25 -0
  294. package/dist/esm/shared/options.d.ts +100 -0
  295. package/dist/esm/shared/options.js +1 -0
  296. package/dist/{shared/ulid.js → esm/shared/ulid.d.ts} +4 -84
  297. package/dist/esm/shared/ulid.js +77 -0
  298. package/dist/{shared/validation/collaborators.js → esm/shared/validation/collaborators.d.ts} +37 -65
  299. package/dist/esm/shared/validation/collaborators.js +70 -0
  300. package/dist/{shared/validation/option-shape.js → esm/shared/validation/option-shape.d.ts} +14 -36
  301. package/dist/esm/shared/validation/option-shape.js +24 -0
  302. package/dist/esm/shared/validation/options.d.ts +145 -0
  303. package/dist/esm/shared/validation/options.js +156 -0
  304. package/dist/{shared/validation/primitives.js → esm/shared/validation/primitives.d.ts} +30 -125
  305. package/dist/esm/shared/validation/primitives.js +100 -0
  306. package/dist/esm/shared/validation/ttl.d.ts +94 -0
  307. package/dist/esm/shared/validation/ttl.js +46 -0
  308. package/dist/esm/store/actions/list-namespaces.d.ts +79 -0
  309. package/dist/esm/store/actions/list-namespaces.js +86 -0
  310. package/dist/esm/store/actions/put.d.ts +43 -0
  311. package/dist/esm/store/actions/put.js +46 -0
  312. package/dist/{store/actions/reconcile-vector-index.js → esm/store/actions/reconcile-vector-index.d.ts} +8 -16
  313. package/dist/esm/store/actions/reconcile-vector-index.js +10 -0
  314. package/dist/esm/store/actions/search.d.ts +38 -0
  315. package/dist/esm/store/actions/search.js +23 -0
  316. package/dist/esm/store/internal/batch-plan.d.ts +56 -0
  317. package/dist/esm/store/internal/batch-plan.js +28 -0
  318. package/dist/esm/store/internal/filter.d.ts +43 -0
  319. package/dist/esm/store/internal/filter.js +60 -0
  320. package/dist/esm/store/internal/get-item.d.ts +77 -0
  321. package/dist/esm/store/internal/get-item.js +54 -0
  322. package/dist/esm/store/internal/item-write.d.ts +270 -0
  323. package/dist/esm/store/internal/item-write.js +173 -0
  324. package/dist/esm/store/internal/parse.d.ts +230 -0
  325. package/dist/esm/store/internal/parse.js +169 -0
  326. package/dist/{store/internal/rows.js → esm/store/internal/rows.d.ts} +111 -199
  327. package/dist/esm/store/internal/rows.js +147 -0
  328. package/dist/esm/store/internal/semantic-search.d.ts +168 -0
  329. package/dist/esm/store/internal/semantic-search.js +200 -0
  330. package/dist/esm/store/internal/setup.d.ts +96 -0
  331. package/dist/esm/store/internal/setup.js +98 -0
  332. package/dist/esm/store/internal/table-search.d.ts +100 -0
  333. package/dist/esm/store/internal/table-search.js +119 -0
  334. package/dist/esm/store/internal/vector-index.d.ts +258 -0
  335. package/dist/esm/store/internal/vector-index.js +256 -0
  336. package/dist/{store/store.js → esm/store/store.d.ts} +99 -133
  337. package/dist/esm/store/store.js +93 -0
  338. package/dist/esm/store/types.d.ts +111 -0
  339. package/dist/esm/store/types.js +1 -0
  340. package/dist/esm/store/vector-backend.d.ts +104 -0
  341. package/dist/esm/store/vector-backend.js +1 -0
  342. package/package.json +50 -44
  343. package/dist/backfill/backfill.js +0 -393
  344. package/dist/checkpointer/actions/list.js +0 -142
  345. package/dist/checkpointer/actions/put.js +0 -195
  346. package/dist/checkpointer/internal/delta-history.js +0 -252
  347. package/dist/checkpointer/internal/parse.js +0 -372
  348. package/dist/checkpointer/internal/pending-writes.js +0 -588
  349. package/dist/checkpointer/internal/read.js +0 -264
  350. package/dist/checkpointer/internal/rows.js +0 -834
  351. package/dist/checkpointer/internal/setup.js +0 -72
  352. package/dist/checkpointer/types.js +0 -12
  353. package/dist/factory/factory.js +0 -266
  354. package/dist/factory/types.js +0 -10
  355. package/dist/history/actions/get-messages.js +0 -141
  356. package/dist/history/actions/list-sessions.js +0 -156
  357. package/dist/history/internal/append.js +0 -500
  358. package/dist/history/internal/message-read.js +0 -204
  359. package/dist/history/internal/parse.js +0 -252
  360. package/dist/history/internal/session.js +0 -628
  361. package/dist/history/internal/setup.js +0 -106
  362. package/dist/history/types.js +0 -12
  363. package/dist/index.js +0 -51
  364. package/dist/shared/adapter.js +0 -143
  365. package/dist/shared/codec/codec.js +0 -441
  366. package/dist/shared/codec/compression.js +0 -89
  367. package/dist/shared/codec/json-serde.js +0 -191
  368. package/dist/shared/codec/s3/client-types.js +0 -26
  369. package/dist/shared/codec/s3/client.js +0 -97
  370. package/dist/shared/codec/s3/lifecycle.js +0 -355
  371. package/dist/shared/codec/s3/offloader.js +0 -658
  372. package/dist/shared/dynamodb/batch-write.js +0 -173
  373. package/dist/shared/dynamodb/paginate.js +0 -188
  374. package/dist/shared/dynamodb/partition-delete.js +0 -340
  375. package/dist/shared/dynamodb/recency-index.js +0 -377
  376. package/dist/shared/dynamodb/retry.js +0 -463
  377. package/dist/shared/errors/base-error.js +0 -174
  378. package/dist/shared/errors/boundary.js +0 -143
  379. package/dist/shared/errors/classify.d.ts +0 -97
  380. package/dist/shared/errors/classify.js +0 -257
  381. package/dist/shared/logging/redaction.js +0 -316
  382. package/dist/shared/options.js +0 -11
  383. package/dist/shared/validation/options.js +0 -328
  384. package/dist/shared/validation/ttl.js +0 -132
  385. package/dist/store/actions/list-namespaces.js +0 -197
  386. package/dist/store/actions/put.js +0 -78
  387. package/dist/store/actions/search.js +0 -66
  388. package/dist/store/internal/batch-plan.d.ts +0 -26
  389. package/dist/store/internal/batch-plan.js +0 -109
  390. package/dist/store/internal/filter.js +0 -137
  391. package/dist/store/internal/get-item.d.ts +0 -45
  392. package/dist/store/internal/get-item.js +0 -115
  393. package/dist/store/internal/item-write.js +0 -463
  394. package/dist/store/internal/parse.js +0 -350
  395. package/dist/store/internal/semantic-search.js +0 -389
  396. package/dist/store/internal/setup.js +0 -223
  397. package/dist/store/internal/table-search.js +0 -213
  398. package/dist/store/internal/vector-index.js +0 -546
  399. package/dist/store/types.js +0 -15
  400. package/dist/store/vector-backend.js +0 -17
  401. /package/dist/{shared → cjs/shared}/clock.d.ts +0 -0
  402. /package/dist/{shared → cjs/shared}/codec/json-serde.d.ts +0 -0
  403. /package/dist/{shared → cjs/shared}/concurrency.d.ts +0 -0
  404. /package/dist/{shared → cjs/shared}/dynamodb/cancellation.d.ts +0 -0
  405. /package/dist/{shared → cjs/shared}/logging/logger.d.ts +0 -0
  406. /package/dist/{shared → cjs/shared}/logging/truncate.d.ts +0 -0
  407. /package/dist/{shared → cjs/shared}/ulid.d.ts +0 -0
  408. /package/dist/{shared → cjs/shared}/validation/primitives.d.ts +0 -0
  409. /package/dist/{store → cjs/store}/vector-backend.d.ts +0 -0
@@ -1,389 +0,0 @@
1
- "use strict";
2
- /**
3
- * Hides which text of a value is embedded, and how.
4
- *
5
- * The text an index field names is extracted exactly as LangGraph's in-memory
6
- * store extracts it — dotted paths, `[n]` and `[*]`, `{a,b}` groups, pretty
7
- * JSON for containers — then embedded in bounded batches, and every vector the
8
- * model returns is held to the configured dimension.
9
- */
10
- Object.defineProperty(exports, "__esModule", { value: true });
11
- exports.cosineSimilarity = cosineSimilarity;
12
- exports.extractTexts = extractTexts;
13
- exports.extractText = extractText;
14
- exports.assertVectorDims = assertVectorDims;
15
- exports.embedValues = embedValues;
16
- exports.embedValue = embedValue;
17
- exports.embedPassages = embedPassages;
18
- exports.tokenizePath = tokenizePath;
19
- exports.getTextAtPath = getTextAtPath;
20
- const errors_1 = require("../../shared/errors/errors");
21
- /** Texts per `embedDocuments` call; keeps provider request sizes bounded. */
22
- const EMBED_BATCH_SIZE = 100;
23
- /**
24
- * Cosine similarity of two vectors.
25
- *
26
- * Accepts: any two vectors. Lengths that disagree, and a vector of all zeros,
27
- * have no defined angle between them.
28
- *
29
- * Returns: the cosine, in [-1, 1]; `0` for the undefined cases, which ranks
30
- * such a pair as unrelated rather than as opposed. A caller that must
31
- * distinguish "unrelated" from "incomparable" checks the lengths itself —
32
- * `rankInMemory` does, so it can report a model mismatch instead of ranking
33
- * everything at zero.
34
- *
35
- * Throws: nothing.
36
- */
37
- function cosineSimilarity(a, b) {
38
- if (a.length !== b.length)
39
- return 0;
40
- let dot = 0;
41
- let normA = 0;
42
- let normB = 0;
43
- for (let i = 0; i < a.length; i++) {
44
- dot += a[i] * b[i];
45
- normA += a[i] * a[i];
46
- normB += b[i] * b[i];
47
- }
48
- if (normA === 0 || normB === 0)
49
- return 0;
50
- return dot / (Math.sqrt(normA) * Math.sqrt(normB));
51
- }
52
- /**
53
- * The indexable texts of a value, one per extracted path, in field order.
54
- *
55
- * Extraction is byte-for-byte what LangGraph's `InMemoryStore` does (see
56
- * {@link getTextAtPath}), and so is keeping them apart: the reference embeds each
57
- * extracted element separately and scores an item by its best-matching one.
58
- * Joining them and embedding once averages a long document into a single
59
- * vector, which ranks a document holding one strongly-matching section
60
- * materially lower — a retrieval-quality difference, not an edge case.
61
- *
62
- * Accepts: `value` — a stored item's value. `fields` — JSON paths; a path that
63
- * addresses nothing contributes nothing.
64
- *
65
- * Returns: one text per extracted path, in field order, with empty ones
66
- * dropped: an empty string embeds to a vector that means nothing and would rank
67
- * against every query.
68
- *
69
- * Throws: nothing.
70
- */
71
- function extractTexts(value, fields) {
72
- return fields.flatMap((field) => getTextAtPath(value, field)).filter((text) => text.length > 0);
73
- }
74
- /**
75
- * The same texts joined into one, which is what a single-vector consumer needs.
76
- *
77
- * Accepts: as {@link extractTexts}.
78
- *
79
- * Returns: the texts joined by a space, and `''` when there are none — which is
80
- * how a caller tells "nothing to index" from a text to embed.
81
- *
82
- * Throws: nothing.
83
- *
84
- * Used only for a configured `vectorBackend`, whose contract is one vector per
85
- * `(namespace, key)`; the in-DynamoDB path embeds each text separately.
86
- */
87
- function extractText(value, fields) {
88
- return extractTexts(value, fields).join(' ');
89
- }
90
- /**
91
- * Reject a vector whose length disagrees with the configured `index.dims`. A
92
- * mismatch means the embeddings model does not match the configuration, so
93
- * every stored vector would be incomparable with every query; failing here
94
- * surfaces that at the first put or search instead of ranking silently.
95
- *
96
- * Accepts: `index.dims` — the check is skipped when it is not a positive
97
- * integer, since nothing else in this package reads it and a store configured
98
- * without it must keep working. `vector` — a document or query vector the model
99
- * just returned. `what` — names which of the two, for the message.
100
- *
101
- * Returns: nothing: `vector` is kept under its declared type, and this
102
- * checks it.
103
- *
104
- * Throws: `VALIDATION` naming `index.dims`.
105
- */
106
- function assertVectorDims(index, vector, what) {
107
- const dims = index.dims;
108
- if (!Number.isInteger(dims) || dims <= 0 || vector.length === dims)
109
- return;
110
- throw (0, errors_1.validationError)(`index.embeddings returned a ${vector.length}-dimensional ${what} vector but index.dims ` +
111
- `is ${dims}; the embeddings model does not match the configured index`, 'index.dims');
112
- }
113
- /**
114
- * Embed several values for indexing with `embedDocuments` — the document-side
115
- * method; providers such as Titan and Cohere embed documents and queries with
116
- * different task types, so embedding a document with `embedQuery` degrades
117
- * retrieval.
118
- *
119
- * Accepts: `values` — any number, including none. `fieldsOverride` — a put's
120
- * own `index` fields; absent uses the store's, and a store with no configured
121
- * fields indexes the whole document (`'$'`), as the reference does.
122
- *
123
- * Returns: one entry per value, in input order: its vector, or `undefined` when
124
- * the value has no indexable text or the store has no index at all.
125
- *
126
- * Throws: `VALIDATION` naming `index.dims` when the model's width disagrees
127
- * with the configuration; whatever the model throws.
128
- *
129
- * Guarantees: values with no text are never sent to the model, and the rest go
130
- * in batches of {@link EMBED_BATCH_SIZE}, so one call cannot turn into one
131
- * provider request per item or a single unbounded one.
132
- */
133
- async function embedValues(context, values, fieldsOverride) {
134
- const index = context.index;
135
- if (!index)
136
- return values.map(() => undefined);
137
- const fields = fieldsOverride ?? index.fields ?? ['$'];
138
- const pending = [];
139
- values.forEach((value, position) => {
140
- const text = extractText(value, fields);
141
- if (text.length > 0)
142
- pending.push({ text, position });
143
- });
144
- const vectors = values.map(() => undefined);
145
- for (let start = 0; start < pending.length; start += EMBED_BATCH_SIZE) {
146
- const batch = pending.slice(start, start + EMBED_BATCH_SIZE);
147
- const embedded = await index.embeddings.embedDocuments(batch.map((entry) => entry.text));
148
- batch.forEach((entry, i) => {
149
- assertVectorDims(index, embedded[i], 'document');
150
- vectors[entry.position] = embedded[i];
151
- });
152
- }
153
- return vectors;
154
- }
155
- /**
156
- * Embed one value for indexing.
157
- *
158
- * Accepts: as {@link embedValues}, for one value; `fieldsOverride` (from a
159
- * put's `index` option) takes precedence over the store's configured fields.
160
- *
161
- * Returns: the value's vector, or undefined when indexing is off or it has no
162
- * indexable text.
163
- *
164
- * Throws: as {@link embedValues}.
165
- */
166
- async function embedValue(context, value, fieldsOverride) {
167
- return (await embedValues(context, [value], fieldsOverride))[0];
168
- }
169
- /**
170
- * One vector per extracted path, for the item's own row — the shape the
171
- * in-DynamoDB ranker scores by best match, matching the reference store.
172
- *
173
- * Accepts: as {@link embedValues}, for one value.
174
- *
175
- * Returns: one vector per extracted text, in path order; `undefined` when
176
- * indexing is off or the value yields no indexable text — which is what clears
177
- * a stale vector on a re-put, since the row is written without the attribute.
178
- *
179
- * Throws: as {@link embedValues}.
180
- *
181
- * Guarantees: every text of one value goes in as few `embedDocuments` calls as
182
- * {@link EMBED_BATCH_SIZE} allows, never one call per path.
183
- */
184
- async function embedPassages(context, value, fieldsOverride) {
185
- const index = context.index;
186
- if (!index)
187
- return undefined;
188
- const texts = extractTexts(value, fieldsOverride ?? index.fields ?? ['$']);
189
- if (texts.length === 0)
190
- return undefined;
191
- const vectors = [];
192
- for (let start = 0; start < texts.length; start += EMBED_BATCH_SIZE) {
193
- const embedded = await index.embeddings.embedDocuments(texts.slice(start, start + EMBED_BATCH_SIZE));
194
- for (const vector of embedded) {
195
- assertVectorDims(index, vector, 'document');
196
- vectors.push(vector);
197
- }
198
- }
199
- return vectors;
200
- }
201
- /**
202
- * Pretty JSON, exactly as `InMemoryStore` embeds non-scalar values, as a list so
203
- * that a value with no JSON text contributes nothing.
204
- *
205
- * `JSON.stringify` answers "no text" in two ways: it *returns* undefined for a
206
- * value JSON cannot represent (`undefined`, a function, a symbol) and it
207
- * *throws* for one it refuses (a circular structure, a `BigInt`). Both mean the
208
- * same thing here — there is no text to index — and neither may escape: the
209
- * first would put a literal `undefined` into a `string[]` and crash the
210
- * caller's `text.length` filter, and the second would surface a raw
211
- * `TypeError` from inside the embedding step. A value JSON refuses outright is
212
- * still refused, by the codec, at the write that follows, which names the
213
- * offending field.
214
- */
215
- function prettyText(value) {
216
- let text;
217
- try {
218
- text = JSON.stringify(value, null, 2);
219
- }
220
- catch {
221
- return [];
222
- }
223
- return text === undefined ? [] : [text];
224
- }
225
- function isScalar(value) {
226
- return typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean';
227
- }
228
- /** Text for a leaf: scalars stringify, containers pretty-print, null yields nothing. */
229
- function leafText(value) {
230
- if (isScalar(value))
231
- return [String(value)];
232
- if (value === null)
233
- return [];
234
- return prettyText(value);
235
- }
236
- /** Index just past the closer matching an opener at `start - 1`, honouring nesting. */
237
- function scanGroup(path, start, open, close) {
238
- let depth = 1;
239
- let i = start;
240
- while (i < path.length && depth > 0) {
241
- if (path[i] === open)
242
- depth += 1;
243
- else if (path[i] === close)
244
- depth -= 1;
245
- i += 1;
246
- }
247
- return i;
248
- }
249
- /**
250
- * Split a JSON path into tokens the way LangGraph's `InMemoryStore` does: dots
251
- * separate plain segments, while a `[…]` index and a `{…}` field group each
252
- * become a token of their own (`tags[0]` → `['tags', '[0]']`).
253
- *
254
- * Accepts: any path string. An empty path, and a path of nothing but
255
- * separators, tokenize to nothing. An **unterminated** `[` or `{` runs to the
256
- * end of the path and becomes a token that no longer closes — `'tags[0'` →
257
- * `['tags', '[0']` — so it is resolved as a plain member name and matches
258
- * nothing unless the value at `tags` holds a field literally called `[0`. That is the reference
259
- * tokenizer's own answer (`@langchain/langgraph-checkpoint@1.1.5`
260
- * `dist/store/utils.js:23-30`), and matching it matters more than refusing the
261
- * path: `index.fields` is validated where it is configured, and text extraction
262
- * must stay byte-for-byte comparable with the reference store.
263
- *
264
- * Returns: the tokens, in path order.
265
- *
266
- * Throws: nothing.
267
- */
268
- function tokenizePath(path) {
269
- const tokens = [];
270
- let current = '';
271
- const flush = () => {
272
- if (current.length > 0)
273
- tokens.push(current);
274
- current = '';
275
- };
276
- let i = 0;
277
- while (i < path.length) {
278
- const char = path[i];
279
- if (char === '[' || char === '{') {
280
- flush();
281
- const end = scanGroup(path, i + 1, char, char === '[' ? ']' : '}');
282
- tokens.push(path.slice(i, end));
283
- i = end;
284
- continue;
285
- }
286
- if (char === '.')
287
- flush();
288
- else
289
- current += char;
290
- i += 1;
291
- }
292
- flush();
293
- return tokens;
294
- }
295
- /** Walk one `{…}`-group field by plain `in` lookups, as the reference does. */
296
- function groupFieldText(value, field) {
297
- let current = value;
298
- for (const token of tokenizePath(field)) {
299
- if (current !== null && typeof current === 'object' && token in current) {
300
- current = current[token];
301
- }
302
- else {
303
- return [];
304
- }
305
- }
306
- return isScalar(current) ? [String(current)] : prettyText(current);
307
- }
308
- /** Resolve a `[n]`, `[-n]` or `[*]` token against an array; anything else yields nothing. */
309
- function indexText(value, token, tokens, pos) {
310
- if (!Array.isArray(value))
311
- return [];
312
- const index = token.slice(1, -1);
313
- if (index === '*')
314
- return value.flatMap((item) => extract(item, tokens, pos + 1));
315
- let idx = Number.parseInt(index, 10);
316
- if (Number.isNaN(idx))
317
- return [];
318
- if (idx < 0)
319
- idx = value.length + idx;
320
- return idx >= 0 && idx < value.length ? extract(value[idx], tokens, pos + 1) : [];
321
- }
322
- /** Resolve a `{a,b.c}` token: each listed field, walked from the current value. */
323
- function groupText(value, token) {
324
- if (typeof value !== 'object' || value === null)
325
- return [];
326
- const results = [];
327
- for (const field of token.slice(1, -1).split(',')) {
328
- const trimmed = field.trim();
329
- if (tokenizePath(trimmed).length > 0)
330
- results.push(...groupFieldText(value, trimmed));
331
- }
332
- return results;
333
- }
334
- /** Resolve a bare `*` token: every array item or every object value. */
335
- function wildcardText(value, tokens, pos) {
336
- if (Array.isArray(value))
337
- return value.flatMap((item) => extract(item, tokens, pos + 1));
338
- if (typeof value === 'object' && value !== null) {
339
- return Object.values(value).flatMap((item) => extract(item, tokens, pos + 1));
340
- }
341
- return [];
342
- }
343
- /** Resolve a plain member token by an `in` lookup, exactly as the reference does. */
344
- function memberText(value, token, tokens, pos) {
345
- if (typeof value !== 'object' || value === null || !(token in value))
346
- return [];
347
- return extract(value[token], tokens, pos + 1);
348
- }
349
- function extract(value, tokens, pos) {
350
- if (pos >= tokens.length)
351
- return leafText(value);
352
- const token = tokens[pos];
353
- if (token.startsWith('[') && token.endsWith(']'))
354
- return indexText(value, token, tokens, pos);
355
- const results = pos === 0 && token === '$' ? prettyText(value) : [];
356
- if (token.startsWith('{') && token.endsWith('}'))
357
- results.push(...groupText(value, token));
358
- else if (token === '*')
359
- results.push(...wildcardText(value, tokens, pos));
360
- else
361
- results.push(...memberText(value, token, tokens, pos));
362
- return results;
363
- }
364
- /**
365
- * Extract the indexable text of `value` at `path`, byte-for-byte as LangGraph's
366
- * `InMemoryStore` does (`store/utils`), so an embedding computed here matches
367
- * one computed by the reference store for the same document. Supports plain
368
- * paths, `[n]`/`[-n]`/`[*]` indexing, a bare `*` wildcard, `{a,b.c}` field
369
- * groups and `$` for the whole document. The package root's `getTextAtPath` is
370
- * a string-only variant that returns nothing for numbers, booleans, objects
371
- * and arrays and throws on a `null` intermediate; it must not be used here.
372
- *
373
- * Accepts: `value` — any stored value, including a scalar and `null`. `path` —
374
- * empty or `$` asks for the whole document; anything else is tokenized. A path
375
- * that addresses nothing present, a `[n]` against a non-array, a `{…}` group
376
- * against a non-object: each yields no text rather than an error, because one
377
- * unindexable field of one item must not fail a put or a search.
378
- *
379
- * Returns: the extracted texts, in path order — one per match, kept apart so
380
- * each is embedded on its own (see `extractTexts`). Empty when the path
381
- * addresses nothing, and empty for a leaf JSON cannot represent.
382
- *
383
- * Throws: nothing.
384
- */
385
- function getTextAtPath(value, path) {
386
- if (path === '' || path === '$')
387
- return prettyText(value);
388
- return extract(value, tokenizePath(path), 0);
389
- }
@@ -1,223 +0,0 @@
1
- "use strict";
2
- /**
3
- * Hides which options the store and its methods accept, and how the store is
4
- * assembled from them.
5
- *
6
- * The exhaustive key list of every option bag — the constructor's, `search`'s,
7
- * `listNamespaces`' — lives here, compiler-checked against its type. The
8
- * store's own options are checked after the shared ones — the in-memory caps,
9
- * that a vector backend comes with an index, that the index can embed, the
10
- * score direction — and the context every operation receives is built with its
11
- * defaults filled in.
12
- */
13
- Object.defineProperty(exports, "__esModule", { value: true });
14
- exports.STORE_LIST_NAMESPACES_KEYS = exports.STORE_SEARCH_KEYS = exports.STORE_KEYS = exports.MAX_SCAN_ITEMS = exports.MAX_SEARCH_CANDIDATES = exports.DEFAULT_MAX_SEARCH_CANDIDATES = void 0;
15
- exports.setUpStore = setUpStore;
16
- exports.assertStoreOptions = assertStoreOptions;
17
- const adapter_1 = require("../../shared/adapter");
18
- const json_serde_1 = require("../../shared/codec/json-serde");
19
- const paginate_1 = require("../../shared/dynamodb/paginate");
20
- const errors_1 = require("../../shared/errors/errors");
21
- const collaborators_1 = require("../../shared/validation/collaborators");
22
- const option_shape_1 = require("../../shared/validation/option-shape");
23
- const primitives_1 = require("../../shared/validation/primitives");
24
- const vector_backend_1 = require("../vector-backend");
25
- /** Default cap on candidates the in-DB semantic ranker will score. */
26
- exports.DEFAULT_MAX_SEARCH_CANDIDATES = 1000;
27
- /**
28
- * Largest `maxSearchCandidates` an adapter accepts: this many decoded
29
- * candidates are held and re-ranked in memory by one `search()` call, so an
30
- * unbounded value lets a typo or hostile config hold an unbounded working set.
31
- */
32
- exports.MAX_SEARCH_CANDIDATES = 100_000;
33
- /**
34
- * Largest `maxScanItems` an adapter accepts: this many raw rows are collected
35
- * into memory across one paginated scan/query before it errors, so — like
36
- * {@link MAX_SEARCH_CANDIDATES} — an unbounded value lets a typo or hostile
37
- * config hold an unbounded working set.
38
- */
39
- exports.MAX_SCAN_ITEMS = 1_000_000;
40
- /**
41
- * Validate the options, then resolve the client, offloader, serializer and index.
42
- *
43
- * Accepts: `options` — validated first, so no half-built store exists when one
44
- * is wrong. Everything optional has a default here and nowhere else, which is
45
- * what lets every action read `context.x` without re-deciding what absent means.
46
- *
47
- * Returns: the context every action shares, and the shell that releases what
48
- * it holds — a client the caller passed in is never destroyed by `destroy()`.
49
- *
50
- * Throws: `VALIDATION` for any invalid option, naming the option.
51
- *
52
- * Guarantees: constructing a store performs no I/O. The stacked-retry check is
53
- * deliberately not awaited: it is a warning about a caller-supplied client, not
54
- * a precondition.
55
- */
56
- function setUpStore(options) {
57
- (0, option_shape_1.assertShape)(options, exports.STORE_KEYS, 'options');
58
- const shell = (0, adapter_1.openAdapter)(options, 'store', {
59
- options: () => assertStoreOptions(options),
60
- collaborators: () => {
61
- if (options.vectorBackend !== undefined) {
62
- (0, collaborators_1.assertMembers)(options.vectorBackend, collaborators_1.VECTOR_BACKEND_MEMBERS, 'vectorBackend');
63
- }
64
- },
65
- });
66
- return {
67
- shell,
68
- context: {
69
- ...shell.core,
70
- serde: options.serde ?? json_serde_1.JSON_SERDE,
71
- index: options.index,
72
- vectorBackend: options.vectorBackend,
73
- vectorScoreDirection: options.vectorScoreDirection ?? 'relevance',
74
- maxSearchCandidates: options.maxSearchCandidates ?? exports.DEFAULT_MAX_SEARCH_CANDIDATES,
75
- maxScanItems: options.maxScanItems ?? paginate_1.MAX_TOTAL_ROWS_IN_MEMORY,
76
- },
77
- };
78
- }
79
- /**
80
- * The keys of each store option bag, exhaustive in both directions:
81
- * `allKeysOf<T>` makes omitting or inventing one a compile error, so a list
82
- * cannot rot away from the type it guards. They live with the feature because
83
- * the types they are checked against do; `shared/` knows no feature.
84
- */
85
- exports.STORE_KEYS = (0, option_shape_1.allKeysOf)({
86
- tableName: 'tableName',
87
- client: 'client',
88
- clientConfig: 'clientConfig',
89
- createClient: 'createClient',
90
- ttl: 'ttl',
91
- logger: 'logger',
92
- retry: 'retry',
93
- indexShards: 'indexShards',
94
- indexName: 'indexName',
95
- readConcurrency: 'readConcurrency',
96
- compression: 'compression',
97
- s3: 's3',
98
- serde: 'serde',
99
- index: 'index',
100
- vectorBackend: 'vectorBackend',
101
- maxSearchCandidates: 'maxSearchCandidates',
102
- maxScanItems: 'maxScanItems',
103
- vectorScoreDirection: 'vectorScoreDirection',
104
- });
105
- /** See {@link STORE_KEYS}. */
106
- exports.STORE_SEARCH_KEYS = (0, option_shape_1.allKeysOf)({
107
- filter: 'filter',
108
- limit: 'limit',
109
- offset: 'offset',
110
- query: 'query',
111
- signal: 'signal',
112
- });
113
- /**
114
- * See {@link STORE_KEYS}. `ListNamespacesOptions` is pinned equal to
115
- * `BaseStore.listNamespaces`' own parameter type, so this list is checked
116
- * against upstream's options through it.
117
- */
118
- exports.STORE_LIST_NAMESPACES_KEYS = (0, option_shape_1.allKeysOf)({
119
- prefix: 'prefix',
120
- suffix: 'suffix',
121
- maxDepth: 'maxDepth',
122
- limit: 'limit',
123
- offset: 'offset',
124
- });
125
- /**
126
- * The keys `IndexConfig` declares. The type is upstream's, but this package is
127
- * what reads `index`, so a key missing from this list — a misspelling, or one
128
- * a later upstream release adds — is one it would silently ignore; refusing it
129
- * is what tells the caller their setting is not in effect.
130
- */
131
- const INDEX_KEYS = (0, option_shape_1.allKeysOf)({
132
- dims: 'dims',
133
- embeddings: 'embeddings',
134
- fields: 'fields',
135
- });
136
- /**
137
- * Reject an `index` that cannot actually embed. `IndexConfig` mandates
138
- * `embeddings`, but a JavaScript caller can omit it or pass the wrong shape,
139
- * and the failure then surfaced as a raw `TypeError` deep inside the first
140
- * `put()`/`search()` rather than this library's typed error at construction.
141
- *
142
- * Both methods are required: documents are embedded with `embedDocuments()`
143
- * on `put()` and queries with `embedQuery()` on `search()`.
144
- *
145
- * The keys are checked first, so `{ dims, embed }` names the misspelt `embed`
146
- * rather than the `embeddings` it displaced. `null` is refused like any other
147
- * value that is not an object, rather than read as no index; only `undefined`
148
- * means no index. `fields`, when given, must be an array of strings, the rule a
149
- * put's own `index` argument follows: a string would otherwise reach the first
150
- * put and fail there as an upstream error.
151
- */
152
- function assertUsableIndex(index) {
153
- if (index === undefined)
154
- return;
155
- (0, option_shape_1.assertShape)(index, INDEX_KEYS, 'index');
156
- (0, collaborators_1.assertMembers)(index.embeddings, collaborators_1.EMBEDDINGS_MEMBERS, 'index.embeddings');
157
- if (index.fields !== undefined)
158
- (0, primitives_1.assertStringArray)(index.fields, 'index.fields');
159
- }
160
- /**
161
- * Reject a `vectorScoreDirection` outside the declared union.
162
- *
163
- * `toRelevanceScores` (store/internal/vector-index.ts) treats anything it does
164
- * not recognise as a no-op — the only safe default, since guessing would invert
165
- * a ranking — so a mistyped
166
- * or config-file-sourced value would otherwise leave a distance backend ranked
167
- * backwards with no error and no warning anywhere. Same premise as
168
- * {@link assertUsableIndex}: a JavaScript caller can pass a string the type
169
- * never admits.
170
- */
171
- function assertScoreDirection(direction) {
172
- if (direction === undefined || vector_backend_1.VECTOR_SCORE_DIRECTIONS.includes(direction))
173
- return;
174
- throw (0, errors_1.validationError)(`vectorScoreDirection must be one of ${vector_backend_1.VECTOR_SCORE_DIRECTIONS.join(' | ')}; received ` +
175
- `${JSON.stringify(direction)}, which would be left in the backend's own direction and ` +
176
- 'could rank a distance backend backwards', 'vectorScoreDirection');
177
- }
178
- /** Both in-memory caps must be positive integers; 0 would silently return nothing. */
179
- function assertLimits(options) {
180
- if (options.maxScanItems !== undefined) {
181
- (0, primitives_1.assertInteger)(options.maxScanItems, 'maxScanItems', { min: 1, max: exports.MAX_SCAN_ITEMS });
182
- }
183
- if (options.maxSearchCandidates !== undefined) {
184
- (0, primitives_1.assertInteger)(options.maxSearchCandidates, 'maxSearchCandidates', {
185
- min: 1,
186
- max: exports.MAX_SEARCH_CANDIDATES,
187
- });
188
- }
189
- }
190
- /**
191
- * Validate the store's own options at construction; the shared ones are
192
- * `openAdapter`'s, which checks them before these.
193
- *
194
- * A `vectorBackend` without an `index` is rejected outright rather than
195
- * silently degrading: with no embeddings configured, every `put` would compute
196
- * no vector and instruct the backend to *delete* the item's entry instead of
197
- * indexing it, and `search()` would fall through to an unranked scan-order
198
- * listing with no `.score` field and no error — a semantic query returning a
199
- * normal-looking but meaningless response. `reconcileVectorIndex` already
200
- * refused this exact misconfiguration.
201
- *
202
- * Accepts: every option the store takes. The types describe the intended
203
- * shapes; this runs for the JavaScript caller the types never see, and for the
204
- * combinations no type can express — a backend without an index, an `index`
205
- * key `IndexConfig` does not declare, an `embeddings` object missing a method,
206
- * a direction outside its union.
207
- *
208
- * Returns: nothing: the value is kept under its declared type, and this
209
- * checks it.
210
- *
211
- * Throws: `VALIDATION` naming the offending option. Every failure is raised
212
- * at construction, where the fix is, rather than at the first put or search.
213
- */
214
- function assertStoreOptions(options) {
215
- assertLimits(options);
216
- if (options.vectorBackend && !options.index) {
217
- throw (0, errors_1.validationError)('vectorBackend requires a configured `index` (embeddings); without one no embedding ' +
218
- 'is computed, every put would clear the item vector, and search would silently return ' +
219
- 'unranked, score-less results', 'vectorBackend');
220
- }
221
- assertUsableIndex(options.index);
222
- assertScoreDirection(options.vectorScoreDirection);
223
- }