@sharpapi/sharpapi-node-job-positions-database 1.0.0

package/README.md

@@ -0,0 +1,212 @@
+![SharpAPI GitHub cover](https://sharpapi.com/sharpapi-github-php-bg.jpg "SharpAPI Node.js Client")
+
+# Job Positions Database API for Node.js
+
+## 💼 Access comprehensive job positions database — powered by SharpAPI.
+
+[![npm version](https://img.shields.io/npm/v/@sharpapi/sharpapi-node-job-positions-database.svg)](https://www.npmjs.com/package/@sharpapi/sharpapi-node-job-positions-database)
+[![License](https://img.shields.io/npm/l/@sharpapi/sharpapi-node-job-positions-database.svg)](https://github.com/sharpapi/sharpapi-node-client/blob/master/LICENSE.md)
+
+**SharpAPI Job Positions Database** provides access to a comprehensive database of professional job positions with categories, industries, levels, and related positions. Perfect for HR applications, job boards, and career platforms.
+
+---
+
+## 📋 Table of Contents
+
+1. [Requirements](#requirements)
+2. [Installation](#installation)
+3. [Usage](#usage)
+4. [API Documentation](#api-documentation)
+5. [Examples](#examples)
+6. [License](#license)
+
+---
+
+## Requirements
+
+- Node.js >= 16.x
+- npm or yarn
+
+---
+
+## Installation
+
+### Step 1. Install the package via npm:
+
+```bash
+npm install @sharpapi/sharpapi-node-job-positions-database
+```
+
+### Step 2. Get your API key
+
+Visit [SharpAPI.com](https://sharpapi.com/) to get your API key.
+
+---
+
+## Usage
+
+```javascript
+const { SharpApiJobPositionsDatabaseService } = require('@sharpapi/sharpapi-node-job-positions-database');
+
+const apiKey = process.env.SHARP_API_KEY;
+const service = new SharpApiJobPositionsDatabaseService(apiKey);
+
+async function browseJobPositions() {
+  try {
+    // Get list of all job positions
+    const positions = await service.getJobPositionsList();
+    console.log(`Found ${positions.length} job positions`);
+
+    // Search for specific positions
+    const results = await service.searchJobPositions('Software Engineer', {
+      limit: 10,
+      level: 'senior'
+    });
+
+    results.forEach(position => {
+      console.log(`${position.title} - ${position.category}`);
+    });
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+browseJobPositions();
+```
+
+---
+
+## API Documentation
+
+### Methods
+
+#### `getJobPositionsList(): Promise<object>`
+Get complete list of all available job positions.
+
+#### `getJobPositionDetails(uuid: string): Promise<object>`
+Get detailed information about a specific job position.
+
+#### `searchJobPositions(query: string, options?:object): Promise<object>`
+Search job positions by title or keyword with filters.
+
+**Options:**
+- `limit` (number): Maximum results
+- `offset` (number): Pagination offset
+- `category` (string): Filter by category
+- `industry` (string): Filter by industry
+- `level` (string): Filter by job level
+
+#### `getJobCategories(): Promise<object>`
+Get all job categories.
+
+#### `getIndustries(): Promise<object>`
+Get all industries.
+
+#### `getJobLevels(): Promise<object>`
+Get all job levels.
+
+#### `getRelatedJobPositions(jobPositionId: string, options?: object): Promise<object>`
+Get related job positions.
+
+#### `validateJobPosition(jobPositionTitle: string): Promise<object>`
+Validate if a job position exists.
+
+#### `getRecommendedSkills(jobPositionId: string, options?: object): Promise<object>`
+Get recommended skills for a job position.
+
+---
+
+## Examples
+
+### Job Board Integration
+
+```javascript
+const service = new SharpApiJobPositionsDatabaseService(process.env.SHARP_API_KEY);
+
+async function buildJobFilters() {
+  const [categories, industries, levels] = await Promise.all([
+    service.getJobCategories(),
+    service.getIndustries(),
+    service.getJobLevels()
+  ]);
+
+  return {
+    categories: categories.map(c => ({ id: c.id, name: c.name })),
+    industries: industries.map(i => ({ id: i.id, name: i.name })),
+    levels: levels.map(l => ({ id: l.id, name: l.name }))
+  };
+}
+
+const filters = await buildJobFilters();
+console.log('Available Filters:', filters);
+```
+
+### Career Path Recommendations
+
+```javascript
+const service = new SharpApiJobPositionsDatabaseService(process.env.SHARP_API_KEY);
+
+async function suggestCareerPath(currentPosition) {
+  const related = await service.getRelatedJobPositions(currentPosition, {
+    limit: 5
+  });
+
+  console.log('Career Path Suggestions:');
+  related.forEach((position, index) => {
+    console.log(`${index + 1}. ${position.title}`);
+    console.log(`   Similarity: ${position.weight}/10`);
+    console.log(`   Category: ${position.category}`);
+  });
+
+  return related;
+}
+
+await suggestCareerPath('software-engineer-id');
+```
+
+---
+
+## Use Cases
+
+- **Job Boards**: Standardized job position listings
+- **ATS Systems**: Job position validation
+- **Career Platforms**: Career path recommendations
+- **HR Applications**: Position database and management
+- **Recruitment Tools**: Position categorization
+- **Skills Mapping**: Position-to-skills relationships
+
+---
+
+## API Endpoint
+
+**GET** `/utilities/job_positions_list`
+
+For detailed API specifications, refer to:
+- [Postman Documentation](https://documenter.getpostman.com/view/31106842/2sBXVeGsW5)
+- [Product Page](https://sharpapi.com/en/catalog/utility/job-positions-api)
+
+---
+
+## Related Packages
+
+- [@sharpapi/sharpapi-node-related-job-positions](https://www.npmjs.com/package/@sharpapi/sharpapi-node-related-job-positions) - AI-powered related positions
+- [@sharpapi/sharpapi-node-skills-database](https://www.npmjs.com/package/@sharpapi/sharpapi-node-skills-database) - Skills database
+- [@sharpapi/sharpapi-node-client](https://www.npmjs.com/package/@sharpapi/sharpapi-node-client) - Full SharpAPI SDK
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.
+
+---
+
+## Support
+
+- **Documentation**: [SharpAPI.com Documentation](https://sharpapi.com/documentation)
+- **Issues**: [GitHub Issues](https://github.com/sharpapi/sharpapi-node-client/issues)
+- **Email**: contact@sharpapi.com
+
+---
+
+**Powered by [SharpAPI](https://sharpapi.com/) - AI-Powered API Workflow Automation**

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@sharpapi/sharpapi-node-job-positions-database",
+  "version": "1.0.0",
+  "description": "SharpAPI.com Node.js SDK for Job Positions Database API",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "keywords": [
+    "sharpapi",
+    "api",
+    "api integration",
+    "restful api",
+    "nodejs",
+    "software development",
+    "job positions",
+    "hr tech",
+    "job titles",
+    "careers"
+  ],
+  "author": "Dawid Makowski <contact@sharpapi.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@sharpapi/sharpapi-node-core": "file:../sharpapi-node-core"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sharpapi/sharpapi-node-job-positions-database.git"
+  }
+}

package/src/SharpApiJobPositionsDatabaseService.js

@@ -0,0 +1,172 @@
+const { SharpApiCoreService } = require('@sharpapi/sharpapi-node-core');
+
+/**
+ * Service for accessing Job Positions Database API using SharpAPI.com
+ */
+class SharpApiJobPositionsDatabaseService extends SharpApiCoreService {
+  /**
+   * Get list of all available job positions
+   *
+   * @returns {Promise<object>} - List of job positions
+   */
+  async getJobPositionsList() {
+    const response = await this.makeRequest('GET', '/utilities/job_positions_list');
+    return response.data;
+  }
+
+  /**
+   * Get detailed information about a specific job position by UUID
+   *
+   * @param {string} uuid - The UUID of the job position
+   * @returns {Promise<object>} - Job position information
+   */
+  async getJobPositionDetails(uuid) {
+    const response = await this.makeRequest('GET', `/utilities/job_positions_details/${uuid}`);
+    return response.data;
+  }
+
+  /**
+   * Get information about a specific job position by ID (alias for getJobPositionDetails)
+   *
+   * @param {string} jobPositionId - The ID of the job position
+   * @returns {Promise<object>} - Job position information
+   */
+  async getJobPositionById(jobPositionId) {
+    return this.getJobPositionDetails(jobPositionId);
+  }
+
+  /**
+   * Search for job positions by title or keyword
+   *
+   * @param {string} query - The search query
+   * @param {object} [options] - Additional options for search
+   * @param {number} [options.limit=20] - Maximum number of results to return
+   * @param {number} [options.offset=0] - Number of results to skip
+   * @param {string} [options.category] - Filter by job category
+   * @param {string} [options.industry] - Filter by industry
+   * @param {string} [options.level] - Filter by job level (entry, mid, senior, etc.)
+   * @returns {Promise<object>} - Search results
+   */
+  async searchJobPositions(query, options = {}) {
+    const data = { query, ...options };
+    const response = await this.makeRequest('GET', '/utility/job-positions/search', data);
+    return response.data;
+  }
+
+  /**
+   * Get all job categories
+   *
+   * @returns {Promise<object>} - List of job categories
+   */
+  async getJobCategories() {
+    const response = await this.makeRequest('GET', '/utility/job-positions/categories');
+    return response.data;
+  }
+
+  /**
+   * Get all industries
+   *
+   * @returns {Promise<object>} - List of industries
+   */
+  async getIndustries() {
+    const response = await this.makeRequest('GET', '/utility/job-positions/industries');
+    return response.data;
+  }
+
+  /**
+   * Get all job levels
+   *
+   * @returns {Promise<object>} - List of job levels
+   */
+  async getJobLevels() {
+    const response = await this.makeRequest('GET', '/utility/job-positions/levels');
+    return response.data;
+  }
+
+  /**
+   * Get related job positions for a specific job position
+   *
+   * @param {string} jobPositionId - The ID of the job position
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=10] - Maximum number of related job positions to return
+   * @returns {Promise<object>} - Related job positions
+   */
+  async getRelatedJobPositions(jobPositionId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/job-positions/${jobPositionId}/related`, data);
+    return response.data;
+  }
+
+  /**
+   * Get job positions by category
+   *
+   * @param {string} categoryId - The ID of the category
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=20] - Maximum number of job positions to return
+   * @param {number} [options.offset=0] - Number of job positions to skip
+   * @returns {Promise<object>} - Job positions in the category
+   */
+  async getJobPositionsByCategory(categoryId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/job-positions/category/${categoryId}`, data);
+    return response.data;
+  }
+
+  /**
+   * Get job positions by industry
+   *
+   * @param {string} industryId - The ID of the industry
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=20] - Maximum number of job positions to return
+   * @param {number} [options.offset=0] - Number of job positions to skip
+   * @returns {Promise<object>} - Job positions in the industry
+   */
+  async getJobPositionsByIndustry(industryId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/job-positions/industry/${industryId}`, data);
+    return response.data;
+  }
+
+  /**
+   * Get job positions by level
+   *
+   * @param {string} levelId - The ID of the level
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=20] - Maximum number of job positions to return
+   * @param {number} [options.offset=0] - Number of job positions to skip
+   * @returns {Promise<object>} - Job positions at the level
+   */
+  async getJobPositionsByLevel(levelId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/job-positions/level/${levelId}`, data);
+    return response.data;
+  }
+
+  /**
+   * Validate if a job position exists in the database
+   *
+   * @param {string} jobPositionTitle - The title of the job position to validate
+   * @returns {Promise<object>} - Validation result
+   */
+  async validateJobPosition(jobPositionTitle) {
+    const data = { job_position: jobPositionTitle };
+    const response = await this.makeRequest('POST', '/utility/job-positions/validate', data);
+    return response.data;
+  }
+
+  /**
+   * Get recommended skills for a job position
+   *
+   * @param {string} jobPositionId - The ID of the job position
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=20] - Maximum number of skills to return
+   * @returns {Promise<object>} - Recommended skills
+   */
+  async getRecommendedSkills(jobPositionId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/job-positions/${jobPositionId}/skills`, data);
+    return response.data;
+  }
+}
+
+module.exports = { SharpApiJobPositionsDatabaseService };

package/src/index.js

@@ -0,0 +1,6 @@
+// sharpapi-node-job-positions-database/src/index.js
+const { SharpApiJobPositionsDatabaseService } = require('./SharpApiJobPositionsDatabaseService');
+
+module.exports = {
+  SharpApiJobPositionsDatabaseService,
+};