@saltcorn/data 0.9.6-beta.8 → 0.9.6

package/dist/base-plugin/index.d.ts

@@ -1,5 +1,6 @@
 export const types: ({
     name: string;
+    description: string;
     sql_name: string;
     js_type: string;
     attributes: ({ table }: object) => object;
@@ -22,6 +23,22 @@ export const types: ({
             description: string;
             run: (s: any) => any;
         };
+        monospace_block: {
+            isEdit: boolean;
+            configFields: ({
+                name: string;
+                label: string;
+                sublabel: string;
+                type: string;
+            } | {
+                name: string;
+                label: string;
+                type: string;
+                sublabel?: undefined;
+            })[];
+            description: string;
+            run: (s: any, req: any, attrs?: {}) => any;
+        };
         ellipsize: {
             isEdit: boolean;
             configFields: {
@@ -237,6 +254,7 @@ export const types: ({
     validate_attributes: ({ min_length, max_length, regexp }: object) => object;
 } | {
     name: string;
+    description: string;
     sql_name: string;
     js_type: string;
     contract: ({ min, max }: {
@@ -455,6 +473,59 @@ export const types: ({
             blockDisplay: boolean;
             run: (nm: any, v: any, attrs: {} | undefined, cls: any, required: any, field: any, state?: {}) => any;
         };
+        to_locale_string: {
+            description: string;
+            configFields: (field: any) => ({
+                type: string;
+                name: string;
+                label: string;
+                sublabel: string;
+                required?: undefined;
+                attributes?: undefined;
+                showIf?: undefined;
+            } | {
+                type: string;
+                name: string;
+                label: string;
+                required: boolean;
+                attributes: {
+                    options: string[];
+                };
+                sublabel?: undefined;
+                showIf?: undefined;
+            } | {
+                type: string;
+                name: string;
+                label: string;
+                sublabel: string;
+                required: boolean;
+                showIf: {
+                    style: string;
+                };
+                attributes?: undefined;
+            } | {
+                type: string;
+                name: string;
+                label: string;
+                required: boolean;
+                showIf: {
+                    style: string;
+                };
+                attributes: {
+                    options: string[];
+                };
+                sublabel?: undefined;
+            })[];
+            isEdit: boolean;
+            run: (v: any, req: any, attrs?: {}) => string;
+        };
+        role_select: {
+            isEdit: boolean;
+            blockDisplay: boolean;
+            description: string;
+            fill_options: (field: any) => Promise<void>;
+            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
+        };
     };
     attributes: object[];
     validate_attributes: ({ min, max }: object) => boolean;
@@ -462,6 +533,7 @@ export const types: ({
     validate: ({ min, max }: object) => boolean;
 } | {
     name: string;
+    description: string;
     sql_name: string;
     js_type: string;
     contract: () => Function;
@@ -469,7 +541,111 @@ export const types: ({
         show: {
             isEdit: boolean;
             description: string;
-            run: (s: any) => any;
+            run: (v: any, req: any) => any;
+        };
+        checkboxes: {
+            isEdit: boolean;
+            description: string;
+            run: (v: any) => any;
+        };
+        TrueFalse: {
+            isEdit: boolean;
+            description: string;
+            run: (v: any) => "" | "True" | "False";
+        };
+        edit: {
+            isEdit: boolean;
+            description: string;
+            configFields: ({
+                name: string;
+                label: string;
+                type: string;
+                attributes: {
+                    options: string[];
+                };
+            } | {
+                name: string;
+                label: string;
+                type: string;
+                attributes?: undefined;
+            })[];
+            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
+        };
+        switch: {
+            isEdit: boolean;
+            description: string;
+            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
+        };
+        show_with_html: {
+            configFields: {
+                input_type: string;
+                name: string;
+                label: string;
+                sublabel: string;
+                default: string;
+                attributes: {
+                    mode: string;
+                };
+            }[];
+            isEdit: boolean;
+            description: string;
+            run: (v: any, req: any, attrs?: {}) => any;
+        };
+        tristate: {
+            isEdit: boolean;
+            description: string;
+            configFields: {
+                name: string;
+                label: string;
+                type: string;
+            }[];
+            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
+        };
+    };
+    attributes: object[];
+    readFromFormRecord: (rec: any, name: string) => boolean | null;
+    read: (v: object) => boolean | null;
+    readFromDB: (v: object) => object;
+    listAs: (v: object) => object;
+    validate: () => boolean;
+} | {
+    name: string;
+    description: string;
+    sql_name: string;
+    js_type: string;
+    contract: () => Function;
+    attributes: object[];
+    fieldviews: {
+        show: {
+            isEdit: boolean;
+            description: string;
+            run: (d: any, req: any, attrs?: {}) => any;
+        };
+        showDay: {
+            isEdit: boolean;
+            description: string;
+            run: (d: any, req: any) => any;
+        };
+        format: {
+            isEdit: boolean;
+            description: string;
+            configFields: {
+                name: string;
+                label: string;
+                type: string;
+                sublabel: string;
+            }[];
+            run: (d: any, req: any, options: any) => any;
+        };
+        relative: {
+            isEdit: boolean;
+            description: string;
+            run: (d: any, req: any) => string;
+        };
+        yearsAgo: {
+            isEdit: boolean;
+            description: string;
+            run: (d: any, req: any) => string;
         };
         show_with_html: {
             configFields: {
@@ -492,12 +668,21 @@ export const types: ({
             description: string;
             run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
         };
+        editDay: {
+            isEdit: boolean;
+            blockDisplay: boolean;
+            description: string;
+            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
+        };
     };
-    attributes: object[];
-    read: (v: object) => object;
+    presets: {
+        Now: () => Date;
+    };
+    read: (v: object, attrs: object) => object;
     validate: () => boolean;
 } | {
     name: string;
+    description: string;
     sql_name: string;
     js_type: string;
     contract: ({ min, max }: {
@@ -664,6 +849,52 @@ export const types: ({
             blockDisplay: boolean;
             run: (nm: any, v: any, attrs: {} | undefined, cls: any, required: any, field: any, state?: {}) => any;
         };
+        to_locale_string: {
+            description: string;
+            configFields: (field: any) => ({
+                type: string;
+                name: string;
+                label: string;
+                sublabel: string;
+                required?: undefined;
+                attributes?: undefined;
+                showIf?: undefined;
+            } | {
+                type: string;
+                name: string;
+                label: string;
+                required: boolean;
+                attributes: {
+                    options: string[];
+                };
+                sublabel?: undefined;
+                showIf?: undefined;
+            } | {
+                type: string;
+                name: string;
+                label: string;
+                sublabel: string;
+                required: boolean;
+                showIf: {
+                    style: string;
+                };
+                attributes?: undefined;
+            } | {
+                type: string;
+                name: string;
+                label: string;
+                required: boolean;
+                showIf: {
+                    style: string;
+                };
+                attributes: {
+                    options: string[];
+                };
+                sublabel?: undefined;
+            })[];
+            isEdit: boolean;
+            run: (v: any, req: any, attrs?: {}) => string;
+        };
         show_with_html: {
             configFields: {
                 input_type: string;
@@ -685,41 +916,15 @@ export const types: ({
     validate: ({ min, max }: object) => boolean | object;
 } | {
     name: string;
+    description: string;
     sql_name: string;
     js_type: string;
     contract: () => Function;
-    attributes: object[];
     fieldviews: {
         show: {
             isEdit: boolean;
             description: string;
-            run: (d: any, req: any, attrs?: {}) => any;
-        };
-        showDay: {
-            isEdit: boolean;
-            description: string;
-            run: (d: any, req: any) => any;
-        };
-        format: {
-            isEdit: boolean;
-            description: string;
-            configFields: {
-                name: string;
-                label: string;
-                type: string;
-                sublabel: string;
-            }[];
-            run: (d: any, req: any, options: any) => any;
-        };
-        relative: {
-            isEdit: boolean;
-            description: string;
-            run: (d: any, req: any) => string;
-        };
-        yearsAgo: {
-            isEdit: boolean;
-            description: string;
-            run: (d: any, req: any) => string;
+            run: (s: any) => any;
         };
         show_with_html: {
             configFields: {
@@ -742,93 +947,9 @@ export const types: ({
             description: string;
             run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
         };
-        editDay: {
-            isEdit: boolean;
-            blockDisplay: boolean;
-            description: string;
-            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
-        };
-    };
-    presets: {
-        Now: () => Date;
-    };
-    read: (v: object, attrs: object) => object;
-    validate: () => boolean;
-} | {
-    name: string;
-    sql_name: string;
-    js_type: string;
-    contract: () => Function;
-    fieldviews: {
-        show: {
-            isEdit: boolean;
-            description: string;
-            run: (v: any, req: any) => any;
-        };
-        checkboxes: {
-            isEdit: boolean;
-            description: string;
-            run: (v: any) => any;
-        };
-        TrueFalse: {
-            isEdit: boolean;
-            description: string;
-            run: (v: any) => "" | "True" | "False";
-        };
-        edit: {
-            isEdit: boolean;
-            description: string;
-            configFields: ({
-                name: string;
-                label: string;
-                type: string;
-                attributes: {
-                    options: string[];
-                };
-            } | {
-                name: string;
-                label: string;
-                type: string;
-                attributes?: undefined;
-            })[];
-            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
-        };
-        switch: {
-            isEdit: boolean;
-            description: string;
-            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
-        };
-        show_with_html: {
-            configFields: {
-                input_type: string;
-                name: string;
-                label: string;
-                sublabel: string;
-                default: string;
-                attributes: {
-                    mode: string;
-                };
-            }[];
-            isEdit: boolean;
-            description: string;
-            run: (v: any, req: any, attrs?: {}) => any;
-        };
-        tristate: {
-            isEdit: boolean;
-            description: string;
-            configFields: {
-                name: string;
-                label: string;
-                type: string;
-            }[];
-            run: (nm: any, v: any, attrs: any, cls: any, required: any, field: any) => any;
-        };
     };
     attributes: object[];
-    readFromFormRecord: (rec: any, name: string) => boolean | null;
-    read: (v: object) => boolean | null;
-    readFromDB: (v: object) => object;
-    listAs: (v: object) => object;
+    read: (v: object) => object;
     validate: () => boolean;
 })[];
 export const viewtemplates: ({
@@ -1030,6 +1151,151 @@ export const viewtemplates: ({
         warnings: string[];
     }>;
     connectedObjects: (configuration: any) => Promise<import("@saltcorn/types/base_types").ConnectedObjects>;
+} | {
+    name: string;
+    description: string;
+    configuration_workflow: (req: object) => import("../models/workflow");
+    run: (table_id: string, viewname: string, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: {
+        participant_field: string;
+        msg_relation: string;
+        msgsender_field: any;
+        msgview: string;
+        msgform: string;
+        participant_maxread_field: string;
+    }, state: object, { req, res }: {
+        req: object;
+        res: object;
+    }, { getRowQuery, updateQuery, optionsQuery }: {
+        getRowQuery: any;
+        updateQuery: any;
+        optionsQuery: any;
+    }) => Promise<div>;
+    get_state_fields: () => object[];
+    display_state_form: boolean;
+    routes: {
+        submit_msg_ajax: (table_id: any, viewname: string, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: {
+            participant_field: string;
+            msg_relation: string;
+            msgsender_field: any;
+            msgview: string;
+            msgform: string;
+            participant_maxread_field: string;
+        }, body: any, { req, res }: {
+            req: object;
+            res: object;
+        }, { submitAjaxQuery }: {
+            submitAjaxQuery: any;
+        }) => Promise<object>;
+        ack_read: (table_id: any, viewname: any, { participant_field, participant_maxread_field }: {
+            participant_field: string;
+            participant_maxread_field: string;
+        }, body: any, { req, res }: {
+            req: object;
+            res: object;
+        }, { ackReadQuery }: {
+            ackReadQuery: any;
+        }) => Promise<void>;
+        fetch_older_msg: (table_id: any, viewname: any, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: object, body: object, { req, res }: string, { fetchOlderMsgQuery }: any) => Promise<object>;
+    };
+    noAutoTest: boolean;
+    authorize_join: ({ table_id, min_role, configuration: { participant_field } }: {
+        participant_field: object;
+    }, room_id: string, user: object) => Promise<object>;
+    virtual_triggers: (table_id: any, viewname: string, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: {
+        participant_field: any;
+        msg_relation: string;
+        msgsender_field: string;
+        msgview: string;
+        msgform: any;
+        participant_maxread_field: any;
+    }) => object[];
+    getStringsForI18n(): object[];
+    queries: ({ table_id, viewname, configuration: { columns, default_state }, req, }: {
+        table_id: any;
+        viewname: any;
+        configuration: {
+            columns: any;
+            default_state: any;
+        };
+        req: any;
+    }) => {
+        getRowQuery(state_id: any, part_table_name: any, part_user_field: any, part_key_to_room: any): Promise<import("@saltcorn/db-common/internal").Row | null>;
+        updateQuery(partRow: any, part_table_name: any, max_read_id: any, part_maxread_field: any): Promise<void>;
+        submitAjaxQuery(msg_relation: any, participant_field: any, body: any, msgform: any, msgsender_field: any, participant_maxread_field: any): Promise<{
+            json: {
+                msgid: {
+                    error: string;
+                } | {
+                    success: any;
+                };
+                error?: undefined;
+            };
+        } | {
+            json: {
+                error: any;
+                msgid?: undefined;
+            };
+        }>;
+        ackReadQuery(participant_field: any, participant_maxread_field: any, body: any): Promise<{
+            json: {
+                error: string;
+                success?: undefined;
+            };
+        } | {
+            json: {
+                success: string;
+                error?: undefined;
+            };
+        }>;
+        fetchOlderMsgQuery(participant_field: any, body: any): Promise<import("@saltcorn/db-common/internal").Row | null>;
+        optionsQuery(reftable_name: any, type: any, attributes: any, where: any): Promise<any>;
+    };
+    connectedObjects: (configuration: any) => Promise<import("@saltcorn/types/base_types").ConnectedObjects>;
+} | {
+    name: string;
+    description: string;
+    configuration_workflow: (req: object) => import("../models/workflow");
+    run: (table_id: number, viewname: string, { show_view, order_field, descending, view_to_create, create_view_display, in_card, view_decoration, initial_open_accordions, title_formula, masonry_columns, rows_per_page, hide_pagination, create_view_label, create_view_location, create_link_style, create_link_size, create_view_showif, always_create_view, include_fml, exclusion_relation, exclusion_where, empty_view, groupby, lazy_accordions, ...cols }: {
+        show_view: string;
+        order_field: void;
+        descending: boolean;
+        view_to_create?: string | undefined;
+        create_view_display: string;
+        in_card: boolean;
+        masonry_columns: string;
+        rows_per_page?: number | undefined;
+        hide_pagination: boolean;
+        create_view_label?: string | undefined;
+        create_view_location?: string | undefined;
+        always_create_view: boolean;
+        cols: any;
+    }, state: object, extraArgs: any, { countRowsQuery, runManyQuery }: {
+        countRowsQuery: any;
+        runManyQuery: any;
+    }) => Promise<div>;
+    get_state_fields: (table_id: number, viewname: any, { show_view }: {
+        show_view: any;
+    }) => Promise<import("../models/field")>;
+    display_state_form: boolean;
+    getStringsForI18n({ create_view_label }: {
+        create_view_label: any;
+    }): string[] | Object[];
+    queries: ({ table_id, viewname, configuration: { show_view }, req, res, }: {
+        table_id: any;
+        viewname: any;
+        configuration: {
+            show_view: any;
+        };
+        req: any;
+        res: any;
+    }) => {
+        countRowsQuery(state: any): Promise<number>;
+        runManyQuery(state: any, qextra: any, selectOpts: any): Promise<string[] | {
+            html: string;
+            row: any;
+        }[]>;
+    };
+    connectedObjects: (configuration: any) => Promise<import("@saltcorn/types/base_types").ConnectedObjects>;
 } | {
     name: string;
     description: string;
@@ -1202,146 +1468,6 @@ export const viewtemplates: ({
     }) => Promise<{
         embeddedViews: import("../models/view")[];
     }>;
-} | {
-    name: string;
-    description: string;
-    configuration_workflow: (req: object) => import("../models/workflow");
-    run: (table_id: number, viewname: string, { show_view, order_field, descending, view_to_create, create_view_display, in_card, view_decoration, initial_open_accordions, title_formula, masonry_columns, rows_per_page, hide_pagination, create_view_label, create_view_location, create_link_style, create_link_size, create_view_showif, always_create_view, include_fml, exclusion_relation, exclusion_where, empty_view, groupby, lazy_accordions, ...cols }: {
-        show_view: string;
-        order_field: void;
-        descending: boolean;
-        view_to_create?: string | undefined;
-        create_view_display: string;
-        in_card: boolean;
-        masonry_columns: string;
-        rows_per_page?: number | undefined;
-        hide_pagination: boolean;
-        create_view_label?: string | undefined;
-        create_view_location?: string | undefined;
-        always_create_view: boolean;
-        cols: any;
-    }, state: object, extraArgs: any, { countRowsQuery }: {
-        countRowsQuery: any;
-    }) => Promise<div>;
-    get_state_fields: (table_id: number, viewname: any, { show_view }: {
-        show_view: any;
-    }) => Promise<import("../models/field")>;
-    display_state_form: boolean;
-    getStringsForI18n({ create_view_label }: {
-        create_view_label: any;
-    }): string[] | Object[];
-    queries: ({ table_id, viewname, configuration: { columns, default_state }, req, }: {
-        table_id: any;
-        viewname: any;
-        configuration: {
-            columns: any;
-            default_state: any;
-        };
-        req: any;
-    }) => {
-        countRowsQuery(state: any): Promise<number>;
-    };
-    connectedObjects: (configuration: any) => Promise<import("@saltcorn/types/base_types").ConnectedObjects>;
-} | {
-    name: string;
-    description: string;
-    configuration_workflow: (req: object) => import("../models/workflow");
-    run: (table_id: string, viewname: string, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: {
-        participant_field: string;
-        msg_relation: string;
-        msgsender_field: any;
-        msgview: string;
-        msgform: string;
-        participant_maxread_field: string;
-    }, state: object, { req, res }: {
-        req: object;
-        res: object;
-    }, { getRowQuery, updateQuery, optionsQuery }: {
-        getRowQuery: any;
-        updateQuery: any;
-        optionsQuery: any;
-    }) => Promise<div>;
-    get_state_fields: () => object[];
-    display_state_form: boolean;
-    routes: {
-        submit_msg_ajax: (table_id: any, viewname: string, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: {
-            participant_field: string;
-            msg_relation: string;
-            msgsender_field: any;
-            msgview: string;
-            msgform: string;
-            participant_maxread_field: string;
-        }, body: any, { req, res }: {
-            req: object;
-            res: object;
-        }, { submitAjaxQuery }: {
-            submitAjaxQuery: any;
-        }) => Promise<object>;
-        ack_read: (table_id: any, viewname: any, { participant_field, participant_maxread_field }: {
-            participant_field: string;
-            participant_maxread_field: string;
-        }, body: any, { req, res }: {
-            req: object;
-            res: object;
-        }, { ackReadQuery }: {
-            ackReadQuery: any;
-        }) => Promise<void>;
-        fetch_older_msg: (table_id: any, viewname: any, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: object, body: object, { req, res }: string, { fetchOlderMsgQuery }: any) => Promise<object>;
-    };
-    noAutoTest: boolean;
-    authorize_join: ({ table_id, min_role, configuration: { participant_field } }: {
-        participant_field: object;
-    }, room_id: string, user: object) => Promise<object>;
-    virtual_triggers: (table_id: any, viewname: string, { participant_field, msg_relation, msgsender_field, msgview, msgform, participant_maxread_field, }: {
-        participant_field: any;
-        msg_relation: string;
-        msgsender_field: string;
-        msgview: string;
-        msgform: any;
-        participant_maxread_field: any;
-    }) => object[];
-    getStringsForI18n(): object[];
-    queries: ({ table_id, viewname, configuration: { columns, default_state }, req, }: {
-        table_id: any;
-        viewname: any;
-        configuration: {
-            columns: any;
-            default_state: any;
-        };
-        req: any;
-    }) => {
-        getRowQuery(state_id: any, part_table_name: any, part_user_field: any, part_key_to_room: any): Promise<import("@saltcorn/db-common/internal").Row | null>;
-        updateQuery(partRow: any, part_table_name: any, max_read_id: any, part_maxread_field: any): Promise<void>;
-        submitAjaxQuery(msg_relation: any, participant_field: any, body: any, msgform: any, msgsender_field: any, participant_maxread_field: any): Promise<{
-            json: {
-                msgid: {
-                    error: string;
-                } | {
-                    success: any;
-                };
-                error?: undefined;
-            };
-        } | {
-            json: {
-                error: any;
-                msgid?: undefined;
-            };
-        }>;
-        ackReadQuery(participant_field: any, participant_maxread_field: any, body: any): Promise<{
-            json: {
-                error: string;
-                success?: undefined;
-            };
-        } | {
-            json: {
-                success: string;
-                error?: undefined;
-            };
-        }>;
-        fetchOlderMsgQuery(participant_field: any, body: any): Promise<import("@saltcorn/db-common/internal").Row | null>;
-        optionsQuery(reftable_name: any, type: any, attributes: any, where: any): Promise<any>;
-    };
-    connectedObjects: (configuration: any) => Promise<import("@saltcorn/types/base_types").ConnectedObjects>;
 })[];
 import fileviews = require("./fileviews");
 import actions = require("./actions");