More tests, tweaks

Author: ggetz

.gitignore

@@ -19,8 +19,6 @@ Thumbs.db
 /Source/Widgets/
 /Source/Cesium.js
 
-types
-
 /Specs/SpecList.js
 /Specs/jasmine/**
 

CHANGES.md

@@ -300,7 +300,7 @@ This is an npm-only release to fix a dependency issue published in 1.118
 
 ##### Breaking Changes :mega:
 
-- By default, instances of `Cesium3DTileset ` will no longer default to enable collisions for camera collision or for clamping entities. [#11829](https://github.com/CesiumGS/cesium/pull/11829)
+- By default, instances of `Cesium3DTileset` will no longer default to enable collisions for camera collision or for clamping entities. [#11829](https://github.com/CesiumGS/cesium/pull/11829)
   - This behavior can be enabled by setting `Cesium3DTileset.enableCollision` to true.
 
 ##### Additions :tada:
@@ -605,6 +605,7 @@ try {
 - `Cesium3DTileset` constructor parameter `options.url`, `Cesium3DTileset.ready`, and `Cesium3DTileset.readyPromise` have been removed. Use `Cesium3DTileset.fromUrl` instead.
 - `createOsmBuildings` was removed. Use `createOsmBuildingsAsync` instead.
 - `Model.fromGltf`, `Model.readyPromise`, and `Model.texturesLoadedPromise` have been removed. Use `Model.fromGltfAsync`, `Model.readyEvent`, `Model.errorEvent`, and `Model.texturesReadyEvent` instead. For example:
+
   ```js
   try {
     const model = await Cesium.Model.fromGltfAsync({
@@ -618,6 +619,7 @@ try {
     console.log(`Failed to load model. ${error}`);
   }
   ```
+
 - `I3SDataProvider` construction parameter `options.url`, `I3SDataProvider.ready`, and `I3SDataProvider.readyPromise` have been removed. Use `I3SDataProvider.fromUrl` instead.
 - `TimeDynamicPointCloud.readyPromise` was removed. Use `TimeDynamicPointCloud.frameFailed` to track any errors.
 - `VoxelProvider.ready` and `VoxelProvider.readyPromise` have been removed.
@@ -789,6 +791,7 @@ try {
 - `Cesium3DTileset` constructor parameter `options.url`, `Cesium3DTileset.ready`, and `Cesium3DTileset.readyPromise` were deprecated in CesiumJS 1.104. They will be removed in 1.107. Use `Cesium3DTileset.fromUrl` instead.
 - `createOsmBuildings` was deprecated in CesiumJS 1.104. It will be removed in 1.107. Use `createOsmBuildingsAsync` instead.
 - `Model.fromGltf`, `Model.readyPromise`, and `Model.texturesLoadedPromise` were deprecated in CesiumJS 1.104. They will be removed in 1.107. Use `Model.fromGltfAsync`, `Model.readyEvent`, `Model.errorEvent`, and `Model.texturesReadyEvent` instead. For example:
+
   ```js
   try {
     const model = await Cesium.Model.fromGltfAsync({
@@ -802,6 +805,7 @@ try {
     console.log(`Failed to load model. ${error}`);
   }
   ```
+
 - `I3SDataProvider` construction parameter `options.url`, `I3SDataProvider.ready`, and `I3SDataProvider.readyPromise` were deprecated in CesiumJS 1.104. They will be removed in 1.107. Use `I3SDataProvider.fromUrl` instead.
 - `TimeDynamicPointCloud.readyPromise` was deprecated in CesiumJS 1.104. It will be removed in 1.107. Use `TimeDynamicPointCloud.frameFailed` to track any errors.
 - `VoxelProvider.ready` and `VoxelProvider.readyPromise` were deprecated in CesiumJS 1.104. They will be removed in 1.107.
@@ -851,9 +855,11 @@ try {
 #### Major Announcements :loudspeaker:
 
 - CesiumJS now defaults to using a WebGL2 context for rendering. WebGL2 is widely supported on all platforms and this results in better feature support across devices, especially mobile.
+
   - WebGL1 is supported. If WebGL2 is not available, CesiumJS will automatically fall back to WebGL1.
   - In order to work in a WebGL2 context, any custom materials, custom primitives or custom shaders will need to be upgraded to use GLSL 300.
   - Otherwise to request a WebGL 1 context, set `requestWebgl1` to `true` when providing `ContextOptions` as shown below:
+
     ```js
     const viewer = new Viewer("cesiumContainer", {
       contextOptions: {
@@ -880,9 +886,11 @@ try {
 #### Major Announcements :loudspeaker:
 
 - Starting with version 1.102, CesiumJS will default to using a WebGL2 context for rendering. WebGL2 is widely supported on all platforms and this change will result in better feature support across devices, especially mobile.
+
   - WebGL1 will still be supported. If WebGL2 is not available, CesiumJS will automatically fall back to WebGL1.
   - In order to work in a WebGL2 context, any custom materials, custom primitive or custom shaders will need to be upgraded to use GLSL 300.
   - Otherwise to request a WebGL 1 context, set `requestWebgl1` to `true` when providing `ContextOptions` as shown below:
+
     ```js
     const viewer = new Viewer("cesiumContainer", {
       contextOptions: {
@@ -2259,12 +2267,15 @@ _This is an npm-only release to fix a publishing issue_.
 ##### Breaking Changes :mega:
 
 - Clipping planes on tilesets now use the root tile's transform, or the root tile's bounding sphere if a transform is not defined. [#7034](https://github.com/CesiumGS/cesium/pull/7034)
+
   - This is to make clipping planes' coordinates always relative to the object they're attached to. So if you were positioning the clipping planes as in the example below, this is no longer necessary:
+
   ```javascript
   clippingPlanes.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(
     tileset.boundingSphere.center,
   );
   ```
+
   - This also fixes several issues with clipping planes not using the correct transform for tilesets with children.
 
 ##### Additions :tada:
@@ -2501,6 +2512,7 @@ _This is an npm-only release to fix a publishing issue_.
 - `BingMapsImageryProvider` is no longer the default base imagery layer. (Bing imagery itself is still the default, however it is provided through Cesium ion)
 - `BingMapsGeocoderService` is no longer the default geocoding service.
 - If you wish to continue to use your own Bing API key for imagery and geocoding, you can go back to the old default behavior by constructing the Viewer as follows:
+
   ```javascript
   Cesium.BingMapsApi.defaultKey = "yourBingKey";
   var viewer = new Cesium.Viewer("cesiumContainer", {
@@ -3364,11 +3376,13 @@ _This is an npm-only release to fix a publishing issue_.
 - Added `VRButton` which is a simple, single-button widget that toggles VR mode. It is off by default. To enable the button, set the `vrButton` option to `Viewer` to `true`. Only Cardboard for mobile is supported. More VR devices will be supported when the WebVR API is more stable.
 - Added `Scene.useWebVR` to switch the scene to use stereoscopic rendering.
 - Cesium now honors `window.devicePixelRatio` on browsers that support the CSS `imageRendering` attribute. This greatly improves performance on mobile devices and high DPI displays by rendering at the browser-recommended resolution. This also reduces bandwidth usage and increases battery life in these cases. To enable the previous behavior, use the following code:
+
   ```javascript
   if (Cesium.FeatureDetection.supportsImageRenderingPixelated()) {
     viewer.resolutionScale = window.devicePixelRatio;
   }
   ```
+
 - `GroundPrimitive` now supports batching geometry for better performance.
 - Improved compatibility with glTF KHR_binary_glTF and KHR_materials_common extensions
 - Added `ImageryLayer.getViewableRectangle` to make it easy to get the effective bounds of an imagery layer.
@@ -4008,14 +4022,17 @@ _This is an npm-only release to fix a publishing issue_.
   - `ImageryLayer` properties `alpha`, `brightness`, `contrast`, `hue`, `saturation`, and `gamma` may no longer be functions. If you need to change these values each frame, consider moving your logic to an event handler for `Scene.preRender`.
   - Removed `closeTop` and `closeBottom` options from `RectangleGeometry`.
   - CZML changes:
+
     - CZML is now versioned using the <major>.<minor> scheme. For example, any CZML 1.0 implementation will be able to load any 1.<minor> document (with graceful degradation). Major version number increases will be reserved for breaking changes. We fully expect these major version increases to happen, as CZML is still in development, but we wanted to give developers a stable target to work with.
     - A `"1.0"` version string is required to be on the document packet, which is required to be the first packet in a CZML file. Previously the `document` packet was optional; it is now mandatory. The simplest document packet is:
+
       ```
       {
         "id":"document",
         "version":"1.0"
       }
       ```
+
     - The `vertexPositions` property has been removed. There is now a `positions` property directly on objects that use it, currently `polyline`, `polygon`, and `wall`.
     - `cone`, `pyramid`, and `vector` have been removed from the core CZML schema. They are now treated as extensions maintained by Analytical Graphics and have been renamed to `agi_conicSensor`, `agi_customPatternSensor`, and `agi_vector` respectively.
     - The `orientation` property has been changed to match Cesium convention. To update existing CZML documents, conjugate the quaternion values.

Source/Cesium.d.ts

@@ -0,0 +1 @@
+export * from "./Cesium.js";

Specs/TypeScript/tsconfig.json

@@ -6,7 +6,6 @@
     "isolatedModules": true
   },
   "include": [
-    "index.ts",
-    "../../types/Cesium.d.ts"
+    "index.ts"
   ]
 }

package.json

@@ -30,7 +30,7 @@
   },
   "main": "index.cjs",
   "module": "./Source/Cesium.js",
-  "types": "types/Cesium.d.ts",
+  "types": "Source/Cesium.d.ts",
   "exports": {
     "./package.json": "./package.json",
     "./Source/*": "./Source/*",
@@ -160,5 +160,8 @@
   "workspaces": [
     "packages/engine",
     "packages/widgets"
-  ]
+  ],
+  "tsd": {
+    "directory": "Specs/TypeScript"
+  }
 }

packages/engine/Source/Core/Check.d.ts

@@ -63,7 +63,7 @@ declare namespace Check {
      * @param {*} test The value to test
      * @exception {DeveloperError} test must be typeof 'number'
      */
-    function number(name: string, test: any): asserts test is string;
+    function number(name: string, test: any): asserts test is number;
     namespace number {
       /**
        * Throws if test is not typeof 'number' and less than limit

packages/engine/Source/Core/EllipsoidTerrainProvider.js

@@ -6,6 +6,11 @@ import GeographicTilingScheme from "./GeographicTilingScheme.js";
 import HeightmapTerrainData from "./HeightmapTerrainData.js";
 import TerrainProvider from "./TerrainProvider.js";
 
+/**
+ * @typedef {import("./Request").default} Request
+ * @typedef {import("./TerrainData").default} TerrainData
+ */
+
 /**
  * A very simple {@link TerrainProvider} that produces geometry by tessellating an ellipsoidal
  * surface.

packages/engine/Source/Core/TerrainProvider.js

@@ -3,16 +3,23 @@ import DeveloperError from "./DeveloperError.js";
 import IndexDatatype from "./IndexDatatype.js";
 import CesiumMath from "./Math.js";
 
+/**
+ * @typedef {import("./Request").default} Request
+ * @typedef {import("./TerrainData").default} TerrainData
+ */
+
 /**
  * Provides terrain or other geometry for the surface of an ellipsoid.  The surface geometry is
  * organized into a pyramid of tiles according to a {@link TilingScheme}.  This type describes an
  * interface and is not intended to be instantiated directly.
  *
  * @alias TerrainProvider
  * @constructor
+ * @interface
  *
  * @see EllipsoidTerrainProvider
  * @see CesiumTerrainProvider
+ * @see ArcGISTiledElevationTerrainProvider
  * @see VRTheWorldTerrainProvider
  * @see GoogleEarthEnterpriseTerrainProvider
  */
@@ -388,7 +395,9 @@ TerrainProvider.getEstimatedLevelZeroGeometricErrorForAHeightmap = function (
  *          pending and the request will be retried later.
  */
 TerrainProvider.prototype.requestTileGeometry =
-  DeveloperError.throwInstantiationError;
+  /** @type {(x: number, y: number, level: number, request?: Request) => Promise<TerrainData>|undefined} */ (
+    DeveloperError.throwInstantiationError
+  );
 
 /**
  * Gets the maximum geometric error allowed in a tile at a given level.
@@ -398,7 +407,9 @@ TerrainProvider.prototype.requestTileGeometry =
  * @returns {number} The maximum geometric error.
  */
 TerrainProvider.prototype.getLevelMaximumGeometricError =
-  DeveloperError.throwInstantiationError;
+  /** @type {(level: number) => number} */ (
+    DeveloperError.throwInstantiationError
+  );
 
 /**
  * Determines whether data for a tile is available to be loaded.
@@ -410,7 +421,9 @@ TerrainProvider.prototype.getLevelMaximumGeometricError =
  * @returns {boolean|undefined} Undefined if not supported by the terrain provider, otherwise true or false.
  */
 TerrainProvider.prototype.getTileDataAvailable =
-  DeveloperError.throwInstantiationError;
+  /** @type {(x: number, y: number, level: number) => boolean|undefined} */ (
+    DeveloperError.throwInstantiationError
+  );
 
 /**
  * Makes sure we load availability data for a tile
@@ -422,7 +435,10 @@ TerrainProvider.prototype.getTileDataAvailable =
  * @returns {undefined|Promise<void>} Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded
  */
 TerrainProvider.prototype.loadTileDataAvailability =
-  DeveloperError.throwInstantiationError;
+  /** @type {(x: number, y: number, level: number) => undefined|Promise<void>} */ (
+    DeveloperError.throwInstantiationError
+  );
+
 export default TerrainProvider;
 
 /**

packages/engine/Source/Core/VRTheWorldTerrainProvider.js

@@ -14,6 +14,11 @@ import RuntimeError from "./RuntimeError.js";
 import TerrainProvider from "./TerrainProvider.js";
 import TileProviderError from "./TileProviderError.js";
 
+/**
+ * @typedef {import("./Request").default} Request
+ * @typedef {import("./TerrainData").default} TerrainData
+ */
+
 function DataRectangle(rectangle, maxLevel) {
   this.rectangle = rectangle;
   this.maxLevel = maxLevel;

packages/engine/Specs/types/Core/Check.test-d.ts

@@ -0,0 +1,48 @@
+import { expectAssignable, expectNotAssignable } from "tsd";
+import { Check } from "@cesium/engine";
+
+// Verify Check.* asserts expected type
+
+let myVar: string | undefined;
+Check.defined("defined", myVar);
+expectNotAssignable<undefined>(myVar);
+
+let myString: string | number | undefined;
+Check.typeOf.string("string", myString);
+expectAssignable<string>(myString);
+
+let myFunc: undefined | string | (() => any);
+Check.typeOf.func("function", myFunc);
+expectAssignable<() => any>(myFunc);
+
+let myObject: object | string | undefined;
+Check.typeOf.object("object", myObject);
+expectAssignable<object>(myObject);
+
+let myBool: boolean | string | undefined;
+Check.typeOf.bool("boolean", myBool);
+expectAssignable<boolean>(myBool);
+
+let myBigInt: BigInt | string | undefined;
+Check.typeOf.number("BigInt", myBigInt);
+expectAssignable<BigInt>(myBigInt);
+
+let myNumber: string | number | undefined;
+Check.typeOf.number("number", myNumber);
+expectAssignable<number>(myNumber);
+
+let myNumberLessThan: string | number | undefined;
+Check.typeOf.number.lessThan("lessThan", myNumberLessThan, 100);
+expectAssignable<number>(myNumberLessThan);
+
+let myNumberLessThanEquals: string | number | undefined;
+Check.typeOf.number.lessThanOrEquals("lessThanEquals", myNumberLessThanEquals, 100);
+expectAssignable<number>(myNumberLessThanEquals);
+
+let myNumberGreaterThan: string | number | undefined;
+Check.typeOf.number.greaterThan("greaterThan", myNumberGreaterThan, 100);
+expectAssignable<number>(myNumberGreaterThan);
+
+let myNumberGreaterThanEquals: string | number | undefined;
+Check.typeOf.number.greaterThanOrEquals("greaterThanEquals", myNumberGreaterThanEquals, 100);
+expectAssignable<number>(myNumberGreaterThanEquals);

packages/engine/Specs/types/Core/TerrainProvider.test-d.ts

@@ -0,0 +1,10 @@
+import { expectAssignable } from "tsd";
+
+import { ArcGISTiledElevationTerrainProvider, CesiumTerrainProvider, EllipsoidTerrainProvider, GoogleEarthEnterpriseTerrainProvider, Terrain, TerrainProvider, VRTheWorldTerrainProvider } from "@cesium/engine";
+
+// Verify TerrainProvider instances conform to the expected interface
+expectAssignable<TerrainProvider>(new ArcGISTiledElevationTerrainProvider());
+expectAssignable<TerrainProvider>(new CesiumTerrainProvider());
+expectAssignable<TerrainProvider>(new EllipsoidTerrainProvider());
+expectAssignable<TerrainProvider>(new VRTheWorldTerrainProvider());
+expectAssignable<TerrainProvider>(new GoogleEarthEnterpriseTerrainProvider());

packages/engine/Specs/types/index.test-d.ts renamed to packages/engine/Specs/types/DataSources/Property.test-d.ts

@@ -0,0 +1,34 @@
+import { expectAssignable } from "tsd";
+import { ArcGisMapServerImageryProvider, BingMapsImageryProvider, Color, GoogleEarthEnterpriseImageryProvider, GoogleEarthEnterpriseMapsProvider, GridImageryProvider, ImageryProvider, IonImageryProvider, MapboxImageryProvider, MapboxStyleImageryProvider, OpenStreetMapImageryProvider, SingleTileImageryProvider, TileCoordinatesImageryProvider, TileMapServiceImageryProvider, UrlTemplateImageryProvider, WebMapServiceImageryProvider, WebMapTileServiceImageryProvider } from "@cesium/engine"
+
+// Verify ImageryProvider instances conform to the expected interface
+expectAssignable<ImageryProvider>(new WebMapServiceImageryProvider({ url: "", layers: "0" }));
+expectAssignable<ImageryProvider>(new ArcGisMapServerImageryProvider());
+expectAssignable<ImageryProvider>(new BingMapsImageryProvider({ key: "" }));
+expectAssignable<ImageryProvider>(new OpenStreetMapImageryProvider({ url: "" }));
+expectAssignable<ImageryProvider>(new TileMapServiceImageryProvider());
+expectAssignable<ImageryProvider>(new GridImageryProvider({
+  tileWidth: 256,
+  tileHeight: 256,
+  color: new Color(1.0, 1.0, 1.0, 0.4),
+}));
+expectAssignable<ImageryProvider>(new IonImageryProvider());
+expectAssignable<ImageryProvider>(new MapboxImageryProvider({ mapId: "", accessToken: "" }));
+expectAssignable<ImageryProvider>(new MapboxStyleImageryProvider({
+  styleId: "",
+  accessToken: "",
+}));
+expectAssignable<ImageryProvider>(new SingleTileImageryProvider({ url: "" }));
+expectAssignable<ImageryProvider>(new TileCoordinatesImageryProvider());
+expectAssignable<ImageryProvider>(new UrlTemplateImageryProvider({ url: "" }));
+expectAssignable<ImageryProvider>(new WebMapServiceImageryProvider({ url: "", layers: "" }));
+expectAssignable<ImageryProvider>(new GoogleEarthEnterpriseImageryProvider());
+expectAssignable<ImageryProvider>(new GoogleEarthEnterpriseMapsProvider({
+  channel: 1,
+}));
+expectAssignable<ImageryProvider>(new WebMapTileServiceImageryProvider({
+  url: "",
+  layer: "",
+  style: "",
+  tileMatrixSetID: "",
+}));