@rohal12/twee-ts 1.18.0 → 1.18.2

package/dist/index.d.cts

@@ -158,8 +158,9 @@ interface Story {
   twine1: Twine1Metadata;
   twine2: Twine2Metadata;
 }
-type ReadonlyPassage = Readonly<Passage> & {
+type ReadonlyPassage = Readonly<Omit<Passage, 'tags' | 'metadata'>> & {
   readonly tags: readonly string[];
+  readonly metadata?: Readonly<PassageMetadata>;
 };
 type ReadonlyStory = Readonly<Omit<Story, 'passages' | 'twine1' | 'twine2'>> & {
   readonly passages: readonly ReadonlyPassage[];
@@ -582,7 +583,7 @@ export declare const CONFIG_FILENAME = "twee-ts.config.json";
  *
  * @param diagnostics Receives warnings that do not stop the config from loading: keys the config does not
  *   define, and a file that is not valid UTF-8 (it is read as Windows-1252).
- * @throws When the file is not valid JSON or fails {@link validateConfig}.
+ * @throws When the file exists but cannot be read, is not valid JSON or fails {@link validateConfig}.
  */
 export declare function loadConfig(dir?: string, diagnostics?: Diagnostic[]): TweeTsConfig | null;
 /**
@@ -613,8 +614,10 @@ export declare function scaffoldConfig(): string;
 /** Get the cache directory for downloaded story formats. */
 export declare function getCacheDir(): string;
 /**
- * Download a format, verify its checksum, write it to the cache shared by name and version, and
- * return its StoryFormatInfo. Concurrent calls for one download URL share one request.
+ * Download a format, verify its checksum, check that it is the format the entry names, write it to
+ * the cache shared by name and version, and return its StoryFormatInfo. Concurrent calls for one
+ * download URL share one request for the bytes; each call then verifies them against its own
+ * entry, within its own timeout.
  */
 export declare function fetchAndCacheFormat(entry: SFAIndexEntry, downloadUrl: string, options?: RemoteFetchOptions): Promise<StoryFormatInfo>;
 /**

package/dist/index.d.ts

@@ -158,8 +158,9 @@ interface Story {
   twine1: Twine1Metadata;
   twine2: Twine2Metadata;
 }
-type ReadonlyPassage = Readonly<Passage> & {
+type ReadonlyPassage = Readonly<Omit<Passage, 'tags' | 'metadata'>> & {
   readonly tags: readonly string[];
+  readonly metadata?: Readonly<PassageMetadata>;
 };
 type ReadonlyStory = Readonly<Omit<Story, 'passages' | 'twine1' | 'twine2'>> & {
   readonly passages: readonly ReadonlyPassage[];
@@ -582,7 +583,7 @@ export declare const CONFIG_FILENAME = "twee-ts.config.json";
  *
  * @param diagnostics Receives warnings that do not stop the config from loading: keys the config does not
  *   define, and a file that is not valid UTF-8 (it is read as Windows-1252).
- * @throws When the file is not valid JSON or fails {@link validateConfig}.
+ * @throws When the file exists but cannot be read, is not valid JSON or fails {@link validateConfig}.
  */
 export declare function loadConfig(dir?: string, diagnostics?: Diagnostic[]): TweeTsConfig | null;
 /**
@@ -613,8 +614,10 @@ export declare function scaffoldConfig(): string;
 /** Get the cache directory for downloaded story formats. */
 export declare function getCacheDir(): string;
 /**
- * Download a format, verify its checksum, write it to the cache shared by name and version, and
- * return its StoryFormatInfo. Concurrent calls for one download URL share one request.
+ * Download a format, verify its checksum, check that it is the format the entry names, write it to
+ * the cache shared by name and version, and return its StoryFormatInfo. Concurrent calls for one
+ * download URL share one request for the bytes; each call then verifies them against its own
+ * entry, within its own timeout.
  */
 export declare function fetchAndCacheFormat(entry: SFAIndexEntry, downloadUrl: string, options?: RemoteFetchOptions): Promise<StoryFormatInfo>;
 /**