@clipstake/view-tracking
Version:
A tRPC-based view tracking service with client for Next.js apps
87 lines (60 loc) • 1.64 kB
Markdown
# View Tracking Service
A tRPC-based view tracking service with TypeScript client for Next.js applications.
## Installation
```bash
npm install @clipstake/view-tracking
# or
bun add @clipstake/view-tracking
```
## Usage
### Client Usage (Next.js)
```typescript
import { createClient } from '@clipstake/view-tracking/client'
const client = createClient({
url: 'https://your-api-url.com/trpc'
})
// Use the client
const result = await client.greet.query({ name: 'John' })
console.log(result) // "Hello John!"
```
### Type Imports
```typescript
import type { Router } from '@clipstake/view-tracking/server'
// Use Router type for type-safe client creation
```
### Server Usage (for deployment)
```typescript
import { handler, router } from '@clipstake/view-tracking/server'
// The handler is ready to be deployed to AWS Lambda
export { handler }
// Or extend the router
import { router } from '@clipstake/view-tracking/server'
// Add your own procedures to the router
```
## Development
```bash
# Build the package
bun run build
# Deploy the server (SST)
bun run deploy
# Development mode
bun run dev
```
## Publishing
```bash
# Publish alpha version (0.0.1-alpha.0, 0.0.1-alpha.1, etc.)
bun run publish:alpha
# Publish beta version (0.0.1-beta.0, 0.0.1-beta.1, etc.)
bun run publish:beta
# Publish release version (0.0.1, 0.0.2, etc.)
bun run publish:release
```
Note: Alpha and beta versions are published with tags, so they won't be installed by default. To install:
```bash
# Install alpha
npm install @clipstake/view-tracking@alpha
# Install beta
npm install @clipstake/view-tracking@beta
```
## License
MIT