Refs: #AR-8376 sdk ref updated

.gitignore

@@ -3,5 +3,5 @@ dist/
 types/
 test/
 *.log
-
+htmldocs/
 .DS_Store

package.json

@@ -18,6 +18,7 @@
     "typecheck": "tsc --noEmit --skipLibCheck",
     "lint": "eslint ./src --ext .js,.jsx,.ts,.tsx",
     "prettier": "prettier --write .",
+    "htmldocs": "typedoc --options typedochtml.json",
     "clean": "rimraf dist/ && rimraf types/",
     "prepublishOnly": "yarn run build"
   },
@@ -35,6 +36,12 @@
     "rimraf": "^3.0.2",
     "rollup": "2.79.1",
     "tslib": "^2.4.1",
+    "typedoc": "^0.26.3",
+    "typedoc-plugin-extras": "^3.0.0",
+    "typedoc-plugin-markdown": "^4.2.3",
+    "typedoc-plugin-missing-exports": "^3.0.0",
+    "typedoc-plugin-rename-defaults": "^0.7.1",
+    "typedoc-material-theme": "^1.1.0",
     "typescript": "^4.9.3"
   }
 }

typedoc-theme/an_style.css

@@ -0,0 +1,96 @@
+@import url('https://fonts.googleapis.com/css2?family=Inter:wght@100;200;300;400;600;800&display=block');
+
+:root > * {
+  font-size: 14px;
+
+  /* Change default colors in the material theme */
+  font-family: 'Inter', sans-serif;
+  --md-an-color: var(--md-sys-color-surface);
+}
+
+footer {
+  border-top: 0;
+  text-align: center;
+}
+
+:root[data-theme='dark'] {
+  --md-an-color: #0a0a0a;
+  border-radius: 9px;
+}
+
+.tsd-page-toolbar {
+  border: 0;
+  border-radius: 5px;
+}
+
+.tsd-theme-toggle {
+  padding-top: 0.75rem;
+}
+.tsd-theme-toggle > h4 {
+  display: inline;
+  vertical-align: middle;
+  margin-right: 0.75rem;
+}
+
+.tsd-generator > p {
+  font-style: italic;
+}
+
+div.tsd-signature,
+.tsd-signature,
+.tsd-signature.tsd-signature,
+.tsd-signature.tsd-anchor-link {
+  border-radius: 9px;
+  border: 0.05rem solid #ff4e9f;
+  background-color: var(--md-an-color);
+}
+
+pre > button {
+  position: absolute;
+  top: 10px;
+  right: 10px;
+  opacity: 0;
+  transition: opacity 0.1s;
+  box-sizing: border-box;
+  border: 0;
+}
+
+code,
+pre {
+  font-family: Menlo, Monaco, Consolas, 'Courier New', monospace;
+  padding: 0.4rem;
+  margin: 0;
+  font-size: 0.75rem;
+  border: 0;
+  border-radius: 0.8em;
+}
+
+h1 {
+  font-size: 1.5rem;
+  margin: 0.67rem 0;
+}
+
+h2 {
+  font-size: 1.2rem;
+  margin: 0.83rem 0;
+}
+
+h3 {
+  font-size: 1rem;
+  margin: 1rem 0;
+}
+
+h4 {
+  font-size: 0.85rem;
+  margin: 1.33rem 0;
+}
+
+h5 {
+  font-size: 0.8rem;
+  margin: 1.5rem 0;
+}
+
+h6 {
+  font-size: 0.7rem;
+  margin: 2.33rem 0;
+}

typedochtml.json

@@ -0,0 +1,25 @@
+{
+  "sidebarLinks": {
+        "Docs": "https://docs.arcana.network",
+  },
+  "entryPoints": ["src/index.ts"],
+  "entryPointStrategy": "expand",
+  "name": "Auth Web3-React SDK Reference",
+  "out": "htmldocs",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "gitRevision": "main",
+  "excludeInternal": true,
+  "includeVersion": true,
+  "footerDate": true,
+  "footerTime": true,
+  "hideGenerator": true,
+  "plugin": [
+    "typedoc-plugin-extras",
+    "typedoc-plugin-rename-defaults",
+    "typedoc-material-theme"
+  ],
+  "themeColor": "#ff4e9f",
+  "customFooterHtml": "<p> Copyright © <strong>Arcana Technologies Ltd. </strong>All rights reserved</p>",
+  "customCss": "./typedoc-theme/an_style.css"
+}