extract server util to secsync-server

CHANGELOG.md

@@ -3,6 +3,7 @@
 There is a changelog available for each package:
 
 - [secsync](./packages/secsync/CHANGELOG.md)
+- [secsync-server](./packages/secsync-server/CHANGELOG.md)
 - [secsync-react-yjs](./packages/secsync-react-yjs/CHANGELOG.md)
 - [secsync-react-automerge](./packages/secsync-react-automerge/CHANGELOG.md)
 - [secsync-react-devtool](./packages/secsync-react-devtool/CHANGELOG.md)

documentation/package.json

@@ -51,7 +51,7 @@
   "devDependencies": {
     "@svgr/webpack": "^8.1.0",
     "@types/libsodium-wrappers": "^0.7.14",
-    "@types/node": "20.11.30",
+    "@types/node": "^20.13.0",
     "autoprefixer": "^10.4.19",
     "postcss": "^8.4.38",
     "tailwindcss": "^3.4.3",

documentation/pages/docs/getting-started.mdx

@@ -195,7 +195,7 @@ Secsync ships with a backend utility that handles a Websocket connection includi
 - hasBroadcastAccess
 
 ```tsx
-import { createWebSocketConnection } from "secsync";
+import { createWebSocketConnection } from "secsync-server";
 import { WebSocketServer } from "ws";
 
 const webSocketServer = new WebSocketServer();

examples/backend/package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "private": true,
   "devDependencies": {
-    "@types/node": "20.12.7",
+    "@types/node": "^20.13.0",
     "@types/uuid": "^9.0.8",
     "@types/ws": "^8.5.10",
     "@vercel/ncc": "^0.38.1",
@@ -32,6 +32,7 @@
     "libsodium-wrappers": "^0.7.13",
     "make-promises-safe": "^5.1.0",
     "secsync": "workspace:^",
+    "secsync-server": "workspace:^",
     "uuid": "^9.0.1",
     "ws": "^8.16.0"
   },

examples/backend/src/index.ts

@@ -2,7 +2,7 @@ require("make-promises-safe"); // installs an 'unhandledRejection' handler
 import cors from "cors";
 import express from "express";
 import { createServer } from "http";
-import { createWebSocketConnection } from "secsync";
+import { createWebSocketConnection } from "secsync-server";
 import { WebSocketServer } from "ws";
 import { createSnapshot as createSnapshotDb } from "./database/createSnapshot";
 import { createUpdate as createUpdateDb } from "./database/createUpdate";

packages/secsync-server/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.0] - 2024-06-01
+
+### Added
+
+- Initial version

packages/secsync-server/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ["@babel/preset-env", { targets: { node: "current" } }],
+    "@babel/preset-typescript",
+  ],
+};

packages/secsync-server/package-json-build-script.js

@@ -0,0 +1,12 @@
+const fs = require("fs");
+const data = fs.readFileSync("./package.json", { encoding: "utf8", flag: "r" });
+
+// Display the file data
+const dataJson = JSON.parse(data);
+
+dataJson.module = "index.mjs";
+dataJson.types = "index.d.ts";
+dataJson.main = "index.js";
+dataJson.browser = "index.mjs";
+
+fs.writeFileSync("./dist/package.json", JSON.stringify(dataJson, null, 2));

packages/secsync-server/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "secsync-server",
+  "version": "0.3.0",
+  "main": "src/index",
+  "types": "src/index",
+  "scripts": {
+    "build": "pnpm build:xstate-types && pnpm tsup && pnpm build:package-json",
+    "build:xstate-types": "xstate typegen \"./src/**/*.ts?(x)\"",
+    "build:package-json": "node package-json-build-script.js",
+    "prepublishOnly": "pnpm run build",
+    "test": "jest",
+    "ts:check": "pnpm tsc --noEmit",
+    "lint": "echo \"No linting configured\""
+  },
+  "dependencies": {
+    "canonicalize": "^2.0.0",
+    "libsodium-wrappers": "^0.7.13"
+  },
+  "peerDependencies": {
+    "secsync": "*"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.24.4",
+    "@babel/preset-env": "^7.24.4",
+    "@babel/preset-typescript": "^7.24.1",
+    "@types/jest": "^29.5.12",
+    "@types/libsodium-wrappers": "^0.7.14",
+    "@types/ws": "^8.5.10",
+    "jest": "^29.7.0",
+    "mock-socket": "^9.3.1"
+  },
+  "jest": {
+    "setupFilesAfterEnv": [
+      "<rootDir>/test/config/jestTestSetup.ts"
+    ]
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": false
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/serenity-kit/secsync.git"
+  }
+}

packages/secsync/src/server/createWebSocketConnection.ts → packages/secsync-server/src/createWebSocketConnection.ts

@@ -1,31 +1,29 @@
 import { IncomingMessage } from "http";
 import sodium from "libsodium-wrappers";
-import { parse as parseUrl } from "url";
-import { WebSocket } from "ws";
-import { verifySignature } from "../crypto/verifySignature";
-import { parseEphemeralMessage } from "../ephemeralMessage/parseEphemeralMessage";
-import {
-  SecsyncNewSnapshotRequiredError,
-  SecsyncSnapshotBasedOnOutdatedSnapshotError,
-  SecsyncSnapshotMissesUpdatesError,
-} from "../errors";
-import { parseSnapshotWithClientData } from "../snapshot/parseSnapshotWithClientData";
 import {
   AdditionalAuthenticationDataValidations,
   CreateSnapshotParams,
   CreateUpdateParams,
   GetDocumentParams,
   HasAccessParams,
   HasBroadcastAccessParams,
+  SecsyncNewSnapshotRequiredError,
+  SecsyncSnapshotBasedOnOutdatedSnapshotError,
+  SecsyncSnapshotMissesUpdatesError,
   Snapshot,
   SnapshotProofChainEntry,
   SnapshotUpdateClocks,
   Update,
-} from "../types";
-import { parseUpdate } from "../update/parseUpdate";
-import { canonicalizeAndToBase64 } from "../utils/canonicalizeAndToBase64";
-import { retryAsyncFunction } from "../utils/retryAsyncFunction";
+  parseEphemeralMessage,
+  parseSnapshotWithClientData,
+  parseUpdate,
+  verifySignature,
+} from "secsync";
+import { parse as parseUrl } from "url";
+import { WebSocket } from "ws";
 import { addConnection, broadcastMessage, removeConnection } from "./store";
+import { canonicalizeAndToBase64 } from "./utils/canonicalizeAndToBase64";
+import { retryAsyncFunction } from "./utils/retryAsyncFunction";
 
 type GetDocumentResult = {
   snapshot?: Snapshot;

packages/secsync-server/src/index.ts

@@ -0,0 +1 @@
+export * from "./createWebSocketConnection";

packages/secsync/src/server/store.ts → packages/secsync-server/src/store.ts

@@ -1,5 +1,5 @@
+import { HasBroadcastAccessParams } from "secsync";
 import WebSocket from "ws";
-import { HasBroadcastAccessParams } from "../types";
 
 type ConnectionEntry = { websocketSessionKey: string; websocket: WebSocket };
 

packages/secsync-server/src/utils/canonicalizeAndToBase64.ts

@@ -0,0 +1,12 @@
+import canonicalize from "canonicalize";
+
+export const canonicalizeAndToBase64 = (
+  input: unknown,
+  sodium: typeof import("libsodium-wrappers")
+): string => {
+  const canonicalized = canonicalize(input);
+  if (!canonicalized) {
+    throw new Error("Failed to canonicalize input");
+  }
+  return sodium.to_base64(canonicalized);
+};

packages/secsync-server/test/config/jestTestSetup.ts

@@ -0,0 +1,12 @@
+import sodium from "libsodium-wrappers";
+import { WebSocket } from "mock-socket";
+
+// @ts-expect-error
+global.setImmediate = jest.useRealTimers;
+global.WebSocket = WebSocket;
+
+jest.setTimeout(5000);
+
+beforeEach(async () => {
+  await sodium.ready;
+});

packages/secsync-server/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+
+  "compilerOptions": {
+    "outDir": "./dist",
+    "types": ["jest"]
+  },
+
+  "include": ["src/**/*"]
+}

packages/secsync-server/tsup.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/index.ts"],
+  clean: true,
+  dts: true,
+  format: ["cjs", "esm"],
+});

packages/secsync/package.json

@@ -24,6 +24,7 @@
     "@babel/preset-typescript": "^7.24.1",
     "@types/jest": "^29.5.12",
     "@types/libsodium-wrappers": "^0.7.14",
+    "@types/node": "^20.13.0",
     "@types/ws": "^8.5.10",
     "@xstate/cli": "^0.5.17",
     "jest": "^29.7.0",

packages/secsync/src/index.ts

@@ -7,15 +7,16 @@ export * from "./crypto/hash";
 export * from "./crypto/sign";
 export * from "./crypto/verifySignature";
 export * from "./ephemeralMessage/createEphemeralMessage";
+export * from "./ephemeralMessage/parseEphemeralMessage";
 export * from "./ephemeralMessage/verifyAndDecryptEphemeralMessage";
 export * from "./errors";
-export * from "./server/createWebSocketConnection";
 export * from "./snapshot/createInitialSnapshot";
 export * from "./snapshot/createSnapshot";
 export * from "./snapshot/parseSnapshotWithClientData";
 export * from "./snapshot/verifyAndDecryptSnapshot";
 export * from "./types";
 export * from "./update/createUpdate";
+export * from "./update/parseUpdate";
 export * from "./update/verifyAndDecryptUpdate";
 export * from "./utils/compareUpdateClocks";
 export * from "./utils/deserializeUint8ArrayUpdates";

packages/secsync/tsconfig.json

@@ -3,7 +3,7 @@
 
   "compilerOptions": {
     "outDir": "./dist",
-    "types": ["jest"]
+    "types": ["jest", "node"]
   },
 
   "include": ["src/**/*"]