@vcmap/core 5.0.0-rc.17 → 5.0.0-rc.18

package/index.d.ts

@@ -8,25 +8,21 @@ export interface AppBackedCategoryOptions extends CategoryOptions {
 export class AppBackedCategory extends Category<VcsObject> {
     constructor(options: AppBackedCategoryOptions);
     protected _deserializeItem(config: VcsObjectOptions): Promise<VcsObject>;
+    setApp(app: VcsApp): void;
     serializeForContext(contextId: string): null;
+    toJSON(): AppBackedCategoryOptions;
 }
 
 /**
  */
 export interface CategoryOptions extends VcsObjectOptions {
-    title?: string | {
-        [key: string]: string;
-    };
+    title?: string;
     /**
      * the class registry name on the current app to provide classes for this category. if provided, parseItems will deserialize using this class registry. See: {@link getObjectFromClassRegistry}.
     */
     classRegistryName?: string | symbol;
     featureProperty?: string | undefined;
     layerOptions?: VectorOptions;
-    /**
-     * items are not evaluated by the constructor but passed to parseItem during deserialization.
-    */
-    items?: object[];
     keyProperty?: string;
 }
 
@@ -39,9 +35,7 @@ export interface CategoryOptions extends VcsObjectOptions {
 export class Category<T extends Object|VcsObject> extends VcsObject {
     constructor(options: CategoryOptions);
     static getDefaultConfig(): CategoryOptions;
-    title: string | {
-        [key: string]: string;
-    };
+    title: string;
     protected _app: VcsApp;
     protected _layer: VectorLayer;
     readonly classRegistryName: string | symbol;
@@ -81,7 +75,7 @@ export class Category<T extends Object|VcsObject> extends VcsObject {
      */
     protected _deserializeItem(config: any): Promise<T>;
     protected _serializeItem(item: T): object[];
-    serializeForContext(contextId: string): CategoryOptions | null;
+    serializeForContext(contextId: string): any | null;
     /**
      * unique Name
      */
@@ -6408,21 +6402,6 @@ export function getDefaultCondition(attribute: string, isColor?: boolean): strin
 
 export const defaultExtrudedHeightCondition: string;
 
-/**
- */
-export interface StyleItemLegendEntry {
-    /**
-     * the color to display
-    */
-    color: string;
-    /**
-     * the name to display for the given color
-    */
-    name: string | {
-        [key: string]: string;
-    };
-}
-
 /**
  */
 export interface StyleItemOptions extends VcsObjectOptions {
@@ -7489,6 +7468,8 @@ export class ViewPoint extends VcsObject {
     readonly className: string;
 }
 
+export const defaultDynamicContextId: string;
+
 export class VcsApp {
     readonly id: string;
     /**

package/index.js

@@ -139,7 +139,7 @@ export { wgs84ToMercatorTransformer, mercatorToWgs84Transformer, setDefaultProje
 export { default as SplitScreen } from './src/util/splitScreen.js';
 export { isSameOrigin } from './src/util/urlHelpers.js';
 export { propertyEqualsEpsilon, angleEqualsEpsilon, coordinateEqualsEpsilon, default as ViewPoint } from './src/util/viewpoint.js';
-export { getVcsAppById, default as VcsApp } from './src/vcsApp.js';
+export { defaultDynamicContextId, getVcsAppById, default as VcsApp } from './src/vcsApp.js';
 export { contextIdSymbol, deserializeMap, deserializeViewPoint, deserializeLayer, serializeLayer, getLayerIndex, destroyCollection } from './src/vcsAppContextHelpers.js';
 export { default as VcsEvent } from './src/vcsEvent.js';
 export { default as VcsObject } from './src/vcsObject.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "5.0.0-rc.17",
+  "version": "5.0.0-rc.18",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -68,7 +68,8 @@
     "node_modules",
     "coverage",
     "index.js",
-    "*.d.ts"
+    "*.d.ts",
+    "docs"
   ],
   "dependencies": {
     "@types/rbush": "^3.0.0",

package/src/category/appBackedCategory.js

@@ -57,6 +57,9 @@ class AppBackedCategory extends Category {
     return super._deserializeItem(config);
   }
 
+  /**
+   * @param {import("@vcmap/core").VcsApp} app
+   */
   setApp(app) {
     super.setApp(app);
     this.setCollection(this._app[this._collectionName]);
@@ -70,6 +73,16 @@ class AppBackedCategory extends Category {
   serializeForContext(contextId) {
     return null;
   }
+
+  /**
+   * @returns {AppBackedCategoryOptions}
+   */
+  toJSON() {
+    const config = /** @type {AppBackedCategoryOptions} */ (super.toJSON());
+    delete config.classRegistryName;
+    config.collectionName = this._collectionName;
+    return config;
+  }
 }
 
 export default AppBackedCategory;

package/src/category/category.js

@@ -15,11 +15,10 @@ import VcsEvent from '../vcsEvent.js';
 
 /**
  * @typedef {VcsObjectOptions} CategoryOptions
- * @property {string|Object<string, string>} [title]
+ * @property {string} [title]
  * @property {string|symbol} [classRegistryName] - the class registry name on the current app to provide classes for this category. if provided, parseItems will deserialize using this class registry. See: {@link getObjectFromClassRegistry}.
  * @property {string|undefined} [featureProperty]
  * @property {VectorOptions} [layerOptions={}]
- * @property {Array<Object>} [items] - items are not evaluated by the constructor but passed to parseItem during deserialization.
  * @property {string} [keyProperty=name]
  */
 
@@ -89,7 +88,6 @@ class Category extends VcsObject {
       classRegistryName: undefined,
       layerOptions: {},
       keyProperty: 'name',
-      items: [],
     };
   }
 
@@ -100,7 +98,7 @@ class Category extends VcsObject {
     super(options);
     const defaultOptions = Category.getDefaultConfig();
     /**
-     * @type {string|Object<string, string>}
+     * @type {string}
      */
     this.title = options.title || this.name;
     /**
@@ -381,7 +379,7 @@ class Category extends VcsObject {
 
   /**
    * @param {string} contextId
-   * @returns {CategoryOptions|null}
+   * @returns {{ name: string, items: Array<Object>}|null}
    */
   serializeForContext(contextId) {
     if (this._collection.size === 0) {
@@ -394,6 +392,34 @@ class Category extends VcsObject {
     };
   }
 
+  /**
+   * @returns {CategoryOptions}
+   */
+  toJSON() {
+    const config = /** @type {CategoryOptions} */ (super.toJSON());
+
+    const defaultOptions = Category.getDefaultConfig();
+    if (this.title !== this.name) {
+      config.title = this.title;
+    }
+    if (this._featureProperty !== defaultOptions.featureProperty) {
+      config.featureProperty = this._featureProperty;
+    }
+    if (this._classRegistryName !== defaultOptions.classRegistryName) {
+      config.classRegistryName = this._classRegistryName;
+    }
+    if (Object.keys(this._layerOptions).length > 0) {
+      config.layerOptions = { ...this._layerOptions };
+    }
+    if (this._keyProperty !== defaultOptions.keyProperty) {
+      config.keyProperty = this._keyProperty;
+    }
+    return config;
+  }
+
+  /**
+   * @inheritDoc
+   */
   destroy() {
     super.destroy();
     if (this._app && this._layer) {
@@ -415,3 +441,4 @@ class Category extends VcsObject {
 
 export default Category;
 categoryClassRegistry.registerClass(Category.className, Category);
+

package/src/context.js

@@ -1,4 +1,4 @@
-import { v4 as uuidv4, v5 as uuidv5 } from 'uuid';
+import { v5 as uuidv5 } from 'uuid';
 
 /**
  * @typedef {Object} VcsAppConfig
@@ -17,7 +17,7 @@ import { v4 as uuidv4, v5 as uuidv5 } from 'uuid';
 /**
  * @type {string}
  */
-const uuidNamespace = uuidv4();
+const uniqueNamespace = '9c27cc2d-552f-4637-9194-09329ed4c1dc';
 
 /**
  * @class
@@ -36,7 +36,7 @@ class Context {
      * @type {string}
      * @private
      */
-    this._checkSum = uuidv5(JSON.stringify(config), uuidNamespace);
+    this._checkSum = uuidv5(JSON.stringify(config), uniqueNamespace);
     /**
      * @type {string}
      * @private

package/src/style/styleItem.js

@@ -6,13 +6,6 @@ import VcsObject from '../vcsObject.js';
 import VcsEvent from '../vcsEvent.js';
 import { styleClassRegistry } from '../classRegistry.js';
 
-/**
- * @typedef {Object} StyleItemLegendEntry
- * @property {string} color - the color to display
- * @property {string|Object<string, string>} name - the name to display for the given color
- * @api
- */
-
 /**
  * @typedef {VcsObjectOptions} StyleItemOptions
  * @property {number} [colorBlendMode=import("@vcmap/cesium").Cesium3DTileColorBlendMode.HIGHLIGHT] - colorBlendMode for 3D Tiledataset @see https://cesiumjs.org/import("@vcmap/cesium").Build/Documentation/Cesium3DTileColorBlendMode.html

package/src/vcsApp.js

@@ -47,6 +47,11 @@ function getLogger() {
  */
 const vcsApps = new Map();
 
+/**
+ * @type {string}
+ */
+export const defaultDynamicContextId = '_defaultDynamicContext';
+
 /**
  * @class
  */
@@ -61,7 +66,7 @@ class VcsApp {
      * @type {Context}
      * @private
      */
-    this._defaultDynamicContext = new Context({ id: '_defaultDynamicContext' });
+    this._defaultDynamicContext = new Context({ id: defaultDynamicContextId });
     /**
      * @type {Context}
      * @private