@abaplint/transpiler-cli 2.13.33 → 2.13.34

package/build/bundle.js

@@ -264,6 +264,7 @@ const path = __importStar(__webpack_require__(/*! path */ "path"));
 const glob = __importStar(__webpack_require__(/*! glob */ "./node_modules/glob/glob.js"));
 const childProcess = __importStar(__webpack_require__(/*! child_process */ "child_process"));
 const os = __importStar(__webpack_require__(/*! os */ "os"));
+const module_1 = __webpack_require__(/*! module */ "module");
 const progress_1 = __importDefault(__webpack_require__(/*! progress */ "./node_modules/progress/index.js"));
 const Transpiler = __importStar(__webpack_require__(/*! @abaplint/transpiler */ "./node_modules/@abaplint/transpiler/build/src/index.js"));
 const abaplint = __importStar(__webpack_require__(/*! @abaplint/core */ "./node_modules/@abaplint/core/build/src/index.js"));
@@ -355,9 +356,28 @@ async function writeObjects(outputFiles, config, outputFolder, files) {
     }
     await file_operations_1.FileOperations.writeFiles(filesToWrite);
 }
+const PLUGIN_MODULE = "@abaplint/transpiler-extras";
+function loadPlugin() {
+    // createRequire so the plugin resolves from the project consuming the CLI, also after webpacking
+    const projectRequire = (0, module_1.createRequire)(path.join(process.cwd(), "package.json"));
+    try {
+        projectRequire.resolve(PLUGIN_MODULE);
+    }
+    catch {
+        // plugin package not installed
+        return undefined;
+    }
+    const plugin = projectRequire(PLUGIN_MODULE).plugin;
+    if (plugin === undefined) {
+        throw new Error(PLUGIN_MODULE + " does not export a plugin");
+    }
+    console.log("Plugin loaded: " + PLUGIN_MODULE + ", object types: " + plugin.objectTypes().join(", "));
+    console.log("Note this requires license for commercial use");
+    return plugin;
+}
 async function build(config, files) {
     const libFiles = await loadLib(config);
-    const t = new Transpiler.Transpiler(config.options);
+    const t = new Transpiler.Transpiler(config.options, loadPlugin());
     const reg = new abaplint.Registry();
     for (const f of files) {
         reg.addFile(new abaplint.MemoryFile(f.filename, f.contents));
@@ -106033,13 +106053,15 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.Transpiler = exports.UnknownTypesEnum = exports.config = void 0;
+exports.Transpiler = exports.Chunk = exports.UnknownTypesEnum = exports.config = void 0;
 const abaplint = __importStar(__webpack_require__(/*! @abaplint/core */ "./node_modules/@abaplint/core/build/src/index.js"));
 const validation_1 = __webpack_require__(/*! ./validation */ "./node_modules/@abaplint/transpiler/build/src/validation.js");
 Object.defineProperty(exports, "config", ({ enumerable: true, get: function () { return validation_1.config; } }));
 const unit_test_1 = __webpack_require__(/*! ./unit_test */ "./node_modules/@abaplint/transpiler/build/src/unit_test.js");
 const types_1 = __webpack_require__(/*! ./types */ "./node_modules/@abaplint/transpiler/build/src/types.js");
 Object.defineProperty(exports, "UnknownTypesEnum", ({ enumerable: true, get: function () { return types_1.UnknownTypesEnum; } }));
+const chunk_1 = __webpack_require__(/*! ./chunk */ "./node_modules/@abaplint/transpiler/build/src/chunk.js");
+Object.defineProperty(exports, "Chunk", ({ enumerable: true, get: function () { return chunk_1.Chunk; } }));
 const db_1 = __webpack_require__(/*! ./db */ "./node_modules/@abaplint/transpiler/build/src/db/index.js");
 const handle_table_1 = __webpack_require__(/*! ./handlers/handle_table */ "./node_modules/@abaplint/transpiler/build/src/handlers/handle_table.js");
 const handle_abap_1 = __webpack_require__(/*! ./handlers/handle_abap */ "./node_modules/@abaplint/transpiler/build/src/handlers/handle_abap.js");
@@ -106056,8 +106078,10 @@ const handle_fugr_1 = __webpack_require__(/*! ./handlers/handle_fugr */ "./node_
 const initialization_1 = __webpack_require__(/*! ./initialization */ "./node_modules/@abaplint/transpiler/build/src/initialization.js");
 class Transpiler {
     options;
-    constructor(options) {
+    plugin;
+    constructor(options, plugin) {
         this.options = options;
+        this.plugin = plugin;
         if (this.options === undefined) {
             this.options = {};
         }
@@ -106075,15 +106099,17 @@ class Transpiler {
         reg.parse();
         this.validate(reg);
         const dbSetup = new db_1.DatabaseSetup(reg).run(this.options);
+        this.plugin?.amendDatabaseSetup?.(dbSetup, reg, this.options || {});
         const output = {
             objects: [],
             unitTestScript: new unit_test_1.UnitTest().unitTestScript(reg, this.options?.skip),
             unitTestScriptOpen: new unit_test_1.UnitTest().unitTestScriptOpen(reg, this.options?.skip),
-            initializationScript: new initialization_1.Initialization().script(reg, dbSetup, this.options),
-            initializationScript2: new initialization_1.Initialization().script(reg, dbSetup, this.options, true),
+            initializationScript: "",
+            initializationScript2: "",
             databaseSetup: dbSetup,
             reg: reg,
         };
+        const pluginOutputs = [];
         progress?.set(reg.getObjectCount().total, "Building");
         for (const obj of reg.getObjects()) {
             await progress?.tick("Building, " + obj.getName());
@@ -106123,12 +106149,22 @@ class Transpiler {
             else if (obj instanceof abaplint.Objects.MessageClass) {
                 output.objects.push(...new handle_msag_1.HandleMSAG().runObject(obj, reg));
             }
+            else if (this.plugin !== undefined) {
+                const handled = this.plugin.handleObject(obj, reg, this.options || {});
+                if (handled !== undefined) {
+                    output.objects.push(...handled);
+                    pluginOutputs.push(...handled);
+                }
+            }
         }
+        // after the object loop, plugin output files are imported by the initialization scripts
+        output.initializationScript = new initialization_1.Initialization().script(reg, dbSetup, this.options, false, pluginOutputs);
+        output.initializationScript2 = new initialization_1.Initialization().script(reg, dbSetup, this.options, true, pluginOutputs);
         return output;
     }
     // ///////////////////////////////
     validate(reg) {
-        const issues = new validation_1.Validation(this.options).run(reg);
+        const issues = new validation_1.Validation(this.options, this.plugin).run(reg);
         if (issues.length > 0) {
             const messages = issues.map(i => i.getKey() + ", " +
                 i.getMessage() + ", " +
@@ -106195,7 +106231,7 @@ function escapeNamespaceFilename(filename) {
     return filename.replace(/\//g, "%23");
 }
 class Initialization {
-    script(reg, dbSetup, options, useImport) {
+    script(reg, dbSetup, options, useImport, pluginOutputs) {
         let ret = "";
         if (useImport === true) {
             ret = `/* eslint-disable import/newline-after-import */
@@ -106238,13 +106274,13 @@ globalThis.abap = new runtime.ABAP();\n`;
         }
         ret += `}\n\n`;
         ret += `await initializeABAP();\n\n`;
-        ret += `${this.buildImports(reg, useImport, options)}`;
+        ret += `${this.buildImports(reg, useImport, options, pluginOutputs)}`;
         if (options?.setup?.postFunction !== undefined) {
             ret += `\n\nawait setup.${options?.setup?.postFunction}();\n`;
         }
         return ret;
     }
-    buildImports(reg, useImport, options) {
+    buildImports(reg, useImport, options, pluginOutputs) {
         // note: ES modules are hoised, so use the dynamic import(), due to setting of globalThis.abap
         // some sorting required: eg. a class constructor using constant from interface
         const list = [];
@@ -106257,6 +106293,9 @@ globalThis.abap = new runtime.ABAP();\n`;
                 return `await import("./${filename}.mjs");`;
             }
         };
+        for (const pluginOutput of pluginOutputs || []) {
+            list.push(imp(pluginOutput.filename.replace(/\.mjs$/i, "")));
+        }
         for (const obj of reg.getObjects()) {
             if (obj instanceof abaplint.Objects.Table
                 || obj instanceof abaplint.Objects.DataElement
@@ -119236,6 +119275,74 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.Validation = exports.config = void 0;
 const core_1 = __webpack_require__(/*! @abaplint/core */ "./node_modules/@abaplint/core/build/src/index.js");
 const types_1 = __webpack_require__(/*! ./types */ "./node_modules/@abaplint/transpiler/build/src/types.js");
+const defaultAllowedObjectTypes = [
+    "APIS",
+    "AUTH",
+    "CLAS",
+    "DEVC",
+    "DOMA",
+    "DTEL",
+    "ENHO",
+    "ENHS",
+    "ENQU",
+    "FUGR",
+    "HTTP",
+    "INTF",
+    "IWMO",
+    "IWOM",
+    "IWPR",
+    "IWSG",
+    "IWSV",
+    "MSAG",
+    "NROB",
+    "NSPC",
+    "OA2P",
+    "PARA",
+    "PINF",
+    "PROG",
+    "WAPA",
+    "SHLP",
+    "SHMA",
+    "SICF",
+    "SMIM",
+    "SPLO",
+    "SRFC",
+    "SUSC",
+    "SUSH",
+    "SUSO",
+    "SXCI",
+    "TABL",
+    "TOBJ",
+    "TRAN",
+    "TTYP",
+    "TYPE",
+    "VCLS",
+    "VIEW",
+    "W3MI",
+    "XSLT",
+    "ZN01",
+    "ZN02",
+    "ZN03",
+    "ZN04",
+    "ZN05",
+    "ZN06",
+    "ZN07",
+    "ZN08",
+    "ZN09",
+    "ZN10",
+    "ZN11",
+    "ZN12",
+    "ZN13",
+    "ZN14",
+    "ZN15",
+    "ZN16",
+    "ZN17",
+    "ZN18",
+    "ZN19",
+    "ZN20",
+    "ZN21",
+    "ZN22",
+];
 exports.config = {
     "global": {
         "files": "/**/*.*",
@@ -119258,75 +119365,7 @@ exports.config = {
         },
         "parser_error": true,
         "allowed_object_types": {
-            "allowed": [
-                "APIS",
-                "AUTH",
-                "CLAS",
-                "DEVC",
-                "DOMA",
-                "DTEL",
-                "ENHO",
-                "ENHS",
-                "ENQU",
-                "FUGR",
-                "HTTP",
-                "INTF",
-                "IWMO",
-                "IWOM",
-                "IWPR",
-                "IWSG",
-                "IWSV",
-                "MSAG",
-                "NROB",
-                "NSPC",
-                "OA2P",
-                "PARA",
-                "PINF",
-                "PROG",
-                "WAPA",
-                "SHLP",
-                "SHMA",
-                "SICF",
-                "SMIM",
-                "SMIM",
-                "SPLO",
-                "SRFC",
-                "SUSC",
-                "SUSH",
-                "SUSO",
-                "SXCI",
-                "TABL",
-                "TOBJ",
-                "TRAN",
-                "TTYP",
-                "TYPE",
-                "VCLS",
-                "VIEW",
-                "W3MI",
-                "XSLT",
-                "ZN01",
-                "ZN02",
-                "ZN03",
-                "ZN04",
-                "ZN05",
-                "ZN06",
-                "ZN07",
-                "ZN08",
-                "ZN09",
-                "ZN10",
-                "ZN11",
-                "ZN12",
-                "ZN13",
-                "ZN14",
-                "ZN15",
-                "ZN16",
-                "ZN17",
-                "ZN18",
-                "ZN19",
-                "ZN20",
-                "ZN21",
-                "ZN22",
-            ],
+            "allowed": defaultAllowedObjectTypes,
         },
         "unknown_types": true,
         "ambiguous_statement": true,
@@ -119343,8 +119382,10 @@ exports.config = {
 // hmm this ^ is okay? since lines will be prefixed with "abap.builtin"?
 class Validation {
     options;
-    constructor(options) {
+    plugin;
+    constructor(options, plugin) {
         this.options = options;
+        this.plugin = plugin;
     }
     run(reg) {
         if (this.options?.ignoreSyntaxCheck === true) {
@@ -119354,6 +119395,13 @@ class Validation {
             exports.config.rules.check_syntax = true;
         }
         exports.config.rules.forbidden_identifier.check = ["^unique\\d+$"];
+        const allowed = [...defaultAllowedObjectTypes];
+        for (const type of this.plugin?.objectTypes() || []) {
+            if (allowed.includes(type.toUpperCase()) === false) {
+                allowed.push(type.toUpperCase());
+            }
+        }
+        exports.config.rules.allowed_object_types.allowed = allowed;
         if (this.options?.unknownTypes === types_1.UnknownTypesEnum.runtimeError) {
             // this is not a constant, just a regex that happens to not match anything
             exports.config.syntax.errorNamespace = "VOID_EVERYTHING";
@@ -126464,6 +126512,17 @@ module.exports = require("fs");
 
 /***/ },
 
+/***/ "module"
+/*!*************************!*\
+  !*** external "module" ***!
+  \*************************/
+(module) {
+
+"use strict";
+module.exports = require("module");
+
+/***/ },
+
 /***/ "node:fs/promises"
 /*!***********************************!*\
   !*** external "node:fs/promises" ***!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abaplint/transpiler-cli",
-  "version": "2.13.33",
+  "version": "2.13.34",
   "description": "Transpiler - Command Line Interface",
   "funding": "https://github.com/sponsors/larshp",
   "bin": {
@@ -28,7 +28,7 @@
   "license": "MIT",
   "devDependencies": {
     "@abaplint/core": "^2.119.55",
-    "@abaplint/transpiler": "^2.13.33",
+    "@abaplint/transpiler": "^2.13.34",
     "@types/glob": "^8.1.0",
     "@types/node": "^24.12.2",
     "@types/progress": "^2.0.7",

package/schema.json

@@ -0,0 +1,235 @@
+{
+  "$ref": "#/definitions/ITranspilerConfig",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "ITranspilerConfig": {
+      "additionalProperties": false,
+      "properties": {
+        "exclude_filter": {
+          "description": "list of regex, case insensitive",
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "uniqueItems": true
+        },
+        "input_filter": {
+          "description": "list of regex, case insensitive, empty gives all files, positive list",
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "uniqueItems": true
+        },
+        "input_folder": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          ]
+        },
+        "libs": {
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "exclude_filter": {
+                "description": "list of regex, case insensitive",
+                "items": {
+                  "type": "string"
+                },
+                "type": "array",
+                "uniqueItems": true
+              },
+              "files": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  }
+                ]
+              },
+              "folder": {
+                "type": "string"
+              },
+              "url": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "options": {
+          "$ref": "#/definitions/ITranspilerOptions"
+        },
+        "output_folder": {
+          "type": "string"
+        },
+        "plugins": {
+          "description": "list of npm module names or paths, resolved from the current working directory, each module exports \"plugins\", an array of ITranspilerPlugin instances",
+          "items": {
+            "type": "string"
+          },
+          "type": "array",
+          "uniqueItems": true
+        },
+        "write_source_map": {
+          "type": "boolean"
+        },
+        "write_unit_tests": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "input_folder",
+        "output_folder",
+        "options"
+      ],
+      "type": "object"
+    },
+    "ITranspilerOptions": {
+      "additionalProperties": false,
+      "properties": {
+        "addCommonJS": {
+          "description": "adds common js modules",
+          "type": "boolean"
+        },
+        "addFilenames": {
+          "description": "adds filenames as comments in the output js",
+          "type": "boolean"
+        },
+        "ignoreSourceMap": {
+          "description": "ignore source map",
+          "type": "boolean"
+        },
+        "ignoreSyntaxCheck": {
+          "description": "ignore syntax check, used for internal testing",
+          "type": "boolean"
+        },
+        "importProg": {
+          "description": "import programs",
+          "type": "boolean"
+        },
+        "keywords": {
+          "description": "list of keywords to rename, if not supplied default will be used",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "populateTables": {
+          "additionalProperties": false,
+          "description": "populate tables, all tables are populated if undefined and they exist",
+          "properties": {
+            "reposrc": {
+              "description": "insert into REPOSRC, skips if equals false",
+              "type": "boolean"
+            },
+            "seosubco": {
+              "description": "insert into SEOSUBCO, skips if equals false",
+              "type": "boolean"
+            },
+            "seosubcodf": {
+              "description": "insert into SEOSUBCODF, skips if equals false",
+              "type": "boolean"
+            },
+            "seosubcotx": {
+              "description": "insert into SEOSUBCOTX, skips if equals false",
+              "type": "boolean"
+            },
+            "tadir": {
+              "description": "insert into TADIR, skips if equals false",
+              "type": "boolean"
+            },
+            "wwwparams": {
+              "description": "insert into WWWPARAMS, skips if equals false",
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        },
+        "setup": {
+          "additionalProperties": false,
+          "description": "extra setup script to be executed during initialization",
+          "properties": {
+            "filename": {
+              "type": "string"
+            },
+            "postFunction": {
+              "type": "string"
+            },
+            "preFunction": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "filename"
+          ],
+          "type": "object"
+        },
+        "skip": {
+          "$ref": "#/definitions/TestMethodList",
+          "description": "list of unit tests to skip"
+        },
+        "skipVersionCheck": {
+          "description": "skips version check, not recommended",
+          "type": "boolean"
+        },
+        "unknownTypes": {
+          "$ref": "#/definitions/UnknownTypesEnum",
+          "description": "sets behavior for unknown types, either fail at compile- or run-time"
+        }
+      },
+      "type": "object"
+    },
+    "TestMethodList": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "class": {
+            "pattern": "^[a-zA-Z0-9_\\/]+$",
+            "type": "string"
+          },
+          "method": {
+            "pattern": "^[a-zA-Z0-9_\\/]+$",
+            "type": "string"
+          },
+          "note": {
+            "type": "string"
+          },
+          "object": {
+            "pattern": "^[a-zA-Z0-9_\\/]+$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "object",
+          "class",
+          "method"
+        ],
+        "type": "object"
+      },
+      "type": "array",
+      "uniqueItems": true
+    },
+    "UnknownTypesEnum": {
+      "enum": [
+        "compileError",
+        "runtimeError"
+      ],
+      "type": "string"
+    }
+  }
+}
+