lemmy-js-client 1.0.0-block-nsfw.1 → 1.0.0-creator-banned.0

package/dist/types/PersonPostMentionView.d.ts

@@ -1,36 +1,31 @@
 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";
+import type { TagsView } from "./TagsView";
 /**
  * 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;
+    post_tags: TagsView;
     creator_is_admin: boolean;
-    subscribed: SubscribedType;
-    /**
-     * The time when the post was saved.
-     */
-    saved?: string;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    post_tags: PostTags;
     can_mod: boolean;
+    creator_banned: boolean;
+    creator_is_moderator: boolean;
+    creator_banned_from_community: 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/PersonSavedCombinedView.js

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

package/dist/types/PersonView.d.ts

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

package/dist/types/PluginMetadata.d.ts

@@ -0,0 +1,5 @@
+export type PluginMetadata = {
+    name: string;
+    url: string;
+    description: string;
+};

package/dist/types/Post.d.ts

@@ -27,8 +27,8 @@ export type Post = {
      * Whether the post is locked.
      */
     locked: boolean;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     /**
      * Whether the post is deleted.
      */
@@ -78,5 +78,20 @@ export type Post = {
     /**
      * Time at which the post will be published. None means publish immediately.
      */
-    scheduled_publish_time?: string;
+    scheduled_publish_time_at?: string;
+    comments: number;
+    score: number;
+    upvotes: number;
+    downvotes: number;
+    /**
+     * The time of the newest comment in the post.
+     */
+    newest_comment_time_at: string;
+    report_count: number;
+    unresolved_report_count: number;
+    /**
+     * If a local user posts in a remote community, the comment is hidden until it is confirmed
+     * accepted by the community (by receiving it back via federation).
+     */
+    federation_pending: boolean;
 };

package/dist/types/PostActions.d.ts

@@ -0,0 +1,31 @@
+export type PostActions = {
+    /**
+     * When the post was read.
+     */
+    read_at?: string;
+    /**
+     * When was the last time you read the comments.
+     */
+    read_comments_at?: 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_at?: string;
+    /**
+     * When the post was liked.
+     */
+    liked_at?: string;
+    /**
+     * The like / score of the post.
+     */
+    like_score?: number;
+    /**
+     * When the post was hidden.
+     */
+    hidden_at?: string;
+};

package/dist/types/PostReport.d.ts

@@ -24,7 +24,7 @@ export type PostReport = {
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: 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,19 +14,9 @@ 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;
-    /**
-     * The time when the post was saved.
-     */
-    saved?: string;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    counts: PostAggregates;
+    community_actions?: CommunityActions;
+    post_actions?: PostActions;
+    person_actions?: PersonActions;
     resolver?: Person;
+    creator_is_admin: boolean;
 };

package/dist/types/PostView.d.ts

@@ -1,10 +1,12 @@
 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";
+import type { TagsView } from "./TagsView";
 /**
  * A post view.
  */
@@ -13,21 +15,14 @@ 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_is_admin: boolean;
-    counts: PostAggregates;
-    subscribed: SubscribedType;
-    /**
-     * The time when the post was saved.
-     */
-    saved?: string;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    tags: PostTags;
+    tags: TagsView;
     can_mod: boolean;
+    creator_banned: boolean;
+    creator_is_moderator: boolean;
+    creator_banned_from_community: boolean;
 };

package/dist/types/PrivateMessage.d.ts

@@ -11,8 +11,8 @@ export type PrivateMessage = {
     content: string;
     deleted: boolean;
     read: boolean;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     ap_id: DbUrl;
     local: boolean;
     removed: boolean;

package/dist/types/PrivateMessageReport.d.ts

@@ -15,6 +15,6 @@ export type PrivateMessageReport = {
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
 };

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

@@ -10,7 +10,7 @@ export type ReadableFederationState = {
      * the last successfully sent activity id
      */
     last_successful_id?: ActivityId;
-    last_successful_published_time?: string;
+    last_successful_published_time_at?: string;
     /**
      * how many failed attempts have been made to send the next activity
      */
@@ -18,5 +18,5 @@ export type ReadableFederationState = {
     /**
      * timestamp of the last retry attempt (when the last failing activity was resent)
      */
-    last_retry?: string;
+    last_retry_at?: string;
 };

package/dist/types/RegistrationApplication.d.ts

@@ -10,5 +10,5 @@ export type RegistrationApplication = {
     answer: string;
     admin_id?: PersonId;
     deny_reason?: string;
-    published: string;
+    published_at: string;
 };

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/ResolveCommunityReport.js

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

package/dist/types/SaveUserSettings.d.ts

@@ -4,6 +4,7 @@ import type { ListingType } from "./ListingType";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { SensitiveString } from "./SensitiveString";
+import type { VoteShow } from "./VoteShow";
 /**
  * Saves settings for your user.
  */
@@ -84,6 +85,7 @@ export type SaveUserSettings = {
      * A list of languages you are able to see discussion in.
      */
     discussion_languages?: Array<LanguageId>;
+    blocking_keywords?: Array<string>;
     /**
      * Open links in a new tab
      */
@@ -114,7 +116,7 @@ export type SaveUserSettings = {
      */
     show_scores?: boolean;
     show_upvotes?: boolean;
-    show_downvotes?: boolean;
+    show_downvotes?: VoteShow;
     show_upvote_percentage?: boolean;
     /**
      * Whether to automatically mark fetched posts as read.

package/dist/types/Search.d.ts

@@ -1,14 +1,14 @@
 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";
 /**
  * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
-    search_term?: string;
+    q: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
@@ -24,6 +24,11 @@ export type Search = {
     post_url_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
-    page_cursor?: SearchCombinedPaginationCursor;
+    /**
+     * If true, then show the nsfw posts (even if your user setting is to hide them)
+     */
+    show_nsfw?: boolean;
+    page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/SearchCombinedView.d.ts

@@ -1,5 +1,6 @@
 import type { CommentView } from "./CommentView";
 import type { CommunityView } from "./CommunityView";
+import type { MultiCommunityView } from "./MultiCommunityView";
 import type { PersonView } from "./PersonView";
 import type { PostView } from "./PostView";
 export type SearchCombinedView = ({
@@ -10,4 +11,6 @@ export type SearchCombinedView = ({
     type_: "Community";
 } & CommunityView) | ({
     type_: "Person";
-} & PersonView);
+} & PersonView) | ({
+    type_: "MultiCommunity";
+} & MultiCommunityView);

package/dist/types/SearchResponse.d.ts

@@ -1,7 +1,13 @@
+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;
+    prev_page?: PaginationCursor;
 };

package/dist/types/SearchType.d.ts

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

package/dist/types/Site.d.ts

@@ -2,7 +2,8 @@ import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
 import type { SiteId } from "./SiteId";
 /**
- * The site.
+ * Additional data for federated instances. This may be missing for other platforms which are not
+ * fully compatible. Basic data is guaranteed to be available via [[Instance]].
  */
 export type Site = {
     id: SiteId;
@@ -11,8 +12,8 @@ export type Site = {
      * A sidebar for the site in markdown.
      */
     sidebar?: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     /**
      * An icon URL.
      */

package/dist/types/SiteResponse.d.ts

@@ -4,8 +4,4 @@ import type { SiteView } from "./SiteView";
  */
 export type SiteResponse = {
     site_view: SiteView;
-    /**
-     * deprecated, use field `tagline` or /api/v4/tagline/list
-     */
-    taglines: Array<null>;
 };

package/dist/types/SiteView.d.ts

@@ -1,7 +1,7 @@
+import type { Instance } from "./Instance";
 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 +9,5 @@ export type SiteView = {
     site: Site;
     local_site: LocalSite;
     local_site_rate_limit: LocalSiteRateLimit;
-    counts: SiteAggregates;
+    instance: Instance;
 };

package/dist/types/Tag.d.ts

@@ -7,21 +7,23 @@ import type { TagId } from "./TagId";
  * 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.
+ * displayed and filtered on. Currently, we only have community post tags, which is a tag that is
+ * created by the mods of a community, then assigned to posts 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;
+    display_name: string;
     /**
      * the community that owns this tag
      */
     community_id: CommunityId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     deleted: boolean;
 };

package/dist/types/Tagline.d.ts

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

package/dist/types/Tagline.js

@@ -1,3 +1,2 @@
 "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/{PostTags.d.ts → TagsView.d.ts}

@@ -2,6 +2,4 @@ import type { Tag } from "./Tag";
 /**
  * we wrap this in a struct so we can implement FromSqlRow<Json> for it
  */
-export type PostTags = {
-    tags: Array<Tag>;
-};
+export type TagsView = Array<Tag>;

package/dist/types/TagsView.js

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

package/dist/types/UpdateCommunityTag.d.ts

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

package/dist/types/UpdateCommunityTag.js

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

package/dist/types/UpdateMultiCommunity.d.ts

@@ -0,0 +1,7 @@
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type UpdateMultiCommunity = {
+    id: MultiCommunityId;
+    title?: string;
+    description?: string;
+    deleted?: boolean;
+};

package/dist/types/UpdateMultiCommunity.js

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

package/dist/types/VoteShow.d.ts

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

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

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-block-nsfw.1",
+  "version": "1.0.0-creator-banned.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -19,28 +19,31 @@
     "type": "git",
     "url": "git+https://github.com/LemmyNet/lemmy-js-client.git"
   },
+  "dependencies": {
+    "@tsoa/runtime": "^6.6.0"
+  },
   "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",
     "eslint": "^9.11.1",
     "eslint-plugin-prettier": "^5.2.1",
     "husky": "^9.1.4",
-    "lint-staged": "^15.2.7",
+    "joi": "^17.13.3",
+    "lint-staged": "^16.0.0",
     "prettier": "^3.3.3",
     "prettier-plugin-import-sort": "^0.0.7",
     "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",
+    "typedoc": "^0.28.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.4.0",
+  "packageManager": "pnpm@10.12.4",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/BannedPersonsResponse.d.ts

@@ -1,7 +0,0 @@
-import type { PersonView } from "./PersonView";
-/**
- * The list of banned persons.
- */
-export type BannedPersonsResponse = {
-    banned: Array<PersonView>;
-};

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;
-};