@saltcorn/server 1.1.1-rc.1 → 1.1.1-rc.2

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## 1.1.1 - In beta
 
+* Full-text search improvements: 
+    - An index for full-text search can now be created. When creating an index in
+      the constraints setting for a table, you can select "Full-text search" in
+      the field selector. This will dramatically speed up search on large tables.
+    - Use websearch_to_tsquery if available. This is a more natural and modern syntax.
+    - Link to syntax examples in /search
+    - Use default locale's language for search localisation.
+    - Option to show results in tabs in search configuration.
+
 * select_by_view fieldview for Key fields: the user selects the value of a 
   Key field based on an clicking in a row of rendered views (typically a Show view) of the joined table. Works for both Edit and Filter views.
 
@@ -38,6 +47,7 @@
     - ForLoop step type for loops over arrays.
     - Varius UX improvements for editing workflows
     - Integrate copilot, if installed, in workflow editing
+    - Call non-workflow trigger actions.
 
 * sbadmin2 theme - Color update: dark side bar, darker primary blue
 

package/locales/en.json

@@ -1545,5 +1545,11 @@
 	"The home page is the page that is served when the user visits the home location (/). This can be set for each user role.": "The home page is the page that is served when the user visits the home location (/). This can be set for each user role.",
 	"Trigger %s deleted": "Trigger %s deleted",
 	"Edit menu": "Edit menu",
-	"Minimum role to edit menu": "Minimum role to edit menu"
+	"Minimum role to edit menu": "Minimum role to edit menu",
+	"Full-text search index is not available as the table contains Key fields (%s) with the \"Include in full-text search\" option enabled. Disable this before creating a Full-text search index": "Full-text search index is not available as the table contains Key fields (%s) with the \"Include in full-text search\" option enabled. Disable this before creating a Full-text search index",
+	"Share Extension Provisioning Profile": "Share Extension Provisioning Profile",
+	"Show results in": "Show results in",
+	"Show results from each table in this type of element": "Show results from each table in this type of element",
+	"Search syntax help": "Search syntax help",
+	"Search syntax": "Search syntax"
 }

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@saltcorn/server",
-  "version": "1.1.1-rc.1",
+  "version": "1.1.1-rc.2",
   "description": "Server app for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.451.0",
-    "@saltcorn/base-plugin": "1.1.1-rc.1",
-    "@saltcorn/builder": "1.1.1-rc.1",
-    "@saltcorn/data": "1.1.1-rc.1",
-    "@saltcorn/admin-models": "1.1.1-rc.1",
-    "@saltcorn/filemanager": "1.1.1-rc.1",
-    "@saltcorn/markup": "1.1.1-rc.1",
-    "@saltcorn/plugins-loader": "1.1.1-rc.1",
-    "@saltcorn/sbadmin2": "1.1.1-rc.1",
+    "@saltcorn/base-plugin": "1.1.1-rc.2",
+    "@saltcorn/builder": "1.1.1-rc.2",
+    "@saltcorn/data": "1.1.1-rc.2",
+    "@saltcorn/admin-models": "1.1.1-rc.2",
+    "@saltcorn/filemanager": "1.1.1-rc.2",
+    "@saltcorn/markup": "1.1.1-rc.2",
+    "@saltcorn/plugins-loader": "1.1.1-rc.2",
+    "@saltcorn/sbadmin2": "1.1.1-rc.2",
     "@socket.io/cluster-adapter": "^0.2.1",
     "@socket.io/sticky": "^1.0.1",
     "adm-zip": "0.5.10",

package/routes/actions.js

@@ -731,7 +731,7 @@ const getWorkflowStepForm = async (
             },
           };
         if (cfgFld.input_type === "code") cfgFld.input_type = "textarea";
-        actionConfigFields.push(cfgFld)
+        actionConfigFields.push(cfgFld);
       }
     } catch {}
   }
@@ -745,6 +745,21 @@ const getWorkflowStepForm = async (
       wf_action_name: Trigger.find({ action: "Workflow" }).map((wf) => wf.name),
     },
   });
+  const nonWfTriggerNames = Trigger.find({})
+    .filter((tr) => tr.action !== "Workflow")
+    .map((wf) => wf.name);
+
+  actionConfigFields.push({
+    label: "Row expression",
+    name: "row_expr",
+    type: "String",
+    class: "validate-expression",
+    sublabel:
+      "Expression for the object to set the <code>row</code> value to inside the action. If blank, set to whole context",
+    showIf: {
+      wf_action_name: nonWfTriggerNames,
+    },
+  });
 
   const builtInActionExplainers = WorkflowStep.builtInActionExplainers({
     api_call: trigger.when_trigger == "API call",
@@ -752,6 +767,7 @@ const getWorkflowStepForm = async (
   const actionsNotRequiringRow = Trigger.action_options({
     notRequireRow: true,
     noMultiStep: true,
+    apiNeverTriggers: true,
     builtInLabel: "Workflow Actions",
     builtIns: Object.keys(builtInActionExplainers),
     forWorkflow: true,

package/routes/search.js

@@ -8,6 +8,8 @@ const Router = require("express-promise-router");
 const { span, h5, h4, nbsp, p, a, div } = require("@saltcorn/markup/tags");
 
 const { getState } = require("@saltcorn/data/db/state");
+const db = require("@saltcorn/data/db");
+
 const { isAdmin, error_catcher } = require("./utils.js");
 const Form = require("@saltcorn/data/models/form");
 const Table = require("@saltcorn/data/models/table");
@@ -58,6 +60,13 @@ const searchConfigForm = (tables, views, req) => {
     sublabel: req.__("Use table description instead of name as header"),
     type: "Bool",
   });
+  fields.push({
+    name: "search_results_decoration",
+    label: req.__("Show results in"),
+    sublabel: req.__("Show results from each table in this type of element"),
+    input_type: "select",
+    options: ["Cards", "Tabs"],
+  });
   const blurb1 = req.__(
     `Choose views for <a href="/search">search results</a> for each table.<br/>Set to blank to omit table from global search.`
   );
@@ -95,6 +104,10 @@ router.get(
       "search_table_description",
       false
     );
+    form.values.search_results_decoration = getState().getConfig(
+      "search_results_decoration",
+      "Cards"
+    );
     send_infoarch_page({
       res,
       req,
@@ -126,13 +139,20 @@ router.post(
     const result = form.validate(req.body);
 
     if (result.success) {
+      const dbversion = await db.getVersion(true);
       const search_table_description =
         !!result.success.search_table_description;
       await getState().setConfig(
         "search_table_description",
         search_table_description
       );
+      await getState().setConfig(
+        "search_results_decoration",
+        result.success.search_results_decoration || "Cards"
+      );
+      await getState().setConfig("search_use_websearch", +dbversion >= 11.0);
       delete result.success.search_table_description;
+      delete result.success.search_results_decoration;
       await getState().setConfig("globalSearch", result.success);
       if (!req.xhr) res.redirect("/search/config");
       else res.json({ success: "ok" });
@@ -196,9 +216,12 @@ const runSearch = async ({ q, _page, table }, req, res) => {
     "search_table_description",
     false
   );
+  const search_results_decoration = getState().getConfig(
+    "search_results_decoration",
+    "Cards"
+  );
   const current_page = parseInt(_page) || 1;
   const offset = (current_page - 1) * page_size;
-  let resp = [];
   let tablesWithResults = [];
   let tablesConfigured = 0;
   for (const [tableName, viewName] of Object.entries(cfg)) {
@@ -206,7 +229,9 @@ const runSearch = async ({ q, _page, table }, req, res) => {
       !viewName ||
       viewName === "" ||
       viewName === "search_table_description" ||
-      tableName === "search_table_description"
+      tableName === "search_table_description" ||
+      viewName === "search_results_decoration" ||
+      tableName === "search_results_decoration"
     )
       continue;
     tablesConfigured += 1;
@@ -238,10 +263,9 @@ const runSearch = async ({ q, _page, table }, req, res) => {
     }
 
     if (vresps.length > 0) {
-      tablesWithResults.push({ tableName, label: sectionHeader });
-      resp.push({
-        type: "card",
-        title: span({ id: tableName }, sectionHeader),
+      tablesWithResults.push({
+        tableName,
+        label: sectionHeader,
         contents: vresps.map((vr) => vr.html).join("<hr>") + paginate,
       });
     }
@@ -251,17 +275,36 @@ const runSearch = async ({ q, _page, table }, req, res) => {
   const form = searchForm();
   form.validate({ q });
 
+  const mkResultDisplay = () => {
+    switch (search_results_decoration) {
+      case "Tabs":
+        const tabContents = {};
+        tablesWithResults.forEach((tblRes) => {
+          tabContents[tblRes.label] = tblRes.contents;
+        });
+        return [{ type: "card", tabContents }];
+
+      default:
+        return tablesWithResults.map((tblRes) => ({
+          type: "card",
+          title: span({ id: tblRes.tableName }, tblRes.label),
+          contents: tblRes.contents,
+        }));
+    }
+  };
+
   // Prepare search result visualization
   const searchResult =
-    resp.length === 0
+    tablesWithResults.length === 0
       ? [{ type: "card", contents: req.__("Not found") }]
-      : resp;
+      : mkResultDisplay();
   res.sendWrap(req.__("Search all tables"), {
     above: [
       {
         type: "card",
         contents: div(
           renderForm(form, false),
+          syntax_help_link(req),
           typeof table !== "undefined" &&
             tablesConfigured > 1 &&
             div(
@@ -296,6 +339,19 @@ const runSearch = async ({ q, _page, table }, req, res) => {
   });
 };
 
+const syntax_help_link = (req) => {
+  const use_websearch = getState().getConfig("search_use_websearch", false);
+  if (use_websearch)
+    return a(
+      {
+        href: "javascript:void(0);",
+        onclick: "ajax_modal('/search/syntax-help')",
+      },
+      req.__("Search syntax")
+    );
+  else return "";
+};
+
 /**
  * Execute search or only show search form
  * @name get
@@ -327,9 +383,33 @@ router.get(
       }
 
       const form = searchForm();
-      form.noSubmitButton = false;
-      form.submitLabel = req.__("Search");
-      res.sendWrap(req.__("Search all tables"), renderForm(form, false));
+      res.sendWrap(req.__("Search all tables"), {
+        type: "card",
+        contents: renderForm(form, false) + syntax_help_link(req),
+      });
     }
   })
 );
+
+router.get(
+  "/syntax-help",
+  error_catcher(async (req, res) => {
+    res.sendWrap(
+      req.__("Search syntax help"),
+      div(
+        p(
+          `Individual words matched independently. Example <code>large cat</code>`
+        ),
+        p(
+          `Double quotes to match phrase as a single unit. Example <code>"large cat"</code> matches "the large cat sat..." but not "the large brown cat".`
+        ),
+        p(
+          `"or" to match either of two phrases. Example <code>cat or mouse</code>`
+        ),
+        p(
+          `"-" to exclude a word or phrase. Example <code>cat -mouse</code> does not match "cat and mouse"`
+        )
+      )
+    );
+  })
+);

package/routes/tables.js

@@ -1533,6 +1533,8 @@ router.get(
                   key: (r) =>
                     r.type === "Unique"
                       ? r.configuration.fields.join(", ")
+                      : r.type === "Index" && r.configuration?.field === "_fts"
+                      ? "Full text search"
                       : r.type === "Index"
                       ? r.configuration.field
                       : r.type === "Formula"
@@ -1629,11 +1631,23 @@ const constraintForm = (req, table, fields, type) => {
         ],
       });
     case "Index":
+      const fieldopts = fields.map((f) => ({ label: f.label, name: f.name }));
+      const hasIncludeFts = fields.filter((f) => f.attributes?.include_fts);
+      if (!db.isSQLite && !hasIncludeFts.length)
+        fieldopts.push({ label: "Full-text search", name: "_fts" });
       return new Form({
         action: `/table/add-constraint/${table.id}/${type}`,
-        blurb: req.__(
-          "Choose the field to be indexed. This make searching the table faster."
-        ),
+        blurb:
+          req.__(
+            "Choose the field to be indexed. This make searching the table faster."
+          ) +
+          " " +
+          (hasIncludeFts.length
+            ? req.__(
+                `Full-text search index is not available as the table contains Key fields (%s) with the "Include in full-text search" option enabled. Disable this before creating a Full-text search index`,
+                hasIncludeFts.map((f) => f.name).join(",")
+              )
+            : ""),
         fields: [
           {
             type: "String",
@@ -1641,7 +1655,7 @@ const constraintForm = (req, table, fields, type) => {
             label: "Field",
             required: true,
             attributes: {
-              options: fields.map((f) => ({ label: f.label, name: f.name })),
+              options: fieldopts,
             },
           },
         ],

package/tests/files.test.js

@@ -407,7 +407,7 @@ describe("visible_entries test", () => {
       .set("Cookie", staffCookie);
     expect(resp.statusCode).toBe(200);
     expect(
-      resp.body.directories.find((file) => file.filename === "subsubfolder")
+      resp.body.directories.find((file) => file.filename === "_sc_test_subfolder_one/subsubfolder")
     ).toBeDefined();
   });