@gandalan/weblibs 1.5.28 → 1.5.29

package/api/neherApp3Types.js

@@ -102,6 +102,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 {boolean} isEmbedded - Indicates if the app is embedded inside i3
  */
 
 export {};

package/index.d.ts

@@ -1961,6 +1961,7 @@ export type NeherApp3 = {
     notify: (message: string, type?: NeherApp3NotifyType, cb?: Function) => void;
     api: NeherApp3ApiCollection;
     cache: NeherApp3CacheCollection;
+    isEmbedded: boolean;
 };
 
 export type NeherApp3ApiCollection = {

package/index.js

@@ -18,7 +18,7 @@ export * from "./api/dtos/index.js";
 
 // BEGIN GENERATED ROOT DTO TYPEDEFS
 // DTO Type Definitions - copied to the package root for stable JSDoc imports
-// This block is generated by scripts/generate-root-dto-typedefs.mjs from ./api/dtos/index.js
+// This block is generated by scripts/generate-dts.mjs from ./api/dtos/index.js
 /** @typedef {import("./api/dtos/index.js").ApiVersionDTO} ApiVersionDTO */
 /** @typedef {import("./api/dtos/index.js").ChangeDTO} ChangeDTO */
 /** @typedef {import("./api/dtos/index.js").ChangeInfoDTO} ChangeInfoDTO */
@@ -232,7 +232,7 @@ export * from "./ui/index.js";
 
 // BEGIN GENERATED ROOT BUSINESS TYPEDEFS
 // Business API Type Definitions - copied to the package root for stable JSDoc imports
-// This block is generated by scripts/generate-root-dto-typedefs.mjs from ./api/business/index.js
+// This block is generated by scripts/generate-dts.mjs from ./api/business/index.js
 /** @typedef {import("./api/business/index.js").AblageApi} AblageApi */
 /** @typedef {import("./api/business/index.js").AnpassungApi} AnpassungApi */
 /** @typedef {import("./api/business/index.js").ArtikelApi} ArtikelApi */
@@ -262,29 +262,10 @@ export * from "./ui/index.js";
 /** @typedef {import("./api/business/index.js").VorgangApi} VorgangApi */
 // END GENERATED ROOT BUSINESS TYPEDEFS
 
-/**
- * @typedef {import("./api/fluentApi").FluentApi} FluentApi
- * @typedef {import("./api/idasFluentApi").IDASFluentApi} IDASFluentApi
- * @typedef {import("./api/fluentAuthManager").FluentAuthManager} FluentAuthManager
- * @typedef {import("./api/neherApp3Types.js").NeherApp3NotifyType} NeherApp3NotifyType
- * @typedef {import("./api/neherApp3Types.js").ArtikelstammEintrag} ArtikelstammEintrag
- * @typedef {import("./api/neherApp3Types.js").Variante} Variante
- * @typedef {import("./api/neherApp3Types.js").Werteliste} Werteliste
- * @typedef {import("./api/neherApp3Types.js").NeherApp3ArtikelstammCache} NeherApp3ArtikelstammCache
- * @typedef {import("./api/neherApp3Types.js").NeherApp3ErfassungCache} NeherApp3ErfassungCache
- * @typedef {import("./api/neherApp3Types.js").NeherApp3Props} NeherApp3Props
- * @typedef {import("./api/neherApp3Types.js").NeherApp3MenuItem} NeherApp3MenuItem
- * @typedef {import("./api/neherApp3Types.js").NeherApp3SetupContext} NeherApp3SetupContext
- * @typedef {import("./api/neherApp3Types.js").NeherApp3Module} NeherApp3Module
- * @typedef {import("./api/neherApp3Types.js").NeherApp3ApiCollection} NeherApp3ApiCollection
- * @typedef {import("./api/neherApp3Types.js").NeherApp3CacheCollection} NeherApp3CacheCollection
- * @typedef {import("./api/neherApp3Types.js").NeherApp3} NeherApp3
- */
-
 /**
  * Global NeherApp3 instance
- * @type {NeherApp3}
+ * @type {import("./api/neherApp3Types.js").NeherApp3}
  * @global
  */
-globalThis.neherapp3 = /** @type {NeherApp3} */ (globalThis.neherapp3 || {});
+globalThis.neherapp3 = /** @type {import("./api/neherApp3Types.js").NeherApp3} */ (globalThis.neherapp3 || {});
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gandalan/weblibs",
-  "version": "1.5.28",
+  "version": "1.5.29",
   "description": "WebLibs for Gandalan JS/TS projects",
   "keywords": [
     "gandalan"
@@ -15,7 +15,7 @@
   "typings": "index.d.ts",
   "type": "module",
   "scripts": {
-    "generate:root-dto-typedefs": "node ./scripts/generate-root-dto-typedefs.mjs",
+    "generate:dts": "node ./scripts/generate-dts.mjs",
     "lint": "eslint .",
     "lint:prod": "eslint .",
     "lint:fix": "eslint . --fix"

package/scripts/{generate-root-dto-typedefs.mjs → generate-dts.mjs}

@@ -11,8 +11,6 @@ const rootDtsPath = path.join(rootDir, "index.d.ts");
 const dtoIndexPath = path.join(rootDir, "api", "dtos", "index.js");
 const businessIndexPath = path.join(rootDir, "api", "business", "index.js");
 const uiIndexPath = path.join(rootDir, "ui", "index.js");
-const neherApp3TypesJsPath = path.join(rootDir, "api", "neherApp3Types.js");
-const neherApp3TypesDtsPath = path.join(rootDir, "api", "neherApp3Types.d.ts");
 
 const dtoLeafDirectory = path.join(rootDir, "api", "dtos");
 const businessLeafDirectory = path.join(rootDir, "api", "business");
@@ -43,193 +41,6 @@ const rootFunctionDeclarationStatements = [
 const simpleImportTypePattern = /^import\((?:"|').+(?:"|')\)\.[A-Za-z0-9_$]+$/;
 const returnTypeOfCreateApiPattern = /^ReturnType<\s*typeof\s+(create[A-Za-z0-9_$]+Api)\s*>$/;
 
-const rawType = (js, ts = js) => ({ kind: "raw", js, ts });
-const refType = (name) => rawType(name);
-const importType = (importPath, name) => rawType(`import("${importPath}").${name}`);
-const arrayType = (elementType) => ({ kind: "array", elementType });
-const promiseType = (valueType) => ({ kind: "promise", valueType });
-const unionType = (...types) => ({ kind: "union", types });
-const intersectionType = (...types) => ({ kind: "intersection", types });
-const functionType = (params, returnType) => ({ kind: "function", params, returnType });
-const objectLiteralType = (properties) => ({ kind: "objectLiteral", properties });
-
-const stringType = refType("string");
-const booleanType = refType("boolean");
-const voidType = refType("void");
-const jsObjectType = rawType("Object", "object");
-const jsFunctionType = rawType("function", "Function");
-
-const neherApp3JsImports = [
-    { importPath: "./fluentApi.js", name: "FluentApi" },
-    { importPath: "./idasFluentApi.js", name: "IDASFluentApi" },
-    { importPath: "./fluentAuthManager.js", name: "FluentAuthManager" }
-];
-
-const neherApp3TypeDefinitions = [
-    {
-        kind: "alias",
-        name: "NeherApp3NotifyType",
-        type: unionType(rawType("0"), rawType("1"), rawType("2"))
-    },
-    {
-        kind: "object",
-        name: "ArtikelstammEintrag",
-        properties: [
-            { name: "KatalogArtikelGuid", type: stringType, optional: true },
-            { name: "KatalogNummer", type: stringType, optional: true },
-            { name: "Katalognummer", type: stringType, optional: true },
-            { name: "Nummer", type: stringType, optional: true }
-        ]
-    },
-    {
-        kind: "object",
-        name: "Variante",
-        properties: [
-            { name: "VarianteGuid", type: stringType, optional: true },
-            { name: "Name", type: stringType, optional: true },
-            { name: "Kuerzel", type: stringType, optional: true }
-        ]
-    },
-    {
-        kind: "object",
-        name: "Werteliste",
-        properties: [
-            { name: "WerteListeGuid", type: stringType, optional: true },
-            { name: "Name", type: stringType, optional: true }
-        ]
-    },
-    {
-        kind: "object",
-        name: "NeherApp3ArtikelstammCache",
-        properties: [
-            { name: "getArtikelStamm", type: functionType([], promiseType(arrayType(refType("ArtikelstammEintrag")))) },
-            { name: "getWarenGruppen", type: functionType([], promiseType(arrayType(jsObjectType))) },
-            {
-                name: "getArtikelByGuid",
-                type: functionType([{ name: "guid", type: stringType }], promiseType(unionType(refType("ArtikelstammEintrag"), rawType("undefined"))))
-            },
-            {
-                name: "getArtikelByKatalognummer",
-                type: functionType([{ name: "nummer", type: stringType }], promiseType(unionType(refType("ArtikelstammEintrag"), rawType("undefined"))))
-            }
-        ]
-    },
-    {
-        kind: "object",
-        name: "NeherApp3ErfassungCache",
-        properties: [
-            { name: "getVarianten", type: functionType([], promiseType(arrayType(refType("Variante")))) },
-            {
-                name: "getVariante",
-                type: functionType([{ name: "variantenNameOderKuerzel", type: stringType }], promiseType(unionType(refType("Variante"), rawType("undefined"))))
-            },
-            { name: "getWertelisten", type: functionType([], promiseType(arrayType(refType("Werteliste")))) },
-            {
-                name: "getWerteliste",
-                type: functionType([{ name: "name", type: stringType }], promiseType(unionType(refType("Werteliste"), rawType("undefined"))))
-            },
-            { name: "getScripts", type: functionType([], promiseType(arrayType(jsObjectType))) },
-            { name: "createUIMachine", type: functionType([{ name: "v", type: refType("Variante") }], voidType) }
-        ]
-    },
-    {
-        kind: "object",
-        name: "NeherApp3Props",
-        properties: [
-            { name: "api", type: importType("./fluentApi.js", "FluentApi") },
-            { name: "authManager", type: importType("./fluentAuthManager.js", "FluentAuthManager"), optional: true },
-            { name: "idas", type: importType("./idasFluentApi.js", "IDASFluentApi") },
-            { name: "mainCssPath", type: stringType, optional: true }
-        ]
-    },
-    {
-        kind: "object",
-        name: "NeherApp3MenuItem",
-        properties: [
-            { name: "id", type: stringType, optional: true, description: "Unique identifier for the menu item (auto-generated if not provided)" },
-            { name: "selected", type: booleanType, optional: true, description: "Indicates if the menu item is currently selected (managed by the menu system)" },
-            { name: "icon", type: stringType, optional: true, description: "URL to an icon" },
-            { name: "url", type: unionType(stringType, rawType("null")), optional: true, description: "Relative URL to use for routes" },
-            { name: "text", type: stringType, description: "Display text" },
-            { name: "parent", type: unionType(stringType, rawType("null")), optional: true, description: "Parent menu item (optional). If not set, the item will be added to the top level menu." },
-            { name: "hidden", type: booleanType, optional: true, description: "If true, the menu item will not be displayed" }
-        ]
-    },
-    {
-        kind: "alias",
-        name: "NeherApp3SetupContext",
-        type: intersectionType(
-            refType("NeherApp3Props"),
-            objectLiteralType([{ name: "neherapp3", type: refType("NeherApp3") }])
-        )
-    },
-    {
-        kind: "object",
-        name: "NeherApp3Module",
-        properties: [
-            { name: "moduleName", type: stringType },
-            {
-                name: "setup",
-                type: functionType([{ name: "context", type: refType("NeherApp3SetupContext") }], unionType(voidType, promiseType(voidType))),
-                optional: true
-            },
-            {
-                name: "mount",
-                type: functionType(
-                    [
-                        { name: "node", type: refType("HTMLElement") },
-                        { name: "props", type: refType("NeherApp3SetupContext") }
-                    ],
-                    unionType(voidType, jsFunctionType)
-                ),
-                optional: true,
-                description: "Must return an optional unmount function"
-            },
-            { name: "embedUrl", type: stringType, optional: true },
-            { name: "extraCSS", type: arrayType(stringType), optional: true },
-            { name: "useShadowDom", type: booleanType, optional: true, description: "If true, the app will be embedded in a shadow DOM. This is required for CSS isolation." }
-        ]
-    },
-    {
-        kind: "object",
-        name: "NeherApp3ApiCollection",
-        properties: [
-            { name: "idas", type: importType("./idasFluentApi.js", "IDASFluentApi"), optional: true },
-            { name: "hostingEnvironment", type: importType("./fluentApi.js", "FluentApi"), optional: true }
-        ]
-    },
-    {
-        kind: "object",
-        name: "NeherApp3CacheCollection",
-        properties: [
-            { name: "artikelstamm", type: refType("NeherApp3ArtikelstammCache") },
-            { name: "erfassung", type: refType("NeherApp3ErfassungCache") }
-        ]
-    },
-    {
-        kind: "object",
-        name: "NeherApp3",
-        properties: [
-            { name: "addMenuItem", type: functionType([{ name: "menuItem", type: refType("NeherApp3MenuItem") }], voidType) },
-            { name: "addApp", type: functionType([{ name: "appModule", type: unionType(refType("NeherApp3Module"), stringType) }], promiseType(voidType)) },
-            {
-                name: "notify",
-                type: functionType(
-                    [
-                        { name: "message", type: stringType },
-                        { name: "type", type: refType("NeherApp3NotifyType"), optional: true },
-                        { name: "cb", type: jsFunctionType, optional: true }
-                    ],
-                    voidType
-                ),
-                description: "Shows a notification. Type defaults to 0 (info). Callback is optional."
-            },
-            { name: "api", type: refType("NeherApp3ApiCollection") },
-            { name: "cache", type: refType("NeherApp3CacheCollection") }
-        ]
-    }
-];
-
 async function collectFiles(directoryPath, allowedExtensions) {
     const entries = await readdir(directoryPath, { withFileTypes: true });
     const files = [];
@@ -263,95 +74,6 @@ function getJSDocBlocks(source) {
     return source.match(/\/\*\*[\s\S]*?\*\//g) ?? [];
 }
 
-function renderTypeExpression(typeExpression, format) {
-    switch (typeExpression.kind) {
-        case "raw":
-            return format === "js" ? typeExpression.js : typeExpression.ts;
-        case "array":
-            return `${renderTypeExpression(typeExpression.elementType, format)}[]`;
-        case "promise":
-            return `Promise<${renderTypeExpression(typeExpression.valueType, format)}>`;
-        case "union":
-            return typeExpression.types.map((type) => renderTypeExpression(type, format)).join(" | ");
-        case "intersection":
-            return typeExpression.types.map((type) => renderTypeExpression(type, format)).join(" & ");
-        case "function":
-            return `(${typeExpression.params.map((param) => `${param.name}${param.optional ? "?" : ""}: ${renderTypeExpression(param.type, format)}`).join(", ")}) => ${renderTypeExpression(typeExpression.returnType, format)}`;
-        case "objectLiteral":
-            return `{ ${typeExpression.properties.map((property) => `${property.name}${property.optional ? "?" : ""}: ${renderTypeExpression(property.type, format)}`).join("; ")} }`;
-        default:
-            throw new Error(`Unsupported type expression kind: ${typeExpression.kind}`);
-    }
-}
-
-function buildNeherApp3TypesJsSource() {
-    const lines = [
-        "/**",
-        " * Auto-generated NeherApp3 root type definitions.",
-        " * Do not modify manually - changes will be overwritten by scripts/generate-root-dto-typedefs.mjs",
-        " */",
-        ""
-    ];
-
-    for (const jsImport of neherApp3JsImports) {
-        lines.push(`/** @typedef {import("${jsImport.importPath}").${jsImport.name}} ${jsImport.name} */`);
-    }
-
-    lines.push("");
-
-    for (const definition of neherApp3TypeDefinitions) {
-        if (definition.kind === "alias") {
-            lines.push("/**");
-            lines.push(` * @typedef {${renderTypeExpression(definition.type, "js")}} ${definition.name}`);
-            lines.push(" */");
-            lines.push("");
-            continue;
-        }
-
-        lines.push("/**");
-        lines.push(` * @typedef {Object} ${definition.name}`);
-
-        for (const property of definition.properties) {
-            const propertyName = property.optional ? `[${property.name}]` : property.name;
-            const propertyLine = ` * @property {${renderTypeExpression(property.type, "js")}} ${propertyName}`;
-            lines.push(property.description ? `${propertyLine} - ${property.description}` : propertyLine);
-        }
-
-        lines.push(" */");
-        lines.push("");
-    }
-
-    lines.push("export {};");
-    return `${lines.join("\n")}\n`;
-}
-
-function buildNeherApp3TypesDtsSource() {
-    const lines = [
-        "// Auto-generated NeherApp3 root type definitions.",
-        "// Do not modify manually - changes will be overwritten by scripts/generate-root-dto-typedefs.mjs",
-        ""
-    ];
-
-    for (const definition of neherApp3TypeDefinitions) {
-        if (definition.kind === "alias") {
-            lines.push(`export type ${definition.name} = ${renderTypeExpression(definition.type, "ts")};`);
-            lines.push("");
-            continue;
-        }
-
-        lines.push(`export type ${definition.name} = {`);
-
-        for (const property of definition.properties) {
-            lines.push(`    ${property.name}${property.optional ? "?" : ""}: ${renderTypeExpression(property.type, "ts")};`);
-        }
-
-        lines.push("};");
-        lines.push("");
-    }
-
-    return `${lines.join("\n")}\n`;
-}
-
 function normalizeJSDocBlock(block) {
     return block
         .replace(/^\/\*\*/, "")
@@ -1479,7 +1201,7 @@ function buildRootAliasBlock(startMarker, endMarker, description, aliases, impor
     const lines = [
         startMarker,
         description,
-        `// This block is generated by scripts/generate-root-dto-typedefs.mjs from ${importPath}`,
+        `// This block is generated by scripts/generate-dts.mjs from ${importPath}`,
         ...aliases.map((alias) => {
             const name = nameSelector(alias);
             return `/** @typedef {import("${importPath}").${name}} ${name} */`;
@@ -1552,19 +1274,14 @@ const publicTypeEntries = [
 const generatedDtoIndexSource = buildDtoIndexSource(dtoAliases);
 const generatedBusinessIndexSource = buildBusinessIndexSource(businessAliases);
 const generatedUiIndexSource = buildUiIndexSource(uiLeafFiles, sourceByFilePath);
-const generatedNeherApp3TypesJsSource = buildNeherApp3TypesJsSource();
-const generatedNeherApp3TypesDtsSource = buildNeherApp3TypesDtsSource();
 
 await writeFile(dtoIndexPath, generatedDtoIndexSource);
 await writeFile(businessIndexPath, generatedBusinessIndexSource);
 await writeFile(uiIndexPath, generatedUiIndexSource);
-await writeFile(neherApp3TypesJsPath, generatedNeherApp3TypesJsSource);
-await writeFile(neherApp3TypesDtsPath, generatedNeherApp3TypesDtsSource);
 
 sourceByFilePath.set(dtoIndexPath, generatedDtoIndexSource);
 sourceByFilePath.set(businessIndexPath, generatedBusinessIndexSource);
 sourceByFilePath.set(uiIndexPath, generatedUiIndexSource);
-sourceByFilePath.set(neherApp3TypesJsPath, generatedNeherApp3TypesJsSource);
 
 const dtoRootBlock = buildRootAliasBlock(
     dtoRootMarkerStart,
@@ -1597,7 +1314,5 @@ await writeFile(rootDtsPath, generatedRootDts);
 console.log(`Updated ${toPosixRelativePath(dtoIndexPath)} with ${dtoAliases.length} generated DTO aliases.`);
 console.log(`Updated ${toPosixRelativePath(businessIndexPath)} with ${businessAliases.length} generated business API exports.`);
 console.log(`Updated ${toPosixRelativePath(uiIndexPath)} with ${uiLeafFiles.length} generated UI exports.`);
-console.log(`Updated ${toPosixRelativePath(neherApp3TypesJsPath)} generated NeherApp3 JSDoc type exports.`);
-console.log(`Updated ${toPosixRelativePath(neherApp3TypesDtsPath)} generated NeherApp3 declaration exports.`);
 console.log(`Updated ${toPosixRelativePath(rootIndexPath)} generated JSDoc alias blocks.`);
 console.log(`Wrote ${toPosixRelativePath(rootDtsPath)} with full package type exports.`);

package/api/neherApp3Types.d.ts

@@ -1,85 +0,0 @@
-// 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;
-};
-