@vcmap/core 6.1.11 → 6.2.0-rc.2

package/README.md

@@ -76,6 +76,13 @@ The core provides a flexible and fully customizable configuration management. It
 The Interactions API is an abstraction layer to handle map events. For example a click event on the Map.
 This allows for developing applications which work in 2D/3D or oblique.
 
+## Workers
+
+Some features use `WebWorkers` to offload heavy computations from the main thread. If you host the library yourself,
+you can set the global `vcs.workerBase` to point to the hosted location of the workers. Otherwise it is assumed the code is
+hosted in the same structure and a relative URL to the workers directory is used
+(which may lead to issues if you dont allow `unsafe-inline` in your CSP).
+
 ## Feature Editor API
 
 Based on the Interactions API the Feature Editor provides functionality to `create`, `select`, and `transform` Features.
@@ -107,17 +114,12 @@ With the ClassRegistry concept and API its possible to register your own Item Ty
 For example with `app.layerClassRegistry.registerClass('myLayer', MyLayerClass)` its possible to implement a custom layer
 while following the Layer Interface. This allows to reuse the Module serialization/parsing Concept with custom Items.
 
-## Getting Started
-
-- clone Repo
-- npm install
-
 # Coding Conventions
 
 ### Exporting from a module
 
 - You should export all variables, functions, class etc. from a module
   which are required to use the API.
-- Party of your module which should be part of the library must be added to the index.ts file manually
+- Part of your module which should be part of the library must be added to the index.ts file manually
 - Make sure the names of exports have _meaning outside of their module_. E.g. a
   function names `extend(destination: extent3D, source: extend3D):void` would need to be rephrased to `extend3DExtent`.

package/build/buildShader.js

@@ -0,0 +1,61 @@
+import { readFile, writeFile, watch } from 'node:fs/promises';
+import { fileURLToPath } from 'node:url';
+import { getFilesInDirectory } from './postinstall.js';
+
+async function buildShader(file) {
+  const fileName = file.replace(/\.glsl$/, '.shader.ts');
+  const content = await readFile(file, 'utf-8');
+  await writeFile(
+    fileName,
+    `// This file is auto-generated. Do not edit it directly.
+export default \`
+${content}
+\``,
+  );
+}
+
+async function buildShaders() {
+  for await (const file of getFilesInDirectory('src')) {
+    if (file.endsWith('.glsl')) {
+      await buildShader(file);
+    }
+  }
+}
+
+if (fileURLToPath(import.meta.url) === process.argv[1]) {
+  buildShaders()
+    .then(async () => {
+      if (process.argv.includes('--watch')) {
+        console.log('Watching for changes...');
+        try {
+          const watcher = watch('src', { recursive: true });
+          const debounceMap = new Map();
+          const debounceTime = 100; // debounce time in ms
+
+          for await (const event of watcher) {
+            const file = `src/${event.filename}`;
+            if (file.endsWith('.glsl')) {
+              if (debounceMap.has(file)) {
+                clearTimeout(debounceMap.get(file));
+              }
+
+              debounceMap.set(
+                file,
+                setTimeout(async () => {
+                  console.log(`File ${file} has been changed`);
+                  await buildShader(file);
+                  debounceMap.delete(file);
+                }, debounceTime),
+              );
+            }
+          }
+        } catch (error) {
+          console.error(`Watcher error: ${error}`);
+        }
+      }
+    })
+    .catch((err) => {
+      console.error(err);
+      process.exitCode = 1;
+    });
+}

package/build/postinstall.js

@@ -1,9 +1,10 @@
 import path from 'path';
 import fs from 'fs';
+import { fileURLToPath } from 'node:url';
 
-async function* getFilesInDirectory(filePath) {
+export async function* getFilesInDirectory(filePath) {
   const entries = await fs.promises.readdir(filePath, { withFileTypes: true });
-  // eslint-disable-next-line no-restricted-syntax
+
   for (const file of entries) {
     if (file.isDirectory()) {
       yield* getFilesInDirectory(path.join(filePath, file.name));
@@ -107,4 +108,6 @@ async function run() {
   console.log('fixed modules');
 }
 
-await run();
+if (fileURLToPath(import.meta.url) === process.argv[1]) {
+  await run();
+}

package/dist/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 './src/style/vectorStyleItem.js';
-import { scaleSymbol } from './src/layer/cesium/vectorContext.js';
-import { allowPicking, vcsLayerName } from './src/layer/layerSymbols.js';
-import {
+import type { StyleLike } from 'ol/style/Style.js';
+import type VectorStyleItem from './src/style/vectorStyleItem.js';
+import type { allowPicking, vcsLayerName } from './src/layer/layerSymbols.js';
+import type {
   globalHidden,
   hidden,
   highlighted,
   originalStyle,
 } from './src/layer/featureVisibility.js';
-import { handlerSymbol } from './src/util/editor/editorSymbols.js';
-import { AxisAndPlanes } from './src/util/editor/transformation/transformationTypes.js';
-import {
+import type { handlerSymbol } from './src/util/editor/editorSymbols.js';
+import type { AxisAndPlanes } from './src/util/editor/transformation/transformationTypes.js';
+import type {
   cesiumTilesetLastUpdated,
   updateFeatureOverride,
 } from './src/layer/cesium/cesiumTilesetCesiumImpl.js';
-import { isTiledFeature } from './src/layer/featureStoreLayer.js';
-import { vectorClusterGroupName } from './src/vectorCluster/vectorClusterSymbols.js';
+import type { isTiledFeature } from './src/layer/featureStoreLayer.js';
+import type { vectorClusterGroupName } from './src/vectorCluster/vectorClusterSymbols.js';
+import { scaleSymbol } from './src/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/dist/geojson.d.ts

@@ -1,6 +1,6 @@
-import { GeoJsonProperties, Geometry } from 'geojson';
+import type { GeoJsonProperties, Geometry } from 'geojson';
 import type { VcsMeta } from './src/layer/vectorProperties.js';
-import { FeatureStoreLayerState } from './src/layer/featureStoreLayerState.js';
+import type { FeatureStoreLayerState } from './src/layer/featureStoreLayerState.js';
 
 declare module 'geojson' {
   interface Point {
@@ -9,6 +9,7 @@ declare module 'geojson' {
 
   interface Feature<
     G extends Geometry | null = Geometry,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     P = GeoJsonProperties,
   > {
     _id?: string;