offcourse 0.0.2 → 1.0.1

package/README.md

@@ -1,33 +1,142 @@
 # Offcourse
 
-[![npm version](https://img.shields.io/npm/v/offcourse?color=cb0000&label=npm)](https://www.npmjs.com/package/offcourse)
-[![npm downloads](https://img.shields.io/npm/dm/offcourse?color=cb0000)](https://www.npmjs.com/package/offcourse)
-[![license](https://img.shields.io/npm/l/offcourse?color=cb0000)](https://github.com/sebastian-software/offcourse/blob/main/LICENSE)
-[![node](https://img.shields.io/node/v/offcourse?color=cb0000)](https://nodejs.org)
+[![npm version](https://img.shields.io/npm/v/offcourse?color=3b82f6&label=npm)](https://www.npmjs.com/package/offcourse)
+[![npm downloads](https://img.shields.io/npm/dm/offcourse?color=3b82f6)](https://www.npmjs.com/package/offcourse)
+[![license](https://img.shields.io/npm/l/offcourse?color=3b82f6)](https://github.com/sebastian-software/offcourse/blob/main/LICENSE)
+[![node](https://img.shields.io/badge/node-%3E%3D22-3b82f6)](https://nodejs.org)
+[![codecov](https://codecov.io/gh/sebastian-software/offcourse/graph/badge.svg)](https://codecov.io/gh/sebastian-software/offcourse)
+[![CI](https://github.com/sebastian-software/offcourse/actions/workflows/ci.yml/badge.svg)](https://github.com/sebastian-software/offcourse/actions/workflows/ci.yml)
 
 Download online courses for offline access – of course! 📚
 
-> 🚧 **Coming Soon** – This package is currently in private development.
+Saves video content and lesson text as Markdown files, organized by module structure.
 
-## What is Offcourse?
-
-Offcourse is a CLI tool that downloads online courses for offline access. It preserves the course structure, downloads videos, and converts lesson content to clean Markdown files.
-
-## Planned Features
+## Features
 
 - 🔐 **Browser-based authentication** – Log in once, sessions are cached
 - 📚 **Course structure preservation** – Maintains module/lesson hierarchy
-- 🎬 **Video downloads** – Supports Loom, native video (Vimeo, YouTube, Wistia planned)
+- 🎬 **Video downloads** – Supports HLS streams, Loom and Vimeo
 - 📝 **Content extraction** – Converts lesson text to clean Markdown
 - ⏸️ **Resumable syncs** – Skips already downloaded content
 - ⚡ **Concurrent downloads** – Configurable parallelism
+- 🔍 **Auto-detection** – Automatically detects platform from URL
 
 ## Supported Platforms
 
-| Platform | Status |
-|----------|--------|
-| [Skool.com](https://skool.com) | ✅ Ready |
-| [LearningSuite.io](https://learningsuite.io) | 🚧 Planned |
+| Platform | Status | Notes |
+|----------|--------|-------|
+| [Skool.com](https://skool.com) | ✅ Supported | Community courses |
+| [HighLevel (GoHighLevel)](https://gohighlevel.com) | ✅ Supported | Membership portals, ClientClub |
+| [LearningSuite.io](https://learningsuite.io) | 🚧 Planned | |
+
+## Installation
+
+```bash
+npm install -g offcourse
+```
+
+Or run directly with npx:
+
+```bash
+npx offcourse <command>
+```
+
+Requires Node.js 22+.
+
+For HLS video downloads (HighLevel native videos), [ffmpeg](https://ffmpeg.org/) must be installed:
+
+```bash
+# macOS
+brew install ffmpeg
+
+# Ubuntu/Debian
+sudo apt install ffmpeg
+
+# Windows (via Chocolatey)
+choco install ffmpeg
+```
+
+## Usage
+
+### Login
+
+```bash
+# Opens browser for interactive login
+offcourse login
+
+# Force re-login
+offcourse login --force
+```
+
+### Sync a Course
+
+The `sync` command auto-detects the platform from the URL:
+
+```bash
+# Auto-detect platform and download
+offcourse sync <url>
+
+# Skip video downloads
+offcourse sync <url> --skip-videos
+
+# Skip text content
+offcourse sync <url> --skip-content
+
+# Preview without downloading
+offcourse sync <url> --dry-run
+
+# Limit to first N lessons (for testing)
+offcourse sync <url> --limit 5
+
+# Override course name (useful when auto-detection fails)
+offcourse sync <url> --course-name "My Course Name"
+
+# Prefer specific video quality
+offcourse sync <url> --quality 720p
+```
+
+### Platform-Specific Commands
+
+```bash
+# Skool courses
+offcourse sync-skool https://www.skool.com/your-community/classroom
+
+# HighLevel/GoHighLevel membership portals
+offcourse sync-highlevel https://member.example.com/courses/products/<id>
+offcourse sync-highlevel <url> --course-name "Course Name"
+```
+
+### Configuration
+
+```bash
+# Show current config
+offcourse config show
+
+# Set output directory
+offcourse config set outputDir ~/Courses
+
+# Set video quality (highest, lowest, 1080p, 720p, 480p)
+offcourse config set videoQuality 720p
+
+# Set download concurrency (1-5)
+offcourse config set concurrency 3
+
+# Run headless (no browser window)
+offcourse config set headless true
+```
+
+### Inspect (Debugging)
+
+```bash
+# Analyze page structure
+offcourse inspect <url>
+
+# Save analysis to files
+offcourse inspect <url> --output ./analysis
+
+# Include full HTML dump
+offcourse inspect <url> --full
+```
 
 ## Output Structure
 
@@ -45,13 +154,139 @@ Offcourse is a CLI tool that downloads online courses for offline access. It pre
         └── ...
 ```
 
-## Stay Updated
+## Platform Notes
 
-⭐ Star the repo to get notified when we release:
+### HighLevel (GoHighLevel)
 
-→ [github.com/sebastian-software/offcourse](https://github.com/sebastian-software/offcourse)
+HighLevel is an all-in-one marketing platform with a "Memberships" feature for hosting courses. Offcourse supports:
 
-## License
+- **Authentication**: Firebase-based login via browser
+- **Course structure**: Extracts products, categories, and posts via API
+- **Video downloads**: Native HLS videos with quality selection (requires ffmpeg)
+- **Embedded videos**: Vimeo, Loom, and other embedded players
+
+Common HighLevel portal URLs:
+- `https://member.yourdomain.com/courses/...`
+- `https://portal.yourdomain.com/courses/...`
+- `https://courses.yourdomain.com/...`
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/sebastian-software/offcourse.git
+cd offcourse
+
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Link globally (optional)
+npm link
+```
+
+### Commands
+
+```bash
+# Watch mode
+npm run dev
+
+# Run directly (without build)
+npx tsx src/cli/index.ts <command>
+
+# Lint
+npm run lint
+
+# Format
+npm run format
+
+# Type check
+npm run typecheck
+
+# Test
+npm test
+```
+
+### Git Hooks
+
+This project uses [Husky](https://typicode.github.io/husky/) for Git hooks:
+
+- **pre-commit**: Runs Prettier on staged files via lint-staged
+- **pre-push**: Runs ESLint and TypeScript type checking
+- **commit-msg**: Validates commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
+
+### Commit Convention
+
+We follow [Conventional Commits](https://www.conventionalcommits.org/). Commit messages must follow this format:
 
-MIT © [Sebastian Software GmbH](https://sebastian-software.de)
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+**Types:**
+
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, semicolons, etc.)
+- `refactor`: Code refactoring
+- `perf`: Performance improvements
+- `test`: Adding or updating tests
+- `chore`: Maintenance tasks
+- `ci`: CI/CD changes
+
+**Examples:**
+
+```bash
+git commit -m "feat: add support for Vimeo downloads"
+git commit -m "fix: handle missing video URLs gracefully"
+git commit -m "docs: update installation instructions"
+```
+
+### Releasing
+
+Releases are managed with [release-it](https://github.com/release-it/release-it). The release process:
+
+1. Runs linting, type checking, and tests
+2. Bumps version based on conventional commits
+3. Generates/updates `CHANGELOG.md`
+4. Creates a Git tag and GitHub release
+5. Publishes to npm
+
+```bash
+# Interactive release (will prompt for version bump)
+npm run release
+
+# Dry run (preview what would happen)
+npm run release -- --dry-run
+
+# Specific version bump
+npm run release -- --minor
+npm run release -- --major
+```
+
+## Acknowledgments
+
+A huge thank you to [Sindre Sorhus](https://github.com/sindresorhus) 🙏 for creating and maintaining so many excellent packages that power this project:
+
+- [`@sindresorhus/slugify`](https://github.com/sindresorhus/slugify) – Slugify a string
+- [`conf`](https://github.com/sindresorhus/conf) – Simple config handling
+- [`delay`](https://github.com/sindresorhus/delay) – Delay a promise
+- [`execa`](https://github.com/sindresorhus/execa) – Process execution for humans
+- [`ky`](https://github.com/sindresorhus/ky) – Tiny & elegant HTTP client
+- [`p-queue`](https://github.com/sindresorhus/p-queue) – Promise queue with concurrency control
+- [`p-retry`](https://github.com/sindresorhus/p-retry) – Retry a promise-returning function
+
+His commitment to high-quality, well-documented, and beautifully designed open source software is truly inspiring. If you find his work useful, consider [sponsoring him](https://github.com/sponsors/sindresorhus).
+
+## License
 
+MIT

package/dist/cli/commands/config.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Shows all current configuration values.
+ */
+export declare function configShowCommand(): void;
+/**
+ * Sets a configuration value.
+ */
+export declare function configSetCommand(key: string, value: string): void;
+/**
+ * Gets a specific configuration value.
+ */
+export declare function configGetCommand(key: string): void;
+//# sourceMappingURL=config.d.ts.map

package/dist/cli/commands/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/config.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAUxC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAiCjE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAWlD"}

package/dist/cli/commands/config.js

@@ -0,0 +1,66 @@
+import chalk from "chalk";
+import { getConfigValue, loadConfig, updateConfig } from "../../config/configManager.js";
+import { CONFIG_FILE } from "../../config/paths.js";
+import { configSchema } from "../../config/schema.js";
+/**
+ * Shows all current configuration values.
+ */
+export function configShowCommand() {
+    const config = loadConfig();
+    console.log(chalk.blue("\n⚙️  Configuration\n"));
+    console.log(chalk.gray(`   File: ${CONFIG_FILE}\n`));
+    for (const [key, value] of Object.entries(config)) {
+        console.log(`   ${chalk.cyan(key)}: ${chalk.white(String(value))}`);
+    }
+    console.log();
+}
+/**
+ * Sets a configuration value.
+ */
+export function configSetCommand(key, value) {
+    const validKeys = Object.keys(configSchema.shape);
+    if (!validKeys.includes(key)) {
+        console.log(chalk.red(`\n❌ Unknown config key: ${key}`));
+        console.log(chalk.gray(`   Valid keys: ${validKeys.join(", ")}\n`));
+        process.exit(1);
+    }
+    // Parse value based on expected type
+    const currentValue = getConfigValue(key);
+    let parsedValue;
+    if (typeof currentValue === "boolean") {
+        parsedValue = value === "true" || value === "1";
+    }
+    else if (typeof currentValue === "number") {
+        parsedValue = parseInt(value, 10);
+        if (isNaN(parsedValue)) {
+            console.log(chalk.red(`\n❌ Invalid number: ${value}\n`));
+            process.exit(1);
+        }
+    }
+    else {
+        parsedValue = value;
+    }
+    try {
+        updateConfig({ [key]: parsedValue });
+        console.log(chalk.green(`\n✅ Set ${key} = ${parsedValue}\n`));
+    }
+    catch (error) {
+        console.log(chalk.red(`\n❌ Invalid value for ${key}: ${value}`));
+        console.log(chalk.gray(`   ${String(error)}\n`));
+        process.exit(1);
+    }
+}
+/**
+ * Gets a specific configuration value.
+ */
+export function configGetCommand(key) {
+    const validKeys = Object.keys(configSchema.shape);
+    if (!validKeys.includes(key)) {
+        console.log(chalk.red(`\n❌ Unknown config key: ${key}`));
+        console.log(chalk.gray(`   Valid keys: ${validKeys.join(", ")}\n`));
+        process.exit(1);
+    }
+    const value = getConfigValue(key);
+    console.log(String(value));
+}
+//# sourceMappingURL=config.js.map

package/dist/cli/commands/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/cli/commands/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD;;GAEG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC;IAE5B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;IACjD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,WAAW,IAAI,CAAC,CAAC,CAAC;IAErD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,CAAC,GAAG,EAAE,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,KAAa;IACzD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAqB,CAAC;IAEtE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAmB,CAAC,EAAE,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC,CAAC;QACzD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,qCAAqC;IACrC,MAAM,YAAY,GAAG,cAAc,CAAC,GAAmB,CAAC,CAAC;IACzD,IAAI,WAAsC,CAAC;IAE3C,IAAI,OAAO,YAAY,KAAK,SAAS,EAAE,CAAC;QACtC,WAAW,GAAG,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,GAAG,CAAC;IAClD,CAAC;SAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC5C,WAAW,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,uBAAuB,KAAK,IAAI,CAAC,CAAC,CAAC;YACzD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,WAAW,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,CAAC;QACH,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,GAAG,MAAM,WAAW,IAAI,CAAC,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;QACjE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAqB,CAAC;IAEtE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAmB,CAAC,EAAE,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC,CAAC;QACzD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,KAAK,GAAG,cAAc,CAAC,GAAmB,CAAC,CAAC;IAClD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7B,CAAC"}

package/dist/cli/commands/inspect.d.ts

@@ -0,0 +1,11 @@
+interface InspectOptions {
+    output?: string;
+    full?: boolean;
+    click?: boolean;
+}
+/**
+ * Inspects the page structure and logs useful debugging info.
+ */
+export declare function inspectCommand(url: string, options: InspectOptions): Promise<void>;
+export {};
+//# sourceMappingURL=inspect.d.ts.map

package/dist/cli/commands/inspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspect.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/inspect.ts"],"names":[],"mappings":"AAWA,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAoaxF"}