Update SPA SDK docs for release 23.3.0

bloomreach · May 28, 2024 · 3ed59d3 · 3ed59d3
1 parent 867e40d
commit 3ed59d3
Show file tree

Hide file tree

Showing 83 changed files with 134 additions and 101 deletions.
diff --git a/docs/_pagefind/fragment/unknown_85556b5.pf_fragment b/docs/_pagefind/fragment/unknown_85556b5.pf_fragment
diff --git a/docs/_pagefind/fragment/unknown_8cdfab5.pf_fragment b/docs/_pagefind/fragment/unknown_8cdfab5.pf_fragment
diff --git a/docs/_pagefind/fragment/unknown_90e7205.pf_fragment b/docs/_pagefind/fragment/unknown_90e7205.pf_fragment
diff --git a/docs/_pagefind/fragment/unknown_fd564ae.pf_fragment b/docs/_pagefind/fragment/unknown_fd564ae.pf_fragment
diff --git a/docs/_pagefind/index/unknown_88e4b17.pf_index b/docs/_pagefind/index/unknown_88e4b17.pf_index
diff --git a/docs/_pagefind/index/unknown_d0c146d.pf_index b/docs/_pagefind/index/unknown_d0c146d.pf_index
diff --git a/docs/_pagefind/pagefind-entry.json b/docs/_pagefind/pagefind-entry.json
@@ -1 +1 @@
-{"version":"0.12.0","languages":{"unknown":{"hash":"unknown_5b97875bf053fd4","wasm":null,"page_count":7}}}
+{"version":"0.12.0","languages":{"unknown":{"hash":"unknown_b8a0337cec8d529","wasm":null,"page_count":7}}}
diff --git a/docs/_pagefind/pagefind.unknown_5b97875bf053fd4.pf_meta b/docs/_pagefind/pagefind.unknown_5b97875bf053fd4.pf_meta
diff --git a/docs/_pagefind/pagefind.unknown_b8a0337cec8d529.pf_meta b/docs/_pagefind/pagefind.unknown_b8a0337cec8d529.pf_meta
diff --git a/docs/changelog/index.html b/docs/changelog/index.html
diff --git a/docs/ng-sdk/index.html b/docs/ng-sdk/index.html
diff --git a/index.html b/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@bloomreach/spa-sdk - v23.2.0</title><meta name="description" content="Documentation for @bloomreach/spa-sdk - v23.2.0"/><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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@bloomreach/spa-sdk - v23.2.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> @bloomreach/spa-sdk - v23.2.0 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@bloomreach/spa-sdk - v23.3.0</title><meta name="description" content="Documentation for @bloomreach/spa-sdk - v23.3.0"/><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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@bloomreach/spa-sdk - v23.3.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> @bloomreach/spa-sdk - v23.3.0 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
 <a href="#bloomreach-spa-sdk" id="bloomreach-spa-sdk" style="color: inherit; text-decoration: none;">
   <h1>Bloomreach SPA SDK</h1>
 </a>

diff --git a/interfaces/express.Internals.Handler.html b/interfaces/express.Internals.Handler.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Handler | @bloomreach/spa-sdk - v23.2.0</title><meta name="description" content="Documentation for @bloomreach/spa-sdk - v23.2.0"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@bloomreach/spa-sdk - v23.2.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@bloomreach/spa-sdk - v23.2.0</a></li><li><a href="../modules/express.html">express</a></li><li><a href="../modules/express.Internals.html">Internals</a></li><li><a href="express.Internals.Handler.html">Handler</a></li></ul><h1>Interface Handler </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Handler</span><ul class="tsd-hierarchy"><li><a href="express.Internals.HandlerWithOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">HandlerWithOptions</a></li></ul></li></ul></section><section class="tsd-panel"><h3 class="tsd-before-signature">Callable</h3><ul class="tsd-signatures tsd-kind-interface tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">Handler<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="express.Internals.HandlerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">HandlerRequest</a>, response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">OutgoingMessage</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;getHeader&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;setHeader&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, next<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Handler | @bloomreach/spa-sdk - v23.3.0</title><meta name="description" content="Documentation for @bloomreach/spa-sdk - v23.3.0"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@bloomreach/spa-sdk - v23.3.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@bloomreach/spa-sdk - v23.3.0</a></li><li><a href="../modules/express.html">express</a></li><li><a href="../modules/express.Internals.html">Internals</a></li><li><a href="express.Internals.Handler.html">Handler</a></li></ul><h1>Interface Handler </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Handler</span><ul class="tsd-hierarchy"><li><a href="express.Internals.HandlerWithOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">HandlerWithOptions</a></li></ul></li></ul></section><section class="tsd-panel"><h3 class="tsd-before-signature">Callable</h3><ul class="tsd-signatures tsd-kind-interface tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">Handler<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="express.Internals.HandlerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">HandlerRequest</a>, response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">OutgoingMessage</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;getHeader&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;setHeader&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, next<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Express middleware for seamless integration with the Relevance Module.</p>
 </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>request: <a href="express.Internals.HandlerRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">HandlerRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Incoming HTTP request.</p>