@m6d/cortex-server 1.7.0 → 1.8.0

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

@@ -0,0 +1,62 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { suggestionCategoryConcept } from "../concepts/suggestionCategory.concept";
+
+export const listSuggestionCategoriesEndpoint = defineEndpoint({
+    name: "List suggestion categories",
+    path: "/suggestions/categories",
+    method: "GET",
+    description:
+        "Returns suggestion categories available to the current user for selection during suggestion creation or editing.",
+    queries: [suggestionCategoryConcept],
+    returns: [{ concept: suggestionCategoryConcept }],
+    paramDescriptions: {
+        keyword: "Optional keyword filter",
+        page: "Pagination page number",
+        pageSize: "Pagination page size",
+    },
+
+    // @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: "description",
+                        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/suggestions/endpoints/listSuggestionImpactLevels.endpoint.ts

@@ -0,0 +1,62 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { suggestionImpactLevelConcept } from "../concepts/suggestionImpactLevel.concept";
+
+export const listSuggestionImpactLevelsEndpoint = defineEndpoint({
+    name: "List suggestion impact levels",
+    path: "/suggestions/impact-levels",
+    method: "GET",
+    description:
+        "Returns impact levels available to the current user for suggestion creation or editing.",
+    queries: [suggestionImpactLevelConcept],
+    returns: [{ concept: suggestionImpactLevelConcept }],
+    paramDescriptions: {
+        keyword: "Optional keyword filter",
+        page: "Pagination page number",
+        pageSize: "Pagination page size",
+    },
+
+    // @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: "description",
+                        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/suggestions/endpoints/listSuggestionStates.endpoint.ts

@@ -0,0 +1,24 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { suggestionConcept } from "../concepts/suggestion.concept";
+
+export const listSuggestionStatesEndpoint = defineEndpoint({
+    name: "List suggestion states",
+    path: "/suggestions/states",
+    method: "GET",
+    description: "Returns the available suggestion states used for filtering and state updates.",
+    queries: [suggestionConcept],
+
+    // @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/suggestions/endpoints/listSuggestions.endpoint.ts

@@ -0,0 +1,132 @@
+import { defineEndpoint } from "@m6d/cortex-server";
+import { suggestionConcept } from "../concepts/suggestion.concept";
+import { suggestionScopeRule } from "../rules/suggestionScope.rule";
+
+export const listSuggestionsEndpoint = defineEndpoint({
+    name: "List suggestions",
+    path: "/suggestions",
+    method: "GET",
+    description:
+        "Returns paginated suggestions accessible to the current user. For self-service use, scope=own should be used to retrieve the current user's suggestions.",
+    queries: [suggestionConcept],
+    returns: [{ concept: suggestionConcept }],
+    governedBy: [suggestionScopeRule],
+    paramDescriptions: {
+        scope: "Suggestion scope. Use own for current user's suggestions and all only when explicitly needed.",
+        keyword: "Optional keyword filter",
+        states: "Optional list of suggestion states",
+        page: "Pagination page number",
+        pageSize: "Pagination page size",
+    },
+
+    // @auto-generated-start
+    autoGenerated: {
+        params: [
+            { name: "keyword", required: false, type: "string" },
+            { name: "scope", required: false, type: "'all' | 'own'" },
+            { name: "states", 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: "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: "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: "expectedGoals", required: false, type: "string" },
+                    { name: "beneficiaries", required: false, type: "string" },
+                    {
+                        name: "impactLevel",
+                        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: "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: "state", required: false, type: "string" },
+                    { name: "expectedImplementationTime", required: false, type: "string" },
+                    {
+                        name: "actionAbility",
+                        required: false,
+                        type: "object",
+                        properties: [
+                            { name: "canEdit", required: false, type: "boolean" },
+                            { name: "canDelete", required: false, type: "boolean" },
+                        ],
+                    },
+                ],
+            },
+            { name: "count", required: false, type: "number" },
+            { name: "filteredCount", required: false, type: "number" },
+        ] as const,
+        successStatus: 200,
+        errorStatuses: [],
+        responseKind: "object",
+    } as const,
+    // @auto-generated-end
+});