@jaypie/constructs 1.2.11 → 1.2.13

package/dist/cjs/JaypieApiGateway.d.ts

@@ -3,9 +3,26 @@ import { RemovalPolicy, Stack } from "aws-cdk-lib";
 import * as acm from "aws-cdk-lib/aws-certificatemanager";
 import * as apiGateway from "aws-cdk-lib/aws-apigateway";
 import * as route53 from "aws-cdk-lib/aws-route53";
+import { HostConfig } from "./helpers";
 export interface JaypieApiGatewayProps extends apiGateway.LambdaRestApiProps {
     certificate?: boolean | acm.ICertificate;
-    host?: string;
+    /**
+     * The domain name for the API Gateway.
+     *
+     * Supports both string and config object:
+     * - String: used directly as the domain name (e.g., "api.example.com")
+     * - Object: passed to envHostname() to construct the domain name
+     *   - { subdomain, domain, env, component }
+     *
+     * @example
+     * // Direct string
+     * host: "api.example.com"
+     *
+     * @example
+     * // Config object - resolves using envHostname()
+     * host: { subdomain: "api" }
+     */
+    host?: string | HostConfig;
     name?: string;
     roleTag?: string;
     zone?: string | route53.IHostedZone;

package/dist/cjs/JaypieDistribution.d.ts

@@ -6,7 +6,8 @@ import * as route53 from "aws-cdk-lib/aws-route53";
 import * as s3 from "aws-cdk-lib/aws-s3";
 import { LambdaDestination } from "aws-cdk-lib/aws-s3-notifications";
 import { Construct } from "constructs";
-export interface JaypieDistributionProps extends Omit<cloudfront.DistributionProps, "certificate" | "defaultBehavior"> {
+import { HostConfig } from "./helpers";
+export interface JaypieDistributionProps extends Omit<cloudfront.DistributionProps, "certificate" | "defaultBehavior" | "logBucket"> {
     /**
      * SSL certificate for the CloudFront distribution
      * @default true (creates a new certificate)
@@ -20,20 +21,45 @@ export interface JaypieDistributionProps extends Omit<cloudfront.DistributionPro
      * Log destination configuration for CloudFront access logs
      * - LambdaDestination: Use a specific Lambda destination for S3 notifications
      * - true: Use Datadog forwarder for S3 notifications (default)
-     * - false: Disable logging entirely
+     * - false: Disable S3 notifications (logging still occurs if logBucket is set)
      * @default true
      */
     destination?: LambdaDestination | boolean;
+    /**
+     * External log bucket for CloudFront access logs.
+     * - IBucket: Use existing bucket directly
+     * - string: Bucket name to import
+     * - { exportName: string }: CloudFormation export name to import
+     * - true: Use account logging bucket (CDK.IMPORT.LOG_BUCKET)
+     * @default undefined (creates new bucket if destination !== false)
+     */
+    logBucket?: s3.IBucket | string | {
+        exportName: string;
+    } | true;
     /**
      * The origin handler - can be an IOrigin, IFunctionUrl, or IFunction
      * If IFunction, a FunctionUrl will be created with auth NONE
      */
     handler?: cloudfront.IOrigin | lambda.IFunctionUrl | lambda.IFunction;
     /**
-     * The domain name for the distribution
+     * The domain name for the distribution.
+     *
+     * Supports both string and config object:
+     * - String: used directly as the domain name (e.g., "api.example.com")
+     * - Object: passed to envHostname() to construct the domain name
+     *   - { subdomain, domain, env, component }
+     *
      * @default mergeDomain(CDK_ENV_API_SUBDOMAIN, CDK_ENV_API_HOSTED_ZONE || CDK_ENV_HOSTED_ZONE)
+     *
+     * @example
+     * // Direct string
+     * host: "api.example.com"
+     *
+     * @example
+     * // Config object - resolves using envHostname()
+     * host: { subdomain: "api" }
      */
-    host?: string;
+    host?: string | HostConfig;
     /**
      * Invoke mode for Lambda Function URLs.
      * If not provided, auto-detects from handler if it has an invokeMode property
@@ -74,6 +100,8 @@ export declare class JaypieDistribution extends Construct implements cloudfront.
     private isIFunctionUrl;
     private isIFunction;
     private hasInvokeMode;
+    private isExportNameObject;
+    private resolveLogBucket;
     get env(): {
         account: string;
         region: string;

package/dist/cjs/JaypieDynamoDb.d.ts

@@ -4,7 +4,7 @@ import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
 export interface JaypieDynamoDbProps extends Omit<dynamodb.TablePropsV2, "globalSecondaryIndexes" | "partitionKey" | "sortKey"> {
     /**
      * Configure GSIs for the table.
-     * - `undefined` or `true`: Creates all five Jaypie GSIs (Alias, Class, Ou, Type, Xid)
+     * - `undefined` or `true`: Creates all five Jaypie GSIs (Alias, Class, Scope, Type, Xid)
      * - `false`: No GSIs
      * - Array: Use the specified GSIs
      */
@@ -61,7 +61,7 @@ export interface JaypieDynamoDbProps extends Omit<dynamodb.TablePropsV2, "global
  * // Use only specific GSIs
  * const table = new JaypieDynamoDb(this, "MyTable", {
  *   globalSecondaryIndexes: [
- *     JaypieDynamoDb.GlobalSecondaryIndex.Ou,
+ *     JaypieDynamoDb.GlobalSecondaryIndex.Scope,
  *     JaypieDynamoDb.GlobalSecondaryIndex.Type,
  *   ],
  * });
@@ -73,7 +73,7 @@ export declare class JaypieDynamoDb extends Construct implements dynamodb.ITable
     static readonly GlobalSecondaryIndex: {
         readonly Alias: dynamodb.GlobalSecondaryIndexPropsV2;
         readonly Class: dynamodb.GlobalSecondaryIndexPropsV2;
-        readonly Ou: dynamodb.GlobalSecondaryIndexPropsV2;
+        readonly Scope: dynamodb.GlobalSecondaryIndexPropsV2;
         readonly Type: dynamodb.GlobalSecondaryIndexPropsV2;
         readonly Xid: dynamodb.GlobalSecondaryIndexPropsV2;
     };

package/dist/cjs/JaypieNextJs.d.ts

@@ -2,13 +2,11 @@ import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
 import { IHostedZone } from "aws-cdk-lib/aws-route53";
 import * as secretsmanager from "aws-cdk-lib/aws-secretsmanager";
 import { Construct } from "constructs";
-import { EnvironmentInput, SecretsArrayItem } from "./helpers";
-export interface DomainNameConfig {
-    component?: string;
-    domain?: string;
-    env?: string;
-    subdomain?: string;
-}
+import { EnvironmentInput, HostConfig, SecretsArrayItem } from "./helpers";
+/**
+ * @deprecated Use HostConfig instead. This alias is kept for backwards compatibility.
+ */
+export type DomainNameConfig = HostConfig;
 export interface JaypieNextjsProps {
     datadogApiKeyArn?: string;
     /**

package/dist/cjs/helpers/envHostname.d.ts

@@ -1,6 +1,11 @@
-export declare function envHostname({ component, domain, env, subdomain, }?: {
+/**
+ * Configuration for resolving a hostname from parts.
+ * Used by envHostname() to construct domain names from environment and config.
+ */
+export interface HostConfig {
     component?: string;
     domain?: string;
     env?: string;
     subdomain?: string;
-}): string;
+}
+export declare function envHostname({ component, domain, env, subdomain, }?: HostConfig): string;

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

@@ -2,7 +2,7 @@ export { addDatadogLayers } from "./addDatadogLayers";
 export { constructEnvName } from "./constructEnvName";
 export { constructStackName } from "./constructStackName";
 export { constructTagger } from "./constructTagger";
-export { envHostname } from "./envHostname";
+export { envHostname, HostConfig } from "./envHostname";
 export { extendDatadogRole, ExtendDatadogRoleOptions, } from "./extendDatadogRole";
 export { clearAllCertificateCaches, clearCertificateCache, resolveCertificate, ResolveCertificateOptions, } from "./resolveCertificate";
 export { isEnv, isProductionEnv, isSandboxEnv } from "./isEnv";

package/dist/cjs/index.cjs

@@ -1159,15 +1159,20 @@ class JaypieApiGateway extends constructs.Construct {
             zone = process.env.CDK_ENV_API_HOSTED_ZONE;
         }
         // Determine host from props or environment
-        let host = propsHost;
-        if (!host) {
-            if (process.env.CDK_ENV_API_HOST_NAME) {
-                host = process.env.CDK_ENV_API_HOST_NAME;
-            }
-            else if (process.env.CDK_ENV_API_SUBDOMAIN &&
-                process.env.CDK_ENV_API_HOSTED_ZONE) {
-                host = mergeDomain(process.env.CDK_ENV_API_SUBDOMAIN, process.env.CDK_ENV_API_HOSTED_ZONE);
-            }
+        let host;
+        if (typeof propsHost === "string") {
+            host = propsHost;
+        }
+        else if (typeof propsHost === "object") {
+            // Resolve host from HostConfig using envHostname()
+            host = envHostname(propsHost);
+        }
+        else if (process.env.CDK_ENV_API_HOST_NAME) {
+            host = process.env.CDK_ENV_API_HOST_NAME;
+        }
+        else if (process.env.CDK_ENV_API_SUBDOMAIN &&
+            process.env.CDK_ENV_API_HOSTED_ZONE) {
+            host = mergeDomain(process.env.CDK_ENV_API_SUBDOMAIN, process.env.CDK_ENV_API_HOSTED_ZONE);
         }
         const apiGatewayName = name || constructEnvName("ApiGateway");
         const apiDomainName = constructEnvName("ApiDomainName");
@@ -2357,7 +2362,7 @@ class JaypieDatadogSecret extends JaypieEnvSecret {
 class JaypieDistribution extends constructs.Construct {
     constructor(scope, id, props) {
         super(scope, id);
-        const { certificate: certificateProp = true, defaultBehavior: propsDefaultBehavior, destination: destinationProp = true, handler, host: propsHost, invokeMode = lambda__namespace.InvokeMode.BUFFERED, originReadTimeout = cdk.Duration.seconds(CDK$2.DURATION.CLOUDFRONT_API), roleTag = CDK$2.ROLE.API, zone: propsZone, ...distributionProps } = props;
+        const { certificate: certificateProp = true, defaultBehavior: propsDefaultBehavior, destination: destinationProp = true, handler, host: propsHost, invokeMode = lambda__namespace.InvokeMode.BUFFERED, logBucket: logBucketProp, originReadTimeout = cdk.Duration.seconds(CDK$2.DURATION.CLOUDFRONT_API), roleTag = CDK$2.ROLE.API, zone: propsZone, ...distributionProps } = props;
         // Validate environment variables
         if (process.env.CDK_ENV_API_SUBDOMAIN &&
             !isValidSubdomain(process.env.CDK_ENV_API_SUBDOMAIN)) {
@@ -2372,8 +2377,20 @@ class JaypieDistribution extends constructs.Construct {
             throw new Error("CDK_ENV_HOSTED_ZONE is not a valid hostname");
         }
         // Determine host from props or environment
-        let host = propsHost;
-        if (!host) {
+        let host;
+        if (typeof propsHost === "string") {
+            host = propsHost;
+        }
+        else if (typeof propsHost === "object") {
+            // Resolve host from HostConfig using envHostname()
+            try {
+                host = envHostname(propsHost);
+            }
+            catch {
+                host = undefined;
+            }
+        }
+        else {
             try {
                 if (process.env.CDK_ENV_API_HOST_NAME) {
                     host = process.env.CDK_ENV_API_HOST_NAME;
@@ -2459,12 +2476,16 @@ class JaypieDistribution extends constructs.Construct {
             });
             this.certificate = certificateToUse;
         }
-        // Create log bucket if logging is enabled
+        // Resolve or create log bucket
         let logBucket;
-        if (destinationProp !== false) {
-            logBucket = new s3__namespace.Bucket(this, constructEnvName("LogBucket"), {
-                objectOwnership: s3__namespace.ObjectOwnership.OBJECT_WRITER,
-                removalPolicy: cdk.RemovalPolicy.DESTROY,
+        const isExternalBucket = logBucketProp !== undefined;
+        if (logBucketProp !== undefined) {
+            // Use external bucket
+            logBucket = this.resolveLogBucket(logBucketProp);
+        }
+        else if (destinationProp !== false) {
+            // Create new bucket (original behavior)
+            const createdBucket = new s3__namespace.Bucket(this, constructEnvName("LogBucket"), {
                 autoDeleteObjects: true,
                 lifecycleRules: [
                     {
@@ -2477,15 +2498,21 @@ class JaypieDistribution extends constructs.Construct {
                         ],
                     },
                 ],
+                objectOwnership: s3__namespace.ObjectOwnership.OBJECT_WRITER,
+                removalPolicy: cdk.RemovalPolicy.DESTROY,
             });
-            cdk.Tags.of(logBucket).add(CDK$2.TAG.ROLE, CDK$2.ROLE.STORAGE);
-            // Add S3 notification to Datadog forwarder
+            cdk.Tags.of(createdBucket).add(CDK$2.TAG.ROLE, CDK$2.ROLE.STORAGE);
+            logBucket = createdBucket;
+        }
+        // Add S3 notifications if we have a bucket and destination is not false
+        if (logBucket && destinationProp !== false && !isExternalBucket) {
+            // Only add notifications to buckets we created (not external buckets)
             const lambdaDestination = destinationProp === true
                 ? new s3n.LambdaDestination(resolveDatadogForwarderFunction(this))
                 : destinationProp;
             logBucket.addEventNotification(s3__namespace.EventType.OBJECT_CREATED, lambdaDestination);
-            this.logBucket = logBucket;
         }
+        this.logBucket = logBucket;
         // Create the CloudFront distribution
         this.distribution = new cloudfront__namespace.Distribution(this, constructEnvName("Distribution"), {
             defaultBehavior,
@@ -2556,6 +2583,30 @@ class JaypieDistribution extends constructs.Construct {
             "invokeMode" in handler &&
             typeof handler.invokeMode === "string");
     }
+    isExportNameObject(value) {
+        return (typeof value === "object" &&
+            value !== null &&
+            "exportName" in value &&
+            typeof value.exportName === "string");
+    }
+    resolveLogBucket(logBucketProp) {
+        // true = use account logging bucket
+        if (logBucketProp === true) {
+            const bucketName = cdk.Fn.importValue(CDK$2.IMPORT.LOG_BUCKET);
+            return s3__namespace.Bucket.fromBucketName(this, "ImportedLogBucket", bucketName);
+        }
+        // { exportName: string } = import from CloudFormation export
+        if (this.isExportNameObject(logBucketProp)) {
+            const bucketName = cdk.Fn.importValue(logBucketProp.exportName);
+            return s3__namespace.Bucket.fromBucketName(this, "ImportedLogBucket", bucketName);
+        }
+        // string = bucket name
+        if (typeof logBucketProp === "string") {
+            return s3__namespace.Bucket.fromBucketName(this, "ImportedLogBucket", logBucketProp);
+        }
+        // IBucket = use directly
+        return logBucketProp;
+    }
     // Implement IDistribution interface
     get env() {
         return {
@@ -2670,7 +2721,7 @@ class JaypieDnsRecord extends constructs.Construct {
 const GSI_NAMES = {
     ALIAS: "indexAlias",
     CLASS: "indexClass",
-    OU: "indexOu",
+    SCOPE: "indexScope",
     TYPE: "indexType",
     XID: "indexXid",
 };
@@ -2697,9 +2748,9 @@ const GlobalSecondaryIndex = {
         projectionType: dynamodb__namespace.ProjectionType.ALL,
         sortKey: { name: "sequence", type: dynamodb__namespace.AttributeType.NUMBER },
     },
-    Ou: {
-        indexName: GSI_NAMES.OU,
-        partitionKey: { name: GSI_NAMES.OU, type: dynamodb__namespace.AttributeType.STRING },
+    Scope: {
+        indexName: GSI_NAMES.SCOPE,
+        partitionKey: { name: GSI_NAMES.SCOPE, type: dynamodb__namespace.AttributeType.STRING },
         projectionType: dynamodb__namespace.ProjectionType.ALL,
         sortKey: { name: "sequence", type: dynamodb__namespace.AttributeType.NUMBER },
     },
@@ -2723,7 +2774,7 @@ const GlobalSecondaryIndex = {
 const GlobalSecondaryIndexes = [
     GlobalSecondaryIndex.Alias,
     GlobalSecondaryIndex.Class,
-    GlobalSecondaryIndex.Ou,
+    GlobalSecondaryIndex.Scope,
     GlobalSecondaryIndex.Type,
     GlobalSecondaryIndex.Xid,
 ];
@@ -2756,7 +2807,7 @@ const GlobalSecondaryIndexes = [
  * // Use only specific GSIs
  * const table = new JaypieDynamoDb(this, "MyTable", {
  *   globalSecondaryIndexes: [
- *     JaypieDynamoDb.GlobalSecondaryIndex.Ou,
+ *     JaypieDynamoDb.GlobalSecondaryIndex.Scope,
  *     JaypieDynamoDb.GlobalSecondaryIndex.Type,
  *   ],
  * });