@boxyhq/saml-jackson 1.0.6 → 1.0.7

package/dist/controller/utils.js

@@ -47,8 +47,9 @@ const OAuthErrorResponse = ({ error, error_description, redirect_uri, state, })
 exports.OAuthErrorResponse = OAuthErrorResponse;
 // https://kentcdodds.com/blog/get-a-catch-block-error-message-with-typescript
 function getErrorMessage(error) {
-    if (error instanceof Error)
+    if (error instanceof Error) {
         return error.message;
+    }
     return String(error);
 }
 exports.getErrorMessage = getErrorMessage;

package/dist/db/db.js

@@ -41,6 +41,12 @@ const mongo_1 = __importDefault(require("./mongo"));
 const redis_1 = __importDefault(require("./redis"));
 const sql_1 = __importDefault(require("./sql/sql"));
 const store_1 = __importDefault(require("./store"));
+const JacksonStore_1 = require("./sql/entity/JacksonStore");
+const JacksonIndex_1 = require("./sql/entity/JacksonIndex");
+const JacksonTTL_1 = require("./sql/entity/JacksonTTL");
+const JacksonStore_2 = require("./planetscale/entity/JacksonStore");
+const JacksonIndex_2 = require("./planetscale/entity/JacksonIndex");
+const JacksonTTL_2 = require("./planetscale/entity/JacksonTTL");
 const decrypt = (res, encryptionKey) => {
     if (res.iv && res.tag) {
         return JSON.parse(encrypter.decrypt(res.value, res.iv, res.tag, encryptionKey));
@@ -107,7 +113,17 @@ exports.default = {
             case 'redis':
                 return new DB(yield redis_1.default.new(options), encryptionKey);
             case 'sql':
-                return new DB(yield sql_1.default.new(options), encryptionKey);
+                return new DB(yield sql_1.default.new(options, {
+                    JacksonStore: JacksonStore_1.JacksonStore,
+                    JacksonIndex: JacksonIndex_1.JacksonIndex,
+                    JacksonTTL: JacksonTTL_1.JacksonTTL,
+                }), encryptionKey);
+            case 'planetscale':
+                return new DB(yield sql_1.default.new(options, {
+                    JacksonStore: JacksonStore_2.JacksonStore,
+                    JacksonIndex: JacksonIndex_2.JacksonIndex,
+                    JacksonTTL: JacksonTTL_2.JacksonTTL,
+                }), encryptionKey);
             case 'mongo':
                 return new DB(yield mongo_1.default.new(options), encryptionKey);
             case 'mem':

package/dist/db/mongo.js

@@ -67,8 +67,9 @@ class Mongo {
             const docs = yield this.collection
                 .find({ _id: _namespaceMatch }, { sort: { createdAt: -1 }, skip: offset, limit: limit })
                 .toArray();
-            if (docs)
+            if (docs) {
                 return docs.map(({ value }) => value);
+            }
             return [];
         });
     }

package/dist/db/planetscale/entity/JacksonIndex.d.ts

@@ -0,0 +1,5 @@
+export declare class JacksonIndex {
+    id: number;
+    key: string;
+    storeKey: string;
+}

package/dist/db/planetscale/entity/JacksonIndex.js

@@ -0,0 +1,34 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JacksonIndex = void 0;
+const typeorm_1 = require("typeorm");
+let JacksonIndex = class JacksonIndex {
+};
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)()
+], JacksonIndex.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Index)('_jackson_index_key'),
+    (0, typeorm_1.Column)({
+        type: 'varchar',
+        length: 250,
+    })
+], JacksonIndex.prototype, "key", void 0);
+__decorate([
+    (0, typeorm_1.Index)('_jackson_index_store'),
+    (0, typeorm_1.Column)({
+        type: 'varchar',
+        length: 250,
+    })
+], JacksonIndex.prototype, "storeKey", void 0);
+JacksonIndex = __decorate([
+    (0, typeorm_1.Index)('_jackson_index_key_store', ['key', 'storeKey']),
+    (0, typeorm_1.Entity)()
+], JacksonIndex);
+exports.JacksonIndex = JacksonIndex;

package/dist/db/planetscale/entity/JacksonStore.d.ts

@@ -0,0 +1,8 @@
+export declare class JacksonStore {
+    key: string;
+    value: string;
+    iv?: string;
+    tag?: string;
+    createdAt?: Date;
+    modifiedAt?: string;
+}

package/dist/db/planetscale/entity/JacksonStore.js

@@ -0,0 +1,55 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JacksonStore = void 0;
+const typeorm_1 = require("typeorm");
+let JacksonStore = class JacksonStore {
+};
+__decorate([
+    (0, typeorm_1.Column)({
+        primary: true,
+        type: 'varchar',
+        length: 250,
+    })
+], JacksonStore.prototype, "key", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'text',
+    })
+], JacksonStore.prototype, "value", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'varchar',
+        length: 64,
+        nullable: true,
+    })
+], JacksonStore.prototype, "iv", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'varchar',
+        length: 64,
+        nullable: true,
+    })
+], JacksonStore.prototype, "tag", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'timestamp',
+        default: () => 'CURRENT_TIMESTAMP',
+        nullable: false,
+    })
+], JacksonStore.prototype, "createdAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        type: 'timestamp',
+        nullable: true,
+    })
+], JacksonStore.prototype, "modifiedAt", void 0);
+JacksonStore = __decorate([
+    (0, typeorm_1.Entity)()
+], JacksonStore);
+exports.JacksonStore = JacksonStore;

package/dist/db/planetscale/entity/JacksonTTL.d.ts

@@ -0,0 +1,4 @@
+export declare class JacksonTTL {
+    key: string;
+    expiresAt: number;
+}

package/dist/db/planetscale/entity/JacksonTTL.js

@@ -0,0 +1,29 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JacksonTTL = void 0;
+const typeorm_1 = require("typeorm");
+let JacksonTTL = class JacksonTTL {
+};
+__decorate([
+    (0, typeorm_1.Column)({
+        primary: true,
+        type: 'varchar',
+        length: 250,
+    })
+], JacksonTTL.prototype, "key", void 0);
+__decorate([
+    (0, typeorm_1.Index)('_jackson_ttl_expires_at'),
+    (0, typeorm_1.Column)({
+        type: 'bigint',
+    })
+], JacksonTTL.prototype, "expiresAt", void 0);
+JacksonTTL = __decorate([
+    (0, typeorm_1.Entity)()
+], JacksonTTL);
+exports.JacksonTTL = JacksonTTL;

package/dist/db/sql/sql.d.ts

@@ -7,8 +7,15 @@ declare class Sql implements DatabaseDriver {
     private ttlRepository;
     private ttlCleanup;
     private timerId;
+    private JacksonStore;
+    private JacksonIndex;
+    private JacksonTTL;
     constructor(options: DatabaseOption);
-    init(): Promise<Sql>;
+    init({ JacksonStore, JacksonIndex, JacksonTTL }: {
+        JacksonStore: any;
+        JacksonIndex: any;
+        JacksonTTL: any;
+    }): Promise<Sql>;
     get(namespace: string, key: string): Promise<any>;
     getAll(namespace: string, pageOffset: number, pageLimit: number): Promise<unknown[]>;
     getByIndex(namespace: string, idx: Index): Promise<any>;
@@ -16,6 +23,6 @@ declare class Sql implements DatabaseDriver {
     delete(namespace: string, key: string): Promise<any>;
 }
 declare const _default: {
-    new: (options: DatabaseOption) => Promise<Sql>;
+    new: (options: DatabaseOption, entities: any) => Promise<Sql>;
 };
 export default _default;

package/dist/db/sql/sql.js

@@ -36,25 +36,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 require('reflect-metadata');
 const typeorm_1 = require("typeorm");
 const dbutils = __importStar(require("../utils"));
-const JacksonStore_1 = require("./entity/JacksonStore");
-const JacksonIndex_1 = require("./entity/JacksonIndex");
-const JacksonTTL_1 = require("./entity/JacksonTTL");
 class Sql {
     constructor(options) {
         this.options = options;
     }
-    init() {
+    init({ JacksonStore, JacksonIndex, JacksonTTL }) {
         return __awaiter(this, void 0, void 0, function* () {
             while (true) {
                 try {
                     this.dataSource = new typeorm_1.DataSource({
                         // name: this.options.type! + Math.floor(Math.random() * 100000),
-                        type: this.options.type,
+                        type: this.options.engine === 'planetscale' ? 'mysql' : this.options.type,
                         url: this.options.url,
-                        synchronize: true,
+                        synchronize: this.options.engine !== 'planetscale',
                         migrationsTableName: '_jackson_migrations',
                         logging: ['error'],
-                        entities: [JacksonStore_1.JacksonStore, JacksonIndex_1.JacksonIndex, JacksonTTL_1.JacksonTTL],
+                        entities: [JacksonStore, JacksonIndex, JacksonTTL],
+                        ssl: this.options.ssl,
                     });
                     yield this.dataSource.initialize();
                     break;
@@ -65,9 +63,12 @@ class Sql {
                     continue;
                 }
             }
-            this.storeRepository = this.dataSource.getRepository(JacksonStore_1.JacksonStore);
-            this.indexRepository = this.dataSource.getRepository(JacksonIndex_1.JacksonIndex);
-            this.ttlRepository = this.dataSource.getRepository(JacksonTTL_1.JacksonTTL);
+            this.JacksonStore = JacksonStore;
+            this.JacksonIndex = JacksonIndex;
+            this.JacksonTTL = JacksonTTL;
+            this.storeRepository = this.dataSource.getRepository(JacksonStore);
+            this.indexRepository = this.dataSource.getRepository(JacksonIndex);
+            this.ttlRepository = this.dataSource.getRepository(JacksonTTL);
             if (this.options.ttl && this.options.cleanupLimit) {
                 this.ttlCleanup = () => __awaiter(this, void 0, void 0, function* () {
                     const now = Date.now();
@@ -121,15 +122,11 @@ class Sql {
                 select: ['value', 'iv', 'tag'],
                 order: {
                     ['createdAt']: 'DESC',
-                    // ['createdAt']: 'ASC',
                 },
                 take: offsetAndLimitValueCheck ? this.options.pageLimit : pageLimit,
                 skip: offsetAndLimitValueCheck ? 0 : pageOffset,
             });
-            const returnValue = JSON.parse(JSON.stringify(response));
-            if (returnValue)
-                return returnValue;
-            return [];
+            return JSON.parse(JSON.stringify(response)) || [];
         });
     }
     getByIndex(namespace, idx) {
@@ -139,13 +136,19 @@ class Sql {
             });
             const ret = [];
             if (res) {
-                res.forEach((r) => {
+                for (const r of res) {
+                    let value = r.store;
+                    if (this.options.engine === 'planetscale') {
+                        value = yield this.storeRepository.findOneBy({
+                            key: r.storeKey,
+                        });
+                    }
                     ret.push({
-                        value: r.store.value,
-                        iv: r.store.iv,
-                        tag: r.store.tag,
+                        value: value.value,
+                        iv: value.iv,
+                        tag: value.tag,
                     });
-                });
+                }
             }
             return ret;
         });
@@ -154,7 +157,7 @@ class Sql {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.dataSource.transaction((transactionalEntityManager) => __awaiter(this, void 0, void 0, function* () {
                 const dbKey = dbutils.key(namespace, key);
-                const store = new JacksonStore_1.JacksonStore();
+                const store = new this.JacksonStore();
                 store.key = dbKey;
                 store.value = val.value;
                 store.iv = val.iv;
@@ -162,7 +165,7 @@ class Sql {
                 store.modifiedAt = new Date().toISOString();
                 yield transactionalEntityManager.save(store);
                 if (ttl) {
-                    const ttlRec = new JacksonTTL_1.JacksonTTL();
+                    const ttlRec = new this.JacksonTTL();
                     ttlRec.key = dbKey;
                     ttlRec.expiresAt = Date.now() + ttl * 1000;
                     yield transactionalEntityManager.save(ttlRec);
@@ -175,9 +178,14 @@ class Sql {
                         storeKey: store.key,
                     });
                     if (!rec) {
-                        const ji = new JacksonIndex_1.JacksonIndex();
+                        const ji = new this.JacksonIndex();
                         ji.key = key;
-                        ji.store = store;
+                        if (this.options.engine === 'planetscale') {
+                            ji.storeKey = store.key;
+                        }
+                        else {
+                            ji.store = store;
+                        }
                         yield transactionalEntityManager.save(ji);
                     }
                 }
@@ -188,6 +196,18 @@ class Sql {
         return __awaiter(this, void 0, void 0, function* () {
             const dbKey = dbutils.key(namespace, key);
             yield this.ttlRepository.remove({ key: dbKey });
+            if (this.options.engine === 'planetscale') {
+                const response = yield this.indexRepository.find({
+                    where: { storeKey: dbKey },
+                    select: ['id'],
+                });
+                const returnValue = response || [];
+                for (const r of returnValue) {
+                    yield this.indexRepository.remove({
+                        id: r.id,
+                    });
+                }
+            }
             return yield this.storeRepository.remove({
                 key: dbKey,
             });
@@ -195,7 +215,7 @@ class Sql {
     }
 }
 exports.default = {
-    new: (options) => __awaiter(void 0, void 0, void 0, function* () {
-        return yield new Sql(options).init();
+    new: (options, entities) => __awaiter(void 0, void 0, void 0, function* () {
+        return yield new Sql(options).init(entities);
     }),
 };

package/dist/typings.d.ts

@@ -106,7 +106,7 @@ export interface Encrypted {
     value: string;
 }
 export declare type EncryptionKey = any;
-export declare type DatabaseEngine = 'redis' | 'sql' | 'mongo' | 'mem';
+export declare type DatabaseEngine = 'redis' | 'sql' | 'mongo' | 'mem' | 'planetscale';
 export declare type DatabaseType = 'postgres' | 'mysql' | 'mariadb';
 export interface DatabaseOption {
     engine?: DatabaseEngine;
@@ -116,6 +116,7 @@ export interface DatabaseOption {
     cleanupLimit?: number;
     encryptionKey?: string;
     pageLimit?: number;
+    ssl?: any;
 }
 export interface JacksonOption {
     externalUrl: string;

package/migration/planetscale/1653746497237-ms_nocascade.ts

@@ -0,0 +1,22 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class msNocascade1653746497237 implements MigrationInterface {
+    name = 'msNocascade1653746497237'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TABLE \`jackson_store\` (\`key\` varchar(250) NOT NULL, \`value\` text NOT NULL, \`iv\` varchar(64) NULL, \`tag\` varchar(64) NULL, \`createdAt\` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, \`modifiedAt\` timestamp NULL, PRIMARY KEY (\`key\`)) ENGINE=InnoDB`);
+        await queryRunner.query(`CREATE TABLE \`jackson_ttl\` (\`key\` varchar(250) NOT NULL, \`expiresAt\` bigint NOT NULL, INDEX \`_jackson_ttl_expires_at\` (\`expiresAt\`), PRIMARY KEY (\`key\`)) ENGINE=InnoDB`);
+        await queryRunner.query(`CREATE TABLE \`jackson_index\` (\`id\` int NOT NULL AUTO_INCREMENT, \`key\` varchar(250) NOT NULL, \`storeKey\` varchar(250) NOT NULL, INDEX \`_jackson_index_key\` (\`key\`), INDEX \`_jackson_index_store\` (\`storeKey\`), INDEX \`_jackson_index_key_store\` (\`key\`, \`storeKey\`), PRIMARY KEY (\`id\`)) ENGINE=InnoDB`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP INDEX \`_jackson_index_key_store\` ON \`jackson_index\``);
+        await queryRunner.query(`DROP INDEX \`_jackson_index_store\` ON \`jackson_index\``);
+        await queryRunner.query(`DROP INDEX \`_jackson_index_key\` ON \`jackson_index\``);
+        await queryRunner.query(`DROP TABLE \`jackson_index\``);
+        await queryRunner.query(`DROP INDEX \`_jackson_ttl_expires_at\` ON \`jackson_ttl\``);
+        await queryRunner.query(`DROP TABLE \`jackson_ttl\``);
+        await queryRunner.query(`DROP TABLE \`jackson_store\``);
+    }
+
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxyhq/saml-jackson",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "SAML Jackson library",
   "keywords": [
     "SAML 2.0"
@@ -20,9 +20,11 @@
     "build": "tsc -p tsconfig.build.json",
     "db:migration:generate:postgres": "ts-node --transpile-only ./node_modules/typeorm/cli.js migration:generate -d typeorm.ts  migration/postgres/pg_${MIGRATION_NAME}",
     "db:migration:generate:mysql": "cross-env DB_TYPE=mysql DB_URL=mysql://root:mysql@localhost:3307/mysql ts-node --transpile-only ./node_modules/typeorm/cli.js migration:generate -d typeorm.ts migration/mysql/ms_${MIGRATION_NAME}",
+    "db:migration:generate:planetscale": "cross-env DB_ENGINE=planetscale DB_URL=mysql://root:mysql@localhost:3307/mysql ts-node --transpile-only ./node_modules/typeorm/cli.js migration:generate -d typeorm.ts migration/mysql/ms_${MIGRATION_NAME}",
     "db:migration:generate:mariadb": "cross-env DB_TYPE=mariadb DB_URL=mariadb://root@localhost:3306/mysql ts-node --transpile-only ./node_modules/typeorm/cli.js migration:generate -d typeorm.ts migration/mariadb/md_${MIGRATION_NAME}",
     "db:migration:run:postgres": "ts-node --transpile-only ./node_modules/typeorm/cli.js migration:run -d typeorm.ts",
     "db:migration:run:mysql": "cross-env DB_TYPE=mysql DB_URL=mysql://root:mysql@localhost:3307/mysql ts-node --transpile-only ./node_modules/typeorm/cli.js migration:run -d typeorm.ts",
+    "db:migration:run:planetscale": "cross-env DB_SSL=true DB_ENGINE=planetscale DB_URL=${PLANETSCALE_URL} ts-node --transpile-only ./node_modules/typeorm/cli.js migration:run -d typeorm.ts",
     "db:migration:run:mariadb": "cross-env DB_TYPE=mariadb DB_URL=mariadb://root@localhost:3306/mysql ts-node --transpile-only ./node_modules/typeorm/cli.js migration:run -d typeorm.ts",
     "prepublishOnly": "npm run build",
     "test": "tap --ts --timeout=100 --coverage test/**/*.test.ts",