@aep-foundation/platform 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,432 @@
+import { AepSigningAlgorithm, AepProblemDetails, AepAuthenticatedCommand, AepClientAssertionClaims, AepImportableJoseKey } from '@aep-foundation/core';
+
+declare const packageName = "@aep-foundation/platform";
+declare const platformHostedIdentityDraft = "draft-kavian-aep-platform-hosted-identity-00";
+declare const defaultAssertionLifetimeSeconds = 300;
+type ManagedAgentStatus = "active" | "revoked" | "suspended" | "terminated";
+interface PlatformDiscoveryDocument {
+    aep_version: string;
+    endpoints: {
+        hosted_verification?: string;
+        lifecycle: string;
+        list: string;
+        provision: string;
+        sign: string;
+        [key: string]: unknown;
+    };
+    http: {
+        endpoint_base: string;
+        [key: string]: unknown;
+    };
+    identity: {
+        did_methods: string[];
+        did_url_template: string;
+        [key: string]: unknown;
+    };
+    platform: {
+        did?: string;
+        hosted_verification: boolean;
+        name: string;
+        [key: string]: unknown;
+    };
+    signing: {
+        algorithms: AepSigningAlgorithm[];
+        default_lifetime_seconds: string;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+interface PlatformDiscoveryDocumentOptions {
+    aepVersion?: string;
+    defaultLifetimeSeconds?: number;
+    didMethods?: string[];
+    didUrlTemplate: string;
+    endpointBase: string;
+    endpoints: {
+        hostedVerification?: string;
+        lifecycle: string;
+        list: string;
+        provision: string;
+        sign: string;
+    };
+    hostedVerification?: boolean;
+    maxLifetimeSeconds?: number;
+    platformDid?: string;
+    platformName: string;
+    signingAlgorithms: AepSigningAlgorithm[];
+}
+interface ManagedAgentIdentity {
+    accountId?: string;
+    agentDid: string;
+    createdAt: string;
+    metadata: Record<string, unknown>;
+    status: ManagedAgentStatus;
+    subjectDid?: string;
+    tenantId?: string;
+    updatedAt: string;
+}
+interface ServiceScopedAgentDidOptions {
+    agentDidId: string;
+    host: string;
+    pathPrefix?: string;
+}
+interface PlatformAgentIdentity {
+    agent_did: string;
+    agent_identity_id: string;
+    created_at: string;
+    did_document_url: string;
+    key_id: string;
+    service_did: string;
+    signing_algorithms: AepSigningAlgorithm[];
+    status: ManagedAgentStatus;
+    updated_at: string;
+}
+interface PlatformPage<T> {
+    count: string;
+    data: T[];
+    total: string;
+}
+type PlatformAgentIdentityListResponse = PlatformPage<PlatformAgentIdentity>;
+interface PlatformAgentIdentityOptions {
+    agentDid: string;
+    agentIdentityId: string;
+    clock?: () => Date;
+    didDocumentUrl?: string;
+    keyId?: string;
+    serviceDid: string;
+    signingAlgorithms: AepSigningAlgorithm[];
+    status?: ManagedAgentStatus;
+}
+interface ManagedAgentIdentityOptions {
+    accountId?: string;
+    agentDid: string;
+    clock?: () => Date;
+    metadata?: Record<string, unknown>;
+    status?: ManagedAgentStatus;
+    subjectDid?: string;
+    tenantId?: string;
+}
+interface ManagedAgentIdentityUpdate {
+    accountId?: string;
+    metadata?: Record<string, unknown>;
+    status?: ManagedAgentStatus;
+    subjectDid?: string;
+    tenantId?: string;
+}
+interface PlatformLifecycleRequest {
+    status: ManagedAgentStatus;
+}
+interface PlatformLifecycleRequestOptions {
+    status: ManagedAgentStatus;
+}
+interface ManagedAgentRegistry {
+    get(agentDid: string): ManagedAgentIdentity | undefined;
+    list(filter?: ManagedAgentListFilter): ManagedAgentIdentity[];
+    remove(agentDid: string): boolean;
+    setStatus(agentDid: string, status: ManagedAgentStatus): ManagedAgentIdentity;
+    upsert(identity: ManagedAgentIdentity): ManagedAgentIdentity;
+}
+interface ManagedAgentListFilter {
+    accountId?: string;
+    status?: ManagedAgentStatus;
+    tenantId?: string;
+}
+interface PlatformEnrollRequest {
+    agent_did: string;
+    claims?: Record<string, unknown>;
+    idempotency_key: string;
+}
+interface PlatformEnrollRequestOptions {
+    claims?: Record<string, unknown>;
+    identity: ManagedAgentIdentity;
+    idempotencyKey: string;
+}
+interface PlatformProvisionRequest {
+    idempotency_key: string;
+    service_did: string;
+}
+interface PlatformProvisionRequestOptions {
+    idempotencyKey: string;
+    serviceDid: string;
+}
+interface PlatformClientAssertionClaims {
+    aud: string;
+    exp: number;
+    iat: number;
+    iss: string;
+    jti: string;
+    op: AepAuthenticatedCommand;
+    sub: string;
+}
+interface PlatformClientAssertionClaimsOptions {
+    command: AepAuthenticatedCommand;
+    identity: ManagedAgentIdentity;
+    issuedAt?: Date | number;
+    jti: string;
+    maxLifetimeSeconds?: number;
+    serviceDid: string;
+    lifetimeSeconds?: number;
+}
+type DidVerificationRelationship = "assertionMethod" | "authentication" | "capabilityDelegation" | "capabilityInvocation" | "keyAgreement";
+interface DidVerificationMethod {
+    controller: string;
+    id: string;
+    publicKeyJwk?: Record<string, unknown>;
+    publicKeyMultibase?: string;
+    publicKeyPem?: string;
+    type: string;
+    [key: string]: unknown;
+}
+interface DidService {
+    id: string;
+    serviceEndpoint: string | string[] | Record<string, unknown>;
+    type: string;
+    [key: string]: unknown;
+}
+interface DidDocument {
+    "@context": string | string[];
+    assertionMethod?: Array<string | DidVerificationMethod>;
+    authentication?: Array<string | DidVerificationMethod>;
+    capabilityDelegation?: Array<string | DidVerificationMethod>;
+    capabilityInvocation?: Array<string | DidVerificationMethod>;
+    controller?: string | string[];
+    id: string;
+    keyAgreement?: Array<string | DidVerificationMethod>;
+    service?: DidService[];
+    verificationMethod?: DidVerificationMethod[];
+    [key: string]: unknown;
+}
+interface ManagedAgentDidVerificationMethodOptions {
+    controller?: string;
+    id?: string;
+    publicKeyJwk?: Record<string, unknown>;
+    publicKeyMultibase?: string;
+    publicKeyPem?: string;
+    relationships?: DidVerificationRelationship[];
+    type: string;
+    [key: string]: unknown;
+}
+interface ManagedAgentDidDocumentOptions {
+    additionalContexts?: string[];
+    controller?: string | string[];
+    identity: ManagedAgentIdentity;
+    service?: DidService[];
+    verificationMethods: ManagedAgentDidVerificationMethodOptions[];
+}
+interface DidDocumentPublication {
+    document: DidDocument;
+    publishedAt: string;
+    url?: string;
+}
+interface DidDocumentPublisher {
+    publish(document: DidDocument): Promise<DidDocumentPublication> | DidDocumentPublication;
+}
+interface PublishManagedAgentDidDocumentOptions extends ManagedAgentDidDocumentOptions {
+    publisher: DidDocumentPublisher;
+}
+interface PlatformDelegatedSigningContext {
+    identity: ManagedAgentIdentity;
+    signingAlgorithms: AepSigningAlgorithm[];
+}
+type PlatformDelegatedSigner = (claims: AepClientAssertionClaims, context: PlatformDelegatedSigningContext) => Promise<string> | string;
+interface JwtPlatformDelegatedSignerOptions {
+    alg?: AepSigningAlgorithm;
+    key: AepImportableJoseKey;
+    kid?: string;
+    typ?: string;
+}
+interface SignPlatformClientAssertionOptions extends PlatformClientAssertionClaimsOptions {
+    signer: PlatformDelegatedSigner;
+    signingAlgorithms?: AepSigningAlgorithm[];
+}
+interface PlatformSignRequest {
+    jti: string;
+    lifetime_seconds?: string;
+    op: AepAuthenticatedCommand;
+    service_did: string;
+}
+interface PlatformSignRequestOptions {
+    command: AepAuthenticatedCommand;
+    jti: string;
+    maxLifetimeSeconds?: number;
+    serviceDid: string;
+    lifetimeSeconds?: number;
+}
+interface PlatformSignResponse {
+    agent_did: string;
+    client_assertion: string;
+    expires_at: string;
+    issued_at: string;
+    jti: string;
+    service_did: string;
+}
+interface PlatformSignResponseOptions {
+    clientAssertion: string;
+    identity: ManagedAgentIdentity;
+    issuedAt?: Date | number;
+    jti: string;
+    maxLifetimeSeconds?: number;
+    serviceDid: string;
+    lifetimeSeconds?: number;
+}
+interface PlatformVerificationRequest {
+    client_assertion: string;
+    op: AepAuthenticatedCommand;
+    service_did: string;
+}
+interface PlatformVerificationRequestOptions {
+    clientAssertion: string;
+    command: AepAuthenticatedCommand;
+    serviceDid: string;
+}
+interface PlatformVerificationResponse {
+    agent_did?: string;
+    agent_identity_id?: string;
+    op?: AepAuthenticatedCommand;
+    reason: string;
+    service_did: string;
+    status?: ManagedAgentStatus;
+    verified: boolean;
+}
+interface PlatformVerificationResponseOptions {
+    agentDid?: string;
+    agentIdentityId?: string;
+    command?: AepAuthenticatedCommand;
+    reason: string;
+    serviceDid: string;
+    status?: ManagedAgentStatus;
+    verified: boolean;
+}
+type Awaitable<T> = T | Promise<T>;
+interface PlatformHttpResponse<TBody = unknown> {
+    body: TBody;
+    contentType: string;
+    status: number;
+}
+interface PlatformRequestContext {
+    authorization?: string;
+    now?: Date;
+    requestId?: string;
+    subject?: string;
+}
+interface PlatformIdentityRecord {
+    agentDid: string;
+    agentDidId: string;
+    agentIdentityId: string;
+    createdAt: string;
+    didDocumentUrl: string;
+    keyId: string;
+    serviceDid: string;
+    signingAlgorithms: AepSigningAlgorithm[];
+    status: ManagedAgentStatus;
+    updatedAt: string;
+}
+interface PlatformIdentityListQuery {
+    limit?: number;
+    offset?: number;
+    serviceDid?: string;
+    status?: ManagedAgentStatus;
+}
+interface PlatformIdentityListResult {
+    identities: PlatformIdentityRecord[];
+    total: number;
+}
+interface PlatformIdentityStore {
+    create(identity: PlatformIdentityRecord, context: PlatformRequestContext): Awaitable<void>;
+    findByAgentDid(agentDid: string, context: PlatformRequestContext): Awaitable<PlatformIdentityRecord | undefined>;
+    get(agentIdentityId: string, context: PlatformRequestContext): Awaitable<PlatformIdentityRecord | undefined>;
+    list(query: PlatformIdentityListQuery, context: PlatformRequestContext): Awaitable<PlatformIdentityListResult>;
+    update(agentIdentityId: string, update: {
+        status: ManagedAgentStatus;
+        updatedAt: string;
+    }, context: PlatformRequestContext): Awaitable<PlatformIdentityRecord | undefined>;
+}
+interface PlatformProvisionIdempotencyRecord {
+    idempotencyKey: string;
+    requestHash: string;
+    response: PlatformAgentIdentity;
+}
+interface PlatformProvisionIdempotencyStore {
+    get(idempotencyKey: string, context: PlatformRequestContext): Awaitable<PlatformProvisionIdempotencyRecord | undefined>;
+    set(record: PlatformProvisionIdempotencyRecord, context: PlatformRequestContext): Awaitable<void>;
+}
+interface PlatformReplayStore {
+    consume(key: string, expiresAt: Date, context: PlatformRequestContext): Awaitable<boolean>;
+}
+interface PlatformKeyStore {
+    create(identity: PlatformIdentityRecord, context: PlatformRequestContext): Awaitable<void>;
+    didVerificationMethod(identity: PlatformIdentityRecord, context: PlatformRequestContext): Awaitable<ManagedAgentDidVerificationMethodOptions>;
+    sign(identity: PlatformIdentityRecord, claims: AepClientAssertionClaims, context: PlatformRequestContext): Awaitable<string>;
+    verificationKey(identity: PlatformIdentityRecord, context: PlatformRequestContext): Awaitable<AepImportableJoseKey>;
+}
+interface PlatformServiceDidResolver {
+    resolve(serviceDid: string, context: PlatformRequestContext): Awaitable<boolean>;
+}
+interface PlatformAuthorizer {
+    authorizeIdentityAccess?(identity: PlatformIdentityRecord, context: PlatformRequestContext): Awaitable<boolean>;
+    authorizeList?(context: PlatformRequestContext): Awaitable<boolean>;
+    authorizeProvision?(request: PlatformProvisionRequest, context: PlatformRequestContext): Awaitable<boolean>;
+}
+interface PlatformLifecyclePolicy {
+    canSign(identity: PlatformIdentityRecord, context: PlatformRequestContext): Awaitable<boolean>;
+    canTransition(identity: PlatformIdentityRecord, nextStatus: ManagedAgentStatus, context: PlatformRequestContext): Awaitable<boolean>;
+    canVerify(identity: PlatformIdentityRecord, context: PlatformRequestContext): Awaitable<boolean>;
+}
+interface CreateAepPlatformOptions {
+    authorizer?: PlatformAuthorizer;
+    clock?: () => Date;
+    defaultLifetimeSeconds?: number;
+    didHost: string;
+    didPathPrefix?: string;
+    didUrlTemplate: string;
+    discovery: Omit<PlatformDiscoveryDocumentOptions, "defaultLifetimeSeconds" | "didUrlTemplate" | "signingAlgorithms">;
+    idGenerator?: () => string;
+    idempotencyStore: PlatformProvisionIdempotencyStore;
+    identityStore: PlatformIdentityStore;
+    keyStore: PlatformKeyStore;
+    lifecyclePolicy?: PlatformLifecyclePolicy;
+    maxLifetimeSeconds?: number;
+    replayStore: PlatformReplayStore;
+    serviceDidResolver: PlatformServiceDidResolver;
+    signingAlgorithms: AepSigningAlgorithm[];
+}
+interface AepPlatform {
+    discovery(): PlatformHttpResponse<PlatformDiscoveryDocument>;
+    getDidDocument(agentIdentityId: string, context?: PlatformRequestContext): Promise<PlatformHttpResponse<DidDocument | AepProblemDetails>>;
+    getIdentity(agentIdentityId: string, context?: PlatformRequestContext): Promise<PlatformHttpResponse<PlatformAgentIdentity | AepProblemDetails>>;
+    list(query?: PlatformIdentityListQuery, context?: PlatformRequestContext): Promise<PlatformHttpResponse<PlatformAgentIdentityListResponse | AepProblemDetails>>;
+    provision(body: unknown, context?: PlatformRequestContext): Promise<PlatformHttpResponse<PlatformAgentIdentity | AepProblemDetails>>;
+    sign(agentIdentityId: string, body: unknown, context?: PlatformRequestContext): Promise<PlatformHttpResponse<PlatformSignResponse | AepProblemDetails>>;
+    updateIdentity(agentIdentityId: string, body: unknown, context?: PlatformRequestContext): Promise<PlatformHttpResponse<PlatformAgentIdentity | AepProblemDetails>>;
+    verify(body: unknown, context?: PlatformRequestContext): Promise<PlatformHttpResponse<PlatformVerificationResponse>>;
+}
+declare class InMemoryManagedAgentRegistry implements ManagedAgentRegistry {
+    #private;
+    constructor(identities?: ManagedAgentIdentity[]);
+    get(agentDid: string): ManagedAgentIdentity | undefined;
+    list(filter?: ManagedAgentListFilter): ManagedAgentIdentity[];
+    remove(agentDid: string): boolean;
+    setStatus(agentDid: string, status: ManagedAgentStatus): ManagedAgentIdentity;
+    upsert(identity: ManagedAgentIdentity): ManagedAgentIdentity;
+}
+declare function createManagedAgentIdentity(options: ManagedAgentIdentityOptions): ManagedAgentIdentity;
+declare function updateManagedAgentIdentity(identity: ManagedAgentIdentity, update: ManagedAgentIdentityUpdate, clock?: () => Date): ManagedAgentIdentity;
+declare function createPlatformDiscoveryDocument(options: PlatformDiscoveryDocumentOptions): PlatformDiscoveryDocument;
+declare function createServiceScopedAgentDid(options: ServiceScopedAgentDidOptions): string;
+declare function createPlatformAgentIdentity(options: PlatformAgentIdentityOptions): PlatformAgentIdentity;
+declare function createPlatformAgentIdentityListResponse(identities: PlatformAgentIdentity[], total?: number): PlatformAgentIdentityListResponse;
+declare function createPlatformLifecycleRequest(options: PlatformLifecycleRequestOptions): PlatformLifecycleRequest;
+declare function createPlatformProvisionRequest(options: PlatformProvisionRequestOptions): PlatformProvisionRequest;
+declare function createPlatformEnrollRequest(options: PlatformEnrollRequestOptions): PlatformEnrollRequest;
+declare function createPlatformClientAssertionClaims(options: PlatformClientAssertionClaimsOptions): AepClientAssertionClaims;
+declare function createManagedAgentDidDocument(options: ManagedAgentDidDocumentOptions): DidDocument;
+declare function publishManagedAgentDidDocument(options: PublishManagedAgentDidDocumentOptions): Promise<DidDocumentPublication>;
+declare function createJwtPlatformDelegatedSigner(options: JwtPlatformDelegatedSignerOptions): PlatformDelegatedSigner;
+declare function signPlatformClientAssertion(options: SignPlatformClientAssertionOptions): Promise<string>;
+declare function createPlatformSignRequest(options: PlatformSignRequestOptions): PlatformSignRequest;
+declare function createPlatformSignResponse(options: PlatformSignResponseOptions): PlatformSignResponse;
+declare function createPlatformVerificationRequest(options: PlatformVerificationRequestOptions): PlatformVerificationRequest;
+declare function createPlatformVerificationResponse(options: PlatformVerificationResponseOptions): PlatformVerificationResponse;
+declare function createAepPlatform(options: CreateAepPlatformOptions): AepPlatform;
+
+export { type AepPlatform, type Awaitable, type CreateAepPlatformOptions, type DidDocument, type DidDocumentPublication, type DidDocumentPublisher, type DidService, type DidVerificationMethod, type DidVerificationRelationship, InMemoryManagedAgentRegistry, type JwtPlatformDelegatedSignerOptions, type ManagedAgentDidDocumentOptions, type ManagedAgentDidVerificationMethodOptions, type ManagedAgentIdentity, type ManagedAgentIdentityOptions, type ManagedAgentIdentityUpdate, type ManagedAgentListFilter, type ManagedAgentRegistry, type ManagedAgentStatus, type PlatformAgentIdentity, type PlatformAgentIdentityListResponse, type PlatformAgentIdentityOptions, type PlatformAuthorizer, type PlatformClientAssertionClaims, type PlatformClientAssertionClaimsOptions, type PlatformDelegatedSigner, type PlatformDelegatedSigningContext, type PlatformDiscoveryDocument, type PlatformDiscoveryDocumentOptions, type PlatformEnrollRequest, type PlatformEnrollRequestOptions, type PlatformHttpResponse, type PlatformIdentityListQuery, type PlatformIdentityListResult, type PlatformIdentityRecord, type PlatformIdentityStore, type PlatformKeyStore, type PlatformLifecyclePolicy, type PlatformLifecycleRequest, type PlatformLifecycleRequestOptions, type PlatformPage, type PlatformProvisionIdempotencyRecord, type PlatformProvisionIdempotencyStore, type PlatformProvisionRequest, type PlatformProvisionRequestOptions, type PlatformReplayStore, type PlatformRequestContext, type PlatformServiceDidResolver, type PlatformSignRequest, type PlatformSignRequestOptions, type PlatformSignResponse, type PlatformSignResponseOptions, type PlatformVerificationRequest, type PlatformVerificationRequestOptions, type PlatformVerificationResponse, type PlatformVerificationResponseOptions, type PublishManagedAgentDidDocumentOptions, type ServiceScopedAgentDidOptions, type SignPlatformClientAssertionOptions, createAepPlatform, createJwtPlatformDelegatedSigner, createManagedAgentDidDocument, createManagedAgentIdentity, createPlatformAgentIdentity, createPlatformAgentIdentityListResponse, createPlatformClientAssertionClaims, createPlatformDiscoveryDocument, createPlatformEnrollRequest, createPlatformLifecycleRequest, createPlatformProvisionRequest, createPlatformSignRequest, createPlatformSignResponse, createPlatformVerificationRequest, createPlatformVerificationResponse, createServiceScopedAgentDid, defaultAssertionLifetimeSeconds, packageName, platformHostedIdentityDraft, publishManagedAgentDidDocument, signPlatformClientAssertion, updateManagedAgentIdentity };