@scalar/oas-utils 0.2.17 → 0.2.19

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

@@ -4,9 +4,7 @@ import { z } from 'zod';
 import type { RequestExample } from './request-examples.js';
 /** A single set of populated values for a sent request */
 export type ResponseInstance = AxiosResponse & {
-    /**
-     * Time in ms the request took
-     */
+    /** Time in ms the request took */
     duration: number;
 };
 /** A single request/response set to save to the history stack */
@@ -71,6 +69,10 @@ declare const requestSchema: z.ZodObject<{
      * security requirement ({}) can be included in the array.
      */
     security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>;
+    /** Security schemes which have been created specifically for this request */
+    securitySchemeUids: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>>;
+    /** The currently selected security schemes at the request level */
+    selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
     /**
      * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the
      * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the
@@ -98,6 +100,8 @@ declare const requestSchema: z.ZodObject<{
         isExternal: boolean;
         collectionRef?: string | undefined;
     } | null;
+    securitySchemeUids: string[];
+    selectedSecuritySchemeUids: string[];
     history: any[];
     description?: string | undefined;
     summary?: string | undefined;
@@ -125,6 +129,8 @@ declare const requestSchema: z.ZodObject<{
         collectionRef?: string | undefined;
     } | null | undefined;
     operationId?: string | undefined;
+    securitySchemeUids?: (string | undefined)[] | undefined;
+    selectedSecuritySchemeUids?: (string | undefined)[] | undefined;
     requestBody?: any;
     history?: any[] | undefined;
 }>;
@@ -157,6 +163,8 @@ export declare const createRequest: (payload: RequestPayload) => {
         isExternal: boolean;
         collectionRef?: string | undefined;
     } | null;
+    securitySchemeUids: string[];
+    selectedSecuritySchemeUids: string[];
     history: any[];
     description?: string | undefined;
     summary?: string | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/requests.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB,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;AAQD,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;IAQjB;;;OAGG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;;;;;;;;;;;;;;;;;IAUH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IAC3D,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AAED,4BAA4B;AAC5B,eAAO,MAAM,aAAa,YAAa,cAAc;;;;;;;;;;;;;;;;;;;;;;;CACR,CAAA"}
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/requests.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;CACjB,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;AAQD,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;IAQjB;;;OAGG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;;;;;;;;;;;;;;;;;IAUH;;;;;;OAMG;;IAEH,6EAA6E;;IAE7E,mEAAmE;;IAEnE;;;;;OAKG;;IAEH,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IACpD,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,GAAG;IAC3D,YAAY,CAAC,EAAE,WAAW,CAAC,2BAA2B,CAAA;CACvD,CAAA;AAED,4BAA4B;AAC5B,eAAO,MAAM,aAAa,YAAa,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;CACR,CAAA"}

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

@@ -46,6 +46,10 @@ const requestSchema = z.object({
      * security requirement ({}) can be included in the array.
      */
     security: z.array(securityRequirement).optional(),
+    /** Security schemes which have been created specifically for this request */
+    securitySchemeUids: z.array(nanoidSchema).optional().default([]),
+    /** The currently selected security schemes at the request level */
+    selectedSecuritySchemeUids: z.array(nanoidSchema).default([]),
     /**
      * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the
      * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the

package/dist/helpers/index.d.ts

@@ -16,4 +16,5 @@ export * from './replaceVariables.js';
 export * from './schema-model.js';
 export * from './ssrState.js';
 export * from './string.js';
+export * from './isValidUrl.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,2BAA2B,CAAA;AACzC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,2BAA2B,CAAA;AACzC,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA"}

package/dist/helpers/index.js

@@ -16,3 +16,4 @@ export { replaceVariables } from './replaceVariables.js';
 export { schemaModel } from './schema-model.js';
 export { defaultStateFactory, ssrState } from './ssrState.js';
 export { camelToTitleWords, capitalize } from './string.js';
+export { isValidUrl } from './isValidUrl.js';

package/dist/helpers/isValidUrl.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Checks if a given string is a valid URL.
+ *
+ * @param {string} url - The string to be validated as a URL.
+ * @returns {boolean} Returns true if the string is a valid URL, false otherwise.
+ *
+ * @example
+ * isValidUrl('https://www.example.com'); // returns true
+ * isValidUrl('not a url'); // returns false
+ */
+export declare function isValidUrl(url: string): boolean;
+//# sourceMappingURL=isValidUrl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isValidUrl.d.ts","sourceRoot":"","sources":["../../src/helpers/isValidUrl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,WAMrC"}

package/dist/helpers/isValidUrl.js

@@ -0,0 +1,20 @@
+/**
+ * Checks if a given string is a valid URL.
+ *
+ * @param {string} url - The string to be validated as a URL.
+ * @returns {boolean} Returns true if the string is a valid URL, false otherwise.
+ *
+ * @example
+ * isValidUrl('https://www.example.com'); // returns true
+ * isValidUrl('not a url'); // returns false
+ */
+function isValidUrl(url) {
+    try {
+        return Boolean(new URL(url));
+    }
+    catch {
+        return false;
+    }
+}
+
+export { isValidUrl };

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

@@ -17,8 +17,8 @@ export declare const importSpecToWorkspace: (spec: string | AnyObject) => Promis
         url: string;
         description?: string | undefined;
         variables?: Record<string, {
-            default: string;
             uid: string;
+            default: string;
             value?: string | undefined;
             description?: string | undefined;
             enum?: string[] | undefined;
@@ -61,10 +61,7 @@ export declare const importSpecToWorkspace: (spec: string | AnyObject) => Promis
                 } | undefined;
             } | undefined;
         };
-        selectedSecuritySchemes: {
-            uid: string;
-            flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
-        }[];
+        securitySchemeDict: Record<string, string>;
         selectedServerUid: string;
         childUids: string[];
     };

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":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,2BAA2B,CAAA;AAKvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAWxC,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,SAAgB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0LnE,CAAA"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,2BAA2B,CAAA;AAIvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAWxC,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,SAAgB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmKnE,CAAA"}

package/dist/transforms/import-spec.js

@@ -1,5 +1,4 @@
 import { tagObjectSchema } from '../entities/workspace/spec/spec.js';
-import { parseJsonOrYaml } from '../helpers/parse.js';
 import { schemaModel } from '../helpers/schema-model.js';
 import { load, dereference } from '@scalar/openapi-parser';
 import { createRequest } from '../entities/workspace/spec/requests.js';
@@ -17,10 +16,9 @@ const PARAM_DICTIONARY = {
 const importSpecToWorkspace = async (spec) => {
     const importWarnings = [];
     const requests = [];
-    const parsedSpec = parseJsonOrYaml(spec);
     // TODO: `parsedSpec` can have circular reference and will break.
     // We always have to use the original document.
-    const { filesystem } = await load(parsedSpec);
+    const { filesystem } = await load(spec);
     const { schema, errors } = await dereference(filesystem);
     if (errors?.length || !schema) {
         console.warn('Please open an issue on https://github.com/scalar/scalar\n', 'Scalar OpenAPI Parser Warning:\n', errors);
@@ -110,8 +108,8 @@ const importSpecToWorkspace = async (spec) => {
         folders.push(folder);
     });
     // Toss in a default server if there aren't any
-    const unparsedServers = parsedSpec.servers?.length
-        ? parsedSpec.servers
+    const unparsedServers = schema?.servers?.length
+        ? schema.servers
         : [
             {
                 url: typeof window !== 'undefined'
@@ -121,17 +119,6 @@ const importSpecToWorkspace = async (spec) => {
             },
         ];
     const servers = unparsedServers.map((server) => createServer(server));
-    // Select initial security
-    const firstSecurityKey = Object.keys((schema?.components?.securitySchemes || schema?.securityDefinitions) ?? {})?.[0];
-    const firstScheme = (schema?.components?.securitySchemes ||
-        schema?.securityDefinitions)?.[firstSecurityKey ?? ''];
-    // In the case of oauth2 we need to select the flow as well
-    const flowKey = firstScheme?.type === 'oauth2'
-        ? Object.keys(firstScheme.flows ?? {})[0]
-        : undefined;
-    const selectedSecuritySchemes = firstSecurityKey
-        ? [{ uid: firstSecurityKey, ...(flowKey ? { flowKey } : {}) }]
-        : [];
     const collection = createCollection({
         spec: {
             openapi: schema?.openapi,
@@ -141,7 +128,6 @@ const importSpecToWorkspace = async (spec) => {
             serverUids: servers.map(({ uid }) => uid),
             tags,
         },
-        selectedSecuritySchemes,
         selectedServerUid: servers[0].uid,
         // We default to having all the requests in the root folder
         childUids: folders.map(({ uid }) => uid),

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.17",
+  "version": "0.2.19",
   "engines": {
     "node": ">=18"
   },