@jaypie/constructs 1.1.65 → 1.1.66

package/dist/cjs/constants.d.ts

@@ -0,0 +1,151 @@
+export declare const CDK: {
+    ACCOUNT: {
+        DEVELOPMENT: string;
+        MANAGEMENT: string;
+        OPERATIONS: string;
+        PRODUCTION: string;
+        SANDBOX: string;
+        SECURITY: string;
+        STAGE: string;
+    };
+    BUILD: {
+        CONFIG: {
+            ALL: string;
+            API: string;
+            INFRASTRUCTURE: string;
+            NONE: string;
+            WEB: string;
+        };
+        PERSONAL: string;
+        /**
+         * @deprecated rename "ephemeral" to "personal" (since 2/24/2025)
+         */
+        EPHEMERAL: string;
+        /**
+         * @deprecated as even "ephemeral" builds have static assets (since 7/6/2024)
+         */
+        STATIC: string;
+    };
+    CREATION: {
+        CDK: string;
+        CLOUDFORMATION_TEMPLATE: string;
+        MANUAL: string;
+    };
+    DATADOG: {
+        SITE: string;
+        LAYER: {
+            NODE: number;
+            EXTENSION: number;
+        };
+    };
+    DEFAULT: {
+        REGION: string;
+    };
+    DNS: {
+        CONFIG: {
+            TTL: number;
+        };
+        RECORD: {
+            A: string;
+            CNAME: string;
+            MX: string;
+            NS: string;
+            TXT: string;
+        };
+    };
+    DURATION: {
+        EXPRESS_API: number;
+        LAMBDA_MAXIMUM: number;
+        LAMBDA_WORKER: number;
+    };
+    ENV: {
+        DEMO: string;
+        DEVELOPMENT: string;
+        /** @deprecated */ EPHEMERAL: string;
+        LOCAL: string;
+        /** @deprecated */ MAIN: string;
+        META: string;
+        PERSONAL: string;
+        PREVIEW: string;
+        PRODUCTION: string;
+        RELEASE: string;
+        REVIEW: string;
+        SANDBOX: string;
+        TRAINING: string;
+    };
+    HOST: {
+        APEX: string;
+    };
+    IMPORT: {
+        DATADOG_LOG_FORWARDER: string;
+        DATADOG_ROLE: string;
+        DATADOG_SECRET: string;
+        LOG_BUCKET: string;
+        OIDC_PROVIDER: string;
+    };
+    LAMBDA: {
+        LOG_RETENTION: number;
+        MEMORY_SIZE: number;
+    };
+    PRINCIPAL: {
+        ROUTE53: string;
+    };
+    PRINCIPAL_TYPE: {
+        GROUP: string;
+        USER: string;
+    };
+    PROJECT: {
+        INFRASTRUCTURE: string;
+    };
+    ROLE: {
+        API: string;
+        DEPLOY: string;
+        HOSTING: string;
+        MONITORING: string;
+        NETWORKING: string;
+        PROCESSING: string;
+        SECURITY: string;
+        STACK: string;
+        STORAGE: string;
+        TOY: string;
+    };
+    SERVICE: {
+        DATADOG: string;
+        INFRASTRUCTURE: string;
+        LIBRARIES: string;
+        NONE: string;
+        SSO: string;
+        TRACE: string;
+    };
+    TAG: {
+        BUILD_DATE: string;
+        BUILD_HEX: string;
+        BUILD_NUMBER: string;
+        BUILD_TIME: string;
+        BUILD_TYPE: string;
+        COMMIT: string;
+        CREATION: string;
+        ENV: string;
+        NONCE: string;
+        PROJECT: string;
+        ROLE: string;
+        SERVICE: string;
+        SPONSOR: string;
+        STACK: string;
+        STACK_SHA: string;
+        VENDOR: string;
+        VERSION: string;
+    };
+    TARGET_TYPE: {
+        AWS_ACCOUNT: string;
+    };
+    VENDOR: {
+        ANTHROPIC: string;
+        AUTH0: string;
+        DATADOG: string;
+        KNOWTRACE: string;
+        MONGODB: string;
+        OPENAI: string;
+        SPLINTERLANDS: string;
+    };
+};

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

@@ -0,0 +1 @@
+export {};

package/dist/cjs/helpers/__tests__/jaypieLambdaEnv.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/helpers/__tests__/resolveDatadogForwarderFunction.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/helpers/__tests__/resolveDatadogLoggingDestination.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/helpers/__tests__/resolveEnvironment.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/helpers/__tests__/resolveSecrets.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+import * as lambda from "aws-cdk-lib/aws-lambda";
+export interface AddDatadogLayerOptions {
+    datadogApiKeyArn?: string;
+}
+export declare function addDatadogLayers(lambdaFunction: lambda.Function, options?: AddDatadogLayerOptions): boolean;

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

@@ -0,0 +1,5 @@
+export declare function constructEnvName(name: string, opts?: {
+    env?: string;
+    key?: string;
+    nonce?: string;
+}): string;

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

@@ -0,0 +1 @@
+export declare function constructStackName(key?: string): string;

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

@@ -0,0 +1,4 @@
+import { Construct } from "constructs";
+export declare function constructTagger(construct: Construct, { name }?: {
+    name?: string;
+}): boolean;

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

@@ -0,0 +1,6 @@
+export declare function envHostname({ component, domain, env, subdomain, }?: {
+    component?: string;
+    domain?: string;
+    env?: string;
+    subdomain?: string;
+}): string;

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

@@ -0,0 +1,31 @@
+import { Policy } from "aws-cdk-lib/aws-iam";
+import { Construct } from "constructs";
+export interface ExtendDatadogRoleOptions {
+    /**
+     * Optional construct ID for the policy
+     * @default "DatadogCustomPolicy"
+     */
+    id?: string;
+    /**
+     * The service tag value
+     * @default CDK.SERVICE.DATADOG
+     */
+    service?: string;
+    /**
+     * Optional project tag value
+     */
+    project?: string;
+}
+/**
+ * Extends the Datadog IAM role with additional permissions
+ *
+ * Checks for CDK_ENV_DATADOG_ROLE_ARN environment variable.
+ * If found, creates a custom policy with:
+ * - budgets:ViewBudget
+ * - logs:DescribeLogGroups
+ *
+ * @param scope - The construct scope
+ * @param options - Configuration options
+ * @returns The created Policy, or undefined if CDK_ENV_DATADOG_ROLE_ARN is not set
+ */
+export declare function extendDatadogRole(scope: Construct, options?: ExtendDatadogRoleOptions): Policy | undefined;

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

@@ -0,0 +1,18 @@
+export { addDatadogLayers } from "./addDatadogLayers";
+export { constructEnvName } from "./constructEnvName";
+export { constructStackName } from "./constructStackName";
+export { constructTagger } from "./constructTagger";
+export { envHostname } from "./envHostname";
+export { extendDatadogRole, ExtendDatadogRoleOptions, } from "./extendDatadogRole";
+export { isEnv, isProductionEnv, isSandboxEnv } from "./isEnv";
+export { isValidHostname } from "./isValidHostname";
+export { isValidSubdomain } from "./isValidSubdomain";
+export { jaypieLambdaEnv } from "./jaypieLambdaEnv";
+export { mergeDomain } from "./mergeDomain";
+export { resolveDatadogForwarderFunction } from "./resolveDatadogForwarderFunction";
+export { resolveDatadogLayers } from "./resolveDatadogLayers";
+export { resolveDatadogLoggingDestination } from "./resolveDatadogLoggingDestination";
+export { resolveEnvironment, EnvironmentArrayItem, EnvironmentInput, } from "./resolveEnvironment";
+export { resolveHostedZone } from "./resolveHostedZone";
+export { resolveParamsAndSecrets } from "./resolveParamsAndSecrets";
+export { resolveSecrets, SecretsArrayItem, clearSecretsCache, clearAllSecretsCaches, } from "./resolveSecrets";

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

@@ -0,0 +1,12 @@
+/**
+ * Check if the current environment matches the given environment
+ */
+export declare function isEnv(env: string): boolean;
+/**
+ * Check if the current environment is production
+ */
+export declare function isProductionEnv(): boolean;
+/**
+ * Check if the current environment is sandbox
+ */
+export declare function isSandboxEnv(): boolean;

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

@@ -0,0 +1 @@
+export declare function isValidHostname(hostname: string): boolean;

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

@@ -0,0 +1 @@
+export declare function isValidSubdomain(subdomain: string): boolean;

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

@@ -0,0 +1,8 @@
+export interface JaypieLambdaEnvOptions {
+    initialEnvironment?: {
+        [key: string]: string;
+    };
+}
+export declare function jaypieLambdaEnv(options?: JaypieLambdaEnvOptions): {
+    [key: string]: string;
+};

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

@@ -0,0 +1 @@
+export declare function mergeDomain(subDomain: string, hostedZone: string): string;

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

@@ -0,0 +1,7 @@
+import * as lambda from "aws-cdk-lib/aws-lambda";
+import { Construct } from "constructs";
+export interface ResolveDatadogForwarderFunctionOptions {
+    import?: string;
+    name?: string;
+}
+export declare function resolveDatadogForwarderFunction(scope: Construct, options?: ResolveDatadogForwarderFunctionOptions): lambda.IFunction;

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

@@ -0,0 +1,7 @@
+import * as lambda from "aws-cdk-lib/aws-lambda";
+import { Construct } from "constructs";
+export interface ResolveDatadogLayerOptions {
+    datadogApiKeyArn?: string;
+    uniqueId?: string;
+}
+export declare function resolveDatadogLayers(scope: Construct, options?: ResolveDatadogLayerOptions): lambda.ILayerVersion[] | undefined;

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

@@ -0,0 +1,4 @@
+import * as logDestinations from "aws-cdk-lib/aws-logs-destinations";
+import { Construct } from "constructs";
+import { ResolveDatadogForwarderFunctionOptions } from "./resolveDatadogForwarderFunction";
+export declare function resolveDatadogLoggingDestination(scope: Construct, options?: ResolveDatadogForwarderFunctionOptions): logDestinations.LambdaDestination;

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

@@ -0,0 +1,47 @@
+/**
+ * Environment value type for the new array syntax
+ * - string: key to lookup in process.env
+ * - object: key-value pairs to include directly
+ */
+export type EnvironmentArrayItem = string | {
+    [key: string]: string;
+};
+/**
+ * Environment type that supports both legacy object syntax and new array syntax
+ */
+export type EnvironmentInput = {
+    [key: string]: string;
+} | EnvironmentArrayItem[];
+/**
+ * Resolves environment input to a plain object.
+ *
+ * When environment is an object (legacy syntax), returns it as-is.
+ * When environment is an array:
+ *   - Strings are treated as keys to lookup in process.env
+ *   - Objects have their key-value pairs merged in
+ *
+ * @example
+ * // Legacy object syntax
+ * resolveEnvironment({ FOO: "bar" })
+ * // => { FOO: "bar" }
+ *
+ * @example
+ * // Array syntax with process.env lookup
+ * // Given process.env.MY_VAR = "hello"
+ * resolveEnvironment(["MY_VAR"])
+ * // => { MY_VAR: "hello" }
+ *
+ * @example
+ * // Array syntax with objects
+ * resolveEnvironment([{ FOO: "bar", BAZ: "qux" }])
+ * // => { FOO: "bar", BAZ: "qux" }
+ *
+ * @example
+ * // Mixed array syntax
+ * // Given process.env.MY_VAR = "hello"
+ * resolveEnvironment(["MY_VAR", { FOO: "bar" }])
+ * // => { MY_VAR: "hello", FOO: "bar" }
+ */
+export declare function resolveEnvironment(environment?: EnvironmentInput, env?: Record<string, string | undefined>): {
+    [key: string]: string;
+};

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

@@ -0,0 +1,6 @@
+import { Construct } from "constructs";
+import * as route53 from "aws-cdk-lib/aws-route53";
+export declare function resolveHostedZone(scope: Construct, { name, zone, }?: {
+    name?: string;
+    zone?: string | route53.IHostedZone;
+}): route53.IHostedZone;

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

@@ -0,0 +1,13 @@
+import { Duration } from "aws-cdk-lib";
+import * as lambda from "aws-cdk-lib/aws-lambda";
+export interface ResolveParamsAndSecretsOptions {
+    cacheSize?: number;
+    logLevel?: lambda.ParamsAndSecretsLogLevel;
+    parameterStoreTtl?: Duration;
+    secretsManagerTtl?: Duration;
+}
+export declare const resolveParamsAndSecrets: ({ paramsAndSecrets, options, }?: {
+    paramsAndSecrets?: lambda.ParamsAndSecretsLayerVersion | boolean;
+    options?: ResolveParamsAndSecretsOptions;
+}) => lambda.ParamsAndSecretsLayerVersion | undefined;
+export default resolveParamsAndSecrets;

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

@@ -0,0 +1,52 @@
+import { Construct } from "constructs";
+import { JaypieEnvSecret } from "../JaypieEnvSecret.js";
+/**
+ * Secrets input type that supports both JaypieEnvSecret instances and strings
+ * - JaypieEnvSecret: passed through as-is
+ * - string: converted to JaypieEnvSecret with the string as envKey
+ */
+export type SecretsArrayItem = JaypieEnvSecret | string;
+/**
+ * Resolves secrets input to an array of JaypieEnvSecret instances.
+ *
+ * When an item is already a JaypieEnvSecret, it's passed through as-is.
+ * When an item is a string, a JaypieEnvSecret is created (or reused from cache)
+ * with the string as the envKey.
+ *
+ * Secrets are cached per scope to avoid creating duplicate secrets when
+ * multiple constructs in the same scope reference the same secret.
+ *
+ * @example
+ * // JaypieEnvSecret instances pass through
+ * const secret = new JaypieEnvSecret(scope, "MySecret", { envKey: "MY_KEY" });
+ * resolveSecrets(scope, [secret])
+ * // => [secret]
+ *
+ * @example
+ * // Strings create JaypieEnvSecret instances
+ * resolveSecrets(scope, ["AUTH0_SECRET", "MONGODB_URI"])
+ * // => [JaypieEnvSecret(envKey: "AUTH0_SECRET"), JaypieEnvSecret(envKey: "MONGODB_URI")]
+ *
+ * @example
+ * // Mixed input
+ * const existingSecret = new JaypieEnvSecret(scope, "Existing", { envKey: "EXISTING" });
+ * resolveSecrets(scope, [existingSecret, "NEW_SECRET"])
+ * // => [existingSecret, JaypieEnvSecret(envKey: "NEW_SECRET")]
+ *
+ * @example
+ * // Secrets are shared across calls with the same scope
+ * const secrets1 = resolveSecrets(scope, ["SHARED_SECRET"]);
+ * const secrets2 = resolveSecrets(scope, ["SHARED_SECRET"]);
+ * // secrets1[0] === secrets2[0] (same instance)
+ */
+export declare function resolveSecrets(scope: Construct, secrets?: SecretsArrayItem[]): JaypieEnvSecret[];
+/**
+ * Clears the secrets cache for a given scope.
+ * Primarily useful for testing.
+ */
+export declare function clearSecretsCache(scope: Construct): void;
+/**
+ * Clears all secrets caches.
+ * Primarily useful for testing.
+ */
+export declare function clearAllSecretsCaches(): void;