@saltcorn/data 0.6.2 → 0.6.3-beta.0

package/dist/models/field.d.ts

@@ -1,82 +1,67 @@
-export = Field;
+/**
+ * Field Data Access Layer
+ * @category saltcorn-data
+ * @module models/field
+ * @subcategory models
+ */
+import type { Where, SelectOptions, Row } from "@saltcorn/db-common/internal";
+import type { ResultMessage, TypeObj } from "../common_types";
+import type Table from "./table";
 /**
  * Field Class
  * @category saltcorn-data
  */
 declare class Field {
-    /**
-     * Label 2 Name
-     * @param {string} label
-     * @returns {string}
-     */
-    static labelToName(label: string): string;
-    /**
-     *
-     * @param {object} where
-     * @param {object} [selectopts]
-     * @returns {Field[]}
-     */
-    static find(where: object, selectopts?: object | undefined): Field[];
-    /**
-     * @param {object} where
-     * @returns {Promise<Field>}
-     */
-    static findOne(where: object): Promise<Field>;
-    /**
-     * @param {object} fld
-     * @param {boolean} [bare = false]
-     * @returns {Promise<Field>}
-     */
-    static create(fld: object, bare?: boolean | undefined): Promise<Field>;
-    /**
-     * @param {function|object[]} [typeattribs]
-     * @param {number} [table_id]
-     * @returns {*}
-     */
-    static getTypeAttributes(typeattribs?: Function | object[] | undefined, table_id?: number | undefined): any;
-    /**
-     * Constructor
-     * @param o
-     */
-    constructor(o: any);
-    label: any;
-    name: any;
-    fieldview: any;
-    validator: any;
-    showIf: any;
-    parent_field: any;
-    postText: any;
-    class: any;
-    id: any;
-    default: any;
-    sublabel: any;
-    description: any;
-    type: any;
-    typename: any;
-    options: any;
+    label: string;
+    name: string;
+    fieldview?: string;
+    validator: Function;
+    showIf?: boolean;
+    parent_field?: string;
+    postText?: string;
+    class: string;
+    id?: number;
+    default?: string;
+    sublabel?: string;
+    description?: string;
+    type?: string | TypeObj;
+    typename?: string;
+    options?: any;
     required: boolean;
     is_unique: boolean;
-    hidden: any;
+    hidden: boolean;
     disabled: boolean;
     calculated: boolean;
     primary_key: boolean;
     stored: boolean;
-    expression: any;
-    sourceURL: any;
-    is_fkey: any;
-    input_type: any;
-    reftable_name: any;
-    reftype: any;
-    refname: any;
-    reftable: any;
+    expression?: string;
+    sourceURL?: string;
+    is_fkey: boolean;
+    input_type: string;
+    reftable_name?: string;
+    reftype?: string;
+    refname: string;
+    reftable?: Table;
     attributes: any;
-    table_id: any;
-    table: any;
+    table_id?: number;
+    table?: Table;
+    [key: string]: any;
+    /**
+     * Constructor
+     * @param o
+     */
+    constructor(o: FieldCfg | Field);
     /**
      * To Json
      * @type {object}
      */
-    get toJson(): object;
+    get toJson(): any;
+    /**
+     * Label 2 Name
+     * @param {string} label
+     * @returns {string}
+     */
+    static labelToName(label: string): string | undefined;
     /**
      * ???
      * @returns {string}
@@ -88,13 +73,17 @@ declare class Field {
      * @param {object} where
      * @returns {Promise<void>}
      */
-    fill_fkey_options(force_allow_none?: boolean | undefined, where0: any, extraCtx: any): Promise<void>;
+    fill_fkey_options(force_allow_none: boolean | undefined, where0: Where, extraCtx?: any): Promise<void>;
     /**
      * Distinct Values
      * @param {object} [req]
      * @returns {Promise<void>}
      */
-    distinct_values(req?: object | undefined, where: any): Promise<void>;
+    distinct_values(req: any, where: Where): Promise<{
+        label: string;
+        value: string;
+        jsvalue?: boolean;
+    }[]>;
     /**
      * @type {string}
      */
@@ -115,7 +104,19 @@ declare class Field {
      * @param {object} whole_rec
      * @returns {object}
      */
-    validate(whole_rec: object): object;
+    validate(whole_rec: any): ResultMessage;
+    /**
+     *
+     * @param {object} where
+     * @param {object} [selectopts]
+     * @returns {Field[]}
+     */
+    static find(where?: Where, selectopts?: SelectOptions): Promise<Field[]>;
+    /**
+     * @param {object} where
+     * @returns {Promise<Field>}
+     */
+    static findOne(where: Where): Promise<Field>;
     /**
      * @returns {Promise<void>}
      */
@@ -134,7 +135,7 @@ declare class Field {
      * @param {object} new_field
      * @returns {Promise<void>}
      */
-    alter_sql_type(new_field: object): Promise<void>;
+    alter_sql_type(new_field: Field): Promise<void>;
     /**
      * @returns {Promise<void>}
      */
@@ -143,15 +144,19 @@ declare class Field {
      * @param {object} v
      * @returns {Promise<void>}
      */
-    update(v: object): Promise<void>;
+    update(v: Row): Promise<void>;
     /**
      * @type {string}
      */
-    get listKey(): string;
+    get listKey(): any;
     /**
      * @type {object}
      */
-    get presets(): object;
+    get presets(): {
+        LoggedIn: ({ user }: {
+            user: any;
+        }) => boolean;
+    } | null;
     /**
      * @throws {InvalidAdminAction}
      * @returns {Promise<void>}
@@ -161,57 +166,55 @@ declare class Field {
      * @param {object} table
      * @returns {Promise<void>}
      */
-    enable_fkey_constraint(table: object): Promise<void>;
+    enable_fkey_constraint(table: Table): Promise<void>;
+    /**
+     * @param {object} fld
+     * @param {boolean} [bare = false]
+     * @returns {Promise<Field>}
+     */
+    static create(fld: Field, bare?: boolean): Promise<Field>;
+    /**
+     * @param {function|object[]} [typeattribs]
+     * @param {number} [table_id]
+     * @returns {*}
+     */
+    static getTypeAttributes(typeattribs: Function | any, table_id?: number): any;
 }
 declare namespace Field {
-    namespace contract {
-        namespace variables {
-            export const name: any;
-            export const label: any;
-            const _class: any;
-            export { _class as class };
-            export const postText: any;
-            export const sublabel: any;
-            export const fieldview: any;
-            export const parent_field: any;
-            export const reftable_name: any;
-            export const validator: any;
-            export const type: any;
-            export const input_type: any;
-            export const is_fkey: any;
-            export const is_unique: any;
-            export const required: any;
-            export const disabled: any;
-            export const id: any;
-            export const attributes: any;
-            export const table_id: any;
-        }
-        const instance_check: any;
-        namespace methods {
-            export const validate: any;
-            export const toJson: any;
-            export const sql_type: any;
-            export const sql_bare_type: any;
-            export const form_name: any;
-            export const listKey: any;
-            export const presets: any;
-            const _delete: any;
-            export { _delete as delete };
-            export const generate: any;
-            export const add_unique_constraint: any;
-            export const remove_unique_constraint: any;
-            export const toggle_not_null: any;
-            export const fill_table: any;
-            export const update: any;
-            export const fill_fkey_options: any;
-            export const distinct_values: any;
-        }
-        namespace static_methods {
-            const find: any;
-            const findOne: any;
-            const create: any;
-            const labelToName: any;
-        }
-    }
+    type FieldCfg = {
+        label?: string;
+        name?: string;
+        fieldview?: string;
+        validator?: (arg0: any) => boolean;
+        showIf?: boolean;
+        parent_field?: string;
+        postText?: string;
+        class?: string;
+        id?: number;
+        default?: string;
+        sublabel?: string;
+        description?: string;
+        type?: string | TypeObj;
+        options?: any;
+        required?: boolean;
+        is_unique?: boolean;
+        hidden?: boolean;
+        disabled?: boolean;
+        calculated?: boolean;
+        primary_key?: boolean;
+        stored?: boolean;
+        expression?: string;
+        sourceURL?: string;
+        input_type?: "hidden" | "file" | "select" | "fromtype" | "search" | "text" | "password" | "section_header" | "textarea" | "custom_html" | "code";
+        reftable_name?: string;
+        reftable?: Table;
+        attributes?: string;
+        table_id?: number;
+        reftype?: string;
+        refname?: string;
+        table?: Table;
+    };
 }
+declare type FieldCfg = Field.FieldCfg;
+export = Field;
 //# sourceMappingURL=field.d.ts.map

package/dist/models/field.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../models/field.js"],"names":[],"mappings":";AAwBA;;;GAGG;AACH;IAqGE;;;;OAIG;IAGH,0BALW,MAAM,GACJ,MAAM,CAMlB;IAyLD;;;;;OAKG;IACH,mBAJW,MAAM,oCAEJ,KAAK,EAAE,CAKnB;IAED;;;OAGG;IACH,sBAHW,MAAM,GACJ,QAAQ,KAAK,CAAC,CAK1B;IAgND;;;;OAIG;IACH,mBAJW,MAAM,+BAEJ,QAAQ,KAAK,CAAC,CAgG1B;IAED;;;;OAIG;IACH,4GASC;IA3nBD;;;OAGG;IACH,oBAmEC;IAhEC,WAA8B;IAC9B,UAAgD;IAChD,eAA4B;IAC5B,eAA4C;IAC5C,YAAsB;IACtB,kBAAkC;IAClC,cAA0B;IAC1B,WAA0B;IAC1B,QAAc;IACd,aAAwB;IACxB,cAA0B;IAC1B,iBAAgC;IAGhC,UAA0E;IAC1D,cAAsB;IACtC,aAAwB;IACxB,kBAAyC;IACzC,mBAA2C;IAC3C,YAA+B;IAC/B,kBAA4B;IAC5B,oBAAgC;IAChC,qBAAkC;IAClC,gBAAwB;IACxB,gBAA8B;IAC9B,eAA4B;IAE5B,aAG6D;IAG3D,gBAA4C;IAI5C,mBAAgC;IAChC,aAAwB;IACxB,aAAmB;IAMnB,cAA0B;IAQ5B,gBAGwB;IACR,cAA0B;IAGxC,WAAoB;IAMxB;;;OAGG;IACH,qBAqBC;IAaD;;;OAGG;IACH,wBAGC;IAED;;;;;OAKG;IACH,uFAFa,QAAQ,IAAI,CAAC,CAgCzB;IAED;;;;OAIG;IACH,uDAFa,QAAQ,IAAI,CAAC,CA8CzB;IAED;;OAEG;IACH,uBAaC;IAED;;OAEG;IACH,0BAIC;IAED;;OAEG;IACH,4BAQC;IAED;;OAEG;IACH,YAFa,QAAQ,GAAG,CAAC,CAcxB;IAED;;;OAGG;IACH,oBAHW,MAAM,GACJ,MAAM,CAwBlB;IAsBD;;OAEG;IACH,yBAFa,QAAQ,IAAI,CAAC,CAKzB;IAED;;OAEG;IACH,4BAFa,QAAQ,IAAI,CAAC,CAKzB;IAED;;;;OAIG;IACH,0BAHW,OAAO,GACL,QAAQ,IAAI,CAAC,CAazB;IAED;;;OAGG;IACH,0BAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAqCzB;IAED;;OAEG;IACH,cAFa,QAAQ,IAAI,CAAC,CAOzB;IAED;;;OAGG;IACH,UAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAkCzB;IAED;;OAEG;IACH,sBAMC;IAED;;OAEG;IACH,sBAOC;IAED;;;OAGG;IACH,UAFa,QAAQ,IAAI,CAAC,CAqCzB;IAED;;;OAGG;IACH,8BAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;CAsHF"}
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../models/field.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,8BAA8B,CAAC;AAC9E,OAAO,KAAK,EAAgB,aAAa,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE5E,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAajC;;;GAGG;AACH,cAAM,KAAK;IACT,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAM;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,UAAU,EAAE,GAAG,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;IAGd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB;;;OAGG;gBACS,CAAC,EAAE,QAAQ,GAAG,KAAK;IAsE/B;;;OAGG;IACH,IAAI,MAAM,IAAI,GAAG,CAqBhB;IAED;;;;OAIG;IAGH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIrD;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAGtB;IAED;;;;;OAKG;IACG,iBAAiB,CACrB,gBAAgB,qBAAiB,EACjC,MAAM,EAAE,KAAK,EACb,QAAQ,GAAE,GAAQ,GACjB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;OAIG;IACG,eAAe,CACnB,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,GACX,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;IA+CjE;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAsBrB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAKxB;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,CAiB1B;IAED;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAc9B;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,GAAG,GAAG,aAAa;IA6BvC;;;;;OAKG;WACU,IAAI,CACf,KAAK,CAAC,EAAE,KAAK,EACb,UAAU,GAAE,aAAiD,GAC5D,OAAO,CAAC,KAAK,EAAE,CAAC;IAKnB;;;OAGG;WACU,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAKlD;;OAEG;IACG,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAK5C;;OAEG;IACG,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAK/C;;;;OAIG;IACG,eAAe,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBvD;;;OAGG;IACG,cAAc,CAAC,SAAS,EAAE,KAAK;IA4CrC;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,MAAM,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAuCnC;;OAEG;IACH,IAAI,OAAO,IAAI,GAAG,CAOjB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI;QAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE;YAAE,IAAI,EAAE,GAAG,CAAA;SAAE,KAAK,OAAO,CAAA;KAAE,GAAG,IAAI,CAQvE;IAED;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAqC7B;;;OAGG;IACG,sBAAsB,CAAC,KAAK,EAAE,KAAK;IAoBzC;;;;OAIG;WACU,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,GAAE,OAAe,GAAG,OAAO,CAAC,KAAK,CAAC;IAgGtE;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,WAAW,EAAE,QAAQ,GAAG,GAAG,EAAE,QAAQ,CAAC,EAAE,MAAM;CAUxE;AAGD,kBAAU,KAAK,CAAC;IACd,KAAY,QAAQ,GAAG;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC;QACnC,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QACxB,OAAO,CAAC,EAAE,GAAG,CAAC;QACd,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EACP,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,MAAM,GACN,UAAU,GACV,gBAAgB,GAChB,UAAU,GACV,aAAa,GACb,MAAM,CAAC;QACX,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,KAAK,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;CACH;AACD,aAAK,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;AAE/B,SAAS,KAAK,CAAC"}