notefeed 0.2.0 → 0.5.0

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

@@ -0,0 +1,276 @@
+export type ClientOptions = {
+    baseUrl: 'https://notefeed.me' | (string & {});
+};
+export type Note = {
+    /**
+     * UTC time to the second plus a slug of the title
+     */
+    id: string;
+    /**
+     * The first heading, or the first non-empty line; may be empty
+     */
+    title: string;
+    /**
+     * The note, byte-for-byte as posted
+     */
+    markdown: string;
+    /**
+     * When the note was posted (UTC)
+     */
+    created_at: string;
+    /**
+     * The note's page in the web UI
+     */
+    url: string;
+};
+export type NoteList = {
+    /**
+     * Newest first
+     */
+    notes: Array<Note>;
+    /**
+     * Pass as `before` for the next (older) page; null on the last page
+     */
+    next: string | null;
+};
+export type Created = {
+    id: string;
+    /**
+     * The note's page in the web UI
+     */
+    url: string;
+    /**
+     * The feed's page in the web UI
+     */
+    feed_url: string;
+    /**
+     * The feed's read-only RSS link, safe to share
+     */
+    read_url: string;
+};
+export type Error = {
+    /**
+     * A short reason, for people
+     */
+    error: string;
+    /**
+     * Stable machine-readable code; absent only on a 500
+     */
+    code?: 'invalid_feed' | 'reserved_feed' | 'auth' | 'rate_limited' | 'too_many_attempts' | 'feed_limit' | 'note_limit' | 'empty_note' | 'too_large' | 'unsupported_type' | 'invalid_body' | 'invalid_request' | 'not_found';
+};
+export type PostJson = {
+    markdown: string;
+};
+export type PostForm = {
+    markdown: string;
+};
+export type ListNotesData = {
+    body?: never;
+    path: {
+        /**
+         * The feed's name. It is the write key: anyone who knows it can post.
+         */
+        feed: string;
+    };
+    query?: {
+        /**
+         * Notes per page, 1–100
+         */
+        limit?: number;
+        /**
+         * Only notes older than this id: the previous page's `next`
+         */
+        before?: string;
+    };
+    url: '/api/v1/feeds/{feed}/notes';
+};
+export type ListNotesErrors = {
+    /**
+     * Invalid or reserved feed name, or a bad `limit` / `before`
+     */
+    400: Error;
+    /**
+     * The instance has a password and it is missing or wrong
+     */
+    401: Error;
+    /**
+     * Too many wrong passwords from this client
+     */
+    429: Error;
+};
+export type ListNotesError = ListNotesErrors[keyof ListNotesErrors];
+export type ListNotesResponses = {
+    /**
+     * A page of notes
+     */
+    200: NoteList;
+};
+export type ListNotesResponse = ListNotesResponses[keyof ListNotesResponses];
+export type PostNoteData = {
+    body: PostJson;
+    path: {
+        /**
+         * The feed's name. It is the write key: anyone who knows it can post.
+         */
+        feed: string;
+    };
+    query?: never;
+    url: '/api/v1/feeds/{feed}/notes';
+};
+export type PostNoteErrors = {
+    /**
+     * Invalid or reserved feed name; empty note; bad JSON, form or UTF-8
+     */
+    400: Error;
+    /**
+     * The instance has a password and it is missing or wrong
+     */
+    401: Error;
+    /**
+     * Body over 102400 bytes
+     */
+    413: Error;
+    /**
+     * Unsupported content type
+     */
+    415: Error;
+    /**
+     * Too many posts, or wrong passwords, from this client
+     */
+    429: Error;
+    /**
+     * NOTEFEED_MAX_FEEDS or NOTEFEED_MAX_NOTES_PER_FEED reached
+     */
+    507: Error;
+};
+export type PostNoteError = PostNoteErrors[keyof PostNoteErrors];
+export type PostNoteResponses = {
+    /**
+     * Stored
+     */
+    201: Created;
+};
+export type PostNoteResponse = PostNoteResponses[keyof PostNoteResponses];
+export type GetNoteData = {
+    body?: never;
+    path: {
+        /**
+         * The feed's name. It is the write key: anyone who knows it can post.
+         */
+        feed: string;
+        /**
+         * The note's id
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/feeds/{feed}/notes/{id}';
+};
+export type GetNoteErrors = {
+    /**
+     * Invalid or reserved feed name
+     */
+    400: Error;
+    /**
+     * The instance has a password and it is missing or wrong
+     */
+    401: Error;
+    /**
+     * No such note
+     */
+    404: Error;
+    /**
+     * Too many wrong passwords from this client
+     */
+    429: Error;
+};
+export type GetNoteError = GetNoteErrors[keyof GetNoteErrors];
+export type GetNoteResponses = {
+    /**
+     * The note
+     */
+    200: Note;
+};
+export type GetNoteResponse = GetNoteResponses[keyof GetNoteResponses];
+export type ListReadNotesData = {
+    body?: never;
+    path: {
+        /**
+         * The feed's read id, from its read link. Read-only; never reveals the name.
+         */
+        readId: string;
+    };
+    query?: {
+        /**
+         * Notes per page, 1–100
+         */
+        limit?: number;
+        /**
+         * Only notes older than this id: the previous page's `next`
+         */
+        before?: string;
+    };
+    url: '/api/v1/read/{readId}/notes';
+};
+export type ListReadNotesErrors = {
+    /**
+     * A bad `limit` / `before`
+     */
+    400: Error;
+    /**
+     * Malformed read id
+     */
+    404: Error;
+};
+export type ListReadNotesError = ListReadNotesErrors[keyof ListReadNotesErrors];
+export type ListReadNotesResponses = {
+    /**
+     * A page of notes
+     */
+    200: NoteList;
+};
+export type ListReadNotesResponse = ListReadNotesResponses[keyof ListReadNotesResponses];
+export type GetReadNoteData = {
+    body?: never;
+    path: {
+        /**
+         * The feed's read id, from its read link. Read-only; never reveals the name.
+         */
+        readId: string;
+        /**
+         * The note's id
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/read/{readId}/notes/{id}';
+};
+export type GetReadNoteErrors = {
+    /**
+     * No such note, or a malformed or unknown read id
+     */
+    404: Error;
+};
+export type GetReadNoteError = GetReadNoteErrors[keyof GetReadNoteErrors];
+export type GetReadNoteResponses = {
+    /**
+     * The note
+     */
+    200: Note;
+};
+export type GetReadNoteResponse = GetReadNoteResponses[keyof GetReadNoteResponses];
+export type GetOpenApiData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/openapi.json';
+};
+export type GetOpenApiResponses = {
+    /**
+     * OpenAPI 3.1
+     */
+    200: {
+        [key: string]: unknown;
+    };
+};
+export type GetOpenApiResponse = GetOpenApiResponses[keyof GetOpenApiResponses];

package/dist/generated/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/index.d.ts

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

package/dist/index.js

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

package/package.json

@@ -1,8 +1,18 @@
 {
   "name": "notefeed",
-  "version": "0.2.0",
-  "description": "Post markdown notes to a notefeed server, from Node or the command line.",
-  "license": "MIT",
+  "version": "0.5.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",
+  "keywords": [
+    "notefeed",
+    "notes",
+    "markdown",
+    "rss",
+    "self-hosted",
+    "homelab",
+    "cli"
+  ],
   "type": "module",
   "exports": {
     ".": {
@@ -21,7 +31,7 @@
   },
   "scripts": {
     "build": "tsc",
-    "test": "vitest run",
+    "test": "tsc && vitest run",
     "prepublishOnly": "npm run build"
   },
   "repository": {
@@ -29,7 +39,10 @@
     "url": "git+https://github.com/Marceltov/notefeed.git",
     "directory": "packages/js"
   },
-  "homepage": "https://marceltov.github.io/notefeed/clients/",
+  "homepage": "https://docs.notefeed.me/clients/",
+  "bugs": {
+    "url": "https://github.com/Marceltov/notefeed/issues"
+  },
   "devDependencies": {
     "@types/node": "^20",
     "typescript": "^5.9",