@voidhash/mimic-effect 0.0.9 → 1.0.0-beta.2

package/dist/Protocol.d.mts

@@ -0,0 +1,203 @@
+import { Permission, PresenceEntry } from "./Types.mjs";
+import { MessageParseError } from "./Errors.mjs";
+import { Effect } from "effect";
+import { Transaction } from "@voidhash/mimic";
+
+//#region src/Protocol.d.ts
+declare namespace Protocol_d_exports {
+  export { AuthMessage, AuthResultMessage, ClientMessage, EncodedClientMessage, EncodedServerMessage, ErrorMessage, PingMessage, PongMessage, PresenceClearMessage, PresenceRemoveMessage, PresenceSetMessage, PresenceSnapshotMessage, PresenceUpdateMessage, RequestSnapshotMessage, ServerBroadcast, ServerMessage, SnapshotMessage, SubmitMessage, TransactionMessage, authResultFailure, authResultSuccess, decodeClientMessage, encodeServerMessage, errorMessage, parseClientMessage, pong, presenceRemoveMessage, presenceSnapshotMessage, presenceUpdateMessage, snapshotMessage, transactionMessage };
+}
+/**
+ * Authentication request
+ */
+interface AuthMessage {
+  readonly type: "auth";
+  readonly token: string;
+}
+/**
+ * Heartbeat ping
+ */
+interface PingMessage {
+  readonly type: "ping";
+}
+/**
+ * Submit a transaction
+ */
+interface SubmitMessage {
+  readonly type: "submit";
+  readonly transaction: Transaction.Transaction;
+}
+/**
+ * Request current document snapshot
+ */
+interface RequestSnapshotMessage {
+  readonly type: "request_snapshot";
+}
+/**
+ * Set presence data
+ */
+interface PresenceSetMessage {
+  readonly type: "presence_set";
+  readonly data: unknown;
+}
+/**
+ * Clear presence data
+ */
+interface PresenceClearMessage {
+  readonly type: "presence_clear";
+}
+/**
+ * Union of all client messages
+ */
+type ClientMessage = AuthMessage | PingMessage | SubmitMessage | RequestSnapshotMessage | PresenceSetMessage | PresenceClearMessage;
+/**
+ * Authentication result
+ */
+interface AuthResultMessage {
+  readonly type: "auth_result";
+  readonly success: boolean;
+  readonly error?: string;
+  readonly userId?: string;
+  readonly permission?: Permission;
+}
+/**
+ * Heartbeat pong
+ */
+interface PongMessage {
+  readonly type: "pong";
+}
+/**
+ * Transaction broadcast
+ */
+interface TransactionMessage {
+  readonly type: "transaction";
+  readonly transaction: Transaction.Transaction;
+  readonly version: number;
+}
+/**
+ * Document snapshot
+ */
+interface SnapshotMessage {
+  readonly type: "snapshot";
+  readonly state: unknown;
+  readonly version: number;
+}
+/**
+ * Transaction error
+ */
+interface ErrorMessage {
+  readonly type: "error";
+  readonly transactionId: string;
+  readonly reason: string;
+}
+/**
+ * Presence update broadcast
+ */
+interface PresenceUpdateMessage {
+  readonly type: "presence_update";
+  readonly id: string;
+  readonly data: unknown;
+  readonly userId?: string;
+}
+/**
+ * Presence removal broadcast
+ */
+interface PresenceRemoveMessage {
+  readonly type: "presence_remove";
+  readonly id: string;
+}
+/**
+ * Presence snapshot (sent after auth)
+ */
+interface PresenceSnapshotMessage {
+  readonly type: "presence_snapshot";
+  readonly selfId: string;
+  readonly presences: Record<string, PresenceEntry>;
+}
+/**
+ * Union of all server messages
+ */
+type ServerMessage = AuthResultMessage | PongMessage | TransactionMessage | SnapshotMessage | ErrorMessage | PresenceUpdateMessage | PresenceRemoveMessage | PresenceSnapshotMessage;
+/**
+ * Server broadcast messages (transaction or error)
+ */
+type ServerBroadcast = TransactionMessage | ErrorMessage;
+/**
+ * Encoded client message (with encoded transaction)
+ */
+interface EncodedClientMessage {
+  readonly type: string;
+  readonly token?: string;
+  readonly transaction?: Transaction.EncodedTransaction;
+  readonly data?: unknown;
+}
+/**
+ * Encoded server message (with encoded transaction)
+ */
+interface EncodedServerMessage {
+  readonly type: string;
+  readonly success?: boolean;
+  readonly error?: string;
+  readonly userId?: string;
+  readonly permission?: Permission;
+  readonly transaction?: Transaction.EncodedTransaction;
+  readonly version?: number;
+  readonly state?: unknown;
+  readonly transactionId?: string;
+  readonly reason?: string;
+  readonly id?: string;
+  readonly data?: unknown;
+  readonly selfId?: string;
+  readonly presences?: Record<string, PresenceEntry>;
+}
+/**
+ * Decode an encoded client message to a ClientMessage
+ */
+declare const decodeClientMessage: (encoded: EncodedClientMessage) => ClientMessage;
+/**
+ * Encode a server message for wire format
+ */
+declare const encodeServerMessage: (message: ServerMessage) => string;
+/**
+ * Parse a raw WebSocket message to a ClientMessage
+ */
+declare const parseClientMessage: (data: string | ArrayBuffer | Uint8Array) => Effect.Effect<ClientMessage, MessageParseError>;
+/**
+ * Create an auth result success message
+ */
+declare const authResultSuccess: (userId: string, permission: Permission) => AuthResultMessage;
+/**
+ * Create an auth result failure message
+ */
+declare const authResultFailure: (error: string) => AuthResultMessage;
+/**
+ * Create a pong message
+ */
+declare const pong: () => PongMessage;
+/**
+ * Create a transaction message
+ */
+declare const transactionMessage: (transaction: Transaction.Transaction, version: number) => TransactionMessage;
+/**
+ * Create a snapshot message
+ */
+declare const snapshotMessage: (state: unknown, version: number) => SnapshotMessage;
+/**
+ * Create an error message
+ */
+declare const errorMessage: (transactionId: string, reason: string) => ErrorMessage;
+/**
+ * Create a presence update message
+ */
+declare const presenceUpdateMessage: (id: string, data: unknown, userId?: string) => PresenceUpdateMessage;
+/**
+ * Create a presence remove message
+ */
+declare const presenceRemoveMessage: (id: string) => PresenceRemoveMessage;
+/**
+ * Create a presence snapshot message
+ */
+declare const presenceSnapshotMessage: (selfId: string, presences: Record<string, PresenceEntry>) => PresenceSnapshotMessage;
+//#endregion
+export { Protocol_d_exports, ServerBroadcast, ServerMessage, SnapshotMessage };
+//# sourceMappingURL=Protocol.d.mts.map

package/dist/Protocol.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Protocol.d.mts","names":[],"sources":["../src/Protocol.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;UAiBiB,WAAA;;;;;;;UAQA,WAAA;;;;;;UAOA,aAAA;;wBAEO,WAAA,CAAY;;;;;UAMnB,sBAAA;;;;;;UAOA,kBAAA;;EA9BA,SAAA,IAAA,EAAW,OAAA;AAQ5B;AAOA;AAQA;AAOA;AAQiB,UAAA,oBAAA,CAAoB;EAOzB,SAAA,IAAA,EAAA,gBAAa;;;;;AAKrB,KALQ,aAAA,GACR,WAIA,GAHA,WAGA,GAFA,aAEA,GADA,sBACA,GAAA,kBAAA,GACA,oBADA;;;AAUJ;AAWiB,UAXA,iBAAA,CAWW;EAOX,SAAA,IAAA,EAAA,aAAkB;EASlB,SAAA,OAAA,EAAe,OAAA;EASf,SAAA,KAAA,CAAY,EAAA,MAAA;EASZ,SAAA,MAAA,CAAA,EAAA,MAAqB;EAUrB,SAAA,UAAA,CAAA,EAlDO,UAkDc;AAQtC;AASA;;;AAGI,UAhEa,WAAA,CAgEb;EACA,SAAA,IAAA,EAAA,MAAA;;;;;AAIuB,UA9DV,kBAAA,CA8DU;EAKf,SAAA,IAAA,EAAA,aAAe;EASV,SAAA,WAAA,EA1EO,WAAA,CAAY,WA6EX;EAOR,SAAA,OAAA,EAAA,MAAoB;;;;;AAcR,UA3FZ,eAAA,CA2FY;EAUhB,SAAA,IAAA,EAAA,UAUZ;EAKY,SAAA,KAAA,EAAA,OAUZ;EAKY,SAAA,OAAA,EAAA,MAeT;;;;;AAbD,UA5Hc,YAAA,CA4HP;EAAM,SAAA,IAAA,EAAA,OAAA;EAkBH,SAAA,aAQX,EAAA,MAAA;EAKW,SAAA,MAAA,EAAA,MAIX;AAKF;AAKA;AAYA;AAYA;AAYa,UApMI,qBAAA,CA6Mf;EAKW,SAAA,IAAA,EAAA,iBAKX;EAKW,SAAA,EAAA,EAAA,MAAA;EAEe,SAAA,IAAA,EAAA,OAAA;EAAf,SAAA,MAAA,CAAA,EAAA,MAAA;;;;;UApNI,qBAAA;;;;;;;UAQA,uBAAA;;;sBAGK,eAAe;;;;;KAMzB,aAAA,GACR,oBACA,cACA,qBACA,kBACA,eACA,wBACA,wBACA;;;;KAKQ,eAAA,GAAkB,qBAAqB;;;;UASlC,oBAAA;;;yBAGQ,WAAA,CAAY;;;;;;UAOpB,oBAAA;;;;;wBAKO;yBACC,WAAA,CAAY;;;;;;;;uBAQd,eAAe;;;;;cAUzB,+BACF,yBACR;;;;cAaU,+BAAgC;;;;cAehC,oCACI,cAAc,eAC5B,MAAA,CAAO,OAAO,eAAe;;;;cAkBnB,gDAEC,eACX;;;;cAUU,sCAAqC;;;;cASrC,YAAW;;;;cAKX,kCACE,WAAA,CAAY,iCAExB;;;;cASU,sDAGV;;;;cASU,yDAGV;;;;cASU,uEAIV;;;;cAUU,uCAEV;;;;cAQU,qDAEA,eAAe,mBACzB"}

package/dist/Protocol.mjs

@@ -0,0 +1,132 @@
+import { __export } from "./_virtual/rolldown_runtime.mjs";
+import { MessageParseError } from "./Errors.mjs";
+import { Effect } from "effect";
+import { Transaction } from "@voidhash/mimic";
+
+//#region src/Protocol.ts
+/**
+* @voidhash/mimic-effect - WebSocket Protocol
+*
+* Message types and encoding/decoding for WebSocket communication.
+*/
+var Protocol_exports = /* @__PURE__ */ __export({
+	authResultFailure: () => authResultFailure,
+	authResultSuccess: () => authResultSuccess,
+	decodeClientMessage: () => decodeClientMessage,
+	encodeServerMessage: () => encodeServerMessage,
+	errorMessage: () => errorMessage,
+	parseClientMessage: () => parseClientMessage,
+	pong: () => pong,
+	presenceRemoveMessage: () => presenceRemoveMessage,
+	presenceSnapshotMessage: () => presenceSnapshotMessage,
+	presenceUpdateMessage: () => presenceUpdateMessage,
+	snapshotMessage: () => snapshotMessage,
+	transactionMessage: () => transactionMessage
+});
+/**
+* Decode an encoded client message to a ClientMessage
+*/
+const decodeClientMessage = (encoded) => {
+	if (encoded.type === "submit" && encoded.transaction) return {
+		type: "submit",
+		transaction: Transaction.decode(encoded.transaction)
+	};
+	return encoded;
+};
+/**
+* Encode a server message for wire format
+*/
+const encodeServerMessage = (message) => {
+	if (message.type === "transaction") {
+		const encoded = {
+			type: "transaction",
+			transaction: Transaction.encode(message.transaction),
+			version: message.version
+		};
+		return JSON.stringify(encoded);
+	}
+	return JSON.stringify(message);
+};
+/**
+* Parse a raw WebSocket message to a ClientMessage
+*/
+const parseClientMessage = (data) => Effect.try({
+	try: () => {
+		const text = typeof data === "string" ? data : new TextDecoder().decode(data instanceof ArrayBuffer ? new Uint8Array(data) : data);
+		return decodeClientMessage(JSON.parse(text));
+	},
+	catch: (cause) => new MessageParseError({ cause })
+});
+/**
+* Create an auth result success message
+*/
+const authResultSuccess = (userId, permission) => ({
+	type: "auth_result",
+	success: true,
+	userId,
+	permission
+});
+/**
+* Create an auth result failure message
+*/
+const authResultFailure = (error) => ({
+	type: "auth_result",
+	success: false,
+	error
+});
+/**
+* Create a pong message
+*/
+const pong = () => ({ type: "pong" });
+/**
+* Create a transaction message
+*/
+const transactionMessage = (transaction, version) => ({
+	type: "transaction",
+	transaction,
+	version
+});
+/**
+* Create a snapshot message
+*/
+const snapshotMessage = (state, version) => ({
+	type: "snapshot",
+	state,
+	version
+});
+/**
+* Create an error message
+*/
+const errorMessage = (transactionId, reason) => ({
+	type: "error",
+	transactionId,
+	reason
+});
+/**
+* Create a presence update message
+*/
+const presenceUpdateMessage = (id, data, userId) => ({
+	type: "presence_update",
+	id,
+	data,
+	userId
+});
+/**
+* Create a presence remove message
+*/
+const presenceRemoveMessage = (id) => ({
+	type: "presence_remove",
+	id
+});
+/**
+* Create a presence snapshot message
+*/
+const presenceSnapshotMessage = (selfId, presences) => ({
+	type: "presence_snapshot",
+	selfId,
+	presences
+});
+
+//#endregion
+export { Protocol_exports, authResultFailure, authResultSuccess, encodeServerMessage, errorMessage, parseClientMessage, pong, presenceRemoveMessage, presenceSnapshotMessage, presenceUpdateMessage, snapshotMessage };
+//# sourceMappingURL=Protocol.mjs.map

package/dist/Protocol.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Protocol.mjs","names":["encoded: EncodedServerMessage"],"sources":["../src/Protocol.ts"],"sourcesContent":["/**\n * @voidhash/mimic-effect - WebSocket Protocol\n *\n * Message types and encoding/decoding for WebSocket communication.\n */\nimport { Effect } from \"effect\";\nimport { Transaction } from \"@voidhash/mimic\";\nimport type { Permission, PresenceEntry } from \"./Types\";\nimport { MessageParseError } from \"./Errors\";\n\n// =============================================================================\n// Client -> Server Messages\n// =============================================================================\n\n/**\n * Authentication request\n */\nexport interface AuthMessage {\n  readonly type: \"auth\";\n  readonly token: string;\n}\n\n/**\n * Heartbeat ping\n */\nexport interface PingMessage {\n  readonly type: \"ping\";\n}\n\n/**\n * Submit a transaction\n */\nexport interface SubmitMessage {\n  readonly type: \"submit\";\n  readonly transaction: Transaction.Transaction;\n}\n\n/**\n * Request current document snapshot\n */\nexport interface RequestSnapshotMessage {\n  readonly type: \"request_snapshot\";\n}\n\n/**\n * Set presence data\n */\nexport interface PresenceSetMessage {\n  readonly type: \"presence_set\";\n  readonly data: unknown;\n}\n\n/**\n * Clear presence data\n */\nexport interface PresenceClearMessage {\n  readonly type: \"presence_clear\";\n}\n\n/**\n * Union of all client messages\n */\nexport type ClientMessage =\n  | AuthMessage\n  | PingMessage\n  | SubmitMessage\n  | RequestSnapshotMessage\n  | PresenceSetMessage\n  | PresenceClearMessage;\n\n// =============================================================================\n// Server -> Client Messages\n// =============================================================================\n\n/**\n * Authentication result\n */\nexport interface AuthResultMessage {\n  readonly type: \"auth_result\";\n  readonly success: boolean;\n  readonly error?: string;\n  readonly userId?: string;\n  readonly permission?: Permission;\n}\n\n/**\n * Heartbeat pong\n */\nexport interface PongMessage {\n  readonly type: \"pong\";\n}\n\n/**\n * Transaction broadcast\n */\nexport interface TransactionMessage {\n  readonly type: \"transaction\";\n  readonly transaction: Transaction.Transaction;\n  readonly version: number;\n}\n\n/**\n * Document snapshot\n */\nexport interface SnapshotMessage {\n  readonly type: \"snapshot\";\n  readonly state: unknown;\n  readonly version: number;\n}\n\n/**\n * Transaction error\n */\nexport interface ErrorMessage {\n  readonly type: \"error\";\n  readonly transactionId: string;\n  readonly reason: string;\n}\n\n/**\n * Presence update broadcast\n */\nexport interface PresenceUpdateMessage {\n  readonly type: \"presence_update\";\n  readonly id: string;\n  readonly data: unknown;\n  readonly userId?: string;\n}\n\n/**\n * Presence removal broadcast\n */\nexport interface PresenceRemoveMessage {\n  readonly type: \"presence_remove\";\n  readonly id: string;\n}\n\n/**\n * Presence snapshot (sent after auth)\n */\nexport interface PresenceSnapshotMessage {\n  readonly type: \"presence_snapshot\";\n  readonly selfId: string;\n  readonly presences: Record<string, PresenceEntry>;\n}\n\n/**\n * Union of all server messages\n */\nexport type ServerMessage =\n  | AuthResultMessage\n  | PongMessage\n  | TransactionMessage\n  | SnapshotMessage\n  | ErrorMessage\n  | PresenceUpdateMessage\n  | PresenceRemoveMessage\n  | PresenceSnapshotMessage;\n\n/**\n * Server broadcast messages (transaction or error)\n */\nexport type ServerBroadcast = TransactionMessage | ErrorMessage;\n\n// =============================================================================\n// Encoded Types (for wire format)\n// =============================================================================\n\n/**\n * Encoded client message (with encoded transaction)\n */\nexport interface EncodedClientMessage {\n  readonly type: string;\n  readonly token?: string;\n  readonly transaction?: Transaction.EncodedTransaction;\n  readonly data?: unknown;\n}\n\n/**\n * Encoded server message (with encoded transaction)\n */\nexport interface EncodedServerMessage {\n  readonly type: string;\n  readonly success?: boolean;\n  readonly error?: string;\n  readonly userId?: string;\n  readonly permission?: Permission;\n  readonly transaction?: Transaction.EncodedTransaction;\n  readonly version?: number;\n  readonly state?: unknown;\n  readonly transactionId?: string;\n  readonly reason?: string;\n  readonly id?: string;\n  readonly data?: unknown;\n  readonly selfId?: string;\n  readonly presences?: Record<string, PresenceEntry>;\n}\n\n// =============================================================================\n// Encoding/Decoding Functions\n// =============================================================================\n\n/**\n * Decode an encoded client message to a ClientMessage\n */\nexport const decodeClientMessage = (\n  encoded: EncodedClientMessage\n): ClientMessage => {\n  if (encoded.type === \"submit\" && encoded.transaction) {\n    return {\n      type: \"submit\",\n      transaction: Transaction.decode(encoded.transaction),\n    };\n  }\n  return encoded as ClientMessage;\n};\n\n/**\n * Encode a server message for wire format\n */\nexport const encodeServerMessage = (message: ServerMessage): string => {\n  if (message.type === \"transaction\") {\n    const encoded: EncodedServerMessage = {\n      type: \"transaction\",\n      transaction: Transaction.encode(message.transaction),\n      version: message.version,\n    };\n    return JSON.stringify(encoded);\n  }\n  return JSON.stringify(message);\n};\n\n/**\n * Parse a raw WebSocket message to a ClientMessage\n */\nexport const parseClientMessage = (\n  data: string | ArrayBuffer | Uint8Array\n): Effect.Effect<ClientMessage, MessageParseError> =>\n  Effect.try({\n    try: () => {\n      const text =\n        typeof data === \"string\"\n          ? data\n          : new TextDecoder().decode(\n              data instanceof ArrayBuffer ? new Uint8Array(data) : data\n            );\n      const encoded = JSON.parse(text) as EncodedClientMessage;\n      return decodeClientMessage(encoded);\n    },\n    catch: (cause) => new MessageParseError({ cause }),\n  });\n\n/**\n * Create an auth result success message\n */\nexport const authResultSuccess = (\n  userId: string,\n  permission: Permission\n): AuthResultMessage => ({\n  type: \"auth_result\",\n  success: true,\n  userId,\n  permission,\n});\n\n/**\n * Create an auth result failure message\n */\nexport const authResultFailure = (error: string): AuthResultMessage => ({\n  type: \"auth_result\",\n  success: false,\n  error,\n});\n\n/**\n * Create a pong message\n */\nexport const pong = (): PongMessage => ({ type: \"pong\" });\n\n/**\n * Create a transaction message\n */\nexport const transactionMessage = (\n  transaction: Transaction.Transaction,\n  version: number\n): TransactionMessage => ({\n  type: \"transaction\",\n  transaction,\n  version,\n});\n\n/**\n * Create a snapshot message\n */\nexport const snapshotMessage = (\n  state: unknown,\n  version: number\n): SnapshotMessage => ({\n  type: \"snapshot\",\n  state,\n  version,\n});\n\n/**\n * Create an error message\n */\nexport const errorMessage = (\n  transactionId: string,\n  reason: string\n): ErrorMessage => ({\n  type: \"error\",\n  transactionId,\n  reason,\n});\n\n/**\n * Create a presence update message\n */\nexport const presenceUpdateMessage = (\n  id: string,\n  data: unknown,\n  userId?: string\n): PresenceUpdateMessage => ({\n  type: \"presence_update\",\n  id,\n  data,\n  userId,\n});\n\n/**\n * Create a presence remove message\n */\nexport const presenceRemoveMessage = (\n  id: string\n): PresenceRemoveMessage => ({\n  type: \"presence_remove\",\n  id,\n});\n\n/**\n * Create a presence snapshot message\n */\nexport const presenceSnapshotMessage = (\n  selfId: string,\n  presences: Record<string, PresenceEntry>\n): PresenceSnapshotMessage => ({\n  type: \"presence_snapshot\",\n  selfId,\n  presences,\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6MA,MAAa,uBACX,YACkB;AAClB,KAAI,QAAQ,SAAS,YAAY,QAAQ,YACvC,QAAO;EACL,MAAM;EACN,aAAa,YAAY,OAAO,QAAQ,YAAY;EACrD;AAEH,QAAO;;;;;AAMT,MAAa,uBAAuB,YAAmC;AACrE,KAAI,QAAQ,SAAS,eAAe;EAClC,MAAMA,UAAgC;GACpC,MAAM;GACN,aAAa,YAAY,OAAO,QAAQ,YAAY;GACpD,SAAS,QAAQ;GAClB;AACD,SAAO,KAAK,UAAU,QAAQ;;AAEhC,QAAO,KAAK,UAAU,QAAQ;;;;;AAMhC,MAAa,sBACX,SAEA,OAAO,IAAI;CACT,WAAW;EACT,MAAM,OACJ,OAAO,SAAS,WACZ,OACA,IAAI,aAAa,CAAC,OAChB,gBAAgB,cAAc,IAAI,WAAW,KAAK,GAAG,KACtD;AAEP,SAAO,oBADS,KAAK,MAAM,KAAK,CACG;;CAErC,QAAQ,UAAU,IAAI,kBAAkB,EAAE,OAAO,CAAC;CACnD,CAAC;;;;AAKJ,MAAa,qBACX,QACA,gBACuB;CACvB,MAAM;CACN,SAAS;CACT;CACA;CACD;;;;AAKD,MAAa,qBAAqB,WAAsC;CACtE,MAAM;CACN,SAAS;CACT;CACD;;;;AAKD,MAAa,cAA2B,EAAE,MAAM,QAAQ;;;;AAKxD,MAAa,sBACX,aACA,aACwB;CACxB,MAAM;CACN;CACA;CACD;;;;AAKD,MAAa,mBACX,OACA,aACqB;CACrB,MAAM;CACN;CACA;CACD;;;;AAKD,MAAa,gBACX,eACA,YACkB;CAClB,MAAM;CACN;CACA;CACD;;;;AAKD,MAAa,yBACX,IACA,MACA,YAC2B;CAC3B,MAAM;CACN;CACA;CACA;CACD;;;;AAKD,MAAa,yBACX,QAC2B;CAC3B,MAAM;CACN;CACD;;;;AAKD,MAAa,2BACX,QACA,eAC6B;CAC7B,MAAM;CACN;CACA;CACD"}

package/dist/Types.d.cts

@@ -0,0 +1,172 @@
+import { Duration, Effect } from "effect";
+import { Presence, Primitive, Transaction } from "@voidhash/mimic";
+
+//#region src/Types.d.ts
+
+/**
+ * Permission level for document access
+ * - "read": Can subscribe, receive transactions, get snapshots
+ * - "write": All of the above, plus can submit transactions and set presence
+ */
+type Permission = "read" | "write";
+/**
+ * Authentication context returned after successful authentication
+ */
+interface AuthContext {
+  readonly userId: string;
+  readonly permission: Permission;
+  readonly metadata?: Record<string, unknown>;
+}
+/**
+ * Document state stored in ColdStorage (snapshots)
+ */
+interface StoredDocument {
+  /** Document state */
+  readonly state: unknown;
+  /** Current version number */
+  readonly version: number;
+  /** Schema version for future migration support */
+  readonly schemaVersion: number;
+  /** Unix timestamp (ms) when saved */
+  readonly savedAt: number;
+}
+/**
+ * WAL entry stored in HotStorage
+ */
+interface WalEntry {
+  /** The transaction data */
+  readonly transaction: Transaction.Transaction;
+  /** Version after this transaction */
+  readonly version: number;
+  /** Unix timestamp (ms) */
+  readonly timestamp: number;
+}
+/**
+ * Presence entry for a connection
+ */
+interface PresenceEntry {
+  /** Presence data (schema-validated) */
+  readonly data: unknown;
+  /** User ID from authentication (optional) */
+  readonly userId?: string;
+}
+/**
+ * Snapshot of all presences for a document
+ */
+interface PresenceSnapshot {
+  readonly presences: Record<string, PresenceEntry>;
+}
+/**
+ * Presence update event
+ */
+interface PresenceUpdateEvent {
+  readonly type: "presence_update";
+  readonly id: string;
+  readonly data: unknown;
+  readonly userId?: string;
+}
+/**
+ * Presence remove event
+ */
+interface PresenceRemoveEvent {
+  readonly type: "presence_remove";
+  readonly id: string;
+}
+/**
+ * Union of presence events
+ */
+type PresenceEvent = PresenceUpdateEvent | PresenceRemoveEvent;
+/**
+ * Duration input type - matches Effect's DurationInput
+ */
+type DurationInput = Duration.DurationInput;
+/**
+ * Snapshot configuration
+ */
+interface SnapshotConfig {
+  /** Time-based snapshot interval */
+  readonly interval: DurationInput;
+  /** Transaction count threshold for snapshots */
+  readonly transactionThreshold: number;
+}
+/**
+ * Context passed to initial state function
+ */
+interface InitialContext {
+  readonly documentId: string;
+}
+/**
+ * Initial state function type
+ */
+type InitialFn<TSchema extends Primitive.AnyPrimitive> = (context: InitialContext) => Effect.Effect<Primitive.InferSetInput<TSchema>>;
+/**
+ * Initial state - either a static value or a function
+ */
+type Initial<TSchema extends Primitive.AnyPrimitive> = Primitive.InferSetInput<TSchema> | InitialFn<TSchema>;
+/**
+ * MimicServerEngine configuration
+ */
+interface MimicServerEngineConfig<TSchema extends Primitive.AnyPrimitive> {
+  /** Document schema (required) */
+  readonly schema: TSchema;
+  /** Initial state for new documents (optional) */
+  readonly initial?: Initial<TSchema>;
+  /** Presence schema (optional) */
+  readonly presence?: Presence.AnyPresence;
+  /** Document idle timeout before GC (default: 5 minutes) */
+  readonly maxIdleTime?: DurationInput;
+  /** Maximum transaction history for deduplication (default: 1000) */
+  readonly maxTransactionHistory?: number;
+  /** Snapshot configuration */
+  readonly snapshot?: SnapshotConfig;
+}
+/**
+ * MimicClusterServerEngine configuration (extends MimicServerEngineConfig)
+ */
+interface MimicClusterServerEngineConfig<TSchema extends Primitive.AnyPrimitive> extends MimicServerEngineConfig<TSchema> {
+  /** Shard group name for cluster distribution (default: "mimic-documents") */
+  readonly shardGroup?: string;
+}
+/**
+ * MimicServer route configuration
+ */
+interface MimicServerRouteConfig {
+  /** WebSocket route path prefix (default: "/mimic") */
+  readonly path?: `/${string}`;
+  /** Heartbeat ping interval (default: 30 seconds) */
+  readonly heartbeatInterval?: DurationInput;
+  /** Heartbeat timeout - disconnect if no activity (default: 10 seconds) */
+  readonly heartbeatTimeout?: DurationInput;
+}
+/**
+ * Resolved engine configuration with all defaults applied
+ */
+interface ResolvedConfig<TSchema extends Primitive.AnyPrimitive> {
+  readonly schema: TSchema;
+  readonly initial: Initial<TSchema> | undefined;
+  readonly presence: Presence.AnyPresence | undefined;
+  readonly maxIdleTime: Duration.Duration;
+  readonly maxTransactionHistory: number;
+  readonly snapshot: {
+    readonly interval: Duration.Duration;
+    readonly transactionThreshold: number;
+  };
+}
+/**
+ * Resolved route configuration with all defaults applied
+ */
+interface ResolvedRouteConfig {
+  readonly path: string;
+  readonly heartbeatInterval: Duration.Duration;
+  readonly heartbeatTimeout: Duration.Duration;
+}
+/**
+ * Resolved cluster engine configuration with all defaults applied
+ */
+interface ResolvedClusterConfig<TSchema extends Primitive.AnyPrimitive> extends ResolvedConfig<TSchema> {
+  /** Shard group name for cluster distribution */
+  readonly shardGroup: string;
+}
+//#endregion
+export { AuthContext, DurationInput, Initial, InitialContext, InitialFn, MimicClusterServerEngineConfig, MimicServerEngineConfig, MimicServerRouteConfig, Permission, PresenceEntry, PresenceEvent, PresenceRemoveEvent, PresenceSnapshot, PresenceUpdateEvent, ResolvedClusterConfig, ResolvedConfig, ResolvedRouteConfig, SnapshotConfig, StoredDocument, WalEntry };
+//# sourceMappingURL=Types.d.cts.map

package/dist/Types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Types.d.cts","names":[],"sources":["../src/Types.ts"],"sourcesContent":[],"mappings":";;;;;AAiDA;AAgBA;AAUA;AAOA;AAUA;AAQY,KAnFA,UAAA,GAmFa,MAAA,GAAG,OAAA;AAS5B;AAKA;AAUA;AAOY,UA7GK,WAAA,CA6GI;EAAiB,SAAU,MAAA,EAAA,MAAA;EACrC,SAAA,UAAA,EA5GY,UA4GZ;EACgC,SAAA,QAAA,CAAA,EA5GrB,MA4GqB,CAAA,MAAA,EAAA,OAAA,CAAA;;;;AAK3C;AAAoC,UAvGnB,cAAA,CAuG6B;EAClB;EAAxB,SAAU,KAAA,EAAA,OAAA;EACA;EAAV,SAAA,OAAA,EAAA,MAAA;EAAS;EAKI,SAAA,aAAA,EAAA,MAAuB;EACtB;EAGC,SAAA,OAAA,EAAA,MAAA;;;;;AAeG,UAnHL,QAAA,CAmHK;EAAc;EAMnB,SAAA,WAAA,EAvHO,WAAA,CAAY,WAuHW;EAC7B;EACgB,SAAA,OAAA,EAAA,MAAA;EAAxB;EAAuB,SAAA,SAAA,EAAA,MAAA;AAYjC;AAkBA;;;AAE4B,UA3IX,aAAA,CA2IW;EAAR;EACC,SAAS,IAAA,EAAA,OAAA;EACN;EAGD,SAAS,MAAA,CAAA,EAAA,MAAA;;AAQhC;AASA;;AACyB,UAxJR,gBAAA,CAwJQ;EAAf,SAAA,SAAA,EAvJY,MAuJZ,CAAA,MAAA,EAvJ2B,aAuJ3B,CAAA;;;;;UAjJO,mBAAA;;;;;;;;;UAUA,mBAAA;;;;;;;KAQL,aAAA,GAAgB,sBAAsB;;;;KAStC,aAAA,GAAgB,QAAA,CAAS;;;;UAKpB,cAAA;;qBAEI;;;;;;;UAQJ,cAAA;;;;;;KAOL,0BAA0B,SAAA,CAAU,0BACrC,mBACN,MAAA,CAAO,OAAO,SAAA,CAAU,cAAc;;;;KAK/B,wBAAwB,SAAA,CAAU,gBAC1C,SAAA,CAAU,cAAc,WACxB,UAAU;;;;UAKG,wCACC,SAAA,CAAU;;mBAGT;;qBAGE,QAAQ;;sBAGP,QAAA,CAAS;;yBAGN;;;;sBAMH;;;;;UAML,+CACC,SAAA,CAAU,sBAClB,wBAAwB;;;;;;;UAYjB,sBAAA;;;;+BAKc;;8BAGD;;;;;UAUb,+BAA+B,SAAA,CAAU;mBACvC;oBACC,QAAQ;qBACP,QAAA,CAAS;wBACN,QAAA,CAAS;;;uBAGV,QAAA,CAAS;;;;;;;UAQf,mBAAA;;8BAEa,QAAA,CAAS;6BACV,QAAA,CAAS;;;;;UAMrB,sCAAsC,SAAA,CAAU,sBACvD,eAAe"}