@hyphen/sdk 1.8.0 → 1.10.0

package/dist/index.js

@@ -406,7 +406,470 @@ 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/link.ts
+import process4 from "process";
+loadEnv();
+var defaultLinkUris = [
+  "https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"
+];
+var Link = class extends BaseService {
+  static {
+    __name(this, "Link");
+  }
+  _uris = defaultLinkUris;
+  _organizationId;
+  _apiKey;
+  constructor(options) {
+    super(options);
+    this._uris = options?.uris ?? defaultLinkUris;
+    this._organizationId = options?.organizationId;
+    if (options?.apiKey) {
+      this.setApiKey(options.apiKey);
+    }
+    if (!this._apiKey && process4.env.HYPHEN_API_KEY) {
+      this.setApiKey(process4.env.HYPHEN_API_KEY);
+    }
+    if (!this._organizationId && process4.env.HYPHEN_ORGANIZATION_ID) {
+      this._organizationId = process4.env.HYPHEN_ORGANIZATION_ID;
+    }
+  }
+  /**
+  * Get the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
+  * @returns {string[]} The URIs for the link service.
+  */
+  get uris() {
+    return this._uris;
+  }
+  /**
+  * Set the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
+  * @param {string[]} uris - The URIs to set.
+  */
+  set uris(uris) {
+    this._uris = uris;
+  }
+  /**
+  * Get the organization ID for the link service. This is required to access the link service.
+  * @returns {string | undefined} The organization ID.
+  */
+  get organizationId() {
+    return this._organizationId;
+  }
+  /**
+  * Set the organization ID for the link service. This is required to access the link service.
+  * @param {string | undefined} organizationId - The organization ID to set.
+  */
+  set organizationId(organizationId) {
+    this._organizationId = organizationId;
+  }
+  /**
+  * Get the API key for the link service. This is required to access the link service.
+  * @returns {string | undefined} The API key.
+  */
+  get apiKey() {
+    return this._apiKey;
+  }
+  /**
+  * Set the API key for the link service. This is required to access the link service.
+  * @param {string | undefined} apiKey - The API key to set.
+  */
+  set apiKey(apiKey) {
+    this.setApiKey(apiKey);
+  }
+  /**
+  * Set the API key for the link service. If the API key starts with 'public_', an error is thrown.
+  * This is to ensure that the API key is not a public key, which should not be used for authenticated requests.
+  * @param {string} apiKey
+  */
+  setApiKey(apiKey) {
+    if (apiKey?.startsWith("public_")) {
+      throw new Error('API key cannot start with "public_"');
+    }
+    if (apiKey) {
+      this._apiKey = apiKey;
+    }
+  }
+  async createShortCode(longUrl, domain, options) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to create a short code.");
+    }
+    const url = this._uris[0].replace("{organizationId}", this._organizationId);
+    const body = {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      long_url: longUrl,
+      domain,
+      code: options?.code,
+      title: options?.title,
+      tags: options?.tags
+    };
+    const headers = this.createHeaders(this._apiKey);
+    const response = await this.post(url, body, {
+      headers
+    });
+    if (response.status === 201) {
+      return response.data;
+    }
+    throw new Error(`Failed to create short code: ${response.statusText}`);
+  }
+  /**
+  * Delete a short code.
+  * @param {string} code The short code to delete. Example: 'code_686bed403c3991bd676bba4d'
+  * @returns {Promise<boolean>} A promise that resolves to true if the short code was deleted successfully, or false if it was not.
+  */
+  async deleteShortCode(code) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to delete a short code.");
+    }
+    let url = this._uris[0].replace("{organizationId}", this._organizationId);
+    url = url.endsWith("/") ? `${url}${code}/` : `${url}/${code}/`;
+    const headers = this.createHeaders(this._apiKey);
+    delete headers["content-type"];
+    const response = await this.delete(url, {
+      headers
+    });
+    if (response.status === 204) {
+      return true;
+    }
+    throw new Error(`Failed to delete short code: ${response.statusText}`);
+  }
+};
+
+// src/hyphen.ts
+var Hyphen = class extends Hookified3 {
+  static {
+    __name(this, "Hyphen");
+  }
+  _netInfo;
+  _toggle;
+  _link;
+  _publicApiKey;
+  _apiKey;
+  constructor(options) {
+    super(options);
+    const toggleOptions = options?.toggle ?? {};
+    const netInfoOptions = options?.netInfo ?? {};
+    const linkOptions = options?.link ?? {};
+    if (options?.publicApiKey) {
+      this._publicApiKey = options.publicApiKey;
+      toggleOptions.publicApiKey = options.publicApiKey;
+    }
+    if (options?.apiKey) {
+      this._apiKey = options.apiKey;
+      netInfoOptions.apiKey = options.apiKey;
+      linkOptions.apiKey = options.apiKey;
+    }
+    if (options?.throwErrors !== void 0) {
+      toggleOptions.throwErrors = options.throwErrors;
+      netInfoOptions.throwErrors = options.throwErrors;
+      linkOptions.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));
+    this._link = new Link(linkOptions);
+    this._link.on("error", (message, ...args) => this.emit("error", message, ...args));
+    this._link.on("info", (message, ...args) => this.emit("info", message, ...args));
+    this._link.on("warn", (message, ...args) => this.emit("warn", message, ...args));
+  }
+  /**
+  * Get the NetInfo service instance.
+  * @returns {NetInfo} The NetInfo service instance.
+  */
+  get netInfo() {
+    return this._netInfo;
+  }
+  /**
+  * Get the Toggle service instance.
+  * @returns {Toggle} The Toggle service instance.
+  */
+  get toggle() {
+    return this._toggle;
+  }
+  /**
+  * Get the Link service instance.
+  * @returns {Link} The Link service instance.
+  */
+  get link() {
+    return this._link;
+  }
+  /**
+  * Get the public API key for the Hyphen service.
+  * This is used for public endpoints that do not require authentication.
+  * @returns {string | undefined} The public API key.
+  */
+  get publicApiKey() {
+    return this._publicApiKey;
+  }
+  /**
+  * Set the public API key for the Hyphen service. If set, this will also update the underlying services.
+  * This is used for public endpoints that do not require authentication such as the Toggle service.
+  * @param {string | undefined} value - The public API key to set.
+  */
+  set publicApiKey(value) {
+    this._publicApiKey = value;
+    this._toggle.publicApiKey = value;
+  }
+  /**
+  * Get the API key for the Hyphen service.
+  * This is used for authenticated endpoints that require an API key such as the NetInfo and Link services.
+  * @returns {string | undefined} The API key.
+  */
+  get apiKey() {
+    return this._apiKey;
+  }
+  /**
+  * Set the API key for the Hyphen service. If set, this will also update the underlying services.
+  * This is used for authenticated endpoints that require an API key such as the NetInfo and Link services.
+  * @param {string | undefined} value - The API key to set.
+  */
+  set apiKey(value) {
+    this._apiKey = value;
+    this._netInfo.apiKey = value;
+    this._link.apiKey = value;
+  }
+  /**
+  * Get whether to throw errors or not.
+  * If set to true, errors will be thrown instead of logged.
+  * @returns {boolean} Whether to throw errors or not.
+  */
+  get throwErrors() {
+    return this._netInfo.throwErrors && this._toggle.throwErrors && this._link.throwErrors;
+  }
+  /**
+  * Set whether to throw errors or not. If set to true, errors will be thrown instead of logged.
+  * This will update the underlying services as well.
+  * @param {boolean} value - Whether to throw errors or not.
+  */
+  set throwErrors(value) {
+    this._netInfo.throwErrors = value;
+    this._toggle.throwErrors = value;
+    this._link.throwErrors = value;
+  }
+};
 export {
+  Hyphen,
   Toggle,
   ToggleHooks,
   loadEnv

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.8.0",
+  "version": "1.10.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"
   }
 }