lemmy-js-client 0.20.0-private-community.9 → 0.20.0-remove-aggregate-tables.1

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,5 +1,11 @@
 import type { SiteView } from "./SiteView";
-export interface SiteResponse {
+/**
+ * The response for a site.
+ */
+export type SiteResponse = {
     site_view: SiteView;
+    /**
+     * 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 @@
+/**
+ * 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,6 +1,9 @@
-export interface Tagline {
+/**
+ * A tagline, shown at the top of your site.
+ */
+export type Tagline = {
     id: number;
     content: string;
     published: string;
     updated?: string;
-}
+};

package/dist/types/TaglineId.d.ts

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

package/dist/types/TaglineResponse.d.ts

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

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

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

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-private-community.9",
-  "author": "Dessalines <tyhou13@gmx.com>",
+  "version": "0.20.0-remove-aggregate-tables.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",
-    "typedoc": "^0.26.5",
+    "tsoa": "^6.6.0",
+    "typedoc": "^0.27.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@9.12.3",
+  "packageManager": "pnpm@10.2.1",
   "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/CommentAggregates.d.ts

@@ -1,9 +0,0 @@
-import type { CommentId } from "./CommentId";
-export interface CommentAggregates {
-    comment_id: CommentId;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    published: string;
-    child_count: number;
-}

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

@@ -1,13 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-export interface CommunityAggregates {
-    community_id: CommunityId;
-    subscribers: number;
-    posts: number;
-    comments: number;
-    published: string;
-    users_active_day: number;
-    users_active_week: number;
-    users_active_month: number;
-    users_active_half_year: number;
-    subscribers_local: number;
-}

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

package/dist/types/GetReplies.d.ts

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

package/dist/types/GetRepliesResponse.d.ts

@@ -1,4 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-export interface GetRepliesResponse {
-    replies: Array<CommentReplyView>;
-}

package/dist/types/ListCommentReports.d.ts

@@ -1,9 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { CommunityId } from "./CommunityId";
-export interface ListCommentReports {
-    comment_id?: CommentId;
-    page?: number;
-    limit?: number;
-    unresolved_only?: boolean;
-    community_id?: CommunityId;
-}

package/dist/types/ListCommentReportsResponse.d.ts

@@ -1,4 +0,0 @@
-import type { CommentReportView } from "./CommentReportView";
-export interface ListCommentReportsResponse {
-    comment_reports: Array<CommentReportView>;
-}

package/dist/types/ListPostReports.d.ts

@@ -1,9 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-import type { PostId } from "./PostId";
-export interface ListPostReports {
-    page?: number;
-    limit?: number;
-    unresolved_only?: boolean;
-    community_id?: CommunityId;
-    post_id?: PostId;
-}

package/dist/types/ListPostReportsResponse.d.ts

@@ -1,4 +0,0 @@
-import type { PostReportView } from "./PostReportView";
-export interface ListPostReportsResponse {
-    post_reports: Array<PostReportView>;
-}

package/dist/types/ListPrivateMessageReports.d.ts

@@ -1,5 +0,0 @@
-export interface ListPrivateMessageReports {
-    page?: number;
-    limit?: number;
-    unresolved_only?: boolean;
-}

package/dist/types/ListPrivateMessageReportsResponse.d.ts

@@ -1,4 +0,0 @@
-import type { PrivateMessageReportView } from "./PrivateMessageReportView";
-export interface ListPrivateMessageReportsResponse {
-    private_message_reports: Array<PrivateMessageReportView>;
-}

package/dist/types/MarkPersonMentionAsRead.d.ts

@@ -1,5 +0,0 @@
-import type { PersonMentionId } from "./PersonMentionId";
-export interface MarkPersonMentionAsRead {
-    person_mention_id: PersonMentionId;
-    read: boolean;
-}

package/dist/types/ModlogListParams.d.ts

@@ -1,14 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { CommunityId } from "./CommunityId";
-import type { PersonId } from "./PersonId";
-import type { PostId } from "./PostId";
-export interface ModlogListParams {
-    community_id?: CommunityId;
-    mod_person_id?: PersonId;
-    other_person_id?: PersonId;
-    post_id?: PostId;
-    comment_id?: CommentId;
-    page?: number;
-    limit?: number;
-    hide_modlog_names: boolean;
-}

package/dist/types/PersonAggregates.d.ts

@@ -1,6 +0,0 @@
-import type { PersonId } from "./PersonId";
-export interface PersonAggregates {
-    person_id: PersonId;
-    post_count: number;
-    comment_count: number;
-}

package/dist/types/PersonMentionId.d.ts

@@ -1 +0,0 @@
-export type PersonMentionId = number;

package/dist/types/PersonMentionResponse.d.ts

@@ -1,4 +0,0 @@
-import type { PersonMentionView } from "./PersonMentionView";
-export interface PersonMentionResponse {
-    person_mention_view: PersonMentionView;
-}

package/dist/types/PostAggregates.d.ts

@@ -1,10 +0,0 @@
-import type { PostId } from "./PostId";
-export interface PostAggregates {
-    post_id: PostId;
-    comments: number;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    published: string;
-    newest_comment_time: string;
-}

package/dist/types/PrivateMessagesResponse.d.ts

@@ -1,4 +0,0 @@
-import type { PrivateMessageView } from "./PrivateMessageView";
-export interface PrivateMessagesResponse {
-    private_messages: Array<PrivateMessageView>;
-}