lemmy-js-client 0.17.2 → 0.18.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemmy-js-client",
-  "version": "0.17.2",
+  "version": "0.18.0-rc.1",
   "description": "A javascript / typescript client for Lemmy",
   "repository": "https://github.com/LemmyNet/lemmy-js-client",
   "license": "AGPL-3.0",
@@ -12,7 +12,7 @@
   ],
   "scripts": {
     "build": "tsc",
-    "docs": "typedoc src/index.ts --sourcefile-url-prefix 'https://github.com/LemmyNet/lemmy-js-client/tree/main/src/'",
+    "docs": "typedoc src/index.ts",
     "lint": "tsc --noEmit && eslint --report-unused-disable-directives --ext .js,.ts,.tsx src && prettier --check src",
     "prepare": "yarn run build && husky install"
   },
@@ -26,25 +26,24 @@
     ]
   },
   "dependencies": {
-    "node-fetch": "2.6.6"
+    "cross-fetch": "^3.1.5",
+    "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "@types/node": "^18.6.2",
-    "@types/node-fetch": "2.6.2",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
-    "eslint": "^8.20.0",
+    "@types/node": "^20.1.2",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
+    "eslint": "^8.40.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "prettier": "^2.7.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.2",
+    "prettier": "^2.8.8",
     "prettier-plugin-import-sort": "^0.0.7",
-    "prettier-plugin-organize-imports": "^3.0.0",
-    "prettier-plugin-packagejson": "^2.2.18",
-    "sortpack": "^2.3.0",
-    "typedoc": "^0.21.6",
-    "typedoc-plugin-sourcefile-url": "^1.0.6",
-    "typescript": "^4.7.4"
+    "prettier-plugin-organize-imports": "^3.2.2",
+    "prettier-plugin-packagejson": "^2.4.3",
+    "sortpack": "^2.3.4",
+    "typedoc": "^0.24.7",
+    "typescript": "^5.0.4"
   },
   "importSort": {
     ".js, .jsx, .ts, .tsx": {

package/dist/interfaces/aggregates.d.ts

@@ -1,93 +0,0 @@
-/**
- * Aggregate data for a person.
- */
-export interface PersonAggregates {
-    id: number;
-    person_id: number;
-    post_count: number;
-    post_score: number;
-    comment_count: number;
-    comment_score: number;
-}
-/**
- * Aggregate data for your site.
- */
-export interface SiteAggregates {
-    id: number;
-    site_id: number;
-    users: number;
-    posts: number;
-    comments: number;
-    communities: number;
-    /**
-     * Active users per day.
-     */
-    users_active_day: number;
-    /**
-     * Active users per week.
-     */
-    users_active_week: number;
-    /**
-     * Active users per month.
-     */
-    users_active_month: number;
-    /**
-     * Active users per year.
-     */
-    users_active_half_year: number;
-}
-/**
- * Aggregate data for your post.
- */
-export interface PostAggregates {
-    id: number;
-    post_id: number;
-    comments: number;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    /**
-     * Newest comment time, limited to 2 days, to prevent necrobumping.
-     */
-    newest_comment_time_necro: string;
-    newest_comment_time: string;
-    featured_community: boolean;
-    featured_local: boolean;
-}
-/**
- * Aggregate data for your community.
- */
-export interface CommunityAggregates {
-    id: number;
-    community_id: number;
-    subscribers: number;
-    posts: number;
-    comments: number;
-    /**
-     * Active users per day.
-     */
-    users_active_day: number;
-    /**
-     * Active users per week.
-     */
-    users_active_week: number;
-    /**
-     * Active users per month.
-     */
-    users_active_month: number;
-    /**
-     * Active users per year.
-     */
-    users_active_half_year: number;
-}
-/**
- * Aggregate data for your comment.
- */
-export interface CommentAggregates {
-    id: number;
-    comment_id: number;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    child_count: number;
-}

package/dist/interfaces/api/comment.d.ts

@@ -1,116 +0,0 @@
-import { CommentSortType, ListingType } from "../others";
-import { CommentReportView, CommentView } from "../views";
-export interface CreateComment {
-    content: string;
-    parent_id?: number;
-    language_id?: number;
-    post_id: number;
-    /**
-     * An optional front end ID, to tell which is comment is coming back.
-     */
-    form_id?: string;
-    auth: string;
-}
-export interface EditComment {
-    comment_id: number;
-    content?: string;
-    /**
-     * "Distinguishes" a comment, or speak officially. Only doable by community mods or admins.
-     */
-    distinguished?: boolean;
-    language_id?: number;
-    /**
-     * An optional front end ID, to tell which is comment is coming back.
-     */
-    form_id?: string;
-    auth: string;
-}
-/**
- * Only the creator can delete the comment.
- */
-export interface DeleteComment {
-    comment_id: number;
-    deleted: boolean;
-    auth: string;
-}
-/**
- * Only a mod or admin can remove the comment.
- */
-export interface RemoveComment {
-    comment_id: number;
-    removed: boolean;
-    reason?: string;
-    auth: string;
-}
-export interface SaveComment {
-    comment_id: number;
-    save: boolean;
-    auth: string;
-}
-export interface CommentResponse {
-    comment_view: CommentView;
-    recipient_ids: number[];
-    /**
-     * An optional front end ID, to tell which is comment is coming back.
-     */
-    form_id?: string;
-}
-export interface CreateCommentLike {
-    comment_id: number;
-    score: number;
-    auth: string;
-}
-/**
- * Comment listing types are `All, Subscribed, Community`
- *
- * You can use either `community_id` or `community_name` as an id.
- * To get posts for a federated community by name, use `name@instance.tld` .
- */
-export interface GetComments {
-    type_?: ListingType;
-    sort?: CommentSortType;
-    max_depth?: number;
-    page?: number;
-    limit?: number;
-    community_id?: number;
-    community_name?: string;
-    post_id?: number;
-    parent_id?: number;
-    saved_only?: boolean;
-    auth?: string;
-}
-export interface GetCommentsResponse {
-    comments: CommentView[];
-}
-export interface CreateCommentReport {
-    comment_id: number;
-    reason: string;
-    auth: string;
-}
-export interface CommentReportResponse {
-    comment_report_view: CommentReportView;
-}
-export interface ResolveCommentReport {
-    report_id: number;
-    /**
-     * Either resolve or unresolve a report.
-     */
-    resolved: boolean;
-    auth: string;
-}
-export interface ListCommentReports {
-    page?: number;
-    limit?: number;
-    /**
-     * if no community is given, it returns reports for all communities moderated by the auth user.
-     */
-    community_id?: number;
-    /**
-     * Only shows the unresolved reports.
-     */
-    unresolved_only?: boolean;
-    auth: string;
-}
-export interface ListCommentReportsResponse {
-    comment_reports: CommentReportView[];
-}

package/dist/interfaces/api/community.d.ts

@@ -1,125 +0,0 @@
-import { ListingType, SortType } from "../others";
-import { Site } from "../source";
-import { CommunityModeratorView, CommunityView, PersonViewSafe } from "../views";
-/**
- * You can use either `id` or `name` as an id.
- *
- * To get a federated community by name, use `name@instance.tld` .
- */
-export interface GetCommunity {
-    id?: number;
-    name?: string;
-    auth?: string;
-}
-export interface GetCommunityResponse {
-    community_view: CommunityView;
-    site?: Site;
-    moderators: CommunityModeratorView[];
-    online: number;
-    discussion_languages: number[];
-    default_post_language?: number;
-}
-export interface CreateCommunity {
-    name: string;
-    title: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    nsfw?: boolean;
-    posting_restricted_to_mods?: boolean;
-    discussion_languages?: number[];
-    auth: string;
-}
-export interface CommunityResponse {
-    community_view: CommunityView;
-    discussion_languages: number[];
-}
-export interface ListCommunities {
-    type_?: ListingType;
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    auth?: string;
-}
-export interface ListCommunitiesResponse {
-    communities: CommunityView[];
-}
-export interface BanFromCommunity {
-    community_id: number;
-    person_id: number;
-    ban: boolean;
-    /**
-     * Removes/Restores their comments and posts for that community.
-     */
-    remove_data?: boolean;
-    reason?: string;
-    /**
-     * The expire time in Unix seconds
-     */
-    expires?: number;
-    auth: string;
-}
-export interface BanFromCommunityResponse {
-    person_view: PersonViewSafe;
-    banned: boolean;
-}
-export interface AddModToCommunity {
-    community_id: number;
-    person_id: number;
-    added: boolean;
-    auth: string;
-}
-export interface AddModToCommunityResponse {
-    moderators: CommunityModeratorView[];
-}
-/**
- * Only mods can edit a community.
- */
-export interface EditCommunity {
-    community_id: number;
-    title?: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    nsfw?: boolean;
-    posting_restricted_to_mods?: boolean;
-    discussion_languages?: number[];
-    auth: string;
-}
-export interface DeleteCommunity {
-    community_id: number;
-    deleted: boolean;
-    auth: string;
-}
-/**
- * Only admins can remove a community.
- */
-export interface RemoveCommunity {
-    community_id: number;
-    removed: boolean;
-    reason?: string;
-    /**
-     * The expire time in Unix seconds
-     */
-    expires?: number;
-    auth: string;
-}
-export interface FollowCommunity {
-    community_id: number;
-    follow: boolean;
-    auth: string;
-}
-export interface TransferCommunity {
-    community_id: number;
-    person_id: number;
-    auth: string;
-}
-export interface BlockCommunity {
-    community_id: number;
-    block: boolean;
-    auth: string;
-}
-export interface BlockCommunityResponse {
-    community_view: CommunityView;
-    blocked: boolean;
-}

package/dist/interfaces/api/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./comment";
-export * from "./community";
-export * from "./person";
-export * from "./post";
-export * from "./site";
-export * from "./websocket";

package/dist/interfaces/api/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./comment"), exports);
-__exportStar(require("./community"), exports);
-__exportStar(require("./person"), exports);
-__exportStar(require("./post"), exports);
-__exportStar(require("./site"), exports);
-__exportStar(require("./websocket"), exports);