@kubohiroya/turbowarp-plus-editor-project-folder 0.13.0 → 0.15.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/src/index.ts CHANGED
@@ -2,6 +2,9 @@ import {FolderError} from './source.js';
2
2
  import {createFolderSession} from './session.js';
3
3
  import {isProjectFolderEmpty} from './create-folder.js';
4
4
  import {registerFolder} from './folder-registry.js';
5
+ import {openBrowserProjects} from './browser-projects.js';
6
+ import type {BrowserProjects} from './browser-projects.js';
7
+ import {chooseBrowserProject} from './browser-project-dialog.js';
5
8
  import type {FolderHost, FolderVM, PickerWindow} from './session.js';
6
9
 
7
10
  export type {Comparison, ComparisonRequest, ComparisonSection, FolderHost, FolderScreenState, FolderVM, OpenResult} from './session.js';
@@ -10,10 +13,15 @@ export {followProjectFolder} from './folder-registry.js';
10
13
  export type {FollowedFolder} from './folder-registry.js';
11
14
  export type {DeserializeBlocks} from './script-reload.js';
12
15
  export {createProjectFolder, projectFolderOverwriteWarning} from './create-folder.js';
16
+ export {openBrowserProjects} from './browser-projects.js';
17
+ export type {BrowserProject, BrowserProjects, BrowserStorageState} from './browser-projects.js';
18
+ export {chooseBrowserProject, exportBrowserProject, zipFileName} from './browser-project-dialog.js';
19
+ export type {BrowserProjectChoice} from './browser-project-dialog.js';
20
+ export {zipDirectory} from './zip.js';
13
21
 
14
22
  const messages = {
15
23
  en: {
16
- open: 'Open Project Folder…', save: 'Save to Project Folder',
24
+ open: 'Open Project Folder…', save: 'Save to Project Folder', openBrowser: 'Open Project Folder in This Browser…',
17
25
  replace: 'Replace the open project and discard its unsaved changes?',
18
26
  opened: 'Project folder opened.', saved: 'Project folder saved.', unchanged: 'No changes to save.',
19
27
  sourceRemoved: (ids: string[]) => `Removed source metadata for replaced extensions: ${ids.join(', ')}. Use sb3-toolchain to fetch the managed sources again if you need to keep their provenance.`,
@@ -34,7 +42,7 @@ const messages = {
34
42
  full: 'These changes need the whole project to be reloaded.'
35
43
  },
36
44
  ja: {
37
- open: 'プロジェクトフォルダを開く…', save: 'プロジェクトフォルダに保存',
45
+ open: 'プロジェクトフォルダを開く…', save: 'プロジェクトフォルダに保存', openBrowser: 'ブラウザー内のプロジェクトフォルダを開く…',
38
46
  replace: '未保存の変更を破棄して、別の作品を開きますか?',
39
47
  opened: 'プロジェクトフォルダを開きました。', saved: 'プロジェクトフォルダに保存しました。', unchanged: '保存する変更はありません。',
40
48
  sourceRemoved: (ids: string[]) => `差し替えた拡張機能(${ids.join('、')})の出どころ情報を削除しました。出どころを保つには、sb3-toolchain で拡張機能を取得し直してください。`,
@@ -64,7 +72,9 @@ interface MenuProps {
64
72
  MenuSection: any;
65
73
  onRequestClose(): void;
66
74
  }
67
- type MenuEntry = {session: ReturnType<typeof createFolderSession>; open(locale: string): void; save(locale: string): void};
75
+ type MenuEntry = {session: ReturnType<typeof createFolderSession>; open(locale: string): void; save(locale: string): void;
76
+ /** Opens a folder kept in this browser, when the host shows it beside the folder picker. */
77
+ openBrowser?(locale: string): void};
68
78
  const menus = new WeakMap<FolderVM, MenuEntry>();
69
79
 
70
80
  type ObserverWindow = PickerWindow & {FileSystemObserver?: new (callback: () => void) => {
@@ -72,16 +82,50 @@ type ObserverWindow = PickerWindow & {FileSystemObserver?: new (callback: () =>
72
82
  disconnect(): void;
73
83
  }};
74
84
 
85
+ /**
86
+ * Where project folders can live, besides folders the user picks on the device.
87
+ * - `fallback` (default): in the browser's private file system when the browser cannot pick folders, as in Safari
88
+ * and Firefox. Open and Save then use those folders.
89
+ * - `always`: also offer the browser's folders where the browser can pick folders.
90
+ * - `off`: only folders on the device.
91
+ */
92
+ export type BrowserStorageMode = 'fallback' | 'always' | 'off';
93
+
94
+ const abort = () => new DOMException('The user closed the dialog', 'AbortError');
95
+
75
96
  /**
76
97
  * `autoReload` (default true) applies value and position changes without a click when the Editor has no unsaved
77
98
  * edits and the project is stopped. Other changes always wait for the reload command.
78
99
  */
79
- export function mountProjectFolder({vm, document, host, locale = 'en', autoReload = true}: {
80
- vm: FolderVM; document: Document; host: FolderHost; locale?: string; autoReload?: boolean;
100
+ export function mountProjectFolder({vm, document, host, locale = 'en', autoReload = true, browserStorage = 'fallback'}: {
101
+ vm: FolderVM; document: Document; host: FolderHost; locale?: string; autoReload?: boolean; browserStorage?: BrowserStorageMode;
81
102
  }) {
82
103
  const view = document.defaultView as ObserverWindow;
83
- const pickDirectory = view?.showDirectoryPicker;
84
- if (!pickDirectory || !vm.runtime?.storage) return null;
104
+ const devicePicker = view?.showDirectoryPicker;
105
+ const browserProjects: BrowserProjects | null = view && browserStorage !== 'off' &&
106
+ (browserStorage === 'always' || !devicePicker) ? openBrowserProjects(view) : null;
107
+ if ((!devicePicker && !browserProjects) || !vm.runtime?.storage) return null;
108
+ // Folders in the browser stand in for the picker where there is none.
109
+ const chooseBrowser = async (purpose: 'open' | 'create', title?: string) => {
110
+ const choice = await chooseBrowserProject({document, projects: browserProjects!, locale, purpose, title});
111
+ if (!choice) throw abort();
112
+ return choice.directory;
113
+ };
114
+ const pickDirectory = devicePicker ?
115
+ (options: {id: string; mode: 'readwrite'}) => devicePicker.call(view, options) :
116
+ () => chooseBrowser('open');
117
+ const pickNewDirectory = (options: {id: string; mode: 'readwrite'}, title?: string) =>
118
+ devicePicker ? devicePicker.call(view, options) : chooseBrowser('create', title);
119
+ /** Runs `run` with the browser folder of `directory` locked against other tabs, and marks it as updated. */
120
+ const withBrowserProject = async <T>(directory: FileSystemDirectoryHandle | null, run: () => Promise<T>) => {
121
+ const project = directory && browserProjects ? await browserProjects.find(directory).catch(() => null) : null;
122
+ if (!project) return run();
123
+ return browserProjects!.exclusive(project.id, async () => {
124
+ const result = await run();
125
+ await browserProjects!.touch(project.id).catch(() => {});
126
+ return result;
127
+ });
128
+ };
85
129
  const session = createFolderSession(vm, host);
86
130
  const status = document.createElement('output');
87
131
  status.dataset.projectFolderStatus = '';
@@ -230,18 +274,24 @@ export function mountProjectFolder({vm, document, host, locale = 'en', autoReloa
230
274
  session,
231
275
  open(locale) {
232
276
  const message = messageFor(locale);
233
- session.open(options => pickDirectory.call(view, options), () => view.confirm(message.replace))
277
+ session.open(options => pickDirectory(options), () => view.confirm(message.replace))
234
278
  .then(result => {if (result === 'opened') report(message.opened);}, error => fail(locale, error)).finally(renderReload);
235
279
  renderReload();
236
280
  },
281
+ openBrowser: devicePicker && browserProjects ? locale => {
282
+ const message = messageFor(locale);
283
+ session.open(() => chooseBrowser('open'), () => view.confirm(message.replace))
284
+ .then(result => {if (result === 'opened') report(message.opened);}, error => fail(locale, error)).finally(renderReload);
285
+ renderReload();
286
+ } : undefined,
237
287
  save(locale) {
238
288
  if (!session.busy) {
239
289
  const message = messageFor(locale);
240
290
  const directory = session.directory;
241
- const save = () => {
291
+ const save = () => withBrowserProject(directory, () => {
242
292
  if (session.directory !== directory) throw new FolderError('conflict');
243
293
  return session.save();
244
- };
294
+ });
245
295
  void (host.saveWithLock?.(save) ?? save()).then(({status, sourceRemoved}) => {
246
296
  const detail = sourceRemoved.length ? ` ${message.sourceRemoved(sourceRemoved)}` : '';
247
297
  report(message[status] + detail);
@@ -265,19 +315,26 @@ export function mountProjectFolder({vm, document, host, locale = 'en', autoReloa
265
315
  unsavedPaths: () => session.unsavedPaths(),
266
316
  readUnsavedFile: (path: string) => session.readUnsavedFile(path),
267
317
  subscribeEdits: (listener: () => void) => session.subscribeEdits(listener),
268
- save: () => session.save().finally(renderReload),
269
- createFromSnapshot({prepareFiles, collectEdits, directory, current = () => true}: {
318
+ save: () => withBrowserProject(session.directory, () => session.save()).finally(renderReload),
319
+ /** The folders kept in this browser, when they are offered, for a host that lists or exports them. */
320
+ browserProjects,
321
+ /**
322
+ * Creates a project folder from a snapshot. `title` names a folder made in the browser, where the user names a
323
+ * new folder instead of picking one on the device.
324
+ */
325
+ createFromSnapshot({prepareFiles, collectEdits, directory, current = () => true, title}: {
270
326
  prepareFiles: () => Promise<ReadonlyMap<string, Uint8Array>>;
271
327
  collectEdits?: () => Promise<void>;
272
328
  directory?: FileSystemDirectoryHandle;
273
329
  current?: () => boolean;
330
+ title?: string;
274
331
  }) {
275
332
  const message = locale.startsWith('ja') ?
276
333
  '指定されたフォルダは空ではありません。フォルダに保存されている内容が上書きされる場合があります。よろしいですか?' :
277
334
  'The selected folder is not empty. Contents in the folder may be overwritten. Continue?';
278
335
  return session.createFromSnapshot(async () => {
279
336
  try {
280
- const selected = directory ?? await pickDirectory.call(view, {id: 'turbowarp-plus-project-folder', mode: 'readwrite'});
337
+ const selected = directory ?? await pickNewDirectory({id: 'turbowarp-plus-project-folder', mode: 'readwrite'}, title);
281
338
  if (!current()) return null;
282
339
  const overwrite = !await isProjectFolderEmpty(selected);
283
340
  if (!current() || (overwrite && !view.confirm(message))) return null;
@@ -310,6 +367,7 @@ export function projectFolderActions(vm: FolderVM, locale = 'en') {
310
367
  if (!entry) return undefined;
311
368
  return {
312
369
  open: () => entry.open(locale),
370
+ openBrowser: entry.openBrowser ? () => entry.openBrowser!(locale) : undefined,
313
371
  save: entry.session.canSave ? () => entry.save(locale) : undefined,
314
372
  detach: () => entry.session.detach()
315
373
  };
@@ -321,8 +379,8 @@ export function renderProjectFolderMenu(createElement: MenuElement, {
321
379
  const entry = menus.get(vm);
322
380
  if (!entry) return null;
323
381
  const labels = locale.startsWith('ja') ? messages.ja : messages.en;
324
- const item = (action: 'open' | 'save') => {
325
- const run = () => {onRequestClose(); entry[action](locale);};
382
+ const item = (action: 'open' | 'openBrowser' | 'save') => {
383
+ const run = () => {onRequestClose(); entry[action]!(locale);};
326
384
  return createElement(MenuItem, {command: `project-folder-${action}`, onClick: run},
327
385
  createElement('span', {role: 'button', tabIndex: 0, onKeyDown(event: KeyboardEvent) {
328
386
  if (event.key !== 'Enter' && event.key !== ' ') return;
@@ -331,7 +389,8 @@ export function renderProjectFolderMenu(createElement: MenuElement, {
331
389
  run();
332
390
  }}, labels[action]));
333
391
  };
334
- return createElement(MenuSection, null, item('open'), entry.session.canSave ? item('save') : null);
392
+ return createElement(MenuSection, null, item('open'), entry.openBrowser ? item('openBrowser') : null,
393
+ entry.session.canSave ? item('save') : null);
335
394
  }
336
395
  export {parseExplorerState, readExplorerState, subscribeExplorerState, writeExplorerState} from './explorer-state.js';
337
396
  export type {ExplorerTreeState} from './explorer-state.js';