notefeed 0.3.0 → 0.5.0

package/dist/generated/core/utils.gen.js

@@ -0,0 +1,87 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { serializeArrayParam, serializeObjectParam, serializePrimitiveParam, } from './pathSerializer.gen.js';
+export const PATH_PARAM_RE = /\{[^{}]+\}/g;
+export const defaultPathSerializer = ({ path, url: _url }) => {
+    let url = _url;
+    const matches = _url.match(PATH_PARAM_RE);
+    if (matches) {
+        for (const match of matches) {
+            let explode = false;
+            let name = match.substring(1, match.length - 1);
+            let style = 'simple';
+            if (name.endsWith('*')) {
+                explode = true;
+                name = name.substring(0, name.length - 1);
+            }
+            if (name.startsWith('.')) {
+                name = name.substring(1);
+                style = 'label';
+            }
+            else if (name.startsWith(';')) {
+                name = name.substring(1);
+                style = 'matrix';
+            }
+            const value = path[name];
+            if (value === undefined || value === null) {
+                continue;
+            }
+            if (Array.isArray(value)) {
+                url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
+                continue;
+            }
+            if (typeof value === 'object') {
+                url = url.replace(match, serializeObjectParam({
+                    explode,
+                    name,
+                    style,
+                    value: value,
+                    valueOnly: true,
+                }));
+                continue;
+            }
+            if (style === 'matrix') {
+                url = url.replace(match, `;${serializePrimitiveParam({
+                    name,
+                    value: value,
+                })}`);
+                continue;
+            }
+            const replaceValue = encodeURIComponent(style === 'label' ? `.${value}` : value);
+            url = url.replace(match, replaceValue);
+        }
+    }
+    return url;
+};
+export const getUrl = ({ baseUrl, path, query, querySerializer, url: _url, }) => {
+    const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
+    let url = (baseUrl ?? '') + pathUrl;
+    if (path) {
+        url = defaultPathSerializer({ path, url });
+    }
+    let search = query ? querySerializer(query) : '';
+    if (search.startsWith('?')) {
+        search = search.substring(1);
+    }
+    if (search) {
+        url += `?${search}`;
+    }
+    return url;
+};
+export function getValidRequestBody(options) {
+    const hasBody = options.body !== undefined;
+    const isSerializedBody = hasBody && options.bodySerializer;
+    if (isSerializedBody) {
+        if ('serializedBody' in options) {
+            const hasSerializedBody = options.serializedBody !== undefined && options.serializedBody !== '';
+            return hasSerializedBody ? options.serializedBody : null;
+        }
+        // not all clients implement a serializedBody property (i.e., client-axios)
+        return options.body !== '' ? options.body : null;
+    }
+    // plain/text body
+    if (hasBody) {
+        return options.body;
+    }
+    // no body was provided
+    return undefined;
+}

package/dist/generated/index.d.ts

@@ -0,0 +1,2 @@
+export { getNote, getOpenApi, getReadNote, listNotes, listReadNotes, type Options, postNote } from './sdk.gen.js';
+export type { ClientOptions, Created, Error, GetNoteData, GetNoteError, GetNoteErrors, GetNoteResponse, GetNoteResponses, GetOpenApiData, GetOpenApiResponse, GetOpenApiResponses, GetReadNoteData, GetReadNoteError, GetReadNoteErrors, GetReadNoteResponse, GetReadNoteResponses, ListNotesData, ListNotesError, ListNotesErrors, ListNotesResponse, ListNotesResponses, ListReadNotesData, ListReadNotesError, ListReadNotesErrors, ListReadNotesResponse, ListReadNotesResponses, Note, NoteList, PostForm, PostJson, PostNoteData, PostNoteError, PostNoteErrors, PostNoteResponse, PostNoteResponses } from './types.gen.js';

package/dist/generated/index.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export { getNote, getOpenApi, getReadNote, listNotes, listReadNotes, postNote } from './sdk.gen.js';

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

@@ -0,0 +1,49 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import type { GetNoteData, GetNoteErrors, GetNoteResponses, GetOpenApiData, GetOpenApiResponses, GetReadNoteData, GetReadNoteErrors, GetReadNoteResponses, ListNotesData, ListNotesErrors, ListNotesResponses, ListReadNotesData, ListReadNotesErrors, ListReadNotesResponses, PostNoteData, PostNoteErrors, PostNoteResponses } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+/**
+ * List a feed's notes
+ *
+ * Newest first. A feed with no notes (or that doesn't exist yet) is an empty list.
+ */
+export declare const listNotes: <ThrowOnError extends boolean = false>(options: Options<ListNotesData, ThrowOnError>) => RequestResult<ListNotesResponses, ListNotesErrors, ThrowOnError>;
+/**
+ * Post a note
+ *
+ * Creates the feed with its first note. Also served at `POST /{feed}`, the short form the client packages and curl one-liners use. The body is at most 102400 bytes and must be UTF-8. `application/x-www-form-urlencoded` (what `curl -d` sends) is read as raw markdown, not as form fields.
+ */
+export declare const postNote: <ThrowOnError extends boolean = false>(options: Options<PostNoteData, ThrowOnError>) => RequestResult<PostNoteResponses, PostNoteErrors, ThrowOnError>;
+/**
+ * Get one note
+ */
+export declare const getNote: <ThrowOnError extends boolean = false>(options: Options<GetNoteData, ThrowOnError>) => RequestResult<GetNoteResponses, GetNoteErrors, 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.
+ */
+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.
+ */
+export declare const getReadNote: <ThrowOnError extends boolean = false>(options: Options<GetReadNoteData, ThrowOnError>) => RequestResult<GetReadNoteResponses, GetReadNoteErrors, ThrowOnError>;
+/**
+ * This API's OpenAPI document
+ *
+ * Generated from the server's route table, with `servers` set to this instance's URL.
+ */
+export declare const getOpenApi: <ThrowOnError extends boolean = false>(options?: Options<GetOpenApiData, ThrowOnError>) => RequestResult<GetOpenApiResponses, unknown, ThrowOnError>;

package/dist/generated/sdk.gen.js

@@ -0,0 +1,52 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client } from './client.gen.js';
+/**
+ * List a feed's notes
+ *
+ * Newest first. A feed with no notes (or that doesn't exist yet) is an empty list.
+ */
+export const listNotes = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/v1/feeds/{feed}/notes',
+    ...options
+});
+/**
+ * Post a note
+ *
+ * Creates the feed with its first note. Also served at `POST /{feed}`, the short form the client packages and curl one-liners use. The body is at most 102400 bytes and must be UTF-8. `application/x-www-form-urlencoded` (what `curl -d` sends) is read as raw markdown, not as form fields.
+ */
+export const postNote = (options) => (options.client ?? client).post({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/v1/feeds/{feed}/notes',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Get one note
+ */
+export const getNote = (options) => (options.client ?? client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/api/v1/feeds/{feed}/notes/{id}',
+    ...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.
+ */
+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.
+ */
+export const getReadNote = (options) => (options.client ?? client).get({ url: '/api/v1/read/{readId}/notes/{id}', ...options });
+/**
+ * This API's OpenAPI document
+ *
+ * Generated from the server's route table, with `servers` set to this instance's URL.
+ */
+export const getOpenApi = (options) => (options?.client ?? client).get({ url: '/api/v1/openapi.json', ...options });

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,6 +1,6 @@
 {
   "name": "notefeed",
-  "version": "0.3.0",
+  "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",
@@ -31,7 +31,7 @@
   },
   "scripts": {
     "build": "tsc",
-    "test": "vitest run",
+    "test": "tsc && vitest run",
     "prepublishOnly": "npm run build"
   },
   "repository": {
@@ -39,7 +39,7 @@
     "url": "git+https://github.com/Marceltov/notefeed.git",
     "directory": "packages/js"
   },
-  "homepage": "https://notefeed.me/clients/",
+  "homepage": "https://docs.notefeed.me/clients/",
   "bugs": {
     "url": "https://github.com/Marceltov/notefeed/issues"
   },