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

package/dist/types/SaveUserSettings.d.ts

@@ -1,35 +1,123 @@
+import type { CommentSortType } from "./CommentSortType";
 import type { LanguageId } from "./LanguageId";
 import type { ListingType } from "./ListingType";
 import type { PostListingMode } from "./PostListingMode";
-import type { SortType } from "./SortType";
-export interface SaveUserSettings {
+import type { PostSortType } from "./PostSortType";
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Saves settings for your user.
+ */
+export type SaveUserSettings = {
+    /**
+     * Show nsfw posts.
+     */
     show_nsfw?: boolean;
+    /**
+     * Blur nsfw posts.
+     */
     blur_nsfw?: boolean;
-    auto_expand?: boolean;
+    /**
+     * Your user's theme.
+     */
     theme?: string;
-    default_sort_type?: SortType;
+    /**
+     * The default post listing type, usually "local"
+     */
     default_listing_type?: ListingType;
+    /**
+     * A post-view mode that changes how multiple post listings look.
+     */
+    post_listing_mode?: PostListingMode;
+    /**
+     * The default post sort, usually "active"
+     */
+    default_post_sort_type?: PostSortType;
+    /**
+     * The default comment sort, usually "hot"
+     */
+    default_comment_sort_type?: CommentSortType;
+    /**
+     * The language of the lemmy interface
+     */
     interface_language?: string;
-    avatar?: string;
-    banner?: string;
+    /**
+     * Your display name, which can contain strange characters, and does not need to be unique.
+     */
     display_name?: string;
-    email?: string;
+    /**
+     * Your email.
+     */
+    email?: SensitiveString;
+    /**
+     * Your bio / info, in markdown.
+     */
     bio?: string;
+    /**
+     * Your matrix user id. Ex: @my_user:matrix.org
+     */
     matrix_user_id?: string;
+    /**
+     * Whether to show or hide avatars.
+     */
     show_avatars?: boolean;
+    /**
+     * Sends notifications to your email.
+     */
     send_notifications_to_email?: boolean;
+    /**
+     * Whether this account is a bot account. Users can hide these accounts easily if they wish.
+     */
     bot_account?: boolean;
+    /**
+     * Whether to show bot accounts.
+     */
     show_bot_accounts?: boolean;
+    /**
+     * Whether to show read posts.
+     */
     show_read_posts?: boolean;
+    /**
+     * A list of languages you are able to see discussion in.
+     */
     discussion_languages?: Array<LanguageId>;
+    /**
+     * Open links in a new tab
+     */
     open_links_in_new_tab?: boolean;
+    /**
+     * Enable infinite scroll
+     */
     infinite_scroll_enabled?: boolean;
-    post_listing_mode?: PostListingMode;
+    /**
+     * Whether to allow keyboard navigation (for browsing and interacting with posts and comments).
+     */
     enable_keyboard_navigation?: boolean;
+    /**
+     * Whether user avatars or inline images in the UI that are gifs should be allowed to play or
+     * should be paused
+     */
     enable_animated_images?: boolean;
+    /**
+     * Whether a user can send / receive private messages
+     */
+    enable_private_messages?: boolean;
+    /**
+     * Whether to auto-collapse bot comments.
+     */
     collapse_bot_comments?: boolean;
+    /**
+     * Some vote display mode settings
+     */
     show_scores?: boolean;
     show_upvotes?: boolean;
     show_downvotes?: boolean;
     show_upvote_percentage?: boolean;
-}
+    /**
+     * Whether to automatically mark fetched posts as read.
+     */
+    auto_mark_fetched_posts_as_read?: boolean;
+    /**
+     * Whether to hide posts containing images/videos.
+     */
+    hide_media?: boolean;
+};

package/dist/types/Search.d.ts

@@ -1,17 +1,24 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PersonId } from "./PersonId";
+import type { SearchCombinedPaginationCursor } from "./SearchCombinedPaginationCursor";
+import type { SearchSortType } from "./SearchSortType";
 import type { SearchType } from "./SearchType";
-import type { SortType } from "./SortType";
-export interface Search {
-    q: string;
+/**
+ * Searches the site, given a search term, and some optional filters.
+ */
+export type Search = {
+    search_term?: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
     type_?: SearchType;
-    sort?: SortType;
+    sort?: SearchSortType;
     listing_type?: ListingType;
-    page?: number;
-    limit?: number;
-    post_title_only?: boolean;
-}
+    title_only?: boolean;
+    post_url_only?: boolean;
+    liked_only?: boolean;
+    disliked_only?: boolean;
+    page_cursor?: SearchCombinedPaginationCursor;
+    page_back?: boolean;
+};

package/dist/types/SearchCombinedPaginationCursor.d.ts

@@ -0,0 +1,4 @@
+/**
+ * like PaginationCursor but for the modlog_combined
+ */
+export type SearchCombinedPaginationCursor = string;

package/dist/types/SearchCombinedPaginationCursor.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/SearchCombinedView.d.ts

@@ -0,0 +1,13 @@
+import type { CommentView } from "./CommentView";
+import type { CommunityView } from "./CommunityView";
+import type { PersonView } from "./PersonView";
+import type { PostView } from "./PostView";
+export type SearchCombinedView = ({
+    type_: "Post";
+} & PostView) | ({
+    type_: "Comment";
+} & CommentView) | ({
+    type_: "Community";
+} & CommunityView) | ({
+    type_: "Person";
+} & PersonView);

package/dist/types/SearchCombinedView.js

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

package/dist/types/SearchResponse.d.ts

@@ -1,12 +1,7 @@
-import type { CommentView } from "./CommentView";
-import type { CommunityView } from "./CommunityView";
-import type { PersonView } from "./PersonView";
-import type { PostView } from "./PostView";
-import type { SearchType } from "./SearchType";
-export interface SearchResponse {
-    type_: SearchType;
-    comments: Array<CommentView>;
-    posts: Array<PostView>;
-    communities: Array<CommunityView>;
-    users: Array<PersonView>;
-}
+import type { SearchCombinedView } from "./SearchCombinedView";
+/**
+ * The search response, containing lists of the return type possibilities
+ */
+export type SearchResponse = {
+    results: Array<SearchCombinedView>;
+};

package/dist/types/SearchSortType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The search sort types.
+ */
+export type SearchSortType = "New" | "Top" | "Old";

package/dist/types/SearchSortType.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/SearchType.d.ts

@@ -1 +1,4 @@
-export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users" | "Url";
+/**
+ * The type of content returned from a search.
+ */
+export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users";

package/dist/types/SensitiveString.d.ts

@@ -0,0 +1 @@
+export type SensitiveString = string;

package/dist/types/SensitiveString.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/Site.d.ts

@@ -1,18 +1,47 @@
+import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
 import type { SiteId } from "./SiteId";
-export interface Site {
+/**
+ * The site.
+ */
+export type Site = {
     id: SiteId;
     name: string;
+    /**
+     * A sidebar for the site in markdown.
+     */
     sidebar?: string;
     published: string;
     updated?: string;
-    icon?: string;
-    banner?: string;
+    /**
+     * An icon URL.
+     */
+    icon?: DbUrl;
+    /**
+     * A banner url.
+     */
+    banner?: DbUrl;
+    /**
+     * A shorter, one-line description of the site.
+     */
     description?: string;
-    actor_id: string;
+    /**
+     * The federated ap_id.
+     */
+    ap_id: DbUrl;
+    /**
+     * The time the site was last refreshed.
+     */
     last_refreshed_at: string;
-    inbox_url: string;
+    /**
+     * The site inbox
+     */
+    inbox_url: DbUrl;
     public_key: string;
     instance_id: InstanceId;
+    /**
+     * If present, nsfw content is visible by default. Should be displayed by frontends/clients
+     * when the site is first opened by a user.
+     */
     content_warning?: string;
-}
+};

package/dist/types/SiteAggregates.d.ts

@@ -1,12 +1,27 @@
 import type { SiteId } from "./SiteId";
-export interface SiteAggregates {
+/**
+ * Aggregate data for a site.
+ */
+export type SiteAggregates = {
     site_id: SiteId;
     users: number;
     posts: number;
     comments: number;
     communities: number;
+    /**
+     * 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 half year.
+     */
     users_active_half_year: number;
-}
+};

package/dist/types/SiteId.d.ts

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

package/dist/types/SiteResponse.d.ts

@@ -1,6 +1,11 @@
 import type { SiteView } from "./SiteView";
-import type { Tagline } from "./Tagline";
-export interface SiteResponse {
+/**
+ * The response for a site.
+ */
+export type SiteResponse = {
     site_view: SiteView;
-    taglines: Array<Tagline>;
-}
+    /**
+     * deprecated, use field `tagline` or /api/v4/tagline/list
+     */
+    taglines: Array<null>;
+};

package/dist/types/SiteView.d.ts

@@ -2,9 +2,12 @@ import type { LocalSite } from "./LocalSite";
 import type { LocalSiteRateLimit } from "./LocalSiteRateLimit";
 import type { Site } from "./Site";
 import type { SiteAggregates } from "./SiteAggregates";
-export interface SiteView {
+/**
+ * A site view.
+ */
+export type SiteView = {
     site: Site;
     local_site: LocalSite;
     local_site_rate_limit: LocalSiteRateLimit;
     counts: SiteAggregates;
-}
+};

package/dist/types/SubscribedType.d.ts

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

package/dist/types/SuccessResponse.d.ts

@@ -1,3 +1,6 @@
-export interface SuccessResponse {
+/**
+ * A response that completes successfully.
+ */
+export type SuccessResponse = {
     success: boolean;
-}
+};

package/dist/types/Tag.d.ts

@@ -0,0 +1,27 @@
+import type { CommunityId } from "./CommunityId";
+import type { DbUrl } from "./DbUrl";
+import type { TagId } from "./TagId";
+/**
+ * A tag that can be assigned to a post within a community.
+ * The tag object is created by the community moderators.
+ * The assignment happens by the post creator and can be updated by the community moderators.
+ *
+ * A tag is a federatable object that gives additional context to another object, which can be
+ * displayed and filtered on currently, we only have community post tags, which is a tag that is
+ * created by post authors as well as mods  of a community, to categorize a post. in the future we
+ * may add more tag types, depending on the requirements, this will lead to either expansion of
+ * this table (community_id optional, addition of tag_type enum) or split of this table / creation
+ * of new tables.
+ */
+export type Tag = {
+    id: TagId;
+    ap_id: DbUrl;
+    name: string;
+    /**
+     * the community that owns this tag
+     */
+    community_id: CommunityId;
+    published: string;
+    updated?: string;
+    deleted: boolean;
+};

package/dist/types/Tag.js

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

package/dist/types/TagId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The internal tag id.
+ */
+export type TagId = number;

package/dist/types/TagId.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/Tagline.d.ts

@@ -1,8 +1,9 @@
-import type { LocalSiteId } from "./LocalSiteId";
-export interface Tagline {
+/**
+ * A tagline, shown at the top of your site.
+ */
+export type Tagline = {
     id: number;
-    local_site_id: LocalSiteId;
     content: string;
     published: string;
     updated?: string;
-}
+};

package/dist/types/Tagline.js

@@ -1,2 +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/TaglineId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The tagline id.
+ */
+export type TaglineId = number;

package/dist/types/TaglineId.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/TaglineResponse.d.ts

@@ -0,0 +1,4 @@
+import type { Tagline } from "./Tagline";
+export type TaglineResponse = {
+    tagline: Tagline;
+};

package/dist/types/TaglineResponse.js

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

package/dist/types/TransferCommunity.d.ts

@@ -1,6 +1,9 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface TransferCommunity {
+/**
+ * Transfer a community to a new owner.
+ */
+export type TransferCommunity = {
     community_id: CommunityId;
     person_id: PersonId;
-}
+};

package/dist/types/UpdateTagline.d.ts

@@ -0,0 +1,8 @@
+import type { TaglineId } from "./TaglineId";
+/**
+ * Update a tagline
+ */
+export type UpdateTagline = {
+    id: TaglineId;
+    content: string;
+};

package/dist/types/UpdateTagline.js

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

package/dist/types/UpdateTotp.d.ts

@@ -1,4 +1,4 @@
-export interface UpdateTotp {
+export type UpdateTotp = {
     totp_token: string;
     enabled: boolean;
-}
+};

package/dist/types/UpdateTotpResponse.d.ts

@@ -1,3 +1,3 @@
-export interface UpdateTotpResponse {
+export type UpdateTotpResponse = {
     enabled: boolean;
-}
+};

package/dist/types/UploadImageResponse.d.ts

@@ -0,0 +1,4 @@
+export type UploadImageResponse = {
+    image_url: string;
+    filename: string;
+};

package/dist/types/UploadImageResponse.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/{BlockInstance.d.ts → UserBlockInstanceParams.d.ts}

@@ -1,5 +1,8 @@
 import type { InstanceId } from "./InstanceId";
-export interface BlockInstance {
+/**
+ * Block an instance as user
+ */
+export type UserBlockInstanceParams = {
     instance_id: InstanceId;
     block: boolean;
-}
+};

package/dist/types/UserBlockInstanceParams.js

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

package/dist/types/VerifyEmail.d.ts

@@ -1,3 +1,6 @@
-export interface VerifyEmail {
+/**
+ * Verify your email.
+ */
+export type VerifyEmail = {
     token: string;
-}
+};

package/dist/types/VoteView.d.ts

@@ -1,6 +1,9 @@
 import type { Person } from "./Person";
-export interface VoteView {
+/**
+ * A vote view for checking a post or comments votes.
+ */
+export type VoteView = {
     creator: Person;
     creator_banned_from_community: boolean;
     score: number;
-}
+};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.20.0-alpha.7",
-  "author": "Dessalines <tyhou13@gmx.com>",
+  "version": "0.20.0-ap-id.0",
+  "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
   "files": [
@@ -12,17 +12,20 @@
     "build": "tsc",
     "docs": "typedoc src/index.ts",
     "lint": "tsc --noEmit && eslint --report-unused-disable-directives && prettier --check src",
-    "prepare": "pnpm run build && husky"
+    "prepare": "pnpm run build && husky",
+    "tsoa": "tsoa spec-and-routes && tsc && redocly build-docs tsoa_build/swagger.json"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/LemmyNet/lemmy-js-client.git"
   },
   "devDependencies": {
-    "@types/node": "^22.1.0",
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
-    "eslint": "^9.8.0",
+    "@redocly/cli": "^1.27.2",
+    "@types/joi": "^17.2.3",
+    "@types/node": "^22.7.4",
+    "@typescript-eslint/eslint-plugin": "^8.7.0",
+    "@typescript-eslint/parser": "^8.7.0",
+    "eslint": "^9.11.1",
     "eslint-plugin-prettier": "^5.2.1",
     "husky": "^9.1.4",
     "lint-staged": "^15.2.7",
@@ -31,11 +34,12 @@
     "prettier-plugin-organize-imports": "^4.0.0",
     "prettier-plugin-packagejson": "^2.5.1",
     "sortpack": "^2.4.0",
-    "typedoc": "^0.26.5",
+    "tsoa": "^6.6.0",
+    "typedoc": "^0.27.0",
     "typescript": "^5.5.4",
-    "typescript-eslint": "^8.0.0"
+    "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@9.9.0",
+  "packageManager": "pnpm@9.15.5",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/BlockInstanceResponse.d.ts

@@ -1,3 +0,0 @@
-export interface BlockInstanceResponse {
-    blocked: boolean;
-}

package/dist/types/CommentReplyResponse.d.ts

@@ -1,4 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-export interface CommentReplyResponse {
-    comment_reply_view: CommentReplyView;
-}

package/dist/types/GetPersonMentions.d.ts

@@ -1,7 +0,0 @@
-import type { CommentSortType } from "./CommentSortType";
-export interface GetPersonMentions {
-    sort?: CommentSortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
-}

package/dist/types/GetPersonMentionsResponse.d.ts

@@ -1,4 +0,0 @@
-import type { PersonMentionView } from "./PersonMentionView";
-export interface GetPersonMentionsResponse {
-    mentions: Array<PersonMentionView>;
-}

package/dist/types/GetPrivateMessages.d.ts

@@ -1,7 +0,0 @@
-import type { PersonId } from "./PersonId";
-export interface GetPrivateMessages {
-    unread_only?: boolean;
-    page?: number;
-    limit?: number;
-    creator_id?: PersonId;
-}