@m6d/cortex-server 1.7.0 → 1.8.0

package/src/sample/domains/suggestions/endpoints/updateSuggestionState.endpoint.ts

@@ -0,0 +1,39 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { suggestionConcept } from "../concepts/suggestion.concept";
+import { getSuggestionByIdEndpoint } from "./getSuggestionById.endpoint";
+
+export const updateSuggestionStateEndpoint = defineEndpoint({
+    name: "Update suggestion state",
+    path: "/suggestions/{id}/update-state",
+    method: "POST",
+    description:
+        "Updates the workflow state of a suggestion, such as moving a draft to submitted or recording a returned-state change when allowed for the current user.",
+    mutates: [suggestionConcept],
+    paramDescriptions: {
+        id: "The suggestion identifier",
+        state: "The target suggestion state",
+        notes: "Optional state change notes",
+    },
+    dependsOn: [
+        {
+            endpoint: getSuggestionByIdEndpoint,
+            fromField: "id",
+            paramName: "id",
+        },
+    ],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [
+            { name: "id", required: false, type: "uuid" },
+            { name: "state", required: false, type: "string" },
+            { name: "notes", required: false, type: "string" },
+        ] as const,
+        response: [] as const,
+        successStatus: 204,
+        errorStatuses: [400, 404],
+        responseKind: "none",
+    } as const,
+    // @auto-generated-end
+});

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

@@ -0,0 +1,34 @@
+import { defineDomain } from "@m6d/cortex-server";
+import type { DomainDef } from "@m6d/cortex-server";
+import { suggestionCategoryConcept } from "./concepts/suggestionCategory.concept";
+import { suggestionConcept } from "./concepts/suggestion.concept";
+import { suggestionImpactLevelConcept } from "./concepts/suggestionImpactLevel.concept";
+import { createSuggestionEndpoint } from "./endpoints/createSuggestion.endpoint";
+import { deleteSuggestionEndpoint } from "./endpoints/deleteSuggestion.endpoint";
+import { getSuggestionByIdEndpoint } from "./endpoints/getSuggestionById.endpoint";
+import { listSuggestionCategoriesEndpoint } from "./endpoints/listSuggestionCategories.endpoint";
+import { listSuggestionImpactLevelsEndpoint } from "./endpoints/listSuggestionImpactLevels.endpoint";
+import { listSuggestionStatesEndpoint } from "./endpoints/listSuggestionStates.endpoint";
+import { listSuggestionsEndpoint } from "./endpoints/listSuggestions.endpoint";
+import { updateSuggestionEndpoint } from "./endpoints/updateSuggestion.endpoint";
+import { updateSuggestionStateEndpoint } from "./endpoints/updateSuggestionState.endpoint";
+import { suggestionScopeRule } from "./rules/suggestionScope.rule";
+
+export const suggestionsDomain: DomainDef = defineDomain({
+    name: "Suggestions",
+    description:
+        "Employee suggestion self-service domain covering the current user's suggestions, drafts, submissions, state changes, categories, and impact levels.",
+    concepts: [suggestionConcept, suggestionCategoryConcept, suggestionImpactLevelConcept],
+    endpoints: [
+        listSuggestionsEndpoint,
+        getSuggestionByIdEndpoint,
+        createSuggestionEndpoint,
+        updateSuggestionEndpoint,
+        deleteSuggestionEndpoint,
+        updateSuggestionStateEndpoint,
+        listSuggestionStatesEndpoint,
+        listSuggestionCategoriesEndpoint,
+        listSuggestionImpactLevelsEndpoint,
+    ],
+    rules: [suggestionScopeRule],
+});

package/src/sample/domains/suggestions/rules/suggestionScope.rule.ts

@@ -0,0 +1,7 @@
+import { defineRule } from "@m6d/cortex-server";
+
+export const suggestionScopeRule = defineRule({
+    name: "Prefer own suggestions scope",
+    description:
+        "When listing suggestions for self-service conversations, prefer scope=own so results are limited to the current user's suggestions unless the user explicitly asks for a broader accessible view.",
+});

package/src/sample/domains/surveys/concepts/survey.concept.ts

@@ -0,0 +1,10 @@
+import { defineConcept } from "@m6d/cortex-server";
+import { paginationRule } from "../../shared/rules/pagination.rule";
+
+export const surveyConcept = defineConcept({
+    name: "Survey",
+    description:
+        "A survey targeted to the current user, including its publishing window, questions, and overall response status.",
+    aliases: ["survey", "targeted survey", "my surveys", "questionnaire", "استبيان", "استبياناتي"],
+    governedBy: [paginationRule],
+});

package/src/sample/domains/surveys/concepts/surveyResponse.concept.ts

@@ -0,0 +1,14 @@
+import { defineConcept } from "@m6d/cortex-server";
+
+export const surveyResponseConcept = defineConcept({
+    name: "Survey Response",
+    description:
+        "A response submitted by the current user to a targeted survey, including answers and completion status.",
+    aliases: [
+        "survey response",
+        "response",
+        "my survey response",
+        "رد الاستبيان",
+        "إجاباتي على الاستبيان",
+    ],
+});

package/src/sample/domains/surveys/endpoints/getSurveyResponseById.endpoint.ts

@@ -0,0 +1,131 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { surveyResponseConcept } from "../concepts/surveyResponse.concept";
+import { listTargetedSurveysEndpoint } from "./listTargetedSurveys.endpoint";
+
+export const getSurveyResponseByIdEndpoint = defineEndpoint({
+    name: "Get survey response by id",
+    path: "/surveys/responses/{id}",
+    method: "GET",
+    description: "Returns a single survey response accessible to the current user.",
+    queries: [surveyResponseConcept],
+    returns: [{ concept: surveyResponseConcept }],
+    paramDescriptions: {
+        id: "The survey response identifier",
+    },
+    dependsOn: [
+        {
+            endpoint: listTargetedSurveysEndpoint,
+            fromField: "response.id",
+            paramName: "id",
+        },
+    ],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [
+            { name: "id", required: false, type: "uuid" },
+            {
+                name: "survey",
+                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: "createdTime", required: false, type: "datetime" },
+            { name: "modifiedTime", required: false, type: "datetime" },
+            { name: "isCompleted", required: false, type: "boolean" },
+            {
+                name: "answers",
+                required: false,
+                type: "object",
+                isArray: true,
+                properties: [
+                    {
+                        name: "question",
+                        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: "type", required: false, type: "string" },
+                            { name: "order", required: false, type: "number" },
+                            {
+                                name: "options",
+                                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: "createdTime", required: false, type: "datetime" },
+                            { name: "modifiedTime", required: false, type: "datetime" },
+                        ],
+                    },
+                    { name: "values", required: false, type: "string", isArray: true },
+                    { name: "createdTime", required: false, type: "datetime" },
+                    { name: "modifiedTime", required: false, type: "datetime" },
+                ],
+            },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

package/src/sample/domains/surveys/endpoints/getTargetedSurvey.endpoint.ts

@@ -0,0 +1,129 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { surveyConcept } from "../concepts/survey.concept";
+import { listTargetedSurveysEndpoint } from "./listTargetedSurveys.endpoint";
+
+export const getTargetedSurveyEndpoint = defineEndpoint({
+    name: "Get targeted survey by id",
+    path: "/surveys/targeted/{id}",
+    method: "GET",
+    description: "Returns a targeted survey that the current user can view or respond to.",
+    queries: [surveyConcept],
+    returns: [{ concept: surveyConcept }],
+    paramDescriptions: {
+        id: "The survey identifier",
+    },
+    dependsOn: [
+        {
+            endpoint: listTargetedSurveysEndpoint,
+            fromField: "survey.id",
+            paramName: "id",
+        },
+    ],
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [{ name: "id", required: true, type: "uuid" }] as const,
+        body: [] as const,
+        response: [
+            { 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: "createdTime", required: false, type: "datetime" },
+            { name: "modifiedTime", required: false, type: "datetime" },
+            { name: "from", required: false, type: "datetime" },
+            { name: "to", required: false, type: "datetime" },
+            { name: "state", required: false, type: "string" },
+            { name: "questionCount", required: false, type: "number" },
+            { name: "responseCount", required: false, type: "number" },
+            { name: "targetCount", required: false, type: "number" },
+            { name: "responseRate", required: false, type: "number" },
+            {
+                name: "users",
+                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: "questions",
+                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: "type", required: false, type: "string" },
+                    { name: "order", required: false, type: "number" },
+                    {
+                        name: "options",
+                        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: "createdTime", required: false, type: "datetime" },
+                    { name: "modifiedTime", required: false, type: "datetime" },
+                ],
+            },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [404],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});

package/src/sample/domains/surveys/endpoints/listTargetedSurveys.endpoint.ts

@@ -0,0 +1,160 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { surveyConcept } from "../concepts/survey.concept";
+import { surveyResponseConcept } from "../concepts/surveyResponse.concept";
+
+export const listTargetedSurveysEndpoint = defineEndpoint({
+    name: "List targeted surveys for current user",
+    path: "/surveys/targeted",
+    method: "GET",
+    description:
+        "Returns the surveys targeted to the current user together with current response state such as complete or incomplete.",
+    queries: [surveyConcept, surveyResponseConcept],
+    returns: [{ concept: surveyConcept }, { concept: surveyResponseConcept }],
+    paramDescriptions: {
+        keyword: "Optional keyword filter",
+        responseStates: "Optional response state filter such as completed or incomplete",
+        page: "Pagination page number",
+        pageSize: "Pagination page size",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "keyword", required: false, type: "string" },
+            { name: "responseStates", required: false, type: "string", isArray: true },
+            { name: "pageNumber", required: false, type: "number" },
+            { name: "pageSize", required: false, type: "number" },
+        ] as const,
+        body: [] as const,
+        response: [
+            {
+                name: "survey",
+                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: "createdTime", required: false, type: "datetime" },
+                    { name: "modifiedTime", required: false, type: "datetime" },
+                ],
+            },
+            {
+                name: "response",
+                required: false,
+                type: "object",
+                properties: [
+                    { name: "id", required: false, type: "uuid" },
+                    {
+                        name: "survey",
+                        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: "createdTime", required: false, type: "datetime" },
+                    { name: "modifiedTime", required: false, type: "datetime" },
+                    { name: "isCompleted", required: false, type: "boolean" },
+                    {
+                        name: "answers",
+                        required: false,
+                        type: "object",
+                        isArray: true,
+                        properties: [
+                            {
+                                name: "question",
+                                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: "type", required: false, type: "string" },
+                                    { name: "order", required: false, type: "number" },
+                                    {
+                                        name: "options",
+                                        required: false,
+                                        type: "object",
+                                        isArray: true,
+                                        properties: [
+                                            { name: "value", required: false, type: "string" },
+                                            { name: "name", required: false, type: "object" },
+                                        ],
+                                    },
+                                    { name: "createdTime", required: false, type: "datetime" },
+                                    { name: "modifiedTime", required: false, type: "datetime" },
+                                ],
+                            },
+                            { name: "values", required: false, type: "string", isArray: true },
+                            { name: "createdTime", required: false, type: "datetime" },
+                            { name: "modifiedTime", required: false, type: "datetime" },
+                        ],
+                    },
+                ],
+            },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "array",
+    } as const,
+    // @auto-generated-end
+});