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

package/dist/base/entities.d.ts

@@ -4,7 +4,7 @@ export declare const DocumentCategory: {
     Communication: "Communication";
     Other: "Other";
 };
-export type DocumentStatus = 'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded';
+export type DocumentStatus = 'Drafted' | 'PendingVisa' | 'PendingSignature' | 'Finished' | 'Rejected' | 'Discarded' | 'Annulled';
 export declare const DocumentStatus: {
     Drafted: "Drafted";
     PendingVisa: "PendingVisa";
@@ -12,6 +12,7 @@ export declare const DocumentStatus: {
     Finished: "Finished";
     Rejected: "Rejected";
     Discarded: "Discarded";
+    Annulled: "Annulled";
 };
 export type DocumentAccessLevel = 'Public' | 'Restricted' | 'Secret' | 'Reserved';
 export declare const DocumentAccessLevel: {
@@ -32,7 +33,7 @@ export declare const DocumentParticipantStatus: {
     Resolved: "Resolved";
     Rejected: "Rejected";
 };
-export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded';
+export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded' | 'Numbered' | 'NumberAnnulled' | 'Annulled' | 'Delivered' | 'Derived' | 'Reassigned' | 'Dispatched' | 'DispatchReturned' | 'Received';
 export declare const DocumentTrackingAction: {
     Created: "Created";
     Updated: "Updated";
@@ -42,12 +43,128 @@ export declare 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";
+};
+export type DocumentOrigin = 'Internal' | 'DocDigital';
+export declare const DocumentOrigin: {
+    Internal: "Internal";
+    DocDigital: "DocDigital";
+};
+export type DocumentDispatchStatus = 'Pending' | 'Dispatched' | 'Returned';
+export declare const DocumentDispatchStatus: {
+    Pending: "Pending";
+    Dispatched: "Dispatched";
+    Returned: "Returned";
+};
+export type DocDigitalInboundStatus = 'Pending' | 'Registered' | 'Returned';
+export declare const DocDigitalInboundStatus: {
+    Pending: "Pending";
+    Registered: "Registered";
+    Returned: "Returned";
+};
+export type DocumentFlowStepType = 'Employee' | 'DirectorateHead';
+export declare const DocumentFlowStepType: {
+    Employee: "Employee";
+    DirectorateHead: "DirectorateHead";
 };
 export type DocumentAttachmentType = 'File' | 'Link';
 export declare const DocumentAttachmentType: {
     File: "File";
     Link: "Link";
 };
+export type DocumentRecipientType = 'Employee' | 'Directorate' | 'Department';
+export declare const DocumentRecipientType: {
+    Employee: "Employee";
+    Directorate: "Directorate";
+    Department: "Department";
+};
+export type DocumentDeliveryOrigin = 'Recipient' | 'Derivation';
+export declare const DocumentDeliveryOrigin: {
+    Recipient: "Recipient";
+    Derivation: "Derivation";
+};
+export type DocumentInstruction = 'Knowledge' | 'Inform' | 'Respond' | 'Archive';
+export declare const DocumentInstruction: {
+    Knowledge: "Knowledge";
+    Inform: "Inform";
+    Respond: "Respond";
+    Archive: "Archive";
+};
+export type CaseFileStatus = 'Open' | 'Closed';
+export declare const CaseFileStatus: {
+    Open: "Open";
+    Closed: "Closed";
+};
+export type CaseFileIncorporationMechanism = 'Manual' | 'WebService' | 'Mixed' | 'CitizenRepository' | 'Interoperability';
+export declare const CaseFileIncorporationMechanism: {
+    Manual: "Manual";
+    WebService: "WebService";
+    Mixed: "Mixed";
+    CitizenRepository: "CitizenRepository";
+    Interoperability: "Interoperability";
+};
+export type CaseFileActuationType = 'AdministrativeAct' | 'Notification' | 'OfficialCommunication' | 'Interoperability' | 'RequestReception' | 'Subfolder' | 'PowerRegistration';
+export declare const CaseFileActuationType: {
+    AdministrativeAct: "AdministrativeAct";
+    Notification: "Notification";
+    OfficialCommunication: "OfficialCommunication";
+    Interoperability: "Interoperability";
+    RequestReception: "RequestReception";
+    Subfolder: "Subfolder";
+    PowerRegistration: "PowerRegistration";
+};
+export type CaseFileEntryKind = 'Document' | 'File' | 'CaseFile';
+export declare const CaseFileEntryKind: {
+    Document: "Document";
+    File: "File";
+    CaseFile: "CaseFile";
+};
+export type CaseFileActorRelation = 'Responsible' | 'Interested' | 'Author' | 'Referred' | 'Recipient' | 'MinisterOfFaith';
+export declare const CaseFileActorRelation: {
+    Responsible: "Responsible";
+    Interested: "Interested";
+    Author: "Author";
+    Referred: "Referred";
+    Recipient: "Recipient";
+    MinisterOfFaith: "MinisterOfFaith";
+};
+export type CaseFileActorType = 'Citizen' | 'Foreigner' | 'PrivateInstitution' | 'Official';
+export declare const CaseFileActorType: {
+    Citizen: "Citizen";
+    Foreigner: "Foreigner";
+    PrivateInstitution: "PrivateInstitution";
+    Official: "Official";
+};
+export type CaseFileTrackingAction = 'Created' | 'Updated' | 'EntryAdded' | 'EntryVoided' | 'ParticipantAdded' | 'ParticipantRemoved' | 'Closed' | 'Exported';
+export declare const CaseFileTrackingAction: {
+    Created: "Created";
+    Updated: "Updated";
+    EntryAdded: "EntryAdded";
+    EntryVoided: "EntryVoided";
+    ParticipantAdded: "ParticipantAdded";
+    ParticipantRemoved: "ParticipantRemoved";
+    Closed: "Closed";
+    Exported: "Exported";
+};
+export type CaseFileAccessAction = 'Viewed' | 'FileDownloaded' | 'Exported';
+export declare const CaseFileAccessAction: {
+    Viewed: "Viewed";
+    FileDownloaded: "FileDownloaded";
+    Exported: "Exported";
+};
+export type WorkFolderItemKind = 'Document' | 'File';
+export declare const WorkFolderItemKind: {
+    Document: "Document";
+    File: "File";
+};
 export interface DocumentTypeEntity {
     id: string;
     name: string;
@@ -57,9 +174,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;
@@ -74,6 +195,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;
@@ -89,6 +228,26 @@ 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;
@@ -97,6 +256,7 @@ export interface DocumentParticipantEntity {
     id: string;
     role: DocumentParticipantRole;
     order: number;
+    stage: number;
     status: DocumentParticipantStatus;
     employeeId: string;
     fullName: string;
@@ -130,3 +290,300 @@ 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;
+export {};

package/dist/base/entities.js

@@ -1,7 +1,7 @@
 "use strict";
 // This file was auto-generated by prisma-generator-typescript-interfaces
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentAttachmentType = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
+exports.WorkFolderItemKind = exports.CaseFileAccessAction = exports.CaseFileTrackingAction = exports.CaseFileActorType = exports.CaseFileActorRelation = exports.CaseFileEntryKind = exports.CaseFileActuationType = exports.CaseFileIncorporationMechanism = exports.CaseFileStatus = exports.DocumentInstruction = exports.DocumentDeliveryOrigin = exports.DocumentRecipientType = exports.DocumentAttachmentType = exports.DocumentFlowStepType = exports.DocDigitalInboundStatus = exports.DocumentDispatchStatus = exports.DocumentOrigin = exports.DocumentTrackingAction = exports.DocumentParticipantStatus = exports.DocumentParticipantRole = exports.DocumentAccessLevel = exports.DocumentStatus = exports.DocumentCategory = void 0;
 exports.DocumentCategory = {
     Decree: 'Decree',
     Communication: 'Communication',
@@ -14,6 +14,7 @@ exports.DocumentStatus = {
     Finished: 'Finished',
     Rejected: 'Rejected',
     Discarded: 'Discarded',
+    Annulled: 'Annulled',
 };
 exports.DocumentAccessLevel = {
     Public: 'Public',
@@ -40,8 +41,108 @@ exports.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',
+};
+exports.DocumentOrigin = {
+    Internal: 'Internal',
+    DocDigital: 'DocDigital',
+};
+exports.DocumentDispatchStatus = {
+    Pending: 'Pending',
+    Dispatched: 'Dispatched',
+    Returned: 'Returned',
+};
+exports.DocDigitalInboundStatus = {
+    Pending: 'Pending',
+    Registered: 'Registered',
+    Returned: 'Returned',
+};
+exports.DocumentFlowStepType = {
+    Employee: 'Employee',
+    DirectorateHead: 'DirectorateHead',
 };
 exports.DocumentAttachmentType = {
     File: 'File',
     Link: 'Link',
 };
+exports.DocumentRecipientType = {
+    Employee: 'Employee',
+    Directorate: 'Directorate',
+    Department: 'Department',
+};
+exports.DocumentDeliveryOrigin = {
+    Recipient: 'Recipient',
+    Derivation: 'Derivation',
+};
+exports.DocumentInstruction = {
+    Knowledge: 'Knowledge',
+    Inform: 'Inform',
+    Respond: 'Respond',
+    Archive: 'Archive',
+};
+exports.CaseFileStatus = {
+    Open: 'Open',
+    Closed: 'Closed',
+};
+exports.CaseFileIncorporationMechanism = {
+    Manual: 'Manual',
+    WebService: 'WebService',
+    Mixed: 'Mixed',
+    CitizenRepository: 'CitizenRepository',
+    Interoperability: 'Interoperability',
+};
+exports.CaseFileActuationType = {
+    AdministrativeAct: 'AdministrativeAct',
+    Notification: 'Notification',
+    OfficialCommunication: 'OfficialCommunication',
+    Interoperability: 'Interoperability',
+    RequestReception: 'RequestReception',
+    Subfolder: 'Subfolder',
+    PowerRegistration: 'PowerRegistration',
+};
+exports.CaseFileEntryKind = {
+    Document: 'Document',
+    File: 'File',
+    CaseFile: 'CaseFile',
+};
+exports.CaseFileActorRelation = {
+    Responsible: 'Responsible',
+    Interested: 'Interested',
+    Author: 'Author',
+    Referred: 'Referred',
+    Recipient: 'Recipient',
+    MinisterOfFaith: 'MinisterOfFaith',
+};
+exports.CaseFileActorType = {
+    Citizen: 'Citizen',
+    Foreigner: 'Foreigner',
+    PrivateInstitution: 'PrivateInstitution',
+    Official: 'Official',
+};
+exports.CaseFileTrackingAction = {
+    Created: 'Created',
+    Updated: 'Updated',
+    EntryAdded: 'EntryAdded',
+    EntryVoided: 'EntryVoided',
+    ParticipantAdded: 'ParticipantAdded',
+    ParticipantRemoved: 'ParticipantRemoved',
+    Closed: 'Closed',
+    Exported: 'Exported',
+};
+exports.CaseFileAccessAction = {
+    Viewed: 'Viewed',
+    FileDownloaded: 'FileDownloaded',
+    Exported: 'Exported',
+};
+exports.WorkFolderItemKind = {
+    Document: 'Document',
+    File: 'File',
+};