@m6d/cortex-server 1.7.0 → 1.8.0

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

@@ -0,0 +1,126 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalRecordFunctionalRequirementConcept } from "../concepts/appraisalRecordFunctionalRequirement.concept";
+
+export const getAppraisalRecordFunctionalRequirementsEndpoint = defineEndpoint({
+    name: "Get appraisal record functional requirements",
+    path: "/appraisals/records/{id}/functional-requirements",
+    method: "GET",
+    description:
+        "Get all functional requirements for an appraisal record, including their targets, achieved values, scores, justifications, and scoring bands. Also returns the overall functional requirements section score. Only available when the template has functional requirements enabled.",
+    queries: [appraisalRecordFunctionalRequirementConcept],
+    returns: [
+        {
+            concept: appraisalRecordFunctionalRequirementConcept,
+            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: "target", required: false, type: "number" },
+                    { name: "achieved", 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
+});

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

@@ -0,0 +1,104 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalRecordGoalConcept } from "../concepts/appraisalRecordGoal.concept";
+
+export const getAppraisalRecordGoalsEndpoint = defineEndpoint({
+    name: "Get appraisal record goals",
+    path: "/appraisals/records/{id}/goals",
+    method: "GET",
+    description:
+        "Get all goals for an appraisal record, including their weights, targets, achieved values, scores, justifications, and scoring bands. Also returns the overall goals section score.",
+    queries: [appraisalRecordGoalConcept],
+    returns: [{ concept: appraisalRecordGoalConcept, 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: "string" },
+                    { name: "weight", required: false, type: "number" },
+                    { name: "target", required: false, type: "number" },
+                    { name: "achieved", 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
+});

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

@@ -0,0 +1,58 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalRecordConcept } from "../concepts/appraisalRecord.concept";
+
+export const getAppraisalRecordScoreEndpoint = defineEndpoint({
+    name: "Get appraisal record score",
+    path: "/appraisals/records/{id}/score",
+    method: "GET",
+    description: "Get the computed total score and matching scoring band for an appraisal record.",
+    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: "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" },
+                ],
+            },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,52 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalCycleConcept } from "../concepts/appraisalCycle.concept";
+
+export const listAppraisalCyclesSimpleEndpoint = defineEndpoint({
+    name: "List appraisal cycles (simple)",
+    path: "/appraisals/cycles/simple",
+    method: "GET",
+    description:
+        "List appraisal cycles with simple output (ID and name only). Useful for filtering records by cycle or displaying cycle names in dropdowns.",
+    queries: [appraisalCycleConcept],
+    returns: [{ concept: appraisalCycleConcept }],
+
+    paramDescriptions: {
+        pageNumber: "0-based",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "keyword", required: false, type: "string" },
+            { 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: "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/appraisals/endpoints/listAppraisalRecords.endpoint.ts

@@ -0,0 +1,245 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalRecordConcept } from "../concepts/appraisalRecord.concept";
+import { appraisalRecordScopingRule } from "../rules/appraisalRecordScoping.rule";
+
+export const listAppraisalRecordsEndpoint = defineEndpoint({
+    name: "List appraisal records",
+    path: "/appraisals/records",
+    method: "GET",
+    description:
+        "List appraisal records with filtering and pagination. Use scope=Own to see your own records, scope=Act to see records needing your action. Can filter by employee, template, cycle, and flow state.",
+    queries: [appraisalRecordConcept],
+    returns: [{ concept: appraisalRecordConcept }],
+    governedBy: [appraisalRecordScopingRule],
+
+    paramDescriptions: {
+        pageNumber: "0-based",
+        scope: "Filter scope: Own (my records), Act (needing my action), All (all accessible)",
+        flowStates:
+            "Filter by flow state: draft, pending_goals_approval, goals_approved, reviewing, reviewed, assessing_by_employee, assessing_by_supervisor, final_assessment, finalized",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            {
+                name: "filterCountExclusions",
+                required: false,
+                type: "'employee_ids' | 'cycle_ids'",
+                isArray: true,
+            },
+            { name: "pageNumber", required: false, type: "number" },
+            { name: "pageSize", required: false, type: "number" },
+            { name: "employeeIds", required: false, type: "uuid", isArray: true },
+            { name: "templateIds", required: false, type: "uuid", isArray: true },
+            { name: "cycleIds", required: false, type: "uuid", isArray: true },
+            { name: "flowStates", required: false, type: "string", isArray: true },
+            { name: "scope", required: false, type: "'all' | 'own' | 'act'" },
+            { 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: "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: "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: "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: "flowState", required: false, type: "string" },
+                    { 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: "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/appraisals/endpoints/listAppraisalTemplatesSimple.endpoint.ts

@@ -0,0 +1,52 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { appraisalCycleConcept } from "../concepts/appraisalCycle.concept";
+
+export const listAppraisalTemplatesSimpleEndpoint = defineEndpoint({
+    name: "List appraisal templates (simple)",
+    path: "/appraisals/templates/simple",
+    method: "GET",
+    description:
+        "List appraisal templates with simple output (ID and name only). Useful for filtering records by template or displaying template names in dropdowns.",
+    queries: [appraisalCycleConcept],
+    returns: [{ concept: appraisalCycleConcept }],
+
+    paramDescriptions: {
+        pageNumber: "0-based",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "keyword", required: false, type: "string" },
+            { 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: "count", required: false, type: "number" },
+            { name: "filteredCount", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});