captions.js 0.1.0-alpha

package/README.md

@@ -0,0 +1,37 @@
+> [!WARNING]
+> 🚧 **Captions.js is nearing its first public release**  
+> The library is under active development and a full-featured version is expected around **November 2025**.
+
+💌 Want to know when Captions.js is released?
+Star or watch the repo on GitHub to get updates!
+
+# Captions.js
+
+A modern JavaScript library for adding captions to HTML5 videos with ease.
+
+[**Live Demo**](https://maskin25.github.io/captions.js/)
+
+[![Storybook](https://raw.githubusercontent.com/storybookjs/brand/refs/heads/main/badge/badge-storybook.svg)](https://main--68e681805917843931c33a87.chromatic.com/)
+
+## Features
+
+- **Easy Integration**: Simple API to add captions to your videos.
+- **Customizable Styles**: Fully customizable caption styles via configurations.
+- **Multiple Formats**: Supports various caption formats including WebVTT and SRT.
+- **Responsive Design**: Captions adapt to different screen sizes and orientations.
+
+## Installation
+
+To install Captions.js, use npm or yarn:
+
+```bash
+npm install captions.js
+```
+
+or
+
+```bash
+yarn add captions.js
+```
+
+For development see [DEVELOPMENT.md](./DEVELOPMENT.md).

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+declare function renderCaptions(ctx: CanvasRenderingContext2D, text: string): boolean;
+
+export { renderCaptions };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare function renderCaptions(ctx: CanvasRenderingContext2D, text: string): boolean;
+
+export { renderCaptions };

package/dist/index.js

@@ -0,0 +1,35 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  renderCaptions: () => renderCaptions
+});
+module.exports = __toCommonJS(index_exports);
+function renderCaptions(ctx, text) {
+  ctx.font = "48px sans-serif";
+  ctx.fillStyle = "#17c499ff";
+  ctx.fillText(text, 150, 50);
+  return true;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  renderCaptions
+});

package/dist/index.mjs

@@ -0,0 +1,10 @@
+// src/index.ts
+function renderCaptions(ctx, text) {
+  ctx.font = "48px sans-serif";
+  ctx.fillStyle = "#17c499ff";
+  ctx.fillText(text, 150, 50);
+  return true;
+}
+export {
+  renderCaptions
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "captions.js",
+  "version": "0.1.0-alpha",
+  "private": false,
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/maskin25/captions.js"
+  },
+  "description": "A cross-platform captions engine for client- and server-side video processing — ideal for AI video tools, editors, and streaming apps",
+  "keywords": [
+    "captions",
+    "subtitles",
+    "video",
+    "transcription",
+    "ffmpeg",
+    "client-side",
+    "server-side"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.6.3"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --dts --watch"
+  }
+}