structured-fw 1.7.4 → 1.7.7

package/README.md

@@ -206,6 +206,8 @@ Session allows you to store temporary data for the users of your web application
 
 Session data is tied to a visitor via sessionId, which is always available on `RequestContext`, which means you can interact with session data from routes and server side part of your components.
 
+*Session data is stored in memory, which means it is lost when you restart the app. If you want to have persistent sessions that survive restart, you can use [structured-plugin-session-redis](https://www.npmjs.com/package/structured-plugin-session-redis).*
+
 **Configuration**\
 `StructuredConfig`.`session`:
 ```
@@ -590,6 +592,9 @@ Your lucky number is {{luckyNumber}}<br>
 ```
 
 That's it. `AnotherComponent` will receive the `luckyNumber` as a number, you can pass any type of data, string, number, boolean, object, array... it will be received by the child as the same type of data. However, *keep in mind the data gets serialized and de-serialized in the process, so if you pass an object to a child, it won't be a reference to the original object, rather a copy of it*.
+
+Since version 1.7.6, additional data types can be passed to child components without them breaking due to serialization: Date, BigInt, RegExp, Map, Uint8Array. *Let me know if you need support for more types that JSON.stringify breaks.*
+
 \
 Let's see how we can use the passed data within `AnotherComponent`, create `/app/views/AnotherComponent/AnotherComponent.html`:
 ```

package/build/system/Util.d.ts

@@ -1,3 +1,4 @@
+import { SerializableDate, SerializableRegExp, Serializable, ValueSerializable, SerializableBigInt, SerializableMap, SerializableUint8Array } from './types/component.types.js';
 import { LooseObject } from './types/general.types.js';
 import { PostedDataDecoded } from "./types/request.types.js";
 export declare function queryStringDecode(queryString: string, initialValue?: PostedDataDecoded, trimValues?: boolean): PostedDataDecoded;
@@ -10,13 +11,22 @@ export declare function isAsync(fn: Function): boolean;
 export declare function randomString(len: number, method?: 'alphanumeric' | 'numbers' | 'letters' | 'lettersUppercase' | 'lettersLowercase'): string;
 export declare function unique<T>(arr: Array<T>): Array<T>;
 export declare function stripTags(contentWithHTML: string, keepTags?: Array<string>): string;
+export declare function toSerializableValue(value: any): ValueSerializable;
+export declare function fromSerializableValue(data: SerializableDate): Date;
+export declare function fromSerializableValue(data: SerializableRegExp): RegExp;
+export declare function fromSerializableValue(data: SerializableMap): Map<any, any>;
+export declare function fromSerializableValue(data: SerializableBigInt): BigInt;
+export declare function fromSerializableValue(data: SerializableUint8Array): Uint8Array;
+export declare function fromSerializableValue(data: Serializable): any;
+export declare function serializableObject(data: LooseObject): LooseObject;
+export declare function deserializeObject(data: LooseObject): LooseObject;
 export declare function attributeValueToString(key: string, value: any): string;
 export declare function attributeValueFromString(attributeValue: string): string | {
     key: string;
     value: any;
 };
 export declare function attributeValueEscape(str: string): string;
-export declare function isObject(item: any): boolean;
+export declare function isObject(value: any): boolean;
 export declare function equalDeep(a: LooseObject, b: LooseObject): boolean;
 export declare function mergeDeep(target: any, ...sources: Array<any>): LooseObject;
 export declare function stripBOM(str: string): string;

package/build/system/Util.js

@@ -235,8 +235,103 @@ function bytesToBase64(bytes) {
         return prev + String.fromCharCode(curr);
     }, ''));
 }
+export function toSerializableValue(value) {
+    if (value instanceof Date) {
+        return {
+            __structured_value: true,
+            type: 'date',
+            value: value.toISOString(),
+        };
+    }
+    if (typeof value === 'bigint') {
+        return {
+            __structured_value: true,
+            type: 'bigint',
+            value: value.toString(),
+        };
+    }
+    if (value instanceof RegExp) {
+        return {
+            __structured_value: true,
+            type: 'regexp',
+            value: {
+                source: value.source,
+                flags: value.flags,
+            }
+        };
+    }
+    if (value instanceof Map) {
+        return {
+            __structured_value: true,
+            type: 'map',
+            value: [...value.entries()],
+        };
+    }
+    if (value instanceof Uint8Array) {
+        return {
+            __structured_value: true,
+            type: 'uint8array',
+            value: Array.from(value),
+        };
+    }
+    return {
+        __structured_value: true,
+        value,
+    };
+}
+export function fromSerializableValue(data) {
+    if (!('type' in data)) {
+        return data.value;
+    }
+    if (data.type === 'date') {
+        return new Date(data.value);
+    }
+    if (data.type === 'regexp') {
+        return new RegExp(data.value.source, data.value.flags);
+    }
+    if (data.type === 'map') {
+        return new Map(data.value);
+    }
+    if (data.type === 'bigint') {
+        return BigInt(data.value);
+    }
+    if (data.type === 'uint8array') {
+        return new Uint8Array(data.value);
+    }
+    return undefined;
+}
+export function serializableObject(data) {
+    const copy = {};
+    objectEach(data, (key, val) => {
+        if (isObject(val)) {
+            copy[key] = serializableObject(val);
+        }
+        else {
+            copy[key] = toSerializableValue(val);
+        }
+    });
+    return copy;
+}
+export function deserializeObject(data) {
+    const copy = {};
+    objectEach(data, (key, val) => {
+        if (typeof val === 'object' && val !== null && val !== undefined) {
+            if ('__structured_value' in val) {
+                copy[key] = fromSerializableValue(val);
+            }
+            else {
+                copy[key] = deserializeObject(val);
+            }
+        }
+        else {
+            copy[key] = fromSerializableValue(val);
+        }
+    });
+    return copy;
+}
 export function attributeValueToString(key, value) {
-    return 'base64:' + bytesToBase64(new TextEncoder().encode(JSON.stringify({ key, value })));
+    const data = serializableObject({ key, data: value });
+    return 'base64:' + bytesToBase64(new TextEncoder().encode(JSON.stringify(data)));
 }
 export function attributeValueFromString(attributeValue) {
     if (attributeValue.indexOf('base64:') === 0) {
@@ -245,11 +340,14 @@ export function attributeValueFromString(attributeValue) {
             if (decoded.indexOf('{') !== 0) {
                 return attributeValue;
             }
-            const valObj = JSON.parse(decoded);
+            const valObj = deserializeObject(JSON.parse(decoded));
             if (!('key' in valObj)) {
                 return decoded;
             }
-            return valObj;
+            return {
+                key: valObj.key,
+                value: valObj.data,
+            };
         }
         catch (e) {
             return attributeValue;
@@ -260,11 +358,11 @@ export function attributeValueFromString(attributeValue) {
 export function attributeValueEscape(str) {
     return str.replaceAll('"', '"');
 }
-export function isObject(item) {
-    if (typeof window === 'undefined') {
-        return (item && typeof item === 'object' && !Array.isArray(item)) && !Buffer.isBuffer(item);
-    }
-    return (item && typeof item === 'object' && !Array.isArray(item));
+export function isObject(value) {
+    if (value === null || typeof value !== 'object')
+        return false;
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
 }
 export function equalDeep(a, b) {
     if (a === b) {

package/build/system/server/Application.d.ts

@@ -26,7 +26,7 @@ export declare class Application {
     constructor(config: StructuredConfig);
     init(): Promise<void>;
     private start;
-    on<E extends ApplicationEvents>(evt: E, callback: (payload: E extends 'beforeRequestHandler' | 'afterRequestHandler' | 'beforeAssetAccess' | 'afterAssetAccess' | 'pageNotFound' | 'requestHandleError' ? RequestContext<RequestContextData> : E extends 'documentCreated' ? Document : E extends 'afterComponentsLoaded' ? Components : E extends 'serverStarted' ? Server : E extends 'sessionsStart' ? Session : E extends 'sessionsStop' ? Session : E extends 'sessionCreated' ? SessionEntry : E extends 'sessionExpired' ? string : E extends 'sessionValueSet' ? [string, string, any] : E extends 'sessionValueRemove' ? [string, string] : E extends 'sessionClear' ? string : undefined) => void): void;
+    on<E extends ApplicationEvents>(evt: E, callback: (payload: E extends 'beforeRequestHandler' | 'afterRequestHandler' | 'beforeAssetAccess' | 'afterAssetAccess' | 'pageNotFound' | 'requestHandleError' ? RequestContext<RequestContextData> : E extends 'documentCreated' ? Document : E extends 'afterComponentsLoaded' ? Components : E extends 'serverStarted' ? Server : E extends 'sessionsStart' ? Session : E extends 'sessionsStop' ? Session : E extends 'sessionCreated' ? SessionEntry : E extends 'sessionExpired' | 'sessionExtended' | 'sessionClear' ? string : E extends 'sessionValueSet' ? [string, string, any] : E extends 'sessionValueRemove' ? [string, string] : undefined) => void): void;
     emit(eventName: ApplicationEvents, payload?: any): Promise<Array<any>>;
     importEnv<T extends LooseObject>(smartPrimitives?: boolean): T;
     exportContextFields(...fields: Array<keyof RequestContextData>): void;

package/build/system/types/component.types.d.ts

@@ -39,6 +39,43 @@ export type ComponentEvents = {
     componentCreated: Component;
     ready: undefined;
 };
+export type Serializable = {
+    __structured_value: true;
+    value: any;
+};
+export type SerializableDate = {
+    __structured_value: true;
+    type: 'date';
+    value: string;
+};
+export type SerializableRegExp = {
+    __structured_value: true;
+    type: 'regexp';
+    value: {
+        source: string;
+        flags: string;
+    };
+};
+export type SerializableMap = {
+    __structured_value: true;
+    type: 'map';
+    value: Array<[any, any]>;
+};
+export type SerializableBigInt = {
+    __structured_value: true;
+    type: 'bigint';
+    value: string;
+};
+export type SerializableUint8Array = {
+    __structured_value: true;
+    type: 'uint8array';
+    value: Array<number>;
+};
+export type ValueSerializable = Serializable | SerializableDate | SerializableRegExp | SerializableMap | SerializableBigInt | SerializableUint8Array;
+export type AttributeEncodedObject = {
+    key: string;
+    data: ValueSerializable;
+};
 export type ClientComponentTransition = {
     fade: false | number;
     slide: false | number;

package/package.json

@@ -19,7 +19,7 @@
   "license": "MIT",
   "type": "module",
   "main": "build/index",
-  "version": "1.7.4",
+  "version": "1.7.7",
   "scripts": {
     "develop": "tsc --watch",
     "startDev": "cd build && nodemon --watch '../app/**/*' --watch '../build/**/*' -e js,html,hbs,css index.js",