@gandalan/weblibs 1.5.17 → 1.5.19

package/api/business/serienApi.js

@@ -0,0 +1,375 @@
+/**
+ * Serien API - Combined API for Serien (Series) and AV (Arbeitsvorbereitung) operations
+ * Combines functionality from SerienWebRoutinen and AVWebRoutinen
+ *
+ * @module api/business/serienApi
+ */
+
+/**
+ * @typedef {import('../dtos/produktion.js').SerieDTO} SerieDTO
+ * @typedef {import('../dtos/index.js').SerieAuslastungDTO} SerieAuslastungDTO
+ * @typedef {import('../dtos/index.js').VirtualSerieWithAuslastungDTO} VirtualSerieWithAuslastungDTO
+ * @typedef {import('../dtos/index.js').BelegPositionAVDTO} BelegPositionAVDTO
+ * @typedef {import('../dtos/index.js').PositionSerieItemDTO} PositionSerieItemDTO
+ * @typedef {import('../fluentApi.js').FluentApi} FluentApi
+ */
+
+/**
+ * Creates a Serien API instance with methods for managing series and AV positions
+ *
+ * @param {FluentApi} fluentApi - The fluent API client instance
+ * @returns {SerienApi} The configured Serien API instance
+ */
+export function createSerienApi(fluentApi) {
+    return {
+        fluentApi,
+
+        // ============================================================================
+        // Serie Operations (from SerienWebRoutinen)
+        // ============================================================================
+
+        /**
+         * Releases elements from a series
+         * @param {string} fromSerie - GUID of the series to release elements from
+         * @returns {Promise<void>}
+         */
+        async releaseElemente(fromSerie) {
+            await this.fluentApi.get(`Serie/ReleaseElemente?fromSerie=${fromSerie}`);
+        },
+
+        /**
+         * Moves elements from one series to another
+         * @param {string} fromSerie - GUID of the source series
+         * @param {string} toSerie - GUID of the target series
+         * @returns {Promise<string>}
+         */
+        async moveElemente(fromSerie, toSerie) {
+            return await this.fluentApi.get(`Serie/MoveElemente?fromSerie=${fromSerie}&toSerie=${toSerie}`);
+        },
+
+        /**
+         * Redistributes elements within a series
+         * @param {string} fromSerie - GUID of the series to redistribute elements in
+         * @returns {Promise<string>}
+         */
+        async redistributeElemente(fromSerie) {
+            return await this.fluentApi.get(`Serie/RedistributeElemente?fromSerie=${fromSerie}`);
+        },
+
+        /**
+         * Gets all series
+         * @returns {Promise<SerieDTO[]>}
+         */
+        async getAllSerien() {
+            return await this.fluentApi.get("Serie");
+        },
+
+        /**
+         * Gets all series changed since a specific date
+         * @param {Date} changedSince - Date to filter changes since
+         * @returns {Promise<SerieDTO[]>}
+         */
+        async getAllSerienChangedSince(changedSince) {
+            return await this.fluentApi.get(`Serie/?changedSince=${changedSince.toISOString()}`);
+        },
+
+        /**
+         * Gets a specific series by GUID
+         * @param {string} guid - GUID of the series
+         * @returns {Promise<SerieDTO>}
+         */
+        async getSerie(guid) {
+            return await this.fluentApi.get(`Serie/${guid}`);
+        },
+
+        /**
+         * Saves a series
+         * @param {SerieDTO} serie - The series to save
+         * @returns {Promise<void>}
+         */
+        async saveSerie(serie) {
+            await this.fluentApi.put("Serie", serie);
+        },
+
+        /**
+         * Deletes a series by GUID
+         * @param {string} guid - GUID of the series to delete
+         * @returns {Promise<void>}
+         */
+        async deleteSerie(guid) {
+            await this.fluentApi.delete(`Serie/${guid}`);
+        },
+
+        /**
+         * Gets capacity utilization for a series
+         * @param {string} serie - GUID of the series
+         * @returns {Promise<SerieAuslastungDTO[]>}
+         */
+        async getAuslastung(serie) {
+            return await this.fluentApi.get(`Auslastung/${serie}`);
+        },
+
+        /**
+         * Gets total capacity utilization across all series
+         * @param {boolean} [includeAbgelaufene=false] - Whether to include expired series
+         * @returns {Promise<Record<string, SerieAuslastungDTO[]>>}
+         */
+        async getGesamtAuslastung(includeAbgelaufene = false) {
+            return await this.fluentApi.get(`Auslastung/?includeAbgelaufene=${includeAbgelaufene}`);
+        },
+
+        /**
+         * Gets series capacities for a date range
+         * @param {Date} [startDate] - Start date of the range
+         * @param {Date} [endDate] - End date of the range
+         * @param {boolean} [includeStaendige=false] - Whether to include permanent series
+         * @returns {Promise<Record<string, SerieAuslastungDTO[]>>}
+         */
+        async getSerienKapazitaeten(startDate = null, endDate = null, includeStaendige = false) {
+            const startParam = startDate ? startDate.toISOString() : "";
+            const endParam = endDate ? endDate.toISOString() : "";
+            return await this.fluentApi.get(`SerieKapazitaet/?startDate=${startParam}&endDate=${endParam}&includeStaendige=${includeStaendige}`);
+        },
+
+        /**
+         * Gets capacity utilization for virtual series within a date range
+         * @param {Date} [startDate] - Start date of the range
+         * @param {Date} [endDate] - End date of the range
+         * @returns {Promise<VirtualSerieWithAuslastungDTO[]>}
+         */
+        async getAuslastungVirtualSerien(startDate = null, endDate = null) {
+            const startParam = startDate ? startDate.toISOString() : "";
+            const endParam = endDate ? endDate.toISOString() : "";
+            return await this.fluentApi.get(`AuslastungVirtual/?startDate=${startParam}&endDate=${endParam}`);
+        },
+
+        /**
+         * Gets capacity utilization for a range of order numbers
+         * @param {number} startVorgangsnummer - Start order number
+         * @param {number} endVorgangsnummer - End order number
+         * @returns {Promise<SerieAuslastungDTO[]>}
+         */
+        async getAuslastungVorgang(startVorgangsnummer, endVorgangsnummer) {
+            return await this.fluentApi.get(`AuslastungVorgang/?startVorgangsnummer=${startVorgangsnummer}&endVorgangsnummer=${endVorgangsnummer}`);
+        },
+
+        // ============================================================================
+        // AV Position Operations (from AVWebRoutinen)
+        // ============================================================================
+
+        /**
+         * Gets all AV positions
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getAllBelegPositionenAV() {
+            return await this.fluentApi.get("BelegPositionenAV");
+        },
+
+        /**
+         * Gets all AV positions changed since a specific date
+         * @param {Date} changedSince - Date to filter changes since
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getAllBelegPositionenAVChangedSince(changedSince) {
+            return await this.fluentApi.get(`BelegPositionenAV/?changedSince=${changedSince.toISOString()}`);
+        },
+
+        /**
+         * Gets all AV positions with optional filtering
+         * @param {boolean} [includeOriginalBeleg=true] - Whether to include original order data
+         * @param {boolean} [includeProdDaten=true] - Whether to include production data
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getAllBelegPositionenAVWithOptions(includeOriginalBeleg = true, includeProdDaten = true) {
+            return await this.fluentApi.get(`BelegPositionenAV?includeOriginalBeleg=${includeOriginalBeleg}&includeProdDaten=${includeProdDaten}`);
+        },
+
+        /**
+         * Gets all AV positions changed since a specific date with optional filtering
+         * @param {Date} changedSince - Date to filter changes since
+         * @param {boolean} [includeOriginalBeleg=true] - Whether to include original order data
+         * @param {boolean} [includeProdDaten=true] - Whether to include production data
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getAllBelegPositionenAVChangedSinceWithOptions(changedSince, includeOriginalBeleg = true, includeProdDaten = true) {
+            return await this.fluentApi.get(`BelegPositionenAV/?changedSince=${changedSince.toISOString()}&includeOriginalBeleg=${includeOriginalBeleg}&includeProdDaten=${includeProdDaten}`);
+        },
+
+        /**
+         * Gets AV positions for a specific series
+         * @param {string} serieGuid - GUID of the series
+         * @param {boolean} [includeOriginalBeleg=true] - Whether to include original order data
+         * @param {boolean} [includeProdDaten=true] - Whether to include production data
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getSerieBelegPositionenAV(serieGuid, includeOriginalBeleg = true, includeProdDaten = true) {
+            return await this.fluentApi.get(`BelegPositionenAV/?serieGuid=${serieGuid}&includeOriginalBeleg=${includeOriginalBeleg}&includeProdDaten=${includeProdDaten}`);
+        },
+
+        /**
+         * Gets AV positions for a specific order (Vorgang)
+         * @param {string} vorgangGuid - GUID of the order
+         * @param {boolean} [includeOriginalBeleg=true] - Whether to include original order data
+         * @param {boolean} [includeProdDaten=true] - Whether to include production data
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getVorgangBelegPositionenAV(vorgangGuid, includeOriginalBeleg = true, includeProdDaten = true) {
+            return await this.fluentApi.get(`BelegPositionenAV/?vorgangGuid=${vorgangGuid}&includeOriginalBeleg=${includeOriginalBeleg}&includeProdDaten=${includeProdDaten}`);
+        },
+
+        /**
+         * Gets AV positions for multiple orders
+         * @param {string[]} vorgangGuids - Array of order GUIDs
+         * @param {boolean} [includeOriginalBeleg=true] - Whether to include original order data
+         * @param {boolean} [includeProdDaten=true] - Whether to include production data
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getVorgaengeBelegPositionenAV(vorgangGuids, includeOriginalBeleg = true, includeProdDaten = true) {
+            const vorgangGuidsString = vorgangGuids.map(g => `vorgangGuids=${encodeURIComponent(g)}`).join("&");
+            return await this.fluentApi.get(`BelegPositionenAVByVorgangIds/?${vorgangGuidsString}&includeOriginalBeleg=${includeOriginalBeleg}&includeProdDaten=${includeProdDaten}`);
+        },
+
+        /**
+         * Gets AV positions for a specific order position
+         * @param {string} belegpositionGuid - GUID of the order position
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getBelegPositionenAV(belegpositionGuid) {
+            return await this.fluentApi.get(`BelegPositionenAV/${belegpositionGuid}`);
+        },
+
+        /**
+         * Gets a single AV position by its GUID
+         * @param {string} avGuid - GUID of the AV position
+         * @returns {Promise<BelegPositionAVDTO>}
+         */
+        async getBelegPositionAVById(avGuid) {
+            return await this.fluentApi.get(`BelegPositionenAVById/${avGuid}`);
+        },
+
+        /**
+         * Gets AV positions by PCode
+         * @param {string} pcode - The PCode to search for
+         * @param {boolean} [includeOriginalBeleg=true] - Whether to include original order data
+         * @param {boolean} [includeProdDaten=true] - Whether to include production data
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async getBelegPositionAVByPCode(pcode, includeOriginalBeleg = true, includeProdDaten = true) {
+            return await this.fluentApi.get(`BelegPositionenAVByPCode/${encodeURIComponent(pcode)}?includeOriginalBeleg=${includeOriginalBeleg}&includeProdDaten=${includeProdDaten}`);
+        },
+
+        /**
+         * Searches AV positions by PCode with wildcard search
+         * @param {string} search - The search string
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async searchBelegPositionAVByPCode(search) {
+            return await this.fluentApi.get(`BelegPositionenAVSearchByPCode?search=${encodeURIComponent(search)}`);
+        },
+
+        /**
+         * Saves a single AV position
+         * @param {BelegPositionAVDTO} position - The AV position to save
+         * @returns {Promise<void>}
+         */
+        async saveBelegPositionenAV(position) {
+            await this.fluentApi.put("BelegPositionenAV", position);
+        },
+
+        /**
+         * Saves multiple AV positions
+         * @param {BelegPositionAVDTO[]} positionen - Array of AV positions to save
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async saveBelegPositionenAVBulk(positionen) {
+            return await this.fluentApi.put("BelegPositionenAVBulk", positionen);
+        },
+
+        /**
+         * Saves AV positions to a specific series
+         * @param {string} serieGuid - GUID of the target series
+         * @param {string[]} positionen - Array of AV position GUIDs to add
+         * @returns {Promise<BelegPositionAVDTO[]>}
+         */
+        async saveBelegPositionenAVToSerie(serieGuid, positionen) {
+            return await this.fluentApi.put(`BelegPositionenAVBulk/AddToSerie/${serieGuid}`, positionen);
+        },
+
+        /**
+         * Triggers AV calculation for the specified positions
+         * @param {string[]} guids - Array of AV position GUIDs to calculate
+         * @returns {Promise<void>}
+         */
+        async belegPositionenAVBerechnen(guids) {
+            await this.fluentApi.put("BelegPositionenAVBulk/AVBerechnung", guids);
+        },
+
+        /**
+         * Deletes a single AV position
+         * @param {string} guid - GUID of the AV position to delete
+         * @returns {Promise<void>}
+         */
+        async deleteBelegPositionenAV(guid) {
+            await this.fluentApi.delete(`BelegPositionenAV/${guid}`);
+        },
+
+        /**
+         * Deletes multiple AV positions
+         * @param {string[]} guids - Array of AV position GUIDs to delete
+         * @returns {Promise<void>}
+         */
+        async deleteBelegPositionenAVBulk(guids) {
+            await this.fluentApi.delete("BelegPositionenAVBulk", guids);
+        },
+
+        /**
+         * Assigns order positions to series
+         * @param {string} belegGuid - GUID of the order
+         * @param {PositionSerieItemDTO[]} positionSerieItems - Array of position-to-series assignments
+         * @returns {Promise<void>}
+         */
+        async belegPositionenSerienZuordnen(belegGuid, positionSerieItems) {
+            await this.fluentApi.put(`BelegPositionenAVBulk/SerienZuorden/${belegGuid}`, positionSerieItems);
+        },
+    };
+}
+
+/**
+ * @typedef {Object} SerienApi
+ * @property {FluentApi} fluentApi
+ *
+ * // Serie Operations
+ * @property {(fromSerie: string) => Promise<void>} releaseElemente
+ * @property {(fromSerie: string, toSerie: string) => Promise<string>} moveElemente
+ * @property {(fromSerie: string) => Promise<string>} redistributeElemente
+ * @property {() => Promise<SerieDTO[]>} getAllSerien
+ * @property {(changedSince: Date) => Promise<SerieDTO[]>} getAllSerienChangedSince
+ * @property {(guid: string) => Promise<SerieDTO>} getSerie
+ * @property {(serie: SerieDTO) => Promise<void>} saveSerie
+ * @property {(guid: string) => Promise<void>} deleteSerie
+ * @property {(serie: string) => Promise<SerieAuslastungDTO[]>} getAuslastung
+ * @property {(includeAbgelaufene?: boolean) => Promise<Record<string, SerieAuslastungDTO[]>>} getGesamtAuslastung
+ * @property {(startDate?: Date, endDate?: Date, includeStaendige?: boolean) => Promise<Record<string, SerieAuslastungDTO[]>>} getSerienKapazitaeten
+ * @property {(startDate?: Date, endDate?: Date) => Promise<VirtualSerieWithAuslastungDTO[]>} getAuslastungVirtualSerien
+ * @property {(startVorgangsnummer: number, endVorgangsnummer: number) => Promise<SerieAuslastungDTO[]>} getAuslastungVorgang
+ *
+ * // AV Position Operations
+ * @property {() => Promise<BelegPositionAVDTO[]>} getAllBelegPositionenAV
+ * @property {(changedSince: Date) => Promise<BelegPositionAVDTO[]>} getAllBelegPositionenAVChangedSince
+ * @property {(includeOriginalBeleg?: boolean, includeProdDaten?: boolean) => Promise<BelegPositionAVDTO[]>} getAllBelegPositionenAVWithOptions
+ * @property {(changedSince: Date, includeOriginalBeleg?: boolean, includeProdDaten?: boolean) => Promise<BelegPositionAVDTO[]>} getAllBelegPositionenAVChangedSinceWithOptions
+ * @property {(serieGuid: string, includeOriginalBeleg?: boolean, includeProdDaten?: boolean) => Promise<BelegPositionAVDTO[]>} getSerieBelegPositionenAV
+ * @property {(vorgangGuid: string, includeOriginalBeleg?: boolean, includeProdDaten?: boolean) => Promise<BelegPositionAVDTO[]>} getVorgangBelegPositionenAV
+ * @property {(vorgangGuids: string[], includeOriginalBeleg?: boolean, includeProdDaten?: boolean) => Promise<BelegPositionAVDTO[]>} getVorgaengeBelegPositionenAV
+ * @property {(belegpositionGuid: string) => Promise<BelegPositionAVDTO[]>} getBelegPositionenAV
+ * @property {(avGuid: string) => Promise<BelegPositionAVDTO>} getBelegPositionAVById
+ * @property {(pcode: string, includeOriginalBeleg?: boolean, includeProdDaten?: boolean) => Promise<BelegPositionAVDTO[]>} getBelegPositionAVByPCode
+ * @property {(search: string) => Promise<BelegPositionAVDTO[]>} searchBelegPositionAVByPCode
+ * @property {(position: BelegPositionAVDTO) => Promise<void>} saveBelegPositionenAV
+ * @property {(positionen: BelegPositionAVDTO[]) => Promise<BelegPositionAVDTO[]>} saveBelegPositionenAVBulk
+ * @property {(serieGuid: string, positionen: string[]) => Promise<BelegPositionAVDTO[]>} saveBelegPositionenAVToSerie
+ * @property {(guids: string[]) => Promise<void>} belegPositionenAVBerechnen
+ * @property {(guid: string) => Promise<void>} deleteBelegPositionenAV
+ * @property {(guids: string[]) => Promise<void>} deleteBelegPositionenAVBulk
+ * @property {(belegGuid: string, positionSerieItems: PositionSerieItemDTO[]) => Promise<void>} belegPositionenSerienZuordnen
+ */

package/api/business/settingsApi.js

@@ -0,0 +1,168 @@
+/**
+ * @typedef {import('../fluentApi.js').FluentApi} FluentApi
+ * @typedef {import('../dtos/index.js').PreisermittlungsEinstellungenDTO} PreisermittlungsEinstellungenDTO
+ * @typedef {import('../dtos/index.js').KonfigSatzInfoDTO} KonfigSatzInfoDTO
+ * @typedef {import('../dtos/index.js').WerteListeDTO} WerteListeDTO
+ * @typedef {import('../dtos/index.js').ContractDTO} ContractDTO
+ * @typedef {import('../dtos/index.js').TemplateDTO} TemplateDTO
+ * @typedef {import('../dtos/index.js').ChangeInfoDTO} ChangeInfoDTO
+ * @typedef {import('../dtos/index.js').UpdateInfoDTO} UpdateInfoDTO
+ */
+
+/**
+ * Settings API - Application settings and configuration
+ * @param {FluentApi} fluentApi
+ */
+export function createSettingsApi(fluentApi) {
+    return {
+    // SettingsWebRoutinen
+    /**
+     * Get all settings
+     * @returns {Promise<Record<string, object>>}
+     */
+        getAllSettings: () => fluentApi.get("Settings"),
+
+        /**
+     * Save setting
+     * @param {string} key
+     * @param {object} value
+     * @returns {Promise<void>}
+     */
+        saveSetting: (key, value) => fluentApi.put(`Settings/${key}`, value),
+
+        // PreiskonditionenWebRoutinen
+        /**
+     * Get price conditions
+     * @returns {Promise<PreisermittlungsEinstellungenDTO>}
+     */
+        getPreiskonditionen: () => fluentApi.get("Preiskonditionen/"),
+
+        /**
+     * Save price conditions
+     * @param {string} konditionen
+     * @returns {Promise<string>}
+     */
+        savePreiskonditionen: (konditionen) => fluentApi.put("Preiskonditionen/", konditionen),
+
+        // KonfigSatzInfoWebRoutinen
+        /**
+     * Get all config set info
+     * @returns {Promise<KonfigSatzInfoDTO[]>}
+     */
+        getAllKonfigSatzInfo: () => fluentApi.get("KonfigSatzInfo"),
+
+        /**
+     * Save config set info
+     * @param {KonfigSatzInfoDTO} konfigSatzInfo
+     * @returns {Promise<KonfigSatzInfoDTO>}
+     */
+        saveKonfigSatzInfo: (konfigSatzInfo) => fluentApi.put("KonfigSatzInfo", konfigSatzInfo),
+
+        // WertelistenWebRoutinen
+        /**
+     * Get all value lists
+     * @param {boolean} includeAutoWerteListen
+     * @returns {Promise<WerteListeDTO[]>}
+     */
+        getAllWertelisten: (includeAutoWerteListen) =>
+            fluentApi.get(`WerteListe?includeAutoWerteListen=${includeAutoWerteListen}`),
+
+        /**
+     * Get value list by GUID
+     * @param {string} wertelisteGuid
+     * @param {boolean} [includeAutoWerteListen=true]
+     * @returns {Promise<WerteListeDTO>}
+     */
+        getWerteliste: (wertelisteGuid, includeAutoWerteListen = true) =>
+            fluentApi.get(`WerteListe/${wertelisteGuid}?includeAutoWerteListen=${includeAutoWerteListen}`),
+
+        /**
+     * Save value list
+     * @param {WerteListeDTO} dto
+     * @returns {Promise<void>}
+     */
+        saveWerteliste: (dto) => fluentApi.put(`WerteListe/${dto.werteListeGuid}`, dto),
+
+        // ContractWebRoutinen
+        /**
+     * Get all contracts
+     * @returns {Promise<ContractDTO[]>}
+     */
+        getAllContracts: () => fluentApi.get("Contracts"),
+
+        /**
+     * Save contract
+     * @param {ContractDTO} dto
+     * @returns {Promise<ContractDTO>}
+     */
+        saveContract: (dto) => fluentApi.put("Contracts", dto),
+
+        /**
+     * Delete contract
+     * @param {ContractDTO} dto
+     * @returns {Promise<void>}
+     */
+        deleteContract: (dto) => fluentApi.delete(`Contracts/${dto.contractGuid}`),
+
+        // TemplateWebRoutinen
+        /**
+     * Get all templates
+     * @returns {Promise<TemplateDTO[]>}
+     */
+        getAllTemplates: () => fluentApi.get("Template"),
+
+        /**
+     * Get template by ID
+     * @param {string} id
+     * @returns {Promise<TemplateDTO>}
+     */
+        getTemplate: (id) => fluentApi.get(`Template?id=${id}`),
+
+        /**
+     * Save template
+     * @param {TemplateDTO} dto
+     * @returns {Promise<void>}
+     */
+        saveTemplate: (dto) => fluentApi.put(`Template/${dto.templateGuid}`, dto),
+
+        /**
+     * Delete template
+     * @param {string} templateGuid
+     * @returns {Promise<void>}
+     */
+        deleteTemplate: (templateGuid) => fluentApi.delete(`Template/${templateGuid}`),
+
+        // ChangeInfoWebRoutinen
+        /**
+     * Get change info
+     * @returns {Promise<ChangeInfoDTO>}
+     */
+        getChangeInfo: () => fluentApi.get("ChangeInfo"),
+
+        // UpdateInfoWebRoutinen
+        /**
+     * Get update info
+     * @returns {Promise<UpdateInfoDTO>}
+     */
+        getUpdateInfo: () => fluentApi.get("UpdateInfo"),
+
+        // DataMigrationHistoryWebRoutinen
+        /**
+     * Get data migration history version
+     * @returns {Promise<number>}
+     */
+        getDataMigrationHistoryVersion: () => fluentApi.get("DataMigrationHistory"),
+
+        /**
+     * Set data migration history version
+     * @param {number} newVersion
+     * @returns {Promise<void>}
+     */
+        setDataMigrationHistoryVersion: (newVersion) =>
+            fluentApi.put("DataMigrationHistory", newVersion.toString()),
+    };
+}
+
+/**
+ * @typedef {ReturnType<typeof createSettingsApi>} SettingsApi
+ */