Skip to content

feat(dts-generator): add getMessagesByPath declarations and tests to TypedJSONModel #549

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 4 commits into from
Closed

feat(dts-generator): add getMessagesByPath declarations and tests to TypedJSONModel #549

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c78fc1a
feat(dts-generator): add getMessagesByPath declarations and tests to …
viktorsperling Mar 10, 2026
a4faa4d
chore(dts-generator): adds getMessagesByPath declaration
viktorsperling Mar 10, 2026
969ba94
chore(dts-generator): apply changes of other pull requests to reduce …
viktorsperling Apr 9, 2026
c2b4f75
chore(dts-generator): remove unnecessary imports
viktorsperling Apr 9, 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 changes: 5 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 @@ -2,6 +2,7 @@ declare module "sap/ui/model/json/TypedJSONModel" {
import JSONModel from "sap/ui/model/json/JSONModel";
import TypedJSONContext from "sap/ui/model/json/TypedJSONContext";
import Context from "sap/ui/model/Context";
import Message from "sap/ui/core/message/Message";

/**
* TypedJSONModel is a subclass of JSONModel that provides type-safe access to the model data. It is only available when using UI5 with TypeScript.
Expand All @@ -19,6 +20,10 @@ declare module "sap/ui/model/json/TypedJSONModel" {
bReload?: boolean,
): TypedJSONContext<Data, Path>;
getData(): Data;
getMessagesByPath<Path extends AbsoluteBindingPath<Data>>(
sPath: Path,
bPrefixMatch?: boolean,
): Message[];
getProperty<Path extends AbsoluteBindingPath<Data>>(
sPath: Path,
): PropertyByAbsoluteBindingPath<Data, Path>;
Expand Down
5 changes: 5 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 @@ -6,6 +6,7 @@ import {
PropertyByRelativeBindingPath,
RelativeBindingPath,
} from "./typing";
import Message from "sap/ui/core/message/Message";

export class TypedJSONContext<Data extends object, Root extends AbsoluteBindingPath<Data>> extends Context {
constructor(oModel: TypedJSONModel<Data>, sPath: Root) {
Expand Down Expand Up @@ -43,6 +44,10 @@ export class TypedJSONModel<Data extends object> extends JSONModel {
return super.getData() as Data;
}

getMessagesByPath<Path extends AbsoluteBindingPath<Data>>(sPath: Path, bPrefixMatch?: boolean): Message[] {
return super.getMessagesByPath(sPath, bPrefixMatch);
}

getProperty<Path extends AbsoluteBindingPath<Data>>(sPath: Path): PropertyByAbsoluteBindingPath<Data, Path>;
getProperty<Path extends RelativeBindingPath<Data, Root>, Root extends AbsoluteBindingPath<Data>>(
sPath: Path,
Expand Down
32 changes: 32 additions & 0 deletions test-packages/typed-json-model/webapp/model/test/cases/edgeCases.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* @file Various edge cases to test the TypedJSONModel
*/

import Message from "sap/ui/core/message/Message";
import { TypedJSONModel } from "../../model";

/***********************************************************************************************************************
Expand Down Expand Up @@ -65,3 +66,34 @@ const model4 = new TypedJSONModel(edgeCase);
/** @expect ok */ model4.setProperty("/anIntersection", { a: 1, b: "b" });
/** @expect ts2345 */ model4.setProperty("/anIntersection", { a: 1 });
/** @expect ts2322 */ model4.setProperty("/anIntersection", { a: 1, b: 2 });

/***********************************************************************************************************************
* Check model.getMessagesByPath
**********************************************************************************************************************/

const data = {
aString: "string",
anObject: { a: "foo" },
anArray: [],
anArrayOfObjects: [{ aNumber: 1 }],
};

const model5 = new TypedJSONModel(data);

/** @expect ok */ model5.getMessagesByPath("/aString");
/** @expect ok */ model5.getMessagesByPath("/aString", true);

/** @expect ok */ const messages: Message[] = model5.getMessagesByPath("/anObject");
/** @expect ok */ model5.getMessagesByPath("/anObject", true);

/** @expect ok */ model5.getMessagesByPath("/anObject/a");
/** @expect ok */ model5.getMessagesByPath("/anObject/a", true);

/** @expect ok */ model5.getMessagesByPath("/anArrayOfObjects/0/aNumber");
/** @expect ok */ model5.getMessagesByPath("/anArrayOfObjects/0/aNumber", true);

/** @expect ts2345 */ model5.getMessagesByPath("anObject");
/** @expect ts2345 */ model5.getMessagesByPath("anObject", true);

/** @expect ts2345 */ model5.getMessagesByPath("/anArray/0/doesNotExist");
/** @expect ts2345 */ model5.getMessagesByPath("/anArray/0/doesNotExist", true);
Loading