@fjall/generator 0.88.4 → 0.89.4

package/dist/src/schemas/patternSchemas.js

@@ -0,0 +1,294 @@
+import { z } from "zod";
+import { VALIDATION_MESSAGES } from "../validation/patterns.js";
+import { BackupRetentionSchema, MonitoringIntervalSchema, DatabasePortSchema, ProxyConfigOrFalseSchema, ReadReplicaConfigOrFalseSchema, AuroraWriterConfigSchema, AuroraReadersConfigOrFalseSchema, DatabaseInsightsConfigOrFalseSchema, CredentialsConfigSchema, EncryptionConfigSchema, } from "./databaseSchemas.js";
+import { LambdaMemorySchema } from "./computeSchemas.js";
+// ─── Pattern Lambda configuration ────────────────────────────────────────────
+/**
+ * Pattern Lambda configuration for individual functions.
+ */
+export const PatternLambdaConfigSchema = z
+    .object({
+    /** Memory size in MB. Range: 128-10240. */
+    memorySize: LambdaMemorySchema.optional(),
+    /** Timeout in seconds. Range: 1-900. */
+    timeout: z
+        .number()
+        .int(VALIDATION_MESSAGES.LAMBDA.TIMEOUT.INTEGER)
+        .min(1, VALIDATION_MESSAGES.LAMBDA.TIMEOUT.MIN)
+        .max(900, VALIDATION_MESSAGES.LAMBDA.TIMEOUT.MAX)
+        .optional(),
+    /** Ephemeral storage size in MB. Range: 512-10240. Default: 512. */
+    ephemeralStorageSize: z
+        .number()
+        .int(VALIDATION_MESSAGES.EPHEMERAL_STORAGE.INTEGER)
+        .min(512, VALIDATION_MESSAGES.EPHEMERAL_STORAGE.MIN)
+        .max(10240, VALIDATION_MESSAGES.EPHEMERAL_STORAGE.MAX)
+        .optional(),
+})
+    .strict();
+// ─── Payload database configuration ──────────────────────────────────────────
+/**
+ * Full Payload database configuration for pattern.
+ * Exposes ALL underlying DatabaseFactory props with pattern-specific defaults.
+ */
+export const PayloadDatabaseConfigSchema = z
+    .object({
+    /** Database type: "Instance" (RDS Instance) or "Aurora". Default: "Instance" */
+    type: z.enum(["Instance", "Aurora"]).optional(),
+    /** Database name. Default: derived from pattern name */
+    databaseName: z.string().optional(),
+    /** Database engine. Default: "postgresql" */
+    databaseEngine: z.enum(["postgresql", "mysql"]).optional(),
+    /** Enable deletion protection. Default: true */
+    deletionProtection: z.boolean().optional(),
+    /** Backup retention in days. Default: 7 */
+    backupRetention: BackupRetentionSchema.optional(),
+    /** Database port. Default: engine-specific (5432 for PostgreSQL) */
+    port: DatabasePortSchema.optional(),
+    /** Make database publicly accessible (for local development). Default: false */
+    publiclyAccessible: z.boolean().optional(),
+    /** IP CIDR to allow when publicly accessible */
+    allowedIpCidr: z.string().optional(),
+    /** Instance type for RDS Instance databases (e.g., "t4g.small", "t4g.large") */
+    instanceType: z.string().optional(),
+    /** Allocated storage in GB for RDS Instance. Default: 20 */
+    allocatedStorage: z
+        .number()
+        .int(VALIDATION_MESSAGES.ALLOCATED_STORAGE.INTEGER)
+        .min(20, VALIDATION_MESSAGES.ALLOCATED_STORAGE.MIN)
+        .max(65536, VALIDATION_MESSAGES.ALLOCATED_STORAGE.MAX)
+        .optional(),
+    /** Enable Multi-AZ deployment for high availability. */
+    multiAz: z.boolean().optional(),
+    /** Read replica configuration for RDS Instance. Set to false to explicitly disable. */
+    readReplica: ReadReplicaConfigOrFalseSchema.optional(),
+    /** Aurora writer instance configuration. */
+    writer: AuroraWriterConfigSchema.optional(),
+    /** Aurora reader instances configuration. Set to false to explicitly disable. */
+    readers: AuroraReadersConfigOrFalseSchema.optional(),
+    /** Allow access from VPC CIDR (avoids cross-stack cyclic dependencies). */
+    allowVpcAccess: z.boolean().optional(),
+    /** Enhanced monitoring interval in seconds. */
+    monitoringInterval: MonitoringIntervalSchema.optional(),
+    /** Preferred maintenance window (e.g., "sun:05:00-sun:06:00"). */
+    preferredMaintenanceWindow: z.string().optional(),
+    /** Database Insights configuration. Set to false to explicitly disable. */
+    databaseInsights: DatabaseInsightsConfigOrFalseSchema.optional(),
+    /** RDS Proxy configuration for connection pooling. Set to false to explicitly disable. */
+    proxy: ProxyConfigOrFalseSchema.optional(),
+    /** Credentials configuration (username, rotation). */
+    credentials: CredentialsConfigSchema.optional(),
+    /** Encryption configuration. */
+    encryption: EncryptionConfigSchema.optional(),
+    /** ARN or identifier of snapshot to restore from */
+    snapshotIdentifier: z.string().optional(),
+    /** Username from the snapshot (required when restoring) */
+    snapshotUsername: z.string().optional(),
+})
+    .strict();
+// ─── Payload compute configuration ──────────────────────────────────────────
+/**
+ * Full Payload compute configuration for pattern.
+ * Allows per-function configuration for each Lambda in the pattern.
+ */
+export const PayloadComputeConfigSchema = z
+    .object({
+    /** Server Lambda configuration (handles main application requests). */
+    server: PatternLambdaConfigSchema.optional(),
+    /** Image optimisation Lambda configuration (handles Next.js image optimisation). */
+    imageOptimisation: PatternLambdaConfigSchema.optional(),
+    /** Revalidation Lambda configuration (handles ISR revalidation from SQS queue). */
+    revalidation: PatternLambdaConfigSchema.optional(),
+})
+    .strict();
+// ─── Payload storage configuration ──────────────────────────────────────────
+/**
+ * Pattern storage bucket configuration.
+ */
+export const PatternStorageBucketConfigSchema = z
+    .object({
+    /** Enable versioning. Default: false */
+    versioned: z.boolean().optional(),
+})
+    .strict();
+/**
+ * Full Payload storage configuration for pattern.
+ * Allows per-bucket configuration for each S3 bucket in the pattern.
+ */
+export const PayloadStorageConfigSchema = z
+    .object({
+    /** Assets bucket (static files) */
+    assets: PatternStorageBucketConfigSchema.optional(),
+    /** Cache bucket (ISR cache) */
+    cache: PatternStorageBucketConfigSchema.optional(),
+    /** Media bucket (uploads) */
+    media: PatternStorageBucketConfigSchema.optional(),
+})
+    .strict();
+// ─── Payload messaging configuration ─────────────────────────────────────────
+/**
+ * Pattern queue configuration for messaging.
+ */
+export const PatternQueueConfigSchema = z
+    .object({
+    /** Visibility timeout in seconds. Default: matches revalidation timeout */
+    visibilityTimeout: z
+        .number()
+        .int(VALIDATION_MESSAGES.SQS.VISIBILITY_TIMEOUT.INTEGER)
+        .min(0, VALIDATION_MESSAGES.SQS.VISIBILITY_TIMEOUT.MIN)
+        .max(43200, VALIDATION_MESSAGES.SQS.VISIBILITY_TIMEOUT.MAX)
+        .optional(),
+    /** Message retention period in seconds. Default: 345600 (4 days) */
+    messageRetentionPeriod: z
+        .number()
+        .int(VALIDATION_MESSAGES.SQS.RETENTION_PERIOD.INTEGER)
+        .min(60, VALIDATION_MESSAGES.SQS.RETENTION_PERIOD.MIN)
+        .max(1209600, VALIDATION_MESSAGES.SQS.RETENTION_PERIOD.MAX)
+        .optional(),
+    /** Maximum message size in bytes. Default: 262144 (256 KB) */
+    maxMessageSize: z
+        .number()
+        .int(VALIDATION_MESSAGES.MAX_MESSAGE_SIZE.INTEGER)
+        .min(1024, VALIDATION_MESSAGES.MAX_MESSAGE_SIZE.MIN)
+        .max(262144, VALIDATION_MESSAGES.MAX_MESSAGE_SIZE.MAX)
+        .optional(),
+    /** Dead letter queue configuration. Set to false to explicitly disable. */
+    deadLetterQueue: z
+        .union([
+        z.literal(false),
+        z
+            .object({
+            enabled: z.boolean().optional(),
+            maxReceiveCount: z
+                .number()
+                .int(VALIDATION_MESSAGES.DLQ.MAX_RECEIVE_COUNT.INTEGER)
+                .min(1, VALIDATION_MESSAGES.DLQ.MAX_RECEIVE_COUNT.MIN)
+                .max(1000, VALIDATION_MESSAGES.DLQ.MAX_RECEIVE_COUNT.MAX)
+                .optional(),
+        })
+            .strict(),
+    ])
+        .optional(),
+})
+    .strict();
+/**
+ * Full Payload messaging configuration for pattern.
+ */
+export const PayloadMessagingConfigSchema = z
+    .object({
+    /** Revalidation queue configuration */
+    revalidationQueue: PatternQueueConfigSchema.optional(),
+})
+    .strict();
+// ─── Payload CDN configuration ───────────────────────────────────────────────
+/**
+ * Payload CDN configuration for pattern.
+ */
+export const PayloadCdnConfigSchema = z
+    .object({
+    /** Custom domain names for CloudFront */
+    domainNames: z.array(z.string()).optional(),
+    /** ACM certificate ARN for custom domains (must be in us-east-1) */
+    certificateArn: z.string().optional(),
+})
+    .strict();
+// ─── Pattern config discriminated unions ─────────────────────────────────────
+/**
+ * Payload pattern configuration.
+ */
+export const PayloadPatternConfigSchema = z
+    .object({
+    type: z.literal("payload"),
+    /** Pattern name (used for resource naming) */
+    name: z.string().min(1, VALIDATION_MESSAGES.REQUIRED.PATTERN_NAME),
+    /** Custom domain (auto-creates certificate + DNS) */
+    domain: z.string().optional(),
+    /** Database configuration */
+    database: PayloadDatabaseConfigSchema.optional(),
+    /** Compute (Lambda) configuration */
+    compute: PayloadComputeConfigSchema.optional(),
+    /** Storage (S3) configuration */
+    storage: PayloadStorageConfigSchema.optional(),
+    /** Messaging (SQS) configuration */
+    messaging: PayloadMessagingConfigSchema.optional(),
+    /** CDN (CloudFront) configuration - advanced use, prefer `domain` for simple setup */
+    cdn: PayloadCdnConfigSchema.optional(),
+    /** Additional environment variables for server Lambda */
+    environment: z.record(z.string(), z.string()).optional(),
+})
+    .strict();
+/**
+ * Next.js pattern configuration.
+ * Shares the same OpenNext infrastructure as Payload but without
+ * requiring a database by default (pure Next.js with optional database).
+ */
+export const NextJSPatternConfigSchema = z
+    .object({
+    type: z.literal("nextjs"),
+    /** Pattern name (used for resource naming) */
+    name: z.string().min(1, VALIDATION_MESSAGES.REQUIRED.PATTERN_NAME),
+    /** Custom domain (auto-creates certificate + DNS) */
+    domain: z.string().optional(),
+    /** Database configuration */
+    database: PayloadDatabaseConfigSchema.optional(),
+    /** Compute (Lambda) configuration */
+    compute: PayloadComputeConfigSchema.optional(),
+    /** Storage (S3) configuration */
+    storage: PayloadStorageConfigSchema.optional(),
+    /** Messaging (SQS) configuration */
+    messaging: PayloadMessagingConfigSchema.optional(),
+    /** CDN (CloudFront) configuration - advanced use, prefer `domain` for simple setup */
+    cdn: PayloadCdnConfigSchema.optional(),
+    /** Additional environment variables for server Lambda */
+    environment: z.record(z.string(), z.string()).optional(),
+})
+    .strict();
+/**
+ * Pattern configuration discriminated union.
+ * Extensible for future patterns (Remix, etc.)
+ */
+export const PatternConfigSchema = z.discriminatedUnion("type", [
+    PayloadPatternConfigSchema,
+    NextJSPatternConfigSchema,
+]);
+// ─── Pattern tier / custom pattern schemas ───────────────────────────────────
+/**
+ * Pattern tier schema for OpenNext patterns (Payload, Next.js).
+ * Defines configuration tiers: lightweight, standard, resilient, custom.
+ */
+export const PatternTierSchema = z.enum([
+    "lightweight",
+    "standard",
+    "resilient",
+    "custom",
+]);
+/**
+ * Custom database configuration for patterns.
+ * Used when patternTier is "custom".
+ */
+export const CustomPatternDatabaseSchema = z
+    .object({
+    type: z.enum(["Instance", "Aurora"]),
+    instanceType: z.string().optional(),
+    backupRetention: BackupRetentionSchema.optional(),
+    deletionProtection: z.boolean().optional(),
+    encryption: z
+        .union([z.object({ useCMK: z.literal(true) }).strict(), z.literal(false)])
+        .optional(),
+})
+    .strict();
+/**
+ * Custom compute configuration for patterns.
+ * Used when patternTier is "custom".
+ */
+export const CustomPatternComputeSchema = z
+    .object({
+    memorySize: LambdaMemorySchema.optional(),
+    timeout: z
+        .number()
+        .int(VALIDATION_MESSAGES.LAMBDA.TIMEOUT.INTEGER)
+        .min(1, VALIDATION_MESSAGES.LAMBDA.TIMEOUT.MIN)
+        .max(900, VALIDATION_MESSAGES.LAMBDA.TIMEOUT.MAX)
+        .optional(),
+})
+    .strict();