@jasonaviandres/velox-earn-types

TypeScript type definitions for the Velox Earn API. This package provides the Client type that gives full type safety when using the Velox Earn SDK.

Installation

npm install @jasonaviandres/velox-earn-types @jasonaviandres/earn-sdk

Usage

import type { Client } from '@jasonaviandres/velox-earn-types';
import { createORPCClient, contract } from '@jasonaviandres/earn-sdk';
import { OpenAPILink } from '@orpc/openapi-client/fetch';

const link = new OpenAPILink(contract as any, {
  url: 'https://your-api.com'
});

const client = createORPCClient<Client>(link).api;
// Now you have full type safety!

What's Included

• Client - Full type definition for all API routes, equivalent to RouterClient<typeof routes> from the server
• Complete copy of all server type definitions for full self-containment

Build Process

This package contains a complete copy of the server's type definitions to ensure it's fully self-contained. When the server's routes change, rebuild this package to update the types:

# Make sure the server is built first
cd apps/server && pnpm run build:orpc

# Then build the types package
cd packages/velox-earn-types && pnpm run build

The build process:

1. Copies all type definitions from the server's dist/src directory to dist/server
2. Generates dist/index.d.ts that exports the Client type
3. Creates a minimal dist/index.js file (this is a types-only package)

Publishing

This package is published to GitHub Packages:

pnpm publish

Important: Always build the server first before building and publishing this package, as it copies the server's type definitions.