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

package/src/data/employee/employee.ts

@@ -0,0 +1,434 @@
+import { ObjectUtils } from "../../utils/object.utils";
+import { Employer } from "../foundation/employer";
+import { EmploymentRelationship } from "../foundation/employmentRelationship";
+import { Person } from "../foundation/person";
+import { ContextReference } from "../context/contextReference";
+import { JobPosition } from "../foundation/jobPosition";
+import { Workshift, WorkshiftGroup } from "../foundation/workshift";
+import { CompanyBranch } from "../foundation/companyBranch";
+import { CostCenter } from "../foundation/costCenter";
+
+/**
+ * @hidden
+ * Interface para os parâmetros do construtor de Employee.
+ */
+interface EmployeeParams {
+    /**
+     * Identificador único do colaborador.
+     */
+    id: string;
+
+    /**
+     * Código do colaborador.
+     */
+    code: number;
+
+    /**
+     * Pessoa do colaborador.
+     */
+    person: Person;
+
+    /**
+     * Data de admissão do colaborador.
+     */
+    hireDate: Date;
+
+    /**
+     * Data de demissão do funcionário (opcional).
+     */
+    dismissalDate: Date | null;
+
+    /**
+     * ID do vínculo do colaborador.
+     */
+    employmentRelationshipId: string;
+
+    /**
+     * Empregador do colaborador.
+     */
+    employer: Employer;
+
+    /**
+     * Código do centro de custo do colaborador (opcional).
+     */
+    costCenterKey: string;
+
+    /**
+     * Código da filial do colaborador.
+     */
+    companyBranchKey: string;
+
+    /**
+     * Código da escala do colaborador.
+     */
+    workshiftId: string;
+
+    /**
+     * Código do turno da escala do colaborador.
+     */
+    workshiftGroupId: string;
+
+    /**
+     * Código do cargo do colaborador.
+     */
+    jobPositionKey: string;
+
+}
+
+/**
+ * Representa um colaborador.
+ * Um colaborador é uma pessoa que trabalha para um empregador, com um vínculo de emprego definido.
+ * Ele possui informações como código, pessoa associada, data de admissão, data de demissão (opcional),
+ * vínculo de emprego, empregador, centro de custo (opcional), filial, escala, turno e cargo.
+ * No colaborador pode se encontrado a pessoa e seu nome.
+ * 
+ * Exemplo de uso:
+ * ```typescript
+ * employee.hireDate; // Retorna a data de admissão do colaborador.
+ * employee.employer.name; // Retorna o nome do empregador do colaborador.
+ * employee.employmentRelationship.code; // Retorna o código do vínculo de emprego do colaborador.
+ * ```
+ * @see {@link Person}
+ * @see {@link Employer}
+ * @see {@link EmploymentRelationship}
+ * @see {@link JobPosition} 
+ * @see {@link Workshift}
+ * @see {@link WorkshiftGroup}
+ * @see {@link CompanyBranch}
+ * @see {@link CostCenter}
+ * 
+ */
+export class Employee {
+    /**
+     * Identificador único do colaborador.
+     */
+    private readonly _id: string;
+
+    /**
+     * Código do colaborador.
+     */
+    private readonly _code: number;
+
+    /**
+     * Pessoa do colaborador.
+     */
+    private readonly _person: Person;
+
+    /**
+     * Data de admissão do colaborador.
+     */
+    private readonly _hireDate: Date;
+
+    /**
+     * Data de demissão do colaborador (opcional).
+     */
+    private readonly _dismissalDate: Date | null;
+
+    /**
+     * Vínculo do colaborador.
+     */
+    private readonly _employmentRelationshipId: string;
+
+    /**
+     * Empregador do colaborador.
+     */
+    private readonly _employer: Employer;
+
+    /**
+     * Código do centro de custo do colaborador (opcional).
+     */
+    private readonly _costCenterKey: string;
+
+    /**
+     * Código da filial do colaborador.
+     */
+    private readonly _companyBranchKey: string;
+
+    /**
+     * Código da escala do colaborador.
+     */
+    private readonly _workshiftId: string;
+
+    /**
+     * Código do turno da escala do colaborador.
+     */
+    private readonly _workshiftGroupId: string;
+
+    /**
+     * Código do cargo do colaborador.
+     */
+    private readonly _jobPositionKey: string;
+
+    /**
+     * @hidden
+     * Construtor da classe Employee.
+     * @param params Parâmetros para inicializar o colaborador.
+     */
+    constructor(params: EmployeeParams) {
+        this._id = params.id;
+        this._code = params.code;
+        this._person = params.person;
+        this._hireDate = ObjectUtils.toDateOrThrow(params.hireDate, "Employee.hireDate");
+        this._dismissalDate = ObjectUtils.toDateOrNull(params.dismissalDate);
+        this._employmentRelationshipId = params.employmentRelationshipId;
+        this._employer = params.employer;
+        this._costCenterKey = params.costCenterKey;
+        this._companyBranchKey = params.companyBranchKey;
+        this._workshiftId = params.workshiftId;
+        this._workshiftGroupId = params.workshiftGroupId;
+        this._jobPositionKey = params.jobPositionKey;
+    }
+
+    /**
+     * @hidden
+     * Retorna o identificador único do colaborador.
+     */
+    private get id(): string {
+        return this._id;
+    }
+
+    /**
+     * Retorna o código do colaborador.
+     * @example
+     * ```typescript
+     * employee.code; // Retorna o código do colaborador.
+     * ```
+     *  @returns Código do colaborador.
+     * 
+     */
+    get code(): number {
+        return this._code;
+    }
+
+    /**
+     * Pessoa do colaborador, com informações pessoais como nome.
+     * 
+     * @example
+     * ```typescript
+     * employee.person.name; // Retorna o nome do colaborador.
+     * ```
+     * @return Pessoa do colaborador.
+     * @see {@link Person} 
+     */
+    get person(): Person {
+        return this._person;
+    }
+
+    /**
+     * Retorna a data de admissão do colaborador.
+     * 
+     * @example
+     * ```typescript
+     * employee.hireDate; // Retorna a data de admissão do colaborador.
+     * ```
+     * @return Data de admissão do colaborador.
+     * @see {@link DateUtils}
+     */
+    get hireDate(): Date {
+        return this._hireDate;
+    }
+
+    /**
+     * Retorna a data de demissão do colaborador ou null se não houver.
+     * @example
+     * ```typescript
+     * employee.dismissalDate; // Retorna a data de demissão do colaborador, ou null se não houver.
+     * ```
+     * @return Data de demissão do colaborador ou null se não houver.
+     * @see {@link DateUtils}
+     */
+    get dismissalDate(): Date | null {
+        return this._dismissalDate;
+    }
+
+    /**
+     * @hidden
+     * Retorna o ID do vínculo do colaborador.
+     */
+    private get employmentRelationshipId(): string {
+        return this._employmentRelationshipId;
+    }
+
+    /**
+     * Retorna o vínculo do colaborador.
+     * 
+     * @example
+     * ```typescript
+     * employee.employmentRelationship; // Retorna o vínculo do colaborador.
+     * ```
+     * @return Vínculo do colaborador.
+     * @see {@link EmploymentRelationship}
+     * 
+     */
+    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;
+    }
+
+    /**
+     * Retorna a empresa do colaborador.
+     * @example
+     * ```typescript
+     * const employeer = employee.employer; // Retorna a empresa do colaborador.
+     * employer.code; // Retorna o código da empresa.
+     * ```
+     * @return Empresa do colaborador.
+     * @see {@link Employer}
+     */
+    get employer(): Employer {
+        return this._employer;
+    }
+
+    /**
+     * @hidden
+     * Retorna a chave do contexto do centro de custo.
+     */
+    private get costCenterKey(): string {
+        return this._costCenterKey;
+    }
+
+    /**
+     * Retorna o centro de custo do colaborador ou null se não houver.
+     * @example
+     * ```typescript
+     * const costCenter = employee.costCenter; // Retorna o centro de custo do colaborador, ou null se não houver.
+     * costCenter ? costCenter.code : null; // Retorna o código do centro de custo, ou null.
+     * ```
+     * @return Centro de custo do colaborador ou null se não houver.
+     * @see {@link CostCenter}
+     */
+    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;
+    }
+
+    /**
+     * @hidden
+     * Retorna a chave da filial do colaborador para buscar no context.
+     */
+    private get companyBranchKey(): string {
+        return this._companyBranchKey;
+    }
+
+    /**
+     * @hidden
+     * Retorna o ID da escala do colaborador para buscar no context.
+     */
+    private get workshiftId(): string {
+        return this._workshiftId;
+    }
+
+    /**
+     * @hidden
+     * Retorna o código da turma da escala do colaborador para buscar no context.
+     */
+    private get workshiftGroupId(): string {
+        return this._workshiftGroupId;
+    }
+
+    /**
+     * @hidden
+     * Retorna a chave do cargo do colaborador para buscar no context.
+     */
+    private get jobPositionKey(): string {
+        return this._jobPositionKey;
+    }
+
+    /**
+     * Retorna o cargo do colaborador.
+     * 
+     * @example
+     * ```typescript
+     * const jobPosition = employee.jobPosition; // Retorna o cargo do colaborador.
+     * jobPosition.name; // Retorna o nome do cargo.
+     * ```
+     * @return Cargo do colaborador.
+     * @see {@link JobPosition}
+     */
+    get jobPosition(): JobPosition {
+        const joobPosition = ContextReference.getGlobalInstance().getJobPosition(this._jobPositionKey);
+        if (!joobPosition) {
+            throw new Error(`Job Position with ID ${this._jobPositionKey} not found in context.`);
+        }
+        return joobPosition;
+    }
+
+    /**
+     * Retorna o turma da escala do colaborador.
+     * 
+     * @example
+     * ```typescript
+     * const workshiftGroup = employee.workshiftGroup; // Retorna a o turma da escala do colaborador.
+     * workshiftGroup.code; // Retorna o código do turma da escala.
+     * ```
+     * @return Turma da escala do colaborador.
+     * @see {@link WorkshiftGroup}
+     */
+    get workshiftGroup(): WorkshiftGroup {
+        const workshiftGroup = ContextReference.getGlobalInstance().getWorkshiftGroup(this._workshiftGroupId);
+        if (!workshiftGroup) {
+            throw new Error(`Workshift group with ID ${this._workshiftGroupId} not found in context.`);
+        }
+        return workshiftGroup;
+    }
+
+    /**
+     * Retorna a escala do colaborador.
+     * 
+     * @example
+     * ```typescript
+     * const workshift = employee.workshift; // Retorna a escala do colaborador.
+     * workshift.code; // Retorna o código da escala.
+     * ```
+     * @return Escala do colaborador.
+     * @see {@link Workshift}
+     */
+    get workshift(): Workshift {
+        const workshift = ContextReference.getGlobalInstance().getWorkshift(this._workshiftId);
+        if (!workshift) {
+            throw new Error(`Workshift with ID ${this._workshiftId} not found in context.`);
+        }
+        return workshift;
+    }
+
+    /**
+     * Retorna a filial do colaborador.
+     * @example
+     * ```typescript
+     * const companyBranch = employee.companyBranch; // Retorna a filial do colaborador.
+     * companyBranch.code; // Retorna o código da filial.
+     * ```
+     * @return Filial do colaborador.
+     * @see {@link CompanyBranch}
+     */
+    get companyBranch(): CompanyBranch {
+        const companyBranch = ContextReference.getGlobalInstance().getCompanyBranch(this._companyBranchKey);
+        if (!companyBranch) {
+            throw new Error(`Company branch with ID ${this._companyBranchKey} not found in context.`);
+        }
+        return companyBranch;
+    }
+
+    public static clone(employee: Employee): Employee {
+        return new Employee({
+                id: employee.id,
+                code: employee.code,
+                person: employee.person,
+                hireDate: employee.hireDate,
+                dismissalDate: employee.dismissalDate,
+                employmentRelationshipId: employee.employmentRelationshipId,
+                employer: employee.employer,
+                costCenterKey: employee.costCenterKey,
+                companyBranchKey: employee.companyBranchKey,
+                workshiftId: employee.workshiftId,
+                workshiftGroupId: employee.workshiftGroupId,
+                jobPositionKey: employee.jobPositionKey,
+            });
+        }
+}

package/src/data/foundation/companyBranch.ts

@@ -0,0 +1,66 @@
+/**
+ * @hidden
+ * Parâmetros para a criação de CompanyBranch.
+ */
+export interface CompanyBranchParams {
+    key: string;
+    code: number;
+}
+
+/**
+ * Representa uma filial de empresa.
+ * 
+ * Exemplo de uso:
+ * ```typescript
+ * companyBranch.code; // Retorna o código da filial.
+ * ```
+ * 
+ */
+export class CompanyBranch {
+    private readonly _key: string;
+    private readonly _code: number;
+
+    /**
+     * @hidden
+     * Construtor da classe CompanyBranch.
+     * @param params Parâmetros para inicializar a filial da empresa.
+     */
+    constructor(params: CompanyBranchParams) {
+        this._key = params.key;
+        this._code = params.code;
+    }
+
+    /**
+     * @hidden
+     * Chave única da filial.
+     * @returns Chave única da filial.
+     */
+    static getKey(companyBrach: CompanyBranch): string {
+        return companyBrach.key;
+    }
+
+    private get key(): string {
+        return this._key;
+    }
+
+    /**
+     * Código da filial.
+     * 
+     * @example
+     * ```typescript
+     * companyBranch.code; // Retorna o código da filial.
+     * ```
+     * 
+     * @returns Código da filial.
+     */
+    get code(): number {
+        return this._code;
+    }
+
+    public static clone(companyBranch: CompanyBranch): CompanyBranch {
+        return new CompanyBranch({
+            key: companyBranch.key,
+            code: companyBranch.code
+        });
+    }
+}

package/src/data/foundation/costCenter.ts

@@ -0,0 +1,47 @@
+/**
+ * @hidden
+ */
+export interface CostCenterParams {
+    /**
+     * Código do centro de custo.
+     */
+    code: string;
+}
+
+/**
+ * Representa um centro de custo.
+ * 
+ * @example
+ * ```javascript
+ * console.log(costCenter.code); // Retorna o código do centro de custo.
+ * ```
+ */
+export class CostCenter {
+    /**
+     * Código do centro de custo.
+     */
+    private readonly _code: string;
+
+    /**
+     * @hidden
+     * @param params Parâmetros para a criação de CostCenter.
+     */
+    constructor(params: CostCenterParams) {
+        this._code = params.code;
+    }
+
+
+    /**
+     * Código do centro de custo.
+     * 
+     * @example 
+     * ```javascript
+     * console.log(costCenter.code); // Retorna o código do centro de custo.
+     * ```
+     * 
+     * @returns Código do centro de custo.
+     */
+    get code(): string {
+        return this._code;
+    }
+}

package/src/data/foundation/employer.ts

@@ -0,0 +1,35 @@
+
+/**
+ * @hidden
+ */
+export interface EmployerParams {
+    code: number;
+}
+
+/**
+ * Representa uma empresa no sistema.
+ */
+export class Employer {
+    private readonly _code: number;
+
+    /**
+     * @hidden
+     */
+    constructor(params: EmployerParams) {
+        this._code = params.code;
+    }
+    
+    /**
+     * Retorna o código da empresa.
+     * 
+     * @example
+     * ```typescript
+     * let code = employer.code; // Retorna o código da empresa.
+     *  ```
+     * 
+     * @return Código da empresa.
+     */
+    get code(): number {
+        return this._code;
+    }
+}

package/src/data/foundation/employmentRelationship.ts

@@ -0,0 +1,63 @@
+import { ContractType } from "../contract/contract";
+
+/**
+ * @hidden
+ */
+export interface EmploymentRelationshipParams {
+    id: string;
+    code: string;
+    contractType: ContractType;
+}
+
+/**
+ * Representa um vínculo empregatício.
+ * Um vínculo empregatício é uma associação entre um colaborador e uma empresa, que define o tipo de contrato e outras informações relevantes.
+ */
+export class EmploymentRelationship {
+
+    private readonly _id: string;
+    private readonly _code: string;
+    private readonly _contractType: ContractType;
+
+    /**
+     * @hidden
+     */
+    constructor(params: EmploymentRelationshipParams) {
+        this._id = params.id
+        this._code = params.code;
+        this._contractType = params.contractType;
+    }
+
+    /**
+     * Retorna o identificador único do vínculo empregatício.
+     * @return O ID do vínculo empregatício.
+     * @hidden
+     **/
+    get id(): string {
+        return this._id;
+    }
+    /**
+     * Retorna o código do vínculo empregatício.
+     * 
+     * @example
+     * ```typescript
+     * let code = employmentRelationship.code; // Retorna o código do vínculo empregatício.
+     * ```
+     */
+    get code(): string {
+        return this._code;
+    }
+
+    /**
+     * Retorna tipo de contrato associado ao vínculo empregatício.
+     * @example
+     * ```typescript
+     * let contractType = employmentRelationship.contractType; // Retorna o tipo de contrato associado ao vínculo empregatício.
+     * ```
+     * @return O tipo de contrato associado ao vínculo empregatício.
+     * @see {@link ContractType}
+     */
+    get contractType(): ContractType {
+        return this._contractType;
+    }
+}