@frontmcp/sdk 0.6.0 → 0.6.2

package/common/types/options/auth/auth.schema.d.ts

@@ -0,0 +1,284 @@
+import { z } from 'zod';
+/**
+ * Main auth options schema - discriminated by 'mode'
+ *
+ * Uses z.union because we have nested discriminators (orchestrated has 'type')
+ */
+export declare const authOptionsSchema: z.ZodUnion<readonly [z.ZodObject<{
+    mode: z.ZodLiteral<"public">;
+    issuer: z.ZodOptional<z.ZodString>;
+    sessionTtl: z.ZodDefault<z.ZodNumber>;
+    anonymousScopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    publicAccess: z.ZodOptional<z.ZodObject<{
+        tools: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        prompts: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        rateLimit: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    jwks: z.ZodOptional<z.ZodObject<{
+        keys: z.ZodArray<z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>>;
+    }, z.core.$strip>>;
+    signKey: z.ZodOptional<z.ZodUnion<[z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>, z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>]>>;
+    transport: z.ZodOptional<z.ZodObject<{
+        enableLegacySSE: z.ZodDefault<z.ZodBoolean>;
+        enableSseListener: z.ZodDefault<z.ZodBoolean>;
+        enableStreamableHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatelessHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatefulHttp: z.ZodDefault<z.ZodBoolean>;
+        requireSessionForStreamable: z.ZodDefault<z.ZodBoolean>;
+        recreation: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            redis: z.ZodOptional<z.ZodObject<{
+                host: z.ZodString;
+                port: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                password: z.ZodOptional<z.ZodString>;
+                db: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                tls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+                keyPrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+                defaultTtlMs: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            }, z.core.$strip>>;
+            defaultTtlMs: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    mode: z.ZodLiteral<"transparent">;
+    remote: z.ZodObject<{
+        provider: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodString>;
+        jwks: z.ZodOptional<z.ZodObject<{
+            keys: z.ZodArray<z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>>;
+        }, z.core.$strip>>;
+        jwksUri: z.ZodOptional<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodString>;
+        clientSecret: z.ZodOptional<z.ZodString>;
+        scopes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        dcrEnabled: z.ZodDefault<z.ZodBoolean>;
+        authEndpoint: z.ZodOptional<z.ZodString>;
+        tokenEndpoint: z.ZodOptional<z.ZodString>;
+        registrationEndpoint: z.ZodOptional<z.ZodString>;
+        userInfoEndpoint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    expectedAudience: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    requiredScopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    allowAnonymous: z.ZodDefault<z.ZodBoolean>;
+    anonymousScopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    publicAccess: z.ZodOptional<z.ZodObject<{
+        tools: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        prompts: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        rateLimit: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    transport: z.ZodOptional<z.ZodObject<{
+        enableLegacySSE: z.ZodDefault<z.ZodBoolean>;
+        enableSseListener: z.ZodDefault<z.ZodBoolean>;
+        enableStreamableHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatelessHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatefulHttp: z.ZodDefault<z.ZodBoolean>;
+        requireSessionForStreamable: z.ZodDefault<z.ZodBoolean>;
+        recreation: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            redis: z.ZodOptional<z.ZodObject<{
+                host: z.ZodString;
+                port: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                password: z.ZodOptional<z.ZodString>;
+                db: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                tls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+                keyPrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+                defaultTtlMs: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            }, z.core.$strip>>;
+            defaultTtlMs: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    local: z.ZodOptional<z.ZodObject<{
+        signKey: z.ZodOptional<z.ZodUnion<[z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>, z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>]>>;
+        jwks: z.ZodOptional<z.ZodObject<{
+            keys: z.ZodArray<z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>>;
+        }, z.core.$strip>>;
+        issuer: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    tokenStorage: z.ZodDefault<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"memory">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"redis">;
+        config: z.ZodObject<{
+            host: z.ZodString;
+            port: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            password: z.ZodOptional<z.ZodString>;
+            db: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            tls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            keyPrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            defaultTtlMs: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">>;
+    sessionMode: z.ZodDefault<z.ZodEnum<{
+        stateful: "stateful";
+        stateless: "stateless";
+    }>>;
+    allowDefaultPublic: z.ZodDefault<z.ZodBoolean>;
+    anonymousScopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    publicAccess: z.ZodOptional<z.ZodObject<{
+        tools: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        prompts: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        rateLimit: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    consent: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        groupByApp: z.ZodDefault<z.ZodBoolean>;
+        showDescriptions: z.ZodDefault<z.ZodBoolean>;
+        allowSelectAll: z.ZodDefault<z.ZodBoolean>;
+        requireSelection: z.ZodDefault<z.ZodBoolean>;
+        customMessage: z.ZodOptional<z.ZodString>;
+        rememberConsent: z.ZodDefault<z.ZodBoolean>;
+        excludedTools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        defaultSelectedTools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+    refresh: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        skewSeconds: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    expectedAudience: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    incrementalAuth: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        skippedAppBehavior: z.ZodDefault<z.ZodEnum<{
+            anonymous: "anonymous";
+            "require-auth": "require-auth";
+        }>>;
+        allowSkip: z.ZodDefault<z.ZodBoolean>;
+        showAllAppsAtOnce: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    transport: z.ZodOptional<z.ZodObject<{
+        enableLegacySSE: z.ZodDefault<z.ZodBoolean>;
+        enableSseListener: z.ZodDefault<z.ZodBoolean>;
+        enableStreamableHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatelessHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatefulHttp: z.ZodDefault<z.ZodBoolean>;
+        requireSessionForStreamable: z.ZodDefault<z.ZodBoolean>;
+        recreation: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            redis: z.ZodOptional<z.ZodObject<{
+                host: z.ZodString;
+                port: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                password: z.ZodOptional<z.ZodString>;
+                db: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                tls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+                keyPrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+                defaultTtlMs: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            }, z.core.$strip>>;
+            defaultTtlMs: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    mode: z.ZodLiteral<"orchestrated">;
+    type: z.ZodLiteral<"local">;
+}, z.core.$strip>, z.ZodObject<{
+    local: z.ZodOptional<z.ZodObject<{
+        signKey: z.ZodOptional<z.ZodUnion<[z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>, z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>]>>;
+        jwks: z.ZodOptional<z.ZodObject<{
+            keys: z.ZodArray<z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>>;
+        }, z.core.$strip>>;
+        issuer: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    tokenStorage: z.ZodDefault<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"memory">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"redis">;
+        config: z.ZodObject<{
+            host: z.ZodString;
+            port: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            password: z.ZodOptional<z.ZodString>;
+            db: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            tls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            keyPrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+            defaultTtlMs: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>], "type">>;
+    sessionMode: z.ZodDefault<z.ZodEnum<{
+        stateful: "stateful";
+        stateless: "stateless";
+    }>>;
+    allowDefaultPublic: z.ZodDefault<z.ZodBoolean>;
+    anonymousScopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    publicAccess: z.ZodOptional<z.ZodObject<{
+        tools: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        prompts: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>>;
+        rateLimit: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    consent: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        groupByApp: z.ZodDefault<z.ZodBoolean>;
+        showDescriptions: z.ZodDefault<z.ZodBoolean>;
+        allowSelectAll: z.ZodDefault<z.ZodBoolean>;
+        requireSelection: z.ZodDefault<z.ZodBoolean>;
+        customMessage: z.ZodOptional<z.ZodString>;
+        rememberConsent: z.ZodDefault<z.ZodBoolean>;
+        excludedTools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        defaultSelectedTools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+    refresh: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        skewSeconds: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    expectedAudience: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    incrementalAuth: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        skippedAppBehavior: z.ZodDefault<z.ZodEnum<{
+            anonymous: "anonymous";
+            "require-auth": "require-auth";
+        }>>;
+        allowSkip: z.ZodDefault<z.ZodBoolean>;
+        showAllAppsAtOnce: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    transport: z.ZodOptional<z.ZodObject<{
+        enableLegacySSE: z.ZodDefault<z.ZodBoolean>;
+        enableSseListener: z.ZodDefault<z.ZodBoolean>;
+        enableStreamableHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatelessHttp: z.ZodDefault<z.ZodBoolean>;
+        enableStatefulHttp: z.ZodDefault<z.ZodBoolean>;
+        requireSessionForStreamable: z.ZodDefault<z.ZodBoolean>;
+        recreation: z.ZodOptional<z.ZodLazy<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            redis: z.ZodOptional<z.ZodObject<{
+                host: z.ZodString;
+                port: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                password: z.ZodOptional<z.ZodString>;
+                db: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+                tls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+                keyPrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+                defaultTtlMs: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+            }, z.core.$strip>>;
+            defaultTtlMs: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    mode: z.ZodLiteral<"orchestrated">;
+    type: z.ZodLiteral<"remote">;
+    remote: z.ZodObject<{
+        provider: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodString>;
+        jwks: z.ZodOptional<z.ZodObject<{
+            keys: z.ZodArray<z.ZodType<import("@frontmcp/sdk").JWK, unknown, z.core.$ZodTypeInternals<import("@frontmcp/sdk").JWK, unknown>>>;
+        }, z.core.$strip>>;
+        jwksUri: z.ZodOptional<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodString>;
+        clientSecret: z.ZodOptional<z.ZodString>;
+        scopes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        dcrEnabled: z.ZodDefault<z.ZodBoolean>;
+        authEndpoint: z.ZodOptional<z.ZodString>;
+        tokenEndpoint: z.ZodOptional<z.ZodString>;
+        registrationEndpoint: z.ZodOptional<z.ZodString>;
+        userInfoEndpoint: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>]>;
+/**
+ * Auth options (output type with defaults applied)
+ * Use this type when working with parsed/validated options
+ */
+export type AuthOptions = z.infer<typeof authOptionsSchema>;
+/**
+ * Auth options input (input type for user configuration)
+ * Use this type for the @frontmcp configuration
+ */
+export type AuthOptionsInput = z.input<typeof authOptionsSchema>;
+/**
+ * Authentication mode
+ */
+export type AuthMode = 'public' | 'transparent' | 'orchestrated';

package/common/types/options/auth/auth.utils.d.ts

@@ -0,0 +1,32 @@
+import { AuthOptions, AuthOptionsInput } from './auth.schema';
+import { PublicAuthOptions } from './public.schema';
+import { TransparentAuthOptions } from './transparent.schema';
+import { OrchestratedAuthOptions, OrchestratedLocalOptions, OrchestratedRemoteOptions } from './orchestrated.schema';
+/**
+ * Parse and validate auth options with defaults
+ */
+export declare function parseAuthOptions(input: AuthOptionsInput): AuthOptions;
+/**
+ * Check if options are public mode
+ */
+export declare function isPublicMode(options: AuthOptions | AuthOptionsInput): options is PublicAuthOptions;
+/**
+ * Check if options are transparent mode
+ */
+export declare function isTransparentMode(options: AuthOptions | AuthOptionsInput): options is TransparentAuthOptions;
+/**
+ * Check if options are orchestrated mode
+ */
+export declare function isOrchestratedMode(options: AuthOptions | AuthOptionsInput): options is OrchestratedAuthOptions;
+/**
+ * Check if orchestrated options are local type
+ */
+export declare function isOrchestratedLocal(options: OrchestratedAuthOptions): options is OrchestratedLocalOptions;
+/**
+ * Check if orchestrated options are remote type
+ */
+export declare function isOrchestratedRemote(options: OrchestratedAuthOptions): options is OrchestratedRemoteOptions;
+/**
+ * Check if options allow public/anonymous access
+ */
+export declare function allowsPublicAccess(options: AuthOptions): boolean;

package/common/types/options/auth/index.d.ts

@@ -0,0 +1,16 @@
+export type { PublicAccessConfig, LocalSigningConfig, RemoteProviderConfig, TokenStorageConfig, TokenStorageMemory, TokenStorageRedis, TokenRefreshConfig, SkippedAppBehavior, ConsentConfig, IncrementalAuthConfig, TransportRecreationConfig, TransportConfig, PublicAuthOptionsInterface, TransparentAuthOptionsInterface, OrchestratedLocalOptionsInterface, OrchestratedRemoteOptionsInterface, OrchestratedAuthOptionsInterface, AuthOptionsInterface, AuthMode, OrchestratedType, } from './auth.interfaces';
+export { publicAccessConfigSchema, localSigningConfigSchema, remoteProviderConfigSchema, tokenStorageConfigSchema, tokenRefreshConfigSchema, skippedAppBehaviorSchema, consentConfigSchema, incrementalAuthConfigSchema, } from './shared.schemas';
+export type { PublicAccessConfig as PublicAccessConfigZod, PublicAccessConfigInput, LocalSigningConfig as LocalSigningConfigZod, LocalSigningConfigInput, RemoteProviderConfig as RemoteProviderConfigZod, RemoteProviderConfigInput, TokenStorageConfig as TokenStorageConfigZod, TokenStorageConfigInput, TokenRefreshConfig as TokenRefreshConfigZod, TokenRefreshConfigInput, SkippedAppBehavior as SkippedAppBehaviorZod, ConsentConfig as ConsentConfigZod, ConsentConfigInput, IncrementalAuthConfig as IncrementalAuthConfigZod, IncrementalAuthConfigInput, RedisConfig, } from './shared.schemas';
+export { publicAuthOptionsSchema } from './public.schema';
+export type { PublicAuthOptions, PublicAuthOptionsInput } from './public.schema';
+export { transparentAuthOptionsSchema } from './transparent.schema';
+export type { TransparentAuthOptions, TransparentAuthOptionsInput } from './transparent.schema';
+export { orchestratedLocalSchema, orchestratedRemoteSchema, orchestratedAuthOptionsSchema, } from './orchestrated.schema';
+export type { OrchestratedLocalOptions, OrchestratedLocalOptionsInput, OrchestratedRemoteOptions, OrchestratedRemoteOptionsInput, OrchestratedAuthOptions, OrchestratedAuthOptionsInput, OrchestratedType as OrchestratedTypeZod, } from './orchestrated.schema';
+export { authOptionsSchema } from './auth.schema';
+export type { AuthOptions, AuthOptionsInput, AuthMode as AuthModeZod } from './auth.schema';
+export { appAuthOptionsSchema } from './app-auth.schema';
+export type { AppAuthOptions, AppAuthOptionsInput } from './app-auth.schema';
+export { parseAuthOptions, isPublicMode, isTransparentMode, isOrchestratedMode, isOrchestratedLocal, isOrchestratedRemote, allowsPublicAccess, } from './auth.utils';
+export { transportConfigSchema, transportRecreationConfigSchema, DEFAULT_TRANSPORT_CONFIG, } from './transport.deprecated';
+export type { TransportConfig as TransportConfigZod, TransportConfigInput, TransportRecreationConfig as TransportRecreationConfigZod, TransportRecreationConfigInput, } from './transport.deprecated';