nitro-patcher 0.1.0 → 0.2.1

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;
@@ -6,7 +22,7 @@ export interface BrowserPatchOptions {
 }
 export interface BrowserPatchResult {
     buffer: Uint8Array<ArrayBuffer>;
-    returnValue: 'SUCCESS' | 'MD5_MISMATCH';
+    returnValue: "SUCCESS" | "MD5_MISMATCH";
     inputMd5: string;
     outputMd5: string;
 }
@@ -26,8 +42,20 @@ 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;
+/** Extract one file from a ZIP archive entirely in memory. */
+export declare const extractZipEntry: (archive: Uint8Array, entryName: string, options?: BrowserPatchOptions) => Uint8Array<ArrayBuffer>;
 export declare const PatchHelper: Readonly<{
+    extractZipEntry: (archive: Uint8Array, entryName: string, options?: BrowserPatchOptions) => Uint8Array<ArrayBuffer>;
     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;