databag/app/sdk/src/api.ts

import type { Channel, Topic, Asset, Tag, Article, Group, Card, Profile, Call, Config, NodeConfig, NodeAccount, Participant } from './types';

export interface Session {
  getSettings(): Settings;
  getIdentity(): Identity;
  getContact(): Contact;
  getAlias(): Alias;
  getAttribute(): Attribute;
  getContent(): Content;
  getRing(): Ring;

  setFocus(cardId: string | null, channelId: string): Promise<Focus>;
  clearFocus(): Promise<void>;

  addStatusListener(ev: (status: string) => void): void;
  removeStatusListener(ev: (status: string) => void): void;
}

export interface Ring {
  addCallingListener(ev: (calls: Call[]) => void): void;
  removeCallingListener(ev: (calls: Call[]) => void): void;

  addCallListener(ev: (call: Call | null) => void): void;
  removeCallListener(ev: (call: Call | null) => void): void;

  accept(callId: string): void;
  ignore(callId: string): void;
  decline(callId: string): void;
}

export interface Settings {
  getUsernameStatus(username: string): Promise<boolean>;
  setLogin(username: string, password: string): Promise<void>;
  enableNotifications(): Promise<void>;
  disableNotifications(): Promise<void>;
  enableRegistry(): Promise<void>;
  disableRegistry(): Promise<void>;
  enableMFA(): Promise<{ secretImage: string; secretText: string }>;
  disableMFA(): Promise<void>;
  confirmMFA(code: string): Promise<void>;
  setSeal(password: string): Promise<void>;
  clearSeal(): Promise<void>;
  unlockSeal(password: string): Promise<void>;
  updateSeal(password: string): Promise<void>;
  forgetSeal(): Promise<void>;

  addConfigListener(ev: (config: Config) => void): void;
  removeConfigListener(ev: (config: Config) => void): void;
}

export interface Identity {
  setProfileData(name: string, location: string, description: string): Promise<void>;
  setProfileImage(image: string): Promise<void>;

  getProfileImageUrl(): string;

  addProfileListener(ev: (profile: Profile) => void): void;
  removeProfileListener(ev: (profile: Profile) => void): void;
}

export interface Contact {
  addCard(server: string | null, guid: string): Promise<string>;
  removeCard(cardId: string): Promise<void>;
  confirmCard(cardId: string): Promise<void>;
  connectCard(cardId: string): Promise<void>;
  disconnectCard(cardId: string): Promise<void>;
  denyCard(cardId: string): Promise<void>;
  ignoreCard(cardId: string): Promise<void>;
  resyncCard(cardId: string): Promise<void>;
  flagCard(cardId: string): Promise<void>;
  setBlockedCard(cardId: string, blocked: boolean): Promise<void>;
  getBlockedCards(): Promise<Card[]>;
  getRegistry(handle: string | null, server: string | null): Promise<Profile[]>;

  leaveChannel(cardId: string, channelId: string): Promise<void>;
  flagChannel(cardId: string, channelId: string): Promise<void>;
  setBlockedChannel(cardId: string, channelId: string, blocked: boolean): Promise<void>;
  getBlockedChannels(): Promise<Channel[]>;
  setUnreadChannel(cardId: string, channelId: string, unread: boolean): Promise<void>;
  getChannelNotifications(cardId: string, channelId: string): Promise<boolean>;
  setChannelNotifications(cardId: string, channelId: string, enabled: boolean): Promise<void>;

  addCardListener(ev: (cards: Card[]) => void): void;
  removeCardListener(ev: (cards: Card[]) => void): void;

  addChannelListener(ev: (arg: { channels: Channel[], cardId: string | null }) => void): void;
  removeChannelListener(ev: (arg: { channels: Channel[], cardId: string | null }) => void): void;
}

export interface Content {
  addChannel(sealed: boolean, type: string, subject: string, cardIds: string[]): Promise<string>;
  removeChannel(channelId: string): Promise<void>;
  setChannelSubject(channelId: string, subject: string): Promise<void>;
  setChannelCard(channelId: string, cardId: string): Promise<void>;
  clearChannelCard(channelId: string, cardId: string): Promise<void>;

  leaveChannel(cardId: string, channelId: string): Promise<void>;

  getChannelNotifications(cardId: string | null, channelId: string): Promise<boolean>;
  setChannelNotifications(cardId: string | null, channelId: string, enabled: boolean): Promise<void>;
  setUnreadChannel(cardId: string | null, channelId: string, unread: boolean): Promise<void>;

  flagChannel(cardId: string, channelId: string): Promise<void>;
  setBlockedChannel(cardId: string | null, channelId: string, blocked: boolean): Promise<void>;
  getBlockedChannels(): Promise<Channel[]>;

  addChannelListener(ev: (arg: { channels: Channel[], cardId: string | null }) => void): void;
  removeChannelListener(ev: (arg: { channels: Channel[], cardId: string | null }) => void): void;
}

export interface Alias {
  addGroup(sealed: boolean, type: string, subject: string, cardIds: string[]): Promise<string>;
  removeGroup(groupId: string): Promise<void>;
  setGroupSubject(groupId: string, subject: string): Promise<void>;
  setGroupCard(groupId: string, cardId: string): Promise<void>;
  clearGroupCard(groupId: string, cardId: string): Promise<void>;
  compare(groupIds: string[], cardIds: string[]): Promise<Map<string, string[]>>;

  addGroupListener(ev: (groups: Group[]) => void): void;
  removeGroupListener(ev: (groups: Group[]) => void): void;
}

export interface Attribute {
  addArticle(sealed: boolean, type: string, subject: string, cardIds: string[], groupIds: string[]): Promise<string>;
  removeArticle(articleId: string): Promise<void>;
  setArticleSubject(articleId: string, subject: string): Promise<void>;
  setArticleCard(articleId: string, cardId: string): Promise<void>;
  clearArticleCard(articleId: string, cardId: string): Promise<void>;
  setArticleGroup(articleId: string, groupId: string): Promise<void>;
  clearArticleGroup(articleId: string, groupId: string): Promise<void>;

  addArticleListener(ev: (articles: Article[]) => void): void;
  removeArticleListener(ev: (articles: Article[]) => void): void;
}

export interface Focus {
  addTopic(type: string, message: string, assets: Asset[]): Promise<string>;
  removeTopic(topicId: string): Promise<void>;
  setTopicSubject(topicId: string, subject: string): Promise<void>;
  addTag(topicId: string, type: string, subject: string): Promise<string>;
  removeTag(cardId: string, tagId: string): Promise<void>;
  setTagSubject(topicId: string, tagId: string, subject: string): Promise<void>;

  viewMoreTopics(): Promise<void>;
  viewMoreTags(topicId: string): Promise<void>;

  setUnreadChannel(cardId: string, channelId: string): Promise<void>;
  clearUnreadChannel(cardId: string, channelId: string): Promise<void>;

  getTopicAssetUrl(topicId: string, assetId: string): string;

  addParticipantAccess(name: string): Promise<Participant>;
  removeParticipantAccess(participantId: string): Promise<void>;

  flagTopic(topicId: string): Promise<void>;
  flagTag(topicId: string, tagId: string): Promise<void>;
  setBlockTopic(topicId: string): Promise<void>;
  setBlockTag(topicId: string, tagId: string): Promise<void>;
  clearBlockTopic(topicId: string): Promise<void>;
  clearBlockTag(topicId: string, tagId: string): Promise<void>;

  addTopicListener(ev: (topics: Topic[]) => void): void;
  removeTopicListener(ev: (topics: Topic[]) => void): void;
}

export interface Node {
  getAccounts(): Promise<NodeAccount[]>;
  createAccountAccess(): Promise<string>;
  resetAccountAccess(): Promise<string>;
  blockAccount(flag: boolean): Promise<void>;
  removeAccount(accountId: number): Promise<void>;
  getConfig(): Promise<NodeConfig>;
  setConfig(config: NodeConfig): Promise<void>;
}

export interface Contributor {
  addTopic(type: string, message: string, assets: Asset[]): Promise<string>;
  removeTopic(topicId: string): Promise<void>;
  addTag(topicId: string, type: string, value: string): Promise<string>;
  removeTag(topicId: string, tagId: string): Promise<void>;
}