@saltcorn/reservable 0.1.1 → 0.1.2

package/README.md

@@ -2,36 +2,34 @@
 
 To use this Plugin, you should create a table for reservations. This table should have the following fields:
 
-* A Date field for the time of the start of the reservation
-* An integer field for the duration After reservation in minutes
-* Any other fields for the reservation, for instance the email of the person reserving the slot
+- A Date field for the time of the start of the reservation
+- An integer field for the duration of the reservation in minutes
+- Any other fields for the reservation, for instance the email of the person reserving the slot
 
 This table also needs to have two views
 
-* A view to create, typically an Edit view obtain the information required for the booking. 
+- A view to create, typically an Edit view obtain the information required for the booking.
   This Edit view does not need to have fields for the date or the duration.
-* A confirmation view, typically a Show view, which is displayed to the user on a successful reservation. 
+- A confirmation view, typically a Show view, which is displayed to the user on a successful reservation.
   This may or may not contain Date and duration
 
 There may be another table indicating reservable resources. This is optional. If you are building a reservation system
-for a single resource, you can leave this out. On the other hand, if you are building a system where multiple resources 
-need to be tracked for whether they are available, use this to denote the resources that can be taken/available. 
+for a single resource, you can leave this out. On the other hand, if you are building a system where multiple resources
+need to be tracked for whether they are available, use this to denote the resources that can be taken/available.
 To do this, create a foreign key field on your reservations Table to the reservable resource table.
 
 You should then create a Reserve view on the reservations table. In the configuration, you specify the fields
 As explained above. You will also need to configure:
 
-* What services are available. Each service has a name and a duration.
-* What the availability is, your opening hours. You specify these in blocks of time and the day of the week.
+- What services are available. Each service has a name and a duration.
+- What the availability is, your opening hours. You specify these in blocks of time and the day of the week.
 
 ### Example
 
-Goldilocks and Rapunzel together run the successful GoldiRap Hair Salon. In fact they are so successful that 
-they must now implement an online booking system. Their opening hours are Monday to Friday 9-12 and 13-17 
-(they close for lunch) and Saturday 10-13. They offer two services: A haircut taking 30 minutes 
+Goldilocks and Rapunzel together run the successful GoldiRap Hair Salon. In fact they are so successful that
+they must now implement an online booking system. Their opening hours are Monday to Friday 9-12 and 13-17
+(they close for lunch) and Saturday 10-13. They offer two services: A haircut taking 30 minutes
 and a full restyle taking 45 minutes. You can book either Goldilocks or Rapunzel for each of the services.
 
-Here, the reservable resource is the hairdresser with two rows: Goldilocks and Rapunzel. They have two services, 
+Here, the reservable resource is the hairdresser with two rows: Goldilocks and Rapunzel. They have two services,
 haircut and full restyle. The availability can be specified as: Mon-Fri 9-12, Mon-Fri 13-17 and Saturday 10-13.
-
-

package/available-feed.js

@@ -0,0 +1,186 @@
+const {
+  input,
+  div,
+  text,
+  script,
+  domReady,
+  style,
+  button,
+  h3,
+  ul,
+  li,
+  form,
+  a,
+  b,
+} = require("@saltcorn/markup/tags");
+
+const View = require("@saltcorn/data/models/view");
+const Workflow = require("@saltcorn/data/models/workflow");
+const Table = require("@saltcorn/data/models/table");
+const Form = require("@saltcorn/data/models/form");
+const Field = require("@saltcorn/data/models/field");
+const {
+  InvalidConfiguration,
+  isNode,
+  isWeb,
+  mergeConnectedObjects,
+  hashState,
+} = require("@saltcorn/data/utils");
+const {
+  link_view,
+  stateToQueryString,
+  stateFieldsToWhere,
+  stateFieldsToQuery,
+  readState,
+} = require("@saltcorn/data/plugin-helper");
+const get_state_fields = async (table_id, viewname, { show_view }) => {
+  const table = Table.findOne(table_id);
+  const table_fields = table.fields;
+  return table_fields
+    .filter((f) => !f.primary_key)
+    .map((f) => {
+      const sf = new Field(f);
+      sf.required = false;
+      return sf;
+    });
+};
+
+const configuration_workflow = (req) =>
+  new Workflow({
+    steps: [
+      {
+        name: req.__("Views"),
+        form: async (context) => {
+          const table = Table.findOne(context.table_id);
+          const fields = table.fields;
+
+          const reservable_entity_fields = fields.filter((f) => f.is_fkey);
+          const show_view_opts = {};
+          for (const rfield of reservable_entity_fields) {
+            const retable = Table.findOne(rfield.reftable_name);
+            const show_views = await View.find_table_views_where(
+              retable.id,
+              ({ state_fields, viewtemplate, viewrow }) =>
+                viewtemplate.runMany &&
+                viewrow.name !== context.viewname &&
+                state_fields.some((sf) => sf.name === "id")
+            );
+            show_view_opts[rfield.name] = show_views.map((v) => v.name);
+          }
+          return new Form({
+            fields: [
+              {
+                name: "reservable_entity_key",
+                label: "Key to reservable entity",
+                type: "String",
+                required: true,
+                attributes: {
+                  options: reservable_entity_fields.map((f) => f.name),
+                },
+              },
+              {
+                name: "start_field",
+                label: "Start date field",
+                type: "String",
+                required: true,
+                attributes: {
+                  options: fields
+                    .filter((f) => f.type.name === "Date")
+                    .map((f) => f.name),
+                },
+              },
+              {
+                name: "end_field",
+                label: "End date field",
+                type: "String",
+                attributes: {
+                  options: fields
+                    .filter((f) => f.type.name === "Date")
+                    .map((f) => f.name),
+                },
+              },
+              {
+                name: "duration_field",
+                label: "Duration field",
+                sublabel: "Integer field holding booked duration in minutes",
+                type: "String",
+                attributes: {
+                  options: fields
+                    .filter((f) => f.type.name === "Integer")
+                    .map((f) => f.name),
+                },
+              },
+              {
+                name: "show_view",
+                label: req.__("Single item view"),
+                type: "String",
+                sublabel:
+                  req.__("The underlying individual view of each table row") +
+                  ". " +
+                  a(
+                    {
+                      "data-dyn-href": `\`/viewedit/config/\${show_view}\``,
+                      target: "_blank",
+                    },
+                    req.__("Configure")
+                  ),
+                required: true,
+                attributes: {
+                  calcOptions: ["reservable_entity_key", show_view_opts],
+                },
+              },
+            ],
+          });
+        },
+      },
+    ],
+  });
+
+const run = async (
+  table_id,
+  viewname,
+  { reservable_entity_key, start_field, end_field, duration_field, show_view },
+  state,
+  extraArgs
+) => {
+  const restable = Table.findOne({ id: table_id });
+  const resfields = restable.getFields();
+
+  const refield = restable.getField(reservable_entity_key);
+  const retable = Table.findOne(refield.reftable_name);
+
+  const state_res = { ...state };
+
+  readState(state_res, restable.fields);
+
+  //get reservations
+  const reswhere = await stateFieldsToWhere({
+    fields: resfields,
+    state: state_res,
+    table: restable,
+  });
+
+  const ress = await restable.getRows(reswhere);
+  const resEnts = new Set(ress.map((r) => r[reservable_entity_key]));
+
+  const sview = await View.findOne({ name: show_view });
+  if (!sview)
+    throw new InvalidConfiguration(
+      `View ${viewname} incorrectly configured: cannot find view ${show_view}`
+    );
+  const srespAll = await sview.runMany(state, extraArgs);
+  const srespsAvailable = [];
+  for (const sresp of srespAll) {
+    if (!resEnts.has(sresp.row[retable.pk_name])) srespsAvailable.push(sresp);
+  }
+  const showRow = (r) => r.html;
+  return div(srespsAvailable.map(showRow));
+};
+
+module.exports = {
+  name: "Available Resources Feed",
+  display_state_form: false,
+  get_state_fields,
+  configuration_workflow,
+  run,
+};

package/index.js

@@ -167,7 +167,8 @@ const configuration_workflow = () =>
   });
 
 const get_state_fields = async (table_id, viewname, { show_view }) => {
-  const table_fields = await Field.find({ table_id });
+  const table = Table.findOne(table_id);
+  const table_fields = table.fields;
   return table_fields.map((f) => {
     const sf = new Field(f);
     sf.required = false;
@@ -525,6 +526,7 @@ module.exports = {
       run,
       runPost,
     },
+    require("./available-feed"),
   ],
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/reservable",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Reservable resources",
   "main": "index.js",
   "dependencies": {
@@ -18,5 +18,21 @@
   },
   "scripts": {
     "test": "jest"
+  },
+  "eslintConfig": {
+    "extends": "eslint:recommended",
+    "parserOptions": {
+      "ecmaVersion": 2020
+    },
+    "env": {
+      "node": true,
+      "es6": true
+    },
+    "rules": {
+      "no-unused-vars": "off",
+      "no-case-declarations": "off",
+      "no-empty": "warn",
+      "no-fallthrough": "warn"
+    }
   }
 }