fluffychat/lib/pangea/models/message_data_models.dart

import 'dart:convert';

import 'package:matrix/matrix.dart';

import 'package:fluffychat/pangea/models/pangea_token_model.dart';

/// this class is contained within a [RepresentationEvent]
/// this event is the child of a [EventTypes.Message]
/// the event has two potential children events -
/// [PangeaTokensEvent] and [PangeaIGCEvent]
/// these events contain [PangeaMessageTokens] and [ChoreoRecord], respectively.
class PangeaRepresentation {
  /// system-detected language, possibly condensed from a list,
  /// but only with high certainty
  /// cannot be "unk"
  String langCode;

  /// final sent text
  /// if this was a process, a [PangeaIGCEvent] will contain changes
  String text;

  bool originalSent;
  bool originalWritten;

  // how do we know which representation was sent by author?
  // RepresentationEvent.text == PangeaMessageEvent.event.body
  // use: to know whether directUse

  // how do we know which representation was original L1 message that was translated (if it exists)?
  // (of l2 rep) RepresentationEvent.igc.steps.first.text = RepresentationEvent.text (of L1 rep)
  // use: for base text for future translations

  // os = true and ow = false
  // rep that went through IGC/IT

  // os = false and ow = false
  // rep added by other user

  // os = true and ow = true
  // potentially L1 language use, maybe with limited IGC, and ignored out of target cries
  // potentially perfect L2 use

  // os = false and ow = true
  // L1 message that then went through significant IGC and/or IT
  // L2 message with errors that went through IGC

  PangeaRepresentation({
    required this.langCode,
    required this.text,
    required this.originalSent,
    required this.originalWritten,
  });

  factory PangeaRepresentation.fromJson(Map<String, dynamic> json) =>
      PangeaRepresentation(
        langCode: json[_langCodeKey],
        text: json[_textKey],
        originalSent: json[_originalSentKey] ?? false,
        originalWritten: json[_originalWrittenKey] ?? false,
      );

  static const _textKey = "txt";
  static const _langCodeKey = "lang";
  static const _originalSentKey = "snt";
  static const _originalWrittenKey = "wrttn";

  Map<String, dynamic> toJson() {
    final data = <String, dynamic>{};
    data[_textKey] = text;
    data[_langCodeKey] = langCode;
    if (originalSent) data[_originalSentKey] = originalSent;
    if (originalWritten) data[_originalWrittenKey] = originalWritten;
    return data;
  }
}

/// this class lives within a [PangeaTokensEvent]
/// it always has a [RepresentationEvent] parent
/// These live as separate event so that anyone can add and edit tokens to
/// representation
class PangeaMessageTokens {
  List<PangeaToken> tokens;

  PangeaMessageTokens({
    required this.tokens,
  });

  factory PangeaMessageTokens.fromJson(Map<String, dynamic> json) {
    return PangeaMessageTokens(
      tokens: (jsonDecode(json[_tokensKey] ?? "[]") as Iterable)
          .map((e) => PangeaToken.fromJson(e))
          .toList()
          .cast<PangeaToken>(),
    );
  }

  static const _tokensKey = "tkns";

  Map<String, dynamic> toJson() {
    final data = <String, dynamic>{};
    data[_tokensKey] = jsonEncode(tokens.map((e) => e.toJson()).toList());
    return data;
  }
}