@studyportals/ws-client 0.1.1-beta.0 → 0.1.1-beta.1

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 export { eventBus } from './event-bus';
 export type { EventBus } from './event-bus';
 export { WebSocketManager } from './websocket-manager';
-export type { WsEventMap, WsIdentifiedPayload, CampaignSavingPayload, WebSocketManagerConfig, IncomingMessage, } from './types';
-export { wsIdentifiedPayloadSchema, campaignSavingPayloadSchema, incomingMessageSchema, } from './types';
+export type { WsEventMap, WsIdentifiedPayload, CampaignSavingPayload, WebSocketManagerConfig, IncomingMessage, ServerEventKey, ServerMessage, ServerMessageParsed, } from './types';
+export { wsIdentifiedPayloadSchema, campaignSavingPayloadSchema, incomingMessageSchema, serverMessageSchema, } from './types';
 export type { IWebSocketTransport } from './transport.interface';
 export { RealWebSocketTransport } from './transports/real.transport';
 export { MockWebSocketTransport } from './transports/mock.transport';

package/dist/index.js

@@ -3,7 +3,7 @@ export { eventBus } from './event-bus';
 // Manager
 export { WebSocketManager } from './websocket-manager';
 // Zod validators (useful for consumers and tests)
-export { wsIdentifiedPayloadSchema, campaignSavingPayloadSchema, incomingMessageSchema, } from './types';
+export { wsIdentifiedPayloadSchema, campaignSavingPayloadSchema, incomingMessageSchema, serverMessageSchema, } from './types';
 // Transport implementations
 export { RealWebSocketTransport } from './transports/real.transport';
 export { MockWebSocketTransport } from './transports/mock.transport';

package/dist/types/index.d.ts

@@ -6,3 +6,5 @@ export { campaignSavingPayloadSchema } from './campaign-saving';
 export type { WebSocketManagerConfig } from './ws-manager-config';
 export type { IncomingMessage } from './ws-message';
 export { incomingMessageSchema } from './ws-message';
+export type { ServerEventKey, ServerMessage, ServerMessageParsed } from './server-message';
+export { serverMessageSchema } from './server-message';

package/dist/types/index.js

@@ -1,3 +1,4 @@
 export { wsIdentifiedPayloadSchema } from './ws-identified';
 export { campaignSavingPayloadSchema } from './campaign-saving';
 export { incomingMessageSchema } from './ws-message';
+export { serverMessageSchema } from './server-message';

package/dist/types/server-message.d.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+import type { WsEventMap } from './ws-event-map';
+type ClientOnlyEvent = 'ws:connected' | 'ws:disconnected' | 'ws:error' | 'ws:max-retries-exceeded' | 'ws:unparseable';
+export type ServerEventKey = Exclude<keyof WsEventMap, ClientOnlyEvent>;
+export type ServerMessage = {
+    [K in ServerEventKey]: {
+        type: K;
+        payload: WsEventMap[K];
+    };
+}[ServerEventKey];
+export declare const serverMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"ws:identified">;
+    payload: z.ZodObject<{
+        connectionId: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"campaign:saving">;
+    payload: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        status: z.ZodLiteral<"start">;
+    }, z.core.$strip>, z.ZodObject<{
+        status: z.ZodLiteral<"success">;
+    }, z.core.$strip>, z.ZodObject<{
+        status: z.ZodLiteral<"failed">;
+        error: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, z.core.$strip>], "status">;
+}, z.core.$strip>], "type">;
+export type ServerMessageParsed = z.infer<typeof serverMessageSchema>;
+export {};

package/dist/types/server-message.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { wsIdentifiedPayloadSchema } from './ws-identified';
+import { campaignSavingPayloadSchema } from './campaign-saving';
+// ---------------------------------------------------------------------------
+// serverMessageSchema — Zod discriminated union over every server event.
+// Validates that an incoming frame is both structurally and semantically valid.
+//
+// NOTE: if you extend WsEventMap via module augmentation you must also add
+// the corresponding member to this schema.
+// ---------------------------------------------------------------------------
+export const serverMessageSchema = z.discriminatedUnion('type', [
+    z.object({ type: z.literal('ws:identified'), payload: wsIdentifiedPayloadSchema }),
+    z.object({ type: z.literal('campaign:saving'), payload: campaignSavingPayloadSchema }),
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyportals/ws-client",
-  "version": "0.1.1-beta.0",
+  "version": "0.1.1-beta.1",
   "description": "WebSocket client with reconnect, heartbeat, and typed event bus",
   "type": "module",
   "main": "dist/index.js",
@@ -12,7 +12,7 @@
   "scripts": {
     "build": "tsc",
     "type-check": "tsc --noEmit",
-	"release": "npm publish --access public",
+    "release": "npm publish --access public",
     "release:major": "npm run build && npm version major && npm run release",
     "release:minor": "npm run build && npm version minor && npm run release",
     "release:patch": "npm run build && npm version patch && npm run release",

package/dist/types.d.ts

@@ -1,46 +0,0 @@
-import type { IWebSocketTransport } from './transport.interface';
-export type WsIdentifiedPayload = {
-    connectionId: string;
-};
-export type CampaignSavingPayload = {
-    status: 'success' | 'start' | 'failed';
-    error?: Record<string, unknown>;
-};
-export type UserUpdatedPayload = {
-    userId: string;
-    [key: string]: unknown;
-};
-export type NotificationReceivedPayload = {
-    id: string;
-    message: string;
-    [key: string]: unknown;
-};
-export interface WsEventMap {
-    'ws:connected': undefined;
-    'ws:disconnected': CloseEvent;
-    'ws:error': Event;
-    'ws:max-retries-exceeded': undefined;
-    'ws:unparseable': string;
-    /** Emitted when the server sends a message with type "ws:identified". */
-    'ws:identified': WsIdentifiedPayload;
-    'campaign:saving': CampaignSavingPayload;
-    'user:updated': UserUpdatedPayload;
-    'notification:received': NotificationReceivedPayload;
-}
-export interface WebSocketManagerConfig {
-    /** WebSocket endpoint URL (e.g. "wss://api.example.com/ws"). */
-    url: string;
-    /** Transport implementation. Use RealWebSocketTransport in production,
-     *  MockWebSocketTransport in tests. */
-    transport: IWebSocketTransport;
-    /** Maximum number of reconnect attempts before giving up. Default: 10. */
-    maxReconnectAttempts?: number;
-    /** Base delay (ms) for exponential backoff. Default: 500. */
-    baseReconnectDelayMs?: number;
-    /** Upper cap (ms) for reconnect delay. Default: 30 000. */
-    maxReconnectDelayMs?: number;
-    /** Interval (ms) between heartbeat messages while connected. Default: 30 000. */
-    heartbeatIntervalMs?: number;
-    /** Payload sent as the heartbeat message. Default: `{ "type": "ping" }`. */
-    heartbeatMessage?: Record<string, unknown>;
-}

package/dist/types.js

@@ -1 +0,0 @@
-export {};