Getting Started

This guide will help you get up and running with openweight in minutes.

Installation

npm

npm install @openweight/sdk

pnpm

pnpm add @openweight/sdk

yarn

yarn add @openweight/sdk

Parse a Workout Log

import { parseWorkoutLog } from '@openweight/sdk'

const json = `{
  "date": "2024-01-15T09:30:00Z",
  "exercises": [
    {
      "exercise": { "name": "Squat" },
      "sets": [
        { "reps": 5, "weight": 100, "unit": "kg" }
      ]
    }
  ]
}`

const workout = parseWorkoutLog(json)
console.log(workout.exercises[0].exercise.name) // "Squat"

Validate Data

import { validateWorkoutLog, isValidWorkoutLog } from '@openweight/sdk'

const data = {
  date: '2024-01-15T09:30:00Z',
  exercises: [
    {
      exercise: { name: 'Bench Press' },
      sets: [{ reps: 8, weight: 60, unit: 'kg' }]
    }
  ]
}

// Type guard
if (isValidWorkoutLog(data)) {
  console.log('Valid workout!')
}

// Detailed validation
const result = validateWorkoutLog(data)
if (!result.valid) {
  console.log(result.errors)
}

Serialize to JSON

import { serializeWorkoutLog, serializeWorkoutLogPretty } from '@openweight/sdk'

const workout = {
  date: '2024-01-15T09:30:00Z',
  exercises: [
    {
      exercise: { name: 'Deadlift' },
      sets: [{ reps: 5, weight: 140, unit: 'kg' }]
    }
  ]
}

// Compact JSON (for storage/transmission)
const compact = serializeWorkoutLog(workout)

// Pretty JSON (for display/debugging)
const pretty = serializeWorkoutLogPretty(workout)

Kotlin SDK

For Android/JVM projects, add the Maven Central dependency:

dependencies {
    implementation("io.github.radupana:openweight-sdk:0.2.0")
}

See the full Kotlin SDK documentation for parsing, validation, and serialization examples.

Next Steps

• Core Concepts — Understand the data model
• Schema Reference — Full schema specification
• Examples — Browse example workout files