@saltcorn/data 0.6.1 → 0.6.2-beta.3

package/models/library.js

@@ -1,135 +0,0 @@
-/**
- * Library Database Access Layer
- * @category saltcorn-data
- * @module models/library
- * @subcategory models
- */
-const db = require("../db");
-const { contract, is } = require("contractis");
-const { traverseSync } = require("./layout");
-
-/**
- * Library Class
- * @category saltcorn-data
- */
-class Library {
-  /**
-   * Library constructor
-   * @param {object} o 
-   */
-  constructor(o) {
-    this.id = o.id;
-    this.name = o.name;
-    this.icon = o.icon;
-    this.layout =
-      typeof o.layout === "string" ? JSON.parse(o.layout) : o.layout;
-  }
-
-  /**
-   * @param {object} lib_in 
-   */
-  static async create(lib_in) {
-    const lib = new Library(lib_in);
-    await db.insert("_sc_library", {
-      name: lib.name,
-      icon: lib.icon,
-      layout: lib.layout,
-    });
-  }
-
-  /**
-   * @type {...*}
-   */
-  get toJson() {
-    const { id, ...rest } = this;
-    return rest;
-  }
-
-  /**
-   * @param {*} where 
-   * @param {*} selectopts 
-   * @returns {Library[]}
-   */
-  static async find(where, selectopts) {
-    const us = await db.select("_sc_library", where, selectopts);
-    return us.map((u) => new Library(u));
-  }
-
-  /**
-   * @param {*} where 
-   * @returns {Library}
-   */
-  static async findOne(where) {
-    const u = await db.selectMaybeOne("_sc_library", where);
-    return u ? new Library(u) : u;
-  }
-
-  /**
-   * @param {*} what 
-   * @returns {object}
-   */
-  suitableFor(what) {
-    let notPage, notShow, notEdit, notFilter;
-    if (!this.layout) return false;
-    const layout = this.layout.layout ? this.layout.layout : this.layout;
-    traverseSync(layout, {
-      search_bar() {
-        //eg: search - only page and filter
-        notShow = true;
-        notEdit = true;
-      },
-      dropdown_filter() {
-        notShow = true;
-        notEdit = true;
-        notPage = true;
-      },
-      toggle_filter() {
-        notShow = true;
-        notEdit = true;
-        notPage = true;
-      },
-      field() {
-        notFilter = true;
-        notPage = true;
-      },
-      view_link() {
-        notFilter = true;
-        notEdit = true;
-      },
-      aggregation() {
-        notFilter = true;
-        notEdit = true;
-        notPage = true;
-      },
-      join_field() {
-        notFilter = true;
-        notEdit = true;
-        notPage = true;
-      },
-    });
-    return {
-      page: !notPage,
-      show: !notShow,
-      edit: !notEdit,
-      filter: !notFilter,
-    }[what];
-  }
-
-  /**
-   * @returns {Promise<void>}
-   */
-  async delete() {
-    const schema = db.getTenantSchemaPrefix();
-    await db.query(`delete FROM ${schema}_sc_library WHERE id = $1`, [this.id]);
-  }
-
-  /**
-   * @param {*} row
-   * @returns {Promise<void>}
-   */
-  async update(row) {
-    await db.update("_sc_library", row, this.id);
-  }
-}
-
-module.exports = Library;

package/models/pack.js

@@ -1,466 +0,0 @@
-/**
- * @category saltcorn-data
- * @module models/pack
- * @subcategory models
- */
-const Table = require("./table");
-const db = require("../db");
-const View = require("./view");
-const User = require("./user");
-const Field = require("./field");
-const Trigger = require("./trigger");
-const { getState } = require("../db/state");
-const fetch = require("node-fetch");
-const { contract, is } = require("contractis");
-const Page = require("./page");
-const { is_pack, is_plugin } = require("../contracts");
-const TableConstraint = require("./table_constraints");
-const { tr } = require("@saltcorn/markup/tags");
-const Role = require("./role");
-const Library = require("./library");
-
-const pack_fun = is.fun(is.str, is.promise(is.obj()));
-
-/**
- * @function
- * @param {string} name
- * @returns {Promise<object>}
- */
-const table_pack = contract(pack_fun, async (name) => {
-  const table = await Table.findOne({ name });
-  const fields = await table.getFields();
-  const strip_ids = (o) => {
-    delete o.id;
-    delete o.table_id;
-    return o;
-  };
-  //const triggers = await Trigger.find({ table_id: table.id });
-  const constraints = await TableConstraint.find({ table_id: table.id });
-
-  return {
-    name: table.name,
-    min_role_read: table.min_role_read,
-    min_role_write: table.min_role_write,
-    versioned: table.versioned,
-    ownership_formula: table.ownership_formula,
-    fields: fields.map((f) => strip_ids(f.toJson)),
-    //triggers: triggers.map((tr) => tr.toJson),
-    constraints: constraints.map((c) => c.toJson),
-    ownership_field_name: table.owner_fieldname_from_fields(fields),
-  };
-});
-
-/**
- * @function
- * @param {string} name
- * @returns {Promise<object>}
- */
-const view_pack = contract(pack_fun, async (name) => {
-  const view = await View.findOne({ name });
-  const table = await Table.findOne({ id: view.table_id });
-
-  return {
-    name: view.name,
-    viewtemplate: view.viewtemplate,
-    configuration: view.configuration,
-    min_role: view.min_role,
-    table: table ? table.name : null,
-    menu_label: view.menu_label,
-    default_render_page: view.default_render_page,
-  };
-});
-
-/**
- * @function
- * @param {string} name
- * @returns {Promise<object>}
- */
-const plugin_pack = contract(pack_fun, async (name) => {
-  const Plugin = require("./plugin");
-  const plugin = await Plugin.findOne({ name });
-
-  return {
-    name: plugin.name,
-    source: plugin.source,
-    location: plugin.location,
-    configuration: plugin.configuration,
-    deploy_private_key: plugin.deploy_private_key,
-  };
-});
-
-/**
- * @function
- * @param {string} name
- * @returns {Promise<object>}
- */
-const page_pack = contract(pack_fun, async (name) => {
-  const page = await Page.findOne({ name });
-  const root_page_for_roles = await page.is_root_page_for_roles();
-  return {
-    name: page.name,
-    title: page.title,
-    description: page.description,
-    min_role: page.min_role,
-    layout: page.layout,
-    fixed_states: page.fixed_states,
-    menu_label: page.menu_label,
-    root_page_for_roles,
-  };
-});
-
-/**
- * @function
- * @param {string} name
- * @returns {Promise<object>}
- */
-const library_pack = contract(pack_fun, async (name) => {
-  const lib = await Library.findOne({ name });
-  return lib.toJson;
-});
-
-/**
- * @function
- * @param {string} name
- * @returns {Promise<object>}
- */
-const trigger_pack = contract(pack_fun, async (name) => {
-  const trig = await Trigger.findOne({ name });
-  return trig.toJson;
-});
-
-/**
- * @function
- * @param {string} role
- * @returns {Promise<object>}
- */
-const role_pack = contract(pack_fun, async (role) => {
-  return await Role.findOne({ role });
-});
-
-/**
- * @function
- * @param {string} pack
- * @returns {Promise<boolean|object>}
- */
-const can_install_pack = contract(
-  is.fun(
-    is_pack,
-    is.promise(
-      is.or(
-        is.eq(true),
-        is.obj({ error: is.maybe(is.str), warning: is.maybe(is.str) })
-      )
-    )
-  ),
-  async (pack) => {
-    const warns = [];
-    const allTables = (await Table.find()).map((t) =>
-      db.sqlsanitize(t.name.toLowerCase())
-    );
-    const allViews = (await View.find()).map((t) => t.name);
-    const allPages = (await Page.find()).map((t) => t.name);
-    const packTables = (pack.tables || []).map((t) =>
-      db.sqlsanitize(t.name.toLowerCase())
-    );
-    const matchTables = allTables.filter((dbt) =>
-      packTables.some((pt) => pt === dbt && pt !== "users")
-    );
-    const matchViews = allViews.filter((dbt) =>
-      (pack.views || []).some((pt) => pt.name === dbt)
-    );
-    const matchPages = allPages.filter((dbt) =>
-      (pack.pages || []).some((pt) => pt.name === dbt)
-    );
-
-    if (matchTables.length > 0)
-      return {
-        error: "Tables already exist: " + matchTables.join(),
-      };
-    pack.tables.forEach((t) => {
-      if (t.name === "users")
-        t.fields.forEach((f) => {
-          if (f.required) {
-            warns.push(
-              `User field '${f.name}' is required in pack, but there are existing users. You must set a value for each user and then change the field to be required. Got to <a href="/list/users">users table data</a>.`
-            );
-          }
-        });
-    });
-    matchViews.forEach((v) => {
-      warns.push(`Clashing view ${v}.`);
-    });
-    matchPages.forEach((p) => {
-      warns.push(`Clashing page ${p}.`);
-    });
-    if (warns.length > 0) return { warning: warns.join(" ") };
-    else return true;
-  }
-);
-
-/**
- * @function
- * @param {string} pack
- * @param {string} name
- * @returns {Promise<void>}
- */
-const uninstall_pack = contract(
-  is.fun([is_pack, is.str], is.promise(is.undefined)),
-  async (pack, name) => {
-    for (const pageSpec of pack.pages || []) {
-      const page = await Page.findOne({ name: pageSpec.name });
-      if (page) await page.delete();
-    }
-    for (const viewSpec of pack.views) {
-      const view = await View.findOne({ name: viewSpec.name });
-      if (view) await view.delete();
-    }
-    for (const tableSpec of pack.tables) {
-      const table = await Table.findOne({ name: tableSpec.name });
-      if (table && table.name === "users") continue;
-      if (table) {
-        const fields = await table.getFields();
-        for (const field of fields) {
-          if (field.is_fkey) await field.delete();
-        }
-        const triggers = await Trigger.find({ table_id: table.id });
-        for (const trigger of triggers) {
-          await trigger.delete();
-        }
-      }
-    }
-    for (const tableSpec of pack.tables) {
-      const table = await Table.findOne({ name: tableSpec.name });
-      if (table && table.name !== "users") await table.delete();
-    }
-
-    if (name) {
-      const existPacks = getState().getConfigCopy("installed_packs", []);
-
-      await getState().setConfig(
-        "installed_packs",
-        existPacks.filter((p) => p !== name)
-      );
-    }
-  }
-);
-
-/**
- * @function
- * @param {object} item
- * @returns {Promise<void>}
- */
-const add_to_menu = contract(
-  is.fun(
-    is.obj({ label: is.str, type: is.one_of(["View", "Page"]) }),
-    is.promise(is.undefined)
-  ),
-  async (item) => {
-    const current_menu = getState().getConfigCopy("menu_items", []);
-    current_menu.push(item);
-    await getState().setConfig("menu_items", current_menu);
-  }
-);
-
-/**
- * @function
- * @param {string} pack
- * @param {string} [name]
- * @param {function} loadAndSaveNewPlugin
- * @param {boolean} [bare_tables = false]
- * @returns {Promise<void>}
- */
-const install_pack = contract(
-  is.fun(
-    [is_pack, is.maybe(is.str), is.fun(is_plugin, is.undefined)],
-    is.promise(is.undefined)
-  ),
-  async (pack, name, loadAndSaveNewPlugin, bare_tables = false) => {
-    const Plugin = require("./plugin");
-    const existingPlugins = await Plugin.find({});
-    for (const plugin of pack.plugins) {
-      if (!existingPlugins.some((ep) => ep.name === plugin.name)) {
-        const p = new Plugin(plugin);
-        await loadAndSaveNewPlugin(p);
-      }
-    }
-    for (const role of pack.roles || []) {
-      await Role.create(role);
-    }
-    for (const lib of pack.library || []) {
-      await Library.create(lib);
-    }
-    for (const tableSpec of pack.tables) {
-      if (tableSpec.name !== "users") {
-        const table = await Table.create(tableSpec.name, tableSpec);
-        const [tbl_pk] = await table.getFields();
-        //set pk
-        const pack_pk = tableSpec.fields.find((f) => f.primary_key);
-        if (pack_pk) {
-          await tbl_pk.update(pack_pk);
-        }
-      }
-    }
-    for (const tableSpec of pack.tables) {
-      const table = await Table.findOne({ name: tableSpec.name });
-      const exfields = await table.getFields();
-      for (const field of tableSpec.fields) {
-        const exfield = exfields.find((f) => f.name === field.name);
-        if (!((table.name === "users" && field.name === "email") || exfield)) {
-          if (table.name === "users" && field.required)
-            await Field.create(
-              { table, ...field, required: false },
-              bare_tables
-            );
-          else await Field.create({ table, ...field }, bare_tables);
-        }
-      }
-      for (const trigger of tableSpec.triggers || [])
-        await Trigger.create({ table, ...trigger }); //legacy, not in new packs
-      for (const constraint of tableSpec.constraints || [])
-        await TableConstraint.create({ table, ...constraint });
-      if (tableSpec.ownership_field_name) {
-        const owner_field = await Field.findOne({
-          table_id: table.id,
-          name: tableSpec.ownership_field_name,
-        });
-        await table.update({ ownership_field_id: owner_field.id });
-      }
-    }
-    for (const viewSpec of pack.views) {
-      const {
-        table,
-        on_menu,
-        menu_label,
-        on_root_page,
-        ...viewNoTable
-      } = viewSpec;
-      const vtable = await Table.findOne({ name: table });
-      await View.create({
-        ...viewNoTable,
-        table_id: vtable ? vtable.id : null,
-      });
-      if (menu_label)
-        await add_to_menu({
-          label: menu_label,
-          type: "View",
-          viewname: viewSpec.name,
-          min_role: viewSpec.min_role || 10,
-        });
-    }
-    for (const triggerSpec of pack.triggers || []) {
-      await Trigger.create(triggerSpec);
-    }
-
-    for (const pageFullSpec of pack.pages || []) {
-      const { root_page_for_roles, menu_label, ...pageSpec } = pageFullSpec;
-      await Page.create(pageSpec);
-      for (const role of root_page_for_roles || []) {
-        const current_root = getState().getConfigCopy(role + "_home", "");
-        if (!current_root || current_root === "")
-          await getState().setConfig(role + "_home", pageSpec.name);
-      }
-      if (menu_label)
-        await add_to_menu({
-          label: menu_label,
-          type: "Page",
-          pagename: pageSpec.name,
-          min_role: pageSpec.min_role,
-        });
-    }
-    if (name) {
-      const existPacks = getState().getConfigCopy("installed_packs", []);
-      await getState().setConfig("installed_packs", [...existPacks, name]);
-    }
-  }
-);
-
-/**
- * @function
- * @param {Date} date
- * @param {string} [hours = 24]
- * @returns {boolean}
- */
-const is_stale = contract(
-  is.fun([is.or(is.class("Date"), is.str), is.maybe(is.posint)], is.bool),
-  (date, hours = 24) => {
-    const oneday = 60 * 60 * hours * 1000;
-    const now = new Date();
-    return new Date(date) < now - oneday;
-  }
-);
-
-/**
- * @function
- * @returns {object[]}
- */
-const fetch_available_packs = contract(
-  is.fun([], is.promise(is.array(is.obj({ name: is.str })))),
-  async () => {
-    const stored = getState().getConfigCopy("available_packs", false);
-    const stored_at = getState().getConfigCopy(
-      "available_packs_fetched_at",
-      false
-    );
-    //console.log("in fetch", stored_at, stored)
-    if (!stored || !stored_at || is_stale(stored_at)) {
-      const from_api = await fetch_available_packs_from_store();
-      await getState().setConfig("available_packs", from_api);
-      await getState().setConfig("available_packs_fetched_at", new Date());
-      return from_api;
-    } else return stored;
-  }
-);
-
-/**
- * @function
- * @returns {Promise<object[]>}
- */
-const fetch_available_packs_from_store = contract(
-  is.fun([], is.promise(is.array(is.obj({ name: is.str })))),
-  async () => {
-    //console.log("fetch packs");
-    const response = await fetch(
-      "http://store.saltcorn.com/api/packs?fields=name,description"
-    );
-
-    const json = await response.json();
-    return json.success;
-  }
-);
-
-/**
- * @function
- * @param {string} name
- * @returns {Promise<object|null>}
- */ 
-const fetch_pack_by_name = contract(
-  is.fun(
-    is.str,
-    is.promise(is.maybe(is.obj({ name: is.str, pack: is.obj() })))
-  ),
-  async (name) => {
-    const response = await fetch(
-      "http://store.saltcorn.com/api/packs?name=" + encodeURIComponent(name)
-    );
-    const json = await response.json();
-    if (json.success.length == 1) return json.success[0];
-    else return null;
-  }
-);
-
-module.exports = {
-  table_pack,
-  view_pack,
-  plugin_pack,
-  page_pack,
-  role_pack,
-  library_pack,
-  trigger_pack,
-  install_pack,
-  fetch_available_packs,
-  fetch_pack_by_name,
-  is_stale,
-  can_install_pack,
-  uninstall_pack,
-  add_to_menu,
-};