@scalar/oas-utils 0.2.84 → 0.2.85

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/oas-utils
 
+## 0.2.85
+
+### Patch Changes
+
+- 3b4a788: feat: sets form request examples defaulting
+- 4c5be96: feat: adds isHttpMethod to helpers
+- 4c5be96: fix: sorts method based on path in import spec
+
 ## 0.2.84
 
 ### Patch Changes

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":"AAOA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAczC,CAAA;AAUF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AAED,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,uEAQ7B,CAAA;AAEV,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmBnC,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;AAOjE,2DAA2D;AAC3D,eAAO,MAAM,oBAAoB;IAC/B,qCAAqC;;;;QA3CrC;;;;WAIG;;QAEH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8C1E,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,cAAc;;;;;;;;;;;;;;;;EA8D9D;AAKD,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;;;;;;;;;;;;;;EA8C1D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,cAAc,CAiGhB"}
+{"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/request-examples.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAczC,CAAA;AAUF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AAED,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,uEAQ7B,CAAA;AAEV,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmBnC,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;AAOjE,2DAA2D;AAC3D,eAAO,MAAM,oBAAoB;IAC/B,qCAAqC;;;;QA3CrC;;;;WAIG;;QAEH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8C1E,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,cAAc;;;;;;;;;;;;;;;;EA8D9D;AAKD,6DAA6D;AAC7D,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;;;;;;;;;;;;;;EA8C1D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,cAAc,CA2GhB"}

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

@@ -325,12 +325,19 @@ function createExampleFromRequest(request, name, server) {
             body.activeBody = 'binary';
             body.binary = undefined;
         }
-        /**
-         * TODO: How are handling form data examples from the spec
-         */
-        if (requestBody?.body?.mimeType === 'application/x-www-form-urlencoded') {
+        if (requestBody?.body?.mimeType === 'application/x-www-form-urlencoded' ||
+            requestBody?.body?.mimeType === 'multipart/form-data') {
             body.activeBody = 'formData';
-            body.formData = undefined;
+            body.formData = {
+                encoding: requestBody.body.mimeType === 'application/x-www-form-urlencoded'
+                    ? 'urlencoded'
+                    : 'form-data',
+                value: (requestBody.body.params || []).map((param) => ({
+                    key: param.name,
+                    value: param.value || '',
+                    enabled: true,
+                })),
+            };
         }
     }
     const serverVariables = server ? getServerVariableExamples(server) : {};

package/dist/helpers/httpMethods.d.ts

@@ -1,4 +1,4 @@
-import type { RequestMethod } from '../entities/spec/requests.js';
+import { type RequestMethod } from '../entities/spec/requests.js';
 /**
  * HTTP methods in a specific order
  * Do not change the order
@@ -23,5 +23,7 @@ export declare const getHttpMethodInfo: (methodName: string) => {
     color: string;
     backgroundColor: string;
 };
+/** Type guard which takes in a string and returns true if it is in fact an HTTPMethod */
+export declare const isHttpMethod: (method: string) => method is RequestMethod;
 export {};
 //# sourceMappingURL=httpMethods.d.ts.map

package/dist/helpers/httpMethods.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"httpMethods.d.ts","sourceRoot":"","sources":["../../src/helpers/httpMethods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE7D;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE;KAC3B,CAAC,IAAI,aAAa,GAAG;QACpB,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,CAAA;KACxB;CA+CO,CAAA;AAEV,yCAAyC;AACzC,QAAA,MAAM,YAAY,6CAA8C,CAAA;AAChE,KAAK,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/C,0DAA0D;AAC1D,eAAO,MAAM,iBAAiB,WACpB,aAAa,KACpB,MAAM,IAAI,UAAyD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAgB,MAAM;WAhEzC,MAAM;WACN,MAAM;qBACI,MAAM;CAuE1B,CAAA"}
+{"version":3,"file":"httpMethods.d.ts","sourceRoot":"","sources":["../../src/helpers/httpMethods.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAkB,MAAM,0BAA0B,CAAA;AAE7E;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE;KAC3B,CAAC,IAAI,aAAa,GAAG;QACpB,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;QACb,eAAe,EAAE,MAAM,CAAA;KACxB;CA+CO,CAAA;AAEV,yCAAyC;AACzC,QAAA,MAAM,YAAY,6CAA8C,CAAA;AAChE,KAAK,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/C,0DAA0D;AAC1D,eAAO,MAAM,iBAAiB,WACpB,aAAa,KACpB,MAAM,IAAI,UAAyD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAgB,MAAM;WAhEzC,MAAM;WACN,MAAM;qBACI,MAAM;CAuE1B,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,YAAY,WAAY,MAAM,KAAG,MAAM,IAAI,aACN,CAAA"}

package/dist/helpers/httpMethods.js

@@ -1,3 +1,5 @@
+import { requestMethods } from '../entities/spec/requests.js';
+
 /**
  * HTTP methods in a specific order
  * Do not change the order
@@ -64,5 +66,7 @@ const getHttpMethodInfo = (methodName) => {
         backgroundColor: 'bg-c-2',
     });
 };
+/** Type guard which takes in a string and returns true if it is in fact an HTTPMethod */
+const isHttpMethod = (method) => requestMethods.includes(method);
 
-export { REQUEST_METHODS, canMethodHaveBody, getHttpMethodInfo };
+export { REQUEST_METHODS, canMethodHaveBody, getHttpMethodInfo, isHttpMethod };

package/dist/helpers/index.js

@@ -3,7 +3,7 @@ export { createHash } from './createHash.js';
 export { fetchSpecFromUrl } from './fetchSpecFromUrl.js';
 export { fetchWithProxyFallback } from './fetchWithProxyFallback.js';
 export { findVariables } from './findVariables.js';
-export { REQUEST_METHODS, canMethodHaveBody, getHttpMethodInfo } from './httpMethods.js';
+export { REQUEST_METHODS, canMethodHaveBody, getHttpMethodInfo, isHttpMethod } from './httpMethods.js';
 export { httpStatusCodes } from './httpStatusCodes.js';
 export { isLocalUrl } from './isLocalUrl.js';
 export { isValidUrl } from './isValidUrl.js';

package/dist/transforms/import-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAOT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAIjC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;IAwB1D;;;OAGG;YAEC,SAAS,CAAC,QAAQ,GAClB,WAAW,CAAC,QAAQ;;;;;EAG3B,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,eAAe,EACxB,qBAA6B,EAC7B,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;IACjD,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CAuVA"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAMT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAKjC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;IAwB1D;;;OAGG;YAEC,SAAS,CAAC,QAAQ,GAClB,WAAW,CAAC,QAAQ;;;;;EAG3B,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,eAAe,EACxB,qBAA6B,EAC7B,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;IACjD,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CAuVA"}

package/dist/transforms/import-spec.js

@@ -1,9 +1,10 @@
 import { securitySchemeSchema } from '../entities/spec/security.js';
+import { isHttpMethod } from '../helpers/httpMethods.js';
 import { schemaModel } from '../helpers/schema-model.js';
 import { keysOf } from '@scalar/object-utils/arrays';
 import { load, upgrade, dereference } from '@scalar/openapi-parser';
 import { serverSchema } from '../entities/spec/server.js';
-import { requestMethods, requestSchema } from '../entities/spec/requests.js';
+import { requestSchema } from '../entities/spec/requests.js';
 import { tagSchema } from '../entities/spec/spec-objects.js';
 import { createExampleFromRequest } from '../entities/spec/request-examples.js';
 import { collectionSchema } from '../entities/spec/collection.js';
@@ -161,77 +162,77 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
         // Path level servers must be saved
         const pathServers = serverSchema.array().parse(path.servers ?? []);
         servers.push(...pathServers);
-        requestMethods.forEach((method) => {
+        // Creates a sorted array of methods based on the path object.
+        const methods = Object.keys(path).filter(isHttpMethod);
+        methods.forEach((method) => {
             const operation = path[method];
-            if (operation && typeof operation === 'object') {
-                const operationServers = serverSchema
-                    .array()
-                    .parse(operation.servers ?? []);
-                servers.push(...operationServers);
-                // We will save a list of all tags to ensure they exists at the top level
-                // TODO: make sure we add any loose requests with no tags to the collection children
-                operation.tags?.forEach((t) => tagNames.add(t));
-                // Remove security here and add it correctly below
-                const { security: operationSecurity, ...operationWithoutSecurity } = operation;
-                // Grab the security requirements for this operation
-                const securityRequirements = (operationSecurity ??
-                    schema.security ??
-                    []).flatMap((s) => {
+            const operationServers = serverSchema
+                .array()
+                .parse(operation.servers ?? []);
+            servers.push(...operationServers);
+            // We will save a list of all tags to ensure they exists at the top level
+            // TODO: make sure we add any loose requests with no tags to the collection children
+            operation.tags?.forEach((t) => tagNames.add(t));
+            // Remove security here and add it correctly below
+            const { security: operationSecurity, ...operationWithoutSecurity } = operation;
+            // Grab the security requirements for this operation
+            const securityRequirements = (operationSecurity ??
+                schema.security ??
+                []).flatMap((s) => {
+                const keys = Object.keys(s);
+                if (keys.length)
+                    return keys[0];
+                else
+                    return [];
+            });
+            let selectedSecuritySchemeUids = [];
+            // Set the initially selected security scheme
+            if (securityRequirements.length && !setCollectionSecurity) {
+                const name = authentication?.preferredSecurityScheme &&
+                    securityRequirements.includes(authentication.preferredSecurityScheme ?? '')
+                    ? authentication.preferredSecurityScheme
+                    : securityRequirements[0];
+                const uid = securitySchemeMap[name];
+                selectedSecuritySchemeUids = [uid];
+            }
+            const requestPayload = {
+                ...operationWithoutSecurity,
+                method,
+                path: pathString,
+                selectedSecuritySchemeUids,
+                // Merge path and operation level parameters
+                parameters: [
+                    ...(path?.parameters ?? []),
+                    ...(operation.parameters ?? []),
+                ],
+                servers: [...pathServers, ...operationServers].map((s) => s.uid),
+            };
+            // Remove any examples from the request payload as they conflict with our examples property and are not valid
+            if (requestPayload.examples) {
+                console.warn('[@scalar/api-client] operation.examples is not a valid openapi property');
+                delete requestPayload.examples;
+            }
+            // Add list of UIDs to associate security schemes
+            // As per the spec if there is operation level security we ignore the top level requirements
+            if (operationSecurity?.length)
+                requestPayload.security = operationSecurity.map((s) => {
                     const keys = Object.keys(s);
-                    if (keys.length)
-                        return keys[0];
+                    // Handle the case of {} for optional
+                    if (keys.length) {
+                        const [key] = Object.keys(s);
+                        return {
+                            [key]: s[key],
+                        };
+                    }
                     else
-                        return [];
+                        return s;
                 });
-                let selectedSecuritySchemeUids = [];
-                // Set the initially selected security scheme
-                if (securityRequirements.length && !setCollectionSecurity) {
-                    const name = authentication?.preferredSecurityScheme &&
-                        securityRequirements.includes(authentication.preferredSecurityScheme ?? '')
-                        ? authentication.preferredSecurityScheme
-                        : securityRequirements[0];
-                    const uid = securitySchemeMap[name];
-                    selectedSecuritySchemeUids = [uid];
-                }
-                const requestPayload = {
-                    ...operationWithoutSecurity,
-                    method,
-                    path: pathString,
-                    selectedSecuritySchemeUids,
-                    // Merge path and operation level parameters
-                    parameters: [
-                        ...(path?.parameters ?? []),
-                        ...(operation.parameters ?? []),
-                    ],
-                    servers: [...pathServers, ...operationServers].map((s) => s.uid),
-                };
-                // Remove any examples from the request payload as they conflict with our examples property and are not valid
-                if (requestPayload.examples) {
-                    console.warn('[@scalar/api-client] operation.examples is not a valid openapi property');
-                    delete requestPayload.examples;
-                }
-                // Add list of UIDs to associate security schemes
-                // As per the spec if there is operation level security we ignore the top level requirements
-                if (operationSecurity?.length)
-                    requestPayload.security = operationSecurity.map((s) => {
-                        const keys = Object.keys(s);
-                        // Handle the case of {} for optional
-                        if (keys.length) {
-                            const [key] = Object.keys(s);
-                            return {
-                                [key]: s[key],
-                            };
-                        }
-                        else
-                            return s;
-                    });
-                // Save parse the request
-                const request = schemaModel(requestPayload, requestSchema, false);
-                if (!request)
-                    importWarnings.push(`${method} Request at ${path} is invalid.`);
-                else
-                    requests.push(request);
-            }
+            // Save parse the request
+            const request = schemaModel(requestPayload, requestSchema, false);
+            if (!request)
+                importWarnings.push(`${method} Request at ${path} is invalid.`);
+            else
+                requests.push(request);
         });
     });
     // ---------------------------------------------------------------------------

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.84",
+  "version": "0.2.85",
   "engines": {
     "node": ">=18"
   },
@@ -111,9 +111,9 @@
     "nanoid": "^5.0.7",
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
-    "@scalar/object-utils": "1.1.12",
-    "@scalar/themes": "0.9.54",
     "@scalar/openapi-types": "0.1.5",
+    "@scalar/themes": "0.9.54",
+    "@scalar/object-utils": "1.1.12",
     "@scalar/types": "0.0.23"
   },
   "devDependencies": {
@@ -121,9 +121,9 @@
     "vite": "^5.4.10",
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
-    "@scalar/build-tooling": "0.1.12",
+    "@scalar/openapi-types": "0.1.5",
     "@scalar/openapi-parser": "0.8.10",
-    "@scalar/openapi-types": "0.1.5"
+    "@scalar/build-tooling": "0.1.12"
   },
   "scripts": {
     "build": "scalar-build-rollup",