feat(api): add ActivityPub schema parity proof

Author: skulidropek

packages/api/src/api/activitypub-schema.ts

@@ -0,0 +1,144 @@
+import * as Schema from "effect/Schema"
+
+import {
+  activityStreamsJsonLdContext,
+  forgeFedJsonLdContext,
+  securityJsonLdContext
+} from "./contracts.js"
+
+export type JsonPrimitive = boolean | number | string | null
+export type JsonValue = JsonPrimitive | JsonObject | ReadonlyArray<JsonValue>
+export type JsonObject = Readonly<{ [key: string]: JsonValue }>
+
+export const JsonValueSchema: Schema.Schema<JsonValue> = Schema.suspend(() =>
+  Schema.Union(
+    Schema.Null,
+    Schema.Boolean,
+    Schema.Number,
+    Schema.String,
+    Schema.Array(JsonValueSchema),
+    Schema.Record({ key: Schema.String, value: JsonValueSchema })
+  )
+)
+
+const OptionalString = Schema.optional(Schema.String)
+const OptionalBoolean = Schema.optional(Schema.Boolean)
+const JsonObjectSchema = Schema.Record({ key: Schema.String, value: JsonValueSchema })
+const JsonLdContextEntrySchema = Schema.Union(Schema.String, JsonObjectSchema)
+
+export const ActivityForgeFedJsonLdContextSchema = Schema.Tuple(
+  Schema.Literal(activityStreamsJsonLdContext),
+  Schema.Literal(forgeFedJsonLdContext)
+)
+
+export const ActorJsonLdContextSchema = Schema.Tuple(
+  Schema.Literal(activityStreamsJsonLdContext),
+  Schema.Literal(securityJsonLdContext),
+  Schema.Literal(forgeFedJsonLdContext)
+)
+
+export const JsonLdContextSchema = Schema.Union(
+  Schema.String,
+  JsonObjectSchema,
+  Schema.Array(JsonLdContextEntrySchema)
+)
+
+export const ForgeFedTicketSourceSchema = Schema.Struct({
+  content: OptionalString,
+  mediaType: OptionalString
+})
+
+export const ForgeFedTicketSchema = Schema.Struct({
+  id: Schema.String,
+  attributedTo: Schema.String,
+  summary: Schema.String,
+  content: Schema.String,
+  mediaType: OptionalString,
+  source: Schema.optional(Schema.Union(Schema.String, ForgeFedTicketSourceSchema)),
+  published: OptionalString,
+  updated: OptionalString,
+  url: OptionalString,
+  context: OptionalString,
+  workType: OptionalString,
+  attachment: Schema.optional(Schema.Array(Schema.Unknown)),
+  raw: Schema.optional(Schema.Unknown)
+})
+
+export const ActivityPubPublicKeySchema = Schema.Struct({
+  id: Schema.String,
+  owner: Schema.String,
+  publicKeyPem: Schema.String
+})
+
+const ActivityPubEndpointsSchema = Schema.Struct({
+  sharedInbox: OptionalString
+})
+
+const ActivityPubInteractionPolicySchema = Schema.Record({
+  key: Schema.String,
+  value: JsonValueSchema
+})
+
+export const ActivityPubPersonSchema = Schema.Struct({
+  "@context": JsonLdContextSchema,
+  type: Schema.Literal("Person"),
+  id: Schema.String,
+  name: Schema.String,
+  preferredUsername: Schema.String,
+  summary: Schema.String,
+  inbox: Schema.String,
+  outbox: Schema.String,
+  followers: Schema.String,
+  following: Schema.String,
+  liked: OptionalString,
+  publicKey: Schema.optional(ActivityPubPublicKeySchema),
+  endpoints: Schema.optional(ActivityPubEndpointsSchema),
+  webfinger: OptionalString,
+  featured: OptionalString,
+  featuredTags: OptionalString,
+  url: OptionalString,
+  manuallyApprovesFollowers: OptionalBoolean,
+  discoverable: OptionalBoolean,
+  indexable: OptionalBoolean,
+  published: OptionalString,
+  memorial: OptionalBoolean,
+  showFeatured: OptionalBoolean,
+  showMedia: OptionalBoolean,
+  showRepliesInMedia: OptionalBoolean,
+  interactionPolicy: Schema.optional(ActivityPubInteractionPolicySchema),
+  featuredCollections: OptionalString,
+  tag: Schema.optional(Schema.Array(JsonValueSchema)),
+  attachment: Schema.optional(Schema.Array(JsonValueSchema))
+})
+
+export const ActivityPubFollowActivitySchema = Schema.Struct({
+  "@context": ActivityForgeFedJsonLdContextSchema,
+  id: Schema.String,
+  type: Schema.Literal("Follow"),
+  actor: Schema.String,
+  object: Schema.String,
+  to: Schema.optional(Schema.Array(Schema.String)),
+  capability: OptionalString
+})
+
+export const ActivityPubOrderedCollectionSchema = Schema.Struct({
+  "@context": JsonLdContextSchema,
+  type: Schema.Literal("OrderedCollection"),
+  id: Schema.String,
+  totalItems: Schema.Number,
+  first: OptionalString,
+  last: OptionalString,
+  current: OptionalString,
+  orderedItems: Schema.optionalWith(Schema.Array(Schema.Unknown), { default: () => [] })
+})
+
+export const ActivityPubOrderedCollectionPageSchema = Schema.Struct({
+  "@context": JsonLdContextSchema,
+  type: Schema.Literal("OrderedCollectionPage"),
+  id: Schema.String,
+  totalItems: Schema.Number,
+  partOf: Schema.String,
+  next: OptionalString,
+  prev: OptionalString,
+  orderedItems: Schema.Array(Schema.Unknown)
+})

packages/api/src/api/contracts.ts

@@ -1,3 +1,17 @@
+import type * as Schema from "effect/Schema"
+
+import type {
+  ActivityForgeFedJsonLdContextSchema,
+  ActivityPubFollowActivitySchema,
+  ActivityPubOrderedCollectionPageSchema,
+  ActivityPubOrderedCollectionSchema,
+  ActivityPubPersonSchema,
+  ActivityPubPublicKeySchema,
+  ActorJsonLdContextSchema,
+  ForgeFedTicketSchema,
+  ForgeFedTicketSourceSchema
+} from "./activitypub-schema.js"
+
 export type ProjectStatus = "running" | "stopped" | "unknown"
 
 export type AgentProvider = "codex" | "opencode" | "claude" | "grok" | "custom"
@@ -556,29 +570,12 @@ export const federationJsonLdContentType =
 export const federationJsonLdResponseContentType =
   `${federationJsonLdContentType}; charset=utf-8` as const
 
-export type ActivityForgeFedJsonLdContext = typeof activityForgeFedJsonLdContext
-export type ActorJsonLdContext = typeof actorJsonLdContext
+export type ActivityForgeFedJsonLdContext = Schema.Schema.Type<typeof ActivityForgeFedJsonLdContextSchema>
+export type ActorJsonLdContext = Schema.Schema.Type<typeof ActorJsonLdContextSchema>
 
-export type ForgeFedTicket = {
-  readonly id: string
-  readonly attributedTo: string
-  readonly summary: string
-  readonly content: string
-  readonly mediaType?: string | undefined
-  readonly source?: string | ForgeFedTicketSource | undefined
-  readonly published?: string | undefined
-  readonly updated?: string | undefined
-  readonly url?: string | undefined
-  readonly context?: string | undefined
-  readonly workType?: string | undefined
-  readonly attachment?: ReadonlyArray<unknown> | undefined
-  readonly raw?: unknown | undefined
-}
+export type ForgeFedTicket = Schema.Schema.Type<typeof ForgeFedTicketSchema>
 
-export type ForgeFedTicketSource = {
-  readonly content?: string | undefined
-  readonly mediaType?: string | undefined
-}
+export type ForgeFedTicketSource = Schema.Schema.Type<typeof ForgeFedTicketSourceSchema>
 
 export type FederationIssueStatus =
   | "offered"
@@ -618,47 +615,15 @@ export type CreateFollowRequest = {
 
 export type FollowStatus = "pending" | "accepted" | "rejected"
 
-export type ActivityPubFollowActivity = {
-  readonly "@context": ActivityForgeFedJsonLdContext
-  readonly id: string
-  readonly type: "Follow"
-  readonly actor: string
-  readonly object: string
-  readonly to?: ReadonlyArray<string> | undefined
-  readonly capability?: string | undefined
-}
+export type ActivityPubFollowActivity = Schema.Schema.Type<typeof ActivityPubFollowActivitySchema>
 
-export type ActivityPubPublicKey = {
-  readonly id: string
-  readonly owner: string
-  readonly publicKeyPem: string
-}
+export type ActivityPubPublicKey = Schema.Schema.Type<typeof ActivityPubPublicKeySchema>
 
-export type ActivityPubPerson = {
-  readonly "@context": ActorJsonLdContext
-  readonly type: "Person"
-  readonly id: string
-  readonly name: string
-  readonly preferredUsername: string
-  readonly summary: string
-  readonly inbox: string
-  readonly outbox: string
-  readonly followers: string
-  readonly following: string
-  readonly liked: string
-  readonly publicKey?: ActivityPubPublicKey | undefined
-  readonly endpoints?: {
-    readonly sharedInbox?: string | undefined
-  } | undefined
-}
-
-export type ActivityPubOrderedCollection = {
-  readonly "@context": ActivityForgeFedJsonLdContext
-  readonly type: "OrderedCollection"
-  readonly id: string
-  readonly totalItems: number
-  readonly orderedItems: ReadonlyArray<unknown>
-}
+export type ActivityPubPerson = Schema.Schema.Type<typeof ActivityPubPersonSchema>
+
+export type ActivityPubOrderedCollection = Schema.Schema.Type<typeof ActivityPubOrderedCollectionSchema>
+
+export type ActivityPubOrderedCollectionPage = Schema.Schema.Type<typeof ActivityPubOrderedCollectionPageSchema>
 
 export type FollowSubscription = {
   readonly id: string

packages/api/src/api/schema.ts

@@ -1,5 +1,19 @@
 import * as Schema from "effect/Schema"
 
+export {
+  ActivityForgeFedJsonLdContextSchema,
+  ActivityPubFollowActivitySchema,
+  ActivityPubOrderedCollectionPageSchema,
+  ActivityPubOrderedCollectionSchema,
+  ActivityPubPersonSchema,
+  ActivityPubPublicKeySchema,
+  ActorJsonLdContextSchema,
+  ForgeFedTicketSchema,
+  ForgeFedTicketSourceSchema,
+  JsonLdContextSchema,
+  JsonValueSchema
+} from "./activitypub-schema.js"
+
 const OptionalString = Schema.optional(Schema.String)
 const OptionalBoolean = Schema.optional(Schema.Boolean)
 const OptionalNullableString = Schema.optional(Schema.NullOr(Schema.String))