@platformatic/sql-events 0.43.1 → 0.45.0

package/errors.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const createError = require('@fastify/error')
+
+const ERROR_PREFIX = 'PLT_SQL_EVENTS'
+
+module.exports = {
+  ObjectRequiredUnderTheDataProperty: createError(`${ERROR_PREFIX}_OBJECT_IS_REQUIRED_UNDER_THE_DATA_PROPERTY`, 'The object that will be published is required under the data property'),
+  PrimaryKeyIsNecessaryInsideData: createError(`${ERROR_PREFIX}_PRIMARY_KEY_IS_NECESSARY_INSIDE_DATA`, 'The primaryKey is necessary inside data'),
+  NoSuchActionError: createError(`${ERROR_PREFIX}_NO_SUCH_ACTION`, 'No such action %s')
+
+}

package/index.d.ts

@@ -1,16 +1,14 @@
-/// <reference types="@platformatic/types" />
-import { FastifyPluginAsync } from 'fastify'
+import { FastifyInstance } from 'fastify'
 import { Readable } from 'stream'
-import { SQLMapperPluginInterface } from '@platformatic/sql-mapper'
+import { SQLMapperPluginInterface, Entities } from '@platformatic/sql-mapper'
+import { FastifyError } from '@fastify/error'
 
-declare module '@platformatic/types' {
-  interface PlatformaticApp {
-    subscribe: (topic: string | string[]) => Promise<Readable>
-  }
+export interface SQLEventsPluginInterface {
+  subscribe: (topic: string | string[]) => Promise<Readable>
 }
 
-export interface SQLEventsPluginOptions {
-  mapper: SQLMapperPluginInterface
+export interface SQLEventsPluginOptions<T extends Entities> {
+  mapper: SQLMapperPluginInterface<T>
 
   // TODO mqemitter has no types
   mq?: any
@@ -20,8 +18,15 @@ export interface SQLEventsPluginOptions {
 /**
  * Fastify plugin that add events capabilities to registered sql-mapper 
  */
-declare const plugin: FastifyPluginAsync<SQLEventsPluginOptions>
+export default function plugin<T extends Entities>(app: FastifyInstance, options: SQLEventsPluginOptions<T>): Promise<SQLEventsPluginInterface>
 
-export default plugin
+export function setupEmitter<T extends Entities>(options: SQLEventsPluginOptions<T>): void
 
-export function setupEmitter(options: SQLEventsPluginOptions): void
+/**
+ * All the errors thrown by the plugin.
+ */
+export module errors {
+  export const ObjectRequiredUnderTheDataProperty: () => FastifyError
+  export const PrimaryKeyIsNecessaryInsideData: () => FastifyError
+  export const NoSuchActionError: (actions: string) => FastifyError
+}

package/index.js

@@ -6,6 +6,7 @@ const camelcase = require('camelcase')
 const { PassThrough } = require('stream')
 const MQEmitterRedis = require('mqemitter-redis')
 const { promisify } = require('util')
+const errors = require('./errors')
 
 async function fastifySqlEvents (app, opts) {
   setupEmitter({ ...opts, mapper: app.platformatic, log: app.log })
@@ -83,11 +84,11 @@ function setupEmitter ({ log, mq, mapper, connectionString }) {
     // getPublishTopic is async because it could be overridden to be asynchronous
     entity.getPublishTopic = async function ({ action, data }) {
       if (!data) {
-        throw new Error('The object that will be published is required under the data property')
+        throw new errors.ObjectRequiredUnderTheDataProperty()
       }
 
       if (!data[primaryKey]) {
-        throw new Error('The primaryKey is necessary inside data')
+        throw new errors.PrimaryKeyIsNecessaryInsideData()
       }
 
       switch (action) {
@@ -108,7 +109,7 @@ function setupEmitter ({ log, mq, mapper, connectionString }) {
         case 'delete':
           return `/entity/${entityName}/delete/+`
         default:
-          throw new Error(`no such action ${action}`)
+          throw new errors.NoSuchActionError(action)
       }
     }
   }
@@ -135,3 +136,4 @@ function noop () {}
 
 module.exports = fp(fastifySqlEvents)
 module.exports.setupEmitter = setupEmitter
+module.exports.errors = errors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-events",
-  "version": "0.43.1",
+  "version": "0.45.0",
   "description": "Emit events via MQEmitter",
   "main": "index.js",
   "repository": {
@@ -20,14 +20,14 @@
     "standard": "^17.1.0",
     "tap": "^16.3.6",
     "tsd": "^0.29.0",
-    "@platformatic/sql-mapper": "0.43.1"
+    "@platformatic/sql-mapper": "0.45.0"
   },
   "dependencies": {
+    "@fastify/error": "^3.2.1",
     "camelcase": "^6.3.0",
     "fastify-plugin": "^4.5.0",
     "mqemitter": "^5.0.0",
-    "mqemitter-redis": "^5.0.0",
-    "@platformatic/types": "0.43.1"
+    "mqemitter-redis": "^5.0.0"
   },
   "tsd": {
     "directory": "test/types"

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

@@ -1,8 +1,16 @@
 import { expectType } from 'tsd'
 import { fastify, FastifyInstance } from 'fastify'
-import plugin, { setupEmitter } from '../../index'
+import plugin, { setupEmitter, errors } from '../../index'
 import { Readable } from 'stream'
-import {SQLMapperPluginInterface} from '@platformatic/sql-mapper'
+import { SQLMapperPluginInterface, Entities } from '@platformatic/sql-mapper'
+import { SQLEventsPluginInterface } from '../../index'
+import { FastifyError } from '@fastify/error'
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: SQLMapperPluginInterface<Entities> & SQLEventsPluginInterface
+  }
+}
 
 const instance: FastifyInstance = fastify()
 instance.register(plugin)
@@ -12,6 +20,14 @@ instance.register(async (instance) => {
   expectType<Promise<Readable>>(instance.platformatic.subscribe(['/test']))
 })
 
-setupEmitter({ mapper: {} as SQLMapperPluginInterface })
-setupEmitter({ mapper: {} as SQLMapperPluginInterface, connectionString: 'redis://localhost:6379' })
-setupEmitter({ mapper: {} as SQLMapperPluginInterface, mq: {} })
+setupEmitter({ mapper: {} as SQLMapperPluginInterface<Entities> })
+setupEmitter({ mapper: {} as SQLMapperPluginInterface<Entities>, connectionString: 'redis://localhost:6379' })
+setupEmitter({ mapper: {} as SQLMapperPluginInterface<Entities>, mq: {} })
+
+// Errors
+type ErrorWithNoParams = () => FastifyError
+type ErrorWithOneParam = (param: string) => FastifyError
+
+expectType<ErrorWithOneParam>(errors.NoSuchActionError)
+expectType<ErrorWithNoParams>(errors.ObjectRequiredUnderTheDataProperty)
+expectType<ErrorWithNoParams>(errors.PrimaryKeyIsNecessaryInsideData)