@openui5/ts-types 1.115.0 → 1.116.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,23 +4,13 @@
4
4
 
5
5
  This npm package contains the types signatures (based on deprecated globals, see below) for all the OpenUI5 libraries.
6
6
 
7
- These signatures can be used to:
7
+ <b>NOTE:</b> "based on globals" means that it supports the usage of the global "sap" object and the huge tree below this global object containing all modules and controls. But this usage is <b>no longer recommended</b>. In traditional JavaScript, UI5 application code should use the asynchronous `sap.ui.define()`/`sap.ui.require()` calls instead and for TypeScript code we recommend using ES6 module syntax provided by the [@openui5/types](https://www.npmjs.com/package/@openui5/types) package. So better use that one instead of this package.
8
8
 
9
- 1. Enable advanced content assist in IDEs, e.g: (VSCode / IntelliJ / Webstorm) for OpenUI5.
10
- 1. Integrate type checking for OpenUI5 applications using the TypeScript compiler.
11
-
12
- These two capabilities are available both for OpenUI5 apps written in TypeScript **and** in JavaScript.
13
-
14
- <b>NOTE:</b> "based on globals" means that it supports the usage of the global "sap" object and the huge tree below this global object containing all modules and controls. But this usage is <b>no longer recommended</b>. In traditional JavaScript, UI5 application code should use the asynchronous sap.ui.define()/sap.ui.require() calls instead and for TypeScript code we recommend using ES6 module syntax provided by the [@openui5/ts-types-esm](https://www.npmjs.com/package/@openui5/ts-types-esm) package. So better use that one instead of this package.
9
+ The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is at https://sap.github.io/ui5-typescript.
15
10
 
16
11
  ## Status
17
12
 
18
- This project is in an experimental **_Beta State_**. Significant changes are likely to occur,
19
- including potential **breaking changes**.
20
-
21
- For information on changes in the type definitions, in particular ones which require adaptation, please refer to the [Release Notes](https://sap.github.io/ui5-typescript/releasenotes.html).
22
-
23
- The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is at https://sap.github.io/ui5-typescript.
13
+ This project **deprecated**. Please use [@openui5/types](https://www.npmjs.com/package/@openui5/types) instead.
24
14
 
25
15
  ## License
26
- OpenUI5 is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
16
+ OpenUI5 and the type definitions in this package are copyright by SAP and contributors and licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types",
3
- "version": "1.115.0",
3
+ "version": "1.116.0",
4
4
  "description": "OpenUI5 TypeScript Definitions",
5
5
  "homepage": "https://openui5.org",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/index.d.ts CHANGED
@@ -16,9 +16,15 @@
16
16
  */
17
17
 
18
18
  /**
19
- * This is a Beta version of the OpenUI5 TypeScript signatures.
20
- * Significant changes may occur in future versions,
21
- * including potential breaking changes.
19
+ * We encourage you to use SAPUI5 with TypeScript productively for an
20
+ * improved development efficiency and experience. TypeScript itself keeps
21
+ * evolving and we try to further improve the UI5 type definitions, so there
22
+ * could be potential incompatible changes between versions of the type
23
+ * definitions. However, such incompatibilities would only affect the
24
+ * compilation of your code but will not cause runtime issues in your
25
+ * application. Plus, there are various ways to easily deal with them:
26
+ * you can, for example, simply keep using the previous version of the
27
+ * UI5 type definitions together with an updated UI5 runtime.
22
28
  */
23
29
  /// <reference path="./sap.ui.codeeditor.d.ts"/>
24
30
  /// <reference path="./sap.ui.commons.d.ts"/>