@m6d/cortex-server 1.8.0 → 2.0.1

package/src/sample/domains/leaves/endpoints/listLeaves.endpoint.ts

@@ -1,234 +0,0 @@
-import { defineEndpoint } from "@m6d/cortex-server";
-import { leaveConcept } from "../concepts/leave.concept";
-
-export const listLeavesEndpoint = defineEndpoint({
-    name: "List leaves",
-    path: "/leaves",
-    method: "GET",
-    description:
-        "List leaves with filtering and pagination. Can return the leaves for the current employee given the employee id as filter.",
-    queries: [leaveConcept],
-    returns: [{ concept: leaveConcept }],
-
-    paramDescriptions: {
-        pageNumber: "0-based",
-    },
-
-    // @auto-generated-start
-    autoGenerated: {
-        params: [
-            {
-                name: "orderByProperties",
-                required: false,
-                type: "object",
-                isArray: true,
-                properties: [
-                    { name: "property", required: false, type: "string" },
-                    { name: "direction", required: false, type: "'asc' | 'desc'" },
-                ],
-            },
-            {
-                name: "filterCountExclusions",
-                required: false,
-                type: "'employee_ids'",
-                isArray: true,
-            },
-            { name: "pageNumber", required: false, type: "number" },
-            { name: "pageSize", required: false, type: "number" },
-            { name: "employeeIds", required: false, type: "uuid", isArray: true },
-            { name: "types", required: false, type: "string", 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: "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: "dateOfBirth", required: false, type: "datetime" },
-                            {
-                                name: "photoFile",
-                                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: "email", required: false, type: "string" },
-                            { name: "number", required: false, type: "string" },
-                            { name: "isConfidential", required: false, type: "boolean" },
-                            {
-                                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: "hireDate", required: false, type: "datetime" },
-                            {
-                                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: "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: "jobCategory",
-                                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: "dayCount", required: false, type: "number" },
-                    { name: "daysBalanceBeforeLeave", required: false, type: "number" },
-                    {
-                        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/leaves/index.ts

@@ -1,38 +0,0 @@
-import { defineDomain } from "@m6d/cortex-server";
-import type { DomainDef } from "@m6d/cortex-server";
-import { leaveConcept } from "./concepts/leave.concept";
-import { leaveBalanceConcept } from "./concepts/leaveBalance.concept";
-import { leaveBalanceTransactionConcept } from "./concepts/leaveBalanceTransaction.concept";
-import { leaveTypeConcept } from "./concepts/leaveType.concept";
-import { leaveTypeConcepts } from "./concepts/leaveTypes.concept";
-import { getBalanceEndpoint } from "./endpoints/getBalance.endpoint";
-import { getLeaveByIdEndpoint } from "./endpoints/getLeaveById.endpoint";
-import { listBalancesEndpoint } from "./endpoints/listBalances.endpoint";
-import { listBalanceTransactionsEndpoint } from "./endpoints/listBalanceTransactions.endpoint";
-import { listBalanceTypesEndpoint } from "./endpoints/listBalanceTypes.endpoint";
-import { listLeavesEndpoint } from "./endpoints/listLeaves.endpoint";
-import { listLeaveTypesEndpoint } from "./endpoints/listLeaveTypes.endpoint";
-import { leaveServices } from "./services/leaveRequests.service";
-
-export const leavesDomain: DomainDef = defineDomain({
-    name: "Leaves",
-    description:
-        "Leave management domain covering leave requests, leave balances, leave types, and leave-related service workflows. Handles all employee leave operations including requesting, approving, tracking balances, and processing returns.",
-    concepts: [
-        leaveConcept,
-        leaveBalanceConcept,
-        leaveBalanceTransactionConcept,
-        leaveTypeConcept,
-        ...leaveTypeConcepts,
-    ],
-    endpoints: [
-        getBalanceEndpoint,
-        getLeaveByIdEndpoint,
-        listBalancesEndpoint,
-        listBalanceTransactionsEndpoint,
-        listBalanceTypesEndpoint,
-        listLeavesEndpoint,
-        listLeaveTypesEndpoint,
-    ],
-    services: [...leaveServices],
-});

package/src/sample/domains/leaves/services/leaveRequests.service.ts

@@ -1,232 +0,0 @@
-import { defineService } from "@m6d/cortex-server";
-import type { ConceptDef } from "@m6d/cortex-server";
-import {
-    annualLeaveConcept,
-    sickLeaveConcept,
-    casualLeaveConcept,
-    maternityLeaveConcept,
-    pilgrimageLeaveConcept,
-    paternalLeaveConcept,
-    examLeaveConcept,
-    unpaidLeaveConcept,
-    guardianLeaveConcept,
-    sabbaticalLeaveConcept,
-    mourningLeaveConcept,
-    iddaLeaveConcept,
-    officialDutyLeaveConcept,
-    careLeaveConcept,
-    contactWithInfectedPatientLeaveConcept,
-    urgentLeaveConcept,
-    timeInLieuLeaveConcept,
-    timeInLieuBalanceCreditGrantConcept,
-    encashLeaveDaysConcept,
-    returnFromLeaveConcept,
-} from "../concepts/leaveTypes.concept";
-
-function leaveService(config: {
-    name: string;
-    builtInId: string;
-    belongsTo: ConceptDef;
-    description: string;
-    intakeMode: "conversational" | "form";
-}) {
-    return defineService({
-        name: config.name,
-        builtInId: config.builtInId,
-        belongsTo: config.belongsTo,
-        description: config.description,
-        metadata: {
-            intakeMode: config.intakeMode,
-        },
-    });
-}
-
-export const annualLeaveRequestService = leaveService({
-    name: "Annual leave request",
-    builtInId: "services:annual_leave",
-    belongsTo: annualLeaveConcept,
-    description:
-        "Request annual leave (vacation). Creates draft then submits for supervisor approval. Requires sufficient annual leave balance.",
-    intakeMode: "conversational",
-});
-
-export const sickLeaveRequestService = leaveService({
-    name: "Sick leave request",
-    builtInId: "services:sick_leave",
-    belongsTo: sickLeaveConcept,
-    description:
-        "Request sick leave. Less than 5 days: standard approval. 5+ days: requires medical committee approval and medical certificate.",
-    intakeMode: "conversational",
-});
-
-export const casualLeaveRequestService = leaveService({
-    name: "Casual leave request",
-    builtInId: "services:casual_leave",
-    belongsTo: casualLeaveConcept,
-    description:
-        "Request casual/emergency leave. Must be for today only (not past or future). Cannot have adjacent leaves.",
-    intakeMode: "conversational",
-});
-
-export const maternityLeaveRequestService = leaveService({
-    name: "Maternity leave request",
-    builtInId: "services:maternity_leave",
-    belongsTo: maternityLeaveConcept,
-    description:
-        "Request maternity leave. Fixed 90-day balance. Requires date of birth and medical report. Female employees only.",
-    intakeMode: "conversational",
-});
-
-export const pilgrimageLeaveRequestService = leaveService({
-    name: "Pilgrimage leave request",
-    builtInId: "services:pilgrimage_leave",
-    belongsTo: pilgrimageLeaveConcept,
-    description:
-        "Request pilgrimage (Hajj) leave. Fixed 30-day balance no need to check balance for this one.",
-    intakeMode: "conversational",
-});
-
-export const paternalLeaveRequestService = leaveService({
-    name: "Paternal leave request",
-    builtInId: "services:paternal_leave",
-    belongsTo: paternalLeaveConcept,
-    description: "Request paternal leave for new fathers.",
-    intakeMode: "conversational",
-});
-
-export const examLeaveRequestService = leaveService({
-    name: "Exam leave request",
-    builtInId: "services:exam_leave",
-    belongsTo: examLeaveConcept,
-    description: "Request exam leave for academic examinations.",
-    intakeMode: "conversational",
-});
-
-export const unpaidLeaveRequestService = leaveService({
-    name: "Unpaid leave request",
-    builtInId: "services:unpaid_leave",
-    belongsTo: unpaidLeaveConcept,
-    description: "Request unpaid leave (leave without pay).",
-    intakeMode: "conversational",
-});
-
-export const guardianLeaveRequestService = leaveService({
-    name: "Guardian leave request",
-    builtInId: "services:guardian_leave",
-    belongsTo: guardianLeaveConcept,
-    description: "Request guardian leave for accompanying a patient.",
-    intakeMode: "conversational",
-});
-
-export const sabbaticalLeaveRequestService = leaveService({
-    name: "Sabbatical leave request",
-    builtInId: "services:sabbatical_leave",
-    belongsTo: sabbaticalLeaveConcept,
-    description: "Request sabbatical leave for extended time off.",
-    intakeMode: "conversational",
-});
-
-export const mourningLeaveRequestService = leaveService({
-    name: "Mourning leave request",
-    builtInId: "services:mourning_leave",
-    belongsTo: mourningLeaveConcept,
-    description: "Request mourning/bereavement leave.",
-    intakeMode: "conversational",
-});
-
-export const iddaLeaveRequestService = leaveService({
-    name: "Idda leave request",
-    builtInId: "services:idda_leave",
-    belongsTo: iddaLeaveConcept,
-    description:
-        "Request Idda leave (waiting period leave for women after divorce or spouse death).",
-    intakeMode: "conversational",
-});
-
-export const officialDutyLeaveRequestService = leaveService({
-    name: "Official duty leave request",
-    builtInId: "services:official_duty_leave",
-    belongsTo: officialDutyLeaveConcept,
-    description: "Request official duty leave for work-related travel or assignments.",
-    intakeMode: "conversational",
-});
-
-export const careLeaveRequestService = leaveService({
-    name: "Care leave request",
-    builtInId: "services:care_leave",
-    belongsTo: careLeaveConcept,
-    description: "Request care leave for caring for a family member.",
-    intakeMode: "conversational",
-});
-
-export const contactWithInfectedPatientLeaveRequestService = leaveService({
-    name: "Contact with infected patient leave request",
-    builtInId: "services:contact_with_infected_patient_leave",
-    belongsTo: contactWithInfectedPatientLeaveConcept,
-    description: "Request leave due to contact with an infected patient.",
-    intakeMode: "conversational",
-});
-
-export const urgentLeaveRequestService = leaveService({
-    name: "Urgent leave request",
-    builtInId: "services:urgent_leave",
-    belongsTo: urgentLeaveConcept,
-    description: "Request urgent leave for emergencies.",
-    intakeMode: "conversational",
-});
-
-export const timeInLieuLeaveRequestService = leaveService({
-    name: "Time in lieu leave request",
-    builtInId: "services:time_in_lieu",
-    belongsTo: timeInLieuLeaveConcept,
-    description: "Request time in lieu leave (compensatory time off for overtime).",
-    intakeMode: "conversational",
-});
-
-export const timeInLieuBalanceCreditGrantService = leaveService({
-    name: "Time in lieu balance credit grant",
-    builtInId: "services:time_in_lieu_balance_credit_grant",
-    belongsTo: timeInLieuBalanceCreditGrantConcept,
-    description: "Request to credit time in lieu balance (grant overtime compensation days).",
-    intakeMode: "conversational",
-});
-
-export const encashLeaveDaysRequestService = leaveService({
-    name: "Encash leave days request",
-    builtInId: "services:encash_leave_days",
-    belongsTo: encashLeaveDaysConcept,
-    description: "Request to encash (cash out) unused leave days.",
-    intakeMode: "conversational",
-});
-
-export const returnFromLeaveRequestService = leaveService({
-    name: "Return from leave request",
-    builtInId: "services:return_from_leave",
-    belongsTo: returnFromLeaveConcept,
-    description:
-        "Register returning from an ongoing leave, possibly earlier than planned end date.",
-    intakeMode: "conversational",
-});
-
-export const leaveServices = [
-    annualLeaveRequestService,
-    sickLeaveRequestService,
-    casualLeaveRequestService,
-    maternityLeaveRequestService,
-    pilgrimageLeaveRequestService,
-    paternalLeaveRequestService,
-    examLeaveRequestService,
-    unpaidLeaveRequestService,
-    guardianLeaveRequestService,
-    sabbaticalLeaveRequestService,
-    mourningLeaveRequestService,
-    iddaLeaveRequestService,
-    officialDutyLeaveRequestService,
-    careLeaveRequestService,
-    contactWithInfectedPatientLeaveRequestService,
-    urgentLeaveRequestService,
-    timeInLieuLeaveRequestService,
-    timeInLieuBalanceCreditGrantService,
-    encashLeaveDaysRequestService,
-    returnFromLeaveRequestService,
-];

package/src/sample/domains/notifications/concepts/notification.concept.ts

@@ -1,19 +0,0 @@
-import { defineConcept } from "@m6d/cortex-server";
-import { paginationRule } from "../../shared/rules/pagination.rule";
-
-export const notificationConcept = defineConcept({
-    name: "Notification",
-    description:
-        "A personal in-app notification for the current user, including message content, read state, timestamps, tags, and optional navigation link.",
-    aliases: [
-        "notification",
-        "my notifications",
-        "unread notifications",
-        "alerts",
-        "notifications",
-        "الإشعارات",
-        "إشعاراتي",
-        "الإشعارات غير المقروءة",
-    ],
-    governedBy: [paginationRule],
-});

package/src/sample/domains/notifications/endpoints/countMyNotifications.endpoint.ts

@@ -1,21 +0,0 @@
-import { defineEndpoint } from "@m6d/cortex-server";
-import { notificationConcept } from "../concepts/notification.concept";
-
-export const countMyNotificationsEndpoint = defineEndpoint({
-    name: "Count unread current user notifications",
-    path: "/notifications/users/count",
-    method: "GET",
-    description: "Returns the number of unread notifications for the current user.",
-    queries: [notificationConcept],
-
-    // @auto-generated-start
-    autoGenerated: {
-        params: [] as const,
-        body: [] as const,
-        response: [{ name: "value", required: true, type: "number" }] as const,
-        successStatus: 200,
-        errorStatuses: [],
-        responseKind: "object",
-    } as const,
-    // @auto-generated-end
-});

package/src/sample/domains/notifications/endpoints/getMyNotification.endpoint.ts

@@ -1,57 +0,0 @@
-import { defineEndpoint } from "@m6d/cortex-server";
-import { notificationConcept } from "../concepts/notification.concept";
-import { listMyNotificationsEndpoint } from "./listMyNotifications.endpoint";
-
-export const getMyNotificationEndpoint = defineEndpoint({
-    name: "Get one current user notification",
-    path: "/notifications/users/{id}",
-    method: "GET",
-    description: "Returns a single notification belonging to the current user.",
-    queries: [notificationConcept],
-    returns: [{ concept: notificationConcept }],
-    paramDescriptions: {
-        id: "The notification identifier",
-    },
-    dependsOn: [
-        {
-            endpoint: listMyNotificationsEndpoint,
-            fromField: "id",
-            paramName: "id",
-        },
-    ],
-
-    // @auto-generated-start
-    autoGenerated: {
-        params: [{ name: "id", required: true, type: "uuid" }] as const,
-        body: [] as const,
-        response: [
-            { 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: "description",
-                required: false,
-                type: "object",
-                properties: [
-                    { name: "ar", required: false, type: "string" },
-                    { name: "en", required: false, type: "string" },
-                ],
-            },
-            { name: "createdTime", required: false, type: "datetime" },
-            { name: "link", required: false, type: "string" },
-            { name: "tags", required: false, type: "string", isArray: true },
-            { name: "readTime", required: false, type: "datetime" },
-        ] as const,
-        successStatus: 200,
-        errorStatuses: [404],
-        responseKind: "object",
-    } as const,
-    // @auto-generated-end
-});

package/src/sample/domains/notifications/endpoints/listMyNotifications.endpoint.ts

@@ -1,59 +0,0 @@
-import { defineEndpoint } from "@m6d/cortex-server";
-import { notificationConcept } from "../concepts/notification.concept";
-
-export const listMyNotificationsEndpoint = defineEndpoint({
-    name: "List current user notifications",
-    path: "/notifications/users",
-    method: "GET",
-    description:
-        "Returns paginated notifications for the current user. Supports keyword and unread filtering for personal inbox-style queries.",
-    queries: [notificationConcept],
-    returns: [{ concept: notificationConcept }],
-    paramDescriptions: {
-        keyword: "Optional keyword filter",
-        isUnread: "Optional boolean filter to return only unread notifications",
-        page: "Pagination page number",
-        pageSize: "Pagination page size",
-    },
-
-    // @auto-generated-start
-    autoGenerated: {
-        params: [
-            { name: "keyword", required: false, type: "string" },
-            { name: "isUnread", required: false, type: "boolean" },
-            { 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: "createdTime", required: false, type: "datetime" },
-                    { name: "link", required: false, type: "string" },
-                    { name: "tags", required: false, type: "string", isArray: true },
-                    { name: "readTime", 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
-});