lemmy-js-client 0.20.0-private-community.9 → 0.20.0-reports-combined.0

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,63 @@
 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;
-}
+    /**
+     * switch to enable or disable PKCE
+     */
+    use_pkce: boolean;
+};

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

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

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;
-}
+};

package/dist/types/Post.d.ts

@@ -1,30 +1,82 @@
 import type { CommunityId } from "./CommunityId";
+import type { DbUrl } from "./DbUrl";
 import type { LanguageId } from "./LanguageId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface Post {
+/**
+ * A post.
+ */
+export type Post = {
     id: PostId;
     name: string;
-    url?: string;
+    /**
+     * An optional link / url for the post.
+     */
+    url?: DbUrl;
+    /**
+     * An optional post body, in markdown.
+     */
     body?: string;
     creator_id: PersonId;
     community_id: CommunityId;
+    /**
+     * Whether the post is removed.
+     */
     removed: boolean;
+    /**
+     * Whether the post is locked.
+     */
     locked: boolean;
     published: string;
     updated?: string;
+    /**
+     * Whether the post is deleted.
+     */
     deleted: boolean;
+    /**
+     * Whether the post is NSFW.
+     */
     nsfw: boolean;
+    /**
+     * A title for the link.
+     */
     embed_title?: string;
+    /**
+     * A description for the link.
+     */
     embed_description?: string;
-    thumbnail_url?: string;
-    ap_id: string;
+    /**
+     * A thumbnail picture url.
+     */
+    thumbnail_url?: DbUrl;
+    /**
+     * The federated activity id / ap_id.
+     */
+    ap_id: DbUrl;
+    /**
+     * Whether the post is local.
+     */
     local: boolean;
-    embed_video_url?: string;
+    /**
+     * A video url for the link.
+     */
+    embed_video_url?: DbUrl;
     language_id: LanguageId;
+    /**
+     * Whether the post is featured to its community.
+     */
     featured_community: boolean;
+    /**
+     * Whether the post is featured to its site.
+     */
     featured_local: boolean;
     url_content_type?: string;
+    /**
+     * An optional alt_text, usable for image posts.
+     */
     alt_text?: string;
+    /**
+     * Time at which the post will be published. None means publish immediately.
+     */
     scheduled_publish_time?: string;
-}
+};

package/dist/types/PostAggregates.d.ts

@@ -1,10 +1,18 @@
 import type { PostId } from "./PostId";
-export interface PostAggregates {
+/**
+ * Aggregate data for a post.
+ */
+export type PostAggregates = {
     post_id: PostId;
     comments: number;
     score: number;
     upvotes: number;
     downvotes: number;
     published: string;
+    /**
+     * The time of the newest comment in the post.
+     */
     newest_comment_time: string;
-}
+    report_count: number;
+    unresolved_report_count: number;
+};

package/dist/types/PostFeatureType.d.ts

@@ -1 +1,4 @@
+/**
+ * The feature type for a post.
+ */
 export type PostFeatureType = "Local" | "Community";

package/dist/types/PostId.d.ts

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

package/dist/types/PostListingMode.d.ts

@@ -1 +1,4 @@
+/**
+ * A post-view mode that changes how multiple post listings look.
+ */
 export type PostListingMode = "List" | "Card" | "SmallCard";

package/dist/types/PostReport.d.ts

@@ -1,16 +1,29 @@
+import type { DbUrl } from "./DbUrl";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
 import type { PostReportId } from "./PostReportId";
-export interface PostReport {
+/**
+ * A post report.
+ */
+export type PostReport = {
     id: PostReportId;
     creator_id: PersonId;
     post_id: PostId;
+    /**
+     * The original post title.
+     */
     original_post_name: string;
-    original_post_url?: string;
+    /**
+     * The original post url.
+     */
+    original_post_url?: DbUrl;
+    /**
+     * The original post body.
+     */
     original_post_body?: string;
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
     published: string;
     updated?: string;
-}
+};

package/dist/types/PostReportId.d.ts

@@ -1 +1,4 @@
+/**
+ * The post report id.
+ */
 export type PostReportId = number;

package/dist/types/PostReportResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PostReportView } from "./PostReportView";
-export interface PostReportResponse {
+/**
+ * The post report response.
+ */
+export type PostReportResponse = {
     post_report_view: PostReportView;
-}
+};

package/dist/types/PostReportView.d.ts

@@ -4,7 +4,10 @@ import type { Post } from "./Post";
 import type { PostAggregates } from "./PostAggregates";
 import type { PostReport } from "./PostReport";
 import type { SubscribedType } from "./SubscribedType";
-export interface PostReportView {
+/**
+ * A post report view.
+ */
+export type PostReportView = {
     post_report: PostReport;
     post: Post;
     community: Community;
@@ -22,4 +25,4 @@ export interface PostReportView {
     unread_comments: number;
     counts: PostAggregates;
     resolver?: Person;
-}
+};

package/dist/types/PostResponse.d.ts

@@ -1,4 +1,4 @@
 import type { PostView } from "./PostView";
-export interface PostResponse {
+export type PostResponse = {
     post_view: PostView;
-}
+};

package/dist/types/PostSortType.d.ts

@@ -1 +1,4 @@
+/**
+ * The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
+ */
 export type PostSortType = "Active" | "Hot" | "New" | "Old" | "TopDay" | "TopWeek" | "TopMonth" | "TopYear" | "TopAll" | "MostComments" | "NewComments" | "TopHour" | "TopSixHour" | "TopTwelveHour" | "TopThreeMonths" | "TopSixMonths" | "TopNineMonths" | "Controversial" | "Scaled";

package/dist/types/PostView.d.ts

@@ -4,7 +4,10 @@ import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { PostAggregates } from "./PostAggregates";
 import type { SubscribedType } from "./SubscribedType";
-export interface PostView {
+/**
+ * A post view.
+ */
+export type PostView = {
     post: Post;
     creator: Person;
     community: Community;
@@ -21,4 +24,4 @@ export interface PostView {
     creator_blocked: boolean;
     my_vote?: number;
     unread_comments: number;
-}
+};

package/dist/types/PrivateMessage.d.ts

@@ -1,6 +1,10 @@
+import type { DbUrl } from "./DbUrl";
 import type { PersonId } from "./PersonId";
 import type { PrivateMessageId } from "./PrivateMessageId";
-export interface PrivateMessage {
+/**
+ * A private message.
+ */
+export type PrivateMessage = {
     id: PrivateMessageId;
     creator_id: PersonId;
     recipient_id: PersonId;
@@ -9,6 +13,6 @@ export interface PrivateMessage {
     read: boolean;
     published: string;
     updated?: string;
-    ap_id: string;
+    ap_id: DbUrl;
     local: boolean;
-}
+};

package/dist/types/PrivateMessageId.d.ts

@@ -1 +1,4 @@
+/**
+ * The private message id.
+ */
 export type PrivateMessageId = number;

package/dist/types/PrivateMessageReport.d.ts

@@ -1,14 +1,20 @@
 import type { PersonId } from "./PersonId";
 import type { PrivateMessageId } from "./PrivateMessageId";
 import type { PrivateMessageReportId } from "./PrivateMessageReportId";
-export interface PrivateMessageReport {
+/**
+ * The private message report.
+ */
+export type PrivateMessageReport = {
     id: PrivateMessageReportId;
     creator_id: PersonId;
     private_message_id: PrivateMessageId;
+    /**
+     * The original text.
+     */
     original_pm_text: string;
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
     published: string;
     updated?: string;
-}
+};

package/dist/types/PrivateMessageReportId.d.ts

@@ -1 +1,4 @@
+/**
+ * The private message report id.
+ */
 export type PrivateMessageReportId = number;

package/dist/types/PrivateMessageReportResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PrivateMessageReportView } from "./PrivateMessageReportView";
-export interface PrivateMessageReportResponse {
+/**
+ * A private message report response.
+ */
+export type PrivateMessageReportResponse = {
     private_message_report_view: PrivateMessageReportView;
-}
+};

package/dist/types/PrivateMessageReportView.d.ts

@@ -1,10 +1,13 @@
 import type { Person } from "./Person";
 import type { PrivateMessage } from "./PrivateMessage";
 import type { PrivateMessageReport } from "./PrivateMessageReport";
-export interface PrivateMessageReportView {
+/**
+ * A private message report view.
+ */
+export type PrivateMessageReportView = {
     private_message_report: PrivateMessageReport;
     private_message: PrivateMessage;
     private_message_creator: Person;
     creator: Person;
     resolver?: Person;
-}
+};

package/dist/types/PrivateMessageResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PrivateMessageView } from "./PrivateMessageView";
-export interface PrivateMessageResponse {
+/**
+ * A single private message response.
+ */
+export type PrivateMessageResponse = {
     private_message_view: PrivateMessageView;
-}
+};