test-entity-library-asm 1.1.8 → 1.2.0

package/src/entities/Permission.ts

@@ -4,32 +4,41 @@ import {
   PrimaryGeneratedColumn,
   ManyToMany,
   JoinTable,
+  BaseEntity,
 } from 'typeorm'
 import { Role } from './Role'
 
-@Entity()
-export class Permission {
-  @PrimaryGeneratedColumn()
+@Entity('permission', {
+  comment: 'Permisos que va a tener cada rol.',
+})
+export class Permission extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 10, unique: true })
+  @Column({ length: 10, unique: true, comment: 'Código del permiso.' })
   code: string
 
   @Column({
     length: 40,
     comment:
-      'Id de la variable que se encuentra en los archivos "locale" para el multilenguaje.',
+      'Id de la variable que se encuentra en los archivos `locale` para el multilenguaje.',
   })
   name: string
 
   @Column({
     length: 40,
     comment:
-      'Id de la variable que se encuentra en los archivos "locale" para el multilenguaje.',
+      'Id de la variable que se encuentra en los archivos `locale` para el multilenguaje.',
   })
   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(() => Role)

package/src/entities/Plan.ts

@@ -5,22 +5,27 @@ import {
   ManyToOne,
   JoinColumn,
   OneToMany,
+  BaseEntity,
 } from 'typeorm'
 import { User } from './User'
 import { Company } from './Company'
 
-@Entity()
-export class Plan {
-  @PrimaryGeneratedColumn()
+@Entity({
+  comment: 'Planes que tendrá la plataforma para las empresas (company)',
+})
+export class Plan extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 20, unique: true })
+  @Column({ length: 20, unique: true, comment: 'Código del plan.' })
   code: string
 
   @Column({
     length: 50,
     comment:
-      'Id de la variable que se encuentra en los archivos "locale" para el multilenguaje.',
+      'Id de la variable que se encuentra en los archivos `locale` para el multilenguaje.',
   })
   name: string
 
@@ -39,17 +44,25 @@ export class Plan {
   })
   customized: 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.plans, { nullable: true })
+  @ManyToOne(() => User, (user) => user.plans, {
+    nullable: true,
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'created_by' })
   created_by: 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
 
   @OneToMany(() => Company, (company) => company.plan)

package/src/entities/Product.ts

@@ -5,26 +5,48 @@ import {
   ManyToOne,
   JoinColumn,
   OneToMany,
+  BaseEntity,
 } from 'typeorm'
 import { Local } from './Local'
 import { ProductGroup } from './ProductGroup'
+import { Category } from './Category'
+import { ProductIngredient } from './ProductIngredient'
+import { RequestProduct } from './RequestProduct'
 
-@Entity()
-export class Product {
-  @PrimaryGeneratedColumn()
+@Entity({
+  comment:
+    'Productos qué serán visibles a los usuarios, estos están asociados a un local.',
+})
+export class Product extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @ManyToOne(() => Local, (local) => local.products)
+  @ManyToOne(() => Local, (local) => local.products, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'local' })
   local: Local
 
-  @Column({ length: 50 })
+  @ManyToOne(() => Category, (category) => category.products, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'category' })
+  category: Category
+
+  @Column({ length: 50, comment: 'Nombre del producto.' })
   name: string
 
-  @Column({ length: 400 })
+  @Column({
+    length: 400,
+    comment: 'Detalles del producto. \n\n ¿Qué contiene?',
+  })
   details: string
 
-  @Column({ length: 20 })
+  @Column({ length: 20, comment: 'Precio del producto.' })
   price: string
 
   @Column({
@@ -40,7 +62,7 @@ export class Product {
   })
   combo: number
 
-  @Column()
+  @Column({ comment: 'En qué posición se va a mostrar el producto.' })
   position: number
 
   @Column({
@@ -50,15 +72,29 @@ export class Product {
   })
   photo: string
 
-  @Column({ type: 'mediumtext', nullable: true })
+  @Column({
+    type: 'mediumtext',
+    nullable: true,
+    comment:
+      'Campo de tipo JSON donde se guarda información necesaria para el registro.',
+  })
   additional_information: 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
 
   @OneToMany(() => ProductGroup, (productGroup) => productGroup.product)
   product_groups: ProductGroup[]
+
+  @OneToMany(
+    () => ProductIngredient,
+    (productIngredient) => productIngredient.product
+  )
+  product_ingredients: ProductIngredient[]
+
+  @OneToMany(() => RequestProduct, (requestProduct) => requestProduct.product)
+  request_products: RequestProduct[]
 }

package/src/entities/ProductGroup.ts

@@ -11,37 +11,47 @@ import { ProductTopping } from './ProductTopping'
 import { ProductGroupComplement } from './productGroupComplement'
 
 @Entity('product_group', {
-  comment: 'Grupos para agregar al topping por producto',
+  comment:
+    'Grupos para agregar al topping por producto.\r\n\r\nEstos elementos que se agreguen acá estarán visibles para los usuarios en la APP.',
 })
 export class ProductGroup {
-  @PrimaryGeneratedColumn()
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @ManyToOne(() => Product, (product) => product.product_groups)
+  @ManyToOne(() => Product, (product) => product.product_groups, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'product' })
   product: Product
 
   @ManyToOne(
     () => ProductTopping,
-    (productTopping) => productTopping.product_groups
+    (productTopping) => productTopping.product_groups,
+    {
+      onDelete: 'CASCADE',
+      onUpdate: 'NO ACTION',
+    }
   )
   @JoinColumn({ name: 'topping' })
   topping: ProductTopping
 
-  @Column({ length: 30 })
+  @Column({ length: 30, comment: 'Nombre del grupo.' })
   name: string
 
   @Column({
     default: 1,
     comment:
-      'El "type" se refiere a si el grupo es opcional o si es requerido:\r\n1. Opcional.\r\n2. Requerido.',
+      'El `type` se refiere a si el grupo es opcional o si es requerido:\r\n1. Opcional.\r\n2. Requerido.',
   })
   type: number
 
   @Column({
     default: 0,
     comment:
-      'Cantidad mínima que el usuario puede agregar para el grupo.\r\n\r\n- Cuando "type" es "Requerido (2)" entonces la cantidad mínima debería ser 1.\r\n\r\n- Cuando "type" es "Opcional (1)" entonces la cantidad puede ser 0.',
+      'Cantidad mínima que el usuario puede agregar para el grupo.\r\n\r\n- Cuando `type` es `Requerido (2)` entonces la cantidad mínima debería ser 1.\r\n\r\n- Cuando `type` es `Opcional (1)` entonces la cantidad puede ser 0.',
   })
   minimum_quantity: number
 
@@ -51,7 +61,7 @@ export class ProductGroup {
   })
   maximum_quantity: number
 
-  @Column()
+  @Column({ comment: 'El orden en que aparece los grupos en el producto.' })
   position: number
 
   @OneToMany(

package/src/entities/ProductIngredient.ts

@@ -0,0 +1,55 @@
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+} from 'typeorm'
+import { Product } from './Product'
+import { TypeMeasureIngredient } from './TypeMeasureIngredient'
+
+@Entity('product_ingredient', {
+  comment:
+    'Ingredientes que tendrá un producto específico. Esto se hace para guardar la información del inventario que se tiene y el que se gasta diario, esto genera un reporte donde el cliente puede ver qué cosas fueron usadas.',
+})
+export class ProductIngredient extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @ManyToOne(() => Product, (product) => product.product_ingredients, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'product' })
+  product: Product
+
+  @Column({ length: 30, comment: 'Nombre del ingrediente.' })
+  name: string
+
+  @ManyToOne(
+    () => TypeMeasureIngredient,
+    (typeMeasureIngredient) => typeMeasureIngredient.type_measure_ingredients,
+    {
+      onDelete: 'CASCADE',
+      onUpdate: 'NO ACTION',
+    }
+  )
+  @JoinColumn({ name: 'type_measure_ingredient' })
+  type_measure_ingredient: TypeMeasureIngredient
+
+  @Column({ comment: 'Cantidad del ingrediente.' })
+  quantity: number
+
+  @Column({ type: 'datetime', comment: 'Fecha de creación del registro.' })
+  created: Date
+
+  @Column({
+    default: 1,
+    comment:
+      'Estado del registro, es decir:\r\n1. Activo: Es visible en los reportes de inventario.\r\n0. Inactivo: No será visible en los reportes de inventario.',
+  })
+  status: number
+}

package/src/entities/ProductTopping.ts

@@ -5,30 +5,41 @@ import {
   ManyToOne,
   JoinColumn,
   OneToMany,
+  BaseEntity,
 } from 'typeorm'
 import { Company } from './Company'
 import { ProductGroup } from './ProductGroup'
 
 @Entity('product_topping', {
   comment:
-    'Tabla para crear toppings y poder agregarlos a los productos, hay toppings que ya están creados para que el usuario no tenga qué agregarlos, o que el usuario pueda agregar sus propios toppings.',
+    'Tabla donde habrán varios toppings por defecto para que el usuario los pueda agregar a sus productos y editarlos a su gusto.\r\n\r\nUn administrador/usuario con permisos podrá crear los toppings para cada empresa si es necesario.',
 })
-export class ProductTopping {
-  @PrimaryGeneratedColumn()
+export class ProductTopping extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @ManyToOne(() => Company, (company) => company.product_toppings)
+  @ManyToOne(() => Company, (company) => company.product_toppings, {
+    nullable: true,
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'company' })
   company: Company
 
   @Column({
     length: 50,
     comment:
-      'El "name" se refiere al id de los archivos de lenguaje que está en "locale" del proyecto. Esto se hace para qué sirva el multilenguaje en el proyecto. Cabe recalcar qué las empresas pueden crear sus propios toppings, entonces no pasa nada el lenguaje en el que ellos lo escriban.',
+      'El `name` se refiere al id de los archivos de lenguaje que está en `locales` del proyecto. \n\nEsto se hace para qué sirva el multilenguaje en el proyecto. \n\nCabe recalcar qué las empresas pueden crear sus propios toppings, entonces no pasa nada el lenguaje en el que ellos lo escriban.',
   })
   name: string
 
-  @Column({ default: 1 })
+  @Column({
+    default: 1,
+    comment:
+      'Estado del registro, es decir:\r\n1. Activo: Es visible en los reportes de inventario.\r\n0. Inactivo: No será visible en los reportes de inventario.',
+  })
   status: number
 
   @OneToMany(() => ProductGroup, (productGroup) => productGroup.topping)

package/src/entities/Region.ts

@@ -5,23 +5,39 @@ import {
   ManyToOne,
   JoinColumn,
   OneToMany,
+  BaseEntity,
 } from 'typeorm'
 import { Country } from './Country'
 import { City } from './City'
 
-@Entity()
-export class Region {
-  @PrimaryGeneratedColumn()
+@Entity({
+  comment: 'Regiones/departamentos donde estará visible la plataforma.',
+})
+export class Region extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
   id: number
 
-  @Column({ length: 50 })
-  name: string
-
-  @ManyToOne(() => Country, (country) => country.regions)
+  @ManyToOne(() => Country, (country) => country.regions, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
   @JoinColumn({ name: 'country' })
   country: Country
 
-  @Column({ default: 1 })
+  @Column({
+    length: 50,
+    comment:
+      'Nombre de la región/departamento/estado.\r\n\r\nID/KEY de la variable que se encuentra en los archivos `locales` para el multilenguaje.',
+  })
+  name: string
+
+  @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(() => City, (city) => city.region)

package/src/entities/Request.ts

@@ -0,0 +1,107 @@
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  JoinColumn,
+  JoinTable,
+  ManyToMany,
+  ManyToOne,
+  OneToMany,
+  PrimaryGeneratedColumn,
+} from 'typeorm'
+import { Local } from './Local'
+import { PaymentMethod } from './PaymentMethod'
+import { RequestStatus } from './RequestStatus'
+import { User } from './User'
+import { RequestProduct } from './RequestProduct'
+import { RequestProductGroupComplement } from './RequestProductGroupComplement'
+
+@Entity({
+  comment:
+    'Tabla para agregar los pedidos realizados a través de la plataforma.',
+})
+export class Request extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @ManyToOne(() => User, (user) => user.requests, {
+    nullable: true,
+    onDelete: 'SET NULL',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'user' })
+  user: User
+
+  @ManyToOne(() => Local, (local) => local.requests, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'local' })
+  local: Local
+
+  @Column({
+    default: 1,
+    comment:
+      'Este campo hace referencia a si el tipo es:\r\n\r\n1. Individual: Un solo usuario ordena y paga.\r\n\r\n2. Grupal: El usuario principal puede agregar a otros colaboradores para realizar un pedido grupal (a tener en cuenta que el usuario principal es el único que puede realizar el pago del pedido).',
+  })
+  order_type: number
+
+  @ManyToOne(() => PaymentMethod, (paymentMethod) => paymentMethod.requests, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'payment_method' })
+  payment_method: PaymentMethod
+
+  @Column({
+    length: 30,
+    comment:
+      'Costo total del pedido, aquí toca tener en cuenta los productos (request_product) que se agreguen al pedido (request) y los complementos (request_product_group_complement).',
+  })
+  order_cost: string
+
+  @ManyToOne(() => RequestStatus, (requestStatus) => requestStatus.requests, {
+    onDelete: 'RESTRICT',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'status' })
+  status: RequestStatus
+
+  @Column({
+    length: 400,
+    comment:
+      'Los detalles que el usuario agrega al pedido, puede ser alguna sugerencia u otra cosa.',
+  })
+  details: string
+
+  @Column({
+    length: 400,
+    comment: 'Comentarios del pedido, este los realiza el cliente (local).',
+  })
+  comments: string
+
+  @ManyToMany(() => User)
+  @JoinTable({
+    name: 'request_group',
+    joinColumn: {
+      name: 'user',
+      referencedColumnName: 'id',
+    },
+    inverseJoinColumn: {
+      name: 'request',
+      referencedColumnName: 'id',
+    },
+  })
+  requests_group: User[]
+
+  @OneToMany(() => RequestProduct, (requestProduct) => requestProduct.request)
+  request_products: RequestProduct[]
+
+  @OneToMany(
+    () => RequestProductGroupComplement,
+    (requestProduct) => requestProduct.request
+  )
+  request_product_group_complements: RequestProductGroupComplement[]
+}

package/src/entities/RequestProduct.ts

@@ -0,0 +1,51 @@
+import {
+    BaseEntity,
+    Column,
+    Entity,
+    JoinColumn,
+    ManyToOne,
+    PrimaryGeneratedColumn,
+} from 'typeorm'
+import { Product } from './Product'
+import { Request } from './Request'
+import { User } from './User'
+
+@Entity('request_product', {
+  comment: 'Productos que están en el pedido.',
+})
+export class RequestProduct extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @ManyToOne(() => Request, (request) => request.request_products, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'request' })
+  request: Request
+
+  @ManyToOne(() => Product, (product) => product.request_products, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'product' })
+  product: Product
+
+  @ManyToOne(() => User, (user) => user.request_products, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'user' })
+  user: User
+
+  @Column({ comment: 'Cantidad del producto (product).' })
+  quantity: number
+
+  @Column({
+    length: 30,
+    comment: 'Comentarios del producto, si hay alguna sugerencia o solicitud.',
+  })
+  comments: string
+}

package/src/entities/RequestProductGroupComplement.ts

@@ -0,0 +1,55 @@
+import {
+  BaseEntity,
+  Column,
+  Entity,
+  JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+} from 'typeorm'
+import { Request } from './Request'
+import { User } from './User'
+import { ProductGroupComplement } from './productGroupComplement'
+
+@Entity('request_product_group_complement', {
+  comment:
+    'Complementos (toppings) que el usuario va a poder agregar por cada producto.',
+})
+export class RequestProductGroupComplement extends BaseEntity {
+  @PrimaryGeneratedColumn({
+    comment: 'Número de identificación (ID) único de cada registro.',
+  })
+  id: number
+
+  @ManyToOne(
+    () => Request,
+    (request) => request.request_product_group_complements,
+    {
+      onDelete: 'CASCADE',
+      onUpdate: 'NO ACTION',
+    }
+  )
+  @JoinColumn({ name: 'request' })
+  request: Request
+
+  @ManyToOne(
+    () => ProductGroupComplement,
+    (productGroupComplement) =>
+      productGroupComplement.request_product_group_complements,
+    {
+      onDelete: 'CASCADE',
+      onUpdate: 'NO ACTION',
+    }
+  )
+  @JoinColumn({ name: 'product_group_complement' })
+  product_group_complement: ProductGroupComplement
+
+  @ManyToOne(() => User, (user) => user.request_product_group_complements, {
+    onDelete: 'CASCADE',
+    onUpdate: 'NO ACTION',
+  })
+  @JoinColumn({ name: 'user' })
+  user: User
+
+  @Column({ comment: 'Cantidad de cada complemento.' })
+  quantity: number
+}