@epistola.app/valtimo-plugin 0.13.1 → 0.15.0

package/lib/components/epistola-admin-page/epistola-admin-page.component.d.ts

@@ -1,7 +1,7 @@
 import { OnInit } from '@angular/core';
 import { ActivatedRoute, Router } from '@angular/router';
 import { EpistolaAdminService } from '../../services/epistola-admin.service';
-import { BpmnValidationReport, BpmnValidationViolation, ChangelogRelease, ClasspathCatalog, FormCarrierIssue, LegacyOverrideForm, PendingJob, PluginUsageEntry } from '../../models';
+import { BpmnValidationReport, BpmnValidationViolation, ChangelogRelease, ClasspathCatalog, ContractCompatibilitySeverity, LegacyOverrideForm, PendingJob, PluginUsageEntry, VersionCheckStatus } from '../../models';
 import * as i0 from "@angular/core";
 /**
  * Combined view model for a single plugin configuration card.
@@ -14,6 +14,9 @@ interface ConfigurationCard {
     latencyMs: number;
     errorMessage?: string;
     serverVersion?: string;
+    contractVersion?: string;
+    serverContractVersion?: string;
+    contractCompatibilitySeverity?: ContractCompatibilitySeverity;
     usageCount: number;
     problemCount: number;
     usageEntries: PluginUsageEntry[];
@@ -29,6 +32,8 @@ export declare class EpistolaAdminPageComponent implements OnInit {
     overviewTab: 'configurations' | 'validations' | 'changelog' | 'forms';
     loading: boolean;
     pluginVersion: string | null;
+    pluginContractVersion: string | null;
+    versionCheck: VersionCheckStatus | null;
     changelog: ChangelogRelease[] | null;
     changelogLoading: boolean;
     validationReport: BpmnValidationReport | null;
@@ -46,15 +51,6 @@ export declare class EpistolaAdminPageComponent implements OnInit {
         type: 'success' | 'error';
         message: string;
     } | null;
-    formIssues: FormCarrierIssue[] | null;
-    formIssuesLoading: boolean;
-    repairingFormIds: Set<string>;
-    repairingAll: boolean;
-    formFeedback: {
-        formId: string;
-        type: 'success' | 'error';
-        message: string;
-    } | null;
     legacyOverrideForms: LegacyOverrideForm[] | null;
     legacyOverrideLoading: boolean;
     private connectionStatuses;
@@ -69,20 +65,24 @@ export declare class EpistolaAdminPageComponent implements OnInit {
     get validationViolations(): BpmnValidationViolation[];
     /** Scan cadence in whole minutes, for the "refreshes every N min" note. */
     get refreshIntervalMinutes(): number;
-    /** Combined "forms needing attention" count for the tab badge (carrier + legacy override). */
+    /** Forms that still need their legacy override mapping migrated. */
     get formsAttentionCount(): number;
-    /** Whether the forms tab has loaded at least one of its two scans. */
+    /** Whether the legacy override scan has completed. */
     get formsScanLoaded(): boolean;
     ngOnInit(): void;
     selectConfiguration(card: ConfigurationCard): void;
+    hasContractCompatibilityWarning(card: ConfigurationCard): boolean;
+    contractBadgeClass(card: ConfigurationCard): string;
+    contractLabelKey(card: ConfigurationCard): string;
+    contractBodyKey(card: ConfigurationCard): string;
+    versionWithContract(version: string | null | undefined, contractVersion: string | null | undefined): string;
+    get versionCheckNoticeType(): 'error' | 'warning' | 'info' | 'success' | null;
+    get versionCheckTitleKey(): string | null;
+    get versionCheckBodyKey(): string | null;
     backToOverview(): void;
     setActiveTab(tab: 'actions' | 'pending' | 'catalogs'): void;
     setOverviewTab(tab: 'configurations' | 'validations' | 'changelog' | 'forms'): void;
     private loadLegacyOverrideForms;
-    private loadFormIssues;
-    isRepairingForm(issue: FormCarrierIssue): boolean;
-    repairForm(issue: FormCarrierIssue): void;
-    repairAllForms(): void;
     private loadChangelog;
     refresh(): void;
     exportProcessLink(entry: PluginUsageEntry): void;

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

@@ -64,6 +64,7 @@ export declare class EpistolaDocumentPreviewComponent implements FormioCustomCom
      * (e.g. Formio builder), in which case the component fails closed.
      */
     private get currentTaskId();
+    private get hasRuntimeContext();
     /**
      * The override mapping as a JSONata expression for the design-mode summary.
      * Legacy `form:`-ref objects are converted on the fly for display.

package/lib/components/generate-document-configuration/generate-document-config.util.d.ts

@@ -0,0 +1,14 @@
+import { GenerateDocumentConfig } from '../../models';
+import type { VariantSelectionMode } from './generate-document-configuration.component';
+export interface GenerateDocumentValidationOptions {
+    selectedCatalogId?: string | null;
+    filename?: string | null;
+    variantSelectionMode?: VariantSelectionMode;
+    variantAttributeEntries?: {
+        key: string;
+        value: string;
+    }[];
+}
+export declare const PROCESS_VARIABLE_NAME_PATTERN: RegExp;
+export declare function isProcessVariableNameValid(value: unknown): boolean;
+export declare function isGenerateDocumentConfigValid(config: Partial<GenerateDocumentConfig> | null | undefined, options: GenerateDocumentValidationOptions): boolean;

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

@@ -72,6 +72,7 @@ export declare class GenerateDocumentConfigurationComponent implements FunctionC
     editorContextVariables: Record<string, string[]>;
     prefillDataMapping: Record<string, any>;
     validationErrors$: BehaviorSubject<JsonataFieldError[]>;
+    resultProcessVariableInvalid$: BehaviorSubject<boolean>;
     private readonly destroy$;
     private saveSubscription;
     private readonly formValue$;

package/lib/components/valtimo-formio-adapter.d.ts

@@ -0,0 +1,12 @@
+import { Injector, Type } from '@angular/core';
+import { createCustomFormioComponent, FormioCustomComponentInfo } from '@valtimo/components';
+export type ValtimoFormioComponentConstructor = ReturnType<typeof createCustomFormioComponent>;
+export type ValtimoFormioComponent = InstanceType<ValtimoFormioComponentConstructor>;
+export type ValtimoFormioComponentEnhancer = (baseComponent: ValtimoFormioComponentConstructor) => ValtimoFormioComponentConstructor;
+/**
+ * Registers an Angular custom element through Valtimo and optionally replaces
+ * its Formio implementation with a subclass of Valtimo's public bridge class.
+ *
+ * Keep all direct access to Formio's global component registry in this adapter.
+ */
+export declare function registerEpistolaFormioComponent(options: FormioCustomComponentInfo, angularComponent: Type<unknown>, injector: Injector, enhance?: ValtimoFormioComponentEnhancer): void;

package/lib/epistola.module.d.ts

@@ -2,8 +2,8 @@ import { ModuleWithProviders } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/common/http";
-import * as i3 from "@valtimo/plugin";
-import * as i4 from "@valtimo/components";
+import * as i3 from "@valtimo/components";
+import * as i4 from "@valtimo/plugin";
 import * as i5 from "./epistola-admin-routing.module";
 import * as i6 from "./components/epistola-configuration/epistola-configuration.component";
 import * as i7 from "./components/generate-document-configuration/generate-document-configuration.component";
@@ -16,6 +16,6 @@ import * as i13 from "./components/epistola-admin-page/epistola-admin-page.compo
 export declare class EpistolaPluginModule {
     static forRoot(): ModuleWithProviders<EpistolaPluginModule>;
     static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaPluginModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<EpistolaPluginModule, never, [typeof i1.CommonModule, typeof i2.HttpClientModule, typeof i3.PluginTranslatePipeModule, typeof i4.FormModule, typeof i4.InputModule, typeof i4.SelectModule, typeof i5.EpistolaAdminRoutingModule, typeof i6.EpistolaConfigurationComponent, typeof i7.GenerateDocumentConfigurationComponent, typeof i8.CheckJobStatusConfigurationComponent, typeof i9.DownloadDocumentConfigurationComponent, typeof i10.EpistolaDocumentComponent, typeof i11.EpistolaRetryFormComponent, typeof i12.EpistolaDocumentPreviewComponent, typeof i13.EpistolaAdminPageComponent], [typeof i6.EpistolaConfigurationComponent, typeof i7.GenerateDocumentConfigurationComponent, typeof i8.CheckJobStatusConfigurationComponent, typeof i9.DownloadDocumentConfigurationComponent, typeof i10.EpistolaDocumentComponent, typeof i11.EpistolaRetryFormComponent, typeof i12.EpistolaDocumentPreviewComponent, typeof i13.EpistolaAdminPageComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<EpistolaPluginModule, never, [typeof i1.CommonModule, typeof i2.HttpClientModule, typeof i3.FormIoModule, typeof i4.PluginTranslatePipeModule, typeof i3.FormModule, typeof i3.InputModule, typeof i3.SelectModule, typeof i5.EpistolaAdminRoutingModule, typeof i6.EpistolaConfigurationComponent, typeof i7.GenerateDocumentConfigurationComponent, typeof i8.CheckJobStatusConfigurationComponent, typeof i9.DownloadDocumentConfigurationComponent, typeof i10.EpistolaDocumentComponent, typeof i11.EpistolaRetryFormComponent, typeof i12.EpistolaDocumentPreviewComponent, typeof i13.EpistolaAdminPageComponent], never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<EpistolaPluginModule>;
 }

package/lib/models/admin.d.ts

@@ -9,13 +9,40 @@ export interface ConnectionStatus {
     latencyMs: number;
     errorMessage?: string;
     serverVersion?: string;
+    contractVersion?: string;
+    serverContractVersion?: string;
+    contractCompatibilitySeverity?: ContractCompatibilitySeverity;
 }
+export type ContractCompatibilitySeverity = 'OK' | 'WARNING' | 'ERROR' | 'UNKNOWN';
 /**
  * Version information for the Epistola plugin and connected server.
  */
 export interface VersionInfo {
     pluginVersion: string;
     epistolaServerVersion?: string;
+    versionCheck: VersionCheckStatus;
+}
+/**
+ * Status of the public plugin release metadata check.
+ */
+export interface VersionCheckStatus {
+    enabled: boolean;
+    checkedAt?: string | null;
+    currentVersion: string;
+    metadataAvailable: boolean;
+    preRelease: boolean;
+    latestVersion?: string | null;
+    updateAvailable: boolean;
+    releaseUrl?: string | null;
+    changelogUrl?: string | null;
+    latestStableVersion?: string | null;
+    stableReleaseUrl?: string | null;
+    stableChangelogUrl?: string | null;
+    supported: boolean;
+    supportEndingSoon: boolean;
+    minSupportedVersion?: string | null;
+    supportedUntil?: string | null;
+    lastError?: string | null;
 }
 /**
  * Describes a single usage of an Epistola plugin action within a process definition.
@@ -140,18 +167,6 @@ export interface BpmnValidationReport {
     refreshIntervalMs: number;
     violations: BpmnValidationViolation[];
 }
-/**
- * TEMPORARY (removed in 1.0.0). A form whose Epistola components are missing the
- * task-id carrier field — surfaced on the admin page so it can be repaired.
- * `readOnly` flags classpath-deployed forms (a repair there is reverted on the next
- * boot; fix the source instead).
- */
-export interface FormCarrierIssue {
-    formId: string;
-    name: string;
-    missingComponents: number;
-    readOnly: boolean;
-}
 /**
  * TEMPORARY. A form whose `epistola-document-preview` components still use the legacy
  * override-mapping object format (`{ scope: { path: "form:key" } }`) instead of the new
@@ -165,17 +180,3 @@ export interface LegacyOverrideForm {
     legacyComponents: number;
     readOnly: boolean;
 }
-/** TEMPORARY (removed in 1.0.0). Outcome of repairing one form's carrier. */
-export interface FormCarrierRepairResult {
-    formId: string;
-    name: string | null;
-    success: boolean;
-    componentsPatched: number;
-    errorMessage: string | null;
-}
-/** TEMPORARY (removed in 1.0.0). Aggregate outcome of repairing all flagged forms. */
-export interface FormCarrierRepairSummary {
-    formsRepaired: number;
-    componentsPatched: number;
-    failed: number;
-}

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

@@ -1,7 +1,7 @@
 import { HttpClient } from '@angular/common/http';
 import { ConfigService } from '@valtimo/shared';
 import { Observable } from 'rxjs';
-import { BpmnValidationReport, CatalogRedeployResult, ChangelogRelease, ClasspathCatalog, ConnectionStatus, FormCarrierIssue, FormCarrierRepairResult, FormCarrierRepairSummary, LegacyOverrideForm, PendingJob, PluginUsageEntry, ReconcileResult, VersionInfo } from '../models';
+import { BpmnValidationReport, CatalogRedeployResult, ChangelogRelease, ClasspathCatalog, ConnectionStatus, LegacyOverrideForm, PendingJob, PluginUsageEntry, ReconcileResult, VersionInfo } from '../models';
 import * as i0 from "@angular/core";
 /**
  * Service for Epistola plugin administrative operations.
@@ -64,12 +64,6 @@ export declare class EpistolaAdminService {
      * Export a single process link as a .process-link.json file.
      */
     exportProcessLink(processLinkId: string): Observable<Blob>;
-    /** Forms whose Epistola components are missing the task-id carrier. */
-    getFormCarrierIssues(): Observable<FormCarrierIssue[]>;
-    /** Inject the task-id carrier into a single form's Epistola components. */
-    repairFormCarrier(formId: string): Observable<FormCarrierRepairResult>;
-    /** Repair every flagged form. */
-    repairAllFormCarriers(): Observable<FormCarrierRepairSummary>;
     /** Forms whose preview components still use the legacy override-mapping object format. */
     getLegacyOverrideForms(): Observable<LegacyOverrideForm[]>;
     static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaAdminService, never>;

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

@@ -1,13 +1,17 @@
 import { MenuService } from '@valtimo/components';
+import { MenuItem } from '@valtimo/shared';
 import * as i0 from "@angular/core";
+export declare function appendEpistolaMenuItem(items: MenuItem[]): MenuItem[];
 /**
  * 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.
+ * Registration is invoked by EpistolaRegistrationService during environment
+ * initialization, before Valtimo builds the configured menu.
  */
 export declare class EpistolaMenuService {
     private readonly menuService;
+    private registered;
     constructor(menuService: MenuService);
+    register(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaMenuService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<EpistolaMenuService>;
 }

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

@@ -24,7 +24,6 @@ export interface PreviewBlobRequest {
  */
 export interface DownloadDocumentRequest {
     taskId: string;
-    caseDocumentId: string;
     documentVariable: string;
     tenantIdVariable: string;
     filename: string;

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

@@ -0,0 +1,12 @@
+import { Injector } from '@angular/core';
+import { EpistolaMenuService } from './epistola-menu.service';
+import * as i0 from "@angular/core";
+export declare class EpistolaRegistrationService {
+    private readonly injector;
+    private readonly menuService;
+    private registered;
+    constructor(injector: Injector, menuService: EpistolaMenuService);
+    register(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EpistolaRegistrationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EpistolaRegistrationService>;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Render a JSONata path tail for a Formio-style dotted key.
+ *
+ * Formio stores component keys through lodash get/set semantics, so dots in a
+ * component key are path separators. JSONata backticks should therefore quote
+ * only the segment that needs it, not the whole dotted key.
+ */
+export declare function renderJsonataPathTail(key: string): string;
+export declare function renderJsonataPath(variableName: string, key: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epistola.app/valtimo-plugin",
-  "version": "0.13.1",
+  "version": "0.15.0",
   "description": "Epistola document generation plugin for Valtimo",
   "license": "EUPL-1.2",
   "repository": {
@@ -10,6 +10,28 @@
   "sideEffects": false,
   "module": "fesm2022/epistola.app-valtimo-plugin.mjs",
   "typings": "index.d.ts",
+  "dependencies": {
+    "jsonata": "^2.2.2",
+    "tslib": "^2.6.0"
+  },
+  "peerDependencies": {
+    "@angular/common": ">=19.2.8 <20",
+    "@angular/core": ">=19.2.8 <20",
+    "@angular/elements": ">=19.2.8 <20",
+    "@angular/forms": ">=19.2.8 <20",
+    "@angular/platform-browser": ">=19.2.8 <20",
+    "@angular/router": ">=19.2.8 <20",
+    "@formio/angular": "7.0.0",
+    "@valtimo/components": ">=13.21.0 <14",
+    "@valtimo/plugin": ">=13.21.0 <14",
+    "@valtimo/process-link": ">=13.21.0 <14",
+    "@valtimo/security": ">=13.21.0 <14",
+    "@valtimo/shared": ">=13.21.0 <14",
+    "carbon-components-angular": "5.57.6",
+    "formiojs": "4.19.5",
+    "monaco-editor": ">=0.40.0 <1",
+    "rxjs": "^7.8.0"
+  },
   "exports": {
     "./package.json": {
       "default": "./package.json"
@@ -18,22 +40,5 @@
       "types": "./index.d.ts",
       "default": "./fesm2022/epistola.app-valtimo-plugin.mjs"
     }
-  },
-  "dependencies": {
-    "jsonata": "^2.1.0",
-    "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",
-    "@formio/angular": "^7.0.0",
-    "@valtimo/components": "^13.21.0",
-    "@valtimo/plugin": "^13.21.0",
-    "@valtimo/process-link": "^13.21.0",
-    "@valtimo/security": "^13.21.0",
-    "@valtimo/shared": "^13.21.0",
-    "monaco-editor": ">=0.40.0"
   }
 }

package/public_api.d.ts

@@ -1,23 +1,2 @@
-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/jsonata-editor/jsonata-editor.component';
-export * from './lib/components/mapping-builder/mapping-builder.component';
-export * from './lib/components/epistola-document/epistola-document.component';
-export * from './lib/components/epistola-document/epistola-document.formio';
-export * from './lib/components/epistola-retry-form/epistola-retry-form.component';
-export * from './lib/components/epistola-retry-form/epistola-retry-form.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';