forked from dmitmel/ultimate-crosscode-typedefs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
patch-steps-lib.d.ts
255 lines (213 loc) · 5.9 KB
/
patch-steps-lib.d.ts
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
export const version: string;
export type PatchFile = AnyPatchStep[] | Record<string, unknown>;
export type Index = string | number;
export interface BasePatchStep {
comment?: string;
}
export namespace PatchStep {
export interface ENTER extends BasePatchStep {
type: 'ENTER';
index: Index | Index[];
}
export interface EXIT extends BasePatchStep {
type: 'EXIT';
count?: number;
}
export interface SET_KEY extends BasePatchStep {
type: 'SET_KEY';
index: Index;
content?: unknown;
}
export interface INIT_KEY extends BasePatchStep {
type: 'INIT_KEY';
index: Index;
content: unknown;
}
export interface REMOVE_ARRAY_ELEMENT extends BasePatchStep {
type: 'REMOVE_ARRAY_ELEMENT';
index: number;
}
export interface ADD_ARRAY_ELEMENT extends BasePatchStep {
type: 'ADD_ARRAY_ELEMENT';
index?: number;
content: unknown;
}
export interface IMPORT extends BasePatchStep {
type: 'IMPORT';
src: string;
path?: Index[];
index?: Index;
}
export interface INCLUDE extends BasePatchStep {
type: 'INCLUDE';
src: string;
}
export interface FOR_IN extends BasePatchStep {
type: 'FOR_IN';
values: unknown[] | Array<Record<string, unknown>>;
keyword: string | Record<string, string>;
body: AnyPatchStep[];
}
export interface COPY extends BasePatchStep {
type: 'COPY';
alias: string;
}
export interface PASTE extends BasePatchStep {
type: 'PASTE';
alias: string;
index?: Index;
}
export interface COMMENT extends BasePatchStep {
type: 'COMMENT';
value: unknown;
}
export interface DEBUG extends BasePatchStep {
type: 'DEBUG';
value: boolean;
}
export interface MERGE_CONTENT extends BasePatchStep {
type: 'MERGE_CONTENT';
content: unknown;
}
export interface CALL extends BasePatchStep {
type: 'CALL';
id: string;
args: unknown;
}
export interface CUSTOM extends BasePatchStep {
type: string;
[key: string]: any;
}
}
// This is expressed with an interface so that mods can define their own
// patching steps.
export interface PatchStepsRegistry {
ENTER: PatchStep.ENTER;
EXIT: PatchStep.EXIT;
SET_KEY: PatchStep.SET_KEY;
INIT_KEY: PatchStep.INIT_KEY;
REMOVE_ARRAY_ELEMENT: PatchStep.REMOVE_ARRAY_ELEMENT;
ADD_ARRAY_ELEMENT: PatchStep.ADD_ARRAY_ELEMENT;
IMPORT: PatchStep.IMPORT;
INCLUDE: PatchStep.INCLUDE;
FOR_IN: PatchStep.FOR_IN;
COPY: PatchStep.COPY;
PASTE: PatchStep.PASTE;
COMMENT: PatchStep.COMMENT;
DEBUG: PatchStep.DEBUG;
[name: string]: PatchStep.CUSTOM;
}
export type AnyPatchStep = Extract<PatchStepsRegistry[keyof PatchStepsRegistry], BasePatchStep>;
export function photomerge<A = unknown, B = A>(a: A, b: B): A & B;
export function photocopy<O = unknown>(o: O): O;
export function diff(
a: unknown,
b: unknown,
settings: Partial<DiffSettings>,
): AnyPatchStep[] | null;
export interface DiffSettings {
arrayTrulyDifferentThreshold: number;
trulyDifferentThreshold: number;
arrayLookahead: number;
diffAddNewKey: number;
diffAddDelKey: number;
diffMulSameKey: number;
diffCore: DiffCore;
comment?: string;
commentValue?: string;
path: Index[];
optimize: boolean;
}
export type DiffCore = (a: unknown, b: unknown, settings: DiffSettings) => AnyPatchStep[] | null;
export function diffApplyComment<T extends BasePatchStep>(step: T, settings: DiffSettings): T;
export function diffEnterLevel(
a: unknown,
b: unknown,
index: Index,
settings: DiffSettings,
): AnyPatchStep[] | null;
export type ParsedPath = null | [/* fromGame */ boolean | string, /* url */ string];
export interface FileInfo {
path: string;
stack: StackEntry[];
}
export type StackEntry = StackEntry.Step | StackEntry.Error;
export namespace StackEntry {
export interface Step {
type: 'Step';
index: Index;
name: string;
}
export interface Error {
type: 'Error';
errorType: string;
errorMessage: string;
}
}
export class DebugState {
fileStack: Array<FileInfo | null>;
currentFile: FileInfo | null;
translateParsedPath(parsedPath: ParsedPath | null): string;
/** @final */
addFile(parsedPath: ParsedPath): void;
/** @final */
removeLastFile(): FileInfo;
/** @final */
addStep(index: Index, name?: string, functionName?: string): void;
/** @final */
removeLastStep(): FileInfo;
/** @final */
getLastStep(): StackEntry.Step;
/** @final */
throwError(type: string, message: string): void;
printFileInfo(file: FileInfo): void;
/** @final */
print(): void;
beforeStep(): Promise<void>;
afterStep(): Promise<void>;
}
export class StepMachine {
steps: AnyPatchStep[];
si: number;
finished: boolean;
run(): Iterator<[number, AnyPatchStep]>;
addSteps(newSteps: AnyPatchStep[] | AnyPatchStep): void;
exit(): void;
gotoLabel(labelName: string): boolean;
setStepIndex(newStepIndex: number): boolean;
getCurrentStep(): AnyPatchStep;
getStepIndex(): number;
findLabelIndex(labelName: string): number;
}
export const appliers: Record<string, Applier>;
export type Applier = (this: StackEntry.Step, state: ApplierState) => Promise<void>;
interface CallstackItem {
returnIndex: number;
functionName: string;
oldReferenceIndex: number;
}
export interface ApplierState {
currentValue: unknown;
stack: StackEntry[];
stepMachine: StepMachine;
cloneMap: Map<string, unknown>;
loader: Loader;
debugState: DebugState;
debug: boolean;
memory: {
callstack: Array<CallstackItem>;
};
functionName: string;
stepReferenceIndex: number;
}
export function patch(
a: unknown,
steps: PatchFile,
loader: Loader,
debugState?: DebugState,
): Promise<void>;
type Loader = (fromGame: boolean | string, path: string) => Promise<unknown>;
export namespace callable {
export type Callable<T> = (state: ApplierState, args: T extends object ? T : unknown) => void | Promise<void>;
export function register<T>(id: string, callable: Callable<T>): void;
}