mattermost-mobile/app/database/models/server/team_channel_history.ts

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

import {Relation} from '@nozbe/watermelondb';
import {field, immutableRelation, json} from '@nozbe/watermelondb/decorators';
import Model, {Associations} from '@nozbe/watermelondb/Model';

import {MM_TABLES} from '@constants/database';
import {safeParseJSON} from '@utils/helpers';

import type Team from '@typings/database/models/servers/team';

const {TEAM, TEAM_CHANNEL_HISTORY} = MM_TABLES.SERVER;

/**
 * The TeamChannelHistory model helps keeping track of the last channel visited
 * by the user.
 */
export default class TeamChannelHistory extends Model {
    /** table (name) : TeamChannelHistory */
    static table = TEAM_CHANNEL_HISTORY;

    /** associations : Describes every relationship to this table. */
    static associations: Associations = {

        /** A TEAM and TEAM_CHANNEL_HISTORY share a 1:1 relationship */
        [TEAM]: {type: 'belongs_to', key: 'team_id'},
    };

    /** team_id : The foreign key to the related Team record */
    @field('team_id') teamId!: string;

    /** channel_ids : An array containing the last 5 channels visited within this team order by recency */
    @json('channel_ids', safeParseJSON) channelIds!: string[];

    /** team : The related record from the parent Team model */
    @immutableRelation(TEAM, 'team_id') team!: Relation<Team>;
}