@itrocks/data-to-object 0.0.1

package/LICENSE

@@ -0,0 +1,14 @@
+ISC License
+Copyright (C) 2024, Baptiste Pillot <baptiste@pillot.fr>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+[![npm version](https://img.shields.io/npm/v/@itrocks/data-to-object?logo=npm)](https://www.npmjs.org/package/@itrocks/data-to-object)
+[![npm downloads](https://img.shields.io/npm/dm/@itrocks/data-to-object)](https://www.npmjs.org/package/@itrocks/data-to-object)
+[![GitHub](https://img.shields.io/github/last-commit/itrocks-ts/data-to-object?color=2dba4e&label=commit&logo=github)](https://github.com/itrocks-ts/data-to-object)
+[![issues](https://img.shields.io/github/issues/itrocks-ts/data-to-object)](https://github.com/itrocks-ts/data-to-object/issues)
+[![discord](https://img.shields.io/discord/1314141024020467782?color=7289da&label=discord&logo=discord&logoColor=white)](https://25.re/ditr)
+
+# data-to-object
+
+Transforms raw string-based data into a business object with type-safe values.
+
+## Installation
+
+```bash
+npm i @itrocks/data-to-object
+```
+
+## Usage
+
+```ts
+import { dataToObject } from '@itrocks/data-to-object'
+
+class User {
+  name!: string
+  age!: number
+}
+
+const rawData = {
+  name: 'John Doe',
+  age: '30'
+}
+
+const user = new User()
+
+await dataToObject(user, rawData)
+
+console.log(user)
+// Output: { name: 'John Doe', age: 30 }
+```
+
+## dataToObject Function
+
+Converts raw data (e.g., JSON, web forms) into a business object
+by applying type-appropriate transformations to each property.
+
+### Parameters
+
+- `object` (*T extends object*) – The target object where the transformed values will be assigned.
+- `data` (*[RecursiveStringObject](https://github.com/itrocks-ts/request-response#recursivestringobject)*) – The raw data source with string values.
+
+### Behavior
+
+- Inspect the object's properties.
+- Applies transformations via [@itrocks/transformer](https://github.com/itrocks-ts/transformer#applytransformer)
+  with [HTML and INPUT contexts](https://github.com/itrocks-ts/transformer#constants).
+- Ignores properties that are not present in the target object.
+- Skips properties explicitly marked as
+  [IGNORE](https://github.com/itrocks-ts/transformer#ignoring-a-transformation-result)
+  by the transformer.
+
+### Example Use Cases
+
+- Processing web form inputs safely (e.g. [@itrocks/save](https://github.com/itrocks-ts/save)).
+- Mapping JSON API responses to strongly-typed objects.
+- Cleaning and sanitizing data before storage or further processing.

package/cjs/data-to-object.d.ts

@@ -0,0 +1,2 @@
+import { RecursiveStringObject } from '@itrocks/request-response';
+export declare function dataToObject<T extends object>(object: T, data: RecursiveStringObject): Promise<void>;

package/cjs/data-to-object.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dataToObject = dataToObject;
+const reflect_1 = require("@itrocks/reflect");
+const transformer_1 = require("@itrocks/transformer");
+const transformer_2 = require("@itrocks/transformer");
+async function dataToObject(object, data) {
+    const properties = new reflect_1.ReflectClass(object).propertyNames;
+    for (const property in data) {
+        if (!properties.includes(property))
+            continue;
+        const value = await (0, transformer_1.applyTransformer)(data[property], object, property, transformer_2.HTML, transformer_2.INPUT, data);
+        if (value === transformer_2.IGNORE)
+            continue;
+        object[property] = value;
+    }
+}
+//# sourceMappingURL=data-to-object.js.map

package/package.json

@@ -0,0 +1,55 @@
+{
+	"author": {
+		"name": "Baptiste Pillot",
+		"email": "baptiste@pillot.fr"
+	},
+	"dependencies": {
+		"@itrocks/reflect": "latest",
+		"@itrocks/request-response": "latest",
+		"@itrocks/transformer": "latest"
+	},
+	"description": "Transforms raw string-based data into a business object with type-safe values",
+	"devDependencies": {
+		"typescript": "~5.6"
+	},
+	"engines": {
+		"node": ">=18"
+	},
+	"exports": "./cjs/data-to-object.js",
+	"homepage": "https://it.rocks",
+	"files": [
+		"LICENSE",
+		"README.md",
+		"cjs/*",
+		"!*.map"
+	],
+	"keywords": [
+		"backend",
+		"conversion",
+		"convert",
+		"data",
+		"form",
+		"handling",
+		"input",
+		"it.rocks",
+		"json",
+		"object",
+		"mapping",
+		"processing",
+		"transform",
+		"transformation",
+		"transformer",
+		"type"
+	],
+	"license": "ISC",
+	"name": "@itrocks/data-to-object",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/itrocks-ts/data-to-object.git"
+	},
+	"scripts": {
+		"build": "tsc -p tsconfig.json"
+	},
+	"types": "./cjs/data-to-object.d.ts",
+	"version": "0.0.1"
+}