@creator.co/wapi 1.7.1-alpha4 → 1.7.2-alpha1

package/src/Database/index.ts

@@ -1,13 +1,13 @@
-import { Database } from './Database'
-import { DatabaseManager } from './DatabaseManager'
-import { DatabaseTransaction } from './DatabaseTransaction'
-import { KnexDatabase } from './integrations/knex/KnexDatabase'
-import { KnexTransaction } from './integrations/knex/KnexTransaction'
-import { KyselyDatabase } from './integrations/kysely/KyselyDatabase'
-import { KyselyTransaction } from './integrations/kysely/KyselyTransaction'
-import { PostgresDatabase } from './integrations/pgsql/PostgresDatabase'
-import { PostgresTransaction } from './integrations/pgsql/PostgresTransaction'
-import { DbConfig } from './types'
+import { Database } from './Database.js'
+import { DatabaseManager } from './DatabaseManager.js'
+import { DatabaseTransaction } from './DatabaseTransaction.js'
+import { KnexDatabase } from './integrations/knex/KnexDatabase.js'
+import { KnexTransaction } from './integrations/knex/KnexTransaction.js'
+import { KyselyDatabase } from './integrations/kysely/KyselyDatabase.js'
+import { KyselyTransaction } from './integrations/kysely/KyselyTransaction.js'
+import { PostgresDatabase } from './integrations/pgsql/PostgresDatabase.js'
+import { PostgresTransaction } from './integrations/pgsql/PostgresTransaction.js'
+import { DbConfig } from './types.js'
 
 export {
   // Abstracts

package/src/Database/integrations/knex/KnexDatabase.ts

@@ -1,9 +1,9 @@
 import knex, { Knex } from 'knex'
 import knexStringcase from 'knex-stringcase'
 
-import { KnexTransaction, KnexTransactionImpl } from './KnexTransaction'
-import { Database } from '../../Database'
-import type { DbConfig } from '../../types'
+import { KnexTransaction, KnexTransactionImpl } from './KnexTransaction.js'
+import { Database } from '../../Database.js'
+import type { DbConfig } from '../../types.js'
 
 /**
  * Represents a KnexDatabase class that extends Database and provides methods for interacting with a Knex database.

package/src/Database/integrations/knex/KnexTransaction.ts

@@ -1,8 +1,8 @@
 import { Knex } from 'knex'
 
-import { KnexDatabase } from './KnexDatabase'
-import { Database } from '../../Database'
-import { DatabaseTransaction } from '../../DatabaseTransaction'
+import { KnexDatabase } from './KnexDatabase.js'
+import { Database } from '../../Database.js'
+import { DatabaseTransaction } from '../../DatabaseTransaction.js'
 
 /**
  * Represents a Knex transaction, combining the functionality of KnexTransactionImpl

package/src/Database/integrations/kysely/KyselyDatabase.ts

@@ -1,9 +1,9 @@
 import { CamelCasePlugin, Kysely, PostgresDialect } from 'kysely'
 import * as pg from 'pg'
 
-import { KyselyTransaction, KyselyTransactionImpl } from './KyselyTransaction'
-import { Database } from '../../Database'
-import type { DbBaseConfig, DbConfig } from '../../types'
+import { KyselyTransaction, KyselyTransactionImpl } from './KyselyTransaction.js'
+import { Database } from '../../Database.js'
+import type { DbBaseConfig, DbConfig } from '../../types.js'
 
 /**
  * Represents a database connection using the Kysely library with support for transactions.

package/src/Database/integrations/kysely/KyselyTransaction.ts

@@ -1,8 +1,8 @@
 import { Kysely, Transaction } from 'kysely'
 
-import { KyselyDatabase } from './KyselyDatabase'
-import { Database } from '../../Database'
-import { DatabaseTransaction } from '../../DatabaseTransaction'
+import { KyselyDatabase } from './KyselyDatabase.js'
+import { Database } from '../../Database.js'
+import { DatabaseTransaction } from '../../DatabaseTransaction.js'
 
 /**
  * Represents a transaction for querying a database with a specific schema.

package/src/Database/integrations/pgsql/PostgresDatabase.ts

@@ -1,8 +1,8 @@
 import * as pg from 'pg'
 
-import { PostgresTransaction, PostgresTransactionImpl } from './PostgresTransaction'
-import { Database } from '../../Database'
-import type { DbBaseConfig, DbConfig } from '../../types'
+import { PostgresTransaction, PostgresTransactionImpl } from './PostgresTransaction.js'
+import { Database } from '../../Database.js'
+import type { DbBaseConfig, DbConfig } from '../../types.js'
 
 /**
  * Represents a Postgres database connection that extends the Database class.

package/src/Database/integrations/pgsql/PostgresTransaction.ts

@@ -1,8 +1,8 @@
 import * as pg from 'pg'
 
-import { PostgresDatabase } from './PostgresDatabase'
-import { Database } from '../../Database'
-import { DatabaseTransaction } from '../../DatabaseTransaction'
+import { PostgresDatabase } from './PostgresDatabase.js'
+import { Database } from '../../Database.js'
+import { DatabaseTransaction } from '../../DatabaseTransaction.js'
 
 /**
  * A type alias representing a Postgres transaction. It extends the `PostgresTransactionImpl`

package/src/Database/types.ts

@@ -1,8 +1,8 @@
-import { Database } from './Database'
-import { DATABASES } from './DatabaseManager'
-import { KnexDatabase } from './integrations/knex/KnexDatabase'
-import { KyselyDatabase } from './integrations/kysely/KyselyDatabase'
-import { PostgresDatabase } from './integrations/pgsql/PostgresDatabase'
+import { Database } from './Database.js'
+import { DATABASES } from './DatabaseManager.js'
+import { KnexDatabase } from './integrations/knex/KnexDatabase.js'
+import { KyselyDatabase } from './integrations/kysely/KyselyDatabase.js'
+import { PostgresDatabase } from './integrations/pgsql/PostgresDatabase.js'
 
 /**
  * Represents the possible types of databases available in the system.

package/src/Globals.ts

@@ -1,6 +1,6 @@
 import dotenv from 'dotenv'
 
-import Utils from './Util/Utils'
+import Utils from './Util/Utils.js'
 
 // important for dev env to load .env file
 dotenv.config()

package/src/Logger/Logger.ts

@@ -2,7 +2,7 @@ import abind from 'abind'
 import stringify from 'json-stringify-safe'
 import stackTrace from 'stack-trace'
 
-import Utils from '../Util/Utils'
+import Utils from '../Util/Utils.js'
 
 /**
  * Enumeration of log levels.

package/src/Server/RouteResolver.ts

@@ -1,5 +1,5 @@
-import { AnyRoute, RouterConfig } from './Router'
-import { HttpMethod } from '../API/Request'
+import { AnyRoute, RouterConfig } from './Router.js'
+import { HttpMethod } from '../API/Request.js'
 
 /**
  * Represents a collection of routes that can be added and resolved.

package/src/Server/Router.ts

@@ -3,16 +3,16 @@ import { Server as HTTPServer } from 'http'
 import express from 'express'
 import { z } from 'zod'
 
-import ContainerServer from './lib/ContainerServer'
-import Server from './lib/Server'
-import { HttpMethod } from '../API/Request'
-import { ResponseErrorType } from '../API/Response'
+import ContainerServer from './lib/ContainerServer.js'
+import Server from './lib/Server.js'
+import { HttpMethod } from '../API/Request.js'
+import { ResponseErrorType } from '../API/Response.js'
 import Transaction, {
   TransactionConfig,
   TransactionExecution,
   StringMap,
-} from '../BaseEvent/Transaction'
-import Utils from '../Util/Utils'
+} from '../BaseEvent/Transaction.js'
+import Utils from '../Util/Utils.js'
 
 /**
  * Represents a route in an API.

package/src/Server/lib/ContainerServer.ts

@@ -1,6 +1,6 @@
-import Proxy from './container/Proxy'
-import Server from './Server'
-import { RouterConfig } from '../Router'
+import Proxy from './container/Proxy.js'
+import Server from './Server.js'
+import { RouterConfig } from '../Router.js'
 
 /**
  * Represents a server container that extends the Server class and handles serverless events.

package/src/Server/lib/Server.ts

@@ -1,12 +1,12 @@
 import { APIGatewayProxyEvent, Context } from 'aws-lambda'
 import { pathToRegexp } from 'path-to-regexp'
 
-import Request from '../../API/Request'
-import Response, { ResponseErrorType } from '../../API/Response'
-import Transaction, { StringMap } from '../../BaseEvent/Transaction'
-import Validator from '../../Validation/Validator'
-import { RouterConfig } from '../Router'
-import RouteResolver from '../RouteResolver'
+import Request from '../../API/Request.js'
+import Response, { ResponseErrorType } from '../../API/Response.js'
+import Transaction, { StringMap } from '../../BaseEvent/Transaction.js'
+import Validator from '../../Validation/Validator.js'
+import { RouterConfig } from '../Router.js'
+import RouteResolver from '../RouteResolver.js'
 
 /**
  * Represents a server that handles serverless events and routes them to appropriate handlers.

package/src/Server/lib/container/GenericHandler.ts

@@ -1,9 +1,9 @@
 import { Request, Response } from 'express'
 
-import GenericHandlerEvent, { GenericHandlerEventResponse } from './GenericHandlerEvent'
-import Globals from '../../../Globals'
-import Utils from '../../../Util/Utils'
-import Server from '../Server'
+import GenericHandlerEvent, { GenericHandlerEventResponse } from './GenericHandlerEvent.js'
+import Globals from '../../../Globals.js'
+import Utils from '../../../Util/Utils.js'
+import Server from '../Server.js'
 
 /**
  * Creates an async function that handles serverless events and sends a response.

package/src/Server/lib/container/GenericHandlerEvent.ts

@@ -2,9 +2,9 @@ import type { APIGatewayProxyEvent, Context } from 'aws-lambda'
 import cuid from 'cuid'
 import { Request } from 'express'
 
-import { parseMultiValueQueryStringParameters, parseQueryStringParameters } from './Utils'
-import Globals from '../../../Globals'
-import Server from '../Server'
+import { parseMultiValueQueryStringParameters, parseQueryStringParameters } from './Utils.js'
+import Globals from '../../../Globals.js'
+import Server from '../Server.js'
 
 /**
  * Represents the response object returned by a generic event handler.

package/src/Server/lib/container/Proxy.ts

@@ -4,12 +4,12 @@ import { Server as HTTPServer, createServer } from 'http'
 import cors from 'cors'
 import express from 'express'
 
-import Server from './../Server'
-import GenericHandler from './GenericHandler'
-import HealthHandler from './HealthHandler'
-import Globals from '../../../Globals'
-import Utils from '../../../Util/Utils'
-import { RouterConfig } from '../../Router'
+import Server from './../Server.js'
+import GenericHandler from './GenericHandler.js'
+import HealthHandler from './HealthHandler.js'
+import Globals from '../../../Globals.js'
+import Utils from '../../../Util/Utils.js'
+import { RouterConfig } from '../../Router.js'
 
 /* Get package.json version from Wapi on ESM */
 const { version: appVersion } = JSON.parse(fs.readFileSync('package.json').toString())

package/src/Validation/Validator.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod'
 
-import Response, { ResponseErrorType } from '../API/Response'
-import Globals from '../Globals'
+import Response, { ResponseErrorType } from '../API/Response.js'
+import Globals from '../Globals.js'
 
 /**
  * Validates the given data against the provided schema.

package/tests/API/Request.test.ts

@@ -0,0 +1,273 @@
+import { APIGatewayEvent, Context } from 'aws-lambda'
+import { expect } from 'chai'
+
+import Request, { HttpMethod } from '../../src/API/Request.js'
+import Logger from '../../src/Logger/Logger.js'
+
+function newReq(event: any, context?: any) {
+  const logger = new Logger(
+    {
+      logLevel: 'DEBUG',
+    },
+    '123-456'
+  )
+  return new Request<any, any, any>(
+    <APIGatewayEvent>(<unknown>event),
+    <Context>context ? context : {},
+    logger
+  )
+}
+
+describe('Request querystring', () => {
+  test('Null query string', () => {
+    const r = newReq({
+      queryStringParameters: null,
+    })
+    expect(r.containsQueryParam('123')).to.be.false
+    expect(r.getQueryParam('123')).to.be.null
+  })
+
+  test('Empty query string', () => {
+    const r = newReq({
+      queryStringParameters: {},
+    })
+    expect(r.containsQueryParam('123')).to.be.false
+    expect(r.getQueryParam('123')).to.be.null
+  })
+
+  test('Valid query string', () => {
+    const v = { '123': 'abc' }
+    const r = newReq({
+      queryStringParameters: v,
+    })
+    expect(r.containsQueryParam('123')).to.be.true
+    expect(r.getQueryParam('123')).to.be.equals('abc')
+    expect(r.getQueryParams()).to.be.deep.equal(v)
+  })
+
+  test('Valid query string number', () => {
+    const r = newReq({
+      queryStringParameters: { '123': 456 },
+    })
+    expect(r.containsQueryParam('123')).to.be.true
+    expect(r.getQueryParam('123')).to.be.equals(456)
+  })
+})
+
+describe('Request headers', () => {
+  test('Null headers', () => {
+    const r = newReq({ headers: null })
+    expect(r.getHeader('123')).to.be.null
+  })
+
+  test('Empty headers', () => {
+    const r = newReq({ headers: {} })
+    expect(r.getHeader('123')).to.be.null
+  })
+
+  test('Valid headers', () => {
+    const r = newReq({ headers: { '123': 'abc' } })
+    expect(r.getHeader('123')).to.be.equals('abc')
+  })
+
+  test('Auth headers', () => {
+    const r = newReq({ headers: { Authorization: 'abc' } })
+    expect(r.getAuthorizationHeader()).to.be.equals('abc')
+  })
+})
+
+describe('Request context', () => {
+  test('Null context', () => {
+    const r = newReq({ requestContext: null })
+    expect(r.getContextParam('123')).to.be.null
+  })
+
+  test('Empty context', () => {
+    const r = newReq({ requestContext: {} })
+    expect(r.getContextParam('123')).to.be.null
+  })
+
+  test('Valid context', () => {
+    const r = newReq({
+      requestContext: { '123': 'abc' },
+    })
+    expect(r.getContextParam('123')).to.be.equals('abc')
+  })
+})
+
+describe('Request path params', () => {
+  test('Null path params', () => {
+    const r = newReq({ pathParameters: null })
+    expect(r.containsPathParam('123')).to.be.false
+    expect(r.getPathParam('123')).to.be.null
+    expect(r.getPathParams()).to.be.null
+  })
+
+  test('Empty path params', () => {
+    const r = newReq({ pathParameters: {} })
+    expect(r.containsPathParam('123')).to.be.false
+    expect(r.getPathParam('123')).to.be.null
+    expect(r.getPathParams()).to.be.deep.equal({})
+  })
+
+  test('Valid path params', () => {
+    const v = { '123': 'abc' }
+    const r = newReq({
+      pathParameters: v,
+    })
+    expect(r.containsPathParam('123')).to.be.true
+    expect(r.getPathParam('123')).to.be.equals('abc')
+    expect(r.getPathParams()).to.be.deep.equal(v)
+  })
+
+  test('Valid path param number', () => {
+    const v = { '123': 456 }
+    const r = newReq({
+      pathParameters: v,
+    })
+    expect(r.containsPathParam('123')).to.be.true
+    expect(r.getPathParam('123')).to.be.equals(456)
+    expect(r.getPathParams()).to.be.deep.equal(v)
+  })
+
+  test('Fix path params', () => {
+    const v = { '123': 'abc' }
+    const r = newReq({ pathParameters: null })
+    r.setFixedPathParams(
+      Object.keys(v).map(k => ({ name: k })),
+      ['/'].concat(Object.values(v))
+    )
+    expect(r.containsPathParam('123')).to.be.true
+    expect(r.getPathParam('123')).to.be.equals('abc')
+    expect(r.getPathParams()).to.be.deep.equal(v)
+  })
+})
+
+describe('Request body', () => {
+  test('Null body', () => {
+    const r = newReq({ body: null })
+    expect(r.getBody()).to.be.null
+  })
+
+  test('Empty body', () => {
+    const r = newReq({ body: {} })
+    expect(r.getBody()).to.be.deep.equals({})
+  })
+
+  test('Empty string body', () => {
+    const r = newReq({ body: '{}' })
+    expect(r.getBody()).to.be.deep.equals({})
+  })
+
+  test('Broken json string body', () => {
+    const r = newReq({ body: '{name": "Joe"}' })
+    expect(r.getBody()).to.be.equals('{name": "Joe"}')
+  })
+
+  test('Valid string body', () => {
+    const r = newReq({ body: '{"name": "Joe"}' })
+    expect(r.getBody()).to.be.deep.equals({
+      name: 'Joe',
+    })
+  })
+
+  test('Valid json body', () => {
+    const r = newReq({ body: { name: 'Joe' } })
+    expect(r.getBody()).to.be.deep.equals({
+      name: 'Joe',
+    })
+  })
+})
+
+describe('Request path/method', () => {
+  test('Null path/method', () => {
+    const r = newReq({
+      path: null,
+      httpMethod: null,
+    })
+    expect(r.getPath()).to.be.null
+    expect(r.getMethod.bind(r)).to.throw('Invalid HTTP method: null')
+  })
+
+  test('Empty path/method', () => {
+    const r = newReq({
+      path: '',
+      httpMethod: '',
+    })
+    expect(r.getPath()).to.be.a('string')
+    expect(r.getPath()).to.be.equals('')
+    expect(r.getMethod.bind(r)).to.throw('Invalid HTTP method: ')
+  })
+
+  test('Valid method/path', () => {
+    const r = newReq({
+      path: '/root',
+      httpMethod: HttpMethod.GET,
+    })
+    expect(r.getPath()).to.be.a('string')
+    expect(r.getPath()).to.be.equals('/root')
+    expect(r.getMethod()).to.be.a('string')
+    expect(r.getMethod()).to.be.equals(HttpMethod.GET)
+  })
+
+  test('Case insensitive method', () => {
+    const r = newReq({
+      path: '/root',
+      httpMethod: 'poST',
+    })
+
+    expect(r.getMethod()).to.be.equals(HttpMethod.POST)
+  })
+})
+
+describe('Request ID', () => {
+  test('From context', () => {
+    const r = newReq({}, { awsRequestId: '123' })
+    expect(r.getRequestID()).to.not.be.null
+    expect(r.getRequestID()).to.be.equals('123')
+  })
+
+  test('From event', () => {
+    const r = newReq({
+      requestContext: { requestId: '123' },
+    })
+    expect(r.getRequestID()).to.not.be.null
+    expect(r.getRequestID()).to.be.equals('123')
+  })
+
+  test('unknown', () => {
+    const r = newReq({})
+    expect(r.getRequestID()).to.not.be.null
+    expect(r.getRequestID()).to.be.equals('unknown')
+  })
+})
+
+describe('Request origin IP', () => {
+  test('From context', () => {
+    const r = newReq({
+      requestContext: {
+        identity: { sourceIp: '127.0.0.1' },
+      },
+    })
+    expect(r.getOriginIP()).to.not.be.null
+    expect(r.getOriginIP()).to.be.equals('127.0.0.1')
+  })
+
+  test('From header', () => {
+    const r = newReq({
+      headers: {
+        'X-Forwarded-For': '127.0.0.1',
+      },
+    })
+    expect(r.getOriginIP()).to.not.be.null
+    expect(r.getOriginIP()).to.be.equals('127.0.0.1')
+  })
+
+  test('unknown', () => {
+    const r = newReq({})
+    expect(r.getOriginIP()).to.not.be.null
+    expect(r.getOriginIP()).to.be.equals('unknown')
+  })
+})
+
+export {}