@saltcorn/data 0.7.2-beta.0 → 0.7.2-beta.10

package/dist/db/state.d.ts

@@ -1,58 +1,220 @@
 /**
- * @function
- * @returns {State}
+ * State of Saltcorn
+ * Keeps cache for main objects
+ * @category saltcorn-data
+ * @module db/state
+ * @subcategory db
  */
-export const getState: any;
+import View from "../models/view";
+import Trigger from "../models/trigger";
+import File from "../models/file";
+import Table from "../models/table";
+import Page from "../models/page";
+import Field from "../models/field";
+import { Plugin, PluginLayout, ViewTemplate } from "@saltcorn/types/base_types";
+import { Type } from "@saltcorn/types/common_types";
+import { ConfigTypes, SingleConfig } from "models/config";
+import User from "../models/user";
+import I18n from "i18n";
 /**
- * Get tenant
- * @param {string} ten
- * @returns {object}
+ * State Class
+ * @category saltcorn-data
  */
-export function getTenant(ten: string): object;
-/**
- * Switch to multi_tenant
- * @param {object} plugin_loader
- * @param {boolean} disableMigrate - if true then dont migrate db
- * @returns {Promise<void>}
- */
-export function init_multi_tenant(plugin_loader: object, disableMigrate: boolean, tenantList: any): Promise<void>;
-/**
- * Restart tenant
- * @param {object} plugin_loader
- * @returns {Promise<void>}
- */
-export function restart_tenant(plugin_loader: object): Promise<void>;
-/**
- * Get other domain tenant
- * @param {string} hostname
- * @returns {object}
- */
-export function get_other_domain_tenant(hostname: string): object;
-/**
- * Set tenant base url???
- * From my point of view it just add tenant to list of otherdomaintenant
- * @param {object} tenant_subdomain
- * @param {string} [value] - new
- */
-export function set_tenant_base_url(tenant_subdomain: object, value?: string | undefined): void;
-/**
- * Get Process Init Time - moment when Saltcorn process was initiated
- * @returns {Date}
- */
-export function get_process_init_time(): Date;
-export namespace features {
-    const serve_static_dependencies: boolean;
-    const deep_public_plugin_serve: boolean;
-    const fieldrepeats_in_field_attributes: boolean;
-    const no_plugin_fieldview_length_check: boolean;
-    const bootstrap5: boolean;
-    const version_plugin_serve_path: boolean;
-    const prefix_or_in_queries: boolean;
+declare class State {
+    tenant: string;
+    views: Array<View>;
+    triggers: Array<Trigger>;
+    virtual_triggers: Array<Trigger>;
+    viewtemplates: Record<string, ViewTemplate>;
+    tables: Array<Table>;
+    types: Record<string, Type>;
+    stashed_fieldviews: Record<string, any>;
+    files: Record<string, File>;
+    pages: Array<Page>;
+    fields: Array<Field>;
+    configs: ConfigTypes;
+    fileviews: Record<string, any>;
+    actions: Record<string, any>;
+    auth_methods: Record<string, any>;
+    plugins: Record<string, Plugin>;
+    plugin_cfgs: any;
+    plugin_locations: any;
+    plugin_module_names: any;
+    eventTypes: any;
+    fonts: Record<string, string>;
+    layouts: Record<string, PluginLayout>;
+    headers: any;
+    function_context: any;
+    functions: any;
+    keyFieldviews: any;
+    external_tables: any;
+    verifier: any;
+    i18n: I18n.I18n;
+    roomEmitter?: Function;
+    localTableIds: number[];
+    role_id?: number;
+    /**
+     * State constructor
+     * @param {string} tenant description
+     */
+    constructor(tenant: string);
+    /**
+     * Get Layout by user
+     * Based on role of user
+     * @param {object} user
+     * @returns {object}
+     */
+    getLayout(user: User): PluginLayout;
+    /**
+     * Get Two factor authentication policy
+     * Based on role of user
+     * @param {object} user
+     * @returns {string}
+     */
+    get2FApolicy(user: User): any;
+    /**
+     * Refresh State cache for all Saltcorn main objects
+     * @param {boolean} noSignal - Do not signal - refresh to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh(noSignal: boolean): Promise<void>;
+    /**
+     * Refresh config
+     * @param {boolean} noSignal - Do not signal refresh to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh_config(noSignal: boolean): Promise<void>;
+    /**
+     * @returns {Promise<void>}
+     */
+    refresh_i18n(): Promise<void>;
+    /**
+     * Refresh views
+     * @param {boolean} noSignal - Do not signal refresh to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh_views(noSignal: boolean): Promise<void>;
+    /**
+     * Refresh triggers
+     * @param {boolean} noSignal - Do not signal refresh to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh_triggers(noSignal: boolean): Promise<void>;
+    /**
+     * Refresh pages
+     * @param {boolean} noSignal - Do not signal refresh to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh_pages(noSignal: boolean): Promise<void>;
+    /**
+     * Refresh files
+     * @param {boolean} noSignal - Do not signal refresh to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh_files(noSignal: boolean): Promise<void>;
+    /**
+     * Refresh tables & fields
+     * @param {boolean} noSignal - Do not signal refresh to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh_tables(noSignal: boolean): Promise<void>;
+    /**
+     * Get config parameter by key
+     * @param {string} key - key of config paramter
+     * @param {*} [def] - default value
+     * @returns {*}
+     */
+    getConfig(key: string, def?: any): any;
+    /**
+     * Get copy of config parameter (which can be safely mutated)
+     * @param {string} key - key of parameter
+     * @param {*} [def] - default value
+     * @returns {*}
+     */
+    getConfigCopy(key: string, def: any): any;
+    /**
+     *
+     * Set value of config parameter
+     * @param {string} key - key of parameter
+     * @param {*} value - value of parameter
+     * @returns {Promise<void>}
+     */
+    setConfig(key: string, value: any): Promise<void>;
+    /**
+     * Delete config parameter by key
+     * @param {string} keys - key of parameter
+     * @returns {Promise<void>}
+     */
+    deleteConfig(...keys: string[]): Promise<void>;
+    /**
+     * Register plugin
+     * @param {string} name
+     * @param {object} plugin
+     * @param {*} cfg
+     * @param {*} location
+     * @param {string} modname
+     * @returns {void}
+     */
+    registerPlugin(name: string, plugin: Plugin, cfg?: SingleConfig, location?: string, modname?: string): void;
+    /**
+     * Get type names
+     * @type {string[]}
+     */
+    get type_names(): string[];
+    /**
+     * Add type
+     * @param {object} t
+     */
+    addType(t: Type): void;
+    /**
+     * Remove plugin
+     * @param {string} name
+     * @param {boolean} noSignal - Do not signal removal to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    remove_plugin(name: string, noSignal: boolean): Promise<void>;
+    /**
+     * Reload plugins
+     * @param {boolean} noSignal - Do not signal reload to other cluster processes.
+     * @returns {Promise<void>}
+     */
+    refresh_plugins(noSignal?: boolean): Promise<void>;
+    /**
+     * Collect translatable strings from configuration
+     * @returns {string[]}
+     */
+    getStringsForI18n(): any[];
+    /**
+     * Set the function which will be called when a message enters a room
+     * @param {function} f
+     */
+    setRoomEmitter(f: Function): void;
+    /**
+     * Send a message to a room
+     * @param {...*} args
+     */
+    emitRoom(...args: any[]): void;
 }
-export function add_tenant(t: any): void;
-/**
- * @param {object} v
- * @returns {void}
- */
-export function process_send(v: object): void;
+declare const _default: {
+    getState: () => State | undefined;
+    getTenant: (ten: string) => State;
+    init_multi_tenant: (plugin_loader: Function, disableMigrate: boolean, tenantList: string[]) => Promise<void>;
+    restart_tenant: (plugin_loader: Function) => Promise<void>;
+    get_other_domain_tenant: (hostname: string) => string;
+    set_tenant_base_url: (tenant_subdomain: string, value?: string | undefined) => void;
+    get_process_init_time: () => Date;
+    features: {
+        serve_static_dependencies: boolean;
+        deep_public_plugin_serve: boolean;
+        fieldrepeats_in_field_attributes: boolean;
+        no_plugin_fieldview_length_check: boolean;
+        bootstrap5: boolean;
+        version_plugin_serve_path: boolean;
+        prefix_or_in_queries: boolean;
+        json_state_query: boolean;
+    };
+    add_tenant: (t: string) => void;
+    process_send: (v: any) => void;
+};
+export = _default;
 //# sourceMappingURL=state.d.ts.map

package/dist/db/state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../db/state.js"],"names":[],"mappings":"AAwkBA;;;GAGG;AACH,2BASE;AAYF;;;;GAIG;AACH,+BAHW,MAAM,GACJ,MAAM,CAKlB;AAwBD;;;;;GAKG;AACH,iDAJW,MAAM,kBACN,OAAO,oBACL,QAAQ,IAAI,CAAC,CAiBzB;AAMD;;;;GAIG;AACH,8CAHW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAMzB;AA1ED;;;;GAIG;AACH,kDAHW,MAAM,GACJ,MAAM,CAEuD;AAmB1E;;;;;GAKG;AACH,sDAHW,MAAM,oCAUhB;AAwCD;;;GAGG;AACH,yCAFa,IAAI,CAEoC;;;;;;;;;;AApBrD,yCAEC;AAvnBD;;;GAGG;AACH,gCAHW,MAAM,GACJ,IAAI,CAIhB"}
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../db/state.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAClC,OAAO,OAAO,MAAM,mBAAmB,CAAC;AACxC,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAClC,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAClC,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,IAAI,MAAM,gBAAgB,CAAC;AAWlC,OAAO,IAAI,MAAM,MAAM,CAAC;AA0DxB;;;GAGG;AACH,cAAM,KAAK;IACT,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACnB,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzB,gBAAgB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACjC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC5C,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5B,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,WAAW,EAAE,GAAG,CAAC;IACjB,gBAAgB,EAAE,GAAG,CAAC;IACtB,mBAAmB,EAAE,GAAG,CAAC;IACzB,UAAU,EAAE,GAAG,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACtC,OAAO,EAAE,GAAG,CAAC;IACb,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,EAAE,GAAG,CAAC;IACf,aAAa,EAAE,GAAG,CAAC;IACnB,eAAe,EAAE,GAAG,CAAC;IACrB,QAAQ,EAAE,GAAG,CAAC;IACd,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;gBACS,MAAM,EAAE,MAAM;IAqC1B;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,IAAI;IAUpB;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,IAAI;IAQvB;;;;OAIG;IACG,OAAO,CAAC,QAAQ,EAAE,OAAO;IAS/B;;;;OAIG;IACG,cAAc,CAAC,QAAQ,EAAE,OAAO;IAUtC;;OAEG;IACG,YAAY;IA4BlB;;;;OAIG;IACG,aAAa,CAAC,QAAQ,EAAE,OAAO;IAkBrC;;;;OAIG;IACG,gBAAgB,CAAC,QAAQ,EAAE,OAAO;IAMxC;;;;OAIG;IACG,aAAa,CAAC,QAAQ,EAAE,OAAO;IAOrC;;;;OAIG;IAEG,aAAa,CAAC,QAAQ,EAAE,OAAO;IAUrC;;;;OAIG;IACG,cAAc,CAAC,QAAQ,EAAE,OAAO;IAsCtC;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG;IAchC;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG;IAInC;;;;;;OAMG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAiBvC;;;;OAIG;IACG,YAAY,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IAYpC;;;;;;;;OAQG;IACH,cAAc,CACZ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,GAAG,CAAC,EAAE,YAAY,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,MAAM;IA6ElB;;;OAGG;IACH,IAAI,UAAU,aAEb;IAED;;;OAGG;IACH,OAAO,CAAC,CAAC,EAAE,IAAI;IAYf;;;;;OAKG;IACG,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO;IAOnD;;;;OAIG;IACG,eAAe,CAAC,QAAQ,CAAC,EAAE,OAAO;IAyBxC;;;OAGG;IACH,iBAAiB;IAWjB;;;OAGG;IACH,cAAc,CAAC,CAAC,EAAE,QAAQ;IAI1B;;;OAGG;IACH,QAAQ,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE;CAGxB;;;;;;;;;;;;;;;;;;;;;;AA4HD,kBAWE"}