lemmy-js-client 0.20.0-alpha.16 → 0.20.0-alpha.18

package/dist/types/ModBanFromCommunity.d.ts

@@ -1,6 +1,9 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModBanFromCommunity {
+/**
+ * When someone is banned from a community.
+ */
+export type ModBanFromCommunity = {
     id: number;
     mod_person_id: PersonId;
     other_person_id: PersonId;
@@ -9,4 +12,4 @@ export interface ModBanFromCommunity {
     banned: boolean;
     expires?: string;
     when_: string;
-}
+};

package/dist/types/ModBanFromCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModBanFromCommunity } from "./ModBanFromCommunity";
 import type { Person } from "./Person";
-export interface ModBanFromCommunityView {
+/**
+ * When someone is banned from a community.
+ */
+export type ModBanFromCommunityView = {
     mod_ban_from_community: ModBanFromCommunity;
     moderator?: Person;
     community: Community;
     banned_person: Person;
-}
+};

package/dist/types/ModBanView.d.ts

@@ -1,7 +1,10 @@
 import type { ModBan } from "./ModBan";
 import type { Person } from "./Person";
-export interface ModBanView {
+/**
+ * When someone is banned from the site.
+ */
+export type ModBanView = {
     mod_ban: ModBan;
     moderator?: Person;
     banned_person: Person;
-}
+};

package/dist/types/ModFeaturePost.d.ts

@@ -1,10 +1,13 @@
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModFeaturePost {
+/**
+ * When a moderator features a post on a community (pins it to the top).
+ */
+export type ModFeaturePost = {
     id: number;
     mod_person_id: PersonId;
     post_id: PostId;
     featured: boolean;
     when_: string;
     is_featured_community: boolean;
-}
+};

package/dist/types/ModFeaturePostView.d.ts

@@ -2,9 +2,12 @@ import type { Community } from "./Community";
 import type { ModFeaturePost } from "./ModFeaturePost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModFeaturePostView {
+/**
+ * When a moderator features a post on a community (pins it to the top).
+ */
+export type ModFeaturePostView = {
     mod_feature_post: ModFeaturePost;
     moderator?: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModHideCommunity.d.ts

@@ -1,10 +1,13 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModHideCommunity {
+/**
+ * When a community is hidden from public view.
+ */
+export type ModHideCommunity = {
     id: number;
     community_id: CommunityId;
     mod_person_id: PersonId;
     when_: string;
     reason?: string;
     hidden: boolean;
-}
+};

package/dist/types/ModHideCommunityView.d.ts

@@ -1,8 +1,11 @@
 import type { Community } from "./Community";
 import type { ModHideCommunity } from "./ModHideCommunity";
 import type { Person } from "./Person";
-export interface ModHideCommunityView {
+/**
+ * When a community is hidden from public view.
+ */
+export type ModHideCommunityView = {
     mod_hide_community: ModHideCommunity;
     admin?: Person;
     community: Community;
-}
+};

package/dist/types/ModLockPost.d.ts

@@ -1,9 +1,12 @@
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModLockPost {
+/**
+ * When a moderator locks a post (prevents new comments being made).
+ */
+export type ModLockPost = {
     id: number;
     mod_person_id: PersonId;
     post_id: PostId;
     locked: boolean;
     when_: string;
-}
+};

package/dist/types/ModLockPostView.d.ts

@@ -2,9 +2,12 @@ import type { Community } from "./Community";
 import type { ModLockPost } from "./ModLockPost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModLockPostView {
+/**
+ * When a moderator locks a post (prevents new comments being made).
+ */
+export type ModLockPostView = {
     mod_lock_post: ModLockPost;
     moderator?: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModRemoveComment.d.ts

@@ -1,10 +1,13 @@
 import type { CommentId } from "./CommentId";
 import type { PersonId } from "./PersonId";
-export interface ModRemoveComment {
+/**
+ * When a moderator removes a comment.
+ */
+export type ModRemoveComment = {
     id: number;
     mod_person_id: PersonId;
     comment_id: CommentId;
     reason?: string;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModRemoveCommentView.d.ts

@@ -3,11 +3,14 @@ import type { Community } from "./Community";
 import type { ModRemoveComment } from "./ModRemoveComment";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModRemoveCommentView {
+/**
+ * When a moderator removes a comment.
+ */
+export type ModRemoveCommentView = {
     mod_remove_comment: ModRemoveComment;
     moderator?: Person;
     comment: Comment;
     commenter: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModRemoveCommunity.d.ts

@@ -1,10 +1,13 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModRemoveCommunity {
+/**
+ * When a moderator removes a community.
+ */
+export type ModRemoveCommunity = {
     id: number;
     mod_person_id: PersonId;
     community_id: CommunityId;
     reason?: string;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModRemoveCommunityView.d.ts

@@ -1,8 +1,11 @@
 import type { Community } from "./Community";
 import type { ModRemoveCommunity } from "./ModRemoveCommunity";
 import type { Person } from "./Person";
-export interface ModRemoveCommunityView {
+/**
+ * When a moderator removes a community.
+ */
+export type ModRemoveCommunityView = {
     mod_remove_community: ModRemoveCommunity;
     moderator?: Person;
     community: Community;
-}
+};

package/dist/types/ModRemovePost.d.ts

@@ -1,10 +1,13 @@
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModRemovePost {
+/**
+ * When a moderator removes a post.
+ */
+export type ModRemovePost = {
     id: number;
     mod_person_id: PersonId;
     post_id: PostId;
     reason?: string;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModRemovePostView.d.ts

@@ -2,9 +2,12 @@ import type { Community } from "./Community";
 import type { ModRemovePost } from "./ModRemovePost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModRemovePostView {
+/**
+ * When a moderator removes a post.
+ */
+export type ModRemovePostView = {
     mod_remove_post: ModRemovePost;
     moderator?: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModTransferCommunity.d.ts

@@ -1,9 +1,12 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModTransferCommunity {
+/**
+ * When a moderator transfers a community to a new owner.
+ */
+export type ModTransferCommunity = {
     id: number;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
     when_: string;
-}
+};

package/dist/types/ModTransferCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModTransferCommunity } from "./ModTransferCommunity";
 import type { Person } from "./Person";
-export interface ModTransferCommunityView {
+/**
+ * When a moderator transfers a community to a new owner.
+ */
+export type ModTransferCommunityView = {
     mod_transfer_community: ModTransferCommunity;
     moderator?: Person;
     community: Community;
     modded_person: Person;
-}
+};

package/dist/types/ModlogActionType.d.ts

@@ -1 +1,4 @@
+/**
+ * A list of possible types for the various modlog actions.
+ */
 export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModHideCommunity" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment";

package/dist/types/ModlogListParams.d.ts

@@ -2,7 +2,10 @@ import type { CommentId } from "./CommentId";
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModlogListParams {
+/**
+ * Querying / filtering the modlog.
+ */
+export type ModlogListParams = {
     community_id?: CommunityId;
     mod_person_id?: PersonId;
     other_person_id?: PersonId;
@@ -11,4 +14,4 @@ export interface ModlogListParams {
     page?: number;
     limit?: number;
     hide_modlog_names: boolean;
-}
+};

package/dist/types/MyUserInfo.d.ts

@@ -5,7 +5,10 @@ import type { Instance } from "./Instance";
 import type { LanguageId } from "./LanguageId";
 import type { LocalUserView } from "./LocalUserView";
 import type { Person } from "./Person";
-export interface MyUserInfo {
+/**
+ * Your user info.
+ */
+export type MyUserInfo = {
     local_user_view: LocalUserView;
     follows: Array<CommunityFollowerView>;
     moderates: Array<CommunityModeratorView>;
@@ -13,4 +16,4 @@ export interface MyUserInfo {
     instance_blocks: Array<Instance>;
     person_blocks: Array<Person>;
     discussion_languages: Array<LanguageId>;
-}
+};

package/dist/types/OAuthAccount.d.ts

@@ -1,9 +1,12 @@
 import type { LocalUserId } from "./LocalUserId";
 import type { OAuthProviderId } from "./OAuthProviderId";
-export interface OAuthAccount {
+/**
+ * An auth account method.
+ */
+export type OAuthAccount = {
     local_user_id: LocalUserId;
     oauth_provider_id: OAuthProviderId;
     oauth_user_id: string;
     published: string;
     updated?: string;
-}
+};

package/dist/types/OAuthProvider.d.ts

@@ -1,17 +1,59 @@
 import type { OAuthProviderId } from "./OAuthProviderId";
-export interface OAuthProvider {
+/**
+ * oauth provider with client_secret - should never be sent to the client
+ */
+export type OAuthProvider = {
     id: OAuthProviderId;
+    /**
+     * The OAuth 2.0 provider name displayed to the user on the Login page
+     */
     display_name: string;
+    /**
+     * The issuer url of the OAUTH provider.
+     */
     issuer: string;
+    /**
+     * The authorization endpoint is used to interact with the resource owner and obtain an
+     * authorization grant. This is usually provided by the OAUTH provider.
+     */
     authorization_endpoint: string;
+    /**
+     * The token endpoint is used by the client to obtain an access token by presenting its
+     * authorization grant or refresh token. This is usually provided by the OAUTH provider.
+     */
     token_endpoint: string;
+    /**
+     * The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the
+     * authenticated End-User. This is defined in the OIDC specification.
+     */
     userinfo_endpoint: string;
+    /**
+     * The OAuth 2.0 claim containing the unique user ID returned by the provider. Usually this
+     * should be set to "sub".
+     */
     id_claim: string;
+    /**
+     * The client_id is provided by the OAuth 2.0 provider and is a unique identifier to this
+     * service
+     */
     client_id: string;
+    /**
+     * Lists the scopes requested from users. Users will have to grant access to the requested scope
+     * at sign up.
+     */
     scopes: string;
+    /**
+     * Automatically sets email as verified on registration
+     */
     auto_verify_email: boolean;
+    /**
+     * Allows linking an OAUTH account to an existing user account by matching emails
+     */
     account_linking_enabled: boolean;
+    /**
+     * switch to enable or disable an oauth provider
+     */
     enabled: boolean;
     published: string;
     updated?: string;
-}
+};

package/dist/types/OAuthProviderId.d.ts

@@ -1 +1,4 @@
+/**
+ * The oauth provider id.
+ */
 export type OAuthProviderId = number;

package/dist/types/OpenGraphData.d.ts

@@ -1,6 +1,10 @@
-export interface OpenGraphData {
+import type { DbUrl } from "./DbUrl";
+/**
+ * Site metadata, from its opengraph tags.
+ */
+export type OpenGraphData = {
     title?: string;
     description?: string;
-    image?: string;
-    embed_video_url?: string;
-}
+    image?: DbUrl;
+    embed_video_url?: DbUrl;
+};

package/dist/types/OpenGraphData.js

@@ -1,3 +1,2 @@
 "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/PaginationCursor.d.ts

@@ -1 +1,7 @@
+/**
+ * currently this is just a wrapper around post id, but should be seen as opaque from the client's
+ * perspective. stringified since we might want to use arbitrary info later, with a P prepended to
+ * prevent ossification (api users love to make assumptions (e.g. parse stuff that looks like
+ * numbers as numbers) about apis that aren't part of the spec
+ */
 export type PaginationCursor = string;

package/dist/types/PasswordChangeAfterReset.d.ts

@@ -1,5 +1,9 @@
-export interface PasswordChangeAfterReset {
-    token: string;
-    password: string;
-    password_verify: string;
-}
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Change your password after receiving a reset request.
+ */
+export type PasswordChangeAfterReset = {
+    token: SensitiveString;
+    password: SensitiveString;
+    password_verify: SensitiveString;
+};

package/dist/types/PasswordChangeAfterReset.js

@@ -1,3 +1,2 @@
 "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/PasswordReset.d.ts

@@ -1,3 +1,7 @@
-export interface PasswordReset {
-    email: string;
-}
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Reset your password via email.
+ */
+export type PasswordReset = {
+    email: SensitiveString;
+};

package/dist/types/PasswordReset.js

@@ -1,3 +1,2 @@
 "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/PendingFollow.d.ts

@@ -0,0 +1,9 @@
+import type { Community } from "./Community";
+import type { Person } from "./Person";
+import type { SubscribedType } from "./SubscribedType";
+export type PendingFollow = {
+    person: Person;
+    community: Community;
+    is_new_instance: boolean;
+    subscribed: SubscribedType;
+};

package/dist/types/PendingFollow.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Person.d.ts

@@ -1,20 +1,57 @@
+import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
 import type { PersonId } from "./PersonId";
-export interface Person {
+/**
+ * A person.
+ */
+export type Person = {
     id: PersonId;
     name: string;
+    /**
+     * A shorter display name.
+     */
     display_name?: string;
-    avatar?: string;
+    /**
+     * A URL for an avatar.
+     */
+    avatar?: DbUrl;
+    /**
+     * Whether the person is banned.
+     */
     banned: boolean;
     published: string;
     updated?: string;
-    actor_id: string;
+    /**
+     * The federated actor_id.
+     */
+    actor_id: DbUrl;
+    /**
+     * An optional bio, in markdown.
+     */
     bio?: string;
+    /**
+     * Whether the person is local to our site.
+     */
     local: boolean;
-    banner?: string;
+    /**
+     * A URL for a banner.
+     */
+    banner?: DbUrl;
+    /**
+     * Whether the person is deleted.
+     */
     deleted: boolean;
+    /**
+     * A matrix id, usually given an @person:matrix.org
+     */
     matrix_user_id?: string;
+    /**
+     * Whether the person is a bot account.
+     */
     bot_account: boolean;
+    /**
+     * When their ban, if it exists, expires, if at all.
+     */
     ban_expires?: string;
     instance_id: InstanceId;
-}
+};

package/dist/types/PersonAggregates.d.ts

@@ -1,6 +1,9 @@
 import type { PersonId } from "./PersonId";
-export interface PersonAggregates {
+/**
+ * Aggregate data for a person.
+ */
+export type PersonAggregates = {
     person_id: PersonId;
     post_count: number;
     comment_count: number;
-}
+};

package/dist/types/PersonId.d.ts

@@ -1 +1,4 @@
+/**
+ * The person id.
+ */
 export type PersonId = number;

package/dist/types/PersonMention.d.ts

@@ -1,10 +1,13 @@
 import type { CommentId } from "./CommentId";
 import type { PersonId } from "./PersonId";
 import type { PersonMentionId } from "./PersonMentionId";
-export interface PersonMention {
+/**
+ * A person mention.
+ */
+export type PersonMention = {
     id: PersonMentionId;
     recipient_id: PersonId;
     comment_id: CommentId;
     read: boolean;
     published: string;
-}
+};

package/dist/types/PersonMentionId.d.ts

@@ -1 +1,4 @@
+/**
+ * The person mention id.
+ */
 export type PersonMentionId = number;

package/dist/types/PersonMentionResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PersonMentionView } from "./PersonMentionView";
-export interface PersonMentionResponse {
+/**
+ * The response for a person mention action.
+ */
+export type PersonMentionResponse = {
     person_mention_view: PersonMentionView;
-}
+};

package/dist/types/PersonMentionView.d.ts

@@ -5,7 +5,10 @@ import type { Person } from "./Person";
 import type { PersonMention } from "./PersonMention";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface PersonMentionView {
+/**
+ * A person mention view.
+ */
+export type PersonMentionView = {
     person_mention: PersonMention;
     comment: Comment;
     creator: Person;
@@ -21,4 +24,4 @@ export interface PersonMentionView {
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
-}
+};

package/dist/types/PersonView.d.ts

@@ -1,7 +1,10 @@
 import type { Person } from "./Person";
 import type { PersonAggregates } from "./PersonAggregates";
-export interface PersonView {
+/**
+ * A person view.
+ */
+export type PersonView = {
     person: Person;
     counts: PersonAggregates;
     is_admin: boolean;
-}
+};