@nomalism-com/types 0.37.6 → 0.37.7

package/src/modules/document/returnToProvider/route.schema.ts

@@ -0,0 +1,27 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  ICheckLinesToReturnRequest,
+  ICheckLinesToReturnLinesRequest,
+  checkLinesToReturnOptions,
+} from './interface';
+
+// check lines to return
+const checkLinesToReturnLinesKeys: IShared.IRouteRequest<ICheckLinesToReturnLinesRequest> = {
+  document_line_assoc_id: joi.string().uuid().required(),
+  document_line_id: joi.string().uuid().required(),
+};
+
+const checkLinesToReturnBodyKeys: IShared.IRouteRequest<ICheckLinesToReturnRequest> = {
+  option: joi
+    .string()
+    .valid(...checkLinesToReturnOptions)
+    .required(),
+  lines: joi.array().items(joi.object().keys(checkLinesToReturnLinesKeys).required()).required(),
+};
+
+export const checkLinesToReturnBody = joi
+  .object()
+  .keys(checkLinesToReturnBodyKeys)
+  .messages(messages);

package/src/modules/document/transformado/interfaces.ts

@@ -0,0 +1,31 @@
+import * as IShared from '../../../shared/interface';
+
+export const Route = 'transformado';
+export const UpperName = 'Transformado';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IProducts {
+  id: string;
+  quantity: number;
+}
+
+export interface ITransformar {
+  product_id: string;
+  quantity: number;
+  price_sale: number;
+  price_cost: number;
+  out_products: IProducts[];
+}
+
+export interface IDestransformar {
+  product_id: string;
+  quantity: number;
+  in_products: IProducts[];
+}
+
+export interface IRepository {
+  transformar(data: ITransformar): Promise<string>;
+  destransformar(data: IDestransformar): Promise<string>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/document/transformado/route.schema.ts

@@ -0,0 +1,26 @@
+import joi from 'joi';
+
+import * as IShared from '../../../shared/interface';
+import { messages } from '../../../shared/messages';
+import { IProducts, ITransformar, IDestransformar } from './interfaces';
+
+const productsKeys: IShared.IRouteRequestWithStamps<IProducts> = {
+  id: joi.string().uuid().required().invalid(joi.ref('/product_id')),
+  quantity: joi.number().positive().required(),
+};
+
+const transformarKeys: IShared.IRouteRequestWithStamps<ITransformar> = {
+  product_id: joi.string().uuid().required(),
+  quantity: joi.number().positive().required(),
+  price_cost: joi.number().positive().allow(0).required(),
+  price_sale: joi.number().positive().allow(0).required(),
+  out_products: joi.array().items(joi.object().keys(productsKeys)).min(1),
+};
+export const transformarBody = joi.object().keys(transformarKeys).messages(messages);
+
+const destransformarKeys: IShared.IRouteRequestWithStamps<IDestransformar> = {
+  product_id: joi.string().uuid().required(),
+  quantity: joi.number().positive().required(),
+  in_products: joi.array().items(joi.object().keys(productsKeys)).min(1),
+};
+export const destransformarBody = joi.object().keys(destransformarKeys).messages(messages);

package/src/modules/document/upfrontReturn/interfaces.ts

@@ -0,0 +1,17 @@
+import * as IShared from '../../../shared/interface';
+
+export const Route = 'upfrontReturn';
+export const UpperName = 'UpfrontReturn';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  current_account: boolean;
+}
+
+export interface IRepository {
+  create(id: IShared.IFindByIdRequest, body: ICreateRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+
+export type IApi = IRepository;

package/src/modules/document/upfrontReturn/route.schema.ts

@@ -0,0 +1,11 @@
+import joi from 'joi';
+
+import * as IShared from '../../../shared/interface';
+import { messages } from '../../../shared/messages';
+import { ICreateRequest } from './interfaces';
+
+const createBodyKeys: IShared.IRouteRequestWithStamps<ICreateRequest> = {
+  current_account: joi.boolean().required(),
+};
+
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);

package/src/modules/documentManagement/multimedia/interfaces.ts

@@ -0,0 +1,22 @@
+import { Multimedia } from '../../../shared/entities/documentManagement';
+
+export type Entity = Multimedia;
+export const Route = 'multimedia';
+export const UpperName = 'Multimedia';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IFindByIdRequest {
+  download?: boolean;
+}
+
+export interface IRepository {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  create(multipartFormData: any, headers?: any): Promise<Entity>;
+  findById(multimedia_id: string): Promise<Entity | null>;
+}
+
+export interface IController extends Omit<IRepository, 'findById'> {
+  findById(multimedia_id: string, params: IFindByIdRequest): Promise<void>;
+}
+
+export type IApi = Omit<IRepository, 'findById'>;

package/src/modules/documentManagement/multimedia/route.schema.ts

@@ -0,0 +1,9 @@
+import joi from 'joi';
+import { IFindByIdRequest } from './interfaces';
+import * as IShared from '../../../shared/interface';
+import { messages } from '../../../shared/messages';
+
+const findByIdQueryKeys: IShared.IRouteRequest<IFindByIdRequest> = {
+  download: joi.boolean().optional(),
+};
+export const findByIdQuery = joi.object().keys(findByIdQueryKeys).messages(messages);

package/src/modules/integration/emailLog/interfaces.ts

@@ -0,0 +1,111 @@
+import * as IShared from '../../../shared/interface';
+import { EmailLog } from '../../../shared/entities/integration';
+
+export type Entity = EmailLog;
+export const Route = 'email_log';
+export const UpperName = 'EmailLog';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IFindRequest {
+  date_start: Date;
+  date_end: Date;
+}
+
+export interface IFindResponse {
+  id: string;
+  template: string;
+  created_at: Date;
+  to: string;
+  subject: string;
+  sent: boolean;
+  retried: boolean;
+  error: string | null;
+}
+
+export interface IEmailAddress {
+  name: string;
+  address: string;
+}
+
+export interface IEmailAttachment {
+  path: string;
+  filename: string;
+}
+
+export const SendGridCallbackEventEnum: {
+  open: 'open';
+  delivered: 'delivered';
+  click: 'click';
+  processed: 'processed';
+  dropped: 'dropped';
+  deferred: 'deferred';
+  bounce: 'bounce';
+} = {
+  open: 'open',
+  delivered: 'delivered',
+  click: 'click',
+  processed: 'processed',
+  dropped: 'dropped',
+  deferred: 'deferred',
+  bounce: 'bounce',
+};
+
+export type ISendGridCallbackEvent =
+  (typeof SendGridCallbackEventEnum)[keyof typeof SendGridCallbackEventEnum];
+
+export const sendGridCallbackEvents = Object.keys(SendGridCallbackEventEnum);
+
+export interface ISendGridCallbacks {
+  email: string;
+  event: ISendGridCallbackEvent;
+  event_time: Date;
+  ip: string | null;
+  useragent: string | null;
+  // event dependent
+  reason: string | null;
+  type: string | null;
+  status: string | null;
+  bounce_classification: string | null;
+  response: string | null;
+  url: string | null;
+  attempt: number | null;
+}
+
+export interface IFindByIdResponse {
+  id: string;
+  owner_id: string | null;
+  chat_id: string | null;
+  template: string;
+  created_at: Date;
+
+  sent: boolean;
+  retried: boolean;
+  accepted: string[];
+  rejected: string[];
+
+  from: IEmailAddress;
+  to: IEmailAddress[];
+  cc: IEmailAddress[];
+  bcc: IEmailAddress[];
+  subject: string;
+  html: string;
+  attachments: IEmailAttachment[];
+
+  error: string | null;
+
+  callbacks: ISendGridCallbacks[];
+}
+
+export interface ICheckSent {
+  document_header_ids: string[];
+}
+export interface ICheckSentResponse {
+  [document_header_id: string]: string | null;
+}
+export interface IRepository {
+  find(params: IFindRequest): Promise<IFindResponse[]>;
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse>;
+  checkSent(data: ICheckSent): Promise<ICheckSentResponse>;
+}
+
+export type IApi = IRepository;

package/src/modules/integration/emailLog/route.schema.ts

@@ -0,0 +1,18 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import { IFindRequest, ICheckSent } from './interfaces';
+
+export const findQuery = joi
+  .object<IFindRequest>()
+  .keys({
+    date_start: joi.date().required(),
+    date_end: joi.date().required(),
+  })
+  .messages(messages);
+
+export const checkSentBody = joi
+  .object<ICheckSent>()
+  .keys({
+    document_header_ids: joi.array().items(joi.string().uuid().required()).required(),
+  })
+  .messages(messages);

package/src/modules/integration/emailTemplate/interfaces.ts

@@ -0,0 +1,55 @@
+import * as IShared from '../../../shared/interface';
+import { EmailTemplate, EmailTemplateAttachment } from '../../../shared/entities/integration';
+import { IEmailAddress, IEmailAttachment } from '../emailLog/interfaces';
+
+export type Entity = EmailTemplate;
+export const Route = 'email_template';
+export const UpperName = 'EmailTemplate';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IEntityExtended extends Entity {
+  attachments: EmailTemplateAttachment[];
+}
+
+export interface ICreateAttachments {
+  multimedia_id: string;
+  name: string;
+}
+
+export interface ICreateRequest {
+  name: string;
+  to: string;
+  subject: string;
+  body: string;
+  attachments: ICreateAttachments[];
+}
+
+export interface IUpdateRequest {
+  name?: string;
+  to?: string;
+  subject?: string;
+  body?: string;
+}
+
+export interface ISendRequest {
+  owner_id: string | null;
+  from: IEmailAddress;
+  to: IEmailAddress[];
+  cc: IEmailAddress[];
+  bcc: IEmailAddress[];
+  subject: string;
+  html: string;
+  attachments: IEmailAttachment[];
+}
+
+export interface IRepository {
+  find(): Promise<IEntityExtended[]>;
+  create(data: ICreateRequest): Promise<string>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+  send(data: ISendRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+
+export type IApi = IRepository;

package/src/modules/integration/emailTemplate/route.schema.ts

@@ -0,0 +1,95 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import { ICreateRequest, IUpdateRequest, ISendRequest, ICreateAttachments } from './interfaces';
+import * as IShared from '../../../shared/interface';
+import { IEmailAddress, IEmailAttachment } from '../emailLog/interfaces';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  name: joi.string().required(),
+  to: joi.string().required(),
+  subject: joi.string().required(),
+  body: joi.string().required(),
+  attachments: joi
+    .array()
+    .items(
+      joi.object<ICreateAttachments>().keys({
+        multimedia_id: joi.string().uuid().required(),
+        name: joi.string().required(),
+      }),
+    )
+    .required(),
+};
+
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().optional(),
+  to: joi.string().optional(),
+  subject: joi.string().optional(),
+  body: joi.string().optional(),
+};
+
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+const sendBodyKeys: IShared.IRouteRequest<ISendRequest> = {
+  owner_id: joi.string().uuid().allow(null).required(),
+  from: joi
+    .object<IEmailAddress>()
+    .keys({
+      name: joi.string().allow('', null).default('').required(),
+      address: joi
+        .string()
+        .email({ tlds: { allow: false } })
+        .required(),
+    })
+    .required(),
+  to: joi
+    .array()
+    .items(
+      joi.object<IEmailAddress>().keys({
+        name: joi.string().allow('', null).default('').required(),
+        address: joi
+          .string()
+          .email({ tlds: { allow: false } })
+          .required(),
+      }),
+    )
+    .required(),
+  cc: joi
+    .array()
+    .items(
+      joi.object<IEmailAddress>().keys({
+        name: joi.string().allow('', null).default('').required(),
+        address: joi
+          .string()
+          .email({ tlds: { allow: false } })
+          .required(),
+      }),
+    )
+    .required(),
+  bcc: joi
+    .array()
+    .items(
+      joi.object<IEmailAddress>().keys({
+        name: joi.string().allow('', null).default('').required(),
+        address: joi
+          .string()
+          .email({ tlds: { allow: false } })
+          .required(),
+      }),
+    )
+    .required(),
+  subject: joi.string().required(),
+  html: joi.string().required(),
+  attachments: joi
+    .array()
+    .items(
+      joi.object<IEmailAttachment>().keys({
+        filename: joi.string().required(),
+        path: joi.string().required(),
+      }),
+    )
+    .required(),
+};
+
+export const sendBody = joi.object().keys(sendBodyKeys).messages(messages);

package/src/modules/integration/emailTemplateAttachment/interfaces.ts

@@ -0,0 +1,22 @@
+import * as IShared from '../../../shared/interface';
+import { EmailTemplateAttachment } from '../../../shared/entities/integration';
+
+export type Entity = EmailTemplateAttachment;
+export const Route = 'email_template_attachment';
+export const UpperName = 'EmailTemplateAttachment';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  email_template_id: string;
+  multimedia_id: string;
+  name: string;
+}
+
+export interface IRepository {
+  create(data: ICreateRequest): Promise<string>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+
+export type IApi = IRepository;

package/src/modules/integration/emailTemplateAttachment/route.schema.ts

@@ -0,0 +1,12 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import { ICreateRequest } from './interfaces';
+import * as IShared from '../../../shared/interface';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  email_template_id: joi.string().uuid().required(),
+  multimedia_id: joi.string().uuid().required(),
+  name: joi.string().required(),
+};
+
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);

package/src/modules/integration/emailVerification/interfaces.ts

@@ -0,0 +1,30 @@
+import { EmailVerification } from '../../../shared/entities/integration';
+import * as IShared from '../../../shared/interface';
+
+export type Entity = EmailVerification;
+export const Route = 'email_verification';
+export const UpperName = 'EmailVerification';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IIsVerifiedRequest {
+  email: string;
+}
+
+export interface ISendVerificationRequest {
+  email: string;
+}
+
+export interface IMarkAsVerifiedRequest {
+  email: string;
+  token: string;
+}
+
+export interface IRepository {
+  isVerified(selector: IIsVerifiedRequest): Promise<boolean>;
+  sendVerificationEmail(data: ISendVerificationRequest): Promise<void>;
+  markAsVerified(data: IMarkAsVerifiedRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+
+export type IApi = IRepository;

package/src/modules/integration/emailVerification/route.schema.ts

@@ -0,0 +1,34 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import { IIsVerifiedRequest, ISendVerificationRequest, IMarkAsVerifiedRequest } from './interfaces';
+
+export const isVerifiedQuery = joi
+  .object<IIsVerifiedRequest>()
+  .keys({
+    email: joi
+      .string()
+      .email({ tlds: { allow: false } })
+      .required(),
+  })
+  .messages(messages);
+
+export const sendVerificationBody = joi
+  .object<ISendVerificationRequest>()
+  .keys({
+    email: joi
+      .string()
+      .email({ tlds: { allow: false } })
+      .required(),
+  })
+  .messages(messages);
+
+export const markAsVerifiedBody = joi
+  .object<IMarkAsVerifiedRequest>()
+  .keys({
+    email: joi
+      .string()
+      .email({ tlds: { allow: false } })
+      .required(),
+    token: joi.string().uuid().required(),
+  })
+  .messages(messages);

package/src/modules/integration/googleFilePermission/interfaces.ts

@@ -0,0 +1,32 @@
+import * as IShared from '../../../shared/interface';
+import { GoogleFilePermission } from '../../../shared/entities/integration';
+
+export type Entity = GoogleFilePermission;
+export const Route = 'google_file_permission';
+export const UpperName = 'GoogleFilePermission';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type IFindRequest = Record<string, unknown>;
+
+export interface ICreateRequest {
+  file_id: string;
+  email: string;
+}
+
+export interface ICreateRequestRepository extends ICreateRequest {
+  permission_id: string;
+}
+
+export interface IController {
+  create(data: ICreateRequest): Promise<Entity>;
+  findById(shared: IShared.IFindByIdRequest): Promise<Entity | null>;
+  find(): Promise<Entity[]>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}
+
+export interface IRepository {
+  create(data: ICreateRequestRepository): Promise<Entity>;
+  findById(shared: IShared.IFindByIdRequest): Promise<Entity | null>;
+  find(): Promise<Entity[]>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}

package/src/modules/integration/googleFilePermission/route.schema.ts

@@ -0,0 +1,15 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import { ICreateRequest } from './interfaces';
+
+import * as IShared from '../../../shared/interface';
+
+export const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  email: joi
+    .string()
+    .email({ tlds: { allow: false } })
+    .required(),
+  file_id: joi.string().required(),
+};
+
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);

package/src/modules/integration/googleSheets/interfaces.ts

@@ -0,0 +1,98 @@
+import { DocumentHeader } from '../../../shared/entities/stock';
+import { Persona } from '../../../shared/entities/user';
+import * as IShared from '../../../shared/interface';
+
+export const Route = 'google';
+export const UpperName = 'Google';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IGetUserData
+  extends Pick<
+    DocumentHeader,
+    | 'document_number'
+    | 'owner_number'
+    | 'billing_persona_nif'
+    | 'billing_persona_name'
+    | 'billing_persona_email'
+    | 'billing_persona_telephone'
+    | 'billing_persona_address_street'
+    | 'billing_persona_address_locality'
+    | 'billing_persona_address_postal_code'
+    | 'billing_persona_address_country_name'
+    | 'delivery_persona_name'
+    | 'delivery_persona_email'
+    | 'delivery_persona_telephone'
+    | 'delivery_persona_address_street'
+    | 'delivery_persona_address_locality'
+    | 'delivery_persona_address_postal_code'
+    | 'delivery_persona_address_country_name'
+  > {
+  emission_date: string;
+  store_operator_id: string | null;
+  store_operator_name: string | null;
+  store_operator_number: number | null;
+  reason_for_exemption_name: string | null;
+  contact_persona_name: Persona['name'];
+  contact_persona_email: Persona['email'];
+  contact_persona_telephone: Persona['telephone'];
+}
+
+export interface IUpdateRequest {
+  document_name: string;
+  client_data?: IGetUserData;
+}
+export interface ICloneRequest {
+  document_name: string;
+}
+
+export interface ICloneResponse {
+  spreadsheetId: string;
+}
+
+export type IGetProductGroup =
+  | 'cortinado'
+  | 'tapete'
+  | 'estore'
+  | 'estofo'
+  | 'almofada'
+  | 'outros'
+  | 'calhas&varões'
+  | 'papel'
+  | 'varoes'
+  | 'terceiros';
+
+export type IGetProductType =
+  | 'confecção'
+  | 'calha'
+  | 'tecido 1'
+  | 'tecido 2'
+  | 'varoes'
+  | 'livre'
+  | 'papel';
+
+export interface IGetProduct {
+  index: number; // line index in sheet's config tab
+  group: IGetProductGroup;
+  type: IGetProductType;
+  quantity: number;
+  reference: string;
+  designation: string;
+  discount: number;
+  price_sale: number;
+  price_cost: number;
+}
+export interface IGetDataResponse {
+  products: IGetProduct[];
+}
+
+export interface IExportRequest {
+  spreadsheetId: string;
+  document_header_id: string;
+}
+
+export interface IController {
+  clone(params: IShared.IFindByIdRequest, data?: ICloneRequest): Promise<ICloneResponse>;
+  export(params: IExportRequest): Promise<string>;
+  getData(params: IShared.IFindByIdRequest): Promise<IGetDataResponse>;
+  update(params: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+}