TypeScript SDK Reference¶

const client = new A2PClient({
  agentDid: string,
  privateKey?: string,
  gatewayUrl?: string
});

const profile = await client.getProfile({
  userDid: string,
  scopes: string[]
}): Promise<Profile>

const result = await client.requestAccess({
  userDid: string,
  scopes: string[],
  purpose: Purpose
}): Promise<AccessResult>

const proposal = await client.proposeMemory({
  userDid: string,
  content: string,
  category: string,
  confidence: number,
  context?: string
}): Promise<Proposal>

const client = new A2PUserClient({
  storage?: StorageAdapter
});

const profile = await client.createProfile({
  displayName: string,
  preferences?: Preferences
}): Promise<Profile>

const proposals = await client.getPendingProposals(): Promise<Proposal[]>

await client.reviewProposal(
  proposalId: string,
  decision: { action: 'approve' | 'reject', editedContent?: string }
): Promise<void>

await client.setPolicy({
  name: string,
  agentPattern: string,
  allow: string[],
  deny?: string[],
  permissions: Permission[]
}): Promise<Policy>

interface Profile {
  id: DID;
  version: string;
  profileType: 'human' | 'agent' | 'entity';
  identity: Identity;
  common?: CommonData;
  memories?: Record<string, any>;
  accessPolicies?: Policy[];
}

interface Purpose {
  type: PurposeType;
  description: string;
  legalBasis: LegalBasis;
  retention?: string;
  automated?: {
    decisionMaking: boolean;
    profiling: boolean;
  };
}

interface AccessResult {
  granted: boolean;
  grantedScopes: string[];
  deniedScopes: string[];
  consentReceipt?: ConsentReceipt;
  reason?: string;
}