@kubohiroya/sb3-toolchain 0.23.0 → 0.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"output-safety.js","names":[],"sources":["../src/output-safety.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {execFile} from 'node:child_process';\nimport {createHash, randomUUID} from 'node:crypto';\nimport {access, lstat, realpath, readdir, readFile, readlink, rename, rm} from 'node:fs/promises';\nimport path from 'node:path';\n\nimport {assert, errorMessage} from './assert';\n\ntype SnapshotEntry =\n | {type: 'directory'}\n | {type: 'file'; size: number; digest: string}\n | {type: 'symbolic-link'; target: string}\n | {type: 'other'};\n\nexport interface DirectoryDifferences {\n added: string[];\n modified: string[];\n removed: string[];\n}\n\nexport interface DirectoryComparison {\n candidateFingerprint: string;\n differences: DirectoryDifferences;\n existingFilePaths: string[];\n existingFingerprint: string;\n identical: boolean;\n}\n\nexport interface GitOutputState {\n clean: boolean;\n fingerprint: string;\n managed: boolean;\n repositoryRoot: string | null;\n statusEntries: string[];\n untrackedContent: string[];\n}\n\nfunction errorCode(error: unknown): string | number | undefined {\n return (error as NodeJS.ErrnoException | null)?.code;\n}\n\nexport async function pathExists(targetPath: string): Promise<boolean> {\n try {\n await access(targetPath);\n return true;\n } catch (error) {\n if (errorCode(error) === 'ENOENT') {\n return false;\n }\n throw error;\n }\n}\n\nfunction isSamePathOrAncestor(candidatePath: string, targetPath: string): boolean {\n const relativePath = path.relative(candidatePath, targetPath);\n return (\n relativePath === '' ||\n (relativePath !== '..' &&\n !relativePath.startsWith(`..${path.sep}`) &&\n !path.isAbsolute(relativePath))\n );\n}\n\nexport function validateOutputDirectoryPath(\n outputDirectory: string,\n protectedRoot: string,\n): string {\n const resolvedOutputDirectory = path.resolve(outputDirectory);\n const resolvedProtectedRoot = path.resolve(protectedRoot);\n assert(\n resolvedOutputDirectory !== path.parse(resolvedOutputDirectory).root,\n 'Refusing to replace a filesystem root with imported SB3 sources.',\n );\n assert(\n !isSamePathOrAncestor(resolvedOutputDirectory, resolvedProtectedRoot),\n 'Refusing to replace the repository root or one of its ancestors.',\n );\n assert(\n !resolvedOutputDirectory.split(path.sep).includes('.git'),\n 'Refusing to write imported SB3 sources into a .git directory.',\n );\n return resolvedOutputDirectory;\n}\n\nexport async function assertRecognizedOutputDirectory(\n outputDirectory: string,\n sourceFormatVersion: number,\n): Promise<void> {\n const stats = await lstat(outputDirectory);\n assert(\n stats.isDirectory() && !stats.isSymbolicLink(),\n `Refusing to replace a non-directory or symbolic link: ${outputDirectory}`,\n );\n\n let manifest: Record<string, unknown> | null;\n try {\n manifest = JSON.parse(await readFile(path.join(outputDirectory, 'sb3-source.json'), 'utf8'));\n } catch (error) {\n if (errorCode(error) !== 'ENOENT' && !(error instanceof SyntaxError)) {\n throw error;\n }\n throw new Error(\n `Refusing to replace an unrecognized directory without a valid sb3-source.json: ${outputDirectory}`,\n {cause: error},\n );\n }\n\n assert(\n manifest?.formatVersion === sourceFormatVersion &&\n manifest.project === 'project.source.json' &&\n manifest.embeddedExtensions === 'embedded-extensions.json' &&\n manifest.assetsDirectory === 'assets' &&\n Array.isArray(manifest.archiveEntries),\n `Refusing to replace an unrecognized directory without a valid sb3-source.json: ${outputDirectory}`,\n );\n}\n\nfunction digest(value: Uint8Array | string): string {\n return createHash('sha256').update(value).digest('hex');\n}\n\nasync function snapshotDirectory(rootDirectory: string): Promise<Map<string, SnapshotEntry>> {\n const snapshot = new Map<string, SnapshotEntry>();\n\n async function visit(directory: string, relativeDirectory: string): Promise<void> {\n const entries = await readdir(directory, {withFileTypes: true});\n entries.sort((left, right) => (left.name < right.name ? -1 : left.name > right.name ? 1 : 0));\n\n for (const entry of entries) {\n const relativePath = relativeDirectory\n ? path.posix.join(relativeDirectory, entry.name)\n : entry.name;\n const absolutePath = path.join(directory, entry.name);\n if (entry.isDirectory()) {\n snapshot.set(relativePath, {type: 'directory'});\n await visit(absolutePath, relativePath);\n } else if (entry.isFile()) {\n const contents = await readFile(absolutePath);\n snapshot.set(relativePath, {\n type: 'file',\n size: contents.length,\n digest: digest(contents),\n });\n } else if (entry.isSymbolicLink()) {\n snapshot.set(relativePath, {\n type: 'symbolic-link',\n target: await readlink(absolutePath),\n });\n } else {\n snapshot.set(relativePath, {type: 'other'});\n }\n }\n }\n\n await visit(rootDirectory, '');\n return snapshot;\n}\n\nfunction snapshotFingerprint(snapshot: Map<string, SnapshotEntry>): string {\n return digest(JSON.stringify([...snapshot.entries()]));\n}\n\nfunction entriesMatch(left: SnapshotEntry, right: SnapshotEntry): boolean {\n return JSON.stringify(left) === JSON.stringify(right);\n}\n\nexport async function compareDirectories(\n existingDirectory: string,\n candidateDirectory: string,\n): Promise<DirectoryComparison> {\n const [existingSnapshot, candidateSnapshot] = await Promise.all([\n snapshotDirectory(existingDirectory),\n snapshotDirectory(candidateDirectory),\n ]);\n const paths = [...new Set([...existingSnapshot.keys(), ...candidateSnapshot.keys()])].sort();\n const differences: DirectoryDifferences = {added: [], modified: [], removed: []};\n\n for (const relativePath of paths) {\n const existingEntry = existingSnapshot.get(relativePath);\n const candidateEntry = candidateSnapshot.get(relativePath);\n if (!existingEntry) {\n differences.added.push(relativePath);\n } else if (!candidateEntry) {\n differences.removed.push(relativePath);\n } else if (!entriesMatch(existingEntry, candidateEntry)) {\n differences.modified.push(relativePath);\n }\n }\n\n return {\n candidateFingerprint: snapshotFingerprint(candidateSnapshot),\n differences,\n existingFilePaths: [...existingSnapshot.entries()]\n .filter(([, entry]) => entry.type !== 'directory')\n .map(([relativePath]) => relativePath),\n existingFingerprint: snapshotFingerprint(existingSnapshot),\n identical: Object.values(differences).every((entries) => entries.length === 0),\n };\n}\n\nfunction executeGit(arguments_: string[], cwd: string): Promise<string> {\n return new Promise<string>((resolve, reject) => {\n execFile(\n 'git',\n arguments_,\n {cwd, encoding: 'utf8', maxBuffer: 10 * 1024 * 1024},\n (error, stdout, stderr) => {\n if (error) {\n Object.assign(error, {stdout, stderr});\n reject(error);\n return;\n }\n resolve(stdout);\n },\n );\n });\n}\n\nfunction toPosixPath(value: string): string {\n return value.split(path.sep).join('/');\n}\n\nexport async function inspectGitOutputState(\n outputDirectory: string,\n existingFilePaths: string[],\n): Promise<GitOutputState> {\n let repositoryRoot: string;\n try {\n repositoryRoot = (await executeGit(['rev-parse', '--show-toplevel'], outputDirectory)).trim();\n } catch (error) {\n if (errorCode(error) === 128) {\n return {\n clean: false,\n fingerprint: 'not-git-managed',\n managed: false,\n repositoryRoot: null,\n statusEntries: [],\n untrackedContent: [...existingFilePaths],\n };\n }\n throw error;\n }\n\n const [canonicalOutputDirectory, canonicalRepositoryRoot] = await Promise.all([\n realpath(outputDirectory),\n realpath(repositoryRoot),\n ]);\n repositoryRoot = canonicalRepositoryRoot;\n const relativeOutputDirectory = path.relative(repositoryRoot, canonicalOutputDirectory);\n assert(\n relativeOutputDirectory !== '..' &&\n !relativeOutputDirectory.startsWith(`..${path.sep}`) &&\n !path.isAbsolute(relativeOutputDirectory),\n `Output directory is outside its detected Git worktree: ${outputDirectory}`,\n );\n const pathspec = relativeOutputDirectory || '.';\n const [statusOutput, trackedOutput] = await Promise.all([\n executeGit(\n ['status', '--porcelain=v1', '--untracked-files=all', '--', pathspec],\n repositoryRoot,\n ),\n executeGit(['ls-files', '-z', '--', pathspec], repositoryRoot),\n ]);\n const statusEntries = statusOutput.split('\\n').filter(Boolean);\n const trackedPaths = new Set(\n trackedOutput\n .split('\\0')\n .filter(Boolean)\n .map((trackedPath) =>\n toPosixPath(\n path.relative(canonicalOutputDirectory, path.join(repositoryRoot, trackedPath)),\n ),\n ),\n );\n const untrackedContent = existingFilePaths.filter((filePath) => !trackedPaths.has(filePath));\n const managed = trackedPaths.size > 0;\n const clean = managed && statusEntries.length === 0 && untrackedContent.length === 0;\n const fingerprint = digest(\n JSON.stringify({\n clean,\n managed,\n repositoryRoot,\n statusEntries,\n trackedPaths: [...trackedPaths].sort(),\n untrackedContent: [...untrackedContent].sort(),\n }),\n );\n\n return {\n clean,\n fingerprint,\n managed,\n repositoryRoot,\n statusEntries,\n untrackedContent,\n };\n}\n\nexport async function assertNoInterruptedRollback(outputDirectory: string): Promise<void> {\n const parentDirectory = path.dirname(outputDirectory);\n const outputName = path.basename(outputDirectory);\n const rollbackPrefixes = [`.${outputName}.rollback-`, `.${outputName}.backup-`];\n const leftovers = (await readdir(parentDirectory))\n .filter((entryName) => rollbackPrefixes.some((prefix) => entryName.startsWith(prefix)))\n .map((entryName) => path.join(parentDirectory, entryName));\n assert(\n leftovers.length === 0,\n `Found an interrupted SB3 import rollback directory. ` +\n `Inspect or restore it before retrying: ${leftovers.join(', ')}`,\n );\n}\n\nexport async function replaceDirectoryTransactionally(\n temporaryDirectory: string,\n outputDirectory: string,\n): Promise<{rollbackCleanupWarning: string | null}> {\n const parentDirectory = path.dirname(outputDirectory);\n await assertNoInterruptedRollback(outputDirectory);\n const rollbackDirectory = path.join(\n parentDirectory,\n `.${path.basename(outputDirectory)}.rollback-${randomUUID()}`,\n );\n assert(\n !(await pathExists(rollbackDirectory)),\n `Refusing to overwrite an existing rollback directory: ${rollbackDirectory}`,\n );\n const outputExists = await pathExists(outputDirectory);\n\n if (outputExists) {\n await rename(outputDirectory, rollbackDirectory);\n }\n\n try {\n await rename(temporaryDirectory, outputDirectory);\n } catch (installError) {\n if (outputExists) {\n try {\n await rename(rollbackDirectory, outputDirectory);\n } catch (restoreError) {\n throw new AggregateError(\n [installError, restoreError],\n `SB3 import failed and automatic restoration also failed. ` +\n `Original output remains at: ${rollbackDirectory}`,\n );\n }\n }\n throw installError;\n }\n\n if (!outputExists) {\n return {rollbackCleanupWarning: null};\n }\n\n try {\n await rm(rollbackDirectory, {recursive: true});\n return {rollbackCleanupWarning: null};\n } catch (error) {\n return {\n rollbackCleanupWarning:\n `Imported output was installed, but its temporary rollback ` +\n `directory could not be removed: ${rollbackDirectory} (${errorMessage(error)})`,\n };\n }\n}\n"],"mappings":";;;;;;AAsCA,SAAS,UAAU,OAA6C;CAC9D,OAAQ,OAAwC;AAClD;AAEA,eAAsB,WAAW,YAAsC;CACrE,IAAI;EACF,MAAM,OAAO,UAAU;EACvB,OAAO;CACT,SAAS,OAAO;EACd,IAAI,UAAU,KAAK,MAAM,UACvB,OAAO;EAET,MAAM;CACR;AACF;AAEA,SAAS,qBAAqB,eAAuB,YAA6B;CAChF,MAAM,eAAe,KAAK,SAAS,eAAe,UAAU;CAC5D,OACE,iBAAiB,MAChB,iBAAiB,QAChB,CAAC,aAAa,WAAW,KAAK,KAAK,KAAK,KACxC,CAAC,KAAK,WAAW,YAAY;AAEnC;AAEA,SAAgB,4BACd,iBACA,eACQ;CACR,MAAM,0BAA0B,KAAK,QAAQ,eAAe;CAC5D,MAAM,wBAAwB,KAAK,QAAQ,aAAa;CACxD,OACE,4BAA4B,KAAK,MAAM,uBAAuB,CAAC,CAAC,MAChE,kEACF;CACA,OACE,CAAC,qBAAqB,yBAAyB,qBAAqB,GACpE,kEACF;CACA,OACE,CAAC,wBAAwB,MAAM,KAAK,GAAG,CAAC,CAAC,SAAS,MAAM,GACxD,+DACF;CACA,OAAO;AACT;AAEA,eAAsB,gCACpB,iBACA,qBACe;CACf,MAAM,QAAQ,MAAM,MAAM,eAAe;CACzC,OACE,MAAM,YAAY,KAAK,CAAC,MAAM,eAAe,GAC7C,yDAAyD,iBAC3D;CAEA,IAAI;CACJ,IAAI;EACF,WAAW,KAAK,MAAM,MAAM,SAAS,KAAK,KAAK,iBAAiB,iBAAiB,GAAG,MAAM,CAAC;CAC7F,SAAS,OAAO;EACd,IAAI,UAAU,KAAK,MAAM,YAAY,EAAE,iBAAiB,cACtD,MAAM;EAER,MAAM,IAAI,MACR,kFAAkF,mBAClF,EAAC,OAAO,MAAK,CACf;CACF;CAEA,OACE,UAAU,kBAAkB,uBAC1B,SAAS,YAAY,yBACrB,SAAS,uBAAuB,8BAChC,SAAS,oBAAoB,YAC7B,MAAM,QAAQ,SAAS,cAAc,GACvC,kFAAkF,iBACpF;AACF;AAEA,SAAS,OAAO,OAAoC;CAClD,OAAO,WAAW,QAAQ,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,KAAK;AACxD;AAEA,eAAe,kBAAkB,eAA4D;CAC3F,MAAM,2BAAW,IAAI,IAA2B;CAEhD,eAAe,MAAM,WAAmB,mBAA0C;EAChF,MAAM,UAAU,MAAM,QAAQ,WAAW,EAAC,eAAe,KAAI,CAAC;EAC9D,QAAQ,MAAM,MAAM,UAAW,KAAK,OAAO,MAAM,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,IAAI,CAAE;EAE5F,KAAK,MAAM,SAAS,SAAS;GAC3B,MAAM,eAAe,oBACjB,KAAK,MAAM,KAAK,mBAAmB,MAAM,IAAI,IAC7C,MAAM;GACV,MAAM,eAAe,KAAK,KAAK,WAAW,MAAM,IAAI;GACpD,IAAI,MAAM,YAAY,GAAG;IACvB,SAAS,IAAI,cAAc,EAAC,MAAM,YAAW,CAAC;IAC9C,MAAM,MAAM,cAAc,YAAY;GACxC,OAAO,IAAI,MAAM,OAAO,GAAG;IACzB,MAAM,WAAW,MAAM,SAAS,YAAY;IAC5C,SAAS,IAAI,cAAc;KACzB,MAAM;KACN,MAAM,SAAS;KACf,QAAQ,OAAO,QAAQ;IACzB,CAAC;GACH,OAAO,IAAI,MAAM,eAAe,GAC9B,SAAS,IAAI,cAAc;IACzB,MAAM;IACN,QAAQ,MAAM,SAAS,YAAY;GACrC,CAAC;QAED,SAAS,IAAI,cAAc,EAAC,MAAM,QAAO,CAAC;EAE9C;CACF;CAEA,MAAM,MAAM,eAAe,EAAE;CAC7B,OAAO;AACT;AAEA,SAAS,oBAAoB,UAA8C;CACzE,OAAO,OAAO,KAAK,UAAU,CAAC,GAAG,SAAS,QAAQ,CAAC,CAAC,CAAC;AACvD;AAEA,SAAS,aAAa,MAAqB,OAA+B;CACxE,OAAO,KAAK,UAAU,IAAI,MAAM,KAAK,UAAU,KAAK;AACtD;AAEA,eAAsB,mBACpB,mBACA,oBAC8B;CAC9B,MAAM,CAAC,kBAAkB,qBAAqB,MAAM,QAAQ,IAAI,CAC9D,kBAAkB,iBAAiB,GACnC,kBAAkB,kBAAkB,CACtC,CAAC;CACD,MAAM,QAAQ,CAAC,mBAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,KAAK,GAAG,GAAG,kBAAkB,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;CAC3F,MAAM,cAAoC;EAAC,OAAO,CAAC;EAAG,UAAU,CAAC;EAAG,SAAS,CAAC;CAAC;CAE/E,KAAK,MAAM,gBAAgB,OAAO;EAChC,MAAM,gBAAgB,iBAAiB,IAAI,YAAY;EACvD,MAAM,iBAAiB,kBAAkB,IAAI,YAAY;EACzD,IAAI,CAAC,eACH,YAAY,MAAM,KAAK,YAAY;OAC9B,IAAI,CAAC,gBACV,YAAY,QAAQ,KAAK,YAAY;OAChC,IAAI,CAAC,aAAa,eAAe,cAAc,GACpD,YAAY,SAAS,KAAK,YAAY;CAE1C;CAEA,OAAO;EACL,sBAAsB,oBAAoB,iBAAiB;EAC3D;EACA,mBAAmB,CAAC,GAAG,iBAAiB,QAAQ,CAAC,CAAC,CAC/C,QAAQ,GAAG,WAAW,MAAM,SAAS,WAAW,CAAC,CACjD,KAAK,CAAC,kBAAkB,YAAY;EACvC,qBAAqB,oBAAoB,gBAAgB;EACzD,WAAW,OAAO,OAAO,WAAW,CAAC,CAAC,OAAO,YAAY,QAAQ,WAAW,CAAC;CAC/E;AACF;AAEA,SAAS,WAAW,YAAsB,KAA8B;CACtE,OAAO,IAAI,SAAiB,SAAS,WAAW;EAC9C,SACE,OACA,YACA;GAAC;GAAK,UAAU;GAAQ,WAAW;EAAgB,IAClD,OAAO,QAAQ,WAAW;GACzB,IAAI,OAAO;IACT,OAAO,OAAO,OAAO;KAAC;KAAQ;IAAM,CAAC;IACrC,OAAO,KAAK;IACZ;GACF;GACA,QAAQ,MAAM;EAChB,CACF;CACF,CAAC;AACH;AAEA,SAAS,YAAY,OAAuB;CAC1C,OAAO,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG;AACvC;AAEA,eAAsB,sBACpB,iBACA,mBACyB;CACzB,IAAI;CACJ,IAAI;EACF,kBAAkB,MAAM,WAAW,CAAC,aAAa,iBAAiB,GAAG,eAAe,EAAA,CAAG,KAAK;CAC9F,SAAS,OAAO;EACd,IAAI,UAAU,KAAK,MAAM,KACvB,OAAO;GACL,OAAO;GACP,aAAa;GACb,SAAS;GACT,gBAAgB;GAChB,eAAe,CAAC;GAChB,kBAAkB,CAAC,GAAG,iBAAiB;EACzC;EAEF,MAAM;CACR;CAEA,MAAM,CAAC,0BAA0B,2BAA2B,MAAM,QAAQ,IAAI,CAC5E,SAAS,eAAe,GACxB,SAAS,cAAc,CACzB,CAAC;CACD,iBAAiB;CACjB,MAAM,0BAA0B,KAAK,SAAS,gBAAgB,wBAAwB;CACtF,OACE,4BAA4B,QAC1B,CAAC,wBAAwB,WAAW,KAAK,KAAK,KAAK,KACnD,CAAC,KAAK,WAAW,uBAAuB,GAC1C,0DAA0D,iBAC5D;CACA,MAAM,WAAW,2BAA2B;CAC5C,MAAM,CAAC,cAAc,iBAAiB,MAAM,QAAQ,IAAI,CACtD,WACE;EAAC;EAAU;EAAkB;EAAyB;EAAM;CAAQ,GACpE,cACF,GACA,WAAW;EAAC;EAAY;EAAM;EAAM;CAAQ,GAAG,cAAc,CAC/D,CAAC;CACD,MAAM,gBAAgB,aAAa,MAAM,IAAI,CAAC,CAAC,OAAO,OAAO;CAC7D,MAAM,eAAe,IAAI,IACvB,cACG,MAAM,IAAI,CAAC,CACX,OAAO,OAAO,CAAC,CACf,KAAK,gBACJ,YACE,KAAK,SAAS,0BAA0B,KAAK,KAAK,gBAAgB,WAAW,CAAC,CAChF,CACF,CACJ;CACA,MAAM,mBAAmB,kBAAkB,QAAQ,aAAa,CAAC,aAAa,IAAI,QAAQ,CAAC;CAC3F,MAAM,UAAU,aAAa,OAAO;CACpC,MAAM,QAAQ,WAAW,cAAc,WAAW,KAAK,iBAAiB,WAAW;CAYnF,OAAO;EACL;EACA,aAbkB,OAClB,KAAK,UAAU;GACb;GACA;GACA;GACA;GACA,cAAc,CAAC,GAAG,YAAY,CAAC,CAAC,KAAK;GACrC,kBAAkB,CAAC,GAAG,gBAAgB,CAAC,CAAC,KAAK;EAC/C,CAAC,CAKD;EACA;EACA;EACA;EACA;CACF;AACF;AAEA,eAAsB,4BAA4B,iBAAwC;CACxF,MAAM,kBAAkB,KAAK,QAAQ,eAAe;CACpD,MAAM,aAAa,KAAK,SAAS,eAAe;CAChD,MAAM,mBAAmB,CAAC,IAAI,WAAW,aAAa,IAAI,WAAW,SAAS;CAC9E,MAAM,aAAa,MAAM,QAAQ,eAAe,EAAA,CAC7C,QAAQ,cAAc,iBAAiB,MAAM,WAAW,UAAU,WAAW,MAAM,CAAC,CAAC,CAAC,CACtF,KAAK,cAAc,KAAK,KAAK,iBAAiB,SAAS,CAAC;CAC3D,OACE,UAAU,WAAW,GACrB,8FAC4C,UAAU,KAAK,IAAI,GACjE;AACF;AAEA,eAAsB,gCACpB,oBACA,iBACkD;CAClD,MAAM,kBAAkB,KAAK,QAAQ,eAAe;CACpD,MAAM,4BAA4B,eAAe;CACjD,MAAM,oBAAoB,KAAK,KAC7B,iBACA,IAAI,KAAK,SAAS,eAAe,EAAE,YAAY,WAAW,GAC5D;CACA,OACE,CAAE,MAAM,WAAW,iBAAiB,GACpC,yDAAyD,mBAC3D;CACA,MAAM,eAAe,MAAM,WAAW,eAAe;CAErD,IAAI,cACF,MAAM,OAAO,iBAAiB,iBAAiB;CAGjD,IAAI;EACF,MAAM,OAAO,oBAAoB,eAAe;CAClD,SAAS,cAAc;EACrB,IAAI,cACF,IAAI;GACF,MAAM,OAAO,mBAAmB,eAAe;EACjD,SAAS,cAAc;GACrB,MAAM,IAAI,eACR,CAAC,cAAc,YAAY,GAC3B,wFACiC,mBACnC;EACF;EAEF,MAAM;CACR;CAEA,IAAI,CAAC,cACH,OAAO,EAAC,wBAAwB,KAAI;CAGtC,IAAI;EACF,MAAM,GAAG,mBAAmB,EAAC,WAAW,KAAI,CAAC;EAC7C,OAAO,EAAC,wBAAwB,KAAI;CACtC,SAAS,OAAO;EACd,OAAO,EACL,wBACE,6FACmC,kBAAkB,IAAI,aAAa,KAAK,EAAE,GACjF;CACF;AACF"}
1
+ {"version":3,"file":"output-safety.js","names":[],"sources":["../src/output-safety.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {execFile} from 'node:child_process';\nimport {createHash, randomUUID} from 'node:crypto';\nimport {access, lstat, realpath, readdir, readFile, readlink, rename, rm} from 'node:fs/promises';\nimport path from 'node:path';\n\nimport {assert, errorMessage} from './assert';\n\ntype SnapshotEntry =\n | {type: 'directory'}\n | {type: 'file'; size: number; digest: string}\n | {type: 'symbolic-link'; target: string}\n | {type: 'other'};\n\nexport interface DirectoryDifferences {\n added: string[];\n modified: string[];\n removed: string[];\n}\n\nexport interface DirectoryComparison {\n candidateFingerprint: string;\n differences: DirectoryDifferences;\n existingFilePaths: string[];\n existingFingerprint: string;\n identical: boolean;\n}\n\nexport interface GitOutputState {\n clean: boolean;\n fingerprint: string;\n managed: boolean;\n repositoryRoot: string | null;\n statusEntries: string[];\n untrackedContent: string[];\n}\n\nfunction errorCode(error: unknown): string | number | undefined {\n return (error as NodeJS.ErrnoException | null)?.code;\n}\n\nexport async function pathExists(targetPath: string): Promise<boolean> {\n try {\n await access(targetPath);\n return true;\n } catch (error) {\n if (errorCode(error) === 'ENOENT') {\n return false;\n }\n throw error;\n }\n}\n\nfunction isSamePathOrAncestor(candidatePath: string, targetPath: string): boolean {\n const relativePath = path.relative(candidatePath, targetPath);\n return (\n relativePath === '' ||\n (relativePath !== '..' &&\n !relativePath.startsWith(`..${path.sep}`) &&\n !path.isAbsolute(relativePath))\n );\n}\n\nexport function validateOutputDirectoryPath(\n outputDirectory: string,\n protectedRoot: string,\n): string {\n const resolvedOutputDirectory = path.resolve(outputDirectory);\n const resolvedProtectedRoot = path.resolve(protectedRoot);\n assert(\n resolvedOutputDirectory !== path.parse(resolvedOutputDirectory).root,\n 'Refusing to replace a filesystem root with imported SB3 sources.',\n );\n assert(\n !isSamePathOrAncestor(resolvedOutputDirectory, resolvedProtectedRoot),\n 'Refusing to replace the repository root or one of its ancestors.',\n );\n assert(\n !resolvedOutputDirectory.split(path.sep).includes('.git'),\n 'Refusing to write imported SB3 sources into a .git directory.',\n );\n return resolvedOutputDirectory;\n}\n\nexport async function assertRecognizedOutputDirectory(\n outputDirectory: string,\n sourceFormatVersions: readonly number[],\n): Promise<void> {\n const stats = await lstat(outputDirectory);\n assert(\n stats.isDirectory() && !stats.isSymbolicLink(),\n `Refusing to replace a non-directory or symbolic link: ${outputDirectory}`,\n );\n\n let manifest: Record<string, unknown> | null;\n try {\n manifest = JSON.parse(await readFile(path.join(outputDirectory, 'sb3-source.json'), 'utf8'));\n } catch (error) {\n if (errorCode(error) !== 'ENOENT' && !(error instanceof SyntaxError)) {\n throw error;\n }\n throw new Error(\n `Refusing to replace an unrecognized directory without a valid sb3-source.json: ${outputDirectory}`,\n {cause: error},\n );\n }\n\n assert(\n manifest !== null &&\n sourceFormatVersions.includes(manifest.formatVersion as number) &&\n manifest.project === 'project.source.json' &&\n manifest.embeddedExtensions === 'embedded-extensions.json' &&\n manifest.assetsDirectory === 'assets' &&\n Array.isArray(manifest.archiveEntries),\n `Refusing to replace an unrecognized directory without a valid sb3-source.json: ${outputDirectory}`,\n );\n}\n\nfunction digest(value: Uint8Array | string): string {\n return createHash('sha256').update(value).digest('hex');\n}\n\nasync function snapshotDirectory(rootDirectory: string): Promise<Map<string, SnapshotEntry>> {\n const snapshot = new Map<string, SnapshotEntry>();\n\n async function visit(directory: string, relativeDirectory: string): Promise<void> {\n const entries = await readdir(directory, {withFileTypes: true});\n entries.sort((left, right) => (left.name < right.name ? -1 : left.name > right.name ? 1 : 0));\n\n for (const entry of entries) {\n const relativePath = relativeDirectory\n ? path.posix.join(relativeDirectory, entry.name)\n : entry.name;\n const absolutePath = path.join(directory, entry.name);\n if (entry.isDirectory()) {\n snapshot.set(relativePath, {type: 'directory'});\n await visit(absolutePath, relativePath);\n } else if (entry.isFile()) {\n const contents = await readFile(absolutePath);\n snapshot.set(relativePath, {\n type: 'file',\n size: contents.length,\n digest: digest(contents),\n });\n } else if (entry.isSymbolicLink()) {\n snapshot.set(relativePath, {\n type: 'symbolic-link',\n target: await readlink(absolutePath),\n });\n } else {\n snapshot.set(relativePath, {type: 'other'});\n }\n }\n }\n\n await visit(rootDirectory, '');\n return snapshot;\n}\n\nfunction snapshotFingerprint(snapshot: Map<string, SnapshotEntry>): string {\n return digest(JSON.stringify([...snapshot.entries()]));\n}\n\nfunction entriesMatch(left: SnapshotEntry, right: SnapshotEntry): boolean {\n return JSON.stringify(left) === JSON.stringify(right);\n}\n\nexport async function compareDirectories(\n existingDirectory: string,\n candidateDirectory: string,\n): Promise<DirectoryComparison> {\n const [existingSnapshot, candidateSnapshot] = await Promise.all([\n snapshotDirectory(existingDirectory),\n snapshotDirectory(candidateDirectory),\n ]);\n const paths = [...new Set([...existingSnapshot.keys(), ...candidateSnapshot.keys()])].sort();\n const differences: DirectoryDifferences = {added: [], modified: [], removed: []};\n\n for (const relativePath of paths) {\n const existingEntry = existingSnapshot.get(relativePath);\n const candidateEntry = candidateSnapshot.get(relativePath);\n if (!existingEntry) {\n differences.added.push(relativePath);\n } else if (!candidateEntry) {\n differences.removed.push(relativePath);\n } else if (!entriesMatch(existingEntry, candidateEntry)) {\n differences.modified.push(relativePath);\n }\n }\n\n return {\n candidateFingerprint: snapshotFingerprint(candidateSnapshot),\n differences,\n existingFilePaths: [...existingSnapshot.entries()]\n .filter(([, entry]) => entry.type !== 'directory')\n .map(([relativePath]) => relativePath),\n existingFingerprint: snapshotFingerprint(existingSnapshot),\n identical: Object.values(differences).every((entries) => entries.length === 0),\n };\n}\n\nfunction executeGit(arguments_: string[], cwd: string): Promise<string> {\n return new Promise<string>((resolve, reject) => {\n execFile(\n 'git',\n arguments_,\n {cwd, encoding: 'utf8', maxBuffer: 10 * 1024 * 1024},\n (error, stdout, stderr) => {\n if (error) {\n Object.assign(error, {stdout, stderr});\n reject(error);\n return;\n }\n resolve(stdout);\n },\n );\n });\n}\n\nfunction toPosixPath(value: string): string {\n return value.split(path.sep).join('/');\n}\n\nexport async function inspectGitOutputState(\n outputDirectory: string,\n existingFilePaths: string[],\n): Promise<GitOutputState> {\n let repositoryRoot: string;\n try {\n repositoryRoot = (await executeGit(['rev-parse', '--show-toplevel'], outputDirectory)).trim();\n } catch (error) {\n if (errorCode(error) === 128) {\n return {\n clean: false,\n fingerprint: 'not-git-managed',\n managed: false,\n repositoryRoot: null,\n statusEntries: [],\n untrackedContent: [...existingFilePaths],\n };\n }\n throw error;\n }\n\n const [canonicalOutputDirectory, canonicalRepositoryRoot] = await Promise.all([\n realpath(outputDirectory),\n realpath(repositoryRoot),\n ]);\n repositoryRoot = canonicalRepositoryRoot;\n const relativeOutputDirectory = path.relative(repositoryRoot, canonicalOutputDirectory);\n assert(\n relativeOutputDirectory !== '..' &&\n !relativeOutputDirectory.startsWith(`..${path.sep}`) &&\n !path.isAbsolute(relativeOutputDirectory),\n `Output directory is outside its detected Git worktree: ${outputDirectory}`,\n );\n const pathspec = relativeOutputDirectory || '.';\n const [statusOutput, trackedOutput] = await Promise.all([\n executeGit(\n ['status', '--porcelain=v1', '--untracked-files=all', '--', pathspec],\n repositoryRoot,\n ),\n executeGit(['ls-files', '-z', '--', pathspec], repositoryRoot),\n ]);\n const statusEntries = statusOutput.split('\\n').filter(Boolean);\n const trackedPaths = new Set(\n trackedOutput\n .split('\\0')\n .filter(Boolean)\n .map((trackedPath) =>\n toPosixPath(\n path.relative(canonicalOutputDirectory, path.join(repositoryRoot, trackedPath)),\n ),\n ),\n );\n const untrackedContent = existingFilePaths.filter((filePath) => !trackedPaths.has(filePath));\n const managed = trackedPaths.size > 0;\n const clean = managed && statusEntries.length === 0 && untrackedContent.length === 0;\n const fingerprint = digest(\n JSON.stringify({\n clean,\n managed,\n repositoryRoot,\n statusEntries,\n trackedPaths: [...trackedPaths].sort(),\n untrackedContent: [...untrackedContent].sort(),\n }),\n );\n\n return {\n clean,\n fingerprint,\n managed,\n repositoryRoot,\n statusEntries,\n untrackedContent,\n };\n}\n\nexport async function assertNoInterruptedRollback(outputDirectory: string): Promise<void> {\n const parentDirectory = path.dirname(outputDirectory);\n const outputName = path.basename(outputDirectory);\n const rollbackPrefixes = [`.${outputName}.rollback-`, `.${outputName}.backup-`];\n const leftovers = (await readdir(parentDirectory))\n .filter((entryName) => rollbackPrefixes.some((prefix) => entryName.startsWith(prefix)))\n .map((entryName) => path.join(parentDirectory, entryName));\n assert(\n leftovers.length === 0,\n `Found an interrupted SB3 import rollback directory. ` +\n `Inspect or restore it before retrying: ${leftovers.join(', ')}`,\n );\n}\n\nexport async function replaceDirectoryTransactionally(\n temporaryDirectory: string,\n outputDirectory: string,\n): Promise<{rollbackCleanupWarning: string | null}> {\n const parentDirectory = path.dirname(outputDirectory);\n await assertNoInterruptedRollback(outputDirectory);\n const rollbackDirectory = path.join(\n parentDirectory,\n `.${path.basename(outputDirectory)}.rollback-${randomUUID()}`,\n );\n assert(\n !(await pathExists(rollbackDirectory)),\n `Refusing to overwrite an existing rollback directory: ${rollbackDirectory}`,\n );\n const outputExists = await pathExists(outputDirectory);\n\n if (outputExists) {\n await rename(outputDirectory, rollbackDirectory);\n }\n\n try {\n await rename(temporaryDirectory, outputDirectory);\n } catch (installError) {\n if (outputExists) {\n try {\n await rename(rollbackDirectory, outputDirectory);\n } catch (restoreError) {\n throw new AggregateError(\n [installError, restoreError],\n `SB3 import failed and automatic restoration also failed. ` +\n `Original output remains at: ${rollbackDirectory}`,\n );\n }\n }\n throw installError;\n }\n\n if (!outputExists) {\n return {rollbackCleanupWarning: null};\n }\n\n try {\n await rm(rollbackDirectory, {recursive: true});\n return {rollbackCleanupWarning: null};\n } catch (error) {\n return {\n rollbackCleanupWarning:\n `Imported output was installed, but its temporary rollback ` +\n `directory could not be removed: ${rollbackDirectory} (${errorMessage(error)})`,\n };\n }\n}\n"],"mappings":";;;;;;AAsCA,SAAS,UAAU,OAA6C;CAC9D,OAAQ,OAAwC;AAClD;AAEA,eAAsB,WAAW,YAAsC;CACrE,IAAI;EACF,MAAM,OAAO,UAAU;EACvB,OAAO;CACT,SAAS,OAAO;EACd,IAAI,UAAU,KAAK,MAAM,UACvB,OAAO;EAET,MAAM;CACR;AACF;AAEA,SAAS,qBAAqB,eAAuB,YAA6B;CAChF,MAAM,eAAe,KAAK,SAAS,eAAe,UAAU;CAC5D,OACE,iBAAiB,MAChB,iBAAiB,QAChB,CAAC,aAAa,WAAW,KAAK,KAAK,KAAK,KACxC,CAAC,KAAK,WAAW,YAAY;AAEnC;AAEA,SAAgB,4BACd,iBACA,eACQ;CACR,MAAM,0BAA0B,KAAK,QAAQ,eAAe;CAC5D,MAAM,wBAAwB,KAAK,QAAQ,aAAa;CACxD,OACE,4BAA4B,KAAK,MAAM,uBAAuB,CAAC,CAAC,MAChE,kEACF;CACA,OACE,CAAC,qBAAqB,yBAAyB,qBAAqB,GACpE,kEACF;CACA,OACE,CAAC,wBAAwB,MAAM,KAAK,GAAG,CAAC,CAAC,SAAS,MAAM,GACxD,+DACF;CACA,OAAO;AACT;AAEA,eAAsB,gCACpB,iBACA,sBACe;CACf,MAAM,QAAQ,MAAM,MAAM,eAAe;CACzC,OACE,MAAM,YAAY,KAAK,CAAC,MAAM,eAAe,GAC7C,yDAAyD,iBAC3D;CAEA,IAAI;CACJ,IAAI;EACF,WAAW,KAAK,MAAM,MAAM,SAAS,KAAK,KAAK,iBAAiB,iBAAiB,GAAG,MAAM,CAAC;CAC7F,SAAS,OAAO;EACd,IAAI,UAAU,KAAK,MAAM,YAAY,EAAE,iBAAiB,cACtD,MAAM;EAER,MAAM,IAAI,MACR,kFAAkF,mBAClF,EAAC,OAAO,MAAK,CACf;CACF;CAEA,OACE,aAAa,QACX,qBAAqB,SAAS,SAAS,aAAuB,KAC9D,SAAS,YAAY,yBACrB,SAAS,uBAAuB,8BAChC,SAAS,oBAAoB,YAC7B,MAAM,QAAQ,SAAS,cAAc,GACvC,kFAAkF,iBACpF;AACF;AAEA,SAAS,OAAO,OAAoC;CAClD,OAAO,WAAW,QAAQ,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,KAAK;AACxD;AAEA,eAAe,kBAAkB,eAA4D;CAC3F,MAAM,2BAAW,IAAI,IAA2B;CAEhD,eAAe,MAAM,WAAmB,mBAA0C;EAChF,MAAM,UAAU,MAAM,QAAQ,WAAW,EAAC,eAAe,KAAI,CAAC;EAC9D,QAAQ,MAAM,MAAM,UAAW,KAAK,OAAO,MAAM,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,IAAI,CAAE;EAE5F,KAAK,MAAM,SAAS,SAAS;GAC3B,MAAM,eAAe,oBACjB,KAAK,MAAM,KAAK,mBAAmB,MAAM,IAAI,IAC7C,MAAM;GACV,MAAM,eAAe,KAAK,KAAK,WAAW,MAAM,IAAI;GACpD,IAAI,MAAM,YAAY,GAAG;IACvB,SAAS,IAAI,cAAc,EAAC,MAAM,YAAW,CAAC;IAC9C,MAAM,MAAM,cAAc,YAAY;GACxC,OAAO,IAAI,MAAM,OAAO,GAAG;IACzB,MAAM,WAAW,MAAM,SAAS,YAAY;IAC5C,SAAS,IAAI,cAAc;KACzB,MAAM;KACN,MAAM,SAAS;KACf,QAAQ,OAAO,QAAQ;IACzB,CAAC;GACH,OAAO,IAAI,MAAM,eAAe,GAC9B,SAAS,IAAI,cAAc;IACzB,MAAM;IACN,QAAQ,MAAM,SAAS,YAAY;GACrC,CAAC;QAED,SAAS,IAAI,cAAc,EAAC,MAAM,QAAO,CAAC;EAE9C;CACF;CAEA,MAAM,MAAM,eAAe,EAAE;CAC7B,OAAO;AACT;AAEA,SAAS,oBAAoB,UAA8C;CACzE,OAAO,OAAO,KAAK,UAAU,CAAC,GAAG,SAAS,QAAQ,CAAC,CAAC,CAAC;AACvD;AAEA,SAAS,aAAa,MAAqB,OAA+B;CACxE,OAAO,KAAK,UAAU,IAAI,MAAM,KAAK,UAAU,KAAK;AACtD;AAEA,eAAsB,mBACpB,mBACA,oBAC8B;CAC9B,MAAM,CAAC,kBAAkB,qBAAqB,MAAM,QAAQ,IAAI,CAC9D,kBAAkB,iBAAiB,GACnC,kBAAkB,kBAAkB,CACtC,CAAC;CACD,MAAM,QAAQ,CAAC,mBAAG,IAAI,IAAI,CAAC,GAAG,iBAAiB,KAAK,GAAG,GAAG,kBAAkB,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;CAC3F,MAAM,cAAoC;EAAC,OAAO,CAAC;EAAG,UAAU,CAAC;EAAG,SAAS,CAAC;CAAC;CAE/E,KAAK,MAAM,gBAAgB,OAAO;EAChC,MAAM,gBAAgB,iBAAiB,IAAI,YAAY;EACvD,MAAM,iBAAiB,kBAAkB,IAAI,YAAY;EACzD,IAAI,CAAC,eACH,YAAY,MAAM,KAAK,YAAY;OAC9B,IAAI,CAAC,gBACV,YAAY,QAAQ,KAAK,YAAY;OAChC,IAAI,CAAC,aAAa,eAAe,cAAc,GACpD,YAAY,SAAS,KAAK,YAAY;CAE1C;CAEA,OAAO;EACL,sBAAsB,oBAAoB,iBAAiB;EAC3D;EACA,mBAAmB,CAAC,GAAG,iBAAiB,QAAQ,CAAC,CAAC,CAC/C,QAAQ,GAAG,WAAW,MAAM,SAAS,WAAW,CAAC,CACjD,KAAK,CAAC,kBAAkB,YAAY;EACvC,qBAAqB,oBAAoB,gBAAgB;EACzD,WAAW,OAAO,OAAO,WAAW,CAAC,CAAC,OAAO,YAAY,QAAQ,WAAW,CAAC;CAC/E;AACF;AAEA,SAAS,WAAW,YAAsB,KAA8B;CACtE,OAAO,IAAI,SAAiB,SAAS,WAAW;EAC9C,SACE,OACA,YACA;GAAC;GAAK,UAAU;GAAQ,WAAW;EAAgB,IAClD,OAAO,QAAQ,WAAW;GACzB,IAAI,OAAO;IACT,OAAO,OAAO,OAAO;KAAC;KAAQ;IAAM,CAAC;IACrC,OAAO,KAAK;IACZ;GACF;GACA,QAAQ,MAAM;EAChB,CACF;CACF,CAAC;AACH;AAEA,SAAS,YAAY,OAAuB;CAC1C,OAAO,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG;AACvC;AAEA,eAAsB,sBACpB,iBACA,mBACyB;CACzB,IAAI;CACJ,IAAI;EACF,kBAAkB,MAAM,WAAW,CAAC,aAAa,iBAAiB,GAAG,eAAe,EAAA,CAAG,KAAK;CAC9F,SAAS,OAAO;EACd,IAAI,UAAU,KAAK,MAAM,KACvB,OAAO;GACL,OAAO;GACP,aAAa;GACb,SAAS;GACT,gBAAgB;GAChB,eAAe,CAAC;GAChB,kBAAkB,CAAC,GAAG,iBAAiB;EACzC;EAEF,MAAM;CACR;CAEA,MAAM,CAAC,0BAA0B,2BAA2B,MAAM,QAAQ,IAAI,CAC5E,SAAS,eAAe,GACxB,SAAS,cAAc,CACzB,CAAC;CACD,iBAAiB;CACjB,MAAM,0BAA0B,KAAK,SAAS,gBAAgB,wBAAwB;CACtF,OACE,4BAA4B,QAC1B,CAAC,wBAAwB,WAAW,KAAK,KAAK,KAAK,KACnD,CAAC,KAAK,WAAW,uBAAuB,GAC1C,0DAA0D,iBAC5D;CACA,MAAM,WAAW,2BAA2B;CAC5C,MAAM,CAAC,cAAc,iBAAiB,MAAM,QAAQ,IAAI,CACtD,WACE;EAAC;EAAU;EAAkB;EAAyB;EAAM;CAAQ,GACpE,cACF,GACA,WAAW;EAAC;EAAY;EAAM;EAAM;CAAQ,GAAG,cAAc,CAC/D,CAAC;CACD,MAAM,gBAAgB,aAAa,MAAM,IAAI,CAAC,CAAC,OAAO,OAAO;CAC7D,MAAM,eAAe,IAAI,IACvB,cACG,MAAM,IAAI,CAAC,CACX,OAAO,OAAO,CAAC,CACf,KAAK,gBACJ,YACE,KAAK,SAAS,0BAA0B,KAAK,KAAK,gBAAgB,WAAW,CAAC,CAChF,CACF,CACJ;CACA,MAAM,mBAAmB,kBAAkB,QAAQ,aAAa,CAAC,aAAa,IAAI,QAAQ,CAAC;CAC3F,MAAM,UAAU,aAAa,OAAO;CACpC,MAAM,QAAQ,WAAW,cAAc,WAAW,KAAK,iBAAiB,WAAW;CAYnF,OAAO;EACL;EACA,aAbkB,OAClB,KAAK,UAAU;GACb;GACA;GACA;GACA;GACA,cAAc,CAAC,GAAG,YAAY,CAAC,CAAC,KAAK;GACrC,kBAAkB,CAAC,GAAG,gBAAgB,CAAC,CAAC,KAAK;EAC/C,CAAC,CAKD;EACA;EACA;EACA;EACA;CACF;AACF;AAEA,eAAsB,4BAA4B,iBAAwC;CACxF,MAAM,kBAAkB,KAAK,QAAQ,eAAe;CACpD,MAAM,aAAa,KAAK,SAAS,eAAe;CAChD,MAAM,mBAAmB,CAAC,IAAI,WAAW,aAAa,IAAI,WAAW,SAAS;CAC9E,MAAM,aAAa,MAAM,QAAQ,eAAe,EAAA,CAC7C,QAAQ,cAAc,iBAAiB,MAAM,WAAW,UAAU,WAAW,MAAM,CAAC,CAAC,CAAC,CACtF,KAAK,cAAc,KAAK,KAAK,iBAAiB,SAAS,CAAC;CAC3D,OACE,UAAU,WAAW,GACrB,8FAC4C,UAAU,KAAK,IAAI,GACjE;AACF;AAEA,eAAsB,gCACpB,oBACA,iBACkD;CAClD,MAAM,kBAAkB,KAAK,QAAQ,eAAe;CACpD,MAAM,4BAA4B,eAAe;CACjD,MAAM,oBAAoB,KAAK,KAC7B,iBACA,IAAI,KAAK,SAAS,eAAe,EAAE,YAAY,WAAW,GAC5D;CACA,OACE,CAAE,MAAM,WAAW,iBAAiB,GACpC,yDAAyD,mBAC3D;CACA,MAAM,eAAe,MAAM,WAAW,eAAe;CAErD,IAAI,cACF,MAAM,OAAO,iBAAiB,iBAAiB;CAGjD,IAAI;EACF,MAAM,OAAO,oBAAoB,eAAe;CAClD,SAAS,cAAc;EACrB,IAAI,cACF,IAAI;GACF,MAAM,OAAO,mBAAmB,eAAe;EACjD,SAAS,cAAc;GACrB,MAAM,IAAI,eACR,CAAC,cAAc,YAAY,GAC3B,wFACiC,mBACnC;EACF;EAEF,MAAM;CACR;CAEA,IAAI,CAAC,cACH,OAAO,EAAC,wBAAwB,KAAI;CAGtC,IAAI;EACF,MAAM,GAAG,mBAAmB,EAAC,WAAW,KAAI,CAAC;EAC7C,OAAO,EAAC,wBAAwB,KAAI;CACtC,SAAS,OAAO;EACd,OAAO,EACL,wBACE,6FACmC,kBAAkB,IAAI,aAAa,KAAK,EAAE,GACjF;CACF;AACF"}
@@ -0,0 +1,20 @@
1
+ import { EmbeddedExtension, ProjectJson, Sb3SourceManifest, UnknownRecord } from './types';
2
+ /** The source format version written for projects without block palette settings. */
3
+ export declare const sourceFormatVersion = 1;
4
+ /** The source format version written for projects with `block-palette.json`. */
5
+ export declare const blockPaletteSourceFormatVersion = 2;
6
+ /** Every source format version that readers accept. */
7
+ export declare const supportedSourceFormatVersions: readonly number[];
8
+ /** `embedded-extensions.json` keeps its own version, independent of the source format. */
9
+ export declare const embeddedExtensionManifestFormatVersion = 1;
10
+ export declare function isObject(value: unknown): value is UnknownRecord;
11
+ export declare function assertSameFileSet(actualFiles: string[], expectedFiles: string[], description: string): void;
12
+ export declare function validateSourceManifest(manifest: unknown): asserts manifest is Sb3SourceManifest;
13
+ export declare function validateExtensionLayout(extensionManifest: unknown, project: ProjectJson, extensionFiles: string[], validateManagedSource?: (extension: EmbeddedExtension) => unknown): {
14
+ extensionBundles: unknown;
15
+ extensions: EmbeddedExtension[];
16
+ };
17
+ export declare function collectSourceAssetReferences(project: ProjectJson): {
18
+ filename: string;
19
+ description: string;
20
+ }[];
@@ -0,0 +1,134 @@
1
+ import { assert } from "./assert.js";
2
+ import { blockPaletteFile } from "./block-palette.js";
3
+ import { validateArchiveEntryName } from "./archive.js";
4
+ //#region src/source-format.ts
5
+ /** The source format version written for projects without block palette settings. */
6
+ var sourceFormatVersion = 1;
7
+ /** The source format version written for projects with `block-palette.json`. */
8
+ var blockPaletteSourceFormatVersion = 2;
9
+ /** Every source format version that readers accept. */
10
+ var supportedSourceFormatVersions = [1, 2];
11
+ function isObject(value) {
12
+ return typeof value === "object" && value !== null && !Array.isArray(value);
13
+ }
14
+ function assertSameFileSet(actualFiles, expectedFiles, description) {
15
+ const actual = new Set(actualFiles);
16
+ const expected = new Set(expectedFiles);
17
+ const missing = [...expected].filter((filePath) => !actual.has(filePath)).sort();
18
+ const extra = [...actual].filter((filePath) => !expected.has(filePath)).sort();
19
+ assert(missing.length === 0 && extra.length === 0, `${description} does not match its manifest. Missing: ${missing.join(", ") || "(none)"}. Extra: ${extra.join(", ") || "(none)"}.`);
20
+ }
21
+ function validateSourceManifest(manifest) {
22
+ assert(isObject(manifest), "sb3-source.json must contain an object.");
23
+ assert(supportedSourceFormatVersions.includes(manifest.formatVersion), `Unsupported SB3 source format version: ${manifest.formatVersion}`);
24
+ if (manifest.formatVersion === 2) assert(manifest.blockPalette === blockPaletteFile, `SB3 source format 2 requires ${blockPaletteFile}.`);
25
+ else assert(manifest.blockPalette === void 0, "sb3-source.json blockPalette requires SB3 source format 2.");
26
+ assert(manifest.project === "project.source.json", "SB3 source format 1 requires project.source.json.");
27
+ assert(manifest.embeddedExtensions === "embedded-extensions.json", "SB3 source format 1 requires embedded-extensions.json.");
28
+ assert(manifest.assetsDirectory === "assets", "SB3 source format 1 requires the assets directory.");
29
+ assert(Array.isArray(manifest.archiveEntries) && manifest.archiveEntries.length > 0, "sb3-source.json archiveEntries must be a non-empty array.");
30
+ const seenEntries = /* @__PURE__ */ new Set();
31
+ let projectEntryCount = 0;
32
+ for (const rawEntryName of manifest.archiveEntries) {
33
+ const entryName = validateArchiveEntryName(rawEntryName);
34
+ assert(!seenEntries.has(entryName), `Duplicate archive entry in manifest: ${entryName}`);
35
+ assert(!entryName.endsWith("/"), `Directory ZIP entries are not supported in SB3 source format 1: ${entryName}`);
36
+ assert(!/^(?:0|[1-9][0-9]*)$/u.test(entryName), `Integer-like ZIP entry names cannot preserve JavaScript object order: ${entryName}`);
37
+ seenEntries.add(entryName);
38
+ if (entryName === "project.json") projectEntryCount += 1;
39
+ }
40
+ assert(projectEntryCount === 1, "archiveEntries must contain project.json exactly once.");
41
+ }
42
+ function validateExtensionLayout(extensionManifest, project, extensionFiles, validateManagedSource) {
43
+ assert(isObject(extensionManifest), "embedded-extensions.json must contain an object.");
44
+ assert(extensionManifest.formatVersion === 1, `Unsupported embedded extension manifest version: ${extensionManifest.formatVersion}`);
45
+ assert(Array.isArray(extensionManifest.extensions), "embedded-extensions.json extensions must be an array.");
46
+ const extensionUrls = project.extensionURLs ?? {};
47
+ assert(isObject(extensionUrls), "project.source.json extensionURLs must be an object when present.");
48
+ const extensionsById = /* @__PURE__ */ new Map();
49
+ const expectedFiles = [];
50
+ const extensions = [];
51
+ for (const entry of extensionManifest.extensions) {
52
+ assert(isObject(entry), "Each embedded extension manifest entry must be an object.");
53
+ const extension = entry;
54
+ assert(typeof extension.id === "string" && /^[A-Za-z0-9._-]+$/u.test(extension.id), `Invalid embedded extension ID: ${JSON.stringify(extension.id)}`);
55
+ assert(!extensionsById.has(extension.id), `Duplicate embedded extension ID: ${extension.id}`);
56
+ const expectedPath = `extensions/${extension.id}.js`;
57
+ assert(extension.path === expectedPath, `Embedded extension path must match its ID: expected ${expectedPath}, got ${extension.path}`);
58
+ assert(typeof extension.mediaType === "string" && extension.mediaType.length > 0 && !/[;,\r\n]/u.test(extension.mediaType), `Invalid media type for embedded extension ${extension.id}: ${extension.mediaType}`);
59
+ assert(Array.isArray(extension.parameters) && extension.parameters.every((parameter) => typeof parameter === "string" && parameter.length > 0 && !/[;,\r\n]/u.test(parameter)), `Invalid data URL parameters for embedded extension ${extension.id}.`);
60
+ assert(extension.encoding === "base64" || extension.encoding === "percent", `Unsupported encoding for embedded extension ${extension.id}: ${extension.encoding}`);
61
+ assert(extensionUrls[extension.id] === `embedded-extension:${extension.path}`, `project.source.json mapping does not match embedded extension ${extension.id}.`);
62
+ if (extension.source !== void 0) {
63
+ assert(isObject(extension.source), `Invalid source for embedded extension ${extension.id}.`);
64
+ const sidecar = extension.source.apiManifest;
65
+ assert(sidecar === void 0 || isObject(sidecar) && sidecar.path === `extensions/${extension.id}.manifest.json`, `Invalid API manifest path for embedded extension ${extension.id}.`);
66
+ }
67
+ validateManagedSource?.(extension);
68
+ extensionsById.set(extension.id, extension);
69
+ extensions.push(extension);
70
+ expectedFiles.push(`${extension.id}.js`);
71
+ if (extension.source?.apiManifest) expectedFiles.push(extension.source.apiManifest.path.slice(11));
72
+ }
73
+ for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {
74
+ assert(typeof extensionUrl !== "string" || !extensionUrl.startsWith("data:"), `project.source.json still contains an embedded data URL: ${extensionId}`);
75
+ if (typeof extensionUrl === "string" && extensionUrl.startsWith("embedded-extension:")) assert(extensionsById.has(extensionId), `project.source.json has no metadata for embedded extension ${extensionId}.`);
76
+ }
77
+ assertSameFileSet(extensionFiles, expectedFiles, "Embedded extension files");
78
+ return {
79
+ extensionBundles: extensionManifest.extensionBundles,
80
+ extensions
81
+ };
82
+ }
83
+ function collectAssetReferences(project) {
84
+ assert(Array.isArray(project.targets), "project.source.json targets must be an array.");
85
+ const references = [];
86
+ for (const [targetIndex, target] of project.targets.entries()) {
87
+ assert(isObject(target), `Project target ${targetIndex} must be an object.`);
88
+ for (const [collectionName, kind] of [["costumes", "costume"], ["sounds", "sound"]]) {
89
+ const assets = target[collectionName] ?? [];
90
+ assert(Array.isArray(assets), `Project target ${targetIndex} ${collectionName} must be an array.`);
91
+ for (const [assetIndex, asset] of assets.entries()) {
92
+ assert(isObject(asset), `Project ${kind} ${targetIndex}:${assetIndex} must be an object.`);
93
+ references.push({
94
+ asset,
95
+ description: `${kind} ${targetIndex}:${assetIndex}`
96
+ });
97
+ }
98
+ }
99
+ }
100
+ const fonts = project.customFonts ?? [];
101
+ assert(Array.isArray(fonts), "project.source.json customFonts must be an array.");
102
+ for (const [index, font] of fonts.entries()) {
103
+ if (!isObject(font) || font.system !== false || font.md5ext === void 0) continue;
104
+ const md5ext = font.md5ext;
105
+ const match = typeof md5ext === "string" && /^([a-f0-9]{32})\.(ttf|otf|woff2?)$/u.exec(md5ext);
106
+ assert(match, `Invalid font asset reference for font ${index}: ${md5ext}`);
107
+ const [, assetId, dataFormat] = match;
108
+ references.push({
109
+ asset: {
110
+ assetId,
111
+ dataFormat,
112
+ md5ext
113
+ },
114
+ description: `font ${index}`
115
+ });
116
+ }
117
+ return references;
118
+ }
119
+ function collectSourceAssetReferences(project) {
120
+ return collectAssetReferences(project).map(({ asset, description }) => {
121
+ assert(typeof asset.assetId === "string" && /^[a-f0-9]{32}$/u.test(asset.assetId), `Invalid assetId for ${description}: ${asset.assetId}`);
122
+ assert(typeof asset.dataFormat === "string" && /^[A-Za-z0-9]+$/u.test(asset.dataFormat), `Invalid dataFormat for ${description}: ${asset.dataFormat}`);
123
+ const expectedFilename = `${asset.assetId}.${asset.dataFormat}`;
124
+ assert(asset.md5ext === expectedFilename, `Asset filename mismatch for ${description}: expected ${expectedFilename}, got ${asset.md5ext}`);
125
+ return {
126
+ filename: expectedFilename,
127
+ description
128
+ };
129
+ });
130
+ }
131
+ //#endregion
132
+ export { assertSameFileSet, blockPaletteSourceFormatVersion, collectSourceAssetReferences, isObject, sourceFormatVersion, supportedSourceFormatVersions, validateExtensionLayout, validateSourceManifest };
133
+
134
+ //# sourceMappingURL=source-format.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"source-format.js","names":[],"sources":["../src/source-format.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {validateArchiveEntryName} from './archive';\nimport {assert} from './assert';\nimport {blockPaletteFile} from './block-palette';\nimport type {\n EmbeddedExtension,\n ProjectAssetReference,\n ProjectJson,\n Sb3SourceManifest,\n UnknownRecord,\n} from './types';\n\n/** The source format version written for projects without block palette settings. */\nexport const sourceFormatVersion = 1;\n/** The source format version written for projects with `block-palette.json`. */\nexport const blockPaletteSourceFormatVersion = 2;\n/** Every source format version that readers accept. */\nexport const supportedSourceFormatVersions: readonly number[] = [1, 2];\n/** `embedded-extensions.json` keeps its own version, independent of the source format. */\nexport const embeddedExtensionManifestFormatVersion = 1;\n\nexport function isObject(value: unknown): value is UnknownRecord {\n return typeof value === 'object' && value !== null && !Array.isArray(value);\n}\n\nexport function assertSameFileSet(\n actualFiles: string[],\n expectedFiles: string[],\n description: string,\n): void {\n const actual = new Set(actualFiles);\n const expected = new Set(expectedFiles);\n const missing = [...expected].filter((filePath) => !actual.has(filePath)).sort();\n const extra = [...actual].filter((filePath) => !expected.has(filePath)).sort();\n assert(\n missing.length === 0 && extra.length === 0,\n `${description} does not match its manifest. Missing: ${missing.join(', ') || '(none)'}. ` +\n `Extra: ${extra.join(', ') || '(none)'}.`,\n );\n}\n\nexport function validateSourceManifest(manifest: unknown): asserts manifest is Sb3SourceManifest {\n assert(isObject(manifest), 'sb3-source.json must contain an object.');\n assert(\n supportedSourceFormatVersions.includes(manifest.formatVersion as number),\n `Unsupported SB3 source format version: ${manifest.formatVersion}`,\n );\n if (manifest.formatVersion === blockPaletteSourceFormatVersion) {\n assert(\n manifest.blockPalette === blockPaletteFile,\n `SB3 source format 2 requires ${blockPaletteFile}.`,\n );\n } else {\n assert(\n manifest.blockPalette === undefined,\n 'sb3-source.json blockPalette requires SB3 source format 2.',\n );\n }\n assert(\n manifest.project === 'project.source.json',\n 'SB3 source format 1 requires project.source.json.',\n );\n assert(\n manifest.embeddedExtensions === 'embedded-extensions.json',\n 'SB3 source format 1 requires embedded-extensions.json.',\n );\n assert(\n manifest.assetsDirectory === 'assets',\n 'SB3 source format 1 requires the assets directory.',\n );\n assert(\n Array.isArray(manifest.archiveEntries) && manifest.archiveEntries.length > 0,\n 'sb3-source.json archiveEntries must be a non-empty array.',\n );\n\n const seenEntries = new Set<string>();\n let projectEntryCount = 0;\n for (const rawEntryName of manifest.archiveEntries as unknown[]) {\n const entryName = validateArchiveEntryName(rawEntryName);\n assert(!seenEntries.has(entryName), `Duplicate archive entry in manifest: ${entryName}`);\n assert(\n !entryName.endsWith('/'),\n `Directory ZIP entries are not supported in SB3 source format 1: ${entryName}`,\n );\n assert(\n !/^(?:0|[1-9][0-9]*)$/u.test(entryName),\n `Integer-like ZIP entry names cannot preserve JavaScript object order: ${entryName}`,\n );\n seenEntries.add(entryName);\n if (entryName === 'project.json') {\n projectEntryCount += 1;\n }\n }\n assert(projectEntryCount === 1, 'archiveEntries must contain project.json exactly once.');\n}\n\nexport function validateExtensionLayout(\n extensionManifest: unknown,\n project: ProjectJson,\n extensionFiles: string[],\n validateManagedSource?: (extension: EmbeddedExtension) => unknown,\n): {extensionBundles: unknown; extensions: EmbeddedExtension[]} {\n assert(isObject(extensionManifest), 'embedded-extensions.json must contain an object.');\n assert(\n extensionManifest.formatVersion === embeddedExtensionManifestFormatVersion,\n `Unsupported embedded extension manifest version: ${extensionManifest.formatVersion}`,\n );\n assert(\n Array.isArray(extensionManifest.extensions),\n 'embedded-extensions.json extensions must be an array.',\n );\n\n const extensionUrls: unknown = project.extensionURLs ?? {};\n assert(\n isObject(extensionUrls),\n 'project.source.json extensionURLs must be an object when present.',\n );\n const extensionsById = new Map<string, EmbeddedExtension>();\n const expectedFiles: string[] = [];\n const extensions: EmbeddedExtension[] = [];\n\n for (const entry of extensionManifest.extensions as unknown[]) {\n assert(isObject(entry), 'Each embedded extension manifest entry must be an object.');\n const extension = entry as unknown as EmbeddedExtension;\n assert(\n typeof extension.id === 'string' && /^[A-Za-z0-9._-]+$/u.test(extension.id),\n `Invalid embedded extension ID: ${JSON.stringify(extension.id)}`,\n );\n assert(!extensionsById.has(extension.id), `Duplicate embedded extension ID: ${extension.id}`);\n const expectedPath = `extensions/${extension.id}.js`;\n assert(\n extension.path === expectedPath,\n `Embedded extension path must match its ID: expected ${expectedPath}, got ${extension.path}`,\n );\n assert(\n typeof extension.mediaType === 'string' &&\n extension.mediaType.length > 0 &&\n !/[;,\\r\\n]/u.test(extension.mediaType),\n `Invalid media type for embedded extension ${extension.id}: ${extension.mediaType}`,\n );\n assert(\n Array.isArray(extension.parameters) &&\n extension.parameters.every(\n (parameter) =>\n typeof parameter === 'string' && parameter.length > 0 && !/[;,\\r\\n]/u.test(parameter),\n ),\n `Invalid data URL parameters for embedded extension ${extension.id}.`,\n );\n assert(\n extension.encoding === 'base64' || extension.encoding === 'percent',\n `Unsupported encoding for embedded extension ${extension.id}: ${extension.encoding}`,\n );\n assert(\n extensionUrls[extension.id] === `embedded-extension:${extension.path}`,\n `project.source.json mapping does not match embedded extension ${extension.id}.`,\n );\n if (extension.source !== undefined) {\n assert(isObject(extension.source), `Invalid source for embedded extension ${extension.id}.`);\n const sidecar = extension.source.apiManifest;\n assert(\n sidecar === undefined ||\n (isObject(sidecar) && sidecar.path === `extensions/${extension.id}.manifest.json`),\n `Invalid API manifest path for embedded extension ${extension.id}.`,\n );\n }\n validateManagedSource?.(extension);\n extensionsById.set(extension.id, extension);\n extensions.push(extension);\n expectedFiles.push(`${extension.id}.js`);\n if (extension.source?.apiManifest) {\n expectedFiles.push(extension.source.apiManifest.path.slice('extensions/'.length));\n }\n }\n\n for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {\n assert(\n typeof extensionUrl !== 'string' || !extensionUrl.startsWith('data:'),\n `project.source.json still contains an embedded data URL: ${extensionId}`,\n );\n if (typeof extensionUrl === 'string' && extensionUrl.startsWith('embedded-extension:')) {\n assert(\n extensionsById.has(extensionId),\n `project.source.json has no metadata for embedded extension ${extensionId}.`,\n );\n }\n }\n\n assertSameFileSet(extensionFiles, expectedFiles, 'Embedded extension files');\n return {\n extensionBundles: extensionManifest.extensionBundles,\n extensions,\n };\n}\n\nfunction collectAssetReferences(\n project: ProjectJson,\n): {asset: ProjectAssetReference; description: string}[] {\n assert(Array.isArray(project.targets), 'project.source.json targets must be an array.');\n const references: {asset: ProjectAssetReference; description: string}[] = [];\n for (const [targetIndex, target] of (project.targets as unknown[]).entries()) {\n assert(isObject(target), `Project target ${targetIndex} must be an object.`);\n for (const [collectionName, kind] of [\n ['costumes', 'costume'],\n ['sounds', 'sound'],\n ] as const) {\n const assets: unknown = target[collectionName] ?? [];\n assert(\n Array.isArray(assets),\n `Project target ${targetIndex} ${collectionName} must be an array.`,\n );\n for (const [assetIndex, asset] of (assets as unknown[]).entries()) {\n assert(isObject(asset), `Project ${kind} ${targetIndex}:${assetIndex} must be an object.`);\n references.push({asset, description: `${kind} ${targetIndex}:${assetIndex}`});\n }\n }\n }\n const fonts = project.customFonts ?? [];\n assert(Array.isArray(fonts), 'project.source.json customFonts must be an array.');\n for (const [index, font] of fonts.entries()) {\n if (!isObject(font) || font.system !== false || font.md5ext === undefined) continue;\n const md5ext = font.md5ext;\n const match = typeof md5ext === 'string' && /^([a-f0-9]{32})\\.(ttf|otf|woff2?)$/u.exec(md5ext);\n assert(match, `Invalid font asset reference for font ${index}: ${md5ext}`);\n const [, assetId, dataFormat] = match;\n references.push({asset: {assetId, dataFormat, md5ext}, description: `font ${index}`});\n }\n return references;\n}\n\nexport function collectSourceAssetReferences(\n project: ProjectJson,\n): {filename: string; description: string}[] {\n return collectAssetReferences(project).map(({asset, description}) => {\n assert(\n typeof asset.assetId === 'string' && /^[a-f0-9]{32}$/u.test(asset.assetId),\n `Invalid assetId for ${description}: ${asset.assetId}`,\n );\n assert(\n typeof asset.dataFormat === 'string' && /^[A-Za-z0-9]+$/u.test(asset.dataFormat),\n `Invalid dataFormat for ${description}: ${asset.dataFormat}`,\n );\n const expectedFilename = `${asset.assetId}.${asset.dataFormat}`;\n assert(\n asset.md5ext === expectedFilename,\n `Asset filename mismatch for ${description}: expected ${expectedFilename}, got ${asset.md5ext}`,\n );\n return {filename: expectedFilename, description};\n });\n}\n"],"mappings":";;;;;AAcA,IAAa,sBAAsB;;AAEnC,IAAa,kCAAkC;;AAE/C,IAAa,gCAAmD,CAAC,GAAG,CAAC;AAIrE,SAAgB,SAAS,OAAwC;CAC/D,OAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAgB,kBACd,aACA,eACA,aACM;CACN,MAAM,SAAS,IAAI,IAAI,WAAW;CAClC,MAAM,WAAW,IAAI,IAAI,aAAa;CACtC,MAAM,UAAU,CAAC,GAAG,QAAQ,CAAC,CAAC,QAAQ,aAAa,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK;CAC/E,MAAM,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,QAAQ,aAAa,CAAC,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK;CAC7E,OACE,QAAQ,WAAW,KAAK,MAAM,WAAW,GACzC,GAAG,YAAY,yCAAyC,QAAQ,KAAK,IAAI,KAAK,SAAS,WAC3E,MAAM,KAAK,IAAI,KAAK,SAAS,EAC3C;AACF;AAEA,SAAgB,uBAAuB,UAA0D;CAC/F,OAAO,SAAS,QAAQ,GAAG,yCAAyC;CACpE,OACE,8BAA8B,SAAS,SAAS,aAAuB,GACvE,0CAA0C,SAAS,eACrD;CACA,IAAI,SAAS,kBAAA,GACX,OACE,SAAS,iBAAiB,kBAC1B,gCAAgC,iBAAiB,EACnD;MAEA,OACE,SAAS,iBAAiB,KAAA,GAC1B,4DACF;CAEF,OACE,SAAS,YAAY,uBACrB,mDACF;CACA,OACE,SAAS,uBAAuB,4BAChC,wDACF;CACA,OACE,SAAS,oBAAoB,UAC7B,oDACF;CACA,OACE,MAAM,QAAQ,SAAS,cAAc,KAAK,SAAS,eAAe,SAAS,GAC3E,2DACF;CAEA,MAAM,8BAAc,IAAI,IAAY;CACpC,IAAI,oBAAoB;CACxB,KAAK,MAAM,gBAAgB,SAAS,gBAA6B;EAC/D,MAAM,YAAY,yBAAyB,YAAY;EACvD,OAAO,CAAC,YAAY,IAAI,SAAS,GAAG,wCAAwC,WAAW;EACvF,OACE,CAAC,UAAU,SAAS,GAAG,GACvB,mEAAmE,WACrE;EACA,OACE,CAAC,uBAAuB,KAAK,SAAS,GACtC,yEAAyE,WAC3E;EACA,YAAY,IAAI,SAAS;EACzB,IAAI,cAAc,gBAChB,qBAAqB;CAEzB;CACA,OAAO,sBAAsB,GAAG,wDAAwD;AAC1F;AAEA,SAAgB,wBACd,mBACA,SACA,gBACA,uBAC8D;CAC9D,OAAO,SAAS,iBAAiB,GAAG,kDAAkD;CACtF,OACE,kBAAkB,kBAAA,GAClB,oDAAoD,kBAAkB,eACxE;CACA,OACE,MAAM,QAAQ,kBAAkB,UAAU,GAC1C,uDACF;CAEA,MAAM,gBAAyB,QAAQ,iBAAiB,CAAC;CACzD,OACE,SAAS,aAAa,GACtB,mEACF;CACA,MAAM,iCAAiB,IAAI,IAA+B;CAC1D,MAAM,gBAA0B,CAAC;CACjC,MAAM,aAAkC,CAAC;CAEzC,KAAK,MAAM,SAAS,kBAAkB,YAAyB;EAC7D,OAAO,SAAS,KAAK,GAAG,2DAA2D;EACnF,MAAM,YAAY;EAClB,OACE,OAAO,UAAU,OAAO,YAAY,qBAAqB,KAAK,UAAU,EAAE,GAC1E,kCAAkC,KAAK,UAAU,UAAU,EAAE,GAC/D;EACA,OAAO,CAAC,eAAe,IAAI,UAAU,EAAE,GAAG,oCAAoC,UAAU,IAAI;EAC5F,MAAM,eAAe,cAAc,UAAU,GAAG;EAChD,OACE,UAAU,SAAS,cACnB,uDAAuD,aAAa,QAAQ,UAAU,MACxF;EACA,OACE,OAAO,UAAU,cAAc,YAC7B,UAAU,UAAU,SAAS,KAC7B,CAAC,YAAY,KAAK,UAAU,SAAS,GACvC,6CAA6C,UAAU,GAAG,IAAI,UAAU,WAC1E;EACA,OACE,MAAM,QAAQ,UAAU,UAAU,KAChC,UAAU,WAAW,OAClB,cACC,OAAO,cAAc,YAAY,UAAU,SAAS,KAAK,CAAC,YAAY,KAAK,SAAS,CACxF,GACF,sDAAsD,UAAU,GAAG,EACrE;EACA,OACE,UAAU,aAAa,YAAY,UAAU,aAAa,WAC1D,+CAA+C,UAAU,GAAG,IAAI,UAAU,UAC5E;EACA,OACE,cAAc,UAAU,QAAQ,sBAAsB,UAAU,QAChE,iEAAiE,UAAU,GAAG,EAChF;EACA,IAAI,UAAU,WAAW,KAAA,GAAW;GAClC,OAAO,SAAS,UAAU,MAAM,GAAG,yCAAyC,UAAU,GAAG,EAAE;GAC3F,MAAM,UAAU,UAAU,OAAO;GACjC,OACE,YAAY,KAAA,KACT,SAAS,OAAO,KAAK,QAAQ,SAAS,cAAc,UAAU,GAAG,iBACpE,oDAAoD,UAAU,GAAG,EACnE;EACF;EACA,wBAAwB,SAAS;EACjC,eAAe,IAAI,UAAU,IAAI,SAAS;EAC1C,WAAW,KAAK,SAAS;EACzB,cAAc,KAAK,GAAG,UAAU,GAAG,IAAI;EACvC,IAAI,UAAU,QAAQ,aACpB,cAAc,KAAK,UAAU,OAAO,YAAY,KAAK,MAAM,EAAoB,CAAC;CAEpF;CAEA,KAAK,MAAM,CAAC,aAAa,iBAAiB,OAAO,QAAQ,aAAa,GAAG;EACvE,OACE,OAAO,iBAAiB,YAAY,CAAC,aAAa,WAAW,OAAO,GACpE,4DAA4D,aAC9D;EACA,IAAI,OAAO,iBAAiB,YAAY,aAAa,WAAW,qBAAqB,GACnF,OACE,eAAe,IAAI,WAAW,GAC9B,8DAA8D,YAAY,EAC5E;CAEJ;CAEA,kBAAkB,gBAAgB,eAAe,0BAA0B;CAC3E,OAAO;EACL,kBAAkB,kBAAkB;EACpC;CACF;AACF;AAEA,SAAS,uBACP,SACuD;CACvD,OAAO,MAAM,QAAQ,QAAQ,OAAO,GAAG,+CAA+C;CACtF,MAAM,aAAoE,CAAC;CAC3E,KAAK,MAAM,CAAC,aAAa,WAAY,QAAQ,QAAsB,QAAQ,GAAG;EAC5E,OAAO,SAAS,MAAM,GAAG,kBAAkB,YAAY,oBAAoB;EAC3E,KAAK,MAAM,CAAC,gBAAgB,SAAS,CACnC,CAAC,YAAY,SAAS,GACtB,CAAC,UAAU,OAAO,CACpB,GAAY;GACV,MAAM,SAAkB,OAAO,mBAAmB,CAAC;GACnD,OACE,MAAM,QAAQ,MAAM,GACpB,kBAAkB,YAAY,GAAG,eAAe,mBAClD;GACA,KAAK,MAAM,CAAC,YAAY,UAAW,OAAqB,QAAQ,GAAG;IACjE,OAAO,SAAS,KAAK,GAAG,WAAW,KAAK,GAAG,YAAY,GAAG,WAAW,oBAAoB;IACzF,WAAW,KAAK;KAAC;KAAO,aAAa,GAAG,KAAK,GAAG,YAAY,GAAG;IAAY,CAAC;GAC9E;EACF;CACF;CACA,MAAM,QAAQ,QAAQ,eAAe,CAAC;CACtC,OAAO,MAAM,QAAQ,KAAK,GAAG,mDAAmD;CAChF,KAAK,MAAM,CAAC,OAAO,SAAS,MAAM,QAAQ,GAAG;EAC3C,IAAI,CAAC,SAAS,IAAI,KAAK,KAAK,WAAW,SAAS,KAAK,WAAW,KAAA,GAAW;EAC3E,MAAM,SAAS,KAAK;EACpB,MAAM,QAAQ,OAAO,WAAW,YAAY,sCAAsC,KAAK,MAAM;EAC7F,OAAO,OAAO,yCAAyC,MAAM,IAAI,QAAQ;EACzE,MAAM,GAAG,SAAS,cAAc;EAChC,WAAW,KAAK;GAAC,OAAO;IAAC;IAAS;IAAY;GAAM;GAAG,aAAa,QAAQ;EAAO,CAAC;CACtF;CACA,OAAO;AACT;AAEA,SAAgB,6BACd,SAC2C;CAC3C,OAAO,uBAAuB,OAAO,CAAC,CAAC,KAAK,EAAC,OAAO,kBAAiB;EACnE,OACE,OAAO,MAAM,YAAY,YAAY,kBAAkB,KAAK,MAAM,OAAO,GACzE,uBAAuB,YAAY,IAAI,MAAM,SAC/C;EACA,OACE,OAAO,MAAM,eAAe,YAAY,kBAAkB,KAAK,MAAM,UAAU,GAC/E,0BAA0B,YAAY,IAAI,MAAM,YAClD;EACA,MAAM,mBAAmB,GAAG,MAAM,QAAQ,GAAG,MAAM;EACnD,OACE,MAAM,WAAW,kBACjB,+BAA+B,YAAY,aAAa,iBAAiB,QAAQ,MAAM,QACzF;EACA,OAAO;GAAC,UAAU;GAAkB;EAAW;CACjD,CAAC;AACH"}
package/dist/source.d.ts CHANGED
@@ -1,11 +1,14 @@
1
+ import { BlockPaletteDocument } from './block-palette';
1
2
  import { ExtensionBundlePlan } from './extension-bundle';
2
3
  import { ProjectAssetAdditionsSummary } from './project-asset-additions';
3
4
  import { EmbeddedExtension, ExtensionBundleConfiguration, ProjectJson, Sb3SourceManifest } from './types';
4
- export declare const sourceFormatVersion = 1;
5
+ export { blockPaletteSourceFormatVersion, sourceFormatVersion, supportedSourceFormatVersions, } from './source-format';
5
6
  export declare const fixedZipTimestamp: Date;
6
7
  export interface InspectedSb3Source {
7
8
  assetContents: Map<string, Uint8Array>;
8
9
  assetReferenceCount: number;
10
+ /** `block-palette.json` in source format 2, otherwise null. */
11
+ blockPalette: BlockPaletteDocument | null;
9
12
  extensions: EmbeddedExtension[];
10
13
  extensionApiManifestContents: Map<string, Uint8Array>;
11
14
  extensionBundles: ExtensionBundleConfiguration[];
package/dist/source.js CHANGED
@@ -1,21 +1,18 @@
1
1
  import { assert, errorMessage } from "./assert.js";
2
- import { validateArchiveEntryName } from "./archive.js";
2
+ import { applyBlockPaletteComments, resolveBlockPaletteReferences, validateBlockPaletteDocument } from "./block-palette.js";
3
3
  import { validateManagedExtensionApiManifest } from "./extension-api-manifest.js";
4
4
  import { validateExtensionSourceMetadata, validateManagedExtensionContents } from "./extension-dependencies.js";
5
5
  import { validateExtensionBundleConfigurations } from "./extension-bundle.js";
6
6
  import { buildExtensionBundlesWithModules } from "./extension-module-bundle.js";
7
7
  import { applyProjectAssetAdditions } from "./project-asset-additions.js";
8
8
  import { cleanUpTurboWarpBlocks } from "./turbowarp-clean-up.js";
9
+ import { assertSameFileSet, blockPaletteSourceFormatVersion, collectSourceAssetReferences, isObject, sourceFormatVersion, supportedSourceFormatVersions, validateExtensionLayout, validateSourceManifest } from "./source-format.js";
9
10
  import path from "node:path";
10
11
  import { createHash } from "node:crypto";
11
12
  import { lstat, readFile, readdir } from "node:fs/promises";
12
13
  import { strToU8, zipSync } from "fflate";
13
14
  //#region src/source.ts
14
- var sourceFormatVersion = 1;
15
15
  var fixedZipTimestamp = new Date(1980, 0, 1, 0, 0, 0, 0);
16
- function isObject(value) {
17
- return typeof value === "object" && value !== null && !Array.isArray(value);
18
- }
19
16
  async function readJson(filePath, description) {
20
17
  try {
21
18
  return JSON.parse(await readFile(filePath, "utf8"));
@@ -28,7 +25,12 @@ async function assertDirectory(directoryPath, description) {
28
25
  assert(stats.isDirectory() && !stats.isSymbolicLink(), `${description} must be a directory, not a file or symbolic link: ${directoryPath}`);
29
26
  }
30
27
  async function listRegularFiles(rootDirectory, description) {
31
- await assertDirectory(rootDirectory, description);
28
+ try {
29
+ await assertDirectory(rootDirectory, description);
30
+ } catch (error) {
31
+ if (error.code === "ENOENT") return [];
32
+ throw error;
33
+ }
32
34
  const files = [];
33
35
  async function visit(directory, relativeDirectory) {
34
36
  const entries = await readdir(directory, { withFileTypes: true });
@@ -46,107 +48,9 @@ async function listRegularFiles(rootDirectory, description) {
46
48
  await visit(rootDirectory, "");
47
49
  return files;
48
50
  }
49
- function assertSameFileSet(actualFiles, expectedFiles, description) {
50
- const actual = new Set(actualFiles);
51
- const expected = new Set(expectedFiles);
52
- const missing = [...expected].filter((filePath) => !actual.has(filePath)).sort();
53
- const extra = [...actual].filter((filePath) => !expected.has(filePath)).sort();
54
- assert(missing.length === 0 && extra.length === 0, `${description} does not match its manifest. Missing: ${missing.join(", ") || "(none)"}. Extra: ${extra.join(", ") || "(none)"}.`);
55
- }
56
51
  function md5(contents) {
57
52
  return createHash("md5").update(contents).digest("hex");
58
53
  }
59
- function validateSourceManifest(manifest) {
60
- assert(isObject(manifest), "sb3-source.json must contain an object.");
61
- assert(manifest.formatVersion === 1, `Unsupported SB3 source format version: ${manifest.formatVersion}`);
62
- assert(manifest.project === "project.source.json", "SB3 source format 1 requires project.source.json.");
63
- assert(manifest.embeddedExtensions === "embedded-extensions.json", "SB3 source format 1 requires embedded-extensions.json.");
64
- assert(manifest.assetsDirectory === "assets", "SB3 source format 1 requires the assets directory.");
65
- assert(Array.isArray(manifest.archiveEntries) && manifest.archiveEntries.length > 0, "sb3-source.json archiveEntries must be a non-empty array.");
66
- const seenEntries = /* @__PURE__ */ new Set();
67
- let projectEntryCount = 0;
68
- for (const rawEntryName of manifest.archiveEntries) {
69
- const entryName = validateArchiveEntryName(rawEntryName);
70
- assert(!seenEntries.has(entryName), `Duplicate archive entry in manifest: ${entryName}`);
71
- assert(!entryName.endsWith("/"), `Directory ZIP entries are not supported in SB3 source format 1: ${entryName}`);
72
- assert(!/^(?:0|[1-9][0-9]*)$/u.test(entryName), `Integer-like ZIP entry names cannot preserve JavaScript object order: ${entryName}`);
73
- seenEntries.add(entryName);
74
- if (entryName === "project.json") projectEntryCount += 1;
75
- }
76
- assert(projectEntryCount === 1, "archiveEntries must contain project.json exactly once.");
77
- }
78
- function validateExtensionManifest(extensionManifest, project, extensionFiles) {
79
- assert(isObject(extensionManifest), "embedded-extensions.json must contain an object.");
80
- assert(extensionManifest.formatVersion === 1, `Unsupported embedded extension manifest version: ${extensionManifest.formatVersion}`);
81
- assert(Array.isArray(extensionManifest.extensions), "embedded-extensions.json extensions must be an array.");
82
- const extensionUrls = project.extensionURLs ?? {};
83
- assert(isObject(extensionUrls), "project.source.json extensionURLs must be an object when present.");
84
- const extensionsById = /* @__PURE__ */ new Map();
85
- const expectedFiles = [];
86
- const extensions = [];
87
- for (const entry of extensionManifest.extensions) {
88
- assert(isObject(entry), "Each embedded extension manifest entry must be an object.");
89
- const extension = entry;
90
- assert(typeof extension.id === "string" && /^[A-Za-z0-9._-]+$/u.test(extension.id), `Invalid embedded extension ID: ${JSON.stringify(extension.id)}`);
91
- assert(!extensionsById.has(extension.id), `Duplicate embedded extension ID: ${extension.id}`);
92
- const expectedPath = `extensions/${extension.id}.js`;
93
- assert(extension.path === expectedPath, `Embedded extension path must match its ID: expected ${expectedPath}, got ${extension.path}`);
94
- assert(typeof extension.mediaType === "string" && extension.mediaType.length > 0 && !/[;,\r\n]/u.test(extension.mediaType), `Invalid media type for embedded extension ${extension.id}: ${extension.mediaType}`);
95
- assert(Array.isArray(extension.parameters) && extension.parameters.every((parameter) => typeof parameter === "string" && parameter.length > 0 && !/[;,\r\n]/u.test(parameter)), `Invalid data URL parameters for embedded extension ${extension.id}.`);
96
- assert(extension.encoding === "base64" || extension.encoding === "percent", `Unsupported encoding for embedded extension ${extension.id}: ${extension.encoding}`);
97
- assert(extensionUrls[extension.id] === `embedded-extension:${extension.path}`, `project.source.json mapping does not match embedded extension ${extension.id}.`);
98
- validateExtensionSourceMetadata(extension);
99
- extensionsById.set(extension.id, extension);
100
- extensions.push(extension);
101
- expectedFiles.push(`${extension.id}.js`);
102
- if (extension.source?.apiManifest) expectedFiles.push(path.posix.relative("extensions", extension.source.apiManifest.path));
103
- }
104
- for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {
105
- assert(typeof extensionUrl !== "string" || !extensionUrl.startsWith("data:"), `project.source.json still contains an embedded data URL: ${extensionId}`);
106
- if (typeof extensionUrl === "string" && extensionUrl.startsWith("embedded-extension:")) assert(extensionsById.has(extensionId), `project.source.json has no metadata for embedded extension ${extensionId}.`);
107
- }
108
- assertSameFileSet(extensionFiles, expectedFiles, "Embedded extension files");
109
- return {
110
- extensionBundles: validateExtensionBundleConfigurations(extensionManifest.extensionBundles, extensions),
111
- extensions
112
- };
113
- }
114
- function collectAssetReferences(project) {
115
- assert(Array.isArray(project.targets), "project.source.json targets must be an array.");
116
- const references = [];
117
- for (const [targetIndex, target] of project.targets.entries()) {
118
- assert(isObject(target), `Project target ${targetIndex} must be an object.`);
119
- for (const [collectionName, kind] of [["costumes", "costume"], ["sounds", "sound"]]) {
120
- const assets = target[collectionName] ?? [];
121
- assert(Array.isArray(assets), `Project target ${targetIndex} ${collectionName} must be an array.`);
122
- for (const [assetIndex, asset] of assets.entries()) {
123
- assert(isObject(asset), `Project ${kind} ${targetIndex}:${assetIndex} must be an object.`);
124
- references.push({
125
- asset,
126
- description: `${kind} ${targetIndex}:${assetIndex}`
127
- });
128
- }
129
- }
130
- }
131
- const fonts = project.customFonts ?? [];
132
- assert(Array.isArray(fonts), "project.source.json customFonts must be an array.");
133
- for (const [index, font] of fonts.entries()) {
134
- if (!isObject(font) || font.system !== false || font.md5ext === void 0) continue;
135
- const md5ext = font.md5ext;
136
- const match = typeof md5ext === "string" && /^([a-f0-9]{32})\.(ttf|otf|woff2?)$/u.exec(md5ext);
137
- assert(match, `Invalid font asset reference for font ${index}: ${md5ext}`);
138
- const [, assetId, dataFormat] = match;
139
- references.push({
140
- asset: {
141
- assetId,
142
- dataFormat,
143
- md5ext
144
- },
145
- description: `font ${index}`
146
- });
147
- }
148
- return references;
149
- }
150
54
  function percentEncode(contents) {
151
55
  return [...contents].map((byte) => `%${byte.toString(16).padStart(2, "0").toUpperCase()}`).join("");
152
56
  }
@@ -163,28 +67,29 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
163
67
  const assetEntries = sourceManifest.archiveEntries.filter((entryName) => entryName !== "project.json");
164
68
  const project = await readJson(path.join(resolvedSourceDirectory, sourceManifest.project), "SB3 project source");
165
69
  assert(isObject(project), "project.source.json must contain an object.");
70
+ const blockPalette = sourceManifest.blockPalette === void 0 ? null : validateBlockPaletteDocument(await readJson(path.join(resolvedSourceDirectory, sourceManifest.blockPalette), "Block palette settings"));
71
+ resolveBlockPaletteReferences(project, blockPalette);
166
72
  const extensionManifest = await readJson(path.join(resolvedSourceDirectory, sourceManifest.embeddedExtensions), "Embedded extension manifest");
167
73
  const assetsDirectory = path.join(resolvedSourceDirectory, sourceManifest.assetsDirectory);
168
74
  const extensionsDirectory = path.join(resolvedSourceDirectory, "extensions");
169
75
  const [assetFiles, extensionFiles] = await Promise.all([listRegularFiles(assetsDirectory, "Assets directory"), listRegularFiles(extensionsDirectory, "Extensions directory")]);
170
76
  assertSameFileSet(assetFiles, assetEntries, "Asset files");
171
- const { extensionBundles, extensions } = validateExtensionManifest(extensionManifest, project, extensionFiles);
77
+ const { extensionBundles: bundleConfiguration, extensions } = validateExtensionLayout(extensionManifest, project, extensionFiles, validateExtensionSourceMetadata);
78
+ const extensionBundles = validateExtensionBundleConfigurations(bundleConfiguration, extensions);
172
79
  const assetContents = /* @__PURE__ */ new Map();
173
80
  await Promise.all(assetFiles.map(async (assetPath) => {
174
81
  assetContents.set(assetPath, await readFile(path.join(assetsDirectory, assetPath)));
175
82
  }));
83
+ const references = collectSourceAssetReferences(project);
176
84
  const referencedAssets = /* @__PURE__ */ new Set();
177
- const references = collectAssetReferences(project);
178
- for (const { asset, description } of references) {
179
- assert(typeof asset.assetId === "string" && /^[a-f0-9]{32}$/u.test(asset.assetId), `Invalid assetId for ${description}: ${asset.assetId}`);
180
- assert(typeof asset.dataFormat === "string" && /^[A-Za-z0-9]+$/u.test(asset.dataFormat), `Invalid dataFormat for ${description}: ${asset.dataFormat}`);
181
- const expectedFilename = `${asset.assetId}.${asset.dataFormat}`;
182
- assert(asset.md5ext === expectedFilename, `Asset filename mismatch for ${description}: expected ${expectedFilename}, got ${asset.md5ext}`);
183
- const contents = assetContents.get(expectedFilename);
184
- assert(contents, `Referenced asset is missing for ${description}: ${expectedFilename}`);
85
+ for (const { filename, description } of references) {
86
+ if (referencedAssets.has(filename)) continue;
87
+ const contents = assetContents.get(filename);
88
+ assert(contents, `Referenced asset is missing for ${description}: ${filename}`);
89
+ const assetId = filename.slice(0, 32);
185
90
  const actualAssetId = md5(contents);
186
- assert(actualAssetId === asset.assetId, `Asset content hash mismatch for ${description}: expected ${asset.assetId}, got ${actualAssetId}`);
187
- referencedAssets.add(expectedFilename);
91
+ assert(actualAssetId === assetId, `Asset content hash mismatch for ${description}: expected ${assetId}, got ${actualAssetId}`);
92
+ referencedAssets.add(filename);
188
93
  }
189
94
  const unreferencedAssets = assetFiles.filter((assetPath) => !referencedAssets.has(assetPath));
190
95
  assert(unreferencedAssets.length === 0, `Asset manifest contains unreferenced files: ${unreferencedAssets.join(", ")}`);
@@ -203,6 +108,7 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
203
108
  return {
204
109
  assetContents,
205
110
  assetReferenceCount: references.length,
111
+ blockPalette,
206
112
  extensions,
207
113
  extensionApiManifestContents,
208
114
  extensionBundles,
@@ -264,6 +170,7 @@ async function createDeterministicSb3(sourceDirectory, options = {}) {
264
170
  targetCount: cleaned.targetCount
265
171
  };
266
172
  }
173
+ applyBlockPaletteComments(project, source.blockPalette);
267
174
  const extensionUrls = project.extensionURLs ?? {};
268
175
  for (const extension of bundled.extensions) {
269
176
  const contents = bundled.extensionContents.get(extension.id);
@@ -297,6 +204,6 @@ async function createDeterministicSb3(sourceDirectory, options = {}) {
297
204
  };
298
205
  }
299
206
  //#endregion
300
- export { createDeterministicSb3, fixedZipTimestamp, inspectSb3SourceForExtensionSync, sourceFormatVersion, validateSb3Source };
207
+ export { blockPaletteSourceFormatVersion, createDeterministicSb3, fixedZipTimestamp, inspectSb3SourceForExtensionSync, sourceFormatVersion, supportedSourceFormatVersions, validateSb3Source };
301
208
 
302
209
  //# sourceMappingURL=source.js.map