@scalar/oas-utils 0.2.77 → 0.2.79

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scalar/oas-utils
 
+## 0.2.79
+
+### Patch Changes
+
+- 6dd7eda: fix: catch errors for invalid OpenAPI documents
+- Updated dependencies [1b06f64]
+  - @scalar/themes@0.9.50
+
+## 0.2.78
+
+### Patch Changes
+
+- daa2663: feat: split out the router based computed values from the store into its own store
+- 37abd4f: feat: make security spec compliant + migrations
+- Updated dependencies [d379b81]
+- Updated dependencies [f67c3bc]
+  - @scalar/themes@0.9.49
+  - @scalar/types@0.0.20
+
 ## 0.2.77
 
 ### Patch Changes

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

@@ -237,91 +237,6 @@ export declare const extendedCollectionSchema: z.ZodObject<{
     tags: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
     /** List of requests without tags and top level tag "folders" */
     children: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
-    /**
-     * Map of security schemas to their value sets
-     *
-     * For each selected security schema we should have an entry here
-     * The entry will contain the secret values (but not the schema definition)
-     */
-    auth: z.ZodDefault<z.ZodRecord<z.ZodDefault<z.ZodOptional<z.ZodString>>, z.ZodUnion<[z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"apiKey">>;
-        name: z.ZodDefault<z.ZodString>;
-        value: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "apiKey";
-        value: string;
-        name: string;
-    }, {
-        type?: "apiKey" | undefined;
-        value?: string | undefined;
-        name?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"http">>;
-        username: z.ZodDefault<z.ZodString>;
-        password: z.ZodDefault<z.ZodString>;
-        token: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "http";
-        username: string;
-        password: string;
-        token: string;
-    }, {
-        type?: "http" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-implicit">>;
-        token: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-implicit";
-        token: string;
-    }, {
-        type?: "oauth-implicit" | undefined;
-        token?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-password">>;
-        token: z.ZodDefault<z.ZodString>;
-        username: z.ZodDefault<z.ZodString>;
-        password: z.ZodDefault<z.ZodString>;
-        clientSecret: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-password";
-        username: string;
-        password: string;
-        token: string;
-        clientSecret: string;
-    }, {
-        type?: "oauth-password" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-clientCredentials">>;
-        token: z.ZodDefault<z.ZodString>;
-        clientSecret: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-clientCredentials";
-        token: string;
-        clientSecret: string;
-    }, {
-        type?: "oauth-clientCredentials" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-authorizationCode">>;
-        token: z.ZodDefault<z.ZodString>;
-        clientSecret: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-authorizationCode";
-        token: string;
-        clientSecret: string;
-    }, {
-        type?: "oauth-authorizationCode" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }>]>>>;
     /** A link to where this document is stored, useful for live sync and possibly git sync down the line */
     documentUrl: z.ZodOptional<z.ZodString>;
     /**
@@ -347,33 +262,6 @@ export declare const extendedCollectionSchema: z.ZodObject<{
     servers: string[];
     requests: string[];
     tags: string[];
-    auth: Record<string, {
-        type: "apiKey";
-        value: string;
-        name: string;
-    } | {
-        type: "http";
-        username: string;
-        password: string;
-        token: string;
-    } | {
-        type: "oauth-implicit";
-        token: string;
-    } | {
-        type: "oauth-password";
-        username: string;
-        password: string;
-        token: string;
-        clientSecret: string;
-    } | {
-        type: "oauth-clientCredentials";
-        token: string;
-        clientSecret: string;
-    } | {
-        type: "oauth-authorizationCode";
-        token: string;
-        clientSecret: string;
-    }>;
     watchMode: boolean;
     watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
     documentUrl?: string | undefined;
@@ -387,33 +275,6 @@ export declare const extendedCollectionSchema: z.ZodObject<{
     servers?: (string | undefined)[] | undefined;
     requests?: (string | undefined)[] | undefined;
     tags?: (string | undefined)[] | undefined;
-    auth?: Record<string | undefined, {
-        type?: "apiKey" | undefined;
-        value?: string | undefined;
-        name?: string | undefined;
-    } | {
-        type?: "http" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-    } | {
-        type?: "oauth-implicit" | undefined;
-        token?: string | undefined;
-    } | {
-        type?: "oauth-password" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    } | {
-        type?: "oauth-clientCredentials" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    } | {
-        type?: "oauth-authorizationCode" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }> | undefined;
     documentUrl?: string | undefined;
     watchMode?: boolean | undefined;
     integration?: string | null | undefined;
@@ -572,91 +433,6 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     tags: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
     /** List of requests without tags and top level tag "folders" */
     children: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
-    /**
-     * Map of security schemas to their value sets
-     *
-     * For each selected security schema we should have an entry here
-     * The entry will contain the secret values (but not the schema definition)
-     */
-    auth: z.ZodDefault<z.ZodRecord<z.ZodDefault<z.ZodOptional<z.ZodString>>, z.ZodUnion<[z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"apiKey">>;
-        name: z.ZodDefault<z.ZodString>;
-        value: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "apiKey";
-        value: string;
-        name: string;
-    }, {
-        type?: "apiKey" | undefined;
-        value?: string | undefined;
-        name?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"http">>;
-        username: z.ZodDefault<z.ZodString>;
-        password: z.ZodDefault<z.ZodString>;
-        token: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "http";
-        username: string;
-        password: string;
-        token: string;
-    }, {
-        type?: "http" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-implicit">>;
-        token: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-implicit";
-        token: string;
-    }, {
-        type?: "oauth-implicit" | undefined;
-        token?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-password">>;
-        token: z.ZodDefault<z.ZodString>;
-        username: z.ZodDefault<z.ZodString>;
-        password: z.ZodDefault<z.ZodString>;
-        clientSecret: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-password";
-        username: string;
-        password: string;
-        token: string;
-        clientSecret: string;
-    }, {
-        type?: "oauth-password" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-clientCredentials">>;
-        token: z.ZodDefault<z.ZodString>;
-        clientSecret: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-clientCredentials";
-        token: string;
-        clientSecret: string;
-    }, {
-        type?: "oauth-clientCredentials" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodDefault<z.ZodLiteral<"oauth-authorizationCode">>;
-        token: z.ZodDefault<z.ZodString>;
-        clientSecret: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "oauth-authorizationCode";
-        token: string;
-        clientSecret: string;
-    }, {
-        type?: "oauth-authorizationCode" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }>]>>>;
     /** A link to where this document is stored, useful for live sync and possibly git sync down the line */
     documentUrl: z.ZodOptional<z.ZodString>;
     /**
@@ -686,33 +462,6 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     servers: string[];
     requests: string[];
     tags: string[];
-    auth: Record<string, {
-        type: "apiKey";
-        value: string;
-        name: string;
-    } | {
-        type: "http";
-        username: string;
-        password: string;
-        token: string;
-    } | {
-        type: "oauth-implicit";
-        token: string;
-    } | {
-        type: "oauth-password";
-        username: string;
-        password: string;
-        token: string;
-        clientSecret: string;
-    } | {
-        type: "oauth-clientCredentials";
-        token: string;
-        clientSecret: string;
-    } | {
-        type: "oauth-authorizationCode";
-        token: string;
-        clientSecret: string;
-    }>;
     watchMode: boolean;
     watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
     externalDocs?: {
@@ -804,33 +553,6 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     servers?: (string | undefined)[] | undefined;
     requests?: (string | undefined)[] | undefined;
     tags?: (string | undefined)[] | undefined;
-    auth?: Record<string | undefined, {
-        type?: "apiKey" | undefined;
-        value?: string | undefined;
-        name?: string | undefined;
-    } | {
-        type?: "http" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-    } | {
-        type?: "oauth-implicit" | undefined;
-        token?: string | undefined;
-    } | {
-        type?: "oauth-password" | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    } | {
-        type?: "oauth-clientCredentials" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    } | {
-        type?: "oauth-authorizationCode" | undefined;
-        token?: string | undefined;
-        clientSecret?: string | undefined;
-    }> | undefined;
     documentUrl?: string | undefined;
     watchMode?: boolean | undefined;
     integration?: string | null | undefined;

package/dist/entities/spec/collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,mBAAmB;IAC9B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWhD,CAAA;AAEF,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKH,CAAA;AAEF,eAAO,MAAM,gBAAgB;IAvF3B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAehD,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASJ,CAAA;AACD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,mBAAmB;IAC9B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWhD,CAAA;AAEF,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKH,CAAA;AAEF,eAAO,MAAM,gBAAgB;IAhF3B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAehD,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE,wGAAwG;;IAExG;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASJ,CAAA;AACD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}

package/dist/entities/spec/collection.js

@@ -1,7 +1,7 @@
-import { oasSecurityRequirementSchema, securitySchemeExampleValueSchema } from './security.js';
 import { xScalarEnvironmentsSchema } from './x-scalar-environments.js';
 import { xScalarSecretsSchema } from './x-scalar-secrets.js';
 import { z } from 'zod';
+import { oasSecurityRequirementSchema } from './security.js';
 import { oasInfoSchema, oasExternalDocumentationSchema } from './spec-objects.js';
 import { nanoidSchema } from '../shared/utility.js';
 
@@ -64,13 +64,6 @@ const extendedCollectionSchema = z.object({
     tags: nanoidSchema.array().default([]),
     /** List of requests without tags and top level tag "folders" */
     children: nanoidSchema.array().default([]),
-    /**
-     * Map of security schemas to their value sets
-     *
-     * For each selected security schema we should have an entry here
-     * The entry will contain the secret values (but not the schema definition)
-     */
-    auth: z.record(nanoidSchema, securitySchemeExampleValueSchema).default({}),
     /** A link to where this document is stored, useful for live sync and possibly git sync down the line */
     documentUrl: z.string().optional(),
     /**

package/dist/entities/spec/index.js

@@ -4,4 +4,4 @@ export { oasRequestSchema, requestMethods, requestSchema } from './requests.js';
 export { convertExampleToXScalar, createExampleFromRequest, createParamInstance, exampleBodyMime, exampleRequestBodyEncoding, exampleRequestBodySchema, requestExampleParametersSchema, requestExampleSchema, xScalarExampleBodySchema, xScalarExampleSchema, xScalarFileValueSchema, xScalarFormDataValue } from './request-examples.js';
 export { oasContactSchema, oasExternalDocumentationSchema, oasInfoSchema, oasLicenseSchema, oasTagSchema, tagSchema, xScalarNestedSchema } from './spec-objects.js';
 export { oasParameterSchema, parameterStyleSchema, parameterTypeSchema } from './parameters.js';
-export { authExampleFromSchema, oasOauthFlowSchema, oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeExampleValueSchema, securitySchemeSchema } from './security.js';
+export { oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeSchema } from './security.js';

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

@@ -505,7 +505,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
     selectedServerUid: string;
     servers: string[];
     examples: string[];
-    method: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace";
+    method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
     description?: string | undefined;
     summary?: string | undefined;
     externalDocs?: {
@@ -551,7 +551,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
     deprecated?: boolean | undefined;
     examples?: (string | undefined)[] | undefined;
     operationId?: string | undefined;
-    method?: "options" | "delete" | "get" | "connect" | "head" | "patch" | "post" | "put" | "trace" | undefined;
+    method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
     parameters?: {
         name: string;
         in: "path" | "query" | "header" | "cookie";