@nomalism-com/types 0.33.88 → 0.34.2

package/src/modules/user/userPositions/route.schema.ts

@@ -0,0 +1,29 @@
+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(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().required(),
+};
+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/user/userTokens/interface.ts

@@ -0,0 +1,41 @@
+import * as IShared from '../../../shared/interface';
+import { UserTokens } from '../../../shared/entities';
+
+export type Entity = UserTokens;
+export const Route = 'user_token';
+export const UpperName = 'UserTokens';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type IFindRequest = Record<string, unknown>;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<UserTokens>;
+
+export interface ICreateRequest {
+  // create fields
+  user_id: string;
+  expires_date: Date;
+  refresh_token: string;
+}
+
+export interface IUpdateRequest {
+  consumed?: boolean;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+  findByToken(id: string): Promise<Entity | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<Entity[]>;
+  find(selector: IFindRequest): Promise<Entity[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  generate(user_id: string): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<Entity | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}
+
+export type IApi = Omit<IRepository, 'generate' | 'findByToken' | 'update'>;
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/user/userTokens/route.schema.ts

@@ -0,0 +1,17 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindRequest, IFindPaginatedRequest } from './interface';
+
+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/user/users/interface.ts

@@ -0,0 +1,177 @@
+import * as IShared from '../../../shared/interface';
+import {
+  Providers,
+  Country,
+  Language,
+  ProviderType,
+  ReasonForExemption,
+  Persona,
+  Clients,
+  SegmentsArea,
+  ClientType,
+  StoreOperator,
+  UserPositions,
+  Commissioner,
+  Users,
+  PaymentMethods,
+  MaturityDates,
+  DeliveryMethods,
+  Vehicles,
+  Theme,
+} from '../../../shared/entities';
+
+export type Entity = Users;
+export type EntityWithoutPassword = Omit<Users, 'password'>;
+export const Route = 'users';
+export const UpperName = 'Users';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+interface IMainPersona extends Persona {
+  country: Country | null;
+  reason_for_exemption: ReasonForExemption | null;
+}
+
+interface IStoreOperator extends Pick<StoreOperator, 'id' | 'location_id'> {
+  main_persona: Pick<Persona, 'name' | 'email'>;
+  theme: Pick<Theme, 'colors'>;
+}
+
+export interface IFindByAccountResponse extends Pick<Entity, 'id' | 'account'> {
+  store_operator: IStoreOperator;
+}
+
+// omit any unnecessary fields
+export interface IFindByIdResponse extends EntityWithoutPassword {
+  provider:
+    | (Providers & {
+        country: Country | null;
+        language: Language | null;
+        support_language: Language | null;
+        provider_type: ProviderType | null;
+        default_payment_method: PaymentMethods | null;
+        default_maturity_date: MaturityDates | null;
+        default_delivery_method: DeliveryMethods | null;
+        default_vehicle: Vehicles | null;
+        main_persona: IMainPersona;
+      })
+    | null;
+  client:
+    | (Clients & {
+        country: Country | null;
+        language: Language | null;
+        segments_area: SegmentsArea | null;
+        client_type: ClientType | null;
+        default_payment_method: PaymentMethods | null;
+        default_maturity_date: MaturityDates | null;
+        default_delivery_method: DeliveryMethods | null;
+        default_vehicle: Vehicles | null;
+        main_persona: IMainPersona;
+      })
+    | null;
+  store_operator:
+    | (StoreOperator & {
+        user_position: UserPositions | null;
+        support_language: Language | null;
+        main_persona: IMainPersona;
+      })
+    | null;
+  commissioner:
+    | (Commissioner & {
+        country: Country | null;
+        language: Language | null;
+        default_payment_method: PaymentMethods | null;
+        default_maturity_date: MaturityDates | null;
+        default_delivery_method: DeliveryMethods | null;
+        default_vehicle: Vehicles | null;
+        main_persona: IMainPersona;
+      })
+    | null;
+}
+
+export type IFindRequest = Record<string, unknown>;
+
+// omit any unnecessary fields
+export type IFindResponse = EntityWithoutPassword;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<EntityWithoutPassword>;
+
+export interface IFindProvidersWithClientIdResponse {
+  name: string;
+  provider_id: string;
+  client_id: string | null;
+}
+
+export interface IFindProvidersWithClientIdRequest {
+  provider_ids: string[];
+}
+
+export interface ICreateRequest {
+  // create fields
+  account: string | null;
+  password: string;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  account?: string | null;
+  old_password?: string;
+  password?: string;
+}
+
+export interface IUpdatePassword {
+  password: string;
+}
+
+export interface ISendForgotPassword {
+  token: string;
+  user: {
+    name: string;
+    email: string;
+  };
+}
+
+export interface IFindFromClientOrProviderRequest {
+  ids: string[];
+}
+
+export interface IFindFromClientOrProviderResponse {
+  name: string;
+  provider: string | null;
+  provider_id: string | null;
+  client_id: string | null;
+  iban: string | null;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findMinified(params?: IShared.IFindMinifiedRequest): Promise<IShared.IFindMinifiedResponse[]>;
+
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  resetPassword(id: string, data: IUpdatePassword): Promise<Users>;
+
+  removeAccess(user_id: string): Promise<boolean>;
+
+  create(data: ICreateRequest): Promise<IFindResponse>;
+
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<IFindResponse | null>;
+
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<IFindResponse | null>;
+
+  findProvidersWithClientId(
+    data: IFindProvidersWithClientIdRequest,
+  ): Promise<IFindProvidersWithClientIdResponse[]>;
+
+  findFromClientOrProviderId(
+    data: IFindFromClientOrProviderRequest,
+  ): Promise<IFindFromClientOrProviderResponse[]>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+
+export type IApi = Omit<IRepository, 'resetPassword' | 'removeAccess'>;

package/src/modules/user/users/route.schema.ts

@@ -0,0 +1,58 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  IFindRequest,
+  IFindPaginatedRequest,
+  ICreateRequest,
+  IUpdateRequest,
+  IFindProvidersWithClientIdRequest,
+  IFindFromClientOrProviderRequest,
+} from './interface';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  account: joi.string().allow(null).required(),
+  password: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  account: joi.string().optional(),
+  old_password: joi.string().optional(),
+  password: joi.string().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {};
+export const findQuery = joi.object().keys(findQueryKeys).messages(messages);
+
+const findProvidersWithClientIdQueryKeys: IShared.IRouteRequest<IFindProvidersWithClientIdRequest> =
+  {
+    provider_ids: joi.array().items(joi.string().uuid().required()).optional(),
+  };
+
+export const findProvidersWithClientIdQuery = joi
+  .object()
+  .keys(findProvidersWithClientIdQueryKeys)
+  .messages(messages);
+
+const findFromClientOrProviderIdBodyKeys: IShared.IRouteRequest<IFindFromClientOrProviderRequest> =
+  {
+    ids: joi.array().items(joi.string().uuid().required()).required(),
+  };
+
+export const findFromClientOrProviderIdBody = joi
+  .object()
+  .keys(findFromClientOrProviderIdBodyKeys)
+  .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/user/vehicles/interfaces.ts

@@ -0,0 +1,31 @@
+import * as IShared from '../../../shared/interface';
+import { Vehicles } from '../../../shared/entities';
+
+export type Entity = Vehicles;
+export const Route = 'vehicles';
+export const UpperName = 'Vehicles';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  description: string;
+  vehicle_id: number;
+  number_plate: string;
+}
+
+export interface IUpdateRequest {
+  description?: string;
+  vehicle_id?: number;
+  number_plate?: string;
+}
+
+export interface IRepository {
+  find(): Promise<Entity[]>;
+  findById(id: string): Promise<Entity | null>;
+  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>;
+
+export type IApi = Omit<IRepository, 'findById'>;

package/src/modules/user/vehicles/route.schema.ts

@@ -0,0 +1,17 @@
+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> = {
+  description: joi.string().required(),
+  vehicle_id: joi.number().integer().required(),
+  number_plate: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  description: joi.string(),
+  vehicle_id: joi.number().integer(),
+  number_plate: joi.string(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

package/src/modules/user/zipCode/interfaces.ts

@@ -0,0 +1,27 @@
+import { ZipCode } from '../../../shared/entities';
+
+export type Entity = ZipCode;
+export const Route = 'zip_code';
+export const UpperName = 'ZipCode';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  postal_code: string;
+  address: string;
+  locality: string;
+  parish: string;
+  county: string;
+  county_code: number;
+  district: string;
+  latitude: string;
+  longitude: string;
+}
+
+export interface IFindByPostalCode {
+  postal_code: string;
+}
+
+export interface IRepository {
+  findByPostalCode(params: IFindByPostalCode): Promise<Entity[]>;
+  create(data: ICreateRequest[]): Promise<void>;
+}

package/src/modules/user/zipCode/route.schema.ts

@@ -0,0 +1,26 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+
+import { IFindByPostalCode, ICreateRequest } from './interfaces';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  address: joi.string().required(),
+  county: joi.string().required(),
+  county_code: joi.number().required(),
+  postal_code: joi.string().trim(true).lowercase().required(),
+  locality: joi.string().required(),
+  parish: joi.string().required(),
+  district: joi.string().required(),
+  latitude: joi.string().required(),
+  longitude: joi.string().required(),
+};
+
+export const createBody = joi.array().items(joi.object().keys(createBodyKeys)).messages(messages);
+
+// findByPostalCode body validation
+const findByPostalCodeBodyKeys: IShared.IRouteRequest<IFindByPostalCode> = {
+  postal_code: joi.string().trim(true).lowercase().required(),
+};
+
+export const findByPostalCodeBody = joi.object().keys(findByPostalCodeBodyKeys).messages(messages);

package/src/modules/view/adminPanel/interfaces.ts

@@ -0,0 +1,180 @@
+export const Route = 'admin_panel';
+export const UpperName = 'AdminPanel';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+// UTILS
+export interface ICalendar {
+  year: number;
+  month: number;
+  day: number;
+}
+
+// SERVER
+export interface IServiceStatus {
+  tier: string;
+  service: string;
+  color: string;
+  description: string;
+}
+
+export interface IServiceLogs {
+  name: string;
+  description: string;
+}
+
+export interface IPostgresBackup extends ICalendar {
+  done: boolean;
+  service: string;
+  size: number;
+}
+
+// GOOGLE SHEETS
+export interface IProposta {
+  label: string;
+  url: string;
+  done: boolean;
+  error: string | null;
+  lines: number;
+  groups: string;
+  duration: number;
+  created_at: Date;
+}
+
+export interface ITask extends ICalendar {
+  count: number;
+}
+
+export interface IStock {
+  created_at: Date;
+  inserts: number;
+  updates: number;
+  deletes: number;
+  error: string | null;
+}
+
+export interface IEncomenda extends ICalendar {
+  finds: number;
+  misses: number;
+  price_updates: number;
+  new_products: number;
+  pre_artigo_count: number;
+  error_count: number;
+}
+
+// OTHER SERVICES
+export interface IPrint extends ICalendar {
+  label: string;
+  completed: number;
+  undone: number;
+  unsent: number;
+  avg_time_to_complete: number;
+}
+
+export interface IEventstore extends ICalendar {
+  label: string;
+  count: number;
+  avg_response_time: number;
+  max_response_time: number;
+  min_response_time: number;
+}
+
+export interface IMoloni extends ICalendar {
+  label: string;
+  count: number;
+  error: number;
+}
+
+export interface IMoloniError {
+  label: string;
+  payload: string;
+  error: string;
+}
+
+export interface IProjectInfo extends ICalendar {
+  label: string;
+  email_sent: boolean;
+  document_header_created: boolean;
+  time_to_complete: number;
+}
+
+export interface IMultimedia extends ICalendar {
+  uploads: number;
+  size: number;
+}
+
+export interface IMultimediaSummary {
+  total: number;
+  obsolete: number;
+}
+
+export interface ICron extends ICalendar {
+  label: string;
+  avg_time_to_complete: number;
+  count: number;
+  error_count: number;
+}
+
+export interface IEmail extends ICalendar {
+  label: string;
+  count: number;
+  errors: number;
+  events: number;
+}
+
+export interface IError extends ICalendar {
+  label: string;
+  count: number;
+  description: string;
+}
+
+export interface IChat extends ICalendar {
+  count: number;
+  processed: number;
+  delivered: number;
+}
+
+export interface IKafka extends ICalendar {
+  topic: string;
+  avg_time_to_complete: number;
+  count: number;
+  error_count: number;
+}
+
+// GLOBAL
+export interface IGetDataRequest {
+  token: string;
+}
+
+export interface IGetDataResponse {
+  server: {
+    services: IServiceStatus[];
+    logs: IServiceLogs[];
+    certificates: string;
+    filesystem: string;
+    backups: IPostgresBackup[];
+  };
+  googleSheets: {
+    propostas: IProposta[];
+    tasks: ITask[];
+    stock: IStock[];
+    encomenda: IEncomenda[];
+  };
+  services: {
+    prints: IPrint[];
+    eventstores: IEventstore[];
+    moloniRequests: IMoloni[];
+    moloniErrors: IMoloniError[];
+    projectInfos: IProjectInfo[];
+    multimedias: IMultimedia[];
+    multimediaSummary: IMultimediaSummary;
+    crons: ICron[];
+    emails: IEmail[];
+    errors: IError[];
+    chats: IChat[];
+    kafka: IKafka[];
+  };
+}
+
+export interface IRepository {
+  getData(params: IGetDataRequest): Promise<IGetDataResponse>;
+}

package/src/modules/view/errorLog/interfaces.ts

@@ -0,0 +1,14 @@
+export const Route = 'error_handler';
+export const UpperName = 'ErrorHandler';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  service: string;
+  type: 'prisma' | 'unhandled' | 'axios' | 'webapp' | 'moloni' | 'kafka';
+  error: { name: string; message: string; stack?: string };
+  request?: { body?: unknown; query?: unknown; params?: unknown };
+}
+
+export interface IRepository {
+  create(data: ICreateRequest): Promise<void>;
+}

package/src/modules/view/errorLog/route.schema.ts

@@ -0,0 +1,22 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest } from './interfaces';
+
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  error: joi.object({
+    name: joi.string().required(),
+    message: joi.string().required(),
+    stack: joi.string().optional(),
+  }),
+  request: joi.object({
+    body: joi.any().optional(),
+    query: joi.any().optional(),
+    params: joi.any().optional(),
+  }),
+
+  service: joi.string().required(),
+  type: joi.string().valid('prisma', 'unhandled', 'axios', 'webapp'),
+};
+
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);

package/src/shared/entities/documentManagement.ts

@@ -0,0 +1,16 @@
+/**
+ * Model Multimedia
+ */
+
+export type Multimedia = {
+  id: string;
+  url: string;
+  filepath: string;
+  size: number;
+  hash: string;
+  content_type: string;
+  original_filename: string;
+  origin_id: string | null;
+  created_at: Date;
+  updated_at: Date;
+};