@managemint-solutions/entities 1.22.1 → 1.23.1

package/dist/audit-trail/enum/index.d.ts

@@ -18,6 +18,7 @@ export declare enum AuditTrailEntityType {
     PROJECTS = "projects",
     TASKS = "tasks",
     TIMESHEETS = "timesheets",
+    TIMESHEET_ENTRIES = "timesheet_entries",
     LEAVE_TYPES = "leave_types",
     LEAVE_ENTITLEMENTS = "leave_entitlements",
     LEAVE_REQUESTS = "leave_requests",

package/dist/audit-trail/enum/index.js

@@ -23,6 +23,7 @@ var AuditTrailEntityType;
     AuditTrailEntityType["PROJECTS"] = "projects";
     AuditTrailEntityType["TASKS"] = "tasks";
     AuditTrailEntityType["TIMESHEETS"] = "timesheets";
+    AuditTrailEntityType["TIMESHEET_ENTRIES"] = "timesheet_entries";
     AuditTrailEntityType["LEAVE_TYPES"] = "leave_types";
     AuditTrailEntityType["LEAVE_ENTITLEMENTS"] = "leave_entitlements";
     AuditTrailEntityType["LEAVE_REQUESTS"] = "leave_requests";

package/dist/leave/dto/index.d.ts

@@ -20,6 +20,7 @@ export type CreateLeaveTypeDto = {
     default_days: number;
     is_paid: boolean;
     requires_approval: boolean;
+    requires_document: boolean;
 };
 export type UpdateLeaveTypeDto = {
     name: string;
@@ -27,6 +28,7 @@ export type UpdateLeaveTypeDto = {
     default_days: number;
     is_paid: boolean;
     requires_approval: boolean;
+    requires_document: boolean;
     active: boolean;
 };
 export type LeaveEntitlementIdDto = {
@@ -48,11 +50,13 @@ export type CreateLeaveEntitlementDto = {
     period_start: string | null;
     /** Null = one year after `period_start`, less a day. */
     period_end: string | null;
+    max_carry_over_days: number;
     notes: string | null;
 };
 export type UpdateLeaveEntitlementDto = {
     days_entitled: number;
     period_end: string;
+    max_carry_over_days: number;
     notes: string | null;
 };
 export type LeaveRequestIdDto = {

package/dist/leave/index.d.ts

@@ -10,6 +10,8 @@ export * from './enum';
 export type LeaveTypeIdentity = {
     mms_id: string;
     name: string;
+    /** Carried on requests and entitlements so a reviewer knows without a second fetch. */
+    requires_document: boolean;
 };
 export type LeaveTypeEntity = {
     mms_id: string;
@@ -24,6 +26,8 @@ export type LeaveTypeEntity = {
     is_paid: boolean;
     /** False auto-approves a request on submission. */
     requires_approval: boolean;
+    /** Approval waits until a supporting file is attached to the request; implies `requires_approval`. */
+    requires_document: boolean;
     /** An inactive type keeps its history but cannot be chosen for new requests. */
     active: boolean;
 };
@@ -41,6 +45,8 @@ export type LeaveEntitlementEntity = LeavePeriod & {
     user: UserIdentity;
     leave_type: LeaveTypeIdentity;
     days_entitled: number;
+    /** Cap on the unused days the nightly rollover carries into the next period. */
+    max_carry_over_days: number;
     notes: string | null;
     /**
      * Computed on read, never stored: the approved and pending requests of this user and

package/dist/notifications/enum/index.d.ts

@@ -16,6 +16,9 @@ export declare enum NotificationType {
     LEAVE_REQUEST_SUBMITTED = "leave_request_submitted",
     LEAVE_REQUEST_APPROVED = "leave_request_approved",
     LEAVE_REQUEST_REJECTED = "leave_request_rejected",
+    TIMESHEET_SUBMITTED = "timesheet_submitted",
+    TIMESHEET_APPROVED = "timesheet_approved",
+    TIMESHEET_REJECTED = "timesheet_rejected",
     SIGNUP_CONFIRMATION = "signup_confirmation",
     PASSWORD_RECOVERY = "password_recovery"
 }

package/dist/notifications/enum/index.js

@@ -24,6 +24,9 @@ var NotificationType;
     NotificationType["LEAVE_REQUEST_SUBMITTED"] = "leave_request_submitted";
     NotificationType["LEAVE_REQUEST_APPROVED"] = "leave_request_approved";
     NotificationType["LEAVE_REQUEST_REJECTED"] = "leave_request_rejected";
+    NotificationType["TIMESHEET_SUBMITTED"] = "timesheet_submitted";
+    NotificationType["TIMESHEET_APPROVED"] = "timesheet_approved";
+    NotificationType["TIMESHEET_REJECTED"] = "timesheet_rejected";
     NotificationType["SIGNUP_CONFIRMATION"] = "signup_confirmation";
     NotificationType["PASSWORD_RECOVERY"] = "password_recovery";
 })(NotificationType || (exports.NotificationType = NotificationType = {}));

package/dist/tasks/index.d.ts

@@ -16,6 +16,8 @@ export type TaskSummary = {
     status: StatusEntity | null;
     priority: number;
     assigned_to: UserIdentity | null;
+    project: ProjectIdentity | null;
+    client: ClientIdentity | null;
 };
 export type TaskEntity = {
     mms_id: string;

package/dist/timesheets/dto/index.d.ts

@@ -0,0 +1,57 @@
+import { TimesheetReviewDecision, TimesheetStatus } from '../enum';
+/**
+ * The wire shapes of the timesheet routes. The api runs a global ValidationPipe with
+ * `forbidNonWhitelisted`, so every field a route accepts is declared here and mirrored by
+ * the sdk's class-validator DTO. Dates travel as `YYYY-MM-DD` strings, times as `HH:MM`.
+ *
+ * Body fields are required keys: a field that may be empty is sent as `null`, never left
+ * out, so a payload always says what it means. Only query-string filters are optional.
+ */
+export type TimesheetIdDto = {
+    timesheetId: string;
+};
+/** One list for everyone: `user_id` narrows it (to yourself, say); the api scopes what is visible. */
+export type GetTimesheetsDto = {
+    page: number;
+    page_size: number;
+    user_id?: string | null;
+    status?: TimesheetStatus | null;
+    /** A Monday; keeps only that week. */
+    week_start?: string | null;
+};
+export type ReviewTimesheetDto = {
+    status: TimesheetReviewDecision;
+    review_note: string | null;
+};
+/** Approved weeks only; the span may not exceed a year. */
+export type GetTimesheetReportDto = {
+    date_from: string;
+    date_to: string;
+    user_id?: string | null;
+};
+export type TimesheetEntryIdDto = {
+    timesheetEntryId: string;
+};
+/**
+ * Always the caller's own entry: there is no `user_id` to log on someone's behalf. The week
+ * is found or created from `date`; the duration is derived from the two times.
+ */
+export type CreateTimesheetEntryDto = {
+    date: string;
+    start_time: string;
+    end_time: string;
+    client_id: string | null;
+    project_id: string | null;
+    task_id: string | null;
+    description: string | null;
+};
+/** Only an entry in a draft or rejected week can be edited; a moved date checks both weeks. */
+export type UpdateTimesheetEntryDto = {
+    date: string;
+    start_time: string;
+    end_time: string;
+    client_id: string | null;
+    project_id: string | null;
+    task_id: string | null;
+    description: string | null;
+};

package/dist/timesheets/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/timesheets/enum/index.d.ts

@@ -1,5 +1,17 @@
+/**
+ * The lifecycle of a timesheet week. Stored as text on `timesheets.status` and validated
+ * here, never by a Postgres enum. A week is created as `draft` by its first entry, moves to
+ * `submitted` when the employee sends it, then to `approved` (entries lock) or `rejected`
+ * (entries reopen and the week may be submitted again).
+ */
 export declare enum TimesheetStatus {
+    DRAFT = "draft",
     SUBMITTED = "submitted",
     APPROVED = "approved",
     REJECTED = "rejected"
 }
+/** The two outcomes a reviewer may give a submitted week. */
+export declare enum TimesheetReviewDecision {
+    APPROVED = "approved",
+    REJECTED = "rejected"
+}

package/dist/timesheets/enum/index.js

@@ -1,10 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimesheetStatus = void 0;
+exports.TimesheetReviewDecision = exports.TimesheetStatus = void 0;
+/**
+ * The lifecycle of a timesheet week. Stored as text on `timesheets.status` and validated
+ * here, never by a Postgres enum. A week is created as `draft` by its first entry, moves to
+ * `submitted` when the employee sends it, then to `approved` (entries lock) or `rejected`
+ * (entries reopen and the week may be submitted again).
+ */
 var TimesheetStatus;
 (function (TimesheetStatus) {
+    TimesheetStatus["DRAFT"] = "draft";
     TimesheetStatus["SUBMITTED"] = "submitted";
     TimesheetStatus["APPROVED"] = "approved";
     TimesheetStatus["REJECTED"] = "rejected";
 })(TimesheetStatus || (exports.TimesheetStatus = TimesheetStatus = {}));
 ;
+/** The two outcomes a reviewer may give a submitted week. */
+var TimesheetReviewDecision;
+(function (TimesheetReviewDecision) {
+    TimesheetReviewDecision["APPROVED"] = "approved";
+    TimesheetReviewDecision["REJECTED"] = "rejected";
+})(TimesheetReviewDecision || (exports.TimesheetReviewDecision = TimesheetReviewDecision = {}));

package/dist/timesheets/index.d.ts

@@ -0,0 +1,83 @@
+import { TimesheetStatus } from './enum';
+import { UserIdentity } from '../users';
+import { ClientIdentity } from '../clients';
+import { ProjectIdentity } from '../projects';
+import { TaskIdentity } from '../tasks';
+export * from './enum';
+/**
+ * Timesheets, the second slice of the HR module: time entries an employee logs against a
+ * Monday-to-Sunday week, submits as one, and a manager approves or rejects with a note.
+ * Dates are calendar dates (`YYYY-MM-DD`); times are wall-clock `HH:MM` on that date, so an
+ * entry never crosses midnight - split it. The same reporting line as leave decides who sees
+ * and reviews what.
+ */
+export type TimesheetEntryEntity = {
+    mms_id: string;
+    created_at: string;
+    created_by: UserIdentity | null;
+    updated_at: string | null;
+    last_updated_by: UserIdentity | null;
+    /** The week this entry belongs to, created as a draft by the first entry dated inside it. */
+    timesheet_id: string;
+    user: UserIdentity;
+    date: string;
+    /** `HH:MM`; `24:00` is allowed as an end for a shift finishing at midnight. */
+    start_time: string;
+    end_time: string;
+    /** Stored by Postgres from the two times, never sent by the client. */
+    duration_minutes: number;
+    /** Optional attribution; each survives the deletion of what it points at as null. */
+    client: ClientIdentity | null;
+    project: ProjectIdentity | null;
+    task: TaskIdentity | null;
+    description: string | null;
+};
+/** One week as the list shows it: the totals are counted on read, never stored. */
+export type TimesheetSummary = {
+    mms_id: string;
+    created_at: string;
+    created_by: UserIdentity | null;
+    updated_at: string | null;
+    last_updated_by: UserIdentity | null;
+    user: UserIdentity;
+    /** Always a Monday; `week_end` is its Sunday. */
+    week_start: string;
+    week_end: string;
+    status: TimesheetStatus;
+    /** Null while the week is a draft; reset when a rejected week is resubmitted. */
+    submitted_at: string | null;
+    reviewed_by: UserIdentity | null;
+    reviewed_at: string | null;
+    review_note: string | null;
+    total_minutes: number;
+    entry_count: number;
+};
+export type TimesheetEntity = TimesheetSummary & {
+    entries: TimesheetEntryEntity[];
+};
+/**
+ * Hours over a date range, approved weeks only, grouped four ways from the same entries.
+ * Null `client` / `project` collects the entries logged without one.
+ */
+export type TimesheetReportEntity = {
+    date_from: string;
+    date_to: string;
+    total_minutes: number;
+    by_user: {
+        user: UserIdentity;
+        total_minutes: number;
+    }[];
+    by_client: {
+        client: ClientIdentity | null;
+        total_minutes: number;
+    }[];
+    by_project: {
+        project: ProjectIdentity | null;
+        client: ClientIdentity | null;
+        total_minutes: number;
+    }[];
+    by_day: {
+        date: string;
+        total_minutes: number;
+    }[];
+};

package/dist/timesheets/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./enum"), exports);

package/dist/users/dto/index.d.ts

@@ -31,6 +31,8 @@ export type UpdateUserDto = {
     employment_type?: EmploymentType | null;
     job_title?: string | null;
     manager_id?: string | null;
+    /** Must differ from `manager_id` and needs a manager set first; the api refuses otherwise. */
+    secondary_manager_id?: string | null;
     social_facebook?: string | null;
     social_linkedin?: string | null;
     social_twitter?: string | null;
@@ -49,7 +51,7 @@ export type UpdateUserDto = {
  * behind `update_users`. Absent here on purpose:
  *   job_title, employment_type,
  *   start_date, end_date  - HR-owned work details, not self-service
- *   manager_id            - an org structure decision
+ *   manager_id, secondary_manager_id - an org structure decision
  *   email                 - GoTrue's, changed through the auth flow
  *   profile_image         - set by POST /users/me/profile-image, never by the client
  */

package/dist/users/index.d.ts

@@ -32,6 +32,8 @@ export interface UserEntity {
     updated_at: Date | null;
     last_updated_by: UserIdentity | null;
     manager: UserIdentity | null;
+    /** Either manager may review a report's leave and timesheets; only the primary is emailed. */
+    secondary_manager: UserIdentity | null;
     birthday: Date | null;
     employment_type: EmploymentType;
     job_title: string | null;
@@ -137,6 +139,7 @@ export interface Permissions {
         projects: CrudPermission;
         project_budgets: CrudPermission;
         tasks: CrudPermission;
+        timesheets: CrudPermission;
         invoices: Omit<CrudPermission, 'create' | 'update' | 'delete'>;
         leave_types: CrudPermission;
         leave_entitlements: CrudPermission;

package/dist/users/permissions/dto/index.d.ts

@@ -11,6 +11,10 @@ export type UpdatePermissionsDto = {
     read_tasks: boolean;
     update_tasks: boolean;
     delete_tasks: boolean;
+    create_timesheets: boolean;
+    read_timesheets: boolean;
+    update_timesheets: boolean;
+    delete_timesheets: boolean;
     create_leave: boolean;
     read_leave: boolean;
     update_leave: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.22.1",
+  "version": "1.23.1",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {