@kubohiroya/turbowarp-plus-editor-project-folder 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +17 -2
- package/README.md +17 -2
- package/dist/browser-project-dialog.d.ts +20 -0
- package/dist/browser-projects.d.ts +47 -0
- package/dist/explorer-files.d.ts +5 -0
- package/dist/explorer.js +93 -32
- package/dist/index.d.ts +25 -2
- package/dist/index.js +704 -19
- package/dist/zip.d.ts +9 -0
- package/package.json +1 -1
- package/src/browser-project-dialog.ts +257 -0
- package/src/browser-projects.ts +211 -0
- package/src/explorer-files.ts +33 -1
- package/src/explorer.tsx +28 -14
- package/src/index.ts +75 -16
- package/src/zip.ts +103 -0
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
|
|
84
|
-
|
|
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
|
|
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
|
-
|
|
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
|
|
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.
|
|
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';
|
package/src/zip.ts
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Writes a folder as a ZIP archive without compression, so a project folder kept in the browser can be saved as one
|
|
3
|
+
* file. Entries use UTF-8 names. The archive holds at most 65535 entries and 4 GiB, which a project folder stays under.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
type IterableDirectory = FileSystemDirectoryHandle & {values(): AsyncIterable<FileSystemHandle>};
|
|
7
|
+
|
|
8
|
+
const crcTable = (() => {
|
|
9
|
+
const table = new Uint32Array(256);
|
|
10
|
+
for (let n = 0; n < 256; n++) {
|
|
11
|
+
let c = n;
|
|
12
|
+
for (let k = 0; k < 8; k++) c = c & 1 ? 0xedb88320 ^ (c >>> 1) : c >>> 1;
|
|
13
|
+
table[n] = c >>> 0;
|
|
14
|
+
}
|
|
15
|
+
return table;
|
|
16
|
+
})();
|
|
17
|
+
|
|
18
|
+
export function crc32(bytes: Uint8Array) {
|
|
19
|
+
let crc = 0xffffffff;
|
|
20
|
+
for (let i = 0; i < bytes.length; i++) crc = crcTable[(crc ^ bytes[i]) & 0xff] ^ (crc >>> 8);
|
|
21
|
+
return (crc ^ 0xffffffff) >>> 0;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
function dosTime(time: number) {
|
|
25
|
+
const date = new Date(Math.max(time, Date.UTC(1980, 0, 1)));
|
|
26
|
+
return {
|
|
27
|
+
time: (date.getHours() << 11) | (date.getMinutes() << 5) | Math.floor(date.getSeconds() / 2),
|
|
28
|
+
date: ((date.getFullYear() - 1980) << 9) | ((date.getMonth() + 1) << 5) | date.getDate()
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
type Entry = {name: string; data: Uint8Array; modified: number; directory: boolean};
|
|
33
|
+
|
|
34
|
+
async function collect(directory: FileSystemDirectoryHandle, prefix: string, exclude: (path: string) => boolean, out: Entry[]) {
|
|
35
|
+
const children: FileSystemHandle[] = [];
|
|
36
|
+
for await (const child of (directory as IterableDirectory).values()) children.push(child);
|
|
37
|
+
children.sort((a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0);
|
|
38
|
+
if (prefix && !children.length) out.push({name: prefix, data: new Uint8Array(), modified: Date.now(), directory: true});
|
|
39
|
+
for (const child of children) {
|
|
40
|
+
const path = prefix + child.name;
|
|
41
|
+
if (exclude(path)) continue;
|
|
42
|
+
if (child.kind === 'directory') {
|
|
43
|
+
await collect(child as FileSystemDirectoryHandle, `${path}/`, exclude, out);
|
|
44
|
+
} else {
|
|
45
|
+
const file = await (child as FileSystemFileHandle).getFile();
|
|
46
|
+
out.push({name: path, data: new Uint8Array(await file.arrayBuffer()), modified: file.lastModified, directory: false});
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/** The files under `directory` as a ZIP. `exclude` receives paths relative to `directory`, such as `.git`. */
|
|
52
|
+
export async function zipDirectory(directory: FileSystemDirectoryHandle, {exclude = () => false}: {
|
|
53
|
+
exclude?: (path: string) => boolean;
|
|
54
|
+
} = {}) {
|
|
55
|
+
const entries: Entry[] = [];
|
|
56
|
+
await collect(directory, '', exclude, entries);
|
|
57
|
+
if (entries.length > 0xffff) throw new RangeError('Too many files for a ZIP archive');
|
|
58
|
+
const encoder = new TextEncoder();
|
|
59
|
+
const parts: Uint8Array[] = [];
|
|
60
|
+
const central: Uint8Array[] = [];
|
|
61
|
+
let offset = 0;
|
|
62
|
+
for (const entry of entries) {
|
|
63
|
+
const name = encoder.encode(entry.name);
|
|
64
|
+
const crc = crc32(entry.data);
|
|
65
|
+
const {time, date} = dosTime(entry.modified);
|
|
66
|
+
const local = new DataView(new ArrayBuffer(30));
|
|
67
|
+
local.setUint32(0, 0x04034b50, true);
|
|
68
|
+
local.setUint16(4, 20, true);
|
|
69
|
+
local.setUint16(6, 0x0800, true); // UTF-8 names
|
|
70
|
+
local.setUint16(8, 0, true); // stored
|
|
71
|
+
local.setUint16(10, time, true);
|
|
72
|
+
local.setUint16(12, date, true);
|
|
73
|
+
local.setUint32(14, crc, true);
|
|
74
|
+
local.setUint32(18, entry.data.length, true);
|
|
75
|
+
local.setUint32(22, entry.data.length, true);
|
|
76
|
+
local.setUint16(26, name.length, true);
|
|
77
|
+
const header = new DataView(new ArrayBuffer(46));
|
|
78
|
+
header.setUint32(0, 0x02014b50, true);
|
|
79
|
+
header.setUint16(4, 20, true);
|
|
80
|
+
header.setUint16(6, 20, true);
|
|
81
|
+
header.setUint16(8, 0x0800, true);
|
|
82
|
+
header.setUint16(12, time, true);
|
|
83
|
+
header.setUint16(14, date, true);
|
|
84
|
+
header.setUint32(16, crc, true);
|
|
85
|
+
header.setUint32(20, entry.data.length, true);
|
|
86
|
+
header.setUint32(24, entry.data.length, true);
|
|
87
|
+
header.setUint16(28, name.length, true);
|
|
88
|
+
header.setUint32(38, entry.directory ? 0x10 : 0, true);
|
|
89
|
+
header.setUint32(42, offset, true);
|
|
90
|
+
parts.push(new Uint8Array(local.buffer), name, entry.data);
|
|
91
|
+
central.push(new Uint8Array(header.buffer), name);
|
|
92
|
+
offset += 30 + name.length + entry.data.length;
|
|
93
|
+
if (offset > 0xffffffff) throw new RangeError('The folder is too large for a ZIP archive');
|
|
94
|
+
}
|
|
95
|
+
const size = central.reduce((total, part) => total + part.length, 0);
|
|
96
|
+
const end = new DataView(new ArrayBuffer(22));
|
|
97
|
+
end.setUint32(0, 0x06054b50, true);
|
|
98
|
+
end.setUint16(8, entries.length, true);
|
|
99
|
+
end.setUint16(10, entries.length, true);
|
|
100
|
+
end.setUint32(12, size, true);
|
|
101
|
+
end.setUint32(16, offset, true);
|
|
102
|
+
return new Blob([...parts, ...central, new Uint8Array(end.buffer)] as BlobPart[], {type: 'application/zip'});
|
|
103
|
+
}
|