lemmy-js-client 0.17.0-rc.2 → 0.17.0-rc.20

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./http";
 export * from "./interfaces";
+export * from "./utils";
 export * from "./websocket";

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -12,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./http"), exports);
 __exportStar(require("./interfaces"), exports);
+__exportStar(require("./utils"), exports);
 __exportStar(require("./websocket"), exports);

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

@@ -1,65 +1,74 @@
+import { Option } from "@sniptt/monads";
+import { ListingType, SortType } from "../others";
 import { CommentReportView, CommentView } from "../views";
-export interface CreateComment {
+export declare class CreateComment {
     content: string;
-    parent_id?: number;
+    parent_id: Option<number>;
     post_id: number;
     /**
      * An optional front end ID, to tell which is comment is coming back.
      */
-    form_id?: string;
+    form_id: Option<string>;
     auth: string;
+    constructor(init: CreateComment);
 }
-export interface EditComment {
+export declare class EditComment {
     content: string;
     comment_id: number;
     /**
      * An optional front end ID, to tell which is comment is coming back.
      */
-    form_id?: string;
+    form_id: Option<string>;
     auth: string;
+    constructor(init: EditComment);
 }
 /**
  * Only the creator can delete the comment.
  */
-export interface DeleteComment {
+export declare class DeleteComment {
     comment_id: number;
     deleted: boolean;
     auth: string;
+    constructor(init: DeleteComment);
 }
 /**
  * Only a mod or admin can remove the comment.
  */
-export interface RemoveComment {
+export declare class RemoveComment {
     comment_id: number;
     removed: boolean;
-    reason?: string;
+    reason: Option<string>;
     auth: string;
+    constructor(init: RemoveComment);
 }
 /**
  * Only the recipient can do this.
  */
-export interface MarkCommentAsRead {
+export declare class MarkCommentAsRead {
     comment_id: number;
     read: boolean;
     auth: string;
+    constructor(init: MarkCommentAsRead);
 }
-export interface SaveComment {
+export declare class SaveComment {
     comment_id: number;
     save: boolean;
     auth: string;
+    constructor(init: SaveComment);
 }
-export interface CommentResponse {
+export declare class CommentResponse {
     comment_view: CommentView;
     recipient_ids: number[];
     /**
      * An optional front end ID, to tell which is comment is coming back.
      */
-    form_id?: string;
+    form_id: Option<string>;
 }
-export interface CreateCommentLike {
+export declare class CreateCommentLike {
     comment_id: number;
     score: number;
     auth: string;
+    constructor(init: CreateCommentLike);
 }
 /**
  * Comment listing types are `All, Subscribed, Community`
@@ -67,54 +76,52 @@ export interface CreateCommentLike {
  * 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 {
-    /**
-     * The [[ListingType]].
-     */
-    type_?: string;
-    /**
-     * The [[SortType]].
-     */
-    sort?: string;
-    page?: number;
-    limit?: number;
-    community_id?: number;
-    community_name?: string;
-    saved_only?: boolean;
-    auth?: string;
+export declare class GetComments {
+    type_: Option<ListingType>;
+    sort: Option<SortType>;
+    page: Option<number>;
+    limit: Option<number>;
+    community_id: Option<number>;
+    community_name: Option<string>;
+    saved_only: Option<boolean>;
+    auth: Option<string>;
+    constructor(init: GetComments);
 }
-export interface GetCommentsResponse {
+export declare class GetCommentsResponse {
     comments: CommentView[];
 }
-export interface CreateCommentReport {
+export declare class CreateCommentReport {
     comment_id: number;
     reason: string;
     auth: string;
+    constructor(init: CreateCommentReport);
 }
-export interface CommentReportResponse {
+export declare class CommentReportResponse {
     comment_report_view: CommentReportView;
 }
-export interface ResolveCommentReport {
+export declare class ResolveCommentReport {
     report_id: number;
     /**
      * Either resolve or unresolve a report.
      */
     resolved: boolean;
     auth: string;
+    constructor(init: ResolveCommentReport);
 }
-export interface ListCommentReports {
-    page?: number;
-    limit?: number;
+export declare class ListCommentReports {
+    page: Option<number>;
+    limit: Option<number>;
     /**
      * if no community is given, it returns reports for all communities moderated by the auth user.
      */
-    community_id?: number;
+    community_id: Option<number>;
     /**
      * Only shows the unresolved reports.
      */
-    unresolved_only?: boolean;
+    unresolved_only: Option<boolean>;
     auth: string;
+    constructor(init: ListCommentReports);
 }
-export interface ListCommentReportsResponse {
+export declare class ListCommentReportsResponse {
     comment_reports: CommentReportView[];
 }

package/dist/interfaces/api/comment.js

@@ -1,2 +1,315 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListCommentReportsResponse = exports.ListCommentReports = exports.ResolveCommentReport = exports.CommentReportResponse = exports.CreateCommentReport = exports.GetCommentsResponse = exports.GetComments = exports.CreateCommentLike = exports.CommentResponse = exports.SaveComment = exports.MarkCommentAsRead = exports.RemoveComment = exports.DeleteComment = exports.EditComment = exports.CreateComment = void 0;
+var monads_1 = require("@sniptt/monads");
+var class_transformer_1 = require("class-transformer");
+var utils_1 = require("../../utils");
+var CreateComment = /** @class */ (function () {
+    function CreateComment(init) {
+        Object.assign(this, init);
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], CreateComment.prototype, "parent_id", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], CreateComment.prototype, "form_id", void 0);
+    return CreateComment;
+}());
+exports.CreateComment = CreateComment;
+var EditComment = /** @class */ (function () {
+    function EditComment(init) {
+        Object.assign(this, init);
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], EditComment.prototype, "form_id", void 0);
+    return EditComment;
+}());
+exports.EditComment = EditComment;
+/**
+ * Only the creator can delete the comment.
+ */
+var DeleteComment = /** @class */ (function () {
+    function DeleteComment(init) {
+        Object.assign(this, init);
+    }
+    return DeleteComment;
+}());
+exports.DeleteComment = DeleteComment;
+/**
+ * Only a mod or admin can remove the comment.
+ */
+var RemoveComment = /** @class */ (function () {
+    function RemoveComment(init) {
+        Object.assign(this, init);
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], RemoveComment.prototype, "reason", void 0);
+    return RemoveComment;
+}());
+exports.RemoveComment = RemoveComment;
+/**
+ * Only the recipient can do this.
+ */
+var MarkCommentAsRead = /** @class */ (function () {
+    function MarkCommentAsRead(init) {
+        Object.assign(this, init);
+    }
+    return MarkCommentAsRead;
+}());
+exports.MarkCommentAsRead = MarkCommentAsRead;
+var SaveComment = /** @class */ (function () {
+    function SaveComment(init) {
+        Object.assign(this, init);
+    }
+    return SaveComment;
+}());
+exports.SaveComment = SaveComment;
+var CommentResponse = /** @class */ (function () {
+    function CommentResponse() {
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], CommentResponse.prototype, "form_id", void 0);
+    return CommentResponse;
+}());
+exports.CommentResponse = CommentResponse;
+var CreateCommentLike = /** @class */ (function () {
+    function CreateCommentLike(init) {
+        Object.assign(this, init);
+    }
+    return CreateCommentLike;
+}());
+exports.CreateCommentLike = CreateCommentLike;
+/**
+ * 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` .
+ */
+var GetComments = /** @class */ (function () {
+    function GetComments(init) {
+        Object.assign(this, init);
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "type_", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "sort", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "page", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "limit", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "community_id", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "community_name", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "saved_only", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], GetComments.prototype, "auth", void 0);
+    return GetComments;
+}());
+exports.GetComments = GetComments;
+var GetCommentsResponse = /** @class */ (function () {
+    function GetCommentsResponse() {
+    }
+    return GetCommentsResponse;
+}());
+exports.GetCommentsResponse = GetCommentsResponse;
+var CreateCommentReport = /** @class */ (function () {
+    function CreateCommentReport(init) {
+        Object.assign(this, init);
+    }
+    return CreateCommentReport;
+}());
+exports.CreateCommentReport = CreateCommentReport;
+var CommentReportResponse = /** @class */ (function () {
+    function CommentReportResponse() {
+    }
+    return CommentReportResponse;
+}());
+exports.CommentReportResponse = CommentReportResponse;
+var ResolveCommentReport = /** @class */ (function () {
+    function ResolveCommentReport(init) {
+        Object.assign(this, init);
+    }
+    return ResolveCommentReport;
+}());
+exports.ResolveCommentReport = ResolveCommentReport;
+var ListCommentReports = /** @class */ (function () {
+    function ListCommentReports(init) {
+        Object.assign(this, init);
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], ListCommentReports.prototype, "page", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], ListCommentReports.prototype, "limit", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], ListCommentReports.prototype, "community_id", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], ListCommentReports.prototype, "unresolved_only", void 0);
+    return ListCommentReports;
+}());
+exports.ListCommentReports = ListCommentReports;
+var ListCommentReportsResponse = /** @class */ (function () {
+    function ListCommentReportsResponse() {
+    }
+    return ListCommentReportsResponse;
+}());
+exports.ListCommentReportsResponse = ListCommentReportsResponse;

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

@@ -1,128 +1,132 @@
+import { Option } from "@sniptt/monads";
+import { ListingType, SortType } from "../others";
 import { Site } from "../source";
-import { CommunityFollowerView, CommunityModeratorView, CommunityView, PersonViewSafe } from "../views";
+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 declare class GetCommunity {
+    id: Option<number>;
+    name: Option<string>;
+    auth: Option<string>;
+    constructor(init: GetCommunity);
 }
-export interface GetCommunityResponse {
+export declare class GetCommunityResponse {
     community_view: CommunityView;
-    site?: Site;
+    site: Option<Site>;
     moderators: CommunityModeratorView[];
     online: number;
 }
-export interface CreateCommunity {
+export declare class CreateCommunity {
     name: string;
     title: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    nsfw?: boolean;
-    posting_restricted_to_mods?: boolean;
+    description: Option<string>;
+    icon: Option<string>;
+    banner: Option<string>;
+    nsfw: Option<boolean>;
+    posting_restricted_to_mods: Option<boolean>;
     auth: string;
+    constructor(init: CreateCommunity);
 }
-export interface CommunityResponse {
+export declare class CommunityResponse {
     community_view: CommunityView;
 }
-export interface FollowCommunityResponse {
-    community_follower_view?: CommunityFollowerView;
+export declare class ListCommunities {
+    type_: Option<ListingType>;
+    sort: Option<SortType>;
+    page: Option<number>;
+    limit: Option<number>;
+    auth: Option<string>;
+    constructor(init: ListCommunities);
 }
-export interface ListCommunities {
-    /**
-     * The [[ListingType]].
-     */
-    type_?: string;
-    /**
-     * The [[SortType]].
-     */
-    sort?: string;
-    page?: number;
-    limit?: number;
-    auth?: string;
-}
-export interface ListCommunitiesResponse {
+export declare class ListCommunitiesResponse {
     communities: CommunityView[];
 }
-export interface BanFromCommunity {
+export declare class BanFromCommunity {
     community_id: number;
     person_id: number;
     ban: boolean;
     /**
      * Removes/Restores their comments and posts for that community.
      */
-    remove_data?: boolean;
-    reason?: string;
+    remove_data: Option<boolean>;
+    reason: Option<string>;
     /**
      * The expire time in Unix seconds
      */
-    expires?: number;
+    expires: Option<number>;
     auth: string;
+    constructor(init: BanFromCommunity);
 }
-export interface BanFromCommunityResponse {
+export declare class BanFromCommunityResponse {
     person_view: PersonViewSafe;
     banned: boolean;
 }
-export interface AddModToCommunity {
+export declare class AddModToCommunity {
     community_id: number;
     person_id: number;
     added: boolean;
     auth: string;
+    constructor(init: AddModToCommunity);
 }
-export interface AddModToCommunityResponse {
+export declare class AddModToCommunityResponse {
     moderators: CommunityModeratorView[];
 }
 /**
  * Only mods can edit a community.
  */
-export interface EditCommunity {
+export declare class EditCommunity {
     community_id: number;
-    title?: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    nsfw?: boolean;
-    posting_restricted_to_mods?: boolean;
+    title: Option<string>;
+    description: Option<string>;
+    icon: Option<string>;
+    banner: Option<string>;
+    nsfw: Option<boolean>;
+    posting_restricted_to_mods: Option<boolean>;
     auth: string;
+    constructor(init: EditCommunity);
 }
-export interface DeleteCommunity {
+export declare class DeleteCommunity {
     community_id: number;
     deleted: boolean;
     auth: string;
+    constructor(init: DeleteCommunity);
 }
 /**
  * Only admins can remove a community.
  */
-export interface RemoveCommunity {
+export declare class RemoveCommunity {
     community_id: number;
     removed: boolean;
-    reason?: string;
+    reason: Option<string>;
     /**
      * The expire time in Unix seconds
      */
-    expires?: number;
+    expires: Option<number>;
     auth: string;
+    constructor(init: RemoveCommunity);
 }
-export interface FollowCommunity {
+export declare class FollowCommunity {
     community_id: number;
     follow: boolean;
     auth: string;
+    constructor(init: FollowCommunity);
 }
-export interface TransferCommunity {
+export declare class TransferCommunity {
     community_id: number;
     person_id: number;
     auth: string;
+    constructor(init: TransferCommunity);
 }
-export interface BlockCommunity {
+export declare class BlockCommunity {
     community_id: number;
     block: boolean;
     auth: string;
+    constructor(init: BlockCommunity);
 }
-export interface BlockCommunityResponse {
+export declare class BlockCommunityResponse {
     community_view: CommunityView;
     blocked: boolean;
 }