npm - @bright.global/arboretum-sdk - Versions diffs - 0.0.6 - Mend

@bright.global/arboretum-sdk 0.0.6

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

package/docs/index.html ADDED Viewed

@@ -0,0 +1,228 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@bright.global/arboretum-sdk</title><meta name="description" content="Documentation for @bright.global/arboretum-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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></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">@bright.global/arboretum-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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
+<div class="container container-main">
+<div class="col-content">
+<div class="tsd-page-title">
+<h2>@bright.global/arboretum-sdk</h2></div>
+<div class="tsd-panel tsd-typography"><h3 align="center">
+  <a href="https://gcanti.github.io/fp-ts/">
+    <img src="./logo.svg">
+  </a>
+</h3>
+<p align="center">
+Arboretum - The sitemap for contentful
+</p>
+<a id="md:introduction" class="tsd-anchor"></a><h1><a href="#md:introduction">Introduction</a></h1><p><code>@bright.global/arboretum-sdk</code> is a library for building sitemaps in <a href="https://www.contentful.com/">Contentful</a>.</p>
+<ul>
+<li><strong>Dynamic:</strong> Arboretum SDK builds sitemap dynamically based on the pages structure defined in Contentful. There are no hard-coded paths, so editors have full power over the sitemap.</li>
+<li><strong>Customizable:</strong> Content types that represent pages are configurable, so you can integrate Arboretum SDK even in existing projects.</li>
+<li><strong>Efficient:</strong> Number of requests to Contentful is minimalized.</li>
+<li><strong>Lazy:</strong> By default sitemap is built only for locales that were explicitly requested.</li>
+<li><strong>In memory:</strong> Sitemap is stored in memory, so no other dependencies (e.g. database) are required.</li>
+</ul>
+<a id="md:installation" class="tsd-anchor"></a><h1><a href="#md:installation">Installation</a></h1><p>To install the stable version:</p>
+<pre><code><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-0">add</span><span class="hl-1"> @</span><span class="hl-0">bright</span><span class="hl-1">.</span><span class="hl-0">global</span><span class="hl-1">/</span><span class="hl-0">arboretum</span><span class="hl-1">-</span><span class="hl-0">sdk</span>
+</code><button>Copy</button></pre>
+<a id="md:create-client" class="tsd-anchor"></a><h1><a href="#md:create-client">Create client</a></h1><p>Basically, there are 3 ways to create Arboretum SDK client:</p>
+<ul>
+<li>By providing required credentials by hand</li>
+</ul>
+<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createArboretumClientFromCdaParams</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@bright.global/arboretum-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> { </span><span class="hl-5">client</span><span class="hl-1">, </span><span class="hl-5">warnings</span><span class="hl-1"> } = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-6">createArboretumClientFromCdaParams</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-0">preview:</span><span class="hl-1"> </span><span class="hl-4">false</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-0">contentful:</span><span class="hl-1"> {</span><br/><span class="hl-1">      </span><span class="hl-0">space:</span><span class="hl-1"> </span><span class="hl-3">&quot;[CONTENTFUL SPACE]&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">      </span><span class="hl-0">environment:</span><span class="hl-1"> </span><span class="hl-3">&quot;[CONTENTFUL ENVIRONMENT]&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">      </span><span class="hl-0">accessToken:</span><span class="hl-1"> </span><span class="hl-3">&quot;[CONTENTFUL CDA/CPA ACCESS TOKEN]&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">      </span><span class="hl-7">// Sample page content type configuration</span><br/><span class="hl-1">      </span><span class="hl-0">options:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-0">pageContentTypes:</span><span class="hl-1"> {</span><br/><span class="hl-1">          </span><span class="hl-0">page:</span><span class="hl-1"> {</span><br/><span class="hl-1">            </span><span class="hl-0">titleFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;name&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-0">slugFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;slug&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-0">childPagesFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;childPages&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">          },</span><br/><span class="hl-1">        },</span><br/><span class="hl-1">      },</span><br/><span class="hl-1">    },</span><br/><span class="hl-1">    </span><span class="hl-7">// Client configuration options</span><br/><span class="hl-1">    </span><span class="hl-0">options:</span><span class="hl-1"> {},</span><br/><span class="hl-1">  });</span><br/><span class="hl-1">})();</span>
+</code><button>Copy</button></pre>
+<ul>
+<li>By providing contentful CDA client</li>
+</ul>
+<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createArboretumClientFromCdaClient</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@bright.global/arboretum-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createClient</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;contentful&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">contentfulClient</span><span class="hl-1"> = </span><span class="hl-6">createClient</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-0">space:</span><span class="hl-1"> </span><span class="hl-3">&quot;[CONTENTFUL SPACE]&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">environment:</span><span class="hl-1"> </span><span class="hl-3">&quot;[CONTENTFUL ENVIRONMENT]&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">accessToken:</span><span class="hl-1"> </span><span class="hl-3">&quot;[CONTENTFUL CDA/CPA ACCESS TOKEN]&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> { </span><span class="hl-5">client</span><span class="hl-1">, </span><span class="hl-5">warnings</span><span class="hl-1"> } = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-6">createArboretumClientFromCdaClient</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-0">preview:</span><span class="hl-1"> </span><span class="hl-4">false</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-0">contentful:</span><span class="hl-1"> {</span><br/><span class="hl-1">      </span><span class="hl-0">client:</span><span class="hl-1"> </span><span class="hl-0">contentfulClient</span><span class="hl-1">,</span><br/><span class="hl-1">      </span><span class="hl-7">// Sample page content type configuration</span><br/><span class="hl-1">      </span><span class="hl-0">options:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-0">pageContentTypes:</span><span class="hl-1"> {</span><br/><span class="hl-1">          </span><span class="hl-0">page:</span><span class="hl-1"> {</span><br/><span class="hl-1">            </span><span class="hl-0">titleFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;name&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-0">slugFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;slug&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-0">childPagesFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;childPages&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">          },</span><br/><span class="hl-1">        },</span><br/><span class="hl-1">      },</span><br/><span class="hl-1">    },</span><br/><span class="hl-1">    </span><span class="hl-7">// Client configuration options</span><br/><span class="hl-1">    </span><span class="hl-0">options:</span><span class="hl-1"> {},</span><br/><span class="hl-1">  });</span><br/><span class="hl-1">})();</span>
+</code><button>Copy</button></pre>
+<ul>
+<li>By providing contentful CMA client (especially useful in contentful apps)</li>
+</ul>
+<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createArboretumClientFromCma</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@bright.global/arboretum-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-0">createClient</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&quot;contentful-management&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">async</span><span class="hl-1"> () </span><span class="hl-4">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">cmaClient</span><span class="hl-1"> = </span><span class="hl-6">createClient</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-0">accessToken:</span><span class="hl-1"> </span><span class="hl-3">&quot;[CONTENTFUL CDA/CPA ACCESS TOKEN]&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  });</span><br/><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">spaceClient</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">cmaClient</span><span class="hl-1">.</span><span class="hl-6">getSpace</span><span class="hl-1">(</span><span class="hl-3">&quot;[CONTENTFUL SPACE]&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">environmentClient</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">spaceClient</span><span class="hl-1">.</span><span class="hl-6">getEnvironment</span><span class="hl-1">(</span><br/><span class="hl-1">    </span><span class="hl-3">&quot;[CONTENTFUL ENVIRONMENT]&quot;</span><br/><span class="hl-1">  );</span><br/><br/><span class="hl-1">  </span><span class="hl-4">const</span><span class="hl-1"> { </span><span class="hl-5">client</span><span class="hl-1">, </span><span class="hl-5">warnings</span><span class="hl-1"> } = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-6">createArboretumClientFromCma</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-0">preview:</span><span class="hl-1"> </span><span class="hl-4">false</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-0">contentful:</span><span class="hl-1"> {</span><br/><span class="hl-1">      </span><span class="hl-0">client:</span><span class="hl-1"> </span><span class="hl-0">environmentClient</span><span class="hl-1">,</span><br/><span class="hl-1">      </span><span class="hl-7">// Sample page content type configuration</span><br/><span class="hl-1">      </span><span class="hl-0">options:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-0">pageContentTypes:</span><span class="hl-1"> {</span><br/><span class="hl-1">          </span><span class="hl-0">page:</span><span class="hl-1"> {</span><br/><span class="hl-1">            </span><span class="hl-0">titleFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;name&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-0">slugFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;slug&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-0">childPagesFieldId:</span><span class="hl-1"> </span><span class="hl-3">&quot;childPages&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">          },</span><br/><span class="hl-1">        },</span><br/><span class="hl-1">      },</span><br/><span class="hl-1">    },</span><br/><span class="hl-1">    </span><span class="hl-7">// Client configuration options</span><br/><span class="hl-1">    </span><span class="hl-0">options:</span><span class="hl-1"> {},</span><br/><span class="hl-1">  });</span><br/><span class="hl-1">};</span>
+</code><button>Copy</button></pre>
+<p>In this step all data required to calculate sitemap is fetched and stored in internal memory. That&#39;s the only place where dynamic requests to Contentful are happening. All subsequent interactions with the Arboretum SDK client rely on the data fetched in this step.</p>
+<p>*** Important: Remember to provide valid content types configuration unique to your contentful environment and mark entry representing the home page with the tag <code>pageHome</code> (you can customize this tag using <code>homePageTagId</code> configuration). </p>
+<a id="md:client-configuration-options" class="tsd-anchor"></a><h3><a href="#md:client-configuration-options">Client configuration options</a></h3><table>
+<thead>
+<tr>
+<th></th>
+<th>Default</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td>eageryly</td>
+<td>false</td>
+<td>By default localized sitemap is generated only for locales that were explicitly requested. When set to <code>true</code> sitemap is generated for every locale in advance.</td>
+</tr>
+<tr>
+<td>data</td>
+<td></td>
+<td>You can cache data computed during previous Arboretum SDK client initialization (<code>client.cachedData</code> method) and use it to create a new client. When this parameter is defined all requests to Contentful are skipped.</td>
+</tr>
+<tr>
+<td>includeEntryStatus</td>
+<td>false</td>
+<td>Only for Arboretum SDK clients that were created based on Contentful CMA. When set to <code>true</code> page&#39;s <code>cmaOnlyStatus</code> field will be defined.</td>
+</tr>
+</tbody></table>
+<a id="md:contentful-configuration-options" class="tsd-anchor"></a><h3><a href="#md:contentful-configuration-options">Contentful configuration options</a></h3><table>
+<thead>
+<tr>
+<th>Default</th>
+<th>Default</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td>homePageTagId</td>
+<td>pageHome</td>
+<td>Sitemap root tag id</td>
+</tr>
+<tr>
+<td>pageContentTypes</td>
+<td></td>
+<td><strong>Required</strong>. Object consisting of keys that are content type id&#39;s and values described <a href="#contentful-page-content-types-configuration">here</a>. Sample value: <code>{page:{&quot;titleFieldId&quot;:&quot;name&quot;,&quot;slugFieldId&quot;:&quot;slug&quot;,&quot;childPagesFieldId&quot;:&quot;childPages&quot;}}</code></td>
+</tr>
+<tr>
+<td>redirectContentType</td>
+<td></td>
+<td>Object described <a href="#contentful-redirect-content-type-configuration">here</a>. Sample value: <code>{&quot;id&quot;:&quot;redirect&quot;,&quot;titleFieldId&quot;:&quot;name&quot;,&quot;typeFieldId&quot;:&quot;type&quot;,&quot;pageFieldId&quot;:&quot;page&quot;,&quot;pathFieldId&quot;:&quot;path&quot;}</code></td>
+</tr>
+</tbody></table>
+<a id="md:contentful-page-content-types-configuration" class="tsd-anchor"></a><h3><a href="#md:contentful-page-content-types-configuration">Contentful page content types configuration</a></h3><table>
+<thead>
+<tr>
+<th>Name</th>
+<th>Default</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td>titleFieldId</td>
+<td></td>
+<td>Id of the field that represents the page title. This field should be of type <code>Symbol</code>.</td>
+</tr>
+<tr>
+<td>slugFieldId</td>
+<td></td>
+<td><strong>Required</strong>. Id of the field that represents the page slug that should match the following regexp <code>^((\/)|(([\/\w\-\._~:!$&amp;&#39;\(\)*+,;@]|(%\d+))+))$</code>. This field should be of type  <code>Symbol</code>.</td>
+</tr>
+<tr>
+<td>childPagesFieldId</td>
+<td></td>
+<td>Id of the field that represents the references to child pages. This field should be of type <code>Array</code> and include references to other entries that were configured as pages.</td>
+</tr>
+</tbody></table>
+<a id="md:contentful-redirect-content-type-configuration" class="tsd-anchor"></a><h3><a href="#md:contentful-redirect-content-type-configuration">Contentful redirect content type configuration</a></h3><table>
+<thead>
+<tr>
+<th>Name</th>
+<th>Default</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody><tr>
+<td>id</td>
+<td></td>
+<td><strong>Required</strong>. Id of the redirect content type.</td>
+</tr>
+<tr>
+<td>titleFieldId</td>
+<td></td>
+<td>Id of the field that represents the redirect title. This field should be of type <code>Symbol</code>.</td>
+</tr>
+<tr>
+<td>typeFieldId</td>
+<td></td>
+<td><strong>Required</strong>. Id of the field that represents the redirect type (should be either <code>alias</code> or <code>redirect</code>). This field should be of type <code>Symbol</code>.</td>
+</tr>
+<tr>
+<td>pageFieldId</td>
+<td></td>
+<td><strong>Required</strong>. Id of the field that represents the page reference. This field should be of type <code>Link</code> and accept references only to entries that were configured as pages.</td>
+</tr>
+<tr>
+<td>pathFieldId</td>
+<td></td>
+<td><strong>Required</strong>. Id of the field that represents the redirect path that should match the following regexp <code>\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?$</code>. This field should be of type <code>Symbol</code>.</td>
+</tr>
+</tbody></table>
+<a id="md:basic-usage" class="tsd-anchor"></a><h1><a href="#md:basic-usage">Basic usage</a></h1><p>Most of the results returned by Arboretum SDK are wrapped by <code>Eider</code> (inspired by <a href="https://gcanti.github.io/fp-ts/modules/Either.ts">fp-ts Eider</a>) where successful responses are marked with <code>_tag</code> equal to <code>&quot;Right&quot;</code> and failed responses are marked with <code>_tag</code> equal to <code>&quot;Left&quot;</code>.</p>
+<pre><code class="language-ts"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">homePage</span><span class="hl-1"> = </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">pageByPath</span><span class="hl-1">(</span><span class="hl-3">&quot;/en&quot;</span><span class="hl-1">);</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">homePage</span><span class="hl-1">);</span><br/><span class="hl-7">/* prints </span><br/><span class="hl-7">  {</span><br/><span class="hl-7">    _tag: &#39;Right&#39;,</span><br/><span class="hl-7">    right: {</span><br/><span class="hl-7">      type: &#39;page&#39;,</span><br/><span class="hl-7">      id: &#39;ZCFBfxFPfz3iy9Rojvxva&#39;,</span><br/><span class="hl-7">      title: &#39;home&#39;,</span><br/><span class="hl-7">      localeCode: &#39;en&#39;,</span><br/><span class="hl-7">      path: &#39;/en&#39;,</span><br/><span class="hl-7">      slug: &#39;home&#39;,</span><br/><span class="hl-7">      totalDirectChildrenCount: 2</span><br/><span class="hl-7">    }</span><br/><span class="hl-7">  }</span><br/><br/><span class="hl-7">or</span><br/><br/><span class="hl-7">  { _tag: &#39;Left&#39;, left: &#39;Failed to find locale by code: en&#39; }</span><br/><span class="hl-7">  </span><br/><span class="hl-7"> */</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">blogPage</span><span class="hl-1"> = </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-6">pageById</span><span class="hl-1">(</span><span class="hl-3">&quot;en&quot;</span><span class="hl-1">, </span><span class="hl-3">&quot;4bkXR9tM8c1cGzTe7BMIgn&quot;</span><span class="hl-1">);</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">blogPage</span><span class="hl-1">);</span><br/><span class="hl-7">/* prints </span><br/><span class="hl-7">  {</span><br/><span class="hl-7">    _tag: &quot;Right&quot;,</span><br/><span class="hl-7">    right: {</span><br/><span class="hl-7">      type: &quot;page&quot;,</span><br/><span class="hl-7">      id: &quot;4bkXR9tM8c1cGzTe7BMIgn&quot;,</span><br/><span class="hl-7">      title: &quot;blog&quot;,</span><br/><span class="hl-7">      localeCode: &quot;en&quot;,</span><br/><span class="hl-7">      path: &quot;/en/blog&quot;,</span><br/><span class="hl-7">      slug: &quot;blog&quot;,</span><br/><span class="hl-7">      totalDirectChildrenCount: 2,</span><br/><span class="hl-7">    },</span><br/><span class="hl-7">  }</span><br/><br/><span class="hl-7">or</span><br/><br/><span class="hl-7">  {</span><br/><span class="hl-7">    _tag: &quot;Left&quot;,</span><br/><span class="hl-7">    left: &quot;Failed to find page by id: 4bkXR9tM8c1cGzTe7BMIgn and locale: en&quot;,</span><br/><span class="hl-7">  }</span><br/><span class="hl-7">  </span><br/><span class="hl-7"> */</span>
+</code><button>Copy</button></pre>
+<a id="md:documentation" class="tsd-anchor"></a><h1><a href="#md:documentation">Documentation</a></h1><ul>
+<li><a href="https://brightit.github.io/arboretum-sdk/">Arboretum SDK Documentation</a></li>
+</ul>
+</div></div>
+<div class="col-sidebar">
+<div class="page-menu">
+<div class="tsd-navigation settings">
+<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility">
+<h4 class="uppercase">Member Visibility</h4><form>
+<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-private" name="private"/><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>Private</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></form></div>
+<div class="tsd-theme-toggle">
+<h4 class="uppercase">Theme</h4><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-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
+<div class="tsd-accordion-details">
+<ul>
+<li>
+<ul>
+<li><a href="#md:introduction"><span>Introduction</span></a></li>
+<li><a href="#md:installation"><span>Installation</span></a></li>
+<li><a href="#md:create-client"><span>Create client</span></a></li>
+<li>
+<ul>
+<li><a href="#md:client-configuration-options"><span>Client configuration options</span></a></li>
+<li>
+<ul>
+<li><a href="#md:contentful-configuration-options"><span>Contentful configuration options</span></a></li>
+<li><a href="#md:contentful-page-content-types-configuration"><span>Contentful page content types configuration</span></a></li>
+<li><a href="#md:contentful-redirect-content-type-configuration"><span>Contentful redirect content type configuration</span></a></li></ul></li></ul></li>
+<li><a href="#md:basic-usage"><span>Basic usage</span></a></li>
+<li><a href="#md:documentation"><span>Documentation</span></a></li></ul></li></ul></div></details></div>
+<div class="site-menu">
+<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@bright.global/arboretum-<wbr/>sdk</span></a>
+<ul class="tsd-small-nested-navigation">
+<li><a href="types/ArboretumAliasT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Arboretum<wbr/>AliasT</span></a></li>
+<li><a href="types/ArboretumClientConfigFromCdaParamsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>Cda<wbr/>ParamsT</span></a></li>
+<li><a href="types/ArboretumClientConfigFromCdaT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CdaT</span></a></li>
+<li><a href="types/ArboretumClientConfigFromCmaT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CmaT</span></a></li>
+<li><a href="types/ArboretumClientConfigT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>ConfigT</span></a></li>
+<li><a href="types/ArboretumClientContentfulConfigOptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Contentful<wbr/>Config<wbr/>OptionsT</span></a></li>
+<li><a href="types/ArboretumClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Options</span></a></li>
+<li><a href="types/ArboretumClientOptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>OptionsT</span></a></li>
+<li><a href="types/ArboretumClientT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>ClientT</span></a></li>
+<li><a href="types/ArboretumPageNodeT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Page<wbr/>NodeT</span></a></li>
+<li><a href="types/ArboretumPageT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>PageT</span></a></li>
+<li><a href="types/ArboretumRedirectT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>RedirectT</span></a></li>
+<li><a href="types/CachedDataT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Cached<wbr/>DataT</span></a></li>
+<li><a href="types/Either.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Either</span></a></li>
+<li><a href="types/EitherL.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherL</span></a></li>
+<li><a href="types/EitherR.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherR</span></a></li>
+<li><a href="types/LocaleT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>LocaleT</span></a></li>
+<li><a href="types/OptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>OptionsT</span></a></li>
+<li><a href="functions/createArboretumClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Arboretum<wbr/>Client</span></a></li>
+<li><a href="functions/createArboretumClientFromCdaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Client</span></a></li>
+<li><a href="functions/createArboretumClientFromCdaParams.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Params</span></a></li>
+<li><a href="functions/createArboretumClientFromCma.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cma</span></a></li></ul></nav></div></div></div>
+<div class="tsd-generator">
+<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
+<div class="overlay"></div></body></html>

package/docs/modules.html ADDED Viewed

@@ -0,0 +1,88 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@bright.global/arboretum-sdk</title><meta name="description" content="Documentation for @bright.global/arboretum-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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></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">@bright.global/arboretum-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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
+<div class="container container-main">
+<div class="col-content">
+<div class="tsd-page-title">
+<h2>@bright.global/arboretum-sdk</h2></div>
+<section class="tsd-panel-group tsd-index-group">
+<section class="tsd-panel tsd-index-panel">
+<h3 class="tsd-index-heading uppercase">Index</h3>
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading">Type Aliases</h3>
+<div class="tsd-index-list"><a href="types/ArboretumAliasT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Arboretum<wbr/>AliasT</span></a>
+<a href="types/ArboretumClientConfigFromCdaParamsT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>Cda<wbr/>ParamsT</span></a>
+<a href="types/ArboretumClientConfigFromCdaT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CdaT</span></a>
+<a href="types/ArboretumClientConfigFromCmaT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CmaT</span></a>
+<a href="types/ArboretumClientConfigT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>ConfigT</span></a>
+<a href="types/ArboretumClientContentfulConfigOptionsT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Contentful<wbr/>Config<wbr/>OptionsT</span></a>
+<a href="types/ArboretumClientOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Options</span></a>
+<a href="types/ArboretumClientOptionsT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>OptionsT</span></a>
+<a href="types/ArboretumClientT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>ClientT</span></a>
+<a href="types/ArboretumPageNodeT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Page<wbr/>NodeT</span></a>
+<a href="types/ArboretumPageT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>PageT</span></a>
+<a href="types/ArboretumRedirectT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>RedirectT</span></a>
+<a href="types/CachedDataT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Cached<wbr/>DataT</span></a>
+<a href="types/Either.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Either</span></a>
+<a href="types/EitherL.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherL</span></a>
+<a href="types/EitherR.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherR</span></a>
+<a href="types/LocaleT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>LocaleT</span></a>
+<a href="types/OptionsT.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>OptionsT</span></a>
+</div></section>
+<section class="tsd-index-section">
+<h3 class="tsd-index-heading">Functions</h3>
+<div class="tsd-index-list"><a href="functions/createArboretumClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Arboretum<wbr/>Client</span></a>
+<a href="functions/createArboretumClientFromCdaClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Client</span></a>
+<a href="functions/createArboretumClientFromCdaParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Params</span></a>
+<a href="functions/createArboretumClientFromCma.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cma</span></a>
+</div></section></section></section></div>
+<div class="col-sidebar">
+<div class="page-menu">
+<div class="tsd-navigation settings">
+<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility">
+<h4 class="uppercase">Member Visibility</h4><form>
+<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-private" name="private"/><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>Private</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></form></div>
+<div class="tsd-theme-toggle">
+<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
+<div class="site-menu">
+<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@bright.global/arboretum-<wbr/>sdk</span></a>
+<ul class="tsd-small-nested-navigation">
+<li><a href="types/ArboretumAliasT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>AliasT</span></a></li>
+<li><a href="types/ArboretumClientConfigFromCdaParamsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>Cda<wbr/>ParamsT</span></a></li>
+<li><a href="types/ArboretumClientConfigFromCdaT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CdaT</span></a></li>
+<li><a href="types/ArboretumClientConfigFromCmaT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CmaT</span></a></li>
+<li><a href="types/ArboretumClientConfigT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>ConfigT</span></a></li>
+<li><a href="types/ArboretumClientContentfulConfigOptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Contentful<wbr/>Config<wbr/>OptionsT</span></a></li>
+<li><a href="types/ArboretumClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Options</span></a></li>
+<li><a href="types/ArboretumClientOptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>OptionsT</span></a></li>
+<li><a href="types/ArboretumClientT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>ClientT</span></a></li>
+<li><a href="types/ArboretumPageNodeT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Page<wbr/>NodeT</span></a></li>
+<li><a href="types/ArboretumPageT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>PageT</span></a></li>
+<li><a href="types/ArboretumRedirectT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>RedirectT</span></a></li>
+<li><a href="types/CachedDataT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Cached<wbr/>DataT</span></a></li>
+<li><a href="types/Either.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Either</span></a></li>
+<li><a href="types/EitherL.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherL</span></a></li>
+<li><a href="types/EitherR.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherR</span></a></li>
+<li><a href="types/LocaleT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>LocaleT</span></a></li>
+<li><a href="types/OptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>OptionsT</span></a></li>
+<li><a href="functions/createArboretumClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client</span></a></li>
+<li><a href="functions/createArboretumClientFromCdaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Client</span></a></li>
+<li><a href="functions/createArboretumClientFromCdaParams.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Params</span></a></li>
+<li><a href="functions/createArboretumClientFromCma.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cma</span></a></li></ul></nav></div></div></div>
+<div class="tsd-generator">
+<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
+<div class="overlay"></div></body></html>

package/docs/types/ArboretumAliasT.html ADDED Viewed

@@ -0,0 +1,70 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ArboretumAliasT | @bright.global/arboretum-sdk</title><meta name="description" content="Documentation for @bright.global/arboretum-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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></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">@bright.global/arboretum-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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></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">@bright.global/arboretum-sdk</a></li>
+<li><a href="ArboretumAliasT.html">ArboretumAliasT</a></li></ul>
+<h1>Type alias ArboretumAliasT</h1></div>
+<div class="tsd-signature"><span class="tsd-kind-type-alias">Arboretum<wbr/>AliasT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ArboretumPageBaseT</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">pageId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;alias&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
+<div class="tsd-type-declaration">
+<h4>Type declaration</h4>
+<ul class="tsd-parameters">
+<li class="tsd-parameter">
+<h5><span class="tsd-kind-property">page<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li>
+<li class="tsd-parameter">
+<h5><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;alias&quot;</span></h5></li></ul></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/BrightIT/arboretum-sdk/blob/09fe705/src/arboretum-client.ts#L81">arboretum-client.ts:81</a></li></ul></aside></div>
+<div class="col-sidebar">
+<div class="page-menu">
+<div class="tsd-navigation settings">
+<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility">
+<h4 class="uppercase">Member Visibility</h4><form>
+<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-private" name="private"/><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>Private</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></form></div>
+<div class="tsd-theme-toggle">
+<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
+<div class="site-menu">
+<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@bright.global/arboretum-<wbr/>sdk</span></a>
+<ul class="tsd-small-nested-navigation">
+<li><a href="ArboretumAliasT.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Arboretum<wbr/>AliasT</span></a></li>
+<li><a href="ArboretumClientConfigFromCdaParamsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>Cda<wbr/>ParamsT</span></a></li>
+<li><a href="ArboretumClientConfigFromCdaT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CdaT</span></a></li>
+<li><a href="ArboretumClientConfigFromCmaT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Config<wbr/>From<wbr/>CmaT</span></a></li>
+<li><a href="ArboretumClientConfigT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>ConfigT</span></a></li>
+<li><a href="ArboretumClientContentfulConfigOptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Contentful<wbr/>Config<wbr/>OptionsT</span></a></li>
+<li><a href="ArboretumClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>Options</span></a></li>
+<li><a href="ArboretumClientOptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Client<wbr/>OptionsT</span></a></li>
+<li><a href="ArboretumClientT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>ClientT</span></a></li>
+<li><a href="ArboretumPageNodeT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>Page<wbr/>NodeT</span></a></li>
+<li><a href="ArboretumPageT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>PageT</span></a></li>
+<li><a href="ArboretumRedirectT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Arboretum<wbr/>RedirectT</span></a></li>
+<li><a href="CachedDataT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Cached<wbr/>DataT</span></a></li>
+<li><a href="Either.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Either</span></a></li>
+<li><a href="EitherL.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherL</span></a></li>
+<li><a href="EitherR.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherR</span></a></li>
+<li><a href="LocaleT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>LocaleT</span></a></li>
+<li><a href="OptionsT.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>OptionsT</span></a></li>
+<li><a href="../functions/createArboretumClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>Arboretum<wbr/>Client</span></a></li>
+<li><a href="../functions/createArboretumClientFromCdaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Client</span></a></li>
+<li><a href="../functions/createArboretumClientFromCdaParams.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cda<wbr/>Params</span></a></li>
+<li><a href="../functions/createArboretumClientFromCma.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Arboretum<wbr/>Client<wbr/>From<wbr/>Cma</span></a></li></ul></nav></div></div></div>
+<div class="tsd-generator">
+<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
+<div class="overlay"></div></body></html>