@scalar/schemas 0.7.0 → 0.7.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 +12 -0
- package/dist/api-reference/api-reference-configuration.d.ts +8 -4
- package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
- package/dist/api-reference/api-reference-plugin.d.ts +4 -2
- package/dist/api-reference/api-reference-plugin.d.ts.map +1 -1
- package/dist/asyncapi/3.1/reference.d.ts +6 -0
- package/dist/asyncapi/3.1/reference.d.ts.map +1 -1
- package/dist/asyncapi/3.1/reference.js +8 -2
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @scalar/schemas
|
|
2
2
|
|
|
3
|
+
## 0.7.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#9639](https://github.com/scalar/scalar/pull/9639): Add a read-only accessor for the global authentication state to the plugin API. Plugin lifecycle hooks (`onInit`, `onConfigChange`) now receive an `auth` accessor alongside `config`, and the plugin manager exposes `getAuthState()` for view components. Plugins can read stored secrets and the selected security schemes via `auth.export()`, `auth.getAuthSecrets(documentName, schemeName)`, and `auth.getAuthSelectedSchemas(payload)` without being able to mutate auth.
|
|
8
|
+
|
|
9
|
+
## 0.7.1
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [#9626](https://github.com/scalar/scalar/pull/9626): Fix AsyncAPI security scheme types being lost on ingestion. When a server referenced a scheme via `$ref`, coercion synthesized a default `$ref-value` (the first `type` literal, `userPassword`) that leaked back over the real definition through the resolved-document proxy, so every scheme rendered as `userPassword`. Reference `$ref-value` is now optional, so unresolved references pass through untouched.
|
|
14
|
+
|
|
3
15
|
## 0.7.0
|
|
4
16
|
|
|
5
17
|
### Minor Changes
|
|
@@ -71,11 +71,13 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
|
|
|
71
71
|
}>>>;
|
|
72
72
|
}>>;
|
|
73
73
|
hooks: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
|
|
74
|
-
onInit: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config }: {
|
|
74
|
+
onInit: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config, auth }: {
|
|
75
75
|
config: any;
|
|
76
|
+
auth: any;
|
|
76
77
|
}) => void>>;
|
|
77
|
-
onConfigChange: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config }: {
|
|
78
|
+
onConfigChange: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config, auth }: {
|
|
78
79
|
config: any;
|
|
80
|
+
auth: any;
|
|
79
81
|
}) => void>>;
|
|
80
82
|
onDestroy: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<() => void>>;
|
|
81
83
|
}>>;
|
|
@@ -257,11 +259,13 @@ export declare const apiReferenceConfigurationWithSourceSchema: (rawInput: unkno
|
|
|
257
259
|
}>>>;
|
|
258
260
|
}>>;
|
|
259
261
|
hooks: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
|
|
260
|
-
onInit: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config }: {
|
|
262
|
+
onInit: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config, auth }: {
|
|
261
263
|
config: any;
|
|
264
|
+
auth: any;
|
|
262
265
|
}) => void>>;
|
|
263
|
-
onConfigChange: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config }: {
|
|
266
|
+
onConfigChange: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config, auth }: {
|
|
264
267
|
config: any;
|
|
268
|
+
auth: any;
|
|
265
269
|
}) => void>>;
|
|
266
270
|
onDestroy: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<() => void>>;
|
|
267
271
|
}>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,+BAA+B
|
|
1
|
+
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oHAsGJ,MAAM,KAAK,IAAI;oHAGf,IAAI;6GAGX,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;qHAKhD;QACN,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,OAAO,CAAA;QACvB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;oHASlB;QACN,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,OAAO,CAAA;QACvB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;gHAOE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;mHAG5B,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;;;;;;;;;yHA4BzB;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;uHAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;qHAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;2HAIpD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;yHAKvD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;kHAGnD;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,KAAK,MAAM;8GAG3E,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;;;oNA+Bb,GAAG,KAAK,GAAG,KAAK,MAAM;gRAGG,GAAG,KAAK,GAAG,KAAK,MAAM;;;IAWtG,CAAA;AAKF,eAAO,MAAM,yCAAyC,GAAI,UAAU,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAzInC,MAAM,KAAK,IAAI;8BAGf,IAAI;uBAGX,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;+BAKhD;QACN,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,OAAO,CAAA;QACvB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;8BASlB;QACN,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,OAAO,CAAA;QACvB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;0BAOE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;6BAG5B,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;;;;;;;;;mCA4BzB;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;iCAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;+BAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;qCAIpD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;mCAKvD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;4BAGnD;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,KAAK,MAAM;wBAG3E,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS;gCA+Bb,GAAG,KAAK,GAAG,KAAK,MAAM;iDAGG,GAAG,KAAK,GAAG,KAAK,MAAM;CAuFvG,CAAA"}
|
|
@@ -25,11 +25,13 @@ declare const viewsSchema: import("@scalar/validation").ObjectSchema<{
|
|
|
25
25
|
}>>>;
|
|
26
26
|
}>;
|
|
27
27
|
declare const lifecycleHooksSchema: import("@scalar/validation").ObjectSchema<{
|
|
28
|
-
onInit: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config }: {
|
|
28
|
+
onInit: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config, auth }: {
|
|
29
29
|
config: any;
|
|
30
|
+
auth: any;
|
|
30
31
|
}) => void>>;
|
|
31
|
-
onConfigChange: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config }: {
|
|
32
|
+
onConfigChange: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<({ config, auth }: {
|
|
32
33
|
config: any;
|
|
34
|
+
auth: any;
|
|
33
35
|
}) => void>>;
|
|
34
36
|
onDestroy: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<() => void>>;
|
|
35
37
|
}>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-reference-plugin.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAsE,MAAM,oBAAoB,CAAA;AAEpH,QAAA,MAAM,sBAAsB;;;;EAY1B,CAAA;AAyBF,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;EAOf,CAAA;AAEF,QAAA,MAAM,oBAAoB;
|
|
1
|
+
{"version":3,"file":"api-reference-plugin.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAsE,MAAM,oBAAoB,CAAA;AAEpH,QAAA,MAAM,sBAAsB;;;;EAY1B,CAAA;AAyBF,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;EAOf,CAAA;AAEF,QAAA,MAAM,oBAAoB;uHACe;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI;+HAC3B;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI;6GACrD,IAAI;EACjC,CAAA;AAEF,eAAO,MAAM,wBAAwB,oDAE3B;IACJ,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAC,OAAO,sBAAsB,CAAC,EAAE,CAAA;IACnD,KAAK,EAAE,MAAM,CAAC,OAAO,WAAW,CAAC,CAAA;IACjC,KAAK,EAAE,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAA;IAC1C,gBAAgB,EAAE,GAAG,EAAE,CAAA;CACxB,CACA,CAAA"}
|
|
@@ -18,6 +18,12 @@ export declare const asyncApiReferenceObject: import("@scalar/validation").Objec
|
|
|
18
18
|
*
|
|
19
19
|
* Use when the specification allows only a Reference Object (not an inline object), for example
|
|
20
20
|
* `operation.channel` or `channel.servers`.
|
|
21
|
+
*
|
|
22
|
+
* `$ref-value` is a resolved-document extension populated by the bundler/proxy at access time, so it
|
|
23
|
+
* is optional here. If coercion required it, an unresolved `{ $ref }` would be filled with a default
|
|
24
|
+
* instance of `schema` (for a security scheme, the first `type` literal — `userPassword`). Because the
|
|
25
|
+
* magic proxy shares one target object between a `$ref-value` and the component it points at, that
|
|
26
|
+
* synthetic default then leaks back over the real definition, clobbering its `type`.
|
|
21
27
|
*/
|
|
22
28
|
export declare const asyncApiResolvedReference: (schema: Schema) => Schema;
|
|
23
29
|
/** Inline object or Reference Object with resolved `$ref-value`. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/reference.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,
|
|
1
|
+
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/reference.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAA2D,MAAM,oBAAoB,CAAA;AAIzG;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;AAElD;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;EAKnC,CAAA;AAUD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yBAAyB,GAAI,QAAQ,MAAM,KAAG,MAC4D,CAAA;AAEvH,oEAAoE;AACpE,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,KAAG,MAA4D,CAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { isObject } from '@scalar/helpers/object/is-object';
|
|
2
|
-
import { evaluate, intersection, object, string, union } from '@scalar/validation';
|
|
2
|
+
import { evaluate, intersection, object, optional, string, union } from '@scalar/validation';
|
|
3
3
|
import { referenceExtensions } from '../../general/bundler-extensions.js';
|
|
4
4
|
/**
|
|
5
5
|
* AsyncAPI Reference Object (JSON Reference). Only `$ref` is defined; additional
|
|
@@ -19,7 +19,13 @@ const e = (value) => {
|
|
|
19
19
|
*
|
|
20
20
|
* Use when the specification allows only a Reference Object (not an inline object), for example
|
|
21
21
|
* `operation.channel` or `channel.servers`.
|
|
22
|
+
*
|
|
23
|
+
* `$ref-value` is a resolved-document extension populated by the bundler/proxy at access time, so it
|
|
24
|
+
* is optional here. If coercion required it, an unresolved `{ $ref }` would be filled with a default
|
|
25
|
+
* instance of `schema` (for a security scheme, the first `type` literal — `userPassword`). Because the
|
|
26
|
+
* magic proxy shares one target object between a `$ref-value` and the component it points at, that
|
|
27
|
+
* synthetic default then leaks back over the real definition, clobbering its `type`.
|
|
22
28
|
*/
|
|
23
|
-
export const asyncApiResolvedReference = (schema) => intersection([asyncApiReferenceObject, object({ '$ref-value': evaluate(e, schema) }), referenceExtensions]);
|
|
29
|
+
export const asyncApiResolvedReference = (schema) => intersection([asyncApiReferenceObject, object({ '$ref-value': optional(evaluate(e, schema)) }), referenceExtensions]);
|
|
24
30
|
/** Inline object or Reference Object with resolved `$ref-value`. */
|
|
25
31
|
export const recursiveRef = (schema) => union([schema, asyncApiResolvedReference(schema)]);
|
package/package.json
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"schemas",
|
|
15
15
|
"scalar"
|
|
16
16
|
],
|
|
17
|
-
"version": "0.7.
|
|
17
|
+
"version": "0.7.2",
|
|
18
18
|
"engines": {
|
|
19
19
|
"node": ">=22"
|
|
20
20
|
},
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"vitest": "4.1.0",
|
|
49
|
-
"@scalar/types": "0.16.
|
|
49
|
+
"@scalar/types": "0.16.2"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
|