@scalar/oas-utils 0.2.143 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @scalar/oas-utils
 
+## 0.3.1
+
+### Patch Changes
+
+- 4440949: chore: bumping packages
+- Updated dependencies [4440949]
+  - @scalar/object-utils@1.2.1
+  - @scalar/openapi-types@0.3.1
+  - @scalar/types@0.2.1
+  - @scalar/themes@0.12.1
+
+## 0.3.0
+
+### Minor Changes
+
+- 483ca93: chore: require Node 20 (or above)
+
+### Patch Changes
+
+- 30bab1d: support unexploded serialization of array query params
+- Updated dependencies [5613e40]
+- Updated dependencies [483ca93]
+  - @scalar/themes@0.12.0
+  - @scalar/openapi-types@0.3.0
+  - @scalar/object-utils@1.2.0
+  - @scalar/types@0.2.0
+
+## 0.2.144
+
+### Patch Changes
+
+- Updated dependencies [be8a6ec]
+  - @scalar/types@0.1.16
+  - @scalar/themes@0.11.3
+
 ## 0.2.143
 
 ### Patch Changes

package/dist/entities/spec/index.d.ts

@@ -8,4 +8,5 @@ export { type Operation, type OperationPayload, operationSchema, } from './opera
 export { xScalarEnvironmentsSchema, type XScalarEnvironment, type XScalarEnvironments, } from './x-scalar-environments.js';
 /** Re-exported here for ease of use but we should use the other ones directly */
 export { type Oauth2Flow, type Oauth2FlowPayload, type SecuritySchemaHttp, type SecuritySchemaOpenId, type SecurityScheme, type SecuritySchemeApiKey, type SecuritySchemeOauth2, type SecuritySchemeOauth2Payload, type SecuritySchemePayload, oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeSchema, } from '@scalar/types/entities';
+export type { PostResponseScript, PostResponseScripts, } from './requests.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/entities/spec/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACxF,OAAO,EAAE,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,cAAc,CAAA;AACtG,OAAO,EAAE,YAAY,EAAE,KAAK,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAA;AACxE,OAAO,EACL,aAAa,EACb,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,YAAY,GAClB,MAAM,YAAY,CAAA;AAEnB,OAAO,EACL,oBAAoB,EACpB,wBAAwB,EACxB,8BAA8B,EAC9B,KAAK,cAAc,EACnB,KAAK,uBAAuB,GAC7B,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EACL,SAAS,EACT,8BAA8B,EAC9B,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,GAAG,EACR,KAAK,UAAU,GAChB,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EACL,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,eAAe,GAChB,MAAM,aAAa,CAAA;AAEpB,OAAO,EACL,yBAAyB,EACzB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,yBAAyB,CAAA;AAEhC,iFAAiF;AACjF,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,wBAAwB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACxF,OAAO,EAAE,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,cAAc,CAAA;AACtG,OAAO,EAAE,YAAY,EAAE,KAAK,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAA;AACxE,OAAO,EACL,aAAa,EACb,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,YAAY,GAClB,MAAM,YAAY,CAAA;AAEnB,OAAO,EACL,oBAAoB,EACpB,wBAAwB,EACxB,8BAA8B,EAC9B,KAAK,cAAc,EACnB,KAAK,uBAAuB,GAC7B,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EACL,SAAS,EACT,8BAA8B,EAC9B,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,KAAK,GAAG,EACR,KAAK,UAAU,GAChB,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EACL,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,eAAe,GAChB,MAAM,aAAa,CAAA;AAEpB,OAAO,EACL,yBAAyB,EACzB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,yBAAyB,CAAA;AAEhC,iFAAiF;AACjF,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EACV,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,eAAe,CAAA"}

package/dist/entities/spec/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/entities/spec/index.ts"],
-  "sourcesContent": ["export { collectionSchema, type Collection, type CollectionPayload } from './collection'\nexport { oasParameterSchema, type RequestParameter, type RequestParameterPayload } from './parameters'\nexport { serverSchema, type Server, type ServerPayload } from './server'\nexport {\n  requestSchema,\n  type Request,\n  type RequestPayload,\n  type RequestMethod,\n  type ResponseInstance,\n  type RequestEvent,\n} from './requests'\n\nexport {\n  requestExampleSchema,\n  createExampleFromRequest,\n  requestExampleParametersSchema,\n  type RequestExample,\n  type RequestExampleParameter,\n} from './request-examples'\n\nexport {\n  tagSchema,\n  oasExternalDocumentationSchema,\n  oasInfoSchema,\n  oasContactSchema,\n  oasLicenseSchema,\n  type Tag,\n  type TagPayload,\n} from './spec-objects'\n\nexport {\n  type Operation,\n  type OperationPayload,\n  operationSchema,\n} from './operation'\n\nexport {\n  xScalarEnvironmentsSchema,\n  type XScalarEnvironment,\n  type XScalarEnvironments,\n} from './x-scalar-environments'\n\n/** Re-exported here for ease of use but we should use the other ones directly */\nexport {\n  type Oauth2Flow,\n  type Oauth2FlowPayload,\n  type SecuritySchemaHttp,\n  type SecuritySchemaOpenId,\n  type SecurityScheme,\n  type SecuritySchemeApiKey,\n  type SecuritySchemeOauth2,\n  type SecuritySchemeOauth2Payload,\n  type SecuritySchemePayload,\n  oasSecurityRequirementSchema,\n  oasSecuritySchemeSchema,\n  pkceOptions,\n  securityApiKeySchema,\n  securityHttpSchema,\n  securityOauthSchema,\n  securityOpenIdSchema,\n  securitySchemeSchema,\n} from '@scalar/types/entities'\n"],
+  "sourcesContent": ["export { collectionSchema, type Collection, type CollectionPayload } from './collection'\nexport { oasParameterSchema, type RequestParameter, type RequestParameterPayload } from './parameters'\nexport { serverSchema, type Server, type ServerPayload } from './server'\nexport {\n  requestSchema,\n  type Request,\n  type RequestPayload,\n  type RequestMethod,\n  type ResponseInstance,\n  type RequestEvent,\n} from './requests'\n\nexport {\n  requestExampleSchema,\n  createExampleFromRequest,\n  requestExampleParametersSchema,\n  type RequestExample,\n  type RequestExampleParameter,\n} from './request-examples'\n\nexport {\n  tagSchema,\n  oasExternalDocumentationSchema,\n  oasInfoSchema,\n  oasContactSchema,\n  oasLicenseSchema,\n  type Tag,\n  type TagPayload,\n} from './spec-objects'\n\nexport {\n  type Operation,\n  type OperationPayload,\n  operationSchema,\n} from './operation'\n\nexport {\n  xScalarEnvironmentsSchema,\n  type XScalarEnvironment,\n  type XScalarEnvironments,\n} from './x-scalar-environments'\n\n/** Re-exported here for ease of use but we should use the other ones directly */\nexport {\n  type Oauth2Flow,\n  type Oauth2FlowPayload,\n  type SecuritySchemaHttp,\n  type SecuritySchemaOpenId,\n  type SecurityScheme,\n  type SecuritySchemeApiKey,\n  type SecuritySchemeOauth2,\n  type SecuritySchemeOauth2Payload,\n  type SecuritySchemePayload,\n  oasSecurityRequirementSchema,\n  oasSecuritySchemeSchema,\n  pkceOptions,\n  securityApiKeySchema,\n  securityHttpSchema,\n  securityOauthSchema,\n  securityOpenIdSchema,\n  securitySchemeSchema,\n} from '@scalar/types/entities'\n\nexport type {\n  PostResponseScript,\n  PostResponseScripts,\n} from './requests.ts'\n"],
   "mappings": "AAAA,SAAS,wBAAiE;AAC1E,SAAS,0BAA+E;AACxF,SAAS,oBAAqD;AAC9D;AAAA,EACE;AAAA,OAMK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAEP;AAAA,EAGE;AAAA,OACK;AAEP;AAAA,EACE;AAAA,OAGK;AAGP;AAAA,EAUE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;",
   "names": []
 }

package/dist/entities/spec/operation.d.ts

@@ -5,7 +5,7 @@
 import { type RequestPayload, type Request as RequestType } from './requests.js';
 export type Operation = RequestType;
 export type OperationPayload = RequestPayload;
-export declare const operationSchema: import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<Omit<{
+export declare const operationSchema: import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<Omit<{
     tags: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
     summary: import("zod").ZodOptional<import("zod").ZodString>;
     description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -21,6 +21,7 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
         schema: import("zod").ZodOptional<import("zod").ZodUnknown>;
         content: import("zod").ZodOptional<import("zod").ZodUnknown>;
         style: import("zod").ZodOptional<import("zod").ZodEnum<["matrix", "simple", "form", "label", "spaceDelimited", "pipeDelimited", "deepObject"]>>;
+        explode: import("zod").ZodOptional<import("zod").ZodBoolean>;
         example: import("zod").ZodOptional<import("zod").ZodUnknown>;
         examples: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodObject<{
             value: import("zod").ZodOptional<import("zod").ZodUnknown>;
@@ -50,6 +51,7 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }, {
         name: string;
         in: "cookie" | "path" | "query" | "header";
@@ -65,6 +67,7 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }>, "many">>;
     externalDocs: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodObject<{
         description: import("zod").ZodCatch<import("zod").ZodOptional<import("zod").ZodString>>;
@@ -216,6 +219,8 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
     selectedServerUid: import("zod").ZodDefault<import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodBranded<import("zod").ZodString, "server">>>>;
     examples: import("zod").ZodDefault<import("zod").ZodArray<import("zod").ZodBranded<import("zod").ZodString, "example">, "many">>;
     selectedSecuritySchemeUids: import("zod").ZodDefault<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodBranded<import("zod").ZodString, "securityScheme">, import("zod").ZodArray<import("zod").ZodBranded<import("zod").ZodString, "securityScheme">, "many">]>, "many">>;
+}>, {
+    'x-post-response': import("zod").ZodOptional<import("zod").ZodString>;
 }>, "strip", import("zod").ZodTypeAny, {
     uid: string & import("zod").BRAND<"operation">;
     path: string;
@@ -252,10 +257,12 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
     'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
+    'x-post-response'?: string | undefined;
     'x-codeSamples'?: {
         source: string;
         label?: string | undefined;
@@ -306,11 +313,13 @@ export declare const operationSchema: import("zod").ZodObject<import("zod").obje
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
     'x-scalar-stability'?: unknown;
     method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
+    'x-post-response'?: string | undefined;
     'x-codeSamples'?: unknown;
     'x-code-samples'?: unknown;
     'x-custom-examples'?: unknown;

package/dist/entities/spec/operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/operation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,IAAI,WAAW,EAAiB,MAAM,YAAY,CAAA;AAE5F,MAAM,MAAM,SAAS,GAAG,WAAW,CAAA;AACnC,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAA;AAC7C,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aACwV,CAAC;YAAkC,CAAC;;;aAAoE,CAAC;YAAuB,CAAC;;;;;;;;aAAqT,CAAC;YAAkC,CAAC;;;aAAoE,CAAC;YAAuB,CAAC;;;;;;;;aAAwT,CAAC;YAAkC,CAAC;;;aAAoE,CAAC;YAAuB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EADxzC,CAAA"}
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/operation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,IAAI,WAAW,EAAiB,MAAM,YAAY,CAAA;AAE5F,MAAM,MAAM,SAAS,GAAG,WAAW,CAAA;AACnC,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAA;AAC7C,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aACwV,CAAC;YAAkC,CAAC;;;aAAoE,CAAC;YAAuB,CAAC;;;;;;;;aAAqT,CAAC;YAAkC,CAAC;;;aAAoE,CAAC;YAAuB,CAAC;;;;;;;;aAAwT,CAAC;YAAkC,CAAC;;;aAAoE,CAAC;YAAuB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EADxzC,CAAA"}

package/dist/entities/spec/parameters.d.ts

@@ -26,6 +26,7 @@ export declare const oasParameterSchema: z.ZodObject<{
     content: z.ZodOptional<z.ZodUnknown>;
     /** Defaulted according to @url https://spec.openapis.org/oas/v3.1.0#parameter-object */
     style: z.ZodOptional<z.ZodEnum<["matrix", "simple", "form", "label", "spaceDelimited", "pipeDelimited", "deepObject"]>>;
+    explode: z.ZodOptional<z.ZodBoolean>;
     example: z.ZodOptional<z.ZodUnknown>;
     examples: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
         value: z.ZodOptional<z.ZodUnknown>;
@@ -55,6 +56,7 @@ export declare const oasParameterSchema: z.ZodObject<{
     schema?: unknown;
     content?: unknown;
     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+    explode?: boolean | undefined;
 }, {
     name: string;
     in: "cookie" | "path" | "query" | "header";
@@ -70,6 +72,7 @@ export declare const oasParameterSchema: z.ZodObject<{
     schema?: unknown;
     content?: unknown;
     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+    explode?: boolean | undefined;
 }>;
 export type RequestParameter = z.infer<typeof oasParameterSchema>;
 export type RequestParameterPayload = z.input<typeof oasParameterSchema>;

package/dist/entities/spec/parameters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/parameters.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAA;AAEjE,eAAO,MAAM,mBAAmB,kDAAgD,CAAA;AAChF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE3D,eAAO,MAAM,oBAAoB,mGAQ/B,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CACnC,MAAM,EACN;IACE,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;IAClD,OAAO,CAAC,EAAE,uBAAuB,CAAA;CAClC,CACF,CAAA;AACD,eAAO,MAAM,sBAAsB,cAAc,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;IAI7B,yBAAyB;;IAEzB,yBAAyB;;;;IAIzB,wFAAwF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBjD,CAAA;AAEzC,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACjE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA"}
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/parameters.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAA;AAEjE,eAAO,MAAM,mBAAmB,kDAAgD,CAAA;AAChF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE3D,eAAO,MAAM,oBAAoB,mGAQ/B,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CACnC,MAAM,EACN;IACE,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;IAClD,OAAO,CAAC,EAAE,uBAAuB,CAAA;CAClC,CACF,CAAA;AACD,eAAO,MAAM,sBAAsB,cAAc,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;IAI7B,yBAAyB;;IAEzB,yBAAyB;;;;IAIzB,wFAAwF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBjD,CAAA;AAEzC,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACjE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA"}

package/dist/entities/spec/parameters.js

@@ -22,6 +22,7 @@ const oasParameterSchema = z.object({
   content: z.unknown().optional(),
   /** Defaulted according to @url https://spec.openapis.org/oas/v3.1.0#parameter-object */
   style: parameterStyleSchema.optional(),
+  explode: z.boolean().optional(),
   example: z.unknown().optional(),
   examples: z.union([
     z.record(

package/dist/entities/spec/parameters.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/entities/spec/parameters.ts"],
-  "sourcesContent": ["import type { OpenAPI } from '@scalar/openapi-types'\nimport { type ZodSchema, z } from 'zod'\nimport type { OpenAPIV3_1 } from '@scalar/openapi-types'\nimport type { RequestExampleParameter } from './request-examples'\n\nexport const parameterTypeSchema = z.enum(['path', 'query', 'header', 'cookie'])\nexport type ParamType = z.infer<typeof parameterTypeSchema>\n\nexport const parameterStyleSchema = z.enum([\n  'matrix',\n  'simple',\n  'form',\n  'label',\n  'spaceDelimited',\n  'pipeDelimited',\n  'deepObject',\n])\nexport type ParameterStyle = z.infer<typeof parameterStyleSchema>\nexport type ParameterContent = Record<\n  string,\n  {\n    schema?: OpenAPIV3_1.Document\n    examples?: Record<string, RequestExampleParameter>\n    example?: RequestExampleParameter\n  }\n>\nexport const parameterExampleSchema = z.unknown()\n\n/**\n * OpenAPI compliant parameters object\n */\nexport const oasParameterSchema = z.object({\n  in: parameterTypeSchema,\n  name: z.string(),\n  description: z.string().optional(),\n  /** Defaulted to false */\n  required: z.boolean().optional().default(false),\n  /** Defaulted to false */\n  deprecated: z.boolean().optional().default(false),\n  schema: z.unknown().optional(),\n  content: z.unknown().optional(),\n  /** Defaulted according to @url https://spec.openapis.org/oas/v3.1.0#parameter-object */\n  style: parameterStyleSchema.optional(),\n  example: z.unknown().optional(),\n  examples: z\n    .union([\n      z.record(\n        z.string(),\n        z.object({\n          value: z.unknown().optional(),\n          summary: z.string().optional(),\n          externalValue: z.string().optional(),\n        }),\n      ),\n      z.array(z.unknown()),\n    ])\n    .optional(),\n}) satisfies ZodSchema<OpenAPI.Parameter>\n\nexport type RequestParameter = z.infer<typeof oasParameterSchema>\nexport type RequestParameterPayload = z.input<typeof oasParameterSchema>\n"],
-  "mappings": "AACA,SAAyB,SAAS;AAI3B,MAAM,sBAAsB,EAAE,KAAK,CAAC,QAAQ,SAAS,UAAU,QAAQ,CAAC;AAGxE,MAAM,uBAAuB,EAAE,KAAK;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAUM,MAAM,yBAAyB,EAAE,QAAQ;AAKzC,MAAM,qBAAqB,EAAE,OAAO;AAAA,EACzC,IAAI;AAAA,EACJ,MAAM,EAAE,OAAO;AAAA,EACf,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAEjC,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK;AAAA;AAAA,EAE9C,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK;AAAA,EAChD,QAAQ,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7B,SAAS,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,EAE9B,OAAO,qBAAqB,SAAS;AAAA,EACrC,SAAS,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC9B,UAAU,EACP,MAAM;AAAA,IACL,EAAE;AAAA,MACA,EAAE,OAAO;AAAA,MACT,EAAE,OAAO;AAAA,QACP,OAAO,EAAE,QAAQ,EAAE,SAAS;AAAA,QAC5B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,QAC7B,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA,MACrC,CAAC;AAAA,IACH;AAAA,IACA,EAAE,MAAM,EAAE,QAAQ,CAAC;AAAA,EACrB,CAAC,EACA,SAAS;AACd,CAAC;",
+  "sourcesContent": ["import type { OpenAPI } from '@scalar/openapi-types'\nimport { type ZodSchema, z } from 'zod'\nimport type { OpenAPIV3_1 } from '@scalar/openapi-types'\nimport type { RequestExampleParameter } from './request-examples'\n\nexport const parameterTypeSchema = z.enum(['path', 'query', 'header', 'cookie'])\nexport type ParamType = z.infer<typeof parameterTypeSchema>\n\nexport const parameterStyleSchema = z.enum([\n  'matrix',\n  'simple',\n  'form',\n  'label',\n  'spaceDelimited',\n  'pipeDelimited',\n  'deepObject',\n])\nexport type ParameterStyle = z.infer<typeof parameterStyleSchema>\nexport type ParameterContent = Record<\n  string,\n  {\n    schema?: OpenAPIV3_1.Document\n    examples?: Record<string, RequestExampleParameter>\n    example?: RequestExampleParameter\n  }\n>\nexport const parameterExampleSchema = z.unknown()\n\n/**\n * OpenAPI compliant parameters object\n */\nexport const oasParameterSchema = z.object({\n  in: parameterTypeSchema,\n  name: z.string(),\n  description: z.string().optional(),\n  /** Defaulted to false */\n  required: z.boolean().optional().default(false),\n  /** Defaulted to false */\n  deprecated: z.boolean().optional().default(false),\n  schema: z.unknown().optional(),\n  content: z.unknown().optional(),\n  /** Defaulted according to @url https://spec.openapis.org/oas/v3.1.0#parameter-object */\n  style: parameterStyleSchema.optional(),\n  explode: z.boolean().optional(),\n  example: z.unknown().optional(),\n  examples: z\n    .union([\n      z.record(\n        z.string(),\n        z.object({\n          value: z.unknown().optional(),\n          summary: z.string().optional(),\n          externalValue: z.string().optional(),\n        }),\n      ),\n      z.array(z.unknown()),\n    ])\n    .optional(),\n}) satisfies ZodSchema<OpenAPI.Parameter>\n\nexport type RequestParameter = z.infer<typeof oasParameterSchema>\nexport type RequestParameterPayload = z.input<typeof oasParameterSchema>\n"],
+  "mappings": "AACA,SAAyB,SAAS;AAI3B,MAAM,sBAAsB,EAAE,KAAK,CAAC,QAAQ,SAAS,UAAU,QAAQ,CAAC;AAGxE,MAAM,uBAAuB,EAAE,KAAK;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAUM,MAAM,yBAAyB,EAAE,QAAQ;AAKzC,MAAM,qBAAqB,EAAE,OAAO;AAAA,EACzC,IAAI;AAAA,EACJ,MAAM,EAAE,OAAO;AAAA,EACf,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAEjC,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK;AAAA;AAAA,EAE9C,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK;AAAA,EAChD,QAAQ,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7B,SAAS,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,EAE9B,OAAO,qBAAqB,SAAS;AAAA,EACrC,SAAS,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC9B,SAAS,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC9B,UAAU,EACP,MAAM;AAAA,IACL,EAAE;AAAA,MACA,EAAE,OAAO;AAAA,MACT,EAAE,OAAO;AAAA,QACP,OAAO,EAAE,QAAQ,EAAE,SAAS;AAAA,QAC5B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,QAC7B,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA,MACrC,CAAC;AAAA,IACH;AAAA,IACA,EAAE,MAAM,EAAE,QAAQ,CAAC;AAAA,EACrB,CAAC,EACA,SAAS;AACd,CAAC;",
   "names": []
 }

package/dist/entities/spec/parameters.test.js

@@ -67,5 +67,14 @@ describe("oasParameterSchema", () => {
     };
     expect(() => oasParameterSchema.parse(validParameter)).not.toThrow();
   });
+  it("should validate examples with the explode property", () => {
+    const validParameter = {
+      in: "query",
+      name: "galaxy",
+      examples: ["Milky Way", "Andromeda"],
+      explode: true
+    };
+    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow();
+  });
 });
 //# sourceMappingURL=parameters.test.js.map

package/dist/entities/spec/parameters.test.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/entities/spec/parameters.test.ts"],
-  "sourcesContent": ["import { oasParameterSchema } from '@/entities/spec/parameters'\nimport { describe, expect, it } from 'vitest'\nimport { z } from 'zod'\n\ndescribe('oasParameterSchema', () => {\n  it('should validate a parameter with a correct example', () => {\n    const validParameterWithExample = {\n      in: 'query',\n      name: 'limit',\n      example: 10,\n    }\n\n    expect(() => oasParameterSchema.parse(validParameterWithExample)).not.toThrow()\n  })\n\n  it('should validate examples as a record with correct structure', () => {\n    const validExamples = {\n      milkyWay: {\n        value: 'Milky Way',\n        summary: 'Our galaxy',\n      },\n      andromeda: {\n        value: 'Andromeda',\n        summary: 'Nearest major galaxy',\n      },\n    }\n\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: validExamples,\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n\n  it('should fail validation if examples have incorrect structure', () => {\n    const invalidExamples = {\n      milkyWay: {\n        value: 'Milky Way',\n        // Summary is optional, so this should not cause a failure\n      },\n      andromeda: 'This should be an object, not a string',\n    }\n\n    const invalidParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: invalidExamples,\n    }\n\n    expect(() => oasParameterSchema.parse(invalidParameter)).toThrow(z.ZodError)\n  })\n\n  it('should validate examples as an array', () => {\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: ['Milky Way', 'Andromeda'],\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n\n  it('should validate examples with a single array item', () => {\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: ['Milky Way'],\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n\n  it('should validate with an empty array of examples', () => {\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: [],\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n})\n"],
-  "mappings": "AAAA,SAAS,0BAA0B;AACnC,SAAS,UAAU,QAAQ,UAAU;AACrC,SAAS,SAAS;AAElB,SAAS,sBAAsB,MAAM;AACnC,KAAG,sDAAsD,MAAM;AAC7D,UAAM,4BAA4B;AAAA,MAChC,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,SAAS;AAAA,IACX;AAEA,WAAO,MAAM,mBAAmB,MAAM,yBAAyB,CAAC,EAAE,IAAI,QAAQ;AAAA,EAChF,CAAC;AAED,KAAG,+DAA+D,MAAM;AACtE,UAAM,gBAAgB;AAAA,MACpB,UAAU;AAAA,QACR,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,MACA,WAAW;AAAA,QACT,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,IACF;AAEA,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,+DAA+D,MAAM;AACtE,UAAM,kBAAkB;AAAA,MACtB,UAAU;AAAA,QACR,OAAO;AAAA;AAAA,MAET;AAAA,MACA,WAAW;AAAA,IACb;AAEA,UAAM,mBAAmB;AAAA,MACvB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAEA,WAAO,MAAM,mBAAmB,MAAM,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ;AAAA,EAC7E,CAAC;AAED,KAAG,wCAAwC,MAAM;AAC/C,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,aAAa,WAAW;AAAA,IACrC;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,qDAAqD,MAAM;AAC5D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,WAAW;AAAA,IACxB;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,mDAAmD,MAAM;AAC1D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC;AAAA,IACb;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AACH,CAAC;",
+  "sourcesContent": ["import { oasParameterSchema } from '@/entities/spec/parameters'\nimport { describe, expect, it } from 'vitest'\nimport { z } from 'zod'\n\ndescribe('oasParameterSchema', () => {\n  it('should validate a parameter with a correct example', () => {\n    const validParameterWithExample = {\n      in: 'query',\n      name: 'limit',\n      example: 10,\n    }\n\n    expect(() => oasParameterSchema.parse(validParameterWithExample)).not.toThrow()\n  })\n\n  it('should validate examples as a record with correct structure', () => {\n    const validExamples = {\n      milkyWay: {\n        value: 'Milky Way',\n        summary: 'Our galaxy',\n      },\n      andromeda: {\n        value: 'Andromeda',\n        summary: 'Nearest major galaxy',\n      },\n    }\n\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: validExamples,\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n\n  it('should fail validation if examples have incorrect structure', () => {\n    const invalidExamples = {\n      milkyWay: {\n        value: 'Milky Way',\n        // Summary is optional, so this should not cause a failure\n      },\n      andromeda: 'This should be an object, not a string',\n    }\n\n    const invalidParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: invalidExamples,\n    }\n\n    expect(() => oasParameterSchema.parse(invalidParameter)).toThrow(z.ZodError)\n  })\n\n  it('should validate examples as an array', () => {\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: ['Milky Way', 'Andromeda'],\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n\n  it('should validate examples with a single array item', () => {\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: ['Milky Way'],\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n\n  it('should validate with an empty array of examples', () => {\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: [],\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n\n  it('should validate examples with the explode property', () => {\n    const validParameter = {\n      in: 'query',\n      name: 'galaxy',\n      examples: ['Milky Way', 'Andromeda'],\n      explode: true,\n    }\n\n    expect(() => oasParameterSchema.parse(validParameter)).not.toThrow()\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,0BAA0B;AACnC,SAAS,UAAU,QAAQ,UAAU;AACrC,SAAS,SAAS;AAElB,SAAS,sBAAsB,MAAM;AACnC,KAAG,sDAAsD,MAAM;AAC7D,UAAM,4BAA4B;AAAA,MAChC,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,SAAS;AAAA,IACX;AAEA,WAAO,MAAM,mBAAmB,MAAM,yBAAyB,CAAC,EAAE,IAAI,QAAQ;AAAA,EAChF,CAAC;AAED,KAAG,+DAA+D,MAAM;AACtE,UAAM,gBAAgB;AAAA,MACpB,UAAU;AAAA,QACR,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,MACA,WAAW;AAAA,QACT,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,IACF;AAEA,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,+DAA+D,MAAM;AACtE,UAAM,kBAAkB;AAAA,MACtB,UAAU;AAAA,QACR,OAAO;AAAA;AAAA,MAET;AAAA,MACA,WAAW;AAAA,IACb;AAEA,UAAM,mBAAmB;AAAA,MACvB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAEA,WAAO,MAAM,mBAAmB,MAAM,gBAAgB,CAAC,EAAE,QAAQ,EAAE,QAAQ;AAAA,EAC7E,CAAC;AAED,KAAG,wCAAwC,MAAM;AAC/C,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,aAAa,WAAW;AAAA,IACrC;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,qDAAqD,MAAM;AAC5D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,WAAW;AAAA,IACxB;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,mDAAmD,MAAM;AAC1D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC;AAAA,IACb;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AAED,KAAG,sDAAsD,MAAM;AAC7D,UAAM,iBAAiB;AAAA,MACrB,IAAI;AAAA,MACJ,MAAM;AAAA,MACN,UAAU,CAAC,aAAa,WAAW;AAAA,MACnC,SAAS;AAAA,IACX;AAEA,WAAO,MAAM,mBAAmB,MAAM,cAAc,CAAC,EAAE,IAAI,QAAQ;AAAA,EACrE,CAAC;AACH,CAAC;",
   "names": []
 }

package/dist/entities/spec/requests.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { type PostResponseSchema, XPostResponseSchema } from '@scalar/openapi-types/schemas/extensions';
 import { XScalarStability } from '@scalar/types';
 import { type RequestExample } from './request-examples.js';
 export declare const requestMethods: readonly ["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"];
@@ -13,6 +14,8 @@ export type ResponseInstance = Omit<Response, 'headers'> & {
     duration: number;
     /** The response status */
     status: number;
+    /** The response status text */
+    statusText: string;
     /** The response method */
     method: RequestMethod;
     /** The request path */
@@ -78,6 +81,7 @@ export declare const oasRequestSchema: z.ZodObject<{
         schema: z.ZodOptional<z.ZodUnknown>;
         content: z.ZodOptional<z.ZodUnknown>;
         style: z.ZodOptional<z.ZodEnum<["matrix", "simple", "form", "label", "spaceDelimited", "pipeDelimited", "deepObject"]>>;
+        explode: z.ZodOptional<z.ZodBoolean>;
         example: z.ZodOptional<z.ZodUnknown>;
         examples: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
             value: z.ZodOptional<z.ZodUnknown>;
@@ -107,6 +111,7 @@ export declare const oasRequestSchema: z.ZodObject<{
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }, {
         name: string;
         in: "cookie" | "path" | "query" | "header";
@@ -122,6 +127,7 @@ export declare const oasRequestSchema: z.ZodObject<{
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }>, "many">>;
     /**
      * External documentation object
@@ -227,6 +233,7 @@ export declare const oasRequestSchema: z.ZodObject<{
     }>>>;
     /** Hide operations */
     'x-internal': z.ZodOptional<z.ZodBoolean>;
+    /** Ignore operations */
     'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     description?: string | undefined;
@@ -256,6 +263,7 @@ export declare const oasRequestSchema: z.ZodObject<{
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
@@ -304,6 +312,7 @@ export declare const oasRequestSchema: z.ZodObject<{
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
@@ -325,8 +334,10 @@ export declare const oasRequestSchema: z.ZodObject<{
         } | undefined;
     }> | undefined;
 }>;
+export type PostResponseScript = z.infer<typeof PostResponseSchema>;
+export type PostResponseScripts = z.infer<typeof XPostResponseSchema>['x-post-response'];
 /** Unified request schema for client usage */
-export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<Omit<{
+export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<Omit<{
     /**
      * A list of tags for API documentation control. Tags can be used for logical
      * grouping of operations by resources or any other qualifier.
@@ -371,6 +382,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         schema: z.ZodOptional<z.ZodUnknown>;
         content: z.ZodOptional<z.ZodUnknown>;
         style: z.ZodOptional<z.ZodEnum<["matrix", "simple", "form", "label", "spaceDelimited", "pipeDelimited", "deepObject"]>>;
+        explode: z.ZodOptional<z.ZodBoolean>;
         example: z.ZodOptional<z.ZodUnknown>;
         examples: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
             value: z.ZodOptional<z.ZodUnknown>;
@@ -400,6 +412,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }, {
         name: string;
         in: "cookie" | "path" | "query" | "header";
@@ -415,6 +428,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }>, "many">>;
     /**
      * External documentation object
@@ -520,6 +534,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     }>>>;
     /** Hide operations */
     'x-internal': z.ZodOptional<z.ZodBoolean>;
+    /** Ignore operations */
     'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
 }, "x-scalar-examples">, {
     'x-codeSamples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -535,23 +550,21 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         label?: unknown;
         lang?: unknown;
     }>, "many">>>;
-    'x-code-samples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
+    'x-code-samples': z.ZodCatch<z.ZodOptional<z.ZodArray /** Store headers as an object to match what we had with axios */<z.ZodObject<{
         lang: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        label: z.ZodCatch<z.ZodOptional<z.ZodString /** Time in ms the request took */>>;
+        label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
         source: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         source: string;
-        label? /** The response method */: string | undefined;
+        label?: string | undefined;
         lang?: string | undefined;
     }, {
         source: string;
         label?: unknown;
         lang?: unknown;
     }>, "many">>>;
-    'x-custom-examples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
-        lang: 
-        /** A stream reader for a streamable response body */
-        z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    'x-custom-examples': z.ZodCatch<z.ZodOptional<z.ZodArray /** The response data */<z.ZodObject<{
+        lang: z.ZodCatch<z.ZodOptional<z.ZodString /** The response size in bytes */>>;
         label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
         source: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -580,6 +593,8 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     examples: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "example">, "many">>;
     /** List of security scheme UIDs associated with the request */
     selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodBranded<z.ZodString, "securityScheme">, z.ZodArray<z.ZodBranded<z.ZodString, "securityScheme">, "many">]>, "many">>;
+}>, {
+    'x-post-response': z.ZodOptional<z.ZodString>;
 }>, "strip", z.ZodTypeAny, {
     uid: string & z.BRAND<"operation">;
     path: string;
@@ -616,10 +631,12 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
     'x-scalar-stability'?: XScalarStability | undefined;
+    'x-post-response'?: string | undefined;
     'x-codeSamples'?: {
         source: string;
         label?: string | undefined;
@@ -670,11 +687,13 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+        explode?: boolean | undefined;
     }[] | undefined;
     requestBody?: any;
     responses?: Record<string, any> | undefined;
     'x-scalar-stability'?: unknown;
     method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
+    'x-post-response'?: string | undefined;
     'x-codeSamples'?: unknown;
     'x-code-samples'?: unknown;
     'x-custom-examples'?: unknown;

package/dist/entities/spec/requests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAGhD,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAG9E,eAAO,MAAM,cAAc,2FAA4F,CAAA;AAEvH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,CACE;IACE,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,qDAAqD;IACrD,MAAM,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAA;CAChD,CACJ,CAAA;AAEH,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;IAC3B;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGtB,CAAA;AAyCF,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IA1FxB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;qBA5FE,EAAI,QAAO,CAAC,EAAE,WAAW,CAAE,EAAC,QAAQ,CAAC,EAAE,SAAS;cAC/D,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAG,SAAQ;eAE/C,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAE,EAAE,SAAQ;gBAAmB,EAAG,SAAS;gBAAkB,EAAE,UAAU;;aAEhF,CAAC;YAAkC,CAAC;;;aAGpD,CAAC;YAAuB,CAAC;;sBACV,EAAG,QAAQ,CAAC,EAAG,WAAU,CAAC,EAAG,QAAO,CAAC,EAAE,SAAS;cACpD,EAAG,QAAQ,CAAC,EAAE,WACvB,CAAC,EAAE,SAAS;eAAkB,EAAG,QACnC,CAAC,EAAE,WAAW,CAAC,EAAE,SACpB,CAAE,kCAAkC;gBAAjB,EAAG,SAAS;gBACnB,EAAE,UACT;;aAGH,CADD,CAAC,0BAA0B;YACtB,CAAC;;;aAIH,CAAC;YACe,CAAC;;yBAEP,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAChC,QAAA,CAAC,EAAE,SAAS;;QAGZ,qDAAqD;QACrD,EAAA,QADE,CAAE,EAAE,WAAU,CAAC,EAAG,SAAQ;eAAkB,EAAG,QACtD,CAAK,EAAA,WAAS,CAAC,EAAE,SAAS;gBAAmB,EAAG,SAC/C;gBAGI,EAAG,UAAU;;aAA0C,CAAA;YAE7D,CAAC;;;aAEa,CAAC;YAGA,CAAC;;;;;;;IAiFhB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASlC,CAAA;AAE/B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvC,OAAO,EACL,KAAK,kBAAkB,EAEvB,mBAAmB,EACpB,MAAM,0CAA0C,CAAA;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAGhD,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAG9E,eAAO,MAAM,cAAc,2FAA4F,CAAA;AAEvH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,CACE;IACE,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,qDAAqD;IACrD,MAAM,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAA;CAChD,CACJ,CAAA;AAEH,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;IAC3B;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;IAEtB,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAExB,CAAA;AAyCF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACnE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AAExF,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IA9FxB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;IAEtB,wBAAwB;;;qBAjGH,EAAG,QAAQ,CAAC,EAAE,WAAW,CAChD,EAAC,QAAQ,CAAC,EAAE,SAAS;cAAgB,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAE,SAAS;eAC7D,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAE,EAAE,SAAQ;gBAE9C,EAAG,SAAS;gBAAiB,EAAG,UAAU;;aAAyC,CAAC;YAEvF,CAAC;;;aAEO,CAAC;YAAuB,CAAC;;sBACR,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAE,QACrD,CAAC,iEAAiE,CACjE,EADE,SAAS;cAAgB,EAAI,QAAO,CAAE,EAAC,WAAW,CAAC,EAAE,SAAS;eAClD,EAAG,QAAQ,CAAC,EAAE,WACvB,CAAC,EAAG,SAAQ;gBAAmB,EAAG,SAClC;gBAAiB,EAAG,UACnB;;aACI,CAAC;YAEX,CAAF;;;aAEiB,CAAC;YACE,CAAC;;yBAEE,EACrB,QAAK,CAAC,EAAE,WAEV,CAAI,EAAA,QACD,CAAK,wBAAwB,CACxB,EAAA,SADO;cAAgB,EACvB,QAAC,CAAC,EAAE,WAAW,CAAC,EAAE,SACnB,CAAC,iCAAiC;eAAhB,EAAG,QAAQ,CAAC,EAAE,WAC/B,CAAC,EAAE,SAAS;gBAIZ,EAAA,SADM;gBAAkB,EAAE,UAAU;;aACrB,CAAC;YAClB,CAAH;;;aAGuD,CAAC;YAC3C,CAAC;;;;;;;IAwFf,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;uBAvInC,EAAG,WAAW,CAAC,EAAE,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoJ3B,CAAA;AAE7B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}

package/dist/entities/spec/requests.js

@@ -1,7 +1,10 @@
 import { selectedSecuritySchemeUidSchema } from "../../entities/shared/utility.js";
 import { nanoidSchema } from "@scalar/types/utils";
 import { z } from "zod";
-import { XCodeSamplesSchema } from "@scalar/openapi-types/schemas/extensions";
+import {
+  XCodeSamplesSchema,
+  XPostResponseSchema
+} from "@scalar/openapi-types/schemas/extensions";
 import { XScalarStability } from "@scalar/types";
 import { oasSecurityRequirementSchema } from "@scalar/types/entities";
 import { oasParameterSchema } from "./parameters.js";
@@ -57,6 +60,7 @@ const oasRequestSchema = z.object({
   "x-scalar-examples": z.record(z.string(), xScalarExampleSchema).optional(),
   /** Hide operations */
   "x-internal": z.boolean().optional(),
+  /** Ignore operations */
   "x-scalar-ignore": z.boolean().optional()
 });
 const ScalarStabilitySchema = z.object({
@@ -78,7 +82,7 @@ const extendedRequestSchema = z.object({
   /** List of security scheme UIDs associated with the request */
   selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema
 });
-const requestSchema = oasRequestSchema.omit({ "x-scalar-examples": true }).merge(XCodeSamplesSchema).merge(ScalarStabilitySchema).merge(extendedRequestSchema);
+const requestSchema = oasRequestSchema.omit({ "x-scalar-examples": true }).merge(XCodeSamplesSchema).merge(ScalarStabilitySchema).merge(extendedRequestSchema).merge(XPostResponseSchema);
 export {
   oasRequestSchema,
   requestMethods,

package/dist/entities/spec/requests.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/entities/spec/requests.ts"],
-  "sourcesContent": ["import { selectedSecuritySchemeUidSchema } from '@/entities/shared/utility'\nimport { type ENTITY_BRANDS, nanoidSchema } from '@scalar/types/utils'\nimport { type ZodSchema, z } from 'zod'\n\nimport { XCodeSamplesSchema } from '@scalar/openapi-types/schemas/extensions'\nimport { XScalarStability } from '@scalar/types'\nimport { oasSecurityRequirementSchema } from '@scalar/types/entities'\nimport { oasParameterSchema } from './parameters'\nimport { type RequestExample, xScalarExampleSchema } from './request-examples'\nimport { oasExternalDocumentationSchema } from './spec-objects'\n\nexport const requestMethods = ['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace'] as const\n\nexport type RequestMethod = (typeof requestMethods)[number]\n\n/** A single set of populated values for a sent request */\nexport type ResponseInstance = Omit<Response, 'headers'> & {\n  /** Store headers as an object to match what we had with axios */\n  headers: Record<string, string>\n  /** Keys of headers which set cookies */\n  cookieHeaderKeys: string[]\n  /** Time in ms the request took */\n  duration: number\n  /** The response status */\n  status: number\n  /** The response method */\n  method: RequestMethod\n  /** The request path */\n  path: string\n} & (\n    | {\n        /** The response data */\n        data: string | Blob\n        /** The response size in bytes */\n        size: number\n      }\n    | {\n        /** A stream reader for a streamable response body */\n        reader: ReadableStreamDefaultReader<Uint8Array>\n      }\n  )\n\n/** A single request/response set to save to the history stack */\nexport type RequestEvent = {\n  request: RequestExample\n  response: ResponseInstance\n  timestamp: number\n}\n\n// TODO: Type body definitions\ntype RequestBody = object\nconst requestBodySchema = z.any() satisfies ZodSchema<RequestBody>\n\n/** Open API Compliant Request Validator */\nexport const oasRequestSchema = z.object({\n  /**\n   * A list of tags for API documentation control. Tags can be used for logical\n   * grouping of operations by resources or any other qualifier.\n   *\n   * These tags are the openapi spec tag names, not uids\n   */\n  'tags': z.string().array().optional(),\n  /** A short summary of what the operation does. */\n  'summary': z.string().optional(),\n  /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */\n  'description': z.string().optional(),\n  /**\n   * Unique string used to identify the operation. The id MUST be unique among all operations described in the API.\n   * The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an\n   * operation, therefore, it is RECOMMENDED to follow bin common programming naming conventions./\n   */\n  'operationId': z.string().optional(),\n  /**\n   * A declaration of which security mechanisms can be used across the API. The list of\n   * values includes alternative security requirement objects that can be used. Only\n   * one of the security requirement objects need to be satisfied to authorize a request.\n   * Individual operations can override this definition. To make security optional, an empty\n   * security requirement ({}) can be included in the array.\n   */\n  'security': z.array(oasSecurityRequirementSchema).optional(),\n  /**\n   * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the\n   * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the\n   * HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined\n   * semantics and SHOULD be avoided if possible.\n   */\n  'requestBody': requestBodySchema.optional(),\n  /**\n   * Request parameters\n   */\n  'parameters': oasParameterSchema.array().optional(),\n  /**\n   * External documentation object\n   */\n  'externalDocs': oasExternalDocumentationSchema.optional(),\n  'deprecated': z.boolean().optional(),\n  /** Response formats */\n  'responses': z.record(z.string(), z.any()).optional(),\n  /** xScalar examples */\n  'x-scalar-examples': z.record(z.string(), xScalarExampleSchema).optional(),\n  /** Hide operations */\n  'x-internal': z.boolean().optional(),\n  'x-scalar-ignore': z.boolean().optional(),\n})\n\n/**\n * An OpenAPI extension to indicate the stability of the operation\n *\n * @example\n * ```yaml\n * x-scalar-stability: deprecated\n * ```\n */\nconst ScalarStabilitySchema = z.object({\n  'x-scalar-stability': z\n    .enum([XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable])\n    .optional()\n    .catch(undefined),\n})\n\n/**\n * Extended properties added to the spec definition for client usage\n *\n * WARNING: DO NOT ADD PROPERTIES THAT SHARE A NAME WITH OAS OPERATION ENTITIES\n *\n * This object is directly converted to a spec operation during saving\n */\nconst extendedRequestSchema = z.object({\n  type: z.literal('request').optional().default('request'),\n  uid: nanoidSchema.brand<ENTITY_BRANDS['OPERATION']>(),\n  /** Path Key */\n  path: z.string().optional().default(''),\n  /** Request Method */\n  method: z.enum(requestMethods).default('get'),\n  /** List of server UIDs specific to the request */\n  servers: z.string().brand<ENTITY_BRANDS['SERVER']>().array().default([]),\n  /** The currently selected server */\n  selectedServerUid: z.string().brand<ENTITY_BRANDS['SERVER']>().optional().nullable().default(null),\n  /** List of example UIDs associated with the request */\n  examples: z.string().brand<ENTITY_BRANDS['EXAMPLE']>().array().default([]),\n  /** List of security scheme UIDs associated with the request */\n  selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,\n})\n\n/** Unified request schema for client usage */\nexport const requestSchema = oasRequestSchema\n  .omit({ 'x-scalar-examples': true })\n  .merge(XCodeSamplesSchema)\n  .merge(ScalarStabilitySchema)\n  .merge(extendedRequestSchema)\n\nexport type Request = z.infer<typeof requestSchema>\nexport type RequestPayload = z.input<typeof requestSchema>\n"],
-  "mappings": "AAAA,SAAS,uCAAuC;AAChD,SAA6B,oBAAoB;AACjD,SAAyB,SAAS;AAElC,SAAS,0BAA0B;AACnC,SAAS,wBAAwB;AACjC,SAAS,oCAAoC;AAC7C,SAAS,0BAA0B;AACnC,SAA8B,4BAA4B;AAC1D,SAAS,sCAAsC;AAExC,MAAM,iBAAiB,CAAC,WAAW,UAAU,OAAO,QAAQ,WAAW,SAAS,QAAQ,OAAO,OAAO;AAwC7G,MAAM,oBAAoB,EAAE,IAAI;AAGzB,MAAM,mBAAmB,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOvC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS;AAAA;AAAA,EAEpC,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE/B,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnC,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnC,YAAY,EAAE,MAAM,4BAA4B,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO3D,eAAe,kBAAkB,SAAS;AAAA;AAAA;AAAA;AAAA,EAI1C,cAAc,mBAAmB,MAAM,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,EAIlD,gBAAgB,+BAA+B,SAAS;AAAA,EACxD,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,EAEnC,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS;AAAA;AAAA,EAEpD,qBAAqB,EAAE,OAAO,EAAE,OAAO,GAAG,oBAAoB,EAAE,SAAS;AAAA;AAAA,EAEzE,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA,EACnC,mBAAmB,EAAE,QAAQ,EAAE,SAAS;AAC1C,CAAC;AAUD,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,sBAAsB,EACnB,KAAK,CAAC,iBAAiB,YAAY,iBAAiB,cAAc,iBAAiB,MAAM,CAAC,EAC1F,SAAS,EACT,MAAM,MAAS;AACpB,CAAC;AASD,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,MAAM,EAAE,QAAQ,SAAS,EAAE,SAAS,EAAE,QAAQ,SAAS;AAAA,EACvD,KAAK,aAAa,MAAkC;AAAA;AAAA,EAEpD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE;AAAA;AAAA,EAEtC,QAAQ,EAAE,KAAK,cAAc,EAAE,QAAQ,KAAK;AAAA;AAAA,EAE5C,SAAS,EAAE,OAAO,EAAE,MAA+B,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEvE,mBAAmB,EAAE,OAAO,EAAE,MAA+B,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,IAAI;AAAA;AAAA,EAEjG,UAAU,EAAE,OAAO,EAAE,MAAgC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEzE,4BAA4B;AAC9B,CAAC;AAGM,MAAM,gBAAgB,iBAC1B,KAAK,EAAE,qBAAqB,KAAK,CAAC,EAClC,MAAM,kBAAkB,EACxB,MAAM,qBAAqB,EAC3B,MAAM,qBAAqB;",
+  "sourcesContent": ["import { selectedSecuritySchemeUidSchema } from '@/entities/shared/utility'\nimport { type ENTITY_BRANDS, nanoidSchema } from '@scalar/types/utils'\nimport { type ZodSchema, z } from 'zod'\n\nimport {\n  type PostResponseSchema,\n  XCodeSamplesSchema,\n  XPostResponseSchema,\n} from '@scalar/openapi-types/schemas/extensions'\nimport { XScalarStability } from '@scalar/types'\nimport { oasSecurityRequirementSchema } from '@scalar/types/entities'\nimport { oasParameterSchema } from './parameters'\nimport { type RequestExample, xScalarExampleSchema } from './request-examples'\nimport { oasExternalDocumentationSchema } from './spec-objects'\n\nexport const requestMethods = ['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace'] as const\n\nexport type RequestMethod = (typeof requestMethods)[number]\n\n/** A single set of populated values for a sent request */\nexport type ResponseInstance = Omit<Response, 'headers'> & {\n  /** Store headers as an object to match what we had with axios */\n  headers: Record<string, string>\n  /** Keys of headers which set cookies */\n  cookieHeaderKeys: string[]\n  /** Time in ms the request took */\n  duration: number\n  /** The response status */\n  status: number\n  /** The response status text */\n  statusText: string\n  /** The response method */\n  method: RequestMethod\n  /** The request path */\n  path: string\n} & (\n    | {\n        /** The response data */\n        data: string | Blob\n        /** The response size in bytes */\n        size: number\n      }\n    | {\n        /** A stream reader for a streamable response body */\n        reader: ReadableStreamDefaultReader<Uint8Array>\n      }\n  )\n\n/** A single request/response set to save to the history stack */\nexport type RequestEvent = {\n  request: RequestExample\n  response: ResponseInstance\n  timestamp: number\n}\n\n// TODO: Type body definitions\ntype RequestBody = object\nconst requestBodySchema = z.any() satisfies ZodSchema<RequestBody>\n\n/** Open API Compliant Request Validator */\nexport const oasRequestSchema = z.object({\n  /**\n   * A list of tags for API documentation control. Tags can be used for logical\n   * grouping of operations by resources or any other qualifier.\n   *\n   * These tags are the openapi spec tag names, not uids\n   */\n  'tags': z.string().array().optional(),\n  /** A short summary of what the operation does. */\n  'summary': z.string().optional(),\n  /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */\n  'description': z.string().optional(),\n  /**\n   * Unique string used to identify the operation. The id MUST be unique among all operations described in the API.\n   * The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an\n   * operation, therefore, it is RECOMMENDED to follow bin common programming naming conventions./\n   */\n  'operationId': z.string().optional(),\n  /**\n   * A declaration of which security mechanisms can be used across the API. The list of\n   * values includes alternative security requirement objects that can be used. Only\n   * one of the security requirement objects need to be satisfied to authorize a request.\n   * Individual operations can override this definition. To make security optional, an empty\n   * security requirement ({}) can be included in the array.\n   */\n  'security': z.array(oasSecurityRequirementSchema).optional(),\n  /**\n   * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the\n   * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the\n   * HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined\n   * semantics and SHOULD be avoided if possible.\n   */\n  'requestBody': requestBodySchema.optional(),\n  /**\n   * Request parameters\n   */\n  'parameters': oasParameterSchema.array().optional(),\n  /**\n   * External documentation object\n   */\n  'externalDocs': oasExternalDocumentationSchema.optional(),\n  'deprecated': z.boolean().optional(),\n  /** Response formats */\n  'responses': z.record(z.string(), z.any()).optional(),\n  /** xScalar examples */\n  'x-scalar-examples': z.record(z.string(), xScalarExampleSchema).optional(),\n  /** Hide operations */\n  'x-internal': z.boolean().optional(),\n  /** Ignore operations */\n  'x-scalar-ignore': z.boolean().optional(),\n})\n\n/**\n * An OpenAPI extension to indicate the stability of the operation\n *\n * @example\n * ```yaml\n * x-scalar-stability: deprecated\n * ```\n */\nconst ScalarStabilitySchema = z.object({\n  'x-scalar-stability': z\n    .enum([XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable])\n    .optional()\n    .catch(undefined),\n})\n\n/**\n * Extended properties added to the spec definition for client usage\n *\n * WARNING: DO NOT ADD PROPERTIES THAT SHARE A NAME WITH OAS OPERATION ENTITIES\n *\n * This object is directly converted to a spec operation during saving\n */\nconst extendedRequestSchema = z.object({\n  type: z.literal('request').optional().default('request'),\n  uid: nanoidSchema.brand<ENTITY_BRANDS['OPERATION']>(),\n  /** Path Key */\n  path: z.string().optional().default(''),\n  /** Request Method */\n  method: z.enum(requestMethods).default('get'),\n  /** List of server UIDs specific to the request */\n  servers: z.string().brand<ENTITY_BRANDS['SERVER']>().array().default([]),\n  /** The currently selected server */\n  selectedServerUid: z.string().brand<ENTITY_BRANDS['SERVER']>().optional().nullable().default(null),\n  /** List of example UIDs associated with the request */\n  examples: z.string().brand<ENTITY_BRANDS['EXAMPLE']>().array().default([]),\n  /** List of security scheme UIDs associated with the request */\n  selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,\n})\n\nexport type PostResponseScript = z.infer<typeof PostResponseSchema>\nexport type PostResponseScripts = z.infer<typeof XPostResponseSchema>['x-post-response']\n\n/** Unified request schema for client usage */\nexport const requestSchema = oasRequestSchema\n  .omit({ 'x-scalar-examples': true })\n  .merge(XCodeSamplesSchema)\n  .merge(ScalarStabilitySchema)\n  .merge(extendedRequestSchema)\n  .merge(XPostResponseSchema)\n\nexport type Request = z.infer<typeof requestSchema>\nexport type RequestPayload = z.input<typeof requestSchema>\n"],
+  "mappings": "AAAA,SAAS,uCAAuC;AAChD,SAA6B,oBAAoB;AACjD,SAAyB,SAAS;AAElC;AAAA,EAEE;AAAA,EACA;AAAA,OACK;AACP,SAAS,wBAAwB;AACjC,SAAS,oCAAoC;AAC7C,SAAS,0BAA0B;AACnC,SAA8B,4BAA4B;AAC1D,SAAS,sCAAsC;AAExC,MAAM,iBAAiB,CAAC,WAAW,UAAU,OAAO,QAAQ,WAAW,SAAS,QAAQ,OAAO,OAAO;AA0C7G,MAAM,oBAAoB,EAAE,IAAI;AAGzB,MAAM,mBAAmB,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOvC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS;AAAA;AAAA,EAEpC,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE/B,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnC,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnC,YAAY,EAAE,MAAM,4BAA4B,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO3D,eAAe,kBAAkB,SAAS;AAAA;AAAA;AAAA;AAAA,EAI1C,cAAc,mBAAmB,MAAM,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,EAIlD,gBAAgB,+BAA+B,SAAS;AAAA,EACxD,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,EAEnC,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS;AAAA;AAAA,EAEpD,qBAAqB,EAAE,OAAO,EAAE,OAAO,GAAG,oBAAoB,EAAE,SAAS;AAAA;AAAA,EAEzE,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,EAEnC,mBAAmB,EAAE,QAAQ,EAAE,SAAS;AAC1C,CAAC;AAUD,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,sBAAsB,EACnB,KAAK,CAAC,iBAAiB,YAAY,iBAAiB,cAAc,iBAAiB,MAAM,CAAC,EAC1F,SAAS,EACT,MAAM,MAAS;AACpB,CAAC;AASD,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,MAAM,EAAE,QAAQ,SAAS,EAAE,SAAS,EAAE,QAAQ,SAAS;AAAA,EACvD,KAAK,aAAa,MAAkC;AAAA;AAAA,EAEpD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE;AAAA;AAAA,EAEtC,QAAQ,EAAE,KAAK,cAAc,EAAE,QAAQ,KAAK;AAAA;AAAA,EAE5C,SAAS,EAAE,OAAO,EAAE,MAA+B,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEvE,mBAAmB,EAAE,OAAO,EAAE,MAA+B,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,IAAI;AAAA;AAAA,EAEjG,UAAU,EAAE,OAAO,EAAE,MAAgC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEzE,4BAA4B;AAC9B,CAAC;AAMM,MAAM,gBAAgB,iBAC1B,KAAK,EAAE,qBAAqB,KAAK,CAAC,EAClC,MAAM,kBAAkB,EACxB,MAAM,qBAAqB,EAC3B,MAAM,qBAAqB,EAC3B,MAAM,mBAAmB;",
   "names": []
 }

package/dist/helpers/security/get-schemes.d.ts

@@ -2,9 +2,9 @@ import type { SecurityScheme } from '@scalar/types/entities';
 import type { Operation } from '../../entities/spec/operation.js';
 /** Parses a list of selected security scheme uids which may be an array or single uid and returns a flattened array of security schemes */
 export declare const getSchemes: (selectedSecuritySchemes: Operation["selectedSecuritySchemeUids"], securitySchemes: Record<SecurityScheme["uid"], SecurityScheme>) => NonNullable<{
-    name: string;
-    value: string;
     type: "apiKey";
+    value: string;
+    name: string;
     uid: string & import("zod").BRAND<"securityScheme">;
     nameKey: string;
     in: "cookie" | "query" | "header";

package/package.json

@@ -16,9 +16,9 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.143",
+  "version": "0.3.1",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "type": "module",
   "main": "dist/index.js",
@@ -93,10 +93,10 @@
     "type-fest": "^4.20.0",
     "yaml": "^2.4.5",
     "zod": "3.24.1",
-    "@scalar/object-utils": "1.1.14",
-    "@scalar/openapi-types": "0.2.3",
-    "@scalar/types": "0.1.15",
-    "@scalar/themes": "0.11.2"
+    "@scalar/object-utils": "1.2.1",
+    "@scalar/openapi-types": "0.3.1",
+    "@scalar/themes": "0.12.1",
+    "@scalar/types": "0.2.1"
   },
   "devDependencies": {
     "@types/node": "^20.17.10",
@@ -104,9 +104,9 @@
     "vite": "5.4.19",
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
-    "@scalar/build-tooling": "0.1.19",
-    "@scalar/openapi-types": "0.2.3",
-    "@scalar/openapi-parser": "0.10.17"
+    "@scalar/openapi-parser": "0.11.0",
+    "@scalar/build-tooling": "0.2.0",
+    "@scalar/openapi-types": "0.3.1"
   },
   "scripts": {
     "build": "scalar-build-esbuild",