@platformatic/sql-mapper 0.27.0 → 0.28.1

package/mapper.d.ts

@@ -1,4 +1,5 @@
 import { FastifyPluginAsync, FastifyInstance, FastifyReply, FastifyRequest } from 'fastify'
+import type { PlatformaticApp } from '@platformatic/types'
 import { SQL, SQLQuery } from '@databases/sql'
 
 interface ILogger {
@@ -306,16 +307,35 @@ 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
   }
@@ -337,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.27.0",
+  "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"
@@ -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"