@epistola.app/valtimo-plugin 0.6.0 → 0.7.0

package/lib/assets/epistola-logo.d.ts

@@ -1 +1 @@
-export declare const EPISTOLA_PLUGIN_LOGO_BASE64 = "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0iIzMzNjZjYyI+PHBhdGggZD0iTTE0IDJINmMtMS4xIDAtMiAuOS0yIDJ2MTZjMCAxLjEuOSAyIDIgMmgxMmMxLjEgMCAyLS45IDItMlY4bC02LTZ6bTQgMThINlY0aDd2NWg1djExeiIvPjxwYXRoIGQ9Ik04IDEyaDh2Mkg4em0wIDRoOHYtMkg4em0wLThWNmg0djJ6Ii8+PC9zdmc+";
+export declare const EPISTOLA_PLUGIN_LOGO_BASE64 = "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMjAgMTIwIiB3aWR0aD0iMTIwIiBoZWlnaHQ9IjEyMCI+CiAgPCEtLSBTdGFjayBiYXNlIC0tPgogIDxyZWN0IHg9IjM2IiB5PSIxNiIgd2lkdGg9IjU0IiBoZWlnaHQ9IjcwIiByeD0iMyIgZmlsbD0iI2U2YzJiMCIgc3Ryb2tlPSIjNGYyZjJiIiBzdHJva2Utd2lkdGg9IjIiIHRyYW5zZm9ybT0icm90YXRlKDUgNjMgNTEpIi8+CiAgPHJlY3QgeD0iMzIiIHk9IjIyIiB3aWR0aD0iNTQiIGhlaWdodD0iNzAiIHJ4PSIzIiBmaWxsPSIjZjBkOGM4IiBzdHJva2U9IiM0ZjJmMmIiIHN0cm9rZS13aWR0aD0iMiIvPgogIDxyZWN0IHg9IjI4IiB5PSIyOCIgd2lkdGg9IjU0IiBoZWlnaHQ9IjcwIiByeD0iMyIgZmlsbD0iI2Y1ZWJlMyIgc3Ryb2tlPSIjNGYyZjJiIiBzdHJva2Utd2lkdGg9IjIuNSIvPgogIDxsaW5lIHgxPSIzOCIgeTE9IjQ0IiB4Mj0iNzIiIHkyPSI0NCIgc3Ryb2tlPSIjYzRhODgyIiBzdHJva2Utd2lkdGg9IjIiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgogIDxsaW5lIHgxPSIzOCIgeTE9IjU0IiB4Mj0iNzIiIHkyPSI1NCIgc3Ryb2tlPSIjYzRhODgyIiBzdHJva2Utd2lkdGg9IjIiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgogIDxsaW5lIHgxPSIzOCIgeTE9IjY0IiB4Mj0iNTgiIHkyPSI2NCIgc3Ryb2tlPSIjYzRhODgyIiBzdHJva2Utd2lkdGg9IjIiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgogIDwhLS0gV2F4IHNlYWwgd2l0aCBjaGVja21hcmsgLS0+CiAgPGNpcmNsZSBjeD0iNTUiIGN5PSI4NCIgcj0iMTUiIGZpbGw9IiNiODVjM2MiIHN0cm9rZT0iIzRmMmYyYiIgc3Ryb2tlLXdpZHRoPSIyIi8+CiAgPGNpcmNsZSBjeD0iNTUiIGN5PSI4NCIgcj0iMTAuNSIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZDQ4MzZhIiBzdHJva2Utd2lkdGg9IjEiLz4KICA8cG9seWxpbmUgcG9pbnRzPSI0OSw4NCA1Myw4OSA2Miw3OCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjNGYyZjJiIiBzdHJva2Utd2lkdGg9IjIuNSIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIi8+Cjwvc3ZnPgo=";

package/lib/components/epistola-document-preview/epistola-document-preview.component.d.ts

@@ -6,36 +6,59 @@ import { ConfigService } from '@valtimo/shared';
 import { PreviewSource } from '../../models';
 import { EpistolaPluginService } from '../../services';
 import * as i0 from "@angular/core";
-export declare class EpistolaDocumentPreviewComponent implements FormioCustomComponent<null>, OnChanges, OnDestroy {
+export declare class EpistolaDocumentPreviewComponent implements FormioCustomComponent<Record<string, any> | null>, OnChanges, OnDestroy {
     private readonly epistolaPluginService;
     private readonly http;
     private readonly sanitizer;
     private readonly configService;
     private readonly formIoStateService;
     private readonly cdr;
-    value: null;
-    valueChange: EventEmitter<null>;
+    value: Record<string, any> | null;
+    valueChange: EventEmitter<Record<string, any>>;
     disabled: boolean;
     label: string;
+    processDefinitionKey?: string;
+    sourceActivityId?: string;
+    overrideMapping?: Record<string, any>;
     sources: PreviewSource[];
     selectedIndex: number;
     discovering: boolean;
     loading: boolean;
     error: string | null;
     previewUrl: SafeResourceUrl | null;
+    designMode: boolean;
     private initialized;
     private currentBlobUrl;
     private discoverSubscription?;
     private previewSubscription?;
     private readonly apiEndpoint;
+    /** Whether the component is in configured mode (explicit process link) vs auto-discover mode */
+    private get configuredMode();
     constructor(epistolaPluginService: EpistolaPluginService, http: HttpClient, sanitizer: DomSanitizer, configService: ConfigService, formIoStateService: FormIoStateService, cdr: ChangeDetectorRef);
+    get overrideMappingScopes(): string[];
+    overrideMappingEntries(scope: string): {
+        path: string;
+        field: string;
+    }[];
     ngOnChanges(changes: SimpleChanges): void;
     ngOnDestroy(): void;
     onSourceChange(event: Event): void;
     refresh(): void;
+    /**
+     * Configured mode: preview using the explicitly configured process link + input overrides.
+     */
+    private loadConfiguredPreview;
+    /**
+     * Auto-discover mode: discover sources from running process instances.
+     */
     private discoverSources;
-    private loadPreview;
+    /**
+     * Auto-discover mode: load preview for the selected discovered source.
+     */
+    private loadDiscoveredPreview;
+    private handlePreviewSuccess;
+    private handlePreviewError;
     private revokeBlobUrl;
     static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaDocumentPreviewComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<EpistolaDocumentPreviewComponent, "epistola-document-preview-component", never, { "value": { "alias": "value"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "label": { "alias": "label"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EpistolaDocumentPreviewComponent, "epistola-document-preview-component", never, { "value": { "alias": "value"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "label": { "alias": "label"; "required": false; }; "processDefinitionKey": { "alias": "processDefinitionKey"; "required": false; }; "sourceActivityId": { "alias": "sourceActivityId"; "required": false; }; "overrideMapping": { "alias": "overrideMapping"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
 }

package/lib/components/epistola-document-preview/preview-utils.d.ts

@@ -0,0 +1,18 @@
+import { OverrideMapping } from '../override-builder/override-builder.component';
+export declare const FORM_REF_PREFIX = "form:";
+/**
+ * Detect if a string value is a JSONata expression (vs a plain literal).
+ * Checks for characters that indicate JSONata operators: $, &, (, {, ?, [
+ */
+export declare function isExpression(value: string): boolean;
+/**
+ * Expand dot-notation keys into nested objects.
+ * e.g. { "beslissing.tekst": "value" } -> { beslissing: { tekst: "value" } }
+ */
+export declare function expandDotNotation(flat: Record<string, any>): Record<string, any>;
+/**
+ * Given an override mapping (scope -> { inputPath -> "form:<componentKey>" })
+ * and form data, produce the inputOverrides object for the backend.
+ * The "form:" prefix identifies form field references; the remainder is the Formio component key.
+ */
+export declare function computeInputOverrides(mapping: OverrideMapping, formData: Record<string, any>): Record<string, any>;

package/lib/components/generate-document-configuration/generate-document-configuration.component.d.ts

@@ -4,7 +4,7 @@ import { FormOutput, SelectItem } from '@valtimo/components';
 import { CaseManagementParams, ManagementContext } from '@valtimo/shared';
 import { ProcessLinkStateService } from '@valtimo/process-link';
 import { BehaviorSubject, Observable } from 'rxjs';
-import { AsyncResource, ExpressionFunctionInfo, GenerateDocumentConfig, TemplateField, VariableSuggestions } from '../../models';
+import { AsyncResource, ExpressionFunctionInfo, GenerateDocumentConfig, JsonataFieldError, TemplateField, VariableSuggestions } from '../../models';
 import { EpistolaPluginService } from '../../services';
 import * as i0 from "@angular/core";
 export type VariantSelectionMode = 'explicit' | 'attributes';
@@ -35,11 +35,16 @@ export declare class GenerateDocumentConfigurationComponent implements FunctionC
     readonly selectedTemplateId$: BehaviorSubject<string>;
     readonly selectedVariantId$: BehaviorSubject<string>;
     variantSelectionMode: VariantSelectionMode;
+    variantIdExpressionMode: boolean;
+    variantIdExpression: string;
+    filenameExpressionMode: boolean;
+    filenameExpression: string;
     variantAttributeEntries: {
         key: string;
         value: string;
         required: boolean;
         _customKey?: boolean;
+        _expressionMode?: boolean;
     }[];
     availableAttributeKeys: string[];
     caseDefinitionKey: string | null;
@@ -51,6 +56,7 @@ export declare class GenerateDocumentConfigurationComponent implements FunctionC
         total: number;
     };
     prefillDataMapping: Record<string, any>;
+    validationErrors$: BehaviorSubject<JsonataFieldError[]>;
     private readonly destroy$;
     private saveSubscription;
     private readonly formValue$;
@@ -71,6 +77,8 @@ export declare class GenerateDocumentConfigurationComponent implements FunctionC
     addAttributeEntry(): void;
     removeAttributeEntry(index: number): void;
     onAttributeEntryChange(): void;
+    onVariantIdExpressionChange(): void;
+    onFilenameExpressionChange(): void;
     onKeySelected(entry: {
         key: string;
         value: string;
@@ -109,6 +117,17 @@ export declare class GenerateDocumentConfigurationComponent implements FunctionC
     private loadVariableSuggestions;
     private handleValid;
     private openSaveSubscription;
+    /**
+     * Build a JSONata validation request from the config and call the backend.
+     * Only fields that are JSONata expressions get validated:
+     * - dataMapping is always JSONata
+     * - filename / variantId only when their `fx` toggle is on
+     * - variant attribute values only when isExpression() reports true
+     * On invalid response, surface errors and abort the emit.
+     * If the validator endpoint itself fails (network/server), proceed with the
+     * emit — the validation is a quality-of-life check, not a hard gate.
+     */
+    private validateAndEmit;
     static ɵfac: i0.ɵɵFactoryDeclaration<GenerateDocumentConfigurationComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<GenerateDocumentConfigurationComponent, "epistola-generate-document-configuration", never, { "save$": { "alias": "save$"; "required": false; }; "disabled$": { "alias": "disabled$"; "required": false; }; "pluginId": { "alias": "pluginId"; "required": false; }; "prefillConfiguration$": { "alias": "prefillConfiguration$"; "required": false; }; "selectedPluginConfigurationData$": { "alias": "selectedPluginConfigurationData$"; "required": false; }; "context$": { "alias": "context$"; "required": false; }; }, { "valid": "valid"; "configuration": "configuration"; }, never, never, true, never>;
 }

package/lib/components/override-builder/override-builder.component.d.ts

@@ -0,0 +1,42 @@
+import { ChangeDetectorRef, EventEmitter } from '@angular/core';
+import { FormioCustomComponent } from '@valtimo/components';
+import * as i0 from "@angular/core";
+interface OverrideRow {
+    scope: 'doc' | 'pv';
+    inputPath: string;
+    formFieldKey: string;
+}
+export interface FormFieldOption {
+    key: string;
+    label: string;
+}
+/**
+ * Override mapping format: scope → { inputPath → "form:<componentKey>" }
+ * The "form:" prefix identifies this as a reference to a Formio component.
+ */
+export type OverrideMapping = Record<string, Record<string, string>>;
+export declare class EpistolaOverrideBuilderComponent implements FormioCustomComponent<OverrideMapping | null> {
+    private readonly cdr;
+    value: OverrideMapping | null;
+    valueChange: EventEmitter<OverrideMapping>;
+    disabled: boolean;
+    label: string;
+    availableFields: FormFieldOption[];
+    rows: OverrideRow[];
+    advancedMode: boolean;
+    jsonText: string;
+    jsonError: string | null;
+    private initialized;
+    constructor(cdr: ChangeDetectorRef);
+    ngOnChanges(): void;
+    toggleMode(): void;
+    addRow(): void;
+    removeRow(index: number): void;
+    emitChange(): void;
+    onJsonChange(text: string): void;
+    private rowsToMapping;
+    private mappingToRows;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaOverrideBuilderComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EpistolaOverrideBuilderComponent, "epistola-override-builder-component", never, { "value": { "alias": "value"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "label": { "alias": "label"; "required": false; }; "availableFields": { "alias": "availableFields"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
+}
+export {};

package/lib/components/override-builder/override-builder.formio.d.ts

@@ -0,0 +1,4 @@
+import { Injector } from '@angular/core';
+import { FormioCustomComponentInfo } from '@valtimo/components';
+export declare const EPISTOLA_OVERRIDE_BUILDER_OPTIONS: FormioCustomComponentInfo;
+export declare function registerEpistolaOverrideBuilderComponent(injector: Injector): void;

package/lib/components/process-link-selector/process-link-selector.component.d.ts

@@ -0,0 +1,31 @@
+import { ChangeDetectorRef, EventEmitter, OnChanges, OnDestroy, SimpleChanges } from '@angular/core';
+import { FormioCustomComponent } from '@valtimo/components';
+import { EpistolaAdminService } from '../../services';
+import { PluginUsageEntry } from '../../models';
+import * as i0 from "@angular/core";
+export interface ProcessLinkSelection {
+    processDefinitionKey: string;
+    sourceActivityId: string;
+}
+export declare class EpistolaProcessLinkSelectorComponent implements FormioCustomComponent<ProcessLinkSelection | null>, OnChanges, OnDestroy {
+    private readonly adminService;
+    private readonly cdr;
+    value: ProcessLinkSelection | null;
+    valueChange: EventEmitter<ProcessLinkSelection>;
+    disabled: boolean;
+    label: string;
+    filteredEntries: PluginUsageEntry[];
+    selectedKey: string;
+    loading: boolean;
+    error: string | null;
+    private initialized;
+    private loadSubscription?;
+    constructor(adminService: EpistolaAdminService, cdr: ChangeDetectorRef);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+    onSelect(key: string): void;
+    entryKey(entry: PluginUsageEntry): string;
+    private loadEntries;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaProcessLinkSelectorComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EpistolaProcessLinkSelectorComponent, "epistola-process-link-selector-component", never, { "value": { "alias": "value"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "label": { "alias": "label"; "required": false; }; }, { "valueChange": "valueChange"; }, never, never, true, never>;
+}

package/lib/components/process-link-selector/process-link-selector.formio.d.ts

@@ -0,0 +1,4 @@
+import { Injector } from '@angular/core';
+import { FormioCustomComponentInfo } from '@valtimo/components';
+export declare const EPISTOLA_PROCESS_LINK_SELECTOR_OPTIONS: FormioCustomComponentInfo;
+export declare function registerEpistolaProcessLinkSelectorComponent(injector: Injector): void;

package/lib/epistola-enabled.guard.d.ts

@@ -0,0 +1,2 @@
+import { CanActivateFn } from '@angular/router';
+export declare const epistolaEnabledGuard: CanActivateFn;

package/lib/epistola-runtime-config.d.ts

@@ -0,0 +1,28 @@
+export interface EpistolaRuntimeEnv {
+    epistolaEnabled?: boolean | string;
+}
+interface EpistolaRuntimeWindow {
+    env?: EpistolaRuntimeEnv;
+}
+declare global {
+    interface Window extends EpistolaRuntimeWindow {
+    }
+}
+/**
+ * Reads the runtime feature flag that decides whether the Epistola plugin
+ * surfaces (admin menu, /epistola route, plugin specification, Formio
+ * components) should activate in the host Valtimo app.
+ *
+ * The flag is sourced from `window['env']['epistolaEnabled']`, populated at
+ * container start by `envsubst` against `assets/config.template.js` (the
+ * standard Valtimo runtime-config pattern). Defaults to enabled — only the
+ * literal `false` or string `'false'` disables the plugin, matching the
+ * backend's `epistola.enabled` `matchIfMissing = true` semantics.
+ *
+ * Exposed as a runtime helper rather than evaluated directly in `@NgModule`
+ * decorator metadata because Angular's AOT compiler cannot statically resolve
+ * `window` accesses (NG1010). Read from runtime code such as specification
+ * property getters, route guards, or the environment initializer instead.
+ */
+export declare function isEpistolaEnabled(): boolean;
+export {};

package/lib/models/config.d.ts

@@ -26,7 +26,7 @@ export interface VariantAttributeEntry {
  *
  * Variant selection supports two modes:
  * - Explicit: set variantId directly
- * - By attributes: set variantAttributes with key-value pairs (values can be value resolver expressions)
+ * - By attributes: set variantAttributes with key-value pairs (values can be JSONata expressions)
  */
 export interface GenerateDocumentConfig {
     catalogId: string;
@@ -77,3 +77,22 @@ export interface EvaluationResult {
     result: Record<string, any> | null;
     error: string | null;
 }
+/**
+ * Request body for the JSONata save-time validation endpoint.
+ * All fields are optional; null/blank values are skipped.
+ */
+export interface ValidateJsonataRequest {
+    dataMapping?: string | null;
+    filename?: string | null;
+    variantId?: string | null;
+    variantAttributeValues?: Record<string, string> | null;
+}
+export interface JsonataFieldError {
+    field: string;
+    expression: string;
+    message: string;
+}
+export interface JsonataValidationResult {
+    valid: boolean;
+    errors: JsonataFieldError[];
+}

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, ExpressionFunctionInfo, PreviewSource, TemplateDetails, TemplateInfo, EvaluationResult, VariableSuggestions, 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.
@@ -57,6 +57,11 @@ export declare class EpistolaPluginService {
      * 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epistola.app/valtimo-plugin",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Epistola document generation plugin for Valtimo",
   "license": "EUPL-1.2",
   "repository": {
@@ -31,6 +31,8 @@
     "@valtimo/plugin": "^13.21.0",
     "@valtimo/process-link": "^13.21.0",
     "@valtimo/security": "^13.21.0",
-    "@valtimo/shared": "^13.21.0"
+    "@valtimo/shared": "^13.21.0",
+    "jsonata": "^2.1.0",
+    "monaco-editor": ">=0.40.0"
   }
 }

package/public_api.d.ts

@@ -2,6 +2,7 @@ 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';
@@ -18,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';