@scalar/oas-utils 0.2.121 → 0.2.123

package/dist/entities/spec/request-examples.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/request-examples.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAKtC;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuCvC,CAAA;AAEJ,+EAA+E;AAC/E,eAAO,MAAM,sBAAsB,WAAY,uBAAuB,EAAE,2BAIhE,CAAA;AAER,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAEpF,eAAO,MAAM,sBAAsB;;;;;;;;;GAKtB,CAAA;AAEb;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAErE;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAS/B,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAKvE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,uEAAwE,CAAA;AAE/G,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAA;AAEtE,eAAO,MAAM,eAAe,gPAalB,CAAA;AAEV,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAA;AAYvD;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBnC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAEzE,iEAAiE;AACjE,eAAO,MAAM,wBAAwB;;IAEnC;;;;OAIG;;IAEH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;EAE1E,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAKzE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAe/B,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEvC,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAKjE,2DAA2D;AAC3D,eAAO,MAAM,oBAAoB;IAC/B,qCAAqC;;;;QAzCrC;;;;WAIG;;QAEH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4C1E,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,cAAc;;;;;;;;;;;;;;;;EAqD9D;AAKD,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;;;;;;;;;;;;;;;EAiE1D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,cAAc,CA8GxG"}
+{"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/request-examples.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAKzC;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuCvC,CAAA;AAEJ,+EAA+E;AAC/E,eAAO,MAAM,sBAAsB,WAAY,uBAAuB,EAAE,2BAIhE,CAAA;AAER,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAEpF,eAAO,MAAM,sBAAsB;;;;;;;;;GAKtB,CAAA;AAEb;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAErE;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAS/B,CAAA;AAEF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAKvE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,uEAAwE,CAAA;AAE/G,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAA;AAEtE,eAAO,MAAM,eAAe,gPAalB,CAAA;AAEV,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAA;AAYvD;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgBnC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAEzE,iEAAiE;AACjE,eAAO,MAAM,wBAAwB;;IAEnC;;;;OAIG;;IAEH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;EAE1E,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAKzE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAe/B,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEvC,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAKjE,2DAA2D;AAC3D,eAAO,MAAM,oBAAoB;IAC/B,qCAAqC;;;;QAzCrC;;;;WAIG;;QAEH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4C1E,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,cAAc;;;;;;;;;;;;;;;;EAqD9D;AAKD,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;;;;;;;;;;;;;;;EAiE1D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,cAAc,CA8GxG"}

package/dist/entities/spec/request-examples.js

@@ -1,9 +1,8 @@
-import { keysOf } from '@scalar/object-utils/arrays';
-import { z } from 'zod';
-import { nanoidSchema } from '../shared/utility.js';
 import { schemaModel } from '../../helpers/schema-model.js';
-import { getRequestBodyFromOperation } from '../../spec-getters/getRequestBodyFromOperation.js';
-import { getServerVariableExamples } from '../../spec-getters/getServerVariableExamples.js';
+import { getServerVariableExamples } from '../../spec-getters/get-server-variable-examples.js';
+import { nanoidSchema } from '@scalar/types/utils';
+import { z } from 'zod';
+import { getRequestBodyFromOperation } from '../../spec-getters/get-request-body-from-operation.js';
 
 // ---------------------------------------------------------------------------
 // Example Parameters
@@ -50,11 +49,6 @@ const requestExampleParametersSchema = z
     }
     return data;
 });
-/** Convert the array of parameters to an object keyed by the parameter name */
-const parameterArrayToObject = (params) => params.reduce((map, param) => {
-    map[param.key] = param.value;
-    return map;
-}, {});
 const xScalarFileValueSchema = z
     .object({
     url: z.string(),
@@ -66,7 +60,7 @@ const xScalarFileValueSchema = z
  *
  * File values can be optionally fetched on import OR inserted as a base64 encoded string
  */
-const xScalarFormDataValue = z.union([
+z.union([
     z.object({
         type: z.literal('string'),
         value: z.string(),
@@ -98,15 +92,6 @@ const exampleBodyMime = [
     /** Used for direct files */
     'binary',
 ];
-const contentMapping = {
-    json: 'application/json',
-    text: 'text/plain',
-    html: 'text/html',
-    javascript: 'application/javascript',
-    xml: 'application/xml',
-    yaml: 'application/yaml',
-    edn: 'application/edn',
-};
 /**
  * TODO: Migrate away from this layout to the format used in the extension
  *
@@ -175,56 +160,6 @@ const xScalarExampleSchema = z.object({
         cookies: xScalarExampleParameterSchema,
     }),
 });
-/**
- * Convert a request example to the xScalar serialized format
- *
- * TODO: The base format should be migrated to align MUCH closer to the serialized format
- */
-function convertExampleToXScalar(example) {
-    const active = example.body?.activeBody;
-    const xScalarBody = {
-        encoding: 'text/plain',
-        content: '',
-    };
-    if (example.body?.activeBody === 'binary') {
-        xScalarBody.encoding = 'binary';
-        // TODO: Need to allow users to set these properties
-        xScalarBody.file = null;
-    }
-    if (active === 'formData' && example.body?.[active]) {
-        const body = example.body[active];
-        xScalarBody.encoding = body.encoding === 'form-data' ? 'multipart/form-data' : 'application/x-www-form-urlencoded';
-        // TODO: Need to allow users to set these properties
-        xScalarBody.content = body.value.reduce((map, param) => {
-            /** TODO: We need to ensure only file or value is set */
-            map[param.key] = param.file
-                ? {
-                    type: 'file',
-                    file: null,
-                }
-                : {
-                    type: 'string',
-                    value: param.value,
-                };
-            return map;
-        }, {});
-    }
-    if (example.body?.activeBody === 'raw') {
-        xScalarBody.encoding = contentMapping[example.body.raw?.encoding ?? 'text'] ?? 'text/plain';
-        xScalarBody.content = example.body.raw?.value ?? '';
-    }
-    const parameters = {};
-    keysOf(example.parameters ?? {}).forEach((key) => {
-        if (example.parameters?.[key].length) {
-            parameters[key] = parameterArrayToObject(example.parameters[key]);
-        }
-    });
-    return xScalarExampleSchema.parse({
-        /** Only add the body if we have content or the body should be a file */
-        body: xScalarBody.content || xScalarBody.encoding === 'binary' ? xScalarBody : undefined,
-        parameters,
-    });
-}
 // ---------------------------------------------------------------------------
 // Example Helpers
 /** Create new instance parameter from a request parameter */
@@ -375,4 +310,4 @@ function createExampleFromRequest(request, name, server) {
     return example;
 }
 
-export { convertExampleToXScalar, createExampleFromRequest, createParamInstance, exampleBodyMime, exampleRequestBodyEncoding, exampleRequestBodySchema, parameterArrayToObject, requestExampleParametersSchema, requestExampleSchema, xScalarExampleBodySchema, xScalarExampleSchema, xScalarFileValueSchema, xScalarFormDataValue };
+export { createExampleFromRequest, createParamInstance, exampleBodyMime, exampleRequestBodyEncoding, exampleRequestBodySchema, requestExampleParametersSchema, requestExampleSchema, xScalarExampleBodySchema, xScalarExampleSchema, xScalarFileValueSchema };

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

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { XScalarStability } from '@scalar/types';
-import { type RequestExample } from './request-examples.js';
+import { type RequestExample } from './request-examples.ts';
 export declare const requestMethods: readonly ["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"];
 export type RequestMethod = (typeof requestMethods)[number];
 /** A single set of populated values for a sent request */
@@ -86,12 +86,12 @@ export declare const oasRequestSchema: z.ZodObject<{
             summary?: string | undefined;
         }>>, z.ZodArray<z.ZodUnknown, "many">]>>;
     }, "strip", z.ZodTypeAny, {
-        required: boolean;
         name: string;
-        in: "path" | "cookie" | "query" | "header";
+        required: boolean;
+        in: "cookie" | "path" | "query" | "header";
         deprecated: boolean;
-        example?: unknown;
         description?: string | undefined;
+        example?: unknown;
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
@@ -101,10 +101,10 @@ export declare const oasRequestSchema: z.ZodObject<{
         }> | undefined;
     }, {
         name: string;
-        in: "path" | "cookie" | "query" | "header";
-        example?: unknown;
-        required?: boolean | undefined;
+        in: "cookie" | "path" | "query" | "header";
         description?: string | undefined;
+        required?: boolean | undefined;
+        example?: unknown;
         deprecated?: boolean | undefined;
         schema?: unknown;
         content?: unknown;
@@ -154,14 +154,14 @@ export declare const oasRequestSchema: z.ZodObject<{
             }>>>;
         }, "strip", z.ZodTypeAny, {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
             } | null | undefined;
         }, {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -174,26 +174,26 @@ export declare const oasRequestSchema: z.ZodObject<{
             cookies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         }, {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         }>;
     }, "strip", z.ZodTypeAny, {
         parameters: {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         };
         name?: string | undefined;
         body?: {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -202,14 +202,14 @@ export declare const oasRequestSchema: z.ZodObject<{
     }, {
         parameters: {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         };
         name?: string | undefined;
         body?: {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -233,12 +233,12 @@ export declare const oasRequestSchema: z.ZodObject<{
     deprecated?: boolean | undefined;
     operationId?: string | undefined;
     parameters?: {
-        required: boolean;
         name: string;
-        in: "path" | "cookie" | "query" | "header";
+        required: boolean;
+        in: "cookie" | "path" | "query" | "header";
         deprecated: boolean;
-        example?: unknown;
         description?: string | undefined;
+        example?: unknown;
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
@@ -252,14 +252,14 @@ export declare const oasRequestSchema: z.ZodObject<{
     'x-scalar-examples'?: Record<string, {
         parameters: {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         };
         name?: string | undefined;
         body?: {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -281,10 +281,10 @@ export declare const oasRequestSchema: z.ZodObject<{
     operationId?: string | undefined;
     parameters?: {
         name: string;
-        in: "path" | "cookie" | "query" | "header";
-        example?: unknown;
-        required?: boolean | undefined;
+        in: "cookie" | "path" | "query" | "header";
         description?: string | undefined;
+        required?: boolean | undefined;
+        example?: unknown;
         deprecated?: boolean | undefined;
         schema?: unknown;
         content?: unknown;
@@ -299,14 +299,14 @@ export declare const oasRequestSchema: z.ZodObject<{
     'x-scalar-examples'?: Record<string, {
         parameters: {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         };
         name?: string | undefined;
         body?: {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -372,12 +372,12 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
             summary?: string | undefined;
         }>>, z.ZodArray<z.ZodUnknown, "many">]>>;
     }, "strip", z.ZodTypeAny, {
-        required: boolean;
         name: string;
-        in: "path" | "cookie" | "query" | "header";
+        required: boolean;
+        in: "cookie" | "path" | "query" | "header";
         deprecated: boolean;
-        example?: unknown;
         description?: string | undefined;
+        example?: unknown;
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
@@ -387,10 +387,10 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         }> | undefined;
     }, {
         name: string;
-        in: "path" | "cookie" | "query" | "header";
-        example?: unknown;
-        required?: boolean | undefined;
+        in: "cookie" | "path" | "query" | "header";
         description?: string | undefined;
+        required?: boolean | undefined;
+        example?: unknown;
         deprecated?: boolean | undefined;
         schema?: unknown;
         content?: unknown;
@@ -440,14 +440,14 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
             }>>>;
         }, "strip", z.ZodTypeAny, {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
             } | null | undefined;
         }, {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -460,26 +460,26 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
             cookies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, "strip", z.ZodTypeAny, {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         }, {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         }>;
     }, "strip", z.ZodTypeAny, {
         parameters: {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         };
         name?: string | undefined;
         body?: {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -488,14 +488,14 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     }, {
         parameters: {
             path?: Record<string, string> | undefined;
-            cookies?: Record<string, string> | undefined;
             query?: Record<string, string> | undefined;
             headers?: Record<string, string> | undefined;
+            cookies?: Record<string, string> | undefined;
         };
         name?: string | undefined;
         body?: {
             content: string | Record<string, any>;
-            encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
+            encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
             file?: {
                 url: string;
                 base64?: string | undefined;
@@ -523,9 +523,9 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     /** 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">>;
 }>, "strip", z.ZodTypeAny, {
+    uid: string & z.BRAND<"operation">;
     path: string;
     type: "request";
-    uid: string & z.BRAND<"operation">;
     selectedSecuritySchemeUids: ((string & z.BRAND<"securityScheme">) | (string & z.BRAND<"securityScheme">)[])[];
     selectedServerUid: (string & z.BRAND<"server">) | null;
     servers: (string & z.BRAND<"server">)[];
@@ -544,12 +544,12 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     deprecated?: boolean | undefined;
     operationId?: string | undefined;
     parameters?: {
-        required: boolean;
         name: string;
-        in: "path" | "cookie" | "query" | "header";
+        required: boolean;
+        in: "cookie" | "path" | "query" | "header";
         deprecated: boolean;
-        example?: unknown;
         description?: string | undefined;
+        example?: unknown;
         schema?: unknown;
         content?: unknown;
         style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
@@ -562,9 +562,9 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     responses?: Record<string, any> | undefined;
     'x-scalar-stability'?: XScalarStability | undefined;
 }, {
+    uid?: string | undefined;
     path?: string | undefined;
     type?: "request" | undefined;
-    uid?: string | undefined;
     description?: string | undefined;
     summary?: string | undefined;
     externalDocs?: {
@@ -583,10 +583,10 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     operationId?: string | undefined;
     parameters?: {
         name: string;
-        in: "path" | "cookie" | "query" | "header";
-        example?: unknown;
-        required?: boolean | undefined;
+        in: "cookie" | "path" | "query" | "header";
         description?: string | undefined;
+        required?: boolean | undefined;
+        example?: unknown;
         deprecated?: boolean | undefined;
         schema?: unknown;
         content?: 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;AAEvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAEhD,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAI9E,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,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG2B,CAAA;AAyCnD,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;;;;;;;;IA8BtB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQlC,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,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAGhD,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,uBAAuB,CAAA;AAGjF,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,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,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;;;;;;;;IA8BtB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQlC,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"}

package/dist/entities/spec/requests.js

@@ -1,9 +1,10 @@
-import { nanoidSchema, selectedSecuritySchemeUidSchema } from '../shared/utility.js';
+import { selectedSecuritySchemeUidSchema } from '../shared/utility.js';
+import { nanoidSchema } from '@scalar/types/utils';
 import { z } from 'zod';
 import { XScalarStability } from '@scalar/types';
+import { oasSecurityRequirementSchema } from '@scalar/types/entities';
 import { oasParameterSchema } from './parameters.js';
 import { xScalarExampleSchema } from './request-examples.js';
-import { oasSecurityRequirementSchema } from './security.js';
 import { oasExternalDocumentationSchema } from './spec-objects.js';
 
 const requestMethods = ['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace'];