@nomalism-com/types 0.33.88 → 0.34.2

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

@@ -0,0 +1,62 @@
+import * as IShared from '../../../shared/interface';
+import { PromotionAssoc, Promotion, Location } from '../../../shared/entities';
+
+export type Entity = PromotionAssoc;
+export const Route = 'promotion_assoc';
+export const UpperName = 'PromotionAssoc';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+interface IFindDetailedResponse extends Entity {
+  location: Location | null;
+  promotion: Promotion;
+}
+
+// omit any unnecessary fields
+export type IFindByIdResponse = Omit<IFindDetailedResponse, 'location' | 'promotion'>;
+
+// omit any unnecessary fields
+export type IFindByOwnerIdResponse = Omit<IFindDetailedResponse, ''>;
+
+export type IFindRequest = Record<string, unknown>;
+
+// omit any unnecessary fields
+export type IFindResponse = Omit<IFindDetailedResponse, 'location' | 'promotion'>;
+
+export interface IFindPaginatedRequest extends IFindRequest, IShared.IPaginationRequest {}
+
+export type IFindWithPaginationResponse = IShared.IPaginationResponse<
+  Omit<IFindDetailedResponse, 'location' | 'promotion'>
+>;
+
+export interface ICreateRequest {
+  // create fields
+  client_id: string;
+  location_id: string;
+  product_id: string;
+  promotion_id: string;
+}
+
+export interface IUpdateRequest {
+  // updatable fields
+  client_id?: string;
+  location_id?: string;
+  product_id?: string;
+  promotion_id?: string;
+}
+
+export interface IRepository {
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindByIdResponse | null>;
+
+  findByOwnerId(params: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+  find(selector: IFindRequest): Promise<IFindResponse[]>;
+  findPaginated(selector: IFindPaginatedRequest): Promise<IFindWithPaginationResponse>;
+
+  create(data: ICreateRequest): Promise<IFindByOwnerIdResponse>;
+  update(
+    selector: IShared.IFindByIdRequest,
+    data: IUpdateRequest,
+  ): Promise<IFindByOwnerIdResponse | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<IFindByOwnerIdResponse | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

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

@@ -0,0 +1,35 @@
+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> = {
+  promotion_id: joi.string().uuid().required(),
+  product_id: joi.string().uuid().optional().allow(null),
+  client_id: joi.string().uuid().optional().allow(null),
+  location_id: joi.string().uuid().optional().allow(null),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  promotion_id: joi.string().uuid().optional(),
+  client_id: joi.string().uuid().optional().allow(null),
+  location_id: joi.string().uuid().optional().allow(null),
+  product_id: joi.string().uuid().optional().allow(null),
+};
+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/queryList/interfaces.ts

@@ -0,0 +1,56 @@
+import * as IShared from '../../../shared/interface';
+import { QueryList, QueryParameter } from '../../../shared/entities';
+
+export type Entity = QueryList;
+export const Route = 'query';
+export const UpperName = 'QueryList';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  label: string;
+  code: string;
+  group: string | null;
+}
+
+export interface IUpdateRequest {
+  label?: string;
+  code?: string;
+  group?: string | null;
+}
+
+export interface IFindResponse extends QueryList {
+  parameters: QueryParameter[];
+}
+
+export const executeOutput = ['csv', 'pdf', 'xlsx', 'json'] as const;
+
+export type IExecuteOutput = (typeof executeOutput)[number];
+
+type IParameterDataType = string | Date | number | boolean | null | undefined;
+
+export type IExecuteInputParameters = Record<string, IParameterDataType>;
+
+export interface IExecuteRequest extends IExecuteInputParameters {
+  query_id: string;
+  output: IExecuteOutput;
+  token?: string;
+}
+
+export interface IExecuteResponse extends IFindResponse {
+  outputParameters: QueryParameter[];
+  data: IParameterDataType[][];
+}
+
+export interface IRepository {
+  find(): Promise<IFindResponse[]>;
+  findById(selector: IShared.IFindByIdRequest): Promise<IFindResponse | null>;
+  create(data: ICreateRequest): Promise<IFindResponse>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<IFindResponse | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+}
+
+export type IApi = Omit<IRepository, 'execute'> & {
+  execute(data: IExecuteRequest): Promise<IExecuteResponse>;
+};
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

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

@@ -0,0 +1,37 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { ICreateRequest, IUpdateRequest, IExecuteRequest, executeOutput } from './interfaces';
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  code: joi.string().required(),
+  label: joi.string().required(),
+  group: joi.string().allow(null).required(),
+};
+
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  code: joi.string().optional(),
+  label: joi.string().optional(),
+  group: joi.string().allow(null).optional(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);
+
+export const executeBodyKeys: IShared.IRouteRequest<IExecuteRequest> = {
+  output: joi
+    .string()
+    .valid(...executeOutput)
+    .required(),
+  query_id: joi.string().uuid().required(),
+  token: joi.string().optional(),
+};
+
+export const executeBody = joi
+  .object()
+  .keys(executeBodyKeys)
+  .pattern(joi.string(), joi.any())
+  .optional()
+  .messages(messages);

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

@@ -0,0 +1,72 @@
+import * as IShared from '../../../shared/interface';
+import { QueryParameter } from '../../../shared/entities';
+
+export type Entity = QueryParameter;
+export const Route = 'query_parameter';
+export const UpperName = 'QueryParameter';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export const QueryParameterDatatypeEnum: {
+  boolean: 'boolean';
+  decimal: 'decimal';
+  integer: 'integer';
+  text: 'text';
+  date: 'date';
+  month: 'month';
+  idnr: 'idnr';
+  link: 'link';
+  user: 'user';
+  hidden: 'hidden';
+} = {
+  boolean: 'boolean',
+  decimal: 'decimal',
+  integer: 'integer',
+  text: 'text',
+  date: 'date',
+  month: 'month',
+  idnr: 'idnr',
+  link: 'link',
+  user: 'user',
+  hidden: 'hidden',
+};
+
+export type IQueryParameterDatatype =
+  (typeof QueryParameterDatatypeEnum)[keyof typeof QueryParameterDatatypeEnum];
+
+export const queryParametersDatatypes = Object.keys(QueryParameterDatatypeEnum);
+
+export interface ICreateRequest {
+  label: string;
+  accessor: string;
+  datatype: IQueryParameterDatatype;
+  suffix: string | null;
+  preffix: string | null;
+  input: boolean;
+  width: number | null;
+  output: boolean;
+  query_id: string;
+}
+
+export interface IUpdateRequest {
+  label?: string;
+  accessor?: string;
+  width?: number;
+  datatype?: IQueryParameterDatatype;
+  suffix?: string | null;
+  preffix?: string | null;
+  input?: boolean;
+  output?: boolean;
+}
+
+export type IFindByOwnerIdResponse = Entity;
+
+export interface IRepository {
+  find(): Promise<Entity[]>;
+  findById(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<Entity | null>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+  findByOwnerId(selector: IShared.IFindByOwnerIdRequest): Promise<IFindByOwnerIdResponse[]>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

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

@@ -0,0 +1,36 @@
+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> = {
+  label: joi.string().required(),
+  accessor: joi.string().required(),
+  datatype: joi
+    .string()
+    .valid(...Object.values(IShared.IDataTypeEnum))
+    .required(),
+  input: joi.boolean().default(false),
+  output: joi.boolean().default(false),
+  preffix: joi.string().allow(null).required(),
+  suffix: joi.string().allow(null).required(),
+  query_id: joi.string().uuid().required(),
+  width: joi.number().default(55),
+};
+
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+// update body validation
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  label: joi.string().optional(),
+  accessor: joi.string().optional(),
+  datatype: joi.string().valid(...Object.values(IShared.IDataTypeEnum)),
+  input: joi.boolean().optional(),
+  output: joi.boolean().optional(),
+  preffix: joi.string().allow(null).optional(),
+  suffix: joi.string().allow(null).optional(),
+  width: joi.number().optional(),
+};
+
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

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

@@ -0,0 +1,12 @@
+import * as IShared from '../../../shared/interface';
+
+export const Route = 'recurrent_tasks';
+export const UpperName = 'RecurrentTasks';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface IRepository {
+  from_master(): Promise<string>;
+  from_master_checked(): Promise<string>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

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

@@ -0,0 +1,23 @@
+import * as IShared from '../../../shared/interface';
+import { ReturnReason } from '../../../shared/entities';
+
+export type Entity = ReturnReason;
+export const Route = 'return_reason';
+export const UpperName = 'ReturnReason';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  reason: string;
+}
+
+export interface IUpdateRequest {
+  reason: string;
+}
+export interface IRepository {
+  create(data: ICreateRequest): Promise<Entity>;
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<Entity | null>;
+  find(): Promise<Entity[]>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<Entity | null>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

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

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

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

@@ -0,0 +1,37 @@
+import * as IShared from '../../../shared/interface';
+import { SavedEmPicking } from '../../../shared/entities';
+import { IUnfinishedPickingLineGroupExtended } from '../../document/materialEntrance/interfaces';
+
+export type Entity = SavedEmPicking;
+export const Route = 'saved_em_picking';
+export const UpperName = 'SavedEmPicking';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export type ISavedEmPickingData = Pick<
+  IUnfinishedPickingLineGroupExtended,
+  'clientOrders' | 'stock' | 'not_ok'
+>;
+
+export interface ICreateRequest {
+  provider_id: string;
+  document_header_id: string;
+  document_line_group_id: string;
+  data: ISavedEmPickingData;
+}
+
+export interface ICreateManyRequest {
+  items: ICreateRequest[];
+}
+
+export interface IDeleteManyRequest {
+  ids: string[];
+}
+
+export interface IRepository {
+  create(data: ICreateRequest): Promise<string>;
+  createMany(data: ICreateManyRequest): Promise<string[]>;
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+  deleteMany(data: IDeleteManyRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

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

@@ -0,0 +1,113 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import {
+  ICreateManyRequest,
+  ICreateRequest,
+  ISavedEmPickingData,
+  type IDeleteManyRequest,
+} from './interfaces';
+
+import {
+  IEntradaDeMaterialClientOrder,
+  IEntradaDeMaterialNC,
+  IEntradaDeMaterialStock,
+  createMaterialEntranceClientOrderOptions,
+  createMaterialEntranceStockOptions,
+  createMaterialEntranceStockWithoutOrderOptions,
+} from '../../document/materialEntrance/interfaces';
+
+const entradaDeMaterialClientOrderBodyKeys: IShared.IRouteRequest<IEntradaDeMaterialClientOrder> = {
+  ef_dla_id: joi.string().uuid().required(),
+  ordered_quantity: joi.number().positive().required(),
+  pc_virtual_name: joi.string().required(),
+  pc_dh_id: joi.string().uuid().required(),
+  pc_dh_number: joi.number().integer().positive().required(),
+  pc_dla_id: joi.string().uuid().required(),
+  pc_sheet: joi.string().allow(null),
+  pc_created_by: joi.string().uuid().required(),
+
+  document_line_id: joi.string().uuid().required(),
+  quantity: joi.number().positive().allow(0).required(),
+  option: joi
+    .string()
+    .valid(...createMaterialEntranceClientOrderOptions)
+    .allow(null)
+    .required(),
+  note: joi.string().allow(null),
+  printed: joi.string().allow(null),
+};
+
+const entradaDeMaterialClientOrderBody = joi
+  .object()
+  .keys(entradaDeMaterialClientOrderBodyKeys)
+  .messages(messages);
+
+const entradaDeMaterialStockBodyKeys: IShared.IRouteRequest<IEntradaDeMaterialStock> = {
+  ef_dla_id: joi.string().uuid().allow(null).required(),
+  ordered_quantity: joi.number().positive().allow(0).required(),
+
+  document_line_id: joi.string().uuid().required(),
+  quantity: joi.number().positive().allow(0).required(),
+  option: joi
+    .string()
+    .valid(...createMaterialEntranceStockOptions, ...createMaterialEntranceStockWithoutOrderOptions)
+    .allow(null)
+    .required(),
+  note: joi.string().allow(null),
+  printed: joi.string().allow(null),
+};
+
+const entradaDeMaterialStockBody = joi
+  .object()
+  .keys(entradaDeMaterialStockBodyKeys)
+  .required()
+
+  .messages(messages);
+
+const entradaDeMaterialNCBodyKeys: IShared.IRouteRequest<IEntradaDeMaterialNC> = {
+  ef_dla_id: joi.valid(null).required(),
+  ordered_quantity: joi.number().valid(0).required(),
+
+  document_line_id: joi.string().uuid().required(),
+  quantity: joi.number().positive().allow(0).required(),
+  option: joi.valid(null).required(),
+  note: joi.string().allow(null),
+  printed: joi.string().allow(null),
+};
+
+const entradaDeMaterialNCBody = joi.object().keys(entradaDeMaterialNCBodyKeys).messages(messages);
+
+const entradaDeMaterialDocumentHeaderBodyKeys: IShared.IRouteRequest<ISavedEmPickingData> = {
+  clientOrders: joi.array().items(entradaDeMaterialClientOrderBody),
+  stock: entradaDeMaterialStockBody,
+  not_ok: entradaDeMaterialNCBody,
+};
+
+const entradaDeMaterialDocumentHeaderBody = joi
+  .object()
+  .keys(entradaDeMaterialDocumentHeaderBodyKeys)
+  .messages(messages);
+
+// create body validation
+const createBodyKeys: IShared.IRouteRequest<ICreateRequest> = {
+  provider_id: joi.string().uuid().required(),
+  document_header_id: joi.string().uuid().required(),
+  document_line_group_id: joi.string().uuid().required(),
+  data: entradaDeMaterialDocumentHeaderBody,
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+export const createManyBody = joi
+  .object<ICreateManyRequest>()
+  .keys({
+    items: joi.array().items(createBody).required(),
+  })
+  .messages(messages);
+
+export const deleteManyBody = joi
+  .object<IDeleteManyRequest>()
+  .keys({
+    ids: joi.array().items(joi.string().uuid().required()).required(),
+  })
+  .messages(messages);

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

@@ -0,0 +1,32 @@
+import * as IShared from '../../../shared/interface';
+import { SavedProviderProposal } from '../../../shared/entities';
+
+export type Entity = SavedProviderProposal;
+export const Route = 'saved_provider_proposal';
+export const UpperName = 'SavedProviderProposal';
+export const LowerName = UpperName[0].toLowerCase() + UpperName.substring(1);
+
+export interface ICreateRequest {
+  provider_id: string;
+  product_id: string;
+  quantity: number;
+}
+
+export interface IFindManyResponse {
+  product_id: string;
+  quantity: number;
+}
+
+export type IUpdateRequest = Omit<ICreateRequest, 'provider_id' | 'product_id'>;
+
+export interface IRepository {
+  findByProviderId(selector: IShared.IFindByIdRequest): Promise<IFindManyResponse[]>;
+
+  create(data: ICreateRequest): Promise<void>;
+
+  update(selector: IShared.IFindByIdRequest, data: IUpdateRequest): Promise<void>;
+
+  deleteOne(selector: IShared.IFindByIdRequest): Promise<void>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;

package/src/modules/stock/savedProviderProposal/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> = {
+  provider_id: joi.string().uuid().required(),
+  product_id: joi.string().uuid().required(),
+  quantity: joi.number().positive().required(),
+};
+export const createBody = joi.object().keys(createBodyKeys).messages(messages);
+
+const updateBodyKeys: IShared.IRouteRequest<IUpdateRequest> = {
+  quantity: joi.number().positive().required(),
+};
+export const updateBody = joi.object().keys(updateBodyKeys).messages(messages);

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

@@ -0,0 +1,48 @@
+import * as IShared from '../../../shared/interface';
+
+export interface IFindByDocumentLineStateRequest {
+  document_type_id: 100 | 116;
+  document_line_state: string;
+}
+
+export interface IFindByDocumentLineStateResponse {
+  document_header_id: string;
+  document_number: string;
+  identifier: string | null;
+  created_at: Date;
+  created_by: string;
+  who_handles: string | null;
+  tags: string | null;
+  upfront_total: number;
+  unread: boolean;
+}
+
+export interface IFindByStateRequest {
+  document_type_id: number;
+  search_value?: string | null;
+}
+
+export interface IFindByStateResponse {
+  name: string;
+  count: number;
+  unread: boolean;
+}
+
+export interface IFindSideMenuCountersResponse {
+  counts: Record<string, number>;
+  timestamp: string;
+}
+interface IRepository {
+  findSideMenuStoreOperators(): Promise<string[]>;
+
+  findByState(data: IFindByStateRequest): Promise<IFindByStateResponse[]>;
+
+  findByDocumentLineState(
+    params: IFindByDocumentLineStateRequest,
+  ): Promise<IFindByDocumentLineStateResponse[]>;
+
+  findSideMenuCounters(): Promise<IFindSideMenuCountersResponse>;
+}
+
+export type IController = IShared.IEntityWithUserToken<IRepository>;
+export {};

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

@@ -0,0 +1,20 @@
+import joi from 'joi';
+import { messages } from '../../../shared/messages';
+import * as IShared from '../../../shared/interface';
+import { IFindByDocumentLineStateRequest, IFindByStateRequest } from './interface';
+
+const findByDocumentLineStateQueryKeys: IShared.IRouteRequest<IFindByDocumentLineStateRequest> = {
+  document_type_id: joi.number().valid(100, 116).required(),
+  document_line_state: joi.string().required(),
+};
+
+const findByStateQueryKeys: IShared.IRouteRequest<IFindByStateRequest> = {
+  document_type_id: joi.number().integer().positive().required(),
+  search_value: joi.string().allow(null).empty('').optional(),
+};
+export const findByStateQuery = joi.object().keys(findByStateQueryKeys).messages(messages);
+
+export const findByDocumentLineStateQuery = joi
+  .object()
+  .keys(findByDocumentLineStateQueryKeys)
+  .messages(messages);