@platoona/shared-types

Shared TypeScript types for Platoona tRPC API

Installation

npm install @platoona/shared-types

Usage

Basic tRPC Client Setup

import { createTRPCClient, httpBatchLink } from '@trpc/client'
import type { AppRouter } from '@platoona/shared-types'

const trpc = createTRPCClient<AppRouter>({
  links: [
    httpBatchLink({
      url: 'http://localhost:8000/trpc',
    }),
  ],
})

// Use the client
const result = await trpc.hello.query({ name: 'World' })
console.log(result.greeting) // "Hello World!"

Type Usage

import type { 
  RouterInputs, 
  RouterOutputs,
  HelloInput,
  HelloOutput 
} from '@platoona/shared-types'

// Input types
type HelloParams = HelloInput // { name?: string } | undefined

// Output types  
type HelloResult = HelloOutput // { greeting: string; timestamp: string }

// All router inputs/outputs
type AllInputs = RouterInputs
type AllOutputs = RouterOutputs

Next.js Integration

// lib/trpc.ts
import { createTRPCClient, httpBatchLink } from '@trpc/client'
import type { AppRouter } from '@platoona/shared-types'

export const api = createTRPCClient<AppRouter>({
  links: [
    httpBatchLink({
      url: process.env.NEXT_PUBLIC_API_URL + '/trpc',
      headers() {
        return {
          authorization: `Bearer ${getAuthToken()}`,
        }
      },
    }),
  ],
})

Available Types

• AppRouter - Main router type
• RouterInputs - All procedure input types
• RouterOutputs - All procedure output types
• HelloInput - Hello procedure input type
• HelloOutput - Hello procedure output type
• HealthOutput - Health procedure output type

Development

This package is automatically generated from the Platoona backend API.

To update types, modify the backend router and rebuild this package.

License

MIT