@scalar/api-reference 1.44.9 → 1.44.12

package/dist/helpers/storage.d.ts

@@ -1,5 +1,4 @@
-import type { XScalarSelectedSecurity } from '@scalar/workspace-store/schemas/extensions/security/x-scalar-selected-security';
-import { type SecuritySchemes } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import { type Auth } from '@scalar/workspace-store/entities/auth';
 /**
  * Provides an interface to store and retrieve the selected client value
  * in local storage.
@@ -24,52 +23,47 @@ export declare const authStorage: () => {
     /**
      * Retrieves and coerces the authentication schemes stored in local storage.
      */
-    getSchemas: (slug: string) => {
-        [x: string]: ({
-            description?: string | undefined;
-        } & {
-            'x-scalar-secret-token': string;
-        } & {
-            type: "apiKey";
-            in: "header" | "query" | "cookie";
-            name: string;
-        }) | ({
-            description?: string | undefined;
-        } & {
-            'x-scalar-secret-token': string;
-        } & {
-            'x-scalar-secret-username': string;
-            'x-scalar-secret-password': string;
-        } & {
-            bearerFormat?: string | undefined;
-            type: "http";
-            scheme: "basic" | "bearer";
-        }) | ({
-            description?: string | undefined;
-        } & {
-            type: "oauth2";
-            flows: {
-                password?: ({
-                    refreshUrl: string;
-                    scopes: {
-                        [x: string]: string;
+    getAuth: (slug: string) => {
+        selected: {
+            path?: {
+                [x: string]: {
+                    [x: string]: {
+                        selectedIndex: number;
+                        selectedSchemes: {}[];
                     };
-                } & {
+                };
+            } | undefined;
+            document?: {
+                selectedIndex: number;
+                selectedSchemes: {}[];
+            } | undefined;
+        };
+        secrets: {
+            [x: string]: ({
+                type: "apiKey";
+            } & {
+                'x-scalar-secret-token': string;
+            }) | ({
+                type: "http";
+            } & {
+                'x-scalar-secret-token': string;
+            } & {
+                'x-scalar-secret-username': string;
+                'x-scalar-secret-password': string;
+            }) | ({
+                type: "oauth2";
+            } & {
+                implicit?: ({
                     'x-scalar-secret-client-id': string;
                 } & {
                     'x-scalar-secret-token': string;
                 } & {
-                    'x-scalar-security-query'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-scalar-security-body'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-tokenName'?: string | undefined;
+                    'x-scalar-secret-redirect-uri': string;
+                }) | undefined;
+                password?: ({
+                    'x-scalar-secret-client-id': string;
                 } & {
-                    tokenUrl: string;
+                    'x-scalar-secret-token': string;
                 } & {
                     'x-scalar-secret-username': string;
                     'x-scalar-secret-password': string;
@@ -78,266 +72,33 @@ export declare const authStorage: () => {
                 } & {
                     'x-scalar-credentials-location'?: "body" | "header" | undefined;
                 }) | undefined;
-                implicit?: ({
-                    refreshUrl: string;
-                    scopes: {
-                        [x: string]: string;
-                    };
-                } & {
-                    'x-scalar-secret-client-id': string;
-                } & {
-                    'x-scalar-secret-token': string;
-                } & {
-                    'x-scalar-security-query'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-scalar-security-body'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-tokenName'?: string | undefined;
-                } & {
-                    authorizationUrl: string;
-                } & {
-                    'x-scalar-secret-redirect-uri': string;
-                }) | undefined;
                 clientCredentials?: ({
-                    refreshUrl: string;
-                    scopes: {
-                        [x: string]: string;
-                    };
-                } & {
                     'x-scalar-secret-client-id': string;
                 } & {
                     'x-scalar-secret-token': string;
-                } & {
-                    'x-scalar-security-query'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-scalar-security-body'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-tokenName'?: string | undefined;
-                } & {
-                    tokenUrl: string;
                 } & {
                     'x-scalar-secret-client-secret': string;
                 } & {
                     'x-scalar-credentials-location'?: "body" | "header" | undefined;
                 }) | undefined;
                 authorizationCode?: ({
-                    refreshUrl: string;
-                    scopes: {
-                        [x: string]: string;
-                    };
-                } & {
                     'x-scalar-secret-client-id': string;
                 } & {
                     'x-scalar-secret-token': string;
-                } & {
-                    'x-scalar-security-query'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-scalar-security-body'?: {
-                        [x: string]: string;
-                    } | undefined;
-                } & {
-                    'x-tokenName'?: string | undefined;
-                } & {
-                    authorizationUrl: string;
-                    tokenUrl: string;
                 } & {
                     'x-scalar-secret-client-secret': string;
                 } & {
                     'x-scalar-secret-redirect-uri': string;
-                } & {
-                    'x-usePkce': "SHA-256" | "plain" | "no";
                 } & {
                     'x-scalar-credentials-location'?: "body" | "header" | undefined;
                 }) | undefined;
-            };
-        } & {
-            'x-default-scopes'?: string[] | undefined;
-        }) | ({
-            description?: string | undefined;
-        } & {
-            type: "openIdConnect";
-            openIdConnectUrl: string;
-        }) | ({
-            summary?: string | undefined;
-            description?: string | undefined;
-            $ref: string;
-        } & {
-            $status?: "loading" | "error" | undefined;
-            $global?: boolean | undefined;
-        } & {
-            '$ref-value': ({
-                description?: string | undefined;
-            } & {
-                'x-scalar-secret-token': string;
-            } & {
-                type: "apiKey";
-                in: "header" | "query" | "cookie";
-                name: string;
-            }) | ({
-                description?: string | undefined;
-            } & {
-                'x-scalar-secret-token': string;
-            } & {
-                'x-scalar-secret-username': string;
-                'x-scalar-secret-password': string;
-            } & {
-                bearerFormat?: string | undefined;
-                type: "http";
-                scheme: "basic" | "bearer";
-            }) | ({
-                description?: string | undefined;
-            } & {
-                type: "oauth2";
-                flows: {
-                    password?: ({
-                        refreshUrl: string;
-                        scopes: {
-                            [x: string]: string;
-                        };
-                    } & {
-                        'x-scalar-secret-client-id': string;
-                    } & {
-                        'x-scalar-secret-token': string;
-                    } & {
-                        'x-scalar-security-query'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-scalar-security-body'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-tokenName'?: string | undefined;
-                    } & {
-                        tokenUrl: string;
-                    } & {
-                        'x-scalar-secret-username': string;
-                        'x-scalar-secret-password': string;
-                    } & {
-                        'x-scalar-secret-client-secret': string;
-                    } & {
-                        'x-scalar-credentials-location'?: "body" | "header" | undefined;
-                    }) | undefined;
-                    implicit?: ({
-                        refreshUrl: string;
-                        scopes: {
-                            [x: string]: string;
-                        };
-                    } & {
-                        'x-scalar-secret-client-id': string;
-                    } & {
-                        'x-scalar-secret-token': string;
-                    } & {
-                        'x-scalar-security-query'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-scalar-security-body'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-tokenName'?: string | undefined;
-                    } & {
-                        authorizationUrl: string;
-                    } & {
-                        'x-scalar-secret-redirect-uri': string;
-                    }) | undefined;
-                    clientCredentials?: ({
-                        refreshUrl: string;
-                        scopes: {
-                            [x: string]: string;
-                        };
-                    } & {
-                        'x-scalar-secret-client-id': string;
-                    } & {
-                        'x-scalar-secret-token': string;
-                    } & {
-                        'x-scalar-security-query'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-scalar-security-body'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-tokenName'?: string | undefined;
-                    } & {
-                        tokenUrl: string;
-                    } & {
-                        'x-scalar-secret-client-secret': string;
-                    } & {
-                        'x-scalar-credentials-location'?: "body" | "header" | undefined;
-                    }) | undefined;
-                    authorizationCode?: ({
-                        refreshUrl: string;
-                        scopes: {
-                            [x: string]: string;
-                        };
-                    } & {
-                        'x-scalar-secret-client-id': string;
-                    } & {
-                        'x-scalar-secret-token': string;
-                    } & {
-                        'x-scalar-security-query'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-scalar-security-body'?: {
-                            [x: string]: string;
-                        } | undefined;
-                    } & {
-                        'x-tokenName'?: string | undefined;
-                    } & {
-                        authorizationUrl: string;
-                        tokenUrl: string;
-                    } & {
-                        'x-scalar-secret-client-secret': string;
-                    } & {
-                        'x-scalar-secret-redirect-uri': string;
-                    } & {
-                        'x-usePkce': "SHA-256" | "plain" | "no";
-                    } & {
-                        'x-scalar-credentials-location'?: "body" | "header" | undefined;
-                    }) | undefined;
-                };
-            } & {
-                'x-default-scopes'?: string[] | undefined;
-            }) | ({
-                description?: string | undefined;
-            } & {
-                type: "openIdConnect";
-                openIdConnectUrl: string;
             });
-        });
+        };
     };
     /**
      * Stores the authentication schemes in local storage.
-     * @param value The SecuritySchemes object to stringify and store.
-     */
-    setSchemas: (slug: string, value: SecuritySchemes) => void;
-    /**
-     * Retrieves and coerces the selected authentication schemes stored in local storage.
-     */
-    getSelectedSchemes: (slug: string) => {
-        'x-scalar-selected-security'?: {
-            selectedIndex: number;
-            selectedSchemes: {}[];
-        } | undefined;
-    };
-    /**
-     * Stores the user's selected authentication schemes in local storage.
-     * @param value The XScalarSelectedSecurity object to stringify and store.
+     * @param value The Auth object to stringify and store.
      */
-    setSelectedSchemes: (slug: string, value: XScalarSelectedSecurity) => void;
+    setAuth: (slug: string, value: Auth) => void;
 };
 //# sourceMappingURL=storage.d.ts.map

package/dist/helpers/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/helpers/storage.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gFAAgF,CAAA;AAE7H,OAAO,EACL,KAAK,eAAe,EAGrB,MAAM,8DAA8D,CAAA;AAKrE;;;GAGG;AACH,eAAO,MAAM,aAAa;IAGtB;;OAEG;;IAIH;;;OAGG;iBACU,MAAM;CAItB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW;IAYpB;;OAEG;uBACgB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIzB;;;OAGG;uBACgB,MAAM,SAAS,eAAe;IAGjD;;OAEG;+BACwB,MAAM;;;;;;IAIjC;;;OAGG;+BACwB,MAAM,SAAS,uBAAuB;CAIpE,CAAA"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/helpers/storage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAc,MAAM,uCAAuC,CAAA;AAM7E;;;GAGG;AACH,eAAO,MAAM,aAAa;IAGtB;;OAEG;;IAIH;;;OAGG;iBACU,MAAM;CAItB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW;IAMpB;;OAEG;oBACa,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAItB;;;OAGG;oBACa,MAAM,SAAS,IAAI;CAItC,CAAA"}

package/dist/helpers/storage.js

@@ -1,6 +1,6 @@
 import { REFERENCE_LS_KEYS, safeLocalStorage } from "@scalar/helpers/object/local-storage";
+import { AuthSchema } from "@scalar/workspace-store/entities/auth";
 import { coerceValue } from "@scalar/workspace-store/schemas/typebox-coerce";
-import { XScalarSelectedSecuritySchema, SecuritySchemesSchema } from "@scalar/workspace-store/schemas/v3.1/strict/openapi-document";
 const storage = safeLocalStorage();
 const clientStorage = () => {
   const key = REFERENCE_LS_KEYS.SELECTED_CLIENT;
@@ -21,42 +21,23 @@ const clientStorage = () => {
   };
 };
 const authStorage = () => {
-  const schemasKey = REFERENCE_LS_KEYS.AUTH_SCHEMES;
-  const selectedSchemesKey = REFERENCE_LS_KEYS.SELECTED_AUTH_SCHEMES;
-  const getAuthId = (type, prefix) => {
-    const getKey = (type2) => {
-      return type2 === "schemas" ? schemasKey : selectedSchemesKey;
-    };
-    return `${prefix}-${getKey(type)}`;
+  const getKey = (slug) => {
+    return `${REFERENCE_LS_KEYS.AUTH}-${slug}`;
   };
   return {
     /**
      * Retrieves and coerces the authentication schemes stored in local storage.
      */
-    getSchemas: (slug) => {
-      const parsed = JSON.parse(storage.getItem(getAuthId("schemas", slug)) ?? "{}");
-      return coerceValue(SecuritySchemesSchema, parsed);
+    getAuth: (slug) => {
+      const parsed = JSON.parse(storage.getItem(getKey(slug)) ?? "{}");
+      return coerceValue(AuthSchema, parsed);
     },
     /**
      * Stores the authentication schemes in local storage.
-     * @param value The SecuritySchemes object to stringify and store.
+     * @param value The Auth object to stringify and store.
      */
-    setSchemas: (slug, value) => {
-      storage.setItem(getAuthId("schemas", slug), JSON.stringify(value));
-    },
-    /**
-     * Retrieves and coerces the selected authentication schemes stored in local storage.
-     */
-    getSelectedSchemes: (slug) => {
-      const parsed = JSON.parse(storage.getItem(getAuthId("selectedSchemes", slug)) ?? "{}");
-      return coerceValue(XScalarSelectedSecuritySchema, parsed);
-    },
-    /**
-     * Stores the user's selected authentication schemes in local storage.
-     * @param value The XScalarSelectedSecurity object to stringify and store.
-     */
-    setSelectedSchemes: (slug, value) => {
-      storage.setItem(getAuthId("selectedSchemes", slug), JSON.stringify(value));
+    setAuth: (slug, value) => {
+      storage.setItem(getKey(slug), JSON.stringify(value));
     }
   };
 };

package/dist/plugins/persistance-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"persistance-plugin.d.ts","sourceRoot":"","sources":["../../src/plugins/persistance-plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAA;AAI/E;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,kDAK/B;IACD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAChC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,CAAA;CACxC,KAAG,eA2EH,CAAA"}
+{"version":3,"file":"persistance-plugin.d.ts","sourceRoot":"","sources":["../../src/plugins/persistance-plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAA;AAI/E;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,kDAK/B;IACD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAChC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,CAAA;CACxC,KAAG,eAsDH,CAAA"}

package/dist/plugins/persistance-plugin.js

@@ -1,5 +1,5 @@
 import { debounce } from "@scalar/helpers/general/debounce";
-import { authStorage, clientStorage } from "../helpers/storage.js";
+import { clientStorage, authStorage } from "../helpers/storage.js";
 const persistencePlugin = ({
   debounceDelay = 500,
   maxWait = 1e4,
@@ -35,24 +35,8 @@ const persistencePlugin = ({
           }
           return;
         }
-        if (event.type === "documents") {
-          if (!getPersistAuth()) {
-            return;
-          }
-          const { path, value: document } = event;
-          const { securitySchemes = {} } = document.components ?? {};
-          if (path[0] === "components" && path[1] === "securitySchemes") {
-            execute("x-scalar-security-schemes", () => authPersistence.setSchemas(getPrefix(), securitySchemes));
-          }
-          const selectedSecurity = document["x-scalar-selected-security"];
-          if (path[0] === "x-scalar-selected-security" && selectedSecurity) {
-            execute(
-              "x-scalar-selected-security-schemes",
-              () => authPersistence.setSelectedSchemes(getPrefix(), {
-                "x-scalar-selected-security": selectedSecurity
-              })
-            );
-          }
+        if (getPersistAuth() && event.type === "auth") {
+          execute("auth", () => authPersistence.setAuth(getPrefix(), event.value));
         }
         return;
       }