@m6d/cortex-server 1.6.0 → 1.8.0

package/src/sample/domains/account/endpoints/revokeCurrentSession.endpoint.ts

@@ -0,0 +1,33 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { sessionConcept } from "../concepts/session.concept";
+import { listCurrentSessionsEndpoint } from "./listCurrentSessions.endpoint";
+
+export const revokeCurrentSessionEndpoint = defineEndpoint({
+    name: "Revoke one current user session",
+    path: "/auth/users/current/sessions/{sessionId}",
+    method: "DELETE",
+    description:
+        "Revokes a specific active session belonging to the current user. Use it to sign out one device or browser session.",
+    paramDescriptions: {
+        sessionId: "The session identifier to revoke",
+    },
+    mutates: [sessionConcept],
+    dependsOn: [
+        {
+            endpoint: listCurrentSessionsEndpoint,
+            fromField: "sessionId",
+            paramName: "sessionId",
+        },
+    ],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "sessionId", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [] as const,
+        successStatus: 204,
+        errorStatuses: [400, 404],
+        responseKind: "none",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,18 @@
+import { defineDomain } from "@m6d/cortex-server";
+import type { DomainDef } from "@m6d/cortex-server";
+import { sessionConcept } from "./concepts/session.concept";
+import { listCurrentSessionsEndpoint } from "./endpoints/listCurrentSessions.endpoint";
+import { revokeAllOtherSessionsEndpoint } from "./endpoints/revokeAllOtherSessions.endpoint";
+import { revokeCurrentSessionEndpoint } from "./endpoints/revokeCurrentSession.endpoint";
+
+export const accountDomain: DomainDef = defineDomain({
+    name: "Account",
+    description:
+        "Personal account security domain covering the current user's active login sessions and session revocation actions.",
+    concepts: [sessionConcept],
+    endpoints: [
+        listCurrentSessionsEndpoint,
+        revokeCurrentSessionEndpoint,
+        revokeAllOtherSessionsEndpoint,
+    ],
+});

package/src/sample/domains/appraisals/concepts/appraisalCycle.concept.ts

@@ -0,0 +1,15 @@
+import { defineConcept } from "@m6d/cortex-server";
+
+export const appraisalCycleConcept = defineConcept({
+    name: "AppraisalCycle",
+    description:
+        "A time-bounded evaluation period with three stages: Setting Goals, Performance Review, and Performance Assessment. Each stage has its own date range. Cycles can be published or unpublished.",
+    aliases: [
+        "appraisal cycle",
+        "evaluation period",
+        "performance cycle",
+        "دورة تقييم",
+        "فترة التقييم",
+        "دورة الأداء",
+    ],
+});

package/src/sample/domains/appraisals/concepts/appraisalRecord.concept.ts

@@ -0,0 +1,20 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+import { appraisalCycleConcept } from "./appraisalCycle.concept";
+
+export const appraisalRecordConcept = defineConcept({
+    name: "AppraisalRecord",
+    description:
+        "An individual employee's appraisal within a cycle, linked to a specific template. Has a workflow with flow states: draft, pending_goals_approval, goals_approved, reviewing, reviewed, assessing_by_employee, assessing_by_supervisor, final_assessment, finalized. Includes ability flags (canSetGoals, canSetAchieved, canSetScores) and available flow transitions.",
+    aliases: [
+        "appraisal record",
+        "performance appraisal",
+        "my appraisal",
+        "evaluation record",
+        "سجل التقييم",
+        "تقييم الأداء",
+        "تقييمي",
+    ],
+    parentConcept: appraisalCycleConcept,
+    governedBy: [paginationRule],
+});

package/src/sample/domains/appraisals/concepts/appraisalRecordCompetency.concept.ts

@@ -0,0 +1,10 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { appraisalRecordConcept } from "./appraisalRecord.concept";
+
+export const appraisalRecordCompetencyConcept = defineConcept({
+    name: "AppraisalRecordCompetency",
+    description:
+        "A competency assigned to an appraisal record from the template. Has a multilingual name, description, weight, target, and optionally achieved value, score, and justification. Competencies are scored during assessment.",
+    aliases: ["appraisal competency", "performance competency", "كفاءة التقييم", "كفاءات الأداء"],
+    parentConcept: appraisalRecordConcept,
+});

package/src/sample/domains/appraisals/concepts/appraisalRecordFunctionalRequirement.concept.ts

@@ -0,0 +1,10 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { appraisalRecordConcept } from "./appraisalRecord.concept";
+
+export const appraisalRecordFunctionalRequirementConcept = defineConcept({
+    name: "AppraisalRecordFunctionalRequirement",
+    description:
+        "A functional requirement assigned to an appraisal record from the template. Has a multilingual name, description, target, and optionally achieved value, score, and justification. Only present when the template has functional requirements enabled.",
+    aliases: ["functional requirement", "appraisal requirement", "متطلب وظيفي", "متطلبات التقييم"],
+    parentConcept: appraisalRecordConcept,
+});

package/src/sample/domains/appraisals/concepts/appraisalRecordGoal.concept.ts

@@ -0,0 +1,17 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { appraisalRecordConcept } from "./appraisalRecord.concept";
+
+export const appraisalRecordGoalConcept = defineConcept({
+    name: "AppraisalRecordGoal",
+    description:
+        "A goal defined by an employee within their appraisal record. Has a name, weight, target value, and optionally achieved value, score, and justification. Goals are set during the goal-setting stage and scored during assessment.",
+    aliases: [
+        "appraisal goal",
+        "performance goal",
+        "my goals",
+        "هدف التقييم",
+        "أهداف الأداء",
+        "أهدافي",
+    ],
+    parentConcept: appraisalRecordConcept,
+});

package/src/sample/domains/appraisals/endpoints/getAppraisalRecordById.endpoint.ts

@@ -0,0 +1,321 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalRecordConcept } from "../concepts/appraisalRecord.concept";
+
+export const getAppraisalRecordByIdEndpoint = defineEndpoint({
+    name: "Get appraisal record by ID",
+    path: "/appraisals/records/{id}",
+    method: "GET",
+    description:
+        "Get a specific appraisal record with full details including cycle info, template constraints, employee info, flow state, ability flags (canSetGoals, canSetAchieved, canSetScores), available flow transitions, overall score, and band.",
+    queries: [appraisalRecordConcept],
+    returns: [{ concept: appraisalRecordConcept }],
+
+    paramDescriptions: {
+        id: "The appraisal record UUID",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [
+            { name: "id", required: false, type: "uuid" },
+            {
+                name: "cycle",
+                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: "from", required: false, type: "datetime" },
+                    { name: "to", required: false, type: "datetime" },
+                    { name: "settingGoalsFrom", required: false, type: "datetime" },
+                    { name: "settingGoalsTo", required: false, type: "datetime" },
+                    { name: "performanceReviewFrom", required: false, type: "datetime" },
+                    { name: "performanceReviewTo", required: false, type: "datetime" },
+                    { name: "performanceAssessmentFrom", required: false, type: "datetime" },
+                    { name: "performanceAssessmentTo", required: false, type: "datetime" },
+                    { name: "didSettingGoalsStart", required: false, type: "boolean" },
+                    { name: "didPerformanceReviewStart", required: false, type: "boolean" },
+                    { name: "didPerformanceAssessmentStart", required: false, type: "boolean" },
+                ],
+            },
+            {
+                name: "template",
+                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: "minGoalCount", required: false, type: "number" },
+                    { name: "maxGoalCount", required: false, type: "number" },
+                    { name: "minGoalWeight", required: false, type: "number" },
+                    { name: "maxGoalWeight", required: false, type: "number" },
+                    { name: "goalWeightSum", required: false, type: "number" },
+                    { name: "maxGoalAchieved", required: false, type: "number" },
+                    { name: "maxScore", required: false, type: "number" },
+                    { name: "isFunctionalRequirementsEnabled", required: false, type: "boolean" },
+                ],
+            },
+            {
+                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: "manager",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            {
+                                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: "titles",
+                                required: false,
+                                type: "object",
+                                isArray: true,
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", 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: "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: "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: "flowState", required: false, type: "string" },
+            {
+                name: "ability",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "canSetGoals", required: false, type: "boolean" },
+                    { name: "canSetAchieved", required: false, type: "boolean" },
+                    { name: "canSetScores", required: false, type: "boolean" },
+                ],
+            },
+            { name: "score", required: false, type: "number" },
+            {
+                name: "band",
+                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: "description",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    { name: "order", required: false, type: "number" },
+                    { name: "from", required: false, type: "number" },
+                    { name: "to", required: false, type: "number" },
+                    { name: "color", required: false, type: "string" },
+                ],
+            },
+            {
+                name: "flowTransitions",
+                required: false,
+                type: "object",
+                isArray: true,
+                properties: [
+                    { name: "fromState", required: false, type: "string" },
+                    { name: "toState", required: false, type: "string" },
+                    { name: "action", required: false, type: "string" },
+                ],
+            },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

package/src/sample/domains/appraisals/endpoints/getAppraisalRecordCompetencies.endpoint.ts

@@ -0,0 +1,120 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalRecordCompetencyConcept } from "../concepts/appraisalRecordCompetency.concept";
+
+export const getAppraisalRecordCompetenciesEndpoint = defineEndpoint({
+    name: "Get appraisal record competencies",
+    path: "/appraisals/records/{id}/competencies",
+    method: "GET",
+    description:
+        "Get all competencies for an appraisal record, including their weights, targets, achieved values, scores, justifications, and scoring bands. Also returns the overall competencies section score.",
+    queries: [appraisalRecordCompetencyConcept],
+    returns: [{ concept: appraisalRecordCompetencyConcept, field: "items" }],
+
+    paramDescriptions: {
+        id: "The appraisal record UUID",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [
+            { name: "score", required: false, type: "number" },
+            {
+                name: "band",
+                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: "description",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    { name: "order", required: false, type: "number" },
+                    { name: "from", required: false, type: "number" },
+                    { name: "to", required: false, type: "number" },
+                    { name: "color", required: false, type: "string" },
+                ],
+            },
+            {
+                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: "description",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    { name: "order", required: false, type: "number" },
+                    { name: "weight", required: false, type: "number" },
+                    { name: "score", required: false, type: "number" },
+                    { name: "justification", required: false, type: "string" },
+                    {
+                        name: "band",
+                        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: "description",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            { name: "order", required: false, type: "number" },
+                            { name: "from", required: false, type: "number" },
+                            { name: "to", required: false, type: "number" },
+                            { name: "color", required: false, type: "string" },
+                        ],
+                    },
+                ],
+            },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});