@m6d/cortex-server 1.6.0 → 1.8.0

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

@@ -0,0 +1,52 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { publicHolidayConcept } from "../concepts/publicHoliday.concept";
+
+export const listPublicHolidaysSimpleEndpoint = defineEndpoint({
+    name: "List public holidays",
+    path: "/attendance/public-holidays/simple",
+    method: "GET",
+    description:
+        "List public holidays with simple output (ID and name only). Useful for viewing upcoming holidays.",
+    queries: [publicHolidayConcept],
+    returns: [{ concept: publicHolidayConcept }],
+
+    paramDescriptions: {
+        pageNumber: "0-based",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "keyword", required: false, type: "string" },
+            { name: "pageNumber", required: false, type: "number" },
+            { name: "pageSize", required: false, type: "number" },
+        ] as const,
+        body: [] as const,
+        response: [
+            {
+                name: "items",
+                required: false,
+                type: "object",
+                isArray: true,
+                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: "count", required: false, type: "number" },
+            { name: "filteredCount", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,25 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { punchConcept } from "../concepts/punch.concept";
+
+export const listPunchTypesEndpoint = defineEndpoint({
+    name: "List punch types",
+    path: "/attendance/punches/types",
+    method: "GET",
+    description: "List available punch types (in, out).",
+    queries: [punchConcept],
+    returns: [{ concept: punchConcept }],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [] as const,
+        body: [] as const,
+        response: [
+            { name: "id", required: false, type: "string" },
+            { name: "name", required: false, type: "string" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "array",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,178 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { punchConcept } from "../concepts/punch.concept";
+
+export const listPunchesEndpoint = defineEndpoint({
+    name: "List punches",
+    path: "/attendance/punches",
+    method: "GET",
+    description:
+        "List punch records with filtering and pagination. Can filter by employee, date range, and punch type. Use employeeIds to view punches for a specific employee.",
+    queries: [punchConcept],
+    returns: [{ concept: punchConcept }],
+
+    paramDescriptions: {
+        pageNumber: "0-based",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            {
+                name: "filterCountExclusions",
+                required: false,
+                type: "'employee_ids'",
+                isArray: true,
+            },
+            { name: "pageNumber", required: false, type: "number" },
+            { name: "pageSize", required: false, type: "number" },
+            { name: "keyword", required: false, type: "string" },
+            { name: "employeeIds", required: false, type: "uuid", isArray: true },
+            { name: "from", required: false, type: "datetime" },
+            { name: "to", required: false, type: "datetime" },
+            { name: "types", required: false, type: "string", isArray: true },
+            { name: "employee.keyword", required: false, type: "string" },
+            { name: "employee.number", required: false, type: "string" },
+            { name: "employee.genders", required: false, type: "string", isArray: true },
+            { name: "employee.jobClassificationIds", required: false, type: "uuid", isArray: true },
+            { name: "employee.jobLevelIds", required: false, type: "uuid", isArray: true },
+            { name: "employee.departmentIds", required: false, type: "uuid", isArray: true },
+            { name: "employee.jobTitleIds", required: false, type: "uuid", isArray: true },
+            { name: "employee.displayAllUnderHierarchy", required: false, type: "boolean" },
+        ] as const,
+        body: [] as const,
+        response: [
+            {
+                name: "items",
+                required: false,
+                type: "object",
+                isArray: true,
+                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: "count", required: false, type: "number" },
+            { name: "filteredCount", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,41 @@
+import { defineDomain } from "@m6d/cortex-server";
+import type { DomainDef } from "@m6d/cortex-server";
+import { attendancePermissionConcept } from "./concepts/attendancePermission.concept";
+import { attendanceTransactionConcept } from "./concepts/attendanceTransaction.concept";
+import { publicHolidayConcept } from "./concepts/publicHoliday.concept";
+import { punchConcept } from "./concepts/punch.concept";
+import { getAttendanceTransactionByIdEndpoint } from "./endpoints/getAttendanceTransactionById.endpoint";
+import { getCurrentAttendanceProfileEndpoint } from "./endpoints/getCurrentAttendanceProfile.endpoint";
+import { getCurrentAttendanceStatisticsEndpoint } from "./endpoints/getCurrentAttendanceStatistics.endpoint";
+import { listAttendancePermissionsEndpoint } from "./endpoints/listAttendancePermissions.endpoint";
+import { listAttendanceTransactionsEndpoint } from "./endpoints/listAttendanceTransactions.endpoint";
+import { listAttendanceTransactionStatesEndpoint } from "./endpoints/listAttendanceTransactionStates.endpoint";
+import { listPublicHolidaysSimpleEndpoint } from "./endpoints/listPublicHolidaysSimple.endpoint";
+import { listPunchesEndpoint } from "./endpoints/listPunches.endpoint";
+import { listPunchTypesEndpoint } from "./endpoints/listPunchTypes.endpoint";
+import { attendanceServices } from "./services/attendancePermissions.service";
+
+export const attendanceDomain: DomainDef = defineDomain({
+    name: "Attendance",
+    description:
+        "Employee attendance domain covering clock-in/out punching, daily attendance transactions, compliance tracking (absent, late, early, compliant), public holidays, and attendance permission request workflows. Focuses on self-service operations for employees.",
+    concepts: [
+        attendanceTransactionConcept,
+        punchConcept,
+        publicHolidayConcept,
+        attendancePermissionConcept,
+    ],
+    endpoints: [
+        getCurrentAttendanceProfileEndpoint,
+        getCurrentAttendanceStatisticsEndpoint,
+        listPunchesEndpoint,
+        listPunchTypesEndpoint,
+        listAttendanceTransactionsEndpoint,
+        getAttendanceTransactionByIdEndpoint,
+        listAttendanceTransactionStatesEndpoint,
+        listPublicHolidaysSimpleEndpoint,
+        listAttendancePermissionsEndpoint,
+    ],
+    services: [...attendanceServices],
+    rules: [],
+});

package/src/sample/domains/attendance/services/attendancePermissions.service.ts

@@ -0,0 +1,15 @@
+import { defineService } from "@m6d/cortex-server";
+import { attendancePermissionConcept } from "../concepts/attendancePermission.concept";
+
+export const attendancePermissionService = defineService({
+    name: "Attendance permission request",
+    builtInId: "services:attendance_permission",
+    belongsTo: attendancePermissionConcept,
+    description:
+        "Request an attendance permission for late arrival, early departure, or forgetfulness. The request captures a permission type and from/to datetime range and goes through an approval workflow.",
+    metadata: {
+        intakeMode: "conversational",
+    },
+});
+
+export const attendanceServices = [attendancePermissionService];

package/src/sample/domains/employees/concepts/employee.concept.ts

@@ -0,0 +1,20 @@
+import { defineConcept } from "@m6d/cortex-server";
+
+export const employeeConcept = defineConcept({
+    name: "Employee",
+    description:
+        "Employee profile and personal information. Includes personal details, job assignment, department, manager, qualifications, and employment history.",
+    aliases: [
+        "employee",
+        "employee profile",
+        "my profile",
+        "personal information",
+        "employee record",
+        "my information",
+        "موظف",
+        "ملف الموظف",
+        "بياناتي",
+        "معلوماتي الشخصية",
+        "ملفي الشخصي",
+    ],
+});

package/src/sample/domains/employees/concepts/employeeBankAccount.concept.ts

@@ -0,0 +1,19 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeBankAccountConcept = defineConcept({
+    name: "EmployeeBankAccount",
+    description:
+        "Bank account details for an employee, used for salary payments. Includes bank name, IBAN, and whether it is the default account.",
+    aliases: [
+        "bank account",
+        "my bank account",
+        "salary account",
+        "IBAN",
+        "الحساب البنكي",
+        "حسابي البنكي",
+        "حساب الراتب",
+        "الآيبان",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeChild.concept.ts

@@ -0,0 +1,19 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeChildConcept = defineConcept({
+    name: "EmployeeChild",
+    description:
+        "Children and dependents of an employee. Tracks name, date of birth, gender, nationality, and child allowance status.",
+    aliases: [
+        "children",
+        "my children",
+        "dependents",
+        "kids",
+        "الأبناء",
+        "أبنائي",
+        "أطفالي",
+        "المعالين",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeDocument.concept.ts

@@ -0,0 +1,21 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeDocumentConcept = defineConcept({
+    name: "EmployeeDocument",
+    description:
+        "Personal documents on file for an employee, such as national ID, passport, residency, or other official documents. Tracks document type, number, issue and expiry dates.",
+    aliases: [
+        "employee document",
+        "my documents",
+        "personal documents",
+        "ID card",
+        "passport",
+        "وثائق الموظف",
+        "مستنداتي",
+        "وثائقي",
+        "الهوية",
+        "جواز السفر",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeEvent.concept.ts

@@ -0,0 +1,21 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeEventConcept = defineConcept({
+    name: "EmployeeEvent",
+    description:
+        "Career events and milestones for an employee, including transfers, promotions, job level changes, and other significant employment events.",
+    aliases: [
+        "career event",
+        "career history",
+        "my events",
+        "employment events",
+        "promotions",
+        "transfers",
+        "أحداث الموظف",
+        "تاريخي الوظيفي",
+        "الترقيات",
+        "التنقلات",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeExperience.concept.ts

@@ -0,0 +1,18 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeExperienceConcept = defineConcept({
+    name: "EmployeePreviousExperience",
+    description:
+        "Previous work experience records for an employee. Tracks the employer name, start and end dates of service.",
+    aliases: [
+        "previous experience",
+        "work experience",
+        "my experience",
+        "employment history",
+        "الخبرات السابقة",
+        "خبراتي",
+        "تجربتي العملية",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeJobLevelChange.concept.ts

@@ -0,0 +1,21 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeJobLevelChangeConcept = defineConcept({
+    name: "EmployeeJobLevelChange",
+    description:
+        "Job level change records for an employee, covering promotions, demotions, and lateral moves. Tracks current and new job levels, change date, promotion type, and reference details.",
+    aliases: [
+        "job level change",
+        "promotion",
+        "demotion",
+        "my promotions",
+        "promotion history",
+        "job level history",
+        "تغيير المرتبة",
+        "ترقية",
+        "ترقياتي",
+        "تاريخ الترقيات",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeMedal.concept.ts

@@ -0,0 +1,20 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeMedalConcept = defineConcept({
+    name: "EmployeeMedal",
+    description:
+        "Awards, medals, and recognitions received by an employee. Tracks award date, source, category, type, and level.",
+    aliases: [
+        "medal",
+        "award",
+        "my medals",
+        "my awards",
+        "recognition",
+        "الأوسمة",
+        "أوسمتي",
+        "الجوائز",
+        "جوائزي",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeQualification.concept.ts

@@ -0,0 +1,20 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeQualificationConcept = defineConcept({
+    name: "EmployeeEducationalQualification",
+    description:
+        "Educational qualifications and academic credentials of an employee. Includes degree, major, specialization, institution, graduation date, and grade.",
+    aliases: [
+        "educational qualification",
+        "my qualifications",
+        "education",
+        "degree",
+        "academic credentials",
+        "المؤهلات التعليمية",
+        "مؤهلاتي",
+        "شهاداتي",
+        "التعليم",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeSpouse.concept.ts

@@ -0,0 +1,21 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeSpouseConcept = defineConcept({
+    name: "EmployeeSpouse",
+    description:
+        "Spouse information for an employee. Tracks name, date of marriage, marriage status, nationality, and employment details.",
+    aliases: [
+        "spouse",
+        "my spouse",
+        "wife",
+        "husband",
+        "marriage",
+        "الزوج",
+        "الزوجة",
+        "زوجتي",
+        "زوجي",
+        "الزواج",
+    ],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/employees/concepts/employeeViolation.concept.ts

@@ -0,0 +1,19 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const employeeViolationConcept = defineConcept({
+    name: "EmployeeViolation",
+    description:
+        "Violations and disciplinary records for an employee. Tracks violation date, decision date, penalties, and associated violation types.",
+    aliases: [
+        "violation",
+        "my violations",
+        "disciplinary record",
+        "penalty",
+        "المخالفات",
+        "مخالفاتي",
+        "الجزاءات",
+        "السجل التأديبي",
+    ],
+    governedBy: [paginationRule],
+});