notefeed 0.9.3 → 0.10.1

package/README.md

@@ -31,6 +31,6 @@ A posted note can be changed or removed: `await client.edit(id, content)` replac
 
 A feed can have a title and a description, and can be deleted: `await client.feedInfo()` returns `{ name, title, description, protected, read_url }`, `await client.updateFeed({ title, description })` replaces both (an empty string clears one) and returns the feed, and `await client.deleteFeed()` removes the feed with all its notes for good. All three take the same `{ feed, feedPassword }` options as `post`, and a feed that doesn't exist is a `NotFoundError`. Anyone who can post to a feed can do this, and deleting is permanent; there are no `notefeed` commands for it.
 
-A picture is a note of its own: `await client.post(bytes, { type: "image/png", alt: "…" })` takes a `Uint8Array` or a `Blob` (PNG, JPEG, GIF or WebP; a Blob's own type is used if you leave `type` out) and returns what a markdown post returns, with the picture's `file` and `file_url` added. Write `![](file)` in a markdown note to show it; the feed is created by its first note, and a picture that is too large is a `NoteTooLargeError`. The server checks the bytes against the declared type. `await client.update(id, { title, alt })` changes a note's title or a picture's alt text, and `await client.edit(id, content)` replaces its content. `await client.updateFeed({ title, description, image: file })` makes a picture the feed's title image (`image: ""` removes it; leaving `image` out keeps it). `notefeed post --file photo.png` posts a file (the type comes from the extension, or `--type`). To post a note with its pictures in one call, `await client.post(text, { attachments: [{ name: "chart.png", content: bytes, type: "image/png" }] })` posts them with the text in one request, and the server swaps `![](chart.png)` for each file name (`null` content posts only the pictures) (`notefeed post "…" --attach chart.png` does the same); nothing is posted when one is refused. Pictures are public to anyone with the feed's read link, and metadata such as EXIF is not removed.
+A picture is a note of its own: `await client.post(bytes, { type: "image/png", alt: "…" })` takes a `Uint8Array` or a `Blob` (PNG, JPEG, GIF or WebP; a Blob's own type is used if you leave `type` out) and returns what a markdown post returns, with the picture's `file` and `file_url` added. Write `![](file)` in a markdown note to show it; the feed is created by its first note, a picture that is too large is a `NoteTooLargeError`, and an instance that takes no pictures (`NOTEFEED_IMAGE_UPLOADS=0`) answers every picture with an `ImagesOffError`. The server checks the bytes against the declared type. `await client.update(id, { title, alt })` changes a note's title or a picture's alt text, and `await client.edit(id, content)` replaces its content. `await client.updateFeed({ title, description, image: file })` makes a picture the feed's title image (`image: ""` removes it; leaving `image` out keeps it). `notefeed post --file photo.png` posts a file (the type comes from the extension, or `--type`). To post a note with its pictures in one call, `await client.post(text, { attachments: [{ name: "chart.png", content: bytes, type: "image/png" }] })` posts them with the text in one request, and the server swaps `![](chart.png)` for each file name (`null` content posts only the pictures) (`notefeed post "…" --attach chart.png` does the same); nothing is posted when one is refused. Pictures are public to anyone with the feed's read link, and metadata such as EXIF is not removed.
 
 Full documentation: https://docs.notefeed.me/integrations/clients/

package/dist/client.d.ts

@@ -34,7 +34,7 @@ export declare class RateLimitedError extends NotefeedError {
     readonly retryAfter: number | null;
     constructor(message: string, status: number | null, code: ErrorCode | null, retryAfter: number | null);
 }
-/** No such note, or a malformed read id. */
+/** No such note, or a malformed read id; also a feed the operator removed for good (`removed`, 410). */
 export declare class NotFoundError extends NotefeedError {
 }
 /** The instance's feed or note limit, or the feed's image limit, is reached. */
@@ -43,7 +43,10 @@ export declare class LimitReachedError extends NotefeedError {
 /** The note or image is over the server's size limit. */
 export declare class NoteTooLargeError extends NotefeedError {
 }
-/** The server refused the request itself: invalid or reserved feed, empty note, bad body or parameter. */
+/** The instance takes no pictures (`NOTEFEED_IMAGE_UPLOADS=0`): an image, a replaced picture or attachments were refused. */
+export declare class ImagesOffError extends NotefeedError {
+}
+/** The server refused the request itself: invalid or reserved feed, empty note, bad body or parameter, or an image on the instance's blocklist (`blocked`, 451). */
 export declare class InvalidRequestError extends NotefeedError {
 }
 export declare class Client {

package/dist/client.js

@@ -29,7 +29,7 @@ export class RateLimitedError extends NotefeedError {
         this.retryAfter = retryAfter;
     }
 }
-/** No such note, or a malformed read id. */
+/** No such note, or a malformed read id; also a feed the operator removed for good (`removed`, 410). */
 export class NotFoundError extends NotefeedError {
 }
 /** The instance's feed or note limit, or the feed's image limit, is reached. */
@@ -38,7 +38,10 @@ export class LimitReachedError extends NotefeedError {
 /** The note or image is over the server's size limit. */
 export class NoteTooLargeError extends NotefeedError {
 }
-/** The server refused the request itself: invalid or reserved feed, empty note, bad body or parameter. */
+/** The instance takes no pictures (`NOTEFEED_IMAGE_UPLOADS=0`): an image, a replaced picture or attachments were refused. */
+export class ImagesOffError extends NotefeedError {
+}
+/** The server refused the request itself: invalid or reserved feed, empty note, bad body or parameter, or an image on the instance's blocklist (`blocked`, 451). */
 export class InvalidRequestError extends NotefeedError {
 }
 const BY_CODE = {
@@ -47,6 +50,7 @@ const BY_CODE = {
     feed_limit: LimitReachedError,
     note_limit: LimitReachedError,
     image_limit: LimitReachedError,
+    images_off: ImagesOffError,
     too_large: NoteTooLargeError,
     invalid_feed: InvalidRequestError,
     reserved_feed: InvalidRequestError,
@@ -55,6 +59,8 @@ const BY_CODE = {
     invalid_request: InvalidRequestError,
     feed_exists: InvalidRequestError,
     taken: InvalidRequestError,
+    removed: NotFoundError,
+    blocked: InvalidRequestError,
     unsupported_type: InvalidRequestError,
 };
 const IMAGE_TYPES = ["image/png", "image/jpeg", "image/gif", "image/webp"];

package/dist/generated/sdk.gen.d.ts

@@ -80,19 +80,19 @@ export declare const changeFeedPassword: <ThrowOnError extends boolean = false>(
 /**
  * Get a feed's title and description by its read id
  *
- * 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.
+ * 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`.
  */
 export declare const getReadFeed: <ThrowOnError extends boolean = false>(options: Options<GetReadFeedData, ThrowOnError>) => RequestResult<GetReadFeedResponses, GetReadFeedErrors, ThrowOnError>;
 /**
  * List a feed's notes by its read id
  *
- * 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.
+ * 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.
  */
 export declare const listReadNotes: <ThrowOnError extends boolean = false>(options: Options<ListReadNotesData, ThrowOnError>) => RequestResult<ListReadNotesResponses, ListReadNotesErrors, ThrowOnError>;
 /**
  * Get one note by its feed's read id
  *
- * Public, like the read link.
+ * Public, like the read link. A read id the operator removed is `410`.
  */
 export declare const getReadNote: <ThrowOnError extends boolean = false>(options: Options<GetReadNoteData, ThrowOnError>) => RequestResult<GetReadNoteResponses, GetReadNoteErrors, ThrowOnError>;
 /**

package/dist/generated/sdk.gen.js

@@ -133,19 +133,19 @@ export const changeFeedPassword = (options) => (options.client ?? client).put({
 /**
  * Get a feed's title and description by its read id
  *
- * 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.
+ * 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`.
  */
 export const getReadFeed = (options) => (options.client ?? client).get({ url: '/api/v1/read/{readId}', ...options });
 /**
  * List a feed's notes by its read id
  *
- * 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.
+ * 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.
  */
 export const listReadNotes = (options) => (options.client ?? client).get({ url: '/api/v1/read/{readId}/notes', ...options });
 /**
  * Get one note by its feed's read id
  *
- * Public, like the read link.
+ * Public, like the read link. A read id the operator removed is `410`.
  */
 export const getReadNote = (options) => (options.client ?? client).get({ url: '/api/v1/read/{readId}/notes/{id}', ...options });
 /**

package/dist/generated/types.gen.d.ts

@@ -194,7 +194,7 @@ export type Error = {
     /**
      * Stable machine-readable code; absent only on a 500
      */
-    code?: 'invalid_feed' | 'reserved_feed' | 'auth' | 'rate_limited' | 'too_many_attempts' | 'feed_limit' | 'note_limit' | 'image_limit' | 'empty_note' | 'too_large' | 'unsupported_type' | 'invalid_body' | 'invalid_request' | 'not_found' | 'feed_exists' | 'taken';
+    code?: 'invalid_feed' | 'reserved_feed' | 'auth' | 'rate_limited' | 'too_many_attempts' | 'feed_limit' | 'note_limit' | 'image_limit' | 'images_off' | 'empty_note' | 'too_large' | 'unsupported_type' | 'invalid_body' | 'invalid_request' | 'not_found' | 'feed_exists' | 'taken' | 'removed' | 'blocked';
 };
 export type NoteMeta = {
     /**
@@ -379,10 +379,18 @@ export type PostNoteErrors = {
      * The instance has a password, or the feed has its own, and it is missing or wrong
      */
     401: Error;
+    /**
+     * Image uploads are off on this instance (`NOTEFEED_IMAGE_UPLOADS=0`, code `images_off`): an image body, a picture replaced, or a multipart body with pictures. Stored pictures are still served
+     */
+    403: Error;
     /**
      * A password was sent for a feed that already exists without one: it can't be claimed; or the chosen read id is taken
      */
     409: Error;
+    /**
+     * The operator removed this feed for good (`removed`): its name cannot be used again
+     */
+    410: Error;
     /**
      * Markdown over 102400 bytes, or an image over NOTEFEED_MAX_IMAGE_BYTES (each picture of a multipart body too), or a multipart body over 102400 bytes plus 10 images plus 64 KiB
      */
@@ -395,6 +403,10 @@ export type PostNoteErrors = {
      * Too many posts, or wrong passwords, from this client
      */
     429: Error;
+    /**
+     * An image the operator removed, which may not be posted again in any feed (`blocked`)
+     */
+    451: Error;
     /**
      * NOTEFEED_MAX_FEEDS, NOTEFEED_MAX_NOTES_PER_FEED or NOTEFEED_MAX_IMAGES_PER_FEED reached
      */
@@ -590,6 +602,10 @@ export type EditNoteErrors = {
      * The instance has a password, or the feed has its own, and it is missing or wrong
      */
     401: Error;
+    /**
+     * Image uploads are off on this instance (`NOTEFEED_IMAGE_UPLOADS=0`, code `images_off`): an image body, a picture replaced, or a multipart body with pictures. Stored pictures are still served
+     */
+    403: Error;
     /**
      * No such note
      */
@@ -606,6 +622,10 @@ export type EditNoteErrors = {
      * Too many posts, edits and deletes, or wrong passwords, from this client
      */
     429: Error;
+    /**
+     * An image the operator removed, which may not be posted again in any feed (`blocked`)
+     */
+    451: Error;
     /**
      * NOTEFEED_MAX_IMAGES_PER_FEED reached
      */
@@ -854,6 +874,10 @@ export type GetReadFeedErrors = {
      * Malformed read id
      */
     404: Error;
+    /**
+     * The operator removed the feed this read id belonged to (`removed`)
+     */
+    410: Error;
 };
 export type GetReadFeedError = GetReadFeedErrors[keyof GetReadFeedErrors];
 export type GetReadFeedResponses = {
@@ -896,6 +920,10 @@ export type ListReadNotesErrors = {
      * Malformed read id
      */
     404: Error;
+    /**
+     * The operator removed the feed this read id belonged to (`removed`)
+     */
+    410: Error;
 };
 export type ListReadNotesError = ListReadNotesErrors[keyof ListReadNotesErrors];
 export type ListReadNotesResponses = {
@@ -925,6 +953,10 @@ export type GetReadNoteErrors = {
      * No such note, or a malformed or unknown read id
      */
     404: Error;
+    /**
+     * The operator removed the feed this read id belonged to (`removed`)
+     */
+    410: Error;
 };
 export type GetReadNoteError = GetReadNoteErrors[keyof GetReadNoteErrors];
 export type GetReadNoteResponses = {

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { AuthError, Client, ConfigError, InvalidRequestError, LimitReachedError, NotefeedError, NotFoundError, NoteTooLargeError, RateLimitedError, } from "./client.js";
+export { AuthError, Client, ConfigError, ImagesOffError, InvalidRequestError, LimitReachedError, NotefeedError, NotFoundError, NoteTooLargeError, RateLimitedError, } from "./client.js";
 export type { Attachment, ClientOptions, Created, ErrorCode, Feed, FeedSettings, Note } from "./client.js";

package/dist/index.js

@@ -1 +1 @@
-export { AuthError, Client, ConfigError, InvalidRequestError, LimitReachedError, NotefeedError, NotFoundError, NoteTooLargeError, RateLimitedError, } from "./client.js";
+export { AuthError, Client, ConfigError, ImagesOffError, InvalidRequestError, LimitReachedError, NotefeedError, NotFoundError, NoteTooLargeError, RateLimitedError, } from "./client.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notefeed",
-  "version": "0.9.3",
+  "version": "0.10.1",
   "description": "Client and CLI for notefeed, a self-hosted inbox for markdown notes that you read back as RSS.",
   "license": "Apache-2.0",
   "author": "Marcel Bruckner",