npm - @oobe-protocol-labs/synapse-client-sdk - Versions diffs - 1.0.8 → 1.2.1 - Mend

@oobe-protocol-labs/synapse-client-sdk 1.0.8 → 1.2.1

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 (713) hide show

package/dist/docs/interfaces/WsConfig.html CHANGED Viewed

@@ -1,13 +1,13 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WsConfig | @oobe-protocol-labs/synapse-client-sdk</title><meta name="description" content="Documentation for @oobe-protocol-labs/synapse-client-sdk"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@oobe-protocol-labs/synapse-client-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@oobe-protocol-labs/synapse-client-sdk</a></li><li><a href="WsConfig.html">WsConfig</a></li></ul><h1>Interface WsConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Configuration for the WebSocket client.</p>
 </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Since"><h4 class="tsd-anchor-link"><a id="Since" class="tsd-anchor"></a>Since<a href="#Since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.0</p>
-</div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WsConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#autoReconnect">autoReconnect</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#endpoint">endpoint</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#maxReconnectAttempts">maxReconnectAttempts</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#pingIntervalMs">pingIntervalMs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#reconnectIntervalMs">reconnectIntervalMs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/9d2139155367d895f8ac996ac51e6663e11b63e8/src/websocket/types.ts#L19">packages/synapse-client-sdk/src/websocket/types.ts:19</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="WsConfig.html#autoReconnect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Reconnect?</span></a>
+</div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WsConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#autoReconnect">autoReconnect</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#endpoint">endpoint</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#maxReconnectAttempts">maxReconnectAttempts</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#pingIntervalMs">pingIntervalMs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WsConfig.html#reconnectIntervalMs">reconnectIntervalMs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/e968e2726c8e5db462f27e418f616ac8a808e66e/src/websocket/types.ts#L19">packages/synapse-client-sdk/src/websocket/types.ts:19</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="WsConfig.html#autoReconnect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Reconnect?</span></a>
 <a href="WsConfig.html#endpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>endpoint</span></a>
 <a href="WsConfig.html#maxReconnectAttempts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Reconnect<wbr/>Attempts?</span></a>
 <a href="WsConfig.html#pingIntervalMs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ping<wbr/>Interval<wbr/>Ms?</span></a>
 <a href="WsConfig.html#reconnectIntervalMs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reconnect<wbr/>Interval<wbr/>Ms?</span></a>
 </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="autoReconnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>auto<wbr/>Reconnect</span><a href="#autoReconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Reconnect</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Auto-reconnect on disconnect (default <code>true</code>).</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/9d2139155367d895f8ac996ac51e6663e11b63e8/src/websocket/types.ts#L23">packages/synapse-client-sdk/src/websocket/types.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="endpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>endpoint</span><a href="#endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">endpoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>WebSocket endpoint URL (<code>wss://…</code>).</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/9d2139155367d895f8ac996ac51e6663e11b63e8/src/websocket/types.ts#L21">packages/synapse-client-sdk/src/websocket/types.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maxReconnectAttempts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>max<wbr/>Reconnect<wbr/>Attempts</span><a href="#maxReconnectAttempts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Reconnect<wbr/>Attempts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Maximum reconnect attempts before giving up (default <code>20</code>).</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/9d2139155367d895f8ac996ac51e6663e11b63e8/src/websocket/types.ts#L27">packages/synapse-client-sdk/src/websocket/types.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pingIntervalMs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ping<wbr/>Interval<wbr/>Ms</span><a href="#pingIntervalMs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ping<wbr/>Interval<wbr/>Ms</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Ping interval to keep the connection alive in ms (default <code>30 000</code>).</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/9d2139155367d895f8ac996ac51e6663e11b63e8/src/websocket/types.ts#L29">packages/synapse-client-sdk/src/websocket/types.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="reconnectIntervalMs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>reconnect<wbr/>Interval<wbr/>Ms</span><a href="#reconnectIntervalMs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">reconnect<wbr/>Interval<wbr/>Ms</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Delay between reconnect attempts in ms (default <code>2000</code>).</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/9d2139155367d895f8ac996ac51e6663e11b63e8/src/websocket/types.ts#L25">packages/synapse-client-sdk/src/websocket/types.ts:25</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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><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><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><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><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#autoReconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Reconnect</span></a><a href="#endpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>endpoint</span></a><a href="#maxReconnectAttempts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Reconnect<wbr/>Attempts</span></a><a href="#pingIntervalMs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ping<wbr/>Interval<wbr/>Ms</span></a><a href="#reconnectIntervalMs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reconnect<wbr/>Interval<wbr/>Ms</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@oobe-protocol-labs/synapse-client-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/e968e2726c8e5db462f27e418f616ac8a808e66e/src/websocket/types.ts#L23">packages/synapse-client-sdk/src/websocket/types.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="endpoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>endpoint</span><a href="#endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">endpoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>WebSocket endpoint URL (<code>wss://…</code>).</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/e968e2726c8e5db462f27e418f616ac8a808e66e/src/websocket/types.ts#L21">packages/synapse-client-sdk/src/websocket/types.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maxReconnectAttempts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>max<wbr/>Reconnect<wbr/>Attempts</span><a href="#maxReconnectAttempts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Reconnect<wbr/>Attempts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Maximum reconnect attempts before giving up (default <code>20</code>).</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/e968e2726c8e5db462f27e418f616ac8a808e66e/src/websocket/types.ts#L27">packages/synapse-client-sdk/src/websocket/types.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pingIntervalMs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ping<wbr/>Interval<wbr/>Ms</span><a href="#pingIntervalMs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ping<wbr/>Interval<wbr/>Ms</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Ping interval to keep the connection alive in ms (default <code>30 000</code>).</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/e968e2726c8e5db462f27e418f616ac8a808e66e/src/websocket/types.ts#L29">packages/synapse-client-sdk/src/websocket/types.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="reconnectIntervalMs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>reconnect<wbr/>Interval<wbr/>Ms</span><a href="#reconnectIntervalMs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">reconnect<wbr/>Interval<wbr/>Ms</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Delay between reconnect attempts in ms (default <code>2000</code>).</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OOBE-PROTOCOL/synapse-client-sdk/blob/e968e2726c8e5db462f27e418f616ac8a808e66e/src/websocket/types.ts#L25">packages/synapse-client-sdk/src/websocket/types.ts:25</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><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><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><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><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><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#autoReconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Reconnect</span></a><a href="#endpoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>endpoint</span></a><a href="#maxReconnectAttempts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Reconnect<wbr/>Attempts</span></a><a href="#pingIntervalMs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ping<wbr/>Interval<wbr/>Ms</span></a><a href="#reconnectIntervalMs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reconnect<wbr/>Interval<wbr/>Ms</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@oobe-protocol-labs/synapse-client-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/dist/docs/media/CHANGELOG.md CHANGED Viewed

@@ -7,6 +7,142 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ---
+## [1.2.1] — 2025-07-22
+### Fixed
+- **DAS API: named params instead of positional arrays** — All 11 DAS (Metaplex Read API) methods
+  now send JSON-RPC 2.0 **named parameters** (`{ id: "..." }`) instead of wrapping them in a
+  positional array (`[{ id: "..." }]`). This was the root cause of 7 Metaplex AI tools returning
+  empty/default results: the gateway correctly expected named params per the DAS spec, but the SDK
+  was sending array-wrapped params that were silently dropped.
+  Affected methods: `getAsset`, `getAssetProof`, `getAssetBatch`, `getAssetProofBatch`,
+  `getAssetsByOwner`, `getAssetsByGroup`, `getAssetsByCreator`, `getAssetsByAuthority`,
+  `searchAssets`, `getSignaturesForAsset`, `getTokenAccounts`.
+- **`RpcRequest.params` type widened** — Changed from `unknown[]` to
+  `unknown[] | Record<string, unknown>` to support both positional params (standard Solana RPC)
+  and named params (DAS / Read API).
+- **`HttpTransport.request()` signature updated** — The `params` argument now accepts
+  `unknown[] | Record<string, unknown>` to match the widened `RpcRequest` type.
+- **Metaplex AI executor simplified** — Removed special-casing for `getAsset`, `getAssetProof`,
+  `getAssets`, and `getAssetProofs` in the Metaplex executor; all DAS tools now use a unified
+  named-params code path.
+- **`resolveCollection` executor** — Updated internal `getAsset` and `getAssetsByGroup` calls
+  to use named params.
+### Known Issues (Gateway-side)
+The following failures are **not SDK bugs** — they require server-side fixes on the Synapse gateway:
+- **4 DAS methods not implemented in gateway**: `getAssetBatch`, `getAssetProofBatch`,
+  `getSignaturesForAsset`, `getTokenAccounts` — the SDK sends correct requests, but the gateway
+  does not yet route these methods.
+- **6 Raydium REST tools return 500**: The gateway proxy to `api-v3.raydium.io` returns HTTP 500
+  for certain endpoints. Direct calls to Raydium's API succeed.
+- **`getAccountInfo` blocked by gateway**: 3 on-chain tools (Jupiter/Raydium) fail because the
+  gateway RPC endpoint does not allow `getAccountInfo`.
+- **`getProgramAccounts` returns 502**: 5 on-chain tools fail with 502 Bad Gateway when calling
+  `getProgramAccounts` through the gateway.
+---
+## [1.2.0] — 2026-02-28
+### Added
+- **Context Provider System** (`src/context/`) — Full IoC (Inversion of Control) container with
+  dependency injection, scoping, and framework-agnostic hooks. Enables components to access SDK
+  services (RPC, DAS, WebSocket, Programs, AI Tools) through a unified context.
+  - `SynapseContext` — Core container with `register()`, `resolve()`, `has()`, `createScope()`,
+    `dispose()`, interceptor middleware, and event bus.
+  - `createSynapseContext(config, opts?)` — Factory that auto-wires all SDK services into the
+    container with pre-defined tokens.
+  - `Tokens` namespace — Pre-defined `ServiceToken<T>` for every SDK module: `RPC`, `DAS`, `WS`,
+    `GRPC`, `TRANSPORT`, `CLIENT`, `ACCOUNTS`, `PROGRAMS`, `DECODERS`, `KIT_RPC`, `KIT_SUBS`.
+  - 6 service lifecycles: `singleton`, `transient`, `scoped`, `value`, `alias`, `asyncFactory`.
+  - 5 provider types: `ValueProvider`, `FactoryProvider`, `ClassProvider`, `AliasProvider`,
+    `AsyncFactoryProvider`.
+  - `createToken<T>(name)` — Type-safe branded token factory.
+  - Error classes: `ServiceNotFoundError`, `CircularDependencyError`, `AsyncProviderError`.
+  - Module system: `ContextModule` interface for registering plugin bundles.
+- **Memory-Safe References** (`src/context/refs.ts`) — Reference-counted cross-component service
+  sharing with automatic cleanup. Designed for SDK-grade memory safety.
+  - `ServiceRef<T>` — Strong reference with `acquire()` / `release()` lifecycle, `RefReleasedError`
+    on use-after-free.
+  - `WeakServiceRef<T>` — WeakRef-backed reference that degrades gracefully on GC.
+  - `RefRegistry` — Central registry tracking all live refs with configurable leak detection.
+  - `MemoryGuard` — Background sweep that detects leaked refs and logs/throws diagnostics.
+  - `ServiceBinding<A, B>` — Couples two services with synchronized disposal.
+  - Container integration: `ctx.acquireRef(token)`, `ctx.bind(tokenA, tokenB)`,
+    `ctx.refCount(token)`, `ctx.enableMemoryGuard(config)`.
+- **Context Hooks** (`src/context/hooks.ts`) — Framework-agnostic service accessors and adapters.
+  - `setGlobalContext()` / `getContext()` / `tryGetContext()` — Global context management.
+  - `useService(token)` / `tryUseService(token)` — Service resolution from global context.
+  - `createServiceHook(token)` / `createBoundHook(token)` — Composable typed accessor factories.
+  - `useSharedRef(token)` / `withRef(token, fn)` / `withRefAsync(token, fn)` — Safe scoped
+    reference access with automatic release.
+  - `createRefHook(token)` — Creates a reusable ref-acquiring hook for a given token.
+  - `useBoundServices(tokenA, tokenB)` — Acquire two bound services atomically.
+  - `autoWire(ctx)` — Proxy-based lazy service bag for zero-boilerplate access.
+  - `createReactAdapter(config)` — React integration blueprint (Provider, useX hooks).
+  - `createServerMiddleware(config)` — Express/Fastify request-scoped DI middleware.
+- **`SynapseClientLike` interface** (`src/core/client.ts`) — Minimal structural interface
+  (`{ readonly transport: HttpTransport }`) that all protocol tool factories now accept.
+  Eliminates the need for `as any` casts when consumer SDK versions differ. Both the full
+  `SynapseClient` class and a plain `{ transport }` object satisfy this interface.
+- **Jupiter `smartSwap` compound tool** — All-in-one tool that chains `getQuote` → `swapInstructions`
+  in a single AI agent call. Accepts human-readable params (`inputMint`, `outputMint`, `amount`,
+  `userPublicKey`, `slippageBps`, etc.) and returns `{ quote, instructions, summary }` with a
+  structured summary including route hops, instruction count, price impact, and lookup table count.
+  Jupiter tool count: 21 → **22**.
+- **Individual program subpath exports** — Each instruction encoder can now be imported via
+  fine-grained sub-paths for tree-shaking:
+  `./programs/system`, `./programs/spl-token`, `./programs/associated-token`,
+  `./programs/memo`, `./programs/compute-budget`, `./programs/types`.
+- **`createSolanaProgramsTools` re-exported** from `./ai` and `./ai/tools` barrels, alongside
+  `solanaProgramsMethods`, `solanaProgramsMethodNames`, and `SolanaProgramsToolsConfig`.
+### Fixed
+- **Breaking type change in `createMetaplexTools`** — The function previously required the full
+  `SynapseClient` class (which gained an `accounts` getter in v1.0.3), forcing consumers on
+  older versions to use `as any` casts. Now accepts `SynapseClientLike` — any object with a
+  `transport` property.
+- **Same type coupling in 5 other factories** — `createJupiterOnchainTools`,
+  `createRaydiumOnchainTools`, `createProtocolTools`, `createExecutableSolanaTools`, and
+  `AgentGateway` / `createAgentGateway` all migrated from `SynapseClient` to `SynapseClientLike`.
+  Zero `client: SynapseClient` parameter types remain in the SDK public API.
+- **Stale JSDoc `@param` tags** — All `@param {SynapseClient}` annotations updated to
+  `@param {SynapseClientLike}` across 6 files.
+- **Missing barrel exports** — `createSolanaProgramsTools`, `solanaProgramsMethods`,
+  `solanaProgramsMethodNames`, and `SolanaProgramsToolsConfig` were exported from
+  `./ai/tools/protocols` but not re-exported from `./ai/tools` or `./ai`. Now available
+  at all barrel levels.
+- **Minor formatting** — Fixed missing whitespace before `createSynapse` factory in main barrel.
+### Changed
+- `SynapseClient` now `implements SynapseClientLike`.
+- Jupiter tool count: **21 → 22** (added `smartSwap` compound tool).
+- Total protocol tools: **69 → 70** (22 Jupiter + 16 Raydium + 12 Metaplex + 10 Jupiter
+  On-Chain + 10 Raydium On-Chain).
+- Total protocol tools including Solana Programs: **86** (70 protocol + 16 native programs).
+- Context module tagged `@since 1.2.0`.
+- Test suite: **655 tests** across 14 test files, all passing (77 context + 78 refs + 6 smartSwap
+  + 494 existing).
+---
 ## [1.0.8] — 2026-02-27
 ### Fixed
@@ -289,6 +425,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ---
+[1.2.0]: https://github.com/oobe-protocol-labs/synapse-client-sdk/compare/v1.0.8...v1.2.0
 [1.0.8]: https://github.com/oobe-protocol-labs/synapse-client-sdk/compare/v1.0.7...v1.0.8
 [1.0.7]: https://github.com/oobe-protocol-labs/synapse-client-sdk/compare/v1.0.6...v1.0.7
 [1.0.6]: https://github.com/oobe-protocol-labs/synapse-client-sdk/compare/v1.0.5...v1.0.6