@engine9/schemas 1.9.0

package/message/schema.js

@@ -0,0 +1,130 @@
+export const tables = [
+  {
+    name: 'message',
+    columns: {
+      id: 'id_uuid',
+      message_set_id: 'foreign_uuid',
+      channel: 'string',
+      name: 'string',
+      status: 'string',
+      publish_date: 'datetime',
+      primary_source_code: { type: 'string', length: 180 },
+      primary_source_code_override: { type: 'string', length: 180 },
+      final_primary_source_code: { type: 'string', length: 180 },
+      source_remote_id: 'string',
+      source_submodule: 'string',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [{ columns: 'id', primary: true }, { columns: ['publish_date'] }, { columns: ['message_set_id'] }]
+  },
+  {
+    name: 'message_set',
+    columns: {
+      id: 'id_uuid',
+      campaign_id: 'foreign_uuid',
+      name: 'string',
+      remote_message_set_id: 'string',
+      remote_message_set_name: 'string',
+      message_template_id: 'foreign_uuid',
+      type: 'string',
+      status: 'string',
+      schedule: 'string',
+      source_code_format: 'string',
+      // default_content: 'json', //unused?
+      default_variables: 'json',
+      required_targeting: 'json', // This is set initially, and can't be changed by users, for things such as Emailable people, etc
+      targeting: 'json',
+      sequencing: 'json', // sequence of messages
+      send_strategy: 'string', // Sending strategy, such as Best open rate, best giving rate, etc
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [
+      { columns: 'id', primary: true },
+      { columns: ['campaign_id', 'remote_message_set_id'], unique: true }
+    ]
+  },
+  {
+    name: 'campaign',
+    columns: {
+      id: 'id_uuid',
+      name: 'string',
+      channel: 'string',
+      plugin_id: 'id_uuid', // can't be null, must have a value
+      remote_campaign_id: 'string',
+      remote_campaign_name: 'string',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [
+      { columns: 'id', primary: true },
+      { columns: ['plugin_id', 'remote_campaign_id'], unique: true }
+    ]
+  },
+  {
+    name: 'message_content',
+    columns: {
+      id: 'id_uuid',
+      message_id: 'foreign_uuid',
+      content: 'json',
+      remote_data: 'json',
+      variables: 'json',
+      targeting: 'json',
+      estimated_targets: 'int',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [{ columns: 'id', primary: true }, { columns: ['message_id'], unique: true }]
+  },
+  {
+    name: 'message_override',
+    columns: {
+      id: 'id_uuid',
+      message_id: 'foreign_uuid',
+      overrides: 'json',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [{ columns: 'id', primary: true }, { columns: ['message_id'], unique: true }]
+  },
+  {
+    name: 'message_statistics',
+    columns: {
+      id: 'id_uuid',
+      message_id: 'foreign_uuid',
+      statistics: 'json',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [{ columns: 'id', primary: true }, { columns: ['message_id'], unique: true }]
+  },
+  {
+    name: 'message_queue',
+    columns: {
+      id: 'id_uuid',
+      message_id: 'foreign_uuid',
+      publish_metadata: 'json',
+      error: 'json',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [{ columns: 'id', primary: true }, { columns: ['message_id'], unique: true }]
+  },
+  {
+    name: 'message_template',
+    columns: {
+      id: 'id_uuid',
+      name: 'string',
+      content: 'json',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    },
+    indexes: [{ columns: 'id', primary: true }]
+  }
+  // message_summary / global_message*_summary stay out of core until messaging is
+  // finalized; Frakture deployments may still ship those views separately.
+];
+export default {
+  tables
+};

package/message/ui.console.json5

@@ -0,0 +1,233 @@
+{
+  menu: {
+    'message-menu': {
+      title: 'Messages',
+      icon: 'messages',
+      type: 'collapse',
+      children: {
+        campaigns: {
+          title: 'Campaigns',
+          icon: 'campaign',
+          url: '/campaign'
+        }
+        /* messages:{
+              title: 'Messages',
+              icon:'message',
+              url: '/message',
+            },
+            */
+      }
+    }
+  },
+  routes: {
+    campaign: {
+      layout: 'full_width',
+      components: {
+        header: [
+          'Campaigns',
+          {
+            component: 'Button',
+            properties: {
+              icon: 'plus',
+              content: 'Add Campaign',
+              onClick: {
+                action: 'navigate',
+                url: '/campaign/create'
+              }
+            }
+          }
+        ],
+        main: [
+          {
+            component: 'RecordTable',
+            properties: {
+              table: 'campaign',
+              columns: [
+                {
+                  title: 'Id',
+                  dataIndex: 'id',
+                  sorter: true,
+                  width: '20%'
+                },
+                {
+                  title: 'Name',
+                  dataIndex: 'name',
+                  sorter: true,
+                  template: '{{name}}',
+                  width: '40%'
+                }
+              ],
+              onRecord: {
+                onClick: {
+                  action: 'navigate',
+                  url: '/campaign/{{record.id}}'
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    'campaign/create': {
+      layout: 'full_width',
+      components: {
+        main: [
+          {
+            path: 'edit',
+            component: 'RecordForm',
+            properties: {
+              table: 'campaign',
+              form: {
+                title: 'Create Campaign',
+                type: 'object',
+                required: [],
+                properties: {
+                  name: { type: 'string', title: 'Name', default: '' }
+                }
+              },
+              uiSchema: {},
+              onSave: {
+                action: 'navigate',
+                url: '/campaign/{{record.id}}'
+              }
+            }
+          }
+        ]
+      }
+    },
+    'campaign/:id/*': {
+      layout: 'sidebar',
+      components: {
+        sidebar: {
+          items: [
+            { component: 'Title', properties: { content: 'Emails' } },
+            {
+              component: 'Button',
+              properties: {
+                icon: 'plus',
+                content: 'Add Message Set',
+                onClick: {
+                  action: 'object.create',
+                  data: {
+                    type: 'message_set',
+                    attributes: {
+                      label: 'Messages - {{date "MMMM, yyyy"}}',
+                      campaign_id: '{{parameters.id}}'
+                    }
+                  },
+                  redirect: '/campaign/{{parameters.id}}/message_set/{{record.id}}'
+                }
+              }
+            },
+            {
+              component: 'RecordList',
+              properties: {
+                table: 'message_set',
+                conditions: [{ eql: 'campaign_id={{id}}' }],
+                onRecord: {
+                  onClick: {
+                    action: 'navigate',
+                    url: '/campaign/{{parameters.id}}/message_set/{{record.id}}/'
+                  }
+                }
+              }
+            }
+          ]
+        },
+        main: [
+          { component: 'Title', properties: { content: 'Campaign Summary' } },
+          {
+            // 'path':'overview', //no path is the default
+            component: 'RecordDisplay',
+            properties: {
+              table: 'campaign',
+              id: '{{parameters.id}}',
+              template: '{{name}}'
+            }
+          }
+        ]
+      }
+    },
+    message: {
+      layout: 'full_width',
+      components: {
+        main: [
+          {
+            component: 'RecordTable',
+            properties: {
+              table: 'message',
+              columns: [
+                {
+                  title: 'Id',
+                  dataIndex: 'id',
+                  sorter: true,
+                  width: '20%'
+                },
+                {
+                  title: 'Publish Date',
+                  dataIndex: 'publish_date',
+                  sorter: true,
+                  width: '40%'
+                },
+                {
+                  title: 'Name',
+                  dataIndex: 'name',
+                  sorter: true,
+                  template: '{{name}}',
+                  width: '40%'
+                }
+              ],
+              onRecord: {
+                onClick: {
+                  action: 'navigate',
+                  url: '/message/{{record.id}}'
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    'message/:id/*': {
+      layout: 'sidebar',
+      components: {
+        sidebar: [
+          {
+            component: 'RecordDisplay',
+            properties: {
+              table: 'message',
+              id: '{{parameters.id}}',
+              components: ['{{name}}']
+            }
+          }
+        ],
+        main: [
+          {
+            // 'path':'overview', //no path is the default
+            component: 'RecordDisplay',
+            properties: {
+              table: 'message',
+              id: '{{parameters.id}}',
+              components: ['{{name}}']
+            }
+          },
+          {
+            path: 'source_codes',
+            label: 'Source Codes',
+            component: 'RecordDisplay',
+            properties: {
+              table: 'message',
+              id: '{{parameters.id}}',
+              includes: {
+                source_codes: {
+                  table: 'source_code'
+                }
+              },
+              components: ['{{source_code}}']
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@engine9/schemas",
+  "version": "1.9.0",
+  "type": "module",
+  "description": "Engine9 standard schemas: shared tables, transforms, searches, and segments",
+  "main": "index.js",
+  "scripts": {
+    "test": "node --test person/upsert.test.js person_address/normalize.test.js person_email/upsert.test.js person_hash/hash.test.js person_phone/upsert.test.js stacks/stacks.test.js transaction/core/attribute.test.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@engine9/input-tools": "^2.4.1",
+    "@zerodep/address-normalize": "^2.4.10",
+    "handlebars": "^4.7.8",
+    "i18n-iso-countries": "^7.14.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.34.0",
+    "eslint-plugin-jsonc": "^2.15.1",
+    "eslint-plugin-n": "^17.21.3"
+  }
+}

package/person/index.js

@@ -0,0 +1,100 @@
+import schema from './schema.js';
+import upsertPerson from './transforms/inbound/upsert_tables.js';
+import normalizeFieldNames from './transforms/inbound/normalize_field_names.js';
+import simpleMap from './transforms/simpleMap.js';
+import appendName from './transforms/outbound/appendName.js';
+import metrics from './metrics.js';
+const metadata = {
+  name: '@engine9/schemas/person',
+  schemas: ['schema.js'],
+  // Inbound people pipeline slots -> transform export keys (woven by core when installed)
+  inbound: {
+    normalize: ['normalizeFieldNames'],
+    upsert: ['upsertPerson']
+  }
+};
+const transforms = {
+  normalizeFieldNames,
+  upsertPerson,
+  simpleMap,
+  appendName
+};
+export const search = {
+  person: {
+    title: 'Primary Info',
+    form: {
+      title: 'Primary Info',
+      type: 'object',
+      properties: {
+        givenName: {
+          title: 'First Name',
+          type: 'string'
+        },
+        familyName: {
+          title: 'Last Name',
+          type: 'string'
+        },
+        ids: {
+          title: 'Person Ids (comma delimited)',
+          type: 'string'
+        },
+        idGreaterThanEqual: {
+          title: 'ID Greater than or equal to',
+          type: 'number'
+        },
+        idLessThan: {
+          title: 'ID less than',
+          type: 'number'
+        }
+      },
+      required: []
+    },
+    optionsToEQL: (options) => {
+      const text = [];
+      const { ids, idGreaterThanEqual, idLessThan, givenName = '', familyName = '' } = options;
+      const conditions = [];
+      if (ids) {
+        let arr = ids || '';
+        if (typeof ids === 'string') arr = ids.split(',');
+        if (arr.length === 0) arr = [0];
+        conditions.push({ eql: `id in (${arr.map((p) => parseInt(p, 10)).join(',')})` });
+        text.push(`Person ID in ${arr.map((p) => parseInt(p, 10)).join(',')}`);
+      }
+      if (idGreaterThanEqual) {
+        conditions.push({ eql: `id>=${idGreaterThanEqual}` });
+        text.push(`Person ID greater or equal to ${idGreaterThanEqual}`);
+      }
+      if (idLessThan) {
+        conditions.push({ eql: `id<${idLessThan}` });
+        text.push(`Person ID less than ${idLessThan}`);
+      }
+      if (givenName.length > 0) {
+        text.push(`First name like '${givenName}'`);
+        conditions.push({ eql: `given_name like '${givenName}'` });
+      }
+      if (familyName.length > 0) {
+        text.push(`Last name like '${givenName}'`);
+        conditions.push({ eql: `family_name like '${familyName}'` });
+      }
+      return {
+        text,
+        eql: {
+          table: 'person',
+          columns: ['id'],
+          conditions
+        }
+      };
+    }
+  }
+};
+export { metadata };
+export { schema };
+export { transforms };
+export { metrics };
+export default {
+  metadata,
+  schema,
+  transforms,
+  metrics,
+  search
+};

package/person/metrics.js

@@ -0,0 +1,17 @@
+export const people = () => {
+  return {
+    label: 'People',
+    description: '',
+    eql: {
+      table: 'person',
+      columns: [
+        { eql: 'min(created_at)', name: 'first_date' },
+        { eql: 'max(created_at)', name: 'last_date' },
+        { eql: 'count', name: 'records' }
+      ]
+    }
+  };
+};
+export default {
+  people
+};

package/person/schema.js

@@ -0,0 +1,47 @@
+export const tables = [
+  {
+    name: 'person',
+    columns: {
+      id: 'id',
+      given_name: 'string',
+      family_name: 'string',
+      created_at: 'created_at',
+      modified_at: 'modified_at'
+    }
+  },
+  {
+    name: 'person_identifier',
+    columns: {
+      id: 'id',
+      person_id: 'person_id',
+      source_input_id: 'uuid',
+      id_type: {
+        type: 'enum',
+        nullable: false,
+        default_value: '',
+        values: ['', 'remote_person_id', 'email_hash_v1', 'phone_hash_v1', 'delegate']
+      },
+      id_value: 'id_string'
+    },
+    indexes: [
+      { columns: ['person_id'] },
+      { columns: ['id_value'] },
+      // useful for finding anyone related to an input
+      // same input can't have the same id value twice
+      { columns: ['source_input_id', 'id_value', 'person_id'], unique: true }
+    ]
+  }
+  /*
+    //sometimes useful, debating whether useful enough to be global
+    create view person_identifier_summary
+as select p.*,
+input.remote_input_id,
+input.remote_input_name,input_type,
+plugin_id,plugin.path,plugin.name,plugin.remote_plugin_id
+from person_identifier p
+join input on (p.source_input_id=input.id)
+join plugin on (input.plugin_id=plugin.id); */
+];
+export default {
+  tables
+};

package/person/transforms/inbound/normalize_field_names.js

@@ -0,0 +1,16 @@
+export async function transform({ batch }) {
+  batch.forEach((row) => {
+    const normalized = {};
+    Object.entries(row).forEach(([key, value]) => {
+      // Keep '.' so person_custom table.column keys survive normalize.
+      const normalizedKey = String(key).toLowerCase().replace(/[^a-z0-9_.]/g, '_');
+      normalized[normalizedKey] = value;
+    });
+    Object.keys(row).forEach((key) => delete row[key]);
+    Object.assign(row, normalized);
+  });
+}
+
+export default {
+  transform
+};

package/person/transforms/inbound/upsert_tables.js

@@ -0,0 +1,21 @@
+export const bindings = {
+  tablesToUpsert: { path: 'sql.tables.upsert' }
+};
+const NAME_COLUMNS = ['given_name', 'family_name'];
+
+export async function transform({ batch, tablesToUpsert }) {
+  if (batch.length === 0) return;
+  batch.forEach((o) => {
+    const present = NAME_COLUMNS.filter((column) => Object.hasOwn(o, column));
+    if (present.length === 0) return;
+    if (!o.person_id) throw new Error('Cannot update name, no person_id');
+    tablesToUpsert.person = tablesToUpsert.person || [];
+    const row = { id: o.person_id };
+    for (const column of present) row[column] = o[column];
+    tablesToUpsert.person.push(row);
+  });
+}
+export default {
+  bindings,
+  transform
+};

package/person/transforms/outbound/appendName.js

@@ -0,0 +1,32 @@
+export const description = 'Append a name';
+export const bindings = {
+  names: {
+    path: 'sql.query',
+    options: {
+      table: 'person',
+      columns: ['id', 'given_name', 'family_name'],
+      lookup: [
+        {
+          personIdField: 'person_id',
+          tableLookupField: 'id'
+        }
+      ]
+    }
+  }
+};
+export const transform = ({ batch, names }) => {
+  const nameMap = names.reduce((a, b) => {
+    a[b.id] = a[b.id] || b;
+    return a;
+  }, {});
+  batch.forEach((data) => {
+    const o = nameMap[data.person_id] || {};
+    data.given_name = o.given_name || null;
+    data.family_name = o.family_name || null;
+  });
+};
+export default {
+  description,
+  bindings,
+  transform
+};

package/person/transforms/simpleMap.js

@@ -0,0 +1,34 @@
+import handlebars from 'handlebars';
+
+const moduleExports = {
+  async transform({ batch, options }) {
+    if (!options._compiledMap) {
+      if (!options?.map) {
+        throw new Error('Error with transform, no options.map provided');
+      }
+      options._compiledMap = {};
+      Object.entries(options.map).forEach(([k, source]) => {
+        if (k === '*') {
+          options._compiledMap['*'] = '*'; // just applies all the other fields
+        } else {
+          options._compiledMap[k] = handlebars.compile(source);
+        }
+      });
+    }
+    const newBatch = batch.map((o) => {
+      const out = {};
+      Object.entries(options._compiledMap).forEach(([k, func]) => {
+        if (k === '*') {
+          Object.assign(out, o);
+        } else if (out[k] === undefined) {
+          // first one wins, specify it first if you want ahead of the '*'
+          out[k] = func(o);
+        }
+      });
+      return out;
+    });
+    return { batch: newBatch };
+  }
+};
+
+export default moduleExports;