create-or-update-model-and-typeorm-schemas

Create new models and update existing ones with TypeORM to ensure proper database structure and maintainability when adapting to evolving business requirements.

When to Use

• When you need to create a new entity in your hexagonal domain
• When adding new properties to existing models
• When modifying existing property types or relationships
• When business logic requirements change and database schema needs updating

Context Validation Checkpoints

• Have you identified which hexagon package the model belongs to?
• Do you know the TypeORM column types needed for each property?
• Have you considered backward compatibility when adding required fields?
• Is there an existing test factory for similar entities to use as reference?

Recipe Steps

Step 1: Define Business Model

Create the business model in packages//src/domain/entities/.ts and define the corresponding repository interface in packages//src/domain/repositories/IRepository.ts. Export both from the hexagon.

// packages/<hexagon>/src/domain/entities/MyModel.ts
export type MyModel = {
  id: string;
  name: string;
  description?: string;
};

Step 2: Define TypeORM Schema

Create the TypeORM schema in packages//src/infra/schemas/Schema.ts using EntitySchema with proper column definitions, UUID schema, and timestamp schemas from @packmind/node-utils.

import { EntitySchema } from 'typeorm';
import { MyModel } from '../../domain/entities/MyModel';
import { WithTimestamps, uuidSchema, timestampsSchemas } from '@packmind/node-utils';

export const MyModelSchema = new EntitySchema<WithTimestamps<MyModel>>({
  name: 'MyModel',
  tableName: 'mymodels',
  columns: {
    ...uuidSchema,
    name: { type: 'varchar' },
    description: { type: 'text', nullable: true },
    ...timestampsSchemas,
  },
});

Step 3: Make Schema Available to App

Register the new schema in apps/api/src/app/app.module.ts to ensure TypeORM recognizes it during database operations.