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

package/src/data/foundation/workshift.ts

@@ -0,0 +1,647 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { HolidayGroup } from "./holidayGroup";
+import { ContextReference } from "../context/contextReference";
+/**
+ * @hidden
+ * Interface para os parâmetros do construtor da Workshift.
+ */
+export interface WorkshiftParams {
+
+    /**
+     * Código da tabela da escala.
+     */
+    id: string;
+    /**
+     * Código da escala.
+     */
+    code: number;
+
+    /**
+     * Tipo da escala.
+     */
+    type: WorkshiftType;
+
+    /**
+     * Minutos de descanso semanal remunerado (DSR).
+     */
+    dsrMinutes: number;
+
+    /**
+     * Minutos semanais da escala.
+     */
+    weekMinutes: number;
+
+    /**
+     * Minutos mensais da escala.
+     */
+    monthMinutes: number;
+
+    /**
+     * Indica se a escala é rotativa.
+     */
+    rotationWorkShift: boolean;
+
+    /**
+     * Indica se a escala tem prorrogação noturna.
+     */
+    extensionNightHours: boolean;
+
+    /**
+     * Tipo de busca automática.
+     */
+    autoSearchType: AutoSearchType;
+
+    /**
+     * Tipo de turno da escala.
+     */
+    timeShiftType: TimeShiftType;
+
+    /**
+     * Grupos de escalas associados.
+     */
+    workshiftGroupsKeys: string[];
+
+    /**
+     * Detalhes da escala.
+     */
+    workshiftDetailsKeys: string[];
+}
+
+/**
+ * @hidden
+ * Interface para os parâmetros do construtor da turma da escala.
+ */
+export interface WorkshiftGroupParams {
+    /**
+     * ID da turma da escala.
+     */
+    id: string;
+    /**
+     * Código da turma da escala.
+     */
+    code: number;
+    /**
+     * Data base da turma da escala.   
+     */
+    baseDate?: Date;
+}
+
+/**
+ * @hidden
+ * Interface para os parâmetros do construtor das configurações da escala.
+ */
+export interface WorkshiftDetailParams {
+    /**
+     * Código da tabela de feriados.
+     */
+    holidayGroup: HolidayGroup;
+
+    /**
+     * Tipo de feriado.
+     */
+    holidayType: HolidayType;
+
+    /**
+     * Data inicial.
+     */
+    startDate: Date;
+
+    /**
+     * Chave do detalhe da escala.
+     */
+    workshiftDetailsKey: string;
+}
+
+/**
+ * @hidden
+ */
+export interface HolidayGroupParams {
+    /**
+     * Código da tabela de feriados.
+     */
+    code: number;
+}
+
+/**
+ * Representa uma escala de trabalho.
+ * 
+ * @example
+ * ```typescript
+ * workshift.code; // Retorna o código da escala.
+ * workshift.type; // Retorna o tipo da escala.
+ * workshift.dsrMinutes; // Retorna os minutos de descanso semanal remunerado (DSR).
+ * workshift.workshiftGroups; // Retorna as turmas da escala.
+ * workshift.workshiftDetails; // Retorna os detalhes da escala.
+ * ```
+ * @see {@link WorkshiftGroup}
+ * @see {@link WorkshiftDetail}
+ * @see {@link HolidayGroup}
+ * @see {@link WorkshiftType}
+ * @see {@link AutoSearchType}
+ * @see {@link TimeShiftType}
+ * 
+ * 
+ */
+export class Workshift {
+    private readonly _id: string;
+    private readonly _code: number;
+    private readonly _type: WorkshiftType;
+    private readonly _dsrMinutes: number;
+    private readonly _weekMinutes: number;
+    private readonly _monthMinutes: number;
+    private readonly _rotationWorkShift: boolean;
+    private readonly _extensionNightHours: boolean;
+    private readonly _autoSearchType: AutoSearchType;
+    private readonly _timeShiftType: TimeShiftType;
+    private readonly _workshiftGroupsKeys: string[];
+    private readonly _workshiftDetailsKeys: string[];
+
+    /**
+     * @hidden
+     * Construtor da classe Workshift.
+     * @param params Parâmetros para inicializar a Workshift.
+     */
+    constructor(params: WorkshiftParams) {
+        this._id = params.id;
+        this._code = params.code;
+        this._type = params.type;
+        this._dsrMinutes = params.dsrMinutes;
+        this._weekMinutes = params.weekMinutes;
+        this._monthMinutes = params.monthMinutes;
+        this._rotationWorkShift = params.rotationWorkShift;
+        this._extensionNightHours = params.extensionNightHours;
+        this._autoSearchType = params.autoSearchType;
+        this._timeShiftType = params.timeShiftType;
+
+        if (params.workshiftGroupsKeys && params.workshiftGroupsKeys.length !== 0) {
+            this._workshiftGroupsKeys = params.workshiftGroupsKeys.map(key => key);
+        } else {
+            this._workshiftGroupsKeys = [];
+        }
+
+        if (params.workshiftDetailsKeys && params.workshiftDetailsKeys.length !== 0) {
+            this._workshiftDetailsKeys = params.workshiftDetailsKeys.map(key => key);
+        } else {
+            this._workshiftDetailsKeys = [];
+        }
+    }
+
+
+    /**
+     * @hidden
+     * Retorna o ID da escala.
+     */
+    private get id(): string {
+        return this._id;
+    }
+
+    /**
+     * Retorna o código da escala.
+     * 
+     * @example
+     * ```typescript
+     * const workshiftCode = workshift.code; // Retorna o código da escala.
+     * ```
+     * @returns Código da escala.
+     */
+    get code(): number {
+        return this._code;
+    }
+
+    /**
+     * Retorna o tipo da escala.
+     * @example
+     * ```typescript
+     * const workshiftType = workshift.type; // Retorna o tipo da escala.
+     * ```
+     * @returns Tipo de escala.
+     * @see {@link WorkshiftType}
+     */
+    get type(): WorkshiftType {
+        return this._type;
+    }
+
+    /**
+     * Retorna o descanso semanal remunerado (DSR).
+     * @example
+     * ```typescript
+     * const dsrMinutes = workshift.dsrMinutes; // Retorna o descanso semanal remunerado (DSR) em minutos.
+     * ```
+     * @return Descanso semanal remunerado (DSR) em minutos.
+     */
+    get dsrMinutes(): number {
+        return this._dsrMinutes;
+    }
+
+    /**
+     * Retorna a quantidade de minutos semanais da escala.
+     * @example
+     * ```typescript
+     * const weekMinutes = workshift.weekMinutes; // Retorna a quantidade de minutos semanais da escala.
+     * ```
+     * @returns Quantidade de minutos semanais da escala.
+     */
+    get weekMinutes(): number {
+        return this._weekMinutes;
+    }
+
+    /**
+     * Retorna os minutos mensais da escala.
+     * @example
+     * ```typescript
+     * const monthMinutes = workshift.monthMinutes; // Retorna os minutos mensais da escala.
+     * ```
+     * @returns Minutos mensais da escala.
+     */
+    get monthMinutes(): number {
+        return this._monthMinutes;
+    }
+
+    /**
+     * Retorna se a escala é rotativa.
+     * @example
+     * ```typescript
+     * const isRotationWorkShift = workshift.rotationWorkShift; // Retorna true se a escala for rotativa, caso contrário false.
+     * ```
+     * @returns True se a escala for rotativa, caso contrário false.
+     */
+    get rotationWorkShift(): boolean {
+        return this._rotationWorkShift;
+    }
+
+    /**
+     * Retorna se a escala tem prorrogação noturna.
+     * @example
+     * ```typescript
+     * const hasExtensionNightHours = workshift.extensionNightHours; // Retorna true se a escala tiver prorrogação noturna, caso contrário false.
+     * ```
+     * @returns True se a escala tiver prorrogação noturna, caso contrário false.
+     */
+    get extensionNightHours(): boolean {
+        return this._extensionNightHours;
+    }
+
+    /**
+     * Retorna o tipo de busca automática.
+     * @example
+     * ```typescript
+     * const autoSearchType = workshift.autoSearchType; // Retorna o tipo de busca automática.
+     * ```
+     * @returns Tipo de busca automática.
+     * @see {@link AutoSearchType}
+     */
+    get autoSearchType(): AutoSearchType {
+        return this._autoSearchType;
+    }
+
+    /**
+     * Retorna o tipo de turno da escala.
+     * @example
+     * ```typescript
+     * const timeShiftType = workshift.timeShiftType; // Retorna o tipo de turno da escala.
+     * ```
+     * @returns Tipo de turno da escala.
+     * @see {@link TimeShiftType}
+     */
+    get timeShiftType(): TimeShiftType {
+        return this._timeShiftType;
+    }
+
+    /**
+     * @hidden
+     * Retorna as chaves das turmas da escala associada.
+     */
+    private get workshiftGroupsKeys(): string[] {
+        return this._workshiftGroupsKeys;
+    }
+
+    /**
+     * @hidden
+     * Retorna as chaves dos detalhes da escala.
+     */
+    private get workshiftDetailsKeys(): string[] {
+        return this._workshiftDetailsKeys;
+    }
+
+    /**
+     * Retorna as turmas da escala associada.
+     * @example
+     * ```typescript
+     * const workshiftGroups = workshift.workshiftGroups;
+     * workshiftGroups.forEach(group => {
+     *  console.log(group.code); // Exibe o código de cada turma da escala.
+     * });
+     * ```
+     * @return Lista de turmas da escala.
+     * @see {@link WorkshiftGroup}
+     */
+    get workshiftGroups(): WorkshiftGroup[] {
+        return this._workshiftGroupsKeys.map(key => {
+            const workshiftGroup = ContextReference.getGlobalInstance().getWorkshiftGroup(key);
+            if (!workshiftGroup) {
+                throw new Error(`WorkshiftGroup with key ${key} not found.`);
+            }
+            return workshiftGroup;
+        });
+    }
+
+    /**
+     * Retorna as configurações da escala.
+     * @example
+     * ```typescript
+     * const workshiftDetails = workshift.workshiftDetails;
+     * workshiftDetails.forEach(detail => {
+     *  console.log(detail.startDate); // Exibe a data inicial da configuração da escala.
+     * });
+     * ```
+     * @return Lista de configurações da escala.
+     * @see {@link WorkshiftDetail}
+     */
+    get workshiftDetails(): WorkshiftDetail[] {
+        return this._workshiftDetailsKeys.map(key => {
+            const workshiftDetail = ContextReference.getGlobalInstance().getWorkshiftDetail(key);
+            if (!workshiftDetail) {
+                throw new Error(`WorkshiftDetail with key ${key} not found.`);
+            }
+            return workshiftDetail;
+        });
+    }
+
+    static getKey(workshift: Workshift): string {
+        return workshift.id;
+    }
+
+    /**
+     * Clona a instância de Workshift.
+     * @returns Uma nova instância de Workshift com os mesmos parâmetros.
+     */
+    public static clone(workshift: Workshift): Workshift {
+        return new Workshift({
+            id: workshift.id,
+            code: workshift.code,
+            type: workshift.type,
+            dsrMinutes: workshift.dsrMinutes,
+            weekMinutes: workshift.weekMinutes,
+            monthMinutes: workshift.monthMinutes,
+            rotationWorkShift: workshift.rotationWorkShift,
+            extensionNightHours: workshift.extensionNightHours,
+            autoSearchType: workshift.autoSearchType,
+            timeShiftType: workshift.timeShiftType,
+            workshiftGroupsKeys: workshift.workshiftGroupsKeys,
+            workshiftDetailsKeys: workshift.workshiftDetailsKeys
+        });
+    }
+}
+
+/**
+ * Representa uma turma de escala.
+ */
+export class WorkshiftGroup {
+    private readonly _id: string;
+    private readonly _code: number;
+    private readonly _baseDate?: Date;
+
+    /**
+     * @hidden
+     * Construtor da classe WorkshiftGroup.
+     * @param params Parâmetros para inicializar o WorkshiftGroup.
+     */
+    constructor(params: WorkshiftGroupParams) {
+        this._id = params.id;
+        this._code = params.code;
+        this._baseDate = ObjectUtils.toDateOrThrow(params.baseDate, "workshiftGroup.baseDate");
+    }
+
+    /**
+     * @hidden
+     * Retorna o ID da turma da escala.
+     */
+    private get id(): string {
+        return this._id;
+    }
+
+    /**
+     * Retorna o código da turma da escala.
+     * @example
+     * ```typescript
+     * const groupCode = workshiftGroup.code; // Retorna o código da turma da escala.
+     * ```
+     * @returns Código da turma da escala.
+     */
+    get code(): number {
+        return this._code;
+    }
+
+    /**
+     * Retorna a data base da turma da escala.
+     *  @example
+     * ```typescript
+     * const baseDate = workshiftGroup.baseDate; // Retorna a data base da turma da escala.
+     * ```
+     * @returns Data base da turma da escala.
+     */
+    get baseDate(): Date | undefined {
+        return this._baseDate;
+    }
+
+    static getKey(workshiftGroup: WorkshiftGroup): string {
+        return workshiftGroup.id;
+    }
+
+    public static clone(workshiftGroup: WorkshiftGroup): WorkshiftGroup {
+        return new WorkshiftGroup({
+            id: workshiftGroup.id,
+            code: workshiftGroup.code,
+            baseDate: workshiftGroup.baseDate
+        });
+    }   
+}
+
+/**
+ * Representa um detalhe da escala. 
+ * Este detalhe se chama configuração da escala e determina o grupo de feriados que será usado na escala.
+ */
+export class WorkshiftDetail {
+    private readonly _holidayGroup: HolidayGroup;
+    private readonly _holidayType: HolidayType;
+    private readonly _startDate: Date;
+    private readonly _workshiftDetailsKey: string;
+
+    /**
+     * @hidden
+     * Construtor da classe WorkshiftDetail.
+     * @param params Parâmetros para inicializar o WorkshiftDetail.
+     */
+    constructor(params: WorkshiftDetailParams) {
+        this._holidayGroup = params.holidayGroup;
+        this._holidayType = params.holidayType;
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, "WorkshiftDetail.startDate");
+        this._workshiftDetailsKey = params.workshiftDetailsKey;
+    }
+
+    /**
+     * @hidden
+     * Retorna a chave do detalhe da escala.
+     */ 
+    private get workshiftDetailsKey(): string {
+        return this._workshiftDetailsKey;
+    }
+
+    /**
+     * Retorna o código da tabela de feriados.
+     * @example
+     * ```typescript
+     * const holidayGroupCode = workshiftDetail.holidayGroup.code; // Retorna o código da tabela de feriados.
+     * ``` 
+     * @returns Código da tabela de feriados.
+     * @see {@link HolidayGroup}
+     */
+    get holidayGroup(): HolidayGroup {
+        return this._holidayGroup;
+    }
+
+    /**
+     * Retorna o tipo de feriado.
+     * 
+     * @example
+     * ```typescript
+     * const holidayType = workshiftDetail.holidayType; // Retorna o tipo de feriado.
+     * ```
+     * @returns Tipo de feriado.
+     * @see {@link HolidayType}
+     */
+    get holidayType(): HolidayType {
+        return this._holidayType;
+    }
+
+    /**
+     * Retorna a data inicial da configuração da escala, detalhe da escala.
+     * 
+     * @example
+     * ```typescript
+     * const startDate = workshiftDetail.startDate; // Retorna a data inicial da configuração da escala.
+     * ```
+     * @return Data inicial da configuração da escala.
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * @hidden
+     * Retorna a chave única da configuração da escala.
+     * @returns chave única da configuração da escala.
+     */
+    static getKey(workshiftDetail: WorkshiftDetail): string {
+        return workshiftDetail.workshiftDetailsKey;
+    }
+
+    public static clone(workshiftDetail: WorkshiftDetail): WorkshiftDetail {
+        return new WorkshiftDetail({
+            holidayGroup: workshiftDetail.holidayGroup,
+            holidayType: workshiftDetail.holidayType,
+            startDate: workshiftDetail.startDate,
+            workshiftDetailsKey: workshiftDetail.workshiftDetailsKey
+        });
+    }
+}
+
+/**
+ * Enumeração para os tipos de escala.
+ * @enum
+ */
+export enum WorkshiftType {
+    /**
+     * Escala permanente.
+     */
+    PERMANENT = "PERMANENT",
+    /**
+     * Busca automática.
+     */
+    AUTOMATIC_SEARCH = "AUTOMATIC_SEARCH",
+    /**
+     * Escala definida.
+     */
+    DEFINED = "DEFINED",
+    /**
+     * Geração automática.
+     */
+    AUTOMATIC_GENERATION = "AUTOMATIC_GENERATION",
+    /**
+     * Escala intermitente.
+     */
+    INTERMITTENT = "INTERMITTENT",
+}
+
+/**
+ * Enumeração para os tipos de busca automática.
+ * @enum
+ */
+export enum AutoSearchType {
+    /**
+     * Maior número de horas realizadas.
+     */
+    LARGEST_NUMBER_OF_HOURS_WORKED = "LARGEST_NUMBER_OF_HOURS_WORKED",
+    /**
+     * Maior percentual de horas realizadas.
+     */
+    HIGHEST_PERCENTAGE_OF_HOURS_WORKED = "HIGHEST_PERCENTAGE_OF_HOURS_WORKED",
+    /**
+     * Primeira marcação realizada no dia.
+     */
+    FIRST_CLOCKING_EVENT_ON_DAY = "FIRST_CLOCKING_EVENT_ON_DAY",
+    /**
+     * Primeira marcação realizada no dia considerando tolerâncias.
+     */
+    FIRST_CLOCKING_EVENT_ON_DAY_CONSIDERING_TOLERANCE = "FIRST_CLOCKING_EVENT_ON_DAY_CONSIDERING_TOLERANCE",
+}
+
+/**
+ * Enumeração para os tipos de turno da escala.
+ * @enum
+ */
+export enum TimeShiftType {
+    /**
+     * 1º Turno.
+     */
+    FIRSTSHIFT = "FIRSTSHIFT",
+    /**
+     * 2º Turno.
+     */
+    SECONDSHIFT = "SECONDSHIFT",
+    /**
+     * 3º Turno.
+     */
+    THIRDSHIFT = "THIRDSHIFT",
+    /**
+     * 4º Turno.
+     */
+    FOURTHSHIFT = "FOURTHSHIFT",
+    /**
+     * Misto.
+     */
+    MIXED = "MIXED",
+    /**
+     * Geral.
+     */
+    GENERAL = "GENERAL",
+}
+
+/**
+ * Enumeração para os tipos de feriado.
+ * @enum
+ */
+export enum HolidayType {
+    /**
+     * Feriado próprio.
+     */
+    OWN = "OWN",
+    /**
+     * Feriado da filial.
+     */
+    BRANCH = "BRANCH",
+    /**
+     * Não tem feriado.
+     */
+    NONE = "NONE"
+}