@glowlabs-org/events-sdk 1.0.3 → 1.0.5

package/README.md

@@ -26,6 +26,27 @@ The following zones are currently available:
 
 - Use `zoneId: 0` (with `zoneName: "All Zones"`) to listen to all zones. **Emitters must be constructed with a specific zoneId (not 0).**
 - The SDK types and runtime validation now officially support `zoneId: 0` and `zoneName: "All Zones"` everywhere for listeners, but not for emitters.
+- **Use the `getZoneId` utility to get the correct zoneId for a given zone name:**
+
+  ```ts
+  import { getZoneId } from "@glowlabs-org/events-sdk";
+  const zoneId = getZoneId("CleanGridProject");
+  ```
+
+---
+
+## 🛠️ Options for Listeners & Emitters
+
+Both `createGlowEventListener` and `createGlowEventEmitter` accept the following options:
+
+| Option           | Type   | Required | Description                                                        |
+| ---------------- | ------ | -------- | ------------------------------------------------------------------ |
+| `username`       | string | Yes      | RabbitMQ username                                                  |
+| `password`       | string | Yes      | RabbitMQ password                                                  |
+| `zoneId`         | number | Yes      | Zone ID (use `getZoneId("ZoneName")`)                              |
+| `queueName`      | string | No       | (Listener only) Pre-created queue name                             |
+| `exchangePrefix` | string | No       | Exchange prefix (default: `glow.zone-`)                            |
+| `host`           | string | No       | **RabbitMQ host/port** (default: `turntable.proxy.rlwy.net:50784`) |
 
 ---
 
@@ -35,11 +56,29 @@ Currently supported event types and versions:
 
 | Event Name            | Version | Payload Type                  | Description                            |
 | --------------------- | ------- | ----------------------------- | -------------------------------------- |
-| `audit.pushed`        | 1       | `AuditPushedV1Payload`        | Emitted when an audit is pushed        |
-| `audit.slashed`       | 1       | `AuditSlashedV1Payload`       | Emitted when a farm is slashed         |
-| `audit.pfees.paid`    | 1       | `AuditPfeesPaidV1Payload`     | Paid (by applicationId)                |
-| `audit.pfees.paid`    | 2       | `AuditPfeesPaidV2Payload`     | Paid (by farmId)                       |
-| `application.created` | 1       | `ApplicationCreatedV1Payload` | Emitted when an application is created |
+| `audit.pushed`        | "v1"    | `AuditPushedV1Payload`        | Emitted when an audit is pushed        |
+| `audit.slashed`       | "v1"    | `AuditSlashedV1Payload`       | Emitted when a farm is slashed         |
+| `audit.pfees.paid`    | "v1"    | `AuditPfeesPaidV1Payload`     | Paid (by applicationId)                |
+| `audit.pfees.paid`    | "v2"    | `AuditPfeesPaidV2Payload`     | Paid (by farmId)                       |
+| `application.created` | "v1"    | `ApplicationCreatedV1Payload` | Emitted when an application is created |
+
+---
+
+### Event Types Enum
+
+The SDK provides a TypeScript constant for all supported event types to ensure type safety and avoid typos:
+
+```ts
+import { eventTypes, EventType } from "./src/event-types";
+
+// Usage example:
+const myEventType: EventType = eventTypes.auditPushed;
+```
+
+- `eventTypes` is a readonly object containing all event type strings.
+- `EventType` is a TypeScript type representing any valid event type string.
+
+Use these in your code to avoid hardcoding event names and to benefit from autocompletion and type checking.
 
 ---
 
@@ -141,50 +180,65 @@ export interface ApplicationCreatedV1Payload {
 ### Listen to Specific Event Types/Versions
 
 ```ts
-import { createGlowEventListener } from "@glowlabs-org/events-sdk";
+import { createGlowEventListener, getZoneId } from "@glowlabs-org/events-sdk";
 
 const listener = createGlowEventListener({
   username: "listener",
   password: "your-password-here",
-  zoneId: 1,
+  zoneId: getZoneId("CleanGridProject"),
   queueName: "my.precreated.queue",
+  host: "my.rabbitmq.host:5672", // Optional: override the default host
 });
 
-listener.onEvent("audit.pushed", 1, (event) => {
-  console.log("Received audit.pushed v1:", event.farmId);
+listener.onEvent("audit.pushed", "v1", (event) => {
+  // event: GlowEvent<AuditPushedV1Payload>
+  console.log(
+    "Received audit.pushed v1:",
+    event.payload.farmId,
+    event.zoneId,
+    event.zoneName
+  );
 });
 
-listener.onEvent("audit.slashed", 1, (event) => {
-  console.log("Received audit.slashed v1:", event.farmId, event.slasher);
+listener.onEvent("audit.slashed", "v1", (event) => {
+  // event: GlowEvent<AuditSlashedV1Payload>
+  console.log(
+    "Received audit.slashed v1:",
+    event.payload.farmId,
+    event.payload.slasher
+  );
 });
 
-listener.onEvent("audit.pfees.paid", 1, (event) => {
+listener.onEvent("audit.pfees.paid", "v1", (event) => {
+  // event: GlowEvent<AuditPfeesPaidV1Payload>
   console.log(
     "Received audit.pfees.paid v1:",
-    event.applicationId,
-    event.payer,
-    event.amount_12Decimals
+    event.payload.applicationId,
+    event.payload.payer,
+    event.payload.amount_12Decimals
   );
 });
 
-listener.onEvent("audit.pfees.paid", 2, (event) => {
+listener.onEvent("audit.pfees.paid", "v2", (event) => {
+  // event: GlowEvent<AuditPfeesPaidV2Payload>
   console.log(
     "Received audit.pfees.paid v2:",
-    event.farmId,
-    event.payer,
-    event.amount_12Decimals
+    event.payload.farmId,
+    event.payload.payer,
+    event.payload.amount_12Decimals
   );
 });
 
-listener.onEvent("application.created", 1, (event) => {
+listener.onEvent("application.created", "v1", (event) => {
+  // event: GlowEvent<ApplicationCreatedV1Payload>
   console.log(
     "Received application.created v1:",
-    event.gcaAddress,
-    event.lat,
-    event.lng,
-    event.estimatedCostOfPowerPerKWh,
-    event.estimatedKWhGeneratedPerYear,
-    event.installerCompanyName
+    event.payload.gcaAddress,
+    event.payload.lat,
+    event.payload.lng,
+    event.payload.estimatedCostOfPowerPerKWh,
+    event.payload.estimatedKWhGeneratedPerYear,
+    event.payload.installerCompanyName
   );
 });
 
@@ -196,57 +250,62 @@ await listener.start();
 ### Emit Events (Admin Only)
 
 ```ts
-import { createGlowEventEmitter } from "@glowlabs-org/events-sdk";
+import { createGlowEventEmitter, getZoneId } from "@glowlabs-org/events-sdk";
 
 // You must construct the emitter with a specific zoneId (not 0)
 const emitter = createGlowEventEmitter({
   username: "admin",
   password: "your-password-here",
-  zoneId: 1, // must be a specific zone
+  zoneId: getZoneId("CleanGridProject"), // must be a specific zone
+  host: "my.rabbitmq.host:5672", // Optional: override the default host
 });
 
 await emitter.emit({
   eventType: "audit.pushed",
-  schemaVersion: 1,
+  schemaVersion: "v1",
   payload: {
     farmId: "0x...",
     protocolFeeUSDPrice_12Decimals: "...",
     expectedProduction_12Decimals: "...",
+    txHash: "0x...",
   },
 });
 
 await emitter.emit({
   eventType: "audit.slashed",
-  schemaVersion: 1,
+  schemaVersion: "v1",
   payload: {
     farmId: "0x...",
     slasher: "0x...",
+    txHash: "0x...",
   },
 });
 
 await emitter.emit({
   eventType: "audit.pfees.paid",
-  schemaVersion: 1,
+  schemaVersion: "v1",
   payload: {
     applicationId: "0x...",
     payer: "0x...",
     amount_12Decimals: "1000000000000",
+    txHash: "0x...",
   },
 });
 
 await emitter.emit({
   eventType: "audit.pfees.paid",
-  schemaVersion: 2,
+  schemaVersion: "v2",
   payload: {
     farmId: "0x...",
     payer: "0x...",
     amount_12Decimals: "1000000000000",
+    txHash: "0x...",
   },
 });
 
 await emitter.emit({
   eventType: "application.created",
-  schemaVersion: 1,
+  schemaVersion: "v1",
   payload: {
     gcaAddress: "0x...",
     lat: 45.5017,
@@ -264,10 +323,12 @@ await emitter.disconnect();
 >
 > - The emitter will automatically publish each event to both the global (zone 0) and the specific zone exchange.
 > - You cannot construct an emitter for zoneId: 0, and you cannot specify zoneId per emit call.
+> - `schemaVersion` is always a string (e.g., "v1", "v2").
+> - **You can override the RabbitMQ host using the `host` option. Default is `turntable.proxy.rlwy.net:50784`.**
 
 ### 🌐 Listening to All Zones
 
-You can listen to **all zones at once** by passing `zoneId: 0` to the listener. **Emitters must always use a specific zone.**
+You can listen to **all zones at once** by passing `zoneId: 0` and `zoneName: "All Zones"` to the listener. **Emitters must always use a specific zone.**
 
 #### Listen to All Zones
 
@@ -281,47 +342,16 @@ const listener = createGlowEventListener({
   queueName: "my.precreated.queue",
 });
 
-listener.onEvent("audit.pushed", 1, (event) => {
-  console.log("Received audit.pushed v1 from any zone:", event.farmId);
-});
-
-listener.onEvent("audit.slashed", 1, (event) => {
+listener.onEvent("audit.pushed", "v1", (event) => {
   console.log(
-    "Received audit.slashed v1 from any zone:",
-    event.farmId,
-    event.slasher
+    "Received audit.pushed v1 from any zone:",
+    event.payload.farmId,
+    event.zoneId,
+    event.zoneName
   );
 });
 
-listener.onEvent("audit.pfees.paid", 1, (event) => {
-  console.log(
-    "Received audit.pfees.paid v1 from any zone:",
-    event.applicationId,
-    event.payer,
-    event.amount_12Decimals
-  );
-});
-
-listener.onEvent("audit.pfees.paid", 2, (event) => {
-  console.log(
-    "Received audit.pfees.paid v2 from any zone:",
-    event.farmId,
-    event.payer,
-    event.amount_12Decimals
-  );
-});
-
-listener.onEvent("application.created", 1, (event) => {
-  console.log(
-    "Received application.created v1 from any zone:",
-    event.gcaAddress,
-    event.lat,
-    event.lng,
-    event.estimatedCostOfPowerPerKWh,
-    event.estimatedKWhGeneratedPerYear,
-    event.installerCompanyName
-  );
-});
+// ... other event handlers ...
 
 await listener.start();
 // To stop listening:

package/dist/admin.d.ts

@@ -8,6 +8,7 @@ export interface CreateAndBindQueueOptions {
     queueOptions?: amqp.Options.AssertQueue;
     exchangeOptions?: amqp.Options.AssertExchange;
     routingKey?: string;
+    host?: string;
 }
 /**
  * Create a RabbitMQ topic exchange (admin credentials required).
@@ -15,25 +16,31 @@ export interface CreateAndBindQueueOptions {
  * @param options - Connection and exchange options
  * @returns Promise<void>
  */
-export declare function createExchange({ username, password, exchange, exchangeType, exchangeOptions, }: Omit<CreateAndBindQueueOptions, "queue" | "queueOptions" | "routingKey">): Promise<void>;
+export declare function createExchange({ username, password, exchange, exchangeType, exchangeOptions, host, }: Omit<CreateAndBindQueueOptions, "queue" | "queueOptions" | "routingKey"> & {
+    host?: string;
+}): Promise<void>;
 /**
  * Create a RabbitMQ queue and bind it to a topic exchange (admin credentials required).
  *
  * @param options - Connection, queue, and exchange options
  * @returns Promise<void>
  */
-export declare function bindQueueToExchange({ username, password, exchange, queue, exchangeType, queueOptions, exchangeOptions, routingKey, }: CreateAndBindQueueOptions): Promise<void>;
+export declare function bindQueueToExchange({ username, password, exchange, queue, exchangeType, queueOptions, exchangeOptions, routingKey, host, }: CreateAndBindQueueOptions): Promise<void>;
 /**
  * Delete a RabbitMQ exchange (admin credentials required).
  *
  * @param options - Connection and exchange options
  * @returns Promise<void>
  */
-export declare function deleteExchange({ username, password, exchange, }: Omit<CreateAndBindQueueOptions, "queue" | "queueOptions" | "exchangeType" | "exchangeOptions" | "routingKey">): Promise<void>;
+export declare function deleteExchange({ username, password, exchange, host, }: Omit<CreateAndBindQueueOptions, "queue" | "queueOptions" | "exchangeType" | "exchangeOptions" | "routingKey"> & {
+    host?: string;
+}): Promise<void>;
 /**
  * Delete a RabbitMQ queue (admin credentials required).
  *
  * @param options - Connection and queue options
  * @returns Promise<void>
  */
-export declare function deleteQueue({ username, password, queue, }: Omit<CreateAndBindQueueOptions, "exchange" | "exchangeType" | "exchangeOptions" | "queueOptions" | "routingKey">): Promise<void>;
+export declare function deleteQueue({ username, password, queue, host, }: Omit<CreateAndBindQueueOptions, "exchange" | "exchangeType" | "exchangeOptions" | "queueOptions" | "routingKey"> & {
+    host?: string;
+}): Promise<void>;

package/dist/admin.js

@@ -8,23 +8,17 @@ exports.bindQueueToExchange = bindQueueToExchange;
 exports.deleteExchange = deleteExchange;
 exports.deleteQueue = deleteQueue;
 const amqplib_1 = __importDefault(require("amqplib"));
-function validateName(name, type) {
-    // Require at least two segments separated by dots, only alphanumerics, dashes, underscores, and dots
-    const pattern = /^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$/;
-    if (!pattern.test(name)) {
-        throw new Error(`${type} name '${name}' is invalid. Must be dot-separated (e.g., 'glow.zone-1.events').`);
-    }
-}
+const utils_1 = require("./utils");
 /**
  * Create a RabbitMQ topic exchange (admin credentials required).
  *
  * @param options - Connection and exchange options
  * @returns Promise<void>
  */
-async function createExchange({ username, password, exchange, exchangeType = "topic", exchangeOptions = { durable: true }, }) {
-    validateName(exchange, "exchange");
-    const url = new URL(`amqp://${username}:${password}@turntable.proxy.rlwy.net:50784`);
-    const conn = await amqplib_1.default.connect(url.toString());
+async function createExchange({ username, password, exchange, exchangeType = "topic", exchangeOptions = { durable: true }, host = "turntable.proxy.rlwy.net:50784", }) {
+    (0, utils_1.validateName)(exchange, "exchange");
+    const url = (0, utils_1.buildAmqpUrl)({ username, password, host });
+    const conn = await amqplib_1.default.connect(url);
     const channel = await conn.createChannel();
     await channel.assertExchange(exchange, exchangeType, exchangeOptions);
     await channel.close();
@@ -36,11 +30,11 @@ async function createExchange({ username, password, exchange, exchangeType = "to
  * @param options - Connection, queue, and exchange options
  * @returns Promise<void>
  */
-async function bindQueueToExchange({ username, password, exchange, queue, exchangeType = "topic", queueOptions = { durable: false }, exchangeOptions = { durable: true }, routingKey = "#", }) {
-    validateName(exchange, "exchange");
-    validateName(queue, "queue");
-    const url = new URL(`amqp://${username}:${password}@turntable.proxy.rlwy.net:50784`);
-    const conn = await amqplib_1.default.connect(url.toString());
+async function bindQueueToExchange({ username, password, exchange, queue, exchangeType = "topic", queueOptions = { durable: false }, exchangeOptions = { durable: true }, routingKey = "#", host = "turntable.proxy.rlwy.net:50784", }) {
+    (0, utils_1.validateName)(exchange, "exchange");
+    (0, utils_1.validateName)(queue, "queue");
+    const url = (0, utils_1.buildAmqpUrl)({ username, password, host });
+    const conn = await amqplib_1.default.connect(url);
     const channel = await conn.createChannel();
     await channel.assertExchange(exchange, exchangeType, exchangeOptions);
     await channel.assertQueue(queue, queueOptions);
@@ -54,10 +48,10 @@ async function bindQueueToExchange({ username, password, exchange, queue, exchan
  * @param options - Connection and exchange options
  * @returns Promise<void>
  */
-async function deleteExchange({ username, password, exchange, }) {
-    validateName(exchange, "exchange");
-    const url = new URL(`amqp://${username}:${password}@turntable.proxy.rlwy.net:50784`);
-    const conn = await amqplib_1.default.connect(url.toString());
+async function deleteExchange({ username, password, exchange, host = "turntable.proxy.rlwy.net:50784", }) {
+    (0, utils_1.validateName)(exchange, "exchange");
+    const url = (0, utils_1.buildAmqpUrl)({ username, password, host });
+    const conn = await amqplib_1.default.connect(url);
     const channel = await conn.createChannel();
     await channel.deleteExchange(exchange);
     await channel.close();
@@ -69,10 +63,10 @@ async function deleteExchange({ username, password, exchange, }) {
  * @param options - Connection and queue options
  * @returns Promise<void>
  */
-async function deleteQueue({ username, password, queue, }) {
-    validateName(queue, "queue");
-    const url = new URL(`amqp://${username}:${password}@turntable.proxy.rlwy.net:50784`);
-    const conn = await amqplib_1.default.connect(url.toString());
+async function deleteQueue({ username, password, queue, host = "turntable.proxy.rlwy.net:50784", }) {
+    (0, utils_1.validateName)(queue, "queue");
+    const url = (0, utils_1.buildAmqpUrl)({ username, password, host });
+    const conn = await amqplib_1.default.connect(url);
     const channel = await conn.createChannel();
     await channel.deleteQueue(queue);
     await channel.close();

package/dist/base-event.d.ts

@@ -1,64 +1,64 @@
 import { z } from "zod";
-import { ZoneName } from "./zones";
+import { EventType } from "./event-types";
 export declare const baseEventZ: z.ZodObject<{
     id: z.ZodString;
     zoneId: z.ZodEffects<z.ZodNumber, number, number>;
     zoneName: z.ZodEnum<[string, ...string[]]>;
-    schemaVersion: z.ZodEffects<z.ZodNumber, 1 | 2, number>;
-    eventType: z.ZodEnum<["audit.pushed", "audit.slashed", "audit.pfees.paid", "application.created"]>;
+    schemaVersion: z.ZodEnum<["v1", "v2"]>;
+    eventType: z.ZodEnum<[EventType, ...EventType[]]>;
     timeStamp: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     id: string;
     zoneId: number;
     zoneName: string;
-    schemaVersion: 1 | 2;
-    eventType: "audit.pushed" | "audit.slashed" | "audit.pfees.paid" | "application.created";
+    schemaVersion: "v1" | "v2";
+    eventType: EventType;
     timeStamp: number;
 }, {
     id: string;
     zoneId: number;
     zoneName: string;
-    schemaVersion: number;
-    eventType: "audit.pushed" | "audit.slashed" | "audit.pfees.paid" | "application.created";
+    schemaVersion: "v1" | "v2";
+    eventType: EventType;
     timeStamp: number;
 }>;
 export interface BaseEventAuditPushedV1 {
     id: string;
     zoneId: number;
-    zoneName: ZoneName;
-    schemaVersion: 1;
+    zoneName: string;
+    schemaVersion: "v1";
     eventType: "audit.pushed";
     timeStamp: number;
 }
 export interface BaseEventAuditSlashedV1 {
     id: string;
     zoneId: number;
-    zoneName: ZoneName;
-    schemaVersion: 1;
+    zoneName: string;
+    schemaVersion: "v1";
     eventType: "audit.slashed";
     timeStamp: number;
 }
 export interface BaseEventAuditPfeesPaidV1 {
     id: string;
     zoneId: number;
-    zoneName: ZoneName;
-    schemaVersion: 1;
+    zoneName: string;
+    schemaVersion: "v1";
     eventType: "audit.pfees.paid";
     timeStamp: number;
 }
 export interface BaseEventAuditPfeesPaidV2 {
     id: string;
     zoneId: number;
-    zoneName: ZoneName;
-    schemaVersion: 2;
+    zoneName: string;
+    schemaVersion: "v2";
     eventType: "audit.pfees.paid";
     timeStamp: number;
 }
 export interface BaseEventApplicationCreatedV1 {
     id: string;
     zoneId: number;
-    zoneName: ZoneName;
-    schemaVersion: 1;
+    zoneName: string;
+    schemaVersion: "v1";
     eventType: "application.created";
     timeStamp: number;
 }

package/dist/base-event.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.baseEventZ = void 0;
 const zod_1 = require("zod");
 const zones_1 = require("./zones");
+const event_types_1 = require("./event-types");
 const zoneIdNumbers = Object.keys(zones_1.zoneMap).map(Number);
 const zoneNames = Object.values(zones_1.zoneMap);
 exports.baseEventZ = zod_1.z.object({
@@ -11,17 +12,7 @@ exports.baseEventZ = zod_1.z.object({
         message: "Invalid zoneId",
     }),
     zoneName: zod_1.z.enum(zoneNames),
-    schemaVersion: zod_1.z
-        .number()
-        .int()
-        .refine((v) => v === 1 || v === 2, {
-        message: "Invalid schemaVersion",
-    }),
-    eventType: zod_1.z.enum([
-        "audit.pushed",
-        "audit.slashed",
-        "audit.pfees.paid",
-        "application.created",
-    ]),
+    schemaVersion: zod_1.z.enum(["v1", "v2"]),
+    eventType: zod_1.z.enum(Object.values(event_types_1.eventTypes)),
     timeStamp: zod_1.z.number().int(),
 });

package/dist/emitter.d.ts

@@ -1,17 +1,18 @@
-import { EventPayload, EventType, EventVersion } from "./types";
+import type { EventPayload, EventPayloadMap, EventType } from "./types";
 interface CreateGlowEventEmitterOptions {
     username: string;
     password: string;
     zoneId: number;
     exchangePrefix?: string;
+    host?: string;
 }
-interface EmitEventArgs<T extends EventType, V extends EventVersion<T>> {
+interface EmitEventArgs<T extends EventType, V extends keyof EventPayloadMap[T]> {
     eventType: T;
     schemaVersion: V;
     payload: EventPayload<T, V>;
 }
-export declare function createGlowEventEmitter({ username, password, zoneId, exchangePrefix, }: CreateGlowEventEmitterOptions): {
-    emit: <T extends EventType, V extends EventVersion<T>>(args: EmitEventArgs<T, V>) => Promise<void>;
+export declare function createGlowEventEmitter({ username, password, zoneId, exchangePrefix, host, }: CreateGlowEventEmitterOptions): {
+    emit: <T extends EventType, V extends keyof import("./types").EventPayloadMap[T]>(args: EmitEventArgs<T, V>) => Promise<void>;
     disconnect: () => Promise<void>;
 };
 export {};

package/dist/emitter.js

@@ -8,19 +8,18 @@ const amqplib_1 = __importDefault(require("amqplib"));
 const utils_1 = require("./utils");
 const uuid_1 = require("uuid");
 const zones_1 = require("./zones");
-function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "glow.zone-", }) {
+function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "glow.zone-", host = "turntable.proxy.rlwy.net:50784", }) {
     let amqpConnection = null;
     let amqpChannel = null;
     // Exchanges for global and specific zone
     const globalExchangeName = `${exchangePrefix}0.events`;
     const zoneExchangeName = `${exchangePrefix}${zoneId}.events`;
-    function buildAmqpUrl() {
-        const url = new URL(`amqp://${username}:${password}@turntable.proxy.rlwy.net:50784`);
-        return url.toString();
+    function buildUrl() {
+        return (0, utils_1.buildAmqpUrl)({ username, password, host });
     }
     async function connectIfNeeded() {
         if (!amqpConnection) {
-            amqpConnection = (await amqplib_1.default.connect(buildAmqpUrl()));
+            amqpConnection = (await amqplib_1.default.connect(buildUrl()));
             amqpChannel = (await amqpConnection.createChannel());
         }
         if (amqpChannel) {
@@ -34,7 +33,7 @@ function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "
     }
     async function emit(args) {
         const { eventType, schemaVersion, payload } = args;
-        const zoneName = zones_1.zoneMap[String(zoneId)];
+        const zoneName = zones_1.zoneMap[zoneId];
         if (!zoneName)
             throw new Error(`Invalid zoneId: ${zoneId}`);
         if (zoneId === 0)
@@ -49,8 +48,8 @@ function createGlowEventEmitter({ username, password, zoneId, exchangePrefix = "
             payload,
         };
         (0, utils_1.validateZoneNameAndId)(event.zoneId, event.zoneName);
-        (0, utils_1.validateEventPayload)(event.eventType, event.schemaVersion, event);
-        const routingKey = `${event.eventType}.v${event.schemaVersion}`;
+        (0, utils_1.validateEventPayload)(event.eventType, schemaVersion, event);
+        const routingKey = `${event.eventType}.${event.schemaVersion.toString()}`;
         await connectIfNeeded();
         // Emit to both the global and the specific zone exchange
         amqpChannel.publish(globalExchangeName, routingKey, Buffer.from(JSON.stringify(event)), { persistent: true });

package/dist/event-registry.d.ts

@@ -1,2 +1,2 @@
 import { z } from "zod";
-export declare function getEventSchema(eventType: string, version: number): z.ZodTypeAny;
+export declare function getEventSchema(eventType: string, version: "v1" | "v2"): z.ZodTypeAny;

package/dist/event-registry.js

@@ -7,21 +7,26 @@ const audit_pfees_paid_v1_1 = require("./schemas/audit-pfees-paid.v1");
 const audit_pfees_paid_v2_1 = require("./schemas/audit-pfees-paid.v2");
 const base_event_1 = require("./base-event");
 const application_created_v1_1 = require("./schemas/application-created.v1");
+const event_types_1 = require("./event-types");
 const eventTypeRegistry = {
-    "audit.pushed:v1": base_event_1.baseEventZ.extend({ payload: audit_pushed_v1_1.auditPushedV1PayloadZ }),
-    "audit.slashed:v1": base_event_1.baseEventZ.extend({ payload: audit_slashed_v1_1.auditSlashedV1PayloadZ }),
-    "audit.pfees.paid:v1": base_event_1.baseEventZ.extend({
+    [`${event_types_1.eventTypes.auditPushed}:v1`]: base_event_1.baseEventZ.extend({
+        payload: audit_pushed_v1_1.auditPushedV1PayloadZ,
+    }),
+    [`${event_types_1.eventTypes.auditSlashed}:v1`]: base_event_1.baseEventZ.extend({
+        payload: audit_slashed_v1_1.auditSlashedV1PayloadZ,
+    }),
+    [`${event_types_1.eventTypes.auditPfeesPaid}:v1`]: base_event_1.baseEventZ.extend({
         payload: audit_pfees_paid_v1_1.auditPfeesPaidV1PayloadZ,
     }),
-    "audit.pfees.paid:v2": base_event_1.baseEventZ.extend({
+    [`${event_types_1.eventTypes.auditPfeesPaid}:v2`]: base_event_1.baseEventZ.extend({
         payload: audit_pfees_paid_v2_1.auditPfeesPaidV2PayloadZ,
     }),
-    "application.created:v1": base_event_1.baseEventZ.extend({
+    [`${event_types_1.eventTypes.applicationCreated}:v1`]: base_event_1.baseEventZ.extend({
         payload: application_created_v1_1.applicationCreatedV1PayloadZ,
     }),
     // Add more event types/versions here
 };
 function getEventSchema(eventType, version) {
-    const key = `${eventType}:v${version}`;
+    const key = `${eventType}:${version}`;
     return eventTypeRegistry[key];
 }

package/dist/event-types.d.ts

@@ -0,0 +1,7 @@
+export declare const eventTypes: {
+    readonly auditPushed: "audit.pushed";
+    readonly auditSlashed: "audit.slashed";
+    readonly auditPfeesPaid: "audit.pfees.paid";
+    readonly applicationCreated: "application.created";
+};
+export type EventType = (typeof eventTypes)[keyof typeof eventTypes];

package/dist/event-types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventTypes = void 0;
+exports.eventTypes = {
+    auditPushed: "audit.pushed",
+    auditSlashed: "audit.slashed",
+    auditPfeesPaid: "audit.pfees.paid",
+    applicationCreated: "application.created",
+};

package/dist/index.d.ts

@@ -1,3 +1,6 @@
 export * from "./emitter";
 export * from "./listener";
 export * from "./admin";
+export * from "./types";
+export * from "./event-types";
+export * from "./zones";

package/dist/index.js

@@ -17,3 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./emitter"), exports);
 __exportStar(require("./listener"), exports);
 __exportStar(require("./admin"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./event-types"), exports);
+__exportStar(require("./zones"), exports);

package/dist/listener.d.ts

@@ -1,13 +1,14 @@
-import type { EventType, EventVersion, EventPayload, GlowEvent } from "./types";
+import type { EventType, EventPayload, EventPayloadMap, GlowEvent } from "./types";
 interface CreateGlowEventListenerOptions {
     username: string;
     password: string;
     zoneId: number;
     queueName?: string;
     exchangePrefix?: string;
+    host?: string;
 }
-export declare function createGlowEventListener({ username, password, zoneId, queueName, exchangePrefix, }: CreateGlowEventListenerOptions): {
-    onEvent: <T extends EventType, V extends EventVersion<T>>(eventType: T, schemaVersion: V, handler: (event: GlowEvent<EventPayload<T, V>>) => void) => void;
+export declare function createGlowEventListener({ username, password, zoneId, queueName, exchangePrefix, host, }: CreateGlowEventListenerOptions): {
+    onEvent: <T extends EventType, V extends keyof EventPayloadMap[T]>(eventType: T, schemaVersion: V, handler: (event: GlowEvent<EventPayload<T, V>>) => void) => void;
     start: () => Promise<void>;
     stop: () => Promise<void>;
 };

package/dist/listener.js

@@ -7,7 +7,7 @@ exports.createGlowEventListener = createGlowEventListener;
 const amqplib_1 = __importDefault(require("amqplib"));
 const event_registry_1 = require("./event-registry");
 const utils_1 = require("./utils");
-function createGlowEventListener({ username, password, zoneId, queueName, exchangePrefix = "glow.zone-", }) {
+function createGlowEventListener({ username, password, zoneId, queueName, exchangePrefix = "glow.zone-", host = "turntable.proxy.rlwy.net:50784", }) {
     let amqpConnection = null;
     let amqpChannel = null;
     let internalQueueName;
@@ -15,13 +15,12 @@ function createGlowEventListener({ username, password, zoneId, queueName, exchan
     // Use a special exchange for all zones if zoneId is 0
     const exchangeName = `${exchangePrefix}${zoneId}.events`;
     const eventHandlers = [];
-    function buildAmqpUrl() {
-        const url = new URL(`amqp://${username}:${password}@turntable.proxy.rlwy.net:50784`);
-        return url.toString();
+    function buildUrl() {
+        return (0, utils_1.buildAmqpUrl)({ username, password, host });
     }
     async function connectIfNeeded(bindingPattern) {
         if (!amqpConnection) {
-            amqpConnection = (await amqplib_1.default.connect(buildAmqpUrl()));
+            amqpConnection = (await amqplib_1.default.connect(buildUrl()));
             amqpChannel = (await amqpConnection.createChannel());
         }
         if (amqpChannel) {
@@ -39,7 +38,7 @@ function createGlowEventListener({ username, password, zoneId, queueName, exchan
         }
     }
     function onEvent(eventType, schemaVersion, handler) {
-        const bindingPattern = `${String(eventType)}.v${String(schemaVersion)}`;
+        const bindingPattern = `${String(eventType)}.${String(schemaVersion)}`;
         eventHandlers.push({
             bindingPattern,
             handler: (event, meta) => handler(event),
@@ -56,11 +55,11 @@ function createGlowEventListener({ username, password, zoneId, queueName, exchan
                 try {
                     const decoded = JSON.parse(msg.content.toString());
                     const [eventType, versionStr] = msg.fields.routingKey.split(".v");
-                    const schemaVersion = Number(versionStr);
+                    const schemaVersion = `v${versionStr}`;
                     (0, utils_1.validateZoneNameAndId)(decoded.zoneId, decoded.zoneName);
                     (0, utils_1.validateEventPayload)(eventType, schemaVersion, decoded);
                     const event = (0, event_registry_1.getEventSchema)(eventType, schemaVersion).parse(decoded);
-                    const handlerEntry = eventHandlers.find((h) => h.bindingPattern === `${eventType}.v${schemaVersion}`);
+                    const handlerEntry = eventHandlers.find((h) => h.bindingPattern === `${eventType}.${schemaVersion}`);
                     if (handlerEntry)
                         handlerEntry.handler(event, { eventType, schemaVersion });
                     amqpChannel.ack(msg);

package/dist/schemas/application-created.v1.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applicationCreatedV1PayloadZ = void 0;
 const zod_1 = require("zod");
+const utils_1 = require("../utils");
 exports.applicationCreatedV1PayloadZ = zod_1.z.object({
-    gcaAddress: zod_1.z.string().regex(/^0x[a-fA-F0-9]{40}$/), // eth address
+    gcaAddress: zod_1.z.string().regex(utils_1.ethAddress), // eth address
     lat: zod_1.z.number(),
     lng: zod_1.z.number(),
     estimatedCostOfPowerPerKWh: zod_1.z.number(),

package/dist/schemas/audit-pfees-paid.v1.js

@@ -2,14 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditPfeesPaidV1PayloadZ = void 0;
 const zod_1 = require("zod");
-const hexBytes32 = /^0x[0-9a-fA-F]{64}$/;
-const ethAddress = /^0x[0-9a-fA-F]{40}$/;
-const uint256 = /^[0-9]+$/;
+const utils_1 = require("../utils");
 exports.auditPfeesPaidV1PayloadZ = zod_1.z.object({
-    applicationId: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
-    payer: zod_1.z.string().regex(ethAddress, "Ethereum address"),
+    applicationId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+    payer: zod_1.z.string().regex(utils_1.ethAddress, "Ethereum address"),
     amount_12Decimals: zod_1.z
         .string()
-        .regex(uint256, "uint256 (decimal) − 12 implied decimals"),
-    txHash: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
+        .regex(utils_1.uint256, "uint256 (decimal) − 12 implied decimals"),
+    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/schemas/audit-pfees-paid.v2.js

@@ -2,14 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditPfeesPaidV2PayloadZ = void 0;
 const zod_1 = require("zod");
-const hexBytes32 = /^0x[0-9a-fA-F]{64}$/;
-const ethAddress = /^0x[0-9a-fA-F]{40}$/;
-const uint256 = /^[0-9]+$/;
+const utils_1 = require("../utils");
 exports.auditPfeesPaidV2PayloadZ = zod_1.z.object({
-    farmId: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
-    payer: zod_1.z.string().regex(ethAddress, "Ethereum address"),
+    farmId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+    payer: zod_1.z.string().regex(utils_1.ethAddress, "Ethereum address"),
     amount_12Decimals: zod_1.z
         .string()
-        .regex(uint256, "uint256 (decimal) − 12 implied decimals"),
-    txHash: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
+        .regex(utils_1.uint256, "uint256 (decimal) − 12 implied decimals"),
+    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/schemas/audit-pushed.v1.js

@@ -2,13 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditPushedV1PayloadZ = void 0;
 const zod_1 = require("zod");
-const hexBytes32 = /^0x[0-9a-fA-F]{64}$/;
-const uint256 = /^[0-9]+$/; // unsigned big‑int as decimal string
+const utils_1 = require("../utils");
 exports.auditPushedV1PayloadZ = zod_1.z.object({
-    farmId: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
+    farmId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
     protocolFeeUSDPrice_12Decimals: zod_1.z
         .string()
-        .regex(uint256, "uint256 (decimal) − 12 implied decimals"),
-    expectedProduction_12Decimals: zod_1.z.string().regex(uint256),
-    txHash: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
+        .regex(utils_1.uint256, "uint256 (decimal) − 12 implied decimals"),
+    expectedProduction_12Decimals: zod_1.z.string().regex(utils_1.uint256),
+    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/schemas/audit-slashed.v1.js

@@ -2,10 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.auditSlashedV1PayloadZ = void 0;
 const zod_1 = require("zod");
-const hexBytes32 = /^0x[0-9a-fA-F]{64}$/;
-const ethAddress = /^0x[0-9a-fA-F]{40}$/;
+const utils_1 = require("../utils");
 exports.auditSlashedV1PayloadZ = zod_1.z.object({
-    farmId: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
-    slasher: zod_1.z.string().regex(ethAddress, "Ethereum address"),
-    txHash: zod_1.z.string().regex(hexBytes32, "bytes32 hex string"),
+    farmId: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
+    slasher: zod_1.z.string().regex(utils_1.ethAddress, "Ethereum address"),
+    txHash: zod_1.z.string().regex(utils_1.hexBytes32, "bytes32 hex string"),
 });

package/dist/types.d.ts

@@ -4,31 +4,25 @@ import type { AuditSlashedV1Payload } from "./schemas/audit-slashed.v1";
 import type { AuditPfeesPaidV1Payload } from "./schemas/audit-pfees-paid.v1";
 import type { AuditPfeesPaidV2Payload } from "./schemas/audit-pfees-paid.v2";
 import type { ApplicationCreatedV1Payload } from "./schemas/application-created.v1";
-export type EventType = BaseEvent["eventType"];
-type EventTypeToVersion = {
-    "audit.pushed": 1;
-    "audit.slashed": 1;
-    "audit.pfees.paid": 1 | 2;
-    "application.created": 1;
-};
-export type EventVersion<T extends EventType> = T extends keyof EventTypeToVersion ? EventTypeToVersion[T] : never;
+import { eventTypes, EventType } from "./event-types";
+export { EventType, eventTypes };
+export type EventVersion = "v1" | "v2";
 export interface EventPayloadMap {
-    "audit.pushed": {
-        1: AuditPushedV1Payload;
+    [eventTypes.auditPushed]: {
+        v1: AuditPushedV1Payload;
     };
-    "audit.slashed": {
-        1: AuditSlashedV1Payload;
+    [eventTypes.auditSlashed]: {
+        v1: AuditSlashedV1Payload;
     };
-    "audit.pfees.paid": {
-        1: AuditPfeesPaidV1Payload;
-        2: AuditPfeesPaidV2Payload;
+    [eventTypes.auditPfeesPaid]: {
+        v1: AuditPfeesPaidV1Payload;
+        v2: AuditPfeesPaidV2Payload;
     };
-    "application.created": {
-        1: ApplicationCreatedV1Payload;
+    [eventTypes.applicationCreated]: {
+        v1: ApplicationCreatedV1Payload;
     };
 }
-export type EventPayload<T extends EventType, V extends EventVersion<T>> = T extends keyof EventPayloadMap ? V extends keyof EventPayloadMap[T] ? EventPayloadMap[T][V] : never : never;
+export type EventPayload<T extends EventType, V extends keyof EventPayloadMap[T]> = T extends keyof EventPayloadMap ? V extends keyof EventPayloadMap[T] ? EventPayloadMap[T][V] : never : never;
 export interface GlowEvent<TPayload> extends Omit<BaseEvent, "payload"> {
     payload: TPayload;
 }
-export {};

package/dist/types.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventTypes = void 0;
+const event_types_1 = require("./event-types");
+Object.defineProperty(exports, "eventTypes", { enumerable: true, get: function () { return event_types_1.eventTypes; } });

package/dist/utils.d.ts

@@ -7,7 +7,7 @@ export declare function validateZoneNameAndId(zoneId: number, zoneName: string):
  * Validates the event payload against the schema for the given eventType and schemaVersion.
  * Throws an error if the schema does not exist or the payload is invalid.
  */
-export declare function validateEventPayload(eventType: string, schemaVersion: number, payload: any): void;
+export declare function validateEventPayload(eventType: string, schemaVersion: "v1" | "v2", payload: any): void;
 /**
  * Processes a message object as the listener would, validating zone and schema.
  * Throws if validation fails, returns the parsed event otherwise.
@@ -18,3 +18,13 @@ export declare function processEventMessage(msg: {
         routingKey: string;
     };
 }): any;
+export declare const hexBytes32: RegExp;
+export declare const ethAddress: RegExp;
+export declare const uint256: RegExp;
+export declare const exchangeOrQueueNamePattern: RegExp;
+export declare function validateName(name: string, type: "exchange" | "queue"): void;
+export declare function buildAmqpUrl({ username, password, host, }: {
+    username: string;
+    password: string;
+    host: string;
+}): string;

package/dist/utils.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.exchangeOrQueueNamePattern = exports.uint256 = exports.ethAddress = exports.hexBytes32 = void 0;
 exports.validateZoneNameAndId = validateZoneNameAndId;
 exports.validateEventPayload = validateEventPayload;
 exports.processEventMessage = processEventMessage;
+exports.validateName = validateName;
+exports.buildAmqpUrl = buildAmqpUrl;
 const event_registry_1 = require("./event-registry");
 const zones_1 = require("./zones");
 /**
@@ -11,9 +14,9 @@ const zones_1 = require("./zones");
  */
 function validateZoneNameAndId(zoneId, zoneName) {
     if (typeof zoneId === "number" &&
-        String(zoneId) in zones_1.zoneMap &&
-        zoneName !== zones_1.zoneMap[String(zoneId)]) {
-        throw new Error(`zoneName '${zoneName}' does not match zoneId '${zoneId}' (expected '${zones_1.zoneMap[String(zoneId)]}')`);
+        zoneId in zones_1.zoneMap &&
+        zoneName !== zones_1.zoneMap[zoneId]) {
+        throw new Error(`zoneName '${zoneName}' does not match zoneId '${zoneId}' (expected '${zones_1.zoneMap[zoneId]}')`);
     }
 }
 /**
@@ -23,12 +26,12 @@ function validateZoneNameAndId(zoneId, zoneName) {
 function validateEventPayload(eventType, schemaVersion, payload) {
     const schema = (0, event_registry_1.getEventSchema)(eventType, schemaVersion);
     if (!schema)
-        throw new Error(`No schema for event: ${eventType} v${schemaVersion}`);
+        throw new Error(`No schema for event: ${eventType} ${schemaVersion}`);
     try {
         schema.parse(payload);
     }
     catch (err) {
-        throw new Error(`Payload does not match schema for event: ${eventType} v${schemaVersion}: ${err.message}`);
+        throw new Error(`Payload does not match schema for event: ${eventType} ${schemaVersion}: ${err.message}`);
     }
 }
 /**
@@ -38,8 +41,21 @@ function validateEventPayload(eventType, schemaVersion, payload) {
 function processEventMessage(msg) {
     const decoded = JSON.parse(msg.content.toString());
     const [eventType, versionStr] = msg.fields.routingKey.split(".v");
-    const schemaVersion = Number(versionStr);
+    const schemaVersion = `v${versionStr}`;
     validateZoneNameAndId(decoded.zoneId, decoded.zoneName);
     validateEventPayload(eventType, schemaVersion, decoded);
     return (0, event_registry_1.getEventSchema)(eventType, schemaVersion).parse(decoded);
 }
+exports.hexBytes32 = /^0x[0-9a-fA-F]{64}$/;
+exports.ethAddress = /^0x[0-9a-fA-F]{40}$/;
+exports.uint256 = /^[0-9]+$/;
+exports.exchangeOrQueueNamePattern = /^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$/;
+function validateName(name, type) {
+    if (!exports.exchangeOrQueueNamePattern.test(name)) {
+        throw new Error(`${type} name '${name}' is invalid. Must be dot-separated (e.g., 'glow.zone-1.events').`);
+    }
+}
+function buildAmqpUrl({ username, password, host, }) {
+    const url = new URL(`amqp://${username}:${password}@${host}`);
+    return url.toString();
+}

package/dist/zones.d.ts

@@ -1,7 +1,14 @@
 export declare const zoneMap: {
-    readonly "0": "All Zones";
-    readonly "1": "Clean Grid Project";
-    readonly "2": "Coming Soon Zone ";
+    readonly 0: "All Zones";
+    readonly 1: "Clean Grid Project";
+    readonly 2: "Coming Soon Zone ";
 };
 export type ZoneId = keyof typeof zoneMap;
 export type ZoneName = (typeof zoneMap)[ZoneId];
+export declare const zoneKeyToId: {
+    readonly AllZones: 0;
+    readonly CleanGridProject: 1;
+    readonly ComingSoonZone: 2;
+};
+export type ZoneKey = keyof typeof zoneKeyToId;
+export declare function getZoneId(name: ZoneKey): number;

package/dist/zones.js

@@ -1,8 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zoneMap = void 0;
+exports.zoneKeyToId = exports.zoneMap = void 0;
+exports.getZoneId = getZoneId;
 exports.zoneMap = {
-    "0": "All Zones",
-    "1": "Clean Grid Project",
-    "2": "Coming Soon Zone ",
+    0: "All Zones",
+    1: "Clean Grid Project",
+    2: "Coming Soon Zone ",
 };
+// Stable keys for zone lookup (do not change these keys, only the display names in zoneMap)
+exports.zoneKeyToId = {
+    AllZones: 0,
+    CleanGridProject: 1,
+    ComingSoonZone: 2,
+};
+function getZoneId(name) {
+    return exports.zoneKeyToId[name];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glowlabs-org/events-sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Typed event SDK for Glow, powered by RabbitMQ and Zod.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",