@illustrisinteractive/sentinel 0.0.1

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/README.md

@@ -0,0 +1,98 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+## Description
+
+[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+
+## Project setup
+
+```bash
+$ npm install
+```
+
+## Compile and run the project
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+## Run tests
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Deployment
+
+When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
+
+If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
+
+```bash
+$ npm install -g @nestjs/mau
+$ mau deploy
+```
+
+With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+
+## Resources
+
+Check out a few resources that may come in handy when working with NestJS:
+
+- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
+- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
+- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
+- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
+- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
+- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
+- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
+- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
+
+## License
+
+Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).

package/eslint.config.mjs

@@ -0,0 +1,35 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      "prettier/prettier": ["error", { endOfLine: "auto" }],
+    },
+  },
+);

package/libs/sentinel/src/helpers/hasDuplicates.ts

@@ -0,0 +1,13 @@
+export const hasDuplicates = (arr, prop) => {
+  const seen = new Set();
+  return arr.some((obj) => {
+    const value = obj[prop];
+    // If the value is already in the Set, it's a duplicate
+    if (seen.has(value)) {
+      return true;
+    }
+    // Otherwise, add the value to the Set
+    seen.add(value);
+    return false;
+  });
+};

package/libs/sentinel/src/index.ts

@@ -0,0 +1,2 @@
+export * from './sentinel.module';
+export * from './sentinel.service';

package/libs/sentinel/src/models/PermissionKey.ts

@@ -0,0 +1,18 @@
+import { Column, HasMany, Model, Table } from 'sequelize-typescript';
+import { RoleHasPermissions } from './RoleHasPermissions';
+import { type NonAttribute } from 'sequelize';
+
+@Table
+export class PermissionKey extends Model {
+  @Column
+  resource: string;
+
+  @Column
+  action: string;
+
+  @Column
+  description: string;
+
+  @HasMany(() => RoleHasPermissions)
+  declare roles?: NonAttribute<RoleHasPermissions[]>;
+}

package/libs/sentinel/src/models/Role.ts

@@ -0,0 +1,12 @@
+import { Column, HasMany, Model, Table } from 'sequelize-typescript';
+import { RoleHasPermissions } from './RoleHasPermissions';
+import { type NonAttribute } from 'sequelize';
+
+@Table
+export class Role extends Model {
+  @Column
+  name: string;
+
+  @HasMany(() => RoleHasPermissions)
+  declare permissions?: NonAttribute<RoleHasPermissions[]>;
+}

package/libs/sentinel/src/models/RoleHasPermissions.ts

@@ -0,0 +1,25 @@
+import {
+  BelongsTo,
+  Column,
+  ForeignKey,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { PermissionKey } from './PermissionKey';
+import { type NonAttribute } from 'sequelize';
+import { Role } from './Role';
+
+@Table
+export class RoleHasPermissions extends Model {
+  @ForeignKey(() => PermissionKey)
+  declare permissionKeyId: number;
+
+  @BelongsTo(() => PermissionKey)
+  declare permissionKey: NonAttribute<PermissionKey>;
+
+  @ForeignKey(() => Role)
+  declare roleId: number;
+
+  @BelongsTo(() => PermissionKey)
+  declare role: NonAttribute<Role>;
+}

package/libs/sentinel/src/models/SecuredResource.ts

@@ -0,0 +1,21 @@
+export interface SecuredResource {
+  /**
+   * The name of the Secured Resource.
+   */
+  name: string;
+  /**
+   * A list of Actions that a User can do on the Secured Resource.
+   */
+  actions: SecuredResourceAction[];
+}
+
+export interface SecuredResourceAction {
+  /**
+   * The permission key to identify this Action on the Secured Resource.
+   */
+  key: string;
+  /**
+   * An optional description to define this Action.
+   */
+  description?: string;
+}

package/libs/sentinel/src/models/SentinelModuleOptions.ts

@@ -0,0 +1,9 @@
+import { Model, Options } from 'sequelize';
+import { SecuredResource } from './SecuredResource';
+
+export interface SentinelModuleOptions {
+  /**
+   * A list of Secured Resources to apply Sentinel (Role-Based Access Control) to.
+   */
+  resources: SecuredResource[];
+}

package/libs/sentinel/src/sentinel.module-definition.ts

@@ -0,0 +1,5 @@
+import { ConfigurableModuleBuilder } from '@nestjs/common';
+import { SentinelModuleOptions } from './models/SentinelModuleOptions';
+
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } =
+  new ConfigurableModuleBuilder<SentinelModuleOptions>().build();

package/libs/sentinel/src/sentinel.module.ts

@@ -0,0 +1,34 @@
+import { Module } from '@nestjs/common';
+import { SentinelService } from './sentinel.service';
+import {
+  ConfigurableModuleClass,
+  MODULE_OPTIONS_TOKEN,
+} from './sentinel.module-definition';
+import { SequelizeModule } from '@nestjs/sequelize';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { PermissionKey } from './models/PermissionKey';
+import { Role } from './models/Role';
+import { RoleHasPermissions } from './models/RoleHasPermissions';
+
+@Module({
+  imports: [
+    SequelizeModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (configService: ConfigService) => ({
+        dialect: 'postgres',
+        host: configService.getOrThrow('SENTINEL_DB_HOST'),
+        port: configService.get('SENTINEL_DB_PORT') || 5432,
+        username: configService.getOrThrow('SENTINEL_DB_USER'),
+        password: configService.getOrThrow('SENTINEL_DB_PASS'),
+        database: configService.getOrThrow('SENTINEL_DB'),
+        models: [PermissionKey, Role, RoleHasPermissions],
+        autoLoadModels: true,
+      }),
+    }),
+    SequelizeModule.forFeature([PermissionKey, Role, RoleHasPermissions]),
+  ],
+  providers: [SentinelService],
+  exports: [SentinelService],
+})
+export class SentinelModule extends ConfigurableModuleClass {}

package/libs/sentinel/src/sentinel.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { SentinelService } from './sentinel.service';
+
+describe('SentinelService', () => {
+  let service: SentinelService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [SentinelService],
+    }).compile();
+
+    service = module.get<SentinelService>(SentinelService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

package/libs/sentinel/src/sentinel.service.ts

@@ -0,0 +1,59 @@
+import {
+  Inject,
+  Injectable,
+  OnModuleInit,
+  Logger,
+  LoggerService,
+} from '@nestjs/common';
+import { MODULE_OPTIONS_TOKEN } from './sentinel.module-definition';
+import { type SentinelModuleOptions } from './models/SentinelModuleOptions';
+import { Sequelize } from 'sequelize';
+import { InjectModel } from '@nestjs/sequelize';
+import { PermissionKey } from './models/PermissionKey';
+import { hasDuplicates } from './helpers/hasDuplicates';
+@Injectable()
+export class SentinelService implements OnModuleInit {
+  private logger: LoggerService = new Logger(SentinelService.name);
+  constructor(
+    @Inject(MODULE_OPTIONS_TOKEN) private options: SentinelModuleOptions,
+    @InjectModel(PermissionKey)
+    private permissionKeyRepository: typeof PermissionKey,
+  ) {}
+  async onModuleInit() {
+    //initial load flags
+    let noMatchingPermissionKey = false;
+    let duplicateResourceName = hasDuplicates(this.options.resources, 'name');
+
+    if (duplicateResourceName) {
+      this.logger.error(
+        `Duplicate name property value detected from list of Secured Resources. Please ensure that all Secured Resources have unique names.`,
+      );
+      throw new Error(
+        `Duplicate name property value detected from list of Secured Resources. Please ensure that all Secured Resources have unique names.`,
+      );
+    }
+
+    //get all permissions
+    const permissions: PermissionKey[] =
+      await this.permissionKeyRepository.findAll();
+    this.logger.log(`${permissions.length} Permission Keys were found.`);
+
+    /*start verifying if all Secured Resources have their Actions persisted as Permission Keys
+    in the database */
+    this.options.resources.forEach((resource) => {
+      resource.actions.forEach((action) => {
+        const matchingKey = permissions.find(
+          (permission) =>
+            permission.action == action.key &&
+            permission.resource == resource.name,
+        );
+        if (!matchingKey) {
+          this.logger.warn(
+            `Action "${action.key}" from Secured Resource "${resource.name}" does not have a matching Permission Key in the database. If this Secured Resource was newly registered, did you run the Permission Key Migration?`,
+          );
+          noMatchingPermissionKey = true;
+        }
+      });
+    });
+  }
+}

package/libs/sentinel/src/sentinel.service.ts.old

@@ -0,0 +1,88 @@
+//Initial tests
+try {
+  //Test database connection
+  await this.sequelize.authenticate();
+  this.logger.log('Sentinel Module connected to Database');
+  init(this.sequelize, this.table);
+
+  //Check if permissions table exists
+  let [results, metadata] = await this.sequelize.query(
+    `SELECT EXISTS (SELECT FROM information_schema.tables WHERE table_schema = 'public' AND table_name = '${this.table}');`,
+  );
+  if (!(results[0] as any).exists) {
+    this.logger.error(
+      `Permission table "${this.table}" does not exist in the database. Please try to run the permission migration again, or set "synchronize" to true (only within development environments).`,
+    );
+    throw new Error(
+      `Permission table "${this.table}" does not exist in the database. Please try to run the permission migration again, or set "synchronize" to true (only within development environments).`,
+    );
+  }
+
+  Role(this.sequelize, this.roleTable);
+
+  //Check if roles table exists
+  let [roleResults] = await this.sequelize.query(
+    `SELECT EXISTS (SELECT FROM information_schema.tables WHERE table_schema = 'public' AND table_name = '${this.roleTable}');`,
+  );
+  if (!(roleResults[0] as any).exists) {
+    this.logger.error(
+      `Role table "${this.roleTable}" does not exist in the database. Please try to run the role migration again, or set "synchronize" to true (only within development environments).`,
+    );
+    throw new Error(
+      `Role table "${this.roleTable}" does not exist in the database. Please try to run the role migration again, or set "synchronize" to true (only within development environments).`,
+    );
+  }
+
+  RoleHasPermissions(this.sequelize, this.roleHasPermissionsTable);
+
+  //Check if permissions table conforms to model
+  let [modelResults] = await this.sequelize.query(
+    `SELECT COLUMN_NAME, DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '${this.table}'`,
+  );
+
+  const expectedColumns = [
+    { column_name: 'id', data_type: 'integer' },
+    { column_name: 'resource', data_type: 'character varying' },
+    { column_name: 'action', data_type: 'character varying' },
+    { column_name: 'description', data_type: 'character varying' },
+  ];
+
+  if (JSON.stringify(expectedColumns) != JSON.stringify(modelResults)) {
+    this.logger.error(
+      `Permission table "${this.table}" does not conform to the schema expected by Sentinel. Drop the table then try to run the permission migration again, or set "synchronize" to true (only within development environments).`,
+    );
+    throw new Error(
+      `Permission table "${this.table}" does not conform to the schema expected by Sentinel. Drop the table then try to run the permission migration again, or set "synchronize" to true (only within development environments).`,
+    );
+  }
+  this.logger.log('Permission table for Sentinel Module found and verified');
+
+  //check all passed Secured Resources and verify that all of their actions exist as keys in the database
+
+  const promises: Promise<void>[] = [];
+  this.options.resources.forEach((_resource) => {
+    const fn = async (resource: SecuredResource) => {
+      const foundActions = await PermissionKey.findAll({
+        where: {
+          resource: resource.name,
+        },
+      });
+
+      resource.actions.forEach((action) => {
+        if (!foundActions.find((key) => key.get('action') == action.key)) {
+          this.logger.warn(
+            `Action "${action.key}" for Secured Resource "${resource.name}" does not exist in the Permission Table. Did you run the permission migration correctly?`,
+          );
+        }
+      });
+    };
+
+    promises.push(fn(_resource));
+  });
+
+  await Promise.all(promises);
+
+  this.logger.log('Sentinel is ready to enforce access controls');
+} catch (error) {
+  throw new Error(error);
+}

package/libs/sentinel/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "../../dist/libs/sentinel"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}

package/nest-cli.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "webpack": true
+  },
+  "projects": {}
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@illustrisinteractive/sentinel",
+  "version": "0.0.1",
+  "description": "",
+  "author": "John Dela Vega <john@illustrisinteractive.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"libs/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@casl/ability": "^6.8.0",
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/config": "^4.0.3",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/sequelize": "^11.0.1",
+    "mysql2": "^3.17.0",
+    "pg": "^8.18.0",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1",
+    "sequelize": "^6.37.7",
+    "sequelize-typescript": "^2.1.6"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.18.0",
+    "@nestjs/cli": "^11.0.0",
+    "@nestjs/schematics": "^11.0.0",
+    "@nestjs/testing": "^11.0.1",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.7",
+    "@types/sequelize": "^4.28.20",
+    "@types/supertest": "^6.0.2",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.2",
+    "globals": "^16.0.0",
+    "jest": "^30.0.0",
+    "prettier": "^3.4.2",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.20.0"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": ".",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "./coverage",
+    "testEnvironment": "node",
+    "roots": [
+      "<rootDir>/src/",
+      "<rootDir>/libs/"
+    ],
+    "moduleNameMapper": {
+      "^@app/sentinel(|/.*)$": "<rootDir>/libs/sentinel/src/$1"
+    }
+  }
+}

package/src/app.controller.spec.ts

@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(appController.getHello()).toBe('Hello World!');
+    });
+  });
+});

package/src/app.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  getHello(): string {
+    return this.appService.getHello();
+  }
+}

package/src/app.module.ts

@@ -0,0 +1,17 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { SentinelModule } from '@app/sentinel';
+import { TransactionResource } from './models/sentinel/TransactionResource';
+import { TestResource } from './models/sentinel/TestResource';
+
+@Module({
+  imports: [
+    SentinelModule.register({
+      resources: [TransactionResource],
+    }),
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}

package/src/app.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}

package/src/main.ts

@@ -0,0 +1,8 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(process.env.PORT ?? 3000);
+}
+bootstrap();

package/src/models/sentinel/TestResource.ts

@@ -0,0 +1,22 @@
+import {
+  SecuredResource,
+  SecuredResourceAction,
+} from '@app/sentinel/models/SecuredResource';
+
+export const TestResource: SecuredResource = {
+  name: 'Transaction',
+  actions: [
+    {
+      key: 'create',
+      description: 'Allows the User to create a new Transaction',
+    },
+    {
+      key: 'read',
+      description: 'Allows the user to read existing Transactions',
+    },
+    {
+      key: 'delete',
+      description: 'Allows the user to delete existing Transactions',
+    },
+  ],
+};

package/src/models/sentinel/TransactionResource.ts

@@ -0,0 +1,22 @@
+import {
+  SecuredResource,
+  SecuredResourceAction,
+} from '@app/sentinel/models/SecuredResource';
+
+export const TransactionResource: SecuredResource = {
+  name: 'Transaction',
+  actions: [
+    {
+      key: 'create',
+      description: 'Allows the User to create a new Transaction',
+    },
+    {
+      key: 'read',
+      description: 'Allows the user to read existing Transactions',
+    },
+    {
+      key: 'delete',
+      description: 'Allows the user to delete existing Transactions',
+    },
+  ],
+};

package/test/app.e2e-spec.ts

@@ -0,0 +1,25 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import request from 'supertest';
+import { App } from 'supertest/types';
+import { AppModule } from './../src/app.module';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication<App>;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  });
+});

package/test/jest-e2e.json

@@ -0,0 +1,16 @@
+{
+  "moduleFileExtensions": [
+    "js",
+    "json",
+    "ts"
+  ],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  },
+  "moduleNameMapper": {
+    "^@app/sentinel(|/.*)$": "<rootDir>/../libs/sentinel/src/$1"
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "resolvePackageJsonExports": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2023",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "noFallthroughCasesInSwitch": false,
+    "paths": {
+      "@app/sentinel": [
+        "libs/sentinel/src"
+      ],
+      "@app/sentinel/*": [
+        "libs/sentinel/src/*"
+      ]
+    }
+  }
+}