@scalar/api-client 2.1.26 → 2.1.28

package/dist/layouts/Modal/create-api-client-modal.d.ts

@@ -82,6 +82,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -106,6 +108,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }>;
         tags: Record<string, {
             type: "tag";
@@ -275,8 +278,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
         }>;
         servers: Record<string, {
             uid: string;
+            url: string;
             description?: string | undefined;
-            url?: string | undefined;
             variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                 enum?: [string, ...string[]];
             }> | undefined;
@@ -375,6 +378,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -399,6 +404,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         } | undefined>;
         activeCookieId: import("vue").ComputedRef<string | undefined>;
         activeExample: import("vue").ComputedRef<{
@@ -553,8 +559,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
         }>;
         activeServer: import("vue").ComputedRef<{
             uid: string;
+            url: string;
             description?: string | undefined;
-            url?: string | undefined;
             variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                 enum?: [string, ...string[]];
             }> | undefined;
@@ -617,6 +623,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -641,11 +649,12 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }[]>;
         activeWorkspaceServers: import("vue").ComputedRef<{
             uid: string;
+            url: string;
             description?: string | undefined;
-            url?: string | undefined;
             variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                 enum?: [string, ...string[]];
             }> | undefined;
@@ -673,7 +682,12 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
         setSidebarWidth: (width: string) => void;
         proxyUrl: import("vue").Ref<string, string>;
         setProxyUrl: (url: string) => void;
-        importSpecFile: (_spec: string | Record<string, any>, workspaceUid?: string, overloadServers?: import("@scalar/types/legacy").Spec["servers"], preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"]) => Promise<{
+        importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
+            documentUrl?: string;
+            watchForChanges?: boolean;
+            overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+            preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
+        }) => Promise<{
             type: "collection";
             uid: string;
             children: string[];
@@ -712,6 +726,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -736,8 +752,19 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         } | undefined>;
-        importSpecFromUrl: (url: string, proxy?: string, overloadServers?: import("@scalar/types/legacy").Spec["servers"], preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"], workspaceUid?: string) => Promise<{
+        importSpecFromUrl: (url: string, workspaceUid: string, { proxy, overloadServers, watchForChanges, preferredSecurityScheme, }?: {
+            watchForChanges?: boolean;
+            overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+            preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
+            proxy?: string;
+        }) => Promise<import("../../libs/index.js").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
+            documentUrl?: string;
+            watchForChanges?: boolean;
+            overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+            preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
+        }) => Promise<{
             type: "collection";
             uid: string;
             children: string[];
@@ -776,6 +803,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -800,7 +829,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
-        } | undefined>;
+            documentUrl?: string | undefined;
+        } | undefined>>>>>;
         cookieMutators: {
             add: (item: {
                 value: string;
@@ -946,6 +976,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -970,6 +1002,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }) => void;
             add: (payload: import("@scalar/oas-utils/entities/spec").CollectionPayload, workspaceUid: string) => {
                 type: "collection";
@@ -1010,6 +1043,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1034,6 +1069,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             };
             delete: (collection: import("@scalar/oas-utils/entities/spec").Collection, workspace: import("@scalar/oas-utils/entities/workspace").Workspace) => void;
             set: (item: {
@@ -1075,6 +1111,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1099,8 +1137,9 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }) => void;
-            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" ? {
+            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" ? {
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -1139,6 +1178,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1163,7 +1204,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? R extends import("@scalar/object-utils/nested").Path<{
+                documentUrl?: string | undefined;
+            }[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<{
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -1202,6 +1244,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1226,6 +1270,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 type: "collection";
                 uid: string;
@@ -1265,6 +1310,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1289,8 +1336,9 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-            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" ? {
+            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" ? {
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -1329,6 +1377,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1353,7 +1403,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? R extends import("@scalar/object-utils/nested").Path<{
+                documentUrl?: string | undefined;
+            }[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<{
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -1392,6 +1443,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1416,6 +1469,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 type: "collection";
                 uid: string;
@@ -1455,6 +1509,8 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -1479,6 +1535,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
@@ -2843,7 +2900,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 'x-scalar-client-id': string;
                 description?: string | undefined;
             };
-            delete: (scheme: import("@scalar/oas-utils/entities/spec").SecurityScheme) => void;
+            delete: (schemeUid: string) => void;
             set: (item: {
                 type: "apiKey";
                 uid: string;
@@ -3231,16 +3288,16 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
         serverMutators: {
             rawAdd: (item: {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }) => void;
             add: (payload: import("@scalar/oas-utils/entities/spec").ServerPayload, parentUid: string) => {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
@@ -3248,52 +3305,52 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             delete: (serverUid: string, collectionUid: string) => void;
             set: (item: {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }) => void;
             edit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             untrackedEdit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
@@ -3685,6 +3742,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -3709,6 +3768,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }>;
         tags: Record<string, {
             type: "tag";
@@ -3878,8 +3938,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
         }>;
         servers: Record<string, {
             uid: string;
+            url: string;
             description?: string | undefined;
-            url?: string | undefined;
             variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                 enum?: [string, ...string[]];
             }> | undefined;
@@ -3978,6 +4038,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4002,6 +4064,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         } | undefined>;
         activeCookieId: import("vue").ComputedRef<string | undefined>;
         activeExample: import("vue").ComputedRef<{
@@ -4156,8 +4219,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
         }>;
         activeServer: import("vue").ComputedRef<{
             uid: string;
+            url: string;
             description?: string | undefined;
-            url?: string | undefined;
             variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                 enum?: [string, ...string[]];
             }> | undefined;
@@ -4220,6 +4283,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4244,11 +4309,12 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }[]>;
         activeWorkspaceServers: import("vue").ComputedRef<{
             uid: string;
+            url: string;
             description?: string | undefined;
-            url?: string | undefined;
             variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                 enum?: [string, ...string[]];
             }> | undefined;
@@ -4276,7 +4342,12 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
         setSidebarWidth: (width: string) => void;
         proxyUrl: import("vue").Ref<string, string>;
         setProxyUrl: (url: string) => void;
-        importSpecFile: (_spec: string | Record<string, any>, workspaceUid?: string, overloadServers?: import("@scalar/types/legacy").Spec["servers"], preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"]) => Promise<{
+        importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
+            documentUrl?: string;
+            watchForChanges?: boolean;
+            overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+            preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
+        }) => Promise<{
             type: "collection";
             uid: string;
             children: string[];
@@ -4315,6 +4386,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4339,8 +4412,19 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         } | undefined>;
-        importSpecFromUrl: (url: string, proxy?: string, overloadServers?: import("@scalar/types/legacy").Spec["servers"], preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"], workspaceUid?: string) => Promise<{
+        importSpecFromUrl: (url: string, workspaceUid: string, { proxy, overloadServers, watchForChanges, preferredSecurityScheme, }?: {
+            watchForChanges?: boolean;
+            overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+            preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
+            proxy?: string;
+        }) => Promise<import("../../libs/index.js").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, { documentUrl, watchForChanges, overloadServers, preferredSecurityScheme, }?: {
+            documentUrl?: string;
+            watchForChanges?: boolean;
+            overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+            preferredSecurityScheme?: ClientConfiguration["preferredSecurityScheme"];
+        }) => Promise<{
             type: "collection";
             uid: string;
             children: string[];
@@ -4379,6 +4463,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4403,7 +4489,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
-        } | undefined>;
+            documentUrl?: string | undefined;
+        } | undefined>>>>>;
         cookieMutators: {
             add: (item: {
                 value: string;
@@ -4549,6 +4636,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -4573,6 +4662,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }) => void;
             add: (payload: import("@scalar/oas-utils/entities/spec").CollectionPayload, workspaceUid: string) => {
                 type: "collection";
@@ -4613,6 +4703,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -4637,6 +4729,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             };
             delete: (collection: import("@scalar/oas-utils/entities/spec").Collection, workspace: import("@scalar/oas-utils/entities/workspace").Workspace) => void;
             set: (item: {
@@ -4678,6 +4771,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -4702,8 +4797,9 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }) => void;
-            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" ? {
+            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" ? {
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -4742,6 +4838,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -4766,7 +4864,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? R extends import("@scalar/object-utils/nested").Path<{
+                documentUrl?: string | undefined;
+            }[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<{
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -4805,6 +4904,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -4829,6 +4930,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 type: "collection";
                 uid: string;
@@ -4868,6 +4970,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -4892,8 +4996,9 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-            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" ? {
+            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" ? {
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -4932,6 +5037,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -4956,7 +5063,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "info" | "servers" | "uid" | "auth" | "securitySchemes" | "tags" | "requests" | "components" | "openapi" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "selectedServerUid" | "x-scalar-icon" ? R extends import("@scalar/object-utils/nested").Path<{
+                documentUrl?: string | undefined;
+            }[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<{
                 type: "collection";
                 uid: string;
                 children: string[];
@@ -4995,6 +5103,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -5019,6 +5129,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 type: "collection";
                 uid: string;
@@ -5058,6 +5169,8 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     token: string;
                     clientSecret: string;
                 }>;
+                watchForChanges: boolean;
+                watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
                 externalDocs?: {
                     url: string;
                     description?: string | undefined;
@@ -5082,6 +5195,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 } | undefined;
                 components?: Record<string, unknown> | undefined;
                 webhooks?: Record<string, unknown> | undefined;
+                documentUrl?: string | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
@@ -6446,7 +6560,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 'x-scalar-client-id': string;
                 description?: string | undefined;
             };
-            delete: (scheme: import("@scalar/oas-utils/entities/spec").SecurityScheme) => void;
+            delete: (schemeUid: string) => void;
             set: (item: {
                 type: "apiKey";
                 uid: string;
@@ -6834,16 +6948,16 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
         serverMutators: {
             rawAdd: (item: {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }) => void;
             add: (payload: import("@scalar/oas-utils/entities/spec").ServerPayload, parentUid: string) => {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
@@ -6851,52 +6965,52 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             delete: (serverUid: string, collectionUid: string) => void;
             set: (item: {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }) => void;
             edit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             untrackedEdit: <P extends "url" | "description" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "url" | "description" | "uid" | "variables" ? {
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[P] : P extends `${infer K}.${infer R}` ? K extends "url" | "description" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;
             }[K]> ? import("@scalar/object-utils/nested").PathValue<{
                 uid: string;
+                url: string;
                 description?: string | undefined;
-                url?: string | undefined;
                 variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
                     enum?: [string, ...string[]];
                 }> | undefined;