piece-signal-cli-rest-api 0.1.14 → 0.2.0

package/package.json

@@ -1,29 +1,7 @@
 {
   "name": "piece-signal-cli-rest-api",
-  "version": "0.1.14",
+  "version": "0.2.0",
   "dependencies": {
-    "@sinclair/typebox": "0.34.11",
-    "ai": "5.0.104",
-    "axios": "1.13.1",
-    "axios-retry": "4.4.1",
-    "deepmerge-ts": "7.1.0",
-    "form-data": "4.0.4",
-    "i18next": "23.13.0",
-    "mime-types": "2.1.35",
-    "nanoid": "3.3.8",
-    "semver": "7.6.0",
-    "socket.io-client": "4.8.1",
-    "ws": "^8.18.0",
-    "zod": "4.1.13",
-    "@activepieces/pieces-common": "0.11.2",
-    "@activepieces/pieces-framework": "0.24.0",
-    "@activepieces/shared": "0.32.0",
-    "tslib": "2.6.2"
-  },
-  "resolutions": {
-    "rollup": "npm:@rollup/wasm-node"
-  },
-  "types": "./src/index.d.ts",
-  "main": "./src/index.js",
-  "type": "commonjs"
-}
+    "ws": "^8.18.0"
+  }
+}

package/project.json

@@ -0,0 +1,58 @@
+{
+  "name": "pieces-signal-cli-rest-api",
+  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/pieces/community/signal-cli-rest-api/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": [
+        "{options.outputPath}"
+      ],
+      "options": {
+        "outputPath": "dist/packages/pieces/community/signal-cli-rest-api",
+        "tsConfig": "packages/pieces/community/signal-cli-rest-api/tsconfig.lib.json",
+        "packageJson": "packages/pieces/community/signal-cli-rest-api/package.json",
+        "main": "packages/pieces/community/signal-cli-rest-api/src/index.ts",
+        "assets": [
+          "packages/pieces/community/signal-cli-rest-api/*.md",
+          {
+            "input": "packages/pieces/community/signal-cli-rest-api/src/i18n",
+            "output": "./src/i18n",
+            "glob": "**/!(i18n.json)"
+          }
+        ],
+        "buildableProjectDepsInPackageJsonType": "dependencies",
+        "updateBuildableProjectDepsInPackageJson": true,
+        "clean": false
+      },
+      "dependsOn": [
+        "^build",
+        "prebuild"
+      ]
+    },
+    "publish": {
+      "command": "node tools/scripts/publish.mjs pieces-signal-cli-rest-api {args.ver} {args.tag}",
+      "dependsOn": [
+        "build"
+      ]
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": [
+        "{options.outputFile}"
+      ]
+    },
+    "prebuild": {
+      "executor": "nx:run-commands",
+      "options": {
+        "cwd": "packages/pieces/community/signal-cli-rest-api",
+        "command": "bun install --no-save --silent"
+      },
+      "dependsOn": [
+        "^build"
+      ]
+    }
+  },
+  "tags": []
+}

package/src/index.ts

@@ -0,0 +1,87 @@
+import { createPiece } from '@activepieces/pieces-framework';
+import { PieceCategory } from '@activepieces/shared';
+import { signalCliRestApiAuth } from './lib/common/auth';
+import { sendMessage } from './lib/actions/send-message';
+import { createGroup } from './lib/actions/create-group';
+import { listGroups } from './lib/actions/list-groups';
+import { getGroup } from './lib/actions/get-group';
+import { updateGroup } from './lib/actions/update-group';
+import { deleteGroup } from './lib/actions/delete-group';
+import { addMembersToGroup } from './lib/actions/add-members-to-group';
+import { removeMembersFromGroup } from './lib/actions/remove-members-from-group';
+import { addAdminsToGroup } from './lib/actions/add-admins-to-group';
+import { removeAdminsFromGroup } from './lib/actions/remove-admins-from-group';
+import { joinGroup } from './lib/actions/join-group';
+import { quitGroup } from './lib/actions/quit-group';
+import { blockGroup } from './lib/actions/block-group';
+import { listContacts } from './lib/actions/list-contacts';
+import { getContact } from './lib/actions/get-contact';
+import { updateContact } from './lib/actions/update-contact';
+import { syncContacts } from './lib/actions/sync-contacts';
+import { updateProfile } from './lib/actions/update-profile';
+import { sendReaction } from './lib/actions/send-reaction';
+import { removeReaction } from './lib/actions/remove-reaction';
+import { sendReceipt } from './lib/actions/send-receipt';
+import { startTyping } from './lib/actions/start-typing';
+import { stopTyping } from './lib/actions/stop-typing';
+import { listAccounts } from './lib/actions/list-accounts';
+import { getQrCodeLink } from './lib/actions/get-qr-code-link';
+import { listDevices } from './lib/actions/list-devices';
+import { addDevice } from './lib/actions/add-device';
+import { removeDevice } from './lib/actions/remove-device';
+import { remoteDeleteMessage } from './lib/actions/remote-delete-message';
+import { listAttachments } from './lib/actions/list-attachments';
+import { searchNumbers } from './lib/actions/search-numbers';
+import { listIdentities } from './lib/actions/list-identities';
+import { updateAccountSettings } from './lib/actions/update-account-settings';
+import { requestApprovalMessage } from './lib/actions/request-approval-message';
+import { receiveMessages } from './lib/actions/receive-messages';
+import { newGroupMember } from './lib/triggers/new-group-member';
+
+export const signalCliRestApi = createPiece({
+	displayName: 'Signal CLI REST API',
+	description: 'Interact with Signal Messenger via signal-cli-rest-api',
+	auth: signalCliRestApiAuth,
+	minimumSupportedRelease: '0.30.0',
+	logoUrl: 'https://cdn.activepieces.com/pieces/signal.png',
+	categories: [PieceCategory.COMMUNICATION],
+	authors: [],
+	actions: [
+		sendMessage,
+		createGroup,
+		listGroups,
+		getGroup,
+		updateGroup,
+		deleteGroup,
+		addMembersToGroup,
+		removeMembersFromGroup,
+		addAdminsToGroup,
+		removeAdminsFromGroup,
+		joinGroup,
+		quitGroup,
+		blockGroup,
+		listContacts,
+		getContact,
+		updateContact,
+		syncContacts,
+		updateProfile,
+		sendReaction,
+		removeReaction,
+		sendReceipt,
+		startTyping,
+		stopTyping,
+		listAccounts,
+		getQrCodeLink,
+		listDevices,
+		addDevice,
+		removeDevice,
+		remoteDeleteMessage,
+		listAttachments,
+		searchNumbers,
+		listIdentities,
+		updateAccountSettings,
+		requestApprovalMessage,
+		receiveMessages,
+	],
+	triggers: [newGroupMember],
+});

package/src/lib/actions/add-admins-to-group.ts

@@ -0,0 +1,50 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { formatPhoneNumber } from '../common/utils';
+
+interface ChangeGroupAdminsRequest {
+	admins: string[];
+}
+
+export const addAdminsToGroup = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'addAdminsToGroup',
+	displayName: 'Add Admins to Group',
+	description: 'Add one or more admins to a Signal group',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		groupid: Property.ShortText({
+			displayName: 'Group ID',
+			description: 'Group ID (base64 encoded)',
+			required: true,
+		}),
+		admins: Property.Array({
+			displayName: 'Admins',
+			description: 'Array of phone numbers to add as admins',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { number, groupid, admins } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		const requestBody: ChangeGroupAdminsRequest = {
+			admins: admins as string[],
+		};
+
+		await apiClient.post(
+			`/v1/groups/${encodeURIComponent(formattedNumber)}/${encodeURIComponent(groupid)}/admins`,
+			requestBody
+		);
+
+		return { success: true };
+	},
+});

package/src/lib/actions/add-device.ts

@@ -0,0 +1,45 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { formatPhoneNumber } from '../common/utils';
+
+interface AddDeviceRequest {
+	uri: string;
+}
+
+export const addDevice = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'addDevice',
+	displayName: 'Add Device',
+	description: 'Link another device to this device (only works if this is the master device)',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		uri: Property.LongText({
+			displayName: 'Device Link URI',
+			description: 'Device link URI from QR code or raw endpoint',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { number, uri } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		const requestBody: AddDeviceRequest = {
+			uri,
+		};
+
+		await apiClient.post(
+			`/v1/devices/${encodeURIComponent(formattedNumber)}`,
+			requestBody
+		);
+
+		return { success: true };
+	},
+});

package/src/lib/actions/add-members-to-group.ts

@@ -0,0 +1,50 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { formatPhoneNumber } from '../common/utils';
+
+interface ChangeGroupMembersRequest {
+	members: string[];
+}
+
+export const addMembersToGroup = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'addMembersToGroup',
+	displayName: 'Add Members to Group',
+	description: 'Add one or more members to a Signal group',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		groupid: Property.ShortText({
+			displayName: 'Group ID',
+			description: 'Group ID (base64 encoded)',
+			required: true,
+		}),
+		members: Property.Array({
+			displayName: 'Members',
+			description: 'Array of phone numbers to add as members',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { number, groupid, members } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		const requestBody: ChangeGroupMembersRequest = {
+			members: members as string[],
+		};
+
+		await apiClient.post(
+			`/v1/groups/${encodeURIComponent(formattedNumber)}/${encodeURIComponent(groupid)}/members`,
+			requestBody
+		);
+
+		return { success: true };
+	},
+});

package/src/lib/actions/block-group.ts

@@ -0,0 +1,36 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { formatPhoneNumber } from '../common/utils';
+
+export const blockGroup = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'blockGroup',
+	displayName: 'Block Group',
+	description: 'Block a Signal group',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		groupid: Property.ShortText({
+			displayName: 'Group ID',
+			description: 'Group ID (base64 encoded)',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { number, groupid } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		await apiClient.post(
+			`/v1/groups/${encodeURIComponent(formattedNumber)}/${encodeURIComponent(groupid)}/block`
+		);
+
+		return { success: true };
+	},
+});

package/src/lib/actions/create-group.ts

@@ -0,0 +1,139 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { formatPhoneNumber } from '../common/utils';
+
+interface CreateGroupRequest {
+	name: string;
+	members: string[];
+	description?: string;
+	permissions?: {
+		add_members: 'every-member' | 'only-admins';
+		edit_group: 'every-member' | 'only-admins';
+		send_messages: 'every-member' | 'only-admins';
+	};
+	group_link?: 'disabled' | 'enabled' | 'enabled-with-approval';
+	expiration_time?: number;
+}
+
+interface CreateGroupResponse {
+	id: string;
+}
+
+export const createGroup = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'createGroup',
+	displayName: 'Create Group',
+	description: 'Create a new Signal group',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		name: Property.ShortText({
+			displayName: 'Group Name',
+			description: 'Name of the group',
+			required: true,
+		}),
+		members: Property.Array({
+			displayName: 'Members',
+			description: 'Array of phone numbers to add as members',
+			required: true,
+		}),
+		description: Property.LongText({
+			displayName: 'Description',
+			description: 'Group description',
+			required: false,
+		}),
+		add_members_permission: Property.StaticDropdown({
+			displayName: 'Add Members Permission',
+			description: 'Who can add members',
+			required: false,
+			options: {
+				options: [
+					{ label: 'Every Member', value: 'every-member' },
+					{ label: 'Only Admins', value: 'only-admins' },
+				],
+			},
+		}),
+		edit_group_permission: Property.StaticDropdown({
+			displayName: 'Edit Group Permission',
+			description: 'Who can edit the group',
+			required: false,
+			options: {
+				options: [
+					{ label: 'Every Member', value: 'every-member' },
+					{ label: 'Only Admins', value: 'only-admins' },
+				],
+			},
+		}),
+		send_messages_permission: Property.StaticDropdown({
+			displayName: 'Send Messages Permission',
+			description: 'Who can send messages',
+			required: false,
+			options: {
+				options: [
+					{ label: 'Every Member', value: 'every-member' },
+					{ label: 'Only Admins', value: 'only-admins' },
+				],
+			},
+		}),
+		group_link: Property.StaticDropdown({
+			displayName: 'Group Link',
+			description: 'Group link state',
+			required: false,
+			options: {
+				options: [
+					{ label: 'Disabled', value: 'disabled' },
+					{ label: 'Enabled', value: 'enabled' },
+					{ label: 'Enabled with Approval', value: 'enabled-with-approval' },
+				],
+			},
+		}),
+		expiration_time: Property.Number({
+			displayName: 'Expiration Time',
+			description: 'Message expiration time in seconds',
+			required: false,
+		}),
+	},
+	async run(context) {
+		const { number, name, members, description, add_members_permission, edit_group_permission, send_messages_permission, group_link, expiration_time } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		const requestBody: CreateGroupRequest = {
+			name,
+			members: members as string[],
+		};
+
+		if (description) {
+			requestBody.description = description;
+		}
+
+		if (add_members_permission || edit_group_permission || send_messages_permission) {
+			requestBody.permissions = {
+				add_members: (add_members_permission as 'every-member' | 'only-admins') || 'every-member',
+				edit_group: (edit_group_permission as 'every-member' | 'only-admins') || 'every-member',
+				send_messages: (send_messages_permission as 'every-member' | 'only-admins') || 'every-member',
+			};
+		}
+
+		if (group_link) {
+			requestBody.group_link = group_link as 'disabled' | 'enabled' | 'enabled-with-approval';
+		}
+
+		if (expiration_time) {
+			requestBody.expiration_time = expiration_time;
+		}
+
+		const response = await apiClient.post<CreateGroupResponse>(
+			`/v1/groups/${encodeURIComponent(formattedNumber)}`,
+			requestBody
+		);
+
+		return response;
+	},
+});

package/src/lib/actions/delete-group.ts

@@ -0,0 +1,36 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { formatPhoneNumber } from '../common/utils';
+
+export const deleteGroup = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'deleteGroup',
+	displayName: 'Delete Group',
+	description: 'Delete a Signal group',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		groupid: Property.ShortText({
+			displayName: 'Group ID',
+			description: 'Group ID (base64 encoded)',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { number, groupid } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		await apiClient.delete(
+			`/v1/groups/${encodeURIComponent(formattedNumber)}/${encodeURIComponent(groupid)}`
+		);
+
+		return { success: true };
+	},
+});

package/src/lib/actions/get-contact.ts

@@ -0,0 +1,42 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { formatPhoneNumber } from '../common/utils';
+
+interface ContactEntry {
+	number: string;
+	name?: string;
+	expiration_in_seconds?: number;
+}
+
+export const getContact = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'getContact',
+	displayName: 'Get Contact',
+	description: 'Get details of a specific contact',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		uuid: Property.ShortText({
+			displayName: 'Contact UUID',
+			description: 'UUID of the contact',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { number, uuid } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		const response = await apiClient.get<ContactEntry>(
+			`/v1/contacts/${encodeURIComponent(formattedNumber)}/${encodeURIComponent(uuid)}`
+		);
+
+		return response;
+	},
+});

package/src/lib/actions/get-group.ts

@@ -0,0 +1,37 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { signalCliRestApiAuth } from '../common/auth';
+import { SignalCliApiClient } from '../common/api-client';
+import { GroupEntry } from '../common/types';
+import { formatPhoneNumber } from '../common/utils';
+
+export const getGroup = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'getGroup',
+	displayName: 'Get Group',
+	description: 'Get details of a specific Signal group',
+	props: {
+		number: Property.ShortText({
+			displayName: 'Phone Number',
+			description: 'Registered phone number in international format',
+			required: true,
+		}),
+		groupid: Property.ShortText({
+			displayName: 'Group ID',
+			description: 'Group ID (base64 encoded)',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { number, groupid } = context.propsValue;
+		// Auth props are passed directly to API client
+
+		const apiClient = new SignalCliApiClient(context.auth.props);
+		const formattedNumber = formatPhoneNumber(number);
+
+		const response = await apiClient.get<GroupEntry>(
+			`/v1/groups/${encodeURIComponent(formattedNumber)}/${encodeURIComponent(groupid)}`
+		);
+
+		return response;
+	},
+});

package/src/lib/actions/get-qr-code-link.ts

@@ -0,0 +1,62 @@
+import { createAction, Property } from '@activepieces/pieces-framework';
+import { httpClient, HttpMethod } from '@activepieces/pieces-common';
+import { signalCliRestApiAuth } from '../common/auth';
+
+export const getQrCodeLink = createAction({
+	auth: signalCliRestApiAuth,
+	name: 'getQrCodeLink',
+	displayName: 'Get QR Code Link',
+	description: 'Generate a QR code for linking a device',
+	props: {
+		device_name: Property.ShortText({
+			displayName: 'Device Name',
+			description: 'Name for the device to link',
+			required: true,
+		}),
+		qrcode_version: Property.Number({
+			displayName: 'QR Code Version',
+			description: 'QR code version (default: 10)',
+			required: false,
+		}),
+	},
+	async run(context) {
+		const { device_name, qrcode_version } = context.propsValue;
+		const { baseUrl, useBasicAuth, basicAuthUsername, basicAuthPassword } = context.auth.props;
+
+		const queryParams = new URLSearchParams();
+		queryParams.append('device_name', device_name);
+		if (qrcode_version) {
+			queryParams.append('qrcode_version', qrcode_version.toString());
+		}
+
+		const headers: Record<string, string> = {
+			Accept: 'image/png',
+		};
+
+		// Add Basic Auth header if configured
+		if (useBasicAuth && basicAuthUsername && basicAuthPassword) {
+			const credentials = Buffer.from(
+				`${basicAuthUsername}:${basicAuthPassword}`
+			).toString('base64');
+			headers['Authorization'] = `Basic ${credentials}`;
+		}
+
+		// The API returns a PNG image, so we need to handle it as binary
+		const response = await httpClient.sendRequest({
+			method: HttpMethod.GET,
+			url: `${baseUrl.replace(/\/$/, '')}/v1/qrcodelink?${queryParams.toString()}`,
+			headers,
+		});
+
+		// Return base64 encoded image
+		if (response.body instanceof ArrayBuffer || response.body instanceof Buffer) {
+			const base64 = Buffer.from(response.body).toString('base64');
+			return {
+				qr_code_base64: `data:image/png;base64,${base64}`,
+				device_name,
+			};
+		}
+
+		return response.body;
+	},
+});