@scalar/api-client 2.2.32 → 2.2.34

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 (90) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/dist/components/AddressBar/AddressBar.vue.js +2 -2
  3. package/dist/components/AddressBar/AddressBar.vue2.js +27 -26
  4. package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts +9 -3
  5. package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts.map +1 -1
  6. package/dist/components/CommandPalette/CommandPaletteServer.vue.js +62 -54
  7. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +13 -3
  8. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
  9. package/dist/components/DataTable/DataTable.vue.js +7 -7
  10. package/dist/components/DataTable/DataTableCell.vue.js +6 -6
  11. package/dist/components/Form/Form.vue.d.ts.map +1 -1
  12. package/dist/components/Form/Form.vue.js +5 -5
  13. package/dist/components/ImportCollection/ImportCollectionModal.vue.d.ts.map +1 -1
  14. package/dist/components/ImportCollection/ImportCollectionModal.vue.js +72 -71
  15. package/dist/components/ImportCollection/WorkspaceSelector.vue.d.ts.map +1 -1
  16. package/dist/components/ImportCollection/WorkspaceSelector.vue.js +23 -22
  17. package/dist/components/Search/useSearch.d.ts.map +1 -1
  18. package/dist/components/Search/useSearch.js +61 -48
  19. package/dist/components/SideNav/SideNavLink.vue.js +2 -2
  20. package/dist/components/Sidebar/Sidebar.vue.js +2 -2
  21. package/dist/components/Sidebar/Sidebar.vue2.js +5 -5
  22. package/dist/components/Sidebar/SidebarList.vue.js +1 -1
  23. package/dist/components/Sidebar/SidebarListElement.vue.d.ts +1 -1
  24. package/dist/components/Sidebar/SidebarListElement.vue.d.ts.map +1 -1
  25. package/dist/components/Sidebar/SidebarListElement.vue.js +2 -2
  26. package/dist/components/Sidebar/SidebarListElement.vue2.js +12 -12
  27. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
  28. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +1 -1
  29. package/dist/components/ViewLayout/ViewLayoutSection.vue.d.ts.map +1 -1
  30. package/dist/components/ViewLayout/ViewLayoutSection.vue.js +1 -1
  31. package/dist/constants.d.ts +4 -0
  32. package/dist/constants.d.ts.map +1 -1
  33. package/dist/constants.js +2 -2
  34. package/dist/layouts/App/create-api-client-app.d.ts +171 -128
  35. package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
  36. package/dist/layouts/Modal/create-api-client-modal.d.ts +342 -256
  37. package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
  38. package/dist/layouts/Web/create-api-client-web.d.ts +171 -128
  39. package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
  40. package/dist/libs/create-client.d.ts +172 -129
  41. package/dist/libs/create-client.d.ts.map +1 -1
  42. package/dist/libs/create-client.js +8 -7
  43. package/dist/libs/find-request.d.ts +2 -0
  44. package/dist/libs/find-request.d.ts.map +1 -1
  45. package/dist/libs/send-request/send-request.d.ts.map +1 -1
  46. package/dist/libs/send-request/send-request.js +93 -93
  47. package/dist/routes.d.ts +1 -0
  48. package/dist/routes.d.ts.map +1 -1
  49. package/dist/routes.js +12 -7
  50. package/dist/store/active-entities.d.ts +29 -27
  51. package/dist/store/active-entities.d.ts.map +1 -1
  52. package/dist/store/collections.d.ts +4 -4
  53. package/dist/store/events.d.ts +3 -1
  54. package/dist/store/events.d.ts.map +1 -1
  55. package/dist/store/request-example.d.ts +134 -134
  56. package/dist/store/request-example.d.ts.map +1 -1
  57. package/dist/store/requests.d.ts +26 -4
  58. package/dist/store/requests.d.ts.map +1 -1
  59. package/dist/store/store.d.ts +174 -129
  60. package/dist/store/store.d.ts.map +1 -1
  61. package/dist/store/store.js +48 -46
  62. package/dist/store/tags.d.ts +24 -4
  63. package/dist/store/tags.d.ts.map +1 -1
  64. package/dist/style.css +1 -1
  65. package/dist/views/Cookies/CookieForm.vue.d.ts.map +1 -1
  66. package/dist/views/Cookies/CookieForm.vue.js +12 -12
  67. package/dist/views/Cookies/Cookies.vue2.js +12 -12
  68. package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
  69. package/dist/views/Environment/Environment.vue2.js +98 -97
  70. package/dist/views/Environment/EnvironmentModal.vue.js +1 -1
  71. package/dist/views/Environment/EnvironmentVariableDropdown.vue.js +6 -6
  72. package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
  73. package/dist/views/Request/RequestSidebar.vue.js +3 -3
  74. package/dist/views/Request/RequestSidebar.vue2.js +14 -14
  75. package/dist/views/Request/RequestSidebarItem.vue.d.ts +2 -2
  76. package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
  77. package/dist/views/Request/RequestSidebarItem.vue.js +2 -2
  78. package/dist/views/Request/RequestSidebarItem.vue2.js +132 -125
  79. package/dist/views/Request/RequestSubpageHeader.vue.d.ts.map +1 -1
  80. package/dist/views/Request/RequestSubpageHeader.vue.js +1 -1
  81. package/dist/views/Request/RequestSubpageHeader.vue2.js +21 -21
  82. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.d.ts.map +1 -1
  83. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.js +1 -1
  84. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +12 -12
  85. package/dist/views/Servers/ServerForm.vue.d.ts +8 -1
  86. package/dist/views/Servers/ServerForm.vue.d.ts.map +1 -1
  87. package/dist/views/Servers/ServerForm.vue.js +28 -59
  88. package/dist/views/Servers/Servers.vue.d.ts.map +1 -1
  89. package/dist/views/Servers/Servers.vue2.js +141 -53
  90. package/package.json +13 -13
@@ -10,7 +10,7 @@ import type { Router } from 'vue-router';
10
10
  export type ClientConfiguration = {
11
11
  proxyUrl?: ReferenceConfiguration['proxyUrl'];
12
12
  themeId?: ReferenceConfiguration['theme'];
13
- } & Pick<ReferenceConfiguration, 'spec' | 'showSidebar' | 'servers' | 'searchHotKey' | 'authentication' | 'baseServerURL' | 'hideClientButton'>;
13
+ } & Pick<ReferenceConfiguration, 'spec' | 'showSidebar' | 'servers' | 'searchHotKey' | 'authentication' | 'baseServerURL' | 'hideClientButton' | '_integration'>;
14
14
  export type OpenClientPayload = {
15
15
  path: string;
16
16
  method: LiteralUnion<RequestMethod | Lowercase<RequestMethod>, string>;
@@ -185,6 +185,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
185
185
  'x-scalar-children'?: {
186
186
  tagName: string;
187
187
  }[] | undefined;
188
+ 'x-internal'?: boolean | undefined;
189
+ 'x-scalar-ignore'?: boolean | undefined;
188
190
  }>;
189
191
  cookies: Record<string, {
190
192
  value: string;
@@ -210,33 +212,6 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
210
212
  type: "requestExample";
211
213
  uid: string;
212
214
  name: string;
213
- body: {
214
- activeBody: "formData" | "binary" | "raw";
215
- formData?: {
216
- value: {
217
- value: string;
218
- key: string;
219
- enabled: boolean;
220
- minimum?: number | undefined;
221
- type?: string | undefined;
222
- maximum?: number | undefined;
223
- default?: any;
224
- required?: boolean | undefined;
225
- description?: string | undefined;
226
- enum?: string[] | undefined;
227
- format?: string | undefined;
228
- file?: any;
229
- nullable?: boolean | undefined;
230
- }[];
231
- encoding: "form-data" | "urlencoded";
232
- } | undefined;
233
- binary?: Blob | undefined;
234
- raw?: {
235
- value: string;
236
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
237
- } | undefined;
238
- };
239
- requestUid: string;
240
215
  parameters: {
241
216
  path: {
242
217
  value: string;
@@ -299,6 +274,33 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
299
274
  nullable?: boolean | undefined;
300
275
  }[];
301
276
  };
277
+ body: {
278
+ activeBody: "binary" | "formData" | "raw";
279
+ binary?: Blob | undefined;
280
+ formData?: {
281
+ value: {
282
+ value: string;
283
+ key: string;
284
+ enabled: boolean;
285
+ minimum?: number | undefined;
286
+ type?: string | undefined;
287
+ maximum?: number | undefined;
288
+ default?: any;
289
+ required?: boolean | undefined;
290
+ description?: string | undefined;
291
+ enum?: string[] | undefined;
292
+ format?: string | undefined;
293
+ file?: any;
294
+ nullable?: boolean | undefined;
295
+ }[];
296
+ encoding: "form-data" | "urlencoded";
297
+ } | undefined;
298
+ raw?: {
299
+ value: string;
300
+ encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
301
+ } | undefined;
302
+ };
303
+ requestUid: string;
302
304
  serverVariables?: Record<string, string[]> | undefined;
303
305
  }>;
304
306
  requests: Record<string, {
@@ -316,6 +318,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
316
318
  url: string;
317
319
  description?: string | undefined;
318
320
  } | undefined;
321
+ 'x-internal'?: boolean | undefined;
322
+ 'x-scalar-ignore'?: boolean | undefined;
319
323
  security?: Record<string, string[]>[] | undefined;
320
324
  tags?: string[] | undefined;
321
325
  deprecated?: boolean | undefined;
@@ -429,7 +433,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
429
433
  hide: () => void;
430
434
  };
431
435
  events: {
432
- executeRequest: import("./event-bus.js").EventBus<any>;
436
+ executeRequest: import("./event-bus.js").EventBus<{
437
+ requestUid?: string;
438
+ }>;
433
439
  cancelRequest: import("./event-bus.js").EventBus<any>;
434
440
  requestStatus: import("./event-bus.js").EventBus<import("./send-request/index.js").RequestStatus>;
435
441
  commandPalette: import("./event-bus.js").EventBus<import("../components/CommandPalette/TheCommandPalette.vue.js").CommandPaletteEvent>;
@@ -441,6 +447,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
441
447
  isReadOnly: boolean;
442
448
  hideClientButton: boolean | undefined;
443
449
  showSidebar: boolean;
450
+ integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
444
451
  importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
445
452
  type?: "collection" | undefined;
446
453
  uid?: string | undefined;
@@ -997,7 +1004,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
997
1004
  documentUrl?: string | undefined;
998
1005
  integration?: string | null | undefined;
999
1006
  }) => void;
1000
- 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" ? {
1007
+ 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" ? {
1001
1008
  type: "collection";
1002
1009
  uid: string;
1003
1010
  children: string[];
@@ -1051,7 +1058,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1051
1058
  }> | undefined;
1052
1059
  documentUrl?: string | undefined;
1053
1060
  integration?: string | null | undefined;
1054
- }[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 Path<{
1061
+ }[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 Path<{
1055
1062
  type: "collection";
1056
1063
  uid: string;
1057
1064
  children: string[];
@@ -1160,7 +1167,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1160
1167
  documentUrl?: string | undefined;
1161
1168
  integration?: string | null | undefined;
1162
1169
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1163
- 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" ? {
1170
+ 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" ? {
1164
1171
  type: "collection";
1165
1172
  uid: string;
1166
1173
  children: string[];
@@ -1214,7 +1221,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1214
1221
  }> | undefined;
1215
1222
  documentUrl?: string | undefined;
1216
1223
  integration?: string | null | undefined;
1217
- }[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 Path<{
1224
+ }[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 Path<{
1218
1225
  type: "collection";
1219
1226
  uid: string;
1220
1227
  children: string[];
@@ -1401,6 +1408,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1401
1408
  url: string;
1402
1409
  description?: string | undefined;
1403
1410
  } | undefined;
1411
+ 'x-internal'?: boolean | undefined;
1412
+ 'x-scalar-ignore'?: boolean | undefined;
1404
1413
  security?: Record<string, string[]>[] | undefined;
1405
1414
  tags?: string[] | undefined;
1406
1415
  deprecated?: boolean | undefined;
@@ -1438,6 +1447,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1438
1447
  url: string;
1439
1448
  description?: string | undefined;
1440
1449
  } | undefined;
1450
+ 'x-internal'?: boolean | undefined;
1451
+ 'x-scalar-ignore'?: boolean | undefined;
1441
1452
  security?: Record<string, string[]>[] | undefined;
1442
1453
  tags?: string[] | undefined;
1443
1454
  deprecated?: boolean | undefined;
@@ -1476,6 +1487,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1476
1487
  url: string;
1477
1488
  description?: string | undefined;
1478
1489
  } | undefined;
1490
+ 'x-internal'?: boolean | undefined;
1491
+ 'x-scalar-ignore'?: boolean | undefined;
1479
1492
  security?: Record<string, string[]>[] | undefined;
1480
1493
  tags?: string[] | undefined;
1481
1494
  deprecated?: boolean | undefined;
@@ -1498,7 +1511,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1498
1511
  requestBody?: any;
1499
1512
  responses?: Record<string, any> | undefined;
1500
1513
  }) => void;
1501
- 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" ? {
1514
+ 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" ? {
1502
1515
  path: string;
1503
1516
  type: "request";
1504
1517
  uid: string;
@@ -1513,6 +1526,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1513
1526
  url: string;
1514
1527
  description?: string | undefined;
1515
1528
  } | undefined;
1529
+ 'x-internal'?: boolean | undefined;
1530
+ 'x-scalar-ignore'?: boolean | undefined;
1516
1531
  security?: Record<string, string[]>[] | undefined;
1517
1532
  tags?: string[] | undefined;
1518
1533
  deprecated?: boolean | undefined;
@@ -1534,7 +1549,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1534
1549
  }[] | undefined;
1535
1550
  requestBody?: any;
1536
1551
  responses?: Record<string, any> | undefined;
1537
- }[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 Path<{
1552
+ }[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 Path<{
1538
1553
  path: string;
1539
1554
  type: "request";
1540
1555
  uid: string;
@@ -1549,6 +1564,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1549
1564
  url: string;
1550
1565
  description?: string | undefined;
1551
1566
  } | undefined;
1567
+ 'x-internal'?: boolean | undefined;
1568
+ 'x-scalar-ignore'?: boolean | undefined;
1552
1569
  security?: Record<string, string[]>[] | undefined;
1553
1570
  tags?: string[] | undefined;
1554
1571
  deprecated?: boolean | undefined;
@@ -1585,6 +1602,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1585
1602
  url: string;
1586
1603
  description?: string | undefined;
1587
1604
  } | undefined;
1605
+ 'x-internal'?: boolean | undefined;
1606
+ 'x-scalar-ignore'?: boolean | undefined;
1588
1607
  security?: Record<string, string[]>[] | undefined;
1589
1608
  tags?: string[] | undefined;
1590
1609
  deprecated?: boolean | undefined;
@@ -1607,7 +1626,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1607
1626
  requestBody?: any;
1608
1627
  responses?: Record<string, any> | undefined;
1609
1628
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1610
- 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" ? {
1629
+ 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" ? {
1611
1630
  path: string;
1612
1631
  type: "request";
1613
1632
  uid: string;
@@ -1622,6 +1641,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1622
1641
  url: string;
1623
1642
  description?: string | undefined;
1624
1643
  } | undefined;
1644
+ 'x-internal'?: boolean | undefined;
1645
+ 'x-scalar-ignore'?: boolean | undefined;
1625
1646
  security?: Record<string, string[]>[] | undefined;
1626
1647
  tags?: string[] | undefined;
1627
1648
  deprecated?: boolean | undefined;
@@ -1643,7 +1664,7 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1643
1664
  }[] | undefined;
1644
1665
  requestBody?: any;
1645
1666
  responses?: Record<string, any> | undefined;
1646
- }[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 Path<{
1667
+ }[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 Path<{
1647
1668
  path: string;
1648
1669
  type: "request";
1649
1670
  uid: string;
@@ -1658,6 +1679,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1658
1679
  url: string;
1659
1680
  description?: string | undefined;
1660
1681
  } | undefined;
1682
+ 'x-internal'?: boolean | undefined;
1683
+ 'x-scalar-ignore'?: boolean | undefined;
1661
1684
  security?: Record<string, string[]>[] | undefined;
1662
1685
  tags?: string[] | undefined;
1663
1686
  deprecated?: boolean | undefined;
@@ -1694,6 +1717,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1694
1717
  url: string;
1695
1718
  description?: string | undefined;
1696
1719
  } | undefined;
1720
+ 'x-internal'?: boolean | undefined;
1721
+ 'x-scalar-ignore'?: boolean | undefined;
1697
1722
  security?: Record<string, string[]>[] | undefined;
1698
1723
  tags?: string[] | undefined;
1699
1724
  deprecated?: boolean | undefined;
@@ -1726,33 +1751,6 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1726
1751
  type: "requestExample";
1727
1752
  uid: string;
1728
1753
  name: string;
1729
- body: {
1730
- activeBody: "formData" | "binary" | "raw";
1731
- formData?: {
1732
- value: {
1733
- value: string;
1734
- key: string;
1735
- enabled: boolean;
1736
- minimum?: number | undefined;
1737
- type?: string | undefined;
1738
- maximum?: number | undefined;
1739
- default?: any;
1740
- required?: boolean | undefined;
1741
- description?: string | undefined;
1742
- enum?: string[] | undefined;
1743
- format?: string | undefined;
1744
- file?: any;
1745
- nullable?: boolean | undefined;
1746
- }[];
1747
- encoding: "form-data" | "urlencoded";
1748
- } | undefined;
1749
- binary?: Blob | undefined;
1750
- raw?: {
1751
- value: string;
1752
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1753
- } | undefined;
1754
- };
1755
- requestUid: string;
1756
1754
  parameters: {
1757
1755
  path: {
1758
1756
  value: string;
@@ -1815,14 +1813,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1815
1813
  nullable?: boolean | undefined;
1816
1814
  }[];
1817
1815
  };
1818
- serverVariables?: Record<string, string[]> | undefined;
1819
- }) => void;
1820
- add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
1821
- type: "requestExample";
1822
- uid: string;
1823
- name: string;
1824
1816
  body: {
1825
- activeBody: "formData" | "binary" | "raw";
1817
+ activeBody: "binary" | "formData" | "raw";
1818
+ binary?: Blob | undefined;
1826
1819
  formData?: {
1827
1820
  value: {
1828
1821
  value: string;
@@ -1841,13 +1834,18 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1841
1834
  }[];
1842
1835
  encoding: "form-data" | "urlencoded";
1843
1836
  } | undefined;
1844
- binary?: Blob | undefined;
1845
1837
  raw?: {
1846
1838
  value: string;
1847
1839
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1848
1840
  } | undefined;
1849
1841
  };
1850
1842
  requestUid: string;
1843
+ serverVariables?: Record<string, string[]> | undefined;
1844
+ }) => void;
1845
+ add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
1846
+ type: "requestExample";
1847
+ uid: string;
1848
+ name: string;
1851
1849
  parameters: {
1852
1850
  path: {
1853
1851
  value: string;
@@ -1910,15 +1908,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1910
1908
  nullable?: boolean | undefined;
1911
1909
  }[];
1912
1910
  };
1913
- serverVariables?: Record<string, string[]> | undefined;
1914
- };
1915
- delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
1916
- set: (item: {
1917
- type: "requestExample";
1918
- uid: string;
1919
- name: string;
1920
1911
  body: {
1921
- activeBody: "formData" | "binary" | "raw";
1912
+ activeBody: "binary" | "formData" | "raw";
1913
+ binary?: Blob | undefined;
1922
1914
  formData?: {
1923
1915
  value: {
1924
1916
  value: string;
@@ -1937,13 +1929,19 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
1937
1929
  }[];
1938
1930
  encoding: "form-data" | "urlencoded";
1939
1931
  } | undefined;
1940
- binary?: Blob | undefined;
1941
1932
  raw?: {
1942
1933
  value: string;
1943
1934
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1944
1935
  } | undefined;
1945
1936
  };
1946
1937
  requestUid: string;
1938
+ serverVariables?: Record<string, string[]> | undefined;
1939
+ };
1940
+ delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
1941
+ set: (item: {
1942
+ type: "requestExample";
1943
+ uid: string;
1944
+ name: string;
1947
1945
  parameters: {
1948
1946
  path: {
1949
1947
  value: string;
@@ -2006,14 +2004,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2006
2004
  nullable?: boolean | undefined;
2007
2005
  }[];
2008
2006
  };
2009
- serverVariables?: Record<string, string[]> | undefined;
2010
- }) => void;
2011
- 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" ? {
2012
- type: "requestExample";
2013
- uid: string;
2014
- name: string;
2015
2007
  body: {
2016
- activeBody: "formData" | "binary" | "raw";
2008
+ activeBody: "binary" | "formData" | "raw";
2009
+ binary?: Blob | undefined;
2017
2010
  formData?: {
2018
2011
  value: {
2019
2012
  value: string;
@@ -2032,13 +2025,18 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2032
2025
  }[];
2033
2026
  encoding: "form-data" | "urlencoded";
2034
2027
  } | undefined;
2035
- binary?: Blob | undefined;
2036
2028
  raw?: {
2037
2029
  value: string;
2038
2030
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2039
2031
  } | undefined;
2040
2032
  };
2041
2033
  requestUid: string;
2034
+ serverVariables?: Record<string, string[]> | undefined;
2035
+ }) => void;
2036
+ 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" ? {
2037
+ type: "requestExample";
2038
+ uid: string;
2039
+ name: string;
2042
2040
  parameters: {
2043
2041
  path: {
2044
2042
  value: string;
@@ -2101,13 +2099,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2101
2099
  nullable?: boolean | undefined;
2102
2100
  }[];
2103
2101
  };
2104
- serverVariables?: Record<string, string[]> | undefined;
2105
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2106
- type: "requestExample";
2107
- uid: string;
2108
- name: string;
2109
2102
  body: {
2110
- activeBody: "formData" | "binary" | "raw";
2103
+ activeBody: "binary" | "formData" | "raw";
2104
+ binary?: Blob | undefined;
2111
2105
  formData?: {
2112
2106
  value: {
2113
2107
  value: string;
@@ -2126,13 +2120,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2126
2120
  }[];
2127
2121
  encoding: "form-data" | "urlencoded";
2128
2122
  } | undefined;
2129
- binary?: Blob | undefined;
2130
2123
  raw?: {
2131
2124
  value: string;
2132
2125
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2133
2126
  } | undefined;
2134
2127
  };
2135
2128
  requestUid: string;
2129
+ serverVariables?: Record<string, string[]> | undefined;
2130
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2131
+ type: "requestExample";
2132
+ uid: string;
2133
+ name: string;
2136
2134
  parameters: {
2137
2135
  path: {
2138
2136
  value: string;
@@ -2195,13 +2193,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2195
2193
  nullable?: boolean | undefined;
2196
2194
  }[];
2197
2195
  };
2198
- serverVariables?: Record<string, string[]> | undefined;
2199
- }[K]> ? PathValue<{
2200
- type: "requestExample";
2201
- uid: string;
2202
- name: string;
2203
2196
  body: {
2204
- activeBody: "formData" | "binary" | "raw";
2197
+ activeBody: "binary" | "formData" | "raw";
2198
+ binary?: Blob | undefined;
2205
2199
  formData?: {
2206
2200
  value: {
2207
2201
  value: string;
@@ -2220,13 +2214,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2220
2214
  }[];
2221
2215
  encoding: "form-data" | "urlencoded";
2222
2216
  } | undefined;
2223
- binary?: Blob | undefined;
2224
2217
  raw?: {
2225
2218
  value: string;
2226
2219
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2227
2220
  } | undefined;
2228
2221
  };
2229
2222
  requestUid: string;
2223
+ serverVariables?: Record<string, string[]> | undefined;
2224
+ }[K]> ? PathValue<{
2225
+ type: "requestExample";
2226
+ uid: string;
2227
+ name: string;
2230
2228
  parameters: {
2231
2229
  path: {
2232
2230
  value: string;
@@ -2289,14 +2287,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2289
2287
  nullable?: boolean | undefined;
2290
2288
  }[];
2291
2289
  };
2292
- serverVariables?: Record<string, string[]> | undefined;
2293
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2294
- 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" ? {
2295
- type: "requestExample";
2296
- uid: string;
2297
- name: string;
2298
2290
  body: {
2299
- activeBody: "formData" | "binary" | "raw";
2291
+ activeBody: "binary" | "formData" | "raw";
2292
+ binary?: Blob | undefined;
2300
2293
  formData?: {
2301
2294
  value: {
2302
2295
  value: string;
@@ -2315,13 +2308,18 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2315
2308
  }[];
2316
2309
  encoding: "form-data" | "urlencoded";
2317
2310
  } | undefined;
2318
- binary?: Blob | undefined;
2319
2311
  raw?: {
2320
2312
  value: string;
2321
2313
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2322
2314
  } | undefined;
2323
2315
  };
2324
2316
  requestUid: string;
2317
+ serverVariables?: Record<string, string[]> | undefined;
2318
+ }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2319
+ 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" ? {
2320
+ type: "requestExample";
2321
+ uid: string;
2322
+ name: string;
2325
2323
  parameters: {
2326
2324
  path: {
2327
2325
  value: string;
@@ -2384,13 +2382,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2384
2382
  nullable?: boolean | undefined;
2385
2383
  }[];
2386
2384
  };
2387
- serverVariables?: Record<string, string[]> | undefined;
2388
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2389
- type: "requestExample";
2390
- uid: string;
2391
- name: string;
2392
2385
  body: {
2393
- activeBody: "formData" | "binary" | "raw";
2386
+ activeBody: "binary" | "formData" | "raw";
2387
+ binary?: Blob | undefined;
2394
2388
  formData?: {
2395
2389
  value: {
2396
2390
  value: string;
@@ -2409,13 +2403,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2409
2403
  }[];
2410
2404
  encoding: "form-data" | "urlencoded";
2411
2405
  } | undefined;
2412
- binary?: Blob | undefined;
2413
2406
  raw?: {
2414
2407
  value: string;
2415
2408
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2416
2409
  } | undefined;
2417
2410
  };
2418
2411
  requestUid: string;
2412
+ serverVariables?: Record<string, string[]> | undefined;
2413
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
2414
+ type: "requestExample";
2415
+ uid: string;
2416
+ name: string;
2419
2417
  parameters: {
2420
2418
  path: {
2421
2419
  value: string;
@@ -2478,13 +2476,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2478
2476
  nullable?: boolean | undefined;
2479
2477
  }[];
2480
2478
  };
2481
- serverVariables?: Record<string, string[]> | undefined;
2482
- }[K]> ? PathValue<{
2483
- type: "requestExample";
2484
- uid: string;
2485
- name: string;
2486
2479
  body: {
2487
- activeBody: "formData" | "binary" | "raw";
2480
+ activeBody: "binary" | "formData" | "raw";
2481
+ binary?: Blob | undefined;
2488
2482
  formData?: {
2489
2483
  value: {
2490
2484
  value: string;
@@ -2503,13 +2497,17 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2503
2497
  }[];
2504
2498
  encoding: "form-data" | "urlencoded";
2505
2499
  } | undefined;
2506
- binary?: Blob | undefined;
2507
2500
  raw?: {
2508
2501
  value: string;
2509
2502
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2510
2503
  } | undefined;
2511
2504
  };
2512
2505
  requestUid: string;
2506
+ serverVariables?: Record<string, string[]> | undefined;
2507
+ }[K]> ? PathValue<{
2508
+ type: "requestExample";
2509
+ uid: string;
2510
+ name: string;
2513
2511
  parameters: {
2514
2512
  path: {
2515
2513
  value: string;
@@ -2572,6 +2570,33 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
2572
2570
  nullable?: boolean | undefined;
2573
2571
  }[];
2574
2572
  };
2573
+ body: {
2574
+ activeBody: "binary" | "formData" | "raw";
2575
+ binary?: Blob | undefined;
2576
+ formData?: {
2577
+ value: {
2578
+ value: string;
2579
+ key: string;
2580
+ enabled: boolean;
2581
+ minimum?: number | undefined;
2582
+ type?: string | undefined;
2583
+ maximum?: number | undefined;
2584
+ default?: any;
2585
+ required?: boolean | undefined;
2586
+ description?: string | undefined;
2587
+ enum?: string[] | undefined;
2588
+ format?: string | undefined;
2589
+ file?: any;
2590
+ nullable?: boolean | undefined;
2591
+ }[];
2592
+ encoding: "form-data" | "urlencoded";
2593
+ } | undefined;
2594
+ raw?: {
2595
+ value: string;
2596
+ encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2597
+ } | undefined;
2598
+ };
2599
+ requestUid: string;
2575
2600
  serverVariables?: Record<string, string[]> | undefined;
2576
2601
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2577
2602
  undo: (uid: string) => void;
@@ -3362,6 +3387,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3362
3387
  'x-scalar-children'?: {
3363
3388
  tagName: string;
3364
3389
  }[] | undefined;
3390
+ 'x-internal'?: boolean | undefined;
3391
+ 'x-scalar-ignore'?: boolean | undefined;
3365
3392
  }) => void;
3366
3393
  add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
3367
3394
  type: "tag";
@@ -3376,6 +3403,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3376
3403
  'x-scalar-children'?: {
3377
3404
  tagName: string;
3378
3405
  }[] | undefined;
3406
+ 'x-internal'?: boolean | undefined;
3407
+ 'x-scalar-ignore'?: boolean | undefined;
3379
3408
  };
3380
3409
  delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
3381
3410
  set: (item: {
@@ -3391,8 +3420,10 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3391
3420
  'x-scalar-children'?: {
3392
3421
  tagName: string;
3393
3422
  }[] | undefined;
3423
+ 'x-internal'?: boolean | undefined;
3424
+ 'x-scalar-ignore'?: boolean | undefined;
3394
3425
  }) => void;
3395
- 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" ? {
3426
+ 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" ? {
3396
3427
  type: "tag";
3397
3428
  uid: string;
3398
3429
  name: string;
@@ -3405,7 +3436,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3405
3436
  'x-scalar-children'?: {
3406
3437
  tagName: string;
3407
3438
  }[] | undefined;
3408
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
3439
+ 'x-internal'?: boolean | undefined;
3440
+ 'x-scalar-ignore'?: boolean | undefined;
3441
+ }[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 Path<{
3409
3442
  type: "tag";
3410
3443
  uid: string;
3411
3444
  name: string;
@@ -3418,6 +3451,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3418
3451
  'x-scalar-children'?: {
3419
3452
  tagName: string;
3420
3453
  }[] | undefined;
3454
+ 'x-internal'?: boolean | undefined;
3455
+ 'x-scalar-ignore'?: boolean | undefined;
3421
3456
  }[K]> ? PathValue<{
3422
3457
  type: "tag";
3423
3458
  uid: string;
@@ -3431,8 +3466,10 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3431
3466
  'x-scalar-children'?: {
3432
3467
  tagName: string;
3433
3468
  }[] | undefined;
3469
+ 'x-internal'?: boolean | undefined;
3470
+ 'x-scalar-ignore'?: boolean | undefined;
3434
3471
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3435
- 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" ? {
3472
+ 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" ? {
3436
3473
  type: "tag";
3437
3474
  uid: string;
3438
3475
  name: string;
@@ -3445,7 +3482,9 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3445
3482
  'x-scalar-children'?: {
3446
3483
  tagName: string;
3447
3484
  }[] | undefined;
3448
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
3485
+ 'x-internal'?: boolean | undefined;
3486
+ 'x-scalar-ignore'?: boolean | undefined;
3487
+ }[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 Path<{
3449
3488
  type: "tag";
3450
3489
  uid: string;
3451
3490
  name: string;
@@ -3458,6 +3497,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3458
3497
  'x-scalar-children'?: {
3459
3498
  tagName: string;
3460
3499
  }[] | undefined;
3500
+ 'x-internal'?: boolean | undefined;
3501
+ 'x-scalar-ignore'?: boolean | undefined;
3461
3502
  }[K]> ? PathValue<{
3462
3503
  type: "tag";
3463
3504
  uid: string;
@@ -3471,6 +3512,8 @@ export declare const createApiClient: ({ el, appComponent, configuration, isRead
3471
3512
  'x-scalar-children'?: {
3472
3513
  tagName: string;
3473
3514
  }[] | undefined;
3515
+ 'x-internal'?: boolean | undefined;
3516
+ 'x-scalar-ignore'?: boolean | undefined;
3474
3517
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3475
3518
  undo: (uid: string) => void;
3476
3519
  redo: (uid: string) => void;