@saltcorn/data 0.6.1 → 0.6.2-beta.3

package/models/fieldrepeat.js

@@ -1,96 +0,0 @@
-/**
- * FieldRepeat Database Access Layer
- * @category saltcorn-data
- * @module models/fieldrepeat
- * @subcategory models
- */
-const { contract, is } = require("contractis");
-const Field = require("./field");
-
-/**
- * FieldRepeat Class
- * @category saltcorn-data
- */
-class FieldRepeat {
-  /**
-   * FieldRepeat constructor
-   * @param {object} o 
-   */
-  constructor(o) {
-    this.label = o.label || o.name;
-    this.name = o.name;
-    this.fields = o.fields.map((f) =>
-      f.constructor.name === Object.name ? new Field(f) : f
-    );
-    this.isRepeat = true;
-    contract.class(this);
-  }
-
-  /**
-   * @returns {Promise<void>}
-   */
-  async generate() {
-    const nrepeats = Math.round(Math.random() * 5);
-    var r = {};
-    for (let index = 0; index < nrepeats; index++) {
-      for (const f of this.fields) {
-        if (f.required || is.bool.generate()) {
-          r[`${f.name}_${index}`] = await f.generate();
-        }
-      }
-    }
-  }
-
-  /**
-   * @param {*} whole_rec 
-   * @returns {object}
-   */
-  validate(whole_rec) {
-    return this.validate_from_ix(whole_rec, 0);
-  }
-
-  /**
-   * @param {*} whole_rec 
-   * @param {*} ix 
-   * @returns {object}
-   */
-  validate_from_ix(whole_rec, ix) {
-    var has_any = false;
-    var res = {};
-
-    this.fields.forEach((f) => {
-      const fval = whole_rec[`${f.name}_${ix}`];
-      if (typeof fval !== "undefined") {
-        has_any = true;
-        res[f.name] = fval;
-      }
-    });
-    if (has_any) {
-      const rest = this.validate_from_ix(whole_rec, ix + 1);
-      return { success: [res, ...rest.success] };
-    } else return { success: [] };
-  }
-
-  /**
-   * @type {string}
-   */
-  get form_name() {
-    return this.name;
-  }
-}
-
-FieldRepeat.contract = {
-  variables: {
-    name: is.str,
-    label: is.str,
-    fields: is.array(is.class("Field")),
-    isRepeat: is.eq(true),
-  },
-  methods: {
-    validate: is.fun(
-      is.obj(),
-      is.or(is.obj({ errors: is.obj() }), is.obj({ success: is.obj() }))
-    ),
-  },
-};
-module.exports = FieldRepeat;

package/models/file.js

@@ -1,234 +0,0 @@
-/**
- * File Database Access Layer
- * @category saltcorn-data
- * @module models/file
- * @subcategory models
- */
-
-const db = require("../db");
-const { contract, is } = require("contractis");
-const { v4: uuidv4 } = require("uuid");
-const path = require("path");
-const { asyncMap } = require("../utils");
-const fs = require("fs").promises;
-
-/**
- * File Descriptor class
- *
- * Architecture tips:
- * 1. Physically Saltcorn stores files on local filesystem of the server, where Saltcorn runs.
- * 2. The path to file store is defined in db.connectObj.file_store.
- * 3. List of files stored in _sc_files table in Saltcorn database.
- * 4. Each tenant has own file list and file storage.
- * 5. This class provides file descriptor and basic functions to manipulate with files.
- * @category saltcorn-data
- */
-class File {
-  /**
-   * Constructor
-   * @param o {object}
-   */
-  constructor(o) {
-    this.filename = o.filename;
-    this.location = o.location;
-    this.uploaded_at = ["string", "number"].includes(typeof o.uploaded_at)
-      ? new Date(o.uploaded_at)
-      : o.uploaded_at;
-    this.size_kb = o.size_kb;
-    this.id = o.id;
-    this.user_id = o.user_id;
-    this.mime_super = o.mime_super;
-    this.mime_sub = o.mime_sub;
-    this.min_role_read = o.min_role_read;
-    // TBD add checksum this.checksum = o.checksum;
-    contract.class(this);
-  }
-
-  /**
-   * Select list of file descriptors
-   * @param where
-   * @param selectopts
-   * @returns {Promise<*>}
-   */
-  static async find(where, selectopts = {}) {
-    if (selectopts.cached) {
-      const { getState } = require("../db/state");
-      const files = Object.values(getState().files).sort((a, b) =>
-        a.filename > b.filename ? 1 : -1
-      );
-      return files.map((t) => new File(t));
-    }
-    const db_flds = await db.select("_sc_files", where, selectopts);
-    return db_flds.map((dbf) => new File(dbf));
-  }
-
-  /**
-   * Select one file descriptor
-   *
-   * @param where
-   * @returns {Promise<File|null>}
-   */
-  static async findOne(where) {
-    if (where.id) {
-      const { getState } = require("../db/state");
-      const cf = getState().files[+where.id];
-      if (cf) return new File(cf);
-    }
-    const f = await db.selectMaybeOne("_sc_files", where);
-    return f ? new File(f) : null;
-  }
-
-  /**
-   * Update File descriptor
-   *
-   * @param id - primary key
-   * @param row - row data
-   * @returns {Promise<void>} no returns
-   */
-  static async update(id, row) {
-    await db.update("_sc_files", row, id);
-    await require("../db/state").getState().refresh_files();
-  }
-
-  /**
-   * Get absolute path to new file in db.connectObj.file_store.
-   *
-   * @param suggest - path to file inside file store. If undefined that autogenerated uudv4 is used.
-   * @returns {string} - path to file
-   */
-  static get_new_path(suggest) {
-    const file_store = db.connectObj.file_store;
-
-    const newFnm = suggest || uuidv4();
-    return path.join(file_store, newFnm);
-  }
-
-  /**
-   * Ensure that file_store path is physically exists in file system.
-   * In reality just recursively creates full absolute path to db.connectObj.file_store.
-   *
-   * @returns {Promise<void>}
-   */
-  // TBD fs errors handling
-  static async ensure_file_store() {
-    const file_store = db.connectObj.file_store;
-    await fs.mkdir(file_store, { recursive: true });
-  }
-
-  /**
-   * Create new file
-   * @param file
-   * @param user_id
-   * @param min_role_read
-   * @returns {Promise<File>}
-   */
-  static async from_req_files(file, user_id, min_role_read = 1) {
-    if (Array.isArray(file)) {
-      return await asyncMap(file, (f) =>
-        File.from_req_files(f, user_id, min_role_read)
-      );
-    } else {
-      // get path to file
-      const newPath = File.get_new_path();
-      // set mime type
-      const [mime_super, mime_sub] = file.mimetype.split("/");
-      // move file in file system to newPath
-      await file.mv(newPath);
-      // create file
-      return await File.create({
-        filename: file.name,
-        location: newPath,
-        uploaded_at: new Date(),
-        size_kb: Math.round(file.size / 1024),
-        user_id,
-        mime_super,
-        mime_sub,
-        min_role_read,
-      });
-    }
-  }
-
-  /**
-   * Delete file
-   * @returns {Promise<{error}>}
-   */
-  async delete() {
-    try {
-      // delete file from database
-      await db.deleteWhere("_sc_files", { id: this.id });
-      // delete name and possible file from file system
-      await fs.unlink(this.location);
-      // reload file list cache
-      await require("../db/state").getState().refresh_files();
-    } catch (e) {
-      return { error: e.message };
-    }
-  }
-
-  /**
-   * MIME type of the file
-   * @type {string}
-   */
-  get mimetype() {
-    return `${this.mime_super}/${this.mime_sub}`;
-  }
-
-  /**
-   * Create file
-   * @param f
-   * @returns {Promise<File>}
-   */
-  static async create(f) {
-    const file = new File(f);
-    const { id, ...rest } = file;
-    // insert file descriptor row to database
-    file.id = await db.insert("_sc_files", rest);
-    // refresh file list cache
-    await require("../db/state").getState().refresh_files();
-
-    return file;
-  }
-}
-
-File.contract = {
-  variables: {
-    filename: is.str,
-    location: is.str,
-    mime_super: is.str,
-    mime_sub: is.str,
-    uploaded_at: is.class("Date"),
-    size_kb: is.posint,
-    id: is.maybe(is.posint),
-    user_id: is.maybe(is.posint),
-    min_role_read: is.posint,
-    // tdb add checksum
-  },
-  methods: {
-    delete: is.fun(
-      [],
-      is.promise(is.or(is.obj({ error: is.str }), is.undefined))
-    ),
-    mimetype: is.getter(is.str),
-  },
-  static_methods: {
-    find: is.fun(
-      [is.maybe(is.obj()), is.maybe(is.obj())],
-      is.promise(is.array(is.class("File")))
-    ),
-    findOne: is.fun(is.obj(), is.promise(is.maybe(is.class("File")))),
-    create: is.fun(is.obj(), is.promise(is.class("File"))),
-    from_req_files: is.fun(
-      [
-        is.or(is.obj(), is.array(is.obj())),
-        is.maybe(is.posint),
-        is.maybe(is.posint),
-      ],
-      is.promise(is.or(is.class("File"), is.array(is.class("File"))))
-    ),
-    update: is.fun([is.posint, is.obj()], is.promise(is.undefined)),
-    ensure_file_store: is.fun([], is.promise(is.undefined)),
-    get_new_path: is.fun(is.maybe(is.str), is.str),
-  },
-};
-
-module.exports = File;

package/models/form.js

@@ -1,168 +0,0 @@
-/**
- * Role Database Access Layer
- * @category saltcorn-data
- * @module models/form
- * @subcategory models
- */
-const { contract, is } = require("contractis");
-const db = require("../db");
-const Field = require("./field");
-
-/**
- * Form Class
- * @category saltcorn-data
- */
-class Form {
-  /**
-    * Constructor
-    * @param o
-    */
-  constructor(o) {
-    this.fields = o.fields.map((f) =>
-      f.constructor.name === Object.name ? new Field(f) : f
-    );
-    this.errors = o.errors || {};
-    this.values = o.values || {};
-    this.action = o.action;
-    this.layout = o.layout;
-    this.id = o.id;
-    this.labelCols = o.labelCols;
-    this.collapsedSummary = o.collapsedSummary;
-    this.isStateForm = !!o.isStateForm;
-    this.formStyle = o.formStyle || "horiz";
-    this.class = o.class;
-    this.methodGET = !!o.methodGET;
-    this.blurb = o.blurb;
-    this.submitLabel = o.submitLabel;
-    this.submitButtonClass = o.submitButtonClass;
-    this.noSubmitButton = o.noSubmitButton;
-    this.additionalButtons = o.additionalButtons;
-    this.onChange = o.onChange;
-    this.validator = o.validator;
-    this.hasErrors = false;
-    this.xhrSubmit = !!o.xhrSubmit;
-    this.req = o.req;
-    this.__ = o.__ || (o.req && o.req.__);
-    if (o.validate) this.validate(o.validate);
-    contract.class(this);
-  }
-
-  /**
-   * @param {object} ks 
-   */
-  hidden(...ks) {
-    ks.forEach((k) => {
-      !this.fields.map((f) => f.name).includes(k) &&
-        this.fields.push(
-          new Field({
-            name: k,
-            input_type: "hidden",
-          })
-        );
-    });
-  }
-
-  /**
-   * @param {boolean} [force_allow_none = false]
-   */
-  async fill_fkey_options(force_allow_none = false) {
-    for (const f of this.fields) {
-      await f.fill_fkey_options(force_allow_none);
-    }
-  }
-
-  /**
-   * @returns {Promise<object>}
-   */
-  async generate() {
-    var r = {};
-
-    for (const f of this.fields) {
-      if (f.input_type === "hidden") r[f.name] = this.values[f.name];
-      else if (f.required || is.bool.generate()) {
-        r[f.name] = await f.generate();
-      }
-    }
-    return r;
-  }
-
-  /**
-   * @type {string}
-   */
-  get errorSummary() {
-    let strs = [];
-    Object.entries(this.errors).forEach(([k, v]) => {
-      strs.push(`${k}: ${v}`);
-    });
-    return strs.join("; ");
-  }
-
-  /**
-   * @param {*} v 
-   * @returns {object}
-   */
-  validate(v) {
-    this.hasErrors = false;
-    this.errors = {};
-    this.fields.forEach((f) => {
-      if (f.disabled || f.calculated) return;
-      if (f.fieldview && f.type && f.type.fieldviews) {
-        const fv = f.type.fieldviews[f.fieldview];
-        if (fv && !fv.isEdit) return;
-      }
-      const valres = f.validate(v);
-      if (valres.error) {
-        this.errors[f.name] = valres.error;
-        this.values[f.name] = v[f.name];
-        this.hasErrors = true;
-      } else {
-        if (f.parent_field) {
-          if (!this.values[f.parent_field]) this.values[f.parent_field] = {};
-          this.values[f.parent_field][f.name] = valres.success;
-        } else this.values[f.name] = valres.success;
-      }
-    });
-
-    if (Object.keys(this.errors).length > 0) {
-      return { errors: this.errors };
-    } else {
-      if (this.validator) {
-        const fvalres = this.validator(this.values);
-        if (typeof fvalres === "string") {
-          this.hasErrors = true;
-          this.errors._form = fvalres;
-          return { errors: this.errors };
-        }
-      }
-      return { success: this.values };
-    }
-  }
-}
-
-Form.contract = {
-  variables: {
-    fields: is.array(is.or(is.class("Field"), is.class("FieldRepeat"))),
-    values: is.obj(),
-    errors: is.obj(),
-    action: is.maybe(is.str),
-    labelCols: is.maybe(is.posint),
-    hasErrors: is.bool,
-    submitLabel: is.maybe(is.str),
-    blurb: is.maybe(is.or(is.str, is.array(is.str))),
-    class: is.maybe(is.str),
-    isStateForm: is.bool,
-    formStyle: is.str,
-    methodGET: is.bool,
-  },
-  methods: {
-    validate: is.fun(
-      is.obj(),
-      is.or(is.obj({ errors: is.obj() }), is.obj({ success: is.obj() }))
-    ),
-    generate: is.fun([], is.promise(is.obj())),
-    fill_fkey_options: is.fun(is.maybe(is.bool), is.promise()),
-    hidden: is.fun(is.any, is.eq(undefined)),
-  },
-};
-
-module.exports = Form;

package/models/layout.js

@@ -1,146 +0,0 @@
-/**
- * @category saltcorn-data
- * @module models/layout
- * @subcategory models
- */
-const { getState } = require("../db/state");
-
-/**
- * @param {object} layout 
- * @param {object[]} visitors 
- * @returns {void}
- */
-const traverseSync = (layout, visitors) => {
-  const go = (segment) => {
-    if (!segment) return;
-    if (visitors[segment.type]) {
-      visitors[segment.type](segment);
-    }
-    if (Array.isArray(segment)) {
-      for (const seg of segment) go(seg);
-      return;
-    }
-    if (segment.contents) {
-      if (typeof contents !== "string") go(segment.contents);
-      return;
-    }
-    if (segment.above) {
-      for (const seg of segment.above) go(seg);
-      return;
-    }
-    if (segment.besides) {
-      for (const seg of segment.besides) go(seg);
-      return;
-    }
-  };
-  go(layout);
-};
-
-/**
- * @param {object} layout 
- * @param {object[]} visitors 
- * @returns {Promise<void>}
- */
-const traverse = async (layout, visitors) => {
-  const go = async (segment) => {
-    if (!segment) return;
-    if (visitors[segment.type]) {
-      await visitors[segment.type](segment);
-      return;
-    }
-    if (Array.isArray(segment)) {
-      for (const seg of segment) await go(seg);
-      return;
-    }
-    if (segment.contents) {
-      if (typeof contents !== "string") await go(segment.contents);
-      return;
-    }
-    if (segment.above) {
-      for (const seg of segment.above) await go(seg);
-      return;
-    }
-    if (segment.besides) {
-      for (const seg of segment.besides) await go(seg);
-      return;
-    }
-  };
-  await go(layout);
-};
-
-/**
- * @param {object} layout 
- * @param {*} f 
- * @returns {void}
- */
-const eachView = (layout, f) => traverse(layout, { view: f });
-
-/**
- * @param {object} layout 
- * @returns {Promise<object[]>}
- */
-const getViews = async (layout) => {
-  const views = [];
-  await eachView(layout, (segment) => {
-    views.push(segment);
-  });
-  return views;
-};
-
-/**
- * @param {object} layout 
- * @returns {string[]}
- */
-const getStringsForI18n = (layout) => {
-  const strings = [];
-  traverseSync(layout, {
-    blank(s) {
-      if (typeof s === "string") strings.push(s);
-      else if (s.contents) strings.push(s.contents);
-    },
-    link({ text }) {
-      strings.push(text);
-    },
-    card({ title }) {
-      strings.push(title);
-    },
-    tabs({ titles }) {
-      strings.push(...titles);
-    },
-  });
-  return strings;
-};
-
-/**
- * @param {object} layout 
- * @param {object} locale 
- */
-const translateLayout = (layout, locale) => {
-  const appState = getState()
-  const __ = (s) => appState.i18n.__({ phrase: s, locale }) || s;
-
-  traverseSync(layout, {
-    blank(s) {
-      s.contents = __(s.contents);
-    },
-    link(s) {
-      s.text = __(s.text);
-    },
-    card(s) {
-      s.title = __(s.title);
-    },
-    tabs(s) {
-      s.titles = s.titles.map((t) => __(t));
-    },
-  });
-};
-//getViews: is.fun([], is.promise(is.array(is.obj()))),
-//eachView: is.fun(is.fun(is.obj(), is.any), is.promise(is.undefined)),
-module.exports = {
-  eachView,
-  getViews,
-  traverse,
-  traverseSync,
-  getStringsForI18n,
-  translateLayout,
-};