@hyphen/sdk 1.7.0 → 1.9.0

package/README.md

@@ -11,7 +11,7 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 
 # Table of Contents
 - [Installation](#installation)
-- [Basic Usage](#basic-usage)
+- [Basic Usage with Hyphen](#basic-usage-with-hyphen)
 - [Toggle](#toggle)
 	- [Toggle Options](#toggle-options)
 	- [Toggle API](#toggle-api)
@@ -35,9 +35,93 @@ To install the Hyphen Node.js SDK, you can use npm or yarn. Run the following co
 npm install @hyphen/sdk
 ```
 
-# Basic Usage
+# Basic Usage with Hyphen
 
-There are many ways to use the Hyphen Node.js SDK. Because of this we have created examples for each of the different ways in each secton of the documentation.
+There are many ways to use the Hyphen Node.js SDK. Because of this we have created examples for each of the different ways in each secton of the documentation. To get started, you can create an instance of the `Hyphen` class and use its methods to interact with the various services.
+
+```javascript
+import { Hyphen } from '@hyphen/sdk';
+
+const hyphen = new Hyphen({
+	publicApiKey: 'your_public_api_key',
+	applicationId: 'your_application_id',
+});
+const result = await hyphen.toggle.getBoolean('hyphen-sdk-boolean', false);
+console.log('Boolean toggle value:', result); // true
+```
+
+You can also use `netInfo` to access the network information service.
+
+```javascript
+import { Hyphen, ToggleContext } from '@hyphen/sdk';
+
+const context: ToggleContext = {
+	targetingKey: 'user-123',
+	ipAddress: '203.0.113.42',
+	customAttributes: {
+		subscriptionLevel: 'premium',
+		region: 'us-east',
+	},
+	user: {
+		id: 'user-123',
+		email: 'john.doe@example.com',
+		name: 'John Doe',
+		customAttributes: {
+			role: 'admin',
+		},
+	},
+};
+
+const hyphen = new Hyphen({
+	publicApiKey: 'your_public_api_key',
+	toggle: {
+		applicationId: 'your_application_id',
+		context: context,
+	},
+});
+const result = await hyphen.toggle.getBoolean('hyphen-sdk-boolean', false);
+console.log('Boolean toggle value:', result); // true
+```
+
+You can also use `netInfo` to access the network information service.
+
+```javascript
+import { Hyphen } from '@hyphen/sdk';
+
+const hyphen = new Hyphen({
+	apiKey: 'your_api_key',
+});
+const result = await hyphen.netInfo.getIpInfo('8.8.8.8');
+console.log('Geo IP information:', result);
+```
+
+If you need to set the `apiKey` or `publicApiKey` after initializing `Hyphen` you can do so and it will cascade the setting to the individual services:
+
+```javascript
+import { Hyphen } from '@hyphen/sdk';
+
+const hyphen = new Hyphen();
+hyphen.apiKey = 'your_api_key';
+const result = await hyphen.netInfo.getIpInfo('8.8.8.8');
+console.log('Geo IP information:', result);
+```
+
+Finally, `error`, `warn`, and `info` emitters are enabled from each of the services and you can access them by doing the following example with `error`:
+
+```javascript
+import { Hyphen } from '@hyphen/sdk';
+
+const hyphen = new Hyphen({ apiKey: 'your_api_key'});
+
+hyphen.on('error', (error) => {
+	console.log(error);
+});
+
+const result = await hyphen.netInfo.getIpInfo('8.8.8.8');
+console.log('Geo IP information:', result);
+```
+
+The rest of the examples for each service show you accessing the service instance directly. 
 
 # Toggle
 
@@ -532,11 +616,12 @@ import { loadEnv } from '@hyphen/sdk';
 loadEnv({ local: false });
 ```
 
-# Net Info (https://net.info)
+# Net Info
 
 The Hyphen Node.js SDK also provides a `NetInfo` class that allows you to fetch geo information about an IP address. This can be useful for debugging or logging purposes. You can read more about it:
 
 * [Website](https://hyphen.ai/net-info)
+* [https://net.info](https://net.info) - webservice uri used by the SDK
 * [Quick Start Guide](https://docs.hyphen.ai/docs/netinfo-quickstart)
 
 To use the `NetInfo` class, you can do the following:
@@ -551,6 +636,18 @@ const ipInfo = await netInfo.getIpInfo('8.8.8.8');
 console.log('IP Info:', ipInfo);
 ```
 
+If you want to fetch information for multiple IP addresses, you can do it like this:
+
+```javascript
+import { NetInfo } from '@hyphen/sdk';
+const netInfo = new NetInfo({
+  apiKey: 'your_api_key',
+});
+const ips = ['8.8.8.8', '1.1.1.1'];
+const ipInfos = await netInfo.getIpInfos(ips);
+console.log('IP Infos:', ipInfos);
+```
+
 You can also set the API key using the `HYPHEN_API_KEY` environment variable. This is useful for keeping your API key secure and not hardcoding it in your code.
 
 # Contributing

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  Hyphen: () => Hyphen,
   Toggle: () => Toggle,
   ToggleHooks: () => ToggleHooks,
   loadEnv: () => loadEnv
@@ -442,8 +443,289 @@ function loadEnv(options) {
   }
 }
 __name(loadEnv, "loadEnv");
+
+// src/hyphen.ts
+var import_hookified3 = require("hookified");
+
+// src/net-info.ts
+var import_node_process3 = __toESM(require("process"), 1);
+
+// src/base-service.ts
+var import_hookified2 = require("hookified");
+var import_cacheable = require("cacheable");
+var import_axios = __toESM(require("axios"), 1);
+var import_pino = __toESM(require("pino"), 1);
+var ErrorMessages = /* @__PURE__ */ function(ErrorMessages2) {
+  ErrorMessages2["API_KEY_REQUIRED"] = "API key is required. Please provide it via options or set the HYPHEN_API_KEY environment variable.";
+  ErrorMessages2["PUBLIC_API_KEY_SHOULD_NOT_BE_USED"] = "The provided API key is a public API key. Please provide a valid non public API key for authentication.";
+  return ErrorMessages2;
+}({});
+var BaseService = class extends import_hookified2.Hookified {
+  static {
+    __name(this, "BaseService");
+  }
+  _log = (0, import_pino.default)();
+  _cache = new import_cacheable.Cacheable();
+  _throwErrors = false;
+  constructor(options) {
+    super(options);
+    if (options && options.throwErrors !== void 0) {
+      this._throwErrors = options.throwErrors;
+    }
+  }
+  get log() {
+    return this._log;
+  }
+  set log(value) {
+    this._log = value;
+  }
+  get cache() {
+    return this._cache;
+  }
+  set cache(value) {
+    this._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);
+    this.emit("warn", message, ...args);
+  }
+  info(message, ...args) {
+    this._log.info(message, ...args);
+    this.emit("info", message, ...args);
+  }
+  async get(url, config2) {
+    return import_axios.default.get(url, config2);
+  }
+  async post(url, data, config2) {
+    return import_axios.default.post(url, data, config2);
+  }
+  async put(url, data, config2) {
+    return import_axios.default.put(url, data, config2);
+  }
+  async delete(url, config2) {
+    return import_axios.default.delete(url, config2);
+  }
+  async patch(url, data, config2) {
+    return import_axios.default.patch(url, data, config2);
+  }
+  createHeaders(apiKey) {
+    const headers = {
+      "content-type": "application/json",
+      accept: "application/json"
+    };
+    if (apiKey) {
+      headers["x-api-key"] = apiKey;
+    }
+    return headers;
+  }
+};
+
+// src/net-info.ts
+loadEnv();
+var NetInfo = class extends BaseService {
+  static {
+    __name(this, "NetInfo");
+  }
+  _apiKey;
+  _baseUri = "https://net.info";
+  constructor(options) {
+    super(options);
+    if (options?.baseUri) {
+      this._baseUri = options.baseUri;
+    }
+    this.setApiKey(options?.apiKey);
+    if (!this._apiKey && import_node_process3.default.env.HYPHEN_API_KEY) {
+      this.setApiKey(import_node_process3.default.env.HYPHEN_API_KEY);
+    }
+    if (!this._apiKey) {
+      this.error(ErrorMessages.API_KEY_REQUIRED);
+    }
+  }
+  /**
+   * Gets or sets the API key for authentication.
+   * If not set, it will try to use the `HYPHEN_API_KEY` environment variable.
+   * @type {string | undefined}
+   */
+  get apiKey() {
+    return this._apiKey;
+  }
+  /**
+   * Sets the API key for authentication.
+   * @param {string | undefined} value - The API key to set.
+   */
+  set apiKey(value) {
+    this.setApiKey(value);
+  }
+  /**
+   * Gets or sets the base URI for the API.
+   * @type {string}
+   */
+  get baseUri() {
+    return this._baseUri;
+  }
+  /**
+   * Sets the base URI for the API.
+   * @param {string} value - The base URI to set.
+   */
+  set baseUri(value) {
+    this._baseUri = value;
+  }
+  setApiKey(value) {
+    if (value?.startsWith("public_")) {
+      this.error(ErrorMessages.PUBLIC_API_KEY_SHOULD_NOT_BE_USED);
+      return;
+    }
+    this._apiKey = value;
+  }
+  /**
+   * Fetches GeoIP information for a given IP address.
+   * @param {string} ip - The IP address to fetch GeoIP information for.
+   * @returns {Promise<ipInfo | ipInfoError>} - A promise that resolves to the ip information or an error.
+   */
+  async getIpInfo(ip) {
+    try {
+      if (!this._apiKey) {
+        throw new Error(ErrorMessages.API_KEY_REQUIRED);
+      }
+      const url = `${this._baseUri}/ip/${ip}`;
+      const headers = this.createHeaders(this._apiKey);
+      const response = await this.get(url, {
+        headers
+      });
+      if (response.status !== 200) {
+        const errorResult = {
+          ip,
+          type: "error",
+          errorMessage: `Failed to fetch ip info: ${response.statusText}`
+        };
+        return errorResult;
+      }
+      return response.data;
+    } catch (error) {
+      this.error(`Failed to fetch ip info: ${error instanceof Error ? error.message : "Unknown error"}`);
+      const errorResult = {
+        ip,
+        type: "error",
+        errorMessage: error instanceof Error ? error.message : "Unknown error"
+      };
+      return errorResult;
+    }
+  }
+  async getIpInfos(ips) {
+    if (!Array.isArray(ips) || ips.length === 0) {
+      this.error("The provided IPs array is invalid. It should be a non-empty array of strings.");
+      return [];
+    }
+    const errorResults = [];
+    try {
+      if (!this._apiKey) {
+        throw new Error(ErrorMessages.API_KEY_REQUIRED);
+      }
+      const url = `${this._baseUri}/ip`;
+      const headers = this.createHeaders(this._apiKey);
+      const response = await this.post(url, ips, {
+        headers
+      });
+      if (response.status !== 200) {
+        errorResults.push({
+          ip: "",
+          type: "error",
+          errorMessage: `Failed to fetch ip infos: ${response.statusText}`
+        });
+        return errorResults;
+      }
+      const responseData = response?.data;
+      return responseData.data;
+    } catch (error) {
+      this.error(`Failed to fetch ip infos: ${error instanceof Error ? error.message : "Unknown error"}`);
+      errorResults.push({
+        ip: "",
+        type: "error",
+        errorMessage: error instanceof Error ? error.message : "Unknown error"
+      });
+      return errorResults;
+    }
+  }
+};
+
+// src/hyphen.ts
+var Hyphen = class extends import_hookified3.Hookified {
+  static {
+    __name(this, "Hyphen");
+  }
+  _netInfo;
+  _toggle;
+  _publicApiKey;
+  _apiKey;
+  constructor(options) {
+    super(options);
+    const toggleOptions = options?.toggle ?? {};
+    const netInfoOptions = options?.netInfo ?? {};
+    if (options?.publicApiKey) {
+      this._publicApiKey = options.publicApiKey;
+      toggleOptions.publicApiKey = options.publicApiKey;
+    }
+    if (options?.apiKey) {
+      this._apiKey = options.apiKey;
+      netInfoOptions.apiKey = options.apiKey;
+    }
+    if (options?.throwErrors !== void 0) {
+      toggleOptions.throwErrors = options.throwErrors;
+      netInfoOptions.throwErrors = options.throwErrors;
+    }
+    this._netInfo = new NetInfo(netInfoOptions);
+    this._netInfo.on("error", (message, ...args) => this.emit("error", message, ...args));
+    this._netInfo.on("info", (message, ...args) => this.emit("info", message, ...args));
+    this._netInfo.on("warn", (message, ...args) => this.emit("warn", message, ...args));
+    this._toggle = new Toggle(toggleOptions);
+    this._toggle.on("error", (message, ...args) => this.emit("error", message, ...args));
+    this._toggle.on("info", (message, ...args) => this.emit("info", message, ...args));
+    this._toggle.on("warn", (message, ...args) => this.emit("warn", message, ...args));
+  }
+  get netInfo() {
+    return this._netInfo;
+  }
+  get toggle() {
+    return this._toggle;
+  }
+  get publicApiKey() {
+    return this._publicApiKey;
+  }
+  set publicApiKey(value) {
+    this._publicApiKey = value;
+    this._toggle.publicApiKey = value;
+  }
+  get apiKey() {
+    return this._apiKey;
+  }
+  set apiKey(value) {
+    this._apiKey = value;
+    this._netInfo.apiKey = value;
+  }
+  get throwErrors() {
+    return this._netInfo.throwErrors && this._toggle.throwErrors;
+  }
+  set throwErrors(value) {
+    this._netInfo.throwErrors = value;
+    this._toggle.throwErrors = value;
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  Hyphen,
   Toggle,
   ToggleHooks,
   loadEnv

package/dist/index.d.cts

@@ -1,5 +1,9 @@
-import { Hookified } from 'hookified';
+import { Hookified, HookifiedOptions } from 'hookified';
 import { EvaluationContext, Client } from '@openfeature/server-sdk';
+import * as axios from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { Cacheable } from 'cacheable';
+import pino from 'pino';
 
 type ToggleContext = EvaluationContext;
 declare enum ToggleHooks {
@@ -218,4 +222,120 @@ type LoadEnvOptions = {
  */
 declare function loadEnv(options?: LoadEnvOptions): void;
 
-export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };
+type BaseServiceOptions = {
+    throwErrors?: boolean;
+} & HookifiedOptions;
+declare class BaseService extends Hookified {
+    private _log;
+    private _cache;
+    private _throwErrors;
+    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;
+    get<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    post<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    put<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    delete<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    patch<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    createHeaders(apiKey?: string): Record<string, string>;
+}
+
+type NetInfoOptions = {
+    /**
+     * API key for authentication. If this is not provided it will try to use `HYPHEN_API_KEY` environment variable.
+     * @type {string} - The API key for authentication. This is not the public API key.
+     * @default undefined
+     */
+    apiKey?: string;
+    /**
+     * Base URI for the API. If not provided, it will use the default Hyphen API base URI.
+     * @type {string} - The base URI for the API.
+     * @default 'https://net.info'
+     */
+    baseUri?: string;
+} & BaseServiceOptions;
+type ipInfo = {
+    ip: string;
+    type: string;
+    location: {
+        country: string;
+        region: string;
+        city: string;
+        lat: number;
+        lng: number;
+        postalCode: string;
+        timezone: string;
+        geonameId: number;
+    };
+};
+type ipInfoError = {
+    ip: string;
+    type: string;
+    errorMessage: string;
+};
+declare class NetInfo extends BaseService {
+    private _apiKey;
+    private _baseUri;
+    constructor(options?: NetInfoOptions);
+    /**
+     * Gets or sets the API key for authentication.
+     * If not set, it will try to use the `HYPHEN_API_KEY` environment variable.
+     * @type {string | undefined}
+     */
+    get apiKey(): string | undefined;
+    /**
+     * Sets the API key for authentication.
+     * @param {string | undefined} value - The API key to set.
+     */
+    set apiKey(value: string | undefined);
+    /**
+     * Gets or sets the base URI for the API.
+     * @type {string}
+     */
+    get baseUri(): string;
+    /**
+     * Sets the base URI for the API.
+     * @param {string} value - The base URI to set.
+     */
+    set baseUri(value: string);
+    setApiKey(value: string | undefined): void;
+    /**
+     * Fetches GeoIP information for a given IP address.
+     * @param {string} ip - The IP address to fetch GeoIP information for.
+     * @returns {Promise<ipInfo | ipInfoError>} - A promise that resolves to the ip information or an error.
+     */
+    getIpInfo(ip: string): Promise<ipInfo | ipInfoError>;
+    getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
+}
+
+type HyphenOptions = {
+    publicApiKey?: string;
+    apiKey?: string;
+    throwErrors?: boolean;
+    toggle?: Omit<ToggleOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
+    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
+} & HookifiedOptions;
+declare class Hyphen extends Hookified {
+    private readonly _netInfo;
+    private readonly _toggle;
+    private _publicApiKey?;
+    private _apiKey?;
+    constructor(options?: HyphenOptions);
+    get netInfo(): NetInfo;
+    get toggle(): Toggle;
+    get publicApiKey(): string | undefined;
+    set publicApiKey(value: string | undefined);
+    get apiKey(): string | undefined;
+    set apiKey(value: string | undefined);
+    get throwErrors(): boolean;
+    set throwErrors(value: boolean);
+}
+
+export { Hyphen, type HyphenOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };

package/dist/index.d.ts

@@ -1,5 +1,9 @@
-import { Hookified } from 'hookified';
+import { Hookified, HookifiedOptions } from 'hookified';
 import { EvaluationContext, Client } from '@openfeature/server-sdk';
+import * as axios from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { Cacheable } from 'cacheable';
+import pino from 'pino';
 
 type ToggleContext = EvaluationContext;
 declare enum ToggleHooks {
@@ -218,4 +222,120 @@ type LoadEnvOptions = {
  */
 declare function loadEnv(options?: LoadEnvOptions): void;
 
-export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };
+type BaseServiceOptions = {
+    throwErrors?: boolean;
+} & HookifiedOptions;
+declare class BaseService extends Hookified {
+    private _log;
+    private _cache;
+    private _throwErrors;
+    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;
+    get<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    post<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    put<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    delete<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    patch<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    createHeaders(apiKey?: string): Record<string, string>;
+}
+
+type NetInfoOptions = {
+    /**
+     * API key for authentication. If this is not provided it will try to use `HYPHEN_API_KEY` environment variable.
+     * @type {string} - The API key for authentication. This is not the public API key.
+     * @default undefined
+     */
+    apiKey?: string;
+    /**
+     * Base URI for the API. If not provided, it will use the default Hyphen API base URI.
+     * @type {string} - The base URI for the API.
+     * @default 'https://net.info'
+     */
+    baseUri?: string;
+} & BaseServiceOptions;
+type ipInfo = {
+    ip: string;
+    type: string;
+    location: {
+        country: string;
+        region: string;
+        city: string;
+        lat: number;
+        lng: number;
+        postalCode: string;
+        timezone: string;
+        geonameId: number;
+    };
+};
+type ipInfoError = {
+    ip: string;
+    type: string;
+    errorMessage: string;
+};
+declare class NetInfo extends BaseService {
+    private _apiKey;
+    private _baseUri;
+    constructor(options?: NetInfoOptions);
+    /**
+     * Gets or sets the API key for authentication.
+     * If not set, it will try to use the `HYPHEN_API_KEY` environment variable.
+     * @type {string | undefined}
+     */
+    get apiKey(): string | undefined;
+    /**
+     * Sets the API key for authentication.
+     * @param {string | undefined} value - The API key to set.
+     */
+    set apiKey(value: string | undefined);
+    /**
+     * Gets or sets the base URI for the API.
+     * @type {string}
+     */
+    get baseUri(): string;
+    /**
+     * Sets the base URI for the API.
+     * @param {string} value - The base URI to set.
+     */
+    set baseUri(value: string);
+    setApiKey(value: string | undefined): void;
+    /**
+     * Fetches GeoIP information for a given IP address.
+     * @param {string} ip - The IP address to fetch GeoIP information for.
+     * @returns {Promise<ipInfo | ipInfoError>} - A promise that resolves to the ip information or an error.
+     */
+    getIpInfo(ip: string): Promise<ipInfo | ipInfoError>;
+    getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
+}
+
+type HyphenOptions = {
+    publicApiKey?: string;
+    apiKey?: string;
+    throwErrors?: boolean;
+    toggle?: Omit<ToggleOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
+    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
+} & HookifiedOptions;
+declare class Hyphen extends Hookified {
+    private readonly _netInfo;
+    private readonly _toggle;
+    private _publicApiKey?;
+    private _apiKey?;
+    constructor(options?: HyphenOptions);
+    get netInfo(): NetInfo;
+    get toggle(): Toggle;
+    get publicApiKey(): string | undefined;
+    set publicApiKey(value: string | undefined);
+    get apiKey(): string | undefined;
+    set apiKey(value: string | undefined);
+    get throwErrors(): boolean;
+    set throwErrors(value: boolean);
+}
+
+export { Hyphen, type HyphenOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };

package/dist/index.js

@@ -406,7 +406,288 @@ function loadEnv(options) {
   }
 }
 __name(loadEnv, "loadEnv");
+
+// src/hyphen.ts
+import { Hookified as Hookified3 } from "hookified";
+
+// src/net-info.ts
+import process3 from "process";
+
+// src/base-service.ts
+import { Hookified as Hookified2 } from "hookified";
+import { Cacheable } from "cacheable";
+import axios from "axios";
+import pino from "pino";
+var ErrorMessages = /* @__PURE__ */ function(ErrorMessages2) {
+  ErrorMessages2["API_KEY_REQUIRED"] = "API key is required. Please provide it via options or set the HYPHEN_API_KEY environment variable.";
+  ErrorMessages2["PUBLIC_API_KEY_SHOULD_NOT_BE_USED"] = "The provided API key is a public API key. Please provide a valid non public API key for authentication.";
+  return ErrorMessages2;
+}({});
+var BaseService = class extends Hookified2 {
+  static {
+    __name(this, "BaseService");
+  }
+  _log = pino();
+  _cache = new Cacheable();
+  _throwErrors = false;
+  constructor(options) {
+    super(options);
+    if (options && options.throwErrors !== void 0) {
+      this._throwErrors = options.throwErrors;
+    }
+  }
+  get log() {
+    return this._log;
+  }
+  set log(value) {
+    this._log = value;
+  }
+  get cache() {
+    return this._cache;
+  }
+  set cache(value) {
+    this._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);
+    this.emit("warn", message, ...args);
+  }
+  info(message, ...args) {
+    this._log.info(message, ...args);
+    this.emit("info", message, ...args);
+  }
+  async get(url, config2) {
+    return axios.get(url, config2);
+  }
+  async post(url, data, config2) {
+    return axios.post(url, data, config2);
+  }
+  async put(url, data, config2) {
+    return axios.put(url, data, config2);
+  }
+  async delete(url, config2) {
+    return axios.delete(url, config2);
+  }
+  async patch(url, data, config2) {
+    return axios.patch(url, data, config2);
+  }
+  createHeaders(apiKey) {
+    const headers = {
+      "content-type": "application/json",
+      accept: "application/json"
+    };
+    if (apiKey) {
+      headers["x-api-key"] = apiKey;
+    }
+    return headers;
+  }
+};
+
+// src/net-info.ts
+loadEnv();
+var NetInfo = class extends BaseService {
+  static {
+    __name(this, "NetInfo");
+  }
+  _apiKey;
+  _baseUri = "https://net.info";
+  constructor(options) {
+    super(options);
+    if (options?.baseUri) {
+      this._baseUri = options.baseUri;
+    }
+    this.setApiKey(options?.apiKey);
+    if (!this._apiKey && process3.env.HYPHEN_API_KEY) {
+      this.setApiKey(process3.env.HYPHEN_API_KEY);
+    }
+    if (!this._apiKey) {
+      this.error(ErrorMessages.API_KEY_REQUIRED);
+    }
+  }
+  /**
+   * Gets or sets the API key for authentication.
+   * If not set, it will try to use the `HYPHEN_API_KEY` environment variable.
+   * @type {string | undefined}
+   */
+  get apiKey() {
+    return this._apiKey;
+  }
+  /**
+   * Sets the API key for authentication.
+   * @param {string | undefined} value - The API key to set.
+   */
+  set apiKey(value) {
+    this.setApiKey(value);
+  }
+  /**
+   * Gets or sets the base URI for the API.
+   * @type {string}
+   */
+  get baseUri() {
+    return this._baseUri;
+  }
+  /**
+   * Sets the base URI for the API.
+   * @param {string} value - The base URI to set.
+   */
+  set baseUri(value) {
+    this._baseUri = value;
+  }
+  setApiKey(value) {
+    if (value?.startsWith("public_")) {
+      this.error(ErrorMessages.PUBLIC_API_KEY_SHOULD_NOT_BE_USED);
+      return;
+    }
+    this._apiKey = value;
+  }
+  /**
+   * Fetches GeoIP information for a given IP address.
+   * @param {string} ip - The IP address to fetch GeoIP information for.
+   * @returns {Promise<ipInfo | ipInfoError>} - A promise that resolves to the ip information or an error.
+   */
+  async getIpInfo(ip) {
+    try {
+      if (!this._apiKey) {
+        throw new Error(ErrorMessages.API_KEY_REQUIRED);
+      }
+      const url = `${this._baseUri}/ip/${ip}`;
+      const headers = this.createHeaders(this._apiKey);
+      const response = await this.get(url, {
+        headers
+      });
+      if (response.status !== 200) {
+        const errorResult = {
+          ip,
+          type: "error",
+          errorMessage: `Failed to fetch ip info: ${response.statusText}`
+        };
+        return errorResult;
+      }
+      return response.data;
+    } catch (error) {
+      this.error(`Failed to fetch ip info: ${error instanceof Error ? error.message : "Unknown error"}`);
+      const errorResult = {
+        ip,
+        type: "error",
+        errorMessage: error instanceof Error ? error.message : "Unknown error"
+      };
+      return errorResult;
+    }
+  }
+  async getIpInfos(ips) {
+    if (!Array.isArray(ips) || ips.length === 0) {
+      this.error("The provided IPs array is invalid. It should be a non-empty array of strings.");
+      return [];
+    }
+    const errorResults = [];
+    try {
+      if (!this._apiKey) {
+        throw new Error(ErrorMessages.API_KEY_REQUIRED);
+      }
+      const url = `${this._baseUri}/ip`;
+      const headers = this.createHeaders(this._apiKey);
+      const response = await this.post(url, ips, {
+        headers
+      });
+      if (response.status !== 200) {
+        errorResults.push({
+          ip: "",
+          type: "error",
+          errorMessage: `Failed to fetch ip infos: ${response.statusText}`
+        });
+        return errorResults;
+      }
+      const responseData = response?.data;
+      return responseData.data;
+    } catch (error) {
+      this.error(`Failed to fetch ip infos: ${error instanceof Error ? error.message : "Unknown error"}`);
+      errorResults.push({
+        ip: "",
+        type: "error",
+        errorMessage: error instanceof Error ? error.message : "Unknown error"
+      });
+      return errorResults;
+    }
+  }
+};
+
+// src/hyphen.ts
+var Hyphen = class extends Hookified3 {
+  static {
+    __name(this, "Hyphen");
+  }
+  _netInfo;
+  _toggle;
+  _publicApiKey;
+  _apiKey;
+  constructor(options) {
+    super(options);
+    const toggleOptions = options?.toggle ?? {};
+    const netInfoOptions = options?.netInfo ?? {};
+    if (options?.publicApiKey) {
+      this._publicApiKey = options.publicApiKey;
+      toggleOptions.publicApiKey = options.publicApiKey;
+    }
+    if (options?.apiKey) {
+      this._apiKey = options.apiKey;
+      netInfoOptions.apiKey = options.apiKey;
+    }
+    if (options?.throwErrors !== void 0) {
+      toggleOptions.throwErrors = options.throwErrors;
+      netInfoOptions.throwErrors = options.throwErrors;
+    }
+    this._netInfo = new NetInfo(netInfoOptions);
+    this._netInfo.on("error", (message, ...args) => this.emit("error", message, ...args));
+    this._netInfo.on("info", (message, ...args) => this.emit("info", message, ...args));
+    this._netInfo.on("warn", (message, ...args) => this.emit("warn", message, ...args));
+    this._toggle = new Toggle(toggleOptions);
+    this._toggle.on("error", (message, ...args) => this.emit("error", message, ...args));
+    this._toggle.on("info", (message, ...args) => this.emit("info", message, ...args));
+    this._toggle.on("warn", (message, ...args) => this.emit("warn", message, ...args));
+  }
+  get netInfo() {
+    return this._netInfo;
+  }
+  get toggle() {
+    return this._toggle;
+  }
+  get publicApiKey() {
+    return this._publicApiKey;
+  }
+  set publicApiKey(value) {
+    this._publicApiKey = value;
+    this._toggle.publicApiKey = value;
+  }
+  get apiKey() {
+    return this._apiKey;
+  }
+  set apiKey(value) {
+    this._apiKey = value;
+    this._netInfo.apiKey = value;
+  }
+  get throwErrors() {
+    return this._netInfo.throwErrors && this._toggle.throwErrors;
+  }
+  set throwErrors(value) {
+    this._netInfo.throwErrors = value;
+    this._toggle.throwErrors = value;
+  }
+};
 export {
+  Hyphen,
   Toggle,
   ToggleHooks,
   loadEnv

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",
@@ -29,15 +29,15 @@
   "author": "Team Hyphen <hello@hyphen.ai>",
   "license": "MIT",
   "devDependencies": {
-    "@swc/core": "^1.11.29",
-    "@types/node": "^22.15.21",
-    "@vitest/coverage-v8": "^3.1.4",
+    "@swc/core": "^1.12.9",
+    "@types/node": "^24.0.10",
+    "@vitest/coverage-v8": "^3.2.4",
     "rimraf": "^6.0.1",
     "tsd": "^0.32.0",
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
-    "vitest": "^3.1.4",
-    "xo": "^1.1.0"
+    "vitest": "^3.2.4",
+    "xo": "^1.1.1"
   },
   "files": [
     "dist",
@@ -47,9 +47,9 @@
     "@hyphen/openfeature-server-provider": "^1.0.7",
     "@openfeature/server-sdk": "^1.18.0",
     "axios": "^1.10.0",
-    "cacheable": "^1.10.0",
-    "dotenv": "^16.5.0",
-    "hookified": "^1.9.0",
+    "cacheable": "^1.10.1",
+    "dotenv": "^17.0.1",
+    "hookified": "^1.10.0",
     "pino": "^9.7.0"
   }
 }