@hazeljs/serverless 0.2.0-alpha.1

package/LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2024 HazelJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,493 @@
+# @hazeljs/serverless
+
+**Deploy to Lambda or Cloud Functions. Zero code changes.**
+
+Same HazelJS app, same controllers, same routing. Wrap it and ship. Cold start optimization, request mapping, env handling — built in.
+
+[![npm version](https://img.shields.io/npm/v/@hazeljs/serverless.svg)](https://www.npmjs.com/package/@hazeljs/serverless)
+[![npm downloads](https://img.shields.io/npm/dm/@hazeljs/serverless)](https://www.npmjs.com/package/@hazeljs/serverless)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+## Features
+
+- ☁️ **AWS Lambda** - Deploy to AWS Lambda
+- 🌐 **Google Cloud Functions** - Deploy to GCP
+- 🔄 **Zero Config** - No code changes needed
+- 🎯 **Cold Start Optimization** - Minimize cold start times
+- 📊 **Request/Response Mapping** - Automatic event transformation
+- 🔐 **Environment Variables** - Seamless config management
+- 🎨 **Decorator Support** - `@Serverless` decorator
+- 📦 **Bundle Optimization** - Tree-shaking and minification
+
+## Installation
+
+```bash
+npm install @hazeljs/serverless
+```
+
+## AWS Lambda
+
+### Quick Start
+
+```typescript
+// lambda.ts
+import { createLambdaHandler } from '@hazeljs/serverless';
+import { AppModule } from './app.module';
+
+export const handler = createLambdaHandler(AppModule);
+```
+
+### With Options
+
+```typescript
+import { createLambdaHandler } from '@hazeljs/serverless';
+import { AppModule } from './app.module';
+
+export const handler = createLambdaHandler(AppModule, {
+  // Enable binary response
+  binaryMimeTypes: ['image/*', 'application/pdf'],
+  
+  // Custom initialization
+  onInit: async (app) => {
+    console.log('Lambda initialized');
+  },
+  
+  // Custom error handling
+  onError: (error) => {
+    console.error('Lambda error:', error);
+  },
+});
+```
+
+### Deployment
+
+#### Using AWS SAM
+
+```yaml
+# template.yaml
+AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+
+Resources:
+  HazelFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: dist/
+      Handler: lambda.handler
+      Runtime: nodejs20.x
+      MemorySize: 512
+      Timeout: 30
+      Environment:
+        Variables:
+          NODE_ENV: production
+          DATABASE_URL: !Ref DatabaseUrl
+      Events:
+        ApiEvent:
+          Type: Api
+          Properties:
+            Path: /{proxy+}
+            Method: ANY
+```
+
+Deploy:
+
+```bash
+npm run build
+sam build
+sam deploy --guided
+```
+
+#### Using Serverless Framework
+
+```yaml
+# serverless.yml
+service: hazeljs-app
+
+provider:
+  name: aws
+  runtime: nodejs20.x
+  stage: ${opt:stage, 'dev'}
+  region: us-east-1
+  environment:
+    NODE_ENV: ${self:provider.stage}
+    DATABASE_URL: ${env:DATABASE_URL}
+
+functions:
+  api:
+    handler: dist/lambda.handler
+    events:
+      - http:
+          path: /{proxy+}
+          method: ANY
+          cors: true
+
+package:
+  individually: true
+  patterns:
+    - '!node_modules/**'
+    - 'node_modules/@hazeljs/**'
+    - 'dist/**'
+```
+
+Deploy:
+
+```bash
+npm run build
+serverless deploy
+```
+
+## Google Cloud Functions
+
+### Quick Start
+
+```typescript
+// index.ts
+import { createCloudFunctionHandler } from '@hazeljs/serverless';
+import { AppModule } from './app.module';
+
+export const hazelApp = createCloudFunctionHandler(AppModule);
+```
+
+### With Options
+
+```typescript
+import { createCloudFunctionHandler } from '@hazeljs/serverless';
+import { AppModule } from './app.module';
+
+export const hazelApp = createCloudFunctionHandler(AppModule, {
+  // Custom initialization
+  onInit: async (app) => {
+    console.log('Cloud Function initialized');
+  },
+  
+  // Custom error handling
+  onError: (error) => {
+    console.error('Cloud Function error:', error);
+  },
+});
+```
+
+**Event handler (Pub/Sub, Storage):** `createCloudFunctionEventHandler(Module)` returns a stub that initializes the app and logs the event but does not route to user code. Implement your own event handling and call it from that handler, or use a separate entrypoint for event-triggered functions.
+
+### Deployment
+
+#### Using gcloud CLI
+
+```bash
+# Build
+npm run build
+
+# Deploy
+gcloud functions deploy hazeljs-app \
+  --runtime nodejs20 \
+  --trigger-http \
+  --allow-unauthenticated \
+  --entry-point hazelApp \
+  --source dist \
+  --set-env-vars NODE_ENV=production,DATABASE_URL=your-db-url
+```
+
+#### Using Cloud Functions YAML
+
+```yaml
+# function.yaml
+runtime: nodejs20
+entryPoint: hazelApp
+environmentVariables:
+  NODE_ENV: production
+  DATABASE_URL: ${DATABASE_URL}
+```
+
+Deploy:
+
+```bash
+gcloud functions deploy hazeljs-app --config function.yaml
+```
+
+## Decorator-Based Optimization
+
+Mark **controllers** (classes) for serverless optimization with `@Serverless`:
+
+```typescript
+import { Controller, Get } from '@hazeljs/core';
+import { Serverless } from '@hazeljs/serverless';
+
+@Controller('/api')
+@Serverless({ memory: 512, timeout: 30, coldStartOptimization: true })
+export class ApiController {
+  @Get('/hello')
+  hello() {
+    return { message: 'Hello from serverless!' };
+  }
+}
+```
+
+> **Note:** The decorator is class-level only. Method-level `@Serverless({ optimize, cache })` and per-route `binaryResponse` are planned for a future release.
+
+## Cold Start Optimization
+
+**ColdStartOptimizer** preloads the DI container and built-in modules (http, https, crypto, buffer); behavior is best-effort and may vary by Node version. **KeepAliveHelper** runs an interval but does not perform an actual HTTP request—use provisioned concurrency, a cron job, or implement `fetch`/`http.get` in the interval to warm the function.
+
+### Minimize Bundle Size
+
+```typescript
+// Use dynamic imports for heavy dependencies
+@Get('/heavy')
+async heavyOperation() {
+  const { processData } = await import('./heavy-processor');
+  return processData();
+}
+```
+
+### Connection Pooling
+
+```typescript
+// Reuse database connections across invocations
+let cachedDb: any = null;
+
+async function connectToDatabase() {
+  if (cachedDb) {
+    return cachedDb;
+  }
+
+  cachedDb = await createDatabaseConnection();
+  return cachedDb;
+}
+
+@Injectable()
+export class DatabaseService {
+  async query(sql: string) {
+    const db = await connectToDatabase();
+    return db.query(sql);
+  }
+}
+```
+
+### Provisioned Concurrency (AWS Lambda)
+
+```yaml
+# template.yaml
+Resources:
+  HazelFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      # ... other properties
+      ProvisionedConcurrencyConfig:
+        ProvisionedConcurrentExecutions: 5
+```
+
+## Environment-Specific Configuration
+
+```typescript
+// config/serverless.config.ts
+export const serverlessConfig = {
+  development: {
+    timeout: 30,
+    memorySize: 512,
+  },
+  production: {
+    timeout: 60,
+    memorySize: 1024,
+    provisionedConcurrency: 5,
+  },
+};
+
+// lambda.ts
+const config = serverlessConfig[process.env.NODE_ENV || 'development'];
+
+export const handler = createLambdaHandler(AppModule, {
+  timeout: config.timeout,
+});
+```
+
+## Request/Response Handling
+
+### AWS Lambda Event Types
+
+```typescript
+import { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
+
+// Access raw Lambda event
+@Get('/lambda-info')
+getLambdaInfo(@Req() req: any) {
+  const event: APIGatewayProxyEvent = req.apiGateway.event;
+  
+  return {
+    requestId: event.requestContext.requestId,
+    sourceIp: event.requestContext.identity.sourceIp,
+    userAgent: event.headers['user-agent'],
+  };
+}
+```
+
+### Binary Responses
+
+You can pass `binaryMimeTypes` in `createLambdaHandler` options for future use. Automatic base64 encoding of binary response bodies for Lambda is planned.
+
+```typescript
+export const handler = createLambdaHandler(AppModule, {
+  binaryMimeTypes: ['image/png', 'application/pdf'],
+});
+```
+
+## Logging
+
+### CloudWatch Logs (AWS)
+
+```typescript
+import { Logger } from '@hazeljs/core';
+
+@Injectable()
+export class MyService {
+  private logger = new Logger(MyService.name);
+
+  async doSomething() {
+    this.logger.log('Processing request');
+    this.logger.error('An error occurred');
+    this.logger.warn('Warning message');
+  }
+}
+```
+
+### Cloud Logging (GCP)
+
+```typescript
+import { Logger } from '@hazeljs/core';
+
+@Injectable()
+export class MyService {
+  private logger = new Logger(MyService.name);
+
+  async doSomething() {
+    // Logs automatically sent to Cloud Logging
+    this.logger.log('Processing request', {
+      userId: '123',
+      action: 'create',
+    });
+  }
+}
+```
+
+## Best Practices
+
+1. **Minimize Dependencies** - Only include necessary packages
+2. **Reuse Connections** - Cache database and API connections
+3. **Use Environment Variables** - Store configuration externally
+4. **Optimize Bundle Size** - Use tree-shaking and minification
+5. **Handle Cold Starts** - Implement warming strategies
+6. **Monitor Performance** - Track execution time and memory usage
+7. **Set Appropriate Timeouts** - Balance cost and functionality
+8. **Use Provisioned Concurrency** - For latency-sensitive endpoints
+
+## Monitoring
+
+### AWS Lambda
+
+```typescript
+// Add X-Ray tracing
+import AWSXRay from 'aws-xray-sdk-core';
+
+const AWS = AWSXRay.captureAWS(require('aws-sdk'));
+
+// Custom metrics
+import { CloudWatch } from 'aws-sdk';
+
+const cloudwatch = new CloudWatch();
+
+async function recordMetric(name: string, value: number) {
+  await cloudwatch.putMetricData({
+    Namespace: 'HazelJS',
+    MetricData: [{
+      MetricName: name,
+      Value: value,
+      Unit: 'Count',
+    }],
+  }).promise();
+}
+```
+
+### Google Cloud Functions
+
+```typescript
+// Add Cloud Trace
+import { TraceAgent } from '@google-cloud/trace-agent';
+
+TraceAgent.start();
+
+// Custom metrics
+import { Monitoring } from '@google-cloud/monitoring';
+
+const monitoring = new Monitoring.MetricServiceClient();
+
+async function recordMetric(name: string, value: number) {
+  const request = {
+    name: monitoring.projectPath(projectId),
+    timeSeries: [{
+      metric: { type: `custom.googleapis.com/${name}` },
+      points: [{
+        interval: { endTime: { seconds: Date.now() / 1000 } },
+        value: { doubleValue: value },
+      }],
+    }],
+  };
+  
+  await monitoring.createTimeSeries(request);
+}
+```
+
+## Cost Optimization
+
+### Request Batching
+
+```typescript
+// Batch multiple operations
+@Post('/batch')
+async batchProcess(@Body() items: any[]) {
+  const results = await Promise.all(
+    items.map(item => this.processItem(item))
+  );
+  return results;
+}
+```
+
+### Caching
+
+```typescript
+import { Cache } from '@hazeljs/cache';
+
+@Injectable()
+export class DataService {
+  @Cache({ key: 'expensive-data', ttl: 3600 })
+  async getExpensiveData() {
+    // This will be cached for 1 hour
+    return await this.fetchFromDatabase();
+  }
+}
+```
+
+## Examples
+
+See the [examples](../../example/src/serverless) directory for complete working examples.
+
+## Testing
+
+```bash
+npm test
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0 © [HazelJS](https://hazeljs.com)
+
+## Links
+
+- [Documentation](https://hazeljs.com/docs/packages/serverless)
+- [AWS Lambda Docs](https://docs.aws.amazon.com/lambda/)
+- [Google Cloud Functions Docs](https://cloud.google.com/functions/docs)
+- [GitHub](https://github.com/hazel-js/hazeljs)
+- [Issues](https://github.com/hazel-js/hazeljs/issues)
+- [Discord](https://discord.com/channels/1448263814238965833/1448263814859456575)

package/dist/adapters.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=adapters.test.d.ts.map

package/dist/adapters.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.test.d.ts","sourceRoot":"","sources":["../src/adapters.test.ts"],"names":[],"mappings":""}