lemmy-js-client 0.20.0-show-mod-reports.1 → 1.0.0-block-nsfw.1

package/README.md

@@ -50,6 +50,15 @@ const posts = await client.getPosts(getPostsForm);
 
 Use `pnpm add` to develop and test changes locally:
 
-```
-pnpm add path/to/lemmy-js-client
-```
+`pnpm add path/to/lemmy-js-client`
+
+## OpenAPI
+
+To generate OpenAPI docs, run `pnpm tsoa`
+
+This creates two files:
+
+- `redoc-static.html` - A static html rendering of the OpenAPI docs.
+- `tsoa_build/swagger.json` - An OpenAPI / Swagger json file.
+
+To contribute, check out the [tsoa docs](https://tsoa-community.github.io/docs/).

package/dist/http.d.ts

@@ -1,3 +1,5 @@
+import { Controller } from "tsoa";
+import { DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListInboxI, ListMediaI, ListPersonContentI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
 import { AddAdmin } from "./types/AddAdmin";
 import { AddAdminResponse } from "./types/AddAdminResponse";
 import { AddModToCommunity } from "./types/AddModToCommunity";
@@ -95,7 +97,6 @@ import { SearchResponse } from "./types/SearchResponse";
 import { SiteResponse } from "./types/SiteResponse";
 import { TransferCommunity } from "./types/TransferCommunity";
 import { VerifyEmail } from "./types/VerifyEmail";
-import { DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListInboxI, ListMediaI, ListPersonContentI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
 import { HideCommunity } from "./types/HideCommunity";
 import { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
 import { UpdateTotp } from "./types/UpdateTotp";
@@ -128,7 +129,7 @@ import { ListInboxResponse } from "./types/ListInboxResponse";
 import { MarkPersonCommentMentionAsRead } from "./types/MarkPersonCommentMentionAsRead";
 import { MarkPersonPostMentionAsRead } from "./types/MarkPersonPostMentionAsRead";
 import { GetCommentsSlimResponse } from "./types/GetCommentsSlimResponse";
-import { Controller } from "tsoa";
+import { ResendVerificationEmail } from "./types/ResendVerificationEmail";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -516,6 +517,10 @@ export declare class LemmyHttp extends Controller {
      * @summary Verify your email
      */
     verifyEmail(form: VerifyEmail, options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * @summary Resend a verification email.
+     */
+    resendVerificationEmail(form: ResendVerificationEmail, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary List your saved content.
      */

package/dist/http.js

@@ -31,8 +31,8 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _LemmyHttp_instances, _LemmyHttp_apiUrl, _LemmyHttp_headers, _LemmyHttp_fetchFunction, _LemmyHttp_buildFullUrl, _LemmyHttp_upload, _LemmyHttp_wrapper;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LemmyHttp = void 0;
-const other_types_1 = require("./other_types");
 const tsoa_1 = require("tsoa");
+const other_types_1 = require("./other_types");
 var HttpType;
 (function (HttpType) {
     HttpType["Get"] = "GET";
@@ -613,6 +613,12 @@ let LemmyHttp = class LemmyHttp extends tsoa_1.Controller {
     verifyEmail(form, options) {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/account/auth/verify_email", form, options);
     }
+    /**
+     * @summary Resend a verification email.
+     */
+    resendVerificationEmail(form, options) {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/account/auth/resend_verification_email", form, options);
+    }
     /**
      * @summary List your saved content.
      */
@@ -1572,6 +1578,12 @@ __decorate([
     __param(0, (0, tsoa_1.Body)()),
     __param(1, (0, tsoa_1.Inject)())
 ], LemmyHttp.prototype, "verifyEmail", null);
+__decorate([
+    (0, tsoa_1.Post)("/account/auth/resend_verification_email"),
+    (0, tsoa_1.Tags)("Account"),
+    __param(0, (0, tsoa_1.Body)()),
+    __param(1, (0, tsoa_1.Inject)())
+], LemmyHttp.prototype, "resendVerificationEmail", null);
 __decorate([
     (0, tsoa_1.Security)("bearerAuth"),
     (0, tsoa_1.Get)("/account/auth/saved"),

package/dist/index.d.ts

@@ -295,6 +295,7 @@ export { RemovePost } from "./types/RemovePost";
 export { ReportCombinedPaginationCursor } from "./types/ReportCombinedPaginationCursor";
 export { ReportCombinedView } from "./types/ReportCombinedView";
 export { ReportType } from "./types/ReportType";
+export { ResendVerificationEmail } from "./types/ResendVerificationEmail";
 export { ResolveCommentReport } from "./types/ResolveCommentReport";
 export { ResolveObject } from "./types/ResolveObject";
 export { ResolveObjectResponse } from "./types/ResolveObjectResponse";

package/dist/types/CommentReplyView.d.ts

@@ -21,7 +21,11 @@ export type CommentReplyView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the comment was saved.
+     */
+    saved?: string;
     creator_blocked: boolean;
     my_vote?: number;
+    can_mod: boolean;
 };

package/dist/types/CommentReport.d.ts

@@ -14,4 +14,5 @@ export type CommentReport = {
     resolver_id?: PersonId;
     published: string;
     updated?: string;
+    violates_instance_rules: boolean;
 };

package/dist/types/CommentReportView.d.ts

@@ -21,7 +21,10 @@ export type CommentReportView = {
     creator_is_admin: boolean;
     creator_blocked: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the comment was saved.
+     */
+    saved?: string;
     my_vote?: number;
     resolver?: Person;
 };

package/dist/types/CommentSlimView.d.ts

@@ -14,7 +14,11 @@ export type CommentSlimView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the comment was saved.
+     */
+    saved?: string;
     creator_blocked: boolean;
     my_vote?: number;
+    can_mod: boolean;
 };

package/dist/types/CommentView.d.ts

@@ -18,7 +18,11 @@ export type CommentView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the comment was saved.
+     */
+    saved?: string;
     creator_blocked: boolean;
     my_vote?: number;
+    can_mod: boolean;
 };

package/dist/types/CommunitySortType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The community sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
  */
-export type CommunitySortType = "Active" | "Hot" | "New" | "Old" | "TopDay" | "TopWeek" | "TopMonth" | "TopYear" | "TopAll" | "MostComments" | "NewComments" | "TopHour" | "TopSixHour" | "TopTwelveHour" | "TopThreeMonths" | "TopSixMonths" | "TopNineMonths" | "Controversial" | "Scaled" | "NameAsc" | "NameDesc";
+export type CommunitySortType = "ActiveSixMonths" | "ActiveMonthly" | "ActiveWeekly" | "ActiveDaily" | "Hot" | "New" | "Old" | "NameAsc" | "NameDesc" | "Comments" | "Posts" | "Subscribers" | "SubscribersLocal";

package/dist/types/CommunityView.d.ts

@@ -10,4 +10,5 @@ export type CommunityView = {
     blocked: boolean;
     counts: CommunityAggregates;
     banned_from_community: boolean;
+    can_mod: boolean;
 };

package/dist/types/CreateCommentReport.d.ts

@@ -5,4 +5,5 @@ import type { CommentId } from "./CommentId";
 export type CreateCommentReport = {
     comment_id: CommentId;
     reason: string;
+    violates_instance_rules?: boolean;
 };

package/dist/types/CreatePostReport.d.ts

@@ -5,4 +5,5 @@ import type { PostId } from "./PostId";
 export type CreatePostReport = {
     post_id: PostId;
     reason: string;
+    violates_instance_rules?: boolean;
 };

package/dist/types/CreateSite.d.ts

@@ -20,6 +20,7 @@ export type CreateSite = {
     default_post_listing_type?: ListingType;
     default_post_listing_mode?: PostListingMode;
     default_post_sort_type?: PostSortType;
+    default_post_time_range_seconds?: number;
     default_comment_sort_type?: CommentSortType;
     legal_information?: string;
     application_email_admins?: boolean;

package/dist/types/EditSite.d.ts

@@ -50,6 +50,10 @@ export type EditSite = {
      * The default post sort, usually "active"
      */
     default_post_sort_type?: PostSortType;
+    /**
+     * A default time range limit to apply to post sorts, in seconds. 0 means none.
+     */
+    default_post_time_range_seconds?: number;
     /**
      * The default comment sort, usually "hot"
      */
@@ -159,4 +163,8 @@ export type EditSite = {
      * donations.
      */
     disable_donation_dialog?: boolean;
+    /**
+     * Block NSFW content being created
+     */
+    disallow_nsfw_content?: boolean;
 };

package/dist/types/FederationError.d.ts

@@ -7,4 +7,4 @@ export type FederationError = "InvalidCommunity" | "CannotCreatePostOrCommentInD
     DomainBlocked: string;
 } | {
     DomainNotInAllowList: string;
-} | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | "Unreachable";
+} | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | "PlatformLackingPrivateCommunitySupport" | "Unreachable";

package/dist/types/GetComments.d.ts

@@ -9,6 +9,11 @@ import type { PostId } from "./PostId";
 export type GetComments = {
     type_?: ListingType;
     sort?: CommentSortType;
+    /**
+     * Filter to within a given time range, in seconds.
+     * IE 60 would give results for the past minute.
+     */
+    time_range_seconds?: number;
     max_depth?: number;
     page?: number;
     limit?: number;

package/dist/types/GetModlog.d.ts

@@ -1,5 +1,6 @@
 import type { CommentId } from "./CommentId";
 import type { CommunityId } from "./CommunityId";
+import type { ListingType } from "./ListingType";
 import type { ModlogActionType } from "./ModlogActionType";
 import type { ModlogCombinedPaginationCursor } from "./ModlogCombinedPaginationCursor";
 import type { PersonId } from "./PersonId";
@@ -8,11 +9,34 @@ import type { PostId } from "./PostId";
  * Fetches the modlog.
  */
 export type GetModlog = {
+    /**
+     * Filter by the moderator.
+     */
     mod_person_id?: PersonId;
+    /**
+     * Filter by the community.
+     */
     community_id?: CommunityId;
+    /**
+     * Filter by the modlog action type.
+     */
     type_?: ModlogActionType;
+    /**
+     * Filter by listing type. When not using All, it will remove the non-community modlog entries,
+     * such as site bans, instance blocks, adding an admin, etc.
+     */
+    listing_type?: ListingType;
+    /**
+     * Filter by the other / modded person.
+     */
     other_person_id?: PersonId;
+    /**
+     * Filter by post. Will include comments of that post.
+     */
     post_id?: PostId;
+    /**
+     * Filter by comment.
+     */
     comment_id?: CommentId;
     page_cursor?: ModlogCombinedPaginationCursor;
     page_back?: boolean;

package/dist/types/GetPostResponse.d.ts

@@ -1,4 +1,3 @@
-import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { CommunityView } from "./CommunityView";
 import type { PostView } from "./PostView";
 /**
@@ -7,7 +6,6 @@ import type { PostView } from "./PostView";
 export type GetPostResponse = {
     post_view: PostView;
     community_view: CommunityView;
-    moderators: Array<CommunityModeratorView>;
     /**
      * A list of cross-posts, or other times / communities this link has been posted to.
      */

package/dist/types/GetPosts.d.ts

@@ -8,6 +8,12 @@ import type { PostSortType } from "./PostSortType";
 export type GetPosts = {
     type_?: ListingType;
     sort?: PostSortType;
+    /**
+     * Filter to within a given time range, in seconds.
+     * IE 60 would give results for the past minute.
+     * Use Zero to override the local_site and local_user time_range.
+     */
+    time_range_seconds?: number;
     /**
      * DEPRECATED, use page_cursor
      */

package/dist/types/ImageDetails.d.ts

@@ -4,4 +4,5 @@ export type ImageDetails = {
     width: number;
     height: number;
     content_type: string;
+    blurhash?: string;
 };

package/dist/types/ListCommunities.d.ts

@@ -6,6 +6,11 @@ import type { ListingType } from "./ListingType";
 export type ListCommunities = {
     type_?: ListingType;
     sort?: CommunitySortType;
+    /**
+     * Filter to within a given time range, in seconds.
+     * IE 60 would give results for the past minute.
+     */
+    time_range_seconds?: number;
     show_nsfw?: boolean;
     page?: number;
     limit?: number;

package/dist/types/ListReports.d.ts

@@ -25,7 +25,11 @@ export type ListReports = {
     page_cursor?: ReportCombinedPaginationCursor;
     page_back?: boolean;
     /**
-     * Only for admins: also show reports destined to community mods
+     * Only for admins: also show reports with `violates_instance_rules=false`
      */
-    show_mod_reports?: boolean;
+    show_community_rule_violations?: boolean;
+    /**
+     * If true, view all your created reports. Works for non-admins/mods also.
+     */
+    my_reports_only?: boolean;
 };

package/dist/types/LocalSite.d.ts

@@ -118,4 +118,12 @@ export type LocalSite = {
      * donations.
      */
     disable_donation_dialog: boolean;
+    /**
+     * A default time range limit to apply to post sorts, in seconds.
+     */
+    default_post_time_range_seconds?: number;
+    /**
+     * Block NSFW content being created
+     */
+    disallow_nsfw_content: boolean;
 };

package/dist/types/LocalUser.d.ts

@@ -93,4 +93,8 @@ export type LocalUser = {
      * Whether to hide posts containing images/videos
      */
     hide_media: boolean;
+    /**
+     * A default time range limit to apply to post sorts, in seconds.
+     */
+    default_post_time_range_seconds?: number;
 };

package/dist/types/PersonAggregates.d.ts

@@ -6,4 +6,5 @@ export type PersonAggregates = {
     person_id: PersonId;
     post_count: number;
     comment_count: number;
+    published: string;
 };

package/dist/types/PersonCommentMentionView.d.ts

@@ -21,7 +21,11 @@ export type PersonCommentMentionView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the comment was saved.
+     */
+    saved?: string;
     creator_blocked: boolean;
     my_vote?: number;
+    can_mod: boolean;
 };

package/dist/types/PersonPostMentionView.d.ts

@@ -22,11 +22,15 @@ export type PersonPostMentionView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the post was saved.
+     */
+    saved?: string;
     read: boolean;
     hidden: boolean;
     creator_blocked: boolean;
     my_vote?: number;
     unread_comments: number;
     post_tags: PostTags;
+    can_mod: boolean;
 };

package/dist/types/PostReport.d.ts

@@ -26,4 +26,5 @@ export type PostReport = {
     resolver_id?: PersonId;
     published: string;
     updated?: string;
+    violates_instance_rules: boolean;
 };

package/dist/types/PostReportView.d.ts

@@ -17,7 +17,10 @@ export type PostReportView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the post was saved.
+     */
+    saved?: string;
     read: boolean;
     hidden: boolean;
     creator_blocked: boolean;

package/dist/types/PostSortType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
  */
-export type PostSortType = "Active" | "Hot" | "New" | "Old" | "TopDay" | "TopWeek" | "TopMonth" | "TopYear" | "TopAll" | "MostComments" | "NewComments" | "TopHour" | "TopSixHour" | "TopTwelveHour" | "TopThreeMonths" | "TopSixMonths" | "TopNineMonths" | "Controversial" | "Scaled";
+export type PostSortType = "Active" | "Hot" | "New" | "Old" | "Top" | "MostComments" | "NewComments" | "Controversial" | "Scaled";

package/dist/types/PostView.d.ts

@@ -19,11 +19,15 @@ export type PostView = {
     creator_is_admin: boolean;
     counts: PostAggregates;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the post was saved.
+     */
+    saved?: string;
     read: boolean;
     hidden: boolean;
     creator_blocked: boolean;
     my_vote?: number;
     unread_comments: number;
     tags: PostTags;
+    can_mod: boolean;
 };

package/dist/types/PrivateMessage.d.ts

@@ -15,4 +15,5 @@ export type PrivateMessage = {
     updated?: string;
     ap_id: DbUrl;
     local: boolean;
+    removed: boolean;
 };

package/dist/types/ResendVerificationEmail.d.ts

@@ -0,0 +1,7 @@
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Make a request to resend your verification email.
+ */
+export type ResendVerificationEmail = {
+    email: SensitiveString;
+};

package/dist/types/ResendVerificationEmail.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/SaveUserSettings.d.ts

@@ -32,6 +32,10 @@ export type SaveUserSettings = {
      * The default post sort, usually "active"
      */
     default_post_sort_type?: PostSortType;
+    /**
+     * A default time range limit to apply to post sorts, in seconds. 0 means none.
+     */
+    default_post_time_range_seconds?: number;
     /**
      * The default comment sort, usually "hot"
      */

package/dist/types/Search.d.ts

@@ -14,6 +14,11 @@ export type Search = {
     creator_id?: PersonId;
     type_?: SearchType;
     sort?: SearchSortType;
+    /**
+     * Filter to within a given time range, in seconds.
+     * IE 60 would give results for the past minute.
+     */
+    time_range_seconds?: number;
     listing_type?: ListingType;
     title_only?: boolean;
     post_url_only?: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.20.0-show-mod-reports.1",
+  "version": "1.0.0-block-nsfw.1",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -40,7 +40,7 @@
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.2.1",
+  "packageManager": "pnpm@10.4.0",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [