@scalar/api-client 2.2.31 → 2.2.33

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 (86) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts +9 -3
  3. package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts.map +1 -1
  4. package/dist/components/CommandPalette/CommandPaletteServer.vue.js +62 -54
  5. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +13 -3
  6. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
  7. package/dist/components/DataTable/DataTable.vue.js +7 -7
  8. package/dist/components/DataTable/DataTableCell.vue.js +6 -6
  9. package/dist/components/Form/Form.vue.d.ts.map +1 -1
  10. package/dist/components/Form/Form.vue.js +5 -5
  11. package/dist/components/ImportCollection/ImportCollectionModal.vue.d.ts.map +1 -1
  12. package/dist/components/ImportCollection/ImportCollectionModal.vue.js +72 -71
  13. package/dist/components/ImportCollection/WorkspaceSelector.vue.d.ts.map +1 -1
  14. package/dist/components/ImportCollection/WorkspaceSelector.vue.js +23 -22
  15. package/dist/components/Search/useSearch.d.ts.map +1 -1
  16. package/dist/components/Search/useSearch.js +61 -48
  17. package/dist/components/SideNav/SideNavLink.vue.js +2 -2
  18. package/dist/components/Sidebar/Sidebar.vue.js +2 -2
  19. package/dist/components/Sidebar/Sidebar.vue2.js +5 -5
  20. package/dist/components/Sidebar/SidebarList.vue.js +1 -1
  21. package/dist/components/Sidebar/SidebarListElement.vue.d.ts +1 -1
  22. package/dist/components/Sidebar/SidebarListElement.vue.d.ts.map +1 -1
  23. package/dist/components/Sidebar/SidebarListElement.vue.js +2 -2
  24. package/dist/components/Sidebar/SidebarListElement.vue2.js +12 -12
  25. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
  26. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +1 -1
  27. package/dist/components/ViewLayout/ViewLayoutSection.vue.d.ts.map +1 -1
  28. package/dist/components/ViewLayout/ViewLayoutSection.vue.js +1 -1
  29. package/dist/constants.d.ts +4 -0
  30. package/dist/constants.d.ts.map +1 -1
  31. package/dist/constants.js +2 -2
  32. package/dist/layouts/App/create-api-client-app.d.ts +168 -127
  33. package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
  34. package/dist/layouts/Modal/create-api-client-modal.d.ts +336 -254
  35. package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
  36. package/dist/layouts/Web/create-api-client-web.d.ts +168 -127
  37. package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
  38. package/dist/libs/create-client.d.ts +169 -128
  39. package/dist/libs/create-client.d.ts.map +1 -1
  40. package/dist/libs/create-client.js +8 -7
  41. package/dist/libs/find-request.d.ts +2 -0
  42. package/dist/libs/find-request.d.ts.map +1 -1
  43. package/dist/libs/send-request/send-request.d.ts.map +1 -1
  44. package/dist/libs/send-request/send-request.js +114 -116
  45. package/dist/routes.d.ts +1 -0
  46. package/dist/routes.d.ts.map +1 -1
  47. package/dist/routes.js +12 -7
  48. package/dist/store/active-entities.d.ts +29 -27
  49. package/dist/store/active-entities.d.ts.map +1 -1
  50. package/dist/store/collections.d.ts +4 -4
  51. package/dist/store/request-example.d.ts +134 -134
  52. package/dist/store/request-example.d.ts.map +1 -1
  53. package/dist/store/requests.d.ts +26 -4
  54. package/dist/store/requests.d.ts.map +1 -1
  55. package/dist/store/store.d.ts +171 -128
  56. package/dist/store/store.d.ts.map +1 -1
  57. package/dist/store/store.js +48 -46
  58. package/dist/store/tags.d.ts +24 -4
  59. package/dist/store/tags.d.ts.map +1 -1
  60. package/dist/style.css +1 -1
  61. package/dist/views/Cookies/CookieForm.vue.d.ts.map +1 -1
  62. package/dist/views/Cookies/CookieForm.vue.js +12 -12
  63. package/dist/views/Cookies/Cookies.vue2.js +12 -12
  64. package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
  65. package/dist/views/Environment/Environment.vue2.js +98 -97
  66. package/dist/views/Environment/EnvironmentModal.vue.js +1 -1
  67. package/dist/views/Environment/EnvironmentVariableDropdown.vue.js +6 -6
  68. package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
  69. package/dist/views/Request/RequestSidebar.vue.js +3 -3
  70. package/dist/views/Request/RequestSidebar.vue2.js +14 -14
  71. package/dist/views/Request/RequestSidebarItem.vue.d.ts +2 -2
  72. package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
  73. package/dist/views/Request/RequestSidebarItem.vue.js +2 -2
  74. package/dist/views/Request/RequestSidebarItem.vue2.js +132 -125
  75. package/dist/views/Request/RequestSubpageHeader.vue.d.ts.map +1 -1
  76. package/dist/views/Request/RequestSubpageHeader.vue.js +1 -1
  77. package/dist/views/Request/RequestSubpageHeader.vue2.js +21 -21
  78. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.d.ts.map +1 -1
  79. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.js +1 -1
  80. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +12 -12
  81. package/dist/views/Servers/ServerForm.vue.d.ts +8 -1
  82. package/dist/views/Servers/ServerForm.vue.d.ts.map +1 -1
  83. package/dist/views/Servers/ServerForm.vue.js +28 -59
  84. package/dist/views/Servers/Servers.vue.d.ts.map +1 -1
  85. package/dist/views/Servers/Servers.vue2.js +141 -53
  86. package/package.json +12 -12
@@ -108,6 +108,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
108
108
  'x-scalar-children'?: {
109
109
  tagName: string;
110
110
  }[] | undefined;
111
+ 'x-internal'?: boolean | undefined;
112
+ 'x-scalar-ignore'?: boolean | undefined;
111
113
  }>;
112
114
  cookies: Record<string, {
113
115
  value: string;
@@ -133,33 +135,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
133
135
  type: "requestExample";
134
136
  uid: string;
135
137
  name: string;
136
- body: {
137
- activeBody: "formData" | "binary" | "raw";
138
- formData?: {
139
- value: {
140
- value: string;
141
- key: string;
142
- enabled: boolean;
143
- minimum?: number | undefined;
144
- type?: string | undefined;
145
- maximum?: number | undefined;
146
- default?: any;
147
- required?: boolean | undefined;
148
- description?: string | undefined;
149
- enum?: string[] | undefined;
150
- format?: string | undefined;
151
- file?: any;
152
- nullable?: boolean | undefined;
153
- }[];
154
- encoding: "form-data" | "urlencoded";
155
- } | undefined;
156
- binary?: Blob | undefined;
157
- raw?: {
158
- value: string;
159
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
160
- } | undefined;
161
- };
162
- requestUid: string;
163
138
  parameters: {
164
139
  path: {
165
140
  value: string;
@@ -222,6 +197,33 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
222
197
  nullable?: boolean | undefined;
223
198
  }[];
224
199
  };
200
+ body: {
201
+ activeBody: "binary" | "formData" | "raw";
202
+ binary?: Blob | undefined;
203
+ formData?: {
204
+ value: {
205
+ value: string;
206
+ key: string;
207
+ enabled: boolean;
208
+ minimum?: number | undefined;
209
+ type?: string | undefined;
210
+ maximum?: number | undefined;
211
+ default?: any;
212
+ required?: boolean | undefined;
213
+ description?: string | undefined;
214
+ enum?: string[] | undefined;
215
+ format?: string | undefined;
216
+ file?: any;
217
+ nullable?: boolean | undefined;
218
+ }[];
219
+ encoding: "form-data" | "urlencoded";
220
+ } | undefined;
221
+ raw?: {
222
+ value: string;
223
+ encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
224
+ } | undefined;
225
+ };
226
+ requestUid: string;
225
227
  serverVariables?: Record<string, string[]> | undefined;
226
228
  }>;
227
229
  requests: Record<string, {
@@ -239,6 +241,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
239
241
  url: string;
240
242
  description?: string | undefined;
241
243
  } | undefined;
244
+ 'x-internal'?: boolean | undefined;
245
+ 'x-scalar-ignore'?: boolean | undefined;
242
246
  security?: Record<string, string[]>[] | undefined;
243
247
  tags?: string[] | undefined;
244
248
  deprecated?: boolean | undefined;
@@ -364,6 +368,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
364
368
  isReadOnly: boolean;
365
369
  hideClientButton: boolean | undefined;
366
370
  showSidebar: boolean;
371
+ integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
367
372
  importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
368
373
  type?: "collection" | undefined;
369
374
  uid?: string | undefined;
@@ -920,7 +925,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
920
925
  documentUrl?: string | undefined;
921
926
  integration?: string | null | undefined;
922
927
  }) => void;
923
- edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `servers.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
928
+ edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
924
929
  type: "collection";
925
930
  uid: string;
926
931
  children: string[];
@@ -974,7 +979,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
974
979
  }> | undefined;
975
980
  documentUrl?: string | undefined;
976
981
  integration?: string | null | undefined;
977
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
982
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
978
983
  type: "collection";
979
984
  uid: string;
980
985
  children: string[];
@@ -1083,7 +1088,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1083
1088
  documentUrl?: string | undefined;
1084
1089
  integration?: string | null | undefined;
1085
1090
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1086
- untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `servers.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
1091
+ untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
1087
1092
  type: "collection";
1088
1093
  uid: string;
1089
1094
  children: string[];
@@ -1137,7 +1142,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1137
1142
  }> | undefined;
1138
1143
  documentUrl?: string | undefined;
1139
1144
  integration?: string | null | undefined;
1140
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
1145
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
1141
1146
  type: "collection";
1142
1147
  uid: string;
1143
1148
  children: string[];
@@ -1324,6 +1329,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1324
1329
  url: string;
1325
1330
  description?: string | undefined;
1326
1331
  } | undefined;
1332
+ 'x-internal'?: boolean | undefined;
1333
+ 'x-scalar-ignore'?: boolean | undefined;
1327
1334
  security?: Record<string, string[]>[] | undefined;
1328
1335
  tags?: string[] | undefined;
1329
1336
  deprecated?: boolean | undefined;
@@ -1361,6 +1368,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1361
1368
  url: string;
1362
1369
  description?: string | undefined;
1363
1370
  } | undefined;
1371
+ 'x-internal'?: boolean | undefined;
1372
+ 'x-scalar-ignore'?: boolean | undefined;
1364
1373
  security?: Record<string, string[]>[] | undefined;
1365
1374
  tags?: string[] | undefined;
1366
1375
  deprecated?: boolean | undefined;
@@ -1399,6 +1408,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1399
1408
  url: string;
1400
1409
  description?: string | undefined;
1401
1410
  } | undefined;
1411
+ 'x-internal'?: boolean | undefined;
1412
+ 'x-scalar-ignore'?: boolean | undefined;
1402
1413
  security?: Record<string, string[]>[] | undefined;
1403
1414
  tags?: string[] | undefined;
1404
1415
  deprecated?: boolean | undefined;
@@ -1421,7 +1432,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1421
1432
  requestBody?: any;
1422
1433
  responses?: Record<string, any> | undefined;
1423
1434
  }) => void;
1424
- edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `servers.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? {
1435
+ edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
1425
1436
  path: string;
1426
1437
  type: "request";
1427
1438
  uid: string;
@@ -1436,6 +1447,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1436
1447
  url: string;
1437
1448
  description?: string | undefined;
1438
1449
  } | undefined;
1450
+ 'x-internal'?: boolean | undefined;
1451
+ 'x-scalar-ignore'?: boolean | undefined;
1439
1452
  security?: Record<string, string[]>[] | undefined;
1440
1453
  tags?: string[] | undefined;
1441
1454
  deprecated?: boolean | undefined;
@@ -1457,7 +1470,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1457
1470
  }[] | undefined;
1458
1471
  requestBody?: any;
1459
1472
  responses?: Record<string, any> | undefined;
1460
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1473
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1461
1474
  path: string;
1462
1475
  type: "request";
1463
1476
  uid: string;
@@ -1472,6 +1485,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1472
1485
  url: string;
1473
1486
  description?: string | undefined;
1474
1487
  } | undefined;
1488
+ 'x-internal'?: boolean | undefined;
1489
+ 'x-scalar-ignore'?: boolean | undefined;
1475
1490
  security?: Record<string, string[]>[] | undefined;
1476
1491
  tags?: string[] | undefined;
1477
1492
  deprecated?: boolean | undefined;
@@ -1508,6 +1523,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1508
1523
  url: string;
1509
1524
  description?: string | undefined;
1510
1525
  } | undefined;
1526
+ 'x-internal'?: boolean | undefined;
1527
+ 'x-scalar-ignore'?: boolean | undefined;
1511
1528
  security?: Record<string, string[]>[] | undefined;
1512
1529
  tags?: string[] | undefined;
1513
1530
  deprecated?: boolean | undefined;
@@ -1530,7 +1547,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1530
1547
  requestBody?: any;
1531
1548
  responses?: Record<string, any> | undefined;
1532
1549
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1533
- untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `servers.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? {
1550
+ untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
1534
1551
  path: string;
1535
1552
  type: "request";
1536
1553
  uid: string;
@@ -1545,6 +1562,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1545
1562
  url: string;
1546
1563
  description?: string | undefined;
1547
1564
  } | undefined;
1565
+ 'x-internal'?: boolean | undefined;
1566
+ 'x-scalar-ignore'?: boolean | undefined;
1548
1567
  security?: Record<string, string[]>[] | undefined;
1549
1568
  tags?: string[] | undefined;
1550
1569
  deprecated?: boolean | undefined;
@@ -1566,7 +1585,7 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1566
1585
  }[] | undefined;
1567
1586
  requestBody?: any;
1568
1587
  responses?: Record<string, any> | undefined;
1569
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "servers" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1588
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1570
1589
  path: string;
1571
1590
  type: "request";
1572
1591
  uid: string;
@@ -1581,6 +1600,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1581
1600
  url: string;
1582
1601
  description?: string | undefined;
1583
1602
  } | undefined;
1603
+ 'x-internal'?: boolean | undefined;
1604
+ 'x-scalar-ignore'?: boolean | undefined;
1584
1605
  security?: Record<string, string[]>[] | undefined;
1585
1606
  tags?: string[] | undefined;
1586
1607
  deprecated?: boolean | undefined;
@@ -1617,6 +1638,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1617
1638
  url: string;
1618
1639
  description?: string | undefined;
1619
1640
  } | undefined;
1641
+ 'x-internal'?: boolean | undefined;
1642
+ 'x-scalar-ignore'?: boolean | undefined;
1620
1643
  security?: Record<string, string[]>[] | undefined;
1621
1644
  tags?: string[] | undefined;
1622
1645
  deprecated?: boolean | undefined;
@@ -1649,33 +1672,6 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1649
1672
  type: "requestExample";
1650
1673
  uid: string;
1651
1674
  name: string;
1652
- body: {
1653
- activeBody: "formData" | "binary" | "raw";
1654
- formData?: {
1655
- value: {
1656
- value: string;
1657
- key: string;
1658
- enabled: boolean;
1659
- minimum?: number | undefined;
1660
- type?: string | undefined;
1661
- maximum?: number | undefined;
1662
- default?: any;
1663
- required?: boolean | undefined;
1664
- description?: string | undefined;
1665
- enum?: string[] | undefined;
1666
- format?: string | undefined;
1667
- file?: any;
1668
- nullable?: boolean | undefined;
1669
- }[];
1670
- encoding: "form-data" | "urlencoded";
1671
- } | undefined;
1672
- binary?: Blob | undefined;
1673
- raw?: {
1674
- value: string;
1675
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1676
- } | undefined;
1677
- };
1678
- requestUid: string;
1679
1675
  parameters: {
1680
1676
  path: {
1681
1677
  value: string;
@@ -1738,14 +1734,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1738
1734
  nullable?: boolean | undefined;
1739
1735
  }[];
1740
1736
  };
1741
- serverVariables?: Record<string, string[]> | undefined;
1742
- }) => void;
1743
- add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
1744
- type: "requestExample";
1745
- uid: string;
1746
- name: string;
1747
1737
  body: {
1748
- activeBody: "formData" | "binary" | "raw";
1738
+ activeBody: "binary" | "formData" | "raw";
1739
+ binary?: Blob | undefined;
1749
1740
  formData?: {
1750
1741
  value: {
1751
1742
  value: string;
@@ -1764,13 +1755,18 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1764
1755
  }[];
1765
1756
  encoding: "form-data" | "urlencoded";
1766
1757
  } | undefined;
1767
- binary?: Blob | undefined;
1768
1758
  raw?: {
1769
1759
  value: string;
1770
1760
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1771
1761
  } | undefined;
1772
1762
  };
1773
1763
  requestUid: string;
1764
+ serverVariables?: Record<string, string[]> | undefined;
1765
+ }) => void;
1766
+ add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
1767
+ type: "requestExample";
1768
+ uid: string;
1769
+ name: string;
1774
1770
  parameters: {
1775
1771
  path: {
1776
1772
  value: string;
@@ -1833,15 +1829,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1833
1829
  nullable?: boolean | undefined;
1834
1830
  }[];
1835
1831
  };
1836
- serverVariables?: Record<string, string[]> | undefined;
1837
- };
1838
- delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
1839
- set: (item: {
1840
- type: "requestExample";
1841
- uid: string;
1842
- name: string;
1843
1832
  body: {
1844
- activeBody: "formData" | "binary" | "raw";
1833
+ activeBody: "binary" | "formData" | "raw";
1834
+ binary?: Blob | undefined;
1845
1835
  formData?: {
1846
1836
  value: {
1847
1837
  value: string;
@@ -1860,13 +1850,19 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1860
1850
  }[];
1861
1851
  encoding: "form-data" | "urlencoded";
1862
1852
  } | undefined;
1863
- binary?: Blob | undefined;
1864
1853
  raw?: {
1865
1854
  value: string;
1866
1855
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1867
1856
  } | undefined;
1868
1857
  };
1869
1858
  requestUid: string;
1859
+ serverVariables?: Record<string, string[]> | undefined;
1860
+ };
1861
+ delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
1862
+ set: (item: {
1863
+ type: "requestExample";
1864
+ uid: string;
1865
+ name: string;
1870
1866
  parameters: {
1871
1867
  path: {
1872
1868
  value: string;
@@ -1929,14 +1925,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1929
1925
  nullable?: boolean | undefined;
1930
1926
  }[];
1931
1927
  };
1932
- serverVariables?: Record<string, string[]> | undefined;
1933
- }) => void;
1934
- edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
1935
- type: "requestExample";
1936
- uid: string;
1937
- name: string;
1938
1928
  body: {
1939
- activeBody: "formData" | "binary" | "raw";
1929
+ activeBody: "binary" | "formData" | "raw";
1930
+ binary?: Blob | undefined;
1940
1931
  formData?: {
1941
1932
  value: {
1942
1933
  value: string;
@@ -1955,13 +1946,18 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
1955
1946
  }[];
1956
1947
  encoding: "form-data" | "urlencoded";
1957
1948
  } | undefined;
1958
- binary?: Blob | undefined;
1959
1949
  raw?: {
1960
1950
  value: string;
1961
1951
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1962
1952
  } | undefined;
1963
1953
  };
1964
1954
  requestUid: string;
1955
+ serverVariables?: Record<string, string[]> | undefined;
1956
+ }) => void;
1957
+ edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
1958
+ type: "requestExample";
1959
+ uid: string;
1960
+ name: string;
1965
1961
  parameters: {
1966
1962
  path: {
1967
1963
  value: string;
@@ -2024,13 +2020,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2024
2020
  nullable?: boolean | undefined;
2025
2021
  }[];
2026
2022
  };
2027
- serverVariables?: Record<string, string[]> | undefined;
2028
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
2029
- type: "requestExample";
2030
- uid: string;
2031
- name: string;
2032
2023
  body: {
2033
- activeBody: "formData" | "binary" | "raw";
2024
+ activeBody: "binary" | "formData" | "raw";
2025
+ binary?: Blob | undefined;
2034
2026
  formData?: {
2035
2027
  value: {
2036
2028
  value: string;
@@ -2049,13 +2041,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2049
2041
  }[];
2050
2042
  encoding: "form-data" | "urlencoded";
2051
2043
  } | undefined;
2052
- binary?: Blob | undefined;
2053
2044
  raw?: {
2054
2045
  value: string;
2055
2046
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2056
2047
  } | undefined;
2057
2048
  };
2058
2049
  requestUid: string;
2050
+ serverVariables?: Record<string, string[]> | undefined;
2051
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
2052
+ type: "requestExample";
2053
+ uid: string;
2054
+ name: string;
2059
2055
  parameters: {
2060
2056
  path: {
2061
2057
  value: string;
@@ -2118,13 +2114,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2118
2114
  nullable?: boolean | undefined;
2119
2115
  }[];
2120
2116
  };
2121
- serverVariables?: Record<string, string[]> | undefined;
2122
- }[K]> ? import("@scalar/object-utils/nested").PathValue<{
2123
- type: "requestExample";
2124
- uid: string;
2125
- name: string;
2126
2117
  body: {
2127
- activeBody: "formData" | "binary" | "raw";
2118
+ activeBody: "binary" | "formData" | "raw";
2119
+ binary?: Blob | undefined;
2128
2120
  formData?: {
2129
2121
  value: {
2130
2122
  value: string;
@@ -2143,13 +2135,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2143
2135
  }[];
2144
2136
  encoding: "form-data" | "urlencoded";
2145
2137
  } | undefined;
2146
- binary?: Blob | undefined;
2147
2138
  raw?: {
2148
2139
  value: string;
2149
2140
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2150
2141
  } | undefined;
2151
2142
  };
2152
2143
  requestUid: string;
2144
+ serverVariables?: Record<string, string[]> | undefined;
2145
+ }[K]> ? import("@scalar/object-utils/nested").PathValue<{
2146
+ type: "requestExample";
2147
+ uid: string;
2148
+ name: string;
2153
2149
  parameters: {
2154
2150
  path: {
2155
2151
  value: string;
@@ -2212,14 +2208,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2212
2208
  nullable?: boolean | undefined;
2213
2209
  }[];
2214
2210
  };
2215
- serverVariables?: Record<string, string[]> | undefined;
2216
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2217
- untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
2218
- type: "requestExample";
2219
- uid: string;
2220
- name: string;
2221
2211
  body: {
2222
- activeBody: "formData" | "binary" | "raw";
2212
+ activeBody: "binary" | "formData" | "raw";
2213
+ binary?: Blob | undefined;
2223
2214
  formData?: {
2224
2215
  value: {
2225
2216
  value: string;
@@ -2238,13 +2229,18 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2238
2229
  }[];
2239
2230
  encoding: "form-data" | "urlencoded";
2240
2231
  } | undefined;
2241
- binary?: Blob | undefined;
2242
2232
  raw?: {
2243
2233
  value: string;
2244
2234
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2245
2235
  } | undefined;
2246
2236
  };
2247
2237
  requestUid: string;
2238
+ serverVariables?: Record<string, string[]> | undefined;
2239
+ }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2240
+ untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
2241
+ type: "requestExample";
2242
+ uid: string;
2243
+ name: string;
2248
2244
  parameters: {
2249
2245
  path: {
2250
2246
  value: string;
@@ -2307,13 +2303,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2307
2303
  nullable?: boolean | undefined;
2308
2304
  }[];
2309
2305
  };
2310
- serverVariables?: Record<string, string[]> | undefined;
2311
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
2312
- type: "requestExample";
2313
- uid: string;
2314
- name: string;
2315
2306
  body: {
2316
- activeBody: "formData" | "binary" | "raw";
2307
+ activeBody: "binary" | "formData" | "raw";
2308
+ binary?: Blob | undefined;
2317
2309
  formData?: {
2318
2310
  value: {
2319
2311
  value: string;
@@ -2332,13 +2324,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2332
2324
  }[];
2333
2325
  encoding: "form-data" | "urlencoded";
2334
2326
  } | undefined;
2335
- binary?: Blob | undefined;
2336
2327
  raw?: {
2337
2328
  value: string;
2338
2329
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2339
2330
  } | undefined;
2340
2331
  };
2341
2332
  requestUid: string;
2333
+ serverVariables?: Record<string, string[]> | undefined;
2334
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
2335
+ type: "requestExample";
2336
+ uid: string;
2337
+ name: string;
2342
2338
  parameters: {
2343
2339
  path: {
2344
2340
  value: string;
@@ -2401,13 +2397,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2401
2397
  nullable?: boolean | undefined;
2402
2398
  }[];
2403
2399
  };
2404
- serverVariables?: Record<string, string[]> | undefined;
2405
- }[K]> ? import("@scalar/object-utils/nested").PathValue<{
2406
- type: "requestExample";
2407
- uid: string;
2408
- name: string;
2409
2400
  body: {
2410
- activeBody: "formData" | "binary" | "raw";
2401
+ activeBody: "binary" | "formData" | "raw";
2402
+ binary?: Blob | undefined;
2411
2403
  formData?: {
2412
2404
  value: {
2413
2405
  value: string;
@@ -2426,13 +2418,17 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2426
2418
  }[];
2427
2419
  encoding: "form-data" | "urlencoded";
2428
2420
  } | undefined;
2429
- binary?: Blob | undefined;
2430
2421
  raw?: {
2431
2422
  value: string;
2432
2423
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2433
2424
  } | undefined;
2434
2425
  };
2435
2426
  requestUid: string;
2427
+ serverVariables?: Record<string, string[]> | undefined;
2428
+ }[K]> ? import("@scalar/object-utils/nested").PathValue<{
2429
+ type: "requestExample";
2430
+ uid: string;
2431
+ name: string;
2436
2432
  parameters: {
2437
2433
  path: {
2438
2434
  value: string;
@@ -2495,6 +2491,33 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
2495
2491
  nullable?: boolean | undefined;
2496
2492
  }[];
2497
2493
  };
2494
+ body: {
2495
+ activeBody: "binary" | "formData" | "raw";
2496
+ binary?: Blob | undefined;
2497
+ formData?: {
2498
+ value: {
2499
+ value: string;
2500
+ key: string;
2501
+ enabled: boolean;
2502
+ minimum?: number | undefined;
2503
+ type?: string | undefined;
2504
+ maximum?: number | undefined;
2505
+ default?: any;
2506
+ required?: boolean | undefined;
2507
+ description?: string | undefined;
2508
+ enum?: string[] | undefined;
2509
+ format?: string | undefined;
2510
+ file?: any;
2511
+ nullable?: boolean | undefined;
2512
+ }[];
2513
+ encoding: "form-data" | "urlencoded";
2514
+ } | undefined;
2515
+ raw?: {
2516
+ value: string;
2517
+ encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2518
+ } | undefined;
2519
+ };
2520
+ requestUid: string;
2498
2521
  serverVariables?: Record<string, string[]> | undefined;
2499
2522
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2500
2523
  undo: (uid: string) => void;
@@ -3285,6 +3308,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3285
3308
  'x-scalar-children'?: {
3286
3309
  tagName: string;
3287
3310
  }[] | undefined;
3311
+ 'x-internal'?: boolean | undefined;
3312
+ 'x-scalar-ignore'?: boolean | undefined;
3288
3313
  }) => void;
3289
3314
  add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
3290
3315
  type: "tag";
@@ -3299,6 +3324,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3299
3324
  'x-scalar-children'?: {
3300
3325
  tagName: string;
3301
3326
  }[] | undefined;
3327
+ 'x-internal'?: boolean | undefined;
3328
+ 'x-scalar-ignore'?: boolean | undefined;
3302
3329
  };
3303
3330
  delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
3304
3331
  set: (item: {
@@ -3314,8 +3341,10 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3314
3341
  'x-scalar-children'?: {
3315
3342
  tagName: string;
3316
3343
  }[] | undefined;
3344
+ 'x-internal'?: boolean | undefined;
3345
+ 'x-scalar-ignore'?: boolean | undefined;
3317
3346
  }) => void;
3318
- edit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
3347
+ edit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
3319
3348
  type: "tag";
3320
3349
  uid: string;
3321
3350
  name: string;
@@ -3328,7 +3357,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3328
3357
  'x-scalar-children'?: {
3329
3358
  tagName: string;
3330
3359
  }[] | undefined;
3331
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
3360
+ 'x-internal'?: boolean | undefined;
3361
+ 'x-scalar-ignore'?: boolean | undefined;
3362
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
3332
3363
  type: "tag";
3333
3364
  uid: string;
3334
3365
  name: string;
@@ -3341,6 +3372,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3341
3372
  'x-scalar-children'?: {
3342
3373
  tagName: string;
3343
3374
  }[] | undefined;
3375
+ 'x-internal'?: boolean | undefined;
3376
+ 'x-scalar-ignore'?: boolean | undefined;
3344
3377
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
3345
3378
  type: "tag";
3346
3379
  uid: string;
@@ -3354,8 +3387,10 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3354
3387
  'x-scalar-children'?: {
3355
3388
  tagName: string;
3356
3389
  }[] | undefined;
3390
+ 'x-internal'?: boolean | undefined;
3391
+ 'x-scalar-ignore'?: boolean | undefined;
3357
3392
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3358
- untrackedEdit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
3393
+ untrackedEdit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
3359
3394
  type: "tag";
3360
3395
  uid: string;
3361
3396
  name: string;
@@ -3368,7 +3403,9 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3368
3403
  'x-scalar-children'?: {
3369
3404
  tagName: string;
3370
3405
  }[] | undefined;
3371
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
3406
+ 'x-internal'?: boolean | undefined;
3407
+ 'x-scalar-ignore'?: boolean | undefined;
3408
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends import("@scalar/object-utils/nested").Path<{
3372
3409
  type: "tag";
3373
3410
  uid: string;
3374
3411
  name: string;
@@ -3381,6 +3418,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3381
3418
  'x-scalar-children'?: {
3382
3419
  tagName: string;
3383
3420
  }[] | undefined;
3421
+ 'x-internal'?: boolean | undefined;
3422
+ 'x-scalar-ignore'?: boolean | undefined;
3384
3423
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
3385
3424
  type: "tag";
3386
3425
  uid: string;
@@ -3394,6 +3433,8 @@ export declare const createApiClientWeb: (el: HTMLElement | null, configuration?
3394
3433
  'x-scalar-children'?: {
3395
3434
  tagName: string;
3396
3435
  }[] | undefined;
3436
+ 'x-internal'?: boolean | undefined;
3437
+ 'x-scalar-ignore'?: boolean | undefined;
3397
3438
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3398
3439
  undo: (uid: string) => void;
3399
3440
  redo: (uid: string) => void;