@vario-software/types 2026.12.3

package/scripting/work_item_intermediate_event.d.ts

@@ -0,0 +1,122 @@
+import {
+    WorkflowInstanceDetails
+} from "./types"
+
+import {
+    ScriptingServiceList
+} from "./services"
+
+export interface WorkflowScriptingContext {
+
+    /**
+     * Details zur aktuellen Workflow-Instanz
+     */
+    instanceDetails: WorkflowInstanceDetails;
+
+    /**
+     * Verfügbare Eingabedaten
+     */
+    availableInput: Map<string,object>;
+
+    /**
+     * Services
+     */
+    services: ScriptingServiceList;
+
+    /**
+     * Parameter zur Verwendung im Skript
+     */
+    parameters: Map<string,object>;
+}
+
+/**
+ * Definiert, ob die Skript-Methode "trigger" ausgeführt werden soll
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ * @return {boolean} Skript-Methode "trigger" ausführen?
+ */
+type WorkItemIntermediateEventGuard = (ctx: WorkflowScriptingContext) => boolean;
+
+/**
+ * Variablen für die C-Unit-Queries füllen. Wird vor "guard" ausgeführt
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ */
+type WorkItemIntermediateEventPrepare = (ctx: WorkflowScriptingContext) => void;
+
+/**
+ * Wird nach Empfang des konfigurierten Events ausgelöst
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ */
+type WorkItemIntermediateEventTrigger = (ctx: WorkflowScriptingContext) => void;
+
+export interface WorkflowScriptingContext {
+
+    /**
+     * Details zur aktuellen Workflow-Instanz
+     */
+    instanceDetails: WorkflowInstanceDetails;
+
+    /**
+     * Verfügbare Eingabedaten
+     */
+    availableInput: Map<string,object>;
+
+    /**
+     * Services
+     */
+    services: ScriptingServiceList;
+
+    /**
+     * Parameter zur Verwendung im Skript
+     */
+    parameters: Map<string,object>;
+}
+
+
+/**
+ * Ausführung von Aktionen nach einem Event oder abgelaufener Wartezeit
+ * 
+ * @filename work_item_intermediate_event
+ * @example
+ * ```typescript
+ * import workItem from "work_item_intermediate_event";
+ * 
+ * workItem.prepare: (ctx) => {
+ *     // Fill variables for c-unit queries. Executed before method “guard”
+ * };
+ * 
+ * workItem.setGuard( (ctx) => {
+ *     // Should "trigger" be executed?
+ *     return true;
+ * };
+ * 
+ * workItem.trigger: (ctx) => {
+ *     // Action to be performed
+ * };
+ * ```
+ */
+export interface workItem {
+
+    /**
+     * Setter für Callback "prepare"
+     * 
+     * @param {WorkItemIntermediateEventPrepare} callback - Callback "prepare"
+     */
+    setPrepare(callback: WorkItemIntermediateEventPrepare): void;
+
+    /**
+     * Setter für Callback "guard"
+     * 
+     * @param {WorkItemIntermediateEventGuard} callback - Callback "guard"
+     */
+    setGuard(callback: WorkItemIntermediateEventGuard): void;
+
+    /**
+     * Setter für Callback "trigger"
+     * 
+     * @param {WorkItemIntermediateEventTrigger} callback - Callback "trigger"
+     */
+    setTrigger(callback: WorkItemIntermediateEventTrigger): void;
+}

package/scripting/work_item_script.d.ts

@@ -0,0 +1,122 @@
+import {
+    WorkflowInstanceDetails
+} from "./types"
+
+import {
+    ScriptingServiceList
+} from "./services"
+
+export interface WorkflowScriptingContext {
+
+    /**
+     * Details zur aktuellen Workflow-Instanz
+     */
+    instanceDetails: WorkflowInstanceDetails;
+
+    /**
+     * Verfügbare Eingabedaten
+     */
+    availableInput: Map<string,object>;
+
+    /**
+     * Services
+     */
+    services: ScriptingServiceList;
+
+    /**
+     * Parameter zur Verwendung im Skript
+     */
+    parameters: Map<string,object>;
+}
+
+/**
+ * Führt die gewünschten Aktionen des Workflow-Elements aus
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ */
+type WorkItemScriptAction = (ctx: WorkflowScriptingContext) => void;
+
+/**
+ * Definiert, ob die Skript-Methode "action" ausgeführt werden soll
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ * @return {boolean} Skript-Methode "action" ausführen?
+ */
+type WorkItemScriptGuard = (ctx: WorkflowScriptingContext) => boolean;
+
+/**
+ * Variablen für die C-Unit-Queries füllen. Wird vor "guard" und "action" ausgeführt
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ */
+type WorkItemScriptPrepare = (ctx: WorkflowScriptingContext) => void;
+
+export interface WorkflowScriptingContext {
+
+    /**
+     * Details zur aktuellen Workflow-Instanz
+     */
+    instanceDetails: WorkflowInstanceDetails;
+
+    /**
+     * Verfügbare Eingabedaten
+     */
+    availableInput: Map<string,object>;
+
+    /**
+     * Services
+     */
+    services: ScriptingServiceList;
+
+    /**
+     * Parameter zur Verwendung im Skript
+     */
+    parameters: Map<string,object>;
+}
+
+
+/**
+ * Ausführung von Aktionen innerhalb eines Workflows
+ * 
+ * @filename work_item_script
+ * @example
+ * ```typescript
+ * import workItem from "work_item_script";
+ * 
+ * workItem.setPrepare( (ctx) => {
+ *     // Fill variables for c-unit queries. Executed before method “guard”
+ * });
+ * 
+ * workItem.setGuard( (ctx) => {
+ *     // Should "trigger" be executed?
+ *     return true;
+ * };
+ * 
+ * workItem.setAction( (ctx) => {
+ *     // Action to be performed
+ * };
+ * ```
+ */
+export interface workItem {
+
+    /**
+     * Setter für Callback "prepare"
+     * 
+     * @param {WorkItemScriptPrepare} callback - Callback "prepare"
+     */
+    setPrepare(callback: WorkItemScriptPrepare): void;
+
+    /**
+     * Setter für Callback "guard"
+     * 
+     * @param {WorkItemScriptGuard} callback - Callback "guard"
+     */
+    setGuard(callback: WorkItemScriptGuard): void;
+
+    /**
+     * Setter für Callback "action"
+     * 
+     * @param {WorkItemScriptAction} callback - Callback "action"
+     */
+    setAction(callback: WorkItemScriptAction): void;
+}

package/scripting/work_item_split_gateway.d.ts

@@ -0,0 +1,104 @@
+import {
+    WorkflowInstanceDetails
+} from "./types"
+
+import {
+    ScriptingServiceList
+} from "./services"
+
+export interface WorkflowScriptingContext {
+
+    /**
+     * Details zur aktuellen Workflow-Instanz
+     */
+    instanceDetails: WorkflowInstanceDetails;
+
+    /**
+     * Verfügbare Eingabedaten
+     */
+    availableInput: Map<string,object>;
+
+    /**
+     * Services
+     */
+    services: ScriptingServiceList;
+
+    /**
+     * Parameter zur Verwendung im Skript
+     */
+    parameters: Map<string,object>;
+}
+
+/**
+ * Variablen für die C-Unit-Queries füllen. Wird vor "split" ausgeführt
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ */
+type WorkItemSplitGatewayPrepare = (ctx: WorkflowScriptingContext) => void;
+
+/**
+ * Ermittelt den Identifier zur Auswahl des nächsten Workflow-Elements
+ * 
+ * @param {WorkflowScriptingContext} ctx - Workflow-Skript-Kontext
+ * @return {string} Split-Gateway-Identifier
+ */
+type WorkItemSplitGatewaySplit = (ctx: WorkflowScriptingContext) => string;
+
+export interface WorkflowScriptingContext {
+
+    /**
+     * Details zur aktuellen Workflow-Instanz
+     */
+    instanceDetails: WorkflowInstanceDetails;
+
+    /**
+     * Verfügbare Eingabedaten
+     */
+    availableInput: Map<string,object>;
+
+    /**
+     * Services
+     */
+    services: ScriptingServiceList;
+
+    /**
+     * Parameter zur Verwendung im Skript
+     */
+    parameters: Map<string,object>;
+}
+
+
+/**
+ * Durchführung einer Entscheidung zum Fortsetzen eines Workflows
+ * 
+ * @filename work_item_split_gateway
+ * @example
+ * ```typescript
+ * import workItem from "work_item_split_gateway";
+ * 
+ * workItem.prepare: (ctx) => {
+ *     // Fill variables for c-unit queries. Executed before method “split”
+ * };
+ * 
+ * workItem.split: (ctx) => {
+ *     // Determines the identifier for selecting the next workflow element
+ *     return <Gateway-Identifier>;
+ * };
+ * ```
+ */
+export interface workItem {
+
+    /**
+     * Setter für Callback "prepare"
+     * 
+     * @param {WorkItemSplitGatewayPrepare} callback - Callback "prepare"
+     */
+    setPrepare(callback: WorkItemSplitGatewayPrepare): void;
+
+    /**
+     * Setter für Callback "split"
+     * 
+     * @param {WorkItemSplitGatewaySplit} callback - Callback "split"
+     */
+    setSplit(callback: WorkItemSplitGatewaySplit): void;
+}

package/scripting.d.ts

@@ -0,0 +1,41 @@
+declare module 'app_scripting_proxy'
+{
+  const appScript: import('./scripting/app_scripting_proxy').appScript;
+  export default appScript;
+}
+
+declare module 'batch_script'
+{
+  const batchAction: import('./scripting/batch_script').batchAction;
+  export default batchAction;
+}
+
+declare module 'output_filter_script'
+{
+  const outputFilter: import('./scripting/output_filter_script').outputFilter;
+  export default outputFilter;
+}
+
+declare module 'picklist_script_pick_box_connect'
+{
+  const pickBoxConnector: import('./scripting/picklist_script_pick_box_connect').pickBoxConnector;
+  export default pickBoxConnector;
+}
+
+declare module 'work_item_script'
+{
+  const workItem: import('./scripting/work_item_script').workItem;
+  export default workItem;
+}
+
+declare module 'work_item_intermediate_event'
+{
+  const workItem: import('./scripting/work_item_intermediate_event').workItem;
+  export default workItem;
+}
+
+declare module 'work_item_split_gateway'
+{
+  const workItem: import('./scripting/work_item_split_gateway').workItem;
+  export default workItem;
+}