lemmy-js-client 1.0.0-action-structs.0 → 1.0.0-action-structs.1

package/dist/http.d.ts

@@ -1,5 +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 { DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListBannedPersonsI, 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";
@@ -468,7 +468,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get a list of banned users.
      */
-    getBannedPersons(options?: RequestOptions): Promise<BannedPersonsResponse>;
+    listBannedPersons(form?: ListBannedPersonsI, options?: RequestOptions): Promise<BannedPersonsResponse>;
     /**
      * @summary Block a person.
      */

package/dist/http.js

@@ -538,8 +538,8 @@ let LemmyHttp = class LemmyHttp extends tsoa_1.Controller {
     /**
      * @summary Get a list of banned users.
      */
-    getBannedPersons(options) {
-        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/admin/banned", {}, options);
+    listBannedPersons(form = {}, options) {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/admin/banned", form, options);
     }
     /**
      * @summary Block a person.
@@ -1497,8 +1497,9 @@ __decorate([
     (0, tsoa_1.Security)("bearerAuth"),
     (0, tsoa_1.Get)("/admin/banned"),
     (0, tsoa_1.Tags)("Admin", "Miscellaneous"),
-    __param(0, (0, tsoa_1.Inject)())
-], LemmyHttp.prototype, "getBannedPersons", null);
+    __param(0, (0, tsoa_1.Queries)()),
+    __param(1, (0, tsoa_1.Inject)())
+], LemmyHttp.prototype, "listBannedPersons", null);
 __decorate([
     (0, tsoa_1.Security)("bearerAuth"),
     (0, tsoa_1.Post)("/account/block/person"),

package/dist/index.d.ts

@@ -61,6 +61,7 @@ export { CommunityId } from "./types/CommunityId";
 export { CommunityModeratorView } from "./types/CommunityModeratorView";
 export { CommunityReport } from "./types/CommunityReport";
 export { CommunityReportId } from "./types/CommunityReportId";
+export { CommunityReportResponse } from "./types/CommunityReportResponse";
 export { CommunityReportView } from "./types/CommunityReportView";
 export { CommunityResponse } from "./types/CommunityResponse";
 export { CommunitySortType } from "./types/CommunitySortType";
@@ -70,6 +71,7 @@ export { CreateComment } from "./types/CreateComment";
 export { CreateCommentLike } from "./types/CreateCommentLike";
 export { CreateCommentReport } from "./types/CreateCommentReport";
 export { CreateCommunity } from "./types/CreateCommunity";
+export { CreateCommunityReport } from "./types/CreateCommunityReport";
 export { CreateCustomEmoji } from "./types/CreateCustomEmoji";
 export { CreateOAuthProvider } from "./types/CreateOAuthProvider";
 export { CreatePost } from "./types/CreatePost";
@@ -151,6 +153,7 @@ export { Language } from "./types/Language";
 export { LanguageId } from "./types/LanguageId";
 export { LemmyErrorType } from "./types/LemmyErrorType";
 export { LinkMetadata } from "./types/LinkMetadata";
+export { ListBannedPersons } from "./types/ListBannedPersons";
 export { ListCommentLikes } from "./types/ListCommentLikes";
 export { ListCommentLikesResponse } from "./types/ListCommentLikesResponse";
 export { ListCommunities } from "./types/ListCommunities";
@@ -208,12 +211,12 @@ export { ModBanFromCommunityId } from "./types/ModBanFromCommunityId";
 export { ModBanFromCommunityView } from "./types/ModBanFromCommunityView";
 export { ModBanId } from "./types/ModBanId";
 export { ModBanView } from "./types/ModBanView";
+export { ModChangeCommunityVisibility } from "./types/ModChangeCommunityVisibility";
+export { ModChangeCommunityVisibilityId } from "./types/ModChangeCommunityVisibilityId";
+export { ModChangeCommunityVisibilityView } from "./types/ModChangeCommunityVisibilityView";
 export { ModFeaturePost } from "./types/ModFeaturePost";
 export { ModFeaturePostId } from "./types/ModFeaturePostId";
 export { ModFeaturePostView } from "./types/ModFeaturePostView";
-export { ModHideCommunity } from "./types/ModHideCommunity";
-export { ModHideCommunityId } from "./types/ModHideCommunityId";
-export { ModHideCommunityView } from "./types/ModHideCommunityView";
 export { ModLockPost } from "./types/ModLockPost";
 export { ModLockPostId } from "./types/ModLockPostId";
 export { ModLockPostView } from "./types/ModLockPostView";
@@ -293,6 +296,7 @@ export { ReportCombinedView } from "./types/ReportCombinedView";
 export { ReportType } from "./types/ReportType";
 export { ResendVerificationEmail } from "./types/ResendVerificationEmail";
 export { ResolveCommentReport } from "./types/ResolveCommentReport";
+export { ResolveCommunityReport } from "./types/ResolveCommunityReport";
 export { ResolveObject } from "./types/ResolveObject";
 export { ResolveObjectResponse } from "./types/ResolveObjectResponse";
 export { ResolvePostReport } from "./types/ResolvePostReport";
@@ -310,7 +314,6 @@ export { Site } from "./types/Site";
 export { SiteId } from "./types/SiteId";
 export { SiteResponse } from "./types/SiteResponse";
 export { SiteView } from "./types/SiteView";
-export { SubscribedType } from "./types/SubscribedType";
 export { SuccessResponse } from "./types/SuccessResponse";
 export { Tag } from "./types/Tag";
 export { TagId } from "./types/TagId";

package/dist/other_types.d.ts

@@ -11,6 +11,7 @@ import { GetRandomCommunity } from "./types/GetRandomCommunity";
 import { GetRegistrationApplication } from "./types/GetRegistrationApplication";
 import { GetReportCount } from "./types/GetReportCount";
 import { GetSiteMetadata } from "./types/GetSiteMetadata";
+import { ListBannedPersons } from "./types/ListBannedPersons";
 import { ListCommentLikes } from "./types/ListCommentLikes";
 import { ListCommunities } from "./types/ListCommunities";
 import { ListCommunityPendingFollows } from "./types/ListCommunityPendingFollows";
@@ -83,3 +84,5 @@ export interface ListReportsI extends ListReports {
 }
 export interface DeleteImageParamsI extends DeleteImageParams {
 }
+export interface ListBannedPersonsI extends ListBannedPersons {
+}

package/dist/types/BannedPersonsResponse.d.ts

@@ -1,7 +1,12 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PersonView } from "./PersonView";
 /**
  * The list of banned persons.
  */
 export type BannedPersonsResponse = {
     banned: Array<PersonView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
 };

package/dist/types/CommentActions.d.ts

@@ -3,7 +3,16 @@ import type { PersonId } from "./PersonId";
 export type CommentActions = {
     person_id: PersonId;
     comment_id: CommentId;
+    /**
+     * The like / score for the comment.
+     */
     like_score?: number;
+    /**
+     * When the comment was liked.
+     */
     liked?: string;
+    /**
+     * When the comment was saved.
+     */
     saved?: string;
 };

package/dist/types/CommentSlimView.d.ts

@@ -1,5 +1,6 @@
 import type { Comment } from "./Comment";
 import type { CommentActions } from "./CommentActions";
+import type { CommunityActions } from "./CommunityActions";
 import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
 import type { PersonActions } from "./PersonActions";
@@ -11,6 +12,7 @@ export type CommentSlimView = {
     creator: Person;
     comment_actions?: CommentActions;
     person_actions?: PersonActions;
+    creator_community_actions?: CommunityActions;
     instance_actions?: InstanceActions;
     creator_is_admin: boolean;
     can_mod: boolean;

package/dist/types/Community.d.ts

@@ -46,10 +46,6 @@ export type Community = {
      * A URL for a banner.
      */
     banner?: DbUrl;
-    /**
-     * Whether the community is hidden.
-     */
-    hidden: boolean;
     /**
      * Whether posting is restricted to mods only.
      */

package/dist/types/CommunityActions.d.ts

@@ -4,11 +4,32 @@ import type { PersonId } from "./PersonId";
 export type CommunityActions = {
     community_id: CommunityId;
     person_id: PersonId;
+    /**
+     * When the community was followed.
+     */
     followed?: string;
+    /**
+     * The state of the community follow.
+     */
     follow_state?: CommunityFollowerState;
+    /**
+     * The approver of the community follow.
+     */
     follow_approver_id?: PersonId;
+    /**
+     * When the community was blocked.
+     */
     blocked?: string;
+    /**
+     * When this user became a moderator.
+     */
     became_moderator?: string;
+    /**
+     * When this user received a ban.
+     */
     received_ban?: string;
+    /**
+     * When their ban expires.
+     */
     ban_expires?: string;
 };

package/dist/types/CommunityReportResponse.d.ts

@@ -0,0 +1,7 @@
+import type { CommunityReportView } from "./CommunityReportView";
+/**
+ * A community report response.
+ */
+export type CommunityReportResponse = {
+    community_report_view: CommunityReportView;
+};

package/dist/types/CommunityVisibility.d.ts

@@ -1,4 +1,4 @@
 /**
  * Defines who can browse and interact with content in a community.
  */
-export type CommunityVisibility = "Public" | "LocalOnly" | "Private";
+export type CommunityVisibility = "Public" | "Unlisted" | "LocalOnlyPublic" | "LocalOnlyPrivate" | "Private";

package/dist/types/CreateCommunityReport.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityId } from "./CommunityId";
+/**
+ * Create a report for a community.
+ */
+export type CreateCommunityReport = {
+    community_id: CommunityId;
+    reason: string;
+};

package/dist/types/Instance.d.ts

@@ -6,7 +6,16 @@ export type Instance = {
     id: InstanceId;
     domain: string;
     published: string;
+    /**
+     * When the instance was updated.
+     */
     updated?: string;
+    /**
+     * The software of the instance.
+     */
     software?: string;
+    /**
+     * The version of the instance's software.
+     */
     version?: string;
 };

package/dist/types/InstanceActions.d.ts

@@ -3,5 +3,8 @@ import type { PersonId } from "./PersonId";
 export type InstanceActions = {
     person_id: PersonId;
     instance_id: InstanceId;
+    /**
+     * When the instance was blocked.
+     */
     blocked?: string;
 };

package/dist/types/InstanceWithFederationState.d.ts

@@ -9,7 +9,16 @@ export type InstanceWithFederationState = {
     id: InstanceId;
     domain: string;
     published: string;
+    /**
+     * When the instance was updated.
+     */
     updated?: string;
+    /**
+     * The software of the instance.
+     */
     software?: string;
+    /**
+     * The version of the instance's software.
+     */
     version?: string;
 };

package/dist/types/LemmyErrorType.d.ts

@@ -176,8 +176,6 @@ export type LemmyErrorType = {
     error: "community_block_already_exists";
 } | {
     error: "community_follower_already_exists";
-} | {
-    error: "couldnt_update_community_hidden_status";
 } | {
     error: "person_block_already_exists";
 } | {

package/dist/types/ListBannedPersons.d.ts

@@ -0,0 +1,9 @@
+import type { PaginationCursor } from "./PaginationCursor";
+/**
+ * List the banned persons.
+ */
+export type ListBannedPersons = {
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
+    limit?: number;
+};

package/dist/types/ListBannedPersons.js

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

package/dist/types/LocalSite.d.ts

@@ -122,6 +122,10 @@ export type LocalSite = {
      * 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;
     users: number;
     posts: number;
     comments: number;
@@ -142,8 +146,4 @@ export type LocalSite = {
      * The number of users with any activity in the last half year.
      */
     users_active_half_year: number;
-    /**
-     * Block NSFW content being created
-     */
-    disallow_nsfw_content: boolean;
 };

package/dist/types/ModChangeCommunityVisibility.d.ts

@@ -0,0 +1,12 @@
+import type { CommunityId } from "./CommunityId";
+import type { CommunityVisibility } from "./CommunityVisibility";
+import type { ModChangeCommunityVisibilityId } from "./ModChangeCommunityVisibilityId";
+import type { PersonId } from "./PersonId";
+export type ModChangeCommunityVisibility = {
+    id: ModChangeCommunityVisibilityId;
+    community_id: CommunityId;
+    mod_person_id: PersonId;
+    published: string;
+    reason?: string;
+    visibility: CommunityVisibility;
+};

package/dist/types/ModChangeCommunityVisibility.js

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

package/dist/types/ModChangeCommunityVisibilityId.d.ts

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

package/dist/types/ModChangeCommunityVisibilityView.d.ts

@@ -0,0 +1,11 @@
+import type { Community } from "./Community";
+import type { ModChangeCommunityVisibility } from "./ModChangeCommunityVisibility";
+import type { Person } from "./Person";
+/**
+ * When the visibility of a community is changed
+ */
+export type ModChangeCommunityVisibilityView = {
+    mod_change_community_visibility: ModChangeCommunityVisibility;
+    moderator?: Person;
+    community: Community;
+};

package/dist/types/ModChangeCommunityVisibilityView.js

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

package/dist/types/ModlogActionType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A list of possible types for the various modlog actions.
  */
-export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModHideCommunity" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment" | "AdminBlockInstance" | "AdminAllowInstance";
+export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModChangeCommunityVisibility" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment" | "AdminBlockInstance" | "AdminAllowInstance";

package/dist/types/ModlogCombinedView.d.ts

@@ -8,8 +8,8 @@ import type { ModAddCommunityView } from "./ModAddCommunityView";
 import type { ModAddView } from "./ModAddView";
 import type { ModBanFromCommunityView } from "./ModBanFromCommunityView";
 import type { ModBanView } from "./ModBanView";
+import type { ModChangeCommunityVisibilityView } from "./ModChangeCommunityVisibilityView";
 import type { ModFeaturePostView } from "./ModFeaturePostView";
-import type { ModHideCommunityView } from "./ModHideCommunityView";
 import type { ModLockPostView } from "./ModLockPostView";
 import type { ModRemoveCommentView } from "./ModRemoveCommentView";
 import type { ModRemoveCommunityView } from "./ModRemoveCommunityView";
@@ -38,8 +38,8 @@ export type ModlogCombinedView = ({
 } & ModBanFromCommunityView) | ({
     type_: "ModFeaturePost";
 } & ModFeaturePostView) | ({
-    type_: "ModHideCommunity";
-} & ModHideCommunityView) | ({
+    type_: "ModChangeCommunityVisibility";
+} & ModChangeCommunityVisibilityView) | ({
     type_: "ModLockPost";
 } & ModLockPostView) | ({
     type_: "ModRemoveComment";

package/dist/types/PendingFollow.d.ts

@@ -1,9 +1,9 @@
 import type { Community } from "./Community";
+import type { CommunityFollowerState } from "./CommunityFollowerState";
 import type { Person } from "./Person";
-import type { SubscribedType } from "./SubscribedType";
 export type PendingFollow = {
     person: Person;
     community: Community;
     is_new_instance: boolean;
-    subscribed: SubscribedType;
+    follow_state?: CommunityFollowerState;
 };

package/dist/types/PersonActions.d.ts

@@ -2,7 +2,8 @@ import type { PersonId } from "./PersonId";
 export type PersonActions = {
     target_id: PersonId;
     person_id: PersonId;
-    followed?: string;
-    follow_pending?: boolean;
+    /**
+     * When the person was blocked.
+     */
     blocked?: string;
 };

package/dist/types/PostActions.d.ts

@@ -3,11 +3,33 @@ import type { PostId } from "./PostId";
 export type PostActions = {
     post_id: PostId;
     person_id: PersonId;
+    /**
+     * When the post was read.
+     */
     read?: string;
+    /**
+     * When was the last time you read the comments.
+     */
     read_comments?: string;
+    /**
+     * The number of comments you read last. Subtract this from total comments to get an unread
+     * count.
+     */
     read_comments_amount?: number;
+    /**
+     * When the post was saved.
+     */
     saved?: string;
+    /**
+     * When the post was liked.
+     */
     liked?: string;
+    /**
+     * The like / score of the post.
+     */
     like_score?: number;
+    /**
+     * When the post was hidden.
+     */
     hidden?: string;
 };

package/dist/types/ResolveCommunityReport.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityReportId } from "./CommunityReportId";
+/**
+ * Resolve a community report.
+ */
+export type ResolveCommunityReport = {
+    report_id: CommunityReportId;
+    resolved: boolean;
+};

package/dist/types/ResolveCommunityReport.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-action-structs.0",
+  "version": "1.0.0-action-structs.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.5.2",
+  "packageManager": "pnpm@10.6.1",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/ModHideCommunity.d.ts

@@ -1,14 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-import type { ModHideCommunityId } from "./ModHideCommunityId";
-import type { PersonId } from "./PersonId";
-/**
- * When a community is hidden from public view.
- */
-export type ModHideCommunity = {
-    id: ModHideCommunityId;
-    community_id: CommunityId;
-    mod_person_id: PersonId;
-    published: string;
-    reason?: string;
-    hidden: boolean;
-};

package/dist/types/ModHideCommunityId.d.ts

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

package/dist/types/ModHideCommunityView.d.ts

@@ -1,11 +0,0 @@
-import type { Community } from "./Community";
-import type { ModHideCommunity } from "./ModHideCommunity";
-import type { Person } from "./Person";
-/**
- * When a community is hidden from public view.
- */
-export type ModHideCommunityView = {
-    mod_hide_community: ModHideCommunity;
-    admin?: Person;
-    community: Community;
-};

package/dist/types/SubscribedType.d.ts

@@ -1,4 +0,0 @@
-/**
- * A type / status for a community subscribe.
- */
-export type SubscribedType = "Subscribed" | "NotSubscribed" | "Pending" | "ApprovalRequired";

package/dist/types/SubscribedType.js

@@ -1,3 +0,0 @@
-"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 });