Merge pull request #343 from open-mexico/codigos-search

Codigos search

Author: macarthuror

.env.example

@@ -7,9 +7,8 @@ PORT=3333
 HOST=localhost
 LOG_LEVEL=info
 
-DB_CONNECTION=sqlite
 DB_HOST=127.0.0.1
-DB_PORT=5432
+DB_PORT=3306
 DB_USER=root
 DB_PASSWORD=root
 DB_DATABASE=app

.github/dependabot.yml

@@ -29,4 +29,4 @@ updates:
   commit-message:
     prefix: fix
     prefix-development: chore
-    include: scope
+    include: scope

README.md

@@ -23,13 +23,13 @@
   <p align="center">
     Consulta colonias, municipios, códigos postales y coordenadas.
     <br />
-    <a href="https://pages.github.com/mexpost"><strong>Explora la documentación »</strong></a>
+    <a href="https://open-mexico.github.io/mexpost/"><strong>Explora la documentación »</strong></a>
     <br />
-    <a href="https://github.com/open-mexico/mexpost">View Demo</a>
+    <!-- <a href="https://github.com/open-mexico/mexpost">View Demo</a>
+    · -->
+    <a href="https://github.com/open-mexico/mexpost/issues/new?template=---1-report-an-issue.md">Report Bug</a>
     ·
-    <a href="https://github.com/open-mexico/mexpost/issues">Report Bug</a>
-    ·
-    <a href="https://github.com/open-mexico/mexpost/issues">Request Feature</a>
+    <a href="https://github.com/open-mexico/mexpost/issues/new?template=---2-share-an-idea.md">Request Feature</a>
   </p>
 </p>
 
@@ -42,6 +42,8 @@
     <li>
       <a href="#about-the-project">Sobre el Proyecto</a>
       <ul>
+        <li><a href="#descripción">Descripción</a></li>
+        <li><a href="#funcionalidades-principales">Funcionalidades principales</a></li>
         <li><a href="#herramientas-utilizadas">🛠️- Herramientas Utilizadas</a></li>
       </ul>
     </li>
@@ -82,9 +84,9 @@ Este proyecto de código abierto tiene como objetivo facilitar la búsqueda y co
 
 ## **Herramientas Utilizadas**
 
-* [NodeJS](https://nodejs.org/)
-* [ExpressJS](https://expressjs.com/)
+* [AdonisJS](https://adonisjs.com/)
 * [TypeScript](https://www.typescriptlang.org/)
+* [NodeJS](https://nodejs.org/)
 
 
 ---

app/controllers/postals_controller.ts

@@ -1,17 +1,26 @@
 import type { HttpContext } from '@adonisjs/core/http'
 import Postal from '#models/postal'
-import {
+
+ import {
   codigoPostalValidator,
-  codigoPostalEstadoValidator
-} from '#validators/postal'
+  codigoPostalEstadoValidator,
+  coloniaEstadoValidator
+} from '#validators/postal_validator'
 
 import { getEstadoName } from '#utils/estados'
 
 export default class PostalsController {
-  async codigo({ params, response }: HttpContext) {
+  /**
+   * Retrieves postal data based on the provided codigo.
+   * @param {HttpContext} ctx - The HTTP context object.
+   * @returns {Promise<void>} - A promise that resolves when the response is sent.
+   */
+  async codigo({ params, request, response }: HttpContext) {
     const { codigo } = await codigoPostalValidator.validate(params)
 
-    const data = await Postal.query().whereLike('codigo', `%${codigo}%`)
+    const { wc } = request.qs()
+    const busqueda = wc ? `'%${codigo}%'` : `'${codigo}%'`
+    const data = await Postal.query().whereRaw(`codigo like ${busqueda}`).preload('estado')
 
     const payload = {
       values: data.length,
@@ -21,11 +30,14 @@ export default class PostalsController {
     response.json(payload)
   }
 
-  async codigoEstado({ params, response }: HttpContext) {
+  async codigoEstado({ request, params, response }: HttpContext) {
     const { codigo, estado } = await codigoPostalEstadoValidator.validate(params)
 
     const estadoName = getEstadoName(estado)
-    const data = await Postal.query().whereLike('codigo', `%${codigo}%`).where('estado_id', estado)
+
+    const { wc } = request.qs()
+    const busqueda = wc ? `'%${codigo}%'` : `'${codigo}%'`
+    const data = await Postal.query().whereRaw(`codigo like ${busqueda}`).where('estado_id', estado).preload('estado').preload('municipio', q => q.where('estado_id', estado))
 
     const payload = {
       values: data.length,
@@ -36,9 +48,15 @@ export default class PostalsController {
     response.json(payload)
   }
 
-  async colonia({ request, response }: HttpContext) {
-    const postal = await Postal.find(1)
+  async colonia({ params, request, response }: HttpContext) {
+    const { colonia, estado } = await coloniaEstadoValidator.validate(params)
+
+    const newColonia = decodeURIComponent(colonia)
+    const page = request.input('page', 1)
+    const limit = 15
+
+    const data = await Postal.query().whereRaw(`nombre like '%${newColonia}%'`).where('estado_id', estado).preload('municipio', q => q.where('estado_id', estado)).paginate(page, limit)
 
-    response.json(postal)
+    response.json(data)
   }
 }

app/models/estado.ts

@@ -0,0 +1,10 @@
+import { DateTime } from 'luxon'
+import { BaseModel, column } from '@adonisjs/lucid/orm'
+
+export default class Estado extends BaseModel {
+  @column({ isPrimary: true })
+  declare id: number
+
+  @column()
+  declare nombre: string
+}

app/models/municipio.ts

@@ -0,0 +1,10 @@
+import { DateTime } from 'luxon'
+import { BaseModel, column } from '@adonisjs/lucid/orm'
+
+export default class Municipio extends BaseModel {
+  @column({ isPrimary: true })
+  declare id: number
+
+  @column()
+  declare nombre: string
+}

app/models/postal.ts

@@ -1,5 +1,8 @@
 import { DateTime } from 'luxon'
-import { BaseModel, column } from '@adonisjs/lucid/orm'
+import Estado from '#models/estado'
+import Municipio from '#models/municipio'
+import { BaseModel, column, belongsTo } from '@adonisjs/lucid/orm'
+import type { BelongsTo } from '@adonisjs/lucid/types/relations'
 
 export default class Postal extends BaseModel {
   static table = 'codigos_postales'
@@ -22,6 +25,15 @@ export default class Postal extends BaseModel {
   @column()
   declare zona: string
 
-  @column({ serializeAs: null})
-  declare estado_id: string
+  @column({ serializeAs: null })
+  declare estadoId: number
+
+  @column({ serializeAs: null })
+  declare municipioId: number
+
+  @belongsTo(() => Estado)
+  declare estado: BelongsTo<typeof Estado>
+
+  @belongsTo(() => Municipio)
+  declare municipio: BelongsTo<typeof Municipio>
 }

app/validators/postal.ts renamed to app/validators/postal_validator.ts

@@ -20,3 +20,10 @@ export const codigoPostalEstadoValidator = vine.compile(
 codigoPostalEstadoValidator.messagesProvider = new SimpleMessagesProvider({
   'codigo.regex': 'El código postal debe ser un número entre 3 y 5 dígitos',
 })
+
+export const coloniaEstadoValidator = vine.compile(
+  vine.object({
+    colonia: vine.string().trim().minLength(3).maxLength(64),
+    estado: vine.number().positive().withoutDecimals().min(1).max(32),
+  })
+)

config/database.ts

@@ -2,10 +2,10 @@ import env from '#start/env'
 import { defineConfig } from '@adonisjs/lucid'
 
 const dbConfig = defineConfig({
-  connection: env.get('DB_CONNECTION', 'sqlite'),
+  connection: 'mysql',
   connections: {
-    postgres: {
-      client: 'pg',
+    mysql: {
+      client: 'mysql2',
       connection: {
         host: env.get('DB_HOST'),
         port: env.get('DB_PORT'),
@@ -17,13 +17,7 @@ const dbConfig = defineConfig({
         naturalSort: true,
         paths: ['database/migrations'],
       },
-    },
-    sqlite: {
-      client: 'better-sqlite3',
-      connection: {
-        filename: env.get('DB_FILE', 'tmp/db.sqlite'),
-      },
-    } // squlite
+    }
   },
 })
 

database/migrations/1740407050839_create_postals_table.ts renamed to database/migrations/1740449596699_create_estados_table.ts

@@ -1,16 +1,15 @@
 import { BaseSchema } from '@adonisjs/lucid/schema'
 
 export default class extends BaseSchema {
-  protected tableName = 'codigos_postales'
+  protected tableName = 'estados'
 
   async up() {
     this.schema.createTable(this.tableName, (table) => {
-      table.increments('id')
+      table.charset('utf8mb4')
+      table.collate('utf8mb4_unicode_ci')
 
-      table.string('postal_code', 10).notNullable().unique()
-
-      table.timestamp('created_at')
-      table.timestamp('updated_at')
+      table.increments('id').unique().primary()
+      table.string('nombre').notNullable().index()
     })
   }