@saltcorn/data 0.6.1 → 0.6.2-beta.3

package/models/page.js

@@ -1,255 +0,0 @@
-/**
- * Page Database Access Layer
- * @category saltcorn-data
- * @module models/page
- * @subcategory models
- */
-const db = require("../db");
-const { contract, is } = require("contractis");
-const View = require("./view");
-const Table = require("./table");
-const {
-  eachView,
-  traverseSync,
-  getStringsForI18n,
-  translateLayout,
-} = require("./layout");
-const { div } = require("@saltcorn/markup/tags");
-const { remove_from_menu } = require("./config");
-const {
-  action_link,
-  fill_presets,
-} = require("../base-plugin/viewtemplates/viewable_fields");
-const {
-  InvalidConfiguration,
-  satisfies,
-  structuredClone,
-} = require("../utils");
-
-/**
- * Page Class
- * @category saltcorn-data
- */
-class Page {
-  /**
-   * @param {object} o
-   */
-  constructor(o) {
-    this.name = o.name;
-    this.title = o.title;
-    this.description = o.description;
-    this.min_role = +o.min_role;
-    this.id = o.id;
-    this.layout =
-      typeof o.layout === "string" ? JSON.parse(o.layout) : o.layout;
-    this.fixed_states =
-      typeof o.fixed_states === "string"
-        ? JSON.parse(o.fixed_states)
-        : o.fixed_states || {};
-    contract.class(this);
-  }
-
-  /**
-   * Find pages in DB
-   * @param where
-   * @param selectopts
-   * @returns {Promise<*>}
-   */
-  static async find(where, selectopts = { orderBy: "name", nocase: true }) {
-    if (selectopts.cached) {
-      const { getState } = require("../db/state");
-      return getState().pages.map((t) => new Page(t));
-    }
-    const db_flds = await db.select("_sc_pages", where, selectopts);
-    return db_flds.map((dbf) => new Page(dbf));
-  }
-
-  /**
-   * Find one page
-   * @param where
-   * @returns {Promise<Page|*>}
-   */
-  static async findOne(where) {
-    const { getState } = require("../db/state");
-    const p = getState().pages.find(
-      where.id
-        ? (v) => v.id === +where.id
-        : where.name
-        ? (v) => v.name === where.name
-        : satisfies(where)
-    );
-    return p
-      ? new Page({
-          ...p,
-          layout: structuredClone(p.layout),
-          fixed_states: structuredClone(p.fixed_states),
-        })
-      : p;
-  }
-
-  /**
-   * Update page
-   * @param id
-   * @param row
-   * @returns {Promise<void>}
-   */
-  static async update(id, row) {
-    await db.update("_sc_pages", row, id);
-    await require("../db/state").getState().refresh_pages();
-  }
-  getStringsForI18n() {
-    return getStringsForI18n(this.layout);
-  }
-  /**
-   * Create page
-   * @param f
-   * @returns {Promise<Page>}
-   */
-  static async create(f) {
-    const page = new Page(f);
-    const { id, ...rest } = page;
-    const fid = await db.insert("_sc_pages", rest);
-    page.id = fid;
-    await require("../db/state").getState().refresh_pages();
-
-    return page;
-  }
-
-  /**
-   * Delete current page
-   * @returns {Promise<void>}
-   */
-  async delete() {
-    await db.deleteWhere("_sc_pages", { id: this.id });
-    const root_page_for_roles = await this.is_root_page_for_roles();
-    for (const role of root_page_for_roles) {
-      const { getState } = require("../db/state");
-      await getState().setConfig(role + "_home", "");
-    }
-    await remove_from_menu({ name: this.name, type: "Page" });
-    await require("../db/state").getState().refresh_pages();
-  }
-
-  /**
-   * Is root page for role
-   * @returns {Promise<*>}
-   */
-  async is_root_page_for_roles() {
-    const User = require("./user");
-    const { getState } = require("../db/state");
-
-    const roles = await User.get_roles();
-    return roles
-      .filter((r) => getState().getConfig(r.role + "_home", "") === this.name)
-      .map((r) => r.role);
-  }
-
-  /**
-   * get menu label for page
-   * @type {string|undefined}
-   */
-  get menu_label() {
-    const { getState } = require("../db/state");
-    const menu_items = getState().getConfig("menu_items", []);
-    const item = menu_items.find((mi) => mi.pagename === this.name);
-    return item ? item.label : undefined;
-  }
-
-  /**
-   * Clone page
-   * @returns {Promise<Page>}
-   */
-  async clone() {
-    const basename = this.name + " copy";
-    let newname;
-    for (let i = 0; i < 100; i++) {
-      newname = i ? `${basename} (${i})` : basename;
-      const existing = await Page.findOne({ name: newname });
-      if (!existing) break;
-    }
-    const createObj = {
-      ...this,
-      name: newname,
-    };
-    delete createObj.id;
-    return await Page.create(createObj);
-  }
-
-  /**
-   * Run (Show) page
-   * @param querystate
-   * @param extraArgs
-   * @returns {Promise<any>}
-   */
-  async run(querystate, extraArgs) {
-    await eachView(this.layout, async (segment) => {
-      const view = await View.findOne({ name: segment.view });
-      if (!view) {
-        throw new InvalidConfiguration(
-          `Page ${this.name} configuration error in embedded view: ` +
-            (segment.view
-              ? `view "${segment.view}" not found`
-              : "no view specified")
-        );
-      } else if (segment.state === "shared") {
-        const mystate = view.combine_state_and_default_state(querystate);
-        segment.contents = await view.run(mystate, extraArgs);
-      } else {
-        const table = Table.findOne({ id: view.table_id });
-        const state = segment.configuration || this.fixed_states[segment.name];
-        const filled = await fill_presets(table, extraArgs.req, state);
-        const mystate = view.combine_state_and_default_state(filled || {});
-        segment.contents = await view.run(mystate, extraArgs);
-      }
-    });
-    const pagename = this.name;
-    traverseSync(this.layout, {
-      action(segment) {
-        const url = `javascript:ajax_post_json('/page/${pagename}/action/${segment.rndid}')`;
-        const html = action_link(url, extraArgs.req, segment);
-        segment.type = "blank";
-        segment.contents = html;
-      },
-    });
-
-    translateLayout(this.layout, extraArgs.req.getLocale());
-    return this.layout;
-  }
-}
-
-/**
- * Page contract
- * @type {{variables: {min_role: ((function(*=): *)|*), layout: ((function(*=): *)|*), name: ((function(*=): *)|*), fixed_states: ((function(*=): *)|*), description: ((function(*=): *)|*), id: ((function(*=): *)|*), title: ((function(*=): *)|*)}, methods: {run: ((function(*=): *)|*), delete: ((function(*=): *)|*), is_root_page_for_roles: ((function(*=): *)|*), menu_label: ((function(*=): *)|*)}, static_methods: {find: ((function(*=): *)|*), findOne: ((function(*=): *)|*), create: ((function(*=): *)|*), update: ((function(*=): *)|*)}}}
- */
-Page.contract = {
-  variables: {
-    name: is.str,
-    title: is.str,
-    description: is.str,
-    id: is.maybe(is.posint),
-    min_role: is.posint,
-    layout: is.obj(),
-    fixed_states: is.obj(),
-  },
-  methods: {
-    delete: is.fun([], is.promise(is.undefined)),
-
-    menu_label: is.getter(is.maybe(is.str)),
-    run: is.fun(
-      [is.obj(), is.obj({ req: is.obj(), res: is.obj() })],
-      is.promise(is.any)
-    ),
-    is_root_page_for_roles: is.fun([], is.promise(is.array(is.str))),
-  },
-  static_methods: {
-    find: is.fun(
-      [is.maybe(is.obj()), is.maybe(is.obj())],
-      is.promise(is.array(is.class("Page")))
-    ),
-    create: is.fun(is.obj(), is.promise(is.class("Page"))),
-    findOne: is.fun(is.obj(), is.promise(is.maybe(is.class("Page")))),
-    update: is.fun([is.posint, is.obj()], is.promise(is.undefined)),
-  },
-};
-
-module.exports = Page;

package/models/plugin.js

@@ -1,219 +0,0 @@
-/**
- * Plugin Database Access Layer
- * @category saltcorn-data
- * @module models/plugin
- * @subcategory models
- */
-const db = require("../db");
-const { contract, is } = require("contractis");
-const View = require("./view");
-const { is_stale } = require("./pack");
-const fetch = require("node-fetch");
-const { stringToJSON } = require("../utils");
-
-/**
- * Plugin Class
- * @category saltcorn-data
- */
-class Plugin {
-  /**
-   * Plugin constructor
-   * @param {object} o
-   */
-  constructor(o) {
-    this.id = o.id ? +o.id : o.id;
-    this.name = o.name;
-    this.source = o.source;
-    this.location = o.location;
-    this.version = o.version;
-    this.description = o.description;
-    this.documentation_link = o.documentation_link;
-    this.has_theme = o.has_theme;
-    this.has_auth = o.has_auth;
-    this.deploy_private_key = o.deploy_private_key;
-    this.configuration = stringToJSON(o.configuration);
-    contract.class(this);
-  }
-
-  /**
-   * Find one plugin
-   * @param where - where object
-   * @returns {Promise<Plugin|null|*>} return existing plugin or new plugin
-   */
-  static async findOne(where) {
-    const p = await db.selectMaybeOne("_sc_plugins", where);
-    return p ? new Plugin(p) : p;
-  }
-
-  /**
-   * Find plugins
-   * @param where - where object
-   * @returns {Promise<*>} returns plugins list
-   */
-  static async find(where) {
-    return (await db.select("_sc_plugins", where)).map((p) => new Plugin(p));
-  }
-
-  /**
-   * Update or Insert plugin
-   * @returns {Promise<void>}
-   */
-  async upsert() {
-    const row = {
-      name: this.name,
-      source: this.source,
-      location: this.location,
-      version: this.version,
-      configuration: this.configuration,
-      deploy_private_key: this.deploy_private_key,
-    };
-    if (typeof this.id === "undefined") {
-      // insert
-      await db.insert("_sc_plugins", row);
-    } else {
-      await db.update("_sc_plugins", row, this.id);
-    }
-  }
-
-  /**
-   * Delete plugin
-   * @returns {Promise<void>}
-   */
-  async delete() {
-    await db.deleteWhere("_sc_plugins", { id: this.id });
-    const { getState } = require("../db/state");
-    await getState().remove_plugin(this.name);
-  }
-
-  /**
-   * Upgrade plugin version
-   * @param requirePlugin
-   * @returns {Promise<void>}
-   */
-  async upgrade_version(requirePlugin) {
-    if (this.source === "npm") {
-      const old_version = this.version;
-      this.version = "latest";
-      const { version } = await requirePlugin(this, true);
-      if (version && version !== old_version) {
-        this.version = version;
-        this.upsert();
-      }
-    } else {
-      await requirePlugin(this, true);
-    }
-  }
-
-  /**
-   * List of views relay on this plugin
-   * @returns {Promise<View[]>}
-   */
-  async dependant_views() {
-    const views = await View.find({});
-    const { getState } = require("../db/state");
-    if (!getState().plugins[this.name]) return [];
-    const myViewTemplates = getState().plugins[this.name].viewtemplates || [];
-    const vt_names = Array.isArray(myViewTemplates)
-      ? myViewTemplates.map((vt) => vt.name)
-      : typeof myViewTemplates === "function"
-      ? myViewTemplates(getState().plugin_cfgs[this.name]).map((vt) => vt.name)
-      : Object.keys(myViewTemplates);
-    return views
-      .filter((v) => vt_names.includes(v.viewtemplate))
-      .map((v) => v.name);
-  }
-
-  /**
-   * List plugins availabe in store
-   * @returns {Promise<*>}
-   */
-  static async store_plugins_available() {
-    const { getState } = require("../db/state");
-    const stored = getState().getConfig("available_plugins", false);
-    const stored_at = getState().getConfig(
-      "available_plugins_fetched_at",
-      false
-    );
-    const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
-
-    if (!stored || !stored_at || is_stale(stored_at)) {
-      try {
-        const from_api = await Plugin.store_plugins_available_from_store();
-        await getState().setConfig("available_plugins", from_api);
-        await getState().setConfig("available_plugins_fetched_at", new Date());
-        return from_api.filter((p) => isRoot || !p.has_auth);
-      } catch (e) {
-        console.error(e);
-        if (stored)
-          return stored
-            .map((p) => new Plugin(p))
-            .filter((p) => isRoot || !p.has_auth);
-        else throw e;
-      }
-    } else
-      return stored
-        .map((p) => new Plugin(p))
-        .filter((p) => isRoot || !p.has_auth);
-  }
-
-  /**
-   *
-   * @returns {Promise<*>}
-   */
-  static async store_plugins_available_from_store() {
-    //console.log("fetch plugins");
-    // TODO support of other store URLs
-    const response = await fetch("http://store.saltcorn.com/api/extensions");
-    const json = await response.json();
-    return json.success.map((p) => new Plugin(p));
-  }
-
-  /**
-   *
-   * @param name
-   * @returns {Promise<null|Plugin>}
-   */
-  static async store_by_name(name) {
-    // TODO support of other store URLs
-    const response = await fetch(
-      "http://store.saltcorn.com/api/extensions?name=" +
-        encodeURIComponent(name)
-    );
-    const json = await response.json();
-    if (json.success.length == 1)
-      return new Plugin({ version: "latest", ...json.success[0] });
-    else return null;
-  }
-}
-
-Plugin.contract = {
-  variables: {
-    id: is.maybe(is.posint),
-    location: is.str,
-    name: is.str,
-    version: is.maybe(is.str),
-    documentation_link: is.maybe(is.str),
-    configuration: is.maybe(is.obj()),
-    source: is.one_of(["npm", "github", "local", "git"]),
-  },
-  methods: {
-    upsert: is.fun([], is.promise(is.eq(undefined))),
-    delete: is.fun([], is.promise(is.eq(undefined))),
-    dependant_views: is.fun([], is.promise(is.array(is.str))),
-  },
-  static_methods: {
-    find: is.fun(is.maybe(is.obj()), is.promise(is.array(is.class("Plugin")))),
-    findOne: is.fun(is.obj(), is.promise(is.maybe(is.class("Plugin")))),
-    store_by_name: is.fun(is.str, is.promise(is.maybe(is.class("Plugin")))),
-    store_plugins_available_from_store: is.fun(
-      [],
-      is.promise(is.array(is.class("Plugin")))
-    ),
-    store_plugins_available: is.fun(
-      [],
-      is.promise(is.array(is.class("Plugin")))
-    ),
-  },
-};
-
-module.exports = Plugin;

package/models/random.js

@@ -1,206 +0,0 @@
-/**
- * View Database Access Layer
- * @category saltcorn-data
- * @module models/random
- * @subcategory models
- */
-const View = require("./view");
-const Field = require("./field");
-const Table = require("./table");
-const { getState } = require("../db/state");
-const { generate_attributes } = require("../plugin-testing");
-const { initial_config_all_fields } = require("../plugin-helper");
-const { contract, is } = require("contractis");
-const db = require("../db");
-
-/**
- * @param {object} [opts = {}]
- * @returns {Promise<Table>}
- */
-const random_table = async (opts = {}) => {
-  const name = is
-    .and(
-      is.sat((s) => db.sqlsanitize(s).length > 2),
-      is.str
-    )
-    .generate();
-  const table = await Table.create(name);
-  if (Math.random() < 0.3 && !opts.force_int_pk && !db.isSQLite) {
-    const [pk] = await table.getFields();
-    await pk.update({ type: "UUID" });
-    table.fields = null;
-  }
-  //fields
-  const nfields = is.integer({ gte: 2, lte: 10 }).generate();
-  const existing_field_names = ["id"];
-  for (let index = 0; index < nfields; index++) {
-    const field = await random_field(existing_field_names, table);
-    existing_field_names.push(field.label);
-
-    await Field.create(field);
-  }
-  //fill rows
-  for (let index = 0; index < 20; index++) {
-    await fill_table_row(table);
-  }
-  const fields = await table.getFields();
-  const userFields = fields.filter((f) => f.reftable_name === "users");
-  if (userFields.length > 0 && Math.random() > 0.5)
-    await table.update({ ownership_field_id: userFields[0].id });
-
-  return table;
-};
-
-/**
- * @param {Table} table 
- * @returns {Promise<*>}
- */
-const fill_table_row = async (table) => {
-  const fields = await table.getFields();
-  const row = {};
-  for (const f of fields) {
-    if (!f.calculated && (f.required || is.bool.generate()) && !f.primary_key)
-      row[f.name] = await f.generate();
-  }
-  //console.log(fields, row);
-  await table.tryInsertRow(row);
-};
-
-/**
- * @param {string} type 
- * @param {string[]} existing_fields 
- * @throws {Error} 
- * @returns {string}
- */
-const random_expression = (type, existing_fields) => {
-  const numField = existing_fields.find((f) =>
-    ["Integer", "Float"].includes(f.type)
-  );
-  switch (type) {
-    case "Bool":
-      if (numField) return `${numField.name}>0`;
-      else return is.one_of(["true", "false"]).generate();
-    case "Float":
-      if (numField) return `${numField.name}+1.5`;
-      else return "1.3";
-    case "Integer":
-      if (numField) return `${numField.name}+3`;
-      else return "7";
-    default:
-      throw new Error("random_expression: unknown type " + type);
-  }
-};
-
-/**
- * @param {string[]} existing_field_names 
- * @param {Table} table 
- * @returns {Promise<Field>}
- */
-const random_field = async (existing_field_names, table) => {
-  const tables = await Table.find({});
-  const tables_with_data = [];
-  for (const t of tables) {
-    const n = await t.countRows();
-    if (n > 0) tables_with_data.push(t);
-  }
-  const fkey_opts = [
-    ...tables_with_data.map((t) => `Key to ${t.name}`),
-    "Key to users",
-    "File",
-  ];
-  const type_options = getState().type_names.concat(fkey_opts || []);
-  const label = is
-    .and(
-      is.sat(
-        (s) =>
-          s.length > 2 && !existing_field_names.includes(Field.labelToName(s))
-      ),
-      is.str
-    )
-    .generate();
-
-  const type = is.one_of(type_options).generate();
-
-  if (Math.random() < 0.2 && ["Integer", "Float", "Bool"].includes(type)) {
-    const stored = Math.random() < 0.5;
-    const existing_fields = await Field.find(
-      {
-        table_id: table.id,
-        calculated: false,
-      },
-      {
-        orderBy: "RANDOM()",
-      }
-    );
-    const expression = random_expression(type, existing_fields);
-    const f = new Field({ type, label, calculated: true, stored, expression });
-    f.table_id = table.id;
-    return f;
-  }
-
-  const f = new Field({ type, label });
-  f.table_id = table.id;
-  if (f.type.attributes)
-    f.attributes = generate_attributes(
-      f.type.attributes,
-      f.type.validate_attributes,
-      table.id
-    );
-  if (f.is_fkey) {
-    if (f.reftable_name === "users") {
-      f.attributes.summary_field = "email";
-    } else if (f.reftable_name === "_sc_files") {
-      f.attributes.summary_field = "email";
-    } else {
-      const reftable = await Table.findOne({ name: f.reftable_name });
-      const reffields = (await reftable.getFields()).filter(
-        (f) => !f.calculated || f.stored
-      );
-      if (reffields.length > 0) {
-        const reff = is.one_of(reffields).generate();
-        f.attributes.summary_field = reff.name;
-      } else {
-        f.attributes.summary_field = "id";
-      }
-    }
-  }
-  // unique?
-  if (Math.random() < 0.25 && type !== "Bool") f.is_unique = true;
-  // required?
-  if (is.bool.generate()) f.required = true;
-  return f;
-};
-
-/**
- * @param {Table} table 
- * @param {string} viewtemplate 
- * @returns {Promise<View>}
- */
-const initial_view = async (table, viewtemplate) => {
-  const configuration = await initial_config_all_fields(
-    viewtemplate === "Edit"
-  )({ table_id: table.id });
-  //console.log(configuration);
-  const name = is.str.generate();
-  const view = await View.create({
-    name,
-    configuration,
-    viewtemplate,
-    table_id: table.id,
-    min_role: 10,
-  });
-  return view;
-};
-
-/**
- * @param {Table} table 
- * @returns {Promise<object[]>}
- */
-const all_views = async (table) => {
-  const list = await initial_view(table, "List");
-  const edit = await initial_view(table, "Edit");
-  const show = await initial_view(table, "Show");
-  return { list, show, edit };
-};
-
-module.exports = { random_table, fill_table_row, initial_view, all_views };