@scalar/api-client 2.1.26 → 2.1.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/components/CommandPalette/CommandPaletteImport.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteImport.vue.js +149 -89
- package/dist/components/ImportCollection/ImportNowButton.vue.d.ts.map +1 -1
- package/dist/components/ImportCollection/ImportNowButton.vue.js +7 -9
- package/dist/layouts/App/create-api-client-app.d.ts +77 -20
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/App/create-api-client-app.js +14 -12
- package/dist/layouts/Modal/create-api-client-modal.d.ts +154 -40
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.js +23 -26
- package/dist/layouts/Web/create-api-client-web.d.ts +77 -20
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.js +12 -10
- package/dist/libs/create-client.d.ts +77 -20
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/create-client.js +60 -58
- package/dist/store/collections.d.ts +34 -4
- package/dist/store/collections.d.ts.map +1 -1
- package/dist/store/import-spec.d.ts +43 -4
- package/dist/store/import-spec.d.ts.map +1 -1
- package/dist/store/import-spec.js +60 -36
- package/dist/store/requests.d.ts +4 -1
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/requests.js +76 -76
- package/dist/store/security-schemes.d.ts +2 -2
- package/dist/store/security-schemes.d.ts.map +1 -1
- package/dist/store/security-schemes.js +35 -37
- package/dist/store/servers.d.ts +10 -10
- package/dist/store/servers.d.ts.map +1 -1
- package/dist/store/store.d.ts +154 -40
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/store.js +27 -27
- package/dist/style.css +1 -1
- package/dist/views/Request/Request.vue.d.ts.map +1 -1
- package/dist/views/Request/Request.vue.js +1 -1
- package/dist/views/Request/Request.vue2.js +39 -38
- package/dist/views/Request/RequestSection/RequestAuth/DeleteRequestAuthModal.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/DeleteRequestAuthModal.vue.js +12 -12
- package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebar.vue.js +4 -4
- package/dist/views/Request/RequestSidebar.vue2.js +107 -102
- package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItem.vue.js +1 -1
- package/dist/views/Request/RequestSidebarItem.vue2.js +165 -135
- package/dist/views/Request/RequestSidebarItemMenu.vue.d.ts +3 -1
- package/dist/views/Request/RequestSidebarItemMenu.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItemMenu.vue.js +4 -4
- package/dist/views/Request/RequestSidebarItemMenu.vue2.js +96 -71
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/dist/views/Request/hooks/useOpenApiWatcher.d.ts +9 -0
- package/dist/views/Request/hooks/useOpenApiWatcher.d.ts.map +1 -0
- package/dist/views/Request/hooks/useOpenApiWatcher.js +86 -0
- package/dist/views/Request/libs/live-sync.d.ts +59 -0
- package/dist/views/Request/libs/live-sync.d.ts.map +1 -0
- package/dist/views/Request/libs/live-sync.js +289 -0
- package/dist/views/Request/types/sidebar-item.d.ts +2 -0
- package/dist/views/Request/types/sidebar-item.d.ts.map +1 -1
- package/package.json +10 -8
|
@@ -82,6 +82,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
82
82
|
token: string;
|
|
83
83
|
clientSecret: string;
|
|
84
84
|
}>;
|
|
85
|
+
watchForChanges: boolean;
|
|
86
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
85
87
|
externalDocs?: {
|
|
86
88
|
url: string;
|
|
87
89
|
description?: string | undefined;
|
|
@@ -106,6 +108,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
106
108
|
} | undefined;
|
|
107
109
|
components?: Record<string, unknown> | undefined;
|
|
108
110
|
webhooks?: Record<string, unknown> | undefined;
|
|
111
|
+
documentUrl?: string | undefined;
|
|
109
112
|
}>;
|
|
110
113
|
tags: Record<string, {
|
|
111
114
|
type: "tag";
|
|
@@ -275,8 +278,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
275
278
|
}>;
|
|
276
279
|
servers: Record<string, {
|
|
277
280
|
uid: string;
|
|
281
|
+
url: string;
|
|
278
282
|
description?: string | undefined;
|
|
279
|
-
url?: string | undefined;
|
|
280
283
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
281
284
|
enum?: [string, ...string[]];
|
|
282
285
|
}> | undefined;
|
|
@@ -375,6 +378,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
375
378
|
token: string;
|
|
376
379
|
clientSecret: string;
|
|
377
380
|
}>;
|
|
381
|
+
watchForChanges: boolean;
|
|
382
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
378
383
|
externalDocs?: {
|
|
379
384
|
url: string;
|
|
380
385
|
description?: string | undefined;
|
|
@@ -399,6 +404,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
399
404
|
} | undefined;
|
|
400
405
|
components?: Record<string, unknown> | undefined;
|
|
401
406
|
webhooks?: Record<string, unknown> | undefined;
|
|
407
|
+
documentUrl?: string | undefined;
|
|
402
408
|
} | undefined>;
|
|
403
409
|
activeCookieId: import("vue").ComputedRef<string | undefined>;
|
|
404
410
|
activeExample: import("vue").ComputedRef<{
|
|
@@ -553,8 +559,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
553
559
|
}>;
|
|
554
560
|
activeServer: import("vue").ComputedRef<{
|
|
555
561
|
uid: string;
|
|
562
|
+
url: string;
|
|
556
563
|
description?: string | undefined;
|
|
557
|
-
url?: string | undefined;
|
|
558
564
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
559
565
|
enum?: [string, ...string[]];
|
|
560
566
|
}> | undefined;
|
|
@@ -617,6 +623,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
617
623
|
token: string;
|
|
618
624
|
clientSecret: string;
|
|
619
625
|
}>;
|
|
626
|
+
watchForChanges: boolean;
|
|
627
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
620
628
|
externalDocs?: {
|
|
621
629
|
url: string;
|
|
622
630
|
description?: string | undefined;
|
|
@@ -641,11 +649,12 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
641
649
|
} | undefined;
|
|
642
650
|
components?: Record<string, unknown> | undefined;
|
|
643
651
|
webhooks?: Record<string, unknown> | undefined;
|
|
652
|
+
documentUrl?: string | undefined;
|
|
644
653
|
}[]>;
|
|
645
654
|
activeWorkspaceServers: import("vue").ComputedRef<{
|
|
646
655
|
uid: string;
|
|
656
|
+
url: string;
|
|
647
657
|
description?: string | undefined;
|
|
648
|
-
url?: string | undefined;
|
|
649
658
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
650
659
|
enum?: [string, ...string[]];
|
|
651
660
|
}> | undefined;
|
|
@@ -673,7 +682,12 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
673
682
|
setSidebarWidth: (width: string) => void;
|
|
674
683
|
proxyUrl: import("vue").Ref<string, string>;
|
|
675
684
|
setProxyUrl: (url: string) => void;
|
|
676
|
-
importSpecFile: (_spec: string | Record<string, any>, workspaceUid
|
|
685
|
+
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
|
|
686
|
+
documentUrl?: string;
|
|
687
|
+
watchForChanges?: boolean;
|
|
688
|
+
overloadServers?: import("@scalar/types/legacy").Spec["servers"];
|
|
689
|
+
preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
|
|
690
|
+
}) => Promise<{
|
|
677
691
|
type: "collection";
|
|
678
692
|
uid: string;
|
|
679
693
|
children: string[];
|
|
@@ -712,6 +726,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
712
726
|
token: string;
|
|
713
727
|
clientSecret: string;
|
|
714
728
|
}>;
|
|
729
|
+
watchForChanges: boolean;
|
|
730
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
715
731
|
externalDocs?: {
|
|
716
732
|
url: string;
|
|
717
733
|
description?: string | undefined;
|
|
@@ -736,8 +752,19 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
736
752
|
} | undefined;
|
|
737
753
|
components?: Record<string, unknown> | undefined;
|
|
738
754
|
webhooks?: Record<string, unknown> | undefined;
|
|
755
|
+
documentUrl?: string | undefined;
|
|
739
756
|
} | undefined>;
|
|
740
|
-
importSpecFromUrl: (url: string,
|
|
757
|
+
importSpecFromUrl: (url: string, workspaceUid: string, { proxy, overloadServers, watchForChanges, preferredSecurityScheme, }?: {
|
|
758
|
+
watchForChanges?: boolean;
|
|
759
|
+
overloadServers?: import("@scalar/types/legacy").Spec["servers"];
|
|
760
|
+
preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
|
|
761
|
+
proxy?: string;
|
|
762
|
+
}) => Promise<import("../../libs/index.js").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
|
|
763
|
+
documentUrl?: string;
|
|
764
|
+
watchForChanges?: boolean;
|
|
765
|
+
overloadServers?: import("@scalar/types/legacy").Spec["servers"];
|
|
766
|
+
preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
|
|
767
|
+
}) => Promise<{
|
|
741
768
|
type: "collection";
|
|
742
769
|
uid: string;
|
|
743
770
|
children: string[];
|
|
@@ -776,6 +803,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
776
803
|
token: string;
|
|
777
804
|
clientSecret: string;
|
|
778
805
|
}>;
|
|
806
|
+
watchForChanges: boolean;
|
|
807
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
779
808
|
externalDocs?: {
|
|
780
809
|
url: string;
|
|
781
810
|
description?: string | undefined;
|
|
@@ -800,7 +829,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
800
829
|
} | undefined;
|
|
801
830
|
components?: Record<string, unknown> | undefined;
|
|
802
831
|
webhooks?: Record<string, unknown> | undefined;
|
|
803
|
-
|
|
832
|
+
documentUrl?: string | undefined;
|
|
833
|
+
} | undefined>>>>>;
|
|
804
834
|
cookieMutators: {
|
|
805
835
|
add: (item: {
|
|
806
836
|
value: string;
|
|
@@ -946,6 +976,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
946
976
|
token: string;
|
|
947
977
|
clientSecret: string;
|
|
948
978
|
}>;
|
|
979
|
+
watchForChanges: boolean;
|
|
980
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
949
981
|
externalDocs?: {
|
|
950
982
|
url: string;
|
|
951
983
|
description?: string | undefined;
|
|
@@ -970,6 +1002,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
970
1002
|
} | undefined;
|
|
971
1003
|
components?: Record<string, unknown> | undefined;
|
|
972
1004
|
webhooks?: Record<string, unknown> | undefined;
|
|
1005
|
+
documentUrl?: string | undefined;
|
|
973
1006
|
}) => void;
|
|
974
1007
|
add: (payload: import("@scalar/oas-utils/entities/spec").CollectionPayload, workspaceUid: string) => {
|
|
975
1008
|
type: "collection";
|
|
@@ -1010,6 +1043,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1010
1043
|
token: string;
|
|
1011
1044
|
clientSecret: string;
|
|
1012
1045
|
}>;
|
|
1046
|
+
watchForChanges: boolean;
|
|
1047
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1013
1048
|
externalDocs?: {
|
|
1014
1049
|
url: string;
|
|
1015
1050
|
description?: string | undefined;
|
|
@@ -1034,6 +1069,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1034
1069
|
} | undefined;
|
|
1035
1070
|
components?: Record<string, unknown> | undefined;
|
|
1036
1071
|
webhooks?: Record<string, unknown> | undefined;
|
|
1072
|
+
documentUrl?: string | undefined;
|
|
1037
1073
|
};
|
|
1038
1074
|
delete: (collection: import("@scalar/oas-utils/entities/spec").Collection, workspace: import("@scalar/oas-utils/entities/workspace").Workspace) => void;
|
|
1039
1075
|
set: (item: {
|
|
@@ -1075,6 +1111,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1075
1111
|
token: string;
|
|
1076
1112
|
clientSecret: string;
|
|
1077
1113
|
}>;
|
|
1114
|
+
watchForChanges: boolean;
|
|
1115
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1078
1116
|
externalDocs?: {
|
|
1079
1117
|
url: string;
|
|
1080
1118
|
description?: string | undefined;
|
|
@@ -1099,8 +1137,9 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1099
1137
|
} | undefined;
|
|
1100
1138
|
components?: Record<string, unknown> | undefined;
|
|
1101
1139
|
webhooks?: Record<string, unknown> | undefined;
|
|
1140
|
+
documentUrl?: string | undefined;
|
|
1102
1141
|
}) => void;
|
|
1103
|
-
edit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? {
|
|
1142
|
+
edit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | "watchForChangesStatus" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? {
|
|
1104
1143
|
type: "collection";
|
|
1105
1144
|
uid: string;
|
|
1106
1145
|
children: string[];
|
|
@@ -1139,6 +1178,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1139
1178
|
token: string;
|
|
1140
1179
|
clientSecret: string;
|
|
1141
1180
|
}>;
|
|
1181
|
+
watchForChanges: boolean;
|
|
1182
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1142
1183
|
externalDocs?: {
|
|
1143
1184
|
url: string;
|
|
1144
1185
|
description?: string | undefined;
|
|
@@ -1163,7 +1204,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1163
1204
|
} | undefined;
|
|
1164
1205
|
components?: Record<string, unknown> | undefined;
|
|
1165
1206
|
webhooks?: Record<string, unknown> | undefined;
|
|
1166
|
-
|
|
1207
|
+
documentUrl?: string | undefined;
|
|
1208
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1167
1209
|
type: "collection";
|
|
1168
1210
|
uid: string;
|
|
1169
1211
|
children: string[];
|
|
@@ -1202,6 +1244,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1202
1244
|
token: string;
|
|
1203
1245
|
clientSecret: string;
|
|
1204
1246
|
}>;
|
|
1247
|
+
watchForChanges: boolean;
|
|
1248
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1205
1249
|
externalDocs?: {
|
|
1206
1250
|
url: string;
|
|
1207
1251
|
description?: string | undefined;
|
|
@@ -1226,6 +1270,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1226
1270
|
} | undefined;
|
|
1227
1271
|
components?: Record<string, unknown> | undefined;
|
|
1228
1272
|
webhooks?: Record<string, unknown> | undefined;
|
|
1273
|
+
documentUrl?: string | undefined;
|
|
1229
1274
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1230
1275
|
type: "collection";
|
|
1231
1276
|
uid: string;
|
|
@@ -1265,6 +1310,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1265
1310
|
token: string;
|
|
1266
1311
|
clientSecret: string;
|
|
1267
1312
|
}>;
|
|
1313
|
+
watchForChanges: boolean;
|
|
1314
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1268
1315
|
externalDocs?: {
|
|
1269
1316
|
url: string;
|
|
1270
1317
|
description?: string | undefined;
|
|
@@ -1289,8 +1336,9 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1289
1336
|
} | undefined;
|
|
1290
1337
|
components?: Record<string, unknown> | undefined;
|
|
1291
1338
|
webhooks?: Record<string, unknown> | undefined;
|
|
1339
|
+
documentUrl?: string | undefined;
|
|
1292
1340
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1293
|
-
untrackedEdit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? {
|
|
1341
|
+
untrackedEdit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | "watchForChangesStatus" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? {
|
|
1294
1342
|
type: "collection";
|
|
1295
1343
|
uid: string;
|
|
1296
1344
|
children: string[];
|
|
@@ -1329,6 +1377,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1329
1377
|
token: string;
|
|
1330
1378
|
clientSecret: string;
|
|
1331
1379
|
}>;
|
|
1380
|
+
watchForChanges: boolean;
|
|
1381
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1332
1382
|
externalDocs?: {
|
|
1333
1383
|
url: string;
|
|
1334
1384
|
description?: string | undefined;
|
|
@@ -1353,7 +1403,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1353
1403
|
} | undefined;
|
|
1354
1404
|
components?: Record<string, unknown> | undefined;
|
|
1355
1405
|
webhooks?: Record<string, unknown> | undefined;
|
|
1356
|
-
|
|
1406
|
+
documentUrl?: string | undefined;
|
|
1407
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1357
1408
|
type: "collection";
|
|
1358
1409
|
uid: string;
|
|
1359
1410
|
children: string[];
|
|
@@ -1392,6 +1443,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1392
1443
|
token: string;
|
|
1393
1444
|
clientSecret: string;
|
|
1394
1445
|
}>;
|
|
1446
|
+
watchForChanges: boolean;
|
|
1447
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1395
1448
|
externalDocs?: {
|
|
1396
1449
|
url: string;
|
|
1397
1450
|
description?: string | undefined;
|
|
@@ -1416,6 +1469,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1416
1469
|
} | undefined;
|
|
1417
1470
|
components?: Record<string, unknown> | undefined;
|
|
1418
1471
|
webhooks?: Record<string, unknown> | undefined;
|
|
1472
|
+
documentUrl?: string | undefined;
|
|
1419
1473
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
1420
1474
|
type: "collection";
|
|
1421
1475
|
uid: string;
|
|
@@ -1455,6 +1509,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1455
1509
|
token: string;
|
|
1456
1510
|
clientSecret: string;
|
|
1457
1511
|
}>;
|
|
1512
|
+
watchForChanges: boolean;
|
|
1513
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
1458
1514
|
externalDocs?: {
|
|
1459
1515
|
url: string;
|
|
1460
1516
|
description?: string | undefined;
|
|
@@ -1479,6 +1535,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
1479
1535
|
} | undefined;
|
|
1480
1536
|
components?: Record<string, unknown> | undefined;
|
|
1481
1537
|
webhooks?: Record<string, unknown> | undefined;
|
|
1538
|
+
documentUrl?: string | undefined;
|
|
1482
1539
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1483
1540
|
undo: (uid: string) => void;
|
|
1484
1541
|
redo: (uid: string) => void;
|
|
@@ -2843,7 +2900,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
2843
2900
|
'x-scalar-client-id': string;
|
|
2844
2901
|
description?: string | undefined;
|
|
2845
2902
|
};
|
|
2846
|
-
delete: (
|
|
2903
|
+
delete: (schemeUid: string) => void;
|
|
2847
2904
|
set: (item: {
|
|
2848
2905
|
type: "apiKey";
|
|
2849
2906
|
uid: string;
|
|
@@ -3231,16 +3288,16 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
3231
3288
|
serverMutators: {
|
|
3232
3289
|
rawAdd: (item: {
|
|
3233
3290
|
uid: string;
|
|
3291
|
+
url: string;
|
|
3234
3292
|
description?: string | undefined;
|
|
3235
|
-
url?: string | undefined;
|
|
3236
3293
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3237
3294
|
enum?: [string, ...string[]];
|
|
3238
3295
|
}> | undefined;
|
|
3239
3296
|
}) => void;
|
|
3240
3297
|
add: (payload: import("@scalar/oas-utils/entities/spec").ServerPayload, parentUid: string) => {
|
|
3241
3298
|
uid: string;
|
|
3299
|
+
url: string;
|
|
3242
3300
|
description?: string | undefined;
|
|
3243
|
-
url?: string | undefined;
|
|
3244
3301
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3245
3302
|
enum?: [string, ...string[]];
|
|
3246
3303
|
}> | undefined;
|
|
@@ -3248,52 +3305,52 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
|
|
|
3248
3305
|
delete: (serverUid: string, collectionUid: string) => void;
|
|
3249
3306
|
set: (item: {
|
|
3250
3307
|
uid: string;
|
|
3308
|
+
url: string;
|
|
3251
3309
|
description?: string | undefined;
|
|
3252
|
-
url?: string | undefined;
|
|
3253
3310
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3254
3311
|
enum?: [string, ...string[]];
|
|
3255
3312
|
}> | undefined;
|
|
3256
3313
|
}) => void;
|
|
3257
3314
|
edit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
|
|
3258
3315
|
uid: string;
|
|
3316
|
+
url: string;
|
|
3259
3317
|
description?: string | undefined;
|
|
3260
|
-
url?: string | undefined;
|
|
3261
3318
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3262
3319
|
enum?: [string, ...string[]];
|
|
3263
3320
|
}> | undefined;
|
|
3264
3321
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3265
3322
|
uid: string;
|
|
3323
|
+
url: string;
|
|
3266
3324
|
description?: string | undefined;
|
|
3267
|
-
url?: string | undefined;
|
|
3268
3325
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3269
3326
|
enum?: [string, ...string[]];
|
|
3270
3327
|
}> | undefined;
|
|
3271
3328
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3272
3329
|
uid: string;
|
|
3330
|
+
url: string;
|
|
3273
3331
|
description?: string | undefined;
|
|
3274
|
-
url?: string | undefined;
|
|
3275
3332
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3276
3333
|
enum?: [string, ...string[]];
|
|
3277
3334
|
}> | undefined;
|
|
3278
3335
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3279
3336
|
untrackedEdit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
|
|
3280
3337
|
uid: string;
|
|
3338
|
+
url: string;
|
|
3281
3339
|
description?: string | undefined;
|
|
3282
|
-
url?: string | undefined;
|
|
3283
3340
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3284
3341
|
enum?: [string, ...string[]];
|
|
3285
3342
|
}> | undefined;
|
|
3286
3343
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3287
3344
|
uid: string;
|
|
3345
|
+
url: string;
|
|
3288
3346
|
description?: string | undefined;
|
|
3289
|
-
url?: string | undefined;
|
|
3290
3347
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3291
3348
|
enum?: [string, ...string[]];
|
|
3292
3349
|
}> | undefined;
|
|
3293
3350
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
3294
3351
|
uid: string;
|
|
3352
|
+
url: string;
|
|
3295
3353
|
description?: string | undefined;
|
|
3296
|
-
url?: string | undefined;
|
|
3297
3354
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3298
3355
|
enum?: [string, ...string[]];
|
|
3299
3356
|
}> | undefined;
|
|
@@ -3685,6 +3742,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
3685
3742
|
token: string;
|
|
3686
3743
|
clientSecret: string;
|
|
3687
3744
|
}>;
|
|
3745
|
+
watchForChanges: boolean;
|
|
3746
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
3688
3747
|
externalDocs?: {
|
|
3689
3748
|
url: string;
|
|
3690
3749
|
description?: string | undefined;
|
|
@@ -3709,6 +3768,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
3709
3768
|
} | undefined;
|
|
3710
3769
|
components?: Record<string, unknown> | undefined;
|
|
3711
3770
|
webhooks?: Record<string, unknown> | undefined;
|
|
3771
|
+
documentUrl?: string | undefined;
|
|
3712
3772
|
}>;
|
|
3713
3773
|
tags: Record<string, {
|
|
3714
3774
|
type: "tag";
|
|
@@ -3878,8 +3938,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
3878
3938
|
}>;
|
|
3879
3939
|
servers: Record<string, {
|
|
3880
3940
|
uid: string;
|
|
3941
|
+
url: string;
|
|
3881
3942
|
description?: string | undefined;
|
|
3882
|
-
url?: string | undefined;
|
|
3883
3943
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
3884
3944
|
enum?: [string, ...string[]];
|
|
3885
3945
|
}> | undefined;
|
|
@@ -3978,6 +4038,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
3978
4038
|
token: string;
|
|
3979
4039
|
clientSecret: string;
|
|
3980
4040
|
}>;
|
|
4041
|
+
watchForChanges: boolean;
|
|
4042
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
3981
4043
|
externalDocs?: {
|
|
3982
4044
|
url: string;
|
|
3983
4045
|
description?: string | undefined;
|
|
@@ -4002,6 +4064,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4002
4064
|
} | undefined;
|
|
4003
4065
|
components?: Record<string, unknown> | undefined;
|
|
4004
4066
|
webhooks?: Record<string, unknown> | undefined;
|
|
4067
|
+
documentUrl?: string | undefined;
|
|
4005
4068
|
} | undefined>;
|
|
4006
4069
|
activeCookieId: import("vue").ComputedRef<string | undefined>;
|
|
4007
4070
|
activeExample: import("vue").ComputedRef<{
|
|
@@ -4156,8 +4219,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4156
4219
|
}>;
|
|
4157
4220
|
activeServer: import("vue").ComputedRef<{
|
|
4158
4221
|
uid: string;
|
|
4222
|
+
url: string;
|
|
4159
4223
|
description?: string | undefined;
|
|
4160
|
-
url?: string | undefined;
|
|
4161
4224
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
4162
4225
|
enum?: [string, ...string[]];
|
|
4163
4226
|
}> | undefined;
|
|
@@ -4220,6 +4283,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4220
4283
|
token: string;
|
|
4221
4284
|
clientSecret: string;
|
|
4222
4285
|
}>;
|
|
4286
|
+
watchForChanges: boolean;
|
|
4287
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4223
4288
|
externalDocs?: {
|
|
4224
4289
|
url: string;
|
|
4225
4290
|
description?: string | undefined;
|
|
@@ -4244,11 +4309,12 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4244
4309
|
} | undefined;
|
|
4245
4310
|
components?: Record<string, unknown> | undefined;
|
|
4246
4311
|
webhooks?: Record<string, unknown> | undefined;
|
|
4312
|
+
documentUrl?: string | undefined;
|
|
4247
4313
|
}[]>;
|
|
4248
4314
|
activeWorkspaceServers: import("vue").ComputedRef<{
|
|
4249
4315
|
uid: string;
|
|
4316
|
+
url: string;
|
|
4250
4317
|
description?: string | undefined;
|
|
4251
|
-
url?: string | undefined;
|
|
4252
4318
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
4253
4319
|
enum?: [string, ...string[]];
|
|
4254
4320
|
}> | undefined;
|
|
@@ -4276,7 +4342,12 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4276
4342
|
setSidebarWidth: (width: string) => void;
|
|
4277
4343
|
proxyUrl: import("vue").Ref<string, string>;
|
|
4278
4344
|
setProxyUrl: (url: string) => void;
|
|
4279
|
-
importSpecFile: (_spec: string | Record<string, any>, workspaceUid
|
|
4345
|
+
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
|
|
4346
|
+
documentUrl?: string;
|
|
4347
|
+
watchForChanges?: boolean;
|
|
4348
|
+
overloadServers?: import("@scalar/types/legacy").Spec["servers"];
|
|
4349
|
+
preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
|
|
4350
|
+
}) => Promise<{
|
|
4280
4351
|
type: "collection";
|
|
4281
4352
|
uid: string;
|
|
4282
4353
|
children: string[];
|
|
@@ -4315,6 +4386,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4315
4386
|
token: string;
|
|
4316
4387
|
clientSecret: string;
|
|
4317
4388
|
}>;
|
|
4389
|
+
watchForChanges: boolean;
|
|
4390
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4318
4391
|
externalDocs?: {
|
|
4319
4392
|
url: string;
|
|
4320
4393
|
description?: string | undefined;
|
|
@@ -4339,8 +4412,19 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4339
4412
|
} | undefined;
|
|
4340
4413
|
components?: Record<string, unknown> | undefined;
|
|
4341
4414
|
webhooks?: Record<string, unknown> | undefined;
|
|
4415
|
+
documentUrl?: string | undefined;
|
|
4342
4416
|
} | undefined>;
|
|
4343
|
-
importSpecFromUrl: (url: string,
|
|
4417
|
+
importSpecFromUrl: (url: string, workspaceUid: string, { proxy, overloadServers, watchForChanges, preferredSecurityScheme, }?: {
|
|
4418
|
+
watchForChanges?: boolean;
|
|
4419
|
+
overloadServers?: import("@scalar/types/legacy").Spec["servers"];
|
|
4420
|
+
preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
|
|
4421
|
+
proxy?: string;
|
|
4422
|
+
}) => Promise<import("../../libs/index.js").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
|
|
4423
|
+
documentUrl?: string;
|
|
4424
|
+
watchForChanges?: boolean;
|
|
4425
|
+
overloadServers?: import("@scalar/types/legacy").Spec["servers"];
|
|
4426
|
+
preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
|
|
4427
|
+
}) => Promise<{
|
|
4344
4428
|
type: "collection";
|
|
4345
4429
|
uid: string;
|
|
4346
4430
|
children: string[];
|
|
@@ -4379,6 +4463,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4379
4463
|
token: string;
|
|
4380
4464
|
clientSecret: string;
|
|
4381
4465
|
}>;
|
|
4466
|
+
watchForChanges: boolean;
|
|
4467
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4382
4468
|
externalDocs?: {
|
|
4383
4469
|
url: string;
|
|
4384
4470
|
description?: string | undefined;
|
|
@@ -4403,7 +4489,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4403
4489
|
} | undefined;
|
|
4404
4490
|
components?: Record<string, unknown> | undefined;
|
|
4405
4491
|
webhooks?: Record<string, unknown> | undefined;
|
|
4406
|
-
|
|
4492
|
+
documentUrl?: string | undefined;
|
|
4493
|
+
} | undefined>>>>>;
|
|
4407
4494
|
cookieMutators: {
|
|
4408
4495
|
add: (item: {
|
|
4409
4496
|
value: string;
|
|
@@ -4549,6 +4636,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4549
4636
|
token: string;
|
|
4550
4637
|
clientSecret: string;
|
|
4551
4638
|
}>;
|
|
4639
|
+
watchForChanges: boolean;
|
|
4640
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4552
4641
|
externalDocs?: {
|
|
4553
4642
|
url: string;
|
|
4554
4643
|
description?: string | undefined;
|
|
@@ -4573,6 +4662,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4573
4662
|
} | undefined;
|
|
4574
4663
|
components?: Record<string, unknown> | undefined;
|
|
4575
4664
|
webhooks?: Record<string, unknown> | undefined;
|
|
4665
|
+
documentUrl?: string | undefined;
|
|
4576
4666
|
}) => void;
|
|
4577
4667
|
add: (payload: import("@scalar/oas-utils/entities/spec").CollectionPayload, workspaceUid: string) => {
|
|
4578
4668
|
type: "collection";
|
|
@@ -4613,6 +4703,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4613
4703
|
token: string;
|
|
4614
4704
|
clientSecret: string;
|
|
4615
4705
|
}>;
|
|
4706
|
+
watchForChanges: boolean;
|
|
4707
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4616
4708
|
externalDocs?: {
|
|
4617
4709
|
url: string;
|
|
4618
4710
|
description?: string | undefined;
|
|
@@ -4637,6 +4729,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4637
4729
|
} | undefined;
|
|
4638
4730
|
components?: Record<string, unknown> | undefined;
|
|
4639
4731
|
webhooks?: Record<string, unknown> | undefined;
|
|
4732
|
+
documentUrl?: string | undefined;
|
|
4640
4733
|
};
|
|
4641
4734
|
delete: (collection: import("@scalar/oas-utils/entities/spec").Collection, workspace: import("@scalar/oas-utils/entities/workspace").Workspace) => void;
|
|
4642
4735
|
set: (item: {
|
|
@@ -4678,6 +4771,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4678
4771
|
token: string;
|
|
4679
4772
|
clientSecret: string;
|
|
4680
4773
|
}>;
|
|
4774
|
+
watchForChanges: boolean;
|
|
4775
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4681
4776
|
externalDocs?: {
|
|
4682
4777
|
url: string;
|
|
4683
4778
|
description?: string | undefined;
|
|
@@ -4702,8 +4797,9 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4702
4797
|
} | undefined;
|
|
4703
4798
|
components?: Record<string, unknown> | undefined;
|
|
4704
4799
|
webhooks?: Record<string, unknown> | undefined;
|
|
4800
|
+
documentUrl?: string | undefined;
|
|
4705
4801
|
}) => void;
|
|
4706
|
-
edit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? {
|
|
4802
|
+
edit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | "watchForChangesStatus" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? {
|
|
4707
4803
|
type: "collection";
|
|
4708
4804
|
uid: string;
|
|
4709
4805
|
children: string[];
|
|
@@ -4742,6 +4838,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4742
4838
|
token: string;
|
|
4743
4839
|
clientSecret: string;
|
|
4744
4840
|
}>;
|
|
4841
|
+
watchForChanges: boolean;
|
|
4842
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4745
4843
|
externalDocs?: {
|
|
4746
4844
|
url: string;
|
|
4747
4845
|
description?: string | undefined;
|
|
@@ -4766,7 +4864,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4766
4864
|
} | undefined;
|
|
4767
4865
|
components?: Record<string, unknown> | undefined;
|
|
4768
4866
|
webhooks?: Record<string, unknown> | undefined;
|
|
4769
|
-
|
|
4867
|
+
documentUrl?: string | undefined;
|
|
4868
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4770
4869
|
type: "collection";
|
|
4771
4870
|
uid: string;
|
|
4772
4871
|
children: string[];
|
|
@@ -4805,6 +4904,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4805
4904
|
token: string;
|
|
4806
4905
|
clientSecret: string;
|
|
4807
4906
|
}>;
|
|
4907
|
+
watchForChanges: boolean;
|
|
4908
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4808
4909
|
externalDocs?: {
|
|
4809
4910
|
url: string;
|
|
4810
4911
|
description?: string | undefined;
|
|
@@ -4829,6 +4930,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4829
4930
|
} | undefined;
|
|
4830
4931
|
components?: Record<string, unknown> | undefined;
|
|
4831
4932
|
webhooks?: Record<string, unknown> | undefined;
|
|
4933
|
+
documentUrl?: string | undefined;
|
|
4832
4934
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
4833
4935
|
type: "collection";
|
|
4834
4936
|
uid: string;
|
|
@@ -4868,6 +4970,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4868
4970
|
token: string;
|
|
4869
4971
|
clientSecret: string;
|
|
4870
4972
|
}>;
|
|
4973
|
+
watchForChanges: boolean;
|
|
4974
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4871
4975
|
externalDocs?: {
|
|
4872
4976
|
url: string;
|
|
4873
4977
|
description?: string | undefined;
|
|
@@ -4892,8 +4996,9 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4892
4996
|
} | undefined;
|
|
4893
4997
|
components?: Record<string, unknown> | undefined;
|
|
4894
4998
|
webhooks?: Record<string, unknown> | undefined;
|
|
4999
|
+
documentUrl?: string | undefined;
|
|
4895
5000
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
4896
|
-
untrackedEdit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? {
|
|
5001
|
+
untrackedEdit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | "x-scalar-icon" | "watchForChangesStatus" | `children.${number}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `auth.${string}` | `securitySchemes.${number}` | `requests.${number}` | `components.${string}` | `webhooks.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? {
|
|
4897
5002
|
type: "collection";
|
|
4898
5003
|
uid: string;
|
|
4899
5004
|
children: string[];
|
|
@@ -4932,6 +5037,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4932
5037
|
token: string;
|
|
4933
5038
|
clientSecret: string;
|
|
4934
5039
|
}>;
|
|
5040
|
+
watchForChanges: boolean;
|
|
5041
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4935
5042
|
externalDocs?: {
|
|
4936
5043
|
url: string;
|
|
4937
5044
|
description?: string | undefined;
|
|
@@ -4956,7 +5063,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4956
5063
|
} | undefined;
|
|
4957
5064
|
components?: Record<string, unknown> | undefined;
|
|
4958
5065
|
webhooks?: Record<string, unknown> | undefined;
|
|
4959
|
-
|
|
5066
|
+
documentUrl?: string | undefined;
|
|
5067
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "documentUrl" | "watchForChanges" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
4960
5068
|
type: "collection";
|
|
4961
5069
|
uid: string;
|
|
4962
5070
|
children: string[];
|
|
@@ -4995,6 +5103,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
4995
5103
|
token: string;
|
|
4996
5104
|
clientSecret: string;
|
|
4997
5105
|
}>;
|
|
5106
|
+
watchForChanges: boolean;
|
|
5107
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
4998
5108
|
externalDocs?: {
|
|
4999
5109
|
url: string;
|
|
5000
5110
|
description?: string | undefined;
|
|
@@ -5019,6 +5129,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
5019
5129
|
} | undefined;
|
|
5020
5130
|
components?: Record<string, unknown> | undefined;
|
|
5021
5131
|
webhooks?: Record<string, unknown> | undefined;
|
|
5132
|
+
documentUrl?: string | undefined;
|
|
5022
5133
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
5023
5134
|
type: "collection";
|
|
5024
5135
|
uid: string;
|
|
@@ -5058,6 +5169,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
5058
5169
|
token: string;
|
|
5059
5170
|
clientSecret: string;
|
|
5060
5171
|
}>;
|
|
5172
|
+
watchForChanges: boolean;
|
|
5173
|
+
watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
5061
5174
|
externalDocs?: {
|
|
5062
5175
|
url: string;
|
|
5063
5176
|
description?: string | undefined;
|
|
@@ -5082,6 +5195,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
5082
5195
|
} | undefined;
|
|
5083
5196
|
components?: Record<string, unknown> | undefined;
|
|
5084
5197
|
webhooks?: Record<string, unknown> | undefined;
|
|
5198
|
+
documentUrl?: string | undefined;
|
|
5085
5199
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
5086
5200
|
undo: (uid: string) => void;
|
|
5087
5201
|
redo: (uid: string) => void;
|
|
@@ -6446,7 +6560,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
6446
6560
|
'x-scalar-client-id': string;
|
|
6447
6561
|
description?: string | undefined;
|
|
6448
6562
|
};
|
|
6449
|
-
delete: (
|
|
6563
|
+
delete: (schemeUid: string) => void;
|
|
6450
6564
|
set: (item: {
|
|
6451
6565
|
type: "apiKey";
|
|
6452
6566
|
uid: string;
|
|
@@ -6834,16 +6948,16 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
6834
6948
|
serverMutators: {
|
|
6835
6949
|
rawAdd: (item: {
|
|
6836
6950
|
uid: string;
|
|
6951
|
+
url: string;
|
|
6837
6952
|
description?: string | undefined;
|
|
6838
|
-
url?: string | undefined;
|
|
6839
6953
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6840
6954
|
enum?: [string, ...string[]];
|
|
6841
6955
|
}> | undefined;
|
|
6842
6956
|
}) => void;
|
|
6843
6957
|
add: (payload: import("@scalar/oas-utils/entities/spec").ServerPayload, parentUid: string) => {
|
|
6844
6958
|
uid: string;
|
|
6959
|
+
url: string;
|
|
6845
6960
|
description?: string | undefined;
|
|
6846
|
-
url?: string | undefined;
|
|
6847
6961
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6848
6962
|
enum?: [string, ...string[]];
|
|
6849
6963
|
}> | undefined;
|
|
@@ -6851,52 +6965,52 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
|
|
|
6851
6965
|
delete: (serverUid: string, collectionUid: string) => void;
|
|
6852
6966
|
set: (item: {
|
|
6853
6967
|
uid: string;
|
|
6968
|
+
url: string;
|
|
6854
6969
|
description?: string | undefined;
|
|
6855
|
-
url?: string | undefined;
|
|
6856
6970
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6857
6971
|
enum?: [string, ...string[]];
|
|
6858
6972
|
}> | undefined;
|
|
6859
6973
|
}) => void;
|
|
6860
6974
|
edit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
|
|
6861
6975
|
uid: string;
|
|
6976
|
+
url: string;
|
|
6862
6977
|
description?: string | undefined;
|
|
6863
|
-
url?: string | undefined;
|
|
6864
6978
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6865
6979
|
enum?: [string, ...string[]];
|
|
6866
6980
|
}> | undefined;
|
|
6867
6981
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6868
6982
|
uid: string;
|
|
6983
|
+
url: string;
|
|
6869
6984
|
description?: string | undefined;
|
|
6870
|
-
url?: string | undefined;
|
|
6871
6985
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6872
6986
|
enum?: [string, ...string[]];
|
|
6873
6987
|
}> | undefined;
|
|
6874
6988
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6875
6989
|
uid: string;
|
|
6990
|
+
url: string;
|
|
6876
6991
|
description?: string | undefined;
|
|
6877
|
-
url?: string | undefined;
|
|
6878
6992
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6879
6993
|
enum?: [string, ...string[]];
|
|
6880
6994
|
}> | undefined;
|
|
6881
6995
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
6882
6996
|
untrackedEdit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
|
|
6883
6997
|
uid: string;
|
|
6998
|
+
url: string;
|
|
6884
6999
|
description?: string | undefined;
|
|
6885
|
-
url?: string | undefined;
|
|
6886
7000
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6887
7001
|
enum?: [string, ...string[]];
|
|
6888
7002
|
}> | undefined;
|
|
6889
7003
|
}[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
6890
7004
|
uid: string;
|
|
7005
|
+
url: string;
|
|
6891
7006
|
description?: string | undefined;
|
|
6892
|
-
url?: string | undefined;
|
|
6893
7007
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6894
7008
|
enum?: [string, ...string[]];
|
|
6895
7009
|
}> | undefined;
|
|
6896
7010
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
6897
7011
|
uid: string;
|
|
7012
|
+
url: string;
|
|
6898
7013
|
description?: string | undefined;
|
|
6899
|
-
url?: string | undefined;
|
|
6900
7014
|
variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
6901
7015
|
enum?: [string, ...string[]];
|
|
6902
7016
|
}> | undefined;
|