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

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

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

import {MM_TABLES} from '@constants/database';

import type {Relation} from '@nozbe/watermelondb';
import type ChannelModel from '@typings/database/models/servers/channel';
import type MyChannelModelInterface from '@typings/database/models/servers/my_channel';
import type MyChannelSettingsModel from '@typings/database/models/servers/my_channel_settings';

const {CATEGORY_CHANNEL, CHANNEL, MY_CHANNEL, MY_CHANNEL_SETTINGS} = MM_TABLES.SERVER;

/**
 * MyChannel is an extension of the Channel model but it lists only the Channels the app's user belongs to
 */
export default class MyChannelModel extends Model implements MyChannelModelInterface {
    /** table (name) : MyChannel */
    static table = MY_CHANNEL;

    static associations: Associations = {
        [CHANNEL]: {type: 'belongs_to', key: 'id'},
        [CATEGORY_CHANNEL]: {type: 'has_many', foreignKey: 'channel_id'},
        [MY_CHANNEL_SETTINGS]: {type: 'has_many', foreignKey: 'id'},
    };

    /** last_post_at : The timestamp for any last post on this channel */
    @field('last_post_at') lastPostAt!: number;

    /** last_last_fetched_at_at : The timestamp when we successfully last fetched post on this channel */
    @field('last_fetched_at') lastFetchedAt!: number;

    /** last_viewed_at : The timestamp showing the user's last viewed post on this channel */
    @field('last_viewed_at') lastViewedAt!: number;

    /** manually_unread : Determine if the user marked a post as unread */
    @field('manually_unread') manuallyUnread!: boolean;

    /** message_count : The derived number of unread messages on this channel */
    @field('message_count') messageCount!: number;

    /** mentions_count : The number of mentions on this channel */
    @field('mentions_count') mentionsCount!: number;

    /** is_unread : Whether the channel has unread messages */
    @field('is_unread') isUnread!: boolean;

    /** roles : The user's privileges on this channel */
    @field('roles') roles!: string;

    /** viewed_at : The timestamp showing when the user's last opened this channel (this is used for the new line message indicator) */
    @field('viewed_at') viewedAt!: number;

    /** last_playbook_runs_fetch_at : The timestamp of the last successful fetch of playbook runs for this channel, used as the "since" parameter for incremental updates */
    @field('last_playbook_runs_fetch_at') lastPlaybookRunsFetchAt!: number;

    /** channel : The relation pointing to the CHANNEL table */
    @immutableRelation(CHANNEL, 'id') channel!: Relation<ChannelModel>;

    /** settings: User specific settings/preferences for this channel */
    @immutableRelation(MY_CHANNEL_SETTINGS, 'id') settings!: Relation<MyChannelSettingsModel>;

    async destroyPermanently() {
        const settings = await this.settings.fetch();
        settings?.destroyPermanently();
        super.destroyPermanently();
    }

    resetPreparedState() {
        this._preparedState = null;
    }
}