@sharpapi/sharpapi-node-skills-database 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 1.0.0 - 2024-10-06
+
+- Initial release of the SharpAPI Node.js Skills Database SDK.
+- Included comprehensive documentation and examples.

package/CONTRIBUTION.md

@@ -0,0 +1,53 @@
+## Contributing
+
+We welcome contributions to the SharpAPI Node.js Skills Database SDK! If you'd like to contribute, please follow these steps:
+
+1. **Fork the Repository**
+
+   Click the "Fork" button at the top-right corner of the repository page to create your own fork.
+
+2. **Clone the Forked Repository**
+
+   ```bash
+   git clone https://github.com/yourusername/sharpapi-node-client.git
+   ```
+
+3. **Navigate to the Project Directory**
+
+   ```bash
+   cd sharpapi-node-client
+   ```
+
+4. **Create a New Branch**
+
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+5. **Make Your Changes**
+
+   Implement your feature or bug fix.
+
+6. **Commit Your Changes**
+
+   ```bash
+   git add .
+   git commit -m "Add feature: Your Feature Name"
+   ```
+
+7. **Push to Your Fork**
+
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+8. **Create a Pull Request**
+
+   Go to the original repository on GitHub and create a pull request from your forked repository.
+
+### Guidelines
+
+- **Follow Coding Standards:** Ensure your code adheres to the existing coding style.
+- **Write Tests:** Add tests for your new features or bug fixes.
+- **Update Documentation:** If your changes affect the usage, update the documentation accordingly.
+- **Provide Clear Descriptions:** Make sure your commit messages and pull request descriptions are clear and concise.

package/LICENSE.md

@@ -0,0 +1,7 @@
+MIT License
+
+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,351 @@
+![SharpAPI GitHub cover](https://sharpapi.com/sharpapi-github-php-bg.jpg "SharpAPI Node.js Skills Database")
+
+# SharpAPI NodeJS Skills Database SDK
+
+## 🚀 Access a comprehensive database of professional skills with AI-powered API
+
+### Leverage AI API to search, validate, and categorize professional skills for HR Tech, job platforms, and more.
+
+**SharpAPI.com Node.js Skills Database SDK** enables developers to integrate access to a comprehensive database of professional skills into their Node.js applications. This SDK simplifies interaction with the SharpAPI Skills Database service, providing a seamless way to search, validate, and categorize professional skills.
+
+See more at [SharpAPI.com Website »](https://sharpapi.com/)
+
+[![Version](https://img.shields.io/npm/v/@sharpapi/sharpapi-node-skills-database.svg)](https://www.npmjs.com/package/@sharpapi/sharpapi-node-skills-database)
+[![License](https://img.shields.io/npm/l/@sharpapi/sharpapi-node-skills-database.svg)](https://github.com/sharpapi/sharpapi-node-client/blob/master/LICENSE.md)
+
+## Requirements
+
+- Node.js >= 16.x
+
+## Installation
+
+```bash
+npm i @sharpapi/sharpapi-node-skills-database
+```
+
+---
+
+## Table of Contents
+
+1. [Installation](#installation)
+2. [Configuration](#configuration)
+3. [Usage](#usage)
+   - [Initialization](#initialization)
+   - [Available Methods](#available-methods)
+4. [Examples](#examples)
+5. [Contributing](#contributing)
+6. [License](#license)
+
+---
+
+## Installation
+
+### Prerequisites
+
+- **Node.js** v16 or higher
+- **npm** (Node Package Manager)
+
+### Install via npm
+
+You can install the SharpAPI Node.js Skills Database SDK using npm:
+
+```bash
+npm install @sharpapi/sharpapi-node-skills-database
+```
+
+### Install via Yarn
+
+Alternatively, if you prefer using Yarn:
+
+```bash
+yarn add @sharpapi/sharpapi-node-skills-database
+```
+
+---
+
+## Configuration
+
+### Setting Up Environment Variables
+
+To protect your credentials, it's recommended to use a `.env` file to store your SharpAPI API key. Follow these steps:
+
+1. **Create a `.env` File**
+
+   In the root directory of your project, create a file named `.env`:
+
+   ```plaintext
+   SHARP_API_KEY=your_actual_api_key_here
+   ```
+
+2. **Install `dotenv` Package**
+
+   To load environment variables from the `.env` file, install the `dotenv` package:
+
+   ```bash
+   npm install dotenv
+   ```
+
+3. **Load Environment Variables**
+
+   At the beginning of your application (e.g., in `app.js` or `index.js`), add the following line to load the environment variables:
+
+   ```javascript
+   require('dotenv').config();
+   ```
+
+4. **Ensure `.env` is Ignored**
+
+   Add `.env` to your `.gitignore` file to prevent sensitive information from being committed to version control:
+
+   ```plaintext
+   # .gitignore
+   .env
+   ```
+
+---
+
+## Usage
+
+### Initialization
+
+First, import and initialize the `SharpApiSkillsDatabaseService` with your API key:
+
+```javascript
+// Load environment variables
+require('dotenv').config();
+
+// Import the SharpApiSkillsDatabaseService
+const { SharpApiSkillsDatabaseService } = require('@sharpapi/sharpapi-node-skills-database');
+
+// Initialize the SharpApiSkillsDatabaseService
+const apiKey = process.env.SHARP_API_KEY;
+const skillsService = new SharpApiSkillsDatabaseService(apiKey);
+```
+
+### Available Methods
+
+The `SharpApiSkillsDatabaseService` class provides various methods to interact with the Skills Database API:
+
+#### getSkillById(skillId)
+
+- **Description:** Get information about a specific skill by ID.
+- **Parameters:**
+  - `skillId` (string): The ID of the skill.
+- **Returns:** A Promise that resolves to the skill information.
+- **Usage:**
+  ```javascript
+  const skillInfo = await skillsService.getSkillById('skill123');
+  console.log(skillInfo);
+  ```
+
+#### searchSkills(query, options)
+
+- **Description:** Search for skills by name or keyword.
+- **Parameters:**
+  - `query` (string): The search query.
+  - `options` (object, optional): Additional options for search.
+    - `limit` (number, optional): Maximum number of results to return (default: 20).
+    - `offset` (number, optional): Number of results to skip (default: 0).
+    - `category` (string, optional): Filter by skill category.
+    - `type` (string, optional): Filter by skill type.
+- **Returns:** A Promise that resolves to the search results.
+- **Usage:**
+  ```javascript
+  const searchResults = await skillsService.searchSkills('javascript', {
+    limit: 10,
+    category: 'programming'
+  });
+  console.log(searchResults);
+  ```
+
+#### getSkillCategories()
+
+- **Description:** Get all skill categories.
+- **Returns:** A Promise that resolves to a list of skill categories.
+- **Usage:**
+  ```javascript
+  const categories = await skillsService.getSkillCategories();
+  console.log(categories);
+  ```
+
+#### getSkillTypes()
+
+- **Description:** Get all skill types.
+- **Returns:** A Promise that resolves to a list of skill types.
+- **Usage:**
+  ```javascript
+  const types = await skillsService.getSkillTypes();
+  console.log(types);
+  ```
+
+#### getRelatedSkills(skillId, options)
+
+- **Description:** Get related skills for a specific skill.
+- **Parameters:**
+  - `skillId` (string): The ID of the skill.
+  - `options` (object, optional): Additional options.
+    - `limit` (number, optional): Maximum number of related skills to return (default: 10).
+- **Returns:** A Promise that resolves to related skills.
+- **Usage:**
+  ```javascript
+  const relatedSkills = await skillsService.getRelatedSkills('skill123', {
+    limit: 5
+  });
+  console.log(relatedSkills);
+  ```
+
+#### getSkillsByCategory(categoryId, options)
+
+- **Description:** Get skills by category.
+- **Parameters:**
+  - `categoryId` (string): The ID of the category.
+  - `options` (object, optional): Additional options.
+    - `limit` (number, optional): Maximum number of skills to return (default: 20).
+    - `offset` (number, optional): Number of skills to skip (default: 0).
+- **Returns:** A Promise that resolves to skills in the category.
+- **Usage:**
+  ```javascript
+  const skillsInCategory = await skillsService.getSkillsByCategory('category123', {
+    limit: 15,
+    offset: 10
+  });
+  console.log(skillsInCategory);
+  ```
+
+#### getSkillsByType(typeId, options)
+
+- **Description:** Get skills by type.
+- **Parameters:**
+  - `typeId` (string): The ID of the type.
+  - `options` (object, optional): Additional options.
+    - `limit` (number, optional): Maximum number of skills to return (default: 20).
+    - `offset` (number, optional): Number of skills to skip (default: 0).
+- **Returns:** A Promise that resolves to skills of the type.
+- **Usage:**
+  ```javascript
+  const skillsOfType = await skillsService.getSkillsByType('type123', {
+    limit: 15,
+    offset: 10
+  });
+  console.log(skillsOfType);
+  ```
+
+#### validateSkill(skillName)
+
+- **Description:** Validate if a skill exists in the database.
+- **Parameters:**
+  - `skillName` (string): The name of the skill to validate.
+- **Returns:** A Promise that resolves to the validation result.
+- **Usage:**
+  ```javascript
+  const validationResult = await skillsService.validateSkill('JavaScript');
+  console.log(validationResult);
+  ```
+
+## Examples
+
+### Search for Skills
+
+```javascript
+require('dotenv').config();
+const { SharpApiSkillsDatabaseService } = require('@sharpapi/sharpapi-node-skills-database');
+
+async function searchSkillsExample() {
+  const apiKey = process.env.SHARP_API_KEY;
+  const skillsService = new SharpApiSkillsDatabaseService(apiKey);
+
+  try {
+    // Search for programming skills
+    const searchResults = await skillsService.searchSkills('programming', {
+      limit: 10,
+      category: 'technical'
+    });
+    
+    console.log('Search Results:', searchResults);
+    
+    // Get skill categories
+    const categories = await skillsService.getSkillCategories();
+    console.log('Skill Categories:', categories);
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+searchSkillsExample();
+```
+
+### Validate and Get Related Skills
+
+```javascript
+require('dotenv').config();
+const { SharpApiSkillsDatabaseService } = require('@sharpapi/sharpapi-node-skills-database');
+
+async function validateAndRelatedSkillsExample() {
+  const apiKey = process.env.SHARP_API_KEY;
+  const skillsService = new SharpApiSkillsDatabaseService(apiKey);
+
+  try {
+    // Validate a skill
+    const skillName = 'JavaScript';
+    const validationResult = await skillsService.validateSkill(skillName);
+    console.log(`Validation Result for ${skillName}:`, validationResult);
+    
+    if (validationResult.valid && validationResult.skill_id) {
+      // Get related skills
+      const relatedSkills = await skillsService.getRelatedSkills(validationResult.skill_id, {
+        limit: 5
+      });
+      console.log(`Related Skills for ${skillName}:`, relatedSkills);
+    }
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
+}
+
+validateAndRelatedSkillsExample();
+```
+
+---
+
+## API Documentation
+
+For detailed usage and API methods, please refer to the [SharpAPI.com Documentation](https://sharpapi.com/documentation).
+
+---
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+---
+
+## Contributing
+
+Check [CONTRIBUTION.md](CONTRIBUTION.md) file for details.
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).
+
+---
+
+## Support
+
+If you encounter any issues or have questions, feel free to open an issue on the [GitHub repository](https://github.com/sharpapi/sharpapi-node-client/issues) or contact support at [contact@sharpapi.com](mailto:contact@sharpapi.com).
+
+---
+
+## Social Media
+
+🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:
+- [SharpAPI X (formerly Twitter)](https://x.com/SharpAPI)
+- [SharpAPI YouTube](https://www.youtube.com/@SharpAPI)
+- [SharpAPI Vimeo](https://vimeo.com/SharpAPI)
+- [SharpAPI LinkedIn](https://www.linkedin.com/products/a2z-web-ltd-sharpapicom-automate-with-aipowered-api/)
+- [SharpAPI Facebook](https://www.facebook.com/profile.php?id=61554115896974)
+
+---
+
+**Happy Coding with SharpAPI Node.js Skills Database SDK!**

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@sharpapi/sharpapi-node-skills-database",
+  "version": "1.0.0",
+  "description": "SharpAPI.com Node.js SDK for Skills Database API",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "keywords": [
+    "sharpapi",
+    "api",
+    "api integration",
+    "restful api",
+    "nodejs",
+    "software development",
+    "skills",
+    "hr tech",
+    "job skills",
+    "skills database"
+  ],
+  "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-skills-database.git"
+  }
+}

package/src/SharpApiSkillsDatabaseService.js

@@ -0,0 +1,132 @@
+const { SharpApiCoreService } = require('@sharpapi/sharpapi-node-core');
+
+/**
+ * Service for accessing Skills Database API using SharpAPI.com
+ */
+class SharpApiSkillsDatabaseService extends SharpApiCoreService {
+  /**
+   * Get list of all available skills
+   *
+   * @returns {Promise<object>} - List of skills
+   */
+  async getSkillsList() {
+    const response = await this.makeRequest('GET', '/utilities/skills_list');
+    return response.data;
+  }
+
+  /**
+   * Get detailed information about a specific skill by UUID
+   *
+   * @param {string} uuid - The UUID of the skill
+   * @returns {Promise<object>} - Skill information
+   */
+  async getSkillDetails(uuid) {
+    const response = await this.makeRequest('GET', `/utilities/skills_details/${uuid}`);
+    return response.data;
+  }
+
+  /**
+   * Get information about a specific skill by ID (alias for getSkillDetails)
+   *
+   * @param {string} skillId - The ID of the skill
+   * @returns {Promise<object>} - Skill information
+   */
+  async getSkillById(skillId) {
+    return this.getSkillDetails(skillId);
+  }
+
+  /**
+   * Search for skills by name 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 skill category
+   * @param {string} [options.type] - Filter by skill type
+   * @returns {Promise<object>} - Search results
+   */
+  async searchSkills(query, options = {}) {
+    const data = { query, ...options };
+    const response = await this.makeRequest('GET', '/utility/skills/search', data);
+    return response.data;
+  }
+
+  /**
+   * Get all skill categories
+   *
+   * @returns {Promise<object>} - List of skill categories
+   */
+  async getSkillCategories() {
+    const response = await this.makeRequest('GET', '/utility/skills/categories');
+    return response.data;
+  }
+
+  /**
+   * Get all skill types
+   *
+   * @returns {Promise<object>} - List of skill types
+   */
+  async getSkillTypes() {
+    const response = await this.makeRequest('GET', '/utility/skills/types');
+    return response.data;
+  }
+
+  /**
+   * Get related skills for a specific skill
+   *
+   * @param {string} skillId - The ID of the skill
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=10] - Maximum number of related skills to return
+   * @returns {Promise<object>} - Related skills
+   */
+  async getRelatedSkills(skillId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/skills/${skillId}/related`, data);
+    return response.data;
+  }
+
+  /**
+   * Get skills by category
+   *
+   * @param {string} categoryId - The ID of the category
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=20] - Maximum number of skills to return
+   * @param {number} [options.offset=0] - Number of skills to skip
+   * @returns {Promise<object>} - Skills in the category
+   */
+  async getSkillsByCategory(categoryId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/skills/category/${categoryId}`, data);
+    return response.data;
+  }
+
+  /**
+   * Get skills by type
+   *
+   * @param {string} typeId - The ID of the type
+   * @param {object} [options] - Additional options
+   * @param {number} [options.limit=20] - Maximum number of skills to return
+   * @param {number} [options.offset=0] - Number of skills to skip
+   * @returns {Promise<object>} - Skills of the type
+   */
+  async getSkillsByType(typeId, options = {}) {
+    const data = { ...options };
+    const response = await this.makeRequest('GET', `/utility/skills/type/${typeId}`, data);
+    return response.data;
+  }
+
+  /**
+   * Validate if a skill exists in the database
+   *
+   * @param {string} skillName - The name of the skill to validate
+   * @returns {Promise<object>} - Validation result
+   */
+  async validateSkill(skillName) {
+    const data = { skill: skillName };
+    const response = await this.makeRequest('POST', '/utility/skills/validate', data);
+    return response.data;
+  }
+}
+
+module.exports = { SharpApiSkillsDatabaseService };

package/src/index.js

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