@focusd/api

Focusd API client library with protobuf definitions and TypeScript types.

Installation

npm install @focusd/api

Usage

TypeScript/JavaScript - Import custom types

import { Session, Application, Classification, AuthProvider } from '@focusd/api';

// Create a session
const session: Session = {
  name: "Work Session",
  duration: { seconds: 3600, nanos: 0 },
  started_at: { seconds: Date.now() / 1000, nanos: 0 }
};

// Create an application
const app: Application = {
  name: "VS Code",
  title: "Visual Studio Code",
  bundle_id: "com.microsoft.VSCode",
  url: "file:///path/to/project",
  classification: Classification.CLASSIFICATION_PRODUCTIVITY,
  categories: ["development", "coding"]
};

Import protobuf-generated types (advanced)

// API types only
import { AskLLMRequest, AskLLMResponse } from '@focusd/api/api';

// Engine types only  
import { Session, Application, EngineService } from '@focusd/api/engine';

Available Types

Custom TypeScript Types

• Session - Focus session with optional id, timestamps, and duration
• Application - Application information with classification and categories
• Classification - Application classification enum (NEUTRAL, PRODUCTIVITY, DISTRUCTION)
• AuthProvider - Authentication provider enum (GITHUB, GOOGLE, APPLE)
• FocusStartRequest - Start focus session request
• FocusStartResponse - Start focus session response
• FocusCheckRequest - Check focus status request
• FocusCheckResponse - Check focus status response
• FocusStatusResponse - Focus status response
• AuthStartRequest - Start auth request
• AuthRedirectURLRequest - Auth redirect request
• AuthRedirectURLResponse - Auth redirect response

Protobuf-Generated Types (Advanced)

• AskLLMRequest - Request for LLM queries
• AskLLMResponse - Response from LLM queries
• AuthRedirectURLRequest - Authentication redirect request
• AuthRedirectURLResponse - Authentication redirect response
• LLMProviderType - LLM provider type enum
• APIService - API service definition
• EngineService - Engine service definition