{"_id":"@ahmedsherwani/clearerrors-sdk","name":"@ahmedsherwani/clearerrors-sdk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@ahmedsherwani/clearerrors-sdk","version":"1.0.0","description":"Frontend SDK for translating API errors into user-friendly messages. No API keys required - completely free!","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"build":"tsc","dev":"tsc --watch","prepublishOnly":"pnpm build"},"keywords":["error-handling","error-translation","api-errors","user-friendly-errors","sdk","frontend","typescript","react","vue","angular"],"author":"","license":"MIT","repository":{"type":"git","url":"git+https://github.com/maksherwani/clear-errors.git","directory":"packages/sdk"},"publishConfig":{"access":"public"},"dependencies":{"@ahmedsherwani/clearerrors-core":"^1.0.0"},"devDependencies":{"typescript":"^5.3.3","@types/node":"^20.11.0"},"peerDependencies":{"axios":"^1.0.0"},"peerDependenciesMeta":{"axios":{"optional":true}},"_id":"@ahmedsherwani/clearerrors-sdk@1.0.0","bugs":{"url":"https://github.com/maksherwani/clear-errors/issues"},"homepage":"https://github.com/maksherwani/clear-errors#readme","_nodeVersion":"22.13.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-rcojMeuZ1UODxWil/RWWQLe6gluSPO/KF8uwkenEqVuvt8f/Cp/DcwoanFafQfQW8Ra5E69JR+jTeISfZ/V6Gg==","shasum":"3452c45057d477c0c3df1ef70a9b687e5e405cf6","tarball":"https://registry.npmjs.org/@ahmedsherwani/clearerrors-sdk/-/clearerrors-sdk-1.0.0.tgz","fileCount":4,"unpackedSize":8023,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDzFZhCfPDoJBjEN5mk9dFV1Nmsf6AUeR11diBR/POItQIhAN8W4CZ52hfbotbQmVHzj7FAac+aVoCGF9p12QF4XM5d"}]},"_npmUser":{"name":"ahmedsherwani","email":"maksherwanii@gmail.com"},"directories":{},"maintainers":[{"name":"ahmedsherwani","email":"maksherwanii@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/clearerrors-sdk_1.0.0_1767474504710_0.8897082011349711"},"_hasShrinkwrap":false}},"time":{"created":"2026-01-03T21:08:24.588Z","1.0.0":"2026-01-03T21:08:24.859Z","modified":"2026-01-03T21:08:25.166Z"},"maintainers":[{"name":"ahmedsherwani","email":"maksherwanii@gmail.com"}],"description":"Frontend SDK for translating API errors into user-friendly messages. No API keys required - completely free!","homepage":"https://github.com/maksherwani/clear-errors#readme","keywords":["error-handling","error-translation","api-errors","user-friendly-errors","sdk","frontend","typescript","react","vue","angular"],"repository":{"type":"git","url":"git+https://github.com/maksherwani/clear-errors.git","directory":"packages/sdk"},"bugs":{"url":"https://github.com/maksherwani/clear-errors/issues"},"license":"MIT","readme":"# @ahmedsherwani/clearerrors-sdk\n\nFrontend SDK for translating API errors into user-friendly messages. **Completely free - no API keys required!**\n\n## Installation\n\n```bash\nnpm install @ahmedsherwani/clearerrors-sdk\n```\n\n## Quick Start\n\n```typescript\nimport { translateApiError } from '@ahmedsherwani/clearerrors-sdk';\n\n// In your error handler\ntry {\n  const response = await fetch('/api/users');\n  if (!response.ok) {\n    throw await response.json();\n  }\n} catch (error) {\n  // Translate the error - no API key needed!\n  const translated = await translateApiError(error, {\n    locale: 'en',\n    tone: 'friendly',\n  });\n\n  // Display to user\n  showError(translated.message);\n}\n```\n\n## Features\n\n- ✅ **No API keys required** - completely free!\n- ✅ Works with any error format (Axios, Fetch, standard errors)\n- ✅ TypeScript support\n- ✅ Zero configuration needed\n- ✅ Can use local translation or API endpoint\n- ✅ Lightweight and fast\n\n## Usage\n\n### Basic Usage\n\n```typescript\nimport { translateApiError } from '@ahmedsherwani/clearerrors-sdk';\n\nconst result = await translateApiError(error, {\n  locale: 'en',\n  tone: 'friendly',\n});\n```\n\n### With API Endpoint\n\nBy default, the SDK will try to use the API endpoint at `http://localhost:3001`. You can configure this:\n\n```typescript\nconst result = await translateApiError(error, {\n  apiUrl: 'https://api.clearerrors.com',\n  locale: 'en',\n  tone: 'friendly',\n});\n```\n\n### With Axios Interceptor\n\n```typescript\nimport { createAxiosInterceptor } from '@ahmedsherwani/clearerrors-sdk';\nimport axios from 'axios';\n\nconst interceptor = createAxiosInterceptor({\n  apiUrl: 'https://api.clearerrors.com',\n  locale: 'en',\n  tone: 'friendly',\n});\n\naxios.interceptors.response.use(undefined, interceptor);\n```\n\n## Options\n\n- `apiKey` (optional): API key for usage tracking (not required for free usage)\n- `apiUrl` (optional): API endpoint URL (default: `http://localhost:3001`)\n- `locale` (optional): Language code (default: 'en')\n- `tone` (optional): Message tone - 'friendly', 'professional', 'casual' (default: 'friendly')\n- `useAI` (optional): Whether to use AI fallback (default: false)\n\n## API Reference\n\n### `translateApiError(error, options?)`\n\nMain function to translate API errors.\n\n**Parameters:**\n- `error`: Any error object\n- `options`: SDK options (see above)\n\n**Returns:** `Promise<TranslatedError>`\n\n### `createAxiosInterceptor(options?)`\n\nCreate an Axios response interceptor for automatic error translation.\n\n**Parameters:**\n- `options`: SDK options\n\n**Returns:** Axios error interceptor function\n\n## Examples\n\nSee the [main repository](https://github.com/yourusername/clear-errors) for more examples.\n\n## License\n\nMIT\n\n","readmeFilename":"README.md","_rev":"1-96d952356d8f250cc48cf3c75fe701e0"}