feat(docs): (cb52a8d) feat: Update peer-did creation and resolution i…

…nline with … (#14) Signed-off-by: Ahmed Moussa <ahmed.moussa@iohk.io>
input-output-hk · Feb 6, 2024 · 1d5f68f · 1d5f68f
1 parent c0c572e
commit 1d5f68f
Show file tree

Hide file tree

Showing 47 changed files with 627 additions and 120 deletions.
diff --git a/...d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/encode-individual-service.html b/...d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/encode-individual-service.html
@@ -0,0 +1,81 @@
+<!DOCTYPE html>
+<html class="no-js">
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>encodeIndividualService</title>
+    <link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
+    <script>var pathToRoot = "../../";</script>
+    <script>document.documentElement.classList.replace("no-js","js");</script>
+    <script>const storage = localStorage.getItem("dokka-dark-mode")
+    if (storage == null) {
+        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
+        if (osDarkSchemePreferred === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    } else {
+        const savedDarkMode = JSON.parse(storage)
+        if(savedDarkMode === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    }
+    </script>
+<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
+<link href="../../styles/style.css" rel="Stylesheet">
+<link href="../../styles/main.css" rel="Stylesheet">
+<link href="../../styles/prism.css" rel="Stylesheet">
+<link href="../../styles/logo-styles.css" rel="Stylesheet">
+<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
+<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
+<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
+<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
+<link href="../../images/Logo.png">
+</head>
+<body>
+    <div class="root">
+<nav class="navigation" id="navigation-wrapper">
+    <div class="navigation--inner">
+        <div class="navigation-title">
+            <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
+            <div class="library-name">
+                    <a class="library-name--link" href="../../index.html">
+                            DIDCommDIDPeer
+                    </a>
+            </div>
+            <div class="library-version">
+1.0.0            </div>
+        </div>
+        <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector common-like" data-active="" data-filter=":didpeer:dokkaHtml/commonMain">common</button>
+        </div>
+    </div>
+    <div class="navigation-controls">
+        <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
+        <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
+    </div>
+</nav>
+        <div id="container">
+            <div class="sidebar" id="leftColumn">
+                <div class="sidebar--inner" id="sideMenu"></div>
+            </div>
+            <div id="main">
+<div class="main-content" data-page-type="member" id="content" pageIds="DIDCommDIDPeer::io.iohk.atala.prism.didcomm.didpeer.core//encodeIndividualService/#kotlin.String/PointingToDeclaration//-398363967">
+  <div class="breadcrumbs"><a href="../../index.html">DIDCommDIDPeer</a><span class="delimiter">/</span><a href="index.html">io.iohk.atala.prism.didcomm.didpeer.core</a><span class="delimiter">/</span><span class="current">encodeIndividualService</span></div>
+  <div class="cover ">
+    <h1 class="cover"><span>encode</span><wbr></wbr><span>Individual</span><wbr></wbr><span><span>Service</span></span></h1>
+  </div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":didpeer:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="encode-individual-service.html"><span class="token function">encodeIndividualService</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">service<span class="token operator">: </span><a href="../io.iohk.atala.prism.didcomm.didpeer/-j-s-o-n/index.html">JSON</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-didcomm-kmm/tree/main/src/commonMain/kotlin/io/iohk/atala/prism/didcomm/didpeer/core/PeerDIDHelper.kt#L103">source</a>)</span></span></div><p class="paragraph">Encodes an individual service object according to the second algorithm.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The encoded service string</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>service</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The service object to encode</p></div></div></div></div></div></div></div>
+</div>
+      <div class="footer">
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
+                class="pull-right"><span>Generated by </span><a
+                href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+      </div>
+            </div>
+        </div>
+    </div>
+</body>
+</html>
diff --git a/-d-i-d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/from-json-to-list.html b/-d-i-d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/from-json-to-list.html
@@ -67,7 +67,7 @@
   <div class="cover ">
     <h1 class="cover"><span>from</span><wbr></wbr><span>Json</span><wbr></wbr><span>To</span><wbr></wbr><span><span>List</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":didpeer:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="from-json-to-list.html"><span class="token function">fromJsonToList</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-didcomm-kmm/tree/main/src/commonMain/kotlin/io/iohk/atala/prism/didcomm/didpeer/core/Utils.kt#L116">source</a>)</span></span></div><p class="paragraph">Converts a JSON string to a List of Maps.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The converted List of Maps.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>value</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The JSON string to convert.</p></div></div></div></div></div><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if the JSON string is not valid.</p></div></div></div></div></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":didpeer:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="from-json-to-list.html"><span class="token function">fromJsonToList</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-didcomm-kmm/tree/main/src/commonMain/kotlin/io/iohk/atala/prism/didcomm/didpeer/core/Utils.kt#L118">source</a>)</span></span></div><p class="paragraph">Converts a JSON string to a List of Maps.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The converted List of Maps.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>value</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The JSON string to convert.</p></div></div></div></div></div><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if the JSON string is not valid.</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

diff --git a/-d-i-d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/from-json-to-map.html b/-d-i-d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/from-json-to-map.html
@@ -67,7 +67,7 @@
   <div class="cover ">
     <h1 class="cover"><span>from</span><wbr></wbr><span>Json</span><wbr></wbr><span>To</span><wbr></wbr><span><span>Map</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":didpeer:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="from-json-to-map.html"><span class="token function">fromJsonToMap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-didcomm-kmm/tree/main/src/commonMain/kotlin/io/iohk/atala/prism/didcomm/didpeer/core/Utils.kt#L143">source</a>)</span></span></div><p class="paragraph">Converts a JSON string to a Map<String, Any> object.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The converted Map<String, Any> object.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>value</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The JSON string to convert.</p></div></div></div></div></div><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if the JSON string is not valid or if the value of any key in the JSON object is not of type JsonPrimitive or JsonArray.</p></div></div></div></div></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":didpeer:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="from-json-to-map.html"><span class="token function">fromJsonToMap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/input-output-hk/atala-prism-didcomm-kmm/tree/main/src/commonMain/kotlin/io/iohk/atala/prism/didcomm/didpeer/core/Utils.kt#L145">source</a>)</span></span></div><p class="paragraph">Converts a JSON string to a Map<String, Any> object.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">The converted Map<String, Any> object.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>value</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The JSON string to convert.</p></div></div></div></div></div><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if the JSON string is not valid or if the value of any key in the JSON object is not of type JsonPrimitive or JsonArray.</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

diff --git a/-d-i-d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/index.html b/-d-i-d-comm-d-i-d-peer/io.iohk.atala.prism.didcomm.didpeer.core/index.html
@@ -91,7 +91,22 @@ <h2 class="">Types</h2>
       </div>
       <div data-togglable="FUNCTION">
         <h2 class="">Functions</h2>
-        <div class="table"><a data-name="1510304505%2FFunctions%2F-398363967" anchor-label="encodeToString" id="1510304505%2FFunctions%2F-398363967" data-filterable-set=":didpeer:dokkaHtml/commonMain"></a>
+        <div class="table"><a data-name="-370788055%2FFunctions%2F-398363967" anchor-label="encodeIndividualService" id="-370788055%2FFunctions%2F-398363967" data-filterable-set=":didpeer:dokkaHtml/commonMain"></a>
+          <div class="table-row" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain">
+            <div class="main-subrow keyValue ">
+              <div class=""><span class="inline-flex">
+                  <div><a href="encode-individual-service.html"><span>encode</span><wbr></wbr><span>Individual</span><wbr></wbr><span><span>Service</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-370788055%2FFunctions%2F-398363967"></span>
+                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                  </span></span></div>
+              <div>
+                <div class="title">
+                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":didpeer:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="encode-individual-service.html"><span class="token function">encodeIndividualService</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">service<span class="token operator">: </span><a href="../io.iohk.atala.prism.didcomm.didpeer/-j-s-o-n/index.html">JSON</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">Encodes an individual service object according to the second algorithm.</p></div></div></div>
+                </div>
+              </div>
+            </div>
+          </div>
+<a data-name="1510304505%2FFunctions%2F-398363967" anchor-label="encodeToString" id="1510304505%2FFunctions%2F-398363967" data-filterable-set=":didpeer:dokkaHtml/commonMain"></a>
           <div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":didpeer:dokkaHtml/commonMain" data-filterable-set=":didpeer:dokkaHtml/commonMain">
             <div class="main-subrow keyValue ">
               <div class=""><span class="inline-flex">