feat: OperationDeclaration: enhanced typings

ladesa-ro · May 1, 2024 · f07ff0e · f07ff0e
1 parent 54b8650
commit f07ff0e
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 25 deletions.
diff --git a/javascript/sisgea-spec/src/helpers/EntityDeclaration/EntityDeclaration.ts b/javascript/sisgea-spec/src/helpers/EntityDeclaration/EntityDeclaration.ts
@@ -28,6 +28,7 @@ export type IOutputDeclarationModes = typeof OutputDeclarationModes;
 export type IOutputDeclarationMode = IOutputDeclarationModes[keyof IOutputDeclarationModes];
 
 export type IDeclarationPropertySimple = {
+  name?: string | void;
   arrayOf?: boolean;
   type: Omit<IPropertyType, IPropertyTypes['MIXED']> | IDeclarator<any>;
   required?: boolean;

diff --git a/javascript/sisgea-spec/src/helpers/OperationDeclaration/OperationDeclaration.ts b/javascript/sisgea-spec/src/helpers/OperationDeclaration/OperationDeclaration.ts
@@ -1,30 +1,42 @@
 import { IDeclarationProperty, IDeclarator } from '../EntityDeclaration/EntityDeclaration';
 
+export type IOperationInputFile = {
+  strategy: 'file';
+  mimeTypes: string[];
+};
+
+export type IOperationInputDto = {
+  strategy: 'dto';
+  body?: Record<string, IDeclarationProperty> | null;
+  query?: Record<string, IDeclarationProperty> | null;
+  params?: Record<string, IDeclarationProperty> | null;
+  combineInputs?: (inputs: { body: Record<string, unknown>; query: Record<string, unknown>; params?: unknown }) => unknown;
+};
+
+export type IOperationOutputFile = {
+  strategy: 'file';
+  mimeTypes: string[];
+  description: string;
+};
+
+export type IOperationOutputDto = {
+  description: string;
+  dto: IDeclarator<any>;
+};
+
+export type IOperationOutputDtos = {
+  strategy: 'dto';
+  success: IOperationOutputDto;
+};
+
 export type IOperation = {
   name: string;
   description: string;
 
-  input?:
-    | {
-        strategy: 'file';
-      }
-    | {
-        strategy: 'dto';
-
-        body?: Record<string, IDeclarationProperty> | null;
-        query?: Record<string, IDeclarationProperty> | null;
-        params?: Record<string, IDeclarationProperty> | null;
-
-        combineInputs?: (inputs: { body: Record<string, unknown>; query: Record<string, unknown>; params?: unknown }) => unknown;
-      }
-    | null;
-
-  output:
-    | {
-        strategy: 'file';
-      }
-    | {
-        strategy: 'dto';
-        dto: IDeclarator<any>;
-      };
+  kind?: 'query' | 'mutation';
+
+  input?: IOperationInputFile | IOperationInputDto | null;
+  output: IOperationOutputFile | IOperationOutputDtos;
 };
+
+export type IOperator = () => IOperation;
diff --git a/javascript/sisgea-spec/src/sisgea/base/arquivo/arquivo.operations.ts b/javascript/sisgea-spec/src/sisgea/base/arquivo/arquivo.operations.ts
@@ -4,13 +4,14 @@ import { IOperation, PropertyTypes } from '@/helpers';
 export const ArquivoGetFileOperator = () => {
   return {
     name: 'ArquivoGetFile',
-
     description: 'Obtêm o conteúdo de um arquivo.',
 
     input: {
       strategy: 'dto',
       params: {
-        ...ObjectUuidDeclarationFactory().properties,
+        id: {
+          ...ObjectUuidDeclarationFactory().properties.id,
+        },
       },
       query: {
         ['acesso.recurso.nome']: {
@@ -30,6 +31,8 @@ export const ArquivoGetFileOperator = () => {
 
     output: {
       strategy: 'file',
+      description: 'Binário do arquivo consultado.',
+      mimeTypes: ['application/octet-stream'],
     },
   } satisfies IOperation;
 };