Merge 7773a3fd83f46ba018503a477e3f304b55eb503f into 9bc4c0ecd8271f7fbc68f0827dabdc664b191d5f

This commit is contained in:
Gara Dorta 2026-04-10 19:12:45 -06:00 committed by GitHub
commit e710efd173
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
43 changed files with 165 additions and 0 deletions

View File

@ -148,6 +148,16 @@ version installed, you can replace `./gradlew` with `gradle` in the following st
./gradlew run --args="--help"
```
### JSON Schemas for the JSON-RPC mode
1. Generate [JSON Schema](https://json-schema.org/) files for all the JSON-RPC data classes (`src/main/java/org/asamk/signal/json`):
```sh
./gradlew jsonSchemas
```
2. The generated files can be found in the `build/generated/META-INF/schemas` folder.
### Building a native binary with GraalVM (EXPERIMENTAL)
It is possible to build a native binary with [GraalVM](https://www.graalvm.org). This is still experimental and will not

View File

@ -1,3 +1,5 @@
import groovy.json.JsonOutput
plugins {
java
application
@ -72,6 +74,11 @@ val excludePatterns = mapOf(
)
)
val schemaAnnotationProcessor by configurations.creating {
isCanBeConsumed = false
isCanBeResolved = true
}
dependencies {
registerTransform(JarFileExcluder::class) {
from.attribute(minified, false).attribute(artifactType, "jar")
@ -82,6 +89,8 @@ dependencies {
}
}
schemaAnnotationProcessor(libs.micronaut.json.schema.processor)
schemaAnnotationProcessor(libs.micronaut.inject.java)
implementation(libs.bouncycastle)
implementation(libs.jackson.databind)
implementation(libs.argparse4j)
@ -90,6 +99,10 @@ dependencies {
implementation(libs.slf4j.jul)
implementation(libs.logback)
implementation(libs.zxing)
implementation(libs.micronaut.json.schema.annotations)
if (gradle.startParameter.taskNames.any { it.contains("jsonSchemas") }) {
implementation(libs.micronaut.json.schema.generator)
}
implementation(project(":libsignal-cli"))
testImplementation(libs.junit.jupiter)
@ -160,3 +173,30 @@ tasks.register("writeLibsignalVersion") {
}
}
}
tasks.register<JavaCompile>("jsonSchemas") {
dependsOn(tasks.compileJava)
val schemaBaseUri = "http://localhost:8080/schemas/"
source = sourceSets.main.get().java
include("org/asamk/signal/json/**/*.java")
classpath = sourceSets.main.get().compileClasspath + files(sourceSets.main.get().java.destinationDirectory)
destinationDirectory.set(layout.buildDirectory.dir("generated"))
options.annotationProcessorPath = schemaAnnotationProcessor
options.compilerArgs.addAll(
listOf(
"-Amicronaut.processing.group=org.asamk",
"-Amicronaut.processing.module=signal-cli",
"-Amicronaut.processing.annotations=org.asamk.signal.json.*",
"-Amicronaut.jsonschema.baseUri=$schemaBaseUri",
)
)
doLast {
fileTree(destinationDirectory.get().dir("META-INF/schemas").asFile) {
include("*.schema.json")
}.forEach { schemaFile ->
val normalized = schemaFile.readText().replace("\"$schemaBaseUri/", "\"")
val prettyJson = JsonOutput.prettyPrint(normalized)
schemaFile.writeText("$prettyJson\n")
}
}
}

View File

@ -1,6 +1,8 @@
[versions]
slf4j = "2.0.17"
junit = "6.0.2"
micronaut-json-schema = "2.0.0-M6"
micronaut-core = "4.9.3"
[libraries]
bouncycastle = "org.bouncycastle:bcprov-jdk18on:1.83"
@ -8,6 +10,10 @@ jackson-databind = "com.fasterxml.jackson.core:jackson-databind:2.20.2"
argparse4j = "net.sourceforge.argparse4j:argparse4j:0.9.0"
dbusjava = "com.github.hypfvieh:dbus-java-transport-native-unixsocket:5.0.0"
zxing = "com.google.zxing:core:3.5.4"
micronaut-json-schema-annotations = { module = "io.micronaut.jsonschema:micronaut-json-schema-annotations", version.ref = "micronaut-json-schema" }
micronaut-json-schema-processor = { module = "io.micronaut.jsonschema:micronaut-json-schema-processor", version.ref = "micronaut-json-schema" }
micronaut-json-schema-generator = { module = "io.micronaut.jsonschema:micronaut-json-schema-generator", version.ref = "micronaut-json-schema" }
micronaut-inject-java = { module = "io.micronaut:micronaut-inject-java", version.ref = "micronaut-core" }
slf4j-api = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
slf4j-jul = { module = "org.slf4j:jul-to-slf4j", version.ref = "slf4j" }
logback = "ch.qos.logback:logback-classic:1.5.32"

View File

@ -1,9 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "AdminDelete")
public record JsonAdminDelete(
@Deprecated String targetAuthor, String targetAuthorNumber, String targetAuthorUuid, long targetSentTimestamp
) {

View File

@ -1,7 +1,10 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "Attachment")
record JsonAttachment(
String contentType,
String filename,

View File

@ -1,5 +1,8 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
@JsonSchema(title = "AttachmentData")
public record JsonAttachmentData(
String data
) {}

View File

@ -1,6 +1,7 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
@ -10,6 +11,7 @@ import java.util.List;
import static org.asamk.signal.manager.util.Utils.callIdUnsigned;
@JsonSchema(title = "CallMessage")
record JsonCallMessage(
@JsonInclude(JsonInclude.Include.NON_NULL) Offer offerMessage,
@JsonInclude(JsonInclude.Include.NON_NULL) Answer answerMessage,

View File

@ -1,9 +1,11 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import java.util.List;
@JsonSchema(title = "Contact")
public record JsonContact(
String number,
String uuid,
@ -26,6 +28,7 @@ public record JsonContact(
@JsonInclude(JsonInclude.Include.NON_NULL) JsonInternal internal
) {
@JsonSchema(title = "Profile")
public record JsonProfile(
long lastUpdateTimestamp,
String givenName,
@ -36,6 +39,7 @@ public record JsonContact(
String mobileCoinAddress
) {}
@JsonSchema(title = "Internal")
public record JsonInternal(
List<String> capabilities,
String unidentifiedAccessMode,

View File

@ -1,8 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import org.asamk.signal.util.Util;
@JsonSchema(title = "ContactAddress")
public record JsonContactAddress(
String type,
String label,

View File

@ -1,7 +1,10 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "ContactAvatar")
public record JsonContactAvatar(JsonAttachment attachment, boolean isProfile) {
static JsonContactAvatar from(MessageEnvelope.Data.SharedContact.Avatar avatar) {

View File

@ -1,8 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import org.asamk.signal.util.Util;
@JsonSchema(title = "ContactEmail")
public record JsonContactEmail(String value, String type, String label) {
static JsonContactEmail from(MessageEnvelope.Data.SharedContact.Email email) {

View File

@ -1,8 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import org.asamk.signal.util.Util;
@JsonSchema(title = "ContactName")
public record JsonContactName(
String nickname, String given, String family, String prefix, String suffix, String middle
) {

View File

@ -1,8 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import org.asamk.signal.util.Util;
@JsonSchema(title = "ContactPhone")
public record JsonContactPhone(String value, String type, String label) {
static JsonContactPhone from(MessageEnvelope.Data.SharedContact.Phone phone) {

View File

@ -1,12 +1,14 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.Manager;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.List;
@JsonSchema(title = "DataMessage")
record JsonDataMessage(
long timestamp,
String message,

View File

@ -1,8 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.Manager;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "EditMessage")
record JsonEditMessage(long targetSentTimestamp, JsonDataMessage dataMessage) {
static JsonEditMessage from(MessageEnvelope.Edit editMessage, Manager m) {

View File

@ -1,5 +1,8 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
@JsonSchema(title = "Error")
public record JsonError(String message, String type) {
public static JsonError from(Throwable exception) {

View File

@ -1,8 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.Manager;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "GroupInfo")
record JsonGroupInfo(String groupId, String groupName, int revision, String type) {
static JsonGroupInfo from(MessageEnvelope.Data.GroupContext groupContext, Manager m) {

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "Mention")
public record JsonMention(@Deprecated String name, String number, String uuid, int start, int length) {
static JsonMention from(MessageEnvelope.Data.Mention mention) {

View File

@ -1,6 +1,7 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.Manager;
import org.asamk.signal.manager.api.MessageEnvelope;
@ -10,6 +11,7 @@ import org.asamk.signal.manager.api.UntrustedIdentityException;
import java.util.UUID;
@JsonSchema(title = "MessageEnvelope")
public record JsonMessageEnvelope(
@Deprecated String source,
String sourceNumber,

View File

@ -1,7 +1,10 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "Payment")
public record JsonPayment(String note, byte[] receipt) {
static JsonPayment from(MessageEnvelope.Data.Payment payment) {

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "PinMessage")
public record JsonPinMessage(
@Deprecated String targetAuthor,
String targetAuthorNumber,

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.List;
@JsonSchema(title = "PollCreate")
public record JsonPollCreate(
String question, boolean allowMultiple, List<String> options
) {

View File

@ -1,7 +1,10 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "PollTerminate")
public record JsonPollTerminate(long targetSentTimestamp) {
static JsonPollTerminate from(MessageEnvelope.Data.PollTerminate pollTerminate) {

View File

@ -1,10 +1,13 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.List;
import java.util.UUID;
@JsonSchema(title = "PollVote")
public record JsonPollVote(
@Deprecated String author,
String authorNumber,

View File

@ -1,7 +1,10 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "Preview")
public record JsonPreview(String url, String title, String description, JsonAttachment image) {
static JsonPreview from(MessageEnvelope.Data.Preview preview) {

View File

@ -1,12 +1,14 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.List;
import java.util.UUID;
@JsonSchema(title = "Quote")
public record JsonQuote(
long id,
@Deprecated String author,

View File

@ -1,9 +1,11 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "QuotedAttachment")
public record JsonQuotedAttachment(
String contentType, String filename, @JsonInclude(JsonInclude.Include.NON_NULL) JsonAttachment thumbnail
) {

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "Reaction")
public record JsonReaction(
String emoji,
@Deprecated String targetAuthor,

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.List;
@JsonSchema(title = "ReceiptMessage")
record JsonReceiptMessage(long when, boolean isDelivery, boolean isRead, boolean isViewed, List<Long> timestamps) {
static JsonReceiptMessage from(MessageEnvelope.Receipt receiptMessage) {

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.RecipientAddress;
import java.util.UUID;
@JsonSchema(title = "RecipientAddress")
public record JsonRecipientAddress(String uuid, String number, String username) {
public static JsonRecipientAddress from(RecipientAddress address) {

View File

@ -1,3 +1,6 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
@JsonSchema(title = "RemoteDelete")
record JsonRemoteDelete(long timestamp) {}

View File

@ -1,10 +1,12 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.GroupId;
import org.asamk.signal.manager.api.SendMessageResult;
@JsonSchema(title = "SendMessageResult")
public record JsonSendMessageResult(
JsonRecipientAddress recipientAddress,
@JsonInclude(JsonInclude.Include.NON_NULL) String groupId,

View File

@ -1,11 +1,13 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.List;
@JsonSchema(title = "SharedContact")
public record JsonSharedContact(
JsonContactName name,
@JsonInclude(JsonInclude.Include.NON_NULL) JsonContactAvatar avatar,

View File

@ -1,8 +1,11 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import org.asamk.signal.util.Hex;
@JsonSchema(title = "Sticker")
public record JsonSticker(String packId, int stickerId) {
static JsonSticker from(MessageEnvelope.Data.Sticker sticker) {

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "StoryContext")
record JsonStoryContext(
String authorNumber, String authorUuid, long sentTimestamp
) {

View File

@ -1,6 +1,7 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.Color;
import org.asamk.signal.manager.api.GroupId;
@ -8,6 +9,7 @@ import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.List;
@JsonSchema(title = "StoryMessage")
record JsonStoryMessage(
boolean allowsReplies,
@JsonInclude(JsonInclude.Include.NON_NULL) String groupId,

View File

@ -2,6 +2,7 @@ package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.Manager;
import org.asamk.signal.manager.api.MessageEnvelope;
@ -9,6 +10,7 @@ import org.asamk.signal.manager.api.RecipientAddress;
import java.util.UUID;
@JsonSchema(title = "SyncDataMessage")
record JsonSyncDataMessage(
@Deprecated String destination,
String destinationNumber,

View File

@ -9,12 +9,15 @@ import org.asamk.signal.manager.api.RecipientAddress;
import java.util.List;
import io.micronaut.jsonschema.JsonSchema;
enum JsonSyncMessageType {
CONTACTS_SYNC,
GROUPS_SYNC,
REQUEST_SYNC
}
@JsonSchema(title = "SyncMessage")
record JsonSyncMessage(
@JsonInclude(JsonInclude.Include.NON_NULL) JsonSyncDataMessage sentMessage,
@JsonInclude(JsonInclude.Include.NON_NULL) JsonSyncStoryMessage sentStoryMessage,

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "SyncReadMessage")
record JsonSyncReadMessage(
@Deprecated String sender, String senderNumber, String senderUuid, long timestamp
) {

View File

@ -1,11 +1,13 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "SyncStoryMessage")
record JsonSyncStoryMessage(
String destinationNumber, String destinationUuid, @JsonUnwrapped JsonStoryMessage dataMessage
) {

View File

@ -1,7 +1,10 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.TextStyle;
@JsonSchema(title = "TextStyle")
public record JsonTextStyle(String style, int start, int length) {
static JsonTextStyle from(TextStyle textStyle) {

View File

@ -1,10 +1,12 @@
package org.asamk.signal.json;
import com.fasterxml.jackson.annotation.JsonInclude;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.GroupId;
import org.asamk.signal.manager.api.MessageEnvelope;
@JsonSchema(title = "TypingMessage")
record JsonTypingMessage(
String action, long timestamp, @JsonInclude(JsonInclude.Include.NON_NULL) String groupId
) {

View File

@ -1,9 +1,12 @@
package org.asamk.signal.json;
import io.micronaut.jsonschema.JsonSchema;
import org.asamk.signal.manager.api.MessageEnvelope;
import java.util.UUID;
@JsonSchema(title = "UnpinMessage")
public record JsonUnpinMessage(
@Deprecated String targetAuthor, String targetAuthorNumber, String targetAuthorUuid, long targetSentTimestamp
) {