@kubohiroya/turbowarp-extension-loader 0.5.0 → 0.6.0

package/README.ja.md

@@ -218,10 +218,17 @@ Manifest は `uri` を持てます。その作品をダウンロードできる
 {"schemaVersion": 1, "uri": "https://example.test/editor/turbowarp-plus-projects/66/66aa/0193f0a1-2b3c-7d4e-8f01-2233445566aa.sb3", "extensions": []}
 ```
 
-1つの作品に1つの URI。何度編集しても変わりません。だから指紋ではなく住所なのです。指紋は保存
+1つの作品に1つの URI。何度編集しても変わりません。拡張を足したり形式を変えたりすると Manifest は
+組み直されますが、住所はその向こう側で保たれます。だから指紋ではなく住所なのです。指紋は保存
 するたびに変わるので、ブラウザーのキャッシュも開く人の選択の記録も、触るたびに同じ作品を別名で
 綴じてしまいます。住所は中身が変わっても変わりません。
 
+`prepareCatalogExtensionChanges` と `prepareExtensionAddition` は `uri` を受け取ります。作品が
+最初の住所を得るのも、作者が選んだ住所へ移るのも、この経路です。何も言わなければ作品が持って
+いる住所がそのまま残り、`readProjectAuthoringState` がその住所を報告するので、ホストは初回保存
+かどうかを決める前に見分けられます。割り当てるかどうかはホストの判断です。作者が住所を選んだ
+のか、既定が必要な初回保存なのかを知っているのはホストだけだからです。
+
 `./project-authoring` の `createProjectUUID` と `defaultProjectURI` が、作者が住所を選んで
 いないときに与える住所を組みます。
 

package/README.md

@@ -220,11 +220,19 @@ identifies it.
 {"schemaVersion": 1, "uri": "https://example.test/editor/turbowarp-plus-projects/66/66aa/0193f0a1-2b3c-7d4e-8f01-2233445566aa.sb3", "extensions": []}
 ```
 
-One work, one URI, across every edit. That is why it is an address and not a fingerprint: a
+One work, one URI, across every edit — including the edits that change its extensions, which
+rebuild the manifest around it. That is why it is an address and not a fingerprint: a
 fingerprint changes on every save, so a browser cache and a record of what the opener chose would
 file one work under a new name each time it was touched. An address does not change when the bytes
 do.
 
+`prepareCatalogExtensionChanges` and `prepareExtensionAddition` take a `uri` option, which is how
+a project gets its first address and how it moves to one the author chose. Saying nothing keeps
+the address the project already has, and `readProjectAuthoringState` reports that address, so a
+host can tell a first save from a later one before deciding. Whether to assign one is the host's
+call: only the host knows whether the author chose an address or whether this is a first save
+that needs a default.
+
 `createProjectUUID` and `defaultProjectURI` in `./project-authoring` build the address a project
 is given when its author has not chosen one:
 

package/dist/packager.js

@@ -81,7 +81,10 @@ export async function convertProjectSources(input, ports, { zip: Zip, targets =
     for (const id of Object.keys(targets))
         if (!records.some(record => record.id === id))
             fail('UNKNOWN_EXTENSION', `Unknown conversion target ${id}`);
-    const manifest = validateManifest({ schemaVersion: 1, extensions });
+    // The project keeps its address through a conversion: it is the same work, served from the
+    // same place, however its extensions are now held.
+    const manifest = validateManifest({ schemaVersion: 1,
+        ...(prepared.manifest.uri === undefined ? {} : { uri: prepared.manifest.uri }), extensions });
     const lock = Object.freeze({ schemaVersion: 1, previousLock: project.turboWarpPlusLock ?? null, extensions: Object.freeze(lockEntries) });
     project.turboWarpPlus = manifest;
     project.turboWarpPlusLock = lock;

package/dist/project-authoring.d.ts

@@ -23,6 +23,16 @@ export interface ExtensionAdditionOptions {
     signal?: AbortSignal;
     loaderOptions?: LoaderOptions;
     archiveOptions?: ArchiveLimits;
+    /**
+     * The address to give this project, or nothing to keep the one it has.
+     *
+     * Whether to assign one is the host's call, not this function's: only the host knows whether
+     * the author chose an address or whether this is a first save that needs a default. So this
+     * sets what it is given and leaves the existing address alone when it is given nothing —
+     * `readProjectAuthoringState` reports what a project already carries, so the host can tell
+     * the two apart before deciding.
+     */
+    uri?: string;
 }
 export interface PreparedExtensionAddition {
     readonly projectBytes: Uint8Array;

package/dist/project-authoring.js

@@ -21,7 +21,7 @@ function snapshotProject(input) {
  * Add a file-backed Embedded or URL-backed Remote extension without evaluating it.
  * A host approval is required before the candidate is returned; the original is untouched.
  */
-export async function prepareExtensionAddition(input, request, ports, { zip: Zip, signal: externalSignal, loaderOptions = {}, archiveOptions } = {}) {
+export async function prepareExtensionAddition(input, request, ports, { zip: Zip, signal: externalSignal, loaderOptions = {}, archiveOptions, uri } = {}) {
     if (typeof Zip !== 'function' || typeof Zip.loadAsync !== 'function')
         throw new TypeError('A compatible JSZip constructor is required');
     if (!plainObject(request) || Object.keys(request).some(key => !['id', 'source', 'bytes', 'execution'].includes(key))) {
@@ -94,10 +94,15 @@ export async function prepareExtensionAddition(input, request, ports, { zip: Zip
         if (project.extensionURLs !== undefined && !plainObject(project.extensionURLs))
             fail('INVALID_PROJECT', 'Project extensionURLs must be an object');
         const previous = prepared.manifest?.extensions || [];
+        // Carried through every rebuild below: an address that changed when an extension was
+        // added would not be an address. The host may set one, which is how a project gets its
+        // first; saying nothing keeps what is there.
+        const address = uri ?? prepared.manifest?.uri;
+        const carried = address === undefined ? {} : { uri: address };
         if (previous.some(spec => spec.id === draft.id) || (project.extensions || []).includes(draft.id) ||
             Object.hasOwn(project.extensionURLs || {}, draft.id))
             fail('DUPLICATE_EXTENSION', 'This extension ID already belongs to the project', draft.id);
-        validateManifest({ schemaVersion: 1, extensions: [...previous, draft] }, loaderOptions);
+        validateManifest({ schemaVersion: 1, ...carried, extensions: [...previous, draft] }, loaderOptions);
         if (draft.source.type === 'embedded-file' && Object.hasOwn(files, draft.source.path)) {
             fail('SOURCE_PATH_COLLISION', 'The embedded path already exists in this project', draft.id);
         }
@@ -128,7 +133,7 @@ export async function prepareExtensionAddition(input, request, ports, { zip: Zip
         }
         const verified = new Uint8Array(bytes);
         const sha256 = await wait(() => digest(verified));
-        const manifest = validateManifest({ schemaVersion: 1, extensions: [...previous, { ...draft, sha256 }] }, loaderOptions);
+        const manifest = validateManifest({ schemaVersion: 1, ...carried, extensions: [...previous, { ...draft, sha256 }] }, loaderOptions);
         const spec = manifest.extensions.find(item => item.id === draft.id);
         project.turboWarpPlus = manifest;
         project.extensions = [...(project.extensions || []), spec.id];

package/dist/project-catalog.d.ts

@@ -23,6 +23,16 @@ export interface CatalogOptions {
     signal?: AbortSignal;
     loaderOptions?: LoaderOptions;
     archiveOptions?: ArchiveLimits;
+    /**
+     * The address to give this project, or nothing to keep the one it has.
+     *
+     * Whether to assign one is the host's call, not this function's: only the host knows whether
+     * the author chose an address or whether this is a first save that needs a default. So this
+     * sets what it is given and leaves the existing address alone when it is given nothing —
+     * `readProjectAuthoringState` reports what a project already carries, so the host can tell
+     * the two apart before deciding.
+     */
+    uri?: string;
 }
 export type CatalogPorts = Pick<LoaderPorts, 'fetcher' | 'trustProvider' | 'cache' | 'diagnostics'>;
 /** Read project-owned distribution requests; these records never grant execution permission. */

package/dist/project-catalog.js

@@ -19,7 +19,7 @@ export async function readProjectAuthoringState(input, { zip, signal, archiveOpt
     const prepared = await io.prepare(input, { signal });
     return prepared.manifest;
 }
-export async function prepareCatalogExtensionChanges(input, requests, ports, { zip: Zip, signal: externalSignal, loaderOptions = {}, archiveOptions } = {}) {
+export async function prepareCatalogExtensionChanges(input, requests, ports, { zip: Zip, signal: externalSignal, loaderOptions = {}, archiveOptions, uri } = {}) {
     const limits = { ...DEFAULT_LOADER_LIMITS, ...loaderOptions };
     for (const key of ['maxExtensions', 'maxBytes', 'maxTotalBytes', 'timeoutMs']) {
         if (!Number.isSafeInteger(limits[key]) || limits[key] < 1)
@@ -173,7 +173,13 @@ export async function prepareCatalogExtensionChanges(input, requests, ports, { z
                 ...(old?.publisher ? { publisher: old.publisher } : {}),
                 capabilities: old?.capabilities || [], dependencies: choice.dependencies });
         }
-        const manifest = validateManifest({ schemaVersion: 1, extensions: [...extensions.values()] }, loaderOptions);
+        // The project's own address survives a change to its extensions. Rebuilding the manifest
+        // without it would file the same work under a new name the next time it was saved, which
+        // is the one thing an address is for.
+        const address = uri ?? prepared.manifest?.uri;
+        const manifest = validateManifest({ schemaVersion: 1,
+            ...(address === undefined ? {} : { uri: address }),
+            extensions: [...extensions.values()] }, loaderOptions);
         for (const spec of manifest.extensions)
             if (spec.source.type === 'embedded-file')
                 replacedPaths.delete(spec.source.path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubohiroya/turbowarp-extension-loader",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Host-independent verified TurboWarp Plus extension loading core",
   "keywords": [
     "turbowarp",