nitro-patcher 0.1.0 → 0.2.0

package/README.md

@@ -4,6 +4,8 @@
 
 运行环境：Node.js 22 或更高版本。
 
+完整的使用说明：<https://github.com/Xzonn/nitro-patcher/wiki>。
+
 ## 安装与 CLI
 
 ```sh

package/dist/browser.d.ts

@@ -1,3 +1,19 @@
+export interface PatchMetadata {
+    id?: string;
+    author?: string;
+    name?: string;
+    homepage?: string;
+    version?: string;
+    isBeta?: boolean;
+}
+export interface PatchReadme {
+    format: 'markdown' | 'plaintext';
+    content: string;
+}
+export interface PatchInfo {
+    metadata: PatchMetadata | null;
+    readme: PatchReadme | null;
+}
 export interface BrowserPatchOptions {
     maxOutputSize?: number;
     maxWindowSize?: number;
@@ -26,8 +42,17 @@ export interface RomInfo {
 export declare const inspectRom: (bytes: Uint8Array) => RomInfo;
 /** Synchronous CPU work; call in a Web Worker for responsive browser UIs. */
 export declare const patchBuffer: (original: Uint8Array, archive: Uint8Array, options?: BrowserPatchOptions) => BrowserPatchResult;
+/** Read and validate metadata.json from a patch package entirely in memory. */
+export declare const readPatchMetadata: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchMetadata | null;
+/** Read a root README.md or README.txt from a patch package entirely in memory. */
+export declare const readPatchReadme: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchReadme | null;
+/** Read metadata and README content while parsing the patch package only once. */
+export declare const readPatchInfo: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchInfo;
 export declare const PatchHelper: Readonly<{
     patchBuffer: (original: Uint8Array, archive: Uint8Array, options?: BrowserPatchOptions) => BrowserPatchResult;
+    readPatchInfo: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchInfo;
+    readPatchMetadata: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchMetadata | null;
+    readPatchReadme: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchReadme | null;
 }>;
 export declare const NitroHelper: Readonly<{
     inspectRom: (bytes: Uint8Array) => RomInfo;

package/dist/browser.js

@@ -4531,6 +4531,65 @@ var PatchReturnValue = Object.freeze({
   MD5_MISMATCH: "MD5_MISMATCH"
 });
 var md52 = (data) => hashDigest("md5", data).toString("hex");
+var invalidMetadata = (message) => {
+  console.warn(`\u5FFD\u7565 metadata.json\uFF1A${message}`);
+  return null;
+};
+var invalidMetadataField = (field2, message) => {
+  console.warn(`\u5FFD\u7565 metadata.json \u7684 ${field2}\uFF1A${message}`);
+};
+var readMetadata = (files) => {
+  const file = files.get("metadata.json");
+  if (!file) return null;
+  let metadata;
+  try {
+    metadata = JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(file));
+  } catch (error) {
+    return invalidMetadata(
+      `\u683C\u5F0F\u9519\u8BEF\uFF0C\u53EF\u80FD\u662F\u56E0\u4E3A\u8865\u4E01\u5305\u5DF2\u635F\u574F\uFF1A${error instanceof Error ? error.message : String(error)}`
+    );
+  }
+  if (!metadata || typeof metadata !== "object" || Array.isArray(metadata))
+    return invalidMetadata("\u6839\u8282\u70B9\u5FC5\u987B\u662F\u5BF9\u8C61\u3002");
+  const value = metadata;
+  const result = {};
+  for (const field2 of ["id", "author", "name", "homepage", "version"]) {
+    if (typeof value[field2] === "string") result[field2] = value[field2];
+    else invalidMetadataField(field2, "\u5FC5\u987B\u662F\u5B57\u7B26\u4E32\u3002");
+  }
+  if (typeof value.isBeta === "boolean") result.isBeta = value.isBeta;
+  else invalidMetadataField("isBeta", "\u5FC5\u987B\u662F\u5E03\u5C14\u503C\u3002");
+  return result;
+};
+var readReadme = (files) => {
+  for (const [filename2, format] of [
+    ["README.md", "markdown"],
+    ["README.txt", "plaintext"]
+  ]) {
+    const file = files.get(filename2.toLowerCase());
+    if (!file) continue;
+    try {
+      return {
+        format,
+        content: new TextDecoder("utf-8", { fatal: true }).decode(file)
+      };
+    } catch (error) {
+      console.warn(
+        `\u5FFD\u7565 ${filename2}\uFF1A\u4E0D\u662F\u6709\u6548\u7684 UTF-8 \u6587\u672C\uFF1A${error instanceof Error ? error.message : String(error)}`
+      );
+    }
+  }
+  return null;
+};
+var readPatchMetadata = (patch, options = {}) => readMetadata(readZip(patch, options));
+var readPatchReadme = (patch, options = {}) => readReadme(readZip(patch, options));
+var readPatchInfo = (patch, options = {}) => {
+  const files = readZip(patch, options);
+  return { metadata: readMetadata(files), readme: readReadme(files) };
+};
+var readPatchMetadataFile = async (patchPath, options = {}) => readPatchMetadata(await readFile(patchPath), options);
+var readPatchReadmeFile = async (patchPath, options = {}) => readPatchReadme(await readFile(patchPath), options);
+var readPatchInfoFile = async (patchPath, options = {}) => readPatchInfo(await readFile(patchPath), options);
 var patchBuffer = (original, patch, options = {}) => {
   const input = bytes(original, "original ROM");
   const patches = readZip(patch, options);
@@ -4572,7 +4631,16 @@ var patchIt = async (originalPath, patchPath, options = {}) => {
   const [original, patch] = await Promise.all([readFile(originalPath), readFile(patchPath)]);
   return patchBuffer(original, patch, options);
 };
-var PatchHelper = Object.freeze({ patchBuffer, patchIt });
+var PatchHelper = Object.freeze({
+  patchBuffer,
+  patchIt,
+  readPatchInfo,
+  readPatchInfoFile,
+  readPatchMetadata,
+  readPatchMetadataFile,
+  readPatchReadme,
+  readPatchReadmeFile
+});
 
 // src/browser.ts
 var inspectRom = (bytes2) => {
@@ -4604,13 +4672,24 @@ var patchBuffer2 = (original, archive, options = {}) => {
     outputMd5: result.outputMd5
   };
 };
-var PatchHelper2 = Object.freeze({ patchBuffer: patchBuffer2 });
+var readPatchMetadata2 = (archive, options = {}) => readPatchMetadata(archive, options);
+var readPatchReadme2 = (archive, options = {}) => readPatchReadme(archive, options);
+var readPatchInfo2 = (archive, options = {}) => readPatchInfo(archive, options);
+var PatchHelper2 = Object.freeze({
+  patchBuffer: patchBuffer2,
+  readPatchInfo: readPatchInfo2,
+  readPatchMetadata: readPatchMetadata2,
+  readPatchReadme: readPatchReadme2
+});
 var NitroHelper = Object.freeze({ inspectRom });
 export {
   NitroHelper,
   PatchHelper2 as PatchHelper,
   inspectRom,
-  patchBuffer2 as patchBuffer
+  patchBuffer2 as patchBuffer,
+  readPatchInfo2 as readPatchInfo,
+  readPatchMetadata2 as readPatchMetadata,
+  readPatchReadme2 as readPatchReadme
 };
 /*! For license information please see browser.js.LEGAL.txt */
 //# sourceMappingURL=browser.js.map