@m6d/cortex-server 1.6.0 → 1.8.0

package/src/sample/domains/appraisals/index.ts

@@ -0,0 +1,40 @@
+import { defineDomain } from "@m6d/cortex-server";
+import type { DomainDef } from "@m6d/cortex-server";
+import { appraisalCycleConcept } from "./concepts/appraisalCycle.concept";
+import { appraisalRecordConcept } from "./concepts/appraisalRecord.concept";
+import { appraisalRecordCompetencyConcept } from "./concepts/appraisalRecordCompetency.concept";
+import { appraisalRecordFunctionalRequirementConcept } from "./concepts/appraisalRecordFunctionalRequirement.concept";
+import { appraisalRecordGoalConcept } from "./concepts/appraisalRecordGoal.concept";
+import { getAppraisalRecordByIdEndpoint } from "./endpoints/getAppraisalRecordById.endpoint";
+import { getAppraisalRecordCompetenciesEndpoint } from "./endpoints/getAppraisalRecordCompetencies.endpoint";
+import { getAppraisalRecordFunctionalRequirementsEndpoint } from "./endpoints/getAppraisalRecordFunctionalRequirements.endpoint";
+import { getAppraisalRecordGoalsEndpoint } from "./endpoints/getAppraisalRecordGoals.endpoint";
+import { getAppraisalRecordScoreEndpoint } from "./endpoints/getAppraisalRecordScore.endpoint";
+import { listAppraisalCyclesSimpleEndpoint } from "./endpoints/listAppraisalCyclesSimple.endpoint";
+import { listAppraisalRecordsEndpoint } from "./endpoints/listAppraisalRecords.endpoint";
+import { listAppraisalTemplatesSimpleEndpoint } from "./endpoints/listAppraisalTemplatesSimple.endpoint";
+import { appraisalRecordScopingRule } from "./rules/appraisalRecordScoping.rule";
+
+export const appraisalsDomain: DomainDef = defineDomain({
+    name: "Appraisals",
+    description:
+        "Performance appraisal domain covering appraisal cycles, records, goals, competencies, and functional requirements. Supports the full appraisal workflow from goal-setting through assessment and finalization. Focuses on self-service operations for employees and their managers.",
+    concepts: [
+        appraisalCycleConcept,
+        appraisalRecordConcept,
+        appraisalRecordGoalConcept,
+        appraisalRecordCompetencyConcept,
+        appraisalRecordFunctionalRequirementConcept,
+    ],
+    endpoints: [
+        listAppraisalRecordsEndpoint,
+        getAppraisalRecordByIdEndpoint,
+        getAppraisalRecordScoreEndpoint,
+        getAppraisalRecordGoalsEndpoint,
+        getAppraisalRecordCompetenciesEndpoint,
+        getAppraisalRecordFunctionalRequirementsEndpoint,
+        listAppraisalCyclesSimpleEndpoint,
+        listAppraisalTemplatesSimpleEndpoint,
+    ],
+    rules: [appraisalRecordScopingRule],
+});

package/src/sample/domains/appraisals/rules/appraisalRecordScoping.rule.ts

@@ -0,0 +1,7 @@
+import { defineRule } from "@m6d/cortex-server";
+
+export const appraisalRecordScopingRule = defineRule({
+    name: "Use scope parameter when listing appraisal records",
+    description:
+        "When listing appraisal records, use the scope parameter to filter appropriately: scope=Own returns only the current employee's records, scope=Act returns records that need the current user's action (e.g., pending approval). Default scope=All returns all accessible records. For self-service use cases, prefer scope=Own.",
+});

package/src/sample/domains/attendance/concepts/attendancePermission.concept.ts

@@ -0,0 +1,17 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const attendancePermissionConcept = defineConcept({
+    name: "AttendancePermission",
+    description:
+        "A permission granted to an employee for late arrival (late_in), early departure (early_out), or forgetfulness. Has a date/time range and is linked to a service request.",
+    aliases: [
+        "attendance permission",
+        "late permission",
+        "early leave permission",
+        "إذن حضور",
+        "إذن تأخير",
+        "إذن انصراف مبكر",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/attendance/concepts/attendanceTransaction.concept.ts

@@ -0,0 +1,17 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const attendanceTransactionConcept = defineConcept({
+    name: "AttendanceTransaction",
+    description:
+        "A daily attendance record for an employee showing clock-in time, clock-out time, schedule info, and compliance state (absent, late, early, compliant). Also indicates if covered by a leave or permission.",
+    aliases: [
+        "attendance record",
+        "daily attendance",
+        "attendance log",
+        "سجل الحضور",
+        "حضور وانصراف",
+        "سجل الدوام",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/attendance/concepts/publicHoliday.concept.ts

@@ -0,0 +1,10 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const publicHolidayConcept = defineConcept({
+    name: "PublicHoliday",
+    description:
+        "A public holiday that affects attendance schedules. Has a name, date range, and periodicity (once, yearly, monthly, weekly).",
+    aliases: ["public holiday", "holiday", "day off", "إجازة رسمية", "عطلة رسمية", "يوم عطلة"],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/attendance/concepts/punch.concept.ts

@@ -0,0 +1,19 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const punchConcept = defineConcept({
+    name: "Punch",
+    description:
+        "A clock-in or clock-out event recorded by an employee. Captures the punch type (in/out), timestamp, and optional geolocation (longitude, latitude).",
+    aliases: [
+        "clock in",
+        "clock out",
+        "punch in",
+        "punch out",
+        "time punch",
+        "تسجيل حضور",
+        "تسجيل انصراف",
+        "بصمة",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/attendance/endpoints/getAttendanceTransactionById.endpoint.ts

@@ -0,0 +1,444 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { attendanceTransactionConcept } from "../concepts/attendanceTransaction.concept";
+
+export const getAttendanceTransactionByIdEndpoint = defineEndpoint({
+    name: "Get attendance transaction by ID",
+    path: "/attendance/transactions/{id}",
+    method: "GET",
+    description:
+        "Get a specific attendance transaction by its ID. Returns full details including in/out times, zones, compliance state, and associated punches.",
+    queries: [attendanceTransactionConcept],
+    returns: [{ concept: attendanceTransactionConcept }],
+
+    paramDescriptions: {
+        id: "The attendance transaction UUID",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [
+            { name: "id", required: false, type: "uuid" },
+            {
+                name: "employee",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    {
+                        name: "name",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    { name: "number", required: false, type: "string" },
+                    {
+                        name: "jobClassification",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            { name: "type", required: false, type: "string" },
+                        ],
+                    },
+                    {
+                        name: "jobLevel",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        name: "jobTitle",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "category",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        name: "department",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        name: "user",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            },
+            {
+                name: "scheduleName",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "ar", required: false, type: "string" },
+                    { name: "en", required: false, type: "string" },
+                ],
+            },
+            { name: "inTime", required: false, type: "datetime" },
+            {
+                name: "inZoneName",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "ar", required: false, type: "string" },
+                    { name: "en", required: false, type: "string" },
+                ],
+            },
+            { name: "inLongitude", required: false, type: "number" },
+            { name: "inLatitude", required: false, type: "number" },
+            { name: "inRadiusInMeters", required: false, type: "number" },
+            { name: "outTime", required: false, type: "datetime" },
+            {
+                name: "outZoneName",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "ar", required: false, type: "string" },
+                    { name: "en", required: false, type: "string" },
+                ],
+            },
+            { name: "outLongitude", required: false, type: "number" },
+            { name: "outLatitude", required: false, type: "number" },
+            { name: "outRadiusInMeters", required: false, type: "number" },
+            {
+                name: "inPunch",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    {
+                        name: "employee",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            { name: "number", required: false, type: "string" },
+                            {
+                                name: "jobClassification",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                    { name: "type", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "jobLevel",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "jobTitle",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                    {
+                                        name: "category",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "department",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "user",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    { name: "type", required: false, type: "string" },
+                    { name: "time", required: false, type: "datetime" },
+                    { name: "longitude", required: false, type: "number" },
+                    { name: "latitude", required: false, type: "number" },
+                ],
+            },
+            {
+                name: "outPunch",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    {
+                        name: "employee",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            { name: "number", required: false, type: "string" },
+                            {
+                                name: "jobClassification",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                    { name: "type", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "jobLevel",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "jobTitle",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                    {
+                                        name: "category",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "department",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "user",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "id", required: false, type: "uuid" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    { name: "type", required: false, type: "string" },
+                    { name: "time", required: false, type: "datetime" },
+                    { name: "longitude", required: false, type: "number" },
+                    { name: "latitude", required: false, type: "number" },
+                ],
+            },
+            { name: "flexOffsetInMinutes", required: false, type: "number" },
+            { name: "earlyStartOffsetInMinutes", required: false, type: "number" },
+            { name: "lateEndOffsetInMinutes", required: false, type: "number" },
+            { name: "isAbsent", required: false, type: "boolean" },
+            { name: "isLate", required: false, type: "boolean" },
+            { name: "isEarly", required: false, type: "boolean" },
+            { name: "isCoveredByLeave", required: false, type: "boolean" },
+            { name: "isCoveredByPermission", required: false, type: "boolean" },
+            { name: "isOverlappingPermission", required: false, type: "boolean" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});