lemmy-js-client 0.20.0-alpha.7 → 0.20.0-ap-id.1

package/dist/types/AdminPurgePersonView.d.ts

@@ -1,6 +1,9 @@
 import type { AdminPurgePerson } from "./AdminPurgePerson";
 import type { Person } from "./Person";
-export interface AdminPurgePersonView {
+/**
+ * When an admin purges a person.
+ */
+export type AdminPurgePersonView = {
     admin_purge_person: AdminPurgePerson;
     admin?: Person;
-}
+};

package/dist/types/AdminPurgePost.d.ts

@@ -1,9 +1,13 @@
+import type { AdminPurgePostId } from "./AdminPurgePostId";
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface AdminPurgePost {
-    id: number;
+/**
+ * When an admin purges a post.
+ */
+export type AdminPurgePost = {
+    id: AdminPurgePostId;
     admin_person_id: PersonId;
     community_id: CommunityId;
     reason?: string;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/AdminPurgePostId.d.ts

@@ -0,0 +1 @@
+export type AdminPurgePostId = number;

package/dist/types/AdminPurgePostId.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/AdminPurgePostView.d.ts

@@ -1,8 +1,11 @@
 import type { AdminPurgePost } from "./AdminPurgePost";
 import type { Community } from "./Community";
 import type { Person } from "./Person";
-export interface AdminPurgePostView {
+/**
+ * When an admin purges a post.
+ */
+export type AdminPurgePostView = {
     admin_purge_post: AdminPurgePost;
     admin?: Person;
     community: Community;
-}
+};

package/dist/types/ApproveCommunityPendingFollower.d.ts

@@ -0,0 +1,7 @@
+import type { CommunityId } from "./CommunityId";
+import type { PersonId } from "./PersonId";
+export type ApproveCommunityPendingFollower = {
+    community_id: CommunityId;
+    follower_id: PersonId;
+    approve: boolean;
+};

package/dist/types/ApproveRegistrationApplication.d.ts

@@ -1,6 +1,9 @@
 import type { RegistrationApplicationId } from "./RegistrationApplicationId";
-export interface ApproveRegistrationApplication {
+/**
+ * Approves a registration application.
+ */
+export type ApproveRegistrationApplication = {
     id: RegistrationApplicationId;
     approve: boolean;
     deny_reason?: string;
-}
+};

package/dist/types/AuthenticateWithOauth.d.ts

@@ -1,8 +1,19 @@
-export interface AuthenticateWithOauth {
+import type { OAuthProviderId } from "./OAuthProviderId";
+/**
+ * Logging in with an OAuth 2.0 authorization
+ */
+export type AuthenticateWithOauth = {
     code: string;
-    oauth_provider_id: string;
+    oauth_provider_id: OAuthProviderId;
     redirect_uri: string;
     show_nsfw?: boolean;
+    /**
+     * Username is mandatory at registration time
+     */
     username?: string;
+    /**
+     * An answer is mandatory if require application is enabled on the server
+     */
     answer?: string;
-}
+    pkce_code_verifier?: string;
+};

package/dist/types/AuthenticateWithOauth.js

@@ -1,3 +1,2 @@
 "use strict";
-// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/BanFromCommunity.d.ts

@@ -1,10 +1,22 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface BanFromCommunity {
+/**
+ * Ban a user from a community.
+ */
+export type BanFromCommunity = {
     community_id: CommunityId;
     person_id: PersonId;
     ban: boolean;
+    /**
+     * Optionally remove or restore all their data. Useful for new troll accounts.
+     * If ban is true, then this means remove. If ban is false, it means restore.
+     */
     remove_or_restore_data?: boolean;
     reason?: string;
+    /**
+     * A time that the ban will expire, in unix epoch seconds.
+     *
+     * An i64 unix timestamp is used for a simpler API client implementation.
+     */
     expires?: number;
-}
+};

package/dist/types/BanFromCommunityResponse.d.ts

@@ -1,5 +1,8 @@
 import type { PersonView } from "./PersonView";
-export interface BanFromCommunityResponse {
+/**
+ * The response for banning a user from a community.
+ */
+export type BanFromCommunityResponse = {
     person_view: PersonView;
     banned: boolean;
-}
+};

package/dist/types/BanPerson.d.ts

@@ -1,8 +1,20 @@
 import type { PersonId } from "./PersonId";
-export interface BanPerson {
+/**
+ * Ban a person from the site.
+ */
+export type BanPerson = {
     person_id: PersonId;
     ban: boolean;
+    /**
+     * Optionally remove or restore all their data. Useful for new troll accounts.
+     * If ban is true, then this means remove. If ban is false, it means restore.
+     */
     remove_or_restore_data?: boolean;
     reason?: string;
+    /**
+     * A time that the ban will expire, in unix epoch seconds.
+     *
+     * An i64 unix timestamp is used for a simpler API client implementation.
+     */
     expires?: number;
-}
+};

package/dist/types/BanPersonResponse.d.ts

@@ -1,5 +1,8 @@
 import type { PersonView } from "./PersonView";
-export interface BanPersonResponse {
+/**
+ * A response for a banned person.
+ */
+export type BanPersonResponse = {
     person_view: PersonView;
     banned: boolean;
-}
+};

package/dist/types/BannedPersonsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PersonView } from "./PersonView";
-export interface BannedPersonsResponse {
+/**
+ * The list of banned persons.
+ */
+export type BannedPersonsResponse = {
     banned: Array<PersonView>;
-}
+};

package/dist/types/BlockCommunity.d.ts

@@ -1,5 +1,8 @@
 import type { CommunityId } from "./CommunityId";
-export interface BlockCommunity {
+/**
+ * Block a community.
+ */
+export type BlockCommunity = {
     community_id: CommunityId;
     block: boolean;
-}
+};

package/dist/types/BlockCommunityResponse.d.ts

@@ -1,5 +1,8 @@
 import type { CommunityView } from "./CommunityView";
-export interface BlockCommunityResponse {
+/**
+ * The block community response.
+ */
+export type BlockCommunityResponse = {
     community_view: CommunityView;
     blocked: boolean;
-}
+};

package/dist/types/BlockPerson.d.ts

@@ -1,5 +1,8 @@
 import type { PersonId } from "./PersonId";
-export interface BlockPerson {
+/**
+ * Block a person.
+ */
+export type BlockPerson = {
     person_id: PersonId;
     block: boolean;
-}
+};

package/dist/types/BlockPersonResponse.d.ts

@@ -1,5 +1,8 @@
 import type { PersonView } from "./PersonView";
-export interface BlockPersonResponse {
+/**
+ * The response for a person block.
+ */
+export type BlockPersonResponse = {
     person_view: PersonView;
     blocked: boolean;
-}
+};

package/dist/types/CaptchaResponse.d.ts

@@ -1,5 +1,17 @@
-export interface CaptchaResponse {
+/**
+ * A captcha response.
+ */
+export type CaptchaResponse = {
+    /**
+     * A Base64 encoded png
+     */
     png: string;
+    /**
+     * A Base64 encoded wav audio
+     */
     wav: string;
+    /**
+     * The UUID for the captcha item.
+     */
     uuid: string;
-}
+};

package/dist/types/ChangePassword.d.ts

@@ -1,5 +1,9 @@
-export interface ChangePassword {
-    new_password: string;
-    new_password_verify: string;
-    old_password: string;
-}
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Changes your account password.
+ */
+export type ChangePassword = {
+    new_password: SensitiveString;
+    new_password_verify: SensitiveString;
+    old_password: SensitiveString;
+};

package/dist/types/ChangePassword.js

@@ -1,3 +1,2 @@
 "use strict";
-// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Comment.d.ts

@@ -1,19 +1,42 @@
 import type { CommentId } from "./CommentId";
+import type { DbUrl } from "./DbUrl";
 import type { LanguageId } from "./LanguageId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface Comment {
+/**
+ * A comment.
+ */
+export type Comment = {
     id: CommentId;
     creator_id: PersonId;
     post_id: PostId;
     content: string;
+    /**
+     * Whether the comment has been removed.
+     */
     removed: boolean;
     published: string;
     updated?: string;
+    /**
+     * Whether the comment has been deleted by its creator.
+     */
     deleted: boolean;
-    ap_id: string;
+    /**
+     * The federated activity id / ap_id.
+     */
+    ap_id: DbUrl;
+    /**
+     * Whether the comment is local.
+     */
     local: boolean;
+    /**
+     * The path / tree location of a comment, separated by dots, ending with the comment's id. Ex:
+     * 0.24.27
+     */
     path: string;
+    /**
+     * Whether the comment has been distinguished(speaking officially) by a mod.
+     */
     distinguished: boolean;
     language_id: LanguageId;
-}
+};

package/dist/types/CommentAggregates.d.ts

@@ -1,9 +1,17 @@
 import type { CommentId } from "./CommentId";
-export interface CommentAggregates {
+/**
+ * Aggregate data for a comment.
+ */
+export type CommentAggregates = {
     comment_id: CommentId;
     score: number;
     upvotes: number;
     downvotes: number;
     published: string;
+    /**
+     * The total number of children in this comment branch.
+     */
     child_count: number;
-}
+    report_count: number;
+    unresolved_report_count: number;
+};

package/dist/types/CommentId.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment id.
+ */
 export type CommentId = number;

package/dist/types/CommentReply.d.ts

@@ -1,10 +1,13 @@
 import type { CommentId } from "./CommentId";
 import type { CommentReplyId } from "./CommentReplyId";
 import type { PersonId } from "./PersonId";
-export interface CommentReply {
+/**
+ * A comment reply.
+ */
+export type CommentReply = {
     id: CommentReplyId;
     recipient_id: PersonId;
     comment_id: CommentId;
     read: boolean;
     published: string;
-}
+};

package/dist/types/CommentReplyId.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment reply id.
+ */
 export type CommentReplyId = number;

package/dist/types/CommentReplyView.d.ts

@@ -5,7 +5,10 @@ import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface CommentReplyView {
+/**
+ * A comment reply view.
+ */
+export type CommentReplyView = {
     comment_reply: CommentReply;
     comment: Comment;
     creator: Person;
@@ -21,4 +24,4 @@ export interface CommentReplyView {
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
-}
+};

package/dist/types/CommentReport.d.ts

@@ -1,7 +1,10 @@
 import type { CommentId } from "./CommentId";
 import type { CommentReportId } from "./CommentReportId";
 import type { PersonId } from "./PersonId";
-export interface CommentReport {
+/**
+ * A comment report.
+ */
+export type CommentReport = {
     id: CommentReportId;
     creator_id: PersonId;
     comment_id: CommentId;
@@ -11,4 +14,4 @@ export interface CommentReport {
     resolver_id?: PersonId;
     published: string;
     updated?: string;
-}
+};

package/dist/types/CommentReportId.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment report id.
+ */
 export type CommentReportId = number;

package/dist/types/CommentReportResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommentReportView } from "./CommentReportView";
-export interface CommentReportResponse {
+/**
+ * The comment report response.
+ */
+export type CommentReportResponse = {
     comment_report_view: CommentReportView;
-}
+};

package/dist/types/CommentReportView.d.ts

@@ -5,7 +5,10 @@ import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface CommentReportView {
+/**
+ * A comment report view.
+ */
+export type CommentReportView = {
     comment_report: CommentReport;
     comment: Comment;
     post: Post;
@@ -21,4 +24,4 @@ export interface CommentReportView {
     saved: boolean;
     my_vote?: number;
     resolver?: Person;
-}
+};

package/dist/types/CommentResponse.d.ts

@@ -1,6 +1,9 @@
 import type { CommentView } from "./CommentView";
 import type { LocalUserId } from "./LocalUserId";
-export interface CommentResponse {
+/**
+ * A comment response.
+ */
+export type CommentResponse = {
     comment_view: CommentView;
     recipient_ids: Array<LocalUserId>;
-}
+};

package/dist/types/CommentSlimView.d.ts

@@ -0,0 +1,20 @@
+import type { Comment } from "./Comment";
+import type { CommentAggregates } from "./CommentAggregates";
+import type { Person } from "./Person";
+import type { SubscribedType } from "./SubscribedType";
+/**
+ * A slimmer comment view, without the post, or community.
+ */
+export type CommentSlimView = {
+    comment: Comment;
+    creator: Person;
+    counts: CommentAggregates;
+    creator_banned_from_community: boolean;
+    banned_from_community: boolean;
+    creator_is_moderator: boolean;
+    creator_is_admin: boolean;
+    subscribed: SubscribedType;
+    saved: boolean;
+    creator_blocked: boolean;
+    my_vote?: number;
+};

package/dist/types/CommentSortType.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
+ */
 export type CommentSortType = "Hot" | "Top" | "New" | "Old" | "Controversial";

package/dist/types/CommentView.d.ts

@@ -4,7 +4,10 @@ import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface CommentView {
+/**
+ * A comment view.
+ */
+export type CommentView = {
     comment: Comment;
     creator: Person;
     post: Post;
@@ -18,4 +21,4 @@ export interface CommentView {
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
-}
+};

package/dist/types/Community.d.ts

@@ -1,22 +1,63 @@
 import type { CommunityId } from "./CommunityId";
 import type { CommunityVisibility } from "./CommunityVisibility";
+import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
-export interface Community {
+/**
+ * A community.
+ */
+export type Community = {
     id: CommunityId;
     name: string;
+    /**
+     * A longer title, that can contain other characters, and doesn't have to be unique.
+     */
     title: string;
-    description?: string;
+    /**
+     * A sidebar for the community in markdown.
+     */
+    sidebar?: string;
+    /**
+     * Whether the community is removed by a mod.
+     */
     removed: boolean;
     published: string;
     updated?: string;
+    /**
+     * Whether the community has been deleted by its creator.
+     */
     deleted: boolean;
+    /**
+     * Whether its an NSFW community.
+     */
     nsfw: boolean;
-    actor_id: string;
+    /**
+     * The federated ap_id.
+     */
+    ap_id: DbUrl;
+    /**
+     * Whether the community is local.
+     */
     local: boolean;
-    icon?: string;
-    banner?: string;
+    /**
+     * A URL for an icon.
+     */
+    icon?: DbUrl;
+    /**
+     * A URL for a banner.
+     */
+    banner?: DbUrl;
+    /**
+     * Whether the community is hidden.
+     */
     hidden: boolean;
+    /**
+     * Whether posting is restricted to mods only.
+     */
     posting_restricted_to_mods: boolean;
     instance_id: InstanceId;
     visibility: CommunityVisibility;
-}
+    /**
+     * A shorter, one-line description of the site.
+     */
+    description?: string;
+};

package/dist/types/CommunityAggregates.d.ts

@@ -1,13 +1,30 @@
 import type { CommunityId } from "./CommunityId";
-export interface CommunityAggregates {
+/**
+ * Aggregate data for a community.
+ */
+export type CommunityAggregates = {
     community_id: CommunityId;
     subscribers: number;
     posts: number;
     comments: number;
     published: string;
+    /**
+     * The number of users with any activity in the last day.
+     */
     users_active_day: number;
+    /**
+     * The number of users with any activity in the last week.
+     */
     users_active_week: number;
+    /**
+     * The number of users with any activity in the last month.
+     */
     users_active_month: number;
+    /**
+     * The number of users with any activity in the last year.
+     */
     users_active_half_year: number;
     subscribers_local: number;
-}
+    report_count: number;
+    unresolved_report_count: number;
+};

package/dist/types/CommunityFollowerState.d.ts

@@ -0,0 +1 @@
+export type CommunityFollowerState = "Accepted" | "Pending" | "ApprovalRequired";

package/dist/types/CommunityFollowerState.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CommunityFollowerView.d.ts

@@ -1,6 +1,9 @@
 import type { Community } from "./Community";
 import type { Person } from "./Person";
-export interface CommunityFollowerView {
+/**
+ * A community follower.
+ */
+export type CommunityFollowerView = {
     community: Community;
     follower: Person;
-}
+};

package/dist/types/CommunityId.d.ts

@@ -1 +1,4 @@
+/**
+ * The community id.
+ */
 export type CommunityId = number;

package/dist/types/CommunityModeratorView.d.ts

@@ -1,6 +1,9 @@
 import type { Community } from "./Community";
 import type { Person } from "./Person";
-export interface CommunityModeratorView {
+/**
+ * A community moderator.
+ */
+export type CommunityModeratorView = {
     community: Community;
     moderator: Person;
-}
+};