test-entity-library-asm 1.1.8 → 1.2.0

package/src/entities/RequestStatus.ts

@@ -0,0 +1,55 @@
+import {
+    BaseEntity,
+    Column,
+    Entity,
+    OneToMany,
+    PrimaryGeneratedColumn
+} from 'typeorm'
+import { Request } from './Request'
+
+@Entity('request_status', {
+  comment:
+    'Acá se podrán agregar los estados que puede tener un pedido, es decir:\r\n\r\n0. Por ordenar (0): Es cuando el usuario agrega los productos al carrito de compras pero aún no realiza la orden.\r\n\r\n1. En espera del cliente (local) cuando el pago ya fue realizado exitosamente (1): Indica que la orden ya fue recibida y está en proceso de verificación.\r\n\r\n2. En espera del usuario (2): Indica que el usuario realizó el pedido y desea cancelarlo en efectivo, en este caso, se genera un código QR/BARCODE donde se puede acercar a la caja del local y pagar el valor del pedido. Cuando el usuario paga se pasa a estado (1), acá el cliente (local/company) puede decir el tiempo de espera máxima para que el cliente se levante a realizar el pago, de lo contrario la orden se cancelará automáticamente.\r\n\r\n3. En proceso (3): Indica que la orden/pedido fue recibid@ y se está preparando.\r\n\r\n4. Listo para servir (4): Indica que la orden ya se preparó y se está a la espera del usuario para entregar.\r\n\r\n5. Entregado/servido (5): Indica que el usuario ya reclamó la orden.\r\n\r\n6. Cancelado (6): Cuando un pedido se marca como "cancelado", significa que la orden ha sido anulada o eliminada del sistema antes de ser procesada o entregada. Esto puede deberse a una solicitud del cliente para cancelar el pedido, a que el pedido no se pueda completar por algún motivo o a una decisión interna del negocio de no procesar el pedido.\r\n\r\n7. Devolución (7): El estado "devolución" se aplica a un pedido que ha sido entregado o completado, pero que por algún motivo el cliente ha devuelto total o parcialmente. Esto podría ser debido a que el producto estaba defectuoso, no era lo que esperaba o por cualquier otra razón por la que el cliente haya solicitado devolver parte o la totalidad del pedido.',
+})
+export class RequestStatus extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @Column({
+    comment:
+      'Los tipos de elemento, esto se hace para validaciones por parte del código:\r\n0, 1, 2, 3, 4, 5, 6, 7....',
+  })
+  code: 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,
+    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({
+    comment:
+      'Quién puede ver y asignar el estado en la orden:\r\n1. Usuario.\r\n2. Cliente (local).\r\n3. Todos.',
+  })
+  visible_to: number
+
+  @Column({
+    default: 1,
+    comment:
+      'Valida si el estado es visible para agregar al pedido:\r\n1. Activo.\r\n0. Inactivo.',
+  })
+  status: number
+
+  @OneToMany(() => Request, (request) => request.status)
+  requests: Request[]
+}

package/src/entities/Role.ts

@@ -9,12 +9,16 @@ import {
 import { Permission } from './Permission'
 import { RoleVisibleTo } from './RoleVisibleTo'
 
-@Entity()
+@Entity({
+  comment: 'Roles que se le pueden agregar a un usuario en la plataforma.',
+})
 export class Role {
-  @PrimaryGeneratedColumn()
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 10 })
+  @Column({ length: 10, comment: 'Código único del rol.' })
   code: string
 
   @Column({
@@ -32,7 +36,11 @@ export class Role {
   })
   description: 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
 
   @ManyToMany(() => Permission)

package/src/entities/RoleVisibleTo.ts

@@ -4,6 +4,7 @@ import {
   PrimaryGeneratedColumn,
   ManyToOne,
   JoinColumn,
+  BaseEntity,
 } from 'typeorm'
 import { Role } from './Role'
 
@@ -11,15 +12,23 @@ import { Role } from './Role'
   comment:
     'Con esta tabla validamos cuales son los roles que puede agregar a otros usuarios qué roles',
 })
-export class RoleVisibleTo {
-  @PrimaryGeneratedColumn()
+export class RoleVisibleTo extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @ManyToOne(() => Role, (role) => role.rolesVisibleTo)
+  @ManyToOne(() => Role, (role) => role.rolesVisibleTo, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'role' })
   role: Role
 
-  @ManyToOne(() => Role, (role) => role.visiblesTo)
+  @ManyToOne(() => Role, (role) => role.visiblesTo, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'visible_to' })
   visible_to: Role
 }

package/src/entities/Square.ts

@@ -0,0 +1,56 @@
+import { BaseEntity, Column, Entity, OneToMany, PrimaryColumn } from 'typeorm'
+import { Local } from './Local'
+
+@Entity({
+  comment:
+    'Centros comerciales registrados/agregados a la plataforma. \n\nDel centro comercial es importante saber si tiene una plazoleta de comida.',
+})
+export class Square extends BaseEntity {
+  @PrimaryColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @Column({ length: 50, comment: 'Nombre del centro comercial/plazoleta.' })
+  name: string
+
+  @Column({ length: 100, comment: 'Dirección del centro comercial/plazoleta.' })
+  address: string
+
+  @Column({
+    type: 'mediumtext',
+    nullable: true,
+    comment:
+      'Campo de tipo JSON por si se llega a necesitar agregar otras columnas para las plazoletas de los centros comerciales.',
+  })
+  details: string
+
+  @Column({
+    comment:
+      'Cantidad máxima de locales para ese del centro comercial/plazoleta.',
+  })
+  maximum_number_locals: number
+
+  @Column({
+    length: 50,
+    nullable: true,
+    comment: 'Correo electrónico del centro comercial/plazoleta.',
+  })
+  email: string
+
+  @Column({
+    length: 15,
+    nullable: true,
+    comment: 'Número de celular del centro comercial/plazoleta.',
+  })
+  phone: string
+
+  @Column({
+    default: 1,
+    comment: 'Si la plazoleta está o no activa:\r\n1. Activa.\r\n0. Inactiva.',
+  })
+  status: number
+
+  @OneToMany(() => Local, (local) => local.square)
+  locals: Local[]
+}

package/src/entities/Terminal.ts

@@ -5,16 +5,32 @@ import {
   ManyToMany,
   JoinTable,
   OneToMany,
+  ManyToOne,
+  JoinColumn,
 } from 'typeorm'
 import { User } from './User'
 import { TerminalSession } from './TerminalSession'
+import { Local } from './Local'
 
-@Entity()
+@Entity({
+  comment:
+    'Tabla creada para asignar terminales a los computadores que estén en un local y así poder recibir pedidos.',
+})
 export class Terminal {
-  @PrimaryGeneratedColumn()
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 50 })
+  @ManyToOne(() => Local, (local) => local.terminals, {
+    nullable: true,
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'local' })
+  local: Local
+
+  @Column({ length: 50, comment: 'Nombre de la terminal.' })
   name: string
 
   @Column({
@@ -25,7 +41,11 @@ export class Terminal {
   })
   settings: 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
 
   @ManyToMany(() => User)

package/src/entities/TerminalSession.ts

@@ -1,32 +1,50 @@
 import {
-  Entity,
+  BaseEntity,
   Column,
-  PrimaryGeneratedColumn,
-  ManyToOne,
+  Entity,
   JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
 } from 'typeorm'
-import { User } from './User'
 import { Terminal } from './Terminal'
+import { User } from './User'
 
-@Entity('terminal_session')
-export class TerminalSession {
-  @PrimaryGeneratedColumn()
+@Entity('terminal_session', {
+  comment:
+    'Tabla creada para llevar el control de los inicios de sesión de los usuarios que tiene permiso de esa terminal.',
+})
+export class TerminalSession extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @ManyToOne(() => User, (user) => user.terminalUsers, { nullable: true })
+  @ManyToOne(() => User, (user) => user.terminalUsers, {
+    nullable: true,
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'user' })
   user: User
 
   @ManyToOne(() => Terminal, (terminal) => terminal.terminalsUser, {
     nullable: true,
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
   })
   @JoinColumn({ name: 'terminal' })
   terminal: Terminal
 
-  @Column({ type: 'datetime' })
+  @Column({
+    type: 'datetime',
+    comment: 'Fecha de inicio de sesión en la terminal.',
+  })
   open: Date
 
-  @Column({ type: 'datetime' })
+  @Column({
+    type: 'datetime',
+    comment: 'Fecha de finalización de la sesión en la terminal.',
+  })
   close: Date
 
   @Column({

package/src/entities/TypeFood.ts

@@ -4,23 +4,44 @@ import {
   PrimaryGeneratedColumn,
   ManyToMany,
   JoinTable,
+  BaseEntity,
 } from 'typeorm'
 import { Company } from './Company'
 
-@Entity('type_food')
-export class TypeFood {
-  @PrimaryGeneratedColumn()
+@Entity('type_food', {
+  comment: 'Tipo de comida que va a tener la plataforma.',
+})
+export class TypeFood extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 40 })
+  @Column({
+    length: 40,
+    comment:
+      'ID de la variable que se encuentra en los archivos `locales` 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
 
   @ManyToMany(() => Company)
   @JoinTable({
     name: 'type_food_company',
+    joinColumn: {
+      name: 'company',
+      referencedColumnName: 'id',
+    },
+    inverseJoinColumn: {
+      name: 'type_food',
+      referencedColumnName: 'id',
+    },
   })
   companies: Company[]
 }

package/src/entities/TypeMeasureIngredient.ts

@@ -0,0 +1,46 @@
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  OneToMany,
+  PrimaryGeneratedColumn,
+} from 'typeorm'
+import { ProductIngredient } from './ProductIngredient'
+
+@Entity('type_measure_ingredient', {
+  comment:
+    'Unidades de medida que el cliente va a poder agregar para medir en los ingredientes que va a tener cada producto.',
+})
+export class TypeMeasureIngredient extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @Column({
+    length: 50,
+    comment:
+      'Nombre que va a tener la medida, este elemento tiene qué ir con el id/key de los lenguajes. Ver la carpeta locales en el proyecto frontend para ver el id que corresponde a la descripción.',
+  })
+  name: string
+
+  @Column({
+    length: 50,
+    comment:
+      'Descripción que va a tener la medida, este elemento tiene qué ir con el id/key de los lenguajes.\r\n\r\nVer la carpeta locales en el proyecto frontend para ver el id que corresponde a la descripción.',
+  })
+  description: string
+
+  @Column({
+    default: 1,
+    comment:
+      'Estado que del item tipo de medida del ingrediente.\r\n1. Activo.\r\n0. Inactivo.',
+  })
+  status: number
+
+  @OneToMany(
+    () => ProductIngredient,
+    (productIngredient) => productIngredient.type_measure_ingredient
+  )
+  type_measure_ingredients: ProductIngredient[]
+}

package/src/entities/User.ts

@@ -1,78 +1,119 @@
 import {
-  Entity,
+  BaseEntity,
   Column,
-  PrimaryGeneratedColumn,
-  ManyToOne,
+  Entity,
   JoinColumn,
-  ManyToMany,
   JoinTable,
+  ManyToMany,
+  ManyToOne,
   OneToMany,
+  PrimaryGeneratedColumn,
 } from 'typeorm'
 import { City } from './City'
-import { Terminal } from './Terminal'
-import { TerminalSession } from './TerminalSession'
-import { Plan } from './Plan'
+import { CodeRedemptionHistoryUser } from './CodeRedemptionHistoryUser'
 import { Company } from './Company'
-import { Local } from './Local'
 import { DiscountCodeCompany } from './DiscountCodeCompany'
 import { DiscountCodeUser } from './DiscountCodeUser'
-import { CodeRedemptionHistoryUser } from './CodeRedemptionHistoryUser'
+import { Local } from './Local'
+import { LocalQualification } from './LocalQualification'
 import { Master } from './Master'
+import { Plan } from './Plan'
+import { Request } from './Request'
+import { RequestProduct } from './RequestProduct'
+import { RequestProductGroupComplement } from './RequestProductGroupComplement'
+import { Terminal } from './Terminal'
+import { TerminalSession } from './TerminalSession'
 
-@Entity()
-export class User {
-  @PrimaryGeneratedColumn()
+@Entity({ comment: 'Usuarios registrados en la plataforma.' })
+export class User extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 30, unique: true })
+  @Column({ length: 30, unique: true, comment: 'Código único del usuario.' })
   code: string
 
-  @Column()
-  document: number
+  @Column({
+    length: 14,
+    unique: true,
+    comment: 'Número de documento del usuario.',
+  })
+  document: string
 
-  @Column({ length: 50 })
+  @Column({ length: 50, comment: 'Nombre del usuario.' })
   name: string
 
-  @Column({ length: 50 })
+  @Column({ length: 50, comment: 'Apellidos del usuario.' })
   surname: string
 
-  @Column({ length: 60, unique: true })
+  @Column({
+    length: 60,
+    unique: true,
+    comment: 'Correo electrónico del usuario.',
+  })
   email: string
 
-  @Column({ length: 12, unique: true })
+  @Column({
+    length: 12,
+    unique: true,
+    comment: 'Número de celular del usuario.',
+  })
   phone: string
 
-  @ManyToOne(() => City, (city) => city.users)
+  @ManyToOne(() => City, (city) => city.users, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'city' })
   city: City
 
-  @Column({ nullable: true, length: 100 })
+  @Column({ nullable: true, length: 100, comment: 'Dirección del usuario.' })
   address: string
 
-  @Column({ type: 'decimal', precision: 10, scale: 8, nullable: true })
+  @Column({
+    type: 'decimal',
+    precision: 10,
+    scale: 8,
+    nullable: true,
+    comment: 'Latitude de la dirección del usuario.',
+  })
   latitude: number
 
-  @Column({ type: 'decimal', precision: 10, scale: 8, nullable: true })
+  @Column({
+    type: 'decimal',
+    precision: 10,
+    scale: 8,
+    nullable: true,
+    comment: 'Longitude de la dirección del usuario.',
+  })
   longitude: number
 
-  @Column({ length: 20 })
+  @Column({
+    length: 20,
+    comment: 'Contraseña almacenada tipo MD5 del usuario.',
+  })
   password: string
 
   @Column({
     type: 'longtext',
     nullable: true,
     comment:
-      'Campo de tipo JSON donde se guarda información necesaria para el usuario',
+      'Campo de tipo JSON donde se guarda información necesaria para el registro.',
   })
   profile: string
 
-  @Column({ type: 'datetime' })
+  @Column({ type: 'datetime', comment: 'Fecha de creación del registro.' })
   created: Date
 
-  @Column({ type: 'datetime' })
+  @Column({ type: 'datetime', comment: 'Fecha de actualización del registro.' })
   updated: Date
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      '¿El usuario tiene acceso a la plataforma?:\r\n1. Activo: El usuario tiene acceso.\r\n0. Inactivo: El usuario no tiene acceso a la plataforma.',
+  })
   status: number
 
   @ManyToMany(() => Terminal)
@@ -119,4 +160,28 @@ export class User {
 
   @OneToMany(() => Master, (master) => master.user)
   masters: Master[]
+
+  @OneToMany(
+    () => LocalQualification,
+    (localQualification) => localQualification.user
+  )
+  qualifications: LocalQualification[]
+
+  @OneToMany(() => Request, (request) => request.user)
+  requests: Request[]
+
+  @ManyToMany(() => Request)
+  @JoinTable({
+    name: 'request_group',
+  })
+  requests_group: Request[]
+
+  @OneToMany(() => RequestProduct, (requestProduct) => requestProduct.user)
+  request_products: RequestProduct[]
+
+  @OneToMany(
+    () => RequestProductGroupComplement,
+    (requestProduct) => requestProduct.user
+  )
+  request_product_group_complements: RequestProductGroupComplement[]
 }

package/src/entities/productGroupComplement.ts

@@ -4,29 +4,45 @@ import {
   PrimaryGeneratedColumn,
   ManyToOne,
   JoinColumn,
+  BaseEntity,
+  OneToMany,
 } from 'typeorm'
 import { ProductGroup } from './ProductGroup'
+import { RequestProductGroupComplement } from './RequestProductGroupComplement'
 
 @Entity('product_group_complement', {
-  comment: 'Los complementos que tiene el grupo de un producto.',
+  comment:
+    'Los complementos que tiene el grupo de un producto (product_group_complement).',
 })
-export class ProductGroupComplement {
-  @PrimaryGeneratedColumn()
+export class ProductGroupComplement extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
   @ManyToOne(
     () => ProductGroup,
-    (productGroup) => productGroup.groups_complement
+    (productGroup) => productGroup.groups_complement,
+    {
+      onDelete: 'CASCADE',
+      onUpdate: 'NO ACTION',
+    }
   )
   @JoinColumn({ name: 'group_id' })
   group_id: ProductGroup
 
-  @Column({ length: 30 })
+  @Column({ length: 30, comment: 'Nombre del complemento.' })
   name: string
 
-  @Column({ length: 20 })
+  @Column({ length: 20, comment: 'Precio del complemento.' })
   price: string
 
-  @Column()
+  @Column({ comment: 'El orden en que aparece los grupos en el producto.' })
   position: number
+
+  @OneToMany(
+    () => RequestProductGroupComplement,
+    (requestProduct) => requestProduct.product_group_complement
+  )
+  request_product_group_complements: RequestProductGroupComplement[]
 }

package/src/entities/ScheduleCategory.ts

@@ -1,32 +0,0 @@
-import {
-  Entity,
-  Column,
-  PrimaryGeneratedColumn,
-  ManyToOne,
-  JoinColumn,
-} from 'typeorm'
-import { Category } from './Category'
-import { Day } from './Day'
-
-@Entity('schedule_category', {
-  comment:
-    'Acá podemos agregar los horarios para las categorías de los productos. O sea, si una categoría sólo está los miércoles, entonces podría agregar el día y los horarios.',
-})
-export class ScheduleCategory {
-  @PrimaryGeneratedColumn()
-  id: number
-
-  @ManyToOne(() => Category, { onDelete: 'CASCADE', onUpdate: 'NO ACTION' })
-  @JoinColumn({ name: 'category' })
-  category: Category
-
-  @ManyToOne(() => Day, { onDelete: 'CASCADE', onUpdate: 'NO ACTION' })
-  @JoinColumn({ name: 'day' })
-  day: Day
-
-  @Column()
-  start_time: string
-
-  @Column()
-  end_time: string
-}