@hyphen/sdk 1.10.0 → 1.12.0

package/README.md

@@ -24,6 +24,16 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 	- [Loading Environment Variables](#loading-environment-variables)
 - [Net Info - Geo Information Service](#net-info---geo-information-service)
 - [Link - Short Code Service](#link---short-code-service)
+	- [Creating a Short Code](#creating-a-short-code)
+	- [Updating a Short Code](#updating-a-short-code)
+	- [Getting a Short Code](#getting-a-short-code)
+	- [Getting Short Codes](#getting-short-codes)
+	- [Getting all Organization Tags](#getting-all-organization-tags)
+	- [Getting Short Code Stats](#getting-short-code-stats)
+	- [Deleting a Short Code](#deleting-a-short-code)
+	- [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)
 - [Contributing](#contributing)
 - [Testing Your Changes](#testing-your-changes)
 - [License and Copyright](#license-and-copyright)
@@ -577,44 +587,44 @@ console.log('Boolean toggle value:', result); // true
 Hyphens secret management service known as [ENV](https://hyphen.ai/env) allows you to manage your environment variables in a secure way. The Hyphen Node.js SDK provides a simple way to access your environment variables.
 
 ## Loading Environment Variables
-To load your environment variables, you can use the `loadEnv` function from the SDK. This function will automatically load your environment variables from the `.env` file and then override them with the environment based environment file if it exists (ex: `.env.development`). This is useful for managing different environments such as development, staging, and production. 
+To load your environment variables, you can use the `env()` function from the SDK. This function will automatically load your environment variables from the `.env` file and then override them with the environment based environment file if it exists (ex: `.env.development`). This is useful for managing different environments such as development, staging, and production. 
 
 The following override path is:
 ```
 .env -> .env.local -> .env.<environment> -> .env.<environment>.local
 ```
 
-Here is an example of how to use the `loadEnv` function:
+Here is an example of how to use the `env()` function:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 
 //load your default environment variables and envrionment variables
-loadEnv();
+env();
 ```
 
 If your environment variables are not stored in the root of your project you can specify the path to your `.env` file:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 //load your default environment variables and envrionment variables
-loadEnv({ path: '/path/to/your/env/files/' });
+env({ path: '/path/to/your/env/files/' });
 ```
 
 You can also specify the environment variables to load by passing an array of variable names:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 //load your default environment variables and envrionment variables
-loadEnv({ environment: 'development' });
+env({ environment: 'development' });
 ```
 
 if you want to turn off the local environment variables you can do it like this:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 //load your default environment variables and envrionment variables
-loadEnv({ local: false });
+env({ local: false });
 ```
 
 # Net Info - Geo Information Service
@@ -653,7 +663,14 @@ You can also set the API key using the `HYPHEN_API_KEY` environment variable. Th
 
 # Link - Short Code Service
 
-The Hyphen Node.js SDK also provides a `Link` class that allows you to create and manage short codes. This can be useful for generating short links for your application. Here is an example of creating a short code:
+The Hyphen Node.js SDK also provides a `Link` class that allows you to create and manage short codes. This can be useful for generating short links for your application.
+
+* [Website](https://hyphen.ai/link)
+* [Guides](https://docs.hyphen.ai/docs/create-short-link)
+* [API Reference](https://docs.hyphen.ai/reference/post_api-organizations-organizationid-link-codes)
+
+## Creating a Short Code
+To create a short code, you can use the `createShortCode` method:
 
 ```javascript
 import { Link } from '@hyphen/sdk';
@@ -670,6 +687,88 @@ const response = await link.createShortCode(longUrl, domain, options);
 console.log('Short Code Response:', response);
 ```
 
+## Updating a Short Code
+To update a short code, you can use the `updateShortCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code you want to update
+const longUrl = 'https://hyphen.ai/updated';
+const options = {
+  title: 'Updated Short Code',
+  tags: ['sdk-test', 'unit-test'],
+  long_url: longUrl,
+};
+
+const updateResponse = await link.updateShortCode(code, options);
+console.log('Update Short Code Response:', updateResponse);
+```
+
+## Getting a Short Code
+To get a short code, you can use the `getShortCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code you want to get
+const response = await link.getShortCode(code);
+console.log('Get Short Code Response:', response);
+```
+
+## Getting Short Codes
+To get a list of short codes, you can use the `getShortCodes` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const title = 'My Short Codes'; // Optional title to filter short codes
+const tags = ['sdk-test', 'unit-test']; // Optional tags to filter short codes
+const response = await link.getShortCodes(title, tags);
+console.log('Get Short Codes Response:', response);
+```
+
+## Getting all Organization Tags
+
+To get all tags for your organization, you can use the `getTags` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const response = await link.getTags();
+console.log('Get Tags Response:', response);
+```
+
+## Get Short Code Stats
+
+To get the stats for a short code, you can use the `getShortCodeStats` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const startDate = new Date('2023-01-01'); // Optional start date for the stats
+const endDate = new Date('2023-12-31'); // Optional end date for the stats
+const response = await link.getShortCodeStats(code, startDate, endDate);
+console.log('Get Short Code Stats Response:', response);
+```
+
+## Deleting a Short Code
 if you want to delete a short code you can do it like this:
 
 ```javascript
@@ -683,6 +782,100 @@ const response = await link.deleteShortCode(code);
 console.log('Delete Short Code Response:', response);
 ```
 
+## Creating a QR Code from a Short Code
+
+To create a QR code from a short code, you can use the `createQrCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code you want to create a QR code for
+const response = await link.createQrCode(code);
+console.log('Create QR Code Response:', response);
+```
+
+There are options that you can pass in to the `createQrCode` method to customize the QR code:
+
+```typescript
+export type CreateQrCodeOptions = {
+	/**
+	 * The title of the QR code. This is used for display purposes.
+	 * @default undefined
+	 */
+	title?: string;
+	/**
+	 * The background color of the QR code. This is a hex color code.
+	 * @default '#ffffff'
+	 */
+	backgroundColor?: string;
+	/**
+	 * The color of the QR code. This is a hex color code.
+	 * @default '#000000'
+	 */
+	color?: string;
+	/**
+	 * The size of the QR code. This can be 'small', 'medium', or 'large'.
+	 * @default QrSize.MEDIUM
+	 */
+	size?: QrSize;
+	/**
+	 * The logo to include in the QR code. This should be a base64 encoded string.
+	 * @default undefined
+	 */
+	logo?: string;
+};
+```
+
+## Get a QR Code By Id
+
+To get a specific QR code by its ID, you can use the `getQrCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const qr = 'qr_1234567890'; // It is the ID of the QR code you want to retrieve
+const response = await link.getQrCode(code, qr);
+console.log('Get QR Code Response:', response);
+```
+
+## Get QR Codes for a Short Code
+
+To get all QR codes for a short code, you can use the `getQrCodes` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const response = await link.getQrCodes(code);
+console.log('Get QR Codes Response:', response);
+```
+
+## Deleting a QR Code
+
+To delete a QR code, you can use the `deleteQrCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const qr = 'qr_1234567890'; // It is the ID of the QR code you want to delete
+const response = await link.deleteQrCode(code, qr);
+console.log('Delete QR Code Response:', response);
+```
+
 # 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

@@ -34,6 +34,7 @@ __export(index_exports, {
   Hyphen: () => Hyphen,
   Toggle: () => Toggle,
   ToggleHooks: () => ToggleHooks,
+  env: () => env,
   loadEnv: () => loadEnv
 });
 module.exports = __toCommonJS(index_exports);
@@ -404,7 +405,7 @@ var import_node_process2 = __toESM(require("process"), 1);
 var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path = __toESM(require("path"), 1);
 var import_dotenv2 = require("dotenv");
-function loadEnv(options) {
+function env(options) {
   const local = options?.local ?? true;
   const currentWorkingDirectory = options?.path ?? import_node_process2.default.cwd();
   const envPath = import_node_path.default.resolve(currentWorkingDirectory, ".env");
@@ -442,7 +443,8 @@ function loadEnv(options) {
     }
   }
 }
-__name(loadEnv, "loadEnv");
+__name(env, "env");
+var loadEnv = env;
 
 // src/hyphen.ts
 var import_hookified3 = require("hookified");
@@ -516,6 +518,9 @@ var BaseService = class extends import_hookified2.Hookified {
     return import_axios.default.put(url, data, config2);
   }
   async delete(url, config2) {
+    if (config2 && config2.headers) {
+      delete config2.headers["content-type"];
+    }
     return import_axios.default.delete(url, config2);
   }
   async patch(url, data, config2) {
@@ -534,7 +539,7 @@ var BaseService = class extends import_hookified2.Hookified {
 };
 
 // src/net-info.ts
-loadEnv();
+env();
 var NetInfo = class extends BaseService {
   static {
     __name(this, "NetInfo");
@@ -663,7 +668,8 @@ var NetInfo = class extends BaseService {
 
 // src/link.ts
 var import_node_process4 = __toESM(require("process"), 1);
-loadEnv();
+var import_node_buffer = require("buffer");
+env();
 var defaultLinkUris = [
   "https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"
 ];
@@ -743,11 +749,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,
@@ -766,6 +804,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.
@@ -774,10 +925,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
     });
@@ -786,6 +935,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 = import_node_buffer.Buffer.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 = import_node_buffer.Buffer.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 = import_node_buffer.Buffer.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
@@ -910,5 +1165,6 @@ var Hyphen = class extends import_hookified3.Hookified {
   Hyphen,
   Toggle,
   ToggleHooks,
+  env,
   loadEnv
 });