@hyphen/sdk 2.2.0 → 3.0.0

package/README.md

@@ -36,6 +36,7 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 	- [Creating a QR Code from a Short Code](#creating-a-qr-code-from-a-short-code)
 	- [Get QR Codes for a Short Code](#get-qr-codes-for-a-short-code)
 	- [Deleting a QR Code](#deleting-a-qr-code)
+- [Migrating to v3](#migrating-to-v3)
 - [Contributing](#contributing)
 - [Testing Your Changes](#testing-your-changes)
 - [License and Copyright](#license-and-copyright)
@@ -958,6 +959,54 @@ const response = await link.deleteQrCode(code, qr);
 console.log('Delete QR Code Response:', response);
 ```
 
+# Migrating to v3
+
+v3 upgrades the underlying event system to [hookified v2](https://hookified.org). There are two breaking changes:
+
+## `throwOnEmptyListeners` now defaults to `true`
+
+In v2, emitting events (`error`) without any registered listeners was silently ignored. In v3, this will throw an error by default. If your code emits events, you must register listeners:
+
+```typescript
+const hyphen = new Hyphen({ apiKey: 'your-key' });
+
+// Register listeners before triggering operations that emit events
+hyphen.on('error', (message) => {
+  console.error('Error:', message);
+});
+```
+
+If you want to restore the previous behavior where unhandled events are silently ignored, pass `throwOnEmptyListeners: false` in the options:
+
+```typescript
+const hyphen = new Hyphen({
+  apiKey: 'your-key',
+  throwOnEmptyListeners: false,
+});
+
+const toggle = new Toggle({
+  publicApiKey: 'public_your-key',
+  throwOnEmptyListeners: false,
+});
+```
+
+## `throwErrors` option removed
+
+The `throwErrors` option has been removed from `BaseServiceOptions`, `HyphenOptions`, and all service classes. Error throwing is now handled natively by hookified v2.
+
+To get the previous `throwErrors: true` behavior, use `throwOnEmitError: true` instead:
+
+```typescript
+// v2 (old)
+const netInfo = new NetInfo({ throwErrors: true });
+
+// v3 (new)
+const netInfo = new NetInfo({ throwOnEmitError: true });
+```
+
+The `throwErrors` getter/setter on service instances has also been removed as you can use `.throwOnEmitError` getter/setter now.
+
+
 # Contributing
 
 We welcome contributions to the Hyphen Node.js SDK! If you have an idea for a new feature, bug fix, or improvement, please follow these steps:

package/dist/index.cjs

@@ -132,13 +132,9 @@ var BaseService = class extends import_hookified.Hookified {
   }
   _log = (0, import_pino.default)();
   _cache = new import_cacheable.Cacheable();
-  _throwErrors = false;
   _net;
   constructor(options) {
     super(options);
-    if (options && options.throwErrors !== void 0) {
-      this._throwErrors = options.throwErrors;
-    }
     this._net = new import_net2.CacheableNet({
       cache: this._cache
     });
@@ -156,18 +152,9 @@ var BaseService = class extends import_hookified.Hookified {
     this._cache = value;
     this._net.cache = value;
   }
-  get throwErrors() {
-    return this._throwErrors;
-  }
-  set throwErrors(value) {
-    this._throwErrors = value;
-  }
   error(message, ...args) {
     this._log.error(message, ...args);
     this.emit("error", message, ...args);
-    if (this.throwErrors) {
-      throw new Error(message);
-    }
   }
   warn(message, ...args) {
     this._log.warn(message, ...args);

package/dist/index.d.cts

@@ -107,21 +107,16 @@ interface HttpResponse<T = any> {
     config: any;
     request?: any;
 }
-type BaseServiceOptions = {
-    throwErrors?: boolean;
-} & HookifiedOptions;
+type BaseServiceOptions = HookifiedOptions;
 declare class BaseService extends Hookified {
     private _log;
     private _cache;
-    private _throwErrors;
     private _net;
     constructor(options?: BaseServiceOptions);
     get log(): pino.Logger;
     set log(value: pino.Logger);
     get cache(): Cacheable;
     set cache(value: Cacheable);
-    get throwErrors(): boolean;
-    set throwErrors(value: boolean);
     error(message: string, ...args: any[]): void;
     warn(message: string, ...args: any[]): void;
     info(message: string, ...args: any[]): void;
@@ -1051,29 +1046,23 @@ type HyphenOptions = {
      * This is used for authenticated endpoints that require an API key.
      */
     apiKey?: string;
-    /**
-     * Whether to throw errors or not.
-     * If set to true, errors will be thrown instead of logged.
-     * @default false
-     */
-    throwErrors?: boolean;
     /**
      * Options for the Toggle service.
-     * Excludes publicApiKey and throwErrors from ToggleOptions.
+     * Excludes `publicApiKey` as it's provided at the top level.
      * @see ToggleOptions
      * @default {Toggle}
      */
     toggle?: Omit<ToggleOptions, "publicApiKey">;
     /**
      * Options for the NetInfo service.
-     * Excludes apiKey and throwErrors from NetInfoOptions.
+     * Excludes `apiKey` as it's provided at the top level.
      * @see NetInfoOptions
      * @default {NetInfo}
      */
     netInfo?: Omit<NetInfoOptions, "apiKey">;
     /**
      * Options for the Link service.
-     * Excludes apiKey and throwErrors from LinkOptions.
+     * Excludes `apiKey` as it's provided at the top level.
      * @see LinkOptions
      * @default {Link}
      */

package/dist/index.d.ts

@@ -107,21 +107,16 @@ interface HttpResponse<T = any> {
     config: any;
     request?: any;
 }
-type BaseServiceOptions = {
-    throwErrors?: boolean;
-} & HookifiedOptions;
+type BaseServiceOptions = HookifiedOptions;
 declare class BaseService extends Hookified {
     private _log;
     private _cache;
-    private _throwErrors;
     private _net;
     constructor(options?: BaseServiceOptions);
     get log(): pino.Logger;
     set log(value: pino.Logger);
     get cache(): Cacheable;
     set cache(value: Cacheable);
-    get throwErrors(): boolean;
-    set throwErrors(value: boolean);
     error(message: string, ...args: any[]): void;
     warn(message: string, ...args: any[]): void;
     info(message: string, ...args: any[]): void;
@@ -1051,29 +1046,23 @@ type HyphenOptions = {
      * This is used for authenticated endpoints that require an API key.
      */
     apiKey?: string;
-    /**
-     * Whether to throw errors or not.
-     * If set to true, errors will be thrown instead of logged.
-     * @default false
-     */
-    throwErrors?: boolean;
     /**
      * Options for the Toggle service.
-     * Excludes publicApiKey and throwErrors from ToggleOptions.
+     * Excludes `publicApiKey` as it's provided at the top level.
      * @see ToggleOptions
      * @default {Toggle}
      */
     toggle?: Omit<ToggleOptions, "publicApiKey">;
     /**
      * Options for the NetInfo service.
-     * Excludes apiKey and throwErrors from NetInfoOptions.
+     * Excludes `apiKey` as it's provided at the top level.
      * @see NetInfoOptions
      * @default {NetInfo}
      */
     netInfo?: Omit<NetInfoOptions, "apiKey">;
     /**
      * Options for the Link service.
-     * Excludes apiKey and throwErrors from LinkOptions.
+     * Excludes `apiKey` as it's provided at the top level.
      * @see LinkOptions
      * @default {Link}
      */

package/dist/index.js

@@ -94,13 +94,9 @@ var BaseService = class extends Hookified {
   }
   _log = pino();
   _cache = new Cacheable();
-  _throwErrors = false;
   _net;
   constructor(options) {
     super(options);
-    if (options && options.throwErrors !== void 0) {
-      this._throwErrors = options.throwErrors;
-    }
     this._net = new CacheableNet2({
       cache: this._cache
     });
@@ -118,18 +114,9 @@ var BaseService = class extends Hookified {
     this._cache = value;
     this._net.cache = value;
   }
-  get throwErrors() {
-    return this._throwErrors;
-  }
-  set throwErrors(value) {
-    this._throwErrors = value;
-  }
   error(message, ...args) {
     this._log.error(message, ...args);
     this.emit("error", message, ...args);
-    if (this.throwErrors) {
-      throw new Error(message);
-    }
   }
   warn(message, ...args) {
     this._log.warn(message, ...args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",
@@ -33,25 +33,25 @@
     "node": ">=20.12.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.8",
-    "@swc/core": "^1.15.3",
-    "@types/node": "^25.0.0",
-    "@vitest/coverage-v8": "^4.0.15",
-    "rimraf": "^6.1.2",
+    "@biomejs/biome": "^2.3.14",
+    "@swc/core": "^1.15.18",
+    "@types/node": "^25.3.3",
+    "@vitest/coverage-v8": "^4.0.18",
+    "rimraf": "^6.1.3",
     "tsd": "^0.33.0",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.15"
+    "vitest": "^4.0.18"
   },
   "files": [
     "dist",
     "LICENSE"
   ],
   "dependencies": {
-    "@cacheable/net": "^2.0.4",
-    "@faker-js/faker": "^10.2.0",
-    "cacheable": "^2.3.0",
-    "hookified": "^1.14.0",
-    "pino": "^10.1.1"
+    "@cacheable/net": "^2.0.6",
+    "@faker-js/faker": "^10.3.0",
+    "cacheable": "^2.3.3",
+    "hookified": "^2.0.1",
+    "pino": "^10.3.1"
   }
 }