feat(dts-generator): merging PR for TypedJSONModel

packages/dts-generator/src/resources/typed-json-model.d.ts

@@ -1,7 +1,14 @@
 declare module "sap/ui/model/json/TypedJSONModel" {
+  import Message from "sap/ui/core/message/Message";
+  import ClientContextBinding from "sap/ui/model/ClientContextBinding";
+  import Context from "sap/ui/model/Context";
+  import Filter from "sap/ui/model/Filter";
+  import Sorter from "sap/ui/model/Sorter";
   import JSONModel from "sap/ui/model/json/JSONModel";
+  import JSONListBinding from "sap/ui/model/json/JSONListBinding";
+  import JSONPropertyBinding from "sap/ui/model/json/JSONPropertyBinding";
+  import JSONTreeBinding from "sap/ui/model/json/JSONTreeBinding";
   import TypedJSONContext from "sap/ui/model/json/TypedJSONContext";
-  import Context from "sap/ui/model/Context";
 
   /**
    * TypedJSONModel is a subclass of JSONModel that provides type-safe access to the model data. It is only available when using UI5 with TypeScript.
@@ -18,7 +25,76 @@ declare module "sap/ui/model/json/TypedJSONModel" {
       fnCallBack?: Function,
       bReload?: boolean,
     ): TypedJSONContext<Data, Path>;
+
+    bindContext<Path extends AbsoluteObjectBindingPath<Data>>(
+      sPath: Path,
+      oContext?: undefined,
+      mParameters?: object,
+    ): ClientContextBinding;
+    bindContext<
+      Path extends RelativeObjectBindingPath<Data, Root>,
+      Root extends AbsoluteObjectBindingPath<Data>,
+    >(
+      sPath: Path,
+      oContext: TypedJSONContext<Data, Root>,
+      mParameters?: object,
+    ): ClientContextBinding;
+
+    bindList<Path extends AbsoluteListBindingPath<Data>>(
+      sPath: Path,
+      oContext?: undefined,
+      aSorters?: Sorter | Sorter[],
+      aFilters?: Filter | Filter[],
+      mParameters?: object,
+    ): JSONListBinding;
+    bindList<
+      Path extends RelativeListBindingPath<Data, Root>,
+      Root extends AbsoluteBindingPath<Data>,
+    >(
+      sPath: Path,
+      oContext: TypedJSONContext<Data, Root>,
+      aSorters?: Sorter | Sorter[],
+      aFilters?: Filter | Filter[],
+      mParameters?: object,
+    ): JSONListBinding;
+
+    bindProperty<Path extends AbsoluteBindingPath<Data>>(
+      sPath: Path,
+      oContext?: undefined,
+      mParameters?: object,
+    ): JSONPropertyBinding;
+    bindProperty<
+      Path extends RelativeBindingPath<Data, Root>,
+      Root extends AbsoluteBindingPath<Data>,
+    >(
+      sPath: Path,
+      oContext: TypedJSONContext<Data, Root>,
+      mParameters?: object,
+    ): JSONPropertyBinding;
+
+    bindTree<Path extends AbsoluteTreeBindingPath<Data>>(
+      sPath: Path,
+      oContext?: undefined,
+      aFilters?: Filter | Filter[],
+      mParameters?: object,
+      aSorters?: Sorter | Sorter[],
+    ): JSONTreeBinding;
+    bindTree<
+      Path extends RelativeTreeBindingPath<Data, Root>,
+      Root extends AbsoluteBindingPath<Data>,
+    >(
+      sPath: Path,
+      oContext: TypedJSONContext<Data, Root>,
+      aFilters?: Filter | Filter[],
+      mParameters?: object,
+      aSorters?: Sorter | Sorter[],
+    ): JSONTreeBinding;
+
     getData(): Data;
+    getMessagesByPath<Path extends AbsoluteBindingPath<Data>>(
+      sPath: Path,
+      bPrefixMatch?: boolean,
+    ): Message[];
     getProperty<Path extends AbsoluteBindingPath<Data>>(
       sPath: Path,
     ): PropertyByAbsoluteBindingPath<Data, Path>;
@@ -82,6 +158,65 @@ declare module "sap/ui/model/json/TypedJSONModel" {
         : // if T is not of type object:
           never;
 
+  /**
+   * Valid absolute binding path for underlying `Array` types.
+   *
+   * @example
+   * type SalesOrder = { id: string, items: string[] };
+   * type PathInObject = PathInJSONModel<SalesOrder>; // "/id" | "/items"
+   * let path: PathInObject = "/items"; // ok
+   * path = "/id"; // error
+   * path = "/items/0"; // error, since an element in the array is a string
+   */
+  export type AbsoluteListBindingPath<Type> = {
+    [Path in AbsoluteBindingPath<Type>]: PropertyByAbsoluteBindingPath<
+      Type,
+      Path
+    > extends Array<unknown>
+      ? Path
+      : never;
+  }[AbsoluteBindingPath<Type>];
+
+  /**
+   * Valid absolute binding path for underlying `Array` or `object` types.
+   *
+   * @example
+   * type SalesOrder = { id: string, items: string[], parameters: { weight: number } };
+   * type PathInObject = PathInJSONModel<SalesOrder>; // "/id" | "/items" | "/parameters"
+   * let path: PathInObject = "/items"; // ok
+   * path = "/parameters"; // ok
+   * path = "/id"; // error
+   * path = "/items/0"; // error, since an element in the array is a string
+   */
+  export type AbsoluteTreeBindingPath<Type> = {
+    [Path in AbsoluteBindingPath<Type>]: PropertyByAbsoluteBindingPath<
+      Type,
+      Path
+    > extends Array<unknown>
+      ? Path
+      : PropertyByAbsoluteBindingPath<Type, Path> extends object
+        ? Path
+        : never;
+  }[AbsoluteBindingPath<Type>];
+
+  /**
+   * Valid absolute binding path for underlying object types (excludes arrays and primitives).
+   *
+   * @example
+   * type Order = { customer: { address: { city: string } }, items: string[], total: number };
+   * type ObjectPaths = AbsoluteObjectBindingPath<Order>; // "/customer" | "/customer/address"
+   */
+  export type AbsoluteObjectBindingPath<Type> = {
+    [Path in AbsoluteBindingPath<Type>]: PropertyByAbsoluteBindingPath<
+      Type,
+      Path
+    > extends Array<unknown>
+      ? never
+      : PropertyByAbsoluteBindingPath<Type, Path> extends object
+        ? Path
+        : never;
+  }[AbsoluteBindingPath<Type>];
+
   /**
    * Valid relative binding path in a JSONModel.
    * The root of the path is defined by the given root string.
@@ -98,6 +233,76 @@ declare module "sap/ui/model/json/TypedJSONModel" {
       ? Rest
       : never;
 
+  /**
+   * Valid relative binding path for underlying `Array` types.
+   * The root of the path is defined by the given root string.
+   *
+   * @example
+   * type SalesOrder = { buyer: { id: string, items: string[] } };
+   * type PathRelativeToSalesOrder = RelativeListBindingPath<SalesOrderWrapper, "/buyer">; // "id" | "items"
+   */
+  export type RelativeListBindingPath<
+    Type,
+    Root extends AbsoluteBindingPath<Type>,
+  > = {
+    [Path in RelativeBindingPath<Type, Root>]: PropertyByRelativeBindingPath<
+      Type,
+      Root,
+      Path
+    > extends Array<unknown>
+      ? Path
+      : never;
+  }[RelativeBindingPath<Type, Root>];
+
+  /**
+   * Valid relative binding path for underlying `Array` or `object` types.
+   * The root of the path is defined by the given root string.
+   *
+   * @example
+   * type SalesOrder = { buyer: { id: string, items: string[], parameters: { weight: number } } };
+   * type PathRelativeToSalesOrder = RelativeTreeBindingPath<SalesOrderWrapper, "/buyer">; // "items" | "parameters"
+   */
+  export type RelativeTreeBindingPath<
+    Type,
+    Root extends AbsoluteBindingPath<Type>,
+  > = {
+    [Path in RelativeBindingPath<Type, Root>]: PropertyByRelativeBindingPath<
+      Type,
+      Root,
+      Path
+    > extends Array<unknown>
+      ? Path
+      : PropertyByRelativeBindingPath<Type, Root, Path> extends object
+        ? Path
+        : never;
+  }[RelativeBindingPath<Type, Root>];
+
+  /**
+   * Valid relative binding path for underlying object types (excludes arrays and primitives).
+   * The root of the path is defined by the given root string.
+   *
+   * @example
+   * type SalesOrder = { buyer: { id: string, name: string }, items: string[] };
+   * type PathRelativeToSalesOrder = RelativeObjectBindingPath<SalesOrder, "/buyer">; // never (no nested objects)
+   *
+   * type Order = { customer: { address: { city: string } }, total: number };
+   * type PathInOrder = RelativeObjectBindingPath<Order, "/">; // "customer" | "customer/address"
+   */
+  export type RelativeObjectBindingPath<
+    Type,
+    Root extends AbsoluteBindingPath<Type>,
+  > = {
+    [Path in RelativeBindingPath<Type, Root>]: PropertyByRelativeBindingPath<
+      Type,
+      Root,
+      Path
+    > extends Array<unknown>
+      ? never
+      : PropertyByRelativeBindingPath<Type, Root, Path> extends object
+        ? Path
+        : never;
+  }[RelativeBindingPath<Type, Root>];
+
   /**
    * The type of a property in a JSONModel identified by the given path.
    * Counterpart to {@link AbsoluteBindingPath}.

test-packages/typed-json-model/package.json

@@ -16,7 +16,7 @@
     "ci": "npm run lint && npm run ui5lint && npm run ts-typecheck && npm run test"
   },
   "devDependencies": {
-    "@types/openui5": "1.136.0",
+    "@openui5/types": "^1.146.0",
     "@ui5/cli": "^4.0.30",
     "@ui5/linter": "^1.20.2",
     "eslint": "^9.37.0",

test-packages/typed-json-model/tsconfig.json

@@ -11,7 +11,8 @@
     "baseUrl": "./",
     "paths": {},
     "composite": true,
-    "outDir": "./dist"
+    "outDir": "./dist",
+    "types": ["@openui5/types"]
   },
   "include": ["./webapp/**/*"],
   "exclude": ["./**/*.mjs", "./webapp/**/test/**"]

test-packages/typed-json-model/webapp/model/model.ts

@@ -1,10 +1,23 @@
+import Message from "sap/ui/core/message/Message";
+import ClientContextBinding from "sap/ui/model/ClientContextBinding";
 import Context from "sap/ui/model/Context";
+import Filter from "sap/ui/model/Filter";
+import Sorter from "sap/ui/model/Sorter";
 import JSONModel from "sap/ui/model/json/JSONModel";
+import JSONListBinding from "sap/ui/model/json/JSONListBinding";
+import JSONPropertyBinding from "sap/ui/model/json/JSONPropertyBinding";
+import JSONTreeBinding from "sap/ui/model/json/JSONTreeBinding";
 import {
   AbsoluteBindingPath,
+  AbsoluteListBindingPath,
   PropertyByAbsoluteBindingPath,
   PropertyByRelativeBindingPath,
   RelativeBindingPath,
+  RelativeListBindingPath,
+  AbsoluteObjectBindingPath,
+  RelativeObjectBindingPath,
+  AbsoluteTreeBindingPath,
+  RelativeTreeBindingPath,
 } from "./typing";
 
 export class TypedJSONContext<Data extends object, Root extends AbsoluteBindingPath<Data>> extends Context {
@@ -39,10 +52,113 @@ export class TypedJSONModel<Data extends object> extends JSONModel {
     return super.createBindingContext(sPath, oContext, mParameters, fnCallBack, bReload) as TypedJSONContext<Data, Path>;
   }
 
+  // Overload for absolute paths
+  bindContext<Path extends AbsoluteObjectBindingPath<Data>>(
+    sPath: Path,
+    oContext?: undefined,
+    mParameters?: object,
+  ): ClientContextBinding;
+  // Overload for relative paths
+  bindContext<Path extends RelativeObjectBindingPath<Data, Root>, Root extends AbsoluteObjectBindingPath<Data>>(
+    sPath: Path,
+    oContext: TypedJSONContext<Data, Root>,
+    mParameters?: object,
+  ): ClientContextBinding;
+  // Implementation
+  bindContext<
+    Path extends AbsoluteObjectBindingPath<Data> | RelativeObjectBindingPath<Data, Root>,
+    Root extends AbsoluteObjectBindingPath<Data>,
+  >(sPath: Path, oContext?: TypedJSONContext<Data, Root>, mParameters?: object): ClientContextBinding {
+    return super.bindContext(sPath, oContext, mParameters);
+  }
+
+  // Overload for absolute paths
+  bindList<Path extends AbsoluteListBindingPath<Data>>(
+    sPath: Path,
+    oContext?: undefined,
+    aSorters?: Sorter | Sorter[],
+    aFilters?: Filter | Filter[],
+    mParameters?: object,
+  ): JSONListBinding;
+  // Overload for relative paths
+  bindList<Path extends RelativeListBindingPath<Data, Root>, Root extends AbsoluteBindingPath<Data>>(
+    sPath: Path,
+    oContext: TypedJSONContext<Data, Root>,
+    aSorters?: Sorter | Sorter[],
+    aFilters?: Filter | Filter[],
+    mParameters?: object,
+  ): JSONListBinding;
+  // Implementation
+  bindList<
+    Path extends AbsoluteListBindingPath<Data> | RelativeListBindingPath<Data, Root>,
+    Root extends AbsoluteBindingPath<Data>,
+  >(
+    sPath: Path,
+    oContext?: TypedJSONContext<Data, Root>,
+    aSorters?: Sorter | Sorter[],
+    aFilters?: Filter | Filter[],
+    mParameters?: object,
+  ): JSONListBinding {
+    return super.bindList(sPath, oContext, aSorters, aFilters, mParameters);
+  }
+
+  // Overload for absolute paths
+  bindProperty<Path extends AbsoluteBindingPath<Data>>(
+    sPath: Path,
+    oContext?: undefined,
+    mParameters?: object,
+  ): JSONPropertyBinding;
+  // Overload for relative paths
+  bindProperty<Path extends RelativeBindingPath<Data, Root>, Root extends AbsoluteBindingPath<Data>>(
+    sPath: Path,
+    oContext: TypedJSONContext<Data, Root>,
+    mParameters?: object,
+  ): JSONPropertyBinding;
+  bindProperty<
+    Path extends AbsoluteBindingPath<Data> | RelativeBindingPath<Data, Root>,
+    Root extends AbsoluteBindingPath<Data>,
+  >(sPath: Path, oContext?: TypedJSONContext<Data, Root>, mParameters?: object): JSONPropertyBinding {
+    return super.bindProperty(sPath, oContext, mParameters);
+  }
+
+  // Overload for absolute paths
+  bindTree<Path extends AbsoluteTreeBindingPath<Data>>(
+    sPath: Path,
+    oContext?: undefined,
+    aFilters?: Filter | Filter[],
+    mParameters?: object,
+    aSorters?: Sorter | Sorter[],
+  ): JSONTreeBinding;
+  // Overload for relative paths
+  bindTree<Path extends RelativeTreeBindingPath<Data, Root>, Root extends AbsoluteBindingPath<Data>>(
+    sPath: Path,
+    oContext: TypedJSONContext<Data, Root>,
+    aFilters?: Filter | Filter[],
+    mParameters?: object,
+    aSorters?: Sorter | Sorter[],
+  ): JSONTreeBinding;
+  // Implementation
+  bindTree<
+    Path extends AbsoluteTreeBindingPath<Data> | RelativeTreeBindingPath<Data, Root>,
+    Root extends AbsoluteBindingPath<Data>,
+  >(
+    sPath: Path,
+    oContext?: TypedJSONContext<Data, Root>,
+    aFilters?: Filter | Filter[],
+    mParameters?: object,
+    aSorters?: Sorter | Sorter[],
+  ): JSONTreeBinding {
+    return super.bindTree(sPath, oContext, aFilters, mParameters, aSorters);
+  }
+
   getData(): Data {
     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,