OpenThreads: Full Implementation Roadmap (meta/17 → main)

.env.example

@@ -0,0 +1,68 @@
+# =============================================================================
+# OpenThreads — Environment Variables
+# Copy this file to .env and fill in your values.
+# =============================================================================
+
+# Server
+PORT=3000
+NODE_ENV=development
+
+# Logging (structured JSON logging)
+# LOG_LEVEL=info           # debug | info | warn | error (default: info)
+# LOG_FORMAT=text          # json | text (default: json in production, text in development)
+
+# MongoDB
+# When using Docker Compose: mongodb://openthreads:openthreads@localhost:27017/openthreads
+MONGODB_URI=mongodb://openthreads:openthreads@localhost:27017/openthreads
+
+# Security
+# IMPORTANT: Change this in production! Use a long, random string.
+JWT_SECRET=change-me-in-production
+
+# Management API Key — required to access /api/channels, /api/recipients, /api/routes
+# Leave unset to allow unauthenticated access in development.
+# MANAGEMENT_API_KEY=change-me-in-production
+
+# Reply Token TTL (in seconds)
+# Default: 86400 (24 hours)
+REPLY_TOKEN_TTL=86400
+
+# Base URL for OpenThreads (used to build replyTo URLs and form links)
+OPENTHREADS_BASE_URL=http://localhost:3000
+
+# =============================================================================
+# Channel Credentials
+# Add credentials for each channel you want to enable.
+# =============================================================================
+
+# Slack
+# SLACK_BOT_TOKEN=xoxb-your-slack-bot-token
+# SLACK_SIGNING_SECRET=your-slack-signing-secret
+# SLACK_APP_TOKEN=xapp-your-slack-app-token
+
+# Telegram
+# TELEGRAM_BOT_TOKEN=your-telegram-bot-token
+
+# Discord
+# DISCORD_BOT_TOKEN=your-discord-bot-token
+# DISCORD_CLIENT_ID=your-discord-client-id
+
+# =============================================================================
+# Trust Layer (optional)
+# Enable for production deployments requiring strong authentication and
+# cryptographic evidence (JWS signing, WebAuthn, audit logging).
+# =============================================================================
+
+# TRUST_LAYER_ENABLED=false
+# TRUST_JWS_ALGORITHM=RS256
+# TRUST_PRIVATE_KEY_PATH=./keys/private.pem
+# TRUST_PUBLIC_KEY_PATH=./keys/public.pem
+
+# =============================================================================
+# Observability (optional)
+# =============================================================================
+
+# OpenTelemetry — set OTEL_EXPORTER_OTLP_ENDPOINT to enable tracing
+# OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318
+# OTEL_SERVICE_NAME=openthreads
+# OTEL_SDK_DISABLED=false

.gitignore

@@ -0,0 +1,32 @@
+# Dependencies
+node_modules/
+
+# Build outputs
+dist/
+.next/
+*.tsbuildinfo
+
+# Environment files
+.env
+.env.local
+.env.*.local
+!.env.example
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+npm-debug.log*
+bun-debug.log*
+
+# Test coverage
+coverage/
+
+# OS
+.DS_Store

.prettierignore

@@ -0,0 +1,6 @@
+node_modules/
+dist/
+.next/
+coverage/
+*.lockb
+bun.lockb

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

Dockerfile

@@ -0,0 +1,53 @@
+# ─── Build stage ─────────────────────────────────────────────────────────────
+FROM oven/bun:1.2 AS builder
+
+WORKDIR /app
+
+# Copy workspace manifests first for layer caching
+COPY package.json bun.lockb* ./
+COPY packages/core/package.json ./packages/core/
+COPY packages/server/package.json ./packages/server/
+COPY packages/storage/mongodb/package.json ./packages/storage/mongodb/
+COPY packages/trust/package.json ./packages/trust/
+COPY packages/channels/package.json ./packages/channels/
+COPY packages/channels/discord/package.json ./packages/channels/discord/
+COPY packages/channels/slack/package.json ./packages/channels/slack/
+COPY packages/channels/telegram/package.json ./packages/channels/telegram/
+COPY packages/channels/whatsapp/package.json ./packages/channels/whatsapp/
+
+RUN bun install --frozen-lockfile
+
+# Copy source
+COPY tsconfig.base.json tsconfig.json ./
+COPY packages ./packages
+
+# Build the Next.js server
+WORKDIR /app/packages/server
+ENV NEXT_TELEMETRY_DISABLED=1
+RUN bun run build
+
+# ─── Production stage ─────────────────────────────────────────────────────────
+FROM oven/bun:1.2-slim AS runner
+
+WORKDIR /app
+
+ENV NODE_ENV=production
+ENV NEXT_TELEMETRY_DISABLED=1
+ENV PORT=3000
+
+RUN addgroup --system --gid 1001 nodejs && \
+    adduser --system --uid 1001 nextjs
+
+# Copy built artifacts
+COPY --from=builder /app/packages/server/.next/standalone ./
+COPY --from=builder /app/packages/server/.next/static ./packages/server/.next/static
+COPY --from=builder /app/packages/server/public ./packages/server/public 2>/dev/null || true
+
+USER nextjs
+
+EXPOSE 3000
+
+HEALTHCHECK --interval=30s --timeout=5s --start-period=15s --retries=3 \
+  CMD bun -e "fetch('http://localhost:3000/api/health').then(r=>r.ok?process.exit(0):process.exit(1)).catch(()=>process.exit(1))"
+
+CMD ["bun", "packages/server/server.js"]

deploy/helm/openthreads/Chart.yaml

@@ -0,0 +1,21 @@
+apiVersion: v2
+name: openthreads
+description: >
+  OpenThreads — a unified messaging gateway with human-in-the-loop support.
+  Bridges Slack, Discord, Telegram, WhatsApp, and other channels to any
+  HTTP-based agent or service via the A2H protocol.
+type: application
+version: 0.1.0
+appVersion: "0.1.0"
+keywords:
+  - openthreads
+  - a2h
+  - human-in-the-loop
+  - messaging
+  - webhook
+home: https://github.com/deepducks/OpenThreads
+sources:
+  - https://github.com/deepducks/OpenThreads
+maintainers:
+  - name: DeepDucks
+    url: https://github.com/deepducks

deploy/helm/openthreads/templates/_helpers.tpl

@@ -0,0 +1,60 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "openthreads.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+*/}}
+{{- define "openthreads.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart label.
+*/}}
+{{- define "openthreads.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels.
+*/}}
+{{- define "openthreads.labels" -}}
+helm.sh/chart: {{ include "openthreads.chart" . }}
+{{ include "openthreads.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels.
+*/}}
+{{- define "openthreads.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "openthreads.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+ServiceAccount name.
+*/}}
+{{- define "openthreads.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "openthreads.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

deploy/helm/openthreads/templates/deployment.yaml

@@ -0,0 +1,74 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "openthreads.fullname" . }}
+  labels:
+    {{- include "openthreads.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "openthreads.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      annotations:
+        checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
+        {{- if .Values.metrics.annotations }}
+        prometheus.io/scrape: "true"
+        prometheus.io/port: "{{ .Values.service.port }}"
+        prometheus.io/path: "/api/metrics"
+        {{- end }}
+        {{- with .Values.podAnnotations }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+      labels:
+        {{- include "openthreads.labels" . | nindent 8 }}
+        {{- with .Values.podLabels }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "openthreads.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: {{ .Values.service.port }}
+              protocol: TCP
+          envFrom:
+            - secretRef:
+                name: {{ if .Values.existingSecret }}{{ .Values.existingSecret }}{{ else }}{{ include "openthreads.fullname" . }}{{ end }}
+          env:
+            {{- range $key, $value := .Values.env }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+            {{- end }}
+          livenessProbe:
+            {{- toYaml .Values.livenessProbe | nindent 12 }}
+          readinessProbe:
+            {{- toYaml .Values.readinessProbe | nindent 12 }}
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

deploy/helm/openthreads/templates/hpa.yaml

@@ -0,0 +1,22 @@
+{{- if .Values.autoscaling.enabled }}
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "openthreads.fullname" . }}
+  labels:
+    {{- include "openthreads.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "openthreads.fullname" . }}
+  minReplicas: {{ .Values.autoscaling.minReplicas }}
+  maxReplicas: {{ .Values.autoscaling.maxReplicas }}
+  metrics:
+    - type: Resource
+      resource:
+        name: cpu
+        target:
+          type: Utilization
+          averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }}
+{{- end }}

deploy/helm/openthreads/templates/ingress.yaml

@@ -0,0 +1,35 @@
+{{- if .Values.ingress.enabled -}}
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: {{ include "openthreads.fullname" . }}
+  labels:
+    {{- include "openthreads.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if .Values.ingress.className }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- toYaml .Values.ingress.tls | nindent 4 }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            pathType: {{ .pathType }}
+            backend:
+              service:
+                name: {{ include "openthreads.fullname" $ }}
+                port:
+                  number: {{ $.Values.service.port }}
+          {{- end }}
+    {{- end }}
+{{- end }}