@kubohiroya/turbowarp-plus-editor-project-folder 0.9.3 → 0.11.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/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
- import { C as unsupported, S as sameBytes, T as _objectSpread2, _ as projectAssets, a as projectFolderOverwriteWarning, b as readFolder, c as assetKey, d as extensionsFile, f as fileVersion, g as planExtensionSave, h as parseProject, i as isProjectFolderEmpty, l as assetTypeFor, m as manifestFile, n as registerFolder, o as FolderError, p as isObject, r as createProjectFolder, s as assertFolderUnchanged, t as followProjectFolder, u as equal, v as projectChanges, w as _objectWithoutProperties, x as readFolderUpdate, y as projectFile } from "./shared-Dz9dzxQF.js";
1
+ import { A as projectFile, C as isObject, D as planExtensionSave, E as parseProject, I as _objectWithoutProperties, L as _objectSpread2, M as readFolderUpdate, N as sameBytes, O as projectAssets, P as unsupported, S as fileVersion, T as paletteFile, _ as collapsePalette, a as parseExplorerState, b as expandPalette, c as subscribeExplorerState, d as isProjectFolderEmpty, f as projectFolderOverwriteWarning, g as assetTypeFor, h as assetKey, j as readFolder, k as projectChanges, l as writeExplorerState, m as assertFolderUnchanged, n as registerFolder, o as readExplorerState, p as FolderError, r as editorDirectory, s as screenStateFile, t as followProjectFolder, u as createProjectFolder, v as encodePalette, w as manifestFile, x as extensionsFile, y as equal } from "./shared-tZS90T71.js";
2
2
  // src/block-reload.ts
3
- var _excluded$1 = ["targets"];
3
+ var _excluded$2 = ["targets"];
4
4
  var _excluded2$1 = ["targets"];
5
5
  var _excluded3$1 = ["blocks"];
6
6
  var _excluded4$1 = ["blocks"];
@@ -36,7 +36,7 @@ var point = (x, y) => {
36
36
  };
37
37
  };
38
38
  function planBlockReload(before, after) {
39
- const { targets: oldTargets } = before, oldProject = _objectWithoutProperties(before, _excluded$1);
39
+ const { targets: oldTargets } = before, oldProject = _objectWithoutProperties(before, _excluded$2);
40
40
  const { targets: newTargets } = after, newProject = _objectWithoutProperties(after, _excluded2$1);
41
41
  if (oldTargets.length !== newTargets.length || !equal(oldProject, newProject)) return reject$1();
42
42
  const edits = [];
@@ -164,7 +164,7 @@ function applyBlockReload(targets, edits) {
164
164
  return [...touched];
165
165
  }
166
166
  // src/script-reload.ts
167
- var _excluded = ["targets"];
167
+ var _excluded$1 = ["targets"];
168
168
  var _excluded2 = ["targets"];
169
169
  var _excluded3 = ["blocks"];
170
170
  var _excluded4 = ["blocks"];
@@ -216,7 +216,7 @@ function opcodesOf(blocks, into) {
216
216
  * project and its targets, including comments, must stay the same; otherwise the whole project is reloaded.
217
217
  */
218
218
  function planScriptReload(before, after) {
219
- const { targets: oldTargets } = before, oldProject = _objectWithoutProperties(before, _excluded);
219
+ const { targets: oldTargets } = before, oldProject = _objectWithoutProperties(before, _excluded$1);
220
220
  const { targets: newTargets } = after, newProject = _objectWithoutProperties(after, _excluded2);
221
221
  if (oldTargets.length !== newTargets.length || !equal(oldProject, newProject)) return reject();
222
222
  const known = new Set(corePrefixes);
@@ -330,6 +330,42 @@ function applyScriptReload(targets, edits, deserialize) {
330
330
  return prepared.map(({ target }) => target);
331
331
  }
332
332
  // src/session.ts
333
+ var _excluded = ["blockPalette"];
334
+ var screenStateMaxBytes = 524288;
335
+ var notFound = (error) => error instanceof DOMException && ["NotFoundError", "TypeMismatchError"].includes(error.name);
336
+ /** The screen state the folder was saved with, or nothing. */
337
+ async function readScreenStateText(directory) {
338
+ try {
339
+ const file = await (await (await directory.getDirectoryHandle(editorDirectory)).getFileHandle(screenStateFile)).getFile();
340
+ return file.size > screenStateMaxBytes ? void 0 : await file.text();
341
+ } catch (error) {
342
+ if (!notFound(error)) console.warn("The screen state of the project folder could not be read", error);
343
+ }
344
+ }
345
+ /** The slices of a screen state, to tell whether only the time of the save changed. */
346
+ var slicesOf = (text) => {
347
+ try {
348
+ return JSON.stringify(JSON.parse(text).slices);
349
+ } catch (_unused) {
350
+ return;
351
+ }
352
+ };
353
+ /** Write the screen state next to the project. Failing to write it never fails the save. */
354
+ async function writeScreenStateText(directory, text) {
355
+ try {
356
+ if (slicesOf(await readScreenStateText(directory)) === slicesOf(text)) return;
357
+ const writable = await (await (await directory.getDirectoryHandle(editorDirectory, { create: true })).getFileHandle(screenStateFile, { create: true })).createWritable();
358
+ try {
359
+ await writable.write(new TextEncoder().encode(text));
360
+ await writable.close();
361
+ } catch (error) {
362
+ await writable.abort().catch(() => {});
363
+ throw error;
364
+ }
365
+ } catch (error) {
366
+ console.warn("The screen state of the project folder could not be saved", error);
367
+ }
368
+ }
333
369
  var storageReaders = /* @__PURE__ */ new WeakMap();
334
370
  var readerFor = (storage) => {
335
371
  const existing = storageReaders.get(storage);
@@ -344,12 +380,16 @@ var readerFor = (storage) => {
344
380
  return reader;
345
381
  };
346
382
  var encodeJson = (value) => new TextEncoder().encode(`${JSON.stringify(value, null, 2)}\n`);
347
- function saveManifest(source, added, removed) {
348
- const value = JSON.parse(new TextDecoder().decode(source.files.get(manifestFile)));
383
+ function saveManifest(source, added, removed, palette) {
384
+ const _JSON$parse = JSON.parse(new TextDecoder().decode(source.files.get(manifestFile))), { blockPalette: _ } = _JSON$parse, value = _objectWithoutProperties(_JSON$parse, _excluded);
349
385
  const entries = value.archiveEntries.filter((name) => !removed.includes(name));
350
- return encodeJson(_objectSpread2(_objectSpread2({}, value), {}, { archiveEntries: [...entries, ...added] }));
386
+ return encodeJson(_objectSpread2(_objectSpread2({}, value), {}, {
387
+ formatVersion: palette ? 2 : 1,
388
+ archiveEntries: [...entries, ...added]
389
+ }, palette ? { blockPalette: paletteFile } : {}));
351
390
  }
352
391
  function createFolderSession(vm, host) {
392
+ var _host$screenState, _host$screenState$reg;
353
393
  let current = null;
354
394
  const listeners = /* @__PURE__ */ new Set();
355
395
  const notify = () => {
@@ -418,17 +458,46 @@ function createFolderSession(vm, host) {
418
458
  notifyEdits();
419
459
  };
420
460
  const planSave = (session, edited) => {
461
+ var _source$files$get;
421
462
  const { source } = session;
422
- const result = projectChanges(source.project, session.baseline, edited, identity(session, edited));
463
+ const expanded = projectChanges(expandPalette(source.project, source.palette), session.baseline, edited, identity(session, edited));
464
+ const collapsed = expanded ? collapsePalette(expanded) : null;
465
+ const result = collapsed && !equal(collapsed.project, source.project) ? collapsed.project : null;
466
+ const palette = collapsed ? collapsed.document : source.palette;
467
+ const paletteBytes = palette ? encodePalette(palette) : null;
468
+ const previousPalette = (_source$files$get = source.files.get(paletteFile)) !== null && _source$files$get !== void 0 ? _source$files$get : null;
469
+ const paletteChanged = paletteBytes === null ? previousPalette !== null : previousPalette === null || !sameBytes(paletteBytes, previousPalette);
423
470
  const extensionSave = planExtensionSave(source, result !== null && result !== void 0 ? result : source.project);
424
471
  const needed = projectAssets(extensionSave.project);
472
+ const added = [...needed].filter(([name]) => !source.bytes.has(name));
473
+ const removed = [...source.bytes.keys()].filter((name) => !needed.has(name));
425
474
  return {
426
475
  result,
427
476
  extensionSave,
428
- added: [...needed].filter(([name]) => !source.bytes.has(name)),
429
- removed: [...source.bytes.keys()].filter((name) => !needed.has(name))
477
+ added,
478
+ removed,
479
+ palette,
480
+ paletteBytes,
481
+ paletteChanged,
482
+ manifestChanged: added.length > 0 || removed.length > 0 || paletteBytes === null !== (previousPalette === null)
430
483
  };
431
484
  };
485
+ let expectingTree = false;
486
+ let pendingTree;
487
+ const unregisterTree = (_host$screenState = host.screenState) === null || _host$screenState === void 0 || (_host$screenState$reg = _host$screenState.register) === null || _host$screenState$reg === void 0 ? void 0 : _host$screenState$reg.call(_host$screenState, "projectFolder", {
488
+ capture: () => current ? readExplorerState(current.source.directory) : void 0,
489
+ apply(value) {
490
+ const tree = parseExplorerState(value);
491
+ if (!tree) return;
492
+ if (current) writeExplorerState(current.source.directory, tree, true);
493
+ else if (expectingTree) pendingTree = tree;
494
+ }
495
+ });
496
+ const saveScreenState = async (directory) => {
497
+ var _host$screenState2;
498
+ const text = (_host$screenState2 = host.screenState) === null || _host$screenState2 === void 0 ? void 0 : _host$screenState2.serialize();
499
+ if (text !== void 0) await writeScreenStateText(directory, text);
500
+ };
432
501
  const loaded = () => setCurrent(null);
433
502
  vm.runtime.on("PROJECT_LOADED", loaded);
434
503
  vm.on("PROJECT_CHANGED", changed);
@@ -442,6 +511,7 @@ function createFolderSession(vm, host) {
442
511
  editListeners.clear();
443
512
  vm.runtime.off("PROJECT_LOADED", loaded);
444
513
  vm.off("PROJECT_CHANGED", changed);
514
+ unregisterTree === null || unregisterTree === void 0 || unregisterTree();
445
515
  };
446
516
  const openFrom = async (getDirectory, confirmReplace, prepare = (directory) => readFolder(directory, vm.runtime.storage), stillCurrent = () => true) => {
447
517
  if (disposed || busy) return "cancelled";
@@ -461,7 +531,10 @@ function createFolderSession(vm, host) {
461
531
  const assets = source.storageAssets;
462
532
  reader.assets = assets;
463
533
  let stage;
534
+ pendingTree = void 0;
535
+ expectingTree = true;
464
536
  try {
537
+ if (host.screenState) host.screenState.prepareLoad(await readScreenStateText(directory));
465
538
  vm.quit();
466
539
  await vm.loadProject(source.loadText, { replaceLegacyExtensions: true });
467
540
  stage = vm.runtime.getTargetForStage();
@@ -478,6 +551,9 @@ function createFolderSession(vm, host) {
478
551
  ids: identify(baseline),
479
552
  pending: null
480
553
  });
554
+ expectingTree = false;
555
+ if (pendingTree) writeExplorerState(directory, pendingTree, true);
556
+ pendingTree = void 0;
481
557
  (_vm$renderer = vm.renderer) === null || _vm$renderer === void 0 || _vm$renderer.draw();
482
558
  return "opened";
483
559
  } finally {
@@ -559,10 +635,11 @@ function createFolderSession(vm, host) {
559
635
  const paths = /* @__PURE__ */ new Set();
560
636
  if (!current) return paths;
561
637
  try {
562
- const { result, extensionSave, added, removed } = planSave(current, snapshot());
638
+ const { result, extensionSave, added, removed, paletteChanged, manifestChanged } = planSave(current, snapshot());
563
639
  if (result) paths.add(projectFile);
564
640
  if (extensionSave.manifestChanged) paths.add(extensionsFile);
565
- if (added.length || removed.length) paths.add(manifestFile);
641
+ if (manifestChanged) paths.add(manifestFile);
642
+ if (paletteChanged) paths.add(paletteFile);
566
643
  for (const name of [...added.map(([name]) => name), ...removed]) paths.add(`assets/${name}`);
567
644
  for (const name of [...extensionSave.writes.keys(), ...extensionSave.removed]) paths.add(`extensions/${name}`);
568
645
  } catch (error) {
@@ -575,10 +652,11 @@ function createFolderSession(vm, host) {
575
652
  readUnsavedFile(path) {
576
653
  if (!current || busy) return;
577
654
  try {
578
- const { result, extensionSave, added, removed } = planSave(current, snapshot());
655
+ const { result, extensionSave, added, removed, paletteBytes, paletteChanged, manifestChanged } = planSave(current, snapshot());
579
656
  if (path === "project.source.json" && result) return encodeJson(extensionSave.project);
580
657
  if (path === "embedded-extensions.json" && extensionSave.manifestChanged) return encodeJson(extensionSave.embedded);
581
- if (path === "sb3-source.json" && (added.length || removed.length)) return saveManifest(current.source, added.map(([name]) => name), removed);
658
+ if (path === "sb3-source.json" && manifestChanged) return saveManifest(current.source, added.map(([name]) => name), removed, paletteBytes !== null);
659
+ if (path === paletteFile && paletteChanged) return paletteBytes;
582
660
  if (path.startsWith("assets/")) {
583
661
  var _added$find, _assetData;
584
662
  const name = path.slice(7);
@@ -649,9 +727,8 @@ function createFolderSession(vm, host) {
649
727
  const base = decoder.decode(session.source.files.get(projectFile));
650
728
  let editor;
651
729
  try {
652
- const edited = snapshot();
653
- const result = projectChanges(session.source.project, session.baseline, edited, identity(session, edited));
654
- editor = result ? `${JSON.stringify(planExtensionSave(session.source, result).project, null, 2)}\n` : base;
730
+ const { result, extensionSave } = planSave(session, snapshot());
731
+ editor = result ? `${JSON.stringify(extensionSave.project, null, 2)}\n` : base;
655
732
  } catch (error) {
656
733
  if (!(error instanceof FolderError)) throw error;
657
734
  editor = null;
@@ -660,7 +737,7 @@ function createFolderSession(vm, host) {
660
737
  try {
661
738
  const file = await (await session.source.directory.getFileHandle(projectFile)).getFile();
662
739
  disk = decoder.decode(new Uint8Array(await file.arrayBuffer()));
663
- } catch (_unused) {
740
+ } catch (_unused2) {
664
741
  disk = null;
665
742
  }
666
743
  return current === session ? {
@@ -774,7 +851,7 @@ function createFolderSession(vm, host) {
774
851
  const saveRevision = revision;
775
852
  const edited = snapshot();
776
853
  const ids = identify(edited);
777
- const { result, extensionSave, added: newAssets, removed } = planSave(session, edited);
854
+ const { result, extensionSave, added: newAssets, removed, palette, paletteBytes, paletteChanged, manifestChanged } = planSave(session, edited);
778
855
  await assertFolderUnchanged(session.source);
779
856
  active(session);
780
857
  const { source } = session;
@@ -786,7 +863,8 @@ function createFolderSession(vm, host) {
786
863
  if (vm.runtime.storage.createAsset(assetTypeFor(vm.runtime.storage, kind, format), format, data.slice(), null, true).assetId !== id) return unsupported(`Asset hash mismatch: ${name}`);
787
864
  added.set(name, data);
788
865
  }
789
- if (!result && !removed.length && !extensionSave.removed.length) {
866
+ if (!result && !removed.length && !extensionSave.removed.length && !paletteChanged && !manifestChanged) {
867
+ await saveScreenState(source.directory);
790
868
  if (revision === saveRevision) host.onSaved();
791
869
  notify();
792
870
  return {
@@ -794,7 +872,7 @@ function createFolderSession(vm, host) {
794
872
  sourceRemoved: []
795
873
  };
796
874
  }
797
- const manifest = added.size || removed.length ? saveManifest(source, added.keys(), removed) : null;
875
+ const manifest = manifestChanged ? saveManifest(source, added.keys(), removed, paletteBytes !== null) : null;
798
876
  const root = {
799
877
  directory: source.directory,
800
878
  files: source.files,
@@ -855,6 +933,7 @@ function createFolderSession(vm, host) {
855
933
  try {
856
934
  for (const [name, data] of added) await write(assets, name, data);
857
935
  for (const [name, data] of extensionSave.writes) await write(extensions, name, data);
936
+ if (paletteBytes && paletteChanged) await write(root, paletteFile, paletteBytes);
858
937
  if (manifest) await write(root, manifestFile, manifest);
859
938
  if (extensionSave.manifestChanged) await write(root, extensionsFile, encodeJson(extensionSave.embedded));
860
939
  if (result) await write(root, projectFile, encodeJson(extensionSave.project));
@@ -864,7 +943,13 @@ function createFolderSession(vm, host) {
864
943
  }
865
944
  source.project = extensionSave.project;
866
945
  source.embedded = extensionSave.embedded;
867
- for (const [{ directory, files, prefix }, names] of [[assets, removed], [extensions, extensionSave.removed]]) for (const name of names) {
946
+ source.palette = palette;
947
+ const removedRoot = paletteBytes === null && paletteChanged ? [paletteFile] : [];
948
+ for (const [{ directory, files, prefix }, names] of [
949
+ [root, removedRoot],
950
+ [assets, removed],
951
+ [extensions, extensionSave.removed]
952
+ ]) for (const name of names) {
868
953
  try {
869
954
  const file = await (await directory.getFileHandle(name)).getFile();
870
955
  if (!sameBytes(new Uint8Array(await file.arrayBuffer()), files.get(name))) continue;
@@ -878,6 +963,7 @@ function createFolderSession(vm, host) {
878
963
  session.baseline = edited;
879
964
  session.ids = ids;
880
965
  session.pending = null;
966
+ await saveScreenState(source.directory);
881
967
  if (current === session && revision === saveRevision) host.onSaved();
882
968
  notify();
883
969
  return {
@@ -1262,4 +1348,4 @@ function renderProjectFolderMenu(createElement, { vm, locale = "en", MenuItem, M
1262
1348
  };
1263
1349
  return createElement(MenuSection, null, item("open"), entry.session.canSave ? item("save") : null);
1264
1350
  }
1265
- export { createProjectFolder, followProjectFolder, mountProjectFolder, projectFolderActions, projectFolderOverwriteWarning, renderProjectFolderMenu };
1351
+ export { createProjectFolder, followProjectFolder, mountProjectFolder, parseExplorerState, projectFolderActions, projectFolderOverwriteWarning, readExplorerState, renderProjectFolderMenu, subscribeExplorerState, writeExplorerState };
package/dist/session.d.ts CHANGED
@@ -1,6 +1,21 @@
1
1
  import type { Asset, Storage } from './source.js';
2
2
  import type { ReloadTarget } from './block-reload.js';
3
3
  import type { DeserializeBlocks } from './script-reload.js';
4
+ /**
5
+ * The Editor's screen state, such as `installProjectScreenState` of the workbench gives it. A project folder is not
6
+ * an SB3, so the folder keeps the state as `.tw-plus/workspace.json` and gives it back when it opens.
7
+ */
8
+ export interface FolderScreenState {
9
+ /** The text to write, or nothing to leave the file as it is. */
10
+ serialize(): string | undefined;
11
+ /** Use this text for the next project load. */
12
+ prepareLoad(text: string | undefined): void;
13
+ /** Add a slice, here the explorer's tree. Returns a function that removes it. */
14
+ register?(key: string, slice: {
15
+ capture(): unknown;
16
+ apply?(value: unknown): void;
17
+ }): () => void;
18
+ }
4
19
  export interface FolderVM {
5
20
  runtime: {
6
21
  storage: Storage;
@@ -51,6 +66,7 @@ export interface FolderHost {
51
66
  */
52
67
  compareChanges?(request: ComparisonRequest): Promise<string | null>;
53
68
  };
69
+ screenState?: FolderScreenState;
54
70
  }
55
71
  /** A titled comparison of two project.source.json texts; `null` stands for a version that cannot be shown. */
56
72
  export type ComparisonSection = {
@@ -1,4 +1,4 @@
1
- import { T as _objectSpread2 } from "./shared-Dz9dzxQF.js";
1
+ import { L as _objectSpread2 } from "./shared-tZS90T71.js";
2
2
  // node_modules/@marijn/find-cluster-break/src/index.js
3
3
  var rangeFrom = [];
4
4
  var rangeTo = [];