@nomalism-com/types 0.37.6 → 0.37.7

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

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

@@ -0,0 +1,63 @@
+import * as IShared from '../../../shared/interface';
+import { VatTaxZone, VatTax } from '../../../shared/entities/stock';
+
+export type Entity = VatTaxZone;
+export const Route = 'vat_tax_zone';
+export const UpperName = 'VatTaxZone';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+interface IFindDetailedResponse extends Entity {
+  vat_tax: VatTax;
+}
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, 'vat_tax'>;
+
+// omit any unnecessary fields
+export type IFindByOwnerIdResponse = Omit<IFindDetailedResponse, 'vat_tax'>;
+
+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, 'vat_tax'>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  name: string;
+  value: number;
+  vat_tax_id: string;
+  country_id: string;
+  saft_code: string;
+  external_id: string | null;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  name?: string;
+  value?: number;
+  vat_tax_id?: string;
+  country_id?: string;
+  saft_code?: string;
+  external_id?: string | null;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  findMinified(selector: 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/vatTaxZone/route.schema.ts

@@ -0,0 +1,42 @@
+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(),
+  value: joi.number().positive().required(),
+  vat_tax_id: joi.string().uuid().required(),
+  country_id: joi.string().uuid().required(),
+  saft_code: joi.string().required(),
+  external_id: joi.string().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  name: joi.string().optional(),
+  value: joi.number().positive().optional(),
+  vat_tax_id: joi.string().uuid().optional(),
+  country_id: joi.string().uuid().optional(),
+  saft_code: joi.string().optional(),
+  external_id: joi.string().optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+const findQueryKeys: IShared.IRouteRequest<IFindRequest> = {
+  country_id: joi.string().uuid().optional(),
+  vat_tax_id: joi.string().uuid().optional(),
+};
+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/vatValidation/interfaces.ts

@@ -0,0 +1,10 @@
+import { VatValidation } from '../../../shared/entities/stock';
+
+export type Entity = VatValidation;
+export const Route = 'vat_validation';
+export const UpperName = 'VatValidation';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IRepository {
+  findByLatest(nif: string): Promise<Entity | null>;
+}

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

@@ -0,0 +1,8 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+
+const findByLatestBodyKeys = {
+  nif: joi.string().required(),
+};
+
+export const findByLatestBody = joi.object().keys(findByLatestBodyKeys).messages(messages);

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

@@ -0,0 +1,64 @@
+import * as IShared from '../../../shared/interface';
+import { Workflow } from '../../../shared/entities/stock';
+import * as DocumentType from '../../supply/documentType/interfaces';
+import { IDocumentTypeUserType } from '../../supply/documentType/interfaces';
+
+export type Entity = Workflow;
+export const Route = 'workflow';
+export const UpperName = 'Workflow';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type IFindRequest = Record<string, unknown>;
+
+export interface ICreateRequest {
+  from_document_type_id: number;
+  to_document_type_id: number;
+
+  transition_name: string;
+
+  is_active: boolean;
+}
+
+export interface IUpdateRequest {
+  from_document_type_id?: number;
+  to_document_type_id?: number;
+
+  transition_name?: string;
+
+  is_active?: boolean;
+}
+
+export interface IFindByQueryRequest extends IShared.IPaginationRequest {
+  id?: number;
+  from?: number;
+}
+
+export interface IFindByOwnerIdRequest {
+  from?: number;
+  to?: number;
+  user_type?: IDocumentTypeUserType;
+}
+
+export interface IFindByOwnerIdResponse extends Entity {
+  from_document_type: DocumentType.Entity | null;
+  to_document_type: DocumentType.Entity | null;
+}
+
+export interface IRepository {
+  findById(id: number): Promise<Workflow | null>;
+  findByQuery(data: IFindByQueryRequest): Promise<IShared.IPaginationResponse<Workflow>>;
+
+  findByOwnerId(data: IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  find(data: IFindRequest): Promise<IFindByOwnerIdResponse[]>;
+
+  create(data: ICreateRequest): Promise<IFindByOwnerIdResponse>;
+  update(
+    selector: IShared.IFindByIdNumberRequest,
+    data: IUpdateRequest,
+  ): Promise<IFindByOwnerIdResponse | null>;
+  deleteOne(selector: IShared.IFindByIdNumberRequest): Promise<IFindByOwnerIdResponse | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+
+export type IApi = Omit<IRepository, 'findById' | 'findByQuery'>;

package/src/modules/stock/workflow/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, IFindByOwnerIdRequest } from './interfaces';
+import { documentTypeUserTypes } from '../../supply/documentType/interfaces';
+
+const postBodyValidatorKeys: IShared.IRouteRequest<ICreateRequest> = {
+  from_document_type_id: joi.number().integer(),
+  to_document_type_id: joi.number().integer(),
+  transition_name: joi.string().required(),
+  is_active: joi.boolean().default(false).optional(),
+};
+export const postBodyValidator = joi.object().keys(postBodyValidatorKeys).messages(messages);
+
+const putBodyValidatorKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  from_document_type_id: joi.number().integer(),
+  to_document_type_id: joi.number().integer(),
+  transition_name: joi.string(),
+  is_active: joi.boolean().optional(),
+};
+export const putBodyValidator = joi.object().keys(putBodyValidatorKeys).messages(messages);
+
+const getByOwnerQueryKeys: IShared.IRouteRequest<IFindByOwnerIdRequest> = {
+  from: joi.number().integer().allow(null),
+  to: joi.number().integer().allow(null),
+  user_type: joi.string().valid(...documentTypeUserTypes),
+};
+export const getByOwnerQuery = joi.object().keys(getByOwnerQueryKeys).messages(messages);