lemmy-js-client 1.0.0-multi-community-follow-state.0 → 1.0.0-multi-community-follow-state.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/http.d.ts CHANGED
@@ -9,11 +9,8 @@ import { BanFromCommunity } from "./types/BanFromCommunity";
9
9
  import { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
10
10
  import { MarkManyPostsAsRead } from "./types/MarkManyPostsAsRead";
11
11
  import { BanPerson } from "./types/BanPerson";
12
- import { BanPersonResponse } from "./types/BanPersonResponse";
13
12
  import { BlockCommunity } from "./types/BlockCommunity";
14
- import { BlockCommunityResponse } from "./types/BlockCommunityResponse";
15
13
  import { BlockPerson } from "./types/BlockPerson";
16
- import { BlockPersonResponse } from "./types/BlockPersonResponse";
17
14
  import { ChangePassword } from "./types/ChangePassword";
18
15
  import { CommentReportResponse } from "./types/CommentReportResponse";
19
16
  import { CommentResponse } from "./types/CommentResponse";
@@ -149,6 +146,8 @@ import { ListNotificationsResponse } from "./types/ListNotificationsResponse";
149
146
  import { ModEditPost } from "./types/ModEditPost";
150
147
  import { UpdateCommunityNotifications } from "./types/UpdateCommunityNotifications";
151
148
  import { UpdatePostNotifications } from "./types/UpdatePostNotifications";
149
+ import { MultiCommunityResponse } from "./types/MultiCommunityResponse";
150
+ import { PersonResponse } from "./types/PersonResponse";
152
151
  type RequestOptions = Pick<RequestInit, "signal">;
153
152
  /**
154
153
  * Helps build lemmy HTTP requests.
@@ -283,7 +282,7 @@ export declare class LemmyHttp extends Controller {
283
282
  /**
284
283
  * @summary Block a community.
285
284
  */
286
- blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<BlockCommunityResponse>;
285
+ blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<CommunityResponse>;
287
286
  /**
288
287
  * @summary Delete a community.
289
288
  */
@@ -355,7 +354,7 @@ export declare class LemmyHttp extends Controller {
355
354
  /**
356
355
  * @summary Hide a post from list views.
357
356
  */
358
- hidePost(form: HidePost, options?: RequestOptions): Promise<SuccessResponse>;
357
+ hidePost(form: HidePost, options?: RequestOptions): Promise<PostResponse>;
359
358
  /**
360
359
  * @summary A moderator can lock a post ( IE disable new comments ).
361
360
  */
@@ -495,7 +494,7 @@ export declare class LemmyHttp extends Controller {
495
494
  /**
496
495
  * @summary Ban a person from your site.
497
496
  */
498
- banPerson(form: BanPerson, options?: RequestOptions): Promise<BanPersonResponse>;
497
+ banPerson(form: BanPerson, options?: RequestOptions): Promise<PersonResponse>;
499
498
  /**
500
499
  * @summary Get a list of users.
501
500
  */
@@ -503,7 +502,7 @@ export declare class LemmyHttp extends Controller {
503
502
  /**
504
503
  * @summary Block a person.
505
504
  */
506
- blockPerson(form: BlockPerson, options?: RequestOptions): Promise<BlockPersonResponse>;
505
+ blockPerson(form: BlockPerson, options?: RequestOptions): Promise<PersonResponse>;
507
506
  /**
508
507
  * @summary Fetch a Captcha.
509
508
  */
@@ -752,13 +751,13 @@ export declare class LemmyHttp extends Controller {
752
751
  * Mark donation dialog as shown, so it isn't displayed anymore.
753
752
  */
754
753
  donationDialogShown(options?: RequestOptions): Promise<SuccessResponse>;
755
- createMultiCommunity(form: CreateMultiCommunity, options?: RequestOptions): Promise<GetMultiCommunityResponse>;
756
- updateMultiCommunity(form: UpdateMultiCommunity, options?: RequestOptions): Promise<SuccessResponse>;
754
+ createMultiCommunity(form: CreateMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse>;
755
+ updateMultiCommunity(form: UpdateMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse>;
757
756
  getMultiCommunity(form: GetMultiCommunityI, options?: RequestOptions): Promise<GetMultiCommunityResponse>;
758
- createMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<SuccessResponse>;
757
+ createMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<CommunityResponse>;
759
758
  deleteMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<SuccessResponse>;
760
759
  listMultiCommunities(form: ListMultiCommunitiesI, options?: RequestOptions): Promise<ListMultiCommunitiesResponse>;
761
- followMultiCommunity(form: FollowMultiCommunity, options?: RequestOptions): Promise<SuccessResponse>;
760
+ followMultiCommunity(form: FollowMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse>;
762
761
  /**
763
762
  * @summary Change notification settings for a community
764
763
  */
package/dist/index.d.ts CHANGED
@@ -43,11 +43,8 @@ export { AuthenticateWithOauth } from "./types/AuthenticateWithOauth";
43
43
  export { BanFromCommunity } from "./types/BanFromCommunity";
44
44
  export { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
45
45
  export { BanPerson } from "./types/BanPerson";
46
- export { BanPersonResponse } from "./types/BanPersonResponse";
47
46
  export { BlockCommunity } from "./types/BlockCommunity";
48
- export { BlockCommunityResponse } from "./types/BlockCommunityResponse";
49
47
  export { BlockPerson } from "./types/BlockPerson";
50
- export { BlockPersonResponse } from "./types/BlockPersonResponse";
51
48
  export { CaptchaResponse } from "./types/CaptchaResponse";
52
49
  export { ChangePassword } from "./types/ChangePassword";
53
50
  export { Comment } from "./types/Comment";
@@ -122,7 +119,6 @@ export { ExportDataResponse } from "./types/ExportDataResponse";
122
119
  export { FeaturePost } from "./types/FeaturePost";
123
120
  export { FederatedInstances } from "./types/FederatedInstances";
124
121
  export { FederationBlockList } from "./types/FederationBlockList";
125
- export { FederationError } from "./types/FederationError";
126
122
  export { FederationMode } from "./types/FederationMode";
127
123
  export { FollowCommunity } from "./types/FollowCommunity";
128
124
  export { FollowMultiCommunity } from "./types/FollowMultiCommunity";
@@ -254,6 +250,7 @@ export { ModlogCombinedView } from "./types/ModlogCombinedView";
254
250
  export { MultiCommunity } from "./types/MultiCommunity";
255
251
  export { MultiCommunityFollow } from "./types/MultiCommunityFollow";
256
252
  export { MultiCommunityId } from "./types/MultiCommunityId";
253
+ export { MultiCommunityResponse } from "./types/MultiCommunityResponse";
257
254
  export { MultiCommunityView } from "./types/MultiCommunityView";
258
255
  export { MyUserInfo } from "./types/MyUserInfo";
259
256
  export { NotePerson } from "./types/NotePerson";
@@ -277,6 +274,7 @@ export { PersonContentCombinedView } from "./types/PersonContentCombinedView";
277
274
  export { PersonContentType } from "./types/PersonContentType";
278
275
  export { PersonId } from "./types/PersonId";
279
276
  export { PersonLikedCombinedView } from "./types/PersonLikedCombinedView";
277
+ export { PersonResponse } from "./types/PersonResponse";
280
278
  export { PersonSavedCombinedView } from "./types/PersonSavedCombinedView";
281
279
  export { PersonView } from "./types/PersonView";
282
280
  export { PluginMetadata } from "./types/PluginMetadata";
@@ -346,6 +344,7 @@ export { TaglineId } from "./types/TaglineId";
346
344
  export { TaglineResponse } from "./types/TaglineResponse";
347
345
  export { TagsView } from "./types/TagsView";
348
346
  export { TransferCommunity } from "./types/TransferCommunity";
347
+ export { UntranslatedError } from "./types/UntranslatedError";
349
348
  export { UpdateCommunityNotifications } from "./types/UpdateCommunityNotifications";
350
349
  export { UpdateCommunityTag } from "./types/UpdateCommunityTag";
351
350
  export { UpdateMultiCommunity } from "./types/UpdateMultiCommunity";
@@ -2,5 +2,10 @@ export type AdminBlockInstanceParams = {
2
2
  instance: string;
3
3
  block: boolean;
4
4
  reason: string;
5
- expires_at?: string;
5
+ /**
6
+ * A time that the block will expire, in unix epoch seconds.
7
+ *
8
+ * An i64 unix timestamp is used for a simpler API client implementation.
9
+ */
10
+ expires_at?: number;
6
11
  };
@@ -1 +1 @@
1
- export declare let AllLemmyErrors: string[];
1
+ export declare const AllLemmyErrors: string[];
@@ -17,14 +17,13 @@ exports.AllLemmyErrors = [
17
17
  "email_not_verified",
18
18
  "email_required",
19
19
  "cannot_leave_admin",
20
- "cannot_leave_admin",
21
- "cannot_leave_admin",
22
- "image_url_missing_path_segments",
23
- "image_url_missing_last_path_segment",
20
+ "cannot_leave_mod",
21
+ "cannot_leave_mod",
22
+ "cannot_leave_mod",
23
+ "pictrs_api_key_not_provided",
24
24
  "pictrs_api_key_not_provided",
25
25
  "no_content_type_header",
26
26
  "not_an_image_type",
27
- "invalid_image_upload",
28
27
  "image_upload_disabled",
29
28
  "not_a_mod_or_admin",
30
29
  "not_top_mod",
@@ -90,7 +89,6 @@ exports.AllLemmyErrors = [
90
89
  "couldnt_create_audio_captcha",
91
90
  "couldnt_create_image_captcha",
92
91
  "invalid_url_scheme",
93
- "couldnt_send_webmention",
94
92
  "contradicting_filters",
95
93
  "too_many_items",
96
94
  "ban_expiration_in_past",
@@ -104,7 +102,6 @@ exports.AllLemmyErrors = [
104
102
  "oauth_login_failed",
105
103
  "oauth_registration_closed",
106
104
  "not_found",
107
- "community_has_no_followers",
108
105
  "post_schedule_time_must_be_in_future",
109
106
  "too_many_scheduled_posts",
110
107
  "cannot_combine_federation_blocklist_and_allowlist",
@@ -116,4 +113,5 @@ exports.AllLemmyErrors = [
116
113
  "multi_community_update_wrong_user",
117
114
  "cannot_combine_community_id_and_multi_community_id",
118
115
  "multi_community_entry_limit_reached",
116
+ "too_many_requests",
119
117
  ];
@@ -23,5 +23,7 @@ export type CommentReportView = {
23
23
  creator_is_admin: boolean;
24
24
  creator_is_moderator: boolean;
25
25
  creator_banned: boolean;
26
+ creator_ban_expires_at?: string;
26
27
  creator_banned_from_community: boolean;
28
+ creator_community_ban_expires_at?: string;
27
29
  };
@@ -12,5 +12,7 @@ export type CommunityReportView = {
12
12
  creator_is_admin: boolean;
13
13
  creator_is_moderator: boolean;
14
14
  creator_banned: boolean;
15
+ creator_ban_expires_at?: string;
15
16
  creator_banned_from_community: boolean;
17
+ creator_community_ban_expires_at?: string;
16
18
  };
@@ -1,4 +1,5 @@
1
1
  import type { MultiCommunityId } from "./MultiCommunityId";
2
2
  export type GetMultiCommunity = {
3
- id: MultiCommunityId;
3
+ id?: MultiCommunityId;
4
+ name?: string;
4
5
  };
@@ -1,4 +1,7 @@
1
- import type { FederationError } from "./FederationError";
1
+ import type { UntranslatedError } from "./UntranslatedError";
2
+ /**
3
+ * Errors used in the API, all of these are translated in lemmy-ui.
4
+ */
2
5
  export type LemmyErrorType = {
3
6
  error: "block_keyword_too_short";
4
7
  } | {
@@ -37,18 +40,15 @@ export type LemmyErrorType = {
37
40
  } | {
38
41
  error: "pictrs_purge_response_error";
39
42
  message: string;
40
- } | {
41
- error: "image_url_missing_path_segments";
42
- } | {
43
- error: "image_url_missing_last_path_segment";
44
43
  } | {
45
44
  error: "pictrs_api_key_not_provided";
45
+ } | {
46
+ error: "pictrs_invalid_image_upload";
47
+ message: string;
46
48
  } | {
47
49
  error: "no_content_type_header";
48
50
  } | {
49
51
  error: "not_an_image_type";
50
- } | {
51
- error: "invalid_image_upload";
52
52
  } | {
53
53
  error: "image_upload_disabled";
54
54
  } | {
@@ -183,8 +183,6 @@ export type LemmyErrorType = {
183
183
  error: "couldnt_create_image_captcha";
184
184
  } | {
185
185
  error: "invalid_url_scheme";
186
- } | {
187
- error: "couldnt_send_webmention";
188
186
  } | {
189
187
  error: "contradicting_filters";
190
188
  } | {
@@ -212,8 +210,6 @@ export type LemmyErrorType = {
212
210
  error: "oauth_registration_closed";
213
211
  } | {
214
212
  error: "not_found";
215
- } | {
216
- error: "community_has_no_followers";
217
213
  } | {
218
214
  error: "post_schedule_time_must_be_in_future";
219
215
  } | {
@@ -221,9 +217,9 @@ export type LemmyErrorType = {
221
217
  } | {
222
218
  error: "cannot_combine_federation_blocklist_and_allowlist";
223
219
  } | {
224
- error: "federation_error";
220
+ error: "untranslated_error";
225
221
  message: {
226
- error?: FederationError;
222
+ error?: UntranslatedError;
227
223
  };
228
224
  } | {
229
225
  error: "couldnt_parse_pagination_token";
@@ -240,4 +236,6 @@ export type LemmyErrorType = {
240
236
  error: "cannot_combine_community_id_and_multi_community_id";
241
237
  } | {
242
238
  error: "multi_community_entry_limit_reached";
239
+ } | {
240
+ error: "too_many_requests";
243
241
  };
@@ -0,0 +1,4 @@
1
+ import type { MultiCommunityView } from "./MultiCommunityView";
2
+ export type MultiCommunityResponse = {
3
+ multi_community_view: MultiCommunityView;
4
+ };
@@ -1,4 +1,14 @@
1
+ import type { AdminAddId } from "./AdminAddId";
2
+ import type { AdminBanId } from "./AdminBanId";
3
+ import type { AdminRemoveCommunityId } from "./AdminRemoveCommunityId";
1
4
  import type { CommentId } from "./CommentId";
5
+ import type { ModAddToCommunityId } from "./ModAddToCommunityId";
6
+ import type { ModBanFromCommunityId } from "./ModBanFromCommunityId";
7
+ import type { ModLockCommentId } from "./ModLockCommentId";
8
+ import type { ModLockPostId } from "./ModLockPostId";
9
+ import type { ModRemoveCommentId } from "./ModRemoveCommentId";
10
+ import type { ModRemovePostId } from "./ModRemovePostId";
11
+ import type { ModTransferCommunityId } from "./ModTransferCommunityId";
2
12
  import type { NotificationId } from "./NotificationId";
3
13
  import type { NotificationType } from "./NotificationType";
4
14
  import type { PersonId } from "./PersonId";
@@ -13,4 +23,14 @@ export type Notification = {
13
23
  kind: NotificationType;
14
24
  post_id?: PostId;
15
25
  private_message_id?: PrivateMessageId;
26
+ admin_add_id?: AdminAddId;
27
+ mod_add_to_community_id?: ModAddToCommunityId;
28
+ admin_ban_id?: AdminBanId;
29
+ mod_ban_from_community_id?: ModBanFromCommunityId;
30
+ mod_lock_post_id?: ModLockPostId;
31
+ mod_remove_comment_id?: ModRemoveCommentId;
32
+ admin_remove_community_id?: AdminRemoveCommunityId;
33
+ mod_remove_post_id?: ModRemovePostId;
34
+ mod_lock_comment_id?: ModLockCommentId;
35
+ mod_transfer_community_id?: ModTransferCommunityId;
16
36
  };
@@ -1,4 +1,14 @@
1
+ import type { AdminAdd } from "./AdminAdd";
2
+ import type { AdminBan } from "./AdminBan";
3
+ import type { AdminRemoveCommunity } from "./AdminRemoveCommunity";
1
4
  import type { CommentView } from "./CommentView";
5
+ import type { ModAddToCommunity } from "./ModAddToCommunity";
6
+ import type { ModBanFromCommunity } from "./ModBanFromCommunity";
7
+ import type { ModLockComment } from "./ModLockComment";
8
+ import type { ModLockPost } from "./ModLockPost";
9
+ import type { ModRemoveComment } from "./ModRemoveComment";
10
+ import type { ModRemovePost } from "./ModRemovePost";
11
+ import type { ModTransferCommunity } from "./ModTransferCommunity";
2
12
  import type { PostView } from "./PostView";
3
13
  import type { PrivateMessageView } from "./PrivateMessageView";
4
14
  export type NotificationData = ({
@@ -7,4 +17,24 @@ export type NotificationData = ({
7
17
  type_: "Post";
8
18
  } & PostView) | ({
9
19
  type_: "PrivateMessage";
10
- } & PrivateMessageView);
20
+ } & PrivateMessageView) | ({
21
+ type_: "AdminAdd";
22
+ } & AdminAdd) | ({
23
+ type_: "ModAddToCommunity";
24
+ } & ModAddToCommunity) | ({
25
+ type_: "AdminBan";
26
+ } & AdminBan) | ({
27
+ type_: "ModBanFromCommunity";
28
+ } & ModBanFromCommunity) | ({
29
+ type_: "ModLockPost";
30
+ } & ModLockPost) | ({
31
+ type_: "ModLockComment";
32
+ } & ModLockComment) | ({
33
+ type_: "ModRemovePost";
34
+ } & ModRemovePost) | ({
35
+ type_: "ModRemoveComment";
36
+ } & ModRemoveComment) | ({
37
+ type_: "AdminRemoveCommunity";
38
+ } & AdminRemoveCommunity) | ({
39
+ type_: "ModTransferCommunity";
40
+ } & ModTransferCommunity);
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * Types of notifications which can be received in inbox
3
3
  */
4
- export type NotificationType = "Mention" | "Reply" | "Subscribed" | "PrivateMessage";
4
+ export type NotificationType = "Mention" | "Reply" | "Subscribed" | "PrivateMessage" | "ModAction";
@@ -0,0 +1,7 @@
1
+ import type { PersonView } from "./PersonView";
2
+ /**
3
+ * A person response for actions done to a person.
4
+ */
5
+ export type PersonResponse = {
6
+ person_view: PersonView;
7
+ };
@@ -21,5 +21,7 @@ export type PostReportView = {
21
21
  creator_is_admin: boolean;
22
22
  creator_is_moderator: boolean;
23
23
  creator_banned: boolean;
24
+ creator_ban_expires_at?: string;
24
25
  creator_banned_from_community: boolean;
26
+ creator_community_ban_expires_at?: string;
25
27
  };
@@ -12,4 +12,5 @@ export type PrivateMessageReportView = {
12
12
  resolver?: Person;
13
13
  creator_is_admin: boolean;
14
14
  creator_banned: boolean;
15
+ creator_ban_expires_at?: string;
15
16
  };
@@ -0,0 +1,12 @@
1
+ /**
2
+ * These errors are only used for federation or internally and dont need to be translated.
3
+ */
4
+ export type UntranslatedError = "InvalidCommunity" | "CannotCreatePostOrCommentInDeletedOrRemovedCommunity" | "CannotReceivePage" | "OnlyLocalAdminCanRemoveCommunity" | "OnlyLocalAdminCanRestoreCommunity" | "PostIsLocked" | {
5
+ PersonIsBannedFromSite: string;
6
+ } | "InvalidVoteValue" | "PageDoesNotSpecifyCreator" | "FederationDisabled" | {
7
+ DomainBlocked: string;
8
+ } | {
9
+ DomainNotInAllowList: string;
10
+ } | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | {
11
+ InvalidFollow: string;
12
+ } | "PurgeInvalidImageUrl" | "Unreachable" | "CouldntSendWebmention" | "CommunityHasNoFollowers";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "lemmy-js-client",
3
3
  "description": "A javascript / typescript client for Lemmy",
4
- "version": "1.0.0-multi-community-follow-state.0",
4
+ "version": "1.0.0-multi-community-follow-state.2",
5
5
  "author": "Dessalines",
6
6
  "license": "AGPL-3.0",
7
7
  "main": "./dist/index.js",
@@ -1,8 +0,0 @@
1
- import type { PersonView } from "./PersonView";
2
- /**
3
- * A response for a banned person.
4
- */
5
- export type BanPersonResponse = {
6
- person_view: PersonView;
7
- banned: boolean;
8
- };
@@ -1,8 +0,0 @@
1
- import type { CommunityView } from "./CommunityView";
2
- /**
3
- * The block community response.
4
- */
5
- export type BlockCommunityResponse = {
6
- community_view: CommunityView;
7
- blocked: boolean;
8
- };
@@ -1,8 +0,0 @@
1
- import type { PersonView } from "./PersonView";
2
- /**
3
- * The response for a person block.
4
- */
5
- export type BlockPersonResponse = {
6
- person_view: PersonView;
7
- blocked: boolean;
8
- };
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,12 +0,0 @@
1
- /**
2
- * Federation related errors, these dont need to be translated.
3
- */
4
- export type FederationError = "InvalidCommunity" | "CannotCreatePostOrCommentInDeletedOrRemovedCommunity" | "CannotReceivePage" | "OnlyLocalAdminCanRemoveCommunity" | "OnlyLocalAdminCanRestoreCommunity" | "PostIsLocked" | {
5
- PersonIsBannedFromSite: string;
6
- } | "InvalidVoteValue" | "PageDoesNotSpecifyCreator" | "FederationDisabled" | {
7
- DomainBlocked: string;
8
- } | {
9
- DomainNotInAllowList: string;
10
- } | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | {
11
- InvalidFollow: string;
12
- } | "Unreachable";