{"_id":"@0xshariq/voxa-types","name":"@0xshariq/voxa-types","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@0xshariq/voxa-types","version":"1.0.0","description":"Shared TypeScript type definitions for Voxa HTTP Client ecosystem (CLI, API, SDKs)","keywords":["voxa","types","typescript","http-client","definitions"],"homepage":"https://github.com/0xshariq/voxa#readme","bugs":{"url":"https://github.com/0xshariq/voxa/issues"},"repository":{"type":"git","url":"git+https://github.com/0xshariq/voxa.git","directory":"packages/voxa-types"},"license":"MIT","author":{"name":"Sharique Chaudhary"},"type":"module","types":"./src/index.d.ts","exports":{".":{"types":"./src/index.d.ts"},"./client":{"types":"./src/client.d.ts"},"./cache":{"types":"./src/cache.d.ts"},"./streaming":{"types":"./src/streaming.d.ts"},"./graphql":{"types":"./src/graphql.d.ts"},"./http2":{"types":"./src/http2.d.ts"},"./common":{"types":"./src/common.d.ts"}},"dependencies":{"@types/node":"^24.10.1"},"publishConfig":{"access":"public"},"gitHead":"9e4d7416959a1f980bdfec9eb73b8a6f625d024e","_id":"@0xshariq/voxa-types@1.0.0","_nodeVersion":"25.2.1","_npmVersion":"11.6.4","dist":{"integrity":"sha512-z2a8hROyMo8pNFbmGOtK+fcMpyUgtiwMK8XQXmcZo3lQHMs7TEzI7sLrVzg1X/8CGafHDY+9xb9HJ79lHACaCg==","shasum":"0176344f7b0aa703c16108975375ae28dc389b9d","tarball":"https://registry.npmjs.org/@0xshariq/voxa-types/-/voxa-types-1.0.0.tgz","fileCount":9,"unpackedSize":12537,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIG9Qr02cmBUqrKXuOSo4Wgb1WwFwKIOAvcenkullBProAiBu0VItGf0Nt/zwqFObhp498A1RN0PQA9DSu4nunYFtLA=="}]},"_npmUser":{"name":"0xshariq","email":"khanshariq92213@gmail.com"},"directories":{},"maintainers":[{"name":"0xshariq","email":"khanshariq92213@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/voxa-types_1.0.0_1764941401760_0.8113569167664656"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-05T13:30:01.665Z","1.0.0":"2025-12-05T13:30:01.928Z","modified":"2025-12-05T13:30:02.232Z"},"maintainers":[{"name":"0xshariq","email":"khanshariq92213@gmail.com"}],"description":"Shared TypeScript type definitions for Voxa HTTP Client ecosystem (CLI, API, SDKs)","homepage":"https://github.com/0xshariq/voxa#readme","keywords":["voxa","types","typescript","http-client","definitions"],"repository":{"type":"git","url":"git+https://github.com/0xshariq/voxa.git","directory":"packages/voxa-types"},"author":{"name":"Sharique Chaudhary"},"bugs":{"url":"https://github.com/0xshariq/voxa/issues"},"license":"MIT","readme":"# @0xshariq/voxa-types\n\nShared TypeScript type definitions for the Voxa HTTP Client ecosystem.\n\n## Installation\n\n```bash\nnpm install @0xshariq/voxa-types\n# or\npnpm add @0xshariq/voxa-types\n# or\nyarn add @0xshariq/voxa-types\n```\n\n## Usage\n\n### Import All Types\n\n```typescript\nimport type { VoxaConfig, HttpMethod, CacheConfig } from '@0xshariq/voxa-types';\n```\n\n### Import Specific Modules\n\n```typescript\n// Client types\nimport type { VoxaConfig, VoxaResponse } from '@0xshariq/voxa-types/client';\n\n// Cache types\nimport type { CacheConfig, CacheAdapter } from '@0xshariq/voxa-types/cache';\n\n// Streaming types\nimport type { StreamingImageOptions, ImagePayload } from '@0xshariq/voxa-types/streaming';\n\n// GraphQL types\nimport type { GraphQLConfig, GraphQLRequest } from '@0xshariq/voxa-types/graphql';\n```\n\n## Type Categories\n\n### Client Types\n- `VoxaConfig` - Main client configuration\n- `VoxaResponse` - Response wrapper with metadata\n- `HttpMethod` - Supported HTTP methods\n- `RequestPriority` - Request priority levels\n\n### Cache Types\n- `CacheConfig` - Cache configuration\n- `CacheAdapter` - Custom cache adapter interface\n- `CacheEntry` - Cache entry structure\n\n### Streaming Types\n- `StreamingImageOptions` - Image streaming configuration\n- `StreamingVideoOptions` - Video streaming configuration\n- `ImagePayload` - Supported image types\n- `VideoPayload` - Supported video types\n\n### GraphQL Types\n- `GraphQLConfig` - GraphQL configuration\n- `GraphQLRequest` - GraphQL query request\n- `GraphQLResponse` - GraphQL response structure\n- `GraphQLError` - GraphQL error format\n\n### HTTP/2 Types\n- `Http2PushConfig` - HTTP/2 push configuration\n- `PushedResource` - Pushed resource metadata\n\n### Common Types\n- `RequestMetadata` - Request tracking metadata\n- `RetryConfig` - Retry configuration\n- `QueueConfig` - Queue configuration\n- `CircuitBreakerConfig` - Circuit breaker configuration\n- And more...\n\n## Usage in Projects\n\n### In CLI\n```typescript\nimport type { VoxaConfig } from '@0xshariq/voxa-types';\n\nfunction createClient(config: VoxaConfig) {\n  // CLI implementation\n}\n```\n\n### In API\n```typescript\nimport type { VoxaResponse, HttpMethod } from '@0xshariq/voxa-types';\n\nasync function handleRequest(method: HttpMethod): Promise<VoxaResponse> {\n  // API implementation\n}\n```\n\n### In SDKs\n```typescript\nimport type { CacheConfig, StreamingImageOptions } from '@0xshariq/voxa-types';\n\nclass VoxaSDK {\n  constructor(\n    cache: CacheConfig,\n    streaming: StreamingImageOptions\n  ) {\n    // SDK implementation\n  }\n}\n```\n\n## License\n\nMIT © [Sharique Chaudhary](https://github.com/0xshariq)\n","readmeFilename":"README.md","_rev":"1-a5349fc453b20c5181cec00589807227"}