Skip to content

Commit b35e604

Browse files
author
Paul Le Cam
authored
Merge pull request #29 from ceramicnetwork/feat/did-provider-type
Update dependencies to export DIDProvider and related types
2 parents f86c993 + c137bbd commit b35e604

30 files changed

+17032
-2442
lines changed

‎docs/assets/css/main.css‎

Lines changed: 2660 additions & 1 deletion
Large diffs are not rendered by default.

‎docs/assets/js/main.js‎

Lines changed: 248 additions & 51 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/js/search.json‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/classes/did.html‎

Lines changed: 71 additions & 94 deletions
Large diffs are not rendered by default.

‎docs/globals.html‎

Lines changed: 0 additions & 432 deletions
This file was deleted.

‎docs/index.html‎

Lines changed: 93 additions & 94 deletions
Large diffs are not rendered by default.

‎docs/interfaces/authenticateoptions.html‎

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>AuthenticateOptions | DID - v2.0.0</title>
7-
<meta name="description" content="Documentation for DID - v2.0.0">
6+
<title>AuthenticateOptions | DID - v2.1.0</title>
7+
<meta name="description" content="Documentation for DID - v2.1.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
10+
<script async src="../assets/js/search.js" id="search-script"></script>
1011
</head>
1112
<body>
1213
<header>
@@ -22,7 +23,7 @@
2223
<li class="state loading">Preparing search index...</li>
2324
<li class="state failure">The search index is not available</li>
2425
</ul>
25-
<a href="../index.html" class="title">DID - v2.0.0</a>
26+
<a href="../index.html" class="title">DID - v2.1.0</a>
2627
</div>
2728
<div class="table-cell" id="tsd-widgets">
2829
<div id="tsd-filter">
@@ -40,8 +41,6 @@
4041
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
4142
<input type="checkbox" id="tsd-filter-externals" checked />
4243
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43-
<input type="checkbox" id="tsd-filter-only-exported" />
44-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4544
</div>
4645
</div>
4746
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@@ -53,7 +52,7 @@
5352
<div class="container">
5453
<ul class="tsd-breadcrumb">
5554
<li>
56-
<a href="../globals.html">Globals</a>
55+
<a href="../modules.html">DID - v2.1.0</a>
5756
</li>
5857
<li>
5958
<a href="authenticateoptions.html">AuthenticateOptions</a>
@@ -94,30 +93,30 @@ <h2>Properties</h2>
9493
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
9594
<a name="aud" class="tsd-anchor"></a>
9695
<h3><span class="tsd-flag ts-flagOptional">Optional</span> aud</h3>
97-
<div class="tsd-signature tsd-kind-icon">aud<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
96+
<div class="tsd-signature tsd-kind-icon">aud<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
9897
<aside class="tsd-sources">
9998
<ul>
100-
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/5031b5f/src/index.ts#L21">src/index.ts:21</a></li>
99+
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/f86c993/src/index.ts#L21">src/index.ts:21</a></li>
101100
</ul>
102101
</aside>
103102
</section>
104103
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
105104
<a name="paths" class="tsd-anchor"></a>
106105
<h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
107-
<div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
106+
<div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
108107
<aside class="tsd-sources">
109108
<ul>
110-
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/5031b5f/src/index.ts#L22">src/index.ts:22</a></li>
109+
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/f86c993/src/index.ts#L22">src/index.ts:22</a></li>
111110
</ul>
112111
</aside>
113112
</section>
114113
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
115114
<a name="provider" class="tsd-anchor"></a>
116115
<h3><span class="tsd-flag ts-flagOptional">Optional</span> provider</h3>
117-
<div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <a href="../globals.html#didprovider" class="tsd-signature-type">DIDProvider</a></div>
116+
<div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <a href="../modules.html#didprovider" class="tsd-signature-type" data-tsd-kind="Type alias">DIDProvider</a></div>
118117
<aside class="tsd-sources">
119118
<ul>
120-
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/5031b5f/src/index.ts#L20">src/index.ts:20</a></li>
119+
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/f86c993/src/index.ts#L20">src/index.ts:20</a></li>
121120
</ul>
122121
</aside>
123122
</section>
@@ -126,8 +125,8 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> provider</h3>
126125
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
127126
<nav class="tsd-navigation primary">
128127
<ul>
129-
<li class="globals ">
130-
<a href="../globals.html"><em>Globals</em></a>
128+
<li class=" ">
129+
<a href="../modules.html">Exports</a>
131130
</li>
132131
</ul>
133132
</nav>
@@ -175,8 +174,8 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> provider</h3>
175174
<li class=" tsd-kind-interface">
176175
<a href="didoptions.html" class="tsd-kind-icon">DIDOptions</a>
177176
</li>
178-
<li class=" tsd-kind-interface">
179-
<a href="dagjws.html" class="tsd-kind-icon">DagJWS</a>
177+
<li class=" tsd-kind-interface tsd-is-external">
178+
<a href="didresolutionresult.html" class="tsd-kind-icon">DIDResolution<wbr>Result</a>
180179
</li>
181180
<li class=" tsd-kind-interface">
182181
<a href="dagjwsresult.html" class="tsd-kind-icon">DagJWSResult</a>
@@ -190,41 +189,41 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> provider</h3>
190189
<li class=" tsd-kind-interface">
191190
<a href="decryptjweresult.html" class="tsd-kind-icon">DecryptJWEResult</a>
192191
</li>
193-
<li class=" tsd-kind-interface">
194-
<a href="jwssignature.html" class="tsd-kind-icon">JWSSignature</a>
195-
</li>
196192
<li class=" tsd-kind-interface">
197193
<a href="verifyjwsresult.html" class="tsd-kind-icon">VerifyJWSResult</a>
198194
</li>
199195
<li class=" tsd-kind-type-alias">
200-
<a href="../globals.html#didprovider" class="tsd-kind-icon">DIDProvider</a>
196+
<a href="../modules.html#authparams" class="tsd-kind-icon">Auth<wbr>Params</a>
201197
</li>
202-
<li class=" tsd-kind-variable">
203-
<a href="../globals.html#b64" class="tsd-kind-icon">B64</a>
198+
<li class=" tsd-kind-type-alias">
199+
<a href="../modules.html#didmethodname" class="tsd-kind-icon">DIDMethod<wbr>Name</a>
200+
</li>
201+
<li class=" tsd-kind-type-alias">
202+
<a href="../modules.html#didprovider" class="tsd-kind-icon">DIDProvider</a>
204203
</li>
205-
<li class=" tsd-kind-variable">
206-
<a href="../globals.html#b64_url" class="tsd-kind-icon">B64_<wbr>URL</a>
204+
<li class=" tsd-kind-type-alias">
205+
<a href="../modules.html#didproviderclient" class="tsd-kind-icon">DIDProvider<wbr>Client</a>
207206
</li>
208-
<li class=" tsd-kind-function">
209-
<a href="../globals.html#base64urltojson" class="tsd-kind-icon">base64url<wbr>ToJSON</a>
207+
<li class=" tsd-kind-type-alias">
208+
<a href="../modules.html#didprovidermethods" class="tsd-kind-icon">DIDProvider<wbr>Methods</a>
210209
</li>
211-
<li class=" tsd-kind-function">
212-
<a href="../globals.html#decodebase64" class="tsd-kind-icon">decode<wbr>Base64</a>
210+
<li class=" tsd-kind-type-alias">
211+
<a href="../modules.html#didproviderorclient" class="tsd-kind-icon">DIDProvider<wbr>OrClient</a>
213212
</li>
214-
<li class=" tsd-kind-function">
215-
<a href="../globals.html#encodebase64" class="tsd-kind-icon">encode<wbr>Base64</a>
213+
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
214+
<a href="../modules.html#didrequest" class="tsd-kind-icon">DIDRequest</a>
216215
</li>
217-
<li class=" tsd-kind-function">
218-
<a href="../globals.html#encodebase64url" class="tsd-kind-icon">encode<wbr>Base64<wbr>Url</a>
216+
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
217+
<a href="../modules.html#didresponse" class="tsd-kind-icon">DIDResponse</a>
219218
</li>
220-
<li class=" tsd-kind-function">
221-
<a href="../globals.html#fromdagjws" class="tsd-kind-icon">from<wbr>DagJWS</a>
219+
<li class=" tsd-kind-type-alias">
220+
<a href="../modules.html#dagjws" class="tsd-kind-icon">DagJWS</a>
222221
</li>
223-
<li class=" tsd-kind-function">
224-
<a href="../globals.html#isresolver" class="tsd-kind-icon">is<wbr>Resolver</a>
222+
<li class=" tsd-kind-type-alias">
223+
<a href="../modules.html#generaljws" class="tsd-kind-icon">GeneralJWS</a>
225224
</li>
226-
<li class=" tsd-kind-function">
227-
<a href="../globals.html#randomstring" class="tsd-kind-icon">random<wbr>String</a>
225+
<li class=" tsd-kind-type-alias">
226+
<a href="../modules.html#jwssignature" class="tsd-kind-icon">JWSSignature</a>
228227
</li>
229228
</ul>
230229
</nav>

‎docs/interfaces/authenticateparams.html‎

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>AuthenticateParams | DID - v2.0.0</title>
7-
<meta name="description" content="Documentation for DID - v2.0.0">
6+
<title>AuthenticateParams | DID - v2.1.0</title>
7+
<meta name="description" content="Documentation for DID - v2.1.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
10+
<script async src="../assets/js/search.js" id="search-script"></script>
1011
</head>
1112
<body>
1213
<header>
@@ -22,7 +23,7 @@
2223
<li class="state loading">Preparing search index...</li>
2324
<li class="state failure">The search index is not available</li>
2425
</ul>
25-
<a href="../index.html" class="title">DID - v2.0.0</a>
26+
<a href="../index.html" class="title">DID - v2.1.0</a>
2627
</div>
2728
<div class="table-cell" id="tsd-widgets">
2829
<div id="tsd-filter">
@@ -40,8 +41,6 @@
4041
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
4142
<input type="checkbox" id="tsd-filter-externals" checked />
4243
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43-
<input type="checkbox" id="tsd-filter-only-exported" />
44-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4544
</div>
4645
</div>
4746
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@@ -53,7 +52,7 @@
5352
<div class="container">
5453
<ul class="tsd-breadcrumb">
5554
<li>
56-
<a href="../globals.html">Globals</a>
55+
<a href="../modules.html">DID - v2.1.0</a>
5756
</li>
5857
<li>
5958
<a href="authenticateparams.html">AuthenticateParams</a>
@@ -73,7 +72,7 @@ <h3>Hierarchy</h3>
7372
<span class="target">AuthenticateParams</span>
7473
<ul class="tsd-hierarchy">
7574
<li>
76-
<a href="authenticateresponse.html" class="tsd-signature-type">AuthenticateResponse</a>
75+
<a href="authenticateresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticateResponse</a>
7776
</li>
7877
</ul>
7978
</li>
@@ -99,10 +98,10 @@ <h2>Properties</h2>
9998
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
10099
<a name="aud" class="tsd-anchor"></a>
101100
<h3><span class="tsd-flag ts-flagOptional">Optional</span> aud</h3>
102-
<div class="tsd-signature tsd-kind-icon">aud<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
101+
<div class="tsd-signature tsd-kind-icon">aud<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103102
<aside class="tsd-sources">
104103
<ul>
105-
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/5031b5f/src/index.ts#L27">src/index.ts:27</a></li>
104+
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/f86c993/src/index.ts#L27">src/index.ts:27</a></li>
106105
</ul>
107106
</aside>
108107
</section>
@@ -112,17 +111,17 @@ <h3>nonce</h3>
112111
<div class="tsd-signature tsd-kind-icon">nonce<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
113112
<aside class="tsd-sources">
114113
<ul>
115-
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/5031b5f/src/index.ts#L26">src/index.ts:26</a></li>
114+
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/f86c993/src/index.ts#L26">src/index.ts:26</a></li>
116115
</ul>
117116
</aside>
118117
</section>
119118
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
120119
<a name="paths" class="tsd-anchor"></a>
121120
<h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
122-
<div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
121+
<div class="tsd-signature tsd-kind-icon">paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
123122
<aside class="tsd-sources">
124123
<ul>
125-
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/5031b5f/src/index.ts#L28">src/index.ts:28</a></li>
124+
<li>Defined in <a href="https://github.com/ceramicnetwork/js-did/blob/f86c993/src/index.ts#L28">src/index.ts:28</a></li>
126125
</ul>
127126
</aside>
128127
</section>
@@ -131,8 +130,8 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
131130
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
132131
<nav class="tsd-navigation primary">
133132
<ul>
134-
<li class="globals ">
135-
<a href="../globals.html"><em>Globals</em></a>
133+
<li class=" ">
134+
<a href="../modules.html">Exports</a>
136135
</li>
137136
</ul>
138137
</nav>
@@ -180,8 +179,8 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
180179
<li class=" tsd-kind-interface">
181180
<a href="didoptions.html" class="tsd-kind-icon">DIDOptions</a>
182181
</li>
183-
<li class=" tsd-kind-interface">
184-
<a href="dagjws.html" class="tsd-kind-icon">DagJWS</a>
182+
<li class=" tsd-kind-interface tsd-is-external">
183+
<a href="didresolutionresult.html" class="tsd-kind-icon">DIDResolution<wbr>Result</a>
185184
</li>
186185
<li class=" tsd-kind-interface">
187186
<a href="dagjwsresult.html" class="tsd-kind-icon">DagJWSResult</a>
@@ -195,41 +194,41 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> paths</h3>
195194
<li class=" tsd-kind-interface">
196195
<a href="decryptjweresult.html" class="tsd-kind-icon">DecryptJWEResult</a>
197196
</li>
198-
<li class=" tsd-kind-interface">
199-
<a href="jwssignature.html" class="tsd-kind-icon">JWSSignature</a>
200-
</li>
201197
<li class=" tsd-kind-interface">
202198
<a href="verifyjwsresult.html" class="tsd-kind-icon">VerifyJWSResult</a>
203199
</li>
204200
<li class=" tsd-kind-type-alias">
205-
<a href="../globals.html#didprovider" class="tsd-kind-icon">DIDProvider</a>
201+
<a href="../modules.html#authparams" class="tsd-kind-icon">Auth<wbr>Params</a>
206202
</li>
207-
<li class=" tsd-kind-variable">
208-
<a href="../globals.html#b64" class="tsd-kind-icon">B64</a>
203+
<li class=" tsd-kind-type-alias">
204+
<a href="../modules.html#didmethodname" class="tsd-kind-icon">DIDMethod<wbr>Name</a>
205+
</li>
206+
<li class=" tsd-kind-type-alias">
207+
<a href="../modules.html#didprovider" class="tsd-kind-icon">DIDProvider</a>
209208
</li>
210-
<li class=" tsd-kind-variable">
211-
<a href="../globals.html#b64_url" class="tsd-kind-icon">B64_<wbr>URL</a>
209+
<li class=" tsd-kind-type-alias">
210+
<a href="../modules.html#didproviderclient" class="tsd-kind-icon">DIDProvider<wbr>Client</a>
212211
</li>
213-
<li class=" tsd-kind-function">
214-
<a href="../globals.html#base64urltojson" class="tsd-kind-icon">base64url<wbr>ToJSON</a>
212+
<li class=" tsd-kind-type-alias">
213+
<a href="../modules.html#didprovidermethods" class="tsd-kind-icon">DIDProvider<wbr>Methods</a>
215214
</li>
216-
<li class=" tsd-kind-function">
217-
<a href="../globals.html#decodebase64" class="tsd-kind-icon">decode<wbr>Base64</a>
215+
<li class=" tsd-kind-type-alias">
216+
<a href="../modules.html#didproviderorclient" class="tsd-kind-icon">DIDProvider<wbr>OrClient</a>
218217
</li>
219-
<li class=" tsd-kind-function">
220-
<a href="../globals.html#encodebase64" class="tsd-kind-icon">encode<wbr>Base64</a>
218+
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
219+
<a href="../modules.html#didrequest" class="tsd-kind-icon">DIDRequest</a>
221220
</li>
222-
<li class=" tsd-kind-function">
223-
<a href="../globals.html#encodebase64url" class="tsd-kind-icon">encode<wbr>Base64<wbr>Url</a>
221+
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
222+
<a href="../modules.html#didresponse" class="tsd-kind-icon">DIDResponse</a>
224223
</li>
225-
<li class=" tsd-kind-function">
226-
<a href="../globals.html#fromdagjws" class="tsd-kind-icon">from<wbr>DagJWS</a>
224+
<li class=" tsd-kind-type-alias">
225+
<a href="../modules.html#dagjws" class="tsd-kind-icon">DagJWS</a>
227226
</li>
228-
<li class=" tsd-kind-function">
229-
<a href="../globals.html#isresolver" class="tsd-kind-icon">is<wbr>Resolver</a>
227+
<li class=" tsd-kind-type-alias">
228+
<a href="../modules.html#generaljws" class="tsd-kind-icon">GeneralJWS</a>
230229
</li>
231-
<li class=" tsd-kind-function">
232-
<a href="../globals.html#randomstring" class="tsd-kind-icon">random<wbr>String</a>
230+
<li class=" tsd-kind-type-alias">
231+
<a href="../modules.html#jwssignature" class="tsd-kind-icon">JWSSignature</a>
233232
</li>
234233
</ul>
235234
</nav>

0 commit comments

Comments
 (0)