@ferricstore/ferricstore 0.5.0 → 0.5.2

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 (63) hide show
  1. package/README.md +7 -6
  2. package/dist/index.cjs +1458 -341
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +95 -10
  5. package/dist/index.d.ts +95 -10
  6. package/dist/index.js +1459 -342
  7. package/dist/index.js.map +1 -1
  8. package/docs/api/assets/hierarchy.js +1 -1
  9. package/docs/api/assets/navigation.js +1 -1
  10. package/docs/api/assets/search.js +1 -1
  11. package/docs/api/classes/ConnectionClosedError.html +1 -1
  12. package/docs/api/classes/FerricStoreError.html +1 -1
  13. package/docs/api/classes/FlowAlreadyExistsError.html +1 -1
  14. package/docs/api/classes/FlowNotFoundError.html +1 -1
  15. package/docs/api/classes/FlowWrongStateError.html +1 -1
  16. package/docs/api/classes/InvalidCommandError.html +1 -1
  17. package/docs/api/classes/LeaseRenewalError.html +1 -1
  18. package/docs/api/classes/LockHeldError.html +1 -1
  19. package/docs/api/classes/LockNotOwnedError.html +1 -1
  20. package/docs/api/classes/NativeAdapter.html +1 -1
  21. package/docs/api/classes/OverloadedError.html +1 -1
  22. package/docs/api/classes/QueueCompletionError.html +1 -1
  23. package/docs/api/classes/RequestTimeoutError.html +1 -1
  24. package/docs/api/classes/RerouteError.html +1 -1
  25. package/docs/api/classes/StaleLeaseError.html +1 -1
  26. package/docs/api/classes/StalePolicyGenerationError.html +1 -1
  27. package/docs/api/functions/projectFlowQuery.html +1 -1
  28. package/docs/api/hierarchy.html +1 -1
  29. package/docs/api/index.html +7 -6
  30. package/docs/api/interfaces/CompleteOutcome.html +1 -1
  31. package/docs/api/interfaces/FailOutcome.html +1 -1
  32. package/docs/api/interfaces/FlowEventProjectionField.html +2 -2
  33. package/docs/api/interfaces/FlowExplainCapabilities.html +5 -0
  34. package/docs/api/interfaces/FlowExplainResult.html +8 -2
  35. package/docs/api/interfaces/FlowQueryCountResult.html +1 -1
  36. package/docs/api/interfaces/FlowQueryIndex.html +11 -2
  37. package/docs/api/interfaces/FlowQueryIndexBuild.html +10 -0
  38. package/docs/api/interfaces/FlowQueryIndexCoverage.html +5 -0
  39. package/docs/api/interfaces/FlowQueryIndexField.html +5 -0
  40. package/docs/api/interfaces/FlowQueryIndexFormat.html +2 -2
  41. package/docs/api/interfaces/FlowQueryIndexProgress.html +7 -0
  42. package/docs/api/interfaces/FlowQueryIndexRegistry.html +2 -2
  43. package/docs/api/interfaces/FlowQueryIndexRetirement.html +10 -0
  44. package/docs/api/interfaces/FlowQueryIndexServices.html +6 -0
  45. package/docs/api/interfaces/FlowQueryIndexStatistics.html +11 -0
  46. package/docs/api/interfaces/FlowQueryIndexStatus.html +2 -2
  47. package/docs/api/interfaces/FlowQueryIndexValidation.html +13 -0
  48. package/docs/api/interfaces/FlowQueryQuality.html +2 -2
  49. package/docs/api/interfaces/FlowQueryRecordsResult.html +1 -1
  50. package/docs/api/interfaces/FlowRunProjectionField.html +2 -2
  51. package/docs/api/interfaces/NamedValueMutation.html +1 -1
  52. package/docs/api/interfaces/RetryOutcome.html +1 -1
  53. package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
  54. package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
  55. package/docs/api/interfaces/TransitionOutcome.html +1 -1
  56. package/docs/api/modules.html +1 -1
  57. package/docs/api/types/ConnectionRequestDisposition.html +1 -1
  58. package/docs/api/types/FlowProjectionField.html +1 -1
  59. package/docs/api/types/FlowProjectionShape.html +1 -1
  60. package/docs/api/types/FlowQueryIndexServiceState.html +1 -0
  61. package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
  62. package/docs/api/variables/FlowProjection.html +1 -1
  63. package/package.json +1 -1
package/README.md CHANGED
@@ -18,11 +18,12 @@ Requires Node.js 22.22 or newer. The SDK ships ESM and CommonJS builds and is te
18
18
 
19
19
  ## Compatibility
20
20
 
21
- SDK `0.5.x` requires FerricStore server `0.11.0` or newer. FerricStore 0.11 is a
22
- breaking beta API contract update, while the native wire protocol remains v1
23
- (`FSNP` framing and existing opcode numbers are unchanged). Capabilities and
24
- response-size limits are negotiated per connection from the HELLO-shaped
25
- startup response rather than inferred from a server version table.
21
+ SDK `0.5.x` requires FerricStore server `0.11.0` or newer and is tested against
22
+ FerricStore `0.11.3`. FerricStore 0.11 is a breaking beta API contract update,
23
+ while the native wire protocol remains v1 (`FSNP` framing and existing opcode
24
+ numbers are unchanged). Capabilities and response-size limits are negotiated
25
+ per connection from the HELLO-shaped startup response rather than inferred from
26
+ a server version table.
26
27
 
27
28
  ESM:
28
29
 
@@ -42,7 +43,7 @@ const { FerricStoreClient, JsonCodec } = require("@ferricstore/ferricstore");
42
43
  docker run -p 6388:6388 \
43
44
  -e FERRICSTORE_PROTECTED_MODE=false \
44
45
  -v ferricstore_data:/data \
45
- ghcr.io/ferricstore/ferricstore:0.11.0
46
+ ghcr.io/ferricstore/ferricstore:0.11.3
46
47
  ```
47
48
 
48
49
  ## Query durable runs