@platformatic/sql-mapper 0.26.1 → 0.28.1

package/mapper.d.ts

@@ -1,4 +1,5 @@
-import { FastifyPluginAsync } from 'fastify'
+import { FastifyPluginAsync, FastifyInstance, FastifyReply, FastifyRequest } from 'fastify'
+import type { PlatformaticApp } from '@platformatic/types'
 import { SQL, SQLQuery } from '@databases/sql'
 
 interface ILogger {
@@ -306,9 +307,37 @@ export interface SQLMapperPluginInterface {
   addEntityHooks(entityName: string, hooks: EntityHooks): any
 }
 
+// Extend the PlatformaticApp interface,
+// Unfortunately we neeed to copy over all the types from SQLMapperPluginInterface
+declare module '@platformatic/types' {
+  interface PlatformaticApp {
+    /**
+     * A Database abstraction layer from [@Databases](https://www.atdatabases.org/)
+     */
+    db: Database,
+    /**
+     * The SQL builder from [@Databases](https://www.atdatabases.org/)
+     */
+    sql: SQL,
+    /**
+     * An object containing a key for each table found in the schema, with basic CRUD operations. See [entity.md](./entity.md) for details.
+     */
+    entities: Entities,
+    /**
+     * Adds hooks to the entity.
+     */
+    addEntityHooks(entityName: string, hooks: EntityHooks): any
+  }
+}
+
+export interface PlatformaticContext {
+  app: FastifyInstance,
+  reply: FastifyReply
+}
+
 declare module 'fastify' {
-  interface FastifyInstance {
-    platformatic: SQLMapperPluginInterface
+  interface FastifyRequest {
+    platformaticContext: PlatformaticContext
   }
 }
 
@@ -328,3 +357,4 @@ export default plugin
 export module utils {
   export function toSingular(str: string): string
 }
+

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@platformatic/sql-mapper",
-  "version": "0.26.1",
+  "version": "0.28.1",
   "description": "A data mapper utility for SQL databases",
   "main": "mapper.js",
+  "types": "mapper.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
@@ -14,10 +15,10 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "fastify": "^4.17.0",
+    "fastify": "^4.18.0",
     "snazzy": "^9.0.0",
-    "standard": "^17.0.0",
-    "tap": "^16.3.4",
+    "standard": "^17.1.0",
+    "tap": "^16.3.6",
     "tsd": "^0.28.1"
   },
   "dependencies": {
@@ -27,7 +28,8 @@
     "@databases/sqlite": "^4.0.2",
     "camelcase": "^6.3.0",
     "fastify-plugin": "^4.5.0",
-    "inflected": "^2.1.0"
+    "inflected": "^2.1.0",
+    "@platformatic/types": "0.28.1"
   },
   "tsd": {
     "directory": "test/types"

package/test/mapper.test.js

@@ -1,3 +1,4 @@
+'use strict'
 
 const { test } = require('tap')
 const { connect, plugin } = require('..')

package/test/types/mapper.test-d.ts

@@ -1,6 +1,6 @@
 import { expectType } from 'tsd'
 import { SQL, SQLQuery } from '@databases/sql'
-import { fastify, FastifyInstance } from 'fastify'
+import { fastify, FastifyInstance, FastifyReply } from 'fastify'
 import {
   connect,
   plugin,
@@ -72,6 +72,13 @@ expectType<SQLMapperPluginInterface>(await connect({
 
 const instance: FastifyInstance = fastify()
 instance.register(plugin, { connectionString: '', autoTimestamp: true })
-instance.register((instance) => { expectType<SQLMapperPluginInterface>(instance.platformatic) })
+instance.register((instance) => { 
+  expectType<SQLMapperPluginInterface>(instance.platformatic)
+  instance.get('/', async (request, reply) => {
+    const ctx = request.platformaticContext
+    expectType<FastifyInstance>(ctx.app)
+    expectType<FastifyReply>(ctx.reply)
+  })
+})
 
 expectType<(str: string) => string>(utils.toSingular)