@xiping/subtitle 1.0.45

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present, xiping.wang
+
+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

@@ -0,0 +1,306 @@
+# Subtitle
+
+一个功能完整的字幕文件处理工具，支持SRT和WebVTT格式的解析、转换、验证和JSON导出。
+
+## 功能特点
+
+- 🚀 轻量级，零依赖
+- 📝 完整的TypeScript类型支持
+- 🔧 支持多行字幕文本
+- ✅ 格式验证功能（SRT和WebVTT）
+- 🎯 简单易用的API
+- 🔄 支持SRT和WebVTT互相转换
+- 📄 支持转换为JSON格式
+
+## 安装
+
+```bash
+npm install @xiping/subtitle
+```
+
+或者使用pnpm：
+
+```bash
+pnpm add @xiping/subtitle
+```
+
+## 使用方法
+
+### 基本用法
+
+```typescript
+import { srtToVtt } from '@xiping/subtitle';
+
+const srtContent = `1
+00:00:00,000 --> 00:00:04,000
+你好，这是第一行字幕
+
+2
+00:00:05,000 --> 00:00:09,000
+这是第二行字幕`;
+
+const webvttContent = srtToVtt(srtContent);
+console.log(webvttContent);
+```
+
+输出结果：
+```
+WEBVTT
+
+00:00:00.000 --> 00:00:04.000
+你好，这是第一行字幕
+
+00:00:05.000 --> 00:00:09.000
+这是第二行字幕
+```
+
+### 高级用法
+
+```typescript
+import { 
+  srtToVtt, 
+  parseSRT, 
+  parseVTT,
+  generateWebVTT, 
+  validateSRT,
+  validateVTT,
+  SubtitleEntry 
+} from '@xiping/subtitle';
+
+// 验证SRT格式
+const isValid = validateSRT(srtContent);
+if (!isValid) {
+  console.error('无效的SRT格式');
+  return;
+}
+
+// 解析SRT文件
+const entries: SubtitleEntry[] = parseSRT(srtContent);
+console.log('字幕条目数量:', entries.length);
+
+// 手动生成WebVTT
+const webvtt = generateWebVTT(entries);
+
+// 解析WebVTT文件
+const vttContent = `WEBVTT\n\n00:00:00.000 --> 00:00:04.000\n字幕内容`;
+const vttEntries = parseVTT(vttContent);
+
+// 验证WebVTT格式
+const isVttValid = validateVTT(vttContent);
+```
+
+### JSON转换
+
+```typescript
+import { srtToJson, vttToJson } from '@xiping/subtitle';
+
+// SRT转JSON
+const srtContent = `1
+00:00:00,000 --> 00:00:04,000
+字幕内容`;
+
+const jsonContent = srtToJson(srtContent);
+console.log(jsonContent);
+// 输出: [{"index":1,"startTime":"00:00:00,000","endTime":"00:00:04,000","text":"字幕内容"}]
+
+// WebVTT转JSON
+const vttContent = `WEBVTT
+
+00:00:00.000 --> 00:00:04.000
+字幕内容`;
+
+const vttJson = vttToJson(vttContent);
+```
+
+### 文件操作示例
+
+```typescript
+import fs from 'fs';
+import { srtToVtt, srtToJson } from '@xiping/subtitle';
+
+// 读取SRT文件
+const srtContent = fs.readFileSync('subtitle.srt', 'utf-8');
+
+// 转换为WebVTT
+const webvttContent = srtToVtt(srtContent);
+fs.writeFileSync('subtitle.vtt', webvttContent, 'utf-8');
+
+// 转换为JSON
+const jsonContent = srtToJson(srtContent);
+fs.writeFileSync('subtitle.json', jsonContent, 'utf-8');
+```
+
+## API 文档
+
+### `srtToVtt(srtContent: string): string`
+
+主转换函数，将SRT格式字幕转换为WebVTT格式。
+
+**参数:**
+- `srtContent` - SRT格式的字幕内容
+
+**返回值:**
+- WebVTT格式的字幕字符串
+
+### `parseSRT(srtContent: string): SubtitleEntry[]`
+
+解析SRT字幕文件内容。
+
+**参数:**
+- `srtContent` - SRT格式的字幕内容
+
+**返回值:**
+- 解析后的字幕条目数组
+
+### `generateWebVTT(entries: SubtitleEntry[]): string`
+
+将字幕条目数组转换为WebVTT格式字符串。
+
+**参数:**
+- `entries` - 字幕条目数组
+
+**返回值:**
+- WebVTT格式字符串
+
+### `validateSRT(srtContent: string): boolean`
+
+验证SRT文件格式是否正确。
+
+**参数:**
+- `srtContent` - SRT格式的字幕内容
+
+**返回值:**
+- 是否为有效的SRT格式
+
+### `parseVTT(vttContent: string): SubtitleEntry[]`
+
+解析WebVTT字幕文件内容。
+
+**参数:**
+- `vttContent` - WebVTT格式的字幕内容
+
+**返回值:**
+- 解析后的字幕条目数组
+
+### `validateVTT(vttContent: string): boolean`
+
+验证WebVTT文件格式是否正确。
+
+**参数:**
+- `vttContent` - WebVTT格式的字幕内容
+
+**返回值:**
+- 是否为有效的WebVTT格式
+
+### `srtToJson(srtContent: string): string`
+
+将SRT字幕转换为JSON格式字符串。
+
+**参数:**
+- `srtContent` - SRT格式的字幕内容
+
+**返回值:**
+- JSON格式字符串（格式化，缩进2空格）
+
+### `vttToJson(vttContent: string): string`
+
+将WebVTT字幕转换为JSON格式字符串。
+
+**参数:**
+- `vttContent` - WebVTT格式的字幕内容
+
+**返回值:**
+- JSON格式字符串（格式化，缩进2空格）
+
+### `convertTimeFormat(srtTime: string): string`
+
+将SRT时间格式转换为WebVTT时间格式。
+
+**参数:**
+- `srtTime` - SRT时间格式 (HH:MM:SS,mmm)
+
+**返回值:**
+- WebVTT时间格式 (HH:MM:SS.mmm)
+
+## 类型定义
+
+```typescript
+interface SubtitleEntry {
+  index: number;      // 字幕序号
+  startTime: string;  // 开始时间
+  endTime: string;    // 结束时间
+  text: string;       // 字幕文本
+}
+```
+
+## 格式说明
+
+### SRT格式示例
+```
+1
+00:00:00,000 --> 00:00:04,000
+第一行字幕
+
+2
+00:00:05,000 --> 00:00:09,000
+第二行字幕
+可以是多行文本
+```
+
+### WebVTT格式示例
+```
+WEBVTT
+
+00:00:00.000 --> 00:00:04.000
+第一行字幕
+
+00:00:05.000 --> 00:00:09.000
+第二行字幕
+可以是多行文本
+```
+
+### 主要差异
+- **文件头**: WebVTT以`WEBVTT`开头
+- **时间分隔符**: SRT使用逗号`,`，WebVTT使用点号`.`
+- **序号**: SRT包含序号，WebVTT不需要
+
+## 错误处理
+
+库会自动处理常见的格式错误：
+
+```typescript
+import { validateSRT, srtToVtt } from '@xiping/subtitle';
+
+const srtContent = "invalid content";
+
+if (!validateSRT(srtContent)) {
+  console.error('SRT格式无效');
+} else {
+  const result = srtToVtt(srtContent);
+  console.log(result);
+}
+```
+
+## 浏览器支持
+
+该库支持所有现代浏览器和Node.js环境。WebVTT格式被广泛支持：
+
+- Chrome 23+
+- Firefox 31+
+- Safari 6+
+- Edge 12+
+- iOS Safari 7+
+- Android Browser 4.4+
+
+## 贡献
+
+欢迎提交Issue和Pull Request！
+
+## 许可证
+
+MIT License
+
+## 相关链接
+
+- [WebVTT规范](https://www.w3.org/TR/webvtt1/)
+- [SRT格式说明](https://en.wikipedia.org/wiki/SubRip)

package/lib/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * subtitle
+ *
+ * SRT格式：
+ * 1
+ * 00:00:00,000 --> 00:00:04,000
+ * 字幕内容
+ *
+ * WebVTT格式：
+ * WEBVTT
+ *
+ * 00:00:00.000 --> 00:00:04.000
+ * 字幕内容
+ */
+export type { SubtitleEntry } from "./src/types.js";
+export { parseSRT, parseVTT, validateSRT, validateVTT } from "./src/parser.js";
+export { convertTimeFormat, generateWebVTT, srtToVtt, } from "./src/converter.js";
+export { srtToJson, vttToJson } from "./src/json-converter.js";
+export { srtToVtt as default } from "./src/converter.js";

package/lib/index.js

@@ -0,0 +1,22 @@
+/**
+ * subtitle
+ *
+ * SRT格式：
+ * 1
+ * 00:00:00,000 --> 00:00:04,000
+ * 字幕内容
+ *
+ * WebVTT格式：
+ * WEBVTT
+ *
+ * 00:00:00.000 --> 00:00:04.000
+ * 字幕内容
+ */
+// 解析功能
+export { parseSRT, parseVTT, validateSRT, validateVTT } from "./src/parser.js";
+// 转换功能
+export { convertTimeFormat, generateWebVTT, srtToVtt, } from "./src/converter.js";
+// JSON转换功能
+export { srtToJson, vttToJson } from "./src/json-converter.js";
+// 默认导出主函数
+export { srtToVtt as default } from "./src/converter.js";

package/lib/src/converter.d.ts

@@ -0,0 +1,19 @@
+import type { SubtitleEntry } from './types.js';
+/**
+ * 将SRT时间格式转换为WebVTT时间格式
+ * @param srtTime SRT时间格式 (HH:MM:SS,mmm)
+ * @returns WebVTT时间格式 (HH:MM:SS.mmm)
+ */
+export declare function convertTimeFormat(srtTime: string): string;
+/**
+ * 将字幕条目数组转换为WebVTT格式
+ * @param entries 字幕条目数组
+ * @returns WebVTT格式字符串
+ */
+export declare function generateWebVTT(entries: SubtitleEntry[]): string;
+/**
+ * 将SRT字幕转换为WebVTT字幕
+ * @param srtContent SRT文件内容
+ * @returns WebVTT格式字符串
+ */
+export declare function srtToVtt(srtContent: string): string;

package/lib/src/converter.js

@@ -0,0 +1,33 @@
+import { parseSRT } from './parser.js';
+/**
+ * 将SRT时间格式转换为WebVTT时间格式
+ * @param srtTime SRT时间格式 (HH:MM:SS,mmm)
+ * @returns WebVTT时间格式 (HH:MM:SS.mmm)
+ */
+export function convertTimeFormat(srtTime) {
+    return srtTime.replace(',', '.');
+}
+/**
+ * 将字幕条目数组转换为WebVTT格式
+ * @param entries 字幕条目数组
+ * @returns WebVTT格式字符串
+ */
+export function generateWebVTT(entries) {
+    let webvtt = 'WEBVTT\n\n';
+    for (const entry of entries) {
+        const startTime = convertTimeFormat(entry.startTime);
+        const endTime = convertTimeFormat(entry.endTime);
+        webvtt += `${startTime} --> ${endTime}\n`;
+        webvtt += `${entry.text}\n\n`;
+    }
+    return webvtt.trim();
+}
+/**
+ * 将SRT字幕转换为WebVTT字幕
+ * @param srtContent SRT文件内容
+ * @returns WebVTT格式字符串
+ */
+export function srtToVtt(srtContent) {
+    const entries = parseSRT(srtContent);
+    return generateWebVTT(entries);
+}

package/lib/src/json-converter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 将SRT字幕转换为JSON格式
+ * @param srtContent SRT文件内容
+ * @returns JSON格式字符串
+ */
+export declare function srtToJson(srtContent: string): string;
+/**
+ * 将WebVTT字幕转换为JSON格式
+ * @param vttContent WebVTT文件内容
+ * @returns JSON格式字符串
+ */
+export declare function vttToJson(vttContent: string): string;

package/lib/src/json-converter.js

@@ -0,0 +1,19 @@
+import { parseSRT, parseVTT } from './parser.js';
+/**
+ * 将SRT字幕转换为JSON格式
+ * @param srtContent SRT文件内容
+ * @returns JSON格式字符串
+ */
+export function srtToJson(srtContent) {
+    const entries = parseSRT(srtContent);
+    return JSON.stringify(entries, null, 2);
+}
+/**
+ * 将WebVTT字幕转换为JSON格式
+ * @param vttContent WebVTT文件内容
+ * @returns JSON格式字符串
+ */
+export function vttToJson(vttContent) {
+    const entries = parseVTT(vttContent);
+    return JSON.stringify(entries, null, 2);
+}

package/lib/src/parser.d.ts

@@ -0,0 +1,25 @@
+import type { SubtitleEntry } from './types.js';
+/**
+ * 解析SRT字幕文件内容
+ * @param srtContent SRT文件内容
+ * @returns 解析后的字幕条目数组
+ */
+export declare function parseSRT(srtContent: string): SubtitleEntry[];
+/**
+ * 解析WebVTT字幕文件内容
+ * @param vttContent WebVTT文件内容
+ * @returns 解析后的字幕条目数组
+ */
+export declare function parseVTT(vttContent: string): SubtitleEntry[];
+/**
+ * 验证SRT文件格式是否正确
+ * @param srtContent SRT文件内容
+ * @returns 是否为有效的SRT格式
+ */
+export declare function validateSRT(srtContent: string): boolean;
+/**
+ * 验证WebVTT文件格式是否正确
+ * @param vttContent WebVTT文件内容
+ * @returns 是否为有效的WebVTT格式
+ */
+export declare function validateVTT(vttContent: string): boolean;

package/lib/src/parser.js

@@ -0,0 +1,101 @@
+/**
+ * 解析SRT字幕文件内容
+ * @param srtContent SRT文件内容
+ * @returns 解析后的字幕条目数组
+ */
+export function parseSRT(srtContent) {
+    const entries = [];
+    const blocks = srtContent.trim().split(/\n\s*\n/);
+    for (const block of blocks) {
+        const lines = block.trim().split('\n');
+        if (lines.length < 3)
+            continue;
+        const index = parseInt(lines[0], 10);
+        if (isNaN(index))
+            continue;
+        const timeMatch = lines[1].match(/(\d{2}:\d{2}:\d{2},\d{3})\s*-->\s*(\d{2}:\d{2}:\d{2},\d{3})/);
+        if (!timeMatch)
+            continue;
+        const startTime = timeMatch[1];
+        const endTime = timeMatch[2];
+        const text = lines.slice(2).join('\n');
+        entries.push({
+            index,
+            startTime,
+            endTime,
+            text
+        });
+    }
+    return entries;
+}
+/**
+ * 解析WebVTT字幕文件内容
+ * @param vttContent WebVTT文件内容
+ * @returns 解析后的字幕条目数组
+ */
+export function parseVTT(vttContent) {
+    const entries = [];
+    // 移除WEBVTT头部（如果存在）
+    let content = vttContent.trim();
+    if (content.startsWith('WEBVTT')) {
+        content = content.replace(/^WEBVTT\s*\n*/, '');
+    }
+    const blocks = content.trim().split(/\n\s*\n/);
+    let index = 1;
+    for (const block of blocks) {
+        const lines = block.trim().split('\n');
+        if (lines.length < 2)
+            continue;
+        // VTT格式：第一行是时间，后面是文本
+        // 也可能有可选的序号（CUE标识符）
+        let timeLineIndex = 0;
+        // 如果第一行不是时间格式，可能是序号，跳过
+        if (!lines[0].includes('-->')) {
+            timeLineIndex = 1;
+        }
+        if (timeLineIndex >= lines.length)
+            continue;
+        const timeMatch = lines[timeLineIndex].match(/(\d{2}:\d{2}:\d{2}[.,]\d{3})\s*-->\s*(\d{2}:\d{2}:\d{2}[.,]\d{3})/);
+        if (!timeMatch)
+            continue;
+        // 统一转换为逗号格式（与SRT保持一致）
+        const startTime = timeMatch[1].replace('.', ',');
+        const endTime = timeMatch[2].replace('.', ',');
+        const text = lines.slice(timeLineIndex + 1).join('\n');
+        entries.push({
+            index: index++,
+            startTime,
+            endTime,
+            text
+        });
+    }
+    return entries;
+}
+/**
+ * 验证SRT文件格式是否正确
+ * @param srtContent SRT文件内容
+ * @returns 是否为有效的SRT格式
+ */
+export function validateSRT(srtContent) {
+    try {
+        const entries = parseSRT(srtContent);
+        return entries.length > 0;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * 验证WebVTT文件格式是否正确
+ * @param vttContent WebVTT文件内容
+ * @returns 是否为有效的WebVTT格式
+ */
+export function validateVTT(vttContent) {
+    try {
+        const entries = parseVTT(vttContent);
+        return entries.length > 0;
+    }
+    catch {
+        return false;
+    }
+}

package/lib/src/types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 字幕条目接口
+ */
+export interface SubtitleEntry {
+    index: number;
+    startTime: string;
+    endTime: string;
+    text: string;
+}

package/lib/src/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@xiping/subtitle",
+  "version": "1.0.45",
+  "description": "字幕文件处理工具，支持SRT和WebVTT格式的解析、转换和验证",
+  "type": "module",
+  "author": "The-End-Hero <527409987@qq.com>",
+  "homepage": "https://github.com/The-End-Hero/xiping#readme",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "build": "tsc"
+  },
+  "gitHead": "044508149840d2ba1b5f896ded9b3906f5866abb",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "jest": "^30.1.3",
+    "ts-jest": "^29.4.4",
+    "typescript": "^5.7.3"
+  }
+}