@wtasnorg/node-lib 0.0.3 → 0.0.4

package/.github/workflows/npm-test-on-pr.yml

@@ -0,0 +1,30 @@
+name: Run tests on pull request
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test

package/README.md

@@ -5,6 +5,11 @@ A library project for nodejs. #nodejs #typescript #library
 - [npm org](https://www.npmjs.com/org/wtasnorg)
 - [github repo](https://github.com/wtasg/node-lib)
 
+## Functions
+
+1. hello (for debugging)
+2. `pojo` for converting class objects to Plain Old Javascript Objects.
+
 ## Develop
 
 ```bash

package/docs/README.md

@@ -9,6 +9,11 @@ A library project for nodejs. #nodejs #typescript #library
 - [npm org](https://www.npmjs.com/org/wtasnorg)
 - [github repo](https://github.com/wtasg/node-lib)
 
+## Functions
+
+1. hello (for debugging)
+2. `pojo` for converting class objects to Plain Old Javascript Objects.
+
 ## Develop
 
 ```bash

package/docs/docs.json

@@ -17,7 +17,7 @@
 					"fileName": "hello.ts",
 					"line": 6,
 					"character": 15,
-					"url": "https://github.com/wtasg/node-lib/blob/8c33d6e85b13c11164c0ab9dca01c58d3cd86813/src/hello.ts#L6"
+					"url": "https://github.com/wtasg/node-lib/blob/be4189222f32cc9b2fdf81c380cde5c51f69046c/src/hello.ts#L6"
 				}
 			],
 			"signatures": [
@@ -51,7 +51,7 @@
 							"fileName": "hello.ts",
 							"line": 6,
 							"character": 15,
-							"url": "https://github.com/wtasg/node-lib/blob/8c33d6e85b13c11164c0ab9dca01c58d3cd86813/src/hello.ts#L6"
+							"url": "https://github.com/wtasg/node-lib/blob/be4189222f32cc9b2fdf81c380cde5c51f69046c/src/hello.ts#L6"
 						}
 					],
 					"type": {
@@ -86,7 +86,15 @@
 	"readme": [
 		{
 			"kind": "text",
-			"text": "# @wtasnorg/node-lib\n\nA library project for nodejs. #nodejs #typescript #library\n\n- [npm org](https://www.npmjs.com/org/wtasnorg)\n- [github repo](https://github.com/wtasg/node-lib)\n\n## Develop\n\n"
+			"text": "# @wtasnorg/node-lib\n\nA library project for nodejs. #nodejs #typescript #library\n\n- [npm org](https://www.npmjs.com/org/wtasnorg)\n- [github repo](https://github.com/wtasg/node-lib)\n\n## Functions\n\n1. hello (for debugging)\n2. "
+		},
+		{
+			"kind": "code",
+			"text": "`pojo`"
+		},
+		{
+			"kind": "text",
+			"text": " for converting class objects to Plain Old Javascript Objects.\n\n## Develop\n\n"
 		},
 		{
 			"kind": "code",

package/docs/functions/hello.md

@@ -8,7 +8,7 @@
 
 > **hello**(): `Promise`\<`string`\>
 
-Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/8c33d6e85b13c11164c0ab9dca01c58d3cd86813/src/hello.ts#L6)
+Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/be4189222f32cc9b2fdf81c380cde5c51f69046c/src/hello.ts#L6)
 
 A sample function that should work to test if lib is installed correctly.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtasnorg/node-lib",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "node library",
   "main": "src/index.js",
   "scripts": {
@@ -8,7 +8,7 @@
     "docs": "./node_modules/.bin/typedoc",
     "docs:json": "./node_modules/.bin/typedoc --json docs/docs.json",
     "docs:watch": "./node_modules/.bin/typedoc --watch",
-    "test": "node --test"
+    "test": "bash -c 'node --test src/**/*.test.js'"
   },
   "keywords": [
     "library"

package/src/pojo.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Convert a class instance into a plain JavaScript object.
+ * Copies only the instance's own enumerable data properties
+ * and excludes methods or prototype values.
+ *
+ * @template T
+ * @param {T} instance - A class instance to convert.
+ * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ */
+declare function pojo<T extends object>(instance: T): Record<string, any>;
+export { pojo };
+//# sourceMappingURL=pojo.d.ts.map

package/src/pojo.js

@@ -0,0 +1,14 @@
+/**
+ * Convert a class instance into a plain JavaScript object.
+ * Copies only the instance's own enumerable data properties
+ * and excludes methods or prototype values.
+ *
+ * @template T
+ * @param {T} instance - A class instance to convert.
+ * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ */
+function pojo(instance) {
+    return Object.fromEntries(Object.entries(instance).filter(([_, value]) => typeof value !== "function"));
+}
+export { pojo };
+//# sourceMappingURL=pojo.js.map

package/src/pojo.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pojo.test.d.ts.map

package/src/pojo.test.js

@@ -0,0 +1,58 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { pojo } from "./pojo.js";
+class User {
+    id;
+    name;
+    constructor(id, name) {
+        this.id = id;
+        this.name = name;
+    }
+    greet() {
+        return `hello ${this.name}`;
+    }
+}
+test("pojo() should return only enumerable data fields", () => {
+    const u = new User(1, "Alice");
+    const out = pojo(u);
+    assert.deepEqual(out, {
+        id: 1,
+        name: "Alice"
+    });
+});
+test("pojo() should exclude methods", () => {
+    const u = new User(2, "Bob");
+    const out = pojo(u);
+    assert.ok(!("greet" in out));
+});
+test("pojo() should exclude prototype properties", () => {
+    class Product {
+        id;
+        constructor(id) {
+            this.id = id;
+        }
+        get info() {
+            return `Product:${this.id}`;
+        }
+    }
+    const p = new Product(101);
+    const out = pojo(p);
+    assert.deepEqual(out, { id: 101 });
+    assert.ok(!("info" in out));
+});
+test("pojo() should ignore non-enumerable own properties", () => {
+    class SecretBox {
+        visible = "open";
+        constructor() {
+            Object.defineProperty(this, "hidden", {
+                value: "secret",
+                enumerable: false
+            });
+        }
+    }
+    const box = new SecretBox();
+    const out = pojo(box);
+    assert.deepEqual(out, { visible: "open" });
+    assert.ok(!("hidden" in out));
+});
+//# sourceMappingURL=pojo.test.js.map

package/src/pojo.test.ts

@@ -0,0 +1,69 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { pojo } from "./pojo.js";
+
+class User {
+    id: number;
+    name: string;
+
+    constructor(id: number, name: string) {
+        this.id = id;
+        this.name = name;
+    }
+
+    greet() {
+        return `hello ${this.name}`;
+    }
+}
+
+test("pojo() should return only enumerable data fields", () => {
+    const u = new User(1, "Alice");
+    const out = pojo(u);
+
+    assert.deepEqual(out, {
+        id: 1,
+        name: "Alice"
+    });
+});
+
+test("pojo() should exclude methods", () => {
+    const u = new User(2, "Bob");
+    const out = pojo(u);
+
+    assert.ok(!("greet" in out));
+});
+
+test("pojo() should exclude prototype properties", () => {
+    class Product {
+        constructor(public id: number) { }
+
+        get info() {
+            return `Product:${this.id}`;
+        }
+    }
+
+    const p = new Product(101);
+    const out = pojo(p);
+
+    assert.deepEqual(out, { id: 101 });
+    assert.ok(!("info" in out));
+});
+
+test("pojo() should ignore non-enumerable own properties", () => {
+    class SecretBox {
+        visible = "open";
+
+        constructor() {
+            Object.defineProperty(this, "hidden", {
+                value: "secret",
+                enumerable: false
+            });
+        }
+    }
+
+    const box = new SecretBox();
+    const out = pojo(box);
+
+    assert.deepEqual(out, { visible: "open" });
+    assert.ok(!("hidden" in out));
+});

package/src/pojo.ts

@@ -0,0 +1,18 @@
+/**
+ * Convert a class instance into a plain JavaScript object.
+ * Copies only the instance's own enumerable data properties
+ * and excludes methods or prototype values.
+ *
+ * @template T
+ * @param {T} instance - A class instance to convert.
+ * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ */
+function pojo<T extends object>(instance: T): Record<string, any> {
+    return Object.fromEntries(
+        Object.entries(instance).filter(([_, value]) => typeof value !== "function")
+    );
+}
+
+export {
+    pojo
+};