@scalar/workspace-store 0.56.0 → 0.57.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 (128) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/dist/client.d.ts.map +1 -1
  3. package/dist/client.js +9 -0
  4. package/dist/entities/auth/schema.d.ts +220 -20
  5. package/dist/entities/auth/schema.d.ts.map +1 -1
  6. package/dist/mutators/operation/helpers/fetch-request-to-har.d.ts.map +1 -1
  7. package/dist/mutators/operation/helpers/fetch-request-to-har.js +7 -2
  8. package/dist/navigation/get-navigation-options.d.ts.map +1 -1
  9. package/dist/navigation/get-navigation-options.js +4 -1
  10. package/dist/request-example/builder/body/get-request-body-example.d.ts.map +1 -1
  11. package/dist/request-example/builder/body/get-request-body-example.js +4 -2
  12. package/dist/schemas/reference-config/index.d.ts +28 -4
  13. package/dist/schemas/reference-config/index.d.ts.map +1 -1
  14. package/dist/schemas/reference-config/settings.d.ts +28 -4
  15. package/dist/schemas/reference-config/settings.d.ts.map +1 -1
  16. package/dist/schemas/v3.1/strict/oauth-flow.d.ts +19 -1
  17. package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
  18. package/dist/schemas/v3.1/strict/oauth-flow.js +6 -1
  19. package/dist/schemas/v3.1/strict/oauthflows.d.ts +16 -0
  20. package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
  21. package/dist/schemas/v3.1/strict/openapi-document.d.ts +980 -140
  22. package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
  23. package/dist/schemas/v3.1/strict/security-scheme.d.ts +14 -5
  24. package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
  25. package/dist/schemas/v3.1/strict/security-scheme.js +5 -2
  26. package/dist/schemas/v3.2/openapi/index.d.ts +144 -0
  27. package/dist/schemas/v3.2/openapi/index.d.ts.map +1 -0
  28. package/dist/schemas/v3.2/openapi/index.js +713 -0
  29. package/dist/schemas/v3.2/openapi/reference.d.ts +4 -0
  30. package/dist/schemas/v3.2/openapi/reference.d.ts.map +1 -0
  31. package/dist/schemas/v3.2/openapi/reference.js +29 -0
  32. package/dist/schemas/v3.2/strict/callback.d.ts +15 -0
  33. package/dist/schemas/v3.2/strict/callback.d.ts.map +1 -0
  34. package/dist/schemas/v3.2/strict/callback.js +6 -0
  35. package/dist/schemas/v3.2/strict/components.d.ts +173 -0
  36. package/dist/schemas/v3.2/strict/components.d.ts.map +1 -0
  37. package/dist/schemas/v3.2/strict/components.js +29 -0
  38. package/dist/schemas/v3.2/strict/contact.d.ts +19 -0
  39. package/dist/schemas/v3.2/strict/contact.d.ts.map +1 -0
  40. package/dist/schemas/v3.2/strict/contact.js +10 -0
  41. package/dist/schemas/v3.2/strict/discriminator.d.ts +27 -0
  42. package/dist/schemas/v3.2/strict/discriminator.d.ts.map +1 -0
  43. package/dist/schemas/v3.2/strict/discriminator.js +14 -0
  44. package/dist/schemas/v3.2/strict/encoding.d.ts +62 -0
  45. package/dist/schemas/v3.2/strict/encoding.d.ts.map +1 -0
  46. package/dist/schemas/v3.2/strict/encoding.js +33 -0
  47. package/dist/schemas/v3.2/strict/example.d.ts +50 -0
  48. package/dist/schemas/v3.2/strict/example.d.ts.map +1 -0
  49. package/dist/schemas/v3.2/strict/example.js +22 -0
  50. package/dist/schemas/v3.2/strict/external-documentation.d.ts +15 -0
  51. package/dist/schemas/v3.2/strict/external-documentation.d.ts.map +1 -0
  52. package/dist/schemas/v3.2/strict/external-documentation.js +8 -0
  53. package/dist/schemas/v3.2/strict/header.d.ts +97 -0
  54. package/dist/schemas/v3.2/strict/header.d.ts.map +1 -0
  55. package/dist/schemas/v3.2/strict/header.js +39 -0
  56. package/dist/schemas/v3.2/strict/info.d.ts +54 -0
  57. package/dist/schemas/v3.2/strict/info.d.ts.map +1 -0
  58. package/dist/schemas/v3.2/strict/info.js +24 -0
  59. package/dist/schemas/v3.2/strict/license.d.ts +19 -0
  60. package/dist/schemas/v3.2/strict/license.d.ts.map +1 -0
  61. package/dist/schemas/v3.2/strict/license.js +10 -0
  62. package/dist/schemas/v3.2/strict/link.d.ts +44 -0
  63. package/dist/schemas/v3.2/strict/link.d.ts.map +1 -0
  64. package/dist/schemas/v3.2/strict/link.js +23 -0
  65. package/dist/schemas/v3.2/strict/media-type.d.ts +78 -0
  66. package/dist/schemas/v3.2/strict/media-type.d.ts.map +1 -0
  67. package/dist/schemas/v3.2/strict/media-type.js +26 -0
  68. package/dist/schemas/v3.2/strict/oauth-flow.d.ts +159 -0
  69. package/dist/schemas/v3.2/strict/oauth-flow.d.ts.map +1 -0
  70. package/dist/schemas/v3.2/strict/oauth-flow.js +44 -0
  71. package/dist/schemas/v3.2/strict/oauthflows.d.ts +116 -0
  72. package/dist/schemas/v3.2/strict/oauthflows.d.ts.map +1 -0
  73. package/dist/schemas/v3.2/strict/oauthflows.js +17 -0
  74. package/dist/schemas/v3.2/strict/openapi-document.d.ts +64576 -0
  75. package/dist/schemas/v3.2/strict/openapi-document.d.ts.map +1 -0
  76. package/dist/schemas/v3.2/strict/openapi-document.js +154 -0
  77. package/dist/schemas/v3.2/strict/operation.d.ts +165 -0
  78. package/dist/schemas/v3.2/strict/operation.d.ts.map +1 -0
  79. package/dist/schemas/v3.2/strict/operation.js +40 -0
  80. package/dist/schemas/v3.2/strict/parameter.d.ts +142 -0
  81. package/dist/schemas/v3.2/strict/parameter.d.ts.map +1 -0
  82. package/dist/schemas/v3.2/strict/parameter.js +58 -0
  83. package/dist/schemas/v3.2/strict/path-item.d.ts +189 -0
  84. package/dist/schemas/v3.2/strict/path-item.d.ts.map +1 -0
  85. package/dist/schemas/v3.2/strict/path-item.js +41 -0
  86. package/dist/schemas/v3.2/strict/paths.d.ts +20 -0
  87. package/dist/schemas/v3.2/strict/paths.d.ts.map +1 -0
  88. package/dist/schemas/v3.2/strict/paths.js +9 -0
  89. package/dist/schemas/v3.2/strict/ref-definitions.d.ts +76 -0
  90. package/dist/schemas/v3.2/strict/ref-definitions.d.ts.map +1 -0
  91. package/dist/schemas/v3.2/strict/ref-definitions.js +80 -0
  92. package/dist/schemas/v3.2/strict/reference.d.ts +63 -0
  93. package/dist/schemas/v3.2/strict/reference.d.ts.map +1 -0
  94. package/dist/schemas/v3.2/strict/reference.js +23 -0
  95. package/dist/schemas/v3.2/strict/request-body.d.ts +23 -0
  96. package/dist/schemas/v3.2/strict/request-body.d.ts.map +1 -0
  97. package/dist/schemas/v3.2/strict/request-body.js +13 -0
  98. package/dist/schemas/v3.2/strict/response.d.ts +50 -0
  99. package/dist/schemas/v3.2/strict/response.d.ts.map +1 -0
  100. package/dist/schemas/v3.2/strict/response.js +15 -0
  101. package/dist/schemas/v3.2/strict/responses.d.ts +32 -0
  102. package/dist/schemas/v3.2/strict/responses.d.ts.map +1 -0
  103. package/dist/schemas/v3.2/strict/responses.js +13 -0
  104. package/dist/schemas/v3.2/strict/schema.d.ts +1330 -0
  105. package/dist/schemas/v3.2/strict/schema.d.ts.map +1 -0
  106. package/dist/schemas/v3.2/strict/schema.js +205 -0
  107. package/dist/schemas/v3.2/strict/security-requirement.d.ts +23 -0
  108. package/dist/schemas/v3.2/strict/security-requirement.d.ts.map +1 -0
  109. package/dist/schemas/v3.2/strict/security-requirement.js +13 -0
  110. package/dist/schemas/v3.2/strict/security-scheme.d.ts +95 -0
  111. package/dist/schemas/v3.2/strict/security-scheme.d.ts.map +1 -0
  112. package/dist/schemas/v3.2/strict/security-scheme.js +46 -0
  113. package/dist/schemas/v3.2/strict/server-variable.d.ts +19 -0
  114. package/dist/schemas/v3.2/strict/server-variable.d.ts.map +1 -0
  115. package/dist/schemas/v3.2/strict/server-variable.js +10 -0
  116. package/dist/schemas/v3.2/strict/server.d.ts +24 -0
  117. package/dist/schemas/v3.2/strict/server.d.ts.map +1 -0
  118. package/dist/schemas/v3.2/strict/server.js +13 -0
  119. package/dist/schemas/v3.2/strict/tag.d.ts +44 -0
  120. package/dist/schemas/v3.2/strict/tag.d.ts.map +1 -0
  121. package/dist/schemas/v3.2/strict/tag.js +22 -0
  122. package/dist/schemas/v3.2/strict/type-guards.d.ts +24 -0
  123. package/dist/schemas/v3.2/strict/type-guards.d.ts.map +1 -0
  124. package/dist/schemas/v3.2/strict/type-guards.js +25 -0
  125. package/dist/schemas/v3.2/strict/xml.d.ts +39 -0
  126. package/dist/schemas/v3.2/strict/xml.d.ts.map +1 -0
  127. package/dist/schemas/v3.2/strict/xml.js +26 -0
  128. package/package.json +12 -12
@@ -0,0 +1,4 @@
1
+ import { type Schema } from '@scalar/validation';
2
+ export declare const normalRef: (schema: Schema) => Schema;
3
+ export declare const recursiveRef: (schema: Schema) => Schema;
4
+ //# sourceMappingURL=reference.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/openapi/reference.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,MAAM,EASZ,MAAM,oBAAoB,CAAA;AAsC3B,eAAO,MAAM,SAAS,GAAI,QAAQ,MAAM,KAAG,MAAoC,CAAA;AAS/E,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,KAAG,MACkE,CAAA"}
@@ -0,0 +1,29 @@
1
+ import { isObject } from '@scalar/helpers/object/is-object';
2
+ import { boolean, evaluate, intersection, literal, object, optional, string, union, } from '@scalar/validation';
3
+ const referenceExtensions = object({
4
+ '$status': optional(union([literal('loading'), literal('error')]), {
5
+ typeComment: `Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed.`,
6
+ }),
7
+ '$global': optional(boolean({
8
+ typeComment: 'Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context.',
9
+ })),
10
+ }, { typeName: 'ReferenceObjectExtensions' });
11
+ const reference = object({
12
+ '$ref': string({ typeComment: 'REQUIRED. The reference identifier. This MUST be in the form of a URI.' }),
13
+ summary: optional(string({
14
+ typeComment: 'A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect.',
15
+ })),
16
+ description: optional(string({
17
+ typeComment: 'A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.',
18
+ })),
19
+ }, {
20
+ typeName: 'ReferenceObject',
21
+ });
22
+ export const normalRef = (schema) => union([schema, reference]);
23
+ const e = (value) => {
24
+ if (isObject(value) && '$ref' in value) {
25
+ return e(value['$ref-value']);
26
+ }
27
+ return value;
28
+ };
29
+ export const recursiveRef = (schema) => union([schema, intersection([reference, object({ '$ref-value': evaluate(e, schema) }), referenceExtensions])]);
@@ -0,0 +1,15 @@
1
+ import type { PathItemObject } from './path-item.js';
2
+ import { type ReferenceType } from './reference.js';
3
+ export declare const CallbackObjectSchemaDefinition: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"PathItemObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
4
+ $ref: import("@scalar/typebox").TString;
5
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
6
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
7
+ }>, import("@scalar/typebox").TObject<{
8
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
9
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
10
+ }>]>, import("@scalar/typebox").TObject<{
11
+ '$ref-value': import("@scalar/typebox").TRef<"PathItemObject">;
12
+ }>]>]>>;
13
+ /** A Path Item Object used to define a callback request and expected responses. A complete example is available. */
14
+ export type CallbackObject = Record<string, ReferenceType<PathItemObject>>;
15
+ //# sourceMappingURL=callback.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"callback.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/callback.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEjD,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAE3D,eAAO,MAAM,8BAA8B;;;;;;;;;OAI1C,CAAA;AAED,oHAAoH;AACpH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAA"}
@@ -0,0 +1,6 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { PathItemObjectRef } from './ref-definitions.js';
3
+ import { reference } from './reference.js';
4
+ export const CallbackObjectSchemaDefinition = Type.Record(Type.String(),
5
+ /** A Path Item Object used to define a callback request and expected responses. A complete example is available. */
6
+ Type.Union([PathItemObjectRef, reference(PathItemObjectRef)]));
@@ -0,0 +1,173 @@
1
+ import type { CallbackObject } from './callback.js';
2
+ import type { ExampleObject } from './example.js';
3
+ import type { HeaderObject } from './header.js';
4
+ import type { LinkObject } from './link.js';
5
+ import type { MediaTypeObject } from './media-type.js';
6
+ import type { ParameterObject } from './parameter.js';
7
+ import type { PathItemObject } from './path-item.js';
8
+ import { type ReferenceType } from './reference.js';
9
+ import type { RequestBodyObject } from './request-body.js';
10
+ import type { ResponsesObject } from './responses.js';
11
+ import type { SchemaObject } from './schema.js';
12
+ import type { SecuritySchemeObject } from './security-scheme.js';
13
+ export declare const SecuritySchemesSchemaDefinition: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SecuritySchemeObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
14
+ $ref: import("@scalar/typebox").TString;
15
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
16
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
17
+ }>, import("@scalar/typebox").TObject<{
18
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
19
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
20
+ }>]>, import("@scalar/typebox").TObject<{
21
+ '$ref-value': import("@scalar/typebox").TRef<"SecuritySchemeObject">;
22
+ }>]>]>>;
23
+ export type SecuritySchemes = Record<string, ReferenceType<SecuritySchemeObject>>;
24
+ /** Holds a set of reusable objects for different aspects of the OAS. All objects defined within the Components Object will have no effect on the API unless they are explicitly referenced from outside the Components Object. */
25
+ export declare const ComponentsObjectSchemaDefinition: import("@scalar/typebox").TObject<{
26
+ /** An object to hold reusable Schema Objects. */
27
+ schemas: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
28
+ $ref: import("@scalar/typebox").TString;
29
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
30
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
31
+ }>, import("@scalar/typebox").TObject<{
32
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
33
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
34
+ }>]>, import("@scalar/typebox").TObject<{
35
+ '$ref-value': import("@scalar/typebox").TRef<"SchemaObject">;
36
+ }>]>]>>>;
37
+ /** An object to hold reusable Response Objects. */
38
+ responses: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ResponseObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
39
+ $ref: import("@scalar/typebox").TString;
40
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
41
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
42
+ }>, import("@scalar/typebox").TObject<{
43
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
44
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
45
+ }>]>, import("@scalar/typebox").TObject<{
46
+ '$ref-value': import("@scalar/typebox").TRef<"ResponseObject">;
47
+ }>]>]>>>;
48
+ /** An object to hold reusable Parameter Objects. */
49
+ parameters: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ParameterObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
50
+ $ref: import("@scalar/typebox").TString;
51
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
52
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
53
+ }>, import("@scalar/typebox").TObject<{
54
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
55
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
56
+ }>]>, import("@scalar/typebox").TObject<{
57
+ '$ref-value': import("@scalar/typebox").TRef<"ParameterObject">;
58
+ }>]>]>>>;
59
+ /** An object to hold reusable Example Objects. */
60
+ examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ExampleObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
61
+ $ref: import("@scalar/typebox").TString;
62
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
63
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
64
+ }>, import("@scalar/typebox").TObject<{
65
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
66
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
67
+ }>]>, import("@scalar/typebox").TObject<{
68
+ '$ref-value': import("@scalar/typebox").TRef<"ExampleObject">;
69
+ }>]>]>>>;
70
+ /** An object to hold reusable Request Body Objects. */
71
+ requestBodies: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"RequestBodyObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
72
+ $ref: import("@scalar/typebox").TString;
73
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
74
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
75
+ }>, import("@scalar/typebox").TObject<{
76
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
77
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
78
+ }>]>, import("@scalar/typebox").TObject<{
79
+ '$ref-value': import("@scalar/typebox").TRef<"RequestBodyObject">;
80
+ }>]>]>>>;
81
+ /** An object to hold reusable Header Objects. */
82
+ headers: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"HeaderObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
83
+ $ref: import("@scalar/typebox").TString;
84
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
85
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
86
+ }>, import("@scalar/typebox").TObject<{
87
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
88
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
89
+ }>]>, import("@scalar/typebox").TObject<{
90
+ '$ref-value': import("@scalar/typebox").TRef<"HeaderObject">;
91
+ }>]>]>>>;
92
+ /** An object to hold reusable Security Scheme Objects. */
93
+ securitySchemes: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SecuritySchemeObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
94
+ $ref: import("@scalar/typebox").TString;
95
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
96
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
97
+ }>, import("@scalar/typebox").TObject<{
98
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
99
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
100
+ }>]>, import("@scalar/typebox").TObject<{
101
+ '$ref-value': import("@scalar/typebox").TRef<"SecuritySchemeObject">;
102
+ }>]>]>>>;
103
+ /** An object to hold reusable Link Objects. */
104
+ links: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"LinkObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
105
+ $ref: import("@scalar/typebox").TString;
106
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
107
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
108
+ }>, import("@scalar/typebox").TObject<{
109
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
110
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
111
+ }>]>, import("@scalar/typebox").TObject<{
112
+ '$ref-value': import("@scalar/typebox").TRef<"LinkObject">;
113
+ }>]>]>>>;
114
+ /** An object to hold reusable Callback Objects. */
115
+ callbacks: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"CallbackObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
116
+ $ref: import("@scalar/typebox").TString;
117
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
118
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
119
+ }>, import("@scalar/typebox").TObject<{
120
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
121
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
122
+ }>]>, import("@scalar/typebox").TObject<{
123
+ '$ref-value': import("@scalar/typebox").TRef<"CallbackObject">;
124
+ }>]>]>>>;
125
+ /** An object to hold reusable Path Item Objects. */
126
+ pathItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"PathItemObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
127
+ $ref: import("@scalar/typebox").TString;
128
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
129
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
130
+ }>, import("@scalar/typebox").TObject<{
131
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
132
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
133
+ }>]>, import("@scalar/typebox").TObject<{
134
+ '$ref-value': import("@scalar/typebox").TRef<"PathItemObject">;
135
+ }>]>]>>>;
136
+ /** An object to hold reusable Media Type Objects. Added in OpenAPI 3.2. */
137
+ mediaTypes: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"MediaTypeObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
138
+ $ref: import("@scalar/typebox").TString;
139
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
140
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
141
+ }>, import("@scalar/typebox").TObject<{
142
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
143
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
144
+ }>]>, import("@scalar/typebox").TObject<{
145
+ '$ref-value': import("@scalar/typebox").TRef<"MediaTypeObject">;
146
+ }>]>]>>>;
147
+ }>;
148
+ /** Holds a set of reusable objects for different aspects of the OAS. All objects defined within the Components Object will have no effect on the API unless they are explicitly referenced from outside the Components Object. */
149
+ export type ComponentsObject = {
150
+ /** An object to hold reusable Schema Objects. */
151
+ schemas?: Record<string, ReferenceType<SchemaObject>>;
152
+ /** An object to hold reusable Response Objects. */
153
+ responses?: ResponsesObject;
154
+ /** An object to hold reusable Parameter Objects. */
155
+ parameters?: Record<string, ReferenceType<ParameterObject>>;
156
+ /** An object to hold reusable Example Objects. */
157
+ examples?: Record<string, ReferenceType<ExampleObject>>;
158
+ /** An object to hold reusable Request Body Objects. */
159
+ requestBodies?: Record<string, ReferenceType<RequestBodyObject>>;
160
+ /** An object to hold reusable Header Objects. */
161
+ headers?: Record<string, ReferenceType<HeaderObject>>;
162
+ /** An object to hold reusable Security Scheme Objects. */
163
+ securitySchemes?: SecuritySchemes;
164
+ /** An object to hold reusable Link Objects. */
165
+ links?: Record<string, ReferenceType<LinkObject>>;
166
+ /** An object to hold reusable Callback Objects. */
167
+ callbacks?: Record<string, ReferenceType<CallbackObject>>;
168
+ /** An object to hold reusable Path Item Objects. */
169
+ pathItems?: Record<string, ReferenceType<PathItemObject>>;
170
+ /** An object to hold reusable Media Type Objects. Added in OpenAPI 3.2. */
171
+ mediaTypes?: Record<string, ReferenceType<MediaTypeObject>>;
172
+ };
173
+ //# sourceMappingURL=components.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/components.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAcjD,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAE7D,eAAO,MAAM,+BAA+B;;;;;;;;;OAG3C,CAAA;AACD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAA;AAEjF,kOAAkO;AAClO,eAAO,MAAM,gCAAgC;IAC3C,iDAAiD;;;;;;;;;;;IAEjD,mDAAmD;;;;;;;;;;;IAEnD,oDAAoD;;;;;;;;;;;IAIpD,kDAAkD;;;;;;;;;;;IAElD,uDAAuD;;;;;;;;;;;IAIvD,iDAAiD;;;;;;;;;;;IAEjD,0DAA0D;;;;;;;;;;;IAE1D,+CAA+C;;;;;;;;;;;IAE/C,mDAAmD;;;;;;;;;;;IAEnD,oDAAoD;;;;;;;;;;;IAEpD,2EAA2E;;;;;;;;;;;EAI3E,CAAA;AAEF,kOAAkO;AAClO,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAA;IACrD,mDAAmD;IACnD,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC,CAAA;IAC3D,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAA;IACvD,uDAAuD;IACvD,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAA;IAChE,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAA;IACrD,0DAA0D;IAC1D,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC,CAAA;IACjD,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAA;IACzD,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAA;IACzD,2EAA2E;IAC3E,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC,CAAA;CAC5D,CAAA"}
@@ -0,0 +1,29 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { CallbackObjectRef, ExampleObjectRef, HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef, ParameterObjectRef, PathItemObjectRef, RequestBodyObjectRef, ResponseObjectRef, SchemaObjectRef, SecuritySchemeObjectRef, } from './ref-definitions.js';
3
+ import { reference } from './reference.js';
4
+ export const SecuritySchemesSchemaDefinition = Type.Record(Type.String(), Type.Union([SecuritySchemeObjectRef, reference(SecuritySchemeObjectRef)]));
5
+ /** Holds a set of reusable objects for different aspects of the OAS. All objects defined within the Components Object will have no effect on the API unless they are explicitly referenced from outside the Components Object. */
6
+ export const ComponentsObjectSchemaDefinition = Type.Object({
7
+ /** An object to hold reusable Schema Objects. */
8
+ schemas: Type.Optional(Type.Record(Type.String(), Type.Union([SchemaObjectRef, reference(SchemaObjectRef)]))),
9
+ /** An object to hold reusable Response Objects. */
10
+ responses: Type.Optional(Type.Record(Type.String(), Type.Union([ResponseObjectRef, reference(ResponseObjectRef)]))),
11
+ /** An object to hold reusable Parameter Objects. */
12
+ parameters: Type.Optional(Type.Record(Type.String(), Type.Union([ParameterObjectRef, reference(ParameterObjectRef)]))),
13
+ /** An object to hold reusable Example Objects. */
14
+ examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),
15
+ /** An object to hold reusable Request Body Objects. */
16
+ requestBodies: Type.Optional(Type.Record(Type.String(), Type.Union([RequestBodyObjectRef, reference(RequestBodyObjectRef)]))),
17
+ /** An object to hold reusable Header Objects. */
18
+ headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObjectRef, reference(HeaderObjectRef)]))),
19
+ /** An object to hold reusable Security Scheme Objects. */
20
+ securitySchemes: Type.Optional(SecuritySchemesSchemaDefinition),
21
+ /** An object to hold reusable Link Objects. */
22
+ links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObjectRef, reference(LinkObjectRef)]))),
23
+ /** An object to hold reusable Callback Objects. */
24
+ callbacks: Type.Optional(Type.Record(Type.String(), Type.Union([CallbackObjectRef, reference(CallbackObjectRef)]))),
25
+ /** An object to hold reusable Path Item Objects. */
26
+ pathItems: Type.Optional(Type.Record(Type.String(), Type.Union([PathItemObjectRef, reference(PathItemObjectRef)]))),
27
+ /** An object to hold reusable Media Type Objects. Added in OpenAPI 3.2. */
28
+ mediaTypes: Type.Optional(Type.Record(Type.String(), Type.Union([MediaTypeObjectRef, reference(MediaTypeObjectRef)]))),
29
+ });
@@ -0,0 +1,19 @@
1
+ /** Contact information for the exposed API. */
2
+ export declare const ContactObjectSchemaDefinition: import("@scalar/typebox").TObject<{
3
+ /** The identifying name of the contact person/organization. */
4
+ name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
5
+ /** The URI for the contact information. This MUST be in the form of a URI. */
6
+ url: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
7
+ /** The email address of the contact person/organization. This MUST be in the form of an email address. */
8
+ email: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
9
+ }>;
10
+ /** Contact information for the exposed API. */
11
+ export type ContactObject = {
12
+ /** The identifying name of the contact person/organization. */
13
+ name?: string;
14
+ /** The URI for the contact information. This MUST be in the form of a URI. */
15
+ url?: string;
16
+ /** The email address of the contact person/organization. This MUST be in the form of an email address. */
17
+ email?: string;
18
+ };
19
+ //# sourceMappingURL=contact.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"contact.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/contact.ts"],"names":[],"mappings":"AAEA,+CAA+C;AAC/C,eAAO,MAAM,6BAA6B;IACxC,+DAA+D;;IAE/D,8EAA8E;;IAE9E,0GAA0G;;EAE1G,CAAA;AAEF,+CAA+C;AAC/C,MAAM,MAAM,aAAa,GAAG;IAC1B,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8EAA8E;IAC9E,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,0GAA0G;IAC1G,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}
@@ -0,0 +1,10 @@
1
+ import { Type } from '@scalar/typebox';
2
+ /** Contact information for the exposed API. */
3
+ export const ContactObjectSchemaDefinition = Type.Object({
4
+ /** The identifying name of the contact person/organization. */
5
+ name: Type.Optional(Type.String()),
6
+ /** The URI for the contact information. This MUST be in the form of a URI. */
7
+ url: Type.Optional(Type.String()),
8
+ /** The email address of the contact person/organization. This MUST be in the form of an email address. */
9
+ email: Type.Optional(Type.String()),
10
+ });
@@ -0,0 +1,27 @@
1
+ /**
2
+ * When request bodies or response payloads may be one of a number of different schemas, a Discriminator Object gives a hint about the expected schema of the document. This hint can be used to aid in serialization, deserialization, and validation. The Discriminator Object does this by implicitly or explicitly associating the possible values of a named property with alternative schemas.
3
+ *
4
+ * Note that discriminator MUST NOT change the validation outcome of the schema.
5
+ */
6
+ export declare const DiscriminatorObjectSchemaDefinition: import("@scalar/typebox").TObject<{
7
+ /** REQUIRED. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. */
8
+ propertyName: import("@scalar/typebox").TString;
9
+ /** An object to hold mappings between payload values and schema names or URI references. */
10
+ mapping: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
11
+ /** The schema name or URI reference to the schema that should validate the value of the discriminating property when it is absent or not found in the mapping. Added in OpenAPI 3.2. */
12
+ defaultMapping: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
13
+ }>;
14
+ /**
15
+ * When request bodies or response payloads may be one of a number of different schemas, a Discriminator Object gives a hint about the expected schema of the document. This hint can be used to aid in serialization, deserialization, and validation. The Discriminator Object does this by implicitly or explicitly associating the possible values of a named property with alternative schemas.
16
+ *
17
+ * Note that discriminator MUST NOT change the validation outcome of the schema.
18
+ */
19
+ export type DiscriminatorObject = {
20
+ /** REQUIRED. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. */
21
+ propertyName: string;
22
+ /** An object to hold mappings between payload values and schema names or URI references. */
23
+ mapping?: Record<string, string>;
24
+ /** The schema name or URI reference to the schema that should validate the value of the discriminating property when it is absent or not found in the mapping. Added in OpenAPI 3.2. */
25
+ defaultMapping?: string;
26
+ };
27
+ //# sourceMappingURL=discriminator.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"discriminator.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/discriminator.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,mCAAmC;IAC9C,mNAAmN;;IAEnN,4FAA4F;;IAE5F,wLAAwL;;EAExL,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,mNAAmN;IACnN,YAAY,EAAE,MAAM,CAAA;IACpB,4FAA4F;IAC5F,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,wLAAwL;IACxL,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA"}
@@ -0,0 +1,14 @@
1
+ import { Type } from '@scalar/typebox';
2
+ /**
3
+ * When request bodies or response payloads may be one of a number of different schemas, a Discriminator Object gives a hint about the expected schema of the document. This hint can be used to aid in serialization, deserialization, and validation. The Discriminator Object does this by implicitly or explicitly associating the possible values of a named property with alternative schemas.
4
+ *
5
+ * Note that discriminator MUST NOT change the validation outcome of the schema.
6
+ */
7
+ export const DiscriminatorObjectSchemaDefinition = Type.Object({
8
+ /** REQUIRED. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. */
9
+ propertyName: Type.String(),
10
+ /** An object to hold mappings between payload values and schema names or URI references. */
11
+ mapping: Type.Optional(Type.Record(Type.String(), Type.String())),
12
+ /** The schema name or URI reference to the schema that should validate the value of the discriminating property when it is absent or not found in the mapping. Added in OpenAPI 3.2. */
13
+ defaultMapping: Type.Optional(Type.String()),
14
+ });
@@ -0,0 +1,62 @@
1
+ import type { HeaderObject } from './header.js';
2
+ import { type ReferenceType } from './reference.js';
3
+ /**
4
+ * A single encoding definition applied to a single schema property. See Appendix B for a discussion of converting values of various types to string representations.
5
+ *
6
+ * Properties are correlated with multipart parts using the name parameter of Content-Disposition: form-data, and with application/x-www-form-urlencoded using the query string parameter names. In both cases, their order is implementation-defined.
7
+ *
8
+ * See Appendix E for a detailed examination of percent-encoding concerns for form media types.
9
+ */
10
+ export declare const EncodingObjectSchemaDefinition: import("@scalar/typebox").TObject<{
11
+ /** The Content-Type for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. image/png) or a wildcard media type (e.g. image/*). Default value depends on the property type as shown in the table below. */
12
+ contentType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
13
+ /** A map allowing additional information to be provided as headers. Content-Type is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a multipart. */
14
+ headers: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"HeaderObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
15
+ $ref: import("@scalar/typebox").TString;
16
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
17
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
18
+ }>, import("@scalar/typebox").TObject<{
19
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
20
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
21
+ }>]>, import("@scalar/typebox").TObject<{
22
+ '$ref-value': import("@scalar/typebox").TRef<"HeaderObject">;
23
+ }>]>]>>>;
24
+ /** Describes how a specific property value will be serialized depending on its type. See the Parameter Object for details on the style field. The behavior follows the same values as query parameters, including default values. Valid values are "form", "spaceDelimited", "pipeDelimited", and "deepObject". This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
25
+ style: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"form">, import("@scalar/typebox").TLiteral<"spaceDelimited">, import("@scalar/typebox").TLiteral<"pipeDelimited">, import("@scalar/typebox").TLiteral<"deepObject">]>>;
26
+ /** When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this field has no effect. When style is "form", the default value is true. For all other styles, the default value is false. This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
27
+ explode: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
28
+ /** When this is true, parameter values are serialized using reserved expansion, as defined by RFC6570, which allows RFC3986's reserved character set, as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including % outside of percent-encoded triples). The default value is false. This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
29
+ allowReserved: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
30
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's encoding field. Added in OpenAPI 3.2. */
31
+ encoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"EncodingObject">>>;
32
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's prefixEncoding field. Added in OpenAPI 3.2. */
33
+ prefixEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TRef<"EncodingObject">>>;
34
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's itemEncoding field. Added in OpenAPI 3.2. */
35
+ itemEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"EncodingObject">>;
36
+ }>;
37
+ /**
38
+ * A single encoding definition applied to a single schema property. See Appendix B for a discussion of converting values of various types to string representations.
39
+ *
40
+ * Properties are correlated with multipart parts using the name parameter of Content-Disposition: form-data, and with application/x-www-form-urlencoded using the query string parameter names. In both cases, their order is implementation-defined.
41
+ *
42
+ * See Appendix E for a detailed examination of percent-encoding concerns for form media types.
43
+ */
44
+ export type EncodingObject = {
45
+ /** The Content-Type for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. image/png) or a wildcard media type (e.g. image/*). Default value depends on the property type as shown in the table below. */
46
+ contentType?: string;
47
+ /** A map allowing additional information to be provided as headers. Content-Type is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a multipart. */
48
+ headers?: Record<string, ReferenceType<HeaderObject>>;
49
+ /** Describes how a specific property value will be serialized depending on its type. See the Parameter Object for details on the style field. The behavior follows the same values as query parameters, including default values. Valid values are "form", "spaceDelimited", "pipeDelimited", and "deepObject". This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
50
+ style?: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | undefined;
51
+ /** When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this field has no effect. When style is "form", the default value is true. For all other styles, the default value is false. This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
52
+ explode?: boolean;
53
+ /** When this is true, parameter values are serialized using reserved expansion, as defined by RFC6570, which allows RFC3986's reserved character set, as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including % outside of percent-encoded triples). The default value is false. This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
54
+ allowReserved?: boolean;
55
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's encoding field. Added in OpenAPI 3.2. */
56
+ encoding?: Record<string, EncodingObject>;
57
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's prefixEncoding field. Added in OpenAPI 3.2. */
58
+ prefixEncoding?: EncodingObject[];
59
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's itemEncoding field. Added in OpenAPI 3.2. */
60
+ itemEncoding?: EncodingObject;
61
+ };
62
+ //# sourceMappingURL=encoding.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/encoding.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAE5C,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAE3D;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;IACzC,sRAAsR;;IAEtR,iOAAiO;;;;;;;;;;;IAEjO,whBAAwhB;;IASxhB,yhBAAyhB;;IAEzhB,wkBAAwkB;;IAExkB,0HAA0H;;IAE1H,gIAAgI;;IAEhI,8HAA8H;;EAE9H,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,sRAAsR;IACtR,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iOAAiO;IACjO,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAA;IACrD,whBAAwhB;IACxhB,KAAK,CAAC,EAAE,MAAM,GAAG,gBAAgB,GAAG,eAAe,GAAG,YAAY,GAAG,SAAS,CAAA;IAC9E,yhBAAyhB;IACzhB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,wkBAAwkB;IACxkB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,0HAA0H;IAC1H,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IACzC,gIAAgI;IAChI,cAAc,CAAC,EAAE,cAAc,EAAE,CAAA;IACjC,8HAA8H;IAC9H,YAAY,CAAC,EAAE,cAAc,CAAA;CAC9B,CAAA"}
@@ -0,0 +1,33 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { EncodingObjectRef, HeaderObjectRef } from './ref-definitions.js';
3
+ import { reference } from './reference.js';
4
+ /**
5
+ * A single encoding definition applied to a single schema property. See Appendix B for a discussion of converting values of various types to string representations.
6
+ *
7
+ * Properties are correlated with multipart parts using the name parameter of Content-Disposition: form-data, and with application/x-www-form-urlencoded using the query string parameter names. In both cases, their order is implementation-defined.
8
+ *
9
+ * See Appendix E for a detailed examination of percent-encoding concerns for form media types.
10
+ */
11
+ export const EncodingObjectSchemaDefinition = Type.Object({
12
+ /** The Content-Type for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. image/png) or a wildcard media type (e.g. image/*). Default value depends on the property type as shown in the table below. */
13
+ contentType: Type.Optional(Type.String()),
14
+ /** A map allowing additional information to be provided as headers. Content-Type is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a multipart. */
15
+ headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObjectRef, reference(HeaderObjectRef)]))),
16
+ /** Describes how a specific property value will be serialized depending on its type. See the Parameter Object for details on the style field. The behavior follows the same values as query parameters, including default values. Valid values are "form", "spaceDelimited", "pipeDelimited", and "deepObject". This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
17
+ style: Type.Optional(Type.Union([
18
+ Type.Literal('form'),
19
+ Type.Literal('spaceDelimited'),
20
+ Type.Literal('pipeDelimited'),
21
+ Type.Literal('deepObject'),
22
+ ])),
23
+ /** When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this field has no effect. When style is "form", the default value is true. For all other styles, the default value is false. This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
24
+ explode: Type.Optional(Type.Boolean()),
25
+ /** When this is true, parameter values are serialized using reserved expansion, as defined by RFC6570, which allows RFC3986's reserved character set, as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including % outside of percent-encoded triples). The default value is false. This field SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
26
+ allowReserved: Type.Optional(Type.Boolean()),
27
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's encoding field. Added in OpenAPI 3.2. */
28
+ encoding: Type.Optional(Type.Record(Type.String(), EncodingObjectRef)),
29
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's prefixEncoding field. Added in OpenAPI 3.2. */
30
+ prefixEncoding: Type.Optional(Type.Array(EncodingObjectRef)),
31
+ /** Applies nested Encoding Objects in the same manner as the Media Type Object's itemEncoding field. Added in OpenAPI 3.2. */
32
+ itemEncoding: Type.Optional(EncodingObjectRef),
33
+ });
@@ -0,0 +1,50 @@
1
+ /**
2
+ * An object grouping an internal or external example value with basic summary and description metadata. This object is typically used in fields named examples (plural), and is a referenceable alternative to older example (singular) fields that do not support referencing or metadata.
3
+ *
4
+ * Examples allow demonstration of the usage of properties, parameters and objects within OpenAPI.
5
+ */
6
+ export declare const ExampleObjectSchemaDefinition: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
7
+ /** Short description for the example. */
8
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
9
+ /** Long description for the example. CommonMark syntax MAY be used for rich text representation. */
10
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
11
+ /** An example of the data structure that MUST be valid according to the relevant Schema Object. If this field is present, value MUST be absent. Added in OpenAPI 3.2. */
12
+ dataValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
13
+ /** An example of the serialized form of the value, including encoding and escaping as described under Validating Examples. This field SHOULD NOT be used if the serialization format is JSON. If this field is present, value and externalValue MUST be absent. Added in OpenAPI 3.2. */
14
+ serializedValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
15
+ /** Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. */
16
+ value: import("@scalar/typebox").TOptional<import("@scalar/typebox").TAny>;
17
+ /** A URI that identifies the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive. See the rules for resolving Relative References. */
18
+ externalValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
19
+ }>, import("@scalar/typebox").TObject<{
20
+ 'x-disabled': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
21
+ }>]>;
22
+ /**
23
+ * An object grouping an internal or external example value with basic summary and description metadata. This object is typically used in fields named examples (plural), and is a referenceable alternative to older example (singular) fields that do not support referencing or metadata.
24
+ *
25
+ * Examples allow demonstration of the usage of properties, parameters and objects within OpenAPI.
26
+ */
27
+ export type ExampleObject = {
28
+ /** Short description for the example. */
29
+ summary?: string;
30
+ /** Long description for the example. CommonMark syntax MAY be used for rich text representation. */
31
+ description?: string;
32
+ /** An example of the data structure that MUST be valid according to the relevant Schema Object. If this field is present, value MUST be absent. Added in OpenAPI 3.2. */
33
+ dataValue?: unknown;
34
+ /** An example of the serialized form of the value, including encoding and escaping as described under Validating Examples. This field SHOULD NOT be used if the serialization format is JSON. If this field is present, value and externalValue MUST be absent. Added in OpenAPI 3.2. */
35
+ serializedValue?: string;
36
+ /** Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. */
37
+ value?: any;
38
+ /** A URI that identifies the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive. See the rules for resolving Relative References. */
39
+ externalValue?: string;
40
+ /**
41
+ * OpenAPI extension to control whether a parameter example is enabled (checkbox on) or disabled (checkbox off).
42
+ *
43
+ * This extension is typically used in API tools to determine if a parameter (such as a header, query, or cookie)
44
+ * should be included in the request when sending an example. If `x-disabled: true`, the parameter example is considered
45
+ * "off" (checkbox unchecked) and will not be sent with the request. If `x-disabled: false` or omitted, the parameter
46
+ * example is "on" (checkbox checked) and will be sent.
47
+ */
48
+ 'x-disabled'?: boolean;
49
+ };
50
+ //# sourceMappingURL=example.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/example.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,eAAO,MAAM,6BAA6B;IAEtC,yCAAyC;;IAEzC,oGAAoG;;IAEpG,yKAAyK;;IAEzK,yRAAyR;;IAEzR,6PAA6P;;IAE7P,+QAA+Q;;;;IAIlR,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oGAAoG;IACpG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,yKAAyK;IACzK,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,yRAAyR;IACzR,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,6PAA6P;IAC7P,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,+QAA+Q;IAC/Q,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA"}
@@ -0,0 +1,22 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { compose } from '../../../schemas/compose.js';
3
+ import { XDisabledSchema } from '../../../schemas/extensions/example/x-disabled.js';
4
+ /**
5
+ * An object grouping an internal or external example value with basic summary and description metadata. This object is typically used in fields named examples (plural), and is a referenceable alternative to older example (singular) fields that do not support referencing or metadata.
6
+ *
7
+ * Examples allow demonstration of the usage of properties, parameters and objects within OpenAPI.
8
+ */
9
+ export const ExampleObjectSchemaDefinition = compose(Type.Object({
10
+ /** Short description for the example. */
11
+ summary: Type.Optional(Type.String()),
12
+ /** Long description for the example. CommonMark syntax MAY be used for rich text representation. */
13
+ description: Type.Optional(Type.String()),
14
+ /** An example of the data structure that MUST be valid according to the relevant Schema Object. If this field is present, value MUST be absent. Added in OpenAPI 3.2. */
15
+ dataValue: Type.Optional(Type.Unknown()),
16
+ /** An example of the serialized form of the value, including encoding and escaping as described under Validating Examples. This field SHOULD NOT be used if the serialization format is JSON. If this field is present, value and externalValue MUST be absent. Added in OpenAPI 3.2. */
17
+ serializedValue: Type.Optional(Type.String()),
18
+ /** Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. */
19
+ value: Type.Optional(Type.Any()),
20
+ /** A URI that identifies the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive. See the rules for resolving Relative References. */
21
+ externalValue: Type.Optional(Type.String()),
22
+ }), XDisabledSchema);
@@ -0,0 +1,15 @@
1
+ /** Allows referencing an external resource for extended documentation. */
2
+ export declare const ExternalDocumentationObjectSchemaDefinition: import("@scalar/typebox").TObject<{
3
+ /** REQUIRED. The URI for the target documentation. This MUST be in the form of a URI. */
4
+ url: import("@scalar/typebox").TString;
5
+ /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
6
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
7
+ }>;
8
+ /** Allows referencing an external resource for extended documentation. */
9
+ export type ExternalDocumentationObject = {
10
+ /** REQUIRED. The URI for the target documentation. This MUST be in the form of a URI. */
11
+ url: string;
12
+ /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
13
+ description?: string;
14
+ };
15
+ //# sourceMappingURL=external-documentation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"external-documentation.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/external-documentation.ts"],"names":[],"mappings":"AAEA,0EAA0E;AAC1E,eAAO,MAAM,2CAA2C;IACtD,yFAAyF;;IAEzF,6GAA6G;;EAE7G,CAAA;AAEF,0EAA0E;AAC1E,MAAM,MAAM,2BAA2B,GAAG;IACxC,yFAAyF;IACzF,GAAG,EAAE,MAAM,CAAA;IACX,6GAA6G;IAC7G,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA"}