@muspellheim/shared 0.14.0 → 0.16.0

package/dist/shared.d.ts

@@ -125,17 +125,17 @@ export declare class ConfigurableResponses<T = unknown> {
     next(): T;
 }
 
-export declare interface ConsoleMessage {
-    level: "log" | "error" | "warn" | "info" | "debug" | "trace";
-    message: unknown[];
-}
-
 /**
- * A stub for the console interface.
+ * Wraps the console interface and allow setting the log level.
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Console_API
  */
-export declare class ConsoleStub extends EventTarget {
+export declare class ConsoleLog extends EventTarget implements Log {
+    #private;
+    static create(): ConsoleLog;
+    static createNull(): ConsoleLog;
+    level: LogLevel;
+    private constructor();
     log(...data: unknown[]): void;
     error(...data: unknown[]): void;
     warn(...data: unknown[]): void;
@@ -146,6 +146,12 @@ export declare class ConsoleStub extends EventTarget {
      * Track the console messages.
      */
     trackMessages(): OutputTracker<ConsoleMessage>;
+    isLoggable(level: LogLevel): boolean;
+}
+
+export declare interface ConsoleMessage {
+    level: LogLevel;
+    message: unknown[];
 }
 
 /**
@@ -222,7 +228,7 @@ export declare const HEARTBEAT_TYPE = "heartbeat";
 /**
  * A simple logging facade.
  *
- * This is a subset of the `console` interface.
+ * This is a subset of the `Console` interface.
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Console_API
  */
@@ -235,6 +241,9 @@ export declare interface Log {
     trace(...data: unknown[]): void;
 }
 
+/** Defines level for setting a log level in a `Log` implementation. */
+export declare type LogLevel = "log" | "error" | "warn" | "info" | "debug" | "trace" | "off";
+
 /**
  * An interface for a streaming message client.
  *
@@ -393,8 +402,10 @@ export declare class SseClient extends EventTarget implements MessageClient {
 /**
  * A successful status.
  */
-export declare class Success {
+export declare class Success<T = unknown> {
     readonly isSuccess = true;
+    readonly result?: T;
+    constructor(result?: T);
 }
 
 /**

package/dist/shared.js

@@ -26,9 +26,9 @@ class c {
   static offset(t, e) {
     return new c(new Date(t.millis() + e));
   }
-  #e;
+  #t;
   constructor(t) {
-    this.#e = t;
+    this.#t = t;
   }
   /**
    * Return the current timestamp of the clock.
@@ -36,7 +36,7 @@ class c {
    * @return The current timestamp.
    */
   date() {
-    return this.#e ? new Date(this.#e) : /* @__PURE__ */ new Date();
+    return this.#t ? new Date(this.#t) : /* @__PURE__ */ new Date();
   }
   /**
    * Return the current timestamp of the clock in milliseconds.
@@ -47,7 +47,7 @@ class c {
     return this.date().getTime();
   }
 }
-class p {
+class f {
   /**
    * Create a tracker for a specific event of an event target.
    *
@@ -55,10 +55,10 @@ class p {
    * @param event The event name to track.
    */
   static create(t, ...e) {
-    return new p(t, e);
+    return new f(t, e);
   }
-  #e;
   #t;
+  #e;
   #s;
   #r;
   /**
@@ -68,8 +68,8 @@ class p {
    * @param event The event name to track.
    */
   constructor(t, e) {
-    this.#e = t, this.#t = e, this.#s = [], this.#r = (s) => this.#s.push(s), this.#t.forEach(
-      (s) => this.#e.addEventListener(s, this.#r)
+    this.#t = t, this.#e = e, this.#s = [], this.#r = (s) => this.#s.push(s), this.#e.forEach(
+      (s) => this.#t.addEventListener(s, this.#r)
     );
   }
   /**
@@ -93,8 +93,8 @@ class p {
    * Stop tracking.
    */
   stop() {
-    this.#t.forEach(
-      (t) => this.#e.removeEventListener(t, this.#r)
+    this.#e.forEach(
+      (t) => this.#t.removeEventListener(t, this.#r)
     );
   }
   /**
@@ -105,20 +105,24 @@ class p {
   async waitFor(t = 1) {
     return new Promise((e) => {
       const s = () => {
-        this.#s.length >= t && (this.#t.forEach(
-          (r) => this.#e.removeEventListener(r, s)
+        this.#s.length >= t && (this.#e.forEach(
+          (r) => this.#t.removeEventListener(r, s)
         ), e(this.events));
       };
-      this.#t.forEach(
-        (r) => this.#e.addEventListener(r, s)
+      this.#e.forEach(
+        (r) => this.#t.addEventListener(r, s)
       ), s();
     });
   }
 }
-class m {
+class S {
   isSuccess = !0;
+  result;
+  constructor(t) {
+    this.result = t;
+  }
 }
-class S {
+class L {
   isSuccess = !1;
   errorMessage;
   /**
@@ -130,7 +134,7 @@ class S {
     this.errorMessage = t;
   }
 }
-class u {
+class l {
   /**
    * Create a list of responses (by providing an array), or a single repeating
    * response (by providing any other type). 'Name' is optional and used in
@@ -140,7 +144,7 @@ class u {
    * @param name An optional name for the responses.
    */
   static create(t, e) {
-    return new u(t, e);
+    return new l(t, e);
   }
   /**
    * Convert all properties in an object into ConfigurableResponse instances.
@@ -152,13 +156,13 @@ class u {
    */
   static mapObject(t, e) {
     const r = Object.entries(t).map(([h, n]) => {
-      const l = e === void 0 ? void 0 : `${e}: ${h}`;
-      return [h, u.create(n, l)];
+      const d = e === void 0 ? void 0 : `${e}: ${h}`;
+      return [h, l.create(n, d)];
     });
     return Object.fromEntries(r);
   }
-  #e;
   #t;
+  #e;
   /**
    * Create a list of responses (by providing an array), or a single repeating
    * response (by providing any other type). 'Name' is optional and used in
@@ -168,7 +172,7 @@ class u {
    * @param name An optional name for the responses.
    */
   constructor(t, e) {
-    this.#e = e == null ? "" : ` in ${e}`, this.#t = Array.isArray(t) ? [...t] : t;
+    this.#t = e == null ? "" : ` in ${e}`, this.#e = Array.isArray(t) ? [...t] : t;
   }
   /**
    * Get the next configured response. Throws an error when configured with a list
@@ -177,13 +181,13 @@ class u {
    * @return The next response.
    */
   next() {
-    const t = Array.isArray(this.#t) ? this.#t.shift() : this.#t;
+    const t = Array.isArray(this.#e) ? this.#e.shift() : this.#e;
     if (t === void 0)
-      throw new Error(`No more responses configured${this.#e}.`);
+      throw new Error(`No more responses configured${this.#t}.`);
     return t;
   }
 }
-class d {
+class u {
   /**
    * Create a tracker for a specific event of an event target.
    *
@@ -191,10 +195,10 @@ class d {
    * @param event The event name to track.
    */
   static create(t, e) {
-    return new d(t, e);
+    return new u(t, e);
   }
-  #e;
   #t;
+  #e;
   #s;
   #r;
   /**
@@ -204,7 +208,7 @@ class d {
    * @param event The event name to track.
    */
   constructor(t, e) {
-    this.#e = t, this.#t = e, this.#s = [], this.#r = (s) => this.#s.push(s.detail), this.#e.addEventListener(this.#t, this.#r);
+    this.#t = t, this.#e = e, this.#s = [], this.#r = (s) => this.#s.push(s.detail), this.#t.addEventListener(this.#e, this.#r);
   }
   /**
    * Return the tracked data.
@@ -227,84 +231,120 @@ class d {
    * Stop tracking.
    */
   stop() {
-    this.#e.removeEventListener(this.#t, this.#r);
+    this.#t.removeEventListener(this.#e, this.#r);
   }
 }
 const i = "message";
-class b extends EventTarget {
+class E extends EventTarget {
+  static create() {
+    return new E(globalThis.console);
+  }
+  static createNull() {
+    return new E(new p());
+  }
+  level = "info";
+  #t;
+  constructor(t) {
+    super(), this.#t = t;
+  }
   log(...t) {
-    this.dispatchEvent(
+    this.isLoggable("log") && (this.#t.log(...t), this.dispatchEvent(
       new CustomEvent(i, {
         detail: { level: "log", message: t }
       })
-    );
+    ));
   }
   error(...t) {
-    this.dispatchEvent(
+    this.isLoggable("error") && (this.#t.error(...t), this.dispatchEvent(
       new CustomEvent(i, {
         detail: { level: "error", message: t }
       })
-    );
+    ));
   }
   warn(...t) {
-    this.dispatchEvent(
+    this.isLoggable("warn") && (this.#t.warn(...t), this.dispatchEvent(
       new CustomEvent(i, {
         detail: { level: "warn", message: t }
       })
-    );
+    ));
   }
   info(...t) {
-    this.dispatchEvent(
+    this.isLoggable("info") && (this.#t.info(...t), this.dispatchEvent(
       new CustomEvent(i, {
         detail: { level: "info", message: t }
       })
-    );
+    ));
   }
   debug(...t) {
-    this.dispatchEvent(
+    this.isLoggable("debug") && (this.#t.debug(...t), this.dispatchEvent(
       new CustomEvent(i, {
         detail: { level: "debug", message: t }
       })
-    );
+    ));
   }
   trace(...t) {
-    this.dispatchEvent(
+    this.isLoggable("trace") && (this.#t.trace(...t), this.dispatchEvent(
       new CustomEvent(i, {
         detail: { level: "trace", message: t }
       })
-    );
+    ));
   }
   /**
    * Track the console messages.
    */
   trackMessages() {
-    return new d(this, i);
+    return new u(this, i);
+  }
+  isLoggable(t) {
+    const e = (n) => n === "log" ? "info" : n, s = [
+      "off",
+      "error",
+      "warn",
+      "info",
+      "debug",
+      "trace"
+    ], r = s.indexOf(e(this.level));
+    return s.indexOf(e(t)) <= r;
+  }
+}
+class p {
+  log(...t) {
+  }
+  error(...t) {
+  }
+  warn(...t) {
+  }
+  info(...t) {
+  }
+  debug(...t) {
+  }
+  trace(...t) {
   }
 }
 function N(a) {
-  const t = u.create(a);
+  const t = l.create(a);
   return async function() {
     const e = t.next();
     if (e instanceof Error)
       throw e;
-    return new g(e);
+    return new y(e);
   };
 }
-class g {
-  #e;
+class y {
   #t;
+  #e;
   #s;
   constructor({ status: t, statusText: e, body: s = null }) {
-    this.#e = t, this.#t = e, this.#s = s;
+    this.#t = t, this.#e = e, this.#s = s;
   }
   get ok() {
     return this.status >= 200 && this.status < 300;
   }
   get status() {
-    return this.#e;
+    return this.#t;
   }
   get statusText() {
-    return this.#t;
+    return this.#e;
   }
   async blob() {
     if (this.#s == null)
@@ -321,14 +361,14 @@ class g {
     return this.#s == null ? "" : String(this.#s);
   }
 }
-class E extends EventTarget {
+class v extends EventTarget {
   /**
    * Create an SSE client.
    *
    * @return A new SSE client.
    */
   static create() {
-    return new E(EventSource);
+    return new v(EventSource);
   }
   /**
    * Create a nulled SSE client.
@@ -336,18 +376,18 @@ class E extends EventTarget {
    * @return A new SSE client.
    */
   static createNull() {
-    return new E(o);
+    return new v(o);
   }
-  #e;
   #t;
+  #e;
   constructor(t) {
-    super(), this.#e = t;
+    super(), this.#t = t;
   }
   get isConnected() {
-    return this.#t?.readyState === this.#e.OPEN;
+    return this.#e?.readyState === this.#t.OPEN;
   }
   get url() {
-    return this.#t?.url;
+    return this.#e?.url;
   }
   async connect(t, e = "message", ...s) {
     await new Promise((r, h) => {
@@ -356,18 +396,18 @@ class E extends EventTarget {
         return;
       }
       try {
-        this.#t = new this.#e(t), this.#t.addEventListener("open", (n) => {
+        this.#e = new this.#t(t), this.#e.addEventListener("open", (n) => {
           this.#s(n), r();
-        }), this.#t.addEventListener(
+        }), this.#e.addEventListener(
           e,
           (n) => this.#r(n)
         );
         for (const n of s)
-          this.#t.addEventListener(
+          this.#e.addEventListener(
             n,
-            (l) => this.#r(l)
+            (d) => this.#r(d)
           );
-        this.#t.addEventListener(
+        this.#e.addEventListener(
           "error",
           (n) => this.#n(n)
         );
@@ -386,7 +426,7 @@ class E extends EventTarget {
         return;
       }
       try {
-        this.#t.close(), t();
+        this.#e.close(), t();
       } catch (s) {
         e(s);
       }
@@ -439,8 +479,8 @@ class o extends EventTarget {
     this.readyState = o.CLOSED;
   }
 }
-const y = "heartbeat", w = "message-sent";
-class v extends EventTarget {
+const m = "heartbeat", w = "message-sent";
+class g extends EventTarget {
   /**
    * Create a WebSocket client.
    *
@@ -451,7 +491,7 @@ class v extends EventTarget {
     heartbeat: t = 3e4,
     retry: e = 1e3
   } = {}) {
-    return new v(t, e, WebSocket);
+    return new g(t, e, WebSocket);
   }
   /**
    * Create a nulled WebSocket client.
@@ -460,20 +500,20 @@ class v extends EventTarget {
    * @return A new nulled WebSocket client.
    */
   static createNull({ heartbeat: t = 0, retry: e = 0 } = {}) {
-    return new v(
+    return new g(
       t,
       e,
-      f
+      b
     );
   }
-  #e;
   #t;
+  #e;
   #s;
   #r;
   #n;
   #i;
   constructor(t, e, s) {
-    super(), this.#e = t, this.#t = e, this.#s = s;
+    super(), this.#t = t, this.#e = e, this.#s = s;
   }
   get isConnected() {
     return this.#r?.readyState === WebSocket.OPEN;
@@ -489,7 +529,7 @@ class v extends EventTarget {
       }
       try {
         this.#r = new this.#s(t), this.#r.addEventListener("open", (r) => {
-          this.#d(r), e();
+          this.#u(r), e();
         }), this.#r.addEventListener(
           "message",
           (r) => this.#a(r)
@@ -512,7 +552,7 @@ class v extends EventTarget {
    * @return A new output tracker.
    */
   trackMessageSent() {
-    return d.create(this, w);
+    return u.create(this, w);
   }
   /**
    * Close the connection.
@@ -543,7 +583,7 @@ class v extends EventTarget {
    * Simulate a heartbeat.
    */
   simulateHeartbeat() {
-    this.#u();
+    this.#l();
   }
   /**
    * Simulate a close event.
@@ -560,7 +600,7 @@ class v extends EventTarget {
   simulateError() {
     this.#r?.close(), this.#o(new Event("error"));
   }
-  #d(t) {
+  #u(t) {
     this.dispatchEvent(new Event(t.type, t)), this.#E();
   }
   #a(t) {
@@ -572,31 +612,31 @@ class v extends EventTarget {
     this.#v(), this.dispatchEvent(new CloseEvent(t.type, t));
   }
   #o(t) {
-    this.dispatchEvent(new Event(t.type, t)), this.#l();
+    this.dispatchEvent(new Event(t.type, t)), this.#d();
   }
-  #l() {
-    this.#t <= 0 || (this.#i = setInterval(
+  #d() {
+    this.#e <= 0 || (this.#i = setInterval(
       () => this.connect(this.#r.url),
-      this.#t
+      this.#e
     ));
   }
   #c() {
     clearInterval(this.#i), this.#i = void 0;
   }
   #E() {
-    this.#e <= 0 || (this.#n = setInterval(
-      () => this.#u(),
-      this.#e
+    this.#t <= 0 || (this.#n = setInterval(
+      () => this.#l(),
+      this.#t
     ));
   }
   #v() {
     clearInterval(this.#n), this.#n = void 0;
   }
-  #u() {
-    this.#n != null && this.send(y);
+  #l() {
+    this.#n != null && this.send(m);
   }
 }
-class f extends EventTarget {
+class b extends EventTarget {
   url;
   readyState = WebSocket.CONNECTING;
   constructor(t) {
@@ -612,15 +652,15 @@ class f extends EventTarget {
 }
 export {
   c as Clock,
-  u as ConfigurableResponses,
-  b as ConsoleStub,
-  p as EventTracker,
-  S as Failure,
-  y as HEARTBEAT_TYPE,
-  d as OutputTracker,
-  E as SseClient,
-  m as Success,
-  v as WebSocketClient,
+  l as ConfigurableResponses,
+  E as ConsoleLog,
+  f as EventTracker,
+  L as Failure,
+  m as HEARTBEAT_TYPE,
+  u as OutputTracker,
+  v as SseClient,
+  S as Success,
+  g as WebSocketClient,
   N as createFetchStub
 };
 //# sourceMappingURL=shared.js.map