@epistola.app/valtimo-plugin 0.5.2 → 0.7.0

package/lib/models/expression.d.ts

@@ -0,0 +1,13 @@
+export interface ExpressionFunctionInfo {
+    name: string;
+    description: string;
+    overloads: OverloadInfo[];
+}
+export interface OverloadInfo {
+    arguments: ArgumentInfo[];
+    returnType: string;
+}
+export interface ArgumentInfo {
+    name: string;
+    type: string;
+}

package/lib/models/index.d.ts

@@ -1,3 +1,5 @@
+export * from './admin';
 export * from './async-resource';
 export * from './config';
+export * from './expression';
 export * from './template';

package/lib/models/template.d.ts

@@ -41,12 +41,6 @@ export interface DataMappingEntry {
  */
 export type DataSourceType = 'document' | 'processVariable' | 'manual';
 /**
- * Validation result from the backend.
- */
-export interface ValidationResult {
-    valid: boolean;
-    missingRequiredFields: string[];
-}
 /**
  * Information about an Epistola environment.
  */

package/lib/services/epistola-admin.service.d.ts

@@ -0,0 +1,37 @@
+import { HttpClient } from '@angular/common/http';
+import { ConfigService } from '@valtimo/shared';
+import { Observable } from 'rxjs';
+import { ConnectionStatus, PendingJob, PluginUsageEntry, VersionInfo } from '../models';
+import * as i0 from "@angular/core";
+/**
+ * Service for Epistola plugin administrative operations.
+ * Provides health checks, version info, and usage overview.
+ */
+export declare class EpistolaAdminService {
+    private readonly http;
+    private readonly configService;
+    private readonly apiEndpoint;
+    constructor(http: HttpClient, configService: ConfigService);
+    /**
+     * Check connectivity to Epistola for all plugin configurations.
+     */
+    getConnectionStatus(): Observable<ConnectionStatus[]>;
+    /**
+     * Get version information for the plugin and connected Epistola server.
+     */
+    getVersions(): Observable<VersionInfo>;
+    /**
+     * Get an overview of all Epistola plugin usages across process definitions.
+     */
+    getPluginUsage(): Observable<PluginUsageEntry[]>;
+    /**
+     * Get all process instances currently waiting for an Epistola document generation result.
+     */
+    getPendingJobs(): Observable<PendingJob[]>;
+    /**
+     * Export a single process link as a .process-link.json file.
+     */
+    exportProcessLink(processLinkId: string): Observable<Blob>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaAdminService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EpistolaAdminService>;
+}

package/lib/services/epistola-menu.service.d.ts

@@ -0,0 +1,13 @@
+import { MenuService } from '@valtimo/components';
+import * as i0 from "@angular/core";
+/**
+ * Registers the Epistola admin page menu item under the Admin > Other section.
+ * Instantiated eagerly via ENVIRONMENT_INITIALIZER so the menu item
+ * appears without any manual configuration in the host application.
+ */
+export declare class EpistolaMenuService {
+    private readonly menuService;
+    constructor(menuService: MenuService);
+    static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaMenuService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EpistolaMenuService>;
+}

package/lib/services/epistola-plugin.service.d.ts

@@ -1,7 +1,7 @@
 import { HttpClient } from '@angular/common/http';
 import { ConfigService } from '@valtimo/shared';
 import { Observable } from 'rxjs';
-import { AttributeDefinition, CatalogInfo, EnvironmentInfo, PreviewSource, TemplateDetails, TemplateInfo, ValidationResult, VariantInfo } from '../models';
+import { AttributeDefinition, CatalogInfo, EnvironmentInfo, ExpressionFunctionInfo, JsonataValidationResult, PreviewSource, TemplateDetails, TemplateInfo, EvaluationResult, ValidateJsonataRequest, VariableSuggestions, VariantInfo } from '../models';
 import * as i0 from "@angular/core";
 /**
  * Service for interacting with Epistola plugin API endpoints.
@@ -42,13 +42,26 @@ export declare class EpistolaPluginService {
      */
     getProcessVariables(processDefinitionKey: string): Observable<string[]>;
     /**
-     * Validate that a data mapping covers all required template fields.
+     * Get variable suggestions for JSONata autocompletion.
      */
-    validateMapping(pluginConfigurationId: string, templateId: string, dataMapping: Record<string, any>): Observable<ValidationResult>;
+    getVariableSuggestions(caseDefinitionKey?: string, processDefinitionKey?: string): Observable<VariableSuggestions>;
+    /**
+     * Evaluate a JSONata expression against a real document.
+     */
+    evaluateMapping(expression: string, documentId: string, processInstanceId?: string): Observable<EvaluationResult>;
     /**
      * Get a dynamically generated Formio form for retrying a failed document generation.
      */
     getRetryForm(processInstanceId: string, documentId?: string, sourceActivityId?: string): Observable<any>;
+    /**
+     * List all available expression functions for expr: data mapping values.
+     */
+    getExpressionFunctions(): Observable<ExpressionFunctionInfo[]>;
+    /**
+     * Validate the JSONata syntax of action-config expressions before save.
+     * Parse-only; runtime errors (missing variables, type mismatches) are not detected.
+     */
+    validateJsonata(request: ValidateJsonataRequest): Observable<JsonataValidationResult>;
     /**
      * Discover all previewable document sources for a given Valtimo document.
      */

package/lib/services/index.d.ts

@@ -1 +1,3 @@
+export * from './epistola-admin.service';
+export * from './epistola-menu.service';
 export * from './epistola-plugin.service';

package/lib/utils/jsonata-converter.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Represents a field in the visual builder.
+ * - mode 'ref': a simple $doc/$pv/$case path reference
+ * - mode 'raw': raw JSONata text the builder can't represent visually
+ */
+export interface BuilderField {
+    name: string;
+    mode: 'ref' | 'raw';
+    value: string;
+    children?: BuilderField[];
+}
+/**
+ * Parse a JSONata expression into BuilderField array.
+ * Only supports top-level object literals with simple path references or nested objects.
+ * Anything else is stored as raw JSONata text.
+ */
+export declare function parseJsonataToBuilder(expression: string): BuilderField[];
+/**
+ * Convert BuilderField array back to a JSONata expression string.
+ */
+export declare function builderToJsonata(fields: BuilderField[]): string;
+/**
+ * Check if a JSONata expression can be fully represented by the builder
+ * (i.e., all fields are simple refs or nested objects of simple refs).
+ */
+export declare function isBuilderCompatible(expression: string): boolean;

package/lib/utils/jsonata-monaco.d.ts

@@ -0,0 +1,14 @@
+import { ExpressionFunctionInfo, VariableSuggestions } from '../models';
+/**
+ * Shared state for the JSONata completion provider.
+ * Updated by the editor component when suggestions/functions change.
+ */
+export declare const jsonataCompletionData: {
+    suggestions: VariableSuggestions | null;
+    functions: ExpressionFunctionInfo[];
+};
+/**
+ * Register the JSONata language in Monaco editor.
+ * Call this once when Monaco is available (e.g., in editor component OnInit).
+ */
+export declare function registerJsonataLanguage(monaco: any): void;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@epistola.app/valtimo-plugin",
-  "version": "0.5.2",
+  "version": "0.7.0",
   "description": "Epistola document generation plugin for Valtimo",
   "license": "EUPL-1.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/epistola-app/valtimo-epistola-plugin"
   },
+  "sideEffects": false,
   "module": "fesm2022/epistola.app-valtimo-plugin.mjs",
   "typings": "index.d.ts",
   "exports": {
@@ -18,17 +19,20 @@
       "default": "./fesm2022/epistola.app-valtimo-plugin.mjs"
     }
   },
-  "sideEffects": false,
+  "dependencies": {
+    "tslib": "^2.6.0"
+  },
   "peerDependencies": {
     "@angular/common": ">=17.0.0",
     "@angular/core": ">=17.0.0",
     "@angular/forms": ">=17.0.0",
+    "@angular/router": ">=17.0.0",
     "@valtimo/components": "^13.21.0",
     "@valtimo/plugin": "^13.21.0",
     "@valtimo/process-link": "^13.21.0",
-    "@valtimo/shared": "^13.21.0"
-  },
-  "dependencies": {
-    "tslib": "^2.6.0"
+    "@valtimo/security": "^13.21.0",
+    "@valtimo/shared": "^13.21.0",
+    "jsonata": "^2.1.0",
+    "monaco-editor": ">=0.40.0"
   }
 }

package/public_api.d.ts

@@ -2,15 +2,15 @@ export * from './lib/models';
 export * from './lib/services';
 export * from './lib/epistola.module';
 export * from './lib/epistola.specification';
+export * from './lib/epistola-runtime-config';
+export * from './lib/epistola-admin-routing.module';
+export * from './lib/components/epistola-admin-page/epistola-admin-page.component';
 export * from './lib/components/epistola-configuration/epistola-configuration.component';
 export * from './lib/components/generate-document-configuration/generate-document-configuration.component';
 export * from './lib/components/check-job-status-configuration/check-job-status-configuration.component';
 export * from './lib/components/download-document-configuration/download-document-configuration.component';
-export * from './lib/components/value-input/value-input.component';
-export * from './lib/components/scalar-field/scalar-field.component';
-export * from './lib/components/array-field/array-field.component';
-export * from './lib/components/field-tree/field-tree.component';
-export * from './lib/components/data-mapping-tree/data-mapping-tree.component';
+export * from './lib/components/jsonata-editor/jsonata-editor.component';
+export * from './lib/components/mapping-builder/mapping-builder.component';
 export * from './lib/components/epistola-download/epistola-download.component';
 export * from './lib/components/epistola-download/epistola-download.formio';
 export * from './lib/components/epistola-retry-form/epistola-retry-form.component';
@@ -19,3 +19,7 @@ export * from './lib/components/epistola-preview-button/epistola-preview-button.
 export * from './lib/components/epistola-preview-button/epistola-preview-button.formio';
 export * from './lib/components/epistola-document-preview/epistola-document-preview.component';
 export * from './lib/components/epistola-document-preview/epistola-document-preview.formio';
+export * from './lib/components/override-builder/override-builder.component';
+export * from './lib/components/override-builder/override-builder.formio';
+export * from './lib/components/process-link-selector/process-link-selector.component';
+export * from './lib/components/process-link-selector/process-link-selector.formio';

package/lib/components/array-field/array-field.component.d.ts

@@ -1,27 +0,0 @@
-import { EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
-import { TemplateField } from '../../models';
-import * as i0 from "@angular/core";
-export declare class ArrayFieldComponent implements OnChanges {
-    field: TemplateField;
-    value: any;
-    pluginId: string;
-    caseDefinitionKey: string | null;
-    processVariables: string[];
-    disabled: boolean;
-    valueChange: EventEmitter<any>;
-    expanded: boolean;
-    arrayPerFieldMode: boolean;
-    mappedCount: number;
-    totalRequired: number;
-    ngOnChanges(changes: SimpleChanges): void;
-    toggleExpanded(): void;
-    getSourceValue(): string;
-    onSourceValueChange(newValue: string): void;
-    toggleArrayPerFieldMode(): void;
-    onItemFieldChange(childName: string, sourceFieldName: string): void;
-    getItemFieldValue(childName: string): string;
-    hasArrayChildren(): boolean;
-    private updateCompleteness;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ArrayFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ArrayFieldComponent, "epistola-array-field", never, { "field": { "alias": "field"; "required": false; }; "value": { "alias": "value"; "required": false; }; "pluginId": { "alias": "pluginId"; "required": false; }; "caseDefinitionKey": { "alias": "caseDefinitionKey"; "required": false; }; "processVariables": { "alias": "processVariables"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
-}

package/lib/components/data-mapping-tree/data-mapping-tree.component.d.ts

@@ -1,27 +0,0 @@
-import { EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
-import { TemplateField } from '../../models';
-import * as i0 from "@angular/core";
-/**
- * Top-level wrapper that hosts FieldTreeComponent instances for each top-level template field.
- * Manages the full nested mapping object, completeness tracking, and emits mapping changes.
- */
-export declare class DataMappingTreeComponent implements OnChanges {
-    pluginId: string;
-    templateFields: TemplateField[];
-    prefillMapping: Record<string, any>;
-    disabled: boolean;
-    caseDefinitionKey: string | null;
-    processVariables: string[];
-    mappingChange: EventEmitter<Record<string, any>>;
-    requiredFieldsStatus: EventEmitter<{
-        mapped: number;
-        total: number;
-    }>;
-    mapping: Record<string, any>;
-    ngOnChanges(changes: SimpleChanges): void;
-    onFieldValueChange(fieldName: string, value: any): void;
-    getFieldValue(fieldName: string): any;
-    private emitRequiredFieldsStatus;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DataMappingTreeComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DataMappingTreeComponent, "epistola-data-mapping-tree", never, { "pluginId": { "alias": "pluginId"; "required": false; }; "templateFields": { "alias": "templateFields"; "required": false; }; "prefillMapping": { "alias": "prefillMapping"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "caseDefinitionKey": { "alias": "caseDefinitionKey"; "required": false; }; "processVariables": { "alias": "processVariables"; "required": false; }; }, { "mappingChange": "mappingChange"; "requiredFieldsStatus": "requiredFieldsStatus"; }, never, never, true, never>;
-}

package/lib/components/field-tree/field-tree.component.d.ts

@@ -1,27 +0,0 @@
-import { EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
-import { TemplateField } from '../../models';
-import * as i0 from "@angular/core";
-/**
- * Recursive field tree component.
- * Dispatches SCALAR and ARRAY to dedicated sub-components.
- * Handles OBJECT inline to avoid circular import issues (OBJECT children recurse back to this component).
- * Uses forwardRef(() => FieldTreeComponent) in imports to allow self-referencing in the template.
- */
-export declare class FieldTreeComponent implements OnChanges {
-    field: TemplateField;
-    value: any;
-    pluginId: string;
-    caseDefinitionKey: string | null;
-    processVariables: string[];
-    disabled: boolean;
-    valueChange: EventEmitter<any>;
-    expanded: boolean;
-    mappedCount: number;
-    totalRequired: number;
-    ngOnChanges(changes: SimpleChanges): void;
-    toggleExpanded(): void;
-    onChildChange(childName: string, childValue: any): void;
-    getChildValue(childName: string): any;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FieldTreeComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FieldTreeComponent, "epistola-field-tree", never, { "field": { "alias": "field"; "required": false; }; "value": { "alias": "value"; "required": false; }; "pluginId": { "alias": "pluginId"; "required": false; }; "caseDefinitionKey": { "alias": "caseDefinitionKey"; "required": false; }; "processVariables": { "alias": "processVariables"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
-}

package/lib/components/scalar-field/scalar-field.component.d.ts

@@ -1,16 +0,0 @@
-import { EventEmitter } from '@angular/core';
-import { TemplateField } from '../../models';
-import * as i0 from "@angular/core";
-export declare class ScalarFieldComponent {
-    field: TemplateField;
-    value: any;
-    pluginId: string;
-    caseDefinitionKey: string | null;
-    processVariables: string[];
-    disabled: boolean;
-    valueChange: EventEmitter<any>;
-    get stringValue(): string;
-    onValueChange(newValue: string): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScalarFieldComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ScalarFieldComponent, "epistola-scalar-field", never, { "field": { "alias": "field"; "required": false; }; "value": { "alias": "value"; "required": false; }; "pluginId": { "alias": "pluginId"; "required": false; }; "caseDefinitionKey": { "alias": "caseDefinitionKey"; "required": false; }; "processVariables": { "alias": "processVariables"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
-}

package/lib/components/value-input/value-input.component.d.ts

@@ -1,34 +0,0 @@
-import { ChangeDetectorRef, EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
-import { ValuePathSelectorPrefix } from '@valtimo/components';
-import * as i0 from "@angular/core";
-export type InputMode = 'browse' | 'pv' | 'expression';
-/**
- * Reusable 3-mode input (browse / pv / expression) for value resolver expressions.
- * Used by both ScalarFieldComponent and ArrayFieldComponent for source mapping.
- */
-export declare class ValueInputComponent implements OnChanges {
-    private readonly cdr;
-    name: string;
-    value: string;
-    pluginId: string;
-    caseDefinitionKey: string | null;
-    processVariables: string[];
-    disabled: boolean;
-    placeholder: string;
-    valueChange: EventEmitter<string>;
-    readonly ValuePathSelectorPrefix: typeof ValuePathSelectorPrefix;
-    inputMode: InputMode;
-    selectedPv: string;
-    browseDefault: string;
-    constructor(cdr: ChangeDetectorRef);
-    ngOnChanges(changes: SimpleChanges): void;
-    setInputMode(mode: InputMode): void;
-    onBrowseValueChange(newValue: string): void;
-    onPvChange(newValue: string): void;
-    onExpressionValueChange(newValue: string): void;
-    private detectInputMode;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ValueInputComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ValueInputComponent, "epistola-value-input", never, { "name": { "alias": "name"; "required": false; }; "value": { "alias": "value"; "required": false; }; "pluginId": { "alias": "pluginId"; "required": false; }; "caseDefinitionKey": { "alias": "caseDefinitionKey"; "required": false; }; "processVariables": { "alias": "processVariables"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
-}
-/** Convert slash-notation paths (e.g. doc:/a/b) to dot notation (doc:a.b). */
-export declare function normalizeToDots(value: string): string;

package/lib/utils/template-field-utils.d.ts

@@ -1,6 +0,0 @@
-import { TemplateField } from '../models';
-export interface RequiredFieldsStatus {
-    mapped: number;
-    total: number;
-}
-export declare function countRequiredMapped(fields: TemplateField[], mapping: Record<string, any>): RequiredFieldsStatus;