lemmy-js-client 0.20.0-modlog-combined.1 → 0.20.0-move-community-hidden.1

package/dist/types/PostPaginationCursor.d.ts

@@ -0,0 +1,7 @@
+/**
+ * currently this is just a wrapper around post id, but should be seen as opaque from the client's
+ * perspective. stringified since we might want to use arbitrary info later, with a P prepended to
+ * prevent ossification (api users love to make assumptions (e.g. parse stuff that looks like
+ * numbers as numbers) about apis that aren't part of the spec
+ */
+export type PostPaginationCursor = string;

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

@@ -1,7 +1,6 @@
 import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
 import type { PostReport } from "./PostReport";
 import type { SubscribedType } from "./SubscribedType";
 /**
@@ -17,12 +16,14 @@ 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;
     my_vote?: number;
     unread_comments: number;
-    counts: PostAggregates;
     resolver?: Person;
 };

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

@@ -2,7 +2,6 @@ import type { Community } from "./Community";
 import type { ImageDetails } from "./ImageDetails";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
 import type { PostTags } from "./PostTags";
 import type { SubscribedType } from "./SubscribedType";
 /**
@@ -17,13 +16,16 @@ export type PostView = {
     banned_from_community: boolean;
     creator_is_moderator: boolean;
     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/ReportType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A list of possible types for reports.
+ */
+export type ReportType = "All" | "Posts" | "Comments" | "PrivateMessages" | "Communities";

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/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"
      */
@@ -116,4 +120,8 @@ export type SaveUserSettings = {
      * 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,23 +1,29 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PersonId } from "./PersonId";
-import type { PostSortType } from "./PostSortType";
+import type { SearchSortType } from "./SearchSortType";
 import type { SearchType } from "./SearchType";
 /**
- * Searches the site, given a query string, and some optional filters.
+ * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
-    q: string;
+    search_term?: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
     type_?: SearchType;
-    sort?: PostSortType;
+    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;
-    page?: number;
-    limit?: number;
     title_only?: boolean;
     post_url_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
 };

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/SearchResponse.d.ts

@@ -1,15 +1,12 @@
-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";
+import type { PaginationCursor } from "./PaginationCursor";
+import type { SearchCombinedView } from "./SearchCombinedView";
 /**
  * The search response, containing lists of the return type possibilities
  */
 export type SearchResponse = {
-    type_: SearchType;
-    comments: Array<CommentView>;
-    posts: Array<PostView>;
-    communities: Array<CommunityView>;
-    users: Array<PersonView>;
+    results: Array<SearchCombinedView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
 };

package/dist/types/SearchSortType.d.ts

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

package/dist/types/Site.d.ts

@@ -26,9 +26,9 @@ export type Site = {
      */
     description?: string;
     /**
-     * The federated actor_id.
+     * The federated ap_id.
      */
-    actor_id: DbUrl;
+    ap_id: DbUrl;
     /**
      * The time the site was last refreshed.
      */

package/dist/types/SiteView.d.ts

@@ -1,7 +1,6 @@
 import type { LocalSite } from "./LocalSite";
 import type { LocalSiteRateLimit } from "./LocalSiteRateLimit";
 import type { Site } from "./Site";
-import type { SiteAggregates } from "./SiteAggregates";
 /**
  * A site view.
  */
@@ -9,5 +8,4 @@ export type SiteView = {
     site: Site;
     local_site: LocalSite;
     local_site_rate_limit: LocalSiteRateLimit;
-    counts: SiteAggregates;
 };

package/dist/types/SuccessResponse.d.ts

@@ -1,5 +1,5 @@
 /**
- * Saves settings for your user.
+ * A response that completes successfully.
  */
 export type SuccessResponse = {
     success: boolean;

package/dist/types/UploadImageResponse.d.ts

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

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.20.0-modlog-combined.1",
-  "author": "Dessalines <tyhou13@gmx.com>",
+  "version": "0.20.0-move-community-hidden.1",
+  "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
   "files": [
@@ -12,13 +12,17 @@
     "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": {
+    "@eslint/js": "^9.20.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",
@@ -31,11 +35,12 @@
     "prettier-plugin-organize-imports": "^4.0.0",
     "prettier-plugin-packagejson": "^2.5.1",
     "sortpack": "^2.4.0",
+    "tsoa": "^6.6.0",
     "typedoc": "^0.27.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@9.15.3",
+  "packageManager": "pnpm@10.6.1",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/CommentAggregates.d.ts

@@ -1,17 +0,0 @@
-import type { CommentId } from "./CommentId";
-/**
- * Aggregate data for a comment.
- */
-export type CommentAggregates = {
-    comment_id: CommentId;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    published: string;
-    /**
-     * The total number of children in this comment branch.
-     */
-    child_count: number;
-    report_count: number;
-    unresolved_report_count: number;
-};

package/dist/types/CommentReplyResponse.d.ts

@@ -1,7 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-/**
- * The response for a comment reply action.
- */
-export type CommentReplyResponse = {
-    comment_reply_view: CommentReplyView;
-};

package/dist/types/CommunityAggregates.d.ts

@@ -1,30 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-/**
- * Aggregate data for a community.
- */
-export type CommunityAggregates = {
-    community_id: CommunityId;
-    subscribers: number;
-    posts: number;
-    comments: number;
-    published: string;
-    /**
-     * 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 year.
-     */
-    users_active_half_year: number;
-    subscribers_local: number;
-    report_count: number;
-    unresolved_report_count: number;
-};

package/dist/types/GetPersonMentions.d.ts

@@ -1,10 +0,0 @@
-import type { CommentSortType } from "./CommentSortType";
-/**
- * Get mentions for your user.
- */
-export type GetPersonMentions = {
-    sort?: CommentSortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
-};

package/dist/types/GetPersonMentionsResponse.d.ts

@@ -1,7 +0,0 @@
-import type { PersonMentionView } from "./PersonMentionView";
-/**
- * The response of mentions for your user.
- */
-export type GetPersonMentionsResponse = {
-    mentions: Array<PersonMentionView>;
-};

package/dist/types/GetPrivateMessages.d.ts

@@ -1,10 +0,0 @@
-import type { PersonId } from "./PersonId";
-/**
- * Get your private messages.
- */
-export type GetPrivateMessages = {
-    unread_only?: boolean;
-    page?: number;
-    limit?: number;
-    creator_id?: PersonId;
-};

package/dist/types/GetReplies.d.ts

@@ -1,10 +0,0 @@
-import type { CommentSortType } from "./CommentSortType";
-/**
- * Get comment replies.
- */
-export type GetReplies = {
-    sort?: CommentSortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
-};

package/dist/types/GetRepliesResponse.d.ts

@@ -1,7 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-/**
- * Fetches your replies.
- */
-export type GetRepliesResponse = {
-    replies: Array<CommentReplyView>;
-};

package/dist/types/LocalUserVoteDisplayMode.d.ts

@@ -1,9 +0,0 @@
-/**
- * The vote display settings for your user.
- */
-export type LocalUserVoteDisplayMode = {
-    score: boolean;
-    upvotes: boolean;
-    downvotes: boolean;
-    upvote_percentage: boolean;
-};

package/dist/types/MarkPersonMentionAsRead.d.ts

@@ -1,8 +0,0 @@
-import type { PersonMentionId } from "./PersonMentionId";
-/**
- * Mark a person mention as read.
- */
-export type MarkPersonMentionAsRead = {
-    person_mention_id: PersonMentionId;
-    read: boolean;
-};

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/ModlogCombinedPaginationCursor.d.ts

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

package/dist/types/PersonAggregates.d.ts

@@ -1,9 +0,0 @@
-import type { PersonId } from "./PersonId";
-/**
- * Aggregate data for a person.
- */
-export type PersonAggregates = {
-    person_id: PersonId;
-    post_count: number;
-    comment_count: number;
-};

package/dist/types/PersonContentCombinedPaginationCursor.d.ts

@@ -1,4 +0,0 @@
-/**
- * like PaginationCursor but for the person_content_combined table
- */
-export type PersonContentCombinedPaginationCursor = string;

package/dist/types/PersonMentionId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The person mention id.
- */
-export type PersonMentionId = number;

package/dist/types/PersonMentionResponse.d.ts

@@ -1,7 +0,0 @@
-import type { PersonMentionView } from "./PersonMentionView";
-/**
- * The response for a person mention action.
- */
-export type PersonMentionResponse = {
-    person_mention_view: PersonMentionView;
-};

package/dist/types/PersonSavedCombinedPaginationCursor.d.ts

@@ -1,4 +0,0 @@
-/**
- * like PaginationCursor but for the person_saved_combined table
- */
-export type PersonSavedCombinedPaginationCursor = string;

package/dist/types/PostAggregates.d.ts

@@ -1,18 +0,0 @@
-import type { PostId } from "./PostId";
-/**
- * Aggregate data for a post.
- */
-export type PostAggregates = {
-    post_id: PostId;
-    comments: number;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    published: string;
-    /**
-     * The time of the newest comment in the post.
-     */
-    newest_comment_time: string;
-    report_count: number;
-    unresolved_report_count: number;
-};

package/dist/types/PrivateMessagesResponse.d.ts

@@ -1,7 +0,0 @@
-import type { PrivateMessageView } from "./PrivateMessageView";
-/**
- * The private messages response.
- */
-export type PrivateMessagesResponse = {
-    private_messages: Array<PrivateMessageView>;
-};

package/dist/types/PrivateMessagesResponse.js

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

package/dist/types/ReportCombinedPaginationCursor.d.ts

@@ -1,4 +0,0 @@
-/**
- * like PaginationCursor but for the report_combined table
- */
-export type ReportCombinedPaginationCursor = string;

package/dist/types/SiteAggregates.d.ts

@@ -1,27 +0,0 @@
-import type { SiteId } from "./SiteId";
-/**
- * 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/SiteAggregates.js

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