@epistola.app/valtimo-plugin 0.0.1

package/src/lib/models/config.ts

@@ -0,0 +1,53 @@
+import {PluginConfigurationData} from '@valtimo/plugin';
+
+/**
+ * Plugin-level configuration for Epistola.
+ * Contains connection settings and defaults.
+ */
+export interface EpistolaPluginConfig extends PluginConfigurationData {
+  baseUrl: string;
+  apiKey: string;
+  tenantId: string;
+  defaultEnvironmentId?: string;
+  templateSyncEnabled?: boolean;
+}
+
+/**
+ * Action configuration for the generate-document action.
+ * Contains all parameters needed to generate a document.
+ *
+ * Variant selection supports two modes:
+ * - Explicit: set variantId directly
+ * - By attributes: set variantAttributes with key-value pairs (values can be value resolver expressions)
+ */
+export interface GenerateDocumentConfig {
+  templateId: string;
+  variantId?: string;
+  variantAttributes?: Record<string, string>;
+  environmentId?: string;
+  dataMapping: Record<string, any>;
+  outputFormat: 'PDF' | 'HTML';
+  filename: string;
+  correlationId?: string;
+  resultProcessVariable: string;
+}
+
+/**
+ * Action configuration for the check-job-status action.
+ * Specifies which process variables to read from and write to.
+ */
+export interface CheckJobStatusConfig {
+  requestIdVariable: string;
+  statusVariable: string;
+  documentIdVariable?: string;
+  errorMessageVariable?: string;
+}
+
+/**
+ * Action configuration for the download-document action.
+ * Specifies which process variables to read from and write to.
+ */
+export interface DownloadDocumentConfig {
+  documentIdVariable: string;
+  contentVariable: string;
+}

package/src/lib/models/index.ts

@@ -0,0 +1,2 @@
+export * from './config';
+export * from './template';

package/src/lib/models/template.ts

@@ -0,0 +1,70 @@
+/**
+ * Basic information about an Epistola template.
+ */
+export interface TemplateInfo {
+  id: string;
+  name: string;
+  description?: string;
+}
+
+/**
+ * Detailed information about an Epistola template including its fields.
+ */
+export interface TemplateDetails {
+  id: string;
+  name: string;
+  fields: TemplateField[];
+}
+
+/**
+ * Represents a field in an Epistola template.
+ * Supports nested structures through the children property.
+ */
+export interface TemplateField {
+  name: string;
+  path: string;
+  type: string;
+  fieldType: 'SCALAR' | 'OBJECT' | 'ARRAY';
+  required: boolean;
+  description?: string;
+  children?: TemplateField[];
+}
+
+/**
+ * Represents a single data mapping entry.
+ */
+export interface DataMappingEntry {
+  templateField: string;
+  dataSource: string;
+}
+
+/**
+ * Source type for data mapping: how the value is provided.
+ */
+export type DataSourceType = 'document' | 'processVariable' | 'manual';
+
+/**
+ * Validation result from the backend.
+ */
+export interface ValidationResult {
+  valid: boolean;
+  missingRequiredFields: string[];
+}
+
+/**
+ * Information about an Epistola environment.
+ */
+export interface EnvironmentInfo {
+  id: string;
+  name: string;
+}
+
+/**
+ * Information about an Epistola template variant.
+ */
+export interface VariantInfo {
+  id: string;
+  templateId: string;
+  name: string;
+  attributes: Record<string, string>;
+}

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

@@ -0,0 +1,82 @@
+import {Injectable} from '@angular/core';
+import {HttpClient} from '@angular/common/http';
+import {ConfigService} from '@valtimo/shared';
+import {Observable} from 'rxjs';
+import {EnvironmentInfo, TemplateDetails, TemplateInfo, ValidationResult, VariantInfo} from '../models';
+
+/**
+ * Service for interacting with Epistola plugin API endpoints.
+ * Provides methods to fetch templates, environments, variants,
+ * process variables, and validate mappings.
+ */
+@Injectable()
+export class EpistolaPluginService {
+  private readonly apiEndpoint: string;
+
+  constructor(
+    private readonly http: HttpClient,
+    private readonly configService: ConfigService
+  ) {
+    this.apiEndpoint = `${this.configService.config.valtimoApi.endpointUri}v1/plugin/epistola`;
+  }
+
+  /**
+   * Get all available templates for a plugin configuration.
+   */
+  getTemplates(pluginConfigurationId: string): Observable<TemplateInfo[]> {
+    return this.http.get<TemplateInfo[]>(
+      `${this.apiEndpoint}/configurations/${pluginConfigurationId}/templates`
+    );
+  }
+
+  /**
+   * Get template details including its fields.
+   */
+  getTemplateDetails(pluginConfigurationId: string, templateId: string): Observable<TemplateDetails> {
+    return this.http.get<TemplateDetails>(
+      `${this.apiEndpoint}/configurations/${pluginConfigurationId}/templates/${templateId}`
+    );
+  }
+
+  /**
+   * Get all available environments for a plugin configuration.
+   */
+  getEnvironments(pluginConfigurationId: string): Observable<EnvironmentInfo[]> {
+    return this.http.get<EnvironmentInfo[]>(
+      `${this.apiEndpoint}/configurations/${pluginConfigurationId}/environments`
+    );
+  }
+
+  /**
+   * Get all variants for a specific template.
+   */
+  getVariants(pluginConfigurationId: string, templateId: string): Observable<VariantInfo[]> {
+    return this.http.get<VariantInfo[]>(
+      `${this.apiEndpoint}/configurations/${pluginConfigurationId}/templates/${templateId}/variants`
+    );
+  }
+
+  /**
+   * Discover process variable names for a given process definition.
+   */
+  getProcessVariables(processDefinitionKey: string): Observable<string[]> {
+    return this.http.get<string[]>(
+      `${this.apiEndpoint}/process-variables`,
+      {params: {processDefinitionKey}}
+    );
+  }
+
+  /**
+   * Validate that a data mapping covers all required template fields.
+   */
+  validateMapping(
+    pluginConfigurationId: string,
+    templateId: string,
+    dataMapping: Record<string, any>
+  ): Observable<ValidationResult> {
+    return this.http.post<ValidationResult>(
+      `${this.apiEndpoint}/configurations/${pluginConfigurationId}/templates/${templateId}/validate-mapping`,
+      {dataMapping}
+    );
+  }
+}

package/src/lib/services/index.ts

@@ -0,0 +1 @@
+export * from './epistola-plugin.service';

package/src/public_api.ts

@@ -0,0 +1,16 @@
+/*
+ * Public API Surface of epistola plugin
+ */
+
+export * from './lib/models';
+export * from './lib/services';
+export * from './lib/epistola.module';
+export * from './lib/epistola.specification';
+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/field-tree/field-tree.component';
+export * from './lib/components/data-mapping-tree/data-mapping-tree.component';
+export * from './lib/components/epistola-download/epistola-download.component';
+export * from './lib/components/epistola-download/epistola-download.formio';

package/tsconfig.lib.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "outDir": "../../out-tsc/lib",
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "sourceMap": true,
+    "importHelpers": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "lib": ["ES2022", "dom"],
+    "types": []
+  },
+  "angularCompilerOptions": {
+    "compilationMode": "partial"
+  },
+  "exclude": ["**/*.spec.ts"]
+}