gingersnap 0.23.11 → 0.23.13

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,36 +143,34 @@ 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
      */
-    object(removeMissingFields = false) {
+    object(options) {
         var _a, _b;
+        const { removeMissingFields = false, keepOptionals = true } = options || {};
         const serialize = (value) => {
             if (value instanceof Model) {
-                return value.object(removeMissingFields);
+                return value.object({ removeMissingFields, keepOptionals });
             }
             else if (value instanceof Array || Array.isArray(value)) {
                 return value.map((v) => serialize(v));
@@ -217,6 +190,13 @@ class Model {
             else if (value instanceof Function) {
                 return null;
             }
+            else if (value instanceof Optional) {
+                if (keepOptionals)
+                    return value;
+                if (value.isPresent())
+                    return value.get();
+                return null;
+            }
             return value;
         };
         return R__namespace.reduce((acc, [key, fieldProps]) => {
@@ -234,42 +214,42 @@ class Model {
     /**
      * Converts the current model to a JSON string
      */
-    json(removeMissingFields = false) {
-        return JSON.stringify(this.object(removeMissingFields));
+    json(options) {
+        return JSON.stringify(this.object(options));
     }
     /**
      * Converts the current model to an arraybuffer
      */
-    buffer(removeMissingFields = false) {
-        return new TextEncoder().encode(this.json(removeMissingFields));
+    buffer(options) {
+        return new TextEncoder().encode(this.json(options));
     }
     /**
      * Converts the current model to a blob
      */
-    blob(removeMissingFields = false) {
-        return new Blob([this.buffer(removeMissingFields)]);
+    blob(options) {
+        return new Blob([this.buffer(options)]);
     }
     /**
      * Converts the current model to an XML string
      */
-    xml(removeMissingFields = false) {
-        return Model.__xmlParser__.js2xml(this.object(removeMissingFields));
+    xml(options) {
+        return Model.__xmlParser__.js2xml(this.object(options));
     }
     /**
      * Converts the current model to message pack binary format
      * @returns message pack binary
      */
-    messagePack(removeMissingFields = false) {
-        return msgpack.encode(this.object(removeMissingFields)).buffer;
+    messagePack(options) {
+        return msgpack.encode(this.object(options)).buffer;
     }
     /**
      * Converts the current model to csv format
-     * @param removeMissingFields
+     * @param options
      * @param config CSV unparsing configuration
      * @returns csv string
      */
-    csv(removeMissingFields = false, config) {
-        return Papa.unparse([this.object(removeMissingFields)], config);
+    csv(options, config) {
+        return Papa.unparse([this.object(options)], config);
     }
     clone() {
         const newModel = new (Object.getPrototypeOf(this))();
@@ -280,10 +260,10 @@ class Model {
     }
     /**
      * Retrieves the schema of the current model based on the selected format
-     * @param format data format
+     * @param includeTitleAndDraft boolean whether the title and JSON schema draft version should be referenced in the schema
      * @returns the schema for the current model
      */
-    static schema(addTitleAndDraftRef = true) {
+    static schema(includeTitleAndDraft = true) {
         const model = new this();
         const props = this.buildPropTree(Object.getPrototypeOf(model));
         const handleArrays = (v, entry) => {
@@ -375,24 +355,38 @@ class Model {
             }
             return entry;
         }));
-        if (addTitleAndDraftRef)
-            return {
-                $schema: "https://json-schema.org/draft/2020-12/schema",
-                title: this.name,
+        const fieldEntries = Array.from(props.fields.entries());
+        const optionals = Object.getOwnPropertyNames(this.prototype)
+            .filter((key) => key !== "constructor")
+            .map((key) => [key, model[key]])
+            .map(([key, modelValue]) => ({
+            modelValue,
+            fieldProps: fieldEntries.find(([k, v]) => { var _a; return k === key || ((_a = v.aliases) === null || _a === void 0 ? void 0 : _a.includes(key)); }),
+        }))
+            .filter(({ modelValue, fieldProps }) => { var _a, _b, _c; return modelValue !== undefined || ((_b = (_a = fieldProps[1].schema) === null || _a === void 0 ? void 0 : _a.options) === null || _b === void 0 ? void 0 : _b.optional) || ((_c = fieldProps[1].ignore) === null || _c === void 0 ? void 0 : _c.deserialize); })
+            .map(({ fieldProps }) => fieldProps[0]);
+        const required = fieldEntries.filter(([k]) => !optionals.includes(k)).map(([k]) => k);
+        const result = required.length
+            ? {
                 type: "object",
                 properties: generateProperties(),
                 additionalProperties: false,
-            };
-        else {
-            return {
+                required,
+            }
+            : {
                 type: "object",
                 properties: generateProperties(),
                 additionalProperties: false,
             };
+        if (includeTitleAndDraft) {
+            return Object.assign(Object.assign({}, result), { $schema: "https://json-schema.org/draft/2020-12/schema", title: this.name });
+        }
+        else {
+            return result;
         }
     }
     toString() {
-        return this.json(true);
+        return this.json({ removeMissingFields: true, keepOptionals: false });
     }
     /**
      * Constructs the model properties by traversing the inheritance tree of the current Model being instantiated
@@ -421,15 +415,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;
@@ -441,7 +437,7 @@ class Model {
         const model = new this();
         const props = this.buildPropTree(Object.getPrototypeOf(model));
         R__namespace.forEach(([key, fieldProps]) => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             let value = data[key];
             if (value === undefined || value === null) {
                 for (const alias of (_a = fieldProps.aliases) !== null && _a !== void 0 ? _a : []) {
@@ -462,12 +458,101 @@ class Model {
             else if ((value === undefined || value === null) && !(model[key] === undefined || model[key] === null)) {
                 return;
             }
+            const checkOtherTypes = (value, Type, fallback) => {
+                var _a, _b;
+                if ((Type === null || Type === void 0 ? void 0 : Type.name) === "String") {
+                    return processValue(fieldProps, String(value));
+                }
+                else if ((Type === null || Type === void 0 ? void 0 : Type.name) === "Boolean") {
+                    return processValue(fieldProps, Boolean(value));
+                }
+                else if ((Type === null || Type === void 0 ? void 0 : Type.name) === "Number") {
+                    const v = Number(value);
+                    if (isNaN(v))
+                        throw new ParsingError.ParsingError([], `value for ${key} is not a valid number`);
+                    return processValue(fieldProps, v);
+                }
+                else if ((Type === null || Type === void 0 ? void 0 : Type.name) === "Map") {
+                    const valueType = typeof value;
+                    switch (valueType) {
+                        case "object": {
+                            try {
+                                return processValue(fieldProps, value instanceof Array || Array.isArray(value) ? new Map(value) : new Map(Object.entries(value)));
+                            }
+                            catch (e) {
+                                throw new ParsingError.ParsingError([], (_a = e === null || e === void 0 ? void 0 : e.message) !== null && _a !== void 0 ? _a : String(e));
+                            }
+                        }
+                        case "string":
+                            try {
+                                value = JSON.parse(value);
+                                return processValue(fieldProps, value instanceof Array || Array.isArray(value) ? new Map(value) : new Map(Object.entries(value)));
+                            }
+                            catch (e) {
+                                throw new ParsingError.ParsingError([], (_b = e === null || e === void 0 ? void 0 : e.message) !== null && _b !== void 0 ? _b : String(e));
+                            }
+                        default:
+                            throw new ParsingError.ParsingError([value], `value for ${key} cannot be converted to a Map`);
+                    }
+                }
+                else if ((Type === null || Type === void 0 ? void 0 : Type.name) === "Set") {
+                    if (value instanceof Array || Array.isArray(value)) {
+                        return processValue(fieldProps, new Set(value));
+                    }
+                    else if (typeof value === "string") {
+                        return processValue(fieldProps, new Set(JSON.parse(value)));
+                    }
+                    throw new ParsingError.ParsingError([value], `value for ${key} cannot be converted to a Set`);
+                }
+                else {
+                    return fallback();
+                }
+            };
+            function processUnionField(value) {
+                let foundMatch = false;
+                let result;
+                for (const unionType of fieldProps.unionTypes) {
+                    try {
+                        result = checkOtherTypes(value, unionType, () => {
+                            if (unionType.prototype instanceof Model) {
+                                const parser$1 = parser.parse({
+                                    string: (v) => unionType.fromString(v, format),
+                                    object: (v) => unionType.fromObject(v, format),
+                                    default: () => {
+                                        throw new ParsingError.ParsingError([], `value for ${key} is expected to be an Array, instead received ${typeof value}`);
+                                    },
+                                    supportArray: true,
+                                });
+                                return processValue(fieldProps, parser$1(value));
+                            }
+                            throw new ParsingError.ParsingError([], `value for ${key} type is unsupported ${typeof value}`);
+                        });
+                        foundMatch = true;
+                        break;
+                    }
+                    catch (e) { }
+                }
+                if (!foundMatch) {
+                    throw new ParsingError.ParsingError([], `value for ${key} does not match any of the union types expected`);
+                }
+                return result;
+            }
             if ((_e = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(model), key)) === null || _e === void 0 ? void 0 : _e.set) {
                 model[key] = processValue(fieldProps, value);
             }
             else if ((_f = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(model), key)) === null || _f === void 0 ? void 0 : _f.get) {
                 return;
             }
+            else if (fieldProps.isUnion) {
+                if (!fieldProps.isArray) {
+                    model[key] = processUnionField(value);
+                }
+                else if (fieldProps.isArray && Array.isArray(value)) {
+                    model[key] = value.map((item) => processUnionField(item));
+                }
+                else
+                    throw new ParsingError.ParsingError([], `value for ${key} is expected to be an array`);
+            }
             else if (model[key] instanceof fieldProps.Type &&
                 typeof model[key] === "function" &&
                 fieldProps.Type instanceof Function) {
@@ -577,51 +662,8 @@ class Model {
                     }
                 }));
             }
-            else if (((_k = fieldProps.Type) === null || _k === void 0 ? void 0 : _k.name) === "String") {
-                model[key] = processValue(fieldProps, String(value));
-            }
-            else if (((_l = fieldProps.Type) === null || _l === void 0 ? void 0 : _l.name) === "Boolean") {
-                model[key] = processValue(fieldProps, Boolean(value));
-            }
-            else if (((_m = fieldProps.Type) === null || _m === void 0 ? void 0 : _m.name) === "Number") {
-                model[key] = processValue(fieldProps, Number(value));
-            }
-            else if (((_o = fieldProps.Type) === null || _o === void 0 ? void 0 : _o.name) === "Map") {
-                const valueType = typeof value;
-                switch (valueType) {
-                    case "object": {
-                        try {
-                            model[key] = processValue(fieldProps, value instanceof Array || Array.isArray(value) ? new Map(value) : new Map(Object.entries(value)));
-                        }
-                        catch (e) {
-                            throw new ParsingError.ParsingError([], (_p = e === null || e === void 0 ? void 0 : e.message) !== null && _p !== void 0 ? _p : String(e));
-                        }
-                        break;
-                    }
-                    case "string":
-                        try {
-                            value = JSON.parse(value);
-                            model[key] = processValue(fieldProps, value instanceof Array || Array.isArray(value) ? new Map(value) : new Map(Object.entries(value)));
-                        }
-                        catch (e) {
-                            throw new ParsingError.ParsingError([], (_q = e === null || e === void 0 ? void 0 : e.message) !== null && _q !== void 0 ? _q : String(e));
-                        }
-                        break;
-                    default:
-                        throw new ParsingError.ParsingError([value], `value for ${key} cannot be converted to a Map`);
-                }
-            }
-            else if (((_r = fieldProps.Type) === null || _r === void 0 ? void 0 : _r.name) === "Set") {
-                if (value instanceof Array || Array.isArray(value)) {
-                    model[key] = processValue(fieldProps, new Set(value));
-                }
-                else if (typeof value === "string") {
-                    model[key] = processValue(fieldProps, new Set(JSON.parse(value)));
-                }
-                throw new ParsingError.ParsingError([value], `value for ${key} cannot be converted to a Set`);
-            }
             else {
-                model[key] = processValue(fieldProps, new fieldProps.Type(value));
+                model[key] = checkOtherTypes(value, fieldProps.Type, () => processValue(fieldProps, new fieldProps.Type(value)));
             }
             if (fieldProps.readonly) {
                 Object.defineProperty(model, key, {
@@ -633,7 +675,7 @@ class Model {
             R__namespace.forEach(([k, v]) => {
                 if (v.__callback__)
                     v.__callback__(k, v.properties, model, key);
-            }, R__namespace.toPairs((_s = fieldProps.customTags) !== null && _s !== void 0 ? _s : {}));
+            }, R__namespace.toPairs((_k = fieldProps.customTags) !== null && _k !== void 0 ? _k : {}));
         }, Array.from(props.fields.entries()));
         return Object.seal(model);
     }