@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
  1. package/README.md +223 -0
  2. package/dist/arboretum-client.js +2 -0
  3. package/dist/clients/contentful-client/contentful-client.js +2 -0
  4. package/dist/clients/contentful-client/impl/contentful-client-impl.js +54 -0
  5. package/dist/es6/arboretum-client.js +1 -0
  6. package/dist/es6/clients/contentful-client/contentful-client.js +1 -0
  7. package/dist/es6/clients/contentful-client/impl/contentful-client-impl.js +50 -0
  8. package/dist/es6/impl/arboretum-client.impl.js +182 -0
  9. package/dist/es6/impl/data/content-types.js +136 -0
  10. package/dist/es6/impl/data/helpers/__mocks__/mocked-contentful-entries-client-api.js +66 -0
  11. package/dist/es6/impl/data/helpers/entry-status.js +19 -0
  12. package/dist/es6/impl/data/helpers/get-all-entries-recursively.js +113 -0
  13. package/dist/es6/impl/data/helpers/get-all-entries-recursively.test.js +114 -0
  14. package/dist/es6/impl/data/helpers/home-pages-by-tag-id.js +66 -0
  15. package/dist/es6/impl/data/helpers/home-pages-by-tag-id.test.js +105 -0
  16. package/dist/es6/impl/data/helpers/locale-codes-from-metadata.js +7 -0
  17. package/dist/es6/impl/data/helpers/locale-codes-from-metadata.test.js +52 -0
  18. package/dist/es6/impl/data/helpers/parse-locale-tag.js +24 -0
  19. package/dist/es6/impl/data/helpers/parse-locale-tag.test.js +19 -0
  20. package/dist/es6/impl/data/helpers/validate-content-types.js +112 -0
  21. package/dist/es6/impl/data/helpers/validate-content-types.test.js +103 -0
  22. package/dist/es6/impl/data/home-page.js +75 -0
  23. package/dist/es6/impl/data/locales.js +60 -0
  24. package/dist/es6/impl/data/page-entries.js +169 -0
  25. package/dist/es6/impl/data/page-entries.test.js +170 -0
  26. package/dist/es6/impl/data/redirect-entries.js +163 -0
  27. package/dist/es6/impl/data/sitemap-data.js +109 -0
  28. package/dist/es6/impl/sitemap/adapters/page-entry-adapter.js +27 -0
  29. package/dist/es6/impl/sitemap/adapters/redirect-entry-adapter.js +26 -0
  30. package/dist/es6/impl/sitemap/adapters/redirect-to-arboretum-page-adapter.js +11 -0
  31. package/dist/es6/impl/sitemap/adapters/to-arboretum-page-adapter.js +14 -0
  32. package/dist/es6/impl/sitemap/adapters/to-arboretum-page-adapter.test.js +100 -0
  33. package/dist/es6/impl/sitemap/adapters/to-arboretum-page-with-missing-data-adapter.js +16 -0
  34. package/dist/es6/impl/sitemap/helpers/__mocks__/mocked-localized-sitemap.js +186 -0
  35. package/dist/es6/impl/sitemap/helpers/build-localized-sitemap.js +128 -0
  36. package/dist/es6/impl/sitemap/helpers/build-localized-sitemap.test.js +208 -0
  37. package/dist/es6/impl/sitemap/helpers/build-pages-by-tag-eagerly.js +7 -0
  38. package/dist/es6/impl/sitemap/helpers/build-sitemap-eagerly.js +32 -0
  39. package/dist/es6/impl/sitemap/helpers/find-ancestors.js +42 -0
  40. package/dist/es6/impl/sitemap/helpers/find-ancestors.test.js +33 -0
  41. package/dist/es6/impl/sitemap/helpers/find-children.js +9 -0
  42. package/dist/es6/impl/sitemap/helpers/find-children.test.js +39 -0
  43. package/dist/es6/impl/sitemap/helpers/is-root.js +1 -0
  44. package/dist/es6/impl/sitemap/helpers/localize-contentful-field.js +22 -0
  45. package/dist/es6/impl/sitemap/helpers/localize-contentful-field.test.js +137 -0
  46. package/dist/es6/impl/sitemap/helpers/localized-pages-by-tag-id.js +79 -0
  47. package/dist/es6/impl/sitemap/helpers/localized-path.js +4 -0
  48. package/dist/es6/impl/sitemap/helpers/page-ancestors.js +8 -0
  49. package/dist/es6/impl/sitemap/helpers/page-children.js +10 -0
  50. package/dist/es6/impl/sitemap/methods/cached-data.js +7 -0
  51. package/dist/es6/impl/sitemap/methods/home-page.js +27 -0
  52. package/dist/es6/impl/sitemap/methods/page-by-id.js +29 -0
  53. package/dist/es6/impl/sitemap/methods/page-by-path.js +52 -0
  54. package/dist/es6/impl/sitemap/methods/pages-by-ids.js +6 -0
  55. package/dist/es6/impl/sitemap/methods/pages-by-paths.js +6 -0
  56. package/dist/es6/impl/sitemap/methods/pages-by-tag-id.js +37 -0
  57. package/dist/es6/impl/sitemap/methods/pages.js +75 -0
  58. package/dist/es6/impl/sitemap/methods/regenerate.js +64 -0
  59. package/dist/es6/impl/sitemap/methods/search.js +97 -0
  60. package/dist/es6/impl/sitemap/methods/status.js +47 -0
  61. package/dist/es6/index.js +2 -0
  62. package/dist/es6/utils/array-to-map.js +7 -0
  63. package/dist/es6/utils/fp-utils.js +5 -0
  64. package/dist/es6/utils/group-by.js +13 -0
  65. package/dist/es6/utils/json-stringify-map-replacer.js +6 -0
  66. package/dist/es6/utils/string-similarity.js +59 -0
  67. package/dist/impl/arboretum-client.impl.js +189 -0
  68. package/dist/impl/data/content-types.js +140 -0
  69. package/dist/impl/data/helpers/__mocks__/mocked-contentful-entries-client-api.js +72 -0
  70. package/dist/impl/data/helpers/entry-status.js +23 -0
  71. package/dist/impl/data/helpers/get-all-entries-recursively.js +117 -0
  72. package/dist/impl/data/helpers/get-all-entries-recursively.test.js +116 -0
  73. package/dist/impl/data/helpers/home-pages-by-tag-id.js +70 -0
  74. package/dist/impl/data/helpers/home-pages-by-tag-id.test.js +107 -0
  75. package/dist/impl/data/helpers/locale-codes-from-metadata.js +11 -0
  76. package/dist/impl/data/helpers/locale-codes-from-metadata.test.js +54 -0
  77. package/dist/impl/data/helpers/parse-locale-tag.js +28 -0
  78. package/dist/impl/data/helpers/parse-locale-tag.test.js +21 -0
  79. package/dist/impl/data/helpers/validate-content-types.js +117 -0
  80. package/dist/impl/data/helpers/validate-content-types.test.js +105 -0
  81. package/dist/impl/data/home-page.js +79 -0
  82. package/dist/impl/data/locales.js +64 -0
  83. package/dist/impl/data/page-entries.js +173 -0
  84. package/dist/impl/data/page-entries.test.js +172 -0
  85. package/dist/impl/data/redirect-entries.js +168 -0
  86. package/dist/impl/data/sitemap-data.js +113 -0
  87. package/dist/impl/sitemap/adapters/page-entry-adapter.js +31 -0
  88. package/dist/impl/sitemap/adapters/redirect-entry-adapter.js +30 -0
  89. package/dist/impl/sitemap/adapters/redirect-to-arboretum-page-adapter.js +15 -0
  90. package/dist/impl/sitemap/adapters/to-arboretum-page-adapter.js +18 -0
  91. package/dist/impl/sitemap/adapters/to-arboretum-page-adapter.test.js +102 -0
  92. package/dist/impl/sitemap/adapters/to-arboretum-page-with-missing-data-adapter.js +20 -0
  93. package/dist/impl/sitemap/helpers/__mocks__/mocked-localized-sitemap.js +189 -0
  94. package/dist/impl/sitemap/helpers/build-localized-sitemap.js +133 -0
  95. package/dist/impl/sitemap/helpers/build-localized-sitemap.test.js +210 -0
  96. package/dist/impl/sitemap/helpers/build-pages-by-tag-eagerly.js +11 -0
  97. package/dist/impl/sitemap/helpers/build-sitemap-eagerly.js +36 -0
  98. package/dist/impl/sitemap/helpers/find-ancestors.js +46 -0
  99. package/dist/impl/sitemap/helpers/find-ancestors.test.js +35 -0
  100. package/dist/impl/sitemap/helpers/find-children.js +13 -0
  101. package/dist/impl/sitemap/helpers/find-children.test.js +41 -0
  102. package/dist/impl/sitemap/helpers/is-root.js +5 -0
  103. package/dist/impl/sitemap/helpers/localize-contentful-field.js +26 -0
  104. package/dist/impl/sitemap/helpers/localize-contentful-field.test.js +139 -0
  105. package/dist/impl/sitemap/helpers/localized-pages-by-tag-id.js +84 -0
  106. package/dist/impl/sitemap/helpers/localized-path.js +8 -0
  107. package/dist/impl/sitemap/helpers/page-ancestors.js +12 -0
  108. package/dist/impl/sitemap/helpers/page-children.js +14 -0
  109. package/dist/impl/sitemap/methods/cached-data.js +11 -0
  110. package/dist/impl/sitemap/methods/home-page.js +31 -0
  111. package/dist/impl/sitemap/methods/page-by-id.js +33 -0
  112. package/dist/impl/sitemap/methods/page-by-path.js +56 -0
  113. package/dist/impl/sitemap/methods/pages-by-ids.js +10 -0
  114. package/dist/impl/sitemap/methods/pages-by-paths.js +10 -0
  115. package/dist/impl/sitemap/methods/pages-by-tag-id.js +41 -0
  116. package/dist/impl/sitemap/methods/pages.js +79 -0
  117. package/dist/impl/sitemap/methods/regenerate.js +68 -0
  118. package/dist/impl/sitemap/methods/search.js +101 -0
  119. package/dist/impl/sitemap/methods/status.js +51 -0
  120. package/dist/index.js +8 -0
  121. package/dist/types/arboretum-client.d.ts +110 -0
  122. package/dist/types/clients/contentful-client/contentful-client.d.ts +95 -0
  123. package/dist/types/clients/contentful-client/impl/contentful-client-impl.d.ts +3 -0
  124. package/dist/types/impl/arboretum-client.impl.d.ts +107 -0
  125. package/dist/types/impl/data/content-types.d.ts +11 -0
  126. package/dist/types/impl/data/helpers/__mocks__/mocked-contentful-entries-client-api.d.ts +7 -0
  127. package/dist/types/impl/data/helpers/entry-status.d.ts +2 -0
  128. package/dist/types/impl/data/helpers/get-all-entries-recursively.d.ts +6 -0
  129. package/dist/types/impl/data/helpers/get-all-entries-recursively.test.d.ts +1 -0
  130. package/dist/types/impl/data/helpers/home-pages-by-tag-id.d.ts +15 -0
  131. package/dist/types/impl/data/helpers/home-pages-by-tag-id.test.d.ts +1 -0
  132. package/dist/types/impl/data/helpers/locale-codes-from-metadata.d.ts +2 -0
  133. package/dist/types/impl/data/helpers/locale-codes-from-metadata.test.d.ts +1 -0
  134. package/dist/types/impl/data/helpers/parse-locale-tag.d.ts +3 -0
  135. package/dist/types/impl/data/helpers/parse-locale-tag.test.d.ts +1 -0
  136. package/dist/types/impl/data/helpers/validate-content-types.d.ts +5 -0
  137. package/dist/types/impl/data/helpers/validate-content-types.test.d.ts +1 -0
  138. package/dist/types/impl/data/home-page.d.ts +3 -0
  139. package/dist/types/impl/data/locales.d.ts +10 -0
  140. package/dist/types/impl/data/page-entries.d.ts +3 -0
  141. package/dist/types/impl/data/page-entries.test.d.ts +1 -0
  142. package/dist/types/impl/data/redirect-entries.d.ts +4 -0
  143. package/dist/types/impl/data/sitemap-data.d.ts +17 -0
  144. package/dist/types/impl/sitemap/adapters/page-entry-adapter.d.ts +6 -0
  145. package/dist/types/impl/sitemap/adapters/redirect-entry-adapter.d.ts +4 -0
  146. package/dist/types/impl/sitemap/adapters/redirect-to-arboretum-page-adapter.d.ts +3 -0
  147. package/dist/types/impl/sitemap/adapters/to-arboretum-page-adapter.d.ts +3 -0
  148. package/dist/types/impl/sitemap/adapters/to-arboretum-page-adapter.test.d.ts +1 -0
  149. package/dist/types/impl/sitemap/adapters/to-arboretum-page-with-missing-data-adapter.d.ts +3 -0
  150. package/dist/types/impl/sitemap/helpers/__mocks__/mocked-localized-sitemap.d.ts +16 -0
  151. package/dist/types/impl/sitemap/helpers/build-localized-sitemap.d.ts +5 -0
  152. package/dist/types/impl/sitemap/helpers/build-localized-sitemap.test.d.ts +1 -0
  153. package/dist/types/impl/sitemap/helpers/build-pages-by-tag-eagerly.d.ts +3 -0
  154. package/dist/types/impl/sitemap/helpers/build-sitemap-eagerly.d.ts +3 -0
  155. package/dist/types/impl/sitemap/helpers/find-ancestors.d.ts +2 -0
  156. package/dist/types/impl/sitemap/helpers/find-ancestors.test.d.ts +1 -0
  157. package/dist/types/impl/sitemap/helpers/find-children.d.ts +2 -0
  158. package/dist/types/impl/sitemap/helpers/find-children.test.d.ts +1 -0
  159. package/dist/types/impl/sitemap/helpers/is-root.d.ts +2 -0
  160. package/dist/types/impl/sitemap/helpers/localize-contentful-field.d.ts +4 -0
  161. package/dist/types/impl/sitemap/helpers/localize-contentful-field.test.d.ts +1 -0
  162. package/dist/types/impl/sitemap/helpers/localized-pages-by-tag-id.d.ts +4 -0
  163. package/dist/types/impl/sitemap/helpers/localized-path.d.ts +1 -0
  164. package/dist/types/impl/sitemap/helpers/page-ancestors.d.ts +3 -0
  165. package/dist/types/impl/sitemap/helpers/page-children.d.ts +5 -0
  166. package/dist/types/impl/sitemap/methods/cached-data.d.ts +3 -0
  167. package/dist/types/impl/sitemap/methods/home-page.d.ts +3 -0
  168. package/dist/types/impl/sitemap/methods/page-by-id.d.ts +3 -0
  169. package/dist/types/impl/sitemap/methods/page-by-path.d.ts +3 -0
  170. package/dist/types/impl/sitemap/methods/pages-by-ids.d.ts +3 -0
  171. package/dist/types/impl/sitemap/methods/pages-by-paths.d.ts +3 -0
  172. package/dist/types/impl/sitemap/methods/pages-by-tag-id.d.ts +3 -0
  173. package/dist/types/impl/sitemap/methods/pages.d.ts +3 -0
  174. package/dist/types/impl/sitemap/methods/regenerate.d.ts +3 -0
  175. package/dist/types/impl/sitemap/methods/search.d.ts +3 -0
  176. package/dist/types/impl/sitemap/methods/status.d.ts +3 -0
  177. package/dist/types/index.d.ts +6 -0
  178. package/dist/types/utils/array-to-map.d.ts +1 -0
  179. package/dist/types/utils/fp-utils.d.ts +11 -0
  180. package/dist/types/utils/group-by.d.ts +1 -0
  181. package/dist/types/utils/json-stringify-map-replacer.d.ts +1 -0
  182. package/dist/types/utils/string-similarity.d.ts +9 -0
  183. package/dist/utils/array-to-map.js +11 -0
  184. package/dist/utils/fp-utils.js +10 -0
  185. package/dist/utils/group-by.js +17 -0
  186. package/dist/utils/json-stringify-map-replacer.js +10 -0
  187. package/dist/utils/string-similarity.js +63 -0
  188. package/docs/.nojekyll +1 -0
  189. package/docs/assets/highlight.css +78 -0
  190. package/docs/assets/main.js +58 -0
  191. package/docs/assets/search.js +1 -0
  192. package/docs/assets/style.css +1367 -0
  193. package/docs/functions/createArboretumClient.html +72 -0
  194. package/docs/functions/createArboretumClientFromCdaClient.html +72 -0
  195. package/docs/functions/createArboretumClientFromCdaParams.html +72 -0
  196. package/docs/functions/createArboretumClientFromCma.html +72 -0
  197. package/docs/index.html +228 -0
  198. package/docs/modules.html +88 -0
  199. package/docs/types/ArboretumAliasT.html +70 -0
  200. package/docs/types/ArboretumClientConfigFromCdaParamsT.html +74 -0
  201. package/docs/types/ArboretumClientConfigFromCdaT.html +79 -0
  202. package/docs/types/ArboretumClientConfigFromCmaT.html +79 -0
  203. package/docs/types/ArboretumClientConfigT.html +63 -0
  204. package/docs/types/ArboretumClientContentfulConfigOptionsT.html +93 -0
  205. package/docs/types/ArboretumClientOptions.html +72 -0
  206. package/docs/types/ArboretumClientOptionsT.html +63 -0
  207. package/docs/types/ArboretumClientT.html +235 -0
  208. package/docs/types/ArboretumPageNodeT.html +63 -0
  209. package/docs/types/ArboretumPageT.html +76 -0
  210. package/docs/types/ArboretumRedirectT.html +70 -0
  211. package/docs/types/CachedDataT.html +63 -0
  212. package/docs/types/Either.html +70 -0
  213. package/docs/types/EitherL.html +75 -0
  214. package/docs/types/EitherR.html +75 -0
  215. package/docs/types/LocaleT.html +63 -0
  216. package/docs/types/OptionsT.html +70 -0
  217. package/logo.svg +12 -0
  218. package/package.json +47 -0
package/docs/types/EitherL.html ADDED
@@ -0,0 +1,75 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EitherL | @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">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <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>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bright.global/arboretum-sdk</a></div>
10
+ <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>
11
+ <div class="container container-main">
12
+ <div class="col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../modules.html">@bright.global/arboretum-sdk</a></li>
16
+ <li><a href="EitherL.html">EitherL</a></li></ul>
17
+ <h1>Type alias EitherL&lt;L&gt;</h1></div>
18
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">EitherL</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">L</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">_tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Left&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">left</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">L</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
19
+ <section class="tsd-panel">
20
+ <h4>Type Parameters</h4>
21
+ <ul class="tsd-type-parameter-list">
22
+ <li>
23
+ <h4><span class="tsd-kind-type-parameter">L</span></h4></li></ul></section>
24
+ <div class="tsd-type-declaration">
25
+ <h4>Type declaration</h4>
26
+ <ul class="tsd-parameters">
27
+ <li class="tsd-parameter">
28
+ <h5><span class="tsd-kind-property">_tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Left&quot;</span></h5></li>
29
+ <li class="tsd-parameter">
30
+ <h5><span class="tsd-kind-property">left</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">L</span></h5></li></ul></div><aside class="tsd-sources">
31
+ <ul>
32
+ <li>Defined in <a href="https://github.com/BrightIT/arboretum-sdk/blob/09fe705/src/utils/fp-utils.ts#L2">utils/fp-utils.ts:2</a></li></ul></aside></div>
33
+ <div class="col-sidebar">
34
+ <div class="page-menu">
35
+ <div class="tsd-navigation settings">
36
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
37
+ <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>
38
+ <div class="tsd-accordion-details">
39
+ <div class="tsd-filter-visibility">
40
+ <h4 class="uppercase">Member Visibility</h4><form>
41
+ <ul id="tsd-filter-options">
42
+ <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>
43
+ <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>
44
+ <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>
45
+ <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>
46
+ <div class="tsd-theme-toggle">
47
+ <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>
48
+ <div class="site-menu">
49
+ <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>
50
+ <ul class="tsd-small-nested-navigation">
51
+ <li><a href="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>
52
+ <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>
53
+ <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>
54
+ <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>
55
+ <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>
56
+ <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>
57
+ <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>
58
+ <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>
59
+ <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>
60
+ <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>
61
+ <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>
62
+ <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>
63
+ <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>
64
+ <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>
65
+ <li><a href="EitherL.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherL</span></a></li>
66
+ <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>
67
+ <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>
68
+ <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>
69
+ <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>
70
+ <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>
71
+ <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>
72
+ <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>
73
+ <div class="tsd-generator">
74
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
75
+ <div class="overlay"></div></body></html>
package/docs/types/EitherR.html ADDED
@@ -0,0 +1,75 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EitherR | @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">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <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>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bright.global/arboretum-sdk</a></div>
10
+ <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>
11
+ <div class="container container-main">
12
+ <div class="col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../modules.html">@bright.global/arboretum-sdk</a></li>
16
+ <li><a href="EitherR.html">EitherR</a></li></ul>
17
+ <h1>Type alias EitherR&lt;R&gt;</h1></div>
18
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">EitherR</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">_tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Right&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">right</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
19
+ <section class="tsd-panel">
20
+ <h4>Type Parameters</h4>
21
+ <ul class="tsd-type-parameter-list">
22
+ <li>
23
+ <h4><span class="tsd-kind-type-parameter">R</span></h4></li></ul></section>
24
+ <div class="tsd-type-declaration">
25
+ <h4>Type declaration</h4>
26
+ <ul class="tsd-parameters">
27
+ <li class="tsd-parameter">
28
+ <h5><span class="tsd-kind-property">_tag</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Right&quot;</span></h5></li>
29
+ <li class="tsd-parameter">
30
+ <h5><span class="tsd-kind-property">right</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">R</span></h5></li></ul></div><aside class="tsd-sources">
31
+ <ul>
32
+ <li>Defined in <a href="https://github.com/BrightIT/arboretum-sdk/blob/09fe705/src/utils/fp-utils.ts#L1">utils/fp-utils.ts:1</a></li></ul></aside></div>
33
+ <div class="col-sidebar">
34
+ <div class="page-menu">
35
+ <div class="tsd-navigation settings">
36
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
37
+ <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>
38
+ <div class="tsd-accordion-details">
39
+ <div class="tsd-filter-visibility">
40
+ <h4 class="uppercase">Member Visibility</h4><form>
41
+ <ul id="tsd-filter-options">
42
+ <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>
43
+ <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>
44
+ <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>
45
+ <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>
46
+ <div class="tsd-theme-toggle">
47
+ <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>
48
+ <div class="site-menu">
49
+ <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>
50
+ <ul class="tsd-small-nested-navigation">
51
+ <li><a href="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>
52
+ <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>
53
+ <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>
54
+ <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>
55
+ <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>
56
+ <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>
57
+ <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>
58
+ <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>
59
+ <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>
60
+ <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>
61
+ <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>
62
+ <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>
63
+ <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>
64
+ <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>
65
+ <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>
66
+ <li><a href="EitherR.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>EitherR</span></a></li>
67
+ <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>
68
+ <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>
69
+ <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>
70
+ <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>
71
+ <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>
72
+ <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>
73
+ <div class="tsd-generator">
74
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
75
+ <div class="overlay"></div></body></html>
package/docs/types/LocaleT.html ADDED
@@ -0,0 +1,63 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LocaleT | @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">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <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>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bright.global/arboretum-sdk</a></div>
10
+ <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>
11
+ <div class="container container-main">
12
+ <div class="col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../modules.html">@bright.global/arboretum-sdk</a></li>
16
+ <li><a href="LocaleT.html">LocaleT</a></li></ul>
17
+ <h1>Type alias LocaleT</h1></div>
18
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">LocaleT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Locale</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;code&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;default&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;fallbackCode&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
19
+ <ul>
20
+ <li>Defined in <a href="https://github.com/BrightIT/arboretum-sdk/blob/09fe705/src/clients/contentful-client/contentful-client.ts#L56">clients/contentful-client/contentful-client.ts:56</a></li></ul></aside></div>
21
+ <div class="col-sidebar">
22
+ <div class="page-menu">
23
+ <div class="tsd-navigation settings">
24
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
25
+ <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>
26
+ <div class="tsd-accordion-details">
27
+ <div class="tsd-filter-visibility">
28
+ <h4 class="uppercase">Member Visibility</h4><form>
29
+ <ul id="tsd-filter-options">
30
+ <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>
31
+ <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>
32
+ <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>
33
+ <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>
34
+ <div class="tsd-theme-toggle">
35
+ <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>
36
+ <div class="site-menu">
37
+ <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>
38
+ <ul class="tsd-small-nested-navigation">
39
+ <li><a href="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>
40
+ <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>
41
+ <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>
42
+ <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>
43
+ <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>
44
+ <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>
45
+ <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>
46
+ <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>
47
+ <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>
48
+ <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>
49
+ <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>
50
+ <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>
51
+ <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>
52
+ <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>
53
+ <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>
54
+ <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>
55
+ <li><a href="LocaleT.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>LocaleT</span></a></li>
56
+ <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>
57
+ <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>
58
+ <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>
59
+ <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>
60
+ <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>
61
+ <div class="tsd-generator">
62
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
63
+ <div class="overlay"></div></body></html>
package/docs/types/OptionsT.html ADDED
@@ -0,0 +1,70 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OptionsT | @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">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <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>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@bright.global/arboretum-sdk</a></div>
10
+ <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>
11
+ <div class="container container-main">
12
+ <div class="col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../modules.html">@bright.global/arboretum-sdk</a></li>
16
+ <li><a href="OptionsT.html">OptionsT</a></li></ul>
17
+ <h1>Type alias OptionsT</h1></div>
18
+ <div class="tsd-signature"><span class="tsd-kind-type-alias">OptionsT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">withAncestors</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">withChildren</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
19
+ <div class="tsd-type-declaration">
20
+ <h4>Type declaration</h4>
21
+ <ul class="tsd-parameters">
22
+ <li class="tsd-parameter">
23
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">with<wbr/>Ancestors</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li>
24
+ <li class="tsd-parameter">
25
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">with<wbr/>Children</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div><aside class="tsd-sources">
26
+ <ul>
27
+ <li>Defined in <a href="https://github.com/BrightIT/arboretum-sdk/blob/09fe705/src/arboretum-client.ts#L99">arboretum-client.ts:99</a></li></ul></aside></div>
28
+ <div class="col-sidebar">
29
+ <div class="page-menu">
30
+ <div class="tsd-navigation settings">
31
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
32
+ <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>
33
+ <div class="tsd-accordion-details">
34
+ <div class="tsd-filter-visibility">
35
+ <h4 class="uppercase">Member Visibility</h4><form>
36
+ <ul id="tsd-filter-options">
37
+ <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>
38
+ <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>
39
+ <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>
40
+ <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>
41
+ <div class="tsd-theme-toggle">
42
+ <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>
43
+ <div class="site-menu">
44
+ <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>
45
+ <ul class="tsd-small-nested-navigation">
46
+ <li><a href="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>
47
+ <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>
48
+ <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>
49
+ <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>
50
+ <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>
51
+ <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>
52
+ <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>
53
+ <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>
54
+ <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>
55
+ <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>
56
+ <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>
57
+ <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>
58
+ <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>
59
+ <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>
60
+ <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>
61
+ <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>
62
+ <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>
63
+ <li><a href="OptionsT.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>OptionsT</span></a></li>
64
+ <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>
65
+ <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>
66
+ <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>
67
+ <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>
68
+ <div class="tsd-generator">
69
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
70
+ <div class="overlay"></div></body></html>
package/logo.svg ADDED
@@ -0,0 +1,12 @@
1
+ <svg width="252" height="220" viewBox="0 0 63 55" fill="none" xmlns="http://www.w3.org/2000/svg">
2
+ <path fill-rule="evenodd" clip-rule="evenodd" d="M53.9077 53.4316C59.3283 47.8026 62.661 40.1512 62.661 31.722C62.661 14.4289 48.6338 0.410034 31.3306 0.410034C14.0272 0.410034 0 14.4289 0 31.722C0 40.1512 3.33275 47.8026 8.75318 53.4316H53.9077Z" fill="#F3F3F6"/>
3
+ <path d="M23.5642 23.5413C23.5642 23.5413 20.6005 22.8339 17.4013 27.3013C17.4013 27.3013 16.3713 28.666 14.6346 29.0349C14.0091 29.1682 13.5921 29.8527 13.76 30.5466C13.8861 31.082 14.3177 31.454 14.8128 31.454H22.0234C23.3782 31.449 24.7018 31.0481 25.8315 30.3007C26.9818 29.5394 28.3329 29.1379 29.7125 29.1474L40.4173 29.2641L48.4097 29.1839C49.5084 29.1734 50.2588 27.9389 49.8691 26.7876C49.7934 26.5521 49.6661 26.3364 49.4963 26.1562C49.3265 25.976 49.1187 25.8358 48.8881 25.7458L48.1929 25.4926C47.1145 25.0916 46.1471 24.4394 45.371 23.5903L44.0002 22.1119L23.5642 23.5413Z" fill="#008539"/>
4
+ <path d="M22.7896 42.7391V41.7327C22.7895 39.4521 23.6928 37.2643 25.302 35.6472C26.9111 34.0303 29.0953 33.1156 31.3772 33.1032L36.2527 33.0761C36.6407 33.0734 37.0119 32.9174 37.2853 32.6422C37.5587 32.367 37.7121 31.995 37.7121 31.6072C37.7122 31.2285 37.5658 30.8644 37.3035 30.591C37.0413 30.3176 36.6834 30.1561 36.3048 30.1403L31.3595 29.9319C30.2655 29.8856 29.232 29.4173 28.4762 28.6254C27.7204 27.8335 27.3011 26.7798 27.3064 25.6854V24.4238L31.0592 23.8904C31.0601 24.5531 31.3147 25.1904 31.7708 25.6714C32.227 26.1524 32.85 26.4408 33.5121 26.4773L38.005 26.7533C39.3346 26.8937 40.5711 27.5013 41.4942 28.4679C42.4173 29.4346 42.9669 30.6973 43.0453 32.0312C43.1252 33.3877 42.7125 34.7274 41.8831 35.8041C41.0536 36.8808 39.863 37.622 38.5304 37.8915L34.3419 39.0687C34.1496 39.1077 33.9767 39.212 33.8526 39.364C33.7285 39.5159 33.6609 39.706 33.6612 39.9022C33.6612 40.1151 33.7415 40.3203 33.886 40.4768C34.0304 40.6333 34.2285 40.7298 34.4409 40.7471L36.7218 41.1492C38.1927 41.4503 39.0339 41.8504 39.7689 42.7411H22.7896V42.7391Z" fill="#006D23"/>
5
+ <path d="M40.3921 53.5334H24.2488C23.7069 53.5334 23.1831 53.3387 22.7725 52.9854C22.3618 52.632 22.0915 52.1438 22.0107 51.6082L20.5752 42.0587H44.0667L42.6313 51.6082C42.5508 52.1438 42.2805 52.633 41.8695 52.9863C41.4585 53.3396 40.9342 53.5339 40.3921 53.5334Z" fill="#E88A23"/>
6
+ <path d="M43.0412 32.0311C42.9617 30.6982 42.4115 29.4366 41.4885 28.4711C40.5655 27.5055 39.3297 26.8987 38.0009 26.7585L33.5122 26.4772C32.8528 26.4366 32.2338 26.1463 31.7812 25.6655C31.3285 25.1846 31.0763 24.5494 31.076 23.8893L27.3232 24.4227L27.3169 25.6844C27.3116 26.7787 27.7309 27.8324 28.4867 28.6243C29.2425 29.4162 30.276 29.8844 31.37 29.9308L36.3153 30.1392C36.6939 30.155 37.0518 30.3165 37.314 30.5899C37.5763 30.8633 37.7227 31.2273 37.7226 31.606C37.7223 31.7072 37.7118 31.8081 37.6913 31.9072L42.9922 33.2031C43.0493 32.8153 43.0658 32.4224 43.0412 32.0311Z" fill="#003F00"/>
7
+ <path d="M31.2626 9.56836H29.4738C26.802 9.56817 24.2358 10.6113 22.3226 12.4751L21.8743 12.9106C20.9943 13.5572 19.9424 13.9291 18.8512 13.9795L18.4343 13.9992C17.4392 14.0463 16.4752 14.3601 15.6433 14.9076C14.8113 15.4551 14.1421 16.2162 13.7058 17.1112L13.2554 18.0374C13.1301 18.2954 12.9552 18.5262 12.7405 18.7166C12.5259 18.907 12.2757 19.0532 12.0045 19.1469L10.1562 19.7845C9.73999 19.9281 9.37677 20.1938 9.11396 20.547C8.85121 20.9001 8.70111 21.3242 8.68327 21.764C8.66123 22.335 8.8636 22.8921 9.24718 23.3159C9.6308 23.7398 10.1651 23.9968 10.7358 24.032L16.0116 24.3518C17.37 24.4346 18.7049 24.7448 19.9604 25.2697C21.6638 25.9822 23.5074 26.2972 25.3509 26.1907L31.2105 25.8511H36.9793C38.9627 25.851 40.911 25.3277 42.6273 24.3342C44.0497 23.5106 45.6351 23.0081 47.2724 22.862L50.4103 22.5818C50.8892 22.5387 51.332 22.3107 51.6455 21.946C51.9585 21.5813 52.1167 21.1089 52.0863 20.6294L52.0791 20.5252C52.0289 19.7331 51.7342 18.9761 51.2355 18.3584C50.7368 17.7408 50.0587 17.293 49.2947 17.0768C48.4097 16.8246 47.5914 16.3811 46.8971 15.7776L46.3029 15.2567C45.5384 14.5929 44.5789 14.1951 43.5686 14.1232L41.4535 13.9732C40.3344 13.84 39.2921 13.336 38.493 12.5417C36.5706 10.6347 33.9712 9.56576 31.2626 9.56836Z" fill="#9ED696"/>
8
+ <path d="M52.086 20.6294L52.0228 19.6365C51.9789 18.9432 51.6722 18.2927 51.1657 17.8173C50.6588 17.3419 49.9894 17.0774 49.2944 17.0778C49.1801 17.0444 49.0663 17.009 48.9534 16.9736L48.9163 16.959C48.8121 16.9225 48.7137 16.885 48.6158 16.8444H48.6033C47.98 16.5855 47.4021 16.2285 46.8917 15.787L46.6645 15.589C45.7492 16.4485 43.8551 17.6185 40.3254 17.6185H36.755C36.2515 17.6185 35.6323 17.9758 35.4217 18.4332C35.3246 18.6454 35.2824 18.8786 35.299 19.1113C35.3156 19.3441 35.3904 19.5689 35.5166 19.7653C35.6427 19.9616 35.8163 20.1231 36.0212 20.2349C36.2261 20.3468 36.4559 20.4054 36.6893 20.4054H36.7081C37.0704 20.4005 37.4259 20.5037 37.7293 20.7017C38.0327 20.8997 38.2702 21.1835 38.4114 21.517C38.4114 21.5263 38.4187 21.5368 38.4229 21.5462C38.7284 22.3557 38.2061 23.2454 37.3607 23.4318C35.9001 23.7458 34.4096 23.8992 32.9157 23.8892H27.0488C25.9573 23.8893 24.8699 23.7577 23.8099 23.4975C23.4003 23.3933 22.9457 23.2766 22.4704 23.1329C20.7754 22.6135 18.9713 22.5627 17.2498 22.9859C15.7769 23.3537 13.6346 23.7246 10.7304 23.8465C10.5052 23.8559 10.2707 23.8621 10.0361 23.8684C10.2593 23.9614 10.4964 24.0167 10.7377 24.032L16.0375 24.3528C17.422 24.4496 18.7814 24.7726 20.0613 25.3092C21.7383 25.9938 23.5474 26.2949 25.3559 26.1906L31.2155 25.851H36.9843C38.9677 25.8509 40.916 25.3277 42.6323 24.3341C44.0531 23.5112 45.6367 23.0088 47.2722 22.862L50.41 22.5817C50.8889 22.5387 51.3321 22.3106 51.6452 21.9459C51.9582 21.5812 52.1164 21.1089 52.086 20.6294Z" fill="#5DB057"/>
9
+ <path d="M43.8896 43.239L21.1279 42.3097V44.0537L43.0495 48.8327L43.8896 43.239Z" fill="#C15C17"/>
10
+ <path d="M44.7307 44.9164H19.9111C19.5321 44.9164 19.1686 44.766 18.9005 44.4981C18.6325 44.2302 18.4819 43.8669 18.4819 43.4881C18.4818 43.3004 18.5187 43.1146 18.5905 42.9412C18.6622 42.7678 18.7675 42.6102 18.9002 42.4774C19.0329 42.3447 19.1905 42.2394 19.364 42.1675C19.5374 42.0957 19.7234 42.0587 19.9111 42.0587H44.7307C44.9184 42.0587 45.1044 42.0957 45.2779 42.1675C45.4513 42.2394 45.6089 42.3447 45.7416 42.4774C45.8744 42.6102 45.9796 42.7678 46.0514 42.9412C46.1231 43.1146 46.16 43.3004 46.1598 43.4881C46.1598 43.8669 46.0093 44.2302 45.7412 44.4981C45.4732 44.766 45.1097 44.9164 44.7307 44.9164Z" fill="#FFBA40"/>
11
+ <path fill-rule="evenodd" clip-rule="evenodd" d="M10.538 54.8777H52.3299L53.7768 53.4316H8.76953L10.538 54.8777Z" fill="black"/>
12
+ </svg>
package/package.json ADDED
@@ -0,0 +1,47 @@
1
+ {
2
+ "name": "@bright.global/arboretum-sdk",
3
+ "version": "0.0.6",
4
+ "license": "MIT",
5
+ "description": "The sitemap for contentful",
6
+ "dependencies": {
7
+ "contentful": "^9.2.5",
8
+ "contentful-management": "10.29.1"
9
+ },
10
+ "sideEffects": false,
11
+ "devDependencies": {
12
+ "@babel/preset-env": "^7.22.6",
13
+ "@babel/preset-typescript": "^7.22.5",
14
+ "@types/jest": "^29.5.2",
15
+ "jest": "^29.5.0",
16
+ "rimraf": "^5.0.1",
17
+ "ts-jest": "^29.1.1",
18
+ "typedoc": "^0.24.8",
19
+ "typescript": "4.9.5"
20
+ },
21
+ "main": "dist/index.js",
22
+ "module": "dist/es6/index.js",
23
+ "types": "dist/types/index.d.ts",
24
+ "scripts": {
25
+ "clean": "rimraf ./dist",
26
+ "build": "tsc -p ./tsconfig.build.json && tsc -p ./tsconfig.build-es6.json",
27
+ "test": "jest",
28
+ "typedoc": "typedoc --out docs src/index.ts",
29
+ "prebuild": "yarn clean"
30
+ },
31
+ "keywords": [
32
+ "contentful",
33
+ "sitemap"
34
+ ],
35
+ "directories": {
36
+ "doc": "docs"
37
+ },
38
+ "repository": {
39
+ "type": "git",
40
+ "url": "git+https://github.com/BrightIT/arboretum-sdk.git"
41
+ },
42
+ "author": "Dacjan Naumowicz <dacjan.naumowicz@bright.global>",
43
+ "bugs": {
44
+ "url": "https://github.com/BrightIT/arboretum-sdk/issues"
45
+ },
46
+ "homepage": "https://github.com/BrightIT/arboretum-sdk#readme"
47
+ }