@vertesia/common 1.3.0 → 1.4.0-dev.20260615.042033Z

package/src/store/object-types.ts

@@ -1,127 +1,123 @@
-import type { JSONSchemaType } from "ajv"
+import type { JSONSchemaType } from 'ajv';
 
 /*Default JSON Schema type for rendition*/
 
 export interface RenditionProperties {
-    mime_type: string,
-    source_etag?: string,
-    height?: number,
-    width?: number,
-    multipart?: boolean,
-    total_parts?: number,
+    mime_type: string;
+    source_etag?: string;
+    height?: number;
+    width?: number;
+    multipart?: boolean;
+    total_parts?: number;
 }
 
 export const RenditionSchema: JSONSchemaType<RenditionProperties> = {
-
-    type: "object",
-    description: "Represent a rendition of a file stored in an object. It will be stored as a separate object in the database.",
+    type: 'object',
+    description:
+        'Represent a rendition of a file stored in an object. It will be stored as a separate object in the database.',
     properties: {
         mime_type: {
-            type: "string",
-            description: "The format of the rendition. This is a MIME type."
+            type: 'string',
+            description: 'The format of the rendition. This is a MIME type.',
         },
         source_etag: {
-            type: "string",
-            description: "The ETag of the file used for the rendition.",
-            nullable: true
+            type: 'string',
+            description: 'The ETag of the file used for the rendition.',
+            nullable: true,
         },
         height: {
-            type: "integer",
-            description: "The height of the rendition",
-            nullable: true
+            type: 'integer',
+            description: 'The height of the rendition',
+            nullable: true,
         },
         width: {
-            type: "integer",
-            description: "The width of the rendition",
-            nullable: true
+            type: 'integer',
+            description: 'The width of the rendition',
+            nullable: true,
         },
         multipart: {
-            type: "boolean",
-            description: "If the rendition is a multi-part rendition",
+            type: 'boolean',
+            description: 'If the rendition is a multi-part rendition',
             nullable: true,
-            default: false
+            default: false,
         },
         total_parts: {
-            type: "integer",
-            description: "The total number of parts in the rendition",
-            nullable: true
-        }
+            type: 'integer',
+            description: 'The total number of parts in the rendition',
+            nullable: true,
+        },
     },
-    required: ["mime_type"],
-}
-
-
+    required: ['mime_type'],
+};
 
 export interface DocumentPartProperties {
-
-    source_etag?: string,
-    part_number: number,
-    title?: string,
-    source_line_start?: number,
-    source_line_end?: number,
-    type?: 'text' | 'image' | 'table' | 'chart' | 'diagram' | 'code' | 'other',
-    page_number?: number,
-    description?: string,
-    height?: number,
-    width?: number,
-
+    source_etag?: string;
+    part_number: number;
+    title?: string;
+    source_line_start?: number;
+    source_line_end?: number;
+    type?: 'text' | 'image' | 'table' | 'chart' | 'diagram' | 'code' | 'other';
+    page_number?: number;
+    description?: string;
+    height?: number;
+    width?: number;
 }
 
-
 export const DocumentPartSchema: JSONSchemaType<DocumentPartProperties> = {
-    type: "object",
-    description: "Represent a semantic chunk of a document",
+    type: 'object',
+    description: 'Represent a semantic chunk of a document',
     properties: {
         source_etag: {
-            type: "string",
-            description: "The ETag of the file used for the rendition.",
-            nullable: true
+            type: 'string',
+            description: 'The ETag of the file used for the rendition.',
+            nullable: true,
         },
         part_number: {
-            type: "integer",
-            description: "The part number of the chunk",
+            type: 'integer',
+            description: 'The part number of the chunk',
         },
         title: {
-            type: "string",
-            description: "The title of the chunk",
-            nullable: true
+            type: 'string',
+            description: 'The title of the chunk',
+            nullable: true,
         },
         source_line_start: {
-            type: "integer",
-            description: "The line number where the chunk starts",
-            nullable: true
+            type: 'integer',
+            description: 'The line number where the chunk starts',
+            nullable: true,
         },
         source_line_end: {
-            type: "integer",
-            description: "The line number where the chunk ends",
-            nullable: true
+            type: 'integer',
+            description: 'The line number where the chunk ends',
+            nullable: true,
         },
         type: {
-            type: "string",
-            description: "The type of the chunk",
+            type: 'string',
+            description: 'The type of the chunk',
             enum: ['text', 'image', 'table', 'chart', 'diagram', 'code', 'other'],
-            nullable: true
+            nullable: true,
         },
         page_number: {
-            type: "integer",
-            description: "The page number of the document part",
-            nullable: true
+            type: 'integer',
+            description: 'The page number of the document part',
+            nullable: true,
         },
         description: {
-            type: "string",
-            description: "The description of the document part, if it's an image, the exhaustive description of the image",
-            nullable: true
+            type: 'string',
+            description:
+                "The description of the document part, if it's an image, the exhaustive description of the image",
+            nullable: true,
         },
         height: {
-            type: "integer",
-            description: "The height of the rendition",
-            nullable: true
+            type: 'integer',
+            description: 'The height of the rendition',
+            nullable: true,
         },
         width: {
-            type: "integer",
-            description: "The width of the rendition",
-            nullable: true
-        }
+            type: 'integer',
+            description: 'The width of the rendition',
+            nullable: true,
+        },
     },
-    required: ["part_number"],
-}
+    required: ['part_number'],
+};

package/src/store/process-schema.test.ts

@@ -0,0 +1,106 @@
+import Ajv from 'ajv';
+import { describe, expect, it } from 'vitest';
+import { PROCESS_DEFINITION_FORMAT_VERSION, type ProcessDefinitionBody } from './process.js';
+import { ProcessDefinitionBodyJsonSchema } from './process-schema.js';
+
+function validDefinition(): ProcessDefinitionBody {
+    return {
+        format_version: PROCESS_DEFINITION_FORMAT_VERSION,
+        process: 'invoice_review',
+        initial: 'fanout',
+        metadata: {
+            provenance: {
+                bpmn: {
+                    process_id: 'InvoiceReview',
+                },
+            },
+        },
+        context: {
+            schema: {
+                type: 'object',
+                additionalProperties: true,
+                properties: {
+                    invoices: { type: 'array' },
+                    results: { type: 'array' },
+                },
+            },
+            initial: {
+                invoices: [],
+            },
+        },
+        nodes: {
+            fanout: {
+                type: 'foreach',
+                foreach: 'invoices',
+                as: 'invoice',
+                item_id: '{{invoice.id}}',
+                max_concurrency: 10,
+                failure_policy: 'collect_errors',
+                collect: {
+                    into: 'results',
+                    include: ['status', 'index', 'item_id', 'output', 'child_run_id'],
+                },
+                metadata: {
+                    editor: {
+                        render: 'foreach',
+                    },
+                },
+                node: {
+                    type: 'process',
+                    process: 'invoice_child_review',
+                    run_type: 'programmatic',
+                    returns: {
+                        from: 'context.review',
+                    },
+                },
+                transitions: [{ to: 'done', metadata: { edge_kind: 'default' } }],
+            },
+            done: {
+                type: 'final',
+            },
+        },
+    };
+}
+
+describe('process definition JSON schema', () => {
+    it('accepts current process engine definition features', () => {
+        const validate = new Ajv.default({ allErrors: true, strict: false }).compile(ProcessDefinitionBodyJsonSchema);
+
+        expect(validate(validDefinition())).toBe(true);
+    });
+
+    it('rejects malformed process definition shape for editor diagnostics', () => {
+        const validate = new Ajv.default({ allErrors: true, strict: false }).compile(ProcessDefinitionBodyJsonSchema);
+        const invalidDefinition = {
+            format_version: PROCESS_DEFINITION_FORMAT_VERSION,
+            process: 'invoice_review',
+            initial: 'fanout',
+            context: {
+                schema: {
+                    type: 'object',
+                },
+                initial: {},
+            },
+            nodes: {
+                fanout: {
+                    type: 'foreach',
+                    collect: {
+                        into: 'results',
+                        include: ['bogus'],
+                    },
+                    node: {
+                        type: 'human_task',
+                    },
+                    transitions: [{ to: 'done', trigger: 'manual' }],
+                },
+                done: {
+                    type: 'final',
+                },
+            },
+        };
+
+        expect(validate(invalidDefinition)).toBe(false);
+        const messages = validate.errors?.map((error) => error.message ?? '') ?? [];
+        expect(messages).toContain('must be equal to one of the allowed values');
+    });
+});