x4js 1.5.40 → 1.6.0

package/lib/types/datastore.d.ts

@@ -1,396 +0,0 @@
-/**
-*  ___  ___ __
-*  \  \/  /  / _
-*   \    /  /_| |_
-*   /    \____   _|
-*  /__/\__\   |_|
-*
-* @file datastore.ts
-* @author Etienne Cochard
-*
-* Copyright (c) 2019-2022 R-libre ingenierie
-*
-* Permission is hereby granted, free of charge, to any person obtaining a copy
-* of this software and associated documentation files (the "Software"), to deal
-* in the Software without restriction, including without limitation the rights
-* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-* of the Software, and to permit persons to whom the Software is furnished to do so,
-* subject to the following conditions:
-* The above copyright notice and this permission notice shall be included in all copies
-* or substantial portions of the Software.
-*
-* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-**/
-import { BasicEvent, EvChange, EventSource, EventMap } from './x4events';
-import { BaseComponent, BaseComponentEventMap, BaseComponentProps } from './base_component';
-export type ChangeCallback = (type: string, id?: any) => void;
-export type CalcCallback = () => string;
-export type FieldType = 'string' | 'int' | 'float' | 'date' | 'bool' | 'array' | 'object' | 'any' | 'calc';
-export type DataIndex = Uint32Array;
-export interface EvDataChange extends BasicEvent {
-    type: string;
-    id: any;
-}
-export declare function EvDataChange(type: 'create' | 'update' | 'delete' | 'data' | 'change', id?: any): EvDataChange;
-/**
- * fields definition
- * 	field with index=0 is record id
- */
-export interface MetaData {
-    type?: FieldType;
-    prec?: number;
-    required?: boolean;
-    calc?: (rec: Record) => any;
-    model?: Record;
-}
-export interface FieldInfo extends MetaData {
-    name: string;
-}
-export declare namespace data {
-    /**
-     * define a record id
-     * @example
-     *	\@data_id()
-     *  id: string; // this field is the record id
-     **/
-    export function id(): (ownerCls: any, fldName: any) => void;
-    /**
-     * @ignore
-     */
-    export function field(data: MetaData): (ownerCls: any, fldName: any) => void;
-    /**
-     * following member is a string field
-     * @example
-     * \@data_string()
-     * my_field: string;	// this field will be seen as a string
-     */
-    export function string(props?: MetaData): (ownerCls: any, fldName: any) => void;
-    /**
-     * following member is an integer field
-     * @example
-     * \@data_string()
-     * my_field: number;	// this field will be seen as an integer
-     */
-    export function int(props?: MetaData): (ownerCls: any, fldName: any) => void;
-    /**
-     * following member is a float field
-     * @example
-     * \@data_float()
-     * my_field: number;	// this field will be seen as a float
-     */
-    export function float(props?: MetaData): (ownerCls: any, fldName: any) => void;
-    /**
-     * following member is a boolean field
-     * @example
-     * \@data_bool()
-     * my_field: boolean;	// this field will be seen as a boolean
-     */
-    export function bool(props?: MetaData): (ownerCls: any, fldName: any) => void;
-    /**
-     * following member is a date field
-     * @example
-     * \@data_date()
-     * my_field: date;	// this field will be seen as a date
-     */
-    export function date(props?: MetaData): (ownerCls: any, fldName: any) => void;
-    /**
-     * following member is a calculated field
-     * @example
-     * \@data_calc( )
-     * get my_field(): string => {
-     * 	return 'hello';
-     * };
-     */
-    export function calc(props?: MetaData): (ownerCls: any, fldName: any) => void;
-    /**
-     *
-     */
-    interface RecordConstructor {
-        new (data?: any, id?: any): Record;
-    }
-    /**
-     * following member is a record array
-     * @example
-     * \@data_array( )
-     * my_field(): TypedRecord[];
-     */
-    export function array(ctor: RecordConstructor, props?: MetaData): (ownerCls: any, fldName: any) => void;
-    export {};
-}
-/**
- * record model
- */
-export declare class Record {
-    constructor(data?: any, id?: any);
-    clone(source?: any): any;
-    /**
-     * get the record unique identifier
-     * by default the return value is the first field
-     * @return unique identifier
-     */
-    getID(): any;
-    /**
-     * MUST IMPLEMENT
-     * @returns fields descriptors
-     */
-    getFields(): FieldInfo[];
-    /**
-     *
-     */
-    validate(): Error[];
-    getFieldIndex(name: string): number;
-    /**
-     * default serializer
-     * @returns an object with known record values
-     */
-    serialize(): any;
-    /**
-     * default unserializer
-     * @param data - input data
-     * @returns a new Record
-     */
-    unSerialize(data: any, id?: any): Record;
-    /**
-     * field conversion
-     * @param field - field descriptor
-     * @param input - value to convert
-     * @returns the field value in it's original form
-     */
-    protected _convertField(field: FieldInfo, input: any): any;
-    /**
-     * get raw value of a field
-     * @param name - field name or field index
-     */
-    getRaw(name: string | number): any;
-    /**
-     *
-     * @param name
-     * @param data
-     */
-    setRaw(name: string, data: string): void;
-    /**
-     * get field value (as string)
-     * @param name - field name
-     * @example
-     * let value = record.get('field1');
-     */
-    getField(name: string): string;
-    /**
-     * set field value
-     * @param name - field name
-     * @param value - value to set
-     * @example
-     * record.set( 'field1', 7 );
-     */
-    setField(name: string, value: any): void;
-}
-/**
- * by default, the field id is rhe first member or the record
- */
-export declare class AutoRecord extends Record {
-    private m_data;
-    private m_fid;
-    constructor(data: any);
-    getID(): any;
-    getFields(): FieldInfo[];
-    getRaw(name: string): string;
-    setRaw(name: string, data: string): void;
-    clone(data: any): AutoRecord;
-}
-/**
- *
- */
-interface DataEventMap extends BaseComponentEventMap {
-    change?: EvChange;
-}
-type DataSolver = (data: any) => Record[];
-export interface DataProxyProps extends BaseComponentProps<DataEventMap> {
-    url: string;
-    params?: string[];
-    solver?: DataSolver;
-}
-export declare class DataProxy extends BaseComponent<DataProxyProps, DataEventMap> {
-    constructor(props: DataProxyProps);
-    load(url?: string): Promise<void>;
-}
-/**
- *
- */
-interface DataStoreProps<T extends Record> extends BaseComponentProps<DataStoreEventMap> {
-    model: T;
-    data?: T[];
-    url?: string;
-    autoload?: false;
-}
-interface DataStoreEventMap extends EventMap {
-    data_change: EvDataChange;
-}
-/**
- *
- */
-export declare class DataStore<T extends Record = Record> extends EventSource<DataStoreEventMap> {
-    protected m_model: T;
-    protected m_fields: FieldInfo[];
-    protected m_records: T[];
-    protected m_proxy: DataProxy;
-    protected m_rec_index: DataIndex;
-    constructor(props: DataStoreProps<T>);
-    /**
-     *
-     * @param records
-     */
-    load(url?: string): Promise<void>;
-    reload(): Promise<void>;
-    /**
-     * convert raw objects to real records from model
-     * @param records
-     */
-    setData(records: any[]): void;
-    /**
-     * just set the records
-     * @param records - must be of the same type as model
-     */
-    setRawData(records: T[]): void;
-    private _rebuildIndex;
-    /**
-     *
-     */
-    update(rec: T): boolean;
-    /**
-     *
-     * @param data
-     */
-    append(rec: T | any): void;
-    /**
-     *
-     */
-    getMaxId(): any;
-    /**
-     *
-     * @param id
-     */
-    delete(id: any): boolean;
-    /**
-     * return the number of records
-     */
-    get count(): number;
-    /**
-     * return the fields
-     */
-    get fields(): FieldInfo[];
-    /**
-     * find the index of the element with the given id
-     */
-    indexOfId(id: any): number;
-    /**
-     * return the record by it's id
-     * @returns record or null
-     */
-    getById(id: any): T;
-    /**
-     * return a record by it's index
-     * @returns record or null
-     */
-    getByIndex(index: number): T;
-    private _getRecord;
-    moveTo(other: DataStore<T>): void;
-    /**
-     * create a new view on the DataStore
-     * @param opts
-     */
-    createView(opts?: DataViewProps<T>): DataView<T>;
-    /**
-     *
-     */
-    createIndex(filter: FilterInfo): DataIndex;
-    sortIndex(index: DataIndex, sort: SortProp[]): Uint32Array;
-    /**
-     *
-     */
-    forEach(cb: (rec: T, index: number) => any): void;
-    export(): T[];
-    changed(): void;
-}
-export interface EvViewChange extends BasicEvent {
-    action: string;
-}
-export declare function EvViewChange(action: 'filter' | 'sort' | 'change'): EvViewChange;
-interface DataViewEventMap extends BaseComponentEventMap {
-    view_change: EvViewChange;
-}
-interface DataViewProps<T extends Record> extends BaseComponentProps<DataViewEventMap> {
-    store?: DataStore<T>;
-    filter?: FilterInfo;
-    order?: string | SortProp[] | SortProp;
-}
-export type FilterFunc = (rec: Record) => boolean;
-export interface FilterInfo {
-    op: '<' | '<=' | '=' | '>=' | '>' | '<>' | 'empty-result' | FilterFunc;
-    field?: string;
-    value?: string | RegExp;
-    caseSensitive?: boolean;
-}
-export interface SortProp {
-    field: string;
-    ascending: boolean;
-}
-/**
- * Dataview allow different views of the DataStore.
- * You can sort the columns & filter data
- * You can have multiple views for a single DataStore
- */
-export declare class DataView<T extends Record = Record> extends BaseComponent<DataViewProps<T>, DataViewEventMap> {
-    protected m_index: DataIndex;
-    protected m_store: DataStore<T>;
-    protected m_sort: SortProp[];
-    protected m_filter: FilterInfo;
-    constructor(props: DataViewProps<T>);
-    private _storeChange;
-    /**
-     *
-     * @param filter
-     */
-    filter(filter?: FilterInfo): number;
-    private _filter;
-    /**
-     *
-     * @param columns
-     * @param ascending
-     */
-    sort(props: SortProp[]): void;
-    private _sort;
-    /**
-     *
-     */
-    get store(): DataStore<T>;
-    /**
-     *
-     */
-    get count(): number;
-    /**
-     *
-     * @param id
-     */
-    indexOfId(id: any): number;
-    /**
-     *
-     * @param index
-     */
-    getByIndex(index: number): T;
-    /**
-     *
-     * @param id
-     */
-    getById(id: any): T;
-    changed(): void;
-    /**
-     *
-     */
-    forEach(cb: (rec: T, index: number) => any): void;
-}
-export {};

package/lib/types/dialog.d.ts

@@ -1,175 +0,0 @@
-/**
-*  ___  ___ __
-*  \  \/  /  / _
-*   \    /  /_| |_
-*   /    \____   _|
-*  /__/\__\   |_|
-*
-* @file dialog.ts
-* @author Etienne Cochard
-*
-* Copyright (c) 2019-2022 R-libre ingenierie
-*
-* Permission is hereby granted, free of charge, to any person obtaining a copy
-* of this software and associated documentation files (the "Software"), to deal
-* in the Software without restriction, including without limitation the rights
-* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-* of the Software, and to permit persons to whom the Software is furnished to do so,
-* subject to the following conditions:
-* The above copyright notice and this permission notice shall be included in all copies
-* or substantial portions of the Software.
-*
-* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-**/
-import { Popup, PopupProps, PopupEventMap } from './popup';
-import { IconID } from './icon';
-import { Label } from './label';
-import { Form, FormButtons } from './form';
-import { Component, ComponentContent } from './component';
-import { BasicEvent, EventCallback } from './x4events';
-import { Rect, Size } from './tools';
-interface Geometry {
-    left: number;
-    top: number;
-    width: number;
-    height: number;
-    minimized: boolean;
-    maximized: boolean;
-}
-export interface EvClose extends BasicEvent {
-}
-export interface EvBtnClick extends BasicEvent {
-    button: string;
-}
-export declare function EvBtnClick(button: string): EvBtnClick;
-export interface DialogBoxEventMap extends PopupEventMap {
-    close: EvClose;
-    btnClick: EvBtnClick;
-}
-export type InitFormCallback = () => Form;
-export interface DialogProps<E extends DialogBoxEventMap = DialogBoxEventMap> extends PopupProps<E> {
-    title?: string;
-    icon?: IconID;
-    buttons?: FormButtons;
-    btnClick?: EventCallback<EvBtnClick>;
-    closable?: boolean;
-    movable?: boolean;
-    maximized?: boolean;
-    maximizable?: boolean;
-    minimizable?: boolean;
-    autoClose?: boolean;
-    width?: number;
-    height?: number;
-    dlgWidth?: number;
-    dlgHeight?: number;
-    form?: Form | InitFormCallback;
-    disableSuggestions?: boolean;
-}
-/**
- * Standard dialog class
- */
-export declare class Dialog<P extends DialogProps = DialogProps, E extends DialogBoxEventMap = DialogBoxEventMap> extends Popup<P, E> {
-    protected m_icon: IconID;
-    protected m_title: string;
-    protected m_form: Form;
-    protected m_buttons: FormButtons;
-    protected m_closable: boolean;
-    protected m_movable: boolean;
-    protected m_maximized: boolean;
-    protected m_minimized: boolean;
-    protected m_maximizable: boolean;
-    protected m_minimizable: boolean;
-    protected m_minFormSize: Size;
-    protected m_rc_max: Rect;
-    protected m_rc_min: Rect;
-    protected m_el_title: Component;
-    protected m_last_down: number;
-    protected m_auto_close: boolean;
-    protected m_ui_title: Label;
-    protected m_form_cb: InitFormCallback;
-    constructor(props: P);
-    /**
-     *
-     */
-    componentCreated(): void;
-    /**
-     *
-     */
-    private _handleClick;
-    /**
-     * restore the geometry
-     */
-    setGeometry(geom: Geometry): void;
-    /**
-     * return the geometry (usefull to save state)
-     */
-    getGeometry(): Geometry;
-    /**
-     * resize the dialog
-     * @param width
-     * @param height
-     */
-    setSize(width: number, height: number): void;
-    /** @ignore */
-    render(): void;
-    /**
-     * change the dialog content
-     * @param els
-     * @param refreshAll
-     */
-    setContent(els: ComponentContent, refreshAll?: boolean): void;
-    /**
-     * change the dialog buttons
-     * @param buttons
-     */
-    setButtons(buttons: FormButtons): void;
-    /**
-     * return the dialog form
-     */
-    get form(): Form;
-    /**
-     * close the dialog
-     */
-    close(): void;
-    /**
-     *
-     */
-    private _toggleMax;
-    /**
-     *
-     */
-    private _toggleMin;
-    /**
-     *
-     */
-    private _mouseDown;
-    /**
-     * maximize the dialog
-     */
-    maximize(): void;
-    /**
-     *
-     */
-    private _maximize;
-    /**
-     * minimize the dialog
-     */
-    minimize(): void;
-    /**
-     *
-     */
-    private _minimize;
-    /**
-     * change the dialog title
-     */
-    set title(title: string);
-    itemWithName<T extends Component>(name: string): T;
-    getValues(): any;
-    validate(): boolean;
-}
-export {};