@scalar/workspace-store 0.40.2 → 0.40.4

package/dist/schemas/v3.1/strict/operation.js

@@ -1,30 +1,17 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-import { XInternalSchema } from "../../../schemas/extensions/document/x-internal.js";
-import { XScalarIgnoreSchema } from "../../../schemas/extensions/document/x-scalar-ignore.js";
-import { XBadgesSchema } from "../../../schemas/extensions/operation/x-badge.js";
-import { XCodeSamplesSchema } from "../../../schemas/extensions/operation/x-code-samples.js";
-import { XDraftExamplesSchema } from "../../../schemas/extensions/operation/x-draft-examples.js";
-import { XPostResponseSchema } from "../../../schemas/extensions/operation/x-post-response.js";
-import {
-  XScalarDisableParametersSchema
-} from "../../../schemas/extensions/operation/x-scalar-disable-parameters.js";
-import { XScalarStabilitySchema } from "../../../schemas/extensions/operation/x-scalar-stability.js";
-import {
-  XScalarSelectedServerSchema
-} from "../../../schemas/extensions/server/x-scalar-selected-server.js";
-import {
-  CallbackObjectRef,
-  ExternalDocumentationObjectRef,
-  ParameterObjectRef,
-  RequestBodyObjectRef,
-  ResponsesObjectRef,
-  SecurityRequirementObjectRef,
-  ServerObjectRef
-} from "./ref-definitions.js";
-import { reference } from "./reference.js";
-const OperationObjectSchemaDefinition = compose(
-  Type.Object({
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+import { XInternalSchema } from '../../../schemas/extensions/document/x-internal.js';
+import { XScalarIgnoreSchema } from '../../../schemas/extensions/document/x-scalar-ignore.js';
+import { XBadgesSchema } from '../../../schemas/extensions/operation/x-badge.js';
+import { XCodeSamplesSchema } from '../../../schemas/extensions/operation/x-code-samples.js';
+import { XDraftExamplesSchema } from '../../../schemas/extensions/operation/x-draft-examples.js';
+import { XPostResponseSchema } from '../../../schemas/extensions/operation/x-post-response.js';
+import { XScalarDisableParametersSchema, } from '../../../schemas/extensions/operation/x-scalar-disable-parameters.js';
+import { XScalarStabilitySchema } from '../../../schemas/extensions/operation/x-scalar-stability.js';
+import { XScalarSelectedServerSchema, } from '../../../schemas/extensions/server/x-scalar-selected-server.js';
+import { CallbackObjectRef, ExternalDocumentationObjectRef, ParameterObjectRef, RequestBodyObjectRef, ResponsesObjectRef, SecurityRequirementObjectRef, ServerObjectRef, } from './ref-definitions.js';
+import { reference } from './reference.js';
+export const OperationObjectSchemaDefinition = compose(Type.Object({
     /** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */
     tags: Type.Optional(Type.Array(Type.String())),
     /** A short summary of what the operation does. */
@@ -48,19 +35,5 @@ const OperationObjectSchemaDefinition = compose(
     /** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */
     servers: Type.Optional(Type.Array(ServerObjectRef)),
     /** A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses. */
-    callbacks: Type.Optional(Type.Record(Type.String(), Type.Union([CallbackObjectRef, reference(CallbackObjectRef)])))
-  }),
-  XBadgesSchema,
-  XInternalSchema,
-  XScalarIgnoreSchema,
-  XCodeSamplesSchema,
-  XScalarStabilitySchema,
-  XScalarDisableParametersSchema,
-  XPostResponseSchema,
-  XDraftExamplesSchema,
-  XScalarSelectedServerSchema
-);
-export {
-  OperationObjectSchemaDefinition
-};
-//# sourceMappingURL=operation.js.map
+    callbacks: Type.Optional(Type.Record(Type.String(), Type.Union([CallbackObjectRef, reference(CallbackObjectRef)]))),
+}), XBadgesSchema, XInternalSchema, XScalarIgnoreSchema, XCodeSamplesSchema, XScalarStabilitySchema, XScalarDisableParametersSchema, XPostResponseSchema, XDraftExamplesSchema, XScalarSelectedServerSchema);

package/dist/schemas/v3.1/strict/parameter.d.ts

@@ -20,6 +20,8 @@ type ParameterObjectBase = {
     deprecated?: boolean;
     /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
     allowEmptyValue?: boolean;
+    /** Determines whether the parameter value SHOULD allow reserved characters without percent-encoding. This field is valid only for query parameters. Default value is false. */
+    allowReserved?: boolean;
     /**
      * OpenAPI extension used by the api-client application to determine if a parameter is considered global in scope
      * for the entire workspace. When set, this parameter will be injected into every request automatically.
@@ -64,6 +66,8 @@ export declare const ParameterObjectSchemaDefinition: import("@scalar/typebox").
     deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
     /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
     allowEmptyValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
+    /** 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). Applications are still responsible for percent-encoding reserved characters that are not allowed in the query string ([, ], #), or have a special meaning in application/x-www-form-urlencoded (-, &, +); see Appendices C and E for details. This field only applies to parameters with an in value of query. The default value is false. */
+    allowReserved: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
 }>, import("@scalar/typebox").TObject<{
     'x-global': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
 }>, import("@scalar/typebox").TObject<{
@@ -115,6 +119,8 @@ export declare const ParameterObjectSchemaDefinition: import("@scalar/typebox").
     deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
     /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
     allowEmptyValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
+    /** 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). Applications are still responsible for percent-encoding reserved characters that are not allowed in the query string ([, ], #), or have a special meaning in application/x-www-form-urlencoded (-, &, +); see Appendices C and E for details. This field only applies to parameters with an in value of query. The default value is false. */
+    allowReserved: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
 }>, import("@scalar/typebox").TObject<{
     'x-global': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
 }>, import("@scalar/typebox").TObject<{

package/dist/schemas/v3.1/strict/parameter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/parameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,0CAA0C,CAAA;AAC1F,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,+CAA+C,CAAA;AAEvG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAEvE,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,iCAAiC,CAAA;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAyBhE,KAAK,mBAAmB,GAAG;IACzB;;;oGAGgG;IAChG,IAAI,EAAE,MAAM,CAAA;IACZ,0GAA0G;IAC1G,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,4IAA4I;IAC5I,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mNAAmN;IACnN,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gHAAgH;IAChH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,4iBAA4iB;IAC5iB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,GAAG,SAAS,GACX,aAAa,CAAA;AAkBf,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAC5D,qHAAqH;IACrH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+QAA+Q;IAC/Q,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,wDAAwD;IACxD,MAAM,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;IACpC,kIAAkI;IAClI,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,mIAAmI;IACnI,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAA;CACxD,CAAA;AASD,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,GAAG;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;IA5FxC;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;;;;;;;IAmC5iB,qHAAqH;;IAErH,+QAA+Q;;IAE/Q,wDAAwD;;;;;;;;;;;IAExD,kIAAkI;;IAElI,mIAAmI;;;;;;;;;;;;IAxDnI;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;;;;;;;;MAkF9iB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,yBAAyB,GAAG,0BAA0B,CAAA"}
+{"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/parameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,0CAA0C,CAAA;AAC1F,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,+CAA+C,CAAA;AAEvG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAEvE,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,iCAAiC,CAAA;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AA2BhE,KAAK,mBAAmB,GAAG;IACzB;;;oGAGgG;IAChG,IAAI,EAAE,MAAM,CAAA;IACZ,0GAA0G;IAC1G,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,4IAA4I;IAC5I,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mNAAmN;IACnN,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gHAAgH;IAChH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,4iBAA4iB;IAC5iB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,+KAA+K;IAC/K,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,GAAG,SAAS,GACX,aAAa,CAAA;AAkBf,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAC5D,qHAAqH;IACrH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+QAA+Q;IAC/Q,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,wDAAwD;IACxD,MAAM,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;IACpC,kIAAkI;IAClI,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,mIAAmI;IACnI,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAA;CACxD,CAAA;AASD,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,GAAG;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;IAhGxC;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;IAE5iB,kpBAAkpB;;;;;;;;;IAqClpB,qHAAqH;;IAErH,+QAA+Q;;IAE/Q,wDAAwD;;;;;;;;;;;IAExD,kIAAkI;;IAElI,mIAAmI;;;;;;;;;;;;IA5DnI;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;IAE5iB,kpBAAkpB;;;;;;;;;;MAoFppB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,yBAAyB,GAAG,0BAA0B,CAAA"}

package/dist/schemas/v3.1/strict/parameter.js

@@ -1,19 +1,18 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-import { XInternalSchema } from "../../../schemas/extensions/document/x-internal.js";
-import { XScalarIgnoreSchema } from "../../../schemas/extensions/document/x-scalar-ignore.js";
-import { XGlobal } from "../../../schemas/extensions/parameter/x-global.js";
-import { ExampleObjectRef, MediaTypeObjectRef, SchemaObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
-import { reference } from "../../../schemas/v3.1/strict/reference.js";
-const ParameterObjectBaseSchema = compose(
-  Type.Object({
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+import { XInternalSchema } from '../../../schemas/extensions/document/x-internal.js';
+import { XScalarIgnoreSchema } from '../../../schemas/extensions/document/x-scalar-ignore.js';
+import { XGlobal } from '../../../schemas/extensions/parameter/x-global.js';
+import { ExampleObjectRef, MediaTypeObjectRef, SchemaObjectRef } from '../../../schemas/v3.1/strict/ref-definitions.js';
+import { reference } from '../../../schemas/v3.1/strict/reference.js';
+const ParameterObjectBaseSchema = compose(Type.Object({
     /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
      *    - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
      *    - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
      *    - For all other cases, the name corresponds to the parameter name used by the in field. */
     name: Type.String(),
     /** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie". */
-    in: Type.Union([Type.Literal("query"), Type.Literal("header"), Type.Literal("path"), Type.Literal("cookie")]),
+    in: Type.Union([Type.Literal('query'), Type.Literal('header'), Type.Literal('path'), Type.Literal('cookie')]),
     /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
     description: Type.Optional(Type.String()),
     /** Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */
@@ -21,15 +20,11 @@ const ParameterObjectBaseSchema = compose(
     /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
     deprecated: Type.Optional(Type.Boolean()),
     /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
-    allowEmptyValue: Type.Optional(Type.Boolean())
-  }),
-  XGlobal,
-  XInternalSchema,
-  XScalarIgnoreSchema
-);
-const ParameterObjectWithSchemaSchema = compose(
-  ParameterObjectBaseSchema,
-  Type.Object({
+    allowEmptyValue: Type.Optional(Type.Boolean()),
+    /** 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). Applications are still responsible for percent-encoding reserved characters that are not allowed in the query string ([, ], #), or have a special meaning in application/x-www-form-urlencoded (-, &, +); see Appendices C and E for details. This field only applies to parameters with an in value of query. The default value is false. */
+    allowReserved: Type.Optional(Type.Boolean()),
+}), XGlobal, XInternalSchema, XScalarIgnoreSchema);
+const ParameterObjectWithSchemaSchema = compose(ParameterObjectBaseSchema, Type.Object({
     /** Describes how the header value will be serialized. The default (and only legal value for headers) is "simple". */
     style: Type.Optional(Type.String()),
     /** When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples. For other data types this field has no effect. The default value is false. */
@@ -39,20 +34,19 @@ const ParameterObjectWithSchemaSchema = compose(
     /** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
     example: Type.Optional(Type.Any()),
     /** Examples of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
-    examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)])))
-  })
-);
-const ParameterObjectWithContentSchema = compose(
-  ParameterObjectBaseSchema,
-  Type.Object({
-    content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef))
-  })
-);
-const ParameterObjectSchemaDefinition = Type.Union([
-  ParameterObjectWithSchemaSchema,
-  ParameterObjectWithContentSchema
+    examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),
+}));
+const ParameterObjectWithContentSchema = compose(ParameterObjectBaseSchema, Type.Object({
+    content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),
+}));
+/**
+ * Describes a single operation parameter.
+ *
+ * A unique parameter is defined by a combination of a name and location.
+ *
+ * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.
+ */
+export const ParameterObjectSchemaDefinition = Type.Union([
+    ParameterObjectWithSchemaSchema,
+    ParameterObjectWithContentSchema,
 ]);
-export {
-  ParameterObjectSchemaDefinition
-};
-//# sourceMappingURL=parameter.js.map

package/dist/schemas/v3.1/strict/path-item.js

@@ -1,41 +1,37 @@
-import { Type } from "@scalar/typebox";
-import { OperationObjectRef, ParameterObjectRef, ServerObjectRef } from "./ref-definitions.js";
-import { reference } from "./reference.js";
-const PathItemObjectSchemaDefinition = Type.Object({
-  /**
-   * Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.
-   *
-   * Note: The behavior of $ref with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the Reference Object.
-   */
-  "$ref": Type.Optional(Type.String()),
-  /** An optional string summary, intended to apply to all operations in this path. */
-  summary: Type.Optional(Type.String()),
-  /** An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** A definition of a GET operation on this path. */
-  get: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a PUT operation on this path. */
-  put: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a POST operation on this path. */
-  post: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a DELETE operation on this path. */
-  delete: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a PATCH operation on this path. */
-  patch: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a CONNECT operation on this path. */
-  connect: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a OPTIONS operation on this path. */
-  options: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a HEAD operation on this path. */
-  head: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** A definition of a TRACE operation on this path. */
-  trace: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
-  /** An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value. */
-  servers: Type.Optional(Type.Array(ServerObjectRef)),
-  /** A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */
-  parameters: Type.Optional(Type.Array(Type.Union([ParameterObjectRef, reference(ParameterObjectRef)])))
+import { Type } from '@scalar/typebox';
+import { OperationObjectRef, ParameterObjectRef, ServerObjectRef } from './ref-definitions.js';
+import { reference } from './reference.js';
+export const PathItemObjectSchemaDefinition = Type.Object({
+    /**
+     * Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.
+     *
+     * Note: The behavior of $ref with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the Reference Object.
+     */
+    '$ref': Type.Optional(Type.String()),
+    /** An optional string summary, intended to apply to all operations in this path. */
+    summary: Type.Optional(Type.String()),
+    /** An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation. */
+    description: Type.Optional(Type.String()),
+    /** A definition of a GET operation on this path. */
+    get: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a PUT operation on this path. */
+    put: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a POST operation on this path. */
+    post: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a DELETE operation on this path. */
+    delete: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a PATCH operation on this path. */
+    patch: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a CONNECT operation on this path. */
+    connect: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a OPTIONS operation on this path. */
+    options: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a HEAD operation on this path. */
+    head: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** A definition of a TRACE operation on this path. */
+    trace: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),
+    /** An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value. */
+    servers: Type.Optional(Type.Array(ServerObjectRef)),
+    /** A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */
+    parameters: Type.Optional(Type.Array(Type.Union([ParameterObjectRef, reference(ParameterObjectRef)]))),
 });
-export {
-  PathItemObjectSchemaDefinition
-};
-//# sourceMappingURL=path-item.js.map

package/dist/schemas/v3.1/strict/paths.js

@@ -1,11 +1,8 @@
-import { Type } from "@scalar/typebox";
-import { PathItemObjectRef } from "./ref-definitions.js";
-const PathsObjectSchemaDefinition = Type.Record(
-  Type.String(),
-  /** A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. */
-  PathItemObjectRef
-);
-export {
-  PathsObjectSchemaDefinition
-};
-//# sourceMappingURL=paths.js.map
+import { Type } from '@scalar/typebox';
+import { PathItemObjectRef } from './ref-definitions.js';
+/**
+ * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.
+ */
+export const PathsObjectSchemaDefinition = Type.Record(Type.String(), 
+/** A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. */
+PathItemObjectRef);

package/dist/schemas/v3.1/strict/ref-definitions.js

@@ -1,101 +1,77 @@
-import { Type } from "@scalar/typebox";
-const REF_DEFINITIONS = {
-  ComponentsObject: "ComponentsObject",
-  SecurityRequirementObject: "SecurityRequirementObject",
-  TagObject: "TagObject",
-  CallbackObject: "CallbackObject",
-  PathsObject: "PathsObject",
-  PathItemObject: "PathItemObject",
-  OperationObject: "OperationObject",
-  SchemaObject: "SchemaObject",
-  EncodingObject: "EncodingObject",
-  HeaderObject: "HeaderObject",
-  MediaTypeObject: "MediaTypeObject",
-  ServerObject: "ServerObject",
-  ExternalDocumentationObject: "ExternalDocumentationObject",
-  InfoObject: "InfoObject",
-  ContactObject: "ContactObject",
-  LicenseObject: "LicenseObject",
-  ResponseObject: "ResponseObject",
-  ResponsesObject: "ResponsesObject",
-  ParameterObject: "ParameterObject",
-  ExampleObject: "ExampleObject",
-  RequestBodyObject: "RequestBodyObject",
-  SecuritySchemeObject: "SecuritySchemeObject",
-  SecuritySchemes: "SecuritySchemes",
-  LinkObject: "LinkObject",
-  XMLObject: "XMLObject",
-  DiscriminatorObject: "DiscriminatorObject",
-  OAuthFlowsObject: "OAuthFlowsObject",
-  ServerVariableObject: "ServerVariableObject",
-  // Navigation schemas
-  TraversedDescriptionObject: "TraversedDescriptionObject",
-  TraversedOperationObject: "TraversedOperationObject",
-  TraversedSchemaObject: "TraversedSchemaObject",
-  TraversedWebhookObject: "TraversedWebhookObject",
-  TraversedTagObject: "TraversedTagObject",
-  TraversedEntryObject: "TraversedEntryObject",
-  TraversedDocumentObject: "TraversedDocumentObject"
+import { Type } from '@scalar/typebox';
+/**
+ * Reference definitions for OpenAPI 3.1 objects.
+ * These can be used with Type.Ref to create references to these objects in other schemas.
+ *
+ * Referencing them this way helps avoid circular dependencies in TypeBox schemas while keeping the overhead performance lower.
+ */
+export const REF_DEFINITIONS = {
+    ComponentsObject: 'ComponentsObject',
+    SecurityRequirementObject: 'SecurityRequirementObject',
+    TagObject: 'TagObject',
+    CallbackObject: 'CallbackObject',
+    PathsObject: 'PathsObject',
+    PathItemObject: 'PathItemObject',
+    OperationObject: 'OperationObject',
+    SchemaObject: 'SchemaObject',
+    EncodingObject: 'EncodingObject',
+    HeaderObject: 'HeaderObject',
+    MediaTypeObject: 'MediaTypeObject',
+    ServerObject: 'ServerObject',
+    ExternalDocumentationObject: 'ExternalDocumentationObject',
+    InfoObject: 'InfoObject',
+    ContactObject: 'ContactObject',
+    LicenseObject: 'LicenseObject',
+    ResponseObject: 'ResponseObject',
+    ResponsesObject: 'ResponsesObject',
+    ParameterObject: 'ParameterObject',
+    ExampleObject: 'ExampleObject',
+    RequestBodyObject: 'RequestBodyObject',
+    SecuritySchemeObject: 'SecuritySchemeObject',
+    SecuritySchemes: 'SecuritySchemes',
+    LinkObject: 'LinkObject',
+    XMLObject: 'XMLObject',
+    DiscriminatorObject: 'DiscriminatorObject',
+    OAuthFlowsObject: 'OAuthFlowsObject',
+    ServerVariableObject: 'ServerVariableObject',
+    // Navigation schemas
+    TraversedDescriptionObject: 'TraversedDescriptionObject',
+    TraversedOperationObject: 'TraversedOperationObject',
+    TraversedSchemaObject: 'TraversedSchemaObject',
+    TraversedWebhookObject: 'TraversedWebhookObject',
+    TraversedTagObject: 'TraversedTagObject',
+    TraversedEntryObject: 'TraversedEntryObject',
+    TraversedDocumentObject: 'TraversedDocumentObject',
 };
-const ComponentsObjectRef = Type.Ref(REF_DEFINITIONS.ComponentsObject);
-const SecurityRequirementObjectRef = Type.Ref(REF_DEFINITIONS.SecurityRequirementObject);
-const TagObjectRef = Type.Ref(REF_DEFINITIONS.TagObject);
-const CallbackObjectRef = Type.Ref(REF_DEFINITIONS.CallbackObject);
-const PathItemObjectRef = Type.Ref(REF_DEFINITIONS.PathItemObject);
-const PathsObjectRef = Type.Ref(REF_DEFINITIONS.PathsObject);
-const OperationObjectRef = Type.Ref(REF_DEFINITIONS.OperationObject);
-const SchemaObjectRef = Type.Ref(REF_DEFINITIONS.SchemaObject);
-const EncodingObjectRef = Type.Ref(REF_DEFINITIONS.EncodingObject);
-const HeaderObjectRef = Type.Ref(REF_DEFINITIONS.HeaderObject);
-const MediaTypeObjectRef = Type.Ref(REF_DEFINITIONS.MediaTypeObject);
-const ServerObjectRef = Type.Ref(REF_DEFINITIONS.ServerObject);
-const ExternalDocumentationObjectRef = Type.Ref(REF_DEFINITIONS.ExternalDocumentationObject);
-const InfoObjectRef = Type.Ref(REF_DEFINITIONS.InfoObject);
-const ContactObjectRef = Type.Ref(REF_DEFINITIONS.ContactObject);
-const LicenseObjectRef = Type.Ref(REF_DEFINITIONS.LicenseObject);
-const ResponseObjectRef = Type.Ref(REF_DEFINITIONS.ResponseObject);
-const ResponsesObjectRef = Type.Ref(REF_DEFINITIONS.ResponsesObject);
-const ParameterObjectRef = Type.Ref(REF_DEFINITIONS.ParameterObject);
-const ExampleObjectRef = Type.Ref(REF_DEFINITIONS.ExampleObject);
-const RequestBodyObjectRef = Type.Ref(REF_DEFINITIONS.RequestBodyObject);
-const SecuritySchemeObjectRef = Type.Ref(REF_DEFINITIONS.SecuritySchemeObject);
-const LinkObjectRef = Type.Ref(REF_DEFINITIONS.LinkObject);
-const XMLObjectRef = Type.Ref(REF_DEFINITIONS.XMLObject);
-const DiscriminatorObjectRef = Type.Ref(REF_DEFINITIONS.DiscriminatorObject);
-const OAuthFlowsObjectRef = Type.Ref(REF_DEFINITIONS.OAuthFlowsObject);
-const ServerVariableObjectRef = Type.Ref(REF_DEFINITIONS.ServerVariableObject);
-const TraversedEntryObjectRef = Type.Ref(REF_DEFINITIONS.TraversedEntryObject);
-const TraversedDocumentObjectRef = Type.Ref(REF_DEFINITIONS.TraversedDocumentObject);
-export {
-  CallbackObjectRef,
-  ComponentsObjectRef,
-  ContactObjectRef,
-  DiscriminatorObjectRef,
-  EncodingObjectRef,
-  ExampleObjectRef,
-  ExternalDocumentationObjectRef,
-  HeaderObjectRef,
-  InfoObjectRef,
-  LicenseObjectRef,
-  LinkObjectRef,
-  MediaTypeObjectRef,
-  OAuthFlowsObjectRef,
-  OperationObjectRef,
-  ParameterObjectRef,
-  PathItemObjectRef,
-  PathsObjectRef,
-  REF_DEFINITIONS,
-  RequestBodyObjectRef,
-  ResponseObjectRef,
-  ResponsesObjectRef,
-  SchemaObjectRef,
-  SecurityRequirementObjectRef,
-  SecuritySchemeObjectRef,
-  ServerObjectRef,
-  ServerVariableObjectRef,
-  TagObjectRef,
-  TraversedDocumentObjectRef,
-  TraversedEntryObjectRef,
-  XMLObjectRef
-};
-//# sourceMappingURL=ref-definitions.js.map
+// Type alias for schema definitions
+export const ComponentsObjectRef = Type.Ref(REF_DEFINITIONS.ComponentsObject);
+export const SecurityRequirementObjectRef = Type.Ref(REF_DEFINITIONS.SecurityRequirementObject);
+export const TagObjectRef = Type.Ref(REF_DEFINITIONS.TagObject);
+export const CallbackObjectRef = Type.Ref(REF_DEFINITIONS.CallbackObject);
+export const PathItemObjectRef = Type.Ref(REF_DEFINITIONS.PathItemObject);
+export const PathsObjectRef = Type.Ref(REF_DEFINITIONS.PathsObject);
+export const OperationObjectRef = Type.Ref(REF_DEFINITIONS.OperationObject);
+export const SchemaObjectRef = Type.Ref(REF_DEFINITIONS.SchemaObject);
+export const EncodingObjectRef = Type.Ref(REF_DEFINITIONS.EncodingObject);
+export const HeaderObjectRef = Type.Ref(REF_DEFINITIONS.HeaderObject);
+export const MediaTypeObjectRef = Type.Ref(REF_DEFINITIONS.MediaTypeObject);
+export const ServerObjectRef = Type.Ref(REF_DEFINITIONS.ServerObject);
+export const ExternalDocumentationObjectRef = Type.Ref(REF_DEFINITIONS.ExternalDocumentationObject);
+export const InfoObjectRef = Type.Ref(REF_DEFINITIONS.InfoObject);
+export const ContactObjectRef = Type.Ref(REF_DEFINITIONS.ContactObject);
+export const LicenseObjectRef = Type.Ref(REF_DEFINITIONS.LicenseObject);
+export const ResponseObjectRef = Type.Ref(REF_DEFINITIONS.ResponseObject);
+export const ResponsesObjectRef = Type.Ref(REF_DEFINITIONS.ResponsesObject);
+export const ParameterObjectRef = Type.Ref(REF_DEFINITIONS.ParameterObject);
+export const ExampleObjectRef = Type.Ref(REF_DEFINITIONS.ExampleObject);
+export const RequestBodyObjectRef = Type.Ref(REF_DEFINITIONS.RequestBodyObject);
+export const SecuritySchemeObjectRef = Type.Ref(REF_DEFINITIONS.SecuritySchemeObject);
+export const LinkObjectRef = Type.Ref(REF_DEFINITIONS.LinkObject);
+export const XMLObjectRef = Type.Ref(REF_DEFINITIONS.XMLObject);
+export const DiscriminatorObjectRef = Type.Ref(REF_DEFINITIONS.DiscriminatorObject);
+export const OAuthFlowsObjectRef = Type.Ref(REF_DEFINITIONS.OAuthFlowsObject);
+export const ServerVariableObjectRef = Type.Ref(REF_DEFINITIONS.ServerVariableObject);
+// Navigation schema references
+export const TraversedEntryObjectRef = Type.Ref(REF_DEFINITIONS.TraversedEntryObject);
+// export const TraversedTagObjectRef = Type.Ref(REF_DEFINITIONS.TraversedTagObject)
+export const TraversedDocumentObjectRef = Type.Ref(REF_DEFINITIONS.TraversedDocumentObject);

package/dist/schemas/v3.1/strict/reference.js

@@ -1,26 +1,23 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-const ReferenceObjectExtensionsSchema = Type.Object({
-  /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
-  "$status": Type.Optional(Type.Union([Type.Literal("loading"), Type.Literal("error")])),
-  /** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
-  "$global": Type.Optional(Type.Boolean())
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+export const ReferenceObjectExtensionsSchema = Type.Object({
+    /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
+    '$status': Type.Optional(Type.Union([Type.Literal('loading'), Type.Literal('error')])),
+    /** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
+    '$global': Type.Optional(Type.Boolean()),
 });
-const ReferenceObjectSchema = compose(
-  Type.Object({
+/**
+ * A simple object to allow referencing other components in the OpenAPI Description, internally and externally.
+ *
+ * The $ref string value contains a URI RFC3986, which identifies the value being referenced.
+ *
+ * See the rules for resolving Relative References. */
+export const ReferenceObjectSchema = compose(Type.Object({
     /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
-    "$ref": Type.String(),
+    '$ref': Type.String(),
     /** 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. */
     summary: Type.Optional(Type.String()),
     /** 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. */
-    description: Type.Optional(Type.String())
-  }),
-  ReferenceObjectExtensionsSchema
-);
-const reference = (schema) => compose(ReferenceObjectSchema, Type.Object({ "$ref-value": schema }));
-export {
-  ReferenceObjectExtensionsSchema,
-  ReferenceObjectSchema,
-  reference
-};
-//# sourceMappingURL=reference.js.map
+    description: Type.Optional(Type.String()),
+}), ReferenceObjectExtensionsSchema);
+export const reference = (schema) => compose(ReferenceObjectSchema, Type.Object({ '$ref-value': schema }));

package/dist/schemas/v3.1/strict/request-body.js

@@ -1,21 +1,13 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../../schemas/compose.js";
-import {
-  XScalarSelectedContentTypeSchema
-} from "../../../schemas/extensions/operation/x-scalar-selected-content-type.js";
-import { MediaTypeObjectRef } from "./ref-definitions.js";
-const RequestBodyObjectSchemaDefinition = compose(
-  Type.Object({
+import { Type } from '@scalar/typebox';
+import { compose } from '../../../schemas/compose.js';
+import { XScalarSelectedContentTypeSchema, } from '../../../schemas/extensions/operation/x-scalar-selected-content-type.js';
+import { MediaTypeObjectRef } from './ref-definitions.js';
+/** Describes a single request body. */
+export const RequestBodyObjectSchemaDefinition = compose(Type.Object({
     /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
     description: Type.Optional(Type.String()),
     /** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/* */
     content: Type.Record(Type.String(), MediaTypeObjectRef),
     /** Determines if the request body is required in the request. Defaults to false. */
-    required: Type.Optional(Type.Boolean())
-  }),
-  XScalarSelectedContentTypeSchema
-);
-export {
-  RequestBodyObjectSchemaDefinition
-};
-//# sourceMappingURL=request-body.js.map
+    required: Type.Optional(Type.Boolean()),
+}), XScalarSelectedContentTypeSchema);

package/dist/schemas/v3.1/strict/response.js

@@ -1,17 +1,13 @@
-import { Type } from "@scalar/typebox";
-import { HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef } from "./ref-definitions.js";
-import { reference } from "./reference.js";
-const ResponseObjectSchemaDefinition = Type.Object({
-  /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.String(),
-  /** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
-  headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObjectRef, reference(HeaderObjectRef)]))),
-  /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*"  */
-  content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),
-  /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
-  links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObjectRef, reference(LinkObjectRef)])))
+import { Type } from '@scalar/typebox';
+import { HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef } from './ref-definitions.js';
+import { reference } from './reference.js';
+export const ResponseObjectSchemaDefinition = Type.Object({
+    /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
+    description: Type.String(),
+    /** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
+    headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObjectRef, reference(HeaderObjectRef)]))),
+    /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*"  */
+    content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),
+    /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
+    links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObjectRef, reference(LinkObjectRef)]))),
 });
-export {
-  ResponseObjectSchemaDefinition
-};
-//# sourceMappingURL=response.js.map