@scalar/api-client 2.1.26 → 2.1.27

package/dist/store/store.d.ts

@@ -70,6 +70,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -94,6 +96,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
         } | undefined;
         components?: Record<string, unknown> | undefined;
         webhooks?: Record<string, unknown> | undefined;
+        documentUrl?: string | undefined;
     }>;
     tags: Record<string, {
         type: "tag";
@@ -263,8 +266,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
     }>;
     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;
@@ -363,6 +366,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -387,6 +392,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
         } | 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<{
@@ -541,8 +547,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
     }>;
     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;
@@ -605,6 +611,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -629,11 +637,12 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
         } | 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;
@@ -661,7 +670,12 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
     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?: import("../libs/index.js").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?: import("../libs/index.js").ClientConfiguration["preferredSecurityScheme"];
+    }) => Promise<{
         type: "collection";
         uid: string;
         children: string[];
@@ -700,6 +714,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -724,8 +740,19 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
         } | 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?: import("../libs/index.js").ClientConfiguration["preferredSecurityScheme"], workspaceUid?: string) => Promise<{
+    importSpecFromUrl: (url: string, workspaceUid: string, { proxy, overloadServers, watchForChanges, preferredSecurityScheme, }?: {
+        watchForChanges?: boolean;
+        overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+        preferredSecurityScheme?: import("../libs/index.js").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?: import("../libs/index.js").ClientConfiguration["preferredSecurityScheme"];
+    }) => Promise<{
         type: "collection";
         uid: string;
         children: string[];
@@ -764,6 +791,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -788,7 +817,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
         } | undefined;
         components?: Record<string, unknown> | undefined;
         webhooks?: Record<string, unknown> | undefined;
-    } | undefined>;
+        documentUrl?: string | undefined;
+    } | undefined>>>>>;
     cookieMutators: {
         add: (item: {
             value: string;
@@ -934,6 +964,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -958,6 +990,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | 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";
@@ -998,6 +1031,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1022,6 +1057,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | 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: {
@@ -1063,6 +1099,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1087,8 +1125,9 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | 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[];
@@ -1127,6 +1166,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1151,7 +1192,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | 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 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 Path<{
             type: "collection";
             uid: string;
             children: string[];
@@ -1190,6 +1232,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1214,6 +1258,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }[K]> ? PathValue<{
             type: "collection";
             uid: string;
@@ -1253,6 +1298,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1277,8 +1324,9 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | 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[];
@@ -1317,6 +1365,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1341,7 +1391,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | 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 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 Path<{
             type: "collection";
             uid: string;
             children: string[];
@@ -1380,6 +1431,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1404,6 +1457,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }[K]> ? PathValue<{
             type: "collection";
             uid: string;
@@ -1443,6 +1497,8 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -1467,6 +1523,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             } | 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;
@@ -2831,7 +2888,7 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
             'x-scalar-client-id': string;
             description?: string | undefined;
         };
-        delete: (scheme: SecurityScheme) => void;
+        delete: (schemeUid: string) => void;
         set: (item: {
             type: "apiKey";
             uid: string;
@@ -3219,16 +3276,16 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
     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;
@@ -3236,52 +3293,52 @@ export declare const createWorkspaceStore: (router: Router, useLocalStorage?: bo
         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 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]> ? 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 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]> ? 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;
@@ -3656,6 +3713,8 @@ export declare const useWorkspace: () => {
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -3680,6 +3739,7 @@ export declare const useWorkspace: () => {
         } | undefined;
         components?: Record<string, unknown> | undefined;
         webhooks?: Record<string, unknown> | undefined;
+        documentUrl?: string | undefined;
     }>;
     tags: Record<string, {
         type: "tag";
@@ -3849,8 +3909,8 @@ export declare const useWorkspace: () => {
     }>;
     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;
@@ -3949,6 +4009,8 @@ export declare const useWorkspace: () => {
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -3973,6 +4035,7 @@ export declare const useWorkspace: () => {
         } | 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<{
@@ -4127,8 +4190,8 @@ export declare const useWorkspace: () => {
     }>;
     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;
@@ -4191,6 +4254,8 @@ export declare const useWorkspace: () => {
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -4215,11 +4280,12 @@ export declare const useWorkspace: () => {
         } | 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;
@@ -4247,7 +4313,12 @@ export declare const useWorkspace: () => {
     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?: import("../libs/index.js").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?: import("../libs/index.js").ClientConfiguration["preferredSecurityScheme"];
+    }) => Promise<{
         type: "collection";
         uid: string;
         children: string[];
@@ -4286,6 +4357,8 @@ export declare const useWorkspace: () => {
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -4310,8 +4383,19 @@ export declare const useWorkspace: () => {
         } | 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?: import("../libs/index.js").ClientConfiguration["preferredSecurityScheme"], workspaceUid?: string) => Promise<{
+    importSpecFromUrl: (url: string, workspaceUid: string, { proxy, overloadServers, watchForChanges, preferredSecurityScheme, }?: {
+        watchForChanges?: boolean;
+        overloadServers?: import("@scalar/types/legacy").Spec["servers"];
+        preferredSecurityScheme?: import("../libs/index.js").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?: import("../libs/index.js").ClientConfiguration["preferredSecurityScheme"];
+    }) => Promise<{
         type: "collection";
         uid: string;
         children: string[];
@@ -4350,6 +4434,8 @@ export declare const useWorkspace: () => {
             token: string;
             clientSecret: string;
         }>;
+        watchForChanges: boolean;
+        watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
             description?: string | undefined;
@@ -4374,7 +4460,8 @@ export declare const useWorkspace: () => {
         } | undefined;
         components?: Record<string, unknown> | undefined;
         webhooks?: Record<string, unknown> | undefined;
-    } | undefined>;
+        documentUrl?: string | undefined;
+    } | undefined>>>>>;
     cookieMutators: {
         add: (item: {
             value: string;
@@ -4520,6 +4607,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4544,6 +4633,7 @@ export declare const useWorkspace: () => {
             } | 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";
@@ -4584,6 +4674,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4608,6 +4700,7 @@ export declare const useWorkspace: () => {
             } | 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: {
@@ -4649,6 +4742,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4673,8 +4768,9 @@ export declare const useWorkspace: () => {
             } | 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[];
@@ -4713,6 +4809,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4737,7 +4835,8 @@ export declare const useWorkspace: () => {
             } | 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 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 Path<{
             type: "collection";
             uid: string;
             children: string[];
@@ -4776,6 +4875,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4800,6 +4901,7 @@ export declare const useWorkspace: () => {
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }[K]> ? PathValue<{
             type: "collection";
             uid: string;
@@ -4839,6 +4941,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4863,8 +4967,9 @@ export declare const useWorkspace: () => {
             } | 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[];
@@ -4903,6 +5008,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4927,7 +5034,8 @@ export declare const useWorkspace: () => {
             } | 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 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 Path<{
             type: "collection";
             uid: string;
             children: string[];
@@ -4966,6 +5074,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -4990,6 +5100,7 @@ export declare const useWorkspace: () => {
             } | undefined;
             components?: Record<string, unknown> | undefined;
             webhooks?: Record<string, unknown> | undefined;
+            documentUrl?: string | undefined;
         }[K]> ? PathValue<{
             type: "collection";
             uid: string;
@@ -5029,6 +5140,8 @@ export declare const useWorkspace: () => {
                 token: string;
                 clientSecret: string;
             }>;
+            watchForChanges: boolean;
+            watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
                 description?: string | undefined;
@@ -5053,6 +5166,7 @@ export declare const useWorkspace: () => {
             } | 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;
@@ -6417,7 +6531,7 @@ export declare const useWorkspace: () => {
             'x-scalar-client-id': string;
             description?: string | undefined;
         };
-        delete: (scheme: SecurityScheme) => void;
+        delete: (schemeUid: string) => void;
         set: (item: {
             type: "apiKey";
             uid: string;
@@ -6805,16 +6919,16 @@ export declare const useWorkspace: () => {
     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;
@@ -6822,52 +6936,52 @@ export declare const useWorkspace: () => {
         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 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]> ? 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 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]> ? 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;