@saltcorn/data 0.6.2-beta.0 → 0.6.2-beta.4

package/dist/models/table.d.ts

@@ -0,0 +1,326 @@
+export = Table;
+/**
+ * Table class
+ * @category saltcorn-data
+ */
+declare class Table {
+    /**
+     *
+     * Find one Table
+     * @param where - where condition
+     * @returns {*|Table|null} table or null
+     */
+    static findOne(where: any): any | Table | null;
+    /**
+     * Find Tables
+     * @param where - where condition
+     * @param selectopts - options
+     * @returns {Promise<Table[]>} table list
+     */
+    static find(where: any, selectopts?: {
+        orderBy: string;
+        nocase: boolean;
+    }): Promise<Table[]>;
+    /**
+     * Find Tables including external tables
+     * @param where0
+     * @param selectopts
+     * @returns {Promise<object[]>}
+     */
+    static find_with_external(where0?: {}, selectopts?: {
+        orderBy: string;
+        nocase: boolean;
+    }): Promise<object[]>;
+    /**
+     * Create table
+     * @param name - table name
+     * @param options - table fields
+     * @returns {Promise<Table>} table
+     */
+    static create(name: any, options?: {}): Promise<Table>;
+    /**
+     * Table Create from CSV
+     * @param name
+     * @param filePath
+     * @returns {Promise<{error: string}|{error: string}|{error: string}|{error: string}|{error: string}|{success: string}|{error: (string|string|*)}>}
+     */
+    static create_from_csv(name: any, filePath: any): Promise<{
+        error: string;
+    } | {
+        error: string;
+    } | {
+        error: string;
+    } | {
+        error: string;
+    } | {
+        error: string;
+    } | {
+        success: string;
+    } | {
+        error: (string | string | any);
+    }>;
+    /**
+     * Table constructor
+     * @param {object} o
+     */
+    constructor(o: object);
+    name: any;
+    id: any;
+    min_role_read: any;
+    min_role_write: any;
+    ownership_field_id: any;
+    ownership_formula: any;
+    versioned: boolean;
+    external: boolean;
+    description: any;
+    fields: any;
+    /**
+     * Get owner column name
+     * @param fields - fields list
+     * @returns {null|*} null or owner column name
+     */
+    owner_fieldname_from_fields(fields: any): null | any;
+    /**
+     * Get owner column name
+     * @returns {Promise<string|null|*>}
+     */
+    owner_fieldname(): Promise<string | null | any>;
+    /**
+     * Check if user is owner of row
+     * @param user - user
+     * @param row - table row
+     * @returns {Promise<string|null|*|boolean>}
+     */
+    is_owner(user: any, row: any): Promise<string | null | any | boolean>;
+    /**
+     * Drop current table
+     * @returns {Promise<void>}
+     */
+    delete(only_forget?: boolean): Promise<void>;
+    /***
+     * get Table SQL Name
+     * @type {string}
+     */
+    get sql_name(): string;
+    /**
+     * Delete rows from table
+     * @param where - condition
+     * @returns {Promise<void>}
+     */
+    deleteRows(where: any): Promise<void>;
+    /**
+     * Returns row with only fields that can be read from db (readFromDB flag)
+     * @param row
+     * @returns {*}
+     */
+    readFromDB(row: any): any;
+    /**
+     * Get one row from table in db
+     * @param where
+     * @returns {Promise<null|*>}
+     */
+    getRow(where?: {}): Promise<null | any>;
+    /**
+     * Get rows from Table in db
+     * @param where
+     * @param selopts
+     * @returns {Promise<void>}
+     */
+    getRows(where: {} | undefined, selopts: any): Promise<void>;
+    /**
+     * Count amount of rows in db table
+     * @param where
+     * @returns {Promise<number>}
+     */
+    countRows(where: any): Promise<number>;
+    /**
+     * Return distinct Values for column in table
+     * ????
+     * @param fieldnm
+     * @returns {Promise<Object[]>}
+     */
+    distinctValues(fieldnm: any): Promise<Object[]>;
+    /**
+     * Update row
+     * @param v_in - colums with values to update
+     * @param id - id value
+     * @param _userid - user id
+     * @returns {Promise<void>}
+     */
+    updateRow(v_in: any, id: any, _userid: any): Promise<void>;
+    /**
+     * Try to Update row
+     * @param v
+     * @param id
+     * @param _userid
+     * @returns {Promise<{error}|{success: boolean}>}
+     */
+    tryUpdateRow(v: any, id: any, _userid: any): Promise<{
+        error: any;
+    } | {
+        success: boolean;
+    }>;
+    /**
+     * ????
+     * @param id
+     * @param field_name
+     * @returns {Promise<void>}
+     */
+    toggleBool(id: any, field_name: any): Promise<void>;
+    /**
+     * Get primary key field
+     * @type {string}
+     */
+    get pk_name(): string;
+    /**
+     * Insert row
+     * @param v_in
+     * @param _userid
+     * @returns {Promise<*>}
+     */
+    insertRow(v_in: any, _userid: any): Promise<any>;
+    /**
+     * Try to Insert row
+     * @param v
+     * @param _userid
+     * @returns {Promise<{error}|{success: *}>}
+     */
+    tryInsertRow(v: any, _userid: any): Promise<{
+        error: any;
+    } | {
+        success: any;
+    }>;
+    /**
+     * Get Fields list for table
+     * @returns {Promise<Field[]>}
+     */
+    getFields(): Promise<Field[]>;
+    /**
+     * Create history table
+     * @returns {Promise<void>}
+     */
+    create_history_table(): Promise<void>;
+    /**
+     * Drop history table
+     * @returns {Promise<void>}
+     */
+    drop_history_table(): Promise<void>;
+    /**
+     * Rename table
+     * @param new_name
+     * @returns {Promise<void>}
+     */
+    rename(new_name: any): Promise<void>;
+    /**
+     * Update Table description in _sc_table
+     * Also creates / drops history table for table
+     * @param new_table_rec
+     * @returns {Promise<void>}
+     */
+    update(new_table_rec: any): Promise<void>;
+    /**
+     * Get table history data
+     * @param id
+     * @returns {Promise<*>}
+     */
+    get_history(id: any): Promise<any>;
+    /**
+     * Enable constraints
+     * @returns {Promise<void>}
+     */
+    enable_fkey_constraints(): Promise<void>;
+    /**
+     * Import CSV file to existing table
+     * @param filePath
+     * @param recalc_stored
+     * @param skip_first_data_row
+     * @returns {Promise<{error: string}|{success: string}>}
+     */
+    import_csv_file(filePath: any, recalc_stored: any, skip_first_data_row: any): Promise<{
+        error: string;
+    } | {
+        success: string;
+    }>;
+    /**
+     * Import JSON table description
+     * @param filePath
+     * @param skip_first_data_row
+     * @returns {Promise<{error: string}|{success: string}>}
+     */
+    import_json_file(filePath: any, skip_first_data_row: any): Promise<{
+        error: string;
+    } | {
+        success: string;
+    }>;
+    /**
+     * Get parent relations for table
+     * @param allow_double
+     * @returns {Promise<{parent_relations: object[], parent_field_list: object[]}>}
+     */
+    get_parent_relations(allow_double: any): Promise<{
+        parent_relations: object[];
+        parent_field_list: object[];
+    }>;
+    /**
+     * Get child relations for table
+     * @returns {Promise<{child_relations: object[], child_field_list: object[]}>}
+     */
+    get_child_relations(): Promise<{
+        child_relations: object[];
+        child_field_list: object[];
+    }>;
+    /**
+     *
+     * @param opts
+     * @returns {Promise<{values, sql: string}>}
+     */
+    getJoinedQuery(opts?: {}): Promise<{
+        values: any;
+        sql: string;
+    }>;
+    /**
+     * @param {object} [opts = {}]
+     * @returns {Promise<object[]>}
+     */
+    getJoinedRows(opts?: object | undefined): Promise<object[]>;
+}
+declare namespace Table {
+    const contract: {
+        variables: {
+            name: ((() => any) | any);
+        };
+        methods: {
+            updateRow: ((() => any) | any);
+            get_history: ((() => any) | any);
+            tryUpdateRow: ((() => any) | any);
+            deleteRows: ((() => any) | any);
+            update: ((() => any) | any);
+            getRows: ((() => any) | any);
+            getRow: ((() => any) | any);
+            delete: ((() => any) | any);
+            get_parent_relations: ((() => any) | any);
+            get_child_relations: ((() => any) | any);
+            tryInsertRow: ((() => any) | any);
+            getFields: ((() => any) | any);
+            insertRow: ((() => any) | any);
+            toggleBool: ((() => any) | any);
+            getJoinedRows: ((() => any) | any);
+            countRows: ((() => any) | any);
+            distinctValues: ((() => any) | any);
+            sql_name: ((() => any) | any);
+            import_csv_file: ((() => any) | any);
+        };
+        static_methods: {
+            find: ((() => any) | any);
+            create_from_csv: ((() => any) | any);
+            findOne: ((() => any) | any);
+            find_with_external: ((() => any) | any);
+            create: ((() => any) | any);
+        };
+        constructs: {
+            name: ((() => any) | any);
+        };
+    };
+}
+import Field = require("./field");
+//# sourceMappingURL=table.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../models/table.js"],"names":[],"mappings":";AAsFA;;;GAGG;AACH;IAmBE;;;;;OAKG;IACH,4BAFa,MAAE,KAAK,GAAC,IAAI,CAyBxB;IAED;;;;;OAKG;IACH;;;QAFa,QAAQ,KAAK,EAAE,CAAC,CAU5B;IAED;;;;;OAKG;IACH;;;QAFa,QAAQ,MAAM,EAAE,CAAC,CAoB7B;IAuCD;;;;;OAKG;IACH,wCAFa,QAAQ,KAAK,CAAC,CAoC1B;IA4YD;;;;;OAKG;IACH,kDAFa,QAAQ;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,GAAC;QAAC,KAAK,EAAE,CAAC,MAAM,GAAC,MAAM,MAAE,CAAC,CAAA;KAAC,CAAC,CA0EjJ;IAloBD;;;OAGG;IACH,eAFW,MAAM,EAchB;IAXC,UAAkB;IAClB,QAAc;IACd,mBAAoC;IACpC,oBAAsC;IACtC,wBAA8C;IAC9C,uBAA4C;IAC5C,mBAA8B;IAC9B,kBAAqB;IACrB,iBAAgC;IAClB,YAA+C;IA6E/D;;;;OAIG;IACH,0CAFa,IAAI,MAAE,CAMlB;IAED;;;OAGG;IACH,mBAFa,QAAQ,MAAM,GAAC,IAAI,MAAE,CAAC,CAMlC;IAED;;;;;OAKG;IACH,+BAFa,QAAQ,MAAM,GAAC,IAAI,SAAG,OAAO,CAAC,CAU1C;IA4CD;;;OAGG;IACH,+BAFa,QAAQ,IAAI,CAAC,CAkCzB;IAED;;;OAGG;IACH,uBAEC;IAED;;;;OAIG;IACH,wBAFa,QAAQ,IAAI,CAAC,CAezB;IAED;;;;OAIG;IACH,0BAMC;IAED;;;;OAIG;IACH,oBAFa,QAAQ,IAAI,MAAE,CAAC,CAO3B;IAED;;;;;OAKG;IACH,8CAFa,QAAQ,IAAI,CAAC,CASzB;IAED;;;;OAIG;IACH,uBAFa,QAAQ,MAAM,CAAC,CAI3B;IAED;;;;;OAKG;IACH,8BAFa,QAAQ,MAAM,EAAE,CAAC,CAO7B;IAED;;;;;;OAMG;IACH,6CAFa,QAAQ,IAAI,CAAC,CAoCzB;IAED;;;;;;OAMG;IACH;;;iBAFuC,OAAO;OAS7C;IAED;;;;;OAKG;IACH,sCAFa,QAAQ,IAAI,CAAC,CAiBzB;IAED;;;OAGG;IACH,sBAEC;IAED;;;;;OAKG;IACH,oCAFa,YAAU,CAiBtB;IAED;;;;;OAKG;IACH;;;;OAOC;IAED;;;OAGG;IACH,aAFa,QAAQ,KAAK,EAAE,CAAC,CAO5B;IAED;;;OAGG;IAEH,wBAHa,QAAQ,IAAI,CAAC,CAsBzB;IAED;;;OAGG;IACH,sBAFa,QAAQ,IAAI,CAAC,CAOzB;IAED;;;;OAIG;IACH,uBAFa,QAAQ,IAAI,CAAC,CAuCzB;IAED;;;;;OAKG;IACH,4BAFa,QAAQ,IAAI,CAAC,CAkBzB;IAED;;;;OAIG;IACH,sBAFa,YAAU,CAQtB;IAED;;;OAGG;IACH,2BAFa,QAAQ,IAAI,CAAC,CAKzB;IAkFD;;;;;;OAMG;IACH;eAF6B,MAAM;;iBAAY,MAAM;OA+HpD;IAED;;;;;OAKG;IACH;eAF6B,MAAM;;iBAAY,MAAM;OAyCpD;IAED;;;;OAIG;IACH;0BAFwC,MAAM,EAAE;2BAAqB,MAAM,EAAE;OA6B5E;IAED;;;OAGG;IACH;yBAFuC,MAAM,EAAE;0BAAoB,MAAM,EAAE;OAe1E;IAED;;;;OAIG;IACH;;aAFmC,MAAM;OA8HxC;IAED;;;OAGG;IACH,0CAFa,QAAQ,MAAM,EAAE,CAAC,CAS7B;CACF;;oBAIS;QAAC,SAAS,EAAE;YAAC,IAAI,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAA;SAAC,CAAC;QAAC,OAAO,EAAE;YAAC,SAAS,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,WAAW,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,YAAY,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,UAAU,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,MAAM,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,OAAO,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,MAAM,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,MAAM,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,oBAAoB,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,mBAAmB,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,YAAY,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,SAAS,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,SAAS,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,UAAU,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,aAAa,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,SAAS,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,cAAc,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,QAAQ,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,eAAe,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAA;SAAC,CAAC;QAAC,cAAc,EAAE;YAAC,IAAI,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,eAAe,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,OAAO,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,kBAAkB,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAC;YAAC,MAAM,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAA;SAAC,CAAC;QAAC,UAAU,EAAE;YAAC,IAAI,EAAE,CAAC,WAAiB,MAAE,CAAC,CAAA;SAAC,CAAA;KAAC"}