@ferricstore/ferricstore 0.11.11 → 0.12.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/README.md +16 -1
- package/dist/durability-DlDCsdlo.d.cts +16 -0
- package/dist/durability-DplL0SbW.d.ts +16 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -162
- package/dist/index.d.ts +5 -162
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/internal-lEEDZpPH.d.cts +4 -0
- package/dist/internal-lEEDZpPH.d.ts +4 -0
- package/dist/langgraph.cjs +1278 -0
- package/dist/langgraph.cjs.map +1 -0
- package/dist/langgraph.d.cts +148 -0
- package/dist/langgraph.d.ts +148 -0
- package/dist/langgraph.js +1252 -0
- package/dist/langgraph.js.map +1 -0
- package/dist/openai-agents.cjs +580 -0
- package/dist/openai-agents.cjs.map +1 -0
- package/dist/openai-agents.d.cts +44 -0
- package/dist/openai-agents.d.ts +44 -0
- package/dist/openai-agents.js +555 -0
- package/dist/openai-agents.js.map +1 -0
- package/dist/outcomes-BbFDp3AH.d.ts +160 -0
- package/dist/outcomes-DmBwnq0Y.d.cts +160 -0
- package/docs/agent-frameworks.md +159 -0
- package/docs/api/assets/highlight.css +12 -12
- package/docs/api/classes/ClaimHydrationError.html +2 -2
- package/docs/api/classes/ConnectionClosedError.html +2 -2
- package/docs/api/classes/FerricStoreError.html +2 -2
- package/docs/api/classes/FlowAlreadyExistsError.html +2 -2
- package/docs/api/classes/FlowBatchError.html +2 -2
- package/docs/api/classes/FlowNotFoundError.html +2 -2
- package/docs/api/classes/FlowQueryError.html +2 -2
- package/docs/api/classes/FlowWrongStateError.html +2 -2
- package/docs/api/classes/HTTPTransportError.html +2 -2
- package/docs/api/classes/InvalidCommandError.html +2 -2
- package/docs/api/classes/LeaseRenewalError.html +2 -2
- package/docs/api/classes/LockHeldError.html +2 -2
- package/docs/api/classes/LockNotOwnedError.html +2 -2
- package/docs/api/classes/OverloadedError.html +2 -2
- package/docs/api/classes/QueueCompletionError.html +2 -2
- package/docs/api/classes/RequestTimeoutError.html +2 -2
- package/docs/api/classes/RerouteError.html +2 -2
- package/docs/api/classes/StaleLeaseError.html +2 -2
- package/docs/api/classes/StalePolicyGenerationError.html +2 -2
- package/docs/api/index.html +34 -24
- package/docs/api/media/agent-frameworks.md +159 -0
- package/docs/api/media/langgraph.ts +23 -0
- package/docs/api/media/openai-agents-session.ts +13 -0
- package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
- package/package.json +41 -2
package/README.md
CHANGED
|
@@ -16,9 +16,22 @@ npm install @ferricstore/ferricstore
|
|
|
16
16
|
|
|
17
17
|
Requires Node.js 22.22 or newer. The SDK ships ESM and CommonJS builds and is tested with Node 22, 24, and 26.
|
|
18
18
|
|
|
19
|
+
Agent framework adapters are optional:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install @ferricstore/ferricstore @langchain/langgraph @langchain/core
|
|
23
|
+
# or
|
|
24
|
+
npm install @ferricstore/ferricstore @openai/agents
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Use `@ferricstore/ferricstore/langgraph` for a LangGraph.js checkpointer,
|
|
28
|
+
long-term `BaseStore`, and FerricFlow handler bridge. Use
|
|
29
|
+
`@ferricstore/ferricstore/openai-agents` for an atomic, idempotent OpenAI
|
|
30
|
+
Agents SDK `Session`. See [docs/agent-frameworks.md](docs/agent-frameworks.md).
|
|
31
|
+
|
|
19
32
|
## Compatibility
|
|
20
33
|
|
|
21
|
-
TypeScript SDK `0.
|
|
34
|
+
TypeScript SDK `0.12.0` requires FerricStore server `0.11.4` or newer. With
|
|
22
35
|
FerricStore 0.11.11 it negotiates compact Stream mode 34 for homogeneous auto-ID
|
|
23
36
|
`XADD` pipelines and compact Pub/Sub mode 35 for homogeneous `PUBLISH`
|
|
24
37
|
pipelines. Native wire protocol v1 and the generic fallback are unchanged.
|
|
@@ -649,6 +662,8 @@ Runnable examples live in the `examples/` directory:
|
|
|
649
662
|
- [signals.ts](examples/signals.ts)
|
|
650
663
|
- [value-refs.ts](examples/value-refs.ts)
|
|
651
664
|
- [kv-store.ts](examples/kv-store.ts)
|
|
665
|
+
- [langgraph.ts](examples/langgraph.ts)
|
|
666
|
+
- [openai-agents-session.ts](examples/openai-agents-session.ts)
|
|
652
667
|
|
|
653
668
|
## Codecs
|
|
654
669
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { C as CommandArgument, a as Command } from './internal-lEEDZpPH.cjs';
|
|
2
|
+
|
|
3
|
+
interface FerricStoreCommandClient {
|
|
4
|
+
command(...args: CommandArgument[]): Promise<unknown>;
|
|
5
|
+
pipeline?(commands: readonly Command[]): Promise<unknown[]>;
|
|
6
|
+
}
|
|
7
|
+
interface FerricStoreLockOptions {
|
|
8
|
+
/** Lease duration for adapter mutation locks. Defaults to five minutes. */
|
|
9
|
+
lockTtlMs?: number;
|
|
10
|
+
/** Maximum time to wait for a contended mutation lock. Defaults to 30 seconds. */
|
|
11
|
+
lockWaitMs?: number;
|
|
12
|
+
/** Delay between lock acquisition attempts. Defaults to 10 milliseconds. */
|
|
13
|
+
lockRetryMs?: number;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export type { FerricStoreCommandClient as F, FerricStoreLockOptions as a };
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { C as CommandArgument, a as Command } from './internal-lEEDZpPH.js';
|
|
2
|
+
|
|
3
|
+
interface FerricStoreCommandClient {
|
|
4
|
+
command(...args: CommandArgument[]): Promise<unknown>;
|
|
5
|
+
pipeline?(commands: readonly Command[]): Promise<unknown[]>;
|
|
6
|
+
}
|
|
7
|
+
interface FerricStoreLockOptions {
|
|
8
|
+
/** Lease duration for adapter mutation locks. Defaults to five minutes. */
|
|
9
|
+
lockTtlMs?: number;
|
|
10
|
+
/** Maximum time to wait for a contended mutation lock. Defaults to 30 seconds. */
|
|
11
|
+
lockWaitMs?: number;
|
|
12
|
+
/** Delay between lock acquisition attempts. Defaults to 10 milliseconds. */
|
|
13
|
+
lockRetryMs?: number;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export type { FerricStoreCommandClient as F, FerricStoreLockOptions as a };
|
package/dist/index.cjs
CHANGED
|
@@ -21378,7 +21378,7 @@ var WorkflowWorker = class {
|
|
|
21378
21378
|
};
|
|
21379
21379
|
|
|
21380
21380
|
// src/version.ts
|
|
21381
|
-
var FERRICSTORE_SDK_VERSION = "0.
|
|
21381
|
+
var FERRICSTORE_SDK_VERSION = "0.12.0";
|
|
21382
21382
|
var FERRICSTORE_MINIMUM_SERVER_VERSION = "0.11.4";
|
|
21383
21383
|
var FERRICSTORE_NATIVE_PROTOCOL_VERSION = 1;
|
|
21384
21384
|
// Annotate the CommonJS export names for ESM import in node:
|