lemmy-js-client 1.0.0-enum-for-api.5 → 1.0.0-enum-variants-snake-case.0

package/dist/http.d.ts

@@ -9,8 +9,11 @@ import { BanFromCommunity } from "./types/BanFromCommunity";
 import { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
 import { MarkManyPostsAsRead } from "./types/MarkManyPostsAsRead";
 import { BanPerson } from "./types/BanPerson";
+import { BanPersonResponse } from "./types/BanPersonResponse";
 import { BlockCommunity } from "./types/BlockCommunity";
+import { BlockCommunityResponse } from "./types/BlockCommunityResponse";
 import { BlockPerson } from "./types/BlockPerson";
+import { BlockPersonResponse } from "./types/BlockPersonResponse";
 import { ChangePassword } from "./types/ChangePassword";
 import { CommentReportResponse } from "./types/CommentReportResponse";
 import { CommentResponse } from "./types/CommentResponse";
@@ -146,7 +149,6 @@ import { ListNotificationsResponse } from "./types/ListNotificationsResponse";
 import { ModEditPost } from "./types/ModEditPost";
 import { UpdateCommunityNotifications } from "./types/UpdateCommunityNotifications";
 import { UpdatePostNotifications } from "./types/UpdatePostNotifications";
-import { PersonResponse } from "./types/PersonResponse";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -253,7 +255,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get / fetch a community.
      */
-    getCommunity(form: GetCommunityI, options?: RequestOptions): Promise<GetCommunityResponse>;
+    getCommunity(form?: GetCommunityI, options?: RequestOptions): Promise<GetCommunityResponse>;
     /**
      * @summary Edit a community.
      */
@@ -281,7 +283,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Block a community.
      */
-    blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<CommunityResponse>;
+    blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<BlockCommunityResponse>;
     /**
      * @summary Delete a community.
      */
@@ -481,11 +483,11 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get the details for a person.
      */
-    getPersonDetails(form: GetPersonDetailsI, options?: RequestOptions): Promise<GetPersonDetailsResponse>;
+    getPersonDetails(form?: GetPersonDetailsI, options?: RequestOptions): Promise<GetPersonDetailsResponse>;
     /**
      * @summary List the content for a person.
      */
-    listPersonContent(form: ListPersonContentI, options?: RequestOptions): Promise<ListPersonContentResponse>;
+    listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<ListPersonContentResponse>;
     /**
      * @summary Make a note for a person.
      */
@@ -493,7 +495,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Ban a person from your site.
      */
-    banPerson(form: BanPerson, options?: RequestOptions): Promise<PersonResponse>;
+    banPerson(form: BanPerson, options?: RequestOptions): Promise<BanPersonResponse>;
     /**
      * @summary Get a list of users.
      */
@@ -501,7 +503,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Block a person.
      */
-    blockPerson(form: BlockPerson, options?: RequestOptions): Promise<PersonResponse>;
+    blockPerson(form: BlockPerson, options?: RequestOptions): Promise<BlockPersonResponse>;
     /**
      * @summary Fetch a Captcha.
      */
@@ -779,7 +781,7 @@ export declare class LemmyHttp extends Controller {
  * The msg is either an empty string, or extra non-translatable info.
  */
 export declare class LemmyError extends Error {
-    status?: number;
-    constructor(name: string, status?: number, msg?: string);
+    status: number;
+    constructor(name: string, status: number, msg?: string);
 }
 export {};

package/dist/http.js

@@ -181,7 +181,7 @@ let LemmyHttp = class LemmyHttp extends runtime_1.Controller {
     /**
      * @summary Get / fetch a community.
      */
-    async getCommunity(form, options) {
+    async getCommunity(form = {}, options) {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/community", form, options);
     }
     /**
@@ -523,13 +523,13 @@ let LemmyHttp = class LemmyHttp extends runtime_1.Controller {
     /**
      * @summary Get the details for a person.
      */
-    async getPersonDetails(form, options) {
+    async getPersonDetails(form = {}, options) {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/person", form, options);
     }
     /**
      * @summary List the content for a person.
      */
-    async listPersonContent(form, options) {
+    async listPersonContent(form = {}, options) {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/person/content", form, options);
     }
     /**

package/dist/index.d.ts

@@ -43,8 +43,11 @@ export { AuthenticateWithOauth } from "./types/AuthenticateWithOauth";
 export { BanFromCommunity } from "./types/BanFromCommunity";
 export { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
 export { BanPerson } from "./types/BanPerson";
+export { BanPersonResponse } from "./types/BanPersonResponse";
 export { BlockCommunity } from "./types/BlockCommunity";
+export { BlockCommunityResponse } from "./types/BlockCommunityResponse";
 export { BlockPerson } from "./types/BlockPerson";
+export { BlockPersonResponse } from "./types/BlockPersonResponse";
 export { CaptchaResponse } from "./types/CaptchaResponse";
 export { ChangePassword } from "./types/ChangePassword";
 export { Comment } from "./types/Comment";
@@ -250,10 +253,8 @@ export { ModlogCombinedView } from "./types/ModlogCombinedView";
 export { MultiCommunity } from "./types/MultiCommunity";
 export { MultiCommunityFollow } from "./types/MultiCommunityFollow";
 export { MultiCommunityId } from "./types/MultiCommunityId";
-export { MultiCommunityResponse } from "./types/MultiCommunityResponse";
 export { MultiCommunityView } from "./types/MultiCommunityView";
 export { MyUserInfo } from "./types/MyUserInfo";
-export { NameOrId } from "./types/NameOrId";
 export { NotePerson } from "./types/NotePerson";
 export { Notification } from "./types/Notification";
 export { NotificationData } from "./types/NotificationData";
@@ -275,7 +276,6 @@ export { PersonContentCombinedView } from "./types/PersonContentCombinedView";
 export { PersonContentType } from "./types/PersonContentType";
 export { PersonId } from "./types/PersonId";
 export { PersonLikedCombinedView } from "./types/PersonLikedCombinedView";
-export { PersonResponse } from "./types/PersonResponse";
 export { PersonSavedCombinedView } from "./types/PersonSavedCombinedView";
 export { PersonView } from "./types/PersonView";
 export { PluginMetadata } from "./types/PluginMetadata";

package/dist/types/AdminBlockInstanceParams.d.ts

@@ -2,5 +2,10 @@ export type AdminBlockInstanceParams = {
     instance: string;
     block: boolean;
     reason: string;
-    expires_at?: string;
+    /**
+     * A time that the block will expire, in unix epoch seconds.
+     *
+     * An i64 unix timestamp is used for a simpler API client implementation.
+     */
+    expires_at?: number;
 };

package/dist/types/AllLemmyErrors.js

@@ -20,10 +20,12 @@ exports.AllLemmyErrors = [
     "cannot_leave_mod",
     "cannot_leave_mod",
     "cannot_leave_mod",
-    "pictrs_api_key_not_provided",
+    "image_url_missing_path_segments",
+    "image_url_missing_last_path_segment",
     "pictrs_api_key_not_provided",
     "no_content_type_header",
     "not_an_image_type",
+    "invalid_image_upload",
     "image_upload_disabled",
     "not_a_mod_or_admin",
     "not_top_mod",
@@ -57,6 +59,7 @@ exports.AllLemmyErrors = [
     "email_already_taken",
     "username_already_taken",
     "person_is_banned_from_community",
+    "no_id_given",
     "incorrect_login",
     "no_email_setup",
     "local_site_not_setup",

package/dist/types/BanPersonResponse.d.ts

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

package/dist/types/BlockCommunityResponse.d.ts

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

package/dist/types/BlockPersonResponse.d.ts

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

package/dist/types/BlockPersonResponse.js

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

package/dist/types/CommentSortType.d.ts

@@ -1,4 +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";
+export type CommentSortType = "hot" | "top" | "new" | "old" | "controversial";

package/dist/types/CommunityFollowerState.d.ts

@@ -1 +1 @@
-export type CommunityFollowerState = "Accepted" | "Pending" | "ApprovalRequired";
+export type CommunityFollowerState = "accepted" | "pending" | "approval_required";

package/dist/types/CommunityNotificationsMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * Available settings for community notifications
  */
-export type CommunityNotificationsMode = "AllPostsAndComments" | "AllPosts" | "RepliesAndMentions" | "Mute";
+export type CommunityNotificationsMode = "all_posts_and_comments" | "all_posts" | "replies_and_mentions" | "mute";

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" | "Unlisted" | "LocalOnlyPublic" | "LocalOnlyPrivate" | "Private";
+export type CommunityVisibility = "public" | "unlisted" | "local_only_public" | "local_only_private" | "private";

package/dist/types/FederationMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * The federation mode for an item
  */
-export type FederationMode = "All" | "Local" | "Disable";
+export type FederationMode = "all" | "local" | "disable";

package/dist/types/GetComments.d.ts

@@ -2,7 +2,6 @@ import type { CommentId } from "./CommentId";
 import type { CommentSortType } from "./CommentSortType";
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
-import type { NameOrId } from "./NameOrId";
 import type { PaginationCursor } from "./PaginationCursor";
 import type { PostId } from "./PostId";
 /**
@@ -20,10 +19,8 @@ export type GetComments = {
     page_cursor?: PaginationCursor;
     page_back?: boolean;
     limit?: number;
-    /**
-     * Example: `star_trek`, or `star_trek@xyz.tld` or `12`
-     */
-    community_name_or_id?: NameOrId<CommunityId>;
+    community_id?: CommunityId;
+    community_name?: string;
     post_id?: PostId;
     parent_id?: CommentId;
 };

package/dist/types/GetCommunity.d.ts

@@ -1,11 +1,11 @@
 import type { CommunityId } from "./CommunityId";
-import type { NameOrId } from "./NameOrId";
 /**
- * Get a community. Must provide either an id, or a name (eg star_trek or star_trek@xyz.tld).
+ * Get a community. Must provide either an id, or a name.
  */
 export type GetCommunity = {
+    id?: CommunityId;
     /**
-     * Example: `star_trek`, or `star_trek@xyz.tld` or `12`
+     * Example: star_trek , or star_trek@xyz.tld
      */
-    name_or_id: NameOrId<CommunityId>;
+    name?: string;
 };

package/dist/types/GetMultiCommunity.d.ts

@@ -1,5 +1,4 @@
 import type { MultiCommunityId } from "./MultiCommunityId";
-import type { NameOrId } from "./NameOrId";
 export type GetMultiCommunity = {
-    name_or_id: NameOrId<MultiCommunityId>;
+    id: MultiCommunityId;
 };

package/dist/types/GetPersonDetails.d.ts

@@ -1,11 +1,13 @@
-import type { NameOrId } from "./NameOrId";
 import type { PersonId } from "./PersonId";
 /**
  * Gets a person's details.
+ *
+ * Either person_id, or username are required.
  */
 export type GetPersonDetails = {
+    person_id?: PersonId;
     /**
-     * Example: `dessalines`, or `dessalines@xyz.tld`, or `12`
+     * Example: dessalines , or dessalines@xyz.tld
      */
-    person_name_or_id: NameOrId<PersonId>;
+    username?: string;
 };

package/dist/types/GetPosts.d.ts

@@ -1,7 +1,6 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { MultiCommunityId } from "./MultiCommunityId";
-import type { NameOrId } from "./NameOrId";
 import type { PaginationCursor } from "./PaginationCursor";
 import type { PostSortType } from "./PostSortType";
 /**
@@ -16,11 +15,9 @@ export type GetPosts = {
      * Use Zero to override the local_site and local_user time_range.
      */
     time_range_seconds?: number;
-    /**
-     * Example: `star_trek`, or `star_trek@xyz.tld` or `12`
-     */
-    community_name_or_id?: NameOrId<CommunityId>;
-    multi_community_name_or_id?: NameOrId<MultiCommunityId>;
+    community_id?: CommunityId;
+    community_name?: string;
+    multi_community_id?: MultiCommunityId;
     show_hidden?: boolean;
     /**
      * If true, then show the read posts (even if your user setting is to hide them)

package/dist/types/LemmyErrorType.d.ts

@@ -41,14 +41,17 @@ export type LemmyErrorType = {
     error: "pictrs_purge_response_error";
     message: string;
 } | {
-    error: "pictrs_api_key_not_provided";
+    error: "image_url_missing_path_segments";
 } | {
-    error: "pictrs_invalid_image_upload";
-    message: string;
+    error: "image_url_missing_last_path_segment";
+} | {
+    error: "pictrs_api_key_not_provided";
 } | {
     error: "no_content_type_header";
 } | {
     error: "not_an_image_type";
+} | {
+    error: "invalid_image_upload";
 } | {
     error: "image_upload_disabled";
 } | {
@@ -115,6 +118,8 @@ export type LemmyErrorType = {
     error: "username_already_taken";
 } | {
     error: "person_is_banned_from_community";
+} | {
+    error: "no_id_given";
 } | {
     error: "incorrect_login";
 } | {

package/dist/types/ListPersonContent.d.ts

@@ -1,16 +1,18 @@
-import type { NameOrId } from "./NameOrId";
 import type { PaginationCursor } from "./PaginationCursor";
 import type { PersonContentType } from "./PersonContentType";
 import type { PersonId } from "./PersonId";
 /**
  * Gets a person's content (posts and comments)
+ *
+ * Either person_id, or username are required.
  */
 export type ListPersonContent = {
     type_?: PersonContentType;
+    person_id?: PersonId;
     /**
-     * Example: `dessalines`, or `dessalines@xyz.tld`, or `12`
+     * Example: dessalines , or dessalines@xyz.tld
      */
-    person_name_or_id: NameOrId<PersonId>;
+    username?: string;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
     limit?: number;

package/dist/types/ListingType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A listing type for post and comment list fetches.
  */
-export type ListingType = "All" | "Local" | "Subscribed" | "ModeratorView" | "Suggested";
+export type ListingType = "all" | "local" | "subscribed" | "moderator_view" | "suggested";

package/dist/types/MultiCommunityView.d.ts

@@ -1,8 +1,6 @@
-import type { CommunityFollowerState } from "./CommunityFollowerState";
 import type { MultiCommunity } from "./MultiCommunity";
 import type { Person } from "./Person";
 export type MultiCommunityView = {
     multi: MultiCommunity;
-    follow_state?: CommunityFollowerState;
     owner: Person;
 };

package/dist/types/NotificationType.d.ts

@@ -1,4 +1,4 @@
 /**
  * Types of notifications which can be received in inbox
  */
-export type NotificationType = "Mention" | "Reply" | "Subscribed" | "PrivateMessage" | "ModAction";
+export type NotificationType = "mention" | "reply" | "subscribed" | "private_message" | "mod_action";

package/dist/types/PostListingMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * A post-view mode that changes how multiple post listings look.
  */
-export type PostListingMode = "List" | "Card" | "SmallCard";
+export type PostListingMode = "list" | "card" | "small_card";

package/dist/types/PostNotificationsMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * Available settings for post notifications
  */
-export type PostNotificationsMode = "AllComments" | "RepliesAndMentions" | "Mute";
+export type PostNotificationsMode = "all_comments" | "replies_and_mentions" | "mute";

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" | "Top" | "MostComments" | "NewComments" | "Controversial" | "Scaled";
+export type PostSortType = "active" | "hot" | "new" | "old" | "top" | "most_comments" | "new_comments" | "controversial" | "scaled";

package/dist/types/RegistrationMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * The registration mode for your site. Determines what happens after a user signs up.
  */
-export type RegistrationMode = "Closed" | "RequireApplication" | "Open";
+export type RegistrationMode = "closed" | "require_application" | "open";

package/dist/types/UntranslatedError.d.ts

@@ -9,4 +9,4 @@ export type UntranslatedError = "InvalidCommunity" | "CannotCreatePostOrCommentI
     DomainNotInAllowList: string;
 } | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | {
     InvalidFollow: string;
-} | "PurgeInvalidImageUrl" | "Unreachable" | "CouldntSendWebmention" | "CommunityHasNoFollowers";
+} | "Unreachable" | "CouldntSendWebmention" | "CommunityHasNoFollowers";

package/dist/types/VoteShow.d.ts

@@ -1,4 +1,4 @@
 /**
  * Lets you show votes for others only, show all votes, or hide all votes.
  */
-export type VoteShow = "Show" | "ShowForOthers" | "Hide";
+export type VoteShow = "show" | "show_for_others" | "hide";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-enum-for-api.5",
+  "version": "1.0.0-enum-variants-snake-case.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -44,7 +44,7 @@
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.18.0",
+  "packageManager": "pnpm@10.18.2",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/MultiCommunityResponse.d.ts

@@ -1,4 +0,0 @@
-import type { MultiCommunityView } from "./MultiCommunityView";
-export type MultiCommunityResponse = {
-    multi_community_view: MultiCommunityView;
-};

package/dist/types/NameOrId.d.ts

@@ -1,4 +0,0 @@
-/**
- * Takes either a name or a numeric ID. For example `main`, `main@lemmy.ml` or `12`.
- */
-export type NameOrId<T> = string | T;

package/dist/types/NameOrId.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/PersonResponse.d.ts

@@ -1,7 +0,0 @@
-import type { PersonView } from "./PersonView";
-/**
- * A person response for actions done to a person.
- */
-export type PersonResponse = {
-    person_view: PersonView;
-};