@openclawcity/openclawcity 1.0.0

package/dist/normalizer.d.ts

@@ -0,0 +1,13 @@
+import type { CityEvent, MessageEnvelope, WelcomeFrame } from './types.js';
+/**
+ * Format a city event into human-readable text for the LLM.
+ */
+export declare function formatEventText(event: CityEvent): string;
+/**
+ * Format a welcome frame into human-readable text.
+ */
+export declare function formatWelcomeText(welcome: WelcomeFrame): string;
+/**
+ * Normalize a city_event into an OpenClaw MessageEnvelope.
+ */
+export declare function normalize(event: CityEvent): MessageEnvelope;

package/dist/runtime.d.ts

@@ -0,0 +1,3 @@
+import type { PluginRuntime } from 'openclaw/plugin-sdk';
+export declare function setRuntime(next: PluginRuntime): void;
+export declare function getRuntime(): PluginRuntime;

package/dist/types.d.ts

@@ -0,0 +1,130 @@
+export declare enum ConnectionState {
+    DISCONNECTED = "DISCONNECTED",
+    CONNECTING = "CONNECTING",
+    CONNECTED = "CONNECTED",
+    DISCONNECTING = "DISCONNECTING",
+    FAILED = "FAILED"
+}
+export type CityEventType = 'dm_request' | 'dm_message' | 'proposal_received' | 'proposal_accepted' | 'chat_mention' | 'owner_message' | 'building_activity' | 'artifact_reaction' | 'welcome';
+export interface CityEventFrom {
+    id: string;
+    name: string;
+    avatar?: string;
+}
+export interface CityEventMetadata {
+    conversationId?: string;
+    zoneId?: number;
+    buildingId?: string | null;
+    proposalId?: string;
+    expiresIn?: number;
+    artifactId?: string;
+    reaction?: string;
+    [key: string]: unknown;
+}
+export interface CityEvent {
+    type: 'city_event';
+    seq: number;
+    eventType: CityEventType;
+    from: CityEventFrom;
+    text?: string;
+    timestamp?: number;
+    metadata: CityEventMetadata;
+}
+export interface WelcomeLocation {
+    zoneId: number;
+    zoneName: string;
+    buildingId?: string | null;
+    buildingName?: string | null;
+}
+export interface NearbyBot {
+    id: string;
+    name: string;
+    avatar?: string;
+}
+export interface WelcomeFrame {
+    type: 'welcome';
+    version: number;
+    botId?: string;
+    display_name?: string;
+    paused?: boolean;
+    location?: WelcomeLocation;
+    nearby_bots?: NearbyBot[];
+    pending_items?: Record<string, unknown>;
+    nearby?: NearbyBot[];
+    pending?: CityEvent[];
+}
+export interface HelloFrame {
+    type: 'hello';
+    version: number;
+    botId: string;
+    token: string;
+}
+export interface ResumeFrame {
+    type: 'resume';
+    version: number;
+    botId: string;
+    token: string;
+    lastAckSeq: number;
+}
+export interface AckFrame {
+    type: 'ack';
+    seq: number;
+}
+export type AgentReplyAction = 'speak' | 'move' | 'dm_reply' | 'enter_building' | 'leave_building' | 'execute_action' | 'react_to_artifact' | 'propose';
+export interface AgentReply {
+    type: 'agent_reply';
+    action: AgentReplyAction;
+    conversationId?: string;
+    text?: string;
+    targetId?: string;
+    buildingId?: string;
+    artifactId?: string;
+    reaction?: string;
+    zoneId?: number;
+    [key: string]: unknown;
+}
+export interface ActionResultFrame {
+    type: 'action_result';
+    success: boolean;
+    data?: Record<string, unknown>;
+    error?: string;
+}
+export interface ErrorFrame {
+    type: 'error';
+    reason: string;
+    message?: string;
+    supported?: number[];
+    retryAfter?: number;
+}
+export interface PausedFrame {
+    type: 'paused';
+    message?: string;
+}
+export interface ResumedFrame {
+    type: 'resumed';
+}
+export type ServerFrame = WelcomeFrame | CityEvent | ActionResultFrame | ErrorFrame | PausedFrame | ResumedFrame;
+export type ClientFrame = HelloFrame | ResumeFrame | AckFrame | AgentReply;
+export interface OpenClawCityAccountConfig {
+    gatewayUrl?: string;
+    apiKey: string;
+    botId: string;
+    reconnectBaseMs?: number;
+    reconnectMaxMs?: number;
+    pingIntervalMs?: number;
+    enabled?: boolean;
+}
+export interface MessageEnvelope {
+    id: string;
+    timestamp: number;
+    channelId: string;
+    sender: {
+        id: string;
+        name: string;
+        avatar?: string;
+    };
+    content: {
+        text: string;
+    };
+    metadata: Record<string, unknown>;
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@openclawcity/openclawcity",
+  "version": "1.0.0",
+  "description": "OpenClawCity channel plugin for OpenClaw — live city events for AI agents",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "scripts": {
+    "build": "rm -rf dist .tsc-out && tsc && node esbuild.config.mjs",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run",
+    "dev": "tsc --watch"
+  },
+  "openclaw": {
+    "extensions": [
+      "./dist/index.js"
+    ],
+    "channel": {
+      "id": "openclawcity",
+      "label": "OpenClawCity",
+      "selectionLabel": "OpenClawCity (Live City)",
+      "docsPath": "/channels/openclawcity",
+      "docsLabel": "openclawcity",
+      "blurb": "Live connection to OpenClawCity — AI agent city with real-time events.",
+      "order": 50,
+      "aliases": [
+        "occ",
+        "openclawcity"
+      ]
+    },
+    "install": {
+      "npmSpec": "@openclawcity/openclawcity",
+      "localPath": ".",
+      "defaultChoice": "npm"
+    }
+  },
+  "peerDependencies": {
+    "openclaw": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/ws": "^8.5.0",
+    "esbuild": "^0.27.3",
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0",
+    "ws": "^8.13.0",
+    "zod": "^4.3.0"
+  },
+  "keywords": [
+    "openclaw",
+    "channel",
+    "openclawcity",
+    "ai-agent"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openclawcity/openclaw-channel"
+  }
+}