fix: correct import path for getPropertyName function and add UserSimple model with tests

Author: LabEG

src/classes/Serializable.ts

@@ -5,7 +5,7 @@ import {deserializeProperty} from "../functions/DeserializeProperty.js";
 import type {AcceptedTypes} from "../models/AcceptedType.js";
 import {SerializationSettings} from "../models/SerializationSettings.js";
 import {classToFormData} from "../functions/ClassToFormData.js";
-import {getPropertyName} from "../functions/GetProperyName.js";
+import {getPropertyName} from "../functions/GetPropertyName.js";
 import {fromJSON} from "../functions/FromJSON.js";
 
 /**

src/functions/ClassToFormData.ts

@@ -1,6 +1,6 @@
 /* eslint-disable max-statements */
 /* eslint-disable max-lines-per-function */
-import {getPropertyName} from "./GetProperyName.js";
+import {getPropertyName} from "./GetPropertyName.js";
 
 /**
  * Converts a class instance to FormData for use in AJAX forms.

src/functions/FromJSON.ts

@@ -7,7 +7,7 @@ import {Serializable} from "../classes/Serializable";
 import {AcceptedTypes} from "../models/AcceptedType";
 import {SerializationSettings} from "../models/SerializationSettings";
 import {deserializeProperty} from "./DeserializeProperty";
-import {getPropertyName} from "./GetProperyName.js";
+import {getPropertyName} from "./GetPropertyName.js";
 import {onWrongType} from "./OnWrongType.js";
 
 // eslint-disable-next-line max-statements

src/functions/GetProperyName.ts src/functions/GetPropertyName.tssrc/functions/GetProperyName.ts renamed to src/functions/GetPropertyName.ts

@@ -25,6 +25,10 @@ export {PascalCaseNamingStrategy} from "./naming-strategies/PascalCaseNamingStra
 export {KebabCaseNamingStrategy} from "./naming-strategies/KebabCaseNamingStrategy.js";
 export {CamelCaseNamingStrategy} from "./naming-strategies/CamelCaseNamingStrategy.js";
 
-// Utils
+// Functions
 export {classToFormData} from "./functions/ClassToFormData.js";
-export {getPropertyName} from "./functions/GetProperyName.js";
+export {deserializeProperty} from "./functions/DeserializeProperty.js";
+export {fromJSON} from "./functions/FromJSON.js";
+export {getPropertyName} from "./functions/GetPropertyName.js";
+export {onWrongType} from "./functions/OnWrongType.js";
+

src/index.ts

@@ -5,6 +5,8 @@ import {assert} from "chai";
 import {describe, it} from "node:test";
 
 import type {User as IUser, Friend as IFriend} from "./models/User";
+import type {UserSimple as IUserSimple, FriendSimple as IFriendSimple} from "./models/UserSimple";
+import {fromJSON} from "../src/functions/FromJSON";
 
 describe("Base functions", () => {
     it("user from method fromJSON must be instance of User", async () => {
@@ -13,7 +15,7 @@ describe("Base functions", () => {
 
         const [object] = Reflect.get(json, "default") as typeof json;
 
-        const user = new User().fromJSON(object);
+        const user: IUser = new User().fromJSON(object);
 
         assert.isTrue(user instanceof User);
         assert.strictEqual(user.id, object.id, "id is not equal");
@@ -81,7 +83,7 @@ describe("Base functions", () => {
         const json = await import("./jsons/json-generator.json", {with: {type: "json"}});
         const [object] = Reflect.get(json, "default") as typeof json;
 
-        const user = new User().fromString(JSON.stringify(object));
+        const user: IUser = new User().fromString(JSON.stringify(object));
 
         assert.isTrue(user instanceof User);
         assert.strictEqual(user.id, object.id, "id is not equal");
@@ -143,4 +145,39 @@ describe("Base functions", () => {
             assert.strictEqual(friend.name, object.friends[index].name, `friend ${String(index)} name is not equal`);
         });
     });
+
+    it("user from function fromJSON must be instance of User", async () => {
+        const {UserSimple} = await import("./models/UserSimple");
+        const json = await import("./jsons/json-generator.json", {with: {type: "json"}});
+
+        const [object] = Reflect.get(json, "default") as typeof json;
+
+        const user: IUserSimple = fromJSON(new UserSimple(), object);
+
+        assert.isTrue(user instanceof UserSimple);
+        assert.strictEqual(user.id, object.id, "id is not equal");
+        assert.strictEqual(user.index, object.index, "index is not equal");
+        assert.strictEqual(user.guid, object.guid, "guid is not equal");
+        assert.strictEqual(user.isActive, object.isActive, "isActive is not equal");
+        assert.strictEqual(user.balance, object.balance, "balance is not equal");
+        assert.strictEqual(user.picture, object.picture, "picture is not equal");
+        assert.strictEqual(user.age, object.age, "age is not equal");
+        assert.strictEqual(user.eyeColor, object.eyeColor, "eyeColor is not equal");
+        assert.strictEqual(user.name, object.name, "name is not equal");
+        assert.strictEqual(user.company, object.company, "company is not equal");
+        assert.strictEqual(user.email, object.email, "email is not equal");
+        assert.strictEqual(user.phone, object.phone, "phone is not equal");
+        assert.strictEqual(user.address, object.address, "address is not equal");
+        assert.strictEqual(user.about, object.about, "about is not equal");
+        assert.strictEqual(user.latitude, object.latitude, "latitude is not equal");
+        assert.strictEqual(user.longitude, object.longitude, "longitude is not equal");
+        assert.deepEqual(user.tags, object.tags, "tags is not equal");
+        assert.strictEqual(user.greeting, object.greeting, "greeting is not equal");
+        assert.strictEqual(user.favoriteFruit, object.favoriteFruit, "favoriteFruit is not equal");
+
+        user.friends.forEach((friend: IFriendSimple, index: number) => {
+            assert.strictEqual(friend.id, object.friends[index].id, `friend ${String(index)} id is not equal`);
+            assert.strictEqual(friend.name, object.friends[index].name, `friend ${String(index)} name is not equal`);
+        });
+    });
 });

tests/base-functions.spec.ts

@@ -0,0 +1,94 @@
+/* eslint-disable max-classes-per-file */
+import {jsonProperty} from "../../src/decorators/JsonProperty";
+import {jsonIgnore} from "../../src/decorators/JsonIgnore";
+
+export class FriendSimple {
+
+    @jsonProperty(Number)
+    public id: number = 0;
+
+    @jsonProperty(String)
+    public name: string = "";
+
+}
+
+export class UserSimple {
+
+    @jsonProperty(String)
+    public id?: string = "";
+
+    @jsonProperty(Number)
+    public index: number = 0;
+
+    @jsonProperty(String)
+    public guid: string = "";
+
+    @jsonProperty(Boolean)
+    public isActive: boolean = false;
+
+    @jsonProperty(String)
+    public balance: string = "";
+
+    @jsonProperty(String)
+    public picture: string = "";
+
+    @jsonProperty(Number)
+    public age: number = 0;
+
+    @jsonProperty(String)
+    public eyeColor: string = "";
+
+    @jsonProperty(String)
+    public name: string = "";
+
+    @jsonProperty(String)
+    public gender: string = "";
+
+    @jsonProperty(String)
+    public company: string = "";
+
+    @jsonProperty(String)
+    public email: string = "";
+
+    @jsonProperty(String)
+    public phone: string = "";
+
+    @jsonProperty(String)
+    public address: string = "";
+
+    @jsonProperty(String)
+    public about: string = "";
+
+    @jsonProperty(Date, null)
+    public registered: Date | null = null;
+
+    @jsonProperty(Number)
+    public latitude: number = 0;
+
+    @jsonProperty(Number)
+    public longitude: number = 0;
+
+    @jsonProperty([String])
+    public tags: string[] = [];
+
+    @jsonProperty([FriendSimple])
+    public friends: FriendSimple[] = [];
+
+    @jsonProperty(String)
+    public greeting: string = "";
+
+    @jsonProperty(String)
+    public favoriteFruit: string = "";
+
+    @jsonIgnore()
+    public isExpanded: boolean = false;
+
+    public getName (): string {
+        return [
+            this.email,
+            this.company,
+            this.address
+        ].join(" ");
+    }
+
+}