@saltcorn/copilot 0.4.1 → 0.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/copilot",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "AI assistant for building Saltcorn applications",
   "main": "index.js",
   "dependencies": {

package/user-copilot.js

@@ -68,10 +68,12 @@ const configuration_workflow = (req) =>
               viewtemplate: "Show",
             });
             show_view_opts[t.name] = views.map((v) => v.name);
-            const lviews = await View.find({
-              table_id: t.id,
-              viewtemplate: "List",
-            });
+            const lviews = await View.find_table_views_where(
+              t.id,
+              ({ state_fields, viewrow }) =>
+                viewrow.viewtemplate !== "Edit" &&
+                state_fields.every((sf) => !sf.required)
+            );
             list_view_opts[t.name] = lviews.map((v) => v.name);
           }
           return new Form({
@@ -105,6 +107,13 @@ const configuration_workflow = (req) =>
                       calcOptions: ["table_name", list_view_opts],
                     },
                   },
+                  {
+                    name: "exclude_fields",
+                    label: "Exclude fields",
+                    sublabel:
+                      "Exclude fields from the chat context. Comma-separated list.",
+                    type: "String",
+                  },
                 ],
               }),
             ],
@@ -203,6 +212,20 @@ const run = async (table_id, viewname, config, state, { res, req }) => {
                       "Copilot"
                     )
                   );
+              } else if (tool_call.function.name.startsWith("Query")) {
+                const query = JSON.parse(tool_call.function.arguments);
+                const queryText = query.sql_id_query
+                  ? query.sql_id_query
+                  : JSON.stringify(query, null, 2);
+                interactMarkups.push(
+                  wrapSegment(
+                    wrapCard(
+                      "Query " + tool_call.function.name.replace("Query", ""),
+                      pre(queryText)
+                    ),
+                    "Copilot"
+                  )
+                );
               }
             }
           } else
@@ -425,68 +448,19 @@ const getCompletionArguments = async (config) => {
 
     const table = Table.findOne({ name: tableCfg.table_name });
 
-    table.fields
-      .filter((f) => !f.primary_key)
-      .forEach((field) => {
-        properties[field.name] = {
-          description: field.label + " " + field.description || "",
-        };
-        if (field.type.name === "String") {
-          properties[field.name].anyOf = [
-            { type: "string", description: "Match this value exactly" },
-            {
-              type: "object",
-              properties: {
-                ilike: {
-                  type: "string",
-                  description: "Case insensitive substring match.",
-                },
-                in: {
-                  type: "array",
-                  description: "Match any one of these values",
-                  items: {
-                    type: "string",
-                  },
-                },
-              },
-            },
-          ];
-        }
-        if (field.type.name === "Integer" || field.type.name === "Float") {
-          const basetype = field.type.name === "Integer" ? "integer" : "number";
-          properties[field.name].anyOf = [
-            { type: basetype, description: "Match this value exactly" },
-            {
-              type: "object",
-              properties: {
-                gt: {
-                  type: basetype,
-                  description: "Greater than this value",
-                },
-                lt: {
-                  type: basetype,
-                  description: "Less than this value",
-                },
-                in: {
-                  type: "array",
-                  description: "Match any one of these values",
-                  items: {
-                    type: basetype,
-                  },
-                },
-              },
-            },
-          ];
-        } else Object.assign(fieldProperties(field), properties[field.name]);
-      });
-
+    properties.sql_id_query = {
+      type: "string",
+      description: `An SQL query for this table's primary keys (${table.pk_name}). This must select only the primary keys (even if the user wants a count), for example SELECT ${table.name[0]}."${table.pk_name}" from "${table.name}" ${table.name[0]} JOIN ... where... Use this to join other tables in the database.`,
+    };
+    properties.is_count = {
+      type: "boolean",
+      description: `Is the only desired output a count? Make this true if the user wants a count of rows`,
+    };
     tools.push({
       type: "function",
       function: {
         name: "Query" + table.name,
-        description: `Query the ${table.name} table. ${
-          table.description || ""
-        }`,
+        description: `Query the ${table.name} table and show the results to the user in a grid format`,
         parameters: {
           type: "object",
           //required: ["action_javascript_code", "action_name"],
@@ -524,9 +498,45 @@ const getCompletionArguments = async (config) => {
       },
     });
   }
+  const tables = (await Table.find({})).filter(
+    (t) => !t.external && !t.provider_name
+  );
+  const schemaPrefix = db.getTenantSchemaPrefix();
   const systemPrompt =
     "You are helping users retrieve information and perform actions on a relational database" +
-    config.sys_prompt;
+    config.sys_prompt +
+    `
+    If you are generating SQL, Your database the following tables in PostgreSQL: 
+
+` +
+    tables
+      .map(
+        (t) => `CREATE TABLE "${t.name}" (${
+          t.description
+            ? `
+  /* ${t.description} */`
+            : ""
+        }
+${t.fields
+  .map(
+    (f) =>
+      `  "${f.name}" ${
+        f.primary_key && f.type?.name === "Integer"
+          ? "SERIAL PRIMARY KEY"
+          : f.sql_type.replace(schemaPrefix, "")
+      }`
+  )
+  .join(",\n")}
+)`
+      )
+      .join(";\n\n") +
+    `
+      
+If the user asks to you show rows from a table, just run the query tool for that table. This will display the result to the user.
+You should not render the results again, that will cause them to be displayed twice. Only if the user asks for a summary
+or a calculation based on the query results should you show that requested summary or calculation.
+`;
+  //console.log("sysprompt", systemPrompt);
 
   if (tools.length === 0) tools = undefined;
   return { tools, systemPrompt };
@@ -562,7 +572,24 @@ const interact = async (table_id, viewname, config, body, { req, res }) => {
 };
 
 const renderQueryInteraction = async (table, result, config, req) => {
-  if (result.length === 0) return "No rows found";
+  if (typeof result === "number")
+    return wrapSegment(
+      wrapCard(
+        "Query " + table.name,
+        //div("Query: ", code(JSON.stringify(query))),
+        `${result}`
+      ),
+      "Copilot"
+    );
+  if (result.length === 0)
+    return wrapSegment(
+      wrapCard(
+        "Query " + table.name,
+        //div("Query: ", code(JSON.stringify(query))),
+        "No rows found"
+      ),
+      "Copilot"
+    );
 
   const tableCfg = config.tables.find((t) => t.table_name === table.name);
   let viewRes = "";
@@ -647,7 +674,10 @@ const process_interaction = async (
           result,
         });
 
-        if (typeof result === "object" && Object.keys(result || {}).length) {
+        if (
+          (typeof result === "object" && Object.keys(result || {}).length) ||
+          typeof result === "string"
+        ) {
           responses.push(
             wrapSegment(
               wrapCard(
@@ -665,7 +695,10 @@ const process_interaction = async (
               role: "tool",
               tool_call_id: tool_call.id,
               name: tool_call.function.name,
-              content: result ? JSON.stringify(result) : "Action run",
+              content:
+                result && typeof result !== "string"
+                  ? JSON.stringify(result)
+                  : result || "Action run",
             },
           ],
         });
@@ -673,11 +706,62 @@ const process_interaction = async (
         const table = Table.findOne({
           name: tool_call.function.name.replace("Query", ""),
         });
+        const tableCfg = config.tables.find((t) => t.table_name === table.name);
         const query = JSON.parse(tool_call.function.arguments);
-        const result = await table.getRows(query, {
-          forUser: req.user,
-          forPublic: !req.user,
-        });
+
+        const is_sqlite = db.isSQLite;
+
+        const client = is_sqlite ? db : await db.getClient();
+        await client.query(`BEGIN;`);
+        if (!is_sqlite) {
+          await client.query(
+            `SET LOCAL search_path TO "${db.getTenantSchema()}";`
+          );
+          await client.query(
+            `SET SESSION CHARACTERISTICS AS TRANSACTION READ ONLY;`
+          );
+        }
+
+        const { rows } = await client.query(query.sql_id_query);
+        await client.query(`ROLLBACK;`);
+
+        if (!is_sqlite) client.release(true);
+        let result;
+        const id_query = {
+          [table.pk_name]: { in: rows.map((r) => r[table.pk_name]) },
+        };
+
+        if (query.is_count) {
+          const role = req.user?.role_id || 100;
+          if (role <= table.min_role_read) {
+            result = await table.countRows(id_query);
+          } else result = "Not authorized";
+        } else {
+          result = await table.getRows(id_query, {
+            forUser: req.user,
+            forPublic: !req.user,
+          });
+          if (tableCfg.exclude_fields) {
+            const fields = tableCfg.exclude_fields
+              .split(",")
+              .map((s) => s.trim());
+            fields.forEach((f) => {
+              result.forEach((r) => {
+                delete r[f];
+              });
+            });
+          }
+        }
+        responses.push(
+          wrapSegment(
+            wrapCard(
+              "Query " + tool_call.function.name.replace("Query", ""),
+              pre(query.sql_id_query)
+            ),
+            "Copilot"
+          )
+        );
+
         await addToContext(run, {
           interactions: [
             {