Skip to content

docs: Add TS type definitions for Test Starter Configuration #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akudev merged 3 commits into from
Jan 20, 2026
Merged

docs: Add TS type definitions for Test Starter Configuration #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
786b5b2
docs: Add TS type definitions for Test Starter Configuration
maxreichmann Jan 9, 2026
f106e6a
refactor(index-cdn.html): Update UI5 version
maxreichmann Jan 12, 2026
76b7b31
refactor: Address review (add type dep to every necessary step)
maxreichmann Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5,486 changes: 3,242 additions & 2,244 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion steps/03/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/04/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/05/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/06/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/07/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/08/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/09/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/10/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/11/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/12/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/13/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/14/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/15/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/16/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/17/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/18/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/19/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/20/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/21/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/22/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/23/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/24/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/25/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o index.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
2 changes: 1 addition & 1 deletion steps/26/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o test/mockServer.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
6 changes: 2 additions & 4 deletions steps/27/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,10 +186,8 @@ The previously created generic `Test.qunit.html` file is referenced as the test

For more information, read [Test Starter - Concept and Basic Setup](https://sdk.openui5.org/#/topic/22f50c0f0b104bf3ba84620880793d3f).

> 📝 **Note:** <br>
> There are currently no types available for the test suite configuration. Please refer to [Test Starter - Configuration Options](https://sdk.openui5.org/topic/738ed025b36e484fa99046d0f80552fd) to see all available options.

```ts
import type {SuiteConfiguration} from "sap/ui/test/starter/config";
export default {
name: "QUnit test suite for UI5 TypeScript Walkthrough",
defaults: {
Expand All @@ -211,7 +209,7 @@ export default {
title: "UI5 TypeScript Walkthrough - Unit Tests"
}
}
};
} satisfies SuiteConfiguration;

```

Expand Down
2 changes: 1 addition & 1 deletion steps/27/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o test/mockServer.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
4 changes: 2 additions & 2 deletions steps/27/ui5.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
specVersion: '3.0'
specVersion: '4.0'
metadata:
name: "ui5.walkthrough"
type: application
framework:
name: OpenUI5
version: "1.136.7"
version: "1.142.0"
libraries:
- name: sap.m
- name: sap.ui.core
Expand Down
2 changes: 1 addition & 1 deletion steps/27/webapp/index-cdn.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>UI5 TypeScript Walkthrough</title>
<script
id="sap-ui-bootstrap"
src="https://sdk.openui5.org/1.136.7/resources/sap-ui-core.js"
src="https://sdk.openui5.org/1.142.0/resources/sap-ui-core.js"
data-sap-ui-theme="sap_horizon"
data-sap-ui-compat-version="edge"
data-sap-ui-async="true"
Expand Down
3 changes: 2 additions & 1 deletion steps/27/webapp/test/testsuite.cdn.qunit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type {SuiteConfiguration} from "sap/ui/test/starter/config";
export default {
name: "QUnit test suite for UI5 TypeScript Walkthrough",
defaults: {
Expand All @@ -19,4 +20,4 @@ export default {
title: "UI5 TypeScript Walkthrough - Unit Tests"
}
}
};
} satisfies SuiteConfiguration;
3 changes: 2 additions & 1 deletion steps/27/webapp/test/testsuite.qunit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type {SuiteConfiguration} from "sap/ui/test/starter/config";
export default {
name: "QUnit test suite for UI5 TypeScript Walkthrough",
defaults: {
Expand All @@ -19,4 +20,4 @@ export default {
title: "UI5 TypeScript Walkthrough - Unit Tests"
}
}
};
} satisfies SuiteConfiguration;
3 changes: 2 additions & 1 deletion steps/28/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ sap.ui.define(["./NavigationJourney"], function (___NavigationJourney) {
Finally we reference the new `integration/opaTests.qunit.?s` in the `testsuite.qunit.?s` file. The `.qunit.?s` extension is omitted and will be added automatically during runtime.

```ts
import type {SuiteConfiguration} from "sap/ui/test/starter/config";
export default {
// ...
tests: {
Expand All @@ -227,7 +228,7 @@ export default {
title: "UI5 TypeScript Walkthrough - Integration Tests"
}
}
};
} satisfies SuiteConfiguration;

```

Expand Down
2 changes: 1 addition & 1 deletion steps/28/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o test/mockServer.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
4 changes: 2 additions & 2 deletions steps/28/ui5.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
specVersion: '3.0'
specVersion: '4.0'
metadata:
name: "ui5.walkthrough"
type: application
framework:
name: OpenUI5
version: "1.136.7"
version: "1.142.0"
libraries:
- name: sap.m
- name: sap.ui.core
Expand Down
2 changes: 1 addition & 1 deletion steps/28/webapp/index-cdn.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>UI5 TypeScript Walkthrough</title>
<script
id="sap-ui-bootstrap"
src="https://sdk.openui5.org/1.136.7/resources/sap-ui-core.js"
src="https://sdk.openui5.org/1.142.0/resources/sap-ui-core.js"
data-sap-ui-theme="sap_horizon"
data-sap-ui-compat-version="edge"
data-sap-ui-async="true"
Expand Down
3 changes: 2 additions & 1 deletion steps/28/webapp/test/testsuite.cdn.qunit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type {SuiteConfiguration} from "sap/ui/test/starter/config";
export default {
name: "QUnit test suite for UI5 TypeScript Walkthrough",
defaults: {
Expand All @@ -22,4 +23,4 @@ export default {
title: "UI5 TypeScript Walkthrough - Integration Tests"
}
}
};
} satisfies SuiteConfiguration;
3 changes: 2 additions & 1 deletion steps/28/webapp/test/testsuite.qunit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type {SuiteConfiguration} from "sap/ui/test/starter/config";
export default {
name: "QUnit test suite for UI5 TypeScript Walkthrough",
defaults: {
Expand All @@ -22,4 +23,4 @@ export default {
title: "UI5 TypeScript Walkthrough - Integration Tests"
}
}
};
} satisfies SuiteConfiguration;
2 changes: 1 addition & 1 deletion steps/29/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"start": "ui5 serve -o test/mockServer.html"
},
"devDependencies": {
"@types/openui5": "^1.132.0",
"@types/openui5": "^1.142.0",
"@ui5/cli": "^4.0.39",
"typescript": "^5.9.3",
"ui5-middleware-livereload": "^3.2.1",
Expand Down
4 changes: 2 additions & 2 deletions steps/29/ui5.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
specVersion: '3.0'
specVersion: '4.0'
metadata:
name: "ui5.walkthrough"
type: application
framework:
name: OpenUI5
version: "1.136.7"
version: "1.142.0"
libraries:
- name: sap.m
- name: sap.ui.core
Expand Down
2 changes: 1 addition & 1 deletion steps/29/webapp/index-cdn.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>UI5 TypeScript Walkthrough</title>
<script
id="sap-ui-bootstrap"
src="https://sdk.openui5.org/1.136.7/resources/sap-ui-core.js"
src="https://sdk.openui5.org/1.142.0/resources/sap-ui-core.js"
data-sap-ui-theme="sap_horizon"
data-sap-ui-compat-version="edge"
data-sap-ui-async="true"
Expand Down
Loading