test-entity-library-asm 1.1.8 → 1.2.0

package/src/entities/Company.ts

@@ -7,6 +7,7 @@ import {
   ManyToMany,
   JoinTable,
   OneToMany,
+  BaseEntity,
 } from 'typeorm'
 import { City } from './City'
 import { User } from './User'
@@ -17,19 +18,30 @@ import { CodeRedemptionHistoryCompany } from './CodeRedemptionHistoryCompany'
 import { DiscountCodeUser } from './DiscountCodeUser'
 import { ProductTopping } from './ProductTopping'
 
-@Entity()
-export class Company {
-  @PrimaryGeneratedColumn()
+@Entity({
+  comment:
+    'Tabla creada para las empresas de comida rápida que deseen registrarse en la plataforma.',
+})
+export class Company extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada empresa.',
+  })
   id: number
 
-  @Column({ length: 50 })
+  @Column({ length: 50, comment: 'Nombre de la empresa.' })
   name: string
 
-  @ManyToOne(() => City, (city) => city.companies)
+  @ManyToOne(() => City, (city) => city.companies, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'city' })
   city: City
 
-  @ManyToOne(() => User, (city) => city.companies)
+  @ManyToOne(() => User, (city) => city.companies, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'user' })
   user: User
 
@@ -37,21 +49,29 @@ export class Company {
     type: 'longtext',
     nullable: true,
     comment:
-      'Campo de tipo JSON donde se guarda información necesaria para la empresa',
+      'Campo de tipo JSON donde se guarda información necesaria para la empresa.',
   })
   profile: string
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Cantidad de locales qué la empresa de comida rápida puede tener por defecto, por defecto es un solo local.',
+  })
   quantity_locals: number
 
-  @Column({ default: 6 })
+  @Column({
+    default: 6,
+    comment:
+      'La cantidad de usuarios que puede asociar a la empresa, es decir, si la empresa desea agregar cajeros, administradores para cada punto lo puede hacer. Por defecto, la cantidad de usuarios que puede tener la empresa es de 6.',
+  })
   quantity_users: number
 
   @Column({
     type: 'longtext',
     nullable: true,
     comment:
-      'Información de tipo JSON donde se guarda la información legal de la empresa',
+      'Información de tipo JSON donde se guarda la información legal de la empresa.',
   })
   legal_information: string
 
@@ -59,37 +79,43 @@ export class Company {
     type: 'longtext',
     nullable: true,
     comment:
-      'Información de tipo JSON donde se guarda la información del representante legal del representante',
+      'Información de tipo JSON donde se guarda la información del representante legal del representante.',
   })
   legal_agent: string
 
-  @ManyToOne(() => Plan, (plan) => plan.companies)
+  @ManyToOne(() => Plan, (plan) => plan.companies, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'RESTRICT',
+  })
   @JoinColumn({ name: 'plan' })
   plan: Plan
 
-  @Column({ type: 'datetime' })
+  @Column({ type: 'datetime', comment: 'Fecha creación de la empresa.' })
   created: Date
 
-  @Column({ type: 'date', nullable: true })
+  @Column({
+    type: 'date',
+    nullable: true,
+    comment: 'Cuándo expira el plan de la empresa.',
+  })
   expiration: Date
 
-  @Column({ type: 'datetime' })
+  @Column({
+    type: 'datetime',
+    comment: 'Fecha de actualización de la empresa.',
+  })
   updated: Date
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Estado de la empresa, es decir:\r\n1. Activo: Es visible en la plataforma.\r\n0. Inactivo: No será visible en la plataforma.',
+  })
   status: number
 
-  @ManyToMany(() => TypeFood)
+  @ManyToMany(() => TypeFood, { onDelete: 'CASCADE', onUpdate: 'NO ACTION' })
   @JoinTable({
     name: 'type_food_company',
-    joinColumn: {
-      name: 'company',
-      referencedColumnName: 'id',
-    },
-    inverseJoinColumn: {
-      name: 'type_food',
-      referencedColumnName: 'id',
-    },
   })
   types_food: TypeFood[]
 

package/src/entities/Configuration.ts

@@ -1,8 +1,14 @@
-import { Entity, Column, PrimaryColumn } from 'typeorm'
+import { Entity, Column, PrimaryColumn, BaseEntity } from 'typeorm'
 
-@Entity()
-export class Configuration {
-  @PrimaryColumn({ length: 20 })
+@Entity({
+  comment:
+    'Esta tabla tiene como fin agregar toda la información de la empresa, logos, urls de documentación, nombres, urls de las páginas... \n\n Esto se se guarda como un string de tipo JSON para que sea fácil almacenarlo y generar nuevos campos si es necesario.',
+})
+export class Configuration extends BaseEntity {
+  @PrimaryColumn({
+    length: 20,
+    comment: 'Nombre del perfil que se está usando en la aplicación.',
+  })
   profile: string
 
   @Column({

package/src/entities/Country.ts

@@ -1,42 +1,54 @@
-import { Entity, Column, PrimaryGeneratedColumn, OneToMany } from 'typeorm'
+import {
+  Entity,
+  Column,
+  PrimaryGeneratedColumn,
+  OneToMany,
+  BaseEntity,
+} from 'typeorm'
 import { Region } from './Region'
 
-@Entity()
-export class Country {
-  @PrimaryGeneratedColumn()
+@Entity({ comment: 'Países donde está disponible la plataforma.' })
+export class Country extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 10 })
+  @Column({ length: 10, comment: 'Código del país.' })
   code: string
 
-  @Column({ length: 50 })
+  @Column({ length: 50, comment: 'Nombre del país.' })
   name: string
 
   @Column({
     length: 10,
     comment:
-      'Usamos esta columna para saber la moneda del país y sugerírsela al usuario o al local',
+      'Usamos esta columna para saber la moneda del país y sugerírsela al usuario o al local.',
   })
   currency: string
 
-  @Column({ length: 10 })
+  @Column({ length: 10, comment: 'Prefijo para los números de teléfono.' })
   prefix: string
 
   @Column({
     type: 'longtext',
     comment:
-      'Esta columna de tipo JSON nos sirve para agregar toda la información que se necesita a nivel de información legal de la empresa que se registre, ya que para cada país cambia la información',
+      'Esta columna de tipo JSON nos sirve para agregar toda la información que se necesita a nivel de información legal de la empresa que se registre, ya que para cada país cambia la información.',
   })
   legal_information: string
 
   @Column({
     type: 'longtext',
     comment:
-      'Columna de tipo JSON para almacenar la información que se necesita para la información del representante legal de la empresa',
+      'Columna de tipo JSON para almacenar la información que se necesita para la información del representante legal de la empresa.',
   })
   legal_agent: string
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Estado del registro, es decir:\r\n1. Activo: Es visible en la plataforma.\r\n0. Inactivo: No será visible en la plataforma.',
+  })
   status: number
 
   @OneToMany(() => Region, (region) => region.country)

package/src/entities/Day.ts

@@ -1,13 +1,23 @@
-import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm'
+import { Entity, Column, PrimaryGeneratedColumn, BaseEntity } from 'typeorm'
 
-@Entity()
-export class Day {
-  @PrimaryGeneratedColumn()
+@Entity({ comment: 'Días de la semana.' })
+export class Day extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 50 })
+  @Column({
+    length: 50,
+    comment:
+      'Nombre del día.\r\n\r\nID/KEY de la variable que se encuentra en los archivos "locale" para el multilenguaje.',
+  })
   name: string
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Estado del registro, es decir:\r\n1. Activo: Es visible en la plataforma.\r\n0. Inactivo: No será visible en la plataforma.',
+  })
   status: number
 }

package/src/entities/DiscountCodeCompany.ts

@@ -5,19 +5,27 @@ import {
   ManyToOne,
   JoinColumn,
   OneToMany,
+  BaseEntity,
 } from 'typeorm'
 import { User } from './User'
 import { CodeRedemptionHistoryCompany } from './CodeRedemptionHistoryCompany'
 
-@Entity('discount_code_company')
-export class DiscountCodeCompany {
-  @PrimaryGeneratedColumn()
+@Entity('discount_code_company', {
+  comment: 'Códigos de descuento para las empresas.',
+})
+export class DiscountCodeCompany extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 10 })
+  @Column({
+    length: 10,
+    comment: 'Código de descuento para las empresas (company).',
+  })
   code: string
 
-  @Column({ length: 10 })
+  @Column({ length: 10, comment: 'Descuento que se aplica.' })
   discount: string
 
   @Column({
@@ -30,23 +38,30 @@ export class DiscountCodeCompany {
   @Column({
     default: 1,
     comment:
-      'Con esto validamos si la empresa puede usar el código una vez o varias veces:\r\n1. Una sola vez.\r\n0. Más de una vez.\r\n\r\nCon esto validamos sí tenemos qué ir a buscar a la tabla code_redemption_history_company',
+      'Con esto validamos si la empresa puede usar el código una vez o varias veces:\r\n1. Una sola vez.\r\n0. Más de una vez.\r\n\r\nCon esto validamos sí tenemos qué ir a buscar a la tabla code_redemption_history_company.',
   })
   single_use: number
 
-  @Column({ type: 'datetime' })
+  @Column({ type: 'datetime', comment: 'Fecha de creación del registro.' })
   created: Date
 
-  @Column({ type: 'date' })
+  @Column({ type: 'date', comment: 'Fecha de expiración del registro.' })
   expiration: Date
 
-  @Column({ type: 'datetime' })
+  @Column({ type: 'datetime', comment: 'Fecha de expiración del registro.' })
   updated: Date
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Estado del registro, es decir: \n 1. Activo: Es visible en la plataforma. \n 0. Inactivo: No será visible en la plataforma.',
+  })
   status: number
 
-  @ManyToOne(() => User, (user) => user.discount_code_companies)
+  @ManyToOne(() => User, (user) => user.discount_code_companies, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'update_by' })
   updated_by: User
 

package/src/entities/DiscountCodeUser.ts

@@ -10,19 +10,26 @@ import { User } from './User'
 import { Company } from './Company'
 import { CodeRedemptionHistoryUser } from './CodeRedemptionHistoryUser'
 
-@Entity('discount_code_user')
+@Entity('discount_code_user', {
+  comment: 'Códigos de descuento para los usuarios.',
+})
 export class DiscountCodeUser {
-  @PrimaryGeneratedColumn()
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @ManyToOne(() => Company, (company) => company.discount_code_users)
+  @ManyToOne(() => Company, (company) => company.discount_code_users, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'company' })
   company: Company
 
-  @Column({ length: 10 })
+  @Column({ length: 10, comment: 'Código del descuento para compartirlo.' })
   code: string
 
-  @Column({ length: 10 })
+  @Column({ length: 10, comment: 'Descuento que se aplica.' })
   discount: string
 
   @Column({
@@ -38,26 +45,32 @@ export class DiscountCodeUser {
   })
   single_use: number
 
-  @Column({ type: 'datetime' })
+  @Column({ type: 'datetime', comment: 'Fecha de creación del registro.' })
   created: Date
 
-  @Column({ type: 'date' })
+  @Column({ type: 'date', comment: 'Fecha de expiración del registro.' })
   expiration: Date
 
-  @ManyToOne(() => User, (user) => user.discount_code_users)
+  @ManyToOne(() => User, (user) => user.discount_code_users, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'updated_by' })
   updated_by: User
 
-  @Column({ type: 'datetime' })
+  @Column({ type: 'datetime', comment: 'Fecha de actualización.' })
   updated: Date
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Estado del registro, es decir: \n 1. Activo: Es visible en la plataforma. \n 0. Inactivo: No será visible en la plataforma.',
+  })
   status: number
 
   @OneToMany(
     () => CodeRedemptionHistoryUser,
-    (codeRedemptionHistoryUser) =>
-      codeRedemptionHistoryUser.discount_code_user
+    (codeRedemptionHistoryUser) => codeRedemptionHistoryUser.discount_code_user
   )
   code_redemptions_history_users: CodeRedemptionHistoryUser[]
 }

package/src/entities/Local.ts

@@ -7,25 +7,40 @@ import {
   ManyToMany,
   JoinTable,
   OneToMany,
+  BaseEntity,
 } from 'typeorm'
 import { Company } from './Company'
 import { City } from './City'
 import { User } from './User'
 import { Product } from './Product'
+import { Category } from './Category'
+import { Square } from './Square'
+import { PaymentMethod } from './PaymentMethod'
+import { LocalQualification } from './LocalQualification'
+import { Request } from './Request'
+import { Terminal } from './Terminal'
 
-@Entity()
-export class Local {
-  @PrimaryGeneratedColumn()
+@Entity({ comment: 'Locales disponibles de las empresas (company).' })
+export class Local extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @ManyToOne(() => Company, (company) => company.locals)
+  @ManyToOne(() => Company, (company) => company.locals, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'company' })
   company: Company
 
   @Column({ length: 100 })
   name: string
 
-  @ManyToOne(() => City, (city) => city.locals)
+  @ManyToOne(() => City, (city) => city.locals, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'city' })
   city: City
 
@@ -52,19 +67,25 @@ export class Local {
   @Column({ type: 'datetime' })
   updated: Date
 
-  @ManyToOne(() => User, (user) => user.locals)
+  @ManyToOne(() => User, (user) => user.locals, {
+    onDelete: 'NO ACTION',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'update_by' })
   updated_by: User
 
+  @ManyToOne(() => Square, (square) => square.locals, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'square' })
+  square: Square
+
   @Column({
-    type: 'int',
-    default: 0,
+    default: 1,
     comment:
-      'Me indica si el local está en una plazoleta o no:\r\n1. Plazoleta.\r\n0. No plazoleta.',
+      'Estado del registro, es decir:\r\n1. Activo: Es visible en la plataforma.\r\n0. Inactivo: No será visible en la plataforma.',
   })
-  square: number
-
-  @Column({ default: 1 })
   status: number
 
   @ManyToMany(() => User)
@@ -83,4 +104,25 @@ export class Local {
 
   @OneToMany(() => Product, (product) => product.local)
   products: Product[]
+
+  @OneToMany(() => Category, (category) => category.local)
+  categories: Category[]
+
+  @ManyToMany(() => PaymentMethod)
+  @JoinTable({
+    name: 'local_payment_method',
+  })
+  payment_methods: PaymentMethod[]
+
+  @OneToMany(
+    () => LocalQualification,
+    (localQualification) => localQualification.local
+  )
+  qualifications: LocalQualification[]
+
+  @OneToMany(() => Request, (request) => request.local)
+  requests: Request[]
+
+  @OneToMany(() => Terminal, (terminal) => terminal.local)
+  terminals: Terminal[]
 }

package/src/entities/LocalQualification.ts

@@ -0,0 +1,45 @@
+import {
+  Entity,
+  Column,
+  PrimaryColumn,
+  ManyToOne,
+  JoinColumn,
+  BaseEntity,
+} from 'typeorm'
+import { User } from './User'
+import { Local } from './Local'
+
+@Entity('local_qualification', {
+  comment:
+    'Valoración que los usuarios le dan a los locales cada vez qué realicen una orden, no es obligatorio.\r\n\r\nTodos los locales cuando se crean y no tienen reseñas quedarán con puntaje de 5.',
+})
+export class LocalQualification extends BaseEntity {
+  @PrimaryColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @Column({
+    comment:
+      'Calificación que tiene el local.\r\n1. Mínimo: Mal servicio.\r\n5. Máximo: Excelente servicio\r\n\r\nLa calificación se evalúa haciéndole 3 o 4 preguntas al usuario:\r\n1. Qué tal fue el servicio a la hora de realizar el pedido.\r\n......',
+  })
+  qualification: number
+
+  @ManyToOne(() => Local, (local) => local.qualifications, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'local' })
+  local: Local
+
+  @ManyToOne(() => User, (user) => user.qualifications, {
+    nullable: true,
+    onDelete: 'SET NULL',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'user' })
+  user: User
+
+  @Column({ type: 'datetime', comment: 'Fecha de creación del registro.' })
+  created: string
+}

package/src/entities/Master.ts

@@ -1,15 +1,28 @@
-import { Entity, Column, PrimaryColumn, ManyToOne, JoinColumn } from 'typeorm'
+import {
+  Entity,
+  Column,
+  PrimaryColumn,
+  ManyToOne,
+  JoinColumn,
+  BaseEntity,
+} from 'typeorm'
 import { User } from './User'
 
 @Entity()
-export class Master {
-  @PrimaryColumn()
+export class Master extends BaseEntity {
+  @PrimaryColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
   @ManyToOne(() => User, (user) => user.masters)
   @JoinColumn({ name: 'user' })
   user: User
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Estado del registro, es decir:\r\n1. Activo: Es visible en la plataforma.\r\n0. Inactivo: No será visible en la plataforma.',
+  })
   status: number
 }

package/src/entities/PaymentMethod.ts

@@ -0,0 +1,72 @@
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  JoinTable,
+  ManyToMany,
+  OneToMany,
+  PrimaryColumn,
+} from 'typeorm'
+import { Local } from './Local'
+import { Request } from './Request'
+
+@Entity('payment_method', {
+  comment:
+    'Métodos de pago qué la plataforma tendrá disponible, estos serán visibles cuando un cliente (local) desee agregarlos para que se vean en los pedidos.',
+})
+export class PaymentMethod extends BaseEntity {
+  @PrimaryColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @Column({
+    length: 50,
+    comment:
+      'Nombre del estado, este campo debe tener el id/key de cada lenguaje. \r\n\r\nVer la carpeta locales del proyecto frontend para ver el id de cada tipo de elemento.',
+  })
+  name: string
+
+  @Column({
+    length: 50,
+    nullable: true,
+    comment:
+      'Descripción del estado, este campo debe tener el id/key de cada lenguaje. \r\n\r\nVer la carpeta locales del proyecto frontend para ver el id de cada tipo de elemento.',
+  })
+  description: string
+
+  @Column({
+    type: 'longtext',
+    nullable: true,
+    comment:
+      'Campo de tipo JSON donde se pueden agregar columnas u otros elementos que sean necesarios.',
+  })
+  settings: string
+
+  @Column({ type: 'datetime', comment: 'Fecha de creación del registro.' })
+  created: Date
+
+  @Column({
+    default: 1,
+    comment:
+      'Valida si el estado es visible para mostrar al cliente (local/company): \r\n1. Activo. \r\n0. Inactivo.',
+  })
+  status: number
+
+  @ManyToMany(() => Local)
+  @JoinTable({
+    name: 'local_payment_method',
+    joinColumn: {
+      name: 'local',
+      referencedColumnName: 'id',
+    },
+    inverseJoinColumn: {
+      name: 'payment_method',
+      referencedColumnName: 'id',
+    },
+  })
+  locals: Local[]
+
+  @OneToMany(() => Request, (request) => request.payment_method)
+  requests: Request[]
+}