@nomalism-com/types 0.37.6 → 0.37.7

package/src/modules/supply/documentLine/route.schema.ts

@@ -0,0 +1,108 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  ICreateRequest,
+  IPrintLabelParamsRequest,
+  IPrintLabelQueryRequest,
+  IUpdateDataRequest,
+  IUpdateManyRequest,
+  IUpdateRequest,
+} from './interfaces';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  product_id: joi.string().uuid().allow(null).optional(),
+  // user to merge lines
+  document_line_id: joi.string().uuid().optional(),
+  // assoc specific
+  document_header_id: joi.string().uuid().required(),
+  // index: joi.number().integer().default(0).optional(),
+  quantity: joi.number().positive().allow(0).default(0).required(),
+  preco_venda: joi.number().positive().allow(0).default(0).required(),
+  client_tax: joi.number().positive().allow(0).required(),
+  client_discount: joi.number().positive().allow(0).default(0).max(100).required(),
+  preco_custo: joi.number().positive().allow(0).default(0).required(),
+  provider_tax: joi.number().positive().allow(0).required(),
+  provider_discount: joi.number().positive().allow(0).default(0).max(100).required(),
+  document_line_group_id: joi.string().optional(),
+  data: joi
+    .object()
+    .pattern(
+      joi.string(),
+      joi.object().keys({
+        value: joi.any().required(),
+      }),
+    )
+    .allow({}),
+};
+
+export const createBody = joi.array().items(joi.object().keys(createBodyKeys)).messages(messages);
+
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  product_id: joi.string().uuid().allow(null).optional(),
+
+  quantity: joi.number().positive().allow(0).optional(),
+  preco_venda: joi.number().positive().allow(0).optional(),
+  client_tax: joi.number().positive().allow(0).optional(),
+  client_discount: joi.number().positive().allow(0).max(100).optional(),
+  preco_custo: joi.number().positive().allow(0).optional(),
+  provider_tax: joi.number().positive().allow(0).optional(),
+  provider_discount: joi.number().positive().allow(0).max(100).optional(),
+  provider_purchase_discount: joi.number().positive().allow(0).max(100).optional(),
+  document_line_group_id: joi.string().optional(),
+  sent_to_client: joi.boolean().optional(),
+  sent_to_provider: joi.boolean().optional(),
+};
+
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+const updateDataBodyKeys: IShared.IRouteRequest<IUpdateDataRequest> = {
+  trigger_states: joi.boolean().optional(),
+  document_header_id: joi.string().uuid().required(),
+  document_line_ids: joi.array().items(joi.string().uuid().required()).required(),
+  datafield: joi.string().required(),
+  payload: joi
+    .object()
+    .keys({
+      value: joi.any().required(),
+      updated_by: joi.string().uuid().optional(),
+      updated_at: joi.date().optional(),
+      location_id: joi.string().uuid().optional(),
+    })
+    .required(),
+};
+
+export const updateDataBody = joi.object().keys(updateDataBodyKeys).messages(messages);
+
+const updateManyKeys: IShared.IRouteRequest<IUpdateManyRequest> = {
+  ids: joi.array().items(joi.string().uuid().required()).required(),
+  client_discount: joi.number().positive().allow(0).max(100).optional(),
+  price_cost: joi.number().positive().allow(0).optional(),
+  provider_discount: joi.number().positive().allow(0).max(100).optional(),
+  provider_estimated_delivery_date: joi.date().allow(null, '').optional(),
+  provider_purchase_discount: joi.number().positive().allow(0).max(100).optional(),
+  consignacao: joi.boolean().optional(),
+  cancelled: joi.boolean().optional(),
+};
+
+export const updateManyBody = joi.object().keys(updateManyKeys).messages(messages);
+
+export const updateIndexesBody = joi
+  .array()
+  .items(joi.string().uuid().required())
+  .required()
+  .messages(messages);
+
+export const deleteBody = joi.array().items(joi.string().uuid().required()).messages(messages);
+
+const printLabelParamsKeys: IShared.IRouteRequest<IPrintLabelParamsRequest> = {
+  document_line_ids: joi.string().required(),
+};
+
+export const printLabelParams = joi.object().keys(printLabelParamsKeys).messages(messages);
+
+const printLabelQueryKeys: IShared.IRouteRequest<IPrintLabelQueryRequest> = {
+  token: joi.string().required(),
+};
+
+export const printLabelQuery = joi.object().keys(printLabelQueryKeys).messages(messages);

package/src/modules/supply/documentLineAssoc/interfaces.ts

@@ -0,0 +1,52 @@
+import * as IShared from '../../../shared/interface';
+import { DocumentLineAssoc, DocumentLine } from '../../../shared/entities/stock';
+import * as IDocumentLine from '../documentLine/interfaces';
+import { IDocumentLineVirtuals } from '../documentLine/interfaces';
+
+export type Entity = DocumentLineAssoc;
+export const Route = 'documentLineAssoc';
+export const UpperName = 'DocumentLineAssoc';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IEntityWithDocumentLine extends Entity {
+  document_line: DocumentLine;
+}
+
+export interface IEntityExtended extends Entity {
+  document_line: IDocumentLine.IEntityExtended;
+}
+
+export interface ICreateRequest {
+  document_header_id: string;
+  document_line_id: string;
+}
+
+export interface IUpdateRequest {
+  external_id?: string | null;
+  origin_id?: string | null;
+}
+
+export interface IUpdateGroupRequest {
+  document_line_id: string[];
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+
+  findByOwnerId(data: IShared.IFindByOwnerIdRequest): Promise<IEntityExtended[]>;
+
+  findVirtualsByOwnerId(data: IShared.IFindByOwnerIdRequest): Promise<IDocumentLineVirtuals[]>;
+
+  findHistoryByLineId(data: IShared.IFindByIdRequest): Promise<IDocumentLine.IHistory[]>;
+
+  create(data: ICreateRequest[]): Promise<IEntityWithDocumentLine[]>;
+
+  update(
+    selector: IShared.IFindByIdRequest,
+    data: IUpdateRequest,
+  ): Promise<IEntityWithDocumentLine>;
+}
+
+export type IApi = Omit<IRepository, 'findById'>;
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/supply/documentLineAssoc/route.schema.ts

@@ -0,0 +1,16 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest } from './interfaces';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  document_header_id: joi.string().uuid().required(),
+  document_line_id: joi.string().uuid().required(),
+};
+export const createBody = joi.array().items(joi.object().keys(createBodyKeys)).messages(messages);
+
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  external_id: joi.string().allow(null).optional(),
+  origin_id: joi.string().allow(null).optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

package/src/modules/supply/documentLineMT/interface.ts

@@ -0,0 +1,27 @@
+import { DocumentLineMT } from '../../../shared/entities/stock';
+import * as IShared from '../../../shared/interface';
+
+export type Entity = DocumentLineMT;
+export const Route = 'document_line_mt';
+export const UpperName = 'DocumentLineMT';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IUpdateRequest {
+  document_line_ids: string[];
+  mt_order_by?: string | null;
+  mt_order_date?: Date | null;
+
+  mt_execution_by?: string | null;
+  mt_execution_date?: Date | null;
+  mt_execution_when?: Date | null;
+
+  mt_order_with_notification?: boolean;
+}
+
+export interface IRepository {
+  update(data: IUpdateRequest): Promise<void>;
+
+  findByOwnerId(selector: IShared.IFindByOwnerIdRequest): Promise<Entity[]>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/supply/documentLineMT/route.schema.ts

@@ -0,0 +1,18 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IUpdateRequest } from '../documentLineMT/interface';
+
+const updateKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  document_line_ids: joi.array().items(joi.string().uuid().required()).required(),
+  mt_order_by: joi.string().uuid().optional().allow(null),
+  mt_order_date: joi.date().optional().allow(null),
+
+  mt_execution_by: joi.string().uuid().optional().allow(null),
+  mt_execution_date: joi.date().optional().allow(null),
+  mt_execution_when: joi.date().optional().allow(null),
+
+  mt_order_with_notification: joi.boolean().optional().default(false),
+};
+
+export const updateBody = joi.object().keys(updateKeys).messages(messages);

package/src/modules/supply/documentLineNote/interfaces.ts

@@ -0,0 +1,53 @@
+import * as IShared from '../../../shared/interface';
+import { DocumentLineNote } from '../../../shared/entities/stock';
+
+// document lines Types
+export const IDocumentLineNoteTypeEnum: {
+  Prisao: 'Prisao';
+  Quebra: 'Quebra';
+  Entrada: 'Entrada';
+  Compra: 'Compra';
+  Devolucao: 'Devolucao';
+  Transformado: 'Transformado';
+  Inventario: 'Inventario';
+  PC: 'PC';
+  PF: 'PF';
+} = {
+  Prisao: 'Prisao',
+  Quebra: 'Quebra',
+  Entrada: 'Entrada',
+  Compra: 'Compra',
+  Devolucao: 'Devolucao',
+  Transformado: 'Transformado',
+  Inventario: 'Inventario',
+  PC: 'PC',
+  PF: 'PF',
+};
+
+export type IDocumentLineNoteType =
+  (typeof IDocumentLineNoteTypeEnum)[keyof typeof IDocumentLineNoteTypeEnum];
+
+export const documentLineNoteTypes = Object.keys(IDocumentLineNoteTypeEnum);
+
+export type Entity = DocumentLineNote;
+export const Route = 'documentLineNote';
+export const UpperName = 'DocumentLineNote';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  document_line_id: string;
+  type: IDocumentLineNoteType;
+  note: string;
+}
+
+export interface IUpdateRequest {
+  note: string;
+}
+
+export interface IRepository {
+  create(data: ICreateRequest): Promise<string>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/supply/documentLineNote/route.schema.ts

@@ -0,0 +1,19 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest, documentLineNoteTypes } from './interfaces';
+
+export const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  document_line_id: joi.string().uuid().required(),
+  note: joi.string().required(),
+  type: joi
+    .string()
+    .valid(...documentLineNoteTypes)
+    .required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  note: joi.string().required(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

package/src/modules/supply/documentLineRM/interface.ts

@@ -0,0 +1,34 @@
+import { DocumentLineRM } from '../../../shared/entities/stock';
+import * as IShared from '../../../shared/interface';
+
+export type Entity = DocumentLineRM;
+export const Route = 'document_line_rm';
+export const UpperName = 'DocumentLineRM';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IUpdateRequest {
+  document_line_ids: string[];
+  rm_order_by?: string | null;
+  rm_order_date?: Date | null;
+
+  rm_execution_by?: string | null;
+  rm_execution_date?: Date | null;
+  rm_execution_when?: Date | null;
+
+  rm_sent_by?: string | null;
+  rm_sent_date?: Date | null;
+
+  rm_done_by?: string | null;
+  rm_done_date?: Date | null;
+
+  rm_checked_by?: string | null;
+  rm_checked_date?: Date | null;
+}
+
+export interface IRepository {
+  update(data: IUpdateRequest): Promise<void>;
+
+  findByOwnerId(selector: IShared.IFindByOwnerIdRequest): Promise<Entity[]>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/supply/documentLineRM/route.schema.ts

@@ -0,0 +1,25 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IUpdateRequest } from '../documentLineRM/interface';
+
+const updateKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  document_line_ids: joi.array().items(joi.string().uuid().required()).required(),
+  rm_order_by: joi.string().uuid().optional().allow(null),
+  rm_order_date: joi.date().optional().allow(null),
+
+  rm_execution_by: joi.string().uuid().optional().allow(null),
+  rm_execution_date: joi.date().optional().allow(null),
+  rm_execution_when: joi.date().optional().allow(null),
+
+  rm_sent_by: joi.string().uuid().optional().allow(null),
+  rm_sent_date: joi.date().optional().allow(null),
+
+  rm_done_by: joi.string().uuid().optional().allow(null),
+  rm_done_date: joi.date().optional().allow(null),
+
+  rm_checked_by: joi.string().uuid().optional().allow(null),
+  rm_checked_date: joi.date().optional().allow(null),
+};
+
+export const updateBody = joi.object().keys(updateKeys).messages(messages);

package/src/modules/supply/documentSet/interface.ts

@@ -0,0 +1,31 @@
+import * as IShared from '../../../shared/interface';
+import { DocumentSet } from '../../../shared/entities/stock';
+
+export type Entity = DocumentSet;
+export const Route = 'document_set';
+export const UpperName = 'DocumentSet';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  document_set_id: number | null;
+  name: string;
+  active_by_default: boolean;
+  validation_code: string;
+}
+
+export interface IUpdateRequest {
+  document_set_id?: number | null;
+  name?: string;
+  active_by_default?: boolean;
+  validation_code?: string;
+}
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+  find(): Promise<Entity[]>;
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<Entity | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/supply/documentSet/route.schema.ts

@@ -0,0 +1,20 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest } from './interface';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  name: joi.string().required(),
+  document_set_id: joi.number().integer().allow(null).optional(),
+  active_by_default: joi.boolean().default(false).optional(),
+  validation_code: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string(),
+  document_set_id: joi.number().integer().allow(null).optional(),
+  active_by_default: joi.boolean().optional(),
+  validation_code: joi.string().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

package/src/modules/supply/documentType/interfaces.ts

@@ -0,0 +1,214 @@
+import * as IShared from '../../../shared/interface';
+import { DocumentType, ExternalDocumentType } from '../../../shared/entities/stock';
+
+export type Entity = DocumentType;
+export const Route = 'documentType';
+export const UpperName = 'DocumentType';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export const DocumentTypeUserTypeEnum: {
+  client: 'client';
+  provider: 'provider';
+  commissioner: 'commissioner';
+  store_operator: 'store_operator';
+  self: 'self';
+} = {
+  client: 'client',
+  provider: 'provider',
+  commissioner: 'commissioner',
+  store_operator: 'store_operator',
+  self: 'self',
+};
+
+export type IDocumentTypeUserType =
+  (typeof DocumentTypeUserTypeEnum)[keyof typeof DocumentTypeUserTypeEnum];
+
+export const documentTypeUserTypes = Object.keys(DocumentTypeUserTypeEnum);
+
+export const DocumentTypeCodeTypeEnum: {
+  PC: 'PC';
+  FTPF: 'FTPF';
+  PCTL: 'PCTL';
+  AD: 'AD';
+  NCAD: 'NCAD';
+  FT: 'FT';
+  FS: 'FS';
+  FR: 'FR';
+  NC: 'NC';
+  GT: 'GT';
+  RE: 'RE';
+  LNC: 'LNC';
+  NPC: 'NPC';
+  QECI: 'QECI';
+  OPI: 'OPI';
+  OP: 'OP';
+  PF: 'PF';
+  EF: 'EF';
+  EFSN: 'EFSN';
+  EM: 'EM';
+  GTF: 'GTF';
+  DF: 'DF';
+  CF: 'CF';
+  NPF: 'NPF';
+  ADF: 'ADF';
+  NCF: 'NCF';
+  NCRF: 'NCRF';
+  FTF: 'FTF';
+  PI: 'PI';
+  IM: 'IM';
+  IMN: 'IMN';
+  QE: 'QE';
+  TR: 'TR';
+  TRS: 'TRS';
+  GTI: 'GTI';
+  ADSM: 'ADSM';
+  FTSM: 'FTSM';
+  FP: 'FP';
+  RDP: 'RDP';
+  NRCL: 'NRCL';
+  FPM: 'FPM';
+} = {
+  PC: 'PC',
+  FTPF: 'FTPF',
+  PCTL: 'PCTL',
+  AD: 'AD',
+  NCAD: 'NCAD',
+  FT: 'FT',
+  FS: 'FS',
+  FR: 'FR',
+  NC: 'NC',
+  GT: 'GT',
+  RE: 'RE',
+  LNC: 'LNC',
+  NPC: 'NPC',
+  QECI: 'QECI',
+  OPI: 'OPI',
+  OP: 'OP',
+  PF: 'PF',
+  EF: 'EF',
+  EFSN: 'EFSN',
+  EM: 'EM',
+  GTF: 'GTF',
+  DF: 'DF',
+  CF: 'CF',
+  NPF: 'NPF',
+  ADF: 'ADF',
+  NCF: 'NCF',
+  NCRF: 'NCRF',
+  FTF: 'FTF',
+  PI: 'PI',
+  IM: 'IM',
+  IMN: 'IMN',
+  QE: 'QE',
+  TR: 'TR',
+  TRS: 'TRS',
+  GTI: 'GTI',
+  ADSM: 'ADSM',
+  FTSM: 'FTSM',
+  FP: 'FP',
+  RDP: 'RDP',
+  NRCL: 'NRCL',
+  FPM: 'FPM',
+};
+
+export type IDocumentTypeCodeType =
+  (typeof DocumentTypeCodeTypeEnum)[keyof typeof DocumentTypeCodeTypeEnum];
+
+export const documentTypeCodeTypes = Object.keys(DocumentTypeCodeTypeEnum);
+
+export interface IEntityExtended extends DocumentType {
+  external_document_type: ExternalDocumentType | null;
+}
+
+export interface ICreateRequest {
+  external_document_type_id: string | null;
+  document_set_id: string;
+
+  code: IDocumentTypeCodeType;
+  description: string;
+
+  group: string;
+  is_searchable: boolean;
+
+  quantity_in?: boolean;
+  quantity_out?: boolean;
+
+  credit?: boolean;
+  debit?: boolean;
+
+  invoice: boolean;
+  return: boolean;
+  pay: boolean;
+  allow_create_from_header_without_lines: boolean;
+  allow_commissioner: boolean;
+  duplicate_group?: string | null;
+  allow_duplicates: boolean;
+  requires_picking: boolean;
+  allow_document_line_assoc_plugins: boolean;
+
+  user_type: IDocumentTypeUserType;
+  final_consumer: boolean;
+
+  ensure_same_provider: boolean;
+}
+
+export interface IUpdateRequest {
+  external_document_type_id?: string | null;
+  document_set_id?: string;
+
+  code?: IDocumentTypeCodeType;
+  description?: string;
+
+  group?: string;
+  is_searchable?: boolean;
+
+  quantity_in?: boolean;
+  quantity_out?: boolean;
+
+  credit?: boolean;
+  debit?: boolean;
+
+  invoice: boolean;
+  return: boolean;
+  pay: boolean;
+  allow_create_from_header_without_lines: boolean;
+  allow_commissioner?: boolean;
+  duplicate_group?: string | null;
+  allow_duplicates?: boolean;
+  requires_picking?: boolean;
+  allow_document_line_assoc_plugins: boolean;
+  user_type?: IDocumentTypeUserType;
+  final_consumer?: boolean;
+
+  ensure_same_provider?: boolean;
+}
+
+export interface IFindRequest {
+  description?: string;
+}
+
+export interface IFindResponse {
+  id: number;
+  group: string;
+  description: string;
+}
+
+export interface IRepository {
+  findById(id: number): Promise<Entity | null>;
+  findByQuery(data: IFindRequest): Promise<Entity[]>;
+
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  find(): Promise<IFindResponse[]>;
+  findDetailed(): Promise<IEntityExtended[]>;
+
+  create(data: ICreateRequest): Promise<IEntityExtended>;
+  update(
+    selector: IShared.IFindByIdNumberRequest,
+    data: IUpdateRequest,
+  ): Promise<IEntityExtended | null>;
+  deleteOne(selector: IShared.IFindByIdNumberRequest): Promise<IEntityExtended | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+
+export type IApi = Omit<IRepository, 'findById' | 'findByQuery'>;