@appliance.sh/api-server 1.6.0

package/README.md

@@ -0,0 +1,98 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+## Description
+
+[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+
+## Project setup
+
+```bash
+$ npm install
+```
+
+## Compile and run the project
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+## Run tests
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Deployment
+
+When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
+
+If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
+
+```bash
+$ npm install -g @nestjs/mau
+$ mau deploy
+```
+
+With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+
+## Resources
+
+Check out a few resources that may come in handy when working with NestJS:
+
+- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
+- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
+- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
+- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
+- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
+- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
+- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
+- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
+
+## License
+
+Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).

package/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@appliance.sh/api-server",
+  "version": "1.6.0",
+  "description": "",
+  "author": "Eliot Lim",
+  "repository": "https://github.com/appliance-sh/appliance.sh",
+  "license": "MIT",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/platform-express": "^11.0.1",
+    "@aws-sdk/client-cloudformation": "^3.679.0",
+    "aws-cdk-lib": "^2.230.0",
+    "constructs": "^10.4.3",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.18.0",
+    "@nestjs/cli": "^11.0.0",
+    "@nestjs/schematics": "^11.0.0",
+    "@nestjs/testing": "^11.0.1",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.7",
+    "@types/supertest": "^6.0.2",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.2",
+    "globals": "^16.0.0",
+    "jest": "^30.0.0",
+    "prettier": "^3.4.2",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.20.0"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/src/app.controller.spec.ts

@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(appController.getHello()).toBe('Hello World!');
+    });
+  });
+});

package/src/app.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  getHello(): string {
+    return this.appService.getHello();
+  }
+}

package/src/app.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { ApplianceStackModule } from './cdk/appliance-stack.module';
+
+@Module({
+  imports: [ApplianceStackModule],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}

package/src/app.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}

package/src/cdk/appliance-stack-aws-cdk.service.ts

@@ -0,0 +1,131 @@
+import { Injectable, Logger } from '@nestjs/common';
+import * as cdk from 'aws-cdk-lib';
+import { ApplianceStack } from './appliance-stack';
+import { mkdtempSync, readFileSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import * as path from 'node:path';
+import {
+  CloudFormationClient,
+  CreateStackCommand,
+  DeleteStackCommand,
+  DescribeStacksCommand,
+  UpdateStackCommand,
+} from '@aws-sdk/client-cloudformation';
+import {
+  waitUntilStackCreateComplete,
+  waitUntilStackUpdateComplete,
+  waitUntilStackDeleteComplete,
+} from '@aws-sdk/client-cloudformation';
+
+export type CdkAction = 'deploy' | 'destroy';
+
+export interface CdkResult {
+  action: CdkAction;
+  ok: boolean;
+  idempotentNoop: boolean;
+  message: string;
+  stackName: string;
+}
+
+@Injectable()
+export class ApplianceStackAwsCdkService {
+  private readonly logger = new Logger(ApplianceStackAwsCdkService.name);
+  private readonly region = process.env.AWS_REGION || 'us-east-1';
+
+  private client(): CloudFormationClient {
+    return new CloudFormationClient({ region: this.region });
+  }
+
+  private synthTemplate(stackName: string): { templateBody: string; outdir: string } {
+    const outdir = mkdtempSync(path.join(tmpdir(), 'appliance-cdk-'));
+    const app = new cdk.App({ outdir });
+    new ApplianceStack(app, stackName, {});
+    const assembly = app.synth();
+    const artifact = assembly.getStackByName(stackName);
+    const templatePath = path.join(assembly.directory, artifact.templateFile);
+    const templateBody = readFileSync(templatePath, 'utf-8');
+    return { templateBody, outdir: assembly.directory };
+  }
+
+  async deploy(stackName = 'appliance-api-managed'): Promise<CdkResult> {
+    const { templateBody, outdir } = this.synthTemplate(stackName);
+    try {
+      // Does stack exist?
+      const cf = this.client();
+      const exists = await this.stackExists(cf, stackName);
+      if (!exists) {
+        await cf.send(
+          new CreateStackCommand({
+            StackName: stackName,
+            TemplateBody: templateBody,
+            Capabilities: ['CAPABILITY_NAMED_IAM', 'CAPABILITY_AUTO_EXPAND'],
+          })
+        );
+        await waitUntilStackCreateComplete(
+          { client: cf, maxWaitTime: 30 * 60, minDelay: 5, maxDelay: 20 },
+          { StackName: stackName }
+        );
+        return { action: 'deploy', ok: true, idempotentNoop: false, message: 'Stack created', stackName };
+      }
+
+      try {
+        await cf.send(
+          new UpdateStackCommand({
+            StackName: stackName,
+            TemplateBody: templateBody,
+            Capabilities: ['CAPABILITY_NAMED_IAM', 'CAPABILITY_AUTO_EXPAND'],
+          })
+        );
+        await waitUntilStackUpdateComplete(
+          { client: cf, maxWaitTime: 30 * 60, minDelay: 5, maxDelay: 20 },
+          { StackName: stackName }
+        );
+        return { action: 'deploy', ok: true, idempotentNoop: false, message: 'Stack updated', stackName };
+      } catch (e) {
+        if (
+          e instanceof Error &&
+          typeof e?.message === 'string' &&
+          e.message.includes('No updates are to be performed')
+        ) {
+          return { action: 'deploy', ok: true, idempotentNoop: true, message: 'No changes (idempotent)', stackName };
+        }
+        throw e;
+      }
+    } finally {
+      // cleanup synth output
+      try {
+        rmSync(outdir, { recursive: true, force: true });
+      } catch {
+        // ignore
+      }
+    }
+  }
+
+  async destroy(stackName = 'appliance-api-managed'): Promise<CdkResult> {
+    const cf = this.client();
+    const exists = await this.stackExists(cf, stackName);
+    if (!exists) {
+      return { action: 'destroy', ok: true, idempotentNoop: true, message: 'Stack not found (idempotent)', stackName };
+    }
+    await cf.send(new DeleteStackCommand({ StackName: stackName }));
+    await waitUntilStackDeleteComplete(
+      { client: cf, maxWaitTime: 30 * 60, minDelay: 5, maxDelay: 20 },
+      { StackName: stackName }
+    );
+    return { action: 'destroy', ok: true, idempotentNoop: false, message: 'Stack deleted', stackName };
+  }
+
+  private async stackExists(cf: CloudFormationClient, stackName: string): Promise<boolean> {
+    try {
+      const res = await cf.send(new DescribeStacksCommand({ StackName: stackName }));
+      return !!res.Stacks && res.Stacks.length > 0;
+    } catch (e) {
+      if (!(e instanceof Error)) throw e;
+      const code = e?.name;
+      const message = e?.message || '';
+      if (code === 'ValidationError' && message.includes('does not exist')) return false;
+      if (message.includes('does not exist')) return false;
+      throw e;
+    }
+  }
+}

package/src/cdk/appliance-stack.controller.ts

@@ -0,0 +1,19 @@
+import { Controller, HttpCode, Post } from '@nestjs/common';
+import { ApplianceStackAwsCdkService } from './appliance-stack-aws-cdk.service';
+
+@Controller('infra')
+export class ApplianceStackController {
+  constructor(private readonly cdk: ApplianceStackAwsCdkService) {}
+
+  @Post('deploy')
+  @HttpCode(200)
+  async deploy() {
+    return await this.cdk.deploy();
+  }
+
+  @Post('destroy')
+  @HttpCode(200)
+  async destroy() {
+    return await this.cdk.destroy();
+  }
+}

package/src/cdk/appliance-stack.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { ApplianceStackAwsCdkService } from './appliance-stack-aws-cdk.service';
+import { ApplianceStackController } from './appliance-stack.controller';
+
+@Module({
+  providers: [ApplianceStackAwsCdkService],
+  controllers: [ApplianceStackController],
+})
+export class ApplianceStackModule {}

package/src/cdk/appliance-stack.ts

@@ -0,0 +1,35 @@
+import * as cdk from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+
+export class ApplianceStack extends cdk.Stack {
+  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
+    super(scope, id, props);
+
+    // Simple dummy resource: S3 bucket with a stable logical ID
+    const bucket = new cdk.aws_s3.Bucket(this, 'DummyBucket', {
+      versioned: true,
+      removalPolicy: cdk.RemovalPolicy.DESTROY,
+      // autoDeleteObjects: true,
+    });
+
+    const lambdaUrl = new cdk.aws_lambda.Function(this, 'DummyLambda', {
+      runtime: cdk.aws_lambda.Runtime.NODEJS_24_X,
+      handler: 'index.handler',
+      code: cdk.aws_lambda.Code.fromInline('exports.handler = async () => "Hello World!";'),
+    });
+
+    const fnUrl = lambdaUrl.addFunctionUrl({
+      authType: cdk.aws_lambda.FunctionUrlAuthType.AWS_IAM,
+    });
+
+    const fnDistribution = new cdk.aws_cloudfront.Distribution(this, 'DummyDistribution', {
+      defaultBehavior: {
+        origin: cdk.aws_cloudfront_origins.FunctionUrlOrigin.withOriginAccessControl(fnUrl),
+      },
+    });
+
+    new cdk.CfnOutput(this, 'BucketName', { value: bucket.bucketName });
+    new cdk.CfnOutput(this, 'FunctionUrl', { value: fnUrl.url });
+    new cdk.CfnOutput(this, 'Distribution', { value: fnDistribution.distributionDomainName });
+  }
+}

package/src/main.ts

@@ -0,0 +1,8 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(process.env.PORT ?? 3000);
+}
+bootstrap();

package/test/app.e2e-spec.ts

@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import request from 'supertest';
+import { App } from 'supertest/types';
+import { AppModule } from '../src/app.module';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication<App>;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer()).get('/').expect(200).expect('Hello World!');
+  });
+});

package/test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "resolvePackageJsonExports": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2023",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "noFallthroughCasesInSwitch": false
+  }
+}