@kubohiroya/sb3-toolchain 0.23.0 → 0.24.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.
- package/CHANGELOG.md +5 -0
- package/README.ja.md +7 -1
- package/README.md +7 -1
- package/dist/archive.js +1 -2
- package/dist/archive.js.map +1 -1
- package/dist/browser.d.ts +15 -0
- package/dist/browser.js +123 -0
- package/dist/browser.js.map +1 -0
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/dist/constants.js.map +1 -1
- package/dist/expand-archive.d.ts +29 -0
- package/dist/expand-archive.js +135 -0
- package/dist/expand-archive.js.map +1 -0
- package/dist/import.js +28 -113
- package/dist/import.js.map +1 -1
- package/dist/index.js +2 -1
- package/dist/source-format.d.ts +13 -0
- package/dist/source-format.js +126 -0
- package/dist/source-format.js.map +1 -0
- package/dist/source.d.ts +1 -1
- package/dist/source.js +17 -115
- package/dist/source.js.map +1 -1
- package/docs/index.html +2 -2
- package/package.json +6 -1
package/dist/import.js
CHANGED
|
@@ -1,17 +1,13 @@
|
|
|
1
|
-
import { assert
|
|
1
|
+
import { assert } from "./assert.js";
|
|
2
2
|
import { assertNoInterruptedRollback, assertRecognizedOutputDirectory, compareDirectories, inspectGitOutputState, pathExists, replaceDirectoryTransactionally, validateOutputDirectoryPath } from "./output-safety.js";
|
|
3
|
-
import { validateArchiveEntryName } from "./archive.js";
|
|
4
3
|
import { validateManagedExtensionApiManifest } from "./extension-api-manifest.js";
|
|
5
4
|
import { validateManagedExtensionContents } from "./extension-dependencies.js";
|
|
6
|
-
import "./source.js";
|
|
5
|
+
import { isObject } from "./source-format.js";
|
|
6
|
+
import { decodeExtensionBytes, expandArchive, formatSourceFiles } from "./expand-archive.js";
|
|
7
7
|
import process from "node:process";
|
|
8
8
|
import path from "node:path";
|
|
9
9
|
import { mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
|
|
10
|
-
import { strFromU8, unzipSync } from "fflate";
|
|
11
10
|
//#region src/import.ts
|
|
12
|
-
function isObject(value) {
|
|
13
|
-
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
14
|
-
}
|
|
15
11
|
function summarizeGitChanges(gitState) {
|
|
16
12
|
const entries = [...gitState.statusEntries, ...gitState.untrackedContent.map((entry) => `not tracked: ${entry}`)];
|
|
17
13
|
return `${entries.slice(0, 8).join(", ")}${entries.length > 8 ? `, and ${entries.length - 8} more` : ""}`;
|
|
@@ -58,10 +54,6 @@ async function revalidateOutputReplacement({ candidateDirectory, decision, disca
|
|
|
58
54
|
assert(latestGitState.fingerprint === decision.gitState.fingerprint, "Git state changed during SB3 import; refusing to replace the output.");
|
|
59
55
|
assert(latestGitState.clean || discardLocalChanges, "Output gained uncommitted Git changes during SB3 import; refusing to replace it.");
|
|
60
56
|
}
|
|
61
|
-
function extensionSourcePath(extensionId) {
|
|
62
|
-
assert(/^[A-Za-z0-9._-]+$/u.test(extensionId), `Embedded extension ID cannot be used as a filename: ${JSON.stringify(extensionId)}`);
|
|
63
|
-
return `extensions/${extensionId}.js`;
|
|
64
|
-
}
|
|
65
57
|
async function readExistingExtensionSources(outputDirectory) {
|
|
66
58
|
if (!await pathExists(outputDirectory)) return /* @__PURE__ */ new Map();
|
|
67
59
|
const manifestPath = path.join(outputDirectory, "embedded-extensions.json");
|
|
@@ -81,31 +73,10 @@ async function readExistingExtensionSources(outputDirectory) {
|
|
|
81
73
|
return sources;
|
|
82
74
|
}
|
|
83
75
|
function decodeExtensionDataUrl(dataUrl) {
|
|
84
|
-
|
|
85
|
-
const commaIndex = dataUrl.indexOf(",");
|
|
86
|
-
assert(commaIndex >= 0, "Embedded extension data URL has no payload separator.");
|
|
87
|
-
const metadata = dataUrl.slice(5, commaIndex).split(";");
|
|
88
|
-
const mediaType = metadata.shift() || "text/plain";
|
|
89
|
-
const base64Index = metadata.indexOf("base64");
|
|
90
|
-
const encoding = base64Index >= 0 ? "base64" : "percent";
|
|
91
|
-
if (base64Index >= 0) metadata.splice(base64Index, 1);
|
|
92
|
-
const payload = dataUrl.slice(commaIndex + 1);
|
|
93
|
-
let source;
|
|
94
|
-
if (encoding === "base64") {
|
|
95
|
-
assert(/^[A-Za-z0-9+/]*={0,2}$/u.test(payload), "Embedded extension data URL contains invalid base64.");
|
|
96
|
-
const unpaddedPayload = payload.replace(/=+$/u, "");
|
|
97
|
-
assert(unpaddedPayload.length % 4 !== 1, "Embedded extension data URL contains invalid base64.");
|
|
98
|
-
source = Buffer.from(unpaddedPayload.padEnd(Math.ceil(unpaddedPayload.length / 4) * 4, "="), "base64");
|
|
99
|
-
} else try {
|
|
100
|
-
source = Buffer.from(decodeURIComponent(payload), "utf8");
|
|
101
|
-
} catch {
|
|
102
|
-
throw new Error("Embedded extension data URL contains invalid percent encoding.");
|
|
103
|
-
}
|
|
76
|
+
const decoded = decodeExtensionBytes(dataUrl);
|
|
104
77
|
return {
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
parameters: metadata,
|
|
108
|
-
source
|
|
78
|
+
...decoded,
|
|
79
|
+
source: Buffer.from(decoded.source)
|
|
109
80
|
};
|
|
110
81
|
}
|
|
111
82
|
async function importSb3({ inputPath, outputDirectory, protectedRoot = process.cwd(), discardLocalChanges = false, yes = false, confirmReplace }) {
|
|
@@ -113,89 +84,33 @@ async function importSb3({ inputPath, outputDirectory, protectedRoot = process.c
|
|
|
113
84
|
assert(typeof outputDirectory === "string", "SB3 source output directory is required.");
|
|
114
85
|
const resolvedInputPath = path.resolve(inputPath);
|
|
115
86
|
const resolvedOutputDirectory = validateOutputDirectoryPath(outputDirectory, protectedRoot);
|
|
116
|
-
const
|
|
117
|
-
const
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
} catch (error) {
|
|
128
|
-
throw new Error(`SB3 project.json is invalid JSON: ${errorMessage(error)}`, { cause: error });
|
|
129
|
-
}
|
|
130
|
-
assert(isObject(project), "SB3 project.json must contain a JSON object.");
|
|
131
|
-
const projectJson = project;
|
|
132
|
-
const extensionUrls = projectJson.extensionURLs ?? {};
|
|
133
|
-
assert(isObject(extensionUrls), "SB3 project.json extensionURLs must be an object when present.");
|
|
134
|
-
const existingExtensionSources = await readExistingExtensionSources(resolvedOutputDirectory);
|
|
135
|
-
const embeddedExtensions = [];
|
|
136
|
-
const decodedExtensionSources = [];
|
|
137
|
-
for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {
|
|
138
|
-
if (typeof extensionUrl !== "string" || !extensionUrl.startsWith("data:")) continue;
|
|
139
|
-
const sourcePath = extensionSourcePath(extensionId);
|
|
140
|
-
const decoded = decodeExtensionDataUrl(extensionUrl);
|
|
141
|
-
extensionUrls[extensionId] = `embedded-extension:${sourcePath}`;
|
|
142
|
-
const extension = {
|
|
143
|
-
id: extensionId,
|
|
144
|
-
path: sourcePath,
|
|
145
|
-
mediaType: decoded.mediaType,
|
|
146
|
-
parameters: decoded.parameters,
|
|
147
|
-
encoding: decoded.encoding
|
|
148
|
-
};
|
|
149
|
-
const existingSource = existingExtensionSources.get(`${extensionId}\u0000${sourcePath}`);
|
|
150
|
-
let existingApiManifestContents = null;
|
|
151
|
-
if (existingSource !== void 0) {
|
|
152
|
-
extension.source = structuredClone(existingSource);
|
|
153
|
-
validateManagedExtensionContents(extension, decoded.source);
|
|
154
|
-
if (extension.source.apiManifest) {
|
|
155
|
-
existingApiManifestContents = await readFile(path.join(resolvedOutputDirectory, extension.source.apiManifest.path));
|
|
156
|
-
validateManagedExtensionApiManifest(extension, existingApiManifestContents);
|
|
157
|
-
}
|
|
87
|
+
const expanded = expandArchive(await readFile(resolvedInputPath));
|
|
88
|
+
const existingSources = await readExistingExtensionSources(resolvedOutputDirectory);
|
|
89
|
+
for (const extension of expanded.embeddedExtensions) {
|
|
90
|
+
const source = existingSources.get(`${extension.id}\u0000${extension.path}`);
|
|
91
|
+
if (source === void 0) continue;
|
|
92
|
+
extension.source = structuredClone(source);
|
|
93
|
+
validateManagedExtensionContents(extension, expanded.extensionFiles.get(extension.path));
|
|
94
|
+
if (extension.source.apiManifest) {
|
|
95
|
+
const contents = await readFile(path.join(resolvedOutputDirectory, extension.source.apiManifest.path));
|
|
96
|
+
validateManagedExtensionApiManifest(extension, contents);
|
|
97
|
+
expanded.extensionFiles.set(extension.source.apiManifest.path, contents);
|
|
158
98
|
}
|
|
159
|
-
embeddedExtensions.push(extension);
|
|
160
|
-
decodedExtensionSources.push({
|
|
161
|
-
path: sourcePath,
|
|
162
|
-
source: decoded.source
|
|
163
|
-
});
|
|
164
|
-
if (existingApiManifestContents && extension.source?.apiManifest) decodedExtensionSources.push({
|
|
165
|
-
path: extension.source.apiManifest.path,
|
|
166
|
-
source: existingApiManifestContents
|
|
167
|
-
});
|
|
168
99
|
}
|
|
100
|
+
let decision;
|
|
101
|
+
let rollbackCleanupWarning = null;
|
|
169
102
|
const outputParent = path.dirname(resolvedOutputDirectory);
|
|
170
103
|
await mkdir(outputParent, { recursive: true });
|
|
171
104
|
const temporaryDirectory = await mkdtemp(path.join(outputParent, `.${path.basename(resolvedOutputDirectory)}.import-`));
|
|
172
105
|
try {
|
|
173
|
-
|
|
174
|
-
await mkdir(assetsDirectory, { recursive: true });
|
|
106
|
+
await mkdir(path.join(temporaryDirectory, "assets"), { recursive: true });
|
|
175
107
|
await mkdir(path.join(temporaryDirectory, "extensions"), { recursive: true });
|
|
176
|
-
for (const [
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
await
|
|
181
|
-
await writeFile(assetPath, contents);
|
|
108
|
+
for (const [name, contents] of formatSourceFiles(expanded)) {
|
|
109
|
+
const outputPath = path.resolve(temporaryDirectory, name);
|
|
110
|
+
assert(outputPath.startsWith(`${temporaryDirectory}${path.sep}`), `SB3 archive entry escapes the source directory: ${JSON.stringify(name)}`);
|
|
111
|
+
await mkdir(path.dirname(outputPath), { recursive: true });
|
|
112
|
+
await writeFile(outputPath, contents);
|
|
182
113
|
}
|
|
183
|
-
for (const extension of decodedExtensionSources) await writeFile(path.join(temporaryDirectory, extension.path), extension.source);
|
|
184
|
-
const sourceManifest = {
|
|
185
|
-
formatVersion: 1,
|
|
186
|
-
project: "project.source.json",
|
|
187
|
-
embeddedExtensions: "embedded-extensions.json",
|
|
188
|
-
assetsDirectory: "assets",
|
|
189
|
-
archiveEntries: archiveEntries.map(([entryName]) => entryName)
|
|
190
|
-
};
|
|
191
|
-
await Promise.all([
|
|
192
|
-
writeFile(path.join(temporaryDirectory, "project.source.json"), `${JSON.stringify(projectJson, null, 2)}\n`),
|
|
193
|
-
writeFile(path.join(temporaryDirectory, "embedded-extensions.json"), `${JSON.stringify({
|
|
194
|
-
formatVersion: 1,
|
|
195
|
-
extensions: embeddedExtensions
|
|
196
|
-
}, null, 2)}\n`),
|
|
197
|
-
writeFile(path.join(temporaryDirectory, "sb3-source.json"), `${JSON.stringify(sourceManifest, null, 2)}\n`)
|
|
198
|
-
]);
|
|
199
114
|
decision = await authorizeOutputReplacement({
|
|
200
115
|
candidateDirectory: temporaryDirectory,
|
|
201
116
|
confirmReplace,
|
|
@@ -224,9 +139,9 @@ async function importSb3({ inputPath, outputDirectory, protectedRoot = process.c
|
|
|
224
139
|
throw error;
|
|
225
140
|
}
|
|
226
141
|
return {
|
|
227
|
-
archiveEntryCount: archiveEntries.length,
|
|
228
|
-
assetCount:
|
|
229
|
-
embeddedExtensionCount: embeddedExtensions.length,
|
|
142
|
+
archiveEntryCount: expanded.archiveEntries.length,
|
|
143
|
+
assetCount: expanded.assets.size,
|
|
144
|
+
embeddedExtensionCount: expanded.embeddedExtensions.length,
|
|
230
145
|
changed: decision.action !== "unchanged",
|
|
231
146
|
differenceCounts: decision.comparison ? {
|
|
232
147
|
added: decision.comparison.differences.added.length,
|
package/dist/import.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"import.js","names":[],"sources":["../src/import.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {mkdir, mkdtemp, readFile, rm, writeFile} from 'node:fs/promises';\nimport path from 'node:path';\nimport process from 'node:process';\n\nimport {strFromU8, unzipSync} from 'fflate';\n\nimport {validateArchiveEntryName} from './archive';\nimport {assert, errorMessage} from './assert';\nimport {validateManagedExtensionApiManifest} from './extension-api-manifest';\nimport {validateManagedExtensionContents} from './extension-dependencies';\nimport {\n assertNoInterruptedRollback,\n assertRecognizedOutputDirectory,\n compareDirectories,\n inspectGitOutputState,\n pathExists,\n replaceDirectoryTransactionally,\n validateOutputDirectoryPath,\n} from './output-safety';\nimport type {DirectoryComparison, GitOutputState} from './output-safety';\nimport {sourceFormatVersion} from './source';\nimport type {\n EmbeddedExtension,\n ExtensionEncoding,\n ExtensionSource,\n ProjectJson,\n UnknownRecord,\n} from './types';\n\nexport {validateOutputDirectoryPath} from './output-safety';\n\nexport interface DecodedExtensionDataUrl {\n encoding: ExtensionEncoding;\n mediaType: string;\n parameters: string[];\n source: Buffer;\n}\n\nexport interface OutputReplacementContext {\n comparison: DirectoryComparison;\n discardLocalChanges: boolean;\n gitState: GitOutputState;\n outputDirectory: string;\n}\n\ninterface OutputReplacementDecision {\n action: 'create' | 'unchanged' | 'replace';\n comparison: DirectoryComparison | null;\n discardLocalChanges?: boolean;\n gitState: GitOutputState | null;\n outputDirectory?: string;\n}\n\nexport interface ImportSb3Options {\n confirmReplace?: (context: OutputReplacementContext) => boolean | Promise<boolean>;\n discardLocalChanges?: boolean;\n inputPath: string;\n outputDirectory: string;\n protectedRoot?: string;\n yes?: boolean;\n}\n\nexport interface ImportSb3Result {\n archiveEntryCount: number;\n assetCount: number;\n changed: boolean;\n differenceCounts: {added: number; modified: number; removed: number} | null;\n embeddedExtensionCount: number;\n inputPath: string;\n outputDirectory: string;\n rollbackCleanupWarning: string | null;\n}\n\nfunction isObject(value: unknown): value is UnknownRecord {\n return typeof value === 'object' && value !== null && !Array.isArray(value);\n}\n\nfunction summarizeGitChanges(gitState: GitOutputState): string {\n const entries = [\n ...gitState.statusEntries,\n ...gitState.untrackedContent.map((entry) => `not tracked: ${entry}`),\n ];\n const visibleEntries = entries.slice(0, 8).join(', ');\n const remainder = entries.length > 8 ? `, and ${entries.length - 8} more` : '';\n return `${visibleEntries}${remainder}`;\n}\n\nasync function authorizeOutputReplacement({\n candidateDirectory,\n confirmReplace,\n discardLocalChanges,\n outputDirectory,\n yes,\n}: {\n candidateDirectory: string;\n confirmReplace?: (context: OutputReplacementContext) => boolean | Promise<boolean>;\n discardLocalChanges: boolean;\n outputDirectory: string;\n yes: boolean;\n}): Promise<OutputReplacementDecision> {\n await assertNoInterruptedRollback(outputDirectory);\n if (!(await pathExists(outputDirectory))) {\n return {action: 'create', comparison: null, gitState: null};\n }\n\n await assertRecognizedOutputDirectory(outputDirectory, sourceFormatVersion);\n const comparison = await compareDirectories(outputDirectory, candidateDirectory);\n if (comparison.identical) {\n return {action: 'unchanged', comparison, gitState: null};\n }\n\n const gitState = await inspectGitOutputState(outputDirectory, comparison.existingFilePaths);\n assert(\n gitState.managed,\n `Existing output differs from the SB3 candidate but is not tracked by Git: ${outputDirectory}. ` +\n 'Import to a new output directory instead of replacing unrecoverable content.',\n );\n assert(\n gitState.clean || discardLocalChanges,\n `Existing output differs from the SB3 candidate and has uncommitted Git changes: ` +\n `${summarizeGitChanges(gitState)}. Commit or stash them first, or explicitly use ` +\n '--discard-local-changes.',\n );\n\n const context = {\n comparison,\n discardLocalChanges,\n gitState,\n outputDirectory,\n };\n if (yes) {\n return {action: 'replace', ...context};\n }\n assert(\n typeof confirmReplace === 'function',\n `Output directory already exists: ${outputDirectory}. ` +\n 'Refusing to replace differing content without interactive confirmation or --yes.',\n );\n assert(\n await confirmReplace(context),\n 'SB3 import cancelled; the existing output was not changed.',\n );\n return {action: 'replace', ...context};\n}\n\nasync function revalidateOutputReplacement({\n candidateDirectory,\n decision,\n discardLocalChanges,\n outputDirectory,\n}: {\n candidateDirectory: string;\n decision: OutputReplacementContext;\n discardLocalChanges: boolean;\n outputDirectory: string;\n}): Promise<void> {\n const latestComparison = await compareDirectories(outputDirectory, candidateDirectory);\n assert(\n latestComparison.existingFingerprint === decision.comparison.existingFingerprint &&\n latestComparison.candidateFingerprint === decision.comparison.candidateFingerprint,\n 'Output or candidate content changed during SB3 import; refusing to replace it.',\n );\n const latestGitState = await inspectGitOutputState(\n outputDirectory,\n latestComparison.existingFilePaths,\n );\n assert(\n latestGitState.managed,\n 'Output stopped being Git-managed during SB3 import; refusing to replace it.',\n );\n assert(\n latestGitState.fingerprint === decision.gitState.fingerprint,\n 'Git state changed during SB3 import; refusing to replace the output.',\n );\n assert(\n latestGitState.clean || discardLocalChanges,\n 'Output gained uncommitted Git changes during SB3 import; refusing to replace it.',\n );\n}\n\nfunction extensionSourcePath(extensionId: string): string {\n assert(\n /^[A-Za-z0-9._-]+$/u.test(extensionId),\n `Embedded extension ID cannot be used as a filename: ${JSON.stringify(extensionId)}`,\n );\n return `extensions/${extensionId}.js`;\n}\n\nasync function readExistingExtensionSources(\n outputDirectory: string,\n): Promise<Map<string, ExtensionSource>> {\n if (!(await pathExists(outputDirectory))) {\n return new Map();\n }\n\n const manifestPath = path.join(outputDirectory, 'embedded-extensions.json');\n if (!(await pathExists(manifestPath))) {\n return new Map();\n }\n\n let manifest: unknown;\n try {\n manifest = JSON.parse(await readFile(manifestPath, 'utf8'));\n } catch (error) {\n throw new Error(`Existing embedded extension manifest is not valid JSON: ${manifestPath}`, {\n cause: error,\n });\n }\n assert(\n isObject(manifest) && Array.isArray(manifest.extensions),\n `Existing embedded extension manifest is invalid: ${manifestPath}`,\n );\n\n const sources = new Map<string, ExtensionSource>();\n for (const extension of manifest.extensions as unknown[]) {\n if (\n !isObject(extension) ||\n typeof extension.id !== 'string' ||\n typeof extension.path !== 'string' ||\n extension.source === undefined\n ) {\n continue;\n }\n sources.set(`${extension.id}\\u0000${extension.path}`, extension.source as ExtensionSource);\n }\n return sources;\n}\n\nexport function decodeExtensionDataUrl(dataUrl: unknown): DecodedExtensionDataUrl {\n assert(\n typeof dataUrl === 'string' && dataUrl.startsWith('data:'),\n 'Embedded extension URL must be a data URL.',\n );\n const commaIndex = dataUrl.indexOf(',');\n assert(commaIndex >= 0, 'Embedded extension data URL has no payload separator.');\n\n const metadata = dataUrl.slice('data:'.length, commaIndex).split(';');\n const mediaType = metadata.shift() || 'text/plain';\n const base64Index = metadata.indexOf('base64');\n const encoding: ExtensionEncoding = base64Index >= 0 ? 'base64' : 'percent';\n if (base64Index >= 0) {\n metadata.splice(base64Index, 1);\n }\n\n const payload = dataUrl.slice(commaIndex + 1);\n let source: Buffer;\n if (encoding === 'base64') {\n assert(\n /^[A-Za-z0-9+/]*={0,2}$/u.test(payload),\n 'Embedded extension data URL contains invalid base64.',\n );\n const unpaddedPayload = payload.replace(/=+$/u, '');\n assert(\n unpaddedPayload.length % 4 !== 1,\n 'Embedded extension data URL contains invalid base64.',\n );\n source = Buffer.from(\n unpaddedPayload.padEnd(Math.ceil(unpaddedPayload.length / 4) * 4, '='),\n 'base64',\n );\n } else {\n try {\n source = Buffer.from(decodeURIComponent(payload), 'utf8');\n } catch {\n throw new Error('Embedded extension data URL contains invalid percent encoding.');\n }\n }\n\n return {\n encoding,\n mediaType,\n parameters: metadata,\n source,\n };\n}\n\nexport async function importSb3({\n inputPath,\n outputDirectory,\n protectedRoot = process.cwd(),\n discardLocalChanges = false,\n yes = false,\n confirmReplace,\n}: ImportSb3Options): Promise<ImportSb3Result> {\n assert(typeof inputPath === 'string', 'Input SB3 path is required.');\n assert(typeof outputDirectory === 'string', 'SB3 source output directory is required.');\n const resolvedInputPath = path.resolve(inputPath);\n const resolvedOutputDirectory = validateOutputDirectoryPath(outputDirectory, protectedRoot);\n\n const archive = unzipSync(new Uint8Array(await readFile(resolvedInputPath)));\n const archiveEntries = Object.entries(archive);\n assert(archiveEntries.length > 0, 'SB3 archive is empty.');\n for (const [entryName] of archiveEntries) {\n validateArchiveEntryName(entryName);\n }\n\n const projectEntry = archive['project.json'];\n assert(projectEntry, 'SB3 archive does not contain project.json.');\n\n let project: unknown;\n let decision: OutputReplacementDecision | undefined;\n let rollbackCleanupWarning: string | null = null;\n try {\n project = JSON.parse(strFromU8(projectEntry));\n } catch (error) {\n throw new Error(`SB3 project.json is invalid JSON: ${errorMessage(error)}`, {cause: error});\n }\n assert(isObject(project), 'SB3 project.json must contain a JSON object.');\n const projectJson: ProjectJson = project;\n\n const extensionUrls: unknown = projectJson.extensionURLs ?? {};\n assert(isObject(extensionUrls), 'SB3 project.json extensionURLs must be an object when present.');\n\n const existingExtensionSources = await readExistingExtensionSources(resolvedOutputDirectory);\n const embeddedExtensions: EmbeddedExtension[] = [];\n const decodedExtensionSources: {path: string; source: Buffer}[] = [];\n for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {\n if (typeof extensionUrl !== 'string' || !extensionUrl.startsWith('data:')) {\n continue;\n }\n const sourcePath = extensionSourcePath(extensionId);\n const decoded = decodeExtensionDataUrl(extensionUrl);\n extensionUrls[extensionId] = `embedded-extension:${sourcePath}`;\n const extension: EmbeddedExtension = {\n id: extensionId,\n path: sourcePath,\n mediaType: decoded.mediaType,\n parameters: decoded.parameters,\n encoding: decoded.encoding,\n };\n const existingSource = existingExtensionSources.get(`${extensionId}\\u0000${sourcePath}`);\n let existingApiManifestContents: Buffer | null = null;\n if (existingSource !== undefined) {\n extension.source = structuredClone(existingSource);\n validateManagedExtensionContents(extension, decoded.source);\n if (extension.source.apiManifest) {\n existingApiManifestContents = await readFile(\n path.join(resolvedOutputDirectory, extension.source.apiManifest.path),\n );\n validateManagedExtensionApiManifest(extension, existingApiManifestContents);\n }\n }\n embeddedExtensions.push(extension);\n decodedExtensionSources.push({path: sourcePath, source: decoded.source});\n if (existingApiManifestContents && extension.source?.apiManifest) {\n decodedExtensionSources.push({\n path: extension.source.apiManifest.path,\n source: existingApiManifestContents,\n });\n }\n }\n\n const outputParent = path.dirname(resolvedOutputDirectory);\n await mkdir(outputParent, {recursive: true});\n const temporaryDirectory = await mkdtemp(\n path.join(outputParent, `.${path.basename(resolvedOutputDirectory)}.import-`),\n );\n\n try {\n const assetsDirectory = path.join(temporaryDirectory, 'assets');\n await mkdir(assetsDirectory, {recursive: true});\n await mkdir(path.join(temporaryDirectory, 'extensions'), {recursive: true});\n\n for (const [entryName, contents] of archiveEntries) {\n if (entryName === 'project.json' || entryName.endsWith('/')) {\n continue;\n }\n const assetPath = path.resolve(assetsDirectory, entryName);\n assert(\n assetPath.startsWith(`${assetsDirectory}${path.sep}`),\n `SB3 archive entry escapes the assets directory: ${JSON.stringify(entryName)}`,\n );\n await mkdir(path.dirname(assetPath), {recursive: true});\n await writeFile(assetPath, contents);\n }\n\n for (const extension of decodedExtensionSources) {\n await writeFile(path.join(temporaryDirectory, extension.path), extension.source);\n }\n\n const sourceManifest = {\n formatVersion: sourceFormatVersion,\n project: 'project.source.json',\n embeddedExtensions: 'embedded-extensions.json',\n assetsDirectory: 'assets',\n archiveEntries: archiveEntries.map(([entryName]) => entryName),\n };\n await Promise.all([\n writeFile(\n path.join(temporaryDirectory, 'project.source.json'),\n `${JSON.stringify(projectJson, null, 2)}\\n`,\n ),\n writeFile(\n path.join(temporaryDirectory, 'embedded-extensions.json'),\n `${JSON.stringify({formatVersion: sourceFormatVersion, extensions: embeddedExtensions}, null, 2)}\\n`,\n ),\n writeFile(\n path.join(temporaryDirectory, 'sb3-source.json'),\n `${JSON.stringify(sourceManifest, null, 2)}\\n`,\n ),\n ]);\n decision = await authorizeOutputReplacement({\n candidateDirectory: temporaryDirectory,\n confirmReplace,\n discardLocalChanges,\n outputDirectory: resolvedOutputDirectory,\n yes,\n });\n if (decision.action === 'unchanged') {\n await rm(temporaryDirectory, {recursive: true, force: true});\n } else {\n if (decision.action === 'replace') {\n await revalidateOutputReplacement({\n candidateDirectory: temporaryDirectory,\n decision: decision as OutputReplacementContext,\n discardLocalChanges,\n outputDirectory: resolvedOutputDirectory,\n });\n }\n ({rollbackCleanupWarning} = await replaceDirectoryTransactionally(\n temporaryDirectory,\n resolvedOutputDirectory,\n ));\n }\n } catch (error) {\n await rm(temporaryDirectory, {recursive: true, force: true});\n throw error;\n }\n\n return {\n archiveEntryCount: archiveEntries.length,\n assetCount: archiveEntries.filter(\n ([entryName]) => entryName !== 'project.json' && !entryName.endsWith('/'),\n ).length,\n embeddedExtensionCount: embeddedExtensions.length,\n changed: decision.action !== 'unchanged',\n differenceCounts: decision.comparison\n ? {\n added: decision.comparison.differences.added.length,\n modified: decision.comparison.differences.modified.length,\n removed: decision.comparison.differences.removed.length,\n }\n : null,\n inputPath: resolvedInputPath,\n outputDirectory: resolvedOutputDirectory,\n rollbackCleanupWarning,\n };\n}\n"],"mappings":";;;;;;;;;;;AA2EA,SAAS,SAAS,OAAwC;CACxD,OAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAS,oBAAoB,UAAkC;CAC7D,MAAM,UAAU,CACd,GAAG,SAAS,eACZ,GAAG,SAAS,iBAAiB,KAAK,UAAU,gBAAgB,OAAO,CACrE;CAGA,OAAO,GAFgB,QAAQ,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,IAEtC,IADQ,QAAQ,SAAS,IAAI,SAAS,QAAQ,SAAS,EAAE,SAAS;AAE9E;AAEA,eAAe,2BAA2B,EACxC,oBACA,gBACA,qBACA,iBACA,OAOqC;CACrC,MAAM,4BAA4B,eAAe;CACjD,IAAI,CAAE,MAAM,WAAW,eAAe,GACpC,OAAO;EAAC,QAAQ;EAAU,YAAY;EAAM,UAAU;CAAI;CAG5D,MAAM,gCAAgC,iBAAA,CAAoC;CAC1E,MAAM,aAAa,MAAM,mBAAmB,iBAAiB,kBAAkB;CAC/E,IAAI,WAAW,WACb,OAAO;EAAC,QAAQ;EAAa;EAAY,UAAU;CAAI;CAGzD,MAAM,WAAW,MAAM,sBAAsB,iBAAiB,WAAW,iBAAiB;CAC1F,OACE,SAAS,SACT,6EAA6E,gBAAgB,+EAE/F;CACA,OACE,SAAS,SAAS,qBAClB,mFACK,oBAAoB,QAAQ,EAAE,yEAErC;CAEA,MAAM,UAAU;EACd;EACA;EACA;EACA;CACF;CACA,IAAI,KACF,OAAO;EAAC,QAAQ;EAAW,GAAG;CAAO;CAEvC,OACE,OAAO,mBAAmB,YAC1B,oCAAoC,gBAAgB,mFAEtD;CACA,OACE,MAAM,eAAe,OAAO,GAC5B,4DACF;CACA,OAAO;EAAC,QAAQ;EAAW,GAAG;CAAO;AACvC;AAEA,eAAe,4BAA4B,EACzC,oBACA,UACA,qBACA,mBAMgB;CAChB,MAAM,mBAAmB,MAAM,mBAAmB,iBAAiB,kBAAkB;CACrF,OACE,iBAAiB,wBAAwB,SAAS,WAAW,uBAC3D,iBAAiB,yBAAyB,SAAS,WAAW,sBAChE,gFACF;CACA,MAAM,iBAAiB,MAAM,sBAC3B,iBACA,iBAAiB,iBACnB;CACA,OACE,eAAe,SACf,6EACF;CACA,OACE,eAAe,gBAAgB,SAAS,SAAS,aACjD,sEACF;CACA,OACE,eAAe,SAAS,qBACxB,kFACF;AACF;AAEA,SAAS,oBAAoB,aAA6B;CACxD,OACE,qBAAqB,KAAK,WAAW,GACrC,uDAAuD,KAAK,UAAU,WAAW,GACnF;CACA,OAAO,cAAc,YAAY;AACnC;AAEA,eAAe,6BACb,iBACuC;CACvC,IAAI,CAAE,MAAM,WAAW,eAAe,GACpC,uBAAO,IAAI,IAAI;CAGjB,MAAM,eAAe,KAAK,KAAK,iBAAiB,0BAA0B;CAC1E,IAAI,CAAE,MAAM,WAAW,YAAY,GACjC,uBAAO,IAAI,IAAI;CAGjB,IAAI;CACJ,IAAI;EACF,WAAW,KAAK,MAAM,MAAM,SAAS,cAAc,MAAM,CAAC;CAC5D,SAAS,OAAO;EACd,MAAM,IAAI,MAAM,2DAA2D,gBAAgB,EACzF,OAAO,MACT,CAAC;CACH;CACA,OACE,SAAS,QAAQ,KAAK,MAAM,QAAQ,SAAS,UAAU,GACvD,oDAAoD,cACtD;CAEA,MAAM,0BAAU,IAAI,IAA6B;CACjD,KAAK,MAAM,aAAa,SAAS,YAAyB;EACxD,IACE,CAAC,SAAS,SAAS,KACnB,OAAO,UAAU,OAAO,YACxB,OAAO,UAAU,SAAS,YAC1B,UAAU,WAAW,KAAA,GAErB;EAEF,QAAQ,IAAI,GAAG,UAAU,GAAG,QAAQ,UAAU,QAAQ,UAAU,MAAyB;CAC3F;CACA,OAAO;AACT;AAEA,SAAgB,uBAAuB,SAA2C;CAChF,OACE,OAAO,YAAY,YAAY,QAAQ,WAAW,OAAO,GACzD,4CACF;CACA,MAAM,aAAa,QAAQ,QAAQ,GAAG;CACtC,OAAO,cAAc,GAAG,uDAAuD;CAE/E,MAAM,WAAW,QAAQ,MAAM,GAAgB,UAAU,CAAC,CAAC,MAAM,GAAG;CACpE,MAAM,YAAY,SAAS,MAAM,KAAK;CACtC,MAAM,cAAc,SAAS,QAAQ,QAAQ;CAC7C,MAAM,WAA8B,eAAe,IAAI,WAAW;CAClE,IAAI,eAAe,GACjB,SAAS,OAAO,aAAa,CAAC;CAGhC,MAAM,UAAU,QAAQ,MAAM,aAAa,CAAC;CAC5C,IAAI;CACJ,IAAI,aAAa,UAAU;EACzB,OACE,0BAA0B,KAAK,OAAO,GACtC,sDACF;EACA,MAAM,kBAAkB,QAAQ,QAAQ,QAAQ,EAAE;EAClD,OACE,gBAAgB,SAAS,MAAM,GAC/B,sDACF;EACA,SAAS,OAAO,KACd,gBAAgB,OAAO,KAAK,KAAK,gBAAgB,SAAS,CAAC,IAAI,GAAG,GAAG,GACrE,QACF;CACF,OACE,IAAI;EACF,SAAS,OAAO,KAAK,mBAAmB,OAAO,GAAG,MAAM;CAC1D,QAAQ;EACN,MAAM,IAAI,MAAM,gEAAgE;CAClF;CAGF,OAAO;EACL;EACA;EACA,YAAY;EACZ;CACF;AACF;AAEA,eAAsB,UAAU,EAC9B,WACA,iBACA,gBAAgB,QAAQ,IAAI,GAC5B,sBAAsB,OACtB,MAAM,OACN,kBAC6C;CAC7C,OAAO,OAAO,cAAc,UAAU,6BAA6B;CACnE,OAAO,OAAO,oBAAoB,UAAU,0CAA0C;CACtF,MAAM,oBAAoB,KAAK,QAAQ,SAAS;CAChD,MAAM,0BAA0B,4BAA4B,iBAAiB,aAAa;CAE1F,MAAM,UAAU,UAAU,IAAI,WAAW,MAAM,SAAS,iBAAiB,CAAC,CAAC;CAC3E,MAAM,iBAAiB,OAAO,QAAQ,OAAO;CAC7C,OAAO,eAAe,SAAS,GAAG,uBAAuB;CACzD,KAAK,MAAM,CAAC,cAAc,gBACxB,yBAAyB,SAAS;CAGpC,MAAM,eAAe,QAAQ;CAC7B,OAAO,cAAc,4CAA4C;CAEjE,IAAI;CACJ,IAAI;CACJ,IAAI,yBAAwC;CAC5C,IAAI;EACF,UAAU,KAAK,MAAM,UAAU,YAAY,CAAC;CAC9C,SAAS,OAAO;EACd,MAAM,IAAI,MAAM,qCAAqC,aAAa,KAAK,KAAK,EAAC,OAAO,MAAK,CAAC;CAC5F;CACA,OAAO,SAAS,OAAO,GAAG,8CAA8C;CACxE,MAAM,cAA2B;CAEjC,MAAM,gBAAyB,YAAY,iBAAiB,CAAC;CAC7D,OAAO,SAAS,aAAa,GAAG,gEAAgE;CAEhG,MAAM,2BAA2B,MAAM,6BAA6B,uBAAuB;CAC3F,MAAM,qBAA0C,CAAC;CACjD,MAAM,0BAA4D,CAAC;CACnE,KAAK,MAAM,CAAC,aAAa,iBAAiB,OAAO,QAAQ,aAAa,GAAG;EACvE,IAAI,OAAO,iBAAiB,YAAY,CAAC,aAAa,WAAW,OAAO,GACtE;EAEF,MAAM,aAAa,oBAAoB,WAAW;EAClD,MAAM,UAAU,uBAAuB,YAAY;EACnD,cAAc,eAAe,sBAAsB;EACnD,MAAM,YAA+B;GACnC,IAAI;GACJ,MAAM;GACN,WAAW,QAAQ;GACnB,YAAY,QAAQ;GACpB,UAAU,QAAQ;EACpB;EACA,MAAM,iBAAiB,yBAAyB,IAAI,GAAG,YAAY,QAAQ,YAAY;EACvF,IAAI,8BAA6C;EACjD,IAAI,mBAAmB,KAAA,GAAW;GAChC,UAAU,SAAS,gBAAgB,cAAc;GACjD,iCAAiC,WAAW,QAAQ,MAAM;GAC1D,IAAI,UAAU,OAAO,aAAa;IAChC,8BAA8B,MAAM,SAClC,KAAK,KAAK,yBAAyB,UAAU,OAAO,YAAY,IAAI,CACtE;IACA,oCAAoC,WAAW,2BAA2B;GAC5E;EACF;EACA,mBAAmB,KAAK,SAAS;EACjC,wBAAwB,KAAK;GAAC,MAAM;GAAY,QAAQ,QAAQ;EAAM,CAAC;EACvE,IAAI,+BAA+B,UAAU,QAAQ,aACnD,wBAAwB,KAAK;GAC3B,MAAM,UAAU,OAAO,YAAY;GACnC,QAAQ;EACV,CAAC;CAEL;CAEA,MAAM,eAAe,KAAK,QAAQ,uBAAuB;CACzD,MAAM,MAAM,cAAc,EAAC,WAAW,KAAI,CAAC;CAC3C,MAAM,qBAAqB,MAAM,QAC/B,KAAK,KAAK,cAAc,IAAI,KAAK,SAAS,uBAAuB,EAAE,SAAS,CAC9E;CAEA,IAAI;EACF,MAAM,kBAAkB,KAAK,KAAK,oBAAoB,QAAQ;EAC9D,MAAM,MAAM,iBAAiB,EAAC,WAAW,KAAI,CAAC;EAC9C,MAAM,MAAM,KAAK,KAAK,oBAAoB,YAAY,GAAG,EAAC,WAAW,KAAI,CAAC;EAE1E,KAAK,MAAM,CAAC,WAAW,aAAa,gBAAgB;GAClD,IAAI,cAAc,kBAAkB,UAAU,SAAS,GAAG,GACxD;GAEF,MAAM,YAAY,KAAK,QAAQ,iBAAiB,SAAS;GACzD,OACE,UAAU,WAAW,GAAG,kBAAkB,KAAK,KAAK,GACpD,mDAAmD,KAAK,UAAU,SAAS,GAC7E;GACA,MAAM,MAAM,KAAK,QAAQ,SAAS,GAAG,EAAC,WAAW,KAAI,CAAC;GACtD,MAAM,UAAU,WAAW,QAAQ;EACrC;EAEA,KAAK,MAAM,aAAa,yBACtB,MAAM,UAAU,KAAK,KAAK,oBAAoB,UAAU,IAAI,GAAG,UAAU,MAAM;EAGjF,MAAM,iBAAiB;GACrB,eAAA;GACA,SAAS;GACT,oBAAoB;GACpB,iBAAiB;GACjB,gBAAgB,eAAe,KAAK,CAAC,eAAe,SAAS;EAC/D;EACA,MAAM,QAAQ,IAAI;GAChB,UACE,KAAK,KAAK,oBAAoB,qBAAqB,GACnD,GAAG,KAAK,UAAU,aAAa,MAAM,CAAC,EAAE,GAC1C;GACA,UACE,KAAK,KAAK,oBAAoB,0BAA0B,GACxD,GAAG,KAAK,UAAU;IAAC,eAAA;IAAoC,YAAY;GAAkB,GAAG,MAAM,CAAC,EAAE,GACnG;GACA,UACE,KAAK,KAAK,oBAAoB,iBAAiB,GAC/C,GAAG,KAAK,UAAU,gBAAgB,MAAM,CAAC,EAAE,GAC7C;EACF,CAAC;EACD,WAAW,MAAM,2BAA2B;GAC1C,oBAAoB;GACpB;GACA;GACA,iBAAiB;GACjB;EACF,CAAC;EACD,IAAI,SAAS,WAAW,aACtB,MAAM,GAAG,oBAAoB;GAAC,WAAW;GAAM,OAAO;EAAI,CAAC;OACtD;GACL,IAAI,SAAS,WAAW,WACtB,MAAM,4BAA4B;IAChC,oBAAoB;IACV;IACV;IACA,iBAAiB;GACnB,CAAC;GAEH,CAAC,CAAC,0BAA0B,MAAM,gCAChC,oBACA,uBACF;EACF;CACF,SAAS,OAAO;EACd,MAAM,GAAG,oBAAoB;GAAC,WAAW;GAAM,OAAO;EAAI,CAAC;EAC3D,MAAM;CACR;CAEA,OAAO;EACL,mBAAmB,eAAe;EAClC,YAAY,eAAe,QACxB,CAAC,eAAe,cAAc,kBAAkB,CAAC,UAAU,SAAS,GAAG,CAC1E,CAAC,CAAC;EACF,wBAAwB,mBAAmB;EAC3C,SAAS,SAAS,WAAW;EAC7B,kBAAkB,SAAS,aACvB;GACE,OAAO,SAAS,WAAW,YAAY,MAAM;GAC7C,UAAU,SAAS,WAAW,YAAY,SAAS;GACnD,SAAS,SAAS,WAAW,YAAY,QAAQ;EACnD,IACA;EACJ,WAAW;EACX,iBAAiB;EACjB;CACF;AACF"}
|
|
1
|
+
{"version":3,"file":"import.js","names":[],"sources":["../src/import.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {mkdir, mkdtemp, readFile, rm, writeFile} from 'node:fs/promises';\nimport path from 'node:path';\nimport process from 'node:process';\n\nimport {assert} from './assert';\nimport {decodeExtensionBytes, expandArchive, formatSourceFiles} from './expand-archive';\nimport {validateManagedExtensionApiManifest} from './extension-api-manifest';\nimport {validateManagedExtensionContents} from './extension-dependencies';\nimport {\n assertNoInterruptedRollback,\n assertRecognizedOutputDirectory,\n compareDirectories,\n inspectGitOutputState,\n pathExists,\n replaceDirectoryTransactionally,\n validateOutputDirectoryPath,\n} from './output-safety';\nimport type {DirectoryComparison, GitOutputState} from './output-safety';\nimport {isObject, sourceFormatVersion} from './source-format';\nimport type {ExtensionEncoding, ExtensionSource} from './types';\n\nexport {validateOutputDirectoryPath} from './output-safety';\n\nexport interface DecodedExtensionDataUrl {\n encoding: ExtensionEncoding;\n mediaType: string;\n parameters: string[];\n source: Buffer;\n}\n\nexport interface OutputReplacementContext {\n comparison: DirectoryComparison;\n discardLocalChanges: boolean;\n gitState: GitOutputState;\n outputDirectory: string;\n}\n\ninterface OutputReplacementDecision {\n action: 'create' | 'unchanged' | 'replace';\n comparison: DirectoryComparison | null;\n discardLocalChanges?: boolean;\n gitState: GitOutputState | null;\n outputDirectory?: string;\n}\n\nexport interface ImportSb3Options {\n confirmReplace?: (context: OutputReplacementContext) => boolean | Promise<boolean>;\n discardLocalChanges?: boolean;\n inputPath: string;\n outputDirectory: string;\n protectedRoot?: string;\n yes?: boolean;\n}\n\nexport interface ImportSb3Result {\n archiveEntryCount: number;\n assetCount: number;\n changed: boolean;\n differenceCounts: {added: number; modified: number; removed: number} | null;\n embeddedExtensionCount: number;\n inputPath: string;\n outputDirectory: string;\n rollbackCleanupWarning: string | null;\n}\n\nfunction summarizeGitChanges(gitState: GitOutputState): string {\n const entries = [\n ...gitState.statusEntries,\n ...gitState.untrackedContent.map((entry) => `not tracked: ${entry}`),\n ];\n const visibleEntries = entries.slice(0, 8).join(', ');\n const remainder = entries.length > 8 ? `, and ${entries.length - 8} more` : '';\n return `${visibleEntries}${remainder}`;\n}\n\nasync function authorizeOutputReplacement({\n candidateDirectory,\n confirmReplace,\n discardLocalChanges,\n outputDirectory,\n yes,\n}: {\n candidateDirectory: string;\n confirmReplace?: (context: OutputReplacementContext) => boolean | Promise<boolean>;\n discardLocalChanges: boolean;\n outputDirectory: string;\n yes: boolean;\n}): Promise<OutputReplacementDecision> {\n await assertNoInterruptedRollback(outputDirectory);\n if (!(await pathExists(outputDirectory))) {\n return {action: 'create', comparison: null, gitState: null};\n }\n\n await assertRecognizedOutputDirectory(outputDirectory, sourceFormatVersion);\n const comparison = await compareDirectories(outputDirectory, candidateDirectory);\n if (comparison.identical) {\n return {action: 'unchanged', comparison, gitState: null};\n }\n\n const gitState = await inspectGitOutputState(outputDirectory, comparison.existingFilePaths);\n assert(\n gitState.managed,\n `Existing output differs from the SB3 candidate but is not tracked by Git: ${outputDirectory}. ` +\n 'Import to a new output directory instead of replacing unrecoverable content.',\n );\n assert(\n gitState.clean || discardLocalChanges,\n `Existing output differs from the SB3 candidate and has uncommitted Git changes: ` +\n `${summarizeGitChanges(gitState)}. Commit or stash them first, or explicitly use ` +\n '--discard-local-changes.',\n );\n\n const context = {\n comparison,\n discardLocalChanges,\n gitState,\n outputDirectory,\n };\n if (yes) {\n return {action: 'replace', ...context};\n }\n assert(\n typeof confirmReplace === 'function',\n `Output directory already exists: ${outputDirectory}. ` +\n 'Refusing to replace differing content without interactive confirmation or --yes.',\n );\n assert(\n await confirmReplace(context),\n 'SB3 import cancelled; the existing output was not changed.',\n );\n return {action: 'replace', ...context};\n}\n\nasync function revalidateOutputReplacement({\n candidateDirectory,\n decision,\n discardLocalChanges,\n outputDirectory,\n}: {\n candidateDirectory: string;\n decision: OutputReplacementContext;\n discardLocalChanges: boolean;\n outputDirectory: string;\n}): Promise<void> {\n const latestComparison = await compareDirectories(outputDirectory, candidateDirectory);\n assert(\n latestComparison.existingFingerprint === decision.comparison.existingFingerprint &&\n latestComparison.candidateFingerprint === decision.comparison.candidateFingerprint,\n 'Output or candidate content changed during SB3 import; refusing to replace it.',\n );\n const latestGitState = await inspectGitOutputState(\n outputDirectory,\n latestComparison.existingFilePaths,\n );\n assert(\n latestGitState.managed,\n 'Output stopped being Git-managed during SB3 import; refusing to replace it.',\n );\n assert(\n latestGitState.fingerprint === decision.gitState.fingerprint,\n 'Git state changed during SB3 import; refusing to replace the output.',\n );\n assert(\n latestGitState.clean || discardLocalChanges,\n 'Output gained uncommitted Git changes during SB3 import; refusing to replace it.',\n );\n}\n\nasync function readExistingExtensionSources(\n outputDirectory: string,\n): Promise<Map<string, ExtensionSource>> {\n if (!(await pathExists(outputDirectory))) {\n return new Map();\n }\n\n const manifestPath = path.join(outputDirectory, 'embedded-extensions.json');\n if (!(await pathExists(manifestPath))) {\n return new Map();\n }\n\n let manifest: unknown;\n try {\n manifest = JSON.parse(await readFile(manifestPath, 'utf8'));\n } catch (error) {\n throw new Error(`Existing embedded extension manifest is not valid JSON: ${manifestPath}`, {\n cause: error,\n });\n }\n assert(\n isObject(manifest) && Array.isArray(manifest.extensions),\n `Existing embedded extension manifest is invalid: ${manifestPath}`,\n );\n\n const sources = new Map<string, ExtensionSource>();\n for (const extension of manifest.extensions as unknown[]) {\n if (\n !isObject(extension) ||\n typeof extension.id !== 'string' ||\n typeof extension.path !== 'string' ||\n extension.source === undefined\n ) {\n continue;\n }\n sources.set(`${extension.id}\\u0000${extension.path}`, extension.source as ExtensionSource);\n }\n return sources;\n}\n\nexport function decodeExtensionDataUrl(dataUrl: unknown): DecodedExtensionDataUrl {\n const decoded = decodeExtensionBytes(dataUrl);\n return {...decoded, source: Buffer.from(decoded.source)};\n}\n\nexport async function importSb3({\n inputPath,\n outputDirectory,\n protectedRoot = process.cwd(),\n discardLocalChanges = false,\n yes = false,\n confirmReplace,\n}: ImportSb3Options): Promise<ImportSb3Result> {\n assert(typeof inputPath === 'string', 'Input SB3 path is required.');\n assert(typeof outputDirectory === 'string', 'SB3 source output directory is required.');\n const resolvedInputPath = path.resolve(inputPath);\n const resolvedOutputDirectory = validateOutputDirectoryPath(outputDirectory, protectedRoot);\n\n const expanded = expandArchive(await readFile(resolvedInputPath));\n const existingSources = await readExistingExtensionSources(resolvedOutputDirectory);\n for (const extension of expanded.embeddedExtensions) {\n const source = existingSources.get(`${extension.id}\\u0000${extension.path}`);\n if (source === undefined) continue;\n extension.source = structuredClone(source);\n validateManagedExtensionContents(extension, expanded.extensionFiles.get(extension.path)!);\n if (extension.source.apiManifest) {\n const contents = await readFile(\n path.join(resolvedOutputDirectory, extension.source.apiManifest.path),\n );\n validateManagedExtensionApiManifest(extension, contents);\n expanded.extensionFiles.set(extension.source.apiManifest.path, contents);\n }\n }\n let decision: OutputReplacementDecision | undefined;\n let rollbackCleanupWarning: string | null = null;\n\n const outputParent = path.dirname(resolvedOutputDirectory);\n await mkdir(outputParent, {recursive: true});\n const temporaryDirectory = await mkdtemp(\n path.join(outputParent, `.${path.basename(resolvedOutputDirectory)}.import-`),\n );\n\n try {\n await mkdir(path.join(temporaryDirectory, 'assets'), {recursive: true});\n await mkdir(path.join(temporaryDirectory, 'extensions'), {recursive: true});\n for (const [name, contents] of formatSourceFiles(expanded)) {\n const outputPath = path.resolve(temporaryDirectory, name);\n assert(\n outputPath.startsWith(`${temporaryDirectory}${path.sep}`),\n `SB3 archive entry escapes the source directory: ${JSON.stringify(name)}`,\n );\n await mkdir(path.dirname(outputPath), {recursive: true});\n await writeFile(outputPath, contents);\n }\n decision = await authorizeOutputReplacement({\n candidateDirectory: temporaryDirectory,\n confirmReplace,\n discardLocalChanges,\n outputDirectory: resolvedOutputDirectory,\n yes,\n });\n if (decision.action === 'unchanged') {\n await rm(temporaryDirectory, {recursive: true, force: true});\n } else {\n if (decision.action === 'replace') {\n await revalidateOutputReplacement({\n candidateDirectory: temporaryDirectory,\n decision: decision as OutputReplacementContext,\n discardLocalChanges,\n outputDirectory: resolvedOutputDirectory,\n });\n }\n ({rollbackCleanupWarning} = await replaceDirectoryTransactionally(\n temporaryDirectory,\n resolvedOutputDirectory,\n ));\n }\n } catch (error) {\n await rm(temporaryDirectory, {recursive: true, force: true});\n throw error;\n }\n\n return {\n archiveEntryCount: expanded.archiveEntries.length,\n assetCount: expanded.assets.size,\n embeddedExtensionCount: expanded.embeddedExtensions.length,\n changed: decision.action !== 'unchanged',\n differenceCounts: decision.comparison\n ? {\n added: decision.comparison.differences.added.length,\n modified: decision.comparison.differences.modified.length,\n removed: decision.comparison.differences.removed.length,\n }\n : null,\n inputPath: resolvedInputPath,\n outputDirectory: resolvedOutputDirectory,\n rollbackCleanupWarning,\n };\n}\n"],"mappings":";;;;;;;;;;AAmEA,SAAS,oBAAoB,UAAkC;CAC7D,MAAM,UAAU,CACd,GAAG,SAAS,eACZ,GAAG,SAAS,iBAAiB,KAAK,UAAU,gBAAgB,OAAO,CACrE;CAGA,OAAO,GAFgB,QAAQ,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,IAEtC,IADQ,QAAQ,SAAS,IAAI,SAAS,QAAQ,SAAS,EAAE,SAAS;AAE9E;AAEA,eAAe,2BAA2B,EACxC,oBACA,gBACA,qBACA,iBACA,OAOqC;CACrC,MAAM,4BAA4B,eAAe;CACjD,IAAI,CAAE,MAAM,WAAW,eAAe,GACpC,OAAO;EAAC,QAAQ;EAAU,YAAY;EAAM,UAAU;CAAI;CAG5D,MAAM,gCAAgC,iBAAA,CAAoC;CAC1E,MAAM,aAAa,MAAM,mBAAmB,iBAAiB,kBAAkB;CAC/E,IAAI,WAAW,WACb,OAAO;EAAC,QAAQ;EAAa;EAAY,UAAU;CAAI;CAGzD,MAAM,WAAW,MAAM,sBAAsB,iBAAiB,WAAW,iBAAiB;CAC1F,OACE,SAAS,SACT,6EAA6E,gBAAgB,+EAE/F;CACA,OACE,SAAS,SAAS,qBAClB,mFACK,oBAAoB,QAAQ,EAAE,yEAErC;CAEA,MAAM,UAAU;EACd;EACA;EACA;EACA;CACF;CACA,IAAI,KACF,OAAO;EAAC,QAAQ;EAAW,GAAG;CAAO;CAEvC,OACE,OAAO,mBAAmB,YAC1B,oCAAoC,gBAAgB,mFAEtD;CACA,OACE,MAAM,eAAe,OAAO,GAC5B,4DACF;CACA,OAAO;EAAC,QAAQ;EAAW,GAAG;CAAO;AACvC;AAEA,eAAe,4BAA4B,EACzC,oBACA,UACA,qBACA,mBAMgB;CAChB,MAAM,mBAAmB,MAAM,mBAAmB,iBAAiB,kBAAkB;CACrF,OACE,iBAAiB,wBAAwB,SAAS,WAAW,uBAC3D,iBAAiB,yBAAyB,SAAS,WAAW,sBAChE,gFACF;CACA,MAAM,iBAAiB,MAAM,sBAC3B,iBACA,iBAAiB,iBACnB;CACA,OACE,eAAe,SACf,6EACF;CACA,OACE,eAAe,gBAAgB,SAAS,SAAS,aACjD,sEACF;CACA,OACE,eAAe,SAAS,qBACxB,kFACF;AACF;AAEA,eAAe,6BACb,iBACuC;CACvC,IAAI,CAAE,MAAM,WAAW,eAAe,GACpC,uBAAO,IAAI,IAAI;CAGjB,MAAM,eAAe,KAAK,KAAK,iBAAiB,0BAA0B;CAC1E,IAAI,CAAE,MAAM,WAAW,YAAY,GACjC,uBAAO,IAAI,IAAI;CAGjB,IAAI;CACJ,IAAI;EACF,WAAW,KAAK,MAAM,MAAM,SAAS,cAAc,MAAM,CAAC;CAC5D,SAAS,OAAO;EACd,MAAM,IAAI,MAAM,2DAA2D,gBAAgB,EACzF,OAAO,MACT,CAAC;CACH;CACA,OACE,SAAS,QAAQ,KAAK,MAAM,QAAQ,SAAS,UAAU,GACvD,oDAAoD,cACtD;CAEA,MAAM,0BAAU,IAAI,IAA6B;CACjD,KAAK,MAAM,aAAa,SAAS,YAAyB;EACxD,IACE,CAAC,SAAS,SAAS,KACnB,OAAO,UAAU,OAAO,YACxB,OAAO,UAAU,SAAS,YAC1B,UAAU,WAAW,KAAA,GAErB;EAEF,QAAQ,IAAI,GAAG,UAAU,GAAG,QAAQ,UAAU,QAAQ,UAAU,MAAyB;CAC3F;CACA,OAAO;AACT;AAEA,SAAgB,uBAAuB,SAA2C;CAChF,MAAM,UAAU,qBAAqB,OAAO;CAC5C,OAAO;EAAC,GAAG;EAAS,QAAQ,OAAO,KAAK,QAAQ,MAAM;CAAC;AACzD;AAEA,eAAsB,UAAU,EAC9B,WACA,iBACA,gBAAgB,QAAQ,IAAI,GAC5B,sBAAsB,OACtB,MAAM,OACN,kBAC6C;CAC7C,OAAO,OAAO,cAAc,UAAU,6BAA6B;CACnE,OAAO,OAAO,oBAAoB,UAAU,0CAA0C;CACtF,MAAM,oBAAoB,KAAK,QAAQ,SAAS;CAChD,MAAM,0BAA0B,4BAA4B,iBAAiB,aAAa;CAE1F,MAAM,WAAW,cAAc,MAAM,SAAS,iBAAiB,CAAC;CAChE,MAAM,kBAAkB,MAAM,6BAA6B,uBAAuB;CAClF,KAAK,MAAM,aAAa,SAAS,oBAAoB;EACnD,MAAM,SAAS,gBAAgB,IAAI,GAAG,UAAU,GAAG,QAAQ,UAAU,MAAM;EAC3E,IAAI,WAAW,KAAA,GAAW;EAC1B,UAAU,SAAS,gBAAgB,MAAM;EACzC,iCAAiC,WAAW,SAAS,eAAe,IAAI,UAAU,IAAI,CAAE;EACxF,IAAI,UAAU,OAAO,aAAa;GAChC,MAAM,WAAW,MAAM,SACrB,KAAK,KAAK,yBAAyB,UAAU,OAAO,YAAY,IAAI,CACtE;GACA,oCAAoC,WAAW,QAAQ;GACvD,SAAS,eAAe,IAAI,UAAU,OAAO,YAAY,MAAM,QAAQ;EACzE;CACF;CACA,IAAI;CACJ,IAAI,yBAAwC;CAE5C,MAAM,eAAe,KAAK,QAAQ,uBAAuB;CACzD,MAAM,MAAM,cAAc,EAAC,WAAW,KAAI,CAAC;CAC3C,MAAM,qBAAqB,MAAM,QAC/B,KAAK,KAAK,cAAc,IAAI,KAAK,SAAS,uBAAuB,EAAE,SAAS,CAC9E;CAEA,IAAI;EACF,MAAM,MAAM,KAAK,KAAK,oBAAoB,QAAQ,GAAG,EAAC,WAAW,KAAI,CAAC;EACtE,MAAM,MAAM,KAAK,KAAK,oBAAoB,YAAY,GAAG,EAAC,WAAW,KAAI,CAAC;EAC1E,KAAK,MAAM,CAAC,MAAM,aAAa,kBAAkB,QAAQ,GAAG;GAC1D,MAAM,aAAa,KAAK,QAAQ,oBAAoB,IAAI;GACxD,OACE,WAAW,WAAW,GAAG,qBAAqB,KAAK,KAAK,GACxD,mDAAmD,KAAK,UAAU,IAAI,GACxE;GACA,MAAM,MAAM,KAAK,QAAQ,UAAU,GAAG,EAAC,WAAW,KAAI,CAAC;GACvD,MAAM,UAAU,YAAY,QAAQ;EACtC;EACA,WAAW,MAAM,2BAA2B;GAC1C,oBAAoB;GACpB;GACA;GACA,iBAAiB;GACjB;EACF,CAAC;EACD,IAAI,SAAS,WAAW,aACtB,MAAM,GAAG,oBAAoB;GAAC,WAAW;GAAM,OAAO;EAAI,CAAC;OACtD;GACL,IAAI,SAAS,WAAW,WACtB,MAAM,4BAA4B;IAChC,oBAAoB;IACV;IACV;IACA,iBAAiB;GACnB,CAAC;GAEH,CAAC,CAAC,0BAA0B,MAAM,gCAChC,oBACA,uBACF;EACF;CACF,SAAS,OAAO;EACd,MAAM,GAAG,oBAAoB;GAAC,WAAW;GAAM,OAAO;EAAI,CAAC;EAC3D,MAAM;CACR;CAEA,OAAO;EACL,mBAAmB,SAAS,eAAe;EAC3C,YAAY,SAAS,OAAO;EAC5B,wBAAwB,SAAS,mBAAmB;EACpD,SAAS,SAAS,WAAW;EAC7B,kBAAkB,SAAS,aACvB;GACE,OAAO,SAAS,WAAW,YAAY,MAAM;GAC7C,UAAU,SAAS,WAAW,YAAY,SAAS;GACnD,SAAS,SAAS,WAAW,YAAY,QAAQ;EACnD,IACA;EACJ,WAAW;EACX,iBAAiB;EACjB;CACF;AACF"}
|
package/dist/index.js
CHANGED
|
@@ -7,7 +7,8 @@ import { buildExtensionBundles, bundleUnsandboxedRequirement, createStaticExtens
|
|
|
7
7
|
import { buildExtensionBundlesWithModules } from "./extension-module-bundle.js";
|
|
8
8
|
import { applyProjectAssetAdditions, projectAssetAdditionsFormatVersion } from "./project-asset-additions.js";
|
|
9
9
|
import { cleanUpTurboWarpBlocks, turboWarpCleanUpLayout } from "./turbowarp-clean-up.js";
|
|
10
|
-
import {
|
|
10
|
+
import { sourceFormatVersion } from "./source-format.js";
|
|
11
|
+
import { createDeterministicSb3, fixedZipTimestamp, validateSb3Source } from "./source.js";
|
|
11
12
|
import { buildSb3 } from "./build.js";
|
|
12
13
|
import { cleanUpSb3, cleanUpSb3Archive } from "./clean-up-sb3.js";
|
|
13
14
|
import { packageName, packageVersion } from "./constants.js";
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { EmbeddedExtension, ProjectJson, Sb3SourceManifest, UnknownRecord } from './types';
|
|
2
|
+
export declare const sourceFormatVersion = 1;
|
|
3
|
+
export declare function isObject(value: unknown): value is UnknownRecord;
|
|
4
|
+
export declare function assertSameFileSet(actualFiles: string[], expectedFiles: string[], description: string): void;
|
|
5
|
+
export declare function validateSourceManifest(manifest: unknown): asserts manifest is Sb3SourceManifest;
|
|
6
|
+
export declare function validateExtensionLayout(extensionManifest: unknown, project: ProjectJson, extensionFiles: string[], validateManagedSource?: (extension: EmbeddedExtension) => unknown): {
|
|
7
|
+
extensionBundles: unknown;
|
|
8
|
+
extensions: EmbeddedExtension[];
|
|
9
|
+
};
|
|
10
|
+
export declare function collectSourceAssetReferences(project: ProjectJson): {
|
|
11
|
+
filename: string;
|
|
12
|
+
description: string;
|
|
13
|
+
}[];
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { assert } from "./assert.js";
|
|
2
|
+
import { validateArchiveEntryName } from "./archive.js";
|
|
3
|
+
//#region src/source-format.ts
|
|
4
|
+
var sourceFormatVersion = 1;
|
|
5
|
+
function isObject(value) {
|
|
6
|
+
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
7
|
+
}
|
|
8
|
+
function assertSameFileSet(actualFiles, expectedFiles, description) {
|
|
9
|
+
const actual = new Set(actualFiles);
|
|
10
|
+
const expected = new Set(expectedFiles);
|
|
11
|
+
const missing = [...expected].filter((filePath) => !actual.has(filePath)).sort();
|
|
12
|
+
const extra = [...actual].filter((filePath) => !expected.has(filePath)).sort();
|
|
13
|
+
assert(missing.length === 0 && extra.length === 0, `${description} does not match its manifest. Missing: ${missing.join(", ") || "(none)"}. Extra: ${extra.join(", ") || "(none)"}.`);
|
|
14
|
+
}
|
|
15
|
+
function validateSourceManifest(manifest) {
|
|
16
|
+
assert(isObject(manifest), "sb3-source.json must contain an object.");
|
|
17
|
+
assert(manifest.formatVersion === 1, `Unsupported SB3 source format version: ${manifest.formatVersion}`);
|
|
18
|
+
assert(manifest.project === "project.source.json", "SB3 source format 1 requires project.source.json.");
|
|
19
|
+
assert(manifest.embeddedExtensions === "embedded-extensions.json", "SB3 source format 1 requires embedded-extensions.json.");
|
|
20
|
+
assert(manifest.assetsDirectory === "assets", "SB3 source format 1 requires the assets directory.");
|
|
21
|
+
assert(Array.isArray(manifest.archiveEntries) && manifest.archiveEntries.length > 0, "sb3-source.json archiveEntries must be a non-empty array.");
|
|
22
|
+
const seenEntries = /* @__PURE__ */ new Set();
|
|
23
|
+
let projectEntryCount = 0;
|
|
24
|
+
for (const rawEntryName of manifest.archiveEntries) {
|
|
25
|
+
const entryName = validateArchiveEntryName(rawEntryName);
|
|
26
|
+
assert(!seenEntries.has(entryName), `Duplicate archive entry in manifest: ${entryName}`);
|
|
27
|
+
assert(!entryName.endsWith("/"), `Directory ZIP entries are not supported in SB3 source format 1: ${entryName}`);
|
|
28
|
+
assert(!/^(?:0|[1-9][0-9]*)$/u.test(entryName), `Integer-like ZIP entry names cannot preserve JavaScript object order: ${entryName}`);
|
|
29
|
+
seenEntries.add(entryName);
|
|
30
|
+
if (entryName === "project.json") projectEntryCount += 1;
|
|
31
|
+
}
|
|
32
|
+
assert(projectEntryCount === 1, "archiveEntries must contain project.json exactly once.");
|
|
33
|
+
}
|
|
34
|
+
function validateExtensionLayout(extensionManifest, project, extensionFiles, validateManagedSource) {
|
|
35
|
+
assert(isObject(extensionManifest), "embedded-extensions.json must contain an object.");
|
|
36
|
+
assert(extensionManifest.formatVersion === 1, `Unsupported embedded extension manifest version: ${extensionManifest.formatVersion}`);
|
|
37
|
+
assert(Array.isArray(extensionManifest.extensions), "embedded-extensions.json extensions must be an array.");
|
|
38
|
+
const extensionUrls = project.extensionURLs ?? {};
|
|
39
|
+
assert(isObject(extensionUrls), "project.source.json extensionURLs must be an object when present.");
|
|
40
|
+
const extensionsById = /* @__PURE__ */ new Map();
|
|
41
|
+
const expectedFiles = [];
|
|
42
|
+
const extensions = [];
|
|
43
|
+
for (const entry of extensionManifest.extensions) {
|
|
44
|
+
assert(isObject(entry), "Each embedded extension manifest entry must be an object.");
|
|
45
|
+
const extension = entry;
|
|
46
|
+
assert(typeof extension.id === "string" && /^[A-Za-z0-9._-]+$/u.test(extension.id), `Invalid embedded extension ID: ${JSON.stringify(extension.id)}`);
|
|
47
|
+
assert(!extensionsById.has(extension.id), `Duplicate embedded extension ID: ${extension.id}`);
|
|
48
|
+
const expectedPath = `extensions/${extension.id}.js`;
|
|
49
|
+
assert(extension.path === expectedPath, `Embedded extension path must match its ID: expected ${expectedPath}, got ${extension.path}`);
|
|
50
|
+
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}`);
|
|
51
|
+
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}.`);
|
|
52
|
+
assert(extension.encoding === "base64" || extension.encoding === "percent", `Unsupported encoding for embedded extension ${extension.id}: ${extension.encoding}`);
|
|
53
|
+
assert(extensionUrls[extension.id] === `embedded-extension:${extension.path}`, `project.source.json mapping does not match embedded extension ${extension.id}.`);
|
|
54
|
+
if (extension.source !== void 0) {
|
|
55
|
+
assert(isObject(extension.source), `Invalid source for embedded extension ${extension.id}.`);
|
|
56
|
+
const sidecar = extension.source.apiManifest;
|
|
57
|
+
assert(sidecar === void 0 || isObject(sidecar) && sidecar.path === `extensions/${extension.id}.manifest.json`, `Invalid API manifest path for embedded extension ${extension.id}.`);
|
|
58
|
+
}
|
|
59
|
+
validateManagedSource?.(extension);
|
|
60
|
+
extensionsById.set(extension.id, extension);
|
|
61
|
+
extensions.push(extension);
|
|
62
|
+
expectedFiles.push(`${extension.id}.js`);
|
|
63
|
+
if (extension.source?.apiManifest) expectedFiles.push(extension.source.apiManifest.path.slice(11));
|
|
64
|
+
}
|
|
65
|
+
for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {
|
|
66
|
+
assert(typeof extensionUrl !== "string" || !extensionUrl.startsWith("data:"), `project.source.json still contains an embedded data URL: ${extensionId}`);
|
|
67
|
+
if (typeof extensionUrl === "string" && extensionUrl.startsWith("embedded-extension:")) assert(extensionsById.has(extensionId), `project.source.json has no metadata for embedded extension ${extensionId}.`);
|
|
68
|
+
}
|
|
69
|
+
assertSameFileSet(extensionFiles, expectedFiles, "Embedded extension files");
|
|
70
|
+
return {
|
|
71
|
+
extensionBundles: extensionManifest.extensionBundles,
|
|
72
|
+
extensions
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
function collectAssetReferences(project) {
|
|
76
|
+
assert(Array.isArray(project.targets), "project.source.json targets must be an array.");
|
|
77
|
+
const references = [];
|
|
78
|
+
for (const [targetIndex, target] of project.targets.entries()) {
|
|
79
|
+
assert(isObject(target), `Project target ${targetIndex} must be an object.`);
|
|
80
|
+
for (const [collectionName, kind] of [["costumes", "costume"], ["sounds", "sound"]]) {
|
|
81
|
+
const assets = target[collectionName] ?? [];
|
|
82
|
+
assert(Array.isArray(assets), `Project target ${targetIndex} ${collectionName} must be an array.`);
|
|
83
|
+
for (const [assetIndex, asset] of assets.entries()) {
|
|
84
|
+
assert(isObject(asset), `Project ${kind} ${targetIndex}:${assetIndex} must be an object.`);
|
|
85
|
+
references.push({
|
|
86
|
+
asset,
|
|
87
|
+
description: `${kind} ${targetIndex}:${assetIndex}`
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
const fonts = project.customFonts ?? [];
|
|
93
|
+
assert(Array.isArray(fonts), "project.source.json customFonts must be an array.");
|
|
94
|
+
for (const [index, font] of fonts.entries()) {
|
|
95
|
+
if (!isObject(font) || font.system !== false || font.md5ext === void 0) continue;
|
|
96
|
+
const md5ext = font.md5ext;
|
|
97
|
+
const match = typeof md5ext === "string" && /^([a-f0-9]{32})\.(ttf|otf|woff2?)$/u.exec(md5ext);
|
|
98
|
+
assert(match, `Invalid font asset reference for font ${index}: ${md5ext}`);
|
|
99
|
+
const [, assetId, dataFormat] = match;
|
|
100
|
+
references.push({
|
|
101
|
+
asset: {
|
|
102
|
+
assetId,
|
|
103
|
+
dataFormat,
|
|
104
|
+
md5ext
|
|
105
|
+
},
|
|
106
|
+
description: `font ${index}`
|
|
107
|
+
});
|
|
108
|
+
}
|
|
109
|
+
return references;
|
|
110
|
+
}
|
|
111
|
+
function collectSourceAssetReferences(project) {
|
|
112
|
+
return collectAssetReferences(project).map(({ asset, description }) => {
|
|
113
|
+
assert(typeof asset.assetId === "string" && /^[a-f0-9]{32}$/u.test(asset.assetId), `Invalid assetId for ${description}: ${asset.assetId}`);
|
|
114
|
+
assert(typeof asset.dataFormat === "string" && /^[A-Za-z0-9]+$/u.test(asset.dataFormat), `Invalid dataFormat for ${description}: ${asset.dataFormat}`);
|
|
115
|
+
const expectedFilename = `${asset.assetId}.${asset.dataFormat}`;
|
|
116
|
+
assert(asset.md5ext === expectedFilename, `Asset filename mismatch for ${description}: expected ${expectedFilename}, got ${asset.md5ext}`);
|
|
117
|
+
return {
|
|
118
|
+
filename: expectedFilename,
|
|
119
|
+
description
|
|
120
|
+
};
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
//#endregion
|
|
124
|
+
export { assertSameFileSet, collectSourceAssetReferences, isObject, sourceFormatVersion, validateExtensionLayout, validateSourceManifest };
|
|
125
|
+
|
|
126
|
+
//# 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 type {\n EmbeddedExtension,\n ProjectAssetReference,\n ProjectJson,\n Sb3SourceManifest,\n UnknownRecord,\n} from './types';\n\nexport const sourceFormatVersion = 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 manifest.formatVersion === sourceFormatVersion,\n `Unsupported SB3 source format version: ${manifest.formatVersion}`,\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 === sourceFormatVersion,\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":";;;AAYA,IAAa,sBAAsB;AAEnC,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,SAAS,kBAAA,GACT,0CAA0C,SAAS,eACrD;CACA,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,7 +1,7 @@
|
|
|
1
1
|
import { ExtensionBundlePlan } from './extension-bundle';
|
|
2
2
|
import { ProjectAssetAdditionsSummary } from './project-asset-additions';
|
|
3
3
|
import { EmbeddedExtension, ExtensionBundleConfiguration, ProjectJson, Sb3SourceManifest } from './types';
|
|
4
|
-
export
|
|
4
|
+
export { sourceFormatVersion } from './source-format';
|
|
5
5
|
export declare const fixedZipTimestamp: Date;
|
|
6
6
|
export interface InspectedSb3Source {
|
|
7
7
|
assetContents: Map<string, Uint8Array>;
|