@scalar/workspace-store 0.14.0 → 0.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/dist/client.d.ts +10 -4
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +47 -20
- package/dist/client.js.map +2 -2
- package/dist/plugins.d.ts.map +1 -1
- package/dist/plugins.js +3 -0
- package/dist/plugins.js.map +2 -2
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# @scalar/workspace-store
|
|
2
2
|
|
|
3
|
+
## 0.14.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 443c507: feat: make required: null an empty array
|
|
8
|
+
- Updated dependencies [88385b1]
|
|
9
|
+
- Updated dependencies [50032be]
|
|
10
|
+
- @scalar/json-magic@0.3.1
|
|
11
|
+
- @scalar/types@0.2.13
|
|
12
|
+
- @scalar/openapi-parser@0.20.1
|
|
13
|
+
- @scalar/code-highlight@0.1.9
|
|
14
|
+
|
|
15
|
+
## 0.14.1
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- b8776fc: feat: output validation errors in the console
|
|
20
|
+
|
|
3
21
|
## 0.14.0
|
|
4
22
|
|
|
5
23
|
### Minor Changes
|
package/dist/client.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { TraverseSpecOptions } from './navigation/types.js';
|
|
2
2
|
import { type InMemoryWorkspace } from './schemas/inmemory-workspace.js';
|
|
3
|
-
import type { WorkspaceSpecification } from './schemas/workspace-specification/index.js';
|
|
4
3
|
import type { Workspace, WorkspaceDocumentMeta, WorkspaceMeta } from './schemas/workspace.js';
|
|
5
|
-
import {
|
|
6
|
-
import type {
|
|
4
|
+
import type { WorkspaceSpecification } from './schemas/workspace-specification/index.js';
|
|
5
|
+
import type { Config } from './schemas/workspace-specification/config.js';
|
|
6
|
+
import { type Difference, merge } from '@scalar/json-magic/diff';
|
|
7
7
|
import type { PartialDeep, RequiredDeep } from 'type-fest';
|
|
8
8
|
export type DocumentConfiguration = Config & PartialDeep<{
|
|
9
9
|
'x-scalar-reference-config': {
|
|
@@ -35,6 +35,12 @@ export type DocumentConfiguration = Config & PartialDeep<{
|
|
|
35
35
|
}) => string;
|
|
36
36
|
};
|
|
37
37
|
}>;
|
|
38
|
+
export type ValidationError = {
|
|
39
|
+
message: string;
|
|
40
|
+
path: string;
|
|
41
|
+
schema: unknown;
|
|
42
|
+
value: unknown;
|
|
43
|
+
};
|
|
38
44
|
declare const defaultConfig: RequiredDeep<Config>;
|
|
39
45
|
/**
|
|
40
46
|
* Input type for workspace document metadata and configuration.
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,OAAO,EAAE,KAAK,iBAAiB,EAA2B,MAAM,8BAA8B,CAAA;AAQ9F,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC1F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0CAA0C,CAAA;AAItE,OAAO,EAAE,KAAK,UAAU,EAAe,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAG7E,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAE1D,MAAM,MAAM,qBAAqB,GAAG,MAAM,GACxC,WAAW,CAAC;IACV,2BAA2B,EAAE;QAC3B,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;QAC1C,gBAAgB,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,CAAA;QACzD,YAAY,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAA;QACjD,cAAc,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,CAAA;QACrD,YAAY,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAA;QACjD,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;QAC7C,QAAQ,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAA;QACzC,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,CAAC,EAAE,MAAM,CAAA;YACpB,MAAM,EAAE,MAAM,CAAA;YACd,OAAO,CAAC,EAAE,MAAM,CAAA;SACjB,KAAK,MAAM,CAAA;QACZ,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,MAAM,CAAA;QAC5D,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,MAAM,CAAA;QACxD,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,MAAM,CAAA;QAC1D,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,KAAK,MAAM,CAAA;KAC5E,CAAA;CACF,CAAC,CAAA;AASJ,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,OAAO,CAAA;CACf,CAAA;AAED,QAAA,MAAM,aAAa,EAAE,YAAY,CAAC,MAAM,CAEvC,CAAA;AAED;;;GAGG;AACH,KAAK,0BAA0B,GAAG;IAChC,wEAAwE;IACxE,IAAI,CAAC,EAAE,qBAAqB,CAAA;IAC5B,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B,iCAAiC;IACjC,SAAS,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAA;IAClD,wIAAwI;IACxI,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC5F,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,0BAA0B,CAAA;AAE9B,iGAAiG;AACjG,MAAM,MAAM,SAAS,GAAG;IACtB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,GAAG,0BAA0B,CAAA;AAE9B;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,SAAS,CAAA;AA+CvD;;;GAGG;AACH,KAAK,cAAc,GAAG;IACpB,gFAAgF;IAChF,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,8BAA8B;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,8CAA8C;IAC9C,KAAK,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAA;CACxC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,aAAa,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;IAC5E;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAClD,IAAI,EAAE,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAC9B,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC9B,IAAI,CAAA;IACP;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACzC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,aAAa,CAAA;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IACjF;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,CAAA;IAClE;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D;;;;;;;;;OASG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1C;;;;;;;;;OASG;IACH,eAAe,IAAI,MAAM,CAAA;IACzB;;;;;;;;OAQG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gCAAgC,CAAC,aAAa,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IACxF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,EAAE,CACd,YAAY,EAAE,MAAM,EACpB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,iBAAiB,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,KACtC,IAAI,GAAG,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,WAAW,CAAC,CAAA;CAClD,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,oBAAqB,cAAc,KAAG,cAyftE,CAAA;AAGD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA"}
|
package/dist/client.js
CHANGED
|
@@ -1,26 +1,28 @@
|
|
|
1
|
-
import YAML from "yaml";
|
|
2
|
-
import { reactive } from "vue";
|
|
3
|
-
import { upgrade } from "@scalar/openapi-parser";
|
|
4
1
|
import { createMagicProxy, getRaw } from "@scalar/json-magic/magic-proxy";
|
|
2
|
+
import { upgrade } from "@scalar/openapi-parser";
|
|
3
|
+
import { reactive } from "vue";
|
|
4
|
+
import YAML from "yaml";
|
|
5
5
|
import { applySelectiveUpdates } from "./helpers/apply-selective-updates.js";
|
|
6
|
+
import { deepClone } from "./helpers/deep-clone.js";
|
|
6
7
|
import { isObject, safeAssign } from "./helpers/general.js";
|
|
7
8
|
import { getValueByPath } from "./helpers/json-path-utils.js";
|
|
8
9
|
import { mergeObjects } from "./helpers/merge-object.js";
|
|
10
|
+
import { createOverridesProxy } from "./helpers/overrides-proxy.js";
|
|
9
11
|
import { createNavigation } from "./navigation/index.js";
|
|
12
|
+
import { externalValueResolver, loadingStatus, refsEverywhere, restoreOriginalRefs } from "./plugins.js";
|
|
10
13
|
import { extensions } from "./schemas/extensions.js";
|
|
14
|
+
import { InMemoryWorkspaceSchema } from "./schemas/inmemory-workspace.js";
|
|
15
|
+
import { defaultReferenceConfig } from "./schemas/reference-config/index.js";
|
|
11
16
|
import { coerceValue } from "./schemas/typebox-coerce.js";
|
|
12
|
-
import { OpenAPIDocumentSchema as OpenAPIDocumentSchemaStrict } from "./schemas/v3.1/strict/openapi-document.js";
|
|
13
17
|
import { OpenAPIDocumentSchema as OpenAPIDocumentSchemaLoose } from "./schemas/v3.1/loose/openapi-document.js";
|
|
14
|
-
import {
|
|
15
|
-
|
|
16
|
-
|
|
18
|
+
import {
|
|
19
|
+
OpenAPIDocumentSchema as OpenAPIDocumentSchemaStrict
|
|
20
|
+
} from "./schemas/v3.1/strict/openapi-document.js";
|
|
21
|
+
import { measureAsync, measureSync } from "@scalar/helpers/testing/measure";
|
|
17
22
|
import { bundle } from "@scalar/json-magic/bundle";
|
|
18
23
|
import { fetchUrls } from "@scalar/json-magic/bundle/plugins/browser";
|
|
19
24
|
import { apply, diff, merge } from "@scalar/json-magic/diff";
|
|
20
|
-
import { externalValueResolver, loadingStatus, refsEverywhere, restoreOriginalRefs } from "./plugins.js";
|
|
21
25
|
import { Value } from "@sinclair/typebox/value";
|
|
22
|
-
import { deepClone } from "./helpers/deep-clone.js";
|
|
23
|
-
import { measureAsync, measureSync } from "@scalar/helpers/testing/measure";
|
|
24
26
|
const defaultConfig = {
|
|
25
27
|
"x-scalar-reference-config": defaultReferenceConfig
|
|
26
28
|
};
|
|
@@ -96,11 +98,11 @@ const createWorkspaceStore = (workspaceProps) => {
|
|
|
96
98
|
extraDocumentConfigurations[name] = { fetch: input.fetch };
|
|
97
99
|
}
|
|
98
100
|
});
|
|
99
|
-
const
|
|
100
|
-
if (
|
|
101
|
+
const temporaryDocument = createMagicProxy({ ...inputDocument, ...meta });
|
|
102
|
+
if (temporaryDocument[extensions.document.navigation] === void 0) {
|
|
101
103
|
await measureAsync(
|
|
102
104
|
"bundle",
|
|
103
|
-
async () => await bundle(getRaw(
|
|
105
|
+
async () => await bundle(getRaw(temporaryDocument), {
|
|
104
106
|
treeShake: false,
|
|
105
107
|
plugins: [
|
|
106
108
|
fetchUrls({
|
|
@@ -118,14 +120,22 @@ const createWorkspaceStore = (workspaceProps) => {
|
|
|
118
120
|
);
|
|
119
121
|
const coerced = measureSync(
|
|
120
122
|
"coerceValue",
|
|
121
|
-
() => coerceValue(OpenAPIDocumentSchemaStrict, deepClone(
|
|
123
|
+
() => coerceValue(OpenAPIDocumentSchemaStrict, deepClone(temporaryDocument))
|
|
122
124
|
);
|
|
123
|
-
measureAsync("mergeObjects", async () => mergeObjects(
|
|
125
|
+
measureAsync("mergeObjects", async () => mergeObjects(temporaryDocument, coerced));
|
|
124
126
|
}
|
|
125
|
-
const isValid = Value.Check(OpenAPIDocumentSchemaStrict,
|
|
127
|
+
const isValid = Value.Check(OpenAPIDocumentSchemaStrict, temporaryDocument);
|
|
128
|
+
let errors = null;
|
|
126
129
|
if (!isValid) {
|
|
127
|
-
|
|
130
|
+
const validationErrors = Array.from(Value.Errors(OpenAPIDocumentSchemaStrict, temporaryDocument));
|
|
131
|
+
errors = validationErrors.map((error) => ({
|
|
132
|
+
message: error.message,
|
|
133
|
+
path: error.path,
|
|
134
|
+
schema: error.schema,
|
|
135
|
+
value: error.value
|
|
136
|
+
}));
|
|
128
137
|
}
|
|
138
|
+
const strictDocument = isValid ? temporaryDocument : temporaryDocument;
|
|
129
139
|
if (strictDocument[extensions.document.navigation] === void 0) {
|
|
130
140
|
const showModels = input.config?.["x-scalar-reference-config"]?.features?.showModels;
|
|
131
141
|
strictDocument[extensions.document.navigation] = createNavigation(strictDocument, {
|
|
@@ -134,6 +144,10 @@ const createWorkspaceStore = (workspaceProps) => {
|
|
|
134
144
|
}).entries;
|
|
135
145
|
}
|
|
136
146
|
workspace.documents[name] = createOverridesProxy(strictDocument, input.overrides);
|
|
147
|
+
return {
|
|
148
|
+
errors,
|
|
149
|
+
document: workspace.documents[name]
|
|
150
|
+
};
|
|
137
151
|
}
|
|
138
152
|
async function addDocument(input) {
|
|
139
153
|
const { name, meta } = input;
|
|
@@ -166,7 +180,14 @@ const createWorkspaceStore = (workspaceProps) => {
|
|
|
166
180
|
};
|
|
167
181
|
return;
|
|
168
182
|
}
|
|
169
|
-
|
|
183
|
+
const { errors } = await addInMemoryDocument({
|
|
184
|
+
...input,
|
|
185
|
+
document: resolve.data,
|
|
186
|
+
documentSource: getDocumentSource(input)
|
|
187
|
+
});
|
|
188
|
+
if (errors) {
|
|
189
|
+
console.warn("OpenAPI Document Validation Errors", errors);
|
|
190
|
+
}
|
|
170
191
|
});
|
|
171
192
|
}
|
|
172
193
|
const getDocumentConfiguration = (name) => {
|
|
@@ -198,7 +219,7 @@ const createWorkspaceStore = (workspaceProps) => {
|
|
|
198
219
|
if (!currentDocument) {
|
|
199
220
|
return console.error(`Document '${documentName}' does not exist in the workspace.`);
|
|
200
221
|
}
|
|
201
|
-
await addInMemoryDocument({
|
|
222
|
+
const { errors } = await addInMemoryDocument({
|
|
202
223
|
name: documentName,
|
|
203
224
|
document: input,
|
|
204
225
|
// Preserve the current metadata
|
|
@@ -208,6 +229,9 @@ const createWorkspaceStore = (workspaceProps) => {
|
|
|
208
229
|
},
|
|
209
230
|
initialize: false
|
|
210
231
|
});
|
|
232
|
+
if (errors) {
|
|
233
|
+
console.warn("OpenAPI Document Validation Errors", errors);
|
|
234
|
+
}
|
|
211
235
|
},
|
|
212
236
|
resolve: async (path) => {
|
|
213
237
|
const activeDocument = workspace.activeDocument;
|
|
@@ -247,11 +271,14 @@ const createWorkspaceStore = (workspaceProps) => {
|
|
|
247
271
|
if (!workspaceDocument || !intermediate) {
|
|
248
272
|
return;
|
|
249
273
|
}
|
|
250
|
-
await addInMemoryDocument({
|
|
274
|
+
const { errors } = await addInMemoryDocument({
|
|
251
275
|
name: documentName,
|
|
252
276
|
document: intermediate,
|
|
253
277
|
initialize: false
|
|
254
278
|
});
|
|
279
|
+
if (errors) {
|
|
280
|
+
console.warn("OpenAPI Document Validation Errors", errors);
|
|
281
|
+
}
|
|
255
282
|
},
|
|
256
283
|
commitDocument(documentName) {
|
|
257
284
|
console.warn(`Commit operation for document '${documentName}' is not implemented yet.`);
|
package/dist/client.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/client.ts"],
|
|
4
|
-
"sourcesContent": ["import YAML from 'yaml'\nimport { reactive } from 'vue'\nimport { upgrade } from '@scalar/openapi-parser'\nimport { createMagicProxy, getRaw } from '@scalar/json-magic/magic-proxy'\n\nimport { applySelectiveUpdates } from '@/helpers/apply-selective-updates'\nimport { isObject, safeAssign, type UnknownObject } from '@/helpers/general'\nimport { getValueByPath } from '@/helpers/json-path-utils'\nimport { mergeObjects } from '@/helpers/merge-object'\nimport { createNavigation } from '@/navigation'\nimport { extensions } from '@/schemas/extensions'\nimport { coerceValue } from '@/schemas/typebox-coerce'\nimport { OpenAPIDocumentSchema as OpenAPIDocumentSchemaStrict } from '@/schemas/v3.1/strict/openapi-document'\nimport { OpenAPIDocumentSchema as OpenAPIDocumentSchemaLoose } from '@/schemas/v3.1/loose/openapi-document'\nimport { defaultReferenceConfig } from '@/schemas/reference-config'\nimport type { Config } from '@/schemas/workspace-specification/config'\nimport { InMemoryWorkspaceSchema, type InMemoryWorkspace } from '@/schemas/inmemory-workspace'\nimport type { WorkspaceSpecification } from '@/schemas/workspace-specification'\nimport { createOverridesProxy } from '@/helpers/overrides-proxy'\nimport type { Workspace, WorkspaceDocumentMeta, WorkspaceMeta } from '@/schemas/workspace'\nimport { bundle } from '@scalar/json-magic/bundle'\nimport { fetchUrls } from '@scalar/json-magic/bundle/plugins/browser'\nimport { apply, diff, merge, type Difference } from '@scalar/json-magic/diff'\nimport type { TraverseSpecOptions } from '@/navigation/types'\nimport type { PartialDeep, RequiredDeep } from 'type-fest'\nimport { externalValueResolver, loadingStatus, refsEverywhere, restoreOriginalRefs } from '@/plugins'\nimport type { Record } from '@sinclair/typebox'\nimport { Value } from '@sinclair/typebox/value'\nimport { deepClone } from '@/helpers/deep-clone'\nimport { measureAsync, measureSync } from '@scalar/helpers/testing/measure'\n\nexport type DocumentConfiguration = Config &\n PartialDeep<{\n 'x-scalar-reference-config': {\n tagSort: TraverseSpecOptions['tagsSorter']\n operationsSorter: TraverseSpecOptions['operationsSorter']\n getHeadingId: TraverseSpecOptions['getHeadingId']\n getOperationId: TraverseSpecOptions['getOperationId']\n getWebhookId: TraverseSpecOptions['getWebhookId']\n getModelId: TraverseSpecOptions['getModelId']\n getTagId: TraverseSpecOptions['getTagId']\n generateOperationSlug?: (details: {\n path: string\n operationId?: string\n method: string\n summary?: string\n }) => string\n generateHeadingSlug?: (details: { slug?: string }) => string\n generateTagSlug?: (details: { name?: string }) => string\n generateModelSlug?: (details: { name?: string }) => string\n generateWebhookSlug?: (details: { name: string; method: string }) => string\n }\n }>\n\ntype ExtraDocumentConfigurations = Record<\n string,\n {\n fetch: WorkspaceDocumentMetaInput['fetch']\n }\n>\n\nconst defaultConfig: RequiredDeep<Config> = {\n 'x-scalar-reference-config': defaultReferenceConfig,\n}\n\n/**\n * Input type for workspace document metadata and configuration.\n * This type defines the required and optional fields for initializing a document in the workspace.\n */\ntype WorkspaceDocumentMetaInput = {\n /** Optional metadata about the document like title, description, etc */\n meta?: WorkspaceDocumentMeta\n /** Required unique identifier for the document */\n name: string\n /** Optional configuration options */\n config?: DocumentConfiguration\n /** Overrides for the document */\n overrides?: InMemoryWorkspace['overrides'][string]\n /** Optional custom fetch implementation to use when retrieving the document. By default the global fetch implementation will be used */\n fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>\n}\n\n/**\n * Represents a document that is loaded from a URL.\n * This type extends WorkspaceDocumentMetaInput to include URL-specific properties.\n */\nexport type UrlDoc = {\n /** URL to fetch the OpenAPI document from */\n url: string\n} & WorkspaceDocumentMetaInput\n\n/** Represents a document that is provided directly as an object rather than loaded from a URL */\nexport type ObjectDoc = {\n /** The OpenAPI document object containing the API specification */\n document: Record<string, unknown>\n} & WorkspaceDocumentMetaInput\n\n/**\n * Union type representing the possible input formats for a workspace document:\n * - UrlDoc: Document loaded from a URL with optional fetch configuration\n * - ObjectDoc: Direct document object with metadata\n */\nexport type WorkspaceDocumentInput = UrlDoc | ObjectDoc\n\n/**\n * Resolves a workspace document from various input sources (URL, local file, or direct document object).\n *\n * @param workspaceDocument - The document input to resolve, which can be:\n * - A URL to fetch the document from\n * - A direct document object\n * @returns A promise that resolves to an object containing:\n * - ok: boolean indicating if the resolution was successful\n * - data: The resolved document data\n *\n * @example\n * // Resolve from URL\n * const urlDoc = await loadDocument({ name: 'api', url: 'https://api.example.com/openapi.json' })\n *\n * // Resolve direct document\n * const directDoc = await loadDocument({\n * name: 'inline',\n * document: { openapi: '3.0.0', paths: {} }\n * })\n */\nasync function loadDocument(workspaceDocument: WorkspaceDocumentInput) {\n if ('url' in workspaceDocument) {\n return fetchUrls({ fetch: workspaceDocument.fetch }).exec(workspaceDocument.url)\n }\n\n return {\n ok: true as const,\n data: workspaceDocument.document,\n }\n}\n\n/**\n * Returns the origin (URL) of a workspace document if it was loaded from a URL.\n * If the document was provided directly as an object, returns undefined.\n *\n * @param input - The workspace document input (either UrlDoc or ObjectDoc)\n * @returns The URL string if present, otherwise undefined\n */\nconst getDocumentSource = (input: WorkspaceDocumentInput) => {\n if ('url' in input) {\n return input.url\n }\n return undefined\n}\n\n/**\n * Configuration object for initializing a workspace store.\n * Defines the initial state and documents for the workspace.\n */\ntype WorkspaceProps = {\n /** Optional metadata for the workspace including theme, active document, etc */\n meta?: WorkspaceMeta\n /** Workspace configuration */\n config?: Config\n /** Fetch function for retrieving documents */\n fetch?: WorkspaceDocumentInput['fetch']\n}\n\n/**\n * Type definition for the workspace store return object.\n * This explicit type is needed to avoid TypeScript inference limits.\n *\n * @see https://github.com/microsoft/TypeScript/issues/43817#issuecomment-827746462\n */\nexport type WorkspaceStore = {\n /**\n * Returns the reactive workspace object with an additional activeDocument getter\n */\n readonly workspace: Workspace\n /**\n * Updates a specific metadata field in the workspace\n * @param key - The metadata field to update\n * @param value - The new value for the field\n * @example\n * // Update the workspace title\n * update('x-scalar-active-document', 'document-name')\n */\n update<K extends keyof WorkspaceMeta>(key: K, value: WorkspaceMeta[K]): void\n /**\n * Updates a specific metadata field in a document\n * @param name - The name of the document to update ('active' or a specific document name)\n * @param key - The metadata field to update\n * @param value - The new value for the field\n * @throws Error if the specified document doesn't exist\n * @example\n * // Update the auth of the active document\n * updateDocument('active', 'x-scalar-active-auth', 'Bearer')\n * // Update the auth of a specific document\n * updateDocument('document-name', 'x-scalar-active-auth', 'Bearer')\n */\n updateDocument<K extends keyof WorkspaceDocumentMeta>(\n name: 'active' | (string & {}),\n key: K,\n value: WorkspaceDocumentMeta[K],\n ): void\n /**\n * Replaces the content of a specific document in the workspace with the provided input.\n * This method computes the difference between the current document and the new input,\n * then applies only the necessary changes in place. The updates are applied atomically,\n * ensuring the document is updated in a single operation.\n *\n * @param documentName - The name of the document to update.\n * @param input - The new content to apply to the document (as a plain object).\n * @example\n * // Replace the content of the 'api' document with new data\n * store.replaceDocument('api', {\n * openapi: '3.1.0',\n * info: { title: 'Updated API', version: '1.0.1' },\n * paths: {},\n * })\n */\n replaceDocument(documentName: string, input: Record<string, unknown>): Promise<void>\n /**\n * Resolves a reference in the active document by following the provided path and resolving any external $ref references.\n * This method traverses the document structure following the given path and resolves any $ref references it encounters.\n * During resolution, it sets a loading status and updates the reference with the resolved content.\n *\n * @param path - Array of strings representing the path to the reference (e.g. ['paths', '/users', 'get', 'responses', '200'])\n * @throws Error if the path is invalid or empty\n * @example\n * // Resolve a reference in the active document\n * resolve(['paths', '/users', 'get', 'responses', '200'])\n */\n resolve(path: string[]): Promise<unknown>\n /**\n * Adds a new document to the workspace\n * @param document - The document content to add. This should be a valid OpenAPI/Swagger document or other supported format\n * @param meta - Metadata for the document, including its name and other properties defined in WorkspaceDocumentMeta\n * @example\n * // Add a new OpenAPI document to the workspace\n * store.addDocument({\n * name: 'name',\n * document: {\n * openapi: '3.0.0',\n * info: { title: 'title' },\n * },\n * meta: {\n * 'x-scalar-active-auth': 'Bearer',\n * 'x-scalar-active-server': 'production'\n * }\n * })\n */\n addDocument(input: WorkspaceDocumentInput): Promise<void>\n /**\n * Returns the merged configuration for the active document.\n *\n * This getter merges configurations in the following order of precedence:\n * 1. Document-specific configuration (highest priority)\n * 2. Workspace-level configuration\n * 3. Default configuration (lowest priority)\n *\n * The active document is determined by the workspace's activeDocument extension,\n * falling back to the first document if none is specified.\n */\n readonly config: typeof defaultConfig\n /**\n * Exports the specified document in the requested format.\n *\n * This method serializes the most recently saved local version of the document (from the intermediateDocuments map)\n * to either JSON or YAML. The exported document reflects the last locally saved state, including any edits\n * that have been saved but not yet synced to a remote registry. Runtime/in-memory changes that have not been saved\n * will not be included.\n *\n * @param documentName - The name of the document to export.\n * @param format - The output format: 'json' for a JSON string, or 'yaml' for a YAML string.\n * @returns The document as a string in the requested format, or undefined if the document does not exist.\n *\n * @example\n * // Export a document as JSON\n * const jsonString = store.exportDocument('api', 'json')\n *\n * // Export a document as YAML\n * const yamlString = store.exportDocument('api', 'yaml')\n */\n exportDocument(documentName: string, format: 'json' | 'yaml'): string | undefined\n /**\n * Saves the current state of the specified document to the intermediate documents map.\n *\n * This function captures the latest (reactive) state of the document from the workspace and\n * applies its changes to the corresponding entry in the `intermediateDocuments` map.\n * The `intermediateDocuments` map represents the most recently \"saved\" local version of the document,\n * which may include edits not yet synced to the remote registry.\n *\n * The update is performed in-place. A deep clone of the current document\n * state is used to avoid mutating the reactive object directly.\n *\n * @param documentName - The name of the document to save.\n * @returns An array of diffs that were excluded from being applied (such as changes to ignored keys),\n * or undefined if the document does not exist or cannot be updated.\n *\n * @example\n * // Save the current state of the document named 'api'\n * const excludedDiffs = store.saveDocument('api')\n */\n saveDocument(documentName: string): Promise<unknown[] | undefined>\n /**\n * Restores the specified document to its last locally saved state.\n *\n * This method updates the current reactive document (in the workspace) with the contents of the\n * corresponding intermediate document (from the `intermediateDocuments` map), effectively discarding\n * any unsaved in-memory changes and reverting to the last saved version.\n * Vue reactivity is preserved by updating the existing reactive object in place.\n *\n * **Warning:** This operation will discard all unsaved (in-memory) changes to the specified document.\n *\n * @param documentName - The name of the document to restore.\n * @returns void\n *\n * @example\n * // Restore the document named 'api' to its last saved state\n * store.revertDocumentChanges('api')\n */\n revertDocumentChanges(documentName: string): Promise<void>\n /**\n * Commits the specified document.\n *\n * This method is intended to finalize and persist the current state of the document,\n * potentially syncing it with a remote registry or marking it as the latest committed version.\n *\n * @param documentName - The name of the document to commit.\n * @remarks\n * The actual commit logic is not implemented yet.\n */\n commitDocument(documentName: string): void\n /**\n * Serializes the current workspace state to a JSON string for backup, persistence, or sharing.\n *\n * This method exports all workspace documents (removing Vue reactivity proxies), workspace metadata,\n * document configurations, and both the original and intermediate document states. The resulting JSON\n * can be imported later to fully restore the workspace to this exact state, including all documents\n * and their configurations.\n *\n * @returns A JSON string representing the complete workspace state.\n */\n exportWorkspace(): string\n /**\n * Imports a workspace from a serialized JSON string.\n *\n * This method parses the input string using the InMemoryWorkspaceSchema,\n * then updates the current workspace state, including documents, metadata,\n * and configuration, with the imported values.\n *\n * @param input - The serialized workspace JSON string to import.\n */\n loadWorkspace(input: string): void\n /**\n * Imports a workspace from a WorkspaceSpecification object.\n *\n * This method assigns workspace metadata and adds all documents defined in the specification.\n * Each document is added using its $ref and optional overrides.\n *\n * @example\n * ```ts\n * await store.importWorkspaceFromSpecification({\n * documents: {\n * api: { $ref: '/specs/api.yaml' },\n * petstore: { $ref: '/specs/petstore.yaml' }\n * },\n * overrides: {\n * api: { config: { features: { showModels: true } } }\n * },\n * info: { title: 'My Workspace' },\n * workspace: 'v1',\n * \"x-scalar-dark-mode\": true\n * })\n * ```\n *\n * @param specification - The workspace specification to import.\n */\n importWorkspaceFromSpecification(specification: WorkspaceSpecification): Promise<void[]>\n /**\n * Rebases a document in the workspace with a new origin, resolving conflicts if provided.\n *\n * This method is used to rebase a document (e.g., after pulling remote changes) by applying the changes\n * from the new origin and merging them with local edits. If there are conflicts, they can be resolved\n * by providing a list of resolved conflicts.\n *\n * @param documentName - The name of the document to rebase.\n * @param newDocumentOrigin - The new origin document (as an object) to rebase onto.\n * @param resolvedConflicts - (Optional) An array of resolved conflicts to apply.\n * @returns If there are unresolved conflicts and no resolution is provided, returns the list of conflicts.\n *\n * @example\n * // Example: Rebase a document with a new origin and resolve conflicts\n * const conflicts = store.rebaseDocument('api', newOriginDoc)\n * if (conflicts && conflicts.length > 0) {\n * // User resolves conflicts here...\n * store.rebaseDocument('api', newOriginDoc, userResolvedConflicts)\n * }\n */\n rebaseDocument: (\n documentName: string,\n newDocumentOrigin: Record<string, unknown>,\n resolvedConflicts?: Difference<unknown>[],\n ) => void | ReturnType<typeof merge>['conflicts']\n}\n\n/**\n * Creates a reactive workspace store that manages documents and their metadata.\n * The store provides functionality for accessing, updating, and resolving document references.\n *\n * @param workspaceProps - Configuration object for the workspace\n * @param workspaceProps.meta - Optional metadata for the workspace\n * @param workspaceProps.documents - Optional record of documents to initialize the workspace with\n * Documents that require asynchronous loading must be added using `addDocument` after the store is created\n * this allows atomic awaiting and does not block page load for the store initialization\n * @returns An object containing methods and getters for managing the workspace\n */\nexport const createWorkspaceStore = (workspaceProps?: WorkspaceProps): WorkspaceStore => {\n /**\n * Holds the original, unmodified documents as they were initially loaded into the workspace.\n * These documents are stored in their raw form\u2014prior to any reactive wrapping, dereferencing, or bundling.\n * This map preserves the pristine structure of each document, using deep clones to ensure that\n * subsequent mutations in the workspace do not affect the originals.\n * The originals are retained so that we can restore, compare, or sync with the remote registry as needed.\n */\n const originalDocuments = {} as Record<string, UnknownObject>\n /**\n * Stores the intermediate state of documents after local edits but before syncing with the remote registry.\n *\n * This map acts as a local \"saved\" version of the document, reflecting the user's changes after they hit \"save\".\n * The `originalDocuments` map, by contrast, always mirrors the document as it exists in the remote registry.\n *\n * Use this map to stage local changes that are ready to be propagated back to the remote registry.\n * This separation allows us to distinguish between:\n * - The last known remote version (`originalDocuments`)\n * - The latest locally saved version (`intermediateDocuments`)\n * - The current in-memory (possibly unsaved) workspace document (`workspace.documents`)\n */\n const intermediateDocuments = {} as Record<string, UnknownObject>\n /**\n * A map of document configurations keyed by document name.\n * This stores the configuration options for each document in the workspace,\n * allowing for document-specific settings like navigation options, appearance,\n * and other reference configuration.\n */\n const documentConfigs: Record<string, Config> = {}\n /**\n * Stores per-document overrides for OpenAPI documents.\n * This object is used to override specific fields of a document\n * when you cannot (or should not) modify the source document directly.\n * For example, this enables UI-driven or temporary changes to be applied\n * on top of the original document, without mutating the source.\n * The key is the document name, and the value is a deep partial\n * OpenAPI document representing the overridden fields.\n */\n const overrides: InMemoryWorkspace['overrides'] = {}\n /**\n * Holds additional metadata for each document in the workspace.\n *\n * This metadata should be persisted together with the document itself.\n * It can include information such as user preferences, UI state, or other\n * per-document attributes that are not part of the OpenAPI document structure.\n */\n const documentMeta: InMemoryWorkspace['documentMeta'] = {}\n\n /**\n * Holds additional configuration options for each document in the workspace.\n *\n * This can include settings that can not be persisted between sessions (not JSON serializable)\n */\n const extraDocumentConfigurations: ExtraDocumentConfigurations = {}\n\n // Create a reactive workspace object with proxied documents\n // Each document is wrapped in a proxy to enable reactive updates and reference resolution\n const workspace = reactive<Workspace>({\n ...workspaceProps?.meta,\n documents: {},\n /**\n * Returns the currently active document from the workspace.\n * The active document is determined by the 'x-scalar-active-document' metadata field,\n * falling back to the first document in the workspace if no active document is specified.\n *\n * @returns The active document or undefined if no document is found\n */\n get activeDocument(): NonNullable<Workspace['activeDocument']> | undefined {\n const activeDocumentKey =\n workspace[extensions.workspace.activeDocument] ?? Object.keys(workspace.documents)[0] ?? ''\n return workspace.documents[activeDocumentKey]\n },\n })\n\n /**\n * Returns the name of the currently active document in the workspace.\n * The active document is determined by the 'x-scalar-active-document' metadata field,\n * falling back to the first document in the workspace if no active document is specified.\n *\n * @returns The name of the active document or an empty string if no document is found\n */\n function getActiveDocumentName() {\n return workspace[extensions.workspace.activeDocument] ?? Object.keys(workspace.documents)[0] ?? ''\n }\n\n // Save the current state of the specified document to the intermediate documents map.\n // This function captures the latest (reactive) state of the document from the workspace and\n // applies its changes to the corresponding entry in the `intermediateDocuments` map.\n // The `intermediateDocuments` map represents the most recently \"saved\" local version of the document,\n // which may include edits not yet synced to the remote registry.\n async function saveDocument(documentName: string) {\n const intermediateDocument = intermediateDocuments[documentName]\n const workspaceDocument = workspace.documents[documentName]\n\n if (!workspaceDocument) {\n return\n }\n\n // Obtain the raw state of the current document to ensure accurate diffing\n const updatedDocument = getRaw(workspaceDocument)\n\n // If either the intermediate or updated document is missing, do nothing\n if (!intermediateDocument || !updatedDocument) {\n return\n }\n\n // Traverse the document and convert refs back to the original shape\n const updatedWithOriginalRefs = await bundle(deepClone(updatedDocument), {\n plugins: [restoreOriginalRefs()],\n treeShake: false,\n urlMap: true,\n })\n\n // Apply changes from the current document to the intermediate document in place\n const excludedDiffs = applySelectiveUpdates(intermediateDocument, updatedWithOriginalRefs as UnknownObject)\n return excludedDiffs\n }\n\n // Add a document to the store synchronously from an in-memory OpenAPI document\n async function addInMemoryDocument(input: ObjectDoc & { initialize?: boolean; documentSource?: string }) {\n const { name, meta } = input\n const cloned = measureSync('deepClone', () => deepClone(input.document))\n const inputDocument = measureSync('upgrade', () => upgrade(cloned).specification)\n\n measureSync('initialize', () => {\n if (input.initialize !== false) {\n // Store the original document in the originalDocuments map\n // This is used to track the original state of the document as it was loaded into the workspace\n originalDocuments[name] = deepClone({ ...inputDocument })\n\n // Store the intermediate document state for local edits\n // This is used to track the last saved state of the document\n // It allows us to differentiate between the original document and the latest saved version\n // This is important for local edits that are not yet synced with the remote registry\n // The intermediate document is used to store the latest saved state of the document\n // This allows us to track changes and revert to the last saved state if needed\n intermediateDocuments[name] = deepClone({ ...inputDocument })\n // Add the document config to the documentConfigs map\n documentConfigs[name] = input.config ?? {}\n // Store the overrides for this document, or an empty object if none are provided\n overrides[name] = input.overrides ?? {}\n // Store the document metadata for this document, setting the origin if provided\n documentMeta[name] = { documentSource: input.documentSource }\n // Store extra document configurations that can not be persisted\n extraDocumentConfigurations[name] = { fetch: input.fetch }\n }\n })\n\n const strictDocument: UnknownObject = createMagicProxy({ ...inputDocument, ...meta })\n\n if (strictDocument[extensions.document.navigation] === undefined) {\n // If the document navigation is not already present, bundle the entire document to resolve all references.\n // This typically applies when the document is not preprocessed by the server and needs local reference resolution.\n // We need to bundle document first before we validate, so we can also validate the external references\n await measureAsync(\n 'bundle',\n async () =>\n await bundle(getRaw(strictDocument), {\n treeShake: false,\n plugins: [\n fetchUrls({\n fetch: extraDocumentConfigurations[name]?.fetch ?? workspaceProps?.fetch,\n }),\n externalValueResolver(),\n refsEverywhere(),\n // TODO: investigate problems with type: {} properties\n // cleanUp(),\n ],\n urlMap: true,\n origin: documentMeta[name]?.documentSource, // use the document origin (if provided) as the base URL for resolution\n }),\n )\n\n // We coerce the values only when the document is not preprocessed by the server-side-store\n const coerced = measureSync('coerceValue', () =>\n coerceValue(OpenAPIDocumentSchemaStrict, deepClone(strictDocument)),\n )\n measureAsync('mergeObjects', async () => mergeObjects(strictDocument, coerced))\n }\n\n const isValid = Value.Check(OpenAPIDocumentSchemaStrict, strictDocument)\n\n if (!isValid) {\n throw 'Invalid document provided! Please check your input document. It has some invalid refs.'\n }\n\n // Skip navigation generation if the document already has a server-side generated navigation structure\n if (strictDocument[extensions.document.navigation] === undefined) {\n const showModels = input.config?.['x-scalar-reference-config']?.features?.showModels\n\n strictDocument[extensions.document.navigation] = createNavigation(strictDocument, {\n ...(input.config?.['x-scalar-reference-config'] ?? {}),\n hideModels: showModels === undefined ? undefined : !showModels,\n }).entries\n }\n\n // Create a proxied document with magic proxy and apply any overrides, then store it in the workspace documents map\n workspace.documents[name] = createOverridesProxy(strictDocument, input.overrides)\n }\n\n // Asynchronously adds a new document to the workspace by loading and validating the input.\n // If loading fails, a placeholder error document is added instead.\n async function addDocument(input: WorkspaceDocumentInput) {\n const { name, meta } = input\n\n const resolve = await measureAsync(\n 'loadDocument',\n async () => await loadDocument({ ...input, fetch: input.fetch ?? workspaceProps?.fetch }),\n )\n\n // Log the time taken to add a document\n await measureAsync('addDocument', async () => {\n if (!resolve.ok) {\n console.error(`Failed to fetch document '${name}': request was not successful`)\n\n workspace.documents[name] = {\n ...meta,\n openapi: '3.1.0',\n info: {\n title: `Document '${name}' could not be loaded`,\n version: 'unknown',\n },\n }\n\n return\n }\n\n if (!isObject(resolve.data)) {\n console.error(`Failed to load document '${name}': response data is not a valid object`)\n\n workspace.documents[name] = {\n ...meta,\n openapi: '3.1.0',\n info: {\n title: `Document '${name}' could not be loaded`,\n version: 'unknown',\n },\n }\n\n return\n }\n\n await addInMemoryDocument({ ...input, document: resolve.data, documentSource: getDocumentSource(input) })\n })\n }\n\n // Returns the effective document configuration for a given document name,\n // merging (in order of increasing priority): the default config, workspace-level config, and document-specific config.\n const getDocumentConfiguration = (name: string) => {\n return mergeObjects<typeof defaultConfig>(\n mergeObjects(defaultConfig, workspaceProps?.config ?? {}),\n documentConfigs[name] ?? {},\n )\n }\n\n // Cache to track visited nodes during reference resolution to prevent bundling the same subtree multiple times\n // This is needed because we are doing partial bundle operations\n const visitedNodesCache = new Set()\n\n return {\n get workspace() {\n return workspace\n },\n update<K extends keyof WorkspaceMeta>(key: K, value: WorkspaceMeta[K]) {\n // @ts-ignore\n if (key === '__proto__' || key === 'constructor' || key === 'prototype') {\n throw new Error('Invalid key: cannot modify prototype')\n }\n Object.assign(workspace, { [key]: value })\n },\n updateDocument<K extends keyof WorkspaceDocumentMeta>(\n name: 'active' | (string & {}),\n key: K,\n value: WorkspaceDocumentMeta[K],\n ) {\n const currentDocument = workspace.documents[name === 'active' ? getActiveDocumentName() : name]\n\n if (!currentDocument) {\n throw 'Please select a valid document'\n }\n\n Object.assign(currentDocument, { [key]: value })\n },\n async replaceDocument(documentName: string, input: Record<string, unknown>) {\n const currentDocument = workspace.documents[documentName]\n\n if (!currentDocument) {\n return console.error(`Document '${documentName}' does not exist in the workspace.`)\n }\n\n // Replace the whole document\n await addInMemoryDocument({\n name: documentName,\n document: input,\n // Preserve the current metadata\n meta: {\n 'x-scalar-active-auth': currentDocument['x-scalar-active-auth'],\n 'x-scalar-active-server': currentDocument['x-scalar-active-server'],\n },\n initialize: false,\n })\n },\n resolve: async (path: string[]) => {\n const activeDocument = workspace.activeDocument\n\n const target = getValueByPath(activeDocument, path)\n\n if (!isObject(target)) {\n console.error(\n `Invalid path provided for resolution. Path: [${path.join(', ')}]. Found value of type: ${typeof target}. Expected an object.`,\n )\n return\n }\n\n // Bundle the target document with the active document as root, resolving any external references\n // and tracking resolution status through hooks\n return bundle(target, {\n root: activeDocument,\n treeShake: false,\n plugins: [fetchUrls(), loadingStatus(), externalValueResolver()],\n urlMap: true,\n visitedNodes: visitedNodesCache,\n })\n },\n addDocument,\n get config() {\n return getDocumentConfiguration(getActiveDocumentName())\n },\n exportDocument: (documentName: string, format: 'json' | 'yaml') => {\n const intermediateDocument = intermediateDocuments[documentName]\n\n if (!intermediateDocument) {\n return\n }\n\n if (format === 'json') {\n return JSON.stringify(intermediateDocument)\n }\n\n return YAML.stringify(intermediateDocument)\n },\n saveDocument,\n async revertDocumentChanges(documentName: string) {\n const workspaceDocument = workspace.documents[documentName]\n const intermediate = intermediateDocuments[documentName]\n\n if (!workspaceDocument || !intermediate) {\n return\n }\n\n await addInMemoryDocument({\n name: documentName,\n document: intermediate,\n initialize: false,\n })\n },\n commitDocument(documentName: string) {\n // TODO: Implement commit logic\n console.warn(`Commit operation for document '${documentName}' is not implemented yet.`)\n },\n exportWorkspace() {\n return JSON.stringify({\n documents: {\n ...Object.fromEntries(\n Object.entries(workspace.documents).map(([name, doc]) => [\n name,\n // Extract the raw document data for export, removing any Vue reactivity wrappers.\n // When importing, the document can be wrapped again in a magic proxy.\n getRaw(doc),\n ]),\n ),\n },\n meta: workspaceProps?.meta ?? {},\n documentConfigs,\n originalDocuments,\n intermediateDocuments,\n overrides,\n documentMeta,\n } satisfies InMemoryWorkspace)\n },\n loadWorkspace(input: string) {\n const result = coerceValue(InMemoryWorkspaceSchema, JSON.parse(input))\n\n // Assign the magic proxy to the documents\n safeAssign(\n workspace.documents,\n Object.fromEntries(\n Object.entries(result.documents).map(([name, doc]) => [\n name,\n createOverridesProxy(createMagicProxy(doc), result.overrides[name]),\n ]),\n ),\n )\n\n safeAssign(originalDocuments, result.originalDocuments)\n safeAssign(intermediateDocuments, result.intermediateDocuments)\n safeAssign(documentConfigs, result.documentConfigs)\n safeAssign(overrides, result.overrides)\n safeAssign(workspace, result.meta)\n safeAssign(documentMeta, result.documentMeta)\n },\n importWorkspaceFromSpecification: (specification: WorkspaceSpecification) => {\n const { documents, overrides, info, workspace: workspaceVersion, ...meta } = specification\n\n // Assign workspace metadata\n safeAssign(workspace, meta)\n\n // Add workspace documents\n return Promise.all(\n Object.entries(documents ?? {}).map(([name, doc]) =>\n addDocument({ url: doc.$ref, name, overrides: overrides?.[name] }),\n ),\n )\n },\n rebaseDocument: (documentName, newDocumentOrigin, resolvedConflicts) => {\n const newOrigin = coerceValue(OpenAPIDocumentSchemaLoose, upgrade(newDocumentOrigin).specification)\n\n const originalDocument = originalDocuments[documentName]\n const intermediateDocument = intermediateDocuments[documentName]\n const activeDocument = workspace.documents[documentName] ? getRaw(workspace.documents[documentName]) : undefined // raw version without any overrides\n\n if (!originalDocument || !intermediateDocument || !activeDocument) {\n // If any required document state is missing, do nothing\n return console.error('[ERROR]: Specified document is missing or internal corrupted workspace state')\n }\n\n // ---- Get the new intermediate document\n const changelogAA = diff(originalDocument, newOrigin)\n const changelogAB = diff(originalDocument, intermediateDocument)\n\n const changesA = merge(changelogAA, changelogAB)\n\n if (resolvedConflicts === undefined) {\n // If there are conflicts, return the list of conflicts for user resolution\n return changesA.conflicts\n }\n\n const changesetA = changesA.diffs.concat(resolvedConflicts)\n\n // Apply the changes to the original document to get the new intermediate\n const newIntermediateDocument = apply(deepClone(originalDocument), changesetA)\n intermediateDocuments[documentName] = newIntermediateDocument\n\n // Update the original document\n originalDocuments[documentName] = newOrigin\n\n // ---- Get the new active document\n const changelogBA = diff(intermediateDocument, newIntermediateDocument)\n const changelogBB = diff(intermediateDocument, activeDocument)\n\n const changesB = merge(changelogBA, changelogBB)\n\n // Auto-conflict resolution: pick only the changes from the first changeset\n // TODO: In the future, implement smarter conflict resolution if needed\n const changesetB = changesB.diffs.concat(changesB.conflicts.flatMap((it) => it[0]))\n\n const newActiveDocument = coerceValue(\n OpenAPIDocumentSchemaStrict,\n apply(deepClone(newIntermediateDocument), changesetB),\n )\n\n // Update the active document to the new value\n workspace.documents[documentName] = createOverridesProxy(\n createMagicProxy({ ...newActiveDocument }),\n overrides[documentName],\n )\n return\n },\n }\n}\n\n// biome-ignore lint/performance/noBarrelFile: <explanation>\nexport { generateClientMutators } from '@/mutators'\n"],
|
|
5
|
-
"mappings": "AAAA,
|
|
4
|
+
"sourcesContent": ["import { createMagicProxy, getRaw } from '@scalar/json-magic/magic-proxy'\nimport { upgrade } from '@scalar/openapi-parser'\nimport { reactive } from 'vue'\nimport YAML from 'yaml'\n\nimport { applySelectiveUpdates } from '@/helpers/apply-selective-updates'\nimport { deepClone } from '@/helpers/deep-clone'\nimport { type UnknownObject, isObject, safeAssign } from '@/helpers/general'\nimport { getValueByPath } from '@/helpers/json-path-utils'\nimport { mergeObjects } from '@/helpers/merge-object'\nimport { createOverridesProxy } from '@/helpers/overrides-proxy'\nimport { createNavigation } from '@/navigation'\nimport type { TraverseSpecOptions } from '@/navigation/types'\nimport { externalValueResolver, loadingStatus, refsEverywhere, restoreOriginalRefs } from '@/plugins'\nimport { extensions } from '@/schemas/extensions'\nimport { type InMemoryWorkspace, InMemoryWorkspaceSchema } from '@/schemas/inmemory-workspace'\nimport { defaultReferenceConfig } from '@/schemas/reference-config'\nimport { coerceValue } from '@/schemas/typebox-coerce'\nimport { OpenAPIDocumentSchema as OpenAPIDocumentSchemaLoose } from '@/schemas/v3.1/loose/openapi-document'\nimport {\n OpenAPIDocumentSchema as OpenAPIDocumentSchemaStrict,\n type OpenApiDocument,\n} from '@/schemas/v3.1/strict/openapi-document'\nimport type { Workspace, WorkspaceDocumentMeta, WorkspaceMeta } from '@/schemas/workspace'\nimport type { WorkspaceSpecification } from '@/schemas/workspace-specification'\nimport type { Config } from '@/schemas/workspace-specification/config'\nimport { measureAsync, measureSync } from '@scalar/helpers/testing/measure'\nimport { bundle } from '@scalar/json-magic/bundle'\nimport { fetchUrls } from '@scalar/json-magic/bundle/plugins/browser'\nimport { type Difference, apply, diff, merge } from '@scalar/json-magic/diff'\nimport type { Record } from '@sinclair/typebox'\nimport { Value } from '@sinclair/typebox/value'\nimport type { PartialDeep, RequiredDeep } from 'type-fest'\n\nexport type DocumentConfiguration = Config &\n PartialDeep<{\n 'x-scalar-reference-config': {\n tagSort: TraverseSpecOptions['tagsSorter']\n operationsSorter: TraverseSpecOptions['operationsSorter']\n getHeadingId: TraverseSpecOptions['getHeadingId']\n getOperationId: TraverseSpecOptions['getOperationId']\n getWebhookId: TraverseSpecOptions['getWebhookId']\n getModelId: TraverseSpecOptions['getModelId']\n getTagId: TraverseSpecOptions['getTagId']\n generateOperationSlug?: (details: {\n path: string\n operationId?: string\n method: string\n summary?: string\n }) => string\n generateHeadingSlug?: (details: { slug?: string }) => string\n generateTagSlug?: (details: { name?: string }) => string\n generateModelSlug?: (details: { name?: string }) => string\n generateWebhookSlug?: (details: { name: string; method: string }) => string\n }\n }>\n\ntype ExtraDocumentConfigurations = Record<\n string,\n {\n fetch: WorkspaceDocumentMetaInput['fetch']\n }\n>\n\nexport type ValidationError = {\n message: string\n path: string\n schema: unknown\n value: unknown\n}\n\nconst defaultConfig: RequiredDeep<Config> = {\n 'x-scalar-reference-config': defaultReferenceConfig,\n}\n\n/**\n * Input type for workspace document metadata and configuration.\n * This type defines the required and optional fields for initializing a document in the workspace.\n */\ntype WorkspaceDocumentMetaInput = {\n /** Optional metadata about the document like title, description, etc */\n meta?: WorkspaceDocumentMeta\n /** Required unique identifier for the document */\n name: string\n /** Optional configuration options */\n config?: DocumentConfiguration\n /** Overrides for the document */\n overrides?: InMemoryWorkspace['overrides'][string]\n /** Optional custom fetch implementation to use when retrieving the document. By default the global fetch implementation will be used */\n fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>\n}\n\n/**\n * Represents a document that is loaded from a URL.\n * This type extends WorkspaceDocumentMetaInput to include URL-specific properties.\n */\nexport type UrlDoc = {\n /** URL to fetch the OpenAPI document from */\n url: string\n} & WorkspaceDocumentMetaInput\n\n/** Represents a document that is provided directly as an object rather than loaded from a URL */\nexport type ObjectDoc = {\n /** The OpenAPI document object containing the API specification */\n document: Record<string, unknown>\n} & WorkspaceDocumentMetaInput\n\n/**\n * Union type representing the possible input formats for a workspace document:\n * - UrlDoc: Document loaded from a URL with optional fetch configuration\n * - ObjectDoc: Direct document object with metadata\n */\nexport type WorkspaceDocumentInput = UrlDoc | ObjectDoc\n\n/**\n * Resolves a workspace document from various input sources (URL, local file, or direct document object).\n *\n * @param workspaceDocument - The document input to resolve, which can be:\n * - A URL to fetch the document from\n * - A direct document object\n * @returns A promise that resolves to an object containing:\n * - ok: boolean indicating if the resolution was successful\n * - data: The resolved document data\n *\n * @example\n * // Resolve from URL\n * const urlDoc = await loadDocument({ name: 'api', url: 'https://api.example.com/openapi.json' })\n *\n * // Resolve direct document\n * const directDoc = await loadDocument({\n * name: 'inline',\n * document: { openapi: '3.0.0', paths: {} }\n * })\n */\nasync function loadDocument(workspaceDocument: WorkspaceDocumentInput) {\n if ('url' in workspaceDocument) {\n return fetchUrls({ fetch: workspaceDocument.fetch }).exec(workspaceDocument.url)\n }\n\n return {\n ok: true as const,\n data: workspaceDocument.document,\n }\n}\n\n/**\n * Returns the origin (URL) of a workspace document if it was loaded from a URL.\n * If the document was provided directly as an object, returns undefined.\n *\n * @param input - The workspace document input (either UrlDoc or ObjectDoc)\n * @returns The URL string if present, otherwise undefined\n */\nconst getDocumentSource = (input: WorkspaceDocumentInput) => {\n if ('url' in input) {\n return input.url\n }\n return undefined\n}\n\n/**\n * Configuration object for initializing a workspace store.\n * Defines the initial state and documents for the workspace.\n */\ntype WorkspaceProps = {\n /** Optional metadata for the workspace including theme, active document, etc */\n meta?: WorkspaceMeta\n /** Workspace configuration */\n config?: Config\n /** Fetch function for retrieving documents */\n fetch?: WorkspaceDocumentInput['fetch']\n}\n\n/**\n * Type definition for the workspace store return object.\n * This explicit type is needed to avoid TypeScript inference limits.\n *\n * @see https://github.com/microsoft/TypeScript/issues/43817#issuecomment-827746462\n */\nexport type WorkspaceStore = {\n /**\n * Returns the reactive workspace object with an additional activeDocument getter\n */\n readonly workspace: Workspace\n /**\n * Updates a specific metadata field in the workspace\n * @param key - The metadata field to update\n * @param value - The new value for the field\n * @example\n * // Update the workspace title\n * update('x-scalar-active-document', 'document-name')\n */\n update<K extends keyof WorkspaceMeta>(key: K, value: WorkspaceMeta[K]): void\n /**\n * Updates a specific metadata field in a document\n * @param name - The name of the document to update ('active' or a specific document name)\n * @param key - The metadata field to update\n * @param value - The new value for the field\n * @throws Error if the specified document doesn't exist\n * @example\n * // Update the auth of the active document\n * updateDocument('active', 'x-scalar-active-auth', 'Bearer')\n * // Update the auth of a specific document\n * updateDocument('document-name', 'x-scalar-active-auth', 'Bearer')\n */\n updateDocument<K extends keyof WorkspaceDocumentMeta>(\n name: 'active' | (string & {}),\n key: K,\n value: WorkspaceDocumentMeta[K],\n ): void\n /**\n * Replaces the content of a specific document in the workspace with the provided input.\n * This method computes the difference between the current document and the new input,\n * then applies only the necessary changes in place. The updates are applied atomically,\n * ensuring the document is updated in a single operation.\n *\n * @param documentName - The name of the document to update.\n * @param input - The new content to apply to the document (as a plain object).\n * @example\n * // Replace the content of the 'api' document with new data\n * store.replaceDocument('api', {\n * openapi: '3.1.0',\n * info: { title: 'Updated API', version: '1.0.1' },\n * paths: {},\n * })\n */\n replaceDocument(documentName: string, input: Record<string, unknown>): Promise<void>\n /**\n * Resolves a reference in the active document by following the provided path and resolving any external $ref references.\n * This method traverses the document structure following the given path and resolves any $ref references it encounters.\n * During resolution, it sets a loading status and updates the reference with the resolved content.\n *\n * @param path - Array of strings representing the path to the reference (e.g. ['paths', '/users', 'get', 'responses', '200'])\n * @throws Error if the path is invalid or empty\n * @example\n * // Resolve a reference in the active document\n * resolve(['paths', '/users', 'get', 'responses', '200'])\n */\n resolve(path: string[]): Promise<unknown>\n /**\n * Adds a new document to the workspace\n * @param document - The document content to add. This should be a valid OpenAPI/Swagger document or other supported format\n * @param meta - Metadata for the document, including its name and other properties defined in WorkspaceDocumentMeta\n * @example\n * // Add a new OpenAPI document to the workspace\n * store.addDocument({\n * name: 'name',\n * document: {\n * openapi: '3.0.0',\n * info: { title: 'title' },\n * },\n * meta: {\n * 'x-scalar-active-auth': 'Bearer',\n * 'x-scalar-active-server': 'production'\n * }\n * })\n */\n addDocument(input: WorkspaceDocumentInput): Promise<void>\n /**\n * Returns the merged configuration for the active document.\n *\n * This getter merges configurations in the following order of precedence:\n * 1. Document-specific configuration (highest priority)\n * 2. Workspace-level configuration\n * 3. Default configuration (lowest priority)\n *\n * The active document is determined by the workspace's activeDocument extension,\n * falling back to the first document if none is specified.\n */\n readonly config: typeof defaultConfig\n /**\n * Exports the specified document in the requested format.\n *\n * This method serializes the most recently saved local version of the document (from the intermediateDocuments map)\n * to either JSON or YAML. The exported document reflects the last locally saved state, including any edits\n * that have been saved but not yet synced to a remote registry. Runtime/in-memory changes that have not been saved\n * will not be included.\n *\n * @param documentName - The name of the document to export.\n * @param format - The output format: 'json' for a JSON string, or 'yaml' for a YAML string.\n * @returns The document as a string in the requested format, or undefined if the document does not exist.\n *\n * @example\n * // Export a document as JSON\n * const jsonString = store.exportDocument('api', 'json')\n *\n * // Export a document as YAML\n * const yamlString = store.exportDocument('api', 'yaml')\n */\n exportDocument(documentName: string, format: 'json' | 'yaml'): string | undefined\n /**\n * Saves the current state of the specified document to the intermediate documents map.\n *\n * This function captures the latest (reactive) state of the document from the workspace and\n * applies its changes to the corresponding entry in the `intermediateDocuments` map.\n * The `intermediateDocuments` map represents the most recently \"saved\" local version of the document,\n * which may include edits not yet synced to the remote registry.\n *\n * The update is performed in-place. A deep clone of the current document\n * state is used to avoid mutating the reactive object directly.\n *\n * @param documentName - The name of the document to save.\n * @returns An array of diffs that were excluded from being applied (such as changes to ignored keys),\n * or undefined if the document does not exist or cannot be updated.\n *\n * @example\n * // Save the current state of the document named 'api'\n * const excludedDiffs = store.saveDocument('api')\n */\n saveDocument(documentName: string): Promise<unknown[] | undefined>\n /**\n * Restores the specified document to its last locally saved state.\n *\n * This method updates the current reactive document (in the workspace) with the contents of the\n * corresponding intermediate document (from the `intermediateDocuments` map), effectively discarding\n * any unsaved in-memory changes and reverting to the last saved version.\n * Vue reactivity is preserved by updating the existing reactive object in place.\n *\n * **Warning:** This operation will discard all unsaved (in-memory) changes to the specified document.\n *\n * @param documentName - The name of the document to restore.\n * @returns void\n *\n * @example\n * // Restore the document named 'api' to its last saved state\n * store.revertDocumentChanges('api')\n */\n revertDocumentChanges(documentName: string): Promise<void>\n /**\n * Commits the specified document.\n *\n * This method is intended to finalize and persist the current state of the document,\n * potentially syncing it with a remote registry or marking it as the latest committed version.\n *\n * @param documentName - The name of the document to commit.\n * @remarks\n * The actual commit logic is not implemented yet.\n */\n commitDocument(documentName: string): void\n /**\n * Serializes the current workspace state to a JSON string for backup, persistence, or sharing.\n *\n * This method exports all workspace documents (removing Vue reactivity proxies), workspace metadata,\n * document configurations, and both the original and intermediate document states. The resulting JSON\n * can be imported later to fully restore the workspace to this exact state, including all documents\n * and their configurations.\n *\n * @returns A JSON string representing the complete workspace state.\n */\n exportWorkspace(): string\n /**\n * Imports a workspace from a serialized JSON string.\n *\n * This method parses the input string using the InMemoryWorkspaceSchema,\n * then updates the current workspace state, including documents, metadata,\n * and configuration, with the imported values.\n *\n * @param input - The serialized workspace JSON string to import.\n */\n loadWorkspace(input: string): void\n /**\n * Imports a workspace from a WorkspaceSpecification object.\n *\n * This method assigns workspace metadata and adds all documents defined in the specification.\n * Each document is added using its $ref and optional overrides.\n *\n * @example\n * ```ts\n * await store.importWorkspaceFromSpecification({\n * documents: {\n * api: { $ref: '/specs/api.yaml' },\n * petstore: { $ref: '/specs/petstore.yaml' }\n * },\n * overrides: {\n * api: { config: { features: { showModels: true } } }\n * },\n * info: { title: 'My Workspace' },\n * workspace: 'v1',\n * \"x-scalar-dark-mode\": true\n * })\n * ```\n *\n * @param specification - The workspace specification to import.\n */\n importWorkspaceFromSpecification(specification: WorkspaceSpecification): Promise<void[]>\n /**\n * Rebases a document in the workspace with a new origin, resolving conflicts if provided.\n *\n * This method is used to rebase a document (e.g., after pulling remote changes) by applying the changes\n * from the new origin and merging them with local edits. If there are conflicts, they can be resolved\n * by providing a list of resolved conflicts.\n *\n * @param documentName - The name of the document to rebase.\n * @param newDocumentOrigin - The new origin document (as an object) to rebase onto.\n * @param resolvedConflicts - (Optional) An array of resolved conflicts to apply.\n * @returns If there are unresolved conflicts and no resolution is provided, returns the list of conflicts.\n *\n * @example\n * // Example: Rebase a document with a new origin and resolve conflicts\n * const conflicts = store.rebaseDocument('api', newOriginDoc)\n * if (conflicts && conflicts.length > 0) {\n * // User resolves conflicts here...\n * store.rebaseDocument('api', newOriginDoc, userResolvedConflicts)\n * }\n */\n rebaseDocument: (\n documentName: string,\n newDocumentOrigin: Record<string, unknown>,\n resolvedConflicts?: Difference<unknown>[],\n ) => void | ReturnType<typeof merge>['conflicts']\n}\n\n/**\n * Creates a reactive workspace store that manages documents and their metadata.\n * The store provides functionality for accessing, updating, and resolving document references.\n *\n * @param workspaceProps - Configuration object for the workspace\n * @param workspaceProps.meta - Optional metadata for the workspace\n * @param workspaceProps.documents - Optional record of documents to initialize the workspace with\n * Documents that require asynchronous loading must be added using `addDocument` after the store is created\n * this allows atomic awaiting and does not block page load for the store initialization\n * @returns An object containing methods and getters for managing the workspace\n */\nexport const createWorkspaceStore = (workspaceProps?: WorkspaceProps): WorkspaceStore => {\n /**\n * Holds the original, unmodified documents as they were initially loaded into the workspace.\n * These documents are stored in their raw form\u2014prior to any reactive wrapping, dereferencing, or bundling.\n * This map preserves the pristine structure of each document, using deep clones to ensure that\n * subsequent mutations in the workspace do not affect the originals.\n * The originals are retained so that we can restore, compare, or sync with the remote registry as needed.\n */\n const originalDocuments = {} as Record<string, UnknownObject>\n /**\n * Stores the intermediate state of documents after local edits but before syncing with the remote registry.\n *\n * This map acts as a local \"saved\" version of the document, reflecting the user's changes after they hit \"save\".\n * The `originalDocuments` map, by contrast, always mirrors the document as it exists in the remote registry.\n *\n * Use this map to stage local changes that are ready to be propagated back to the remote registry.\n * This separation allows us to distinguish between:\n * - The last known remote version (`originalDocuments`)\n * - The latest locally saved version (`intermediateDocuments`)\n * - The current in-memory (possibly unsaved) workspace document (`workspace.documents`)\n */\n const intermediateDocuments = {} as Record<string, UnknownObject>\n /**\n * A map of document configurations keyed by document name.\n * This stores the configuration options for each document in the workspace,\n * allowing for document-specific settings like navigation options, appearance,\n * and other reference configuration.\n */\n const documentConfigs: Record<string, Config> = {}\n /**\n * Stores per-document overrides for OpenAPI documents.\n * This object is used to override specific fields of a document\n * when you cannot (or should not) modify the source document directly.\n * For example, this enables UI-driven or temporary changes to be applied\n * on top of the original document, without mutating the source.\n * The key is the document name, and the value is a deep partial\n * OpenAPI document representing the overridden fields.\n */\n const overrides: InMemoryWorkspace['overrides'] = {}\n /**\n * Holds additional metadata for each document in the workspace.\n *\n * This metadata should be persisted together with the document itself.\n * It can include information such as user preferences, UI state, or other\n * per-document attributes that are not part of the OpenAPI document structure.\n */\n const documentMeta: InMemoryWorkspace['documentMeta'] = {}\n\n /**\n * Holds additional configuration options for each document in the workspace.\n *\n * This can include settings that can not be persisted between sessions (not JSON serializable)\n */\n const extraDocumentConfigurations: ExtraDocumentConfigurations = {}\n\n // Create a reactive workspace object with proxied documents\n // Each document is wrapped in a proxy to enable reactive updates and reference resolution\n const workspace = reactive<Workspace>({\n ...workspaceProps?.meta,\n documents: {},\n /**\n * Returns the currently active document from the workspace.\n * The active document is determined by the 'x-scalar-active-document' metadata field,\n * falling back to the first document in the workspace if no active document is specified.\n *\n * @returns The active document or undefined if no document is found\n */\n get activeDocument(): NonNullable<Workspace['activeDocument']> | undefined {\n const activeDocumentKey =\n workspace[extensions.workspace.activeDocument] ?? Object.keys(workspace.documents)[0] ?? ''\n return workspace.documents[activeDocumentKey]\n },\n })\n\n /**\n * Returns the name of the currently active document in the workspace.\n * The active document is determined by the 'x-scalar-active-document' metadata field,\n * falling back to the first document in the workspace if no active document is specified.\n *\n * @returns The name of the active document or an empty string if no document is found\n */\n function getActiveDocumentName() {\n return workspace[extensions.workspace.activeDocument] ?? Object.keys(workspace.documents)[0] ?? ''\n }\n\n // Save the current state of the specified document to the intermediate documents map.\n // This function captures the latest (reactive) state of the document from the workspace and\n // applies its changes to the corresponding entry in the `intermediateDocuments` map.\n // The `intermediateDocuments` map represents the most recently \"saved\" local version of the document,\n // which may include edits not yet synced to the remote registry.\n async function saveDocument(documentName: string) {\n const intermediateDocument = intermediateDocuments[documentName]\n const workspaceDocument = workspace.documents[documentName]\n\n if (!workspaceDocument) {\n return\n }\n\n // Obtain the raw state of the current document to ensure accurate diffing\n const updatedDocument = getRaw(workspaceDocument)\n\n // If either the intermediate or updated document is missing, do nothing\n if (!intermediateDocument || !updatedDocument) {\n return\n }\n\n // Traverse the document and convert refs back to the original shape\n const updatedWithOriginalRefs = await bundle(deepClone(updatedDocument), {\n plugins: [restoreOriginalRefs()],\n treeShake: false,\n urlMap: true,\n })\n\n // Apply changes from the current document to the intermediate document in place\n const excludedDiffs = applySelectiveUpdates(intermediateDocument, updatedWithOriginalRefs as UnknownObject)\n return excludedDiffs\n }\n\n // Add a document to the store synchronously from an in-memory OpenAPI document\n async function addInMemoryDocument(input: ObjectDoc & { initialize?: boolean; documentSource?: string }): Promise<{\n errors: ValidationError[] | null\n document: unknown\n }> {\n const { name, meta } = input\n const cloned = measureSync('deepClone', () => deepClone(input.document))\n const inputDocument = measureSync('upgrade', () => upgrade(cloned).specification)\n\n measureSync('initialize', () => {\n if (input.initialize !== false) {\n // Store the original document in the originalDocuments map\n // This is used to track the original state of the document as it was loaded into the workspace\n originalDocuments[name] = deepClone({ ...inputDocument })\n\n // Store the intermediate document state for local edits\n // This is used to track the last saved state of the document\n // It allows us to differentiate between the original document and the latest saved version\n // This is important for local edits that are not yet synced with the remote registry\n // The intermediate document is used to store the latest saved state of the document\n // This allows us to track changes and revert to the last saved state if needed\n intermediateDocuments[name] = deepClone({ ...inputDocument })\n // Add the document config to the documentConfigs map\n documentConfigs[name] = input.config ?? {}\n // Store the overrides for this document, or an empty object if none are provided\n overrides[name] = input.overrides ?? {}\n // Store the document metadata for this document, setting the origin if provided\n documentMeta[name] = { documentSource: input.documentSource }\n // Store extra document configurations that can not be persisted\n extraDocumentConfigurations[name] = { fetch: input.fetch }\n }\n })\n\n const temporaryDocument: UnknownObject = createMagicProxy({ ...inputDocument, ...meta })\n\n if (temporaryDocument[extensions.document.navigation] === undefined) {\n // If the document navigation is not already present, bundle the entire document to resolve all references.\n // This typically applies when the document is not preprocessed by the server and needs local reference resolution.\n // We need to bundle document first before we validate, so we can also validate the external references\n await measureAsync(\n 'bundle',\n async () =>\n await bundle(getRaw(temporaryDocument), {\n treeShake: false,\n plugins: [\n fetchUrls({\n fetch: extraDocumentConfigurations[name]?.fetch ?? workspaceProps?.fetch,\n }),\n externalValueResolver(),\n refsEverywhere(),\n // TODO: investigate problems with type: {} properties\n // cleanUp(),\n ],\n urlMap: true,\n origin: documentMeta[name]?.documentSource, // use the document origin (if provided) as the base URL for resolution\n }),\n )\n\n // We coerce the values only when the document is not preprocessed by the server-side-store\n const coerced = measureSync('coerceValue', () =>\n coerceValue(OpenAPIDocumentSchemaStrict, deepClone(temporaryDocument)),\n )\n measureAsync('mergeObjects', async () => mergeObjects(temporaryDocument, coerced))\n }\n\n const isValid = Value.Check(OpenAPIDocumentSchemaStrict, temporaryDocument)\n let errors: ValidationError[] | null = null\n\n if (!isValid) {\n const validationErrors = Array.from(Value.Errors(OpenAPIDocumentSchemaStrict, temporaryDocument))\n\n errors = validationErrors.map((error) => ({\n message: error.message,\n path: error.path,\n schema: error.schema,\n value: error.value,\n }))\n }\n\n // Type-cast and just try to render, even if the document is (partially) invalid\n const strictDocument = isValid ? temporaryDocument : (temporaryDocument as OpenApiDocument)\n\n // Skip navigation generation if the document already has a server-side generated navigation structure\n if (strictDocument[extensions.document.navigation] === undefined) {\n const showModels = input.config?.['x-scalar-reference-config']?.features?.showModels\n\n strictDocument[extensions.document.navigation] = createNavigation(strictDocument, {\n ...(input.config?.['x-scalar-reference-config'] ?? {}),\n hideModels: showModels === undefined ? undefined : !showModels,\n }).entries\n }\n\n // Create a proxied document with magic proxy and apply any overrides, then store it in the workspace documents map\n workspace.documents[name] = createOverridesProxy(strictDocument, input.overrides)\n\n // Always return success with the processed document and any validation errors\n return {\n errors,\n document: workspace.documents[name],\n }\n }\n\n // Asynchronously adds a new document to the workspace by loading and validating the input.\n // If loading fails, a placeholder error document is added instead.\n async function addDocument(input: WorkspaceDocumentInput) {\n const { name, meta } = input\n\n const resolve = await measureAsync(\n 'loadDocument',\n async () => await loadDocument({ ...input, fetch: input.fetch ?? workspaceProps?.fetch }),\n )\n\n // Log the time taken to add a document\n await measureAsync('addDocument', async () => {\n if (!resolve.ok) {\n console.error(`Failed to fetch document '${name}': request was not successful`)\n\n workspace.documents[name] = {\n ...meta,\n openapi: '3.1.0',\n info: {\n title: `Document '${name}' could not be loaded`,\n version: 'unknown',\n },\n }\n\n return\n }\n\n if (!isObject(resolve.data)) {\n console.error(`Failed to load document '${name}': response data is not a valid object`)\n\n workspace.documents[name] = {\n ...meta,\n openapi: '3.1.0',\n info: {\n title: `Document '${name}' could not be loaded`,\n version: 'unknown',\n },\n }\n\n return\n }\n\n const { errors } = await addInMemoryDocument({\n ...input,\n document: resolve.data,\n documentSource: getDocumentSource(input),\n })\n\n if (errors) {\n console.warn('OpenAPI Document Validation Errors', errors)\n }\n })\n }\n\n // Returns the effective document configuration for a given document name,\n // merging (in order of increasing priority): the default config, workspace-level config, and document-specific config.\n const getDocumentConfiguration = (name: string) => {\n return mergeObjects<typeof defaultConfig>(\n mergeObjects(defaultConfig, workspaceProps?.config ?? {}),\n documentConfigs[name] ?? {},\n )\n }\n\n // Cache to track visited nodes during reference resolution to prevent bundling the same subtree multiple times\n // This is needed because we are doing partial bundle operations\n const visitedNodesCache = new Set()\n\n return {\n get workspace() {\n return workspace\n },\n update<K extends keyof WorkspaceMeta>(key: K, value: WorkspaceMeta[K]) {\n // @ts-ignore\n if (key === '__proto__' || key === 'constructor' || key === 'prototype') {\n throw new Error('Invalid key: cannot modify prototype')\n }\n Object.assign(workspace, { [key]: value })\n },\n updateDocument<K extends keyof WorkspaceDocumentMeta>(\n name: 'active' | (string & {}),\n key: K,\n value: WorkspaceDocumentMeta[K],\n ) {\n const currentDocument = workspace.documents[name === 'active' ? getActiveDocumentName() : name]\n\n if (!currentDocument) {\n throw 'Please select a valid document'\n }\n\n Object.assign(currentDocument, { [key]: value })\n },\n async replaceDocument(documentName: string, input: Record<string, unknown>) {\n const currentDocument = workspace.documents[documentName]\n\n if (!currentDocument) {\n return console.error(`Document '${documentName}' does not exist in the workspace.`)\n }\n\n // Replace the whole document\n const { errors } = await addInMemoryDocument({\n name: documentName,\n document: input,\n // Preserve the current metadata\n meta: {\n 'x-scalar-active-auth': currentDocument['x-scalar-active-auth'],\n 'x-scalar-active-server': currentDocument['x-scalar-active-server'],\n },\n initialize: false,\n })\n\n if (errors) {\n console.warn('OpenAPI Document Validation Errors', errors)\n }\n },\n resolve: async (path: string[]) => {\n const activeDocument = workspace.activeDocument\n\n const target = getValueByPath(activeDocument, path)\n\n if (!isObject(target)) {\n console.error(\n `Invalid path provided for resolution. Path: [${path.join(', ')}]. Found value of type: ${typeof target}. Expected an object.`,\n )\n return\n }\n\n // Bundle the target document with the active document as root, resolving any external references\n // and tracking resolution status through hooks\n return bundle(target, {\n root: activeDocument,\n treeShake: false,\n plugins: [fetchUrls(), loadingStatus(), externalValueResolver()],\n urlMap: true,\n visitedNodes: visitedNodesCache,\n })\n },\n addDocument,\n get config() {\n return getDocumentConfiguration(getActiveDocumentName())\n },\n exportDocument: (documentName: string, format: 'json' | 'yaml') => {\n const intermediateDocument = intermediateDocuments[documentName]\n\n if (!intermediateDocument) {\n return\n }\n\n if (format === 'json') {\n return JSON.stringify(intermediateDocument)\n }\n\n return YAML.stringify(intermediateDocument)\n },\n saveDocument,\n async revertDocumentChanges(documentName: string) {\n const workspaceDocument = workspace.documents[documentName]\n const intermediate = intermediateDocuments[documentName]\n\n if (!workspaceDocument || !intermediate) {\n return\n }\n\n const { errors } = await addInMemoryDocument({\n name: documentName,\n document: intermediate,\n initialize: false,\n })\n\n if (errors) {\n console.warn('OpenAPI Document Validation Errors', errors)\n }\n },\n commitDocument(documentName: string) {\n // TODO: Implement commit logic\n console.warn(`Commit operation for document '${documentName}' is not implemented yet.`)\n },\n exportWorkspace() {\n return JSON.stringify({\n documents: {\n ...Object.fromEntries(\n Object.entries(workspace.documents).map(([name, doc]) => [\n name,\n // Extract the raw document data for export, removing any Vue reactivity wrappers.\n // When importing, the document can be wrapped again in a magic proxy.\n getRaw(doc),\n ]),\n ),\n },\n meta: workspaceProps?.meta ?? {},\n documentConfigs,\n originalDocuments,\n intermediateDocuments,\n overrides,\n documentMeta,\n } satisfies InMemoryWorkspace)\n },\n loadWorkspace(input: string) {\n const result = coerceValue(InMemoryWorkspaceSchema, JSON.parse(input))\n\n // Assign the magic proxy to the documents\n safeAssign(\n workspace.documents,\n Object.fromEntries(\n Object.entries(result.documents).map(([name, doc]) => [\n name,\n createOverridesProxy(createMagicProxy(doc), result.overrides[name]),\n ]),\n ),\n )\n\n safeAssign(originalDocuments, result.originalDocuments)\n safeAssign(intermediateDocuments, result.intermediateDocuments)\n safeAssign(documentConfigs, result.documentConfigs)\n safeAssign(overrides, result.overrides)\n safeAssign(workspace, result.meta)\n safeAssign(documentMeta, result.documentMeta)\n },\n importWorkspaceFromSpecification: (specification: WorkspaceSpecification) => {\n const { documents, overrides, info, workspace: workspaceVersion, ...meta } = specification\n\n // Assign workspace metadata\n safeAssign(workspace, meta)\n\n // Add workspace documents\n return Promise.all(\n Object.entries(documents ?? {}).map(([name, doc]) =>\n addDocument({ url: doc.$ref, name, overrides: overrides?.[name] }),\n ),\n )\n },\n rebaseDocument: (documentName, newDocumentOrigin, resolvedConflicts) => {\n const newOrigin = coerceValue(OpenAPIDocumentSchemaLoose, upgrade(newDocumentOrigin).specification)\n\n const originalDocument = originalDocuments[documentName]\n const intermediateDocument = intermediateDocuments[documentName]\n const activeDocument = workspace.documents[documentName] ? getRaw(workspace.documents[documentName]) : undefined // raw version without any overrides\n\n if (!originalDocument || !intermediateDocument || !activeDocument) {\n // If any required document state is missing, do nothing\n return console.error('[ERROR]: Specified document is missing or internal corrupted workspace state')\n }\n\n // ---- Get the new intermediate document\n const changelogAA = diff(originalDocument, newOrigin)\n const changelogAB = diff(originalDocument, intermediateDocument)\n\n const changesA = merge(changelogAA, changelogAB)\n\n if (resolvedConflicts === undefined) {\n // If there are conflicts, return the list of conflicts for user resolution\n return changesA.conflicts\n }\n\n const changesetA = changesA.diffs.concat(resolvedConflicts)\n\n // Apply the changes to the original document to get the new intermediate\n const newIntermediateDocument = apply(deepClone(originalDocument), changesetA)\n intermediateDocuments[documentName] = newIntermediateDocument\n\n // Update the original document\n originalDocuments[documentName] = newOrigin\n\n // ---- Get the new active document\n const changelogBA = diff(intermediateDocument, newIntermediateDocument)\n const changelogBB = diff(intermediateDocument, activeDocument)\n\n const changesB = merge(changelogBA, changelogBB)\n\n // Auto-conflict resolution: pick only the changes from the first changeset\n // TODO: In the future, implement smarter conflict resolution if needed\n const changesetB = changesB.diffs.concat(changesB.conflicts.flatMap((it) => it[0]))\n\n const newActiveDocument = coerceValue(\n OpenAPIDocumentSchemaStrict,\n apply(deepClone(newIntermediateDocument), changesetB),\n )\n\n // Update the active document to the new value\n workspace.documents[documentName] = createOverridesProxy(\n createMagicProxy({ ...newActiveDocument }),\n overrides[documentName],\n )\n return\n },\n }\n}\n\n// biome-ignore lint/performance/noBarrelFile: <explanation>\nexport { generateClientMutators } from '@/mutators'\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,kBAAkB,cAAc;AACzC,SAAS,eAAe;AACxB,SAAS,gBAAgB;AACzB,OAAO,UAAU;AAEjB,SAAS,6BAA6B;AACtC,SAAS,iBAAiB;AAC1B,SAA6B,UAAU,kBAAkB;AACzD,SAAS,sBAAsB;AAC/B,SAAS,oBAAoB;AAC7B,SAAS,4BAA4B;AACrC,SAAS,wBAAwB;AAEjC,SAAS,uBAAuB,eAAe,gBAAgB,2BAA2B;AAC1F,SAAS,kBAAkB;AAC3B,SAAiC,+BAA+B;AAChE,SAAS,8BAA8B;AACvC,SAAS,mBAAmB;AAC5B,SAAS,yBAAyB,kCAAkC;AACpE;AAAA,EACE,yBAAyB;AAAA,OAEpB;AAIP,SAAS,cAAc,mBAAmB;AAC1C,SAAS,cAAc;AACvB,SAAS,iBAAiB;AAC1B,SAA0B,OAAO,MAAM,aAAa;AAEpD,SAAS,aAAa;AAwCtB,MAAM,gBAAsC;AAAA,EAC1C,6BAA6B;AAC/B;AA6DA,eAAe,aAAa,mBAA2C;AACrE,MAAI,SAAS,mBAAmB;AAC9B,WAAO,UAAU,EAAE,OAAO,kBAAkB,MAAM,CAAC,EAAE,KAAK,kBAAkB,GAAG;AAAA,EACjF;AAEA,SAAO;AAAA,IACL,IAAI;AAAA,IACJ,MAAM,kBAAkB;AAAA,EAC1B;AACF;AASA,MAAM,oBAAoB,CAAC,UAAkC;AAC3D,MAAI,SAAS,OAAO;AAClB,WAAO,MAAM;AAAA,EACf;AACA,SAAO;AACT;AAyQO,MAAM,uBAAuB,CAAC,mBAAoD;AAQvF,QAAM,oBAAoB,CAAC;AAa3B,QAAM,wBAAwB,CAAC;AAO/B,QAAM,kBAA0C,CAAC;AAUjD,QAAM,YAA4C,CAAC;AAQnD,QAAM,eAAkD,CAAC;AAOzD,QAAM,8BAA2D,CAAC;AAIlE,QAAM,YAAY,SAAoB;AAAA,IACpC,GAAG,gBAAgB;AAAA,IACnB,WAAW,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQZ,IAAI,iBAAuE;AACzE,YAAM,oBACJ,UAAU,WAAW,UAAU,cAAc,KAAK,OAAO,KAAK,UAAU,SAAS,EAAE,CAAC,KAAK;AAC3F,aAAO,UAAU,UAAU,iBAAiB;AAAA,IAC9C;AAAA,EACF,CAAC;AASD,WAAS,wBAAwB;AAC/B,WAAO,UAAU,WAAW,UAAU,cAAc,KAAK,OAAO,KAAK,UAAU,SAAS,EAAE,CAAC,KAAK;AAAA,EAClG;AAOA,iBAAe,aAAa,cAAsB;AAChD,UAAM,uBAAuB,sBAAsB,YAAY;AAC/D,UAAM,oBAAoB,UAAU,UAAU,YAAY;AAE1D,QAAI,CAAC,mBAAmB;AACtB;AAAA,IACF;AAGA,UAAM,kBAAkB,OAAO,iBAAiB;AAGhD,QAAI,CAAC,wBAAwB,CAAC,iBAAiB;AAC7C;AAAA,IACF;AAGA,UAAM,0BAA0B,MAAM,OAAO,UAAU,eAAe,GAAG;AAAA,MACvE,SAAS,CAAC,oBAAoB,CAAC;AAAA,MAC/B,WAAW;AAAA,MACX,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,gBAAgB,sBAAsB,sBAAsB,uBAAwC;AAC1G,WAAO;AAAA,EACT;AAGA,iBAAe,oBAAoB,OAGhC;AACD,UAAM,EAAE,MAAM,KAAK,IAAI;AACvB,UAAM,SAAS,YAAY,aAAa,MAAM,UAAU,MAAM,QAAQ,CAAC;AACvE,UAAM,gBAAgB,YAAY,WAAW,MAAM,QAAQ,MAAM,EAAE,aAAa;AAEhF,gBAAY,cAAc,MAAM;AAC9B,UAAI,MAAM,eAAe,OAAO;AAG9B,0BAAkB,IAAI,IAAI,UAAU,EAAE,GAAG,cAAc,CAAC;AAQxD,8BAAsB,IAAI,IAAI,UAAU,EAAE,GAAG,cAAc,CAAC;AAE5D,wBAAgB,IAAI,IAAI,MAAM,UAAU,CAAC;AAEzC,kBAAU,IAAI,IAAI,MAAM,aAAa,CAAC;AAEtC,qBAAa,IAAI,IAAI,EAAE,gBAAgB,MAAM,eAAe;AAE5D,oCAA4B,IAAI,IAAI,EAAE,OAAO,MAAM,MAAM;AAAA,MAC3D;AAAA,IACF,CAAC;AAED,UAAM,oBAAmC,iBAAiB,EAAE,GAAG,eAAe,GAAG,KAAK,CAAC;AAEvF,QAAI,kBAAkB,WAAW,SAAS,UAAU,MAAM,QAAW;AAInE,YAAM;AAAA,QACJ;AAAA,QACA,YACE,MAAM,OAAO,OAAO,iBAAiB,GAAG;AAAA,UACtC,WAAW;AAAA,UACX,SAAS;AAAA,YACP,UAAU;AAAA,cACR,OAAO,4BAA4B,IAAI,GAAG,SAAS,gBAAgB;AAAA,YACrE,CAAC;AAAA,YACD,sBAAsB;AAAA,YACtB,eAAe;AAAA;AAAA;AAAA,UAGjB;AAAA,UACA,QAAQ;AAAA,UACR,QAAQ,aAAa,IAAI,GAAG;AAAA;AAAA,QAC9B,CAAC;AAAA,MACL;AAGA,YAAM,UAAU;AAAA,QAAY;AAAA,QAAe,MACzC,YAAY,6BAA6B,UAAU,iBAAiB,CAAC;AAAA,MACvE;AACA,mBAAa,gBAAgB,YAAY,aAAa,mBAAmB,OAAO,CAAC;AAAA,IACnF;AAEA,UAAM,UAAU,MAAM,MAAM,6BAA6B,iBAAiB;AAC1E,QAAI,SAAmC;AAEvC,QAAI,CAAC,SAAS;AACZ,YAAM,mBAAmB,MAAM,KAAK,MAAM,OAAO,6BAA6B,iBAAiB,CAAC;AAEhG,eAAS,iBAAiB,IAAI,CAAC,WAAW;AAAA,QACxC,SAAS,MAAM;AAAA,QACf,MAAM,MAAM;AAAA,QACZ,QAAQ,MAAM;AAAA,QACd,OAAO,MAAM;AAAA,MACf,EAAE;AAAA,IACJ;AAGA,UAAM,iBAAiB,UAAU,oBAAqB;AAGtD,QAAI,eAAe,WAAW,SAAS,UAAU,MAAM,QAAW;AAChE,YAAM,aAAa,MAAM,SAAS,2BAA2B,GAAG,UAAU;AAE1E,qBAAe,WAAW,SAAS,UAAU,IAAI,iBAAiB,gBAAgB;AAAA,QAChF,GAAI,MAAM,SAAS,2BAA2B,KAAK,CAAC;AAAA,QACpD,YAAY,eAAe,SAAY,SAAY,CAAC;AAAA,MACtD,CAAC,EAAE;AAAA,IACL;AAGA,cAAU,UAAU,IAAI,IAAI,qBAAqB,gBAAgB,MAAM,SAAS;AAGhF,WAAO;AAAA,MACL;AAAA,MACA,UAAU,UAAU,UAAU,IAAI;AAAA,IACpC;AAAA,EACF;AAIA,iBAAe,YAAY,OAA+B;AACxD,UAAM,EAAE,MAAM,KAAK,IAAI;AAEvB,UAAM,UAAU,MAAM;AAAA,MACpB;AAAA,MACA,YAAY,MAAM,aAAa,EAAE,GAAG,OAAO,OAAO,MAAM,SAAS,gBAAgB,MAAM,CAAC;AAAA,IAC1F;AAGA,UAAM,aAAa,eAAe,YAAY;AAC5C,UAAI,CAAC,QAAQ,IAAI;AACf,gBAAQ,MAAM,6BAA6B,IAAI,+BAA+B;AAE9E,kBAAU,UAAU,IAAI,IAAI;AAAA,UAC1B,GAAG;AAAA,UACH,SAAS;AAAA,UACT,MAAM;AAAA,YACJ,OAAO,aAAa,IAAI;AAAA,YACxB,SAAS;AAAA,UACX;AAAA,QACF;AAEA;AAAA,MACF;AAEA,UAAI,CAAC,SAAS,QAAQ,IAAI,GAAG;AAC3B,gBAAQ,MAAM,4BAA4B,IAAI,wCAAwC;AAEtF,kBAAU,UAAU,IAAI,IAAI;AAAA,UAC1B,GAAG;AAAA,UACH,SAAS;AAAA,UACT,MAAM;AAAA,YACJ,OAAO,aAAa,IAAI;AAAA,YACxB,SAAS;AAAA,UACX;AAAA,QACF;AAEA;AAAA,MACF;AAEA,YAAM,EAAE,OAAO,IAAI,MAAM,oBAAoB;AAAA,QAC3C,GAAG;AAAA,QACH,UAAU,QAAQ;AAAA,QAClB,gBAAgB,kBAAkB,KAAK;AAAA,MACzC,CAAC;AAED,UAAI,QAAQ;AACV,gBAAQ,KAAK,sCAAsC,MAAM;AAAA,MAC3D;AAAA,IACF,CAAC;AAAA,EACH;AAIA,QAAM,2BAA2B,CAAC,SAAiB;AACjD,WAAO;AAAA,MACL,aAAa,eAAe,gBAAgB,UAAU,CAAC,CAAC;AAAA,MACxD,gBAAgB,IAAI,KAAK,CAAC;AAAA,IAC5B;AAAA,EACF;AAIA,QAAM,oBAAoB,oBAAI,IAAI;AAElC,SAAO;AAAA,IACL,IAAI,YAAY;AACd,aAAO;AAAA,IACT;AAAA,IACA,OAAsC,KAAQ,OAAyB;AAErE,UAAI,QAAQ,eAAe,QAAQ,iBAAiB,QAAQ,aAAa;AACvE,cAAM,IAAI,MAAM,sCAAsC;AAAA,MACxD;AACA,aAAO,OAAO,WAAW,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC;AAAA,IAC3C;AAAA,IACA,eACE,MACA,KACA,OACA;AACA,YAAM,kBAAkB,UAAU,UAAU,SAAS,WAAW,sBAAsB,IAAI,IAAI;AAE9F,UAAI,CAAC,iBAAiB;AACpB,cAAM;AAAA,MACR;AAEA,aAAO,OAAO,iBAAiB,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC;AAAA,IACjD;AAAA,IACA,MAAM,gBAAgB,cAAsB,OAAgC;AAC1E,YAAM,kBAAkB,UAAU,UAAU,YAAY;AAExD,UAAI,CAAC,iBAAiB;AACpB,eAAO,QAAQ,MAAM,aAAa,YAAY,oCAAoC;AAAA,MACpF;AAGA,YAAM,EAAE,OAAO,IAAI,MAAM,oBAAoB;AAAA,QAC3C,MAAM;AAAA,QACN,UAAU;AAAA;AAAA,QAEV,MAAM;AAAA,UACJ,wBAAwB,gBAAgB,sBAAsB;AAAA,UAC9D,0BAA0B,gBAAgB,wBAAwB;AAAA,QACpE;AAAA,QACA,YAAY;AAAA,MACd,CAAC;AAED,UAAI,QAAQ;AACV,gBAAQ,KAAK,sCAAsC,MAAM;AAAA,MAC3D;AAAA,IACF;AAAA,IACA,SAAS,OAAO,SAAmB;AACjC,YAAM,iBAAiB,UAAU;AAEjC,YAAM,SAAS,eAAe,gBAAgB,IAAI;AAElD,UAAI,CAAC,SAAS,MAAM,GAAG;AACrB,gBAAQ;AAAA,UACN,gDAAgD,KAAK,KAAK,IAAI,CAAC,2BAA2B,OAAO,MAAM;AAAA,QACzG;AACA;AAAA,MACF;AAIA,aAAO,OAAO,QAAQ;AAAA,QACpB,MAAM;AAAA,QACN,WAAW;AAAA,QACX,SAAS,CAAC,UAAU,GAAG,cAAc,GAAG,sBAAsB,CAAC;AAAA,QAC/D,QAAQ;AAAA,QACR,cAAc;AAAA,MAChB,CAAC;AAAA,IACH;AAAA,IACA;AAAA,IACA,IAAI,SAAS;AACX,aAAO,yBAAyB,sBAAsB,CAAC;AAAA,IACzD;AAAA,IACA,gBAAgB,CAAC,cAAsB,WAA4B;AACjE,YAAM,uBAAuB,sBAAsB,YAAY;AAE/D,UAAI,CAAC,sBAAsB;AACzB;AAAA,MACF;AAEA,UAAI,WAAW,QAAQ;AACrB,eAAO,KAAK,UAAU,oBAAoB;AAAA,MAC5C;AAEA,aAAO,KAAK,UAAU,oBAAoB;AAAA,IAC5C;AAAA,IACA;AAAA,IACA,MAAM,sBAAsB,cAAsB;AAChD,YAAM,oBAAoB,UAAU,UAAU,YAAY;AAC1D,YAAM,eAAe,sBAAsB,YAAY;AAEvD,UAAI,CAAC,qBAAqB,CAAC,cAAc;AACvC;AAAA,MACF;AAEA,YAAM,EAAE,OAAO,IAAI,MAAM,oBAAoB;AAAA,QAC3C,MAAM;AAAA,QACN,UAAU;AAAA,QACV,YAAY;AAAA,MACd,CAAC;AAED,UAAI,QAAQ;AACV,gBAAQ,KAAK,sCAAsC,MAAM;AAAA,MAC3D;AAAA,IACF;AAAA,IACA,eAAe,cAAsB;AAEnC,cAAQ,KAAK,kCAAkC,YAAY,2BAA2B;AAAA,IACxF;AAAA,IACA,kBAAkB;AAChB,aAAO,KAAK,UAAU;AAAA,QACpB,WAAW;AAAA,UACT,GAAG,OAAO;AAAA,YACR,OAAO,QAAQ,UAAU,SAAS,EAAE,IAAI,CAAC,CAAC,MAAM,GAAG,MAAM;AAAA,cACvD;AAAA;AAAA;AAAA,cAGA,OAAO,GAAG;AAAA,YACZ,CAAC;AAAA,UACH;AAAA,QACF;AAAA,QACA,MAAM,gBAAgB,QAAQ,CAAC;AAAA,QAC/B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAA6B;AAAA,IAC/B;AAAA,IACA,cAAc,OAAe;AAC3B,YAAM,SAAS,YAAY,yBAAyB,KAAK,MAAM,KAAK,CAAC;AAGrE;AAAA,QACE,UAAU;AAAA,QACV,OAAO;AAAA,UACL,OAAO,QAAQ,OAAO,SAAS,EAAE,IAAI,CAAC,CAAC,MAAM,GAAG,MAAM;AAAA,YACpD;AAAA,YACA,qBAAqB,iBAAiB,GAAG,GAAG,OAAO,UAAU,IAAI,CAAC;AAAA,UACpE,CAAC;AAAA,QACH;AAAA,MACF;AAEA,iBAAW,mBAAmB,OAAO,iBAAiB;AACtD,iBAAW,uBAAuB,OAAO,qBAAqB;AAC9D,iBAAW,iBAAiB,OAAO,eAAe;AAClD,iBAAW,WAAW,OAAO,SAAS;AACtC,iBAAW,WAAW,OAAO,IAAI;AACjC,iBAAW,cAAc,OAAO,YAAY;AAAA,IAC9C;AAAA,IACA,kCAAkC,CAAC,kBAA0C;AAC3E,YAAM,EAAE,WAAW,WAAAA,YAAW,MAAM,WAAW,kBAAkB,GAAG,KAAK,IAAI;AAG7E,iBAAW,WAAW,IAAI;AAG1B,aAAO,QAAQ;AAAA,QACb,OAAO,QAAQ,aAAa,CAAC,CAAC,EAAE;AAAA,UAAI,CAAC,CAAC,MAAM,GAAG,MAC7C,YAAY,EAAE,KAAK,IAAI,MAAM,MAAM,WAAWA,aAAY,IAAI,EAAE,CAAC;AAAA,QACnE;AAAA,MACF;AAAA,IACF;AAAA,IACA,gBAAgB,CAAC,cAAc,mBAAmB,sBAAsB;AACtE,YAAM,YAAY,YAAY,4BAA4B,QAAQ,iBAAiB,EAAE,aAAa;AAElG,YAAM,mBAAmB,kBAAkB,YAAY;AACvD,YAAM,uBAAuB,sBAAsB,YAAY;AAC/D,YAAM,iBAAiB,UAAU,UAAU,YAAY,IAAI,OAAO,UAAU,UAAU,YAAY,CAAC,IAAI;AAEvG,UAAI,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,gBAAgB;AAEjE,eAAO,QAAQ,MAAM,8EAA8E;AAAA,MACrG;AAGA,YAAM,cAAc,KAAK,kBAAkB,SAAS;AACpD,YAAM,cAAc,KAAK,kBAAkB,oBAAoB;AAE/D,YAAM,WAAW,MAAM,aAAa,WAAW;AAE/C,UAAI,sBAAsB,QAAW;AAEnC,eAAO,SAAS;AAAA,MAClB;AAEA,YAAM,aAAa,SAAS,MAAM,OAAO,iBAAiB;AAG1D,YAAM,0BAA0B,MAAM,UAAU,gBAAgB,GAAG,UAAU;AAC7E,4BAAsB,YAAY,IAAI;AAGtC,wBAAkB,YAAY,IAAI;AAGlC,YAAM,cAAc,KAAK,sBAAsB,uBAAuB;AACtE,YAAM,cAAc,KAAK,sBAAsB,cAAc;AAE7D,YAAM,WAAW,MAAM,aAAa,WAAW;AAI/C,YAAM,aAAa,SAAS,MAAM,OAAO,SAAS,UAAU,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;AAElF,YAAM,oBAAoB;AAAA,QACxB;AAAA,QACA,MAAM,UAAU,uBAAuB,GAAG,UAAU;AAAA,MACtD;AAGA,gBAAU,UAAU,YAAY,IAAI;AAAA,QAClC,iBAAiB,EAAE,GAAG,kBAAkB,CAAC;AAAA,QACzC,UAAU,YAAY;AAAA,MACxB;AACA;AAAA,IACF;AAAA,EACF;AACF;AAGA,SAAS,8BAA8B;",
|
|
6
6
|
"names": ["overrides"]
|
|
7
7
|
}
|
package/dist/plugins.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAO,eAahC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,QAAO,eA+BxC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,QAAO,eAwCjC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,mBAAmB,QAAO,eAuBtC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,OAAO,QAAO,
|
|
1
|
+
{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAO,eAahC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,QAAO,eA+BxC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,QAAO,eAwCjC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,mBAAmB,QAAO,eAuBtC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,eAAO,MAAM,OAAO,QAAO,eA0B1B,CAAA"}
|
package/dist/plugins.js
CHANGED
package/dist/plugins.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/plugins.ts"],
|
|
4
|
-
"sourcesContent": ["/**\n * This file contains a collection of plugins used for the bundler.\n * Plugins defined here can extend or modify the behavior of the bundling process,\n * such as adding lifecycle hooks or custom processing logic.\n */\nimport { isLocalRef } from '@/helpers/general'\nimport type { LifecyclePlugin } from '@scalar/json-magic/bundle'\n\n/**\n * A lifecycle plugin that adds a `$status` property to nodes during resolution.\n * - Sets `$status` to 'loading' when resolution starts.\n * - Sets `$status` to 'error' if resolution fails.\n * - Removes `$status` when resolution succeeds.\n */\nexport const loadingStatus = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onResolveStart: (node) => {\n node['$status'] = 'loading'\n },\n onResolveError: (node) => {\n node['$status'] = 'error'\n },\n onResolveSuccess: (node) => {\n delete node['$status']\n },\n }\n}\n\n/**\n * Lifecycle plugin to resolve and embed external content referenced by an 'externalValue' property in a node.\n *\n * When a node contains an 'externalValue' property (as a string), this plugin will:\n * - Fetch the external resource (such as a URL or file) using the fetchUrls plugin.\n * - If the fetch is successful, assign the fetched data to the node's 'value' property.\n *\n * This is useful for inlining external content (like examples or schemas) into the OpenAPI document during bundling.\n *\n * @param node - The node being processed, which may contain an 'externalValue' property.\n */\nexport const externalValueResolver = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onAfterNodeProcess: async (node, context) => {\n const externalValue = node['externalValue']\n const cache = context.resolutionCache\n\n // Only process if 'externalValue' is a string\n if (typeof externalValue !== 'string') {\n return\n }\n\n const loader = context.loaders.find((it) => it.validate(externalValue))\n\n // We can not process the external value\n if (!loader) {\n return\n }\n\n if (!cache.has(externalValue)) {\n cache.set(externalValue, loader.exec(externalValue))\n }\n\n const result = await cache.get(externalValue)\n\n // If fetch is successful, assign the data to the node's 'value' property\n if (result?.ok) {\n node['value'] = result.data\n }\n },\n }\n}\n\n/**\n * Lifecycle plugin to resolve $ref on any object, including non-standard locations like the info object.\n *\n * This plugin will:\n * - Detect if a node contains a $ref property (as a string).\n * - If the node is under the 'info' path, attempt to resolve the reference using fetchUrls.\n * - Replace the node's properties with the resolved data if successful.\n *\n * Note: This currently only supports refs on the 'info' object and does not handle primitive types.\n */\nexport const refsEverywhere = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onBeforeNodeProcess: async (node, context) => {\n const { path, resolutionCache, parentNode } = context\n const ref = node['$ref']\n\n // Only process nodes that have a $ref property as a string\n if (typeof ref !== 'string') {\n return\n }\n\n // Can not resolve top level refs\n if (!parentNode || !path.length) {\n return\n }\n\n const loader = context.loaders.find((it) => it.validate(ref))\n\n // Can not load the external ref\n if (!loader) {\n return\n }\n\n // Support resolving $ref on the info object\n if (path[0] === 'info') {\n // Use the cache to avoid duplicate fetches\n if (!resolutionCache.has(ref)) {\n resolutionCache.set(ref, loader.exec(ref))\n }\n\n const result = await resolutionCache.get(ref)\n\n if (result?.ok) {\n // Replace the ref with the resolved data\n parentNode[path.at(-1)!] = result.data\n }\n }\n },\n }\n}\n\n/**\n * Lifecycle plugin to restore original $ref values after processing.\n *\n * This plugin is intended to be used as a \"lifecycle\" plugin in the bundling process.\n * It operates in the `onAfterNodeProcess` hook, and its main purpose is to restore\n * the original $ref values for external references that may have been replaced or\n * rewritten during the bundling process.\n *\n * How it works:\n * - For each node processed, if the node contains a $ref property (as a string),\n * and the root document contains an \"x-ext-urls\" mapping object,\n * the plugin will attempt to restore the original $ref value.\n * - The \"x-ext-urls\" object is expected to be a mapping from the rewritten $ref\n * (e.g., a hashed or compressed reference) back to the original external URL or path.\n * - If a mapping exists for the current $ref, the plugin replaces the $ref value\n * with the original value from the mapping. If no mapping exists (e.g., for local refs),\n * the $ref value is left unchanged.\n *\n * This is useful for scenarios where you want to present or export the bundled document\n * with the original external $ref values, rather than the internal or rewritten ones.\n *\n * @returns {LifecyclePlugin} The plugin object for use in the bundler.\n */\nexport const restoreOriginalRefs = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onBeforeNodeProcess: (node, context) => {\n const ref = node['$ref']\n const root = context.rootNode\n const extUrls = root['x-ext-urls']\n\n // Only process if $ref is a string and x-ext-urls is a valid object\n if (typeof ref !== 'string' || typeof extUrls !== 'object' || extUrls === null || !isLocalRef(ref)) {\n return\n }\n\n // Working with local refs\n\n const segments = ref.split('/')\n const key = segments.at(-1) ?? ''\n\n // Replace the $ref with the original version from the mapping,\n // or keep the current version if there is no mapping (e.g., for local refs)\n node['$ref'] = (extUrls as Record<string, string>)[key] ?? ref\n },\n }\n}\n\n/**\n * Lifecycle plugin to automatically add missing \"type\" fields to OpenAPI/JSON Schema nodes.\n *\n * This plugin is intended for use as a \"lifecycle\" plugin during the bundling process.\n * It ensures that schema objects are explicitly typed, improving compatibility with OpenAPI tools and validators.\n *\n * Behavior:\n * - If a schema object has a \"properties\" field but no \"type\", it sets \"type\" to \"object\".\n * This is required for schemas that define properties but omit the type.\n *\n * - If a schema object contains any array-related keywords (\"items\", \"prefixItems\", \"minItems\", \"maxItems\", or \"uniqueItems\")\n * and lacks a \"type\", it sets \"type\" to \"array\". This clarifies the intent for array schemas missing an explicit type.\n *\n * - If a schema object has a \"pattern\" field but no \"type\", it sets \"type\" to \"string\".\n * This ensures that pattern constraints are only applied to string-typed schemas.\n *\n * Usage:\n * Add this plugin to the bundler to automatically fix schemas missing \"type: object\", \"type: array\", or \"type: string\"\n * when defining properties, array-related keywords, or pattern constraints.\n *\n * Examples:\n * // Before:\n * { properties: { foo: { type: \"string\" } } }\n * // After:\n * { type: \"object\", properties: { foo: { type: \"string\" } } }\n *\n * // Before:\n * { items: { type: \"string\" } }\n * // After:\n * { type: \"array\", items: { type: \"string\" } }\n *\n * // Before:\n * { pattern: \"^[a-z]+$\" }\n * // After:\n * { type: \"string\", pattern: \"^[a-z]+$\" }\n */\nexport const cleanUp = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onBeforeNodeProcess: (node) => {\n // If the node has \"properties\" but no \"type\", set \"type\" to \"object\"\n if ('properties' in node && !('type' in node)) {\n node['type'] = 'object'\n }\n\n // Set type to 'array' for schemas that have array-related keywords but are missing a type\n const arrayKeywords = ['items', 'prefixItems', 'minItems', 'maxItems', 'uniqueItems']\n if (arrayKeywords.some((it) => Object.hasOwn(node, it)) && !('type' in node)) {\n node['type'] = 'array'\n }\n\n // If the node has \"pattern\" but no \"type\", set \"type\" to \"string\"\n if ('pattern' in node && !('type' in node)) {\n node['type'] = 'string'\n }\n },\n }\n}\n"],
|
|
5
|
-
"mappings": "AAKA,SAAS,kBAAkB;AASpB,MAAM,gBAAgB,MAAuB;AAClD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,gBAAgB,CAAC,SAAS;AACxB,WAAK,SAAS,IAAI;AAAA,IACpB;AAAA,IACA,gBAAgB,CAAC,SAAS;AACxB,WAAK,SAAS,IAAI;AAAA,IACpB;AAAA,IACA,kBAAkB,CAAC,SAAS;AAC1B,aAAO,KAAK,SAAS;AAAA,IACvB;AAAA,EACF;AACF;AAaO,MAAM,wBAAwB,MAAuB;AAC1D,SAAO;AAAA,IACL,MAAM;AAAA,IACN,oBAAoB,OAAO,MAAM,YAAY;AAC3C,YAAM,gBAAgB,KAAK,eAAe;AAC1C,YAAM,QAAQ,QAAQ;AAGtB,UAAI,OAAO,kBAAkB,UAAU;AACrC;AAAA,MACF;AAEA,YAAM,SAAS,QAAQ,QAAQ,KAAK,CAAC,OAAO,GAAG,SAAS,aAAa,CAAC;AAGtE,UAAI,CAAC,QAAQ;AACX;AAAA,MACF;AAEA,UAAI,CAAC,MAAM,IAAI,aAAa,GAAG;AAC7B,cAAM,IAAI,eAAe,OAAO,KAAK,aAAa,CAAC;AAAA,MACrD;AAEA,YAAM,SAAS,MAAM,MAAM,IAAI,aAAa;AAG5C,UAAI,QAAQ,IAAI;AACd,aAAK,OAAO,IAAI,OAAO;AAAA,MACzB;AAAA,IACF;AAAA,EACF;AACF;AAYO,MAAM,iBAAiB,MAAuB;AACnD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,qBAAqB,OAAO,MAAM,YAAY;AAC5C,YAAM,EAAE,MAAM,iBAAiB,WAAW,IAAI;AAC9C,YAAM,MAAM,KAAK,MAAM;AAGvB,UAAI,OAAO,QAAQ,UAAU;AAC3B;AAAA,MACF;AAGA,UAAI,CAAC,cAAc,CAAC,KAAK,QAAQ;AAC/B;AAAA,MACF;AAEA,YAAM,SAAS,QAAQ,QAAQ,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,CAAC;AAG5D,UAAI,CAAC,QAAQ;AACX;AAAA,MACF;AAGA,UAAI,KAAK,CAAC,MAAM,QAAQ;AAEtB,YAAI,CAAC,gBAAgB,IAAI,GAAG,GAAG;AAC7B,0BAAgB,IAAI,KAAK,OAAO,KAAK,GAAG,CAAC;AAAA,QAC3C;AAEA,cAAM,SAAS,MAAM,gBAAgB,IAAI,GAAG;AAE5C,YAAI,QAAQ,IAAI;AAEd,qBAAW,KAAK,GAAG,EAAE,CAAE,IAAI,OAAO;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAyBO,MAAM,sBAAsB,MAAuB;AACxD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,qBAAqB,CAAC,MAAM,YAAY;AACtC,YAAM,MAAM,KAAK,MAAM;AACvB,YAAM,OAAO,QAAQ;AACrB,YAAM,UAAU,KAAK,YAAY;AAGjC,UAAI,OAAO,QAAQ,YAAY,OAAO,YAAY,YAAY,YAAY,QAAQ,CAAC,WAAW,GAAG,GAAG;AAClG;AAAA,MACF;AAIA,YAAM,WAAW,IAAI,MAAM,GAAG;AAC9B,YAAM,MAAM,SAAS,GAAG,EAAE,KAAK;AAI/B,WAAK,MAAM,IAAK,QAAmC,GAAG,KAAK;AAAA,IAC7D;AAAA,EACF;AACF;AAsCO,MAAM,UAAU,MAAuB;AAC5C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,qBAAqB,CAAC,SAAS;AAE7B,UAAI,gBAAgB,QAAQ,EAAE,UAAU,OAAO;AAC7C,aAAK,MAAM,IAAI;AAAA,MACjB;AAGA,YAAM,gBAAgB,CAAC,SAAS,eAAe,YAAY,YAAY,aAAa;AACpF,UAAI,cAAc,KAAK,CAAC,OAAO,OAAO,OAAO,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,OAAO;AAC5E,aAAK,MAAM,IAAI;AAAA,MACjB;AAGA,UAAI,aAAa,QAAQ,EAAE,UAAU,OAAO;AAC1C,aAAK,MAAM,IAAI;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AACF;",
|
|
4
|
+
"sourcesContent": ["/**\n * This file contains a collection of plugins used for the bundler.\n * Plugins defined here can extend or modify the behavior of the bundling process,\n * such as adding lifecycle hooks or custom processing logic.\n */\nimport { isLocalRef } from '@/helpers/general'\nimport type { LifecyclePlugin } from '@scalar/json-magic/bundle'\n\n/**\n * A lifecycle plugin that adds a `$status` property to nodes during resolution.\n * - Sets `$status` to 'loading' when resolution starts.\n * - Sets `$status` to 'error' if resolution fails.\n * - Removes `$status` when resolution succeeds.\n */\nexport const loadingStatus = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onResolveStart: (node) => {\n node['$status'] = 'loading'\n },\n onResolveError: (node) => {\n node['$status'] = 'error'\n },\n onResolveSuccess: (node) => {\n delete node['$status']\n },\n }\n}\n\n/**\n * Lifecycle plugin to resolve and embed external content referenced by an 'externalValue' property in a node.\n *\n * When a node contains an 'externalValue' property (as a string), this plugin will:\n * - Fetch the external resource (such as a URL or file) using the fetchUrls plugin.\n * - If the fetch is successful, assign the fetched data to the node's 'value' property.\n *\n * This is useful for inlining external content (like examples or schemas) into the OpenAPI document during bundling.\n *\n * @param node - The node being processed, which may contain an 'externalValue' property.\n */\nexport const externalValueResolver = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onAfterNodeProcess: async (node, context) => {\n const externalValue = node['externalValue']\n const cache = context.resolutionCache\n\n // Only process if 'externalValue' is a string\n if (typeof externalValue !== 'string') {\n return\n }\n\n const loader = context.loaders.find((it) => it.validate(externalValue))\n\n // We can not process the external value\n if (!loader) {\n return\n }\n\n if (!cache.has(externalValue)) {\n cache.set(externalValue, loader.exec(externalValue))\n }\n\n const result = await cache.get(externalValue)\n\n // If fetch is successful, assign the data to the node's 'value' property\n if (result?.ok) {\n node['value'] = result.data\n }\n },\n }\n}\n\n/**\n * Lifecycle plugin to resolve $ref on any object, including non-standard locations like the info object.\n *\n * This plugin will:\n * - Detect if a node contains a $ref property (as a string).\n * - If the node is under the 'info' path, attempt to resolve the reference using fetchUrls.\n * - Replace the node's properties with the resolved data if successful.\n *\n * Note: This currently only supports refs on the 'info' object and does not handle primitive types.\n */\nexport const refsEverywhere = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onBeforeNodeProcess: async (node, context) => {\n const { path, resolutionCache, parentNode } = context\n const ref = node['$ref']\n\n // Only process nodes that have a $ref property as a string\n if (typeof ref !== 'string') {\n return\n }\n\n // Can not resolve top level refs\n if (!parentNode || !path.length) {\n return\n }\n\n const loader = context.loaders.find((it) => it.validate(ref))\n\n // Can not load the external ref\n if (!loader) {\n return\n }\n\n // Support resolving $ref on the info object\n if (path[0] === 'info') {\n // Use the cache to avoid duplicate fetches\n if (!resolutionCache.has(ref)) {\n resolutionCache.set(ref, loader.exec(ref))\n }\n\n const result = await resolutionCache.get(ref)\n\n if (result?.ok) {\n // Replace the ref with the resolved data\n parentNode[path.at(-1)!] = result.data\n }\n }\n },\n }\n}\n\n/**\n * Lifecycle plugin to restore original $ref values after processing.\n *\n * This plugin is intended to be used as a \"lifecycle\" plugin in the bundling process.\n * It operates in the `onAfterNodeProcess` hook, and its main purpose is to restore\n * the original $ref values for external references that may have been replaced or\n * rewritten during the bundling process.\n *\n * How it works:\n * - For each node processed, if the node contains a $ref property (as a string),\n * and the root document contains an \"x-ext-urls\" mapping object,\n * the plugin will attempt to restore the original $ref value.\n * - The \"x-ext-urls\" object is expected to be a mapping from the rewritten $ref\n * (e.g., a hashed or compressed reference) back to the original external URL or path.\n * - If a mapping exists for the current $ref, the plugin replaces the $ref value\n * with the original value from the mapping. If no mapping exists (e.g., for local refs),\n * the $ref value is left unchanged.\n *\n * This is useful for scenarios where you want to present or export the bundled document\n * with the original external $ref values, rather than the internal or rewritten ones.\n *\n * @returns {LifecyclePlugin} The plugin object for use in the bundler.\n */\nexport const restoreOriginalRefs = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onBeforeNodeProcess: (node, context) => {\n const ref = node['$ref']\n const root = context.rootNode\n const extUrls = root['x-ext-urls']\n\n // Only process if $ref is a string and x-ext-urls is a valid object\n if (typeof ref !== 'string' || typeof extUrls !== 'object' || extUrls === null || !isLocalRef(ref)) {\n return\n }\n\n // Working with local refs\n\n const segments = ref.split('/')\n const key = segments.at(-1) ?? ''\n\n // Replace the $ref with the original version from the mapping,\n // or keep the current version if there is no mapping (e.g., for local refs)\n node['$ref'] = (extUrls as Record<string, string>)[key] ?? ref\n },\n }\n}\n\n/**\n * Lifecycle plugin to automatically add missing \"type\" fields to OpenAPI/JSON Schema nodes.\n *\n * This plugin is intended for use as a \"lifecycle\" plugin during the bundling process.\n * It ensures that schema objects are explicitly typed, improving compatibility with OpenAPI tools and validators.\n *\n * Behavior:\n * - If a schema object has a \"properties\" field but no \"type\", it sets \"type\" to \"object\".\n * This is required for schemas that define properties but omit the type.\n *\n * - If a schema object contains any array-related keywords (\"items\", \"prefixItems\", \"minItems\", \"maxItems\", or \"uniqueItems\")\n * and lacks a \"type\", it sets \"type\" to \"array\". This clarifies the intent for array schemas missing an explicit type.\n *\n * - If a schema object has a \"pattern\" field but no \"type\", it sets \"type\" to \"string\".\n * This ensures that pattern constraints are only applied to string-typed schemas.\n *\n * Usage:\n * Add this plugin to the bundler to automatically fix schemas missing \"type: object\", \"type: array\", or \"type: string\"\n * when defining properties, array-related keywords, or pattern constraints.\n *\n * Examples:\n * // Before:\n * { properties: { foo: { type: \"string\" } } }\n * // After:\n * { type: \"object\", properties: { foo: { type: \"string\" } } }\n *\n * // Before:\n * { items: { type: \"string\" } }\n * // After:\n * { type: \"array\", items: { type: \"string\" } }\n *\n * // Before:\n * { pattern: \"^[a-z]+$\" }\n * // After:\n * { type: \"string\", pattern: \"^[a-z]+$\" }\n */\nexport const cleanUp = (): LifecyclePlugin => {\n return {\n type: 'lifecycle',\n onBeforeNodeProcess: (node) => {\n // If the node has \"properties\" but no \"type\", set \"type\" to \"object\"\n if ('properties' in node && !('type' in node)) {\n node['type'] = 'object'\n }\n\n // Set type to 'array' for schemas that have array-related keywords but are missing a type\n const arrayKeywords = ['items', 'prefixItems', 'minItems', 'maxItems', 'uniqueItems']\n if (arrayKeywords.some((it) => Object.hasOwn(node, it)) && !('type' in node)) {\n node['type'] = 'array'\n }\n\n // If the node has \"pattern\" but no \"type\", set \"type\" to \"string\"\n if ('pattern' in node && !('type' in node)) {\n node['type'] = 'string'\n }\n\n // Convert required: null to required: [] for object schemas\n if ('required' in node && node.required === null && 'properties' in node) {\n node.required = []\n }\n },\n }\n}\n"],
|
|
5
|
+
"mappings": "AAKA,SAAS,kBAAkB;AASpB,MAAM,gBAAgB,MAAuB;AAClD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,gBAAgB,CAAC,SAAS;AACxB,WAAK,SAAS,IAAI;AAAA,IACpB;AAAA,IACA,gBAAgB,CAAC,SAAS;AACxB,WAAK,SAAS,IAAI;AAAA,IACpB;AAAA,IACA,kBAAkB,CAAC,SAAS;AAC1B,aAAO,KAAK,SAAS;AAAA,IACvB;AAAA,EACF;AACF;AAaO,MAAM,wBAAwB,MAAuB;AAC1D,SAAO;AAAA,IACL,MAAM;AAAA,IACN,oBAAoB,OAAO,MAAM,YAAY;AAC3C,YAAM,gBAAgB,KAAK,eAAe;AAC1C,YAAM,QAAQ,QAAQ;AAGtB,UAAI,OAAO,kBAAkB,UAAU;AACrC;AAAA,MACF;AAEA,YAAM,SAAS,QAAQ,QAAQ,KAAK,CAAC,OAAO,GAAG,SAAS,aAAa,CAAC;AAGtE,UAAI,CAAC,QAAQ;AACX;AAAA,MACF;AAEA,UAAI,CAAC,MAAM,IAAI,aAAa,GAAG;AAC7B,cAAM,IAAI,eAAe,OAAO,KAAK,aAAa,CAAC;AAAA,MACrD;AAEA,YAAM,SAAS,MAAM,MAAM,IAAI,aAAa;AAG5C,UAAI,QAAQ,IAAI;AACd,aAAK,OAAO,IAAI,OAAO;AAAA,MACzB;AAAA,IACF;AAAA,EACF;AACF;AAYO,MAAM,iBAAiB,MAAuB;AACnD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,qBAAqB,OAAO,MAAM,YAAY;AAC5C,YAAM,EAAE,MAAM,iBAAiB,WAAW,IAAI;AAC9C,YAAM,MAAM,KAAK,MAAM;AAGvB,UAAI,OAAO,QAAQ,UAAU;AAC3B;AAAA,MACF;AAGA,UAAI,CAAC,cAAc,CAAC,KAAK,QAAQ;AAC/B;AAAA,MACF;AAEA,YAAM,SAAS,QAAQ,QAAQ,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,CAAC;AAG5D,UAAI,CAAC,QAAQ;AACX;AAAA,MACF;AAGA,UAAI,KAAK,CAAC,MAAM,QAAQ;AAEtB,YAAI,CAAC,gBAAgB,IAAI,GAAG,GAAG;AAC7B,0BAAgB,IAAI,KAAK,OAAO,KAAK,GAAG,CAAC;AAAA,QAC3C;AAEA,cAAM,SAAS,MAAM,gBAAgB,IAAI,GAAG;AAE5C,YAAI,QAAQ,IAAI;AAEd,qBAAW,KAAK,GAAG,EAAE,CAAE,IAAI,OAAO;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAyBO,MAAM,sBAAsB,MAAuB;AACxD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,qBAAqB,CAAC,MAAM,YAAY;AACtC,YAAM,MAAM,KAAK,MAAM;AACvB,YAAM,OAAO,QAAQ;AACrB,YAAM,UAAU,KAAK,YAAY;AAGjC,UAAI,OAAO,QAAQ,YAAY,OAAO,YAAY,YAAY,YAAY,QAAQ,CAAC,WAAW,GAAG,GAAG;AAClG;AAAA,MACF;AAIA,YAAM,WAAW,IAAI,MAAM,GAAG;AAC9B,YAAM,MAAM,SAAS,GAAG,EAAE,KAAK;AAI/B,WAAK,MAAM,IAAK,QAAmC,GAAG,KAAK;AAAA,IAC7D;AAAA,EACF;AACF;AAsCO,MAAM,UAAU,MAAuB;AAC5C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,qBAAqB,CAAC,SAAS;AAE7B,UAAI,gBAAgB,QAAQ,EAAE,UAAU,OAAO;AAC7C,aAAK,MAAM,IAAI;AAAA,MACjB;AAGA,YAAM,gBAAgB,CAAC,SAAS,eAAe,YAAY,YAAY,aAAa;AACpF,UAAI,cAAc,KAAK,CAAC,OAAO,OAAO,OAAO,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,OAAO;AAC5E,aAAK,MAAM,IAAI;AAAA,MACjB;AAGA,UAAI,aAAa,QAAQ,EAAE,UAAU,OAAO;AAC1C,aAAK,MAAM,IAAI;AAAA,MACjB;AAGA,UAAI,cAAc,QAAQ,KAAK,aAAa,QAAQ,gBAAgB,MAAM;AACxE,aAAK,WAAW,CAAC;AAAA,MACnB;AAAA,IACF;AAAA,EACF;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"openapi",
|
|
17
17
|
"scalar"
|
|
18
18
|
],
|
|
19
|
-
"version": "0.14.
|
|
19
|
+
"version": "0.14.2",
|
|
20
20
|
"engines": {
|
|
21
21
|
"node": ">=18"
|
|
22
22
|
},
|
|
@@ -68,16 +68,16 @@
|
|
|
68
68
|
"CHANGELOG.md"
|
|
69
69
|
],
|
|
70
70
|
"dependencies": {
|
|
71
|
-
"@sinclair/typebox": "https://raw.githubusercontent.com/DemonHa/typebox/refs/heads/amrit/build/target/
|
|
71
|
+
"@sinclair/typebox": "https://raw.githubusercontent.com/DemonHa/typebox/refs/heads/amrit/build-2/target/sinclair-typebox-0.34.40.tgz",
|
|
72
72
|
"github-slugger": "^2.0.0",
|
|
73
73
|
"type-fest": "4.41.0",
|
|
74
74
|
"vue": "^3.5.17",
|
|
75
75
|
"yaml": "2.8.0",
|
|
76
|
-
"@scalar/helpers": "0.0.8",
|
|
77
76
|
"@scalar/code-highlight": "0.1.9",
|
|
78
|
-
"@scalar/
|
|
79
|
-
"@scalar/openapi-parser": "0.20.
|
|
80
|
-
"@scalar/types": "0.2.
|
|
77
|
+
"@scalar/helpers": "0.0.8",
|
|
78
|
+
"@scalar/openapi-parser": "0.20.1",
|
|
79
|
+
"@scalar/types": "0.2.13",
|
|
80
|
+
"@scalar/json-magic": "0.3.1"
|
|
81
81
|
},
|
|
82
82
|
"devDependencies": {
|
|
83
83
|
"@google-cloud/storage": "7.16.0",
|