db-crud-api 0.3.10 → 0.3.12

package/CHANGELOG.md

@@ -1,47 +1,51 @@
-# Changelog
-
-## v0.1.0 (2022-12-08)
-
-    Initial release
-## v0.1.1 (2023-01-01)
-
-    Bug fix:
-        - default server/database
-## v0.1.4 (2024-02-24)
-
-    Bug fix:
-        - update mssql to 9.3.2
-        - update uuid to 9.0.1
-## v0.1.5 (2024-03-03)
-
-    Bug fix:
-        - deleteById function crash 
-        - new function return undefined
-        ## v0.1.5 (2024-03-03)
-## v0.1.6 (2024-03-03)
-
-    Bug fix:
-        - update function crash with date value
-## v0.1.9 (2024-03-12)
-
-    Added:
-        - execute store procedure
-## v0.2.0 (2024-04-02)
-
-    Changes:
-        - parameters position have been change for some api 
-    Added:
-        - batch job that run multiple instructions
-## v0.2.1 (2024-12-05)
-
-    Refresh dependency
-## v0.3.0 (2024-12-28)
-
-    Changes:
-        - execute api definition
-    Added:
-        - support for mySQL
-## v0.3.1 (2025-01-01)
-
-    Bug fix:
-        - autoId flag not onored
+# Changelog
+
+## v0.1.0 (2022-12-08)
+
+    Initial release
+## v0.1.1 (2023-01-01)
+
+    Bug fix:
+        - default server/database
+## v0.1.4 (2024-02-24)
+
+    Bug fix:
+        - update mssql to 9.3.2
+        - update uuid to 9.0.1
+## v0.1.5 (2024-03-03)
+
+    Bug fix:
+        - deleteById function crash 
+        - new function return undefined
+        ## v0.1.5 (2024-03-03)
+## v0.1.6 (2024-03-03)
+
+    Bug fix:
+        - update function crash with date value
+## v0.1.9 (2024-03-12)
+
+    Added:
+        - execute store procedure
+## v0.2.0 (2024-04-02)
+
+    Changes:
+        - parameters position have been change for some api 
+    Added:
+        - batch job that run multiple instructions
+## v0.2.1 (2024-12-05)
+
+    Refresh dependency
+## v0.3.0 (2024-12-28)
+
+    Changes:
+        - execute api definition
+    Added:
+        - support for mySQL
+## v0.3.1 (2025-01-01)
+
+    Bug fix:
+        - autoId flag not onored
+## v0.3.11 (2025-10-25)
+
+    Added:
+        - testConnection()

package/README.md

@@ -1,98 +1,100 @@
-# db-crud-api 💡
-    CRUD api for database tables.
-
-## Installation
-    npm install db-crud-api
-
-# Usage
-```javascript
-    import dbCrudApi from "db-crud-api";
-    const apiFactory = dbCrudApi(mySchema);
-
-    const mySchema = {
-        servers: {
-            server1: {
-                realName: "server1.mydomain.com",
-                type: "ms-sql",
-                instance: "DEFAULT",
-                user: "User1",
-                password: "mypassword",
-                options: {
-                    appName: "myAppName",
-                    ...
-                },
-                databases: {
-                    db1: {
-                        realName: "db_orders",
-                        tables: {
-                            table1: {
-                                realName: "tb_orders_head",
-                                idField: "Id",
-                                autoId: true,
-                                fields: {
-                                    Id: { realName: "OrderId", type: "uuid", lengh: undefined, canBeNull: false, description: "Unique Id", defaultValue: undefined },
-                                    CustomerId: { type: "string", lengh: undefined, canBeNull: false, description: "Customer Id", defaultValue: undefined },
-                                    ...
-                                }
-                            },
-                            table2: {
-                                realName: "tb_orders_detail",
-                                idField: "Id",
-                                autoId: true,
-                                fields: {
-                                    Id: { realName: "OrderId", type: "uuid", lengh: undefined, canBeNull: false, description: "Unique Id", defaultValue: undefined },
-                                    OrderId: { type: "uuid", lengh: undefined, canBeNull: false, description: "Order Id", defaultValue: undefined },
-                                    RowSeq: { type: "numeric", lengh: undefined, canBeNull: false, description: "Row sequence", defaultValue: undefined },
-                                    ...
-                                }
-                            },
-                            ...
-                        }
-                    },
-                    ...
-                }
-            },
-            ...
-        }
-    };
-
-    const apiOrder = apiFactory.newROApi("server1.db1.table1");  // Read Only api
-    const apiOrderDetail = apiFactory.newFullApi("table2"); // full CRUD api
-    const apiExecuteSP = apiFactory.newExecuteApi("db1.my_storeproc"); // execute my_storeproc
-
-    console.log(await apiOrder.getById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx"));
-    console.log(await apiOrder.getById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx", {get: {fields: ["Id", "OrderNumber", "OrderTotal"]}}));
-    console.log(await apiOrder.getByFilter({get: {filters: ["OrderType in ('P', 'A')", "and", "OrderDate > '2022-12-01'"]}}));   // get filterd rows
-    console.log(await apiOrder.getByFilter());   // this get all rows
-    console.log(await apiOrderDetail.patchById({patch: {sets: {ItemRef: "2024-TX-0001", ItemDate: "2024-01-31"}}}, "xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx"));   // change some fields
-    console.log(await apiOrderDetail.patchByFilter({patch: {sets: {LastUpdate: "2023-04-30"}, filters: ["OrderId: 'xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx'"]}}));   // change by filter
-    console.log(await apiOrderDetail.deleteById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx"));   // delete row by Id
-    console.log(await apiOrderDetail.deleteByFilter({delete: {filters: ["ItemType in ('X', 'W')", "and", "ItemDate > '2022-12-01'"]}}));   // delete filterd rows
-    console.log(await apiExecuteSP.execute());   // execute procedure with no argument
-    console.log(await apiExecuteSP.execute({execute: {arguments: "@Company, @OrderNumber", params: {Company: "XXX", OrderNumber: "12345"}}}));   // execute procedure with arguments and params 
-```
-
-License
--------
-
-    MIT License
-
-    Copyright (c) 2022
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# db-crud-api 💡
+    CRUD api for database tables.
+
+## Installation
+    npm install db-crud-api
+
+# Usage
+```javascript
+    import dbCrudApi from "db-crud-api";
+    const apiFactory = dbCrudApi(mySchema);
+
+    const mySchema = {
+        servers: {
+            server1: {
+                realName: "server1.mydomain.com",
+                type: "ms-sql",
+                instance: "DEFAULT",
+                user: "User1",
+                password: "mypassword",
+                options: {
+                    appName: "myAppName",
+                    ...
+                },
+                databases: {
+                    db1: {
+                        realName: "db_orders",
+                        tables: {
+                            table1: {
+                                realName: "tb_orders_head",
+                                idField: "Id",
+                                autoId: true,
+                                fields: {
+                                    Id: { realName: "OrderId", type: "uuid", lengh: undefined, canBeNull: false, description: "Unique Id", defaultValue: undefined },
+                                    CustomerId: { type: "string", lengh: undefined, canBeNull: false, description: "Customer Id", defaultValue: undefined },
+                                    ...
+                                }
+                            },
+                            table2: {
+                                realName: "tb_orders_detail",
+                                idField: "Id",
+                                autoId: true,
+                                fields: {
+                                    Id: { realName: "OrderId", type: "uuid", lengh: undefined, canBeNull: false, description: "Unique Id", defaultValue: undefined },
+                                    OrderId: { type: "uuid", lengh: undefined, canBeNull: false, description: "Order Id", defaultValue: undefined },
+                                    RowSeq: { type: "numeric", lengh: undefined, canBeNull: false, description: "Row sequence", defaultValue: undefined },
+                                    ...
+                                }
+                            },
+                            ...
+                        }
+                    },
+                    ...
+                }
+            },
+            ...
+        }
+    };
+
+    const apiOrder = apiFactory.newROApi("server1.db1.table1");  // Read Only api
+    const apiOrderDetail = apiFactory.newFullApi("table2"); // full CRUD api
+    const apiExecuteSP = apiFactory.newExecuteApi("db1.my_storeproc"); // execute my_storeproc
+
+    console.log(await apiFactory.testConnection()); // optional
+
+    console.log(await apiOrder.getById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx"));
+    console.log(await apiOrder.getById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx", {get: {fields: ["Id", "OrderNumber", "OrderTotal"]}}));
+    console.log(await apiOrder.getByFilter({get: {filters: ["OrderType in ('P', 'A')", "and", "OrderDate > '2022-12-01'"]}}));   // get filterd rows
+    console.log(await apiOrder.getByFilter());   // this get all rows
+    console.log(await apiOrderDetail.patchById({patch: {sets: {ItemRef: "2024-TX-0001", ItemDate: "2024-01-31"}}}, "xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx"));   // change some fields
+    console.log(await apiOrderDetail.patchByFilter({patch: {sets: {LastUpdate: "2023-04-30"}, filters: ["OrderId: 'xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx'"]}}));   // change by filter
+    console.log(await apiOrderDetail.deleteById("xxxxx-xxxxx-xxxxxxxxxxxx-xxxxxx"));   // delete row by Id
+    console.log(await apiOrderDetail.deleteByFilter({delete: {filters: ["ItemType in ('X', 'W')", "and", "ItemDate > '2022-12-01'"]}}));   // delete filterd rows
+    console.log(await apiExecuteSP.execute());   // execute procedure with no argument
+    console.log(await apiExecuteSP.execute({execute: {arguments: "@Company, @OrderNumber", params: {Company: "XXX", OrderNumber: "12345"}}}));   // execute procedure with arguments and params 
+```
+
+License
+-------
+
+    MIT License
+
+    Copyright (c) 2022
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     SOFTWARE.

package/deploy

@@ -2,4 +2,4 @@
 ##### !!! pay attention to not publish files with secrets
 npm login
 npm publish
-npm unpublish db-crud-api@0.1.0
+npm unpublish db-crud-api@0.X.X

package/lib/api-factory.js

@@ -1,27 +1,31 @@
-"use strict";
-
-import * as dbOpe from "./db-operations.js" 
-import apiFull from "./api-full.js"
-import apiRO from "./api-ro.js"
-import apiExecute from "./api-execute.js"
-import apiBatch from "./api-batch.js"
-
-export function newFullApi(tablePath) {
-    return new apiFull(tablePath);
-}
-
-export function newROApi(tablePath) {
-    return new apiRO(tablePath);
-}
-
-export function newExecuteApi(procPath) {
-    return new apiExecute(procPath);
-}
-
-export function newBatchApi(useTransaction) {
-    return new apiBatch(useTransaction);
-}
-
-export function closeAllDbConnections() {
-    return dbOpe.closeAllConnections();
+"use strict";
+
+import * as dbOpe from "./db-operations.js" 
+import apiFull from "./api-full.js"
+import apiRO from "./api-ro.js"
+import apiExecute from "./api-execute.js"
+import apiBatch from "./api-batch.js"
+
+export function newFullApi(tablePath) {
+    return new apiFull(tablePath);
+}
+
+export function newROApi(tablePath) {
+    return new apiRO(tablePath);
+}
+
+export function newExecuteApi(procPath) {
+    return new apiExecute(procPath);
+}
+
+export function newBatchApi(useTransaction) {
+    return new apiBatch(useTransaction);
+}
+
+export function closeAllDbConnections() {
+    return dbOpe.closeAllConnections();
+}
+
+export function testDbConnection() {
+    return dbOpe.testConnection();
 }