notefeed 0.17.0 → 0.19.0

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.
@@ -54,6 +54,10 @@ export type Note = {
54
54
  * Labels the poster gave the note (not verified, and shown to readers like the note itself); empty when none
55
55
  */
56
56
  tags: Array<string>;
57
+ /**
58
+ * Present, and true, for a damaged note: its stored copy can't be decrypted. A list shows it in its place, with its id, file, type and time; its title and tags are empty, its size 0, it has no content, and reading it alone is a 500 with the code `unreadable`. Deleting it works. Absent for every other note
59
+ */
60
+ unreadable?: true;
57
61
  };
58
62
  export type NoteList = {
59
63
  /**
@@ -171,6 +175,10 @@ export type NoteEdited = {
171
175
  * Labels the poster gave the note (not verified, and shown to readers like the note itself); empty when none
172
176
  */
173
177
  tags: Array<string>;
178
+ /**
179
+ * Present, and true, for a damaged note: its stored copy can't be decrypted. A list shows it in its place, with its id, file, type and time; its title and tags are empty, its size 0, it has no content, and reading it alone is a 500 with the code `unreadable`. Deleting it works. Absent for every other note
180
+ */
181
+ unreadable?: true;
174
182
  /**
175
183
  * A multipart request's pictures, one per `file` part, in their order; absent for a raw body
176
184
  */
@@ -194,7 +202,7 @@ export type Error = {
194
202
  /**
195
203
  * Stable machine-readable code; absent only on a 500
196
204
  */
197
- code?: 'invalid_feed' | 'reserved_feed' | 'auth' | 'rate_limited' | 'too_many_attempts' | 'feed_limit' | 'note_limit' | 'image_limit' | 'images_off' | 'license_required' | 'empty_note' | 'too_large' | 'unsupported_type' | 'invalid_body' | 'invalid_request' | 'not_found' | 'feed_exists' | 'taken' | 'removed' | 'blocked';
205
+ code?: 'invalid_feed' | 'reserved_feed' | 'auth' | 'rate_limited' | 'too_many_attempts' | 'feed_limit' | 'note_limit' | 'image_limit' | 'images_off' | 'license_required' | 'empty_note' | 'too_large' | 'unsupported_type' | 'invalid_body' | 'invalid_request' | 'not_found' | 'feed_exists' | 'taken' | 'removed' | 'blocked' | 'unreadable' | 'unavailable';
198
206
  };
199
207
  export type NoteMeta = {
200
208
  /**
@@ -335,6 +343,10 @@ export type ListNotesErrors = {
335
343
  * Too many wrong passwords from this client
336
344
  */
337
345
  429: Error;
346
+ /**
347
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
348
+ */
349
+ 503: Error;
338
350
  };
339
351
  export type ListNotesError = ListNotesErrors[keyof ListNotesErrors];
340
352
  export type ListNotesResponses = {
@@ -429,6 +441,10 @@ export type PostNoteErrors = {
429
441
  * An image the operator removed, which may not be posted again in any feed (`blocked`)
430
442
  */
431
443
  451: Error;
444
+ /**
445
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
446
+ */
447
+ 503: Error;
432
448
  /**
433
449
  * NOTEFEED_MAX_FEEDS, NOTEFEED_MAX_NOTES_PER_FEED or NOTEFEED_MAX_IMAGES_PER_FEED reached
434
450
  */
@@ -480,6 +496,10 @@ export type DeleteNoteErrors = {
480
496
  * Too many posts, edits and deletes, or wrong passwords, from this client
481
497
  */
482
498
  429: Error;
499
+ /**
500
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
501
+ */
502
+ 503: Error;
483
503
  };
484
504
  export type DeleteNoteError = DeleteNoteErrors[keyof DeleteNoteErrors];
485
505
  export type DeleteNoteResponses = {
@@ -527,6 +547,10 @@ export type GetNoteErrors = {
527
547
  * Too many wrong passwords from this client
528
548
  */
529
549
  429: Error;
550
+ /**
551
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
552
+ */
553
+ 503: Error;
530
554
  };
531
555
  export type GetNoteError = GetNoteErrors[keyof GetNoteErrors];
532
556
  export type GetNoteResponses = {
@@ -578,6 +602,10 @@ export type PatchNoteErrors = {
578
602
  * Too many posts, edits and deletes, or wrong passwords, from this client
579
603
  */
580
604
  429: Error;
605
+ /**
606
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
607
+ */
608
+ 503: Error;
581
609
  };
582
610
  export type PatchNoteError = PatchNoteErrors[keyof PatchNoteErrors];
583
611
  export type PatchNoteResponses = {
@@ -652,6 +680,10 @@ export type EditNoteErrors = {
652
680
  * An image the operator removed, which may not be posted again in any feed (`blocked`)
653
681
  */
654
682
  451: Error;
683
+ /**
684
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
685
+ */
686
+ 503: Error;
655
687
  /**
656
688
  * NOTEFEED_MAX_IMAGES_PER_FEED reached
657
689
  */
@@ -699,6 +731,10 @@ export type DeleteFeedErrors = {
699
731
  * Too many posts, edits and deletes, or wrong passwords, from this client
700
732
  */
701
733
  429: Error;
734
+ /**
735
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
736
+ */
737
+ 503: Error;
702
738
  };
703
739
  export type DeleteFeedError = DeleteFeedErrors[keyof DeleteFeedErrors];
704
740
  export type DeleteFeedResponses = {
@@ -742,6 +778,10 @@ export type GetFeedErrors = {
742
778
  * Too many wrong passwords from this client
743
779
  */
744
780
  429: Error;
781
+ /**
782
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
783
+ */
784
+ 503: Error;
745
785
  };
746
786
  export type GetFeedError = GetFeedErrors[keyof GetFeedErrors];
747
787
  export type GetFeedResponses = {
@@ -789,6 +829,10 @@ export type UpdateFeedErrors = {
789
829
  * Too many posts, edits and deletes, or wrong passwords, from this client
790
830
  */
791
831
  429: Error;
832
+ /**
833
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
834
+ */
835
+ 503: Error;
792
836
  };
793
837
  export type UpdateFeedError = UpdateFeedErrors[keyof UpdateFeedErrors];
794
838
  export type UpdateFeedResponses = {
@@ -832,6 +876,10 @@ export type RemoveFeedPasswordErrors = {
832
876
  * Too many wrong passwords from this client
833
877
  */
834
878
  429: Error;
879
+ /**
880
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
881
+ */
882
+ 503: Error;
835
883
  };
836
884
  export type RemoveFeedPasswordError = RemoveFeedPasswordErrors[keyof RemoveFeedPasswordErrors];
837
885
  export type RemoveFeedPasswordResponses = {
@@ -879,6 +927,10 @@ export type ChangeFeedPasswordErrors = {
879
927
  * Too many wrong passwords from this client
880
928
  */
881
929
  429: Error;
930
+ /**
931
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
932
+ */
933
+ 503: Error;
882
934
  };
883
935
  export type ChangeFeedPasswordError = ChangeFeedPasswordErrors[keyof ChangeFeedPasswordErrors];
884
936
  export type ChangeFeedPasswordResponses = {
@@ -908,6 +960,10 @@ export type GetReadFeedErrors = {
908
960
  * The operator removed the feed this read id belonged to (`removed`)
909
961
  */
910
962
  410: Error;
963
+ /**
964
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
965
+ */
966
+ 503: Error;
911
967
  };
912
968
  export type GetReadFeedError = GetReadFeedErrors[keyof GetReadFeedErrors];
913
969
  export type GetReadFeedResponses = {
@@ -954,6 +1010,10 @@ export type ListReadNotesErrors = {
954
1010
  * The operator removed the feed this read id belonged to (`removed`)
955
1011
  */
956
1012
  410: Error;
1013
+ /**
1014
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
1015
+ */
1016
+ 503: Error;
957
1017
  };
958
1018
  export type ListReadNotesError = ListReadNotesErrors[keyof ListReadNotesErrors];
959
1019
  export type ListReadNotesResponses = {
@@ -987,6 +1047,10 @@ export type GetReadNoteErrors = {
987
1047
  * The operator removed the feed this read id belonged to (`removed`)
988
1048
  */
989
1049
  410: Error;
1050
+ /**
1051
+ * The key service is unreachable: the instance is down for maintenance; try again after Retry-After
1052
+ */
1053
+ 503: Error;
990
1054
  };
991
1055
  export type GetReadNoteError = GetReadNoteErrors[keyof GetReadNoteErrors];
992
1056
  export type GetReadNoteResponses = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "notefeed",
3
- "version": "0.17.0",
3
+ "version": "0.19.0",
4
4
  "description": "Client and CLI for notefeed, a self-hosted inbox for markdown notes that you read back as RSS.",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Marcel Bruckner",