@scalar/oas-utils 0.2.77 → 0.2.79

package/dist/transforms/import-spec.js

@@ -1,4 +1,4 @@
-import { securitySchemeSchema, authExampleFromSchema } from '../entities/spec/security.js';
+import { securitySchemeSchema } from '../entities/spec/security.js';
 import { schemaModel } from '../helpers/schema-model.js';
 import { keysOf } from '@scalar/object-utils/arrays';
 import { load, upgrade, dereference } from '@scalar/openapi-parser';
@@ -8,90 +8,31 @@ import { tagSchema } from '../entities/spec/spec-objects.js';
 import { createExampleFromRequest } from '../entities/spec/request-examples.js';
 import { collectionSchema } from '../entities/spec/collection.js';
 
-/**
- * We need to convert from openapi spec flows to our singular flow object here
- * If we ever go spec compliant (flows), we will no longer need this conversion
- */
-const convertOauth2Flows = (security, nameKey, auth) => {
-    if (security.type === 'oauth2') {
-        const entries = Object.entries(security.flows ?? {});
-        if (entries.length) {
-            const [[type, flow]] = entries;
-            const payload = {
-                ...security,
-                nameKey,
-                flow: {
-                    ...flow,
-                    scopes: 
-                    // Ensure we convert array scope to an object
-                    Array.isArray(flow.scopes) && typeof flow.scopes[0] === 'string'
-                        ? flow.scopes.reduce((prev, s) => ({ ...prev, [s]: '' }), {})
-                        : flow.scopes,
-                    type,
-                },
-            };
-            if (auth?.oAuth2 && payload.flow) {
-                // Set client id
-                if (auth.oAuth2.clientId)
-                    payload['x-scalar-client-id'] = auth.oAuth2.clientId;
-                // Set selected scopes
-                if (auth.oAuth2.scopes)
-                    payload.flow.selectedScopes = auth.oAuth2.scopes;
-            }
-            // Handle x-defaultClientId
-            if ('x-defaultClientId' in flow &&
-                typeof flow['x-defaultClientId'] === 'string')
-                payload['x-scalar-client-id'] = flow['x-defaultClientId'];
-            return payload;
-        }
-    }
-    return {
-        ...security,
-        nameKey,
-    };
-};
-/** Pre-fill baseValues if we have authentication config */
-const getBaseAuthValues = (scheme, auth) => {
-    if (!auth)
-        return {};
-    // ApiKey
-    if (scheme.type === 'apiKey')
-        return { value: auth.apiKey?.token ?? '' };
-    // HTTP
-    else if (scheme.type === 'http') {
-        if (scheme.scheme === 'basic')
-            return {
-                username: auth.http?.basic?.username ?? '',
-                password: auth.http?.basic?.password ?? '',
-            };
-        else if (scheme.scheme === 'bearer')
-            return { token: auth.http?.bearer?.token ?? '' };
-    }
-    // oauth2 implicit only for now, when we support multi flow can expand this
-    else if (scheme.type === 'oauth2') {
-        if (scheme.flow?.type === 'implicit')
-            return {
-                type: 'oauth-implicit',
-                token: auth.oAuth2?.accessToken ?? '',
-            };
-        else if (scheme.flow?.type === 'password')
-            return {
-                type: 'oauth-password',
-                token: auth.oAuth2?.accessToken ?? '',
-                username: auth.oAuth2?.username ?? '',
-                password: auth.oAuth2?.password ?? '',
-            };
-    }
-    return {};
-};
 /** Takes a string or object and parses it into an openapi spec compliant schema */
 const parseSchema = async (spec) => {
     // TODO: Plugins for URLs and files with the proxy is missing here.
     // @see packages/api-reference/src/helpers/parse.ts
-    const { filesystem } = await load(spec);
+    const { filesystem, errors: loadErrors = [] } = await load(spec).catch((e) => ({
+        errors: [
+            {
+                code: e.code,
+                message: e.message,
+            },
+        ],
+        filesystem: [],
+    }));
     const { specification } = upgrade(filesystem);
-    const { schema, errors = [] } = await dereference(specification);
-    return { schema: schema, errors };
+    const { schema, errors: derefErrors = [] } = await dereference(specification);
+    if (!schema)
+        console.warn('[@scalar/oas-utils] OpenAPI Parser Warning: Schema is undefined');
+    return {
+        /**
+         * Temporary fix for the parser returning an empty array
+         * TODO: remove this once the parser is fixed
+         */
+        schema: (Array.isArray(schema) ? {} : schema),
+        errors: [...loadErrors, ...derefErrors],
+    };
 };
 /**
  * Imports an OpenAPI document and converts it to workspace entities (Collection, Request, Server, etc.)
@@ -149,15 +90,58 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     // SECURITY HANDLING
     const security = schema.components?.securitySchemes ?? schema?.securityDefinitions ?? {};
     const securitySchemes = Object.entries(security)
-        .map?.(([nameKey, s]) => {
-        const scheme = schemaModel(
-        // We must convert flows to a singular object, technically not spec compliant so we grab the first
-        s.type === 'oauth2'
-            ? convertOauth2Flows(s, nameKey, authentication)
-            : {
-                ...s,
-                nameKey,
-            }, securitySchemeSchema, false);
+        .map?.(([nameKey, _scheme]) => {
+        // Apply any transforms we need before parsing
+        const payload = {
+            ..._scheme,
+            nameKey,
+        };
+        // For oauth2 we need to add the type to the flows + prefill from authentication
+        if (payload.type === 'oauth2' && payload.flows) {
+            const flowKeys = Object.keys(payload.flows);
+            flowKeys.forEach((key) => {
+                if (!payload.flows?.[key])
+                    return;
+                const flow = payload.flows[key];
+                // Set the type
+                flow.type = key;
+                // Prefill values from authorization config
+                if (authentication?.oAuth2) {
+                    if (authentication.oAuth2.accessToken)
+                        flow.token = authentication.oAuth2.accessToken;
+                    if (flow.type === 'password') {
+                        flow.username = authentication.oAuth2.username;
+                        flow.password = authentication.oAuth2.password;
+                    }
+                    if (authentication.oAuth2.scopes) {
+                        flow.selectedScopes = authentication.oAuth2.scopes;
+                        flow['x-scalar-client-id'] = authentication.oAuth2.clientId;
+                    }
+                }
+                // Convert scopes to an object
+                if (Array.isArray(flow.scopes))
+                    flow.scopes = flow.scopes.reduce((prev, s) => ({ ...prev, [s]: '' }), {});
+                // Handle x-defaultClientId
+                if (flow['x-defaultClientId'])
+                    flow['x-scalar-client-id'] = flow['x-defaultClientId'];
+            });
+        }
+        // Otherwise we just prefill
+        else if (authentication) {
+            // ApiKey
+            if (payload.type === 'apiKey' && authentication.apiKey?.token)
+                payload.value = authentication.apiKey.token;
+            // HTTP
+            else if (payload.type === 'http') {
+                if (payload.scheme === 'basic' && authentication.http?.basic) {
+                    payload.username = authentication.http.basic.username ?? '';
+                    payload.password = authentication.http.basic.password ?? '';
+                }
+                else if (payload.scheme === 'bearer' && authentication.http?.bearer)
+                    payload.token = authentication.http.bearer.token ?? '';
+            }
+        }
+        const scheme = schemaModel(payload, securitySchemeSchema, false);
         if (!scheme)
             importWarnings.push(`Security scheme ${nameKey} is invalid.`);
         return scheme;
@@ -299,14 +283,6 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     });
     // ---------------------------------------------------------------------------
     // Generate Collection
-    // Create the auth examples
-    const auth = securitySchemes?.reduce((prev, s) => {
-        const baseValues = getBaseAuthValues(s, authentication);
-        const example = authExampleFromSchema(s, baseValues);
-        if (example)
-            prev[s.uid] = example;
-        return prev;
-    }, {});
     const securityKeys = Object.keys(security);
     let selectedSecuritySchemeUids = [];
     /** Selected security scheme UIDs for the collection, defaults to the first key */
@@ -319,7 +295,6 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
         ...schema,
         watchMode,
         documentUrl,
-        auth,
         requests: requests.map((r) => r.uid),
         servers: servers.map((s) => s.uid),
         tags: tags.map((t) => t.uid),
@@ -350,4 +325,4 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     };
 }
 
-export { getBaseAuthValues, importSpecToWorkspace, parseSchema };
+export { importSpecToWorkspace, parseSchema };

package/dist/transforms/index.js

@@ -1,2 +1,2 @@
-export { getBaseAuthValues, importSpecToWorkspace, parseSchema } from './import-spec.js';
+export { importSpecToWorkspace, parseSchema } from './import-spec.js';
 export { exportSpecFromWorkspace } from './export-spec.js';

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.77",
+  "version": "0.2.79",
   "engines": {
     "node": ">=18"
   },
@@ -38,6 +38,11 @@
       "types": "./dist/migrations/index.d.ts",
       "default": "./dist/migrations/index.js"
     },
+    "./migrations/v-2.2.0": {
+      "import": "./dist/migrations/v-2.2.0/index.js",
+      "types": "./dist/migrations/v-2.2.0/index.d.ts",
+      "default": "./dist/migrations/v-2.2.0/index.js"
+    },
     "./migrations/v-2.1.0": {
       "import": "./dist/migrations/v-2.1.0/index.js",
       "types": "./dist/migrations/v-2.1.0/index.d.ts",
@@ -106,16 +111,16 @@
     "nanoid": "^5.0.7",
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
-    "@scalar/openapi-types": "0.1.5",
     "@scalar/object-utils": "1.1.12",
-    "@scalar/themes": "0.9.48",
-    "@scalar/types": "0.0.19"
+    "@scalar/openapi-types": "0.1.5",
+    "@scalar/themes": "0.9.50",
+    "@scalar/types": "0.0.20"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
     "vite": "^5.4.10",
     "vitest": "^1.6.0",
-    "zod-to-ts": "^1.2.0",
+    "zod-to-ts": "github:amritk/zod-to-ts#build",
     "@scalar/build-tooling": "0.1.12",
     "@scalar/openapi-parser": "0.8.10",
     "@scalar/openapi-types": "0.1.5"