@scalar/api-reference 1.24.45 → 1.24.48

package/dist/hooks/useReactiveSpec.d.ts

@@ -13,46 +13,46 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
             name: string;
             description: string;
             operations: {
-                httpVerb: "GET" | "POST" | "PUT" | "HEAD" | "DELETE" | "PATCH" | "OPTIONS" | "CONNECT" | "TRACE";
+                httpVerb: import("@scalar/oas-utils/helpers").RequestMethod;
                 path: string;
-                operationId?: string | undefined;
-                name?: string | undefined;
-                description?: string | undefined;
+                operationId?: string;
+                name?: string;
+                description?: string;
                 information?: {
-                    description?: string | undefined;
-                    operationId?: string | number | undefined;
+                    description?: string;
+                    operationId?: string | number;
                     parameters?: {
                         name: string;
-                        in?: string | undefined;
-                        description?: string | undefined;
-                        required?: boolean | undefined;
-                        deprecated?: boolean | undefined;
-                        allowEmptyValue?: boolean | undefined;
-                        style?: "form" | "simple" | undefined;
-                        explode?: boolean | undefined;
-                        allowReserved?: boolean | undefined;
+                        in?: string;
+                        description?: string;
+                        required?: boolean;
+                        deprecated?: boolean;
+                        allowEmptyValue?: boolean;
+                        style?: "form" | "simple";
+                        explode?: boolean;
+                        allowReserved?: boolean;
                         schema?: {
                             type: string;
-                            name?: string | undefined;
+                            name?: string;
                             example?: any;
                             default?: any;
-                            format?: string | undefined;
-                            description?: string | undefined;
-                            properties?: Record<string, import("@scalar/oas-utils").Schema> | undefined;
+                            format?: string;
+                            description?: string;
+                            properties?: Record<string, import("@scalar/oas-utils").Schema>;
                         } | undefined;
                         example?: any;
                         examples?: (Map<string, any> & Omit<Map<string, any>, keyof Map<any, any>>) | undefined;
                     }[] | undefined;
-                    responses?: Record<string, import("@scalar/oas-utils").ScalarResponse> | undefined;
-                    security?: import("@scalar/openapi-parser").OpenAPIV3.SecurityRequirementObject[] | undefined;
+                    responses?: Record<string, import("@scalar/oas-utils").ScalarResponse>;
+                    security?: import("@scalar/openapi-parser").OpenAPIV3.SecurityRequirementObject[];
                     requestBody?: {
-                        description?: string | undefined;
-                        required?: boolean | undefined;
-                        content?: import("@scalar/oas-utils").RequestBodyMimeTypes | undefined;
+                        description?: string;
+                        required?: boolean;
+                        content?: import("@scalar/oas-utils").RequestBodyMimeTypes;
                     } | undefined;
-                    summary?: string | undefined;
-                    tags?: string[] | undefined;
-                    deprecated?: boolean | undefined;
+                    summary?: string;
+                    tags?: string[];
+                    deprecated?: boolean;
                     'x-custom-examples'?: {
                         lang: string;
                         label: string;
@@ -71,141 +71,141 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
                 } | undefined;
                 pathParameters?: {
                     name: string;
-                    in?: string | undefined;
-                    description?: string | undefined;
-                    required?: boolean | undefined;
-                    deprecated?: boolean | undefined;
-                    allowEmptyValue?: boolean | undefined;
-                    style?: "form" | "simple" | undefined;
-                    explode?: boolean | undefined;
-                    allowReserved?: boolean | undefined;
+                    in?: string;
+                    description?: string;
+                    required?: boolean;
+                    deprecated?: boolean;
+                    allowEmptyValue?: boolean;
+                    style?: "form" | "simple";
+                    explode?: boolean;
+                    allowReserved?: boolean;
                     schema?: {
                         type: string;
-                        name?: string | undefined;
+                        name?: string;
                         example?: any;
                         default?: any;
-                        format?: string | undefined;
-                        description?: string | undefined;
-                        properties?: Record<string, import("@scalar/oas-utils").Schema> | undefined;
+                        format?: string;
+                        description?: string;
+                        properties?: Record<string, import("@scalar/oas-utils").Schema>;
                     } | undefined;
                     example?: any;
                     examples?: (Map<string, any> & Omit<Map<string, any>, keyof Map<any, any>>) | undefined;
                 }[] | undefined;
             }[];
-            'x-displayName'?: string | undefined;
+            'x-displayName'?: string;
         }[] | undefined;
         info: {
-            title?: string | undefined;
-            description?: string | undefined;
-            termsOfService?: string | undefined;
+            title?: string;
+            description?: string;
+            termsOfService?: string;
             contact?: {
-                name?: string | undefined;
-                url?: string | undefined;
-                email?: string | undefined;
+                name?: string;
+                url?: string;
+                email?: string;
             } | undefined;
             license?: {
-                name?: string | undefined;
-                url?: string | undefined;
+                name?: string;
+                url?: string;
             } | undefined;
-            version?: string | undefined;
+            version?: string;
         } | {
-            title?: string | undefined;
-            description?: string | undefined;
-            termsOfService?: string | undefined;
+            title?: string;
+            description?: string;
+            termsOfService?: string;
             contact?: {
-                name?: string | undefined;
-                url?: string | undefined;
-                email?: string | undefined;
+                name?: string;
+                url?: string;
+                email?: string;
             } | undefined;
             license?: {
-                name?: string | undefined;
-                url?: string | undefined;
+                name?: string;
+                url?: string;
             } | undefined;
-            version?: string | undefined;
+            version?: string;
         } | {
-            description?: string | undefined;
-            title?: string | undefined;
-            termsOfService?: string | undefined;
+            description?: string;
+            title?: string;
+            termsOfService?: string;
             contact?: {
-                name?: string | undefined;
-                url?: string | undefined;
-                email?: string | undefined;
+                name?: string;
+                url?: string;
+                email?: string;
             } | undefined;
-            version?: string | undefined;
-            summary?: string | undefined;
+            version?: string;
+            summary?: string;
             license?: {
-                url?: string | undefined;
-                name?: string | undefined;
-                identifier?: string | undefined;
+                url?: string;
+                name?: string;
+                identifier?: string;
             } | undefined;
         } | undefined;
-        host?: string | undefined;
-        basePath?: string | undefined;
-        schemes?: string[] | undefined;
+        host?: import("@scalar/openapi-parser").OpenAPIV2.Document["host"];
+        basePath?: import("@scalar/openapi-parser").OpenAPIV2.Document["basePath"];
+        schemes?: import("@scalar/openapi-parser").OpenAPIV2.Document["schemes"];
         externalDocs?: {
             url: string;
             description?: string | undefined;
         } | undefined;
         servers?: {
-            url?: string | undefined;
-            description?: string | undefined;
+            url?: string;
+            description?: string;
             variables?: {
                 [variable: string]: import("@scalar/openapi-parser").OpenAPIV3.ServerVariableObject;
-            } | undefined;
+            };
         }[] | {
-            url?: string | undefined;
-            description?: string | undefined;
-            variables?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ServerVariableObject> | undefined;
+            url?: string;
+            description?: string;
+            variables?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ServerVariableObject>;
         }[] | undefined;
         components?: {
             schemas?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.SchemaObject;
-            } | undefined;
+            };
             responses?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.ResponseObject;
-            } | undefined;
+            };
             parameters?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.ParameterObject;
-            } | undefined;
+            };
             examples?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.ExampleObject;
-            } | undefined;
+            };
             requestBodies?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.RequestBodyObject;
-            } | undefined;
+            };
             headers?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.HeaderObject;
-            } | undefined;
+            };
             securitySchemes?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.SecuritySchemeObject;
-            } | undefined;
+            };
             links?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.LinkObject;
-            } | undefined;
+            };
             callbacks?: {
                 [key: string]: import("@scalar/openapi-parser").OpenAPIV3.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.CallbackObject;
-            } | undefined;
+            };
         } | {
-            schemas?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.SchemaObject> | undefined;
-            responses?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.ResponseObject> | undefined;
-            parameters?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.ParameterObject> | undefined;
-            examples?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.ExampleObject> | undefined;
-            requestBodies?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.RequestBodyObject> | undefined;
-            headers?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.HeaderObject> | undefined;
-            securitySchemes?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3.SecuritySchemeObject> | undefined;
-            links?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.LinkObject> | undefined;
-            callbacks?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.CallbackObject> | undefined;
-            pathItems?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.PathItemObject<{}>> | undefined;
+            schemas?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.SchemaObject>;
+            responses?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.ResponseObject>;
+            parameters?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.ParameterObject>;
+            examples?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.ExampleObject>;
+            requestBodies?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.RequestBodyObject>;
+            headers?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.HeaderObject>;
+            securitySchemes?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.SecuritySchemeObject>;
+            links?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.LinkObject>;
+            callbacks?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.CallbackObject>;
+            pathItems?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-parser").OpenAPIV3_1.PathItemObject>;
         } | undefined;
-        webhooks?: import("@scalar/oas-utils").Webhooks | undefined;
-        definitions?: import("@scalar/openapi-parser").OpenAPIV2.DefinitionsObject | undefined;
-        swagger?: string | undefined;
-        openapi?: string | undefined;
+        webhooks?: import("@scalar/oas-utils").Webhooks;
+        definitions?: import("@scalar/oas-utils").Definitions;
+        swagger?: import("@scalar/openapi-parser").OpenAPIV2.Document["swagger"];
+        openapi?: import("@scalar/openapi-parser").OpenAPIV3.Document["openapi"] | import("@scalar/openapi-parser").OpenAPIV3_1.Document["openapi"];
         'x-tagGroups'?: {
             name: string;
             tags: string[];
         }[] | undefined;
-        security?: import("@scalar/openapi-parser").OpenAPIV3.SecurityRequirementObject[] | undefined;
+        security?: import("@scalar/openapi-parser").OpenAPIV3.SecurityRequirementObject[];
     };
     specErrors: import("vue").Ref<string | null>;
 };

package/dist/hooks/useSidebar.d.ts

@@ -1,4 +1,4 @@
-import type { Spec } from '@scalar/oas-utils';
+import type { Spec, Tag } from '@scalar/oas-utils';
 export type SidebarEntry = {
     id: string;
     title: string;
@@ -10,16 +10,21 @@ export type SidebarEntry = {
     deprecated?: boolean;
     isGroup?: boolean;
 };
+/** Helper to overwrite the current OpenAPI document */
 declare function setParsedSpec(spec: Spec): Spec;
 type CollapsedSidebarItems = Record<string, boolean>;
 declare function toggleCollapsedSidebarItem(key: string): void;
 declare function setCollapsedSidebarItem(key: string, value: boolean): void;
+export type ParsedSpecOption = {
+    parsedSpec: Spec;
+};
+export type TagsSorterOption = {
+    tagsSorter?: 'alpha' | ((a: Tag, b: Tag) => number);
+};
 /**
  * Provides the sidebar state and methods to control it.
  */
-export declare function useSidebar(options?: {
-    parsedSpec: Spec;
-}): {
+export declare function useSidebar(options?: ParsedSpecOption & TagsSorterOption): {
     breadcrumb: import("vue").ComputedRef<string>;
     items: import("vue").ComputedRef<{
         entries: SidebarEntry[];

package/dist/hooks/useSidebar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../src/hooks/useSidebar.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAA6B,MAAM,mBAAmB,CAAA;AAexE,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAeD,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,QAEhC;AAMD,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAMpD,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AA2OD;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE;;;;;;;;;;;;;EA4CxD"}
+{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../src/hooks/useSidebar.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAwB,MAAM,mBAAmB,CAAA;AAexE,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAkBD,uDAAuD;AACvD,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,QAWhC;AAMD,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAMpD,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AA2OD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,IAAI,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,CAAA;CACpD,CAAA;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,gBAAgB;;;;;;;;;;;;;EA8CvE"}