notefeed 0.10.0 → 0.10.1

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.
@@ -80,19 +80,19 @@ export declare const changeFeedPassword: <ThrowOnError extends boolean = false>(
80
80
  /**
81
81
  * Get a feed's title and description by its read id
82
82
  *
83
- * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id has an empty title and description, so read ids can't be probed.
83
+ * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id has an empty title and description, so read ids can't be probed; one the operator removed is `410`.
84
84
  */
85
85
  export declare const getReadFeed: <ThrowOnError extends boolean = false>(options: Options<GetReadFeedData, ThrowOnError>) => RequestResult<GetReadFeedResponses, GetReadFeedErrors, ThrowOnError>;
86
86
  /**
87
87
  * List a feed's notes by its read id
88
88
  *
89
- * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id is an empty list, so read ids can't be probed. The same notes as the read link's RSS.
89
+ * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id is an empty list, so read ids can't be probed; one the operator removed is `410`. The same notes as the read link's RSS.
90
90
  */
91
91
  export declare const listReadNotes: <ThrowOnError extends boolean = false>(options: Options<ListReadNotesData, ThrowOnError>) => RequestResult<ListReadNotesResponses, ListReadNotesErrors, ThrowOnError>;
92
92
  /**
93
93
  * Get one note by its feed's read id
94
94
  *
95
- * Public, like the read link.
95
+ * Public, like the read link. A read id the operator removed is `410`.
96
96
  */
97
97
  export declare const getReadNote: <ThrowOnError extends boolean = false>(options: Options<GetReadNoteData, ThrowOnError>) => RequestResult<GetReadNoteResponses, GetReadNoteErrors, ThrowOnError>;
98
98
  /**
@@ -133,19 +133,19 @@ export const changeFeedPassword = (options) => (options.client ?? client).put({
133
133
  /**
134
134
  * Get a feed's title and description by its read id
135
135
  *
136
- * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id has an empty title and description, so read ids can't be probed.
136
+ * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id has an empty title and description, so read ids can't be probed; one the operator removed is `410`.
137
137
  */
138
138
  export const getReadFeed = (options) => (options.client ?? client).get({ url: '/api/v1/read/{readId}', ...options });
139
139
  /**
140
140
  * List a feed's notes by its read id
141
141
  *
142
- * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id is an empty list, so read ids can't be probed. The same notes as the read link's RSS.
142
+ * Public, even on an instance with a password, and never reveals the feed's name. An unknown read id is an empty list, so read ids can't be probed; one the operator removed is `410`. The same notes as the read link's RSS.
143
143
  */
144
144
  export const listReadNotes = (options) => (options.client ?? client).get({ url: '/api/v1/read/{readId}/notes', ...options });
145
145
  /**
146
146
  * Get one note by its feed's read id
147
147
  *
148
- * Public, like the read link.
148
+ * Public, like the read link. A read id the operator removed is `410`.
149
149
  */
150
150
  export const getReadNote = (options) => (options.client ?? client).get({ url: '/api/v1/read/{readId}/notes/{id}', ...options });
151
151
  /**
@@ -874,6 +874,10 @@ export type GetReadFeedErrors = {
874
874
  * Malformed read id
875
875
  */
876
876
  404: Error;
877
+ /**
878
+ * The operator removed the feed this read id belonged to (`removed`)
879
+ */
880
+ 410: Error;
877
881
  };
878
882
  export type GetReadFeedError = GetReadFeedErrors[keyof GetReadFeedErrors];
879
883
  export type GetReadFeedResponses = {
@@ -916,6 +920,10 @@ export type ListReadNotesErrors = {
916
920
  * Malformed read id
917
921
  */
918
922
  404: Error;
923
+ /**
924
+ * The operator removed the feed this read id belonged to (`removed`)
925
+ */
926
+ 410: Error;
919
927
  };
920
928
  export type ListReadNotesError = ListReadNotesErrors[keyof ListReadNotesErrors];
921
929
  export type ListReadNotesResponses = {
@@ -945,6 +953,10 @@ export type GetReadNoteErrors = {
945
953
  * No such note, or a malformed or unknown read id
946
954
  */
947
955
  404: Error;
956
+ /**
957
+ * The operator removed the feed this read id belonged to (`removed`)
958
+ */
959
+ 410: Error;
948
960
  };
949
961
  export type GetReadNoteError = GetReadNoteErrors[keyof GetReadNoteErrors];
950
962
  export type GetReadNoteResponses = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "notefeed",
3
- "version": "0.10.0",
3
+ "version": "0.10.1",
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",