@decentrl/sdk 0.0.7 → 0.0.8

package/src/types.ts

@@ -17,26 +17,120 @@ export type EventDefinitions = Record<
 	}
 >;
 
+// --- Public Event Definition Types ---
+
+export interface PublicEventDefinition<TSchema extends z.ZodType = z.ZodType> {
+	schema: TSchema;
+	tags: string[];
+	channelId: string;
+}
+
+export type PublicEventDefinitions = Record<
+	string,
+	{
+		schema: z.ZodType;
+		tags: string[];
+		channelId: string;
+	}
+>;
+
+// --- Channel Definition Types (external public channels you read) ---
+
+export interface ChannelDefinition<TSchema extends z.ZodType = z.ZodType> {
+	schema: TSchema;
+}
+
+export type ChannelDefinitions = Record<
+	string,
+	{
+		schema: z.ZodType;
+	}
+>;
+
+// --- Public Event Meta & Envelope ---
+
+export interface PublicEventMeta {
+	publisherDid: string;
+	timestamp: number;
+	eventId: string;
+	channelId: string;
+}
+
+export interface PublicEventEnvelope {
+	type: string;
+	data: unknown;
+	meta: PublicEventMeta;
+	tags?: string[];
+}
+
+// --- Channel Subscription/Fetch ---
+
+export interface ChannelSubscriptionConfig {
+	did: string;
+	channelId: string;
+	tags?: string[];
+	pollIntervalMs?: number;
+}
+
+export interface ChannelFetchOptions {
+	did: string;
+	mediatorEndpoint?: string;
+	channelId?: string;
+	tags?: string[];
+	afterTimestamp?: number;
+	beforeTimestamp?: number;
+	pagination?: { page: number; pageSize: number };
+}
+
+// --- Reducer Key Inference ---
+
+// Builds a typed reduce map from all three event sources:
+// - Private events: key matches TEvents, data inferred from schema, meta = EventMeta
+// - Public events: key is `public:${K}` where K is in TPublicEvents, data inferred, meta = PublicEventMeta
+// - Channel events: key is `channel:${K}` where K is in TChannels, data inferred, meta = PublicEventMeta
+type PrivateReducers<TSlice, TEvents extends EventDefinitions> = {
+	[K in string & keyof TEvents]?: (
+		state: TSlice,
+		data: z.infer<TEvents[K]['schema']>,
+		meta: EventMeta,
+	) => TSlice;
+};
+
+type PublicReducers<TSlice, TPublicEvents extends PublicEventDefinitions> = {
+	[K in string & keyof TPublicEvents as `public:${K}`]?: (
+		state: TSlice,
+		data: z.infer<TPublicEvents[K]['schema']>,
+		meta: PublicEventMeta,
+	) => TSlice;
+};
+
+type ChannelReducers<TSlice, TChannels extends ChannelDefinitions> = {
+	[K in string & keyof TChannels as `channel:${K}`]?: (
+		state: TSlice,
+		data: z.infer<TChannels[K]['schema']>,
+		meta: PublicEventMeta,
+	) => TSlice;
+};
+
 // --- State Slice Types ---
 
 export interface StateSliceDefinition<
 	TSlice = unknown,
 	TEvents extends EventDefinitions = EventDefinitions,
+	TPublicEvents extends PublicEventDefinitions = PublicEventDefinitions,
+	TChannels extends ChannelDefinitions = ChannelDefinitions,
 > {
 	initial: TSlice;
-	reduce: {
-		[K in keyof TEvents]?: (
-			state: TSlice,
-			data: z.infer<TEvents[K]['schema']>,
-			meta: EventMeta,
-		) => TSlice;
-	};
+	reduce: PrivateReducers<TSlice, TEvents> &
+		PublicReducers<TSlice, TPublicEvents> &
+		ChannelReducers<TSlice, TChannels>;
 }
 
-export type StateDefinitions<TEvents extends EventDefinitions = EventDefinitions> = Record<
-	string,
-	StateSliceDefinition<any, TEvents>
->;
+export type StateDefinitions<
+	TEvents extends EventDefinitions = EventDefinitions,
+	TPublicEvents extends PublicEventDefinitions = PublicEventDefinitions,
+	TChannels extends ChannelDefinitions = ChannelDefinitions,
+> = Record<string, StateSliceDefinition<unknown, TEvents, TPublicEvents, TChannels>>;
 
 // --- Inferred State ---
 
@@ -64,7 +158,7 @@ export interface EventEnvelope {
 // --- Client Config ---
 
 export interface DecentrlClientConfig {
-	mediatorDid: string;
+	mediatorDid?: string;
 	/** Enable localStorage persistence. Pass a key prefix (e.g. "decentrl-myapp"). */
 	persist?: { key: string };
 	/** Optional transport layer. Defaults to DirectTransport (direct HTTP to mediator). */
@@ -75,10 +169,18 @@ export interface DecentrlClientConfig {
 
 export interface DecentrlAppConfig<
 	TEvents extends EventDefinitions = EventDefinitions,
-	TState extends StateDefinitions<TEvents> = StateDefinitions<TEvents>,
+	TPublicEvents extends PublicEventDefinitions = PublicEventDefinitions,
+	TChannels extends ChannelDefinitions = ChannelDefinitions,
+	TState extends StateDefinitions<TEvents, TPublicEvents, TChannels> = StateDefinitions<
+		TEvents,
+		TPublicEvents,
+		TChannels
+	>,
 > {
 	events: TEvents;
 	state: TState;
+	publicEvents?: TPublicEvents;
+	channels?: TChannels;
 }
 
 // --- Serialized Identity ---
@@ -162,6 +264,29 @@ export interface PaginatedResult<T> {
 	pagination: PaginationMeta;
 }
 
+// --- Public Query Options ---
+
+export interface PublicQueryOptions {
+	publisherDid: string;
+	mediatorEndpoint?: string;
+	channelId?: string;
+	tags?: string[];
+	/** Unix timestamp in seconds */
+	afterTimestamp?: number;
+	/** Unix timestamp in seconds */
+	beforeTimestamp?: number;
+	pagination?: { page: number; pageSize: number };
+}
+
+export interface PublicEventResult {
+	id: string;
+	channelId: string;
+	event: string;
+	tags: string[];
+	timestamp: number;
+	eventSignature: string;
+}
+
 // --- Publish Options ---
 
 export interface PublishOptions {