Skip to content

Commit

Permalink
Update SPA SDK docs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins committed May 1, 2024
1 parent bbe14b4 commit cd3eaea
Show file tree
Hide file tree
Showing 92 changed files with 355 additions and 1,142 deletions.
Binary file not shown.
Binary file removed docs/_pagefind/fragment/unknown_95b2a01.pf_fragment
Binary file not shown.
Binary file not shown.
Binary file added docs/_pagefind/fragment/unknown_c84a145.pf_fragment
Binary file not shown.
Binary file removed docs/_pagefind/fragment/unknown_d82aaa6.pf_fragment
Binary file not shown.
Binary file removed docs/_pagefind/fragment/unknown_e26468b.pf_fragment
Binary file not shown.
Binary file removed docs/_pagefind/fragment/unknown_f222b77.pf_fragment
Binary file not shown.
Binary file added docs/_pagefind/index/unknown_6c5b81a.pf_index
Binary file not shown.
Binary file removed docs/_pagefind/index/unknown_7ca4d6e.pf_index
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_pagefind/pagefind-entry.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"version":"0.12.0","languages":{"unknown":{"hash":"unknown_17946366a59bd75","wasm":null,"page_count":8}}}
{"version":"0.12.0","languages":{"unknown":{"hash":"unknown_8fb43dfc274997c","wasm":null,"page_count":7}}}
Binary file removed docs/_pagefind/pagefind.unknown_17946366a59bd75.pf_meta
Binary file not shown.
Binary file not shown.
255 changes: 149 additions & 106 deletions docs/changelog/index.html

Large diffs are not rendered by default.

14 changes: 3 additions & 11 deletions docs/getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,7 @@
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue-sdk">
Vue 2 SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue3-sdk">
Vue 3 SDK
Vue SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/migration-guide">
Expand Down Expand Up @@ -147,11 +143,7 @@ <h1>SDK Documentation Portal</h1>
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue-sdk">
Vue 2 SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue3-sdk">
Vue 3 SDK
Vue SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/migration-guide">
Expand Down Expand Up @@ -181,7 +173,7 @@ <h1 id="getting-started">Getting started</h1>
<p>The Bloomreach SPA SDKs make life considerably easier when integrating the Content Delivery APIs in your app, it also
provides automatic integration with the Bloomreach Experience Manager which is a Visual Page Builder for business users.</p>
<p>The SDKs consists of a core plain javascript/typescript SDK <code>@bloomreach/spa-sdk</code> and a set of framework specific SDKs
<code>@bloomreach/react-sdk</code>, <code>@bloomreach/vue-sdk</code>, <code>@bloomreach/vue3-sdk</code> and <code>@bloomreach/ng-sdk</code> which extend the core
<code>@bloomreach/react-sdk</code>, <code>@bloomreach/vue-sdk</code> and <code>@bloomreach/ng-sdk</code> which extend the core
SDK with the framework specific rendering logic.</p>
<p>The SPA SDK itself is written in typescript and is framework independent, it holds the core code that sets up a
connection to the Page Delivery API of the Bloomreach Content instance. When initializing it will use the provided
Expand Down
16 changes: 4 additions & 12 deletions docs/migration-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,7 @@
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue-sdk">
Vue 2 SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue3-sdk">
Vue 3 SDK
Vue SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/migration-guide" class="active">
Expand Down Expand Up @@ -147,11 +143,7 @@ <h1>SDK Documentation Portal</h1>
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue-sdk">
Vue 2 SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/vue3-sdk">
Vue 3 SDK
Vue SDK
</a>
</li><li class="nav-link">
<a href="/spa-sdk/docs/migration-guide" class="active">
Expand All @@ -174,7 +166,7 @@ <h1>SDK Documentation Portal</h1>
<div class="col-span-3 lg:col-span-2">
<article>
<div class="block lg:hidden">
<style>astro-island,astro-slot,astro-static-slot{display:contents}</style><script>(()=>{var e=async t=>{await(await t())()};(self.Astro||(self.Astro={})).load=e;window.dispatchEvent(new Event("astro:load"));})();;(()=>{var d;{let p={0:t=>u(t),1:t=>l(t),2:t=>new RegExp(t),3:t=>new Date(t),4:t=>new Map(l(t)),5:t=>new Set(l(t)),6:t=>BigInt(t),7:t=>new URL(t),8:t=>new Uint8Array(t),9:t=>new Uint16Array(t),10:t=>new Uint32Array(t)},h=t=>{let[e,n]=t;return e in p?p[e](n):void 0},l=t=>t.map(h),u=t=>typeof t!="object"||t===null?t:Object.fromEntries(Object.entries(t).map(([e,n])=>[e,h(n)]));customElements.get("astro-island")||customElements.define("astro-island",(d=class extends HTMLElement{constructor(){super(...arguments);this.hydrate=async()=>{var i;if(!this.hydrator||!this.isConnected)return;let e=(i=this.parentElement)==null?void 0:i.closest("astro-island[ssr]");if(e){e.addEventListener("astro:hydrate",this.hydrate,{once:!0});return}let n=this.querySelectorAll("astro-slot"),o={},a=this.querySelectorAll("template[data-astro-template]");for(let r of a){let s=r.closest(this.tagName);s!=null&&s.isSameNode(this)&&(o[r.getAttribute("data-astro-template")||"default"]=r.innerHTML,r.remove())}for(let r of n){let s=r.closest(this.tagName);s!=null&&s.isSameNode(this)&&(o[r.getAttribute("name")||"default"]=r.innerHTML)}let c;try{c=this.hasAttribute("props")?u(JSON.parse(this.getAttribute("props"))):{}}catch(r){let s=this.getAttribute("component-url")||"<unknown>",y=this.getAttribute("component-export");throw y&&(s+=` (export ${y})`),console.error(`[hydrate] Error parsing props for component ${s}`,this.getAttribute("props"),r),r}await this.hydrator(this)(this.Component,c,o,{client:this.getAttribute("client")}),this.removeAttribute("ssr"),this.dispatchEvent(new CustomEvent("astro:hydrate"))}}connectedCallback(){!this.hasAttribute("await-children")||this.firstChild?this.childrenConnectedCallback():new MutationObserver((e,n)=>{n.disconnect(),setTimeout(()=>this.childrenConnectedCallback(),0)}).observe(this,{childList:!0})}async childrenConnectedCallback(){let e=this.getAttribute("before-hydration-url");e&&await import(e),this.start()}start(){let e=JSON.parse(this.getAttribute("opts")),n=this.getAttribute("client");if(Astro[n]===void 0){window.addEventListener(`astro:${n}`,()=>this.start(),{once:!0});return}Astro[n](async()=>{let o=this.getAttribute("renderer-url"),[a,{default:c}]=await Promise.all([import(this.getAttribute("component-url")),o?import(o):()=>()=>{}]),i=this.getAttribute("component-export")||"default";if(!i.includes("."))this.Component=a[i];else{this.Component=a;for(let r of i.split("."))this.Component=this.Component[r]}return this.hydrator=c,this.hydrate},e,this)}attributeChangedCallback(){this.hydrate()}},d.observedAttributes=["props"],d))}})();</script><astro-island uid="ZcTNDp" prefix="r0" component-url="/spa-sdk/docs/_astro/TableOfContents.ba90f8bc.js" component-export="default" renderer-url="/spa-sdk/docs/_astro/client.2ce19805.js" props="{&quot;headings&quot;:[1,[[0,{&quot;depth&quot;:[0,1],&quot;slug&quot;:[0,&quot;migration-guide&quot;],&quot;text&quot;:[0,&quot;Migration guide&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v22&quot;],&quot;text&quot;:[0,&quot;v22&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v21&quot;],&quot;text&quot;:[0,&quot;v21&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v20-v19-v18-v17&quot;],&quot;text&quot;:[0,&quot;v20, v19, v18, v17&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v16&quot;],&quot;text&quot;:[0,&quot;v16&quot;]}]]]}" ssr="" client="load" opts="{&quot;name&quot;:&quot;TableOfContents&quot;,&quot;value&quot;:true}" await-children=""><nav class="sticky top-0"><ul class="menu"><li><h2 id="on-this-page-heading" class="menu-title"><span class="">On this page</span></h2><ul><li><a href="#v22" class="">v22</a></li><li><a href="#v21" class="">v21</a></li><li><a href="#v20-v19-v18-v17" class="">v20, v19, v18, v17</a></li><li><a href="#v16" class="">v16</a></li></ul></li></ul><div class="divider lg:hidden"></div></nav></astro-island>
<style>astro-island,astro-slot,astro-static-slot{display:contents}</style><script>(()=>{var e=async t=>{await(await t())()};(self.Astro||(self.Astro={})).load=e;window.dispatchEvent(new Event("astro:load"));})();;(()=>{var d;{let p={0:t=>u(t),1:t=>l(t),2:t=>new RegExp(t),3:t=>new Date(t),4:t=>new Map(l(t)),5:t=>new Set(l(t)),6:t=>BigInt(t),7:t=>new URL(t),8:t=>new Uint8Array(t),9:t=>new Uint16Array(t),10:t=>new Uint32Array(t)},h=t=>{let[e,n]=t;return e in p?p[e](n):void 0},l=t=>t.map(h),u=t=>typeof t!="object"||t===null?t:Object.fromEntries(Object.entries(t).map(([e,n])=>[e,h(n)]));customElements.get("astro-island")||customElements.define("astro-island",(d=class extends HTMLElement{constructor(){super(...arguments);this.hydrate=async()=>{var i;if(!this.hydrator||!this.isConnected)return;let e=(i=this.parentElement)==null?void 0:i.closest("astro-island[ssr]");if(e){e.addEventListener("astro:hydrate",this.hydrate,{once:!0});return}let n=this.querySelectorAll("astro-slot"),o={},a=this.querySelectorAll("template[data-astro-template]");for(let r of a){let s=r.closest(this.tagName);s!=null&&s.isSameNode(this)&&(o[r.getAttribute("data-astro-template")||"default"]=r.innerHTML,r.remove())}for(let r of n){let s=r.closest(this.tagName);s!=null&&s.isSameNode(this)&&(o[r.getAttribute("name")||"default"]=r.innerHTML)}let c;try{c=this.hasAttribute("props")?u(JSON.parse(this.getAttribute("props"))):{}}catch(r){let s=this.getAttribute("component-url")||"<unknown>",y=this.getAttribute("component-export");throw y&&(s+=` (export ${y})`),console.error(`[hydrate] Error parsing props for component ${s}`,this.getAttribute("props"),r),r}await this.hydrator(this)(this.Component,c,o,{client:this.getAttribute("client")}),this.removeAttribute("ssr"),this.dispatchEvent(new CustomEvent("astro:hydrate"))}}connectedCallback(){!this.hasAttribute("await-children")||this.firstChild?this.childrenConnectedCallback():new MutationObserver((e,n)=>{n.disconnect(),setTimeout(()=>this.childrenConnectedCallback(),0)}).observe(this,{childList:!0})}async childrenConnectedCallback(){let e=this.getAttribute("before-hydration-url");e&&await import(e),this.start()}start(){let e=JSON.parse(this.getAttribute("opts")),n=this.getAttribute("client");if(Astro[n]===void 0){window.addEventListener(`astro:${n}`,()=>this.start(),{once:!0});return}Astro[n](async()=>{let o=this.getAttribute("renderer-url"),[a,{default:c}]=await Promise.all([import(this.getAttribute("component-url")),o?import(o):()=>()=>{}]),i=this.getAttribute("component-export")||"default";if(!i.includes("."))this.Component=a[i];else{this.Component=a;for(let r of i.split("."))this.Component=this.Component[r]}return this.hydrator=c,this.hydrate},e,this)}attributeChangedCallback(){this.hydrate()}},d.observedAttributes=["props"],d))}})();</script><astro-island uid="1VPJ0V" prefix="r0" component-url="/spa-sdk/docs/_astro/TableOfContents.ba90f8bc.js" component-export="default" renderer-url="/spa-sdk/docs/_astro/client.2ce19805.js" props="{&quot;headings&quot;:[1,[[0,{&quot;depth&quot;:[0,1],&quot;slug&quot;:[0,&quot;migration-guide&quot;],&quot;text&quot;:[0,&quot;Migration guide&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v22&quot;],&quot;text&quot;:[0,&quot;v22&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v21&quot;],&quot;text&quot;:[0,&quot;v21&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v20-v19-v18-v17&quot;],&quot;text&quot;:[0,&quot;v20, v19, v18, v17&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v16&quot;],&quot;text&quot;:[0,&quot;v16&quot;]}]]]}" ssr="" client="load" opts="{&quot;name&quot;:&quot;TableOfContents&quot;,&quot;value&quot;:true}" await-children=""><nav class="sticky top-0"><ul class="menu"><li><h2 id="on-this-page-heading" class="menu-title"><span class="">On this page</span></h2><ul><li><a href="#v22" class="">v22</a></li><li><a href="#v21" class="">v21</a></li><li><a href="#v20-v19-v18-v17" class="">v20, v19, v18, v17</a></li><li><a href="#v16" class="">v16</a></li></ul></li></ul><div class="divider lg:hidden"></div></nav></astro-island>
</div>
<section class="prose" data-pagefind-body>
<h1 id="migration-guide">Migration guide</h1>
Expand Down Expand Up @@ -218,7 +210,7 @@ <h2 id="v16">v16</h2>
</article>
</div>
<aside class="hidden lg:block col-span-1">
<astro-island uid="ZcTNDp" prefix="r1" component-url="/spa-sdk/docs/_astro/TableOfContents.ba90f8bc.js" component-export="default" renderer-url="/spa-sdk/docs/_astro/client.2ce19805.js" props="{&quot;headings&quot;:[1,[[0,{&quot;depth&quot;:[0,1],&quot;slug&quot;:[0,&quot;migration-guide&quot;],&quot;text&quot;:[0,&quot;Migration guide&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v22&quot;],&quot;text&quot;:[0,&quot;v22&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v21&quot;],&quot;text&quot;:[0,&quot;v21&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v20-v19-v18-v17&quot;],&quot;text&quot;:[0,&quot;v20, v19, v18, v17&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v16&quot;],&quot;text&quot;:[0,&quot;v16&quot;]}]]]}" ssr="" client="load" opts="{&quot;name&quot;:&quot;TableOfContents&quot;,&quot;value&quot;:true}" await-children=""><nav class="sticky top-0"><ul class="menu"><li><h2 id="on-this-page-heading" class="menu-title"><span class="">On this page</span></h2><ul><li><a href="#v22" class="">v22</a></li><li><a href="#v21" class="">v21</a></li><li><a href="#v20-v19-v18-v17" class="">v20, v19, v18, v17</a></li><li><a href="#v16" class="">v16</a></li></ul></li></ul><div class="divider lg:hidden"></div></nav></astro-island>
<astro-island uid="1VPJ0V" prefix="r1" component-url="/spa-sdk/docs/_astro/TableOfContents.ba90f8bc.js" component-export="default" renderer-url="/spa-sdk/docs/_astro/client.2ce19805.js" props="{&quot;headings&quot;:[1,[[0,{&quot;depth&quot;:[0,1],&quot;slug&quot;:[0,&quot;migration-guide&quot;],&quot;text&quot;:[0,&quot;Migration guide&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v22&quot;],&quot;text&quot;:[0,&quot;v22&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v21&quot;],&quot;text&quot;:[0,&quot;v21&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v20-v19-v18-v17&quot;],&quot;text&quot;:[0,&quot;v20, v19, v18, v17&quot;]}],[0,{&quot;depth&quot;:[0,2],&quot;slug&quot;:[0,&quot;v16&quot;],&quot;text&quot;:[0,&quot;v16&quot;]}]]]}" ssr="" client="load" opts="{&quot;name&quot;:&quot;TableOfContents&quot;,&quot;value&quot;:true}" await-children=""><nav class="sticky top-0"><ul class="menu"><li><h2 id="on-this-page-heading" class="menu-title"><span class="">On this page</span></h2><ul><li><a href="#v22" class="">v22</a></li><li><a href="#v21" class="">v21</a></li><li><a href="#v20-v19-v18-v17" class="">v20, v19, v18, v17</a></li><li><a href="#v16" class="">v16</a></li></ul></li></ul><div class="divider lg:hidden"></div></nav></astro-island>
</aside>
</main>
</body>
Expand Down
Loading

0 comments on commit cd3eaea

Please sign in to comment.