{"_id":"@covia/covialib","_rev":"2-e50f0fc13f9afe1726653c38eaa22422","name":"@covia/covialib","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@covia/covialib","version":"1.0.0","keywords":["covia","grid","api","typescript","data-assets","operations"],"author":{"name":"Covia AI"},"license":"MIT","_id":"@covia/covialib@1.0.0","maintainers":[{"name":"convexbase","email":"mike@convex.world"},{"name":"anu.dev.c09","email":"anu.dev.c09@gmail.com"},{"name":"chirdeep","email":"chirdeep@covia.ai"},{"name":"mike-covia","email":"mike@covia.ai"}],"homepage":"https://github.com/covia-ai/covialib#readme","bugs":{"url":"https://github.com/covia-ai/covialib/issues"},"dist":{"shasum":"20cb098a3e39e6caefc1ec5b4ba86ce140c6e303","tarball":"https://registry.npmjs.org/@covia/covialib/-/covialib-1.0.0.tgz","fileCount":7,"integrity":"sha512-FKo8sYAzaKxks4FiJJVXHzoCILBP8qOCdUOktuHrtSlWEATCEa64bBi/R8yT0O5c/z0oPZUNiddcX1ZdA7VP3Q==","signatures":[{"sig":"MEUCIE/La35hUS8Q5vQw+lZlva0JLVWhL1qHrzJbxo/iAC2DAiEAtzKADUgZtbDuKy36RyJB/jmddRmxs7HsGwsLqypcZE4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":55904},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=18"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.js"}},"gitHead":"d862fbc33d991b20f471d9fdedb9e16d4ba48735","scripts":{"dev":"tsup src/index.ts --format cjs,esm --dts --watch","lint":"eslint src --ext .ts","test":"jest","build":"tsup src/index.ts --format cjs,esm --dts --clean","prepare":"npm run build","prepublishOnly":"npm run build && npm test"},"_npmUser":{"name":"anu.dev.c09","email":"anu.dev.c09@gmail.com"},"repository":{"url":"git+https://github.com/covia-ai/covialib.git","type":"git"},"_npmVersion":"10.9.3","description":"Typescript library for covia-ai","directories":{},"_nodeVersion":"22.19.0","dependencies":{"did-resolver":"^4.1.0","web-did-resolver":"^2.0.32"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^30.2.0","tsup":"^8.0.0","dotenv":"^17.2.3","ts-jest":"^29.4.6","typescript":"^5.3.0","@types/jest":"^30.0.0","@types/node":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/covialib_1.0.0_1771479913994_0.5579799730259414","host":"s3://npm-registry-packages-npm-production"},"deprecated":"This package has been renamed. Use @covia/covia-sdk instead."}},"time":{"created":"2026-02-19T05:45:13.923Z","modified":"2026-02-24T04:24:59.474Z","1.0.0":"2026-02-19T05:45:14.129Z"},"bugs":{"url":"https://github.com/covia-ai/covialib/issues"},"author":{"name":"Covia AI"},"license":"MIT","homepage":"https://github.com/covia-ai/covialib#readme","keywords":["covia","grid","api","typescript","data-assets","operations"],"repository":{"url":"git+https://github.com/covia-ai/covialib.git","type":"git"},"description":"Typescript library for covia-ai","maintainers":[{"name":"anu.dev.c09","email":"anu.dev.c09@gmail.com"},{"name":"chirdeep","email":"chirdeep@covia.ai"},{"name":"convexbase","email":"mike@convex.world"},{"name":"mike-covia","email":"mike@covia.ai"}],"readme":"# Covia TypeScript API\r\n\r\nThis directory contains the TypeScript implementation of the Covia grid API, extracted from the original JavaScript implementation.\r\n\r\n## File Structure\r\n\r\n- **`types.ts`** - TypeScript interfaces, types, and the `CoviaError` class\r\n- **`Asset.ts`** - Abstract base class for all assets\r\n- **`Operation.ts`** - Extends `Asset` for operation-specific functionality\r\n- **`DataAsset.ts`** - Extends `Asset` for data asset-specific functionality\r\n- **`Venue.ts`** - Manages connections and provides factory methods\r\n- **`index.ts`** - Exports all classes and types\r\n- **`example.ts`** - Usage examples\r\n\r\n## Inheritance Structure\r\n\r\n```\r\nAsset (abstract base class)\r\n├── Operation (extends Asset)\r\n└── DataAsset (extends Asset)\r\n```\r\n\r\n## Usage\r\n\r\n```typescript\r\nimport { Venue, Asset, Operation, DataAsset } from '@/lib/covia';\r\n\r\n// Create venue\r\nconst venue = new Venue({ \r\n  baseUrl: 'http://localhost:8080',\r\n  venueId: 'my-venue' \r\n});\r\n\r\n// Get assets (returns Operation or DataAsset based on metadata)\r\nconst operation = await venue.getAsset('op-id');\r\nconst dataAsset = await venue.getAsset('data-id');\r\n\r\n// Use inherited functionality\r\nawait operation.invoke({ param: 'value' }); // Simplified: just pass input parameters\r\nawait dataAsset.uploadContent(content);\r\n```\r\n\r\n## Key Features\r\n\r\n- **Type Safety**: Full TypeScript support with proper interfaces\r\n- **Inheritance**: `Operation` and `DataAsset` inherit all functionality from `Asset`\r\n- **Caching**: Built-in caching for improved performance\r\n- **Error Handling**: Typed `CoviaError` class for proper error management\r\n- **Stream Support**: Built-in support for content streaming\r\n# @covia-ai/covialib\r\n\r\nTypeScript client library for the Covia grid API.\r\n\r\n## Features\r\n\r\n- 🔒 **Type Safety**: Full TypeScript support with comprehensive type definitions\r\n- 🏗️ **Object-Oriented**: Clean inheritance structure with Asset, Operation, and DataAsset classes\r\n- ⚡ **Performance**: Built-in caching for improved performance\r\n- 🌊 **Streaming**: Native support for content streaming\r\n- 🛡️ **Error Handling**: Typed error handling with CoviaError class\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @covia-ai/covialib\r\n```\r\n\r\nor\r\n\r\n```bash\r\nyarn add @covia-ai/covialib\r\n```\r\n\r\n## Quick Start\r\n\r\n```typescript\r\nimport { Venue, Asset, Operation, DataAsset } from '@covia-ai/covialib';\r\n\r\n// Create a venue connection\r\nconst venue = new Venue({\r\n  baseUrl: 'http://localhost:8080',\r\n  venueId: 'my-venue'\r\n});\r\n\r\n// Get assets (returns Operation or DataAsset based on metadata)\r\nconst operation = await venue.getAsset('op-id') as Operation;\r\nconst dataAsset = await venue.getAsset('data-id') as DataAsset;\r\n\r\n// Use operation\r\nconst result = await operation.invoke({ \r\n  param: 'value' \r\n});\r\n\r\n// Upload content to data asset\r\nawait dataAsset.uploadContent(content);\r\n```\r\n\r\n## Architecture\r\n\r\n```\r\nAsset (abstract base class)\r\n├── Operation (extends Asset)\r\n└── DataAsset (extends Asset)\r\n```\r\n\r\n### Core Classes\r\n\r\n- **Venue**: Manages connections and provides factory methods for creating assets\r\n- **Asset**: Abstract base class providing common functionality\r\n- **Operation**: Extends Asset for operation-specific functionality\r\n- **DataAsset**: Extends Asset for data asset-specific functionality\r\n\r\n## API Reference\r\n\r\n### Venue\r\n\r\n```typescript\r\nclass Venue {\r\n  constructor(config: VenueConfig);\r\n  getAsset(assetId: string): Promise<Asset>;\r\n  // ... other methods\r\n}\r\n```\r\n\r\n### Operation\r\n\r\n```typescript\r\nclass Operation extends Asset {\r\n  invoke(params: Record<string, any>): Promise<any>;\r\n  // ... inherited methods from Asset\r\n}\r\n```\r\n\r\n### DataAsset\r\n\r\n```typescript\r\nclass DataAsset extends Asset {\r\n  uploadContent(content: any): Promise<void>;\r\n  downloadContent(): Promise<any>;\r\n  // ... inherited methods from Asset\r\n}\r\n```\r\n\r\n## Error Handling\r\n\r\nThe library provides a typed `CoviaError` class for comprehensive error handling:\r\n\r\n```typescript\r\nimport { CoviaError } from '@covia-ai/covialib';\r\n\r\ntry {\r\n  await operation.invoke({ param: 'value' });\r\n} catch (error) {\r\n  if (error instanceof CoviaError) {\r\n    console.error('Covia API Error:', error.message);\r\n    console.error('Error code:', error.code);\r\n  }\r\n}\r\n```\r\n\r\n## Development\r\n\r\n```bash\r\n# Install dependencies\r\nnpm install\r\n\r\n# Build the library\r\nnpm run build\r\n\r\n# Run tests\r\nnpm test\r\n\r\n# Run linter\r\nnpm run lint\r\n\r\n# Type checking\r\nnpm run typecheck\r\n```\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request.\r\n\r\n## License\r\n\r\nMIT\r\n\r\n## Support\r\n\r\nFor issues and questions, please use the [GitHub issue tracker](https://github.com/covia-ai/covialib/issues).","readmeFilename":"README.md"}