@scalar/oas-utils 0.2.33 → 0.2.35

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 (34) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/entities/workspace/collection/collection.d.ts +3 -3
  3. package/dist/entities/workspace/folder/folder.d.ts +1 -1
  4. package/dist/entities/workspace/security/security-schemes.d.ts +11 -11
  5. package/dist/entities/workspace/server/server.d.ts +5 -5
  6. package/dist/entities/workspace/spec/components.d.ts +1 -1
  7. package/dist/entities/workspace/spec/components.d.ts.map +1 -1
  8. package/dist/entities/workspace/spec/request-examples.d.ts +168 -168
  9. package/dist/entities/workspace/spec/request-examples.js +1 -1
  10. package/dist/entities/workspace/spec/requests.d.ts +9 -9
  11. package/dist/entities/workspace/spec/requests.d.ts.map +1 -1
  12. package/dist/entities/workspace/workspace.d.ts +22 -22
  13. package/dist/helpers/normalizeMimeType.d.ts +1 -1
  14. package/dist/helpers/normalizeMimeType.d.ts.map +1 -1
  15. package/dist/helpers/normalizeMimeTypeObject.d.ts +1 -1
  16. package/dist/helpers/normalizeMimeTypeObject.d.ts.map +1 -1
  17. package/dist/helpers/parse.d.ts +6 -6
  18. package/dist/helpers/parse.d.ts.map +1 -1
  19. package/dist/helpers/ssrState.d.ts +1 -1
  20. package/dist/helpers/ssrState.d.ts.map +1 -1
  21. package/dist/spec-getters/getParametersFromOperation.d.ts +1 -1
  22. package/dist/spec-getters/getParametersFromOperation.d.ts.map +1 -1
  23. package/dist/spec-getters/getRequestBodyFromOperation.d.ts +1 -1
  24. package/dist/spec-getters/getRequestBodyFromOperation.d.ts.map +1 -1
  25. package/dist/spec-getters/getRequestFromOperation.d.ts +1 -1
  26. package/dist/spec-getters/getRequestFromOperation.d.ts.map +1 -1
  27. package/dist/transforms/import-spec.d.ts +4 -3
  28. package/dist/transforms/import-spec.d.ts.map +1 -1
  29. package/package.json +3 -8
  30. package/dist/index.d.ts +0 -2
  31. package/dist/index.d.ts.map +0 -1
  32. package/dist/index.js +0 -1
  33. package/dist/types.d.ts +0 -200
  34. package/dist/types.d.ts.map +0 -1
@@ -6,7 +6,7 @@ const requestExampleParametersSchema = z.object({
6
6
  key: z.string().default(''),
7
7
  value: z.union([z.string(), z.number()]).transform(String).default(''),
8
8
  enabled: z.boolean().default(true),
9
- file: z.instanceof(File).optional(),
9
+ file: z.any().optional(),
10
10
  description: z.string().optional(),
11
11
  /** Params are linked to parents such as path params and global headers/cookies */
12
12
  refUid: nanoidSchema.optional(),
@@ -1,5 +1,5 @@
1
+ import type { OpenAPIV3_1 } from '@scalar/openapi-parser';
1
2
  import type { AxiosResponse } from 'axios';
2
- import type { OpenAPIV3_1 } from 'openapi-types';
3
3
  import { z } from 'zod';
4
4
  import type { RequestExample } from './request-examples.js';
5
5
  /** A single set of populated values for a sent request */
@@ -53,13 +53,13 @@ declare const requestSchema: z.ZodObject<{
53
53
  }, "strip", z.ZodTypeAny, {
54
54
  path: Record<string, any>;
55
55
  query: Record<string, any>;
56
- cookies: Record<string, any>;
57
56
  headers: Record<string, any>;
57
+ cookies: Record<string, any>;
58
58
  }, {
59
59
  path: Record<string, any>;
60
60
  query: Record<string, any>;
61
- cookies: Record<string, any>;
62
61
  headers: Record<string, any>;
62
+ cookies: Record<string, any>;
63
63
  }>>;
64
64
  /**
65
65
  * A declaration of which security mechanisms can be used across the API. The list of
@@ -87,13 +87,13 @@ declare const requestSchema: z.ZodObject<{
87
87
  path: string;
88
88
  uid: string;
89
89
  childUids: string[];
90
- method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
91
90
  parameters: {
92
91
  path: Record<string, any>;
93
92
  query: Record<string, any>;
94
- cookies: Record<string, any>;
95
93
  headers: Record<string, any>;
94
+ cookies: Record<string, any>;
96
95
  };
96
+ method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
97
97
  ref: {
98
98
  path: string;
99
99
  isExternal: boolean;
@@ -116,13 +116,13 @@ declare const requestSchema: z.ZodObject<{
116
116
  security?: Record<string, string[] | undefined>[] | undefined;
117
117
  tags?: string[] | undefined;
118
118
  childUids?: (string | undefined)[] | undefined;
119
- method?: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS" | undefined;
120
119
  parameters?: {
121
120
  path: Record<string, any>;
122
121
  query: Record<string, any>;
123
- cookies: Record<string, any>;
124
122
  headers: Record<string, any>;
123
+ cookies: Record<string, any>;
125
124
  } | undefined;
125
+ method?: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS" | undefined;
126
126
  ref?: {
127
127
  path: string;
128
128
  isExternal: boolean;
@@ -150,13 +150,13 @@ export declare const createRequest: (payload: RequestPayload) => {
150
150
  path: string;
151
151
  uid: string;
152
152
  childUids: string[];
153
- method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
154
153
  parameters: {
155
154
  path: Record<string, any>;
156
155
  query: Record<string, any>;
157
- cookies: Record<string, any>;
158
156
  headers: Record<string, any>;
157
+ cookies: Record<string, any>;
159
158
  };
159
+ method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
160
160
  ref: {
161
161
  path: string;
162
162
  isExternal: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/requests.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAQD,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;IAQjB;;;OAGG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;;;;;;;;;;;;;;;;;IAUH;;;;;;OAMG;;IAEH,6EAA6E;;IAE7E,mEAAmE;;IAEnE;;;;;OAKG;;IAEH,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IAC3D,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AAED,4BAA4B;AAC5B,eAAO,MAAM,aAAa,YAAa,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;CACY,CAAA"}
1
+ {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/requests.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAQD,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;IAQjB;;;OAGG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;;;;;;;;;;;;;;;;;IAUH;;;;;;OAMG;;IAEH,6EAA6E;;IAE7E,mEAAmE;;IAEnE;;;;;OAKG;;IAEH,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IAC3D,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AAED,4BAA4B;AAC5B,eAAO,MAAM,aAAa,YAAa,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;CACY,CAAA"}
@@ -6,10 +6,10 @@ declare const hotKeys: z.ZodRecord<z.ZodEnum<["Space", "Backspace", "Tab", "Ente
6
6
  event: z.ZodEnum<["closeModal", "commandPaletteDown", "commandPaletteSelect", "commandPaletteUp", "openCommandPalette", "toggleSidebar", "addTopNav", "closeTopNav", "navigateTopNavLeft", "navigateTopNavRight", "focusAddressBar", "jumpToTab", "jumpToLastTab"]>;
7
7
  }, "strip", z.ZodTypeAny, {
8
8
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
9
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt")[] | undefined;
9
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
10
10
  }, {
11
11
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
12
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
12
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
13
13
  }>>;
14
14
  export type HotKeyConfig = z.infer<typeof hotKeys>;
15
15
  declare const workspaceSchema: z.ZodObject<{
@@ -31,22 +31,22 @@ declare const workspaceSchema: z.ZodObject<{
31
31
  event: z.ZodEnum<["closeModal", "commandPaletteDown", "commandPaletteSelect", "commandPaletteUp", "openCommandPalette", "toggleSidebar", "addTopNav", "closeTopNav", "navigateTopNavLeft", "navigateTopNavRight", "focusAddressBar", "jumpToTab", "jumpToLastTab"]>;
32
32
  }, "strip", z.ZodTypeAny, {
33
33
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
34
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt")[] | undefined;
34
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
35
35
  }, {
36
36
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
37
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
37
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
38
38
  }>>>;
39
39
  }, "strip", z.ZodTypeAny, {
40
- modifiers: ("default" | "Meta" | "Control" | "Shift" | "Alt")[];
41
- hotKeys?: Partial<Record<"" | "0" | "1" | "2" | "/" | "[" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "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
+ modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
41
+ 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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
42
42
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
43
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt")[] | undefined;
43
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
44
44
  }>> | undefined;
45
45
  }, {
46
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
47
- hotKeys?: Partial<Record<"" | "0" | "1" | "2" | "/" | "[" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "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
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
47
+ 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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
48
48
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
49
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
49
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
50
50
  }>> | undefined;
51
51
  }>>;
52
52
  /** List of all cookie uids in a given workspace */
@@ -57,33 +57,33 @@ declare const workspaceSchema: z.ZodObject<{
57
57
  themeId: z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "mars", "none"]>>>;
58
58
  }, "strip", z.ZodTypeAny, {
59
59
  uid: string;
60
- description: string;
61
60
  name: string;
61
+ description: string;
62
62
  isReadOnly: boolean;
63
63
  collectionUids: string[];
64
64
  environmentUids: string[];
65
65
  cookieUids: string[];
66
66
  themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
67
67
  hotKeyConfig?: {
68
- modifiers: ("default" | "Meta" | "Control" | "Shift" | "Alt")[];
69
- hotKeys?: Partial<Record<"" | "0" | "1" | "2" | "/" | "[" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "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" | ";" | "=" | "," | "`" | "\\" | "]", {
68
+ modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
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
70
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
71
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt")[] | undefined;
71
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
72
72
  }>> | undefined;
73
73
  } | undefined;
74
74
  proxyUrl?: string | undefined;
75
75
  }, {
76
76
  uid?: string | undefined;
77
- description?: string | undefined;
78
77
  name?: string | undefined;
78
+ description?: string | undefined;
79
79
  isReadOnly?: boolean | undefined;
80
80
  collectionUids?: string[] | undefined;
81
81
  environmentUids?: string[] | undefined;
82
82
  hotKeyConfig?: {
83
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
84
- hotKeys?: Partial<Record<"" | "0" | "1" | "2" | "/" | "[" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "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" | ";" | "=" | "," | "`" | "\\" | "]", {
83
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
84
+ 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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
85
85
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
86
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt" | undefined)[] | undefined;
86
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default" | undefined)[] | undefined;
87
87
  }>> | undefined;
88
88
  } | undefined;
89
89
  cookieUids?: string[] | undefined;
@@ -95,18 +95,18 @@ export type Workspace = z.infer<typeof workspaceSchema>;
95
95
  export type WorkspacePayload = z.input<typeof workspaceSchema>;
96
96
  export declare const createWorkspace: (payload: WorkspacePayload) => {
97
97
  uid: string;
98
- description: string;
99
98
  name: string;
99
+ description: string;
100
100
  isReadOnly: boolean;
101
101
  collectionUids: string[];
102
102
  environmentUids: string[];
103
103
  cookieUids: string[];
104
104
  themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
105
105
  hotKeyConfig?: {
106
- modifiers: ("default" | "Meta" | "Control" | "Shift" | "Alt")[];
107
- hotKeys?: Partial<Record<"" | "0" | "1" | "2" | "/" | "[" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "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" | ";" | "=" | "," | "`" | "\\" | "]", {
106
+ modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
107
+ 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" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
108
108
  event: "closeModal" | "commandPaletteDown" | "commandPaletteSelect" | "commandPaletteUp" | "openCommandPalette" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab";
109
- modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt")[] | undefined;
109
+ modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
110
110
  }>> | undefined;
111
111
  } | undefined;
112
112
  proxyUrl?: string | undefined;
@@ -1,4 +1,4 @@
1
- import type { ContentType } from '../types';
1
+ import type { ContentType } from '@scalar/types/legacy';
2
2
  /**
3
3
  * Normalizes a MIME type to a standard format.
4
4
  *
@@ -1 +1 @@
1
- {"version":3,"file":"normalizeMimeType.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeMimeType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAE3C;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,CAAC,EAAE,MAAM,2BAcrD"}
1
+ {"version":3,"file":"normalizeMimeType.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeMimeType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,CAAC,EAAE,MAAM,2BAcrD"}
@@ -1,4 +1,4 @@
1
- import type { ContentType } from '../types';
1
+ import type { ContentType } from '@scalar/types/legacy';
2
2
  /**
3
3
  * Remove charset from content types
4
4
  *
@@ -1 +1 @@
1
- {"version":3,"file":"normalizeMimeTypeObject.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeMimeTypeObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAG3C;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC;;;;;;;;cA8BzE"}
1
+ {"version":3,"file":"normalizeMimeTypeObject.d.ts","sourceRoot":"","sources":["../../src/helpers/normalizeMimeTypeObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAIvD;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC;;;;;;;;cA8BzE"}
@@ -1,20 +1,20 @@
1
+ import type { UnknownObject } from '@scalar/types/utils';
1
2
  import { stringify } from 'yaml';
2
- import type { AnyObject } from '../types';
3
3
  type PrimitiveOrObject = object | string | null | number | boolean | undefined;
4
4
  /** Yaml handling with optional safeparse */
5
5
  export declare const yaml: {
6
6
  /** Parse and throw if the return value is not an object */
7
- parse: (val: string) => AnyObject;
7
+ parse: (val: string) => UnknownObject;
8
8
  /** Parse and return a fallback on failure */
9
- parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): AnyObject | T;
9
+ parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): UnknownObject | T;
10
10
  stringify: typeof stringify;
11
11
  };
12
12
  /** JSON handling with optional safeparse */
13
13
  export declare const json: {
14
14
  /** Parse and throw if the return value is not an object */
15
- parse: (val: string) => AnyObject;
15
+ parse: (val: string) => UnknownObject;
16
16
  /** Parse and return a fallback on failure */
17
- parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): AnyObject | T;
17
+ parseSafe<T extends PrimitiveOrObject>(val: string, fallback: T | ((err: any) => T)): UnknownObject | T;
18
18
  stringify: (val: object) => string;
19
19
  };
20
20
  /**
@@ -28,6 +28,6 @@ export declare const transformToJson: (value: string) => string;
28
28
  /** Validates a JSON string if provided. Otherwise returns the raw YAML */
29
29
  export declare function formatJsonOrYamlString(value: string): string;
30
30
  /** Parse JSON or YAML into an object */
31
- export declare const parseJsonOrYaml: (value: string | AnyObject) => AnyObject;
31
+ export declare const parseJsonOrYaml: (value: string | UnknownObject) => UnknownObject;
32
32
  export {};
33
33
  //# sourceMappingURL=parse.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,SAAS,EAAE,MAAM,MAAM,CAAA;AAEvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAEzC,KAAK,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;AAE9E,4CAA4C;AAC5C,eAAO,MAAM,IAAI;IACf,2DAA2D;iBAC9C,MAAM,KAGI,SAAS;IAEhC,6CAA6C;cACnC,CAAC,SAAS,iBAAiB,OAC9B,MAAM,YACD,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,GAC9B,SAAS,GAAG,CAAC;;CAQjB,CAAA;AAED,4CAA4C;AAC5C,eAAO,MAAM,IAAI;IACf,2DAA2D;iBAC9C,MAAM,KAAG,SAAS;IAK/B,6CAA6C;cACnC,CAAC,SAAS,iBAAiB,OAC9B,MAAM,YACD,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,GAC9B,SAAS,GAAG,CAAC;qBAOC,MAAM;CACxB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,WAAY,GAAG,YAIvC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,WAG5C,CAAA;AAED,0EAA0E;AAC1E,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,UAYnD;AAED,wCAAwC;AACxC,eAAO,MAAM,eAAe,UAAW,MAAM,GAAG,SAAS,KAAG,SAc3D,CAAA"}
1
+ {"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EAAS,SAAS,EAAE,MAAM,MAAM,CAAA;AAEvC,KAAK,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;AAE9E,4CAA4C;AAC5C,eAAO,MAAM,IAAI;IACf,2DAA2D;iBAC9C,MAAM,KAGI,aAAa;IAEpC,6CAA6C;cACnC,CAAC,SAAS,iBAAiB,OAC9B,MAAM,YACD,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,GAC9B,aAAa,GAAG,CAAC;;CAQrB,CAAA;AAED,4CAA4C;AAC5C,eAAO,MAAM,IAAI;IACf,2DAA2D;iBAC9C,MAAM,KAAG,aAAa;IAKnC,6CAA6C;cACnC,CAAC,SAAS,iBAAiB,OAC9B,MAAM,YACD,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,GAC9B,aAAa,GAAG,CAAC;qBAOH,MAAM;CACxB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,WAAY,GAAG,YAIvC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,WAG5C,CAAA;AAED,0EAA0E;AAC1E,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,UAYnD;AAED,wCAAwC;AACxC,eAAO,MAAM,eAAe,UACnB,MAAM,GAAG,aAAa,KAC5B,aAcF,CAAA"}
@@ -1,4 +1,4 @@
1
- import type { ScalarState } from '../types';
1
+ import type { ScalarState } from '@scalar/types/legacy';
2
2
  declare global {
3
3
  interface Window {
4
4
  __SCALAR__: ScalarState;
@@ -1 +1 @@
1
- {"version":3,"file":"ssrState.d.ts","sourceRoot":"","sources":["../../src/helpers/ssrState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAE3C,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,EAAE,WAAW,CAAA;KACxB;CACF;AAED,eAAO,MAAM,mBAAmB,QAAO,WAAmB,CAAA;AAE1D;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,WAGI,CAAA"}
1
+ {"version":3,"file":"ssrState.d.ts","sourceRoot":"","sources":["../../src/helpers/ssrState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,EAAE,WAAW,CAAA;KACxB;CACF;AAED,eAAO,MAAM,mBAAmB,QAAO,WAAmB,CAAA;AAE1D;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,WAGI,CAAA"}
@@ -1,4 +1,4 @@
1
- import type { BaseParameter, TransformedOperation } from '../types';
1
+ import type { BaseParameter, TransformedOperation } from '@scalar/types/legacy';
2
2
  /**
3
3
  * Get the query parameters from an operation.
4
4
  *
@@ -1 +1 @@
1
- {"version":3,"file":"getParametersFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getParametersFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAGnE;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,oBAAoB,EAC/B,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,EACnE,YAAY,GAAE,OAAc,GAC3B,aAAa,EAAE,CAkCjB"}
1
+ {"version":3,"file":"getParametersFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getParametersFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAI/E;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,oBAAoB,EAC/B,KAAK,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,EACnE,YAAY,GAAE,OAAc,GAC3B,aAAa,EAAE,CAkCjB"}
@@ -1,4 +1,4 @@
1
- import type { ContentType, TransformedOperation } from '../types';
1
+ import type { ContentType, TransformedOperation } from '@scalar/types/legacy';
2
2
  /**
3
3
  * Get the request body from the operation.
4
4
  */
@@ -1 +1 @@
1
- {"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAIjE;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,oBAAoB,EAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA6NrC"}
1
+ {"version":3,"file":"getRequestBodyFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestBodyFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAQ7E;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,oBAAoB,EAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA6NrC"}
@@ -1,4 +1,4 @@
1
- import type { HarRequestWithPath, TransformedOperation } from '../types';
1
+ import type { HarRequestWithPath, TransformedOperation } from '@scalar/types/legacy';
2
2
  export declare const getRequestFromOperation: (operation: TransformedOperation, options?: {
3
3
  /**
4
4
  * If the path will be URL encoded, you may want to replace {curlyBrackets} with __UNDERSCORES__ to indicate an
@@ -1 +1 @@
1
- {"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAGlB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAIjB,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,uBACoB,MAAM,GAAG,MAAM,KACnC,OAAO,CAAC,kBAAkB,CA6D5B,CAAA"}
1
+ {"version":3,"file":"getRequestFromOperation.d.ts","sourceRoot":"","sources":["../../src/spec-getters/getRequestFromOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAGlB,oBAAoB,EACrB,MAAM,sBAAsB,CAAA;AAK7B,eAAO,MAAM,uBAAuB,cACvB,oBAAoB,YACrB;IACR;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,uBACoB,MAAM,GAAG,MAAM,KACnC,OAAO,CAAC,kBAAkB,CA6D5B,CAAA"}
@@ -1,7 +1,8 @@
1
1
  import { type Request } from '../entities/workspace/spec/index.js';
2
- import type { AnyObject, Spec } from '../types';
2
+ import type { Spec } from '@scalar/types/legacy';
3
+ import type { UnknownObject } from '@scalar/types/utils';
3
4
  /** Import an OpenAPI spec file and convert it to workspace entities */
4
- export declare const importSpecToWorkspace: (spec: string | AnyObject, overloadServers?: Spec["servers"]) => Promise<{
5
+ export declare const importSpecToWorkspace: (spec: string | UnknownObject, overloadServers?: Spec["servers"]) => Promise<{
5
6
  tags: {
6
7
  name: string;
7
8
  description?: string | undefined;
@@ -17,8 +18,8 @@ export declare const importSpecToWorkspace: (spec: string | AnyObject, overloadS
17
18
  url: string;
18
19
  description?: string | undefined;
19
20
  variables?: Record<string, {
20
- uid: string;
21
21
  default: string;
22
+ uid: string;
22
23
  value?: string | undefined;
23
24
  description?: string | undefined;
24
25
  enum?: string[] | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,2BAA2B,CAAA;AAIvE,OAAO,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAW9C,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,SAC1B,MAAM,GAAG,SAAS,oBACN,IAAI,CAAC,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsKlC,CAAA"}
1
+ {"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,2BAA2B,CAAA;AAKvE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AASxD,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,SAC1B,MAAM,GAAG,aAAa,oBACV,IAAI,CAAC,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsKlC,CAAA"}
package/package.json CHANGED
@@ -16,17 +16,13 @@
16
16
  "specification",
17
17
  "yaml"
18
18
  ],
19
- "version": "0.2.33",
19
+ "version": "0.2.35",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },
23
23
  "type": "module",
24
24
  "main": "dist/index.js",
25
25
  "exports": {
26
- ".": {
27
- "import": "./dist/index.js",
28
- "types": "./dist/index.d.ts"
29
- },
30
26
  "./transforms": {
31
27
  "import": "./dist/transforms/index.js",
32
28
  "types": "./dist/transforms/index.d.ts"
@@ -95,13 +91,12 @@
95
91
  "yaml": "^2.4.5",
96
92
  "zod": "^3.22.4",
97
93
  "@scalar/object-utils": "1.1.7",
98
- "@scalar/themes": "0.9.24"
94
+ "@scalar/themes": "0.9.25",
95
+ "@scalar/types": "0.0.2"
99
96
  },
100
97
  "devDependencies": {
101
98
  "@scalar/openapi-parser": "^0.7.2",
102
99
  "axios": "^1.6.8",
103
- "httpsnippet-lite": "^3.0.5",
104
- "openapi-types": "^12.1.3",
105
100
  "rollup": "^4.16.4",
106
101
  "type-fest": "^4.20.0",
107
102
  "vite": "^5.2.10",
package/dist/index.d.ts DELETED
@@ -1,2 +0,0 @@
1
- export * from './types';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA"}
package/dist/index.js DELETED
@@ -1 +0,0 @@
1
-
package/dist/types.d.ts DELETED
@@ -1,200 +0,0 @@
1
- import type { ExternalDocumentation } from './entities/workspace/collection/index.js';
2
- import type { RequestMethod } from './helpers/index.js';
3
- import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-parser';
4
- import type { HarRequest } from 'httpsnippet-lite';
5
- export type AnyObject = Record<string, any>;
6
- export type AnyStringOrObject = string | Record<string, any>;
7
- export type BaseParameter = {
8
- name: string;
9
- description?: string | null;
10
- value: string | number | Record<string, any>;
11
- required?: boolean;
12
- enabled: boolean;
13
- };
14
- type OptionalCharset = string | null;
15
- export type ContentType = `application/json${OptionalCharset}` | `application/xml${OptionalCharset}` | `text/plain${OptionalCharset}` | `text/html${OptionalCharset}` | `application/octet-stream${OptionalCharset}` | `application/x-www-form-urlencoded${OptionalCharset}` | `multipart/form-data${OptionalCharset}`;
16
- export type Cookie = {
17
- name: string;
18
- value: string;
19
- };
20
- export type CustomRequestExample = {
21
- lang: string;
22
- label: string;
23
- source: string;
24
- };
25
- export type HarRequestWithPath = HarRequest & {
26
- path: string;
27
- };
28
- export type Header = {
29
- name: string;
30
- value: string;
31
- };
32
- export type Information = {
33
- 'description'?: string;
34
- 'operationId'?: string | number;
35
- 'parameters'?: Parameters[];
36
- 'responses'?: Record<string, ScalarResponse>;
37
- 'security'?: OpenAPIV3.SecurityRequirementObject[];
38
- 'requestBody'?: RequestBody;
39
- 'summary'?: string;
40
- 'tags'?: string[];
41
- 'deprecated'?: boolean;
42
- /**
43
- * Scalar
44
- */
45
- 'x-custom-examples'?: CustomRequestExample[];
46
- /**
47
- * Redocly, current
48
- */
49
- 'x-codeSamples'?: CustomRequestExample[];
50
- /**
51
- * Redocly, deprecated
52
- */
53
- 'x-code-samples'?: CustomRequestExample[];
54
- };
55
- export type Operation = {
56
- httpVerb: RequestMethod;
57
- path: string;
58
- operationId?: string;
59
- name?: string;
60
- description?: string;
61
- information?: Information;
62
- };
63
- export type Parameters = {
64
- name: string;
65
- in?: string;
66
- description?: string;
67
- required?: boolean;
68
- deprecated?: boolean;
69
- allowEmptyValue?: boolean;
70
- style?: 'form' | 'simple';
71
- explode?: boolean;
72
- allowReserved?: boolean;
73
- schema?: Schema;
74
- example?: any;
75
- examples?: Map<string, any>;
76
- content?: RequestBodyMimeTypes;
77
- };
78
- export type Query = {
79
- name: string;
80
- value: string;
81
- };
82
- export type RequestBodyMimeTypes = {
83
- [K in ContentType]?: {
84
- schema?: any;
85
- example?: any;
86
- examples?: any;
87
- };
88
- };
89
- export type ScalarResponse = {
90
- description: string;
91
- content: any;
92
- };
93
- export type RequestBody = {
94
- description?: string;
95
- required?: boolean;
96
- content?: RequestBodyMimeTypes;
97
- };
98
- /** For providing a OAS spec object or url to be fetched */
99
- export type SpecConfiguration = {
100
- /** URL to a Swagger/OpenAPI file */
101
- url?: string;
102
- /** Swagger/Open API spec */
103
- content?: string | Record<string, any> | (() => Record<string, any>);
104
- };
105
- export type Schema = {
106
- type: string;
107
- name?: string;
108
- example?: any;
109
- default?: any;
110
- format?: string;
111
- description?: string;
112
- properties?: Record<string, Schema>;
113
- };
114
- export type TransformedOperation = Operation & {
115
- pathParameters?: Parameters[];
116
- };
117
- export type CollapsedSidebarItems = Record<string, boolean>;
118
- export type AuthenticationState = {
119
- customSecurity: boolean;
120
- preferredSecurityScheme: string | null;
121
- securitySchemes?: OpenAPIV2.SecurityDefinitionsObject | OpenAPIV3.ComponentsObject['securitySchemes'] | OpenAPIV3_1.ComponentsObject['securitySchemes'];
122
- http: {
123
- basic: {
124
- username: string;
125
- password: string;
126
- };
127
- bearer: {
128
- token: string;
129
- };
130
- };
131
- apiKey: {
132
- token: string;
133
- };
134
- oAuth2: {
135
- clientId: string;
136
- scopes: string[];
137
- accessToken: string;
138
- state: string;
139
- username: string;
140
- password: string;
141
- };
142
- };
143
- export type Heading = {
144
- depth: number;
145
- value: string;
146
- slug?: string;
147
- };
148
- export type CodeBlockSSRKey = `components-scalar-code-block${number}`;
149
- export type DescriptionSectionSSRKey = `components-Content-Introduction-Description-sections${number}`;
150
- export type ExampleRequestSSRKey = `components-Content-Operation-Example-Request${number}`;
151
- export type ScalarState = {
152
- 'hash'?: string;
153
- 'useGlobalStore-authentication'?: AuthenticationState;
154
- 'useSidebarContent-collapsedSidebarItems'?: CollapsedSidebarItems;
155
- [key: CodeBlockSSRKey]: string;
156
- [key: DescriptionSectionSSRKey]: {
157
- heading: Heading;
158
- content: string;
159
- }[];
160
- [key: ExampleRequestSSRKey]: string;
161
- };
162
- export type SSRState = {
163
- payload: {
164
- data: ScalarState;
165
- };
166
- url: string;
167
- };
168
- export type Tag = {
169
- 'name': string;
170
- 'description': string;
171
- 'operations': TransformedOperation[];
172
- 'x-displayName'?: string;
173
- };
174
- export type TagGroup = {
175
- name: string;
176
- tags: string[];
177
- };
178
- export type SecurityScheme = Record<string, never> | OpenAPIV2.SecuritySchemeObject | OpenAPIV3.SecuritySchemeObject | OpenAPIV3_1.SecuritySchemeObject;
179
- export type Definitions = OpenAPIV2.DefinitionsObject;
180
- export type Webhooks = Record<string, Record<OpenAPIV3_1.HttpMethods, TransformedOperation & {
181
- 'x-internal'?: boolean;
182
- }>>;
183
- export type Spec = {
184
- 'tags'?: Tag[];
185
- 'info': Partial<OpenAPIV2.Document['info']> | Partial<OpenAPIV3.Document['info']> | Partial<OpenAPIV3_1.Document['info']>;
186
- 'host'?: OpenAPIV2.Document['host'];
187
- 'basePath'?: OpenAPIV2.Document['basePath'];
188
- 'schemes'?: OpenAPIV2.Document['schemes'];
189
- 'externalDocs'?: ExternalDocumentation;
190
- 'servers'?: OpenAPIV3.Document['servers'] | OpenAPIV3_1.Document['servers'];
191
- 'components'?: OpenAPIV3.ComponentsObject | OpenAPIV3_1.ComponentsObject;
192
- 'webhooks'?: Webhooks;
193
- 'definitions'?: Definitions;
194
- 'swagger'?: OpenAPIV2.Document['swagger'];
195
- 'openapi'?: OpenAPIV3.Document['openapi'] | OpenAPIV3_1.Document['openapi'];
196
- 'x-tagGroups'?: TagGroup[];
197
- 'security'?: OpenAPIV3.SecurityRequirementObject[];
198
- };
199
- export {};
200
- //# sourceMappingURL=types.d.ts.map