@zakyyudha/node-authzkit 1.0.0

package/dist/tests/PgAuthzkitStore.test.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Authzkit_1 = require("../src/classes/Authzkit");
+const pg_connection_1 = require("../src/drivers/postgres/pg-connection");
+const pg_mem_1 = require("pg-mem");
+const PgAuthzkitStore_1 = require("../src/stores/PgAuthzkitStore");
+// Increase Jest timeout for PostgreSQL operations
+jest.setTimeout(30000); // 30 seconds
+describe('PgAuthzkitStore', () => {
+    let pgMemDb; // Use any because IMemoryDb doesn't have clone method directly
+    let pgConnection;
+    let pgAuthzkitStore;
+    let authzkit;
+    let user;
+    // No actual connection string needed for in-memory db
+    const CONNECTION_STRING = 'in-memory-db';
+    beforeAll(async () => {
+        // pg-mem's newDb() method creates a fresh, isolated database instance.
+        // We create one for the whole test suite as pg-mem can be reset efficiently.
+        pgMemDb = (0, pg_mem_1.newDb)();
+        const config = {
+            connection: {
+                type: 'postgres',
+                uri: CONNECTION_STRING,
+            },
+        };
+        pgConnection = pg_connection_1.PgConnection.getInstance(config, pgMemDb);
+        // No need to call pgConnection.connect() for pg-mem, as it's mocked
+        await pgConnection.initSchema(); // Initialize schema for tests
+    });
+    beforeEach(async () => {
+        // For pg-mem, pgMemDb.public.query('TRUNCATE ...') is the way to reset data.
+        // This is handled by authzkit.reset() which calls pgAuthzkitStore.reset().
+        // We need to re-initialize PgConnection for each test to ensure its internal state is clean.
+        const config = {
+            connection: {
+                type: 'postgres',
+                uri: CONNECTION_STRING + Math.random(),
+            },
+        };
+        pgConnection = pg_connection_1.PgConnection.getInstance(config, pgMemDb); // Unique connectionString for singleton instance tracking
+        pgAuthzkitStore = new PgAuthzkitStore_1.PgAuthzkitStore(pgConnection);
+        Authzkit_1.Authzkit.getInstance(pgAuthzkitStore); // Initialize Authzkit with the Pg store
+        authzkit = Authzkit_1.Authzkit.getInstance(); // Get the instance, ensure it's the one we just set
+        await authzkit.reset(); // Clear all data for current test using the clean schema
+        // Define some permissions and roles
+        await authzkit.definePermission('create_pg_post');
+        await authzkit.definePermission('edit_pg_post');
+        await authzkit.definePermission('delete_pg_post');
+        await authzkit.definePermission('view_pg_dashboard');
+        await authzkit.defineRole('pg_admin', [
+            'create_pg_post',
+            'edit_pg_post',
+            'delete_pg_post',
+            'view_pg_dashboard',
+        ]);
+        await authzkit.defineRole('pg_editor', ['create_pg_post', 'edit_pg_post']);
+        await authzkit.defineRole('pg_viewer', ['view_pg_dashboard']);
+        user = { id: 'pg_user1', roles: [], permissions: [] }; // Using string ID
+    });
+    afterAll(async () => {
+        // No explicit disconnect needed for pg-mem
+    });
+    // --- Permission Definition Tests ---
+    test('should define a permission', async () => {
+        const perm = await authzkit.definePermission('new_pg_permission');
+        expect(perm).toEqual({ name: 'new_pg_permission', guard_name: undefined });
+        await expect(authzkit.definePermission('new_pg_permission')).rejects.toThrow(/Permission 'new_pg_permission' already exists./);
+    });
+    // --- Role Definition Tests ---
+    test('should define a role with permissions', async () => {
+        const role = await authzkit.defineRole('pg_moderator', ['edit_pg_post']);
+        expect(role).toEqual({
+            name: 'pg_moderator',
+            permissions: ['edit_pg_post'],
+            guard_name: undefined,
+        });
+        await expect(authzkit.defineRole('pg_admin')).rejects.toThrow(/Role 'pg_admin' already exists./);
+    });
+    test('should throw error if role is defined with non-existent permission', async () => {
+        await expect(authzkit.defineRole('bad_pg_role', ['non_existent_pg_permission'])).rejects.toThrow(/Permission 'non_existent_pg_permission' not found when defining role 'bad_pg_role'./);
+    });
+    // --- Assignment Tests ---
+    test('should assign a role to a user', async () => {
+        await authzkit.assignRole(user, 'pg_editor');
+        expect(await authzkit.hasRole(user, 'pg_editor')).toBe(true);
+        expect(await authzkit.hasRole(user, 'pg_admin')).toBe(false);
+    });
+    test('should assign a direct permission to a user', async () => {
+        await authzkit.assignPermission(user, 'create_pg_post');
+        expect(await authzkit.hasPermission(user, 'create_pg_post')).toBe(true);
+        expect(await authzkit.hasPermission(user, 'edit_pg_post')).toBe(false);
+    });
+    test('should throw error if assigning non-existent role', async () => {
+        await expect(authzkit.assignRole(user, 'non_existent_pg_role')).rejects.toThrow(/Role 'non_existent_pg_role' not found./);
+    });
+    test('should throw error if assigning non-existent permission', async () => {
+        await expect(authzkit.assignPermission(user, 'non_existent_pg_permission')).rejects.toThrow(/Permission 'non_existent_pg_permission' not found./);
+    });
+    // --- Revocation Tests ---
+    test('should revoke a role from a user', async () => {
+        await authzkit.assignRole(user, 'pg_editor');
+        expect(await authzkit.hasRole(user, 'pg_editor')).toBe(true);
+        await authzkit.revokeRole(user, 'pg_editor');
+        expect(await authzkit.hasRole(user, 'pg_editor')).toBe(false);
+    });
+    test('should revoke a direct permission from a user', async () => {
+        await authzkit.assignPermission(user, 'create_pg_post');
+        expect(await authzkit.hasPermission(user, 'create_pg_post')).toBe(true);
+        await authzkit.revokePermission(user, 'create_pg_post');
+        expect(await authzkit.hasPermission(user, 'create_pg_post')).toBe(false);
+    });
+    // --- Has Role/Permission Tests ---
+    test('user with role should have role', async () => {
+        await authzkit.assignRole(user, 'pg_admin');
+        expect(await authzkit.hasRole(user, 'pg_admin')).toBe(true);
+    });
+    test('user without role should not have role', async () => {
+        expect(await authzkit.hasRole(user, 'pg_admin')).toBe(false);
+    });
+    test('user with direct permission should have permission', async () => {
+        await authzkit.assignPermission(user, 'edit_pg_post');
+        expect(await authzkit.hasPermission(user, 'edit_pg_post')).toBe(true);
+    });
+    test('user with role having permission should have permission', async () => {
+        await authzkit.assignRole(user, 'pg_editor'); // pg_editor has create_pg_post, edit_pg_post
+        expect(await authzkit.hasPermission(user, 'create_pg_post')).toBe(true);
+        expect(await authzkit.hasPermission(user, 'edit_pg_post')).toBe(true);
+        expect(await authzkit.hasPermission(user, 'delete_pg_post')).toBe(false);
+    });
+    test('user with admin role should have all admin permissions', async () => {
+        await authzkit.assignRole(user, 'pg_admin');
+        expect(await authzkit.hasPermission(user, 'create_pg_post')).toBe(true);
+        expect(await authzkit.hasPermission(user, 'edit_pg_post')).toBe(true);
+        expect(await authzkit.hasPermission(user, 'delete_pg_post')).toBe(true);
+        expect(await authzkit.hasPermission(user, 'view_pg_dashboard')).toBe(true);
+    });
+    test('user with no permissions/roles should not have any permissions', async () => {
+        expect(await authzkit.hasPermission(user, 'create_pg_post')).toBe(false);
+        expect(await authzkit.hasRole(user, 'pg_admin')).toBe(false);
+    });
+    test('roleHasPermission should work correctly', async () => {
+        expect(await authzkit.roleHasPermission('pg_admin', 'create_pg_post')).toBe(true);
+        expect(await authzkit.roleHasPermission('pg_editor', 'delete_pg_post')).toBe(false);
+        expect(await authzkit.roleHasPermission('pg_viewer', 'view_pg_dashboard')).toBe(true);
+        expect(await authzkit.roleHasPermission('non_existent_pg_role', 'some_permission')).toBe(false);
+    });
+    // --- Reset Tests ---
+    test('reset should clear all permissions, roles, and assignments', async () => {
+        await authzkit.definePermission('test_pg_perm');
+        await authzkit.defineRole('test_pg_role', ['test_pg_perm']);
+        await authzkit.assignRole(user, 'test_pg_role');
+        await authzkit.assignPermission(user, 'test_pg_perm');
+        await authzkit.reset();
+        // After reset, defining again should not throw an error (as they were cleared)
+        await expect(authzkit.definePermission('test_pg_perm')).resolves.not.toThrow();
+        await expect(authzkit.defineRole('test_pg_role', ['test_pg_perm'])).resolves.not.toThrow();
+        // User should no longer have the role/permission
+        expect(await authzkit.hasRole(user, 'test_pg_role')).toBe(false);
+        expect(await authzkit.hasPermission(user, 'test_pg_perm')).toBe(false);
+    });
+});
+//# sourceMappingURL=PgAuthzkitStore.test.js.map

package/dist/tests/PgAuthzkitStore.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PgAuthzkitStore.test.js","sourceRoot":"","sources":["../../tests/PgAuthzkitStore.test.ts"],"names":[],"mappings":";;AAAA,sDAAmD;AAEnD,yEAAqE;AACrE,mCAA+B;AAC/B,mEAAgE;AAGhE,kDAAkD;AAClD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa;AAErC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAI,OAAY,CAAC,CAAC,+DAA+D;IACjF,IAAI,YAA0B,CAAC;IAC/B,IAAI,eAAgC,CAAC;IACrC,IAAI,QAAkB,CAAC;IACvB,IAAI,IAAkB,CAAC;IAEvB,sDAAsD;IACtD,MAAM,iBAAiB,GAAG,cAAc,CAAC;IAEzC,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,uEAAuE;QACvE,6EAA6E;QAC7E,OAAO,GAAG,IAAA,cAAK,GAAE,CAAC;QAElB,MAAM,MAAM,GAAoB;YAC9B,UAAU,EAAE;gBACV,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,iBAAiB;aACvB;SACF,CAAC;QAEF,YAAY,GAAG,4BAAY,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzD,oEAAoE;QACpE,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC,CAAC,8BAA8B;IACjE,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,6EAA6E;QAC7E,2EAA2E;QAC3E,6FAA6F;QAE7F,MAAM,MAAM,GAAoB;YAC9B,UAAU,EAAE;gBACV,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,iBAAiB,GAAG,IAAI,CAAC,MAAM,EAAE;aACvC;SACF,CAAC;QAEF,YAAY,GAAG,4BAAY,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,0DAA0D;QACpH,eAAe,GAAG,IAAI,iCAAe,CAAC,YAAY,CAAC,CAAC;QACpD,mBAAQ,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,wCAAwC;QAC/E,QAAQ,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,oDAAoD;QACvF,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,yDAAyD;QAEjF,oCAAoC;QACpC,MAAM,QAAQ,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAClD,MAAM,QAAQ,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,QAAQ,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAClD,MAAM,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAErD,MAAM,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE;YACpC,gBAAgB;YAChB,cAAc;YACd,gBAAgB;YAChB,mBAAmB;SACpB,CAAC,CAAC;QACH,MAAM,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC,CAAC;QAC3E,MAAM,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAE9D,IAAI,GAAG,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC,kBAAkB;IAC3E,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClB,2CAA2C;IAC7C,CAAC,CAAC,CAAC;IAEH,sCAAsC;IACtC,IAAI,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAClE,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3E,MAAM,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC1E,gDAAgD,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,gCAAgC;IAChC,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,cAAc;YACpB,WAAW,EAAE,CAAC,cAAc,CAAC;YAC7B,UAAU,EAAE,SAAS;SACtB,CAAC,CAAC;QACH,MAAM,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC3D,iCAAiC,CAClC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,MAAM,CACV,QAAQ,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,4BAA4B,CAAC,CAAC,CACnE,CAAC,OAAO,CAAC,OAAO,CACf,qFAAqF,CACtF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,2BAA2B;IAC3B,IAAI,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC7E,wCAAwC,CACzC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACzF,oDAAoD,CACrD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,2BAA2B;IAC3B,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,oCAAoC;IACpC,IAAI,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,6CAA6C;QAC3F,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAChF,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzE,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClF,MAAM,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpF,MAAM,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtF,MAAM,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,sBAAsB,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClG,CAAC,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,QAAQ,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,QAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QAC5D,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAChD,MAAM,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAEtD,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEvB,+EAA+E;QAC/E,MAAM,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAC/E,MAAM,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAE3F,iDAAiD;QACjD,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,CAAC,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/tests/PgAuthzkitStoreCustom.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/PgAuthzkitStoreCustom.test.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Authzkit_1 = require("../src/classes/Authzkit");
+const pg_connection_1 = require("../src/drivers/postgres/pg-connection");
+const pg_mem_1 = require("pg-mem");
+const PgAuthzkitStore_1 = require("../src/stores/PgAuthzkitStore");
+// Increase Jest timeout
+jest.setTimeout(30000);
+describe('PgAuthzkitStore (Custom Tables)', () => {
+    let pgMemDb;
+    let pgConnection;
+    let pgAuthzkitStore;
+    let authzkit;
+    const CONNECTION_STRING = 'in-memory-db-custom';
+    beforeAll(async () => {
+        pgMemDb = (0, pg_mem_1.newDb)();
+        // We need to initialize schema with custom names
+        const config = {
+            connection: {
+                type: 'postgres',
+                uri: CONNECTION_STRING,
+            },
+            models: {
+                users: 'custom_users',
+                roles: 'custom_roles',
+                permissions: 'custom_permissions',
+                user_roles: 'custom_user_roles',
+                user_permissions: 'custom_user_permissions',
+            },
+        };
+        pgConnection = pg_connection_1.PgConnection.getInstance(config, pgMemDb);
+        await pgConnection.initSchema();
+    });
+    beforeEach(async () => {
+        // Config matching the one used in beforeAll (for singleton to return same instance)
+        // Actually, if we pass same config object (by value/content), getInstance should return same instance.
+        // But we used random string in other test. Here we can stick to one instance since we just want to verify table names.
+        // Or we can create a new instance if we want, but we need to pass pgMemDb again.
+        const config = {
+            connection: {
+                type: 'postgres',
+                uri: CONNECTION_STRING,
+            },
+            models: {
+                users: 'custom_users',
+                roles: 'custom_roles',
+                permissions: 'custom_permissions',
+                user_roles: 'custom_user_roles',
+                user_permissions: 'custom_user_permissions',
+            },
+        };
+        // We reuse the instance created in beforeAll
+        pgConnection = pg_connection_1.PgConnection.getInstance(config, pgMemDb);
+        pgAuthzkitStore = new PgAuthzkitStore_1.PgAuthzkitStore(pgConnection);
+        Authzkit_1.Authzkit.getInstance(pgAuthzkitStore);
+        authzkit = Authzkit_1.Authzkit.getInstance();
+        // We don't call reset() here because it might truncate tables we just created?
+        // Actually reset() calls truncateTables(). PgConnection.truncateTables() uses getTableName().
+        // So if config is correct, it should truncate custom tables.
+        await authzkit.reset();
+        await authzkit.definePermission('custom_pg_perm');
+    });
+    test('should store data in custom tables', async () => {
+        // Query pg-mem directly to see if data is in custom table
+        // pg-mem exposes the DB state via pgMemDb
+        // we can use pgConnection.query acting as a backdoor too, but let's try to verify via "direct" SQL on the connection
+        const res = await pgConnection.query('SELECT count(*) FROM custom_permissions WHERE name = $1', ['custom_pg_perm']);
+        expect(res.rows[0].count).toBe(1);
+        // Verify default table does not exist or is empty
+        // In pg-mem, querying non-existent table throws error.
+        await expect(pgConnection.query('SELECT count(*) FROM permissions')).rejects.toThrow();
+    });
+});
+//# sourceMappingURL=PgAuthzkitStoreCustom.test.js.map

package/dist/tests/PgAuthzkitStoreCustom.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PgAuthzkitStoreCustom.test.js","sourceRoot":"","sources":["../../tests/PgAuthzkitStoreCustom.test.ts"],"names":[],"mappings":";;AAAA,sDAAmD;AACnD,yEAAqE;AACrE,mCAA+B;AAC/B,mEAAgE;AAGhE,wBAAwB;AACxB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAEvB,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,OAAY,CAAC;IACjB,IAAI,YAA0B,CAAC;IAC/B,IAAI,eAAgC,CAAC;IACrC,IAAI,QAAkB,CAAC;IAEvB,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;IAEhD,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,OAAO,GAAG,IAAA,cAAK,GAAE,CAAC;QAElB,iDAAiD;QACjD,MAAM,MAAM,GAAoB;YAC9B,UAAU,EAAE;gBACV,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,iBAAiB;aACvB;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,cAAc;gBACrB,KAAK,EAAE,cAAc;gBACrB,WAAW,EAAE,oBAAoB;gBACjC,UAAU,EAAE,mBAAmB;gBAC/B,gBAAgB,EAAE,yBAAyB;aAC5C;SACF,CAAC;QAEF,YAAY,GAAG,4BAAY,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,oFAAoF;QACpF,uGAAuG;QACvG,uHAAuH;QACvH,iFAAiF;QAEjF,MAAM,MAAM,GAAoB;YAC9B,UAAU,EAAE;gBACV,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,iBAAiB;aACvB;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,cAAc;gBACrB,KAAK,EAAE,cAAc;gBACrB,WAAW,EAAE,oBAAoB;gBACjC,UAAU,EAAE,mBAAmB;gBAC/B,gBAAgB,EAAE,yBAAyB;aAC5C;SACF,CAAC;QAEF,6CAA6C;QAC7C,YAAY,GAAG,4BAAY,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzD,eAAe,GAAG,IAAI,iCAAe,CAAC,YAAY,CAAC,CAAC;QACpD,mBAAQ,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QACtC,QAAQ,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC;QAElC,+EAA+E;QAC/E,8FAA8F;QAC9F,6DAA6D;QAC7D,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEvB,MAAM,QAAQ,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QACpD,0DAA0D;QAC1D,0CAA0C;QAE1C,qHAAqH;QAErH,MAAM,GAAG,GAAG,MAAM,YAAY,CAAC,KAAK,CAClC,yDAAyD,EACzD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAElC,kDAAkD;QAClD,uDAAuD;QACvD,MAAM,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACzF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/examples/express-app.ts

@@ -0,0 +1,65 @@
+import express from 'express';
+import {
+  Authzkit,
+  InMemoryAuthzkitStore,
+  createDashboardRouter,
+  loadConfigFromEnv,
+} from '@zakyyudha/node-authzkit';
+
+let authzkit;
+
+const app = express();
+const port = 3000;
+
+try {
+  // Initialize Authzkit
+  // Example: Load from env or default to InMemory
+  const config = loadConfigFromEnv();
+  if (config) {
+    console.log('Using configured store from environment');
+    // Here you would initialize Mongo/Pg connection based on config
+    // For this example we default to InMemory to keep it runnable without DB
+  } else {
+    console.log('Using In-Memory Store');
+  }
+
+  authzkit = Authzkit.getInstance(new InMemoryAuthzkitStore());
+
+  // Setup Dashboard
+  // Mount at /authzkit
+  // Basic Auth: admin / mysecret
+  app.use(
+    '/authzkit',
+    createDashboardRouter({
+      authzkit,
+      secret: 'mysecret',
+      username: 'admin',
+    })
+  );
+} catch (error) {
+  console.error('Failed to initialize Authzkit or Dashboard:', error);
+  process.exit(1); // Exit the process if initialization fails
+}
+
+// Global error handlers
+process.on('uncaughtException', (err) => {
+  console.error('Uncaught Exception:', err);
+});
+process.on('unhandledRejection', (reason, promise) => {
+  console.error('Unhandled Rejection at:', promise, 'reason:', reason);
+});
+
+app.get('/', (req, res) => {
+  res.send(
+    'Go to <a href="/authzkit/">/authzkit/</a> to manage permissions. (User: admin, Pass: mysecret)'
+  );
+});
+
+const server = app.listen(port, () => {
+  console.log(`Example app listening at http://localhost:${port}`);
+  console.log(`Dashboard available at http://localhost:${port}/authzkit/`);
+});
+
+server.on('error', (err) => {
+  console.error('Server error:', err);
+});

package/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/tests'],
+  moduleFileExtensions: ['ts', 'js', 'json', 'node'],
+  transform: {
+    '^.+\.ts$': 'ts-jest',
+  },
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@zakyyudha/node-authzkit",
+  "version": "1.0.0",
+  "description": "A very simple Node.js authorization library",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build:web": "cd src/dashboard/web && pnpm install && pnpm build",
+    "build": "pnpm build:web && tsc && copyfiles -u 3 \"src/dashboard/web/dist/**/*\" dist/src/dashboard/web/",
+    "test": "jest --coverage",
+    "lint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\" --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\" \"examples/**/*.ts\"",
+    "start:dev": "ts-node-dev --respawn --transpile-only -r tsconfig-paths/register examples/express-app.ts",
+    "clean": "rm -rf dist node_modules",
+    "release": "release-it"
+  },
+  "keywords": [
+    "authorization",
+    "permissions",
+    "roles",
+    "node",
+    "typescript"
+  ],
+  "license": "ISC",
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/basic-auth": "^1.1.8",
+    "@types/jest": "^29.5.12",
+    "@types/mongodb-memory-server": "^2.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.16.0",
+    "@typescript-eslint/parser": "^7.16.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "^8.57.0",
+    "globals": "^17.2.0",
+    "jest": "^29.7.0",
+    "mongodb-memory-server": "^11.0.1",
+    "pg-mem": "^3.0.8",
+    "prettier": "^3.3.3",
+    "release-it": "^19.2.4",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "ts-node-dev": "^2.0.0",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^8.54.0"
+  },
+  "dependencies": {
+    "@types/express": "^5.0.6",
+    "@types/mongodb": "^4.0.7",
+    "@types/pg": "^8.16.0",
+    "basic-auth": "^2.0.1",
+    "express": "^5.2.1",
+    "mongodb": "^7.0.0",
+    "pg": "^8.17.2"
+  }
+}

package/src/classes/Authzkit.ts

@@ -0,0 +1,214 @@
+import { Authorizable } from '../interfaces/Authorizable';
+import { Permission } from '../interfaces/Permission';
+import { Role } from '../interfaces/Role';
+import { IAuthzkitStore } from '../stores/IAuthzkitStore';
+import { InMemoryAuthzkitStore } from '../stores/InMemoryAuthzkitStore';
+
+export class Authzkit {
+  private static instance: Authzkit;
+  private store: IAuthzkitStore;
+
+  private constructor(store?: IAuthzkitStore) {
+    this.store = store || new InMemoryAuthzkitStore();
+  }
+
+  /**
+   * Returns the singleton instance of Authzkit.
+   * Optionally accepts a store implementation to use. If no store is provided,
+   * an `InMemoryAuthzkitStore` will be used by default.
+   */
+  public static getInstance(store?: IAuthzkitStore): Authzkit {
+    if (!Authzkit.instance) {
+      Authzkit.instance = new Authzkit(store);
+    }
+    return Authzkit.instance;
+  }
+
+  /**
+   * Defines a new permission.
+   * @param name The name of the permission.
+   * @param guard_name Optional guard name.
+   */
+  public async definePermission(name: string, guard_name?: string): Promise<Permission> {
+    if (await this.store.hasPermission(name)) {
+      throw new Error(`Permission '${name}' already exists.`);
+    }
+    const permission: Permission = { name, guard_name };
+    await this.store.setPermission(permission);
+    return permission;
+  }
+
+  /**
+   * Retrieves all defined permissions.
+   * @returns An array of Permission objects.
+   */
+  public async getPermissions(): Promise<Permission[]> {
+    return await this.store.getPermissions();
+  }
+
+  /**
+   * Retrieves all defined roles.
+   * @returns An array of Role objects.
+   */
+  public async getRoles(): Promise<Role[]> {
+    return await this.store.getRoles();
+  }
+
+  /**
+   * Defines a new role with associated permissions.
+   * @param name The name of the role.
+   * @param permissions An array of permission names.
+   * @param guard_name Optional guard name.
+   */
+  public async defineRole(
+    name: string,
+    permissions: string[] = [],
+    guard_name?: string
+  ): Promise<Role> {
+    if (await this.store.hasRole(name)) {
+      throw new Error(`Role '${name}' already exists.`);
+    }
+    // Ensure all provided permissions exist
+    for (const pName of permissions) {
+      if (!(await this.store.hasPermission(pName))) {
+        throw new Error(`Permission '${pName}' not found when defining role '${name}'.`);
+      }
+    }
+
+    const role: Role = { name, permissions, guard_name }; // Store permission names
+    await this.store.setRole(role);
+    return role;
+  }
+
+  /**
+   * Deletes a permission.
+   * @param name The name of the permission to delete.
+   */
+  public async deletePermission(name: string): Promise<void> {
+    await this.store.deletePermission(name);
+  }
+
+  /**
+   * Deletes a role.
+   * @param name The name of the role to delete.
+   */
+  public async deleteRole(name: string): Promise<void> {
+    await this.store.deleteRole(name);
+  }
+
+  /**
+   * Retrieves roles assigned to a user.
+   * @param authorizable The user for whom to retrieve roles.
+   * @returns A Promise resolving to a Set of role names.
+   */
+  public async getUserRoles(authorizable: Authorizable): Promise<Set<string>> {
+    return await this.store.getUserRoles(authorizable.id);
+  }
+
+  /**
+   * Retrieves permissions assigned directly to a user.
+   * @param authorizable The user for whom to retrieve permissions.
+   * @returns A Promise resolving to a Set of permission names.
+   */
+  public async getUserPermissions(authorizable: Authorizable): Promise<Set<string>> {
+    return await this.store.getUserPermissions(authorizable.id);
+  }
+
+  /**
+   * Assigns a role to an authorizable entity.
+   * @param authorizable The entity to assign the role to.
+   * @param roleName The name of the role to assign.
+   */
+  public async assignRole(authorizable: Authorizable, roleName: string): Promise<void> {
+    if (!(await this.store.hasRole(roleName))) {
+      throw new Error(`Role '${roleName}' not found.`);
+    }
+    await this.store.addUserRole(authorizable.id, roleName);
+  }
+
+  /**
+   * Assigns a direct permission to an authorizable entity.
+   * @param authorizable The entity to assign the permission to.
+   * @param permissionName The name of the permission to assign.
+   */
+  public async assignPermission(authorizable: Authorizable, permissionName: string): Promise<void> {
+    if (!(await this.store.hasPermission(permissionName))) {
+      throw new Error(`Permission '${permissionName}' not found.`);
+    }
+    await this.store.addUserPermission(authorizable.id, permissionName);
+  }
+
+  /**
+   * Revokes a role from an authorizable entity.
+   * @param authorizable The entity to revoke the role from.
+   * @param roleName The name of the role to revoke.
+   */
+  public async revokeRole(authorizable: Authorizable, roleName: string): Promise<void> {
+    await this.store.removeUserRole(authorizable.id, roleName);
+  }
+
+  /**
+   * Revokes a direct permission from an authorizable entity.
+   * @param authorizable The entity to revoke the permission from.
+   * @param permissionName The name of the permission to revoke.
+   */
+  public async revokePermission(authorizable: Authorizable, permissionName: string): Promise<void> {
+    await this.store.removeUserPermission(authorizable.id, permissionName);
+  }
+
+  /**
+   * Checks if an authorizable entity has a given role.
+   * @param authorizable The entity to check.
+   * @param roleName The name of the role to check for.
+   * @returns True if the entity has the role, false otherwise.
+   */
+  public async hasRole(authorizable: Authorizable, roleName: string): Promise<boolean> {
+    return await this.store.hasUserRole(authorizable.id, roleName);
+  }
+
+  /**
+   * Checks if an authorizable entity has a given permission, either directly or through a role.
+   * @param authorizable The entity to check.
+   * @param permissionName The name of the permission to check for.
+   * @returns True if the entity has the permission, false otherwise.
+   */
+  public async hasPermission(authorizable: Authorizable, permissionName: string): Promise<boolean> {
+    // Check direct permissions from store
+    if (await this.store.hasUserPermission(authorizable.id, permissionName)) {
+      return true;
+    }
+
+    // Check permissions via roles
+    const roles = await this.store.getUserRoles(authorizable.id);
+    if (roles) {
+      for (const roleName of roles) {
+        const role = await this.store.getRole(roleName);
+        // Check if the role has the permission
+        if (role && role.permissions.includes(permissionName)) {
+          return true;
+        }
+      }
+    }
+
+    return false;
+  }
+
+  /**
+   * Checks if a role has a specific permission.
+   * @param roleName The name of the role.
+   * @param permissionName The name of the permission.
+   * @returns True if the role has the permission, false otherwise.
+   */
+  public async roleHasPermission(roleName: string, permissionName: string): Promise<boolean> {
+    const role = await this.store.getRole(roleName);
+    return role ? role.permissions.includes(permissionName) : false;
+  }
+
+  /**
+   * Resets all defined permissions, roles, and assigned user roles/permissions.
+   * Useful for testing.
+   */
+  public async reset(): Promise<void> {
+    await this.store.reset();
+  }
+}