@lafken/queue 0.14.1 → 0.14.3

package/lib/main/event/event.d.ts

@@ -1,5 +1,7 @@
 import type { ParamProps } from './event.types';
+/** Reflect-metadata key prefix for queue field metadata. */
 export declare const queueFieldKey: string;
+/** Reflect-metadata key prefix for queue payload metadata. */
 export declare const queuePayloadKey: string;
 /**
  * Class decorator that declares a class as an SQS message payload.

package/lib/main/event/event.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Event = exports.Field = exports.Param = exports.Payload = exports.queuePayloadKey = exports.queueFieldKey = void 0;
 const common_1 = require("@lafken/common");
 const queue_1 = require("../queue");
+/** Reflect-metadata key prefix for queue field metadata. */
 exports.queueFieldKey = (0, common_1.createFieldName)(queue_1.RESOURCE_TYPE, common_1.FieldProperties.field);
+/** Reflect-metadata key prefix for queue payload metadata. */
 exports.queuePayloadKey = (0, common_1.createFieldName)(queue_1.RESOURCE_TYPE, common_1.FieldProperties.payload);
 /**
  * Class decorator that declares a class as an SQS message payload.

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

@@ -95,26 +95,56 @@ export interface ParamRecordProps extends Omit<FieldProps, 'type' | 'name'> {
      */
     type?: StringConstructor;
 }
+/**
+ * Union of all supported parameter source configurations for SQS queue decorators.
+ * Each variant defines how the parameter value is extracted from the SQS event.
+ */
 export type ParamProps = ParamAttributeProps | ParamBodyUnparsedProps | ParamBodyParsedProps | ParamRecordProps;
+/**
+ * Extracted union of valid `source` values from {@link ParamProps}.
+ * Excludes `undefined` to represent concrete source discriminants.
+ */
 export type Source = Exclude<ParamProps['source'], undefined>;
+/**
+ * Internal base shape for all resolved SQS queue parameter metadata.
+ * Discriminated by `source` to indicate where the value comes from.
+ */
 interface QueueParamBase {
     source: Source;
     parse: boolean;
 }
+/** Resolved metadata for a string-typed SQS parameter. */
 export interface QueueStringParam extends StringField, QueueParamBase {
 }
+/** Resolved metadata for a number-typed SQS parameter. */
 export interface QueueNumberParam extends NumberField, QueueParamBase {
 }
+/** Resolved metadata for a boolean-typed SQS parameter. */
 export interface QueueBooleanParam extends BooleanField, QueueParamBase {
 }
+/**
+ * Resolved metadata for an object-typed SQS parameter.
+ * Nested properties are recursively described as {@link QueueParamMetadata}.
+ */
 export interface QueueObjectParam extends Omit<ObjectField, 'properties'>, QueueParamBase {
     properties: QueueParamMetadata[];
 }
+/**
+ * Resolved metadata for an array-typed SQS parameter.
+ * The element schema is described by a single {@link QueueParamMetadata} entry.
+ */
 export interface QueueArrayParam extends Omit<ArrayField, 'items'>, QueueParamBase {
     items: QueueParamMetadata;
 }
+/**
+ * Resolved metadata for an SQS parameter that extracts a raw record field.
+ */
 export interface QueueRecordParam extends StringField, QueueParamBase {
     source: 'record';
 }
+/**
+ * Discriminated union of all resolved SQS queue parameter metadata types.
+ * Used by the resolver to build the Lambda handler parameter mapping.
+ */
 export type QueueParamMetadata = QueueStringParam | QueueNumberParam | QueueBooleanParam | QueueObjectParam | QueueArrayParam | QueueRecordParam;
 export {};

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

@@ -137,6 +137,20 @@ export interface ExternalQueueProps extends SourceMappingProps {
     /**
      *
      */
+    /**
+     * Name or resolver function that resolves the name of the external SQS queue.
+     *
+     * Can be a literal queue name or a callback that receives `GetResourceProps`
+     * to dynamically resolve the queue identifier from another resource.
+     *
+     * @example
+     * // Literal name
+     * queueName: 'my-existing-queue'
+     *
+     * @example
+     * // Dynamic reference
+     * queueName: (props) => props.getResourceValue('module::queue::name', 'id')
+     */
     queueName: string | ((props: GetResourceProps) => string);
     /**
      * Lambda configuration for processing messages from this queue.
@@ -156,8 +170,15 @@ export interface InternalFifoProps extends InternalStandardProps {
 }
 export type StandardProps = InternalStandardProps | ExternalQueueProps;
 export type FifoProps = InternalFifoProps | ExternalQueueProps;
+/**
+ * Resolved metadata for an SQS queue Lambda handler, used internally
+ * by the resolver to generate the Lambda function and event source mapping.
+ */
 export interface QueueLambdaMetadata extends LambdaMetadata, Omit<InternalFifoProps, 'queueName' | 'isExternal'> {
+    /** Resolved queue name (literal or callback). */
     queueName: ExternalQueueProps['queueName'];
+    /** Whether this is a FIFO queue. */
     isFifo: boolean;
+    /** Whether this queue references an externally managed SQS resource. */
     isExternal: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lafken/queue",
-  "version": "0.14.1",
+  "version": "0.14.3",
   "private": false,
   "description": "Define SQS queues and consumers using TypeScript decorators - automatic infrastructure generation with Lafken",
   "keywords": [
@@ -57,7 +57,7 @@
   "dependencies": {
     "@aws-sdk/client-sqs": "^3.1106.0",
     "reflect-metadata": "^0.2.2",
-    "@lafken/resolver": "0.14.1"
+    "@lafken/resolver": "0.14.3"
   },
   "devDependencies": {
     "@cdktn/provider-aws": "^25.0.0",
@@ -71,13 +71,13 @@
     "typescript": "7.0.2",
     "unplugin-swc": "^1.5.10",
     "vitest": "^4.1.10",
-    "@lafken/common": "0.14.1"
+    "@lafken/common": "0.14.3"
   },
   "peerDependencies": {
     "@cdktn/provider-aws": ">=23.0.0",
     "cdktn": ">=0.22.0",
     "constructs": ">=10.7.0",
-    "@lafken/common": "0.14.1"
+    "@lafken/common": "0.14.3"
   },
   "engines": {
     "node": ">=20.19"