@nomalism-com/types 0.33.88 → 0.34.2

package/src/modules/stock/chat/interfaces.ts

@@ -0,0 +1,82 @@
+import type * as IShared from '../../../shared/interface';
+import type * as Persona from '../../user/persona/interface';
+import { Chat, File } from '../../../shared/entities';
+
+export type Entity = Chat;
+export const Route = 'chat';
+export const UpperName = 'Chat';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export const ChatTypeEnum: {
+  por_proposta: 'por_proposta';
+  global: 'global';
+} = {
+  por_proposta: 'por_proposta',
+  global: 'global',
+};
+
+export type IChatType = (typeof ChatTypeEnum)[keyof typeof ChatTypeEnum];
+
+export const chatTypes = Object.keys(ChatTypeEnum);
+
+export interface IChatBalloon {
+  chat?: Pick<Entity, 'message'> & {
+    id?: string;
+    read?: boolean;
+  };
+  file?: Pick<File, 'multimedia_id' | 'filename'> & {
+    id?: string;
+    read?: boolean;
+  };
+  created_at: Date;
+  created_by: string;
+  is_customer: boolean;
+}
+
+export type IReport = Pick<
+  Entity,
+  'email_processed' | 'email_delivered' | 'email_opened' | 'email_clicked'
+>;
+
+export interface IPublicFindActiveByOwnerIdResponse {
+  persona?: Persona.IFindContactPersonaByOwnerId;
+  last_group_report?: IReport;
+  owner_id?: string;
+  chat: IChatBalloon[];
+}
+
+export interface ICreateRequest {
+  owner_id: string;
+  document_header_id: string;
+  message: string;
+  username: string;
+  is_customer: boolean;
+}
+
+export interface IUpdateRequest {
+  document_header_id?: string;
+  message?: string;
+  email_processed?: boolean;
+  email_delivered?: boolean;
+  email_opened?: boolean;
+  email_clicked?: boolean;
+  whatsapp_sent?: boolean;
+  read?: boolean;
+  username?: string;
+}
+
+export interface IRepository {
+  findActiveByOwnerId(
+    params: IShared.IFindByOwnerIdRequest,
+  ): Promise<IPublicFindActiveByOwnerIdResponse>;
+
+  resendLast(params: IShared.IFindByOwnerIdRequest): Promise<void>;
+  create(data: ICreateRequest): Promise<Chat>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+
+  markAllAsRead(params: IShared.IFindByOwnerIdRequest): Promise<void>;
+  markAllAsUnread(params: IShared.IFindByOwnerIdRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/chat/route.schema.ts

@@ -0,0 +1,28 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest } from './interfaces';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  owner_id: joi.string().uuid().required(),
+  document_header_id: joi.string().uuid().allow(null).required(),
+  message: joi.string().required(),
+  username: joi.string().required(),
+  is_customer: joi.boolean().default(false).optional(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  document_header_id: joi.string().uuid().optional(),
+  message: joi.string().optional(),
+  email_processed: joi.boolean().optional(),
+  email_delivered: joi.boolean().optional(),
+  email_opened: joi.boolean().optional(),
+  email_clicked: joi.boolean().optional(),
+  whatsapp_sent: joi.boolean().optional(),
+  read: joi.boolean().optional(),
+  username: joi.string().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

package/src/modules/stock/chatRapidMessage/interface.ts

@@ -0,0 +1,31 @@
+export const Route = 'chat_rapid_message';
+export const UpperName = 'ChatRapidMessage';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+import { ChatRapidMessage } from '../../../shared/entities';
+import * as IShared from '../../../shared/interface';
+
+export type Entity = ChatRapidMessage;
+
+export interface ICreateRequest {
+  title: string;
+  message: string;
+}
+
+export interface IUpdateRequest {
+  title?: string;
+  message?: string;
+}
+
+export interface IFindMinifiedResponse {
+  id: string;
+  title: string;
+}
+export interface IRepository {
+  create(data: ICreateRequest): Promise<Entity>;
+  findMinified(): Promise<IFindMinifiedResponse[]>;
+  findById(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+  delete(selector: IShared.IFindByIdRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/chatRapidMessage/route.schema.ts

@@ -0,0 +1,18 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  title: joi.string().required(),
+  message: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  title: joi.string().optional(),
+  message: joi.string().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

package/src/modules/stock/dashboard/interface.ts

@@ -0,0 +1,25 @@
+export const Route = 'dashboard';
+export const UpperName = 'Dashboard';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type IDashboardNames = 'dia' | 'mes' | 'ano';
+
+export interface IData {
+  chave: number;
+  faturaRecibo: number;
+  fatura: number;
+  adiantamento: number;
+}
+
+export interface IDashboardResponse {
+  id: number;
+  name: string;
+  data: IData[];
+}
+export interface IFindDashboardByDate {
+  date: Date;
+  name: IDashboardNames;
+}
+export interface IRepository {
+  findByDate(selector: IFindDashboardByDate): Promise<IDashboardResponse>;
+}

package/src/modules/stock/dashboard/route.schema.ts

@@ -0,0 +1,11 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindDashboardByDate } from './interface';
+
+// create body validation
+const findByDateKeys: IShared.IRouteRequest<IFindDashboardByDate> = {
+  date: joi.date().required(),
+  name: joi.string().valid('dia', 'mes', 'ano').required(),
+};
+export const findByDateParams = joi.object().keys(findByDateKeys).messages(messages);

package/src/modules/stock/file/interface.ts

@@ -0,0 +1,37 @@
+import * as IShared from '../../../shared/interface';
+import { File } from '../../../shared/entities';
+
+export type Entity = File;
+export const Route = 'file';
+export const UpperName = 'File';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IFindByOwnerRequest {
+  owner_id: string;
+  tags?: string;
+  shared_only: boolean;
+}
+
+export interface ICreateRequest {
+  title: string;
+  owner_id: string;
+  document_header_id: string | null;
+  multimedia_id: string;
+  filename: string;
+  is_customer?: boolean;
+  is_private: boolean;
+  tags: string;
+  username: string;
+}
+
+export interface IUpdateRequest {
+  document_header_id?: string;
+  filename?: string;
+}
+
+export interface IRepository {
+  findByOwnerId(params: IFindByOwnerRequest): Promise<Entity[]>;
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}

package/src/modules/stock/file/route.schema.ts

@@ -0,0 +1,37 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IFindByOwnerRequest, type IUpdateRequest } from './interface';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  title: joi.string().required(),
+  owner_id: joi.string().uuid().required(),
+  document_header_id: joi.string().uuid().allow(null).required(),
+  multimedia_id: joi.string().uuid().required(),
+  filename: joi.string().required(),
+  is_customer: joi.boolean().default(false).optional(),
+  is_private: joi.boolean().required(),
+  tags: joi.string().allow('').empty('').required(),
+  username: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  document_header_id: joi.string().uuid().optional(),
+  filename: joi
+    .string()
+    .min(1)
+    .max(255)
+    .regex(/^[^<>:"/\\|?*\x00-\x1F]+$/)
+    .optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+export const findByOwnerIdQuery = joi
+  .object<IFindByOwnerRequest>()
+  .keys({
+    owner_id: joi.string().uuid().required(),
+    tags: joi.string().optional(),
+    shared_only: joi.boolean().required(),
+  })
+  .messages(messages);

package/src/modules/stock/location/interface.ts

@@ -0,0 +1,77 @@
+import * as IShared from '../../../shared/interface';
+import { Location, TypeOfLocation } from '../../../shared/entities';
+
+export type Entity = Location;
+export const Route = 'location';
+export const UpperName = 'Location';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+interface IFindDetailedResponse extends Entity {
+  type_of_location: TypeOfLocation;
+}
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, 'type_of_location'>;
+
+// omit any unnecessary fields
+export type IFindByOwnerIdResponse = Omit<IFindDetailedResponse, 'type_of_location'>;
+
+export type IFindRequest = Record<string, unknown>;
+
+// omit any unnecessary fields
+export type IFindResponse = Omit<IFindDetailedResponse, ''>;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<
+  Omit<IFindDetailedResponse, 'type_of_location'>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  name: string;
+  street: string;
+  country_id: string;
+  country_name: string;
+  locality: string;
+  postal_code: string;
+  type_of_location_id: string;
+  geolocation?: {
+    lat: number;
+    lon: number;
+  };
+  default_billing?: boolean;
+  default_delivery?: boolean;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+  street?: string;
+  locality?: string;
+  country_id?: string;
+  country_name?: string;
+  postal_code?: string;
+  type_of_location_id?: string;
+  geolocation?: {
+    lat?: number;
+    lon?: number;
+  };
+  default_billing?: boolean;
+  default_delivery?: boolean;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  create(data: ICreateRequest): Promise<IFindResponse>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<IFindResponse | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<IFindResponse | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/location/route.schema.ts

@@ -0,0 +1,57 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindRequest, IFindPaginatedRequest, ICreateRequest, IUpdateRequest } from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  name: joi.string().required(),
+  type_of_location_id: joi.string().uuid().required(),
+  country_id: joi.string().uuid().required(),
+  country_name: joi.string().required(),
+  geolocation: joi
+    .object({
+      lat: joi.number().required(),
+      lon: joi.number().required(),
+    })
+    .optional(),
+  street: joi.string().required(),
+  locality: joi.string().required(),
+  postal_code: joi.string().trim(true).lowercase().required(),
+  default_billing: joi.boolean(),
+  default_delivery: joi.boolean(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().optional(),
+  type_of_location_id: joi.string().uuid().optional(),
+  country_id: joi.string().uuid().optional(),
+  country_name: joi.string().optional(),
+  geolocation: joi
+    .object({
+      lat: joi.number().required(),
+      lon: joi.number().required(),
+    })
+    .optional(),
+  street: joi.string().optional(),
+  locality: joi.string().optional(),
+  postal_code: joi.string().trim(true).lowercase().optional(),
+  default_billing: joi.boolean(),
+  default_delivery: joi.boolean(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+// find with pagination query validation
+const findWithPaginationQueryKeys: IShared.IRouteRequest<IFindPaginatedRequest> = {
+  per_page: joi.number().integer().positive().default(10).optional(),
+  current_page: joi.number().integer().positive().default(1).optional(),
+};
+export const findWithPaginationQuery = joi
+  .object()
+  .keys(findWithPaginationQueryKeys)
+  .messages(messages);

package/src/modules/stock/prison/interface.ts

@@ -0,0 +1,70 @@
+import { DocumentLineNote } from '../../../shared/entities';
+import * as IShared from '../../../shared/interface';
+
+export const Route = 'prison';
+export const UpperName = 'Prison';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IFindLinesInPrisonResponse {
+  id: string;
+  quantity: number;
+  preco_custo: number;
+  id_provider: number;
+  product: {
+    id: string;
+    thumbnail_multimedia_id: string | null;
+    virtual: {
+      designation: string;
+      reference: string;
+    };
+  };
+  notes: DocumentLineNote[];
+  updated_by: string;
+  updated_at: Date;
+}
+
+export const checkLineInPrisonOptions = ['Desprender', 'Quebrar', 'Devolver a fornecedor'] as const;
+
+export type ICheckLineInPrisonOptions = (typeof checkLineInPrisonOptions)[number];
+
+export interface ICheckLinesInPrisonLinesRequest {
+  document_line_id: string;
+}
+
+export interface ICheckLinesInPrisonRequest {
+  option: ICheckLineInPrisonOptions;
+  lines: ICheckLinesInPrisonLinesRequest[];
+}
+
+export interface ICreateLinesInPrisonProduct {
+  id: string;
+  quantity: number;
+  note?: string;
+}
+
+export interface ICreateLinesInPrisonRequest {
+  products: ICreateLinesInPrisonProduct[];
+  createProviderReturn: boolean;
+}
+
+export interface IRepository {
+  findLinesInPrison(): Promise<IFindLinesInPrisonResponse[]>;
+
+  findLinesInPrisonProviders(): Promise<IShared.IFindMinifiedResponse[]>;
+
+  putLineInPrison(params: IShared.IFindByIdRequest): Promise<void>;
+
+  removeLineFromPrison(params: IShared.IFindByIdRequest): Promise<void>;
+
+  checkLinesInPrison(
+    params: ICheckLinesInPrisonRequest,
+  ): Promise<IShared.IBrokerMessage<IShared.IBrokerTopic>[]>;
+
+  createLinesInPrison(params: ICreateLinesInPrisonRequest): Promise<string[]>;
+}
+
+export type IApi = Omit<IRepository, 'checkLinesInPrison'> & {
+  checkLinesInPrison(params: ICheckLinesInPrisonRequest): Promise<void>;
+};
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/prison/route.schema.ts

@@ -0,0 +1,50 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  ICheckLinesInPrisonLinesRequest,
+  ICheckLinesInPrisonRequest,
+  ICreateLinesInPrisonProduct,
+  ICreateLinesInPrisonRequest,
+  checkLineInPrisonOptions,
+} from './interface';
+
+// check lines in prison
+const checkLinesInPrisonLinesBodyKeys: IShared.IRouteRequest<ICheckLinesInPrisonLinesRequest> = {
+  document_line_id: joi.string().uuid().required(),
+};
+const checkLinesInPrisonBodyKeys: IShared.IRouteRequest<ICheckLinesInPrisonRequest> = {
+  option: joi
+    .string()
+    .valid(...checkLineInPrisonOptions)
+    .required(),
+  lines: joi
+    .array()
+    .items(joi.object().keys(checkLinesInPrisonLinesBodyKeys).required())
+    .required(),
+};
+
+export const checkLinesInPrisonBody = joi
+  .object()
+  .keys(checkLinesInPrisonBodyKeys)
+  .messages(messages);
+
+export const createLinesInPrisonBody = joi
+  .object<ICreateLinesInPrisonRequest>()
+  .keys({
+    createProviderReturn: joi.boolean().required(),
+    products: joi
+      .array()
+      .items(
+        joi
+          .object<ICreateLinesInPrisonProduct>()
+          .keys({
+            id: joi.string().uuid().required(),
+            quantity: joi.number().positive().required(),
+            note: joi.string().optional(),
+          })
+          .required(),
+      )
+      .required(),
+  })
+  .required();