@saltcorn/data 0.6.1 → 0.6.2-beta.3

package/base-plugin/viewtemplates/feed.js

@@ -1,434 +0,0 @@
-/**
- * @category saltcorn-data
- * @module base-plugin/viewtemplates/feed
- * @subcategory base-plugin
- */
-const Field = require("../../models/field");
-const Table = require("../../models/table");
-const Form = require("../../models/form");
-const View = require("../../models/view");
-const Workflow = require("../../models/workflow");
-const { text, div, h4, hr, button } = require("@saltcorn/markup/tags");
-const { pagination } = require("@saltcorn/markup/helpers");
-const { renderForm, tabs, link } = require("@saltcorn/markup");
-const { mkTable } = require("@saltcorn/markup");
-const {} = require("./viewable_fields");
-const pluralize = require("pluralize");
-const {
-  link_view,
-  stateToQueryString,
-  stateFieldsToWhere,
-  stateFieldsToQuery,
-  readState,
-} = require("../../plugin-helper");
-const { InvalidConfiguration } = require("../../utils");
-const { getState } = require("../../db/state");
-
-/**
- * @param {object} req 
- * @returns {Workflow}
- */
-const configuration_workflow = (req) =>
-  new Workflow({
-    steps: [
-      {
-        name: req.__("Views"),
-        form: async (context) => {
-          const table = await Table.findOne(context.table_id);
-          const show_views = await View.find_table_views_where(
-            context.table_id,
-            ({ state_fields, viewtemplate, viewrow }) =>
-              viewtemplate.runMany &&
-              viewrow.name !== context.viewname &&
-              state_fields.some((sf) => sf.name === "id")
-          );
-          const create_views = await View.find_table_views_where(
-            context.table_id,
-            ({ state_fields, viewrow }) =>
-              viewrow.name !== context.viewname &&
-              state_fields.every((sf) => !sf.required)
-          );
-          const show_view_opts = show_views.map((v) => v.select_option);
-          const create_view_opts = create_views.map((v) => v.select_option);
-          return new Form({
-            fields: [
-              {
-                name: "show_view",
-                label: req.__("Single item view"),
-                type: "String",
-                sublabel: req.__(
-                  "The underlying individual view of each table row"
-                ),
-                required: true,
-                attributes: {
-                  options: show_view_opts,
-                },
-              },
-              {
-                name: "view_to_create",
-                label: req.__("Use view to create"),
-                sublabel: req.__(
-                  "If user has write permission.  Leave blank to have no link to create a new item"
-                ),
-                type: "String",
-                attributes: {
-                  options: create_view_opts,
-                },
-              },
-              {
-                name: "create_view_display",
-                label: req.__("Display create view as"),
-                type: "String",
-                required: true,
-                attributes: {
-                  options: "Link,Embedded,Popup",
-                },
-              },
-              {
-                name: "create_view_label",
-                label: req.__("Label for create"),
-                sublabel: req.__(
-                  "Label in link or button to create. Leave blank for a default label"
-                ),
-                type: "String",
-                showIf: { create_view_display: ["Link", "Popup"] },
-              },
-              {
-                name: "create_view_location",
-                label: req.__("Location"),
-                sublabel: req.__("Location of link to create new row"),
-                //required: true,
-                attributes: {
-                  options: [
-                    "Bottom left",
-                    "Bottom right",
-                    "Top left",
-                    "Top right",
-                  ],
-                },
-                type: "String",
-                showIf: { create_view_display: ["Link", "Popup"] },
-              },
-              ...(table.ownership_field_id
-                ? [
-                    {
-                      name: "always_create_view",
-                      label: req.__("Always show create view"),
-                      sublabel: req.__(
-                        "If off, only show create view if the query state is about the current user"
-                      ),
-                      type: "Bool",
-                    },
-                  ]
-                : []),
-            ],
-          });
-        },
-      },
-      {
-        name: req.__("Order and layout"),
-        form: async (context) => {
-          const table = await Table.findOne({ id: context.table_id });
-          const fields = await table.getFields();
-          return new Form({
-            fields: [
-              {
-                name: "order_field",
-                label: req.__("Order by"),
-                type: "String",
-                required: true,
-                attributes: {
-                  options: fields.map((f) => f.name),
-                },
-              },
-              {
-                name: "descending",
-                label: req.__("Descending"),
-                type: "Bool",
-                required: true,
-              },
-              {
-                name: "cols_sm",
-                label: req.__("Columns small screen"),
-                type: "Integer",
-                attributes: {
-                  min: 1,
-                  max: 4,
-                },
-                required: true,
-                default: 1,
-              },
-              {
-                name: "cols_md",
-                label: req.__("Columns medium screen"),
-                type: "Integer",
-                attributes: {
-                  min: 1,
-                  max: 4,
-                },
-                required: true,
-                default: 1,
-              },
-              {
-                name: "cols_lg",
-                label: req.__("Columns large screen"),
-                type: "Integer",
-                attributes: {
-                  min: 1,
-                  max: 4,
-                },
-                required: true,
-                default: 1,
-              },
-              {
-                name: "cols_xl",
-                label: req.__("Columns extra-large screen"),
-                type: "Integer",
-                attributes: {
-                  min: 1,
-                  max: 4,
-                },
-                required: true,
-                default: 1,
-              },
-              {
-                name: "rows_per_page",
-                label: req.__("Items per page"),
-                type: "Integer",
-                attributes: {
-                  min: 1,
-                },
-                required: true,
-                default: 20,
-              },
-              {
-                name: "in_card",
-                label: req.__("Each in card?"),
-                type: "Bool",
-                required: true,
-              },
-              {
-                name: "masonry_columns",
-                label: req.__("Masonry columns"),
-                type: "Bool",
-                showIf: { in_card: true },
-                required: true,
-              },
-              {
-                name: "hide_pagination",
-                label: req.__("Hide pagination"),
-                type: "Bool",
-                required: true,
-              },
-            ],
-          });
-        },
-      },
-    ],
-  });
-
-/**
- * @param {number} table_id 
- * @param {*} viewname 
- * @param {object} opts
- * @param {*} opts.show_view 
- * @returns {Promise<Field>}
- */
-const get_state_fields = async (table_id, viewname, { show_view }) => {
-  const table_fields = await Field.find({ table_id });
-  return table_fields
-    .filter((f) => !f.primary_key)
-    .map((f) => {
-      const sf = new Field(f);
-      sf.required = false;
-      return sf;
-    });
-};
-
-/**
- * @param {number} table_id 
- * @param {string} viewname 
- * @param {object} opts
- * @param {string} opts.show_view
- * @param {name} opts.order_field
- * @param {boolean} opts.descending
- * @param {string} [opts.view_to_create]
- * @param {string} opts.create_view_display
- * @param {boolean} opts.in_card
- * @param {string} opts.masonry_columns
- * @param {number} [opts.rows_per_page = 20]
- * @param {boolean} opts.hide_pagination
- * @param {string} [opts.create_view_label]
- * @param {string} [opts.create_view_location]
- * @param {boolean} opts.always_create_view
- * @param {*} opts.cols
- * @param {object} state 
- * @param {*} extraArgs 
- * @returns {Promise<div>}
- */
-const run = async (
-  table_id,
-  viewname,
-  {
-    show_view,
-    order_field,
-    descending,
-    view_to_create,
-    create_view_display,
-    in_card,
-    masonry_columns,
-    rows_per_page = 20,
-    hide_pagination,
-    create_view_label,
-    create_view_location,
-    always_create_view,
-    ...cols
-  },
-  state,
-  extraArgs
-) => {
-  const table = await Table.findOne({ id: table_id });
-  const fields = await table.getFields();
-  readState(state, fields);
-  const appState = getState();
-  const locale = extraArgs.req.getLocale();
-  const __ = (s) => appState.i18n.__({ phrase: s, locale }) || s;
-
-  const sview = await View.findOne({ name: show_view });
-  if (!sview)
-    throw new InvalidConfiguration(
-      `View ${viewname} incorrectly configured: cannot find view ${show_view}`
-    );
-  const q = await stateFieldsToQuery({ state, fields });
-  let qextra = {};
-  if (!q.orderBy) {
-    qextra.orderBy = order_field;
-    if (descending) qextra.orderDesc = true;
-  }
-  qextra.limit = q.limit || rows_per_page;
-  const current_page = parseInt(state._page) || 1;
-
-  const sresp = await sview.runMany(state, {
-    ...extraArgs,
-    ...qextra,
-  });
-  let paginate = "";
-  if (!hide_pagination && (sresp.length === qextra.limit || current_page > 1)) {
-    const fields = await table.getFields();
-
-    const where = await stateFieldsToWhere({ fields, state });
-
-    const nrows = await table.countRows(where);
-    if (nrows > qextra.limit || current_page > 1) {
-      paginate = pagination({
-        current_page,
-        pages: Math.ceil(nrows / qextra.limit),
-        get_page_link: (n) => `javascript:gopage(${n}, ${qextra.limit})`,
-      });
-    }
-  }
-  const [vpos, hpos] = (create_view_location || "Bottom left").split(" ");
-  const istop = vpos === "Top";
-  const isright = hpos === "right";
-  const role =
-    extraArgs && extraArgs.req && extraArgs.req.user
-      ? extraArgs.req.user.role_id
-      : 10;
-  var create_link = "";
-  const user_id =
-    extraArgs && extraArgs.req.user ? extraArgs.req.user.id : null;
-  const about_user = fields.some(
-    (f) =>
-      f.reftable_name === "users" && state[f.name] && state[f.name] === user_id
-  );
-
-  if (
-    view_to_create &&
-    (role <= table.min_role_write ||
-      (table.ownership_field_id && (about_user || always_create_view)))
-  ) {
-    if (create_view_display === "Embedded") {
-      const create_view = await View.findOne({ name: view_to_create });
-      if (!create_view)
-        throw new InvalidConfiguration(
-          `View ${viewname} incorrectly configured: cannot find embedded view to create ${view_to_create}`
-        );
-      create_link = await create_view.run(state, extraArgs);
-    } else {
-      create_link = link_view(
-        `/view/${encodeURIComponent(view_to_create)}${stateToQueryString(
-          state
-        )}`,
-        __(create_view_label) || `Add ${pluralize(table.name, 1)}`,
-        create_view_display === "Popup",
-        create_view_display === "Popup" && "btn btn-secondary",
-        create_view_display === "Popup" && "btn-sm"
-      );
-    }
-  }
-  const create_link_div = isright
-    ? div({ class: "float-right" }, create_link)
-    : create_link;
-
-  const setCols = (sz) => `col-${sz}-${Math.round(12 / cols[`cols_${sz}`])}`;
-
-  const showRowInner = (r) =>
-    in_card
-      ? div(
-          { class: `card shadow ${masonry_columns ? "mt-2" : "mt-4"}` },
-          div({ class: "card-body" }, r.html)
-        )
-      : r.html;
-
-  const showRow = (r) =>
-    div(
-      {
-        class: [setCols("sm"), setCols("md"), setCols("lg"), setCols("xl")],
-      },
-      showRowInner(r)
-    );
-
-  const correct_order = ([main, pagin, create]) =>
-    istop ? [create, main, pagin] : [main, pagin, create];
-
-  const inner =
-    in_card && masonry_columns
-      ? div(
-          correct_order([
-            div({ class: "card-columns" }, sresp.map(showRowInner)),
-            paginate,
-            create_link_div,
-          ])
-        )
-      : div(
-          correct_order([
-            div({ class: "row" }, sresp.map(showRow)),
-            paginate,
-            create_link_div,
-          ])
-        );
-
-  return inner;
-};
-
-module.exports = {
-  /** @type {string} */
-  name: "Feed",
-  /** @type {string} */
-  description:
-    "Show multiple rows by displaying a chosen view for each row, stacked or in columns",
-  configuration_workflow,
-  run,
-  get_state_fields,
-  /** @type {boolean} */
-  display_state_form: false,
-  /**
-   * @param {object} opts 
-   * @param {*} opts.create_view_label
-   * @returns {string[]|Object[]}
-   */
-  getStringsForI18n({ create_view_label }) {
-    if (create_view_label) return [create_view_label];
-    else return [];
-  },
-};