@scalar/oas-utils 0.2.95 → 0.2.96
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 +9 -0
- package/dist/entities/hotkeys/hotkeys.d.ts +1 -1
- package/dist/entities/hotkeys/hotkeys.d.ts.map +1 -1
- package/dist/entities/hotkeys/hotkeys.js +11 -10
- package/dist/entities/workspace/workspace.d.ts +10 -10
- package/dist/spec-getters/getExampleFromSchema.d.ts.map +1 -1
- package/dist/spec-getters/getExampleFromSchema.js +11 -0
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# @scalar/oas-utils
|
|
2
2
|
|
|
3
|
+
## 0.2.96
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- cf0e7b1: feat: generate examples for objects with patternProperties
|
|
8
|
+
- Updated dependencies [7b4ab2c]
|
|
9
|
+
- @scalar/themes@0.9.59
|
|
10
|
+
- @scalar/types@0.0.25
|
|
11
|
+
|
|
3
12
|
## 0.2.95
|
|
4
13
|
|
|
5
14
|
### Patch Changes
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Array of all of the events that we support
|
|
3
3
|
*/
|
|
4
|
-
export declare const HOTKEY_EVENT_NAMES: readonly ["closeModal", "
|
|
4
|
+
export declare const HOTKEY_EVENT_NAMES: readonly ["addTopNav", "closeModal", "closeTopNav", "createNew", "executeRequest", "focusAddressBar", "focusRequestSearch", "jumpToLastTab", "jumpToTab", "navigateSearchResultsDown", "navigateSearchResultsUp", "navigateTopNavLeft", "navigateTopNavRight", "openCommandPalette", "selectSearchResult", "toggleSidebar"];
|
|
5
5
|
export type HotkeyEventName = (typeof HOTKEY_EVENT_NAMES)[number];
|
|
6
6
|
/**
|
|
7
7
|
* Array of all of the hotkeys that we support
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hotkeys.d.ts","sourceRoot":"","sources":["../../../src/entities/hotkeys/hotkeys.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,kBAAkB,
|
|
1
|
+
{"version":3,"file":"hotkeys.d.ts","sourceRoot":"","sources":["../../../src/entities/hotkeys/hotkeys.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,kBAAkB,6TAiBrB,CAAA;AACV,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEjE;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,8hBAyFf,CAAA;AACV,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA"}
|
|
@@ -2,21 +2,22 @@
|
|
|
2
2
|
* Array of all of the events that we support
|
|
3
3
|
*/
|
|
4
4
|
const HOTKEY_EVENT_NAMES = [
|
|
5
|
+
'addTopNav',
|
|
5
6
|
'closeModal',
|
|
7
|
+
'closeTopNav',
|
|
8
|
+
'createNew',
|
|
9
|
+
'executeRequest',
|
|
10
|
+
'focusAddressBar',
|
|
11
|
+
'focusRequestSearch',
|
|
12
|
+
'jumpToLastTab',
|
|
13
|
+
'jumpToTab',
|
|
6
14
|
'navigateSearchResultsDown',
|
|
7
|
-
'selectSearchResult',
|
|
8
15
|
'navigateSearchResultsUp',
|
|
9
|
-
'openCommandPalette',
|
|
10
|
-
'createNew',
|
|
11
|
-
'toggleSidebar',
|
|
12
|
-
'addTopNav',
|
|
13
|
-
'closeTopNav',
|
|
14
16
|
'navigateTopNavLeft',
|
|
15
17
|
'navigateTopNavRight',
|
|
16
|
-
'
|
|
17
|
-
'
|
|
18
|
-
'
|
|
19
|
-
'focusRequestSearch',
|
|
18
|
+
'openCommandPalette',
|
|
19
|
+
'selectSearchResult',
|
|
20
|
+
'toggleSidebar',
|
|
20
21
|
];
|
|
21
22
|
/**
|
|
22
23
|
* Array of all of the hotkeys that we support
|
|
@@ -3,12 +3,12 @@ declare const modifiers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodDefault<z.Zo
|
|
|
3
3
|
export type HotKeyModifiers = z.infer<typeof modifiers>;
|
|
4
4
|
declare const hotKeys: z.ZodRecord<z.ZodEnum<["Space", "Backspace", "Tab", "Enter", "Escape", "ArrowDown", "ArrowLeft", "ArrowRight", "ArrowUp", "End", "Home", "PageDown", "PageUp", "Delete", "0", "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", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "*", "+", "-", ".", "/", "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12", ";", "=", ",", "-", ".", "/", "`", "[", "\\", "]", ""]>, z.ZodObject<{
|
|
5
5
|
modifiers: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodEnum<["Meta", "Control", "Shift", "Alt", "default"]>>>, "many">>>>;
|
|
6
|
-
event: z.ZodEnum<["closeModal", "
|
|
6
|
+
event: z.ZodEnum<["addTopNav", "closeModal", "closeTopNav", "createNew", "executeRequest", "focusAddressBar", "focusRequestSearch", "jumpToLastTab", "jumpToTab", "navigateSearchResultsDown", "navigateSearchResultsUp", "navigateTopNavLeft", "navigateTopNavRight", "openCommandPalette", "selectSearchResult", "toggleSidebar"]>;
|
|
7
7
|
}, "strip", z.ZodTypeAny, {
|
|
8
|
-
event: "closeModal" | "
|
|
8
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
9
9
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
|
|
10
10
|
}, {
|
|
11
|
-
event: "closeModal" | "
|
|
11
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
12
12
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
|
|
13
13
|
}>>;
|
|
14
14
|
export type HotKeyConfig = z.infer<typeof hotKeys>;
|
|
@@ -26,24 +26,24 @@ export declare const workspaceSchema: z.ZodObject<{
|
|
|
26
26
|
modifiers: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodEnum<["Meta", "Control", "Shift", "Alt", "default"]>>>, "many">>>;
|
|
27
27
|
hotKeys: z.ZodOptional<z.ZodRecord<z.ZodEnum<["Space", "Backspace", "Tab", "Enter", "Escape", "ArrowDown", "ArrowLeft", "ArrowRight", "ArrowUp", "End", "Home", "PageDown", "PageUp", "Delete", "0", "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", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "*", "+", "-", ".", "/", "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12", ";", "=", ",", "-", ".", "/", "`", "[", "\\", "]", ""]>, z.ZodObject<{
|
|
28
28
|
modifiers: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodEnum<["Meta", "Control", "Shift", "Alt", "default"]>>>, "many">>>>;
|
|
29
|
-
event: z.ZodEnum<["closeModal", "
|
|
29
|
+
event: z.ZodEnum<["addTopNav", "closeModal", "closeTopNav", "createNew", "executeRequest", "focusAddressBar", "focusRequestSearch", "jumpToLastTab", "jumpToTab", "navigateSearchResultsDown", "navigateSearchResultsUp", "navigateTopNavLeft", "navigateTopNavRight", "openCommandPalette", "selectSearchResult", "toggleSidebar"]>;
|
|
30
30
|
}, "strip", z.ZodTypeAny, {
|
|
31
|
-
event: "closeModal" | "
|
|
31
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
32
32
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
|
|
33
33
|
}, {
|
|
34
|
-
event: "closeModal" | "
|
|
34
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
35
35
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
|
|
36
36
|
}>>>;
|
|
37
37
|
}, "strip", z.ZodTypeAny, {
|
|
38
38
|
modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
|
|
39
39
|
hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
|
|
40
|
-
event: "closeModal" | "
|
|
40
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
41
41
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
|
|
42
42
|
}>> | undefined;
|
|
43
43
|
}, {
|
|
44
44
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
|
|
45
45
|
hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
|
|
46
|
-
event: "closeModal" | "
|
|
46
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
47
47
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
|
|
48
48
|
}>> | undefined;
|
|
49
49
|
}>>;
|
|
@@ -67,7 +67,7 @@ export declare const workspaceSchema: z.ZodObject<{
|
|
|
67
67
|
hotKeyConfig?: {
|
|
68
68
|
modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
|
|
69
69
|
hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
|
|
70
|
-
event: "closeModal" | "
|
|
70
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
71
71
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
|
|
72
72
|
}>> | undefined;
|
|
73
73
|
} | undefined;
|
|
@@ -81,7 +81,7 @@ export declare const workspaceSchema: z.ZodObject<{
|
|
|
81
81
|
hotKeyConfig?: {
|
|
82
82
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
|
|
83
83
|
hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
|
|
84
|
-
event: "closeModal" | "
|
|
84
|
+
event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
|
|
85
85
|
modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
|
|
86
86
|
}>> | undefined;
|
|
87
87
|
} | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getExampleFromSchema.ts"],"names":[],"mappings":"AAyDA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;;OAGG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,
|
|
1
|
+
{"version":3,"file":"getExampleFromSchema.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getExampleFromSchema.ts"],"names":[],"mappings":"AAyDA;;GAEG;AACH,eAAO,MAAM,oBAAoB,WACvB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACjB;IACR;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B;;;OAGG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;CACzC,UACM,MAAM,iBACE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,SAC3B,MAAM,KACZ,GA8UF,CAAA"}
|
|
@@ -134,6 +134,17 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) =>
|
|
|
134
134
|
}
|
|
135
135
|
}
|
|
136
136
|
}
|
|
137
|
+
// Pattern properties (regex)
|
|
138
|
+
if (schema.patternProperties !== undefined) {
|
|
139
|
+
for (const pattern in schema.patternProperties) {
|
|
140
|
+
if (Object.prototype.hasOwnProperty.call(schema.patternProperties, pattern)) {
|
|
141
|
+
const property = schema.patternProperties[pattern];
|
|
142
|
+
// Use the regex pattern as an example key
|
|
143
|
+
const exampleKey = pattern;
|
|
144
|
+
response[exampleKey] = getExampleFromSchema(property, options, level + 1, schema, exampleKey);
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
137
148
|
// Additional properties
|
|
138
149
|
if (schema.additionalProperties !== undefined) {
|
|
139
150
|
const anyTypeIsValid =
|
package/package.json
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"specification",
|
|
17
17
|
"yaml"
|
|
18
18
|
],
|
|
19
|
-
"version": "0.2.
|
|
19
|
+
"version": "0.2.96",
|
|
20
20
|
"engines": {
|
|
21
21
|
"node": ">=18"
|
|
22
22
|
},
|
|
@@ -122,9 +122,9 @@
|
|
|
122
122
|
"yaml": "^2.4.5",
|
|
123
123
|
"zod": "^3.23.8",
|
|
124
124
|
"@scalar/object-utils": "1.1.12",
|
|
125
|
-
"@scalar/
|
|
126
|
-
"@scalar/themes": "0.9.
|
|
127
|
-
"@scalar/types": "0.
|
|
125
|
+
"@scalar/types": "0.0.25",
|
|
126
|
+
"@scalar/themes": "0.9.59",
|
|
127
|
+
"@scalar/openapi-types": "0.1.5"
|
|
128
128
|
},
|
|
129
129
|
"devDependencies": {
|
|
130
130
|
"type-fest": "^4.20.0",
|
|
@@ -132,7 +132,7 @@
|
|
|
132
132
|
"vitest": "^1.6.0",
|
|
133
133
|
"zod-to-ts": "github:amritk/zod-to-ts#build",
|
|
134
134
|
"@scalar/build-tooling": "0.1.12",
|
|
135
|
-
"@scalar/openapi-parser": "0.10.
|
|
135
|
+
"@scalar/openapi-parser": "0.10.3",
|
|
136
136
|
"@scalar/openapi-types": "0.1.5"
|
|
137
137
|
},
|
|
138
138
|
"scripts": {
|