@loopback/repository-json-schema 4.0.0-alpha.8 → 5.0.0

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 (76) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +15 -10
  3. package/dist/build-schema.d.ts +137 -0
  4. package/dist/build-schema.js +445 -0
  5. package/dist/build-schema.js.map +1 -0
  6. package/dist/filter-json-schema.d.ts +54 -0
  7. package/dist/filter-json-schema.js +198 -0
  8. package/dist/filter-json-schema.js.map +1 -0
  9. package/dist/index.d.ts +36 -1
  10. package/dist/index.js +18 -7
  11. package/dist/index.js.map +1 -0
  12. package/dist/keys.d.ts +8 -0
  13. package/dist/keys.js +13 -0
  14. package/dist/keys.js.map +1 -0
  15. package/package.json +42 -33
  16. package/src/build-schema.ts +491 -79
  17. package/src/filter-json-schema.ts +237 -0
  18. package/src/index.ts +42 -1
  19. package/src/keys.ts +15 -0
  20. package/CHANGELOG.md +0 -83
  21. package/api-docs/apple-touch-icon-114x114-precomposed.png +0 -0
  22. package/api-docs/apple-touch-icon-144x144-precomposed.png +0 -0
  23. package/api-docs/apple-touch-icon-57x57-precomposed.png +0 -0
  24. package/api-docs/apple-touch-icon-72x72-precomposed.png +0 -0
  25. package/api-docs/apple-touch-icon-precomposed.png +0 -0
  26. package/api-docs/apple-touch-icon.png +0 -0
  27. package/api-docs/css/bootstrap.min.css +0 -9
  28. package/api-docs/css/code-themes/arta.css +0 -158
  29. package/api-docs/css/code-themes/ascetic.css +0 -50
  30. package/api-docs/css/code-themes/brown_paper.css +0 -104
  31. package/api-docs/css/code-themes/brown_papersq.png +0 -0
  32. package/api-docs/css/code-themes/dark.css +0 -103
  33. package/api-docs/css/code-themes/default.css +0 -135
  34. package/api-docs/css/code-themes/far.css +0 -111
  35. package/api-docs/css/code-themes/github.css +0 -127
  36. package/api-docs/css/code-themes/googlecode.css +0 -144
  37. package/api-docs/css/code-themes/idea.css +0 -121
  38. package/api-docs/css/code-themes/ir_black.css +0 -104
  39. package/api-docs/css/code-themes/magula.css +0 -121
  40. package/api-docs/css/code-themes/monokai.css +0 -114
  41. package/api-docs/css/code-themes/pojoaque.css +0 -104
  42. package/api-docs/css/code-themes/pojoaque.jpg +0 -0
  43. package/api-docs/css/code-themes/rainbow.css +0 -114
  44. package/api-docs/css/code-themes/school_book.css +0 -111
  45. package/api-docs/css/code-themes/school_book.png +0 -0
  46. package/api-docs/css/code-themes/sl-theme.css +0 -45
  47. package/api-docs/css/code-themes/solarized_dark.css +0 -88
  48. package/api-docs/css/code-themes/solarized_light.css +0 -88
  49. package/api-docs/css/code-themes/sunburst.css +0 -158
  50. package/api-docs/css/code-themes/tomorrow-night-blue.css +0 -52
  51. package/api-docs/css/code-themes/tomorrow-night-bright.css +0 -51
  52. package/api-docs/css/code-themes/tomorrow-night-eighties.css +0 -51
  53. package/api-docs/css/code-themes/tomorrow-night.css +0 -52
  54. package/api-docs/css/code-themes/tomorrow.css +0 -49
  55. package/api-docs/css/code-themes/vs.css +0 -86
  56. package/api-docs/css/code-themes/xcode.css +0 -154
  57. package/api-docs/css/code-themes/zenburn.css +0 -115
  58. package/api-docs/css/main.css +0 -139
  59. package/api-docs/favicon.ico +0 -0
  60. package/api-docs/fonts/0ihfXUL2emPh0ROJezvraLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
  61. package/api-docs/fonts/OsJ2DjdpjqFRVUSto6IffLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
  62. package/api-docs/fonts/_aijTyevf54tkVDLy-dlnLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
  63. package/api-docs/index.html +0 -717
  64. package/api-docs/js/main.js +0 -19
  65. package/api-docs/js/vendor/bootstrap.min.js +0 -6
  66. package/api-docs/js/vendor/jquery-1.10.1.min.js +0 -6
  67. package/api-docs/js/vendor/jquery.scrollTo-1.4.3.1.js +0 -218
  68. package/api-docs/js/vendor/modernizr-2.6.2-respond-1.1.0.min.js +0 -11
  69. package/dist/src/build-schema.d.ts +0 -50
  70. package/dist/src/build-schema.js +0 -143
  71. package/dist/src/build-schema.js.map +0 -1
  72. package/dist/src/index.d.ts +0 -1
  73. package/dist/src/index.js +0 -11
  74. package/dist/src/index.js.map +0 -1
  75. package/index.d.ts +0 -6
  76. package/index.js +0 -6
@@ -1,717 +0,0 @@
1
- <!DOCTYPE html>
2
- <!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
3
- <!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
4
- <!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
5
- <!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
6
- <head>
7
- <meta charset="utf-8">
8
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
9
- <title></title>
10
- <meta name="description" content="">
11
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
12
-
13
- <link rel="stylesheet" href="css/bootstrap.min.css">
14
- <link rel="stylesheet" href="css/code-themes/sl-theme.css">
15
- <link rel="stylesheet" href="css/main.css">
16
- </head>
17
- <body>
18
- <div class="navbar navbar-inverse navbar-static-top" role="navigation">
19
- <div class="navbar-header">
20
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
21
- <span class="icon-bar"></span>
22
- <span class="icon-bar"></span>
23
- <span class="icon-bar"></span>
24
- </button>
25
- <a class="navbar-brand" href="/">docs.strongloop.com</a>
26
- </div>
27
- <div id="modules"></div>
28
- </div>
29
-
30
- <div class="row">
31
- <div class="col-lg-3 column scroll-spy-target">
32
- <ul class="nav nav-pills nav-stacked">
33
- <div id="versions"></div>
34
-
35
- <li class="depth-3">
36
- <a href="#JsonDefinition">Interface: JsonDefinition</a>
37
- </li>
38
-
39
- <li class="depth-3">
40
- <a href="#58">Function: getJsonSchema</a>
41
- </li>
42
-
43
- <li class="depth-3">
44
- <a href="#64">Function: isComplexType</a>
45
- </li>
46
-
47
- <li class="depth-3">
48
- <a href="#67">Function: metaToJsonProperty</a>
49
- </li>
50
-
51
- <li class="depth-3">
52
- <a href="#70">Function: modelToJsonSchema</a>
53
- </li>
54
-
55
- <li class="depth-3">
56
- <a href="#61">Function: stringTypeToWrapper</a>
57
- </li>
58
-
59
- </ul>
60
-
61
- </div>
62
- <div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0">
63
- <div class="readability">
64
-
65
- <section class="code-doc ">
66
- <a name="JsonDefinition"></a>
67
- <h3 class="code-ref">Interface: JsonDefinition</h3>
68
- <!--
69
- Used for displaying comments in Class, Interface, Properties Constructor,
70
- Function and Parameters of constructor or function.
71
- (Excludes Type alias).
72
- -->
73
-
74
- <div class="code-desc">
75
- <p><p>Type definition for JSON Schema</p>
76
- </p>
77
- <p></p>
78
- </div>
79
-
80
-
81
-
82
-
83
-
84
- </section>
85
-
86
- <section class="code-doc">
87
- <a name="TODO"></a>
88
- <div class="code-arguments-hdr">Properties</div>
89
- <table class="params code-arguments">
90
- <tr>
91
- <th class="hdr-name">Name</th>
92
- <th class="hdr-type">Type</th>
93
- <th class="hdr-desc">Description</th>
94
- </tr>
95
-
96
- <tr class="code-arg">
97
- <td>
98
- <a name="JsonDefinition"></a>
99
- <strong class="code-arg-name">additionalItems</strong>
100
- </td>
101
- <td class="code-arg-types">
102
-
103
- <code></code>
104
-
105
-
106
- </td>
107
- <td class="code-arg-desc">
108
- <!--
109
- Used for displaying comments in Class, Interface, Properties Constructor,
110
- Function and Parameters of constructor or function.
111
- (Excludes Type alias).
112
- -->
113
-
114
- <div class="code-desc">
115
- <p><p>Type definition for JSON Schema</p>
116
- </p>
117
- <p></p>
118
- </div>
119
-
120
-
121
-
122
-
123
-
124
- </td>
125
- </tr>
126
-
127
- <tr class="code-arg">
128
- <td>
129
- <a name="JsonDefinition"></a>
130
- <strong class="code-arg-name">additionalProperties</strong>
131
- </td>
132
- <td class="code-arg-types">
133
-
134
- <code></code>
135
-
136
-
137
- </td>
138
- <td class="code-arg-desc">
139
- <!--
140
- Used for displaying comments in Class, Interface, Properties Constructor,
141
- Function and Parameters of constructor or function.
142
- (Excludes Type alias).
143
- -->
144
-
145
- <div class="code-desc">
146
- <p><p>Type definition for JSON Schema</p>
147
- </p>
148
- <p></p>
149
- </div>
150
-
151
-
152
-
153
-
154
-
155
- </td>
156
- </tr>
157
-
158
- <tr class="code-arg">
159
- <td>
160
- <a name="JsonDefinition"></a>
161
- <strong class="code-arg-name">allOf</strong>
162
- </td>
163
- <td class="code-arg-types">
164
-
165
- <code></code>
166
-
167
-
168
- </td>
169
- <td class="code-arg-desc">
170
- <!--
171
- Used for displaying comments in Class, Interface, Properties Constructor,
172
- Function and Parameters of constructor or function.
173
- (Excludes Type alias).
174
- -->
175
-
176
- <div class="code-desc">
177
- <p><p>Type definition for JSON Schema</p>
178
- </p>
179
- <p></p>
180
- </div>
181
-
182
-
183
-
184
-
185
-
186
- </td>
187
- </tr>
188
-
189
- <tr class="code-arg">
190
- <td>
191
- <a name="JsonDefinition"></a>
192
- <strong class="code-arg-name">anyOf</strong>
193
- </td>
194
- <td class="code-arg-types">
195
-
196
- <code></code>
197
-
198
-
199
- </td>
200
- <td class="code-arg-desc">
201
- <!--
202
- Used for displaying comments in Class, Interface, Properties Constructor,
203
- Function and Parameters of constructor or function.
204
- (Excludes Type alias).
205
- -->
206
-
207
- <div class="code-desc">
208
- <p><p>Type definition for JSON Schema</p>
209
- </p>
210
- <p></p>
211
- </div>
212
-
213
-
214
-
215
-
216
-
217
- </td>
218
- </tr>
219
-
220
- <tr class="code-arg">
221
- <td>
222
- <a name="JsonDefinition"></a>
223
- <strong class="code-arg-name">definitions</strong>
224
- </td>
225
- <td class="code-arg-types">
226
-
227
- <code></code>
228
-
229
-
230
- </td>
231
- <td class="code-arg-desc">
232
- <!--
233
- Used for displaying comments in Class, Interface, Properties Constructor,
234
- Function and Parameters of constructor or function.
235
- (Excludes Type alias).
236
- -->
237
-
238
- <div class="code-desc">
239
- <p><p>Type definition for JSON Schema</p>
240
- </p>
241
- <p></p>
242
- </div>
243
-
244
-
245
-
246
-
247
-
248
- </td>
249
- </tr>
250
-
251
- <tr class="code-arg">
252
- <td>
253
- <a name="JsonDefinition"></a>
254
- <strong class="code-arg-name">enum</strong>
255
- </td>
256
- <td class="code-arg-types">
257
-
258
- <code></code>
259
-
260
-
261
- </td>
262
- <td class="code-arg-desc">
263
- <!--
264
- Used for displaying comments in Class, Interface, Properties Constructor,
265
- Function and Parameters of constructor or function.
266
- (Excludes Type alias).
267
- -->
268
-
269
- <div class="code-desc">
270
- <p><p>Type definition for JSON Schema</p>
271
- </p>
272
- <p></p>
273
- </div>
274
-
275
-
276
-
277
-
278
-
279
- </td>
280
- </tr>
281
-
282
- <tr class="code-arg">
283
- <td>
284
- <a name="JsonDefinition"></a>
285
- <strong class="code-arg-name">items</strong>
286
- </td>
287
- <td class="code-arg-types">
288
-
289
- <code></code>
290
-
291
-
292
- </td>
293
- <td class="code-arg-desc">
294
- <!--
295
- Used for displaying comments in Class, Interface, Properties Constructor,
296
- Function and Parameters of constructor or function.
297
- (Excludes Type alias).
298
- -->
299
-
300
- <div class="code-desc">
301
- <p><p>Type definition for JSON Schema</p>
302
- </p>
303
- <p></p>
304
- </div>
305
-
306
-
307
-
308
-
309
-
310
- </td>
311
- </tr>
312
-
313
- <tr class="code-arg">
314
- <td>
315
- <a name="JsonDefinition"></a>
316
- <strong class="code-arg-name">oneOf</strong>
317
- </td>
318
- <td class="code-arg-types">
319
-
320
- <code></code>
321
-
322
-
323
- </td>
324
- <td class="code-arg-desc">
325
- <!--
326
- Used for displaying comments in Class, Interface, Properties Constructor,
327
- Function and Parameters of constructor or function.
328
- (Excludes Type alias).
329
- -->
330
-
331
- <div class="code-desc">
332
- <p><p>Type definition for JSON Schema</p>
333
- </p>
334
- <p></p>
335
- </div>
336
-
337
-
338
-
339
-
340
-
341
- </td>
342
- </tr>
343
-
344
- <tr class="code-arg">
345
- <td>
346
- <a name="JsonDefinition"></a>
347
- <strong class="code-arg-name">properties</strong>
348
- </td>
349
- <td class="code-arg-types">
350
-
351
- <code></code>
352
-
353
-
354
- </td>
355
- <td class="code-arg-desc">
356
- <!--
357
- Used for displaying comments in Class, Interface, Properties Constructor,
358
- Function and Parameters of constructor or function.
359
- (Excludes Type alias).
360
- -->
361
-
362
- <div class="code-desc">
363
- <p><p>Type definition for JSON Schema</p>
364
- </p>
365
- <p></p>
366
- </div>
367
-
368
-
369
-
370
-
371
-
372
- </td>
373
- </tr>
374
-
375
- </table>
376
- </section>
377
-
378
-
379
- <section class="code-doc ">
380
- <a name="58"></a>
381
-
382
- <h4 class="code-ref">getJsonSchema(ctor: <a href="#Function">Function</a>) : JsonDefinition</h4>
383
-
384
-
385
- <!--
386
- Used for displaying comments in Class, Interface, Properties Constructor,
387
- Function and Parameters of constructor or function.
388
- (Excludes Type alias).
389
- -->
390
-
391
- <div class="code-desc">
392
- <p><p>Gets the JSON Schema of a TypeScript model/class by seeing if one exists
393
- in a cache. If not, one is generated and then cached.</p>
394
- </p>
395
- <p></p>
396
- </div>
397
-
398
-
399
-
400
-
401
-
402
-
403
- <div class="code-arguments-hdr">Arguments</div>
404
- <table class="params code-arguments">
405
- <tr>
406
- <th class="hdr-name">Name</th>
407
- <th class="hdr-type">Type</th>
408
- <th class="hdr-desc">Description</th>
409
- </tr>
410
-
411
- <tr class="code-arg">
412
- <td>
413
- <strong class="code-arg-name">ctor</strong>
414
- </td>
415
- <td class="code-arg-types">
416
-
417
- <code><a href="#Function">Function</a></code>
418
-
419
-
420
- </td>
421
- <td class="code-arg-desc">
422
- <!--
423
- Used for displaying comments in Class, Interface, Properties Constructor,
424
- Function and Parameters of constructor or function.
425
- (Excludes Type alias).
426
- -->
427
-
428
- <div class="code-desc">
429
- <p></p>
430
- <p><p>Contructor of class to get JSON Schema from</p>
431
- </p>
432
- </div>
433
-
434
-
435
-
436
-
437
-
438
- </td>
439
- </tr>
440
-
441
- </table>
442
-
443
- </section>
444
-
445
- <section class="code-doc ">
446
- <a name="64"></a>
447
-
448
- <h4 class="code-ref">isComplexType(ctor: <a href="#Function">Function</a>) : boolean</h4>
449
-
450
-
451
- <!--
452
- Used for displaying comments in Class, Interface, Properties Constructor,
453
- Function and Parameters of constructor or function.
454
- (Excludes Type alias).
455
- -->
456
-
457
- <div class="code-desc">
458
- <p><p>Determines whether the given constructor is a custom type or not</p>
459
- </p>
460
- <p></p>
461
- </div>
462
-
463
-
464
-
465
-
466
-
467
-
468
- <div class="code-arguments-hdr">Arguments</div>
469
- <table class="params code-arguments">
470
- <tr>
471
- <th class="hdr-name">Name</th>
472
- <th class="hdr-type">Type</th>
473
- <th class="hdr-desc">Description</th>
474
- </tr>
475
-
476
- <tr class="code-arg">
477
- <td>
478
- <strong class="code-arg-name">ctor</strong>
479
- </td>
480
- <td class="code-arg-types">
481
-
482
- <code><a href="#Function">Function</a></code>
483
-
484
-
485
- </td>
486
- <td class="code-arg-desc">
487
- <!--
488
- Used for displaying comments in Class, Interface, Properties Constructor,
489
- Function and Parameters of constructor or function.
490
- (Excludes Type alias).
491
- -->
492
-
493
- <div class="code-desc">
494
- <p></p>
495
- <p><p>Constructor</p>
496
- </p>
497
- </div>
498
-
499
-
500
-
501
-
502
-
503
- </td>
504
- </tr>
505
-
506
- </table>
507
-
508
- </section>
509
-
510
- <section class="code-doc ">
511
- <a name="67"></a>
512
-
513
- <h4 class="code-ref">metaToJsonProperty(meta: <a href="#PropertyDefinition">PropertyDefinition</a>) : JsonDefinition</h4>
514
-
515
-
516
- <!--
517
- Used for displaying comments in Class, Interface, Properties Constructor,
518
- Function and Parameters of constructor or function.
519
- (Excludes Type alias).
520
- -->
521
-
522
- <div class="code-desc">
523
- <p><p>Converts property metadata into a JSON property definition</p>
524
- </p>
525
- <p></p>
526
- </div>
527
-
528
-
529
-
530
-
531
-
532
-
533
- <div class="code-arguments-hdr">Arguments</div>
534
- <table class="params code-arguments">
535
- <tr>
536
- <th class="hdr-name">Name</th>
537
- <th class="hdr-type">Type</th>
538
- <th class="hdr-desc">Description</th>
539
- </tr>
540
-
541
- <tr class="code-arg">
542
- <td>
543
- <strong class="code-arg-name">meta</strong>
544
- </td>
545
- <td class="code-arg-types">
546
-
547
- <code><a href="#PropertyDefinition">PropertyDefinition</a></code>
548
-
549
-
550
- </td>
551
- <td class="code-arg-desc">
552
- <!--
553
- Used for displaying comments in Class, Interface, Properties Constructor,
554
- Function and Parameters of constructor or function.
555
- (Excludes Type alias).
556
- -->
557
-
558
- <div class="code-desc">
559
- <p></p>
560
- <p></p>
561
- </div>
562
-
563
-
564
-
565
-
566
-
567
- </td>
568
- </tr>
569
-
570
- </table>
571
-
572
- </section>
573
-
574
- <section class="code-doc ">
575
- <a name="70"></a>
576
-
577
- <h4 class="code-ref">modelToJsonSchema(ctor: <a href="#Function">Function</a>) : JsonDefinition</h4>
578
-
579
-
580
- <!--
581
- Used for displaying comments in Class, Interface, Properties Constructor,
582
- Function and Parameters of constructor or function.
583
- (Excludes Type alias).
584
- -->
585
-
586
- <div class="code-desc">
587
- <p><p>Converts a TypeScript class into a JSON Schema using TypeScript&#39;s
588
- reflection API</p>
589
- </p>
590
- <p></p>
591
- </div>
592
-
593
-
594
-
595
-
596
-
597
-
598
- <div class="code-arguments-hdr">Arguments</div>
599
- <table class="params code-arguments">
600
- <tr>
601
- <th class="hdr-name">Name</th>
602
- <th class="hdr-type">Type</th>
603
- <th class="hdr-desc">Description</th>
604
- </tr>
605
-
606
- <tr class="code-arg">
607
- <td>
608
- <strong class="code-arg-name">ctor</strong>
609
- </td>
610
- <td class="code-arg-types">
611
-
612
- <code><a href="#Function">Function</a></code>
613
-
614
-
615
- </td>
616
- <td class="code-arg-desc">
617
- <!--
618
- Used for displaying comments in Class, Interface, Properties Constructor,
619
- Function and Parameters of constructor or function.
620
- (Excludes Type alias).
621
- -->
622
-
623
- <div class="code-desc">
624
- <p></p>
625
- <p><p>Constructor of class to convert from</p>
626
- </p>
627
- </div>
628
-
629
-
630
-
631
-
632
-
633
- </td>
634
- </tr>
635
-
636
- </table>
637
-
638
- </section>
639
-
640
- <section class="code-doc ">
641
- <a name="61"></a>
642
-
643
- <h4 class="code-ref">stringTypeToWrapper(type: string) : Function</h4>
644
-
645
-
646
- <!--
647
- Used for displaying comments in Class, Interface, Properties Constructor,
648
- Function and Parameters of constructor or function.
649
- (Excludes Type alias).
650
- -->
651
-
652
- <div class="code-desc">
653
- <p><p>Gets the wrapper function of primitives string, number, and boolean</p>
654
- </p>
655
- <p></p>
656
- </div>
657
-
658
-
659
-
660
-
661
-
662
-
663
- <div class="code-arguments-hdr">Arguments</div>
664
- <table class="params code-arguments">
665
- <tr>
666
- <th class="hdr-name">Name</th>
667
- <th class="hdr-type">Type</th>
668
- <th class="hdr-desc">Description</th>
669
- </tr>
670
-
671
- <tr class="code-arg">
672
- <td>
673
- <strong class="code-arg-name">type</strong>
674
- </td>
675
- <td class="code-arg-types">
676
-
677
- <code>string</code>
678
-
679
-
680
- </td>
681
- <td class="code-arg-desc">
682
- <!--
683
- Used for displaying comments in Class, Interface, Properties Constructor,
684
- Function and Parameters of constructor or function.
685
- (Excludes Type alias).
686
- -->
687
-
688
- <div class="code-desc">
689
- <p></p>
690
- <p><p>Name of type</p>
691
- </p>
692
- </div>
693
-
694
-
695
-
696
-
697
-
698
- </td>
699
- </tr>
700
-
701
- </table>
702
-
703
- </section>
704
-
705
-
706
-
707
- </div>
708
- <div class="intentionally-left-blank"></div>
709
- </div>
710
- </div>
711
- <script src="js/vendor/jquery-1.10.1.min.js"></script>
712
- <script src="js/vendor/jquery.scrollTo-1.4.3.1.js"></script>
713
- <script src="js/vendor/bootstrap.min.js"></script>
714
- <script src="js/main.js"></script>
715
- </body>
716
- </html>
717
-