@iveri/contracts 0.53.0 → 0.54.0

package/dist/api/hr/hr-access-action.enum.d.ts

@@ -0,0 +1,7 @@
+/** What somebody did with pay or identity numbers, as written to the access log. */
+export declare enum HrAccessAction {
+    READ_SENSITIVE = "read-sensitive",
+    CHANGE_SENSITIVE = "change-sensitive",
+    READ_PAY = "read-pay",
+    CHANGE_PAY = "change-pay"
+}

package/dist/api/hr/hr-access-action.enum.js

@@ -0,0 +1,8 @@
+/** What somebody did with pay or identity numbers, as written to the access log. */
+export var HrAccessAction;
+(function (HrAccessAction) {
+    HrAccessAction["READ_SENSITIVE"] = "read-sensitive";
+    HrAccessAction["CHANGE_SENSITIVE"] = "change-sensitive";
+    HrAccessAction["READ_PAY"] = "read-pay";
+    HrAccessAction["CHANGE_PAY"] = "change-pay";
+})(HrAccessAction || (HrAccessAction = {}));

package/dist/api/hr/hr-employment-event-kind.enum.d.ts

@@ -0,0 +1,8 @@
+export declare enum HrEmploymentEventKind {
+    HIRED = "hired",
+    /** Their department, job title, location, manager or employment type changed. */
+    JOB_CHANGED = "job-changed",
+    LEFT = "left",
+    /** A last day that was set has been withdrawn. */
+    STAYED = "stayed"
+}

package/dist/api/hr/hr-employment-event-kind.enum.js

@@ -0,0 +1,9 @@
+export var HrEmploymentEventKind;
+(function (HrEmploymentEventKind) {
+    HrEmploymentEventKind["HIRED"] = "hired";
+    /** Their department, job title, location, manager or employment type changed. */
+    HrEmploymentEventKind["JOB_CHANGED"] = "job-changed";
+    HrEmploymentEventKind["LEFT"] = "left";
+    /** A last day that was set has been withdrawn. */
+    HrEmploymentEventKind["STAYED"] = "stayed";
+})(HrEmploymentEventKind || (HrEmploymentEventKind = {}));

package/dist/api/hr/hr-employment-status.enum.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Where somebody is in their employment, worked out from their dates on every read.
+ *
+ * Never stored: a column would need a sweep to stay true, and would be wrong whenever the sweep was late.
+ */
+export declare enum HrEmploymentStatus {
+    /** Their first day is still to come. */
+    UPCOMING = "upcoming",
+    ACTIVE = "active",
+    /** A last day is set and has not passed. */
+    LEAVING = "leaving",
+    FORMER = "former"
+}

package/dist/api/hr/hr-employment-status.enum.js

@@ -0,0 +1,14 @@
+/**
+ * Where somebody is in their employment, worked out from their dates on every read.
+ *
+ * Never stored: a column would need a sweep to stay true, and would be wrong whenever the sweep was late.
+ */
+export var HrEmploymentStatus;
+(function (HrEmploymentStatus) {
+    /** Their first day is still to come. */
+    HrEmploymentStatus["UPCOMING"] = "upcoming";
+    HrEmploymentStatus["ACTIVE"] = "active";
+    /** A last day is set and has not passed. */
+    HrEmploymentStatus["LEAVING"] = "leaving";
+    HrEmploymentStatus["FORMER"] = "former";
+})(HrEmploymentStatus || (HrEmploymentStatus = {}));

package/dist/api/hr/hr-employment-type.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum HrEmploymentType {
+    FULL_TIME = "full-time",
+    PART_TIME = "part-time",
+    CONTRACTOR = "contractor",
+    INTERN = "intern"
+}

package/dist/api/hr/hr-employment-type.enum.js

@@ -0,0 +1,7 @@
+export var HrEmploymentType;
+(function (HrEmploymentType) {
+    HrEmploymentType["FULL_TIME"] = "full-time";
+    HrEmploymentType["PART_TIME"] = "part-time";
+    HrEmploymentType["CONTRACTOR"] = "contractor";
+    HrEmploymentType["INTERN"] = "intern";
+})(HrEmploymentType || (HrEmploymentType = {}));

package/dist/api/hr/hr-leave-accrual.enum.d.ts

@@ -0,0 +1,7 @@
+/** How a leave type's yearly allowance arrives. */
+export declare enum HrLeaveAccrual {
+    /** All of it on the first day of the year. */
+    UPFRONT = "upfront",
+    /** A twelfth each month. */
+    MONTHLY = "monthly"
+}

package/dist/api/hr/hr-leave-accrual.enum.js

@@ -0,0 +1,8 @@
+/** How a leave type's yearly allowance arrives. */
+export var HrLeaveAccrual;
+(function (HrLeaveAccrual) {
+    /** All of it on the first day of the year. */
+    HrLeaveAccrual["UPFRONT"] = "upfront";
+    /** A twelfth each month. */
+    HrLeaveAccrual["MONTHLY"] = "monthly";
+})(HrLeaveAccrual || (HrLeaveAccrual = {}));

package/dist/api/hr/hr-leave-ledger-kind.enum.d.ts

@@ -0,0 +1,9 @@
+/** Why a leave balance moved. A balance is the sum of these and is never stored. */
+export declare enum HrLeaveLedgerKind {
+    ALLOWANCE = "allowance",
+    ACCRUAL = "accrual",
+    CARRY_OVER = "carry-over",
+    ADJUSTMENT = "adjustment",
+    TAKEN = "taken",
+    RETURNED = "returned"
+}

package/dist/api/hr/hr-leave-ledger-kind.enum.js

@@ -0,0 +1,10 @@
+/** Why a leave balance moved. A balance is the sum of these and is never stored. */
+export var HrLeaveLedgerKind;
+(function (HrLeaveLedgerKind) {
+    HrLeaveLedgerKind["ALLOWANCE"] = "allowance";
+    HrLeaveLedgerKind["ACCRUAL"] = "accrual";
+    HrLeaveLedgerKind["CARRY_OVER"] = "carry-over";
+    HrLeaveLedgerKind["ADJUSTMENT"] = "adjustment";
+    HrLeaveLedgerKind["TAKEN"] = "taken";
+    HrLeaveLedgerKind["RETURNED"] = "returned";
+})(HrLeaveLedgerKind || (HrLeaveLedgerKind = {}));

package/dist/api/hr/hr-leave-request-status.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum HrLeaveRequestStatus {
+    PENDING = "pending",
+    APPROVED = "approved",
+    REJECTED = "rejected",
+    CANCELLED = "cancelled"
+}

package/dist/api/hr/hr-leave-request-status.enum.js

@@ -0,0 +1,7 @@
+export var HrLeaveRequestStatus;
+(function (HrLeaveRequestStatus) {
+    HrLeaveRequestStatus["PENDING"] = "pending";
+    HrLeaveRequestStatus["APPROVED"] = "approved";
+    HrLeaveRequestStatus["REJECTED"] = "rejected";
+    HrLeaveRequestStatus["CANCELLED"] = "cancelled";
+})(HrLeaveRequestStatus || (HrLeaveRequestStatus = {}));

package/dist/api/hr/hr-pay-period.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum HrPayPeriod {
+    MONTH = "month",
+    HOUR = "hour"
+}

package/dist/api/hr/hr-pay-period.enum.js

@@ -0,0 +1,5 @@
+export var HrPayPeriod;
+(function (HrPayPeriod) {
+    HrPayPeriod["MONTH"] = "month";
+    HrPayPeriod["HOUR"] = "hour";
+})(HrPayPeriod || (HrPayPeriod = {}));

package/dist/api/hr/hr-resource-status.enum.d.ts

@@ -0,0 +1,5 @@
+/** Whether a location, department, job title or leave type is still offered. Records that name one keep it. */
+export declare enum HrResourceStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive"
+}

package/dist/api/hr/hr-resource-status.enum.js

@@ -0,0 +1,6 @@
+/** Whether a location, department, job title or leave type is still offered. Records that name one keep it. */
+export var HrResourceStatus;
+(function (HrResourceStatus) {
+    HrResourceStatus["ACTIVE"] = "active";
+    HrResourceStatus["INACTIVE"] = "inactive";
+})(HrResourceStatus || (HrResourceStatus = {}));

package/dist/api/hr/index.d.ts

@@ -0,0 +1,10 @@
+export * from './hr-access-action.enum.js';
+export * from './hr-employment-event-kind.enum.js';
+export * from './hr-employment-status.enum.js';
+export * from './hr-employment-type.enum.js';
+export * from './hr-leave-accrual.enum.js';
+export * from './hr-leave-ledger-kind.enum.js';
+export * from './hr-leave-request-status.enum.js';
+export * from './hr-pay-period.enum.js';
+export * from './hr-resource-status.enum.js';
+export * from './localized-text.type.js';

package/dist/api/hr/index.js

@@ -0,0 +1,10 @@
+export * from './hr-access-action.enum.js';
+export * from './hr-employment-event-kind.enum.js';
+export * from './hr-employment-status.enum.js';
+export * from './hr-employment-type.enum.js';
+export * from './hr-leave-accrual.enum.js';
+export * from './hr-leave-ledger-kind.enum.js';
+export * from './hr-leave-request-status.enum.js';
+export * from './hr-pay-period.enum.js';
+export * from './hr-resource-status.enum.js';
+export * from './localized-text.type.js';

package/dist/api/hr/localized-text.type.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Text written in each language it has been written in, keyed by locale.
+ *
+ * Used for what ships in three languages and a company may change, such as a leave type or a
+ * public holiday. What a company types for its own staff, such as a department, is plain text.
+ */
+export type LocalizedText = Record<string, string>;

package/dist/api/hr/localized-text.type.js

@@ -0,0 +1 @@
+export {};

package/dist/enum/user-permission.enum.d.ts

@@ -498,7 +498,53 @@ export declare enum UserPermission {
     /** Change promotions and moderate reviews. */
     RESTAURANT_MARKETING_MANAGE = "restaurant:marketing:manage",
     /** See sales reports. */
-    RESTAURANT_REPORT_READ = "restaurant:report:read"
+    RESTAURANT_REPORT_READ = "restaurant:report:read",
+    /** Read a company's HR settings, locations, departments and job titles. */
+    HR_ORG_READ = "hr:org:read",
+    /** Change them. */
+    HR_ORG_MANAGE = "hr:org:manage",
+    /** Read employee records, without pay or identity numbers. */
+    HR_EMPLOYEE_READ = "hr:employee:read",
+    /** Add and change employee records, record a job change, and end somebody's employment. */
+    HR_EMPLOYEE_MANAGE = "hr:employee:manage",
+    /** Read pay, identity numbers and bank details. Its own permission, because keeping a directory right does not need them. */
+    HR_COMPENSATION_READ = "hr:compensation:read",
+    /** Change them. */
+    HR_COMPENSATION_MANAGE = "hr:compensation:manage",
+    /** See who read or changed pay and identity numbers, which reading them does not show. */
+    HR_AUDIT_READ = "hr:audit:read",
+    /** See everybody's time off, balances and the holiday calendar. A manager sees their own reports without this. */
+    HR_TIME_OFF_READ = "hr:time-off:read",
+    /** Decide anybody's time off, adjust balances, and change leave types and holidays. */
+    HR_TIME_OFF_MANAGE = "hr:time-off:manage",
+    /** See everybody's attendance and timesheets. */
+    HR_ATTENDANCE_READ = "hr:attendance:read",
+    /** Change attendance and decide corrections. */
+    HR_ATTENDANCE_MANAGE = "hr:attendance:manage",
+    /** Read employee documents and company policies. */
+    HR_DOCUMENT_READ = "hr:document:read",
+    /** Upload, change and remove them. */
+    HR_DOCUMENT_MANAGE = "hr:document:manage",
+    /** See onboarding and offboarding checklists. */
+    HR_ONBOARDING_READ = "hr:onboarding:read",
+    /** Change the templates and start a checklist for somebody. */
+    HR_ONBOARDING_MANAGE = "hr:onboarding:manage",
+    /** Post and withdraw company announcements. */
+    HR_ANNOUNCEMENT_MANAGE = "hr:announcement:manage",
+    /** See payroll runs and payslips. */
+    HR_PAYROLL_READ = "hr:payroll:read",
+    /** Prepare a payroll run. */
+    HR_PAYROLL_MANAGE = "hr:payroll:manage",
+    /** Approve a payroll run, which freezes every payslip in it. Its own permission, so one person cannot both prepare and sign off. */
+    HR_PAYROLL_APPROVE = "hr:payroll:approve",
+    /** See job openings and applicants. */
+    HR_HIRING_READ = "hr:hiring:read",
+    /** Change job openings and move applicants through the pipeline. */
+    HR_HIRING_MANAGE = "hr:hiring:manage",
+    /** See goals and reviews across the company. A manager sees their own reports without this. */
+    HR_PERFORMANCE_READ = "hr:performance:read",
+    /** Run review cycles. */
+    HR_PERFORMANCE_MANAGE = "hr:performance:manage"
 }
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/dist/enum/user-permission.enum.js

@@ -562,6 +562,53 @@ export var UserPermission;
     UserPermission["RESTAURANT_MARKETING_MANAGE"] = "restaurant:marketing:manage";
     /** See sales reports. */
     UserPermission["RESTAURANT_REPORT_READ"] = "restaurant:report:read";
+    // HR
+    /** Read a company's HR settings, locations, departments and job titles. */
+    UserPermission["HR_ORG_READ"] = "hr:org:read";
+    /** Change them. */
+    UserPermission["HR_ORG_MANAGE"] = "hr:org:manage";
+    /** Read employee records, without pay or identity numbers. */
+    UserPermission["HR_EMPLOYEE_READ"] = "hr:employee:read";
+    /** Add and change employee records, record a job change, and end somebody's employment. */
+    UserPermission["HR_EMPLOYEE_MANAGE"] = "hr:employee:manage";
+    /** Read pay, identity numbers and bank details. Its own permission, because keeping a directory right does not need them. */
+    UserPermission["HR_COMPENSATION_READ"] = "hr:compensation:read";
+    /** Change them. */
+    UserPermission["HR_COMPENSATION_MANAGE"] = "hr:compensation:manage";
+    /** See who read or changed pay and identity numbers, which reading them does not show. */
+    UserPermission["HR_AUDIT_READ"] = "hr:audit:read";
+    /** See everybody's time off, balances and the holiday calendar. A manager sees their own reports without this. */
+    UserPermission["HR_TIME_OFF_READ"] = "hr:time-off:read";
+    /** Decide anybody's time off, adjust balances, and change leave types and holidays. */
+    UserPermission["HR_TIME_OFF_MANAGE"] = "hr:time-off:manage";
+    /** See everybody's attendance and timesheets. */
+    UserPermission["HR_ATTENDANCE_READ"] = "hr:attendance:read";
+    /** Change attendance and decide corrections. */
+    UserPermission["HR_ATTENDANCE_MANAGE"] = "hr:attendance:manage";
+    /** Read employee documents and company policies. */
+    UserPermission["HR_DOCUMENT_READ"] = "hr:document:read";
+    /** Upload, change and remove them. */
+    UserPermission["HR_DOCUMENT_MANAGE"] = "hr:document:manage";
+    /** See onboarding and offboarding checklists. */
+    UserPermission["HR_ONBOARDING_READ"] = "hr:onboarding:read";
+    /** Change the templates and start a checklist for somebody. */
+    UserPermission["HR_ONBOARDING_MANAGE"] = "hr:onboarding:manage";
+    /** Post and withdraw company announcements. */
+    UserPermission["HR_ANNOUNCEMENT_MANAGE"] = "hr:announcement:manage";
+    /** See payroll runs and payslips. */
+    UserPermission["HR_PAYROLL_READ"] = "hr:payroll:read";
+    /** Prepare a payroll run. */
+    UserPermission["HR_PAYROLL_MANAGE"] = "hr:payroll:manage";
+    /** Approve a payroll run, which freezes every payslip in it. Its own permission, so one person cannot both prepare and sign off. */
+    UserPermission["HR_PAYROLL_APPROVE"] = "hr:payroll:approve";
+    /** See job openings and applicants. */
+    UserPermission["HR_HIRING_READ"] = "hr:hiring:read";
+    /** Change job openings and move applicants through the pipeline. */
+    UserPermission["HR_HIRING_MANAGE"] = "hr:hiring:manage";
+    /** See goals and reviews across the company. A manager sees their own reports without this. */
+    UserPermission["HR_PERFORMANCE_READ"] = "hr:performance:read";
+    /** Run review cycles. */
+    UserPermission["HR_PERFORMANCE_MANAGE"] = "hr:performance:manage";
 })(UserPermission || (UserPermission = {}));
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iveri/contracts",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "Wire contracts shared by every Iveri backend and frontend. Zero runtime dependencies.",
   "license": "MIT",
   "repository": {
@@ -52,6 +52,10 @@
       "types": "./dist/api/clinic/index.d.ts",
       "default": "./dist/api/clinic/index.js"
     },
+    "./hr": {
+      "types": "./dist/api/hr/index.d.ts",
+      "default": "./dist/api/hr/index.js"
+    },
     "./restaurant": {
       "types": "./dist/api/restaurant/index.d.ts",
       "default": "./dist/api/restaurant/index.js"