weseek__growi/packages/core/src/interfaces/subscription.ts

import type { Ref } from './common';
import type { IPage } from './page';
import type { IUser } from './user';

export const SubscriptionStatusType = {
  SUBSCRIBE: 'SUBSCRIBE',
  UNSUBSCRIBE: 'UNSUBSCRIBE',
} as const;
export const AllSubscriptionStatusType = Object.values(SubscriptionStatusType);
export type SubscriptionStatusType =
  (typeof SubscriptionStatusType)[keyof typeof SubscriptionStatusType];

export interface ISubscription {
  user: Ref<IUser>;
  targetModel: string;
  target: Ref<IPage>;
  status: string;
  createdAt: Date;

  isSubscribing(): boolean;
  isUnsubscribing(): boolean;
}