@vcmap/core 5.0.0-rc.13 → 5.0.0-rc.14

package/index.d.ts

@@ -1828,7 +1828,9 @@ export class FeatureStoreLayerChanges extends VcsObject {
     /**
      * commits the changes to the provided url. url should contain accessTokens and point to a featureStore layers bulk operation endpoint
      */
-    commitChanges(url: string): Promise<void>;
+    commitChanges(url: string, headers?: {
+        [key: string]: string;
+    }): Promise<void>;
     /**
      * resets all changes since the last commit or the beginning of tracking
      */
@@ -7502,9 +7504,11 @@ export class VcsApp {
     readonly styles: OverrideCollection<StyleItem>;
     readonly categories: CategoryCollection;
     readonly destroyed: VcsEvent<void>;
+    readonly contexts: Context[];
     readonly contextAdded: any;
     readonly contextRemoved: any;
     readonly dynamicContextId: string;
+    readonly dynamicContextIdChanged: VcsEvent<string>;
     readonly mapClassRegistry: OverrideClassRegistry<VcsMap>;
     readonly layerClassRegistry: OverrideClassRegistry<Layer>;
     readonly styleClassRegistry: OverrideClassRegistry<StyleItem>;
@@ -7516,6 +7520,14 @@ export class VcsApp {
     protected _parseContext(context: Context): Promise<void>;
     protected _setContextState(context: Context): Promise<void>;
     addContext(context: Context): Promise<void>;
+    /**
+     * sets the given context as the dynamic
+     */
+    setDynamicContext(context: Context): void;
+    /**
+     * resets the dynamic Context to the "defaultDynamicContext"
+     */
+    resetDynamicContext(): void;
     protected _removeContext(contextId: string): Promise<void>;
     removeContext(contextId: string): Promise<void>;
     /**
@@ -7609,8 +7621,13 @@ export class VcsObject {
 
 
 
+export interface ReplacedEvent<T extends any> {
+    new: T,
+    old: T,
+}
+
 export interface OverrideCollectionInterface<T extends any> {
-    replaced: VcsEvent<T>;
+    replaced: VcsEvent<ReplacedEvent<T>>;
     shadowMap: Map<string, object[]>;
     override: (item: T) => T;
     parseItems: (items: object[], contextId: string) => Promise<void>;
@@ -7619,7 +7636,7 @@ export interface OverrideCollectionInterface<T extends any> {
 }
 
 export class OverrideCollection<T extends any> extends Collection<T> implements OverrideCollectionInterface<T> {
-    replaced: VcsEvent<T>;
+    replaced: VcsEvent<ReplacedEvent<T>>;
     shadowMap: Map<string, object[]>;
     override: (item: T) => T;
     parseItems: (items: object[], contextId: string) => Promise<void>;
@@ -7628,7 +7645,7 @@ export class OverrideCollection<T extends any> extends Collection<T> implements
 }
 
 export class OverrideLayerCollection extends LayerCollection implements OverrideCollectionInterface<Layer> {
-    replaced: VcsEvent<Layer>;
+    replaced: VcsEvent<ReplacedEvent<Layer>>;
     shadowMap: Map<string, object[]>;
     override: (item: Layer) => Layer;
     parseItems: (items: object[], contextId: string) => Promise<void>;
@@ -7637,7 +7654,7 @@ export class OverrideLayerCollection extends LayerCollection implements Override
 }
 
 export class OverrideMapCollection extends MapCollection implements OverrideCollectionInterface<VcsMap> {
-    replaced: VcsEvent<VcsMap>;
+    replaced: VcsEvent<ReplacedEvent<VcsMap>>;
     shadowMap: Map<string, object[]>;
     override: (item: VcsMap) => VcsMap;
     parseItems: (items: object[], contextId: string) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "5.0.0-rc.13",
+  "version": "5.0.0-rc.14",
   "description": "",
   "main": "index.js",
   "type": "module",

package/src/layer/featureStoreLayerChanges.js

@@ -163,15 +163,17 @@ class FeatureStoreLayerChanges extends VcsObject {
   /**
    * commits the changes to the provided url. url should contain accessTokens and point to a featureStore layers bulk operation endpoint
    * @param {string} url
+   * @param {Object<string, string>=} headers
    * @returns {Promise<void>}
    * @api
    */
-  async commitChanges(url) {
+  async commitChanges(url, headers = {}) {
     const actions = createCommitActions(this._addedFeatures, this._editedFeatures, this._removedFeatures);
     if (actions.length > 0) {
       const data = await requestJson(url.toString(), {
         method: 'POST',
         headers: {
+          ...headers,
           'Content-Type': 'application/json',
         },
         body: JSON.stringify(actions.map(a => ({ action: a.action, feature: a.feature }))),

package/src/util/overrideCollection.js

@@ -91,18 +91,18 @@ function makeOverrideCollection(
       }
       const shadowsArray = overrideCollection.shadowMap.get(itemId);
       const serializedShadow = serialize(shadow);
-      // @ts-ignore
-      if (shadow.destroy) {
-        // @ts-ignore
-        shadow.destroy();
-      }
       serializedShadow[contextIdSymbol] = shadow[contextIdSymbol];
       shadowsArray.push(serializedShadow);
     }
 
     const usedIndex = shadow ? getShadowIndex(shadow, item, index) : null;
     if (shadow) {
-      overrideCollection.replaced.raiseEvent(item);
+      overrideCollection.replaced.raiseEvent({ old: shadow, new: item });
+      // @ts-ignore
+      if (shadow.destroy) {
+        // @ts-ignore
+        shadow.destroy();
+      }
     }
     // @ts-ignore
     if (overrideCollection.add(item, usedIndex) >= 0) {
@@ -186,7 +186,7 @@ function makeOverrideCollection(
   };
 
   /**
-   * @type {VcsEvent<T>}
+   * @type {VcsEvent<ReplacedEvent<T>>}
    */
   overrideCollection.replaced = new VcsEvent();
 

package/src/vcsApp.js

@@ -70,6 +70,12 @@ class VcsApp {
 
     const getDynamicContextId = () => this._dynamicContext.id;
 
+    /**
+     * @type {VcsEvent<string>}
+     * @private
+     */
+    this._dynamicContextIdChanged = new VcsEvent();
+
     /**
      * represents the current Locale.
      * @type {string}
@@ -287,6 +293,14 @@ class VcsApp {
    */
   get destroyed() { return this._destroyed; }
 
+  /**
+   * @type {Array<Context>}
+   * @readonly
+   */
+  get contexts() {
+    return [...this._contexts];
+  }
+
   /**
    * @returns {VcsEvent<Context>}
    * @readonly
@@ -305,6 +319,12 @@ class VcsApp {
    */
   get dynamicContextId() { return this._dynamicContext.id; }
 
+  /**
+   * @type {VcsEvent<string>}
+   * @readonly
+   */
+  get dynamicContextIdChanged() { return this._dynamicContextIdChanged; }
+
   /**
    * @type {OverrideClassRegistry<VcsMap>}
    * @readonly
@@ -446,6 +466,27 @@ class VcsApp {
     return this._contextMutationPromise;
   }
 
+  /**
+   * sets the given context as the dynamic
+   * @param {Context} context
+   */
+  setDynamicContext(context) {
+    if (!this._contexts.has(context)) {
+      throw new Error('Context is not managed by this app, call add(context) before');
+    }
+    if (this._dynamicContext !== context) {
+      this._dynamicContext = context;
+      this.dynamicContextIdChanged.raiseEvent(this.dynamicContextId);
+    }
+  }
+
+  /**
+   * resets the dynamic Context to the "defaultDynamicContext"
+   */
+  resetDynamicContext() {
+    this.setDynamicContext(this._defaultDynamicContext);
+  }
+
   /**
    * @param {string} contextId
    * @returns {Promise<void>}
@@ -507,6 +548,7 @@ class VcsApp {
     this.destroyed.raiseEvent();
     this.destroyed.destroy();
     this.localeChanged.destroy();
+    this.dynamicContextIdChanged.destroy();
   }
 }