@hyphen/sdk 1.10.0 → 1.12.0

package/dist/index.js

@@ -367,7 +367,7 @@ import process2 from "process";
 import fs from "fs";
 import path from "path";
 import { config } from "dotenv";
-function loadEnv(options) {
+function env(options) {
   const local = options?.local ?? true;
   const currentWorkingDirectory = options?.path ?? process2.cwd();
   const envPath = path.resolve(currentWorkingDirectory, ".env");
@@ -405,7 +405,8 @@ function loadEnv(options) {
     }
   }
 }
-__name(loadEnv, "loadEnv");
+__name(env, "env");
+var loadEnv = env;
 
 // src/hyphen.ts
 import { Hookified as Hookified3 } from "hookified";
@@ -479,6 +480,9 @@ var BaseService = class extends Hookified2 {
     return axios.put(url, data, config2);
   }
   async delete(url, config2) {
+    if (config2 && config2.headers) {
+      delete config2.headers["content-type"];
+    }
     return axios.delete(url, config2);
   }
   async patch(url, data, config2) {
@@ -497,7 +501,7 @@ var BaseService = class extends Hookified2 {
 };
 
 // src/net-info.ts
-loadEnv();
+env();
 var NetInfo = class extends BaseService {
   static {
     __name(this, "NetInfo");
@@ -626,7 +630,8 @@ var NetInfo = class extends BaseService {
 
 // src/link.ts
 import process4 from "process";
-loadEnv();
+import { Buffer as Buffer2 } from "buffer";
+env();
 var defaultLinkUris = [
   "https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"
 ];
@@ -706,11 +711,43 @@ var Link = class extends BaseService {
       this._apiKey = apiKey;
     }
   }
+  /**
+  * Get the URI for a specific organization and code. This is used internally to construct the URI for the link service.
+  * @param {string} organizationId The ID of the organization.
+  * @param {string} code The code to include in the URI.
+  * @returns {string} The constructed URI.
+  */
+  getUri(organizationId, prefix1, prefix2, prefix3) {
+    if (!organizationId) {
+      throw new Error("Organization ID is required to get the URI.");
+    }
+    let url = this._uris[0].replace("{organizationId}", organizationId);
+    if (prefix1) {
+      url = url.endsWith("/") ? `${url}${prefix1}/` : `${url}/${prefix1}`;
+    }
+    if (prefix2) {
+      url = url.endsWith("/") ? `${url}${prefix2}/` : `${url}/${prefix2}`;
+    }
+    if (prefix3) {
+      url = url.endsWith("/") ? `${url}${prefix3}/` : `${url}/${prefix3}`;
+    }
+    if (url.endsWith("/")) {
+      url = url.slice(0, -1);
+    }
+    return url;
+  }
+  /**
+  * Create a short code for a long URL.
+  * @param {string} longUrl The long URL to shorten.
+  * @param {string} domain The domain to use for the short code.
+  * @param {CreateShortCodeOptions} options Optional parameters for creating the short code.
+  * @returns {Promise<CreateShortCodeResponse>} A promise that resolves to the created short code details.
+  */
   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 url = this.getUri(this._organizationId);
     const body = {
       // eslint-disable-next-line @typescript-eslint/naming-convention
       long_url: longUrl,
@@ -729,6 +766,119 @@ var Link = class extends BaseService {
     throw new Error(`Failed to create short code: ${response.statusText}`);
   }
   /**
+  * Get a short code by its code.
+  * @param {string} code The short code to retrieve. Example: 'code_686bed403c3991bd676bba4d'
+  * @returns {Promise<GetShortCodeResponse>} A promise that resolves to the short code details.
+  */
+  async getShortCode(code) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to get a short code.");
+    }
+    const url = this.getUri(this._organizationId, code);
+    const headers = this.createHeaders(this._apiKey);
+    const response = await this.get(url, {
+      headers
+    });
+    if (response.status === 200) {
+      return response.data;
+    }
+    throw new Error(`Failed to get short code: ${response.statusText}`);
+  }
+  /**
+  * Get all short codes for the organization.
+  * @param {string} titleSearch Optional search term to filter short codes by title.
+  * @param {string[]} tags Optional tags to filter short codes.
+  * @param {number} pageNumber The page number to retrieve. Default is 1.
+  * @param {number} pageSize The number of short codes per page. Default is 100.
+  * @returns {Promise<GetShortCodesResponse>} A promise that resolves to the list of short codes.
+  */
+  async getShortCodes(titleSearch, tags, pageNumber = 1, pageSize = 100) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to get short codes.");
+    }
+    const url = this.getUri(this._organizationId);
+    const headers = this.createHeaders(this._apiKey);
+    const parameters = {};
+    if (titleSearch) {
+      parameters.title = titleSearch;
+    }
+    if (tags && tags.length > 0) {
+      parameters.tags = tags.join(",");
+    }
+    parameters.pageNum = pageNumber.toString();
+    parameters.pageSize = pageSize.toString();
+    const response = await this.get(url, {
+      headers,
+      params: parameters
+    });
+    if (response.status === 200) {
+      return response.data;
+    }
+    throw new Error(`Failed to get short codes: ${response.statusText}`);
+  }
+  /**
+  * Get all tags associated with the organization's short codes.
+  * @returns {Promise<string[]>} A promise that resolves to an array of tags.
+  */
+  async getTags() {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to get tags.");
+    }
+    const url = this.getUri(this._organizationId, "tags");
+    const headers = this.createHeaders(this._apiKey);
+    const response = await this.get(url, {
+      headers
+    });
+    if (response.status === 200) {
+      return response.data;
+    }
+    throw new Error(`Failed to get tags: ${response.statusText}`);
+  }
+  /**
+  * Get statistics for a specific short code.
+  * @param code The short code to retrieve statistics for.
+  * @returns {Promise<GetCodeStatsResponse>} A promise that resolves to the code statistics.
+  */
+  async getCodeStats(code, startDate, endDate) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to get code stats.");
+    }
+    const url = this.getUri(this._organizationId, code, "stats");
+    const headers = this.createHeaders(this._apiKey);
+    const parameters = {
+      startDate: startDate.toISOString(),
+      endDate: endDate.toISOString()
+    };
+    const response = await this.get(url, {
+      headers,
+      params: parameters
+    });
+    if (response.status === 200) {
+      return response.data;
+    }
+    throw new Error(`Failed to get code stats: ${response.statusText}`);
+  }
+  /**
+  * Update a short code.
+  * @param {string} code The short code to update. Example: 'code_686bed403c3991bd676bba4d'
+  * @param {UpdateShortCodeOptions} options The options to update the short code with.
+  * @returns {Promise<UpdateShortCodeResponse>} A promise that resolves to the updated short code details.
+  */
+  async updateShortCode(code, options) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to update a short code.");
+    }
+    const url = this.getUri(this._organizationId, code);
+    const headers = this.createHeaders(this._apiKey);
+    const response = await this.patch(url, options, {
+      headers
+    });
+    if (response.status === 200) {
+      return response.data;
+    }
+    throw new Error(`Failed to update 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.
@@ -737,10 +887,8 @@ var Link = class extends BaseService {
     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 url = this.getUri(this._organizationId, code);
     const headers = this.createHeaders(this._apiKey);
-    delete headers["content-type"];
     const response = await this.delete(url, {
       headers
     });
@@ -749,6 +897,112 @@ var Link = class extends BaseService {
     }
     throw new Error(`Failed to delete short code: ${response.statusText}`);
   }
+  /**
+  * Create a QR code for a specific short code.
+  * @param {string} code The short code to create a QR code for.
+  * @param {CreateQrCodeOptions} options The options for creating the QR code.
+  * @returns {Promise<CreateQrCodeResponse>} A promise that resolves to the created QR code details.
+  */
+  async createQrCode(code, options) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to create a QR code.");
+    }
+    const url = this.getUri(this._organizationId, code, "qrs");
+    const headers = this.createHeaders(this._apiKey);
+    const body = {
+      title: options?.title,
+      backgroundColor: options?.backgroundColor,
+      color: options?.color,
+      size: options?.size,
+      logo: options?.logo
+    };
+    const response = await this.post(url, body, {
+      headers
+    });
+    if (response.status === 201) {
+      const result = response.data;
+      if (result.qrCode) {
+        const buffer = Buffer2.from(result.qrCode, "base64");
+        result.qrCodeBytes = new Uint16Array(buffer);
+      }
+      return result;
+    }
+    throw new Error(`Failed to create QR code: ${response.statusText}`);
+  }
+  /**
+  * Get a QR code by its ID.
+  * @param code The short code associated with the QR code.
+  * @param qr The ID of the QR code to retrieve.
+  * @returns The details of the requested QR code.
+  */
+  async getQrCode(code, qr) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to get a QR code.");
+    }
+    const url = this.getUri(this._organizationId, code, "qrs", qr);
+    const headers = this.createHeaders(this._apiKey);
+    const response = await this.get(url, {
+      headers
+    });
+    if (response.status === 200) {
+      const result = response.data;
+      if (result.qrCode) {
+        const buffer = Buffer2.from(result.qrCode, "base64");
+        result.qrCodeBytes = new Uint16Array(buffer);
+      }
+      return result;
+    }
+    throw new Error(`Failed to get QR code: ${response.statusText}`);
+  }
+  async getQrCodes(code, pageNumber, pageSize) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to get QR codes.");
+    }
+    const url = this.getUri(this._organizationId, code, "qrs");
+    const headers = this.createHeaders(this._apiKey);
+    const parameters = {};
+    if (pageNumber) {
+      parameters.pageNum = pageNumber.toString();
+    }
+    if (pageSize) {
+      parameters.pageSize = pageSize.toString();
+    }
+    const response = await this.get(url, {
+      headers,
+      params: parameters
+    });
+    if (response.status === 200) {
+      const result = response.data;
+      for (const qrCode of result.data) {
+        if (qrCode.qrCode) {
+          const buffer = Buffer2.from(qrCode.qrCode, "base64");
+          qrCode.qrCodeBytes = new Uint16Array(buffer);
+        }
+      }
+      return result;
+    }
+    throw new Error(`Failed to get QR codes: ${response.statusText}`);
+  }
+  /**
+  * Delete a QR code by its ID.
+  * @param {string} code The short code associated with the QR code.
+  * @param {string} qr The ID of the QR code to delete.
+  * @returns {Promise<boolean>} A promise that resolves to true if the QR code was deleted successfully, or false if it was not.
+  */
+  async deleteQrCode(code, qr) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to delete a QR code.");
+    }
+    const url = this.getUri(this._organizationId, code, "qrs", qr);
+    const headers = this.createHeaders(this._apiKey);
+    const response = await this.delete(url, {
+      headers
+    });
+    if (response.status === 204) {
+      return true;
+    }
+    throw new Error(`Failed to delete QR code: ${response.statusText}`);
+  }
 };
 
 // src/hyphen.ts
@@ -872,5 +1126,6 @@ export {
   Hyphen,
   Toggle,
   ToggleHooks,
+  env,
   loadEnv
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",
@@ -29,26 +29,27 @@
   "author": "Team Hyphen <hello@hyphen.ai>",
   "license": "MIT",
   "devDependencies": {
-    "@swc/core": "^1.12.9",
-    "@types/node": "^24.0.10",
+    "@swc/core": "^1.13.2",
+    "@types/node": "^24.1.0",
     "@vitest/coverage-v8": "^3.2.4",
     "rimraf": "^6.0.1",
     "tsd": "^0.32.0",
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
-    "xo": "^1.1.1"
+    "xo": "^1.2.1"
   },
   "files": [
     "dist",
     "LICENSE"
   ],
   "dependencies": {
+    "@faker-js/faker": "^9.9.0",
     "@hyphen/openfeature-server-provider": "^1.0.7",
     "@openfeature/server-sdk": "^1.18.0",
-    "axios": "^1.10.0",
-    "cacheable": "^1.10.1",
-    "dotenv": "^17.0.1",
+    "axios": "^1.11.0",
+    "cacheable": "^1.10.3",
+    "dotenv": "^17.2.1",
     "hookified": "^1.10.0",
     "pino": "^9.7.0"
   }