feat: add intercept api to make it easier to call into hooks

The new intercept function allows you to call into a specific hook without needing to write a
plugin.

closes #50

package.json

@@ -34,7 +34,7 @@
 		"@sapphire/docusaurus-plugin-npm2yarn2pnpm": "^1.1.4",
 		"ajv": "^8.12.0",
 		"clsx": "^1.2.1",
-		"krog": "^1.2.0",
+		"krog": "^1.3.0",
 		"prism-react-renderer": "^1.3.5",
 		"react": "^17.0.2",
 		"react-dom": "^17.0.2",

packages/client/src/lib/client.plugins.spec.ts

@@ -40,3 +40,35 @@ test('allow providing hooks via plugins', (done) => {
 
 	client.get('players').get('1').get('name').set('Patrick', { owner: 'test' });
 });
+
+test('allow providing hooks via the intercept function', (done) => {
+	// does the same as the previous test, but uses the intercept function instead of plugins
+
+	const socketClient: SocketClient = {
+		onConnect(connect) {
+			setTimeout(connect);
+		},
+		onDisconnect() {},
+		off() {},
+		on() {},
+		send() {},
+		close() {},
+	};
+	const store = createStore();
+	const client = SocketDBClient({ socketClient, store });
+
+	client.intercept('client:firstConnect', () => {
+		expect(true);
+	});
+
+	client.intercept('client:set', ({ path, value, meta }) => {
+		// note: errors here will not throw,
+		// because they are catched by the hooks system
+		expect(path).toEqual('players/1/name');
+		expect(value).toEqual('Patrick');
+		expect(meta).toEqual({ owner: 'test' });
+		done();
+	});
+
+	client.get('players').get('1').get('name').set('Patrick', { owner: 'test' });
+});

packages/client/src/lib/client.ts

@@ -30,6 +30,10 @@ import { createWebsocketClient } from './socket-implementation/websocketClient';
 
 export type SocketDBClientAPI<Schema extends SchemaDefinition = any> = {
 	disconnect: () => void;
+	intercept: <Hook extends keyof ClientHooks>(
+		hook: Hook,
+		callback: ClientHooks[Hook]
+	) => () => void;
 } & ChainReference<Schema>;
 
 type Unsubscriber = () => void;
@@ -359,6 +363,7 @@ export function SocketDBClient<Schema extends RootSchemaDefinition = any>({
 
 	return {
 		...get(''),
+		intercept: hooks.register,
 		disconnect() {
 			connection.close();
 		},

packages/server/src/lib/server.plugins.spec.ts

@@ -46,3 +46,44 @@ test('allows providing hooks via plugins', (done) => {
 		done();
 	}, 10);
 });
+
+test('allows providing hooks via the intercept function', (done) => {
+	// does the same as the previous test, but uses the intercept function instead of plugins
+
+	const store = createStore();
+	const time = new Date().getTime();
+	const server = SocketDBServer({
+		store,
+		socketServer: {
+			listen() {},
+			onConnection() {},
+		},
+	});
+
+	server.intercept('server:update', ({ data }, { client }) => {
+		// when update is called manually, client has no id
+		expect(client.id).toBe(null);
+		return {
+			data: {
+				value: data.value,
+				meta: {
+					...data.meta,
+					updated: time,
+				},
+			},
+		};
+	});
+
+	server.update(
+		nodeify({
+			players: { 1: { name: 'Arnold' } },
+		})
+	);
+
+	setTimeout(() => {
+		// Note: jest errors are catched by socketdb and prevent the store from being updated
+		expect(store.get('players/1/name')).toEqual({ value: 'Arnold' });
+		expect(store.get()?.meta).toEqual({ updated: time });
+		done();
+	}, 10);
+});

packages/server/src/lib/server.ts

@@ -42,6 +42,10 @@ export type SocketDBServerDataAPI<Schema extends RootSchemaDefinition> = {
 export type SocketDBServerAPI<Schema extends RootSchemaDefinition> =
 	SocketDBServerDataAPI<Schema> & {
 		listen: (port?: number, callback?: () => void) => void;
+		intercept: <Hook extends keyof ServerHooks<Schema>>(
+			hook: Hook,
+			callback: ServerHooks<Schema>[Hook]
+		) => () => void;
 	};
 
 /**
@@ -429,6 +433,7 @@ export function SocketDBServer<Schema extends RootSchemaDefinition>({
 		listen(port);
 		return {
 			...api,
+			intercept: hooks.register,
 			listen() {
 				console.warn('No-op. Turn off autoListen to use the listen() method.');
 			},
@@ -437,6 +442,7 @@ export function SocketDBServer<Schema extends RootSchemaDefinition>({
 
 	return {
 		listen,
+		intercept: hooks.register,
 		...api,
 	};
 }