@crossdelta/cloudevents 0.1.1 → 0.1.3

package/README.md

@@ -1,30 +1,37 @@
-# Orderboss CloudEvents Toolkit
+# @crossdelta/cloudevents
 
-[![Architecture](https://img.shields.io/badge/architecture-arc42-blue?style=flat-square&logo=gitbook)](docs/architecture.md)
-
-CloudEvents middleware, publishers, and consumers that integrate cleanly with [Hono](https://hono.dev/). Ship handler discovery, DLQ-safe processing for Google Pub/Sub & Eventarc, and NATS utilities without wiring everything yourself.
+CloudEvents toolkit for TypeScript. Handler discovery, DLQ-safe processing, NATS streaming, and optional Hono middleware.
 
 ## Features
 
-- Automatic handler discovery for `*.event.(ts|js)` files with caching
-- CloudEvents parsing for structured, binary, Pub/Sub push, and raw payloads
-- DLQ-safe mode that quarantines invalid messages and reports recoverable errors
-- First-class Zod support with optional safe-parse fallback
-- Shared tooling for Google Pub/Sub and NATS (publish & consume)
+- Automatic handler discovery for `*.event.(ts|js)` files
+- CloudEvents parsing (structured, binary, Pub/Sub push, raw)
+- DLQ-safe mode with quarantine for invalid messages
+- Zod validation with optional safe-parse fallback
+- NATS publish & consume support
+- Google Pub/Sub support (optional dependency)
+
+## Installation
+
+```bash
+bun add @crossdelta/cloudevents
+```
 
-## Getting started
+### Optional: Google Pub/Sub
 
-### 1. Install the package
+For Pub/Sub publishing, install the optional dependency:
 
 ```bash
-bun add @orderboss/cloudevents
+bun add @google-cloud/pubsub
 ```
 
-### 2. Define a typed event handler
+## Quick Start
+
+### Define a handler
 
 ```typescript
 import { z } from 'zod'
-import { eventSchema, handleEvent } from '@orderboss/cloudevents'
+import { eventSchema, handleEvent } from '@crossdelta/cloudevents'
 
 const CustomerCreatedSchema = eventSchema({
   type: z.literal('customer.created'),
@@ -39,87 +46,50 @@ export const CustomerCreatedHandler = handleEvent(CustomerCreatedSchema, async (
 })
 ```
 
-> Need a softer failure mode? Set `CustomerCreatedHandler.__eventarcMetadata.safeParse = true` before registering it to skip invalid payloads in favour of quarantine logs.
-
-### 3. Register the middleware in Hono
+### Register middleware
 
 ```typescript
 import { Hono } from 'hono'
-import { cloudEvents } from '@orderboss/cloudevents'
+import { cloudEvents } from '@crossdelta/cloudevents'
 
 const app = new Hono()
 
 app.use('/events', cloudEvents({
   discover: 'src/events/**/*.event.{ts,js}',
-  quarantineTopic: process.env.QUARANTINE_TOPIC,
-  errorTopic: process.env.ERROR_TOPIC,
-  projectId: process.env.GCP_PROJECT_ID,
-  log: process.env.NODE_ENV === 'production' ? 'structured' : 'pretty',
 }))
 ```
 
-DLQ-safe mode activates automatically when `quarantineTopic` or `errorTopic` is provided.
-
-## Publishing events
+## Publishing
 
 ```typescript
-import {
-  publishEvent,
-  publishRawEvent,
-  publishNatsEvent,
-  publishNatsRawEvent,
-} from '@orderboss/cloudevents'
-
-// Google Pub/Sub
-await publishEvent('customer-events', CustomerCreatedSchema, {
-  payload: { id: 'cust_1', email: 'jane@example.com' },
-})
+import { publishNatsEvent } from '@crossdelta/cloudevents'
 
-await publishRawEvent('customer-events', 'customer.deleted', { id: 'cust_1' }, {
-  source: 'orderboss://customers',
-  projectId: 'my-project',
-})
-
-// NATS Streaming (reuse the schema you defined for your handler)
 await publishNatsEvent('orders.placed', OrderPlacedSchema, {
   payload: { id: 'ord_42', total: 149.9 },
 })
-
-await publishNatsRawEvent('orders.canceled', 'order.canceled', { id: 'ord_42' }, {
-  servers: process.env.NATS_URL,
-})
 ```
 
 ## Consuming from NATS
 
 ```typescript
-import { consumeNatsEvents } from '@orderboss/cloudevents/transports/nats'
+import { consumeNatsEvents } from '@crossdelta/cloudevents/transports/nats'
 
 await consumeNatsEvents({
   servers: process.env.NATS_URL,
   subject: 'orders.placed',
   discover: 'dist/events/*.event.js',
   consumerName: 'orders-api',
-  quarantineTopic: 'projects/my-app/topics/nats-quarantine',
-  errorTopic: 'projects/my-app/topics/nats-errors',
 })
 ```
 
-The consumer reuses your handler definitions, honours `safeParse`, and mirrors the DLQ-safe behaviour of the middleware.
-
-## API surface
-
-- `cloudEvents(options)` – Hono middleware with discovery, dedupe, and DLQ-safe semantics
-- `clearHandlerCache()` – resets the discovery cache (tests, hot reload)
-- `eventSchema(schema)` – wraps a Zod object that includes a `type` literal
-- `handleEvent(schemaOrOptions, handler)` – builds discovery-ready handler classes
-- `parseEventFromContext(ctx)` – normalises incoming CloudEvents for manual flows
-- `publishEvent` / `publishRawEvent` – publish to Google Pub/Sub
-- `publishNatsEvent` / `publishNatsRawEvent` – publish to NATS subjects
-- `consumeNatsEvents` – subscribe to NATS and execute discovered handlers
-
-## Further reading
-
-- [Architecture notes](docs/architecture.md)
-- Examples in `packages/cloudevents/test`
-- Project changelog in the repository root
+## API
+
+| Function | Description |
+|----------|-------------|
+| `cloudEvents(options)` | Hono middleware with discovery and DLQ-safe semantics |
+| `eventSchema(schema)` | Wraps a Zod schema with `type` literal |
+| `handleEvent(schema, handler)` | Creates discovery-ready handler |
+| `publishNatsEvent` / `publishNatsRawEvent` | Publish to NATS |
+| `publishEvent` / `publishRawEvent` | Publish to Google Pub/Sub (requires optional dep) |
+| `consumeNatsEvents` | Subscribe to NATS and execute handlers |
+| `clearHandlerCache()` | Reset discovery cache |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crossdelta/cloudevents",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "type": "module",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",