@caronashow/api

TypeScript/JavaScript client library for the CaronaShow API. This package provides type-safe access to the CaronaShow service APIs.

Installation

npm install @caronashow/api
# or
yarn add @caronashow/api
# or
pnpm add @caronashow/api
# or
bun install @caronashow/api

Usage

Basic Setup Example

import { createClient } from "@connectrpc/connect";
import { createGrpcWebTransport } from "@connectrpc/connect-web";
import { OnboardingService } from "@caronashow/api";

// Create a transport
const transport = createGrpcWebTransport({
  baseUrl: "https://dev.carona.show",
  useBinaryFormat: true,
});

// Create the client
const client = createClient(OnboardingService, transport);

// Check if the current user has completed onboarding
const status = await client.getOnboardingStatus({});

API Documentation

Types

The package includes the following type definitions:

• User - User information including ID, name, email, participation mode, tier, avatar, and org
• TimeOfDay - A time without a date component (hours, minutes)
• DayOfWeek - Enum for days of the week
• ChatPreference - Passenger's conversation preference (open, quiet, indifferent)
• ParticipationMode - User's role in the system (offer, search, explore)
• DriverOfferSetup - Driver's vehicle and route preferences
• PassengerSearchSetup - Passenger's pickup and schedule preferences

Services

This is not a full list of services. These are just some examples.

• OnboardingService - One-shot onboarding flow
  • getOnboardingStatus({}): Promise<GetOnboardingStatusResponse> - Check if the current user has completed onboarding
  • completeOnboarding(request: CompleteOnboardingRequest): Promise<CompleteOnboardingResponse> - Submit all onboarding data

Development

This package is automatically generated from Protocol Buffer definitions. Do not modify the generated code directly. Instead, make changes to the proto files in the parent repository.

Building

The package is built using the following tools:

• buf - Protocol Buffer compiler
• protoc-gen-es - TypeScript code generator
• protoc-gen-connect-es - Connect-ES code generator

To rebuild the package:

make generate

License

MIT License - see LICENSE file for details.