@agora-server/contract 0.9.2

package/dist/secure-chat.js

@@ -0,0 +1,85 @@
+// Secure chat (end-to-end-encrypted, MLS/RFC-9420) wire contract.
+//
+// This is a SEPARATE surface from the Replyke-compatible plaintext chat (types.ts /
+// schemas.ts) — it is NOT consumed by the forked Replyke SDK. The server is a blind MLS
+// Delivery Service: every binary value (KeyPackages, Welcomes, Commits, application
+// ciphertext, key-backup blobs) crosses the wire as **base64** and the server never parses
+// it. MLS epochs are u64 (exceed JS safe-int) so they travel as **decimal strings**.
+//
+// Pure zod + TS — no hono/drizzle. Request schemas feed the server's parseBody(); the
+// model interfaces are the response shapes the route shapers produce.
+import { z } from "zod";
+// Base64 (standard alphabet, optional padding). The server enforces the real DECODED byte
+// caps (MAX_SECURE_MESSAGE_BYTES / MAX_SECURE_HANDSHAKE_BYTES); this just rejects non-base64
+// and an absurd pre-decode length so a garbage body fails fast at validation.
+const MAX_B64_CHARS = 16_777_216; // ~12 MiB decoded — generous upper guard, real cap is server-side
+export const base64 = z
+    .string()
+    .min(1)
+    .max(MAX_B64_CHARS)
+    .regex(/^[A-Za-z0-9+/]+={0,2}$/, "must be base64");
+// MLS epoch as a non-negative decimal string (u64-safe on the wire).
+export const epochString = z.string().regex(/^\d+$/, "epoch must be a non-negative integer string");
+const ciphersuite = z.number().int().positive();
+// ─── reusable sub-objects ────────────────────────────────────────────────────
+// A Welcome is targeted at the ONE device whose claimed KeyPackage was consumed.
+export const welcomeSchema = z.object({
+    targetDeviceId: z.string().uuid(),
+    payload: base64,
+    epoch: epochString,
+});
+// A Commit/Proposal is broadcast to the whole group (no target device).
+export const handshakeBlobSchema = z.object({
+    payload: base64,
+    epoch: epochString,
+});
+// ─── request schemas (server: parseBody(schema, raw, "secure-chat")) ─────────
+export const registerDeviceSchema = z.object({
+    deviceId: z.string().min(1).max(200), // client-generated stable id (one device = one MLS leaf)
+    displayName: z.string().max(200).nullish(),
+    signaturePublicKey: base64,
+    credential: base64,
+    ciphersuite,
+});
+export const publishKeyPackagesSchema = z.object({
+    keyPackages: z
+        .array(z.object({
+        keyPackageRef: z.string().min(1).max(512),
+        keyPackage: base64,
+        ciphersuite,
+        expiresAt: z.string().datetime().nullish(),
+    }))
+        .min(1)
+        .max(100),
+});
+export const createSecureConversationSchema = z.object({
+    type: z.enum(["dm", "group", "channel"]),
+    mlsGroupId: base64,
+    spaceId: z.string().uuid().nullish(), // required when type === "channel" (enforced server-side)
+    name: z.string().max(300).nullish(), // optional plaintext label; prefer null (metadata concession)
+    memberUserIds: z.array(z.string().uuid()).max(1000).default([]),
+    welcomes: z.array(welcomeSchema).max(1000).default([]),
+});
+export const addSecureMemberSchema = z.object({
+    userId: z.string().uuid(),
+    commit: handshakeBlobSchema,
+    welcomes: z.array(welcomeSchema).min(1).max(50),
+});
+export const removeSecureMemberSchema = z.object({
+    commit: handshakeBlobSchema,
+});
+export const sendSecureMessageSchema = z.object({
+    ciphertext: base64,
+    epoch: epochString,
+    senderDeviceId: z.string().uuid(),
+    contentType: z.string().max(100).nullish(),
+});
+export const uploadKeyBackupSchema = z.object({
+    deviceId: z.string().max(200).nullish(),
+    blob: base64,
+    nonce: base64,
+    kdf: z.enum(["argon2id", "pbkdf2"]),
+    kdfParams: z.record(z.string(), z.unknown()),
+    cipher: z.enum(["xchacha20poly1305", "aes-256-gcm"]),
+    version: z.number().int().positive(),
+});

package/dist/types.d.ts

@@ -0,0 +1,144 @@
+import type { ReactionCounts, ReactionType } from "./reactions.js";
+export interface User {
+    id: string;
+    projectId: string;
+    foreignId: string | null;
+    role: "admin" | "moderator" | "visitor";
+    name: string | null;
+    username: string | null;
+    avatar: string | null;
+    avatarFileId: string | null;
+    bannerFileId: string | null;
+    bio: string | null;
+    birthdate: string | null;
+    location: unknown | null;
+    metadata: Record<string, unknown>;
+    reputation: number;
+    createdAt: string;
+}
+export interface Entity {
+    id: string;
+    foreignId: string | null;
+    shortId: string;
+    projectId: string;
+    sourceId: string | null;
+    spaceId: string | null;
+    space?: unknown;
+    userId: string | null;
+    user?: User | null;
+    title: string | null;
+    content: string | null;
+    mentions: unknown[];
+    attachments: unknown[];
+    files?: unknown[];
+    keywords: string[];
+    upvotes: string[];
+    downvotes: string[];
+    reactionCounts: ReactionCounts;
+    userReaction: ReactionType | null;
+    repliesCount: number;
+    views: number;
+    score: number;
+    scoreUpdatedAt: string;
+    location: unknown | null;
+    metadata: Record<string, unknown>;
+    isSaved?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    isDraft: boolean;
+    moderationStatus: string | null;
+    moderatedAt: string | null;
+    moderatedById: string | null;
+    moderatedByType: string | null;
+    moderationReason: string | null;
+}
+export interface Comment {
+    id: string;
+    projectId: string;
+    foreignId: string | null;
+    entityId: string;
+    userId: string | null;
+    user?: User | null;
+    parentId: string | null;
+    parentComment?: Comment | null;
+    content: string | null;
+    gif: unknown | null;
+    mentions: unknown[];
+    upvotes: string[];
+    downvotes: string[];
+    reactionCounts: ReactionCounts;
+    userReaction: ReactionType | null;
+    repliesCount: number;
+    metadata: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    userDeletedAt: string | null;
+    moderationStatus: string | null;
+    moderatedAt: string | null;
+    moderatedById: string | null;
+    moderatedByType: string | null;
+    moderationReason: string | null;
+}
+export interface AuthUser extends User {
+    email: string | null;
+    isVerified: boolean;
+    isActive: boolean;
+    lastActive: string;
+    updatedAt: string;
+    suspensions: {
+        reason: string | null;
+        startDate: string;
+        endDate: string | null;
+    }[];
+    authMethods: string[];
+    isOperator: boolean;
+    isSteward: boolean;
+}
+export type ReportTargetType = "entity" | "comment" | "message";
+export interface UserSummary {
+    id: string;
+    username: string | null;
+    name: string | null;
+    reputation: number;
+}
+export interface Report {
+    id: string;
+    projectId: string;
+    reporterId: string | null;
+    targetType: ReportTargetType;
+    targetId: string;
+    spaceId: string | null;
+    reason: string;
+    details: string | null;
+    resolvedAt: string | null;
+    resolvedById: string | null;
+    createdAt: string;
+    author?: UserSummary | null;
+    reporter?: UserSummary | null;
+}
+export interface AuthContext {
+    userId: string;
+    role: "admin" | "moderator" | "visitor";
+    isOperator: boolean;
+    isSteward: boolean;
+}
+export type ModerationVerdict = "allow" | "block" | "review";
+export interface ModerationAnalysis {
+    id: string;
+    projectId: string;
+    targetType: ReportTargetType;
+    targetId: string;
+    spaceId: string | null;
+    verdict: ModerationVerdict;
+    categories: string[];
+    confidence: number;
+    reason: string;
+    model: string;
+    autoActioned: boolean;
+    humanResolvedAt: string | null;
+    createdAt: string;
+    author?: UserSummary | null;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnE,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;IACxC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,EAAE,cAAc,CAAC;IAC/B,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,cAAc,EAAE,cAAc,CAAC;IAC/B,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,QAAS,SAAQ,IAAI;IACpC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE;QAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,EAAE,CAAC;IACpF,WAAW,EAAE,MAAM,EAAE,CAAC;IAGtB,UAAU,EAAE,OAAO,CAAC;IAGpB,SAAS,EAAE,OAAO,CAAC;CACpB;AAGD,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;AAKhE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC/B;AAGD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;IACxC,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;CACpB;AAKD,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAI7D,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B"}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@agora-server/contract",
+  "version": "0.9.2",
+  "type": "module",
+  "description": "Shared Agora API contract — response-model types + zod request schemas (no hono/drizzle).",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jenova-marie/agora-server.git",
+    "directory": "packages/contract"
+  },
+  "homepage": "https://github.com/jenova-marie/agora-server/tree/main/packages/contract",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.2",
+    "vitest": "^4.1.7"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsc -w -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}