mentions.ts

/*
 *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
 *  License: MS-RSL – see LICENSE.md for details
 */

import { Table } from "./types";

Table({
  name: "mentions",
  fields: {
    time: {
      type: "timestamp",
      desc: "when this mention happened.",
    },
    project_id: {
      type: "uuid",
    },
    path: {
      type: "string",
    },
    source: {
      type: "uuid",
      desc: "User who did the mentioning.",
    },
    target: {
      type: "string",
      desc: "uuid of user who was mentioned; later will have other possibilities including group names, 'all', etc.",
    },
    description: {
      type: "string",
      desc: "Extra text to describe the mention. eg. could be the containing message",
    },
    fragment_id: {
      type: "string",
      desc: "Text represenation of fragment_id, which is an indicator of exactly where the mention occurs in the document, e.g., a specific chat or cell in a notebook or line in a file.",
    },
    priority: {
      type: "number",
      desc: "optional integer priority.  0 = default, but could be 1 = higher priority, etc.",
    },
    error: {
      type: "string",
      desc: "some sort of error occured handling this mention",
    },
    action: {
      type: "string",
      desc: "what action was attempted by the backend - 'email', 'ignore'",
    },
    users: {
      type: "map",
      desc: "{account_id1: {read: boolean, saved: boolean}, account_id2: {...}}",
    },
    expire: {
      type: "timestamp",
      desc: "delete this row after this date, if not null",
    },
  },
  rules: {
    primary_key: ["time", "project_id", "path", "target"],
    db_standby: "unsafe",
    pg_indexes: ["action"],
    user_query: {
      get: {
        pg_where: ["time >= NOW() - interval '45 days'", "projects"],
        pg_changefeed: "projects",
        options: [{ order_by: "-time" }, { limit: 500 }],
        throttle_changes: 2000,
        fields: {
          time: null,
          project_id: null,
          path: null,
          source: null,
          target: null,
          priority: null,
          description: null,
          fragment_id: null,
          users: null,
        },
      },
      set: {
        fields: {
          time({ time }) {
            return time || new Date();
          },
          project_id: "project_write",
          path: true,
          source: true,
          target: true,
          priority: true,
          description: true,
          fragment_id: true,
          users: true,
        },
        required_fields: {
          project_id: true,
          source: true,
          path: true,
          target: true,
        },
      },
    },
  },
});