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

package/src/data/foundation/syndicate.ts

@@ -0,0 +1,244 @@
+/**
+ * @hidden
+ */
+export interface SyndicateParams {
+    key: string;
+    code: number;
+    nightStartHour: number;
+    nightEndHour: number;
+    minimumInterval4to6Hours: number;
+    minimumInterval6Hours: number;
+    minimumWorkDuration6Hours: number;
+    maxDailyWorkTime: number;
+    maxContinuousDrivingTime: number;
+    minContinuousRestTime: number;
+    allowDailyRestFractionation: boolean;
+    calculateWeeklyRest: boolean;
+}
+
+/**
+ * Representa um sindicato de colaboradores.
+ * Um sindicato é uma organização que representa os interesses dos trabalhadores de uma empresa ou setor.
+ * @example
+ * ```typescript
+ *  sindicate.code; // Retorna o código do sindicato.
+ *  sindicate.nightStartHour; // Retorna a hora inicial do período noturno.
+ *  sindicate.nightEndHour; // Retorna a hora final do período noturno.
+ *  sindicate.minimumInterval4to6Hours; // Retorna o intervalo mínimo para jornada entre 4 e 6 horas.
+ *  sindicate.minimumInterval6Hours; // Retorna o intervalo mínimo para jornada acima de 6 horas.
+ *  sindicate.maxDailyWorkTime; // Retorna o máximo de horas de trabalho diário.
+ *  sindicate.maxContinuousDrivingTime; // Retorna o máximo de horas de direção contínua.
+ *  sindicate.minContinuousRestTime; // Retorna o mínimo de horas de descanso contínuo.
+ *  sindicate.allowDailyRestFractionation; // Retorna se permite fracionar repouso diário.
+ *  sindicate.calculateWeeklyRest; // Retorna se deve calcular repouso semanal.
+ * ```
+ * 
+ */
+export class Syndicate {
+    private readonly _key: string;
+    private readonly _code: number;
+    private readonly _nightStartHour: number;
+    private readonly _nightEndHour: number;
+    private readonly _minimumInterval4to6Hours: number;
+    private readonly _minimumInterval6Hours: number;
+    private readonly _minimumWorkDuration6Hours: number;
+    private readonly _maxDailyWorkTime: number;
+    private readonly _maxContinuousDrivingTime: number;
+    private readonly _minContinuousRestTime: number;
+    private readonly _allowDailyRestFractionation: boolean;
+    private readonly _calculateWeeklyRest: boolean;
+
+    /**
+     * @hidden
+     * @param params parâmetros para a criação de Syndicate.
+     */
+    constructor(params: SyndicateParams) {
+        this._key = params.key;
+        this._code = params.code;
+        this._nightStartHour = params.nightStartHour;
+        this._nightEndHour = params.nightEndHour;
+        this._minimumInterval4to6Hours = params.minimumInterval4to6Hours;
+        this._minimumInterval6Hours = params.minimumInterval6Hours;
+        this._minimumWorkDuration6Hours = params.minimumWorkDuration6Hours;
+        this._maxDailyWorkTime = params.maxDailyWorkTime;
+        this._maxContinuousDrivingTime = params.maxContinuousDrivingTime;
+        this._minContinuousRestTime = params.minContinuousRestTime;
+        this._allowDailyRestFractionation = params.allowDailyRestFractionation;
+        this._calculateWeeklyRest = params.calculateWeeklyRest;
+    }
+
+    /** Uso interno da lib */
+    /**
+     * @hidden
+     * @param syndicate 
+     * @returns 
+     */
+    static getKey(syndicate: Syndicate): string {
+        return syndicate._key;
+    }
+
+    /**
+     * Código do sindicato.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.code; // Retorna o código do sindicato.
+     * ```
+     * 
+     * @returns Código do sindicato.
+     * 
+     */
+    get code(): number {
+        return this._code;
+    }
+
+    /**
+     * Hora inicial do período noturno em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.nightStartHour; // Retorna a hora inicial do período noturno em minutos.
+     * ```
+     * @returns Hora inicial do período noturno em minutos.
+     */
+    get nightStartHour(): number {
+        return this._nightStartHour;
+    }
+
+    /**
+     * Hora final do período noturno em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.nightEndHour; // Retorna a hora final do período noturno em minutos.
+     * ```
+     * 
+     * @returns Hora final do período noturno em minutos.
+     * 
+     */
+    get nightEndHour(): number {
+        return this._nightEndHour;
+    }
+
+    /**
+     * Intervalo mínimo para jornada entre 4 e 6 horas em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.minimumInterval4to6Hours; // Retorna o intervalo mínimo para jornada entre 4 e 6 horas em minutos.
+     * ```
+     * @returns Intervalo mínimo para jornada entre 4 e 6 horas em minutos.
+     */
+    get minimumInterval4to6Hours(): number {
+        return this._minimumInterval4to6Hours;
+    }
+
+    /**
+     * Intervalo mínimo para jornada acima de 6 horas em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.minimumInterval6Hours; // Retorna o intervalo mínimo para jornada acima de 6 horas em minutos.
+     * ```
+     * @returns Intervalo mínimo para jornada acima de 6 horas em minutos.
+     */
+    get minimumInterval6Hours(): number {
+        return this._minimumInterval6Hours;
+    }
+
+    /**
+     * Mínimo trabalho para jornada acima de 6 horas em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.minimumWorkDuration6Hours; // Retorna o mínimo trabalho para jornada acima de 6 horas em minutos.
+     * ```
+     * @returns Mínimo trabalho para jornada acima de 6 horas em minutos.
+     */
+    get minimumWorkDuration6Hours(): number {
+        return this._minimumWorkDuration6Hours;
+    }
+
+    /**
+     * Tempo máximo de jornada diária em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.maxDailyWorkTime; // Retorna o tempo máximo de jornada diária em minutos.
+     * ```
+     * @returns Tempo máximo de jornada diária em minutos.
+     */
+    get maxDailyWorkTime(): number {
+        return this._maxDailyWorkTime;
+    }
+
+    /**
+     * Tempo máximo de direção contínua em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.maxContinuousDrivingTime; // Retorna o tempo máximo de direção contínua em minutos.
+     * ```
+     * @returns Tempo máximo de direção contínua em minutos.
+     */
+    get maxContinuousDrivingTime(): number {
+        return this._maxContinuousDrivingTime;
+    }
+
+    /**
+     * Tempo mínimo de descanso contínuo em minutos.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.minContinuousRestTime; // Retorna o tempo mínimo de descanso contínuo em minutos.
+     * ```
+     * @returns Tempo mínimo de descanso contínuo em minutos.
+     */
+    get minContinuousRestTime(): number {
+        return this._minContinuousRestTime;
+    }
+
+    /**
+     * Permite fracionar repouso diário.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.allowDailyRestFractionation; // Retorna se permite fracionar repouso diário.
+     * ```
+     * @returns Permite fracionar repouso diário.
+     */
+    get allowDailyRestFractionation(): boolean {
+        return this._allowDailyRestFractionation;
+    }
+
+    /**
+     * Calcular repouso semanal.
+     * 
+     * @example
+     * ```typescript
+     * sindicate.calculateWeeklyRest; // Retorna se deve calcular repouso semanal.
+     * ```
+     * @returns Calcular repouso semanal.
+     */
+    get calculateWeeklyRest(): boolean {
+        return this._calculateWeeklyRest;
+    }
+
+    public static clone(syndicate: Syndicate): Syndicate {
+        return new Syndicate({
+            key: syndicate._key,
+            code: syndicate.code,
+            nightStartHour: syndicate.nightStartHour,
+            nightEndHour: syndicate.nightEndHour,
+            minimumInterval4to6Hours: syndicate.minimumInterval4to6Hours,
+            minimumInterval6Hours: syndicate.minimumInterval6Hours,
+            minimumWorkDuration6Hours: syndicate.minimumWorkDuration6Hours,
+            maxDailyWorkTime: syndicate.maxDailyWorkTime,
+            maxContinuousDrivingTime: syndicate.maxContinuousDrivingTime,
+            minContinuousRestTime: syndicate.minContinuousRestTime,
+            allowDailyRestFractionation: syndicate.allowDailyRestFractionation,
+            calculateWeeklyRest: syndicate.calculateWeeklyRest,
+        });
+    }
+
+}