@scalar/api-reference 0.8.10 → 1.0.1

package/dist/hooks/useParser.d.ts

@@ -0,0 +1,163 @@
+import { type ComputedRef, type Ref } from 'vue';
+import type { Spec } from '../types';
+/**
+ * Dereference OpenAPI/Swagger specs
+ */
+export declare function useParser({ input, }: {
+    input?: string | Ref<string> | ComputedRef<string>;
+}): {
+    parsedSpecRef: {
+        tags: {
+            name: string;
+            description: string;
+            operations: {
+                httpVerb: string;
+                path: string;
+                operationId: string;
+                name: string;
+                description: string;
+                information: {
+                    description: string;
+                    operationId: string;
+                    parameters: {
+                        description?: string | undefined;
+                        in?: string | undefined;
+                        name: string;
+                        required?: boolean | undefined;
+                        schema?: {
+                            format: string;
+                            type: string;
+                        } | undefined;
+                    }[];
+                    responses: Record<string, import("../types").Response>;
+                    security: import("openapi-types").OpenAPIV3.SecurityRequirementObject[];
+                    requestBody: {
+                        description: string;
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: string;
+                                    required: string[];
+                                    properties: import("../types").ContentProperties;
+                                };
+                            };
+                            "application/xml": {
+                                schema: {
+                                    type: string;
+                                    required: string[];
+                                    properties: import("../types").ContentProperties;
+                                };
+                            };
+                            "text/plain": {
+                                schema: {
+                                    type: string;
+                                    required: string[];
+                                    properties: import("../types").ContentProperties;
+                                };
+                            };
+                            "text/html": {
+                                schema: {
+                                    type: string;
+                                    required: string[];
+                                    properties: import("../types").ContentProperties;
+                                };
+                            };
+                            "application/x-www-form-urlencoded": {
+                                schema: {
+                                    type: string;
+                                    required: string[];
+                                    properties: import("../types").ContentProperties;
+                                };
+                            };
+                            "multipart/form-data": {
+                                schema: {
+                                    type: string;
+                                    required: string[];
+                                    properties: import("../types").ContentProperties;
+                                };
+                            };
+                        };
+                        required: boolean;
+                    };
+                    summary: string;
+                    tags: string[];
+                };
+                responses: Record<string, import("../types").Response & {
+                    headers: import("../types").ExampleResponseHeaders;
+                }>;
+            }[];
+        }[];
+        info: {
+            title: string;
+            description: string;
+            termsOfService: string;
+            contact: {
+                email: string;
+            };
+            license: {
+                name: string;
+                url: string;
+            };
+            version: string;
+        };
+        externalDocs: {
+            description: string;
+            url: string;
+        };
+        servers: {
+            url: string;
+            description?: string | undefined;
+            variables?: Record<string, {
+                default?: string | number | undefined;
+                description?: string | undefined;
+                enum?: (string | number)[] | undefined;
+            }> | undefined;
+        }[];
+        components?: {
+            schemas?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.SchemaObject;
+            } | undefined;
+            responses?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.ResponseObject;
+            } | undefined;
+            parameters?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.ParameterObject;
+            } | undefined;
+            examples?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.ExampleObject;
+            } | undefined;
+            requestBodies?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.RequestBodyObject;
+            } | undefined;
+            headers?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.HeaderObject;
+            } | undefined;
+            securitySchemes?: {
+                [key: string]: import("openapi-types").OpenAPIV3.SecuritySchemeObject | import("openapi-types").OpenAPIV3.ReferenceObject;
+            } | undefined;
+            links?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.LinkObject;
+            } | undefined;
+            callbacks?: {
+                [key: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.CallbackObject;
+            } | undefined;
+        } | {
+            schemas?: Record<string, import("openapi-types").OpenAPIV3_1.SchemaObject> | undefined;
+            responses?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.ResponseObject> | undefined;
+            parameters?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3.ParameterObject> | undefined;
+            examples?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3.ExampleObject> | undefined;
+            requestBodies?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.RequestBodyObject> | undefined;
+            headers?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3.HeaderObject> | undefined;
+            securitySchemes?: Record<string, import("openapi-types").OpenAPIV3.SecuritySchemeObject | import("openapi-types").OpenAPIV3_1.ReferenceObject> | undefined;
+            links?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.LinkObject> | undefined;
+            callbacks?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.CallbackObject> | undefined;
+            pathItems?: Record<string, import("openapi-types").OpenAPIV3_1.ReferenceObject | import("openapi-types").OpenAPIV3_1.PathItemObject<{}>> | undefined;
+        } | undefined;
+        definitions?: import("openapi-types").OpenAPIV2.DefinitionsObject | undefined;
+        openapi?: string | undefined;
+        swagger?: string | undefined;
+    };
+    overwriteParsedSpecRef: (value: Spec) => void;
+    errorRef: Ref<string | null>;
+};
+//# sourceMappingURL=useParser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useParser.d.ts","sourceRoot":"","sources":["../../src/hooks/useParser.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAA+B,MAAM,KAAK,CAAA;AAE7E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AA4BpC;;GAEG;AACH,wBAAgB,SAAS,CAAC,EACxB,KAAK,GACN,EAAE;IACD,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCA2CwC,IAAI;;EAS5C"}

package/dist/hooks/useSpec.d.ts

@@ -0,0 +1,13 @@
+import { type ComputedRef, type Ref } from 'vue';
+import type { SpecConfiguration } from '../types';
+/**
+ * Keep the raw spec content in a ref and update it when the configuration changes.
+ */
+export declare function useSpec({ configuration, proxy, }: {
+    configuration?: SpecConfiguration | Ref<SpecConfiguration | undefined> | ComputedRef<SpecConfiguration | undefined>;
+    proxy?: string;
+}): {
+    rawSpecRef: Ref<string>;
+    setRawSpecRef: (value: string) => void;
+};
+//# sourceMappingURL=useSpec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSpec.d.ts","sourceRoot":"","sources":["../../src/hooks/useSpec.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAqB,MAAM,KAAK,CAAA;AAEnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AA4CjD;;GAEG;AACH,wBAAgB,OAAO,CAAC,EACtB,aAAa,EACb,KAAK,GACN,EAAE;IACD,aAAa,CAAC,EACV,iBAAiB,GACjB,GAAG,CAAC,iBAAiB,GAAG,SAAS,CAAC,GAClC,WAAW,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAA;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;;2BAgC+B,MAAM;EAYrC"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { default as ApiClientModal, useApiClientStore, } from './components/ApiClientModal.vue';
 export { default as ApiReference } from './components/ApiReference.vue';
+export { default as ApiReferenceLayout } from './components/ApiReferenceLayout.vue';
 export { default as Sidebar } from './components/Sidebar.vue';
 export { default as RenderedReference } from './components/Content/Content.vue';
 export { default as DarkModeToggle } from './components/DarkModeToggle.vue';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,IAAI,cAAc,EACzB,iBAAiB,GAClB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AAC/E,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAErE,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC1C,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,IAAI,cAAc,EACzB,iBAAiB,GAClB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AAC/E,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAErE,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC1C,cAAc,SAAS,CAAA"}