@hyphen/sdk 1.10.0 → 1.11.0

package/README.md

@@ -24,6 +24,10 @@ 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)
+	- [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)
@@ -653,7 +657,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 +681,36 @@ 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

package/dist/index.cjs

@@ -743,11 +743,27 @@ 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, 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._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 +782,49 @@ 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}`);
+  }
+  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.
@@ -774,8 +833,7 @@ 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, {

package/dist/index.d.cts

@@ -345,6 +345,13 @@ type CreateShortCodeResponse = {
         name: string;
     };
 };
+type GetShortCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: GetShortCodeResponse[];
+};
+type GetShortCodeResponse = CreateShortCodeResponse;
 type LinkOptions = {
     /**
      * The URIs to access the link service.
@@ -402,7 +409,21 @@ declare class Link extends BaseService {
      * @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'

package/dist/index.d.ts

@@ -345,6 +345,13 @@ type CreateShortCodeResponse = {
         name: string;
     };
 };
+type GetShortCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: GetShortCodeResponse[];
+};
+type GetShortCodeResponse = CreateShortCodeResponse;
 type LinkOptions = {
     /**
      * The URIs to access the link service.
@@ -402,7 +409,21 @@ declare class Link extends BaseService {
      * @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'

package/dist/index.js

@@ -706,11 +706,27 @@ 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, 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._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 +745,49 @@ 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}`);
+  }
+  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.
@@ -737,8 +796,7 @@ 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, {

package/package.json

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