qmap-forms 0.0.0-stage → 1.0.0

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types/qmap';
+export * from './services/question-provider';
+export * from './services/question-validator';
+export * as Question from './components/Question.vue';

package/src/lib.d.ts

@@ -0,0 +1,45 @@
+import { QuestionValidator } from './services/question-validator';
+import { type Component, type Ref } from 'vue';
+import type { QMAP, QMapEvent } from './types';
+import { Observable } from 'rxjs';
+interface FormOptions {
+    showSubmit?: boolean;
+    showReset?: boolean;
+    showCancel?: boolean;
+    scrollPane?: boolean;
+    validator?: QuestionValidator;
+    extras?: any;
+    onSubmit?: ((a: any) => void);
+    onCancel?: (() => void);
+    onReset?: (() => void);
+}
+interface FormInstance {
+    /**
+     * The Vue form component
+     */
+    form: Component;
+    /**
+     * Input model wrapped in a vue ref
+     */
+    model: Ref<any>;
+    /**
+     * Fires full object whenever it changes
+     */
+    state: Observable<any>;
+    /**
+     * fires delta event of field that changes and value of that field
+     */
+    events: Observable<{
+        e: QMapEvent;
+        v: any;
+    }>;
+}
+declare function mount(id: string | HTMLElement, qmaps: QMAP[], model: any, option?: FormOptions): FormInstance;
+export * from './types/qmap';
+declare const _default: {
+    QuestionValidator: typeof QuestionValidator;
+    Question: import("vue").DefineComponent<{}, {}, any>;
+    Form: import("vue").DefineComponent<{}, {}, any>;
+    mount: typeof mount;
+};
+export default _default;

package/src/services/question-provider.d.ts

@@ -0,0 +1,8 @@
+export interface QuestionProvider {
+    questionTypes: {
+        [type: string]: any;
+    };
+    keyPairs?: {
+        [type: string]: any;
+    };
+}

package/src/services/question-validator.d.ts

@@ -0,0 +1,25 @@
+import { BehaviorSubject, Subject } from "rxjs";
+import type { QMAP, QMapEvent } from "../types/qmap";
+export declare class QuestionValidator {
+    readonly invalidFields: BehaviorSubject<QMAP[]>;
+    readonly isValid: BehaviorSubject<boolean>;
+    protected qMaps: QMAP[];
+    protected requiredQMaps: QMAP[];
+    protected children: QuestionValidator[];
+    protected baseQMaps: QMAP[];
+    readonly changeEvents: Subject<QMapEvent>;
+    protected model: any;
+    protected activeQMAPS: Map<string, QMAP>;
+    constructor(_baseQMaps: QMAP[], _model: any);
+    setQMAPs(q: QMAP[]): void;
+    setModel(m: any): void;
+    setQMAPsAndModel(q: QMAP[], m: any): void;
+    updateEvent(ev?: QMapEvent): void;
+    addChild(v: QuestionValidator): void;
+    removeChild(v: QuestionValidator): void;
+    nestedTypes: string[];
+    flattenNode(q: QMAP): QMAP[];
+    flattenQMAPs(schema: QMAP[]): QMAP[];
+    close(): void;
+    get currentQMaps(): QMAP[];
+}

package/src/services/scoped.d.ts

@@ -0,0 +1,5 @@
+import { type Ref } from 'vue';
+import type { QMAP } from '../types/qmap';
+export declare const MyScopeKey: unique symbol;
+export declare function provideBadQMAPS(s: Ref<Set<QMAP>>): void;
+export declare function useBadQMAPS(): Ref<Set<QMAP>>;

package/src/types/qmap.d.ts

@@ -0,0 +1,108 @@
+import type { QuestionProvider } from '../services/question-provider';
+import type { QuestionValidator } from '../services/question-validator';
+export type QMAP = {
+    id: string;
+    type: string;
+    title?: string;
+    subtitle?: string;
+    required?: boolean;
+    default?: any;
+    groups?: {
+        name: string;
+        icon?: string;
+        items: QMAP[];
+        guid?: string;
+        scope?: {
+            hideOn?: string[];
+        };
+    }[];
+    items?: QMAP[];
+    item?: QMAP;
+    values?: {
+        title?: string;
+        value: any;
+        icon?: string;
+        colour?: string;
+        default?: boolean;
+        weight?: number;
+        onSelect?: QMAP[];
+        guid?: string;
+    }[];
+    readOnly?: boolean;
+    obj_type?: string;
+    filter?: any;
+    style?: string;
+    colour?: string;
+    icon?: string;
+    scope?: {
+        hideOn?: string[];
+        readOnlyOn?: string[];
+    };
+    min?: number;
+    max?: number;
+    onValue?: QMAP[];
+    pos?: string;
+    neg?: string;
+    onPos?: QMAP[];
+    onNeg?: QMAP[];
+    ui?: any;
+    guid?: string;
+    config?: {
+        id: string;
+        title: string;
+        obj_type: string;
+        template?: string;
+        showAll?: boolean;
+        addTemplates?: {
+            name: string;
+            items: {
+                startDate: number;
+                endDate: number;
+                name?: string;
+                status?: string;
+            }[];
+        }[];
+    }[];
+    timeline?: {
+        mode?: {
+            scale: 'hour' | 'minute' | 'day';
+            step: number;
+        };
+        hideBefore?: string;
+        hideAfter?: string;
+        template?: string;
+        defaultDuration?: number;
+        timeSettings?: any;
+    };
+};
+export interface QuestionProps {
+    qMap: QMAP;
+    extras?: any;
+    modelValue?: any;
+    provider?: QuestionProvider;
+    validator?: QuestionValidator;
+    readOnly?: boolean;
+    lite?: boolean;
+}
+export interface QMapEvent {
+    qMap: QMAP;
+    value: any;
+}
+export interface QuestionEmits {
+    (e: 'update:model-value', v: any): void;
+    (e: 'change', v: QMapEvent, m: any): void;
+}
+export interface QuestionWidgetEmits {
+    (e: 'qmap_change', v: QMapEvent): void;
+    (e: 'qmap_subquestions', v?: QMAP[]): void;
+}
+export interface QuestionWidgetProps {
+    qMap: QMAP;
+    extras?: any;
+    model?: any;
+    provider?: QuestionProvider;
+    validator?: QuestionValidator;
+    readOnly?: boolean;
+    lite?: boolean;
+    style?: string;
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.