Misskey

Streaming in misskey-js is managed by two primary abstractions:

1. Stream: Manages the underlying connection to the server. It handles automatic reconnection if the connection is lost.
2. Channel: Represents a specific stream channel (e.g., main, chat). You obtain a Channel instance by calling .useChannel() on a Stream instance.

Lifecycle and Events:

• Connection States: Check stream.state which can be initializing, connected, or reconnecting.
• Connection Events: Listen to _connected_ and _disconnected_ on the Stream instance.
• Message Reception: Channel extends EventEmitter. Listen for specific event names (like notification) to receive payloads from the server.
• Message Transmission: Use channel.send(event, params) to send messages to the server.
• Cleanup: Call channel.dispose() to disconnect from a specific channel.

const stream = new Misskey.Stream('https://misskey.test', { token: 'TOKEN' });
const mainChannel = stream.useChannel('main');

// Listen for messages
mainChannel.on('notification', notification => {
	console.log('notification received', notification);
});

// Send a message
mainChannel.send('read', { id: 'xxxxxxxxxx' });

// Disconnect channel
mainChannel.dispose();

Misskey authentication often requires multiple steps (e.g., Captcha, TOTP, or Passkeys). The SigninFlowResponse type indicates whether the sign-in process is complete or if further action is required.

Sign-in States

• Finished: If finished: true, the response contains the user id and an authentication token i.
• Requires Captcha: If next: 'captcha', the client must solve a captcha and provide the response.
• Requires Password: If next: 'password', the client must provide the user's password.
• Requires TOTP: If next: 'totp', the client must provide a Two-Factor Authentication code.
• Requires Passkey: If next: 'passkey', the client must initiate a WebAuthn/Passkey request using the provided authRequest.

export type SigninFlowResponse = {
    finished: true;
    id: User['id'];
    i: string;
} | {
    finished: false;
    next: 'captcha' | 'password' | 'totp';
} | {
    finished: false;
    next: 'passkey';
    authRequest: PublicKeyCredentialRequestOptionsJSON_2;
};

The Channels type defines the real-time communication streams available via misskey-js. Each channel consists of params (required to subscribe), events (callbacks triggered by the server), and receives (actions you can perform within that channel).

Key channels include:

• main: Global notifications like mention, follow, reply, and unreadNotification.
• Timelines (homeTimeline, localTimeline, hybridTimeline, globalTimeline): Subscribe to note streams with optional parameters like withRenotes, withFiles, or minimize.
• hashtag: Subscribe to notes containing specific hashtags using the q parameter.
• drive: Monitor file system changes like fileCreated, fileDeleted, or folderUpdated.
• reversiGame: A specialized channel for playing Reversi, supporting events like started, ended, and changeReadyStates, and receiving actions like putStone or cancel.
• chatUser / chatRoom: Real-time messaging channels for specific users or rooms, supporting message, deleted, and react events.
• antenna / channel / roleTimeline: Specialized timeline subscriptions based on specific IDs.

// Example of the structure of a channel
type Channels = {
    main: {
        params: null;
        events: {
            notification: (payload: Notification_2) => void;
            mention: (payload: Note) => void;
            // ...
        };
        receives: null;
    };
    // ...
}

The ModerationLogPayloads type defines the structure of data payloads for various moderation actions recorded in the system. Each key in the type represents a specific type of moderation event (e.g., suspend, assignRole, deleteNote). The moderationLogTypes constant provides a runtime array of these event type strings, which can be used to identify or filter moderation logs.

Common payload structures include:

• User actions: suspend, unsuspend, resetPassword, deleteAccount (typically include userId, userUsername, and userHost).
• Content actions: deleteNote, deleteDriveFile, deletePage (include identifiers for the content and the user responsible).
• Role management: assignRole, unassignRole, createRole, updateRole, deleteRole.
• Announcement management: createGlobalAnnouncement, updateGlobalAnnouncement, etc.

export const moderationLogTypes: readonly ["updateServerSettings", "suspend", "unsuspend", ...];

export type ModerationLogPayloads = {
    updateServerSettings: { before: MetaDetailed | null; after: MetaDetailed | null; };
    suspend: { userId: string; userUsername: string; userHost: string | null; };
    // ... other payloads
};