@scalar/api-client 2.1.32 → 2.1.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 (78) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/dist/components/CodeInput/CodeInput.vue.js +2 -2
  3. package/dist/components/ScalarHotkey.vue.d.ts +5 -6
  4. package/dist/components/ScalarHotkey.vue.d.ts.map +1 -1
  5. package/dist/components/ScalarHotkey.vue.js +9 -18
  6. package/dist/components/Sidebar/SidebarButton.vue.d.ts +4 -0
  7. package/dist/components/Sidebar/SidebarButton.vue.d.ts.map +1 -1
  8. package/dist/components/Sidebar/SidebarButton.vue.js +19 -17
  9. package/dist/index.d.ts +1 -1
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/index.js +8 -8
  12. package/dist/layouts/App/ApiClientApp.vue.d.ts.map +1 -1
  13. package/dist/layouts/App/ApiClientApp.vue.js +35 -29
  14. package/dist/layouts/App/create-api-client-app.d.ts +257 -45
  15. package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
  16. package/dist/layouts/App/create-api-client-app.js +10 -10
  17. package/dist/layouts/App/hotkeys.js +1 -1
  18. package/dist/layouts/Modal/create-api-client-modal.d.ts +514 -90
  19. package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
  20. package/dist/layouts/Modal/create-api-client-modal.js +24 -22
  21. package/dist/layouts/Web/ApiClientWeb.vue.d.ts.map +1 -1
  22. package/dist/layouts/Web/ApiClientWeb.vue.js +33 -27
  23. package/dist/layouts/Web/create-api-client-web.d.ts +258 -46
  24. package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
  25. package/dist/layouts/Web/create-api-client-web.js +9 -9
  26. package/dist/libs/create-client.d.ts +280 -50
  27. package/dist/libs/create-client.d.ts.map +1 -1
  28. package/dist/libs/create-client.js +25 -24
  29. package/dist/libs/hot-keys.d.ts +1 -1
  30. package/dist/libs/local-storage.d.ts +2 -2
  31. package/dist/libs/local-storage.d.ts.map +1 -1
  32. package/dist/libs/send-request.d.ts +2 -1
  33. package/dist/libs/send-request.d.ts.map +1 -1
  34. package/dist/libs/send-request.js +98 -97
  35. package/dist/router.d.ts +5 -5
  36. package/dist/router.d.ts.map +1 -1
  37. package/dist/router.js +32 -32
  38. package/dist/store/collections.d.ts +14 -4
  39. package/dist/store/collections.d.ts.map +1 -1
  40. package/dist/store/events.d.ts +1 -1
  41. package/dist/store/import-spec.d.ts +16 -31
  42. package/dist/store/import-spec.d.ts.map +1 -1
  43. package/dist/store/import-spec.js +43 -56
  44. package/dist/store/requests.d.ts +14 -14
  45. package/dist/store/store.d.ts +514 -90
  46. package/dist/store/store.d.ts.map +1 -1
  47. package/dist/store/store.js +43 -43
  48. package/dist/store/workspace.d.ts +10 -10
  49. package/dist/store/workspace.d.ts.map +1 -1
  50. package/dist/style.css +1 -1
  51. package/dist/views/Cookies/Cookies.vue.d.ts +5 -1
  52. package/dist/views/Cookies/Cookies.vue.d.ts.map +1 -1
  53. package/dist/views/Cookies/Cookies.vue2.js +64 -55
  54. package/dist/views/Environment/Environment.vue.d.ts +5 -1
  55. package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
  56. package/dist/views/Environment/Environment.vue2.js +75 -66
  57. package/dist/views/Request/Request.vue.d.ts.map +1 -1
  58. package/dist/views/Request/Request.vue.js +1 -1
  59. package/dist/views/Request/Request.vue2.js +98 -91
  60. package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts +2 -0
  61. package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts.map +1 -1
  62. package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.js +2 -2
  63. package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue2.js +104 -111
  64. package/dist/views/Request/RequestSection/RequestAuth/RequestExampleAuth.vue.d.ts +5 -1
  65. package/dist/views/Request/RequestSection/RequestAuth/RequestExampleAuth.vue.d.ts.map +1 -1
  66. package/dist/views/Request/RequestSection/RequestAuth/RequestExampleAuth.vue.js +37 -34
  67. package/dist/views/Request/RequestSection/RequestSection.vue.d.ts +5 -1
  68. package/dist/views/Request/RequestSection/RequestSection.vue.d.ts.map +1 -1
  69. package/dist/views/Request/RequestSection/RequestSection.vue.js +43 -37
  70. package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
  71. package/dist/views/Request/RequestSidebar.vue.js +4 -4
  72. package/dist/views/Request/RequestSidebar.vue2.js +43 -42
  73. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.d.ts.map +1 -1
  74. package/dist/views/Request/ResponseSection/ResponseEmpty.vue.js +1 -1
  75. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +27 -26
  76. package/dist/views/Settings/SettingsGeneral.vue.js +3 -3
  77. package/dist/views/Settings/SettingsGeneralMode.vue.js +3 -3
  78. package/package.json +9 -9
@@ -35,7 +35,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
35
35
  hotKeyConfig?: {
36
36
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
37
37
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
38
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
38
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
39
39
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
40
40
  }>> | undefined;
41
41
  } | undefined;
@@ -49,6 +49,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
49
49
  security: Record<string, string[]>[];
50
50
  'x-scalar-icon': string;
51
51
  securitySchemes: string[];
52
+ selectedSecuritySchemeUids: string[];
52
53
  selectedServerUid: string;
53
54
  servers: string[];
54
55
  requests: string[];
@@ -246,11 +247,11 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
246
247
  path: string;
247
248
  type: "request";
248
249
  uid: string;
250
+ selectedSecuritySchemeUids: string[];
249
251
  selectedServerUid: string;
250
252
  servers: string[];
251
253
  examples: string[];
252
254
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
253
- selectedSecuritySchemeUids: string[];
254
255
  description?: string | undefined;
255
256
  summary?: string | undefined;
256
257
  externalDocs?: {
@@ -345,6 +346,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
345
346
  security: Record<string, string[]>[];
346
347
  'x-scalar-icon': string;
347
348
  securitySchemes: string[];
349
+ selectedSecuritySchemeUids: string[];
348
350
  selectedServerUid: string;
349
351
  servers: string[];
350
352
  requests: string[];
@@ -509,11 +511,11 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
509
511
  path: string;
510
512
  type: "request";
511
513
  uid: string;
514
+ selectedSecuritySchemeUids: string[];
512
515
  selectedServerUid: string;
513
516
  servers: string[];
514
517
  examples: string[];
515
518
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
516
- selectedSecuritySchemeUids: string[];
517
519
  description?: string | undefined;
518
520
  summary?: string | undefined;
519
521
  externalDocs?: {
@@ -576,7 +578,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
576
578
  hotKeyConfig?: {
577
579
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
578
580
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
579
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
581
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
580
582
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
581
583
  }>> | undefined;
582
584
  } | undefined;
@@ -590,6 +592,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
590
592
  security: Record<string, string[]>[];
591
593
  'x-scalar-icon': string;
592
594
  securitySchemes: string[];
595
+ selectedSecuritySchemeUids: string[];
593
596
  selectedServerUid: string;
594
597
  servers: string[];
595
598
  requests: string[];
@@ -674,18 +677,84 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
674
677
  cancelRequest: import("../../libs/index.js").EventBus<any>;
675
678
  requestStatus: import("../../libs/index.js").EventBus<import("../../libs/index.js").RequestStatus>;
676
679
  commandPalette: import("../../libs/index.js").EventBus<import("../../components/CommandPalette/TheCommandPalette.vue.js").CommandPaletteEvent>;
677
- hotKeys: import("../../libs/index.js").EventBus<Partial<Record<"closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch", KeyboardEvent>>>;
680
+ hotKeys: import("../../libs/index.js").EventBus<Partial<Record<"closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch", KeyboardEvent>>>;
678
681
  };
679
682
  sidebarWidth: import("vue").Ref<string, string>;
680
683
  setSidebarWidth: (width: string) => void;
681
684
  proxyUrl: import("vue").Ref<string | undefined, string | undefined>;
682
685
  setProxyUrl: (url: string) => void;
683
686
  defaultProxyUrl: string | undefined;
684
- importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
685
- documentUrl?: string;
686
- watchForChanges?: boolean;
687
+ importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, { overloadServers, ...options }?: Pick<{
688
+ type?: "collection" | undefined;
689
+ uid?: string | undefined;
690
+ externalDocs?: {
691
+ description?: string | undefined;
692
+ url?: string | undefined;
693
+ } | undefined;
694
+ children?: (string | undefined)[] | undefined;
695
+ openapi?: string | undefined;
696
+ jsonSchemaDialect?: string | undefined;
697
+ info?: {
698
+ description?: string | undefined;
699
+ title?: string | undefined;
700
+ summary?: string | undefined;
701
+ termsOfService?: string | undefined;
702
+ contact?: {
703
+ name?: string | undefined;
704
+ url?: string | undefined;
705
+ email?: string | undefined;
706
+ } | undefined;
707
+ license?: {
708
+ name?: string | undefined;
709
+ identifier?: string | undefined;
710
+ url?: string | undefined;
711
+ } | undefined;
712
+ version?: string | undefined;
713
+ } | undefined;
714
+ security?: Record<string, string[] | undefined>[] | undefined;
715
+ components?: Record<string, unknown> | undefined;
716
+ webhooks?: Record<string, unknown> | undefined;
717
+ 'x-scalar-icon'?: string | undefined;
718
+ securitySchemes?: string[] | undefined;
719
+ selectedSecuritySchemeUids?: (string | undefined)[] | undefined;
720
+ selectedServerUid?: string | undefined;
721
+ servers?: (string | undefined)[] | undefined;
722
+ requests?: (string | undefined)[] | undefined;
723
+ tags?: (string | undefined)[] | undefined;
724
+ auth?: Record<string | undefined, {
725
+ type?: "apiKey" | undefined;
726
+ value?: string | undefined;
727
+ name?: string | undefined;
728
+ } | {
729
+ type?: "http" | undefined;
730
+ username?: string | undefined;
731
+ password?: string | undefined;
732
+ token?: string | undefined;
733
+ } | {
734
+ type?: "oauth-implicit" | undefined;
735
+ token?: string | undefined;
736
+ } | {
737
+ type?: "oauth-password" | undefined;
738
+ username?: string | undefined;
739
+ password?: string | undefined;
740
+ token?: string | undefined;
741
+ clientSecret?: string | undefined;
742
+ } | {
743
+ type?: "oauth-clientCredentials" | undefined;
744
+ token?: string | undefined;
745
+ clientSecret?: string | undefined;
746
+ } | {
747
+ type?: "oauth-authorizationCode" | undefined;
748
+ token?: string | undefined;
749
+ clientSecret?: string | undefined;
750
+ }> | undefined;
751
+ documentUrl?: string | undefined;
752
+ watchForChanges?: boolean | undefined;
753
+ watchForChangesStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
754
+ }, "documentUrl" | "watchForChanges"> & Pick<import("@scalar/types/legacy").ReferenceConfiguration, "authentication"> & {
755
+ setCollectionSecurity?: boolean;
756
+ } & {
687
757
  overloadServers?: import("@scalar/types/legacy").Spec["servers"];
688
- preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
689
758
  }) => Promise<{
690
759
  type: "collection";
691
760
  uid: string;
@@ -694,6 +763,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
694
763
  security: Record<string, string[]>[];
695
764
  'x-scalar-icon': string;
696
765
  securitySchemes: string[];
766
+ selectedSecuritySchemeUids: string[];
697
767
  selectedServerUid: string;
698
768
  servers: string[];
699
769
  requests: string[];
@@ -753,16 +823,148 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
753
823
  webhooks?: Record<string, unknown> | undefined;
754
824
  documentUrl?: string | undefined;
755
825
  } | undefined>;
756
- importSpecFromUrl: (url: string, workspaceUid: string, { proxy, overloadServers, watchForChanges, preferredSecurityScheme, }?: {
757
- watchForChanges?: boolean;
826
+ importSpecFromUrl: (url: string, workspaceUid: string, { proxy, ...options }?: Omit<Pick<{
827
+ type?: "collection" | undefined;
828
+ uid?: string | undefined;
829
+ externalDocs?: {
830
+ description?: string | undefined;
831
+ url?: string | undefined;
832
+ } | undefined;
833
+ children?: (string | undefined)[] | undefined;
834
+ openapi?: string | undefined;
835
+ jsonSchemaDialect?: string | undefined;
836
+ info?: {
837
+ description?: string | undefined;
838
+ title?: string | undefined;
839
+ summary?: string | undefined;
840
+ termsOfService?: string | undefined;
841
+ contact?: {
842
+ name?: string | undefined;
843
+ url?: string | undefined;
844
+ email?: string | undefined;
845
+ } | undefined;
846
+ license?: {
847
+ name?: string | undefined;
848
+ identifier?: string | undefined;
849
+ url?: string | undefined;
850
+ } | undefined;
851
+ version?: string | undefined;
852
+ } | undefined;
853
+ security?: Record<string, string[] | undefined>[] | undefined;
854
+ components?: Record<string, unknown> | undefined;
855
+ webhooks?: Record<string, unknown> | undefined;
856
+ 'x-scalar-icon'?: string | undefined;
857
+ securitySchemes?: string[] | undefined;
858
+ selectedSecuritySchemeUids?: (string | undefined)[] | undefined;
859
+ selectedServerUid?: string | undefined;
860
+ servers?: (string | undefined)[] | undefined;
861
+ requests?: (string | undefined)[] | undefined;
862
+ tags?: (string | undefined)[] | undefined;
863
+ auth?: Record<string | undefined, {
864
+ type?: "apiKey" | undefined;
865
+ value?: string | undefined;
866
+ name?: string | undefined;
867
+ } | {
868
+ type?: "http" | undefined;
869
+ username?: string | undefined;
870
+ password?: string | undefined;
871
+ token?: string | undefined;
872
+ } | {
873
+ type?: "oauth-implicit" | undefined;
874
+ token?: string | undefined;
875
+ } | {
876
+ type?: "oauth-password" | undefined;
877
+ username?: string | undefined;
878
+ password?: string | undefined;
879
+ token?: string | undefined;
880
+ clientSecret?: string | undefined;
881
+ } | {
882
+ type?: "oauth-clientCredentials" | undefined;
883
+ token?: string | undefined;
884
+ clientSecret?: string | undefined;
885
+ } | {
886
+ type?: "oauth-authorizationCode" | undefined;
887
+ token?: string | undefined;
888
+ clientSecret?: string | undefined;
889
+ }> | undefined;
890
+ documentUrl?: string | undefined;
891
+ watchForChanges?: boolean | undefined;
892
+ watchForChangesStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
893
+ }, "documentUrl" | "watchForChanges"> & Pick<import("@scalar/types/legacy").ReferenceConfiguration, "authentication"> & {
894
+ setCollectionSecurity?: boolean;
895
+ } & {
758
896
  overloadServers?: import("@scalar/types/legacy").Spec["servers"];
759
- preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
760
- proxy?: string;
761
- }) => Promise<import("../../libs/index.js").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
762
- documentUrl?: string;
763
- watchForChanges?: boolean;
897
+ }, "documentUrl"> & Pick<import("@scalar/types/legacy").ReferenceConfiguration, "proxy">) => Promise<import("../../libs/index.js").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, { overloadServers, ...options }?: Pick<{
898
+ type?: "collection" | undefined;
899
+ uid?: string | undefined;
900
+ externalDocs?: {
901
+ description?: string | undefined;
902
+ url?: string | undefined;
903
+ } | undefined;
904
+ children?: (string | undefined)[] | undefined;
905
+ openapi?: string | undefined;
906
+ jsonSchemaDialect?: string | undefined;
907
+ info?: {
908
+ description?: string | undefined;
909
+ title?: string | undefined;
910
+ summary?: string | undefined;
911
+ termsOfService?: string | undefined;
912
+ contact?: {
913
+ name?: string | undefined;
914
+ url?: string | undefined;
915
+ email?: string | undefined;
916
+ } | undefined;
917
+ license?: {
918
+ name?: string | undefined;
919
+ identifier?: string | undefined;
920
+ url?: string | undefined;
921
+ } | undefined;
922
+ version?: string | undefined;
923
+ } | undefined;
924
+ security?: Record<string, string[] | undefined>[] | undefined;
925
+ components?: Record<string, unknown> | undefined;
926
+ webhooks?: Record<string, unknown> | undefined;
927
+ 'x-scalar-icon'?: string | undefined;
928
+ securitySchemes?: string[] | undefined;
929
+ selectedSecuritySchemeUids?: (string | undefined)[] | undefined;
930
+ selectedServerUid?: string | undefined;
931
+ servers?: (string | undefined)[] | undefined;
932
+ requests?: (string | undefined)[] | undefined;
933
+ tags?: (string | undefined)[] | undefined;
934
+ auth?: Record<string | undefined, {
935
+ type?: "apiKey" | undefined;
936
+ value?: string | undefined;
937
+ name?: string | undefined;
938
+ } | {
939
+ type?: "http" | undefined;
940
+ username?: string | undefined;
941
+ password?: string | undefined;
942
+ token?: string | undefined;
943
+ } | {
944
+ type?: "oauth-implicit" | undefined;
945
+ token?: string | undefined;
946
+ } | {
947
+ type?: "oauth-password" | undefined;
948
+ username?: string | undefined;
949
+ password?: string | undefined;
950
+ token?: string | undefined;
951
+ clientSecret?: string | undefined;
952
+ } | {
953
+ type?: "oauth-clientCredentials" | undefined;
954
+ token?: string | undefined;
955
+ clientSecret?: string | undefined;
956
+ } | {
957
+ type?: "oauth-authorizationCode" | undefined;
958
+ token?: string | undefined;
959
+ clientSecret?: string | undefined;
960
+ }> | undefined;
961
+ documentUrl?: string | undefined;
962
+ watchForChanges?: boolean | undefined;
963
+ watchForChangesStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
964
+ }, "documentUrl" | "watchForChanges"> & Pick<import("@scalar/types/legacy").ReferenceConfiguration, "authentication"> & {
965
+ setCollectionSecurity?: boolean;
966
+ } & {
764
967
  overloadServers?: import("@scalar/types/legacy").Spec["servers"];
765
- preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
766
968
  }) => Promise<{
767
969
  type: "collection";
768
970
  uid: string;
@@ -771,6 +973,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
771
973
  security: Record<string, string[]>[];
772
974
  'x-scalar-icon': string;
773
975
  securitySchemes: string[];
976
+ selectedSecuritySchemeUids: string[];
774
977
  selectedServerUid: string;
775
978
  servers: string[];
776
979
  requests: string[];
@@ -944,6 +1147,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
944
1147
  security: Record<string, string[]>[];
945
1148
  'x-scalar-icon': string;
946
1149
  securitySchemes: string[];
1150
+ selectedSecuritySchemeUids: string[];
947
1151
  selectedServerUid: string;
948
1152
  servers: string[];
949
1153
  requests: string[];
@@ -1011,6 +1215,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1011
1215
  security: Record<string, string[]>[];
1012
1216
  'x-scalar-icon': string;
1013
1217
  securitySchemes: string[];
1218
+ selectedSecuritySchemeUids: string[];
1014
1219
  selectedServerUid: string;
1015
1220
  servers: string[];
1016
1221
  requests: string[];
@@ -1070,7 +1275,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1070
1275
  webhooks?: Record<string, unknown> | undefined;
1071
1276
  documentUrl?: string | undefined;
1072
1277
  };
1073
- delete: (collection: import("@scalar/oas-utils/entities/spec").Collection, workspace: import("@scalar/oas-utils/entities/workspace").Workspace) => void;
1278
+ delete: (collection: import("@scalar/oas-utils/entities/spec").Collection, workspace: import("@scalar/oas-utils/entities").Workspace) => void;
1074
1279
  set: (item: {
1075
1280
  type: "collection";
1076
1281
  uid: string;
@@ -1079,6 +1284,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1079
1284
  security: Record<string, string[]>[];
1080
1285
  'x-scalar-icon': string;
1081
1286
  securitySchemes: string[];
1287
+ selectedSecuritySchemeUids: string[];
1082
1288
  selectedServerUid: string;
1083
1289
  servers: string[];
1084
1290
  requests: string[];
@@ -1138,7 +1344,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1138
1344
  webhooks?: Record<string, unknown> | undefined;
1139
1345
  documentUrl?: string | undefined;
1140
1346
  }) => void;
1141
- 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" ? {
1347
+ edit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "selectedSecuritySchemeUids" | "tags" | "requests" | "documentUrl" | "watchForChanges" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | `servers.${number}` | `selectedSecuritySchemeUids.${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" | "selectedSecuritySchemeUids" | "tags" | "requests" | "documentUrl" | "watchForChanges" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? {
1142
1348
  type: "collection";
1143
1349
  uid: string;
1144
1350
  children: string[];
@@ -1146,6 +1352,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1146
1352
  security: Record<string, string[]>[];
1147
1353
  'x-scalar-icon': string;
1148
1354
  securitySchemes: string[];
1355
+ selectedSecuritySchemeUids: string[];
1149
1356
  selectedServerUid: string;
1150
1357
  servers: string[];
1151
1358
  requests: string[];
@@ -1204,7 +1411,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1204
1411
  components?: Record<string, unknown> | undefined;
1205
1412
  webhooks?: Record<string, unknown> | undefined;
1206
1413
  documentUrl?: string | undefined;
1207
- }[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<{
1414
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "selectedSecuritySchemeUids" | "tags" | "requests" | "documentUrl" | "watchForChanges" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? R extends import("@scalar/object-utils/nested").Path<{
1208
1415
  type: "collection";
1209
1416
  uid: string;
1210
1417
  children: string[];
@@ -1212,6 +1419,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1212
1419
  security: Record<string, string[]>[];
1213
1420
  'x-scalar-icon': string;
1214
1421
  securitySchemes: string[];
1422
+ selectedSecuritySchemeUids: string[];
1215
1423
  selectedServerUid: string;
1216
1424
  servers: string[];
1217
1425
  requests: string[];
@@ -1278,6 +1486,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1278
1486
  security: Record<string, string[]>[];
1279
1487
  'x-scalar-icon': string;
1280
1488
  securitySchemes: string[];
1489
+ selectedSecuritySchemeUids: string[];
1281
1490
  selectedServerUid: string;
1282
1491
  servers: string[];
1283
1492
  requests: string[];
@@ -1337,7 +1546,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1337
1546
  webhooks?: Record<string, unknown> | undefined;
1338
1547
  documentUrl?: string | undefined;
1339
1548
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1340
- 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" ? {
1549
+ untrackedEdit: <P extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "selectedSecuritySchemeUids" | "tags" | "requests" | "documentUrl" | "watchForChanges" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | `servers.${number}` | `selectedSecuritySchemeUids.${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" | "selectedSecuritySchemeUids" | "tags" | "requests" | "documentUrl" | "watchForChanges" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? {
1341
1550
  type: "collection";
1342
1551
  uid: string;
1343
1552
  children: string[];
@@ -1345,6 +1554,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1345
1554
  security: Record<string, string[]>[];
1346
1555
  'x-scalar-icon': string;
1347
1556
  securitySchemes: string[];
1557
+ selectedSecuritySchemeUids: string[];
1348
1558
  selectedServerUid: string;
1349
1559
  servers: string[];
1350
1560
  requests: string[];
@@ -1403,7 +1613,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1403
1613
  components?: Record<string, unknown> | undefined;
1404
1614
  webhooks?: Record<string, unknown> | undefined;
1405
1615
  documentUrl?: string | undefined;
1406
- }[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<{
1616
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "selectedSecuritySchemeUids" | "tags" | "requests" | "documentUrl" | "watchForChanges" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" | "watchForChangesStatus" ? R extends import("@scalar/object-utils/nested").Path<{
1407
1617
  type: "collection";
1408
1618
  uid: string;
1409
1619
  children: string[];
@@ -1411,6 +1621,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1411
1621
  security: Record<string, string[]>[];
1412
1622
  'x-scalar-icon': string;
1413
1623
  securitySchemes: string[];
1624
+ selectedSecuritySchemeUids: string[];
1414
1625
  selectedServerUid: string;
1415
1626
  servers: string[];
1416
1627
  requests: string[];
@@ -1477,6 +1688,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1477
1688
  security: Record<string, string[]>[];
1478
1689
  'x-scalar-icon': string;
1479
1690
  securitySchemes: string[];
1691
+ selectedSecuritySchemeUids: string[];
1480
1692
  selectedServerUid: string;
1481
1693
  servers: string[];
1482
1694
  requests: string[];
@@ -1601,11 +1813,11 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1601
1813
  path: string;
1602
1814
  type: "request";
1603
1815
  uid: string;
1816
+ selectedSecuritySchemeUids: string[];
1604
1817
  selectedServerUid: string;
1605
1818
  servers: string[];
1606
1819
  examples: string[];
1607
1820
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1608
- selectedSecuritySchemeUids: string[];
1609
1821
  description?: string | undefined;
1610
1822
  summary?: string | undefined;
1611
1823
  externalDocs?: {
@@ -1633,11 +1845,11 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1633
1845
  path: string;
1634
1846
  type: "request";
1635
1847
  uid: string;
1848
+ selectedSecuritySchemeUids: string[];
1636
1849
  selectedServerUid: string;
1637
1850
  servers: string[];
1638
1851
  examples: string[];
1639
1852
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1640
- selectedSecuritySchemeUids: string[];
1641
1853
  description?: string | undefined;
1642
1854
  summary?: string | undefined;
1643
1855
  externalDocs?: {
@@ -1666,11 +1878,11 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1666
1878
  path: string;
1667
1879
  type: "request";
1668
1880
  uid: string;
1881
+ selectedSecuritySchemeUids: string[];
1669
1882
  selectedServerUid: string;
1670
1883
  servers: string[];
1671
1884
  examples: string[];
1672
1885
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1673
- selectedSecuritySchemeUids: string[];
1674
1886
  description?: string | undefined;
1675
1887
  summary?: string | undefined;
1676
1888
  externalDocs?: {
@@ -1694,15 +1906,15 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1694
1906
  requestBody?: any;
1695
1907
  responses?: Record<string, any> | undefined;
1696
1908
  }) => void;
1697
- edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "selectedSecuritySchemeUids" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "selectedSecuritySchemeUids" | "operationId" | "requestBody" | "responses" ? {
1909
+ edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
1698
1910
  path: string;
1699
1911
  type: "request";
1700
1912
  uid: string;
1913
+ selectedSecuritySchemeUids: string[];
1701
1914
  selectedServerUid: string;
1702
1915
  servers: string[];
1703
1916
  examples: string[];
1704
1917
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1705
- selectedSecuritySchemeUids: string[];
1706
1918
  description?: string | undefined;
1707
1919
  summary?: string | undefined;
1708
1920
  externalDocs?: {
@@ -1725,15 +1937,15 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1725
1937
  }[] | undefined;
1726
1938
  requestBody?: any;
1727
1939
  responses?: Record<string, any> | undefined;
1728
- }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "selectedSecuritySchemeUids" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
1940
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
1729
1941
  path: string;
1730
1942
  type: "request";
1731
1943
  uid: string;
1944
+ selectedSecuritySchemeUids: string[];
1732
1945
  selectedServerUid: string;
1733
1946
  servers: string[];
1734
1947
  examples: string[];
1735
1948
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1736
- selectedSecuritySchemeUids: string[];
1737
1949
  description?: string | undefined;
1738
1950
  summary?: string | undefined;
1739
1951
  externalDocs?: {
@@ -1760,11 +1972,11 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1760
1972
  path: string;
1761
1973
  type: "request";
1762
1974
  uid: string;
1975
+ selectedSecuritySchemeUids: string[];
1763
1976
  selectedServerUid: string;
1764
1977
  servers: string[];
1765
1978
  examples: string[];
1766
1979
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1767
- selectedSecuritySchemeUids: string[];
1768
1980
  description?: string | undefined;
1769
1981
  summary?: string | undefined;
1770
1982
  externalDocs?: {
@@ -1788,15 +2000,15 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1788
2000
  requestBody?: any;
1789
2001
  responses?: Record<string, any> | undefined;
1790
2002
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1791
- untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "selectedSecuritySchemeUids" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "selectedSecuritySchemeUids" | "operationId" | "requestBody" | "responses" ? {
2003
+ untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
1792
2004
  path: string;
1793
2005
  type: "request";
1794
2006
  uid: string;
2007
+ selectedSecuritySchemeUids: string[];
1795
2008
  selectedServerUid: string;
1796
2009
  servers: string[];
1797
2010
  examples: string[];
1798
2011
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1799
- selectedSecuritySchemeUids: string[];
1800
2012
  description?: string | undefined;
1801
2013
  summary?: string | undefined;
1802
2014
  externalDocs?: {
@@ -1819,15 +2031,15 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1819
2031
  }[] | undefined;
1820
2032
  requestBody?: any;
1821
2033
  responses?: Record<string, any> | undefined;
1822
- }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "selectedSecuritySchemeUids" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
2034
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
1823
2035
  path: string;
1824
2036
  type: "request";
1825
2037
  uid: string;
2038
+ selectedSecuritySchemeUids: string[];
1826
2039
  selectedServerUid: string;
1827
2040
  servers: string[];
1828
2041
  examples: string[];
1829
2042
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1830
- selectedSecuritySchemeUids: string[];
1831
2043
  description?: string | undefined;
1832
2044
  summary?: string | undefined;
1833
2045
  externalDocs?: {
@@ -1854,11 +2066,11 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
1854
2066
  path: string;
1855
2067
  type: "request";
1856
2068
  uid: string;
2069
+ selectedSecuritySchemeUids: string[];
1857
2070
  selectedServerUid: string;
1858
2071
  servers: string[];
1859
2072
  examples: string[];
1860
2073
  method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
1861
- selectedSecuritySchemeUids: string[];
1862
2074
  description?: string | undefined;
1863
2075
  summary?: string | undefined;
1864
2076
  externalDocs?: {
@@ -3498,13 +3710,13 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3498
3710
  hotKeyConfig?: {
3499
3711
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3500
3712
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3501
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3713
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3502
3714
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3503
3715
  }>> | undefined;
3504
3716
  } | undefined;
3505
3717
  proxyUrl?: string | undefined;
3506
3718
  }) => void;
3507
- add: (payload?: Partial<import("@scalar/oas-utils/entities/workspace").Workspace>) => {
3719
+ add: (payload?: Partial<import("@scalar/oas-utils/entities").Workspace>) => {
3508
3720
  uid: string;
3509
3721
  name: string;
3510
3722
  description: string;
@@ -3517,7 +3729,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3517
3729
  hotKeyConfig?: {
3518
3730
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3519
3731
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3520
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3732
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3521
3733
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3522
3734
  }>> | undefined;
3523
3735
  } | undefined;
@@ -3537,7 +3749,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3537
3749
  hotKeyConfig?: {
3538
3750
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3539
3751
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3540
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3752
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3541
3753
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3542
3754
  }>> | undefined;
3543
3755
  } | undefined;
@@ -3556,7 +3768,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3556
3768
  hotKeyConfig?: {
3557
3769
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3558
3770
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3559
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3771
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3560
3772
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3561
3773
  }>> | undefined;
3562
3774
  } | undefined;
@@ -3574,7 +3786,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3574
3786
  hotKeyConfig?: {
3575
3787
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3576
3788
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3577
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3789
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3578
3790
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3579
3791
  }>> | undefined;
3580
3792
  } | undefined;
@@ -3592,7 +3804,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3592
3804
  hotKeyConfig?: {
3593
3805
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3594
3806
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3595
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3807
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3596
3808
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3597
3809
  }>> | undefined;
3598
3810
  } | undefined;
@@ -3611,7 +3823,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3611
3823
  hotKeyConfig?: {
3612
3824
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3613
3825
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3614
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3826
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3615
3827
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3616
3828
  }>> | undefined;
3617
3829
  } | undefined;
@@ -3629,7 +3841,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3629
3841
  hotKeyConfig?: {
3630
3842
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3631
3843
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3632
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3844
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3633
3845
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3634
3846
  }>> | undefined;
3635
3847
  } | undefined;
@@ -3647,7 +3859,7 @@ export declare const createApiClientApp: (el: HTMLElement | null, configuration?
3647
3859
  hotKeyConfig?: {
3648
3860
  modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3649
3861
  hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3650
- event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "openCommandPaletteRequest" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3862
+ event: "closeModal" | "navigateSearchResultsDown" | "selectSearchResult" | "navigateSearchResultsUp" | "openCommandPalette" | "createNew" | "toggleSidebar" | "addTopNav" | "closeTopNav" | "navigateTopNavLeft" | "navigateTopNavRight" | "focusAddressBar" | "jumpToTab" | "jumpToLastTab" | "focusRequestSearch";
3651
3863
  modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3652
3864
  }>> | undefined;
3653
3865
  } | undefined;