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

package/src/data/foundation/workshiftBase.ts

@@ -0,0 +1,113 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { ContextReference } from "../context/contextReference";
+import { Workshift, WorkshiftGroup } from "./workshift";
+
+/**
+ * @hidden
+ */
+export interface WorkshiftBaseParams {
+    /**
+     * Data inicial da escala.
+     */
+    startDate: Date;
+    /**
+     * Identificador da escala.
+     */
+    workshiftId: string;
+    /**
+     * Código do turma da escala.
+     */
+    workshiftGroupId: string;
+}
+
+export abstract class WorkshiftBase {
+    /**
+     * Data inicial da escala.
+     */
+    protected readonly _startDate: Date;
+    /**
+     * Identificador da escala.
+     */
+    protected readonly _workshiftId: string;
+    /**
+     * Código do turma da escala.
+     */
+    protected readonly _workshiftGroupId: string;
+
+    /**
+     * @hidden
+     * @param params Parâmetros necessários para criar uma instância de WorkshiftBase.
+     */
+    constructor(params: WorkshiftBaseParams) {
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, `${this.constructor.name}.startDate`);
+        this._workshiftId = params.workshiftId;
+        this._workshiftGroupId = params.workshiftGroupId;
+    }
+
+    /**
+     * Data inicial da escala.
+     * @example
+     * ```typescript
+     * let startDate = workshiftBase.startDate; // Retorna a data inicial da escala.
+     * ```
+     * @return Data inicial da escala.
+     * 
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * @hidden
+     * Identificador da escala.
+     */
+    protected get workshiftId(): string {
+        return this._workshiftId;
+    }
+
+    /**
+     * @hidden
+     * Código do turma da escala.
+     * @return ID da turma da escala.
+     */
+    protected get workshiftGroupId(): string {
+        return this._workshiftGroupId;
+    }
+
+    /**
+     * Escala 
+     * 
+     * @example
+     * ```typescript
+     * const workshift = item.workshift; // Retorna a escala associada ao histórico/programação.
+     * workshift.code; // Retorna o código da escala.
+     * ```
+     * @return Escala associada ao histórico/programação.
+     * @see {@link Workshift}
+     */
+    get workshift(): Workshift {
+        const workshift = ContextReference.getGlobalInstance().getWorkshift(this._workshiftId);
+        if (!workshift) {
+            throw new Error(`Workshift not found for key: ${this._workshiftId}`);
+        }
+        return workshift;
+    }
+
+    /**
+     * Turma da escala.
+     * @example
+     * ```typescript
+     * const workshiftGroup = item.workshiftGroup; // Retorna o turma da escala associado ao histórico/programação.
+     * workshiftGroup.code; // Retorna o código do turma da escala.
+     * ```
+     * @return Turma da escala associado ao histórico/programação.
+     * @see {@link WorkshiftGroup}
+     */
+    get workshiftGroups(): WorkshiftGroup {
+        const workshiftGroup = ContextReference.getGlobalInstance().getWorkshiftGroup(this._workshiftGroupId);
+        if (!workshiftGroup) {
+            throw new Error(`WorkshiftGroup not found for key: ${this._workshiftGroupId}`);
+        }
+        return workshiftGroup;
+    }
+}

package/src/data/histories/companyBranchHistory.ts

@@ -0,0 +1,128 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { ContextReference } from "../context/contextReference";
+import { CompanyBranch } from "../foundation/companyBranch";
+
+/**
+ * @hidden
+ * Parâmetros necessários para criar uma instância de CompanyBranchHistory.
+ */
+export interface CompanyBranchHistoryParams {
+    /** A data inicial do histórico de filial de empresa. */
+    startDate: Date;
+    /** A data final do histórico de filial de empresa (opcional). */
+    endDate: Date | null;
+    /** A chave única que identifica a filial de empresa. */
+    companyBranchKey: string;
+}
+
+/**
+ * Representa o histórico de filial de empresa.
+ * 
+ * @example
+ * ```typescript
+ *  companyBranchHistory.startDate; // Retorna a data inicial do histórico de filial.
+ *  companyBranchHistory.endDate; // Retorna a data final do histórico de filial.
+ *  const branch = companyBranchHistory.companyBranch; // Obtém a filial de empresa associada ao histórico.
+ *  branch.code; // Retorna o código da filial.
+ * ```
+ * @see {@link CompanyBranch}
+ * 
+ */
+export class CompanyBranchHistory {
+    /** A data inicial do histórico de filial de empresa. */
+    private readonly _startDate: Date;
+    /** A data final do histórico de filial de empresa (opcional). */
+    private readonly _endDate: Date | null;
+    /** A chave única que identifica a filial de empresa. */
+    private readonly _companyBranchKey: string;
+    /**
+     * @hidden
+     * Cria uma nova instância de CompanyBranchHistory.
+     * @param params - Os parâmetros necessários para criar a instância.
+     */
+    constructor(params: CompanyBranchHistoryParams) {
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, "CompanyBranchHistory.startDate");
+        this._endDate = ObjectUtils.toDateOrNull(params.endDate);
+        this._companyBranchKey = params.companyBranchKey;
+    }
+
+    /**
+     * Obtém a data inicial do histórico de filial de empresa.
+     * 
+     * @example
+     * ```typescript
+     * const startDate = companyBranchHistory.startDate; // Retorna a data inicial do histórico de filial.
+     * ```
+     * 
+     * @returns A data inicial.
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * Obtém a data final do histórico de filial de empresa.
+     * 
+     * @example
+     * ```typescript
+     * const endDate = companyBranchHistory.endDate; // Retorna a data final do histórico de filial.
+     * ```
+     * 
+     * @returns A data final ou null se não estiver definida.
+     */
+    get endDate(): Date | null {
+        return this._endDate;
+    }
+
+    /**
+     * @hidden
+     * Obtém a chave única que identifica a filial da empresa.
+     * 
+     * @example
+     * ```typescript
+     * const branchKey = companyBranchHistory.companyBranchKey; // Retorna a chave de filial de empresa.
+     * ```
+     * 
+     * @returns A chave de filial de empresa.
+     */
+    private get companyBranchKey(): string {
+        return this._companyBranchKey;
+    }
+
+
+    /**
+     * Obtém a filial de empresa associada ao histórico.
+     * 
+     * @example
+     * ```typescript
+     * const branch = companyBranchHistory.companyBranch; // Obtém a filial de empresa associada ao histórico.
+     * * branch.code; // Retorna o código da filial.
+     * ```
+     * @returns A filial da empresa.
+     * @throws Se a filial de empresa não for encontrada.
+     * @see {@link CompanyBranch}
+     */
+    get companyBranch(): CompanyBranch {
+        const companyBranch = ContextReference.getGlobalInstance().getCompanyBranch(this._companyBranchKey);
+        if (!companyBranch) {
+            throw new Error(`Company branch not found for key: ${this._companyBranchKey}`);
+        }
+        return companyBranch;
+    }
+
+
+    /**
+     * Clona o histórico de filial de empresa.
+     * 
+     * @param companyBranchHistory - O histórico de filial de empresa a ser clonado.
+     * @returns Uma nova instância de CompanyBranchHistory com os mesmos dados.
+     */
+    public static clone(companyBranchHistory: CompanyBranchHistory): CompanyBranchHistory {
+        const companyBranchHistoryParams: CompanyBranchHistoryParams = {
+            startDate: companyBranchHistory.startDate,
+            endDate: companyBranchHistory.endDate,
+            companyBranchKey: companyBranchHistory.companyBranchKey
+        };
+        return new CompanyBranchHistory(companyBranchHistoryParams);
+    }
+}

package/src/data/histories/costCenterHistory.ts

@@ -0,0 +1,114 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { ContextReference } from "../context/contextReference";
+import { CostCenter } from "../foundation/costCenter";
+
+/**
+ * Histórico de centro de custo do colaborador.
+ * O histórico de centro de custo é utilizado para verificar o centro de custo do colaborador em uma data específica.
+ * @hidden
+ */
+export interface CostCenterHistoryParams {
+    startDate: Date;
+    endDate: Date | null;
+    costCenterKey: string;
+}
+
+/**
+ * Representa o histórico de centro de custo do colaborador.
+ * O histórico de centro de custo é utilizado para verificar o centro de custo do colaborador em uma data específica.
+ * 
+ * @example
+ * ```javascript
+ * costCenterHistory.startDate; // Data inicial do histórico de centro de custo.
+ * costCenterHistory.endDate; // Data final do histórico de centro de custo (pode ser null).
+ * costCenterHistory.costCenter; // Objeto CostCenter associado ao histórico.
+ * ``` 
+ * @see CostCenter
+ */
+export class CostCenterHistory {
+    private readonly _startDate: Date;
+    private readonly _endDate: Date | null;
+    private readonly _costCenterKey: string;
+
+    /**
+     * @hidden
+     * @param params Parâmetros para a criação de CostCenterHistory.
+     */
+    constructor(params: CostCenterHistoryParams) {
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, "CostCenterHistory.startDate");
+        this._endDate = ObjectUtils.toDateOrNull(params.endDate);
+        this._costCenterKey = params.costCenterKey;
+    }
+
+    /**
+     * Data inicial do histórico de centro de custo.
+     * 
+     * @example
+     * ```javascript
+     * let startDate = costCenterHistory.startDate;
+     * console.log(`Data inicial do histórico de centro de custo: ${startDate.toISOString()}`);
+     * ```
+     * 
+     * @returns Data inicial do histórico de centro de custo.
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * Data final do histórico de centro de custo.
+     * 
+     * @example
+     * ```javascript
+     * let endDate = costCenterHistory.endDate;
+     * console.log(`Data final do histórico de centro de custo: ${endDate ? endDate.toISOString() : 'null'}`);
+     * ```
+     * 
+     * @returns Data final do histórico de centro de custo.
+     */
+    get endDate(): Date | null {
+        return this._endDate;
+    }
+
+     /**
+     * @hidden
+     */
+    private get costCenterKey(): string {
+        return this._costCenterKey;
+    }
+
+    /**
+     * Centro de custo do colaborador.
+     * @example
+     * 
+     * ```javascript
+     * let costCenter = costCenterHistory.costCenter;
+     * console.log(`Centro de custo: ${costCenter.code}`);
+     * ```
+     * 
+     * @returns Centro de custo do colaborador.
+     * @throws Se o centro de custo não for encontrado.
+     */
+    get costCenter(): CostCenter {
+        const costCenter = ContextReference.getGlobalInstance().getCostCenter(this._costCenterKey);
+        if (!costCenter) {
+            throw new Error(`Cost center not found for key: ${this._costCenterKey}`);
+        }
+        return costCenter;
+    }
+
+    /**
+     * Clona o histórico de centro de custo.
+     * @returns Uma nova instância de CostCenterHistory com os mesmos valores.
+     */
+    public static clone(object: CostCenterHistory): CostCenterHistory {
+        
+        const costCenterHistoryParams: CostCenterHistoryParams = {
+            startDate: object.startDate,
+            endDate: object.endDate,
+            costCenterKey: object.costCenterKey
+        };
+        return new CostCenterHistory(costCenterHistoryParams);
+    }
+
+}

package/src/data/histories/employmentRelationshipHistory.ts

@@ -0,0 +1,116 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { ContextReference } from "../context/contextReference";
+import { EmploymentRelationship } from '../foundation/employmentRelationship';
+
+/**
+ * @hidden
+ * Parâmetros necessários para criar uma instância de EmploymentRelationshipHistory.
+ */
+export interface EmploymentRelationshipHistoryParams {
+    /** A data inicial do histórico de vínculo. */
+    startDate: Date;
+    /** A data final do histórico de vínculo (opcional). */
+    endDate: Date | null;
+    /** ID que identifica o vínculo. */
+    employmentRelationshipId: string;
+}
+
+/**
+ * Representa o histórico de vínculo.
+ * 
+ * @example
+ * ```typescript
+ * employmentHistory.startDate; // Retorna a data inicial do histórico de vínculo.
+ * employmentHistory.endDate; // Retorna a data final do histórico de vínculo ou null se não estiver definida.
+ * const employmentRelationship = employmentHistory.employmentRelationship;
+ * employmentRelationship.type; // Retorna o tipo do vínculo.
+ * ```
+ * @see {@link EmploymentRelationship}
+ * 
+ */
+export class EmploymentRelationshipHistory {
+    /** A data inicial do histórico de vínculo. */
+    private readonly _startDate: Date;
+    /** A data final do histórico de vínculo (opcional). */
+    private readonly _endDate: Date | null;
+    /** ID que identifica o vínculo. */
+    private readonly _employmentRelationshipId: string;
+
+    /**
+     * @hidden
+     * Cria uma nova instância de EmploymentRelationshipHistory.
+     * @param params - Os parâmetros necessários para criar a instância.
+     */
+    constructor(params: EmploymentRelationshipHistoryParams) {
+        this._startDate = ObjectUtils.toDateOrThrow(params.startDate, "EmploymentRelationshipHistory.startDate");
+        this._endDate = ObjectUtils.toDateOrNull(params.endDate);
+        this._employmentRelationshipId = params.employmentRelationshipId;
+    }
+
+    /**
+     * Obtém a data inicial do histórico de vínculo.
+     * 
+     * @example
+     * ```typescript
+     *  let startDate = employmentHistory.startDate; // Retorna a data inicial do histórico de vínculo.
+     * ```
+     * 
+     * @returns A data inicial.
+     */
+    get startDate(): Date {
+        return this._startDate;
+    }
+
+    /**
+     * Obtém a data final do histórico de vínculo. A data final pode ser null se for um histórico em aberto (sem data final definida).
+     * 
+     * @example
+     * ```typescript
+     * let endDate = employmentHistory.endDate; // Retorna a data final do histórico de vínculo ou null se não estiver definida.
+     * ```
+     * 
+     * 
+     * @returns A data final ou null se não estiver definida.
+     */
+    get endDate(): Date | null {
+        return this._endDate;
+    }
+
+    /**
+     * @hidden
+     * Obtém a chave única que identifica o vínculo.
+     * @returns ID do vínculo.
+     */
+    private get employmentRelationshipId(): string {
+        return this._employmentRelationshipId;
+    }
+
+    /**
+     * Obtém o vínculo do colaborador associado ao histórico.
+     * 
+     * @example
+     * ```typescript
+     * let employmentRelationship = employmentHistory.employmentRelationship; // Retorna o vínculo do colaborador associado ao histórico.
+     * employmentRelationship.type; // Retorna o tipo do vínculo.
+     * ```
+     * 
+     * @returns O vínculo.
+     * @throws Se o vínculo não for encontrado.
+     */
+    get employmentRelationship(): EmploymentRelationship {
+        const employmentRelationship = ContextReference.getGlobalInstance().getEmploymentRelationship(this._employmentRelationshipId);
+        if (!employmentRelationship) {
+            throw new Error(`Employment relationship not found for key: ${this._employmentRelationshipId}`);
+        }
+        return employmentRelationship;
+    }
+
+    public static clone(object: EmploymentRelationshipHistory): EmploymentRelationshipHistory {
+        const employmentRelationshipParams = {
+                    startDate: object.startDate,
+                    endDate: object.endDate,
+                    employmentRelationshipId: object.employmentRelationshipId
+                };
+        return new EmploymentRelationshipHistory(employmentRelationshipParams)
+    }
+}