Skip to content

feat(dts-generator): add bindList declarations and tests to TypedJSONModel #538

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

Closed
viktorsperling wants to merge 9 commits into from
Closed

feat(dts-generator): add bindList declarations and tests to TypedJSONModel #538

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ef12e6b
revert(dts-generator): revert add getOriginalProperty declarations an…
viktorsperling Jan 23, 2026
f279f08
Merge branch 'UI5:main' into main
viktorsperling Jan 27, 2026
cd39e4a
feat(dts-generator): add bindList declarations and tests to TypedJSON…
viktorsperling Jan 28, 2026
56d6d99
fix(dts-generator): fix ESLint errors
viktorsperling Jan 28, 2026
aa50371
fix(dts-generator): fix failing tests
viktorsperling Jan 28, 2026
ce06c95
feat(dts-generator): add typing for relative binding paths to bindList
viktorsperling Jan 29, 2026
3471c04
chore(dts-generator): review comments
viktorsperling Feb 2, 2026
7e02d89
feat(dts-generator): add bindList declarations to TypedJSONModel
viktorsperling Feb 2, 2026
566d713
Merge branch 'UI5:main' into bindList
PeterBuchholz Feb 26, 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
6 changes: 6 additions & 0 deletions test-packages/typed-json-model/webapp/model/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import Context from "sap/ui/model/Context";
import JSONModel from "sap/ui/model/json/JSONModel";
import JSONListBinding from "sap/ui/model/json/JSONListBinding";
import {
AbsoluteBindingPath,
AbsoluteListBindingPath,
PropertyByAbsoluteBindingPath,
PropertyByRelativeBindingPath,
RelativeBindingPath,
Expand Down Expand Up @@ -57,6 +59,10 @@ export class TypedJSONModel<Data extends object> extends JSONModel {
| PropertyByRelativeBindingPath<Data, Root, Path>;
}

bindList<Path extends AbsoluteListBindingPath<Data>>(sPath: Path): JSONListBinding {
return super.bindList(sPath);
}

setData(oData: Data, bMerge?: boolean): void {
super.setData(oData, bMerge);
}
Expand Down
14 changes: 14 additions & 0 deletions test-packages/typed-json-model/webapp/model/test/cases/absolute-complex-inference.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
*/

import { JSONSafe, objectLikeByInference, Placeholder } from "../input";
import JSONListBinding from "sap/ui/model/json/JSONListBinding";

import { TypedJSONModel } from "../../model";

Expand Down Expand Up @@ -76,3 +77,16 @@ import { TypedJSONModel } from "../../model";

/** @expect ts2740 */ const dataB: Array<any> = model.getData();
/** @expect ts2345 */ model.setData(dataB);

/***********************************************************************************************************************
* Check model.bindList
**********************************************************************************************************************/

/** @expect ok */ let ListBinding: JSONListBinding = model.bindList("/anArray");
Comment thread
viktorsperling marked this conversation as resolved.
Outdated
/** @expect ok */ ListBinding = model.bindList("/anArrayOfArrays/0");
/** @expect ok */ ListBinding = model.bindList("/anObjectWithArray/anArray");

/** @expect ts2345 */ ListBinding = model.bindList("/aJsonSafeArray/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anArrayOfArrays/0/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anObjectWithArray/anArray/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anArrayOfObjects/0");
14 changes: 14 additions & 0 deletions test-packages/typed-json-model/webapp/model/test/cases/absolute-complex-interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
*/

import { IObjectLike, JSONSafe, objectLikeByInterface, Placeholder, TObjectLike } from "../input";
import JSONListBinding from "sap/ui/model/json/JSONListBinding";

import { TypedJSONModel } from "../../model";

Expand Down Expand Up @@ -81,3 +82,16 @@ import { TypedJSONModel } from "../../model";

/** @expect ts2740 */ const dataC: Array<any> = model.getData();
/** @expect ts2345 */ model.setData(dataC);

/***********************************************************************************************************************
* Check model.bindList
**********************************************************************************************************************/

/** @expect ok */ let ListBinding: JSONListBinding = model.bindList("/anArray");
/** @expect ok */ ListBinding = model.bindList("/anArrayOfArrays/0");
/** @expect ok */ ListBinding = model.bindList("/anObjectWithArray/anArray");

/** @expect ts2345 */ ListBinding = model.bindList("/aJsonSafeArray/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anArrayOfArrays/0/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anObjectWithArray/anArray/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anArrayOfPlaceholders/0");
14 changes: 14 additions & 0 deletions test-packages/typed-json-model/webapp/model/test/cases/absolute-complex-typeAlias.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
*/

import { IObjectLike, JSONSafe, objectLikeByTypeAlias, Placeholder, TObjectLike } from "../input";
import JSONListBinding from "sap/ui/model/json/JSONListBinding";

import { TypedJSONModel } from "../../model";

Expand Down Expand Up @@ -81,3 +82,16 @@ import { TypedJSONModel } from "../../model";

/** @expect ts2740 */ const dataC: Array<any> = model.getData();
/** @expect ts2345 */ model.setData(dataC);

/***********************************************************************************************************************
* Check model.bindList
**********************************************************************************************************************/

/** @expect ok */ let ListBinding: JSONListBinding = model.bindList("/anArray");
/** @expect ok */ ListBinding = model.bindList("/anArrayOfArrays/0");
/** @expect ok */ ListBinding = model.bindList("/anObjectWithArray/anArray");

/** @expect ts2345 */ ListBinding = model.bindList("/aJsonSafeArray/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anArrayOfArrays/0/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anObjectWithArray/anArray/0");
/** @expect ts2345 */ ListBinding = model.bindList("/anArrayOfPlaceholders/0");
9 changes: 9 additions & 0 deletions test-packages/typed-json-model/webapp/model/test/input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ export interface IPrimitives {
export type TObjectLike = {
anObject: object;
anArray: Array<unknown>;
anArrayOfArrays: Array<Array<unknown>>;
aJsonSafeArray: Array<JSONSafe>;
anObjectWithArray: { anArray: Array<unknown> };
anArrayOfPlaceholders: Array<Placeholder>;
aPlaceholder: Placeholder;
aTuple: [string, number];
Expand All @@ -71,7 +73,9 @@ export type TObjectLike = {
export interface IObjectLike {
anObject: object;
anArray: Array<unknown>;
anArrayOfArrays: Array<Array<unknown>>;
aJsonSafeArray: Array<JSONSafe>;
anObjectWithArray: { anArray: Array<unknown> };
anArrayOfPlaceholders: Array<Placeholder>;
aPlaceholder: Placeholder;
aTuple: [string, number];
Expand Down Expand Up @@ -149,8 +153,13 @@ export const objectLikeByInterface: IObjectLike = {
export const objectLikeByInference = {
anObject: {},
anArray: [],
anArrayOfArrays: [
["string", 1],
[true, false],
],
aJsonSafeArray: ["string", 1, true],
anArrayOfObjects: [{ aNumber: 1 }],
anObjectWithArray: { anArray: ["string"] },
anArrayOfPlaceholders: [new Placeholder()],
aPlaceholder: new Placeholder(),
aTuple: ["string", 1],
Expand Down
13 changes: 13 additions & 0 deletions test-packages/typed-json-model/webapp/model/typing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,19 @@ export type AbsoluteBindingPath<Type> =
: // if T is not of type object:
never;

/**
* Valid absolute binding in a JSONModel with the underlying type `Type`.
* Counterpart to {@link PropertyByAbsoluteBindingPath}
* @example
* type Person = { name: string, id: number };
* type PathInPerson = PathInJSONModel<Person>; // "/name" | "/id"
* let path: PathInPerson = "/name"; // ok
* path = "/firstName"; // error
*/
export type AbsoluteListBindingPath<Type> = {
Comment thread
viktorsperling marked this conversation as resolved.
[Path in AbsoluteBindingPath<Type>]: PropertyByAbsoluteBindingPath<Type, Path> extends Array<unknown> ? Path : never;
}[AbsoluteBindingPath<Type>];

/**
* Valid relative binding path in a JSONModel.
* The root of the path is defined by the given root string.
Expand Down
Loading