@scalar/api-client 2.17.7 → 2.18.0

package/dist/v2/components/code-input/CodeInput.vue.d.ts

@@ -2,150 +2,121 @@ import { type CodeMirrorLanguage, type Extension } from '@scalar/use-codemirror'
 import type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
 import { type Ref } from 'vue';
 import type { ClientLayout } from '../../../v2/types/layout';
-declare const _default: __VLS_WithSlots<import("vue").DefineComponent<{
-    modelValue: string | number | boolean;
-    /** Environment for variable substitution. Pass undefined to disable environment variables */
-    environment: XScalarEnvironment | undefined;
-    /** Type of the input value, affects rendering mode for booleans */
-    type?: string | string[];
-    /** Render as disabled text display */
-    disabled?: boolean;
-    /** Show error styling */
-    error?: boolean;
-    /** Layout context affects styling and behavior */
-    layout?: ClientLayout;
-    /** Predefined enum values, triggers select mode */
-    enum?: string[];
-    /** Example values, triggers select mode */
-    examples?: string[];
-    /** Default value to show in select mode */
-    default?: string | number | boolean;
-    /** Allow null in boolean select options */
-    nullable?: boolean;
-    /** Placeholder text for empty input */
-    placeholder?: string;
-    /** Show required indicator */
-    required?: boolean;
-    /** Enable color picker extension */
-    colorPicker?: boolean;
-    /** Show line numbers in editor */
-    lineNumbers?: boolean;
-    /** Enable linting */
-    lint?: boolean;
-    /** Enable line wrapping */
-    lineWrapping?: boolean;
-    /** CodeMirror language mode */
-    language?: CodeMirrorLanguage;
-    /** Additional CodeMirror extensions */
-    extensions?: Extension[];
-    /** Disable tab key for indentation */
-    disableTabIndent?: boolean;
-    /** Disable enter key */
-    disableEnter?: boolean;
-    /** Disable automatic bracket closing */
-    disableCloseBrackets?: boolean;
-    /** Emit submit event on blur */
-    emitOnBlur?: boolean;
-    /** Enable environment variable pills */
-    withVariables?: boolean;
-    /** Detect and emit curl commands */
-    importCurl?: boolean;
-    /** Emit change event even if the value is the same */
-    alwaysEmitChange?: boolean;
-    /** Custom change handler, prevents default emit */
-    handleFieldChange?: (value: string) => void;
-    /** Custom submit handler, prevents default emit */
-    handleFieldSubmit?: (value: string) => void;
-}, {
-    /**
-     * Focus the codemirror element
-     *
-     * @param cursorAtEnd boolean place the cursor at the end of the input
-     */
-    focus: (position?: "start" | "end" | number) => void;
-    isFocused: Ref<boolean, boolean>;
-    handleChange: (value: string) => void;
-    handleSubmit: (value: string) => void;
-    handleBlur: (value: string) => void;
-    booleanOptions: import("vue").ComputedRef<string[]>;
-    codeMirror: Ref<import("@codemirror/view").EditorView | null, import("@codemirror/view").EditorView | null>;
-    modelValue: string | number | boolean;
-    cursorPosition: () => number | undefined;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    submit: (value: string) => any;
-    redirectToEnvironment: () => any;
-    "update:modelValue": (value: string) => any;
-    blur: (value: string) => any;
-    curl: (value: string) => any;
-}, string, import("vue").PublicProps, Readonly<{
-    modelValue: string | number | boolean;
-    /** Environment for variable substitution. Pass undefined to disable environment variables */
-    environment: XScalarEnvironment | undefined;
-    /** Type of the input value, affects rendering mode for booleans */
-    type?: string | string[];
-    /** Render as disabled text display */
-    disabled?: boolean;
-    /** Show error styling */
-    error?: boolean;
-    /** Layout context affects styling and behavior */
-    layout?: ClientLayout;
-    /** Predefined enum values, triggers select mode */
-    enum?: string[];
-    /** Example values, triggers select mode */
-    examples?: string[];
-    /** Default value to show in select mode */
-    default?: string | number | boolean;
-    /** Allow null in boolean select options */
-    nullable?: boolean;
-    /** Placeholder text for empty input */
-    placeholder?: string;
-    /** Show required indicator */
-    required?: boolean;
-    /** Enable color picker extension */
-    colorPicker?: boolean;
-    /** Show line numbers in editor */
-    lineNumbers?: boolean;
-    /** Enable linting */
-    lint?: boolean;
-    /** Enable line wrapping */
-    lineWrapping?: boolean;
-    /** CodeMirror language mode */
-    language?: CodeMirrorLanguage;
-    /** Additional CodeMirror extensions */
-    extensions?: Extension[];
-    /** Disable tab key for indentation */
-    disableTabIndent?: boolean;
-    /** Disable enter key */
-    disableEnter?: boolean;
-    /** Disable automatic bracket closing */
-    disableCloseBrackets?: boolean;
-    /** Emit submit event on blur */
-    emitOnBlur?: boolean;
-    /** Enable environment variable pills */
-    withVariables?: boolean;
-    /** Detect and emit curl commands */
-    importCurl?: boolean;
-    /** Emit change event even if the value is the same */
-    alwaysEmitChange?: boolean;
-    /** Custom change handler, prevents default emit */
-    handleFieldChange?: (value: string) => void;
-    /** Custom submit handler, prevents default emit */
-    handleFieldSubmit?: (value: string) => void;
-}> & Readonly<{
-    onSubmit?: ((value: string) => any) | undefined;
-    onRedirectToEnvironment?: (() => any) | undefined;
-    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
-    onBlur?: ((value: string) => any) | undefined;
-    onCurl?: ((value: string) => any) | undefined;
-}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, {
-    warning?: (props: {}) => any;
-} & {
-    icon?: (props: {}) => any;
-}>;
-export default _default;
-type __VLS_WithSlots<T, S> = T & {
-    new (): {
-        $slots: S;
+export type CodeInputModelValue = string | number | boolean | Array<string | number | boolean> | Record<string, unknown>;
+/**
+ * CodeInput
+ *
+ * A versatile input component that adapts its rendering based on props:
+ * - Disabled mode: Read-only text display
+ * - Select mode: Dropdown for enums, booleans, or examples
+ * - Editor mode: CodeMirror with environment variable support
+ *
+ * Type `{{` to trigger environment variable autocomplete when an environment is provided.
+ *d
+ * @example
+ * ```vue
+ * <!-- Basic input with environment variables -->
+ * <CodeInput v-model="value" :environment="env" />
+ *
+ * <!-- Boolean select -->
+ * <CodeInput v-model="flag" type="boolean" />
+ *
+ * <!-- JSON editor with linting -->
+ * <CodeInput v-model="data" language="json" :lint="true" />
+ * ```
+ */
+declare const _default: <T extends CodeInputModelValue>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{
+        readonly onSubmit?: ((value: string) => any) | undefined;
+        readonly onRedirectToEnvironment?: (() => any) | undefined;
+        readonly "onUpdate:modelValue"?: ((value: T) => any) | undefined;
+        readonly onBlur?: ((value: string) => any) | undefined;
+        readonly onCurl?: ((value: string) => any) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onBlur" | "onSubmit" | "onUpdate:modelValue" | "onCurl" | "onRedirectToEnvironment"> & {
+        modelValue: T;
+        /** Environment for variable substitution. Pass undefined to disable environment variables */
+        environment: XScalarEnvironment | undefined;
+        /** Type of the input value, affects rendering mode for booleans */
+        type?: string | string[];
+        /** Render as disabled text display */
+        disabled?: boolean;
+        /** Show error styling */
+        error?: boolean;
+        /** Layout context affects styling and behavior */
+        layout?: ClientLayout;
+        /** Predefined enum values, triggers select mode */
+        enum?: string[];
+        /** Example values, triggers select mode */
+        examples?: string[];
+        /** Default value to show in select mode */
+        default?: T;
+        /** Allow null in boolean select options */
+        nullable?: boolean;
+        /** Placeholder text for empty input */
+        placeholder?: string;
+        /** Show required indicator */
+        required?: boolean;
+        /** Enable color picker extension */
+        colorPicker?: boolean;
+        /** Show line numbers in editor */
+        lineNumbers?: boolean;
+        /** Enable linting */
+        lint?: boolean;
+        /** Enable line wrapping */
+        lineWrapping?: boolean;
+        /** CodeMirror language mode */
+        language?: CodeMirrorLanguage;
+        /** Additional CodeMirror extensions */
+        extensions?: Extension[];
+        /** Disable tab key for indentation */
+        disableTabIndent?: boolean;
+        /** Disable enter key */
+        disableEnter?: boolean;
+        /** Disable automatic bracket closing */
+        disableCloseBrackets?: boolean;
+        /** Emit submit event on blur */
+        emitOnBlur?: boolean;
+        /** Enable environment variable pills */
+        withVariables?: boolean;
+        /** Detect and emit curl commands */
+        importCurl?: boolean;
+        /** Emit change event even if the value is the same */
+        alwaysEmitChange?: boolean;
+        /** Custom change handler, prevents default emit */
+        handleFieldChange?: (value: T) => void;
+        /** Custom submit handler, prevents default emit */
+        handleFieldSubmit?: (value: string) => void;
+    } & Partial<{}>> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{
+        /**
+         * Focus the codemirror element
+         *
+         * @param cursorAtEnd boolean place the cursor at the end of the input
+         */
+        focus: (position?: "start" | "end" | number) => void;
+        isFocused: Ref<boolean, boolean>;
+        handleChange: (value: string) => void;
+        handleSubmit: (value: string) => void;
+        handleBlur: (value: string) => void;
+        booleanOptions: import("vue").ComputedRef<string[]>;
+        codeMirror: Ref<import("@codemirror/view").EditorView | null, import("@codemirror/view").EditorView | null>;
+        modelValue: T;
+        cursorPosition: () => number | undefined;
+        serializeValue: (value: T) => string;
+        deserializeValue: (value: string) => T;
+    }>): void;
+    attrs: any;
+    slots: {
+        warning?: (props: {}) => any;
+    } & {
+        icon?: (props: {}) => any;
     };
+    emit: ((evt: "submit", value: string) => void) & ((evt: "redirectToEnvironment") => void) & ((evt: "update:modelValue", value: T) => void) & ((evt: "blur", value: string) => void) & ((evt: "curl", value: string) => void);
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
 };
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};
 //# sourceMappingURL=CodeInput.vue.d.ts.map

package/dist/v2/components/code-input/CodeInput.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CodeInput.vue.d.ts","sourceRoot":"","sources":["../../../../src/v2/components/code-input/CodeInput.vue"],"names":[],"mappings":"AA4oBA,OAAO,EAIL,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACf,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AAEnH,OAAO,EAAyC,KAAK,GAAG,EAAE,MAAM,KAAK,CAAA;AAIrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;;gBAcvC,MAAM,GAAG,MAAM,GAAG,OAAO;IACrC,6FAA6F;iBAChF,kBAAkB,GAAG,SAAS;IAC3C,mEAAmE;WAC5D,MAAM,GAAG,MAAM,EAAE;IACxB,sCAAsC;eAC3B,OAAO;IAClB,yBAAyB;YACjB,OAAO;IACf,kDAAkD;aACzC,YAAY;IACrB,mDAAmD;WAC5C,MAAM,EAAE;IACf,2CAA2C;eAChC,MAAM,EAAE;IACnB,2CAA2C;;IAE3C,2CAA2C;eAChC,OAAO;IAClB,uCAAuC;kBACzB,MAAM;IACpB,8BAA8B;eACnB,OAAO;IAClB,oCAAoC;kBACtB,OAAO;IACrB,kCAAkC;kBACpB,OAAO;IACrB,qBAAqB;WACd,OAAO;IACd,2BAA2B;mBACZ,OAAO;IACtB,+BAA+B;eACpB,kBAAkB;IAC7B,uCAAuC;iBAC1B,SAAS,EAAE;IACxB,sCAAsC;uBACnB,OAAO;IAC1B,wBAAwB;mBACT,OAAO;IACtB,wCAAwC;2BACjB,OAAO;IAC9B,gCAAgC;iBACnB,OAAO;IACpB,wCAAwC;oBACxB,OAAO;IACvB,oCAAoC;iBACvB,OAAO;IACpB,sDAAsD;uBACnC,OAAO;IAC1B,mDAAmD;wBAC/B,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;IAC3C,mDAAmD;wBAC/B,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;;IAuR3C;;;;OAIG;uBACgB,OAAO,GAAG,KAAK,GAAG,MAAM;;0BAlMhB,MAAM,KAAG,IAAI;0BAiCb,MAAM,KAAG,IAAI;wBAWf,MAAM,KAAG,IAAI;;;;;;;;;;;;gBA1L1B,MAAM,GAAG,MAAM,GAAG,OAAO;IACrC,6FAA6F;iBAChF,kBAAkB,GAAG,SAAS;IAC3C,mEAAmE;WAC5D,MAAM,GAAG,MAAM,EAAE;IACxB,sCAAsC;eAC3B,OAAO;IAClB,yBAAyB;YACjB,OAAO;IACf,kDAAkD;aACzC,YAAY;IACrB,mDAAmD;WAC5C,MAAM,EAAE;IACf,2CAA2C;eAChC,MAAM,EAAE;IACnB,2CAA2C;;IAE3C,2CAA2C;eAChC,OAAO;IAClB,uCAAuC;kBACzB,MAAM;IACpB,8BAA8B;eACnB,OAAO;IAClB,oCAAoC;kBACtB,OAAO;IACrB,kCAAkC;kBACpB,OAAO;IACrB,qBAAqB;WACd,OAAO;IACd,2BAA2B;mBACZ,OAAO;IACtB,+BAA+B;eACpB,kBAAkB;IAC7B,uCAAuC;iBAC1B,SAAS,EAAE;IACxB,sCAAsC;uBACnB,OAAO;IAC1B,wBAAwB;mBACT,OAAO;IACtB,wCAAwC;2BACjB,OAAO;IAC9B,gCAAgC;iBACnB,OAAO;IACpB,wCAAwC;oBACxB,OAAO;IACvB,oCAAoC;iBACvB,OAAO;IACpB,sDAAsD;uBACnC,OAAO;IAC1B,mDAAmD;wBAC/B,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;IAC3C,mDAAmD;wBAC/B,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;;;;;;;;cA8mB/B,CAAC,KAAK,IAAiB,KAAK,GAAG;;WAClC,CAAC,KAAK,IAAiB,KAAK,GAAG;;AA3qB1C,wBA+tBC;AAOD,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}
+{"version":3,"file":"CodeInput.vue.d.ts","sourceRoot":"","sources":["../../../../src/v2/components/code-input/CodeInput.vue"],"names":[],"mappings":"AA4tBA,OAAO,EAIL,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACf,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AAEnH,OAAO,EAAyC,KAAK,GAAG,EAAE,MAAM,KAAK,CAAA;AAIrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAKrD,MAAM,MAAM,mBAAmB,GAC3B,MAAM,GACN,MAAM,GACN,OAAO,GACP,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B;;;;;;;;;;;;;;;;;;;;;GAqBG;yBACc,CAAC,SAAS,mBAAmB,EAC7C,aAAa,WAAW,CAAC,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,EAC9D,YAAY,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,EAC3G,eAAe,WAAW,CAAC,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,EACjE;WA0wBO,mBAAmB,CAAC;;;;;;;oBAlwBd,CAAC;QACb,6FAA6F;qBAChF,kBAAkB,GAAG,SAAS;QAC3C,mEAAmE;eAC5D,MAAM,GAAG,MAAM,EAAE;QACxB,sCAAsC;mBAC3B,OAAO;QAClB,yBAAyB;gBACjB,OAAO;QACf,kDAAkD;iBACzC,YAAY;QACrB,mDAAmD;eAC5C,MAAM,EAAE;QACf,2CAA2C;mBAChC,MAAM,EAAE;QACnB,2CAA2C;;QAE3C,2CAA2C;mBAChC,OAAO;QAClB,uCAAuC;sBACzB,MAAM;QACpB,8BAA8B;mBACnB,OAAO;QAClB,oCAAoC;sBACtB,OAAO;QACrB,kCAAkC;sBACpB,OAAO;QACrB,qBAAqB;eACd,OAAO;QACd,2BAA2B;uBACZ,OAAO;QACtB,+BAA+B;mBACpB,kBAAkB;QAC7B,uCAAuC;qBAC1B,SAAS,EAAE;QACxB,sCAAsC;2BACnB,OAAO;QAC1B,wBAAwB;uBACT,OAAO;QACtB,wCAAwC;+BACjB,OAAO;QAC9B,gCAAgC;qBACnB,OAAO;QACpB,wCAAwC;wBACxB,OAAO;QACvB,oCAAoC;qBACvB,OAAO;QACpB,sDAAsD;2BACnC,OAAO;QAC1B,mDAAmD;4BAC/B,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI;QACtC,mDAAmD;4BAC/B,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;QA8sBoB,OAAO,IAAsB,CAAC,4BAA2B;oBACzG,OAAO,KAAK,EAAE,gBAAgB;QAxY7C;;;;WAIG;2BACgB,OAAO,GAAG,KAAK,GAAG,MAAM;;8BApPhB,MAAM,KAAG,IAAI;8BAuCb,MAAM,KAAG,IAAI;4BAWf,MAAM,KAAG,IAAI;;;;;gCA2DT,CAAC,KAAG,MAAM;kCAeR,MAAM,KAAG,CAAC;MA2f0B,GAAG,IAAI;WACpE,GAAG;;kBA3CG,CAAC,KAAK,IAAiB,KAAK,GAAG;;eAClC,CAAC,KAAK,IAAiB,KAAK,GAAG;;;EA8CtC,KACQ,OAAO,KAAK,EAAE,KAAK,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC,OAAO,WAAW,CAAC,CAAA;CAAE;AArxBzE,wBAsxBC;AACD,KAAK,mBAAmB,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAG,GAAG,EAAE,CAAC"}

package/dist/v2/components/code-input/CodeInput.vue.js

@@ -2,7 +2,7 @@ import o from "./CodeInput.vue2.js";
 /* empty css               */
 /* empty css               */
 import t from "../../../_virtual/_plugin-vue_export-helper.js";
-const d = /* @__PURE__ */ t(o, [["__scopeId", "data-v-bd9d3fab"]]);
+const a = /* @__PURE__ */ t(o, [["__scopeId", "data-v-d6129762"]]);
 export {
-  d as default
+  a as default
 };