Skip to content

feat(typed-json-model): add getOriginalProperty declarations to TypedJSONModel #531

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 1 commit into from
Closed

feat(typed-json-model): add getOriginalProperty declarations to TypedJSONModel #531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions packages/dts-generator/src/resources/typed-json-model.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ declare module "sap/ui/model/json/TypedJSONModel" {
bReload?: boolean,
): TypedJSONContext<Data, Path>;
getData(): Data;

getProperty<Path extends AbsoluteBindingPath<Data>>(
sPath: Path,
): PropertyByAbsoluteBindingPath<Data, Path>;
Expand All @@ -30,6 +31,17 @@ declare module "sap/ui/model/json/TypedJSONModel" {
oContext: TypedJSONContext<Data, Root>,
): PropertyByRelativeBindingPath<Data, Root, Path>;

getOriginalProperty<Path extends AbsoluteBindingPath<Data>>(
sPath: Path,
): PropertyByAbsoluteBindingPath<Data, Path>;
getOriginalProperty<
Path extends RelativeBindingPath<Data, Root>,
Root extends AbsoluteBindingPath<Data>,
>(
sPath: Path,
oContext: TypedJSONContext<Data, Root>,
): PropertyByRelativeBindingPath<Data, Root, Path>;

setData(oData: Data, bMerge?: boolean): void;

// setProperty with AbsoluteBindingPath (context === undefined),
Expand Down
2 changes: 1 addition & 1 deletion test-packages/openui5-snapshot-test/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"directory": "test-packages/openui5-snapshot-test"
},
"dependencies": {
"@ui5/dts-generator": "link:../../packages/dts-generator",
"@ui5/dts-generator": "file:../../packages/dts-generator",
Copy link
Member

@codeworrior codeworrior Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the motivation behind this change?

"fs-extra": "11.3.2",
"lodash": "4.17.21",
"typescript": "5.9.3"
Expand Down
17 changes: 17 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
Expand Up @@ -57,6 +57,23 @@ export class TypedJSONModel<Data extends object> extends JSONModel {
| PropertyByRelativeBindingPath<Data, Root, Path>;
}

getOriginalProperty<Path extends AbsoluteBindingPath<Data>>(sPath: Path): PropertyByAbsoluteBindingPath<Data, Path>;
getOriginalProperty<Path extends RelativeBindingPath<Data, Root>, Root extends AbsoluteBindingPath<Data>>(
sPath: Path,
oContext: TypedJSONContext<Data, Root>,
): PropertyByRelativeBindingPath<Data, Root, Path>;
getOriginalProperty<
Path extends AbsoluteBindingPath<Data> | RelativeBindingPath<Data, Root>,
Root extends AbsoluteBindingPath<Data>,
>(
sPath: Path,
oContext?: TypedJSONContext<Data, Root>,
): PropertyByAbsoluteBindingPath<Data, Path> | PropertyByRelativeBindingPath<Data, Root, Path> {
return super.getOriginalProperty(sPath, oContext) as
| PropertyByAbsoluteBindingPath<Data, Path>
| PropertyByRelativeBindingPath<Data, Root, Path>;
}

setData(oData: Data, bMerge?: boolean): void {
super.setData(oData, bMerge);
}
Expand Down
26 changes: 26 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 @@ -67,6 +67,32 @@ import { TypedJSONModel } from "../../model";
/** @expect ts2322 */ anElementInATuple = model.getProperty("/aTuple");
/** @expect ts2322 */ anObject = model.getProperty("/aTuple/0");

/***********************************************************************************************************************
* Check model.getOriginalProperty
**********************************************************************************************************************/

/** @expect ok */ let anOriginalObject: object = model.getOriginalProperty("/anObject");
/** @expect ok */ let anOriginalArray: unknown[] = model.getOriginalProperty("/anArray");
/** @expect ok */ let aOriginalJsonSafeArray: JSONSafe[] = model.getOriginalProperty("/aJsonSafeArray");
/** @expect ok */ let aOriginalJsonSafe: JSONSafe = model.getOriginalProperty("/aJsonSafeArray/0");
/** @expect ok */ let aOriginalPlaceholder: Placeholder = model.getOriginalProperty("/aPlaceholder");
/** @expect ok */ let anOriginalArrayOfPlaceholders: Placeholder[] = model.getOriginalProperty("/anArrayOfPlaceholders");
/** @expect ok */ let anotherOriginalPlaceholder: Placeholder = model.getOriginalProperty("/anArrayOfPlaceholders/0");
/** @expect ok */ let anOriginalTuple: (string | number)[] = model.getOriginalProperty("/aTuple");
/** @expect ok */ let anOriginalElementInATuple: string | number = model.getOriginalProperty("/aTuple/0");

/** @expect ts2345 */ let anythingOriginal: any = model.getOriginalProperty("/anObject/0");
/** @expect ts2345 */ anythingOriginal = model.getOriginalProperty("/doesNotExist");
/** @expect ts2345 */ anythingOriginal = model.getOriginalProperty("/anArray/0/doesNotExist");

/** @expect ts2739 */ aOriginalPlaceholder = model.getOriginalProperty("/anObject");
/** @expect ts2322 */ anOriginalArrayOfPlaceholders = model.getOriginalProperty("/aJsonSafeArray");
/** @expect ts2322 */ anOriginalObject = model.getOriginalProperty("/aJsonSafeArray/0");
/** @expect ts2322 */ aOriginalJsonSafe = model.getOriginalProperty("/aPlaceholder");
/** @expect ts2322 */ aOriginalJsonSafe = model.getOriginalProperty("/anArrayOfPlaceholders/0");
/** @expect ts2322 */ anOriginalElementInATuple = model.getOriginalProperty("/aTuple");
/** @expect ts2322 */ anOriginalObject = model.getOriginalProperty("/aTuple/0");

/***********************************************************************************************************************
* Check model.getData / model.setData
**********************************************************************************************************************/
Expand Down
Loading