@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/constants.js
DELETED
|
@@ -1,336 +0,0 @@
|
|
|
1
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
2
|
-
|
|
3
|
-
import {createHash} from 'node:crypto';
|
|
4
|
-
|
|
5
|
-
import {validateArchiveEntryName} from './archive.js';
|
|
6
|
-
|
|
7
|
-
export const extensionApiManifestFormatVersion = 1;
|
|
8
|
-
export const defaultExtensionApiManifestSizeLimit = 1024 * 1024;
|
|
9
|
-
|
|
10
|
-
function assert(condition, message) {
|
|
11
|
-
if (!condition) {
|
|
12
|
-
throw new Error(message);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
function isObject(value) {
|
|
17
|
-
return value && typeof value === 'object' && !Array.isArray(value);
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
function assertExactProperties(value, expected, description) {
|
|
21
|
-
const expectedProperties = new Set(expected);
|
|
22
|
-
const unexpected = Object.keys(value).filter((property) => !expectedProperties.has(property));
|
|
23
|
-
assert(
|
|
24
|
-
unexpected.length === 0,
|
|
25
|
-
`${description} has unsupported properties: ${unexpected.join(', ')}`,
|
|
26
|
-
);
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
function assertNonEmptyString(value, description) {
|
|
30
|
-
assert(
|
|
31
|
-
typeof value === 'string' && value.length > 0,
|
|
32
|
-
`${description} must be a non-empty string.`,
|
|
33
|
-
);
|
|
34
|
-
return value;
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
function compareIds(left, right) {
|
|
38
|
-
return left < right ? -1 : left > right ? 1 : 0;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
function escapeJsonPointer(value) {
|
|
42
|
-
return value.replaceAll('~', '~0').replaceAll('/', '~1');
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export function extensionApiManifestIntegrity(contents) {
|
|
46
|
-
return `sha256-${createHash('sha256').update(contents).digest('base64')}`;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
export function extensionApiManifestLocalPath(extensionId) {
|
|
50
|
-
return `extensions/${extensionId}.manifest.json`;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
export function validateExtensionApiManifestSourceMetadata(extension) {
|
|
54
|
-
const metadata = extension.source?.apiManifest;
|
|
55
|
-
if (metadata === undefined) return null;
|
|
56
|
-
assert(
|
|
57
|
-
isObject(metadata),
|
|
58
|
-
`Managed extension API manifest metadata must be an object: ${extension.id}`,
|
|
59
|
-
);
|
|
60
|
-
assertExactProperties(
|
|
61
|
-
metadata,
|
|
62
|
-
['artifact', 'formatVersion', 'integrity', 'path'],
|
|
63
|
-
`Managed extension API manifest metadata for ${extension.id}`,
|
|
64
|
-
);
|
|
65
|
-
assert(
|
|
66
|
-
metadata.formatVersion === extensionApiManifestFormatVersion,
|
|
67
|
-
`Managed extension ${extension.id} requires API manifest formatVersion ${extensionApiManifestFormatVersion}.`,
|
|
68
|
-
);
|
|
69
|
-
assertNonEmptyString(
|
|
70
|
-
metadata.artifact,
|
|
71
|
-
`Managed extension ${extension.id} API manifest artifact`,
|
|
72
|
-
);
|
|
73
|
-
validateArchiveEntryName(metadata.artifact);
|
|
74
|
-
assert(
|
|
75
|
-
!metadata.artifact.endsWith('/'),
|
|
76
|
-
`Managed extension API manifest artifact must be a file: ${metadata.artifact}`,
|
|
77
|
-
);
|
|
78
|
-
const expectedPath = extensionApiManifestLocalPath(extension.id);
|
|
79
|
-
assert(
|
|
80
|
-
metadata.path === expectedPath,
|
|
81
|
-
`Managed extension API manifest path must match its ID: expected ${expectedPath}, got ${metadata.path}`,
|
|
82
|
-
);
|
|
83
|
-
assert(
|
|
84
|
-
typeof metadata.integrity === 'string' &&
|
|
85
|
-
/^sha256-[A-Za-z0-9+/]{43}=$/u.test(metadata.integrity),
|
|
86
|
-
`Managed extension ${extension.id} API manifest requires SHA-256 integrity.`,
|
|
87
|
-
);
|
|
88
|
-
return metadata;
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
function normalizeArgument(value, blockOpcode, index, menuIds) {
|
|
92
|
-
assert(isObject(value), `API manifest block ${blockOpcode} argument ${index} must be an object.`);
|
|
93
|
-
assertExactProperties(
|
|
94
|
-
value,
|
|
95
|
-
['id', 'menu', 'type'],
|
|
96
|
-
`API manifest block ${blockOpcode} argument ${index}`,
|
|
97
|
-
);
|
|
98
|
-
const id = assertNonEmptyString(
|
|
99
|
-
value.id,
|
|
100
|
-
`API manifest block ${blockOpcode} argument ${index} ID`,
|
|
101
|
-
);
|
|
102
|
-
const type = assertNonEmptyString(
|
|
103
|
-
value.type,
|
|
104
|
-
`API manifest block ${blockOpcode} argument ${id} type`,
|
|
105
|
-
);
|
|
106
|
-
if (value.menu !== undefined) {
|
|
107
|
-
assertNonEmptyString(value.menu, `API manifest block ${blockOpcode} argument ${id} menu`);
|
|
108
|
-
assert(
|
|
109
|
-
menuIds.has(value.menu),
|
|
110
|
-
`API manifest block ${blockOpcode} argument ${id} references unknown menu: ${value.menu}`,
|
|
111
|
-
);
|
|
112
|
-
}
|
|
113
|
-
return value.menu === undefined ? {id, type} : {id, menu: value.menu, type};
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
function normalizeBlock(value, index, menuIds) {
|
|
117
|
-
assert(isObject(value), `API manifest block ${index} must be an object.`);
|
|
118
|
-
assertExactProperties(value, ['arguments', 'blockType', 'opcode'], `API manifest block ${index}`);
|
|
119
|
-
const opcode = assertNonEmptyString(value.opcode, `API manifest block ${index} opcode`);
|
|
120
|
-
const blockType = assertNonEmptyString(value.blockType, `API manifest block ${opcode} blockType`);
|
|
121
|
-
assert(
|
|
122
|
-
Array.isArray(value.arguments),
|
|
123
|
-
`API manifest block ${opcode} arguments must be an array.`,
|
|
124
|
-
);
|
|
125
|
-
const arguments_ = value.arguments.map((argument, argumentIndex) =>
|
|
126
|
-
normalizeArgument(argument, opcode, argumentIndex, menuIds),
|
|
127
|
-
);
|
|
128
|
-
const argumentIds = new Set();
|
|
129
|
-
for (const argument of arguments_) {
|
|
130
|
-
assert(
|
|
131
|
-
!argumentIds.has(argument.id),
|
|
132
|
-
`API manifest block ${opcode} has duplicate argument ID: ${argument.id}`,
|
|
133
|
-
);
|
|
134
|
-
argumentIds.add(argument.id);
|
|
135
|
-
}
|
|
136
|
-
arguments_.sort((left, right) => compareIds(left.id, right.id));
|
|
137
|
-
return {arguments: arguments_, blockType, opcode};
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
function normalizeMenu(value, index) {
|
|
141
|
-
assert(isObject(value), `API manifest menu ${index} must be an object.`);
|
|
142
|
-
assertExactProperties(value, ['acceptReporters', 'id'], `API manifest menu ${index}`);
|
|
143
|
-
const id = assertNonEmptyString(value.id, `API manifest menu ${index} ID`);
|
|
144
|
-
assert(
|
|
145
|
-
typeof value.acceptReporters === 'boolean',
|
|
146
|
-
`API manifest menu ${id} acceptReporters must be a boolean.`,
|
|
147
|
-
);
|
|
148
|
-
return {acceptReporters: value.acceptReporters, id};
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* @param {string | Uint8Array} contents
|
|
153
|
-
* @param {{expectedId?: string}} [options]
|
|
154
|
-
*/
|
|
155
|
-
export function parseExtensionApiManifest(contents, {expectedId} = {}) {
|
|
156
|
-
let manifest;
|
|
157
|
-
try {
|
|
158
|
-
manifest = JSON.parse(Buffer.from(contents).toString('utf8'));
|
|
159
|
-
} catch (error) {
|
|
160
|
-
throw new Error(`Extension API manifest is not valid JSON: ${error.message}`, {cause: error});
|
|
161
|
-
}
|
|
162
|
-
assert(isObject(manifest), 'Extension API manifest must contain an object.');
|
|
163
|
-
assertExactProperties(
|
|
164
|
-
manifest,
|
|
165
|
-
['blocks', 'formatVersion', 'id', 'menus'],
|
|
166
|
-
'Extension API manifest',
|
|
167
|
-
);
|
|
168
|
-
assert(
|
|
169
|
-
manifest.formatVersion === extensionApiManifestFormatVersion,
|
|
170
|
-
`Unsupported extension API manifest formatVersion: ${manifest.formatVersion}`,
|
|
171
|
-
);
|
|
172
|
-
assert(
|
|
173
|
-
typeof manifest.id === 'string' && /^[a-z0-9]+$/u.test(manifest.id),
|
|
174
|
-
`Invalid extension API manifest ID: ${JSON.stringify(manifest.id)}`,
|
|
175
|
-
);
|
|
176
|
-
if (expectedId !== undefined) {
|
|
177
|
-
assert(
|
|
178
|
-
manifest.id === expectedId,
|
|
179
|
-
`Extension API manifest ID mismatch: expected ${expectedId}, got ${manifest.id}`,
|
|
180
|
-
);
|
|
181
|
-
}
|
|
182
|
-
assert(Array.isArray(manifest.menus), 'Extension API manifest menus must be an array.');
|
|
183
|
-
const menus = manifest.menus.map(normalizeMenu);
|
|
184
|
-
const menuIds = new Set();
|
|
185
|
-
for (const menu of menus) {
|
|
186
|
-
assert(!menuIds.has(menu.id), `Extension API manifest has duplicate menu ID: ${menu.id}`);
|
|
187
|
-
menuIds.add(menu.id);
|
|
188
|
-
}
|
|
189
|
-
assert(Array.isArray(manifest.blocks), 'Extension API manifest blocks must be an array.');
|
|
190
|
-
const blocks = manifest.blocks.map((block, index) => normalizeBlock(block, index, menuIds));
|
|
191
|
-
const blockOpcodes = new Set();
|
|
192
|
-
for (const block of blocks) {
|
|
193
|
-
assert(
|
|
194
|
-
!blockOpcodes.has(block.opcode),
|
|
195
|
-
`Extension API manifest has duplicate block opcode: ${block.opcode}`,
|
|
196
|
-
);
|
|
197
|
-
blockOpcodes.add(block.opcode);
|
|
198
|
-
}
|
|
199
|
-
blocks.sort((left, right) => compareIds(left.opcode, right.opcode));
|
|
200
|
-
menus.sort((left, right) => compareIds(left.id, right.id));
|
|
201
|
-
return {blocks, formatVersion: extensionApiManifestFormatVersion, id: manifest.id, menus};
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
export function validateManagedExtensionApiManifest(
|
|
205
|
-
extension,
|
|
206
|
-
contents,
|
|
207
|
-
{expectedId = extension.id} = {},
|
|
208
|
-
) {
|
|
209
|
-
const metadata = validateExtensionApiManifestSourceMetadata(extension);
|
|
210
|
-
if (!metadata) return null;
|
|
211
|
-
const actualIntegrity = extensionApiManifestIntegrity(contents);
|
|
212
|
-
assert(
|
|
213
|
-
actualIntegrity === metadata.integrity,
|
|
214
|
-
`Managed extension API manifest integrity mismatch for ${extension.id}: ` +
|
|
215
|
-
`expected ${metadata.integrity}, got ${actualIntegrity}`,
|
|
216
|
-
);
|
|
217
|
-
const manifest = parseExtensionApiManifest(contents, {expectedId});
|
|
218
|
-
assert(
|
|
219
|
-
manifest.formatVersion === metadata.formatVersion,
|
|
220
|
-
`Managed extension API manifest version mismatch for ${extension.id}.`,
|
|
221
|
-
);
|
|
222
|
-
return {integrity: actualIntegrity, manifest, metadata};
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
function addChange(changes, kind, path, before, after, breaking) {
|
|
226
|
-
changes.push({after, before, breaking, kind, path});
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
export function compareExtensionApiManifests(installed, candidate) {
|
|
230
|
-
const changes = [];
|
|
231
|
-
const installedBlocks = new Map(installed.blocks.map((block) => [block.opcode, block]));
|
|
232
|
-
const candidateBlocks = new Map(candidate.blocks.map((block) => [block.opcode, block]));
|
|
233
|
-
for (const [opcode, block] of installedBlocks) {
|
|
234
|
-
const path = `/blocks/${escapeJsonPointer(opcode)}`;
|
|
235
|
-
const replacement = candidateBlocks.get(opcode);
|
|
236
|
-
if (!replacement) {
|
|
237
|
-
addChange(changes, 'block-removed', path, block, null, true);
|
|
238
|
-
continue;
|
|
239
|
-
}
|
|
240
|
-
if (block.blockType !== replacement.blockType) {
|
|
241
|
-
addChange(
|
|
242
|
-
changes,
|
|
243
|
-
'block-type-changed',
|
|
244
|
-
`${path}/blockType`,
|
|
245
|
-
block.blockType,
|
|
246
|
-
replacement.blockType,
|
|
247
|
-
true,
|
|
248
|
-
);
|
|
249
|
-
}
|
|
250
|
-
const installedArguments = new Map(block.arguments.map((argument) => [argument.id, argument]));
|
|
251
|
-
const candidateArguments = new Map(
|
|
252
|
-
replacement.arguments.map((argument) => [argument.id, argument]),
|
|
253
|
-
);
|
|
254
|
-
for (const [argumentId, argument] of installedArguments) {
|
|
255
|
-
const argumentPath = `${path}/arguments/${escapeJsonPointer(argumentId)}`;
|
|
256
|
-
const replacementArgument = candidateArguments.get(argumentId);
|
|
257
|
-
if (!replacementArgument) {
|
|
258
|
-
addChange(changes, 'argument-removed', argumentPath, argument, null, true);
|
|
259
|
-
continue;
|
|
260
|
-
}
|
|
261
|
-
for (const property of ['type', 'menu']) {
|
|
262
|
-
if (argument[property] !== replacementArgument[property]) {
|
|
263
|
-
addChange(
|
|
264
|
-
changes,
|
|
265
|
-
`argument-${property}-changed`,
|
|
266
|
-
`${argumentPath}/${property}`,
|
|
267
|
-
argument[property] ?? null,
|
|
268
|
-
replacementArgument[property] ?? null,
|
|
269
|
-
true,
|
|
270
|
-
);
|
|
271
|
-
}
|
|
272
|
-
}
|
|
273
|
-
}
|
|
274
|
-
for (const [argumentId, argument] of candidateArguments) {
|
|
275
|
-
if (!installedArguments.has(argumentId)) {
|
|
276
|
-
addChange(
|
|
277
|
-
changes,
|
|
278
|
-
'argument-added',
|
|
279
|
-
`${path}/arguments/${escapeJsonPointer(argumentId)}`,
|
|
280
|
-
null,
|
|
281
|
-
argument,
|
|
282
|
-
true,
|
|
283
|
-
);
|
|
284
|
-
}
|
|
285
|
-
}
|
|
286
|
-
}
|
|
287
|
-
for (const [opcode, block] of candidateBlocks) {
|
|
288
|
-
if (!installedBlocks.has(opcode)) {
|
|
289
|
-
addChange(changes, 'block-added', `/blocks/${escapeJsonPointer(opcode)}`, null, block, false);
|
|
290
|
-
}
|
|
291
|
-
}
|
|
292
|
-
|
|
293
|
-
const installedMenus = new Map(installed.menus.map((menu) => [menu.id, menu]));
|
|
294
|
-
const candidateMenus = new Map(candidate.menus.map((menu) => [menu.id, menu]));
|
|
295
|
-
const referencedInstalledMenus = new Set();
|
|
296
|
-
for (const block of installed.blocks) {
|
|
297
|
-
for (const argument of block.arguments) {
|
|
298
|
-
if (argument.menu !== undefined) referencedInstalledMenus.add(argument.menu);
|
|
299
|
-
}
|
|
300
|
-
}
|
|
301
|
-
for (const [menuId, menu] of installedMenus) {
|
|
302
|
-
const path = `/menus/${escapeJsonPointer(menuId)}`;
|
|
303
|
-
const replacement = candidateMenus.get(menuId);
|
|
304
|
-
if (!replacement) {
|
|
305
|
-
addChange(changes, 'menu-removed', path, menu, null, referencedInstalledMenus.has(menuId));
|
|
306
|
-
} else if (menu.acceptReporters !== replacement.acceptReporters) {
|
|
307
|
-
addChange(
|
|
308
|
-
changes,
|
|
309
|
-
'menu-accept-reporters-changed',
|
|
310
|
-
`${path}/acceptReporters`,
|
|
311
|
-
menu.acceptReporters,
|
|
312
|
-
replacement.acceptReporters,
|
|
313
|
-
true,
|
|
314
|
-
);
|
|
315
|
-
}
|
|
316
|
-
}
|
|
317
|
-
for (const [menuId, menu] of candidateMenus) {
|
|
318
|
-
if (!installedMenus.has(menuId)) {
|
|
319
|
-
addChange(changes, 'menu-added', `/menus/${escapeJsonPointer(menuId)}`, null, menu, false);
|
|
320
|
-
}
|
|
321
|
-
}
|
|
322
|
-
return changes.sort((left, right) =>
|
|
323
|
-
left.path === right.path
|
|
324
|
-
? compareIds(left.kind, right.kind)
|
|
325
|
-
: compareIds(left.path, right.path),
|
|
326
|
-
);
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
export function formatExtensionApiCompatibilityChanges(extensionId, changes) {
|
|
330
|
-
return changes
|
|
331
|
-
.map(
|
|
332
|
-
(change) =>
|
|
333
|
-
`${extensionId} ${change.breaking ? 'breaking' : 'compatible'} ${change.kind} ${change.path}`,
|
|
334
|
-
)
|
|
335
|
-
.join('\n');
|
|
336
|
-
}
|