@rubriclab/events

@rubriclab/events

The Actions package aims to provide a powerful and simple way to define actions (which are essentially API primitives) and execute them safely with JSON serializable payloads.

It is part of Rubric's architecture for Generative UI when used with:

• @rubriclab/actions
• @rubriclab/blocks
• @rubriclab/chains
• @rubriclab/agents

Get Started

Installation

bun add @rubriclab/events

@rubriclab scope packages are not built, they are all raw typescript. If using in a next.js app, make sure to transpile.

// next.config.ts
import type { NextConfig } from  'next' 
export default {
	transpilePackages: ['@rubriclab/events'],
	reactStrictMode: true
} satisfies  NextConfig

If using inside the monorepo (@rubric), simply add {"@rubriclab/events": "*"} to dependencies and then run bun i

Define Event types

export const eventTypes = createEventTypes({
  ping: z.literal('ping'),
})

Create the events server and a route

import { createEventsServer } from '@rubriclab/events/server'
import env from '~/env'
import { eventTypes } from './types'

export const { publish, GET, maxDuration } = createEventsServer({
	eventTypes,
	redisURL: env.UPSTASH_REDIS_URL
})

// app/api/events/route.ts
export { GET, maxDuration } from './server'

Create the events client

import { createEventsClient } from '@rubriclab/events/client'
import { eventTypes } from './types'

export const { useEvents } = createEventsClient({
	url: '/api/events', // The url of the server
	eventTypes
})

Publish an event from the server

await publish({
  channel: '123',
  eventType: 'ping',
  payload: 'ping'
})

Consume it on the client!

useEvents({
		id: '123',
		on: {
			ping: (payload) => {
				console.log('ping', payload)
			}
		}
	})

Commits to main will automatically publish a new version to npm.