@kubohiroya/sb3-toolchain 0.25.0 → 0.26.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 +18 -0
- package/README.ja.md +5 -3
- package/README.md +5 -3
- package/dist/block-palette.d.ts +1 -1
- package/dist/browser.d.ts +7 -7
- package/dist/browser.js +12 -9
- package/dist/browser.js.map +1 -1
- package/dist/build.d.ts +1 -1
- package/dist/clean-up-sb3.d.ts +2 -2
- package/dist/cli.d.ts +2 -2
- 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 +4 -5
- package/dist/expand-archive.js +9 -17
- package/dist/expand-archive.js.map +1 -1
- package/dist/extension-api-manifest.d.ts +1 -1
- package/dist/extension-bundle-configuration.d.ts +4 -4
- package/dist/extension-bundle-metadata.d.ts +1 -1
- package/dist/extension-bundle.d.ts +3 -3
- package/dist/extension-dependencies.d.ts +1 -1
- package/dist/extension-id-migration.d.ts +2 -2
- package/dist/extension-module-bundle.d.ts +2 -2
- package/dist/extension-sb3-replacement.d.ts +2 -2
- package/dist/extension-sync.d.ts +6 -6
- package/dist/import.d.ts +4 -4
- package/dist/import.js +1 -1
- package/dist/import.js.map +1 -1
- package/dist/index.d.ts +42 -42
- package/dist/index.js +2 -2
- package/dist/npm-extension-source.d.ts +1 -1
- package/dist/project-asset-additions.d.ts +1 -1
- package/dist/release-snapshot.d.ts +1 -1
- package/dist/source-format.d.ts +8 -1
- package/dist/source-format.js +8 -1
- package/dist/source-format.js.map +1 -1
- package/dist/source.d.ts +7 -5
- package/dist/source.js +22 -4
- package/dist/source.js.map +1 -1
- package/dist/turbowarp-clean-up.d.ts +1 -1
- package/docs/index.html +2 -2
- package/docs/ja/source-format-v1.md +5 -1
- package/docs/ja/source-format-v2.md +2 -0
- package/docs/source-format-v1.md +11 -2
- package/docs/source-format-v2.md +4 -0
- package/package.json +1 -1
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 {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, supportedSourceFormatVersions} from './source-format';\nimport type {ExtensionEncoding, ExtensionSource} from './types';\nimport type {BlockPaletteWarning} from './block-palette';\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 /** Block palette comments that were normalized or kept as plain comments. */\n warnings: BlockPaletteWarning[];\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, supportedSourceFormatVersions);\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 warnings: expanded.blockPaletteWarnings,\n };\n}\n"],"mappings":";;;;;;;;;;AAsEA,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,iBAAiB,6BAA6B;CACpF,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;EACA,UAAU,SAAS;CACrB;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, supportedSourceFormatVersions} from './source-format';\nimport type {ExtensionEncoding, ExtensionSource} from './types';\nimport type {BlockPaletteWarning} from './block-palette';\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 /** Block palette comments that were normalized or kept as plain comments. */\n warnings: BlockPaletteWarning[];\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, supportedSourceFormatVersions);\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 // Import no longer moves palette comments, so it has no palette warnings; the field stays for callers.\n warnings: [],\n };\n}\n"],"mappings":";;;;;;;;;;AAsEA,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,iBAAiB,6BAA6B;CACpF,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;EAEA,UAAU,CAAC;CACb;AACF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,42 +1,42 @@
|
|
|
1
|
-
export type { EmbeddedExtension, EmbeddedExtensionManifest, ExtensionApiManifestSource, ExtensionBundleConfiguration, ExtensionBundleMetadata, ExtensionEncoding, ExtensionModuleSource, ExtensionSource, GitHubExtensionSource, NpmExtensionSource, ProjectAssetReference, ProjectJson, ProjectTarget, Sb3SourceManifest, } from './types';
|
|
2
|
-
export { assert } from './assert';
|
|
3
|
-
export { validateArchiveEntryName } from './archive';
|
|
4
|
-
export { blockPaletteCommentMarker, blockPaletteCommentMaxLength, blockPaletteCommentReference, blockPaletteFile, blockPaletteFormatVersion, blockPaletteSpriteCommentHeader, blockPaletteStageCommentHeader, formatBlockPaletteComment, serializeBlockPaletteDocument, validateBlockPaletteDocument, } from './block-palette';
|
|
5
|
-
export type { BlockPaletteDocument, BlockPaletteSet, BlockPaletteTargetSetting, BlockPaletteWarning, BlockPaletteWarningCode, } from './block-palette';
|
|
6
|
-
export { buildSb3 } from './build';
|
|
7
|
-
export { cleanUpSb3, cleanUpSb3Archive } from './clean-up-sb3';
|
|
8
|
-
export type { CleanUpSb3ArchiveResult, CleanUpSb3Options, CleanUpSb3Result } from './clean-up-sb3';
|
|
9
|
-
export { packageName, packageVersion } from './constants';
|
|
10
|
-
export { extensionHeaderId, extensionHeaderMetadata, extensionIntegrity, unsandboxedRequirement, unsandboxedRequirements, validateExtensionSourceMetadata, validateManagedExtensionContents, } from './extension-dependencies';
|
|
11
|
-
export { compareExtensionApiManifests, defaultExtensionApiManifestSizeLimit, extensionApiManifestEffects, extensionApiManifestFormatVersion, extensionApiManifestFormatVersions, extensionApiManifestIntegrity, extensionApiManifestLocalPath, extensionApiManifestResultTypes, formatExtensionApiCompatibilityChanges, parseExtensionApiManifest, tryParseExtensionApiManifest, validateExtensionApiManifestSourceMetadata, validateManagedExtensionApiManifest, } from './extension-api-manifest';
|
|
12
|
-
export { bundleExtensions, planExtensionBundle, planExtensionUnbundle, unbundleExtensions, } from './extension-bundle-configuration';
|
|
13
|
-
export { planBundledSb3Unbundle, unbundleSb3 } from './extension-bundle-archive';
|
|
14
|
-
export { extensionSourceTypes, formatExtensionDigestInventory, inspectSb3ExtensionDigests, inventoryExtensionDigests, projectManifestKey, readProjectManifest, } from './extension-digest-inventory';
|
|
15
|
-
export type { ExtensionDigestEntry, ExtensionDigestInventory, ExtensionDigestUsage, ExtensionExecutionMode, ExtensionSourceType, Sb3ExtensionDigests, } from './extension-digest-inventory';
|
|
16
|
-
export { buildExtensionBundles, createStaticExtensionBundle, bundleUnsandboxedRequirement, defaultSandboxedNotices, extensionBundleRecoveryMarker, validateExtensionBundleConfigurations, } from './extension-bundle';
|
|
17
|
-
export { buildExtensionBundlesWithModules } from './extension-module-bundle';
|
|
18
|
-
export type { ExtensionModuleBuildReport } from './extension-module-bundle';
|
|
19
|
-
export { migrateExtensionId, planExtensionIdMigration, validateNewExtensionId, } from './extension-id-migration';
|
|
20
|
-
export { defaultExtensionArtifactSizeLimit, extensionStatus, syncExtensions, updateExtensions, } from './extension-sync';
|
|
21
|
-
export { decodeExtensionDataUrl, importSb3 } from './import';
|
|
22
|
-
export { compareDirectories, inspectGitOutputState, validateOutputDirectoryPath, } from './output-safety';
|
|
23
|
-
export { createDeterministicSb3, blockPaletteSourceFormatVersion, fixedZipTimestamp, sourceFormatVersion, supportedSourceFormatVersions, validateSb3Source, } from './source';
|
|
24
|
-
export { applyProjectAssetAdditions, projectAssetAdditionsFormatVersion, } from './project-asset-additions';
|
|
25
|
-
export { assertSb3ReleaseSnapshotMetadata, computeReleaseSourceIdentity, createSb3ReleaseSnapshot, createSb3ReleaseSnapshotMetadata, freezeSb3ReleaseSnapshot, readSb3ReleaseSnapshotMetadata, recordPublishedSb3ReleaseSnapshot, verifySb3ReleaseSnapshot, writeSb3ReleaseCandidate, } from './release-snapshot';
|
|
26
|
-
export { cleanUpTurboWarpBlocks, turboWarpCleanUpLayout } from './turbowarp-clean-up';
|
|
27
|
-
export type { BuildSb3Options, WriteSb3ArchiveOptions, WriteSb3ArchiveResult } from './build';
|
|
28
|
-
export type { CliOptions } from './cli';
|
|
29
|
-
export type { ExtensionApiCompatibilityChange, ExtensionApiManifest, ExtensionApiManifestArgument, ExtensionApiManifestBlock, ExtensionApiManifestDataReferenceType, ExtensionApiManifestEffect, ExtensionApiManifestFormatVersion, ExtensionApiManifestMenu, ExtensionApiManifestParseFailure, ExtensionApiManifestParseResult, ExtensionApiManifestParseSuccess, ExtensionApiManifestPathSegmentType, ExtensionApiManifestResultType, ExtensionApiManifestServer, } from './extension-api-manifest';
|
|
30
|
-
export type { BuildExtensionBundlesResult, ExtensionBundleComponent, ExtensionBundleCounts, ExtensionBundlePlan, } from './extension-bundle';
|
|
31
|
-
export type { BundledSb3UnbundlePlan } from './extension-bundle-archive';
|
|
32
|
-
export type { ExtensionHeaderMetadata, UnsandboxedRequirement } from './extension-dependencies';
|
|
33
|
-
export type { ExtensionIdMigrationCounts, ExtensionIdReference, RewriteExtensionIdDocumentsResult, } from './extension-id-migration';
|
|
34
|
-
export type { ExtensionSyncConfirmContext, SyncExtensionsOptions, UpdateExtensionsOptions, } from './extension-sync';
|
|
35
|
-
export type { DecodedExtensionDataUrl, ImportSb3Options, ImportSb3Result, OutputReplacementContext, } from './import';
|
|
36
|
-
export type { DirectoryComparison, DirectoryDifferences, GitOutputState } from './output-safety';
|
|
37
|
-
export type { ProjectAssetAdditionsSummary } from './project-asset-additions';
|
|
38
|
-
export type { Sb3ReleaseSnapshotMetadata } from './release-snapshot';
|
|
39
|
-
export type { DeterministicSb3, InspectedSb3Source } from './source';
|
|
40
|
-
export type { TurboWarpCleanUpResult } from './turbowarp-clean-up';
|
|
41
|
-
export { defaultKamishibaiManifestUrl, kamishibaiReplacementIds, replaceSb3Extensions, } from './extension-sb3-replacement';
|
|
42
|
-
export type { ReplaceSb3ExtensionsOptions, ReplaceSb3ExtensionsResult, } from './extension-sb3-replacement';
|
|
1
|
+
export type { EmbeddedExtension, EmbeddedExtensionManifest, ExtensionApiManifestSource, ExtensionBundleConfiguration, ExtensionBundleMetadata, ExtensionEncoding, ExtensionModuleSource, ExtensionSource, GitHubExtensionSource, NpmExtensionSource, ProjectAssetReference, ProjectJson, ProjectTarget, Sb3SourceManifest, } from './types.js';
|
|
2
|
+
export { assert } from './assert.js';
|
|
3
|
+
export { validateArchiveEntryName } from './archive.js';
|
|
4
|
+
export { applyBlockPaletteComments, blockPaletteCommentMarker, blockPaletteCommentMaxLength, blockPaletteCommentReference, blockPaletteFile, blockPaletteFormatVersion, blockPaletteSpriteCommentHeader, blockPaletteStageCommentHeader, extractBlockPalette, formatBlockPaletteComment, hasBlockPaletteSettings, resolveBlockPaletteReferences, serializeBlockPaletteDocument, validateBlockPaletteDocument, } from './block-palette.js';
|
|
5
|
+
export type { BlockPaletteDocument, BlockPaletteSet, BlockPaletteTargetSetting, BlockPaletteWarning, BlockPaletteWarningCode, } from './block-palette.js';
|
|
6
|
+
export { buildSb3 } from './build.js';
|
|
7
|
+
export { cleanUpSb3, cleanUpSb3Archive } from './clean-up-sb3.js';
|
|
8
|
+
export type { CleanUpSb3ArchiveResult, CleanUpSb3Options, CleanUpSb3Result } from './clean-up-sb3.js';
|
|
9
|
+
export { packageName, packageVersion } from './constants.js';
|
|
10
|
+
export { extensionHeaderId, extensionHeaderMetadata, extensionIntegrity, unsandboxedRequirement, unsandboxedRequirements, validateExtensionSourceMetadata, validateManagedExtensionContents, } from './extension-dependencies.js';
|
|
11
|
+
export { compareExtensionApiManifests, defaultExtensionApiManifestSizeLimit, extensionApiManifestEffects, extensionApiManifestFormatVersion, extensionApiManifestFormatVersions, extensionApiManifestIntegrity, extensionApiManifestLocalPath, extensionApiManifestResultTypes, formatExtensionApiCompatibilityChanges, parseExtensionApiManifest, tryParseExtensionApiManifest, validateExtensionApiManifestSourceMetadata, validateManagedExtensionApiManifest, } from './extension-api-manifest.js';
|
|
12
|
+
export { bundleExtensions, planExtensionBundle, planExtensionUnbundle, unbundleExtensions, } from './extension-bundle-configuration.js';
|
|
13
|
+
export { planBundledSb3Unbundle, unbundleSb3 } from './extension-bundle-archive.js';
|
|
14
|
+
export { extensionSourceTypes, formatExtensionDigestInventory, inspectSb3ExtensionDigests, inventoryExtensionDigests, projectManifestKey, readProjectManifest, } from './extension-digest-inventory.js';
|
|
15
|
+
export type { ExtensionDigestEntry, ExtensionDigestInventory, ExtensionDigestUsage, ExtensionExecutionMode, ExtensionSourceType, Sb3ExtensionDigests, } from './extension-digest-inventory.js';
|
|
16
|
+
export { buildExtensionBundles, createStaticExtensionBundle, bundleUnsandboxedRequirement, defaultSandboxedNotices, extensionBundleRecoveryMarker, validateExtensionBundleConfigurations, } from './extension-bundle.js';
|
|
17
|
+
export { buildExtensionBundlesWithModules } from './extension-module-bundle.js';
|
|
18
|
+
export type { ExtensionModuleBuildReport } from './extension-module-bundle.js';
|
|
19
|
+
export { migrateExtensionId, planExtensionIdMigration, validateNewExtensionId, } from './extension-id-migration.js';
|
|
20
|
+
export { defaultExtensionArtifactSizeLimit, extensionStatus, syncExtensions, updateExtensions, } from './extension-sync.js';
|
|
21
|
+
export { decodeExtensionDataUrl, importSb3 } from './import.js';
|
|
22
|
+
export { compareDirectories, inspectGitOutputState, validateOutputDirectoryPath, } from './output-safety.js';
|
|
23
|
+
export { createDeterministicSb3, blockPaletteSourceFormatVersion, fixedZipTimestamp, sourceFormatVersion, supportedSourceFormatVersions, validateSb3Source, } from './source.js';
|
|
24
|
+
export { applyProjectAssetAdditions, projectAssetAdditionsFormatVersion, } from './project-asset-additions.js';
|
|
25
|
+
export { assertSb3ReleaseSnapshotMetadata, computeReleaseSourceIdentity, createSb3ReleaseSnapshot, createSb3ReleaseSnapshotMetadata, freezeSb3ReleaseSnapshot, readSb3ReleaseSnapshotMetadata, recordPublishedSb3ReleaseSnapshot, verifySb3ReleaseSnapshot, writeSb3ReleaseCandidate, } from './release-snapshot.js';
|
|
26
|
+
export { cleanUpTurboWarpBlocks, turboWarpCleanUpLayout } from './turbowarp-clean-up.js';
|
|
27
|
+
export type { BuildSb3Options, WriteSb3ArchiveOptions, WriteSb3ArchiveResult } from './build.js';
|
|
28
|
+
export type { CliOptions } from './cli.js';
|
|
29
|
+
export type { ExtensionApiCompatibilityChange, ExtensionApiManifest, ExtensionApiManifestArgument, ExtensionApiManifestBlock, ExtensionApiManifestDataReferenceType, ExtensionApiManifestEffect, ExtensionApiManifestFormatVersion, ExtensionApiManifestMenu, ExtensionApiManifestParseFailure, ExtensionApiManifestParseResult, ExtensionApiManifestParseSuccess, ExtensionApiManifestPathSegmentType, ExtensionApiManifestResultType, ExtensionApiManifestServer, } from './extension-api-manifest.js';
|
|
30
|
+
export type { BuildExtensionBundlesResult, ExtensionBundleComponent, ExtensionBundleCounts, ExtensionBundlePlan, } from './extension-bundle.js';
|
|
31
|
+
export type { BundledSb3UnbundlePlan } from './extension-bundle-archive.js';
|
|
32
|
+
export type { ExtensionHeaderMetadata, UnsandboxedRequirement } from './extension-dependencies.js';
|
|
33
|
+
export type { ExtensionIdMigrationCounts, ExtensionIdReference, RewriteExtensionIdDocumentsResult, } from './extension-id-migration.js';
|
|
34
|
+
export type { ExtensionSyncConfirmContext, SyncExtensionsOptions, UpdateExtensionsOptions, } from './extension-sync.js';
|
|
35
|
+
export type { DecodedExtensionDataUrl, ImportSb3Options, ImportSb3Result, OutputReplacementContext, } from './import.js';
|
|
36
|
+
export type { DirectoryComparison, DirectoryDifferences, GitOutputState } from './output-safety.js';
|
|
37
|
+
export type { ProjectAssetAdditionsSummary } from './project-asset-additions.js';
|
|
38
|
+
export type { Sb3ReleaseSnapshotMetadata } from './release-snapshot.js';
|
|
39
|
+
export type { DeterministicSb3, InspectedSb3Source } from './source.js';
|
|
40
|
+
export type { TurboWarpCleanUpResult } from './turbowarp-clean-up.js';
|
|
41
|
+
export { defaultKamishibaiManifestUrl, kamishibaiReplacementIds, replaceSb3Extensions, } from './extension-sb3-replacement.js';
|
|
42
|
+
export type { ReplaceSb3ExtensionsOptions, ReplaceSb3ExtensionsResult, } from './extension-sb3-replacement.js';
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { assert } from "./assert.js";
|
|
2
2
|
import { compareDirectories, inspectGitOutputState, validateOutputDirectoryPath } from "./output-safety.js";
|
|
3
|
-
import { blockPaletteCommentMarker, blockPaletteCommentMaxLength, blockPaletteCommentReference, blockPaletteFile, blockPaletteFormatVersion, blockPaletteSpriteCommentHeader, blockPaletteStageCommentHeader, formatBlockPaletteComment, serializeBlockPaletteDocument, validateBlockPaletteDocument } from "./block-palette.js";
|
|
3
|
+
import { applyBlockPaletteComments, blockPaletteCommentMarker, blockPaletteCommentMaxLength, blockPaletteCommentReference, blockPaletteFile, blockPaletteFormatVersion, blockPaletteSpriteCommentHeader, blockPaletteStageCommentHeader, extractBlockPalette, formatBlockPaletteComment, hasBlockPaletteSettings, resolveBlockPaletteReferences, serializeBlockPaletteDocument, validateBlockPaletteDocument } from "./block-palette.js";
|
|
4
4
|
import { validateArchiveEntryName } from "./archive.js";
|
|
5
5
|
import { compareExtensionApiManifests, defaultExtensionApiManifestSizeLimit, extensionApiManifestEffects, extensionApiManifestFormatVersion, extensionApiManifestFormatVersions, extensionApiManifestIntegrity, extensionApiManifestLocalPath, extensionApiManifestResultTypes, formatExtensionApiCompatibilityChanges, parseExtensionApiManifest, tryParseExtensionApiManifest, validateExtensionApiManifestSourceMetadata, validateManagedExtensionApiManifest } from "./extension-api-manifest.js";
|
|
6
6
|
import { extensionHeaderId, extensionHeaderMetadata, extensionIntegrity, unsandboxedRequirement, unsandboxedRequirements, validateExtensionSourceMetadata, validateManagedExtensionContents } from "./extension-dependencies.js";
|
|
@@ -21,4 +21,4 @@ import { migrateExtensionId, planExtensionIdMigration, validateNewExtensionId }
|
|
|
21
21
|
import { defaultKamishibaiManifestUrl, kamishibaiReplacementIds, replaceSb3Extensions } from "./extension-sb3-replacement.js";
|
|
22
22
|
import { defaultExtensionArtifactSizeLimit, extensionStatus, syncExtensions, updateExtensions } from "./extension-sync.js";
|
|
23
23
|
import { assertSb3ReleaseSnapshotMetadata, computeReleaseSourceIdentity, createSb3ReleaseSnapshot, createSb3ReleaseSnapshotMetadata, freezeSb3ReleaseSnapshot, readSb3ReleaseSnapshotMetadata, recordPublishedSb3ReleaseSnapshot, verifySb3ReleaseSnapshot, writeSb3ReleaseCandidate } from "./release-snapshot.js";
|
|
24
|
-
export { applyProjectAssetAdditions, assert, assertSb3ReleaseSnapshotMetadata, blockPaletteCommentMarker, blockPaletteCommentMaxLength, blockPaletteCommentReference, blockPaletteFile, blockPaletteFormatVersion, blockPaletteSourceFormatVersion, blockPaletteSpriteCommentHeader, blockPaletteStageCommentHeader, buildExtensionBundles, buildExtensionBundlesWithModules, buildSb3, bundleExtensions, bundleUnsandboxedRequirement, cleanUpSb3, cleanUpSb3Archive, cleanUpTurboWarpBlocks, compareDirectories, compareExtensionApiManifests, computeReleaseSourceIdentity, createDeterministicSb3, createSb3ReleaseSnapshot, createSb3ReleaseSnapshotMetadata, createStaticExtensionBundle, decodeExtensionDataUrl, defaultExtensionApiManifestSizeLimit, defaultExtensionArtifactSizeLimit, defaultKamishibaiManifestUrl, defaultSandboxedNotices, extensionApiManifestEffects, extensionApiManifestFormatVersion, extensionApiManifestFormatVersions, extensionApiManifestIntegrity, extensionApiManifestLocalPath, extensionApiManifestResultTypes, extensionBundleRecoveryMarker, extensionHeaderId, extensionHeaderMetadata, extensionIntegrity, extensionSourceTypes, extensionStatus, fixedZipTimestamp, formatBlockPaletteComment, formatExtensionApiCompatibilityChanges, formatExtensionDigestInventory, freezeSb3ReleaseSnapshot, importSb3, inspectGitOutputState, inspectSb3ExtensionDigests, inventoryExtensionDigests, kamishibaiReplacementIds, migrateExtensionId, packageName, packageVersion, parseExtensionApiManifest, planBundledSb3Unbundle, planExtensionBundle, planExtensionIdMigration, planExtensionUnbundle, projectAssetAdditionsFormatVersion, projectManifestKey, readProjectManifest, readSb3ReleaseSnapshotMetadata, recordPublishedSb3ReleaseSnapshot, replaceSb3Extensions, serializeBlockPaletteDocument, sourceFormatVersion, supportedSourceFormatVersions, syncExtensions, tryParseExtensionApiManifest, turboWarpCleanUpLayout, unbundleExtensions, unbundleSb3, unsandboxedRequirement, unsandboxedRequirements, updateExtensions, validateArchiveEntryName, validateBlockPaletteDocument, validateExtensionApiManifestSourceMetadata, validateExtensionBundleConfigurations, validateExtensionSourceMetadata, validateManagedExtensionApiManifest, validateManagedExtensionContents, validateNewExtensionId, validateOutputDirectoryPath, validateSb3Source, verifySb3ReleaseSnapshot, writeSb3ReleaseCandidate };
|
|
24
|
+
export { applyBlockPaletteComments, applyProjectAssetAdditions, assert, assertSb3ReleaseSnapshotMetadata, blockPaletteCommentMarker, blockPaletteCommentMaxLength, blockPaletteCommentReference, blockPaletteFile, blockPaletteFormatVersion, blockPaletteSourceFormatVersion, blockPaletteSpriteCommentHeader, blockPaletteStageCommentHeader, buildExtensionBundles, buildExtensionBundlesWithModules, buildSb3, bundleExtensions, bundleUnsandboxedRequirement, cleanUpSb3, cleanUpSb3Archive, cleanUpTurboWarpBlocks, compareDirectories, compareExtensionApiManifests, computeReleaseSourceIdentity, createDeterministicSb3, createSb3ReleaseSnapshot, createSb3ReleaseSnapshotMetadata, createStaticExtensionBundle, decodeExtensionDataUrl, defaultExtensionApiManifestSizeLimit, defaultExtensionArtifactSizeLimit, defaultKamishibaiManifestUrl, defaultSandboxedNotices, extensionApiManifestEffects, extensionApiManifestFormatVersion, extensionApiManifestFormatVersions, extensionApiManifestIntegrity, extensionApiManifestLocalPath, extensionApiManifestResultTypes, extensionBundleRecoveryMarker, extensionHeaderId, extensionHeaderMetadata, extensionIntegrity, extensionSourceTypes, extensionStatus, extractBlockPalette, fixedZipTimestamp, formatBlockPaletteComment, formatExtensionApiCompatibilityChanges, formatExtensionDigestInventory, freezeSb3ReleaseSnapshot, hasBlockPaletteSettings, importSb3, inspectGitOutputState, inspectSb3ExtensionDigests, inventoryExtensionDigests, kamishibaiReplacementIds, migrateExtensionId, packageName, packageVersion, parseExtensionApiManifest, planBundledSb3Unbundle, planExtensionBundle, planExtensionIdMigration, planExtensionUnbundle, projectAssetAdditionsFormatVersion, projectManifestKey, readProjectManifest, readSb3ReleaseSnapshotMetadata, recordPublishedSb3ReleaseSnapshot, replaceSb3Extensions, resolveBlockPaletteReferences, serializeBlockPaletteDocument, sourceFormatVersion, supportedSourceFormatVersions, syncExtensions, tryParseExtensionApiManifest, turboWarpCleanUpLayout, unbundleExtensions, unbundleSb3, unsandboxedRequirement, unsandboxedRequirements, updateExtensions, validateArchiveEntryName, validateBlockPaletteDocument, validateExtensionApiManifestSourceMetadata, validateExtensionBundleConfigurations, validateExtensionSourceMetadata, validateManagedExtensionApiManifest, validateManagedExtensionContents, validateNewExtensionId, validateOutputDirectoryPath, validateSb3Source, verifySb3ReleaseSnapshot, writeSb3ReleaseCandidate };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { UnknownRecord } from './types';
|
|
1
|
+
import { UnknownRecord } from './types.js';
|
|
2
2
|
export type ReleaseSnapshotState = 'candidate' | 'frozen' | 'published';
|
|
3
3
|
export type ReleaseSourceFiles = Map<string, Buffer | Uint8Array | string>;
|
|
4
4
|
export interface ReleaseSnapshotArtifact {
|
package/dist/source-format.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { EmbeddedExtension, ProjectJson, Sb3SourceManifest, UnknownRecord } from './types';
|
|
1
|
+
import { EmbeddedExtension, ProjectJson, Sb3SourceManifest, UnknownRecord } from './types.js';
|
|
2
2
|
/** The source format version written for projects without block palette settings. */
|
|
3
3
|
export declare const sourceFormatVersion = 1;
|
|
4
4
|
/** The source format version written for projects with `block-palette.json`. */
|
|
@@ -7,6 +7,13 @@ export declare const blockPaletteSourceFormatVersion = 2;
|
|
|
7
7
|
export declare const supportedSourceFormatVersions: readonly number[];
|
|
8
8
|
/** `embedded-extensions.json` keeps its own version, independent of the source format. */
|
|
9
9
|
export declare const embeddedExtensionManifestFormatVersion = 1;
|
|
10
|
+
/**
|
|
11
|
+
* The screen state TurboWarp Plus Editor saves with a project (its tab layout, block palette settings and so on).
|
|
12
|
+
* An SB3 carries it as this ZIP entry; Scratch and TurboWarp ignore it.
|
|
13
|
+
*/
|
|
14
|
+
export declare const screenStateEntry = "tw-plus/workspace.json";
|
|
15
|
+
/** Where a source folder keeps the screen state: the same file the Editor writes in a project folder. */
|
|
16
|
+
export declare const screenStateFile = ".tw-plus/workspace.json";
|
|
10
17
|
export declare function isObject(value: unknown): value is UnknownRecord;
|
|
11
18
|
export declare function assertSameFileSet(actualFiles: string[], expectedFiles: string[], description: string): void;
|
|
12
19
|
export declare function validateSourceManifest(manifest: unknown): asserts manifest is Sb3SourceManifest;
|
package/dist/source-format.js
CHANGED
|
@@ -8,6 +8,13 @@ var sourceFormatVersion = 1;
|
|
|
8
8
|
var blockPaletteSourceFormatVersion = 2;
|
|
9
9
|
/** Every source format version that readers accept. */
|
|
10
10
|
var supportedSourceFormatVersions = [1, 2];
|
|
11
|
+
/**
|
|
12
|
+
* The screen state TurboWarp Plus Editor saves with a project (its tab layout, block palette settings and so on).
|
|
13
|
+
* An SB3 carries it as this ZIP entry; Scratch and TurboWarp ignore it.
|
|
14
|
+
*/
|
|
15
|
+
var screenStateEntry = "tw-plus/workspace.json";
|
|
16
|
+
/** Where a source folder keeps the screen state: the same file the Editor writes in a project folder. */
|
|
17
|
+
var screenStateFile = ".tw-plus/workspace.json";
|
|
11
18
|
function isObject(value) {
|
|
12
19
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
13
20
|
}
|
|
@@ -129,6 +136,6 @@ function collectSourceAssetReferences(project) {
|
|
|
129
136
|
});
|
|
130
137
|
}
|
|
131
138
|
//#endregion
|
|
132
|
-
export { assertSameFileSet, blockPaletteSourceFormatVersion, collectSourceAssetReferences, isObject, sourceFormatVersion, supportedSourceFormatVersions, validateExtensionLayout, validateSourceManifest };
|
|
139
|
+
export { assertSameFileSet, blockPaletteSourceFormatVersion, collectSourceAssetReferences, isObject, screenStateEntry, screenStateFile, sourceFormatVersion, supportedSourceFormatVersions, validateExtensionLayout, validateSourceManifest };
|
|
133
140
|
|
|
134
141
|
//# sourceMappingURL=source-format.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"source-format.js","names":[],"sources":["../src/source-format.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {validateArchiveEntryName} from './archive';\nimport {assert} from './assert';\nimport {blockPaletteFile} from './block-palette';\nimport type {\n EmbeddedExtension,\n ProjectAssetReference,\n ProjectJson,\n Sb3SourceManifest,\n UnknownRecord,\n} from './types';\n\n/** The source format version written for projects without block palette settings. */\nexport const sourceFormatVersion = 1;\n/** The source format version written for projects with `block-palette.json`. */\nexport const blockPaletteSourceFormatVersion = 2;\n/** Every source format version that readers accept. */\nexport const supportedSourceFormatVersions: readonly number[] = [1, 2];\n/** `embedded-extensions.json` keeps its own version, independent of the source format. */\nexport const embeddedExtensionManifestFormatVersion = 1;\n\nexport function isObject(value: unknown): value is UnknownRecord {\n return typeof value === 'object' && value !== null && !Array.isArray(value);\n}\n\nexport function assertSameFileSet(\n actualFiles: string[],\n expectedFiles: string[],\n description: string,\n): void {\n const actual = new Set(actualFiles);\n const expected = new Set(expectedFiles);\n const missing = [...expected].filter((filePath) => !actual.has(filePath)).sort();\n const extra = [...actual].filter((filePath) => !expected.has(filePath)).sort();\n assert(\n missing.length === 0 && extra.length === 0,\n `${description} does not match its manifest. Missing: ${missing.join(', ') || '(none)'}. ` +\n `Extra: ${extra.join(', ') || '(none)'}.`,\n );\n}\n\nexport function validateSourceManifest(manifest: unknown): asserts manifest is Sb3SourceManifest {\n assert(isObject(manifest), 'sb3-source.json must contain an object.');\n assert(\n supportedSourceFormatVersions.includes(manifest.formatVersion as number),\n `Unsupported SB3 source format version: ${manifest.formatVersion}`,\n );\n if (manifest.formatVersion === blockPaletteSourceFormatVersion) {\n assert(\n manifest.blockPalette === blockPaletteFile,\n `SB3 source format 2 requires ${blockPaletteFile}.`,\n );\n } else {\n assert(\n manifest.blockPalette === undefined,\n 'sb3-source.json blockPalette requires SB3 source format 2.',\n );\n }\n assert(\n manifest.project === 'project.source.json',\n 'SB3 source format 1 requires project.source.json.',\n );\n assert(\n manifest.embeddedExtensions === 'embedded-extensions.json',\n 'SB3 source format 1 requires embedded-extensions.json.',\n );\n assert(\n manifest.assetsDirectory === 'assets',\n 'SB3 source format 1 requires the assets directory.',\n );\n assert(\n Array.isArray(manifest.archiveEntries) && manifest.archiveEntries.length > 0,\n 'sb3-source.json archiveEntries must be a non-empty array.',\n );\n\n const seenEntries = new Set<string>();\n let projectEntryCount = 0;\n for (const rawEntryName of manifest.archiveEntries as unknown[]) {\n const entryName = validateArchiveEntryName(rawEntryName);\n assert(!seenEntries.has(entryName), `Duplicate archive entry in manifest: ${entryName}`);\n assert(\n !entryName.endsWith('/'),\n `Directory ZIP entries are not supported in SB3 source format 1: ${entryName}`,\n );\n assert(\n !/^(?:0|[1-9][0-9]*)$/u.test(entryName),\n `Integer-like ZIP entry names cannot preserve JavaScript object order: ${entryName}`,\n );\n seenEntries.add(entryName);\n if (entryName === 'project.json') {\n projectEntryCount += 1;\n }\n }\n assert(projectEntryCount === 1, 'archiveEntries must contain project.json exactly once.');\n}\n\nexport function validateExtensionLayout(\n extensionManifest: unknown,\n project: ProjectJson,\n extensionFiles: string[],\n validateManagedSource?: (extension: EmbeddedExtension) => unknown,\n): {extensionBundles: unknown; extensions: EmbeddedExtension[]} {\n assert(isObject(extensionManifest), 'embedded-extensions.json must contain an object.');\n assert(\n extensionManifest.formatVersion === embeddedExtensionManifestFormatVersion,\n `Unsupported embedded extension manifest version: ${extensionManifest.formatVersion}`,\n );\n assert(\n Array.isArray(extensionManifest.extensions),\n 'embedded-extensions.json extensions must be an array.',\n );\n\n const extensionUrls: unknown = project.extensionURLs ?? {};\n assert(\n isObject(extensionUrls),\n 'project.source.json extensionURLs must be an object when present.',\n );\n const extensionsById = new Map<string, EmbeddedExtension>();\n const expectedFiles: string[] = [];\n const extensions: EmbeddedExtension[] = [];\n\n for (const entry of extensionManifest.extensions as unknown[]) {\n assert(isObject(entry), 'Each embedded extension manifest entry must be an object.');\n const extension = entry as unknown as EmbeddedExtension;\n assert(\n typeof extension.id === 'string' && /^[A-Za-z0-9._-]+$/u.test(extension.id),\n `Invalid embedded extension ID: ${JSON.stringify(extension.id)}`,\n );\n assert(!extensionsById.has(extension.id), `Duplicate embedded extension ID: ${extension.id}`);\n const expectedPath = `extensions/${extension.id}.js`;\n assert(\n extension.path === expectedPath,\n `Embedded extension path must match its ID: expected ${expectedPath}, got ${extension.path}`,\n );\n assert(\n typeof extension.mediaType === 'string' &&\n extension.mediaType.length > 0 &&\n !/[;,\\r\\n]/u.test(extension.mediaType),\n `Invalid media type for embedded extension ${extension.id}: ${extension.mediaType}`,\n );\n assert(\n Array.isArray(extension.parameters) &&\n extension.parameters.every(\n (parameter) =>\n typeof parameter === 'string' && parameter.length > 0 && !/[;,\\r\\n]/u.test(parameter),\n ),\n `Invalid data URL parameters for embedded extension ${extension.id}.`,\n );\n assert(\n extension.encoding === 'base64' || extension.encoding === 'percent',\n `Unsupported encoding for embedded extension ${extension.id}: ${extension.encoding}`,\n );\n assert(\n extensionUrls[extension.id] === `embedded-extension:${extension.path}`,\n `project.source.json mapping does not match embedded extension ${extension.id}.`,\n );\n if (extension.source !== undefined) {\n assert(isObject(extension.source), `Invalid source for embedded extension ${extension.id}.`);\n const sidecar = extension.source.apiManifest;\n assert(\n sidecar === undefined ||\n (isObject(sidecar) && sidecar.path === `extensions/${extension.id}.manifest.json`),\n `Invalid API manifest path for embedded extension ${extension.id}.`,\n );\n }\n validateManagedSource?.(extension);\n extensionsById.set(extension.id, extension);\n extensions.push(extension);\n expectedFiles.push(`${extension.id}.js`);\n if (extension.source?.apiManifest) {\n expectedFiles.push(extension.source.apiManifest.path.slice('extensions/'.length));\n }\n }\n\n for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {\n assert(\n typeof extensionUrl !== 'string' || !extensionUrl.startsWith('data:'),\n `project.source.json still contains an embedded data URL: ${extensionId}`,\n );\n if (typeof extensionUrl === 'string' && extensionUrl.startsWith('embedded-extension:')) {\n assert(\n extensionsById.has(extensionId),\n `project.source.json has no metadata for embedded extension ${extensionId}.`,\n );\n }\n }\n\n assertSameFileSet(extensionFiles, expectedFiles, 'Embedded extension files');\n return {\n extensionBundles: extensionManifest.extensionBundles,\n extensions,\n };\n}\n\nfunction collectAssetReferences(\n project: ProjectJson,\n): {asset: ProjectAssetReference; description: string}[] {\n assert(Array.isArray(project.targets), 'project.source.json targets must be an array.');\n const references: {asset: ProjectAssetReference; description: string}[] = [];\n for (const [targetIndex, target] of (project.targets as unknown[]).entries()) {\n assert(isObject(target), `Project target ${targetIndex} must be an object.`);\n for (const [collectionName, kind] of [\n ['costumes', 'costume'],\n ['sounds', 'sound'],\n ] as const) {\n const assets: unknown = target[collectionName] ?? [];\n assert(\n Array.isArray(assets),\n `Project target ${targetIndex} ${collectionName} must be an array.`,\n );\n for (const [assetIndex, asset] of (assets as unknown[]).entries()) {\n assert(isObject(asset), `Project ${kind} ${targetIndex}:${assetIndex} must be an object.`);\n references.push({asset, description: `${kind} ${targetIndex}:${assetIndex}`});\n }\n }\n }\n const fonts = project.customFonts ?? [];\n assert(Array.isArray(fonts), 'project.source.json customFonts must be an array.');\n for (const [index, font] of fonts.entries()) {\n if (!isObject(font) || font.system !== false || font.md5ext === undefined) continue;\n const md5ext = font.md5ext;\n const match = typeof md5ext === 'string' && /^([a-f0-9]{32})\\.(ttf|otf|woff2?)$/u.exec(md5ext);\n assert(match, `Invalid font asset reference for font ${index}: ${md5ext}`);\n const [, assetId, dataFormat] = match;\n references.push({asset: {assetId, dataFormat, md5ext}, description: `font ${index}`});\n }\n return references;\n}\n\nexport function collectSourceAssetReferences(\n project: ProjectJson,\n): {filename: string; description: string}[] {\n return collectAssetReferences(project).map(({asset, description}) => {\n assert(\n typeof asset.assetId === 'string' && /^[a-f0-9]{32}$/u.test(asset.assetId),\n `Invalid assetId for ${description}: ${asset.assetId}`,\n );\n assert(\n typeof asset.dataFormat === 'string' && /^[A-Za-z0-9]+$/u.test(asset.dataFormat),\n `Invalid dataFormat for ${description}: ${asset.dataFormat}`,\n );\n const expectedFilename = `${asset.assetId}.${asset.dataFormat}`;\n assert(\n asset.md5ext === expectedFilename,\n `Asset filename mismatch for ${description}: expected ${expectedFilename}, got ${asset.md5ext}`,\n );\n return {filename: expectedFilename, description};\n });\n}\n"],"mappings":";;;;;AAcA,IAAa,sBAAsB;;AAEnC,IAAa,kCAAkC;;AAE/C,IAAa,gCAAmD,CAAC,GAAG,CAAC;AAIrE,SAAgB,SAAS,OAAwC;CAC/D,OAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAgB,kBACd,aACA,eACA,aACM;CACN,MAAM,SAAS,IAAI,IAAI,WAAW;CAClC,MAAM,WAAW,IAAI,IAAI,aAAa;CACtC,MAAM,UAAU,CAAC,GAAG,QAAQ,CAAC,CAAC,QAAQ,aAAa,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK;CAC/E,MAAM,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,QAAQ,aAAa,CAAC,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK;CAC7E,OACE,QAAQ,WAAW,KAAK,MAAM,WAAW,GACzC,GAAG,YAAY,yCAAyC,QAAQ,KAAK,IAAI,KAAK,SAAS,WAC3E,MAAM,KAAK,IAAI,KAAK,SAAS,EAC3C;AACF;AAEA,SAAgB,uBAAuB,UAA0D;CAC/F,OAAO,SAAS,QAAQ,GAAG,yCAAyC;CACpE,OACE,8BAA8B,SAAS,SAAS,aAAuB,GACvE,0CAA0C,SAAS,eACrD;CACA,IAAI,SAAS,kBAAA,GACX,OACE,SAAS,iBAAiB,kBAC1B,gCAAgC,iBAAiB,EACnD;MAEA,OACE,SAAS,iBAAiB,KAAA,GAC1B,4DACF;CAEF,OACE,SAAS,YAAY,uBACrB,mDACF;CACA,OACE,SAAS,uBAAuB,4BAChC,wDACF;CACA,OACE,SAAS,oBAAoB,UAC7B,oDACF;CACA,OACE,MAAM,QAAQ,SAAS,cAAc,KAAK,SAAS,eAAe,SAAS,GAC3E,2DACF;CAEA,MAAM,8BAAc,IAAI,IAAY;CACpC,IAAI,oBAAoB;CACxB,KAAK,MAAM,gBAAgB,SAAS,gBAA6B;EAC/D,MAAM,YAAY,yBAAyB,YAAY;EACvD,OAAO,CAAC,YAAY,IAAI,SAAS,GAAG,wCAAwC,WAAW;EACvF,OACE,CAAC,UAAU,SAAS,GAAG,GACvB,mEAAmE,WACrE;EACA,OACE,CAAC,uBAAuB,KAAK,SAAS,GACtC,yEAAyE,WAC3E;EACA,YAAY,IAAI,SAAS;EACzB,IAAI,cAAc,gBAChB,qBAAqB;CAEzB;CACA,OAAO,sBAAsB,GAAG,wDAAwD;AAC1F;AAEA,SAAgB,wBACd,mBACA,SACA,gBACA,uBAC8D;CAC9D,OAAO,SAAS,iBAAiB,GAAG,kDAAkD;CACtF,OACE,kBAAkB,kBAAA,GAClB,oDAAoD,kBAAkB,eACxE;CACA,OACE,MAAM,QAAQ,kBAAkB,UAAU,GAC1C,uDACF;CAEA,MAAM,gBAAyB,QAAQ,iBAAiB,CAAC;CACzD,OACE,SAAS,aAAa,GACtB,mEACF;CACA,MAAM,iCAAiB,IAAI,IAA+B;CAC1D,MAAM,gBAA0B,CAAC;CACjC,MAAM,aAAkC,CAAC;CAEzC,KAAK,MAAM,SAAS,kBAAkB,YAAyB;EAC7D,OAAO,SAAS,KAAK,GAAG,2DAA2D;EACnF,MAAM,YAAY;EAClB,OACE,OAAO,UAAU,OAAO,YAAY,qBAAqB,KAAK,UAAU,EAAE,GAC1E,kCAAkC,KAAK,UAAU,UAAU,EAAE,GAC/D;EACA,OAAO,CAAC,eAAe,IAAI,UAAU,EAAE,GAAG,oCAAoC,UAAU,IAAI;EAC5F,MAAM,eAAe,cAAc,UAAU,GAAG;EAChD,OACE,UAAU,SAAS,cACnB,uDAAuD,aAAa,QAAQ,UAAU,MACxF;EACA,OACE,OAAO,UAAU,cAAc,YAC7B,UAAU,UAAU,SAAS,KAC7B,CAAC,YAAY,KAAK,UAAU,SAAS,GACvC,6CAA6C,UAAU,GAAG,IAAI,UAAU,WAC1E;EACA,OACE,MAAM,QAAQ,UAAU,UAAU,KAChC,UAAU,WAAW,OAClB,cACC,OAAO,cAAc,YAAY,UAAU,SAAS,KAAK,CAAC,YAAY,KAAK,SAAS,CACxF,GACF,sDAAsD,UAAU,GAAG,EACrE;EACA,OACE,UAAU,aAAa,YAAY,UAAU,aAAa,WAC1D,+CAA+C,UAAU,GAAG,IAAI,UAAU,UAC5E;EACA,OACE,cAAc,UAAU,QAAQ,sBAAsB,UAAU,QAChE,iEAAiE,UAAU,GAAG,EAChF;EACA,IAAI,UAAU,WAAW,KAAA,GAAW;GAClC,OAAO,SAAS,UAAU,MAAM,GAAG,yCAAyC,UAAU,GAAG,EAAE;GAC3F,MAAM,UAAU,UAAU,OAAO;GACjC,OACE,YAAY,KAAA,KACT,SAAS,OAAO,KAAK,QAAQ,SAAS,cAAc,UAAU,GAAG,iBACpE,oDAAoD,UAAU,GAAG,EACnE;EACF;EACA,wBAAwB,SAAS;EACjC,eAAe,IAAI,UAAU,IAAI,SAAS;EAC1C,WAAW,KAAK,SAAS;EACzB,cAAc,KAAK,GAAG,UAAU,GAAG,IAAI;EACvC,IAAI,UAAU,QAAQ,aACpB,cAAc,KAAK,UAAU,OAAO,YAAY,KAAK,MAAM,EAAoB,CAAC;CAEpF;CAEA,KAAK,MAAM,CAAC,aAAa,iBAAiB,OAAO,QAAQ,aAAa,GAAG;EACvE,OACE,OAAO,iBAAiB,YAAY,CAAC,aAAa,WAAW,OAAO,GACpE,4DAA4D,aAC9D;EACA,IAAI,OAAO,iBAAiB,YAAY,aAAa,WAAW,qBAAqB,GACnF,OACE,eAAe,IAAI,WAAW,GAC9B,8DAA8D,YAAY,EAC5E;CAEJ;CAEA,kBAAkB,gBAAgB,eAAe,0BAA0B;CAC3E,OAAO;EACL,kBAAkB,kBAAkB;EACpC;CACF;AACF;AAEA,SAAS,uBACP,SACuD;CACvD,OAAO,MAAM,QAAQ,QAAQ,OAAO,GAAG,+CAA+C;CACtF,MAAM,aAAoE,CAAC;CAC3E,KAAK,MAAM,CAAC,aAAa,WAAY,QAAQ,QAAsB,QAAQ,GAAG;EAC5E,OAAO,SAAS,MAAM,GAAG,kBAAkB,YAAY,oBAAoB;EAC3E,KAAK,MAAM,CAAC,gBAAgB,SAAS,CACnC,CAAC,YAAY,SAAS,GACtB,CAAC,UAAU,OAAO,CACpB,GAAY;GACV,MAAM,SAAkB,OAAO,mBAAmB,CAAC;GACnD,OACE,MAAM,QAAQ,MAAM,GACpB,kBAAkB,YAAY,GAAG,eAAe,mBAClD;GACA,KAAK,MAAM,CAAC,YAAY,UAAW,OAAqB,QAAQ,GAAG;IACjE,OAAO,SAAS,KAAK,GAAG,WAAW,KAAK,GAAG,YAAY,GAAG,WAAW,oBAAoB;IACzF,WAAW,KAAK;KAAC;KAAO,aAAa,GAAG,KAAK,GAAG,YAAY,GAAG;IAAY,CAAC;GAC9E;EACF;CACF;CACA,MAAM,QAAQ,QAAQ,eAAe,CAAC;CACtC,OAAO,MAAM,QAAQ,KAAK,GAAG,mDAAmD;CAChF,KAAK,MAAM,CAAC,OAAO,SAAS,MAAM,QAAQ,GAAG;EAC3C,IAAI,CAAC,SAAS,IAAI,KAAK,KAAK,WAAW,SAAS,KAAK,WAAW,KAAA,GAAW;EAC3E,MAAM,SAAS,KAAK;EACpB,MAAM,QAAQ,OAAO,WAAW,YAAY,sCAAsC,KAAK,MAAM;EAC7F,OAAO,OAAO,yCAAyC,MAAM,IAAI,QAAQ;EACzE,MAAM,GAAG,SAAS,cAAc;EAChC,WAAW,KAAK;GAAC,OAAO;IAAC;IAAS;IAAY;GAAM;GAAG,aAAa,QAAQ;EAAO,CAAC;CACtF;CACA,OAAO;AACT;AAEA,SAAgB,6BACd,SAC2C;CAC3C,OAAO,uBAAuB,OAAO,CAAC,CAAC,KAAK,EAAC,OAAO,kBAAiB;EACnE,OACE,OAAO,MAAM,YAAY,YAAY,kBAAkB,KAAK,MAAM,OAAO,GACzE,uBAAuB,YAAY,IAAI,MAAM,SAC/C;EACA,OACE,OAAO,MAAM,eAAe,YAAY,kBAAkB,KAAK,MAAM,UAAU,GAC/E,0BAA0B,YAAY,IAAI,MAAM,YAClD;EACA,MAAM,mBAAmB,GAAG,MAAM,QAAQ,GAAG,MAAM;EACnD,OACE,MAAM,WAAW,kBACjB,+BAA+B,YAAY,aAAa,iBAAiB,QAAQ,MAAM,QACzF;EACA,OAAO;GAAC,UAAU;GAAkB;EAAW;CACjD,CAAC;AACH"}
|
|
1
|
+
{"version":3,"file":"source-format.js","names":[],"sources":["../src/source-format.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {validateArchiveEntryName} from './archive';\nimport {assert} from './assert';\nimport {blockPaletteFile} from './block-palette';\nimport type {\n EmbeddedExtension,\n ProjectAssetReference,\n ProjectJson,\n Sb3SourceManifest,\n UnknownRecord,\n} from './types';\n\n/** The source format version written for projects without block palette settings. */\nexport const sourceFormatVersion = 1;\n/** The source format version written for projects with `block-palette.json`. */\nexport const blockPaletteSourceFormatVersion = 2;\n/** Every source format version that readers accept. */\nexport const supportedSourceFormatVersions: readonly number[] = [1, 2];\n/** `embedded-extensions.json` keeps its own version, independent of the source format. */\nexport const embeddedExtensionManifestFormatVersion = 1;\n\n/**\n * The screen state TurboWarp Plus Editor saves with a project (its tab layout, block palette settings and so on).\n * An SB3 carries it as this ZIP entry; Scratch and TurboWarp ignore it.\n */\nexport const screenStateEntry = 'tw-plus/workspace.json';\n/** Where a source folder keeps the screen state: the same file the Editor writes in a project folder. */\nexport const screenStateFile = '.tw-plus/workspace.json';\n\nexport function isObject(value: unknown): value is UnknownRecord {\n return typeof value === 'object' && value !== null && !Array.isArray(value);\n}\n\nexport function assertSameFileSet(\n actualFiles: string[],\n expectedFiles: string[],\n description: string,\n): void {\n const actual = new Set(actualFiles);\n const expected = new Set(expectedFiles);\n const missing = [...expected].filter((filePath) => !actual.has(filePath)).sort();\n const extra = [...actual].filter((filePath) => !expected.has(filePath)).sort();\n assert(\n missing.length === 0 && extra.length === 0,\n `${description} does not match its manifest. Missing: ${missing.join(', ') || '(none)'}. ` +\n `Extra: ${extra.join(', ') || '(none)'}.`,\n );\n}\n\nexport function validateSourceManifest(manifest: unknown): asserts manifest is Sb3SourceManifest {\n assert(isObject(manifest), 'sb3-source.json must contain an object.');\n assert(\n supportedSourceFormatVersions.includes(manifest.formatVersion as number),\n `Unsupported SB3 source format version: ${manifest.formatVersion}`,\n );\n if (manifest.formatVersion === blockPaletteSourceFormatVersion) {\n assert(\n manifest.blockPalette === blockPaletteFile,\n `SB3 source format 2 requires ${blockPaletteFile}.`,\n );\n } else {\n assert(\n manifest.blockPalette === undefined,\n 'sb3-source.json blockPalette requires SB3 source format 2.',\n );\n }\n assert(\n manifest.project === 'project.source.json',\n 'SB3 source format 1 requires project.source.json.',\n );\n assert(\n manifest.embeddedExtensions === 'embedded-extensions.json',\n 'SB3 source format 1 requires embedded-extensions.json.',\n );\n assert(\n manifest.assetsDirectory === 'assets',\n 'SB3 source format 1 requires the assets directory.',\n );\n assert(\n Array.isArray(manifest.archiveEntries) && manifest.archiveEntries.length > 0,\n 'sb3-source.json archiveEntries must be a non-empty array.',\n );\n\n const seenEntries = new Set<string>();\n let projectEntryCount = 0;\n for (const rawEntryName of manifest.archiveEntries as unknown[]) {\n const entryName = validateArchiveEntryName(rawEntryName);\n assert(!seenEntries.has(entryName), `Duplicate archive entry in manifest: ${entryName}`);\n assert(\n !entryName.endsWith('/'),\n `Directory ZIP entries are not supported in SB3 source format 1: ${entryName}`,\n );\n assert(\n !/^(?:0|[1-9][0-9]*)$/u.test(entryName),\n `Integer-like ZIP entry names cannot preserve JavaScript object order: ${entryName}`,\n );\n seenEntries.add(entryName);\n if (entryName === 'project.json') {\n projectEntryCount += 1;\n }\n }\n assert(projectEntryCount === 1, 'archiveEntries must contain project.json exactly once.');\n}\n\nexport function validateExtensionLayout(\n extensionManifest: unknown,\n project: ProjectJson,\n extensionFiles: string[],\n validateManagedSource?: (extension: EmbeddedExtension) => unknown,\n): {extensionBundles: unknown; extensions: EmbeddedExtension[]} {\n assert(isObject(extensionManifest), 'embedded-extensions.json must contain an object.');\n assert(\n extensionManifest.formatVersion === embeddedExtensionManifestFormatVersion,\n `Unsupported embedded extension manifest version: ${extensionManifest.formatVersion}`,\n );\n assert(\n Array.isArray(extensionManifest.extensions),\n 'embedded-extensions.json extensions must be an array.',\n );\n\n const extensionUrls: unknown = project.extensionURLs ?? {};\n assert(\n isObject(extensionUrls),\n 'project.source.json extensionURLs must be an object when present.',\n );\n const extensionsById = new Map<string, EmbeddedExtension>();\n const expectedFiles: string[] = [];\n const extensions: EmbeddedExtension[] = [];\n\n for (const entry of extensionManifest.extensions as unknown[]) {\n assert(isObject(entry), 'Each embedded extension manifest entry must be an object.');\n const extension = entry as unknown as EmbeddedExtension;\n assert(\n typeof extension.id === 'string' && /^[A-Za-z0-9._-]+$/u.test(extension.id),\n `Invalid embedded extension ID: ${JSON.stringify(extension.id)}`,\n );\n assert(!extensionsById.has(extension.id), `Duplicate embedded extension ID: ${extension.id}`);\n const expectedPath = `extensions/${extension.id}.js`;\n assert(\n extension.path === expectedPath,\n `Embedded extension path must match its ID: expected ${expectedPath}, got ${extension.path}`,\n );\n assert(\n typeof extension.mediaType === 'string' &&\n extension.mediaType.length > 0 &&\n !/[;,\\r\\n]/u.test(extension.mediaType),\n `Invalid media type for embedded extension ${extension.id}: ${extension.mediaType}`,\n );\n assert(\n Array.isArray(extension.parameters) &&\n extension.parameters.every(\n (parameter) =>\n typeof parameter === 'string' && parameter.length > 0 && !/[;,\\r\\n]/u.test(parameter),\n ),\n `Invalid data URL parameters for embedded extension ${extension.id}.`,\n );\n assert(\n extension.encoding === 'base64' || extension.encoding === 'percent',\n `Unsupported encoding for embedded extension ${extension.id}: ${extension.encoding}`,\n );\n assert(\n extensionUrls[extension.id] === `embedded-extension:${extension.path}`,\n `project.source.json mapping does not match embedded extension ${extension.id}.`,\n );\n if (extension.source !== undefined) {\n assert(isObject(extension.source), `Invalid source for embedded extension ${extension.id}.`);\n const sidecar = extension.source.apiManifest;\n assert(\n sidecar === undefined ||\n (isObject(sidecar) && sidecar.path === `extensions/${extension.id}.manifest.json`),\n `Invalid API manifest path for embedded extension ${extension.id}.`,\n );\n }\n validateManagedSource?.(extension);\n extensionsById.set(extension.id, extension);\n extensions.push(extension);\n expectedFiles.push(`${extension.id}.js`);\n if (extension.source?.apiManifest) {\n expectedFiles.push(extension.source.apiManifest.path.slice('extensions/'.length));\n }\n }\n\n for (const [extensionId, extensionUrl] of Object.entries(extensionUrls)) {\n assert(\n typeof extensionUrl !== 'string' || !extensionUrl.startsWith('data:'),\n `project.source.json still contains an embedded data URL: ${extensionId}`,\n );\n if (typeof extensionUrl === 'string' && extensionUrl.startsWith('embedded-extension:')) {\n assert(\n extensionsById.has(extensionId),\n `project.source.json has no metadata for embedded extension ${extensionId}.`,\n );\n }\n }\n\n assertSameFileSet(extensionFiles, expectedFiles, 'Embedded extension files');\n return {\n extensionBundles: extensionManifest.extensionBundles,\n extensions,\n };\n}\n\nfunction collectAssetReferences(\n project: ProjectJson,\n): {asset: ProjectAssetReference; description: string}[] {\n assert(Array.isArray(project.targets), 'project.source.json targets must be an array.');\n const references: {asset: ProjectAssetReference; description: string}[] = [];\n for (const [targetIndex, target] of (project.targets as unknown[]).entries()) {\n assert(isObject(target), `Project target ${targetIndex} must be an object.`);\n for (const [collectionName, kind] of [\n ['costumes', 'costume'],\n ['sounds', 'sound'],\n ] as const) {\n const assets: unknown = target[collectionName] ?? [];\n assert(\n Array.isArray(assets),\n `Project target ${targetIndex} ${collectionName} must be an array.`,\n );\n for (const [assetIndex, asset] of (assets as unknown[]).entries()) {\n assert(isObject(asset), `Project ${kind} ${targetIndex}:${assetIndex} must be an object.`);\n references.push({asset, description: `${kind} ${targetIndex}:${assetIndex}`});\n }\n }\n }\n const fonts = project.customFonts ?? [];\n assert(Array.isArray(fonts), 'project.source.json customFonts must be an array.');\n for (const [index, font] of fonts.entries()) {\n if (!isObject(font) || font.system !== false || font.md5ext === undefined) continue;\n const md5ext = font.md5ext;\n const match = typeof md5ext === 'string' && /^([a-f0-9]{32})\\.(ttf|otf|woff2?)$/u.exec(md5ext);\n assert(match, `Invalid font asset reference for font ${index}: ${md5ext}`);\n const [, assetId, dataFormat] = match;\n references.push({asset: {assetId, dataFormat, md5ext}, description: `font ${index}`});\n }\n return references;\n}\n\nexport function collectSourceAssetReferences(\n project: ProjectJson,\n): {filename: string; description: string}[] {\n return collectAssetReferences(project).map(({asset, description}) => {\n assert(\n typeof asset.assetId === 'string' && /^[a-f0-9]{32}$/u.test(asset.assetId),\n `Invalid assetId for ${description}: ${asset.assetId}`,\n );\n assert(\n typeof asset.dataFormat === 'string' && /^[A-Za-z0-9]+$/u.test(asset.dataFormat),\n `Invalid dataFormat for ${description}: ${asset.dataFormat}`,\n );\n const expectedFilename = `${asset.assetId}.${asset.dataFormat}`;\n assert(\n asset.md5ext === expectedFilename,\n `Asset filename mismatch for ${description}: expected ${expectedFilename}, got ${asset.md5ext}`,\n );\n return {filename: expectedFilename, description};\n });\n}\n"],"mappings":";;;;;AAcA,IAAa,sBAAsB;;AAEnC,IAAa,kCAAkC;;AAE/C,IAAa,gCAAmD,CAAC,GAAG,CAAC;;;;;AAQrE,IAAa,mBAAmB;;AAEhC,IAAa,kBAAkB;AAE/B,SAAgB,SAAS,OAAwC;CAC/D,OAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC5E;AAEA,SAAgB,kBACd,aACA,eACA,aACM;CACN,MAAM,SAAS,IAAI,IAAI,WAAW;CAClC,MAAM,WAAW,IAAI,IAAI,aAAa;CACtC,MAAM,UAAU,CAAC,GAAG,QAAQ,CAAC,CAAC,QAAQ,aAAa,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK;CAC/E,MAAM,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,QAAQ,aAAa,CAAC,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK;CAC7E,OACE,QAAQ,WAAW,KAAK,MAAM,WAAW,GACzC,GAAG,YAAY,yCAAyC,QAAQ,KAAK,IAAI,KAAK,SAAS,WAC3E,MAAM,KAAK,IAAI,KAAK,SAAS,EAC3C;AACF;AAEA,SAAgB,uBAAuB,UAA0D;CAC/F,OAAO,SAAS,QAAQ,GAAG,yCAAyC;CACpE,OACE,8BAA8B,SAAS,SAAS,aAAuB,GACvE,0CAA0C,SAAS,eACrD;CACA,IAAI,SAAS,kBAAA,GACX,OACE,SAAS,iBAAiB,kBAC1B,gCAAgC,iBAAiB,EACnD;MAEA,OACE,SAAS,iBAAiB,KAAA,GAC1B,4DACF;CAEF,OACE,SAAS,YAAY,uBACrB,mDACF;CACA,OACE,SAAS,uBAAuB,4BAChC,wDACF;CACA,OACE,SAAS,oBAAoB,UAC7B,oDACF;CACA,OACE,MAAM,QAAQ,SAAS,cAAc,KAAK,SAAS,eAAe,SAAS,GAC3E,2DACF;CAEA,MAAM,8BAAc,IAAI,IAAY;CACpC,IAAI,oBAAoB;CACxB,KAAK,MAAM,gBAAgB,SAAS,gBAA6B;EAC/D,MAAM,YAAY,yBAAyB,YAAY;EACvD,OAAO,CAAC,YAAY,IAAI,SAAS,GAAG,wCAAwC,WAAW;EACvF,OACE,CAAC,UAAU,SAAS,GAAG,GACvB,mEAAmE,WACrE;EACA,OACE,CAAC,uBAAuB,KAAK,SAAS,GACtC,yEAAyE,WAC3E;EACA,YAAY,IAAI,SAAS;EACzB,IAAI,cAAc,gBAChB,qBAAqB;CAEzB;CACA,OAAO,sBAAsB,GAAG,wDAAwD;AAC1F;AAEA,SAAgB,wBACd,mBACA,SACA,gBACA,uBAC8D;CAC9D,OAAO,SAAS,iBAAiB,GAAG,kDAAkD;CACtF,OACE,kBAAkB,kBAAA,GAClB,oDAAoD,kBAAkB,eACxE;CACA,OACE,MAAM,QAAQ,kBAAkB,UAAU,GAC1C,uDACF;CAEA,MAAM,gBAAyB,QAAQ,iBAAiB,CAAC;CACzD,OACE,SAAS,aAAa,GACtB,mEACF;CACA,MAAM,iCAAiB,IAAI,IAA+B;CAC1D,MAAM,gBAA0B,CAAC;CACjC,MAAM,aAAkC,CAAC;CAEzC,KAAK,MAAM,SAAS,kBAAkB,YAAyB;EAC7D,OAAO,SAAS,KAAK,GAAG,2DAA2D;EACnF,MAAM,YAAY;EAClB,OACE,OAAO,UAAU,OAAO,YAAY,qBAAqB,KAAK,UAAU,EAAE,GAC1E,kCAAkC,KAAK,UAAU,UAAU,EAAE,GAC/D;EACA,OAAO,CAAC,eAAe,IAAI,UAAU,EAAE,GAAG,oCAAoC,UAAU,IAAI;EAC5F,MAAM,eAAe,cAAc,UAAU,GAAG;EAChD,OACE,UAAU,SAAS,cACnB,uDAAuD,aAAa,QAAQ,UAAU,MACxF;EACA,OACE,OAAO,UAAU,cAAc,YAC7B,UAAU,UAAU,SAAS,KAC7B,CAAC,YAAY,KAAK,UAAU,SAAS,GACvC,6CAA6C,UAAU,GAAG,IAAI,UAAU,WAC1E;EACA,OACE,MAAM,QAAQ,UAAU,UAAU,KAChC,UAAU,WAAW,OAClB,cACC,OAAO,cAAc,YAAY,UAAU,SAAS,KAAK,CAAC,YAAY,KAAK,SAAS,CACxF,GACF,sDAAsD,UAAU,GAAG,EACrE;EACA,OACE,UAAU,aAAa,YAAY,UAAU,aAAa,WAC1D,+CAA+C,UAAU,GAAG,IAAI,UAAU,UAC5E;EACA,OACE,cAAc,UAAU,QAAQ,sBAAsB,UAAU,QAChE,iEAAiE,UAAU,GAAG,EAChF;EACA,IAAI,UAAU,WAAW,KAAA,GAAW;GAClC,OAAO,SAAS,UAAU,MAAM,GAAG,yCAAyC,UAAU,GAAG,EAAE;GAC3F,MAAM,UAAU,UAAU,OAAO;GACjC,OACE,YAAY,KAAA,KACT,SAAS,OAAO,KAAK,QAAQ,SAAS,cAAc,UAAU,GAAG,iBACpE,oDAAoD,UAAU,GAAG,EACnE;EACF;EACA,wBAAwB,SAAS;EACjC,eAAe,IAAI,UAAU,IAAI,SAAS;EAC1C,WAAW,KAAK,SAAS;EACzB,cAAc,KAAK,GAAG,UAAU,GAAG,IAAI;EACvC,IAAI,UAAU,QAAQ,aACpB,cAAc,KAAK,UAAU,OAAO,YAAY,KAAK,MAAM,EAAoB,CAAC;CAEpF;CAEA,KAAK,MAAM,CAAC,aAAa,iBAAiB,OAAO,QAAQ,aAAa,GAAG;EACvE,OACE,OAAO,iBAAiB,YAAY,CAAC,aAAa,WAAW,OAAO,GACpE,4DAA4D,aAC9D;EACA,IAAI,OAAO,iBAAiB,YAAY,aAAa,WAAW,qBAAqB,GACnF,OACE,eAAe,IAAI,WAAW,GAC9B,8DAA8D,YAAY,EAC5E;CAEJ;CAEA,kBAAkB,gBAAgB,eAAe,0BAA0B;CAC3E,OAAO;EACL,kBAAkB,kBAAkB;EACpC;CACF;AACF;AAEA,SAAS,uBACP,SACuD;CACvD,OAAO,MAAM,QAAQ,QAAQ,OAAO,GAAG,+CAA+C;CACtF,MAAM,aAAoE,CAAC;CAC3E,KAAK,MAAM,CAAC,aAAa,WAAY,QAAQ,QAAsB,QAAQ,GAAG;EAC5E,OAAO,SAAS,MAAM,GAAG,kBAAkB,YAAY,oBAAoB;EAC3E,KAAK,MAAM,CAAC,gBAAgB,SAAS,CACnC,CAAC,YAAY,SAAS,GACtB,CAAC,UAAU,OAAO,CACpB,GAAY;GACV,MAAM,SAAkB,OAAO,mBAAmB,CAAC;GACnD,OACE,MAAM,QAAQ,MAAM,GACpB,kBAAkB,YAAY,GAAG,eAAe,mBAClD;GACA,KAAK,MAAM,CAAC,YAAY,UAAW,OAAqB,QAAQ,GAAG;IACjE,OAAO,SAAS,KAAK,GAAG,WAAW,KAAK,GAAG,YAAY,GAAG,WAAW,oBAAoB;IACzF,WAAW,KAAK;KAAC;KAAO,aAAa,GAAG,KAAK,GAAG,YAAY,GAAG;IAAY,CAAC;GAC9E;EACF;CACF;CACA,MAAM,QAAQ,QAAQ,eAAe,CAAC;CACtC,OAAO,MAAM,QAAQ,KAAK,GAAG,mDAAmD;CAChF,KAAK,MAAM,CAAC,OAAO,SAAS,MAAM,QAAQ,GAAG;EAC3C,IAAI,CAAC,SAAS,IAAI,KAAK,KAAK,WAAW,SAAS,KAAK,WAAW,KAAA,GAAW;EAC3E,MAAM,SAAS,KAAK;EACpB,MAAM,QAAQ,OAAO,WAAW,YAAY,sCAAsC,KAAK,MAAM;EAC7F,OAAO,OAAO,yCAAyC,MAAM,IAAI,QAAQ;EACzE,MAAM,GAAG,SAAS,cAAc;EAChC,WAAW,KAAK;GAAC,OAAO;IAAC;IAAS;IAAY;GAAM;GAAG,aAAa,QAAQ;EAAO,CAAC;CACtF;CACA,OAAO;AACT;AAEA,SAAgB,6BACd,SAC2C;CAC3C,OAAO,uBAAuB,OAAO,CAAC,CAAC,KAAK,EAAC,OAAO,kBAAiB;EACnE,OACE,OAAO,MAAM,YAAY,YAAY,kBAAkB,KAAK,MAAM,OAAO,GACzE,uBAAuB,YAAY,IAAI,MAAM,SAC/C;EACA,OACE,OAAO,MAAM,eAAe,YAAY,kBAAkB,KAAK,MAAM,UAAU,GAC/E,0BAA0B,YAAY,IAAI,MAAM,YAClD;EACA,MAAM,mBAAmB,GAAG,MAAM,QAAQ,GAAG,MAAM;EACnD,OACE,MAAM,WAAW,kBACjB,+BAA+B,YAAY,aAAa,iBAAiB,QAAQ,MAAM,QACzF;EACA,OAAO;GAAC,UAAU;GAAkB;EAAW;CACjD,CAAC;AACH"}
|
package/dist/source.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { BlockPaletteDocument } from './block-palette';
|
|
2
|
-
import { ExtensionBundlePlan } from './extension-bundle';
|
|
3
|
-
import { ProjectAssetAdditionsSummary } from './project-asset-additions';
|
|
4
|
-
import { EmbeddedExtension, ExtensionBundleConfiguration, ProjectJson, Sb3SourceManifest } from './types';
|
|
5
|
-
export { blockPaletteSourceFormatVersion, sourceFormatVersion, supportedSourceFormatVersions, } from './source-format';
|
|
1
|
+
import { BlockPaletteDocument } from './block-palette.js';
|
|
2
|
+
import { ExtensionBundlePlan } from './extension-bundle.js';
|
|
3
|
+
import { ProjectAssetAdditionsSummary } from './project-asset-additions.js';
|
|
4
|
+
import { EmbeddedExtension, ExtensionBundleConfiguration, ProjectJson, Sb3SourceManifest } from './types.js';
|
|
5
|
+
export { blockPaletteSourceFormatVersion, sourceFormatVersion, supportedSourceFormatVersions, } from './source-format.js';
|
|
6
6
|
export declare const fixedZipTimestamp: Date;
|
|
7
7
|
export interface InspectedSb3Source {
|
|
8
8
|
assetContents: Map<string, Uint8Array>;
|
|
@@ -15,6 +15,8 @@ export interface InspectedSb3Source {
|
|
|
15
15
|
extensionContents: Map<string, Uint8Array>;
|
|
16
16
|
project: ProjectJson;
|
|
17
17
|
resolvedSourceDirectory: string;
|
|
18
|
+
/** The Editor's screen state (`.tw-plus/workspace.json`), or null when the folder has none. */
|
|
19
|
+
screenState: Uint8Array | null;
|
|
18
20
|
sourceManifest: Sb3SourceManifest;
|
|
19
21
|
}
|
|
20
22
|
export interface BlockCleanUpSummary {
|
package/dist/source.js
CHANGED
|
@@ -6,7 +6,7 @@ import { validateExtensionBundleConfigurations } from "./extension-bundle.js";
|
|
|
6
6
|
import { buildExtensionBundlesWithModules } from "./extension-module-bundle.js";
|
|
7
7
|
import { applyProjectAssetAdditions } from "./project-asset-additions.js";
|
|
8
8
|
import { cleanUpTurboWarpBlocks } from "./turbowarp-clean-up.js";
|
|
9
|
-
import { assertSameFileSet, blockPaletteSourceFormatVersion, collectSourceAssetReferences, isObject, sourceFormatVersion, supportedSourceFormatVersions, validateExtensionLayout, validateSourceManifest } from "./source-format.js";
|
|
9
|
+
import { assertSameFileSet, blockPaletteSourceFormatVersion, collectSourceAssetReferences, isObject, screenStateEntry, screenStateFile, sourceFormatVersion, supportedSourceFormatVersions, validateExtensionLayout, validateSourceManifest } from "./source-format.js";
|
|
10
10
|
import path from "node:path";
|
|
11
11
|
import { createHash } from "node:crypto";
|
|
12
12
|
import { lstat, readFile, readdir } from "node:fs/promises";
|
|
@@ -64,7 +64,18 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
|
|
|
64
64
|
await assertDirectory(resolvedSourceDirectory, "SB3 source");
|
|
65
65
|
const sourceManifest = await readJson(path.join(resolvedSourceDirectory, "sb3-source.json"), "SB3 source manifest");
|
|
66
66
|
validateSourceManifest(sourceManifest);
|
|
67
|
-
const assetEntries = sourceManifest.archiveEntries.filter((entryName) => entryName !== "project.json");
|
|
67
|
+
const assetEntries = sourceManifest.archiveEntries.filter((entryName) => entryName !== "project.json" && entryName !== "tw-plus/workspace.json");
|
|
68
|
+
let screenState = null;
|
|
69
|
+
try {
|
|
70
|
+
screenState = await readFile(path.join(resolvedSourceDirectory, screenStateFile));
|
|
71
|
+
} catch (error) {
|
|
72
|
+
if (error.code !== "ENOENT") throw error;
|
|
73
|
+
}
|
|
74
|
+
if (screenState) try {
|
|
75
|
+
JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(screenState));
|
|
76
|
+
} catch (cause) {
|
|
77
|
+
throw new Error(`${screenStateFile} is not valid JSON: ${errorMessage(cause)}`, { cause });
|
|
78
|
+
}
|
|
68
79
|
const project = await readJson(path.join(resolvedSourceDirectory, sourceManifest.project), "SB3 project source");
|
|
69
80
|
assert(isObject(project), "project.source.json must contain an object.");
|
|
70
81
|
const blockPalette = sourceManifest.blockPalette === void 0 ? null : validateBlockPaletteDocument(await readJson(path.join(resolvedSourceDirectory, sourceManifest.blockPalette), "Block palette settings"));
|
|
@@ -115,6 +126,7 @@ async function inspectSb3Source(sourceDirectory, validateManagedExtensions) {
|
|
|
115
126
|
extensionContents,
|
|
116
127
|
project,
|
|
117
128
|
resolvedSourceDirectory,
|
|
129
|
+
screenState,
|
|
118
130
|
sourceManifest
|
|
119
131
|
};
|
|
120
132
|
}
|
|
@@ -179,11 +191,17 @@ async function createDeterministicSb3(sourceDirectory, options = {}) {
|
|
|
179
191
|
}
|
|
180
192
|
project.extensionURLs = extensionUrls;
|
|
181
193
|
const archiveEntries = {};
|
|
182
|
-
|
|
194
|
+
const entryNames = [...projectAssets.archiveEntries];
|
|
195
|
+
if (source.screenState && !entryNames.includes("tw-plus/workspace.json")) entryNames.push(screenStateEntry);
|
|
196
|
+
for (const entryName of entryNames) {
|
|
183
197
|
if (entryName === "project.json") {
|
|
184
198
|
archiveEntries[entryName] = strToU8(`${JSON.stringify(project)}\n`);
|
|
185
199
|
continue;
|
|
186
200
|
}
|
|
201
|
+
if (entryName === "tw-plus/workspace.json") {
|
|
202
|
+
if (source.screenState) archiveEntries[entryName] = source.screenState;
|
|
203
|
+
continue;
|
|
204
|
+
}
|
|
187
205
|
const contents = projectAssets.assetContents.get(entryName);
|
|
188
206
|
assert(contents, `Archive entry has no contents: ${entryName}`);
|
|
189
207
|
archiveEntries[entryName] = contents;
|
|
@@ -198,7 +216,7 @@ async function createDeterministicSb3(sourceDirectory, options = {}) {
|
|
|
198
216
|
blockCleanUp,
|
|
199
217
|
bundlePlans: bundled.bundlePlans,
|
|
200
218
|
embeddedExtensionCount: bundled.extensions.length,
|
|
201
|
-
entryCount:
|
|
219
|
+
entryCount: Object.keys(archiveEntries).length,
|
|
202
220
|
projectAssetAdditions: projectAssets.summary,
|
|
203
221
|
source
|
|
204
222
|
};
|
package/dist/source.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"source.js","names":[],"sources":["../src/source.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {createHash} from 'node:crypto';\nimport {lstat, readdir, readFile} from 'node:fs/promises';\nimport path from 'node:path';\n\nimport {strToU8, zipSync} from 'fflate';\n\nimport {assert, errorMessage} from './assert';\nimport {\n applyBlockPaletteComments,\n resolveBlockPaletteReferences,\n validateBlockPaletteDocument,\n} from './block-palette';\nimport type {BlockPaletteDocument} from './block-palette';\nimport {validateManagedExtensionApiManifest} from './extension-api-manifest';\nimport {validateExtensionBundleConfigurations} from './extension-bundle';\nimport {buildExtensionBundlesWithModules} from './extension-module-bundle';\nimport type {ExtensionBundlePlan} from './extension-bundle';\nimport {\n validateExtensionSourceMetadata,\n validateManagedExtensionContents,\n} from './extension-dependencies';\nimport {applyProjectAssetAdditions} from './project-asset-additions';\nimport type {ProjectAssetAdditionsSummary} from './project-asset-additions';\nimport {cleanUpTurboWarpBlocks} from './turbowarp-clean-up';\nimport {\n assertSameFileSet,\n collectSourceAssetReferences,\n isObject,\n validateExtensionLayout,\n validateSourceManifest,\n} from './source-format';\nimport type {\n EmbeddedExtension,\n ExtensionBundleConfiguration,\n ProjectJson,\n Sb3SourceManifest,\n} from './types';\n\nexport {\n blockPaletteSourceFormatVersion,\n sourceFormatVersion,\n supportedSourceFormatVersions,\n} from './source-format';\nexport const fixedZipTimestamp = new Date(1980, 0, 1, 0, 0, 0, 0);\n\nexport interface InspectedSb3Source {\n assetContents: Map<string, Uint8Array>;\n assetReferenceCount: number;\n /** `block-palette.json` in source format 2, otherwise null. */\n blockPalette: BlockPaletteDocument | null;\n extensions: EmbeddedExtension[];\n extensionApiManifestContents: Map<string, Uint8Array>;\n extensionBundles: ExtensionBundleConfiguration[];\n extensionContents: Map<string, Uint8Array>;\n project: ProjectJson;\n resolvedSourceDirectory: string;\n sourceManifest: Sb3SourceManifest;\n}\n\nexport interface BlockCleanUpSummary {\n movedCommentCount: number;\n movedScriptCount: number;\n scriptCount: number;\n targetCount: number;\n}\n\nexport interface DeterministicSb3Options {\n allowedAssetRoots?: string[];\n cleanUpBlocks?: boolean;\n projectAssetsPath?: string;\n}\n\nexport interface DeterministicSb3 {\n archive: Uint8Array;\n assetCount: number;\n assetReferenceCount: number;\n blockCleanUp: BlockCleanUpSummary | null;\n bundlePlans: ExtensionBundlePlan[];\n embeddedExtensionCount: number;\n entryCount: number;\n projectAssetAdditions: Readonly<ProjectAssetAdditionsSummary> | null;\n source: InspectedSb3Source;\n}\n\nasync function readJson(filePath: string, description: string): Promise<unknown> {\n try {\n return JSON.parse(await readFile(filePath, 'utf8'));\n } catch (error) {\n throw new Error(`${description} is not valid JSON: ${filePath} (${errorMessage(error)})`, {\n cause: error,\n });\n }\n}\n\nasync function assertDirectory(directoryPath: string, description: string): Promise<void> {\n const stats = await lstat(directoryPath);\n assert(\n stats.isDirectory() && !stats.isSymbolicLink(),\n `${description} must be a directory, not a file or symbolic link: ${directoryPath}`,\n );\n}\n\nasync function listRegularFiles(rootDirectory: string, description: string): Promise<string[]> {\n try {\n await assertDirectory(rootDirectory, description);\n } catch (error) {\n if ((error as NodeJS.ErrnoException).code === 'ENOENT') return [];\n throw error;\n }\n const files: string[] = [];\n\n async function visit(directory: string, relativeDirectory: string): Promise<void> {\n const entries = await readdir(directory, {withFileTypes: true});\n entries.sort((left, right) => (left.name < right.name ? -1 : left.name > right.name ? 1 : 0));\n for (const entry of entries) {\n const relativePath = relativeDirectory\n ? path.posix.join(relativeDirectory, entry.name)\n : entry.name;\n const absolutePath = path.join(directory, entry.name);\n if (entry.isDirectory()) {\n await visit(absolutePath, relativePath);\n } else {\n assert(\n entry.isFile(),\n `${description} contains a symbolic link or unsupported entry: ${relativePath}`,\n );\n files.push(relativePath);\n }\n }\n }\n\n await visit(rootDirectory, '');\n return files;\n}\n\nfunction md5(contents: Uint8Array | string): string {\n return createHash('md5').update(contents).digest('hex');\n}\n\nfunction percentEncode(contents: Uint8Array): string {\n return [...contents]\n .map((byte) => `%${byte.toString(16).padStart(2, '0').toUpperCase()}`)\n .join('');\n}\n\nfunction encodeExtensionDataUrl(extension: EmbeddedExtension, contents: Uint8Array): string {\n const metadata = [extension.mediaType, ...extension.parameters].join(';');\n if (extension.encoding === 'base64') {\n return `data:${metadata};base64,${Buffer.from(contents).toString('base64')}`;\n }\n return `data:${metadata},${percentEncode(contents)}`;\n}\n\nasync function inspectSb3Source(\n sourceDirectory: string,\n validateManagedExtensions: boolean,\n): Promise<InspectedSb3Source> {\n const resolvedSourceDirectory = path.resolve(sourceDirectory);\n await assertDirectory(resolvedSourceDirectory, 'SB3 source');\n const sourceManifest = await readJson(\n path.join(resolvedSourceDirectory, 'sb3-source.json'),\n 'SB3 source manifest',\n );\n validateSourceManifest(sourceManifest);\n const assetEntries = sourceManifest.archiveEntries.filter(\n (entryName) => entryName !== 'project.json',\n );\n const project: unknown = await readJson(\n path.join(resolvedSourceDirectory, sourceManifest.project),\n 'SB3 project source',\n );\n assert(isObject(project), 'project.source.json must contain an object.');\n const blockPalette =\n sourceManifest.blockPalette === undefined\n ? null\n : validateBlockPaletteDocument(\n await readJson(\n path.join(resolvedSourceDirectory, sourceManifest.blockPalette),\n 'Block palette settings',\n ),\n );\n resolveBlockPaletteReferences(project, blockPalette);\n const extensionManifest = await readJson(\n path.join(resolvedSourceDirectory, sourceManifest.embeddedExtensions),\n 'Embedded extension manifest',\n );\n\n const assetsDirectory = path.join(resolvedSourceDirectory, sourceManifest.assetsDirectory);\n const extensionsDirectory = path.join(resolvedSourceDirectory, 'extensions');\n const [assetFiles, extensionFiles] = await Promise.all([\n listRegularFiles(assetsDirectory, 'Assets directory'),\n listRegularFiles(extensionsDirectory, 'Extensions directory'),\n ]);\n assertSameFileSet(assetFiles, assetEntries, 'Asset files');\n const {extensionBundles: bundleConfiguration, extensions} = validateExtensionLayout(\n extensionManifest,\n project,\n extensionFiles,\n validateExtensionSourceMetadata,\n );\n const extensionBundles = validateExtensionBundleConfigurations(bundleConfiguration, extensions);\n\n const assetContents = new Map<string, Uint8Array>();\n await Promise.all(\n assetFiles.map(async (assetPath) => {\n assetContents.set(assetPath, await readFile(path.join(assetsDirectory, assetPath)));\n }),\n );\n const references = collectSourceAssetReferences(project);\n const referencedAssets = new Set<string>();\n for (const {filename, description} of references) {\n if (referencedAssets.has(filename)) continue;\n const contents = assetContents.get(filename);\n assert(contents, `Referenced asset is missing for ${description}: ${filename}`);\n const assetId = filename.slice(0, 32);\n const actualAssetId = md5(contents);\n assert(\n actualAssetId === assetId,\n `Asset content hash mismatch for ${description}: expected ${assetId}, got ${actualAssetId}`,\n );\n referencedAssets.add(filename);\n }\n const unreferencedAssets = assetFiles.filter((assetPath) => !referencedAssets.has(assetPath));\n assert(\n unreferencedAssets.length === 0,\n `Asset manifest contains unreferenced files: ${unreferencedAssets.join(', ')}`,\n );\n\n const extensionContents = new Map<string, Uint8Array>();\n const extensionApiManifestContents = new Map<string, Uint8Array>();\n await Promise.all(\n extensions.map(async (extension) => {\n const contents = await readFile(path.join(resolvedSourceDirectory, extension.path));\n if (validateManagedExtensions) {\n validateManagedExtensionContents(extension, contents);\n }\n extensionContents.set(extension.id, contents);\n if (extension.source?.apiManifest) {\n const apiManifestContents = await readFile(\n path.join(resolvedSourceDirectory, extension.source.apiManifest.path),\n );\n if (validateManagedExtensions) {\n validateManagedExtensionApiManifest(extension, apiManifestContents);\n }\n extensionApiManifestContents.set(extension.id, apiManifestContents);\n }\n }),\n );\n\n return {\n assetContents,\n assetReferenceCount: references.length,\n blockPalette,\n extensions,\n extensionApiManifestContents,\n extensionBundles,\n extensionContents,\n project,\n resolvedSourceDirectory,\n sourceManifest,\n };\n}\n\nexport async function inspectSb3SourceForExtensionSync(\n sourceDirectory: string,\n): Promise<InspectedSb3Source> {\n return inspectSb3Source(sourceDirectory, false);\n}\n\nexport async function validateSb3Source(sourceDirectory: string): Promise<InspectedSb3Source> {\n const source = await inspectSb3Source(sourceDirectory, true);\n await buildExtensionBundlesWithModules({\n sourceDirectory: source.resolvedSourceDirectory,\n extensionBundles: source.extensionBundles,\n extensionContents: source.extensionContents,\n extensions: source.extensions,\n project: source.project,\n });\n return source;\n}\n\nexport async function createDeterministicSb3(\n sourceDirectory: string,\n options: DeterministicSb3Options = {},\n): Promise<DeterministicSb3> {\n const {allowedAssetRoots = [], cleanUpBlocks = false, projectAssetsPath} = options;\n assert(typeof cleanUpBlocks === 'boolean', 'cleanUpBlocks must be a boolean.');\n assert(Array.isArray(allowedAssetRoots), 'allowedAssetRoots must be an array.');\n assert(\n projectAssetsPath === undefined || typeof projectAssetsPath === 'string',\n 'projectAssetsPath must be a string when provided.',\n );\n const source = await inspectSb3Source(sourceDirectory, true);\n const projectAssets: {\n archiveEntries: string[];\n assetContents: Map<string, Uint8Array>;\n assetReferenceCount: number;\n project: ProjectJson;\n summary: Readonly<ProjectAssetAdditionsSummary> | null;\n } = projectAssetsPath\n ? await applyProjectAssetAdditions({\n allowedAssetRoots,\n assetContents: source.assetContents,\n archiveEntries: source.sourceManifest.archiveEntries,\n manifestPath: projectAssetsPath,\n project: source.project,\n })\n : {\n archiveEntries: source.sourceManifest.archiveEntries,\n assetContents: source.assetContents,\n assetReferenceCount: 0,\n project: source.project,\n summary: null,\n };\n const bundled = await buildExtensionBundlesWithModules({\n sourceDirectory: source.resolvedSourceDirectory,\n extensionBundles: source.extensionBundles,\n extensionContents: source.extensionContents,\n extensions: source.extensions,\n project: projectAssets.project,\n });\n let project = structuredClone(bundled.project);\n let blockCleanUp: BlockCleanUpSummary | null = null;\n if (cleanUpBlocks) {\n const cleaned = cleanUpTurboWarpBlocks(project);\n project = cleaned.project;\n blockCleanUp = {\n movedCommentCount: cleaned.movedCommentCount,\n movedScriptCount: cleaned.movedScriptCount,\n scriptCount: cleaned.scriptCount,\n targetCount: cleaned.targetCount,\n };\n }\n applyBlockPaletteComments(project, source.blockPalette);\n const extensionUrls: Record<string, unknown> = project.extensionURLs ?? {};\n for (const extension of bundled.extensions) {\n const contents = bundled.extensionContents.get(extension.id);\n assert(contents, `Embedded extension has no contents: ${extension.id}`);\n extensionUrls[extension.id] = encodeExtensionDataUrl(extension, contents);\n }\n project.extensionURLs = extensionUrls;\n\n const archiveEntries: Record<string, Uint8Array> = {};\n for (const entryName of projectAssets.archiveEntries) {\n if (entryName === 'project.json') {\n archiveEntries[entryName] = strToU8(`${JSON.stringify(project)}\\n`);\n continue;\n }\n const contents = projectAssets.assetContents.get(entryName);\n assert(contents, `Archive entry has no contents: ${entryName}`);\n archiveEntries[entryName] = contents;\n }\n const archive = zipSync(archiveEntries, {\n level: 6,\n mtime: fixedZipTimestamp,\n });\n\n return {\n archive,\n assetCount: projectAssets.assetContents.size,\n assetReferenceCount: source.assetReferenceCount + projectAssets.assetReferenceCount,\n blockCleanUp,\n bundlePlans: bundled.bundlePlans,\n embeddedExtensionCount: bundled.extensions.length,\n entryCount: projectAssets.archiveEntries.length,\n projectAssetAdditions: projectAssets.summary,\n source,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;AA6CA,IAAa,oBAAoB,IAAI,KAAK,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAyChE,eAAe,SAAS,UAAkB,aAAuC;CAC/E,IAAI;EACF,OAAO,KAAK,MAAM,MAAM,SAAS,UAAU,MAAM,CAAC;CACpD,SAAS,OAAO;EACd,MAAM,IAAI,MAAM,GAAG,YAAY,sBAAsB,SAAS,IAAI,aAAa,KAAK,EAAE,IAAI,EACxF,OAAO,MACT,CAAC;CACH;AACF;AAEA,eAAe,gBAAgB,eAAuB,aAAoC;CACxF,MAAM,QAAQ,MAAM,MAAM,aAAa;CACvC,OACE,MAAM,YAAY,KAAK,CAAC,MAAM,eAAe,GAC7C,GAAG,YAAY,qDAAqD,eACtE;AACF;AAEA,eAAe,iBAAiB,eAAuB,aAAwC;CAC7F,IAAI;EACF,MAAM,gBAAgB,eAAe,WAAW;CAClD,SAAS,OAAO;EACd,IAAK,MAAgC,SAAS,UAAU,OAAO,CAAC;EAChE,MAAM;CACR;CACA,MAAM,QAAkB,CAAC;CAEzB,eAAe,MAAM,WAAmB,mBAA0C;EAChF,MAAM,UAAU,MAAM,QAAQ,WAAW,EAAC,eAAe,KAAI,CAAC;EAC9D,QAAQ,MAAM,MAAM,UAAW,KAAK,OAAO,MAAM,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,IAAI,CAAE;EAC5F,KAAK,MAAM,SAAS,SAAS;GAC3B,MAAM,eAAe,oBACjB,KAAK,MAAM,KAAK,mBAAmB,MAAM,IAAI,IAC7C,MAAM;GACV,MAAM,eAAe,KAAK,KAAK,WAAW,MAAM,IAAI;GACpD,IAAI,MAAM,YAAY,GACpB,MAAM,MAAM,cAAc,YAAY;QACjC;IACL,OACE,MAAM,OAAO,GACb,GAAG,YAAY,kDAAkD,cACnE;IACA,MAAM,KAAK,YAAY;GACzB;EACF;CACF;CAEA,MAAM,MAAM,eAAe,EAAE;CAC7B,OAAO;AACT;AAEA,SAAS,IAAI,UAAuC;CAClD,OAAO,WAAW,KAAK,CAAC,CAAC,OAAO,QAAQ,CAAC,CAAC,OAAO,KAAK;AACxD;AAEA,SAAS,cAAc,UAA8B;CACnD,OAAO,CAAC,GAAG,QAAQ,CAAC,CACjB,KAAK,SAAS,IAAI,KAAK,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,YAAY,GAAG,CAAC,CACrE,KAAK,EAAE;AACZ;AAEA,SAAS,uBAAuB,WAA8B,UAA8B;CAC1F,MAAM,WAAW,CAAC,UAAU,WAAW,GAAG,UAAU,UAAU,CAAC,CAAC,KAAK,GAAG;CACxE,IAAI,UAAU,aAAa,UACzB,OAAO,QAAQ,SAAS,UAAU,OAAO,KAAK,QAAQ,CAAC,CAAC,SAAS,QAAQ;CAE3E,OAAO,QAAQ,SAAS,GAAG,cAAc,QAAQ;AACnD;AAEA,eAAe,iBACb,iBACA,2BAC6B;CAC7B,MAAM,0BAA0B,KAAK,QAAQ,eAAe;CAC5D,MAAM,gBAAgB,yBAAyB,YAAY;CAC3D,MAAM,iBAAiB,MAAM,SAC3B,KAAK,KAAK,yBAAyB,iBAAiB,GACpD,qBACF;CACA,uBAAuB,cAAc;CACrC,MAAM,eAAe,eAAe,eAAe,QAChD,cAAc,cAAc,cAC/B;CACA,MAAM,UAAmB,MAAM,SAC7B,KAAK,KAAK,yBAAyB,eAAe,OAAO,GACzD,oBACF;CACA,OAAO,SAAS,OAAO,GAAG,6CAA6C;CACvE,MAAM,eACJ,eAAe,iBAAiB,KAAA,IAC5B,OACA,6BACE,MAAM,SACJ,KAAK,KAAK,yBAAyB,eAAe,YAAY,GAC9D,wBACF,CACF;CACN,8BAA8B,SAAS,YAAY;CACnD,MAAM,oBAAoB,MAAM,SAC9B,KAAK,KAAK,yBAAyB,eAAe,kBAAkB,GACpE,6BACF;CAEA,MAAM,kBAAkB,KAAK,KAAK,yBAAyB,eAAe,eAAe;CACzF,MAAM,sBAAsB,KAAK,KAAK,yBAAyB,YAAY;CAC3E,MAAM,CAAC,YAAY,kBAAkB,MAAM,QAAQ,IAAI,CACrD,iBAAiB,iBAAiB,kBAAkB,GACpD,iBAAiB,qBAAqB,sBAAsB,CAC9D,CAAC;CACD,kBAAkB,YAAY,cAAc,aAAa;CACzD,MAAM,EAAC,kBAAkB,qBAAqB,eAAc,wBAC1D,mBACA,SACA,gBACA,+BACF;CACA,MAAM,mBAAmB,sCAAsC,qBAAqB,UAAU;CAE9F,MAAM,gCAAgB,IAAI,IAAwB;CAClD,MAAM,QAAQ,IACZ,WAAW,IAAI,OAAO,cAAc;EAClC,cAAc,IAAI,WAAW,MAAM,SAAS,KAAK,KAAK,iBAAiB,SAAS,CAAC,CAAC;CACpF,CAAC,CACH;CACA,MAAM,aAAa,6BAA6B,OAAO;CACvD,MAAM,mCAAmB,IAAI,IAAY;CACzC,KAAK,MAAM,EAAC,UAAU,iBAAgB,YAAY;EAChD,IAAI,iBAAiB,IAAI,QAAQ,GAAG;EACpC,MAAM,WAAW,cAAc,IAAI,QAAQ;EAC3C,OAAO,UAAU,mCAAmC,YAAY,IAAI,UAAU;EAC9E,MAAM,UAAU,SAAS,MAAM,GAAG,EAAE;EACpC,MAAM,gBAAgB,IAAI,QAAQ;EAClC,OACE,kBAAkB,SAClB,mCAAmC,YAAY,aAAa,QAAQ,QAAQ,eAC9E;EACA,iBAAiB,IAAI,QAAQ;CAC/B;CACA,MAAM,qBAAqB,WAAW,QAAQ,cAAc,CAAC,iBAAiB,IAAI,SAAS,CAAC;CAC5F,OACE,mBAAmB,WAAW,GAC9B,+CAA+C,mBAAmB,KAAK,IAAI,GAC7E;CAEA,MAAM,oCAAoB,IAAI,IAAwB;CACtD,MAAM,+CAA+B,IAAI,IAAwB;CACjE,MAAM,QAAQ,IACZ,WAAW,IAAI,OAAO,cAAc;EAClC,MAAM,WAAW,MAAM,SAAS,KAAK,KAAK,yBAAyB,UAAU,IAAI,CAAC;EAClF,IAAI,2BACF,iCAAiC,WAAW,QAAQ;EAEtD,kBAAkB,IAAI,UAAU,IAAI,QAAQ;EAC5C,IAAI,UAAU,QAAQ,aAAa;GACjC,MAAM,sBAAsB,MAAM,SAChC,KAAK,KAAK,yBAAyB,UAAU,OAAO,YAAY,IAAI,CACtE;GACA,IAAI,2BACF,oCAAoC,WAAW,mBAAmB;GAEpE,6BAA6B,IAAI,UAAU,IAAI,mBAAmB;EACpE;CACF,CAAC,CACH;CAEA,OAAO;EACL;EACA,qBAAqB,WAAW;EAChC;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF;AAEA,eAAsB,iCACpB,iBAC6B;CAC7B,OAAO,iBAAiB,iBAAiB,KAAK;AAChD;AAEA,eAAsB,kBAAkB,iBAAsD;CAC5F,MAAM,SAAS,MAAM,iBAAiB,iBAAiB,IAAI;CAC3D,MAAM,iCAAiC;EACrC,iBAAiB,OAAO;EACxB,kBAAkB,OAAO;EACzB,mBAAmB,OAAO;EAC1B,YAAY,OAAO;EACnB,SAAS,OAAO;CAClB,CAAC;CACD,OAAO;AACT;AAEA,eAAsB,uBACpB,iBACA,UAAmC,CAAC,GACT;CAC3B,MAAM,EAAC,oBAAoB,CAAC,GAAG,gBAAgB,OAAO,sBAAqB;CAC3E,OAAO,OAAO,kBAAkB,WAAW,kCAAkC;CAC7E,OAAO,MAAM,QAAQ,iBAAiB,GAAG,qCAAqC;CAC9E,OACE,sBAAsB,KAAA,KAAa,OAAO,sBAAsB,UAChE,mDACF;CACA,MAAM,SAAS,MAAM,iBAAiB,iBAAiB,IAAI;CAC3D,MAAM,gBAMF,oBACA,MAAM,2BAA2B;EAC/B;EACA,eAAe,OAAO;EACtB,gBAAgB,OAAO,eAAe;EACtC,cAAc;EACd,SAAS,OAAO;CAClB,CAAC,IACD;EACE,gBAAgB,OAAO,eAAe;EACtC,eAAe,OAAO;EACtB,qBAAqB;EACrB,SAAS,OAAO;EAChB,SAAS;CACX;CACJ,MAAM,UAAU,MAAM,iCAAiC;EACrD,iBAAiB,OAAO;EACxB,kBAAkB,OAAO;EACzB,mBAAmB,OAAO;EAC1B,YAAY,OAAO;EACnB,SAAS,cAAc;CACzB,CAAC;CACD,IAAI,UAAU,gBAAgB,QAAQ,OAAO;CAC7C,IAAI,eAA2C;CAC/C,IAAI,eAAe;EACjB,MAAM,UAAU,uBAAuB,OAAO;EAC9C,UAAU,QAAQ;EAClB,eAAe;GACb,mBAAmB,QAAQ;GAC3B,kBAAkB,QAAQ;GAC1B,aAAa,QAAQ;GACrB,aAAa,QAAQ;EACvB;CACF;CACA,0BAA0B,SAAS,OAAO,YAAY;CACtD,MAAM,gBAAyC,QAAQ,iBAAiB,CAAC;CACzE,KAAK,MAAM,aAAa,QAAQ,YAAY;EAC1C,MAAM,WAAW,QAAQ,kBAAkB,IAAI,UAAU,EAAE;EAC3D,OAAO,UAAU,uCAAuC,UAAU,IAAI;EACtE,cAAc,UAAU,MAAM,uBAAuB,WAAW,QAAQ;CAC1E;CACA,QAAQ,gBAAgB;CAExB,MAAM,iBAA6C,CAAC;CACpD,KAAK,MAAM,aAAa,cAAc,gBAAgB;EACpD,IAAI,cAAc,gBAAgB;GAChC,eAAe,aAAa,QAAQ,GAAG,KAAK,UAAU,OAAO,EAAE,GAAG;GAClE;EACF;EACA,MAAM,WAAW,cAAc,cAAc,IAAI,SAAS;EAC1D,OAAO,UAAU,kCAAkC,WAAW;EAC9D,eAAe,aAAa;CAC9B;CAMA,OAAO;EACL,SANc,QAAQ,gBAAgB;GACtC,OAAO;GACP,OAAO;EACT,CAGE;EACA,YAAY,cAAc,cAAc;EACxC,qBAAqB,OAAO,sBAAsB,cAAc;EAChE;EACA,aAAa,QAAQ;EACrB,wBAAwB,QAAQ,WAAW;EAC3C,YAAY,cAAc,eAAe;EACzC,uBAAuB,cAAc;EACrC;CACF;AACF"}
|
|
1
|
+
{"version":3,"file":"source.js","names":[],"sources":["../src/source.ts"],"sourcesContent":["// SPDX-License-Identifier: MPL-2.0\n\nimport {createHash} from 'node:crypto';\nimport {lstat, readdir, readFile} from 'node:fs/promises';\nimport path from 'node:path';\n\nimport {strToU8, zipSync} from 'fflate';\n\nimport {assert, errorMessage} from './assert';\nimport {\n applyBlockPaletteComments,\n resolveBlockPaletteReferences,\n validateBlockPaletteDocument,\n} from './block-palette';\nimport type {BlockPaletteDocument} from './block-palette';\nimport {validateManagedExtensionApiManifest} from './extension-api-manifest';\nimport {validateExtensionBundleConfigurations} from './extension-bundle';\nimport {buildExtensionBundlesWithModules} from './extension-module-bundle';\nimport type {ExtensionBundlePlan} from './extension-bundle';\nimport {\n validateExtensionSourceMetadata,\n validateManagedExtensionContents,\n} from './extension-dependencies';\nimport {applyProjectAssetAdditions} from './project-asset-additions';\nimport type {ProjectAssetAdditionsSummary} from './project-asset-additions';\nimport {cleanUpTurboWarpBlocks} from './turbowarp-clean-up';\nimport {\n assertSameFileSet,\n collectSourceAssetReferences,\n isObject,\n screenStateEntry,\n screenStateFile,\n validateExtensionLayout,\n validateSourceManifest,\n} from './source-format';\nimport type {\n EmbeddedExtension,\n ExtensionBundleConfiguration,\n ProjectJson,\n Sb3SourceManifest,\n} from './types';\n\nexport {\n blockPaletteSourceFormatVersion,\n sourceFormatVersion,\n supportedSourceFormatVersions,\n} from './source-format';\nexport const fixedZipTimestamp = new Date(1980, 0, 1, 0, 0, 0, 0);\n\nexport interface InspectedSb3Source {\n assetContents: Map<string, Uint8Array>;\n assetReferenceCount: number;\n /** `block-palette.json` in source format 2, otherwise null. */\n blockPalette: BlockPaletteDocument | null;\n extensions: EmbeddedExtension[];\n extensionApiManifestContents: Map<string, Uint8Array>;\n extensionBundles: ExtensionBundleConfiguration[];\n extensionContents: Map<string, Uint8Array>;\n project: ProjectJson;\n resolvedSourceDirectory: string;\n /** The Editor's screen state (`.tw-plus/workspace.json`), or null when the folder has none. */\n screenState: Uint8Array | null;\n sourceManifest: Sb3SourceManifest;\n}\n\nexport interface BlockCleanUpSummary {\n movedCommentCount: number;\n movedScriptCount: number;\n scriptCount: number;\n targetCount: number;\n}\n\nexport interface DeterministicSb3Options {\n allowedAssetRoots?: string[];\n cleanUpBlocks?: boolean;\n projectAssetsPath?: string;\n}\n\nexport interface DeterministicSb3 {\n archive: Uint8Array;\n assetCount: number;\n assetReferenceCount: number;\n blockCleanUp: BlockCleanUpSummary | null;\n bundlePlans: ExtensionBundlePlan[];\n embeddedExtensionCount: number;\n entryCount: number;\n projectAssetAdditions: Readonly<ProjectAssetAdditionsSummary> | null;\n source: InspectedSb3Source;\n}\n\nasync function readJson(filePath: string, description: string): Promise<unknown> {\n try {\n return JSON.parse(await readFile(filePath, 'utf8'));\n } catch (error) {\n throw new Error(`${description} is not valid JSON: ${filePath} (${errorMessage(error)})`, {\n cause: error,\n });\n }\n}\n\nasync function assertDirectory(directoryPath: string, description: string): Promise<void> {\n const stats = await lstat(directoryPath);\n assert(\n stats.isDirectory() && !stats.isSymbolicLink(),\n `${description} must be a directory, not a file or symbolic link: ${directoryPath}`,\n );\n}\n\nasync function listRegularFiles(rootDirectory: string, description: string): Promise<string[]> {\n try {\n await assertDirectory(rootDirectory, description);\n } catch (error) {\n if ((error as NodeJS.ErrnoException).code === 'ENOENT') return [];\n throw error;\n }\n const files: string[] = [];\n\n async function visit(directory: string, relativeDirectory: string): Promise<void> {\n const entries = await readdir(directory, {withFileTypes: true});\n entries.sort((left, right) => (left.name < right.name ? -1 : left.name > right.name ? 1 : 0));\n for (const entry of entries) {\n const relativePath = relativeDirectory\n ? path.posix.join(relativeDirectory, entry.name)\n : entry.name;\n const absolutePath = path.join(directory, entry.name);\n if (entry.isDirectory()) {\n await visit(absolutePath, relativePath);\n } else {\n assert(\n entry.isFile(),\n `${description} contains a symbolic link or unsupported entry: ${relativePath}`,\n );\n files.push(relativePath);\n }\n }\n }\n\n await visit(rootDirectory, '');\n return files;\n}\n\nfunction md5(contents: Uint8Array | string): string {\n return createHash('md5').update(contents).digest('hex');\n}\n\nfunction percentEncode(contents: Uint8Array): string {\n return [...contents]\n .map((byte) => `%${byte.toString(16).padStart(2, '0').toUpperCase()}`)\n .join('');\n}\n\nfunction encodeExtensionDataUrl(extension: EmbeddedExtension, contents: Uint8Array): string {\n const metadata = [extension.mediaType, ...extension.parameters].join(';');\n if (extension.encoding === 'base64') {\n return `data:${metadata};base64,${Buffer.from(contents).toString('base64')}`;\n }\n return `data:${metadata},${percentEncode(contents)}`;\n}\n\nasync function inspectSb3Source(\n sourceDirectory: string,\n validateManagedExtensions: boolean,\n): Promise<InspectedSb3Source> {\n const resolvedSourceDirectory = path.resolve(sourceDirectory);\n await assertDirectory(resolvedSourceDirectory, 'SB3 source');\n const sourceManifest = await readJson(\n path.join(resolvedSourceDirectory, 'sb3-source.json'),\n 'SB3 source manifest',\n );\n validateSourceManifest(sourceManifest);\n const assetEntries = sourceManifest.archiveEntries.filter(\n (entryName) => entryName !== 'project.json' && entryName !== screenStateEntry,\n );\n // The Editor writes its screen state into the folder whenever it saves; it is optional and only has to be JSON.\n let screenState: Uint8Array | null = null;\n try {\n screenState = await readFile(path.join(resolvedSourceDirectory, screenStateFile));\n } catch (error) {\n if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw error;\n }\n if (screenState) {\n try {\n JSON.parse(new TextDecoder('utf-8', {fatal: true}).decode(screenState));\n } catch (cause) {\n throw new Error(`${screenStateFile} is not valid JSON: ${errorMessage(cause)}`, {cause});\n }\n }\n const project: unknown = await readJson(\n path.join(resolvedSourceDirectory, sourceManifest.project),\n 'SB3 project source',\n );\n assert(isObject(project), 'project.source.json must contain an object.');\n const blockPalette =\n sourceManifest.blockPalette === undefined\n ? null\n : validateBlockPaletteDocument(\n await readJson(\n path.join(resolvedSourceDirectory, sourceManifest.blockPalette),\n 'Block palette settings',\n ),\n );\n resolveBlockPaletteReferences(project, blockPalette);\n const extensionManifest = await readJson(\n path.join(resolvedSourceDirectory, sourceManifest.embeddedExtensions),\n 'Embedded extension manifest',\n );\n\n const assetsDirectory = path.join(resolvedSourceDirectory, sourceManifest.assetsDirectory);\n const extensionsDirectory = path.join(resolvedSourceDirectory, 'extensions');\n const [assetFiles, extensionFiles] = await Promise.all([\n listRegularFiles(assetsDirectory, 'Assets directory'),\n listRegularFiles(extensionsDirectory, 'Extensions directory'),\n ]);\n assertSameFileSet(assetFiles, assetEntries, 'Asset files');\n const {extensionBundles: bundleConfiguration, extensions} = validateExtensionLayout(\n extensionManifest,\n project,\n extensionFiles,\n validateExtensionSourceMetadata,\n );\n const extensionBundles = validateExtensionBundleConfigurations(bundleConfiguration, extensions);\n\n const assetContents = new Map<string, Uint8Array>();\n await Promise.all(\n assetFiles.map(async (assetPath) => {\n assetContents.set(assetPath, await readFile(path.join(assetsDirectory, assetPath)));\n }),\n );\n const references = collectSourceAssetReferences(project);\n const referencedAssets = new Set<string>();\n for (const {filename, description} of references) {\n if (referencedAssets.has(filename)) continue;\n const contents = assetContents.get(filename);\n assert(contents, `Referenced asset is missing for ${description}: ${filename}`);\n const assetId = filename.slice(0, 32);\n const actualAssetId = md5(contents);\n assert(\n actualAssetId === assetId,\n `Asset content hash mismatch for ${description}: expected ${assetId}, got ${actualAssetId}`,\n );\n referencedAssets.add(filename);\n }\n const unreferencedAssets = assetFiles.filter((assetPath) => !referencedAssets.has(assetPath));\n assert(\n unreferencedAssets.length === 0,\n `Asset manifest contains unreferenced files: ${unreferencedAssets.join(', ')}`,\n );\n\n const extensionContents = new Map<string, Uint8Array>();\n const extensionApiManifestContents = new Map<string, Uint8Array>();\n await Promise.all(\n extensions.map(async (extension) => {\n const contents = await readFile(path.join(resolvedSourceDirectory, extension.path));\n if (validateManagedExtensions) {\n validateManagedExtensionContents(extension, contents);\n }\n extensionContents.set(extension.id, contents);\n if (extension.source?.apiManifest) {\n const apiManifestContents = await readFile(\n path.join(resolvedSourceDirectory, extension.source.apiManifest.path),\n );\n if (validateManagedExtensions) {\n validateManagedExtensionApiManifest(extension, apiManifestContents);\n }\n extensionApiManifestContents.set(extension.id, apiManifestContents);\n }\n }),\n );\n\n return {\n assetContents,\n assetReferenceCount: references.length,\n blockPalette,\n extensions,\n extensionApiManifestContents,\n extensionBundles,\n extensionContents,\n project,\n resolvedSourceDirectory,\n screenState,\n sourceManifest,\n };\n}\n\nexport async function inspectSb3SourceForExtensionSync(\n sourceDirectory: string,\n): Promise<InspectedSb3Source> {\n return inspectSb3Source(sourceDirectory, false);\n}\n\nexport async function validateSb3Source(sourceDirectory: string): Promise<InspectedSb3Source> {\n const source = await inspectSb3Source(sourceDirectory, true);\n await buildExtensionBundlesWithModules({\n sourceDirectory: source.resolvedSourceDirectory,\n extensionBundles: source.extensionBundles,\n extensionContents: source.extensionContents,\n extensions: source.extensions,\n project: source.project,\n });\n return source;\n}\n\nexport async function createDeterministicSb3(\n sourceDirectory: string,\n options: DeterministicSb3Options = {},\n): Promise<DeterministicSb3> {\n const {allowedAssetRoots = [], cleanUpBlocks = false, projectAssetsPath} = options;\n assert(typeof cleanUpBlocks === 'boolean', 'cleanUpBlocks must be a boolean.');\n assert(Array.isArray(allowedAssetRoots), 'allowedAssetRoots must be an array.');\n assert(\n projectAssetsPath === undefined || typeof projectAssetsPath === 'string',\n 'projectAssetsPath must be a string when provided.',\n );\n const source = await inspectSb3Source(sourceDirectory, true);\n const projectAssets: {\n archiveEntries: string[];\n assetContents: Map<string, Uint8Array>;\n assetReferenceCount: number;\n project: ProjectJson;\n summary: Readonly<ProjectAssetAdditionsSummary> | null;\n } = projectAssetsPath\n ? await applyProjectAssetAdditions({\n allowedAssetRoots,\n assetContents: source.assetContents,\n archiveEntries: source.sourceManifest.archiveEntries,\n manifestPath: projectAssetsPath,\n project: source.project,\n })\n : {\n archiveEntries: source.sourceManifest.archiveEntries,\n assetContents: source.assetContents,\n assetReferenceCount: 0,\n project: source.project,\n summary: null,\n };\n const bundled = await buildExtensionBundlesWithModules({\n sourceDirectory: source.resolvedSourceDirectory,\n extensionBundles: source.extensionBundles,\n extensionContents: source.extensionContents,\n extensions: source.extensions,\n project: projectAssets.project,\n });\n let project = structuredClone(bundled.project);\n let blockCleanUp: BlockCleanUpSummary | null = null;\n if (cleanUpBlocks) {\n const cleaned = cleanUpTurboWarpBlocks(project);\n project = cleaned.project;\n blockCleanUp = {\n movedCommentCount: cleaned.movedCommentCount,\n movedScriptCount: cleaned.movedScriptCount,\n scriptCount: cleaned.scriptCount,\n targetCount: cleaned.targetCount,\n };\n }\n applyBlockPaletteComments(project, source.blockPalette);\n const extensionUrls: Record<string, unknown> = project.extensionURLs ?? {};\n for (const extension of bundled.extensions) {\n const contents = bundled.extensionContents.get(extension.id);\n assert(contents, `Embedded extension has no contents: ${extension.id}`);\n extensionUrls[extension.id] = encodeExtensionDataUrl(extension, contents);\n }\n project.extensionURLs = extensionUrls;\n\n const archiveEntries: Record<string, Uint8Array> = {};\n // The screen state keeps its place in the archive; one the Editor wrote after the import goes last.\n const entryNames = [...projectAssets.archiveEntries];\n if (source.screenState && !entryNames.includes(screenStateEntry))\n entryNames.push(screenStateEntry);\n for (const entryName of entryNames) {\n if (entryName === 'project.json') {\n archiveEntries[entryName] = strToU8(`${JSON.stringify(project)}\\n`);\n continue;\n }\n if (entryName === screenStateEntry) {\n if (source.screenState) archiveEntries[entryName] = source.screenState;\n continue;\n }\n const contents = projectAssets.assetContents.get(entryName);\n assert(contents, `Archive entry has no contents: ${entryName}`);\n archiveEntries[entryName] = contents;\n }\n const archive = zipSync(archiveEntries, {\n level: 6,\n mtime: fixedZipTimestamp,\n });\n\n return {\n archive,\n assetCount: projectAssets.assetContents.size,\n assetReferenceCount: source.assetReferenceCount + projectAssets.assetReferenceCount,\n blockCleanUp,\n bundlePlans: bundled.bundlePlans,\n embeddedExtensionCount: bundled.extensions.length,\n entryCount: Object.keys(archiveEntries).length,\n projectAssetAdditions: projectAssets.summary,\n source,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;AA+CA,IAAa,oBAAoB,IAAI,KAAK,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AA2ChE,eAAe,SAAS,UAAkB,aAAuC;CAC/E,IAAI;EACF,OAAO,KAAK,MAAM,MAAM,SAAS,UAAU,MAAM,CAAC;CACpD,SAAS,OAAO;EACd,MAAM,IAAI,MAAM,GAAG,YAAY,sBAAsB,SAAS,IAAI,aAAa,KAAK,EAAE,IAAI,EACxF,OAAO,MACT,CAAC;CACH;AACF;AAEA,eAAe,gBAAgB,eAAuB,aAAoC;CACxF,MAAM,QAAQ,MAAM,MAAM,aAAa;CACvC,OACE,MAAM,YAAY,KAAK,CAAC,MAAM,eAAe,GAC7C,GAAG,YAAY,qDAAqD,eACtE;AACF;AAEA,eAAe,iBAAiB,eAAuB,aAAwC;CAC7F,IAAI;EACF,MAAM,gBAAgB,eAAe,WAAW;CAClD,SAAS,OAAO;EACd,IAAK,MAAgC,SAAS,UAAU,OAAO,CAAC;EAChE,MAAM;CACR;CACA,MAAM,QAAkB,CAAC;CAEzB,eAAe,MAAM,WAAmB,mBAA0C;EAChF,MAAM,UAAU,MAAM,QAAQ,WAAW,EAAC,eAAe,KAAI,CAAC;EAC9D,QAAQ,MAAM,MAAM,UAAW,KAAK,OAAO,MAAM,OAAO,KAAK,KAAK,OAAO,MAAM,OAAO,IAAI,CAAE;EAC5F,KAAK,MAAM,SAAS,SAAS;GAC3B,MAAM,eAAe,oBACjB,KAAK,MAAM,KAAK,mBAAmB,MAAM,IAAI,IAC7C,MAAM;GACV,MAAM,eAAe,KAAK,KAAK,WAAW,MAAM,IAAI;GACpD,IAAI,MAAM,YAAY,GACpB,MAAM,MAAM,cAAc,YAAY;QACjC;IACL,OACE,MAAM,OAAO,GACb,GAAG,YAAY,kDAAkD,cACnE;IACA,MAAM,KAAK,YAAY;GACzB;EACF;CACF;CAEA,MAAM,MAAM,eAAe,EAAE;CAC7B,OAAO;AACT;AAEA,SAAS,IAAI,UAAuC;CAClD,OAAO,WAAW,KAAK,CAAC,CAAC,OAAO,QAAQ,CAAC,CAAC,OAAO,KAAK;AACxD;AAEA,SAAS,cAAc,UAA8B;CACnD,OAAO,CAAC,GAAG,QAAQ,CAAC,CACjB,KAAK,SAAS,IAAI,KAAK,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,YAAY,GAAG,CAAC,CACrE,KAAK,EAAE;AACZ;AAEA,SAAS,uBAAuB,WAA8B,UAA8B;CAC1F,MAAM,WAAW,CAAC,UAAU,WAAW,GAAG,UAAU,UAAU,CAAC,CAAC,KAAK,GAAG;CACxE,IAAI,UAAU,aAAa,UACzB,OAAO,QAAQ,SAAS,UAAU,OAAO,KAAK,QAAQ,CAAC,CAAC,SAAS,QAAQ;CAE3E,OAAO,QAAQ,SAAS,GAAG,cAAc,QAAQ;AACnD;AAEA,eAAe,iBACb,iBACA,2BAC6B;CAC7B,MAAM,0BAA0B,KAAK,QAAQ,eAAe;CAC5D,MAAM,gBAAgB,yBAAyB,YAAY;CAC3D,MAAM,iBAAiB,MAAM,SAC3B,KAAK,KAAK,yBAAyB,iBAAiB,GACpD,qBACF;CACA,uBAAuB,cAAc;CACrC,MAAM,eAAe,eAAe,eAAe,QAChD,cAAc,cAAc,kBAAkB,cAAA,wBACjD;CAEA,IAAI,cAAiC;CACrC,IAAI;EACF,cAAc,MAAM,SAAS,KAAK,KAAK,yBAAyB,eAAe,CAAC;CAClF,SAAS,OAAO;EACd,IAAK,MAAgC,SAAS,UAAU,MAAM;CAChE;CACA,IAAI,aACF,IAAI;EACF,KAAK,MAAM,IAAI,YAAY,SAAS,EAAC,OAAO,KAAI,CAAC,CAAC,CAAC,OAAO,WAAW,CAAC;CACxE,SAAS,OAAO;EACd,MAAM,IAAI,MAAM,GAAG,gBAAgB,sBAAsB,aAAa,KAAK,KAAK,EAAC,MAAK,CAAC;CACzF;CAEF,MAAM,UAAmB,MAAM,SAC7B,KAAK,KAAK,yBAAyB,eAAe,OAAO,GACzD,oBACF;CACA,OAAO,SAAS,OAAO,GAAG,6CAA6C;CACvE,MAAM,eACJ,eAAe,iBAAiB,KAAA,IAC5B,OACA,6BACE,MAAM,SACJ,KAAK,KAAK,yBAAyB,eAAe,YAAY,GAC9D,wBACF,CACF;CACN,8BAA8B,SAAS,YAAY;CACnD,MAAM,oBAAoB,MAAM,SAC9B,KAAK,KAAK,yBAAyB,eAAe,kBAAkB,GACpE,6BACF;CAEA,MAAM,kBAAkB,KAAK,KAAK,yBAAyB,eAAe,eAAe;CACzF,MAAM,sBAAsB,KAAK,KAAK,yBAAyB,YAAY;CAC3E,MAAM,CAAC,YAAY,kBAAkB,MAAM,QAAQ,IAAI,CACrD,iBAAiB,iBAAiB,kBAAkB,GACpD,iBAAiB,qBAAqB,sBAAsB,CAC9D,CAAC;CACD,kBAAkB,YAAY,cAAc,aAAa;CACzD,MAAM,EAAC,kBAAkB,qBAAqB,eAAc,wBAC1D,mBACA,SACA,gBACA,+BACF;CACA,MAAM,mBAAmB,sCAAsC,qBAAqB,UAAU;CAE9F,MAAM,gCAAgB,IAAI,IAAwB;CAClD,MAAM,QAAQ,IACZ,WAAW,IAAI,OAAO,cAAc;EAClC,cAAc,IAAI,WAAW,MAAM,SAAS,KAAK,KAAK,iBAAiB,SAAS,CAAC,CAAC;CACpF,CAAC,CACH;CACA,MAAM,aAAa,6BAA6B,OAAO;CACvD,MAAM,mCAAmB,IAAI,IAAY;CACzC,KAAK,MAAM,EAAC,UAAU,iBAAgB,YAAY;EAChD,IAAI,iBAAiB,IAAI,QAAQ,GAAG;EACpC,MAAM,WAAW,cAAc,IAAI,QAAQ;EAC3C,OAAO,UAAU,mCAAmC,YAAY,IAAI,UAAU;EAC9E,MAAM,UAAU,SAAS,MAAM,GAAG,EAAE;EACpC,MAAM,gBAAgB,IAAI,QAAQ;EAClC,OACE,kBAAkB,SAClB,mCAAmC,YAAY,aAAa,QAAQ,QAAQ,eAC9E;EACA,iBAAiB,IAAI,QAAQ;CAC/B;CACA,MAAM,qBAAqB,WAAW,QAAQ,cAAc,CAAC,iBAAiB,IAAI,SAAS,CAAC;CAC5F,OACE,mBAAmB,WAAW,GAC9B,+CAA+C,mBAAmB,KAAK,IAAI,GAC7E;CAEA,MAAM,oCAAoB,IAAI,IAAwB;CACtD,MAAM,+CAA+B,IAAI,IAAwB;CACjE,MAAM,QAAQ,IACZ,WAAW,IAAI,OAAO,cAAc;EAClC,MAAM,WAAW,MAAM,SAAS,KAAK,KAAK,yBAAyB,UAAU,IAAI,CAAC;EAClF,IAAI,2BACF,iCAAiC,WAAW,QAAQ;EAEtD,kBAAkB,IAAI,UAAU,IAAI,QAAQ;EAC5C,IAAI,UAAU,QAAQ,aAAa;GACjC,MAAM,sBAAsB,MAAM,SAChC,KAAK,KAAK,yBAAyB,UAAU,OAAO,YAAY,IAAI,CACtE;GACA,IAAI,2BACF,oCAAoC,WAAW,mBAAmB;GAEpE,6BAA6B,IAAI,UAAU,IAAI,mBAAmB;EACpE;CACF,CAAC,CACH;CAEA,OAAO;EACL;EACA,qBAAqB,WAAW;EAChC;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF;AAEA,eAAsB,iCACpB,iBAC6B;CAC7B,OAAO,iBAAiB,iBAAiB,KAAK;AAChD;AAEA,eAAsB,kBAAkB,iBAAsD;CAC5F,MAAM,SAAS,MAAM,iBAAiB,iBAAiB,IAAI;CAC3D,MAAM,iCAAiC;EACrC,iBAAiB,OAAO;EACxB,kBAAkB,OAAO;EACzB,mBAAmB,OAAO;EAC1B,YAAY,OAAO;EACnB,SAAS,OAAO;CAClB,CAAC;CACD,OAAO;AACT;AAEA,eAAsB,uBACpB,iBACA,UAAmC,CAAC,GACT;CAC3B,MAAM,EAAC,oBAAoB,CAAC,GAAG,gBAAgB,OAAO,sBAAqB;CAC3E,OAAO,OAAO,kBAAkB,WAAW,kCAAkC;CAC7E,OAAO,MAAM,QAAQ,iBAAiB,GAAG,qCAAqC;CAC9E,OACE,sBAAsB,KAAA,KAAa,OAAO,sBAAsB,UAChE,mDACF;CACA,MAAM,SAAS,MAAM,iBAAiB,iBAAiB,IAAI;CAC3D,MAAM,gBAMF,oBACA,MAAM,2BAA2B;EAC/B;EACA,eAAe,OAAO;EACtB,gBAAgB,OAAO,eAAe;EACtC,cAAc;EACd,SAAS,OAAO;CAClB,CAAC,IACD;EACE,gBAAgB,OAAO,eAAe;EACtC,eAAe,OAAO;EACtB,qBAAqB;EACrB,SAAS,OAAO;EAChB,SAAS;CACX;CACJ,MAAM,UAAU,MAAM,iCAAiC;EACrD,iBAAiB,OAAO;EACxB,kBAAkB,OAAO;EACzB,mBAAmB,OAAO;EAC1B,YAAY,OAAO;EACnB,SAAS,cAAc;CACzB,CAAC;CACD,IAAI,UAAU,gBAAgB,QAAQ,OAAO;CAC7C,IAAI,eAA2C;CAC/C,IAAI,eAAe;EACjB,MAAM,UAAU,uBAAuB,OAAO;EAC9C,UAAU,QAAQ;EAClB,eAAe;GACb,mBAAmB,QAAQ;GAC3B,kBAAkB,QAAQ;GAC1B,aAAa,QAAQ;GACrB,aAAa,QAAQ;EACvB;CACF;CACA,0BAA0B,SAAS,OAAO,YAAY;CACtD,MAAM,gBAAyC,QAAQ,iBAAiB,CAAC;CACzE,KAAK,MAAM,aAAa,QAAQ,YAAY;EAC1C,MAAM,WAAW,QAAQ,kBAAkB,IAAI,UAAU,EAAE;EAC3D,OAAO,UAAU,uCAAuC,UAAU,IAAI;EACtE,cAAc,UAAU,MAAM,uBAAuB,WAAW,QAAQ;CAC1E;CACA,QAAQ,gBAAgB;CAExB,MAAM,iBAA6C,CAAC;CAEpD,MAAM,aAAa,CAAC,GAAG,cAAc,cAAc;CACnD,IAAI,OAAO,eAAe,CAAC,WAAW,SAAA,wBAAyB,GAC7D,WAAW,KAAK,gBAAgB;CAClC,KAAK,MAAM,aAAa,YAAY;EAClC,IAAI,cAAc,gBAAgB;GAChC,eAAe,aAAa,QAAQ,GAAG,KAAK,UAAU,OAAO,EAAE,GAAG;GAClE;EACF;EACA,IAAI,cAAA,0BAAgC;GAClC,IAAI,OAAO,aAAa,eAAe,aAAa,OAAO;GAC3D;EACF;EACA,MAAM,WAAW,cAAc,cAAc,IAAI,SAAS;EAC1D,OAAO,UAAU,kCAAkC,WAAW;EAC9D,eAAe,aAAa;CAC9B;CAMA,OAAO;EACL,SANc,QAAQ,gBAAgB;GACtC,OAAO;GACP,OAAO;EACT,CAGE;EACA,YAAY,cAAc,cAAc;EACxC,qBAAqB,OAAO,sBAAsB,cAAc;EAChE;EACA,aAAa,QAAQ;EACrB,wBAAwB,QAAQ,WAAW;EAC3C,YAAY,OAAO,KAAK,cAAc,CAAC,CAAC;EACxC,uBAAuB,cAAc;EACrC;CACF;AACF"}
|
package/docs/index.html
CHANGED
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
<body>
|
|
70
70
|
<header>
|
|
71
71
|
<h1>SB3 Toolchain</h1>
|
|
72
|
-
<p><code>@kubohiroya/sb3-toolchain@0.
|
|
72
|
+
<p><code>@kubohiroya/sb3-toolchain@0.26.0</code></p>
|
|
73
73
|
<nav aria-label="Documentation">
|
|
74
74
|
<a href="#scope">責務</a><a href="#usage">使い方</a><a href="#api">API</a
|
|
75
75
|
><a href="#schemas">Schema</a><a href="#guides">関連文書</a>
|
|
@@ -90,7 +90,7 @@
|
|
|
90
90
|
<section id="usage">
|
|
91
91
|
<h2>使い方</h2>
|
|
92
92
|
<p>公開済みの完全固定versionを使います。</p>
|
|
93
|
-
<pre><code>npm install --save-exact @kubohiroya/sb3-toolchain@0.
|
|
93
|
+
<pre><code>npm install --save-exact @kubohiroya/sb3-toolchain@0.26.0</code></pre>
|
|
94
94
|
<pre><code>sb3-toolchain import tmp/project.sb3 --output app
|
|
95
95
|
sb3-toolchain check app
|
|
96
96
|
sb3-toolchain build app --output dist/project.sb3</code></pre>
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[English](../source-format-v1.md)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
import と unpack は、いつも v1 で書く。0.25 がブロックパレットのコメントのある作品に書いた[形式 v2](source-format-v2.md)の作品フォルダも、引き続き読んで build できる。
|
|
6
6
|
|
|
7
7
|
## レイアウト
|
|
8
8
|
|
|
@@ -11,12 +11,16 @@ SOURCE_DIR/
|
|
|
11
11
|
├── sb3-source.json
|
|
12
12
|
├── project.source.json
|
|
13
13
|
├── embedded-extensions.json
|
|
14
|
+
├── .tw-plus/
|
|
15
|
+
│ └── workspace.json (任意)
|
|
14
16
|
├── assets/
|
|
15
17
|
│ └── <assetId>.<dataFormat>
|
|
16
18
|
└── extensions/
|
|
17
19
|
└── <extensionId>.js
|
|
18
20
|
```
|
|
19
21
|
|
|
22
|
+
`.tw-plus/workspace.json` は、TurboWarp Plus Editor が作品と一緒に保存する画面状態である。タブの配置や、スプライトごとにパレットに出すブロックグループなどが入る。SB3 では ZIP のエントリ `tw-plus/workspace.json` で、Scratch と TurboWarp はこれを無視する。import はこのエントリをバイト列のままこのファイルに写し、`archiveEntries` にも記録する。build は同じ位置に戻す。エディターは作品フォルダを保存するときにこのファイルを自分で書く。`archiveEntries` に載っていないこのファイルは、SB3 の最後のエントリになる。toolchain は JSON であることだけを確かめ、ファイルのない作品フォルダはこのエントリなしで build する。
|
|
23
|
+
|
|
20
24
|
`sb3-source.json`は、形式のバージョン、各構成要素へのパス、元のSB3におけるZIPエントリ順を記録します。
|
|
21
25
|
|
|
22
26
|
```json
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
[English](../source-format-v2.md)
|
|
4
4
|
|
|
5
|
+
> **今は書かない。** 0.26 から、import と unpack は[形式 v1](source-format-v1.md) で書き、パレットのコメントは普通のコメントのまま残す。TurboWarp Plus Editor は、ブロックパレットの設定をコメントではなく画面状態(`.tw-plus/workspace.json`)に保存するようになった。この形式の作品フォルダも、引き続き読んで build できる。
|
|
6
|
+
|
|
5
7
|
形式 v2 は、[形式 v1](source-format-v1.md) にブロックパレットの設定を足したものである。設定とは、スプライト・背景ごとに、ブロックパレットにどのブロックグループを表示するかである。ここに書いていないことは v1 と同じ。
|
|
6
8
|
|
|
7
9
|
## どちらの版で書くか
|