sidechat.js 2.0.0-alpha.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/index.d.ts +3 -0
- package/dist/sidechat.cjs +1 -1
- package/dist/sidechat.cjs.map +1 -1
- package/dist/sidechat.modern.js +1 -1
- package/dist/sidechat.modern.js.map +1 -1
- package/dist/sidechat.module.js +1 -1
- package/dist/sidechat.module.js.map +1 -1
- package/dist/sidechat.umd.js +1 -1
- package/dist/sidechat.umd.js.map +1 -1
- package/dist/types.d.ts +229 -0
- package/docs/sidechat.js/2.0.0/SidechatAPIClient.html +3 -0
- package/docs/sidechat.js/2.0.0/SidechatAPIError.html +3 -0
- package/docs/sidechat.js/2.0.0/classes_SidechatAPIClient.js.html +425 -0
- package/docs/sidechat.js/2.0.0/classes_SidechatAPIError.js.html +16 -0
- package/docs/sidechat.js/2.0.0/data/search.json +1 -0
- package/docs/sidechat.js/2.0.0/fonts/Inconsolata-Regular.ttf +0 -0
- package/docs/sidechat.js/2.0.0/fonts/OpenSans-Regular.ttf +0 -0
- package/docs/sidechat.js/2.0.0/fonts/WorkSans-Bold.ttf +0 -0
- package/docs/sidechat.js/2.0.0/global.html +3 -0
- package/docs/sidechat.js/2.0.0/index.html +4 -0
- package/docs/sidechat.js/2.0.0/scripts/core.js +702 -0
- package/docs/sidechat.js/2.0.0/scripts/core.min.js +23 -0
- package/docs/sidechat.js/2.0.0/scripts/resize.js +90 -0
- package/docs/sidechat.js/2.0.0/scripts/search.js +265 -0
- package/docs/sidechat.js/2.0.0/scripts/search.min.js +6 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/Apache-License-2.0.txt +202 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/fuse.js +9 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-line-num-original.js +369 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-line-num.js +1 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-original.js +5171 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/hljs.js +1 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/popper.js +5 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/tippy.js +1 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/tocbot.js +672 -0
- package/docs/sidechat.js/2.0.0/scripts/third-party/tocbot.min.js +1 -0
- package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-base.css +975 -0
- package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-dark.css +407 -0
- package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-light.css +388 -0
- package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme.min.css +1 -0
- package/docs/sidechat.js/2.0.0/tutorial-Authentication.html +13 -0
- package/docs/sidechat.js/2.0.0/tutorial-Email Registration.html +6 -0
- package/docs/sidechat.js/2.0.0/types_SidechatTypes.js.html +98 -0
- package/docs/sidechat.js/2.0.0-alpha.0/SidechatAPIClient.html +1 -1
- package/docs/sidechat.js/2.0.0-alpha.0/SidechatAPIError.html +3 -0
- package/docs/sidechat.js/2.0.0-alpha.0/classes_SidechatAPIClient.js.html +92 -48
- package/docs/sidechat.js/2.0.0-alpha.0/classes_SidechatAPIError.js.html +16 -0
- package/docs/sidechat.js/2.0.0-alpha.0/data/search.json +1 -1
- package/docs/sidechat.js/2.0.0-alpha.0/global.html +1 -1
- package/docs/sidechat.js/2.0.0-alpha.0/index.html +2 -2
- package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Authentication.html +13 -0
- package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Email Registration.html +6 -0
- package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Email Verification.html +6 -0
- package/docs/sidechat.js/2.0.0-alpha.0/types_SidechatTypes.js.html +19 -3
- package/docs/tutorials/Authentication.md +46 -0
- package/docs/tutorials/Email Registration.md +16 -0
- package/jsdoc.json +2 -1
- package/package.json +10 -3
- package/src/classes/SidechatAPIClient.js +96 -45
- package/src/classes/SidechatAPIError.js +5 -0
- package/src/index.js +2 -2
- package/src/tests/basicTest.js +14 -3
- package/src/types/SidechatTypes.js +17 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: types/SidechatTypes.js</title><!--[if lt IE 9]>
|
|
2
2
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
3
|
-
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAsset">SidechatAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">types_SidechatTypes.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
|
|
3
|
+
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAsset">SidechatAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">types_SidechatTypes.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
|
|
4
4
|
* A user-created post or comment, depending on the "type" prop
|
|
5
5
|
* @typedef {Object} SidechatPostOrComment
|
|
6
6
|
* @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
|
|
@@ -76,7 +76,23 @@
|
|
|
76
76
|
*/
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* A vote on a comment or post
|
|
80
80
|
* @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
|
|
81
81
|
*/
|
|
82
|
-
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* A user's bearer authentication token needed for most requests
|
|
85
|
+
* @typedef {String} SidechatAuthToken
|
|
86
|
+
*/
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* A list of posts and the associated cursor
|
|
90
|
+
* @typedef {Object} SidechatPostsAndCursor
|
|
91
|
+
* @prop {SidechatPostOrComment[]} posts
|
|
92
|
+
* @prop {SidechatCursorString} cursor
|
|
93
|
+
*/
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* @tutorial Hello world
|
|
97
|
+
*/
|
|
98
|
+
</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAsset">SidechatAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
There are two supported methods of authenticating a Sidechat.js API client. We recommend the automatic method, but you may choose to use the manual method if your project involves multiple instances of `SidechatAPIClient`.
|
|
2
|
+
|
|
3
|
+
Go ahead and import `SidechatAPIClient` from the module:
|
|
4
|
+
|
|
5
|
+
```javascript
|
|
6
|
+
import { SidechatAPIClient } from "sidechat.js";
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
### Automatic method
|
|
10
|
+
|
|
11
|
+
For existing users, this is trivial. First, send the user a verification code to their phone number. Make sure the passed phone number is in a 10-digit format with no dashes, spaces, or parentheses:
|
|
12
|
+
|
|
13
|
+
```javascript
|
|
14
|
+
const phoneNumber = /* User's phone number */;
|
|
15
|
+
await API.loginViaSMS(phoneNumber);
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Then once the user has inputted the 6-digit code into your application, verify it with the API:
|
|
19
|
+
|
|
20
|
+
```javascript
|
|
21
|
+
const code = /* SMS verification code */;
|
|
22
|
+
await API.verifySMSCode(phoneNumber, code);
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
If the user already exists, calling those two functions will set the user token and all requests from here on out using this instance of the API client will be automatically authenticated.
|
|
26
|
+
|
|
27
|
+
If the user has not used Sidechat before, the `verifySMSCode` will return a `registrationID`, which you should store and then use to call the `setAge` function:
|
|
28
|
+
|
|
29
|
+
```javascript
|
|
30
|
+
// Here "res" refers to the result of verifySMSCode()
|
|
31
|
+
const { registration_id } = res;
|
|
32
|
+
await API.setAge(18, registration_id);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Now the user should be logged in properly and future requests will be automatically authenticated. You may still need to [add an email address](tutorial-Email%20Registration.html) for most functionality.
|
|
36
|
+
|
|
37
|
+
### Manual method
|
|
38
|
+
|
|
39
|
+
You can pass a user token directly to the constructor initialization:
|
|
40
|
+
|
|
41
|
+
```javascript
|
|
42
|
+
const token = /* User bearer token as a string */;
|
|
43
|
+
const API = new SidechatAPIClient(token);
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
All requests from here on out using this instance of the API client will automatically use the token passed to the constructor.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
> You can only start this process once you have [authenticated as a user](tutorial-Authentication.html).
|
|
2
|
+
|
|
3
|
+
Start by sending a verification email to the user:
|
|
4
|
+
|
|
5
|
+
```javascript
|
|
6
|
+
const email = /* User's email address */;
|
|
7
|
+
await API.registerEmail(email);
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Once the user has clicked the link in the verification email, verify that they've clicked it:
|
|
11
|
+
|
|
12
|
+
```javascript
|
|
13
|
+
await API.checkEmailVerification();
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
You should be verified!
|
package/jsdoc.json
CHANGED
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
"encoding": "utf8",
|
|
17
17
|
"readme": "./README.md",
|
|
18
18
|
"destination": "docs/",
|
|
19
|
+
"tutorials": "docs/tutorials",
|
|
19
20
|
"package": "./package.json",
|
|
20
21
|
"recurse": true,
|
|
21
22
|
"verbose": true,
|
|
@@ -31,7 +32,7 @@
|
|
|
31
32
|
"target": "_blank"
|
|
32
33
|
}
|
|
33
34
|
],
|
|
34
|
-
"sections": ["Classes", "Global"]
|
|
35
|
+
"sections": ["Tutorials", "Classes", "Global"]
|
|
35
36
|
}
|
|
36
37
|
},
|
|
37
38
|
"markdown": {
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sidechat.js",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "A reverse-engineered API wrapper for Sidechat",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"source": "./src/index.js",
|
|
7
|
+
"types": "./dist/types.d.ts",
|
|
7
8
|
"exports": {
|
|
8
9
|
"require": "./dist/sidechat.cjs",
|
|
9
10
|
"default": "./dist/sidechat.modern.js"
|
|
@@ -14,7 +15,9 @@
|
|
|
14
15
|
"scripts": {
|
|
15
16
|
"build": "microbundle",
|
|
16
17
|
"dev": "microbundle watch",
|
|
17
|
-
"docs": "npx jsdoc --configure jsdoc.json --verbose"
|
|
18
|
+
"docs": "npx jsdoc --configure jsdoc.json --verbose",
|
|
19
|
+
"prepublish": "jsdoc -r src -t node_modules/tsd-jsdoc/dist -d dist",
|
|
20
|
+
"typegen": "jsdoc -r src -t node_modules/tsd-jsdoc/dist -d dist"
|
|
18
21
|
},
|
|
19
22
|
"repository": {
|
|
20
23
|
"type": "git",
|
|
@@ -31,6 +34,10 @@
|
|
|
31
34
|
},
|
|
32
35
|
"devDependencies": {
|
|
33
36
|
"clean-jsdoc-theme": "^4.2.17",
|
|
34
|
-
"microbundle": "^0.15.1"
|
|
37
|
+
"microbundle": "^0.15.1",
|
|
38
|
+
"prompt-sync": "^4.2.0"
|
|
39
|
+
},
|
|
40
|
+
"dependencies": {
|
|
41
|
+
"tsd-jsdoc": "^2.5.0"
|
|
35
42
|
}
|
|
36
43
|
}
|
|
@@ -2,27 +2,55 @@ import "../types/SidechatTypes.js";
|
|
|
2
2
|
import SidechatAPIError from "../classes/SidechatAPIError.js";
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
* API client class for making requests to Sidechat's private API.
|
|
5
|
+
* API client class for making requests to Sidechat's private API. You'll need to [authenticate]{@tutorial Authentication} before using most of the methods.
|
|
6
6
|
* @class
|
|
7
7
|
* @since 2.0.0-alpha.0
|
|
8
|
-
* @todo Add functionality for constructing a client with or without a token and having it keep track of requests/caching, etc
|
|
9
8
|
*/
|
|
10
9
|
class SidechatAPIClient {
|
|
11
|
-
|
|
10
|
+
/**
|
|
11
|
+
* User bearer token
|
|
12
|
+
* @type {SidechatAuthToken}
|
|
13
|
+
* */
|
|
14
|
+
userToken;
|
|
15
|
+
/**
|
|
16
|
+
* Default headers for every API request
|
|
17
|
+
* @type {Object}
|
|
18
|
+
* @static
|
|
19
|
+
*/
|
|
20
|
+
defaultHeaders = {
|
|
12
21
|
Accept: "application/json",
|
|
13
22
|
"Content-Type": "application/json",
|
|
14
23
|
};
|
|
15
24
|
|
|
25
|
+
/**
|
|
26
|
+
* Create a new instance of the API client
|
|
27
|
+
* @param {SidechatAuthToken} [token] - user bearer token
|
|
28
|
+
*/
|
|
29
|
+
constructor(token = "") {
|
|
30
|
+
if (token) {
|
|
31
|
+
this.userToken = token;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Manually set the currently signed in user's token. Generally try to avoid this and instead either pass a token to the constructor or login automatically through the auth functions
|
|
37
|
+
* @method
|
|
38
|
+
* @param {SidechatAuthToken} token - user bearer token
|
|
39
|
+
*/
|
|
40
|
+
setToken = (token) => {
|
|
41
|
+
this.userToken = token;
|
|
42
|
+
};
|
|
43
|
+
|
|
16
44
|
/**
|
|
17
45
|
* Initiate the login process with a phone number. Should be followed up with verifySMSCode().
|
|
18
46
|
* @method
|
|
19
47
|
* @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
|
|
20
48
|
*/
|
|
21
|
-
|
|
49
|
+
loginViaSMS = async (phoneNumber) => {
|
|
22
50
|
try {
|
|
23
51
|
const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {
|
|
24
52
|
method: "POST",
|
|
25
|
-
headers: defaultHeaders,
|
|
53
|
+
headers: this.defaultHeaders,
|
|
26
54
|
body: JSON.stringify({
|
|
27
55
|
phone_number: `+1${phoneNumber}`,
|
|
28
56
|
version: 3,
|
|
@@ -31,7 +59,7 @@ class SidechatAPIClient {
|
|
|
31
59
|
const json = await res.json();
|
|
32
60
|
return json;
|
|
33
61
|
} catch (err) {
|
|
34
|
-
console.error(
|
|
62
|
+
console.error(err);
|
|
35
63
|
throw new SidechatAPIError("Failed to request SMS verification.");
|
|
36
64
|
}
|
|
37
65
|
};
|
|
@@ -42,13 +70,13 @@ class SidechatAPIClient {
|
|
|
42
70
|
* @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
|
|
43
71
|
* @param {String} code - the verification code
|
|
44
72
|
*/
|
|
45
|
-
|
|
73
|
+
verifySMSCode = async (phoneNumber, code) => {
|
|
46
74
|
try {
|
|
47
75
|
const res = await fetch(
|
|
48
76
|
`https://api.sidechat.lol/v1/verify_phone_number`,
|
|
49
77
|
{
|
|
50
78
|
method: "POST",
|
|
51
|
-
headers: defaultHeaders,
|
|
79
|
+
headers: this.defaultHeaders,
|
|
52
80
|
body: JSON.stringify({
|
|
53
81
|
phone_number: `+1${phoneNumber}`,
|
|
54
82
|
code: code.toUpperCase(),
|
|
@@ -56,6 +84,9 @@ class SidechatAPIClient {
|
|
|
56
84
|
}
|
|
57
85
|
);
|
|
58
86
|
const json = await res.json();
|
|
87
|
+
if (json?.logged_in_user?.token) {
|
|
88
|
+
this.userToken = json.logged_in_user.token;
|
|
89
|
+
}
|
|
59
90
|
return json;
|
|
60
91
|
} catch (err) {
|
|
61
92
|
console.error(err);
|
|
@@ -69,7 +100,7 @@ class SidechatAPIClient {
|
|
|
69
100
|
* @param {Number} age - user's age in years
|
|
70
101
|
* @param {String} registrationID - the registration ID generated by verifySMSCode()
|
|
71
102
|
*/
|
|
72
|
-
|
|
103
|
+
setAge = async (age, registrationID) => {
|
|
73
104
|
if (age < 13) {
|
|
74
105
|
throw new SidechatAPIError("You're too young to use Offsides.");
|
|
75
106
|
}
|
|
@@ -78,7 +109,7 @@ class SidechatAPIClient {
|
|
|
78
109
|
`https://api.sidechat.lol/v1/complete_registration`,
|
|
79
110
|
{
|
|
80
111
|
method: "POST",
|
|
81
|
-
headers: defaultHeaders,
|
|
112
|
+
headers: this.defaultHeaders,
|
|
82
113
|
body: JSON.stringify({
|
|
83
114
|
age: Number(age),
|
|
84
115
|
registration_id: registrationID,
|
|
@@ -86,6 +117,9 @@ class SidechatAPIClient {
|
|
|
86
117
|
}
|
|
87
118
|
);
|
|
88
119
|
const json = await res.json();
|
|
120
|
+
if (json.token) {
|
|
121
|
+
this.userToken = json.token;
|
|
122
|
+
}
|
|
89
123
|
return json;
|
|
90
124
|
} catch (err) {
|
|
91
125
|
console.error(err);
|
|
@@ -97,17 +131,20 @@ class SidechatAPIClient {
|
|
|
97
131
|
* Initiate the email setup process. Should be followed up with checkEmailVerification().
|
|
98
132
|
* @method
|
|
99
133
|
* @param {String} email - school email address to send verification code to
|
|
100
|
-
* @
|
|
134
|
+
* @tutorial Email Registration
|
|
101
135
|
*/
|
|
102
|
-
|
|
136
|
+
registerEmail = async (email) => {
|
|
137
|
+
if (!this.userToken) {
|
|
138
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
139
|
+
}
|
|
103
140
|
try {
|
|
104
141
|
const res = await fetch(
|
|
105
142
|
`https://api.sidechat.lol/v2/users/register_email`,
|
|
106
143
|
{
|
|
107
144
|
method: "POST",
|
|
108
145
|
headers: {
|
|
109
|
-
...defaultHeaders,
|
|
110
|
-
Authorization: `Bearer ${
|
|
146
|
+
...this.defaultHeaders,
|
|
147
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
111
148
|
},
|
|
112
149
|
body: JSON.stringify({
|
|
113
150
|
email: email,
|
|
@@ -128,17 +165,19 @@ class SidechatAPIClient {
|
|
|
128
165
|
/**
|
|
129
166
|
* Check is the user's email is verified.
|
|
130
167
|
* @method
|
|
131
|
-
* @param {String} token - user bearer token
|
|
132
168
|
*/
|
|
133
|
-
|
|
169
|
+
checkEmailVerification = async () => {
|
|
170
|
+
if (!this.userToken) {
|
|
171
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
172
|
+
}
|
|
134
173
|
try {
|
|
135
174
|
const res = await fetch(
|
|
136
175
|
`https://api.sidechat.lol/v1/users/check_email_verified`,
|
|
137
176
|
{
|
|
138
177
|
method: "GET",
|
|
139
178
|
headers: {
|
|
140
|
-
...defaultHeaders,
|
|
141
|
-
Authorization: `Bearer ${
|
|
179
|
+
...this.defaultHeaders,
|
|
180
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
142
181
|
},
|
|
143
182
|
}
|
|
144
183
|
);
|
|
@@ -158,17 +197,19 @@ class SidechatAPIClient {
|
|
|
158
197
|
* Set the device ID of the current user
|
|
159
198
|
* @method
|
|
160
199
|
* @param {String} deviceId - the device ID to set
|
|
161
|
-
* @param {String} token - the user bearer token
|
|
162
200
|
*/
|
|
163
|
-
|
|
201
|
+
setDeviceID = async (deviceID) => {
|
|
202
|
+
if (!this.userToken) {
|
|
203
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
204
|
+
}
|
|
164
205
|
try {
|
|
165
206
|
const res = await fetch(
|
|
166
207
|
`https://api.sidechat.lol/v1/register_device_token`,
|
|
167
208
|
{
|
|
168
209
|
method: "POST",
|
|
169
210
|
headers: {
|
|
170
|
-
...defaultHeaders,
|
|
171
|
-
Authorization: `Bearer ${
|
|
211
|
+
...this.defaultHeaders,
|
|
212
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
172
213
|
},
|
|
173
214
|
body: JSON.stringify({
|
|
174
215
|
build_type: "release",
|
|
@@ -189,18 +230,20 @@ class SidechatAPIClient {
|
|
|
189
230
|
/**
|
|
190
231
|
* Get updated status for user and group
|
|
191
232
|
* @method
|
|
192
|
-
* @param {String} token - user bearer token
|
|
193
233
|
* @param {String} [groupID] - ID of a specific group to retrieve info from
|
|
194
234
|
*/
|
|
195
|
-
|
|
235
|
+
getUserAndGroup = async (groupID = "") => {
|
|
236
|
+
if (!this.userToken) {
|
|
237
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
238
|
+
}
|
|
196
239
|
try {
|
|
197
240
|
const res = await fetch(
|
|
198
241
|
`https://api.sidechat.lol/v1/updates?group_id=${groupID}`,
|
|
199
242
|
{
|
|
200
243
|
method: "GET",
|
|
201
244
|
headers: {
|
|
202
|
-
...defaultHeaders,
|
|
203
|
-
Authorization: `Bearer ${
|
|
245
|
+
...this.defaultHeaders,
|
|
246
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
204
247
|
},
|
|
205
248
|
}
|
|
206
249
|
);
|
|
@@ -216,12 +259,14 @@ class SidechatAPIClient {
|
|
|
216
259
|
* Fetches posts from the specified category in a group
|
|
217
260
|
* @method
|
|
218
261
|
* @param {String} groupID - group ID
|
|
219
|
-
* @param {String} token - user bearer token
|
|
220
262
|
* @param {"hot"|"recent"|"top"} category - category to filter posts
|
|
221
263
|
* @param {SidechatCursorString} [cursor] - cursor string
|
|
222
|
-
* @returns {
|
|
264
|
+
* @returns {SidechatPostsAndCursor} List of posts and cursor
|
|
223
265
|
*/
|
|
224
|
-
|
|
266
|
+
getGroupPosts = async (groupID, category = "hot", cursor) => {
|
|
267
|
+
if (!this.userToken) {
|
|
268
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
269
|
+
}
|
|
225
270
|
try {
|
|
226
271
|
const res = await fetch(
|
|
227
272
|
`https://api.sidechat.lol/v1/posts?group_id=${groupID}&type=${category}${
|
|
@@ -230,8 +275,8 @@ class SidechatAPIClient {
|
|
|
230
275
|
{
|
|
231
276
|
method: "GET",
|
|
232
277
|
headers: {
|
|
233
|
-
...defaultHeaders,
|
|
234
|
-
Authorization: `Bearer ${
|
|
278
|
+
...this.defaultHeaders,
|
|
279
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
235
280
|
},
|
|
236
281
|
}
|
|
237
282
|
);
|
|
@@ -247,16 +292,18 @@ class SidechatAPIClient {
|
|
|
247
292
|
* Upvote or downvote, or unvote a post
|
|
248
293
|
* @method
|
|
249
294
|
* @param {String} postID - post ID to vote on
|
|
250
|
-
* @param {String} token - user bearer token
|
|
251
295
|
* @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
|
|
252
296
|
*/
|
|
253
|
-
|
|
297
|
+
setVote = async (postID, action) => {
|
|
298
|
+
if (!this.userToken) {
|
|
299
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
300
|
+
}
|
|
254
301
|
try {
|
|
255
302
|
const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {
|
|
256
303
|
method: "POST",
|
|
257
304
|
headers: {
|
|
258
|
-
...defaultHeaders,
|
|
259
|
-
Authorization: `Bearer ${
|
|
305
|
+
...this.defaultHeaders,
|
|
306
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
260
307
|
},
|
|
261
308
|
body: JSON.stringify({
|
|
262
309
|
post_id: postID,
|
|
@@ -275,18 +322,20 @@ class SidechatAPIClient {
|
|
|
275
322
|
* Get all the commments on a post
|
|
276
323
|
* @method
|
|
277
324
|
* @param {String} postID - post ID to get comments for
|
|
278
|
-
* @param {String} token - user bearer token
|
|
279
325
|
* @returns {SidechatPostOrComment[]} list of comments
|
|
280
326
|
*/
|
|
281
|
-
|
|
327
|
+
getPostComments = async (postID) => {
|
|
328
|
+
if (!this.userToken) {
|
|
329
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
330
|
+
}
|
|
282
331
|
try {
|
|
283
332
|
const res = await fetch(
|
|
284
333
|
`https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,
|
|
285
334
|
{
|
|
286
335
|
method: "GET",
|
|
287
336
|
headers: {
|
|
288
|
-
...defaultHeaders,
|
|
289
|
-
Authorization: `Bearer ${
|
|
337
|
+
...this.defaultHeaders,
|
|
338
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
290
339
|
},
|
|
291
340
|
}
|
|
292
341
|
);
|
|
@@ -347,20 +396,22 @@ class SidechatAPIClient {
|
|
|
347
396
|
/**
|
|
348
397
|
* Gets groups to be displayed on the "Explore Groups" page
|
|
349
398
|
* @method
|
|
350
|
-
* @
|
|
351
|
-
* @returns {SidechatGroup}
|
|
399
|
+
* @returns {SidechatGroup[]}
|
|
352
400
|
*/
|
|
353
|
-
|
|
401
|
+
getAvailableGroups = async () => {
|
|
402
|
+
if (!this.userToken) {
|
|
403
|
+
throw new SidechatAPIError("User is not authenticated.");
|
|
404
|
+
}
|
|
354
405
|
try {
|
|
355
406
|
const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {
|
|
356
407
|
method: "GET",
|
|
357
408
|
headers: {
|
|
358
|
-
...defaultHeaders,
|
|
359
|
-
Authorization: `Bearer ${
|
|
409
|
+
...this.defaultHeaders,
|
|
410
|
+
Authorization: `Bearer ${this.userToken}`,
|
|
360
411
|
},
|
|
361
412
|
});
|
|
362
413
|
const json = await res.json();
|
|
363
|
-
return json.groups;
|
|
414
|
+
return await json.groups;
|
|
364
415
|
} catch (err) {
|
|
365
416
|
console.error(err);
|
|
366
417
|
throw new SidechatAPIError(`Failed to get groups from explore.`);
|
package/src/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import SidechatAPIClient from "./classes/SidechatAPIClient";
|
|
2
|
-
import SidechatAPIError from "./classes/SidechatAPIError";
|
|
1
|
+
import SidechatAPIClient from "./classes/SidechatAPIClient.js";
|
|
2
|
+
import SidechatAPIError from "./classes/SidechatAPIError.js";
|
|
3
3
|
|
|
4
4
|
export { SidechatAPIClient, SidechatAPIError };
|
package/src/tests/basicTest.js
CHANGED
|
@@ -1,8 +1,19 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { SidechatAPIClient } from "../index.js";
|
|
2
|
+
import PromptSync from "prompt-sync";
|
|
3
|
+
const prompt = new PromptSync();
|
|
2
4
|
|
|
3
5
|
async function main() {
|
|
4
|
-
const
|
|
5
|
-
|
|
6
|
+
const API = new SidechatAPIClient(
|
|
7
|
+
"eyJhbGciOiJIUzI1NiJ9.ZTViNjFiMzktM2UwNi00NGU1LTg1M2YtMTg2MDNhOWQzOWM5.gOl2_HPyPzcyNpTXqSQEuJ3ZUmZi7Zq_vSBoRfbKA1A"
|
|
8
|
+
);
|
|
9
|
+
if (API.userToken) {
|
|
10
|
+
const phoneNum = prompt("Phone number: ");
|
|
11
|
+
await API.loginViaSMS(phoneNum);
|
|
12
|
+
const code = prompt("Code: ");
|
|
13
|
+
await API.verifySMSCode(phoneNum, code);
|
|
14
|
+
console.log("User auth token:", API.userToken);
|
|
15
|
+
} else {
|
|
16
|
+
}
|
|
6
17
|
}
|
|
7
18
|
|
|
8
19
|
main();
|
|
@@ -74,6 +74,22 @@
|
|
|
74
74
|
*/
|
|
75
75
|
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* A vote on a comment or post
|
|
78
78
|
* @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
|
|
79
79
|
*/
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* A user's bearer authentication token needed for most requests
|
|
83
|
+
* @typedef {String} SidechatAuthToken
|
|
84
|
+
*/
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* A list of posts and the associated cursor
|
|
88
|
+
* @typedef {Object} SidechatPostsAndCursor
|
|
89
|
+
* @prop {SidechatPostOrComment[]} posts
|
|
90
|
+
* @prop {SidechatCursorString} cursor
|
|
91
|
+
*/
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* @tutorial Hello world
|
|
95
|
+
*/
|