@abaplint/transpiler 2.13.32 → 2.13.34

package/build/src/index.d.ts

@@ -1,10 +1,13 @@
 import * as abaplint from "@abaplint/core";
 import { config } from "./validation";
-import { IFile, IOutput, IProgress, ITranspilerOptions, IOutputFile, UnknownTypesEnum } from "./types";
-export { config, ITranspilerOptions, IFile, IProgress, IOutputFile, IOutput, UnknownTypesEnum };
+import { IFile, IOutput, IProgress, ITranspilerOptions, ITranspilerPlugin, IOutputFile, UnknownTypesEnum } from "./types";
+import { Chunk } from "./chunk";
+import { DatabaseSetupResult } from "./db/database_setup_result";
+export { config, ITranspilerOptions, ITranspilerPlugin, IFile, IProgress, IOutputFile, IOutput, UnknownTypesEnum, Chunk, DatabaseSetupResult };
 export declare class Transpiler {
     private readonly options;
-    constructor(options?: ITranspilerOptions);
+    private readonly plugin;
+    constructor(options?: ITranspilerOptions, plugin?: ITranspilerPlugin);
     runRaw(files: IFile[]): Promise<IOutput>;
     run(reg: abaplint.IRegistry, progress?: IProgress): Promise<IOutput>;
     protected validate(reg: abaplint.IRegistry): void;

package/build/src/index.js

@@ -33,13 +33,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(require("@abaplint/core"));
 const validation_1 = require("./validation");
 Object.defineProperty(exports, "config", { enumerable: true, get: function () { return validation_1.config; } });
 const unit_test_1 = require("./unit_test");
 const types_1 = require("./types");
 Object.defineProperty(exports, "UnknownTypesEnum", { enumerable: true, get: function () { return types_1.UnknownTypesEnum; } });
+const chunk_1 = require("./chunk");
+Object.defineProperty(exports, "Chunk", { enumerable: true, get: function () { return chunk_1.Chunk; } });
 const db_1 = require("./db");
 const handle_table_1 = require("./handlers/handle_table");
 const handle_abap_1 = require("./handlers/handle_abap");
@@ -56,8 +58,10 @@ const handle_fugr_1 = require("./handlers/handle_fugr");
 const initialization_1 = require("./initialization");
 class Transpiler {
     options;
-    constructor(options) {
+    plugin;
+    constructor(options, plugin) {
         this.options = options;
+        this.plugin = plugin;
         if (this.options === undefined) {
             this.options = {};
         }
@@ -75,15 +79,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());
@@ -123,12 +129,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() + ", " +

package/build/src/initialization.d.ts

@@ -1,9 +1,9 @@
 import { DatabaseSetupResult } from "./db/database_setup_result";
 import * as abaplint from "@abaplint/core";
-import { ITranspilerOptions } from "./types";
+import { ITranspilerOptions, IOutputFile } from "./types";
 export declare function escapeNamespaceFilename(filename: string): string;
 export declare class Initialization {
-    script(reg: abaplint.IRegistry, dbSetup: DatabaseSetupResult, options: ITranspilerOptions | undefined, useImport?: boolean): string;
+    script(reg: abaplint.IRegistry, dbSetup: DatabaseSetupResult, options: ITranspilerOptions | undefined, useImport?: boolean, pluginOutputs?: readonly IOutputFile[]): string;
     private buildImports;
     private hasClassConstructor;
 }

package/build/src/initialization.js

@@ -43,7 +43,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 */
@@ -86,13 +86,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 = [];
@@ -105,6 +105,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

package/build/src/types.d.ts

@@ -40,6 +40,18 @@ export declare enum UnknownTypesEnum {
     compileError = "compileError",
     runtimeError = "runtimeError"
 }
+/** handles additional object types, may be supplied by a separate npm package */
+export interface ITranspilerPlugin {
+    /** object types handled by the plugin, merged into allowed_object_types during validation */
+    objectTypes(): string[];
+    /** returns undefined if the object is not handled by the plugin,
+     *  returned output files are imported in the initialization script,
+     *  return an empty array to accept the object without producing output */
+    handleObject(obj: abaplint.IObject, reg: abaplint.IRegistry, options: ITranspilerOptions): IOutputFile[] | undefined;
+    /** optional, called after the default schemas and inserts are built,
+     *  amend the database setup by mutating the supplied result directly */
+    amendDatabaseSetup?(dbSetup: DatabaseSetupResult, reg: abaplint.IRegistry, options: ITranspilerOptions): void;
+}
 export interface ITranspilerOptions {
     /** ignore syntax check, used for internal testing */
     ignoreSyntaxCheck?: boolean;

package/build/src/validation.d.ts

@@ -1,8 +1,9 @@
 import { Issue, IRegistry, IConfig } from "@abaplint/core";
-import { ITranspilerOptions } from "./types";
+import { ITranspilerOptions, ITranspilerPlugin } from "./types";
 export declare const config: IConfig;
 export declare class Validation {
     private readonly options;
-    constructor(options?: ITranspilerOptions);
+    private readonly plugin;
+    constructor(options?: ITranspilerOptions, plugin?: ITranspilerPlugin);
     run(reg: IRegistry): readonly Issue[];
 }

package/build/src/validation.js

@@ -3,6 +3,74 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Validation = exports.config = void 0;
 const core_1 = require("@abaplint/core");
 const types_1 = require("./types");
+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": "/**/*.*",
@@ -25,75 +93,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,
@@ -110,8 +110,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) {
@@ -121,6 +123,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";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abaplint/transpiler",
-  "version": "2.13.32",
+  "version": "2.13.34",
   "description": "Transpiler",
   "main": "build/src/index.js",
   "typings": "build/src/index.d.ts",
@@ -29,7 +29,7 @@
   "author": "abaplint",
   "license": "MIT",
   "dependencies": {
-    "@abaplint/core": "^2.119.54",
+    "@abaplint/core": "^2.119.55",
     "source-map": "^0.7.6"
   },
   "devDependencies": {