node-hdiffpatch/index.d.ts at main · reactnativecn/node-hdiffpatch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
/// <reference types="node" />

/** Buffer、TypedArray 和 DataView 均可作为二进制输入。 */
export type BinaryLike = Buffer | ArrayBufferView;

export type DiffCallback = (err: Error | null, result?: Buffer) => void;
export type StreamCallback = (err: Error | null, outPath?: string) => void;

export interface CompressionOptions {
  /** LZMA2 compression workers. Level 9 and the 8 MiB dictionary are unchanged. */
  compressionThreads?: 1 | 2;
}

export interface DiffWindowOptions extends CompressionOptions {
  /** Old-data sliding window bytes; 0 uses the native 2 MiB default. */
  windowSize?: number;
}

/**
 * patch 侧资源上限。补丁头声明的输出大小和工作内存来自不可信输入,
 * 超出上限的补丁在任何分配或输出文件创建之前被拒绝。
 */
export interface PatchOptions {
  /**
   * 允许的最大输出字节数。默认:内存版 patch() 2 GiB,文件版
   * patchStream()/patchSingleStream() 16 GiB。
   */
  maxOutputBytes?: number;
  /** 允许的最大补丁工作内存(stepMemSize)字节数。默认 256 MiB。 */
  maxWorkingMemoryBytes?: number;
}

export interface NativeAddon {
  diff(oldBuf: BinaryLike, newBuf: BinaryLike): Buffer;
  diff(oldBuf: BinaryLike, newBuf: BinaryLike, options: CompressionOptions): Buffer;
  diff(oldBuf: BinaryLike, newBuf: BinaryLike, cb: DiffCallback): void;
  diff(
    oldBuf: BinaryLike,
    newBuf: BinaryLike,
    options: CompressionOptions,
    cb: DiffCallback
  ): void;
  patch(oldBuf: BinaryLike, diffBuf: BinaryLike): Buffer;
  patch(oldBuf: BinaryLike, diffBuf: BinaryLike, options: PatchOptions): Buffer;
  patch(oldBuf: BinaryLike, diffBuf: BinaryLike, cb: DiffCallback): void;
  patch(
    oldBuf: BinaryLike,
    diffBuf: BinaryLike,
    options: PatchOptions,
    cb: DiffCallback
  ): void;
  diffStream(oldPath: string, newPath: string, outDiffPath: string): string;
  diffStream(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    options: CompressionOptions
  ): string;
  diffStream(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    cb: StreamCallback
  ): void;
  diffStream(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    options: CompressionOptions,
    cb: StreamCallback
  ): void;
  patchStream(oldPath: string, diffPath: string, outNewPath: string): string;
  patchStream(
    oldPath: string,
    diffPath: string,
    outNewPath: string,
    options: PatchOptions
  ): string;
  patchStream(
    oldPath: string,
    diffPath: string,
    outNewPath: string,
    cb: StreamCallback
  ): void;
  patchStream(
    oldPath: string,
    diffPath: string,
    outNewPath: string,
    options: PatchOptions,
    cb: StreamCallback
  ): void;
  diffSingleStream(oldPath: string, newPath: string, outDiffPath: string): string;
  diffSingleStream(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    options: CompressionOptions
  ): string;
  diffSingleStream(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    cb: StreamCallback,
  ): void;
  diffSingleStream(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    options: CompressionOptions,
    cb: StreamCallback,
  ): void;
  patchSingleStream(oldPath: string, diffPath: string, outNewPath: string): string;
  patchSingleStream(
    oldPath: string,
    diffPath: string,
    outNewPath: string,
    options: PatchOptions
  ): string;
  patchSingleStream(
    oldPath: string,
    diffPath: string,
    outNewPath: string,
    cb: StreamCallback
  ): void;
  patchSingleStream(
    oldPath: string,
    diffPath: string,
    outNewPath: string,
    options: PatchOptions,
    cb: StreamCallback
  ): void;
  diffWindow(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    windowSize?: number
  ): string;
  diffWindow(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    options: DiffWindowOptions
  ): string;
  diffWindow(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    cb: StreamCallback
  ): void;
  diffWindow(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    options: DiffWindowOptions,
    cb: StreamCallback
  ): void;
  diffWindow(
    oldPath: string,
    newPath: string,
    outDiffPath: string,
    windowSize: number,
    cb: StreamCallback
  ): void;
}

export const native: NativeAddon;

export interface HdiffpatchCapabilities {
  readonly diffStreamVerifiesOutput: true;
  readonly diffSingleStreamVerifiesOutput: true;
  readonly diffWindowVerifiesOutput: true;
  readonly maxCompressionThreads: 2;
}

/** Native diff functions apply and compare their output before returning. */
export const capabilities: HdiffpatchCapabilities;

export function diff(oldBuf: BinaryLike, newBuf: BinaryLike): Buffer;
export function diff(
  oldBuf: BinaryLike,
  newBuf: BinaryLike,
  options: CompressionOptions
): Buffer;
export function diff(
  oldBuf: BinaryLike,
  newBuf: BinaryLike,
  cb: DiffCallback
): void;
export function diff(
  oldBuf: BinaryLike,
  newBuf: BinaryLike,
  options: CompressionOptions,
  cb: DiffCallback
): void;

export function patch(oldBuf: BinaryLike, diffBuf: BinaryLike): Buffer;
export function patch(
  oldBuf: BinaryLike,
  diffBuf: BinaryLike,
  options: PatchOptions
): Buffer;
export function patch(
  oldBuf: BinaryLike,
  diffBuf: BinaryLike,
  cb: DiffCallback
): void;
export function patch(
  oldBuf: BinaryLike,
  diffBuf: BinaryLike,
  options: PatchOptions,
  cb: DiffCallback
): void;

export function diffStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string
): string;
export function diffStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  options: CompressionOptions
): string;
export function diffStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  cb: StreamCallback
): void;
export function diffStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  options: CompressionOptions,
  cb: StreamCallback
): void;

export function patchStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string
): string;
export function patchStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string,
  options: PatchOptions
): string;
export function patchStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string,
  cb: StreamCallback
): void;
export function patchStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string,
  options: PatchOptions,
  cb: StreamCallback
): void;
export function diffSingleStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
): string;
export function diffSingleStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  options: CompressionOptions,
): string;
export function diffSingleStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  cb: StreamCallback,
): void;
export function diffSingleStream(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  options: CompressionOptions,
  cb: StreamCallback,
): void;
export function patchSingleStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string
): string;
export function patchSingleStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string,
  options: PatchOptions
): string;
export function patchSingleStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string,
  cb: StreamCallback
): void;
export function patchSingleStream(
  oldPath: string,
  diffPath: string,
  outNewPath: string,
  options: PatchOptions,
  cb: StreamCallback
): void;

// window 模式生成 HDIFFSF20 single 格式 patch:匹配质量接近内存版
// diff(),内存占用保持流式档;产物用 patch()/patchSingleStream() 应用。
// windowSize 为 old 数据滑动窗口字节数(缺省 2MB),调大可捕获更长距离
// 的内容移动,内存占用近似线性增长。
export function diffWindow(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  windowSize?: number
): string;
export function diffWindow(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  options: DiffWindowOptions
): string;
export function diffWindow(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  cb: StreamCallback
): void;
export function diffWindow(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  options: DiffWindowOptions,
  cb: StreamCallback
): void;
export function diffWindow(
  oldPath: string,
  newPath: string,
  outDiffPath: string,
  windowSize: number,
  cb: StreamCallback
): void;

declare const hdiffpatch: {
  native: NativeAddon;
  capabilities: HdiffpatchCapabilities;
  diff: typeof diff;
  patch: typeof patch;
  diffStream: typeof diffStream;
  patchStream: typeof patchStream;
  diffSingleStream: typeof diffSingleStream;
  patchSingleStream: typeof patchSingleStream;
  diffWindow: typeof diffWindow;
};

export default hdiffpatch;