spoonfeeder 0.1.0

package/templates/recipes/cloud-aws/secrets-manager/src/infrastructure/aws/secrets.service.ts

@@ -0,0 +1,39 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { SecretsManagerClient, GetSecretValueCommand } from '@aws-sdk/client-secrets-manager';
+
+@Injectable()
+export class SecretsService {
+  private readonly client: SecretsManagerClient;
+  private readonly logger = new Logger(SecretsService.name);
+
+  constructor(private readonly configService: ConfigService) {
+    this.client = new SecretsManagerClient({
+      region: this.configService.get<string>('AWS_REGION', 'eu-west-1'),
+    });
+  }
+
+  async getSecret(secretId: string, versionStage = 'AWSCURRENT'): Promise<string> {
+    const result = await this.client.send(
+      new GetSecretValueCommand({
+        SecretId: secretId,
+        VersionStage: versionStage,
+      }),
+    );
+
+    if (!result.SecretString) {
+      throw new Error(`Secret "${secretId}" has no string value`);
+    }
+
+    this.logger.debug(`Retrieved secret: ${secretId}`);
+    return result.SecretString;
+  }
+
+  async getSecretJson<T = Record<string, unknown>>(
+    secretId: string,
+    versionStage = 'AWSCURRENT',
+  ): Promise<T> {
+    const raw = await this.getSecret(secretId, versionStage);
+    return JSON.parse(raw) as T;
+  }
+}

package/templates/recipes/cloud-aws/sns/README.md

@@ -0,0 +1,43 @@
+# AWS SNS
+
+Amazon Simple Notification Service integration for pub/sub messaging in NestJS.
+
+## Documentation
+
+- [AWS SNS Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/)
+- [@aws-sdk/client-sns on npm](https://www.npmjs.com/package/@aws-sdk/client-sns)
+- [NestJS Microservices](https://docs.nestjs.com/microservices/basics)
+
+## Dependencies
+
+| Package               | Version   | Purpose               |
+| --------------------- | --------- | --------------------- |
+| `@aws-sdk/client-sns` | `3.712.0` | AWS SDK v3 SNS client |
+
+## Environment Variables
+
+| Variable        | Default     | Description   |
+| --------------- | ----------- | ------------- |
+| `AWS_REGION`    | `eu-west-1` | AWS region    |
+| `SNS_TOPIC_ARN` | —           | SNS topic ARN |
+
+## Usage
+
+```typescript
+import { SnsService } from '@/aws/sns.service';
+
+@Injectable()
+export class NotificationPublisher {
+  constructor(private readonly sns: SnsService) {}
+
+  async publishOrderCreated(order: Order): Promise<void> {
+    await this.sns.publish({
+      TopicArn: this.configService.get('SNS_TOPIC_ARN'),
+      Message: JSON.stringify(order),
+      MessageAttributes: {
+        eventType: { DataType: 'String', StringValue: 'ORDER_CREATED' },
+      },
+    });
+  }
+}
+```

package/templates/recipes/cloud-aws/sns/src/infrastructure/aws/sns.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { SnsService } from './sns.service';
+
+@Module({
+  providers: [SnsService],
+  exports: [SnsService],
+})
+export class SnsModule {}

package/templates/recipes/cloud-aws/sns/src/infrastructure/aws/sns.service.ts

@@ -0,0 +1,48 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import {
+  SNSClient,
+  PublishCommand,
+  SubscribeCommand,
+  type MessageAttributeValue,
+} from '@aws-sdk/client-sns';
+
+@Injectable()
+export class SnsService {
+  private readonly client: SNSClient;
+  private readonly logger = new Logger(SnsService.name);
+
+  constructor(private readonly configService: ConfigService) {
+    this.client = new SNSClient({
+      region: this.configService.get<string>('AWS_REGION', 'eu-west-1'),
+    });
+  }
+
+  async publish(
+    topicArn: string,
+    message: string,
+    attributes?: Record<string, MessageAttributeValue>,
+  ): Promise<string> {
+    const result = await this.client.send(
+      new PublishCommand({
+        TopicArn: topicArn,
+        Message: message,
+        MessageAttributes: attributes,
+      }),
+    );
+    this.logger.debug(`Published message: ${result.MessageId}`);
+    return result.MessageId!;
+  }
+
+  async subscribe(topicArn: string, protocol: string, endpoint: string): Promise<string> {
+    const result = await this.client.send(
+      new SubscribeCommand({
+        TopicArn: topicArn,
+        Protocol: protocol,
+        Endpoint: endpoint,
+      }),
+    );
+    this.logger.debug(`Subscription created: ${result.SubscriptionArn}`);
+    return result.SubscriptionArn!;
+  }
+}

package/templates/recipes/cloud-aws/sqs/README.md

@@ -0,0 +1,47 @@
+# AWS SQS
+
+Amazon Simple Queue Service integration for reliable message queuing in NestJS.
+
+## Documentation
+
+- [AWS SQS Developer Guide](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/)
+- [@aws-sdk/client-sqs on npm](https://www.npmjs.com/package/@aws-sdk/client-sqs)
+- [NestJS Microservices — Custom Transporters](https://docs.nestjs.com/microservices/custom-transport)
+
+## Dependencies
+
+| Package               | Version   | Purpose               |
+| --------------------- | --------- | --------------------- |
+| `@aws-sdk/client-sqs` | `3.712.0` | AWS SDK v3 SQS client |
+
+## Environment Variables
+
+| Variable        | Default     | Description   |
+| --------------- | ----------- | ------------- |
+| `AWS_REGION`    | `eu-west-1` | AWS region    |
+| `SQS_QUEUE_URL` | —           | SQS queue URL |
+
+## Usage
+
+```typescript
+import { SqsService } from '@/infrastructure/aws/sqs.service';
+
+@Injectable()
+export class OrderProcessor {
+  constructor(
+    private readonly sqs: SqsService,
+    private readonly configService: ConfigService,
+  ) {}
+
+  async enqueue(order: Order): Promise<void> {
+    const queueUrl = this.configService.get<string>('SQS_QUEUE_URL');
+    await this.sqs.sendMessage(queueUrl, JSON.stringify(order));
+  }
+
+  async poll(): Promise<Order[]> {
+    const queueUrl = this.configService.get<string>('SQS_QUEUE_URL');
+    const messages = await this.sqs.receiveMessages(queueUrl, 10, 20);
+    return messages.map((m) => JSON.parse(m.Body!));
+  }
+}
+```

package/templates/recipes/cloud-aws/sqs/src/infrastructure/aws/sqs.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { SqsService } from './sqs.service';
+
+@Module({
+  providers: [SqsService],
+  exports: [SqsService],
+})
+export class SqsModule {}

package/templates/recipes/cloud-aws/sqs/src/infrastructure/aws/sqs.service.ts

@@ -0,0 +1,58 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import {
+  SQSClient,
+  SendMessageCommand,
+  ReceiveMessageCommand,
+  DeleteMessageCommand,
+  type Message,
+} from '@aws-sdk/client-sqs';
+
+@Injectable()
+export class SqsService {
+  private readonly client: SQSClient;
+  private readonly logger = new Logger(SqsService.name);
+
+  constructor(private readonly configService: ConfigService) {
+    this.client = new SQSClient({
+      region: this.configService.get<string>('AWS_REGION', 'eu-west-1'),
+    });
+  }
+
+  async sendMessage(queueUrl: string, body: string, groupId?: string): Promise<string> {
+    const result = await this.client.send(
+      new SendMessageCommand({
+        QueueUrl: queueUrl,
+        MessageBody: body,
+        MessageGroupId: groupId,
+      }),
+    );
+    this.logger.debug(`Message sent: ${result.MessageId}`);
+    return result.MessageId!;
+  }
+
+  async receiveMessages(
+    queueUrl: string,
+    maxMessages = 10,
+    waitTimeSeconds = 20,
+  ): Promise<Message[]> {
+    const result = await this.client.send(
+      new ReceiveMessageCommand({
+        QueueUrl: queueUrl,
+        MaxNumberOfMessages: maxMessages,
+        WaitTimeSeconds: waitTimeSeconds,
+      }),
+    );
+    return result.Messages ?? [];
+  }
+
+  async deleteMessage(queueUrl: string, receiptHandle: string): Promise<void> {
+    await this.client.send(
+      new DeleteMessageCommand({
+        QueueUrl: queueUrl,
+        ReceiptHandle: receiptHandle,
+      }),
+    );
+    this.logger.debug(`Message deleted from ${queueUrl}`);
+  }
+}

package/templates/recipes/cloud-aws/ssm/README.md

@@ -0,0 +1,41 @@
+# AWS SSM Parameter Store
+
+Retrieve configuration from AWS Systems Manager Parameter Store in NestJS.
+
+## Documentation
+
+- [AWS SSM Parameter Store User Guide](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html)
+- [@aws-sdk/client-ssm on npm](https://www.npmjs.com/package/@aws-sdk/client-ssm)
+- [NestJS Configuration](https://docs.nestjs.com/techniques/configuration)
+
+## Dependencies
+
+| Package               | Version   | Purpose               |
+| --------------------- | --------- | --------------------- |
+| `@aws-sdk/client-ssm` | `3.712.0` | AWS SDK v3 SSM client |
+
+## Environment Variables
+
+| Variable     | Default     | Description               |
+| ------------ | ----------- | ------------------------- |
+| `AWS_REGION` | `eu-west-1` | AWS region                |
+| `SSM_PREFIX` | `/app/prod` | SSM parameter path prefix |
+
+## Usage
+
+```typescript
+import { SsmService } from '@/aws/ssm.service';
+
+@Injectable()
+export class AppConfig {
+  constructor(private readonly ssm: SsmService) {}
+
+  async loadParameters(): Promise<Map<string, string>> {
+    return this.ssm.getParametersByPath(this.configService.get('SSM_PREFIX'));
+  }
+
+  async getParameter(name: string): Promise<string> {
+    return this.ssm.getParameter(`${this.configService.get('SSM_PREFIX')}/${name}`);
+  }
+}
+```

package/templates/recipes/cloud-aws/ssm/src/infrastructure/aws/ssm.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { SsmService } from './ssm.service';
+
+@Module({
+  providers: [SsmService],
+  exports: [SsmService],
+})
+export class SsmModule {}

package/templates/recipes/cloud-aws/ssm/src/infrastructure/aws/ssm.service.ts

@@ -0,0 +1,54 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import {
+  SSMClient,
+  GetParameterCommand,
+  PutParameterCommand,
+  type ParameterType,
+} from '@aws-sdk/client-ssm';
+
+@Injectable()
+export class SsmService {
+  private readonly client: SSMClient;
+  private readonly logger = new Logger(SsmService.name);
+
+  constructor(private readonly configService: ConfigService) {
+    this.client = new SSMClient({
+      region: this.configService.get<string>('AWS_REGION', 'eu-west-1'),
+    });
+  }
+
+  async getParameter(name: string, withDecryption = true): Promise<string> {
+    const result = await this.client.send(
+      new GetParameterCommand({
+        Name: name,
+        WithDecryption: withDecryption,
+      }),
+    );
+
+    if (!result.Parameter?.Value) {
+      throw new Error(`Parameter "${name}" not found or has no value`);
+    }
+
+    this.logger.debug(`Retrieved parameter: ${name}`);
+    return result.Parameter.Value;
+  }
+
+  async putParameter(
+    name: string,
+    value: string,
+    type: ParameterType = 'String',
+    overwrite = true,
+  ): Promise<number> {
+    const result = await this.client.send(
+      new PutParameterCommand({
+        Name: name,
+        Value: value,
+        Type: type,
+        Overwrite: overwrite,
+      }),
+    );
+    this.logger.debug(`Put parameter: ${name} (version ${result.Version})`);
+    return result.Version!;
+  }
+}

package/templates/recipes/cloud-azure/README.md

@@ -0,0 +1,18 @@
+# Azure Cloud Recipes
+
+Microsoft Azure integrations for NestJS applications.
+
+## Recipes
+
+| Recipe                                  | Description                        |
+| --------------------------------------- | ---------------------------------- |
+| [Application Insights](./app-insights/) | Telemetry and monitoring           |
+| [Blob Storage](./blob-storage/)         | Object storage for files           |
+| [Cache for Redis](./cache/)             | Managed Redis caching service      |
+| [Cosmos DB](./cosmos-db/)               | NoSQL database                     |
+| [Entra ID](./entra-id/)                 | Authentication (formerly Azure AD) |
+| [Front Door](./front-door/)             | CDN and global load balancer       |
+| [Functions](./functions/)               | Serverless NestJS workloads        |
+| [Key Vault](./key-vault/)               | Secret and key management          |
+| [Service Bus](./service-bus/)           | Enterprise messaging               |
+| [SQL Database](./sql-database/)         | Managed SQL database connection    |

package/templates/recipes/cloud-azure/app-insights/README.md

@@ -0,0 +1,50 @@
+# Azure Application Insights
+
+Azure Application Insights for telemetry and monitoring in NestJS.
+
+## Documentation
+
+- [Azure Application Insights Documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview)
+- [applicationinsights on npm](https://www.npmjs.com/package/applicationinsights)
+- [NestJS Logger](https://docs.nestjs.com/techniques/logger)
+
+## Dependencies
+
+| Package               | Version | Purpose                              |
+| --------------------- | ------- | ------------------------------------ |
+| `applicationinsights` | `3.4.0` | Application Insights SDK for Node.js |
+
+## Environment Variables
+
+| Variable                                | Default | Description                            |
+| --------------------------------------- | ------- | -------------------------------------- |
+| `APPLICATIONINSIGHTS_CONNECTION_STRING` | —       | Application Insights connection string |
+
+## Usage
+
+```typescript
+import * as appInsights from 'applicationinsights';
+
+// Initialize before NestJS bootstrap
+appInsights
+  .setup(process.env.APPLICATIONINSIGHTS_CONNECTION_STRING)
+  .setAutoCollectRequests(true)
+  .setAutoCollectPerformance(true)
+  .setAutoCollectExceptions(true)
+  .setAutoCollectDependencies(true)
+  .start();
+
+// In services, use the TelemetryClient for custom events
+@Injectable()
+export class TelemetryService {
+  private client = appInsights.defaultClient;
+
+  trackEvent(name: string, properties?: Record<string, string>): void {
+    this.client.trackEvent({ name, properties });
+  }
+
+  trackMetric(name: string, value: number): void {
+    this.client.trackMetric({ name, value });
+  }
+}
+```

package/templates/recipes/cloud-azure/app-insights/src/infrastructure/azure/app-insights.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+
+import { AppInsightsService } from './app-insights.service';
+
+@Module({
+  imports: [ConfigModule],
+  providers: [AppInsightsService],
+  exports: [AppInsightsService],
+})
+export class AppInsightsModule {}

package/templates/recipes/cloud-azure/app-insights/src/infrastructure/azure/app-insights.service.ts

@@ -0,0 +1,38 @@
+import { Injectable, Logger, OnModuleInit } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import * as appInsights from 'applicationinsights';
+
+@Injectable()
+export class AppInsightsService implements OnModuleInit {
+  private readonly logger = new Logger(AppInsightsService.name);
+  private client!: appInsights.TelemetryClient;
+
+  constructor(private readonly config: ConfigService) {}
+
+  onModuleInit(): void {
+    const connectionString = this.config.getOrThrow<string>(
+      'APPLICATIONINSIGHTS_CONNECTION_STRING',
+    );
+
+    appInsights
+      .setup(connectionString)
+      .setAutoCollectRequests(true)
+      .setAutoCollectExceptions(true)
+      .start();
+
+    this.client = appInsights.defaultClient;
+    this.logger.log('Application Insights initialized');
+  }
+
+  trackEvent(name: string, properties?: Record<string, string>): void {
+    this.client.trackEvent({ name, properties });
+  }
+
+  trackException(error: Error, properties?: Record<string, string>): void {
+    this.client.trackException({ exception: error, properties });
+  }
+
+  trackMetric(name: string, value: number): void {
+    this.client.trackMetric({ name, value });
+  }
+}

package/templates/recipes/cloud-azure/blob-storage/README.md

@@ -0,0 +1,49 @@
+# Azure Blob Storage
+
+Azure Blob Storage for object storage in NestJS.
+
+## Documentation
+
+- [Azure Blob Storage Documentation](https://learn.microsoft.com/en-us/azure/storage/blobs/)
+- [@azure/storage-blob on npm](https://www.npmjs.com/package/@azure/storage-blob)
+- [@azure/identity on npm](https://www.npmjs.com/package/@azure/identity)
+- [NestJS File Upload](https://docs.nestjs.com/techniques/file-upload)
+
+## Dependencies
+
+| Package               | Version   | Purpose                           |
+| --------------------- | --------- | --------------------------------- |
+| `@azure/storage-blob` | `12.26.0` | Azure Blob Storage client         |
+| `@azure/identity`     | `4.5.0`   | Azure identity and authentication |
+
+## Environment Variables
+
+| Variable                          | Default   | Description                     |
+| --------------------------------- | --------- | ------------------------------- |
+| `AZURE_STORAGE_CONNECTION_STRING` | —         | Azure Storage connection string |
+| `AZURE_STORAGE_CONTAINER`         | `uploads` | Blob container name             |
+
+## Usage
+
+```typescript
+import { BlobStorageService } from '@/azure/blob-storage.service';
+
+@Injectable()
+export class FileUploader {
+  constructor(private readonly blobStorage: BlobStorageService) {}
+
+  async upload(fileName: string, content: Buffer, contentType: string): Promise<string> {
+    await this.blobStorage.uploadBlob(
+      this.configService.get('AZURE_STORAGE_CONTAINER'),
+      fileName,
+      content,
+      contentType,
+    );
+    return this.blobStorage.generateSasUrl(
+      this.configService.get('AZURE_STORAGE_CONTAINER'),
+      fileName,
+      3600,
+    );
+  }
+}
+```

package/templates/recipes/cloud-azure/blob-storage/src/infrastructure/azure/blob-storage.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+
+import { BlobStorageService } from './blob-storage.service';
+
+@Module({
+  imports: [ConfigModule],
+  providers: [BlobStorageService],
+  exports: [BlobStorageService],
+})
+export class BlobStorageModule {}

package/templates/recipes/cloud-azure/blob-storage/src/infrastructure/azure/blob-storage.service.ts

@@ -0,0 +1,64 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import {
+  BlobServiceClient,
+  BlockBlobClient,
+  BlobSASPermissions,
+  generateBlobSASQueryParameters,
+  StorageSharedKeyCredential,
+} from '@azure/storage-blob';
+
+@Injectable()
+export class BlobStorageService {
+  private readonly logger = new Logger(BlobStorageService.name);
+  private readonly blobServiceClient: BlobServiceClient;
+  private readonly accountName: string;
+  private readonly accountKey: string;
+
+  constructor(private readonly config: ConfigService) {
+    this.accountName = this.config.getOrThrow<string>('AZURE_STORAGE_ACCOUNT_NAME');
+    this.accountKey = this.config.getOrThrow<string>('AZURE_STORAGE_ACCOUNT_KEY');
+
+    const credential = new StorageSharedKeyCredential(this.accountName, this.accountKey);
+    this.blobServiceClient = new BlobServiceClient(
+      `https://${this.accountName}.blob.core.windows.net`,
+      credential,
+    );
+  }
+
+  async upload(container: string, blobName: string, data: Buffer): Promise<void> {
+    const client = this.getBlockBlobClient(container, blobName);
+    await client.uploadData(data);
+    this.logger.log(`Uploaded blob "${blobName}" to "${container}"`);
+  }
+
+  async download(container: string, blobName: string): Promise<Buffer> {
+    const client = this.getBlockBlobClient(container, blobName);
+    const response = await client.downloadToBuffer();
+    this.logger.log(`Downloaded blob "${blobName}" from "${container}"`);
+    return response;
+  }
+
+  generateSasUrl(container: string, blobName: string, expiresInMinutes = 60): string {
+    const credential = new StorageSharedKeyCredential(this.accountName, this.accountKey);
+    const startsOn = new Date();
+    const expiresOn = new Date(startsOn.getTime() + expiresInMinutes * 60_000);
+
+    const sasToken = generateBlobSASQueryParameters(
+      {
+        containerName: container,
+        blobName,
+        permissions: BlobSASPermissions.parse('r'),
+        startsOn,
+        expiresOn,
+      },
+      credential,
+    ).toString();
+
+    return `https://${this.accountName}.blob.core.windows.net/${container}/${blobName}?${sasToken}`;
+  }
+
+  private getBlockBlobClient(container: string, blobName: string): BlockBlobClient {
+    return this.blobServiceClient.getContainerClient(container).getBlockBlobClient(blobName);
+  }
+}

package/templates/recipes/cloud-azure/cache/README.md

@@ -0,0 +1,47 @@
+# Azure Cache for Redis
+
+Azure Cache for Redis managed caching service integration for NestJS.
+
+## Documentation
+
+- [Azure Cache for Redis Documentation](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/)
+- [ioredis on npm](https://www.npmjs.com/package/ioredis)
+- [NestJS Caching](https://docs.nestjs.com/techniques/caching)
+
+## Dependencies
+
+| Package   | Version | Purpose                  |
+| --------- | ------- | ------------------------ |
+| `ioredis` | `5.4.2` | Redis client for Node.js |
+
+## Environment Variables
+
+| Variable               | Default | Description                      |
+| ---------------------- | ------- | -------------------------------- |
+| `AZURE_REDIS_HOST`     | —       | Azure Cache for Redis hostname   |
+| `AZURE_REDIS_PORT`     | `6380`  | Azure Cache for Redis port (TLS) |
+| `AZURE_REDIS_PASSWORD` | —       | Azure Cache for Redis access key |
+
+## Usage
+
+```typescript
+import Redis from 'ioredis';
+
+@Module({
+  providers: [
+    {
+      provide: 'REDIS_CLIENT',
+      useFactory: (config: ConfigService) =>
+        new Redis({
+          host: config.getOrThrow('AZURE_REDIS_HOST'),
+          port: config.get<number>('AZURE_REDIS_PORT', 6380),
+          password: config.get('AZURE_REDIS_PASSWORD'),
+          tls: { servername: config.getOrThrow('AZURE_REDIS_HOST') },
+        }),
+      inject: [ConfigService],
+    },
+  ],
+  exports: ['REDIS_CLIENT'],
+})
+export class RedisModule {}
+```

package/templates/recipes/cloud-azure/cache/src/infrastructure/azure/redis.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+
+import { RedisService } from './redis.service';
+
+@Module({
+  imports: [ConfigModule],
+  providers: [RedisService],
+  exports: [RedisService],
+})
+export class RedisModule {}