eprec 0.0.1 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kent C. Dodds
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,68 @@
-# eprec
+<div align="center">
+<h1>eprec</h1>
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+<p>Tools for processing Epic Web course recordings</p>
+</div>
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+---
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+<!-- prettier-ignore-start -->
+[![Build Status][build-badge]][build]
+[![version][version-badge]][package]
+[![downloads][downloads-badge]][npmtrends]
+[![MIT License][license-badge]][license]
+<!-- prettier-ignore-end -->
 
-## Purpose
+## Installation
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `eprec`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+To install dependencies:
 
-## What is OIDC Trusted Publishing?
+```bash
+bun install
+```
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+To run:
 
-## Setup Instructions
+```bash
+bun run index.ts
+```
 
-To properly configure OIDC trusted publishing for this package:
+## Whisper.cpp transcription (optional)
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+Install the local whisper.cpp CLI (Homebrew):
 
-## DO NOT USE THIS PACKAGE
+```bash
+brew install whisper-cpp
+```
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+The default small English model is downloaded on first use and cached at
+`.cache/whispercpp/ggml-small.en.bin`. Replace that file (or pass
+`--whisper-model-path`) to use a different model.
 
-## More Information
+Enable transcription with `--enable-transcription` when running
+`process-course-video.ts` to skip chapters that include "jarvis bad take" or
+"bad take jarvis". If the CLI isn't on your PATH, pass `--whisper-binary-path`
+with the full path to `whisper-cli`.
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+Customize skip phrases by repeating `--whisper-skip-phrase` (do not use
+comma-separated values because phrases may include commas).
 
----
+Manual test checklist:
+
+- Run with `--enable-transcription` and confirm whisper.cpp runs locally.
+- Verify a chapter containing the phrase is skipped and logged.
+- Verify a normal chapter still renders and writes output.
+
+This project was created using `bun init` in bun v1.3.1. [Bun](https://bun.com)
+is a fast all-in-one JavaScript runtime.
 
-**Maintained for OIDC setup purposes only**
+<!-- prettier-ignore-start -->
+[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/eprec/validate.yml?branch=main&logo=github&style=flat-square
+[build]: https://github.com/epicweb-dev/eprec/actions?query=workflow%3Avalidate
+[version-badge]: https://img.shields.io/npm/v/eprec.svg?style=flat-square
+[package]: https://www.npmjs.com/package/eprec
+[downloads-badge]: https://img.shields.io/npm/dm/eprec.svg?style=flat-square
+[npmtrends]: https://www.npmtrends.com/eprec
+[license-badge]: https://img.shields.io/npm/l/eprec.svg?style=flat-square
+[license]: https://github.com/epicweb-dev/eprec/blob/main/LICENSE
+<!-- prettier-ignore-end -->

package/cli.ts

@@ -0,0 +1,150 @@
+#!/usr/bin/env bun
+import path from 'node:path'
+import type { CommandBuilder, CommandHandler } from 'yargs'
+import yargs from 'yargs/yargs'
+import { hideBin } from 'yargs/helpers'
+import { ensureFfmpegAvailable } from './process-course/ffmpeg'
+import {
+	normalizeProcessArgs,
+	configureProcessCommand,
+} from './process-course/cli'
+import { runProcessCourse } from './process-course-video'
+import {
+	configureEditVideoCommand,
+	configureCombineVideosCommand,
+	handleCombineVideosCommand,
+	handleEditVideoCommand,
+} from './process-course/edits/cli'
+import { detectSpeechSegmentsForFile } from './speech-detection'
+import {
+	getDefaultWhisperModelPath,
+	transcribeAudio,
+} from './whispercpp-transcribe'
+
+function resolveOptionalString(value: unknown) {
+	if (typeof value !== 'string') {
+		return undefined
+	}
+	const trimmed = value.trim()
+	return trimmed.length > 0 ? trimmed : undefined
+}
+
+async function main() {
+	const parser = yargs(hideBin(process.argv))
+		.scriptName('eprec')
+		.command(
+			'process <input...>',
+			'Process chapters into separate files',
+			configureProcessCommand,
+			async (argv) => {
+				const args = normalizeProcessArgs(argv)
+				await runProcessCourse(args)
+			},
+		)
+		.command(
+			'edit',
+			'Edit a single video using transcript text edits',
+			configureEditVideoCommand as CommandBuilder,
+			handleEditVideoCommand as CommandHandler,
+		)
+		.command(
+			'combine',
+			'Combine two videos with speech-aligned padding',
+			configureCombineVideosCommand as CommandBuilder,
+			handleCombineVideosCommand as CommandHandler,
+		)
+		.command(
+			'transcribe <input>',
+			'Transcribe a single audio/video file',
+			(command) =>
+				command
+					.positional('input', {
+						type: 'string',
+						describe: 'Input audio/video file',
+					})
+					.option('model-path', {
+						type: 'string',
+						describe: 'Path to whisper.cpp model file',
+						default: getDefaultWhisperModelPath(),
+					})
+					.option('language', {
+						type: 'string',
+						describe: 'Language passed to whisper.cpp',
+						default: 'en',
+					})
+					.option('threads', {
+						type: 'number',
+						describe: 'Thread count for whisper.cpp',
+					})
+					.option('binary-path', {
+						type: 'string',
+						describe: 'Path to whisper.cpp CLI (whisper-cli)',
+					})
+					.option('output-base', {
+						type: 'string',
+						describe: 'Output base path (without extension)',
+					}),
+			async (argv) => {
+				const inputPath = path.resolve(String(argv.input))
+				const outputBasePath =
+					resolveOptionalString(argv['output-base']) ??
+					path.join(
+						path.dirname(inputPath),
+						`${path.parse(inputPath).name}-transcript`,
+					)
+				const threads =
+					typeof argv.threads === 'number' && Number.isFinite(argv.threads)
+						? argv.threads
+						: undefined
+				const result = await transcribeAudio(inputPath, {
+					modelPath: resolveOptionalString(argv['model-path']),
+					language: resolveOptionalString(argv.language),
+					threads,
+					binaryPath: resolveOptionalString(argv['binary-path']),
+					outputBasePath,
+				})
+				console.log(`Transcript written to ${outputBasePath}.txt`)
+				console.log(`Segments written to ${outputBasePath}.json`)
+				console.log(result.text)
+			},
+		)
+		.command(
+			'detect-speech <input>',
+			'Show detected speech segments for a file',
+			(command) =>
+				command
+					.positional('input', {
+						type: 'string',
+						describe: 'Input audio/video file',
+					})
+					.option('start', {
+						type: 'number',
+						describe: 'Start time in seconds',
+					})
+					.option('end', {
+						type: 'number',
+						describe: 'End time in seconds',
+					}),
+			async (argv) => {
+				await ensureFfmpegAvailable()
+				const segments = await detectSpeechSegmentsForFile({
+					inputPath: String(argv.input),
+					start: typeof argv.start === 'number' ? argv.start : undefined,
+					end: typeof argv.end === 'number' ? argv.end : undefined,
+				})
+				console.log(JSON.stringify(segments, null, 2))
+			},
+		)
+		.demandCommand(1)
+		.strict()
+		.help()
+
+	await parser.parseAsync()
+}
+
+main().catch((error) => {
+	console.error(
+		`[error] ${error instanceof Error ? error.message : String(error)}`,
+	)
+	process.exit(1)
+})

package/package.json

@@ -1,10 +1,42 @@
 {
   "name": "eprec",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for eprec",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "type": "module",
+  "version": "1.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/epicweb-dev/eprec"
+  },
+  "scripts": {
+    "format": "prettier --write .",
+    "test": "bun test process-course utils.test.ts",
+    "test:e2e": "bun test e2e",
+    "test:all": "bun test",
+    "validate": "bun run test"
+  },
+  "bin": {
+    "eprec": "./cli.ts"
+  },
+  "files": [
+    "cli.ts",
+    "process-course/**",
+    "process-course-video.ts",
+    "speech-detection.ts",
+    "utils.ts",
+    "whispercpp-transcribe.ts"
+  ],
+  "prettier": "@epic-web/config/prettier",
+  "devDependencies": {
+    "@epic-web/config": "^1.21.3",
+    "@types/bun": "latest",
+    "@types/yargs": "^17.0.35",
+    "prettier": "^3.8.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "onnxruntime-node": "^1.23.2",
+    "yargs": "^18.0.0"
+  }
 }