Adds xp tables

libs/model/src/models/associations.ts

@@ -11,9 +11,8 @@ export const buildAssociations = (db: DB) => {
       onDelete: 'CASCADE',
     })
     .withMany(db.Wallets)
-    .withOne(db.ApiKey, {
-      onDelete: 'CASCADE',
-    });
+    .withMany(db.XpLog, { onDelete: 'CASCADE' })
+    .withOne(db.ApiKey, { onDelete: 'CASCADE' });
 
   db.Address.withMany(db.Thread, {
     asOne: 'Address',

libs/model/src/models/factories.ts

@@ -43,6 +43,7 @@ import User from './user';
 import Vote from './vote';
 import Wallets from './wallets';
 import Webhook from './webhook';
+import XpLog from './xp_log';
 
 export const Factories = {
   Address,
@@ -87,6 +88,7 @@ export const Factories = {
   Vote,
   Webhook,
   Wallets,
+  XpLog,
 };
 
 export type DB = {

libs/model/src/models/user.ts

@@ -72,6 +72,7 @@ export default (sequelize: Sequelize.Sequelize): UserModelStatic =>
       },
       selected_community_id: { type: Sequelize.STRING, allowNull: true },
       profile: { type: Sequelize.JSONB, allowNull: false },
+      xp_points: { type: Sequelize.INTEGER, defaultValue: 0, allowNull: true },
     },
     {
       timestamps: true,

libs/model/src/models/xp_log.ts

@@ -0,0 +1,23 @@
+import { XpLog } from '@hicommonwealth/schemas';
+import Sequelize from 'sequelize';
+import { z } from 'zod';
+import type { ModelInstance } from './types';
+
+export type XpLogInstance = ModelInstance<z.infer<typeof XpLog>>;
+export type XpLogModelStatic = Sequelize.ModelStatic<XpLogInstance>;
+
+export default (sequelize: Sequelize.Sequelize) =>
+  <XpLogModelStatic>sequelize.define<XpLogInstance>(
+    'XpLog',
+    {
+      user_id: { type: Sequelize.INTEGER, primaryKey: true },
+      created_at: { type: Sequelize.DATE, primaryKey: true },
+      event_name: { type: Sequelize.STRING, primaryKey: true },
+      xp_points: { type: Sequelize.INTEGER, allowNull: false },
+    },
+    {
+      timestamps: false,
+      tableName: 'XpLogs',
+      underscored: true,
+    },
+  );

libs/schemas/src/entities/user.schemas.ts

@@ -49,6 +49,7 @@ export const User = z.object({
   is_welcome_onboard_flow_complete: z.boolean().default(false).optional(),
 
   profile: UserProfile,
+  xp_points: PG_INT.default(0).nullish(),
 
   ProfileTags: z.array(ProfileTags).optional(),
 
@@ -105,3 +106,10 @@ export const CommunityMember = z.object({
   group_ids: z.array(PG_INT),
   last_active: z.any().nullish().describe('string or date'),
 });
+
+export const XpLog = z.object({
+  user_id: PG_INT,
+  created_at: z.coerce.date(),
+  event_name: z.string(),
+  xp_points: PG_INT,
+});

packages/commonwealth/server/migrations/20241003134700-add-xp-tables.js

@@ -0,0 +1,46 @@
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.sequelize.transaction(async (transaction) => {
+      await queryInterface.createTable(
+        'XpLogs',
+        {
+          user_id: {
+            primaryKey: true,
+            type: Sequelize.INTEGER,
+            references: {
+              model: 'Users',
+              key: 'id',
+            },
+            onDelete: 'CASCADE',
+          },
+          created_at: { type: Sequelize.DATE, primaryKey: true },
+          event_name: { type: Sequelize.STRING, primaryKey: true },
+          xp_points: { type: Sequelize.INTEGER, allowNull: false },
+        },
+        { transaction },
+      );
+      await queryInterface.addColumn(
+        'Users',
+        'xp_points',
+        {
+          type: Sequelize.INTEGER,
+          defaultValue: 0,
+          allowNull: true,
+        },
+        { transaction },
+      );
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.sequelize.transaction(async (transaction) => {
+      await queryInterface.dropTable('XpLogs', { transaction });
+      await queryInterface.removeColumn('Users', 'xp_points', {
+        transaction,
+      });
+    });
+  },
+};