typedoc generation

.jsdoc.json

@@ -0,0 +1,27 @@
+{
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc"]
+    },
+    "source": {
+        "include": ["src", "package.json", "README.md"],
+        "includePattern": ".ts$",
+        "excludePattern": "(node_modules/|docs|dist|examples|test)"
+    },
+    "plugins": [
+        "plugins/markdown"
+    ],
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": true,
+        "useLongnameInNav": false,
+        "showInheritedInNav": true
+    },
+    "opts": {
+        "destination": "./docs/",
+        "encoding": "utf8",
+        "private": true,
+        "recurse": true,
+        "template": "./node_modules/minami"
+    }
+}

diagrams/account-creation-webpage-workflow.mmd

@@ -0,0 +1,23 @@
+sequenceDiagram
+    actor u as User
+    participant a as Web Page App
+    participant s as Signify
+    participant c as Cloud Agent
+    u ->> a: Create Account
+    a ->>+ s: Generate Pub/Pri Keys
+    s ->>- a: Return new Pub/Pri Keypair
+    a ->>+ c: Request ICP Event Creation with Keys
+    note over s,c: This call can not be secured
+    note right of c: Creates ICP Event
+    c ->>- a: Return ICP event
+    a ->>+ s: Sign ICP Event
+    s ->>- a: Return Signed Event
+    a ->>+ c: Create Account with Signed ICP Event
+    note over s,c: Call Signed by new Keys
+    note right of c: Parses and Saves ICP
+    note right of c: Create Account with new AID
+    c ->>- a: Return New Account KeyState
+    a ->>+ s: Save Key Information
+    s ->>+ c: Save Key Information
+    c ->>- s: Key Information Saved
+    a ->> u: Return New Account Information

diagrams/account-creation-workflow.mmd

@@ -0,0 +1,18 @@
+sequenceDiagram
+    actor u as User
+    participant s as Signify
+    participant c as Cloud Agent
+    u ->> s: Create Account
+    s ->> s: Generate Pub/Pri Keys
+    s ->>+ c: Request ICP Event Creation with Keys
+    note over s,c: This call can not be secured
+    note right of c: Creates ICP Event
+    c ->>- s: Return ICP event
+    s ->>+ c: Create Account with Signed ICP Event
+    note over s,c: Call Signed by new Keys
+    note right of c: Parses and Saves ICP
+    note right of c: Create Account with new AID
+    c ->>- s: Return New Account KeyState
+    s ->>+ c: Save Key Information
+    c ->>- s: Key Information Saved
+    s ->> u: Return New Account Information

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,43 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+pre, code { background: var(--code-background); }