@m6d/cortex-server 1.7.0 → 1.8.0

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

@@ -0,0 +1,49 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { attendanceTransactionConcept } from "../concepts/attendanceTransaction.concept";
+
+export const getCurrentAttendanceStatisticsEndpoint = defineEndpoint({
+    name: "Get current employee attendance statistics",
+    path: "/attendance/employees/current/statistics",
+    method: "GET",
+    description:
+        "Get the current employee's attendance statistics including transaction count, absence count, late count, early departure count, and compliance rate. Supports date range filtering.",
+    queries: [attendanceTransactionConcept],
+    returns: [{ concept: attendanceTransactionConcept }],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "from", required: false, type: "datetime" },
+            { name: "to", required: false, type: "datetime" },
+        ] as const,
+        body: [] as const,
+        response: [
+            {
+                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: "attendanceTransactionCount", required: false, type: "number" },
+            { name: "absenceCount", required: false, type: "number" },
+            { name: "lateCount", required: false, type: "number" },
+            { name: "earlyCount", required: false, type: "number" },
+            { name: "complianceRate", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [400],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,176 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { attendancePermissionConcept } from "../concepts/attendancePermission.concept";
+
+export const listAttendancePermissionsEndpoint = defineEndpoint({
+    name: "List attendance permissions",
+    path: "/attendance/permissions",
+    method: "GET",
+    description:
+        "List attendance permissions with filtering and pagination. Permissions cover late arrivals (late_in), early departures (early_out), and forgetfulness. Use employeeIds to view permissions for a specific employee.",
+    queries: [attendancePermissionConcept],
+    returns: [{ concept: attendancePermissionConcept }],
+
+    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: "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: "from", required: false, type: "datetime" },
+                    { name: "to", required: false, type: "datetime" },
+                ],
+            },
+            { 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/listAttendanceTransactionStates.endpoint.ts

@@ -0,0 +1,26 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { attendanceTransactionConcept } from "../concepts/attendanceTransaction.concept";
+
+export const listAttendanceTransactionStatesEndpoint = defineEndpoint({
+    name: "List attendance transaction states",
+    path: "/attendance/transactions/states",
+    method: "GET",
+    description:
+        "List available attendance transaction compliance states: absent, late, early, compliant.",
+    queries: [attendanceTransactionConcept],
+    returns: [{ concept: attendanceTransactionConcept }],
+
+    // @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/listAttendanceTransactions.endpoint.ts

@@ -0,0 +1,373 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { attendanceTransactionConcept } from "../concepts/attendanceTransaction.concept";
+
+export const listAttendanceTransactionsEndpoint = defineEndpoint({
+    name: "List attendance transactions",
+    path: "/attendance/transactions",
+    method: "GET",
+    description:
+        "List attendance transactions with filtering and pagination. Can filter by employee, date range, and compliance state (absent, late, early, compliant). Use employeeIds to view transactions for a specific employee.",
+    queries: [attendanceTransactionConcept],
+    returns: [{ concept: attendanceTransactionConcept }],
+
+    paramDescriptions: {
+        pageNumber: "0-based",
+        states: "Filter by compliance state: absent, late, early, compliant",
+    },
+
+    // @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: "states", 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: "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" },
+                                            { 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" },
+                                        ],
+                                    },
+                                    {
+                                        name: "jobTitle",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                            { name: "category", required: false, type: "object" },
+                                        ],
+                                    },
+                                    {
+                                        name: "department",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                    {
+                                        name: "user",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            { 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" },
+                                            { 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" },
+                                        ],
+                                    },
+                                    {
+                                        name: "jobTitle",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                            { name: "category", required: false, type: "object" },
+                                        ],
+                                    },
+                                    {
+                                        name: "department",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                    {
+                                        name: "user",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "id", required: false, type: "uuid" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            { 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" },
+                ],
+            },
+            { name: "count", required: false, type: "number" },
+            { name: "filteredCount", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});