nitro-patcher 0.3.0 → 1.1.0

package/dist/browser.d.ts

@@ -1,4 +1,5 @@
 export interface PatchMetadata {
+    formatVersion?: number;
     id?: string;
     author?: string;
     name?: string;
@@ -20,11 +21,39 @@ export interface BrowserPatchOptions {
     maxUncompressedSize?: number;
     maxEntries?: number;
 }
+export interface CreatePatchOptions extends BrowserPatchOptions {
+    metadata?: Omit<PatchMetadata, "formatVersion">;
+    readme?: string;
+}
+export interface CreatePatchResult {
+    buffer: Uint8Array<ArrayBuffer>;
+    changedFiles: number;
+    warnings: string[];
+}
+/** Create an in-memory XZP with diagnostic warnings. Call in a Web Worker. */
+export declare const createPatch: (original: Uint8Array, modified: Uint8Array, options?: CreatePatchOptions) => Promise<CreatePatchResult>;
+export interface DsiCheck {
+    status: "valid" | "invalid" | "not-applicable";
+    reason?: string;
+}
+export interface DsiVerification {
+    arm9: DsiCheck;
+    arm7: DsiCheck;
+    arm9i: DsiCheck;
+    arm7i: DsiCheck;
+    arm9NoSecure: DsiCheck;
+    banner: DsiCheck;
+    sectors: DsiCheck;
+    blocks: DsiCheck;
+    master: DsiCheck;
+    signature: DsiCheck;
+}
 export interface BrowserPatchResult {
     buffer: Uint8Array<ArrayBuffer>;
     returnValue: "SUCCESS" | "MD5_MISMATCH";
     inputMd5: string;
     outputMd5: string;
+    dsi?: DsiVerification;
 }
 export interface RomInfo {
     gameTitle: string;
@@ -37,9 +66,12 @@ export interface RomInfo {
         secureArea: boolean;
         banner: boolean;
     };
+    dsi?: DsiVerification;
 }
 /** Parse ROM metadata entirely in memory. No filesystem or Node types required. */
-export declare const inspectRom: (bytes: Uint8Array) => RomInfo;
+export declare const inspectRom: (bytes: Uint8Array, options?: {
+    dsiMode?: "legacy" | "complete";
+}) => 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. */
@@ -51,6 +83,7 @@ export declare const readPatchInfo: (archive: Uint8Array, options?: BrowserPatch
 /** 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<{
+    createPatch: (original: Uint8Array, modified: Uint8Array, options?: CreatePatchOptions) => Promise<CreatePatchResult>;
     extractZipEntry: (archive: Uint8Array, entryName: string, options?: BrowserPatchOptions) => Uint8Array<ArrayBuffer>;
     patchBuffer: (original: Uint8Array, archive: Uint8Array, options?: BrowserPatchOptions) => BrowserPatchResult;
     readPatchInfo: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchInfo;
@@ -58,5 +91,7 @@ export declare const PatchHelper: Readonly<{
     readPatchReadme: (archive: Uint8Array, options?: BrowserPatchOptions) => PatchReadme | null;
 }>;
 export declare const NitroHelper: Readonly<{
-    inspectRom: (bytes: Uint8Array) => RomInfo;
+    inspectRom: (bytes: Uint8Array, options?: {
+        dsiMode?: "legacy" | "complete";
+    }) => RomInfo;
 }>;