feat: Add [bare] polyproto-mls extension

Author: bitfl0wer

polyproto/core/routes/federated_identity.tsp

@@ -7,7 +7,6 @@ import "./main.tsp";
 
 using TypeSpec.Http;
 using TypeSpec.Versioning;
-using polyproto.core;
 
 namespace polyproto.core.Routes.FederatedIdentity {
     @tag("Federated Identity - Registration required")

polyproto/main.tsp

@@ -1,4 +1,5 @@
 import "./chat/main.tsp";
 import "./core/main.tsp";
+import "./mls/main.tsp";
 
 namespace polyproto;

polyproto/mls/main.tsp

@@ -0,0 +1,23 @@
+import "./types.tsp";
+import "./operations.tsp";
+import "../main.tsp";
+
+using Http;
+using Versioning;
+using OpenAPI;
+
+@service(#{ title: "polyproto chat APIs" })
+@info(#{
+    license: #{
+        name: "MIT License",
+        url: "https://raw.githubusercontent.com/polyphony-chat/docs/refs/heads/main/LICENSE",
+    },
+})
+@server("https://example.com", "Example endpoint")
+@route("/.p2/chat/v1/")
+@versioned(Version)
+namespace polyproto.mls;
+
+enum Version {
+    `v0.1.0-alpha.0`,
+}

polyproto/mls/operations.tsp

@@ -0,0 +1,76 @@
+import "@typespec/rest";
+import "@typespec/openapi";
+import "@typespec/http";
+import "./main.tsp";
+import "../main.tsp";
+
+using TypeSpec.Http;
+
+namespace polyproto.mls.routes {
+  /**
+   * Create a new MLS group
+   */
+  @post
+  @route("/groups")
+  op createGroup(@body keyPackage: KeyPackage): Group;
+
+  /**
+   * Get information about an MLS group
+   */
+  @get
+  @route("/groups/{groupId}")
+  op getGroup(@path groupId: string): Group;
+
+  /**
+   * Submit a proposal to modify the group
+   */
+  @post
+  @route("/groups/{groupId}/proposals")
+  op submitProposal(@path groupId: string, @body proposal: Proposal): void;
+
+  /**
+   * Submit a commit to apply pending proposals
+   */
+  @post
+  @route("/groups/{groupId}/commits")
+  op submitCommit(@path groupId: string, @body commit: Commit): Welcome;
+
+  /**
+   * Get the current state of a group member
+   */
+  @get
+  @route("/groups/{groupId}/members/{memberId}")
+  op getMember(@path groupId: string, @path memberId: string): GroupMember;
+
+  /**
+   * Update a member's key package
+   */
+  @put
+  @route("/groups/{groupId}/members/{memberId}")
+  op updateMember(
+    @path groupId: string,
+    @path memberId: string,
+    @body keyPackage: KeyPackage,
+  ): void;
+
+  /**
+   * Remove a member from the group
+   */
+  @delete
+  @route("/groups/{groupId}/members/{memberId}")
+  op removeMember(@path groupId: string, @path memberId: string): void;
+
+  /**
+   * Get all pending proposals for a group
+   */
+  @get
+  @route("/groups/{groupId}/proposals")
+  op getProposals(@path groupId: string): Proposal[];
+
+  /**
+   * Get the latest commit for a group
+   */
+  @get
+  @route("/groups/{groupId}/commits/latest")
+  op getLatestCommit(@path groupId: string): Commit;
+}

polyproto/mls/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "polyproto-mls",
+  "version": "0.1.0",
+  "type": "module"
+}

polyproto/mls/tspconfig.yaml

@@ -0,0 +1,7 @@
+emit:
+  - "@typespec/openapi3"
+options:
+  "@typespec/openapi3":
+    emitter-output-dir: "{output-dir}/schema"
+    openapi-versions:
+      - "3.1.0"

polyproto/mls/types.tsp

@@ -0,0 +1,141 @@
+import "@typespec/rest";
+import "@typespec/openapi";
+
+namespace polyproto.mls;
+
+/**
+ * Represents a client's capabilities and provides keys for group operations
+ */
+model KeyPackage {
+  @doc("Unique identifier for this key package")
+  id: string;
+
+  @doc("The client's public key")
+  publicKey: bytes;
+
+  @doc("The client's capabilities and supported ciphersuites")
+  capabilities: ClientCapabilities;
+
+  @doc("The client's signature over the key package")
+  signature: bytes;
+}
+
+/**
+ * Client capabilities and supported features
+ */
+model ClientCapabilities {
+  @doc("Supported MLS protocol versions")
+  versions: string[];
+
+  @doc("Supported ciphersuites")
+  ciphersuites: string[];
+
+  @doc("Supported extensions")
+  extensions: string[];
+}
+
+/**
+ * Represents a proposed change to the group state
+ */
+model Proposal {
+  @doc("Unique identifier for this proposal")
+  id: string;
+
+  @doc("The type of proposal")
+  type: ProposalType;
+
+  @doc("The target of the proposal (e.g., member to remove)")
+  target?: string;
+
+  @doc("The key package for add proposals")
+  keyPackage?: KeyPackage;
+
+  @doc("The proposal sender's signature")
+  signature: bytes;
+}
+
+/**
+ * Types of proposals that can be made
+ */
+enum ProposalType {
+  Add,
+  Remove,
+  Update,
+  ReInit,
+}
+
+/**
+ * Represents a commit message that initiates a new epoch
+ */
+model Commit {
+  @doc("Unique identifier for this commit")
+  id: string;
+
+  @doc("The group ID this commit applies to")
+  groupId: string;
+
+  @doc("The epoch number this commit creates")
+  epoch: int32;
+
+  @doc("The proposals being committed")
+  proposals: Proposal[];
+
+  @doc("The commit sender's signature")
+  signature: bytes;
+}
+
+/**
+ * Welcome message for new group members
+ */
+model Welcome {
+  @doc("The group ID the new member is being added to")
+  groupId: string;
+
+  @doc("The epoch number the new member is being added to")
+  epoch: int32;
+
+  @doc("The key package of the new member")
+  keyPackage: KeyPackage;
+
+  @doc("Encrypted group state for the new member")
+  encryptedGroupState: bytes;
+}
+
+/**
+ * Represents a group in MLS
+ */
+model Group {
+  @doc("Unique identifier for the group")
+  id: string;
+
+  @doc("Current epoch number")
+  epoch: int32;
+
+  @doc("List of current group members")
+  members: GroupMember[];
+
+  @doc("Group's public key")
+  publicKey: bytes;
+}
+
+/**
+ * Represents a member in an MLS group
+ */
+model GroupMember {
+  @doc("Unique identifier for the member")
+  id: string;
+
+  @doc("The member's key package")
+  keyPackage: KeyPackage;
+
+  @doc("The member's role in the group")
+  role: MemberRole;
+}
+
+/**
+ * Possible roles for group members
+ */
+enum MemberRole {
+  Admin,
+  Member,
+}