@yz-social/civildefense.io 4.4.3 → 4.5.4

package/public/javascripts/conversation.js

@@ -0,0 +1,100 @@
+// TODO:
+// - clarify common lifecycle management, including existing reply to not get re-initialized
+// - In Alert, get rid of subject (just use tag)
+// - key off 'deleted' instead of payload:null, and bring handling here
+// - Bring pub/sub here, customized for SpatialConversation subclass
+// - Agents
+// - Document lifecycle and subclass requirements
+
+export class Tagged { // Maintains cached existence within a (possibly instance-specific) container
+
+  // These next three instance methods are not generally called directly, but are here for extending by subclasses.
+  initialize({...properties} = {}) { // Initialization of a new object. (Includes tag.) Must return this, or null to not cache.
+    // Application subclass will typically extend this with UI initialization
+    Object.assign(this, properties);
+    return this;
+  }
+  update({...properties} = {}) { // Re-initialize an existing object with properties. Must return this, or null to remove item.
+    // This version gives error when specified values (if any) do not match existing.
+    // Since axona publications are immutable, an update with different values would generally be meaningless.
+    for (const key in properties) {
+      const existing = this[key];
+      const proposed = properties[key];
+      if (JSON.stringify(existing) !== JSON.stringify(proposed)) throw new Error(`Cannot update ${key} ${existing} to ${proposed}.`);
+    }
+    return this;
+  }
+  destroy() { // Subclasses extend to remove UI.
+    // Subclass extensions of ensure may expect this answer falsy, indicating that an item was removed.
+    // NOTE: Does not destroy replies, as these may have been published by others.
+    return null; 
+  }
+
+  static ensureIn(data, container, kind = container.itemKind) { // update() or initialize() item and remember what those answer. (Falsy is deleted).
+    const {tag, payload, ...rest} = data;
+    let item = container.getItem(tag);
+    if (!payload) return item && container.removeItem(tag)?.destroy();
+    if (item) item = item.update(data);
+    else item = new kind().initialize(data);
+
+    if (!item) return container.removeItem(tag)?.destroy();
+    return container.setItem(tag, item);
+  }
+}
+
+export class Reply extends Tagged {  // An individual reply to a conversation.
+}
+
+export class Conversation extends Tagged { // A conversation with replies.
+
+  // get/set/removeItem for replies. The instance maintains the collection as a list.
+  items = []; // List of replies, in increasing time order.
+  getItem(tag) { // Find the reply if known, else falsy.
+    const { items } = this;        
+    return items.find(reply => reply.tag === tag);
+  }
+  setItem(tag, item) { // Adds reply to cache, maintaining order. Ignores tag.
+    const { items } = this;        
+    items.push(item);
+    items.sort((a, b) => a.issuedTime - b.issuedTime); // In case they arrive out of order. Typically just a check.
+    return item;
+  }
+  removeItem(tag) { // Remove reply from cache.
+    const { items } = this;    
+    return items.splice(items.findIndex(reply => reply.tag === tag), 1)?.[0];
+  }
+  get itemKind() { // Answer class of reply items.
+    return Reply;
+  }
+  ensure(data) { // Initialize or update Reply from data.
+    return this.constructor.ensureIn(data, this);
+  }
+
+  // get/set/removeItem for conversations. The class maintains the collection as a dictionary.
+  // Multiton pattern, with each subclass getting its own dictionary.
+  static _conversations = {}; // Maps tag => conversation
+  static get conversations() { // Answer conversation dictionary for this specific class.
+    if (!Object.hasOwn(this, '_conversations')) this._conversations = {};
+    return this._conversations;
+  }
+  static items() {
+    return Object.values(this.conversations);
+  }
+  static getItem(tag) { // Get conversation if known, else falsy.
+    return this.conversations[tag];
+  }
+  static setItem(tag, item) { // Cache conversation at tag.
+    return this.conversations[tag] = item;
+  }
+  static removeItem(tag) { // Remove conversation from cache.
+    let existing = this.getItem(tag);
+    delete this._conversations[tag];
+    return existing;
+  }
+  static get itemKind() { // Answer class of Converstion items.
+    return this;
+  }
+  static ensure(data) { // Initialize or update Conversation from data.
+    return this.ensureIn(data, this);
+  }
+}

package/public/javascripts/hashtags.js

@@ -1,7 +1,8 @@
 const { localStorage } = globalThis; // For linters.
 import { stripLeadingEmoji, canonicalTag } from './versions.js';
 import { Int } from './translations.js';
-import { updateSubscriptions, Marker, showMessage } from './map.js';
+import { showMessage } from './map.js';
+import { Alert } from './alert.js';
 import { resetInactivityTimer, clickTip } from './main.js';
 
 // We subscribe to the cartesian product of the list of non-overlapping cells and all hashes.
@@ -26,7 +27,7 @@ export const Hashtags = {
   //    were using the same emoji as each other.
   hashtags: {},
   canonical2extended: {},
-  add(label, active = true, updateMarkers = true) { // Ensure label is a hashtag, initialized to active, and if existing, forcing it active.
+  add(label, active = true, updateAlerts = true) { // Ensure label is a hashtag, initialized to active, and if existing, forcing it active.
     // Return our (possibly new) understanding of the extended hashtag.
     // Note that only startup-population of tags from persistence would ever specify active=false.
     // Here we accept a canonical or extended label, updating our records keyed by the canonical part,
@@ -44,7 +45,7 @@ export const Hashtags = {
     this.canonical2extended[canonical] = extended;
     if (!oursHasEmoji) {
       this.onchange({resetSubscriptions: false});
-      if (updateMarkers) Marker.updateMarkers(canonical, extended);
+      if (updateAlerts) Alert.updateAlerts(canonical, extended);
     }
     return extended;
   },
@@ -70,7 +71,7 @@ export const Hashtags = {
     // Unneeded and not necessarilly meaningful if tag has emoji.
     return `<minidenticon-svg ${slot ? `slot="${slot}"` : ''} username="${tag}"></minidenticon-svg>`;
   },
-  formatMarker(tag) { // HTML (possibly text) to represent tag as a marker on map.
+  formatAlert(tag) { // HTML (possibly text) to represent tag as a marker on map.
     return this.firstEmoji(tag) || this.identicon(tag);
   },
   formatPubtag(tag) { // HTML (possibly text) to represent tag with defaulted icon.
@@ -82,8 +83,8 @@ export const Hashtags = {
     if (redisplaySubscribers) this.resetSubscriberDisplay();
     localStorage.setItem('hashtags', JSON.stringify(this.hashtags));
     if (resetSubscriptions) {
-      updateSubscriptions();
-      Object.values(Marker.markers).forEach(wrapper => this.hashtags[wrapper.hashtag] || wrapper.destroy());
+      Alert.updateSubscriptions();
+      Alert.items.forEach(wrapper => this.hashtags[wrapper.hashtag] || wrapper.destroy());
     }
   },
   chipset: document.body.querySelector('.watching-hashtags'), // Element containing the user's chips.
@@ -132,7 +133,7 @@ export const Hashtags = {
 	if (chip.selected) showMessage(Int`Turning "${chip.label}" alerts back on in the map.`, 'instructions');
 	else showMessage(Int`Turning off "${chip.label}" alerts in the map. You can delete the topic altogether with the X.`, 'instructions');
 	this.toggleChip(chip);
-	Marker.closePopup();
+	Alert.closePopup();
 	if (chip.selected) this.setPublish(chip.label);
 	this.onchange({redisplaySubscribers: false});
       });
@@ -141,7 +142,7 @@ export const Hashtags = {
 				    `<md-filled-text-field class="newtag" placeholder="➕${Int`add topic`}"></md-filled-text-field>`);
     clickTip(this.chipset.firstChild, Int`Add a new topic for which the map should show any alerts.`, event => { // Focusing "add topic".
       event.stopPropagation();
-      Marker.closePopup();
+      Alert.closePopup();
       showMessage(Int`Type a new topic name to see any alerts on the map with this topic.`, 'instructions');
     });
     this.chipset.firstChild.onchange = event => { // Add the new hashtag.
@@ -151,7 +152,7 @@ export const Hashtags = {
 	  .replace(/\s+/g, ' ')    // Replace multiple spaces with a single space
 	  .normalize('NFD');        // Standardize different ways of making accents into decomposed form - but do not remove them.
       if (!tag) return;
-      Marker.closePopup();
+      Alert.closePopup();
       tag = this.add(tag); // Might exist, in which case tag might now be extended.
       this.setPublish(tag);
       this.onchange({highlightPublish: true});

package/public/javascripts/main.js

@@ -5,7 +5,8 @@ import { openDisplay } from './display.js';
 import { Agent} from './agent.js';
 import { P2PWebNetwork } from './p2pWebNetwork.js';
 import { getPointInCell } from './s2.js';
-import { Marker, map, getShareableURL, showMessage, updateLocation, updateSubscriptions, recenterMap, share } from './map.js';
+import { Alert, getShareableURL, share } from './alert.js';
+import { map, showMessage, updateLocation, recenterMap } from './map.js';
 import './service-manager.js'; // Comment this out and kill service-workers for reload-to-get-latest behavior during development.
 
 document.getElementById('appVersion').textContent = appVersion;
@@ -123,7 +124,7 @@ export function openAbout(event) {
   noteNotificationPermission(window.Notification?.permission);
 }
 clickTip('#aboutButton', Int`Information about this app, and options to change how you appear to others.`, event => { // open about
-  Marker.closePopup();
+  Alert.closePopup();
   openAbout(event);
 });
 clickTip('#wipe', Int`Wipe from ${osName()} all personal data and source files for this app.`, async event => {
@@ -242,7 +243,7 @@ function initializeGeolocation(subscribe = false) { // Arrange to constantly upd
     if (!subscribeOneShot) return;
     subscribeOneShot = false;
     resetInactivityTimer(false);
-    updateSubscriptions([]); // This was for a new node, so supply an empty oldSubscriptions.
+    Alert.updateSubscriptions([]); // This was for a new node, so supply an empty oldSubscriptions.
   };
   if (!geolocation) {
     showMessage(Int`Geolocation not supported. Using default location.`, 'error', 'fail');