@m6d/cortex-server 1.6.0 → 1.8.0

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

@@ -0,0 +1,278 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { employeeSpouseConcept } from "../concepts/employeeSpouse.concept";
+
+export const listSpousesEndpoint = defineEndpoint({
+    name: "List employee spouses",
+    path: "/employees/spouses",
+    method: "GET",
+    description:
+        "List spouse records for an employee. Filter by employeeIds to scope to a specific employee. Includes name, marriage date, marriage status, nationality, and employment details.",
+    queries: [employeeSpouseConcept],
+    returns: [{ concept: employeeSpouseConcept }],
+
+    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: "genders", required: false, type: "string", isArray: true },
+            { name: "nationalityIds", required: false, type: "uuid", isArray: true },
+            { name: "dateOfBirthFrom", required: false, type: "datetime" },
+            { name: "dateOfBirthTo", required: false, type: "datetime" },
+            { name: "dateOfMarriageFrom", required: false, type: "datetime" },
+            { name: "dateOfMarriageTo", required: false, type: "datetime" },
+            { name: "marriageStatuses", required: false, type: "string", isArray: true },
+            { name: "hasHouseAllowance", required: false, type: "boolean" },
+            { 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: "dateOfMarriage", required: false, type: "datetime" },
+                    { name: "placeOfWork", required: false, type: "string" },
+                    { name: "workAddress", required: false, type: "string" },
+                    { name: "hasHouseAllowance", required: false, type: "boolean" },
+                    { name: "isWorking", required: false, type: "boolean" },
+                    { 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: "name",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    { name: "gender", required: false, type: "string" },
+                    { name: "dateOfBirth", required: false, type: "datetime" },
+                    { name: "marriageStatus", 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: "jobTitle", required: false, type: "string" },
+                    {
+                        name: "marriageCertificateFile",
+                        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: "workNocFile",
+                        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: "serviceRequest",
+                        required: false,
+                        type: "object",
+                        properties: [{ name: "id", required: false, type: "uuid" }],
+                    },
+                ],
+            },
+            { 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/listViolations.endpoint.ts

@@ -0,0 +1,245 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { employeeViolationConcept } from "../concepts/employeeViolation.concept";
+
+export const listViolationsEndpoint = defineEndpoint({
+    name: "List employee violations",
+    path: "/employees/violations",
+    method: "GET",
+    description:
+        "List violations and disciplinary records for an employee. Filter by employeeIds to scope to a specific employee. Includes violation date, decision details, penalties, and types.",
+    queries: [employeeViolationConcept],
+    returns: [{ concept: employeeViolationConcept }],
+
+    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: "from", required: false, type: "date" },
+            { name: "to", required: false, type: "date" },
+            { name: "employeeIds", required: false, type: "uuid", isArray: true },
+            { name: "violationTypeIds", required: false, type: "uuid", 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: "violationDate", required: false, type: "date" },
+                    { name: "decisionDate", required: false, type: "date" },
+                    { name: "decisionMaker", required: false, type: "string" },
+                    { name: "notes", required: false, type: "string" },
+                    {
+                        name: "penalties",
+                        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: "files",
+                        required: false,
+                        type: "object",
+                        isArray: true,
+                        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: "types",
+                        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: "degree", 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/index.ts

@@ -0,0 +1,75 @@
+import { defineDomain } from "@m6d/cortex-server";
+import type { DomainDef } from "@m6d/cortex-server";
+
+// Concepts
+import { employeeConcept } from "./concepts/employee.concept";
+import { employeeDocumentConcept } from "./concepts/employeeDocument.concept";
+import { employeeQualificationConcept } from "./concepts/employeeQualification.concept";
+import { employeeExperienceConcept } from "./concepts/employeeExperience.concept";
+import { employeeBankAccountConcept } from "./concepts/employeeBankAccount.concept";
+import { employeeChildConcept } from "./concepts/employeeChild.concept";
+import { employeeSpouseConcept } from "./concepts/employeeSpouse.concept";
+import { employeeEventConcept } from "./concepts/employeeEvent.concept";
+import { employeeMedalConcept } from "./concepts/employeeMedal.concept";
+import { employeeJobLevelChangeConcept } from "./concepts/employeeJobLevelChange.concept";
+import { employeeViolationConcept } from "./concepts/employeeViolation.concept";
+
+// Services
+import { employeeServices } from "./services/employees.service";
+
+// Endpoints
+import { getCurrentIdentityEndpoint } from "./endpoints/getCurrentIdentity.endpoint";
+import { getCurrentEmployeeEndpoint } from "./endpoints/getCurrentEmployee.endpoint";
+import { getEmployeeByIdEndpoint } from "./endpoints/getEmployeeById.endpoint";
+import { getEmployeeStatisticsEndpoint } from "./endpoints/getEmployeeStatistics.endpoint";
+import { getCurrentManagersEndpoint } from "./endpoints/getCurrentManagers.endpoint";
+import { listEmployeesSimpleEndpoint } from "./endpoints/listEmployeesSimple.endpoint";
+import { listDocumentsEndpoint } from "./endpoints/listDocuments.endpoint";
+import { listQualificationsEndpoint } from "./endpoints/listQualifications.endpoint";
+import { listExperiencesEndpoint } from "./endpoints/listExperiences.endpoint";
+import { listBankAccountsEndpoint } from "./endpoints/listBankAccounts.endpoint";
+import { listChildrenEndpoint } from "./endpoints/listChildren.endpoint";
+import { listSpousesEndpoint } from "./endpoints/listSpouses.endpoint";
+import { listEventsEndpoint } from "./endpoints/listEvents.endpoint";
+import { listJobLevelChangesEndpoint } from "./endpoints/listJobLevelChanges.endpoint";
+import { listMedalsEndpoint } from "./endpoints/listMedals.endpoint";
+import { listViolationsEndpoint } from "./endpoints/listViolations.endpoint";
+
+export const employeesDomain: DomainDef = defineDomain({
+    name: "Employees",
+    description:
+        "Employee self-service domain covering personal profile, identity, management hierarchy, documents, qualifications, work experience, bank accounts, family information, career events, awards, and violations. Focused on querying personal employee data.",
+    concepts: [
+        employeeConcept,
+        employeeDocumentConcept,
+        employeeQualificationConcept,
+        employeeExperienceConcept,
+        employeeBankAccountConcept,
+        employeeChildConcept,
+        employeeSpouseConcept,
+        employeeEventConcept,
+        employeeJobLevelChangeConcept,
+        employeeMedalConcept,
+        employeeViolationConcept,
+    ],
+    endpoints: [
+        getCurrentIdentityEndpoint,
+        getCurrentEmployeeEndpoint,
+        getEmployeeByIdEndpoint,
+        getEmployeeStatisticsEndpoint,
+        getCurrentManagersEndpoint,
+        listEmployeesSimpleEndpoint,
+        listDocumentsEndpoint,
+        listQualificationsEndpoint,
+        listExperiencesEndpoint,
+        listBankAccountsEndpoint,
+        listChildrenEndpoint,
+        listSpousesEndpoint,
+        listEventsEndpoint,
+        listJobLevelChangesEndpoint,
+        listMedalsEndpoint,
+        listViolationsEndpoint,
+    ],
+    services: [...employeeServices],
+    rules: [],
+});