@starbemtech/star-db-query-builder 1.0.21 → 1.0.23

package/README.md

@@ -1,12 +1,187 @@
-# star-db-query-builder
+# NodeJS Star DB Query Builder
 
-# Como criar o link local pelo pnpm
+🎉 Welcome to the NodeJS Database Library! This library provides a set of robust methods to interact with your database seamlessly. With TypeScript support, it ensures type safety and great developer experience.
 
-- Cria um link simbólico para o pacote local no diretório node_modules global.
-  $ pnpm link global
+## Features
 
-- Cria um link simbólico para o pacote global especificado no diretório node_modules global.
-  $ pnpm link --global <nome-do-pacote>
+- **TypeScript Declarations**: Ensure type safety and better autocompletion in your IDE.
+- **Flexible Configuration**: Easily initialize and configure the database client.
+- **Comprehensive CRUD Operations**: Perform Create, Read, Update, Delete operations with ease.
+- **Join Queries**: Execute complex join queries effortlessly.
 
-- Cria um link simbólico para o pacote no diretório especificado no diretório node_modules do projeto atual.
-  $ pnpm install ../star-db-query-builder
+## Installation
+
+```bash
+// Use npm
+$ npm install star-db-query-builder
+
+// Use yarn
+$ yarn add star-db-query-builder
+
+// Use pnpm
+$ pnpm install star-db-query-builder
+```
+
+## Usage
+
+### Initialization
+
+First, initialize the database with the appropriate configuration.
+
+```typescript
+import { initDb, getDbClient } from 'star-db-query-builder';
+
+// Use PostgresSQL
+initDb({
+  type: 'pg',
+  options: {
+     connectionURL: 'YOUR POSTGRES CONNECTION URL'
+  },
+});
+
+// User MySQL
+initDb({
+  type: 'mysql',
+  options: {
+     url: 'YOUR MYSQL CONNECTION URL'
+  },
+});
+
+// In your service, create an instance of getDbClient
+const dbClient = getDbClient();
+```
+
+### Methods
+
+#### findFirst
+
+Retrieve the first matching record from a table.
+
+```typescript
+import { findFirst } from 'star-db-query-builder';
+
+const result = await findFirst({
+  tableName: 'users',
+  dbClient,
+  select: ['id', 'name', 'email'],
+  where: {
+    id: { operator: '=', value: 1 }
+  }
+});
+
+console.log(result);
+```
+
+#### findMany
+
+Retrieve multiple records from a table.
+
+```typescript
+import { findMany } from 'star-db-query-builder';
+
+const results = await findMany({
+  tableName: 'users',
+  dbClient,
+  select: ['id', 'name', 'email'],
+  where: {
+    status: { operator: '= ', value: 'active' }
+  },
+  limit: 10,
+  offset: 0,
+});
+
+console.log(results);
+```
+
+#### insert
+
+Insert a new record into a table.
+
+```typescript
+import { insert } from 'star-db-query-builder';
+
+const newUser = { name: 'John Doe', email: 'john@example.com' };
+
+const insertedUser = await insert({
+  tableName: 'users',
+  dbClient,
+  data: newUser,
+  returning: ['id', 'name', 'email'],
+});
+
+console.log(insertedUser);
+```
+
+#### update
+
+Update an existing record in a table.
+
+```typescript
+import { update } from 'star-db-query-builder';
+
+const updatedUser = { name: 'John Smith' };
+
+const result = await update({
+  tableName: 'users',
+  dbClient,
+  id: 1,
+  data: updatedUser,
+  returning: ['id', 'name', 'email'],
+});
+
+console.log(result);
+```
+
+#### deleteOne
+
+Delete a record from a table.
+
+```typescript
+import { deleteOne } from 'star-db-query-builder';
+
+await deleteOne({
+  tableName: 'users',
+  dbClient,
+  id: 1,
+  permanently: true,
+});
+
+console.log('User deleted');
+```
+
+#### joins
+
+Execute a join query.
+
+```typescript
+import { joins } from 'star-db-query-builder';
+
+const joinResults = await joins({
+  tableName: 'orders',
+  dbClient,
+  select: ['orders.id', 'users.name'],
+  joins: [
+    {
+      table: 'users',
+      on: { 'orders.userId': 'users.id' },
+    },
+  ],
+  where: {
+    JOINS: [
+      {
+        'users.id': { operator: '=', value: exist.user_id }
+      }
+    ]
+  }
+});
+
+console.log(joinResults);
+```
+
+## License
+
+This project is licensed under the MIT License.
+
+---
+
+👨‍💻 Happy Coding!

package/coverage/clover.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1717461018121" clover="3.2.0">
-  <project timestamp="1717461018121" name="All files">
+<coverage generated="1720095645093" clover="3.2.0">
+  <project timestamp="1720095645093" name="All files">
     <metrics statements="0" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0" elements="0" coveredelements="0" complexity="0" loc="0" ncloc="0" packages="0" files="0" classes="0"/>
   </project>
 </coverage>

package/coverage/lcov-report/index.html

@@ -86,7 +86,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2024-06-04T00:30:18.116Z
+                at 2024-07-04T12:20:45.089Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/index.d.ts

@@ -22,6 +22,7 @@ export declare function findMany<T>({
   groupBy,
   orderBy,
   limit,
+  offset,
 }: QueryParams<T>): Promise<T[]>
 
 export declare function insert<P, R>({
@@ -46,10 +47,14 @@ export declare function deleteOne<T>({
   permanently,
 }: QueryParams<T> & { permanently?: boolean }): Promise<void>
 
-// Services Methods
-export declare function getByUserAndSubscription<T>({
+export declare function joins<T>({
   tableName,
   dbClient,
   select,
+  joins,
   where,
-}: QueryParams<T>): Promise<T | null>
+  groupBy,
+  orderBy,
+  limit,
+  offset,
+}: QueryParams<T>): Promise<T[]>

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@starbemtech/star-db-query-builder",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "A query builder to be used with mysql or postgres",
   "author": "Julio Sousa <julio.sousa@starbem.app>",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "license": "MIT",
   "engines": {
-    "node": ">=16.13",
-    "pnpm": ">=8.6.7 <9"
+    "node": ">=18"
   },
   "scripts": {
     "build": "tsc",
@@ -42,7 +41,6 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-jest": "^27.9.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "git-commit-msg-linter": "^5.0.7",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
     "lint-staged": "^15.2.2",
@@ -65,5 +63,6 @@
     "hooks": {
       "pre-commit": "lint-staged"
     }
-  }
+  },
+  "packageManager": "pnpm@8.6.2"
 }