protoobject 0.0.1 → 1.0.0

package/README.md

@@ -1,6 +1,12 @@
 # ProtoObject
 
-TBD
+A universal class for creating any JSON objects and simple manipulations with them.
+
+Just inherit from this class and easily organize your work with data. This can be data storage in an SQL/NoSQL database, data storage in localStorage/sessionStorage, simple transfer of data serialization on one side and the same idle deserialization of data on the other side. You can write your own ProtoBuffer protocol on top of this library and use it for RPC or to write a universal data library for FrontEnd and BackEnd.
+
+Think of it as a data framework.
+
+Inspired by gRPC and Firebase.
 
 [![npm](https://img.shields.io/npm/v/protoobject.svg)](https://www.npmjs.com/package/protoobject)
 [![npm](https://img.shields.io/npm/dy/protoobject.svg)](https://www.npmjs.com/package/protoobject)
@@ -16,7 +22,247 @@ TBD
 
 ## DOCS
 
-TBD
+### The main methods of the ProtoObject class
+
+These methods ensure that the class and its heirs interact with the external system and will not contain backward incompatible changes.
+
+| --- type of the property --- | --- name of the property --- | --- description --- |
+| --- | --- | --- |
+| static | `fromJSON` | A method for converting a simple json to ProtoObject class or its heir |
+| dynamic | `toJSON` | A method for converting a ProtoObject class or its heir to simple json |
+| dynamic | `toString` | A method for converting a ProtoObject class or its heir to a string |
+| dynamic | `copy` | Copying a ProtoObject class or its heirs |
+| dynamic | `assign` | Deep assign data to an instance of the ProtoObject class or its heir |
+| static | `recordTransformer` | Factory for creating a data transformer for the ProtoObject class or its heir |
+| static | `collectionTransformer` | Factory for creating a data transformer for the array of ProtoObject classes or its heirs |
+
+### The auxiliary methods of the ProtoObject class
+
+These methods ensure the operation of the class itself and can change significantly over time.
+
+| --- type of the property --- | --- name of the property --- | --- description --- |
+| --- | --- | --- |
+| static | `getProperties` | Get all properties of an object and its prototypes |
+| static | `getEnumerableProperties` | Get all enumerable properties of an object and its prototypes |
+| static | `recursiveAssign` | A recursive function for assigning properties to an object or returning a property if it is not interchangeable |
+| static | `deepAssign` | Deep assign data to an instance of the ProtoObject class or its heir |
+| static | `valueToJSON` | The converter of values into simple types |
+| static | `valueFromJSON` | The converter of simple types into values |
+
+### JavaScript
+
+Creating an heir class
+
+#### JavaScript - Creating an heir class using inheritance
+
+Note that you cannot use static method validation using a decorator in JavaScript, TypeScript provides more features.
+
+Note the call to `this.assign(data);` in the constructor of your own class. This is due to the code build, which causes your class to first call `super(data);` and then apply the value of the properties specified in the class (if the value is not specified, `undefined` will be applied). This is the reason why `super(data);` will not make an assignment for the properties specified in your class.
+
+```js
+class UserAddress extends ProtoObject {
+  constructor(data) {
+    if (data) this.assign(data);
+    return this;
+  }
+
+  country;
+
+  postCode;
+}
+```
+
+#### JavaScript - Creating an heir class using a factory
+
+You can skip fields with standard types `String`, `Number`, `Boolean` and use a superclass converters (`UserRights?.prototype?.toJSON?.call(this)` and `ProtoObject.fromJSON(data)`) for these types, but you must implement the conversion of the remaining types manually.
+
+```js
+const UserRights = protoObjectFactory({
+  fromJSON(data) {
+    return new this({
+      ...ProtoObject.fromJSON(data),
+      updatedAt: new Date(data?.updatedAt),
+    });
+  },
+  toJSON() {
+    return {
+      ...UserRights?.prototype?.toJSON?.call(this),
+      updatedAt: this.updatedAt?.toJSON(),
+    };
+  },
+});
+```
+
+#### JavaScript - Creating an heir class using inheritance with conversion of additional data types
+
+Note that you cannot use static method validation using a decorator in JavaScript, TypeScript provides more features.
+
+Note the call to `this.assign(data);` in the constructor of your own class. This is due to the code build, which causes your class to first call `super(data);` and then apply the value of the properties specified in the class (if the value is not specified, `undefined` will be applied). This is the reason why `super(data);` will not make an assignment for the properties specified in your class.
+
+You can skip fields with standard types `String`, `Number`, `Boolean` and use a superclass converters (`super.toJSON()` and `super.fromJSON(data)`) for these types, but you must implement the conversion of the remaining types manually.
+
+```js
+class User extends ProtoObject {
+  constructor(data) {
+    super(data);
+    if (data) this.assign(data);
+    return this;
+  }
+
+  id;
+
+  email;
+
+  createdAt;
+
+  photo;
+
+  address;
+
+  toJSON() {
+    return {
+      ...super.toJSON(),
+      createdAt: this.createdAt.toJSON(),
+      photo:
+        this.photo instanceof Buffer ? this.photo.toString("hex") : undefined,
+      address:
+        this.address instanceof UserAddress ? this.address.toJSON() : undefined,
+      rights:
+        this.rights instanceof UserRights ? this.rights?.toJSON() : undefined,
+    };
+  }
+
+  static fromJSON(data) {
+    return new User({
+      ...super.fromJSON(data),
+      createdAt:
+        typeof data.createdAt === "string"
+          ? new Date(data.createdAt)
+          : undefined,
+      photo:
+        typeof data.photo === "string"
+          ? Buffer.from(data.photo, "hex")
+          : undefined,
+      address: data.address ? UserAddress.fromJSON(data.address) : undefined,
+      rights: data.rights ? UserRights.fromJSON(data.rights) : undefined,
+    });
+  }
+}
+```
+
+### TypeScript
+
+Creating an heir class
+
+#### TypeScript - Creating an heir class using inheritance
+
+Note that to check the static properties of a class, you can use the decorator `@StaticImplements<ProtoObjectStaticMethods<User>>()`.
+
+Note the call to `this.assign(data);` in the constructor of your own class. This is due to the code build, which causes your class to first call `super(data);` and then apply the value of the properties specified in the class (if the value is not specified, `undefined` will be applied). This is the reason why `super(data);` will not make an assignment for the properties specified in your class.
+
+```js
+@StaticImplements<ProtoObjectStaticMethods<UserAddress>>()
+export class UserAddress extends ProtoObject<UserAddress> {
+  constructor(data?: Partial<UserAddress>) {
+    super(data);
+    if (data) this.assign(data);
+    return this;
+  }
+
+  country!: string;
+
+  postCode!: string;
+}
+```
+
+#### TypeScript - Creating an heir class using a factory
+
+You can skip fields with standard types `String`, `Number`, `Boolean` and use a superclass converters (`UserRights?.prototype?.toJSON?.call(this)` and `ProtoObject.fromJSON(data)`) for these types, but you must implement the conversion of the remaining types manually.
+
+```js
+interface IUserRights extends ProtoObject<IUserRights> {
+  isAdmin: boolean;
+  updatedAt: Date;
+}
+const UserRights = protoObjectFactory<IUserRights>({
+  fromJSON(data) {
+    return new this({
+      ...ProtoObject.fromJSON(data),
+      updatedAt: new Date(data?.updatedAt),
+    });
+  },
+  toJSON() {
+    return {
+      ...UserRights?.prototype?.toJSON?.call(this),
+      updatedAt: this.updatedAt?.toJSON(),
+    };
+  },
+});
+```
+
+#### TypeScript - Creating an heir class using inheritance with conversion of additional data types
+
+Note that to check the static properties of a class, you can use the decorator `@StaticImplements<ProtoObjectStaticMethods<User>>()`.
+
+Note the call to `this.assign(data);` in the constructor of your own class. This is due to the code build, which causes your class to first call `super(data);` and then apply the value of the properties specified in the class (if the value is not specified, `undefined` will be applied). This is the reason why `super(data);` will not make an assignment for the properties specified in your class.
+
+You can skip fields with standard types `String`, `Number`, `Boolean` and use a superclass converters (`super.toJSON()` and `super.fromJSON(data)`) for these types, but you must implement the conversion of the remaining types manually.
+
+```js
+@StaticImplements<ProtoObjectStaticMethods<User>>()
+class User extends ProtoObject<User> {
+  constructor(data?: Partial<User>) {
+    super(data);
+    if (data) this.assign(data);
+    return this;
+  }
+
+  id!: string;
+
+  email!: string;
+
+  createdAt!: Date;
+
+  photo?: Buffer;
+
+  address?: UserAddress;
+
+  rights?: IUserRights;
+
+  public toJSON(): { [key: string]: any } {
+    return {
+      ...super.toJSON(),
+      createdAt: this.createdAt.toJSON(),
+      photo:
+        this.photo instanceof Buffer ? this.photo.toString("hex") : undefined,
+      address:
+        this.address instanceof UserAddress ? this.address.toJSON() : undefined,
+      rights:
+        this.rights instanceof UserRights ? this.rights?.toJSON() : undefined,
+    };
+  }
+
+  public static fromJSON<User>(data: { [key: string]: unknown }): User {
+    return new User({
+      ...(super.fromJSON<any>(data) as User),
+      createdAt:
+        typeof data.createdAt === "string"
+          ? new Date(data.createdAt)
+          : undefined,
+      photo:
+        typeof data.photo === "string"
+          ? Buffer.from(data.photo, "hex")
+          : undefined,
+      address: data.address
+        ? UserAddress.fromJSON<UserAddress>(
+            data.address as { [key: string]: unknown }
+          )
+        : undefined,
+      rights: data.rights ? UserRights.fromJSON(data.rights) : undefined,
+    }) as unknown as User;
+  }
+}
+```
 
 ## LICENSE
 

package/lib/classes/proto-object.d.ts

@@ -0,0 +1,143 @@
+import { UnknownObject } from "../types/unknown-object";
+import { ProtoObjectDynamicMethods } from "../types/dynamic-methods";
+import { ValidatorFunction } from "../types/validator-function";
+/**
+ * A universal class for creating any JSON objects and simple manipulations with them.
+ */
+export declare class ProtoObject<T extends ProtoObjectDynamicMethods<T>> implements ProtoObjectDynamicMethods<T> {
+    /**
+     *
+     * @param data - ProtoObject or its heir properties
+     * @returns - the ProtoObject or its heir
+     */
+    constructor(data?: Partial<T>);
+    /**
+     * Get all properties of an object and its prototypes
+     *
+     * @param data - any non-null object, such as an instance of the ProtoObject class or its heir
+     * @returns - an array of the properties information
+     */
+    static getProperties(data: {
+        [key: PropertyKey]: unknown;
+    }): {
+        key: PropertyKey;
+        value: unknown;
+        descriptor: PropertyDescriptor;
+    }[];
+    /**
+     * Get all enumerable properties of an object and its prototypes
+     *
+     * @param data - any non-null object, such as an instance of the ProtoObject class or its heir
+     * @param options - options for the returned array of properties
+     * @param options.onlyWritable - return only writable properties
+     * @returns - an array of the properties information
+     */
+    static getEnumerableProperties<T extends ProtoObjectDynamicMethods<T>>(data: {
+        [key: PropertyKey]: unknown;
+    }, options?: {
+        onlyWritable: boolean;
+    }): {
+        key: PropertyKey;
+        value: unknown;
+        descriptor: PropertyDescriptor;
+    }[];
+    /**
+     * A recursive function for assigning properties to an object or returning a property
+     * if it is not interchangeable
+     *
+     * WARN: The first transferred object will be changed.
+     *
+     * @param obj - an object such as a ProtoObject or its heir or an object property
+     * @param data - an object such as a ProtoObject or its heir or an object property
+     * @returns - an object such as a ProtoObject or its heir or an object property
+     */
+    static recursiveAssign<T extends ProtoObjectDynamicMethods<T>, K>(obj: unknown, data?: unknown): K;
+    /**
+     * Deep assign data to an instance of the ProtoObject class or its heir
+     *
+     * @param obj - a ProtoObject class or its heir
+     * @param data - a ProtoObject class or its heir or any other object
+     * @returns - a assigned ProtoObject class or its heir
+     */
+    static deepAssign<T extends ProtoObjectDynamicMethods<T>>(obj: T, data?: Partial<T>): T;
+    /**
+     * The converter of values into simple types
+     *
+     * @param data - a value to convert to a simple type
+     * @returns - a simple type
+     */
+    static valueToJSON(data: unknown): unknown;
+    /**
+     * The converter of simple types into values
+     *
+     * @param data - a simple type to convert to a value
+     * @returns - a value
+     */
+    static valueFromJSON(data: unknown): unknown;
+    /**
+     * A method for converting a simple json to ProtoObject class or its heir
+     *
+     * @param data - a simple json data
+     * @returns - a ProtoObject class or its heir
+     */
+    static fromJSON<T extends ProtoObjectDynamicMethods<T>>(data: {
+        [key: string]: unknown;
+    }): T;
+    /**
+     * A method for converting a ProtoObject class or its heir to simple json
+     *
+     * @returns - a simple json
+     */
+    toJSON(): {
+        [key: string]: any;
+    };
+    /**
+     * A method for converting a ProtoObject class or its heir to a string
+     *
+     * @returns - string
+     */
+    toString(): string;
+    /**
+     * Copying a ProtoObject class or its heirs
+     *
+     * @returns - a deep copy of the ProtoObject object or its heir
+     */
+    copy(): T;
+    /**
+     * Deep assign data to an instance of the ProtoObject class or its heir
+     *
+     * @param data - a ProtoObject class or its heir or any other object
+     * @returns - a assigned ProtoObject class or its heir
+     */
+    assign(data: Partial<T>): T;
+    /**
+     * Factory for creating a data transformer for the ProtoObject class or its heir
+     *
+     * @param param0 - data validators
+     * @param param0.validatorTo - data validator when converting to a simple JSON object
+     * @param param0.validatorFrom - data validator when converting to a class
+     * @returns data transformer for the ProtoObject class or its heir
+     */
+    static recordTransformer<T extends ProtoObjectDynamicMethods<T>>({ validatorTo, validatorFrom, }: {
+        validatorTo?: ValidatorFunction<T>;
+        validatorFrom?: ValidatorFunction<UnknownObject>;
+    }): {
+        to(obj: unknown): UnknownObject | undefined;
+        from(json: unknown): T | undefined;
+    };
+    /**
+     * Factory for creating a data transformer for the array of ProtoObject classes or its heirs
+     *
+     * @param param0 - data validators
+     * @param param0.validatorTo - data validator when converting to a simple JSON object
+     * @param param0.validatorFrom - data validator when converting to a class
+     * @returns data transformer for the array of the ProtoObject classes or its heirs
+     */
+    static collectionTransformer<T extends ProtoObjectDynamicMethods<T>>({ validatorTo, validatorFrom, }: {
+        validatorTo?: ValidatorFunction<T>;
+        validatorFrom?: ValidatorFunction<UnknownObject>;
+    }): {
+        to(objArr: unknown): UnknownObject[] | undefined;
+        from(jsonArr: unknown): T[] | undefined;
+    };
+}

package/lib/classes/proto-object.js

@@ -0,0 +1,268 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProtoObject = void 0;
+/**
+ * A universal class for creating any JSON objects and simple manipulations with them.
+ */
+class ProtoObject {
+    /**
+     *
+     * @param data - ProtoObject or its heir properties
+     * @returns - the ProtoObject or its heir
+     */
+    constructor(data) {
+        return ProtoObject.deepAssign(this, data ?? {});
+    }
+    /**
+     * Get all properties of an object and its prototypes
+     *
+     * @param data - any non-null object, such as an instance of the ProtoObject class or its heir
+     * @returns - an array of the properties information
+     */
+    static getProperties(data) {
+        const props = [];
+        // eslint-disable-next-line guard-for-in
+        for (const key in data) {
+            const prop = Object.getOwnPropertyDescriptor(data, key);
+            if (prop)
+                props.push({ key, value: prop?.value, descriptor: prop });
+        }
+        return props;
+    }
+    /**
+     * Get all enumerable properties of an object and its prototypes
+     *
+     * @param data - any non-null object, such as an instance of the ProtoObject class or its heir
+     * @param options - options for the returned array of properties
+     * @param options.onlyWritable - return only writable properties
+     * @returns - an array of the properties information
+     */
+    static getEnumerableProperties(data, options = { onlyWritable: false }) {
+        const classNode = this;
+        return classNode
+            .getProperties(data)
+            .filter((prop) => !prop.descriptor.get &&
+            !prop.descriptor.set &&
+            prop.descriptor.enumerable)
+            .filter((prop) => options?.onlyWritable ? prop.descriptor.writable : true);
+    }
+    /**
+     * A recursive function for assigning properties to an object or returning a property
+     * if it is not interchangeable
+     *
+     * WARN: The first transferred object will be changed.
+     *
+     * @param obj - an object such as a ProtoObject or its heir or an object property
+     * @param data - an object such as a ProtoObject or its heir or an object property
+     * @returns - an object such as a ProtoObject or its heir or an object property
+     */
+    static recursiveAssign(obj, data) {
+        const classNode = this;
+        if (typeof obj === "undefined" ||
+            obj === null ||
+            (typeof data !== "undefined" && typeof obj !== typeof data))
+            return data;
+        if (data === null)
+            return data;
+        switch (typeof data) {
+            case "undefined":
+                return obj;
+            case "bigint":
+            case "boolean":
+            case "function":
+            case "number":
+            case "string":
+            case "symbol":
+                return data;
+            case "object": {
+                if (Array.isArray(data)) {
+                    return data;
+                }
+                if (data instanceof ProtoObject &&
+                    data?.constructor?.name !== obj?.constructor?.name) {
+                    return data.copy();
+                }
+                if (!(data instanceof ProtoObject) &&
+                    typeof data.constructor === "function" &&
+                    data.constructor?.name !== "Object") {
+                    return data;
+                }
+                for (const prop of classNode.getEnumerableProperties(data)) {
+                    if (typeof prop.key !== "string")
+                        continue;
+                    const origProp = Object.getOwnPropertyDescriptor(obj, prop.key);
+                    if (!origProp ||
+                        (!origProp.get &&
+                            !origProp.set &&
+                            origProp.enumerable &&
+                            origProp.writable)) {
+                        obj[prop.key] = classNode.recursiveAssign(obj[prop.key], data[prop.key]);
+                    }
+                    else {
+                        continue;
+                    }
+                }
+                return obj;
+            }
+        }
+        return obj;
+    }
+    /**
+     * Deep assign data to an instance of the ProtoObject class or its heir
+     *
+     * @param obj - a ProtoObject class or its heir
+     * @param data - a ProtoObject class or its heir or any other object
+     * @returns - a assigned ProtoObject class or its heir
+     */
+    static deepAssign(obj, data) {
+        const classNode = this;
+        return classNode.recursiveAssign(obj, data ?? {});
+    }
+    /**
+     * The converter of values into simple types
+     *
+     * @param data - a value to convert to a simple type
+     * @returns - a simple type
+     */
+    static valueToJSON(data) {
+        switch (typeof data) {
+            case "boolean":
+            case "number":
+            case "string":
+                return data;
+            default:
+                return undefined;
+        }
+    }
+    /**
+     * The converter of simple types into values
+     *
+     * @param data - a simple type to convert to a value
+     * @returns - a value
+     */
+    static valueFromJSON(data) {
+        switch (typeof data) {
+            case "boolean":
+            case "number":
+            case "string":
+                return data;
+            default:
+                return undefined;
+        }
+    }
+    /**
+     * A method for converting a simple json to ProtoObject class or its heir
+     *
+     * @param data - a simple json data
+     * @returns - a ProtoObject class or its heir
+     */
+    static fromJSON(data) {
+        const classNode = this;
+        const json = {};
+        // eslint-disable-next-line guard-for-in
+        for (const key in data) {
+            const value = classNode.valueFromJSON(data[key]);
+            if (value)
+                json[key] = value;
+        }
+        return new classNode(json);
+    }
+    /**
+     * A method for converting a ProtoObject class or its heir to simple json
+     *
+     * @returns - a simple json
+     */
+    toJSON() {
+        const classNode = this
+            .constructor;
+        const json = {};
+        const props = ProtoObject.getEnumerableProperties(this);
+        for (const prop of props) {
+            const value = classNode.valueToJSON(prop.value);
+            if (value)
+                json[prop.key] = value;
+        }
+        return json;
+    }
+    /**
+     * A method for converting a ProtoObject class or its heir to a string
+     *
+     * @returns - string
+     */
+    toString() {
+        return JSON.stringify(this.toJSON());
+    }
+    /**
+     * Copying a ProtoObject class or its heirs
+     *
+     * @returns - a deep copy of the ProtoObject object or its heir
+     */
+    copy() {
+        const classNode = this.constructor;
+        return classNode.fromJSON(this.toJSON());
+    }
+    /**
+     * Deep assign data to an instance of the ProtoObject class or its heir
+     *
+     * @param data - a ProtoObject class or its heir or any other object
+     * @returns - a assigned ProtoObject class or its heir
+     */
+    assign(data) {
+        const classNode = this.constructor;
+        return classNode.deepAssign(this, data);
+    }
+    /**
+     * Factory for creating a data transformer for the ProtoObject class or its heir
+     *
+     * @param param0 - data validators
+     * @param param0.validatorTo - data validator when converting to a simple JSON object
+     * @param param0.validatorFrom - data validator when converting to a class
+     * @returns data transformer for the ProtoObject class or its heir
+     */
+    static recordTransformer({ validatorTo, validatorFrom, }) {
+        const classNode = this;
+        return {
+            to(obj) {
+                if (!obj || (typeof validatorTo === "function" && !validatorTo(obj)))
+                    return undefined;
+                return obj.toJSON();
+            },
+            from(json) {
+                if (!json ||
+                    (typeof validatorFrom === "function" && !validatorFrom(json)))
+                    return undefined;
+                return classNode.fromJSON(json);
+            },
+        };
+    }
+    /**
+     * Factory for creating a data transformer for the array of ProtoObject classes or its heirs
+     *
+     * @param param0 - data validators
+     * @param param0.validatorTo - data validator when converting to a simple JSON object
+     * @param param0.validatorFrom - data validator when converting to a class
+     * @returns data transformer for the array of the ProtoObject classes or its heirs
+     */
+    static collectionTransformer({ validatorTo, validatorFrom, }) {
+        const classNode = this;
+        return {
+            to(objArr) {
+                if (!Array.isArray(objArr))
+                    return undefined;
+                return objArr
+                    .filter((obj) => !!obj && (typeof validatorTo !== "function" || !!validatorTo(obj)))
+                    .map((obj) => obj.toJSON());
+            },
+            from(jsonArr) {
+                if (!Array.isArray(jsonArr))
+                    return undefined;
+                return jsonArr
+                    .filter((json) => !!json &&
+                    (typeof validatorFrom !== "function" || !!validatorFrom(json)))
+                    .map((json) => classNode.fromJSON(json));
+            },
+        };
+    }
+}
+exports.ProtoObject = ProtoObject;
+//# sourceMappingURL=proto-object.js.map

package/lib/classes/proto-object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proto-object.js","sourceRoot":"","sources":["../../src/classes/proto-object.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACH,MAAa,WAAW;IAGtB;;;;OAIG;IACH,YAAY,IAAiB;QAC3B,OAAO,WAAW,CAAC,UAAU,CAAI,IAAoB,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,IAE3B;QACC,MAAM,KAAK,GAIL,EAAE,CAAC;QACT,wCAAwC;QACxC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACxD,IAAI,IAAI;gBAAE,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CACnC,IAEC,EACD,UAAqC,EAAE,YAAY,EAAE,KAAK,EAAE;QAE5D,MAAM,SAAS,GAAG,IAA8C,CAAC;QACjE,OAAO,SAAS;aACb,aAAa,CAAC,IAAI,CAAC;aACnB,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG;YACpB,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG;YACpB,IAAI,CAAC,UAAU,CAAC,UAAU,CAC7B;aACA,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACf,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CACxD,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,eAAe,CAC3B,GAAY,EACZ,IAAc;QAEd,MAAM,SAAS,GAAG,IAA8C,CAAC;QACjE,IACE,OAAO,GAAG,KAAK,WAAW;YAC1B,GAAG,KAAK,IAAI;YACZ,CAAC,OAAO,IAAI,KAAK,WAAW,IAAI,OAAO,GAAG,KAAK,OAAO,IAAI,CAAC;YAE3D,OAAO,IAAS,CAAC;QACnB,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,IAAS,CAAC;QACpC,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,WAAW;gBACd,OAAO,GAAQ,CAAC;YAClB,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,UAAU,CAAC;YAChB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO,IAAS,CAAC;YACnB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxB,OAAO,IAAS,CAAC;gBACnB,CAAC;gBACD,IACE,IAAI,YAAY,WAAW;oBAC3B,IAAI,EAAE,WAAW,EAAE,IAAI,KAAK,GAAG,EAAE,WAAW,EAAE,IAAI,EAClD,CAAC;oBACD,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;gBACrB,CAAC;gBACD,IACE,CAAC,CAAC,IAAI,YAAY,WAAW,CAAC;oBAC9B,OAAO,IAAI,CAAC,WAAW,KAAK,UAAU;oBACtC,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,QAAQ,EACnC,CAAC;oBACD,OAAO,IAAS,CAAC;gBACnB,CAAC;gBACD,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,uBAAuB,CAClD,IAAkC,CACnC,EAAE,CAAC;oBACF,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ;wBAAE,SAAS;oBAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;oBAChE,IACE,CAAC,QAAQ;wBACT,CAAC,CAAC,QAAQ,CAAC,GAAG;4BACZ,CAAC,QAAQ,CAAC,GAAG;4BACb,QAAQ,CAAC,UAAU;4BACnB,QAAQ,CAAC,QAAQ,CAAC,EACpB,CAAC;wBACA,GAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,eAAe,CACzD,GAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,EAC/B,IAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAClC,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,SAAS;oBACX,CAAC;gBACH,CAAC;gBACD,OAAO,GAAQ,CAAC;YAClB,CAAC;QACH,CAAC;QACD,OAAO,GAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CACtB,GAAM,EACN,IAAiB;QAEjB,MAAM,SAAS,GAAG,IAA8C,CAAC;QACjE,OAAO,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,IAAI,EAAE,CAAM,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAa;QACrC,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO,IAAI,CAAC;YACd;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,IAAa;QACvC,QAAQ,OAAO,IAAI,EAAE,CAAC;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO,IAAI,CAAC;YACd;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAyC,IAE9D;QACC,MAAM,SAAS,GAAG,IAA8C,CAAC;QACjE,MAAM,IAAI,GAA+B,EAAE,CAAC;QAC5C,wCAAwC;QACxC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACjD,IAAI,KAAK;gBAAE,IAAI,CAAC,GAAa,CAAC,GAAG,KAAK,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,SAAS,CAAC,IAAkB,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,MAAM,SAAS,GAAG,IAAI;aACnB,WAAqD,CAAC;QACzD,MAAM,IAAI,GAA+B,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,WAAW,CAAC,uBAAuB,CAC/C,IAA6C,CAC9C,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChD,IAAI,KAAK;gBAAE,IAAI,CAAC,IAAI,CAAC,GAAa,CAAC,GAAG,KAAK,CAAC;QAC9C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,MAAM,SAAS,GAAG,IAAI,CAAC,WAA0C,CAAC;QAClE,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAgB;QAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,WAA0C,CAAC;QAClE,OAAO,SAAS,CAAC,UAAU,CAAI,IAAoB,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,iBAAiB,CAAyC,EACtE,WAAW,EACX,aAAa,GAId;QACC,MAAM,SAAS,GAAG,IAA8C,CAAC;QACjE,OAAO;YACL,EAAE,CAAC,GAAY;gBACb,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,WAAW,KAAK,UAAU,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;oBAClE,OAAO,SAAS,CAAC;gBACnB,OAAQ,GAAS,CAAC,MAAM,EAAmB,CAAC;YAC9C,CAAC;YACD,IAAI,CAAC,IAAa;gBAChB,IACE,CAAC,IAAI;oBACL,CAAC,OAAO,aAAa,KAAK,UAAU,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;oBAE7D,OAAO,SAAS,CAAC;gBACnB,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAM,CAAC;YACvC,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAyC,EAC1E,WAAW,EACX,aAAa,GAId;QACC,MAAM,SAAS,GAAG,IAA8C,CAAC;QACjE,OAAO;YACL,EAAE,CAAC,MAAe;gBAChB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;oBAAE,OAAO,SAAS,CAAC;gBAC7C,OAAO,MAAM;qBACV,MAAM,CACL,CAAC,GAAG,EAAE,EAAE,CACN,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,WAAW,KAAK,UAAU,IAAI,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CACrE;qBACA,GAAG,CAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YAC/C,CAAC;YACD,IAAI,CAAC,OAAgB;gBACnB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;oBAAE,OAAO,SAAS,CAAC;gBAC9C,OAAO,OAAO;qBACX,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,CAAC,IAAI;oBACN,CAAC,OAAO,aAAa,KAAK,UAAU,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CACjE;qBACA,GAAG,CAAI,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YAChD,CAAC;SACF,CAAC;IACJ,CAAC;CACF;AArUD,kCAqUC"}

package/lib/decorators/static-implements.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Use this decorator to check the static properties of a class
+ *
+ * Example: `@StaticImplements<ProtoObjectStaticMethods<User>>()`
+ */
+export declare const StaticImplements: <T>() => <U extends T>(constructor: U) => void;

package/lib/decorators/static-implements.js

@@ -0,0 +1,16 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unused-expressions */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticImplements = void 0;
+/**
+ * Use this decorator to check the static properties of a class
+ *
+ * Example: `@StaticImplements<ProtoObjectStaticMethods<User>>()`
+ */
+const StaticImplements = () => {
+    return (constructor) => {
+        constructor;
+    };
+};
+exports.StaticImplements = StaticImplements;
+//# sourceMappingURL=static-implements.js.map

package/lib/decorators/static-implements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"static-implements.js","sourceRoot":"","sources":["../../src/decorators/static-implements.ts"],"names":[],"mappings":";AAAA,6DAA6D;;;AAE7D;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,GAAM,EAAE;IACtC,OAAO,CAAc,WAAc,EAAE,EAAE;QACrC,WAAW,CAAC;IACd,CAAC,CAAC;AACJ,CAAC,CAAC;AAJW,QAAA,gBAAgB,oBAI3B"}

package/lib/index.d.ts

@@ -1,11 +1,14 @@
 /**
- * TBD
+ * A universal class for creating any JSON objects and simple manipulations with them.
  * @module protoobject
  * @author Siarhei Dudko <siarhei@dudko.dev>
- * @copyright 2020
+ * @copyright 2024
  * @license MIT
- * @version 2.0.0
- * @requires stream
+ * @version 1.0.0
  */
-declare const _default: {};
-export = _default;
+import { ProtoObject } from "./classes/proto-object";
+import { ProtoObjectDynamicMethods } from "./types/dynamic-methods";
+import { ProtoObjectStaticMethods } from "./types/static-methods";
+import { StaticImplements } from "./decorators/static-implements";
+import { protoObjectFactory } from "./utils/protoobject-factory";
+export { ProtoObject, StaticImplements, ProtoObjectDynamicMethods, ProtoObjectStaticMethods, protoObjectFactory, };

package/lib/index.js

@@ -1,12 +1,18 @@
 "use strict";
 /**
- * TBD
+ * A universal class for creating any JSON objects and simple manipulations with them.
  * @module protoobject
  * @author Siarhei Dudko <siarhei@dudko.dev>
- * @copyright 2020
+ * @copyright 2024
  * @license MIT
- * @version 2.0.0
- * @requires stream
+ * @version 1.0.0
  */
-module.exports = (module.exports = {});
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.protoObjectFactory = exports.StaticImplements = exports.ProtoObject = void 0;
+const proto_object_1 = require("./classes/proto-object");
+Object.defineProperty(exports, "ProtoObject", { enumerable: true, get: function () { return proto_object_1.ProtoObject; } });
+const static_implements_1 = require("./decorators/static-implements");
+Object.defineProperty(exports, "StaticImplements", { enumerable: true, get: function () { return static_implements_1.StaticImplements; } });
+const protoobject_factory_1 = require("./utils/protoobject-factory");
+Object.defineProperty(exports, "protoObjectFactory", { enumerable: true, get: function () { return protoobject_factory_1.protoObjectFactory; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;AAEH,iBAAS,CAAC,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAEH,yDAAqD;AAOnD,4FAPO,0BAAW,OAOP;AAJb,sEAAkE;AAKhE,iGALO,oCAAgB,OAKP;AAJlB,qEAAiE;AAO/D,mGAPO,wCAAkB,OAOP"}

package/lib/types/any-object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * An universal object
+ */
+export interface AnyObject {
+    [key: string]: any;
+}

package/lib/types/any-object.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=any-object.js.map

package/lib/types/any-object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"any-object.js","sourceRoot":"","sources":["../../src/types/any-object.ts"],"names":[],"mappings":""}

package/lib/types/collection-transformer.d.ts

@@ -0,0 +1,21 @@
+import { ProtoObjectDynamicMethods } from "./dynamic-methods";
+/**
+ * A data transformer for the array of ProtoObject classes or its heirs
+ *
+ */
+export interface CollectionTransformer<T extends ProtoObjectDynamicMethods<T>, K> {
+    /**
+     * Converter of an array of ProtoObject classes or its heirs to simple jsons
+     *
+     * @param objectArr - the array of ProtoObject classes or its heirs
+     * @returns - the array of the simple jsons
+     */
+    to: (objectArr: unknown) => K[] | undefined;
+    /**
+     * Converter of an array of simple jsons to ProtoObject classes or its heirs
+     *
+     * @param jsonArr - the array of the simple jsons
+     * @returns - the array of ProtoObject classes or its heirs
+     */
+    from: (jsonArr: unknown) => T[] | undefined;
+}

package/lib/types/collection-transformer.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable no-unused-vars */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=collection-transformer.js.map

package/lib/types/collection-transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-transformer.js","sourceRoot":"","sources":["../../src/types/collection-transformer.ts"],"names":[],"mappings":";AAAA,mCAAmC"}

package/lib/types/dynamic-methods.d.ts

@@ -0,0 +1,31 @@
+import { AnyObject } from "./any-object";
+/**
+ * Dynamic methods of the ProtoObject class and its heirs
+ */
+export interface ProtoObjectDynamicMethods<T> {
+    /**
+     * A method for converting a ProtoObject class or its heir to simple json
+     *
+     * @returns - a simple json
+     */
+    toJSON: () => AnyObject;
+    /**
+     * A method for converting a ProtoObject class or its heir to a string
+     *
+     * @returns - string
+     */
+    toString(): string;
+    /**
+     * Copying a ProtoObject class or its heirs
+     *
+     * @returns - a deep copy of the ProtoObject object or its heir
+     */
+    copy: () => T;
+    /**
+     * Deep assign data to an instance of the ProtoObject class or its heir
+     *
+     * @param data - a ProtoObject class or its heir or any other object
+     * @returns - a assigned ProtoObject class or its heir
+     */
+    assign: (data: Partial<T>) => T;
+}

package/lib/types/dynamic-methods.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable no-unused-vars */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dynamic-methods.js.map

package/lib/types/dynamic-methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dynamic-methods.js","sourceRoot":"","sources":["../../src/types/dynamic-methods.ts"],"names":[],"mappings":";AAAA,mCAAmC"}

package/lib/types/record-transformer.d.ts

@@ -0,0 +1,21 @@
+import { ProtoObjectDynamicMethods } from "./dynamic-methods";
+/**
+ * A data transformer for the ProtoObject class or its heir
+ *
+ */
+export interface RecordTransformer<T extends ProtoObjectDynamicMethods<T>, K> {
+    /**
+     * Converter of a ProtoObject class or its heir to simple json
+     *
+     * @param objectArr - the ProtoObject class or its heir
+     * @returns - the simple json
+     */
+    to: (obj: unknown) => K | undefined;
+    /**
+     * Converter of a simple json to ProtoObject class or its heir
+     *
+     * @param jsonArr - the simple json
+     * @returns - the ProtoObject class or its heir
+     */
+    from: (json: unknown) => T | undefined;
+}

package/lib/types/record-transformer.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable no-unused-vars */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=record-transformer.js.map

package/lib/types/record-transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-transformer.js","sourceRoot":"","sources":["../../src/types/record-transformer.ts"],"names":[],"mappings":";AAAA,mCAAmC"}

package/lib/types/static-methods.d.ts

@@ -0,0 +1,109 @@
+import { AnyObject } from "./any-object";
+import { UnknownObject } from "./unknown-object";
+import { RecordTransformer } from "./record-transformer";
+import { ProtoObjectDynamicMethods } from "./dynamic-methods";
+import { CollectionTransformer } from "./collection-transformer";
+import { ValidatorFunction } from "./validator-function";
+/**
+ * Static methods of the ProtoObject class and its heirs
+ */
+export interface ProtoObjectStaticMethods<T extends ProtoObjectDynamicMethods<T>> {
+    /**
+     * A class constructor
+     */
+    new (data?: Partial<T>): T;
+    /**
+     * Get all properties of an object and its prototypes
+     *
+     * @param data - any non-null object, such as an instance of the ProtoObject class or its heir
+     * @returns - an array of the properties information
+     */
+    getProperties(data: {
+        [key: PropertyKey]: unknown;
+    }): {
+        key: PropertyKey;
+        value: unknown;
+        descriptor: PropertyDescriptor;
+    }[];
+    /**
+     * Get all enumerable properties of an object and its prototypes
+     *
+     * @param data - any non-null object, such as an instance of the ProtoObject class or its heir
+     * @param options - options for the returned array of properties
+     * @param options.onlyWritable - return only writable properties
+     * @returns - an array of the properties information
+     */
+    getEnumerableProperties<T extends ProtoObjectDynamicMethods<T>>(data: {
+        [key: PropertyKey]: unknown;
+    }, options?: {
+        onlyWritable: boolean;
+    }): {
+        key: PropertyKey;
+        value: unknown;
+        descriptor: PropertyDescriptor;
+    }[];
+    /**
+     * A recursive function for assigning properties to an object or returning a property
+     * if it is not interchangeable
+     *
+     * WARN: The first transferred object will be changed.
+     *
+     * @param obj - an object such as a ProtoObject or its heir or an object property
+     * @param data - an object such as a ProtoObject or its heir or an object property
+     * @returns - an object such as a ProtoObject or its heir or an object property
+     */
+    recursiveAssign<T extends ProtoObjectDynamicMethods<T>>(obj: unknown, data?: unknown): T;
+    /**
+     * Deep assign data to an instance of the ProtoObject class or its heir
+     *
+     * @param obj - a ProtoObject class or its heir
+     * @param data - a ProtoObject class or its heir or any other object
+     * @returns - a assigned ProtoObject class or its heir
+     */
+    deepAssign<T extends ProtoObjectDynamicMethods<T>>(obj: T, data?: Partial<T>): T;
+    /**
+     * The converter of values into simple types
+     *
+     * @param data - a value to convert to a simple type
+     * @returns - a simple type
+     */
+    valueToJSON(data: unknown): unknown;
+    /**
+     * The converter of simple types into values
+     *
+     * @param data - a simple type to convert to a value
+     * @returns - a value
+     */
+    valueFromJSON(data: unknown): unknown;
+    /**
+     * A method for converting a simple json to ProtoObject class or its heir
+     *
+     * @param data - a simple json data
+     * @returns - a ProtoObject class or its heir
+     */
+    fromJSON: (data: AnyObject) => T;
+    /**
+     * Factory for creating a data transformer for the ProtoObject class or its heir
+     *
+     * @param param0 - data validators
+     * @param param0.validatorTo - data validator when converting to a simple JSON object
+     * @param param0.validatorFrom - data validator when converting to a class
+     * @returns data transformer for the ProtoObject class or its heir
+     */
+    recordTransformer: (options: {
+        validatorTo?: ValidatorFunction<T>;
+        validatorFrom?: ValidatorFunction<UnknownObject>;
+    }) => RecordTransformer<T, UnknownObject>;
+    /**
+     * Factory for creating a data transformer for the array of ProtoObject classes or its heirs
+     *
+     * @param param0 - data validators
+     * @param param0.validatorTo - data validator when converting to a simple JSON object
+     * @param param0.validatorFrom - data validator when converting to a class
+     * @returns data transformer for the array of the ProtoObject classes or its heirs
+     */
+    collectionTransformer: (options: {
+        validatorTo?: ValidatorFunction<T>;
+        validatorFrom?: ValidatorFunction<UnknownObject>;
+    }) => CollectionTransformer<T, UnknownObject>;
+}

package/lib/types/static-methods.js

@@ -0,0 +1,5 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-shadow */
+/* eslint-disable no-unused-vars */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=static-methods.js.map

package/lib/types/static-methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"static-methods.js","sourceRoot":"","sources":["../../src/types/static-methods.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,mCAAmC"}

package/lib/types/unknown-object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * An universal object
+ */
+export interface UnknownObject {
+    [key: string]: unknown;
+}

package/lib/types/unknown-object.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=unknown-object.js.map

package/lib/types/unknown-object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unknown-object.js","sourceRoot":"","sources":["../../src/types/unknown-object.ts"],"names":[],"mappings":""}

package/lib/types/validator-function.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The function of validating the fields of an object when it is transformed from/to a database
+ */
+export type ValidatorFunction<T> = (data: unknown) => T | undefined;

package/lib/types/validator-function.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable no-unused-vars */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=validator-function.js.map

package/lib/types/validator-function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator-function.js","sourceRoot":"","sources":["../../src/types/validator-function.ts"],"names":[],"mappings":";AAAA,mCAAmC"}

package/lib/utils/protoobject-factory.d.ts

@@ -0,0 +1,9 @@
+import { ProtoObjectDynamicMethods } from "../types/dynamic-methods";
+import { ProtoObjectStaticMethods } from "../types/static-methods";
+/**
+ * A factory for creating classes based on the ProtoObject class
+ *
+ * @param methods - Methods that should be updated in the class being created.
+ * @returns - an ProtoObject's heir
+ */
+export declare function protoObjectFactory<T extends ProtoObjectDynamicMethods<T>>(methods?: Partial<ProtoObjectStaticMethods<T> & ProtoObjectDynamicMethods<T>>): ProtoObjectStaticMethods<T>;

package/lib/utils/protoobject-factory.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.protoObjectFactory = protoObjectFactory;
+const proto_object_1 = require("../classes/proto-object");
+/**
+ * A factory for creating classes based on the ProtoObject class
+ *
+ * @param methods - Methods that should be updated in the class being created.
+ * @returns - an ProtoObject's heir
+ */
+function protoObjectFactory(methods) {
+    class CProtoObject extends proto_object_1.ProtoObject {
+        constructor(data) {
+            super(data);
+            if (methods) {
+                Object.keys(methods)
+                    .filter((key) => typeof this[key] === "function")
+                    .map((key) => key)
+                    .forEach((key) => {
+                    this[key] = methods[key];
+                });
+            }
+        }
+    }
+    if (methods) {
+        Object.keys(methods)
+            .filter((key) => typeof CProtoObject[key] === "function")
+            .map((key) => key)
+            .forEach((key) => {
+            CProtoObject[key] = methods[key];
+        });
+    }
+    return CProtoObject;
+}
+//# sourceMappingURL=protoobject-factory.js.map

package/lib/utils/protoobject-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protoobject-factory.js","sourceRoot":"","sources":["../../src/utils/protoobject-factory.ts"],"names":[],"mappings":";;AAUA,gDAuCC;AAhDD,0DAAsD;AAGtD;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,OAA6E;IAE7E,MAAM,YAAa,SAAQ,0BAAyB;QAClD,YAAY,IAA2B;YACrC,KAAK,CAAC,IAAI,CAAC,CAAC;YACZ,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;qBACjB,MAAM,CACL,CAAC,GAAG,EAAE,EAAE,CACN,OAAO,IAAI,CACT,GAAoD,CACrD,KAAK,UAAU,CACnB;qBACA,GAAG,CACF,CAAC,GAAG,EAAE,EAAE,CAAC,GAAoD,CAC9D;qBACA,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBACf,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAQ,CAAC;gBAClC,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;KACF;IACD,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;aACjB,MAAM,CACL,CAAC,GAAG,EAAE,EAAE,CACN,OAAO,YAAY,CACjB,GAAmD,CACpD,KAAK,UAAU,CACnB;aACA,GAAG,CACF,CAAC,GAAG,EAAE,EAAE,CAAC,GAAmD,CAC7D;aACA,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACf,YAAY,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAQ,CAAC;QAC1C,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,YAAsD,CAAC;AAChE,CAAC"}

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "protoobject",
-  "version": "0.0.1",
-  "description": "TBD",
+  "version": "1.0.0",
+  "description": "A universal class for creating any JSON objects and simple manipulations with them.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
-    "test": "node --test test/**/*.test.js",
-    "cov": "node_modules/.bin/nyc npm run test",
-    "lint": "node_modules/.bin/eslint src/**/*.ts",
+    "test:ts": "node --import=tsx --test test/ts/*.test.ts",
+    "test:js": "node --test test/js/*.test.js",
+    "cov": "./node_modules/.bin/nyc npm run test:ts",
+    "lint": "./node_modules/.bin/eslint src/**/*.ts",
     "prebuild": "npm run lint",
-    "build": "rm -rf lib && node_modules/.bin/tsc --declaration",
+    "build": "rm -rf lib && ./node_modules/.bin/tsc --declaration",
     "update": "eval \"$(node -e 'const t = require(`./package.json`);const ignore = require(`./ignoreUpdatesModules.json`);console.log(`npm i ${(Object.keys(t.dependencies || {}).filter((e)=>ignore.base.indexOf(e) === -1).map((e)=>(`${e}@latest`)).join(` `))} --save&&npm i ${(Object.keys(t.devDependencies || {}).filter((e)=>ignore.dev.indexOf(e) === -1).map((e)=>(`${e}@latest`)).join(` `))} --save-dev`);')\""
   },
   "author": {
@@ -37,7 +38,16 @@
     "url": "github:dudko-dev/protoobject"
   },
   "keywords": [
-    "protoobject"
+    "protoobject",
+    "json",
+    "jsonstream",
+    "object",
+    "class",
+    "converter",
+    "transformer",
+    "base-class",
+    "class-converter",
+    "class-transformer"
   ],
   "homepage": "https://github.com/dudko-dev/protoobject",
   "devDependencies": {
@@ -46,6 +56,7 @@
     "eslint": "^9.12.0",
     "nyc": "^17.1.0",
     "prettier": "^3.3.3",
+    "tsx": "^4.19.1",
     "typescript": "^5.6.3",
     "typescript-eslint": "^8.8.1"
   },