@kirschbaum-development/sst-laravel 0.0.13 → 0.0.19

package/README.md

@@ -41,21 +41,22 @@ npx sst-laravel init
 To start using, you only need to import the component in your `sst.config.ts` file:
 
 ```ts
-import { Laravel } from "@kirschbaum-development/sst-laravel";
+import { LaravelService } from "@kirschbaum-development/sst-laravel";
 ```
 
 And now you can start using the `Laravel` SST component. All the configuration options are Typescript files with documentation, so
 
 To check the full list of options. check [here](https://github.com/kirschbaum-development/sst-laravel/blob/main/docs/api.md). 
 
-### HTTP
+### Web (HTTP)
 
-Setting up your app to receive HTTP requests, on the `laravel-sst-demo.kdg.dev` domain (with SSL), with auto-scaling with a max of 3 servers.
+Below is an example of setting up your application to receive HTTP requests, on the `laravel-sst-demo.example.com` domain (with SSL), with auto-scaling with a max of 3 servers.
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   web: {
-    domain: 'laravel-sst-demo.kdg.dev',
+    dns: sst.cloudflare.dns(),
+    domain: 'laravel-sst-demo.example.com',
     scaling: {
       min: 1, 
       max: 3,
@@ -64,6 +65,8 @@ const app = new Laravel('MyLaravelApp', {
 });
 ```
 
+Check all the `web` options [here](https://github.com/kirschbaum-development/sst-laravel/blob/main/docs/api.md#web).
+
 ### Workers
 
 Beyond HTTP requests, you can set up one or more `workers` for your Laravel application. Workers are meant to run background commands like Laravel Horizon, the Laravel Scheduler or any background command you may need to run.
@@ -74,7 +77,7 @@ SST Laravel will automatically deploy and configure worker containers running yo
 **Running the Laravel scheduler**
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   workers: [
     {
       name: 'scheduler',
@@ -87,7 +90,7 @@ const app = new Laravel('MyLaravelApp', {
 **Running the Laravel Horizon**
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   workers: [
     {
       name: 'horizon',
@@ -100,7 +103,7 @@ const app = new Laravel('MyLaravelApp', {
 **Running custom commands**
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   workers: [
     {
       name: 'worker',
@@ -120,6 +123,8 @@ const app = new Laravel('MyLaravelApp', {
 });
 ```
 
+Check all the `workers` options [here](https://github.com/kirschbaum-development/sst-laravel/blob/main/docs/api.md#workers).
+
 ## Environment Variables
 
 There are multiple ways to configure environment variables. If you want SST Laravel to copy an environment file, you can configure the `config.environment.file` entry.
@@ -127,7 +132,7 @@ There are multiple ways to configure environment variables. If you want SST Lara
 The below configuration would copy a file named `.env.$STAGE` (e.g. `.env.production`) into the deployment containers as your `.env` file.
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   // ...
   config: {
     environment: {
@@ -140,7 +145,7 @@ const app = new Laravel('MyLaravelApp', {
 You can also configure it to use simply `.env`.
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   // ...
   config: {
     environment: {
@@ -161,7 +166,7 @@ const database = new sst.aws.Postgres('MyDatabase', { vpc });
 const redis = new sst.aws.Redis("MyRedis", { vpc });
 const bucket = new sst.aws.Bucket("MyBucket");
 
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   link: [database, redis, bucket],
 });
 ```
@@ -175,7 +180,7 @@ You can also [import existing resources](https://sst.dev/docs/import-resources/)
 If you need to customize the environment variable names for your resources, you can provide an object with the resource and a callback function in the `link` array:
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   link: [
     email, 
     {
@@ -223,7 +228,7 @@ The IAM permissions for the linked resources are also automatically added to the
 You can configure the PHP version, custom environment variables and a custom deployment script.
 
 ```js
-const app = new Laravel('MyLaravelApp', {
+const app = new LaravelService('MyLaravelApp', {
   config: {
     php: 8.4,
     opcache: true,

package/laravel-sst.ts

@@ -202,7 +202,7 @@ export interface LaravelArgs extends ClusterArgs {
   }
 }
 
-export class Laravel extends Component {
+export class LaravelService extends Component {
   private readonly services: Record<string, sst.aws.Service>;
 
   constructor(
@@ -483,8 +483,17 @@ export class Laravel extends Component {
         ...customEnv,
       };
 
-      // TODO: Write resourcesEnvVars to the .env file
-      // TODO: Add proper types
+      const envFile = path.resolve(pluginBuildPath, 'deploy', '.env');
+      
+      all(Object.entries(resourcesEnvVars)).apply(entries => {
+        const envContent = entries
+          .map(([key, value]) => `${key}=${value}`)
+          .join('\n');
+        
+        if (envContent) {
+          fs.appendFileSync(envFile, '\n' + envContent);
+        }
+      });
     };
 
     /**
@@ -555,6 +564,6 @@ export class Laravel extends Component {
   }
 }
 
-const __pulumiType = "sst:aws:Laravel";
+const __pulumiType = "sst:aws:LaravelService";
 // @ts-expect-error
-Laravel.__pulumiType = __pulumiType;
+LaravelService.__pulumiType = __pulumiType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kirschbaum-development/sst-laravel",
-  "version": "0.0.13",
+  "version": "0.0.19",
   "type": "module",
   "description": "An unofficial extension of SST to deploy containerized Laravel applications to AWS Fargate.",
   "main": "laravel-sst.ts",
@@ -41,7 +41,7 @@
   },
   "homepage": "https://github.com/kirschbaum-development/sst-laravel#readme",
   "bin": {
-    "sst-laravel": "./dist/bin/cli.js"
+    "sst-laravel": "dist/bin/cli.js"
   },
   "dependencies": {
     "@aws-sdk/client-ecs": "^3.0.0",

package/templates/sst.config.run.template

@@ -1,11 +1,11 @@
-    const { Laravel } = await import("@kirschbaum-development/sst-laravel");
+    const { LaravelService } = await import("@kirschbaum-development/sst-laravel");
     const vpc = new sst.aws.Vpc("MyVpc");
     // you can also use an existing VPC
     // const vpc = sst.aws.Vpc.get("DefaultVpc", "vpc-12345678901234567");
 
     const database = new sst.aws.Postgres('MyDB', { vpc });
 
-    const app = new Laravel("MyLaravelApp", {
+    const app = new LaravelService("MyLaravelApp", {
       vpc,
       link: [database],