lemmy-js-client 0.17.0-rc.13 → 0.17.0-rc.16

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

@@ -1,3 +1,4 @@
+import { Option } from "@sniptt/monads";
 import { ListingType, SortType } from "../others";
 import { Site } from "../source";
 import { CommunityModeratorView, CommunityView, PersonViewSafe } from "../views";
@@ -6,115 +7,126 @@ import { CommunityModeratorView, CommunityView, PersonViewSafe } from "../views"
  *
  * 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(id: Option<number>, name: Option<string>, auth: Option<string>);
 }
-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(name: string, title: string, description: Option<string>, icon: Option<string>, banner: Option<string>, nsfw: Option<boolean>, posting_restricted_to_mods: Option<boolean>, auth: string);
 }
-export interface CommunityResponse {
+export declare class CommunityResponse {
     community_view: CommunityView;
 }
-export interface ListCommunities {
-    type_?: ListingType;
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    auth?: string;
+export declare class ListCommunities {
+    type_: Option<ListingType>;
+    sort: Option<SortType>;
+    page: Option<number>;
+    limit: Option<number>;
+    auth: Option<string>;
+    constructor(type_: Option<ListingType>, sort: Option<SortType>, page: Option<number>, limit: Option<number>, auth: Option<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(community_id: number, person_id: number, ban: boolean, remove_data: Option<boolean>, reason: Option<string>, expires: Option<number>, auth: string);
 }
-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(community_id: number, person_id: number, added: boolean, auth: string);
 }
-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(community_id: number, title: Option<string>, description: Option<string>, icon: Option<string>, banner: Option<string>, nsfw: Option<boolean>, posting_restricted_to_mods: Option<boolean>, auth: string);
 }
-export interface DeleteCommunity {
+export declare class DeleteCommunity {
     community_id: number;
     deleted: boolean;
     auth: string;
+    constructor(community_id: number, deleted: boolean, auth: string);
 }
 /**
  * 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(community_id: number, removed: boolean, reason: Option<string>, expires: Option<number>, auth: string);
 }
-export interface FollowCommunity {
+export declare class FollowCommunity {
     community_id: number;
     follow: boolean;
     auth: string;
+    constructor(community_id: number, follow: boolean, auth: string);
 }
-export interface TransferCommunity {
+export declare class TransferCommunity {
     community_id: number;
     person_id: number;
     auth: string;
+    constructor(community_id: number, person_id: number, auth: string);
 }
-export interface BlockCommunity {
+export declare class BlockCommunity {
     community_id: number;
     block: boolean;
     auth: string;
+    constructor(community_id: number, block: boolean, auth: string);
 }
-export interface BlockCommunityResponse {
+export declare class BlockCommunityResponse {
     community_view: CommunityView;
     blocked: boolean;
 }

package/dist/interfaces/api/community.js

@@ -1,2 +1,452 @@
 "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.BlockCommunityResponse = exports.BlockCommunity = exports.TransferCommunity = exports.FollowCommunity = exports.RemoveCommunity = exports.DeleteCommunity = exports.EditCommunity = exports.AddModToCommunityResponse = exports.AddModToCommunity = exports.BanFromCommunityResponse = exports.BanFromCommunity = exports.ListCommunitiesResponse = exports.ListCommunities = exports.CommunityResponse = exports.CreateCommunity = exports.GetCommunityResponse = exports.GetCommunity = void 0;
+var monads_1 = require("@sniptt/monads");
+var class_transformer_1 = require("class-transformer");
+var utils_1 = require("../../utils");
+/**
+ * You can use either `id` or `name` as an id.
+ *
+ * To get a federated community by name, use `name@instance.tld` .
+ */
+var GetCommunity = /** @class */ (function () {
+    function GetCommunity(id, name, auth) {
+        this.id = id;
+        this.name = name;
+        this.auth = auth;
+    }
+    __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)()
+    ], GetCommunity.prototype, "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)()
+    ], GetCommunity.prototype, "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)()
+    ], GetCommunity.prototype, "auth", void 0);
+    return GetCommunity;
+}());
+exports.GetCommunity = GetCommunity;
+var GetCommunityResponse = /** @class */ (function () {
+    function GetCommunityResponse() {
+    }
+    __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)()
+    ], GetCommunityResponse.prototype, "site", void 0);
+    return GetCommunityResponse;
+}());
+exports.GetCommunityResponse = GetCommunityResponse;
+var CreateCommunity = /** @class */ (function () {
+    function CreateCommunity(name, title, description, icon, banner, nsfw, posting_restricted_to_mods, auth) {
+        this.name = name;
+        this.title = title;
+        this.description = description;
+        this.icon = icon;
+        this.banner = banner;
+        this.nsfw = nsfw;
+        this.posting_restricted_to_mods = posting_restricted_to_mods;
+        this.auth = auth;
+    }
+    __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)()
+    ], CreateCommunity.prototype, "description", 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)()
+    ], CreateCommunity.prototype, "icon", 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)()
+    ], CreateCommunity.prototype, "banner", 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)()
+    ], CreateCommunity.prototype, "nsfw", 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)()
+    ], CreateCommunity.prototype, "posting_restricted_to_mods", void 0);
+    return CreateCommunity;
+}());
+exports.CreateCommunity = CreateCommunity;
+var CommunityResponse = /** @class */ (function () {
+    function CommunityResponse() {
+    }
+    return CommunityResponse;
+}());
+exports.CommunityResponse = CommunityResponse;
+var ListCommunities = /** @class */ (function () {
+    function ListCommunities(type_, sort, page, limit, auth) {
+        this.type_ = type_;
+        this.sort = sort;
+        this.page = page;
+        this.limit = limit;
+        this.auth = auth;
+    }
+    __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)()
+    ], ListCommunities.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)()
+    ], ListCommunities.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)()
+    ], ListCommunities.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)()
+    ], ListCommunities.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)()
+    ], ListCommunities.prototype, "auth", void 0);
+    return ListCommunities;
+}());
+exports.ListCommunities = ListCommunities;
+var ListCommunitiesResponse = /** @class */ (function () {
+    function ListCommunitiesResponse() {
+    }
+    return ListCommunitiesResponse;
+}());
+exports.ListCommunitiesResponse = ListCommunitiesResponse;
+var BanFromCommunity = /** @class */ (function () {
+    function BanFromCommunity(community_id, person_id, ban, remove_data, reason, expires, auth) {
+        this.community_id = community_id;
+        this.person_id = person_id;
+        this.ban = ban;
+        this.remove_data = remove_data;
+        this.reason = reason;
+        this.expires = expires;
+        this.auth = auth;
+    }
+    __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)()
+    ], BanFromCommunity.prototype, "remove_data", 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)()
+    ], BanFromCommunity.prototype, "reason", 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)()
+    ], BanFromCommunity.prototype, "expires", void 0);
+    return BanFromCommunity;
+}());
+exports.BanFromCommunity = BanFromCommunity;
+var BanFromCommunityResponse = /** @class */ (function () {
+    function BanFromCommunityResponse() {
+    }
+    return BanFromCommunityResponse;
+}());
+exports.BanFromCommunityResponse = BanFromCommunityResponse;
+var AddModToCommunity = /** @class */ (function () {
+    function AddModToCommunity(community_id, person_id, added, auth) {
+        this.community_id = community_id;
+        this.person_id = person_id;
+        this.added = added;
+        this.auth = auth;
+    }
+    return AddModToCommunity;
+}());
+exports.AddModToCommunity = AddModToCommunity;
+var AddModToCommunityResponse = /** @class */ (function () {
+    function AddModToCommunityResponse() {
+    }
+    return AddModToCommunityResponse;
+}());
+exports.AddModToCommunityResponse = AddModToCommunityResponse;
+/**
+ * Only mods can edit a community.
+ */
+var EditCommunity = /** @class */ (function () {
+    function EditCommunity(community_id, title, description, icon, banner, nsfw, posting_restricted_to_mods, auth) {
+        this.community_id = community_id;
+        this.title = title;
+        this.description = description;
+        this.icon = icon;
+        this.banner = banner;
+        this.nsfw = nsfw;
+        this.posting_restricted_to_mods = posting_restricted_to_mods;
+        this.auth = auth;
+    }
+    __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)()
+    ], EditCommunity.prototype, "title", 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)()
+    ], EditCommunity.prototype, "description", 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)()
+    ], EditCommunity.prototype, "icon", 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)()
+    ], EditCommunity.prototype, "banner", 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)()
+    ], EditCommunity.prototype, "nsfw", 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)()
+    ], EditCommunity.prototype, "posting_restricted_to_mods", void 0);
+    return EditCommunity;
+}());
+exports.EditCommunity = EditCommunity;
+var DeleteCommunity = /** @class */ (function () {
+    function DeleteCommunity(community_id, deleted, auth) {
+        this.community_id = community_id;
+        this.deleted = deleted;
+        this.auth = auth;
+    }
+    return DeleteCommunity;
+}());
+exports.DeleteCommunity = DeleteCommunity;
+/**
+ * Only admins can remove a community.
+ */
+var RemoveCommunity = /** @class */ (function () {
+    function RemoveCommunity(community_id, removed, reason, expires, auth) {
+        this.community_id = community_id;
+        this.removed = removed;
+        this.reason = reason;
+        this.expires = expires;
+        this.auth = auth;
+    }
+    __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)()
+    ], RemoveCommunity.prototype, "reason", 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)()
+    ], RemoveCommunity.prototype, "expires", void 0);
+    return RemoveCommunity;
+}());
+exports.RemoveCommunity = RemoveCommunity;
+var FollowCommunity = /** @class */ (function () {
+    function FollowCommunity(community_id, follow, auth) {
+        this.community_id = community_id;
+        this.follow = follow;
+        this.auth = auth;
+    }
+    return FollowCommunity;
+}());
+exports.FollowCommunity = FollowCommunity;
+var TransferCommunity = /** @class */ (function () {
+    function TransferCommunity(community_id, person_id, auth) {
+        this.community_id = community_id;
+        this.person_id = person_id;
+        this.auth = auth;
+    }
+    return TransferCommunity;
+}());
+exports.TransferCommunity = TransferCommunity;
+var BlockCommunity = /** @class */ (function () {
+    function BlockCommunity(community_id, block, auth) {
+        this.community_id = community_id;
+        this.block = block;
+        this.auth = auth;
+    }
+    return BlockCommunity;
+}());
+exports.BlockCommunity = BlockCommunity;
+var BlockCommunityResponse = /** @class */ (function () {
+    function BlockCommunityResponse() {
+    }
+    return BlockCommunityResponse;
+}());
+exports.BlockCommunityResponse = BlockCommunityResponse;