@entergreat/unipile-wrapper 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Niv Kaufman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,143 @@
+# Unipile Wrapper
+
+## Overview 🌐
+A lightweight JavaScript wrapper for Unipile's social network automation platform. This wrapper simplifies the interaction with Unipile's API, currently focusing on LinkedIn automation features. The wrapper provides an easy-to-use interface for common LinkedIn operations while handling the underlying API communication with Unipile.
+
+## Features ✨
+- Simplified interface for Unipile's LinkedIn API
+- Easy account connection using li_at cookies
+- Streamlined search capabilities (URL-based and parameter-based)
+- Built-in pagination support
+- Clean error handling
+- Promise-based async/await interface
+
+## Prerequisites 📋
+- An active Unipile account
+- Unipile API token
+- Access to a Unipile subdomain and port
+
+## Installation 🛠️
+```bash
+npm install @entergreat/unipile-wrapper
+```
+
+## Configuration ⚙️
+Initialize the wrapper with your Unipile credentials:
+
+```javascript
+import { LinkedinService } from 'unipile-linkedin-wrapper';
+
+const linkedinService = new LinkedinService({
+  unipileToken: 'your-unipile-token',
+  subdomain: 'your-subdomain',
+  port: 'port-number'
+});
+```
+
+## Usage 🚀
+
+### Connect LinkedIn Account
+Add a LinkedIn account to Unipile using a li_at cookie:
+
+```javascript
+try {
+  const account = await linkedinService.connect({
+    loginCookie: 'your-li-at-cookie'
+  });
+  console.log('Successfully connected account to Unipile:', account);
+} catch (error) {
+  console.error('Connection failed:', error);
+}
+```
+
+### Search LinkedIn
+#### Using Parameters
+```javascript
+const searchParams = {
+  keywords: 'software engineer',
+  location: 'United States',
+  // Additional LinkedIn search parameters
+};
+
+try {
+  const results = await linkedinService.searchByParams({
+    accountId: 'your-unipile-account-id',
+    params: searchParams,
+    cursor: '', // for pagination
+    limit: 10
+  });
+  console.log('Search results:', results);
+} catch (error) {
+  console.error('Search failed:', error);
+}
+```
+
+#### Using LinkedIn URL
+```javascript
+try {
+  const results = await linkedinService.searchByUrl({
+    accountId: 'your-unipile-account-id',
+    searchUrl: 'linkedin-search-url',
+    cursor: '', // for pagination
+    limit: 10
+  });
+  console.log('Search results:', results);
+} catch (error) {
+  console.error('Search failed:', error);
+}
+```
+
+## API Reference 📚
+
+### LinkedinService
+
+#### Constructor
+```javascript
+new LinkedinService({
+  unipileToken: string, // Your Unipile API token
+  subdomain: string,    // Your Unipile subdomain
+  port: number         // Unipile port number
+})
+```
+
+#### Methods
+
+##### connect({ loginCookie: string })
+Connects a LinkedIn account to Unipile using a li_at cookie.
+- **Parameters:**
+  - `loginCookie`: LinkedIn li_at cookie value
+- **Returns:** Promise with Unipile account connection details
+
+##### searchByParams({ accountId: string, params?: object, cursor?: string, limit?: number })
+Performs a LinkedIn search through Unipile using specified parameters.
+- **Parameters:**
+  - `accountId`: Unipile account ID (required)
+  - `params`: LinkedIn search parameters (optional, default: {})
+  - `cursor`: Pagination cursor (optional, default: "")
+  - `limit`: Results per page (optional, default: 10)
+- **Returns:** Promise with search results
+- **Note:** Automatically sets `api: "classic"` and `category: "people"`
+
+##### searchByUrl({ accountId: string, searchUrl: string, cursor?: string, limit?: number })
+Performs a LinkedIn search through Unipile using a LinkedIn search URL.
+- **Parameters:**
+  - `accountId`: Unipile account ID (required)
+  - `searchUrl`: LinkedIn search URL (required)
+  - `cursor`: Pagination cursor (optional, default: "")
+  - `limit`: Results per page (optional, default: 10)
+- **Returns:** Promise with search results
+
+## Error Handling ⚠️
+The wrapper provides error handling for common Unipile API interactions:
+- Validates required parameters (e.g., accountId)
+- Propagates Unipile API errors with original error messages
+- Wraps API calls in try-catch blocks for easier error handling
+
+## Dependencies 🔧
+- Requires `api.js` utility for HTTP requests to Unipile API
+
+## Contributing 🤝
+Contributions are welcome! Feel free to submit issues and pull requests.
+
+## License 📄
+MIT License - see LICENSE file for details

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@entergreat/unipile-wrapper",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "src/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nivkman/unipile-wrapper.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/nivkman/unipile-wrapper/issues"
+  },
+  "homepage": "https://github.com/nivkman/unipile-wrapper#readme",
+  "dependencies": {
+    "axios": "^1.7.9",
+    "cors": "^2.8.5"
+  }
+}

package/src/index.js

@@ -0,0 +1,3 @@
+import LinkedinService from "./services/linkedinService.js";
+
+export { LinkedinService };

package/src/services/linkedinService.js

@@ -0,0 +1,73 @@
+import { post } from "../utils/api.js";
+
+export default class LinkedinService {
+  constructor({uniphileToken, subdomain, port}) {
+    this.unipileUrl = `https://${subdomain}.unipile.com:${port}/api/v1`;
+    this.headers = {
+      accept: "application/json",
+      "content-type": "application/json",
+      "X-API-KEY": uniphileToken,
+    };
+  }
+
+  // connect to linkedin account via li_at cookie
+  async connect({loginCookie}) {
+    try {
+      const body = {
+        provider: "LINKEDIN",
+        access_token: loginCookie,
+      };
+
+      return await post(`${this.unipileUrl}/accounts`, body, this.headers);
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  // preform a linkedin search by params
+  async searchByParams({accountId, params = {}, cursor = "", limit = 10}) {
+    try {
+      if (!accountId) {
+        throw "account_id must be provided";
+      }
+
+      let url = `${this.unipileUrl}/linkedin/search?account_id=${accountId}&limit=${limit}`;
+
+      params["api"] = "classic";
+      params["category"] = "people";
+
+      if (cursor) {
+        url += `&cursor=${cursor}`;
+      }
+
+      return await post(url, params, this.headers);
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  // preform a linkedin search by url
+  async searchByUrl({accountId, searchUrl, cursor = "", limit = 10}) {
+    try {
+      if (!accountId) {
+        throw "account_id must be provided";
+      }
+
+      const body = {
+        api: "classic",
+        category: "people",
+        url: searchUrl,
+      };
+
+      let url = `${this.unipileUrl}/linkedin/search?account_id=${accountId}&limit=${limit}`;
+
+      if (cursor) {
+        url += `&cursor=${cursor}`;
+      }
+
+      return await post(url, body, this.headers);
+    } catch (error) {
+      throw error;
+    }
+  }
+}

package/src/utils/api.js

@@ -0,0 +1,19 @@
+import axios from "axios";
+
+export const get = async (route, headers = {}) => {
+  try {
+    const response = await axios.get(route, { headers });
+    return response.data;
+  } catch (error) {
+    throw error;
+  }
+};
+
+export const post = async (route, body = {}, headers = {}) => {
+  try {
+    const response = await axios.post(route, body, { headers });
+    return response.data;
+  } catch (error) {
+    throw error;
+  }
+};