@m6d/cortex-server 1.6.0 → 1.8.0

package/src/sample/domains/payroll/endpoints/listSalaryCertificateTypes.endpoint.ts

@@ -0,0 +1,24 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { salaryCertificateConcept } from "../concepts/salaryCertificate.concept";
+
+export const listSalaryCertificateTypesEndpoint = defineEndpoint({
+    name: "List salary certificate types",
+    path: "/payroll/salaries/certificates/types",
+    method: "GET",
+    description: "Returns the available salary certificate types used for previews and filtering.",
+    queries: [salaryCertificateConcept],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [] as const,
+        body: [] as const,
+        response: [
+            { name: "id", required: false, type: "string" },
+            { name: "name", required: false, type: "string" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "array",
+    } as const,
+    // @auto-generated-end
+});

package/src/sample/domains/payroll/endpoints/listSalaryCertificates.endpoint.ts

@@ -0,0 +1,122 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { salaryCertificateConcept } from "../concepts/salaryCertificate.concept";
+import { payrollEmployeeContextRule } from "../rules/payrollEmployeeContext.rule";
+
+export const listSalaryCertificatesEndpoint = defineEndpoint({
+    name: "List salary certificates",
+    path: "/payroll/salaries/certificates",
+    method: "GET",
+    description:
+        "Returns paginated salary or employment certificates. In self-service conversations, this should be limited to the current employee context.",
+    queries: [salaryCertificateConcept],
+    returns: [{ concept: salaryCertificateConcept }],
+    governedBy: [payrollEmployeeContextRule],
+    paramDescriptions: {
+        employeeIds:
+            "Filter by employee identifiers. For self-service use the current employee id.",
+        types: "Optional certificate type filters",
+        languages: "Optional certificate language filters",
+        page: "Pagination page number",
+        pageSize: "Pagination page size",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "keyword", required: false, type: "string" },
+            { name: "employeeIds", required: false, type: "uuid", isArray: true },
+            { name: "from", required: false, type: "datetime" },
+            { name: "to", required: false, type: "datetime" },
+            {
+                name: "filterCountExclusions",
+                required: false,
+                type: "'employee_ids'",
+                isArray: true,
+            },
+            { 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: "createdTime", required: false, type: "datetime" },
+                    {
+                        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: "type", required: false, type: "string" },
+                    { name: "language", required: false, type: "string" },
+                    {
+                        name: "entityName",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                    {
+                        name: "file",
+                        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/payroll/endpoints/previewSalaryCertificate.endpoint.ts

@@ -0,0 +1,45 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { salaryCertificateRequestingEntityConcept } from "../concepts/salaryCertificateRequestingEntity.concept";
+import { salaryCertificateConcept } from "../concepts/salaryCertificate.concept";
+import { payrollEmployeeContextRule } from "../rules/payrollEmployeeContext.rule";
+import { listSalaryCertificateRequestingEntitiesEndpoint } from "./listSalaryCertificateRequestingEntities.endpoint";
+
+export const previewSalaryCertificateEndpoint = defineEndpoint({
+    name: "Preview salary certificate",
+    path: "/payroll/salaries/certificates/employees/{employeeId}/preview",
+    method: "GET",
+    description:
+        "Generates a preview file for a salary or employment certificate for the specified employee. In self-service use the current employee id from session context.",
+    queries: [salaryCertificateConcept],
+    governedBy: [payrollEmployeeContextRule],
+    paramDescriptions: {
+        employeeId:
+            "The employee identifier. For self-service use the current employee id from session context.",
+        type: "Certificate type such as employment, salary, or detailed_salary",
+        language: "Certificate language such as arabic or english",
+        entityId: "The requesting entity identifier",
+    },
+    dependsOn: [
+        {
+            endpoint: listSalaryCertificateRequestingEntitiesEndpoint,
+            fromField: "id",
+            paramName: "entityId",
+        },
+    ],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "employeeId", required: true, type: "uuid" },
+            { name: "type", required: false, type: "string" },
+            { name: "language", required: false, type: "string" },
+            { name: "entityId", required: false, type: "uuid" },
+        ] as const,
+        body: [] as const,
+        response: [] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "none",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,32 @@
+import { defineDomain } from "@m6d/cortex-server";
+import type { DomainDef } from "@m6d/cortex-server";
+import { payslipConcept } from "./concepts/payslip.concept";
+import { salaryCertificateRequestingEntityConcept } from "./concepts/salaryCertificateRequestingEntity.concept";
+import { salaryCertificateConcept } from "./concepts/salaryCertificate.concept";
+import { getPayslipByIdEndpoint } from "./endpoints/getPayslipById.endpoint";
+import { listPayslipsEndpoint } from "./endpoints/listPayslips.endpoint";
+import { listSalaryCertificateLanguagesEndpoint } from "./endpoints/listSalaryCertificateLanguages.endpoint";
+import { listSalaryCertificateRequestingEntitiesEndpoint } from "./endpoints/listSalaryCertificateRequestingEntities.endpoint";
+import { listSalaryCertificateTypesEndpoint } from "./endpoints/listSalaryCertificateTypes.endpoint";
+import { listSalaryCertificatesEndpoint } from "./endpoints/listSalaryCertificates.endpoint";
+import { previewSalaryCertificateEndpoint } from "./endpoints/previewSalaryCertificate.endpoint";
+import { payrollEmployeeContextRule } from "./rules/payrollEmployeeContext.rule";
+import { payrollServices } from "./services/salaryCertificates.service";
+
+export const payrollDomain: DomainDef = defineDomain({
+    name: "Payroll",
+    description:
+        "Payroll self-service domain covering the current employee's payslips and salary certificate request, lookup, filtering, and preview workflows.",
+    concepts: [payslipConcept, salaryCertificateConcept, salaryCertificateRequestingEntityConcept],
+    endpoints: [
+        listPayslipsEndpoint,
+        getPayslipByIdEndpoint,
+        listSalaryCertificatesEndpoint,
+        previewSalaryCertificateEndpoint,
+        listSalaryCertificateTypesEndpoint,
+        listSalaryCertificateLanguagesEndpoint,
+        listSalaryCertificateRequestingEntitiesEndpoint,
+    ],
+    services: [...payrollServices],
+    rules: [payrollEmployeeContextRule],
+});

package/src/sample/domains/payroll/rules/payrollEmployeeContext.rule.ts

@@ -0,0 +1,7 @@
+import { defineRule } from "@m6d/cortex-server";
+
+export const payrollEmployeeContextRule = defineRule({
+    name: "Use current employee context for payroll self-service",
+    description:
+        "For payroll self-service operations, use the current employee context from the session whenever an employeeId is needed. Do not browse or mutate payroll data for other employees unless the user explicitly asks and is clearly authorized.",
+});

package/src/sample/domains/payroll/services/salaryCertificates.service.ts

@@ -0,0 +1,15 @@
+import { defineService } from "@m6d/cortex-server";
+import { salaryCertificateConcept } from "../concepts/salaryCertificate.concept";
+
+export const salaryCertificateService = defineService({
+    name: "Salary certificate request",
+    builtInId: "services:salary_certificate",
+    belongsTo: salaryCertificateConcept,
+    description:
+        "Request a salary or employment certificate. The request captures certificate type, requesting entity, language, and purpose, then follows the salary-certificate approval workflow until the certificate is generated.",
+    metadata: {
+        intakeMode: "conversational",
+    },
+});
+
+export const payrollServices = [salaryCertificateService];

package/src/sample/domains/servicing/concepts/service.concept.ts

@@ -0,0 +1,6 @@
+import { defineConcept } from "@m6d/cortex-server";
+
+export const serviceConcept = defineConcept({
+    name: "Service",
+    description: "A workflow that represents a process a user can apply for.",
+});

package/src/sample/domains/servicing/concepts/serviceRequest.concept.ts

@@ -0,0 +1,12 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+import { filterServiceRequestsByStateRule } from "../rules/filterServiceRequestsByState.rule";
+import { serviceConcept } from "./service.concept";
+
+export const serviceRequestConcept = defineConcept({
+    name: "ServiceRequest",
+    description:
+        "A service request in the servicing/workflow system. Used for requests that go through approval workflows. Tracks status, actioners, and approval chain.",
+    governedBy: [paginationRule, filterServiceRequestsByStateRule],
+    parentConcept: serviceConcept,
+});

package/src/sample/domains/servicing/concepts/serviceRequestApproval.concept.ts

@@ -0,0 +1,9 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { serviceRequestConcept } from "./serviceRequest.concept";
+
+export const serviceRequestApprovalConcept = defineConcept({
+    name: "Service request approval",
+    description:
+        "Other names include action invocation, transfer, etc; it is the action of invoking an action on an existing requests. Requests that have an invocable action are categorized as pending requests.",
+    parentConcept: serviceRequestConcept,
+});

package/src/sample/domains/servicing/endpoints/cancelServiceRequest.endpoint.ts

@@ -0,0 +1,21 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { serviceRequestConcept } from "../concepts/serviceRequest.concept";
+
+export const cancelServiceRequestEndpoint = defineEndpoint({
+    name: "Cancel service request",
+    path: "/servicing/requests/{id}/cancel",
+    method: "PUT",
+    description: "Cancel a pending service request",
+    mutates: [serviceRequestConcept],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [] as const,
+        successStatus: 204,
+        errorStatuses: [400, 401],
+        responseKind: "none",
+    } as const,
+    // @auto-generated-end
+});