svelteesp32 1.4.1 → 1.5.0

package/README.md

@@ -12,12 +12,10 @@ In order to be able to easily update OTA, it is important - from the users' poin
 
 This npm package provides a solution for **inserting any JS client application into the ESP web server** (PsychicHttp and also ESPAsyncWebServer available, PsychicHttp is the default). For this, JS, html, css, font, assets, etc. files must be converted to binary byte array. Npm mode is easy to use and easy to **integrate into your CI/CD pipeline**.
 
+> Starting with version v1.5.0, PsychicHttp v2 is also supported.
 > Version v1.4.0 has a breaking change! --no-gzip changed to --gzip. Starting with this version c++ compiler directives are available to setup operation in project level.
-
 > Starting with version v1.3.0, c++ defines can be used.
-
 > Starting with version v1.2.0, ESP8266/ESP8285 is also supported.
-
 > Starting with version v1.1.0, the ETag header is also supported.
 
 ### Usage
@@ -34,6 +32,9 @@ After a successful Svelte build (rollup/webpack/vite) **create an includeable c+
 // for PsychicHttpServer
 npx svelteesp32 -e psychic -s ../svelteapp/dist -o ../esp32project/svelteesp32.h --etag=true
 
+// for PsychicHttpServer V2
+npx svelteesp32 -e psychic2 -s ../svelteapp/dist -o ../esp32project/svelteesp32.h --etag=true
+
 // for ESPAsyncWebServer
 npx svelteesp32 -e async -s ../svelteapp/dist -o ../esp32project/svelteesp32.h --etag=true
 ```
@@ -217,18 +218,18 @@ You can use the following c++ directives at the project level if you want to con
 
 ### Command line options
 
-| Option        | Description                                                      | default                 |
-| ------------- | ---------------------------------------------------------------- | ----------------------- |
-| `-s`          | **Source dist folder contains compiled web files**               |                         |
-| `-e`          | The engine for which the include file is created (psychic/async) | psychic                 |
-| `-o`          | Generated output file with path                                  | `svelteesp32.h`         |
-| `--etag`      | Use ETag header for cache (true/false/compiler)                  | false                   |
-| `--gzip`      | Compress content with gzip (true/false/compiler)                 | true                    |
-| `--created`   | Include creation time                                            | false                   |
-| `--version`   | Include a version string, `--version=v$npm_package_version`      | ''                      |
-| `--espmethod` | Name of generated method                                         | `initSvelteStaticFiles` |
-| `--define`    | Prefix of c++ defines                                            | `SVELTEESP32`           |
-| `-h`          | Show help                                                        |                         |
+| Option        | Description                                                               | default                 |
+| ------------- | ------------------------------------------------------------------------- | ----------------------- |
+| `-s`          | **Source dist folder contains compiled web files**                        |                         |
+| `-e`          | The engine for which the include file is created (psychic/psychic2/async) | psychic                 |
+| `-o`          | Generated output file with path                                           | `svelteesp32.h`         |
+| `--etag`      | Use ETag header for cache (true/false/compiler)                           | false                   |
+| `--gzip`      | Compress content with gzip (true/false/compiler)                          | true                    |
+| `--created`   | Include creation time                                                     | false                   |
+| `--version`   | Include a version string, `--version=v$npm_package_version`               | ''                      |
+| `--espmethod` | Name of generated method                                                  | `initSvelteStaticFiles` |
+| `--define`    | Prefix of c++ defines                                                     | `SVELTEESP32`           |
+| `-h`          | Show help                                                                 |                         |
 
 ### Q&A
 

package/dist/commandLine.d.ts

@@ -1,5 +1,5 @@
 interface ICopyFilesArguments {
-    engine: 'psychic' | 'async';
+    engine: 'psychic' | 'psychic2' | 'async';
     sourcepath: string;
     outputfile: string;
     espmethod: string;

package/dist/commandLine.js

@@ -8,12 +8,14 @@ exports.cmdLine = (0, ts_command_line_args_1.parse)({
         type: (value) => {
             if (value === 'psychic')
                 return 'psychic';
+            if (value === 'psychic2')
+                return 'psychic2';
             if (value === 'async')
                 return 'async';
             throw new Error(`Invalid engine: ${value}`);
         },
         alias: 'e',
-        description: 'The engine for which the include file is created (psychic|async)',
+        description: 'The engine for which the include file is created (psychic|psychic2|async)',
         defaultValue: 'psychic'
     },
     sourcepath: {

package/dist/cppCode.js

@@ -150,10 +150,12 @@ void {{methodName}}(PsychicHttpServer * server) {
 
 {{#switch ../etag}}
 {{#case "true"}}
+    response.addHeader("cache-control", "no-cache");
     response.addHeader("ETag", etag_{{this.dataname}});
 {{/case}}
 {{#case "compiler"}}
   #ifdef {{../definePrefix}}_ENABLE_ETAG
+    response.addHeader("cache-control", "no-cache");
     response.addHeader("ETag", etag_{{this.dataname}});
   #endif 
 {{/case}}
@@ -178,6 +180,182 @@ void {{methodName}}(PsychicHttpServer * server) {
     return response.send();
   });
 
+{{/each}}
+}`;
+const psychic2Template = `
+//engine:   PsychicHttpServerV2
+//cmdline:  {{{commandLine}}}
+{{#if created }}
+//created:  {{now}}
+{{/if}}
+//
+
+{{#switch etag}}
+{{#case "true"}}
+#ifdef {{definePrefix}}_ENABLE_ETAG
+#warning {{definePrefix}}_ENABLE_ETAG has no effect because it is permanently switched ON
+#endif
+{{/case}}
+{{#case "false"}}
+#ifdef {{definePrefix}}_ENABLE_ETAG
+#warning {{definePrefix}}_ENABLE_ETAG has no effect because it is permanently switched OFF
+#endif
+{{/case}}
+{{/switch}}
+
+{{#switch gzip}}
+{{#case "true"}}
+#ifdef {{definePrefix}}_ENABLE_GZIP
+#warning {{definePrefix}}_ENABLE_GZIP has no effect because it is permanently switched ON
+#endif
+{{/case}}
+{{#case "false"}}
+#ifdef {{definePrefix}}_ENABLE_GZIP
+#warning {{definePrefix}}_ENABLE_GZIP has no effect because it is permanently switched OFF
+#endif
+{{/case}}
+{{/switch}}
+
+//
+{{#if version }}
+#define {{definePrefix}}_VERSION "{{version}}"
+{{/if}}
+#define {{definePrefix}}_COUNT {{fileCount}}
+#define {{definePrefix}}_SIZE {{fileSize}}
+#define {{definePrefix}}_SIZE_GZIP {{fileGzipSize}}
+
+//
+{{#each sources}}
+#define {{../definePrefix}}_FILE_{{this.datanameUpperCase}}
+{{/each}}
+
+//
+{{#each filesByExtension}}
+#define {{../definePrefix}}_{{this.extension}}_FILES {{this.count}}
+{{/each}}
+
+//
+#include <Arduino.h>
+#include <PsychicHttp.h>
+#include <PsychicHttpsServer.h>
+
+//
+{{#switch gzip}}
+{{#case "true"}}
+  {{#each sources}}
+const uint8_t datagzip_{{this.dataname}}[{{this.lengthGzip}}] = { {{this.bytesGzip}} };
+  {{/each}}
+{{/case}}
+{{#case "false"}}
+  {{#each sources}}
+const uint8_t data_{{this.dataname}}[{{this.length}}] = { {{this.bytes}} };
+  {{/each}}
+{{/case}}
+{{#case "compiler"}}
+#ifdef {{definePrefix}}_ENABLE_GZIP
+  {{#each sources}}
+const uint8_t datagzip_{{this.dataname}}[{{this.lengthGzip}}] = { {{this.bytesGzip}} };
+  {{/each}}
+#else
+  {{#each sources}}
+const uint8_t data_{{this.dataname}}[{{this.length}}] = { {{this.bytes}} };
+  {{/each}}
+#endif 
+{{/case}}
+{{/switch}}
+
+//
+{{#switch etag}}
+{{#case "true"}}
+  {{#each sources}}
+const char * etag_{{this.dataname}} = "{{this.md5}}";
+  {{/each}}
+{{/case}}
+{{#case "false"}}
+{{/case}}
+{{#case "compiler"}}
+#ifdef {{definePrefix}}_ENABLE_ETAG
+  {{#each sources}}
+const char * etag_{{this.dataname}} = "{{this.md5}}";
+  {{/each}}
+#endif 
+{{/case}}
+{{/switch}}
+
+//
+// Http Handlers
+void {{methodName}}(PsychicHttpServer * server) {
+{{#each sources}}
+//
+// {{this.filename}}
+  {{#if this.isDefault}}server->defaultEndpoint = {{/if}}server->on("/{{this.filename}}", HTTP_GET, [](PsychicRequest * request, PsychicResponse * response) {
+
+{{#switch ../etag}}
+{{#case "true"}}
+    if (request->hasHeader("If-None-Match") && request->header("If-None-Match") == String(etag_{{this.dataname}})) {
+      response->setCode(304);
+      return response->send();
+    }
+{{/case}}
+{{#case "compiler"}}
+  #ifdef {{../definePrefix}}_ENABLE_ETAG
+    if (request->hasHeader("If-None-Match") && request->header("If-None-Match") == String(etag_{{this.dataname}})) {
+      response->setCode(304);
+      return response->send();
+    }
+  #endif 
+{{/case}}
+{{/switch}}
+
+    response->setContentType("{{this.mime}}");
+
+{{#switch ../gzip}}
+{{#case "true"}}
+{{#if this.isGzip}}
+    response->addHeader("Content-Encoding", "gzip");
+{{/if}}
+{{/case}}
+{{#case "compiler"}}
+  {{#if this.isGzip}}
+  #ifdef {{../definePrefix}}_ENABLE_GZIP
+    response->addHeader("Content-Encoding", "gzip");
+  #endif 
+  {{/if}}
+{{/case}}
+{{/switch}}
+
+{{#switch ../etag}}
+{{#case "true"}}
+    response->addHeader("cache-control", "no-cache");
+    response->addHeader("ETag", etag_{{this.dataname}});
+{{/case}}
+{{#case "compiler"}}
+  #ifdef {{../definePrefix}}_ENABLE_ETAG
+    response->addHeader("cache-control", "no-cache");
+    response->addHeader("ETag", etag_{{this.dataname}});
+  #endif 
+{{/case}}
+{{/switch}}
+
+{{#switch ../gzip}}
+{{#case "true"}}
+    response->setContent(datagzip_{{this.dataname}}, {{this.lengthGzip}});
+{{/case}}
+{{#case "false"}}
+    response->setContent(data_{{this.dataname}}, {{this.length}});
+{{/case}}
+{{#case "compiler"}}
+  #ifdef {{../definePrefix}}_ENABLE_GZIP
+    response->setContent(datagzip_{{this.dataname}}, {{this.lengthGzip}});
+  #else
+    response->setContent(data_{{this.dataname}}, {{this.length}});
+  #endif 
+{{/case}}
+{{/switch}}
+
+    return response->send();
+  });
+
 {{/each}}
 }`;
 const asyncTemplate = `
@@ -328,10 +506,12 @@ void {{methodName}}(AsyncWebServer * server) {
 
 {{#switch ../etag}}
 {{#case "true"}}
+    response->addHeader("cache-control", "no-cache");
     response->addHeader("ETag", etag_{{this.dataname}});
 {{/case}}
 {{#case "compiler"}}
   #ifdef {{../definePrefix}}_ENABLE_ETAG
+    response->addHeader("cache-control", "no-cache");
     response->addHeader("ETag", etag_{{this.dataname}});
   #endif 
 {{/case}}
@@ -347,7 +527,7 @@ void {{methodName}}(AsyncWebServer * server) {
 {{/each}}
 }`;
 let switchValue;
-const getCppCode = (sources, filesByExtension) => (0, handlebars_1.compile)(commandLine_1.cmdLine.engine === 'psychic' ? psychicTemplate : asyncTemplate)({
+const getCppCode = (sources, filesByExtension) => (0, handlebars_1.compile)(commandLine_1.cmdLine.engine === 'psychic' ? psychicTemplate : commandLine_1.cmdLine.engine === 'psychic2' ? psychic2Template : asyncTemplate)({
     commandLine: process.argv.slice(2).join(' '),
     now: `${new Date().toLocaleDateString()} ${new Date().toLocaleTimeString()}`,
     fileCount: sources.length.toString(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelteesp32",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Convert Svelte (or any frontend) JS application to serve it from ESP32 webserver (PsychicHttp)",
   "author": "BCsabaEngine",
   "license": "ISC",
@@ -30,6 +30,7 @@
   "scripts": {
     "dev:async": "nodemon src/index.ts -- -e async -s ./demo/svelte/dist -o ./demo/esp32/include/svelteesp32.h --etag=true --gzip=true --version=v$npm_package_version",
     "dev:psychic": "nodemon src/index.ts -- -e psychic -s ./demo/svelte/dist -o ./demo/esp32/include/svelteesp32.h --etag=false --gzip=false --version=v$npm_package_version",
+    "dev:psychic2": "nodemon src/index.ts -- -e psychic2 -s ./demo/svelte/dist -o ./demo/esp32/include/svelteesp32.h --etag=false --gzip=false --version=v$npm_package_version",
     "test:all": "./package.script && ~/.platformio/penv/bin/pio run -d ./demo/esp32",
     "clean": "tsc --build --clean",
     "build": "tsc --build --clean && tsc --build --force",
@@ -49,21 +50,22 @@
     "esp8266",
     "webserver",
     "psychichttpserver",
+    "psychichttpserverV2",
     "espasyncwebserver"
   ],
   "devDependencies": {
     "@types/mime-types": "^2.1.4",
-    "@types/node": "^22.4.1",
-    "@typescript-eslint/eslint-plugin": "^8.1.0",
-    "@typescript-eslint/parser": "^8.1.0",
-    "eslint": "^9.9.0",
+    "@types/node": "^22.5.2",
+    "@typescript-eslint/eslint-plugin": "^8.3.0",
+    "@typescript-eslint/parser": "^8.3.0",
+    "eslint": "^9.9.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unicorn": "^55.0.0",
     "nodemon": "^3.1.4",
     "prettier": "^3.3.3",
     "ts-node": "^10.9.2",
-    "tsx": "^4.17.0",
+    "tsx": "^4.19.0",
     "typescript": "^5.5.4"
   },
   "dependencies": {