mirror of
https://github.com/penpot/penpot.git
synced 2026-08-07 13:29:07 +00:00
29345fd381
Use version (1 for legacy, 2 for compact) instead of format strings
("compact" / "legacy") throughout the export pipeline. Matches the
backend pattern where version alone determines format behavior. Added
validation that rejects invalid versions with a clear error.
AI-assisted-by: deepseek-v4-pro
316 lines
9.5 KiB
JavaScript
316 lines
9.5 KiB
JavaScript
import assert from "node:assert/strict";
|
|
import test from "node:test";
|
|
import * as fs from "node:fs";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { BlobReader, ZipReader, TextWriter } from "@zip.js/zip.js";
|
|
|
|
import * as penpot from "#self";
|
|
|
|
|
|
const __filename = fileURLToPath(import.meta.url);
|
|
const __dirname = path.dirname(__filename);
|
|
|
|
test("create empty context", () => {
|
|
const context = penpot.createBuildContext();
|
|
assert.ok(context);
|
|
});
|
|
|
|
test("create context with single file", () => {
|
|
const context = penpot.createBuildContext();
|
|
context.addFile({name: "sample"});
|
|
|
|
const internalState = context.getInternalState();
|
|
|
|
// console.log(internalState);
|
|
|
|
assert.ok(internalState.files);
|
|
assert.equal(typeof internalState.files, "object");
|
|
assert.equal(typeof internalState.currentFileId, "string");
|
|
|
|
const file = internalState.files[internalState.currentFileId];
|
|
assert.ok(file);
|
|
});
|
|
|
|
test("create context with two file", () => {
|
|
const context = penpot.createBuildContext();
|
|
|
|
const fileId_1 = context.addFile({name: "sample 1"});
|
|
const fileId_2 = context.addFile({name: "sample 2"});
|
|
|
|
const internalState = context.getInternalState();
|
|
|
|
// console.log(internalState.files[fileId_1])
|
|
|
|
assert.ok(internalState.files[fileId_1]);
|
|
assert.ok(internalState.files[fileId_2]);
|
|
assert.equal(internalState.files[fileId_1].name, "sample 1");
|
|
assert.equal(internalState.files[fileId_2].name, "sample 2");
|
|
|
|
const file = internalState.files[fileId_2];
|
|
|
|
assert.ok(file.data);
|
|
assert.ok(file.data.pages);
|
|
assert.ok(file.data.pagesIndex);
|
|
assert.equal(file.data.pages.length, 0)
|
|
});
|
|
|
|
test("create context with two file and relation between", () => {
|
|
const context = penpot.createBuildContext();
|
|
|
|
const fileId_1 = context.addFile({name: "sample 1"});
|
|
const fileId_2 = context.addFile({name: "sample 2"});
|
|
|
|
context.addRelation(fileId_1, fileId_2);
|
|
|
|
const internalState = context.getInternalState();
|
|
|
|
assert.ok(internalState.files[fileId_1]);
|
|
assert.ok(internalState.files[fileId_2]);
|
|
assert.equal(internalState.files[fileId_1].name, "sample 1");
|
|
assert.equal(internalState.files[fileId_2].name, "sample 2");
|
|
|
|
assert.ok(internalState.relations[fileId_1]);
|
|
assert.equal(internalState.relations[fileId_1], fileId_2);
|
|
|
|
const file = internalState.files[fileId_2];
|
|
|
|
assert.ok(file.data);
|
|
assert.ok(file.data.pages);
|
|
assert.ok(file.data.pagesIndex);
|
|
assert.equal(file.data.pages.length, 0)
|
|
});
|
|
|
|
|
|
test("create context with file and page", () => {
|
|
const context = penpot.createBuildContext();
|
|
|
|
const fileId = context.addFile({name: "file 1"});
|
|
const pageId = context.addPage({name: "page 1"});
|
|
|
|
const internalState = context.getInternalState();
|
|
|
|
const file = internalState.files[fileId];
|
|
|
|
assert.ok(file, "file should exist");
|
|
|
|
assert.ok(file.data);
|
|
assert.ok(file.data.pages);
|
|
|
|
assert.equal(file.data.pages.length, 1);
|
|
|
|
const page = file.data.pagesIndex[pageId];
|
|
|
|
assert.ok(page, "page should exist");
|
|
assert.ok(page.objects, "page objects should exist");
|
|
assert.equal(page.id, pageId);
|
|
|
|
|
|
const rootShape = page.objects["00000000-0000-0000-0000-000000000000"];
|
|
assert.ok(rootShape, "root shape should exist");
|
|
assert.equal(rootShape.id, "00000000-0000-0000-0000-000000000000");
|
|
});
|
|
|
|
test("create context with color", () => {
|
|
const context = penpot.createBuildContext();
|
|
|
|
const fileId = context.addFile({name: "file 1"});
|
|
const pageId = context.addPage({name: "page 1"});
|
|
|
|
const colorId = context.genId();
|
|
|
|
const params = {
|
|
color: '#000000',
|
|
gradient: undefined,
|
|
id: colorId,
|
|
image: undefined,
|
|
name: 'Black-8',
|
|
opacity: 0.800000011920929,
|
|
path: 'Remote',
|
|
};
|
|
|
|
context.addLibraryColor(params);
|
|
|
|
const internalState = context.getInternalState();
|
|
|
|
const file = internalState.files[fileId];
|
|
|
|
assert.ok(file, "file should exist");
|
|
|
|
assert.ok(file.data);
|
|
assert.ok(file.data.pages);
|
|
|
|
const colors = file.data.colors
|
|
|
|
assert.ok(colors, "colors should exist");
|
|
|
|
const color = colors[colorId];
|
|
|
|
assert.ok(color, "color objects should exist");
|
|
assert.equal(color.color, params.color);
|
|
assert.equal(color.id, colorId);
|
|
assert.equal(color.path, params.path);
|
|
assert.equal(color.opacity, params.opacity);
|
|
assert.equal(color.name, params.name);
|
|
});
|
|
|
|
|
|
test("create context with tokens lib as json", () => {
|
|
const context = penpot.createBuildContext();
|
|
|
|
const fileId = context.addFile({name: "file 1"});
|
|
const pageId = context.addPage({name: "page 1"});
|
|
|
|
|
|
const tokensFilePath = path.join(__dirname, "_tokens-1.json");
|
|
const tokens = fs.readFileSync(tokensFilePath, "utf8");
|
|
|
|
context.addTokensLib(tokens);
|
|
|
|
|
|
const internalState = context.getInternalState();
|
|
const file = internalState.files[fileId];
|
|
|
|
assert.ok(file, "file should exist");
|
|
|
|
assert.ok(file.data);
|
|
assert.ok(file.data.tokensLib)
|
|
});
|
|
|
|
test("create context with tokens lib as json 2", () => {
|
|
const context = penpot.createBuildContext();
|
|
|
|
const fileId = context.addFile({name: "file 1"});
|
|
const pageId = context.addPage({name: "page 1"});
|
|
|
|
|
|
const tokensFilePath = path.join(__dirname, "_tokens-2.json");
|
|
const tokens = fs.readFileSync(tokensFilePath, "utf8");
|
|
|
|
context.addTokensLib(tokens);
|
|
|
|
const internalState = context.getInternalState();
|
|
const file = internalState.files[fileId];
|
|
|
|
assert.ok(file, "file should exist");
|
|
|
|
assert.ok(file.data);
|
|
assert.ok(file.data.tokensLib)
|
|
});
|
|
|
|
test("create context with tokens lib as obj", () => {
|
|
const context = penpot.createBuildContext();
|
|
|
|
const fileId = context.addFile({name: "file 1"});
|
|
const pageId = context.addPage({name: "page 1"});
|
|
|
|
|
|
const tokensFilePath = path.join(__dirname, "_tokens-1.json");
|
|
const tokens = fs.readFileSync(tokensFilePath, "utf8");
|
|
|
|
context.addTokensLib(JSON.parse(tokens))
|
|
|
|
|
|
const internalState = context.getInternalState();
|
|
const file = internalState.files[fileId];
|
|
|
|
assert.ok(file, "file should exist");
|
|
|
|
assert.ok(file.data);
|
|
assert.ok(file.data.tokensLib)
|
|
});
|
|
|
|
test("export compact format produces page-level objects", async () => {
|
|
const context = penpot.createBuildContext();
|
|
const fileId = context.addFile({name: "test file"});
|
|
const pageId = context.addPage({name: "test page"});
|
|
|
|
context.addRect({name: "rect1", x: 100, y: 200, width: 50, height: 30});
|
|
|
|
const blob = await penpot.exportAsBlob(context, {version: 2});
|
|
|
|
const zipReader = new ZipReader(new BlobReader(new Blob([blob])));
|
|
const entries = await zipReader.getEntries();
|
|
|
|
const manifestEntry = entries.find(e => e.filename === "manifest.json");
|
|
assert.ok(manifestEntry, "manifest should exist");
|
|
|
|
const manifest = JSON.parse(await manifestEntry.getData(new TextWriter()));
|
|
assert.equal(manifest.version, 2);
|
|
|
|
const pageEntry = entries.find(e =>
|
|
e.filename === `files/${fileId}/pages/${pageId}.json`);
|
|
assert.ok(pageEntry, "page entry should exist");
|
|
|
|
const pageData = JSON.parse(await pageEntry.getData(new TextWriter()));
|
|
assert.ok(pageData.objects, "page should contain objects");
|
|
assert.ok(Object.keys(pageData.objects).length > 0,
|
|
"objects should not be empty");
|
|
|
|
const shapeEntries = entries.filter(e =>
|
|
e.filename.startsWith(`files/${fileId}/pages/${pageId}/`) &&
|
|
e.filename !== `files/${fileId}/pages/${pageId}.json`);
|
|
assert.equal(shapeEntries.length, 0, "should not have per-shape entries");
|
|
|
|
await zipReader.close();
|
|
});
|
|
|
|
test("export legacy format produces per-shape entries", async () => {
|
|
const context = penpot.createBuildContext();
|
|
const fileId = context.addFile({name: "test file"});
|
|
const pageId = context.addPage({name: "test page"});
|
|
|
|
context.addRect({name: "rect1", x: 100, y: 200, width: 50, height: 30});
|
|
|
|
const blob = await penpot.exportAsBlob(context, {version: 1});
|
|
|
|
const zipReader = new ZipReader(new BlobReader(new Blob([blob])));
|
|
const entries = await zipReader.getEntries();
|
|
|
|
const manifestEntry = entries.find(e => e.filename === "manifest.json");
|
|
assert.ok(manifestEntry, "manifest should exist");
|
|
|
|
const manifest = JSON.parse(await manifestEntry.getData(new TextWriter()));
|
|
assert.equal(manifest.version, 1);
|
|
|
|
const pageEntry = entries.find(e =>
|
|
e.filename === `files/${fileId}/pages/${pageId}.json`);
|
|
assert.ok(pageEntry, "page entry should exist");
|
|
|
|
const pageData = JSON.parse(await pageEntry.getData(new TextWriter()));
|
|
assert.ok(!pageData.objects, "legacy page should not contain objects");
|
|
|
|
const shapeEntries = entries.filter(e =>
|
|
e.filename.startsWith(`files/${fileId}/pages/${pageId}/`) &&
|
|
e.filename !== `files/${fileId}/pages/${pageId}.json`);
|
|
assert.ok(shapeEntries.length > 0, "should have per-shape entries");
|
|
|
|
await zipReader.close();
|
|
});
|
|
|
|
test("export default format produces per-shape entries", async () => {
|
|
const context = penpot.createBuildContext();
|
|
const fileId = context.addFile({name: "test file"});
|
|
const pageId = context.addPage({name: "test page"});
|
|
|
|
context.addRect({name: "rect1", x: 100, y: 200, width: 50, height: 30});
|
|
|
|
const blob = await penpot.exportAsBlob(context);
|
|
|
|
const zipReader = new ZipReader(new BlobReader(new Blob([blob])));
|
|
const entries = await zipReader.getEntries();
|
|
|
|
const manifest = JSON.parse(
|
|
await entries.find(e => e.filename === "manifest.json")
|
|
.getData(new TextWriter()));
|
|
assert.equal(manifest.version, 1);
|
|
|
|
const shapeEntries = entries.filter(e =>
|
|
e.filename.startsWith(`files/${fileId}/pages/${pageId}/`) &&
|
|
e.filename !== `files/${fileId}/pages/${pageId}.json`);
|
|
assert.ok(shapeEntries.length > 0,
|
|
"default (legacy) should have per-shape entries");
|
|
|
|
await zipReader.close();
|
|
});
|