@qodalis/vue-cli 2.0.0-beta.2 → 2.0.0-beta.21

package/dist/index.d.ts

@@ -0,0 +1,354 @@
+import * as vue from 'vue';
+import { PropType, VNode, InjectionKey, Ref } from 'vue';
+import { ICliModule, ICliCommandProcessor, CliEngineSnapshot, CliPanelConfig, CliPanelPosition } from '@qodalis/cli-core';
+import { CliEngineOptions, CliEngine, CreateCliEngineConfig } from '@qodalis/cli';
+export { CliEngine, CliEngineOptions } from '@qodalis/cli';
+
+/**
+ * Props accepted by the Vue `Cli` component.
+ */
+interface CliProps {
+    modules?: ICliModule[];
+    processors?: ICliCommandProcessor[];
+    options?: CliEngineOptions;
+    services?: Record<string, any>;
+    snapshot?: CliEngineSnapshot;
+    style?: Record<string, string>;
+    class?: string;
+}
+declare const Cli: vue.DefineComponent<vue.ExtractPropTypes<{
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    options: {
+        type: PropType<CliEngineOptions>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+    snapshot: {
+        type: PropType<CliEngineSnapshot>;
+        default: undefined;
+    };
+    style: {
+        type: PropType<Record<string, string>>;
+        default: undefined;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>, (() => null) | (() => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>), {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "ready"[], "ready", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    options: {
+        type: PropType<CliEngineOptions>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+    snapshot: {
+        type: PropType<CliEngineSnapshot>;
+        default: undefined;
+    };
+    style: {
+        type: PropType<Record<string, string>>;
+        default: undefined;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{
+    onReady?: ((...args: any[]) => any) | undefined;
+}>, {
+    modules: ICliModule[];
+    processors: ICliCommandProcessor[];
+    options: CliEngineOptions;
+    services: Record<string, any>;
+    snapshot: CliEngineSnapshot;
+    style: Record<string, string>;
+    class: string;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+interface CliPanelOptions extends CliEngineOptions, CliPanelConfig {
+}
+declare const CliPanel: vue.DefineComponent<vue.ExtractPropTypes<{
+    options: {
+        type: PropType<CliPanelOptions>;
+        default: undefined;
+    };
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+    onClose: {
+        type: PropType<() => void>;
+        default: undefined;
+    };
+    collapsed: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    hidden: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    maximized: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    activeTabId: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    position: {
+        type: PropType<CliPanelPosition>;
+        default: undefined;
+    };
+    height: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    width: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    style: {
+        type: PropType<Record<string, string>>;
+        default: undefined;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, ("close" | "update:collapsed" | "update:hidden" | "update:maximized" | "update:activeTabId" | "update:position" | "update:height" | "update:width" | "tab-added" | "tab-closed" | "pane-split" | "pane-closed")[], "close" | "update:collapsed" | "update:hidden" | "update:maximized" | "update:activeTabId" | "update:position" | "update:height" | "update:width" | "tab-added" | "tab-closed" | "pane-split" | "pane-closed", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    options: {
+        type: PropType<CliPanelOptions>;
+        default: undefined;
+    };
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+    onClose: {
+        type: PropType<() => void>;
+        default: undefined;
+    };
+    collapsed: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    hidden: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    maximized: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    activeTabId: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    position: {
+        type: PropType<CliPanelPosition>;
+        default: undefined;
+    };
+    height: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    width: {
+        type: NumberConstructor;
+        default: undefined;
+    };
+    style: {
+        type: PropType<Record<string, string>>;
+        default: undefined;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{
+    onClose?: ((...args: any[]) => any) | undefined;
+    "onUpdate:collapsed"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:hidden"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:maximized"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:activeTabId"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:position"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:height"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:width"?: ((...args: any[]) => any) | undefined;
+    "onTab-added"?: ((...args: any[]) => any) | undefined;
+    "onTab-closed"?: ((...args: any[]) => any) | undefined;
+    "onPane-split"?: ((...args: any[]) => any) | undefined;
+    "onPane-closed"?: ((...args: any[]) => any) | undefined;
+}>, {
+    modules: ICliModule[];
+    processors: ICliCommandProcessor[];
+    options: CliPanelOptions;
+    services: Record<string, any>;
+    style: Record<string, string>;
+    class: string;
+    onClose: () => void;
+    collapsed: boolean;
+    hidden: boolean;
+    maximized: boolean;
+    activeTabId: number;
+    position: CliPanelPosition;
+    height: number;
+    width: number;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const CliProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    options: {
+        type: PropType<CliEngineOptions>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+    style: {
+        type: PropType<Record<string, string>>;
+        default: undefined;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "ready"[], "ready", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    options: {
+        type: PropType<CliEngineOptions>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+    style: {
+        type: PropType<Record<string, string>>;
+        default: undefined;
+    };
+}>> & Readonly<{
+    onReady?: ((...args: any[]) => any) | undefined;
+}>, {
+    modules: ICliModule[];
+    processors: ICliCommandProcessor[];
+    options: CliEngineOptions;
+    services: Record<string, any>;
+    style: Record<string, string>;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+interface CliConfigValue {
+    modules?: ICliModule[];
+    processors?: ICliCommandProcessor[];
+    options?: CliEngineOptions;
+    services?: Record<string, any>;
+}
+declare const CliConfigKey: InjectionKey<CliConfigValue>;
+declare const CliConfigProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    options: {
+        type: PropType<CliEngineOptions>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>[] | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    modules: {
+        type: PropType<ICliModule[]>;
+        default: undefined;
+    };
+    processors: {
+        type: PropType<ICliCommandProcessor[]>;
+        default: undefined;
+    };
+    options: {
+        type: PropType<CliEngineOptions>;
+        default: undefined;
+    };
+    services: {
+        type: PropType<Record<string, any>>;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    modules: ICliModule[];
+    processors: ICliCommandProcessor[];
+    options: CliEngineOptions;
+    services: Record<string, any>;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+interface CliContextValue {
+    engine: Ref<CliEngine | null>;
+}
+declare const CliInjectionKey: InjectionKey<CliContextValue>;
+
+declare function useCli(): CliContextValue;
+
+type UseCliEngineConfig = Omit<CreateCliEngineConfig, 'framework'>;
+declare function useCliEngine(containerRef: Ref<HTMLElement | null>, config?: UseCliEngineConfig): Ref<CliEngine | null>;
+
+export { Cli, CliConfigKey, CliConfigProvider, CliInjectionKey, CliPanel, CliProvider, useCli, useCliEngine };
+export type { CliConfigValue, CliContextValue, CliPanelOptions, CliProps, UseCliEngineConfig };