feat(company): introduce CompanyProfile entity for detailed company roles

apps/edr-freight-api/src/modules/companies/dto/create-company.dto.ts

@@ -25,11 +25,6 @@ export class CreateCompanyDto {
   @MaxLength(50)
   vatNumber?: string;
 
-  @IsOptional()
-  @IsString()
-  @MaxLength(100)
-  businessLicense?: string;
-
   @IsOptional()
   @IsString()
   @MaxLength(32)

apps/edr-freight-api/src/modules/companies/dto/response-company.dto.ts

@@ -8,7 +8,6 @@ export class ResponseCompanyDto {
   status: CompanyStatus;
   tin: string;
   vatNumber?: string | null;
-  businessLicense?: string | null;
   fanNumber?: string | null;
   country: string;
   address?: string | null;
@@ -27,7 +26,6 @@ export class ResponseCompanyDto {
     this.status = company.status;
     this.tin = company.tin;
     this.vatNumber = company.vatNumber;
-    this.businessLicense = company.businessLicense;
     this.fanNumber = company.fanNumber;
     this.country = company.country;
     this.address = company.address;

apps/edr-freight-api/src/modules/companies/entities/company-profile.entity.ts

@@ -0,0 +1,62 @@
+import { BaseEntity } from "@edr/api-common";
+import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
+import { Company } from "./company.entity";
+
+export enum ProfileType {
+  importer = "importer",
+  exporter = "exporter",
+  freightForwarder = "freight_forwarder",
+  djFreightForwarder = "dj_freight_forwarder",
+  transporter = "transporter",
+}
+
+export enum ProfileStatus {
+  Active = "active",
+  Pending = "pending",
+  Suspended = "suspended",
+  Blacklisted = "blacklisted",
+}
+
+@Entity({ schema: "freight", name: "company_profiles" })
+@Index(["reference"], { unique: true })
+@Index(["type"])
+@Index(["companyId"])
+export class CompanyProfile extends BaseEntity {
+  @Column({ name: "company_id", type: "uuid" })
+  companyId!: string;
+
+  @ManyToOne(() => Company, (company) => company.companyProfiles)
+  @JoinColumn({ name: "company_id" })
+  company!: Company;
+
+  @Column({ name: "type", type: "varchar", length: 32, enum: ProfileType })
+  type!: ProfileType;
+
+  @Column({
+    name: "reference",
+    type: "varchar",
+    length: 20,
+    nullable: false,
+    unique: true,
+  })
+  reference!: string;
+
+  @Column({
+    name: "status",
+    type: "varchar",
+    length: 32,
+    default: ProfileStatus.Active,
+  })
+  status!: ProfileStatus;
+
+  @Column({
+    name: "business_license",
+    type: "varchar",
+    length: 100,
+    nullable: true,
+  })
+  businessLicense?: string | null;
+
+  @Column({ name: "attributes", type: "jsonb", nullable: true })
+  attributes?: Record<string, any> | null;
+}

apps/edr-freight-api/src/modules/companies/entities/company.entity.ts

@@ -1,79 +1,110 @@
-import { BaseEntity } from '@edr/api-common';
-import { Column, Entity, Index, OneToMany } from 'typeorm';
-import { ExternalProfile } from './external-profile.entity';
+import { BaseEntity } from "@edr/api-common";
+import { Column, Entity, Index, OneToMany } from "typeorm";
+import { ExternalProfile } from "./external-profile.entity";
+import { CompanyProfile } from "./company-profile.entity";
 
 export enum CompanyType {
-  Customer = 'customer',
-  Forwarder = 'forwarder',
-  Transporter = 'transporter',
-  Broker = 'broker',
+  Customer = "customer",
+  FreightForwarder = "freight_forwarder",
+  DJFreightForwarder = "dj_freight_forwarder",
+  Transporter = "transporter",
 }
 
 export enum CompanyStatus {
-  Active = 'active',
-  Pending = 'pending',
-  Suspended = 'suspended',
-  Blacklisted = 'blacklisted',
+  Active = "active",
+  Pending = "pending",
+  Suspended = "suspended",
+  Blacklisted = "blacklisted",
 }
 
-@Entity({ schema: 'freight', name: 'companies' })
-@Index(['tin'])
-@Index(['type'])
+@Entity({ schema: "freight", name: "companies" })
+@Index(["tin"])
+@Index(["type"])
 export class Company extends BaseEntity {
-  @Column({ name: 'name', type: 'varchar', length: 200 })
+  @Column({ name: "name", type: "varchar", length: 200 })
   name!: string;
 
-  @Column({ name: 'type', type: 'varchar', length: 32, enum: CompanyType })
+  @Column({ name: "type", type: "varchar", length: 32, enum: CompanyType })
   type!: CompanyType;
 
-  @Column({ name: 'status', type: 'varchar', length: 32, default: CompanyStatus.Pending })
+  @Column({
+    name: "status",
+    type: "varchar",
+    length: 32,
+    default: CompanyStatus.Pending,
+  })
   status!: CompanyStatus;
 
-  @Column({ name: 'tin', type: 'varchar', length: 10, unique: true })
+  @Column({ name: "tin", type: "varchar", length: 10, unique: true })
   tin!: string;
 
-  @Column({ name: 'vat_number', type: 'varchar', length: 50, nullable: true })
+  @Column({ name: "vat_number", type: "varchar", length: 50, nullable: true })
   vatNumber?: string | null;
 
-  @Column({ name: 'business_license', type: 'varchar', length: 100, nullable: true })
-  businessLicense?: string | null;
-
-  @Column({ name: 'fan_number', type: 'varchar', length: 16, nullable: true })
+  @Column({ name: "fan_number", type: "varchar", length: 16, nullable: true })
   fanNumber?: string | null;
 
-  @Column({ name: 'country', type: 'varchar', length: 32, default: 'Ethiopia' })
+  @Column({ name: "country", type: "varchar", length: 32, default: "Ethiopia" })
   country!: string;
 
-  @Column({ name: 'address', type: 'text', nullable: true })
+  @Column({ name: "address", type: "text", nullable: true })
   address?: string | null;
 
-  @Column({ name: 'phone', type: 'varchar', length: 20, nullable: true })
+  @Column({ name: "phone", type: "varchar", length: 20, nullable: true })
   phone?: string | null;
 
-  @Column({ name: 'email', type: 'varchar', length: 150, nullable: true })
+  @Column({ name: "email", type: "varchar", length: 150, nullable: true })
   email?: string | null;
 
-  @Column({ name: 'contact_person_name', type: 'varchar', length: 100, nullable: true })
+  @Column({
+    name: "contact_person_name",
+    type: "varchar",
+    length: 100,
+    nullable: true,
+  })
   contactPersonName?: string | null;
 
-  @Column({ name: 'contact_person_phone', type: 'varchar', length: 20, nullable: true })
+  @Column({
+    name: "contact_person_phone",
+    type: "varchar",
+    length: 20,
+    nullable: true,
+  })
   contactPersonPhone?: string | null;
 
-  @Column({ name: 'general_manager_name', type: 'varchar', length: 100, nullable: true })
+  @Column({
+    name: "general_manager_name",
+    type: "varchar",
+    length: 100,
+    nullable: true,
+  })
   generalManagerName?: string | null;
 
-  @Column({ name: 'general_manager_email', type: 'varchar', length: 150, nullable: true })
+  @Column({
+    name: "general_manager_email",
+    type: "varchar",
+    length: 150,
+    nullable: true,
+  })
   generalManagerEmail?: string | null;
 
-  @Column({ name: 'general_manager_phone', type: 'varchar', length: 20, nullable: true })
+  @Column({
+    name: "general_manager_phone",
+    type: "varchar",
+    length: 20,
+    nullable: true,
+  })
   generalManagerPhone?: string | null;
 
-  @Column({ name: 'website', type: 'varchar', length: 200, nullable: true })
+  @Column({ name: "website", type: "varchar", length: 200, nullable: true })
   website?: string | null;
 
-  @Column({ name: 'attributes', type: 'jsonb', nullable: true })
+  @Column({ name: "attributes", type: "jsonb", nullable: true })
   attributes?: Record<string, any> | null;
 
   @OneToMany(() => ExternalProfile, (profile) => profile.company)
   profiles?: ExternalProfile[];
+
+  @OneToMany(() => CompanyProfile, (profile) => profile.company)
+  companyProfiles?: CompanyProfile[];
 }