@gandalan/weblibs 1.5.22 → 1.5.24

package/api/neherApp3Types.d.ts

@@ -0,0 +1,85 @@
+// Auto-generated NeherApp3 root type definitions.
+// Do not modify manually - changes will be overwritten by scripts/generate-root-dto-typedefs.mjs
+
+export type NeherApp3NotifyType = 0 | 1 | 2;
+
+export type ArtikelstammEintrag = {
+    KatalogArtikelGuid?: string;
+    KatalogNummer?: string;
+    Katalognummer?: string;
+    Nummer?: string;
+};
+
+export type Variante = {
+    VarianteGuid?: string;
+    Name?: string;
+    Kuerzel?: string;
+};
+
+export type Werteliste = {
+    WerteListeGuid?: string;
+    Name?: string;
+};
+
+export type NeherApp3ArtikelstammCache = {
+    getArtikelStamm: () => Promise<ArtikelstammEintrag[]>;
+    getWarenGruppen: () => Promise<object[]>;
+    getArtikelByGuid: (guid: string) => Promise<ArtikelstammEintrag | undefined>;
+    getArtikelByKatalognummer: (nummer: string) => Promise<ArtikelstammEintrag | undefined>;
+};
+
+export type NeherApp3ErfassungCache = {
+    getVarianten: () => Promise<Variante[]>;
+    getVariante: (variantenNameOderKuerzel: string) => Promise<Variante | undefined>;
+    getWertelisten: () => Promise<Werteliste[]>;
+    getWerteliste: (name: string) => Promise<Werteliste | undefined>;
+    getScripts: () => Promise<object[]>;
+    createUIMachine: (v: Variante) => void;
+};
+
+export type NeherApp3Props = {
+    api: import("./fluentApi.js").FluentApi;
+    authManager?: import("./fluentAuthManager.js").FluentAuthManager;
+    idas: import("./idasFluentApi.js").IDASFluentApi;
+    mainCssPath?: string;
+};
+
+export type NeherApp3MenuItem = {
+    id?: string;
+    selected?: boolean;
+    icon?: string;
+    url?: string | null;
+    text: string;
+    parent?: string | null;
+    hidden?: boolean;
+};
+
+export type NeherApp3SetupContext = NeherApp3Props & { neherapp3: NeherApp3 };
+
+export type NeherApp3Module = {
+    moduleName: string;
+    setup?: (context: NeherApp3SetupContext) => void | Promise<void>;
+    mount?: (node: HTMLElement, props: NeherApp3SetupContext) => void | Function;
+    embedUrl?: string;
+    extraCSS?: string[];
+    useShadowDom?: boolean;
+};
+
+export type NeherApp3ApiCollection = {
+    idas?: import("./idasFluentApi.js").IDASFluentApi;
+    hostingEnvironment?: import("./fluentApi.js").FluentApi;
+};
+
+export type NeherApp3CacheCollection = {
+    artikelstamm: NeherApp3ArtikelstammCache;
+    erfassung: NeherApp3ErfassungCache;
+};
+
+export type NeherApp3 = {
+    addMenuItem: (menuItem: NeherApp3MenuItem) => void;
+    addApp: (appModule: NeherApp3Module | string) => Promise<void>;
+    notify: (message: string, type?: NeherApp3NotifyType, cb?: Function) => void;
+    api: NeherApp3ApiCollection;
+    cache: NeherApp3CacheCollection;
+};
+

package/api/neherApp3Types.js

@@ -0,0 +1,107 @@
+/**
+ * Auto-generated NeherApp3 root type definitions.
+ * Do not modify manually - changes will be overwritten by scripts/generate-root-dto-typedefs.mjs
+ */
+
+/** @typedef {import("./fluentApi.js").FluentApi} FluentApi */
+/** @typedef {import("./idasFluentApi.js").IDASFluentApi} IDASFluentApi */
+/** @typedef {import("./fluentAuthManager.js").FluentAuthManager} FluentAuthManager */
+
+/**
+ * @typedef {0 | 1 | 2} NeherApp3NotifyType
+ */
+
+/**
+ * @typedef {Object} ArtikelstammEintrag
+ * @property {string} [KatalogArtikelGuid]
+ * @property {string} [KatalogNummer]
+ * @property {string} [Katalognummer]
+ * @property {string} [Nummer]
+ */
+
+/**
+ * @typedef {Object} Variante
+ * @property {string} [VarianteGuid]
+ * @property {string} [Name]
+ * @property {string} [Kuerzel]
+ */
+
+/**
+ * @typedef {Object} Werteliste
+ * @property {string} [WerteListeGuid]
+ * @property {string} [Name]
+ */
+
+/**
+ * @typedef {Object} NeherApp3ArtikelstammCache
+ * @property {() => Promise<ArtikelstammEintrag[]>} getArtikelStamm
+ * @property {() => Promise<Object[]>} getWarenGruppen
+ * @property {(guid: string) => Promise<ArtikelstammEintrag | undefined>} getArtikelByGuid
+ * @property {(nummer: string) => Promise<ArtikelstammEintrag | undefined>} getArtikelByKatalognummer
+ */
+
+/**
+ * @typedef {Object} NeherApp3ErfassungCache
+ * @property {() => Promise<Variante[]>} getVarianten
+ * @property {(variantenNameOderKuerzel: string) => Promise<Variante | undefined>} getVariante
+ * @property {() => Promise<Werteliste[]>} getWertelisten
+ * @property {(name: string) => Promise<Werteliste | undefined>} getWerteliste
+ * @property {() => Promise<Object[]>} getScripts
+ * @property {(v: Variante) => void} createUIMachine
+ */
+
+/**
+ * @typedef {Object} NeherApp3Props
+ * @property {import("./fluentApi.js").FluentApi} api
+ * @property {import("./fluentAuthManager.js").FluentAuthManager} [authManager]
+ * @property {import("./idasFluentApi.js").IDASFluentApi} idas
+ * @property {string} [mainCssPath]
+ */
+
+/**
+ * @typedef {Object} NeherApp3MenuItem
+ * @property {string} [id] - Unique identifier for the menu item (auto-generated if not provided)
+ * @property {boolean} [selected] - Indicates if the menu item is currently selected (managed by the menu system)
+ * @property {string} [icon] - URL to an icon
+ * @property {string | null} [url] - Relative URL to use for routes
+ * @property {string} text - Display text
+ * @property {string | null} [parent] - Parent menu item (optional). If not set, the item will be added to the top level menu.
+ * @property {boolean} [hidden] - If true, the menu item will not be displayed
+ */
+
+/**
+ * @typedef {NeherApp3Props & { neherapp3: NeherApp3 }} NeherApp3SetupContext
+ */
+
+/**
+ * @typedef {Object} NeherApp3Module
+ * @property {string} moduleName
+ * @property {(context: NeherApp3SetupContext) => void | Promise<void>} [setup]
+ * @property {(node: HTMLElement, props: NeherApp3SetupContext) => void | function} [mount] - Must return an optional unmount function
+ * @property {string} [embedUrl]
+ * @property {string[]} [extraCSS]
+ * @property {boolean} [useShadowDom] - If true, the app will be embedded in a shadow DOM. This is required for CSS isolation.
+ */
+
+/**
+ * @typedef {Object} NeherApp3ApiCollection
+ * @property {import("./idasFluentApi.js").IDASFluentApi} [idas]
+ * @property {import("./fluentApi.js").FluentApi} [hostingEnvironment]
+ */
+
+/**
+ * @typedef {Object} NeherApp3CacheCollection
+ * @property {NeherApp3ArtikelstammCache} artikelstamm
+ * @property {NeherApp3ErfassungCache} erfassung
+ */
+
+/**
+ * @typedef {Object} NeherApp3
+ * @property {(menuItem: NeherApp3MenuItem) => void} addMenuItem
+ * @property {(appModule: NeherApp3Module | string) => Promise<void>} addApp
+ * @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
+ */
+
+export {};