@hyphen/sdk 1.9.0 → 1.11.0

package/README.md

@@ -12,7 +12,7 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 # Table of Contents
 - [Installation](#installation)
 - [Basic Usage with Hyphen](#basic-usage-with-hyphen)
-- [Toggle](#toggle)
+- [Toggle - Feature Flag Service](#toggle---feature-flag-service)
 	- [Toggle Options](#toggle-options)
 	- [Toggle API](#toggle-api)
 	- [Toggle Hooks](#toggle-hooks)
@@ -20,9 +20,14 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 	- [Toggle Caching](#toggle-caching)
 	- [Toggle Environment Variables](#toggle-environment-variables)
 	- [Toggle Self-Hosted](#toggle-self-hosted)
-- [ENV](#env)
+- [ENV - Secret Management Service](#env---secret-management-service)
 	- [Loading Environment Variables](#loading-environment-variables)
-- [Net Info](#net-info)
+- [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)
+	- [Getting a Short Code](#getting-a-short-code)
+	- [Getting Short Codes](#getting-short-codes)
+	- [Deleting a Short Code](#deleting-a-short-code)
 - [Contributing](#contributing)
 - [Testing Your Changes](#testing-your-changes)
 - [License and Copyright](#license-and-copyright)
@@ -123,7 +128,7 @@ console.log('Geo IP information:', result);
 
 The rest of the examples for each service show you accessing the service instance directly. 
 
-# Toggle
+# Toggle - Feature Flag Service
 
 [Toggle](https://hyphen.ai/toggle) is our feature flag service that allows you to control the rollout of new features to your users. You can access your feature flags using the `Toggle` class.
 
@@ -571,7 +576,7 @@ const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
 console.log('Boolean toggle value:', result); // true
 ```
 
-# ENV
+# ENV - Secret Management Service
 
 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.
 
@@ -616,7 +621,7 @@ import { loadEnv } from '@hyphen/sdk';
 loadEnv({ local: false });
 ```
 
-# Net Info
+# Net Info - Geo Information Service
 
 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:
 
@@ -650,6 +655,75 @@ 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.
 
+# 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.
+
+* [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';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const longUrl = 'https://hyphen.ai';
+const domain = 'test.h4n.link';
+const options = {
+  tags: ['sdk-test', 'unit-test'],
+};
+const response = await link.createShortCode(longUrl, domain, options);
+console.log('Short Code Response:', response);
+```
+
+## 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);
+```
+
+## Deleting a Short Code
+if you want to delete a short code you can do it like this:
+
+```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 delete
+const response = await link.deleteShortCode(code);
+console.log('Delete Short 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:
@@ -690,9 +764,19 @@ Once you have created the project, added the toggles, and created your applicati
 HYPHEN_PUBLIC_API_KEY=your_public_api_key
 HYPHEN_API_KEY=your_api_key
 HYPHEN_APPLICATION_ID=your_project_id
+HYPHEN_LINK_DOMAIN=your_link_domain
+HYPHEN_ORGANIZATION_ID=your_organization_id
 ```
 
-The `HYPHEN_PUBLIC_API_KEY` is the public API key for your Hyphen project, `HYPHEN_API_KEY` is the API key used for things such as `NetInfo` and is located under settings in the dashboard, and `HYPHEN_APPLICATION_ID` is the application ID for your Hyphen project.
+A bit more information about the environment variables:
+
+| Variable | Example Value | Description |
+|----------------|----------------|----------------|
+| *HYPHEN_PUBLIC_API_KEY* | `public_api_key` | The public API key for your Hyphen project. You can find this in the Hyphen dashboard. |
+| *HYPHEN_API_KEY* | `api_key` | The API key for your Hyphen project. You can find this in the Hyphen dashboard. |
+| *HYPHEN_APPLICATION_ID* | `application_id` | The application ID for your Hyphen project. You can find this in the Hyphen dashboard. |
+| *HYPHEN_LINK_DOMAIN* | `test.h4n.link` | The domain for the Link service. This is used for generating links. |
+| *HYPHEN_ORGANIZATION_ID* | `org_668575c0e169cde974a5c76a` | | The organization ID for your Hyphen project. This is used for the Link service. |
 
 Then run the tests with the following command:
 

package/dist/index.cjs

@@ -661,6 +661,191 @@ var NetInfo = class extends BaseService {
   }
 };
 
+// src/link.ts
+var import_node_process4 = __toESM(require("process"), 1);
+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 && import_node_process4.default.env.HYPHEN_API_KEY) {
+      this.setApiKey(import_node_process4.default.env.HYPHEN_API_KEY);
+    }
+    if (!this._organizationId && import_node_process4.default.env.HYPHEN_ORGANIZATION_ID) {
+      this._organizationId = import_node_process4.default.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;
+    }
+  }
+  /**
+  * 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, code) {
+    if (!organizationId) {
+      throw new Error("Organization ID is required to get the URI.");
+    }
+    let url = this._uris[0].replace("{organizationId}", organizationId);
+    if (code) {
+      url = url.endsWith("/") ? `${url}${code}/` : `${url}/${code}/`;
+    }
+    return url;
+  }
+  async createShortCode(longUrl, domain, options) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to create a short code.");
+    }
+    const url = this.getUri(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}`);
+  }
+  /**
+  * 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}`);
+  }
+  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}`);
+  }
+  /**
+  * 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.");
+    }
+    const url = this.getUri(this._organizationId, 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 import_hookified3.Hookified {
   static {
@@ -668,12 +853,14 @@ var Hyphen = class extends import_hookified3.Hookified {
   }
   _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;
@@ -681,10 +868,12 @@ var Hyphen = class extends import_hookified3.Hookified {
     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));
@@ -694,33 +883,84 @@ var Hyphen = class extends import_hookified3.Hookified {
     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;
+    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;
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.cts

@@ -315,26 +315,219 @@ declare class NetInfo extends BaseService {
     getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
 }
 
+type CreateShortCodeOptions = {
+    /**
+     * The short code used for this link. If not provided, a random code will be generated.
+     * @default undefined
+     */
+    code?: string;
+    /**
+     * The title of the link. This is used for display purposes.
+     * @default undefined
+     */
+    title?: string;
+    /**
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
+     */
+    tags?: string[];
+};
+type CreateShortCodeResponse = {
+    id: string;
+    code: string;
+    long_url: string;
+    domain: string;
+    createdAt: string;
+    title?: string;
+    tags?: string[];
+    organizationId: {
+        id: string;
+        name: string;
+    };
+};
+type GetShortCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: GetShortCodeResponse[];
+};
+type GetShortCodeResponse = CreateShortCodeResponse;
+type LinkOptions = {
+    /**
+     * The URIs to access the link service.
+     * @default ["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]
+     */
+    uris?: string[];
+    /**
+     * The organization ID to use for the link service.
+     * @requires organizationId
+     */
+    organizationId?: string;
+    /**
+     * The API key to use for the link service. This should be provided as the service requires authentication.
+     */
+    apiKey?: string;
+} & BaseServiceOptions;
+declare class Link extends BaseService {
+    private _uris;
+    private _organizationId?;
+    private _apiKey?;
+    constructor(options?: LinkOptions);
+    /**
+     * 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(): string[];
+    /**
+     * 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: string[]);
+    /**
+     * Get the organization ID for the link service. This is required to access the link service.
+     * @returns {string | undefined} The organization ID.
+     */
+    get organizationId(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * Get the API key for the link service. This is required to access the link service.
+     * @returns {string | undefined} The API key.
+     */
+    get apiKey(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * 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: string | undefined): void;
+    /**
+     * 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: string, code?: string): string;
+    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    /**
+     * 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.
+     */
+    getShortCode(code: string): Promise<GetShortCodeResponse>;
+    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
+    /**
+     * 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.
+     */
+    deleteShortCode(code: string): Promise<boolean>;
+}
+
 type HyphenOptions = {
+    /**
+     * The public API key to use for the Hyphen service.
+     * This is used for public endpoints that do not require authentication.
+     */
     publicApiKey?: string;
+    /**
+     * The API key to use for the Hyphen service.
+     * 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;
-    toggle?: Omit<ToggleOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
-    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
+    /**
+     * Options for the Toggle service.
+     * Excludes publicApiKey and throwErrors from ToggleOptions.
+     * @see ToggleOptions
+     * @default {Toggle}
+     */
+    toggle?: Omit<ToggleOptions, 'publicApiKey' | 'throwErrors'>;
+    /**
+     * Options for the NetInfo service.
+     * Excludes apiKey and throwErrors from NetInfoOptions.
+     * @see NetInfoOptions
+     * @default {NetInfo}
+     */
+    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'throwErrors'>;
+    /**
+     * Options for the Link service.
+     * Excludes apiKey and throwErrors from LinkOptions.
+     * @see LinkOptions
+     * @default {Link}
+     */
+    link?: Omit<LinkOptions, 'apiKey' | 'throwErrors'>;
 } & HookifiedOptions;
 declare class Hyphen extends Hookified {
     private readonly _netInfo;
     private readonly _toggle;
+    private readonly _link;
     private _publicApiKey?;
     private _apiKey?;
     constructor(options?: HyphenOptions);
+    /**
+     * Get the NetInfo service instance.
+     * @returns {NetInfo} The NetInfo service instance.
+     */
     get netInfo(): NetInfo;
+    /**
+     * Get the Toggle service instance.
+     * @returns {Toggle} The Toggle service instance.
+     */
     get toggle(): Toggle;
+    /**
+     * Get the Link service instance.
+     * @returns {Link} The Link service instance.
+     */
+    get link(): 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(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * 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(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * 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(): boolean;
+    /**
+     * 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: boolean);
 }
 

package/dist/index.d.ts

@@ -315,26 +315,219 @@ declare class NetInfo extends BaseService {
     getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
 }
 
+type CreateShortCodeOptions = {
+    /**
+     * The short code used for this link. If not provided, a random code will be generated.
+     * @default undefined
+     */
+    code?: string;
+    /**
+     * The title of the link. This is used for display purposes.
+     * @default undefined
+     */
+    title?: string;
+    /**
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
+     */
+    tags?: string[];
+};
+type CreateShortCodeResponse = {
+    id: string;
+    code: string;
+    long_url: string;
+    domain: string;
+    createdAt: string;
+    title?: string;
+    tags?: string[];
+    organizationId: {
+        id: string;
+        name: string;
+    };
+};
+type GetShortCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: GetShortCodeResponse[];
+};
+type GetShortCodeResponse = CreateShortCodeResponse;
+type LinkOptions = {
+    /**
+     * The URIs to access the link service.
+     * @default ["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]
+     */
+    uris?: string[];
+    /**
+     * The organization ID to use for the link service.
+     * @requires organizationId
+     */
+    organizationId?: string;
+    /**
+     * The API key to use for the link service. This should be provided as the service requires authentication.
+     */
+    apiKey?: string;
+} & BaseServiceOptions;
+declare class Link extends BaseService {
+    private _uris;
+    private _organizationId?;
+    private _apiKey?;
+    constructor(options?: LinkOptions);
+    /**
+     * 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(): string[];
+    /**
+     * 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: string[]);
+    /**
+     * Get the organization ID for the link service. This is required to access the link service.
+     * @returns {string | undefined} The organization ID.
+     */
+    get organizationId(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * Get the API key for the link service. This is required to access the link service.
+     * @returns {string | undefined} The API key.
+     */
+    get apiKey(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * 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: string | undefined): void;
+    /**
+     * 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: string, code?: string): string;
+    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    /**
+     * 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.
+     */
+    getShortCode(code: string): Promise<GetShortCodeResponse>;
+    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
+    /**
+     * 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.
+     */
+    deleteShortCode(code: string): Promise<boolean>;
+}
+
 type HyphenOptions = {
+    /**
+     * The public API key to use for the Hyphen service.
+     * This is used for public endpoints that do not require authentication.
+     */
     publicApiKey?: string;
+    /**
+     * The API key to use for the Hyphen service.
+     * 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;
-    toggle?: Omit<ToggleOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
-    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'publicApiKey' | 'throwErrors'>;
+    /**
+     * Options for the Toggle service.
+     * Excludes publicApiKey and throwErrors from ToggleOptions.
+     * @see ToggleOptions
+     * @default {Toggle}
+     */
+    toggle?: Omit<ToggleOptions, 'publicApiKey' | 'throwErrors'>;
+    /**
+     * Options for the NetInfo service.
+     * Excludes apiKey and throwErrors from NetInfoOptions.
+     * @see NetInfoOptions
+     * @default {NetInfo}
+     */
+    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'throwErrors'>;
+    /**
+     * Options for the Link service.
+     * Excludes apiKey and throwErrors from LinkOptions.
+     * @see LinkOptions
+     * @default {Link}
+     */
+    link?: Omit<LinkOptions, 'apiKey' | 'throwErrors'>;
 } & HookifiedOptions;
 declare class Hyphen extends Hookified {
     private readonly _netInfo;
     private readonly _toggle;
+    private readonly _link;
     private _publicApiKey?;
     private _apiKey?;
     constructor(options?: HyphenOptions);
+    /**
+     * Get the NetInfo service instance.
+     * @returns {NetInfo} The NetInfo service instance.
+     */
     get netInfo(): NetInfo;
+    /**
+     * Get the Toggle service instance.
+     * @returns {Toggle} The Toggle service instance.
+     */
     get toggle(): Toggle;
+    /**
+     * Get the Link service instance.
+     * @returns {Link} The Link service instance.
+     */
+    get link(): 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(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * 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(): string | undefined;
+    /**
+     * 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: string | undefined);
+    /**
+     * 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(): boolean;
+    /**
+     * 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: boolean);
 }
 

package/dist/index.js

@@ -624,6 +624,191 @@ var NetInfo = class extends BaseService {
   }
 };
 
+// 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;
+    }
+  }
+  /**
+  * 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, code) {
+    if (!organizationId) {
+      throw new Error("Organization ID is required to get the URI.");
+    }
+    let url = this._uris[0].replace("{organizationId}", organizationId);
+    if (code) {
+      url = url.endsWith("/") ? `${url}${code}/` : `${url}/${code}/`;
+    }
+    return url;
+  }
+  async createShortCode(longUrl, domain, options) {
+    if (!this._organizationId) {
+      throw new Error("Organization ID is required to create a short code.");
+    }
+    const url = this.getUri(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}`);
+  }
+  /**
+  * 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}`);
+  }
+  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}`);
+  }
+  /**
+  * 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.");
+    }
+    const url = this.getUri(this._organizationId, 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 {
@@ -631,12 +816,14 @@ var Hyphen = class extends Hookified3 {
   }
   _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;
@@ -644,10 +831,12 @@ var Hyphen = class extends Hookified3 {
     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));
@@ -657,33 +846,84 @@ var Hyphen = class extends Hookified3 {
     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;
+    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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",
@@ -12,13 +12,6 @@
     }
   },
   "types": "dist/index.d.ts",
-  "scripts": {
-    "test": "xo --fix && vitest run --coverage",
-    "test:ci": "xo && vitest run --coverage",
-    "build": "rimraf ./dist && tsup src/index.ts --format esm,cjs --dts --clean",
-    "clean": "rimraf ./dist pnpm-lock.yaml node_modules coverage",
-    "prepublishOnly": "rimraf ./dist && tsup src/index.ts --format esm,cjs --dts --clean"
-  },
   "keywords": [
     "hyphen",
     "sdk",
@@ -44,6 +37,7 @@
     "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",
@@ -51,5 +45,11 @@
     "dotenv": "^17.0.1",
     "hookified": "^1.10.0",
     "pino": "^9.7.0"
+  },
+  "scripts": {
+    "test": "xo --fix && vitest run --coverage",
+    "test:ci": "xo && vitest run --coverage",
+    "build": "rimraf ./dist && tsup src/index.ts --format esm,cjs --dts --clean",
+    "clean": "rimraf ./dist pnpm-lock.yaml node_modules coverage"
   }
-}
+}