@seniorsistemas/hcm-clocking-event-rule-nodejs 0.35.0

package/src/data/foundation/holiday.ts

@@ -0,0 +1,84 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { HolidayGroupParams, HolidayGroup } from "./holidayGroup";
+/**
+ * @hidden
+ */
+export interface HolidayParams {
+    key: string;
+    date: Date;
+    holidayGroup: HolidayGroupParams;
+}
+
+/**
+ * Representa um feriado.
+ * Um feriado é um dia específico que é reconhecido como um dia de descanso ou celebração e está associado a um grupo de feriados.
+ * 
+ * @example
+ * ```typescript
+ * context.logInfo(`Feriado, Data: ${DateUtils.format(holiday.date)}, Tabela: ${holiday.holidayGroup.name}`);
+ * ```
+ * @see {@link HolidayGroup}
+ */
+export class Holiday {
+    private readonly _key: string;
+    private readonly _date: Date;
+    private readonly _holidayGroup: HolidayGroup;
+
+    /**
+     * @hidden
+     */
+    constructor(params: HolidayParams) {
+        this._key = params.key;
+        this._date = ObjectUtils.toDateOrThrow(params.date, "Holiday.date");
+        this._holidayGroup = new HolidayGroup(params.holidayGroup);
+    }
+
+    /**
+     * @hidden
+     */
+    get key(): string {
+        return this._key;
+    }
+
+    /**
+     * Retorna a data do feriado.
+     * 
+     * @example
+     * ```typescript
+     * let holidayDate = holiday.date; // Retorna a data do feriado.
+     * ```
+     */
+    get date(): Date {
+        return this._date;
+    }
+
+    /**
+     * Retorna a tabela de feriados ao qual este feriado pertence.
+     * @example
+     * ```typescript
+     * let holidayGroup = holiday.holidayGroup; // Retorna a tabela de feriados do feriado.
+     * ```
+     * @return A tabela de feriados do feriado.
+     * @see {@link HolidayGroup}
+     */
+    get holidayGroup(): HolidayGroup {
+        return this._holidayGroup;
+    }
+
+    /**
+     * Clona um feriado.
+     * @param holiday Feriado a ser clonado.
+     * @returns 
+     */
+    public static clone(holiday: Holiday): Holiday {
+        return new Holiday({
+            key: holiday.key,
+            date: holiday.date,
+            holidayGroup: {
+                code: holiday.holidayGroup.code,
+            }
+        });
+    }
+
+}
+

package/src/data/foundation/holidayGroup.ts

@@ -0,0 +1,47 @@
+/**
+ * Parâmetros para a criação de um HolidayGroup.
+ * @hidden
+ */
+export interface HolidayGroupParams {
+    /**
+     * Código da tabela de feriados.
+     */
+    code: number;
+}
+
+
+/**
+ * Representa uma tabela de feriados.
+ * 
+ * @example
+ * ```typescript
+ *  holidayGroup.code; // Retorna o código da tabela de feriados.
+ * ```
+ */
+export class HolidayGroup {
+    /**
+     * Código da tabela de feriados.
+     */
+    private readonly _code: number;
+
+    /**
+     * @hidden
+     */
+    constructor(params: HolidayGroupParams) {
+        this._code = params.code;
+    }
+
+    /**
+     * Código da tabela de feriados.
+     * 
+     * @example
+     * ```typescript
+     * let code = holidayGroup.code; // Retorna o código da tabela de feriados.
+     * ```
+     * @return Código da tabela de feriados.
+     */
+    get code(): number {
+        return this._code;
+    }
+}
+

package/src/data/foundation/jobPosition.ts

@@ -0,0 +1,73 @@
+/**
+ * @hidden
+ */
+export interface JobPositionParams {
+    /**
+     * Código do cargo.
+     */
+    code: number;
+    /**
+     * Código da estrutura do cargo.
+     */
+    structureCode: number;
+}
+
+/**
+ * Representa um cargo de um colaborador.
+ * 
+ * @example
+ * ```typescript
+ *  jobPosition.code; // Retorna o código do cargo.
+ *  jobPosition.structureCode; // Retorna o código da estrutura do cargo.
+ * ```
+ */
+export class JobPosition {
+    /**
+     * Código do cargo.
+     */
+    private readonly _code: number;
+    /**
+     * Código da estrutura do cargo.
+     */
+    private readonly _structureCode: number;
+
+    /**
+     * @hidden
+     * @param params Parâmetros para a criação de JobPosition.
+     */
+    constructor(params: JobPositionParams) {
+        this._code = params.code;
+        this._structureCode = params.structureCode;
+    }
+
+
+    /**
+     * Código do cargo.
+     * 
+     * @example
+     * ```typescript
+     * let jobPositionCode = jobPosition.code;
+     * console.log(`Código do cargo: ${jobPositionCode}`);
+     * ```
+     * 
+     * @returns Código do cargo.
+     */
+    get code(): number {
+        return this._code;
+    }
+
+    /**
+     * Código da estrutura do cargo.
+     * 
+     * @example
+     * ```typescript
+     * let structureCode = jobPosition.structureCode;
+     * console.log(`Código da estrutura do cargo: ${structureCode}`);
+     * ```
+     * 
+     * @returns Código da estrutura do cargo.
+     */
+    get structureCode(): number {
+        return this._structureCode;
+    }
+}

package/src/data/foundation/person.ts

@@ -0,0 +1,35 @@
+/**
+ * @hidden
+ */
+export interface PersonParams {
+    name: string;
+}
+/**
+ * Representa uma pessoa no sistema, com um nome associado.
+ * 
+ * @example
+ * ```typescript
+ *  person.name; // Retorna o nome da pessoa.
+ * ```
+ */
+export class Person {
+    private readonly _name: string;
+
+    /**
+     * @hidden
+     */
+    constructor(params: PersonParams) {
+        this._name = params.name;
+    }
+
+    /**
+     * Retorna o nome da pessoa.
+     * @example
+     * ```typescript
+     * let name = person.name; // Retorna o nome da pessoa.
+     * ```
+     */
+    get name(): string {
+        return this._name;
+    }
+}

package/src/data/foundation/situation.ts

@@ -0,0 +1,301 @@
+// Situation.ts
+
+import { ContextReference } from "../context/contextReference";
+/**
+ * Interface para os parâmetros do construtor de Situation.
+ * @hidden
+ */
+export interface SituationParams {
+    id: string;
+    code: number;
+    type: SituationType;
+    exception: boolean;
+    daytime: boolean;
+    complementarySituationId: string;
+}
+
+/**
+ * Representa uma situação de um colaborador.
+ * 
+ * @example
+ * ```typescript
+ * console.log(situation.code); // Retorna o código da situação.
+ * console.log(situation.type); // Retorna o tipo da situação.
+ * console.log(situation.exception); // Retorna se a situação é uma exceção.
+ * console.log(situation.daytime); // Retorna se a situação é diurna.
+ * console.log(situation.complementarySituation); // Retorna a situação complementar.
+ * ```
+ * @see {@link SituationType}
+ */
+export class Situation {
+    /**
+     * * O código da situação é o código que identifica a situação do colaborador, como férias, atestado, etc..
+     */
+    private readonly _id: string;
+    private readonly _code: number;
+    private readonly _type: SituationType;
+    private readonly _exception: boolean;
+    private readonly _daytime: boolean
+    private readonly _complementarySituationId: string;
+
+    /**
+     * @hidden
+     * Construtor privado para garantir que a classe seja construída apenas através do método estático build.
+     */
+    constructor(params: SituationParams) {
+        this._id = params.id;
+        this._code = params.code;
+        this._type = params.type;
+        this._exception = params.exception;
+        this._daytime = params.daytime;
+        this._complementarySituationId = params.complementarySituationId;
+    }
+
+    /**
+     * @hidden
+     * @param _situationCode 
+     * @returns 
+     */
+    static build(_situationCode: number): Situation {
+        return new Situation({
+            id: "",
+            code: _situationCode,
+            type: SituationType.OTHERS,
+            exception: false,
+            daytime: false,
+            complementarySituationId: ""
+        });
+    }
+
+    /**
+     * Retorna o identificador único da situação.
+     * @hidden
+     * 
+     */
+    get id(): string {
+        return this._id;
+    }
+
+    /**
+     * Retorna o código da situação.
+     * 
+     * @example
+     * ```typescript
+     * let code = situation.code; // Retorna o código da situação.
+     * ```
+     * @return Código da situação.
+     */
+    get code(): number {
+        return this._code;
+    }
+
+    /**
+     * Retorna o tipo da situação, como trabalhando, férias, auxílio doença, etc.
+     * 
+     * @example
+     * ```typescript
+     * let type = situation.type; // Retorna o tipo da situação.
+     * ```
+     * @return Tipo da situação.
+     * @see {@link SituationType}
+     */
+    get type(): SituationType {
+        return this._type;
+    }
+
+    /**
+     * Retorna se a situação é uma exceção.
+     * 
+     * @example
+     * ```typescript
+     * let isException = situation.exception; // Retorna se a situação é uma exceção.
+     * ```
+     * @return Verdadeiro se a situação for uma exceção, falso caso contrário.
+     */
+    get exception(): boolean {
+        return this._exception;
+    }
+
+    /**
+     * Retorna se a situação é diurna.
+     * 
+     * @example
+     * ```typescript
+     * let isDaytime = situation.daytime; // Retorna se a situação é diurna.
+     * ```
+     * @return Verdadeiro se a situação for diurna, falso caso contrário.
+     */
+    get daytime(): boolean {
+        return this._daytime;
+    }
+
+    /**
+     * @hidden
+     * Retorna o ID da situação complementar, se houver.
+     * 
+     * @example
+     * ```typescript
+     * let complementarySituationId = situation.complementarySituationId; // Retorna o ID da situação complementar
+     * ```
+     * @return ID da situação complementar.
+     */
+    private get complementarySituationId(): string {
+        return this._complementarySituationId;
+    }
+
+    /**
+     * Retorna a situação complementar associada a esta situação.
+     * Observação: Se a situação complementar não for encontrada no contexto de regras, uma exceção será lançada. 
+     * Somente estão disponíveis as situações complementares que estão referenciadas no contexto de regras ou seja utilizadas em definição de situação, situação do dia, histórico de afastamento, etc.
+     * 
+     * @example
+     * ```typescript
+     * let complementarySituation = situation.complementarySituation; // Retorna a situação complementar.
+     * complementarySituation.code; // Retorna o código da situação complementar.
+     * complementarySituation.type; // Retorna o tipo da situação complementar.
+     * ```
+     * @return Situação complementar.
+     * @throws Se a situação complementar não for encontrada no contexto de regras.
+     */
+    get complementarySituation(): Situation {
+        const situation = ContextReference.getGlobalInstance().getSituationById(this._complementarySituationId);
+        if (!situation) {
+            throw new Error(`Complementary situation not found for ID: ${this._complementarySituationId}`);
+        }
+        return situation;
+    }
+
+    /**
+     * Verifica se a situação é uma situação completa com todas os atributos ou se é uma situação padrão somente com o código.
+     * Isso pode acontecer caso for criado uma situação somente com o código e a situação não for encontrada no contexto de regras, por não ser referenciado por nenhum cadastro.
+     */
+    get isLoaded(): boolean {
+        return this._id !== "";
+    }
+
+
+    public static clone(situation: Situation): Situation {
+        return new Situation({
+            id: situation.id,
+            code: situation.code,
+            type: situation.type,
+            exception: situation.exception,
+            daytime: situation.daytime,
+            complementarySituationId: situation.complementarySituationId
+        });
+    }
+
+}
+
+
+/**
+ * Enumeração para os tipos de situações.
+ * @enum
+ */
+export enum SituationType {
+    /**
+     * Trabalhando.
+     */
+    WORKING = "WORKING",
+    /**
+     * Férias.
+     */
+    VACATION = "VACATION",
+    /**
+     * Auxílio doença.
+     */
+    ILLNESSAID = "ILLNESSAID",
+    /**
+     * Acidente de trabalho.
+     */
+    LABORACCIDENT = "LABORACCIDENT",
+    /**
+     * Serviço militar.
+     */
+    MILITARYSERVICE = "MILITARYSERVICE",
+    /**
+     * Licença maternidade.
+     */
+    MATERNITYLEAVE = "MATERNITYLEAVE",
+    /**
+     * Licença maternidade - Aborto não criminoso.
+     */
+    MATERNITYLEAVENONCRIMINALABORTION = "MATERNITYLEAVENONCRIMINALABORTION",
+    /**
+     * Licença maternidade - Prorrogação mediante atestado médico.
+     */
+    MATERNITYLEAVEANTICIPATIONEXTENSION = "MATERNITYLEAVEANTICIPATIONEXTENSION",
+    /**
+     * Licença maternidade - Empresa cidadã.
+     */
+    CITIZENCOMPANYMATERNITY = "CITIZENCOMPANYMATERNITY",
+    /**
+     * Licença maternidade - INSS.
+     */
+    INSSMATERNITYLEAVE = "INSSMATERNITYLEAVE",
+    /**
+     * Licença sem remuneração.
+     */
+    LEAVEWITHOUTCOMPENSATION = "LEAVEWITHOUTCOMPENSATION",
+    /**
+     * Licença remunerada.
+     */
+    PAIDLEAVE = "PAIDLEAVE",
+    /**
+     * Licença paternidade.
+     */
+    PATERNITYLEAVE = "PATERNITYLEAVE",
+    /**
+     * Licença paternidade - Empresa cidadã.
+     */
+    CITIZENCOMPANYPATERNITY = "CITIZENCOMPANYPATERNITY",
+    /**
+     * Férias coletivas.
+     */
+    COLLECTIVEVACATION = "COLLECTIVEVACATION",
+    /**
+     * Licença médica (pgto empresa).
+     */
+    MEDICALLEAVE = "MEDICALLEAVE",
+    /**
+     * Licença médica sem incidência INSS.
+     */
+    MEDICALLEAVEWITHOUTINSS = "MEDICALLEAVEWITHOUTINSS",
+    /**
+     * Faltas.
+     */
+    ABSENCES = "ABSENCES",
+    /**
+     * Horas extras.
+     */
+    OVERTIME = "OVERTIME",
+    /**
+     * Situação de apuração ponto.
+     */
+    TIMEEVALUATIONSITUATION = "TIMEEVALUATIONSITUATION",
+    /**
+     * Sobreaviso/Prontidão.
+     */
+    PRECAUTIONREADINESS = "PRECAUTIONREADINESS",
+    /**
+     * Mandato sindical.
+     */
+    TRADEUNIONMANDATE = "TRADEUNIONMANDATE",
+    /**
+     * Licença acidente de trabalho (pgto empresa).
+     */
+    WORKACCIDENTLEAVE = "WORKACCIDENTLEAVE",
+    /**
+     * Licença acidente de trabalho sem incidência INSS.
+     */
+    WORKACCIDENTLEAVEWITHOUTINSS = "WORKACCIDENTLEAVEWITHOUTINSS",
+    /**
+     * Aposentadoria por invalidez.
+     */
+    RETIREMENTDUETODISABILITY = "RETIREMENTDUETODISABILITY",
+    /**
+     * Outros.
+     */
+    OTHERS = "OTHERS"
+}
+