@nhtio/swarm 1.20250425.0 → 1.20260111.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhtio/swarm",
-  "version": "1.20250425.0",
+  "version": "1.20260111.0",
   "description": "A library that provides peer communication between browser tabs and service workers",
   "keywords": [],
   "author": "Jak Giveon",

package/types-tRl_KHbK.js

@@ -0,0 +1,6 @@
+"use strict";
+const types = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" }));
+exports.types = types;
+//# sourceMappingURL=types-tRl_KHbK.js.map

package/types-tRl_KHbK.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-tRl_KHbK.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/types-wf-bHbgv.mjs

@@ -0,0 +1,7 @@
+const types = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" }));
+export {
+  types as t
+};
+//# sourceMappingURL=types-wf-bHbgv.mjs.map

package/types-wf-bHbgv.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-wf-bHbgv.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/types.d.ts

@@ -1,40 +1,64 @@
-/**
- * The module which contains types for the library.
- * @module @nhtio/swarm/types
- */
-/**
- * An inteface which describes the information about the browser and operating system
- */
-export interface BrowserInfo {
-    /**
-     * The name of the browser
-     */
-    browserName: string;
-    /**
-     * The version of the browser
-     */
-    browserVersion: string;
-    /**
-     * The name of the operating system
-     */
-    osName: string;
-    /**
-     * The version of the operating system
-     */
-    osVersion: string;
-    /**
-     * The type of platform i.e. desktop / mobile
-     */
-    platformType: string;
-    /**
-     * The name of the browser engine
-     */
-    engineName: string;
-    /**
-     * The version of the browser engine
-     */
-    engineVersion: string;
-}
-export type { TypedEventMap } from './lib/emitter';
-export type { RequestHandlerMap } from './lib/class_swarm';
-export type { LogLevel, LogLevelStyles } from './lib/logger';
+/**
+ * The module which contains types for the library.
+ * @module @nhtio/swarm/types
+ */
+/**
+ * An inteface which describes the information about the browser and operating system
+ */
+export declare interface BrowserInfo {
+    /**
+     * The name of the browser
+     */
+    browserName: string;
+    /**
+     * The version of the browser
+     */
+    browserVersion: string;
+    /**
+     * The name of the operating system
+     */
+    osName: string;
+    /**
+     * The version of the operating system
+     */
+    osVersion: string;
+    /**
+     * The type of platform i.e. desktop / mobile
+     */
+    platformType: string;
+    /**
+     * The name of the browser engine
+     */
+    engineName: string;
+    /**
+     * The version of the browser engine
+     */
+    engineVersion: string;
+}
+
+export declare type LogLevel = keyof typeof LogLevelStyles;
+
+export declare const LogLevelStyles: {
+    EMERG: (text: string) => string[];
+    ALERT: (text: string) => string[];
+    CRIT: (text: string) => string[];
+    ERROR: (text: string) => string[];
+    WARNING: (text: string) => string[];
+    NOTICE: (text: string) => string[];
+    INFO: (text: string) => string[];
+    DEBUG: (text: string) => string[];
+};
+
+export declare type RequestHandlerMap<Events extends TypedEventMap> = {
+    [K in keyof Events]: (...args: Events[K]) => any;
+};
+
+/**
+ * A map from event-names to the tuple of arguments
+ * that listeners for that event will receive.
+ */
+export declare interface TypedEventMap {
+    [event: string]: any[];
+}
+
+export { }

package/errors-Cqo3rABf.mjs

@@ -1,89 +0,0 @@
-var u = Object.defineProperty;
-var m = (e, r, t) => r in e ? u(e, r, { enumerable: !0, configurable: !0, writable: !0, value: t }) : e[r] = t;
-var i = (e, r, t) => m(e, typeof r != "symbol" ? r + "" : r, t);
-class n extends Error {
-  /**
-   * Creates a new SwarmError instance.
-   * @param message The error message.
-   * @param options The error options.
-   */
-  constructor(t, s) {
-    const c = s ? { cause: s.cause } : {};
-    super(t, c);
-    /** @private */
-    i(this, "$__name");
-    /** @private */
-    i(this, "$__message");
-    const o = this.constructor;
-    if (Object.setPrototypeOf(this, o), this.$__name = o.name, this.$__message = t, typeof Error.captureStackTrace == "function" && Error.captureStackTrace(this, o), this.stack && s && s.trim && s.trim > 0) {
-      const a = this.stack.split(`
-`);
-      a.splice(0, s.trim), this.stack = a.join(`
-`);
-    }
-  }
-  get name() {
-    return this.$__name;
-  }
-  get message() {
-    return this.$__message;
-  }
-  get [Symbol.toStringTag]() {
-    return this.constructor.name;
-  }
-  toString() {
-    return `${this.name}: ${this.message}`;
-  }
-  [Symbol.toPrimitive](t) {
-    switch (t) {
-      case "string":
-        return this.toString();
-      default:
-        return !0;
-    }
-  }
-  static [Symbol.hasInstance](t) {
-    if (typeof t == "object" && t !== null || typeof t == "function") {
-      const s = Object.getPrototypeOf(t);
-      return s.name === this.name || s === this;
-    }
-    return !1;
-  }
-}
-class l extends n {
-  constructor() {
-    super("Unable to setup instance because Service Workers are not supported in this environment");
-  }
-}
-class p extends n {
-  constructor() {
-    super(
-      "Unable to setup instance because another instance is already initialized in this context"
-    );
-  }
-}
-class h extends n {
-  constructor(r) {
-    super(`Request timed out while waiting for event "${String(r)}".`);
-  }
-}
-class g extends n {
-  constructor() {
-    super("An encryption key has not been provided at any point in the runtime.");
-  }
-}
-const y = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
-  __proto__: null,
-  AlreadyInitializedInContextError: p,
-  MissingEncryptionKey: g,
-  RequestTimeoutError: h,
-  UnsupportedEnvironmentError: l
-}, Symbol.toStringTag, { value: "Module" }));
-export {
-  p as A,
-  g as M,
-  h as R,
-  l as U,
-  y as e
-};
-//# sourceMappingURL=errors-Cqo3rABf.mjs.map

package/errors-j8BTGk4y.js

@@ -1,4 +0,0 @@
-"use strict";var h=Object.defineProperty;var d=(e,r,t)=>r in e?h(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var i=(e,r,t)=>d(e,typeof r!="symbol"?r+"":r,t);class n extends Error{constructor(t,s){const p=s?{cause:s.cause}:{};super(t,p);i(this,"$__name");i(this,"$__message");const o=this.constructor;if(Object.setPrototypeOf(this,o),this.$__name=o.name,this.$__message=t,typeof Error.captureStackTrace=="function"&&Error.captureStackTrace(this,o),this.stack&&s&&s.trim&&s.trim>0){const a=this.stack.split(`
-`);a.splice(0,s.trim),this.stack=a.join(`
-`)}}get name(){return this.$__name}get message(){return this.$__message}get[Symbol.toStringTag](){return this.constructor.name}toString(){return`${this.name}: ${this.message}`}[Symbol.toPrimitive](t){switch(t){case"string":return this.toString();default:return!0}}static[Symbol.hasInstance](t){if(typeof t=="object"&&t!==null||typeof t=="function"){const s=Object.getPrototypeOf(t);return s.name===this.name||s===this}return!1}}class c extends n{constructor(){super("Unable to setup instance because Service Workers are not supported in this environment")}}class u extends n{constructor(){super("Unable to setup instance because another instance is already initialized in this context")}}class m extends n{constructor(r){super(`Request timed out while waiting for event "${String(r)}".`)}}class l extends n{constructor(){super("An encryption key has not been provided at any point in the runtime.")}}const y=Object.freeze(Object.defineProperty({__proto__:null,AlreadyInitializedInContextError:u,MissingEncryptionKey:l,RequestTimeoutError:m,UnsupportedEnvironmentError:c},Symbol.toStringTag,{value:"Module"}));exports.AlreadyInitializedInContextError=u;exports.MissingEncryptionKey=l;exports.RequestTimeoutError=m;exports.UnsupportedEnvironmentError=c;exports.errors=y;
-//# sourceMappingURL=errors-j8BTGk4y.js.map

package/lib/browser.d.ts

@@ -1,6 +0,0 @@
-import type { BrowserInfo } from '@nhtio/swarm/types';
-/**
- * Get the current browser information
- * @returns {@link BrowserInfo}
- */
-export declare const getBrowserInfo: () => BrowserInfo;

package/lib/class_swarm.d.ts

@@ -1,105 +0,0 @@
-import { TypedEventEmitter } from './emitter';
-import type { TypedEventMap } from './emitter';
-import type { Secret } from '@nhtio/swarm';
-export type RequestHandlerMap<Events extends TypedEventMap> = {
-    [K in keyof Events]: (...args: Events[K]) => any;
-};
-/**
- * The class that provides peer communication between browser tabs and service workers
- * @typeParam Events - The map of events and their arguments that can be emitted and listened to.
- */
-export declare class Swarm<Events extends TypedEventMap = TypedEventMap> extends TypedEventEmitter<Events> {
-    #private;
-    private static readonly INTERNAL_HEARTBEAT;
-    private static readonly INTERNAL_OBITUARY;
-    /** @private */
-    constructor(secret?: string | Secret<string>);
-    /**
-     * The ID of the current instance.
-     */
-    get id(): string;
-    /**
-     * Whether this instance is the leader or not.
-     */
-    get leader(): boolean;
-    /**
-     * Emit an event to all connected peers.
-     * @param event - The name of the event to emit.
-     * @param args - The arguments to pass to the event listeners.
-     * @typeParam E - The name of the event to emit.
-     */
-    emit<E extends keyof Events>(event: E, ...args: Events[E]): this;
-    /**
-     * Subscribe to the leadership change event.
-     * @param cb - The callback function to be called when the leadership status changes.
-     */
-    onLeadershipChange(cb: (is: boolean) => void): this;
-    /**
-     * Remove the leadership change event listener.
-     * @param cb - The callback function to be removed from the leadership change event.
-     */
-    offLeadershipChange(cb: (is: boolean) => void): this;
-    /**
-     * Subscribe to the next occurance of a leadership change event.
-     * @param cb - The callback function to be called when the leadership status changes.
-     */
-    onceLeadershipChange(cb: (is: boolean) => void): this;
-    /**
-     * Collect responses from all peers for a specific event.
-     * @param event The name of the event to collect responses for.
-     * @param args The arguments which will be passed to the event handler.
-     * @returns A promise that resolves with an array of responses from all peers.
-     * @typeParam R - The type of the response.
-     * @typeParam E - The name of the event to collect responses for.
-     */
-    collect<R, E extends keyof Events = keyof Events>(event: E, ...args: Events[E]): Promise<R[]>;
-    /**
-     * Register a handler for a specific event which will respond to incoming messages which require a general response
-     * @param event The name of the event to listen for.
-     * @param handler The function to call when the event is emitted.
-     * @typeParam E - The name of the event to listen for.
-     */
-    onCollect<E extends keyof Events>(event: E, handler: (...args: Events[E]) => ReturnType<RequestHandlerMap<Events>[E]>): this;
-    /**
-     * De-register a handler for a specific event which will respond to incoming messages which require a general response
-     * @param event The name of the event to listen for.
-     * @param handler The function to call when the event is emitted.
-     * @typeParam E - The name of the event to listen for.
-     */
-    offCollect<E extends keyof Events>(event: E): this;
-    /**
-     * Request feedback from the leader for a specific event.
-     * @param event The name of the event to request feedback for.
-     * @param args The arguments to pass to the event handler.
-     * @returns A promise that resolves with the response from the event handler.
-     * @typeParam R - The type of the response.
-     * @typeParam E - The name of the event to request feedback for.
-     */
-    request<R = any, E extends keyof Events = keyof Events>(event: E, ...args: Events[E]): Promise<R>;
-    /**
-     * Register a handler for a specific event which will respond to incoming messages which require a response from the leader
-     * @param event The name of the event to listen for.
-     * @param handler The function to call when the event is emitted.
-     * @typeParam E - The name of the event to listen for.
-     */
-    onRequest<E extends keyof Events>(event: E, handler: (...args: Events[E]) => ReturnType<RequestHandlerMap<Events>[E]>): this;
-    /**
-     * De-register a handler for a specific event which will respond to incoming messages which require a response from the leader
-     * @param event The name of the event to listen for.
-     * @param handler The function to call when the event is emitted.
-     * @typeParam E - The name of the event to listen for.
-     */
-    offRequest<E extends keyof Events>(event: E): this;
-    /**
-     * Set the timeout for waiting for a response from `request()` or `collect()`.
-     * @param timeout The timeout in milliseconds to wait for a response.
-     * @returns The current instance of the Swarm class for the current context.
-     */
-    setAwaitResponseTimeout(timeout: number): this;
-    /**
-     * Retreive the current instance of the Swarm class for the current context.
-     * @typeParam Events - The map of events and their arguments that can be emitted and listened to.
-     * @returns The current instance of the Swarm class for the current context.
-     */
-    static instance<Events extends TypedEventMap = TypedEventMap>(secret?: string | Secret<string>): Swarm<Events>;
-}

package/lib/common.d.ts

@@ -1,26 +0,0 @@
-/**
- * Returns true if the environment is a browser tab
- * @returns {boolean} - true if the environment is a browser tab
- */
-export declare const isTabEnvironment: () => boolean;
-/**
- * Returns true if the environment is a service worker
- * @returns {boolean} - true if the environment is a service worker
- */
-export declare const isWorkerEnvironment: () => boolean;
-/**
- * Returns true if the environment is an SSR (Server-Side Rendering) environment
- * @returns {boolean} - true if the environment is an SSR environment
- */
-export declare const isSsrEnvironment: () => boolean;
-/**
- * Return true if the environment is a Safari browser
- * @returns {boolean} - true if the environment is a Safari browser
- */
-export declare const isSafari: () => boolean;
-/**
- * Return the global object for the current environment
- * @returns An object representing the global scope
- */
-export declare const getGlobal: () => Window | WorkerGlobalScope;
-export declare const makeRandomId: (length: number) => string;

package/lib/emitter.d.ts

@@ -1,33 +0,0 @@
-import { TinyEmitter } from 'tiny-emitter';
-/**
- * A map from event-names to the tuple of arguments
- * that listeners for that event will receive.
- */
-export interface TypedEventMap {
-    [event: string]: any[];
-}
-/**
- * A strongly-typed Tiny Event Emitter.
- *
- * @template Events
- *   key = event name,
- *   value = tuple type of that event’s arguments
- */
-export declare class TypedEventEmitter<Events extends TypedEventMap = TypedEventMap> extends TinyEmitter {
-    /**
-     * Subscribe to an event with a typed listener.
-     */
-    on<E extends keyof Events>(event: E, listener: (...args: Events[E]) => void, ctx?: any): this;
-    /**
-     * Subscribe once to an event.
-     */
-    once<E extends keyof Events>(event: E, listener: (...args: Events[E]) => void, ctx?: any): this;
-    /**
-     * Emit an event, enforcing that the args match Events[E].
-     */
-    emit<E extends keyof Events>(event: E, ...args: Events[E]): this;
-    /**
-     * Remove a listener.
-     */
-    off<E extends keyof Events>(event: E, listener?: (...args: Events[E]) => void): this;
-}

package/lib/encryption.d.ts

@@ -1,9 +0,0 @@
-import { Encryption } from '@nhtio/web-encryption';
-import { Secret } from '@nhtio/swarm';
-export declare const getEncryption: (secret?: string | Secret<string>) => Encryption;
-/**
- * Set the pre-shared key used to ensure that any data shared between nodes in the swarm is encrypted and namespaced.
- * @param secret The pre-shared key to use
- * @returns
- */
-export declare const setPSK: (secret: string | Secret<string>) => void;

package/lib/logger.d.ts

@@ -1,67 +0,0 @@
-export declare const LogLevelStyles: {
-    EMERG: (text: string) => string[];
-    ALERT: (text: string) => string[];
-    CRIT: (text: string) => string[];
-    ERROR: (text: string) => string[];
-    WARNING: (text: string) => string[];
-    NOTICE: (text: string) => string[];
-    INFO: (text: string) => string[];
-    DEBUG: (text: string) => string[];
-};
-export declare enum LogLevelValues {
-    EMERG = 0,
-    ALERT = 1,
-    CRIT = 2,
-    ERROR = 3,
-    WARNING = 4,
-    NOTICE = 5,
-    INFO = 6,
-    DEBUG = 7
-}
-export type LogLevel = keyof typeof LogLevelStyles | Lowercase<keyof typeof LogLevelStyles>;
-declare const EnvironmentStyles: {
-    BROWSER: (text: string) => string[];
-    WORKER: (text: string) => string[];
-    SSR: (text: string) => string[];
-    UNKNOWN: (text: string) => string[];
-};
-export type Environment = keyof typeof EnvironmentStyles | Lowercase<keyof typeof EnvironmentStyles>;
-export declare class Logger {
-    #private;
-    constructor(level?: LogLevelValues);
-    get level(): LogLevel;
-    set level(level: LogLevel);
-    EMERG(...args: any[]): void;
-    ALERT(...args: any[]): void;
-    CRIT(...args: any[]): void;
-    ERROR(...args: any[]): void;
-    WARNING(...args: any[]): void;
-    NOTICE(...args: any[]): void;
-    INFO(...args: any[]): void;
-    DEBUG(...args: any[]): void;
-    emerg(...args: any[]): void;
-    alert(...args: any[]): void;
-    crit(...args: any[]): void;
-    error(...args: any[]): void;
-    warning(...args: any[]): void;
-    notice(...args: any[]): void;
-    info(...args: any[]): void;
-    debug(...args: any[]): void;
-}
-export declare const getLogger: () => Logger;
-/**
- * Sets the log level for the logger.
- * @param level - The log level to set. Can be one of the following:
- * - `EMERG` or `emerg`
- * - `ALERT` or `alert`
- * - `CRIT` or `crit`
- * - `ERROR` or `error`
- * - `WARNING` or `warning`
- * - `NOTICE` or `notice`
- * - `INFO` or `info`
- * - `DEBUG` or `debug`
- *
- * @remarks You can also set `window.SWARM_LOG_LEVEL` or `globalThis.SWARM_LOG_LEVEL` to the same values to set the log level globally before initializing any of the Swarm modules.
- */
-export declare const setLogLevel: (level: LogLevel) => void;
-export {};

package/lib/symbols.d.ts

@@ -1,6 +0,0 @@
-export declare const FOR_BROWSER: unique symbol;
-export declare const FOR_WORKER: unique symbol;
-export declare const FOR_SWARM: unique symbol;
-export declare const FOR_LOGGER: unique symbol;
-export declare const CAPTURE_REJECTION_SYMBOL: unique symbol;
-export declare const FOR_ENCRYPTION: unique symbol;

package/types-C0eRuyk9.js

@@ -1,2 +0,0 @@
-"use strict";const e=Object.freeze(Object.defineProperty({__proto__:null},Symbol.toStringTag,{value:"Module"}));exports.types=e;
-//# sourceMappingURL=types-C0eRuyk9.js.map

package/types-C0eRuyk9.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types-C0eRuyk9.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/types-CBFnAS2P.mjs

@@ -1,7 +0,0 @@
-const e = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
-  __proto__: null
-}, Symbol.toStringTag, { value: "Module" }));
-export {
-  e as t
-};
-//# sourceMappingURL=types-CBFnAS2P.mjs.map

package/types-CBFnAS2P.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"types-CBFnAS2P.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}