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

package/dist/interfaces/others.d.ts

@@ -1,3 +1,4 @@
+import { Option } from "@sniptt/monads";
 export declare const VERSION = "v3";
 /**
  * All of the websocket operations available.
@@ -143,45 +144,12 @@ export declare enum SearchType {
     Users = "Users",
     Url = "Url"
 }
-/**
- * A websocket response. Includes the return type.
- * Can be used like:
- *
- * ```ts
- * if (op == UserOperation.Search) {
- *   let data = wsJsonToRes<SearchResponse>(msg).data;
- * }
- * ```
- */
-export interface WebSocketResponse<ResponseType> {
-    op: UserOperation;
-    /**
-     * This contains the data for a websocket response.
-     *
-     * The correct response type if given is in [[LemmyHttp]].
-     */
-    data: ResponseType;
-}
-/**
- * A websocket JSON response that includes the errors.
- */
-export interface WebSocketJsonResponse<ResponseType> {
-    op?: string;
-    /**
-     * This contains the data for a websocket response.
-     *
-     * The correct response type if given is in [[LemmyHttp]].
-     */
-    data?: ResponseType;
-    error?: string;
-    reconnect?: boolean;
-}
 /**
  * A holder for a site's metadata ( such as opengraph tags ), used for post links.
  */
-export interface SiteMetadata {
-    title?: string;
-    description?: string;
-    image?: string;
-    html?: string;
+export declare class SiteMetadata {
+    title: Option<string>;
+    description: Option<string>;
+    image: Option<string>;
+    html: Option<string>;
 }

package/dist/interfaces/others.js

@@ -1,6 +1,15 @@
 "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.SearchType = exports.ListingType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
+exports.SiteMetadata = exports.SearchType = exports.ListingType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
+var monads_1 = require("@sniptt/monads");
+var class_transformer_1 = require("class-transformer");
+var utils_1 = require("../utils");
 exports.VERSION = "v3";
 /**
  * All of the websocket operations available.
@@ -150,3 +159,56 @@ var SearchType;
     SearchType["Users"] = "Users";
     SearchType["Url"] = "Url";
 })(SearchType = exports.SearchType || (exports.SearchType = {}));
+/**
+ * A holder for a site's metadata ( such as opengraph tags ), used for post links.
+ */
+var SiteMetadata = /** @class */ (function () {
+    function SiteMetadata() {
+    }
+    __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)()
+    ], SiteMetadata.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)()
+    ], SiteMetadata.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)()
+    ], SiteMetadata.prototype, "image", 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)()
+    ], SiteMetadata.prototype, "html", void 0);
+    return SiteMetadata;
+}());
+exports.SiteMetadata = SiteMetadata;

package/dist/interfaces/source.d.ts

@@ -1,8 +1,8 @@
-import { Option } from "@swan-io/boxed";
-export interface LocalUserSettings {
+import { Option } from "@sniptt/monads";
+export declare class LocalUserSettings {
     id: number;
     person_id: number;
-    email?: string;
+    email: Option<string>;
     show_nsfw: boolean;
     theme: string;
     default_sort_type: number;
@@ -17,42 +17,42 @@ export interface LocalUserSettings {
     email_verified: boolean;
     accepted_application: boolean;
 }
-export interface PersonSafe {
+export declare class PersonSafe {
     id: number;
     name: string;
-    display_name?: string;
-    avatar?: string;
+    display_name: Option<string>;
+    avatar: Option<string>;
     banned: boolean;
     published: string;
-    updated?: string;
+    updated: Option<string>;
     actor_id: string;
-    bio?: string;
+    bio: Option<string>;
     local: boolean;
-    banner?: string;
+    banner: Option<string>;
     deleted: boolean;
     inbox_url: string;
     shared_inbox_url: string;
-    matrix_user_id?: string;
+    matrix_user_id: Option<string>;
     admin: boolean;
     bot_account: boolean;
-    ban_expires?: string;
+    ban_expires: Option<string>;
 }
-export interface Site {
+export declare class Site {
     id: number;
     name: string;
     sidebar: Option<string>;
     published: string;
-    updated?: string;
+    updated: Option<string>;
     enable_downvotes: boolean;
     open_registration: boolean;
     enable_nsfw: boolean;
-    icon?: string;
-    banner?: string;
-    description?: string;
+    icon: Option<string>;
+    banner: Option<string>;
+    description: Option<string>;
     community_creation_admin_only: boolean;
     require_email_verification: boolean;
     require_application: boolean;
-    application_question?: string;
+    application_question: Option<string>;
     private_instance: boolean;
     default_theme: string;
     default_post_listing_type: string;
@@ -60,9 +60,9 @@ export interface Site {
     last_refreshed_at: string;
     inbox_url: string;
     public_key: string;
-    legal_information?: string;
+    legal_information: Option<string>;
 }
-export interface PrivateMessage {
+export declare class PrivateMessage {
     id: number;
     creator_id: number;
     recipient_id: number;
@@ -70,184 +70,184 @@ export interface PrivateMessage {
     deleted: boolean;
     read: boolean;
     published: string;
-    updated?: string;
+    updated: Option<string>;
     ap_id: string;
     local: boolean;
 }
-export interface PostReport {
+export declare class PostReport {
     id: number;
     creator_id: number;
     post_id: number;
     original_post_name: string;
-    original_post_url?: string;
-    original_post_body?: string;
+    original_post_url: Option<string>;
+    original_post_body: Option<string>;
     reason: string;
     resolved: boolean;
-    resolver_id?: number;
+    resolver_id: Option<number>;
     published: string;
-    updated?: string;
+    updated: Option<string>;
 }
-export interface Post {
+export declare class Post {
     id: number;
     name: string;
-    url?: string;
-    body?: string;
+    url: Option<string>;
+    body: Option<string>;
     creator_id: number;
     community_id: number;
     removed: boolean;
     locked: boolean;
     published: string;
-    updated?: string;
+    updated: Option<string>;
     deleted: boolean;
     nsfw: boolean;
     stickied: boolean;
-    embed_title?: string;
-    embed_description?: string;
-    embed_html?: string;
-    thumbnail_url?: string;
+    embed_title: Option<string>;
+    embed_description: Option<string>;
+    embed_html: Option<string>;
+    thumbnail_url: Option<string>;
     ap_id: string;
     local: boolean;
 }
-export interface PasswordResetRequest {
+export declare class PasswordResetRequest {
     id: number;
     local_user_id: number;
     token_encrypted: string;
     published: string;
 }
-export interface ModRemovePost {
+export declare class ModRemovePost {
     id: number;
     mod_person_id: number;
     post_id: number;
-    reason?: string;
-    removed?: boolean;
+    reason: Option<string>;
+    removed: Option<boolean>;
     when_: string;
 }
-export interface ModLockPost {
+export declare class ModLockPost {
     id: number;
     mod_person_id: number;
     post_id: number;
-    locked?: boolean;
+    locked: Option<boolean>;
     when_: string;
 }
-export interface ModStickyPost {
+export declare class ModStickyPost {
     id: number;
     mod_person_id: number;
     post_id: number;
-    stickied?: boolean;
+    stickied: Option<boolean>;
     when_: string;
 }
-export interface ModRemoveComment {
+export declare class ModRemoveComment {
     id: number;
     mod_person_id: number;
     comment_id: number;
-    reason?: string;
-    removed?: boolean;
+    reason: Option<string>;
+    removed: Option<boolean>;
     when_: string;
 }
-export interface ModRemoveCommunity {
+export declare class ModRemoveCommunity {
     id: number;
     mod_person_id: number;
     community_id: number;
-    reason?: string;
-    removed?: boolean;
-    expires?: string;
+    reason: Option<string>;
+    removed: Option<boolean>;
+    expires: Option<string>;
     when_: string;
 }
-export interface ModBanFromCommunity {
+export declare class ModBanFromCommunity {
     id: number;
     mod_person_id: number;
     other_person_id: number;
     community_id: number;
-    reason?: string;
-    banned?: boolean;
-    expires?: string;
+    reason: Option<string>;
+    banned: Option<boolean>;
+    expires: Option<string>;
     when_: string;
 }
-export interface ModBan {
+export declare class ModBan {
     id: number;
     mod_person_id: number;
     other_person_id: number;
-    reason?: string;
-    banned?: boolean;
-    expires?: string;
+    reason: Option<string>;
+    banned: Option<boolean>;
+    expires: Option<string>;
     when_: string;
 }
-export interface ModAddCommunity {
+export declare class ModAddCommunity {
     id: number;
     mod_person_id: number;
     other_person_id: number;
     community_id: number;
-    removed?: boolean;
+    removed: Option<boolean>;
     when_: string;
 }
-export interface ModTransferCommunity {
+export declare class ModTransferCommunity {
     id: number;
     mod_person_id: number;
     other_person_id: number;
     community_id: number;
-    removed?: boolean;
+    removed: Option<boolean>;
     when_: string;
 }
-export interface ModAdd {
+export declare class ModAdd {
     id: number;
     mod_person_id: number;
     other_person_id: number;
-    removed?: boolean;
+    removed: Option<boolean>;
     when_: string;
 }
-export interface CommunitySafe {
+export declare class CommunitySafe {
     id: number;
     name: string;
     title: string;
-    description?: string;
+    description: Option<string>;
     removed: boolean;
     published: string;
-    updated?: string;
+    updated: Option<string>;
     deleted: boolean;
     nsfw: boolean;
     actor_id: string;
     local: boolean;
-    icon?: string;
-    banner?: string;
+    icon: Option<string>;
+    banner: Option<string>;
     posting_restricted_to_mods: boolean;
 }
-export interface CommentReport {
+export declare class CommentReport {
     id: number;
     creator_id: number;
     comment_id: number;
     original_comment_text: string;
     reason: string;
     resolved: boolean;
-    resolver_id?: number;
+    resolver_id: Option<number>;
     published: string;
-    updated?: string;
+    updated: Option<string>;
 }
-export interface Comment {
+export declare class Comment {
     id: number;
     creator_id: number;
     post_id: number;
-    parent_id?: number;
+    parent_id: Option<number>;
     content: string;
     removed: boolean;
     read: boolean;
     published: string;
-    updated?: string;
+    updated: Option<string>;
     deleted: boolean;
     ap_id: string;
     local: boolean;
 }
-export interface PersonMention {
+export declare class PersonMention {
     id: number;
     recipient_id: number;
     comment_id: number;
     read: boolean;
     published: string;
 }
-export interface RegistrationApplication {
+export declare class RegistrationApplication {
     id: number;
     local_user_id: number;
     answer: string;
-    admin_id?: number;
-    deny_reason?: string;
+    admin_id: Option<number>;
+    deny_reason: Option<string>;
     published: string;
 }