async-matrix 0.1.3 → 1.0.0

data/lib/async/matrix/application_service/config/schema/appservice.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "appservice.json",
+  "description": "Application service registration and network settings. Maps to mautrix bridgev2/bridgeconfig.AppserviceConfig.",
+  "type": "object",
+  "properties": {
+    "address": {
+      "type": "string",
+      "description": "The full public address of the appservice (e.g. http://bridge:29318)."
+    },
+    "public_address": {
+      "type": "string",
+      "description": "Public-facing address if different from address."
+    },
+    "hostname": {
+      "type": "string",
+      "default": "0.0.0.0",
+      "description": "Hostname to bind the appservice listener to."
+    },
+    "port": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 65535,
+      "default": 29318,
+      "description": "Port to bind the appservice listener to."
+    },
+    "id": {
+      "type": "string",
+      "description": "Unique appservice ID, used in the registration file."
+    },
+    "bot": {
+      "$ref": "#/$defs/BotUserConfig"
+    },
+    "as_token": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Appservice token used to authenticate requests to the homeserver."
+    },
+    "hs_token": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Homeserver token used to authenticate requests from the homeserver."
+    },
+    "ephemeral_events": {
+      "type": "boolean",
+      "default": false,
+      "description": "Receive ephemeral events (typing, receipts) via appservice transactions."
+    },
+    "async_transactions": {
+      "type": "boolean",
+      "default": false,
+      "description": "Send transaction responses before processing (Hungry-specific)."
+    },
+    "username_template": {
+      "type": "string",
+      "description": "Go text/template for generating ghost user localparts. Receives the remote username as {{.}}."
+    }
+  },
+  "required": ["as_token", "hs_token"],
+  "additionalProperties": false,
+  "$defs": {
+    "BotUserConfig": {
+      "description": "Configuration for the appservice bot user. Maps to mautrix BotUserConfig.",
+      "type": "object",
+      "properties": {
+        "username": {
+          "type": "string",
+          "description": "Localpart of the bot user (e.g. 'bot' for @bot:example.com)."
+        },
+        "displayname": {
+          "type": "string",
+          "description": "Display name to set for the bot user."
+        },
+        "avatar": {
+          "type": "string",
+          "description": "Avatar mxc:// URI for the bot user. Set to 'remove' to remove the avatar."
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

data/lib/async/matrix/application_service/config/schema/backfill.json

@@ -0,0 +1,91 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "backfill.json",
+  "description": "Message backfill settings. Maps to mautrix bridgev2/bridgeconfig.BackfillConfig.",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "default": false,
+      "description": "Enable message backfilling from the remote network."
+    },
+    "max_initial_messages": {
+      "type": "integer",
+      "minimum": 0,
+      "default": 50,
+      "description": "Maximum number of messages to backfill in a newly created portal."
+    },
+    "max_catchup_messages": {
+      "type": "integer",
+      "minimum": 0,
+      "default": 500,
+      "description": "Maximum number of messages to backfill when catching up on missed messages."
+    },
+    "unread_hours_threshold": {
+      "type": "integer",
+      "minimum": 0,
+      "default": 720,
+      "description": "Number of hours of unread messages before switching to catchup backfill."
+    },
+    "threads": {
+      "$ref": "#/$defs/BackfillThreadsConfig"
+    },
+    "queue": {
+      "$ref": "#/$defs/BackfillQueueConfig"
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "BackfillThreadsConfig": {
+      "type": "object",
+      "properties": {
+        "max_initial_messages": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 20,
+          "description": "Maximum number of messages to backfill in a thread."
+        }
+      },
+      "additionalProperties": false
+    },
+    "BackfillQueueConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable the backfill queue for processing large backfills in batches."
+        },
+        "manual": {
+          "type": "boolean",
+          "default": false,
+          "description": "Require manual triggering of queued backfills."
+        },
+        "batch_size": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 100,
+          "description": "Number of messages per backfill batch."
+        },
+        "batch_delay": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 20,
+          "description": "Delay in seconds between backfill batches."
+        },
+        "max_batches": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Maximum number of batches to process. 0 means unlimited."
+        },
+        "max_batches_override": {
+          "type": "object",
+          "additionalProperties": { "type": "integer" },
+          "description": "Per-portal overrides for max_batches, keyed by portal name."
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

data/lib/async/matrix/application_service/config/schema/bridge.json

@@ -0,0 +1,209 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "bridge.json",
+  "description": "Core bridge behavior settings. Maps to mautrix bridgev2/bridgeconfig.BridgeConfig.",
+  "type": "object",
+  "properties": {
+    "command_prefix": {
+      "type": "string",
+      "description": "Prefix for bridge commands in the management room."
+    },
+    "personal_filtering_spaces": {
+      "type": "boolean",
+      "default": false,
+      "description": "Enable personal filtering spaces for portal rooms."
+    },
+    "private_chat_portal_meta": {
+      "type": "boolean",
+      "default": false,
+      "description": "Set portal room metadata (name/avatar) in private chats."
+    },
+    "async_events": {
+      "type": "boolean",
+      "default": false,
+      "description": "Process Matrix events asynchronously."
+    },
+    "split_portals": {
+      "type": "boolean",
+      "default": false,
+      "description": "Create separate portal rooms per user login."
+    },
+    "resend_bridge_info": {
+      "type": "boolean",
+      "default": false,
+      "description": "Resend bridge info state events on startup."
+    },
+    "no_bridge_info_state_key": {
+      "type": "boolean",
+      "default": false,
+      "description": "Don't include the bridge info state key in portal rooms."
+    },
+    "bridge_status_notices": {
+      "type": "string",
+      "default": "",
+      "description": "Control bridge status notices behavior."
+    },
+    "unknown_error_auto_reconnect": {
+      "type": "string",
+      "default": "",
+      "description": "Duration to wait before auto-reconnecting after an unknown error (Go duration, e.g. '1m')."
+    },
+    "unknown_error_max_auto_reconnects": {
+      "type": "integer",
+      "minimum": 0,
+      "default": 0,
+      "description": "Maximum number of auto-reconnect attempts after unknown errors."
+    },
+    "bridge_matrix_leave": {
+      "type": "boolean",
+      "default": false,
+      "description": "Bridge Matrix leave events to the remote network."
+    },
+    "bridge_notices": {
+      "type": "boolean",
+      "default": false,
+      "description": "Bridge m.notice messages to the remote network."
+    },
+    "tag_only_on_create": {
+      "type": "boolean",
+      "default": false,
+      "description": "Only set room tags when creating a portal, not on updates."
+    },
+    "only_bridge_tags": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Only bridge rooms with these tags."
+    },
+    "mute_only_on_create": {
+      "type": "boolean",
+      "default": false,
+      "description": "Only set mute status when creating a portal, not on updates."
+    },
+    "deduplicate_matrix_messages": {
+      "type": "boolean",
+      "default": false,
+      "description": "Deduplicate Matrix messages before bridging to avoid double-sends."
+    },
+    "cross_room_replies": {
+      "type": "boolean",
+      "default": false,
+      "description": "Support replies across different portal rooms."
+    },
+    "outgoing_message_re_id": {
+      "type": "boolean",
+      "default": false,
+      "description": "Re-identify outgoing messages with the remote network ID."
+    },
+    "revert_failed_state_changes": {
+      "type": "boolean",
+      "default": false,
+      "description": "Revert Matrix state changes that failed to bridge."
+    },
+    "kick_matrix_users": {
+      "type": "boolean",
+      "default": false,
+      "description": "Kick Matrix users from portal rooms when they are removed on the remote network."
+    },
+    "enable_send_state_requests": {
+      "type": "boolean",
+      "default": false,
+      "description": "Enable handling send-state requests."
+    },
+    "phone_numbers_in_profile": {
+      "type": "boolean",
+      "default": false,
+      "description": "Include phone numbers in ghost user profiles."
+    },
+    "cleanup_on_logout": {
+      "$ref": "#/$defs/CleanupOnLogouts"
+    },
+    "relay": {
+      "$ref": "relay.json"
+    },
+    "portal_create_filter": {
+      "$ref": "#/$defs/PortalCreateFilter"
+    },
+    "permissions": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "permissions.json"
+      },
+      "description": "User/server permission map. Keys are '*' (wildcard), 'example.com' (server), or '@user:example.com' (user)."
+    },
+    "backfill": {
+      "$ref": "backfill.json"
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "CleanupAction": {
+      "type": "string",
+      "enum": ["", "nothing", "kick", "unbridge", "delete"],
+      "description": "Action to take on portal rooms during cleanup."
+    },
+    "CleanupOnLogout": {
+      "type": "object",
+      "properties": {
+        "private": { "$ref": "#/$defs/CleanupAction" },
+        "relayed": { "$ref": "#/$defs/CleanupAction" },
+        "shared_no_users": { "$ref": "#/$defs/CleanupAction" },
+        "shared_has_users": { "$ref": "#/$defs/CleanupAction" }
+      },
+      "additionalProperties": false
+    },
+    "CleanupOnLogouts": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable cleanup of portal rooms on logout."
+        },
+        "manual": {
+          "$ref": "#/$defs/CleanupOnLogout",
+          "description": "Cleanup behavior when a user manually logs out."
+        },
+        "bad_credentials": {
+          "$ref": "#/$defs/CleanupOnLogout",
+          "description": "Cleanup behavior when credentials become invalid."
+        }
+      },
+      "additionalProperties": false
+    },
+    "PortalCreateFilter": {
+      "type": "object",
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": ["allow", "deny", ""],
+          "default": "",
+          "description": "Filter mode: 'allow' only allows listed items, 'deny' blocks listed items."
+        },
+        "list": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              { "type": "string" },
+              {
+                "type": "object",
+                "properties": {
+                  "id": { "type": "string" },
+                  "receiver": { "type": "string" }
+                },
+                "required": ["id"],
+                "additionalProperties": false
+              }
+            ]
+          },
+          "description": "Portal IDs to allow/deny. Each item is a portal ID string or an object with id and optional receiver."
+        },
+        "always_deny_from_login": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "User login IDs that are always denied portal creation."
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

data/lib/async/matrix/application_service/config/schema/config.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "config.json",
+  "title": "Mautrix Bridge Configuration",
+  "description": "Root configuration schema for mautrix bridgev2-compatible bridges. Maps to mautrix bridgev2/bridgeconfig.Config.",
+  "type": "object",
+  "properties": {
+    "network": {
+      "type": "object",
+      "description": "Bridge-specific network configuration. Opaque to the framework — validated by each bridge implementation."
+    },
+    "homeserver": {
+      "$ref": "homeserver.json"
+    },
+    "appservice": {
+      "$ref": "appservice.json"
+    },
+    "bridge": {
+      "$ref": "bridge.json"
+    },
+    "database": {
+      "$ref": "database.json"
+    },
+    "matrix": {
+      "$ref": "matrix.json"
+    },
+    "encryption": {
+      "$ref": "encryption.json"
+    },
+    "backfill": {
+      "$ref": "backfill.json"
+    },
+    "analytics": {
+      "$ref": "analytics.json"
+    },
+    "provisioning": {
+      "$ref": "provisioning.json"
+    },
+    "public_media": {
+      "$ref": "public_media.json"
+    },
+    "direct_media": {
+      "$ref": "direct_media.json"
+    },
+    "double_puppet": {
+      "$ref": "double_puppet.json"
+    },
+    "management_room_texts": {
+      "$ref": "management_room_texts.json"
+    },
+    "logging": {
+      "$ref": "logging.json"
+    },
+    "env_config_prefix": {
+      "type": "string",
+      "description": "Prefix for environment variable overrides (e.g. 'MAUTRIX_SIGNAL')."
+    }
+  },
+  "required": ["homeserver", "appservice"],
+  "additionalProperties": false
+}

data/lib/async/matrix/application_service/config/schema/database.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "database.json",
+  "description": "Database connection settings. Maps to go.mau.fi/util/dbutil.Config.",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": ["sqlite3-fk-wal", "postgres"],
+      "description": "Database engine type. 'sqlite3-fk-wal' is SQLite with foreign keys and WAL mode."
+    },
+    "uri": {
+      "type": "string",
+      "description": "Database connection URI (e.g. file:bridge.db?_txlock=immediate or postgres://...)."
+    },
+    "max_open_conns": {
+      "type": "integer",
+      "minimum": 0,
+      "default": 5,
+      "description": "Maximum number of open database connections."
+    },
+    "max_idle_conns": {
+      "type": "integer",
+      "minimum": 0,
+      "default": 1,
+      "description": "Maximum number of idle database connections."
+    },
+    "max_conn_idle_time": {
+      "type": "string",
+      "description": "Maximum time a connection can be idle (Go duration, e.g. '30m')."
+    },
+    "max_conn_lifetime": {
+      "type": "string",
+      "description": "Maximum lifetime of a connection (Go duration, e.g. '1h')."
+    }
+  },
+  "additionalProperties": false
+}

data/lib/async/matrix/application_service/config/schema/direct_media.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "direct_media.json",
+  "description": "Direct media access settings. Maps to mautrix bridgev2/bridgeconfig.DirectMediaConfig.",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "default": false,
+      "description": "Enable direct media access via federation-style media endpoints."
+    },
+    "media_id_prefix": {
+      "type": "string",
+      "description": "Prefix for generated media IDs."
+    },
+    "server_name": {
+      "type": "string",
+      "description": "Server name for the media proxy (inlined from mediaproxy.BasicConfig)."
+    },
+    "server_key": {
+      "type": "string",
+      "description": "Signing key for federation. Set to 'generate' for auto-generation."
+    },
+    "well_known_response": {
+      "type": ["string", "null"],
+      "description": "Custom .well-known response for the media server."
+    },
+    "allow_proxy": {
+      "type": "boolean",
+      "default": false,
+      "description": "Allow proxying media through the homeserver if direct download fails."
+    }
+  },
+  "additionalProperties": false
+}

data/lib/async/matrix/application_service/config/schema/double_puppet.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "double_puppet.json",
+  "description": "Double-puppeting settings. Maps to mautrix bridgev2/bridgeconfig.DoublePuppetConfig.",
+  "type": "object",
+  "properties": {
+    "servers": {
+      "type": "object",
+      "additionalProperties": { "type": "string" },
+      "description": "Map of server name to homeserver URL for double-puppeting."
+    },
+    "allow_discovery": {
+      "type": "boolean",
+      "default": false,
+      "description": "Allow discovering double-puppet homeservers via .well-known."
+    },
+    "secrets": {
+      "type": "object",
+      "additionalProperties": { "type": "string" },
+      "description": "Map of server name to shared secret for automatic double-puppet login."
+    }
+  },
+  "additionalProperties": false
+}