@midwayjs/casbin-typeorm-adapter 3.5.3

package/README.md

@@ -0,0 +1,12 @@
+# midwayjs casbin with typeorm
+
+[![Package Quality](http://npm.packagequality.com/shield/midway-core.svg)](http://packagequality.com/#?package=midway-core)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/midwayjs/midway/pulls)
+
+this is a sub package for midway.
+
+Document: [https://midwayjs.org](https://midwayjs.org)
+
+## License
+
+[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/adapter.d.ts

@@ -0,0 +1,26 @@
+import { DataSource } from 'typeorm';
+import { GenericCasbinRule, TypeORMAdapterConfig } from './interface';
+import { BaseAdapter } from '@midwayjs/casbin';
+/**
+ * TypeORMAdapter represents the TypeORM filtered adapter for policy storage.
+ */
+export declare class TypeORMAdapter extends BaseAdapter<GenericCasbinRule> {
+    private adapterConfig;
+    private typeorm;
+    constructor(dataSource: DataSource, options: TypeORMAdapterConfig);
+    private clearTable;
+    /**
+     * 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).
+     * @param type
+     * @param adapterConfig
+     */
+    private static getCasbinRuleType;
+    private getRepository;
+    protected getAdapterLine(): new () => GenericCasbinRule;
+    protected loadPolicyByAdapter(): Promise<GenericCasbinRule[]>;
+    protected loadPolicyWithFilterByAdapter(filter: any): Promise<GenericCasbinRule[]>;
+    protected savePolicyByAdapter(policies: GenericCasbinRule[]): Promise<void>;
+    protected removePolicyByAdapter(removePolicy: GenericCasbinRule, newestPolicies?: GenericCasbinRule[]): Promise<void>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeORMAdapter = void 0;
+const casbinRule_1 = require("./casbinRule");
+const casbinMongoRule_1 = require("./casbinMongoRule");
+const casbin_1 = require("@midwayjs/casbin");
+/**
+ * TypeORMAdapter represents the TypeORM filtered adapter for policy storage.
+ */
+class TypeORMAdapter extends casbin_1.BaseAdapter {
+    constructor(dataSource, options) {
+        super();
+        this.typeorm = dataSource;
+        this.adapterConfig = options;
+    }
+    async clearTable() {
+        await this.getRepository().clear();
+    }
+    /**
+     * 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).
+     * @param type
+     * @param adapterConfig
+     */
+    static getCasbinRuleType(type, adapterConfig) {
+        if (adapterConfig === null || adapterConfig === void 0 ? void 0 : adapterConfig.customCasbinRuleEntity) {
+            return adapterConfig.customCasbinRuleEntity;
+        }
+        if (type === 'mongodb') {
+            return casbinMongoRule_1.CasbinMongoRule;
+        }
+        return casbinRule_1.CasbinRule;
+    }
+    getRepository() {
+        return this.typeorm.getRepository(this.getAdapterLine());
+    }
+    getAdapterLine() {
+        return TypeORMAdapter.getCasbinRuleType(this.adapterConfig.type, this.adapterConfig);
+    }
+    async loadPolicyByAdapter() {
+        return this.getRepository().find();
+    }
+    async loadPolicyWithFilterByAdapter(filter) {
+        return this.getRepository().find({ where: filter });
+    }
+    async savePolicyByAdapter(policies) {
+        await this.clearTable();
+        const queryRunner = this.typeorm.createQueryRunner();
+        await queryRunner.connect();
+        await queryRunner.startTransaction();
+        try {
+            await queryRunner.manager.save(policies);
+            await queryRunner.commitTransaction();
+        }
+        catch (err) {
+            await queryRunner.rollbackTransaction();
+            throw err;
+        }
+        finally {
+            await queryRunner.release();
+        }
+        await this.getRepository().save(policies);
+    }
+    async removePolicyByAdapter(removePolicy, newestPolicies) {
+        await this.getRepository().delete({
+            ...removePolicy,
+        });
+    }
+}
+exports.TypeORMAdapter = TypeORMAdapter;
+//# sourceMappingURL=adapter.js.map

package/dist/casbinMongoRule.d.ts

@@ -0,0 +1,13 @@
+import { BaseEntity, ObjectID } from 'typeorm';
+export declare class CasbinMongoRule extends BaseEntity {
+    id: ObjectID;
+    ptype: string;
+    v0: string;
+    v1: string;
+    v2: string;
+    v3: string;
+    v4: string;
+    v5: string;
+    v6: string;
+}
+//# sourceMappingURL=casbinMongoRule.d.ts.map

package/dist/casbinMongoRule.js

@@ -0,0 +1,72 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CasbinMongoRule = void 0;
+const typeorm_1 = require("typeorm");
+let CasbinMongoRule = class CasbinMongoRule extends typeorm_1.BaseEntity {
+};
+__decorate([
+    (0, typeorm_1.ObjectIdColumn)(),
+    __metadata("design:type", typeorm_1.ObjectID)
+], CasbinMongoRule.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "ptype", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "v0", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "v1", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "v2", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "v3", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "v4", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "v5", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinMongoRule.prototype, "v6", void 0);
+CasbinMongoRule = __decorate([
+    (0, typeorm_1.Entity)()
+], CasbinMongoRule);
+exports.CasbinMongoRule = CasbinMongoRule;
+//# sourceMappingURL=casbinMongoRule.js.map

package/dist/casbinRule.d.ts

@@ -0,0 +1,13 @@
+import { BaseEntity } from 'typeorm';
+export declare class CasbinRule extends BaseEntity {
+    id: number;
+    ptype: string;
+    v0: string;
+    v1: string;
+    v2: string;
+    v3: string;
+    v4: string;
+    v5: string;
+    v6: string;
+}
+//# sourceMappingURL=casbinRule.d.ts.map

package/dist/casbinRule.js

@@ -0,0 +1,72 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CasbinRule = void 0;
+const typeorm_1 = require("typeorm");
+let CasbinRule = class CasbinRule extends typeorm_1.BaseEntity {
+};
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)(),
+    __metadata("design:type", Number)
+], CasbinRule.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "ptype", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "v0", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "v1", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "v2", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "v3", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "v4", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "v5", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        nullable: true,
+    }),
+    __metadata("design:type", String)
+], CasbinRule.prototype, "v6", void 0);
+CasbinRule = __decorate([
+    (0, typeorm_1.Entity)()
+], CasbinRule);
+exports.CasbinRule = CasbinRule;
+//# sourceMappingURL=casbinRule.js.map

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { IMidwayContainer } from '@midwayjs/core';
+import { TypeORMAdapter } from './adapter';
+import { TypeORMAdapterConfig } from './interface';
+export * from './adapter';
+export * from './casbinRule';
+export * from './casbinMongoRule';
+export declare function createAdapter(options: TypeORMAdapterConfig): (container: IMidwayContainer) => Promise<TypeORMAdapter>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAdapter = void 0;
+const adapter_1 = require("./adapter");
+const typeorm_1 = require("@midwayjs/typeorm");
+__exportStar(require("./adapter"), exports);
+__exportStar(require("./casbinRule"), exports);
+__exportStar(require("./casbinMongoRule"), exports);
+function createAdapter(options) {
+    return async (container) => {
+        const typeORMDataSourceManager = await container.getAsync(typeorm_1.TypeORMDataSourceManager);
+        const dataSource = typeORMDataSourceManager.getDataSource(options.dataSourceName);
+        return new adapter_1.TypeORMAdapter(dataSource, options);
+    };
+}
+exports.createAdapter = createAdapter;
+//# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -0,0 +1,10 @@
+import { CasbinRule } from './casbinRule';
+import { CasbinMongoRule } from './casbinMongoRule';
+export declare type GenericCasbinRule = CasbinRule | CasbinMongoRule;
+export declare type CasbinRuleConstructor = new (...args: any[]) => GenericCasbinRule;
+export interface TypeORMAdapterConfig {
+    dataSourceName?: string;
+    type?: string;
+    customCasbinRuleEntity?: CasbinRuleConstructor;
+}
+//# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interface.js.map

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@midwayjs/casbin-typeorm-adapter",
+  "description": "midway casbin typeorm adapter",
+  "version": "3.5.3",
+  "main": "dist/index",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "devDependencies": {
+    "@midwayjs/core": "^3.5.3",
+    "@midwayjs/koa": "^3.5.3",
+    "@midwayjs/mock": "^3.5.3",
+    "casbin": "5.19.1",
+    "sqlite3": "5.1.2",
+    "typeorm": "0.3.10"
+  },
+  "dependencies": {
+    "@midwayjs/casbin": "^3.5.3",
+    "@midwayjs/typeorm": "^3.5.3"
+  },
+  "keywords": [
+    "midway",
+    "casbin",
+    "typeorm",
+    "adapter",
+    "typeorm-adapter"
+  ],
+  "author": "czy88840616 <czy88840616@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
+    "ci": "npm run test",
+    "lint": "mwts check"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/midwayjs/midway.git"
+  }
+}