@scalar/oas-utils 0.4.33 → 0.5.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.
- package/CHANGELOG.md +25 -0
- package/dist/entities/cookie/cookie.d.ts +2 -17
- package/dist/entities/cookie/cookie.d.ts.map +1 -1
- package/dist/entities/environment/environment.d.ts +2 -14
- package/dist/entities/environment/environment.d.ts.map +1 -1
- package/dist/entities/shared/utility.d.ts +1 -1
- package/dist/entities/shared/utility.d.ts.map +1 -1
- package/dist/entities/spec/collection.d.ts +76 -501
- package/dist/entities/spec/collection.d.ts.map +1 -1
- package/dist/entities/spec/operation.d.ts +60 -290
- package/dist/entities/spec/operation.d.ts.map +1 -1
- package/dist/entities/spec/parameters.d.ts +33 -50
- package/dist/entities/spec/parameters.d.ts.map +1 -1
- package/dist/entities/spec/request-examples.d.ts +161 -998
- package/dist/entities/spec/request-examples.d.ts.map +1 -1
- package/dist/entities/spec/request-examples.js +11 -6
- package/dist/entities/spec/request-examples.js.map +2 -2
- package/dist/entities/spec/requests.d.ts +102 -595
- package/dist/entities/spec/requests.d.ts.map +1 -1
- package/dist/entities/spec/server.d.ts +12 -156
- package/dist/entities/spec/server.d.ts.map +1 -1
- package/dist/entities/spec/spec-objects.d.ts +37 -229
- package/dist/entities/spec/spec-objects.d.ts.map +1 -1
- package/dist/entities/spec/x-scalar-environments.d.ts +8 -56
- package/dist/entities/spec/x-scalar-environments.d.ts.map +1 -1
- package/dist/entities/spec/x-scalar-secrets.d.ts +2 -14
- package/dist/entities/spec/x-scalar-secrets.d.ts.map +1 -1
- package/dist/entities/workspace/workspace.d.ts +218 -98
- package/dist/entities/workspace/workspace.d.ts.map +1 -1
- package/dist/entities/workspace/workspace.js +4 -5
- package/dist/entities/workspace/workspace.js.map +2 -2
- package/dist/helpers/parse.js +1 -1
- package/dist/helpers/parse.js.map +2 -2
- package/dist/helpers/schema-model.d.ts +3 -3
- package/dist/helpers/schema-model.d.ts.map +1 -1
- package/dist/helpers/schema-model.js.map +1 -1
- package/dist/helpers/security/get-schemes.d.ts +27 -27
- package/dist/helpers/security/get-schemes.d.ts.map +1 -1
- package/dist/migrations/v-2.5.0/migration.d.ts.map +1 -1
- package/dist/migrations/v-2.5.0/migration.js.map +2 -2
- package/dist/spec-getters/get-example-from-schema.d.ts +26 -23
- package/dist/spec-getters/get-example-from-schema.d.ts.map +1 -1
- package/dist/spec-getters/get-example-from-schema.js +330 -174
- package/dist/spec-getters/get-example-from-schema.js.map +2 -2
- package/package.json +9 -9
- package/dist/helpers/operation-to-har/index.d.ts +0 -2
- package/dist/helpers/operation-to-har/index.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/index.js +0 -5
- package/dist/helpers/operation-to-har/index.js.map +0 -7
- package/dist/helpers/operation-to-har/operation-to-har.d.ts +0 -49
- package/dist/helpers/operation-to-har/operation-to-har.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/operation-to-har.js +0 -68
- package/dist/helpers/operation-to-har/operation-to-har.js.map +0 -7
- package/dist/helpers/operation-to-har/process-body.d.ts +0 -12
- package/dist/helpers/operation-to-har/process-body.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-body.js +0 -80
- package/dist/helpers/operation-to-har/process-body.js.map +0 -7
- package/dist/helpers/operation-to-har/process-parameters.d.ts +0 -19
- package/dist/helpers/operation-to-har/process-parameters.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-parameters.js +0 -261
- package/dist/helpers/operation-to-har/process-parameters.js.map +0 -7
- package/dist/helpers/operation-to-har/process-security-schemes.d.ts +0 -15
- package/dist/helpers/operation-to-har/process-security-schemes.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-security-schemes.js +0 -62
- package/dist/helpers/operation-to-har/process-security-schemes.js.map +0 -7
- package/dist/helpers/operation-to-har/process-server-url.d.ts +0 -6
- package/dist/helpers/operation-to-har/process-server-url.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-server-url.js +0 -27
- package/dist/helpers/operation-to-har/process-server-url.js.map +0 -7
|
@@ -1,74 +1,26 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
export type XScalarEnvVar = z.infer<typeof xScalarEnvVarSchema>;
|
|
3
|
-
export declare const xScalarEnvVarSchema: z.ZodUnion<[z.ZodObject<{
|
|
3
|
+
export declare const xScalarEnvVarSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
4
4
|
description: z.ZodOptional<z.ZodString>;
|
|
5
5
|
default: z.ZodDefault<z.ZodString>;
|
|
6
|
-
},
|
|
7
|
-
default: string;
|
|
8
|
-
description?: string | undefined;
|
|
9
|
-
}, {
|
|
10
|
-
description?: string | undefined;
|
|
11
|
-
default?: string | undefined;
|
|
12
|
-
}>, z.ZodString]>;
|
|
6
|
+
}, z.core.$strip>, z.ZodString]>;
|
|
13
7
|
export declare const xScalarEnvironmentSchema: z.ZodObject<{
|
|
14
8
|
description: z.ZodOptional<z.ZodString>;
|
|
15
9
|
color: z.ZodOptional<z.ZodString>;
|
|
16
|
-
|
|
17
|
-
variables: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
|
|
10
|
+
variables: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
|
|
18
11
|
description: z.ZodOptional<z.ZodString>;
|
|
19
12
|
default: z.ZodDefault<z.ZodString>;
|
|
20
|
-
},
|
|
21
|
-
|
|
22
|
-
description?: string | undefined;
|
|
23
|
-
}, {
|
|
24
|
-
description?: string | undefined;
|
|
25
|
-
default?: string | undefined;
|
|
26
|
-
}>, z.ZodString]>>;
|
|
27
|
-
}, "strip", z.ZodTypeAny, {
|
|
28
|
-
variables: Record<string, string | {
|
|
29
|
-
default: string;
|
|
30
|
-
description?: string | undefined;
|
|
31
|
-
}>;
|
|
32
|
-
color?: string | undefined;
|
|
33
|
-
description?: string | undefined;
|
|
34
|
-
}, {
|
|
35
|
-
variables: Record<string, string | {
|
|
36
|
-
description?: string | undefined;
|
|
37
|
-
default?: string | undefined;
|
|
38
|
-
}>;
|
|
39
|
-
color?: string | undefined;
|
|
40
|
-
description?: string | undefined;
|
|
41
|
-
}>;
|
|
13
|
+
}, z.core.$strip>, z.ZodString]>>;
|
|
14
|
+
}, z.core.$strip>;
|
|
42
15
|
/** A map of environments by name */
|
|
43
16
|
export declare const xScalarEnvironmentsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
44
17
|
description: z.ZodOptional<z.ZodString>;
|
|
45
18
|
color: z.ZodOptional<z.ZodString>;
|
|
46
|
-
|
|
47
|
-
variables: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
|
|
19
|
+
variables: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
|
|
48
20
|
description: z.ZodOptional<z.ZodString>;
|
|
49
21
|
default: z.ZodDefault<z.ZodString>;
|
|
50
|
-
},
|
|
51
|
-
|
|
52
|
-
description?: string | undefined;
|
|
53
|
-
}, {
|
|
54
|
-
description?: string | undefined;
|
|
55
|
-
default?: string | undefined;
|
|
56
|
-
}>, z.ZodString]>>;
|
|
57
|
-
}, "strip", z.ZodTypeAny, {
|
|
58
|
-
variables: Record<string, string | {
|
|
59
|
-
default: string;
|
|
60
|
-
description?: string | undefined;
|
|
61
|
-
}>;
|
|
62
|
-
color?: string | undefined;
|
|
63
|
-
description?: string | undefined;
|
|
64
|
-
}, {
|
|
65
|
-
variables: Record<string, string | {
|
|
66
|
-
description?: string | undefined;
|
|
67
|
-
default?: string | undefined;
|
|
68
|
-
}>;
|
|
69
|
-
color?: string | undefined;
|
|
70
|
-
description?: string | undefined;
|
|
71
|
-
}>>;
|
|
22
|
+
}, z.core.$strip>, z.ZodString]>>;
|
|
23
|
+
}, z.core.$strip>>;
|
|
72
24
|
export type XScalarEnvironment = z.infer<typeof xScalarEnvironmentSchema>;
|
|
73
25
|
export type XScalarEnvironments = z.infer<typeof xScalarEnvironmentsSchema>;
|
|
74
26
|
//# sourceMappingURL=x-scalar-environments.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-scalar-environments.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/x-scalar-environments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,eAAO,MAAM,mBAAmB
|
|
1
|
+
{"version":3,"file":"x-scalar-environments.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/x-scalar-environments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,eAAO,MAAM,mBAAmB;;;gCAM9B,CAAA;AAEF,eAAO,MAAM,wBAAwB;;;;;;;iBAKnC,CAAA;AAEF,oCAAoC;AACpC,eAAO,MAAM,yBAAyB;;;;;;;kBAKrC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AACzE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA"}
|
|
@@ -2,22 +2,10 @@ import { z } from 'zod';
|
|
|
2
2
|
export declare const xScalarSecretVarSchema: z.ZodObject<{
|
|
3
3
|
description: z.ZodOptional<z.ZodString>;
|
|
4
4
|
example: z.ZodOptional<z.ZodString>;
|
|
5
|
-
},
|
|
6
|
-
description?: string | undefined;
|
|
7
|
-
example?: string | undefined;
|
|
8
|
-
}, {
|
|
9
|
-
description?: string | undefined;
|
|
10
|
-
example?: string | undefined;
|
|
11
|
-
}>;
|
|
5
|
+
}, z.core.$strip>;
|
|
12
6
|
export declare const xScalarSecretsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
13
7
|
description: z.ZodOptional<z.ZodString>;
|
|
14
8
|
example: z.ZodOptional<z.ZodString>;
|
|
15
|
-
},
|
|
16
|
-
description?: string | undefined;
|
|
17
|
-
example?: string | undefined;
|
|
18
|
-
}, {
|
|
19
|
-
description?: string | undefined;
|
|
20
|
-
example?: string | undefined;
|
|
21
|
-
}>>;
|
|
9
|
+
}, z.core.$strip>>;
|
|
22
10
|
export type XScalarSecrets = z.infer<typeof xScalarSecretsSchema>;
|
|
23
11
|
//# sourceMappingURL=x-scalar-secrets.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-scalar-secrets.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/x-scalar-secrets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,sBAAsB
|
|
1
|
+
{"version":3,"file":"x-scalar-secrets.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/x-scalar-secrets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,sBAAsB;;;iBAGjC,CAAA;AAEF,eAAO,MAAM,oBAAoB;;;kBAA+C,CAAA;AAChF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}
|
|
@@ -1,114 +1,234 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
declare const modifiers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.
|
|
2
|
+
declare const modifiers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"Meta">, z.ZodLiteral<"Control">, z.ZodLiteral<"Shift">, z.ZodLiteral<"Alt">, z.ZodLiteral<"default">]>>>>;
|
|
3
3
|
export type HotKeyModifiers = z.infer<typeof modifiers>;
|
|
4
|
-
declare const hotKeys: z.ZodRecord<z.ZodEnum<
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
4
|
+
declare const hotKeys: z.ZodRecord<z.ZodEnum<{
|
|
5
|
+
"": "";
|
|
6
|
+
Space: "Space";
|
|
7
|
+
Backspace: "Backspace";
|
|
8
|
+
Tab: "Tab";
|
|
9
|
+
Enter: "Enter";
|
|
10
|
+
Escape: "Escape";
|
|
11
|
+
ArrowDown: "ArrowDown";
|
|
12
|
+
ArrowLeft: "ArrowLeft";
|
|
13
|
+
ArrowRight: "ArrowRight";
|
|
14
|
+
ArrowUp: "ArrowUp";
|
|
15
|
+
End: "End";
|
|
16
|
+
Home: "Home";
|
|
17
|
+
PageDown: "PageDown";
|
|
18
|
+
PageUp: "PageUp";
|
|
19
|
+
Delete: "Delete";
|
|
20
|
+
0: "0";
|
|
21
|
+
1: "1";
|
|
22
|
+
2: "2";
|
|
23
|
+
3: "3";
|
|
24
|
+
4: "4";
|
|
25
|
+
5: "5";
|
|
26
|
+
6: "6";
|
|
27
|
+
7: "7";
|
|
28
|
+
8: "8";
|
|
29
|
+
9: "9";
|
|
30
|
+
a: "a";
|
|
31
|
+
b: "b";
|
|
32
|
+
c: "c";
|
|
33
|
+
d: "d";
|
|
34
|
+
e: "e";
|
|
35
|
+
f: "f";
|
|
36
|
+
g: "g";
|
|
37
|
+
h: "h";
|
|
38
|
+
i: "i";
|
|
39
|
+
j: "j";
|
|
40
|
+
k: "k";
|
|
41
|
+
l: "l";
|
|
42
|
+
m: "m";
|
|
43
|
+
n: "n";
|
|
44
|
+
o: "o";
|
|
45
|
+
p: "p";
|
|
46
|
+
q: "q";
|
|
47
|
+
r: "r";
|
|
48
|
+
s: "s";
|
|
49
|
+
t: "t";
|
|
50
|
+
u: "u";
|
|
51
|
+
v: "v";
|
|
52
|
+
w: "w";
|
|
53
|
+
x: "x";
|
|
54
|
+
y: "y";
|
|
55
|
+
z: "z";
|
|
56
|
+
"*": "*";
|
|
57
|
+
"+": "+";
|
|
58
|
+
"-": "-";
|
|
59
|
+
".": ".";
|
|
60
|
+
"/": "/";
|
|
61
|
+
F1: "F1";
|
|
62
|
+
F2: "F2";
|
|
63
|
+
F3: "F3";
|
|
64
|
+
F4: "F4";
|
|
65
|
+
F5: "F5";
|
|
66
|
+
F6: "F6";
|
|
67
|
+
F7: "F7";
|
|
68
|
+
F8: "F8";
|
|
69
|
+
F9: "F9";
|
|
70
|
+
F10: "F10";
|
|
71
|
+
F11: "F11";
|
|
72
|
+
F12: "F12";
|
|
73
|
+
";": ";";
|
|
74
|
+
"=": "=";
|
|
75
|
+
",": ",";
|
|
76
|
+
"`": "`";
|
|
77
|
+
"[": "[";
|
|
78
|
+
"\\": "\\";
|
|
79
|
+
"]": "]";
|
|
80
|
+
}> & z.core.$partial, z.ZodObject<{
|
|
81
|
+
modifiers: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"Meta">, z.ZodLiteral<"Control">, z.ZodLiteral<"Shift">, z.ZodLiteral<"Alt">, z.ZodLiteral<"default">]>>>>>;
|
|
82
|
+
event: z.ZodEnum<{
|
|
83
|
+
addTopNav: "addTopNav";
|
|
84
|
+
closeModal: "closeModal";
|
|
85
|
+
closeTopNav: "closeTopNav";
|
|
86
|
+
createNew: "createNew";
|
|
87
|
+
executeRequest: "executeRequest";
|
|
88
|
+
focusAddressBar: "focusAddressBar";
|
|
89
|
+
focusRequestSearch: "focusRequestSearch";
|
|
90
|
+
jumpToLastTab: "jumpToLastTab";
|
|
91
|
+
jumpToTab: "jumpToTab";
|
|
92
|
+
navigateSearchResultsDown: "navigateSearchResultsDown";
|
|
93
|
+
navigateSearchResultsUp: "navigateSearchResultsUp";
|
|
94
|
+
navigateTopNavLeft: "navigateTopNavLeft";
|
|
95
|
+
navigateTopNavRight: "navigateTopNavRight";
|
|
96
|
+
openCommandPalette: "openCommandPalette";
|
|
97
|
+
selectSearchResult: "selectSearchResult";
|
|
98
|
+
toggleSidebar: "toggleSidebar";
|
|
99
|
+
}>;
|
|
100
|
+
}, z.core.$strip>>;
|
|
14
101
|
export type HotKeyConfig = z.infer<typeof hotKeys>;
|
|
15
102
|
export declare const workspaceSchema: z.ZodObject<{
|
|
16
|
-
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "workspace">;
|
|
103
|
+
uid: z.core.$ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "workspace">;
|
|
17
104
|
name: z.ZodDefault<z.ZodString>;
|
|
18
|
-
/** Workspace description */
|
|
19
105
|
description: z.ZodDefault<z.ZodString>;
|
|
20
|
-
|
|
21
|
-
collections: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "collection">, "many">>;
|
|
22
|
-
/** List of all environment uids in a given workspace, TODO: why is this a record? */
|
|
106
|
+
collections: z.ZodDefault<z.ZodArray<z.core.$ZodBranded<z.ZodString, "collection">>>;
|
|
23
107
|
environments: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
24
|
-
/** Customize hotkeys */
|
|
25
108
|
hotKeyConfig: z.ZodOptional<z.ZodObject<{
|
|
26
|
-
modifiers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.
|
|
27
|
-
hotKeys: z.ZodOptional<z.ZodRecord<z.ZodEnum<
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
109
|
+
modifiers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"Meta">, z.ZodLiteral<"Control">, z.ZodLiteral<"Shift">, z.ZodLiteral<"Alt">, z.ZodLiteral<"default">]>>>>;
|
|
110
|
+
hotKeys: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
111
|
+
"": "";
|
|
112
|
+
Space: "Space";
|
|
113
|
+
Backspace: "Backspace";
|
|
114
|
+
Tab: "Tab";
|
|
115
|
+
Enter: "Enter";
|
|
116
|
+
Escape: "Escape";
|
|
117
|
+
ArrowDown: "ArrowDown";
|
|
118
|
+
ArrowLeft: "ArrowLeft";
|
|
119
|
+
ArrowRight: "ArrowRight";
|
|
120
|
+
ArrowUp: "ArrowUp";
|
|
121
|
+
End: "End";
|
|
122
|
+
Home: "Home";
|
|
123
|
+
PageDown: "PageDown";
|
|
124
|
+
PageUp: "PageUp";
|
|
125
|
+
Delete: "Delete";
|
|
126
|
+
0: "0";
|
|
127
|
+
1: "1";
|
|
128
|
+
2: "2";
|
|
129
|
+
3: "3";
|
|
130
|
+
4: "4";
|
|
131
|
+
5: "5";
|
|
132
|
+
6: "6";
|
|
133
|
+
7: "7";
|
|
134
|
+
8: "8";
|
|
135
|
+
9: "9";
|
|
136
|
+
a: "a";
|
|
137
|
+
b: "b";
|
|
138
|
+
c: "c";
|
|
139
|
+
d: "d";
|
|
140
|
+
e: "e";
|
|
141
|
+
f: "f";
|
|
142
|
+
g: "g";
|
|
143
|
+
h: "h";
|
|
144
|
+
i: "i";
|
|
145
|
+
j: "j";
|
|
146
|
+
k: "k";
|
|
147
|
+
l: "l";
|
|
148
|
+
m: "m";
|
|
149
|
+
n: "n";
|
|
150
|
+
o: "o";
|
|
151
|
+
p: "p";
|
|
152
|
+
q: "q";
|
|
153
|
+
r: "r";
|
|
154
|
+
s: "s";
|
|
155
|
+
t: "t";
|
|
156
|
+
u: "u";
|
|
157
|
+
v: "v";
|
|
158
|
+
w: "w";
|
|
159
|
+
x: "x";
|
|
160
|
+
y: "y";
|
|
161
|
+
z: "z";
|
|
162
|
+
"*": "*";
|
|
163
|
+
"+": "+";
|
|
164
|
+
"-": "-";
|
|
165
|
+
".": ".";
|
|
166
|
+
"/": "/";
|
|
167
|
+
F1: "F1";
|
|
168
|
+
F2: "F2";
|
|
169
|
+
F3: "F3";
|
|
170
|
+
F4: "F4";
|
|
171
|
+
F5: "F5";
|
|
172
|
+
F6: "F6";
|
|
173
|
+
F7: "F7";
|
|
174
|
+
F8: "F8";
|
|
175
|
+
F9: "F9";
|
|
176
|
+
F10: "F10";
|
|
177
|
+
F11: "F11";
|
|
178
|
+
F12: "F12";
|
|
179
|
+
";": ";";
|
|
180
|
+
"=": "=";
|
|
181
|
+
",": ",";
|
|
182
|
+
"`": "`";
|
|
183
|
+
"[": "[";
|
|
184
|
+
"\\": "\\";
|
|
185
|
+
"]": "]";
|
|
186
|
+
}> & z.core.$partial, z.ZodObject<{
|
|
187
|
+
modifiers: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"Meta">, z.ZodLiteral<"Control">, z.ZodLiteral<"Shift">, z.ZodLiteral<"Alt">, z.ZodLiteral<"default">]>>>>>;
|
|
188
|
+
event: z.ZodEnum<{
|
|
189
|
+
addTopNav: "addTopNav";
|
|
190
|
+
closeModal: "closeModal";
|
|
191
|
+
closeTopNav: "closeTopNav";
|
|
192
|
+
createNew: "createNew";
|
|
193
|
+
executeRequest: "executeRequest";
|
|
194
|
+
focusAddressBar: "focusAddressBar";
|
|
195
|
+
focusRequestSearch: "focusRequestSearch";
|
|
196
|
+
jumpToLastTab: "jumpToLastTab";
|
|
197
|
+
jumpToTab: "jumpToTab";
|
|
198
|
+
navigateSearchResultsDown: "navigateSearchResultsDown";
|
|
199
|
+
navigateSearchResultsUp: "navigateSearchResultsUp";
|
|
200
|
+
navigateTopNavLeft: "navigateTopNavLeft";
|
|
201
|
+
navigateTopNavRight: "navigateTopNavRight";
|
|
202
|
+
openCommandPalette: "openCommandPalette";
|
|
203
|
+
selectSearchResult: "selectSearchResult";
|
|
204
|
+
toggleSidebar: "toggleSidebar";
|
|
205
|
+
}>;
|
|
206
|
+
}, z.core.$strip>>>;
|
|
207
|
+
}, z.core.$strip>>;
|
|
51
208
|
activeEnvironmentId: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
52
|
-
|
|
53
|
-
cookies: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "cookie">, "many">>;
|
|
54
|
-
/** Workspace level proxy for all requests to be sent through */
|
|
209
|
+
cookies: z.ZodDefault<z.ZodArray<z.core.$ZodBranded<z.ZodString, "cookie">>>;
|
|
55
210
|
proxyUrl: z.ZodOptional<z.ZodString>;
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
211
|
+
themeId: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
212
|
+
default: "default";
|
|
213
|
+
alternate: "alternate";
|
|
214
|
+
moon: "moon";
|
|
215
|
+
purple: "purple";
|
|
216
|
+
solarized: "solarized";
|
|
217
|
+
bluePlanet: "bluePlanet";
|
|
218
|
+
deepSpace: "deepSpace";
|
|
219
|
+
saturn: "saturn";
|
|
220
|
+
kepler: "kepler";
|
|
221
|
+
elysiajs: "elysiajs";
|
|
222
|
+
fastify: "fastify";
|
|
223
|
+
mars: "mars";
|
|
224
|
+
laserwave: "laserwave";
|
|
225
|
+
none: "none";
|
|
226
|
+
}>>>>;
|
|
59
227
|
selectedHttpClient: z.ZodDefault<z.ZodOptional<z.ZodObject<{
|
|
60
228
|
targetKey: z.ZodString;
|
|
61
229
|
clientKey: z.ZodString;
|
|
62
|
-
},
|
|
63
|
-
|
|
64
|
-
clientKey: string;
|
|
65
|
-
}, {
|
|
66
|
-
targetKey: string;
|
|
67
|
-
clientKey: string;
|
|
68
|
-
}>>>;
|
|
69
|
-
}, "strip", z.ZodTypeAny, {
|
|
70
|
-
uid: string & z.BRAND<"workspace">;
|
|
71
|
-
name: string;
|
|
72
|
-
description: string;
|
|
73
|
-
cookies: (string & z.BRAND<"cookie">)[];
|
|
74
|
-
collections: (string & z.BRAND<"collection">)[];
|
|
75
|
-
environments: Record<string, string>;
|
|
76
|
-
activeEnvironmentId: string;
|
|
77
|
-
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
|
|
78
|
-
selectedHttpClient: {
|
|
79
|
-
targetKey: string;
|
|
80
|
-
clientKey: string;
|
|
81
|
-
};
|
|
82
|
-
hotKeyConfig?: {
|
|
83
|
-
modifiers: ("default" | "Meta" | "Control" | "Shift" | "Alt")[];
|
|
84
|
-
hotKeys?: Partial<Record<"" | "0" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "/" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
|
|
85
|
-
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
86
|
-
modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt")[] | undefined;
|
|
87
|
-
}>> | undefined;
|
|
88
|
-
} | undefined;
|
|
89
|
-
proxyUrl?: string | undefined;
|
|
90
|
-
}, {
|
|
91
|
-
uid?: string | undefined;
|
|
92
|
-
name?: string | undefined;
|
|
93
|
-
description?: string | undefined;
|
|
94
|
-
cookies?: string[] | undefined;
|
|
95
|
-
collections?: string[] | undefined;
|
|
96
|
-
environments?: Record<string, string> | undefined;
|
|
97
|
-
hotKeyConfig?: {
|
|
98
|
-
modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
|
|
99
|
-
hotKeys?: Partial<Record<"" | "0" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "/" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
|
|
100
|
-
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
101
|
-
modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
|
|
102
|
-
}>> | undefined;
|
|
103
|
-
} | undefined;
|
|
104
|
-
activeEnvironmentId?: string | undefined;
|
|
105
|
-
proxyUrl?: string | undefined;
|
|
106
|
-
themeId?: unknown;
|
|
107
|
-
selectedHttpClient?: {
|
|
108
|
-
targetKey: string;
|
|
109
|
-
clientKey: string;
|
|
110
|
-
} | undefined;
|
|
111
|
-
}>;
|
|
230
|
+
}, z.core.$strip>>>;
|
|
231
|
+
}, z.core.$strip>;
|
|
112
232
|
/** The base scalar workspace */
|
|
113
233
|
export type Workspace = z.infer<typeof workspaceSchema>;
|
|
114
234
|
export type WorkspacePayload = z.input<typeof workspaceSchema>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../../../src/entities/workspace/workspace.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../../../src/entities/workspace/workspace.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,QAAA,MAAM,SAAS,oLAGQ,CAAA;AAEvB,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEvD,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAMZ,CAAA;AACD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAA;AASlD,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA8B1B,CAAA;AAEF,gCAAgC;AAChC,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AACvD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { themeIds } from "@scalar/themes";
|
|
2
|
-
import { z } from "zod";
|
|
3
2
|
import { nanoidSchema } from "@scalar/types/utils";
|
|
3
|
+
import { z } from "zod";
|
|
4
4
|
import { HOTKEY_EVENT_NAMES, KEYDOWN_KEYS } from "../hotkeys/hotkeys.js";
|
|
5
|
-
const
|
|
6
|
-
const
|
|
7
|
-
const hotKeys = z.record(
|
|
5
|
+
const modifiers = z.array(z.union([z.literal("Meta"), z.literal("Control"), z.literal("Shift"), z.literal("Alt"), z.literal("default")])).optional().default(["default"]);
|
|
6
|
+
const hotKeys = z.partialRecord(
|
|
8
7
|
z.enum(KEYDOWN_KEYS),
|
|
9
8
|
z.object({
|
|
10
9
|
modifiers: modifiers.optional(),
|
|
@@ -23,7 +22,7 @@ const workspaceSchema = z.object({
|
|
|
23
22
|
/** List of all collection uids in a given workspace */
|
|
24
23
|
collections: z.array(z.string().brand()).default([]),
|
|
25
24
|
/** List of all environment uids in a given workspace, TODO: why is this a record? */
|
|
26
|
-
environments: z.record(z.string()).default({}),
|
|
25
|
+
environments: z.record(z.string(), z.string()).default({}),
|
|
27
26
|
/** Customize hotkeys */
|
|
28
27
|
hotKeyConfig: hotKeyConfigSchema,
|
|
29
28
|
/** Active Environment ID to use for requests */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/entities/workspace/workspace.ts"],
|
|
4
|
-
"sourcesContent": ["import { themeIds } from '@scalar/themes'\nimport {
|
|
5
|
-
"mappings": "AAAA,SAAS,gBAAgB;AACzB,
|
|
4
|
+
"sourcesContent": ["import { themeIds } from '@scalar/themes'\nimport { type ENTITY_BRANDS, nanoidSchema } from '@scalar/types/utils'\nimport { z } from 'zod'\n\nimport { HOTKEY_EVENT_NAMES, KEYDOWN_KEYS } from '../hotkeys/hotkeys'\n\nconst modifiers = z\n .array(z.union([z.literal('Meta'), z.literal('Control'), z.literal('Shift'), z.literal('Alt'), z.literal('default')]))\n .optional()\n .default(['default'])\n\nexport type HotKeyModifiers = z.infer<typeof modifiers>\n\nconst hotKeys = z.partialRecord(\n z.enum(KEYDOWN_KEYS),\n z.object({\n modifiers: modifiers.optional(),\n event: z.enum(HOTKEY_EVENT_NAMES),\n }),\n)\nexport type HotKeyConfig = z.infer<typeof hotKeys>\n\nconst hotKeyConfigSchema = z\n .object({\n modifiers,\n hotKeys: hotKeys.optional(),\n })\n .optional()\n\nexport const workspaceSchema = z.object({\n uid: nanoidSchema.brand<ENTITY_BRANDS['WORKSPACE']>(),\n name: z.string().default('Default Workspace'),\n /** Workspace description */\n description: z.string().default('Basic Scalar Workspace'),\n /** List of all collection uids in a given workspace */\n collections: z.array(z.string().brand<ENTITY_BRANDS['COLLECTION']>()).default([]),\n /** List of all environment uids in a given workspace, TODO: why is this a record? */\n environments: z.record(z.string(), z.string()).default({}),\n /** Customize hotkeys */\n hotKeyConfig: hotKeyConfigSchema,\n /** Active Environment ID to use for requests */\n activeEnvironmentId: z.string().optional().default('default'),\n /** List of all cookie uids in a given workspace */\n cookies: z.array(z.string().brand<ENTITY_BRANDS['COOKIE']>()).default([]),\n /** Workspace level proxy for all requests to be sent through */\n proxyUrl: z.string().optional(),\n /** Workspace level theme, we might move this to user level later */\n themeId: z.enum(themeIds).optional().default('default').catch('default'),\n /** Currently selected snippet client */\n selectedHttpClient: z\n .object({\n targetKey: z.string(),\n clientKey: z.string(),\n })\n .optional()\n .default({\n targetKey: 'shell',\n clientKey: 'curl',\n }),\n})\n\n/** The base scalar workspace */\nexport type Workspace = z.infer<typeof workspaceSchema>\nexport type WorkspacePayload = z.input<typeof workspaceSchema>\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,gBAAgB;AACzB,SAA6B,oBAAoB;AACjD,SAAS,SAAS;AAElB,SAAS,oBAAoB,oBAAoB;AAEjD,MAAM,YAAY,EACf,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,MAAM,GAAG,EAAE,QAAQ,SAAS,GAAG,EAAE,QAAQ,OAAO,GAAG,EAAE,QAAQ,KAAK,GAAG,EAAE,QAAQ,SAAS,CAAC,CAAC,CAAC,EACpH,SAAS,EACT,QAAQ,CAAC,SAAS,CAAC;AAItB,MAAM,UAAU,EAAE;AAAA,EAChB,EAAE,KAAK,YAAY;AAAA,EACnB,EAAE,OAAO;AAAA,IACP,WAAW,UAAU,SAAS;AAAA,IAC9B,OAAO,EAAE,KAAK,kBAAkB;AAAA,EAClC,CAAC;AACH;AAGA,MAAM,qBAAqB,EACxB,OAAO;AAAA,EACN;AAAA,EACA,SAAS,QAAQ,SAAS;AAC5B,CAAC,EACA,SAAS;AAEL,MAAM,kBAAkB,EAAE,OAAO;AAAA,EACtC,KAAK,aAAa,MAAkC;AAAA,EACpD,MAAM,EAAE,OAAO,EAAE,QAAQ,mBAAmB;AAAA;AAAA,EAE5C,aAAa,EAAE,OAAO,EAAE,QAAQ,wBAAwB;AAAA;AAAA,EAExD,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAmC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEhF,cAAc,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEzD,cAAc;AAAA;AAAA,EAEd,qBAAqB,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,SAAS;AAAA;AAAA,EAE5D,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAA+B,CAAC,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAExE,UAAU,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE9B,SAAS,EAAE,KAAK,QAAQ,EAAE,SAAS,EAAE,QAAQ,SAAS,EAAE,MAAM,SAAS;AAAA;AAAA,EAEvE,oBAAoB,EACjB,OAAO;AAAA,IACN,WAAW,EAAE,OAAO;AAAA,IACpB,WAAW,EAAE,OAAO;AAAA,EACtB,CAAC,EACA,SAAS,EACT,QAAQ;AAAA,IACP,WAAW;AAAA,IACX,WAAW;AAAA,EACb,CAAC;AACL,CAAC;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/dist/helpers/parse.js
CHANGED
|
@@ -2,7 +2,7 @@ import { parse, stringify } from "yaml";
|
|
|
2
2
|
const yaml = {
|
|
3
3
|
/** Parse and throw if the return value is not an object */
|
|
4
4
|
parse: (val) => {
|
|
5
|
-
const yamlObject = parse(val);
|
|
5
|
+
const yamlObject = parse(val, { merge: true, maxAliasCount: 1e4 });
|
|
6
6
|
if (typeof yamlObject !== "object") {
|
|
7
7
|
throw Error("Invalid YAML object");
|
|
8
8
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/helpers/parse.ts"],
|
|
4
|
-
"sourcesContent": ["import type { UnknownObject } from '@scalar/types/utils'\nimport { parse, stringify } from 'yaml'\n\ntype PrimitiveOrObject = object | string | null | number | boolean | undefined\n\n/** Yaml handling with optional safeparse */\nexport const yaml = {\n /** Parse and throw if the return value is not an object */\n parse: (val: string) => {\n const yamlObject = parse(val)\n if (typeof yamlObject !== 'object') {\n throw Error('Invalid YAML object')\n }\n return yamlObject as UnknownObject\n },\n /** Parse and return a fallback on failure */\n parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): UnknownObject | T {\n try {\n return yaml.parse(val)\n } catch (err: any) {\n return typeof fallback === 'function' ? fallback(err) : fallback\n }\n },\n stringify,\n}\n\n/** JSON handling with optional safeparse */\nexport const json = {\n /** Parse and throw if the return value is not an object */\n parse: (val: string): UnknownObject => {\n const jsonObject = JSON.parse(val)\n if (typeof jsonObject !== 'object') {\n throw Error('Invalid JSON object')\n }\n return jsonObject\n },\n /** Parse and return a fallback on failure */\n parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): UnknownObject | T {\n try {\n return json.parse(val)\n } catch (err) {\n return typeof fallback === 'function' ? fallback(err) : fallback\n }\n },\n stringify: (val: object) => JSON.stringify(val),\n}\n\n/**\n * Check if value is a valid JSON string\n */\nexport const isJsonString = (value?: any) => {\n if (typeof value !== 'string') {\n return false\n }\n\n return !!json.parseSafe(value, false)\n}\n\n/**\n * This helper is used to transform the content of the swagger file to JSON, even it was YAML.\n */\nexport const transformToJson = (value: string) => {\n // Try json, then fallback to yaml, then fallback to string\n return JSON.stringify(json.parseSafe(value, yaml.parseSafe(value, value)))\n}\n\n/** Validates a JSON string if provided. Otherwise returns the raw YAML */\nexport function formatJsonOrYamlString(value: string) {\n // If we don't start with a bracket assume yaml\n const trimmed = value.trim()\n if (trimmed[0] !== '{' && trimmed[0] !== '[') {\n return value\n }\n\n try {\n // JSON\n return JSON.stringify(JSON.parse(value), null, 2)\n } catch {\n // YAML\n return value\n }\n}\n\n/** Parse JSON or YAML into an object */\nexport const parseJsonOrYaml = (value: string | UnknownObject): UnknownObject => {\n if (typeof value !== 'string') {\n return value\n }\n\n const jsonObject = json.parseSafe(value, null)\n if (jsonObject) {\n return jsonObject\n }\n\n // Value is probably supposed to be JSON. Throw\n if (value.length > 0 && ['{', '['].includes(value[0] ?? '')) {\n throw Error('Invalid JSON or YAML')\n }\n\n return yaml.parseSafe(value, (err) => {\n throw Error(err)\n })\n}\n"],
|
|
5
|
-
"mappings": "AACA,SAAS,OAAO,iBAAiB;AAK1B,MAAM,OAAO;AAAA;AAAA,EAElB,OAAO,CAAC,QAAgB;AACtB,UAAM,aAAa,MAAM,
|
|
4
|
+
"sourcesContent": ["import type { UnknownObject } from '@scalar/types/utils'\nimport { parse, stringify } from 'yaml'\n\ntype PrimitiveOrObject = object | string | null | number | boolean | undefined\n\n/** Yaml handling with optional safeparse */\nexport const yaml = {\n /** Parse and throw if the return value is not an object */\n parse: (val: string) => {\n const yamlObject = parse(val, { merge: true, maxAliasCount: 10000 })\n if (typeof yamlObject !== 'object') {\n throw Error('Invalid YAML object')\n }\n return yamlObject as UnknownObject\n },\n /** Parse and return a fallback on failure */\n parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): UnknownObject | T {\n try {\n return yaml.parse(val)\n } catch (err: any) {\n return typeof fallback === 'function' ? fallback(err) : fallback\n }\n },\n stringify,\n}\n\n/** JSON handling with optional safeparse */\nexport const json = {\n /** Parse and throw if the return value is not an object */\n parse: (val: string): UnknownObject => {\n const jsonObject = JSON.parse(val)\n if (typeof jsonObject !== 'object') {\n throw Error('Invalid JSON object')\n }\n return jsonObject\n },\n /** Parse and return a fallback on failure */\n parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): UnknownObject | T {\n try {\n return json.parse(val)\n } catch (err) {\n return typeof fallback === 'function' ? fallback(err) : fallback\n }\n },\n stringify: (val: object) => JSON.stringify(val),\n}\n\n/**\n * Check if value is a valid JSON string\n */\nexport const isJsonString = (value?: any) => {\n if (typeof value !== 'string') {\n return false\n }\n\n return !!json.parseSafe(value, false)\n}\n\n/**\n * This helper is used to transform the content of the swagger file to JSON, even it was YAML.\n */\nexport const transformToJson = (value: string) => {\n // Try json, then fallback to yaml, then fallback to string\n return JSON.stringify(json.parseSafe(value, yaml.parseSafe(value, value)))\n}\n\n/** Validates a JSON string if provided. Otherwise returns the raw YAML */\nexport function formatJsonOrYamlString(value: string) {\n // If we don't start with a bracket assume yaml\n const trimmed = value.trim()\n if (trimmed[0] !== '{' && trimmed[0] !== '[') {\n return value\n }\n\n try {\n // JSON\n return JSON.stringify(JSON.parse(value), null, 2)\n } catch {\n // YAML\n return value\n }\n}\n\n/** Parse JSON or YAML into an object */\nexport const parseJsonOrYaml = (value: string | UnknownObject): UnknownObject => {\n if (typeof value !== 'string') {\n return value\n }\n\n const jsonObject = json.parseSafe(value, null)\n if (jsonObject) {\n return jsonObject\n }\n\n // Value is probably supposed to be JSON. Throw\n if (value.length > 0 && ['{', '['].includes(value[0] ?? '')) {\n throw Error('Invalid JSON or YAML')\n }\n\n return yaml.parseSafe(value, (err) => {\n throw Error(err)\n })\n}\n"],
|
|
5
|
+
"mappings": "AACA,SAAS,OAAO,iBAAiB;AAK1B,MAAM,OAAO;AAAA;AAAA,EAElB,OAAO,CAAC,QAAgB;AACtB,UAAM,aAAa,MAAM,KAAK,EAAE,OAAO,MAAM,eAAe,IAAM,CAAC;AACnE,QAAI,OAAO,eAAe,UAAU;AAClC,YAAM,MAAM,qBAAqB;AAAA,IACnC;AACA,WAAO;AAAA,EACT;AAAA;AAAA,EAEA,UAAuC,KAAa,UAAoD;AACtG,QAAI;AACF,aAAO,KAAK,MAAM,GAAG;AAAA,IACvB,SAAS,KAAU;AACjB,aAAO,OAAO,aAAa,aAAa,SAAS,GAAG,IAAI;AAAA,IAC1D;AAAA,EACF;AAAA,EACA;AACF;AAGO,MAAM,OAAO;AAAA;AAAA,EAElB,OAAO,CAAC,QAA+B;AACrC,UAAM,aAAa,KAAK,MAAM,GAAG;AACjC,QAAI,OAAO,eAAe,UAAU;AAClC,YAAM,MAAM,qBAAqB;AAAA,IACnC;AACA,WAAO;AAAA,EACT;AAAA;AAAA,EAEA,UAAuC,KAAa,UAAoD;AACtG,QAAI;AACF,aAAO,KAAK,MAAM,GAAG;AAAA,IACvB,SAAS,KAAK;AACZ,aAAO,OAAO,aAAa,aAAa,SAAS,GAAG,IAAI;AAAA,IAC1D;AAAA,EACF;AAAA,EACA,WAAW,CAAC,QAAgB,KAAK,UAAU,GAAG;AAChD;AAKO,MAAM,eAAe,CAAC,UAAgB;AAC3C,MAAI,OAAO,UAAU,UAAU;AAC7B,WAAO;AAAA,EACT;AAEA,SAAO,CAAC,CAAC,KAAK,UAAU,OAAO,KAAK;AACtC;AAKO,MAAM,kBAAkB,CAAC,UAAkB;AAEhD,SAAO,KAAK,UAAU,KAAK,UAAU,OAAO,KAAK,UAAU,OAAO,KAAK,CAAC,CAAC;AAC3E;AAGO,SAAS,uBAAuB,OAAe;AAEpD,QAAM,UAAU,MAAM,KAAK;AAC3B,MAAI,QAAQ,CAAC,MAAM,OAAO,QAAQ,CAAC,MAAM,KAAK;AAC5C,WAAO;AAAA,EACT;AAEA,MAAI;AAEF,WAAO,KAAK,UAAU,KAAK,MAAM,KAAK,GAAG,MAAM,CAAC;AAAA,EAClD,QAAQ;AAEN,WAAO;AAAA,EACT;AACF;AAGO,MAAM,kBAAkB,CAAC,UAAiD;AAC/E,MAAI,OAAO,UAAU,UAAU;AAC7B,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,KAAK,UAAU,OAAO,IAAI;AAC7C,MAAI,YAAY;AACd,WAAO;AAAA,EACT;AAGA,MAAI,MAAM,SAAS,KAAK,CAAC,KAAK,GAAG,EAAE,SAAS,MAAM,CAAC,KAAK,EAAE,GAAG;AAC3D,UAAM,MAAM,sBAAsB;AAAA,EACpC;AAEA,SAAO,KAAK,UAAU,OAAO,CAAC,QAAQ;AACpC,UAAM,MAAM,GAAG;AAAA,EACjB,CAAC;AACH;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import type z from 'zod';
|
|
2
2
|
/** Parse an value from a given schema with optional error or null return */
|
|
3
|
-
export declare function schemaModel<T, I = any>(data: I, schema:
|
|
4
|
-
export declare function schemaModel<T, I = any>(data: I, schema:
|
|
3
|
+
export declare function schemaModel<T extends z.ZodType, I = any>(data: I, schema: T, throwError?: true, errorLocation?: string): z.infer<T>;
|
|
4
|
+
export declare function schemaModel<T, I = any>(data: I, schema: T, throwError?: false, errorLocation?: string): z.infer<T> | null;
|
|
5
5
|
//# sourceMappingURL=schema-model.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema-model.d.ts","sourceRoot":"","sources":["../../src/helpers/schema-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"schema-model.d.ts","sourceRoot":"","sources":["../../src/helpers/schema-model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,4EAA4E;AAC5E,wBAAgB,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,GAAG,EACtD,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,CAAC,EACT,UAAU,CAAC,EAAE,IAAI,EACjB,aAAa,CAAC,EAAE,MAAM,GACrB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AACb,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,EACpC,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,CAAC,EACT,UAAU,CAAC,EAAE,KAAK,EAClB,aAAa,CAAC,EAAE,MAAM,GACrB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/helpers/schema-model.ts"],
|
|
4
|
-
"sourcesContent": ["import type
|
|
4
|
+
"sourcesContent": ["import type z from 'zod'\n\n/** Parse an value from a given schema with optional error or null return */\nexport function schemaModel<T extends z.ZodType, I = any>(\n data: I,\n schema: T,\n throwError?: true,\n errorLocation?: string,\n): z.infer<T>\nexport function schemaModel<T, I = any>(\n data: I,\n schema: T,\n throwError?: false,\n errorLocation?: string,\n): z.infer<T> | null\n/** Parse a Zod */\nexport function schemaModel<T extends z.ZodType, I = any>(\n data: I,\n schema: T,\n throwError = true,\n errorLocation?: string,\n) {\n const result = schema.safeParse(data)\n\n if (!result.success) {\n console.group('Schema Error' + (errorLocation ? ` - ${errorLocation}` : ''))\n console.warn(JSON.stringify(result.error.format(), null, 2))\n console.log('Received: ', data)\n console.groupEnd()\n }\n\n if (throwError && !result.success) {\n throw new Error('Zod validation failure')\n }\n\n return result.data\n}\n"],
|
|
5
5
|
"mappings": "AAgBO,SAAS,YACd,MACA,QACA,aAAa,MACb,eACA;AACA,QAAM,SAAS,OAAO,UAAU,IAAI;AAEpC,MAAI,CAAC,OAAO,SAAS;AACnB,YAAQ,MAAM,kBAAkB,gBAAgB,MAAM,aAAa,KAAK,GAAG;AAC3E,YAAQ,KAAK,KAAK,UAAU,OAAO,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC;AAC3D,YAAQ,IAAI,cAAc,IAAI;AAC9B,YAAQ,SAAS;AAAA,EACnB;AAEA,MAAI,cAAc,CAAC,OAAO,SAAS;AACjC,UAAM,IAAI,MAAM,wBAAwB;AAAA,EAC1C;AAEA,SAAO,OAAO;AAChB;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|