zormz 1.2.3 → 1.2.4

package/README.md

@@ -1,7 +1,7 @@
 # ZORMZ
 
-Un ORM ligero escrito en TypeScript para MySQL y PostgreSQL, diseñado para ser simple, rápido y extensible.
-por ahora solo es posible conectarse a una base de datos.
+Un ORM ligero escrito en TypeScript para **MySQL** y **PostgreSQL**, diseñado para ser simple, rápido y extensible.  
+Permite conectarse a una base de datos, definir tablas desde TypeScript con autocompletado y tipado, y generar tablas automáticamente.
 
 ---
 
@@ -11,7 +11,11 @@ por ahora solo es posible conectarse a una base de datos.
 * Tipado completo en **TypeScript**
 * Builder con sintaxis encadenada: `select().from().where().execute()`
 * Insert múltiple con arrays
-* Soporte para MySQL y PostgreSQL
+* 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
 
@@ -21,207 +25,177 @@ por ahora solo es posible conectarse a una base de datos.
 
 ```bash
 npm install zormz
-```
-
----
-
-## Uso básico
 
-### Importación (ESM)
+```
 
+## Uso basico
+### importacion ESM
 ```ts
-import { connecionLocal, getConexion } from "zormz";
-```
 
-### Importación (CommonJS)
+import { connecionLocal, getConexion, defineTable, generateTable, int, varchar, DB, eq, ORQ } from "zormz";
 
-```js
-const { connecionLocal, getConexion } = require("zormz");
 ```
+### importacion COMMONJS
 
----
-
+```ts
+const { connecionLocal, getConexion, defineTable, generateTable, int, varchar, DB, eq, ORQ } = require("zormz");
 
-## Conexión a la base de datos
-### mysql local
+```
+## Conexion a la base de datos
+### MYSQL
 ```ts
-import { connecionLocal, DB, getConexion } from "zormz";
-//de preferencia esto en el archivo raiz index.ts
-const conexion: connecionLocal = {
-  database: "pruebamaster",
-  user: "root",
+const conexionMysql: connecionLocal = {
+  database: "pruebas",
+  host: "localhost",
   password: "",
   port: 3306,
-  host: "localhost",
+  user: "root",
 };
 
-getConexion("mysql", conexion);
-```
-
----
+getConexion("mysql", conexionMysql);
 
-### pg en linea
+```
 
+### PG
 ```ts
-const conexionPg:connecionRed = {
-  connectionString:"ruta de la conexion"
+//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"
 }
-getConexion("pg",conexionPg);
-```
----
-
-
-##  Métodos disponibles
-
-### **Select**
-### **Insert**
-### **Update**
-### **Delete**
 
+const conexion: connecionLocal = {
+  database: "pruebamaster",
+  host: "localhost",
+  password: "zainmaster123",
+  port: 5432,
+  user: "postgres",
+};
 
----
+getConexion("pg", conexion);
 
-## Creación de tablas para autocompletado y SQL
+```
 
-Por ahora, la creación de tablas en **ZORMZ** no es avanzada. Sin embargo, ya permite **definir la estructura de la base de datos desde TypeScript o js**, lo que habilita:
+## Definicion de Tablas 
 
-* Autocompletado en el editor
-* Tipado básico de columnas
+```ts
+export const prueba1 = defineTable("prueba1", {
+  id: int().Pk().$(),
+  valor: varchar(200).Default("hola").$(),
+  resultado: int().Default(0).$(),
+  fechaRegistro: timestamp().required().now().$(),
+  fechaUpdate: timestamp().required().now().onUpdate().$()
 
-Esto es útil si ya tienes la base de datos creada o si quieres preparar el schema antes de automatizarlo.
+});
 
+```
 
-### Ejemplo de definición de tabla
+### 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*
 
+## Generacion de tablas
 ```ts
-export const datosPrueba = defineTable("datosPrueba", {
-  id: { typo: "int", id: true },
-
-  nombre: {
-    typo: "varchar",
-    maxLength: 200,
-    default: "hola"
-  },
-
-  data: {
-    typo: "varchar",
-    default: "none magic"
-  },
-
-  edad: {
-    typo: "int",
-    default:19
-  }
-});
+generateTable(prueba1(), prueba1.$columns);
 ```
-
-### Notas
-
-* `defineTable` registra el nombre de la tabla y sus columnas
-* Cada propiedad representa una columna
-* El objetivo actual es **autocompletado y estructura**, no migraciones complejas
-* El sistema está en evolución 😢
+Esto crea la tabla en la base de datos respetando tipos, claves primarias y valores por defecto.
 
 ---
-## Creacion de tabla desde ZORMZ
-Para la creacion de la tabla se necesita que la tabla este definido 
-* $columns : es un parametro que por defecto se obtiene al definir la tabla, este reserva gran parte de los datos.
+
+## Insertar Datos
 
 ```ts
-import { master } from "./archivos/prueba";
-generateTable(master(), master.$columns);
+await DB.Insert(prueba1(), [prueba1.valor, prueba1.resultado])
+  .Values([["hola mundo", 1], ["prueba", 0]])
+  .execute();
 
 ```
+---
 
-##  Ejemplo: Insertar datos
+## Select de Datos
 
 ```ts
-const response = await DB.Insert(datosPrueba(),
-  [datosPrueba.nombre, datosPrueba.data]).Values(['yunno','magic wind']).execute();
-```
+const datos = await DB.select()
+  .from(prueba1())
+  .where(eq(prueba1.id, 1))
+  .execute();
 
-Resultado esperado:
-
-```sql
-INSERT INTO datosPrueba (nombre, data) VALUES (?, ?);
 ```
-
 ---
 
-## Ejemplo: Select
-
+## Update de Datos
 ```ts
-let datos = await DB.select().from(datosPrueba()).where(eq(datosPrueba.id,2)).execute();
-console.log(datos);
+await DB.Update(prueba1())
+  .set({ valor: "nuevo valor", resultado: 2 })
+  .where(eq(prueba1.id, 1))
+  .execute();
+
 ```
 ---
-
-##  Ejemplo: Insert
-
+## Delete de Datos
 ```ts
-const response = await DB.Insert(productosPrueba(),
-  [productosPrueba.nombre,productosPrueba.descripcion]).Values(['yunno','magic wind']).execute();
+await DB.Delete(prueba1())
+  .where(ORQ(prueba1.id, 2, 3))
+  .execute();
+
 ```
+
 ---
 
-##  Ejemplo completo
+## Ejemplo de Uso 
 
 ```ts
-import { connecionLocal, DB, eq, getConexion, ORQ } from "zormz";
+import { connecionLocal, getConexion, defineTable, generateTable, int, varchar, DB, eq, ORQ } from "zormz";
 
 const conexion: connecionLocal = {
   database: "pruebamaster",
-  user: "root",
-  password: "",
-  port: 3306,
   host: "localhost",
+  password: "pgZORMZ",
+  port: 5432,
+  user: "postgres",
 };
 
-getConexion("mysql", conexion);
+getConexion("pg", conexion);
 
-async function pruebaData() {
-  let datos = await DB.select().from("datosPrueba").execute();
-  console.log(datos);
+const prueba1 = defineTable("prueba1", {
+  id: int().Pk().$(),
+  valor: varchar(200).Default("hola").$(),
+  resultado: int().Default(0).$()
+});
 
-  let response = await DB.Insert("datosPrueba", ["nombre", "data"])
-    .Values([
-      ["yunno", "magic wind"],
-      ["astta", "no magic"],
-    ])
+generateTable(prueba1(), prueba1.$columns);
+
+async function pruebaData() {
+  await DB.Insert(prueba1(), [prueba1.valor, prueba1.resultado])
+    .Values([["hola mundo", 1], ["prueba", 0]])
     .execute();
-  console.log(response);
 
-  let update = await DB.Update("datosPrueba")
-    .set({ nombre: "yukio", data: "es un juego ?" })
-    .where(eq("id", 1))
+  const datos = await DB.select().from(prueba1()).execute();
+  console.log(datos);
+
+  await DB.Update(prueba1())
+    .set({ valor: "actualizado", resultado: 2 })
+    .where(eq(prueba1.id, 1))
     .execute();
-  console.log(update);
 
-  let eliminados = await DB.Delete("datosPrueba")
-    .where(ORQ("id", 3, 4, 5, 6))
+  await DB.Delete(prueba1())
+    .where(ORQ(prueba1.id, 2, 3))
     .execute();
-  console.log(eliminados);
 }
 
-pruebaData().catch((e) => {
-  console.log("error al cargar los datos");
-});
+pruebaData().catch(console.error);
 
 ```
 
 ---
 
-## 📝 Notas
-
-* Este ORM está en versión inicial.
-* Puedes extenderlo o contribuir con nuevas funciones.
-
----
-
-
+## Notas
+* ORM en version inicial con enfoque de tipado y autompletado 
+* Compatible con **MYSQL** y **PG**
+* Preparado para extenderse
 
-## 📄 Licencia
+## Licencia
 
 ISC © Yukio-kayaba
 
-[![GitHub](https://img.shields.io/badge/GitHub-Follow%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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "zormz",
-    "version": "1.2.3",
+    "version": "1.2.4",
     "description": "",
     "author": "",
     "license": "ISC",
@@ -13,7 +13,6 @@
             "require": "./dist/index.cjs"
         }
     },
-    "type": "module",
     "files": [
         "dist",
         "README.md"