@kubohiroya/sb3-toolchain 0.10.0 → 0.12.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 +22 -0
- package/README.ja.md +17 -1
- package/README.md +17 -1
- package/dist/archive.d.ts +1 -0
- package/dist/archive.js +16 -0
- package/dist/archive.js.map +1 -0
- package/dist/assert.d.ts +2 -0
- package/dist/assert.js +11 -0
- package/dist/assert.js.map +1 -0
- package/dist/bin.d.ts +1 -0
- package/dist/bin.js +12 -0
- package/dist/bin.js.map +1 -0
- package/dist/build.d.ts +23 -0
- package/dist/build.js +111 -0
- package/dist/build.js.map +1 -0
- package/dist/cli.d.ts +87 -0
- package/dist/cli.js +544 -0
- package/dist/cli.js.map +1 -0
- package/dist/constants.d.ts +2 -0
- package/dist/constants.js +7 -0
- package/dist/constants.js.map +1 -0
- package/dist/extension-api-manifest.d.ts +46 -0
- package/dist/extension-api-manifest.js +211 -0
- package/dist/extension-api-manifest.js.map +1 -0
- package/dist/extension-bundle-archive.d.ts +36 -0
- package/dist/extension-bundle-archive.js +302 -0
- package/dist/extension-bundle-archive.js.map +1 -0
- package/dist/extension-bundle-configuration.d.ts +55 -0
- package/dist/extension-bundle-configuration.js +200 -0
- package/dist/extension-bundle-configuration.js.map +1 -0
- package/dist/extension-bundle.d.ts +39 -0
- package/dist/extension-bundle.js +580 -0
- package/dist/extension-bundle.js.map +1 -0
- package/dist/extension-dependencies.d.ts +18 -0
- package/dist/extension-dependencies.js +59 -0
- package/dist/extension-dependencies.js.map +1 -0
- package/dist/extension-id-migration.d.ts +83 -0
- package/dist/extension-id-migration.js +292 -0
- package/dist/extension-id-migration.js.map +1 -0
- package/dist/extension-sync.d.ts +111 -0
- package/dist/extension-sync.js +463 -0
- package/dist/extension-sync.js.map +1 -0
- package/dist/import.d.ts +39 -0
- package/dist/import.js +244 -0
- package/dist/import.js.map +1 -0
- package/dist/index.d.ts +31 -0
- package/dist/index.js +18 -0
- package/dist/npm-extension-source.d.ts +13 -0
- package/dist/npm-extension-source.js +63 -0
- package/dist/npm-extension-source.js.map +1 -0
- package/dist/output-safety.d.ts +29 -0
- package/dist/output-safety.js +213 -0
- package/dist/output-safety.js.map +1 -0
- package/dist/project-asset-additions.d.ts +29 -0
- package/dist/project-asset-additions.js +412 -0
- package/dist/project-asset-additions.js.map +1 -0
- package/dist/release-snapshot.d.ts +75 -0
- package/dist/release-snapshot.js +177 -0
- package/dist/release-snapshot.js.map +1 -0
- package/dist/source.d.ts +41 -0
- package/dist/source.js +282 -0
- package/dist/source.js.map +1 -0
- package/dist/turbowarp-clean-up.d.ts +18 -0
- package/dist/turbowarp-clean-up.js +266 -0
- package/dist/turbowarp-clean-up.js.map +1 -0
- package/dist/types.d.ts +80 -0
- package/package.json +29 -21
- package/bin/sb3-toolchain.mjs +0 -9
- package/src/archive.js +0 -35
- package/src/build.js +0 -188
- package/src/cli.js +0 -748
- package/src/constants.js +0 -4
- package/src/extension-api-manifest.js +0 -336
- package/src/extension-bundle-archive.js +0 -422
- package/src/extension-bundle-configuration.js +0 -265
- package/src/extension-bundle.js +0 -695
- package/src/extension-dependencies.js +0 -114
- package/src/extension-id-migration.js +0 -496
- package/src/extension-sync.js +0 -754
- package/src/import.js +0 -397
- package/src/index.js +0 -75
- package/src/npm-extension-source.js +0 -111
- package/src/output-safety.js +0 -322
- package/src/project-asset-additions.js +0 -560
- package/src/release-snapshot.js +0 -247
- package/src/source.js +0 -468
- package/src/turbowarp-clean-up.js +0 -295
package/src/release-snapshot.js
DELETED
|
@@ -1,247 +0,0 @@
|
|
|
1
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
2
|
-
|
|
3
|
-
import {createHash} from 'node:crypto';
|
|
4
|
-
import {mkdir, readFile, rename, rm, writeFile} from 'node:fs/promises';
|
|
5
|
-
import path from 'node:path';
|
|
6
|
-
import process from 'node:process';
|
|
7
|
-
|
|
8
|
-
const releaseSnapshotFormatVersion = 1;
|
|
9
|
-
const releaseSnapshotStates = new Set(['candidate', 'frozen', 'published']);
|
|
10
|
-
|
|
11
|
-
function assert(condition, message) {
|
|
12
|
-
if (!condition) {
|
|
13
|
-
throw new Error(message);
|
|
14
|
-
}
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
function sha256(contents) {
|
|
18
|
-
return createHash('sha256').update(contents).digest('hex');
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
function asBuffer(contents, description) {
|
|
22
|
-
if (Buffer.isBuffer(contents)) return contents;
|
|
23
|
-
if (contents instanceof Uint8Array) return Buffer.from(contents);
|
|
24
|
-
if (typeof contents === 'string') return Buffer.from(contents);
|
|
25
|
-
throw new TypeError(`${description} must be a string, Buffer, or Uint8Array.`);
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
function normalizedSourceEntries(sourceFiles) {
|
|
29
|
-
assert(sourceFiles instanceof Map, 'Release source files must be provided as a Map.');
|
|
30
|
-
const entries = [...sourceFiles.entries()].map(([relativePath, contents]) => {
|
|
31
|
-
assert(
|
|
32
|
-
typeof relativePath === 'string' &&
|
|
33
|
-
relativePath.length > 0 &&
|
|
34
|
-
!path.isAbsolute(relativePath) &&
|
|
35
|
-
!relativePath.split(/[\\/]+/u).includes('..'),
|
|
36
|
-
`Release source path must be a safe relative path: ${relativePath}`,
|
|
37
|
-
);
|
|
38
|
-
return [relativePath.split(path.sep).join('/'), asBuffer(contents, relativePath)];
|
|
39
|
-
});
|
|
40
|
-
entries.sort(([left], [right]) => left.localeCompare(right, 'en'));
|
|
41
|
-
return entries;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
export function computeReleaseSourceIdentity(sourceFiles) {
|
|
45
|
-
const hash = createHash('sha256');
|
|
46
|
-
for (const [relativePath, contents] of normalizedSourceEntries(sourceFiles)) {
|
|
47
|
-
const pathBytes = Buffer.from(relativePath);
|
|
48
|
-
hash.update(Buffer.from(`${pathBytes.byteLength}:`));
|
|
49
|
-
hash.update(pathBytes);
|
|
50
|
-
hash.update(Buffer.from(`:${contents.byteLength}:`));
|
|
51
|
-
hash.update(contents);
|
|
52
|
-
}
|
|
53
|
-
return `sha256:${hash.digest('hex')}`;
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
export function createSb3ReleaseSnapshotMetadata({
|
|
57
|
-
artifact,
|
|
58
|
-
metadata = {},
|
|
59
|
-
publication = {},
|
|
60
|
-
sourceFiles,
|
|
61
|
-
state = 'candidate',
|
|
62
|
-
}) {
|
|
63
|
-
assert(releaseSnapshotStates.has(state), `Unsupported SB3 release snapshot state: ${state}`);
|
|
64
|
-
const archive = asBuffer(artifact.archive, 'SB3 release artifact archive');
|
|
65
|
-
const filename = artifact.filename;
|
|
66
|
-
assert(
|
|
67
|
-
typeof filename === 'string' && filename.endsWith('.sb3'),
|
|
68
|
-
'Artifact filename is required.',
|
|
69
|
-
);
|
|
70
|
-
const normalizedArtifact = {
|
|
71
|
-
filename,
|
|
72
|
-
sha256: sha256(archive),
|
|
73
|
-
size: archive.byteLength,
|
|
74
|
-
};
|
|
75
|
-
if (artifact.url !== undefined) {
|
|
76
|
-
const url = new URL(artifact.url);
|
|
77
|
-
assert(url.protocol === 'https:', 'Artifact URL must use HTTPS.');
|
|
78
|
-
normalizedArtifact.url = url.href;
|
|
79
|
-
}
|
|
80
|
-
return {
|
|
81
|
-
formatVersion: releaseSnapshotFormatVersion,
|
|
82
|
-
...metadata,
|
|
83
|
-
state,
|
|
84
|
-
sourceIdentity: computeReleaseSourceIdentity(sourceFiles),
|
|
85
|
-
artifact: normalizedArtifact,
|
|
86
|
-
publication: {...publication},
|
|
87
|
-
};
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
export function assertSb3ReleaseSnapshotMetadata(metadata) {
|
|
91
|
-
assert(
|
|
92
|
-
metadata?.formatVersion === releaseSnapshotFormatVersion,
|
|
93
|
-
'SB3 release snapshot metadata format is invalid.',
|
|
94
|
-
);
|
|
95
|
-
assert(releaseSnapshotStates.has(metadata.state), 'SB3 release snapshot state is invalid.');
|
|
96
|
-
assert(
|
|
97
|
-
typeof metadata.sourceIdentity === 'string' &&
|
|
98
|
-
/^sha256:[0-9a-f]{64}$/u.test(metadata.sourceIdentity),
|
|
99
|
-
'SB3 release snapshot source identity is invalid.',
|
|
100
|
-
);
|
|
101
|
-
assert(
|
|
102
|
-
typeof metadata.artifact?.filename === 'string' && metadata.artifact.filename.endsWith('.sb3'),
|
|
103
|
-
'SB3 release snapshot artifact filename is invalid.',
|
|
104
|
-
);
|
|
105
|
-
assert(
|
|
106
|
-
typeof metadata.artifact?.sha256 === 'string' &&
|
|
107
|
-
/^[0-9a-f]{64}$/u.test(metadata.artifact.sha256),
|
|
108
|
-
'SB3 release snapshot artifact SHA-256 is invalid.',
|
|
109
|
-
);
|
|
110
|
-
assert(
|
|
111
|
-
Number.isSafeInteger(metadata.artifact?.size) && metadata.artifact.size > 0,
|
|
112
|
-
'SB3 release snapshot artifact size is invalid.',
|
|
113
|
-
);
|
|
114
|
-
if (metadata.artifact.url !== undefined) {
|
|
115
|
-
const url = new URL(metadata.artifact.url);
|
|
116
|
-
assert(url.protocol === 'https:', 'SB3 release snapshot artifact URL must use HTTPS.');
|
|
117
|
-
}
|
|
118
|
-
if (metadata.publication?.urls !== undefined) {
|
|
119
|
-
for (const [name, value] of Object.entries(metadata.publication.urls)) {
|
|
120
|
-
const url = new URL(value);
|
|
121
|
-
assert(
|
|
122
|
-
url.protocol === 'https:',
|
|
123
|
-
`SB3 release snapshot publication URL must use HTTPS: ${name}`,
|
|
124
|
-
);
|
|
125
|
-
}
|
|
126
|
-
}
|
|
127
|
-
return metadata;
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
export async function createSb3ReleaseSnapshot({
|
|
131
|
-
artifact,
|
|
132
|
-
createSb3,
|
|
133
|
-
metadata,
|
|
134
|
-
publication,
|
|
135
|
-
sourceFiles,
|
|
136
|
-
state,
|
|
137
|
-
}) {
|
|
138
|
-
assert(typeof createSb3 === 'function', 'A createSb3 function is required.');
|
|
139
|
-
const built = await createSb3();
|
|
140
|
-
const archive = asBuffer(built.archive, 'SB3 release artifact archive');
|
|
141
|
-
const snapshot = createSb3ReleaseSnapshotMetadata({
|
|
142
|
-
artifact: {...artifact, archive},
|
|
143
|
-
metadata,
|
|
144
|
-
publication,
|
|
145
|
-
sourceFiles,
|
|
146
|
-
state,
|
|
147
|
-
});
|
|
148
|
-
return {archive, metadata: assertSb3ReleaseSnapshotMetadata(snapshot), sourceFiles};
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
export async function verifySb3ReleaseSnapshot(options) {
|
|
152
|
-
const {createSb3, fetchPublishedArtifact, metadata, sourceFiles} = options;
|
|
153
|
-
const snapshot = assertSb3ReleaseSnapshotMetadata(metadata);
|
|
154
|
-
if (snapshot.state === 'published') {
|
|
155
|
-
assert(
|
|
156
|
-
typeof fetchPublishedArtifact === 'function',
|
|
157
|
-
'A published artifact fetcher is required.',
|
|
158
|
-
);
|
|
159
|
-
const archive = asBuffer(
|
|
160
|
-
await fetchPublishedArtifact(snapshot),
|
|
161
|
-
'Published SB3 release artifact',
|
|
162
|
-
);
|
|
163
|
-
assert(
|
|
164
|
-
archive.byteLength === snapshot.artifact.size,
|
|
165
|
-
'Published SB3 release artifact size is invalid.',
|
|
166
|
-
);
|
|
167
|
-
assert(
|
|
168
|
-
sha256(archive) === snapshot.artifact.sha256,
|
|
169
|
-
'Published SB3 release artifact SHA-256 is invalid.',
|
|
170
|
-
);
|
|
171
|
-
return snapshot;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
assert(
|
|
175
|
-
computeReleaseSourceIdentity(sourceFiles) === snapshot.sourceIdentity,
|
|
176
|
-
'SB3 release source changed. Update the release snapshot.',
|
|
177
|
-
);
|
|
178
|
-
assert(typeof createSb3 === 'function', 'A createSb3 function is required.');
|
|
179
|
-
const [first, second] = await Promise.all([createSb3(), createSb3()]);
|
|
180
|
-
const firstArchive = asBuffer(first.archive, 'First SB3 release artifact archive');
|
|
181
|
-
const secondArchive = asBuffer(second.archive, 'Second SB3 release artifact archive');
|
|
182
|
-
assert(
|
|
183
|
-
firstArchive.equals(secondArchive),
|
|
184
|
-
'SB3 release artifact generation is not deterministic.',
|
|
185
|
-
);
|
|
186
|
-
assert(
|
|
187
|
-
sha256(firstArchive) === snapshot.artifact.sha256,
|
|
188
|
-
'SB3 release artifact SHA-256 is stale.',
|
|
189
|
-
);
|
|
190
|
-
assert(firstArchive.byteLength === snapshot.artifact.size, 'SB3 release artifact size is stale.');
|
|
191
|
-
return snapshot;
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
async function writeAtomically(filename, contents) {
|
|
195
|
-
await mkdir(path.dirname(filename), {recursive: true});
|
|
196
|
-
const temporaryPath = `${filename}.tmp-${process.pid}`;
|
|
197
|
-
try {
|
|
198
|
-
await writeFile(temporaryPath, contents);
|
|
199
|
-
await rename(temporaryPath, filename);
|
|
200
|
-
} catch (error) {
|
|
201
|
-
await rm(temporaryPath, {force: true});
|
|
202
|
-
throw error;
|
|
203
|
-
}
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
export async function writeSb3ReleaseCandidate({artifactPath, archive, metadata, metadataPath}) {
|
|
207
|
-
assertSb3ReleaseSnapshotMetadata(metadata);
|
|
208
|
-
const artifactArchive = asBuffer(archive, 'SB3 release candidate archive');
|
|
209
|
-
assert(
|
|
210
|
-
sha256(artifactArchive) === metadata.artifact.sha256 &&
|
|
211
|
-
artifactArchive.byteLength === metadata.artifact.size,
|
|
212
|
-
'SB3 release candidate archive does not match metadata.',
|
|
213
|
-
);
|
|
214
|
-
await writeAtomically(artifactPath, artifactArchive);
|
|
215
|
-
await writeAtomically(metadataPath, `${JSON.stringify(metadata, null, 2)}\n`);
|
|
216
|
-
return {artifactPath, metadataPath};
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
export function freezeSb3ReleaseSnapshot(metadata) {
|
|
220
|
-
const snapshot = assertSb3ReleaseSnapshotMetadata(metadata);
|
|
221
|
-
if (snapshot.state === 'frozen') return snapshot;
|
|
222
|
-
assert(snapshot.state === 'candidate', 'Only candidate SB3 release snapshots can be frozen.');
|
|
223
|
-
return assertSb3ReleaseSnapshotMetadata({...snapshot, state: 'frozen'});
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
export async function readSb3ReleaseSnapshotMetadata(metadataPath) {
|
|
227
|
-
return assertSb3ReleaseSnapshotMetadata(JSON.parse(await readFile(metadataPath, 'utf8')));
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
export async function recordPublishedSb3ReleaseSnapshot(metadata, urls, options = {}) {
|
|
231
|
-
const {fetchPublishedArtifact} = options;
|
|
232
|
-
const snapshot = assertSb3ReleaseSnapshotMetadata(metadata);
|
|
233
|
-
assert(snapshot.state === 'frozen', 'Only frozen SB3 release snapshots can be published.');
|
|
234
|
-
const published = assertSb3ReleaseSnapshotMetadata({
|
|
235
|
-
...snapshot,
|
|
236
|
-
state: 'published',
|
|
237
|
-
publication: {
|
|
238
|
-
...snapshot.publication,
|
|
239
|
-
urls,
|
|
240
|
-
},
|
|
241
|
-
});
|
|
242
|
-
await verifySb3ReleaseSnapshot({
|
|
243
|
-
fetchPublishedArtifact,
|
|
244
|
-
metadata: published,
|
|
245
|
-
});
|
|
246
|
-
return published;
|
|
247
|
-
}
|