227 |
`
230 | : '';
231 |
232 | const stylizedTypes = manifest.types.map(
233 | (t) => t[0].toUpperCase() + t.slice(1) + (t !== 'series' ? 's' : '')
234 | );
235 |
236 | return `
237 |
238 |
239 |
240 |
241 |
242 | Contact ${manifest.name} addon creator:
228 | ${manifest.contactEmail} 229 |
252 |
285 |
288 |
289 |
290 |
291 | `;
292 | }
293 |
294 | module.exports = landing;
295 |
--------------------------------------------------------------------------------
/middlewares/sendMappedSubs.js:
--------------------------------------------------------------------------------
1 | const config = require('config');
2 |
3 | const SERVER_HOSTNAME = config.get('hostname');
4 | const SRT_ROUTE = config.get('srtUnzipperRoute');
5 | const PORT = config.get('port');
6 | const IS_PRODUCTION = config.get('isProduction');
7 |
8 | const getSubUrl = (subID) =>
9 | `${SERVER_HOSTNAME}${IS_PRODUCTION ? '' : `:${PORT}`}${SRT_ROUTE}${subID}.srt`;
10 |
11 | /**
12 | * Builds an array of subtitle object: https://github.com/Stremio/stremio-addon-sdk/blob/master/docs/api/responses/subtitles.md
13 | * Since version 2.2.3 I've added id to each sub.
14 | */
15 | const mapToStremioSubs = (req, res) => {
16 | const subtitles = req?.subs?.map?.((sub) => ({
17 | url: getSubUrl(sub.id),
18 | lang: 'heb',
19 | id: `[WIZDOM]${sub.versioname}`,
20 | }));
21 |
22 | res.json({ subtitles: subtitles || [] });
23 | };
24 |
25 | module.exports = mapToStremioSubs;
26 |
--------------------------------------------------------------------------------
/middlewares/sendSrt.js:
--------------------------------------------------------------------------------
1 | const { downloadSubZip } = require('../client/wizdom');
2 | const unzipper = require('unzipper');
3 | const logger = require('../common/logger');
4 |
5 | function sendSrt(req, res, next) {
6 | const srtId = req.params?.id;
7 |
8 | if (!srtId) {
9 | return res.status(400).json({ error: 'Invalid srt ID' });
10 | }
11 |
12 | res.setHeader('Content-Type', 'application/octet-stream; charset=utf-8');
13 |
14 | const unzippedSrt = downloadSubZip(srtId).pipe(unzipper.ParseOne());
15 |
16 | unzippedSrt.on('error', (err) => {
17 | logger.error(err.message, {
18 | ktuvitTitleID: srtId,
19 | description: 'Error downloading SRT file.',
20 | });
21 | next(err);
22 | });
23 |
24 | unzippedSrt.pipe(res);
25 | }
26 |
27 | module.exports = sendSrt;
28 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "wizdom-stremio-express",
3 | "version": "2.6.2",
4 | "description": "Stremio addon for Hebrew subtitles from wizdom.xyz using express this time",
5 | "main": "index.js",
6 | "scripts": {
7 | "start": "node index.js",
8 | "devStart": "nodemon index.js",
9 | "lint": "eslint .",
10 | "fix": "npm run lint -- --fix",
11 | "test": "mocha ./test/**/*.spec.js"
12 | },
13 | "keywords": [
14 | "stremio",
15 | "wizdom"
16 | ],
17 | "author": "Maor Development",
18 | "license": "GPL-3.0",
19 | "dependencies": {
20 | "config": "^3.3.12",
21 | "cors": "^2.8.5",
22 | "express": "^4.21.2",
23 | "fastest-levenshtein": "^1.0.12",
24 | "superagent": "^9.0.2",
25 | "unzipper": "^0.10.11",
26 | "winston": "^3.13.0"
27 | },
28 | "devDependencies": {
29 | "@types/mocha": "^10.0.6",
30 | "cross-env": "^7.0.3",
31 | "eslint": "^8.57.0",
32 | "eslint-config-prettier": "^9.1.0",
33 | "eslint-plugin-import": "^2.29.1",
34 | "eslint-plugin-prettier": "^5.1.3",
35 | "eslint-plugin-unicorn": "^53.0.0",
36 | "mocha": "^10.4.0",
37 | "nock": "^13.5.4",
38 | "nodemon": "^2.0.16",
39 | "prettier": "^3.2.5",
40 | "supertest": "^7.0.0"
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/server.js:
--------------------------------------------------------------------------------
1 | const express = require('express');
2 | const cors = require('cors');
3 | const landing = require('./middlewares/landingTemplate');
4 | const extractTitle = require('./middlewares/extractTitle');
5 | const manifest = require('./data/manifest');
6 | const mapToStremioSubs = require('./middlewares/sendMappedSubs');
7 | const getWizdomSubs = require('./middlewares/getWizdomSubs');
8 | const errorHandler = require('./middlewares/errorMiddleware');
9 | const sendSrt = require('./middlewares/sendSrt');
10 |
11 | const addon = express();
12 | addon.use(cors());
13 |
14 | //Landing page request.
15 | addon.get('/', landing);
16 |
17 | //manifest request.
18 | addon.get('/manifest.json', function (req, res) {
19 | res.send(manifest);
20 | });
21 |
22 | //Addon's readme request
23 | addon.get('/README.md', (req, res) => {
24 | res.sendFile(`${__dirname}/README.md`);
25 | });
26 |
27 | //Subtitles request.
28 | addon.get('/subtitles/:type/:imdbId/:query?.json', [
29 | extractTitle,
30 | getWizdomSubs,
31 | mapToStremioSubs,
32 | ]);
33 |
34 | /**
35 | * unzips Wizdom zip files and send the srt file in it.
36 | */
37 | addon.get('/srt/:id.srt', sendSrt);
38 |
39 | addon.use(errorHandler);
40 |
41 | module.exports = addon;
42 |
--------------------------------------------------------------------------------
/test/e2e/data/manifest.mock.js:
--------------------------------------------------------------------------------
1 | const version = require('../../../package.json').version;
2 |
3 | module.exports = {
4 | id: 'xyz.stremio.wizdom',
5 | contactEmail: 'maor@magori.online',
6 | catalogs: [],
7 | resources: ['subtitles'],
8 | types: ['movie', 'series'],
9 | name: 'Wizdom Subtitles',
10 | description:
11 | 'An unofficial Stremio addon for Hebrew subtitles from wizdom.xyz. Developed by Maor Development',
12 | logo: 'https://i.ibb.co/KLYK0TH/wizdon256.png',
13 | version: version,
14 | };
15 |
--------------------------------------------------------------------------------
/test/e2e/data/mocksrtfile.srt:
--------------------------------------------------------------------------------
1 | 1
2 | 00:00:16,498 --> 00:00:18,598
3 | I'm a mock srt file
4 |
5 | 2
6 | 00:00:19,098 --> 00:00:20,998
7 | I'm a mock srt file
--------------------------------------------------------------------------------
/test/e2e/data/mockzipfile.zip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/maormagori/wizdom-stremio-v2/f19f7ea5ce471bf713392ccdd40e2ace8656351b/test/e2e/data/mockzipfile.zip
--------------------------------------------------------------------------------
/test/e2e/specs/manifest.spec.js:
--------------------------------------------------------------------------------
1 | const request = require('supertest');
2 | const assert = require('assert');
3 | const manifest = require('../data/manifest.mock.js');
4 | const version = require('../../../package.json').version;
5 |
6 | describe('Manifest', () => {
7 | before(() => {
8 | process.env.npm_package_version = version;
9 | });
10 | it("should return 200 and addon's manifest", async () => {
11 | const addon = require('../../../server');
12 |
13 | const response = await request(addon)
14 | .get('/manifest.json')
15 | .expect('Content-Type', /json/)
16 | .expect(200);
17 |
18 | assert.strictEqual(typeof response.body, 'object');
19 | assert.deepEqual(response.body, manifest);
20 | });
21 | });
22 |
--------------------------------------------------------------------------------
/test/e2e/specs/srt.spec.js:
--------------------------------------------------------------------------------
1 | const request = require('supertest');
2 | const assert = require('assert');
3 | const nock = require('nock');
4 | const addon = require('../../../server');
5 | const fs = require('fs');
6 |
7 | const MOCK_SUB_ID = 66054;
8 | const srtFileBuffer = fs.readFileSync(`${__dirname}/../data/mocksrtfile.srt`);
9 |
10 | describe('GET /srt/:id.srt', () => {
11 | after(() => {
12 | nock.cleanAll();
13 | });
14 | beforeEach(() => {
15 | nock.cleanAll();
16 | });
17 |
18 | it('Should download sub zip and extract srt file from it', async () => {
19 | nock(`https://wizdom.xyz/`)
20 | .get(`/api/files/sub/${MOCK_SUB_ID}`)
21 | .replyWithFile(200, `${__dirname}/../data/mockzipfile.zip`, {
22 | 'content-type': 'application/octet-stream',
23 | });
24 |
25 | const response = await request(addon).get(`/srt/${MOCK_SUB_ID}.srt`);
26 | assert.strictEqual(response.status, 200);
27 | assert.strictEqual(
28 | response.headers['content-type'],
29 | 'application/octet-stream; charset=utf-8'
30 | );
31 | assert.strictEqual(response.body.toString(), srtFileBuffer.toString());
32 | });
33 | it('Should return 500 if error downloading srt file', async () => {
34 | nock(`https://wizdom.xyz/`).get(`/api/files/sub/${MOCK_SUB_ID}`).reply(500);
35 |
36 | const response = await request(addon).get(`/srt/${MOCK_SUB_ID}.srt`);
37 | assert.strictEqual(response.status, 500);
38 | });
39 | });
40 |
--------------------------------------------------------------------------------
/test/e2e/specs/subtitles.spec.js:
--------------------------------------------------------------------------------
1 | const request = require('supertest');
2 | const assert = require('assert');
3 | const nock = require('nock');
4 | const addon = require('../../../server');
5 |
6 | const MOCK_TITLE_ID = `tt1234567`;
7 | const MOCK_SUB_ID1 = 66054;
8 | const MOCK_SUB_NAME1 = 'sub1';
9 | const MOCK_SUB_ID2 = 66055;
10 |
11 | const mockTitle = (titleId, season, episode, response, status = 200) => {
12 | nock(`https://wizdom.xyz/`)
13 | .get(
14 | `/api/search?action=by_id&imdb=${titleId}&season=${season}&episode=${episode}`
15 | )
16 | .reply(status, response);
17 | };
18 |
19 | const createSubtitleArray = (subs) => {
20 | return subs.map((sub) => ({
21 | url: `http://127.0.0.1:7001/srt/${sub.id}.srt`,
22 | lang: 'heb',
23 | id: `[WIZDOM]${sub.versioname}`,
24 | }));
25 | };
26 |
27 | const makeRequestAndAssertResponse = async (url, expectedSubs) => {
28 | const response = await request(addon).get(url);
29 | assert.strictEqual(response.status, 200);
30 | assert.strictEqual(typeof response.body, 'object');
31 | assert.strictEqual(Array.isArray(response.body?.subtitles), true);
32 | assert.deepEqual(response.body?.subtitles, expectedSubs);
33 | };
34 |
35 | describe('GET /subtitles/:type/:imdbId/:query?.json', () => {
36 | after(() => {
37 | nock.cleanAll();
38 | });
39 | beforeEach(() => {
40 | nock.cleanAll();
41 | });
42 | it('should return movie subtitle', async () => {
43 | const subs = [
44 | {
45 | id: MOCK_SUB_ID1,
46 | versioname: MOCK_SUB_NAME1,
47 | },
48 | ];
49 | mockTitle(MOCK_TITLE_ID, undefined, undefined, subs);
50 | const expectedSubs = createSubtitleArray(subs);
51 | const testUrl = `/subtitles/movie/${MOCK_TITLE_ID}/extraArgs.json`;
52 |
53 | await makeRequestAndAssertResponse(testUrl, expectedSubs);
54 | });
55 |
56 | it('should return episode subtitle', async () => {
57 | const mockSeason = 2;
58 | const mockEpisode = 3;
59 | const subs = [
60 | {
61 | id: MOCK_SUB_ID1,
62 | versioname: MOCK_SUB_NAME1,
63 | },
64 | ];
65 | mockTitle(MOCK_TITLE_ID, mockSeason, mockEpisode, subs);
66 | const expectedSubs = createSubtitleArray(subs);
67 | const testUrl = `/subtitles/series/${MOCK_TITLE_ID}:${mockSeason}:${mockEpisode}/extraArgs.json`;
68 |
69 | await makeRequestAndAssertResponse(testUrl, expectedSubs);
70 | });
71 |
72 | it('should return sorted subtitles', async () => {
73 | const subs = [
74 | {
75 | id: MOCK_SUB_ID1,
76 | versioname: 'sub1',
77 | },
78 | {
79 | id: MOCK_SUB_ID2,
80 | versioname: 'sub2',
81 | },
82 | ];
83 | mockTitle(MOCK_TITLE_ID, undefined, undefined, subs);
84 | const expectedSubs = createSubtitleArray(subs.reverse());
85 | const testUrl = `/subtitles/movie/${MOCK_TITLE_ID}/filename=sub2.json`;
86 |
87 | await makeRequestAndAssertResponse(testUrl, expectedSubs);
88 | });
89 |
90 | it('should return empty subtitles for missing title', async () => {
91 | mockTitle(
92 | MOCK_TITLE_ID,
93 | undefined,
94 | undefined,
95 | {
96 | statusCode: 500,
97 | message: 'Internal Server Error',
98 | },
99 | 500
100 | );
101 | const testUrl = `/subtitles/movie/${MOCK_TITLE_ID}/extraArgs.json`;
102 |
103 | await makeRequestAndAssertResponse(testUrl, []);
104 | });
105 |
106 | it('should return empty subtitles for missing episode', async () => {
107 | mockTitle(MOCK_TITLE_ID, undefined, undefined, undefined);
108 | const testUrl = `/subtitles/series/${MOCK_TITLE_ID}:3:/extraArgs.json`;
109 |
110 | await makeRequestAndAssertResponse(testUrl, []);
111 | });
112 |
113 | it('should return title subtitles when no extra args were given', async () => {
114 | const subs = [
115 | {
116 | id: MOCK_SUB_ID1,
117 | versioname: MOCK_SUB_NAME1,
118 | },
119 | ];
120 | mockTitle(MOCK_TITLE_ID, undefined, undefined, subs);
121 | const expectedSubs = createSubtitleArray(subs);
122 | const testUrl = `/subtitles/movie/${MOCK_TITLE_ID}.json`;
123 |
124 | await makeRequestAndAssertResponse(testUrl, expectedSubs);
125 | });
126 | });
127 |
--------------------------------------------------------------------------------
/util/sortSubs.js:
--------------------------------------------------------------------------------
1 | const { distance } = require('fastest-levenshtein');
2 |
3 | function sortSubs(subsArr, filename) {
4 | subsArr.sort((firstSub, secondSub) => {
5 | return (
6 | distance(filename, firstSub.versioname) -
7 | distance(filename, secondSub.versioname)
8 | );
9 | });
10 | }
11 |
12 | module.exports = sortSubs;
13 |
--------------------------------------------------------------------------------
253 |
277 |
254 |
255 | 
256 |
257 |
258 | ${manifest.name}
259 |${manifest.version || '0.0.0'}
260 |${manifest.description || ''}
261 | 262 | 263 | 264 |This addon has more :
265 |-
266 | ${stylizedTypes.map((t) => `
- ${t} `).join('')} 267 |
278 |
279 |
280 | Github README.md
281 |
282 |
284 |