feat: Update typescript to v5, use eslint, fix ObjectId issue, fix dependency lock

Author: hsluoyz

.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  env: {
+    node: true,
+  },
+  rules: {
+    'max-classes-per-file': 'off',
+    '@typescript-eslint/no-empty-interface': 'off',
+    'no-console': 'off',
+    'arrow-parens': 'off',
+    'ordered-imports': 'off',
+    'object-literal-sort-keys': 'off',
+    'no-empty': 'off',
+    'quotes': ['error', 'single'],
+    'comma-dangle': 'off',
+    'max-len': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+  },
+};

.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/[email protected]
         with:
-          node-version: ^14
+          node-version: ^18
 
       - name: Install Dependency
         run: yarn install
@@ -54,7 +54,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [^16, ^17, ^18]
+        node: [^16, ^18]
     steps:
       - uses: actions/checkout@v2
 

package.json

@@ -9,30 +9,32 @@
     "prepublish": "yarn run lint && yarn build",
     "build": "rimraf lib && tsc",
     "coverage": "jest --coverage --runInBand",
-    "lint": "tslint \"src/**/*.ts\"",
-    "fix": "tslint \"src/**/*.ts\" --fix",
+    "lint": "eslint src/**/*.{ts,tsx,js,jsx}",
+    "fix": "eslint src/**/*.{ts,tsx,js,jsx} --fix",
     "test": "jest --runInBand",
     "release": "npx -p semantic-release -p @semantic-release/git -p @semantic-release/changelog semantic-release",
     "prepare": "npm run build"
   },
   "devDependencies": {
     "@types/jest": "^23.3.5",
-    "@types/node": "^10.11.7",
+    "@types/node": "^20.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
     "coveralls": "^3.0.2",
+    "eslint": "^8.49.0",
     "husky": "^1.1.2",
     "jest": "^28.1.3",
     "lint-staged": "^7.3.0",
     "mysql2": "^2.1.0",
     "pg": "^8.4.2",
     "rimraf": "^2.6.2",
     "ts-jest": "28.0.7",
-    "tslint": "^5.11.0",
-    "typescript": "^4.7.3"
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "casbin": "^5.11.5",
+    "casbin": "^5.27.0",
     "reflect-metadata": "^0.1.13",
-    "typeorm": "^0.3.6"
+    "typeorm": "^0.3.17"
   },
   "files": [
     "lib",
@@ -68,13 +70,15 @@
     "url": "https://github.com/node-casbin/typeorm-adapter/issues"
   },
   "lint-staged": {
-    "*.{ts,js}": [
-      "tslint --fix",
+    "*.{ts,tsx,js,jsx}": [
+      "eslint --fix",
       "git add"
     ]
   },
   "jest": {
-    "testURL": "http://localhost",
+    "testEnvironmentOptions": {
+      "url": "http://localhost"
+    },
     "transform": {
       "^.+\\.(ts|tsx)$": "ts-jest"
     },

src/adapter.ts

@@ -359,8 +359,9 @@ export default class TypeORMAdapter implements FilteredAdapter {
 
   /**
    * Returns either a {@link CasbinRule} or a {@link CasbinMongoRule}, depending on the type. If passed a custom entity through the adapter config it will use that entity type.
-   * This switch is required as the normal {@link CasbinRule} does not work when using MongoDB as a backend (due to a missing ObjectID field).
+   * This switch is required as the normal {@link CasbinRule} does not work when using MongoDB as a backend (due to a missing ObjectId field).
    * @param type
+   * @param adapterConfig
    */
   private static getCasbinRuleType(
     type: string,

src/casbinMongoRule.ts

@@ -12,12 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { BaseEntity, Column, Entity, ObjectID, ObjectIdColumn } from 'typeorm';
+import { BaseEntity, Column, Entity, ObjectId, ObjectIdColumn } from 'typeorm';
 
 @Entity()
 export class CasbinMongoRule extends BaseEntity {
   @ObjectIdColumn()
-  public id!: ObjectID;
+  public id!: ObjectId;
 
   @Column({
     nullable: true,

src/index.ts

@@ -1,3 +1,4 @@
+import 'reflect-metadata';
 export { TypeORMAdapterOptions } from './adapter';
 export * from './casbinMongoRule';
 export * from './casbinRule';

test/adapter-config.test.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { Enforcer } from 'casbin';
+import {Enforcer, setDefaultFileSystem} from 'casbin';
 import {
   CreateDateColumn,
   DataSource,
@@ -22,6 +22,9 @@ import {
 import TypeORMAdapter, { CasbinRule } from '../src/index';
 import { connectionConfig } from './config';
 
+import * as fs from 'fs';
+setDefaultFileSystem(fs as any);
+
 @Entity('custom_rule')
 class CustomCasbinRule extends CasbinRule {
   @CreateDateColumn()

test/adapter-with-acl-model.test.ts

@@ -12,10 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { Enforcer, Util } from 'casbin';
+import {Enforcer, setDefaultFileSystem} from 'casbin';
 import TypeORMAdapter from '../src/index';
 import { connectionConfig } from './config';
 
+import * as fs from 'fs';
+setDefaultFileSystem(fs as any);
+
 test(
   'TestAdapter',
   async () => {

test/adapter-with-rbac-model.test.ts

@@ -12,10 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { Enforcer, Util } from 'casbin';
+import {Enforcer, setDefaultFileSystem} from 'casbin';
 import TypeORMAdapter from '../src/index';
 import { connectionConfig } from './config';
 
+import * as fs from 'fs';
+setDefaultFileSystem(fs as any);
+
 test(
   'TestAdapter',
   async () => {

test/existent-connection-adapter.test.ts

@@ -12,11 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { Enforcer, Util } from 'casbin';
+import {Enforcer, setDefaultFileSystem, Util} from 'casbin';
 import { DataSource } from 'typeorm';
 import TypeORMAdapter, { CasbinRule } from '../src/index';
 import { connectionConfig } from './config';
 
+import * as fs from 'fs';
+setDefaultFileSystem(fs as any);
+
 async function testGetPolicy(e: Enforcer, res: string[][]) {
   const myRes = await e.getPolicy();