npm - structured-fw - Versions diffs - 1.6.0 → 1.7.1 - Mend

structured-fw 1.6.0 → 1.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/Config.ts +5 -5
package/build/system/server/RequestContext.d.ts +1 -0
package/build/system/server/RequestContext.js +15 -2
package/build/system/types/structured.types.d.ts +1 -1
package/package.json +3 -2

package/Config.ts CHANGED Viewed

@@ -15,11 +15,11 @@ export const config: StructuredConfig = {
         // setting this to false disallows the use of ClientComponent.redraw and ClientComponent.add
         componentRender: '/componentRender',
-        // function that receives the requested URL and returns boolean, if true, treat as static asset
-        // if there is a registered request handler that matches this same URL, it takes precedence over this
-        isAsset: function(uri: string) {
-            return uri.indexOf('/assets/') === 0;
-        }
+        // array of glob patterns that should be treated as static assets
+        // make sure to only include files you want to be publicly accessible
+        staticAssets: [
+            '/assets/**/*'
+        ]
     },
     routes: {
         path: '/app/routes'

package/build/system/server/RequestContext.d.ts CHANGED Viewed

@@ -40,4 +40,5 @@ export declare class RequestContext<Body extends LooseObject | undefined = Loose
     isAjax(): boolean;
     duration(): number;
     complete(): boolean;
+    isAsset(): boolean;
 }

package/build/system/server/RequestContext.js CHANGED Viewed

@@ -4,6 +4,8 @@ import { Document } from "./Document.js";
 import path from "node:path";
 import { existsSync, readFileSync, ReadStream } from "node:fs";
 import { StructuredError } from "../StructuredError.js";
+import { minimatch } from "minimatch";
+import { Transform } from "node:stream";
 export class RequestContext {
     executionStartedAt = null;
     executionCompletedAt = null;
@@ -69,7 +71,7 @@ export class RequestContext {
         else if (data === undefined || data === null) {
             this.sendResponse('', 'text/plain; charset=utf-8');
         }
-        else if (data instanceof ReadStream) {
+        else if (data instanceof ReadStream || data instanceof Transform) {
             this.streamingData = true;
             data.once('end', () => {
                 this.response.end();
@@ -281,7 +283,7 @@ export class RequestContext {
         }
         else {
             let staticAsset = false;
-            if (this.app.config.url.isAsset(this.request.url || '')) {
+            if (this.isAsset()) {
                 const basePath = this.request.url?.startsWith('/assets/ts/') ? './' : '../';
                 const assetPath = path.resolve(basePath + this.request.url);
                 if (existsSync(assetPath)) {
@@ -319,4 +321,15 @@ export class RequestContext {
     complete() {
         return this.executionCompletedAt !== null;
     }
+    isAsset() {
+        return this.app.config.url.staticAssets.some((pattern) => {
+            return minimatch(this.uri, pattern, {
+                nonegate: true,
+                nobrace: true,
+                noext: true,
+                nocomment: true,
+                partial: false,
+            });
+        });
+    }
 }

package/build/system/types/structured.types.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@ export type StructuredConfig = {
     url: {
         removeTrailingSlash: boolean;
         componentRender: false | string;
-        isAsset: (url: string) => boolean;
+        staticAssets: Array<string>;
     };
     routes: {
         readonly path: string;

package/package.json CHANGED Viewed

@@ -19,7 +19,7 @@
   "license": "MIT",
   "type": "module",
   "main": "build/index",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "scripts": {
     "develop": "tsc --watch",
     "startDev": "cd build && nodemon --watch '../app/**/*' --watch '../build/**/*' -e js,html,hbs,css index.js",
@@ -37,7 +37,8 @@
   },
   "dependencies": {
     "handlebars": "^4.7.9",
-    "mime-types": "^3.0.0"
+    "mime-types": "^3.0.0",
+    "minimatch": "^10.2.5"
   },
   "files": [
     "build/system/*",