@fjall/components-infrastructure 0.86.1 → 0.87.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/README.md +3 -3
  2. package/dist/lib/app.d.ts +166 -6
  3. package/dist/lib/app.js +212 -20
  4. package/dist/lib/aspects/resourceInventory.d.ts +4 -4
  5. package/dist/lib/aspects/resourceInventory.js +3 -3
  6. package/dist/lib/config/aws/backupGlobalSettings.js +1 -2
  7. package/dist/lib/config/aws/identityCenter.js +1 -5
  8. package/dist/lib/config/aws/organisation.js +1 -4
  9. package/dist/lib/index.d.ts +1 -0
  10. package/dist/lib/index.js +7 -1
  11. package/dist/lib/patterns/aws/buildkite.js +3 -2
  12. package/dist/lib/patterns/aws/cdn.d.ts +164 -0
  13. package/dist/lib/patterns/aws/cdn.js +264 -0
  14. package/dist/lib/patterns/aws/compute.d.ts +278 -59
  15. package/dist/lib/patterns/aws/compute.js +384 -188
  16. package/dist/lib/patterns/aws/connections.d.ts +46 -0
  17. package/dist/lib/patterns/aws/connections.js +159 -0
  18. package/dist/lib/patterns/aws/database.d.ts +124 -11
  19. package/dist/lib/patterns/aws/database.js +188 -66
  20. package/dist/lib/patterns/aws/hostedZone.js +1 -1
  21. package/dist/lib/patterns/aws/index.d.ts +3 -0
  22. package/dist/lib/patterns/aws/index.js +4 -1
  23. package/dist/lib/patterns/aws/interfaces/compute.d.ts +121 -0
  24. package/dist/lib/patterns/aws/interfaces/compute.js +48 -0
  25. package/dist/lib/patterns/aws/interfaces/connector.d.ts +183 -0
  26. package/dist/lib/patterns/aws/interfaces/connector.js +117 -0
  27. package/dist/lib/patterns/aws/interfaces/database.d.ts +136 -0
  28. package/dist/lib/patterns/aws/interfaces/database.js +65 -0
  29. package/dist/lib/patterns/aws/interfaces/index.d.ts +12 -0
  30. package/dist/lib/patterns/aws/interfaces/index.js +49 -0
  31. package/dist/lib/patterns/aws/interfaces/messaging.d.ts +146 -0
  32. package/dist/lib/patterns/aws/interfaces/messaging.js +56 -0
  33. package/dist/lib/patterns/aws/interfaces/pattern.d.ts +403 -0
  34. package/dist/lib/patterns/aws/interfaces/pattern.js +36 -0
  35. package/dist/lib/patterns/aws/interfaces/storage.d.ts +136 -0
  36. package/dist/lib/patterns/aws/interfaces/storage.js +48 -0
  37. package/dist/lib/patterns/aws/messaging.d.ts +183 -0
  38. package/dist/lib/patterns/aws/messaging.js +239 -0
  39. package/dist/lib/patterns/aws/network.js +4 -4
  40. package/dist/lib/patterns/aws/pattern.d.ts +67 -0
  41. package/dist/lib/patterns/aws/pattern.js +69 -0
  42. package/dist/lib/patterns/aws/payload.d.ts +87 -0
  43. package/dist/lib/patterns/aws/payload.js +526 -0
  44. package/dist/lib/patterns/aws/storage.d.ts +127 -15
  45. package/dist/lib/patterns/aws/storage.js +234 -38
  46. package/dist/lib/resources/aws/backup/backupPlan.js +1 -6
  47. package/dist/lib/resources/aws/backup/backupVault.js +1 -2
  48. package/dist/lib/resources/aws/base/awsStack.d.ts +0 -2
  49. package/dist/lib/resources/aws/base/awsStack.js +1 -7
  50. package/dist/lib/resources/aws/cdn/cloudFront.d.ts +71 -0
  51. package/dist/lib/resources/aws/cdn/cloudFront.js +176 -0
  52. package/dist/lib/resources/aws/cdn/index.d.ts +1 -0
  53. package/dist/lib/resources/aws/cdn/index.js +18 -0
  54. package/dist/lib/resources/aws/compute/ec2.d.ts +5 -0
  55. package/dist/lib/resources/aws/compute/ec2.js +33 -6
  56. package/dist/lib/resources/aws/compute/ecs.d.ts +32 -25
  57. package/dist/lib/resources/aws/compute/ecs.js +31 -115
  58. package/dist/lib/resources/aws/compute/lambda.d.ts +94 -5
  59. package/dist/lib/resources/aws/compute/lambda.js +209 -32
  60. package/dist/lib/resources/aws/database/database.js +1 -1
  61. package/dist/lib/resources/aws/database/dynamodb.d.ts +70 -0
  62. package/dist/lib/resources/aws/database/dynamodb.js +181 -0
  63. package/dist/lib/resources/aws/database/index.d.ts +1 -0
  64. package/dist/lib/resources/aws/database/index.js +2 -1
  65. package/dist/lib/resources/aws/database/migrationLambda.d.ts +80 -0
  66. package/dist/lib/resources/aws/database/migrationLambda.js +119 -0
  67. package/dist/lib/resources/aws/database/rdsAurora.d.ts +15 -0
  68. package/dist/lib/resources/aws/database/rdsAurora.js +41 -18
  69. package/dist/lib/resources/aws/database/rdsAuroraGlobal.js +12 -8
  70. package/dist/lib/resources/aws/database/rdsInstance.js +2 -2
  71. package/dist/lib/resources/aws/index.d.ts +2 -0
  72. package/dist/lib/resources/aws/index.js +3 -1
  73. package/dist/lib/resources/aws/messaging/eventbridge.d.ts +28 -0
  74. package/dist/lib/resources/aws/messaging/eventbridge.js +53 -0
  75. package/dist/lib/resources/aws/messaging/index.d.ts +3 -0
  76. package/dist/lib/resources/aws/messaging/index.js +20 -0
  77. package/dist/lib/resources/aws/messaging/sns.d.ts +35 -0
  78. package/dist/lib/resources/aws/messaging/sns.js +70 -0
  79. package/dist/lib/resources/aws/messaging/sqs.d.ts +105 -0
  80. package/dist/lib/resources/aws/messaging/sqs.js +231 -0
  81. package/dist/lib/resources/aws/messaging/utils.d.ts +3 -0
  82. package/dist/lib/resources/aws/messaging/utils.js +7 -0
  83. package/dist/lib/resources/aws/networking/ipam.js +1 -2
  84. package/dist/lib/resources/aws/networking/ipamPool.js +3 -2
  85. package/dist/lib/resources/aws/networking/vpc.js +1 -2
  86. package/dist/lib/resources/aws/storage/ecr.js +8 -5
  87. package/dist/lib/resources/aws/storage/s3.js +1 -2
  88. package/dist/lib/resources/aws/utilities/awsCustomResource.js +1 -1
  89. package/dist/lib/resources/aws/utilities/customResource.js +1 -1
  90. package/dist/lib/utils/getConfig.js +3 -2
  91. package/dist/lib/utils/index.d.ts +1 -0
  92. package/dist/lib/utils/index.js +2 -1
  93. package/dist/lib/utils/manifestWriter.d.ts +174 -0
  94. package/dist/lib/utils/manifestWriter.js +233 -0
  95. package/dist/lib/utils/standardTagsAspect.js +1 -8
  96. package/dist/lib/utils/validationLogger.d.ts +34 -0
  97. package/dist/lib/utils/validationLogger.js +83 -0
  98. package/package.json +3 -3
  99. package/dist/lib/__tests__/setup.d.ts +0 -48
  100. package/dist/lib/__tests__/setup.js +0 -1
  101. package/dist/lib/patterns/aws/cicdRole.d.ts +0 -67
  102. package/dist/lib/patterns/aws/cicdRole.js +0 -68
  103. package/dist/lib/resources/aws/cicd/cicdRole.d.ts +0 -65
  104. package/dist/lib/resources/aws/cicd/cicdRole.js +0 -191
  105. package/dist/lib/resources/aws/compute/ecsFreeTier.d.ts +0 -75
  106. package/dist/lib/resources/aws/compute/ecsFreeTier.js +0 -1
  107. package/dist/lib/resources/aws/compute/ecsSpot.d.ts +0 -75
  108. package/dist/lib/resources/aws/compute/ecsSpot.js +0 -1
  109. package/dist/lib/resources/aws/compute/utilities/capacityProviderDrainWaiter.d.ts +0 -20
  110. package/dist/lib/resources/aws/compute/utilities/capacityProviderDrainWaiter.js +0 -1
  111. package/dist/lib/resources/aws/utilities/cfnOutput.d.ts +0 -5
  112. package/dist/lib/resources/aws/utilities/cfnOutput.js +0 -1
@@ -0,0 +1,403 @@
1
+ /**
2
+ * Type-safe pattern interfaces.
3
+ *
4
+ * These interfaces provide compile-time type safety for pattern resources.
5
+ * Patterns are high-level constructs that compose multiple infrastructure resources
6
+ * into a cohesive, opinionated deployment (e.g., Payload CMS, Next.js).
7
+ *
8
+ * @example
9
+ * const payload = app.addPattern(PatternFactory.build("PayloadApp", {
10
+ * type: "payload",
11
+ * name: "my-cms",
12
+ * source: "../.."
13
+ * }));
14
+ * payload.getDatabase(); // ✓ Available on IPayload
15
+ * payload.getServer(); // ✓ Available on IPayload
16
+ */
17
+ import { type ICertificate } from "aws-cdk-lib/aws-certificatemanager";
18
+ import { type Duration } from "aws-cdk-lib";
19
+ import { type Construct } from "constructs";
20
+ import { type RelationalDatabase, type DynamoDBDatabase, type ProxyConfig, type ReadReplicaConfig, type CredentialsConfig, type EncryptionConfig, type AuroraEncryptionConfig, type AuroraWriterConfig, type AuroraReadersConfig, type PerformanceInsightsConfig, type PerformanceInsightsRetentionPeriod } from "../database.js";
21
+ import { type LambdaCompute } from "../compute.js";
22
+ import { type PrivateStorage } from "../storage.js";
23
+ import { type QueueMessaging } from "../messaging.js";
24
+ import { type Cdn, type SmartCdnBehaviour } from "../cdn.js";
25
+ export type { ProxyConfig, ReadReplicaConfig, CredentialsConfig, EncryptionConfig, AuroraEncryptionConfig, AuroraWriterConfig, AuroraReadersConfig, PerformanceInsightsConfig, PerformanceInsightsRetentionPeriod };
26
+ /**
27
+ * Full database configuration for patterns.
28
+ * Extends underlying DatabaseFactory props with pattern-specific defaults.
29
+ *
30
+ * @example
31
+ * // Minimal - use defaults
32
+ * database: { type: "Instance" }
33
+ *
34
+ * @example
35
+ * // Production-ready Instance
36
+ * database: {
37
+ * type: "Instance",
38
+ * instanceType: "t4g.large",
39
+ * allocatedStorage: 50,
40
+ * multiAz: true,
41
+ * performanceInsights: { retentionPeriod: 31 },
42
+ * encryption: { storageKey: { useCMK: true } }
43
+ * }
44
+ *
45
+ * @example
46
+ * // Aurora with readers
47
+ * database: {
48
+ * type: "Aurora",
49
+ * readers: { count: 2 },
50
+ * allowVpcAccess: true
51
+ * }
52
+ */
53
+ export interface PayloadDatabaseConfig {
54
+ /** Database type: "Instance" or "Aurora". Default: "Instance" */
55
+ type?: "Instance" | "Aurora";
56
+ /** Database name. Default: derived from pattern name */
57
+ databaseName?: string;
58
+ /** Database engine. Default: "postgresql" */
59
+ databaseEngine?: "postgresql" | "mysql";
60
+ /** Enable deletion protection. Default: true */
61
+ deletionProtection?: boolean;
62
+ /** Backup retention in days (1-35). Default: 7 */
63
+ backupRetention?: number;
64
+ /** Database port. Default: engine-specific (5432 for PostgreSQL) */
65
+ port?: number;
66
+ /** Make database publicly accessible (for local development). Default: false */
67
+ publiclyAccessible?: boolean;
68
+ /** IP CIDR to allow when publicly accessible (e.g., "203.0.113.0/32") */
69
+ allowedIpCidr?: string;
70
+ /**
71
+ * Instance type for RDS Instance databases.
72
+ * Examples: "t4g.micro", "t4g.small", "t4g.large", "r6g.large"
73
+ * Default: "t4g.small"
74
+ * Only applies when type: "Instance"
75
+ */
76
+ instanceType?: string;
77
+ /**
78
+ * Allocated storage in GB for RDS Instance.
79
+ * Default: 20
80
+ * Only applies when type: "Instance"
81
+ */
82
+ allocatedStorage?: number;
83
+ /**
84
+ * Enable Multi-AZ deployment for high availability.
85
+ * Creates a standby replica in a different AZ.
86
+ * Only applies when type: "Instance"
87
+ */
88
+ multiAz?: boolean;
89
+ /**
90
+ * Read replica configuration for RDS Instance.
91
+ * Set to false to explicitly disable.
92
+ * Only applies when type: "Instance"
93
+ */
94
+ readReplica?: ReadReplicaConfig | false;
95
+ /**
96
+ * Aurora writer instance configuration.
97
+ * Only applies when type: "Aurora"
98
+ */
99
+ writer?: AuroraWriterConfig;
100
+ /**
101
+ * Aurora reader instances configuration.
102
+ * Set to false to explicitly disable readers.
103
+ * Only applies when type: "Aurora"
104
+ */
105
+ readers?: AuroraReadersConfig | false;
106
+ /**
107
+ * Allow access from VPC CIDR (avoids cross-stack cyclic dependencies).
108
+ * Only applies when type: "Aurora"
109
+ */
110
+ allowVpcAccess?: boolean;
111
+ /**
112
+ * Enhanced monitoring interval.
113
+ * Only applies when type: "Aurora"
114
+ */
115
+ monitoringInterval?: Duration;
116
+ /**
117
+ * Preferred maintenance window (e.g., "sun:05:00-sun:06:00").
118
+ * Only applies when type: "Aurora"
119
+ */
120
+ preferredMaintenanceWindow?: string;
121
+ /**
122
+ * Performance Insights configuration.
123
+ * Set to false to explicitly disable.
124
+ * @example { retentionPeriod: 31 }
125
+ */
126
+ performanceInsights?: PerformanceInsightsConfig | false;
127
+ /**
128
+ * RDS Proxy configuration for connection pooling.
129
+ * Set to false to explicitly disable.
130
+ * @example { maxConnections: 100 }
131
+ */
132
+ proxy?: ProxyConfig | false;
133
+ /**
134
+ * Credentials configuration (username, rotation).
135
+ */
136
+ credentials?: CredentialsConfig;
137
+ /**
138
+ * Encryption configuration.
139
+ * For Instance: EncryptionConfig
140
+ * For Aurora: AuroraEncryptionConfig
141
+ * @example { storageKey: { useCMK: true } }
142
+ */
143
+ encryption?: EncryptionConfig | AuroraEncryptionConfig;
144
+ /** ARN or identifier of snapshot to restore from */
145
+ snapshotIdentifier?: string;
146
+ /** Username from the snapshot (required when restoring) */
147
+ snapshotUsername?: string;
148
+ }
149
+ /**
150
+ * Lambda function configuration for pattern sub-functions.
151
+ *
152
+ * @example
153
+ * server: { memorySize: 2048, timeout: 60 }
154
+ */
155
+ export interface PatternLambdaConfig {
156
+ /** Memory size in MB. Range: 128-10240. */
157
+ memorySize?: number;
158
+ /** Timeout in seconds. Range: 1-900. */
159
+ timeout?: number;
160
+ /** Ephemeral storage size in MB. Range: 512-10240. Default: 512. */
161
+ ephemeralStorageSize?: number;
162
+ }
163
+ /**
164
+ * Full compute configuration for patterns.
165
+ * Allows per-function configuration for each Lambda in the pattern.
166
+ *
167
+ * @example
168
+ * // Configure individual functions
169
+ * compute: {
170
+ * server: { memorySize: 2048, timeout: 60 },
171
+ * imageOptimisation: { memorySize: 2048 },
172
+ * revalidation: { memorySize: 1024, timeout: 600 }
173
+ * }
174
+ */
175
+ export interface PayloadComputeConfig {
176
+ /**
177
+ * Server Lambda configuration.
178
+ * Handles main application requests.
179
+ * Defaults: memorySize=1536, timeout=30
180
+ */
181
+ server?: PatternLambdaConfig;
182
+ /**
183
+ * Image optimisation Lambda configuration.
184
+ * Handles Next.js image optimization.
185
+ * Defaults: memorySize=1536, timeout=30
186
+ */
187
+ imageOptimisation?: PatternLambdaConfig;
188
+ /**
189
+ * Revalidation Lambda configuration.
190
+ * Handles ISR revalidation from SQS queue.
191
+ * Defaults: memorySize=768, timeout=300
192
+ */
193
+ revalidation?: PatternLambdaConfig;
194
+ }
195
+ /**
196
+ * S3 bucket configuration for pattern sub-buckets.
197
+ */
198
+ export interface PatternStorageBucketConfig {
199
+ /** Enable versioning. Default: false */
200
+ versioned?: boolean;
201
+ }
202
+ /**
203
+ * Full storage configuration for patterns.
204
+ * Allows per-bucket configuration for each S3 bucket in the pattern.
205
+ *
206
+ * @example
207
+ * storage: {
208
+ * assets: { versioned: true },
209
+ * cache: { versioned: false },
210
+ * media: { versioned: true }
211
+ * }
212
+ */
213
+ export interface PayloadStorageConfig {
214
+ /** Assets bucket (static files) */
215
+ assets?: PatternStorageBucketConfig;
216
+ /** Cache bucket (ISR cache) */
217
+ cache?: PatternStorageBucketConfig;
218
+ /** Media bucket (uploads) */
219
+ media?: PatternStorageBucketConfig;
220
+ }
221
+ /**
222
+ * SQS queue configuration for pattern messaging.
223
+ */
224
+ export interface PatternQueueConfig {
225
+ /** Visibility timeout in seconds. Default: matches revalidation timeout */
226
+ visibilityTimeout?: number;
227
+ /** Message retention period in seconds. Default: 345600 (4 days) */
228
+ messageRetentionPeriod?: number;
229
+ /** Maximum message size in bytes. Default: 262144 (256 KB) */
230
+ maxMessageSize?: number;
231
+ /**
232
+ * Dead letter queue configuration.
233
+ * Set to false to explicitly disable.
234
+ */
235
+ deadLetterQueue?: {
236
+ enabled?: boolean;
237
+ maxReceiveCount?: number;
238
+ } | false;
239
+ }
240
+ /**
241
+ * Full messaging configuration for patterns.
242
+ *
243
+ * @example
244
+ * messaging: {
245
+ * revalidationQueue: {
246
+ * visibilityTimeout: 600,
247
+ * deadLetterQueue: { enabled: true, maxReceiveCount: 5 }
248
+ * }
249
+ * }
250
+ */
251
+ export interface PayloadMessagingConfig {
252
+ /** Revalidation queue configuration */
253
+ revalidationQueue?: PatternQueueConfig;
254
+ }
255
+ /**
256
+ * CDN configuration for Payload pattern.
257
+ */
258
+ export interface PayloadCdnConfig {
259
+ /** Custom domain names for CloudFront */
260
+ domainNames?: string[];
261
+ /** ACM certificate for custom domains (must be in us-east-1) */
262
+ certificate?: ICertificate;
263
+ /** ACM certificate ARN (alternative to certificate - must be in us-east-1) */
264
+ certificateArn?: string;
265
+ /** Additional CDN behaviours */
266
+ behaviours?: SmartCdnBehaviour[];
267
+ }
268
+ /**
269
+ * Payload pattern props.
270
+ *
271
+ * Configures a Payload CMS deployment with all required infrastructure:
272
+ * - RDS PostgreSQL database (Aurora or Instance)
273
+ * - S3 buckets (assets, cache, media)
274
+ * - DynamoDB table (tag cache)
275
+ * - SQS FIFO queue (revalidation)
276
+ * - Lambda functions (server, image optimisation, revalidation)
277
+ * - CloudFront distribution
278
+ *
279
+ * @example
280
+ * // Minimal - works out of box
281
+ * app.addPattern(PatternFactory.build("PayloadApp", {
282
+ * type: "payload",
283
+ * name: "my-cms"
284
+ * }));
285
+ *
286
+ * @example
287
+ * // With custom domain (auto-creates certificate + DNS)
288
+ * app.addPattern(PatternFactory.build("PayloadApp", {
289
+ * type: "payload",
290
+ * name: "my-cms",
291
+ * domain: "cms.example.com"
292
+ * }));
293
+ *
294
+ * @example
295
+ * // Customised
296
+ * app.addPattern(PatternFactory.build("PayloadApp", {
297
+ * type: "payload",
298
+ * name: "my-cms",
299
+ * database: {
300
+ * type: "Instance",
301
+ * publiclyAccessible: true
302
+ * },
303
+ * compute: {
304
+ * server: { memorySize: 2048 }
305
+ * }
306
+ * }));
307
+ */
308
+ export interface IPayloadProps {
309
+ /** Pattern type discriminator */
310
+ type: "payload";
311
+ /** Pattern name (used for resource naming) */
312
+ name: string;
313
+ /**
314
+ * Custom domain for the Payload application.
315
+ * When provided, automatically:
316
+ * - Looks up the Route53 hosted zone
317
+ * - Creates an ACM certificate with DNS validation (in us-east-1)
318
+ * - Configures CloudFront with the certificate
319
+ * - Creates an A record (alias) pointing to CloudFront
320
+ *
321
+ * Requires: A Route53 hosted zone for the domain must exist.
322
+ *
323
+ * @example "cms.example.com"
324
+ */
325
+ domain?: string;
326
+ /** Database configuration */
327
+ database?: PayloadDatabaseConfig;
328
+ /** Compute (Lambda) configuration */
329
+ compute?: PayloadComputeConfig;
330
+ /** Storage (S3) configuration */
331
+ storage?: PayloadStorageConfig;
332
+ /** Messaging (SQS) configuration */
333
+ messaging?: PayloadMessagingConfig;
334
+ /** CDN (CloudFront) configuration - for advanced use. Use `domain` for simple setup. */
335
+ cdn?: PayloadCdnConfig;
336
+ /** Additional environment variables for server Lambda */
337
+ environment?: Record<string, string>;
338
+ }
339
+ /**
340
+ * Union of all pattern props.
341
+ * Extend this when adding new patterns (e.g., INextjsProps, IRemixProps).
342
+ */
343
+ export type IPatternProps = IPayloadProps;
344
+ /**
345
+ * Pattern type discriminator.
346
+ */
347
+ export type PatternType = "payload";
348
+ /**
349
+ * Base pattern interface.
350
+ * All patterns implement this interface.
351
+ */
352
+ export interface IPattern {
353
+ /** The type of pattern. Used for runtime type narrowing. */
354
+ readonly patternType: PatternType;
355
+ /** The underlying CDK construct node. */
356
+ readonly node: Construct["node"];
357
+ }
358
+ /**
359
+ * Payload pattern interface.
360
+ * Provides access to all underlying resources for escape hatches.
361
+ *
362
+ * @example
363
+ * // Escape hatches - full access to underlying resources
364
+ * payload.getDatabase().grantConnect(someOtherLambda);
365
+ * payload.getServer().getLambdaFunction().addEnvironment("CUSTOM_VAR", "value");
366
+ * payload.getCdn().getDistribution().addBehavior("/custom/*", customOrigin);
367
+ */
368
+ export interface IPayload extends IPattern {
369
+ readonly patternType: "payload";
370
+ /** Get the PostgreSQL database (Aurora or Instance) */
371
+ getDatabase(): RelationalDatabase;
372
+ /** Get the Server Lambda function */
373
+ getServer(): LambdaCompute;
374
+ /** Get the Image Optimisation Lambda function */
375
+ getImageOptimisation(): LambdaCompute;
376
+ /** Get the Revalidation Lambda function */
377
+ getRevalidation(): LambdaCompute;
378
+ /** Get the Assets S3 bucket (static files) */
379
+ getAssetsBucket(): PrivateStorage;
380
+ /** Get the Cache S3 bucket (ISR cache) */
381
+ getCacheBucket(): PrivateStorage;
382
+ /** Get the Media S3 bucket (uploads) */
383
+ getMediaBucket(): PrivateStorage;
384
+ /** Get the Tag Cache DynamoDB table */
385
+ getTagCache(): DynamoDBDatabase;
386
+ /** Get the Revalidation SQS queue */
387
+ getRevalidationQueue(): QueueMessaging;
388
+ /** Get the CloudFront distribution */
389
+ getCdn(): Cdn;
390
+ }
391
+ /**
392
+ * Union type representing any pattern interface.
393
+ * Use with type guards for generic handling.
394
+ */
395
+ export type AnyPattern = IPayload;
396
+ /**
397
+ * Type guard to check if a pattern is Payload.
398
+ */
399
+ export declare function isPayloadPattern(pattern: IPattern): pattern is IPayload;
400
+ /**
401
+ * Type guard to check if a resource is any pattern type.
402
+ */
403
+ export declare function isPattern(resource: unknown): resource is IPattern;
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ /**
3
+ * Type-safe pattern interfaces.
4
+ *
5
+ * These interfaces provide compile-time type safety for pattern resources.
6
+ * Patterns are high-level constructs that compose multiple infrastructure resources
7
+ * into a cohesive, opinionated deployment (e.g., Payload CMS, Next.js).
8
+ *
9
+ * @example
10
+ * const payload = app.addPattern(PatternFactory.build("PayloadApp", {
11
+ * type: "payload",
12
+ * name: "my-cms",
13
+ * source: "../.."
14
+ * }));
15
+ * payload.getDatabase(); // ✓ Available on IPayload
16
+ * payload.getServer(); // ✓ Available on IPayload
17
+ */
18
+ Object.defineProperty(exports, "__esModule", { value: true });
19
+ exports.isPayloadPattern = isPayloadPattern;
20
+ exports.isPattern = isPattern;
21
+ /**
22
+ * Type guard to check if a pattern is Payload.
23
+ */
24
+ function isPayloadPattern(pattern) {
25
+ return pattern.patternType === "payload";
26
+ }
27
+ /**
28
+ * Type guard to check if a resource is any pattern type.
29
+ */
30
+ function isPattern(resource) {
31
+ return (resource !== null &&
32
+ typeof resource === "object" &&
33
+ "patternType" in resource &&
34
+ typeof resource.patternType === "string");
35
+ }
36
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"pattern.js","sourceRoot":"","sources":["../../../../../lib/patterns/aws/interfaces/pattern.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AA4cH,4CAEC;AAKD,8BAOC;AAjBD;;GAEG;AACH,SAAgB,gBAAgB,CAAC,OAAiB;IAChD,OAAO,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,QAAiB;IACzC,OAAO,CACL,QAAQ,KAAK,IAAI;QACjB,OAAO,QAAQ,KAAK,QAAQ;QAC5B,aAAa,IAAI,QAAQ;QACzB,OAAQ,QAAqB,CAAC,WAAW,KAAK,QAAQ,CACvD,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Type-safe pattern interfaces.\n *\n * These interfaces provide compile-time type safety for pattern resources.\n * Patterns are high-level constructs that compose multiple infrastructure resources\n * into a cohesive, opinionated deployment (e.g., Payload CMS, Next.js).\n *\n * @example\n * const payload = app.addPattern(PatternFactory.build(\"PayloadApp\", {\n *   type: \"payload\",\n *   name: \"my-cms\",\n *   source: \"../..\"\n * }));\n * payload.getDatabase(); // ✓ Available on IPayload\n * payload.getServer(); // ✓ Available on IPayload\n */\n\nimport { type ICertificate } from \"aws-cdk-lib/aws-certificatemanager\";\nimport { type Duration } from \"aws-cdk-lib\";\nimport { type Construct } from \"constructs\";\n\nimport {\n  type RelationalDatabase,\n  type DynamoDBDatabase,\n  type ProxyConfig,\n  type ReadReplicaConfig,\n  type CredentialsConfig,\n  type EncryptionConfig,\n  type AuroraEncryptionConfig,\n  type AuroraWriterConfig,\n  type AuroraReadersConfig,\n  type PerformanceInsightsConfig,\n  type PerformanceInsightsRetentionPeriod\n} from \"../database.js\";\nimport { type LambdaCompute } from \"../compute.js\";\nimport { type PrivateStorage } from \"../storage.js\";\nimport { type QueueMessaging } from \"../messaging.js\";\nimport { type Cdn, type SmartCdnBehaviour } from \"../cdn.js\";\n\n// Re-export database types for consumer convenience\nexport type {\n  ProxyConfig,\n  ReadReplicaConfig,\n  CredentialsConfig,\n  EncryptionConfig,\n  AuroraEncryptionConfig,\n  AuroraWriterConfig,\n  AuroraReadersConfig,\n  PerformanceInsightsConfig,\n  PerformanceInsightsRetentionPeriod\n};\n\n/**\n * Full database configuration for patterns.\n * Extends underlying DatabaseFactory props with pattern-specific defaults.\n *\n * @example\n * // Minimal - use defaults\n * database: { type: \"Instance\" }\n *\n * @example\n * // Production-ready Instance\n * database: {\n *   type: \"Instance\",\n *   instanceType: \"t4g.large\",\n *   allocatedStorage: 50,\n *   multiAz: true,\n *   performanceInsights: { retentionPeriod: 31 },\n *   encryption: { storageKey: { useCMK: true } }\n * }\n *\n * @example\n * // Aurora with readers\n * database: {\n *   type: \"Aurora\",\n *   readers: { count: 2 },\n *   allowVpcAccess: true\n * }\n */\nexport interface PayloadDatabaseConfig {\n  // --- Base Configuration ---\n\n  /** Database type: \"Instance\" or \"Aurora\". Default: \"Instance\" */\n  type?: \"Instance\" | \"Aurora\";\n  /** Database name. Default: derived from pattern name */\n  databaseName?: string;\n  /** Database engine. Default: \"postgresql\" */\n  databaseEngine?: \"postgresql\" | \"mysql\";\n\n  // --- Common Configuration ---\n\n  /** Enable deletion protection. Default: true */\n  deletionProtection?: boolean;\n  /** Backup retention in days (1-35). Default: 7 */\n  backupRetention?: number;\n  /** Database port. Default: engine-specific (5432 for PostgreSQL) */\n  port?: number;\n\n  // --- Public Access (Development Use) ---\n\n  /** Make database publicly accessible (for local development). Default: false */\n  publiclyAccessible?: boolean;\n  /** IP CIDR to allow when publicly accessible (e.g., \"203.0.113.0/32\") */\n  allowedIpCidr?: string;\n\n  // --- Instance-Specific Configuration ---\n\n  /**\n   * Instance type for RDS Instance databases.\n   * Examples: \"t4g.micro\", \"t4g.small\", \"t4g.large\", \"r6g.large\"\n   * Default: \"t4g.small\"\n   * Only applies when type: \"Instance\"\n   */\n  instanceType?: string;\n  /**\n   * Allocated storage in GB for RDS Instance.\n   * Default: 20\n   * Only applies when type: \"Instance\"\n   */\n  allocatedStorage?: number;\n  /**\n   * Enable Multi-AZ deployment for high availability.\n   * Creates a standby replica in a different AZ.\n   * Only applies when type: \"Instance\"\n   */\n  multiAz?: boolean;\n  /**\n   * Read replica configuration for RDS Instance.\n   * Set to false to explicitly disable.\n   * Only applies when type: \"Instance\"\n   */\n  readReplica?: ReadReplicaConfig | false;\n\n  // --- Aurora-Specific Configuration ---\n\n  /**\n   * Aurora writer instance configuration.\n   * Only applies when type: \"Aurora\"\n   */\n  writer?: AuroraWriterConfig;\n  /**\n   * Aurora reader instances configuration.\n   * Set to false to explicitly disable readers.\n   * Only applies when type: \"Aurora\"\n   */\n  readers?: AuroraReadersConfig | false;\n  /**\n   * Allow access from VPC CIDR (avoids cross-stack cyclic dependencies).\n   * Only applies when type: \"Aurora\"\n   */\n  allowVpcAccess?: boolean;\n  /**\n   * Enhanced monitoring interval.\n   * Only applies when type: \"Aurora\"\n   */\n  monitoringInterval?: Duration;\n  /**\n   * Preferred maintenance window (e.g., \"sun:05:00-sun:06:00\").\n   * Only applies when type: \"Aurora\"\n   */\n  preferredMaintenanceWindow?: string;\n\n  // --- Shared Advanced Configuration ---\n\n  /**\n   * Performance Insights configuration.\n   * Set to false to explicitly disable.\n   * @example { retentionPeriod: 31 }\n   */\n  performanceInsights?: PerformanceInsightsConfig | false;\n  /**\n   * RDS Proxy configuration for connection pooling.\n   * Set to false to explicitly disable.\n   * @example { maxConnections: 100 }\n   */\n  proxy?: ProxyConfig | false;\n  /**\n   * Credentials configuration (username, rotation).\n   */\n  credentials?: CredentialsConfig;\n  /**\n   * Encryption configuration.\n   * For Instance: EncryptionConfig\n   * For Aurora: AuroraEncryptionConfig\n   * @example { storageKey: { useCMK: true } }\n   */\n  encryption?: EncryptionConfig | AuroraEncryptionConfig;\n\n  // --- Snapshot Restore ---\n\n  /** ARN or identifier of snapshot to restore from */\n  snapshotIdentifier?: string;\n  /** Username from the snapshot (required when restoring) */\n  snapshotUsername?: string;\n}\n\n/**\n * Lambda function configuration for pattern sub-functions.\n *\n * @example\n * server: { memorySize: 2048, timeout: 60 }\n */\nexport interface PatternLambdaConfig {\n  /** Memory size in MB. Range: 128-10240. */\n  memorySize?: number;\n  /** Timeout in seconds. Range: 1-900. */\n  timeout?: number;\n  /** Ephemeral storage size in MB. Range: 512-10240. Default: 512. */\n  ephemeralStorageSize?: number;\n}\n\n/**\n * Full compute configuration for patterns.\n * Allows per-function configuration for each Lambda in the pattern.\n *\n * @example\n * // Configure individual functions\n * compute: {\n *   server: { memorySize: 2048, timeout: 60 },\n *   imageOptimisation: { memorySize: 2048 },\n *   revalidation: { memorySize: 1024, timeout: 600 }\n * }\n */\nexport interface PayloadComputeConfig {\n  /**\n   * Server Lambda configuration.\n   * Handles main application requests.\n   * Defaults: memorySize=1536, timeout=30\n   */\n  server?: PatternLambdaConfig;\n  /**\n   * Image optimisation Lambda configuration.\n   * Handles Next.js image optimization.\n   * Defaults: memorySize=1536, timeout=30\n   */\n  imageOptimisation?: PatternLambdaConfig;\n  /**\n   * Revalidation Lambda configuration.\n   * Handles ISR revalidation from SQS queue.\n   * Defaults: memorySize=768, timeout=300\n   */\n  revalidation?: PatternLambdaConfig;\n}\n\n/**\n * S3 bucket configuration for pattern sub-buckets.\n */\nexport interface PatternStorageBucketConfig {\n  /** Enable versioning. Default: false */\n  versioned?: boolean;\n}\n\n/**\n * Full storage configuration for patterns.\n * Allows per-bucket configuration for each S3 bucket in the pattern.\n *\n * @example\n * storage: {\n *   assets: { versioned: true },\n *   cache: { versioned: false },\n *   media: { versioned: true }\n * }\n */\nexport interface PayloadStorageConfig {\n  /** Assets bucket (static files) */\n  assets?: PatternStorageBucketConfig;\n  /** Cache bucket (ISR cache) */\n  cache?: PatternStorageBucketConfig;\n  /** Media bucket (uploads) */\n  media?: PatternStorageBucketConfig;\n}\n\n/**\n * SQS queue configuration for pattern messaging.\n */\nexport interface PatternQueueConfig {\n  /** Visibility timeout in seconds. Default: matches revalidation timeout */\n  visibilityTimeout?: number;\n  /** Message retention period in seconds. Default: 345600 (4 days) */\n  messageRetentionPeriod?: number;\n  /** Maximum message size in bytes. Default: 262144 (256 KB) */\n  maxMessageSize?: number;\n  /**\n   * Dead letter queue configuration.\n   * Set to false to explicitly disable.\n   */\n  deadLetterQueue?:\n    | {\n        enabled?: boolean;\n        maxReceiveCount?: number;\n      }\n    | false;\n}\n\n/**\n * Full messaging configuration for patterns.\n *\n * @example\n * messaging: {\n *   revalidationQueue: {\n *     visibilityTimeout: 600,\n *     deadLetterQueue: { enabled: true, maxReceiveCount: 5 }\n *   }\n * }\n */\nexport interface PayloadMessagingConfig {\n  /** Revalidation queue configuration */\n  revalidationQueue?: PatternQueueConfig;\n}\n\n/**\n * CDN configuration for Payload pattern.\n */\nexport interface PayloadCdnConfig {\n  /** Custom domain names for CloudFront */\n  domainNames?: string[];\n  /** ACM certificate for custom domains (must be in us-east-1) */\n  certificate?: ICertificate;\n  /** ACM certificate ARN (alternative to certificate - must be in us-east-1) */\n  certificateArn?: string;\n  /** Additional CDN behaviours */\n  behaviours?: SmartCdnBehaviour[];\n}\n\n/**\n * Payload pattern props.\n *\n * Configures a Payload CMS deployment with all required infrastructure:\n * - RDS PostgreSQL database (Aurora or Instance)\n * - S3 buckets (assets, cache, media)\n * - DynamoDB table (tag cache)\n * - SQS FIFO queue (revalidation)\n * - Lambda functions (server, image optimisation, revalidation)\n * - CloudFront distribution\n *\n * @example\n * // Minimal - works out of box\n * app.addPattern(PatternFactory.build(\"PayloadApp\", {\n *   type: \"payload\",\n *   name: \"my-cms\"\n * }));\n *\n * @example\n * // With custom domain (auto-creates certificate + DNS)\n * app.addPattern(PatternFactory.build(\"PayloadApp\", {\n *   type: \"payload\",\n *   name: \"my-cms\",\n *   domain: \"cms.example.com\"\n * }));\n *\n * @example\n * // Customised\n * app.addPattern(PatternFactory.build(\"PayloadApp\", {\n *   type: \"payload\",\n *   name: \"my-cms\",\n *   database: {\n *     type: \"Instance\",\n *     publiclyAccessible: true\n *   },\n *   compute: {\n *     server: { memorySize: 2048 }\n *   }\n * }));\n */\nexport interface IPayloadProps {\n  /** Pattern type discriminator */\n  type: \"payload\";\n  /** Pattern name (used for resource naming) */\n  name: string;\n\n  /**\n   * Custom domain for the Payload application.\n   * When provided, automatically:\n   * - Looks up the Route53 hosted zone\n   * - Creates an ACM certificate with DNS validation (in us-east-1)\n   * - Configures CloudFront with the certificate\n   * - Creates an A record (alias) pointing to CloudFront\n   *\n   * Requires: A Route53 hosted zone for the domain must exist.\n   *\n   * @example \"cms.example.com\"\n   */\n  domain?: string;\n\n  /** Database configuration */\n  database?: PayloadDatabaseConfig;\n  /** Compute (Lambda) configuration */\n  compute?: PayloadComputeConfig;\n  /** Storage (S3) configuration */\n  storage?: PayloadStorageConfig;\n  /** Messaging (SQS) configuration */\n  messaging?: PayloadMessagingConfig;\n  /** CDN (CloudFront) configuration - for advanced use. Use `domain` for simple setup. */\n  cdn?: PayloadCdnConfig;\n\n  /** Additional environment variables for server Lambda */\n  environment?: Record<string, string>;\n}\n\n/**\n * Union of all pattern props.\n * Extend this when adding new patterns (e.g., INextjsProps, IRemixProps).\n */\nexport type IPatternProps = IPayloadProps; // | INextjsProps | IRemixProps in future\n\n/**\n * Pattern type discriminator.\n */\nexport type PatternType = \"payload\"; // | \"nextjs\" | \"remix\" in future\n\n/**\n * Base pattern interface.\n * All patterns implement this interface.\n */\nexport interface IPattern {\n  /** The type of pattern. Used for runtime type narrowing. */\n  readonly patternType: PatternType;\n\n  /** The underlying CDK construct node. */\n  readonly node: Construct[\"node\"];\n}\n\n/**\n * Payload pattern interface.\n * Provides access to all underlying resources for escape hatches.\n *\n * @example\n * // Escape hatches - full access to underlying resources\n * payload.getDatabase().grantConnect(someOtherLambda);\n * payload.getServer().getLambdaFunction().addEnvironment(\"CUSTOM_VAR\", \"value\");\n * payload.getCdn().getDistribution().addBehavior(\"/custom/*\", customOrigin);\n */\nexport interface IPayload extends IPattern {\n  readonly patternType: \"payload\";\n\n  /** Get the PostgreSQL database (Aurora or Instance) */\n  getDatabase(): RelationalDatabase;\n\n  /** Get the Server Lambda function */\n  getServer(): LambdaCompute;\n\n  /** Get the Image Optimisation Lambda function */\n  getImageOptimisation(): LambdaCompute;\n\n  /** Get the Revalidation Lambda function */\n  getRevalidation(): LambdaCompute;\n\n  /** Get the Assets S3 bucket (static files) */\n  getAssetsBucket(): PrivateStorage;\n\n  /** Get the Cache S3 bucket (ISR cache) */\n  getCacheBucket(): PrivateStorage;\n\n  /** Get the Media S3 bucket (uploads) */\n  getMediaBucket(): PrivateStorage;\n\n  /** Get the Tag Cache DynamoDB table */\n  getTagCache(): DynamoDBDatabase;\n\n  /** Get the Revalidation SQS queue */\n  getRevalidationQueue(): QueueMessaging;\n\n  /** Get the CloudFront distribution */\n  getCdn(): Cdn;\n}\n\n/**\n * Union type representing any pattern interface.\n * Use with type guards for generic handling.\n */\nexport type AnyPattern = IPayload; // | INextjs | IRemix in future\n\n/**\n * Type guard to check if a pattern is Payload.\n */\nexport function isPayloadPattern(pattern: IPattern): pattern is IPayload {\n  return pattern.patternType === \"payload\";\n}\n\n/**\n * Type guard to check if a resource is any pattern type.\n */\nexport function isPattern(resource: unknown): resource is IPattern {\n  return (\n    resource !== null &&\n    typeof resource === \"object\" &&\n    \"patternType\" in resource &&\n    typeof (resource as IPattern).patternType === \"string\"\n  );\n}\n"]}
@@ -0,0 +1,136 @@
1
+ /**
2
+ * Type-safe storage interfaces.
3
+ *
4
+ * These interfaces provide compile-time type safety for storage resources.
5
+ * All S3 bucket types are grouped under the Storage umbrella, with specific
6
+ * interfaces for each bucket type.
7
+ *
8
+ * @example
9
+ * const assets = app.addStorage(StorageFactory.build("Assets", { bucketType: "private" }));
10
+ * assets.getBucketName(); // ✓ Available on all storage types
11
+ *
12
+ * const website = app.addStorage(StorageFactory.build("Site", { bucketType: "website" }));
13
+ * website.getWebsiteUrl(); // ✓ Available on IWebsiteStorage
14
+ */
15
+ import { type IBucket, type EventType, type IBucketNotificationDestination, type NotificationKeyFilter } from "aws-cdk-lib/aws-s3";
16
+ import { type IGrantable, type Grant } from "aws-cdk-lib/aws-iam";
17
+ import { type Construct } from "constructs";
18
+ /**
19
+ * Storage type discriminator.
20
+ * Maps to S3 bucket configurations.
21
+ */
22
+ export type StorageType = "private" | "website" | "publicRead";
23
+ /**
24
+ * Base storage interface.
25
+ * All storage types implement this interface.
26
+ */
27
+ export interface IStorage {
28
+ /** The type of storage resource. Used for runtime type narrowing. */
29
+ readonly storageType: StorageType;
30
+ /** The underlying CDK construct node. */
31
+ readonly node: Construct["node"];
32
+ /** Get the underlying S3 bucket. */
33
+ getBucket(): IBucket;
34
+ /** Get the bucket ARN. */
35
+ getBucketArn(): string;
36
+ /** Get the bucket name. */
37
+ getBucketName(): string;
38
+ /** Get the bucket domain name. */
39
+ getBucketDomainName(): string;
40
+ /** Get the regional bucket domain name. */
41
+ getBucketRegionalDomainName(): string;
42
+ /**
43
+ * Grant read permissions to a grantee.
44
+ * @param grantee The principal to grant read permissions to
45
+ */
46
+ grantRead(grantee: IGrantable): Grant;
47
+ /**
48
+ * Grant write permissions to a grantee.
49
+ * @param grantee The principal to grant write permissions to
50
+ */
51
+ grantWrite(grantee: IGrantable): Grant;
52
+ /**
53
+ * Grant read and write permissions to a grantee.
54
+ * @param grantee The principal to grant permissions to
55
+ */
56
+ grantReadWrite(grantee: IGrantable): Grant;
57
+ /**
58
+ * Grant delete permissions to a grantee.
59
+ * @param grantee The principal to grant delete permissions to
60
+ */
61
+ grantDelete(grantee: IGrantable): Grant;
62
+ /**
63
+ * Grant put permissions to a grantee.
64
+ * @param grantee The principal to grant put permissions to
65
+ */
66
+ grantPut(grantee: IGrantable): Grant;
67
+ /**
68
+ * Add an event notification to the bucket.
69
+ * @param event The event type to trigger on
70
+ * @param dest The notification destination
71
+ * @param filters Optional key filters
72
+ */
73
+ addEventNotification(event: EventType, dest: IBucketNotificationDestination, ...filters: NotificationKeyFilter[]): void;
74
+ /**
75
+ * Add an object created notification.
76
+ * @param dest The notification destination
77
+ * @param filters Optional key filters
78
+ */
79
+ addObjectCreatedNotification(dest: IBucketNotificationDestination, ...filters: NotificationKeyFilter[]): void;
80
+ /**
81
+ * Add an object removed notification.
82
+ * @param dest The notification destination
83
+ * @param filters Optional key filters
84
+ */
85
+ addObjectRemovedNotification(dest: IBucketNotificationDestination, ...filters: NotificationKeyFilter[]): void;
86
+ }
87
+ /**
88
+ * Private storage interface.
89
+ * Standard S3 bucket with optional encryption and versioning.
90
+ */
91
+ export interface IPrivateStorage extends IStorage {
92
+ readonly storageType: "private";
93
+ /**
94
+ * Grant public access to objects under a prefix.
95
+ * Use with caution - makes objects publicly readable.
96
+ * @param keyPrefix Key prefixes to grant public access to
97
+ */
98
+ grantPublicAccess(...keyPrefix: string[]): Grant;
99
+ }
100
+ /**
101
+ * Website storage interface.
102
+ * S3 bucket configured for static website hosting.
103
+ */
104
+ export interface IWebsiteStorage extends IStorage {
105
+ readonly storageType: "website";
106
+ /** Get the website URL. */
107
+ getWebsiteUrl(): string;
108
+ }
109
+ /**
110
+ * Public read storage interface.
111
+ * S3 bucket with public read access enabled.
112
+ */
113
+ export interface IPublicStorage extends IStorage {
114
+ readonly storageType: "publicRead";
115
+ }
116
+ /**
117
+ * Union type representing any storage interface.
118
+ * Use with type guards for generic handling.
119
+ */
120
+ export type AnyStorage = IPrivateStorage | IWebsiteStorage | IPublicStorage;
121
+ /**
122
+ * Type guard to check if a storage is private.
123
+ */
124
+ export declare function isPrivateStorage(storage: IStorage): storage is IPrivateStorage;
125
+ /**
126
+ * Type guard to check if a storage is a website bucket.
127
+ */
128
+ export declare function isWebsiteStorage(storage: IStorage): storage is IWebsiteStorage;
129
+ /**
130
+ * Type guard to check if a storage is public read.
131
+ */
132
+ export declare function isPublicStorage(storage: IStorage): storage is IPublicStorage;
133
+ /**
134
+ * Type guard to check if a resource is any storage type.
135
+ */
136
+ export declare function isStorage(resource: unknown): resource is IStorage;
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ /**
3
+ * Type-safe storage interfaces.
4
+ *
5
+ * These interfaces provide compile-time type safety for storage resources.
6
+ * All S3 bucket types are grouped under the Storage umbrella, with specific
7
+ * interfaces for each bucket type.
8
+ *
9
+ * @example
10
+ * const assets = app.addStorage(StorageFactory.build("Assets", { bucketType: "private" }));
11
+ * assets.getBucketName(); // ✓ Available on all storage types
12
+ *
13
+ * const website = app.addStorage(StorageFactory.build("Site", { bucketType: "website" }));
14
+ * website.getWebsiteUrl(); // ✓ Available on IWebsiteStorage
15
+ */
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.isPrivateStorage = isPrivateStorage;
18
+ exports.isWebsiteStorage = isWebsiteStorage;
19
+ exports.isPublicStorage = isPublicStorage;
20
+ exports.isStorage = isStorage;
21
+ /**
22
+ * Type guard to check if a storage is private.
23
+ */
24
+ function isPrivateStorage(storage) {
25
+ return storage.storageType === "private";
26
+ }
27
+ /**
28
+ * Type guard to check if a storage is a website bucket.
29
+ */
30
+ function isWebsiteStorage(storage) {
31
+ return storage.storageType === "website";
32
+ }
33
+ /**
34
+ * Type guard to check if a storage is public read.
35
+ */
36
+ function isPublicStorage(storage) {
37
+ return storage.storageType === "publicRead";
38
+ }
39
+ /**
40
+ * Type guard to check if a resource is any storage type.
41
+ */
42
+ function isStorage(resource) {
43
+ return (resource !== null &&
44
+ typeof resource === "object" &&
45
+ "storageType" in resource &&
46
+ typeof resource.storageType === "string");
47
+ }
48
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../../../lib/patterns/aws/interfaces/storage.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;AAqJH,4CAIC;AAKD,4CAIC;AAKD,0CAEC;AAKD,8BAOC;AAnCD;;GAEG;AACH,SAAgB,gBAAgB,CAC9B,OAAiB;IAEjB,OAAO,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAC9B,OAAiB;IAEjB,OAAO,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,OAAiB;IAC/C,OAAO,OAAO,CAAC,WAAW,KAAK,YAAY,CAAC;AAC9C,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,QAAiB;IACzC,OAAO,CACL,QAAQ,KAAK,IAAI;QACjB,OAAO,QAAQ,KAAK,QAAQ;QAC5B,aAAa,IAAI,QAAQ;QACzB,OAAQ,QAAqB,CAAC,WAAW,KAAK,QAAQ,CACvD,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Type-safe storage interfaces.\n *\n * These interfaces provide compile-time type safety for storage resources.\n * All S3 bucket types are grouped under the Storage umbrella, with specific\n * interfaces for each bucket type.\n *\n * @example\n * const assets = app.addStorage(StorageFactory.build(\"Assets\", { bucketType: \"private\" }));\n * assets.getBucketName(); // ✓ Available on all storage types\n *\n * const website = app.addStorage(StorageFactory.build(\"Site\", { bucketType: \"website\" }));\n * website.getWebsiteUrl(); // ✓ Available on IWebsiteStorage\n */\n\nimport {\n  type IBucket,\n  type EventType,\n  type IBucketNotificationDestination,\n  type NotificationKeyFilter\n} from \"aws-cdk-lib/aws-s3\";\nimport { type IGrantable, type Grant } from \"aws-cdk-lib/aws-iam\";\nimport { type Construct } from \"constructs\";\n\n/**\n * Storage type discriminator.\n * Maps to S3 bucket configurations.\n */\nexport type StorageType = \"private\" | \"website\" | \"publicRead\";\n\n/**\n * Base storage interface.\n * All storage types implement this interface.\n */\nexport interface IStorage {\n  /** The type of storage resource. Used for runtime type narrowing. */\n  readonly storageType: StorageType;\n\n  /** The underlying CDK construct node. */\n  readonly node: Construct[\"node\"];\n\n  /** Get the underlying S3 bucket. */\n  getBucket(): IBucket;\n\n  /** Get the bucket ARN. */\n  getBucketArn(): string;\n\n  /** Get the bucket name. */\n  getBucketName(): string;\n\n  /** Get the bucket domain name. */\n  getBucketDomainName(): string;\n\n  /** Get the regional bucket domain name. */\n  getBucketRegionalDomainName(): string;\n\n  /**\n   * Grant read permissions to a grantee.\n   * @param grantee The principal to grant read permissions to\n   */\n  grantRead(grantee: IGrantable): Grant;\n\n  /**\n   * Grant write permissions to a grantee.\n   * @param grantee The principal to grant write permissions to\n   */\n  grantWrite(grantee: IGrantable): Grant;\n\n  /**\n   * Grant read and write permissions to a grantee.\n   * @param grantee The principal to grant permissions to\n   */\n  grantReadWrite(grantee: IGrantable): Grant;\n\n  /**\n   * Grant delete permissions to a grantee.\n   * @param grantee The principal to grant delete permissions to\n   */\n  grantDelete(grantee: IGrantable): Grant;\n\n  /**\n   * Grant put permissions to a grantee.\n   * @param grantee The principal to grant put permissions to\n   */\n  grantPut(grantee: IGrantable): Grant;\n\n  /**\n   * Add an event notification to the bucket.\n   * @param event The event type to trigger on\n   * @param dest The notification destination\n   * @param filters Optional key filters\n   */\n  addEventNotification(\n    event: EventType,\n    dest: IBucketNotificationDestination,\n    ...filters: NotificationKeyFilter[]\n  ): void;\n\n  /**\n   * Add an object created notification.\n   * @param dest The notification destination\n   * @param filters Optional key filters\n   */\n  addObjectCreatedNotification(\n    dest: IBucketNotificationDestination,\n    ...filters: NotificationKeyFilter[]\n  ): void;\n\n  /**\n   * Add an object removed notification.\n   * @param dest The notification destination\n   * @param filters Optional key filters\n   */\n  addObjectRemovedNotification(\n    dest: IBucketNotificationDestination,\n    ...filters: NotificationKeyFilter[]\n  ): void;\n}\n\n/**\n * Private storage interface.\n * Standard S3 bucket with optional encryption and versioning.\n */\nexport interface IPrivateStorage extends IStorage {\n  readonly storageType: \"private\";\n\n  /**\n   * Grant public access to objects under a prefix.\n   * Use with caution - makes objects publicly readable.\n   * @param keyPrefix Key prefixes to grant public access to\n   */\n  grantPublicAccess(...keyPrefix: string[]): Grant;\n}\n\n/**\n * Website storage interface.\n * S3 bucket configured for static website hosting.\n */\nexport interface IWebsiteStorage extends IStorage {\n  readonly storageType: \"website\";\n\n  /** Get the website URL. */\n  getWebsiteUrl(): string;\n}\n\n/**\n * Public read storage interface.\n * S3 bucket with public read access enabled.\n */\nexport interface IPublicStorage extends IStorage {\n  readonly storageType: \"publicRead\";\n}\n\n/**\n * Union type representing any storage interface.\n * Use with type guards for generic handling.\n */\nexport type AnyStorage = IPrivateStorage | IWebsiteStorage | IPublicStorage;\n\n/**\n * Type guard to check if a storage is private.\n */\nexport function isPrivateStorage(\n  storage: IStorage\n): storage is IPrivateStorage {\n  return storage.storageType === \"private\";\n}\n\n/**\n * Type guard to check if a storage is a website bucket.\n */\nexport function isWebsiteStorage(\n  storage: IStorage\n): storage is IWebsiteStorage {\n  return storage.storageType === \"website\";\n}\n\n/**\n * Type guard to check if a storage is public read.\n */\nexport function isPublicStorage(storage: IStorage): storage is IPublicStorage {\n  return storage.storageType === \"publicRead\";\n}\n\n/**\n * Type guard to check if a resource is any storage type.\n */\nexport function isStorage(resource: unknown): resource is IStorage {\n  return (\n    resource !== null &&\n    typeof resource === \"object\" &&\n    \"storageType\" in resource &&\n    typeof (resource as IStorage).storageType === \"string\"\n  );\n}\n"]}