vitepress-openapi 0.1.17 → 0.1.19

package/README.md

@@ -2,10 +2,17 @@
 
 Generate VitePress API Documentation from OpenAPI Specification.
 
+## Demo
+
+- [DolarApi.com](https://dolarapi.com/)
+- [ArgentinaDatos](https://argentinadatos.com/)
+- [CriptoYa API](https://docs.criptoya.com/)
+
 ## Documentation
 
 To get started, check out the [documentation](https://vitepress-openapi.vercel.app/).
 
+
 ## Contributors
 
 <a href="https://github.com/enzonotario/vitepress-openapi/graphs/contributors">
@@ -14,6 +21,18 @@ To get started, check out the [documentation](https://vitepress-openapi.vercel.a
 
 Made with [contrib.rocks](https://contrib.rocks).
 
+
 ## License
 
 [MIT License](./LICENSE) © 2023-present [Enzo Notario](https://github.com/enzonotario).
+
+---
+
+### ❤️ Sponsors & Backers
+
+<a href="https://github.com/sponsors/enzonotario">
+  <img src="https://raw.githubusercontent.com/enzonotario/enzonotario/main/sponsors.png" alt="Sponsors & Backers" />
+</a>
+
+> [Become a sponsor](https://github.com/sponsors/enzonotario)
+

package/dist/types/src/client.d.ts

@@ -12,6 +12,7 @@ interface VPTheme {
     extends?: Theme;
 }
 export declare const theme: VPTheme;
+export * from './components';
 export { useOpenapi } from './composables/useOpenapi';
 export { usePlayground } from './composables/usePlayground';
 export { DEFAULT_OPERATION_SLOTS };
@@ -20,4 +21,5 @@ export { useTheme } from './composables/useTheme';
 export { generateCodeSample } from './lib/codeSamples/generateCodeSample';
 export { OARequest } from './lib/codeSamples/request';
 export { createOpenApiSpec } from './lib/spec/createOpenApiSpec';
+export { minifyHtml } from './lib/utils/minifyHtml';
 export { locales } from './locales';

package/dist/types/src/components/Common/OACodeValue.vue.d.ts

@@ -5,28 +5,28 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
         type: (ObjectConstructor | ArrayConstructor | StringConstructor | NumberConstructor | BooleanConstructor)[];
         required: true;
     };
-    parameterName: {
-        type: StringConstructor;
-        default: string;
-    };
     isEnum: {
         type: BooleanConstructor;
         default: boolean;
     };
+    onSet: {
+        type: FunctionConstructor;
+        default: undefined;
+    };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     value: {
         type: (ObjectConstructor | ArrayConstructor | StringConstructor | NumberConstructor | BooleanConstructor)[];
         required: true;
     };
-    parameterName: {
-        type: StringConstructor;
-        default: string;
-    };
     isEnum: {
         type: BooleanConstructor;
         default: boolean;
     };
+    onSet: {
+        type: FunctionConstructor;
+        default: undefined;
+    };
 }>> & Readonly<{}>, {
-    parameterName: string;
+    onSet: Function;
     isEnum: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/dist/types/src/components/Parameter/OAParameterExamples.vue.d.ts

@@ -1,13 +1,23 @@
-declare const _default: typeof __VLS_export;
-export default _default;
 declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     property: {
         type: ObjectConstructor;
         required: true;
     };
+    securitySchemeName: {
+        type: StringConstructor;
+        default: undefined;
+    };
 }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     property: {
         type: ObjectConstructor;
         required: true;
     };
-}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+    securitySchemeName: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    securitySchemeName: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/types/src/components/index.d.ts

@@ -1,4 +1,6 @@
 import OAVueJsonPretty from './Common/Highlight/OAVueJsonPretty.vue';
+import OAFooter from './Common/OAFooter.vue';
+import OAHeaderBadges from './Common/OAHeaderBadges.vue';
 import OAHeading from './Common/OAHeading.vue';
 import OAMarkdown from './Common/OAMarkdown.vue';
 import OAInfo from './Feature/OAInfo.vue';
@@ -10,10 +12,13 @@ import OAOperationLink from './Feature/OAOperationLink.vue';
 import OAServers from './Feature/OAServers.vue';
 import OASpec from './Feature/OASpec.vue';
 import OASpecSkeleton from './Feature/OASpecSkeleton.vue';
+import OAOperationTags from './Operation/OAOperationTags.vue';
 import OAParameter from './Parameter/OAParameter.vue';
 import OAParameters from './Parameter/OAParameters.vue';
 import OAPathEndpoint from './Path/OAPathEndpoint.vue';
 import OAPlayground from './Playground/OAPlayground.vue';
 import OARequestBody from './Request/OARequestBody.vue';
 import OAResponses from './Response/OAResponses.vue';
-export { OAHeading, OAInfo, OAIntroduction, OALocaleSelect, OAMarkdown, OAOperation, OAOperationContext, OAOperationLink, OAParameter, OAParameters, OAPathEndpoint, OAPlayground, OARequestBody, OAResponses, OAServers, OASpec, OASpecSkeleton, OAVueJsonPretty, };
+import OACodeSamples from './Sample/OACodeSamples.vue';
+import OASecurity from './Security/OASecurity.vue';
+export { OACodeSamples, OAFooter, OAHeaderBadges, OAHeading, OAInfo, OAIntroduction, OALocaleSelect, OAMarkdown, OAOperation, OAOperationContext, OAOperationLink, OAOperationTags, OAParameter, OAParameters, OAPathEndpoint, OAPlayground, OARequestBody, OAResponses, OASecurity, OAServers, OASpec, OASpecSkeleton, OAVueJsonPretty, };

package/dist/types/src/components/ui/input/Input.vue.d.ts

@@ -4,6 +4,7 @@ type __VLS_Props = {
     modelValue?: string | number;
     class?: HTMLAttributes['class'];
     type?: string;
+    clearable?: boolean;
 };
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
     "update:modelValue": (payload: string | number) => any;

package/dist/types/src/composables/usePlayground.d.ts

@@ -41,5 +41,6 @@ export declare function usePlayground(): {
     submitRequest: ({ request, method, baseUrl, path, operationId }: SubmitOptions) => Promise<PlaygroundResponse | null>;
     cleanupImageUrls: () => void;
     setParameterValue: (parameterName: string, value: any) => void;
+    setSecurityValue: (schemeId: string, value: any) => void;
     hasOperationData: boolean;
 };

package/dist/types/src/composables/useTheme.d.ts

@@ -96,6 +96,7 @@ export interface ServerConfig {
 }
 export interface StorageConfig {
     prefix?: string;
+    persistAuth?: boolean;
 }
 export interface OperationLinkConfig {
     linkPrefix?: string;
@@ -159,6 +160,7 @@ type GetServersFunction = ({ method, path, operation }: {
 export declare const DEFAULT_OPERATION_SLOTS: OperationSlot[];
 export declare const DEFAULT_BASE_URL = "http://localhost";
 export declare const DEFAULT_STORAGE_PREFIX = "--oa";
+export declare const DEFAULT_STORAGE_PERSIST_AUTH = true;
 export declare const availableLanguages: LanguageConfig[];
 export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
     isDark: import("@vueuse/core").UseDarkReturn;
@@ -277,6 +279,7 @@ export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
         } | undefined;
         storage?: {
             prefix?: string | undefined;
+            persistAuth?: boolean | undefined;
         } | undefined;
         markdown?: {
             operationLink?: false | {
@@ -363,6 +366,7 @@ export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
     setMarkdownConfig: (config: Partial<UnwrapNestedRefs<MarkdownConfig>>) => void;
     getOperationLinkConfig: () => OperationLinkConfig | false | undefined;
     getStoragePrefix: () => string;
+    getStoragePersistAuth: () => boolean;
     setStorageConfig: (config: Partial<StorageConfig>) => void;
 };
 export {};

package/dist/types/src/index.d.ts

@@ -4,6 +4,7 @@ export { getGlobalOpenapi, injectOpenapi, useOpenapi, } from './composables/useO
 export { usePaths } from './composables/usePaths';
 export { useSidebar } from './composables/useSidebar';
 export { createOpenApiSpec, type OpenApiSpecInstance } from './lib/spec/createOpenApiSpec';
+export { minifyHtml } from './lib/utils/minifyHtml';
 export { parseSpec } from './lib/utils/parseSpec';
 export declare const httpVerbs: readonly OpenAPIV3.HttpMethods[];
 export declare const literalTypes: string[];

package/dist/types/src/lib/operation/operationData.d.ts

@@ -5,6 +5,7 @@ export interface OperationData {
     operationId: string;
     security: {
         selectedSchemeId: Ref<string>;
+        securityValues: Ref<Record<string, any>>;
     };
     playground: {
         request: Ref<OARequest>;

package/dist/types/src/lib/utils/minifyHtml.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Minifies a string of HTML by replacing multiple whitespace characters with a single space
+ * and trimming the result. This helps prevent hydration mismatches in VitePress.
+ */
+export declare function minifyHtml(html: string): string;