lemmy-js-client 1.0.0-api-updates-4.1 → 1.0.0-api-updates-6.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-api-updates-4.1",
+  "version": "1.0.0-api-updates-6.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -25,7 +25,7 @@
   "devDependencies": {
     "@eslint/js": "^9.20.0",
     "@redocly/cli": "^2.0.0",
-    "@types/node": "^22.7.4",
+    "@types/node": "^24.0.0",
     "@typescript-eslint/eslint-plugin": "^8.7.0",
     "@typescript-eslint/parser": "^8.7.0",
     "ajv": "^8.17.1",
@@ -38,13 +38,13 @@
     "prettier-plugin-import-sort": "^0.0.7",
     "prettier-plugin-organize-imports": "^4.0.0",
     "prettier-plugin-packagejson": "^2.5.1",
-    "sortpack": "^3.0.0",
+    "sortpack": "^4.0.0",
     "tsoa": "^6.6.0",
     "typedoc": "^0.28.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.18.3",
+  "packageManager": "pnpm@10.24.0",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/AdminAdd.d.ts

@@ -1,12 +0,0 @@
-import type { AdminAddId } from "./AdminAddId";
-import type { PersonId } from "./PersonId";
-/**
- * When someone is added as a site admin.
- */
-export type AdminAdd = {
-    id: AdminAddId;
-    mod_person_id: PersonId;
-    other_person_id: PersonId;
-    removed: boolean;
-    published_at: string;
-};

package/dist/types/AdminAddId.d.ts

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

package/dist/types/AdminAddView.d.ts

@@ -1,10 +0,0 @@
-import type { AdminAdd } from "./AdminAdd";
-import type { Person } from "./Person";
-/**
- * When someone is added as a site moderator.
- */
-export type AdminAddView = {
-    admin_add: AdminAdd;
-    moderator?: Person;
-    other_person: Person;
-};

package/dist/types/AdminAllowInstance.d.ts

@@ -1,11 +0,0 @@
-import type { AdminAllowInstanceId } from "./AdminAllowInstanceId";
-import type { InstanceId } from "./InstanceId";
-import type { PersonId } from "./PersonId";
-export type AdminAllowInstance = {
-    id: AdminAllowInstanceId;
-    instance_id: InstanceId;
-    admin_person_id: PersonId;
-    allowed: boolean;
-    reason: string;
-    published_at: string;
-};

package/dist/types/AdminAllowInstanceId.d.ts

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

package/dist/types/AdminAllowInstanceView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminAllowInstance } from "./AdminAllowInstance";
-import type { Instance } from "./Instance";
-import type { Person } from "./Person";
-/**
- * When an admin purges a post.
- */
-export type AdminAllowInstanceView = {
-    admin_allow_instance: AdminAllowInstance;
-    instance: Instance;
-    admin?: Person;
-};

package/dist/types/AdminAllowInstanceView.js

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

package/dist/types/AdminBan.d.ts

@@ -1,16 +0,0 @@
-import type { AdminBanId } from "./AdminBanId";
-import type { InstanceId } from "./InstanceId";
-import type { PersonId } from "./PersonId";
-/**
- * When someone is banned from the site.
- */
-export type AdminBan = {
-    id: AdminBanId;
-    mod_person_id: PersonId;
-    other_person_id: PersonId;
-    reason: string;
-    banned: boolean;
-    expires_at?: string;
-    published_at: string;
-    instance_id: InstanceId;
-};

package/dist/types/AdminBan.js

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

package/dist/types/AdminBanId.d.ts

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

package/dist/types/AdminBanView.d.ts

@@ -1,10 +0,0 @@
-import type { AdminBan } from "./AdminBan";
-import type { Person } from "./Person";
-/**
- * When someone is banned from the site.
- */
-export type AdminBanView = {
-    admin_ban: AdminBan;
-    moderator?: Person;
-    other_person: Person;
-};

package/dist/types/AdminBanView.js

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

package/dist/types/AdminBlockInstance.d.ts

@@ -1,12 +0,0 @@
-import type { AdminBlockInstanceId } from "./AdminBlockInstanceId";
-import type { InstanceId } from "./InstanceId";
-import type { PersonId } from "./PersonId";
-export type AdminBlockInstance = {
-    id: AdminBlockInstanceId;
-    instance_id: InstanceId;
-    admin_person_id: PersonId;
-    blocked: boolean;
-    reason: string;
-    expires_at?: string;
-    published_at: string;
-};

package/dist/types/AdminBlockInstance.js

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

package/dist/types/AdminBlockInstanceId.d.ts

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

package/dist/types/AdminBlockInstanceView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminBlockInstance } from "./AdminBlockInstance";
-import type { Instance } from "./Instance";
-import type { Person } from "./Person";
-/**
- * When an admin purges a post.
- */
-export type AdminBlockInstanceView = {
-    admin_block_instance: AdminBlockInstance;
-    instance: Instance;
-    admin?: Person;
-};

package/dist/types/AdminBlockInstanceView.js

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

package/dist/types/AdminListUsersResponse.d.ts

@@ -1,10 +0,0 @@
-import type { LocalUserView } from "./LocalUserView";
-import type { PaginationCursor } from "./PaginationCursor";
-export type AdminListUsersResponse = {
-    users: Array<LocalUserView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/AdminListUsersResponse.js

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

package/dist/types/AdminPurgeComment.d.ts

@@ -1,13 +0,0 @@
-import type { AdminPurgeCommentId } from "./AdminPurgeCommentId";
-import type { PersonId } from "./PersonId";
-import type { PostId } from "./PostId";
-/**
- * When an admin purges a comment.
- */
-export type AdminPurgeComment = {
-    id: AdminPurgeCommentId;
-    admin_person_id: PersonId;
-    post_id: PostId;
-    reason: string;
-    published_at: string;
-};

package/dist/types/AdminPurgeComment.js

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

package/dist/types/AdminPurgeCommentId.d.ts

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

package/dist/types/AdminPurgeCommentId.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 });

package/dist/types/AdminPurgeCommentView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminPurgeComment } from "./AdminPurgeComment";
-import type { Person } from "./Person";
-import type { Post } from "./Post";
-/**
- * When an admin purges a comment.
- */
-export type AdminPurgeCommentView = {
-    admin_purge_comment: AdminPurgeComment;
-    admin?: Person;
-    post: Post;
-};

package/dist/types/AdminPurgeCommentView.js

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

package/dist/types/AdminPurgeCommunity.d.ts

@@ -1,11 +0,0 @@
-import type { AdminPurgeCommunityId } from "./AdminPurgeCommunityId";
-import type { PersonId } from "./PersonId";
-/**
- * When an admin purges a community.
- */
-export type AdminPurgeCommunity = {
-    id: AdminPurgeCommunityId;
-    admin_person_id: PersonId;
-    reason: string;
-    published_at: string;
-};

package/dist/types/AdminPurgeCommunity.js

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

package/dist/types/AdminPurgeCommunityId.d.ts

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

package/dist/types/AdminPurgeCommunityId.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 });

package/dist/types/AdminPurgeCommunityView.d.ts

@@ -1,9 +0,0 @@
-import type { AdminPurgeCommunity } from "./AdminPurgeCommunity";
-import type { Person } from "./Person";
-/**
- * When an admin purges a community.
- */
-export type AdminPurgeCommunityView = {
-    admin_purge_community: AdminPurgeCommunity;
-    admin?: Person;
-};

package/dist/types/AdminPurgeCommunityView.js

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

package/dist/types/AdminPurgePerson.d.ts

@@ -1,11 +0,0 @@
-import type { AdminPurgePersonId } from "./AdminPurgePersonId";
-import type { PersonId } from "./PersonId";
-/**
- * When an admin purges a person.
- */
-export type AdminPurgePerson = {
-    id: AdminPurgePersonId;
-    admin_person_id: PersonId;
-    reason: string;
-    published_at: string;
-};

package/dist/types/AdminPurgePerson.js

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

package/dist/types/AdminPurgePersonId.d.ts

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

package/dist/types/AdminPurgePersonId.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 });

package/dist/types/AdminPurgePersonView.d.ts

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

package/dist/types/AdminPurgePersonView.js

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

package/dist/types/AdminPurgePost.d.ts

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

package/dist/types/AdminPurgePost.js

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

package/dist/types/AdminPurgePostId.d.ts

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

package/dist/types/AdminPurgePostId.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 });

package/dist/types/AdminPurgePostView.d.ts

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

package/dist/types/AdminPurgePostView.js

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

package/dist/types/AdminRemoveCommunity.d.ts

@@ -1,14 +0,0 @@
-import type { AdminRemoveCommunityId } from "./AdminRemoveCommunityId";
-import type { CommunityId } from "./CommunityId";
-import type { PersonId } from "./PersonId";
-/**
- * When a moderator removes a community.
- */
-export type AdminRemoveCommunity = {
-    id: AdminRemoveCommunityId;
-    mod_person_id: PersonId;
-    community_id: CommunityId;
-    reason: string;
-    removed: boolean;
-    published_at: string;
-};

package/dist/types/AdminRemoveCommunity.js

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

package/dist/types/AdminRemoveCommunityId.d.ts

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

package/dist/types/AdminRemoveCommunityId.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 });

package/dist/types/AdminRemoveCommunityView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminRemoveCommunity } from "./AdminRemoveCommunity";
-import type { Community } from "./Community";
-import type { Person } from "./Person";
-/**
- * When an admin removes a community.
- */
-export type AdminRemoveCommunityView = {
-    admin_remove_community: AdminRemoveCommunity;
-    moderator?: Person;
-    community: Community;
-};

package/dist/types/AdminRemoveCommunityView.js

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

package/dist/types/BanFromCommunityResponse.d.ts

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

package/dist/types/BanFromCommunityResponse.js

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

package/dist/types/GetCommentsResponse.d.ts

@@ -1,10 +0,0 @@
-import type { CommentView } from "./CommentView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * The comment list response.
- */
-export type GetCommentsResponse = {
-    comments: Array<CommentView>;
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetCommentsResponse.js

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

package/dist/types/GetCommentsSlimResponse.d.ts

@@ -1,10 +0,0 @@
-import type { CommentSlimView } from "./CommentSlimView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * A slimmer comment list response, without the post or community.
- */
-export type GetCommentsSlimResponse = {
-    comments: Array<CommentSlimView>;
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetCommentsSlimResponse.js

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

package/dist/types/GetFederatedInstancesResponse.d.ts

@@ -1,10 +0,0 @@
-import type { FederatedInstanceView } from "./FederatedInstanceView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * A response of federated instances.
- */
-export type GetFederatedInstancesResponse = {
-    federated_instances: Array<FederatedInstanceView>;
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetFederatedInstancesResponse.js

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

package/dist/types/GetModlogResponse.d.ts

@@ -1,13 +0,0 @@
-import type { ModlogCombinedView } from "./ModlogCombinedView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * The modlog fetch response.
- */
-export type GetModlogResponse = {
-    modlog: Array<ModlogCombinedView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetModlogResponse.js

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

package/dist/types/GetPostsResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PostView } from "./PostView";
-/**
- * The post list response.
- */
-export type GetPostsResponse = {
-    posts: Array<PostView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetPostsResponse.js

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

package/dist/types/ListCommentLikesResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { VoteView } from "./VoteView";
-/**
- * The comment likes response
- */
-export type ListCommentLikesResponse = {
-    comment_likes: Array<VoteView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListCommentLikesResponse.js

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

package/dist/types/ListCommunitiesResponse.d.ts

@@ -1,13 +0,0 @@
-import type { CommunityView } from "./CommunityView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * The response for listing communities.
- */
-export type ListCommunitiesResponse = {
-    communities: Array<CommunityView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListCommunitiesResponse.js

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

package/dist/types/ListCommunityPendingFollowsResponse.d.ts

@@ -1,10 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PendingFollowerView } from "./PendingFollowerView";
-export type ListCommunityPendingFollowsResponse = {
-    items: Array<PendingFollowerView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListCommunityPendingFollowsResponse.js

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

package/dist/types/ListMediaResponse.d.ts

@@ -1,10 +0,0 @@
-import type { LocalImageView } from "./LocalImageView";
-import type { PaginationCursor } from "./PaginationCursor";
-export type ListMediaResponse = {
-    images: Array<LocalImageView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListMediaResponse.js

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

package/dist/types/ListMultiCommunitiesResponse.d.ts

@@ -1,4 +0,0 @@
-import type { MultiCommunityView } from "./MultiCommunityView";
-export type ListMultiCommunitiesResponse = {
-    multi_communities: Array<MultiCommunityView>;
-};

package/dist/types/ListMultiCommunitiesResponse.js

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

package/dist/types/ListNotificationsResponse.d.ts

@@ -1,13 +0,0 @@
-import type { NotificationView } from "./NotificationView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * Get your inbox (replies, comment mentions, post mentions, and messages)
- */
-export type ListNotificationsResponse = {
-    notifications: Array<NotificationView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListNotificationsResponse.js

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

package/dist/types/ListPersonContentResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PersonContentCombinedView } from "./PersonContentCombinedView";
-/**
- * A person's content response.
- */
-export type ListPersonContentResponse = {
-    content: Array<PersonContentCombinedView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListPersonContentResponse.js

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