@ferricstore/ferricstore 0.12.0 → 0.12.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 (52) hide show
  1. package/README.md +3 -0
  2. package/dist/langgraph.cjs +395 -125
  3. package/dist/langgraph.cjs.map +1 -1
  4. package/dist/langgraph.d.cts +17 -7
  5. package/dist/langgraph.d.ts +17 -7
  6. package/dist/langgraph.js +396 -126
  7. package/dist/langgraph.js.map +1 -1
  8. package/dist/openai-agents.cjs +161 -24
  9. package/dist/openai-agents.cjs.map +1 -1
  10. package/dist/openai-agents.d.cts +10 -4
  11. package/dist/openai-agents.d.ts +10 -4
  12. package/dist/openai-agents.js +161 -24
  13. package/dist/openai-agents.js.map +1 -1
  14. package/docs/agent-api/assets/hierarchy.js +1 -0
  15. package/docs/agent-api/assets/highlight.css +92 -0
  16. package/docs/agent-api/assets/icons.js +18 -0
  17. package/docs/agent-api/assets/icons.svg +1 -0
  18. package/docs/agent-api/assets/main.js +60 -0
  19. package/docs/agent-api/assets/navigation.js +1 -0
  20. package/docs/agent-api/assets/search.js +1 -0
  21. package/docs/agent-api/assets/style.css +1648 -0
  22. package/docs/agent-api/classes/langgraph.FerricStoreSaver.html +297 -0
  23. package/docs/agent-api/classes/langgraph.FerricStoreStore.html +298 -0
  24. package/docs/agent-api/classes/langgraph.LangGraphFlow.html +190 -0
  25. package/docs/agent-api/classes/langgraph.LangGraphFlowContext.html +158 -0
  26. package/docs/agent-api/classes/langgraph.LangGraphFlowRun.html +133 -0
  27. package/docs/agent-api/classes/openai-agents.FerricStoreSession.html +241 -0
  28. package/docs/agent-api/hierarchy.html +44 -0
  29. package/docs/agent-api/index.html +142 -0
  30. package/docs/agent-api/interfaces/langgraph.FerricFlowHandlerContext.html +94 -0
  31. package/docs/agent-api/interfaces/langgraph.FerricStoreCommandClient.html +77 -0
  32. package/docs/agent-api/interfaces/langgraph.FerricStoreLockOptions.html +81 -0
  33. package/docs/agent-api/interfaces/langgraph.FerricStoreSaverOptions.html +106 -0
  34. package/docs/agent-api/interfaces/langgraph.FerricStoreStoreOptions.html +98 -0
  35. package/docs/agent-api/interfaces/langgraph.InvokableLangGraph.html +83 -0
  36. package/docs/agent-api/interfaces/langgraph.LangGraphFlowOptions.html +116 -0
  37. package/docs/agent-api/interfaces/openai-agents.FerricStoreSessionOptions.html +114 -0
  38. package/docs/agent-api/interfaces/openai-agents.Session.html +208 -0
  39. package/docs/agent-api/interfaces/openai-agents.SessionHistoryRewriteAwareSession.html +230 -0
  40. package/docs/agent-api/interfaces/openai-agents.SessionHistoryTransactionAwareSession.html +237 -0
  41. package/docs/agent-api/modules/langgraph.html +44 -0
  42. package/docs/agent-api/modules/openai-agents.html +44 -0
  43. package/docs/agent-api/modules.html +35 -0
  44. package/docs/agent-api/types/langgraph.LangGraphChannelVersions.html +33 -0
  45. package/docs/agent-api/types/langgraph.LangGraphInvocationConfig.html +33 -0
  46. package/docs/agent-api/types/langgraph.LangGraphOutcomeMapper.html +50 -0
  47. package/docs/agent-api/types/langgraph.LangGraphPendingWrite.html +33 -0
  48. package/docs/agent-api/types/openai-agents.AgentInputItem.html +35 -0
  49. package/docs/agent-frameworks.md +25 -8
  50. package/docs/api/index.html +4 -1
  51. package/docs/api/media/agent-frameworks.md +25 -8
  52. package/package.json +5 -5
@@ -0,0 +1,208 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Session | @ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@ferricstore/ferricstore</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/openai-agents.html">openai-agents</a></li>
12
+ <li><a href="" aria-current="page">Session</a></li></ul>
13
+ <h1>Interface Session</h1></div>
14
+ <section class="tsd-panel tsd-comment">
15
+ <div class="tsd-comment tsd-typography"><p>Interface representing a persistent session store for conversation history.</p>
16
+ </div></section>
17
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Session</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#additems-1">addItems</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#clearsession-1">clearSession</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getitems-1">getItems</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getsessionid-1">getSessionId</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#popitem-1">popItem</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#preparehistoryitemformodelinput-1">prepareHistoryItemForModelInput</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#preparehistoryitemsforpersistencecomparison-1">prepareHistoryItemsForPersistenceComparison</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#preservereasoningitemidsforpersistence-1">preserveReasoningItemIdsForPersistence</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#replacehistorywithcompaction-1">replaceHistoryWithCompaction</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
18
+ <section class="tsd-panel tsd-hierarchy" data-refl="455">
19
+ <h4>Hierarchy (<a href="../hierarchy.html#openai-agents.Session">View Summary</a>)</h4>
20
+ <ul class="tsd-hierarchy">
21
+ <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Session</span>
22
+ <ul class="tsd-hierarchy">
23
+ <li class="tsd-hierarchy-item"><a href="openai-agents.SessionHistoryRewriteAwareSession.html" class="tsd-signature-type tsd-kind-interface">SessionHistoryRewriteAwareSession</a></li>
24
+ <li class="tsd-hierarchy-item"><a href="openai-agents.SessionHistoryTransactionAwareSession.html" class="tsd-signature-type tsd-kind-interface">SessionHistoryTransactionAwareSession</a></li></ul></li></ul></section>
25
+ <section class="tsd-panel">
26
+ <h4>Implemented by</h4>
27
+ <ul class="tsd-hierarchy">
28
+ <li><a href="../classes/openai-agents.FerricStoreSession.html" class="tsd-signature-type tsd-kind-class">FerricStoreSession</a></li></ul></section><aside class="tsd-sources">
29
+ <ul>
30
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L22">../node_modules/@openai/agents-core/dist/memory/session.d.ts:22</a></li></ul></aside>
31
+ <section class="tsd-panel-group tsd-index-group">
32
+ <section class="tsd-panel tsd-index-panel">
33
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
34
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
35
+ <div class="tsd-accordion-details">
36
+ <section class="tsd-index-section">
37
+ <h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
38
+ <div class="tsd-index-list"><a href="#additems" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Items</span></a>
39
+ <a href="#clearsession" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Session</span></a>
40
+ <a href="#getitems" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Items</span></a>
41
+ <a href="#getsessionid" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Session<wbr/>Id</span></a>
42
+ <a href="#popitem" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pop<wbr/>Item</span></a>
43
+ <a href="#preparehistoryitemformodelinput" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>History<wbr/>Item<wbr/>For<wbr/>Model<wbr/>Input?</span></a>
44
+ <a href="#preparehistoryitemsforpersistencecomparison" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>History<wbr/>Items<wbr/>For<wbr/>Persistence<wbr/>Comparison?</span></a>
45
+ <a href="#preservereasoningitemidsforpersistence" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preserve<wbr/>Reasoning<wbr/>Item<wbr/>Ids<wbr/>For<wbr/>Persistence?</span></a>
46
+ <a href="#replacehistorywithcompaction" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>replace<wbr/>History<wbr/>With<wbr/>Compaction?</span></a>
47
+ </div></section></div></details></section></section>
48
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
49
+ <h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
50
+ <section>
51
+ <section class="tsd-panel tsd-member tsd-is-external">
52
+ <h3 class="tsd-anchor-link" id="additems"><span>add<wbr/>Items</span><a href="#additems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
53
+ <ul class="tsd-signatures tsd-is-external">
54
+ <li class="tsd-is-external">
55
+ <div class="tsd-signature tsd-anchor-link" id="additems-1"><span class="tsd-kind-call-signature">addItems</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#additems-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
56
+ <div class="tsd-description">
57
+ <div class="tsd-comment tsd-typography"><p>Append new items to the conversation history.</p>
58
+ </div>
59
+ <div class="tsd-parameters">
60
+ <h4 class="tsd-parameters-title">Parameters</h4>
61
+ <ul class="tsd-parameter-list">
62
+ <li><span><span class="tsd-kind-parameter">items</span>: <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span></span>
63
+ <div class="tsd-comment tsd-typography"><p>Items to add to the session history.</p>
64
+ </div></li></ul></div>
65
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
66
+ <ul>
67
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L61">../node_modules/@openai/agents-core/dist/memory/session.d.ts:61</a></li></ul></aside></div></li></ul></section>
68
+ <section class="tsd-panel tsd-member tsd-is-external">
69
+ <h3 class="tsd-anchor-link" id="clearsession"><span>clear<wbr/>Session</span><a href="#clearsession" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
70
+ <ul class="tsd-signatures tsd-is-external">
71
+ <li class="tsd-is-external">
72
+ <div class="tsd-signature tsd-anchor-link" id="clearsession-1"><span class="tsd-kind-call-signature">clearSession</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#clearsession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
73
+ <div class="tsd-description">
74
+ <div class="tsd-comment tsd-typography"><p>Remove all items that belong to the session and reset its state.</p>
75
+ </div>
76
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
77
+ <ul>
78
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L79">../node_modules/@openai/agents-core/dist/memory/session.d.ts:79</a></li></ul></aside></div></li></ul></section>
79
+ <section class="tsd-panel tsd-member tsd-is-external">
80
+ <h3 class="tsd-anchor-link" id="getitems"><span>get<wbr/>Items</span><a href="#getitems" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
81
+ <ul class="tsd-signatures tsd-is-external">
82
+ <li class="tsd-is-external">
83
+ <div class="tsd-signature tsd-anchor-link" id="getitems-1"><span class="tsd-kind-call-signature">getItems</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#getitems-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
84
+ <div class="tsd-description">
85
+ <div class="tsd-comment tsd-typography"><p>Retrieve items from the conversation history.</p>
86
+ </div>
87
+ <div class="tsd-parameters">
88
+ <h4 class="tsd-parameters-title">Parameters</h4>
89
+ <ul class="tsd-parameter-list">
90
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></span>
91
+ <div class="tsd-comment tsd-typography"><p>The maximum number of items to return. When provided the most
92
+ recent <a href="#getitems-1" class="tsd-kind-parameter">limit</a> items should be returned in chronological order.</p>
93
+ </div></li></ul></div>
94
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
95
+ <ul>
96
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L33">../node_modules/@openai/agents-core/dist/memory/session.d.ts:33</a></li></ul></aside></div></li></ul></section>
97
+ <section class="tsd-panel tsd-member tsd-is-external">
98
+ <h3 class="tsd-anchor-link" id="getsessionid"><span>get<wbr/>Session<wbr/>Id</span><a href="#getsessionid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
99
+ <ul class="tsd-signatures tsd-is-external">
100
+ <li class="tsd-is-external">
101
+ <div class="tsd-signature tsd-anchor-link" id="getsessionid-1"><span class="tsd-kind-call-signature">getSessionId</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getsessionid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
102
+ <div class="tsd-description">
103
+ <div class="tsd-comment tsd-typography"><p>Ensure and return the identifier for this session.</p>
104
+ </div>
105
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
106
+ <ul>
107
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L26">../node_modules/@openai/agents-core/dist/memory/session.d.ts:26</a></li></ul></aside></div></li></ul></section>
108
+ <section class="tsd-panel tsd-member tsd-is-external">
109
+ <h3 class="tsd-anchor-link" id="popitem"><span>pop<wbr/>Item</span><a href="#popitem" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
110
+ <ul class="tsd-signatures tsd-is-external">
111
+ <li class="tsd-is-external">
112
+ <div class="tsd-signature tsd-anchor-link" id="popitem-1"><span class="tsd-kind-call-signature">popItem</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#popitem-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
113
+ <div class="tsd-description">
114
+ <div class="tsd-comment tsd-typography"><p>Remove and return the most recent item from the conversation history if it
115
+ exists.</p>
116
+ </div>
117
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
118
+ <ul>
119
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L75">../node_modules/@openai/agents-core/dist/memory/session.d.ts:75</a></li></ul></aside></div></li></ul></section>
120
+ <section class="tsd-panel tsd-member tsd-is-external">
121
+ <h3 class="tsd-anchor-link" id="preparehistoryitemformodelinput"><code class="tsd-tag">Optional</code><span>prepare<wbr/>History<wbr/>Item<wbr/>For<wbr/>Model<wbr/>Input</span><a href="#preparehistoryitemformodelinput" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
122
+ <ul class="tsd-signatures tsd-is-external">
123
+ <li class="tsd-is-external">
124
+ <div class="tsd-signature tsd-anchor-link" id="preparehistoryitemformodelinput-1"><span class="tsd-kind-call-signature">prepareHistoryItemForModelInput</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><a href="#preparehistoryitemformodelinput-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
125
+ <div class="tsd-description">
126
+ <div class="tsd-comment tsd-typography"><p>Optionally rewrite a stored history item before it is sent back to the model.</p>
127
+ <p>Session implementations can use this to strip provider-managed replay metadata while
128
+ preserving their public <code>getItems()</code> shape for UI and deletion workflows.</p>
129
+ </div>
130
+ <div class="tsd-parameters">
131
+ <h4 class="tsd-parameters-title">Parameters</h4>
132
+ <ul class="tsd-parameter-list">
133
+ <li><span><span class="tsd-kind-parameter">item</span>: <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a></span></li></ul></div>
134
+ <h4 class="tsd-returns-title">Returns <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a></h4><aside class="tsd-sources">
135
+ <ul>
136
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L40">../node_modules/@openai/agents-core/dist/memory/session.d.ts:40</a></li></ul></aside></div></li></ul></section>
137
+ <section class="tsd-panel tsd-member tsd-is-external">
138
+ <h3 class="tsd-anchor-link" id="preparehistoryitemsforpersistencecomparison"><code class="tsd-tag">Optional</code><span>prepare<wbr/>History<wbr/>Items<wbr/>For<wbr/>Persistence<wbr/>Comparison</span><a href="#preparehistoryitemsforpersistencecomparison" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
139
+ <ul class="tsd-signatures tsd-is-external">
140
+ <li class="tsd-is-external">
141
+ <div class="tsd-signature tsd-anchor-link" id="preparehistoryitemsforpersistencecomparison-1"><span class="tsd-kind-call-signature">prepareHistoryItemsForPersistenceComparison</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><a href="#preparehistoryitemsforpersistencecomparison-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
142
+ <div class="tsd-description">
143
+ <div class="tsd-comment tsd-typography"><p>Optionally normalize stored and expected history before persistence reconciliation compares
144
+ them.</p>
145
+ <p>Session implementations can use this to remove backend-assigned metadata while preserving
146
+ their public <code>getItems()</code> shape.</p>
147
+ </div>
148
+ <div class="tsd-parameters">
149
+ <h4 class="tsd-parameters-title">Parameters</h4>
150
+ <ul class="tsd-parameter-list">
151
+ <li><span><span class="tsd-kind-parameter">items</span>: <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
152
+ <h4 class="tsd-returns-title">Returns <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
153
+ <ul>
154
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L48">../node_modules/@openai/agents-core/dist/memory/session.d.ts:48</a></li></ul></aside></div></li></ul></section>
155
+ <section class="tsd-panel tsd-member tsd-is-external">
156
+ <h3 class="tsd-anchor-link" id="preservereasoningitemidsforpersistence"><code class="tsd-tag">Optional</code><span>preserve<wbr/>Reasoning<wbr/>Item<wbr/>Ids<wbr/>For<wbr/>Persistence</span><a href="#preservereasoningitemidsforpersistence" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
157
+ <ul class="tsd-signatures tsd-is-external">
158
+ <li class="tsd-is-external">
159
+ <div class="tsd-signature tsd-anchor-link" id="preservereasoningitemidsforpersistence-1"><span class="tsd-kind-call-signature">preserveReasoningItemIdsForPersistence</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#preservereasoningitemidsforpersistence-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
160
+ <div class="tsd-description">
161
+ <div class="tsd-comment tsd-typography"><p>Optionally preserve reasoning item IDs when persisting generated output.</p>
162
+ <p>Some remote session stores require provider-assigned reasoning identities to accept stored
163
+ reasoning items, even when model replay should omit those IDs.</p>
164
+ </div>
165
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
166
+ <ul>
167
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L55">../node_modules/@openai/agents-core/dist/memory/session.d.ts:55</a></li></ul></aside></div></li></ul></section>
168
+ <section class="tsd-panel tsd-member tsd-is-external">
169
+ <h3 class="tsd-anchor-link" id="replacehistorywithcompaction"><code class="tsd-tag">Optional</code><span>replace<wbr/>History<wbr/>With<wbr/>Compaction</span><a href="#replacehistorywithcompaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
170
+ <ul class="tsd-signatures tsd-is-external">
171
+ <li class="tsd-is-external">
172
+ <div class="tsd-signature tsd-anchor-link" id="replacehistorywithcompaction-1"><span class="tsd-kind-call-signature">replaceHistoryWithCompaction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#replacehistorywithcompaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
173
+ <div class="tsd-description">
174
+ <div class="tsd-comment tsd-typography"><p>Optionally replace the logical session history with a compaction marker and its retained
175
+ suffix without resetting the session identity.</p>
176
+ <p>Implementations may append the replacement when their backend treats the leading compaction
177
+ item as the authoritative replay boundary. If this method is absent, the runner falls back to
178
+ clearing and rebuilding the session with rollback protection.</p>
179
+ </div>
180
+ <div class="tsd-parameters">
181
+ <h4 class="tsd-parameters-title">Parameters</h4>
182
+ <ul class="tsd-parameter-list">
183
+ <li><span><span class="tsd-kind-parameter">items</span>: <a href="../types/openai-agents.AgentInputItem.html" class="tsd-signature-type tsd-kind-type-alias">AgentInputItem</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
184
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
185
+ <ul>
186
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@openai/agents-core/dist/memory/session.d.ts#L70">../node_modules/@openai/agents-core/dist/memory/session.d.ts:70</a></li></ul></aside></div></li></ul></section></section></details></div>
187
+ <div class="col-sidebar">
188
+ <div class="page-menu">
189
+ <div class="tsd-navigation settings">
190
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
191
+ <h3>Settings</h3></summary>
192
+ <div class="tsd-accordion-details">
193
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
194
+ <ul id="tsd-filter-options">
195
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
196
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
197
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
198
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
199
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
200
+ <h3>On This Page</h3></summary>
201
+ <div class="tsd-accordion-details">
202
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
203
+ <div><a href="#additems" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Items</span></a><a href="#clearsession" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Session</span></a><a href="#getitems" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Items</span></a><a href="#getsessionid" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Session<wbr/>Id</span></a><a href="#popitem" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pop<wbr/>Item</span></a><a href="#preparehistoryitemformodelinput" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>History<wbr/>Item<wbr/>For<wbr/>Model<wbr/>Input</span></a><a href="#preparehistoryitemsforpersistencecomparison" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prepare<wbr/>History<wbr/>Items<wbr/>For<wbr/>Persistence<wbr/>Comparison</span></a><a href="#preservereasoningitemidsforpersistence" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preserve<wbr/>Reasoning<wbr/>Item<wbr/>Ids<wbr/>For<wbr/>Persistence</span></a><a href="#replacehistorywithcompaction" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>replace<wbr/>History<wbr/>With<wbr/>Compaction</span></a></div></details></div></details></div>
204
+ <div class="site-menu">
205
+ <nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
206
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
207
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
208
+ <div class="overlay"></div></body></html>