@scalar/schemas 0.4.2 → 0.5.0

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.
Files changed (14) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/dist/api-reference/api-reference-configuration.d.ts +26 -4
  3. package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
  4. package/dist/api-reference/api-reference-configuration.js +0 -7
  5. package/dist/api-reference/api-reference-plugin.d.ts +13 -0
  6. package/dist/api-reference/api-reference-plugin.d.ts.map +1 -1
  7. package/dist/api-reference/api-reference-plugin.js +10 -1
  8. package/dist/openapi/3.1/components.d.ts +1 -24
  9. package/dist/openapi/3.1/components.d.ts.map +1 -1
  10. package/dist/openapi/3.1/components.js +1 -1
  11. package/dist/openapi/3.1/document.d.ts +3 -72
  12. package/dist/openapi/3.1/document.d.ts.map +1 -1
  13. package/dist/openapi/3.1/document.js +3 -2
  14. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # @scalar/schemas
2
2
 
3
+ ## 0.5.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#9478](https://github.com/scalar/scalar/pull/9478): Add `content.start` plugin view slot and `sidebar` visibility option for plugin view components.
8
+ - **`content.start`**: A new view slot that renders custom plugin components **before** the Introduction/Info section (at the top of the content area).
9
+ - **`sidebar` option on `ViewComponent`**: Plugins can now opt-in to display a sidebar entry for their custom views by providing `sidebar: { show: true, label: 'My Page' }`. Omitting `sidebar` or setting `show: false` hides the entry from the sidebar. The entry hooks into the existing navigation, so clicking it scrolls to the plugin view and it highlights as it scrolls into view.
10
+
11
+ ### Patch Changes
12
+
13
+ - [#9529](https://github.com/scalar/scalar/pull/9529): Remove the unused `isLoading` configuration option. It was never wired to a consumer, so it had no effect on the rendered references.
14
+ - [#9528](https://github.com/scalar/scalar/pull/9528): Remove the unused `onSpecUpdate` configuration option. It was never wired to a consumer, so the callback never fired.
15
+
16
+ ## 0.4.3
17
+
18
+ ### Patch Changes
19
+
20
+ - [#9342](https://github.com/scalar/scalar/pull/9342): fix: resolve operations when OpenAPI path items use `$ref`
21
+
22
+ Path entries and webhooks can reference `components.pathItems` instead of inlining operations. Navigation, mutators, search, and markdown export now resolve path-item references before reading HTTP methods and path-level parameters.
23
+
3
24
  ## 0.4.2
4
25
 
5
26
  ### Patch Changes
package/dist/api-reference/api-reference-configuration.d.ts CHANGED
@@ -51,10 +51,23 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
51
51
  renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
52
52
  }>>[];
53
53
  views: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
54
+ 'content.start': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
55
+ component: import("@scalar/validation").UnknownSchema;
56
+ renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
57
+ props: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>>;
58
+ sidebar: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
59
+ show: import("@scalar/validation").BooleanSchema;
60
+ label: import("@scalar/validation").StringSchema;
61
+ }>>;
62
+ }>>>;
54
63
  'content.end': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
55
64
  component: import("@scalar/validation").UnknownSchema;
56
65
  renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
57
66
  props: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>>;
67
+ sidebar: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
68
+ show: import("@scalar/validation").BooleanSchema;
69
+ label: import("@scalar/validation").StringSchema;
70
+ }>>;
58
71
  }>>>;
59
72
  }>>;
60
73
  hooks: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
@@ -69,7 +82,6 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
69
82
  apiClientPlugins: any[];
70
83
  }>>>;
71
84
  isEditable: import("@scalar/validation").BooleanSchema;
72
- isLoading: import("@scalar/validation").BooleanSchema;
73
85
  hideModels: import("@scalar/validation").BooleanSchema;
74
86
  modelsSectionLabel: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"Models">, import("@scalar/validation").LiteralSchema<"Schemas">, import("@scalar/validation").StringSchema]>>;
75
87
  documentDownloadType: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"both">, import("@scalar/validation").LiteralSchema<"yaml">, import("@scalar/validation").LiteralSchema<"json">, import("@scalar/validation").LiteralSchema<"direct">, import("@scalar/validation").LiteralSchema<"none">]>;
@@ -88,7 +100,6 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
88
100
  clientKey: import("@scalar/validation").StringSchema;
89
101
  }>>;
90
102
  customCss: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
91
- onSpecUpdate: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<(input: string) => void>>;
92
103
  onServerChange: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<(input: string) => void>>;
93
104
  onDocumentSelect: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<() => void>>;
94
105
  onLoaded: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<(slug: string) => Promise<void> | void>>;
@@ -190,7 +201,6 @@ export declare const apiReferenceConfigurationWithSourceSchema: (rawInput: unkno
190
201
  } & {
191
202
  layout: "modern" | "classic";
192
203
  isEditable: boolean;
193
- isLoading: boolean;
194
204
  hideModels: boolean;
195
205
  documentDownloadType: "none" | "both" | "yaml" | "json" | "direct";
196
206
  hideTestRequestButton: boolean;
@@ -217,10 +227,23 @@ export declare const apiReferenceConfigurationWithSourceSchema: (rawInput: unkno
217
227
  renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
218
228
  }>>[];
219
229
  views: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
230
+ 'content.start': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
231
+ component: import("@scalar/validation").UnknownSchema;
232
+ renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
233
+ props: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>>;
234
+ sidebar: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
235
+ show: import("@scalar/validation").BooleanSchema;
236
+ label: import("@scalar/validation").StringSchema;
237
+ }>>;
238
+ }>>>;
220
239
  'content.end': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
221
240
  component: import("@scalar/validation").UnknownSchema;
222
241
  renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
223
242
  props: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>>;
243
+ sidebar: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
244
+ show: import("@scalar/validation").BooleanSchema;
245
+ label: import("@scalar/validation").StringSchema;
246
+ }>>;
224
247
  }>>>;
225
248
  }>>;
226
249
  hooks: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
@@ -246,7 +269,6 @@ export declare const apiReferenceConfigurationWithSourceSchema: (rawInput: unkno
246
269
  clientKey: string;
247
270
  } | undefined;
248
271
  customCss?: string | undefined;
249
- onSpecUpdate?: ((input: string) => void) | undefined;
250
272
  onServerChange?: ((input: string) => void) | undefined;
251
273
  onDocumentSelect?: (() => void) | undefined;
252
274
  onLoaded?: ((slug: string) => Promise<void> | void) | undefined;
package/dist/api-reference/api-reference-configuration.d.ts.map CHANGED
@@ -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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kHA6FN,MAAM,KAAK,IAAI;oHAGb,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;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BA/HrC,MAAM,KAAK,IAAI;8BAGb,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;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"}
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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oHAyFJ,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;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BA5HnC,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;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"}
package/dist/api-reference/api-reference-configuration.js CHANGED
@@ -26,10 +26,6 @@ export const apiReferenceConfigurationSchema = intersection([
26
26
  default: false,
27
27
  typeComment: 'Allows the user to inject an editor for the spec',
28
28
  }),
29
- isLoading: boolean({
30
- default: false,
31
- typeComment: 'Controls whether the references show a loading state in the intro',
32
- }),
33
29
  hideModels: boolean({
34
30
  default: false,
35
31
  typeComment: 'Whether to show models in the sidebar, search, and content.',
@@ -83,9 +79,6 @@ export const apiReferenceConfigurationSchema = intersection([
83
79
  customCss: optional(string(), {
84
80
  typeComment: 'Custom CSS to be added to the page',
85
81
  }),
86
- onSpecUpdate: optional(fn(), {
87
- typeComment: 'onSpecUpdate is fired on spec/swagger content change',
88
- }),
89
82
  onServerChange: optional(fn(), {
90
83
  typeComment: 'onServerChange is fired on selected server change',
91
84
  }),
package/dist/api-reference/api-reference-plugin.d.ts CHANGED
@@ -5,10 +5,23 @@ declare const openApiExtensionSchema: import("@scalar/validation").ObjectSchema<
5
5
  renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
6
6
  }>;
7
7
  declare const viewsSchema: import("@scalar/validation").ObjectSchema<{
8
+ 'content.start': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
9
+ component: import("@scalar/validation").UnknownSchema;
10
+ renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
11
+ props: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>>;
12
+ sidebar: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
13
+ show: import("@scalar/validation").BooleanSchema;
14
+ label: import("@scalar/validation").StringSchema;
15
+ }>>;
16
+ }>>>;
8
17
  'content.end': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
9
18
  component: import("@scalar/validation").UnknownSchema;
10
19
  renderer: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
11
20
  props: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>>;
21
+ sidebar: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
22
+ show: import("@scalar/validation").BooleanSchema;
23
+ label: import("@scalar/validation").StringSchema;
24
+ }>>;
12
25
  }>>>;
13
26
  }>;
14
27
  declare const lifecycleHooksSchema: import("@scalar/validation").ObjectSchema<{
package/dist/api-reference/api-reference-plugin.d.ts.map CHANGED
@@ -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,EAA6D,MAAM,oBAAoB,CAAA;AAE3G,QAAA,MAAM,sBAAsB;;;;EAY1B,CAAA;AAgBF,QAAA,MAAM,WAAW;;;;;;EAIf,CAAA;AAEF,QAAA,MAAM,oBAAoB;iHACS;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI;yHAChB;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI;6GACpC,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"}
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;iHACS;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI;yHAChB;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI;6GACpC,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"}
package/dist/api-reference/api-reference-plugin.js CHANGED
@@ -1,4 +1,4 @@
1
- import { any, array, fn, object, optional, record, string, unknown } from '@scalar/validation';
1
+ import { any, array, boolean, fn, object, optional, record, string, unknown } from '@scalar/validation';
2
2
  const openApiExtensionSchema = object({
3
3
  name: string({
4
4
  typeComment: 'Name of specification extension property. Has to start with \`x-\`.',
@@ -20,8 +20,17 @@ const viewComponentSchema = object({
20
20
  props: optional(record(string(), any()), {
21
21
  typeComment: 'Additional props to pass to the component',
22
22
  }),
23
+ sidebar: optional(object({
24
+ show: boolean(),
25
+ label: string(),
26
+ }), {
27
+ typeComment: 'Sidebar configuration. Set show: true to display in sidebar.',
28
+ }),
23
29
  });
24
30
  const viewsSchema = object({
31
+ 'content.start': optional(array(viewComponentSchema), {
32
+ typeComment: 'Components to render before the Introduction/Info section',
33
+ }),
25
34
  'content.end': optional(array(viewComponentSchema), {
26
35
  typeComment: 'Components to render at specific views in the API Reference',
27
36
  }),
package/dist/openapi/3.1/components.d.ts CHANGED
@@ -8,29 +8,6 @@ export declare const components: import("@scalar/validation").LazySchema<() => i
8
8
  securitySchemes: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
9
9
  links: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
10
10
  callbacks: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
11
- pathItems: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").ObjectSchema<{
12
- $ref: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
13
- summary: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
14
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
15
- get: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
16
- put: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
17
- post: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
18
- delete: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
19
- patch: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
20
- connect: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
21
- options: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
22
- head: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
23
- trace: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
24
- servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
25
- url: import("@scalar/validation").StringSchema;
26
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
27
- variables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
28
- enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
29
- default: import("@scalar/validation").StringSchema;
30
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
31
- }>>>;
32
- }>>>;
33
- parameters: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").Schema>>;
34
- }>>>>;
11
+ pathItems: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
35
12
  }>>;
36
13
  //# sourceMappingURL=components.d.ts.map
package/dist/openapi/3.1/components.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/components.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BtB,CAAA"}
1
+ {"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/components.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,UAAU;;;;;;;;;;;GAoBtB,CAAA"}
package/dist/openapi/3.1/components.js CHANGED
@@ -20,5 +20,5 @@ export const components = lazy(() => object({
20
20
  securitySchemes: optional(record(string(), recursiveRef(lazy(() => securityScheme)), { typeName: 'ComponentsSecuritySchemes' })),
21
21
  links: optional(record(string(), recursiveRef(lazy(() => link)), { typeName: 'ComponentsLinks' })),
22
22
  callbacks: optional(record(string(), recursiveRef(lazy(() => callback)), { typeName: 'ComponentsCallbacks' })),
23
- pathItems: optional(record(string(), lazy(() => pathItem), { typeName: 'ComponentsPathItems' })),
23
+ pathItems: optional(record(string(), recursiveRef(lazy(() => pathItem)), { typeName: 'ComponentsPathItems' })),
24
24
  }, { typeName: 'ComponentsObject' }));
package/dist/openapi/3.1/document.d.ts CHANGED
@@ -33,54 +33,8 @@ export declare const openApiSchema: import("@scalar/validation").IntersectionSch
33
33
  description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
34
34
  }>>>;
35
35
  }>>>;
36
- paths: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
37
- $ref: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
38
- summary: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
39
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
40
- get: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
41
- put: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
42
- post: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
43
- delete: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
44
- patch: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
45
- connect: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
46
- options: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
47
- head: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
48
- trace: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
49
- servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
50
- url: import("@scalar/validation").StringSchema;
51
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
52
- variables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
53
- enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
54
- default: import("@scalar/validation").StringSchema;
55
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
56
- }>>>;
57
- }>>>;
58
- parameters: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").Schema>>;
59
- }>>>;
60
- webhooks: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
61
- $ref: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
62
- summary: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
63
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
64
- get: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
65
- put: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
66
- post: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
67
- delete: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
68
- patch: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
69
- connect: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
70
- options: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
71
- head: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
72
- trace: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
73
- servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
74
- url: import("@scalar/validation").StringSchema;
75
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
76
- variables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
77
- enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
78
- default: import("@scalar/validation").StringSchema;
79
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
80
- }>>>;
81
- }>>>;
82
- parameters: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").Schema>>;
83
- }>>>;
36
+ paths: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
37
+ webhooks: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
84
38
  components: import("@scalar/validation").OptionalSchema<import("@scalar/validation").LazySchema<() => import("@scalar/validation").ObjectSchema<{
85
39
  schemas: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
86
40
  responses: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
@@ -91,30 +45,7 @@ export declare const openApiSchema: import("@scalar/validation").IntersectionSch
91
45
  securitySchemes: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
92
46
  links: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
93
47
  callbacks: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
94
- pathItems: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").ObjectSchema<{
95
- $ref: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
96
- summary: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
97
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
98
- get: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
99
- put: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
100
- post: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
101
- delete: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
102
- patch: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
103
- connect: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
104
- options: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
105
- head: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
106
- trace: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
107
- servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
108
- url: import("@scalar/validation").StringSchema;
109
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
110
- variables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
111
- enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
112
- default: import("@scalar/validation").StringSchema;
113
- description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
114
- }>>>;
115
- }>>>;
116
- parameters: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").Schema>>;
117
- }>>>>;
48
+ pathItems: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
118
49
  }>>>;
119
50
  security: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>>>;
120
51
  tags: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
package/dist/openapi/3.1/document.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/document.ts"],"names":[],"mappings":"AA2GA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAGxB,CAAA"}
1
+ {"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/document.ts"],"names":[],"mappings":"AA4GA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAGxB,CAAA"}
package/dist/openapi/3.1/document.js CHANGED
@@ -7,6 +7,7 @@ import { components } from '../../openapi/3.1/components.js';
7
7
  import { externalDocs } from '../../openapi/3.1/external-docs.js';
8
8
  import { info } from '../../openapi/3.1/info.js';
9
9
  import { pathItem } from '../../openapi/3.1/path-item.js';
10
+ import { recursiveRef } from '../../openapi/3.1/reference.js';
10
11
  import { securityRequirement } from '../../openapi/3.1/security-requirement.js';
11
12
  import { server } from '../../openapi/3.1/server.js';
12
13
  import { tag } from '../../openapi/3.1/tag.js';
@@ -43,11 +44,11 @@ const openApiDocumentCore = object({
43
44
  typeComment: 'An array of Server Objects, which provide connectivity information to a target server. If the servers field is not provided, or is an empty array, the default value would be a Server Object with a url value of /.',
44
45
  typeName: 'OpenApiServers',
45
46
  })),
46
- paths: optional(record(string(), pathItem, {
47
+ paths: optional(record(string(), recursiveRef(pathItem), {
47
48
  typeComment: 'The available paths and operations for the API.',
48
49
  typeName: 'PathsObject',
49
50
  })),
50
- webhooks: optional(record(string(), pathItem, {
51
+ webhooks: optional(record(string(), recursiveRef(pathItem), {
51
52
  typeComment: 'The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement.',
52
53
  typeName: 'WebhooksObject',
53
54
  })),
package/package.json CHANGED
@@ -14,7 +14,7 @@
14
14
  "schemas",
15
15
  "scalar"
16
16
  ],
17
- "version": "0.4.2",
17
+ "version": "0.5.0",
18
18
  "engines": {
19
19
  "node": ">=22"
20
20
  },
@@ -41,12 +41,12 @@
41
41
  "CHANGELOG.md"
42
42
  ],
43
43
  "dependencies": {
44
- "@scalar/validation": "0.6.0",
45
- "@scalar/helpers": "0.8.2"
44
+ "@scalar/helpers": "0.8.2",
45
+ "@scalar/validation": "0.6.0"
46
46
  },
47
47
  "devDependencies": {
48
48
  "vitest": "4.1.0",
49
- "@scalar/types": "0.13.2"
49
+ "@scalar/types": "0.14.0"
50
50
  },
51
51
  "scripts": {
52
52
  "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",