IDLizer

Description

This folder contains collection of tools for analyzing and transformation of .d.ts files, with aim of exposing ArkUI interfaces to more languages and runtimes.

Tools available

Peer generator

Prerequisites:

Add registry to the .npmrc file in the $HOME directory (~/.npmrc):

registry=https://repo.huaweicloud.com/repository/npm/
@ohos:registry=https://repo.harmonyos.com/npm/
strict-ssl=false
lockfile=false
@koalaui:registry=https://nexus.bz-openlab.ru:10443/repository/koala-npm/
//nexus.bz-openlab.ru:10443/repository/koala-npm/:_auth=a29hbGEtcHViOnkzIW4wdGhlclAK

Using:

npx @azanat/idlize@next --dts2peer --input-dir <dir> --arkoala-destination <arkoala-path> --generate-interface <components> --generator-target arkoala --only-integrated

Run:

cd idlize
git submodule update --init
git submodule update --remote
npm i
npm run compile

Generating libace interface files:

Given interface definitions it will produce for libace

• For libace interface
  • arkoala_api.h header
  • api discovery code
  • component modifiers
  • etc

node . --dts2peer --input-dir sdk/component --generator-target libace --api-version 140

Generating high level language peer files:

Given interface definitions it will produce for Arkoala

• For high language bindings (arkoala)
  • C++ glue code
  • high level language peer classes (TS, ArkTS, Java, etc)
  • etc

node . --dts2peer --input-dir sdk/component --generator-target arkoala --api-version 140

To test for full sdk

cd idlize
npm i
npm run check:peers:run

The output is in generated/peers directory

To test with a simple subset sdk

cd idlize
npm i
npm run check:subset:run

The output is in generated/subset directory

.d.ts linter

Tool checking that given folder (ArkUI interface declarations downloaded by Arkoala build by default) only contains reasonable set of TypeScript features allowed for usage in public interfaces.

To run

cd idlize
npm i
npm run compile
node . --linter --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component

Results are in ./<outputDir>/linter.txt if --output-dir parameter specified, otherwise printed to stdout. If there are no unsuppressed errors - exit code is 1, otherwise it is 0.

Linter support whitelist files in JSON:

{
    "suppressErrors": ["TYPE_ELEMENT_TYPE", "INDEX_SIGNATURE"],
    "suppressIdentifiers": {
        "cursorControl": ["NAMESPACE"]
    }
}

can be passed with --linter-whitelist whitelist.json.

IDL generator

Tool producing set of WebIDL-compatible interface definitions from .d.ts interface definitions. Still in progress, may produce incorrect IDL.

cd idlize
npm i
npm run compile
node . --dts2idl --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component

Results are in ./idl/ folder.

C headers generator

Tool producing set of C interface definitions from .d.ts interface definitions. Still in progress, will produce incorrect C now.

cd idlize
npm i
npm run compile
node . --idl2h --input-dir ../arkui-common/ohos-sdk-ets/openharmony/10/ets/component

Results are in ./headers/arkoala_api.h.

Typescript declaration files generator

Tool producing set of typescript declaration files from .idl interface definitions.

cd idlize
npm i
npm run compile
node . --idl2dts --input-dir ./test/from-idl/idl

By default, results are in ./dts.

Tests

Use the IDLIZE_SEED environment variable to set a predefined seed for the random generator used in tests. Set the IDLIZE_SEED environment variable to RANDOM to use a random seed.

Configure and run the subset fuzzing tests:

npm run configure:native-node-host-subset
npm run check:subset:fuzz

To test a specific test or method in fuzzing tests use --test-interface and --test-method options in the check:subset:fuzz task:

node . --dts2test --input-dir ./tests/subset/ets  --output-dir ./generated/fuzz --test-interface Test --test-method testBoolean