@scalar/oas-utils 0.2.137 → 0.2.138

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/oas-utils
 
+## 0.2.138
+
+### Patch Changes
+
+- 5d24800: feat: add a few security scheme helpers
+
 ## 0.2.137
 
 ### Patch Changes

package/dist/helpers/security/get-schemes.d.ts

@@ -0,0 +1,82 @@
+import type { SecurityScheme } from '@scalar/types/entities';
+import type { Operation } from '../../entities/spec/operation.ts';
+/** Parses a list of selected security scheme uids which may be an array or single uid and returns a flattened array of security schemes */
+export declare const getSchemes: (selectedSecuritySchemes: Operation["selectedSecuritySchemeUids"], securitySchemes: Record<SecurityScheme["uid"], SecurityScheme>) => NonNullable<{
+    name: string;
+    value: string;
+    type: "apiKey";
+    uid: string & import("zod").BRAND<"securityScheme">;
+    nameKey: string;
+    in: "cookie" | "query" | "header";
+    description?: string | undefined;
+} | {
+    type: "http";
+    uid: string & import("zod").BRAND<"securityScheme">;
+    nameKey: string;
+    scheme: "basic" | "bearer";
+    bearerFormat: string;
+    username: string;
+    password: string;
+    token: string;
+    description?: string | undefined;
+} | {
+    type: "openIdConnect";
+    uid: string & import("zod").BRAND<"securityScheme">;
+    nameKey: string;
+    openIdConnectUrl: string;
+    description?: string | undefined;
+} | {
+    type: "oauth2";
+    uid: string & import("zod").BRAND<"securityScheme">;
+    nameKey: string;
+    flows: {
+        password?: {
+            type: "password";
+            username: string;
+            password: string;
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            "x-scalar-client-id": string;
+            tokenUrl: string;
+            clientSecret: string;
+        } | undefined;
+        implicit?: {
+            type: "implicit";
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            "x-scalar-client-id": string;
+            authorizationUrl: string;
+            "x-scalar-redirect-uri": string;
+        } | undefined;
+        clientCredentials?: {
+            type: "clientCredentials";
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            "x-scalar-client-id": string;
+            tokenUrl: string;
+            clientSecret: string;
+        } | undefined;
+        authorizationCode?: {
+            type: "authorizationCode";
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            "x-scalar-client-id": string;
+            authorizationUrl: string;
+            "x-scalar-redirect-uri": string;
+            tokenUrl: string;
+            clientSecret: string;
+            "x-usePkce": "SHA-256" | "plain" | "no";
+        } | undefined;
+    };
+    description?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
+}>[];
+//# sourceMappingURL=get-schemes.d.ts.map

package/dist/helpers/security/get-schemes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-schemes.d.ts","sourceRoot":"","sources":["../../../src/helpers/security/get-schemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAE5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAG7D,2IAA2I;AAC3I,eAAO,MAAM,UAAU,4BACI,SAAS,CAAC,4BAA4B,CAAC,mBAC/C,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAOyr3D,CAAC;;;;;;;;;;;;gBAA4X,CAAC;;;;;;;;;;yBAA4V,CAAC;;;;;;;;;;yBAAkV,CAAC;;;;;;;;;;;;;;;;IADty5D,CAAA"}

package/dist/helpers/security/get-schemes.js

@@ -0,0 +1,11 @@
+import { isDefined } from '../is-defined.js';
+
+/** Parses a list of selected security scheme uids which may be an array or single uid and returns a flattened array of security schemes */
+const getSchemes = (selectedSecuritySchemes, securitySchemes) => {
+    const uids = new Set(selectedSecuritySchemes.flat());
+    return Array.from(uids)
+        .map((uid) => securitySchemes[uid])
+        .filter(isDefined);
+};
+
+export { getSchemes };

package/dist/helpers/security/has-token.d.ts

@@ -0,0 +1,4 @@
+import type { SecurityScheme } from '@scalar/types/entities';
+/** Pass in a security scheme and it will return true if it has a token or value depending on the scheme type */
+export declare const hasToken: (scheme: SecurityScheme) => Boolean;
+//# sourceMappingURL=has-token.d.ts.map

package/dist/helpers/security/has-token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-token.d.ts","sourceRoot":"","sources":["../../../src/helpers/security/has-token.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAE5D,gHAAgH;AAChH,eAAO,MAAM,QAAQ,WAAY,cAAc,KAAG,OAwBjD,CAAA"}

package/dist/helpers/security/has-token.js

@@ -0,0 +1,21 @@
+/** Pass in a security scheme and it will return true if it has a token or value depending on the scheme type */
+const hasToken = (scheme) => {
+    // ApiKey
+    if (scheme.type === 'apiKey') {
+        return Boolean(scheme.value);
+    }
+    // Http
+    if (scheme.type === 'http') {
+        return Boolean((scheme.scheme === 'bearer' && scheme.token) || (scheme.scheme === 'basic' && scheme.username && scheme.password));
+    }
+    // OAuth2 just check for A token
+    if (scheme.type === 'oauth2') {
+        return Boolean(scheme.flows.authorizationCode?.token ||
+            scheme.flows.clientCredentials?.token ||
+            scheme.flows.password?.token ||
+            scheme.flows.implicit?.token);
+    }
+    return false;
+};
+
+export { hasToken };

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

@@ -0,0 +1,3 @@
+export { getSchemes } from './get-schemes.ts';
+export { hasToken } from './has-token.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/helpers/security/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/helpers/security/index.js

@@ -0,0 +1,2 @@
+export { getSchemes } from './get-schemes.js';
+export { hasToken } from './has-token.js';

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.137",
+  "version": "0.2.138",
   "engines": {
     "node": ">=18"
   },
@@ -58,6 +58,11 @@
       "types": "./dist/helpers/index.d.ts",
       "default": "./dist/helpers/index.js"
     },
+    "./helpers/security": {
+      "import": "./dist/helpers/security/index.js",
+      "types": "./dist/helpers/security/index.d.ts",
+      "default": "./dist/helpers/security/index.js"
+    },
     "./migrations": {
       "import": "./dist/migrations/index.js",
       "types": "./dist/migrations/index.d.ts",
@@ -86,11 +91,11 @@
     "nanoid": "^5.1.5",
     "type-fest": "^4.20.0",
     "yaml": "^2.4.5",
-    "zod": "^3.23.8",
+    "zod": "3.24.1",
+    "@scalar/object-utils": "1.1.13",
     "@scalar/openapi-types": "0.2.1",
-    "@scalar/types": "0.1.12",
     "@scalar/themes": "0.10.4",
-    "@scalar/object-utils": "1.1.13"
+    "@scalar/types": "0.1.12"
   },
   "devDependencies": {
     "@types/node": "^20.17.10",
@@ -98,9 +103,9 @@
     "vite": "^5.4.10",
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
+    "@scalar/openapi-types": "0.2.1",
     "@scalar/build-tooling": "0.1.18",
-    "@scalar/openapi-parser": "0.10.16",
-    "@scalar/openapi-types": "0.2.1"
+    "@scalar/openapi-parser": "0.10.16"
   },
   "scripts": {
     "build": "scalar-build-rollup",