@m6d/cortex-server 1.6.0 → 1.8.0

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

@@ -0,0 +1,216 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { serviceRequestConcept } from "../concepts/serviceRequest.concept";
+
+export const getServiceRequestTransactionFormItemsEndpoint = defineEndpoint({
+    name: "Get service request transaction form items",
+    path: "/servicing/services/{id}/transaction-form-items/{actionToInvoke}",
+    method: "GET",
+    description: "Get transaction form items required for a specific action on a service request.",
+    queries: [serviceRequestConcept],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "id", required: true, type: "string" },
+            { name: "actionToInvoke", required: true, type: "string" },
+            { name: "requestId", required: false, type: "uuid" },
+            { name: "transactionId", required: false, type: "uuid" },
+            { name: "transactionData", required: false, type: "string" },
+        ] as const,
+        body: [] as const,
+        response: [
+            { name: "id", required: false, type: "string" },
+            {
+                name: "label",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "ar", required: false, type: "string" },
+                    { name: "en", required: false, type: "string" },
+                ],
+            },
+            {
+                name: "type",
+                required: false,
+                type: "'text' | 'large_text' | 'number' | 'date' | 'datetime' | 'boolean' | 'file' | 'option' | 'repeat'",
+            },
+            { name: "isRequired", required: false, type: "boolean" },
+            { name: "isHidden", required: false, type: "boolean" },
+            { name: "isDisabled", required: false, type: "boolean" },
+            { name: "defaultValue", required: false, type: "unknown" },
+            {
+                name: "note",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "ar", required: false, type: "string" },
+                    { name: "en", required: false, type: "string" },
+                ],
+            },
+            {
+                name: "options",
+                required: false,
+                type: "object",
+                isArray: true,
+                properties: [
+                    { name: "id", required: false, type: "string" },
+                    {
+                        name: "name",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "ar", required: false, type: "string" },
+                            { name: "en", required: false, type: "string" },
+                        ],
+                    },
+                ],
+            },
+            { name: "disableSelectionInOptionsCheck", required: false, type: "boolean" },
+            {
+                name: "repeatConfig",
+                required: false,
+                type: "object",
+                properties: [
+                    {
+                        name: "items",
+                        required: false,
+                        type: "object",
+                        isArray: true,
+                        properties: [
+                            { name: "id", required: false, type: "string" },
+                            {
+                                name: "label",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "type",
+                                required: false,
+                                type: "'text' | 'large_text' | 'number' | 'date' | 'datetime' | 'boolean' | 'file' | 'option' | 'repeat'",
+                            },
+                            { name: "isRequired", required: false, type: "boolean" },
+                            { name: "isHidden", required: false, type: "boolean" },
+                            { name: "isDisabled", required: false, type: "boolean" },
+                            { name: "defaultValue", required: false, type: "unknown" },
+                            {
+                                name: "note",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    { name: "ar", required: false, type: "string" },
+                                    { name: "en", required: false, type: "string" },
+                                ],
+                            },
+                            {
+                                name: "options",
+                                required: false,
+                                type: "object",
+                                isArray: true,
+                                properties: [
+                                    { name: "id", required: false, type: "string" },
+                                    {
+                                        name: "name",
+                                        required: false,
+                                        type: "object",
+                                        properties: [
+                                            { name: "ar", required: false, type: "string" },
+                                            { name: "en", required: false, type: "string" },
+                                        ],
+                                    },
+                                ],
+                            },
+                            {
+                                name: "disableSelectionInOptionsCheck",
+                                required: false,
+                                type: "boolean",
+                            },
+                            {
+                                name: "repeatConfig",
+                                required: false,
+                                type: "object",
+                                properties: [
+                                    {
+                                        name: "items",
+                                        required: false,
+                                        type: "object",
+                                        isArray: true,
+                                        properties: [
+                                            { name: "id", required: false, type: "string" },
+                                            { name: "label", required: false, type: "object" },
+                                            {
+                                                name: "type",
+                                                required: false,
+                                                type: "'text' | 'large_text' | 'number' | 'date' | 'datetime' | 'boolean' | 'file' | 'option' | 'repeat'",
+                                            },
+                                            {
+                                                name: "isRequired",
+                                                required: false,
+                                                type: "boolean",
+                                            },
+                                            { name: "isHidden", required: false, type: "boolean" },
+                                            {
+                                                name: "isDisabled",
+                                                required: false,
+                                                type: "boolean",
+                                            },
+                                            {
+                                                name: "defaultValue",
+                                                required: false,
+                                                type: "unknown",
+                                            },
+                                            { name: "note", required: false, type: "object" },
+                                            {
+                                                name: "options",
+                                                required: false,
+                                                type: "object",
+                                                isArray: true,
+                                            },
+                                            {
+                                                name: "disableSelectionInOptionsCheck",
+                                                required: false,
+                                                type: "boolean",
+                                            },
+                                            {
+                                                name: "repeatConfig",
+                                                required: false,
+                                                type: "object",
+                                            },
+                                            {
+                                                name: "refreshForm",
+                                                required: false,
+                                                type: "boolean",
+                                            },
+                                            {
+                                                name: "refreshStateList",
+                                                required: false,
+                                                type: "boolean",
+                                            },
+                                        ],
+                                    },
+                                    {
+                                        name: "isAdditionDisabled",
+                                        required: false,
+                                        type: "boolean",
+                                    },
+                                ],
+                            },
+                            { name: "refreshForm", required: false, type: "boolean" },
+                            { name: "refreshStateList", required: false, type: "boolean" },
+                        ],
+                    },
+                    { name: "isAdditionDisabled", required: false, type: "boolean" },
+                ],
+            },
+            { name: "refreshForm", required: false, type: "boolean" },
+            { name: "refreshStateList", required: false, type: "boolean" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "array",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,47 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { serviceConcept } from "../concepts/service.concept";
+
+export const getServiceStatesEndpoint = defineEndpoint({
+    name: "Get service states",
+    path: "/servicing/services/{id}/states",
+    method: "GET",
+    description:
+        "Returns the list of possible states for a given service. Each state has a value (used as filter key), a multilingual name, and an optional description. The service {id} is the real UUID (not the builtInId). Use this to discover valid state values before filtering service requests by state.",
+    queries: [serviceConcept],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "id", required: true, type: "string" },
+            { name: "serviceRequestId", required: false, type: "uuid" },
+            { name: "userId", required: false, type: "uuid" },
+            { name: "data", required: false, type: "string" },
+        ] as const,
+        body: [] as const,
+        response: [
+            { 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" },
+                ],
+            },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "array",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,139 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { serviceRequestConcept } from "../concepts/serviceRequest.concept";
+import { serviceRequestApprovalConcept } from "../concepts/serviceRequestApproval.concept";
+import { checkValidActionsRule } from "../rules/checkValidActions.rule";
+import { createServiceRequestEndpoint } from "./createServiceRequest.endpoint";
+import { getServiceRequestEndpoint } from "./getServiceRequest.endpoint";
+import { getServiceRequestTransactionFormItemsEndpoint } from "./getServiceRequestTransactionFormItems.endpoint";
+
+export const invokeServiceRequestActionEndpoint = defineEndpoint({
+    name: "Invoke service request action",
+    path: "/servicing/requests/{id}/invoke/{actionToInvoke}",
+    method: "POST",
+    description:
+        'Invoke an action on a service request. The actionToInvoke value depends on the request\'s current state — fetch the request first via GET /servicing/requests/{id} and check the "validActions" array to see which actions are available. Common actions: "submit" (after creation), "approve", "return", "reject". Standard actions require an empty body {}. Only include transactionData when the action explicitly needs additional input.',
+    mutates: [serviceRequestConcept, serviceRequestApprovalConcept],
+    dependsOn: [
+        {
+            endpoint: createServiceRequestEndpoint,
+            paramName: "id",
+            fromField: "id",
+        },
+        {
+            endpoint: getServiceRequestEndpoint,
+            paramName: "actionToInvoke",
+            fromField: "validActions",
+        },
+        {
+            endpoint: getServiceRequestTransactionFormItemsEndpoint,
+            paramName: "transactionData",
+            fromField: "*",
+        },
+    ],
+
+    governedBy: [checkValidActionsRule],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "id", required: true, type: "uuid" },
+            { name: "actionToInvoke", required: true, type: "string" },
+        ] as const,
+        body: [] as const,
+        response: [
+            { 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: 200,
+        errorStatuses: [400, 404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});