refactor: replace string event IDs with EventID

packages/core/src/events/eventBase.ts

@@ -1,8 +1,9 @@
 import { Pdu, PduForType } from '@hs/room';
+import type { EventID } from '@hs/room';
 
 export type EventBase = {
-	auth_events: string[];
-	prev_events: string[];
+	auth_events: EventID[];
+	prev_events: EventID[];
 	type:
 		| 'm.room.member'
 		| 'm.room.create'
@@ -32,7 +33,7 @@ export type EventBase = {
 };
 
 export type RedactedEvent = EventBase & {
-	redacts: string;
+	redacts: EventID;
 	type: 'm.room.redaction';
 };
 
@@ -51,8 +52,8 @@ export const createEventBase = <T extends KeyEvent>(
 	props: {
 		roomId: string;
 		sender: string;
-		auth_events?: string[];
-		prev_events?: string[];
+		auth_events?: EventID[];
+		prev_events?: EventID[];
 		depth: number;
 		content: Events[T]['content'];
 		state_key?: string;
@@ -92,8 +93,8 @@ const _createEventBase = <
 }: {
 	roomId: string;
 	sender: string;
-	auth_events?: string[];
-	prev_events?: string[];
+	auth_events?: EventID[];
+	prev_events?: EventID[];
 	depth: number;
 	type: string;
 	content?: TContent;

packages/core/src/events/m.reaction.ts

@@ -1,3 +1,4 @@
+import type { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -7,7 +8,7 @@ declare module './eventBase' {
 			content: {
 				'm.relates_to': {
 					rel_type: 'm.annotation';
-					event_id: string;
+					event_id: EventID;
 					key: string;
 				};
 			};
@@ -19,9 +20,9 @@ declare module './eventBase' {
 }
 
 export type ReactionAuthEvents = {
-	'm.room.create': string | undefined;
-	'm.room.power_levels': string | undefined;
-	'm.room.member': string | undefined;
+	'm.room.create': EventID | undefined;
+	'm.room.power_levels': EventID | undefined;
+	'm.room.member': EventID | undefined;
 };
 
 export const isReactionEvent = (event: EventBase): event is ReactionEvent => {
@@ -33,7 +34,7 @@ export interface ReactionEvent extends EventBase {
 	content: {
 		'm.relates_to': {
 			rel_type: 'm.annotation';
-			event_id: string;
+			event_id: EventID;
 			key: string;
 		};
 	};
@@ -62,12 +63,12 @@ export const reactionEvent = ({
 	roomId: string;
 	sender: string;
 	auth_events: ReactionAuthEvents;
-	prev_events: string[];
+	prev_events: EventID[];
 	depth: number;
 	content: {
 		'm.relates_to': {
 			rel_type: 'm.annotation';
-			event_id: string;
+			event_id: EventID;
 			key: string;
 		};
 	};

packages/core/src/events/m.room.guest_access.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -24,8 +25,8 @@ export const roomGuestAccessEvent = ({
 }: {
 	roomId: string;
 	sender: string;
-	auth_events: string[];
-	prev_events: string[];
+	auth_events: EventID[];
+	prev_events: EventID[];
 	depth: number;
 	ts?: number;
 }) => {

packages/core/src/events/m.room.history_visibility.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -26,8 +27,8 @@ export const roomHistoryVisibilityEvent = ({
 }: {
 	roomId: string;
 	sender: string;
-	auth_events: string[];
-	prev_events: string[];
+	auth_events: EventID[];
+	prev_events: EventID[];
 	depth: number;
 	ts?: number;
 }) => {

packages/core/src/events/m.room.join_rules.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -33,8 +34,8 @@ export const roomJoinRulesEvent = ({
 }: {
 	roomId: string;
 	sender: string;
-	auth_events: string[];
-	prev_events: string[];
+	auth_events: EventID[];
+	prev_events: EventID[];
 	depth: number;
 	ts?: number;
 }) => {

packages/core/src/events/m.room.member.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { createEventBase } from './eventBase';
 import type { Membership, RoomMemberEvent } from './isRoomMemberEvent';
 import { createEventWithId } from './utils/createSignedEvent';
@@ -18,12 +19,12 @@ declare module './eventBase' {
 }
 
 export type AuthEvents = {
-	'm.room.create': string;
-	'm.room.power_levels'?: string;
-	'm.room.join_rules'?: string;
-	'm.room.history_visibility'?: string;
+	'm.room.create': EventID;
+	'm.room.power_levels'?: EventID;
+	'm.room.join_rules'?: EventID;
+	'm.room.history_visibility'?: EventID;
 } & {
-	[K in `m.room.member:${string}`]?: string;
+	[K in `m.room.member:${string}`]?: EventID;
 };
 
 const isTruthy = <T>(
@@ -50,7 +51,7 @@ export const roomMemberEvent = ({
 	sender: string;
 	state_key: string;
 	auth_events: AuthEvents;
-	prev_events: string[];
+	prev_events: EventID[];
 	depth: number;
 	unsigned?: RoomMemberEvent['unsigned'];
 	content?: Record<string, any>;

packages/core/src/events/m.room.message.ts

@@ -1,3 +1,4 @@
+import type { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -74,14 +75,14 @@ declare module './eventBase' {
 
 export type MessageRelation = {
 	rel_type: RelationType;
-	event_id: string;
+	event_id: EventID;
 } & (RelationTypeReplace | Record<string, never>);
 
 export type RelationType = 'm.replace' | 'm.annotation';
 
 export type RelationTypeReplace = {
 	rel_type: 'm.replace';
-	event_id: string;
+	event_id: EventID;
 	'm.new_content'?: {
 		body: string;
 		msgtype: MessageType;
@@ -91,9 +92,9 @@ export type RelationTypeReplace = {
 };
 
 export type MessageAuthEvents = {
-	'm.room.create': string;
-	'm.room.power_levels': string;
-	'm.room.member': string;
+	'm.room.create': EventID;
+	'm.room.power_levels': EventID;
+	'm.room.member': EventID;
 };
 
 export const isRoomMessageEvent = (
@@ -137,7 +138,7 @@ export const roomMessageEvent = ({
 	roomId: string;
 	sender: string;
 	auth_events: MessageAuthEvents;
-	prev_events: string[];
+	prev_events: EventID[];
 	depth: number;
 	unsigned?: RoomMessageEvent['unsigned'];
 	content: (

packages/core/src/events/m.room.name.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -16,9 +17,9 @@ declare module './eventBase' {
 }
 
 export type RoomNameAuthEvents = {
-	'm.room.create': string;
-	'm.room.power_levels': string;
-	'm.room.member': string;
+	'm.room.create': EventID;
+	'm.room.power_levels': EventID;
+	'm.room.member': EventID;
 };
 
 export const isRoomNameEvent = (event: EventBase): event is RoomNameEvent => {
@@ -52,7 +53,7 @@ export const roomNameEvent = ({
 	roomId: string;
 	sender: string;
 	auth_events: RoomNameAuthEvents;
-	prev_events: string[];
+	prev_events: EventID[];
 	depth: number;
 	content: {
 		name: string;

packages/core/src/events/m.room.power_levels.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -53,11 +54,11 @@ export const roomPowerLevelsEvent = ({
 	roomId: string;
 	members: [sender: string, ...member: string[]];
 	auth_events: {
-		'm.room.create': string;
-		'm.room.power_levels': string;
-		'm.room.member': string; // TODO: Based on the tests, this is optional, based on the code, this is required check this
+		'm.room.create': EventID;
+		'm.room.power_levels': EventID;
+		'm.room.member': EventID; // TODO: Based on the tests, this is optional, based on the code, this is required check this
 	};
-	prev_events: string[];
+	prev_events: EventID[];
 	depth: number;
 	content?: RoomPowerLevelsEvent['content'];
 	ts?: number;
@@ -70,7 +71,7 @@ export const roomPowerLevelsEvent = ({
 			auth_events['m.room.create'],
 			auth_events['m.room.power_levels'],
 			auth_events['m.room.member'],
-		].filter(Boolean) as string[],
+		].filter(Boolean) as EventID[],
 		prev_events,
 		depth,
 		ts,

packages/core/src/events/m.room.redaction.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -8,9 +9,9 @@ declare module './eventBase' {
 }
 
 export type RedactionAuthEvents = {
-	'm.room.create': string | undefined;
-	'm.room.power_levels': string | undefined;
-	'm.room.member'?: string | undefined;
+	'm.room.create': EventID | undefined;
+	'm.room.power_levels': EventID | undefined;
+	'm.room.member'?: EventID | undefined;
 };
 
 export const isRedactionEvent = (event: EventBase): event is RedactionEvent => {
@@ -24,7 +25,7 @@ export interface RedactionEvent extends EventBase {
 	unsigned: {
 		age_ts: number;
 	};
-	redacts: string;
+	redacts: EventID;
 }
 
 const isTruthy = <T>(
@@ -47,10 +48,10 @@ export const redactionEvent = ({
 	roomId: string;
 	sender: string;
 	auth_events: RedactionAuthEvents;
-	prev_events: string[];
+	prev_events: EventID[];
 	depth: number;
 	content: {
-		redacts: string;
+		redacts: EventID;
 		reason?: string;
 	};
 	origin?: string;

packages/core/src/events/m.room.tombstone.ts

@@ -1,3 +1,4 @@
+import { EventID } from '@hs/room';
 import { type EventBase, createEventBase } from './eventBase';
 import { createEventWithId } from './utils/createSignedEvent';
 
@@ -20,9 +21,9 @@ declare module './eventBase' {
 }
 
 export type TombstoneAuthEvents = {
-	'm.room.create': string;
-	'm.room.power_levels': string;
-	'm.room.member': string;
+	'm.room.create': EventID | undefined;
+	'm.room.power_levels': EventID | undefined;
+	'm.room.member': EventID | undefined;
 };
 
 type RoomTombstoneEventProps = {
@@ -31,7 +32,7 @@ type RoomTombstoneEventProps = {
 	body: string;
 	replacementRoom?: string;
 	auth_events: TombstoneAuthEvents;
-	prev_events: string[];
+	prev_events: EventID[];
 	depth: number;
 	ts?: number;
 	origin?: string;

packages/core/src/models/event.model.ts

@@ -1,10 +1,10 @@
-import { Pdu, PduForType } from '@hs/room';
+import { EventID, Pdu, PduForType } from '@hs/room';
 import type { EventBase as CoreEventBase } from '../events/eventBase';
 
 // TODO: use room package
 
 interface PersistentEventBase<E = Pdu> {
-	_id: string;
+	_id: EventID;
 	event: E;
 
 	origin: string;

packages/core/src/types.ts

@@ -1,11 +1,12 @@
 import { Pdu } from '@hs/room';
+import type { EventID } from '@hs/room';
 
 export enum EncryptionValidAlgorithm {
 	ed25519 = 'ed25519',
 }
 
 export type SignedEvent<T extends Pdu> = T & {
-	event_id: string;
+	event_id: EventID;
 	hashes: {
 		sha256: string;
 	};

packages/core/src/utils/generateId.ts

@@ -1,14 +1,15 @@
 import crypto from 'node:crypto';
+import { EventID } from '@hs/room';
 import { toUnpaddedBase64 } from './binaryData';
 import { pruneEventDict } from './pruneEventDict';
 import { encodeCanonicalJson } from './signJson';
 
-export function generateId<T extends object>(content: T): string {
+export function generateId<T extends object>(content: T): EventID {
 	// remove the fields that are not part of the hash
 	const { unsigned, signatures, ...toHash } = pruneEventDict(content as any);
 
 	return `\$${toUnpaddedBase64(
 		crypto.createHash('sha256').update(encodeCanonicalJson(toHash)).digest(),
 		{ urlSafe: true },
-	)}`;
+	)}` as EventID;
 }