@studiosonrai/nestjs-testfx 1.0.0 → 1.1.0

package/dist/src/helpers/app-test.helper.d.ts

@@ -0,0 +1,9 @@
+import { INestApplication } from '@nestjs/common';
+import { TestingModule } from '@nestjs/testing';
+export interface CreateTestAppOptions {
+    whitelist?: boolean;
+    transform?: boolean;
+    forbidNonWhitelisted?: boolean;
+    beforeInit?: (app: INestApplication) => void | Promise<void>;
+}
+export declare function createTestApp(moduleFixture: TestingModule, options?: CreateTestAppOptions): Promise<INestApplication>;

package/dist/src/helpers/app-test.helper.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestApp = createTestApp;
+const common_1 = require("@nestjs/common");
+async function createTestApp(moduleFixture, options = {}) {
+    const { whitelist = true, transform = true, forbidNonWhitelisted = true, beforeInit, } = options;
+    const app = moduleFixture.createNestApplication();
+    app.useGlobalPipes(new common_1.ValidationPipe({
+        whitelist,
+        transform,
+        forbidNonWhitelisted,
+    }));
+    if (beforeInit) {
+        await beforeInit(app);
+    }
+    await app.init();
+    return app;
+}
+//# sourceMappingURL=app-test.helper.js.map

package/dist/src/helpers/app-test.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-test.helper.js","sourceRoot":"","sources":["../../../src/helpers/app-test.helper.ts"],"names":[],"mappings":";;AAsEA,sCA2BC;AAjGD,2CAAkE;AAsE3D,KAAK,UAAU,aAAa,CACjC,aAA4B,EAC5B,UAAgC,EAAE;IAElC,MAAM,EACJ,SAAS,GAAG,IAAI,EAChB,SAAS,GAAG,IAAI,EAChB,oBAAoB,GAAG,IAAI,EAC3B,UAAU,GACX,GAAG,OAAO,CAAC;IAEZ,MAAM,GAAG,GAAG,aAAa,CAAC,qBAAqB,EAAE,CAAC;IAElD,GAAG,CAAC,cAAc,CAChB,IAAI,uBAAc,CAAC;QACjB,SAAS;QACT,SAAS;QACT,oBAAoB;KACrB,CAAC,CACH,CAAC;IAEF,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IACjB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/src/helpers/auth-test.helper.d.ts

@@ -0,0 +1,28 @@
+import { INestApplication } from '@nestjs/common';
+import { TestingModule } from '@nestjs/testing';
+import { JwtService } from '@nestjs/jwt';
+export interface TestJwtPayload {
+    sub: number;
+    email: string;
+    roles: string[];
+}
+export interface AuthenticatedRequest {
+    get: (url: string) => unknown;
+    post: (url: string) => unknown;
+    put: (url: string) => unknown;
+    patch: (url: string) => unknown;
+    delete: (url: string) => unknown;
+}
+export interface AuthHelper {
+    asAdmin: () => AuthenticatedRequest;
+    asUser: (options?: Partial<TestJwtPayload>) => AuthenticatedRequest;
+    withToken: (token: string) => AuthenticatedRequest;
+    unauthenticated: () => unknown;
+}
+export interface AuthHelperConfig {
+    defaultAdmin?: TestJwtPayload;
+    defaultUser?: TestJwtPayload;
+}
+export declare function createTestToken(jwtService: JwtService, payload: TestJwtPayload): string;
+export declare function getJwtService(module: TestingModule): JwtService;
+export declare function createAuthHelper(app: INestApplication, jwtService: JwtService, config?: AuthHelperConfig): AuthHelper;

package/dist/src/helpers/auth-test.helper.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestToken = createTestToken;
+exports.getJwtService = getJwtService;
+exports.createAuthHelper = createAuthHelper;
+const jwt_1 = require("@nestjs/jwt");
+function createTestToken(jwtService, payload) {
+    return jwtService.sign(payload);
+}
+function getJwtService(module) {
+    return module.get(jwt_1.JwtService);
+}
+function createAuthHelper(app, jwtService, config = {}) {
+    const request = require('supertest');
+    const defaultAdmin = config.defaultAdmin ?? {
+        sub: 1,
+        email: 'admin@test.com',
+        roles: ['admin'],
+    };
+    const defaultUser = config.defaultUser ?? {
+        sub: 2,
+        email: 'user@test.com',
+        roles: ['user'],
+    };
+    const createAuthenticatedRequest = (token) => {
+        const server = app.getHttpServer();
+        return {
+            get: (url) => request(server).get(url).set('Authorization', `Bearer ${token}`),
+            post: (url) => request(server).post(url).set('Authorization', `Bearer ${token}`),
+            put: (url) => request(server).put(url).set('Authorization', `Bearer ${token}`),
+            patch: (url) => request(server).patch(url).set('Authorization', `Bearer ${token}`),
+            delete: (url) => request(server).delete(url).set('Authorization', `Bearer ${token}`),
+        };
+    };
+    return {
+        asAdmin: () => {
+            const token = jwtService.sign(defaultAdmin);
+            return createAuthenticatedRequest(token);
+        },
+        asUser: (options) => {
+            const payload = { ...defaultUser, ...options };
+            const token = jwtService.sign(payload);
+            return createAuthenticatedRequest(token);
+        },
+        withToken: (token) => {
+            return createAuthenticatedRequest(token);
+        },
+        unauthenticated: () => {
+            const server = app.getHttpServer();
+            return request(server);
+        },
+    };
+}
+//# sourceMappingURL=auth-test.helper.js.map

package/dist/src/helpers/auth-test.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-test.helper.js","sourceRoot":"","sources":["../../../src/helpers/auth-test.helper.ts"],"names":[],"mappings":";;AAkGA,0CAKC;AAcD,sCAEC;AA2DD,4CA0DC;AA1OD,qCAAyC;AAgGzC,SAAgB,eAAe,CAC7B,UAAsB,EACtB,OAAuB;IAEvB,OAAO,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAcD,SAAgB,aAAa,CAAC,MAAqB;IACjD,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAU,CAAC,CAAC;AAChC,CAAC;AA2DD,SAAgB,gBAAgB,CAC9B,GAAqB,EACrB,UAAsB,EACtB,SAA2B,EAAE;IAI7B,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAA+B,CAAC;IAEnE,MAAM,YAAY,GAAmB,MAAM,CAAC,YAAY,IAAI;QAC1D,GAAG,EAAE,CAAC;QACN,KAAK,EAAE,gBAAgB;QACvB,KAAK,EAAE,CAAC,OAAO,CAAC;KACjB,CAAC;IAEF,MAAM,WAAW,GAAmB,MAAM,CAAC,WAAW,IAAI;QACxD,GAAG,EAAE,CAAC;QACN,KAAK,EAAE,eAAe;QACtB,KAAK,EAAE,CAAC,MAAM,CAAC;KAChB,CAAC;IAEF,MAAM,0BAA0B,GAAG,CAAC,KAAa,EAAwB,EAAE;QACzE,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,EAAmC,CAAC;QACpE,OAAO;YACL,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE,CACnB,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC;YAClE,IAAI,EAAE,CAAC,GAAW,EAAE,EAAE,CACpB,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC;YACnE,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE,CACnB,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC;YAClE,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE,CACrB,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC;YACpE,MAAM,EAAE,CAAC,GAAW,EAAE,EAAE,CACtB,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,KAAK,EAAE,CAAC;SACtE,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,GAAG,EAAE;YACZ,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC5C,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,EAAE,CAAC,OAAiC,EAAE,EAAE;YAC5C,MAAM,OAAO,GAAG,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACvC,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;QAED,SAAS,EAAE,CAAC,KAAa,EAAE,EAAE;YAC3B,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;QAED,eAAe,EAAE,GAAG,EAAE;YACpB,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,EAAmC,CAAC;YACpE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/src/helpers/index.d.ts

@@ -1 +1,3 @@
 export { DatabaseTestHelper, DatabaseTestHelperConfig, } from './database-test.helper';
+export { createTestApp, CreateTestAppOptions } from './app-test.helper';
+export { createAuthHelper, createTestToken, getJwtService, TestJwtPayload, AuthHelper, AuthenticatedRequest, AuthHelperConfig, } from './auth-test.helper';

package/dist/src/helpers/index.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseTestHelper = void 0;
+exports.getJwtService = exports.createTestToken = exports.createAuthHelper = exports.createTestApp = exports.DatabaseTestHelper = void 0;
 var database_test_helper_1 = require("./database-test.helper");
 Object.defineProperty(exports, "DatabaseTestHelper", { enumerable: true, get: function () { return database_test_helper_1.DatabaseTestHelper; } });
+var app_test_helper_1 = require("./app-test.helper");
+Object.defineProperty(exports, "createTestApp", { enumerable: true, get: function () { return app_test_helper_1.createTestApp; } });
+var auth_test_helper_1 = require("./auth-test.helper");
+Object.defineProperty(exports, "createAuthHelper", { enumerable: true, get: function () { return auth_test_helper_1.createAuthHelper; } });
+Object.defineProperty(exports, "createTestToken", { enumerable: true, get: function () { return auth_test_helper_1.createTestToken; } });
+Object.defineProperty(exports, "getJwtService", { enumerable: true, get: function () { return auth_test_helper_1.getJwtService; } });
 //# sourceMappingURL=index.js.map

package/dist/src/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAMA,+DAGgC;AAF9B,0HAAA,kBAAkB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":";;;AAMA,+DAGgC;AAF9B,0HAAA,kBAAkB,OAAA;AAIpB,qDAAwE;AAA/D,gHAAA,aAAa,OAAA;AAEtB,uDAQ4B;AAP1B,oHAAA,gBAAgB,OAAA;AAChB,mHAAA,eAAe,OAAA;AACf,iHAAA,aAAa,OAAA"}

package/dist/src/index.d.ts

@@ -1,4 +1,4 @@
-export { DatabaseTestHelper, DatabaseTestHelperConfig, } from './helpers';
+export { DatabaseTestHelper, DatabaseTestHelperConfig, createTestApp, CreateTestAppOptions, createAuthHelper, createTestToken, getJwtService, TestJwtPayload, AuthHelper, AuthenticatedRequest, AuthHelperConfig, } from './helpers';
 export { BaseFactory, EntityFactory, FactoryOptions, ExampleUserFactory, ExampleOrderFactory, ExampleFactoryManager, } from './factories';
 export { EntityComparator, ComparisonOptions, ComparisonResult, EntityEquivalentMatcher, createEntityEquivalentMatcher, } from './matchers';
 export { RoleFixture, ROLE_FIXTURES, getAllRoleFixtures, getRoleById, getRoleByName, StatusFixture, ORDER_STATUS_FIXTURES, getAllOrderStatusFixtures, getOrderStatusByCode, ExampleFixtureLoader, } from './fixtures';

package/dist/src/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExampleFixtureLoader = exports.getOrderStatusByCode = exports.getAllOrderStatusFixtures = exports.ORDER_STATUS_FIXTURES = exports.getRoleByName = exports.getRoleById = exports.getAllRoleFixtures = exports.ROLE_FIXTURES = exports.createEntityEquivalentMatcher = exports.EntityComparator = exports.ExampleFactoryManager = exports.ExampleOrderFactory = exports.ExampleUserFactory = exports.BaseFactory = exports.DatabaseTestHelper = void 0;
+exports.ExampleFixtureLoader = exports.getOrderStatusByCode = exports.getAllOrderStatusFixtures = exports.ORDER_STATUS_FIXTURES = exports.getRoleByName = exports.getRoleById = exports.getAllRoleFixtures = exports.ROLE_FIXTURES = exports.createEntityEquivalentMatcher = exports.EntityComparator = exports.ExampleFactoryManager = exports.ExampleOrderFactory = exports.ExampleUserFactory = exports.BaseFactory = exports.getJwtService = exports.createTestToken = exports.createAuthHelper = exports.createTestApp = exports.DatabaseTestHelper = void 0;
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "DatabaseTestHelper", { enumerable: true, get: function () { return helpers_1.DatabaseTestHelper; } });
+Object.defineProperty(exports, "createTestApp", { enumerable: true, get: function () { return helpers_1.createTestApp; } });
+Object.defineProperty(exports, "createAuthHelper", { enumerable: true, get: function () { return helpers_1.createAuthHelper; } });
+Object.defineProperty(exports, "createTestToken", { enumerable: true, get: function () { return helpers_1.createTestToken; } });
+Object.defineProperty(exports, "getJwtService", { enumerable: true, get: function () { return helpers_1.getJwtService; } });
 var factories_1 = require("./factories");
 Object.defineProperty(exports, "BaseFactory", { enumerable: true, get: function () { return factories_1.BaseFactory; } });
 Object.defineProperty(exports, "ExampleUserFactory", { enumerable: true, get: function () { return factories_1.ExampleUserFactory; } });

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AA2CA,qCAGmB;AAFjB,6GAAA,kBAAkB,OAAA;AAKpB,yCAOqB;AANnB,wGAAA,WAAW,OAAA;AAGX,+GAAA,kBAAkB,OAAA;AAClB,gHAAA,mBAAmB,OAAA;AACnB,kHAAA,qBAAqB,OAAA;AAIvB,uCAMoB;AALlB,4GAAA,gBAAgB,OAAA;AAIhB,yHAAA,6BAA6B,OAAA;AAI/B,uCAWoB;AATlB,yGAAA,aAAa,OAAA;AACb,8GAAA,kBAAkB,OAAA;AAClB,uGAAA,WAAW,OAAA;AACX,yGAAA,aAAa,OAAA;AAEb,iHAAA,qBAAqB,OAAA;AACrB,qHAAA,yBAAyB,OAAA;AACzB,gHAAA,oBAAoB,OAAA;AACpB,gHAAA,oBAAoB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AA2CA,qCAYmB;AAXjB,6GAAA,kBAAkB,OAAA;AAElB,wGAAA,aAAa,OAAA;AAEb,2GAAA,gBAAgB,OAAA;AAChB,0GAAA,eAAe,OAAA;AACf,wGAAA,aAAa,OAAA;AAQf,yCAOqB;AANnB,wGAAA,WAAW,OAAA;AAGX,+GAAA,kBAAkB,OAAA;AAClB,gHAAA,mBAAmB,OAAA;AACnB,kHAAA,qBAAqB,OAAA;AAIvB,uCAMoB;AALlB,4GAAA,gBAAgB,OAAA;AAIhB,yHAAA,6BAA6B,OAAA;AAI/B,uCAWoB;AATlB,yGAAA,aAAa,OAAA;AACb,8GAAA,kBAAkB,OAAA;AAClB,uGAAA,WAAW,OAAA;AACX,yGAAA,aAAa,OAAA;AAEb,iHAAA,qBAAqB,OAAA;AACrB,qHAAA,yBAAyB,OAAA;AACzB,gHAAA,oBAAoB,OAAA;AACpB,gHAAA,oBAAoB,OAAA"}