@m6d/cortex-server 1.6.0 → 1.8.0

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

@@ -0,0 +1,511 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { serviceRequestConcept } from "../concepts/serviceRequest.concept";
+import { createServiceRequestRule } from "../rules/createServiceRequest.rule";
+import { passingOptionFieldsRule } from "../rules/passingOptionFields.rule";
+import { getServiceRequestFormItems } from "./getServiceRequestFormItems.endpoint";
+
+export const createServiceRequestEndpoint = defineEndpoint({
+    name: "Create service request",
+    path: "/servicing/services/{id}/requests",
+    method: "POST",
+    description:
+        "Create a new service request (e.g., annual leave request, sick leave request). The {id} is the service UUID obtained from the services list.",
+    paramDescriptions: {
+        id: "The service UUID (path parameter)",
+        serviceId: "The service UUID or built-in id (body parameter, same value as id)",
+        userId: "This is the user id not the employee id",
+        data: "The service request data as a JSON object — structure depends on the specific service",
+    },
+    mutates: [serviceRequestConcept],
+    dependsOn: [
+        {
+            endpoint: getServiceRequestFormItems,
+            fromField: "*",
+            paramName: "*",
+        },
+    ],
+
+    governedBy: [createServiceRequestRule, passingOptionFieldsRule],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "string" }] as const,
+        body: [
+            { name: "serviceId", required: false, type: "string" },
+            { name: "userId", required: false, type: "uuid" },
+            { name: "data", required: false, type: "object" },
+            {
+                name: "invocationSource",
+                required: false,
+                type: "'internal' | 'external'",
+            },
+        ] as const,
+        response: [
+            { name: "id", required: false, type: "uuid" },
+            { name: "createdTime", required: false, type: "datetime" },
+            {
+                name: "service",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    { name: "builtInId", required: false, type: "string" },
+                    {
+                        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: "subcategory",
+                        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: "category",
+                                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: "isProxyApplicationEnabled",
+                        required: false,
+                        type: "boolean",
+                    },
+                    { name: "isArchived", required: false, type: "boolean" },
+                    {
+                        name: "isSystemManaged",
+                        required: false,
+                        type: "boolean",
+                    },
+                    {
+                        name: "states",
+                        required: false,
+                        type: "object",
+                        isArray: true,
+                        properties: [
+                            { name: "value", required: false, type: "string" },
+                            {
+                                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: "actions",
+                        required: false,
+                        type: "object",
+                        isArray: true,
+                        properties: [
+                            { name: "key", required: false, type: "string" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    {
+                                        name: "ar",
+                                        required: false,
+                                        type: "string",
+                                    },
+                                    {
+                                        name: "en",
+                                        required: false,
+                                        type: "string",
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        name: "requirements",
+                        required: false,
+                        type: "object",
+                        isArray: true,
+                        properties: [
+                            {
+                                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: "globalExtraData",
+                        required: false,
+                        type: "unknown",
+                    },
+                ],
+            },
+            {
+                name: "applyingUser",
+                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: "globalExtraData",
+                        required: false,
+                        type: "unknown",
+                    },
+                ],
+            },
+            {
+                name: "state",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "value", required: false, type: "string" },
+                    {
+                        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: "lastAction",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "key", required: false, type: "string" },
+                    {
+                        name: "name",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                ],
+            },
+            { name: "data", required: false, type: "object" },
+            {
+                name: "latestTransactionCreatedTime",
+                required: false,
+                type: "datetime",
+            },
+            {
+                name: "ability",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "canWrite", required: false, type: "boolean" },
+                    { name: "canDelete", required: false, type: "boolean" },
+                    { name: "canCancel", required: false, type: "boolean" },
+                ],
+            },
+            { name: "isUserSuspended", required: false, type: "boolean" },
+            { name: "globalExtraData", required: false, type: "unknown" },
+            {
+                name: "validActions",
+                required: false,
+                type: "string",
+                isArray: true,
+            },
+            {
+                name: "transactions",
+                required: false,
+                type: "object",
+                isArray: true,
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    { name: "createdTime", required: false, type: "datetime" },
+                    {
+                        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: "fromState",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "value", required: false, type: "string" },
+                            {
+                                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: "action",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "key", required: false, type: "string" },
+                            {
+                                name: "name",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    {
+                                        name: "ar",
+                                        required: false,
+                                        type: "string",
+                                    },
+                                    {
+                                        name: "en",
+                                        required: false,
+                                        type: "string",
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        name: "toState",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "value", required: false, type: "string" },
+                            {
+                                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: "data", required: false, type: "object" },
+                ],
+            },
+        ] as const,
+        successStatus: 201,
+        errorStatuses: [400, 404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});