lemmy-js-client 0.17.2 → 0.18.0-rc.1

package/dist/interfaces/api/person.d.ts

@@ -1,303 +0,0 @@
-import { CommentSortType, SortType } from "../others";
-import { CommentReplyView, CommentView, CommunityModeratorView, PersonMentionView, PersonViewSafe, PostView, PrivateMessageReportView, PrivateMessageView } from "../views";
-export interface Login {
-    username_or_email: string;
-    password: string;
-}
-/**
- * Register a new user.
- *
- * Only the first user to register will be able to be the admin.
- */
-export interface Register {
-    username: string;
-    /**
-     * Email is mandatory if email verification is enabled on the server
-     */
-    email?: string;
-    password: string;
-    password_verify: string;
-    show_nsfw: boolean;
-    /**
-     * Captcha is only checked if these are enabled in the server.
-     */
-    captcha_uuid?: string;
-    captcha_answer?: string;
-    honeypot?: string;
-    /**
-     * An answer is mandatory if require application is enabled on the server
-     */
-    answer?: string;
-}
-export interface GetCaptcha {
-}
-export interface GetCaptchaResponse {
-    /**
-     * Will be undefined if captchas are disabled.
-     */
-    ok?: CaptchaResponse;
-}
-export interface CaptchaResponse {
-    /**
-     * A Base64 encoded png.
-     */
-    png: string;
-    /**
-     * A Base64 encoded wav file.
-     */
-    wav?: string;
-    /**
-     * A UUID to match the one given on request.
-     */
-    uuid: string;
-}
-export interface SaveUserSettings {
-    show_nsfw?: boolean;
-    /**
-     * Default for this is `browser`.
-     */
-    theme?: string;
-    /**
-     * The [[SortType]].
-     *
-     * The Sort types from above, zero indexed as a number
-     */
-    default_sort_type?: number;
-    /**
-     * The [[ListingType]].
-     *
-     * Post listing types are `All, Subscribed, Community`
-     */
-    default_listing_type?: number;
-    interface_language?: string;
-    avatar?: string;
-    banner?: string;
-    display_name?: string;
-    email?: string;
-    bio?: string;
-    matrix_user_id?: string;
-    show_avatars?: boolean;
-    show_scores?: boolean;
-    send_notifications_to_email?: boolean;
-    bot_account?: boolean;
-    show_bot_accounts?: boolean;
-    show_read_posts?: boolean;
-    show_new_post_notifs?: boolean;
-    discussion_languages?: number[];
-    auth: string;
-}
-export interface ChangePassword {
-    new_password: string;
-    new_password_verify: string;
-    old_password: string;
-    auth: string;
-}
-/**
- * The `jwt` string should be stored and used anywhere `auth` is called for.
- */
-export interface LoginResponse {
-    /**
-     * This is None in response to `Register` if email verification is enabled, or the server requires registration applications.
-     */
-    jwt?: string;
-    verify_email_sent: boolean;
-    registration_created: boolean;
-}
-export interface GetPersonDetails {
-    person_id?: number;
-    /**
-     * To get details for a federated user, use `person@instance.tld`.
-     */
-    username?: string;
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    community_id?: number;
-    saved_only?: boolean;
-    auth?: string;
-}
-export interface GetPersonDetailsResponse {
-    person_view: PersonViewSafe;
-    comments: CommentView[];
-    posts: PostView[];
-    moderates: CommunityModeratorView[];
-}
-export interface GetRepliesResponse {
-    replies: CommentReplyView[];
-}
-export interface GetPersonMentionsResponse {
-    mentions: PersonMentionView[];
-}
-export interface MarkAllAsRead {
-    auth: string;
-}
-export interface AddAdmin {
-    person_id: number;
-    added: boolean;
-    auth: string;
-}
-export interface AddAdminResponse {
-    admins: PersonViewSafe[];
-}
-export interface BanPerson {
-    person_id: number;
-    ban: boolean;
-    /**
-     * Removes/Restores their comments, posts, and communities
-     */
-    remove_data?: boolean;
-    reason?: string;
-    /**
-     * The expire time in Unix seconds
-     */
-    expires?: number;
-    auth: string;
-}
-export interface BanPersonResponse {
-    person_view: PersonViewSafe;
-    banned: boolean;
-}
-export interface GetReplies {
-    sort?: CommentSortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
-    auth: string;
-}
-export interface GetPersonMentions {
-    sort?: CommentSortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
-    auth: string;
-}
-export interface MarkPersonMentionAsRead {
-    person_mention_id: number;
-    read: boolean;
-    auth: string;
-}
-export interface PersonMentionResponse {
-    person_mention_view: PersonMentionView;
-}
-export interface MarkCommentReplyAsRead {
-    comment_reply_id: number;
-    read: boolean;
-    auth: string;
-}
-export interface CommentReplyResponse {
-    comment_reply_view: CommentReplyView;
-}
-/**
- * Permanently deletes your posts and comments
- */
-export interface DeleteAccount {
-    password: string;
-    auth: string;
-}
-export interface DeleteAccountResponse {
-}
-export interface PasswordReset {
-    email: string;
-}
-export interface PasswordResetResponse {
-}
-export interface PasswordChange {
-    token: string;
-    password: string;
-    password_verify: string;
-}
-export interface CreatePrivateMessage {
-    content: string;
-    recipient_id: number;
-    auth: string;
-}
-export interface EditPrivateMessage {
-    private_message_id: number;
-    content: string;
-    auth: string;
-}
-export interface DeletePrivateMessage {
-    private_message_id: number;
-    deleted: boolean;
-    auth: string;
-}
-export interface MarkPrivateMessageAsRead {
-    private_message_id: number;
-    read: boolean;
-    auth: string;
-}
-export interface GetPrivateMessages {
-    unread_only?: boolean;
-    page?: number;
-    limit?: number;
-    auth: string;
-}
-export interface PrivateMessagesResponse {
-    private_messages: PrivateMessageView[];
-}
-export interface PrivateMessageResponse {
-    private_message_view: PrivateMessageView;
-}
-export interface CreatePrivateMessageReport {
-    private_message_id: number;
-    reason: string;
-    auth: string;
-}
-export interface PrivateMessageReportResponse {
-    private_message_report_view: PrivateMessageReportView;
-}
-export interface ResolvePrivateMessageReport {
-    report_id: number;
-    resolved: boolean;
-    auth: string;
-}
-export interface ListPrivateMessageReports {
-    page?: number;
-    limit?: number;
-    unresolved_only?: boolean;
-    auth: string;
-}
-export interface ListPrivateMessageReportsResponse {
-    private_message_reports: PrivateMessageReportView[];
-}
-export interface GetReportCount {
-    /**
-     * If a community is supplied, returns the report count for only that community, otherwise returns the report count for all communities the user moderates.
-     */
-    community_id?: number;
-    auth: string;
-}
-export interface GetReportCountResponse {
-    community_id?: number;
-    comment_reports: number;
-    post_reports: number;
-    private_message_reports?: number;
-}
-export interface GetUnreadCount {
-    auth: string;
-}
-export interface GetUnreadCountResponse {
-    replies: number;
-    mentions: number;
-    private_messages: number;
-}
-export interface VerifyEmail {
-    token: string;
-}
-export interface VerifyEmailResponse {
-}
-export interface BlockPerson {
-    person_id: number;
-    block: boolean;
-    auth: string;
-}
-export interface BlockPersonResponse {
-    person_view: PersonViewSafe;
-    blocked: boolean;
-}
-export interface GetBannedPersons {
-    auth: string;
-}
-export interface BannedPersonsResponse {
-    banned: PersonViewSafe[];
-}

package/dist/interfaces/api/post.d.ts

@@ -1,141 +0,0 @@
-import { ListingType, PostFeatureType, SiteMetadata, SortType } from "../others";
-import { CommunityModeratorView, CommunityView, PostReportView, PostView } from "../views";
-export interface CreatePost {
-    name: string;
-    url?: string;
-    body?: string;
-    nsfw?: boolean;
-    language_id?: number;
-    community_id: number;
-    honeypot?: string;
-    auth: string;
-}
-export interface PostResponse {
-    post_view: PostView;
-}
-export interface GetPost {
-    id?: number;
-    comment_id?: number;
-    auth?: string;
-}
-export interface GetPostResponse {
-    post_view: PostView;
-    community_view: CommunityView;
-    moderators: CommunityModeratorView[];
-    online: number;
-}
-export interface GetPosts {
-    type_?: ListingType;
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    community_id?: number;
-    /**
-     * To get posts for a federated community by name, use `name@instance.tld` .
-     */
-    community_name?: string;
-    saved_only?: boolean;
-    auth?: string;
-}
-export interface GetPostsResponse {
-    posts: PostView[];
-}
-export interface CreatePostLike {
-    post_id: number;
-    /**
-     * `score` can be 0, -1, or 1. Anything else will be rejected.
-     */
-    score: number;
-    auth: string;
-}
-export interface EditPost {
-    post_id: number;
-    name?: string;
-    url?: string;
-    body?: string;
-    nsfw?: boolean;
-    language_id?: number;
-    auth: string;
-}
-export interface DeletePost {
-    post_id: number;
-    deleted: boolean;
-    auth: string;
-}
-/**
- * Only admins and mods can remove a post.
- */
-export interface RemovePost {
-    post_id: number;
-    removed: boolean;
-    reason?: string;
-    auth: string;
-}
-/**
- * Marks a post as read.
- */
-export interface MarkPostAsRead {
-    post_id: number;
-    read: boolean;
-    auth: string;
-}
-/**
- * Only admins and mods can lock a post.
- */
-export interface LockPost {
-    post_id: number;
-    locked: boolean;
-    auth: string;
-}
-/**
- * Only admins and mods can feature a community post.
- */
-export interface FeaturePost {
-    post_id: number;
-    featured: boolean;
-    feature_type: PostFeatureType;
-    auth: string;
-}
-export interface SavePost {
-    post_id: number;
-    save: boolean;
-    auth: string;
-}
-export interface CreatePostReport {
-    post_id: number;
-    reason: string;
-    auth: string;
-}
-export interface PostReportResponse {
-    post_report_view: PostReportView;
-}
-export interface ResolvePostReport {
-    report_id: number;
-    /**
-     * Either resolve or unresolve a report.
-     */
-    resolved: boolean;
-    auth: string;
-}
-export interface ListPostReports {
-    page?: number;
-    limit?: number;
-    /**
-     * if no community is given, it returns reports for all communities moderated by the auth user.
-     */
-    community_id?: number;
-    /**
-     * Only shows the unresolved reports.
-     */
-    unresolved_only?: boolean;
-    auth: string;
-}
-export interface ListPostReportsResponse {
-    post_reports: PostReportView[];
-}
-export interface GetSiteMetadata {
-    url: string;
-}
-export interface GetSiteMetadataResponse {
-    metadata: SiteMetadata;
-}

package/dist/interfaces/api/site.d.ts

@@ -1,243 +0,0 @@
-import { ListingType, ModlogActionType, SearchType, SortType } from "../others";
-import { Language, RegistrationMode, Tagline } from "../source";
-import { AdminPurgeCommentView, AdminPurgeCommunityView, AdminPurgePersonView, AdminPurgePostView, CommentView, CommunityBlockView, CommunityFollowerView, CommunityModeratorView, CommunityView, LocalUserSettingsView, ModAddCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModFeaturePostView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModTransferCommunityView, PersonBlockView, PersonViewSafe, PostView, RegistrationApplicationView, SiteView } from "../views";
-/**
- * Search lemmy for different types of data.
- */
-export interface Search {
-    /**
-     * The search query string.
-     */
-    q: string;
-    type_?: SearchType;
-    community_id?: number;
-    community_name?: string;
-    creator_id?: number;
-    sort?: SortType;
-    listing_type?: ListingType;
-    page?: number;
-    limit?: number;
-    auth?: string;
-}
-export interface SearchResponse {
-    /**
-     * The [[SearchType]].
-     */
-    type_: string;
-    comments: CommentView[];
-    posts: PostView[];
-    communities: CommunityView[];
-    users: PersonViewSafe[];
-}
-export interface GetModlog {
-    mod_person_id?: number;
-    community_id?: number;
-    page?: number;
-    limit?: number;
-    auth?: string;
-    type_: ModlogActionType;
-    other_person_id?: number;
-}
-export interface GetModlogResponse {
-    removed_posts: ModRemovePostView[];
-    locked_posts: ModLockPostView[];
-    featured_posts: ModFeaturePostView[];
-    removed_comments: ModRemoveCommentView[];
-    removed_communities: ModRemoveCommunityView[];
-    banned_from_community: ModBanFromCommunityView[];
-    banned: ModBanView[];
-    added_to_community: ModAddCommunityView[];
-    transferred_to_community: ModTransferCommunityView[];
-    added: ModAddView[];
-    admin_purged_persons: AdminPurgePersonView[];
-    admin_purged_communities: AdminPurgeCommunityView[];
-    admin_purged_posts: AdminPurgePostView[];
-    admin_purged_comments: AdminPurgeCommentView[];
-}
-export interface CreateSite {
-    name: string;
-    sidebar?: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    enable_downvotes?: boolean;
-    enable_nsfw?: boolean;
-    community_creation_admin_only?: boolean;
-    require_email_verification?: boolean;
-    registration_mode?: RegistrationMode;
-    application_question?: string;
-    private_instance?: boolean;
-    default_theme?: string;
-    default_post_listing_type?: string;
-    application_email_admins?: boolean;
-    reports_email_admins?: boolean;
-    hide_modlog_mod_names?: boolean;
-    discussion_languages?: number[];
-    legal_information?: string;
-    slur_filter_regex?: string;
-    actor_name_max_length?: number;
-    rate_limit_message?: number;
-    rate_limit_message_per_second?: number;
-    rate_limit_post?: number;
-    rate_limit_post_per_second?: number;
-    rate_limit_register?: number;
-    rate_limit_register_per_second?: number;
-    rate_limit_image?: number;
-    rate_limit_image_per_second?: number;
-    rate_limit_comment?: number;
-    rate_limit_comment_per_second?: number;
-    rate_limit_search?: number;
-    rate_limit_search_per_second?: number;
-    federation_enabled?: boolean;
-    federation_debug?: boolean;
-    federation_worker_count?: number;
-    captcha_enabled?: boolean;
-    captcha_difficulty?: string;
-    allowed_instances?: string[];
-    blocked_instances?: string[];
-    taglines?: string[];
-    auth: string;
-}
-export interface EditSite {
-    name?: string;
-    sidebar?: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    enable_downvotes?: boolean;
-    enable_nsfw?: boolean;
-    community_creation_admin_only?: boolean;
-    require_email_verification?: boolean;
-    registration_mode?: RegistrationMode;
-    application_question?: string;
-    private_instance?: boolean;
-    default_theme?: string;
-    default_post_listing_type?: string;
-    legal_information?: string;
-    application_email_admins?: boolean;
-    reports_email_admins?: boolean;
-    hide_modlog_mod_names?: boolean;
-    discussion_languages?: number[];
-    slur_filter_regex?: string;
-    actor_name_max_length?: number;
-    rate_limit_message?: number;
-    rate_limit_message_per_second?: number;
-    rate_limit_post?: number;
-    rate_limit_post_per_second?: number;
-    rate_limit_register?: number;
-    rate_limit_register_per_second?: number;
-    rate_limit_image?: number;
-    rate_limit_image_per_second?: number;
-    rate_limit_comment?: number;
-    rate_limit_comment_per_second?: number;
-    rate_limit_search?: number;
-    rate_limit_search_per_second?: number;
-    federation_enabled?: boolean;
-    federation_debug?: boolean;
-    federation_worker_count?: number;
-    captcha_enabled?: boolean;
-    captcha_difficulty?: string;
-    allowed_instances?: string[];
-    blocked_instances?: string[];
-    taglines?: string[];
-    auth: string;
-}
-export interface GetSite {
-    auth?: string;
-}
-export interface SiteResponse {
-    site_view: SiteView;
-}
-export interface GetSiteResponse {
-    site_view: SiteView;
-    admins: PersonViewSafe[];
-    online: number;
-    version: string;
-    /**
-     * If you're logged in, you'll get back extra user info.
-     */
-    my_user?: MyUserInfo;
-    federated_instances?: FederatedInstances;
-    all_languages: Language[];
-    discussion_languages: number[];
-    taglines?: Tagline[];
-}
-/**
- * Your user info, such as blocks, follows, etc.
- */
-export interface MyUserInfo {
-    local_user_view: LocalUserSettingsView;
-    follows: CommunityFollowerView[];
-    moderates: CommunityModeratorView[];
-    community_blocks: CommunityBlockView[];
-    person_blocks: PersonBlockView[];
-    discussion_languages: number[];
-}
-export interface LeaveAdmin {
-    auth: string;
-}
-export interface FederatedInstances {
-    linked: string[];
-    allowed?: string[];
-    blocked?: string[];
-}
-export interface ResolveObject {
-    q: string;
-    auth?: string;
-}
-export interface ResolveObjectResponse {
-    comment?: CommentView;
-    post?: PostView;
-    community?: CommunityView;
-    person?: PersonViewSafe;
-}
-export interface PurgePerson {
-    person_id: number;
-    reason?: string;
-    auth: string;
-}
-export interface PurgeCommunity {
-    community_id: number;
-    reason?: string;
-    auth: string;
-}
-export interface PurgePost {
-    post_id: number;
-    reason?: string;
-    auth: string;
-}
-export interface PurgeComment {
-    comment_id: number;
-    reason?: string;
-    auth: string;
-}
-export interface PurgeItemResponse {
-    success: boolean;
-}
-export interface ListRegistrationApplications {
-    /**
-     * Only shows the unread applications (IE those without an admin actor)
-     */
-    unread_only?: boolean;
-    page?: number;
-    limit?: number;
-    auth: string;
-}
-export interface ListRegistrationApplicationsResponse {
-    registration_applications: RegistrationApplicationView[];
-}
-export interface ApproveRegistrationApplication {
-    id: number;
-    approve: boolean;
-    deny_reason?: string;
-    auth: string;
-}
-export interface RegistrationApplicationResponse {
-    registration_application: RegistrationApplicationView;
-}
-export interface GetUnreadRegistrationApplicationCount {
-    auth: string;
-}
-export interface GetUnreadRegistrationApplicationCountResponse {
-    registration_applications: number;
-}

package/dist/interfaces/api/websocket.d.ts

@@ -1,27 +0,0 @@
-export interface UserJoin {
-    auth: string;
-}
-export interface UserJoinResponse {
-    joined: boolean;
-}
-/**
- * The main / frontpage community is `community_id: 0`.
- */
-export interface CommunityJoin {
-    community_id: number;
-}
-export interface CommunityJoinResponse {
-    joined: boolean;
-}
-export interface ModJoin {
-    community_id: number;
-}
-export interface ModJoinResponse {
-    joined: boolean;
-}
-export interface PostJoin {
-    post_id: number;
-}
-export interface PostJoinResponse {
-    joined: boolean;
-}

package/dist/interfaces/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./aggregates";
-export * from "./api";
-export * from "./others";
-export * from "./source";
-export * from "./views";