@frontmcp/guard 0.0.1 → 1.0.0-beta.2

package/esm/index.mjs

@@ -54,35 +54,35 @@ var partitionKeySchema = z.union([
   )
 ]);
 var rateLimitConfigSchema = z.object({
-  maxRequests: z.number().int().positive(),
-  windowMs: z.number().int().positive().optional().default(6e4),
-  partitionBy: partitionKeySchema.optional().default("global")
+  maxRequests: z.number().int().positive().describe("Maximum number of requests allowed within the window."),
+  windowMs: z.number().int().positive().optional().default(6e4).describe("Time window in milliseconds."),
+  partitionBy: partitionKeySchema.optional().default("global").describe("Partition key strategy.")
 });
 var concurrencyConfigSchema = z.object({
-  maxConcurrent: z.number().int().positive(),
-  queueTimeoutMs: z.number().int().nonnegative().optional().default(0),
-  partitionBy: partitionKeySchema.optional().default("global")
+  maxConcurrent: z.number().int().positive().describe("Maximum number of concurrent executions allowed."),
+  queueTimeoutMs: z.number().int().nonnegative().optional().default(0).describe("Maximum time in ms to wait in queue (0 = no wait)."),
+  partitionBy: partitionKeySchema.optional().default("global").describe("Partition key strategy.")
 });
 var timeoutConfigSchema = z.object({
-  executeMs: z.number().int().positive()
+  executeMs: z.number().int().positive().describe("Maximum execution time in milliseconds.")
 });
 var ipFilterConfigSchema = z.object({
-  allowList: z.array(z.string()).optional(),
-  denyList: z.array(z.string()).optional(),
-  defaultAction: z.enum(["allow", "deny"]).optional().default("allow"),
-  trustProxy: z.boolean().optional().default(false),
-  trustedProxyDepth: z.number().int().positive().optional().default(1)
+  allowList: z.array(z.string()).optional().describe("IP addresses or CIDR ranges to always allow."),
+  denyList: z.array(z.string()).optional().describe("IP addresses or CIDR ranges to always block."),
+  defaultAction: z.enum(["allow", "deny"]).optional().default("allow").describe("Default action when IP matches neither list."),
+  trustProxy: z.boolean().optional().default(false).describe("Trust X-Forwarded-For header."),
+  trustedProxyDepth: z.number().int().positive().optional().default(1).describe("Max number of proxies to trust from X-Forwarded-For.")
 });
 var guardConfigSchema = z.object({
-  enabled: z.boolean(),
-  storage: z.looseObject({}).optional(),
-  keyPrefix: z.string().optional().default("mcp:guard:"),
-  global: rateLimitConfigSchema.optional(),
-  globalConcurrency: concurrencyConfigSchema.optional(),
-  defaultRateLimit: rateLimitConfigSchema.optional(),
-  defaultConcurrency: concurrencyConfigSchema.optional(),
-  defaultTimeout: timeoutConfigSchema.optional(),
-  ipFilter: ipFilterConfigSchema.optional()
+  enabled: z.boolean().describe("Whether the guard system is enabled."),
+  storage: z.looseObject({}).optional().describe("Storage backend configuration."),
+  keyPrefix: z.string().optional().default("mcp:guard:").describe("Key prefix for all storage keys."),
+  global: rateLimitConfigSchema.optional().describe("Global rate limit applied to all requests."),
+  globalConcurrency: concurrencyConfigSchema.optional().describe("Global concurrency limit."),
+  defaultRateLimit: rateLimitConfigSchema.optional().describe("Default rate limit for entities without explicit config."),
+  defaultConcurrency: concurrencyConfigSchema.optional().describe("Default concurrency for entities without explicit config."),
+  defaultTimeout: timeoutConfigSchema.optional().describe("Default timeout for entity execution."),
+  ipFilter: ipFilterConfigSchema.optional().describe("IP filtering configuration.")
 });
 
 // libs/guard/src/partition-key/partition-key.resolver.ts

package/esm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontmcp/guard",
-  "version": "1.0.0",
+  "version": "1.0.0-beta.2",
   "description": "Rate limiting, concurrency control, timeout, IP filtering, and traffic guard utilities for FrontMCP",
   "author": "AgentFront <info@agentfront.dev>",
   "license": "Apache-2.0",
@@ -48,7 +48,7 @@
     "node": ">=22.0.0"
   },
   "dependencies": {
-    "@frontmcp/utils": "1.0.0"
+    "@frontmcp/utils": "1.0.0-beta.2"
   },
   "peerDependencies": {
     "zod": "^4.0.0"

package/index.js

@@ -99,35 +99,35 @@ var partitionKeySchema = import_zod.z.union([
   )
 ]);
 var rateLimitConfigSchema = import_zod.z.object({
-  maxRequests: import_zod.z.number().int().positive(),
-  windowMs: import_zod.z.number().int().positive().optional().default(6e4),
-  partitionBy: partitionKeySchema.optional().default("global")
+  maxRequests: import_zod.z.number().int().positive().describe("Maximum number of requests allowed within the window."),
+  windowMs: import_zod.z.number().int().positive().optional().default(6e4).describe("Time window in milliseconds."),
+  partitionBy: partitionKeySchema.optional().default("global").describe("Partition key strategy.")
 });
 var concurrencyConfigSchema = import_zod.z.object({
-  maxConcurrent: import_zod.z.number().int().positive(),
-  queueTimeoutMs: import_zod.z.number().int().nonnegative().optional().default(0),
-  partitionBy: partitionKeySchema.optional().default("global")
+  maxConcurrent: import_zod.z.number().int().positive().describe("Maximum number of concurrent executions allowed."),
+  queueTimeoutMs: import_zod.z.number().int().nonnegative().optional().default(0).describe("Maximum time in ms to wait in queue (0 = no wait)."),
+  partitionBy: partitionKeySchema.optional().default("global").describe("Partition key strategy.")
 });
 var timeoutConfigSchema = import_zod.z.object({
-  executeMs: import_zod.z.number().int().positive()
+  executeMs: import_zod.z.number().int().positive().describe("Maximum execution time in milliseconds.")
 });
 var ipFilterConfigSchema = import_zod.z.object({
-  allowList: import_zod.z.array(import_zod.z.string()).optional(),
-  denyList: import_zod.z.array(import_zod.z.string()).optional(),
-  defaultAction: import_zod.z.enum(["allow", "deny"]).optional().default("allow"),
-  trustProxy: import_zod.z.boolean().optional().default(false),
-  trustedProxyDepth: import_zod.z.number().int().positive().optional().default(1)
+  allowList: import_zod.z.array(import_zod.z.string()).optional().describe("IP addresses or CIDR ranges to always allow."),
+  denyList: import_zod.z.array(import_zod.z.string()).optional().describe("IP addresses or CIDR ranges to always block."),
+  defaultAction: import_zod.z.enum(["allow", "deny"]).optional().default("allow").describe("Default action when IP matches neither list."),
+  trustProxy: import_zod.z.boolean().optional().default(false).describe("Trust X-Forwarded-For header."),
+  trustedProxyDepth: import_zod.z.number().int().positive().optional().default(1).describe("Max number of proxies to trust from X-Forwarded-For.")
 });
 var guardConfigSchema = import_zod.z.object({
-  enabled: import_zod.z.boolean(),
-  storage: import_zod.z.looseObject({}).optional(),
-  keyPrefix: import_zod.z.string().optional().default("mcp:guard:"),
-  global: rateLimitConfigSchema.optional(),
-  globalConcurrency: concurrencyConfigSchema.optional(),
-  defaultRateLimit: rateLimitConfigSchema.optional(),
-  defaultConcurrency: concurrencyConfigSchema.optional(),
-  defaultTimeout: timeoutConfigSchema.optional(),
-  ipFilter: ipFilterConfigSchema.optional()
+  enabled: import_zod.z.boolean().describe("Whether the guard system is enabled."),
+  storage: import_zod.z.looseObject({}).optional().describe("Storage backend configuration."),
+  keyPrefix: import_zod.z.string().optional().default("mcp:guard:").describe("Key prefix for all storage keys."),
+  global: rateLimitConfigSchema.optional().describe("Global rate limit applied to all requests."),
+  globalConcurrency: concurrencyConfigSchema.optional().describe("Global concurrency limit."),
+  defaultRateLimit: rateLimitConfigSchema.optional().describe("Default rate limit for entities without explicit config."),
+  defaultConcurrency: concurrencyConfigSchema.optional().describe("Default concurrency for entities without explicit config."),
+  defaultTimeout: timeoutConfigSchema.optional().describe("Default timeout for entity execution."),
+  ipFilter: ipFilterConfigSchema.optional().describe("IP filtering configuration.")
 });
 
 // libs/guard/src/partition-key/partition-key.resolver.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontmcp/guard",
-  "version": "0.0.1",
+  "version": "1.0.0-beta.2",
   "description": "Rate limiting, concurrency control, timeout, IP filtering, and traffic guard utilities for FrontMCP",
   "author": "AgentFront <info@agentfront.dev>",
   "license": "Apache-2.0",
@@ -48,7 +48,7 @@
     "node": ">=22.0.0"
   },
   "dependencies": {
-    "@frontmcp/utils": "1.0.0"
+    "@frontmcp/utils": "1.0.0-beta.2"
   },
   "peerDependencies": {
     "zod": "^4.0.0"

package/schemas/index.d.ts

@@ -1 +1,2 @@
 export { partitionKeySchema, rateLimitConfigSchema, concurrencyConfigSchema, timeoutConfigSchema, ipFilterConfigSchema, guardConfigSchema, } from './schemas';
+export type { ConcurrencyConfigInput, RateLimitConfigInput, TimeoutConfigInput, IpFilterConfigInput, GuardConfigInput, } from './schemas.generated';

package/schemas/schemas.generated.d.ts

@@ -0,0 +1,102 @@
+import type { PartitionKey } from '../partition-key/types';
+/**
+ * Input type for concurrency control configuration.
+ * All fields are optional for IDE autocomplete; required fields
+ * are validated at runtime by concurrencyConfigSchema.
+ */
+export interface ConcurrencyConfigInput {
+    /** Maximum number of concurrent executions allowed. */
+    maxConcurrent?: number;
+    /**
+     * Maximum time in ms to wait in queue (0 = no wait).
+     * @default 0
+     */
+    queueTimeoutMs?: number;
+    /**
+     * Partition key strategy.
+     * @default "global"
+     */
+    partitionBy?: PartitionKey;
+}
+/**
+ * Input type for rate limiting configuration.
+ * All fields are optional for IDE autocomplete; required fields
+ * are validated at runtime by rateLimitConfigSchema.
+ */
+export interface RateLimitConfigInput {
+    /** Maximum number of requests allowed within the window. */
+    maxRequests?: number;
+    /**
+     * Time window in milliseconds.
+     * @default 60000
+     */
+    windowMs?: number;
+    /**
+     * Partition key strategy.
+     * @default "global"
+     */
+    partitionBy?: PartitionKey;
+}
+/**
+ * Input type for timeout configuration.
+ * All fields are optional for IDE autocomplete; required fields
+ * are validated at runtime by timeoutConfigSchema.
+ */
+export interface TimeoutConfigInput {
+    /** Maximum execution time in milliseconds. */
+    executeMs?: number;
+}
+/**
+ * Input type for IP filtering configuration.
+ * All fields are optional for IDE autocomplete; required fields
+ * are validated at runtime by ipFilterConfigSchema.
+ */
+export interface IpFilterConfigInput {
+    /** IP addresses or CIDR ranges to always allow. */
+    allowList?: Array<string>;
+    /** IP addresses or CIDR ranges to always block. */
+    denyList?: Array<string>;
+    /**
+     * Default action when IP matches neither list.
+     * @default "allow"
+     */
+    defaultAction?: "allow" | "deny";
+    /**
+     * Trust X-Forwarded-For header.
+     * @default false
+     */
+    trustProxy?: boolean;
+    /**
+     * Max number of proxies to trust from X-Forwarded-For.
+     * @default 1
+     */
+    trustedProxyDepth?: number;
+}
+/**
+ * Input type for guard system configuration.
+ * All fields are optional for IDE autocomplete; required fields
+ * are validated at runtime by guardConfigSchema.
+ */
+export interface GuardConfigInput {
+    /** Whether the guard system is enabled. */
+    enabled?: boolean;
+    /** Storage backend configuration. */
+    storage?: Record<string, unknown>;
+    /**
+     * Key prefix for all storage keys.
+     * @default "mcp:guard:"
+     */
+    keyPrefix?: string;
+    /** Global rate limit applied to all requests. */
+    global?: RateLimitConfigInput;
+    /** Global concurrency limit. */
+    globalConcurrency?: ConcurrencyConfigInput;
+    /** Default rate limit for entities without explicit config. */
+    defaultRateLimit?: RateLimitConfigInput;
+    /** Default concurrency for entities without explicit config. */
+    defaultConcurrency?: ConcurrencyConfigInput;
+    /** Default timeout for entity execution. */
+    defaultTimeout?: TimeoutConfigInput;
+    /** IP filtering configuration. */
+    ipFilter?: IpFilterConfigInput;
+}