freelancer-kit 1.0.1 → 1.0.2

package/README.md

@@ -11,6 +11,7 @@ This repository provides a comprehensive JavaScript toolkit for interacting with
 *   **Token Management:** Easily handle access and refresh tokens for persistent API access.
 *   **Profile Retrieval:** Fetch and manage your Freelancer profile information.
 *   **Project Searching:** Efficiently search for projects based on various criteria.
+*   **Create Bid:** you can create a bid.
 
 ## Installation 📥
 
@@ -33,103 +34,99 @@ npm install
 ### Authentication Example
 
 ```javascript
-const FreelancerAuth = require('freelancer-kit').FreelancerAuth;
-
-const auth = new FreelancerAuth({
-    clientId: 'YOUR_CLIENT_ID',
-    clientSecret: 'YOUR_CLIENT_SECRET',
-    redirectUri: 'YOUR_REDIRECT_URI'
-});
-
-// Get authorization URL
-const authorizationUrl = auth.getAuthorizationUrl(['email', 'profile']);
-console.log('Please visit this URL to authorize:', authorizationUrl);
-
-// After user authorizes, you'll receive a code. Exchange it for tokens.
-// Assuming you have the authorization code:
-async function exchangeCodeForToken(code) {
-    try {
-        const tokens = await auth.exchangeCodeForToken(code);
-        console.log('Access Token:', tokens.access_token);
-        console.log('Refresh Token:', tokens.refresh_token);
-        // Store tokens securely
-    } catch (error) {
-        console.error('Error exchanging code for token:', error);
-    }
-}
-
-// Example of refreshing a token
-async function refreshTokenExample(refreshToken) {
-    try {
-        const newTokens = await auth.refreshToken(refreshToken);
-        console.log('New Access Token:', newTokens.access_token);
-        // Update stored tokens
-    } catch (error) {
-        console.error('Error refreshing token:', error);
-    }
-}
+const { FreelancerAuth } = require("../src/index");
+
+(async () => {
+  const clientId = "app_id";
+  const clientSecret = "client_secret";
+  const redirectUri = "https://example.com/callback";
+  const sandbox = true;
+
+  const flags = {
+    messaging: true,        
+    project_create: true,    
+    project_manage: false,   
+    contest_create: false,   
+    contest_manage: false,   
+    user_information: true,  
+    location_tracking_create: false, 
+    location_tracking_view: false,   
+  };
+
+  const auth = new FreelancerAuth({ clientId, clientSecret, redirectUri, sandbox, flags });
+
+  const authUrl = auth.generateAuthLink();
+  console.log("Open this link in your browser to authorize the app:");
+  console.log(authUrl);
+  const code = await FreelancerAuth.askCode("Enter the code you received: ");
+
+  const tokens = await auth.exchangeCode(code.trim());
+
+  console.log("Access Token:", tokens.access_token);
+  console.log("Refresh Token:", tokens.refresh_token);
+})();
 ```
 
 ### Self Profile Example
 
 ```javascript
-const SelfProfile = require('freelancer-kit').SelfProfile;
-const FreelancerAuth = require('freelancer-kit').FreelancerAuth; // Needed for token management
-
-// Assuming you have obtained and stored your access token
-const accessToken = 'YOUR_STORED_ACCESS_TOKEN';
-
-async function getProfile() {
-    try {
-        const profile = new SelfProfile(accessToken);
-        const userProfile = await profile.getProfile();
-        console.log('User Profile:', userProfile);
-    } catch (error) {
-        console.error('Error fetching profile:', error);
-    }
-}
-
-getProfile();
+const { SelfProfile } = require("../src/index");
+(async () => {
+  try {
+    const profile = new SelfProfile({
+      accessToken: "access_token",
+      sandbox: true
+    });
+
+    const res = await profile.getMyProfile({
+      avatar: true,
+      display_info: true,
+      profile_description: true,
+    });
+
+    console.log(res);
+  } catch (err) {
+    console.error("Error:", err.message);
+  }
+})();
 ```
 
 ### Search Projects Example
 
 ```javascript
-const SearchProjects = require('freelancer-kit').SearchProjects;
-const FreelancerAuth = require('freelancer-kit').FreelancerAuth; // Needed for token management
-
-// Assuming you have obtained and stored your access token
-const accessToken = 'YOUR_STORED_ACCESS_TOKEN';
-
-async function searchProjects() {
-    try {
-        const searcher = new SearchProjects(accessToken);
-        const projects = await searcher.search({
-            limit: 10,
-            full_description: 1,
-            query: 'web development'
-        });
-        console.log('Found Projects:', projects);
-    } catch (error) {
-        console.error('Error searching projects:', error);
-    }
-}
-
-searchProjects();
-```
-
-## Contributing 🤝
+const { SearchProjects } = require("../src/index");
 
-We welcome contributions to `freelancer-kit`! Please follow these guidelines:
+const projects = new SearchProjects({
+  accessToken: "access_token",
+  sandbox: true,
+});
 
-1.  **Fork the repository.**
-2.  **Create a new branch** for your feature or bug fix.
-3.  **Make your changes** and ensure they are well-documented.
-4.  **Add tests** for your new functionality.
-5.  **Submit a Pull Request** with a clear description of your changes.
+(async () => {
+  try {
+    const result = await projects.search({
+      query: "software",
+      project_types: ["fixed"],
+      min_price: 50,
+      max_price: 1000,
+      jobs: [1, 2, 3], // job id
+      languages: ["en"],
+      project_statuses: ["active"],
+      sort_field: "time_updated",
+      limit: 10,
+      full_description: true,
+      user_details: true,
+    });
+
+    console.log(result.result.projects);
+  } catch (err) {
+    console.error("Error:", err.details || err.message);
+  }
+})();
+```
 
-Please ensure your code adheres to the existing style and formatting.
+## Contributing 🤝
 
+We welcome contributions to `freelancer-kit`
 ## License 📜
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -142,78 +139,4 @@ The `freelancer-kit` library exposes several classes to interact with the Freela
 
 Handles authentication and token management.
 
-**Constructor:**
-
-```javascript
-new FreelancerAuth(options: {
-    clientId: string;
-    clientSecret: string;
-    redirectUri: string;
-})
-```
-
-**Methods:**
-
-*   `getAuthorizationUrl(scopes: string[]): string`
-    *   Generates the OAuth 2.0 authorization URL.
-*   `exchangeCodeForToken(code: string): Promise<TokenResponse>`
-    *   Exchanges an authorization code for an access token and refresh token.
-*   `refreshToken(refreshToken: string): Promise<TokenResponse>`
-    *   Refreshes an expired access token using a refresh token.
-
-### `SearchProjects` 🔍
-
-Facilitates searching for projects.
-
-**Constructor:**
-
-```javascript
-new SearchProjects(accessToken: string)
-```
-
-**Methods:**
-
-*   `search(params: SearchParams): Promise<Project[]>`
-    *   Searches for projects.
-    *   `SearchParams` can include:
-        *   `limit`: Maximum number of results.
-        *   `full_description`: Whether to include full project descriptions (1 for yes, 0 for no).
-        *   `query`: Search term.
-        *   `page`: Page number for results.
-        *   `sort_field`: Field to sort by (e.g., 'time_left', 'budget').
-        *   `sort_order`: Sort order ('asc' or 'desc').
-        *   `min_budget`: Minimum budget for projects.
-        *   `max_budget`: Maximum budget for projects.
-        *   `category_id`: Filter by category ID.
-
-### `SelfProfile` 👤
-
-Provides access to the authenticated user's profile.
-
-**Constructor:**
-
-```javascript
-new SelfProfile(accessToken: string)
-```
-
-**Methods:**
-
-*   `getProfile(): Promise<UserProfile>`
-    *   Fetches the authenticated user's profile information.
-
-## Configuration Options & Environment Variables ⚙️
-
-While the library can be configured directly via constructor options, it's recommended to use environment variables for sensitive information like API keys and secrets.
-
-*   `FREELANCER_CLIENT_ID`: Your Freelancer API Client ID.
-*   `FREELANCER_CLIENT_SECRET`: Your Freelancer API Client Secret.
-*   `FREELANCER_REDIRECT_URI`: Your registered Redirect URI.
-
-When using these environment variables, you can instantiate classes without passing explicit options:
-
-```javascript
-// Example using environment variables for FreelancerAuth
-const auth = new FreelancerAuth(); // Reads from process.env.FREELANCER_CLIENT_ID, etc.
-```
-
 ---

package/examples/post_bid.js

@@ -0,0 +1,21 @@
+const { Bid } = require("../src/index");
+
+(async () => {
+  try {
+    const bid = new Bid({
+      accessToken: "access_token",
+      sandbox: true,
+    });
+                                
+    const res = await bid.placeBid("project_id", {
+      amount: "how much money",
+      period: "how many days",
+      description: "description",
+      milestone_percentage: "milestone percentage",
+    });
+
+    console.log(`SUCCESS: Bid placed successfully (ID: ${res.result.id})`);
+  } catch (err) {
+    console.error(`FAILED: ${err.message}`);
+  }
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freelancer-kit",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Unofficial Node.js toolkit for integrating with the Freelancer.com API",
   "author": "MURTESA",
   "license": "MIT",
@@ -9,6 +9,8 @@
     "freelancer",
     "freelancer-kit",
     "freelancer-api",
+    "freelancer-client",
+    "freelance",
     "nodejs",
     "sdk",
     "client",
@@ -18,7 +20,6 @@
     "node": ">=14"
   },
   "dependencies": {
-    "freelancer-kit": "^1.0.0",
     "node-fetch": "^2.7.0"
   }
 }

package/src/classes/Bid.js

@@ -0,0 +1,82 @@
+const fetch = require("node-fetch");
+
+class Bid {
+  constructor({ accessToken, sandbox = false }) {
+    if (!accessToken) {
+      throw new Error("accessToken is required");
+    }
+
+    this.accessToken = accessToken;
+    this.sandbox = sandbox;
+
+    this.projectBaseUrl = sandbox
+      ? "https://www.freelancer-sandbox.com/api/projects/0.1"
+      : "https://www.freelancer.com/api/projects/0.1";
+
+    this.userBaseUrl = sandbox
+      ? "https://www.freelancer-sandbox.com/api/users/0.1"
+      : "https://www.freelancer.com/api/users/0.1";
+  }
+
+  async request(method, url, body = null) {
+    const options = {
+      method,
+      headers: {
+        "Content-Type": "application/json",
+        "freelancer-oauth-v1": this.accessToken,
+      },
+    };
+
+    if (body) {
+      options.body = JSON.stringify(body);
+    }
+
+    const res = await fetch(url, options);
+    const data = await res.json();
+
+    if (!res.ok) {
+      const error = new Error(data?.message || "Freelancer API Error");
+      error.status = res.status;
+      error.details = data;
+      throw error;
+    }
+
+    return data;
+  }
+
+  async getMyUserId() {
+    const data = await this.request(
+      "GET",
+      `${this.userBaseUrl}/self/`
+    );
+
+    if (!data?.result?.id) {
+      throw new Error("Failed to retrieve self user ID");
+    }
+
+    return Number(data.result.id);
+  }
+
+  async placeBid(projectId, bidData = {}) {
+    const bidderId = await this.getMyUserId();
+
+    const payload = {
+      project_id: Number(projectId),
+      bidder_id: bidderId,
+      amount: Number(bidData.amount),
+      period: Number(bidData.period),
+      description: String(bidData.description || ""),
+      milestone_percentage: bidData.milestone_percentage ?? 0,
+      sponsored: Boolean(bidData.sponsored),
+      highlighted: Boolean(bidData.highlighted),
+    };
+
+    return this.request(
+      "POST",
+      `${this.projectBaseUrl}/bids/`,
+      payload
+    );
+  }
+}
+
+module.exports = Bid;

package/src/index.js

@@ -2,11 +2,12 @@ const SelfProfile = require("./classes/SelfProfile");
 const Token = require("./classes/Token");
 const SearchProjects = require("./classes/SearchProjects");
 const FreelancerAuth = require("./classes/FreelancerAuth");
-
+const Bid = require("./classes/Bid")
 
 module.exports = {
   SelfProfile,
   Token,
   SearchProjects,
   FreelancerAuth,
+  Bid,
 };