@scalar/workspace-store 0.52.0 → 0.54.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 +55 -0
  2. package/dist/channel-example/build-connection-url.d.ts.map +1 -1
  3. package/dist/channel-example/build-connection-url.js +11 -8
  4. package/dist/channel-example/get-all-channel-messages.d.ts +10 -0
  5. package/dist/channel-example/get-all-channel-messages.d.ts.map +1 -0
  6. package/dist/channel-example/get-all-channel-messages.js +16 -0
  7. package/dist/channel-example/get-asyncapi-security-requirements.d.ts +7 -0
  8. package/dist/channel-example/get-asyncapi-security-requirements.d.ts.map +1 -0
  9. package/dist/channel-example/get-asyncapi-security-requirements.js +76 -0
  10. package/dist/channel-example/get-channel-connection-context.d.ts +16 -0
  11. package/dist/channel-example/get-channel-connection-context.d.ts.map +1 -0
  12. package/dist/channel-example/get-channel-connection-context.js +120 -0
  13. package/dist/channel-example/get-channel-connection-security.d.ts +8 -0
  14. package/dist/channel-example/get-channel-connection-security.d.ts.map +1 -0
  15. package/dist/channel-example/get-channel-connection-security.js +20 -0
  16. package/dist/channel-example/get-channel-operations.d.ts +11 -0
  17. package/dist/channel-example/get-channel-operations.d.ts.map +1 -0
  18. package/dist/channel-example/get-channel-operations.js +20 -0
  19. package/dist/channel-example/get-channel-parameters.d.ts +14 -0
  20. package/dist/channel-example/get-channel-parameters.d.ts.map +1 -0
  21. package/dist/channel-example/get-channel-parameters.js +59 -0
  22. package/dist/channel-example/index.d.ts +15 -0
  23. package/dist/channel-example/index.d.ts.map +1 -1
  24. package/dist/channel-example/index.js +9 -0
  25. package/dist/channel-example/resolve-channel.d.ts +11 -0
  26. package/dist/channel-example/resolve-channel.d.ts.map +1 -0
  27. package/dist/channel-example/resolve-channel.js +13 -0
  28. package/dist/channel-example/resolve-operation-channel.d.ts +11 -0
  29. package/dist/channel-example/resolve-operation-channel.d.ts.map +1 -0
  30. package/dist/channel-example/resolve-operation-channel.js +39 -0
  31. package/dist/channel-example/resolve-operation-with-traits.d.ts +6 -0
  32. package/dist/channel-example/resolve-operation-with-traits.d.ts.map +1 -0
  33. package/dist/channel-example/resolve-operation-with-traits.js +41 -0
  34. package/dist/channel-example/servers.d.ts.map +1 -1
  35. package/dist/channel-example/servers.js +23 -0
  36. package/dist/channel-example/types.d.ts +41 -0
  37. package/dist/channel-example/types.d.ts.map +1 -0
  38. package/dist/channel-example/types.js +1 -0
  39. package/dist/client.d.ts.map +1 -1
  40. package/dist/client.js +8 -8
  41. package/dist/entities/auth/schema.d.ts +1473 -88
  42. package/dist/entities/auth/schema.d.ts.map +1 -1
  43. package/dist/events/definitions/meta.d.ts +5 -3
  44. package/dist/events/definitions/meta.d.ts.map +1 -1
  45. package/dist/events/definitions/server.d.ts +21 -0
  46. package/dist/events/definitions/server.d.ts.map +1 -1
  47. package/dist/events/definitions/workspace.d.ts +7 -3
  48. package/dist/events/definitions/workspace.d.ts.map +1 -1
  49. package/dist/helpers/get-name-from-ref.d.ts +15 -0
  50. package/dist/helpers/get-name-from-ref.d.ts.map +1 -0
  51. package/dist/helpers/get-name-from-ref.js +37 -0
  52. package/dist/mutators/index.d.ts +4 -0
  53. package/dist/mutators/index.d.ts.map +1 -1
  54. package/dist/mutators/server.d.ts +26 -0
  55. package/dist/mutators/server.d.ts.map +1 -1
  56. package/dist/mutators/server.js +44 -1
  57. package/dist/navigation/get-navigation-options.d.ts +2 -2
  58. package/dist/navigation/get-navigation-options.d.ts.map +1 -1
  59. package/dist/navigation/get-navigation-options.js +26 -3
  60. package/dist/navigation/helpers/traverse-asyncapi-document.d.ts +23 -0
  61. package/dist/navigation/helpers/traverse-asyncapi-document.d.ts.map +1 -0
  62. package/dist/navigation/helpers/traverse-asyncapi-document.js +479 -0
  63. package/dist/navigation/helpers/traverse-description.d.ts +4 -3
  64. package/dist/navigation/helpers/traverse-description.d.ts.map +1 -1
  65. package/dist/navigation/helpers/traverse-description.js +2 -2
  66. package/dist/navigation/helpers/traverse-document.d.ts.map +1 -1
  67. package/dist/navigation/helpers/traverse-document.js +3 -3
  68. package/dist/navigation/index.d.ts +1 -0
  69. package/dist/navigation/index.d.ts.map +1 -1
  70. package/dist/navigation/index.js +1 -0
  71. package/dist/navigation/types.d.ts +3 -0
  72. package/dist/navigation/types.d.ts.map +1 -1
  73. package/dist/request-example/builder/body/build-request-body.d.ts.map +1 -1
  74. package/dist/request-example/builder/body/build-request-body.js +32 -1
  75. package/dist/request-example/builder/body/serialize-form-property.d.ts +23 -0
  76. package/dist/request-example/builder/body/serialize-form-property.d.ts.map +1 -0
  77. package/dist/request-example/builder/body/serialize-form-property.js +101 -0
  78. package/dist/request-example/builder/header/de-serialize-parameter.d.ts +4 -1
  79. package/dist/request-example/builder/header/de-serialize-parameter.d.ts.map +1 -1
  80. package/dist/request-example/builder/header/de-serialize-parameter.js +19 -13
  81. package/dist/request-example/builder/index.d.ts +1 -0
  82. package/dist/request-example/builder/index.d.ts.map +1 -1
  83. package/dist/request-example/builder/index.js +1 -0
  84. package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts +1 -1
  85. package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts.map +1 -1
  86. package/dist/request-example/context/security/extract-security-scheme-secrets.js +12 -8
  87. package/dist/request-example/context/security/merge-security.d.ts +1 -1
  88. package/dist/request-example/context/security/merge-security.d.ts.map +1 -1
  89. package/dist/request-example/context/security/merge-security.js +2 -2
  90. package/dist/request-example/index.d.ts +1 -1
  91. package/dist/request-example/index.d.ts.map +1 -1
  92. package/dist/request-example/index.js +1 -1
  93. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +1 -3
  94. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
  95. package/dist/schemas/extensions/document/x-scalar-sdk-installation.js +0 -2
  96. package/dist/schemas/extensions/operation/index.d.ts +1 -1
  97. package/dist/schemas/extensions/operation/index.d.ts.map +1 -1
  98. package/dist/schemas/extensions/operation/x-code-samples.d.ts +71 -0
  99. package/dist/schemas/extensions/operation/x-code-samples.d.ts.map +1 -1
  100. package/dist/schemas/extensions/operation/x-code-samples.js +50 -7
  101. package/dist/schemas/navigation.d.ts +113 -4
  102. package/dist/schemas/navigation.d.ts.map +1 -1
  103. package/dist/schemas/navigation.js +22 -0
  104. package/dist/schemas/reference-config/index.d.ts +286 -9
  105. package/dist/schemas/reference-config/index.d.ts.map +1 -1
  106. package/dist/schemas/reference-config/settings.d.ts +286 -9
  107. package/dist/schemas/reference-config/settings.d.ts.map +1 -1
  108. package/dist/schemas/v3.1/openapi/index.d.ts +0 -1
  109. package/dist/schemas/v3.1/openapi/index.d.ts.map +1 -1
  110. package/dist/schemas/v3.1/openapi/index.js +59 -17
  111. package/dist/schemas/v3.1/strict/info.d.ts +0 -1
  112. package/dist/schemas/v3.1/strict/info.d.ts.map +1 -1
  113. package/dist/schemas/v3.1/strict/openapi-document.d.ts +11168 -1473
  114. package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
  115. package/dist/schemas/v3.1/strict/openapi-document.js +4 -1
  116. package/dist/schemas/v3.1/strict/operation.d.ts +25 -0
  117. package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
  118. package/dist/schemas/v3.1/strict/ref-definitions.d.ts +3 -0
  119. package/dist/schemas/v3.1/strict/ref-definitions.d.ts.map +1 -1
  120. package/dist/schemas/v3.1/strict/ref-definitions.js +3 -0
  121. package/dist/schemas/v3.1/strict/schema.d.ts +387 -26
  122. package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
  123. package/dist/schemas/v3.1/strict/schema.js +53 -28
  124. package/dist/schemas/workspace-specification/index.d.ts +1 -1
  125. package/dist/schemas/workspace.d.ts +2 -3
  126. package/dist/schemas/workspace.d.ts.map +1 -1
  127. package/dist/schemas/workspace.js +5 -1
  128. package/package.json +7 -7
@@ -14,21 +14,20 @@ import { type ReferenceObject } from './reference.js';
14
14
  export type SchemaReferenceType<Value> = Value | (ReferenceObject & {
15
15
  '$ref-value': unknown;
16
16
  });
17
+ type PrimitiveSchemaType = 'null' | 'boolean' | 'string' | 'number' | 'integer' | 'object' | 'array';
17
18
  /** We use this type to ensure that we are parsing a schema object as every property can be optional */
18
19
  type _InternalType = CoreProperties & {
19
20
  __scalar_: string;
20
21
  } & Extensions;
21
22
  /**
22
23
  * Primitive types that don't have additional validation properties.
23
- * These types (null, boolean, string, number, integer, object, array) can be used
24
+ * These types (null, boolean) can be used
24
25
  * without additional validation constraints.
25
- *
26
- * TODO: Type array will actually validate against every union type but we can cross that bridge when we come to it
27
26
  */
28
27
  declare const OtherTypes: import("@scalar/typebox").TObject<{
29
- type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TLiteral<"string">, import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">, import("@scalar/typebox").TLiteral<"object">, import("@scalar/typebox").TLiteral<"array">]>>]>;
28
+ type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">]>;
30
29
  }>;
31
- type OtherType = 'boolean' | 'null' | ('string' | 'number' | 'boolean' | 'object' | 'null' | 'integer' | 'array')[];
30
+ type OtherType = 'boolean' | 'null';
32
31
  type OtherTypes = CoreProperties & {
33
32
  type: OtherType;
34
33
  } & Extensions;
@@ -55,6 +54,22 @@ declare const Extensions: import("@scalar/typebox").TIntersect<[import("@scalar/
55
54
  }>]>;
56
55
  type Extensions = XScalarIgnore & XInternal & XVariable & XEnumDescriptions & XEnumVarNames & XExamples & XAdditionalPropertiesName & XOrder & XTags;
57
56
  type CoreProperties = {
57
+ /**
58
+ * JSON Schema 2020-12 core reference keywords.
59
+ *
60
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
61
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
62
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
63
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
64
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
65
+ */
66
+ $id?: string;
67
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
68
+ $anchor?: string;
69
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
70
+ $dynamicAnchor?: string;
71
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
72
+ $dynamicRef?: string;
58
73
  name?: string;
59
74
  /** A title for the schema. */
60
75
  title?: string;
@@ -104,10 +119,7 @@ type CoreProperties = {
104
119
  /** Schema must not be valid. */
105
120
  not?: SchemaReferenceType<SchemaObject>;
106
121
  };
107
- type NumericObject = CoreProperties & {
108
- type: 'number' | 'integer';
109
- /** Different subtypes */
110
- format?: 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'double-int' | 'float' | 'double' | 'decimal' | 'decimal128' | 'sf-integer' | 'sf-decimal' | (string & {});
122
+ type NumericKeywords = {
111
123
  /** Number must be a multiple of this value. */
112
124
  multipleOf?: number;
113
125
  /** Maximum value (inclusive). */
@@ -118,6 +130,12 @@ type NumericObject = CoreProperties & {
118
130
  minimum?: number;
119
131
  /** Minimum value (exclusive). */
120
132
  exclusiveMinimum?: number;
133
+ };
134
+ type NumericFormat = 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'double-int' | 'float' | 'double' | 'decimal' | 'decimal128' | 'sf-integer' | 'sf-decimal' | (string & {});
135
+ type NumericObject = CoreProperties & NumericKeywords & {
136
+ type: 'number' | 'integer';
137
+ /** Different subtypes */
138
+ format?: NumericFormat;
121
139
  } & Extensions;
122
140
  /**
123
141
  * Supported string formats in OpenAPI schemas.
@@ -126,19 +144,20 @@ type NumericObject = CoreProperties & {
126
144
  * in the schema, so we type it in typescript instead. This gives us autocomplete while allowing any string!
127
145
  */
128
146
  type StringFormat = 'date' | 'date-time' | 'date-time-local' | 'time' | 'time-local' | 'duration' | 'http-date' | 'email' | 'idn-email' | 'hostname' | 'idn-hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uri-reference' | 'uri-template' | 'iri' | 'iri-reference' | 'uuid' | 'binary' | 'byte' | 'base64url' | 'html' | 'commonmark' | 'password' | 'regex' | 'json-pointer' | 'relative-json-pointer' | 'media-range' | 'char' | 'sf-string' | 'sf-token' | 'sf-binary' | 'sf-boolean' | (string & {});
129
- type StringObject = CoreProperties & {
130
- type: 'string';
131
- /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
132
- format?: StringFormat;
147
+ type StringKeywords = {
133
148
  /** Maximum string length. */
134
149
  maxLength?: number;
135
150
  /** Minimum string length. */
136
151
  minLength?: number;
137
152
  /** Regular expression pattern. */
138
153
  pattern?: string;
154
+ };
155
+ type StringObject = CoreProperties & StringKeywords & {
156
+ type: 'string';
157
+ /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
158
+ format?: StringFormat;
139
159
  } & Extensions;
140
- type ArrayObject = CoreProperties & {
141
- type: 'array';
160
+ type ArrayKeywords = {
142
161
  /** Maximum number of items in array. */
143
162
  maxItems?: number;
144
163
  /** Minimum number of items in array. */
@@ -149,9 +168,11 @@ type ArrayObject = CoreProperties & {
149
168
  items?: SchemaReferenceType<SchemaObject>;
150
169
  /** Schema for tuple validation. */
151
170
  prefixItems?: SchemaReferenceType<SchemaObject>[];
171
+ };
172
+ type ArrayObject = CoreProperties & ArrayKeywords & {
173
+ type: 'array';
152
174
  } & Extensions;
153
- type ObjectObject = CoreProperties & {
154
- type: 'object';
175
+ type ObjectKeywords = {
155
176
  /** Maximum number of properties. */
156
177
  maxProperties?: number;
157
178
  /** Minimum number of properties. */
@@ -166,11 +187,35 @@ type ObjectObject = CoreProperties & {
166
187
  patternProperties?: Record<string, SchemaReferenceType<SchemaObject>>;
167
188
  /** Constraints on property names (JSON Schema propertyNames keyword). */
168
189
  propertyNames?: SchemaReferenceType<SchemaObject>;
190
+ };
191
+ type ObjectObject = CoreProperties & ObjectKeywords & {
192
+ type: 'object';
193
+ } & Extensions;
194
+ type MultiTypeObject = CoreProperties & NumericKeywords & StringKeywords & ArrayKeywords & ObjectKeywords & {
195
+ type: PrimitiveSchemaType[];
196
+ /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
197
+ format?: StringFormat | NumericFormat;
169
198
  } & Extensions;
170
199
  /** Builds the recursive schema schema */
171
200
  export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
172
201
  __scalar_: import("@scalar/typebox").TString;
173
202
  }>, import("@scalar/typebox").TObject<{
203
+ /**
204
+ * JSON Schema 2020-12 core reference keywords.
205
+ *
206
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
207
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
208
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
209
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
210
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
211
+ */
212
+ $id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
213
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
214
+ $anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
215
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
216
+ $dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
217
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
218
+ $dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
174
219
  name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
175
220
  /** A title for the schema. */
176
221
  title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
@@ -285,8 +330,24 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
285
330
  }>, import("@scalar/typebox").TObject<{
286
331
  'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
287
332
  }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
288
- type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TLiteral<"string">, import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">, import("@scalar/typebox").TLiteral<"object">, import("@scalar/typebox").TLiteral<"array">]>>]>;
333
+ type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">]>;
289
334
  }>, import("@scalar/typebox").TObject<{
335
+ /**
336
+ * JSON Schema 2020-12 core reference keywords.
337
+ *
338
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
339
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
340
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
341
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
342
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
343
+ */
344
+ $id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
345
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
346
+ $anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
347
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
348
+ $dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
349
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
350
+ $dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
290
351
  name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
291
352
  /** A title for the schema. */
292
353
  title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
@@ -400,10 +461,11 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
400
461
  'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
401
462
  }>, import("@scalar/typebox").TObject<{
402
463
  'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
403
- }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
464
+ }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
404
465
  type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">]>;
405
466
  /** Different subtypes */
406
467
  format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
468
+ }>, import("@scalar/typebox").TObject<{
407
469
  /** Number must be a multiple of this value. */
408
470
  multipleOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
409
471
  /** Maximum value (inclusive). */
@@ -414,7 +476,23 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
414
476
  minimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
415
477
  /** Minimum value (exclusive). */
416
478
  exclusiveMinimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
417
- }>, import("@scalar/typebox").TObject<{
479
+ }>]>, import("@scalar/typebox").TObject<{
480
+ /**
481
+ * JSON Schema 2020-12 core reference keywords.
482
+ *
483
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
484
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
485
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
486
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
487
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
488
+ */
489
+ $id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
490
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
491
+ $anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
492
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
493
+ $dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
494
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
495
+ $dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
418
496
  name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
419
497
  /** A title for the schema. */
420
498
  title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
@@ -528,17 +606,34 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
528
606
  'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
529
607
  }>, import("@scalar/typebox").TObject<{
530
608
  'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
531
- }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
609
+ }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
532
610
  type: import("@scalar/typebox").TLiteral<"string">;
533
611
  /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
534
612
  format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
613
+ }>, import("@scalar/typebox").TObject<{
535
614
  /** Maximum string length. */
536
615
  maxLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
537
616
  /** Minimum string length. */
538
617
  minLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
539
618
  /** Regular expression pattern. */
540
619
  pattern: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
541
- }>, import("@scalar/typebox").TObject<{
620
+ }>]>, import("@scalar/typebox").TObject<{
621
+ /**
622
+ * JSON Schema 2020-12 core reference keywords.
623
+ *
624
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
625
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
626
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
627
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
628
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
629
+ */
630
+ $id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
631
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
632
+ $anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
633
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
634
+ $dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
635
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
636
+ $dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
542
637
  name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
543
638
  /** A title for the schema. */
544
639
  title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
@@ -652,8 +747,9 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
652
747
  'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
653
748
  }>, import("@scalar/typebox").TObject<{
654
749
  'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
655
- }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
750
+ }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
656
751
  type: import("@scalar/typebox").TLiteral<"object">;
752
+ }>, import("@scalar/typebox").TObject<{
657
753
  /** Maximum number of properties. */
658
754
  maxProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
659
755
  /** Minimum number of properties. */
@@ -704,7 +800,23 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
704
800
  }>]>, import("@scalar/typebox").TObject<{
705
801
  '$ref-value': import("@scalar/typebox").TUnknown;
706
802
  }>]>]>>;
707
- }>, import("@scalar/typebox").TObject<{
803
+ }>]>, import("@scalar/typebox").TObject<{
804
+ /**
805
+ * JSON Schema 2020-12 core reference keywords.
806
+ *
807
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
808
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
809
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
810
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
811
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
812
+ */
813
+ $id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
814
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
815
+ $anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
816
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
817
+ $dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
818
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
819
+ $dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
708
820
  name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
709
821
  /** A title for the schema. */
710
822
  title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
@@ -818,8 +930,190 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
818
930
  'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
819
931
  }>, import("@scalar/typebox").TObject<{
820
932
  'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
821
- }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
933
+ }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
822
934
  type: import("@scalar/typebox").TLiteral<"array">;
935
+ }>, import("@scalar/typebox").TObject<{
936
+ /** Maximum number of items in array. */
937
+ maxItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
938
+ /** Minimum number of items in array. */
939
+ minItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
940
+ /** Whether array items must be unique. */
941
+ uniqueItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
942
+ /** Schema for array items. */
943
+ items: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
944
+ $ref: import("@scalar/typebox").TString;
945
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
946
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
947
+ }>, import("@scalar/typebox").TObject<{
948
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
949
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
950
+ }>]>, import("@scalar/typebox").TObject<{
951
+ '$ref-value': import("@scalar/typebox").TUnknown;
952
+ }>]>]>>;
953
+ /** Schema for tuple validation. */
954
+ prefixItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
955
+ $ref: import("@scalar/typebox").TString;
956
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
957
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
958
+ }>, import("@scalar/typebox").TObject<{
959
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
960
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
961
+ }>]>, import("@scalar/typebox").TObject<{
962
+ '$ref-value': import("@scalar/typebox").TUnknown;
963
+ }>]>]>>>;
964
+ }>]>, import("@scalar/typebox").TObject<{
965
+ /**
966
+ * JSON Schema 2020-12 core reference keywords.
967
+ *
968
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
969
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
970
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
971
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
972
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
973
+ */
974
+ $id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
975
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
976
+ $anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
977
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
978
+ $dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
979
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
980
+ $dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
981
+ name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
982
+ /** A title for the schema. */
983
+ title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
984
+ /** A description of the schema. */
985
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
986
+ /** Default value for the schema. */
987
+ default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
988
+ /** Array of allowed values. */
989
+ enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
990
+ /** Constant value that must match exactly. */
991
+ const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
992
+ /** Media type for content validation. */
993
+ contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
994
+ /** Content encoding. */
995
+ contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
996
+ /** Schema for content validation. */
997
+ contentSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
998
+ $ref: import("@scalar/typebox").TString;
999
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1000
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1001
+ }>, import("@scalar/typebox").TObject<{
1002
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1003
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1004
+ }>]>, import("@scalar/typebox").TObject<{
1005
+ '$ref-value': import("@scalar/typebox").TUnknown;
1006
+ }>]>]>>;
1007
+ /** Whether the schema is deprecated. */
1008
+ deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1009
+ /** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
1010
+ discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
1011
+ /** Whether the schema is read-only. */
1012
+ readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1013
+ /** Whether the schema is write-only. */
1014
+ writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1015
+ /** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
1016
+ xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
1017
+ /** Additional external documentation for this schema. */
1018
+ externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
1019
+ /**
1020
+ * A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
1021
+ *
1022
+ * @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
1023
+ */
1024
+ example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
1025
+ /**
1026
+ * An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
1027
+ * Each example should be a valid instance of the schema.
1028
+ */
1029
+ examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
1030
+ /** All schemas must be valid. */
1031
+ allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1032
+ $ref: import("@scalar/typebox").TString;
1033
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1034
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1035
+ }>, import("@scalar/typebox").TObject<{
1036
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1037
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1038
+ }>]>, import("@scalar/typebox").TObject<{
1039
+ '$ref-value': import("@scalar/typebox").TUnknown;
1040
+ }>]>]>>>;
1041
+ /** Exactly one schema must be valid. */
1042
+ oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1043
+ $ref: import("@scalar/typebox").TString;
1044
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1045
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1046
+ }>, import("@scalar/typebox").TObject<{
1047
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1048
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1049
+ }>]>, import("@scalar/typebox").TObject<{
1050
+ '$ref-value': import("@scalar/typebox").TUnknown;
1051
+ }>]>]>>>;
1052
+ /** At least one schema must be valid. */
1053
+ anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1054
+ $ref: import("@scalar/typebox").TString;
1055
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1056
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1057
+ }>, import("@scalar/typebox").TObject<{
1058
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1059
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1060
+ }>]>, import("@scalar/typebox").TObject<{
1061
+ '$ref-value': import("@scalar/typebox").TUnknown;
1062
+ }>]>]>>>;
1063
+ /** Schema must not be valid. */
1064
+ not: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1065
+ $ref: import("@scalar/typebox").TString;
1066
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1067
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1068
+ }>, import("@scalar/typebox").TObject<{
1069
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1070
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1071
+ }>]>, import("@scalar/typebox").TObject<{
1072
+ '$ref-value': import("@scalar/typebox").TUnknown;
1073
+ }>]>]>>;
1074
+ }>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1075
+ 'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1076
+ }>, import("@scalar/typebox").TObject<{
1077
+ 'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1078
+ }>, import("@scalar/typebox").TObject<{
1079
+ 'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1080
+ }>, import("@scalar/typebox").TObject<{
1081
+ 'x-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnknown>>;
1082
+ }>, import("@scalar/typebox").TObject<{
1083
+ 'x-enumDescriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
1084
+ 'x-enum-descriptions': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>, import("@scalar/typebox").TArray<import("@scalar/typebox").TString>]>>;
1085
+ }>, import("@scalar/typebox").TObject<{
1086
+ 'x-enum-varnames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
1087
+ 'x-enumNames': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
1088
+ }>, import("@scalar/typebox").TObject<{
1089
+ 'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1090
+ }>, import("@scalar/typebox").TObject<{
1091
+ 'x-order': import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
1092
+ }>, import("@scalar/typebox").TObject<{
1093
+ 'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
1094
+ }>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1095
+ type: import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TLiteral<"string">, import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">, import("@scalar/typebox").TLiteral<"object">, import("@scalar/typebox").TLiteral<"array">]>>;
1096
+ /** Different subtypes - allow any arbitrary string, this negates the purpose of having a union of formats so we type it in typescript instead */
1097
+ format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1098
+ }>, import("@scalar/typebox").TObject<{
1099
+ /** Number must be a multiple of this value. */
1100
+ multipleOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
1101
+ /** Maximum value (inclusive). */
1102
+ maximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
1103
+ /** Maximum value (exclusive). */
1104
+ exclusiveMaximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
1105
+ /** Minimum value (inclusive). */
1106
+ minimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
1107
+ /** Minimum value (exclusive). */
1108
+ exclusiveMinimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
1109
+ }>, import("@scalar/typebox").TObject<{
1110
+ /** Maximum string length. */
1111
+ maxLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
1112
+ /** Minimum string length. */
1113
+ minLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
1114
+ /** Regular expression pattern. */
1115
+ pattern: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1116
+ }>, import("@scalar/typebox").TObject<{
823
1117
  /** Maximum number of items in array. */
824
1118
  maxItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
825
1119
  /** Minimum number of items in array. */
@@ -849,6 +1143,73 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
849
1143
  '$ref-value': import("@scalar/typebox").TUnknown;
850
1144
  }>]>]>>>;
851
1145
  }>, import("@scalar/typebox").TObject<{
1146
+ /** Maximum number of properties. */
1147
+ maxProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
1148
+ /** Minimum number of properties. */
1149
+ minProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
1150
+ /** Array of required property names. */
1151
+ required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
1152
+ /** Object property definitions. */
1153
+ properties: 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<{
1154
+ $ref: import("@scalar/typebox").TString;
1155
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1156
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1157
+ }>, import("@scalar/typebox").TObject<{
1158
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1159
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1160
+ }>]>, import("@scalar/typebox").TObject<{
1161
+ '$ref-value': import("@scalar/typebox").TUnknown;
1162
+ }>]>]>>>;
1163
+ /** Schema for additional properties. */
1164
+ additionalProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TBoolean, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1165
+ $ref: import("@scalar/typebox").TString;
1166
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1167
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1168
+ }>, import("@scalar/typebox").TObject<{
1169
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1170
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1171
+ }>]>, import("@scalar/typebox").TObject<{
1172
+ '$ref-value': import("@scalar/typebox").TUnknown;
1173
+ }>]>]>]>>;
1174
+ /** Properties matching regex patterns. */
1175
+ patternProperties: 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<{
1176
+ $ref: import("@scalar/typebox").TString;
1177
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1178
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1179
+ }>, import("@scalar/typebox").TObject<{
1180
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1181
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1182
+ }>]>, import("@scalar/typebox").TObject<{
1183
+ '$ref-value': import("@scalar/typebox").TUnknown;
1184
+ }>]>]>>>;
1185
+ /** Constraints on property names (JSON Schema propertyNames keyword). */
1186
+ propertyNames: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
1187
+ $ref: import("@scalar/typebox").TString;
1188
+ summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1189
+ description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1190
+ }>, import("@scalar/typebox").TObject<{
1191
+ $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
1192
+ $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
1193
+ }>]>, import("@scalar/typebox").TObject<{
1194
+ '$ref-value': import("@scalar/typebox").TUnknown;
1195
+ }>]>]>>;
1196
+ }>]>, import("@scalar/typebox").TObject<{
1197
+ /**
1198
+ * JSON Schema 2020-12 core reference keywords.
1199
+ *
1200
+ * OpenAPI 3.1 adopts the JSON Schema 2020-12 dialect for Schema Objects, which means a schema may carry an
1201
+ * identifier (`$id`), a plain-name anchor (`$anchor`), and the dynamic binding keywords (`$dynamicAnchor` /
1202
+ * `$dynamicRef`) used for generic and recursive patterns such as `PaginatedResponse<T>`. We keep these typed so
1203
+ * the keywords survive parsing instead of being dropped as unknown properties. Resolution of `$dynamicRef`
1204
+ * against the active `$dynamicAnchor` is tracked separately, see https://github.com/scalar/scalar/issues/9414.
1205
+ */
1206
+ $id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1207
+ /** Plain-name anchor that other schemas can reference with `#anchor`. */
1208
+ $anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1209
+ /** Dynamic anchor, the target a matching `$dynamicRef` resolves to within the dynamic scope. */
1210
+ $dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
1211
+ /** Dynamic reference, resolved against the outermost matching `$dynamicAnchor` in the dynamic scope. */
1212
+ $dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
852
1213
  name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
853
1214
  /** A title for the schema. */
854
1215
  title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
@@ -963,7 +1324,7 @@ export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUn
963
1324
  }>, import("@scalar/typebox").TObject<{
964
1325
  'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
965
1326
  }>]>]>]>;
966
- export type SchemaObject = _InternalType | OtherTypes | NumericObject | StringObject | ObjectObject | ArrayObject;
1327
+ export type SchemaObject = _InternalType | OtherTypes | MultiTypeObject | NumericObject | StringObject | ObjectObject | ArrayObject;
967
1328
  export type MaybeRefSchemaObject = SchemaReferenceType<SchemaObject>;
968
1329
  export {};
969
1330
  //# sourceMappingURL=schema.d.ts.map