@mountainpass/problem-document 0.0.2 → 0.0.3

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.
Files changed (16) hide show
  1. package/.gitattributes +3 -1
  2. package/.prettierignore +1 -0
  3. package/.prettierrc.json +3 -0
  4. package/docs/assets/css/main.css +2660 -0
  5. package/docs/assets/images/icons.png +0 -0
  6. package/docs/assets/images/icons@2x.png +0 -0
  7. package/docs/assets/images/widgets.png +0 -0
  8. package/docs/assets/images/widgets@2x.png +0 -0
  9. package/docs/assets/js/main.js +248 -0
  10. package/docs/assets/js/search.js +1 -0
  11. package/docs/classes/ProblemDocument.html +285 -0
  12. package/docs/index.html +108 -0
  13. package/docs/modules.html +206 -0
  14. package/lib/index.d.ts +489 -349
  15. package/lib/index.js +45 -1
  16. package/package.json +28 -4
package/docs/assets/js/search.js ADDED
@@ -0,0 +1 @@
1
+ window.searchData = {"kinds":{"128":"Class","512":"Constructor","1024":"Property","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":4194304,"name":"BaseProblemDocumentProperties","url":"modules.html#BaseProblemDocumentProperties","classes":"tsd-kind-type-alias"},{"id":1,"kind":65536,"name":"__type","url":"modules.html#BaseProblemDocumentProperties.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"BaseProblemDocumentProperties"},{"id":2,"kind":1024,"name":"type","url":"modules.html#BaseProblemDocumentProperties.__type.type","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BaseProblemDocumentProperties.__type"},{"id":3,"kind":1024,"name":"title","url":"modules.html#BaseProblemDocumentProperties.__type.title","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BaseProblemDocumentProperties.__type"},{"id":4,"kind":1024,"name":"status","url":"modules.html#BaseProblemDocumentProperties.__type.status","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BaseProblemDocumentProperties.__type"},{"id":5,"kind":1024,"name":"detail","url":"modules.html#BaseProblemDocumentProperties.__type.detail","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BaseProblemDocumentProperties.__type"},{"id":6,"kind":1024,"name":"instance","url":"modules.html#BaseProblemDocumentProperties.__type.instance","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"BaseProblemDocumentProperties.__type"},{"id":7,"kind":4194304,"name":"ProblemDocumentProperties","url":"modules.html#ProblemDocumentProperties","classes":"tsd-kind-type-alias"},{"id":8,"kind":128,"name":"ProblemDocument","url":"classes/ProblemDocument.html","classes":"tsd-kind-class"},{"id":9,"kind":512,"name":"constructor","url":"classes/ProblemDocument.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"ProblemDocument"},{"id":10,"kind":1024,"name":"detail","url":"classes/ProblemDocument.html#detail","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProblemDocument"},{"id":11,"kind":1024,"name":"instance","url":"classes/ProblemDocument.html#instance","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProblemDocument"},{"id":12,"kind":1024,"name":"status","url":"classes/ProblemDocument.html#status","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProblemDocument"},{"id":13,"kind":1024,"name":"title","url":"classes/ProblemDocument.html#title","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProblemDocument"},{"id":14,"kind":1024,"name":"type","url":"classes/ProblemDocument.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"ProblemDocument"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,18.563]],["parent/0",[]],["name/1",[1,23.671]],["parent/1",[0,1.684]],["name/2",[2,18.563]],["parent/2",[3,0.969]],["name/3",[4,18.563]],["parent/3",[3,0.969]],["name/4",[5,18.563]],["parent/4",[3,0.969]],["name/5",[6,18.563]],["parent/5",[3,0.969]],["name/6",[7,18.563]],["parent/6",[3,0.969]],["name/7",[8,23.671]],["parent/7",[]],["name/8",[9,7.577]],["parent/8",[]],["name/9",[10,23.671]],["parent/9",[9,0.687]],["name/10",[6,18.563]],["parent/10",[9,0.687]],["name/11",[7,18.563]],["parent/11",[9,0.687]],["name/12",[5,18.563]],["parent/12",[9,0.687]],["name/13",[4,18.563]],["parent/13",[9,0.687]],["name/14",[2,18.563]],["parent/14",[9,0.687]]],"invertedIndex":[["__type",{"_index":1,"name":{"1":{}},"parent":{}}],["baseproblemdocumentproperties",{"_index":0,"name":{"0":{}},"parent":{"1":{}}}],["baseproblemdocumentproperties.__type",{"_index":3,"name":{},"parent":{"2":{},"3":{},"4":{},"5":{},"6":{}}}],["constructor",{"_index":10,"name":{"9":{}},"parent":{}}],["detail",{"_index":6,"name":{"5":{},"10":{}},"parent":{}}],["instance",{"_index":7,"name":{"6":{},"11":{}},"parent":{}}],["problemdocument",{"_index":9,"name":{"8":{}},"parent":{"9":{},"10":{},"11":{},"12":{},"13":{},"14":{}}}],["problemdocumentproperties",{"_index":8,"name":{"7":{}},"parent":{}}],["status",{"_index":5,"name":{"4":{},"12":{}},"parent":{}}],["title",{"_index":4,"name":{"3":{},"13":{}},"parent":{}}],["type",{"_index":2,"name":{"2":{},"14":{}},"parent":{}}]],"pipeline":[]}}
package/docs/classes/ProblemDocument.html ADDED
@@ -0,0 +1,285 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ProblemDocument | @mountainpass/problem-document</title>
7
+ <meta name="description" content="Documentation for @mountainpass/problem-document">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@mountainpass/problem-document</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@mountainpass/problem-document</a>
56
+ </li>
57
+ <li>
58
+ <a href="ProblemDocument.html">ProblemDocument</a>
59
+ </li>
60
+ </ul>
61
+ <h1>Class ProblemDocument</h1>
62
+ </div>
63
+ </div>
64
+ </header>
65
+ <div class="container container-main">
66
+ <div class="row">
67
+ <div class="col-8 col-content">
68
+ <section class="tsd-panel tsd-comment">
69
+ <div class="tsd-comment tsd-typography">
70
+ <div class="lead">
71
+ <p>This class implements RFC7807 &quot;problem detail&quot;, a way to carry machine-
72
+ readable details of errors in a HTTP response to avoid the need to
73
+ define new error response formats for HTTP APIs.</p>
74
+ </div>
75
+ <p>Official Documentation @ <a href="https://datatracker.ietf.org/doc/html/rfc7807">https://datatracker.ietf.org/doc/html/rfc7807</a></p>
76
+ <p>Consumers MUST use the &quot;type&quot; string as the primary identifier for
77
+ the problem type; the &quot;title&quot; string is advisory and included only
78
+ for users who are not aware of the semantics of the URI and do not
79
+ have the ability to discover them (e.g., offline log analysis).
80
+ Consumers SHOULD NOT automatically dereference the type URI.</p>
81
+ <p>The &quot;status&quot; member, if present, is only advisory; it conveys the
82
+ HTTP status code used for the convenience of the consumer.
83
+ Generators MUST use the same status code in the actual HTTP response,
84
+ to assure that generic HTTP software that does not understand this
85
+ format still behaves correctly. See Section 5 for further caveats
86
+ regarding its use.</p>
87
+ <p>Consumers can use the status member to determine what the original
88
+ status code used by the generator was, in cases where it has been
89
+ changed (e.g., by an intermediary or cache), and when message bodies
90
+ persist without HTTP information. Generic HTTP software will still
91
+ use the HTTP status code.</p>
92
+ <p>The &quot;detail&quot; member, if present, ought to focus on helping the client
93
+ correct the problem, rather than giving debugging information.</p>
94
+ <p>Consumers SHOULD NOT parse the &quot;detail&quot; member for information;
95
+ extensions are more suitable and less error-prone ways to obtain such
96
+ information.</p>
97
+ <p>Note that both {@link BaseProblemDocumentProperties.type type} and {@link BaseProblemDocumentProperties.instance instance} accept relative URIs; this means
98
+ that they must be resolved relative to the document&#39;s base URI, as
99
+ per <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-5" class="external">[RFC3986], Section 5</a>.</p>
100
+ </div>
101
+ </section>
102
+ <section class="tsd-panel tsd-hierarchy">
103
+ <h3>Hierarchy</h3>
104
+ <ul class="tsd-hierarchy">
105
+ <li>
106
+ <span class="target">ProblemDocument</span>
107
+ </li>
108
+ </ul>
109
+ </section>
110
+ <section class="tsd-panel">
111
+ <h3>Implements</h3>
112
+ <ul class="tsd-hierarchy">
113
+ <li><a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a></li>
114
+ </ul>
115
+ </section>
116
+ <section class="tsd-panel tsd-kind-class">
117
+ <h3 class="tsd-before-signature">Indexable</h3>
118
+ <div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div>
119
+ </section>
120
+ <section class="tsd-panel-group tsd-index-group">
121
+ <h2>Index</h2>
122
+ <section class="tsd-panel tsd-index-panel">
123
+ <div class="tsd-index-content">
124
+ <section class="tsd-index-section ">
125
+ <h3>Constructors</h3>
126
+ <ul class="tsd-index-list">
127
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ProblemDocument.html#constructor" class="tsd-kind-icon">constructor</a></li>
128
+ </ul>
129
+ </section>
130
+ <section class="tsd-index-section ">
131
+ <h3>Properties</h3>
132
+ <ul class="tsd-index-list">
133
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#detail" class="tsd-kind-icon">detail</a></li>
134
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#instance" class="tsd-kind-icon">instance</a></li>
135
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#status" class="tsd-kind-icon">status</a></li>
136
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#title" class="tsd-kind-icon">title</a></li>
137
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#type" class="tsd-kind-icon">type</a></li>
138
+ </ul>
139
+ </section>
140
+ </div>
141
+ </section>
142
+ </section>
143
+ <section class="tsd-panel-group tsd-member-group ">
144
+ <h2>Constructors</h2>
145
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
146
+ <a name="constructor" class="tsd-anchor"></a>
147
+ <h3>constructor</h3>
148
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
149
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Problem<wbr>Document<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ProblemDocument.html" class="tsd-signature-type" data-tsd-kind="Class">ProblemDocument</a></li>
150
+ </ul>
151
+ <ul class="tsd-descriptions">
152
+ <li class="tsd-description">
153
+ <aside class="tsd-sources">
154
+ </aside>
155
+ <div class="tsd-comment tsd-typography">
156
+ <div class="lead">
157
+ <p>construct a new ProblemDocument instance</p>
158
+ </div>
159
+ </div>
160
+ <h4 class="tsd-parameters-title">Parameters</h4>
161
+ <ul class="tsd-parameters">
162
+ <li>
163
+ <h5>data: <a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a></h5>
164
+ <div class="tsd-comment tsd-typography">
165
+ <div class="lead">
166
+ <p>properties to assign to the new instance</p>
167
+ </div>
168
+ </div>
169
+ </li>
170
+ </ul>
171
+ <h4 class="tsd-returns-title">Returns <a href="ProblemDocument.html" class="tsd-signature-type" data-tsd-kind="Class">ProblemDocument</a></h4>
172
+ </li>
173
+ </ul>
174
+ </section>
175
+ </section>
176
+ <section class="tsd-panel-group tsd-member-group ">
177
+ <h2>Properties</h2>
178
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
179
+ <a name="detail" class="tsd-anchor"></a>
180
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> detail</h3>
181
+ <div class="tsd-signature tsd-kind-icon">detail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
182
+ <aside class="tsd-sources">
183
+ <p>Implementation of ProblemDocumentProperties.detail</p>
184
+ </aside>
185
+ </section>
186
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
187
+ <a name="instance" class="tsd-anchor"></a>
188
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> instance</h3>
189
+ <div class="tsd-signature tsd-kind-icon">instance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
190
+ <aside class="tsd-sources">
191
+ <p>Implementation of ProblemDocumentProperties.instance</p>
192
+ </aside>
193
+ </section>
194
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
195
+ <a name="status" class="tsd-anchor"></a>
196
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
197
+ <div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StatusCode</span></div>
198
+ <aside class="tsd-sources">
199
+ <p>Implementation of ProblemDocumentProperties.status</p>
200
+ </aside>
201
+ </section>
202
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
203
+ <a name="title" class="tsd-anchor"></a>
204
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
205
+ <div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
206
+ <aside class="tsd-sources">
207
+ <p>Implementation of ProblemDocumentProperties.title</p>
208
+ </aside>
209
+ </section>
210
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
211
+ <a name="type" class="tsd-anchor"></a>
212
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
213
+ <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
214
+ <aside class="tsd-sources">
215
+ <p>Implementation of ProblemDocumentProperties.type</p>
216
+ </aside>
217
+ </section>
218
+ </section>
219
+ </div>
220
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
221
+ <nav class="tsd-navigation primary">
222
+ <ul>
223
+ <li class=" ">
224
+ <a href="../modules.html">Exports</a>
225
+ </li>
226
+ </ul>
227
+ </nav>
228
+ <nav class="tsd-navigation secondary menu-sticky">
229
+ <ul class="before-current">
230
+ </ul>
231
+ <ul class="current">
232
+ <li class="current tsd-kind-class">
233
+ <a href="ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a>
234
+ <ul>
235
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
236
+ <a href="ProblemDocument.html#constructor" class="tsd-kind-icon">constructor</a>
237
+ </li>
238
+ <li class=" tsd-kind-property tsd-parent-kind-class">
239
+ <a href="ProblemDocument.html#detail" class="tsd-kind-icon">detail</a>
240
+ </li>
241
+ <li class=" tsd-kind-property tsd-parent-kind-class">
242
+ <a href="ProblemDocument.html#instance" class="tsd-kind-icon">instance</a>
243
+ </li>
244
+ <li class=" tsd-kind-property tsd-parent-kind-class">
245
+ <a href="ProblemDocument.html#status" class="tsd-kind-icon">status</a>
246
+ </li>
247
+ <li class=" tsd-kind-property tsd-parent-kind-class">
248
+ <a href="ProblemDocument.html#title" class="tsd-kind-icon">title</a>
249
+ </li>
250
+ <li class=" tsd-kind-property tsd-parent-kind-class">
251
+ <a href="ProblemDocument.html#type" class="tsd-kind-icon">type</a>
252
+ </li>
253
+ </ul>
254
+ </li>
255
+ </ul>
256
+ <ul class="after-current">
257
+ <li class=" tsd-kind-type-alias">
258
+ <a href="../modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a>
259
+ </li>
260
+ <li class=" tsd-kind-type-alias">
261
+ <a href="../modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a>
262
+ </li>
263
+ </ul>
264
+ </nav>
265
+ </div>
266
+ </div>
267
+ </div>
268
+ <footer class="with-border-bottom">
269
+ <div class="container">
270
+ <h2>Legend</h2>
271
+ <div class="tsd-legend-group">
272
+ <ul class="tsd-legend">
273
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
274
+ <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
275
+ </ul>
276
+ </div>
277
+ </div>
278
+ </footer>
279
+ <div class="container tsd-generator">
280
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
281
+ </div>
282
+ <div class="overlay"></div>
283
+ <script src="../assets/js/main.js"></script>
284
+ </body>
285
+ </html>
package/docs/index.html ADDED
@@ -0,0 +1,108 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>@mountainpass/problem-document</title>
7
+ <meta name="description" content="Documentation for @mountainpass/problem-document">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="assets/css/main.css">
10
+ <script async src="assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="index.html" class="title">@mountainpass/problem-document</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <h1>@mountainpass/problem-document</h1>
54
+ </div>
55
+ </div>
56
+ </header>
57
+ <div class="container container-main">
58
+ <div class="row">
59
+ <div class="col-8 col-content">
60
+ <div class="tsd-panel tsd-typography">
61
+ <a href="#problem-document" id="problem-document" style="color: inherit; text-decoration: none;">
62
+ <h1>problem-document</h1>
63
+ </a>
64
+ <p>A basic RFC7807 Problem Document with basic type checking and autocomplete</p>
65
+ </div>
66
+ </div>
67
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
68
+ <nav class="tsd-navigation primary">
69
+ <ul>
70
+ <li class=" ">
71
+ <a href="modules.html">Exports</a>
72
+ </li>
73
+ </ul>
74
+ </nav>
75
+ <nav class="tsd-navigation secondary menu-sticky">
76
+ <ul class="before-current">
77
+ <li class=" tsd-kind-class">
78
+ <a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a>
79
+ </li>
80
+ <li class=" tsd-kind-type-alias">
81
+ <a href="modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a>
82
+ </li>
83
+ <li class=" tsd-kind-type-alias">
84
+ <a href="modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a>
85
+ </li>
86
+ </ul>
87
+ </nav>
88
+ </div>
89
+ </div>
90
+ </div>
91
+ <footer class="with-border-bottom">
92
+ <div class="container">
93
+ <h2>Legend</h2>
94
+ <div class="tsd-legend-group">
95
+ <ul class="tsd-legend">
96
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
98
+ </ul>
99
+ </div>
100
+ </div>
101
+ </footer>
102
+ <div class="container tsd-generator">
103
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
104
+ </div>
105
+ <div class="overlay"></div>
106
+ <script src="assets/js/main.js"></script>
107
+ </body>
108
+ </html>
package/docs/modules.html ADDED
@@ -0,0 +1,206 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>@mountainpass/problem-document</title>
7
+ <meta name="description" content="Documentation for @mountainpass/problem-document">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="assets/css/main.css">
10
+ <script async src="assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="index.html" class="title">@mountainpass/problem-document</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <h1>@mountainpass/problem-document</h1>
54
+ </div>
55
+ </div>
56
+ </header>
57
+ <div class="container container-main">
58
+ <div class="row">
59
+ <div class="col-8 col-content">
60
+ <section class="tsd-panel-group tsd-index-group">
61
+ <h2>Index</h2>
62
+ <section class="tsd-panel tsd-index-panel">
63
+ <div class="tsd-index-content">
64
+ <section class="tsd-index-section ">
65
+ <h3>Classes</h3>
66
+ <ul class="tsd-index-list">
67
+ <li class="tsd-kind-class"><a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a></li>
68
+ </ul>
69
+ </section>
70
+ <section class="tsd-index-section ">
71
+ <h3>Type aliases</h3>
72
+ <ul class="tsd-index-list">
73
+ <li class="tsd-kind-type-alias"><a href="modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a></li>
74
+ <li class="tsd-kind-type-alias"><a href="modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a></li>
75
+ </ul>
76
+ </section>
77
+ </div>
78
+ </section>
79
+ </section>
80
+ <section class="tsd-panel-group tsd-member-group ">
81
+ <h2>Type aliases</h2>
82
+ <section class="tsd-panel tsd-member tsd-kind-type-alias">
83
+ <a name="BaseProblemDocumentProperties" class="tsd-anchor"></a>
84
+ <h3>Base<wbr>Problem<wbr>Document<wbr>Properties</h3>
85
+ <div class="tsd-signature tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>detail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StatusCode</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
86
+ <aside class="tsd-sources">
87
+ </aside>
88
+ <div class="tsd-comment tsd-typography">
89
+ <div class="lead">
90
+ <p>Base class for Problem Documents, which includes the non-extension fields</p>
91
+ </div>
92
+ </div>
93
+ <div class="tsd-type-declaration">
94
+ <h4>Type declaration</h4>
95
+ <ul class="tsd-parameters">
96
+ <li class="tsd-parameter">
97
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> detail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
98
+ <div class="tsd-comment tsd-typography">
99
+ <div class="lead">
100
+ <p>A human-readable explanation specific to this occurrence of the problem.</p>
101
+ </div>
102
+ </div>
103
+ </li>
104
+ <li class="tsd-parameter">
105
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
106
+ <div class="tsd-comment tsd-typography">
107
+ <div class="lead">
108
+ <p>A URI reference that identifies the specific
109
+ occurrence of the problem. It may or may not yield further
110
+ information if dereferenced.</p>
111
+ </div>
112
+ </div>
113
+ </li>
114
+ <li class="tsd-parameter">
115
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StatusCode</span></h5>
116
+ <div class="tsd-comment tsd-typography">
117
+ <div class="lead">
118
+ <p>The HTTP status code (<a href="https://datatracker.ietf.org/doc/html/rfc7231#section-6" class="external">[RFC7231], Section 6</a>)
119
+ generated by the origin server for this occurrence of the problem.</p>
120
+ </div>
121
+ </div>
122
+ </li>
123
+ <li class="tsd-parameter">
124
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
125
+ <div class="tsd-comment tsd-typography">
126
+ <div class="lead">
127
+ <p>A short, human-readable summary of the problem
128
+ type. It SHOULD NOT change from occurrence to occurrence of the
129
+ problem, except for purposes of localization (e.g., using
130
+ proactive content negotiation; see <a href="https://datatracker.ietf.org/doc/html/rfc7231#section-3.4" class="external">[RFC7231], Section 3.4</a>).</p>
131
+ </div>
132
+ </div>
133
+ </li>
134
+ <li class="tsd-parameter">
135
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
136
+ <div class="tsd-comment tsd-typography">
137
+ <div class="lead">
138
+ <p>A URI reference [<a href="https://datatracker.ietf.org/doc/html/rfc3986" class="external">RFC3986</a>] that identifies the
139
+ problem type. This specification encourages that, when
140
+ dereferenced, it provide human-readable documentation for the
141
+ problem type (e.g., using HTML [<a href="https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028" class="external">W3C.REC-html5-20141028</a>]). When
142
+ this member is not present, its value is assumed to be
143
+ &quot;about:blank&quot;.</p>
144
+ </div>
145
+ </div>
146
+ </li>
147
+ </ul>
148
+ </div>
149
+ </section>
150
+ <section class="tsd-panel tsd-member tsd-kind-type-alias">
151
+ <a name="ProblemDocumentProperties" class="tsd-anchor"></a>
152
+ <h3>Problem<wbr>Document<wbr>Properties</h3>
153
+ <div class="tsd-signature tsd-kind-icon">Problem<wbr>Document<wbr>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><a href="modules.html#BaseProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">BaseProblemDocumentProperties</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules.html#BaseProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">BaseProblemDocumentProperties</a></div>
154
+ <aside class="tsd-sources">
155
+ </aside>
156
+ <div class="tsd-comment tsd-typography">
157
+ <div class="lead">
158
+ <p>The Problem Document with extensions</p>
159
+ </div>
160
+ <p>Note the use of Omit, this allows auto-completion of the base fields</p>
161
+ </div>
162
+ </section>
163
+ </section>
164
+ </div>
165
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
166
+ <nav class="tsd-navigation primary">
167
+ <ul>
168
+ <li class="current ">
169
+ <a href="modules.html">Exports</a>
170
+ </li>
171
+ </ul>
172
+ </nav>
173
+ <nav class="tsd-navigation secondary menu-sticky">
174
+ <ul class="before-current">
175
+ <li class=" tsd-kind-class">
176
+ <a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a>
177
+ </li>
178
+ <li class=" tsd-kind-type-alias">
179
+ <a href="modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a>
180
+ </li>
181
+ <li class=" tsd-kind-type-alias">
182
+ <a href="modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a>
183
+ </li>
184
+ </ul>
185
+ </nav>
186
+ </div>
187
+ </div>
188
+ </div>
189
+ <footer class="with-border-bottom">
190
+ <div class="container">
191
+ <h2>Legend</h2>
192
+ <div class="tsd-legend-group">
193
+ <ul class="tsd-legend">
194
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
195
+ <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
196
+ </ul>
197
+ </div>
198
+ </div>
199
+ </footer>
200
+ <div class="container tsd-generator">
201
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
202
+ </div>
203
+ <div class="overlay"></div>
204
+ <script src="assets/js/main.js"></script>
205
+ </body>
206
+ </html>