@m6d/cortex-server 1.6.0 → 1.8.0

package/src/sample/domains/employees/endpoints/getEmployeeStatistics.endpoint.ts

@@ -0,0 +1,43 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { employeeConcept } from "../concepts/employee.concept";
+import { getCurrentIdentityEndpoint } from "./getCurrentIdentity.endpoint";
+
+export const getEmployeeStatisticsEndpoint = defineEndpoint({
+    name: "Get employee statistics",
+    path: "/employees/{id}/statistics",
+    method: "GET",
+    description:
+        "Get aggregated statistics for an employee including leave balances, performance rating, attendance, awards, and violations counts.",
+    queries: [employeeConcept],
+    returns: [{ concept: employeeConcept }],
+    dependsOn: [
+        {
+            endpoint: getCurrentIdentityEndpoint,
+            paramName: "id",
+            fromField: "employee.id",
+        },
+    ],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [
+            { name: "annualLeaveBalance", required: false, type: "number" },
+            { name: "annualLeaveDayCount", required: false, type: "number" },
+            { name: "performanceRating", required: false, type: "number" },
+            { name: "taskFulfillmentRating", required: false, type: "number" },
+            { name: "absenceDays", required: false, type: "number" },
+            { name: "sickLeaveBalance", required: false, type: "number" },
+            { name: "sickLeaveCount", required: false, type: "number" },
+            { name: "sickLeaveDayCount", required: false, type: "number" },
+            { name: "awardCount", required: false, type: "number" },
+            { name: "violationCount", required: false, type: "number" },
+            { name: "attendanceComplianceRate", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

package/src/sample/domains/employees/endpoints/listBankAccounts.endpoint.ts

@@ -0,0 +1,223 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { employeeBankAccountConcept } from "../concepts/employeeBankAccount.concept";
+
+export const listBankAccountsEndpoint = defineEndpoint({
+    name: "List employee bank accounts",
+    path: "/employees/bank-accounts",
+    method: "GET",
+    description:
+        "List bank accounts for an employee. Filter by employeeIds to scope to a specific employee. Includes bank name, IBAN, and default account flag.",
+    queries: [employeeBankAccountConcept],
+    returns: [{ concept: employeeBankAccountConcept }],
+
+    paramDescriptions: {
+        pageNumber: "0-based",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            {
+                name: "filterCountExclusions",
+                required: false,
+                type: "'employee_ids' | 'bank_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: "bankIds", required: false, type: "uuid", isArray: true },
+            { name: "changeDateFrom", required: false, type: "datetime" },
+            { name: "changeDateTo", 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: "bank",
+                        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: "changeDate", required: false, type: "datetime" },
+                    { name: "iban", required: false, type: "string" },
+                    { name: "isDefault", required: false, type: "boolean" },
+                    {
+                        name: "bankAttachmentFile",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "id", required: false, type: "uuid" },
+                            { name: "createdTime", required: false, type: "datetime" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "description",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            { name: "sizeInBytes", required: false, type: "number" },
+                            { name: "contentType", 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/employees/endpoints/listChildren.endpoint.ts

@@ -0,0 +1,211 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { employeeChildConcept } from "../concepts/employeeChild.concept";
+
+export const listChildrenEndpoint = defineEndpoint({
+    name: "List employee children",
+    path: "/employees/children",
+    method: "GET",
+    description:
+        "List children and dependents of an employee. Filter by employeeIds to scope to a specific employee. Includes name, date of birth, gender, nationality, and allowance status.",
+    queries: [employeeChildConcept],
+    returns: [{ concept: employeeChildConcept }],
+
+    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: "dateOfBirthFrom", required: false, type: "datetime" },
+            { name: "dateOfBirthTo", required: false, type: "datetime" },
+            { name: "genders", required: false, type: "string", isArray: true },
+            { name: "nationalityIds", required: false, type: "uuid", isArray: true },
+            { name: "allowanceStatuses", required: false, type: "string", isArray: true },
+            { name: "nationalIdExpirationDateFrom", required: false, type: "datetime" },
+            { name: "nationalIdExpirationDateTo", 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: "name",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    {
+                        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: "dateOfBirth", required: false, type: "datetime" },
+                    { name: "order", required: false, type: "number" },
+                    { name: "gender", required: false, type: "string" },
+                    {
+                        name: "nationality",
+                        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: "motherName", required: false, type: "string" },
+                    { name: "allowanceStatus", required: false, type: "string" },
+                    { name: "placeOfBirth", required: false, type: "string" },
+                    { name: "nationalIdNumber", 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
+});