@hypercard/shared

Shared validators and types for Hypercard frontend and backend applications.

Installation

yarn add @hypercard/shared
# or
npm install @hypercard/shared

Usage

Importing validators

import { expenseValidator, messageValidator } from "@hypercard/shared";

// Validate expense data
const expense = expenseValidator.parse(expenseData);

Importing types only

import type { Expense, ServerMessage } from "@hypercard/shared/types";

// Use types for type annotations
const handleMessage = (message: ServerMessage) => {
  // ...
};

Available Validators

• Common: Tool calls, messages, actions, events
• Expense: Expense data, submissions, validation results
• Message: Server message types for real-time communication
• Workflow: Expense workflow state and conversation context
• Websocket: WebSocket event types
• Receipts: Parsed receipt data
• Events: LangGraph events and node names
• Tools: Tool input/output types

Available Constants

• ContentType: Text and image content types
• Role: User, assistant, system roles
• ActionType: Tool call and other action types
• EventType: Message and action event types
• SERVER_MESSAGE_TYPES: All server message type constants
• SUGGESTED_ACTIONS: Suggested action types
• TarsMessageAction: WebSocket message actions
• LANGGRAPH_EVENTS: LangGraph event types
• NODE_NAMES: Workflow node names

TypeScript Support

This package is built with TypeScript and provides full type definitions. All validators use Zod for runtime validation with TypeScript inference.

Domain-Driven Design

The validators follow domain-driven design patterns with:

• Arrow named functions using TypeScript
• Default parameters as objects
• Zod validation for type safety
• Const objects over enums for immutability