notefeed 0.1.0 → 0.2.0

package/README.md

@@ -12,8 +12,10 @@ backup.sh 2>&1 | npx notefeed post -
 ```js
 import { Client } from "notefeed";
 
-const note = await new Client().post("# Deploy done\nversion 1.4.2"); // reads NOTEFEED_URL / NOTEFEED_TOKEN
-console.log(note.url);
+const client = new Client({ url: "https://notes.example.com", token }); // URL and token set once
+console.log((await client.post("# Deploy done\nversion 1.4.2")).url);
 ```
 
+The `notefeed` command reads `--url` / `--token`, or `NOTEFEED_URL` / `NOTEFEED_TOKEN`. The library itself never reads the environment.
+
 Full documentation: https://marceltov.github.io/notefeed/clients/

package/dist/cli.js

@@ -33,7 +33,13 @@ export async function main(argv, io = process) {
         if (command !== "post" || rest.length)
             throw new UsageError(USAGE);
         const markdown = await read(text, values.file, io);
-        const note = await new Client({ url: values.url, token: values.token }).post(markdown);
+        const url = values.url || process.env.NOTEFEED_URL;
+        const token = values.token || process.env.NOTEFEED_TOKEN;
+        if (!url)
+            throw new UsageError("no URL given; pass --url or set NOTEFEED_URL");
+        if (!token)
+            throw new UsageError("no token given; pass --token or set NOTEFEED_TOKEN");
+        const note = await new Client({ url, token }).post(markdown);
         io.stdout.write(`${note.url}\n`);
         return 0;
     }

package/dist/client.d.ts

@@ -4,8 +4,8 @@ export type Note = {
     url: string;
 };
 export type ClientOptions = {
-    url?: string;
-    token?: string;
+    url: string;
+    token: string;
     timeoutMs?: number;
 };
 /** Any failure talking to notefeed. `status` is the HTTP status, or null (network, config). */
@@ -29,8 +29,7 @@ export declare class Client {
     readonly url: string;
     private readonly token;
     private readonly timeoutMs;
-    constructor(options?: ClientOptions);
+    /** A notefeed server. URL and token are set once here; post() takes only the note. */
+    constructor(options: ClientOptions);
     post(markdown: string): Promise<Note>;
 }
-/** Post one note. Options go to Client (url, token, timeoutMs). */
-export declare function post(markdown: string, options?: ClientOptions): Promise<Note>;

package/dist/client.js

@@ -26,23 +26,23 @@ const ERRORS = {
     401: AuthError,
     413: NoteTooLargeError,
 };
-function setting(value, env) {
-    const v = value || process.env[env] || "";
-    if (!v)
-        throw new ConfigError(`no ${env.split("_")[1].toLowerCase()} given; pass it or set ${env}`);
-    return v;
-}
 export class Client {
     url;
     token;
     timeoutMs;
-    constructor(options = {}) {
-        this.url = setting(options.url, "NOTEFEED_URL").replace(/\/+$/, "");
-        this.token = setting(options.token, "NOTEFEED_TOKEN").trim();
+    /** A notefeed server. URL and token are set once here; post() takes only the note. */
+    constructor(options) {
+        const { url, token, timeoutMs } = options ?? {};
+        if (!url)
+            throw new ConfigError("no url given");
+        if (!token?.trim())
+            throw new ConfigError("no token given");
+        this.url = url.replace(/\/+$/, "");
+        this.token = token.trim();
         // Never echo the value: it would end up in terminals and CI logs.
         if (/[\x00-\x1f\x7f]/.test(this.token))
-            throw new ConfigError("NOTEFEED_TOKEN contains invalid characters");
-        this.timeoutMs = options.timeoutMs ?? 10_000;
+            throw new ConfigError("token contains invalid characters");
+        this.timeoutMs = timeoutMs ?? 10_000;
     }
     async post(markdown) {
         let res;
@@ -81,7 +81,3 @@ export class Client {
         throw new NotefeedError(`unexpected response from ${this.url} (not a notefeed server?)`, res.status);
     }
 }
-/** Post one note. Options go to Client (url, token, timeoutMs). */
-export function post(markdown, options) {
-    return new Client(options).post(markdown);
-}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { AuthError, Client, ConfigError, InvalidNoteError, NotefeedError, NoteTooLargeError, post } from "./client.js";
+export { AuthError, Client, ConfigError, InvalidNoteError, NotefeedError, NoteTooLargeError } from "./client.js";
 export type { ClientOptions, Note } from "./client.js";

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notefeed",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Post markdown notes to a notefeed server, from Node or the command line.",
   "license": "MIT",
   "type": "module",