apkg-reader
Version:
a library for reading your APKG files in JavaScript
211 lines (210 loc) • 10.2 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var path_1 = __importDefault(require("path"));
var fs_1 = __importDefault(require("fs"));
var vitest_1 = require("vitest");
var ZipHandler_1 = require("../lib/handlers/ZipHandler");
var readDatabaseFrom_1 = require("../lib/readDatabaseFrom");
var MediaHandler_1 = require("../lib/handlers/MediaHandler");
function getInputFileAsZipHandler(apkg) {
return __awaiter(this, void 0, void 0, function () {
var filePath, data, zip;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
filePath = path_1.default.join(__dirname, "./artifacts/".concat(apkg));
data = fs_1.default.readFileSync(filePath);
zip = new ZipHandler_1.ZipHandler();
return [4 /*yield*/, zip.extractFilesInPlace(data)];
case 1:
_a.sent();
return [2 /*return*/, zip];
}
});
});
}
(0, vitest_1.test)("detected files", function () { return __awaiter(void 0, void 0, void 0, function () {
var zip, expected, actual;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, getInputFileAsZipHandler("HTML TEST.apkg")];
case 1:
zip = _a.sent();
expected = [
"0",
"1",
"2",
"3",
"4",
"collection.anki2",
"collection.anki21",
"media", // What is this?? is it related to images and scheduling???
];
actual = zip.fileNames;
(0, vitest_1.expect)(expected).toStrictEqual(actual);
(0, vitest_1.expect)(expected).toStrictEqual(zip.getFileNames());
return [2 /*return*/];
}
});
}); });
(0, vitest_1.test)("reading sqlite files", function (t) { return __awaiter(void 0, void 0, void 0, function () {
var zip, db, notes;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, getInputFileAsZipHandler("HTML TEST.apkg")];
case 1:
zip = _a.sent();
return [4 /*yield*/, (0, readDatabaseFrom_1.readDatabaseFrom)(zip)];
case 2:
db = _a.sent();
notes = db === null || db === void 0 ? void 0 : db.notes();
(0, vitest_1.expect)(15).toStrictEqual(db === null || db === void 0 ? void 0 : db.notes().length);
return [2 /*return*/];
}
});
}); });
(0, vitest_1.test)("get deck name", function (t) { return __awaiter(void 0, void 0, void 0, function () {
var zip, db, _a, expected, decks;
var _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, getInputFileAsZipHandler("HTML TEST.apkg")];
case 1:
zip = _c.sent();
_a = readDatabaseFrom_1.readDatabaseFrom;
return [4 /*yield*/, zip];
case 2: return [4 /*yield*/, _a.apply(void 0, [_c.sent()])];
case 3:
db = _c.sent();
expected = "Default";
decks = db === null || db === void 0 ? void 0 : db.decks();
if (decks) {
(0, vitest_1.expect)(expected).toStrictEqual((_b = decks[0]) === null || _b === void 0 ? void 0 : _b.name);
(0, vitest_1.expect)(decks[1].name).toEqual("🧦 HTML test");
}
else {
throw new Error("Did not load decks");
}
return [2 /*return*/];
}
});
}); });
(0, vitest_1.test)('get non-default deck name', function () { return __awaiter(void 0, void 0, void 0, function () {
var zipHandler, database, decks;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, getInputFileAsZipHandler("Capitals.apkg")];
case 1:
zipHandler = _b.sent();
return [4 /*yield*/, (0, readDatabaseFrom_1.readDatabaseFrom)(zipHandler)];
case 2:
database = _b.sent();
decks = database === null || database === void 0 ? void 0 : database.decks({
useZSTD: true
});
if (decks) {
(0, vitest_1.expect)((_a = decks[1]) === null || _a === void 0 ? void 0 : _a.name).toEqual('Capitals');
}
else {
throw new Error("Missing deck: Capitals");
}
return [2 /*return*/];
}
});
}); });
/**
* The way we get to the deck id is via cards.
* From the notes we can find the correct cards
* then access the deck id (did).
*/
(0, vitest_1.test)("get notes grouped by deck", function () { return __awaiter(void 0, void 0, void 0, function () {
var zip, db, _a, deck, notes, expected;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, getInputFileAsZipHandler("HTML TEST.apkg")];
case 1:
zip = _b.sent();
_a = readDatabaseFrom_1.readDatabaseFrom;
return [4 /*yield*/, zip];
case 2: return [4 /*yield*/, _a.apply(void 0, [_b.sent()])];
case 3:
db = _b.sent();
deck = db === null || db === void 0 ? void 0 : db.decks()[0];
notes = db === null || db === void 0 ? void 0 : db.notes();
expected = "Default";
// grouped && console.log(grouped?.notes[0].front);
(0, vitest_1.expect)(expected).toStrictEqual(deck === null || deck === void 0 ? void 0 : deck.name);
if (notes) {
(0, vitest_1.expect)(notes[0]).toBeTruthy();
}
else {
throw new Error('No notes found for grouped test');
}
return [2 /*return*/];
}
});
}); });
(0, vitest_1.test)("get media files", function () { return __awaiter(void 0, void 0, void 0, function () {
var zip, mediaFile, contents, media;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, getInputFileAsZipHandler("HTML TEST.apkg")];
case 1:
zip = _b.sent();
return [4 /*yield*/, zip.getMediaFile()];
case 2:
mediaFile = _b.sent();
contents = (_a = (mediaFile === null || mediaFile === void 0 ? void 0 : mediaFile.contents)) === null || _a === void 0 ? void 0 : _a.toString();
media = new MediaHandler_1.MediaHandler(contents);
(0, vitest_1.expect)(media.getFiles()).toEqual({
"0": "6607631571149c09609b248b9e353752f84d1b74.png",
"1": "d56fb9f3d4cf60abbcf66603225d80a4fe6ab4aa.png",
"2": "ffdcdfdcdeaec827d7ab7ba0d82d6c5b0ccaca41.png",
"3": "9f81241e831db14361b054623138658a9d49d751.jpg",
"4": "d951457b1d3277a1ce3ffc3e52bf55901b8997d7.jpg"
});
return [2 /*return*/];
}
});
}); });