@jaypie/constructs 1.2.12 → 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,6 +6,7 @@ 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";
+import { HostConfig } from "./helpers";
 export interface JaypieDistributionProps extends Omit<cloudfront.DistributionProps, "certificate" | "defaultBehavior" | "logBucket"> {
     /**
      * SSL certificate for the CloudFront distribution
@@ -41,10 +42,24 @@ export interface JaypieDistributionProps extends Omit<cloudfront.DistributionPro
      */
     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

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");
@@ -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;
@@ -2704,7 +2721,7 @@ class JaypieDnsRecord extends constructs.Construct {
 const GSI_NAMES = {
     ALIAS: "indexAlias",
     CLASS: "indexClass",
-    OU: "indexOu",
+    SCOPE: "indexScope",
     TYPE: "indexType",
     XID: "indexXid",
 };
@@ -2731,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 },
     },
@@ -2757,7 +2774,7 @@ const GlobalSecondaryIndex = {
 const GlobalSecondaryIndexes = [
     GlobalSecondaryIndex.Alias,
     GlobalSecondaryIndex.Class,
-    GlobalSecondaryIndex.Ou,
+    GlobalSecondaryIndex.Scope,
     GlobalSecondaryIndex.Type,
     GlobalSecondaryIndex.Xid,
 ];
@@ -2790,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,
  *   ],
  * });