@vario-software/types 2026.32.7 → 2026.32.8

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "@vario-software/types",
-  "version": "2026.32.7",
+  "version": "2026.32.8",
+  "description": "TypeScript type definitions for the VARIO Cloud platform: REST API schemas, app framework contexts and scripting interfaces. Provides type checking, autocompletion and IntelliSense in TypeScript and JavaScript projects.",
+  "homepage": "https://developer.vario-software.de/",
+  "bugs": "https://developer.vario-software.de/help-support",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vario-software/types.git"
+  },
+  "author": "VARIO Software AG",
+  "license": "MIT",
   "types": "./index.d.ts",
   "dependencies": {
     "@types/express": "^5.0.6"
@@ -27,9 +36,5 @@
     "./scripting": {
       "types": "./scripting.d.ts"
     }
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vario-software/types.git"
   }
 }

package/readme.md

@@ -1,8 +1,21 @@
-# VARIO Types
+# VARIO Cloud TypeScript Definitions
 
-TypeScript type definitions for the VARIO Cloud platform. This package provides full autocompletion and type checking for VARIO Cloud Apps built with the [VARIO App Framework](https://github.com/vario-software/vario-app-framework) like our [VARIO App Demo](https://github.com/vario-software/vario-app-demo), including typed API calls, context, feature modules, OpenAPI schemas, and scripting interfaces.
+TypeScript type definitions for the VARIO Cloud platform.
 
-For more information about VARIO and our ERP system, visit [www.vario.ag](https://www.vario.ag). For developer resources, see our [Developer Documentation](https://developer.vario-software.de/).
+The package provides type checking, autocompletion and IntelliSense for VARIO Cloud APIs, platform contexts, OpenAPI schemas and scripting interfaces.
+
+It works in plain JavaScript projects too — no TypeScript build step is required.
+
+## What's included
+
+| Area | Contents |
+| ---- | -------- |
+| VARIO Cloud APIs | The REST and VQL clients, and the platform modules (EAV, migrations, text enums, webhooks, permitted tokens) |
+| Platform contexts | The App object, request context, migrator and error types |
+| OpenAPI schemas | The generated ERP schema — every request and response shape of the REST API |
+| Scripting interfaces | The script entry points (batch scripts, work items, output filters, the scripting proxy) and the service layer |
+
+## Installation
 
 ```bash
 npm install @vario-software/types --save-dev
@@ -10,7 +23,6 @@ npm install @vario-software/types --save-dev
 
 To enable type support in your project, create a `jsconfig.json` file in the project root:
 
-
 ```json
 {
   "compilerOptions": {
@@ -21,4 +33,11 @@ To enable type support in your project, create a `jsconfig.json` file in the pro
     "**/node_modules"
   ]
 }
-```
+```
+
+## VARIO Cloud developer resources
+
+- [Browse the VARIO Cloud Developer Docs](https://developer.vario-software.de/)
+- [Explore the VARIO Cloud REST API Reference](https://developer.vario-software.de/api-reference)
+- [View all VARIO packages on npm](https://www.npmjs.com/org/vario-software)
+- [View the source code on GitHub](https://github.com/vario-software/types)

package/scripting/services.d.ts

@@ -1775,20 +1775,20 @@ export interface DocumentScriptingService {
      * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
      * 
      * @param {number} documentId - ID des zu kopierenden Belegs
-     * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
+     * @param {string} targetDocumentType - Ziel-Belegart der Kopie
+     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der kopierte Beleg
      */
-    copy(documentId: number, targetDocumentTypeLabel: string): Document;
+    copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
 
     /**
      * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
      * 
      * @param {number} documentId - ID des zu kopierenden Belegs
-     * @param {string} targetDocumentType - Ziel-Belegart der Kopie
-     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
+     * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
      * @return {Document} Der kopierte Beleg
      */
-    copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
+    copy(documentId: number, targetDocumentTypeLabel: string): Document;
 
     /**
      * Erstellt einen neuen Beleg
@@ -1802,35 +1802,35 @@ export interface DocumentScriptingService {
      * Löst einen Beleg auf
      * 
      * @param {number} documentId - ID des aufzulösenden Belegs
+     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der aufgelöste Beleg
      */
-    dissolve(documentId: number): Document;
+    dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
 
     /**
      * Löst einen Beleg auf
      * 
      * @param {number} documentId - ID des aufzulösenden Belegs
-     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der aufgelöste Beleg
      */
-    dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
+    dissolve(documentId: number): Document;
 
     /**
      * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
      * 
      * @param {number} documentId - ID des Belegs
+     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der Beleg in Bearbeitung
      */
-    edit(documentId: number): Document;
+    edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
 
     /**
      * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
      * 
      * @param {number} documentId - ID des Belegs
-     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der Beleg in Bearbeitung
      */
-    edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
+    edit(documentId: number): Document;
 
     /**
      * Erstellt ein AdditionalParameter-Objekt
@@ -2871,26 +2871,26 @@ export interface ScriptingServiceList {
      */
     crmTaskService: CrmTaskScriptingService;
 
-    /**
-     * Service zur Verarbeitung von Accounts
-     */
-    accountService: AccountScriptingService;
-
     /**
      * Service zur Verarbeitung von Shelf-Documents
      */
     shelfDocumentService: ShelfDocumentScriptingService;
 
     /**
-     * Verwaltung von Versandarten
+     * Service zur Verarbeitung von Accounts
      */
-    deliveryMethodService: DeliveryMethodScriptingService;
+    accountService: AccountScriptingService;
 
     /**
      * Logging im Scripting
      */
     logger: LoggingScriptingService;
 
+    /**
+     * Verwaltung von Versandarten
+     */
+    deliveryMethodService: DeliveryMethodScriptingService;
+
     /**
      * Service zur Verarbeitung von Deals
      */
@@ -2912,14 +2912,14 @@ export interface ScriptingServiceList {
     textTemplateService: TextTemplateScriptingService;
 
     /**
-     * Service zur Verarbeitung von Hauptwarengruppen im Skripten
+     * Ausgabe-Support Methoden
      */
-    productMainGroupService: ProductMainGroupScriptingService;
+    outputHelper: ScriptOutputHelperService;
 
     /**
-     * Ausgabe-Support Methoden
+     * Service zur Verarbeitung von Hauptwarengruppen im Skripten
      */
-    outputHelper: ScriptOutputHelperService;
+    productMainGroupService: ProductMainGroupScriptingService;
 
     /**
      * Service zur Verarbeitung von Account-Listings in Skripten
@@ -2947,14 +2947,14 @@ export interface ScriptingServiceList {
     utils: ScriptingUtilities;
 
     /**
-     * Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten
+     * Service zur Verarbeitung von Variantenschemas in Skripten
      */
-    articleCustomerService: ArticleCustomerScriptingService;
+    variantSchemaService: VariantSchemaScriptingService;
 
     /**
-     * Service zur Verarbeitung von Variantenschemas in Skripten
+     * Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten
      */
-    variantSchemaService: VariantSchemaScriptingService;
+    articleCustomerService: ArticleCustomerScriptingService;
 
     /**
      * Service zur Verarbeitung von Artikeln im Skripten
@@ -2982,14 +2982,14 @@ export interface ScriptingServiceList {
     articleStorageService: ArticleStorageScriptingService;
 
     /**
-     * Verwaltung von Zahlungsarten
+     * Anfragen von neuen Zählerkreis-Nummern
      */
-    paymentMethodService: PaymentMethodScriptingService;
+    freeSequencerService: FreeSequencerScriptingService;
 
     /**
-     * Anfragen von neuen Zählerkreis-Nummern
+     * Verwaltung von Zahlungsarten
      */
-    freeSequencerService: FreeSequencerScriptingService;
+    paymentMethodService: PaymentMethodScriptingService;
 
     /**
      * Service zur Verarbeitung von AssetsTypen in Skripten
@@ -3002,14 +3002,14 @@ export interface ScriptingServiceList {
     stockService: StockScriptingService;
 
     /**
-     * Service zur Verarbeitung von Assets in Skripten
+     * Service zur Verarbeitung von Variantenwerten in Skripten
      */
-    assetService: AssetScriptingService;
+    variantValueService: VariantValueScriptingService;
 
     /**
-     * Service zur Verarbeitung von Variantenwerten in Skripten
+     * Service zur Verarbeitung von Assets in Skripten
      */
-    variantValueService: VariantValueScriptingService;
+    assetService: AssetScriptingService;
 
     /**
      * Service zur Verarbeitung von ScenarioActualValue
@@ -3175,24 +3175,24 @@ export interface ShelfDocumentScriptingService {
     deleteAttribution(attributionId: number): void;
 
     /**
-     * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
+     * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
      * 
      * @param {string} url - Download-URL
-     * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
-     * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
      * @param {string} documentTypeKey - Schlüssel der Dokumentenart
      * @return {ShelfDocument} Das neu erstellte DMS-Dokument
      */
-    downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
+    downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
 
     /**
-     * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
+     * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
      * 
      * @param {string} url - Download-URL
+     * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
+     * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
      * @param {string} documentTypeKey - Schlüssel der Dokumentenart
      * @return {ShelfDocument} Das neu erstellte DMS-Dokument
      */
-    downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
+    downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
 
     /**
      * Findet ein Dokumentenart über ihren Schlüssel