lemmy-js-client 1.0.0-post-tags.0 → 1.0.0-site-person-ban.0

package/dist/types/PersonPostMentionView.d.ts

@@ -1,32 +1,27 @@
 import type { Community } from "./Community";
+import type { CommunityActions } from "./CommunityActions";
 import type { ImageDetails } from "./ImageDetails";
+import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
+import type { PersonActions } from "./PersonActions";
 import type { PersonPostMention } from "./PersonPostMention";
 import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
-import type { PostTags } from "./PostTags";
-import type { SubscribedType } from "./SubscribedType";
+import type { PostActions } from "./PostActions";
 /**
  * A person post mention view.
  */
 export type PersonPostMentionView = {
     person_post_mention: PersonPostMention;
+    recipient: Person;
     post: Post;
     creator: Person;
     community: Community;
     image_details?: ImageDetails;
-    recipient: Person;
-    counts: PostAggregates;
-    creator_banned_from_community: boolean;
-    banned_from_community: boolean;
-    creator_is_moderator: boolean;
+    community_actions?: CommunityActions;
+    person_actions?: PersonActions;
+    post_actions?: PostActions;
+    instance_actions?: InstanceActions;
+    creator_community_actions?: CommunityActions;
     creator_is_admin: boolean;
-    subscribed: SubscribedType;
-    saved: boolean;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    post_tags: PostTags;
+    can_mod: boolean;
 };

package/dist/types/PersonSavedCombinedView.d.ts

@@ -0,0 +1,7 @@
+import type { CommentView } from "./CommentView";
+import type { PostView } from "./PostView";
+export type PersonSavedCombinedView = ({
+    type_: "Post";
+} & PostView) | ({
+    type_: "Comment";
+} & CommentView);

package/dist/types/PersonView.d.ts

@@ -1,10 +1,10 @@
+import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
-import type { PersonAggregates } from "./PersonAggregates";
 /**
  * A person view.
  */
 export type PersonView = {
     person: Person;
-    counts: PersonAggregates;
     is_admin: boolean;
+    instance_actions?: InstanceActions;
 };

package/dist/types/Post.d.ts

@@ -79,4 +79,14 @@ export type Post = {
      * Time at which the post will be published. None means publish immediately.
      */
     scheduled_publish_time?: string;
+    comments: number;
+    score: number;
+    upvotes: number;
+    downvotes: number;
+    /**
+     * The time of the newest comment in the post.
+     */
+    newest_comment_time: string;
+    report_count: number;
+    unresolved_report_count: number;
 };

package/dist/types/PostActions.d.ts

@@ -0,0 +1,35 @@
+import type { PersonId } from "./PersonId";
+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/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,9 +1,10 @@
 import type { Community } from "./Community";
+import type { CommunityActions } from "./CommunityActions";
 import type { Person } from "./Person";
+import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
+import type { PostActions } from "./PostActions";
 import type { PostReport } from "./PostReport";
-import type { SubscribedType } from "./SubscribedType";
 /**
  * A post report view.
  */
@@ -13,16 +14,10 @@ export type PostReportView = {
     community: Community;
     creator: Person;
     post_creator: Person;
-    creator_banned_from_community: boolean;
-    creator_is_moderator: boolean;
-    creator_is_admin: boolean;
-    subscribed: SubscribedType;
-    saved: boolean;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    counts: PostAggregates;
+    creator_community_actions?: CommunityActions;
+    community_actions?: CommunityActions;
+    post_actions?: PostActions;
+    person_actions?: PersonActions;
     resolver?: Person;
+    creator_is_admin: boolean;
 };

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

@@ -1,10 +1,11 @@
 import type { Community } from "./Community";
+import type { CommunityActions } from "./CommunityActions";
 import type { ImageDetails } from "./ImageDetails";
+import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
+import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
-import type { PostTags } from "./PostTags";
-import type { SubscribedType } from "./SubscribedType";
+import type { PostActions } from "./PostActions";
 /**
  * A post view.
  */
@@ -13,17 +14,11 @@ export type PostView = {
     creator: Person;
     community: Community;
     image_details?: ImageDetails;
-    creator_banned_from_community: boolean;
-    banned_from_community: boolean;
-    creator_is_moderator: boolean;
+    community_actions?: CommunityActions;
+    person_actions?: PersonActions;
+    post_actions?: PostActions;
+    instance_actions?: InstanceActions;
+    creator_community_actions?: CommunityActions;
     creator_is_admin: boolean;
-    counts: PostAggregates;
-    subscribed: SubscribedType;
-    saved: boolean;
-    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/PrivateMessageReportView.d.ts

@@ -7,7 +7,7 @@ import type { PrivateMessageReport } from "./PrivateMessageReport";
 export type PrivateMessageReportView = {
     private_message_report: PrivateMessageReport;
     private_message: PrivateMessage;
-    private_message_creator: Person;
     creator: Person;
+    private_message_creator: Person;
     resolver?: Person;
 };

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/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/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"
      */

package/dist/types/Search.d.ts

@@ -1,7 +1,7 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PersonId } from "./PersonId";
-import type { SearchCombinedPaginationCursor } from "./SearchCombinedPaginationCursor";
 import type { SearchSortType } from "./SearchSortType";
 import type { SearchType } from "./SearchType";
 /**
@@ -14,11 +14,16 @@ export type Search = {
     creator_id?: PersonId;
     type_?: SearchType;
     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;
     title_only?: boolean;
     post_url_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
-    page_cursor?: SearchCombinedPaginationCursor;
+    page_cursor?: PaginationCursor;
     page_back?: boolean;
 };

package/dist/types/SearchResponse.d.ts

@@ -1,7 +1,12 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { SearchCombinedView } from "./SearchCombinedView";
 /**
  * The search response, containing lists of the return type possibilities
  */
 export type SearchResponse = {
     results: Array<SearchCombinedView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
 };

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-post-tags.0",
+  "version": "1.0.0-site-person-ban.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -36,11 +36,11 @@
     "prettier-plugin-packagejson": "^2.5.1",
     "sortpack": "^2.4.0",
     "tsoa": "^6.6.0",
-    "typedoc": "^0.27.0",
+    "typedoc": "^0.28.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.2.1",
+  "packageManager": "pnpm@10.6.3",
   "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/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/CommunityTagResponse.d.ts

@@ -1,7 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-import type { TagId } from "./TagId";
-export type CommunityTagResponse = {
-    id: TagId;
-    name: string;
-    community_id: CommunityId;
-};

package/dist/types/CreateCommunityTag.d.ts

@@ -1,9 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-/**
- * Create a tag for a community.
- */
-export type CreateCommunityTag = {
-    community_id: CommunityId;
-    id_slug: string;
-    name: string;
-};

package/dist/types/DeleteCommunityTag.d.ts

@@ -1,7 +0,0 @@
-import type { TagId } from "./TagId";
-/**
- * Delete a community tag.
- */
-export type DeleteCommunityTag = {
-    tag_id: TagId;
-};

package/dist/types/InboxCombinedPaginationCursor.d.ts

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

package/dist/types/ListCommunityTags.d.ts

@@ -1,7 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-/**
- * List tags for a community.
- */
-export type ListCommunityTags = {
-    community_id: CommunityId;
-};

package/dist/types/ListCommunityTagsResponse.d.ts

@@ -1,4 +0,0 @@
-import type { CommunityTagResponse } from "./CommunityTagResponse";
-export type ListCommunityTagsResponse = {
-    tags: Array<CommunityTagResponse>;
-};

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

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

package/dist/types/PersonSavedCombinedPaginationCursor.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/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/PostTags.d.ts

@@ -1,5 +0,0 @@
-import type { Tag } from "./Tag";
-/**
- * we wrap this in a struct so we can implement FromSqlRow<Json> for it
- */
-export type PostTags = Array<Tag>;

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

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

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

package/dist/types/UpdateCommunityTag.d.ts

@@ -1,8 +0,0 @@
-import type { TagId } from "./TagId";
-/**
- * Update a community tag.
- */
-export type UpdateCommunityTag = {
-    tag_id: TagId;
-    name: string;
-};