@loomcore/api 0.1.28 → 0.1.30

package/dist/__tests__/common-test.utils.d.ts

@@ -25,7 +25,7 @@ export declare class CategoryService extends GenericApiService<ICategory> {
 export declare class CategoryController extends ApiController<ICategory> {
     constructor(app: Application, database: IDatabase);
 }
-export declare function setupTestConfig(): void;
+export declare function setupTestConfig(isMultiTenant?: boolean): void;
 export declare class ProductService extends GenericApiService<IProduct> {
     private db;
     constructor(database: IDatabase);

package/dist/__tests__/common-test.utils.js

@@ -155,7 +155,7 @@ export class CategoryController extends ApiController {
         super('categories', app, categoryService, 'category', CategorySpec);
     }
 }
-export function setupTestConfig() {
+export function setupTestConfig(isMultiTenant = true) {
     setBaseApiConfig({
         env: 'test',
         hostName: 'localhost',
@@ -173,7 +173,7 @@ export function setupTestConfig() {
         debug: {
             showErrors: false
         },
-        app: { isMultiTenant: true },
+        app: { isMultiTenant: isMultiTenant },
         auth: {
             jwtExpirationInSeconds: 3600,
             refreshTokenExpirationInDays: 7,
@@ -183,7 +183,7 @@ export function setupTestConfig() {
         email: {
             emailApiKey: 'WeDontHaveAKeyYet',
             emailApiSecret: 'WeDontHaveASecretYet',
-            fromAddress: undefined,
+            fromAddress: 'test@test.com',
             systemEmailAddress: 'system@test.com'
         },
         adminUser: {

package/dist/config/base-api-config.js

@@ -23,7 +23,7 @@ export async function initSystemUserContext(database) {
         throw new Error('BaseApiConfig has not been set. Call setBaseApiConfig first.');
     }
     if (!isSystemUserContextSet) {
-        const systemEmail = config.email.systemEmailAddress || 'system@example.com';
+        const systemEmail = config.email?.systemEmailAddress || 'system@example.com';
         let metaOrgId = undefined;
         if (config.app.isMultiTenant) {
             const { OrganizationService } = await import('../services/organization.service.js');

package/dist/databases/postgres/migrations/003-create-users-table.migration.js

@@ -1,5 +1,6 @@
 import { randomUUID } from "crypto";
 import { doesTableExist } from "../utils/does-table-exist.util.js";
+import { config } from "../../../config/index.js";
 export class CreateUsersTableMigration {
     client;
     constructor(client) {
@@ -12,6 +13,9 @@ export class CreateUsersTableMigration {
             await this.client.query('BEGIN');
             const tableExists = await doesTableExist(this.client, 'users');
             if (!tableExists) {
+                const fkConstraint = config.app.isMultiTenant
+                    ? ',\n                            CONSTRAINT "fk_users_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE'
+                    : '';
                 await this.client.query(`
                     CREATE TABLE "users" (
                         "_id" VARCHAR(255) PRIMARY KEY,
@@ -29,8 +33,7 @@ export class CreateUsersTableMigration {
                         "_updatedBy" VARCHAR(255) NOT NULL,
                         "_deleted" TIMESTAMP,
                         "_deletedBy" VARCHAR(255),
-                        CONSTRAINT "fk_users_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE,
-                        CONSTRAINT "uk_users_email" UNIQUE ("_orgId", "email")
+                        CONSTRAINT "uk_users_email" UNIQUE ("_orgId", "email")${fkConstraint}
                     )
                 `);
             }

package/dist/databases/postgres/migrations/004-create-refresh-tokens-table.migration.js

@@ -1,5 +1,6 @@
 import { randomUUID } from "crypto";
 import { doesTableExist } from "../utils/does-table-exist.util.js";
+import { config } from "../../../config/index.js";
 export class CreateRefreshTokenTableMigration {
     client;
     constructor(client) {
@@ -12,6 +13,9 @@ export class CreateRefreshTokenTableMigration {
             await this.client.query('BEGIN');
             const tableExists = await doesTableExist(this.client, 'refreshTokens');
             if (!tableExists) {
+                const fkConstraint = config.app.isMultiTenant
+                    ? ',\n                        CONSTRAINT "fk_refreshTokens_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE'
+                    : '';
                 await this.client.query(`
                     CREATE TABLE "refreshTokens" (
                         "_id" VARCHAR(255) PRIMARY KEY,
@@ -21,7 +25,7 @@ export class CreateRefreshTokenTableMigration {
                         "userId" VARCHAR(255) NOT NULL,
                         "expiresOn" BIGINT NOT NULL,
                         "created" TIMESTAMP NOT NULL,
-                        "createdBy" VARCHAR(255) NOT NULL
+                        "createdBy" VARCHAR(255) NOT NULL${fkConstraint}
                     )
                 `);
             }

package/dist/databases/postgres/migrations/005-create-meta-org.migration.js

@@ -20,6 +20,7 @@ export class CreateMetaOrgMigration {
                 await this.client.query('ROLLBACK');
                 return { success: false, error: new Error(`Error creating meta org: No row returned`) };
             }
+            initializeSystemUserContext(config.email?.systemEmailAddress || 'system@example.com', orgResult.rows[0]._id);
             const migrationResult = await this.client.query(`
                 INSERT INTO "migrations" ("_id", "index", "hasRun", "reverted")
                 VALUES ('${_id}', ${this.index}, TRUE, FALSE);
@@ -28,7 +29,6 @@ export class CreateMetaOrgMigration {
                 await this.client.query('ROLLBACK');
                 return { success: false, error: new Error(`Error inserting migration ${this.index} to migrations table: No row returned`) };
             }
-            initializeSystemUserContext(config.email.systemEmailAddress || 'system@example.com', orgResult.rows[0]._id);
             await this.client.query('COMMIT');
             return { success: true, error: null };
         }

package/dist/databases/postgres/migrations/006-create-admin-user.migration.d.ts

@@ -3,6 +3,7 @@ import { IMigration } from "../index.js";
 export declare class CreateAdminUserMigration implements IMigration {
     private readonly client;
     constructor(client: Client);
+    private authService;
     index: number;
     execute(): Promise<{
         success: boolean;

package/dist/databases/postgres/migrations/006-create-admin-user.migration.js

@@ -7,16 +7,17 @@ export class CreateAdminUserMigration {
     client;
     constructor(client) {
         this.client = client;
+        const database = new PostgresDatabase(this.client);
+        this.authService = new AuthService(database);
     }
+    authService;
     index = 6;
     async execute() {
         const _id = randomUUID().toString();
         const systemUserContext = getSystemUserContext();
         let createdUser;
         try {
-            const database = new PostgresDatabase(this.client);
-            const authService = new AuthService(database);
-            createdUser = await authService.createUser(systemUserContext, {
+            createdUser = await this.authService.createUser(systemUserContext, {
                 _id: _id,
                 _orgId: systemUserContext._orgId,
                 email: config.adminUser?.email,

package/dist/databases/postgres/migrations/007-create-roles-table.migration.js

@@ -1,5 +1,6 @@
 import { randomUUID } from "crypto";
 import { doesTableExist } from "../utils/does-table-exist.util.js";
+import { config } from "../../../config/index.js";
 export class CreateRoleTableMigration {
     client;
     constructor(client) {
@@ -12,13 +13,15 @@ export class CreateRoleTableMigration {
             await this.client.query('BEGIN');
             const tableExists = await doesTableExist(this.client, 'roles');
             if (!tableExists) {
+                const fkConstraint = config.app.isMultiTenant
+                    ? ',\n                            CONSTRAINT "fk_roles_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE'
+                    : '';
                 await this.client.query(`
                     CREATE TABLE "roles" (
                         "_id" VARCHAR(255) PRIMARY KEY,
                         "_orgId" VARCHAR(255),
                         "name" VARCHAR(255) NOT NULL,
-                        CONSTRAINT "fk_roles_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE,
-                        CONSTRAINT "uk_roles_name" UNIQUE ("_orgId", "name")
+                        CONSTRAINT "uk_roles_name" UNIQUE ("_orgId", "name")${fkConstraint}
                     )
                 `);
             }

package/dist/databases/postgres/migrations/008-create-user-roles-table.migration.js

@@ -1,5 +1,6 @@
 import { randomUUID } from "crypto";
 import { doesTableExist } from "../utils/does-table-exist.util.js";
+import { config } from "../../../config/index.js";
 export class CreateUserRolesTableMigration {
     client;
     constructor(client) {
@@ -12,6 +13,9 @@ export class CreateUserRolesTableMigration {
             await this.client.query('BEGIN');
             const tableExists = await doesTableExist(this.client, 'user_roles');
             if (!tableExists) {
+                const fkConstraint = config.app.isMultiTenant
+                    ? '\n                        CONSTRAINT "fk_user_roles_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE,'
+                    : '';
                 await this.client.query(`
                     CREATE TABLE "user_roles" (
                         "_id" VARCHAR(255) PRIMARY KEY,
@@ -24,7 +28,7 @@ export class CreateUserRolesTableMigration {
                         "_updatedBy" VARCHAR(255) NOT NULL,
                         "_deleted" TIMESTAMP,
                         "_deletedBy" VARCHAR(255),
-                        CONSTRAINT "fk_user_roles_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE,
+                        ${fkConstraint}
                         CONSTRAINT "fk_user_roles_user" FOREIGN KEY ("_userId") REFERENCES "users"("_id") ON DELETE CASCADE,
                         CONSTRAINT "fk_user_roles_role" FOREIGN KEY ("_roleId") REFERENCES "roles"("_id") ON DELETE CASCADE,
                         CONSTRAINT "uk_user_roles" UNIQUE ("_orgId", "_userId", "_roleId")

package/dist/databases/postgres/migrations/009-create-features-table.migration.js

@@ -1,5 +1,6 @@
 import { randomUUID } from "crypto";
 import { doesTableExist } from "../utils/does-table-exist.util.js";
+import { config } from "../../../config/index.js";
 export class CreateFeaturesTableMigration {
     client;
     constructor(client) {
@@ -12,13 +13,15 @@ export class CreateFeaturesTableMigration {
             await this.client.query('BEGIN');
             const tableExists = await doesTableExist(this.client, 'features');
             if (!tableExists) {
+                const fkConstraint = config.app.isMultiTenant
+                    ? ',\n                            CONSTRAINT "fk_features_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE'
+                    : '';
                 await this.client.query(`
                     CREATE TABLE "features" (
                         "_id" VARCHAR(255) PRIMARY KEY,
                         "_orgId" VARCHAR(255),
                         "name" VARCHAR(255) NOT NULL,
-                        CONSTRAINT "fk_features_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE,
-                        CONSTRAINT "uk_features" UNIQUE ("_orgId", "name")
+                        CONSTRAINT "uk_features" UNIQUE ("_orgId", "name")${fkConstraint}
                     )
                 `);
             }

package/dist/databases/postgres/migrations/010-create-authorizations-table.migration.js

@@ -1,5 +1,6 @@
 import { randomUUID } from "crypto";
 import { doesTableExist } from "../utils/does-table-exist.util.js";
+import { config } from "../../../config/index.js";
 export class CreateAuthorizationsTableMigration {
     client;
     constructor(client) {
@@ -12,6 +13,9 @@ export class CreateAuthorizationsTableMigration {
             await this.client.query('BEGIN');
             const tableExists = await doesTableExist(this.client, 'authorizations');
             if (!tableExists) {
+                const fkConstraint = config.app.isMultiTenant
+                    ? ',\n                            CONSTRAINT "fk_authorizations_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE'
+                    : '';
                 await this.client.query(`
                     CREATE TABLE "authorizations" (
                         "_id" VARCHAR(255) PRIMARY KEY,
@@ -27,10 +31,9 @@ export class CreateAuthorizationsTableMigration {
                         "_updatedBy" VARCHAR(255) NOT NULL,
                         "_deleted" TIMESTAMP,
                         "_deletedBy" VARCHAR(255),
-                        CONSTRAINT "fk_authorizations_organization" FOREIGN KEY ("_orgId") REFERENCES "organizations"("_id") ON DELETE CASCADE,
                         CONSTRAINT "fk_authorizations_role" FOREIGN KEY ("_roleId") REFERENCES "roles"("_id") ON DELETE CASCADE,
                         CONSTRAINT "fk_authorizations_feature" FOREIGN KEY ("_featureId") REFERENCES "features"("_id") ON DELETE CASCADE,
-                        CONSTRAINT "uk_authorizations" UNIQUE ("_orgId", "_roleId", "_featureId")
+                        CONSTRAINT "uk_authorizations" UNIQUE ("_orgId", "_roleId", "_featureId")${fkConstraint}
                     )
                 `);
             }

package/dist/databases/postgres/migrations/011-create-admin-authorization.migration.js

@@ -17,20 +17,20 @@ export class CreateAdminAuthorizationMigration {
     async execute() {
         const _id = randomUUID().toString();
         try {
-            const metaOrg = await this.organizationService.getMetaOrg(EmptyUserContext);
+            const metaOrg = await this.organizationService.getMetaOrg(EmptyUserContext).catch(() => null);
             if (!config.adminUser?.email) {
                 return { success: false, error: new Error('Create admin authorization: Admin user email not found in config') };
             }
             const adminUser = await this.authService.getUserByEmail(config.adminUser?.email);
-            if (!metaOrg || !adminUser) {
-                return { success: false, error: new Error('Create admin authorization: Meta organization or admin user not found') };
+            if (!adminUser) {
+                return { success: false, error: new Error('Create admin authorization: Admin user not found') };
             }
             await this.client.query('BEGIN');
             const roleId = randomUUID().toString();
             const roleResult = await this.client.query(`
                 INSERT INTO "roles" ("_id", "_orgId", "name")
                 VALUES ($1, $2, 'admin')
-            `, [roleId, metaOrg?._id]);
+            `, [roleId, metaOrg?._id ?? null]);
             if (roleResult.rowCount === 0) {
                 await this.client.query('ROLLBACK');
                 return { success: false, error: new Error('Failed to create admin role') };
@@ -39,7 +39,7 @@ export class CreateAdminAuthorizationMigration {
             const userRoleResult = await this.client.query(`
                 INSERT INTO "user_roles" ("_id", "_orgId", "_userId", "_roleId", "_created", "_createdBy", "_updated", "_updatedBy")
                 VALUES ($1, $2, $3, $4, NOW(), 'system', NOW(), 'system')
-            `, [userRoleId, metaOrg?._id, adminUser?._id, roleId]);
+            `, [userRoleId, metaOrg?._id ?? null, adminUser?._id, roleId]);
             if (userRoleResult.rowCount === 0) {
                 await this.client.query('ROLLBACK');
                 return { success: false, error: new Error('Failed to create user role') };
@@ -48,7 +48,7 @@ export class CreateAdminAuthorizationMigration {
             const featureResult = await this.client.query(`
                 INSERT INTO "features" ("_id", "_orgId", "name")
                 VALUES ($1, $2, 'admin')
-            `, [featureId, metaOrg?._id]);
+            `, [featureId, metaOrg?._id ?? null]);
             if (featureResult.rowCount === 0) {
                 await this.client.query('ROLLBACK');
                 return { success: false, error: new Error('Failed to create admin feature') };
@@ -60,7 +60,7 @@ export class CreateAdminAuthorizationMigration {
                     "_created", "_createdBy", "_updated", "_updatedBy"
                 )
                 VALUES ($1, $2, $3, $4, NOW(), 'system', NOW(), 'system')
-            `, [authorizationId, metaOrg?._id, roleId, featureId]);
+            `, [authorizationId, metaOrg?._id ?? null, roleId, featureId]);
             if (authorizationResult.rowCount === 0) {
                 await this.client.query('ROLLBACK');
                 return { success: false, error: new Error('Failed to create admin authorization') };

package/dist/databases/postgres/migrations/database-builder.d.ts

@@ -0,0 +1,15 @@
+import { Client } from "pg";
+import { IDatabaseBuilder } from "./database-builder.interface.js";
+import { IMigration } from "./migration.interface.js";
+export declare class DatabaseBuilder implements IDatabaseBuilder {
+    private client;
+    private migrationsToRun;
+    constructor(client: Client);
+    withAuth(): IDatabaseBuilder;
+    withMultitenant(): IDatabaseBuilder;
+    withMigrations(migrations: IMigration[]): IDatabaseBuilder;
+    build(): Promise<{
+        success: boolean;
+        error: Error | null;
+    }>;
+}

package/dist/databases/postgres/migrations/database-builder.interface.d.ts

@@ -0,0 +1,10 @@
+import { IMigration } from "./migration.interface.js";
+export interface IDatabaseBuilder {
+    withAuth(): IDatabaseBuilder;
+    withMultitenant(): IDatabaseBuilder;
+    withMigrations(migrations: IMigration[]): IDatabaseBuilder;
+    build(): Promise<{
+        success: boolean;
+        error: Error | null;
+    }>;
+}

package/dist/databases/postgres/migrations/database-builder.interface.js

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

package/dist/databases/postgres/migrations/database-builder.js

@@ -0,0 +1,62 @@
+import { CreateMigrationTableMigration } from "./001-create-migrations-table.migration.js";
+import { CreateUsersTableMigration } from "./003-create-users-table.migration.js";
+import { CreateAdminUserMigration } from "./006-create-admin-user.migration.js";
+import { CreateUserRolesTableMigration } from "./008-create-user-roles-table.migration.js";
+import { CreateAuthorizationsTableMigration } from "./010-create-authorizations-table.migration.js";
+import { CreateFeaturesTableMigration } from "./009-create-features-table.migration.js";
+import { CreateRoleTableMigration } from "./007-create-roles-table.migration.js";
+import { CreateRefreshTokenTableMigration } from "./004-create-refresh-tokens-table.migration.js";
+import { CreateAdminAuthorizationMigration } from "./011-create-admin-authorization.migration.js";
+import { CreateMetaOrgMigration } from "./005-create-meta-org.migration.js";
+import { CreateOrganizationsTableMigration } from "./002-create-organizations-table.migration.js";
+import { doesTableExist } from "../utils/index.js";
+export class DatabaseBuilder {
+    client;
+    migrationsToRun = [];
+    constructor(client) {
+        this.client = client;
+    }
+    withAuth() {
+        this.migrationsToRun.push(new CreateMigrationTableMigration(this.client));
+        this.migrationsToRun.push(new CreateUsersTableMigration(this.client));
+        this.migrationsToRun.push(new CreateRefreshTokenTableMigration(this.client));
+        this.migrationsToRun.push(new CreateAdminUserMigration(this.client));
+        this.migrationsToRun.push(new CreateRoleTableMigration(this.client));
+        this.migrationsToRun.push(new CreateUserRolesTableMigration(this.client));
+        this.migrationsToRun.push(new CreateFeaturesTableMigration(this.client));
+        this.migrationsToRun.push(new CreateAuthorizationsTableMigration(this.client));
+        this.migrationsToRun.push(new CreateAdminAuthorizationMigration(this.client));
+        return this;
+    }
+    withMultitenant() {
+        this.migrationsToRun.push(new CreateMigrationTableMigration(this.client));
+        this.migrationsToRun.push(new CreateOrganizationsTableMigration(this.client));
+        this.migrationsToRun.push(new CreateMetaOrgMigration(this.client));
+        return this;
+    }
+    withMigrations(migrations) {
+        this.migrationsToRun.push(...migrations);
+        return this;
+    }
+    async build() {
+        let runMigrations = [];
+        if (await doesTableExist(this.client, 'migrations')) {
+            const migrations = await this.client.query(`
+                SELECT "_id", "index"
+                FROM migrations
+                WHERE "hasRun" = TRUE AND "reverted" = FALSE
+            `);
+            runMigrations = migrations.rows.map((row) => {
+                return row.index;
+            });
+        }
+        const orderedMigrations = this.migrationsToRun.filter((migration) => !runMigrations.includes(migration.index)).sort((migration) => migration.index);
+        for (const migration of orderedMigrations) {
+            const result = await migration.execute();
+            if (!result.success) {
+                return result;
+            }
+        }
+        return { success: true, error: null };
+    }
+}

package/dist/databases/postgres/migrations/index.d.ts

@@ -1,3 +1,2 @@
 export * from './migration.interface.js';
-export * from './setup-for-multitenant.migration.js';
-export * from './setup-for-auth.migration.js';
+export * from './database-builder.js';

package/dist/databases/postgres/migrations/index.js

@@ -1,3 +1,2 @@
 export * from './migration.interface.js';
-export * from './setup-for-multitenant.migration.js';
-export * from './setup-for-auth.migration.js';
+export * from './database-builder.js';

package/dist/models/base-api-config.interface.d.ts

@@ -30,10 +30,10 @@ export interface IBaseApiConfig {
         deviceIdCookieMaxAgeInDays: number;
         passwordResetTokenExpirationInMinutes: number;
     };
-    email: {
-        emailApiKey?: string;
-        emailApiSecret?: string;
-        fromAddress?: string;
-        systemEmailAddress?: string;
+    email?: {
+        emailApiKey: string;
+        emailApiSecret: string;
+        fromAddress: string;
+        systemEmailAddress: string;
     };
 }

package/dist/services/email.service.js

@@ -5,16 +5,19 @@ export class EmailService {
     mailjet;
     constructor() {
         this.mailjet = new Mailjet.default({
-            apiKey: config.email.emailApiKey || '',
-            apiSecret: config.email.emailApiSecret || ''
+            apiKey: config.email?.emailApiKey || '',
+            apiSecret: config.email?.emailApiSecret || ''
         });
     }
     async sendHtmlEmail(emailAddress, subject, body) {
+        if (!config.email?.fromAddress) {
+            throw new ServerError('From address is not set in the config');
+        }
         const messageData = {
             Messages: [
                 {
                     From: {
-                        Email: config.email.fromAddress,
+                        Email: config.email?.fromAddress,
                         Name: config.appName || 'Application'
                     },
                     To: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loomcore/api",
-  "version": "0.1.28",
+  "version": "0.1.30",
   "private": false,
   "description": "Loom Core Api - An opinionated Node.js api using Typescript, Express, and MongoDb or PostgreSQL",
   "scripts": {