@elizaos/plugin-signal 2.0.0-alpha

package/dist/types.d.ts

@@ -0,0 +1,172 @@
+import type { Character, EventPayload, MessagePayload, WorldPayload } from "@elizaos/core";
+/**
+ * Signal-specific event types
+ */
+export declare enum SignalEventTypes {
+    MESSAGE_RECEIVED = "SIGNAL_MESSAGE_RECEIVED",
+    MESSAGE_SENT = "SIGNAL_MESSAGE_SENT",
+    REACTION_RECEIVED = "SIGNAL_REACTION_RECEIVED",
+    GROUP_JOINED = "SIGNAL_GROUP_JOINED",
+    GROUP_LEFT = "SIGNAL_GROUP_LEFT",
+    TYPING_STARTED = "SIGNAL_TYPING_STARTED",
+    TYPING_STOPPED = "SIGNAL_TYPING_STOPPED",
+    READ_RECEIPT = "SIGNAL_READ_RECEIPT"
+}
+export interface SignalMessageReceivedPayload extends MessagePayload {
+    sender: string;
+    groupId: string | undefined;
+    timestamp: number;
+    attachments: SignalAttachment[];
+    isGroupMessage: boolean;
+}
+export interface SignalMessageSentPayload extends MessagePayload {
+    recipient: string;
+    groupId: string | undefined;
+    timestamp: number;
+}
+export interface SignalReactionPayload extends EventPayload {
+    emoji: string;
+    sender: string;
+    targetTimestamp: number;
+    targetAuthor: string;
+    isRemove: boolean;
+}
+export interface SignalGroupPayload extends WorldPayload {
+    groupId: string;
+    groupName: string;
+    members: string[];
+}
+export interface SignalAttachment {
+    contentType: string;
+    filename: string | undefined;
+    id: string;
+    size: number;
+    width: number | undefined;
+    height: number | undefined;
+    caption: string | undefined;
+    blurhash: string | undefined;
+}
+export interface SignalEventPayloadMap {
+    [SignalEventTypes.MESSAGE_RECEIVED]: SignalMessageReceivedPayload;
+    [SignalEventTypes.MESSAGE_SENT]: SignalMessageSentPayload;
+    [SignalEventTypes.REACTION_RECEIVED]: SignalReactionPayload;
+    [SignalEventTypes.GROUP_JOINED]: SignalGroupPayload;
+    [SignalEventTypes.GROUP_LEFT]: SignalGroupPayload;
+}
+export interface SignalContact {
+    number: string;
+    uuid: string | undefined;
+    name: string | undefined;
+    profileName: string | undefined;
+    color: string | undefined;
+    blocked: boolean;
+}
+export interface SignalGroup {
+    id: string;
+    name: string;
+    description: string | undefined;
+    isMember: boolean;
+    isBlocked: boolean;
+    members: SignalGroupMember[];
+    admins: string[];
+    inviteLink: string | undefined;
+}
+export interface SignalGroupMember {
+    uuid: string;
+    number: string | undefined;
+    role: "ADMINISTRATOR" | "DEFAULT";
+}
+export interface SignalMessage {
+    timestamp: number;
+    sender: string;
+    senderUuid: string | undefined;
+    groupId: string | undefined;
+    message: string | undefined;
+    attachments: SignalAttachment[];
+    quote: SignalQuote | undefined;
+    reaction: SignalReactionInfo | undefined;
+    expiresInSeconds: number | undefined;
+    viewOnce: boolean;
+}
+export interface SignalQuote {
+    id: number;
+    author: string;
+    authorUuid: string | undefined;
+    text: string;
+    attachments: SignalAttachment[];
+}
+export interface SignalReactionInfo {
+    emoji: string;
+    targetAuthor: string;
+    targetAuthorUuid: string | undefined;
+    targetSentTimestamp: number;
+    isRemove: boolean;
+}
+export interface ISignalService {
+    accountNumber: string | null;
+    character: Character;
+    isConnected: boolean;
+}
+export declare const SIGNAL_SERVICE_NAME = "signal";
+export declare const ServiceType: {
+    readonly SIGNAL: "signal";
+};
+export interface SignalSettings {
+    shouldIgnoreGroupMessages: boolean;
+    allowedGroups: string[] | undefined;
+    blockedNumbers: string[] | undefined;
+}
+export interface SignalMessageSendOptions {
+    attachments: string[] | undefined;
+    quote: {
+        timestamp: number;
+        author: string;
+    } | undefined;
+    expiresInSeconds: number | undefined;
+}
+export declare class SignalPluginError extends Error {
+    readonly code: string;
+    constructor(message: string, code: string);
+}
+export declare class SignalServiceNotInitializedError extends SignalPluginError {
+    constructor();
+}
+export declare class SignalClientNotAvailableError extends SignalPluginError {
+    constructor();
+}
+export declare class SignalConfigurationError extends SignalPluginError {
+    constructor(missingConfig: string);
+}
+export declare class SignalApiError extends SignalPluginError {
+    readonly apiErrorCode: string | undefined;
+    constructor(message: string, apiErrorCode: string | undefined);
+}
+/**
+ * Normalize a phone number to E.164 format
+ */
+export declare function normalizeE164(number: string): string | null;
+/**
+ * Validates an E.164 phone number format
+ */
+export declare function isValidE164(number: string): boolean;
+/**
+ * Validates a Signal group ID format (base64-encoded)
+ */
+export declare function isValidGroupId(id: string): boolean;
+/**
+ * Validates a Signal UUID format
+ */
+export declare function isValidUuid(uuid: string): boolean;
+/**
+ * Gets the display name for a Signal contact
+ */
+export declare function getSignalContactDisplayName(contact: SignalContact): string;
+/**
+ * Maximum message length for Signal messages
+ */
+export declare const MAX_SIGNAL_MESSAGE_LENGTH = 4000;
+/**
+ * Maximum attachment size (100MB)
+ */
+export declare const MAX_SIGNAL_ATTACHMENT_SIZE: number;
+//# 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":"AAAA,OAAO,KAAK,EACV,SAAS,EAET,YAAY,EAIZ,cAAc,EACd,YAAY,EACb,MAAM,eAAe,CAAC;AAEvB;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,gBAAgB,4BAA4B;IAC5C,YAAY,wBAAwB;IACpC,iBAAiB,6BAA6B;IAC9C,YAAY,wBAAwB;IACpC,UAAU,sBAAsB;IAChC,cAAc,0BAA0B;IACxC,cAAc,0BAA0B;IACxC,YAAY,wBAAwB;CACrC;AAED,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC9D,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,4BAA4B,CAAC;IAClE,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,wBAAwB,CAAC;IAC1D,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC5D,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IACpD,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;CACnD;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,eAAe,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,QAAQ,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACzC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,eAAO,MAAM,mBAAmB,WAAW,CAAC;AAE5C,eAAO,MAAM,WAAW;;CAEd,CAAC;AAEX,MAAM,WAAW,cAAc;IAC7B,yBAAyB,EAAE,OAAO,CAAC;IACnC,aAAa,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACpC,cAAc,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAClC,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IACzD,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC;AAED,qBAAa,iBAAkB,SAAQ,KAAK;aAGxB,IAAI,EAAE,MAAM;gBAD5B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM;CAK/B;AAED,qBAAa,gCAAiC,SAAQ,iBAAiB;;CAKtE;AAED,qBAAa,6BAA8B,SAAQ,iBAAiB;;CAKnE;AAED,qBAAa,wBAAyB,SAAQ,iBAAiB;gBACjD,aAAa,EAAE,MAAM;CAIlC;AAED,qBAAa,cAAe,SAAQ,iBAAiB;aAGjC,YAAY,EAAE,MAAM,GAAG,SAAS;gBADhD,OAAO,EAAE,MAAM,EACC,YAAY,EAAE,MAAM,GAAG,SAAS;CAKnD;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAsB3D;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAGlD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CAE1E;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,OAAO,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,0BAA0B,QAAoB,CAAC"}

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@elizaos/plugin-signal",
+  "version": "2.0.0-alpha",
+  "description": "Signal messaging integration plugin for ElizaOS agents",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/elizaos-plugins/plugin-signal.git"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "elizaos",
+    "plugin",
+    "signal",
+    "messaging",
+    "secure",
+    "encrypted"
+  ],
+  "author": "elizaOS",
+  "license": "MIT",
+  "scripts": {
+    "build": "bun run build.ts",
+    "build:ts": "bun run build.ts",
+    "dev": "bun --hot build.ts",
+    "clean": "rm -rf dist .turbo node_modules",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "lint": "bunx @biomejs/biome check --write --unsafe .",
+    "lint:check": "bunx @biomejs/biome check .",
+    "format": "bunx @biomejs/biome format --write .",
+    "format:check": "bunx @biomejs/biome format ."
+  },
+  "dependencies": {
+    "@elizaos/core": "workspace:*",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "typescript": "^5.9.3",
+    "@biomejs/biome": "^2.3.11"
+  },
+  "peerDependencies": {
+    "@elizaos/core": "workspace:*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "agentConfig": {
+    "pluginType": "elizaos:plugin:1.0.0",
+    "pluginParameters": {
+      "SIGNAL_ACCOUNT_NUMBER": {
+        "type": "string",
+        "description": "Signal account phone number in E.164 format (e.g., +1234567890)",
+        "required": true,
+        "sensitive": false
+      },
+      "SIGNAL_HTTP_URL": {
+        "type": "string",
+        "description": "Signal CLI REST API URL (e.g., http://localhost:8080)",
+        "required": false,
+        "sensitive": false
+      },
+      "SIGNAL_CLI_PATH": {
+        "type": "string",
+        "description": "Path to signal-cli executable (alternative to HTTP API)",
+        "required": false,
+        "sensitive": false
+      },
+      "SIGNAL_SHOULD_IGNORE_GROUP_MESSAGES": {
+        "type": "boolean",
+        "description": "If true, the bot will only respond to direct messages",
+        "required": false,
+        "sensitive": false
+      }
+    }
+  },
+  "milaidy": {
+    "platforms": [
+      "node"
+    ],
+    "runtime": "node",
+    "platformDetails": {
+      "node": "Default export (Node.js)"
+    }
+  }
+}