@managemint-solutions/entities 1.19.0 → 1.21.0

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

@@ -18,6 +18,9 @@ export declare enum AuditTrailEntityType {
     PROJECTS = "projects",
     TASKS = "tasks",
     TIMESHEETS = "timesheets",
+    LEAVE_TYPES = "leave_types",
+    LEAVE_ENTITLEMENTS = "leave_entitlements",
+    LEAVE_REQUESTS = "leave_requests",
     BILLING_TRANSACTIONS = "billing_transactions",
     INVOICE = "invoices",
     NOTIFICATION = "notifications"

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

@@ -23,6 +23,9 @@ var AuditTrailEntityType;
     AuditTrailEntityType["PROJECTS"] = "projects";
     AuditTrailEntityType["TASKS"] = "tasks";
     AuditTrailEntityType["TIMESHEETS"] = "timesheets";
+    AuditTrailEntityType["LEAVE_TYPES"] = "leave_types";
+    AuditTrailEntityType["LEAVE_ENTITLEMENTS"] = "leave_entitlements";
+    AuditTrailEntityType["LEAVE_REQUESTS"] = "leave_requests";
     AuditTrailEntityType["BILLING_TRANSACTIONS"] = "billing_transactions";
     AuditTrailEntityType["INVOICE"] = "invoices";
     AuditTrailEntityType["NOTIFICATION"] = "notifications";

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

@@ -0,0 +1,89 @@
+import { LeaveRequestStatus, LeaveReviewDecision } from '../enum';
+/**
+ * The wire shapes of the leave 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.
+ *
+ * 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 LeaveTypeIdDto = {
+    leaveTypeId: string;
+};
+export type GetLeaveTypesDto = {
+    /** Omitted = every type; true/false filters on the flag. */
+    active?: boolean | null;
+};
+export type CreateLeaveTypeDto = {
+    name: string;
+    description: string | null;
+    default_days: number;
+    is_paid: boolean;
+    requires_approval: boolean;
+};
+export type UpdateLeaveTypeDto = {
+    name: string;
+    description: string | null;
+    default_days: number;
+    is_paid: boolean;
+    requires_approval: boolean;
+    active: boolean;
+};
+export type LeaveEntitlementIdDto = {
+    leaveEntitlementId: string;
+};
+export type GetLeaveEntitlementsDto = {
+    page: number;
+    page_size: number;
+    user_id?: string | null;
+    leave_type_id?: string | null;
+    /** Keep only entitlements whose period contains this date. */
+    as_of?: string | null;
+};
+export type CreateLeaveEntitlementDto = {
+    user_id: string;
+    leave_type_id: string;
+    days_entitled: number;
+    /** Null = the organization's current leave year. */
+    period_start: string | null;
+    /** Null = one year after `period_start`, less a day. */
+    period_end: string | null;
+    notes: string | null;
+};
+export type UpdateLeaveEntitlementDto = {
+    days_entitled: number;
+    period_end: string;
+    notes: string | null;
+};
+export type LeaveRequestIdDto = {
+    leaveRequestId: string;
+};
+/** One list for everyone: `user_id` narrows it (to yourself, say); the api scopes what is visible. */
+export type GetLeaveRequestsDto = {
+    page: number;
+    page_size: number;
+    user_id?: string | null;
+    status?: LeaveRequestStatus | null;
+    start_date_after?: string | null;
+    start_date_before?: string | null;
+};
+/** Always the caller's own request: there is no `user_id` to file on someone's behalf. */
+export type CreateLeaveRequestDto = {
+    leave_type_id: string;
+    start_date: string;
+    end_date: string;
+    is_half_day: boolean;
+    reason: string | null;
+};
+/** Only a pending request can be edited; the days are recounted from what is sent. */
+export type UpdateLeaveRequestDto = {
+    leave_type_id: string;
+    start_date: string;
+    end_date: string;
+    is_half_day: boolean;
+    reason: string | null;
+};
+export type ReviewLeaveRequestDto = {
+    status: LeaveReviewDecision;
+    review_note: string | null;
+};

package/dist/leave/dto/index.js

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

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

@@ -0,0 +1,17 @@
+/**
+ * The lifecycle of a leave request. Stored as text on `leave_requests.status` and validated
+ * here, never by a Postgres enum. `pending` moves to any of the other three; `approved` may
+ * still be cancelled (a future booking the employee no longer needs); `rejected` and
+ * `cancelled` are terminal.
+ */
+export declare enum LeaveRequestStatus {
+    PENDING = "pending",
+    APPROVED = "approved",
+    REJECTED = "rejected",
+    CANCELLED = "cancelled"
+}
+/** The two outcomes a reviewer may give a pending request. */
+export declare enum LeaveReviewDecision {
+    APPROVED = "approved",
+    REJECTED = "rejected"
+}

package/dist/leave/enum/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeaveReviewDecision = exports.LeaveRequestStatus = void 0;
+/**
+ * The lifecycle of a leave request. Stored as text on `leave_requests.status` and validated
+ * here, never by a Postgres enum. `pending` moves to any of the other three; `approved` may
+ * still be cancelled (a future booking the employee no longer needs); `rejected` and
+ * `cancelled` are terminal.
+ */
+var LeaveRequestStatus;
+(function (LeaveRequestStatus) {
+    LeaveRequestStatus["PENDING"] = "pending";
+    LeaveRequestStatus["APPROVED"] = "approved";
+    LeaveRequestStatus["REJECTED"] = "rejected";
+    LeaveRequestStatus["CANCELLED"] = "cancelled";
+})(LeaveRequestStatus || (exports.LeaveRequestStatus = LeaveRequestStatus = {}));
+/** The two outcomes a reviewer may give a pending request. */
+var LeaveReviewDecision;
+(function (LeaveReviewDecision) {
+    LeaveReviewDecision["APPROVED"] = "approved";
+    LeaveReviewDecision["REJECTED"] = "rejected";
+})(LeaveReviewDecision || (exports.LeaveReviewDecision = LeaveReviewDecision = {}));

package/dist/leave/index.d.ts

@@ -0,0 +1,79 @@
+import { LeaveRequestStatus } from './enum';
+import { UserIdentity } from '../users';
+export * from './enum';
+/**
+ * Leave, the first slice of the HR module: leave types, per-user entitlements and leave
+ * requests. Every date below is a calendar date (`YYYY-MM-DD`), never a timestamp - leave is
+ * booked by day, and the columns are `date` in Postgres. The public-holiday calendar the
+ * day count reads lives in `../public-holidays`.
+ */
+export type LeaveTypeIdentity = {
+    mms_id: string;
+    name: string;
+};
+export type LeaveTypeEntity = {
+    mms_id: string;
+    created_at: string;
+    created_by: UserIdentity | null;
+    updated_at: string | null;
+    last_updated_by: UserIdentity | null;
+    name: string;
+    description: string | null;
+    /** The days a full year of this type is worth - the suggested entitlement. */
+    default_days: number;
+    is_paid: boolean;
+    /** False auto-approves a request on submission. */
+    requires_approval: boolean;
+    /** An inactive type keeps its history but cannot be chosen for new requests. */
+    active: boolean;
+};
+/** The window an entitlement covers - normally the organization's leave year. */
+export type LeavePeriod = {
+    period_start: string;
+    period_end: string;
+};
+export type LeaveEntitlementEntity = LeavePeriod & {
+    mms_id: string;
+    created_at: string;
+    created_by: UserIdentity | null;
+    updated_at: string | null;
+    last_updated_by: UserIdentity | null;
+    user: UserIdentity;
+    leave_type: LeaveTypeIdentity;
+    days_entitled: number;
+    notes: string | null;
+    /**
+     * Computed on read, never stored: the approved and pending requests of this user and
+     * type whose start date falls inside the period. `days_remaining` already subtracts both.
+     */
+    days_used: number;
+    days_pending: number;
+    days_remaining: number;
+};
+export type LeaveRequestEntity = {
+    mms_id: string;
+    created_at: string;
+    created_by: UserIdentity | null;
+    updated_at: string | null;
+    last_updated_by: UserIdentity | null;
+    user: UserIdentity;
+    leave_type: LeaveTypeIdentity;
+    start_date: string;
+    end_date: string;
+    /** Only for a single-day request; halves its `days`. */
+    is_half_day: boolean;
+    /**
+     * Working days (Monday to Friday, less the organization's public holidays) as counted
+     * when the request was submitted or last edited. A snapshot: a holiday added afterwards
+     * does not rewrite approved history.
+     */
+    days: number;
+    reason: string | null;
+    status: LeaveRequestStatus;
+    /** Null on an auto-approved request (`requires_approval` was false). */
+    reviewed_by: UserIdentity | null;
+    reviewed_at: string | null;
+    review_note: string | null;
+    cancelled_by: UserIdentity | null;
+    cancelled_at: string | null;
+};

package/dist/leave/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/modules/index.d.ts

@@ -8,6 +8,7 @@
  */
 export declare const MODULE_KEYS: {
     readonly CRM: "CRM";
+    readonly HR: "HR";
 };
 /**
  * A row of the billing_modules catalog: one row per sellable module, no pricing.

package/dist/modules/index.js

@@ -11,4 +11,5 @@ exports.MODULE_KEYS = void 0;
  */
 exports.MODULE_KEYS = {
     CRM: 'CRM',
+    HR: 'HR',
 };

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

@@ -13,6 +13,9 @@ export declare enum NotificationType {
     PROJECT_MANAGER_ASSIGNED = "project_manager_assigned",
     PAYMENT_FAILED = "payment_failed",
     INVOICE_PAID = "invoice_paid",
+    LEAVE_REQUEST_SUBMITTED = "leave_request_submitted",
+    LEAVE_REQUEST_APPROVED = "leave_request_approved",
+    LEAVE_REQUEST_REJECTED = "leave_request_rejected",
     SIGNUP_CONFIRMATION = "signup_confirmation",
     PASSWORD_RECOVERY = "password_recovery"
 }

package/dist/notifications/enum/index.js

@@ -21,6 +21,9 @@ var NotificationType;
     NotificationType["PROJECT_MANAGER_ASSIGNED"] = "project_manager_assigned";
     NotificationType["PAYMENT_FAILED"] = "payment_failed";
     NotificationType["INVOICE_PAID"] = "invoice_paid";
+    NotificationType["LEAVE_REQUEST_SUBMITTED"] = "leave_request_submitted";
+    NotificationType["LEAVE_REQUEST_APPROVED"] = "leave_request_approved";
+    NotificationType["LEAVE_REQUEST_REJECTED"] = "leave_request_rejected";
     NotificationType["SIGNUP_CONFIRMATION"] = "signup_confirmation";
     NotificationType["PASSWORD_RECOVERY"] = "password_recovery";
 })(NotificationType || (exports.NotificationType = NotificationType = {}));

package/dist/public-holidays/dto/index.d.ts

@@ -0,0 +1,5 @@
+/** The one route, a read. There is no body DTO: the calendar is edited in Supabase Studio. */
+export type GetPublicHolidaysDto = {
+    /** Omitted = every holiday on record. */
+    year?: number | null;
+};

package/dist/public-holidays/dto/index.js

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

package/dist/public-holidays/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The public-holiday calendar: the dates that are not working days when a leave request's
+ * days are counted. Global, like configs - a holiday is a fact about the country, not a
+ * tenant, so every organization reads the same list. Read-only through the api; the rows
+ * are maintained in Supabase Studio and carry no author stamps and no audit trail.
+ */
+export type PublicHolidayEntity = {
+    mms_id: string;
+    created_at: string;
+    name: string;
+    date: string;
+    /**
+     * Null means the holiday applies to everyone and shortens a request. A faith-specific
+     * holiday (several may share a date) is on the calendar only, since nothing yet records
+     * which employees observe it.
+     */
+    religion: string | null;
+    notes: string | null;
+};

package/dist/public-holidays/index.js

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

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

@@ -1,20 +1,19 @@
 /**
- * The contract for the portal's edge cache of each member's own `GET /users/me`.
+ * The contract for the portal's Redis cache of each member's own `GET /users/me`.
  *
- * The portal owns the cache (Upstash Redis through the sdk cache subpath, one entry per
- * member, written on a miss); the api never reads it and only invalidates tags after a write. Both sides import
- * these so a change to the shape or the tagging is one edit.
+ * One hash per organization, `profiles:v1:<organization_id>`, with one field per member
+ * named by their `mms_id` and holding their `LoggedInUser`. The portal writes a field on a
+ * miss; the api never reads the hash and only deletes a field (a member's write) or the
+ * whole hash (a write that changes every member's profile). Both sides build the key from
+ * these constants - the builder itself lives in `@managemint-solutions/sdk/cache`.
  */
-/** Bump when the LoggedInUser wire shape changes; old entries simply stop matching. */
-export declare const USER_ME_CACHE_VERSION = "v1";
-/** The hard ceiling on how stale a cached profile may be, in seconds (one day). */
-export declare const USER_ME_CACHE_TTL_SECONDS = 86400;
-/** The cache key of one member's LoggedInUser blob. Portal-internal; versioned here. */
-export declare const userMeCacheKey: (mmsId: string) => string;
-/** Expiring this tag drops one member's blob - every write to that member's row or permissions. */
-export declare const userCacheTag: (mmsId: string) => string;
+/** Bump when the LoggedInUser wire shape changes; old hashes simply stop matching. */
+export declare const PROFILE_CACHE_VERSION = "v1";
+/** The hash key is this prefix followed by the organization's `mms_id`. */
+export declare const PROFILE_CACHE_KEY_PREFIX = "profiles:v1:";
 /**
- * Expiring this tag drops every member's blob in the organization - a write that changes
- * what all of them see (the module set folded into their permissions).
+ * The hard ceiling on how stale a cached profile may be, in seconds (one day). Set once,
+ * when a hash is first written, so an organization's whole cache re-reads once a day
+ * however busy it is.
  */
-export declare const organizationCacheTag: (organizationId: string) => string;
+export declare const PROFILE_CACHE_TTL_SECONDS = 86400;

package/dist/users/cache/index.js

@@ -1,26 +1,22 @@
 "use strict";
 /**
- * The contract for the portal's edge cache of each member's own `GET /users/me`.
+ * The contract for the portal's Redis cache of each member's own `GET /users/me`.
  *
- * The portal owns the cache (Upstash Redis through the sdk cache subpath, one entry per
- * member, written on a miss); the api never reads it and only invalidates tags after a write. Both sides import
- * these so a change to the shape or the tagging is one edit.
+ * One hash per organization, `profiles:v1:<organization_id>`, with one field per member
+ * named by their `mms_id` and holding their `LoggedInUser`. The portal writes a field on a
+ * miss; the api never reads the hash and only deletes a field (a member's write) or the
+ * whole hash (a write that changes every member's profile). Both sides build the key from
+ * these constants - the builder itself lives in `@managemint-solutions/sdk/cache`.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.organizationCacheTag = exports.userCacheTag = exports.userMeCacheKey = exports.USER_ME_CACHE_TTL_SECONDS = exports.USER_ME_CACHE_VERSION = void 0;
-/** Bump when the LoggedInUser wire shape changes; old entries simply stop matching. */
-exports.USER_ME_CACHE_VERSION = 'v1';
-/** The hard ceiling on how stale a cached profile may be, in seconds (one day). */
-exports.USER_ME_CACHE_TTL_SECONDS = 86400;
-/** The cache key of one member's LoggedInUser blob. Portal-internal; versioned here. */
-const userMeCacheKey = (mmsId) => `user:me:${exports.USER_ME_CACHE_VERSION}:${mmsId}`;
-exports.userMeCacheKey = userMeCacheKey;
-/** Expiring this tag drops one member's blob - every write to that member's row or permissions. */
-const userCacheTag = (mmsId) => `user:${mmsId}`;
-exports.userCacheTag = userCacheTag;
+exports.PROFILE_CACHE_TTL_SECONDS = exports.PROFILE_CACHE_KEY_PREFIX = exports.PROFILE_CACHE_VERSION = void 0;
+/** Bump when the LoggedInUser wire shape changes; old hashes simply stop matching. */
+exports.PROFILE_CACHE_VERSION = 'v1';
+/** The hash key is this prefix followed by the organization's `mms_id`. */
+exports.PROFILE_CACHE_KEY_PREFIX = `profiles:${exports.PROFILE_CACHE_VERSION}:`;
 /**
- * Expiring this tag drops every member's blob in the organization - a write that changes
- * what all of them see (the module set folded into their permissions).
+ * The hard ceiling on how stale a cached profile may be, in seconds (one day). Set once,
+ * when a hash is first written, so an organization's whole cache re-reads once a day
+ * however busy it is.
  */
-const organizationCacheTag = (organizationId) => `org:${organizationId}`;
-exports.organizationCacheTag = organizationCacheTag;
+exports.PROFILE_CACHE_TTL_SECONDS = 86400;

package/dist/users/index.d.ts

@@ -138,6 +138,9 @@ export interface Permissions {
         project_budgets: CrudPermission;
         tasks: CrudPermission;
         invoices: Omit<CrudPermission, 'create' | 'update' | 'delete'>;
+        leave_types: CrudPermission;
+        leave_entitlements: CrudPermission;
+        leave_requests: CrudPermission;
         users: CrudPermission;
         user_permissions: Omit<CrudPermission, 'create' | 'delete'>;
         organizations: Omit<CrudPermission, 'create' | 'delete'>;

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

@@ -11,6 +11,18 @@ export type UpdatePermissionsDto = {
     read_tasks: boolean;
     update_tasks: boolean;
     delete_tasks: boolean;
+    create_leave: boolean;
+    read_leave: boolean;
+    update_leave: boolean;
+    delete_leave: boolean;
+    create_leave_types: boolean;
+    read_leave_types: boolean;
+    update_leave_types: boolean;
+    delete_leave_types: boolean;
+    create_leave_requests: boolean;
+    read_leave_requests: boolean;
+    update_leave_requests: boolean;
+    delete_leave_requests: boolean;
     read_invoices: boolean;
     create_users: boolean;
     read_users: boolean;

package/package.json

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