@lafken/common 0.11.8 → 0.11.10

package/lib/decorators/lambda/lambda.types.d.ts

@@ -1,5 +1,6 @@
-import type { EnvironmentValue, GetResourceProps } from '../../types';
+import type { EnvironmentValue, GetResourceProps, LambdaReferenceNames, ResourceOutputType } from '../../types';
 import type { ServicesValues } from '../../types/services.types';
+export type LambdaOutputAttributes = 'arn' | 'invokeArn' | 'qualifiedArn';
 export interface VpcConfig {
     /**
      * Enables IPv6 for dual-stack networking.
@@ -51,6 +52,43 @@ export interface AliasConfig {
      */
     provisionedExecutions?: number;
 }
+export interface LoggingConfig {
+    /**
+     * Log format for the Lambda function.
+     *
+     * Controls the format of the log records written to CloudWatch.
+     * - `'Text'`: Unstructured text output (default Lambda behaviour).
+     * - `'JSON'`: Structured JSON records, enabling `applicationLogLevel`
+     *             and `systemLogLevel`.
+     */
+    logFormat: 'text' | 'json';
+    /**
+     * Log retention period in days.
+     *
+     * Specifies the number of days to retain Lambda invocation logs
+     * in the CloudWatch Log Group before they are automatically deleted.
+     * When omitted, the log group never expires.
+     */
+    retentionInDays?: number;
+    /**
+     * Application-level log verbosity.
+     *
+     * Only valid when `logFormat` is `'json'`.
+     * Controls the level of logs emitted by your function code.
+     *
+     * Supported values: `'trace'` | `'debug'` | `'info'` | `'warn'` | `'error'` | `'fatal'`
+     */
+    applicationLogLevel?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+    /**
+     * System-level log verbosity.
+     *
+     * Only valid when `logFormat` is `'json'`.
+     * Controls the level of logs emitted by the Lambda runtime itself.
+     *
+     * Supported values: `'debug'` | `'info'` | `'warn'`
+     */
+    systemLogLevel?: 'debug' | 'info' | 'warn';
+}
 export interface LambdaProps {
     /**
      * Lambda execution timeout.
@@ -170,6 +208,34 @@ export interface LambdaProps {
      * { name: 'live', provisionedExecutions: 5 }
      */
     alias?: AliasConfig;
+    /**
+     * Logging configuration for the Lambda function.
+     *
+     * When provided, configures the CloudWatch logging behaviour for the
+     * Lambda function. If `logGroup` is specified, a `CloudwatchLogGroup`
+     * resource will be created and linked automatically.
+     *
+     * @example
+     * { logFormat: 'Text', logGroup: { name: '/aws/lambda/my-fn', retentionInDays: 30 } }
+     *
+     * @example
+     * { logFormat: 'JSON', applicationLogLevel: 'WARN', systemLogLevel: 'INFO' }
+     */
+    loggingConfig?: LoggingConfig;
+    /**
+     * Output configuration for the Lambda function.
+     *
+     * Defines which attributes should be exported to SSM Parameter Store or
+     * as Terraform outputs. Supported attributes: `'arn'`, `'invokeArn'`, `'qualifiedArn'`.
+     */
+    outputs?: ResourceOutputType<LambdaOutputAttributes>;
+    /**
+     * Registers this Lambda as a named global reference.
+     *
+     * Allows other resources to look up this function by name via
+     * `lafkenResource.getResource('lambda', ref)`.
+     */
+    ref?: LambdaReferenceNames;
 }
 export interface LambdaMetadata {
     name: string;

package/lib/types/output.types.d.ts

@@ -1,4 +1,4 @@
-export type OutputType = 'arn' | 'id';
+export type OutputType = 'arn' | 'id' | (string & {});
 export type GetResourceValue<T = string, V = OutputType> = (value: T, type: V) => any;
 /**
  * Common fields shared by all resource output definitions.

package/lib/types/override-resources.types.d.ts

@@ -1,39 +1,31 @@
-import type { ResourceIdentifiers, ScopedResourceNames } from './utilities.types';
-export type ModuleGlobalReferenceNames = 'api' | 'user-pool' | 'user-pool-client' | 'bucket' | 'dynamo' | 'event-bus' | 'resource';
-export interface ModulesAvailable {
-}
-export interface AuthAvailable {
-}
-export interface BucketAvailable {
-}
-export interface ApiRestAvailable {
-}
-export interface ApiAuthorizerAvailable {
-}
-export interface EventBusAvailable {
-}
-export interface DynamoTableAvailable {
-}
-export interface ResourceAvailable {
-}
-type ResourceNames<T> = keyof T | (string & {});
-type StackResourceName<T, S extends ModuleGlobalReferenceNames> = `${S}::${Extract<keyof T, string | number>}` | (string & {});
-export type ModuleNames = ResourceNames<ModulesAvailable>;
-export type AuthNames = ResourceNames<AuthAvailable>;
-export type UserPoolScopedNames = StackResourceName<AuthAvailable, 'user-pool'>;
-export type UserPoolClientScopedNames = StackResourceName<AuthAvailable, 'user-pool-client'>;
-export type BucketNames = ResourceNames<BucketAvailable>;
-export type ResourcesScopedNames = StackResourceName<ResourceAvailable, 'resource'>;
-export type BucketScopedNames = StackResourceName<BucketAvailable, 'bucket'>;
-export type ApiRestNames = ResourceNames<ApiRestAvailable>;
-export type ApiRestScopedNames = StackResourceName<ApiRestAvailable, 'api'>;
-export type ApiAuthorizerNames = ResourceNames<ApiAuthorizerAvailable>;
-export type EventBusNames = ResourceNames<EventBusAvailable>;
-export type EventBusScopedNames = StackResourceName<EventBusAvailable, 'event-bus'>;
-export type DynamoTableNames = ResourceNames<DynamoTableAvailable>;
-export type DynamoTableScopedNames = StackResourceName<DynamoTableAvailable, 'dynamo'>;
-export type StateMachineNames = ResourceIdentifiers<ModulesAvailable, 'StateMachine'> | (string & {});
-export type StateMachineScopedNames = ScopedResourceNames<ModulesAvailable, 'StateMachine', 'state-machine'> | (string & {});
-export type QueueNames = ResourceIdentifiers<ModulesAvailable, 'Queue'> | (string & {});
-export type QueueScopedNames = ScopedResourceNames<ModulesAvailable, 'Queue', 'queue'> | (string & {});
-export {};
+export interface SharedResourceNames {
+}
+export interface SharedReferenceResources {
+}
+export type ResourceScopedKeys<T> = {
+    [Scope in keyof T]: `${Scope & string}::${T[Scope] & string}`;
+}[keyof T];
+export type ResourceScopeKeys<T, Scope extends string> = T extends Record<Scope, string> ? T[Scope] : string & {};
+export type AvailableReference = [keyof SharedReferenceResources] extends [never] ? string : ResourceScopedKeys<SharedReferenceResources>;
+export type ApiNames = ResourceScopeKeys<SharedResourceNames, 'api'>;
+export type ApiReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'api'>;
+export type BucketNames = ResourceScopeKeys<SharedResourceNames, 'bucket'>;
+export type BucketReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'bucket'>;
+export type DynamoTableNames = ResourceScopeKeys<SharedResourceNames, 'dynamo'>;
+export type DynamoReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'dynamo'>;
+export type StateMachineNames = ResourceScopeKeys<SharedResourceNames, 'state-machine'>;
+export type StateMachineReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'state-machine'>;
+export type EventBusNames = ResourceScopeKeys<SharedResourceNames, 'event-bus'>;
+export type EventBusReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'event-bus'>;
+export type EventRuleReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'event-rule'>;
+export type QueueNames = ResourceScopeKeys<SharedResourceNames, 'queue'>;
+export type QueueReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'queue'>;
+export type UserPoolNames = ResourceScopeKeys<SharedResourceNames, 'user-pool'>;
+export type UserPoolReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'user-pool'>;
+export type UserPoolClientNames = ResourceScopeKeys<SharedResourceNames, 'user-pool-client'>;
+export type UserPoolClientReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'user-pool-client'>;
+export type ApiAuthorizerNames = ResourceScopeKeys<SharedResourceNames, 'api-authorizer'>;
+export type ScheduleReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'schedule'>;
+export type LambdaNames = ResourceScopeKeys<SharedResourceNames, 'lambda'>;
+export type LambdaReferenceNames = ResourceScopeKeys<SharedReferenceResources, 'lambda'>;
+export type RegisterNamespaces = 'api' | 'bucket' | 'dynamo' | 'state-machine' | 'queue' | 'authentication' | 'api-authorizer' | 'user-pool' | 'user-pool-client' | 'schedule' | 'event-bus' | 'event-rule' | 'lambda' | (string & {});

package/lib/types/resource.types.d.ts

@@ -1,5 +1,5 @@
 import type { GetResourceValue } from './output.types';
-import type { ApiRestScopedNames, BucketScopedNames, DynamoTableScopedNames, EventBusScopedNames, QueueScopedNames, ResourcesScopedNames, StateMachineScopedNames, UserPoolClientScopedNames, UserPoolScopedNames } from './override-resources.types';
+import type { AvailableReference } from './override-resources.types';
 export interface ClassResource {
     new (...args: any[]): {};
 }
@@ -272,7 +272,7 @@ export interface GetResourceProps {
      * // Get a bucket ARN
      * getResourceValue('bucket::uploads', 'arn')
      */
-    getResourceValue: GetResourceValue<DynamoTableScopedNames | UserPoolScopedNames | UserPoolClientScopedNames | BucketScopedNames | ApiRestScopedNames | EventBusScopedNames | StateMachineScopedNames | QueueScopedNames | ResourcesScopedNames>;
+    getResourceValue: GetResourceValue<AvailableReference>;
     /**
      * Retrieves a value from AWS Systems Manager Parameter Store.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lafken/common",
-  "version": "0.11.8",
+  "version": "0.11.10",
   "private": false,
   "description": "Lafken utilities - TypeScript decorator factories and metadata reflection for infrastructure-as-code decorators",
   "keywords": [
@@ -31,13 +31,13 @@
     "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
-    "@swc/core": "^1.15.21",
-    "@swc/helpers": "^0.5.20",
-    "@vitest/runner": "^4.1.2",
+    "@swc/core": "^1.15.30",
+    "@swc/helpers": "^0.5.21",
+    "@vitest/runner": "^4.1.5",
     "cdktn-vitest": "^1.0.0",
-    "typescript": "6.0.2",
+    "typescript": "6.0.3",
     "unplugin-swc": "^1.5.9",
-    "vitest": "^4.1.2"
+    "vitest": "^4.1.5"
   },
   "engines": {
     "node": ">=20.19"