vitepress-openapi 0.1.14 → 0.1.16

package/dist/types/src/components/Playground/OAPlaygroundBodyInput.vue.d.ts

@@ -1,4 +1,5 @@
 import type { OpenAPIV3 } from '@scalar/openapi-types';
+import type { PlaygroundExampleBehavior } from '../../composables/useTheme';
 import type { OAExampleObject } from '../../types';
 interface Props {
     operationId: string;
@@ -9,6 +10,8 @@ interface Props {
     examples?: {
         [key: string]: OAExampleObject;
     };
+    exampleBehavior?: PlaygroundExampleBehavior;
+    xExampleBehavior?: PlaygroundExampleBehavior;
 }
 declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     submit: () => any;

package/dist/types/src/components/Playground/OAPlaygroundParameterInput.vue.d.ts

@@ -1,3 +1,4 @@
+import type { PlaygroundExampleBehavior } from '../../composables/useTheme';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     parameter: {
         type: ObjectConstructor;
@@ -14,6 +15,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: StringConstructor;
         required: true;
     };
+    exampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
+    xExampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
     enabled: {
         type: BooleanConstructor;
         default: boolean;
@@ -42,6 +51,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: StringConstructor;
         required: true;
     };
+    exampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
+    xExampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
     enabled: {
         type: BooleanConstructor;
         default: boolean;
@@ -55,6 +72,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     onSubmit?: ((...args: any[]) => any) | undefined;
     "onUpdate:enabled"?: ((...args: any[]) => any) | undefined;
 }>, {
+    exampleBehavior: PlaygroundExampleBehavior;
+    xExampleBehavior: PlaygroundExampleBehavior;
     enabled: boolean;
     hideLabel: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/dist/types/src/components/Playground/OAPlaygroundParameters.vue.d.ts

@@ -1,4 +1,5 @@
 import type { OpenAPIV3 } from '@scalar/openapi-types';
+import type { PlaygroundExampleBehavior } from '../../composables/useTheme';
 import type { SecurityUiItem } from '../../types';
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     operationId: {
@@ -46,6 +47,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: ObjectConstructor;
         required: false;
     };
+    exampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
+    xExampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
     requestBody: {
         type: ObjectConstructor;
         required: false;
@@ -98,6 +107,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: ObjectConstructor;
         required: false;
     };
+    exampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
+    xExampleBehavior: {
+        type: () => PlaygroundExampleBehavior;
+        default: string;
+    };
     requestBody: {
         type: ObjectConstructor;
         required: false;
@@ -107,6 +124,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
 }>, {
     parameters: OpenAPIV3.ParameterObject[];
     servers: unknown[];
+    exampleBehavior: PlaygroundExampleBehavior;
+    xExampleBehavior: PlaygroundExampleBehavior;
     securityUi: Record<string, any>;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/types/src/components/ui/select-with-custom-option/SelectWithCustomOption.vue.d.ts

@@ -10,8 +10,8 @@ declare const _default: import("vue").DefineComponent<SelectWithCustomOptionProp
     "onUpdate:customValue"?: ((value: string) => any) | undefined;
     "onUpdate:isCustom"?: ((value: boolean) => any) | undefined;
 }>, {
-    modelValue: string;
     placeholder: string;
+    modelValue: string;
     isCustom: boolean;
     customValue: string;
     defaultCustomValue: string;

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

@@ -44,6 +44,7 @@ export interface ResponseConfig {
         defaultView?: Ref<BodyViewType>;
     };
 }
+export type PlaygroundExampleBehavior = 'placeholder' | 'value' | 'ignore';
 export interface PlaygroundConfig {
     jsonEditor?: {
         mode?: Ref<PlaygroundJsonEditorMode>;
@@ -51,6 +52,10 @@ export interface PlaygroundConfig {
         navigationBar?: Ref<boolean>;
         statusBar?: Ref<boolean>;
     };
+    examples?: {
+        behavior?: Ref<PlaygroundExampleBehavior>;
+        playgroundExampleBehavior?: Ref<PlaygroundExampleBehavior>;
+    };
 }
 export interface SecurityConfig {
     defaultScheme?: Ref<string | null>;
@@ -89,6 +94,9 @@ export interface ServerConfig {
     allowCustomServer?: boolean;
     getServers?: GetServersFunction | null;
 }
+export interface StorageConfig {
+    prefix?: string;
+}
 export interface OperationLinkConfig {
     linkPrefix?: string;
     transformHref?: (href: string) => string;
@@ -114,6 +122,7 @@ export interface UseThemeConfig {
     codeSamples?: Partial<CodeSamplesConfig>;
     linksPrefixes?: Partial<LinksPrefixesConfig>;
     server?: Partial<ServerConfig>;
+    storage?: Partial<StorageConfig>;
     markdown?: Partial<MarkdownConfig>;
 }
 export interface CodeSamplesConfig {
@@ -149,6 +158,7 @@ type GetServersFunction = ({ method, path, operation }: {
 }) => string[] | null;
 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 availableLanguages: LanguageConfig[];
 export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
     isDark: import("vue").WritableComputedRef<boolean, boolean>;
@@ -196,6 +206,10 @@ export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
                 navigationBar?: boolean | undefined;
                 statusBar?: boolean | undefined;
             } | undefined;
+            examples?: {
+                behavior?: PlaygroundExampleBehavior | undefined;
+                playgroundExampleBehavior?: PlaygroundExampleBehavior | undefined;
+            } | undefined;
         } | undefined;
         security?: {
             defaultScheme?: string | null | undefined;
@@ -261,6 +275,9 @@ export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
             allowCustomServer?: boolean | undefined;
             getServers?: {} | null | undefined;
         } | undefined;
+        storage?: {
+            prefix?: string | undefined;
+        } | undefined;
         markdown?: {
             operationLink?: false | {
                 linkPrefix?: string | undefined;
@@ -307,6 +324,10 @@ export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
     setPlaygroundJsonEditorNavigationBar: (value: boolean) => void;
     getPlaygroundJsonEditorStatusBar: () => boolean | undefined;
     setPlaygroundJsonEditorStatusBar: (value: boolean) => void;
+    getPlaygroundExamplesBehavior: () => PlaygroundExampleBehavior;
+    setPlaygroundExamplesBehavior: (value: PlaygroundExampleBehavior) => void;
+    getPlaygroundXExampleBehavior: () => PlaygroundExampleBehavior;
+    setPlaygroundXExampleBehavior: (value: PlaygroundExampleBehavior) => void;
     getSecurityDefaultScheme: () => string | null | undefined;
     setSecurityDefaultScheme: (value: string | null) => void;
     getOperationBadges: () => OperationBadges[];
@@ -341,5 +362,7 @@ export declare function useTheme(initialConfig?: PartialUseThemeConfig): {
     getExternalLinksNewTab: () => boolean;
     setMarkdownConfig: (config: Partial<UnwrapNestedRefs<MarkdownConfig>>) => void;
     getOperationLinkConfig: () => OperationLinkConfig | false | undefined;
+    getStoragePrefix: () => string;
+    setStorageConfig: (config: Partial<StorageConfig>) => void;
 };
 export {};

package/dist/types/src/lib/examples/getPropertyExample.d.ts

@@ -1 +1,3 @@
+export declare function getPlaygroundSpecificExample(property: any): any;
+export declare function getStandardExample(property: any): any;
 export declare function getPropertyExample(property: any): any;

package/dist/types/src/lib/playground/playgroundExampleBehavior.d.ts

@@ -0,0 +1,5 @@
+import type { PlaygroundExampleBehavior } from '../../composables/useTheme';
+export declare function useExampleForPlaceholder(behavior: PlaygroundExampleBehavior): boolean;
+export declare function useExampleForValue(behavior: PlaygroundExampleBehavior): boolean;
+export declare function resolveExampleForValue(property: any, behavior: PlaygroundExampleBehavior, xExampleBehavior?: PlaygroundExampleBehavior): any;
+export declare function resolveExampleForPlaceholder(property: any, behavior: PlaygroundExampleBehavior, xExampleBehavior?: PlaygroundExampleBehavior): any;