Merge pull request #7 from SoftwareBrothers/feat/update-logger

feat: add example app, update docs, update config options

Author: dziraf

.eslintrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+  root: true,
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint/eslint-plugin'],
   extends: [
@@ -16,6 +17,8 @@ module.exports = {
   rules: {
     'prettier/prettier': 'error',
     'react/prop-types': 'off',
+    'semi': ['error', 'always'],
+    'quotes': ['error', 'single'],
   },
   ignorePatterns: ['node_modules', 'lib'],
 };

.gitignore

@@ -120,4 +120,5 @@ dist
 # build files
 /build
 /lib
-/types
+/types
+example/.adminjs

README.md

@@ -12,6 +12,7 @@ Or visit [AdminJS](https://github.com/SoftwareBrothers/adminjs) github page.
 
 ## Usage
 
+See an example application in the repository: [Example App](https://github.com/SoftwareBrothers/adminjs-logger/tree/master/example)
 
 ## License
 

example/.example.env

@@ -0,0 +1,6 @@
+SEQUELIZE_TYPE=postgres
+SEQUELIZE_USERNAME=postgres
+SEQUELIZE_PASSWORD=
+SEQUELIZE_HOST=localhost
+SEQUELIZE_PORT=5439
+SEQUELIZE_DATABASE=adminjs_example

example/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '3.7'
+services:
+  adminjs-example:
+    container_name: adminjs-example
+    image: postgres:12-alpine
+    environment:
+      POSTGRES_DB: adminjs_example
+      POSTGRES_HOST_AUTH_METHOD: trust
+    ports:
+      - "5439:5432"
+    volumes:
+      - adminjs_example_db:/var/lib/postgresql/data
+volumes:
+  adminjs_example_db:

example/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "adminjs-logger-example",
+  "version": "1.0.0",
+  "description": "An example for @adminjs/logger",
+  "main": "index.js",
+  "author": "Rafal Dziegielewski",
+  "license": "MIT",
+  "scripts": {
+    "dev": "dotenv -c '.env' ts-node src/server.ts"
+  },
+  "devDependencies": {
+    "@types/argon2": "^0.15.0",
+    "@types/node": "^17.0.22",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.2"
+  },
+  "dependencies": {
+    "@adminjs/express": "^4.1.0",
+    "@adminjs/sequelize": "^2.1.5",
+    "adminjs": "^5.7.4",
+    "argon2": "^0.28.5",
+    "dotenv-cli": "^5.0.0",
+    "express": "^4.17.3",
+    "express-formidable": "^1.2.0",
+    "express-session": "^1.17.2",
+    "pg": "^8.7.3",
+    "sequelize": "^6.17.0",
+    "tslib": "^2.3.1"
+  }
+}

example/src/item/item.model.ts

@@ -0,0 +1,51 @@
+import { DataTypes, Model, Optional } from 'sequelize';
+
+import { sequelize } from '../sequelize';
+
+type Item = {
+  id: number;
+  name: string;
+  description: string;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+type ItemCreationAttributes = Optional<Item, 'id' | 'createdAt' | 'updatedAt'>;
+
+export class ItemModel extends Model<Item, ItemCreationAttributes> {
+  declare id: number;
+  declare name: string;
+  declare description: string;
+  declare createdAt: Date;
+  declare updatedAt: Date;
+}
+
+ItemModel.init(
+  {
+    id: {
+      type: DataTypes.INTEGER,
+      autoIncrement: true,
+      primaryKey: true,
+    },
+    name: {
+      type: new DataTypes.STRING(128),
+      allowNull: false,
+    },
+    description: {
+      type: DataTypes.TEXT,
+      allowNull: true,
+    },
+    createdAt: {
+      type: DataTypes.DATE,
+    },
+    updatedAt: {
+      type: DataTypes.DATE,
+    },
+  },
+  {
+    sequelize,
+    tableName: 'items',
+    modelName: 'Item',
+    timestamps: true,
+  }
+);

example/src/item/item.resource.ts

@@ -0,0 +1,14 @@
+import { FeatureType, ResourceWithOptions } from 'adminjs';
+import { ItemModel } from './item.model';
+import loggerFeature from '../../../src';
+import loggerConfig from '../logger.config';
+
+const ItemResource: ResourceWithOptions = {
+  resource: ItemModel,
+  options: {
+    editProperties: ['name', 'description'],
+  },
+  features: [loggerFeature(loggerConfig) as FeatureType],
+};
+
+export default ItemResource;

example/src/log/log.model.ts

@@ -0,0 +1,97 @@
+import {
+  DataTypes,
+  Model,
+  Optional,
+  NonAttribute,
+  HasOneGetAssociationMixin,
+  Association,
+} from 'sequelize';
+
+import { sequelize } from '../sequelize';
+import { UserModel } from '../user/user.model';
+
+type Log = {
+  id: number;
+  recordId: number;
+  recordTitle: string;
+  difference: Record<string, any>;
+  userId: number;
+  action: string;
+  resource: string;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+type LogCreationAttributes = Optional<Log, 'id' | 'createdAt' | 'updatedAt'>;
+
+export class LogModel extends Model<Log, LogCreationAttributes> {
+  declare id: number;
+  declare recordId: number;
+  declare recordTitle: string;
+  declare difference: Record<string, any>;
+  declare userId: number;
+  declare action: string;
+  declare resource: string;
+  declare createdAt: Date;
+  declare updatedAt: Date;
+
+  declare user?: NonAttribute<UserModel>;
+
+  declare getUser: HasOneGetAssociationMixin<UserModel>;
+
+  declare static associations: {
+    user: Association<UserModel>;
+  };
+}
+
+LogModel.init(
+  {
+    id: {
+      type: DataTypes.INTEGER,
+      autoIncrement: true,
+      primaryKey: true,
+    },
+    action: {
+      type: new DataTypes.STRING(128),
+      allowNull: false,
+    },
+    resource: {
+      type: new DataTypes.STRING(128),
+      allowNull: false,
+    },
+    userId: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    recordId: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    recordTitle: {
+      type: new DataTypes.STRING(128),
+      allowNull: false,
+    },
+    difference: {
+      type: DataTypes.JSONB,
+      allowNull: true,
+    },
+    createdAt: {
+      type: DataTypes.DATE,
+    },
+    updatedAt: {
+      type: DataTypes.DATE,
+    },
+  },
+  {
+    sequelize,
+    tableName: 'logs',
+    modelName: 'Log',
+    timestamps: true,
+  }
+);
+
+LogModel.belongsTo(UserModel, {
+  foreignKey: 'userId',
+  targetKey: 'id',
+  as: 'user',
+});

example/src/log/log.resource.ts

@@ -0,0 +1,10 @@
+import { LogModel } from './log.model';
+import { createLoggerResource } from '../../../src';
+import loggerConfig from '../logger.config';
+
+const LogResource = createLoggerResource({
+  resource: LogModel,
+  featureOptions: loggerConfig,
+});
+
+export default LogResource;