lemmy-js-client 1.0.0-action-structs.1 → 1.0.0-alpha.1

package/dist/types/ListPersonContent.d.ts

@@ -15,4 +15,5 @@ export type ListPersonContent = {
     username?: string;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/ListPersonContentResponse.d.ts

@@ -9,4 +9,5 @@ export type ListPersonContentResponse = {
      * the pagination cursor to use to fetch the next page
      */
     next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/ListPersonSaved.d.ts

@@ -7,4 +7,5 @@ export type ListPersonSaved = {
     type_?: PersonContentType;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/ListPersonSavedResponse.d.ts

@@ -9,4 +9,5 @@ export type ListPersonSavedResponse = {
      * the pagination cursor to use to fetch the next page
      */
     next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/ListPostLikes.d.ts

@@ -1,9 +1,11 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PostId } from "./PostId";
 /**
  * List post likes. Admins-only.
  */
 export type ListPostLikes = {
     post_id: PostId;
-    page?: number;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPostLikesResponse.d.ts

@@ -1,7 +1,13 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { VoteView } from "./VoteView";
 /**
  * The post likes response
  */
 export type ListPostLikesResponse = {
     post_likes: Array<VoteView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/ListRegistrationApplications.d.ts

@@ -1,3 +1,4 @@
+import type { PaginationCursor } from "./PaginationCursor";
 /**
  * Fetches a list of registration applications.
  */
@@ -6,6 +7,7 @@ export type ListRegistrationApplications = {
      * Only shows the unread applications (IE those without an admin actor)
      */
     unread_only?: boolean;
-    page?: number;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListRegistrationApplications.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/ListRegistrationApplicationsResponse.d.ts

@@ -1,7 +1,13 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { RegistrationApplicationView } from "./RegistrationApplicationView";
 /**
  * The list of registration applications.
  */
 export type ListRegistrationApplicationsResponse = {
     registration_applications: Array<RegistrationApplicationView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/ListReports.d.ts

@@ -24,6 +24,7 @@ export type ListReports = {
     community_id?: CommunityId;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
     /**
      * Only for admins: also show reports with `violates_instance_rules=false`
      */

package/dist/types/ListReportsResponse.d.ts

@@ -9,4 +9,5 @@ export type ListReportsResponse = {
      * the pagination cursor to use to fetch the next page
      */
     next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/ListTaglines.d.ts

@@ -1,7 +1,9 @@
+import type { PaginationCursor } from "./PaginationCursor";
 /**
  * Fetches a list of taglines.
  */
 export type ListTaglines = {
-    page?: number;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListTaglines.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/ListTaglinesResponse.d.ts

@@ -1,7 +1,13 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { Tagline } from "./Tagline";
 /**
  * A response for taglines.
  */
 export type ListTaglinesResponse = {
     taglines: Array<Tagline>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/LocalSite.d.ts

@@ -113,11 +113,6 @@ export type LocalSite = {
      * What kind of comment downvotes your site allows.
      */
     comment_downvotes: FederationMode;
-    /**
-     * If this is true, users will never see the dialog asking to support Lemmy development with
-     * donations.
-     */
-    disable_donation_dialog: boolean;
     /**
      * A default time range limit to apply to post sorts, in seconds.
      */
@@ -146,4 +141,8 @@ export type LocalSite = {
      * The number of users with any activity in the last half year.
      */
     users_active_half_year: number;
+    /**
+     * Dont send email notifications to users for new replies, mentions etc
+     */
+    disable_email_notifications: boolean;
 };

package/dist/types/LocalUserView.d.ts

@@ -1,3 +1,4 @@
+import type { InstanceActions } from "./InstanceActions";
 import type { LocalUser } from "./LocalUser";
 import type { Person } from "./Person";
 /**
@@ -6,4 +7,5 @@ import type { Person } from "./Person";
 export type LocalUserView = {
     local_user: LocalUser;
     person: Person;
+    instance_actions?: InstanceActions;
 };

package/dist/types/ModBan.d.ts

@@ -1,3 +1,4 @@
+import type { InstanceId } from "./InstanceId";
 import type { ModBanId } from "./ModBanId";
 import type { PersonId } from "./PersonId";
 /**
@@ -11,4 +12,5 @@ export type ModBan = {
     banned: boolean;
     expires?: string;
     published: string;
+    instance_id: InstanceId;
 };

package/dist/types/MyUserInfo.d.ts

@@ -15,5 +15,6 @@ export type MyUserInfo = {
     community_blocks: Array<Community>;
     instance_blocks: Array<Instance>;
     person_blocks: Array<Person>;
+    keyword_blocks: Array<string>;
     discussion_languages: Array<LanguageId>;
 };

package/dist/types/Person.d.ts

@@ -15,10 +15,6 @@ export type Person = {
      * A URL for an avatar.
      */
     avatar?: DbUrl;
-    /**
-     * Whether the person is banned.
-     */
-    banned: boolean;
     published: string;
     updated?: string;
     /**
@@ -49,10 +45,6 @@ export type Person = {
      * Whether the person is a bot account.
      */
     bot_account: boolean;
-    /**
-     * When their ban, if it exists, expires, if at all.
-     */
-    ban_expires?: string;
     instance_id: InstanceId;
     post_count: number;
     comment_count: number;

package/dist/types/PersonCommentMentionView.d.ts

@@ -21,7 +21,10 @@ export type PersonCommentMentionView = {
     comment_actions?: CommentActions;
     person_actions?: PersonActions;
     instance_actions?: InstanceActions;
+    creator_home_instance_actions?: InstanceActions;
+    creator_local_instance_actions?: InstanceActions;
     creator_community_actions?: CommunityActions;
     creator_is_admin: boolean;
     can_mod: boolean;
+    creator_banned: boolean;
 };

package/dist/types/PersonPostMentionView.d.ts

@@ -7,6 +7,7 @@ import type { PersonActions } from "./PersonActions";
 import type { PersonPostMention } from "./PersonPostMention";
 import type { Post } from "./Post";
 import type { PostActions } from "./PostActions";
+import type { TagsView } from "./TagsView";
 /**
  * A person post mention view.
  */
@@ -21,7 +22,11 @@ export type PersonPostMentionView = {
     person_actions?: PersonActions;
     post_actions?: PostActions;
     instance_actions?: InstanceActions;
+    creator_home_instance_actions?: InstanceActions;
+    creator_local_instance_actions?: InstanceActions;
     creator_community_actions?: CommunityActions;
+    post_tags: TagsView;
     creator_is_admin: boolean;
     can_mod: boolean;
+    creator_banned: boolean;
 };

package/dist/types/PersonView.d.ts

@@ -1,3 +1,4 @@
+import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
 /**
  * A person view.
@@ -5,4 +6,7 @@ import type { Person } from "./Person";
 export type PersonView = {
     person: Person;
     is_admin: boolean;
+    home_instance_actions?: InstanceActions;
+    local_instance_actions?: InstanceActions;
+    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

@@ -89,4 +89,9 @@ export type Post = {
     newest_comment_time: 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/PostView.d.ts

@@ -6,6 +6,7 @@ import type { Person } from "./Person";
 import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
 import type { PostActions } from "./PostActions";
+import type { TagsView } from "./TagsView";
 /**
  * A post view.
  */
@@ -18,7 +19,11 @@ export type PostView = {
     person_actions?: PersonActions;
     post_actions?: PostActions;
     instance_actions?: InstanceActions;
+    creator_home_instance_actions?: InstanceActions;
+    creator_local_instance_actions?: InstanceActions;
     creator_community_actions?: CommunityActions;
     creator_is_admin: boolean;
+    tags: TagsView;
     can_mod: boolean;
+    creator_banned: boolean;
 };

package/dist/types/SaveUserSettings.d.ts

@@ -84,6 +84,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
      */

package/dist/types/Search.d.ts

@@ -26,4 +26,5 @@ export type Search = {
     disliked_only?: boolean;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/SearchResponse.d.ts

@@ -9,4 +9,5 @@ export type SearchResponse = {
      * the pagination cursor to use to fetch the next page
      */
     next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/SiteView.d.ts

@@ -1,3 +1,4 @@
+import type { Instance } from "./Instance";
 import type { LocalSite } from "./LocalSite";
 import type { LocalSiteRateLimit } from "./LocalSiteRateLimit";
 import type { Site } from "./Site";
@@ -8,4 +9,5 @@ export type SiteView = {
     site: Site;
     local_site: LocalSite;
     local_site_rate_limit: LocalSiteRateLimit;
+    instance: Instance;
 };

package/dist/types/Tag.d.ts

@@ -7,16 +7,18 @@ 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
      */

package/dist/types/Tagline.d.ts

@@ -1,8 +1,9 @@
+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;

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

@@ -0,0 +1,5 @@
+import type { Tag } from "./Tag";
+/**
+ * we wrap this in a struct so we can implement FromSqlRow<Json> for it
+ */
+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/VoteView.d.ts

@@ -4,6 +4,7 @@ import type { Person } from "./Person";
  */
 export type VoteView = {
     creator: Person;
+    item_id: number;
     creator_banned_from_community: boolean;
     score: number;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-action-structs.1",
+  "version": "1.0.0-alpha.1",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -19,6 +19,9 @@
     "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",
@@ -36,11 +39,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.6.1",
+  "packageManager": "pnpm@10.8.0",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/PostPaginationCursor.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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;