@muni-sanfer/types-gestor-documental 0.0.1-beta.0 → 0.0.1-beta.10

package/src/base/entities.ts

@@ -8,7 +8,8 @@ export const DocumentCategory = {
   Other: 'Other',
 } satisfies Record<string, DocumentCategory>;
 
-export type DocumentStatus = 'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded';
+export type DocumentStatus =
+  'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded' | 'Annulled';
 
 export const DocumentStatus = {
   Drafted: 'Drafted',
@@ -17,6 +18,7 @@ export const DocumentStatus = {
   Finished: 'Finished',
   Rejected: 'Rejected',
   Discarded: 'Discarded',
+  Annulled: 'Annulled',
 } satisfies Record<string, DocumentStatus>;
 
 export type DocumentAccessLevel = 'Public' | 'Restricted' | 'Secret' | 'Reserved';
@@ -45,7 +47,23 @@ export const DocumentParticipantStatus = {
 } satisfies Record<string, DocumentParticipantStatus>;
 
 export type DocumentTrackingAction =
-  'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded';
+  | 'Created'
+  | 'Updated'
+  | 'Submitted'
+  | 'Visaed'
+  | 'Signed'
+  | 'Rejected'
+  | 'Finished'
+  | 'Discarded'
+  | 'Numbered'
+  | 'NumberAnnulled'
+  | 'Annulled'
+  | 'Delivered'
+  | 'Derived'
+  | 'Reassigned'
+  | 'Dispatched'
+  | 'DispatchReturned'
+  | 'Received';
 
 export const DocumentTrackingAction = {
   Created: 'Created',
@@ -56,8 +74,47 @@ export const DocumentTrackingAction = {
   Rejected: 'Rejected',
   Finished: 'Finished',
   Discarded: 'Discarded',
+  Numbered: 'Numbered',
+  NumberAnnulled: 'NumberAnnulled',
+  Annulled: 'Annulled',
+  Delivered: 'Delivered',
+  Derived: 'Derived',
+  Reassigned: 'Reassigned',
+  Dispatched: 'Dispatched',
+  DispatchReturned: 'DispatchReturned',
+  Received: 'Received',
 } satisfies Record<string, DocumentTrackingAction>;
 
+export type DocumentOrigin = 'Internal' | 'DocDigital';
+
+export const DocumentOrigin = {
+  Internal: 'Internal',
+  DocDigital: 'DocDigital',
+} satisfies Record<string, DocumentOrigin>;
+
+export type DocumentDispatchStatus = 'Pending' | 'Dispatched' | 'Returned';
+
+export const DocumentDispatchStatus = {
+  Pending: 'Pending',
+  Dispatched: 'Dispatched',
+  Returned: 'Returned',
+} satisfies Record<string, DocumentDispatchStatus>;
+
+export type DocDigitalInboundStatus = 'Pending' | 'Registered' | 'Returned';
+
+export const DocDigitalInboundStatus = {
+  Pending: 'Pending',
+  Registered: 'Registered',
+  Returned: 'Returned',
+} satisfies Record<string, DocDigitalInboundStatus>;
+
+export type DocumentFlowStepType = 'Employee' | 'DirectorateHead';
+
+export const DocumentFlowStepType = {
+  Employee: 'Employee',
+  DirectorateHead: 'DirectorateHead',
+} satisfies Record<string, DocumentFlowStepType>;
+
 export type DocumentAttachmentType = 'File' | 'Link';
 
 export const DocumentAttachmentType = {
@@ -65,6 +122,132 @@ export const DocumentAttachmentType = {
   Link: 'Link',
 } satisfies Record<string, DocumentAttachmentType>;
 
+export type DocumentRecipientType = 'Employee' | 'Directorate' | 'Department';
+
+export const DocumentRecipientType = {
+  Employee: 'Employee',
+  Directorate: 'Directorate',
+  Department: 'Department',
+} satisfies Record<string, DocumentRecipientType>;
+
+export type DocumentDeliveryOrigin = 'Recipient' | 'Derivation';
+
+export const DocumentDeliveryOrigin = {
+  Recipient: 'Recipient',
+  Derivation: 'Derivation',
+} satisfies Record<string, DocumentDeliveryOrigin>;
+
+export type DocumentInstruction = 'Knowledge' | 'Inform' | 'Respond' | 'Archive';
+
+export const DocumentInstruction = {
+  Knowledge: 'Knowledge',
+  Inform: 'Inform',
+  Respond: 'Respond',
+  Archive: 'Archive',
+} satisfies Record<string, DocumentInstruction>;
+
+export type CaseFileStatus = 'Open' | 'Closed';
+
+export const CaseFileStatus = {
+  Open: 'Open',
+  Closed: 'Closed',
+} satisfies Record<string, CaseFileStatus>;
+
+export type CaseFileIncorporationMechanism =
+  'Manual' | 'WebService' | 'Mixed' | 'CitizenRepository' | 'Interoperability';
+
+export const CaseFileIncorporationMechanism = {
+  Manual: 'Manual',
+  WebService: 'WebService',
+  Mixed: 'Mixed',
+  CitizenRepository: 'CitizenRepository',
+  Interoperability: 'Interoperability',
+} satisfies Record<string, CaseFileIncorporationMechanism>;
+
+export type CaseFileActuationType =
+  | 'AdministrativeAct'
+  | 'Notification'
+  | 'OfficialCommunication'
+  | 'Interoperability'
+  | 'RequestReception'
+  | 'Subfolder'
+  | 'PowerRegistration';
+
+export const CaseFileActuationType = {
+  AdministrativeAct: 'AdministrativeAct',
+  Notification: 'Notification',
+  OfficialCommunication: 'OfficialCommunication',
+  Interoperability: 'Interoperability',
+  RequestReception: 'RequestReception',
+  Subfolder: 'Subfolder',
+  PowerRegistration: 'PowerRegistration',
+} satisfies Record<string, CaseFileActuationType>;
+
+export type CaseFileEntryKind = 'Document' | 'File' | 'CaseFile';
+
+export const CaseFileEntryKind = {
+  Document: 'Document',
+  File: 'File',
+  CaseFile: 'CaseFile',
+} satisfies Record<string, CaseFileEntryKind>;
+
+export type CaseFileActorRelation =
+  'Responsible' | 'Interested' | 'Author' | 'Referred' | 'Recipient' | 'MinisterOfFaith';
+
+export const CaseFileActorRelation = {
+  Responsible: 'Responsible',
+  Interested: 'Interested',
+  Author: 'Author',
+  Referred: 'Referred',
+  Recipient: 'Recipient',
+  MinisterOfFaith: 'MinisterOfFaith',
+} satisfies Record<string, CaseFileActorRelation>;
+
+export type CaseFileActorType = 'Citizen' | 'Foreigner' | 'PrivateInstitution' | 'Official';
+
+export const CaseFileActorType = {
+  Citizen: 'Citizen',
+  Foreigner: 'Foreigner',
+  PrivateInstitution: 'PrivateInstitution',
+  Official: 'Official',
+} satisfies Record<string, CaseFileActorType>;
+
+export type CaseFileTrackingAction =
+  | 'Created'
+  | 'Updated'
+  | 'EntryAdded'
+  | 'EntryVoided'
+  | 'ParticipantAdded'
+  | 'ParticipantRemoved'
+  | 'Closed'
+  | 'Exported';
+
+export const CaseFileTrackingAction = {
+  Created: 'Created',
+  Updated: 'Updated',
+  EntryAdded: 'EntryAdded',
+  EntryVoided: 'EntryVoided',
+  ParticipantAdded: 'ParticipantAdded',
+  ParticipantRemoved: 'ParticipantRemoved',
+  Closed: 'Closed',
+  Exported: 'Exported',
+} satisfies Record<string, CaseFileTrackingAction>;
+
+export type CaseFileAccessAction = 'Viewed' | 'FileDownloaded' | 'Exported';
+
+export const CaseFileAccessAction = {
+  Viewed: 'Viewed',
+  FileDownloaded: 'FileDownloaded',
+  Exported: 'Exported',
+} satisfies Record<string, CaseFileAccessAction>;
+
+export type WorkFolderItemKind = 'Document' | 'File';
+
+export const WorkFolderItemKind = {
+  Document: 'Document',
+  File: 'File',
+} satisfies Record<string, WorkFolderItemKind>;
+
 export interface DocumentTypeEntity {
   id: string;
   name: string;
@@ -74,9 +257,13 @@ export interface DocumentTypeEntity {
   nextCorrelative: number;
   correlativeYear?: number | null;
   resetsYearly: boolean;
+  numbered: boolean;
   directorateCodeReference?: number | null;
   enabled: boolean;
   documents?: DocumentEntity[];
+  annulledNumbers?: DocumentAnnulledNumberEntity[];
+  flowSteps?: DocumentTypeFlowStepEntity[];
+  signatureBatches?: SignatureBatchEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -92,6 +279,24 @@ export interface DocumentEntity {
   correlative?: number | null;
   correlativeYear?: number | null;
   numberedAt?: string | null;
+  verificationCode?: string | null;
+  signatureSheet: boolean;
+  annulledAt?: string | null;
+  annulmentReason?: string | null;
+  responseDueAt?: string | null;
+  origin: DocumentOrigin;
+  intakeNumber?: number | null;
+  intakeYear?: number | null;
+  externalFolio?: string | null;
+  externalSender?: string | null;
+  externalDate?: string | null;
+  contentText?: string | null;
+  textExtractedAt?: string | null;
+  batch?: SignatureBatchEntity | null;
+  batchId?: string | null;
+  replyTo?: DocumentEntity | null;
+  replyToDocumentId?: string | null;
+  replies?: DocumentEntity[];
   directorateCodeReference?: number | null;
   departmentId?: string | null;
   createdByEmployeeId: string;
@@ -107,6 +312,27 @@ export interface DocumentEntity {
   participants?: DocumentParticipantEntity[];
   attachments?: DocumentAttachmentEntity[];
   trackings?: DocumentTrackingEntity[];
+  annulledNumbers?: DocumentAnnulledNumberEntity[];
+  recipients?: DocumentRecipientEntity[];
+  deliveries?: DocumentDeliveryEntity[];
+  caseFileEntries?: CaseFileEntryEntity[];
+  workFolderItems?: WorkFolderItemEntity[];
+  externalRecipients?: DocumentExternalRecipientEntity[];
+  dispatch?: DocumentDispatchEntity | null;
+  docDigitalInbound?: DocDigitalInboundEntity | null;
+  deleted: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface SignatureBatchEntity {
+  id: string;
+  name: string;
+  createdByEmployeeId: string;
+  createdByFullName: string;
+  documentType?: DocumentTypeEntity;
+  documentTypeId: string;
+  documents?: DocumentEntity[];
   deleted: boolean;
   createdAt: string;
   updatedAt: string;
@@ -116,6 +342,7 @@ export interface DocumentParticipantEntity {
   id: string;
   role: DocumentParticipantRole;
   order: number;
+  stage: number;
   status: DocumentParticipantStatus;
   employeeId: string;
   fullName: string;
@@ -151,3 +378,318 @@ export interface DocumentTrackingEntity {
   documentId: string;
   createdAt: string;
 }
+
+export interface DocumentAnnulledNumberEntity {
+  id: string;
+  correlative: number;
+  correlativeYear: number;
+  reason: string;
+  employeeId: string;
+  employeeFullName: string;
+  documentType?: DocumentTypeEntity;
+  documentTypeId: string;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}
+
+export interface DocumentRecipientEntity {
+  id: string;
+  type: DocumentRecipientType;
+  employeeId?: string | null;
+  directorateCodeReference?: number | null;
+  departmentId?: string | null;
+  name: string;
+  position?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}
+
+export interface DocumentDeliveryEntity {
+  id: string;
+  origin: DocumentDeliveryOrigin;
+  employeeId: string;
+  fullName: string;
+  position?: string | null;
+  areaName?: string | null;
+  sentByEmployeeId?: string | null;
+  sentByFullName?: string | null;
+  instruction?: DocumentInstruction | null;
+  note?: string | null;
+  dueAt?: string | null;
+  deliveredAt?: string | null;
+  readAt?: string | null;
+  closedAt?: string | null;
+  closingNote?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}
+
+export interface DocumentTypeFlowStepEntity {
+  id: string;
+  role: DocumentParticipantRole;
+  order: number;
+  type: DocumentFlowStepType;
+  employeeId?: string | null;
+  directorateCodeReference?: number | null;
+  name: string;
+  position?: string | null;
+  documentType?: DocumentTypeEntity;
+  documentTypeId: string;
+  createdAt: string;
+}
+
+export interface ProcedureEntity {
+  id: string;
+  name: string;
+  cpatId?: string | null;
+  cpatCode?: string | null;
+  description?: string | null;
+  enabled: boolean;
+  caseFiles?: CaseFileEntity[];
+  deleted: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface CaseFileSequenceEntity {
+  year: number;
+  next: number;
+}
+
+export interface CaseFileEntity {
+  id: string;
+  code: string;
+  year: number;
+  number: number;
+  title: string;
+  subject: string;
+  summary?: string | null;
+  status: CaseFileStatus;
+  accessLevel: DocumentAccessLevel;
+  hasSensitiveData: boolean;
+  incorporationMechanism: CaseFileIncorporationMechanism;
+  schemaVersion: string;
+  procedure?: ProcedureEntity;
+  procedureId: string;
+  responsibleEmployeeId: string;
+  responsibleFullName: string;
+  responsiblePosition?: string | null;
+  closedAt?: string | null;
+  closedByEmployeeId?: string | null;
+  closedByFullName?: string | null;
+  closingNote?: string | null;
+  participants?: CaseFileParticipantEntity[];
+  actors?: CaseFileActorEntity[];
+  entries?: CaseFileEntryEntity[];
+  linkedFrom?: CaseFileEntryEntity[];
+  trackings?: CaseFileTrackingEntity[];
+  metadataChanges?: CaseFileMetadataChangeEntity[];
+  accesses?: CaseFileAccessEntity[];
+  createdAt: string;
+  updatedAt: string;
+  workFolder?: WorkFolderEntity | null;
+}
+
+export interface CaseFileParticipantEntity {
+  id: string;
+  employeeId: string;
+  fullName: string;
+  position?: string | null;
+  addedByEmployeeId: string;
+  addedByFullName: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileActorEntity {
+  id: string;
+  relation: CaseFileActorRelation;
+  actorType: CaseFileActorType;
+  identifier?: string | null;
+  name: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileEntryEntity {
+  id: string;
+  sequence: number;
+  kind: CaseFileEntryKind;
+  actuationType: CaseFileActuationType;
+  title: string;
+  document?: DocumentEntity | null;
+  documentId?: string | null;
+  fileId?: string | null;
+  fileName?: string | null;
+  documentTypeName?: string | null;
+  originDate?: string | null;
+  author?: string | null;
+  keywords: string[];
+  accessLevel?: DocumentAccessLevel | null;
+  hasSensitiveData?: boolean | null;
+  linkedCaseFile?: CaseFileEntity | null;
+  linkedCaseFileId?: string | null;
+  sha256?: string | null;
+  size?: number | null;
+  hasAdvancedSignature: boolean;
+  incorporatedByEmployeeId: string;
+  incorporatedByFullName: string;
+  voidedAt?: string | null;
+  voidedByEmployeeId?: string | null;
+  voidedByFullName?: string | null;
+  voidReason?: string | null;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileTrackingEntity {
+  id: string;
+  action: CaseFileTrackingAction;
+  observation?: string | null;
+  employeeId?: string | null;
+  employeeFullName?: string | null;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileMetadataChangeEntity {
+  id: string;
+  field: string;
+  previousValue?: string | null;
+  newValue?: string | null;
+  employeeId: string;
+  employeeFullName: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface CaseFileAccessEntity {
+  id: string;
+  action: CaseFileAccessAction;
+  entryId?: string | null;
+  employeeId: string;
+  employeeFullName: string;
+  caseFile?: CaseFileEntity;
+  caseFileId: string;
+  createdAt: string;
+}
+
+export interface DocumentExternalRecipientEntity {
+  id: string;
+  entityId: number;
+  entityName: string;
+  userId?: number | null;
+  userName?: string | null;
+  userPosition?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+}
+
+export interface DocumentDispatchEntity {
+  id: string;
+  status: DocumentDispatchStatus;
+  folio?: string | null;
+  docDigitalTypeId?: number | null;
+  docDigitalTypeName?: string | null;
+  docDigitalDocumentId?: string | null;
+  docDigitalRequestId?: string | null;
+  dispatchedAt?: string | null;
+  dispatchedByEmployeeId?: string | null;
+  dispatchedByFullName?: string | null;
+  returnedAt?: string | null;
+  returnedByEmployeeId?: string | null;
+  returnedByFullName?: string | null;
+  returnReason?: string | null;
+  document?: DocumentEntity;
+  documentId: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface DocDigitalInboundEntity {
+  id: string;
+  docDigitalDocumentId: string;
+  docDigitalRequestId?: string | null;
+  status: DocDigitalInboundStatus;
+  subject: string;
+  description?: string | null;
+  folio?: string | null;
+  folioDate?: string | null;
+  typeName?: string | null;
+  reserved: boolean;
+  senderEntityId?: number | null;
+  senderEntityName?: string | null;
+  senderName?: string | null;
+  senderPosition?: string | null;
+  fileId?: string | null;
+  fileName?: string | null;
+  attachments: JsonValue;
+  registeredAt?: string | null;
+  registeredByEmployeeId?: string | null;
+  registeredByFullName?: string | null;
+  acknowledgedAt?: string | null;
+  acknowledgeError?: string | null;
+  returnedAt?: string | null;
+  returnedByEmployeeId?: string | null;
+  returnedByFullName?: string | null;
+  returnReason?: string | null;
+  document?: DocumentEntity | null;
+  documentId?: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface IntakeSequenceEntity {
+  year: number;
+  next: number;
+}
+
+export interface WorkFolderEntity {
+  id: string;
+  name: string;
+  description?: string | null;
+  ownerEmployeeId: string;
+  ownerFullName: string;
+  caseFile?: CaseFileEntity | null;
+  caseFileId?: string | null;
+  participants?: WorkFolderParticipantEntity[];
+  items?: WorkFolderItemEntity[];
+  deleted: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface WorkFolderParticipantEntity {
+  id: string;
+  employeeId: string;
+  fullName: string;
+  folder?: WorkFolderEntity;
+  folderId: string;
+  createdAt: string;
+}
+
+export interface WorkFolderItemEntity {
+  id: string;
+  kind: WorkFolderItemKind;
+  title: string;
+  document?: DocumentEntity | null;
+  documentId?: string | null;
+  fileId?: string | null;
+  fileName?: string | null;
+  addedByEmployeeId: string;
+  addedByFullName: string;
+  folder?: WorkFolderEntity;
+  folderId: string;
+  createdAt: string;
+}
+
+type JsonValue = string | number | boolean | { [key in string]?: JsonValue } | Array<JsonValue> | null;