@aitofy/youtube 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,241 @@
+/**
+ * YouTube Tools Type Definitions
+ */
+interface YouTubeVideo {
+    /** Video ID (e.g., 'dQw4w9WgXcQ') */
+    videoId: string;
+    /** Video title */
+    title: string;
+    /** Video description (may be truncated) */
+    description?: string;
+    /** Published date in ISO 8601 format */
+    publishedAt: string;
+    /** Video duration in 'HH:MM:SS' or 'MM:SS' format */
+    duration?: string;
+    /** Duration in seconds */
+    durationSeconds?: number;
+    /** View count */
+    viewCount?: number;
+    /** Like count */
+    likeCount?: number;
+    /** Comment count */
+    commentCount?: number;
+    /** Thumbnail URLs */
+    thumbnails?: YouTubeThumbnails;
+    /** Channel ID */
+    channelId?: string;
+    /** Channel title/name */
+    channelTitle?: string;
+    /** Video URL */
+    url: string;
+}
+interface YouTubeThumbnails {
+    default?: string;
+    medium?: string;
+    high?: string;
+    standard?: string;
+    maxres?: string;
+}
+interface YouTubeChannel {
+    /** Channel ID */
+    channelId: string;
+    /** Channel name */
+    title: string;
+    /** Channel description */
+    description?: string;
+    /** Custom URL or handle (@username) */
+    customUrl?: string;
+    /** Subscriber count (may be hidden) */
+    subscriberCount?: number;
+    /** Total video count */
+    videoCount?: number;
+    /** Total view count */
+    viewCount?: number;
+    /** Channel thumbnails/avatars */
+    thumbnails?: YouTubeThumbnails;
+    /** Channel banner images */
+    banners?: YouTubeThumbnails;
+    /** Channel URL */
+    url: string;
+    /** Channel creation date */
+    publishedAt?: string;
+}
+interface TranscriptSegment {
+    /** Start time in seconds */
+    start: number;
+    /** Duration in seconds */
+    duration: number;
+    /** Text content */
+    text: string;
+    /** End time in seconds (start + duration) */
+    end?: number;
+}
+interface TranscriptOptions {
+    /** Language code (e.g., 'en', 'vi'). Auto-detect if not specified */
+    lang?: string;
+    /** Output format */
+    format?: 'json' | 'text' | 'srt' | 'vtt';
+}
+interface TranscriptInfo {
+    /** Available language codes */
+    availableLanguages: string[];
+    /** Whether auto-generated captions are available */
+    hasAutoGenerated: boolean;
+    /** Whether manual captions are available */
+    hasManual: boolean;
+}
+interface GetVideoInfoOptions {
+    /** Video ID or URL */
+    video: string;
+}
+declare class YouTubeToolsError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined);
+}
+declare const ErrorCodes: {
+    readonly CHANNEL_NOT_FOUND: "CHANNEL_NOT_FOUND";
+    readonly VIDEO_NOT_FOUND: "VIDEO_NOT_FOUND";
+    readonly TRANSCRIPT_NOT_AVAILABLE: "TRANSCRIPT_NOT_AVAILABLE";
+    readonly RATE_LIMITED: "RATE_LIMITED";
+    readonly PARSING_ERROR: "PARSING_ERROR";
+    readonly NETWORK_ERROR: "NETWORK_ERROR";
+};
+
+/**
+ * Get Channel Videos
+ *
+ * Sử dụng 2 methods:
+ * 1. RSS Feed - nhanh, stable, nhưng chỉ 15 videos
+ * 2. Scraping - lấy được nhiều hơn với pagination
+ */
+
+interface GetChannelVideosOptions {
+    /** Channel ID, URL, or handle (@username) */
+    channel: string;
+    /** Maximum videos to fetch. Default: 15 (RSS), set higher to use scraping */
+    limit?: number;
+    /** Sort by: newest, oldest, popular */
+    sortBy?: 'newest' | 'oldest' | 'popular';
+    /** Content type filter */
+    contentType?: 'videos' | 'shorts' | 'streams';
+}
+/**
+ * Get videos from a YouTube channel
+ */
+declare function getChannelVideos(options: GetChannelVideosOptions | string): Promise<YouTubeVideo[]>;
+
+/**
+ * Get Channel Info
+ */
+
+/**
+ * Get channel information
+ */
+declare function getChannelInfo(channel: string): Promise<YouTubeChannel>;
+
+/**
+ * YouTube Transcript Fetcher - Pure Node.js
+ *
+ * Port từ youtube-transcript-api (Python) sang TypeScript
+ * Sử dụng Innertube API như Python library
+ */
+
+interface TranscriptTrack {
+    languageCode: string;
+    language: string;
+    baseUrl: string;
+    isGenerated: boolean;
+    isTranslatable: boolean;
+}
+interface FetchTranscriptOptions {
+    /** Preferred language codes in order of preference */
+    languages?: string[];
+    /** If true, prefer auto-generated over manual */
+    preferGenerated?: boolean;
+}
+/**
+ * Fetch available transcript tracks for a video
+ */
+declare function listTranscripts(videoId: string): Promise<TranscriptTrack[]>;
+/**
+ * Fetch transcript segments for a video
+ */
+declare function getTranscript(videoId: string, options?: FetchTranscriptOptions): Promise<TranscriptSegment[]>;
+/**
+ * Fetch transcript and format as plain text
+ */
+declare function getTranscriptText(videoId: string, options?: FetchTranscriptOptions): Promise<string>;
+/**
+ * Fetch transcript and format as SRT
+ */
+declare function getTranscriptSRT(videoId: string, options?: FetchTranscriptOptions): Promise<string>;
+/**
+ * Fetch transcript and format as WebVTT
+ */
+declare function getTranscriptVTT(videoId: string, options?: FetchTranscriptOptions): Promise<string>;
+
+/**
+ * Get Video Info
+ *
+ * Lấy thông tin chi tiết của video từ YouTube page
+ */
+
+interface VideoInfo extends YouTubeVideo {
+    /** Video description (full) */
+    description: string;
+    /** Like count */
+    likeCount?: number;
+    /** Comment count */
+    commentCount?: number;
+    /** Video category */
+    category?: string;
+    /** Video tags */
+    tags?: string[];
+    /** Video chapters */
+    chapters?: VideoChapter[];
+    /** Is live stream */
+    isLive?: boolean;
+    /** Is upcoming premiere */
+    isUpcoming?: boolean;
+    /** Keywords */
+    keywords?: string[];
+}
+interface VideoChapter {
+    title: string;
+    startTime: number;
+    endTime?: number;
+}
+/**
+ * Get detailed video information
+ */
+declare function getVideoInfo(videoIdOrUrl: string): Promise<VideoInfo>;
+/**
+ * Get basic video info (faster, less data)
+ */
+declare function getBasicVideoInfo(videoIdOrUrl: string): Promise<YouTubeVideo>;
+
+/**
+ * Search YouTube Videos
+ */
+
+interface SearchOptions {
+    /** Search query */
+    query: string;
+    /** Maximum results */
+    limit?: number;
+    /** Sort by */
+    sortBy?: 'relevance' | 'date' | 'viewCount' | 'rating';
+    /** Filter by upload date */
+    uploadDate?: 'hour' | 'today' | 'week' | 'month' | 'year';
+    /** Filter by duration */
+    duration?: 'short' | 'medium' | 'long';
+    /** Filter by type */
+    type?: 'video' | 'channel' | 'playlist';
+}
+/**
+ * Search YouTube videos
+ */
+declare function searchVideos(queryOrOptions: string | SearchOptions): Promise<YouTubeVideo[]>;
+
+export { ErrorCodes, type FetchTranscriptOptions, type GetChannelVideosOptions, type GetVideoInfoOptions, type SearchOptions, type TranscriptInfo, type TranscriptOptions, type TranscriptSegment, type TranscriptTrack, type VideoInfo, type YouTubeChannel, type YouTubeThumbnails, YouTubeToolsError, type YouTubeVideo, getBasicVideoInfo, getChannelInfo, getChannelVideos, getTranscript, getTranscriptSRT, getTranscriptText, getTranscriptVTT, getVideoInfo, listTranscripts, searchVideos };

package/dist/index.d.ts

@@ -0,0 +1,241 @@
+/**
+ * YouTube Tools Type Definitions
+ */
+interface YouTubeVideo {
+    /** Video ID (e.g., 'dQw4w9WgXcQ') */
+    videoId: string;
+    /** Video title */
+    title: string;
+    /** Video description (may be truncated) */
+    description?: string;
+    /** Published date in ISO 8601 format */
+    publishedAt: string;
+    /** Video duration in 'HH:MM:SS' or 'MM:SS' format */
+    duration?: string;
+    /** Duration in seconds */
+    durationSeconds?: number;
+    /** View count */
+    viewCount?: number;
+    /** Like count */
+    likeCount?: number;
+    /** Comment count */
+    commentCount?: number;
+    /** Thumbnail URLs */
+    thumbnails?: YouTubeThumbnails;
+    /** Channel ID */
+    channelId?: string;
+    /** Channel title/name */
+    channelTitle?: string;
+    /** Video URL */
+    url: string;
+}
+interface YouTubeThumbnails {
+    default?: string;
+    medium?: string;
+    high?: string;
+    standard?: string;
+    maxres?: string;
+}
+interface YouTubeChannel {
+    /** Channel ID */
+    channelId: string;
+    /** Channel name */
+    title: string;
+    /** Channel description */
+    description?: string;
+    /** Custom URL or handle (@username) */
+    customUrl?: string;
+    /** Subscriber count (may be hidden) */
+    subscriberCount?: number;
+    /** Total video count */
+    videoCount?: number;
+    /** Total view count */
+    viewCount?: number;
+    /** Channel thumbnails/avatars */
+    thumbnails?: YouTubeThumbnails;
+    /** Channel banner images */
+    banners?: YouTubeThumbnails;
+    /** Channel URL */
+    url: string;
+    /** Channel creation date */
+    publishedAt?: string;
+}
+interface TranscriptSegment {
+    /** Start time in seconds */
+    start: number;
+    /** Duration in seconds */
+    duration: number;
+    /** Text content */
+    text: string;
+    /** End time in seconds (start + duration) */
+    end?: number;
+}
+interface TranscriptOptions {
+    /** Language code (e.g., 'en', 'vi'). Auto-detect if not specified */
+    lang?: string;
+    /** Output format */
+    format?: 'json' | 'text' | 'srt' | 'vtt';
+}
+interface TranscriptInfo {
+    /** Available language codes */
+    availableLanguages: string[];
+    /** Whether auto-generated captions are available */
+    hasAutoGenerated: boolean;
+    /** Whether manual captions are available */
+    hasManual: boolean;
+}
+interface GetVideoInfoOptions {
+    /** Video ID or URL */
+    video: string;
+}
+declare class YouTubeToolsError extends Error {
+    code: string;
+    statusCode?: number | undefined;
+    constructor(message: string, code: string, statusCode?: number | undefined);
+}
+declare const ErrorCodes: {
+    readonly CHANNEL_NOT_FOUND: "CHANNEL_NOT_FOUND";
+    readonly VIDEO_NOT_FOUND: "VIDEO_NOT_FOUND";
+    readonly TRANSCRIPT_NOT_AVAILABLE: "TRANSCRIPT_NOT_AVAILABLE";
+    readonly RATE_LIMITED: "RATE_LIMITED";
+    readonly PARSING_ERROR: "PARSING_ERROR";
+    readonly NETWORK_ERROR: "NETWORK_ERROR";
+};
+
+/**
+ * Get Channel Videos
+ *
+ * Sử dụng 2 methods:
+ * 1. RSS Feed - nhanh, stable, nhưng chỉ 15 videos
+ * 2. Scraping - lấy được nhiều hơn với pagination
+ */
+
+interface GetChannelVideosOptions {
+    /** Channel ID, URL, or handle (@username) */
+    channel: string;
+    /** Maximum videos to fetch. Default: 15 (RSS), set higher to use scraping */
+    limit?: number;
+    /** Sort by: newest, oldest, popular */
+    sortBy?: 'newest' | 'oldest' | 'popular';
+    /** Content type filter */
+    contentType?: 'videos' | 'shorts' | 'streams';
+}
+/**
+ * Get videos from a YouTube channel
+ */
+declare function getChannelVideos(options: GetChannelVideosOptions | string): Promise<YouTubeVideo[]>;
+
+/**
+ * Get Channel Info
+ */
+
+/**
+ * Get channel information
+ */
+declare function getChannelInfo(channel: string): Promise<YouTubeChannel>;
+
+/**
+ * YouTube Transcript Fetcher - Pure Node.js
+ *
+ * Port từ youtube-transcript-api (Python) sang TypeScript
+ * Sử dụng Innertube API như Python library
+ */
+
+interface TranscriptTrack {
+    languageCode: string;
+    language: string;
+    baseUrl: string;
+    isGenerated: boolean;
+    isTranslatable: boolean;
+}
+interface FetchTranscriptOptions {
+    /** Preferred language codes in order of preference */
+    languages?: string[];
+    /** If true, prefer auto-generated over manual */
+    preferGenerated?: boolean;
+}
+/**
+ * Fetch available transcript tracks for a video
+ */
+declare function listTranscripts(videoId: string): Promise<TranscriptTrack[]>;
+/**
+ * Fetch transcript segments for a video
+ */
+declare function getTranscript(videoId: string, options?: FetchTranscriptOptions): Promise<TranscriptSegment[]>;
+/**
+ * Fetch transcript and format as plain text
+ */
+declare function getTranscriptText(videoId: string, options?: FetchTranscriptOptions): Promise<string>;
+/**
+ * Fetch transcript and format as SRT
+ */
+declare function getTranscriptSRT(videoId: string, options?: FetchTranscriptOptions): Promise<string>;
+/**
+ * Fetch transcript and format as WebVTT
+ */
+declare function getTranscriptVTT(videoId: string, options?: FetchTranscriptOptions): Promise<string>;
+
+/**
+ * Get Video Info
+ *
+ * Lấy thông tin chi tiết của video từ YouTube page
+ */
+
+interface VideoInfo extends YouTubeVideo {
+    /** Video description (full) */
+    description: string;
+    /** Like count */
+    likeCount?: number;
+    /** Comment count */
+    commentCount?: number;
+    /** Video category */
+    category?: string;
+    /** Video tags */
+    tags?: string[];
+    /** Video chapters */
+    chapters?: VideoChapter[];
+    /** Is live stream */
+    isLive?: boolean;
+    /** Is upcoming premiere */
+    isUpcoming?: boolean;
+    /** Keywords */
+    keywords?: string[];
+}
+interface VideoChapter {
+    title: string;
+    startTime: number;
+    endTime?: number;
+}
+/**
+ * Get detailed video information
+ */
+declare function getVideoInfo(videoIdOrUrl: string): Promise<VideoInfo>;
+/**
+ * Get basic video info (faster, less data)
+ */
+declare function getBasicVideoInfo(videoIdOrUrl: string): Promise<YouTubeVideo>;
+
+/**
+ * Search YouTube Videos
+ */
+
+interface SearchOptions {
+    /** Search query */
+    query: string;
+    /** Maximum results */
+    limit?: number;
+    /** Sort by */
+    sortBy?: 'relevance' | 'date' | 'viewCount' | 'rating';
+    /** Filter by upload date */
+    uploadDate?: 'hour' | 'today' | 'week' | 'month' | 'year';
+    /** Filter by duration */
+    duration?: 'short' | 'medium' | 'long';
+    /** Filter by type */
+    type?: 'video' | 'channel' | 'playlist';
+}
+/**
+ * Search YouTube videos
+ */
+declare function searchVideos(queryOrOptions: string | SearchOptions): Promise<YouTubeVideo[]>;
+
+export { ErrorCodes, type FetchTranscriptOptions, type GetChannelVideosOptions, type GetVideoInfoOptions, type SearchOptions, type TranscriptInfo, type TranscriptOptions, type TranscriptSegment, type TranscriptTrack, type VideoInfo, type YouTubeChannel, type YouTubeThumbnails, YouTubeToolsError, type YouTubeVideo, getBasicVideoInfo, getChannelInfo, getChannelVideos, getTranscript, getTranscriptSRT, getTranscriptText, getTranscriptVTT, getVideoInfo, listTranscripts, searchVideos };