@kubohiroya/sb3-toolchain 0.1.1 → 0.3.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/README.md +59 -96
- package/docs/extension-api-compatibility.md +169 -0
- package/docs/extension-bundles.md +446 -0
- package/docs/extension-id-migration.md +44 -33
- package/docs/ja/extension-api-compatibility.md +167 -0
- package/docs/source-format-v1.md +134 -62
- package/docs/workflows.md +249 -0
- package/package.json +1 -1
- package/src/build.js +21 -7
- package/src/cli.js +176 -3
- package/src/constants.js +1 -1
- package/src/extension-api-manifest.js +336 -0
- package/src/extension-bundle-archive.js +422 -0
- package/src/extension-bundle-configuration.js +247 -0
- package/src/extension-bundle.js +640 -0
- package/src/extension-dependencies.js +16 -1
- package/src/extension-id-migration.js +74 -3
- package/src/extension-sync.js +189 -20
- package/src/import.js +28 -12
- package/src/index.js +25 -0
- package/src/source.js +48 -7
package/src/source.js
CHANGED
|
@@ -7,6 +7,8 @@ import path from 'node:path';
|
|
|
7
7
|
import {strToU8, zipSync} from 'fflate';
|
|
8
8
|
|
|
9
9
|
import {validateArchiveEntryName} from './archive.js';
|
|
10
|
+
import {validateManagedExtensionApiManifest} from './extension-api-manifest.js';
|
|
11
|
+
import {buildExtensionBundles, validateExtensionBundleConfigurations} from './extension-bundle.js';
|
|
10
12
|
import {
|
|
11
13
|
validateExtensionSourceMetadata,
|
|
12
14
|
validateManagedExtensionContents,
|
|
@@ -193,6 +195,9 @@ function validateExtensionManifest(extensionManifest, project, extensionFiles) {
|
|
|
193
195
|
validateExtensionSourceMetadata(extension);
|
|
194
196
|
extensionsById.set(extension.id, extension);
|
|
195
197
|
expectedFiles.push(`${extension.id}.js`);
|
|
198
|
+
if (extension.source?.apiManifest) {
|
|
199
|
+
expectedFiles.push(path.posix.relative('extensions', extension.source.apiManifest.path));
|
|
200
|
+
}
|
|
196
201
|
}
|
|
197
202
|
|
|
198
203
|
for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {
|
|
@@ -209,7 +214,13 @@ function validateExtensionManifest(extensionManifest, project, extensionFiles) {
|
|
|
209
214
|
}
|
|
210
215
|
|
|
211
216
|
assertSameFileSet(extensionFiles, expectedFiles, 'Embedded extension files');
|
|
212
|
-
return
|
|
217
|
+
return {
|
|
218
|
+
extensionBundles: validateExtensionBundleConfigurations(
|
|
219
|
+
extensionManifest.extensionBundles,
|
|
220
|
+
extensionManifest.extensions,
|
|
221
|
+
),
|
|
222
|
+
extensions: extensionManifest.extensions,
|
|
223
|
+
};
|
|
213
224
|
}
|
|
214
225
|
|
|
215
226
|
function collectAssetReferences(project) {
|
|
@@ -283,7 +294,11 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
|
|
|
283
294
|
listRegularFiles(extensionsDirectory, 'Extensions directory'),
|
|
284
295
|
]);
|
|
285
296
|
assertSameFileSet(assetFiles, assetEntries, 'Asset files');
|
|
286
|
-
const extensions = validateExtensionManifest(
|
|
297
|
+
const {extensionBundles, extensions} = validateExtensionManifest(
|
|
298
|
+
extensionManifest,
|
|
299
|
+
project,
|
|
300
|
+
extensionFiles,
|
|
301
|
+
);
|
|
287
302
|
|
|
288
303
|
const assetContents = new Map();
|
|
289
304
|
await Promise.all(
|
|
@@ -323,6 +338,7 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
|
|
|
323
338
|
);
|
|
324
339
|
|
|
325
340
|
const extensionContents = new Map();
|
|
341
|
+
const extensionApiManifestContents = new Map();
|
|
326
342
|
await Promise.all(
|
|
327
343
|
extensions.map(async (extension) => {
|
|
328
344
|
const contents = await readFile(path.join(resolvedSourceDirectory, extension.path));
|
|
@@ -330,6 +346,15 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
|
|
|
330
346
|
validateManagedExtensionContents(extension, contents);
|
|
331
347
|
}
|
|
332
348
|
extensionContents.set(extension.id, contents);
|
|
349
|
+
if (extension.source?.apiManifest) {
|
|
350
|
+
const apiManifestContents = await readFile(
|
|
351
|
+
path.join(resolvedSourceDirectory, extension.source.apiManifest.path),
|
|
352
|
+
);
|
|
353
|
+
if (validateManagedExtensions) {
|
|
354
|
+
validateManagedExtensionApiManifest(extension, apiManifestContents);
|
|
355
|
+
}
|
|
356
|
+
extensionApiManifestContents.set(extension.id, apiManifestContents);
|
|
357
|
+
}
|
|
333
358
|
}),
|
|
334
359
|
);
|
|
335
360
|
|
|
@@ -337,6 +362,8 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
|
|
|
337
362
|
assetContents,
|
|
338
363
|
assetReferenceCount: references.length,
|
|
339
364
|
extensions,
|
|
365
|
+
extensionApiManifestContents,
|
|
366
|
+
extensionBundles,
|
|
340
367
|
extensionContents,
|
|
341
368
|
project,
|
|
342
369
|
resolvedSourceDirectory,
|
|
@@ -349,16 +376,29 @@ export async function inspectSb3SourceForExtensionSync(sourceDirectory) {
|
|
|
349
376
|
}
|
|
350
377
|
|
|
351
378
|
export async function validateSb3Source(sourceDirectory) {
|
|
352
|
-
|
|
379
|
+
const source = await inspectSb3Source(sourceDirectory, true);
|
|
380
|
+
buildExtensionBundles({
|
|
381
|
+
extensionBundles: source.extensionBundles,
|
|
382
|
+
extensionContents: source.extensionContents,
|
|
383
|
+
extensions: source.extensions,
|
|
384
|
+
project: source.project,
|
|
385
|
+
});
|
|
386
|
+
return source;
|
|
353
387
|
}
|
|
354
388
|
|
|
355
389
|
export async function createDeterministicSb3(sourceDirectory) {
|
|
356
390
|
const source = await validateSb3Source(sourceDirectory);
|
|
357
|
-
const
|
|
358
|
-
|
|
391
|
+
const bundled = buildExtensionBundles({
|
|
392
|
+
extensionBundles: source.extensionBundles,
|
|
393
|
+
extensionContents: source.extensionContents,
|
|
394
|
+
extensions: source.extensions,
|
|
395
|
+
project: source.project,
|
|
396
|
+
});
|
|
397
|
+
const project = structuredClone(bundled.project);
|
|
398
|
+
for (const extension of bundled.extensions) {
|
|
359
399
|
project.extensionURLs[extension.id] = encodeExtensionDataUrl(
|
|
360
400
|
extension,
|
|
361
|
-
|
|
401
|
+
bundled.extensionContents.get(extension.id),
|
|
362
402
|
);
|
|
363
403
|
}
|
|
364
404
|
|
|
@@ -379,7 +419,8 @@ export async function createDeterministicSb3(sourceDirectory) {
|
|
|
379
419
|
archive,
|
|
380
420
|
assetCount: source.assetContents.size,
|
|
381
421
|
assetReferenceCount: source.assetReferenceCount,
|
|
382
|
-
|
|
422
|
+
bundlePlans: bundled.bundlePlans,
|
|
423
|
+
embeddedExtensionCount: bundled.extensions.length,
|
|
383
424
|
entryCount: source.sourceManifest.archiveEntries.length,
|
|
384
425
|
source,
|
|
385
426
|
};
|