crossfire/node/packages/contracts/src/schema/response.ts

principal = check.object({ principalId: check.identifier, matrixUserId: check.matrixUserId, kind: check.choice('human', 'agent'),
    displayName: check.text(255), ownerId: check.identifier, ownerMatrixId: check.matrixUserId })

principalIdentity = check.refine(check.object({ matrixUserId: check.matrixUserId, kind: check.choice('human', 'agent', 'unknown'),
    ownerMatrixId: check.nullable(check.matrixUserId), displayName: check.nullable(check.text(255)), ownerDisplayName: check.nullable(check.text(255)) }), identity => (identity.kind === 'agent') === (identity.ownerMatrixId !== null), 'Only registered agents have an owner')

principalIdentities = check.refine(check.list(principalIdentity, 100, 1), identities => new Set(identities.map(identity => identity.matrixUserId)).size === identities.length, 'Resolved identities must be unique')

role = check.object({ code: check.text(100), principalKind: check.choice('human', 'agent'), label: check.text(100) })

permission = check.object({ code: check.text(100), grantScope: check.choice('role', 'agent_room'), description: check.text(300) })

application = check.object({ appliedRevision: check.nullable(check.integer()), appliedStatus: check.nullable(check.status),
    nativeDisplayName: check.nullable(check.text(255)), lastAttemptAt: check.nullable(check.integer()), lastSuccessAt: check.nullable(check.integer()),
    errorCode: check.nullable(check.text(100)), errorMessage: check.nullable(check.text(4096)) })

member = check.object({ memberId: check.identifier, matrixUserId: check.matrixUserId, displayName: check.text(HUMAN_SIGNUP.labelMax),
    roleCode: check.choice('member', 'administrator'), status: check.status, revision: check.integer(), createdAt: check.integer(), application })

session = check.object({ member, csrfSecret: check.secret, permissions: check.list(check.text(100), 100) })

listenerRun = check.object({ runId: check.identifier, agentId: check.identifier, release: check.nullable(check.text(200)),
    controller: check.nullable(check.object({ fleetId: check.identifier, connectionId: check.identifier, credentialId: check.identifier })),
    startedAt: check.integer(), lastSeenAt: check.integer(), activeMs: check.integer(), messagesDelivered: check.integer(),
    stoppedAt: check.nullable(check.integer()), disconnectRequestedAt: check.nullable(check.integer()) })

activity = check.object({ status: check.choice('online', 'offline', 'disconnecting'), activeMs: check.integer(),
    messagesDelivered: check.integer(), lastSeenAt: check.nullable(check.integer()), activeRuns: check.list(listenerRun, 100) })

owner = check.object({ memberId: check.identifier, matrixUserId: check.matrixUserId, displayName: check.text(HUMAN_SIGNUP.labelMax), status: check.status })

agent = check.object({ agentId: check.identifier, matrixUserId: check.matrixUserId, name: check.name, displayName: check.text(255),
    owner, status: check.status, revision: check.integer(), createdAt: check.integer(), application, activity, nativeRuntime: check.nullable(nativeRuntimeSummary),
    deployment: check.object({ fleetId: check.identifier, fleetKey: check.name, label: check.text(100), controllerName: check.text(100), reportedAt: check.integer(), instanceKey: check.name }),
    canRetire: check.boolean, allowedActions: check.list(check.choice('configure', 'room-grant.manage', 'retire'), 3) })

wakeSender = check.refine(check.object({ identity: principal, includeAgents: check.boolean }), sender => !sender.includeAgents || sender.identity.kind === 'human', 'Only people can include their agents')

wakePolicy = check.refine(check.object({ agentId: check.identifier, revision: check.integer(), mode: check.wakeMode, senders: check.list(wakeSender, 2000) }), policy => new Set(policy.senders.map(sender => sender.identity.principalId)).size === policy.senders.length
    && policy.senders.every(sender => sender.identity.principalId !== policy.agentId)
    && (policy.mode !== 'everyone' || policy.senders.length === 0), 'Invalid selected wake authority')

grant = check.object({ agentId: check.identifier, roomId: check.roomId, generation: check.identifier, authorizerId: check.identifier,
    addedById: check.identifier, accessMode: check.choice('none', 'read', 'reply', 'custom'), powerLevel: check.nullable(check.integer(Number.MIN_SAFE_INTEGER)),
    muted: check.boolean, revision: check.integer(), accessRevision: check.integer(), updatedAt: check.integer() })

grantApplication = check.refine(check.object({ observedGeneration: check.nullable(check.identifier), appliedRevision: check.nullable(check.integer()),
    appliedAccessRevision: check.nullable(check.integer()), membership: check.nullable(check.choice('join', 'invite', 'leave', 'ban')), creator: check.boolean,
    powerLevel: check.nullable(check.integer(Number.MIN_SAFE_INTEGER)), lastAttemptAt: check.nullable(check.integer()), lastSuccessAt: check.nullable(check.integer()),
    errorCode: check.nullable(check.text(100)), errorMessage: check.nullable(check.text(4096)) }), application => !application.creator || application.powerLevel === null, 'Native creators have no finite power level')

grantView = check.object({ agentId: check.identifier, revision: check.integer(), grant: check.nullable(grant),
    ownerConversation: check.boolean,
    application: check.nullable(grantApplication), permissions: check.list(check.choice('room.agent.invite'), 1),
    allowedActions: check.list(check.choice('set', 'remove', 'permissions.set'), 3) })

deliveryGrant = check.object({ roomId: check.roomId, accessMode: check.choice('read', 'reply', 'custom'),
    powerLevel: check.nullable(check.integer(Number.MIN_SAFE_INTEGER)), muted: check.boolean })

deliveryPolicy = check.refine(check.object({ agentId: check.identifier, matrixUserId: check.matrixUserId, ownerMatrixId: check.matrixUserId,
    maxMessageBytes: check.integer(4096, 4194304),
    fleetIdleTimeoutSeconds: check.integer(0, 604800),
    status: check.status, ownerStatus: check.status, ownerConversation: check.nullable(check.roomId), roomGrants: check.list(deliveryGrant, 101), wakeMode: check.wakeMode,
    senderMatrixIds: check.list(check.matrixUserId, 2000) }), policy => new Set(policy.senderMatrixIds).size === policy.senderMatrixIds.length && !policy.senderMatrixIds.includes(policy.matrixUserId)
    && new Set(policy.roomGrants.map(grant => grant.roomId)).size === policy.roomGrants.length
    && policy.roomGrants.every(grant => (grant.accessMode === 'custom') === (grant.powerLevel !== null))
    && (policy.ownerConversation === null || policy.roomGrants.some(grant => grant.roomId === policy.ownerConversation && grant.accessMode === 'reply' && !grant.muted))
    && (policy.status === 'active' && policy.ownerStatus === 'active' || policy.senderMatrixIds.length === 0), 'Invalid resolved delivery authority')

roomAuthority = check.refine(check.object({ matrixUserId: check.matrixUserId, powerLevel: check.nullable(check.integer(Number.MIN_SAFE_INTEGER)), creator: check.boolean,
    creatorIds: check.list(check.matrixUserId, 100), readLevel: check.integer(Number.MIN_SAFE_INTEGER), replyLevel: check.integer(Number.MIN_SAFE_INTEGER),
    inviteLevel: check.integer(Number.MIN_SAFE_INTEGER), kickLevel: check.integer(Number.MIN_SAFE_INTEGER), changePowerLevel: check.integer(Number.MIN_SAFE_INTEGER),
    nativePermissions: check.list(check.object({ action: check.text(255), level: check.integer(Number.MIN_SAFE_INTEGER) }), 1000) }), authority => authority.creator === (authority.powerLevel === null), 'Native creator authority has no finite power level')

room = check.object({ roomId: check.roomId, name: check.text(255), topic: check.text(4096, 0), alias: check.nullable(check.text(255)),
    authority: check.nullable(roomAuthority) })

enrollmentItem = check.object({ instanceKey: check.name, requestedName: check.name, currentName: check.nullable(check.name), outcome: check.choice('claimed', 'existing'),
    agentId: check.nullable(check.identifier), coordinationPolicy })

enrollment = check.object({ owner: principal, controllerName: check.text(100), enrollmentId: check.identifier, ownerId: check.identifier, fleetKey: check.name,
    verificationCode: check.text(12, 12), status: check.choice('pending', 'approved', 'rejected', 'expired'), revision: check.integer(),
    createdAt: check.integer(), expiresAt: check.integer(), decidedByMemberId: check.nullable(check.identifier), decidedAt: check.nullable(check.integer()) })

enrollmentDetails = check.object({ enrollment, instances: check.list(enrollmentItem, 100) })

enrollmentIntroduction = check.object({ enrollment: enrollmentDetails, approvalUrl: check.text(2048) })

enrollmentDecision = check.object({ enrollmentId: check.identifier, status: check.choice('approved', 'rejected'), revision: check.integer() })

preflight = check.object({ available: check.boolean, instances: check.integer(1, 100) })

enrollmentExchange = check.object({ status: check.choice('pending', 'rejected', 'expired', 'provisioning', 'ready'),
    fleet: check.nullable(check.object({ fleetId: check.identifier, controllerCredential: check.nullable(check.text(200)) })),
    ownerMatrixId: check.matrixUserId, instances: check.list(check.object({ instanceKey: check.name, name: check.name, agentId: check.nullable(check.identifier),
        status: check.choice('ready', 'provisioning'), errorCode: check.nullable(check.text(100)), account: check.nullable(check.object({
            matrixUserId: check.matrixUserId, accessToken: check.text(8192), deviceId: check.text(255)
        })) }), 100) })

fleet = check.object({ fleetId: check.identifier, owner: principal, fleetKey: check.name, label: check.text(100), controller,
    revision: check.integer(), createdAt: check.integer(), updatedAt: check.integer(), delivery: fleetControl,
    canArchive: check.boolean, allowedActions: check.list(check.choice('configure', 'archive'), 2) })

fleetAgent = check.object({ instanceKey: check.name, agent })

invitation = check.object({ invitationId: check.identifier, createdByMemberId: check.identifier, roleCode: check.choice('member', 'administrator'),
    createdAt: check.integer(), expiresAt: check.integer(), consumedByMemberId: check.nullable(check.identifier), revokedAt: check.nullable(check.integer()) })

invitationCreated = check.object({ invitationId: check.identifier, claimSecret: check.secret, expiresAt: check.integer(), signupUrl: check.text(2048) })

policy = check.object({ revision: check.integer(), maxOwnerAgents: check.integer(1, 100), maxAgents: check.integer(1, 1000),
    maxMessageBytes: check.integer(4096, 4194304),
    fleetIdleTimeoutSeconds: check.integer(0, 604800),
    maxPending: check.integer(1, 1000), enrollmentSeconds: check.integer(60, 3600), reconcileSeconds: check.integer(30, 3600), agentInstructions: check.multiline,
    signupMode: check.choice('invitation', 'open'), invitationIssuers: check.choice('administrators', 'members') })

audit = check.object({ auditId: check.identifier, requestId: check.text(255), actorCredentialId: check.nullable(check.identifier), actorKind: check.choice('human', 'agent', 'controller', 'system', 'anonymous'),
    actor: check.nullable(principal), target: check.nullable(principal),
    actorPrincipalId: check.nullable(check.identifier), ownerId: check.nullable(check.identifier), targetKind: check.text(100), targetId: check.text(255),
    roomId: check.nullable(check.roomId), membershipGeneration: check.nullable(check.identifier), authorizerId: check.nullable(check.identifier),
    addedById: check.nullable(check.identifier), permissionCode: check.nullable(check.text(100)), action: check.text(100),
    outcome: check.text(100), message: check.text(4096, 0), createdAt: check.integer() })

acknowledged = check.object({ accepted: check.boolean })

recorded = check.object({ recorded: check.boolean })

report = check.object({ disconnect: check.boolean, currentRelease: check.text(200), statisticsAccepted: check.boolean })

notice = check.object({ outcome: check.choice('pending', 'sent', 'denied', 'not-applicable', 'not-permitted', 'rate-limited') })

export type AgentView = Parsed<typeof agent>;

export type PrincipalIdentity = Parsed<typeof principalIdentity>;

export type MemberView = Parsed<typeof member>;

export type SessionView = Parsed<typeof session>;

export type RoomView = Parsed<typeof room>;

export type RoomGrantView = Parsed<typeof grantView>;

export type EnrollmentView = Parsed<typeof enrollmentDetails>;

export type FleetView = Parsed<typeof fleet>;

export type DeliveryPolicy = Parsed<typeof deliveryPolicy>;

export type ActivityView = Parsed<typeof activity>;

export type ListenerRunView = Parsed<typeof listenerRun>;

export type PolicyView = Parsed<typeof policy>;