lemmy-js-client 0.20.0-reports-combined.3 → 0.20.0-show-mod-reports.0

package/dist/types/SearchResponse.d.ts

@@ -1,15 +1,7 @@
-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 { 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>;
 };

package/dist/types/SearchSortType.d.ts

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

package/dist/types/SearchSortType.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/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/SiteResponse.d.ts

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

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

@@ -1,8 +1,8 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.20.0-reports-combined.3",
-  "author": "Dessalines <tyhou13@gmx.com>",
+  "version": "0.20.0-show-mod-reports.0",
+  "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
   "files": [
@@ -12,13 +12,16 @@
     "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": {
+    "@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 +34,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.0",
+  "packageManager": "pnpm@9.15.5",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

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

@@ -1,17 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { CommunityId } from "./CommunityId";
-import type { PersonId } from "./PersonId";
-import type { PostId } from "./PostId";
-/**
- * Querying / filtering the modlog.
- */
-export type 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/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/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/ReportCombined.d.ts

@@ -1,14 +0,0 @@
-import type { CommentReportId } from "./CommentReportId";
-import type { PostReportId } from "./PostReportId";
-import type { PrivateMessageReportId } from "./PrivateMessageReportId";
-import type { ReportCombinedId } from "./ReportCombinedId";
-/**
- * A combined reports table.
- */
-export type ReportCombined = {
-    id: ReportCombinedId;
-    published: string;
-    post_report_id?: PostReportId;
-    comment_report_id?: CommentReportId;
-    private_message_report_id?: PrivateMessageReportId;
-};

package/dist/types/ReportCombinedId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The report combined id
- */
-export type ReportCombinedId = number;