@jaypie/constructs 1.2.17 → 1.2.19

package/dist/cjs/JaypieDynamoDb.d.ts

@@ -93,7 +93,7 @@ export declare class JaypieDynamoDb extends Construct implements dynamodb.ITable
      * Default Jaypie GSI definitions from @jaypie/fabric.
      * Pass to `indexes` prop to create all standard GSIs.
      */
-    static readonly DEFAULT_INDEXES: any;
+    static readonly DEFAULT_INDEXES: IndexDefinition[];
     private readonly _table;
     constructor(scope: Construct, id: string, props?: JaypieDynamoDbProps);
     /**

package/dist/cjs/JaypieNextJs.d.ts

@@ -16,8 +16,16 @@ export interface JaypieNextjsProps {
      * - String: used directly as the domain name
      * - Object: passed to envHostname() to construct the domain name
      *   - { component, domain, env, subdomain }
+     *
+     * To deploy without a domain (CloudFront URL only), set domainProps: false
      */
     domainName?: string | DomainNameConfig;
+    /**
+     * Set to false to deploy without a custom domain.
+     * When false, the application will only be accessible via CloudFront URL.
+     * This overrides any domainName configuration.
+     */
+    domainProps?: false;
     /**
      * DynamoDB tables to grant read/write access to the Next.js server function.
      * Each table is granted read/write access and if exactly one table is provided,
@@ -51,7 +59,7 @@ export interface JaypieNextjsProps {
 }
 export declare class JaypieNextJs extends Construct {
     private readonly _nextjs;
-    readonly domainName: string;
+    readonly domainName?: string;
     constructor(scope: Construct, id: string, props?: JaypieNextjsProps);
     /** S3 bucket for static assets */
     get bucket(): import("aws-cdk-lib/aws-s3").IBucket;

package/dist/cjs/JaypieWebSocket.d.ts

@@ -0,0 +1,115 @@
+import { Construct } from "constructs";
+import * as acm from "aws-cdk-lib/aws-certificatemanager";
+import * as apigatewayv2 from "aws-cdk-lib/aws-apigatewayv2";
+import * as iam from "aws-cdk-lib/aws-iam";
+import * as lambda from "aws-cdk-lib/aws-lambda";
+import * as logs from "aws-cdk-lib/aws-logs";
+import * as route53 from "aws-cdk-lib/aws-route53";
+import { HostConfig } from "./helpers";
+export interface JaypieWebSocketProps {
+    /**
+     * Certificate configuration.
+     * - true: Create certificate at stack level (default, reusable)
+     * - false: No certificate (use regional endpoint)
+     * - ICertificate: Use provided certificate
+     * - string: Import certificate from ARN
+     */
+    certificate?: boolean | acm.ICertificate | string;
+    /**
+     * Lambda handler for $connect route (connection established).
+     * Use this to validate connections (e.g., auth tokens) and store connection IDs.
+     */
+    connect?: lambda.IFunction;
+    /**
+     * Lambda handler for $default route (catches unmatched messages).
+     * Use this as the main message handler.
+     */
+    default?: lambda.IFunction;
+    /**
+     * Lambda handler for $disconnect route (connection closed).
+     * Use this to clean up connection IDs from storage.
+     */
+    disconnect?: lambda.IFunction;
+    /**
+     * Single Lambda handler for all routes.
+     * Alternative to providing separate connect/disconnect/default handlers.
+     * The handler receives routeKey in the context to determine which route was invoked.
+     */
+    handler?: lambda.IFunction;
+    /**
+     * The domain name for the WebSocket API.
+     *
+     * Supports both string and config object:
+     * - String: used directly as the domain name (e.g., "ws.example.com")
+     * - Object: passed to envHostname() to construct the domain name
+     *   - { subdomain, domain, env, component }
+     *
+     * @example
+     * // Direct string
+     * host: "ws.example.com"
+     *
+     * @example
+     * // Config object - resolves using envHostname()
+     * host: { component: "ws" }
+     */
+    host?: string | HostConfig;
+    /**
+     * Log retention for WebSocket API access logs.
+     * @default logs.RetentionDays.THREE_MONTHS
+     */
+    logRetention?: logs.RetentionDays;
+    /**
+     * Construct name (used for resource naming).
+     */
+    name?: string;
+    /**
+     * Role tag for tagging resources.
+     * @default CDK.ROLE.API
+     */
+    roleTag?: string;
+    /**
+     * Additional named routes beyond $connect, $disconnect, and $default.
+     * Keys are route keys (e.g., "sendMessage", "subscribe").
+     */
+    routes?: Record<string, lambda.IFunction>;
+    /**
+     * Stage name for the WebSocket API.
+     * @default "production"
+     */
+    stageName?: string;
+    /**
+     * Route53 hosted zone for DNS records.
+     * - string: Zone domain name (looked up or imported)
+     * - IHostedZone: Use provided hosted zone
+     */
+    zone?: string | route53.IHostedZone;
+}
+export declare class JaypieWebSocket extends Construct {
+    private readonly _api;
+    private readonly _certificate?;
+    private readonly _domainName?;
+    private readonly _host?;
+    private readonly _stage;
+    constructor(scope: Construct, id: string, props?: JaypieWebSocketProps);
+    get api(): apigatewayv2.WebSocketApi;
+    get apiId(): string;
+    get certificate(): acm.ICertificate | undefined;
+    get domainName(): string | undefined;
+    /**
+     * The WebSocket endpoint URL.
+     * Uses custom domain if configured, otherwise returns the default stage URL.
+     */
+    get endpoint(): string;
+    get host(): string | undefined;
+    get stage(): apigatewayv2.WebSocketStage;
+    /**
+     * The callback URL for API Gateway Management API.
+     * Use this URL to send messages to connected clients.
+     */
+    get callbackUrl(): string;
+    /**
+     * Grant a Lambda function permission to manage WebSocket connections
+     * (post to connections, delete connections).
+     */
+    grantManageConnections(grantee: lambda.IFunction): iam.Grant;
+}

package/dist/cjs/JaypieWebSocketLambda.d.ts

@@ -0,0 +1,26 @@
+import { Construct } from "constructs";
+import { JaypieLambda, JaypieLambdaProps } from "./JaypieLambda.js";
+/**
+ * JaypieWebSocketLambda - A Lambda function optimized for WebSocket handlers.
+ *
+ * Provides sensible defaults for WebSocket event handling:
+ * - 30 second timeout (same as API handlers)
+ * - API role tag
+ *
+ * @example
+ * ```typescript
+ * const handler = new JaypieWebSocketLambda(this, "ChatHandler", {
+ *   code: "dist/handlers",
+ *   handler: "chat.handler",
+ *   secrets: ["MONGODB_URI"],
+ * });
+ *
+ * new JaypieWebSocket(this, "Chat", {
+ *   host: "ws.example.com",
+ *   handler,
+ * });
+ * ```
+ */
+export declare class JaypieWebSocketLambda extends JaypieLambda {
+    constructor(scope: Construct, id: string, props: JaypieLambdaProps);
+}

package/dist/cjs/JaypieWebSocketTable.d.ts

@@ -0,0 +1,100 @@
+import { Construct } from "constructs";
+import { Duration } from "aws-cdk-lib";
+import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
+import * as iam from "aws-cdk-lib/aws-iam";
+import * as lambda from "aws-cdk-lib/aws-lambda";
+export interface JaypieWebSocketTableProps {
+    /**
+     * Explicit table name. If not provided, uses CDK-generated name.
+     */
+    tableName?: string;
+    /**
+     * Time-to-live duration for connections.
+     * Connections will be automatically deleted after this duration.
+     * @default Duration.hours(24)
+     */
+    ttl?: Duration;
+    /**
+     * Whether to create a GSI for looking up connections by user ID.
+     * @default false
+     */
+    userIndex?: boolean;
+    /**
+     * Role tag for tagging resources.
+     * @default CDK.ROLE.STORAGE
+     */
+    roleTag?: string;
+}
+/**
+ * JaypieWebSocketTable - DynamoDB table for storing WebSocket connection IDs.
+ *
+ * Provides a simple table structure for tracking active WebSocket connections:
+ * - Partition key: connectionId (String)
+ * - TTL attribute: expiresAt (for automatic cleanup)
+ * - Optional GSI: userId-index (for looking up connections by user)
+ *
+ * @example
+ * ```typescript
+ * const connectionTable = new JaypieWebSocketTable(this, "Connections");
+ *
+ * const ws = new JaypieWebSocket(this, "Chat", {
+ *   host: "ws.example.com",
+ *   handler: chatHandler,
+ * });
+ *
+ * // Grant Lambda access to the table
+ * connectionTable.grantReadWriteData(chatHandler);
+ *
+ * // Pass table name to Lambda
+ * chatHandler.addEnvironment("CONNECTION_TABLE", connectionTable.tableName);
+ * ```
+ *
+ * @example
+ * // With user index for looking up all connections for a user
+ * const connectionTable = new JaypieWebSocketTable(this, "Connections", {
+ *   userIndex: true,
+ *   ttl: Duration.hours(12),
+ * });
+ */
+export declare class JaypieWebSocketTable extends Construct {
+    private readonly _table;
+    private readonly _ttlDuration;
+    constructor(scope: Construct, id: string, props?: JaypieWebSocketTableProps);
+    /**
+     * The underlying DynamoDB TableV2 construct.
+     */
+    get table(): dynamodb.TableV2;
+    /**
+     * The name of the DynamoDB table.
+     */
+    get tableName(): string;
+    /**
+     * The ARN of the DynamoDB table.
+     */
+    get tableArn(): string;
+    /**
+     * TTL duration for connections in seconds.
+     * Use this to calculate expiresAt when storing connections.
+     */
+    get ttlSeconds(): number;
+    /**
+     * Grant read permissions to the table.
+     */
+    grantReadData(grantee: iam.IGrantable): iam.Grant;
+    /**
+     * Grant write permissions to the table.
+     */
+    grantWriteData(grantee: iam.IGrantable): iam.Grant;
+    /**
+     * Grant read and write permissions to the table.
+     */
+    grantReadWriteData(grantee: iam.IGrantable): iam.Grant;
+    /**
+     * Add the table name to a Lambda function's environment variables.
+     * Also grants read/write access to the table.
+     */
+    connectLambda(lambdaFunction: lambda.IFunction, options?: {
+        envKey?: string;
+        readOnly?: boolean;
+    }): void;
+}

package/dist/cjs/__tests__/JaypieWebSocket.spec.d.ts

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