UNPKG

40 kBJavaScriptView Raw
1"use strict";
2Object.defineProperty(exports, "__esModule", { value: true });
3// tslint:disable
4exports.schema = {
5 "$schema": "http://json-schema.org/draft-07/schema#",
6 "definitions": {
7 "FunctionRunnerSize": {
8 "enum": [
9 "m128MiB",
10 "m1GiB",
11 "m256MiB",
12 "m2GiB",
13 "m512MiB"
14 ],
15 "type": "string"
16 },
17 "Session": {
18 "type": "object",
19 "properties": {
20 "accountId": {
21 "minLength": 1,
22 "type": "string"
23 },
24 "principal": {
25 "minLength": 1,
26 "type": "string"
27 }
28 },
29 "propertyOrder": [
30 "accountId",
31 "principal"
32 ],
33 "required": [
34 "accountId",
35 "principal"
36 ]
37 },
38 "ServerOnlyContext": {
39 "type": "object",
40 "properties": {
41 "tags": {
42 "type": "object",
43 "additionalProperties": {
44 "type": "string"
45 },
46 "propertyOrder": []
47 },
48 "logLevel": {
49 "type": "string"
50 },
51 "logExtra": {
52 "type": "object",
53 "additionalProperties": {},
54 "propertyOrder": []
55 },
56 "sampleRate": {
57 "type": "number"
58 },
59 "debugId": {
60 "type": "string"
61 },
62 "session": {
63 "$ref": "#/definitions/Session"
64 }
65 },
66 "propertyOrder": [
67 "tags",
68 "logLevel",
69 "logExtra",
70 "sampleRate",
71 "debugId",
72 "session"
73 ],
74 "required": [
75 "debugId"
76 ]
77 },
78 "UnauthorizedError": {
79 "type": "object",
80 "properties": {
81 "name": {
82 "type": "string"
83 },
84 "message": {
85 "type": "string"
86 },
87 "stack": {
88 "type": "string"
89 }
90 },
91 "propertyOrder": [
92 "name",
93 "message",
94 "stack"
95 ],
96 "required": [
97 "message",
98 "name"
99 ]
100 },
101 "NotFoundError": {
102 "type": "object",
103 "properties": {
104 "name": {
105 "type": "string"
106 },
107 "message": {
108 "type": "string"
109 },
110 "stack": {
111 "type": "string"
112 }
113 },
114 "propertyOrder": [
115 "name",
116 "message",
117 "stack"
118 ],
119 "required": [
120 "message",
121 "name"
122 ]
123 },
124 "ExistsError": {
125 "type": "object",
126 "properties": {
127 "name": {
128 "type": "string"
129 },
130 "message": {
131 "type": "string"
132 },
133 "stack": {
134 "type": "string"
135 }
136 },
137 "propertyOrder": [
138 "name",
139 "message",
140 "stack"
141 ],
142 "required": [
143 "message",
144 "name"
145 ]
146 },
147 "SubDomain": {
148 "type": "object",
149 "properties": {
150 "type": {
151 "type": "string",
152 "enum": [
153 "subdomain"
154 ]
155 },
156 "name": {
157 "type": "string"
158 }
159 },
160 "propertyOrder": [
161 "type",
162 "name"
163 ],
164 "required": [
165 "name",
166 "type"
167 ]
168 },
169 "CNameDomain": {
170 "type": "object",
171 "properties": {
172 "type": {
173 "type": "string",
174 "enum": [
175 "cname"
176 ]
177 },
178 "name": {
179 "format": "hostname",
180 "type": "string"
181 },
182 "certificate": {
183 "minLength": 1,
184 "type": "string"
185 }
186 },
187 "propertyOrder": [
188 "type",
189 "name",
190 "certificate"
191 ],
192 "required": [
193 "certificate",
194 "name",
195 "type"
196 ]
197 },
198 "Domain": {
199 "anyOf": [
200 {
201 "$ref": "#/definitions/SubDomain"
202 },
203 {
204 "$ref": "#/definitions/CNameDomain"
205 }
206 ]
207 },
208 "TemplateSource": {
209 "type": "object",
210 "properties": {
211 "downloadDir": {
212 "description": "Directory name with the source inside the uncompressed bundle",
213 "type": "string"
214 },
215 "downloadUrl": {
216 "description": "URL of the template source compressed tar bundle",
217 "type": "string"
218 },
219 "githubUrl": {
220 "description": "URL of the template git repository",
221 "type": "string"
222 },
223 "targetDir": {
224 "description": "Desired directory name for the ready applicaton",
225 "type": "string"
226 },
227 "zipUrl": {
228 "description": "URL of the template source zip file",
229 "type": "string"
230 }
231 },
232 "propertyOrder": [
233 "downloadDir",
234 "downloadUrl",
235 "githubUrl",
236 "targetDir",
237 "zipUrl"
238 ],
239 "required": [
240 "downloadDir",
241 "downloadUrl",
242 "githubUrl",
243 "targetDir",
244 "zipUrl"
245 ]
246 },
247 "Environment": {
248 "type": "object",
249 "properties": {
250 "name": {
251 "pattern": "^[A-Za-z][A-Za-z_\\d]{0,49}$",
252 "type": "string"
253 },
254 "domains": {
255 "type": "array",
256 "items": {
257 "anyOf": [
258 {
259 "$ref": "#/definitions/SubDomain"
260 },
261 {
262 "$ref": "#/definitions/CNameDomain"
263 }
264 ]
265 }
266 }
267 },
268 "propertyOrder": [
269 "name",
270 "domains"
271 ],
272 "required": [
273 "domains",
274 "name"
275 ]
276 },
277 "Application": {
278 "type": "object",
279 "properties": {
280 "accountId": {
281 "minLength": 1,
282 "type": "string"
283 },
284 "id": {
285 "minLength": 1,
286 "type": "string"
287 },
288 "name": {
289 "description": "Non-unique user friendly name to identify this app",
290 "minLength": 1,
291 "type": "string"
292 },
293 "createdAt": {
294 "description": "Enables basic storage and retrieval of dates and times.",
295 "type": "string",
296 "format": "date-time",
297 "coerce-date": true
298 },
299 "updatedAt": {
300 "description": "Enables basic storage and retrieval of dates and times.",
301 "type": "string",
302 "format": "date-time",
303 "coerce-date": true
304 },
305 "source": {
306 "description": "If cloned from template, will hold the template source information,\nsuch as github URL (including the git tag | digest).\nCould be used in the future to track a github repo.",
307 "$ref": "#/definitions/TemplateSource"
308 },
309 "environments": {
310 "type": "array",
311 "items": {
312 "$ref": "#/definitions/Environment"
313 }
314 }
315 },
316 "propertyOrder": [
317 "accountId",
318 "id",
319 "name",
320 "createdAt",
321 "updatedAt",
322 "source",
323 "environments"
324 ],
325 "required": [
326 "accountId",
327 "createdAt",
328 "environments",
329 "id",
330 "name",
331 "updatedAt"
332 ]
333 },
334 "Template": {
335 "type": "object",
336 "properties": {
337 "id": {
338 "minLength": 1,
339 "type": "string"
340 },
341 "name": {
342 "minLength": 1,
343 "type": "string"
344 },
345 "previewImageUrl": {
346 "format": "uri",
347 "type": "string"
348 },
349 "githubUrl": {
350 "format": "uri",
351 "type": "string"
352 },
353 "license": {
354 "minLength": 1,
355 "type": "string"
356 },
357 "author": {
358 "minLength": 1,
359 "type": "string"
360 },
361 "description": {
362 "minLength": 1,
363 "type": "string"
364 },
365 "similarTemplatesIds": {
366 "type": "array",
367 "items": {
368 "type": "string"
369 }
370 }
371 },
372 "propertyOrder": [
373 "id",
374 "name",
375 "previewImageUrl",
376 "githubUrl",
377 "license",
378 "author",
379 "description",
380 "similarTemplatesIds"
381 ],
382 "required": [
383 "author",
384 "description",
385 "githubUrl",
386 "id",
387 "license",
388 "name",
389 "previewImageUrl",
390 "similarTemplatesIds"
391 ]
392 },
393 "ExternalAccount": {
394 "type": "object",
395 "properties": {
396 "source": {
397 "description": "e.g. github",
398 "minLength": 1,
399 "type": "string"
400 },
401 "id": {
402 "minLength": 1,
403 "type": "string"
404 }
405 },
406 "propertyOrder": [
407 "source",
408 "id"
409 ],
410 "required": [
411 "id",
412 "source"
413 ]
414 },
415 "User": {
416 "type": "object",
417 "properties": {
418 "id": {
419 "minLength": 1,
420 "type": "string"
421 },
422 "fullName": {
423 "minLength": 1,
424 "type": "string"
425 },
426 "email": {
427 "format": "email",
428 "type": "string"
429 },
430 "avatarUrl": {
431 "format": "uri",
432 "type": "string"
433 },
434 "externalAccounts": {
435 "type": "array",
436 "items": {
437 "$ref": "#/definitions/ExternalAccount"
438 }
439 }
440 },
441 "propertyOrder": [
442 "id",
443 "fullName",
444 "email",
445 "avatarUrl",
446 "externalAccounts"
447 ],
448 "required": [
449 "email",
450 "externalAccounts",
451 "fullName",
452 "id"
453 ]
454 },
455 "TimePeriod": {
456 "description": "Pattern as supported by the ms package",
457 "minLength": 1,
458 "type": "string"
459 },
460 "InvocationDetails": {
461 "type": "object",
462 "properties": {
463 "durUs": {
464 "type": "number"
465 },
466 "reqid": {
467 "type": "string"
468 }
469 },
470 "propertyOrder": [
471 "durUs",
472 "reqid"
473 ],
474 "required": [
475 "durUs",
476 "reqid"
477 ]
478 },
479 "LogRecord": {
480 "type": "object",
481 "properties": {
482 "source": {
483 "type": "string"
484 },
485 "msg": {
486 "type": "string"
487 },
488 "isErr": {
489 "type": "boolean"
490 },
491 "time": {
492 "description": "Enables basic storage and retrieval of dates and times.",
493 "type": "string",
494 "format": "date-time",
495 "coerce-date": true
496 },
497 "invocation": {
498 "$ref": "#/definitions/InvocationDetails"
499 }
500 },
501 "propertyOrder": [
502 "source",
503 "msg",
504 "isErr",
505 "time",
506 "invocation"
507 ],
508 "required": [
509 "isErr",
510 "msg",
511 "source",
512 "time"
513 ]
514 },
515 "LogReadOpts": {
516 "type": "object",
517 "properties": {
518 "since": {
519 "description": "Enables basic storage and retrieval of dates and times.",
520 "type": "string",
521 "format": "date-time",
522 "coerce-date": true
523 },
524 "limit": {
525 "minimum": 1,
526 "maximum": 10000,
527 "type": "number"
528 },
529 "follow": {
530 "type": "boolean"
531 },
532 "nextToken": {
533 "description": "Continuation token (received in response)",
534 "minLength": 1,
535 "type": "string"
536 }
537 },
538 "propertyOrder": [
539 "since",
540 "limit",
541 "follow",
542 "nextToken"
543 ],
544 "required": [
545 "follow",
546 "limit",
547 "since"
548 ]
549 },
550 "LogsResponse": {
551 "type": "object",
552 "properties": {
553 "records": {
554 "type": "array",
555 "items": {
556 "$ref": "#/definitions/LogRecord"
557 }
558 },
559 "nextToken": {
560 "minLength": 1,
561 "type": "string"
562 }
563 },
564 "propertyOrder": [
565 "records",
566 "nextToken"
567 ],
568 "required": [
569 "records"
570 ]
571 },
572 "CreateTicketResponse": {
573 "type": "object",
574 "properties": {
575 "ticket": {
576 "minLength": 1,
577 "type": "string"
578 },
579 "expires": {
580 "description": "Pattern as supported by the ms package",
581 "minLength": 1,
582 "type": "string"
583 }
584 },
585 "propertyOrder": [
586 "ticket",
587 "expires"
588 ],
589 "required": [
590 "expires",
591 "ticket"
592 ]
593 },
594 "TryTemplateResponse": {
595 "type": "object",
596 "properties": {
597 "token": {
598 "minLength": 1,
599 "type": "string"
600 },
601 "expiresAt": {
602 "description": "Enables basic storage and retrieval of dates and times.",
603 "type": "string",
604 "format": "date-time",
605 "coerce-date": true
606 },
607 "domain": {
608 "minLength": 1,
609 "type": "string"
610 }
611 },
612 "propertyOrder": [
613 "token",
614 "expiresAt",
615 "domain"
616 ],
617 "required": [
618 "domain",
619 "expiresAt",
620 "token"
621 ]
622 },
623 "Lycan": {
624 "type": "object",
625 "properties": {
626 "createTicket": {
627 "description": "Create a ticket for claiming an API key",
628 "type": "object",
629 "properties": {
630 "params": {
631 "type": "object",
632 "properties": {}
633 },
634 "returns": {
635 "$ref": "#/definitions/CreateTicketResponse"
636 }
637 },
638 "propertyOrder": [
639 "params",
640 "returns"
641 ],
642 "required": [
643 "params",
644 "returns"
645 ]
646 },
647 "claimTicket": {
648 "description": "Returns an API key in exchange for a valid ticket",
649 "type": "object",
650 "properties": {
651 "params": {
652 "type": "object",
653 "properties": {
654 "ticket": {
655 "type": "string"
656 }
657 },
658 "propertyOrder": [
659 "ticket"
660 ],
661 "required": [
662 "ticket"
663 ]
664 },
665 "throws": {
666 "$ref": "#/definitions/NotFoundError"
667 },
668 "returns": {
669 "type": "string"
670 }
671 },
672 "propertyOrder": [
673 "params",
674 "throws",
675 "returns"
676 ],
677 "required": [
678 "params",
679 "returns",
680 "throws"
681 ]
682 },
683 "listTemplates": {
684 "type": "object",
685 "properties": {
686 "params": {
687 "type": "object",
688 "properties": {}
689 },
690 "returns": {
691 "type": "array",
692 "items": {
693 "$ref": "#/definitions/Template"
694 }
695 }
696 },
697 "propertyOrder": [
698 "params",
699 "returns"
700 ],
701 "required": [
702 "params",
703 "returns"
704 ]
705 },
706 "tryTemplate": {
707 "description": "Returns a JWT token for claiming the live template\nwith claimApp",
708 "type": "object",
709 "properties": {
710 "params": {
711 "type": "object",
712 "properties": {
713 "id": {
714 "minLength": 1,
715 "type": "string"
716 }
717 },
718 "propertyOrder": [
719 "id"
720 ],
721 "required": [
722 "id"
723 ]
724 },
725 "throws": {
726 "$ref": "#/definitions/NotFoundError"
727 },
728 "returns": {
729 "$ref": "#/definitions/TryTemplateResponse"
730 }
731 },
732 "propertyOrder": [
733 "params",
734 "throws",
735 "returns"
736 ],
737 "required": [
738 "params",
739 "returns",
740 "throws"
741 ]
742 },
743 "whoami": {
744 "type": "object",
745 "properties": {
746 "params": {
747 "type": "object",
748 "properties": {}
749 },
750 "returns": {
751 "$ref": "#/definitions/User"
752 },
753 "throws": {
754 "$ref": "#/definitions/UnauthorizedError"
755 }
756 },
757 "propertyOrder": [
758 "params",
759 "returns",
760 "throws"
761 ],
762 "required": [
763 "params",
764 "returns",
765 "throws"
766 ]
767 },
768 "listApps": {
769 "type": "object",
770 "properties": {
771 "params": {
772 "type": "object",
773 "properties": {}
774 },
775 "throws": {
776 "$ref": "#/definitions/UnauthorizedError"
777 },
778 "returns": {
779 "type": "array",
780 "items": {
781 "$ref": "#/definitions/Application"
782 }
783 }
784 },
785 "propertyOrder": [
786 "params",
787 "throws",
788 "returns"
789 ],
790 "required": [
791 "params",
792 "returns",
793 "throws"
794 ]
795 },
796 "getApp": {
797 "type": "object",
798 "properties": {
799 "params": {
800 "type": "object",
801 "properties": {
802 "id": {
803 "minLength": 1,
804 "type": "string"
805 }
806 },
807 "propertyOrder": [
808 "id"
809 ],
810 "required": [
811 "id"
812 ]
813 },
814 "throws": {
815 "$ref": "#/definitions/UnauthorizedError"
816 },
817 "returns": {
818 "$ref": "#/definitions/Application"
819 }
820 },
821 "propertyOrder": [
822 "params",
823 "throws",
824 "returns"
825 ],
826 "required": [
827 "params",
828 "returns",
829 "throws"
830 ]
831 },
832 "deployInitial": {
833 "type": "object",
834 "properties": {
835 "params": {
836 "type": "object",
837 "properties": {
838 "env": {
839 "pattern": "^[A-Za-z][A-Za-z_\\d]{0,49}$",
840 "type": "string"
841 },
842 "name": {
843 "minLength": 1,
844 "type": "string"
845 },
846 "digest": {
847 "minLength": 1,
848 "type": "string"
849 },
850 "envVars": {
851 "type": "array",
852 "items": {
853 "type": "array",
854 "items": [
855 {
856 "type": "string"
857 },
858 {
859 "type": "string"
860 }
861 ],
862 "minItems": 2,
863 "additionalItems": {
864 "anyOf": [
865 {
866 "type": "string"
867 },
868 {
869 "type": "string"
870 }
871 ]
872 }
873 }
874 }
875 },
876 "propertyOrder": [
877 "env",
878 "name",
879 "digest",
880 "envVars"
881 ],
882 "required": [
883 "digest",
884 "env",
885 "envVars",
886 "name"
887 ]
888 },
889 "throws": {
890 "anyOf": [
891 {
892 "$ref": "#/definitions/UnauthorizedError"
893 },
894 {
895 "$ref": "#/definitions/ExistsError"
896 }
897 ]
898 },
899 "returns": {
900 "$ref": "#/definitions/Application"
901 }
902 },
903 "propertyOrder": [
904 "params",
905 "throws",
906 "returns"
907 ],
908 "required": [
909 "params",
910 "returns",
911 "throws"
912 ]
913 },
914 "deploy": {
915 "type": "object",
916 "properties": {
917 "params": {
918 "type": "object",
919 "properties": {
920 "appId": {
921 "minLength": 1,
922 "type": "string"
923 },
924 "env": {
925 "pattern": "^[A-Za-z][A-Za-z_\\d]{0,49}$",
926 "type": "string"
927 },
928 "digest": {
929 "minLength": 1,
930 "type": "string"
931 },
932 "envVars": {
933 "type": "array",
934 "items": {
935 "type": "array",
936 "items": [
937 {
938 "type": "string"
939 },
940 {
941 "type": "string"
942 }
943 ],
944 "minItems": 2,
945 "additionalItems": {
946 "anyOf": [
947 {
948 "type": "string"
949 },
950 {
951 "type": "string"
952 }
953 ]
954 }
955 }
956 }
957 },
958 "propertyOrder": [
959 "appId",
960 "env",
961 "digest",
962 "envVars"
963 ],
964 "required": [
965 "appId",
966 "digest",
967 "env",
968 "envVars"
969 ]
970 },
971 "throws": {
972 "anyOf": [
973 {
974 "$ref": "#/definitions/UnauthorizedError"
975 },
976 {
977 "$ref": "#/definitions/NotFoundError"
978 }
979 ]
980 },
981 "returns": {
982 "$ref": "#/definitions/Application"
983 }
984 },
985 "propertyOrder": [
986 "params",
987 "throws",
988 "returns"
989 ],
990 "required": [
991 "params",
992 "returns",
993 "throws"
994 ]
995 },
996 "claimApp": {
997 "description": "Claim an anonymously deployed app into the user account\nusing the token received from tryTemplate",
998 "type": "object",
999 "properties": {
1000 "params": {
1001 "type": "object",
1002 "properties": {
1003 "token": {
1004 "minLength": 1,
1005 "type": "string"
1006 }
1007 },
1008 "propertyOrder": [
1009 "token"
1010 ],
1011 "required": [
1012 "token"
1013 ]
1014 },
1015 "throws": {
1016 "anyOf": [
1017 {
1018 "$ref": "#/definitions/UnauthorizedError"
1019 },
1020 {
1021 "$ref": "#/definitions/NotFoundError"
1022 }
1023 ]
1024 },
1025 "returns": {
1026 "$ref": "#/definitions/Application"
1027 }
1028 },
1029 "propertyOrder": [
1030 "params",
1031 "throws",
1032 "returns"
1033 ],
1034 "required": [
1035 "params",
1036 "returns",
1037 "throws"
1038 ]
1039 },
1040 "getLogs": {
1041 "type": "object",
1042 "properties": {
1043 "params": {
1044 "type": "object",
1045 "properties": {
1046 "appId": {
1047 "minLength": 1,
1048 "type": "string"
1049 },
1050 "env": {
1051 "pattern": "^[A-Za-z][A-Za-z_\\d]{0,49}$",
1052 "type": "string"
1053 },
1054 "opts": {
1055 "$ref": "#/definitions/LogReadOpts"
1056 }
1057 },
1058 "propertyOrder": [
1059 "appId",
1060 "env",
1061 "opts"
1062 ],
1063 "required": [
1064 "appId",
1065 "env",
1066 "opts"
1067 ]
1068 },
1069 "throws": {
1070 "anyOf": [
1071 {
1072 "$ref": "#/definitions/UnauthorizedError"
1073 },
1074 {
1075 "$ref": "#/definitions/NotFoundError"
1076 }
1077 ]
1078 },
1079 "returns": {
1080 "$ref": "#/definitions/LogsResponse"
1081 }
1082 },
1083 "propertyOrder": [
1084 "params",
1085 "throws",
1086 "returns"
1087 ],
1088 "required": [
1089 "params",
1090 "returns",
1091 "throws"
1092 ]
1093 },
1094 "destroyApp": {
1095 "type": "object",
1096 "properties": {
1097 "params": {
1098 "type": "object",
1099 "properties": {
1100 "appId": {
1101 "minLength": 1,
1102 "type": "string"
1103 }
1104 },
1105 "propertyOrder": [
1106 "appId"
1107 ],
1108 "required": [
1109 "appId"
1110 ]
1111 },
1112 "throws": {
1113 "anyOf": [
1114 {
1115 "$ref": "#/definitions/UnauthorizedError"
1116 },
1117 {
1118 "$ref": "#/definitions/NotFoundError"
1119 }
1120 ]
1121 },
1122 "returns": {
1123 "type": "null"
1124 }
1125 },
1126 "propertyOrder": [
1127 "params",
1128 "throws",
1129 "returns"
1130 ],
1131 "required": [
1132 "params",
1133 "returns",
1134 "throws"
1135 ]
1136 }
1137 },
1138 "propertyOrder": [
1139 "createTicket",
1140 "claimTicket",
1141 "listTemplates",
1142 "tryTemplate",
1143 "whoami",
1144 "listApps",
1145 "getApp",
1146 "deployInitial",
1147 "deploy",
1148 "claimApp",
1149 "getLogs",
1150 "destroyApp"
1151 ],
1152 "required": [
1153 "claimApp",
1154 "claimTicket",
1155 "createTicket",
1156 "deploy",
1157 "deployInitial",
1158 "destroyApp",
1159 "getApp",
1160 "getLogs",
1161 "listApps",
1162 "listTemplates",
1163 "tryTemplate",
1164 "whoami"
1165 ]
1166 }
1167 }
1168};
1169class InternalServerError extends Error {
1170 constructor() {
1171 super(...arguments);
1172 this.name = 'InternalServerError';
1173 }
1174}
1175exports.InternalServerError = InternalServerError;
1176class UnauthorizedError extends Error {
1177 constructor() {
1178 super(...arguments);
1179 this.name = 'UnauthorizedError';
1180 }
1181}
1182exports.UnauthorizedError = UnauthorizedError;
1183class NotFoundError extends Error {
1184 constructor() {
1185 super(...arguments);
1186 this.name = 'NotFoundError';
1187 }
1188}
1189exports.NotFoundError = NotFoundError;
1190class ExistsError extends Error {
1191 constructor() {
1192 super(...arguments);
1193 this.name = 'ExistsError';
1194 }
1195}
1196exports.ExistsError = ExistsError;
1197var FunctionRunnerSize;
1198(function (FunctionRunnerSize) {
1199 FunctionRunnerSize["M128MIB"] = "m128MiB";
1200 FunctionRunnerSize["M1GIB"] = "m1GiB";
1201 FunctionRunnerSize["M256MIB"] = "m256MiB";
1202 FunctionRunnerSize["M2GIB"] = "m2GiB";
1203 FunctionRunnerSize["M512MIB"] = "m512MiB";
1204})(FunctionRunnerSize = exports.FunctionRunnerSize || (exports.FunctionRunnerSize = {}));
1205//# sourceMappingURL=interfaces.js.map
\No newline at end of file