notefeed 0.33.0 → 0.34.0

package/README.md

@@ -27,6 +27,8 @@ Every note has a date, now unless you give one: `client.post(text, { date: "2025
 
 A note posted with `draft: true` (`notefeed post "…" --draft`) is a draft: readers don't see it, or its pictures, until `client.update(id, { draft: false })` (`notefeed update <id> --publish`) publishes it at its date; `draft: true` (`--draft`) hides it again.
 
+Where the operator took a post down for breaking the instance's content rules, a list has a mark in its place: a note with `removed: true`, type `application/x-notefeed-removed`, the removed note's id and date, no content and `file_url` null. Getting it alone or editing it throws `NotFoundError` (code `removed`, 410), and so does the removed note's id after the mark is gone; `client.delete(id)` (`notefeed delete <id>`) takes the mark off the feed, and the note does not come back.
+
 `Client.fromEnv()` reads `NOTEFEED_URL` / `NOTEFEED_FEED` / `NOTEFEED_PASSWORD`; so does the `notefeed` command, unless given `--url` / `--feed` / `--password`.
 
 A feed can have its own password, which gates reading, listing and posting to it. Pass `feedPassword: "..."` to `new Client(...)` (or per call, e.g. `client.post(text, { feedPassword })`), or set `NOTEFEED_FEED_PASSWORD`, which `fromEnv()` and the `notefeed` command both read (there is deliberately no flag, so it stays out of shell history). It is sent as `X-Feed-Password`; `Authorization` stays the instance password. A feed password is 1 to 256 printable ASCII characters with no space at the start or end; an empty one is the same as none.

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; also a feed the operator removed for good (`removed`, 410). */
+/** No such note, or a malformed read id; also a feed or a note 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. */

package/dist/client.js

@@ -29,7 +29,7 @@ export class RateLimitedError extends NotefeedError {
         this.retryAfter = retryAfter;
     }
 }
-/** No such note, or a malformed read id; also a feed the operator removed for good (`removed`, 410). */
+/** No such note, or a malformed read id; also a feed or a note 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. */

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

@@ -7,7 +7,7 @@ export type Note = {
      */
     id: string;
     /**
-     * The media type of the note's file: `text/markdown`, `image/png`, `image/jpeg`, `image/gif` or `image/webp`
+     * The media type of the note's file: `text/markdown`, `image/png`, `image/jpeg`, `image/gif` or `image/webp`; `application/x-notefeed-removed` for the operator's mark (see `removed`)
      */
     type: string;
     /**
@@ -66,6 +66,10 @@ export type Note = {
      * 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
      */
     unreadable?: true;
+    /**
+     * Present, and true, for the mark the operator left where a post was removed for breaking the content rules (type `application/x-notefeed-removed`): it has the removed note's id and date, no content, an empty title, size 0, and `file_url` null; getting it alone is a 410 with the code `removed`, and so is any edit. Deleting it works; the post does not come back. Absent for every other note
+     */
+    removed?: true;
 };
 export type NoteList = {
     /**
@@ -144,7 +148,7 @@ export type NoteEdited = {
      */
     id: string;
     /**
-     * The media type of the note's file: `text/markdown`, `image/png`, `image/jpeg`, `image/gif` or `image/webp`
+     * The media type of the note's file: `text/markdown`, `image/png`, `image/jpeg`, `image/gif` or `image/webp`; `application/x-notefeed-removed` for the operator's mark (see `removed`)
      */
     type: string;
     /**
@@ -203,6 +207,10 @@ export type NoteEdited = {
      * 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
      */
     unreadable?: true;
+    /**
+     * Present, and true, for the mark the operator left where a post was removed for breaking the content rules (type `application/x-notefeed-removed`): it has the removed note's id and date, no content, an empty title, size 0, and `file_url` null; getting it alone is a 410 with the code `removed`, and so is any edit. Deleting it works; the post does not come back. Absent for every other note
+     */
+    removed?: true;
     /**
      * A multipart request's pictures, one per `file` part, in their order; absent for a raw body
      */
@@ -310,11 +318,11 @@ export type FeedSettings = {
 };
 export type FreeTier = {
     /**
-     * The feed's text notes now
+     * The feed's notes now: texts, images and the operator's marks alike
      */
     notes: number;
     /**
-     * How many text notes a free feed keeps; past it, each new note drops the oldest one
+     * How many notes a free feed keeps; past it, each new note drops the oldest one, of any kind
      */
     cap: number;
 };
@@ -660,6 +668,10 @@ export type GetNoteErrors = {
      * No such note
      */
     404: Error;
+    /**
+     * The operator removed this note (`removed`, #159): for good, also once its mark is deleted; the mark itself can't be edited
+     */
+    410: Error;
     /**
      * Too many wrong passwords from this client
      */
@@ -715,6 +727,10 @@ export type PatchNoteErrors = {
      * The note, or a picture posted with it, is the feed's title image, so it cannot become a draft (`title_image`)
      */
     409: Error;
+    /**
+     * The operator removed this note (`removed`, #159): for good, also once its mark is deleted; the mark itself can't be edited
+     */
+    410: Error;
     /**
      * Content-Type is not application/json
      */
@@ -785,6 +801,10 @@ export type EditNoteErrors = {
      * No such note
      */
     404: Error;
+    /**
+     * The operator removed this note (`removed`, #159): for good, also once its mark is deleted; the mark itself can't be edited
+     */
+    410: Error;
     /**
      * Markdown over 102400 bytes, or an image over NOTEFEED_MAX_IMAGE_BYTES or 100 megapixels (each picture of a multipart body too), or a multipart body over 102400 bytes plus 10 images plus 64 KiB, and never over 64 MiB
      */
@@ -1478,7 +1498,7 @@ export type GetReadNoteErrors = {
      */
     404: Error;
     /**
-     * The operator removed the feed this read id belonged to (`removed`)
+     * The operator removed the feed this read id belonged to, or this note (`removed`)
      */
     410: Error;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notefeed",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "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",