local-serverless-stack 0.17.1 → 1.0.0

package/packages/serverless-plugin/README.md

@@ -1,115 +0,0 @@
-# Serverless Orchestrator Plugin
-
-[![npm version](https://img.shields.io/npm/v/serverless-lss.svg)](https://www.npmjs.com/package/serverless-lss)
-
-Automatically register your Serverless microservices with the Local Serverless Stack Local Orchestrator.
-
-## Installation
-
-```bash
-npm install --save-dev serverless-lss
-```
-
-## Usage
-
-Add the plugin to your `serverless.yml`:
-
-```yaml
-plugins:
-  - serverless-lss
-
-custom:
-  orchestrator:
-    enabled: true
-    orchestratorUrl: http://localhost:3100
-```
-
-## How it works
-
-After running `sls package` or `sls deploy`:
-
-1. The plugin sends a registration request to the Orchestrator (service path, ports, region)
-2. The Orchestrator reads the `sls package` artifacts from `.serverless/` (CloudFormation template + `serverless-state.json`)
-3. It provisions resources (DynamoDB, SQS, SNS, S3) to LocalStack
-4. It registers the service's Lambda functions, HTTP routes and authorizers, starts a runtime worker, and binds the service's API port (30xx) and Lambda-invoke port (130xx) — replacing `serverless-offline`
-
-## Configuration Options
-
-- `enabled` (boolean, default: `true`): Enable/disable the plugin
-- `orchestratorUrl` (string, default: `http://localhost:3100`): Orchestrator API endpoint
-
-### Service ports
-
-The plugin reports which ports LSS should serve the service on:
-
-```yaml
-custom:
-  lss:                    # preferred — explicit LSS ports
-    apiPort: 3010         # API Gateway emulator (HTTP routes)
-    invokePort: 13010     # AWS Lambda Invoke API
-  serverless-offline:     # fallback — drop-in for services already using offline
-    httpPort: 3010
-    lambdaPort: 13010
-```
-
-If only `apiPort` is known, the orchestrator derives `invokePort = apiPort + 10000`
-(configurable via `lambdaRuntime.invokePortOffset`).
-
-### Example with custom config:
-
-```yaml
-plugins:
-  - serverless-lss
-
-custom:
-  orchestrator:
-    enabled: true
-    orchestratorUrl: http://my-orchestrator:3100
-```
-
-## Environment Variables (optional)
-
-You can also use environment variables to override the configuration:
-
-```bash
-ORCHESTRATOR_URL=http://localhost:3100 sls package
-```
-
-## Features
-
-✅ Auto-registers on `sls package`
-✅ Auto-registers on `sls deploy`
-✅ Non-blocking: deployment continues even if orchestrator is unavailable
-✅ Colored console output
-✅ Minimal dependencies
-
-## Behavior
-
-- If the Orchestrator is unavailable, the plugin logs a warning but doesn't fail the deployment
-- The plugin is compatible with all Serverless Framework providers
-- It only reads existing `.serverless/cloudformation-template-update-stack.json` files (doesn't create them)
-
-## Troubleshooting
-
-**"Orchestrator unavailable" message**
-
-Make sure the Orchestrator is running:
-
-```bash
-cd orchestrator
-npm run server
-```
-
-**Plugin not found**
-
-Make sure you're using a recent version of Serverless Framework (3.0+) and that the plugin is installed in `node_modules`.
-
-## Development
-
-```bash
-# Build
-npm run build
-
-# Watch mode
-npm run dev
-```

package/packages/serverless-plugin/dist/index.d.ts

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

package/packages/serverless-plugin/dist/index.d.ts.map

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

package/packages/serverless-plugin/dist/index.js

@@ -1,107 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = __importDefault(require("chalk"));
-class ServerlessOrchestratorPlugin {
-    serverless;
-    orchestratorUrl;
-    enabled;
-    hooks;
-    constructor(serverless, options = {}) {
-        this.serverless = serverless;
-        const customConfig = (this.serverless.service?.custom || {}).orchestrator || {};
-        // Merge priority: env > options > custom > defaults
-        const merged = {
-            enabled: true,
-            orchestratorUrl: 'http://localhost:3100',
-            ...customConfig,
-            ...options,
-        };
-        // Env overrides win over file/options so the same serverless.yml can register
-        // against different LSS instances at runtime (e.g. an isolated e2e stack).
-        // ORCHESTRATOR_URL (a full URL) is the most explicit and wins over
-        // LSS_DASHBOARD_PORT (just the dashboard port of the target instance).
-        if (process.env.ORCHESTRATOR_URL) {
-            merged.orchestratorUrl = process.env.ORCHESTRATOR_URL;
-        }
-        else if (process.env.LSS_DASHBOARD_PORT) {
-            merged.orchestratorUrl = `http://localhost:${process.env.LSS_DASHBOARD_PORT}`;
-        }
-        if (process.env.ORCHESTRATOR_ENABLED) {
-            merged.enabled = process.env.ORCHESTRATOR_ENABLED !== 'false';
-        }
-        this.orchestratorUrl = merged.orchestratorUrl;
-        this.enabled = merged.enabled !== false;
-        this.hooks = {
-            'after:package:finalize': this.registerWithOrchestrator.bind(this),
-            // 'after:deploy:deploy': this.registerWithOrchestrator.bind(this),
-            'before:offline:start': this.registerWithOrchestrator.bind(this),
-            'before:offline:start:init': this.registerWithOrchestrator.bind(this),
-        };
-    }
-    log(message, type = 'info') {
-        const timestamp = new Date().toLocaleTimeString();
-        let formattedMessage = '';
-        switch (type) {
-            case 'success':
-                formattedMessage = chalk_1.default.green(`✓ [${timestamp}] ${message}`);
-                break;
-            case 'error':
-                formattedMessage = chalk_1.default.red(`✗ [${timestamp}] ${message}`);
-                break;
-            default:
-                formattedMessage = chalk_1.default.blue(`ℹ [${timestamp}] ${message}`);
-        }
-        console.log(formattedMessage);
-    }
-    async registerWithOrchestrator() {
-        if (!this.enabled) {
-            return;
-        }
-        const servicePath = this.serverless.config.servicePath;
-        const serviceName = this.serverless.service?.service || this.serverless.config.service || 'unknown';
-        const region = this.serverless.service?.provider?.region; // Don't use fallback, let orchestrator handle it
-        // Port discovery: custom.lss wins; custom.serverless-offline keeps drop-in
-        // compatibility for services already configured for offline (httpPort →
-        // apiPort, lambdaPort → invokePort).
-        const lssConfig = this.serverless.service?.custom?.lss || {};
-        const serverlessOfflineConfig = this.serverless.service?.custom?.['serverless-offline'] || {};
-        const invokePort = lssConfig.invokePort ?? serverlessOfflineConfig.lambdaPort;
-        const apiPort = lssConfig.apiPort ?? serverlessOfflineConfig.httpPort;
-        if (region) {
-            this.log(`Registering service "${serviceName}" (region: ${region} from Serverless Framework) with orchestrator at ${this.orchestratorUrl}...`, 'info');
-        }
-        else {
-            this.log(`Registering service "${serviceName}" (region will use orchestrator configuration) with orchestrator at ${this.orchestratorUrl}...`, 'info');
-        }
-        try {
-            const response = await fetch(`${this.orchestratorUrl}/api/services/register`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                },
-                body: JSON.stringify({
-                    servicePath,
-                    invokePort,
-                    ...(apiPort !== undefined && { apiPort }),
-                    ...(region && { region }), // Only include region if defined in Serverless Framework
-                }),
-            });
-            if (!response.ok) {
-                const error = (await response.json().catch(() => ({ error: response.statusText })));
-                throw new Error(error.error || `HTTP ${response.status}`);
-            }
-            const result = (await response.json());
-            this.log(`Orchestrator: Registered ${result.resourcesCount} resources for "${serviceName}"`, 'success');
-        }
-        catch (error) {
-            // Non-blocking error: log but don't fail the deployment
-            this.log(`Orchestrator unavailable or registration failed: ${error.message}. Continuing without orchestrator sync.`, 'error');
-        }
-    }
-}
-// Export for serverless framework (CommonJS)
-module.exports = ServerlessOrchestratorPlugin;
-//# sourceMappingURL=index.js.map

package/packages/serverless-plugin/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,kDAA0B;AA2B1B,MAAM,4BAA4B;IACxB,UAAU,CAAqB;IAC/B,eAAe,CAAS;IACxB,OAAO,CAAU;IAClB,KAAK,CAAsC;IAElD,YAAY,UAA8B,EAAE,UAAyB,EAAE;QACrE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC;QAEhF,oDAAoD;QACpD,MAAM,MAAM,GAAG;YACb,OAAO,EAAE,IAAI;YACb,eAAe,EAAE,uBAAuB;YACxC,GAAG,YAAY;YACf,GAAG,OAAO;SACM,CAAC;QAEnB,8EAA8E;QAC9E,2EAA2E;QAC3E,mEAAmE;QACnE,uEAAuE;QACvE,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACjC,MAAM,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;QACxD,CAAC;aAAM,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAC1C,MAAM,CAAC,eAAe,GAAG,oBAAoB,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC;QAChF,CAAC;QACD,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;YACrC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,OAAO,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAgB,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,KAAK,KAAK,CAAC;QAExC,IAAI,CAAC,KAAK,GAAG;YACX,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC;YAClE,mEAAmE;YACnE,sBAAsB,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC;YAChE,2BAA2B,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC;SACtE,CAAC;IACJ,CAAC;IAEO,GAAG,CAAC,OAAe,EAAE,OAAqC,MAAM;QACtE,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,kBAAkB,EAAE,CAAC;QAElD,IAAI,gBAAgB,GAAG,EAAE,CAAC;QAC1B,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,SAAS;gBACZ,gBAAgB,GAAG,eAAK,CAAC,KAAK,CAAC,MAAM,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;gBAC9D,MAAM;YACR,KAAK,OAAO;gBACV,gBAAgB,GAAG,eAAK,CAAC,GAAG,CAAC,MAAM,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;gBAC5D,MAAM;YACR;gBACE,gBAAgB,GAAG,eAAK,CAAC,IAAI,CAAC,MAAM,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAChC,CAAC;IAEO,KAAK,CAAC,wBAAwB;QACpC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC;QACvD,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,IAAI,SAAS,CAAC;QACpG,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,iDAAiD;QAE3G,2EAA2E;QAC3E,wEAAwE;QACxE,qCAAqC;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC;QAC7D,MAAM,uBAAuB,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;QAC9F,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,IAAI,uBAAuB,CAAC,UAAU,CAAC;QAC9E,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,IAAI,uBAAuB,CAAC,QAAQ,CAAC;QAEtE,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,wBAAwB,WAAW,cAAc,MAAM,oDAAoD,IAAI,CAAC,eAAe,KAAK,EAAE,MAAM,CAAC,CAAC;QACzJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,wBAAwB,WAAW,uEAAuE,IAAI,CAAC,eAAe,KAAK,EAAE,MAAM,CAAC,CAAC;QACxJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,eAAe,wBAAwB,EAAE;gBAC5E,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,WAAW;oBACX,UAAU;oBACV,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,CAAC;oBACzC,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,yDAAyD;iBACrF,CAAC;aACH,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,KAAK,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAQ,CAAC;gBAC3F,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAQ,CAAC;YAC9C,IAAI,CAAC,GAAG,CAAC,4BAA4B,MAAM,CAAC,cAAc,mBAAmB,WAAW,GAAG,EAAE,SAAS,CAAC,CAAC;QAC1G,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,wDAAwD;YACxD,IAAI,CAAC,GAAG,CACN,oDAAoD,KAAK,CAAC,OAAO,yCAAyC,EAC1G,OAAO,CACR,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED,6CAA6C;AAC7C,MAAM,CAAC,OAAO,GAAG,4BAA4B,CAAC"}