@vcmap/core 6.1.11 → 6.2.0-rc.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "6.1.11",
+  "version": "6.2.0-rc.2",
   "description": "",
   "main": "dist/index.js",
   "type": "module",
@@ -13,13 +13,16 @@
     "lint": "npm run lint:js && npm run lint:prettier",
     "format": "prettier --write --list-different . && npm run lint:js -- --fix",
     "type-check": "tsc --noEmit",
-    "postinstall": "node build/postinstall.js",
+    "postinstall": "node build/postinstall.js && node build/buildShader.js",
     "coverage": "c8 --reporter text-summary npm run test",
     "coverage:gitlab": "c8 --reporter text-summary npm run test -- --reporter mocha-junit-reporter",
     "build-docs": "typedoc index.ts --out docs --skipErrorChecking",
+    "build-shader": "node build/buildShader.js",
+    "prebuild": "node build/buildShader.js",
     "build": "tsc && node -e \"require('fs').cpSync('tests/data', 'dist/tests/data', { recursive: true })\"",
     "postbuild": "node build/postBuild.js",
-    "watch": "tsc --watch",
+    "watch": "node build/watch.js",
+    "circular-check": "madge --circular src/**/*.ts",
     "prepare": "npm run build"
   },
   "repository": {
@@ -28,12 +31,14 @@
   },
   "files": [
     "build/postinstall.js",
+    "build/buildShader.js",
     "src/",
     "dist/",
     "LICENSE.md",
     "README.md",
     "index.ts",
-    "!dist/tsconfig.tsbuildinfo"
+    "!dist/tsconfig.tsbuildinfo",
+    "!**/*.shader.ts"
   ],
   "author": "Virtual City Systems",
   "license": "MIT",
@@ -46,14 +51,14 @@
     "@types/proj4": "^2.5.5",
     "@types/sinon": "^10.0.15",
     "@types/sinon-chai": "^3.2.12",
-    "@vcsuite/eslint-config": "^3.0.5",
+    "@vcsuite/eslint-config": "^4.0.0",
     "c8": "^10.1.2",
     "canvas": "^2.11.2",
     "chai": "^4.4.1",
     "chai-as-promised": "^8.0.1",
-    "eslint": "^8.38.0",
     "jsdom": "^24.1.0",
     "jsdom-global": "^3.0.2",
+    "madge": "^8.0.0",
     "mocha": "^10.0.0",
     "mocha-junit-reporter": "^2.2.1",
     "nock": "^13.5.4",
@@ -66,60 +71,23 @@
     "typescript": "^5.6.2"
   },
   "peerDependencies": {
-    "@vcmap-cesium/engine": "^11.0.2",
+    "@vcmap-cesium/engine": "^11.0.3",
     "ol": "^10.4.0"
   },
-  "eslintConfig": {
-    "extends": [
-      "@vcsuite/eslint-config/node-ts"
-    ],
-    "env": {
-      "browser": true
-    },
-    "rules": {
-      "no-restricted-syntax": "off",
-      "import/extensions": [
-        "error",
-        "always"
-      ]
-    },
-    "overrides": [
-      {
-        "files": [
-          "*.ts",
-          "*.vue"
-        ],
-        "parserOptions": {
-          "project": [
-            "./tsconfig.json",
-            "./tests/tsconfig.json"
-          ]
-        },
-        "rules": {
-          "@typescript-eslint/no-non-null-assertion": "off",
-          "@typescript-eslint/no-unused-vars": "off",
-          "@typescript-eslint/no-explicit-any": "off"
-        }
-      }
-    ]
-  },
-  "eslintIgnore": [
-    "node_modules",
-    "coverage",
-    "docs",
-    "dist",
-    ".tests"
-  ],
   "prettier": "@vcsuite/eslint-config/prettier.js",
   "dependencies": {
-    "@vcsuite/check": "^2.1.0",
+    "@vcsuite/check": "^3.0.0",
     "@vcsuite/logger": "^1.0.1",
     "@vcsuite/parsers": "^2.0.0",
     "fast-deep-equal": "^3.1.3",
     "flatgeobuf": "^3.38.0",
+    "geotiff": "^2.1.3",
     "proj4": "^2.15.0",
     "rbush": ">=4.0.0",
     "rbush-knn": "^4.0.0",
     "uuid": "^11.1.0"
+  },
+  "engines": {
+    "node": "^20.0.0"
   }
 }

package/src/category/category.ts

@@ -2,21 +2,24 @@ import { check } from '@vcsuite/check';
 import { Feature } from 'ol';
 import type { GeoJSONFeature } from 'ol/format/GeoJSON.js';
 import { destroyCollection } from '../vcsModuleHelpers.js';
-import makeOverrideCollection, {
-  isOverrideCollection,
+import type {
   OverrideCollection,
   ReplacedEvent,
 } from '../util/overrideCollection.js';
-import VcsObject, { VcsObjectOptions } from '../vcsObject.js';
+import makeOverrideCollection, {
+  isOverrideCollection,
+} from '../util/overrideCollection.js';
+import type { VcsObjectOptions } from '../vcsObject.js';
+import VcsObject from '../vcsObject.js';
 import VectorLayer, { type VectorOptions } from '../layer/vectorLayer.js';
 import IndexedCollection from '../util/indexedCollection.js';
 import { parseGeoJSON, writeGeoJSONFeature } from '../layer/geojsonHelpers.js';
 import Collection from '../util/collection.js';
 import { getStyleOrDefaultStyle } from '../style/styleFactory.js';
+import type { TypedConstructorOptions } from '../classRegistry.js';
 import {
   categoryClassRegistry,
   getObjectFromClassRegistry,
-  TypedConstructorOptions,
 } from '../classRegistry.js';
 import OverrideClassRegistry from '../overrideClassRegistry.js';
 import VcsEvent from '../vcsEvent.js';
@@ -205,10 +208,10 @@ class Category<
     }
   }
 
-  // eslint-disable-next-line class-methods-use-this,no-unused-vars
+  // eslint-disable-next-line class-methods-use-this,@typescript-eslint/no-unused-vars
   protected _itemReplaced(_item: ReplacedEvent<T>): void {}
 
-  // eslint-disable-next-line class-methods-use-this,no-unused-vars
+  // eslint-disable-next-line class-methods-use-this,@typescript-eslint/no-unused-vars
   protected _itemMoved(_item: T): void {}
 
   private _getDynamicModuleId(): string {

package/src/category/categoryCollection.ts

@@ -1,9 +1,10 @@
 import { getLogger as getLoggerByName, type Logger } from '@vcsuite/logger';
-import Category, { CategoryOptions } from './category.js';
+import type { CategoryOptions } from './category.js';
+import Category from './category.js';
 import IndexedCollection from '../util/indexedCollection.js';
 import { getObjectFromClassRegistry } from '../classRegistry.js';
 import type VcsApp from '../vcsApp.js';
-import VcsObject from '../vcsObject.js';
+import type VcsObject from '../vcsObject.js';
 
 function getLogger(): Logger {
   return getLoggerByName('CategoryCollection');
@@ -18,7 +19,7 @@ class CategoryCollection extends IndexedCollection<Category> {
   /**
    * Map of category names, where the value is a map of moduleId and items.
    */
-  private _cache: Map<string, Map<string, object[]>> = new Map();
+  private _cache = new Map<string, Map<string, object[]>>();
 
   private _moduleRemovedListener: () => void;
 

package/src/cesium/cesium.d.ts

@@ -1,35 +1,68 @@
+/* eslint-disable @typescript-eslint/no-explicit-any,@typescript-eslint/consistent-type-imports,@typescript-eslint/naming-convention */
 /**
  * Type overrides for types extended by the @vcmap/core API
  */
 // eslint-disable-next-line max-classes-per-file
-import {
-  Cartesian2,
-  Cartesian3,
-  Cartesian4,
-  Color,
-  Cartographic,
-  HeightReference,
-} from '@vcmap-cesium/engine';
-import { StyleLike } from 'ol/style/Style.js';
-import VectorStyleItem from '../style/vectorStyleItem.js';
-import { scaleSymbol } from '../layer/cesium/vectorContext.js';
-import { allowPicking, vcsLayerName } from '../layer/layerSymbols.js';
-import {
+import type { StyleLike } from 'ol/style/Style.js';
+import type VectorStyleItem from '../style/vectorStyleItem.js';
+import type { allowPicking, vcsLayerName } from '../layer/layerSymbols.js';
+import type {
   globalHidden,
   hidden,
   highlighted,
   originalStyle,
 } from '../layer/featureVisibility.js';
-import { handlerSymbol } from '../util/editor/editorSymbols.js';
-import { AxisAndPlanes } from '../util/editor/transformation/transformationTypes.js';
-import {
+import type { handlerSymbol } from '../util/editor/editorSymbols.js';
+import type { AxisAndPlanes } from '../util/editor/transformation/transformationTypes.js';
+import type {
   cesiumTilesetLastUpdated,
   updateFeatureOverride,
 } from '../layer/cesium/cesiumTilesetCesiumImpl.js';
-import { isTiledFeature } from '../layer/featureStoreLayer.js';
-import { vectorClusterGroupName } from '../vectorCluster/vectorClusterSymbols.js';
+import type { isTiledFeature } from '../layer/featureStoreLayer.js';
+import type { vectorClusterGroupName } from '../vectorCluster/vectorClusterSymbols.js';
+import { scaleSymbol } from '../layer/vectorSymbols.js';
 
 declare module '@vcmap-cesium/engine' {
+  enum TextureWarp {
+    CLAMP_TO_EDGE = 33071,
+    REPEAT = 10497,
+    MIRRORED_REPEAT = 33648,
+  }
+
+  class Sampler {
+    constructor(options: {
+      warpS?: TextureWarp;
+      warpT?: TextureWarp;
+      minificationFilter?: TextureMinificationFilter;
+      magnificationFilter?: TextureMagnificationFilter;
+      maximumAnisotropy?: number;
+    });
+
+    readonly warpS: TextureWarp;
+    readonly warpT: TextureWarp;
+    readonly minificationFilter: TextureMinificationFilter;
+    readonly magnificationFilter: TextureMagnificationFilter;
+    readonly maximumAnisotropy: number;
+  }
+
+  class Texture {
+    constructor(options: {
+      context: Context;
+      source?: any;
+      pixelFormat?: PixelFormat;
+      pixelDatatype?: PixelDatatype;
+      width?: number;
+      height?: number;
+      sampler?: Sampler;
+      flipY?: boolean;
+      preMultiplyAlpha?: boolean;
+      skipColorSpaceConversion?: boolean;
+    });
+
+    isDestroyed(): boolean;
+    destroy(): void;
+  }
+
   interface Scene {
     render(): void;
     frameState: FrameState;
@@ -206,6 +239,7 @@ declare module '@vcmap-cesium/engine' {
 
   interface StyleExpression {
     evaluate<
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
       T extends
         | boolean
         | number
@@ -405,4 +439,9 @@ declare module '@vcmap-cesium/engine' {
     _totalPositions: number;
     setDirty(): void;
   }
+
+  interface WebMercatorTilingScheme {
+    _projection: MapProjection;
+    _rectangle: Rectangle;
+  }
 }

package/src/cesium/cesium3DTileFeature.ts

@@ -1,22 +1,21 @@
-import {
-  Cesium3DTileFeature,
-  Cesium3DTilePointFeature,
-} from '@vcmap-cesium/engine';
+import type { Cesium3DTilePointFeature } from '@vcmap-cesium/engine';
+import { Cesium3DTileFeature } from '@vcmap-cesium/engine';
 
 Cesium3DTileFeature.prototype.getId = function getId(
   this: Cesium3DTileFeature,
 ): string | number {
   return (
     (this.getProperty('id') as string | number) ||
-    `${this.content.url}${this._batchId}`
+    `${this.content.url}${String(this._batchId)}`
   ); // XXX there is a new property `featureId` on the Cesium3DTileset. this may cause issues when picking b3dm.
 };
 
-// eslint-disable-next-line import/prefer-default-export
 export function getAttributes(
   this: Cesium3DTileFeature | Cesium3DTilePointFeature,
 ): Record<string, unknown> {
-  if ((this.tileset.asset as { version: string })?.version === '1.1') {
+  if (
+    (this.tileset.asset as { version: string } | undefined)?.version === '1.1'
+  ) {
     const attributes: Record<string, unknown> = {};
     this.getPropertyIds().forEach((id) => {
       attributes[id] = this.getProperty(id);

package/src/cesium/cesiumVcsCameraPrimitive.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 import {
   Cartesian3,
   Matrix3,
@@ -164,16 +165,16 @@ class VcsCameraPrimitive {
   destroy(): void {
     const { length } = this._planesPrimitives;
     for (let i = 0; i < length; ++i) {
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
+      // @ts-expect-error cs code
       this._outlinePrimitives[i] =
+        // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
         this._outlinePrimitives[i] && this._outlinePrimitives[i].destroy();
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
+      // @ts-expect-error cs code
       this._planesPrimitives[i] =
+        // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
         this._planesPrimitives[i] && this._planesPrimitives[i].destroy();
     }
-    return destroyObject(this);
+    destroyObject(this);
   }
 }
 

package/src/cesium/entity.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { Entity } from '@vcmap-cesium/engine';
 
 Entity.prototype.getId = function getId(this: Entity): string | number {
@@ -28,6 +29,5 @@ Entity.prototype.getPropertyInherited = function getPropertyInherited(
   this: Entity,
   property: string,
 ): any {
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-return
   return this.getProperty(property);
 };

package/src/classRegistry.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { is, check, oneOf } from '@vcsuite/check';
 import { getLogger, type Logger } from '@vcsuite/logger';
 import OverrideClassRegistry from './overrideClassRegistry.js';
@@ -14,7 +15,7 @@ function logger(): Logger {
 
 export type AbstractCtor = new (...args: any) => any;
 
-export type Ctor<T extends AbstractCtor> = new (
+export type CtorType<T extends AbstractCtor> = new (
   ...params: any
 ) => InstanceType<T>;
 
@@ -24,7 +25,7 @@ export type TypedConstructorOptions = { type?: string } & Record<
 >;
 
 class ClassRegistry<T extends AbstractCtor> {
-  private _classMap: Map<string, Ctor<T>>;
+  private _classMap: Map<string, CtorType<T>>;
 
   constructor() {
     this._classMap = new Map();
@@ -39,7 +40,7 @@ class ClassRegistry<T extends AbstractCtor> {
    * @param  className
    * @param  ctor
    */
-  registerClass(className: string, ctor: Ctor<T>): void {
+  registerClass(className: string, ctor: CtorType<T>): void {
     check(className, String);
     check(ctor, Function);
 
@@ -55,7 +56,7 @@ class ClassRegistry<T extends AbstractCtor> {
   /**
    * Gets the constructor for a registered class or undefined, if no such class was registerd
    */
-  getClass(className: string): Ctor<T> | undefined {
+  getClass(className: string): CtorType<T> | undefined {
     check(className, String);
 
     if (this._classMap.has(className)) {
@@ -73,6 +74,7 @@ class ClassRegistry<T extends AbstractCtor> {
   create(className: string, ...args: unknown[]): InstanceType<T> | undefined {
     check(className, String);
 
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     const Ctor = this.getClass(className);
     if (!Ctor) {
       logger().error(`could not find constructor ${className}`);
@@ -88,35 +90,34 @@ class ClassRegistry<T extends AbstractCtor> {
   ): InstanceType<T> | undefined {
     check(options, { type: String });
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    return this.create(options.type as string, options, ...args);
+    return this.create(options.type, options, ...args);
   }
 }
 
 export default ClassRegistry;
 
-export const layerClassRegistry: ClassRegistry<typeof Layer> =
-  new ClassRegistry();
+export const layerClassRegistry = new ClassRegistry<typeof Layer>();
 
-export const tileProviderClassRegistry: ClassRegistry<typeof TileProvider> =
-  new ClassRegistry();
+export const tileProviderClassRegistry = new ClassRegistry<
+  typeof TileProvider
+>();
 
-export const featureProviderClassRegistry: ClassRegistry<
+export const featureProviderClassRegistry = new ClassRegistry<
   typeof AbstractFeatureProvider
-> = new ClassRegistry();
+>();
 
-export const mapClassRegistry: ClassRegistry<typeof VcsMap> =
-  new ClassRegistry();
+export const mapClassRegistry = new ClassRegistry<typeof VcsMap>();
 
-export const styleClassRegistry: ClassRegistry<typeof StyleItem> =
-  new ClassRegistry();
+export const styleClassRegistry = new ClassRegistry<typeof StyleItem>();
 
-export const categoryClassRegistry: ClassRegistry<typeof Category<any, any>> =
-  new ClassRegistry();
+export const categoryClassRegistry = new ClassRegistry<
+  typeof Category<any, any>
+>();
 
 /**
  * Returns an object based on a class registry or override class registry and a typed options object. as opposed to ClassRegistry.createFromTypedOptions, this function never throws.
  */
-export function getObjectFromClassRegistry<T extends Ctor<T>>(
+export function getObjectFromClassRegistry<T extends CtorType<T>>(
   classRegistry: OverrideClassRegistry<T> | ClassRegistry<T>,
   options: TypedConstructorOptions,
   ...args: unknown[]

package/src/featureProvider/abstractFeatureProvider.ts

@@ -11,7 +11,8 @@ import VectorProperties, {
   type VectorPropertiesOptions,
 } from '../layer/vectorProperties.js';
 import { isProvidedFeature } from './featureProviderSymbols.js';
-import StyleItem, { type StyleItemOptions } from '../style/styleItem.js';
+import type StyleItem from '../style/styleItem.js';
+import { type StyleItemOptions } from '../style/styleItem.js';
 import type VcsMap from '../map/vcsMap.js';
 
 export type AbstractFeatureProviderOptions = VcsObjectOptions & {
@@ -96,7 +97,7 @@ class AbstractFeatureProvider extends VcsObject {
       options.vectorProperties instanceof VectorProperties
         ? options.vectorProperties
         : new VectorProperties({
-            ...defaultOptions.vectorProperties,
+            ...(defaultOptions.vectorProperties as VectorPropertiesOptions),
             ...options.vectorProperties,
           });
 
@@ -147,10 +148,13 @@ class AbstractFeatureProvider extends VcsObject {
    * @param resolution - meters per pixel for the given location
    * @param headers - headers optional request headers to be sent with the server request
    */
-  // eslint-disable-next-line no-unused-vars,class-methods-use-this
+  // eslint-disable-next-line class-methods-use-this
   getFeaturesByCoordinate(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     _coordinate: Coordinate,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     _resolution: number,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     _headers?: Record<string, string>,
   ): Promise<Feature[]> {
     return Promise.resolve([]);
@@ -175,7 +179,7 @@ class AbstractFeatureProvider extends VcsObject {
 
     const vectorPropertiesConfig = this.vectorProperties.getVcsMeta({
       ...VectorProperties.getDefaultOptions(),
-      ...defaultOptions.vectorProperties,
+      ...(defaultOptions.vectorProperties as VectorPropertiesOptions),
     });
     if (Object.keys(vectorPropertiesConfig).length > 0) {
       config.vectorProperties = vectorPropertiesConfig;