@evolu/relay 1.1.2-preview.5 → 4.0.0

package/Dockerfile

@@ -1,27 +0,0 @@
-FROM node:22-alpine
-
-ARG RELAY_VERSION=latest
-
-# Install required dependencies and create non-root user
-RUN apk add --no-cache wget && \
-    addgroup --system --gid 1001 nodejs && \
-    adduser --system --uid 1001 evolu --ingroup nodejs && \
-    npm install -g @evolu/relay@${RELAY_VERSION} && \
-    mkdir -p /app/data && \
-    chown -R evolu:nodejs /app
-
-WORKDIR /app
-USER evolu
-
-ENV RELAY_PORT=4000 \
-    RELAY_NAME=evolu-relay \
-    RELAY_ENABLE_LOGGING=false \
-    NODE_ENV=production \
-    LOG_LEVEL=error
-
-EXPOSE ${RELAY_PORT}
-
-HEALTHCHECK --interval=30s --timeout=5s --start-period=30s --retries=3 \
-  CMD wget --no-verbose --tries=1 --spider http://localhost:${RELAY_PORT}
-
-CMD ["sh", "-c", "npx @evolu/relay@${RELAY_VERSION} start --port $RELAY_PORT --name $RELAY_NAME $([ \"$RELAY_ENABLE_LOGGING\" = \"true\" ] && echo --enable-logging)"] 

package/README.docker.md

@@ -1,154 +0,0 @@
-# Evolu Relay - Docker Setup
-
-Docker configuration for the Evolu Relay.
-
-## 🚀 Quick Start for Developers
-
-**Just one command to get started:**
-
-```bash
-cd apps/relay
-pnpm docker:up
-```
-
-That's it! This will:
-
-- ✅ Automatically build the Docker image
-- ✅ Start the Evolu Relay service
-- ✅ Show real-time logs
-- ✅ Make the service available at `http://localhost:4000`
-
-Press `Ctrl+C` to stop the service.
-
-### Background Mode (Optional)
-
-```bash
-cd apps/relay
-
-# Start in background
-pnpm docker:up:detached
-
-# View logs when needed
-pnpm docker:logs
-
-# Stop when done
-pnpm docker:down
-```
-
-## 🔧 Advanced Usage
-
-### All Available Commands
-
-| Command                   | Description                                    | Auto-builds? | Persistence  |
-| ------------------------- | ---------------------------------------------- | ------------ | ------------ |
-| `pnpm docker:up`          | **Recommended**: Start in foreground with logs | ✅ Yes       | Named volume |
-| `pnpm docker:up:detached` | Start in background                            | ✅ Yes       | Named volume |
-| `pnpm docker:down`        | Stop services                                  | N/A          | N/A          |
-| `pnpm docker:restart`     | Restart with rebuild                           | ✅ Yes       | Named volume |
-| `pnpm docker:logs`        | View logs (live)                               | N/A          | N/A          |
-| `pnpm docker:shell`       | Access running container shell                 | N/A          | N/A          |
-| `pnpm docker:stats`       | View container resource usage                  | N/A          | N/A          |
-| `pnpm docker:inspect`     | View container details                         | N/A          | N/A          |
-| `pnpm docker:build`       | Build image only                               | N/A          | N/A          |
-| `pnpm docker:clean`       | Clean up containers and images                 | N/A          | N/A          |
-| `pnpm docker:clean:all`   | **Full cleanup**: Remove everything            | N/A          | N/A          |
-
-### Manual Docker Commands (Alternative)
-
-```bash
-# Build manually
-docker-compose build
-
-# Run with Docker Compose
-docker-compose up --build
-
-# Run directly with Docker
-docker run -p 4000:4000 evolu/relay:latest
-```
-
-## ❓ FAQ
-
-**Q: Do I need to build the image first?**  
-A: No! `pnpm docker:up` automatically builds and starts everything.
-
-**Q: How do I update after code changes?**  
-A: Just run `pnpm docker:restart` or stop and start again.
-
-**Q: How do I know if it's working?**  
-A: Check `http://localhost:4000` - you should get a "426 Upgrade Required" response (this is correct for WebSocket servers).
-
-**Q: How do I see what's happening?**  
-A: Use `pnpm docker:logs` to view live logs.
-
-**Q: How do I access the container?**  
-A: Use `pnpm docker:shell` to get shell access inside the running container.
-
-**Q: How do I clean up everything?**  
-A: Run `pnpm docker:clean:all` to remove all containers, images, and networks.
-
-## 📁 Docker Files
-
-- `Dockerfile` - Multi-stage Docker build configuration
-- `docker-compose.yml` - Docker Compose configuration with health checks
-- `.dockerignore` - Files to exclude from Docker build context
-
-## ⚙️ Configuration
-
-- **Port**: 4000 (modify in `docker-compose.yml` if needed)
-- **Environment**: `NODE_ENV=production` in Docker
-- **Health Check**: Built-in health monitoring via Docker Compose
-- **Data Persistence**: SQLite database automatically persists via Docker volumes
-
-### Container Details
-
-| Component          | Value                 | Description                        |
-| ------------------ | --------------------- | ---------------------------------- |
-| **Container Name** | `evolu-relay-server`  | Easy identification                |
-| **Image Name**     | `evolu/relay:latest`  | Tagged for production deployment   |
-| **Network**        | `evolu-relay-network` | Isolated Docker network            |
-| **Volume**         | `evolu-relay-data`    | Persistent SQLite database storage |
-| **User**           | `evolu:nodejs` (1001) | Non-root user for security         |
-| **Memory Limit**   | 1GB                   | Resource constraint                |
-| **CPU Limit**      | 1.0                   | CPU resource constraint            |
-
-## 🚨 Troubleshooting
-
-| Issue                    | Solution                                                   |
-| ------------------------ | ---------------------------------------------------------- |
-| Build fails              | Run `pnpm docker:clean:all` and try again                  |
-| Port already in use      | Change port in `docker-compose.yml` or stop other services |
-| Container won't start    | Check logs with `pnpm docker:logs`                         |
-| Need container access    | Use `pnpm docker:shell` for interactive shell              |
-| Performance issues       | Check resources with `pnpm docker:stats`                   |
-| Need to reset everything | Run `pnpm docker:clean:all`                                |
-
-## 🔍 Monitoring & Debugging
-
-### Real-time Monitoring
-
-```bash
-# View live logs
-pnpm docker:logs
-
-# Monitor resource usage
-pnpm docker:stats
-
-# Container details
-pnpm docker:inspect
-
-# Access container shell
-pnpm docker:shell
-```
-
-### Inside Container Commands
-
-```bash
-# Access container
-pnpm docker:shell
-
-# Then inside container:
-ls -la /app/apps/relay/data/     # View database files
-ps aux                           # Check running processes
-top                              # Monitor resource usage
-netstat -tlnp                    # Check port bindings
-```

package/data/.gitkeep

@@ -1,2 +0,0 @@
-# This directory is used for persistent SQLite database storage in production deployments
-# The .gitkeep file ensures this directory exists in git while ignoring its contents 

package/dist/package.json

@@ -1,41 +0,0 @@
-{
-    "name": "@evolu/relay",
-    "version": "1.1.2-preview.5",
-    "type": "module",
-    "bin": {
-        "@evolu/relay": "dist/src/cli.js"
-    },
-    "scripts": {
-        "dev": "tsx --watch src/cli.ts -- start",
-        "build": "shx rm -rf dist && tsc",
-        "start": "node dist/src/cli.js",
-        "clean": "shx rm -rf .turbo node_modules dist db.sqlite",
-        "docker:build": "docker-compose build --no-cache",
-        "docker:up": "docker-compose up --build",
-        "docker:up:detached": "docker-compose up -d --build",
-        "docker:down": "docker-compose down -v",
-        "docker:restart": "docker-compose down && docker-compose up --build",
-        "docker:logs": "docker-compose logs -f evolu-relay",
-        "docker:shell": "docker exec -it evolu-relay-server sh",
-        "docker:inspect": "docker inspect evolu-relay-server",
-        "docker:stats": "docker stats evolu-relay-server",
-        "docker:clean": "docker-compose down -v && docker system prune -f",
-        "docker:clean:all": "docker-compose down -v && docker system prune -af && docker volume prune -f"
-    },
-    "dependencies": {
-        "@evolu/common": "workspace:*",
-        "@evolu/nodejs": "workspace:*",
-        "commander": "^14.0.1"
-    },
-    "devDependencies": {
-        "@evolu/tsconfig": "workspace:*",
-        "@types/node": "^22.17.1",
-        "typescript": "^5.9.2"
-    },
-    "engines": {
-        "node": ">=22.0.0"
-    },
-    "publishConfig": {
-        "access": "public"
-    }
-}

package/dist/src/cli.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=cli.d.ts.map

package/dist/src/cli.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":""}

package/dist/src/cli.js

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-import { Command, Option } from "commander";
-import packageJson from "../package.json" with { type: "json" };
-import { logger } from "./logger.js";
-import { startNodeJsRelay } from "./nodejs.js";
-import { cliParams } from "./params.js";
-function main() {
-    const program = new Command()
-        .name("@evolu/relay")
-        .description("Evolu Relay server")
-        .version(packageJson.version || "1.0.0", "-v, --version", "display the version number");
-    program
-        .command("start")
-        .description("start the relay server")
-        .addOption(new Option("-n, --name <name>", "database name").default("evolu-relay"))
-        .addOption(new Option("-l, --enable-logging", "enable logging").default(false))
-        .addOption(new Option("-p, --port <number>", "port to listen on")
-        .default(4000)
-        .argParser(Number))
-        // .addOption(
-        //   new Option("--platform <platform>", "platform")
-        //     .choices(["nodejs", "bun"])
-        //     .default("nodejs"),
-        // )
-        .action(async (options) => {
-        logger.enabled = true;
-        const params = cliParams.fromUnknown(options);
-        logger.log("Evolu Relay", packageJson.version);
-        if (!params.ok) {
-            logger.error(params.error.reason);
-            process.exit(1);
-        }
-        try {
-            await startNodeJsRelay(params.value);
-        }
-        catch (error) {
-            logger.error(error);
-            process.exit(1);
-        }
-    });
-    program.parse();
-}
-main();

package/dist/src/logger.d.ts

@@ -1,2 +0,0 @@
-export declare const logger: import("@evolu/common").Console;
-//# sourceMappingURL=logger.d.ts.map

package/dist/src/logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM,iCAAkB,CAAC"}

package/dist/src/logger.js

@@ -1,4 +0,0 @@
-import { createConsole } from "@evolu/common";
-// TODO: use createConsoleWithTime after release
-// export const logger = createConsoleWithTime({ timestampType: "absolute" });
-export const logger = createConsole();

package/dist/src/nodejs.d.ts

@@ -1,3 +0,0 @@
-import { CliParams } from "./params.js";
-export declare function startNodeJsRelay(options: CliParams): Promise<void>;
-//# sourceMappingURL=nodejs.d.ts.map

package/dist/src/nodejs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodejs.d.ts","sourceRoot":"","sources":["../../src/nodejs.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBxE"}

package/dist/src/nodejs.js

@@ -1,24 +0,0 @@
-import { createNodeJsRelay } from "@evolu/nodejs";
-import { mkdirSync } from "fs";
-import { once } from "node:events";
-import { logger } from "./logger.js";
-export async function startNodeJsRelay(options) {
-    // Ensure the database is created in a predictable location for Docker.
-    mkdirSync("data", { recursive: true });
-    process.chdir("data");
-    if (options.enableLogging) {
-        logger.enabled = true;
-    }
-    const relay = await createNodeJsRelay({ console: logger })({
-        port: options.port,
-        enableLogging: options.enableLogging,
-        name: options.name,
-    });
-    await Promise.race([
-        once(process, "SIGINT"), // Ctrl-C
-        once(process, "SIGTERM"), // OS/k8s/etc requested termination
-    ]);
-    logger.enabled = true;
-    logger.log("Shutting down relay server");
-    relay[Symbol.dispose]();
-}

package/dist/src/params.d.ts

@@ -1,7 +0,0 @@
-export declare const cliParams: import("@evolu/common").ObjectType<{
-    name: import("@evolu/common").BrandType<import("@evolu/common").Type<"String", string, string, import("@evolu/common").StringError, string, import("@evolu/common").StringError>, "SimpleName", import("@evolu/common").RegexError<"SimpleName">, import("@evolu/common").StringError>;
-    enableLogging: import("@evolu/common").Type<"Boolean", boolean, boolean, import("@evolu/common").BooleanError, boolean, import("@evolu/common").BooleanError>;
-    port: import("@evolu/common").Type<"Number", number, number, import("@evolu/common").NumberError, number, import("@evolu/common").NumberError>;
-}>;
-export type CliParams = typeof cliParams.Type;
-//# sourceMappingURL=params.d.ts.map

package/dist/src/params.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../src/params.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS;;;;EAIpB,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC,IAAI,CAAC"}

package/dist/src/params.js

@@ -1,6 +0,0 @@
-import { Boolean, Number, object, SimpleName } from "@evolu/common";
-export const cliParams = object({
-    name: SimpleName,
-    enableLogging: Boolean,
-    port: Number,
-});

package/docker-compose.yml

@@ -1,60 +0,0 @@
-services:
-  evolu-relay:
-    container_name: evolu-relay-server
-    image: evolu/relay:latest
-    build:
-      context: .
-      dockerfile: Dockerfile
-      tags:
-        - evolu/relay:latest
-    ports:
-      - "${RELAY_PORT:-4000}:${RELAY_PORT:-4000}"
-    volumes:
-      # Use named volume by default, can be overridden with bind mount if needed
-      - evolu-relay-data:/app/data
-    environment:
-      - NODE_ENV=${NODE_ENV:-production}
-      - LOG_LEVEL=${LOG_LEVEL:-error}
-      - RELAY_NAME=${RELAY_NAME:-evolu-relay}
-      - RELAY_PORT=${RELAY_PORT:-4000}
-      - RELAY_ENABLE_LOGGING=${RELAY_ENABLE_LOGGING:-false}
-    restart: unless-stopped
-    deploy:
-      resources:
-        limits:
-          memory: ${MEMORY_LIMIT:-1G}
-          cpus: ${CPU_LIMIT:-1.0}
-        reservations:
-          memory: ${MEMORY_RESERVED:-512M}
-          cpus: ${CPU_RESERVED:-0.5}
-    healthcheck:
-      test:
-        [
-          "CMD",
-          "wget",
-          "--no-verbose",
-          "--tries=1",
-          "--spider",
-          "http://localhost:4000",
-        ]
-      interval: 30s
-      timeout: 5s
-      retries: 3
-      start_period: 30s
-    logging:
-      driver: "json-file"
-      options:
-        max-size: ${LOG_MAX_SIZE:-50m}
-        max-file: ${LOG_MAX_FILES:-5}
-    networks:
-      - evolu-network
-
-volumes:
-  evolu-relay-data:
-    driver: local
-    name: evolu-relay-data
-
-networks:
-  evolu-network:
-    name: evolu-relay-network
-    driver: bridge

package/src/cli.ts

@@ -1,59 +0,0 @@
-#!/usr/bin/env node
-
-import { Command, Option } from "commander";
-import packageJson from "../package.json" with { type: "json" };
-import { logger } from "./logger.js";
-import { startNodeJsRelay } from "./nodejs.js";
-import { cliParams } from "./params.js";
-
-function main() {
-  const program = new Command()
-    .name("@evolu/relay")
-    .description("Evolu Relay server")
-    .version(
-      packageJson.version || "1.0.0",
-      "-v, --version",
-      "display the version number",
-    );
-
-  program
-    .command("start")
-    .description("start the relay server")
-    .addOption(
-      new Option("-n, --name <name>", "database name").default("evolu-relay"),
-    )
-    .addOption(
-      new Option("-l, --enable-logging", "enable logging").default(false),
-    )
-    .addOption(
-      new Option("-p, --port <number>", "port to listen on")
-        .default(4000)
-        .argParser(Number),
-    )
-    // .addOption(
-    //   new Option("--platform <platform>", "platform")
-    //     .choices(["nodejs", "bun"])
-    //     .default("nodejs"),
-    // )
-    .action(async (options: unknown) => {
-      logger.enabled = true;
-      const params = cliParams.fromUnknown(options);
-      logger.log("Evolu Relay", packageJson.version);
-
-      if (!params.ok) {
-        logger.error(params.error.reason);
-        process.exit(1);
-      }
-
-      try {
-        await startNodeJsRelay(params.value);
-      } catch (error: unknown) {
-        logger.error(error);
-        process.exit(1);
-      }
-    });
-
-  program.parse();
-}
-
-main();

package/src/logger.ts

@@ -1,5 +0,0 @@
-import { createConsole } from "@evolu/common";
-
-// TODO: use createConsoleWithTime after release
-// export const logger = createConsoleWithTime({ timestampType: "absolute" });
-export const logger = createConsole();

package/src/nodejs.ts

@@ -1,30 +0,0 @@
-import { createNodeJsRelay } from "@evolu/nodejs";
-import { mkdirSync } from "fs";
-import { once } from "node:events";
-import { logger } from "./logger.js";
-import { CliParams } from "./params.js";
-
-export async function startNodeJsRelay(options: CliParams): Promise<void> {
-  // Ensure the database is created in a predictable location for Docker.
-  mkdirSync("data", { recursive: true });
-  process.chdir("data");
-
-  if (options.enableLogging) {
-    logger.enabled = true;
-  }
-
-  const relay = await createNodeJsRelay({ console: logger })({
-    port: options.port,
-    enableLogging: options.enableLogging,
-    name: options.name,
-  });
-
-  await Promise.race([
-    once(process, "SIGINT"), // Ctrl-C
-    once(process, "SIGTERM"), // OS/k8s/etc requested termination
-  ]);
-
-  logger.enabled = true;
-  logger.log("Shutting down relay server");
-  relay[Symbol.dispose]();
-}

package/src/params.ts

@@ -1,9 +0,0 @@
-import { Boolean, Number, object, SimpleName } from "@evolu/common";
-
-export const cliParams = object({
-  name: SimpleName,
-  enableLogging: Boolean,
-  port: Number,
-});
-
-export type CliParams = typeof cliParams.Type;

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "@evolu/tsconfig/universal-esm.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "module": "nodenext",
-    "resolveJsonModule": true
-  },
-  "include": ["src"],
-  "exclude": ["node_modules"]
-}