-
Notifications
You must be signed in to change notification settings - Fork 332
/
dereferenceObject.ts
203 lines (194 loc) · 6.26 KB
/
dereferenceObject.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
import JsonPointer from 'json-pointer';
import urlJoin from 'url-join';
import { handleUntitledDefinitions } from './healUntitledDefinitions.js';
export const resolvePath = (path: string, root: any): any => {
try {
return JsonPointer.get(root, path);
} catch (e) {
if (e.message?.startsWith('Invalid reference')) {
return undefined;
}
throw e;
}
};
function isUrl(str: string): boolean {
return /^https?:\/\//.test(str);
}
function isRefObject(obj: any): obj is { $ref: string } {
return typeof obj === 'object' && typeof obj.$ref === 'string';
}
const getAbsolute$Ref = (given$ref: string, baseFilePath: string) => {
const [givenExternalFileRelativePath, givenRefPath] = given$ref.split('#');
if (givenExternalFileRelativePath) {
const cwd = getCwd(baseFilePath);
const givenExternalFilePath = getAbsolutePath(givenExternalFileRelativePath, cwd);
if (givenRefPath) {
return `${givenExternalFilePath}#${givenRefPath}`;
}
return givenExternalFilePath;
}
return `${baseFilePath}#${givenRefPath}`;
};
function normalizeUrl(url: string) {
return new URL(url).toString();
}
export function getAbsolutePath(path: string, cwd: string) {
if (isUrl(path)) {
return path;
}
if (isUrl(cwd)) {
return normalizeUrl(urlJoin(cwd, path));
}
if (path.startsWith('/') || path.substring(1).startsWith(':\\')) {
return path;
}
return cwd + '/' + path;
}
export function getCwd(path: string) {
const pathParts = path.split('/');
pathParts.pop();
return pathParts.join('/');
}
export async function dereferenceObject<T extends object, TRoot = T>(
obj: T,
{
cwd = globalThis?.process.cwd(),
externalFileCache = new Map<string, any>(),
refMap = new Map<string, any>(),
root = obj as any,
debugLogFn,
readFileOrUrl,
resolvedObjects = new WeakSet(),
}: {
cwd?: string;
externalFileCache?: Map<string, any>;
refMap?: Map<string, any>;
root?: TRoot;
debugLogFn?(message?: any): void;
readFileOrUrl(path: string, opts: { cwd: string }): Promise<any> | any;
resolvedObjects?: WeakSet<any>;
},
): Promise<T> {
if (obj != null && typeof obj === 'object') {
if (isRefObject(obj)) {
const $ref = obj.$ref;
if (refMap.has($ref)) {
return refMap.get($ref);
} else {
debugLogFn?.(`Resolving ${$ref}`);
const [externalRelativeFilePath, refPath] = $ref.split('#');
if (externalRelativeFilePath) {
const externalFilePath = getAbsolutePath(externalRelativeFilePath, cwd);
const newCwd = getCwd(externalFilePath);
let externalFile = externalFileCache.get(externalFilePath);
if (!externalFile) {
try {
externalFile = await readFileOrUrl(externalFilePath, { cwd });
} catch (e) {
console.error(e);
throw new Error(`Unable to load ${externalRelativeFilePath} from ${cwd}`);
}
externalFileCache.set(externalFilePath, externalFile);
// Title should not be overwritten by the title given from the reference
// Usually Swagger and OpenAPI Schemas have this
handleUntitledDefinitions(externalFile);
}
const result = await dereferenceObject(
refPath
? {
$ref: `#${refPath}`,
}
: externalFile,
{
cwd: newCwd,
externalFileCache,
refMap: new Proxy(refMap, {
get: (originalRefMap, key) => {
switch (key) {
case 'has':
return (given$ref: string) => {
const original$Ref = getAbsolute$Ref(given$ref, externalFilePath);
return originalRefMap.has(original$Ref);
};
case 'get':
return (given$ref: string) => {
const original$Ref = getAbsolute$Ref(given$ref, externalFilePath);
return originalRefMap.get(original$Ref);
};
case 'set':
return (given$ref: string, val: any) => {
const original$Ref = getAbsolute$Ref(given$ref, externalFilePath);
return originalRefMap.set(original$Ref, val);
};
}
throw new Error('Not implemented ' + key.toString());
},
}),
debugLogFn,
readFileOrUrl,
root: externalFile,
resolvedObjects,
},
);
refMap.set($ref, result);
resolvedObjects.add(result);
if (result && !result.$resolvedRef) {
result.$resolvedRef = refPath;
}
if ((obj as any).title && !result.title) {
result.title = (obj as any).title;
}
return result;
} else {
const resolvedObj = resolvePath(refPath, root);
if (resolvedObjects.has(resolvedObj)) {
refMap.set($ref, resolvedObj);
return resolvedObj;
}
/*
if (resolvedObj && !resolvedObj.$resolvedRef) {
resolvedObj.$resolvedRef = refPath;
}
*/
const result = await dereferenceObject(resolvedObj, {
cwd,
externalFileCache,
refMap,
root,
debugLogFn,
readFileOrUrl,
resolvedObjects,
});
if (!result) {
return obj;
}
resolvedObjects.add(result);
refMap.set($ref, result);
if (!result.$resolvedRef) {
result.$resolvedRef = refPath;
}
return result;
}
}
} else {
if (!resolvedObjects.has(obj)) {
resolvedObjects.add(obj);
for (const key in obj) {
const val = obj[key];
if (typeof val === 'object') {
obj[key] = await dereferenceObject<any>(val, {
cwd,
externalFileCache,
refMap,
root,
debugLogFn,
readFileOrUrl,
resolvedObjects,
});
}
}
}
}
}
return obj;
}