zormz 1.4.1 → 1.4.3

package/README.md

@@ -7,17 +7,17 @@ Permite conectarse a una base de datos, definir tablas desde TypeScript con auto
 
 ## Características
 
-* Compatible con **ESM** y **CommonJS**
-* Tipado completo en **TypeScript**
-* Builder con sintaxis encadenada: `select().from().where().execute()`
-* Insert múltiple con arrays
-* Update y Delete con condiciones
-* Definición de columnas con encadenamiento:
-  * `int().Pk().$()`
-  * `varchar(200).Default("hola").$()`
-* Generación automática de tablas en MySQL y PostgreSQL
-* Sin dependencias pesadas
-* Fácil de extender
+- Compatible con **ESM** y **CommonJS**
+- Tipado completo en **TypeScript**
+- Builder con sintaxis encadenada: `select().from().where().execute()`
+- Insert múltiple con arrays
+- Update y Delete con condiciones
+- Definición de columnas con encadenamiento:
+  - `int().Pk().$()`
+  - `varchar(200).Default("hola").$()`
+- Generación automática de tablas en MySQL y PostgreSQL
+- Sin dependencias pesadas
+- Fácil de extender
 
 ---
 
@@ -29,20 +29,43 @@ npm install zormz
 ```
 
 ## Uso basico
-### importacion ESM
-```ts
 
-import { connecionLocal, getConexion, defineTable, generateTable, int, varchar, DB, eq, ORQ } from "zormz";
+### importacion ESM
 
+```ts
+import {
+  connecionLocal,
+  getConexion,
+  defineTable,
+  generateTable,
+  int,
+  varchar,
+  DB,
+  eq,
+  ORQ,
+} from "zormz";
 ```
+
 ### importacion COMMONJS
 
 ```ts
-const { connecionLocal, getConexion, defineTable, generateTable, int, varchar, DB, eq, ORQ } = require("zormz");
-
+const {
+  connecionLocal,
+  getConexion,
+  defineTable,
+  generateTable,
+  int,
+  varchar,
+  DB,
+  eq,
+  ORQ,
+} = require("zormz");
 ```
+
 ## Conexion a la base de datos
+
 ### MYSQL
+
 ```ts
 const conexionMysql: connecionLocal = {
   database: "pruebas",
@@ -53,15 +76,15 @@ const conexionMysql: connecionLocal = {
 };
 
 getConexion("mysql", conexionMysql);
-
 ```
 
 ### PG
+
 ```ts
 //Conexion por red , aqui solo se pone la ruta que por defecto te arroja la base de datos de la nube
-const conexion2:connecionRed = {
-    connectionString:"direccion"
-}
+const conexion2: connecionRed = {
+  connectionString: "direccion",
+};
 
 const conexion: connecionLocal = {
   database: "pruebamaster",
@@ -72,10 +95,9 @@ const conexion: connecionLocal = {
 };
 
 getConexion("pg", conexion);
-
 ```
 
-## Definicion de Tablas 
+## Definicion de Tablas
 
 ```ts
 export const prueba1 = defineTable("prueba1", {
@@ -83,11 +105,12 @@ export const prueba1 = defineTable("prueba1", {
   valor: varchar(200).Default("hola").$(),
   resultado: int().Default(0).$(),
   fechaRegistro: timestamp().required().now().$(),
-  fechaUpdate: timestamp().required().now().onUpdate().$()
+  fechaUpdate: timestamp().required().now().onUpdate().$(),
 });
-
 ```
+
 o
+
 ```ts
 export function generateTables() {
   return {
@@ -98,7 +121,7 @@ export function generateTables() {
       dni: varchar(9).$(),
       rol: varchar(50).$(),
       diastrabajo: varchar(200).Default("sabado - domingo").$(),
-      activo: bool().default(true).$(),
+      estado: varchar().Check(["pendiente", "completado", "rechazado"]).$(),
     }),
     permisos: defineTable("permisos", {
       idpermiso: int().Pk().$(),
@@ -116,21 +139,27 @@ export function generateTables() {
 ```
 
 ### Notas importantes
-* **.pk()** define la columna como clave primaria
-* **.Default()** entrega un valor por defecto
-* **.$()** finaliza la definicion y entrega un valor compatible con *$columns*
-* **.required()** Indica que los valores de la fila no podran ser null, si o si un valor obligatorio
-* **.now()** Solo esta disponible para timestamp , indica fecha automatica de registra
-* **.onUpdate()** Tomara la fecha actual cada ves que se haga un update
+
+- **.pk()** define la columna como clave primaria
+- **.Default()** entrega un valor por defecto
+- **.$()** finaliza la definicion y entrega un valor compatible con _$columns_
+- **.required()** Indica que los valores de la fila no podran ser null, si o si un valor obligatorio
+- **.now()** Solo esta disponible para timestamp , indica fecha automatica de registra
+- **.onUpdate()** Tomara la fecha actual cada ves que se haga un update
+- **.Check()** Solo para varchar , puedes decirle que valores esta obligado a recibir y no otros
+
 ## Generacion de tablas
+
 ```ts
-generateTable(prueba1(), prueba1.$columns);
+generateTable(prueba1(), prueba1.$columns,true);//true para ver la definicion
 ```
+
 Esto crea la tabla en la base de datos respetando tipos, claves primarias y valores por defecto.
 
 ---
 
 ## Eliminar tablas
+
 ```ts
 await dropTable(prueba4());
 ```
@@ -139,10 +168,14 @@ await dropTable(prueba4());
 
 ```ts
 await DB.Insert(prueba1(), [prueba1.valor, prueba1.resultado])
-  .Values([["hola mundo", 1], ["prueba", 0]])
+  .Values([
+    ["hola mundo", 1],
+    ["prueba", 0],
+  ])
+  .Returning(prueba1.id)
   .execute();
-
 ```
+
 ---
 
 ## Select de Datos
@@ -151,67 +184,175 @@ await DB.Insert(prueba1(), [prueba1.valor, prueba1.resultado])
 const datos = await DB.select()
   .from(prueba1())
   .where(eq(prueba1.id, 1))
-  .execute();
-
+  .execute(true);
 ```
+
 ---
 
 ## Update de Datos
-### .set() Recibe un objeto con clave valor de las tablas o un array con UP 
+
+### .set() Recibe un objeto con clave valor de las tablas o un array con UP
+
 ```ts
 await DB.Update(prueba1())
   .set({ valor: "nuevo valor", resultado: 2 })
   .where(eq(prueba1.id, 1))
   .execute();
-
 ```
+
 o
+
 ```ts
-  //Usar la funcion UP
-  const response = await DB.Update(producto())
-    .set([UP(producto.stockactual, `${producto.stockactual} -  4`, true)])
-    .where(eq(producto.idproducto, 4))
-    .execute();
-  
+//Usar la funcion UP
+const response = await DB.Update(producto())
+  .set([UP(producto.stockactual, `${producto.stockactual} -  4`, true)])
+  .where(eq(producto.idproducto, 4))
+  .execute();
 ```
 
 ---
+
 ## Delete de Datos
+
 ```ts
 await DB.Delete(prueba1())
   .where(ORQ(prueba1.id, 2, 3))
   .execute();
-
 ```
+
 ## JOINS
+
 ```ts
 const { detallespermisos, colaborador, permisos } = generateTables();
 
-  const response = await DB.Select([
-    detallespermisos.iddetallepermiso,
-    colaborador.nombrecompleto,
-    colaborador.dni,
-    permisos.nombre,
-    permisos.estado,
-  ])
-    .from(detallespermisos())
-    .innerJOIN(
-      colaborador(),
-      eq(colaborador.idcolaborador, detallespermisos.idcolaborador, false),
-    )
-    .innerJOIN(
-      permisos(),
-      eq(permisos.idpermiso, detallespermisos.idppermiso, false),
-    )
-    .execute();
+const response = await DB.Select([
+  detallespermisos.iddetallepermiso,
+  colaborador.nombrecompleto,
+  colaborador.dni,
+  permisos.nombre,
+  permisos.estado,
+])
+  .from(detallespermisos())
+  .innerJOIN(
+    colaborador(),
+    eq(colaborador.idcolaborador, detallespermisos.idcolaborador, false),
+  )
+  .innerJOIN(
+    permisos(),
+    eq(permisos.idpermiso, detallespermisos.idppermiso, false),
+  )
+  .execute();
+```
+---
+
+## Operadores y Helpers SQL
+
+
+### eq(valor1,valor2,literal = true)
+comparacion de igualdad
+
+```ts
+  eq("dni", dni);//2do valor como variable 
+  eq("id","idLaptops",true)//2do valor como campo de tabla 
+```
+
+### neq(valor1,valor2,literal = true)
+comparacion de negacion
+
+```ts
+  neq("dni", dni);//2do valor como variable 
+  neq("id","idLaptops",true)//2do valor como campo de tabla 
+```
+
+---
+
+### AND(...condiciones)
+Agrupa múltiples condiciones con `AND`.
+
+```ts
+AND(eq(), eq(), neq())
+```
+
+### OR(...condiciones)
+Agrupa múltiples condiciones con `OR`.
+
+```ts
+OR(neq(), eq(), eq())
+```
+
+### ORQ(campo,...valores)
+Genera multiples comparaciones `OR` para un mismo campo.
+
+```ts
+ORQ("id",1,2,3);
+// => id = 1 or id = 2 or id = 3
+```
+---
+### ILIKE(campo,valor)
+Comparacion insensible a mayusculas/minusculas 
+
+```ts
+ILIKE('nombre','%juan%');
+// => nombre ILIKE '%juan%'
+```
+
+### NOW(campo,dias,minor = true)
+Compara una fecha con la fecha actual menos X días.
+```ts
+NOW('fecha_creacion', 7)
+// => ( fecha_creacion < NOW() - INTERVAL '7 days')
+
+NOW('fecha_creacion', 7, false)
+// => ( fecha_creacion > NOW() - INTERVAL '7 days')
+
+```
+---
+### NULL(campo)
+valida si un campo es NULL
+```ts
+NULL('delete_at');
+//=> delete_at IS NULL
+```
+
+### NOTNULL(campo)
+valida si un campo no es NULL
+```ts
+NOTNULL('deleted_at')
+// => deleted_at IS NOT NULL
+```
+---
+
+
+### MAYOR(campo,valor)
+Comparacion mayor que (`>`)
+```ts
+
+MAYOR('edad',18);
+// => edad > 18
+```
+### MENOR(campo,valor)
+Comparacion menor que (`<`)
+```ts
+MENOR('edad', 18)
+// => edad < 18
 
 ```
 ---
 
-## Ejemplo de Uso 
+## Ejemplo de Uso
 
 ```ts
-import { connecionLocal, getConexion, defineTable, generateTable, int, varchar, DB, eq, ORQ } from "zormz";
+import {
+  connecionLocal,
+  getConexion,
+  defineTable,
+  generateTable,
+  int,
+  varchar,
+  DB,
+  eq,
+  ORQ,
+} from "zormz";
 
 const conexion: connecionLocal = {
   database: "pruebamaster",
@@ -228,14 +369,17 @@ getConexion("pg", conexion);
 const prueba1 = defineTable("prueba1", {
   id: int().Pk().$(),
   valor: varchar(200).Default("hola").$(),
-  resultado: int().Default(0).$()
+  resultado: int().Default(0).$(),
 });
 
 generateTable(prueba1(), prueba1.$columns);
 
 async function pruebaData() {
   await DB.Insert(prueba1(), [prueba1.valor, prueba1.resultado])
-    .Values([["hola mundo", 1], ["prueba", 0]])
+    .Values([
+      ["hola mundo", 1],
+      ["prueba", 0],
+    ])
     .execute();
 
   const datos = await DB.select().from(prueba1()).execute();
@@ -252,19 +396,19 @@ async function pruebaData() {
 }
 
 pruebaData().catch(console.error);
-
 ```
 
 ---
-
 ## Notas
-* ORM en version inicial con enfoque de tipado y autompletado 
-* Compatible con **MYSQL** y **PG**
-* Preparado para extenderse
-* Las versiones +1.3.0 son mas estables , las anteriores estaban en desarrollo y presentan multiples errores
-* version estable 1.4.0
+
+- ORM en version inicial con enfoque de tipado y autompletado
+- Compatible con **MYSQL** y **PG**
+- Preparado para extenderse
+- Las versiones +1.3.0 son mas estables , las anteriores estaban en desarrollo y presentan multiples errores
+- version estable 1.4.2
+
 ## Licencia
 
 ISC © Yukio-kayaba
 
-[![GitHub](https://img.shields.io/badge/GitHub-Sigue%20me-black?logo=github)](https://github.com/yukio-kayaba/) 
+[![GitHub](https://img.shields.io/badge/GitHub-Sigue%20me-black?logo=github)](https://github.com/yukio-kayaba/)

package/dist/index.d.mts

@@ -12,6 +12,7 @@ interface ColumnDefinition<T extends ColumnTypes = ColumnTypes> {
   typo: T;
   pk?: boolean;
   sqlz: string;
+  check?: string
 }
 
 interface VarcharType{
@@ -83,25 +84,17 @@ type TableProxy<TCols> = {
  * @param {string} tableName
  * @param {string} columns
  * @example
- * export const productosPrueba = defineTable("productosPrueba",{
- *  id:{typo:"int",id:true},
-    dato: {
-        typo:"varchar",
-        maxLength:200,
-        default:"hola mundo"
-    },
-    edad: {
-        typo:"int",
-        default: 0,
-    },
-    apellido : {
-        typo:"varchar",
-    }
+ * export const categorias = defineTable("categorias", {
+       idcategoria: int().Pk().$(),
+       nombrecategoria: varchar(100).Check(['disponible','data']).Required().$(),
+       descripcion: varchar(250).$(),
+       estado: bool().default(true).$(),
+     })
  * });
  * @returns
  */
 declare function defineTable<T extends Record<string, ColumnDefinition>>(tableName: string, columns: T): TableProxy<T>;
-declare function generateTable<T extends Record<string, ColumnDefinition>>(tabla: string, columns: T): Promise<void>;
+declare function generateTable<T extends Record<string, ColumnDefinition>>(tabla: string, columns: T, seeSQL?: boolean): Promise<void>;
 declare function dropTable(nombreTabla: string): Promise<void>;
 
 declare class DeleteR {
@@ -131,7 +124,7 @@ declare class QueryBuilder {
     private tabla;
     private parametros;
     private valores;
-    private valorRetorno;
+    private returning;
     private conexion;
     /**
      * @throws {Error} Si la consulta es vacía.
@@ -154,7 +147,8 @@ declare class QueryBuilder {
      * @returns
      */
     Values(values: arrayData | arrayDatas): this;
-    execute(see?: boolean): Promise<number | any[] | undefined>;
+    Returning(idRetorno: string): this;
+    execute(see?: boolean): Promise<any[] | undefined>;
 }
 
 type valor = "ASC" | "DESC";
@@ -344,6 +338,19 @@ declare const NOTNULL: (variable: string) => string;
  * eq('id',valor1, false)
  */
 declare const eq: (valor1: Valor, valor2: Valor, literal?: boolean) => string;
+/**
+ *
+ * @param {(string | number | boolean )} valor1 - primer valor
+ * @param {(string | number | boolean )} valor2 - segundo valor
+ * @param {(boolean )} literal
+ *
+ * @example
+ * //en caso sea un valores normalres
+ * neq('id','1')
+ * //en caso de que seaq un valor de tabla columna
+ * neq('id',valor1, false)
+ */
+declare const neq: (valor1: Valor, valor2: Valor, literal?: boolean) => string;
 /**
  *
  * @param {string} valor
@@ -392,9 +399,11 @@ declare class IntColumn {
     private defaultData?;
     private pk?;
     private unsingned;
+    private comentario;
     constructor();
     Required(): this;
     Pk(): this;
+    Comment(comentario: string): this;
     Unique(): this;
     Unsingned(numeroPositivosInicio?: number): this;
     AutoIncrement(): this;
@@ -409,9 +418,23 @@ declare class Varchar {
     private defaultData;
     private requerido;
     private unique;
+    private enum;
+    private campo;
+    private comentarios;
     constructor(cantidad?: number);
     withType({ maxLenth, defaultData, requerido, unique, }: VarcharType): ColumnDefinition<ColumnTypes>;
+    /**
+     *
+     * @param {string} campo
+     * @param {string[]} datos
+     * @example
+     * Check("example", ["operativo","denegado","revisando"])
+     *
+     * @returns
+     */
+    Check(datos: (string)[]): this;
     Required(): this;
+    Comment(comentario: string): this;
     Unique(): this;
     Default(textoDefecto: string): this;
     $(): ColumnDefinition<ColumnTypes>;
@@ -421,7 +444,9 @@ declare function varchar(cantidad?: number): Varchar;
 declare class BoolColumn {
     private requerido;
     private defaultData?;
+    private comentario;
     required(): this;
+    Comment(comentario: string): this;
     default(value: boolean): this;
     $(): ColumnDefinition;
 }
@@ -431,7 +456,9 @@ declare class Timestamp {
     private requerido;
     private defaultNow;
     private onUpdateNow;
+    private comentario;
     required(): this;
+    comment(comentario: string): this;
     now(): this;
     onUpdate(): this;
     $(): ColumnDefinition<ColumnTypes>;
@@ -443,11 +470,13 @@ declare class Money {
     private scale;
     private requerido;
     private defaultData?;
+    private comentario;
     constructor(presicion?: number, decimales?: number);
     required(): this;
     default(value: number): this;
+    comment(comentario: string): this;
     $(): ColumnDefinition<ColumnTypes>;
 }
 declare function money(presicion?: number, decimales?: number): Money;
 
-export { AND, BDconnection, CURRENT_TIMESTAMP, type Consultas, DB, DeleteR, ILIKE, MAYOR, MENOR, NOTNULL, NOW, NULL, OR, ORQ, QueryBuilder, Select, type TableProxy, type Tipos, UP, Update, type Valores, type arrayData, type arrayDatas, bool, type connecionLocal, type connecionRed, type connectionDB, defineTable, dropTable, eq, generateTable, getConexion, getRed, getTipoConexion, int, money, timestamp, type valor, varchar };
+export { AND, BDconnection, CURRENT_TIMESTAMP, type Consultas, DB, DeleteR, ILIKE, MAYOR, MENOR, NOTNULL, NOW, NULL, OR, ORQ, QueryBuilder, Select, type TableProxy, type Tipos, UP, Update, type Valores, type arrayData, type arrayDatas, bool, type connecionLocal, type connecionRed, type connectionDB, defineTable, dropTable, eq, generateTable, getConexion, getRed, getTipoConexion, int, money, neq, timestamp, type valor, varchar };