@gandalan/weblibs 2.0.2 → 2.0.4

package/api/business/anpassungApi.js

@@ -1,7 +1,31 @@
 /**
  * @typedef {import('../fluentApi.js').FluentApi} FluentApi
- * @typedef {Object & { AnpassungGuid?: string, anpassungGuid?: string }} AnpassungDTO
- * @typedef {Object & { AnpassungVorlageGuid?: string, anpassungVorlageGuid?: string }} AnpassungVorlageDTO
+ */
+
+/**
+ * @typedef {Object} AnpassungDTO
+ * @property {string} AnpassungGuid
+ * @property {string} Art
+ * @property {boolean} GiltFuerBesitzer
+ * @property {boolean} GiltFuerAlleUntermandanten
+ * @property {boolean} GiltFuerZielMandant
+ * @property {string} ZielMandantGuid
+ * @property {string} Content
+ * @property {string} WarengruppeGuid
+ * @property {string} ArtikelGuid
+ * @property {number} Version
+ * @property {string} ChangedDate - ISO date string
+ */
+
+/**
+ * @typedef {Object} AnpassungVorlageDTO
+ * @property {string} AnpassungVorlageGuid
+ * @property {string} Art
+ * @property {string} Name
+ * @property {string} Beschreibung
+ * @property {string} Content
+ * @property {number} Version
+ * @property {string} ChangedDate - ISO date string
  */
 
 /**

package/api/business/avApi.js

@@ -6,8 +6,7 @@
  * @typedef {import('../dtos/produktion.js').ProduktionsDatenDTO} ProduktionsDatenDTO
  * @typedef {import('../dtos/index.js').AVReserviertItemDTO} AVReserviertItemDTO
  * @typedef {import('../dtos/belege.js').CalculationInfoDTO} CalculationInfoDTO
- * @typedef {Object} AvReportVorgangRequestDto
- * @typedef {Object} AvReportVorgangDto
+ * @typedef {import('../dtos/index.js').BeleganschriftDTO} BeleganschriftDTO
  * @typedef {import('../dtos/produktion.js').SaegeDatenHistorieDTO} SaegeDatenHistorieDTO
  * @typedef {import('../dtos/produktion.js').SaegeDatenResultDTO} SaegeDatenResultDTO
  * @typedef {import('../dtos/index.js').MaterialBearbeitungsMethodeDTO} MaterialBearbeitungsMethodeDTO
@@ -16,6 +15,41 @@
  * @typedef {import('../dtos/av.js').SerienMaterialEditDTO} SerienMaterialEditDTO
  */
 
+/**
+ * @typedef {Object} AvReportVorgangRequestDto
+ * @property {Array<string>} VorgangGuids
+ */
+
+/**
+ * Minimalistic DTO for Vorgang in AV reports.
+ * @typedef {Object} AvReportVorgangDto
+ * @property {string} VorgangGuid
+ * @property {number} VorgangsNummer
+ * @property {string} Kommission
+ * @property {string} Kommission2
+ * @property {Array<AvReportBelegDto>} Belege
+ * @property {AvReportKontaktDto} Kunde
+ */
+
+/**
+ * Minimalistic DTO for Beleg in AV reports.
+ * @typedef {Object} AvReportBelegDto
+ * @property {string} BelegGuid
+ * @property {BeleganschriftDTO} BelegAdresse
+ * @property {BeleganschriftDTO} VersandAdresse
+ * @property {boolean} VersandAdresseGleichBelegAdresse
+ * @property {string} BelegArt
+ * @property {string} Terminwunsch
+ * @property {boolean} IstSelbstabholer
+ */
+
+/**
+ * Minimalistic DTO for Kontakt information in AvReportVorgangDto.
+ * @typedef {Object} AvReportKontaktDto
+ * @property {string} KundenNummer
+ * @property {string} Land
+ */
+
 /**
  * AV API - Arbeitsvorbereitung (work preparation) management
  * @param {FluentApi} fluentApi

package/api/business/fileApi.js

@@ -1,6 +1,15 @@
 /**
  * @typedef {import('../fluentApi.js').FluentApi} FluentApi
+ */
+
+/**
  * @typedef {Object} FileInfoDTO
+ * @property {string} FileName
+ * @property {number} FileSize
+ * @property {string} Modified - ISO date string
+ * @property {string} Created - ISO date string
+ * @property {string | null} GueltigBis - ISO date string
+ * @property {string | null} MandantGuid
  */
 
 /**

package/api/business/systemApi.js

@@ -3,11 +3,24 @@
  * @typedef {import('../dtos/index.js').ChangeDTO} ChangeDTO
  * @typedef {import('../dtos/index.js').TagInfoDTO} TagInfoDTO
  * @typedef {import('../dtos/index.js').TagVorlageDTO} TagVorlageDTO
- * @typedef {Object} FilterItemDTO
  * @typedef {import('../dtos/index.js').ChangeInfoDTO} ChangeInfoDTO
  * @typedef {import('../dtos/index.js').UpdateInfoDTO} UpdateInfoDTO
  */
 
+/**
+ * @typedef {Object} FilterItemDTO
+ * @property {string} FilterGuid
+ * @property {string} MandantGuid
+ * @property {string} BenutzerGuid
+ * @property {string} Title
+ * @property {string} Context
+ * @property {string} SerializedFilterSetting
+ * @property {number} Version
+ * @property {string} ChangedDate - ISO date string
+ * @property {boolean} IsDeleted
+ * @property {number} Reihenfolge
+ */
+
 /**
  * System API - System administration and configuration
  * @param {FluentApi} fluentApi

package/api/business/uiApi.js

@@ -5,7 +5,7 @@
  * @typedef {import('../dtos/index.js').UIEingabeFeldInfoDTO} UIEingabeFeldInfoDTO
  * @typedef {import('../dtos/index.js').TagInfoDTO} TagInfoDTO
  * @typedef {import('../dtos/index.js').TagVorlageDTO} TagVorlageDTO
- * @typedef {Object} FilterItemDTO
+ * @typedef {import('./systemApi.js').FilterItemDTO} FilterItemDTO
  */
 
 /**

package/api/neherApp3Types.js

@@ -96,6 +96,74 @@
  * @property {NeherApp3ErfassungCache} erfassung
  */
 
+/**
+ * A single message envelope delivered to handlers.
+ * @typedef {Object} NeherMessage
+ * @property {string} id - Unique message id (`crypto.randomUUID`).
+ * @property {string} type - Message kind, e.g. `"artikel.selected"`.
+ * @property {string | null} to - Target module name (directed) or `null` (broadcast).
+ * @property {string | null} from - Sender module name (stamped by the endpoint) or `null`.
+ * @property {any} payload - Arbitrary payload.
+ * @property {number} ts - Timestamp (`Date.now`).
+ */
+
+/**
+ * Handler invoked with the full message envelope.
+ * @callback MessageHandler
+ * @param {NeherMessage} message
+ * @returns {void}
+ */
+
+/**
+ * Subscription type pattern: exact (`"a.b"`), prefix glob (`"a.*"`), all (`"*"`)
+ * or a list of patterns.
+ * @typedef {string | string[]} TypePattern
+ */
+
+/**
+ * Options for `send`/`broadcast`.
+ * @typedef {Object} SendOptions
+ * @property {string} [from] - Sender module name (bus-level `send`/`broadcast` only; set automatically via an endpoint).
+ * @property {boolean} [retain] - Keep this `(to, type)` as a last value; subscribers that register later receive it immediately. Default `false`.
+ * @property {boolean} [requireRecipient] - If nobody received it, call `onUndeliverable` instead of silently dropping. Default `false`.
+ * @property {boolean} [deliverWhenAvailable] - If nobody is listening, buffer the directed message and deliver it when the target registers. Default `false`.
+ * @property {boolean} [echo] - For broadcast: also deliver to the sender itself. Default `false`.
+ * @property {number} [ttlMs] - Lifetime for buffered messages. Default `30000`.
+ * @property {(message: NeherMessage) => void} [onUndeliverable] - Callback invoked with the envelope when `requireRecipient` and no recipient.
+ */
+
+/**
+ * Delivery information returned by `send`/`broadcast` — never the result of a handler.
+ * @typedef {Object} Delivery
+ * @property {boolean} delivered - At least one recipient was reached.
+ * @property {number} recipients - Number of distinct modules delivered to.
+ * @property {boolean} queued - Buffered for a later recipient.
+ */
+
+/**
+ * A registered endpoint, returned by `messages.register`. `register` is
+ * idempotent; each handle's `dispose` only removes subscriptions made through it.
+ * @typedef {Object} Endpoint
+ * @property {string} name - The module name of this endpoint.
+ * @property {(type: TypePattern, handler: MessageHandler) => (() => void)} on - Subscribe; returns an unsubscribe function.
+ * @property {(to: string, type: string, payload?: any, options?: SendOptions) => Delivery} send - Directed message (`from` is stamped automatically).
+ * @property {(type: string, payload?: any, options?: SendOptions) => Delivery} broadcast - Broadcast (`from` is stamped automatically).
+ * @property {() => void} dispose - Remove all subscriptions created through this handle.
+ */
+
+/**
+ * In-realm message bus for module-to-module communication, exposed at
+ * `neherapp3.messages`. Messaging, not RPC: `send`/`broadcast` return delivery
+ * information, never a handler's result.
+ * @typedef {Object} NeherApp3Messages
+ * @property {(moduleName: string) => Endpoint} register - Register a module as a reachable endpoint.
+ * @property {(to: string, type: string, payload?: any, options?: SendOptions) => Delivery} send - Directed message (`from` via `options.from`).
+ * @property {(type: string, payload?: any, options?: SendOptions) => Delivery} broadcast - Broadcast to all subscribers (`from` via `options.from`).
+ * @property {(moduleName: string) => boolean} isReachable - Does the module have at least one live handler?
+ * @property {(moduleName: string) => boolean} isKnown - Is the module registered (loaded via `addApp`)?
+ * @property {string[]} reachable - Reactive list of all currently reachable module names.
+ */
+
 /**
  * @typedef {Object} NeherApp3
  * @property {(menuItem: NeherApp3MenuItem) => void} addMenuItem - Adds a menu item. If an item with the same `id` already exists it is replaced.
@@ -105,6 +173,7 @@
  * @property {(message: string, type?: NeherApp3NotifyType, cb?: function) => void} notify - Shows a notification. Type defaults to 0 (info). Callback is optional.
  * @property {NeherApp3ApiCollection} api
  * @property {NeherApp3CacheCollection} cache
+ * @property {NeherApp3Messages} messages - In-realm message bus for module-to-module communication.
  * @property {boolean} isEmbedded - Indicates if the app is embedded inside i3
  */
 

package/index.d.ts

@@ -93,6 +93,30 @@ export type AnpassungApi = {
     vorlage: { getAll: () => Promise<AnpassungVorlageDTO[]>; get: (guid: string) => Promise<AnpassungVorlageDTO>; save: (dto: AnpassungVorlageDTO) => Promise<void>; delete: (guid: string) => Promise<void> };
 };
 
+export type AnpassungDTO = {
+    AnpassungGuid: string;
+    Art: string;
+    GiltFuerBesitzer: boolean;
+    GiltFuerAlleUntermandanten: boolean;
+    GiltFuerZielMandant: boolean;
+    ZielMandantGuid: string;
+    Content: string;
+    WarengruppeGuid: string;
+    ArtikelGuid: string;
+    Version: number;
+    ChangedDate: string;
+};
+
+export type AnpassungVorlageDTO = {
+    AnpassungVorlageGuid: string;
+    Art: string;
+    Name: string;
+    Beschreibung: string;
+    Content: string;
+    Version: number;
+    ChangedDate: string;
+};
+
 export type ApiVersionDTO = {
     Version: string;
     Environment: string;
@@ -212,6 +236,34 @@ export type AvApi = {
     material: { serieBerechnen: (serieGuid: string) => Promise<void>; getForSerie: (serieGuid: string) => Promise<MaterialbedarfDTO[]>; getOffenerBedarfV2: (serieGuid: string, filterCsvExportedMaterial?: boolean) => Promise<MaterialbedarfDTO[]>; getOffenerBedarf: (serieGuid: string) => Promise<MaterialbedarfDTO[]>; resetForSerie: (serieGuid: string) => Promise<void>; berechnenForFunction: (serieGuid: string, mandantId: number) => Promise<string[]>; resetFromAvPosForFunction: (avPosGuid: string, mandantId: number) => Promise<string[]>; addOrUpdate: (dto: MaterialbedarfDTO) => Promise<SerienMaterialEditDTO>; delete: (materialbedarfGuid: string) => Promise<void> };
 };
 
+export type AvReportBelegDto = {
+    BelegGuid: string;
+    BelegAdresse: BeleganschriftDTO;
+    VersandAdresse: BeleganschriftDTO;
+    VersandAdresseGleichBelegAdresse: boolean;
+    BelegArt: string;
+    Terminwunsch: string;
+    IstSelbstabholer: boolean;
+};
+
+export type AvReportKontaktDto = {
+    KundenNummer: string;
+    Land: string;
+};
+
+export type AvReportVorgangDto = {
+    VorgangGuid: string;
+    VorgangsNummer: number;
+    Kommission: string;
+    Kommission2: string;
+    Belege: Array<AvReportBelegDto>;
+    Kunde: AvReportKontaktDto;
+};
+
+export type AvReportVorgangRequestDto = {
+    VorgangGuids: Array<string>;
+};
+
 export type AVReserviertItemDTO = {
     Variante: string;
     ArtikelNummer: string;
@@ -853,6 +905,12 @@ export type CsvExportCombinationDTO = {
     ExportFarbArten: ExportFarbArt[];
 };
 
+export type Delivery = {
+    delivered: boolean;
+    recipients: number;
+    queued: boolean;
+};
+
 export type DevOpsStatusDTO = {
     Env: string;
     DbInfo: string;
@@ -860,6 +918,14 @@ export type DevOpsStatusDTO = {
     PendingMigrations: string[];
 };
 
+export type Endpoint = {
+    name: string;
+    on: (type: TypePattern, handler: MessageHandler) => (() => void);
+    send: (to: string, type: string, payload?: any, options?: SendOptions) => Delivery;
+    broadcast: (type: string, payload?: any, options?: SendOptions) => Delivery;
+    dispose: () => void;
+};
+
 export type EnvironmentConfig = {
     name: string;
     version: string;
@@ -1018,6 +1084,28 @@ export type FileApi = {
     data: { get: (filename: string) => Promise<Uint8Array>; getList: (directory?: string) => Promise<FileInfoDTO[]>; save: (fileName: string, data: Uint8Array) => Promise<void>; delete: (filename: string) => Promise<void> };
 };
 
+export type FileInfoDTO = {
+    FileName: string;
+    FileSize: number;
+    Modified: string;
+    Created: string;
+    GueltigBis: string | null;
+    MandantGuid: string | null;
+};
+
+export type FilterItemDTO = {
+    FilterGuid: string;
+    MandantGuid: string;
+    BenutzerGuid: string;
+    Title: string;
+    Context: string;
+    SerializedFilterSetting: string;
+    Version: number;
+    ChangedDate: string;
+    IsDeleted: boolean;
+    Reihenfolge: number;
+};
+
 export type FluentApi = {
     baseUrl: string;
     authManager: FluentAuthManager|null;
@@ -1841,7 +1929,7 @@ export type MaterialBearbeitungsMethodeDTO = {
     ChangedDate: string;
 };
 
-export type MaterialbedarfCutOptimization = object.<string, any>;
+export type MaterialbedarfCutOptimization = Record<string, any>;
 
 export type MaterialbedarfDTO = {
     MaterialBedarfGuid: string;
@@ -1942,6 +2030,8 @@ export type MaterialDTO = {
     MoeglicheBearbeitungsMethoden: Array<string>;
 };
 
+export type MessageHandler = (message: NeherMessage) => void;
+
 export type NachrichtenDTO = {
     NachrichtGuid: string;
     MandantGuid: string;
@@ -1961,6 +2051,7 @@ export type NeherApp3 = {
     notify: (message: string, type?: NeherApp3NotifyType, cb?: Function) => void;
     api: NeherApp3ApiCollection;
     cache: NeherApp3CacheCollection;
+    messages: NeherApp3Messages;
     isEmbedded: boolean;
 };
 
@@ -2001,6 +2092,15 @@ export type NeherApp3MenuItem = {
     separator?: boolean;
 };
 
+export type NeherApp3Messages = {
+    register: (moduleName: string) => Endpoint;
+    send: (to: string, type: string, payload?: any, options?: SendOptions) => Delivery;
+    broadcast: (type: string, payload?: any, options?: SendOptions) => Delivery;
+    isReachable: (moduleName: string) => boolean;
+    isKnown: (moduleName: string) => boolean;
+    reachable: string[];
+};
+
 export type NeherApp3Module = {
     moduleName: string;
     setup?: (context: NeherApp3SetupContext) => void | Promise<void>;
@@ -2021,6 +2121,15 @@ export type NeherApp3Props = {
 
 export type NeherApp3SetupContext = NeherApp3Props & { neherapp3: NeherApp3 };
 
+export type NeherMessage = {
+    id: string;
+    type: string;
+    to: string | null;
+    from: string | null;
+    payload: any;
+    ts: number;
+};
+
 export type OberflaecheDTO = {
     OberflaecheGuid: string;
     Bezeichnung: string;
@@ -2095,11 +2204,11 @@ export type PreisermittlungsEinstellungenDTO = {
     EndpreisRundungsModus: string;
     SonderfarbZuschlaege: string;
     BruttoPreisErmitteln: boolean;
-    AufpreisAnpassungen: object.<string, AufpreisAnpassungDTO[]>;
-    PreisfaktorAnpassungen: object.<string, number>;
-    ZuschnittpreisfaktorAnpassungen: object.<string, number>;
-    AufpreisfaktorAnpassungen: object.<string, number>;
-    GrenzfreigabeAnpassungen: object.<string, boolean>;
+    AufpreisAnpassungen: Record<string, AufpreisAnpassungDTO[]>;
+    PreisfaktorAnpassungen: Record<string, number>;
+    ZuschnittpreisfaktorAnpassungen: Record<string, number>;
+    AufpreisfaktorAnpassungen: Record<string, number>;
+    GrenzfreigabeAnpassungen: Record<string, boolean>;
     MbAufpreis: number;
     Mb_v_Fix_Aufpreis: number|null;
     Mb_Klebeband_Aufpreis: number|null;
@@ -2548,6 +2657,16 @@ export type SchnittKonturOperationDTO = {
 
 export type SchnittoptimierungsOptionen = ('Keine'|'Lieferdatum'|'Serie'|'FarbeOberflaeche');
 
+export type SendOptions = {
+    from?: string;
+    retain?: boolean;
+    requireRecipient?: boolean;
+    deliverWhenAvailable?: boolean;
+    echo?: boolean;
+    ttlMs?: number;
+    onUndeliverable?: (message: NeherMessage) => void;
+};
+
 export type SerieAuslastungDTO = {
     IstSumme: boolean;
     Produktfamilie: string;
@@ -2727,6 +2846,8 @@ export type TemplateDTO = {
     Benutzer: string;
 };
 
+export type TypePattern = string | string[];
+
 export type UiApi = {
     getAllUiDefinitions: () => Promise<UIDefinitionDTO[]>;
     getUiDefinition: (guid: string) => Promise<UIDefinitionDTO>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gandalan/weblibs",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "WebLibs for Gandalan JS/TS projects",
   "keywords": [
     "gandalan"
@@ -23,14 +23,14 @@
   "dependencies": {
     "@mdi/js": "^7.4.47",
     "jwt-decode": "^4.0.0",
-    "validator": "^13.12.0"
+    "validator": "^13.15.35"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.9",
-    "@babel/eslint-parser": "^7.26.8",
-    "@eslint/js": "^9.21.0",
-    "eslint": "^9.21.0",
-    "globals": "^15.15.0"
+    "@babel/core": "^8.0.1",
+    "@babel/eslint-parser": "^8.0.1",
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.5.0",
+    "globals": "^17.7.0"
   },
   "publishConfig": {
     "access": "public",

package/scripts/generate-dts.mjs

@@ -429,7 +429,7 @@ function parseObjectLiteralProperties(objectSource, scopeTypeMap) {
 
         index = skipWhitespaceAndComments(objectSource, index);
 
-        let typeExpression = "any";
+        let typeExpression;
         let optional = false;
 
         if (objectSource[index] === ":") {
@@ -858,35 +858,56 @@ function isSimpleImportAlias(typeExpression) {
     return simpleImportTypePattern.test(typeExpression.replace(/\s+/g, ""));
 }
 
+function splitBlockByTagBoundaries(normalizedBlock) {
+    const tagPattern = /@(?:typedef|callback)\b/g;
+    const startIndices = [];
+    let match;
+
+    while ((match = tagPattern.exec(normalizedBlock)) !== null) {
+        startIndices.push(match.index);
+    }
+
+    if (startIndices.length <= 1) {
+        return [normalizedBlock];
+    }
+
+    return startIndices.map((startIndex, position) => {
+        const endIndex = position + 1 < startIndices.length ? startIndices[position + 1] : normalizedBlock.length;
+        return normalizedBlock.slice(startIndex, endIndex);
+    });
+}
+
 function extractPublicTypeEntries(source, filePath) {
     const entries = [];
 
     for (const block of getJSDocBlocks(source).map(normalizeJSDocBlock)) {
-        const typedefEntry = extractTypedefEntry(block);
+        for (const segment of splitBlockByTagBoundaries(block)) {
+            const typedefEntry = extractTypedefEntry(segment);
 
-        if (typedefEntry) {
-            const inferredCreateApiName = typedefEntry.typeExpression.match(returnTypeOfCreateApiPattern)?.[1] ?? null;
+            if (typedefEntry) {
+                const inferredCreateApiName = typedefEntry.typeExpression.match(returnTypeOfCreateApiPattern)?.[1] ?? null;
 
-            if (inferredCreateApiName) {
-                const inferredObjectEntry = inferReturnTypeObjectEntry(source, filePath, typedefEntry.name, inferredCreateApiName);
+                if (inferredCreateApiName) {
+                    const inferredObjectEntry = inferReturnTypeObjectEntry(source, filePath, typedefEntry.name, inferredCreateApiName);
 
-                if (inferredObjectEntry) {
-                    entries.push(inferredObjectEntry);
-                    continue;
+                    if (inferredObjectEntry) {
+                        entries.push(inferredObjectEntry);
+                        continue;
+                    }
                 }
-            }
 
-            if (!isSimpleImportAlias(typedefEntry.typeExpression)) {
-                entries.push({ ...typedefEntry, filePath });
-            }
+                if (!isSimpleImportAlias(typedefEntry.typeExpression)) {
+                    entries.push({ ...typedefEntry, filePath });
+                }
 
-            continue;
-        }
+                continue;
+            }
 
-        const callbackEntry = extractCallbackEntry(block);
+            const callbackEntry = extractCallbackEntry(segment);
 
-        if (callbackEntry) {
-            entries.push({ ...callbackEntry, filePath });
+            if (callbackEntry) {
+                entries.push({ ...callbackEntry, filePath });
+            }
         }
     }
 
@@ -940,15 +961,20 @@ function replaceObjectGenerics(typeExpression, transformTypeExpression) {
     let result = "";
 
     for (let index = 0; index < typeExpression.length; index += 1) {
-        if (!typeExpression.startsWith("Object<", index)) {
+        // Support both the TypeScript form (Object<...>) and the dotted JSDoc form (Object.<...>).
+        const isDottedForm = typeExpression.startsWith("Object.<", index);
+        const isPlainForm = typeExpression.startsWith("Object<", index);
+
+        if (!isDottedForm && !isPlainForm) {
             result += typeExpression[index];
             continue;
         }
 
+        const openAngleIndex = index + (isDottedForm ? "Object.".length : "Object".length);
         let angleDepth = 0;
         let closingIndex = -1;
 
-        for (let cursor = index + "Object".length; cursor < typeExpression.length; cursor += 1) {
+        for (let cursor = openAngleIndex; cursor < typeExpression.length; cursor += 1) {
             const character = typeExpression[cursor];
 
             if (character === "<") {
@@ -968,7 +994,7 @@ function replaceObjectGenerics(typeExpression, transformTypeExpression) {
             continue;
         }
 
-        const genericContent = typeExpression.slice(index + "Object<".length, closingIndex);
+        const genericContent = typeExpression.slice(openAngleIndex + 1, closingIndex);
         const genericParts = splitTopLevel(genericContent, ",");
 
         if (genericParts.length === 2) {