@scalar/oas-utils 0.2.102 → 0.2.104

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

@@ -16,9 +16,7 @@ export declare const parseSchema: (spec: string | UnknownObject, { shouldLoad }?
     errors: import("@scalar/openapi-parser").ErrorObject[];
 }>;
 /** Converts selected security requirements to uids */
-export declare const getSelectedSecuritySchemeUids: (securityRequirements: SelectedSecuritySchemeUids, authentication: {
-    preferredSecurityScheme?: string | null;
-} | undefined, securitySchemeMap: Record<string, string>) => SelectedSecuritySchemeUids;
+export declare const getSelectedSecuritySchemeUids: (securityRequirements: SelectedSecuritySchemeUids, authentication: ReferenceConfiguration["authentication"] | undefined, securitySchemeMap: Record<string, string>) => SelectedSecuritySchemeUids;
 export type ImportSpecToWorkspaceArgs = Pick<CollectionPayload, 'documentUrl' | 'watchMode'> & Pick<ReferenceConfiguration, 'authentication' | 'baseServerURL' | 'servers'> & {
     /** Sets the preferred security scheme on the collection instead of the requests */
     setCollectionSecurity?: boolean;

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,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAA;AAC3E,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;AAWjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAChB,MAAM,GAAG,aAAa;;;IAuC1B;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,0BAA0B,kBAChC;IAAE,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAAG,SAAS,qBACpD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACxC,0BAYF,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;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,UAAU,EACV,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,WAAW,CAAC,QAAQ,CAAA;IAC5B,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,CAmUA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAM,GACpE,MAAM,EAAE,CA4CV"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAA;AAC3E,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;AAWjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAChB,MAAM,GAAG,aAAa;;;IAuC1B;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,0BAA0B,kBAChC,sBAAsB,CAAC,gBAAgB,CAAC,GAAG,SAAS,qBACjD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACxC,0BAgCF,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;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,UAAU,EACV,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,WAAW,CAAC,QAAQ,CAAA;IAC5B,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,CA6UA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAM,GACpE,MAAM,EAAE,CA8CV"}

package/dist/transforms/import-spec.js

@@ -9,7 +9,7 @@ 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';
-import { concatenateUrlAndPath } from '../helpers/concatenateUrlAndPath.js';
+import { combineUrlAndPath } from '../helpers/merge-urls.js';
 
 /** Takes a string or object and parses it into an openapi spec compliant schema */
 const parseSchema = async (spec, { shouldLoad = true } = {}) => {
@@ -52,14 +52,31 @@ const parseSchema = async (spec, { shouldLoad = true } = {}) => {
 };
 /** Converts selected security requirements to uids */
 const getSelectedSecuritySchemeUids = (securityRequirements, authentication, securitySchemeMap) => {
-    const name = authentication?.preferredSecurityScheme &&
-        securityRequirements.includes(authentication.preferredSecurityScheme)
-        ? authentication.preferredSecurityScheme
-        : securityRequirements[0];
-    const uids = Array.isArray(name)
+    // Filter the preferred security schemes to only include the ones that are in the security requirements
+    const preferredSecurityNames = [
+        authentication?.preferredSecurityScheme ?? [],
+    ]
+        .flat()
+        .filter((name) => {
+        // Match up complex security requirements, array to array
+        if (Array.isArray(name)) {
+            // We match every element in the array
+            return securityRequirements.some((r) => Array.isArray(r) &&
+                r.length === name.length &&
+                r.every((v, i) => v === name[i]));
+        }
+        else
+            return securityRequirements.includes(name);
+    });
+    // Set the first security requirement if no preferred security schemes are set
+    if (!preferredSecurityNames.length && securityRequirements[0]) {
+        preferredSecurityNames.push(securityRequirements[0]);
+    }
+    // Map names to uids
+    const uids = preferredSecurityNames.map((name) => Array.isArray(name)
         ? name.map((k) => securitySchemeMap[k])
-        : securitySchemeMap[name];
-    return [uids];
+        : securitySchemeMap[name]);
+    return uids;
 };
 /**
  * Imports an OpenAPI document and converts it to workspace entities (Collection, Request, Server, etc.)
@@ -87,6 +104,13 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     const servers = getServersFromOpenApiDocument(configuredServers || schema.servers, {
         baseServerURL,
     });
+    // Fallback to the current window.location.origin if no servers are provided
+    if (!servers.length) {
+        const fallbackUrl = getFallbackUrl();
+        if (fallbackUrl) {
+            servers.push(serverSchema.parse({ url: fallbackUrl }));
+        }
+    }
     /**
      * List of all tag strings. For non compliant specs we may need to
      * add top level tag objects for missing tag objects
@@ -196,6 +220,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
                 ...operationWithoutSecurity,
                 method,
                 path: pathString,
+                security: operationSecurity,
                 selectedSecuritySchemeUids,
                 // Merge path and operation level parameters
                 parameters: [
@@ -338,12 +363,13 @@ function getServersFromOpenApiDocument(servers, { baseServerURL } = {}) {
             if (parsedSchema?.url?.startsWith('/')) {
                 // Use the base server URL (if provided)
                 if (baseServerURL) {
-                    parsedSchema.url = concatenateUrlAndPath(baseServerURL?.replace(/\/$/, ''), parsedSchema.url.replace(/^\//, ''));
+                    parsedSchema.url = combineUrlAndPath(baseServerURL, parsedSchema.url);
                     return parsedSchema;
                 }
                 // Fallback to the current window origin
-                if (typeof window?.location?.origin === 'string') {
-                    parsedSchema.url = concatenateUrlAndPath(window.location.origin, parsedSchema.url.replace(/^\//, ''));
+                const fallbackUrl = getFallbackUrl();
+                if (fallbackUrl) {
+                    parsedSchema.url = combineUrlAndPath(fallbackUrl, parsedSchema.url.replace(/^\//, ''));
                     return parsedSchema;
                 }
             }
@@ -360,5 +386,17 @@ function getServersFromOpenApiDocument(servers, { baseServerURL } = {}) {
     })
         .filter(isDefined);
 }
+/**
+ * Fallback to the current window.location.origin, if available
+ */
+function getFallbackUrl() {
+    if (typeof window === 'undefined') {
+        return undefined;
+    }
+    if (typeof window?.location?.origin !== 'string') {
+        return undefined;
+    }
+    return window.location.origin;
+}
 
 export { getSelectedSecuritySchemeUids, getServersFromOpenApiDocument, importSpecToWorkspace, parseSchema };

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.102",
+  "version": "0.2.104",
   "engines": {
     "node": ">=18"
   },
@@ -127,9 +127,9 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.12",
-    "@scalar/themes": "0.9.64",
     "@scalar/openapi-types": "0.1.7",
-    "@scalar/types": "0.0.30"
+    "@scalar/themes": "0.9.66",
+    "@scalar/types": "0.0.32"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
@@ -137,15 +137,13 @@
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
     "@scalar/build-tooling": "0.1.12",
-    "@scalar/openapi-parser": "0.10.4",
-    "@scalar/openapi-types": "0.1.7"
+    "@scalar/openapi-types": "0.1.7",
+    "@scalar/openapi-parser": "0.10.6"
   },
   "scripts": {
     "build": "scalar-build-rollup",
-    "dev": "vite",
     "lint:check": "eslint .",
     "lint:fix": "eslint .  --fix",
-    "preview": "vite preview",
     "test": "vitest",
     "test:unit": "vitest .",
     "typegen:migration": "vite-node ./src/migrations/generate-types.ts",

package/dist/helpers/concatenateUrlAndPath.d.ts

@@ -1,5 +0,0 @@
-/**
- * Make sure the URL and path are concatenated correctly.
- */
-export declare const concatenateUrlAndPath: (url: string, path?: string) => string;
-//# sourceMappingURL=concatenateUrlAndPath.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"concatenateUrlAndPath.d.ts","sourceRoot":"","sources":["../../src/helpers/concatenateUrlAndPath.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,qBAAqB,QAAS,MAAM,SAAS,MAAM,WAc/D,CAAA"}

package/dist/helpers/concatenateUrlAndPath.js

@@ -1,17 +0,0 @@
-/**
- * Make sure the URL and path are concatenated correctly.
- */
-const concatenateUrlAndPath = (url, path) => {
-    if (typeof path !== 'string' || !path.length) {
-        return url;
-    }
-    const trimmedUrl = url.trim();
-    const trimmedPath = path.trim();
-    const urlWithSlash = trimmedUrl.endsWith('/') ? trimmedUrl : `${trimmedUrl}/`;
-    const pathWithoutSlash = trimmedPath.startsWith('/')
-        ? trimmedPath.slice(1)
-        : trimmedPath;
-    return [urlWithSlash, pathWithoutSlash].join('');
-};
-
-export { concatenateUrlAndPath };