removed manga and fixed image links

This commit is contained in:
2026-11-17 19:10:05 -08:00
parent cd487cb189
commit aafe50e978
21 changed files with 37 additions and 402 deletions

View File

@@ -1,12 +1,12 @@
# Vyla SDK (`@vyla-entertainment/sdk`)
<p class="page-description">The official Node.js scraping and resolver library for movies, television series, embed configurations, subtitles, downloads, and manga.</p>
<p class="page-description">The official Node.js scraping and resolver library for movies, television series, embed configurations, subtitles, and downloads.</p>
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla SDK developer tools" loading="lazy" decoding="async" fetchpriority="low" />
## Overview
`@vyla-entertainment/sdk` is the core media resolver engine for Vyla. It runs in Node.js (ES Modules) to query 65+ streaming scrapers, expose dedicated vs. aggregator source lists, provide pre-configured embed player URL templates, extract subtitles, find media downloads, and browse manga archives.
`@vyla-entertainment/sdk` is the core media resolver engine for Vyla. It runs in Node.js (ES Modules) to query 65+ streaming scrapers, expose dedicated vs. aggregator source lists, provide pre-configured embed player URL templates, extract subtitles, and find media downloads.
---
@@ -29,7 +29,6 @@ npm install @vyla-entertainment/sdk
- **Embed Configuration**: Pre-mapped movie and TV embed URL templates with `ads: false` tagging in `embed_config.js` (`EMBEDS` / `EMBED_MAP`).
- **Subtitles**: Fetch `.vtt` and `.srt` subtitle tracks with `getSubtitles()`.
- **Downloads**: Find direct `.mp4` download links using `getDownloads()`.
- **Manga**: Search titles, list chapters, and fetch page images with `searchManga()`, `getManga()`, and `getMangaChapter()`.
---
@@ -67,5 +66,4 @@ console.log(`Subtitles found: ${subtitles.length}`);
- **[Quickstart](quickstart.md)** — Step-by-step tutorial for movies, TV episodes, embeds, and error handling.
- **[API Reference](reference.md)** — Complete methods, config exports, return shapes, and TypeScript types.
- **[Manga Module](manga.md)** — Manga search, chapter indexes, and page loading.
- **[Contributing Scrapers](contributing.md)** — How to write and register new source and embed scrapers.

View File

@@ -1,131 +0,0 @@
# Manga Resolution Module
<p class="page-description">How to integrate manga title discovery, chapter listings, and high-resolution page resolution using the Vyla SDK.</p>
## Overview
In addition to video streaming, `@vyla-entertainment/sdk` includes a native Manga resolution module. Powered by `atsu.moe` and leveraging `node-tls-client`, the module bypasses anti-bot TLS fingerprinting by mimicking real Google Chrome 131 cryptographic handshakes.
This allows developers to build responsive, ad-free manga reading interfaces directly into their applications.
---
## Technical Architecture
Upstream manga archives frequently block standard Node.js `fetch` or `axios` requests using JA3/JA4 TLS fingerprinting. To ensure reliable connectivity:
1. **TLS Emulation**: Uses `node-tls-client` configured with `ClientIdentifier.chrome_131`.
2. **Session Persistence**: Reuses keep-alive TLS sessions across search and chapter page requests.
3. **Structured Geometry**: Returns explicit image dimensions (`width`, `height`) and pre-calculated aspect ratios so mobile and desktop readers can prevent layout shifts during image loading.
---
## Manga Methods
### 1. Searching for Titles
Search the manga catalog by query string with pagination support:
```javascript
import VylaSDK from '@vyla-entertainment/sdk';
const sdk = new VylaSDK();
const searchResult = await sdk.searchManga('Chainsaw Man', 1, 10);
console.log(`Total results: ${searchResult.total}`);
searchResult.results.forEach((manga) => {
console.log(`[ID: ${manga.id}] ${manga.title} (${manga.status})`);
});
```
#### Search Response Structure
```json
{
"page": 1,
"total": 42,
"results": [
{
"id": "chainsaw-man",
"title": "Chainsaw Man",
"englishTitle": "Chainsaw Man",
"authors": ["Tatsuki Fujimoto"],
"type": "Manga",
"medium": "MANGA",
"status": "Ongoing",
"year": 2018,
"rating": 8.7,
"popularity": 120000,
"poster": "https://cdn.atsu.moe/static/covers/chainsaw-man.webp",
"posterSmall": "https://cdn.atsu.moe/static/covers/chainsaw-man-sm.webp",
"posterMedium": "https://cdn.atsu.moe/static/covers/chainsaw-man-md.webp"
}
]
}
```
---
### 2. Fetching Manga Details & Chapters
Retrieve full metadata, synopsis, genres, and the complete chapter index:
```javascript
const mangaDetails = await sdk.getManga('chainsaw-man');
console.log('Title:', mangaDetails.title);
console.log('Synopsis:', mangaDetails.synopsis);
console.log('Genres:', mangaDetails.genres.join(', '));
console.log('Available Chapters:', mangaDetails.chapters.length);
const latest = mangaDetails.chapters[0];
console.log(`Latest Chapter: ${latest.number} (ID: ${latest.id})`);
```
---
### 3. Resolving Chapter Pages
To render the reader view, fetch the ordered page image assets for a specific chapter:
```javascript
const mangaId = 'chainsaw-man';
const chapterId = 'chapter-1';
const chapter = await sdk.getMangaChapter(mangaId, chapterId);
console.log(`Chapter ${chapter.number} contains ${chapter.pages.length} pages.`);
chapter.pages.forEach((page) => {
console.log(`Page ${page.number}: ${page.url} [${page.width}x${page.height}]`);
});
```
#### Chapter Response Structure
```json
{
"id": "chapter-1",
"number": 1,
"title": "Dog & Chainsaw",
"scanlatorId": null,
"pages": [
{
"number": 1,
"url": "https://cdn.atsu.moe/static/data/.../01.webp",
"width": 1080,
"height": 1600,
"aspectRatio": 0.675
}
]
}
```
---
## Reader Layout Best Practices
When rendering manga pages in a frontend reader:
1. **Prevent Cumulative Layout Shift (CLS)**: Use the provided `aspectRatio` or `width`/`height` in CSS (`aspect-ratio: attr(width) / attr(height);`) to reserve vertical scroll space before each image finishes downloading.
2. **Preload Neighboring Pages**: Implement a 2-page lookahead preloader so viewers turning pages experience instantaneous transitions.
3. **Session Cleanup**: In long-running background tasks, invoke `cleanup()` from `src/manga/atsu.js` when closing reader sessions to terminate idle TLS sockets.

View File

@@ -205,5 +205,4 @@ for (const [key, status] of Object.entries(healthReport)) {
## Next Steps
- Consult the [Complete API Reference](reference.md) for exhaustive class, config, and method parameters.
- Learn how to integrate manga reading with the [Manga SDK Guide](manga.md).
- Deploy an HTTP/SSE bridge with the [Stream API Guide](../../stream-api/overview)

View File

@@ -4,7 +4,7 @@
## Class: `VylaSDK`
The primary entry point for media scraping, subtitle retrieval, downloads, and manga discovery.
The primary entry point for media scraping, subtitle retrieval, and downloads.
```typescript
import VylaSDK from '@vyla-entertainment/sdk';
@@ -143,28 +143,6 @@ Concurrently probes all active (non-disabled) sources and returns a health map k
---
### Manga Methods
#### `searchManga(query, page?, perPage?)`
```typescript
async searchManga(query: string, page?: number, perPage?: number): Promise<MangaSearchResult>
```
Queries the manga catalog via `atsu.moe` using Chrome 131 TLS fingerprinting.
#### `getManga(id)`
```typescript
async getManga(id: string): Promise<MangaDetails>
```
Retrieves full manga details, authors, genres, tags, and chapter list.
#### `getMangaChapter(mangaId, chapterId)`
```typescript
async getMangaChapter(mangaId: string, chapterId: string): Promise<MangaChapterPages>
```
Resolves ordered image URLs and dimensions for all pages in a chapter.
---
## Config & Embed Exports
### `src/config.js`
@@ -304,72 +282,4 @@ export interface ProbeResult {
}
export type ProbeAllResult = Record<string, ProbeResult>;
```
### `Interfaces: Manga`
```typescript
export interface MangaSearchItem {
id: string;
title: string;
englishTitle: string | null;
authors: string[];
type: string;
medium: string;
status: string;
year: number | null;
rating: number | null;
popularity: number | null;
poster: string | null;
posterSmall: string | null;
posterMedium: string | null;
}
export interface MangaSearchResult {
page: number;
total: number;
results: MangaSearchItem[];
}
export interface MangaChapterSummary {
id: string;
number: number;
title: string;
pageCount: number;
createdAt: string | null;
}
export interface MangaDetails {
id: string;
title: string;
englishTitle: string | null;
synopsis: string | null;
status: string;
type: string;
medium: string;
rating: number | null;
views: number | null;
authors: string[];
genres: string[];
tags: string[];
poster: string | null;
totalChapters: number;
chapters: MangaChapterSummary[];
}
export interface MangaPage {
number: number;
url: string | null;
width: number;
height: number;
aspectRatio: number;
}
export interface MangaChapterPages {
id: string;
number: number;
title: string;
scanlatorId: string | null;
pages: MangaPage[];
}
```