refactor(common): replace enum with const (#14)

packages/common/src/client-context.ts

@@ -1,6 +1,6 @@
 import { randomUUID } from 'crypto';
 import { LRUCache } from 'lru-cache';
-import { ClientReadyState } from './enums/client.enum';
+import { ClientReadyState } from './constants';
 import { Client } from './interfaces/client.interface';
 import { Filter } from './interfaces/filter.interface';
 import { OutgoingMessage } from './interfaces/message.interface';

packages/common/src/constants/client.const.ts

@@ -0,0 +1,11 @@
+/**
+ * Same as WebSocket readyState
+ */
+export const ClientReadyState = {
+  CONNECTING: 0,
+  OPEN: 1,
+  CLOSING: 2,
+  CLOSED: 3,
+} as const;
+export type ClientReadyState =
+  (typeof ClientReadyState)[keyof typeof ClientReadyState];

packages/common/src/constants/event.const.ts

@@ -0,0 +1,67 @@
+export const EventType = {
+  /**
+   * Regular event
+   */
+  REGULAR: 'REGULAR',
+  /**
+   * Replaceable event
+   */
+  REPLACEABLE: 'REPLACEABLE',
+  /**
+   * Ephemeral event
+   */
+  EPHEMERAL: 'EPHEMERAL',
+  /**
+   * Parameterized replaceable event
+   */
+  PARAMETERIZED_REPLACEABLE: 'PARAMETERIZED_REPLACEABLE',
+} as const;
+export type EventType = (typeof EventType)[keyof typeof EventType];
+
+/**
+ * Some special event kinds
+ */
+export const EventKind = {
+  SET_METADATA: 0,
+  TEXT_NOTE: 1,
+  RECOMMEND_SERVER: 2,
+  CONTACT_LIST: 3,
+  ENCRYPTED_DIRECT_MESSAGE: 4,
+  DELETION: 5,
+  // Channel
+  CHANNEL_CREATION: 40,
+  CHANNEL_METADATA: 41,
+  CHANNEL_MESSAGE: 42,
+  CHANNEL_HIDE_MESSAGE: 43,
+  CHANNEL_MUTE_USER: 44,
+  CHANNEL_RESERVE_FIRST: 45,
+  CHANNEL_RESERVE_LAST: 49,
+  // Regular Events
+  REGULAR_FIRST: 1000,
+  REGULAR_LAST: 9999,
+  // Replaceable Events
+  REPLACEABLE_FIRST: 10000,
+  REPLACEABLE_LAST: 19999,
+  // Ephemeral Events
+  EPHEMERAL_FIRST: 20000,
+  AUTHENTICATION: 22242,
+  EPHEMERAL_LAST: 29999,
+  // Parameterized Replaceable Events
+  PARAMETERIZED_REPLACEABLE_FIRST: 30000,
+  LONG_FORM_CONTENT: 30023,
+  PARAMETERIZED_REPLACEABLE_LAST: 39999,
+};
+export type EventKind = number;
+
+export const TagName = {
+  EVENT_COORDINATES: 'a',
+  EVENT: 'e',
+  PUBKEY: 'p',
+  D: 'd',
+  NONCE: 'nonce',
+  EXPIRATION: 'expiration',
+  DELEGATION: 'delegation',
+  RELAY: 'relay',
+  CHALLENGE: 'challenge',
+} as const;
+export type TagName = (typeof TagName)[keyof typeof TagName];

packages/common/src/constants/index.ts

@@ -0,0 +1,4 @@
+export * from './client.const';
+export * from './event.const';
+export * from './logger.const';
+export * from './message.const';

packages/common/src/constants/logger.const.ts

@@ -0,0 +1,7 @@
+export const LogLevel = {
+  DEBUG: 0,
+  INFO: 1,
+  WARN: 2,
+  ERROR: 3,
+} as const;
+export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];

packages/common/src/constants/message.const.ts

@@ -0,0 +1,11 @@
+export const MessageType = {
+  REQ: 'REQ',
+  EVENT: 'EVENT',
+  CLOSE: 'CLOSE',
+  AUTH: 'AUTH',
+  EOSE: 'EOSE',
+  OK: 'OK',
+  NOTICE: 'NOTICE',
+  CLOSED: 'CLOSED',
+} as const;
+export type MessageType = (typeof MessageType)[keyof typeof MessageType];

packages/common/src/index.ts

@@ -1,5 +1,5 @@
 export * from './client-context';
-export * from './enums';
+export * from './constants';
 export * from './errors';
 export * from './interfaces';
 export * from './services';

packages/common/src/interfaces/client.interface.ts

@@ -1,4 +1,4 @@
-import { ClientReadyState } from '../enums';
+import { ClientReadyState } from '../constants';
 
 /**
  * Client interface. Usually a WebSocket.

packages/common/src/interfaces/logger.interface.ts

@@ -1,4 +1,4 @@
-import { LogLevel } from '../enums';
+import { LogLevel } from '../constants';
 
 export interface Logger {
   setLogLevel(level: LogLevel): void;

packages/common/src/interfaces/message.interface.ts

@@ -1,19 +1,8 @@
+import { MessageType } from '../constants';
 import { EventId, SubscriptionId } from './common.interface';
 import { Event } from './event.interface';
 import { Filter } from './filter.interface';
 
-export const MessageType = {
-  REQ: 'REQ',
-  EVENT: 'EVENT',
-  CLOSE: 'CLOSE',
-  AUTH: 'AUTH',
-  EOSE: 'EOSE',
-  OK: 'OK',
-  NOTICE: 'NOTICE',
-  CLOSED: 'CLOSED',
-} as const;
-export type TMessageType = (typeof MessageType)[keyof typeof MessageType];
-
 export type IncomingMessage =
   | IncomingEventMessage
   | IncomingReqMessage

packages/common/src/services/console-logger.service.ts

@@ -1,4 +1,4 @@
-import { LogLevel } from '../enums';
+import { LogLevel } from '../constants';
 import { Logger } from '../interfaces';
 
 export class ConsoleLoggerService implements Logger {

packages/common/src/utils/event.util.ts

@@ -1,4 +1,4 @@
-import { EventKind, EventType, TagName } from '../enums';
+import { EventKind, EventType, TagName } from '../constants';
 import { Event, Filter, Tag } from '../interfaces';
 import { schnorrVerify, sha256 } from './crypto.util';
 import { countPowDifficulty } from './proof-of-work.util';

packages/common/src/utils/filter.util.ts

@@ -1,4 +1,4 @@
-import { EventKind } from '../enums';
+import { EventKind } from '../constants';
 import { Filter } from '../interfaces';
 
 export class FilterUtils {