location_create.mjs

/**
### /location/create

@module /location/create
*/

/**
@function createLocation

@description
The createLocation method creates a location from a JSON feature and stores the new Location in the layer data at rest.

The layer will be reloaded to show the new location in the mapview.

Dynamic tile generation for MVT layer may lag and not represent recently inserted rows. The feature will be checked for inclusion and the tile generation will be attempted at a 1 second interval until the feature is included in the generated tiles.

The method will attempt to get the location from the layer data at rest.

@param {Object} feature JSON feature. 
@param {Object} interaction Mapview drawing interaction.
@param {layer} layer Decorated Mapp Layer.

@property {Object} feature.geometry GeoJSON geometry for new location.
@property {Object} [interaction.defaults] defaults{} object properties are stored as field columns in the location record.
@property {Object} [interaction.default_fields] default_fields{} object keys are assigned as interaction.defaults properties with the values used to lookup interaction object properties values.
*/
export default async function createLocation(feature, interaction, layer) {

  // If the feature is null, return.
  if (!feature) return;

  // Get the current table and set new to true.
  const location = {
    layer,
    table: layer.tableCurrent(),
    new: true
  };

  // Assign defaults from interaction[default_fields]
  if (interaction.default_fields) {

    interaction.defaults ??= {}

    Object.entries(interaction.default_fields).forEach(entry => {

      interaction.defaults[entry[0]] = interaction[entry[1]]
    })
  }

  // Store location in database.
  // The id must be returned from a serial ID field.
  location.id = await mapp.utils.xhr({
    method: 'POST',
    url: `${layer.mapview.host}/api/query?` +
      mapp.utils.paramString({
        template: 'location_new',
        locale: layer.mapview.locale.key,
        layer: layer.key,
        table: location.table
      }),
    body: JSON.stringify({
      [layer.geom]: feature.geometry,

      // Spread in defaults.
      ...interaction?.defaults,
      ...layer.draw?.defaults
    })
  });

  // Check whether feature is loaded on MVT update.
  if (layer.format === 'mvt') {
    layer.features = [];
    layer.source.on('tileloadend', concatFeatures);

    function concatFeatures(e) {
      layer.features = layer.features.concat(e.tile.getFeatures());
    }

    setTimeout(checkFeature, 1000);

    function checkFeature() {
      const found = layer.features?.find(F => F.properties?.id === location.id);
      if (found) {
        layer.source.un('tileloadend', concatFeatures);
      } else {
        layer.reload();
      }
    }
  }

  // Layer must be reloaded to reflect geometry changes.
  layer.reload();

  // The changeEnd event is required for dataview updates.
  layer.mapview.Map.getTargetElement()
    .dispatchEvent(new CustomEvent('changeEnd'))

  // Get the newly created location.
  mapp.location.get(location);
}