@lafken/queue 0.11.19 → 0.12.0

package/lib/main/queue/queue.js

@@ -92,6 +92,7 @@ exports.Standard = (0, common_1.createLambdaDecorator)({
     getLambdaMetadata: (props, methodName) => ({
         ...props,
         queueName: props.queueName || methodName,
+        isExternal: props.isExternal ?? false,
         name: methodName,
         isFifo: false,
     }),
@@ -122,6 +123,7 @@ exports.Fifo = (0, common_1.createLambdaDecorator)({
     getLambdaMetadata: (props, methodName) => ({
         ...props,
         queueName: props.queueName || methodName,
+        isExternal: props.isExternal ?? false,
         name: methodName,
         isFifo: true,
     }),

package/lib/main/queue/queue.types.d.ts

@@ -1,4 +1,4 @@
-import type { LambdaMetadata, LambdaProps, QueueNames, QueueReferenceNames, ResourceOutputType } from '@lafken/common';
+import type { GetResourceProps, LambdaMetadata, LambdaProps, QueueNames, QueueReferenceNames, ResourceOutputType } from '@lafken/common';
 /**
  * Attributes that can be exported from an SQS queue resource.
  *
@@ -18,7 +18,15 @@ export interface DlqProps {
      */
     retentionPeriod?: number;
 }
-export interface StandardProps {
+export interface InternalStandardProps {
+    /**
+     * Marks the queue as an external resource.
+     *
+     * When set to `true`, the SQS queue is not created by the framework.
+     * Instead, it references an existing queue by `queueName`. The Lambda
+     * handler and event source mapping are still created.
+     */
+    isExternal?: false;
     /**
      * Delivery delay in seconds.
      *
@@ -115,7 +123,21 @@ export interface StandardProps {
      */
     dlq?: DlqProps;
 }
-export interface FifoProps extends StandardProps {
+export interface ExternalQueueProps {
+    /**
+     * Marks the queue as an external resource.
+     *
+     * When set to `true`, the SQS queue is not created by the framework.
+     * Instead, it references an existing queue by `queueName`. The Lambda
+     * handler and event source mapping are still created.
+     */
+    isExternal: true;
+    /**
+     *
+     */
+    queueName: string | ((props: GetResourceProps) => string);
+}
+export interface InternalFifoProps extends InternalStandardProps {
     /**
      * Enable content-based deduplication.
      *
@@ -126,7 +148,10 @@ export interface FifoProps extends StandardProps {
      */
     contentBasedDeduplication?: boolean;
 }
-export interface QueueLambdaMetadata extends LambdaMetadata, Omit<FifoProps, 'queueName'> {
-    queueName: string;
+export type StandardProps = InternalStandardProps | ExternalQueueProps;
+export type FifoProps = InternalFifoProps | ExternalQueueProps;
+export interface QueueLambdaMetadata extends LambdaMetadata, Omit<InternalFifoProps, 'queueName' | 'isExternal'> {
+    queueName: ExternalQueueProps['queueName'];
     isFifo: boolean;
+    isExternal: boolean;
 }

package/lib/resolver/queue/base/base.d.ts

@@ -0,0 +1,16 @@
+import type { Construct } from 'constructs';
+import type { QueueProps } from '../queue.types';
+type Constructor = new (...args: any[]) => Construct & {
+    arn: string;
+};
+export declare function QueueBase<TBase extends Constructor>(Base: TBase): {
+    new (...args: any[]): {
+        addEventSource(id: string, props: QueueProps): void;
+        validateEventParams(props: QueueProps): void;
+        readonly node: import("constructs").Node;
+        with(...mixins: import("constructs").IMixin[]): import("constructs").IConstruct;
+        toString(): string;
+        arn: string;
+    };
+} & TBase;
+export {};

package/lib/resolver/queue/base/base.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueBase = QueueBase;
+const lambda_event_source_mapping_1 = require("@cdktn/provider-aws/lib/lambda-event-source-mapping");
+const common_1 = require("@lafken/common");
+const resolver_1 = require("@lafken/resolver");
+const attributeAllowedTypes = new Set(['String', 'Number']);
+const bodyUnparsedTypes = new Set(['String']);
+function getParams(props) {
+    const { classResource, handler } = props;
+    const params = (0, common_1.getMetadataPrototypeByKey)(classResource, common_1.LambdaReflectKeys.event_param) || {};
+    return params[handler.name];
+}
+function validateParamType(param) {
+    if (param.source === 'attribute' && !attributeAllowedTypes.has(param.type)) {
+        throw new Error(`Attribute params only support ${[...attributeAllowedTypes].join(', ')} values`);
+    }
+    if (param?.source === 'body' && !param.parse && !bodyUnparsedTypes.has(param.type)) {
+        throw new Error(`Body params only support ${[...bodyUnparsedTypes].join(', ')} values`);
+    }
+}
+function QueueBase(Base) {
+    class QueueWithBase extends Base {
+        addEventSource(id, props) {
+            const { handler, resourceMetadata } = props;
+            const lambdaHandler = new resolver_1.LambdaHandler(this, `${id}-handler`, {
+                ...handler,
+                originalName: resourceMetadata.originalName,
+                filename: resourceMetadata.filename,
+                foldername: resourceMetadata.foldername,
+                suffix: 'queue',
+            });
+            new lambda_event_source_mapping_1.LambdaEventSourceMapping(this, 'event-mapping', {
+                batchSize: handler.batchSize,
+                eventSourceArn: this.arn,
+                functionName: lambdaHandler.arn,
+                maximumBatchingWindowInSeconds: handler.maxBatchingWindow,
+                functionResponseTypes: handler.isFifo ? ['ReportBatchItemFailures'] : undefined,
+                scalingConfig: handler.maxConcurrency
+                    ? { maximumConcurrency: handler.maxConcurrency }
+                    : undefined,
+                dependsOn: [lambdaHandler],
+            });
+        }
+        validateEventParams(props) {
+            const param = getParams(props);
+            if (!param)
+                return;
+            let bodyCount = 0;
+            for (const property of param.properties) {
+                validateParamType(property);
+                if (property.source === 'body')
+                    bodyCount++;
+                if (bodyCount >= 2)
+                    throw new Error('Queue event only support one body param');
+            }
+        }
+    }
+    return QueueWithBase;
+}

package/lib/resolver/queue/external/external.d.ts

@@ -0,0 +1,25 @@
+import { DataAwsSqsQueue } from '@cdktn/provider-aws/lib/data-aws-sqs-queue';
+import { type AppModule } from '@lafken/resolver';
+import type { QueueProps } from '../queue.types';
+declare const ExternalQueue_base: {
+    new (...args: any[]): {
+        addEventSource(id: string, props: QueueProps): void;
+        validateEventParams(props: QueueProps): void;
+        readonly node: import("constructs").Node;
+        with(...mixins: import("constructs").IMixin[]): import("constructs").IConstruct;
+        toString(): string;
+        arn: string;
+    };
+} & (new (...args: any[]) => {
+    register(namespaces: import("@lafken/common").RegisterNamespaces | (string & {}), id: string): void;
+    onResolve(callback: () => void): void;
+    readonly node: import("constructs").Node;
+    with(...mixins: import("constructs").IMixin[]): import("constructs").IConstruct;
+    toString(): string;
+}) & typeof DataAwsSqsQueue;
+export declare class ExternalQueue extends ExternalQueue_base {
+    private props;
+    constructor(scope: AppModule, id: string, props: QueueProps);
+    private setName;
+}
+export {};

package/lib/resolver/queue/external/external.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExternalQueue = void 0;
+const data_aws_sqs_queue_1 = require("@cdktn/provider-aws/lib/data-aws-sqs-queue");
+const resolver_1 = require("@lafken/resolver");
+const base_1 = require("../base/base");
+const queue_utils_1 = require("../queue.utils");
+class ExternalQueue extends (0, base_1.QueueBase)(resolver_1.lafkenResource.make(data_aws_sqs_queue_1.DataAwsSqsQueue)) {
+    props;
+    constructor(scope, id, props) {
+        const { handler } = props;
+        super(scope, `${id}-queue`, {
+            name: '',
+        });
+        this.props = props;
+        this.setName();
+        if (handler.ref) {
+            this.register('queue', handler.ref);
+        }
+        this.validateEventParams(props);
+        this.addEventSource(id, props);
+    }
+    setName() {
+        const { handler } = this.props;
+        if (typeof handler.queueName === 'string') {
+            this.name = (0, queue_utils_1.sqsName)(handler.queueName, handler.isFifo ? '.fifo' : '');
+            return;
+        }
+        const queueName = (0, resolver_1.resolveCallbackResource)(this, handler.queueName);
+        if (!queueName) {
+            this.onResolve(() => {
+                this.setName();
+                if (!this.name) {
+                    throw new Error('Unresolved external queue name');
+                }
+            });
+            return;
+        }
+        this.name = queueName;
+    }
+}
+exports.ExternalQueue = ExternalQueue;

package/lib/resolver/queue/{queue.d.ts → internal/internal.d.ts}

@@ -1,20 +1,25 @@
 import { SqsQueue } from '@cdktn/provider-aws/lib/sqs-queue';
 import { type AppModule } from '@lafken/resolver';
-import type { QueueProps } from './queue.types';
-declare const Queue_base: (new (...args: any[]) => {
+import type { QueueProps } from '../queue.types';
+declare const InternalQueue_base: {
+    new (...args: any[]): {
+        addEventSource(id: string, props: QueueProps): void;
+        validateEventParams(props: QueueProps): void;
+        readonly node: import("constructs").Node;
+        with(...mixins: import("constructs").IMixin[]): import("constructs").IConstruct;
+        toString(): string;
+        arn: string;
+    };
+} & (new (...args: any[]) => {
     register(namespaces: import("@lafken/common").RegisterNamespaces | (string & {}), id: string): void;
     onResolve(callback: () => void): void;
     readonly node: import("constructs").Node;
     with(...mixins: import("constructs").IMixin[]): import("constructs").IConstruct;
     toString(): string;
 }) & typeof SqsQueue;
-export declare class Queue extends Queue_base {
+export declare class InternalQueue extends InternalQueue_base {
     private props;
     constructor(scope: AppModule, id: string, props: QueueProps);
     private addDeadLetterQueue;
-    private addEventSource;
-    private validateEventParams;
-    private getParams;
-    private validateParamType;
 }
 export {};

package/lib/resolver/queue/internal/internal.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalQueue = void 0;
+const sqs_queue_1 = require("@cdktn/provider-aws/lib/sqs-queue");
+const sqs_queue_redrive_policy_1 = require("@cdktn/provider-aws/lib/sqs-queue-redrive-policy");
+const resolver_1 = require("@lafken/resolver");
+const base_1 = require("../base/base");
+const queue_utils_1 = require("../queue.utils");
+class InternalQueue extends (0, base_1.QueueBase)(resolver_1.lafkenResource.make(sqs_queue_1.SqsQueue)) {
+    props;
+    constructor(scope, id, props) {
+        const { handler } = props;
+        super(scope, `${id}-queue`, {
+            name: (0, queue_utils_1.sqsName)(handler.queueName, handler.isFifo ? '.fifo' : ''),
+            fifoQueue: handler.isFifo,
+            contentBasedDeduplication: handler.contentBasedDeduplication,
+            visibilityTimeoutSeconds: handler.visibilityTimeout,
+            messageRetentionSeconds: handler.retentionPeriod,
+            maxMessageSize: handler.maxMessageSizeBytes,
+            delaySeconds: handler.deliveryDelay,
+        });
+        this.props = props;
+        if (handler.ref) {
+            this.register('queue', handler.ref);
+        }
+        this.addDeadLetterQueue(id);
+        this.validateEventParams(props);
+        this.addEventSource(id, props);
+        new resolver_1.ResourceOutput(this, handler.outputs);
+    }
+    addDeadLetterQueue(id) {
+        const { handler } = this.props;
+        if (!handler.dlq)
+            return;
+        const dlqName = (0, queue_utils_1.sqsName)(handler.queueName, `-dlq${handler.isFifo ? '.fifo' : ''}`);
+        const dlq = new sqs_queue_1.SqsQueue(this, `${id}-dlq`, {
+            name: dlqName,
+            fifoQueue: handler.isFifo,
+            messageRetentionSeconds: handler.dlq.retentionPeriod,
+        });
+        new sqs_queue_redrive_policy_1.SqsQueueRedrivePolicy(this, `${id}-redrive-policy`, {
+            queueUrl: this.url,
+            redrivePolicy: JSON.stringify({
+                deadLetterTargetArn: dlq.arn,
+                maxReceiveCount: handler.dlq.maxReceiveCount,
+            }),
+        });
+    }
+}
+exports.InternalQueue = InternalQueue;

package/lib/resolver/queue/queue.types.d.ts

@@ -1,7 +1,13 @@
 import type { ClassResource, ResourceMetadata } from '@lafken/common';
 import type { QueueLambdaMetadata } from '../../main';
-export interface QueueProps {
+export interface InternalQueueProps {
     handler: QueueLambdaMetadata;
     resourceMetadata: ResourceMetadata;
     classResource: ClassResource;
 }
+export interface ExternalQueueProps {
+    handler: QueueLambdaMetadata;
+    resourceMetadata: ResourceMetadata;
+    classResource: ClassResource;
+}
+export type QueueProps = InternalQueueProps | ExternalQueueProps;

package/lib/resolver/resolver.js

@@ -4,7 +4,8 @@ exports.QueueResolver = void 0;
 const common_1 = require("@lafken/common");
 const resolver_1 = require("@lafken/resolver");
 const main_1 = require("../main");
-const queue_1 = require("./queue/queue");
+const external_1 = require("./queue/external/external");
+const internal_1 = require("./queue/internal/internal");
 class QueueResolver {
     type = main_1.RESOURCE_TYPE;
     create(module, resource) {
@@ -19,7 +20,15 @@ class QueueResolver {
             methods: handlers.map((handler) => handler.name),
         });
         for (const handler of handlers) {
-            new queue_1.Queue(module, `${metadata.name}-${handler.name}`, {
+            if (handler.isExternal) {
+                new external_1.ExternalQueue(module, `${metadata.name}-${handler.name}`, {
+                    resourceMetadata: metadata,
+                    classResource: resource,
+                    handler,
+                });
+                return;
+            }
+            new internal_1.InternalQueue(module, `${metadata.name}-${handler.name}`, {
                 resourceMetadata: metadata,
                 classResource: resource,
                 handler,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lafken/queue",
-  "version": "0.11.19",
+  "version": "0.12.0",
   "private": false,
   "description": "Define SQS queues and consumers using TypeScript decorators - automatic infrastructure generation with Lafken",
   "keywords": [
@@ -52,30 +52,29 @@
     "lib"
   ],
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.1037.0",
-    "aws-lambda": "^1.0.7",
+    "@aws-sdk/client-sqs": "^3.1045.0",
     "reflect-metadata": "^0.2.2",
-    "@lafken/resolver": "0.11.19"
+    "@lafken/resolver": "0.12.0"
   },
   "devDependencies": {
-    "@cdktn/provider-aws": "^23.9.0",
-    "@swc/core": "^1.15.30",
+    "@cdktn/provider-aws": "^24.0.0",
+    "@swc/core": "^1.15.33",
     "@swc/helpers": "^0.5.21",
     "@types/aws-lambda": "^8.10.161",
     "@vitest/runner": "^4.1.5",
-    "cdktn": "^0.22.1",
+    "cdktn": "^0.23.0",
     "cdktn-vitest": "^1.0.0",
     "constructs": "^10.6.0",
     "typescript": "6.0.3",
     "unplugin-swc": "^1.5.9",
     "vitest": "^4.1.5",
-    "@lafken/common": "0.11.19"
+    "@lafken/common": "0.12.0"
   },
   "peerDependencies": {
     "@cdktn/provider-aws": ">=23.0.0",
     "cdktn": ">=0.22.0",
     "constructs": "^10.4.5",
-    "@lafken/common": "0.11.19"
+    "@lafken/common": "0.12.0"
   },
   "engines": {
     "node": ">=20.19"

package/lib/resolver/queue/queue.js

@@ -1,106 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Queue = void 0;
-const lambda_event_source_mapping_1 = require("@cdktn/provider-aws/lib/lambda-event-source-mapping");
-const sqs_queue_1 = require("@cdktn/provider-aws/lib/sqs-queue");
-const sqs_queue_redrive_policy_1 = require("@cdktn/provider-aws/lib/sqs-queue-redrive-policy");
-const common_1 = require("@lafken/common");
-const resolver_1 = require("@lafken/resolver");
-const queue_utils_1 = require("./queue.utils");
-const attributeAllowedTypes = new Set(['String', 'Number']);
-const bodyParsedTypes = new Set(['String', 'Object', 'Array']);
-const bodyUnparsedTypes = new Set(['String']);
-class Queue extends resolver_1.lafkenResource.make(sqs_queue_1.SqsQueue) {
-    props;
-    constructor(scope, id, props) {
-        const { handler } = props;
-        super(scope, `${id}-queue`, {
-            name: (0, queue_utils_1.sqsName)(handler.queueName, handler.isFifo ? '.fifo' : ''),
-            fifoQueue: handler.isFifo,
-            contentBasedDeduplication: handler.contentBasedDeduplication,
-            visibilityTimeoutSeconds: handler.visibilityTimeout,
-            messageRetentionSeconds: handler.retentionPeriod,
-            maxMessageSize: handler.maxMessageSizeBytes,
-            delaySeconds: handler.deliveryDelay,
-        });
-        this.props = props;
-        if (handler.ref) {
-            this.register('queue', handler.ref);
-        }
-        this.addDeadLetterQueue(id);
-        this.validateEventParams();
-        this.addEventSource(id);
-        new resolver_1.ResourceOutput(this, handler.outputs);
-    }
-    addDeadLetterQueue(id) {
-        const { handler } = this.props;
-        if (!handler.dlq)
-            return;
-        const dlqName = (0, queue_utils_1.sqsName)(handler.queueName, `-dlq${handler.isFifo ? '.fifo' : ''}`);
-        const dlq = new sqs_queue_1.SqsQueue(this, `${id}-dlq`, {
-            name: dlqName,
-            fifoQueue: handler.isFifo,
-            messageRetentionSeconds: handler.dlq.retentionPeriod,
-        });
-        new sqs_queue_redrive_policy_1.SqsQueueRedrivePolicy(this, `${id}-redrive-policy`, {
-            queueUrl: this.url,
-            redrivePolicy: JSON.stringify({
-                deadLetterTargetArn: dlq.arn,
-                maxReceiveCount: handler.dlq.maxReceiveCount,
-            }),
-        });
-    }
-    addEventSource(id) {
-        const { handler, resourceMetadata } = this.props;
-        const lambdaHandler = new resolver_1.LambdaHandler(this, `${id}-handler`, {
-            ...handler,
-            originalName: resourceMetadata.originalName,
-            filename: resourceMetadata.filename,
-            foldername: resourceMetadata.foldername,
-            suffix: 'queue',
-        });
-        new lambda_event_source_mapping_1.LambdaEventSourceMapping(this, 'event-mapping', {
-            batchSize: handler.batchSize,
-            eventSourceArn: this.arn,
-            functionName: lambdaHandler.arn,
-            maximumBatchingWindowInSeconds: handler.maxBatchingWindow,
-            functionResponseTypes: handler.isFifo ? ['ReportBatchItemFailures'] : undefined,
-            scalingConfig: handler.maxConcurrency
-                ? {
-                    maximumConcurrency: handler.maxConcurrency,
-                }
-                : undefined,
-            dependsOn: [lambdaHandler, this],
-        });
-    }
-    validateEventParams() {
-        const param = this.getParams();
-        if (!param) {
-            return;
-        }
-        let bodyCount = 0;
-        for (const property of param.properties) {
-            this.validateParamType(property);
-            if (property.source === 'body') {
-                bodyCount++;
-            }
-            if (bodyCount >= 2) {
-                throw new Error('Queue event only support one body param');
-            }
-        }
-    }
-    getParams() {
-        const { classResource, handler } = this.props;
-        const params = (0, common_1.getMetadataPrototypeByKey)(classResource, common_1.LambdaReflectKeys.event_param) || {};
-        return params[handler.name];
-    }
-    validateParamType(param) {
-        if (param.source === 'attribute' && !attributeAllowedTypes.has(param.type)) {
-            throw new Error(`Attribute params only support ${[...attributeAllowedTypes].join(', ')} values`);
-        }
-        if (param?.source === 'body' && !param.parse && !bodyUnparsedTypes.has(param.type)) {
-            throw new Error(`Body params only support ${[...bodyUnparsedTypes].join(', ')} values`);
-        }
-    }
-}
-exports.Queue = Queue;