openui5-create-defs

OpenUI5 Typescript definition parser

Tool to generate typescript definitions for OpenUI5 from the SAP documentation:

• https://openui5.hana.ondemand.com/test-resources/sap/m/designtime/api.json
• https://openui5.hana.ondemand.com/test-resources/sap/ui/core/designtime/api.json
• https://openui5.hana.ondemand.com/test-resources/sap/ui/layout/designtime/api.json
• https://openui5.hana.ondemand.com/test-resources/sap/ui/unified/designtime/api.json

Changes from original repo

Fixed some bugs and added interface to the mSettings parameters of controls/classes. Also created a script to be executed via command line.

Usage

Install with NPM

npm install --save-dev openui5-create-defs

run via npx

# syntax: npx ui5-create-defs <output path>
npx ui5-create-defs src/generated

update tsconfig.json file

Add the output path in compilerOptions/paths

{
    "compilerOptions": {
        //...
        "paths": {
            //...
            "*": ["./src/generated/*"]
        }
    }
}

Usage in Visual Studio Code

Sample usage in Visual Studio Code