gingersnap 0.23.10 → 0.23.12

package/data/model/model.cjs

@@ -73,14 +73,9 @@ class Optional {
  * A Data de/serializer class that manages and validates data as JavaScript Objects
  */
 class Model {
-    /**
-     * Converts arraybuffer to a model
-     * @param data arraybuffer
-     * @param format data format
-     * @param options configurations for deserializing the data
-     * @returns new model or an array of models
-     */
-    static fromBuffer(data, format = types.DataFormat.JSON, options) {
+    static fromBuffer(data, options) {
+        var _a;
+        const format = (_a = options === null || options === void 0 ? void 0 : options.format) !== null && _a !== void 0 ? _a : types.DataFormat.JSON;
         switch (format) {
             case types.DataFormat.MESSAGE_PACK: {
                 const decoder = msgpack.decode;
@@ -89,27 +84,18 @@ class Model {
                     throw new ParsingError.ParsingError([], "expected an array of models");
                 if ((!(options === null || options === void 0 ? void 0 : options.array) && result instanceof Array) || Array.isArray(result))
                     throw new ParsingError.ParsingError([], "expected only one model");
-                if (result instanceof Array || Array.isArray(result))
-                    return result.map((v) => this.fromJSON(v));
-                return this.fromJSON(result);
+                return this.fromJSON(result, { array: options === null || options === void 0 ? void 0 : options.array, maybeArray: options === null || options === void 0 ? void 0 : options.maybeArray });
             }
             case types.DataFormat.CSV: {
                 const text = data instanceof Uint8Array ? new TextDecoder().decode(data.buffer) : data.toString();
-                return this.fromString(text, format, options);
+                return this.fromString(text, options);
             }
             case types.DataFormat.XML:
             case types.DataFormat.JSON:
-                return this.fromString(data instanceof Uint8Array ? new TextDecoder().decode(data) : data.toString(), format, options);
+                return this.fromString(data instanceof Uint8Array ? new TextDecoder().decode(data) : data.toString(), options);
         }
     }
-    /**
-     * Downloads data from the given source and deserializes the data to one or more models
-     * @param source URL source to fetch the data
-     * @param format data format
-     * @param options configurations for deserializing and/or retrieving the data
-     * @returns one or more models
-     */
-    static fromURL(source, format = types.DataFormat.JSON, options) {
+    static fromURL(source, options) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
             const fetcher = fetch;
             const resp = yield fetcher(source, {
@@ -119,48 +105,37 @@ class Model {
             });
             if (!resp.ok)
                 throw new NetworkError.NetworkError(resp.status);
-            return yield this.fromBlob(yield resp.blob(), format, options);
+            return yield this.fromBlob(yield resp.blob(), options);
         });
     }
-    /**
-     * Deserializes one or more models from a Blob
-     * @param data blob data
-     * @param format data format
-     * @param options configurations for deserializing the data
-     * @returns one or more models
-     */
-    static fromBlob(data, format = types.DataFormat.JSON, options) {
+    static fromBlob(data, options) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
-            return this.fromBuffer(new Uint8Array(yield data.arrayBuffer()), format);
+            return this.fromBuffer(new Uint8Array(yield data.arrayBuffer()), options);
         });
     }
-    /**
-     * Deserializes one or more models from given string
-     *
-     * @remarks
-     * If the data format is a binary one, the provided string should be a hexadecimal string.
-     * @param data string data source
-     * @param format data format
-     * @param options
-     */
-    static fromString(data, format = types.DataFormat.JSON, options) {
-        var _a, _b, _c, _d, _e, _f;
+    static fromString(data, options) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const format = (_a = options === null || options === void 0 ? void 0 : options.format) !== null && _a !== void 0 ? _a : types.DataFormat.JSON;
         switch (format) {
             case types.DataFormat.JSON:
                 try {
                     data = JSON.parse(data);
                 }
                 catch (e) {
-                    throw new ParsingError.ParsingError((_a = e === null || e === void 0 ? void 0 : e.message) !== null && _a !== void 0 ? _a : String(e));
+                    throw new ParsingError.ParsingError((_b = e === null || e === void 0 ? void 0 : e.message) !== null && _b !== void 0 ? _b : String(e));
                 }
-                return this.fromJSON(data);
+                return this.fromJSON(data, { maybeArray: options === null || options === void 0 ? void 0 : options.maybeArray, array: options === null || options === void 0 ? void 0 : options.array });
             case types.DataFormat.XML:
-                return this.fromObject(this.__xmlParser__.xml2js(data), format);
+                return this.fromObject(this.__xmlParser__.xml2js(data), {
+                    format,
+                    maybeArray: options === null || options === void 0 ? void 0 : options.maybeArray,
+                    array: options === null || options === void 0 ? void 0 : options.array,
+                });
             case types.DataFormat.CSV: {
                 let result;
                 let text = data;
                 if (options === null || options === void 0 ? void 0 : options.headers)
-                    text = options.headers.join((_b = options === null || options === void 0 ? void 0 : options.delimiter) !== null && _b !== void 0 ? _b : ",") + ((_c = options.newline) !== null && _c !== void 0 ? _c : "\n") + text;
+                    text = options.headers.join((_c = options === null || options === void 0 ? void 0 : options.delimiter) !== null && _c !== void 0 ? _c : ",") + ((_d = options.newline) !== null && _d !== void 0 ? _d : "\n") + text;
                 try {
                     result = Papa.parse(text, {
                         header: true,
@@ -168,27 +143,24 @@ class Model {
                     });
                 }
                 catch (e) {
-                    throw new ParsingError.ParsingError([], (_d = e === null || e === void 0 ? void 0 : e.message) !== null && _d !== void 0 ? _d : String(e));
+                    throw new ParsingError.ParsingError([], (_e = e === null || e === void 0 ? void 0 : e.message) !== null && _e !== void 0 ? _e : String(e));
                 }
                 if (!(options === null || options === void 0 ? void 0 : options.ignoreErrors) && result.errors.length > 0)
                     throw new ParsingError.ParsingError(result.errors);
                 if (!(options === null || options === void 0 ? void 0 : options.array) && result.data.length > 0)
                     throw new ParsingError.ParsingError([], "Too many records found");
-                if (options === null || options === void 0 ? void 0 : options.array)
-                    return result.data.map((v) => this.fromObject(v));
-                return this.fromObject(result.data[0]);
+                if ((options === null || options === void 0 ? void 0 : options.array) || (options === null || options === void 0 ? void 0 : options.maybeArray))
+                    return this.fromObject(result.data, { array: true });
+                if (!(options === null || options === void 0 ? void 0 : options.maybeArray) || (options.maybeArray && result.data.length === 1))
+                    return this.fromObject(result.data[0]);
+                break;
             }
             default:
-                return this.fromBuffer(new Uint8Array((_f = (_e = data.match(/../g)) === null || _e === void 0 ? void 0 : _e.map((h) => parseInt(h, 16))) !== null && _f !== void 0 ? _f : []), format, options);
+                return this.fromBuffer(new Uint8Array((_g = (_f = data.match(/../g)) === null || _f === void 0 ? void 0 : _f.map((h) => parseInt(h, 16))) !== null && _g !== void 0 ? _g : []), options);
         }
     }
-    /**
-     * Converts a JSON object to a model
-     * @param data JSON Object
-     * @returns new model
-     */
-    static fromJSON(data) {
-        return this.fromObject(data, types.DataFormat.JSON);
+    static fromJSON(data, options) {
+        return this.fromObject(data, options);
     }
     /**
      * Converts the current model to a JSON object
@@ -231,6 +203,7 @@ class Model {
             return acc;
         }, {}, Array.from(((_b = (_a = Model.buildPropTree(Object.getPrototypeOf(this))) === null || _a === void 0 ? void 0 : _a.fields) !== null && _b !== void 0 ? _b : new Map()).entries()));
     }
+    // TODO add support for union fields in serialization and deserialization, and later date include schema generation
     /**
      * Converts the current model to a JSON string
      */
@@ -421,15 +394,17 @@ class Model {
         }
         return tree;
     }
-    /**
-     * Constructs a model from a JSON object
-     * @param data JSON object
-     * @param format
-     * @private
-     */
-    static fromObject(data, format = types.DataFormat.JSON) {
-        if (data instanceof Array || Array.isArray(data) || typeof data !== "object") {
-            throw new ParsingError.ParsingError([], "Invalid data provided. Must be an object");
+    static fromObject(data, options) {
+        var _a;
+        const format = (_a = options === null || options === void 0 ? void 0 : options.format) !== null && _a !== void 0 ? _a : types.DataFormat.JSON;
+        if (Array.isArray(data)) {
+            if (!(options === null || options === void 0 ? void 0 : options.array) || !(options === null || options === void 0 ? void 0 : options.maybeArray))
+                throw new ParsingError.ParsingError([], "Invalid data provided. Must be an object");
+            else
+                return data.map((item) => this.fromObject(item, { format }));
+        }
+        else if (options === null || options === void 0 ? void 0 : options.array) {
+            throw new ParsingError.ParsingError([], "Invalid data provided. Must be an array of objects");
         }
         const processValue = (fieldProps, value) => {
             var _a, _b;

package/data/model/model.d.ts

@@ -23,10 +23,12 @@ export interface FieldProps {
     Type: any;
     KeyType?: any;
     ValueType?: any;
+    isUnion?: boolean;
     isArray?: boolean;
     isMap?: boolean;
     readonly?: boolean;
     aliases?: string[];
+    unionTypes?: any[];
     schema?: {
         description: string;
         dataType: DataType;
@@ -78,6 +80,22 @@ export declare class Optional<T> {
      */
     get(): T;
 }
+export interface ModelConversionOptions {
+    array?: boolean;
+    maybeArray?: boolean;
+    format?: DataFormat;
+}
+export interface ModelAdvanceConversionOptions extends ModelConversionOptions {
+    headers?: string[];
+    ignoreErrors?: boolean;
+    delimiter?: string;
+    newline?: string;
+}
+export interface ModelURLConversionOptions extends ModelAdvanceConversionOptions {
+    requestHeaders?: any;
+    mode?: any;
+}
+export type ModelJSONConversionOptions = Omit<ModelConversionOptions, "format">;
 /**
  * A Data de/serializer class that manages and validates data as JavaScript Objects
  */
@@ -87,46 +105,42 @@ export declare class Model {
     /**
      * Converts arraybuffer to a model
      * @param data arraybuffer
-     * @param format data format
      * @param options configurations for deserializing the data
      * @returns new model or an array of models
      */
-    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, format?: DataFormat, options?: {
-        headers?: string[];
-        ignoreErrors?: boolean;
-        array?: boolean;
-        delimiter?: string;
-        newline?: string;
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options?: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray">): T;
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): T[];
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        maybeArray: true;
     }): T | T[];
+    static fromBuffer<T extends Model>(this: ModelConstructor<T>, data: Uint8Array | Buffer, options?: ModelAdvanceConversionOptions): T | T[];
     /**
      * Downloads data from the given source and deserializes the data to one or more models
      * @param source URL source to fetch the data
-     * @param format data format
      * @param options configurations for deserializing and/or retrieving the data
      * @returns one or more models
      */
-    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, format?: DataFormat, options?: {
-        headers?: string[];
-        ignoreErrors?: boolean;
-        array?: boolean;
-        delimiter?: string;
-        newline?: string;
-        requestHeaders?: any;
-        mode?: any;
+    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, options?: Omit<ModelURLConversionOptions, "array" | "maybeArray">): Promise<T>;
+    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, options: Omit<ModelURLConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): Promise<T[]>;
+    static fromURL<T extends Model>(this: ModelConstructor<T>, source: string, options: Omit<ModelURLConversionOptions, "array" | "maybeArray"> & {
+        maybeArray: true;
     }): Promise<T | T[]>;
     /**
      * Deserializes one or more models from a Blob
      * @param data blob data
-     * @param format data format
      * @param options configurations for deserializing the data
      * @returns one or more models
      */
-    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, format?: DataFormat, options?: {
-        headers?: string[];
-        ignoreErrors?: boolean;
-        array?: boolean;
-        delimiter?: string;
-        newline?: string;
+    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, options?: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray">): Promise<T>;
+    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): Promise<T[]>;
+    static fromBlob<T extends Model>(this: ModelConstructor<T>, data: Blob, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        maybeArray: true;
     }): Promise<T | T[]>;
     /**
      * Deserializes one or more models from given string
@@ -137,12 +151,12 @@ export declare class Model {
      * @param format data format
      * @param options
      */
-    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, format?: DataFormat, options?: {
-        headers?: string[];
-        ignoreErrors?: boolean;
-        array?: boolean;
-        delimiter?: string;
-        newline?: string;
+    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, options?: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray">): T;
+    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, options: Omit<ModelAdvanceConversionOptions, "array" | "maybeArray"> & {
+        array: true;
+    }): T[];
+    static fromString<T extends Model>(this: ModelConstructor<T>, data: string, options: Omit<ModelAdvanceConversionOptions, "maybeArray"> & {
+        maybeArray: true;
     }): T | T[];
     /**
      * Converts a JSON object to a model
@@ -150,6 +164,10 @@ export declare class Model {
      * @returns new model
      */
     static fromJSON<T extends Model>(this: ModelConstructor<T>, data: object): T;
+    static fromJSON<T extends Model>(this: ModelConstructor<T>, data: object, options: {
+        array: true;
+    }): T[];
+    static fromJSON<T extends Model>(this: ModelConstructor<T>, data: object, options: ModelJSONConversionOptions): T | T[];
     /**
      * Converts the current model to a JSON object
      */
@@ -201,9 +219,9 @@ export declare class Model {
      */
     private static buildPropTree;
     /**
-     * Constructs a model from a JSON object
-     * @param data JSON object
-     * @param format
+     * Constructs a model from JSON objects
+     * @param data JSON object or array of JSON object
+     * @param options
      * @private
      */
     private static fromObject;

package/data/model/model.mjs

@@ -52,14 +52,9 @@ class Optional {
  * A Data de/serializer class that manages and validates data as JavaScript Objects
  */
 class Model {
-    /**
-     * Converts arraybuffer to a model
-     * @param data arraybuffer
-     * @param format data format
-     * @param options configurations for deserializing the data
-     * @returns new model or an array of models
-     */
-    static fromBuffer(data, format = DataFormat.JSON, options) {
+    static fromBuffer(data, options) {
+        var _a;
+        const format = (_a = options === null || options === void 0 ? void 0 : options.format) !== null && _a !== void 0 ? _a : DataFormat.JSON;
         switch (format) {
             case DataFormat.MESSAGE_PACK: {
                 const decoder = decode;
@@ -68,27 +63,18 @@ class Model {
                     throw new ParsingError([], "expected an array of models");
                 if ((!(options === null || options === void 0 ? void 0 : options.array) && result instanceof Array) || Array.isArray(result))
                     throw new ParsingError([], "expected only one model");
-                if (result instanceof Array || Array.isArray(result))
-                    return result.map((v) => this.fromJSON(v));
-                return this.fromJSON(result);
+                return this.fromJSON(result, { array: options === null || options === void 0 ? void 0 : options.array, maybeArray: options === null || options === void 0 ? void 0 : options.maybeArray });
             }
             case DataFormat.CSV: {
                 const text = data instanceof Uint8Array ? new TextDecoder().decode(data.buffer) : data.toString();
-                return this.fromString(text, format, options);
+                return this.fromString(text, options);
             }
             case DataFormat.XML:
             case DataFormat.JSON:
-                return this.fromString(data instanceof Uint8Array ? new TextDecoder().decode(data) : data.toString(), format, options);
+                return this.fromString(data instanceof Uint8Array ? new TextDecoder().decode(data) : data.toString(), options);
         }
     }
-    /**
-     * Downloads data from the given source and deserializes the data to one or more models
-     * @param source URL source to fetch the data
-     * @param format data format
-     * @param options configurations for deserializing and/or retrieving the data
-     * @returns one or more models
-     */
-    static fromURL(source, format = DataFormat.JSON, options) {
+    static fromURL(source, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const fetcher = fetch;
             const resp = yield fetcher(source, {
@@ -98,48 +84,37 @@ class Model {
             });
             if (!resp.ok)
                 throw new NetworkError(resp.status);
-            return yield this.fromBlob(yield resp.blob(), format, options);
+            return yield this.fromBlob(yield resp.blob(), options);
         });
     }
-    /**
-     * Deserializes one or more models from a Blob
-     * @param data blob data
-     * @param format data format
-     * @param options configurations for deserializing the data
-     * @returns one or more models
-     */
-    static fromBlob(data, format = DataFormat.JSON, options) {
+    static fromBlob(data, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.fromBuffer(new Uint8Array(yield data.arrayBuffer()), format);
+            return this.fromBuffer(new Uint8Array(yield data.arrayBuffer()), options);
         });
     }
-    /**
-     * Deserializes one or more models from given string
-     *
-     * @remarks
-     * If the data format is a binary one, the provided string should be a hexadecimal string.
-     * @param data string data source
-     * @param format data format
-     * @param options
-     */
-    static fromString(data, format = DataFormat.JSON, options) {
-        var _a, _b, _c, _d, _e, _f;
+    static fromString(data, options) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const format = (_a = options === null || options === void 0 ? void 0 : options.format) !== null && _a !== void 0 ? _a : DataFormat.JSON;
         switch (format) {
             case DataFormat.JSON:
                 try {
                     data = JSON.parse(data);
                 }
                 catch (e) {
-                    throw new ParsingError((_a = e === null || e === void 0 ? void 0 : e.message) !== null && _a !== void 0 ? _a : String(e));
+                    throw new ParsingError((_b = e === null || e === void 0 ? void 0 : e.message) !== null && _b !== void 0 ? _b : String(e));
                 }
-                return this.fromJSON(data);
+                return this.fromJSON(data, { maybeArray: options === null || options === void 0 ? void 0 : options.maybeArray, array: options === null || options === void 0 ? void 0 : options.array });
             case DataFormat.XML:
-                return this.fromObject(this.__xmlParser__.xml2js(data), format);
+                return this.fromObject(this.__xmlParser__.xml2js(data), {
+                    format,
+                    maybeArray: options === null || options === void 0 ? void 0 : options.maybeArray,
+                    array: options === null || options === void 0 ? void 0 : options.array,
+                });
             case DataFormat.CSV: {
                 let result;
                 let text = data;
                 if (options === null || options === void 0 ? void 0 : options.headers)
-                    text = options.headers.join((_b = options === null || options === void 0 ? void 0 : options.delimiter) !== null && _b !== void 0 ? _b : ",") + ((_c = options.newline) !== null && _c !== void 0 ? _c : "\n") + text;
+                    text = options.headers.join((_c = options === null || options === void 0 ? void 0 : options.delimiter) !== null && _c !== void 0 ? _c : ",") + ((_d = options.newline) !== null && _d !== void 0 ? _d : "\n") + text;
                 try {
                     result = Papa.parse(text, {
                         header: true,
@@ -147,27 +122,24 @@ class Model {
                     });
                 }
                 catch (e) {
-                    throw new ParsingError([], (_d = e === null || e === void 0 ? void 0 : e.message) !== null && _d !== void 0 ? _d : String(e));
+                    throw new ParsingError([], (_e = e === null || e === void 0 ? void 0 : e.message) !== null && _e !== void 0 ? _e : String(e));
                 }
                 if (!(options === null || options === void 0 ? void 0 : options.ignoreErrors) && result.errors.length > 0)
                     throw new ParsingError(result.errors);
                 if (!(options === null || options === void 0 ? void 0 : options.array) && result.data.length > 0)
                     throw new ParsingError([], "Too many records found");
-                if (options === null || options === void 0 ? void 0 : options.array)
-                    return result.data.map((v) => this.fromObject(v));
-                return this.fromObject(result.data[0]);
+                if ((options === null || options === void 0 ? void 0 : options.array) || (options === null || options === void 0 ? void 0 : options.maybeArray))
+                    return this.fromObject(result.data, { array: true });
+                if (!(options === null || options === void 0 ? void 0 : options.maybeArray) || (options.maybeArray && result.data.length === 1))
+                    return this.fromObject(result.data[0]);
+                break;
             }
             default:
-                return this.fromBuffer(new Uint8Array((_f = (_e = data.match(/../g)) === null || _e === void 0 ? void 0 : _e.map((h) => parseInt(h, 16))) !== null && _f !== void 0 ? _f : []), format, options);
+                return this.fromBuffer(new Uint8Array((_g = (_f = data.match(/../g)) === null || _f === void 0 ? void 0 : _f.map((h) => parseInt(h, 16))) !== null && _g !== void 0 ? _g : []), options);
         }
     }
-    /**
-     * Converts a JSON object to a model
-     * @param data JSON Object
-     * @returns new model
-     */
-    static fromJSON(data) {
-        return this.fromObject(data, DataFormat.JSON);
+    static fromJSON(data, options) {
+        return this.fromObject(data, options);
     }
     /**
      * Converts the current model to a JSON object
@@ -210,6 +182,7 @@ class Model {
             return acc;
         }, {}, Array.from(((_b = (_a = Model.buildPropTree(Object.getPrototypeOf(this))) === null || _a === void 0 ? void 0 : _a.fields) !== null && _b !== void 0 ? _b : new Map()).entries()));
     }
+    // TODO add support for union fields in serialization and deserialization, and later date include schema generation
     /**
      * Converts the current model to a JSON string
      */
@@ -400,15 +373,17 @@ class Model {
         }
         return tree;
     }
-    /**
-     * Constructs a model from a JSON object
-     * @param data JSON object
-     * @param format
-     * @private
-     */
-    static fromObject(data, format = DataFormat.JSON) {
-        if (data instanceof Array || Array.isArray(data) || typeof data !== "object") {
-            throw new ParsingError([], "Invalid data provided. Must be an object");
+    static fromObject(data, options) {
+        var _a;
+        const format = (_a = options === null || options === void 0 ? void 0 : options.format) !== null && _a !== void 0 ? _a : DataFormat.JSON;
+        if (Array.isArray(data)) {
+            if (!(options === null || options === void 0 ? void 0 : options.array) || !(options === null || options === void 0 ? void 0 : options.maybeArray))
+                throw new ParsingError([], "Invalid data provided. Must be an object");
+            else
+                return data.map((item) => this.fromObject(item, { format }));
+        }
+        else if (options === null || options === void 0 ? void 0 : options.array) {
+            throw new ParsingError([], "Invalid data provided. Must be an array of objects");
         }
         const processValue = (fieldProps, value) => {
             var _a, _b;

package/data/model/property.cjs

@@ -129,6 +129,30 @@ const Field = (name, type = undefined) => (target, key) => {
     props.parent = Object.getPrototypeOf(target).constructor.name;
     model.namespacedModelInternalProps.set(target.constructor.name, props);
 };
+const UnionField = (types, name) => (target, key) => {
+    var _a, _b, _c;
+    const schema = {};
+    const props = (_a = model.namespacedModelInternalProps.get(target.constructor.name)) !== null && _a !== void 0 ? _a : {
+        fields: new Map(),
+    };
+    schema.description = (_b = name === null || name === void 0 ? void 0 : name.description) !== null && _b !== void 0 ? _b : "";
+    const fieldProp = (_c = props.fields.get(key)) !== null && _c !== void 0 ? _c : {};
+    fieldProp.name = typeof name === "string" ? name : typeof name === "object" ? name.name : key;
+    fieldProp.isUnion = true;
+    fieldProp.schema = schema;
+    fieldProp.unionTypes = types;
+    props.fields.set(key, fieldProp);
+    if (typeof name === "string" && name) {
+        if (fieldProp.aliases) {
+            fieldProp.aliases.push(name);
+        }
+        else {
+            fieldProp.aliases = [name];
+        }
+    }
+    props.parent = Object.getPrototypeOf(target).constructor.name;
+    model.namespacedModelInternalProps.set(target.constructor.name, props);
+};
 /**
  * A property that exists on the incoming data, that contains an array of same data types
  * @param type Type of data in the array
@@ -310,5 +334,6 @@ exports.RaiseError = RaiseError;
 exports.Range = Range;
 exports.Readonly = Readonly;
 exports.SchemaType = SchemaType;
+exports.UnionField = UnionField;
 exports.UpperBound = UpperBound;
 exports.Validator = Validator;

package/data/model/property.d.ts

@@ -1,4 +1,4 @@
-import { IgnoreProps } from "./model";
+import { IgnoreProps, Model } from "./model";
 import { DataType } from "./types";
 /**
  * A property that exist in the incoming data
@@ -11,6 +11,10 @@ export declare const Field: (name?: string | {
     name: string;
     description: string;
 }, type?: any) => (target: any, key: string) => void;
+export declare const UnionField: <T extends new (...args: any[]) => Model>(types: T[], name?: string | {
+    name: string;
+    description: string;
+}) => (target: any, key: string) => void;
 /**
  * A property that exists on the incoming data, that contains an array of same data types
  * @param type Type of data in the array

package/data/model/property.mjs

@@ -108,6 +108,30 @@ const Field = (name, type = undefined) => (target, key) => {
     props.parent = Object.getPrototypeOf(target).constructor.name;
     namespacedModelInternalProps.set(target.constructor.name, props);
 };
+const UnionField = (types, name) => (target, key) => {
+    var _a, _b, _c;
+    const schema = {};
+    const props = (_a = namespacedModelInternalProps.get(target.constructor.name)) !== null && _a !== void 0 ? _a : {
+        fields: new Map(),
+    };
+    schema.description = (_b = name === null || name === void 0 ? void 0 : name.description) !== null && _b !== void 0 ? _b : "";
+    const fieldProp = (_c = props.fields.get(key)) !== null && _c !== void 0 ? _c : {};
+    fieldProp.name = typeof name === "string" ? name : typeof name === "object" ? name.name : key;
+    fieldProp.isUnion = true;
+    fieldProp.schema = schema;
+    fieldProp.unionTypes = types;
+    props.fields.set(key, fieldProp);
+    if (typeof name === "string" && name) {
+        if (fieldProp.aliases) {
+            fieldProp.aliases.push(name);
+        }
+        else {
+            fieldProp.aliases = [name];
+        }
+    }
+    props.parent = Object.getPrototypeOf(target).constructor.name;
+    namespacedModelInternalProps.set(target.constructor.name, props);
+};
 /**
  * A property that exists on the incoming data, that contains an array of same data types
  * @param type Type of data in the array
@@ -279,4 +303,4 @@ const UpperBound = (value, inclusive = false) => createValidator(inclusive ? (v)
  */
 const Range = (lower, upper, inclusive = false) => createValidator(inclusive ? (v) => lower <= v && v <= upper : (v) => lower <= v && v < upper, new InvalidValue(`value is not within the range of ${lower} <= v ` + (inclusive ? `<= ${upper}` : `< ${upper}`)));
 
-export { Alias, ArrayField, Field, Ignore, LowerBound, MapField, RaiseError, Range, Readonly, SchemaType, UpperBound, Validator };
+export { Alias, ArrayField, Field, Ignore, LowerBound, MapField, RaiseError, Range, Readonly, SchemaType, UnionField, UpperBound, Validator };

package/data/model.cjs

@@ -21,6 +21,7 @@ exports.RaiseError = property.RaiseError;
 exports.Range = property.Range;
 exports.Readonly = property.Readonly;
 exports.SchemaType = property.SchemaType;
+exports.UnionField = property.UnionField;
 exports.UpperBound = property.UpperBound;
 exports.Validator = property.Validator;
 Object.defineProperty(exports, 'DataFormat', {

package/data/model.mjs

@@ -1,5 +1,5 @@
 export { Model, Optional } from './model/model.mjs';
-export { Alias, ArrayField, Field, Ignore, LowerBound, MapField, RaiseError, Range, Readonly, SchemaType, UpperBound, Validator } from './model/property.mjs';
+export { Alias, ArrayField, Field, Ignore, LowerBound, MapField, RaiseError, Range, Readonly, SchemaType, UnionField, UpperBound, Validator } from './model/property.mjs';
 export { DataFormat, DataType } from './model/types.mjs';
 export { APIKeyCredentials, BasicCredentials, BearerCredentials, Credentials } from './model/credentials.mjs';
 export { createModelClassAnnotationTag, createModelFieldAnnotationTag, getModelClassAnnotationTagProperties, getModelFieldAnnotationTagProperties } from './model/plugin.mjs';

package/data/store/manager.cjs

@@ -10,7 +10,7 @@ require('uuid');
 var Pair = require('../../data-structures/array/Pair.cjs');
 var model = require('../model/model.cjs');
 var property = require('../model/property.cjs');
-var types = require('../model/types.cjs');
+require('../model/types.cjs');
 require('../model/credentials.cjs');
 
 class PersistedCachedRecord extends model.Model {
@@ -65,7 +65,7 @@ class Cache {
                     .get(transformedKey)
                     .thenApply(({ value }) => {
                     if (value) {
-                        const val = PersistedCachedRecord.fromString(value, types.DataFormat.JSON);
+                        const val = PersistedCachedRecord.fromString(value);
                         val.value = this.decode(val.value);
                         return val;
                     }
@@ -109,7 +109,7 @@ class Cache {
     }
     values() {
         var _a, _b;
-        return ((_b = (_a = this.persistStore) === null || _a === void 0 ? void 0 : _a.values().map((v) => PersistedCachedRecord.fromString(v, types.DataFormat.JSON)).map((v) => v.value)) !== null && _b !== void 0 ? _b : stream.Stream.of(this.valuesSync()));
+        return ((_b = (_a = this.persistStore) === null || _a === void 0 ? void 0 : _a.values().map((v) => PersistedCachedRecord.fromString(v)).map((v) => v.value)) !== null && _b !== void 0 ? _b : stream.Stream.of(this.valuesSync()));
     }
     valuesSync() {
         return this.memStore.values(true);

package/data/store/manager.mjs

@@ -8,7 +8,7 @@ import 'uuid';
 import { pair } from '../../data-structures/array/Pair.mjs';
 import { Model } from '../model/model.mjs';
 import { Field } from '../model/property.mjs';
-import { DataFormat } from '../model/types.mjs';
+import '../model/types.mjs';
 import '../model/credentials.mjs';
 
 class PersistedCachedRecord extends Model {
@@ -63,7 +63,7 @@ class Cache {
                     .get(transformedKey)
                     .thenApply(({ value }) => {
                     if (value) {
-                        const val = PersistedCachedRecord.fromString(value, DataFormat.JSON);
+                        const val = PersistedCachedRecord.fromString(value);
                         val.value = this.decode(val.value);
                         return val;
                     }
@@ -107,7 +107,7 @@ class Cache {
     }
     values() {
         var _a, _b;
-        return ((_b = (_a = this.persistStore) === null || _a === void 0 ? void 0 : _a.values().map((v) => PersistedCachedRecord.fromString(v, DataFormat.JSON)).map((v) => v.value)) !== null && _b !== void 0 ? _b : Stream.of(this.valuesSync()));
+        return ((_b = (_a = this.persistStore) === null || _a === void 0 ? void 0 : _a.values().map((v) => PersistedCachedRecord.fromString(v)).map((v) => v.value)) !== null && _b !== void 0 ? _b : Stream.of(this.valuesSync()));
     }
     valuesSync() {
         return this.memStore.values(true);

package/networking/EventSourceService.cjs

@@ -77,7 +77,7 @@ class EventSourceService extends NetworkService.NetworkService {
                     .map((data) => {
                     if (config.responseClass.prototype instanceof model.Model) {
                         const ModelClass = config.responseClass;
-                        return ModelClass.fromString(data, config.dataFormat);
+                        return ModelClass.fromString(data, { format: config.dataFormat });
                     }
                     return config.responseClass(data, config.dataFormat);
                 })

package/networking/EventSourceService.mjs

@@ -56,7 +56,7 @@ class EventSourceService extends NetworkService {
                     .map((data) => {
                     if (config.responseClass.prototype instanceof Model) {
                         const ModelClass = config.responseClass;
-                        return ModelClass.fromString(data, config.dataFormat);
+                        return ModelClass.fromString(data, { format: config.dataFormat });
                     }
                     return config.responseClass(data, config.dataFormat);
                 })

package/package.json

@@ -1 +1 @@
-{"name":"gingersnap","version":"0.23.10","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/AtomicValue":{"import":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.mjs"},"require":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.cjs"}},"./data/store":{"import":{"types":"./data/store/index.d.ts","default":"./data/store.mjs"},"require":{"types":"./data/store/index.d.ts","default":"./data/store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}
+{"name":"gingersnap","version":"0.23.12","description":"A general purpose library built with the aim of filling the gaps of javascript shortcomings","dependencies":{"@msgpack/msgpack":"^3.0.0-beta2","browser-or-node":"^3.0.0-pre.0","modern-isomorphic-ws":"^1.0.5","object-hash":"^3.0.0","papaparse":"^5.4.1","protobufjs":"^7.2.6","ramda":"^0.30.1","reflect-metadata":"^0.2.2","tslib":"^2.6.3","uuid":"^9.0.1","ws":"^8.16.0","x2js":"^3.4.4"},"author":"CookieNerds LLC","exports":{"./synchronize":{"import":{"types":"./synchronize.d.ts","default":"./synchronize.mjs"},"require":{"types":"./synchronize.d.ts","default":"./synchronize.cjs"}},"./mocks":{"import":{"types":"./mocks.d.ts","default":"./mocks.mjs"},"require":{"types":"./mocks.d.ts","default":"./mocks.cjs"}},"./socket":{"import":{"types":"./socket.d.ts","default":"./socket.mjs"},"require":{"types":"./socket.d.ts","default":"./socket.cjs"}},"./typing":{"import":{"types":"./typing.d.ts","default":"./typing.mjs"},"require":{"types":"./typing.d.ts","default":"./typing.cjs"}},"./stream":{"import":{"types":"./stream/index.d.ts","default":"./stream.mjs"},"require":{"types":"./stream/index.d.ts","default":"./stream.cjs"}},"./reflection/injector":{"import":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.mjs"},"require":{"types":"./reflection/injector.d.ts","default":"./reflection/injector.cjs"}},"./stream/call":{"import":{"types":"./stream/call.d.ts","default":"./stream/call.mjs"},"require":{"types":"./stream/call.d.ts","default":"./stream/call.cjs"}},"./stream/state":{"import":{"types":"./stream/state.d.ts","default":"./stream/state.mjs"},"require":{"types":"./stream/state.d.ts","default":"./stream/state.cjs"}},"./stream/collector":{"import":{"types":"./stream/collector.d.ts","default":"./stream/collector.mjs"},"require":{"types":"./stream/collector.d.ts","default":"./stream/collector.cjs"}},"./stream/observable":{"import":{"types":"./stream/observable.d.ts","default":"./stream/observable.mjs"},"require":{"types":"./stream/observable.d.ts","default":"./stream/observable.cjs"}},"./networking":{"import":{"types":"./networking/index.d.ts","default":"./networking.mjs"},"require":{"types":"./networking/index.d.ts","default":"./networking.cjs"}},"./managers":{"import":{"types":"./managers/index.d.ts","default":"./managers.mjs"},"require":{"types":"./managers/index.d.ts","default":"./managers.cjs"}},"./future":{"import":{"types":"./future/index.d.ts","default":"./future.mjs"},"require":{"types":"./future/index.d.ts","default":"./future.cjs"}},"./errors":{"import":{"types":"./errors/index.d.ts","default":"./errors.mjs"},"require":{"types":"./errors/index.d.ts","default":"./errors.cjs"}},"./data-structures/array":{"import":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.mjs"},"require":{"types":"./data-structures/array/index.d.ts","default":"./data-structures/array.cjs"}},"./data-structures/object":{"import":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.mjs"},"require":{"types":"./data-structures/object/index.d.ts","default":"./data-structures/object.cjs"}},"./data/decoders":{"import":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.mjs"},"require":{"types":"./data/decoders/index.d.ts","default":"./data/decoders.cjs"}},"./data/model":{"import":{"types":"./data/model/index.d.ts","default":"./data/model.mjs"},"require":{"types":"./data/model/index.d.ts","default":"./data/model.cjs"}},"./data/bus":{"import":{"types":"./data/bus.d.ts","default":"./data/bus.mjs"},"require":{"types":"./data/bus.d.ts","default":"./data/bus.cjs"}},"./data/AtomicValue":{"import":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.mjs"},"require":{"types":"./data/AtomicValue.d.ts","default":"./data/AtomicValue.cjs"}},"./data/store":{"import":{"types":"./data/store/index.d.ts","default":"./data/store.mjs"},"require":{"types":"./data/store/index.d.ts","default":"./data/store.cjs"}},"./functools":{"import":{"types":"./functools/index.d.ts","default":"./functools.mjs"},"require":{"types":"./functools/index.d.ts","default":"./functools.cjs"}}}}

package/stream/index.d.ts

@@ -144,6 +144,7 @@ export declare class Stream<T> implements AsyncGenerator<T> {
      * @param callback
      */
     filter(callback: (v: T) => boolean | Promise<boolean> | Future<boolean>): Stream<T>;
+    filterNotNull(): Stream<NonNullable<T>>;
     reduce<K, V>(initialData: K, functor: (v: T, prev: K | V) => V, exhaustive?: boolean): Stream<V>;
     reduceWhile<K, V>(predicate: (v: T) => boolean, initialData: K, functor: (v: T, prev: K | V) => V, exhaustive?: boolean): Stream<V>;
     /**

package/stream.cjs

@@ -396,6 +396,9 @@ class Stream {
         });
         return this;
     }
+    filterNotNull() {
+        return this.filter((it) => it !== null || it !== undefined);
+    }
     reduce(initialData, functor, exhaustive = true) {
         if (!this.canAlterStream)
             throw new IllegalOperationError.IllegalOperationError("Cannot alter the stream as it is frozen");

package/stream.mjs

@@ -375,6 +375,9 @@ class Stream {
         });
         return this;
     }
+    filterNotNull() {
+        return this.filter((it) => it !== null || it !== undefined);
+    }
     reduce(initialData, functor, exhaustive = true) {
         if (!this.canAlterStream)
             throw new IllegalOperationError("Cannot alter the stream as it is frozen");