@byloth/core 2.1.6 → 2.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.1.6",
+  "version": "2.1.7",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",

package/src/index.ts

@@ -1,4 +1,4 @@
-export const VERSION = "2.1.6";
+export const VERSION = "2.1.7";
 
 export type { Constructor, Interval, Timeout, ValueOf } from "./core/types.js";
 

package/src/models/callbacks/callable-object.ts

@@ -1,7 +1,7 @@
 import type { Callback } from "./types.js";
 
 const SmartFunction = (Function as unknown) as new<A extends unknown[] = [], R = void>(...args: string[])
-    => (...args: A) => R;
+    => Callback<A, R>;
 
 /**
  * An abstract class that can be used to implement callable objects.
@@ -30,10 +30,10 @@ const SmartFunction = (Function as unknown) as new<A extends unknown[] = [], R =
  *
  * @template T
  * The type signature of the callback function.  
- * It must be a function. Default is `(...args: any[]) => any`.
+ * It must be a function. Default is `() => void`.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export default abstract class CallableObject<T extends Callback<any[], any> = () => void>
+export default abstract class CallableObject<T extends Callback<any[], any> = Callback>
     extends SmartFunction<Parameters<T>, ReturnType<T>>
 {
     /**

package/src/models/callbacks/publisher.ts

@@ -2,8 +2,8 @@ import { ReferenceException } from "../exceptions/index.js";
 
 import type { Callback, CallbackMap, InternalsEventsMap, WildcardEventsMap } from "./types.js";
 
-type I = InternalsEventsMap;
-type W = WildcardEventsMap;
+type P = InternalsEventsMap;
+type S = WildcardEventsMap & InternalsEventsMap;
 
 /**
  * A class implementing the
@@ -120,29 +120,29 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      * ---
      *
      * @template U
-     * A map containing the names of the emittable events and the
-     * related callback signatures that can be subscribed to them.
-     * Default is `T`.
+     * A map containing the additional names of the emittable events and
+     * the related callback signatures that can be subscribed to them.
+     * Default is `{ }`.
      *
      * @return
      * A new instance of the {@link Publisher} class that can be
      * used to publish and subscribe events within a specific context.
      */
-    public createScope<U extends T = T>(): Publisher<U>
+
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+    public createScope<U extends CallbackMap<U> = { }>(): Publisher<U & T>
     {
-        const scope = new Publisher<U>();
+        const scope = new Publisher();
 
         this.subscribe("__internals__:clear", () => scope.clear());
-        this.subscribe("*", (event, ...args): void =>
-        {
-            scope.publish(event as keyof U & string, ...args as Parameters<U[keyof U]>);
-        });
+        this.subscribe("*", (event, ...args): void => { scope.publish(event, ...args); });
 
         return scope;
     }
 
     /**
-     * Publishes an event to all the subscribers.
+     * Publishes an event to all the subscribers.  
+     * This events will trigger the wildcard listeners as well, if any.
      *
      * ---
      *
@@ -170,7 +170,8 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      * Publishes an internal event to all the subscribers.
      *
      * Internal events follow the pattern `__${string}__:${string}` and are used for internal
-     * communication within the publisher system. These events won't trigger wildcard listeners.
+     * communication within the publisher system. These events won't trigger wildcard listeners.  
+     * Please note to use this method only if you know what you are doing.
      *
      * ---
      *
@@ -189,7 +190,7 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      *
      * @returns An array containing the return values of all the subscribers.
      */
-    public publish<K extends keyof I>(event: K & string, ...args: Parameters<I[K]>): ReturnType<I[K]>[];
+    public publish<K extends keyof P>(event: K & string, ...args: Parameters<P[K]>): ReturnType<P[K]>[];
     public publish(event: string, ...args: unknown[]): unknown[]
     {
         let results: unknown[];
@@ -240,32 +241,6 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      */
     public subscribe<K extends keyof T>(event: K & string, subscriber: T[K]): () => void;
 
-    /**
-     * Subscribes to an internal event and adds a subscriber to be executed when the event is published.
-     *
-     * Internal events follow the pattern `__${string}__:${string}` and
-     * are used for internal communication within the publisher system.  
-     * Please note to use this method only if you know what you are doing.
-     *
-     * ---
-     *
-     * @example
-     * ```ts
-     * publisher.subscribe("__internals__:clear", () => console.log("All subscribers have been cleared."));
-     * publisher.clear(); // "All subscribers have been cleared."
-     * ```
-     *
-     * ---
-     *
-     * @template K The key of the internal events map containing the callback signature to subscribe.
-     *
-     * @param event The name of the internal event to subscribe to.
-     * @param subscriber The subscriber to execute when the internal event is published.
-     *
-     * @returns A function that can be used to unsubscribe the subscriber from the event.
-     */
-    public subscribe<K extends keyof I>(event: K & string, subscriber: I[K]): () => void;
-
     /**
      * Subscribes to the wildcard event to listen to all published events.
      *
@@ -291,7 +266,7 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      *
      * @returns A function that can be used to unsubscribe the subscriber from the wildcard event.
      */
-    public subscribe<K extends keyof W>(event: K & string, subscriber: W[K]): () => void;
+    public subscribe<K extends keyof S>(event: K & string, subscriber: S[K]): () => void;
     public subscribe(event: string, subscriber: Callback<unknown[], unknown>): () => void
     {
         const subscribers = this._subscribers.get(event) ?? [];
@@ -334,31 +309,6 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      */
     public unsubscribe<K extends keyof T>(event: K & string, subscriber: T[K]): void;
 
-    /**
-     * Unsubscribes from an internal event and removes a subscriber from being executed when the event is published.
-     *
-     * Internal events follow the pattern `__${string}__:${string}` and
-     * are used for internal communication within the publisher system.
-     *
-     * ---
-     *
-     * @example
-     * ```ts
-     * const onClear = () => console.log("Publisher cleared");
-     * 
-     * publisher.subscribe("__internals__:clear", onClear);
-     * publisher.unsubscribe("__internals__:clear", onClear);
-     * ```
-     *
-     * ---
-     *
-     * @template K The key of the internal events map containing the callback signature to unsubscribe.
-     *
-     * @param event The name of the internal event to unsubscribe from.
-     * @param subscriber The subscriber to remove from the internal event.
-     */
-    public unsubscribe<K extends keyof I>(event: K & string, subscriber: I[K]): void;
-
     /**
      * Unsubscribes from the wildcard event and removes a subscriber from being executed for all events.
      *
@@ -381,7 +331,7 @@ export default class Publisher<T extends CallbackMap<T> = CallbackMap>
      * @param event The wildcard event name ("*").
      * @param subscriber The wildcard subscriber to remove.
      */
-    public unsubscribe<K extends keyof W>(event: K & string, subscriber: W[K]): void;
+    public unsubscribe<K extends keyof S>(event: K & string, subscriber: S[K]): void;
     public unsubscribe(event: string, subscriber: Callback<unknown[], unknown>): void
     {
         const subscribers = this._subscribers.get(event);

package/src/models/callbacks/switchable-callback.ts

@@ -27,7 +27,7 @@ const Disabler = () => { /* ... */ };
  *
  * ---
  *
- * @template T The type signature of the callback. Default is `(...args: any[]) => any`.
+ * @template T The type signature of the callback. Default is `() => void`.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export default class SwitchableCallback<T extends Callback<any[], any> = Callback> extends CallableObject<T>

package/src/models/callbacks/types.ts

@@ -69,7 +69,7 @@ export type CallbackMap<T = Record<string, Callback<unknown[], unknown>>> = { [K
  * publisher.clear(); // "Publisher cleared"
  * ```
  */
-export type InternalsEventsMap = Record<`__${string}__:${string}`, (...args: unknown[]) => unknown>;
+export type InternalsEventsMap = Record<`__${string}__:${string}`, Callback<unknown[], unknown>>;
 
 /**
  * An utility interface that defines a wildcard event for listening to all events.