@sargonpiraev/hh-api-client 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sargon Piraev
+
+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

@@ -1,5 +1,11 @@
 # HeadHunter API Client
 
+![npm version](https://img.shields.io/npm/v/@sargonpiraev/hh-api-client)
+![npm downloads](https://img.shields.io/npm/dw/@sargonpiraev/hh-api-client)
+![license](https://img.shields.io/github/license/sargonpiraev/hh-api-client)
+![pipeline status](https://gitlab.com/sargonpiraev/hh-api-client/badges/main/pipeline.svg)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)
+
 A TypeScript client for the HeadHunter API, generated from the official OpenAPI specification.
 
 ## Features
@@ -14,13 +20,28 @@ A TypeScript client for the HeadHunter API, generated from the official OpenAPI
 ## Installation
 
 ```bash
-npm install hh-api-client
+npm install @sargonpiraev/hh-api-client
 ```
 
+## Get Your Credentials
+
+Before installation, you'll need HeadHunter API credentials:
+
+1. Visit [HeadHunter Developer Portal](https://dev.hh.ru/)
+2. Create an application to get client credentials
+3. For authenticated requests, implement OAuth flow to get access token
+4. Set up proper User-Agent format: `"AppName/Version (contact@example.com)"`
+
+## Requirements
+
+- Node.js >= v18.0.0
+- HeadHunter API credentials (User-Agent required, access token optional)
+- npm >= 8.0.0
+
 ## Quick Start
 
 ```typescript
-import { createHeadHunterClient, getVacancies, getAreas, type GetVacanciesData } from 'hh-api-client'
+import { createHeadHunterClient, getVacancies, getAreas, type GetVacanciesData } from '@sargonpiraev/hh-api-client'
 
 // Create a configured client
 const client = createHeadHunterClient({
@@ -54,7 +75,7 @@ console.log('Available areas:', areas.data)
 ### Search Vacancies
 
 ```typescript
-import { getVacancies, type GetVacanciesData } from 'hh-api-client'
+import { getVacancies, type GetVacanciesData } from '@sargonpiraev/hh-api-client'
 
 const searchParams: GetVacanciesData = {
   query: {
@@ -76,7 +97,7 @@ const result = await getVacancies({ client, ...searchParams })
 ### Get Vacancy Details
 
 ```typescript
-import { getVacancy } from 'hh-api-client'
+import { getVacancy } from '@sargonpiraev/hh-api-client'
 
 const vacancy = await getVacancy({
   client,
@@ -90,7 +111,7 @@ console.log(vacancy.data.description)
 ### Apply to Vacancy
 
 ```typescript
-import { applyToVacancy } from 'hh-api-client'
+import { applyToVacancy } from '@sargonpiraev/hh-api-client'
 
 await applyToVacancy({
   client,
@@ -105,7 +126,7 @@ await applyToVacancy({
 ### Work with Dictionaries
 
 ```typescript
-import { getAreas, getIndustries, getSkills, getProfessionalRolesDictionary } from 'hh-api-client'
+import { getAreas, getIndustries, getSkills, getProfessionalRolesDictionary } from '@sargonpiraev/hh-api-client'
 
 // Get all areas (cities/regions)
 const areas = await getAreas({ client })
@@ -123,7 +144,7 @@ const roles = await getProfessionalRolesDictionary({ client })
 ### User Information
 
 ```typescript
-import { getCurrentUserInfo, editCurrentUserInfo } from 'hh-api-client'
+import { getCurrentUserInfo, editCurrentUserInfo } from '@sargonpiraev/hh-api-client'
 
 // Get current user info
 const user = await getCurrentUserInfo({ client })
@@ -196,7 +217,7 @@ The client exports all generated SDK functions. See the [HeadHunter API document
 
 ```typescript
 // Import everything
-import * as HHApi from 'hh-api-client'
+import * as HHApi from '@sargonpiraev/hh-api-client'
 
 // Or import specific functions
 import {
@@ -204,7 +225,7 @@ import {
   getNegotiations,
   createResume,
   // ... etc
-} from 'hh-api-client'
+} from '@sargonpiraev/hh-api-client'
 ```
 
 ## TypeScript Support
@@ -212,7 +233,7 @@ import {
 Full TypeScript support with generated types:
 
 ```typescript
-import type { GetVacanciesData, GetVacanciesResponses, Vacancy, Area, Industry } from 'hh-api-client'
+import type { GetVacanciesData, GetVacanciesResponses, Vacancy, Area, Industry } from '@sargonpiraev/hh-api-client'
 
 const handleVacancy = (vacancy: Vacancy) => {
   console.log(vacancy.name)
@@ -237,25 +258,38 @@ try {
 }
 ```
 
-## Development
+## Roadmap
 
-```bash
-# Install dependencies
-npm install
+**Coming Soon** 🚀
 
-# Generate types from OpenAPI spec
-npm run openapi-ts
+- [ ] **Enhanced Type Safety**: Additional validation and type guards
+- [ ] **Response Caching**: Intelligent caching for frequently accessed data
+- [ ] **Batch Operations**: Support for bulk API operations
+- [ ] **Rate Limiting**: Built-in rate limiting and retry logic
+- [ ] **Offline Support**: Offline-first capabilities with sync
+- [ ] **React Hooks**: React hooks package for easier integration
 
-# Build
-npm run build
+**Completed** ✅
 
-# Test
-npm run test
+- [x] **Full API Coverage**: Complete HeadHunter API integration
+- [x] **Type Generation**: Automated TypeScript types from OpenAPI
+- [x] **Error Handling**: Comprehensive error management
+- [x] **Tree Shaking**: Optimized bundle size with selective imports
 
-# Lint
-npm run lint
-```
+**Community Requests** 💭
+
+Have an idea for HeadHunter API Client? [Open an issue](https://github.com/sargonpiraev/hh-api-client/issues) or contribute to our roadmap!
+
+## Support This Project
+
+Hi! I'm Sargon Piraev, a software engineer passionate about API integrations and developer tools. I create open-source API clients to help developers integrate with their favorite services more easily.
+
+Your support helps me continue developing and maintaining these tools, and motivates me to create new integrations that make developer workflows even more efficient! 🚀
+
+[![Support on Boosty](https://img.shields.io/badge/Support-Boosty-orange?logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTEyIDJMMTMuMDkgOC4yNkwyMCA5TDEzLjA5IDE1Ljc0TDEyIDIyTDEwLjkxIDE1Ljc0TDQgOUwxMC45MSA4LjI2TDEyIDJaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4K)](https://boosty.to/sargonpiraev)
 
-## License
+## Connect with Author
 
-MIT
+- 🌐 Visit [sargonpiraev.com](https://sargonpiraev.com)
+- 📧 Email: [sargonpiraev@gmail.com](mailto:sargonpiraev@gmail.com)
+- 💼 LinkedIn: [linkedin.com/in/sargonpiraev](https://linkedin.com/in/sargonpiraev)

package/build/src/HhApiClient.d.ts

@@ -0,0 +1,9 @@
+import * as sdk from './generated/sdk.gen.js';
+export interface Config {
+    userAgent: string;
+}
+export declare class HhApiClient {
+    private client;
+    constructor(config: Config);
+    sdk: typeof sdk;
+}

package/build/src/HhApiClient.js

@@ -0,0 +1,12 @@
+import { client } from './generated/client.gen.js';
+import * as sdk from './generated/sdk.gen.js';
+export class HhApiClient {
+    client;
+    constructor(config) {
+        this.client = client;
+        this.client.setConfig({
+            headers: { 'User-Agent': config.userAgent },
+        });
+    }
+    sdk = sdk;
+}

package/build/src/index.d.ts

@@ -1,22 +1,3 @@
-export { client } from './generated/client.gen.js';
-export { createClient } from './generated/client/index.js';
-export type { Client, Options } from './generated/client/index.js';
-export { getVacancies, getVacancy, getFavoriteVacancies, addVacancyToFavorite, deleteVacancyFromFavorite, getVacanciesSimilarToResume, applyToVacancy, } from './generated/index.js';
-export { getDictionaries, getAreas, getIndustries, getLanguages, getSkills, getProfessionalRolesDictionary, getMetroStations, getMetroStationsInCity, } from './generated/index.js';
-export { getCurrentUserInfo, editCurrentUserInfo, authorize, invalidateToken } from './generated/index.js';
-export { getMineResumes, getResume, createResume, editResume, deleteResume, publishResume, searchForResumes, getResumeConditions, } from './generated/index.js';
-export { getNegotiations, getNegotiationItem, getNegotiationMessages, sendNegotiationMessage, changeNegotiationAction, } from './generated/index.js';
-export type { GetVacanciesData, GetVacanciesResponses, GetVacancyData, GetVacancyResponses, ApplyToVacancyData, ApplyToVacancyResponses, GetDictionariesResponses, GetAreasResponses, GetIndustriesResponses, GetLanguagesResponses, GetSkillsResponses, GetCurrentUserInfoResponses, AuthorizeData, AuthorizeResponses, GetMineResumesResponses, GetResumeData, GetResumeResponses, CreateResumeData, CreateResumeResponses, EditResumeData, EditResumeResponses, SearchForResumesData, SearchForResumesResponses, GetNegotiationsData, GetNegotiationsResponses, GetNegotiationItemData, GetNegotiationItemResponses, SendNegotiationMessageData, SendNegotiationMessageResponses, ChangeNegotiationActionData, ChangeNegotiationActionResponses, } from './generated/index.js';
-export * from './generated/index.js';
-/**
- * Create a pre-configured HeadHunter API client
- * @param config Configuration options
- * @returns Configured client instance
- */
-export declare function createHeadHunterClient(config: {
-    userAgent: string;
-    accessToken?: string;
-    baseURL?: string;
-}): import("./generated/client/types.js").Client;
-export declare const HH_API_BASE_URL = "https://api.hh.ru";
-export declare const HH_REQUIRED_USER_AGENT_FORMAT = "AppName/Version (contact@example.com)";
+export { HhApiClient } from './HhApiClient.js';
+export { HhApiClient as default } from './HhApiClient.js';
+export * from './types.js';

package/build/src/index.js

@@ -1,37 +1,3 @@
-// HeadHunter API Client
-// Re-exports from generated SDK with organized structure
-// === Core Client & Configuration ===
-export { client } from './generated/client.gen.js';
-export { createClient } from './generated/client/index.js';
-// === Most Used Functions ===
-// Vacancy search and management
-export { getVacancies, getVacancy, getFavoriteVacancies, addVacancyToFavorite, deleteVacancyFromFavorite, getVacanciesSimilarToResume, applyToVacancy, } from './generated/index.js';
-// Dictionaries and references
-export { getDictionaries, getAreas, getIndustries, getLanguages, getSkills, getProfessionalRolesDictionary, getMetroStations, getMetroStationsInCity, } from './generated/index.js';
-// User and authentication
-export { getCurrentUserInfo, editCurrentUserInfo, authorize, invalidateToken } from './generated/index.js';
-// Resume management
-export { getMineResumes, getResume, createResume, editResume, deleteResume, publishResume, searchForResumes, getResumeConditions, } from './generated/index.js';
-// Negotiations
-export { getNegotiations, getNegotiationItem, getNegotiationMessages, sendNegotiationMessage, changeNegotiationAction, } from './generated/index.js';
-// === All Functions (for advanced usage) ===
-export * from './generated/index.js';
-// === Helper Configuration ===
-import { createClient } from './generated/client/index.js';
-/**
- * Create a pre-configured HeadHunter API client
- * @param config Configuration options
- * @returns Configured client instance
- */
-export function createHeadHunterClient(config) {
-    return createClient({
-        baseUrl: config.baseURL || 'https://api.hh.ru',
-        headers: {
-            'User-Agent': config.userAgent,
-            ...(config.accessToken && { Authorization: `Bearer ${config.accessToken}` }),
-        },
-    });
-}
-// === Constants ===
-export const HH_API_BASE_URL = 'https://api.hh.ru';
-export const HH_REQUIRED_USER_AGENT_FORMAT = 'AppName/Version (contact@example.com)';
+export { HhApiClient } from './HhApiClient.js';
+export { HhApiClient as default } from './HhApiClient.js';
+export * from './types.js';

package/build/src/types.d.ts

@@ -0,0 +1 @@
+export * from './generated/types.gen.js';

package/build/src/types.js

@@ -0,0 +1 @@
+export * from './generated/types.gen.js';

package/package.json

@@ -1,13 +1,37 @@
 {
   "name": "@sargonpiraev/hh-api-client",
-  "version": "1.0.0",
-  "description": "",
-  "main": "./build/index.js",
-  "types": "./build/generated/types.gen.ts",
+  "version": "1.1.0",
+  "description": "A TypeScript client for the HeadHunter API, generated from the official OpenAPI specification.",
+  "main": "./build/src/index.js",
+  "types": "./build/src/index.d.ts",
   "type": "module",
   "files": [
-    "build"
+    "build",
+    "README.md",
+    "LICENSE"
   ],
+  "keywords": [
+    "api-client",
+    "typescript",
+    "sdk",
+    "headhunter",
+    "hh",
+    "openapi",
+    "job-search",
+    "recruiting"
+  ],
+  "author": {
+    "name": "Sargon Piraev",
+    "email": "sargonpiraev@gmail.com"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/sargonpiraev/hh-api-client.git"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "scripts": {
     "test": "jest --passWithNoTests --coverage",
     "dev": "tsx watch ./src/index.ts",