Support TypeScript 3.9 and 4.x

To make tabris TypeScript 4.x-compliant some changes are needed in the type declarations: * The "properties" parameter of "set" overrides need to assignable to their respective type in the super class. This is not the case if properties are explicitly excluded via "Omit" but included in the super class. Various other mechanism to exclude read-only properties either don't work with specific TypeScript versions or cause breaking changes. Therefore these overrides are removed. Regrettably this means that it is now possible (at compile-time) to use "set" to set read-only values, though they are still excluded from the constructors. * The same issue applies to jsxAttributes, but here a workaround is possible: Instead of omitting attribute they are joined with "never". This means they are still auto-suggested by the IDE, but actually using them causes a compile error. This workaround is possible because it is assumed that the JSXAttribues<T> type is (unlike Properties<T>) is never used outside of class declarations. * NativeObject property "_nativeType" must be declared with an explicit getter to able to override it with one, as is the established way to define it in code. To allow this the declarations generator and api json schema need to be extended. This includes a minor unrelated fix in api-schema.d.ts * d.ts files may can longer be linted by eslint. The reason for this is unclear. Change-Id: I58fbceab2df94f03ebe658173965d5fdc7b60751
eclipsesource · Sep 30, 2020 · 8045159 · 8045159
1 parent 38a5517
commit 8045159
Show file tree

Hide file tree

Showing 22 changed files with 41 additions and 198 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,4 @@
-tools/*.d.ts
+*.d.ts
 test/typescript/*
 build
 node_modules

diff --git a/.eslintrc.json b/.eslintrc.json
@@ -412,18 +412,6 @@
               }
             ]
           }
-        },
-        {
-          "files": [
-            "*.d.ts"
-          ],
-          "rules": {
-            "max-len": "off",
-            "no-redeclare": "off",
-            "no-var": "off",
-            "@typescript-eslint/no-explicit-any": "off",
-            "@typescript-eslint/explicit-member-accessibility": "off"
-          }
         }
       ]
     }

diff --git a/doc/api/AlertDialog.json b/doc/api/AlertDialog.json
@@ -51,31 +51,9 @@
       "const": true,
       "readonly": true,
       "ts_only": true,
-      "type": "JSXAttributes<Omit<this, 'textInputs'>> & {children?: Flatten<string|TextInput>}"
+      "type": "JSXAttributes<this> & {children?: Flatten<string|TextInput>, textInputs?: never}"
     }
   },
-  "methods": {
-    "set": [
-      {
-        "ts_only": true,
-        "generics": [
-          {
-            "name": "T",
-            "extends": "NativeObject",
-            "default": "this"
-          }
-        ],
-        "parameters": [
-          {
-            "name": "properties",
-            "type": "Properties<Omit<T, 'textInputs'>>"
-          }
-        ],
-        "description": "Sets all key-value pairs in the properties object.",
-        "returns": "this"
-      }
-    ]
-  },
   "events": {
     "close": {
       "description": "Fired when the dialog was closed for any reason.",

diff --git a/doc/api/CollectionView.json b/doc/api/CollectionView.json
@@ -152,7 +152,7 @@
         "parameters": [
           {
             "name": "properties",
-            "type": "Properties<Omit<T, 'firstVisibleIndex' | 'lastVisibleIndex'>> & Partial<Pick<this, 'cellHeight' | 'cellType' | 'createCell'>>"
+            "type": "Properties<T> & Partial<Pick<this, 'cellHeight' | 'cellType' | 'createCell'>>"
           }
         ],
         "description": "Sets all key-value pairs in the properties object as widget properties.\n\n**Important TypeScript note:** When called on `this` you may need to specify your custom type like this: `this.set<MyComponent>({propA: valueA});`",

diff --git a/doc/api/NativeObject.json b/doc/api/NativeObject.json
@@ -32,7 +32,8 @@
     "_nativeType": {
       "readonly": true,
       "protected": true,
-      "type": "string"
+      "type": "string",
+      "separateAccessors": true
     },
     "_isDisposed": {
       "protected": true,

diff --git a/doc/api/NavigationBar.json b/doc/api/NavigationBar.json
@@ -68,28 +68,6 @@
       }
     }
   },
-  "methods": {
-    "set": [
-      {
-        "ts_only": true,
-        "generics": [
-          {
-            "name": "T",
-            "extends": "NativeObject",
-            "default": "this"
-          }
-        ],
-        "parameters": [
-          {
-            "name": "properties",
-            "type": "Properties<Omit<T, 'height'>>"
-          }
-        ],
-        "description": "Sets all key-value pairs in the properties object.",
-        "returns": "this"
-      }
-    ]
-  },
   "links": [
     {
       "title": "Demonstrating various properties of the `NavigationBar`",

diff --git a/doc/api/Popover.json b/doc/api/Popover.json
@@ -23,7 +23,7 @@
       "const": true,
       "readonly": true,
       "ts_only": true,
-      "type": "JSXAttributes<Omit<this, 'contentView'>> & {children?: JSXChildren<Widget>}"
+      "type": "JSXAttributes<this> & {children?: JSXChildren<Widget>, contentView?: never}"
     },
     "contentView": {
       "const": true,
@@ -50,28 +50,6 @@
       }
     }
   },
-  "methods": {
-    "set": [
-      {
-        "ts_only": true,
-        "generics": [
-          {
-            "name": "T",
-            "extends": "NativeObject",
-            "default": "this"
-          }
-        ],
-        "parameters": [
-          {
-            "name": "properties",
-            "type": "Properties<Omit<T, 'contentView'>>"
-          }
-        ],
-        "description": "Sets all key-value pairs in the properties object as Popover properties.",
-        "returns": "this"
-      }
-    ]
-  },
   "statics": {
     "methods": {
       "open": [

diff --git a/doc/api/StatusBar.json b/doc/api/StatusBar.json
@@ -56,28 +56,6 @@
       "description": "Background color of the status bar. Should be used in conjunction with the `theme` property to keep the status bar icons legible."
     }
   },
-  "methods": {
-    "set": [
-      {
-        "ts_only": true,
-        "generics": [
-          {
-            "name": "T",
-            "extends": "NativeObject",
-            "default": "this"
-          }
-        ],
-        "parameters": [
-          {
-            "name": "properties",
-            "type": "Properties<Omit<T, 'height'>>"
-          }
-        ],
-        "description": "Sets all key-value pairs in the properties object.",
-        "returns": "this"
-      }
-    ]
-  },
   "events": {
     "tap": {
       "description": "Fired when status bar is tapped.",

diff --git a/doc/api/TabFolder.json b/doc/api/TabFolder.json
@@ -95,7 +95,7 @@
         "selection": {
           "description": "The `Tap` selected by the user.",
           "type": "Tab",
-          "ts_type": "Target extends TabFolder ? Target['selection'] : Tab"
+          "ts_type": "Target extends TabFolder<any> ? Target['selection'] : Tab"
         }
       }
     },
@@ -105,7 +105,7 @@
         "selection": {
           "description": "The current value of the `selection` property.",
           "type": "Tab",
-          "ts_type": "Target extends TabFolder ? Target['selection'] : Tab"
+          "ts_type": "Target extends TabFolder<any> ? Target['selection'] : Tab"
         },
         "offset": {
           "description": "Number of pixels the current tab has scrolled horizontally.",

diff --git a/doc/api/Video.json b/doc/api/Video.json
@@ -96,27 +96,7 @@
         }
       ],
       "description": "Starts playing the video, *[state](#state)* changes to `play`. Has no effect unless the current state is either `pause` or `ready`."
-    },
-    "set": [
-      {
-        "ts_only": true,
-        "generics": [
-          {
-            "name": "T",
-            "extends": "NativeObject",
-            "default": "this"
-          }
-        ],
-        "parameters": [
-          {
-            "name": "properties",
-            "type": "Properties<Omit<T, 'speed' | 'position' | 'duration' | 'state'>>"
-          }
-        ],
-        "description": "Sets all key-value pairs in the properties object as widget properties.\n\n**Important TypeScript note:** When called on `this` you may need to specify your custom type like this: `this.set<MyComponent>({propA: valueA});`",
-        "returns": "this"
-      }
-    ]
+    }
   },
   "links": [
     {

diff --git a/doc/api/WebView.json b/doc/api/WebView.json
@@ -128,26 +128,6 @@
         "parameters": [],
         "description": "Navigate the `WebView` to the next page if possible."
       }
-    ],
-    "set": [
-      {
-        "ts_only": true,
-        "generics": [
-          {
-            "name": "T",
-            "extends": "NativeObject",
-            "default": "this"
-          }
-        ],
-        "parameters": [
-          {
-            "name": "properties",
-            "type": "Properties<Omit<T, 'canGoBack' | 'canGoForward'>>"
-          }
-        ],
-        "description": "Sets all key-value pairs in the properties object as widget properties.\n\n**Important TypeScript note:** When called on `this` you may need to specify your custom type like this: `this.set<MyComponent>({propA: valueA});`",
-        "returns": "this"
-      }
     ]
   },
   "links": [

diff --git a/doc/api/app.json b/doc/api/app.json
@@ -247,27 +247,7 @@
         }
       ],
       "description": "Allows to register a font to use throughout the app. Once a font is registered its alias can be used to apply the font where ever a font can be configured, e.g. in `TextView` or `GraphicalContext`. Tabris.js supports TrueType fonts (*.ttf) and OpenType fonts (*.otf)."
-    },
-    "set": [
-      {
-        "ts_only": true,
-        "generics": [
-          {
-            "name": "T",
-            "extends": "NativeObject",
-            "default": "this"
-          }
-        ],
-        "parameters": [
-          {
-            "name": "properties",
-            "type": "Properties<Omit<T, 'id' | 'debugBuild' | 'versionCode' | 'version'>>"
-          }
-        ],
-        "description": "Sets all key-value pairs in the properties object.",
-        "returns": "this"
-      }
-    ]
+    }
   },
   "links": [
     {

diff --git a/snippets/package.json b/snippets/package.json
@@ -5,7 +5,7 @@
     "tabris": "^3.6.1"
   },
   "devDependencies": {
-    "typescript": "3.8.x"
+    "typescript": "4.0.x"
   },
   "scripts": {
     "build": "tsc -p .",

diff --git a/test/typescript/NavigationBar.fail.ts b/test/typescript/NavigationBar.fail.ts
@@ -6,8 +6,6 @@ navigationBar.height = height;
 navigationBar.onHeightChanged(function() {});
 
 /*Expected
-(4,
-is not assignable to parameter of type
 (5,
 Cannot assign to 'height'
-*/
+*/
diff --git a/test/typescript/StatusBar.fail.ts b/test/typescript/StatusBar.fail.ts
@@ -6,8 +6,6 @@ statusBar.height = height;
 statusBar.onHeightChanged(function() {});
 
 /*Expected
-(4,
-is not assignable to parameter of type
 (5,
 Cannot assign to 'height'
-*/
+*/
diff --git a/test/typescript/Widgets/CollectionView.fail.ts b/test/typescript/Widgets/CollectionView.fail.ts
@@ -14,14 +14,10 @@ widget.lastVisibleIndex = lastVisibleIndex;
 
 /*Expected
 (6,
-(7,
-firstVisibleIndex
 (8,
 firstVisibleIndex
 
 (11,
-(12,
-lastVisibleIndex
 (13,
 lastVisibleIndex
 */
diff --git a/test/typescript/Widgets/Video.fail.ts b/test/typescript/Widgets/Video.fail.ts
@@ -24,26 +24,18 @@ widget.state = 'empty';
 
 /*Expected
 (6,
-(7,
-speed
 (8,
 speed
 
 (11,
-(12,
-position
 (13,
 position
 
 (16,
-(17,
-duration
 (18,
 duration
 
 (21,
-(22,
-state
 (23,
 state
-*/
+*/
diff --git a/test/typescript/Widgets/WebView.fail.ts b/test/typescript/Widgets/WebView.fail.ts
@@ -14,12 +14,10 @@ widget.canGoForward = canGoForward;
 
 /*Expected
 (6,
-(7,
 (8,
 canGoBack
 
 (11,
-(12,
 (13,
 canGoForward
 */
diff --git a/test/typescript/package.json b/test/typescript/package.json
@@ -3,6 +3,6 @@
   "private": true,
   "dependencies": {
     "tabris": "../tabris",
-    "typescript": "3.8.x"
+    "typescript": "4.0.x"
   }
 }
diff --git a/tools/api-schema.d.ts b/tools/api-schema.d.ts
@@ -85,7 +85,7 @@ export interface Api {
   methods?: {
     /**
      * This interface was referenced by `undefined`'s JSON-Schema definition
-     * via the `patternProperty` "(^[_\$]?[a-z]\w+$)|(^\[.*\]$|^\$$)".
+     * via the `patternProperty` "(^[_\$]?[A-Za-z]\w+$)|(^\[.*\]$|^\$$)".
      */
     [k: string]: Method | Method[];
   };
@@ -152,6 +152,10 @@ export interface Property {
    * Exclude this property from documentation
    */
   ts_only?: boolean;
+  /**
+   * Render declaration using separate getter and setter.
+   */
+  separateAccessors?: boolean;
   /**
    * Mark property as protected
    */