{ "schemaVersion": 1, "generator": "scripts/generate-api-reference.mjs", "manifestSha256": "96f5f16fa05b332f404e0d9173118d66b38a81ff2ed7d9e34d2eb0d58f1bc78c", "methodology": "Integrity-verified npm archives; static TypeScript symbol resolution; no published package execution. Declaration signatures are reference, not runnable examples.", "packages": [ { "name": "@openagentid/aegis-sdk", "version": "0.1.1", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/aegis-sdk/-/aegis-sdk-0.1.1.tgz", "integrity": "sha512-eKG79P17teM8i+ZQaNdBEPJnL0XT9723i04kDxgVRrOb0VOnNW5rt2doLq8g4mHBZ4rjHdPEuzZmj5LsL4iuVw==", "packageJsonSha256": "f9116fd39eaff66ca2c6acbe5b7381cfb51559dbcd7599fddd8c7b90348cb663", "page": "/reference/typescript/aegis-sdk", "engines": { "node": ">=20" }, "dependencies": { "uuid": "^11.0.0", "zod": "^3.23.0" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/aegis-sdk", "page": "/reference/typescript/aegis-sdk", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "ActiveHours", "declarationName": "ActiveHours", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ActiveHours {\n startHour: number;\n endHour: number;\n timezone: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 126, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "activehours" }, { "name": "ActiveHoursSchema", "declarationName": "ActiveHoursSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ActiveHoursSchema: z.ZodObject<{\n startHour: z.ZodNumber;\n endHour: z.ZodNumber;\n timezone: z.ZodString;\n}, \"strip\", z.ZodTypeAny, {\n startHour: number;\n endHour: number;\n timezone: string;\n}, {\n startHour: number;\n endHour: number;\n timezone: string;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 232, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "activehoursschema" }, { "name": "AddressDeriver", "declarationName": "AddressDeriver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class AddressDeriver {\n static derivationPath(chain: Chain, account: number, index: number): string;\n static deriveAddress(chain: Chain, publicKeyBytes: Uint8Array): WalletAddress;\n static deriveAll(publicKeyBytes: Uint8Array, chains: readonly Chain[]): WalletAddress[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/wallet/index.d.ts", "line": 11, "sha256": "b9fcb67088060fec0eefaebce36a7aca2f6490dc507858d671ce6d8c084a774d" } } ], "anchor": "addressderiver" }, { "name": "AegisClient", "declarationName": "AegisClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Unified AEGIS client.\n\nHolds a [`PluginRegistry`], a verification pipeline, a session manager,\na delegation tree, and (optionally) a transaction pipeline. Storage\nbackends are accessible via the `stores` field.", "tags": [], "signatures": [ { "code": "declare class AegisClient {\n readonly registry: PluginRegistry;\n readonly verifier: VerificationPipeline;\n readonly sessions: SessionManager;\n readonly delegations: DelegationTree;\n readonly config: AegisConfig;\n readonly stores: AegisStores;\n constructor(params: {\n registry: PluginRegistry;\n config?: AegisConfig;\n stores?: AegisStores;\n });\n static withDefaults(registry: PluginRegistry): AegisClient;\n withSigner(signer: SigningBackend): this;\n verifyIdentity(did: string): Promise;\n verifyIdentityFresh(did: string): Promise;\n authenticate(credential: AuthCredential, identityType: IdentityType): Promise;\n getSession(sessionId: string): Session;\n revokeSession(sessionId: string): void;\n isSessionValid(sessionId: string): boolean;\n authorize(request: PolicyRequest): Promise;\n composePolicyDecisions(decisions: readonly PolicyDecision[]): PolicyDecision;\n delegate(params: {\n delegatorDid: string;\n delegateDid: string;\n scope: DelegationScope;\n expires?: string | null;\n signingKey: Uint8Array;\n verificationMethod: string;\n }): Delegation;\n verifyDelegation(delegation: Delegation, delegatorPublicKey: Uint8Array): boolean;\n revokeDelegation(delegationId: string): string[];\n signTransaction(tx: Transaction, auth: AuthContext, policyDecision: PolicyDecision): Promise;\n transactions(): TransactionPipeline | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 61, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "aegisclient" }, { "name": "AegisConfig", "declarationName": "AegisConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AegisConfig {\n verification: VerificationConfig;\n sessions: SessionConfig;\n keys: KeyConfig;\n storageBackend: StorageBackend;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 29, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "aegisconfig" }, { "name": "AegisError", "declarationName": "AegisError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AegisError = ResolverError | AuthError | PolicyError | VerificationError | KeyError | DelegationError | WalletError;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 245, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "aegiserror" }, { "name": "AegisException", "declarationName": "AegisException", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Throwable wrapper around a tagged AegisError.", "tags": [], "signatures": [ { "code": "declare class AegisException extends Error {\n readonly error: AegisError;\n constructor(error: AegisError);\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 247, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "aegisexception" }, { "name": "AegisIdentity", "declarationName": "AegisIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Identity information extracted from authentication.", "tags": [], "signatures": [ { "code": "interface AegisIdentity {\n did: string;\n identityType: IdentityType;\n displayName?: string | null;\n conformanceLevel?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 6, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "aegisidentity" }, { "name": "AegisStores", "declarationName": "AegisStores", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Collection of pluggable persistent storage backends used by the client.\n\nDefaults to in-memory implementations. Application code may inject\nPostgres-backed (or any other) implementations via `withStores`.", "tags": [], "signatures": [ { "code": "interface AegisStores {\n sessionStore: SessionStore;\n nonceStore: NonceStore;\n delegationStore: DelegationStore;\n revocationStore: RevocationStore;\n keyStore: KeyStore;\n verificationCacheStore: VerificationCacheStore;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 45, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "aegisstores" }, { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentLineageProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 19, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "agentlineageproof" }, { "name": "ApiKeyProvider", "declarationName": "ApiKeyProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Simple API key auth provider for service-to-service communication.\n\nMaps opaque API keys to DIDs. Suitable for internal services that\nauthenticate via pre-shared keys rather than challenge-response.", "tags": [], "signatures": [ { "code": "declare class ApiKeyProvider implements AuthProvider {\n constructor(initial?: Record);\n providerName(): string;\n registerKey(key: string, did: string): void;\n revokeKey(key: string): boolean;\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 77, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "apikeyprovider" }, { "name": "AuditInfo", "declarationName": "AuditInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuditInfo {\n auditId: string;\n timestamp: string;\n engine: string;\n policiesEvaluated: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 86, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "auditinfo" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The output of successful authentication (AEGIS Spec §7.1).", "tags": [], "signatures": [ { "code": "interface AuthContext {\n provider: string;\n subject: string;\n did?: string | null;\n sessionId?: string | null;\n expiresAt?: string | null;\n claims: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 13, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcontext" }, { "name": "AuthCredential", "declarationName": "AuthCredential", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Discriminated union of credentials accepted by AEGIS auth providers (§7.2).", "tags": [], "signatures": [ { "code": "type AuthCredential = {\n type: \"bearer_token\";\n token: string;\n} | {\n type: \"session_cookie\";\n cookie: string;\n} | {\n type: \"api_key\";\n key: string;\n} | {\n type: \"signed_challenge\";\n did: string;\n challenge: string;\n signature: string;\n timestamp: string;\n nonce: string;\n} | {\n type: \"capability_token\";\n token: string;\n} | {\n type: \"passkey_assertion\";\n credentialId: string;\n authenticatorData: string;\n clientDataJson: string;\n signature: string;\n} | {\n type: \"custom\";\n provider: string;\n data: unknown;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 22, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcredential" }, { "name": "AuthError", "declarationName": "AuthError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuthError = {\n kind: \"auth/invalid_credential\";\n reason: string;\n message: string;\n} | {\n kind: \"auth/credential_expired\";\n expiredAt: string;\n message: string;\n} | {\n kind: \"auth/session_revoked\";\n sessionId: string;\n message: string;\n} | {\n kind: \"auth/session_expired\";\n sessionId: string;\n message: string;\n} | {\n kind: \"auth/challenge_invalid\";\n reason: string;\n message: string;\n} | {\n kind: \"auth/provider_unavailable\";\n provider: string;\n message: string;\n} | {\n kind: \"auth/refresh_not_supported\";\n provider: string;\n message: string;\n} | {\n kind: \"auth/revocation_not_supported\";\n provider: string;\n message: string;\n} | {\n kind: \"auth/internal\";\n reason: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 38, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "autherror" }, { "name": "authErrors", "declarationName": "authErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const authErrors: {\n invalidCredential: (reason: string) => AuthError;\n credentialExpired: (expiredAt: string) => AuthError;\n sessionRevoked: (sessionId: string) => AuthError;\n sessionExpired: (sessionId: string) => AuthError;\n challengeInvalid: (reason: string) => AuthError;\n providerUnavailable: (provider: string) => AuthError;\n refreshNotSupported: (provider: string) => AuthError;\n revocationNotSupported: (provider: string) => AuthError;\n internal: (reason: string) => AuthError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 261, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "autherrors" }, { "name": "AuthorizedTransaction", "declarationName": "AuthorizedTransaction", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuthorizedTransaction {\n transaction: Transaction;\n signature: Uint8Array;\n fulfilledObligations: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 50, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "authorizedtransaction" }, { "name": "AuthProvider", "declarationName": "AuthProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuthProvider {\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n providerName(): string;\n refresh?(ctx: AuthContext): Promise;\n revoke?(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 92, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "authprovider" }, { "name": "base64UrlDecode", "declarationName": "base64UrlDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a URL-safe base64 string (with or without padding) to bytes.", "tags": [], "signatures": [ { "code": "declare function base64UrlDecode(input: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 4, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "base64urldecode" }, { "name": "base64UrlEncode", "declarationName": "base64UrlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes as URL-safe base64 without padding.", "tags": [], "signatures": [ { "code": "declare function base64UrlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 2, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "base64urlencode" }, { "name": "BatchMode", "declarationName": "BatchMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type BatchMode = \"all_or_nothing\" | \"best_effort\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 184, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "batchmode" }, { "name": "buildChallengePayload", "declarationName": "buildChallengePayload", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build the JCS-canonical payload bytes for challenge signing/verification.\n\nCanonical form is a JSON object with keys in alphabetical order:\n\n {\"challenge\":\"\",\"did\":\"\",\"nonce\":\"\",\"timestamp\":\"\"}\n\nThe WASM crypto backend's `jcsCanonicalize` handles RFC 8785 ordering.", "tags": [], "signatures": [ { "code": "declare function buildChallengePayload(challenge: Challenge, did: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 28, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "buildchallengepayload" }, { "name": "Chain", "declarationName": "Chain", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type Chain = \"ethereum\" | \"polygon\" | \"arbitrum\" | \"optimism\" | \"base\" | \"solana\" | \"bitcoin\" | \"cosmos\" | \"osmosis\" | \"aptos\" | \"sui\" | \"starknet\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 177, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chain" }, { "name": "CHAIN_VALUES", "declarationName": "CHAIN_VALUES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CHAIN_VALUES: readonly Chain[];", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 178, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chain_values" }, { "name": "chainCoinType", "declarationName": "chainCoinType", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "BIP-44 coin type for the given chain.", "tags": [], "signatures": [ { "code": "declare function chainCoinType(chain: Chain): number;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 180, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chaincointype" }, { "name": "ChainSchema", "declarationName": "ChainSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ChainSchema: z.ZodEnum<[\n \"ethereum\",\n \"polygon\",\n \"arbitrum\",\n \"optimism\",\n \"base\",\n \"solana\",\n \"bitcoin\",\n \"cosmos\",\n \"osmosis\",\n \"aptos\",\n \"sui\",\n \"starknet\"\n]>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 211, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chainschema" }, { "name": "Challenge", "declarationName": "Challenge", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A challenge issued by the verifier to an authenticating entity.", "tags": [], "signatures": [ { "code": "interface Challenge {\n challengeBytes: Uint8Array;\n timestamp: string;\n nonce: string;\n expiresAt: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 7, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "challenge" }, { "name": "ChallengeResponseProvider", "declarationName": "ChallengeResponseProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Auth provider implementing the AEGIS challenge-response protocol.\n\nValidates `signed_challenge` credentials by:\n 1. Resolving the DID via the registered DID resolver\n 2. Extracting the primary authentication public key\n 3. Reconstructing the challenge and verifying the Ed25519 signature", "tags": [], "signatures": [ { "code": "declare class ChallengeResponseProvider implements AuthProvider {\n constructor(resolver: DidResolver);\n providerName(): string;\n verifier(): ChallengeVerifier;\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 62, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "challengeresponseprovider" }, { "name": "ChallengeVerifier", "declarationName": "ChallengeVerifier", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Challenge-response verifier with in-memory nonce tracking.\n\nProduction deployments should swap the in-memory nonce set for a TTL-\nbacked cache or database via the {@link NonceStore } abstraction in\n`auth/store.ts`.", "tags": [], "signatures": [ { "code": "declare class ChallengeVerifier {\n verifyResponse(challenge: Challenge, did: string, signatureB64: string, publicKey: Uint8Array): void;\n clearNonces(): void;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 36, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "challengeverifier" }, { "name": "composeDecisions", "declarationName": "composeDecisions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function composeDecisions(decisions: readonly PolicyDecision[]): PolicyDecision;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 63, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "composedecisions" }, { "name": "concatBytes", "declarationName": "concatBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function concatBytes(...chunks: Uint8Array[]): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 9, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "concatbytes" }, { "name": "ContractInteraction", "declarationName": "ContractInteraction", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ContractInteraction {\n contractAddress: string;\n functionName: string;\n chain: string;\n gasEstimate?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 53, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "contractinteraction" }, { "name": "ContractPolicy", "declarationName": "ContractPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ContractPolicy {\n contractAllowlist: string[];\n functionAllowlist: string[];\n chainAllowlist: string[];\n gasLimit?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 47, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "contractpolicy" }, { "name": "ContractPolicyEvaluator", "declarationName": "ContractPolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class ContractPolicyEvaluator {\n static evaluate(policy: ContractPolicy, interaction: ContractInteraction): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 59, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "contractpolicyevaluator" }, { "name": "createDelegationProof", "declarationName": "createDelegationProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a delegation proof by signing the delegation with the delegator's key.\n\nSteps per spec §9.7:\n 1. Construct delegation object (excluding proof field)\n 2. Canonicalize via JCS (RFC 8785)\n 3. Sign canonical bytes with delegator's delegation key (Ed25519)", "tags": [ { "name": "param", "text": "signingKey 32-byte raw Ed25519 signing key." }, { "name": "returns", "text": "Fully formed Delegation with attached cryptographic proof." } ], "signatures": [ { "code": "declare function createDelegationProof(params: {\n delegatorDid: string;\n delegateDid: string;\n scope: DelegationScope;\n expires?: string | null;\n signingKey: Uint8Array;\n verificationMethod: string;\n}): Delegation;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 33, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "createdelegationproof" }, { "name": "CreateDidParams", "declarationName": "CreateDidParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreateDidParams {\n entityKind: string;\n namespace: string;\n identifier: string;\n metadata: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 66, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "createdidparams" }, { "name": "CreatedSessionKey", "declarationName": "CreatedSessionKey", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreatedSessionKey {\n sessionKey: SessionKey;\n ephemeralSigningKey: Uint8Array;\n ephemeralVerifyingKey: Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 58, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "createdsessionkey" }, { "name": "createSessionKey", "declarationName": "createSessionKey", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a session key (temporary, scoped, max 24h).\n\nGenerates a fresh Ed25519 keypair for the session and signs the\ngrant with the principal's identity key.", "tags": [], "signatures": [ { "code": "declare function createSessionKey(params: {\n principalDid: string;\n scope: DelegationScope;\n maxTransactions?: number | null;\n lifetimeMs: number;\n principalSigningKey: Uint8Array;\n verificationMethod: string;\n}): CreatedSessionKey;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 70, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "createsessionkey" }, { "name": "cryptoBackend", "declarationName": "cryptoBackend", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the active crypto backend. Throws if none has been registered.\n\nIn Node.js, the backend can be auto-loaded by `loadDefaultCryptoBackend`\nwhich dynamically imports `@openagentid/crypto-wasm`.", "tags": [], "signatures": [ { "code": "declare function cryptoBackend(): CryptoBackend;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 366, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "cryptobackend" }, { "name": "CryptoBackend", "declarationName": "CryptoBackend", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CryptoBackend {\n ed25519GenerateKeypair(): {\n signingKey: Uint8Array;\n verifyingKey: Uint8Array;\n };\n ed25519PublicFromPrivate(signingKey: Uint8Array): Uint8Array;\n ed25519Sign(signingKey: Uint8Array, message: Uint8Array): Uint8Array;\n ed25519Verify(verifyingKey: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;\n hkdfSha256(ikm: Uint8Array, salt: Uint8Array, info: Uint8Array, length: number): Uint8Array;\n blake3Hash(input: Uint8Array): Uint8Array;\n sha256(input: Uint8Array): Uint8Array;\n sha512(input: Uint8Array): Uint8Array;\n aes256GcmEncrypt(key: Uint8Array, nonce: Uint8Array, plaintext: Uint8Array): Uint8Array;\n aes256GcmDecrypt(key: Uint8Array, nonce: Uint8Array, ciphertext: Uint8Array): Uint8Array;\n jcsCanonicalize(value: unknown): Uint8Array;\n multibaseEncode(bytes: Uint8Array): string;\n multibaseDecode(encoded: string): Uint8Array;\n randomBytes(length: number): Uint8Array;\n frostTrustedKeygen(minSigners: number, maxSigners: number): {\n keyPackages: FrostKeyPackage[];\n publicKeyPackage: Uint8Array;\n };\n frostSignRound1(signingShare: Uint8Array): {\n nonces: Uint8Array;\n commitments: Uint8Array;\n };\n frostSignRound2(signingPackage: Uint8Array, nonces: Uint8Array, keyPackage: Uint8Array): Uint8Array;\n frostBuildSigningPackage(commitments: Map, message: Uint8Array): Uint8Array;\n frostAggregate(signingPackage: Uint8Array, signatureShares: Map, publicKeyPackage: Uint8Array): Uint8Array;\n frostVerify(publicKeyPackage: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 320, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "cryptobackend-1" }, { "name": "DEFAULT_AEGIS_CONFIG", "declarationName": "DEFAULT_AEGIS_CONFIG", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_AEGIS_CONFIG: AegisConfig;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 37, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "default_aegis_config" }, { "name": "DEFAULT_KEY_CONFIG", "declarationName": "DEFAULT_KEY_CONFIG", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_KEY_CONFIG: KeyConfig;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 36, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "default_key_config" }, { "name": "DEFAULT_PAGE_SIZE", "declarationName": "DEFAULT_PAGE_SIZE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_PAGE_SIZE = 100;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 203, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "default_page_size" }, { "name": "DEFAULT_PAGINATION", "declarationName": "DEFAULT_PAGINATION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_PAGINATION: Pagination;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 209, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "default_pagination" }, { "name": "DEFAULT_SESSION_CONFIG", "declarationName": "DEFAULT_SESSION_CONFIG", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_SESSION_CONFIG: SessionConfig;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 35, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "default_session_config" }, { "name": "DEFAULT_VERIFICATION_CONFIG", "declarationName": "DEFAULT_VERIFICATION_CONFIG", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_VERIFICATION_CONFIG: VerificationConfig;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 125, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "default_verification_config" }, { "name": "defaultAegisStores", "declarationName": "defaultAegisStores", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function defaultAegisStores(): AegisStores;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 53, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "defaultaegisstores" }, { "name": "Delegation", "declarationName": "Delegation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Delegation {\n id: string;\n delegator: string;\n delegate: string;\n scope: DelegationScope;\n created: string;\n expires?: string | null;\n revocable: boolean;\n proof: DelegationProof;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 157, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegation" }, { "name": "DelegationError", "declarationName": "DelegationError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type DelegationError = {\n kind: \"delegation/invalid_proof\";\n reason: string;\n message: string;\n} | {\n kind: \"delegation/revoked\";\n delegationId: string;\n message: string;\n} | {\n kind: \"delegation/expired\";\n delegationId: string;\n message: string;\n} | {\n kind: \"delegation/max_depth_exceeded\";\n depth: number;\n maxDepth: number;\n message: string;\n} | {\n kind: \"delegation/scope_amplification\";\n reason: string;\n message: string;\n} | {\n kind: \"delegation/delegator_not_found\";\n did: string;\n message: string;\n} | {\n kind: \"delegation/delegate_not_found\";\n did: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 184, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "delegationerror" }, { "name": "delegationErrors", "declarationName": "delegationErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const delegationErrors: {\n invalidProof: (reason: string) => DelegationError;\n revoked: (delegationId: string) => DelegationError;\n expired: (delegationId: string) => DelegationError;\n maxDepthExceeded: (depth: number, maxDepth: number) => DelegationError;\n scopeAmplification: (reason: string) => DelegationError;\n delegatorNotFound: (did: string) => DelegationError;\n delegateNotFound: (did: string) => DelegationError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 301, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "delegationerrors" }, { "name": "DelegationProof", "declarationName": "DelegationProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationProof {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 151, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationproof" }, { "name": "DelegationProofSchema", "declarationName": "DelegationProofSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DelegationProofSchema: z.ZodObject<{\n type: z.ZodLiteral<\"AegisDelegationProof2025\">;\n verificationMethod: z.ZodString;\n created: z.ZodString;\n jws: z.ZodString;\n}, \"strip\", z.ZodTypeAny, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n}, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 383, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationproofschema" }, { "name": "DelegationSchema", "declarationName": "DelegationSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DelegationSchema: z.ZodObject<{\n id: z.ZodString;\n delegator: z.ZodString;\n delegate: z.ZodString;\n scope: z.ZodObject<{\n actions: z.ZodDefault>;\n resources: z.ZodDefault>;\n chains: z.ZodDefault>;\n limits: z.ZodOptional>;\n dailyVolume: z.ZodOptional>;\n assetAllowlist: z.ZodDefault>;\n recipientAllowlist: z.ZodDefault>;\n approvalThreshold: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n }, {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n }>>>;\n temporal: z.ZodOptional>;\n validUntil: z.ZodOptional>;\n activeHours: z.ZodOptional>>;\n cooldown: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }>>>;\n }, \"strip\", z.ZodTypeAny, {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n }, {\n actions?: string[] | undefined;\n resources?: string[] | undefined;\n chains?: string[] | undefined;\n limits?: {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n }>;\n created: z.ZodString;\n expires: z.ZodOptional>;\n revocable: z.ZodBoolean;\n proof: z.ZodObject<{\n type: z.ZodLiteral<\"AegisDelegationProof2025\">;\n verificationMethod: z.ZodString;\n created: z.ZodString;\n jws: z.ZodString;\n }, \"strip\", z.ZodTypeAny, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n }, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n }>;\n}, \"strip\", z.ZodTypeAny, {\n created: string;\n id: string;\n delegator: string;\n delegate: string;\n scope: {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n };\n revocable: boolean;\n proof: {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n };\n expires?: string | null | undefined;\n}, {\n created: string;\n id: string;\n delegator: string;\n delegate: string;\n scope: {\n actions?: string[] | undefined;\n resources?: string[] | undefined;\n chains?: string[] | undefined;\n limits?: {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n };\n revocable: boolean;\n proof: {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n };\n expires?: string | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 399, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationschema" }, { "name": "DelegationScope", "declarationName": "DelegationScope", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationScope {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: SpendingLimits | null;\n temporal?: TemporalConstraints | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 144, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationscope" }, { "name": "DelegationScopeSchema", "declarationName": "DelegationScopeSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DelegationScopeSchema: z.ZodObject<{\n actions: z.ZodDefault>;\n resources: z.ZodDefault>;\n chains: z.ZodDefault>;\n limits: z.ZodOptional>;\n dailyVolume: z.ZodOptional>;\n assetAllowlist: z.ZodDefault>;\n recipientAllowlist: z.ZodDefault>;\n approvalThreshold: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n }, {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n }>>>;\n temporal: z.ZodOptional>;\n validUntil: z.ZodOptional>;\n activeHours: z.ZodOptional>>;\n cooldown: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }>>>;\n}, \"strip\", z.ZodTypeAny, {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n}, {\n actions?: string[] | undefined;\n resources?: string[] | undefined;\n chains?: string[] | undefined;\n limits?: {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 281, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationscopeschema" }, { "name": "DelegationStore", "declarationName": "DelegationStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationStore {\n storeDelegation(delegation: Delegation): Promise;\n getDelegation(id: string): Promise;\n listByDelegator(delegatorDid: string, pagination?: Pagination): Promise;\n listByDelegate(delegateDid: string, pagination?: Pagination): Promise;\n deleteDelegation(id: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 33, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "delegationstore" }, { "name": "DelegationTree", "declarationName": "DelegationTree", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class DelegationTree {\n readonly maxDepth: number;\n constructor(maxDepth?: number);\n addDelegation(delegation: Delegation): void;\n getDelegationChain(delegateDid: string): Delegation[];\n effectiveScope(delegateDid: string): DelegationScope | null;\n depth(delegateDid: string): number;\n revoke(delegationId: string): string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 3, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "delegationtree" }, { "name": "derivationPath", "declarationName": "derivationPath", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a BIP-44 derivation path for a given blockchain chain.\n\nReturns the standard `m/44'/coin_type'/account'/0/index` path\nused for HD key derivation across most chains.", "tags": [], "signatures": [ { "code": "declare function derivationPath(chain: Chain, account: number, index: number): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 26, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "derivationpath" }, { "name": "derivationStandard", "declarationName": "derivationStandard", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the derivation standard name for the given chain.", "tags": [], "signatures": [ { "code": "declare function derivationStandard(chain: Chain): \"BIP-44\" | \"SLIP-0010\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 182, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "derivationstandard" }, { "name": "deriveLineageKey", "declarationName": "deriveLineageKey", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derive a lineage key from a parent private key using HKDF-SHA256.\n\nAlgorithm:\n HKDF-SHA256(\n IKM = parent_private_key (32 bytes),\n Salt = child_did_utf8,\n Info = \"oas-lineage-v1\" || generation_be32,\n L = 32\n )", "tags": [ { "name": "returns", "text": "32 bytes of derived key material suitable for an Ed25519 signing key." } ], "signatures": [ { "code": "declare function deriveLineageKey(parentPrivate: Uint8Array, childDid: string, generation: number): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 19, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "derivelineagekey" }, { "name": "DidCreationResult", "declarationName": "DidCreationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DidCreationResult {\n did: string;\n document: OasDocument;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 72, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didcreationresult" }, { "name": "DidResolver", "declarationName": "DidResolver", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "DID Resolver plugin interface (§4.1).\n\nEnables AEGIS to resolve any DID method without coupling to a specific\nresolution mechanism. Each resolver handles one or more DID methods.\n\nImplementations MUST resolve within 5 seconds.", "tags": [], "signatures": [ { "code": "interface DidResolver {\n resolve(did: string): Promise;\n handles(did: string): boolean;\n supportedMethods(): readonly string[];\n create?(params: CreateDidParams): Promise;\n update?(did: string, document: OasDocument): Promise;\n deactivate?(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 84, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didresolver" }, { "name": "DirectSigner", "declarationName": "DirectSigner", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Direct signing backend using a single Ed25519 key.\n\nThe signing key is stored in memory; callers should treat the instance\nas sensitive material and zeroize when done.", "tags": [], "signatures": [ { "code": "declare class DirectSigner implements SigningBackend {\n constructor(signingKey: Uint8Array);\n sign(request: SigningRequest): Promise;\n publicKey(): Uint8Array;\n mode(): SigningMode;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 24, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "directsigner" }, { "name": "DocumentMetadata", "declarationName": "DocumentMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentMetadata {\n created: string;\n updated?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 25, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentmetadata" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws?: string;\n proofValue?: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 29, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentproof" }, { "name": "EncryptedKey", "declarationName": "EncryptedKey", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An encrypted private key blob.\n\nUses AES-256-GCM with a random 96-bit nonce. The ciphertext contains\nthe 32-byte Ed25519 signing key material plus a 16-byte authentication tag.", "tags": [], "signatures": [ { "code": "declare class EncryptedKey {\n readonly ciphertext: Uint8Array;\n readonly nonce: Uint8Array;\n static encrypt(signingKeyBytes: Uint8Array, encryptionKey: Uint8Array): EncryptedKey;\n decrypt(encryptionKey: Uint8Array): Uint8Array;\n static fromParts(ciphertext: Uint8Array, nonce: Uint8Array): EncryptedKey;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 9, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "encryptedkey" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type EntityKind = \"hmr\" | \"mhr\" | \"enr\" | \"ao\" | \"agent\" | \"agent:instance\" | \"tool\" | \"skill\" | \"workflow\" | \"model\" | \"dataset\" | \"service\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 4, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "entitykind" }, { "name": "FrostCeremony", "declarationName": "FrostCeremony", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "State of a distributed FROST signing ceremony, suitable for orchestrating\nthe protocol across multiple machines/processes. Each participant calls\nthe methods in order:\n\n 1. `addCommitment(id, commitments)` — gather round 1 outputs\n 2. `buildSigningPackage(message)` — build signing package once all\n participants have committed\n 3. `addSignatureShare(id, share)` — gather round 2 outputs\n 4. `aggregate()` — produce the final aggregated signature\n\nThe ceremony does NOT hold any participant key material — those remain\non the participant's own machine.", "tags": [], "signatures": [ { "code": "declare class FrostCeremony {\n constructor(publicKeyPackage: Uint8Array, threshold: number);\n addCommitment(id: number, commitments: Uint8Array): void;\n hasEnoughCommitments(): boolean;\n buildSigningPackage(message: Uint8Array): Uint8Array;\n addSignatureShare(id: number, share: Uint8Array): void;\n hasEnoughShares(): boolean;\n aggregate(): Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 123, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "frostceremony" }, { "name": "FrostKeyPackage", "declarationName": "FrostKeyPackage", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface FrostKeyPackage {\n identifier: number;\n bytes: Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 351, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "frostkeypackage" }, { "name": "generateChallenge", "declarationName": "generateChallenge", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generate a new random challenge.", "tags": [], "signatures": [ { "code": "declare function generateChallenge(): Challenge;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 18, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "generatechallenge" }, { "name": "generateShares", "declarationName": "generateShares", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generate threshold key shares using FROST trusted dealer.\n\nCreates a `t-of-n` setup: any `minSigners` of `maxSigners` participants\nmay cooperate to produce a valid signature. The dealer is trusted to\ndestroy its copy of the master secret after distribution.", "tags": [], "signatures": [ { "code": "declare function generateShares(minSigners: number, maxSigners: number): ThresholdKeyPackages;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 92, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "generateshares" }, { "name": "Guardian", "declarationName": "Guardian", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Guardian {\n guardianType: GuardianType;\n identifier: string;\n weight: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 192, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "guardian" }, { "name": "GuardianAuthorization", "declarationName": "GuardianAuthorization", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface GuardianAuthorization {\n guardian: Guardian;\n authorizedAt: string;\n signature: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 51, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "guardianauthorization" }, { "name": "GuardianType", "declarationName": "GuardianType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type GuardianType = \"identity\" | \"email\" | \"phone\" | \"hardware\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 191, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "guardiantype" }, { "name": "hexDecode", "declarationName": "hexDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function hexDecode(input: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 6, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "hexdecode" }, { "name": "hexEncode", "declarationName": "hexEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function hexEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 5, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "hexencode" }, { "name": "IdentityType", "declarationName": "IdentityType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The type of entity being authenticated.", "tags": [], "signatures": [ { "code": "type IdentityType = \"human\" | \"agent\" | \"organization\" | \"enterprise\" | \"delegated\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 4, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "identitytype" }, { "name": "IdentityTypeSchema", "declarationName": "IdentityTypeSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const IdentityTypeSchema: z.ZodEnum<[\n \"human\",\n \"agent\",\n \"organization\",\n \"enterprise\",\n \"delegated\"\n]>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 210, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "identitytypeschema" }, { "name": "inferIdentityTypeFromDid", "declarationName": "inferIdentityTypeFromDid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Infer the IdentityType from a `did:oas:::` string.\n\nReturns \"agent\" if the DID cannot be parsed.", "tags": [], "signatures": [ { "code": "declare function inferIdentityTypeFromDid(did: string): \"human\" | \"organization\" | \"enterprise\" | \"agent\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 64, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "inferidentitytypefromdid" }, { "name": "InMemoryDelegationStore", "declarationName": "InMemoryDelegationStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryDelegationStore implements DelegationStore {\n storeDelegation(delegation: Delegation): Promise;\n getDelegation(id: string): Promise;\n listByDelegator(delegatorDid: string, pagination?: Pagination): Promise;\n listByDelegate(delegateDid: string, pagination?: Pagination): Promise;\n deleteDelegation(id: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 40, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "inmemorydelegationstore" }, { "name": "InMemoryKeyStore", "declarationName": "InMemoryKeyStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryKeyStore implements KeyStore {\n size(): number;\n isEmpty(): boolean;\n store(key: ManagedKey): Promise;\n load(keyId: string): Promise;\n delete(keyId: string): Promise;\n list(role: KeyRole | null, pagination?: Pagination): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 63, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "inmemorykeystore" }, { "name": "InMemoryNonceStore", "declarationName": "InMemoryNonceStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryNonceStore implements NonceStore {\n recordNonce(nonce: string): Promise;\n hasNonce(nonce: string): Promise;\n cleanup(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 48, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "inmemorynoncestore" }, { "name": "InMemoryRevocationStore", "declarationName": "InMemoryRevocationStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryRevocationStore implements RevocationStore {\n revoke(delegationId: string): Promise;\n isRevoked(delegationId: string): Promise;\n revokeBatch(ids: readonly string[]): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 53, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "inmemoryrevocationstore" }, { "name": "InMemorySessionStore", "declarationName": "InMemorySessionStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemorySessionStore implements SessionStore {\n storeSession(session: Session): Promise;\n getSession(sessionId: string): Promise;\n deleteSession(sessionId: string): Promise;\n listByDid(did: string, pagination?: Pagination): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 34, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "inmemorysessionstore" }, { "name": "InMemoryVerificationCacheStore", "declarationName": "InMemoryVerificationCacheStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryVerificationCacheStore implements VerificationCacheStore {\n constructor(ttlSecs: number);\n ttlSecs(): number;\n getCached(did: string): Promise;\n storeCached(did: string, result: VerificationResult): Promise;\n invalidate(did: string): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 54, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "inmemoryverificationcachestore" }, { "name": "intersectScopes", "declarationName": "intersectScopes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compute the intersection of two scopes.\n\n- Empty list = wildcard, take the other side\n- Otherwise, set intersection\n- For limits, take the most restrictive value", "tags": [], "signatures": [ { "code": "declare function intersectScopes(a: DelegationScope, b: DelegationScope): DelegationScope;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 19, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "intersectscopes" }, { "name": "isRotationEligible", "declarationName": "isRotationEligible", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Convenience function: returns true if the role is eligible for standard\nrotation. Session and Recovery keys are excluded.", "tags": [], "signatures": [ { "code": "declare function isRotationEligible(role: KeyRole): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 49, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "isrotationeligible" }, { "name": "isScopeSubset", "declarationName": "isScopeSubset", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if `child` scope is a subset of `parent` scope.\n\nEmpty fields on `parent` mean \"wildcard\" — they accept any child value.\nLimits on `child` must be at least as restrictive as the parent's.", "tags": [], "signatures": [ { "code": "declare function isScopeSubset(child: DelegationScope, parent: DelegationScope): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 11, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "isscopesubset" }, { "name": "KeyConfig", "declarationName": "KeyConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface KeyConfig {\n encryptionAlgorithm: string;\n zeroizeOnDrop: boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 25, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "keyconfig" }, { "name": "KeyError", "declarationName": "KeyError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyError = {\n kind: \"key/generation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/derivation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/rotation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/recovery_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/mpc_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/not_found\";\n keyId: string;\n message: string;\n} | {\n kind: \"key/storage_error\";\n reason: string;\n message: string;\n} | {\n kind: \"key/signing_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/unsupported_type\";\n keyType: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 147, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "keyerror" }, { "name": "keyErrors", "declarationName": "keyErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const keyErrors: {\n generationFailed: (reason: string) => KeyError;\n derivationFailed: (reason: string) => KeyError;\n rotationFailed: (reason: string) => KeyError;\n recoveryFailed: (reason: string) => KeyError;\n mpcFailed: (reason: string) => KeyError;\n notFound: (keyId: string) => KeyError;\n storageError: (reason: string) => KeyError;\n signingFailed: (reason: string) => KeyError;\n unsupportedKeyType: (keyType: string) => KeyError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 290, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "keyerrors" }, { "name": "KeyGenerationMode", "declarationName": "KeyGenerationMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyGenerationMode = \"direct\" | \"mpc\" | \"tee\" | \"hsm\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 186, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keygenerationmode" }, { "name": "KeyGenerator", "declarationName": "KeyGenerator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Key generator supporting multiple generation modes (§6.2).\n\nCurrently implements `direct` generation via the WASM backend's CSPRNG.\nMPC, TEE, and HSM modes are stubs that throw an unsupported error.", "tags": [], "signatures": [ { "code": "declare class KeyGenerator {\n static generateDirect(role: KeyRole, encryptionKey: Uint8Array): ManagedKey;\n static generateKeyId(): string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 51, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "keygenerator" }, { "name": "KeyRole", "declarationName": "KeyRole", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyRole = \"identity\" | \"authentication\" | \"assertion\" | \"delegation\" | \"session\" | \"recovery\" | \"chain\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 185, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keyrole" }, { "name": "KeyRoleSchema", "declarationName": "KeyRoleSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const KeyRoleSchema: z.ZodEnum<[\n \"identity\",\n \"authentication\",\n \"assertion\",\n \"delegation\",\n \"session\",\n \"recovery\",\n \"chain\"\n]>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 212, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keyroleschema" }, { "name": "KeyRotation", "declarationName": "KeyRotation", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class KeyRotation {\n static initiate(old: ManagedKey, encryptionKey: Uint8Array): RotationResult;\n static initiateWithGrace(old: ManagedKey, encryptionKey: Uint8Array, gracePeriodMs: number): RotationResult;\n static isGracePeriodExpired(result: RotationResult): boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 39, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "keyrotation" }, { "name": "KeyStore", "declarationName": "KeyStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface KeyStore {\n store(key: ManagedKey): Promise;\n load(keyId: string): Promise;\n delete(keyId: string): Promise;\n list(role: KeyRole | null, pagination?: Pagination): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 57, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "keystore" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LifecycleStatus = \"active\" | \"suspended\" | \"terminated\" | \"deprecated\" | \"draft\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 3, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lifecyclestatus" }, { "name": "LineagePolicy", "declarationName": "LineagePolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LineagePolicy {\n minConformanceLevel?: number | null;\n maxLineageDepth?: number | null;\n requiredHumanRootLiveness?: number | null;\n requiredAttestations: string[];\n bannedHumanRoots: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 35, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "lineagepolicy" }, { "name": "LineagePolicyEvaluator", "declarationName": "LineagePolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class LineagePolicyEvaluator {\n static evaluate(policy: LineagePolicy, verification: VerificationResult): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 43, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "lineagepolicyevaluator" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Optional lineage section for non-root entities.", "tags": [], "signatures": [ { "code": "interface LineageSection {\n parent: string;\n generation: number;\n humanRootChain: string[];\n proof?: AgentLineageProof | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 13, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lineagesection" }, { "name": "LineageSummary", "declarationName": "LineageSummary", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LineageSummary {\n depth: number;\n humanRoot: string;\n verified: boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 69, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "lineagesummary" }, { "name": "LivenessStatus", "declarationName": "LivenessStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LivenessStatus = \"active\" | \"warning\" | \"stale\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 104, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "livenessstatus" }, { "name": "loadDefaultCryptoBackend", "declarationName": "loadDefaultCryptoBackend", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Attempts to load `@openagentid/crypto-wasm` lazily. Falls back to a\nstub error backend if the module isn't available — callers should\nrely on this for one-time setup in tests/examples.", "tags": [], "signatures": [ { "code": "declare function loadDefaultCryptoBackend(): Promise;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 372, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "loaddefaultcryptobackend" }, { "name": "makePagination", "declarationName": "makePagination", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function makePagination(limit: number, offset: number): Pagination;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 208, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "makepagination" }, { "name": "makeTransaction", "declarationName": "makeTransaction", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function makeTransaction(params: {\n fromDid: string;\n to: string;\n chain: string;\n data: Uint8Array;\n value?: string | null;\n}): Transaction;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 43, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "maketransaction" }, { "name": "ManagedKey", "declarationName": "ManagedKey", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A managed key with metadata. The private key is stored encrypted; access\nto the raw signing key requires presenting the encryption key.", "tags": [], "signatures": [ { "code": "declare class ManagedKey {\n readonly keyId: string;\n readonly role: KeyRole;\n readonly generationMode: KeyGenerationMode;\n readonly publicKey: Uint8Array;\n readonly encryptedPrivate: EncryptedKey;\n readonly createdAt: string;\n constructor(params: {\n keyId: string;\n role: KeyRole;\n generationMode: KeyGenerationMode;\n publicKey: Uint8Array;\n encryptedPrivate: EncryptedKey;\n createdAt: string;\n });\n publicKeyMultibase(): string;\n decryptPrivate(encryptionKey: Uint8Array): Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 24, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "managedkey" }, { "name": "MAX_PAGE_SIZE", "declarationName": "MAX_PAGE_SIZE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const MAX_PAGE_SIZE = 1000;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 202, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "max_page_size" }, { "name": "NonceStore", "declarationName": "NonceStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface NonceStore {\n recordNonce(nonce: string): Promise;\n hasNonce(nonce: string): Promise;\n cleanup(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 42, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "noncestore" }, { "name": "oasDocument", "declarationName": "oasDocument", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Helpers for inspecting OAS documents without coupling to a specific SDK.", "tags": [], "signatures": [ { "code": "declare const oasDocument: {\n isRoot(doc: OasDocument): boolean;\n isRevoked(doc: OasDocument): boolean;\n primaryPublicKeyMultibase(doc: OasDocument): string | null;\n findVerificationMethod(doc: OasDocument, id: string): VerificationMethod | null;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 53, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "oasdocument" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal OAS Identity Document interface.", "tags": [], "signatures": [ { "code": "interface OasDocument {\n id: string;\n oasVersion: string;\n kind: string;\n verificationMethod: VerificationMethod[];\n authentication?: string[];\n assertionMethod?: string[];\n delegationMethod?: string[];\n metadata: DocumentMetadata;\n lineage?: LineageSection | null;\n lifecycleStatus?: LifecycleStatus | null;\n revoked?: boolean;\n proof?: DocumentProof | null;\n [key: string]: unknown;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 37, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "oasdocument-1" }, { "name": "Obligation", "declarationName": "Obligation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Obligation {\n obligationType: ObligationType;\n params: Record;\n deadline?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 81, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligation" }, { "name": "ObligationType", "declarationName": "ObligationType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ObligationType = \"log\" | \"notify\" | \"approve\" | \"escrow\" | \"limit\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 80, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligationtype" }, { "name": "Pagination", "declarationName": "Pagination", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Pagination {\n limit: number;\n offset: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 204, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "pagination" }, { "name": "parseAmount", "declarationName": "parseAmount", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse a decimal amount string. Throws PolicyError on invalid input.", "tags": [], "signatures": [ { "code": "declare function parseAmount(s: string): number;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 22, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "parseamount" }, { "name": "parseIso8601DurationMs", "declarationName": "parseIso8601DurationMs", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse a simplified ISO 8601 duration into milliseconds.\n\nSupports `PT{n}S`, `PT{n}M`, `PT{n}H`, and `P{n}D`. Falls back to 24 hours\nfor unrecognized formats.", "tags": [], "signatures": [ { "code": "declare function parseIso8601DurationMs(input: string): number;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 76, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "parseiso8601durationms" }, { "name": "PermissionCheck", "declarationName": "PermissionCheck", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PermissionCheck {\n principal: string;\n permission: string;\n resource?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 98, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "permissioncheck" }, { "name": "PluginRegistry", "declarationName": "PluginRegistry", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The Plugin Registry manages all loaded plugins and routes requests\nto the appropriate plugin (AEGIS Spec §4.4).\n\n- Multiple DID Resolvers (routed by `handles()` matching)\n- Multiple Auth Providers (keyed by `providerName()`)\n- Exactly one Policy Engine\n\nPlugin registration order is deterministic. Resolvers are tried in\nregistration order; the first whose `handles()` returns true is used.", "tags": [], "signatures": [ { "code": "declare class PluginRegistry {\n registerResolver(resolver: DidResolver): void;\n registerAuthProvider(provider: AuthProvider): void;\n setPolicyEngine(engine: PolicyEngine): void;\n resolverCount(): number;\n authProviderCount(): number;\n hasPolicyEngine(): boolean;\n getResolverFor(did: string): DidResolver | null;\n getAuthProvider(name: string): AuthProvider | null;\n getPolicyEngine(): PolicyEngine | null;\n resolveDid(did: string): Promise;\n validateCredential(credential: AuthCredential, providerName?: string | null): Promise;\n evaluatePolicy(request: PolicyRequest): Promise;\n checkPermission(check: PermissionCheck): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 116, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "pluginregistry" }, { "name": "PolicyContext", "declarationName": "PolicyContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyContext {\n authContext?: AuthContext | null;\n lineage?: LineageSummary | null;\n conformanceLevel?: number | null;\n session?: Session | null;\n extra: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 62, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policycontext" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n allowed: boolean;\n reason?: string | null;\n obligations: Obligation[];\n auditInfo: AuditInfo;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 92, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policydecision" }, { "name": "PolicyEngine", "declarationName": "PolicyEngine", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyEngine {\n evaluate(request: PolicyRequest): Promise;\n checkPermission(check: PermissionCheck): Promise;\n engineName(): string;\n getPolicies?(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 99, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "policyengine" }, { "name": "PolicyError", "declarationName": "PolicyError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyError = {\n kind: \"policy/evaluation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"policy/timeout\";\n timeoutMs: number;\n message: string;\n} | {\n kind: \"policy/engine_unavailable\";\n message: string;\n} | {\n kind: \"policy/no_engine\";\n message: string;\n} | {\n kind: \"policy/config_error\";\n reason: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 75, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "policyerror" }, { "name": "policyErrors", "declarationName": "policyErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const policyErrors: {\n evaluationFailed: (reason: string) => PolicyError;\n timeout: (timeoutMs: number) => PolicyError;\n engineUnavailable: () => PolicyError;\n noEngine: () => PolicyError;\n configError: (reason: string) => PolicyError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 272, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "policyerrors" }, { "name": "PolicyRequest", "declarationName": "PolicyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRequest {\n principal: string;\n action: string;\n resource: string;\n context: PolicyContext;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 74, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policyrequest" }, { "name": "RecoveryCeremony", "declarationName": "RecoveryCeremony", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class RecoveryCeremony {\n readonly ceremonyId: string;\n readonly config: RecoveryConfig;\n readonly authorizations: GuardianAuthorization[];\n readonly initiatedAt: string;\n readonly timelockUntil: string;\n constructor(config: RecoveryConfig);\n addAuthorization(auth: GuardianAuthorization): void;\n isThresholdMet(): boolean;\n isTimelockExpired(): boolean;\n canExecute(): boolean;\n accumulatedWeight(): number;\n authorizationCount(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 56, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "recoveryceremony" }, { "name": "RecoveryConfig", "declarationName": "RecoveryConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RecoveryConfig {\n guardians: Guardian[];\n threshold: number;\n timelock: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 197, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "recoveryconfig" }, { "name": "ResolverError", "declarationName": "ResolverError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ResolverError = {\n kind: \"resolver/not_found\";\n did: string;\n message: string;\n} | {\n kind: \"resolver/invalid_format\";\n reason: string;\n message: string;\n} | {\n kind: \"resolver/timeout\";\n did: string;\n timeoutMs: number;\n message: string;\n} | {\n kind: \"resolver/deactivated\";\n did: string;\n message: string;\n} | {\n kind: \"resolver/network\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"resolver/creation_not_supported\";\n message: string;\n} | {\n kind: \"resolver/update_not_supported\";\n message: string;\n} | {\n kind: \"resolver/deactivation_not_supported\";\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 6, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "resolvererror" }, { "name": "resolverErrors", "declarationName": "resolverErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const resolverErrors: {\n notFound: (did: string) => ResolverError;\n invalidFormat: (reason: string) => ResolverError;\n timeout: (did: string, timeoutMs: number) => ResolverError;\n deactivated: (did: string) => ResolverError;\n network: (did: string, reason: string) => ResolverError;\n creationNotSupported: () => ResolverError;\n updateNotSupported: () => ResolverError;\n deactivationNotSupported: () => ResolverError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 251, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "resolvererrors" }, { "name": "RevocationRegistry", "declarationName": "RevocationRegistry", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class RevocationRegistry {\n revoke(delegationId: string): void;\n isRevoked(delegationId: string): boolean;\n revokeCascade(ids: readonly string[]): void;\n size(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 49, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "revocationregistry" }, { "name": "RevocationStatus", "declarationName": "RevocationStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevocationStatus = \"active\" | \"revoked\" | \"suspended\" | \"expired\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 103, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "revocationstatus" }, { "name": "RevocationStore", "declarationName": "RevocationStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RevocationStore {\n revoke(delegationId: string): Promise;\n isRevoked(delegationId: string): Promise;\n revokeBatch(ids: readonly string[]): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 48, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "revocationstore" }, { "name": "RotationRequest", "declarationName": "RotationRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RotationRequest {\n keyId: string;\n gracePeriodMs: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 28, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "rotationrequest" }, { "name": "RotationResult", "declarationName": "RotationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RotationResult {\n oldKeyId: string;\n newKey: ManagedKey;\n gracePeriodEnds: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 33, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "rotationresult" }, { "name": "Session", "declarationName": "Session", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Session token structure (AEGIS Spec §7.4).", "tags": [], "signatures": [ { "code": "interface Session {\n sessionId: string;\n did: string;\n provider: string;\n createdAt: string;\n expiresAt: string;\n scope: string[];\n deviceBinding?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 53, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "session" }, { "name": "SessionConfig", "declarationName": "SessionConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionConfig {\n humanLifetimeSecs: number;\n agentLifetimeSecs: number;\n sessionKeyMaxSecs: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 17, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "sessionconfig" }, { "name": "SessionKey", "declarationName": "SessionKey", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionKey {\n sessionKey: string;\n principal: string;\n scope: DelegationScope;\n maxTransactions?: number | null;\n created: string;\n expires: string;\n proof: DelegationProof;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 167, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "sessionkey" }, { "name": "SessionManager", "declarationName": "SessionManager", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class SessionManager {\n readonly humanLifetimeMs: number;\n readonly agentLifetimeMs: number;\n constructor(opts?: SessionManagerOptions);\n createSession(params: {\n did: string;\n provider: string;\n scope?: string[];\n isAgent: boolean;\n deviceBinding?: string | null;\n }): Session;\n getSession(sessionId: string): Session;\n revokeSession(sessionId: string): void;\n isValid(sessionId: string): boolean;\n cleanupExpired(): number;\n sessionCount(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 7, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "sessionmanager" }, { "name": "SessionManagerOptions", "declarationName": "SessionManagerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionManagerOptions {\n humanLifetimeMs?: number;\n agentLifetimeMs?: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 3, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "sessionmanageroptions" }, { "name": "SessionStore", "declarationName": "SessionStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionStore {\n storeSession(session: Session): Promise;\n getSession(sessionId: string): Promise;\n deleteSession(sessionId: string): Promise;\n listByDid(did: string, pagination?: Pagination): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 27, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "sessionstore" }, { "name": "setCryptoBackend", "declarationName": "setCryptoBackend", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Inject a custom crypto backend implementation. Call this once at SDK\ninitialization (typically with the `@openagentid/crypto-wasm` exports).", "tags": [], "signatures": [ { "code": "declare function setCryptoBackend(impl: CryptoBackend): void;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 359, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "setcryptobackend" }, { "name": "SigningBackend", "declarationName": "SigningBackend", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SigningBackend {\n sign(request: SigningRequest): Promise;\n publicKey(): Uint8Array;\n mode(): SigningMode;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 13, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "signingbackend" }, { "name": "SigningMode", "declarationName": "SigningMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SigningMode = \"direct\" | \"mpc\" | \"tee\" | \"external\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 183, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "signingmode" }, { "name": "SigningRequest", "declarationName": "SigningRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SigningRequest {\n message: Uint8Array;\n signerDid: string;\n chain?: Chain | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 3, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "signingrequest" }, { "name": "SigningResult", "declarationName": "SigningResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SigningResult {\n signature: Uint8Array;\n publicKey: Uint8Array;\n mode: SigningMode;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 8, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "signingresult" }, { "name": "signWithThreshold", "declarationName": "signWithThreshold", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Run a complete FROST signing round in a single process.\n\nIn production, each participant would perform round1 and round2\nindependently. This helper executes the full 2-round protocol locally\nfor testing, validation, and single-process orchestration scenarios.", "tags": [ { "name": "param", "text": "message The bytes to sign." }, { "name": "param", "text": "keyPackages Map from FROST identifier to key package bytes\n(must contain at least `t` packages)." }, { "name": "param", "text": "publicKeyPackage The group public key package." }, { "name": "returns", "text": "The aggregated FROST signature (64 bytes)." } ], "signatures": [ { "code": "declare function signWithThreshold(message: Uint8Array, keyPackages: Map, publicKeyPackage: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 106, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "signwiththreshold" }, { "name": "SpendingLimits", "declarationName": "SpendingLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SpendingLimits {\n maxAmount?: string | null;\n dailyVolume?: string | null;\n assetAllowlist: string[];\n recipientAllowlist: string[];\n approvalThreshold?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 137, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "spendinglimits" }, { "name": "SpendingLimitsSchema", "declarationName": "SpendingLimitsSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SpendingLimitsSchema: z.ZodObject<{\n maxAmount: z.ZodOptional>;\n dailyVolume: z.ZodOptional>;\n assetAllowlist: z.ZodDefault>;\n recipientAllowlist: z.ZodDefault>;\n approvalThreshold: z.ZodOptional>;\n}, \"strip\", z.ZodTypeAny, {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n}, {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 213, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "spendinglimitsschema" }, { "name": "SpendingPolicyEvaluator", "declarationName": "SpendingPolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class SpendingPolicyEvaluator {\n static evaluate(limits: SpendingLimits, tx: TransactionInfo, dailySpent: string): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 10, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "spendingpolicyevaluator" }, { "name": "StorageBackend", "declarationName": "StorageBackend", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Storage backend selection.", "tags": [], "signatures": [ { "code": "type StorageBackend = {\n type: \"in_memory\";\n} | {\n type: \"postgres\";\n url: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/sdk/index.d.ts", "line": 11, "sha256": "9a4ae3e114704cf626d3855e07c72ef250cb5b8c056550cf8b9f9cf4f90b03d8" } } ], "anchor": "storagebackend" }, { "name": "TemporalConstraints", "declarationName": "TemporalConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TemporalConstraints {\n validFrom?: string | null;\n validUntil?: string | null;\n activeHours?: ActiveHours | null;\n cooldown?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 131, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "temporalconstraints" }, { "name": "TemporalConstraintsSchema", "declarationName": "TemporalConstraintsSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const TemporalConstraintsSchema: z.ZodObject<{\n validFrom: z.ZodOptional>;\n validUntil: z.ZodOptional>;\n activeHours: z.ZodOptional>>;\n cooldown: z.ZodOptional>;\n}, \"strip\", z.ZodTypeAny, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n}, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 245, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "temporalconstraintsschema" }, { "name": "TemporalPolicyEvaluator", "declarationName": "TemporalPolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class TemporalPolicyEvaluator {\n static evaluate(constraints: TemporalConstraints, now?: Date): PolicyDecision;\n static evaluateWithCooldown(constraints: TemporalConstraints, now: Date, lastOperation: Date | null): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 24, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "temporalpolicyevaluator" }, { "name": "ThresholdConfig", "declarationName": "ThresholdConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ThresholdConfig {\n threshold: number;\n totalShares: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 187, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "thresholdconfig" }, { "name": "ThresholdKeyPackages", "declarationName": "ThresholdKeyPackages", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of FROST trusted-dealer key generation.", "tags": [], "signatures": [ { "code": "interface ThresholdKeyPackages {\n keyPackages: Map;\n publicKeyPackage: Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 79, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "thresholdkeypackages" }, { "name": "Transaction", "declarationName": "Transaction", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Transaction {\n txId: string;\n fromDid: string;\n to: string;\n chain: string;\n data: Uint8Array;\n value?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 35, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "transaction" }, { "name": "TransactionInfo", "declarationName": "TransactionInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TransactionInfo {\n asset: string;\n amount: string;\n recipient: string;\n chain: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 4, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "transactioninfo" }, { "name": "TransactionPipeline", "declarationName": "TransactionPipeline", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Full transaction authorization pipeline per AEGIS Spec §10.4.\n\nEnforces a strict 5-step process; if any step fails the transaction\nis NOT signed.", "tags": [], "signatures": [ { "code": "declare class TransactionPipeline {\n constructor(signer: SigningBackend);\n authorizeAndSign(tx: Transaction, auth: AuthContext, policyDecision: PolicyDecision): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 61, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "transactionpipeline" }, { "name": "u32BeBytes", "declarationName": "u32BeBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "big-endian u32 → 4 bytes", "tags": [], "signatures": [ { "code": "declare function u32BeBytes(n: number): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 11, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "u32bebytes" }, { "name": "utf8Decode", "declarationName": "utf8Decode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function utf8Decode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 8, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "utf8decode" }, { "name": "utf8Encode", "declarationName": "utf8Encode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function utf8Encode(s: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 7, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "utf8encode" }, { "name": "validateScope", "declarationName": "validateScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function validateScope(scope: DelegationScope): void;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 20, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "validatescope" }, { "name": "VerificationCache", "declarationName": "VerificationCache", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class VerificationCache {\n constructor(ttlSecs: number);\n ttl(): number;\n size(): number;\n isEmpty(): boolean;\n get(did: string): VerificationResult | null;\n insert(did: string, result: VerificationResult): void;\n invalidate(did: string): void;\n clear(): void;\n cleanupExpired(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 4, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "verificationcache" }, { "name": "VerificationCacheStore", "declarationName": "VerificationCacheStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationCacheStore {\n getCached(did: string): Promise;\n storeCached(did: string, result: VerificationResult): Promise;\n invalidate(did: string): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 48, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "verificationcachestore" }, { "name": "VerificationConfig", "declarationName": "VerificationConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationConfig {\n maxLineageDepth: number;\n perHopTimeoutSecs: number;\n totalTimeoutSecs: number;\n cacheTtlSecs: number;\n livenessPeriodDays: number;\n conformanceLevel: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 117, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "verificationconfig" }, { "name": "VerificationError", "declarationName": "VerificationError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerificationError = {\n kind: \"verify/resolution_failed\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"verify/invalid_schema\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"verify/invalid_signature\";\n did: string;\n message: string;\n} | {\n kind: \"verify/lineage_failed\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"verify/max_depth_exceeded\";\n did: string;\n depth: number;\n maxDepth: number;\n message: string;\n} | {\n kind: \"verify/revoked\";\n did: string;\n message: string;\n} | {\n kind: \"verify/suspended\";\n did: string;\n message: string;\n} | {\n kind: \"verify/human_root_revoked\";\n humanRoot: string;\n message: string;\n} | {\n kind: \"verify/generation_mismatch\";\n did: string;\n expected: number;\n found: number;\n message: string;\n} | {\n kind: \"verify/timeout\";\n did: string;\n message: string;\n} | {\n kind: \"verify/consistency_violation\";\n did: string;\n reason: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 94, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "verificationerror" }, { "name": "verificationErrors", "declarationName": "verificationErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const verificationErrors: {\n resolutionFailed: (did: string, reason: string) => VerificationError;\n invalidSchema: (did: string, reason: string) => VerificationError;\n invalidSignature: (did: string) => VerificationError;\n lineageFailed: (did: string, reason: string) => VerificationError;\n maxDepthExceeded: (did: string, depth: number, maxDepth: number) => VerificationError;\n revoked: (did: string) => VerificationError;\n suspended: (did: string) => VerificationError;\n humanRootRevoked: (humanRoot: string) => VerificationError;\n timeout: (did: string) => VerificationError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 279, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "verificationerrors" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Verification method per W3C DID-Core.", "tags": [], "signatures": [ { "code": "interface VerificationMethod {\n id: string;\n type: string;\n controller: string;\n publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 6, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "verificationmethod" }, { "name": "VerificationPipeline", "declarationName": "VerificationPipeline", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The AEGIS Verification Pipeline.\n\nPerforms complete verification of OAS identity documents per AEGIS\nSpecification §5. Results are cached with a configurable TTL (max\n300 seconds per spec).", "tags": [], "signatures": [ { "code": "declare class VerificationPipeline {\n constructor(registry: PluginRegistry, config?: VerificationConfig);\n cache(): VerificationCache;\n verify(did: string): Promise;\n verifyForceRefresh(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 26, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "verificationpipeline" }, { "name": "VerificationResult", "declarationName": "VerificationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationResult {\n did: string;\n signatureValid: boolean;\n lineageValid: boolean;\n lineageDepth: number;\n humanRoot?: string | null;\n revocationStatus: RevocationStatus;\n livenessStatus: LivenessStatus;\n conformanceLevel: number;\n warnings: string[];\n verifiedAt: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 105, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "verificationresult" }, { "name": "verifyDelegationProof", "declarationName": "verifyDelegationProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify a delegation proof against the delegator's public key.\n\nReconstructs the canonical form of the delegation (without the proof),\nthen verifies the Ed25519 signature in the proof's JWS field.", "tags": [], "signatures": [ { "code": "declare function verifyDelegationProof(delegation: Delegation, delegatorPublicKey: Uint8Array): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 47, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "verifydelegationproof" }, { "name": "verifySignature", "declarationName": "verifySignature", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify an Ed25519 signature against a message and public key.", "tags": [], "signatures": [ { "code": "declare function verifySignature(publicKey: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 33, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "verifysignature" }, { "name": "verifyThresholdSignature", "declarationName": "verifyThresholdSignature", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify an aggregated FROST signature against the group public key.", "tags": [], "signatures": [ { "code": "declare function verifyThresholdSignature(message: Uint8Array, signature: Uint8Array, publicKeyPackage: Uint8Array): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 108, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "verifythresholdsignature" }, { "name": "WalletAddress", "declarationName": "WalletAddress", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface WalletAddress {\n chain: Chain;\n address: string;\n derivationPath: string;\n publicKeyHex: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/wallet/index.d.ts", "line": 5, "sha256": "b9fcb67088060fec0eefaebce36a7aca2f6490dc507858d671ce6d8c084a774d" } } ], "anchor": "walletaddress" }, { "name": "WalletError", "declarationName": "WalletError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type WalletError = {\n kind: \"wallet/authorization_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/signing_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/unsupported_chain\";\n chain: string;\n message: string;\n} | {\n kind: \"wallet/derivation_failed\";\n chain: string;\n reason: string;\n message: string;\n} | {\n kind: \"wallet/policy_denied\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/obligation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/batch_partial_failure\";\n succeeded: number;\n total: number;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 214, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "walleterror" }, { "name": "walletErrors", "declarationName": "walletErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const walletErrors: {\n authorizationFailed: (reason: string) => WalletError;\n signingFailed: (reason: string) => WalletError;\n unsupportedChain: (chain: string) => WalletError;\n derivationFailed: (chain: string, reason: string) => WalletError;\n policyDenied: (reason: string) => WalletError;\n obligationFailed: (reason: string) => WalletError;\n batchPartialFailure: (succeeded: number, total: number) => WalletError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 310, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "walleterrors" }, { "name": "WalletType", "declarationName": "WalletType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type WalletType = \"eoa\" | \"smart\" | \"abstract\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 176, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "wallettype" } ], "supportingDeclarations": [], "coverage": { "discovered": 176, "documented": 176, "missing": [] } }, { "subpath": "./core", "importSpecifier": "@openagentid/aegis-sdk/core", "page": "/reference/typescript/aegis-sdk/core", "kind": "declarations", "conditions": { "types": "./dist/core/index.d.ts", "import": "./dist/core/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/core/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/core/index.js" } ], "exports": [ { "name": "ActiveHours", "declarationName": "ActiveHours", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ActiveHours {\n startHour: number;\n endHour: number;\n timezone: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 126, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "activehours" }, { "name": "ActiveHoursSchema", "declarationName": "ActiveHoursSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ActiveHoursSchema: z.ZodObject<{\n startHour: z.ZodNumber;\n endHour: z.ZodNumber;\n timezone: z.ZodString;\n}, \"strip\", z.ZodTypeAny, {\n startHour: number;\n endHour: number;\n timezone: string;\n}, {\n startHour: number;\n endHour: number;\n timezone: string;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 232, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "activehoursschema" }, { "name": "AegisError", "declarationName": "AegisError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AegisError = ResolverError | AuthError | PolicyError | VerificationError | KeyError | DelegationError | WalletError;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 245, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "aegiserror" }, { "name": "AegisException", "declarationName": "AegisException", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Throwable wrapper around a tagged AegisError.", "tags": [], "signatures": [ { "code": "declare class AegisException extends Error {\n readonly error: AegisError;\n constructor(error: AegisError);\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 247, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "aegisexception" }, { "name": "AegisIdentity", "declarationName": "AegisIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Identity information extracted from authentication.", "tags": [], "signatures": [ { "code": "interface AegisIdentity {\n did: string;\n identityType: IdentityType;\n displayName?: string | null;\n conformanceLevel?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 6, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "aegisidentity" }, { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentLineageProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 19, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "agentlineageproof" }, { "name": "AuditInfo", "declarationName": "AuditInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuditInfo {\n auditId: string;\n timestamp: string;\n engine: string;\n policiesEvaluated: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 86, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "auditinfo" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The output of successful authentication (AEGIS Spec §7.1).", "tags": [], "signatures": [ { "code": "interface AuthContext {\n provider: string;\n subject: string;\n did?: string | null;\n sessionId?: string | null;\n expiresAt?: string | null;\n claims: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 13, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcontext" }, { "name": "AuthCredential", "declarationName": "AuthCredential", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Discriminated union of credentials accepted by AEGIS auth providers (§7.2).", "tags": [], "signatures": [ { "code": "type AuthCredential = {\n type: \"bearer_token\";\n token: string;\n} | {\n type: \"session_cookie\";\n cookie: string;\n} | {\n type: \"api_key\";\n key: string;\n} | {\n type: \"signed_challenge\";\n did: string;\n challenge: string;\n signature: string;\n timestamp: string;\n nonce: string;\n} | {\n type: \"capability_token\";\n token: string;\n} | {\n type: \"passkey_assertion\";\n credentialId: string;\n authenticatorData: string;\n clientDataJson: string;\n signature: string;\n} | {\n type: \"custom\";\n provider: string;\n data: unknown;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 22, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcredential" }, { "name": "AuthError", "declarationName": "AuthError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuthError = {\n kind: \"auth/invalid_credential\";\n reason: string;\n message: string;\n} | {\n kind: \"auth/credential_expired\";\n expiredAt: string;\n message: string;\n} | {\n kind: \"auth/session_revoked\";\n sessionId: string;\n message: string;\n} | {\n kind: \"auth/session_expired\";\n sessionId: string;\n message: string;\n} | {\n kind: \"auth/challenge_invalid\";\n reason: string;\n message: string;\n} | {\n kind: \"auth/provider_unavailable\";\n provider: string;\n message: string;\n} | {\n kind: \"auth/refresh_not_supported\";\n provider: string;\n message: string;\n} | {\n kind: \"auth/revocation_not_supported\";\n provider: string;\n message: string;\n} | {\n kind: \"auth/internal\";\n reason: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 38, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "autherror" }, { "name": "authErrors", "declarationName": "authErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const authErrors: {\n invalidCredential: (reason: string) => AuthError;\n credentialExpired: (expiredAt: string) => AuthError;\n sessionRevoked: (sessionId: string) => AuthError;\n sessionExpired: (sessionId: string) => AuthError;\n challengeInvalid: (reason: string) => AuthError;\n providerUnavailable: (provider: string) => AuthError;\n refreshNotSupported: (provider: string) => AuthError;\n revocationNotSupported: (provider: string) => AuthError;\n internal: (reason: string) => AuthError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 261, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "autherrors" }, { "name": "AuthProvider", "declarationName": "AuthProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuthProvider {\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n providerName(): string;\n refresh?(ctx: AuthContext): Promise;\n revoke?(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 92, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "authprovider" }, { "name": "base64UrlDecode", "declarationName": "base64UrlDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a URL-safe base64 string (with or without padding) to bytes.", "tags": [], "signatures": [ { "code": "declare function base64UrlDecode(input: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 4, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "base64urldecode" }, { "name": "base64UrlEncode", "declarationName": "base64UrlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes as URL-safe base64 without padding.", "tags": [], "signatures": [ { "code": "declare function base64UrlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 2, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "base64urlencode" }, { "name": "BatchMode", "declarationName": "BatchMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type BatchMode = \"all_or_nothing\" | \"best_effort\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 184, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "batchmode" }, { "name": "Chain", "declarationName": "Chain", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type Chain = \"ethereum\" | \"polygon\" | \"arbitrum\" | \"optimism\" | \"base\" | \"solana\" | \"bitcoin\" | \"cosmos\" | \"osmosis\" | \"aptos\" | \"sui\" | \"starknet\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 177, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chain" }, { "name": "CHAIN_VALUES", "declarationName": "CHAIN_VALUES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CHAIN_VALUES: readonly Chain[];", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 178, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chain_values" }, { "name": "chainCoinType", "declarationName": "chainCoinType", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "BIP-44 coin type for the given chain.", "tags": [], "signatures": [ { "code": "declare function chainCoinType(chain: Chain): number;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 180, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chaincointype" }, { "name": "ChainSchema", "declarationName": "ChainSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ChainSchema: z.ZodEnum<[\n \"ethereum\",\n \"polygon\",\n \"arbitrum\",\n \"optimism\",\n \"base\",\n \"solana\",\n \"bitcoin\",\n \"cosmos\",\n \"osmosis\",\n \"aptos\",\n \"sui\",\n \"starknet\"\n]>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 211, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chainschema" }, { "name": "concatBytes", "declarationName": "concatBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function concatBytes(...chunks: Uint8Array[]): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 9, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "concatbytes" }, { "name": "CreateDidParams", "declarationName": "CreateDidParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreateDidParams {\n entityKind: string;\n namespace: string;\n identifier: string;\n metadata: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 66, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "createdidparams" }, { "name": "cryptoBackend", "declarationName": "cryptoBackend", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the active crypto backend. Throws if none has been registered.\n\nIn Node.js, the backend can be auto-loaded by `loadDefaultCryptoBackend`\nwhich dynamically imports `@openagentid/crypto-wasm`.", "tags": [], "signatures": [ { "code": "declare function cryptoBackend(): CryptoBackend;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 366, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "cryptobackend" }, { "name": "CryptoBackend", "declarationName": "CryptoBackend", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CryptoBackend {\n ed25519GenerateKeypair(): {\n signingKey: Uint8Array;\n verifyingKey: Uint8Array;\n };\n ed25519PublicFromPrivate(signingKey: Uint8Array): Uint8Array;\n ed25519Sign(signingKey: Uint8Array, message: Uint8Array): Uint8Array;\n ed25519Verify(verifyingKey: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;\n hkdfSha256(ikm: Uint8Array, salt: Uint8Array, info: Uint8Array, length: number): Uint8Array;\n blake3Hash(input: Uint8Array): Uint8Array;\n sha256(input: Uint8Array): Uint8Array;\n sha512(input: Uint8Array): Uint8Array;\n aes256GcmEncrypt(key: Uint8Array, nonce: Uint8Array, plaintext: Uint8Array): Uint8Array;\n aes256GcmDecrypt(key: Uint8Array, nonce: Uint8Array, ciphertext: Uint8Array): Uint8Array;\n jcsCanonicalize(value: unknown): Uint8Array;\n multibaseEncode(bytes: Uint8Array): string;\n multibaseDecode(encoded: string): Uint8Array;\n randomBytes(length: number): Uint8Array;\n frostTrustedKeygen(minSigners: number, maxSigners: number): {\n keyPackages: FrostKeyPackage[];\n publicKeyPackage: Uint8Array;\n };\n frostSignRound1(signingShare: Uint8Array): {\n nonces: Uint8Array;\n commitments: Uint8Array;\n };\n frostSignRound2(signingPackage: Uint8Array, nonces: Uint8Array, keyPackage: Uint8Array): Uint8Array;\n frostBuildSigningPackage(commitments: Map, message: Uint8Array): Uint8Array;\n frostAggregate(signingPackage: Uint8Array, signatureShares: Map, publicKeyPackage: Uint8Array): Uint8Array;\n frostVerify(publicKeyPackage: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 320, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "cryptobackend-1" }, { "name": "DEFAULT_PAGE_SIZE", "declarationName": "DEFAULT_PAGE_SIZE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_PAGE_SIZE = 100;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 203, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "default_page_size" }, { "name": "DEFAULT_PAGINATION", "declarationName": "DEFAULT_PAGINATION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_PAGINATION: Pagination;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 209, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "default_pagination" }, { "name": "DEFAULT_VERIFICATION_CONFIG", "declarationName": "DEFAULT_VERIFICATION_CONFIG", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_VERIFICATION_CONFIG: VerificationConfig;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 125, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "default_verification_config" }, { "name": "Delegation", "declarationName": "Delegation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Delegation {\n id: string;\n delegator: string;\n delegate: string;\n scope: DelegationScope;\n created: string;\n expires?: string | null;\n revocable: boolean;\n proof: DelegationProof;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 157, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegation" }, { "name": "DelegationError", "declarationName": "DelegationError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type DelegationError = {\n kind: \"delegation/invalid_proof\";\n reason: string;\n message: string;\n} | {\n kind: \"delegation/revoked\";\n delegationId: string;\n message: string;\n} | {\n kind: \"delegation/expired\";\n delegationId: string;\n message: string;\n} | {\n kind: \"delegation/max_depth_exceeded\";\n depth: number;\n maxDepth: number;\n message: string;\n} | {\n kind: \"delegation/scope_amplification\";\n reason: string;\n message: string;\n} | {\n kind: \"delegation/delegator_not_found\";\n did: string;\n message: string;\n} | {\n kind: \"delegation/delegate_not_found\";\n did: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 184, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "delegationerror" }, { "name": "delegationErrors", "declarationName": "delegationErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const delegationErrors: {\n invalidProof: (reason: string) => DelegationError;\n revoked: (delegationId: string) => DelegationError;\n expired: (delegationId: string) => DelegationError;\n maxDepthExceeded: (depth: number, maxDepth: number) => DelegationError;\n scopeAmplification: (reason: string) => DelegationError;\n delegatorNotFound: (did: string) => DelegationError;\n delegateNotFound: (did: string) => DelegationError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 301, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "delegationerrors" }, { "name": "DelegationProof", "declarationName": "DelegationProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationProof {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 151, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationproof" }, { "name": "DelegationProofSchema", "declarationName": "DelegationProofSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DelegationProofSchema: z.ZodObject<{\n type: z.ZodLiteral<\"AegisDelegationProof2025\">;\n verificationMethod: z.ZodString;\n created: z.ZodString;\n jws: z.ZodString;\n}, \"strip\", z.ZodTypeAny, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n}, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 383, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationproofschema" }, { "name": "DelegationSchema", "declarationName": "DelegationSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DelegationSchema: z.ZodObject<{\n id: z.ZodString;\n delegator: z.ZodString;\n delegate: z.ZodString;\n scope: z.ZodObject<{\n actions: z.ZodDefault>;\n resources: z.ZodDefault>;\n chains: z.ZodDefault>;\n limits: z.ZodOptional>;\n dailyVolume: z.ZodOptional>;\n assetAllowlist: z.ZodDefault>;\n recipientAllowlist: z.ZodDefault>;\n approvalThreshold: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n }, {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n }>>>;\n temporal: z.ZodOptional>;\n validUntil: z.ZodOptional>;\n activeHours: z.ZodOptional>>;\n cooldown: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }>>>;\n }, \"strip\", z.ZodTypeAny, {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n }, {\n actions?: string[] | undefined;\n resources?: string[] | undefined;\n chains?: string[] | undefined;\n limits?: {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n }>;\n created: z.ZodString;\n expires: z.ZodOptional>;\n revocable: z.ZodBoolean;\n proof: z.ZodObject<{\n type: z.ZodLiteral<\"AegisDelegationProof2025\">;\n verificationMethod: z.ZodString;\n created: z.ZodString;\n jws: z.ZodString;\n }, \"strip\", z.ZodTypeAny, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n }, {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n }>;\n}, \"strip\", z.ZodTypeAny, {\n created: string;\n id: string;\n delegator: string;\n delegate: string;\n scope: {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n };\n revocable: boolean;\n proof: {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n };\n expires?: string | null | undefined;\n}, {\n created: string;\n id: string;\n delegator: string;\n delegate: string;\n scope: {\n actions?: string[] | undefined;\n resources?: string[] | undefined;\n chains?: string[] | undefined;\n limits?: {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n };\n revocable: boolean;\n proof: {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n };\n expires?: string | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 399, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationschema" }, { "name": "DelegationScope", "declarationName": "DelegationScope", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationScope {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: SpendingLimits | null;\n temporal?: TemporalConstraints | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 144, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationscope" }, { "name": "DelegationScopeSchema", "declarationName": "DelegationScopeSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DelegationScopeSchema: z.ZodObject<{\n actions: z.ZodDefault>;\n resources: z.ZodDefault>;\n chains: z.ZodDefault>;\n limits: z.ZodOptional>;\n dailyVolume: z.ZodOptional>;\n assetAllowlist: z.ZodDefault>;\n recipientAllowlist: z.ZodDefault>;\n approvalThreshold: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n }, {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n }>>>;\n temporal: z.ZodOptional>;\n validUntil: z.ZodOptional>;\n activeHours: z.ZodOptional>>;\n cooldown: z.ZodOptional>;\n }, \"strip\", z.ZodTypeAny, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n }>>>;\n}, \"strip\", z.ZodTypeAny, {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n}, {\n actions?: string[] | undefined;\n resources?: string[] | undefined;\n chains?: string[] | undefined;\n limits?: {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n } | null | undefined;\n temporal?: {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n } | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 281, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationscopeschema" }, { "name": "derivationStandard", "declarationName": "derivationStandard", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the derivation standard name for the given chain.", "tags": [], "signatures": [ { "code": "declare function derivationStandard(chain: Chain): \"BIP-44\" | \"SLIP-0010\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 182, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "derivationstandard" }, { "name": "DidCreationResult", "declarationName": "DidCreationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DidCreationResult {\n did: string;\n document: OasDocument;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 72, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didcreationresult" }, { "name": "DidResolver", "declarationName": "DidResolver", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "DID Resolver plugin interface (§4.1).\n\nEnables AEGIS to resolve any DID method without coupling to a specific\nresolution mechanism. Each resolver handles one or more DID methods.\n\nImplementations MUST resolve within 5 seconds.", "tags": [], "signatures": [ { "code": "interface DidResolver {\n resolve(did: string): Promise;\n handles(did: string): boolean;\n supportedMethods(): readonly string[];\n create?(params: CreateDidParams): Promise;\n update?(did: string, document: OasDocument): Promise;\n deactivate?(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 84, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didresolver" }, { "name": "DocumentMetadata", "declarationName": "DocumentMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentMetadata {\n created: string;\n updated?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 25, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentmetadata" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws?: string;\n proofValue?: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 29, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentproof" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type EntityKind = \"hmr\" | \"mhr\" | \"enr\" | \"ao\" | \"agent\" | \"agent:instance\" | \"tool\" | \"skill\" | \"workflow\" | \"model\" | \"dataset\" | \"service\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 4, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "entitykind" }, { "name": "FrostKeyPackage", "declarationName": "FrostKeyPackage", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface FrostKeyPackage {\n identifier: number;\n bytes: Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 351, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "frostkeypackage" }, { "name": "Guardian", "declarationName": "Guardian", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Guardian {\n guardianType: GuardianType;\n identifier: string;\n weight: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 192, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "guardian" }, { "name": "GuardianType", "declarationName": "GuardianType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type GuardianType = \"identity\" | \"email\" | \"phone\" | \"hardware\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 191, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "guardiantype" }, { "name": "hexDecode", "declarationName": "hexDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function hexDecode(input: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 6, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "hexdecode" }, { "name": "hexEncode", "declarationName": "hexEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function hexEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 5, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "hexencode" }, { "name": "IdentityType", "declarationName": "IdentityType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The type of entity being authenticated.", "tags": [], "signatures": [ { "code": "type IdentityType = \"human\" | \"agent\" | \"organization\" | \"enterprise\" | \"delegated\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 4, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "identitytype" }, { "name": "IdentityTypeSchema", "declarationName": "IdentityTypeSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const IdentityTypeSchema: z.ZodEnum<[\n \"human\",\n \"agent\",\n \"organization\",\n \"enterprise\",\n \"delegated\"\n]>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 210, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "identitytypeschema" }, { "name": "inferIdentityTypeFromDid", "declarationName": "inferIdentityTypeFromDid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Infer the IdentityType from a `did:oas:::` string.\n\nReturns \"agent\" if the DID cannot be parsed.", "tags": [], "signatures": [ { "code": "declare function inferIdentityTypeFromDid(did: string): \"human\" | \"organization\" | \"enterprise\" | \"agent\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 64, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "inferidentitytypefromdid" }, { "name": "KeyError", "declarationName": "KeyError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyError = {\n kind: \"key/generation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/derivation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/rotation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/recovery_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/mpc_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/not_found\";\n keyId: string;\n message: string;\n} | {\n kind: \"key/storage_error\";\n reason: string;\n message: string;\n} | {\n kind: \"key/signing_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"key/unsupported_type\";\n keyType: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 147, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "keyerror" }, { "name": "keyErrors", "declarationName": "keyErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const keyErrors: {\n generationFailed: (reason: string) => KeyError;\n derivationFailed: (reason: string) => KeyError;\n rotationFailed: (reason: string) => KeyError;\n recoveryFailed: (reason: string) => KeyError;\n mpcFailed: (reason: string) => KeyError;\n notFound: (keyId: string) => KeyError;\n storageError: (reason: string) => KeyError;\n signingFailed: (reason: string) => KeyError;\n unsupportedKeyType: (keyType: string) => KeyError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 290, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "keyerrors" }, { "name": "KeyGenerationMode", "declarationName": "KeyGenerationMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyGenerationMode = \"direct\" | \"mpc\" | \"tee\" | \"hsm\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 186, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keygenerationmode" }, { "name": "KeyRole", "declarationName": "KeyRole", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyRole = \"identity\" | \"authentication\" | \"assertion\" | \"delegation\" | \"session\" | \"recovery\" | \"chain\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 185, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keyrole" }, { "name": "KeyRoleSchema", "declarationName": "KeyRoleSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const KeyRoleSchema: z.ZodEnum<[\n \"identity\",\n \"authentication\",\n \"assertion\",\n \"delegation\",\n \"session\",\n \"recovery\",\n \"chain\"\n]>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 212, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keyroleschema" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LifecycleStatus = \"active\" | \"suspended\" | \"terminated\" | \"deprecated\" | \"draft\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 3, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Optional lineage section for non-root entities.", "tags": [], "signatures": [ { "code": "interface LineageSection {\n parent: string;\n generation: number;\n humanRootChain: string[];\n proof?: AgentLineageProof | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 13, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lineagesection" }, { "name": "LineageSummary", "declarationName": "LineageSummary", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LineageSummary {\n depth: number;\n humanRoot: string;\n verified: boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 69, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "lineagesummary" }, { "name": "LivenessStatus", "declarationName": "LivenessStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LivenessStatus = \"active\" | \"warning\" | \"stale\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 104, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "livenessstatus" }, { "name": "loadDefaultCryptoBackend", "declarationName": "loadDefaultCryptoBackend", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Attempts to load `@openagentid/crypto-wasm` lazily. Falls back to a\nstub error backend if the module isn't available — callers should\nrely on this for one-time setup in tests/examples.", "tags": [], "signatures": [ { "code": "declare function loadDefaultCryptoBackend(): Promise;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 372, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "loaddefaultcryptobackend" }, { "name": "makePagination", "declarationName": "makePagination", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function makePagination(limit: number, offset: number): Pagination;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 208, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "makepagination" }, { "name": "MAX_PAGE_SIZE", "declarationName": "MAX_PAGE_SIZE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const MAX_PAGE_SIZE = 1000;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 202, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "max_page_size" }, { "name": "oasDocument", "declarationName": "oasDocument", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Helpers for inspecting OAS documents without coupling to a specific SDK.", "tags": [], "signatures": [ { "code": "declare const oasDocument: {\n isRoot(doc: OasDocument): boolean;\n isRevoked(doc: OasDocument): boolean;\n primaryPublicKeyMultibase(doc: OasDocument): string | null;\n findVerificationMethod(doc: OasDocument, id: string): VerificationMethod | null;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 53, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "oasdocument" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal OAS Identity Document interface.", "tags": [], "signatures": [ { "code": "interface OasDocument {\n id: string;\n oasVersion: string;\n kind: string;\n verificationMethod: VerificationMethod[];\n authentication?: string[];\n assertionMethod?: string[];\n delegationMethod?: string[];\n metadata: DocumentMetadata;\n lineage?: LineageSection | null;\n lifecycleStatus?: LifecycleStatus | null;\n revoked?: boolean;\n proof?: DocumentProof | null;\n [key: string]: unknown;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 37, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "oasdocument-1" }, { "name": "Obligation", "declarationName": "Obligation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Obligation {\n obligationType: ObligationType;\n params: Record;\n deadline?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 81, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligation" }, { "name": "ObligationType", "declarationName": "ObligationType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ObligationType = \"log\" | \"notify\" | \"approve\" | \"escrow\" | \"limit\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 80, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligationtype" }, { "name": "Pagination", "declarationName": "Pagination", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Pagination {\n limit: number;\n offset: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 204, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "pagination" }, { "name": "PermissionCheck", "declarationName": "PermissionCheck", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PermissionCheck {\n principal: string;\n permission: string;\n resource?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 98, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "permissioncheck" }, { "name": "PluginRegistry", "declarationName": "PluginRegistry", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The Plugin Registry manages all loaded plugins and routes requests\nto the appropriate plugin (AEGIS Spec §4.4).\n\n- Multiple DID Resolvers (routed by `handles()` matching)\n- Multiple Auth Providers (keyed by `providerName()`)\n- Exactly one Policy Engine\n\nPlugin registration order is deterministic. Resolvers are tried in\nregistration order; the first whose `handles()` returns true is used.", "tags": [], "signatures": [ { "code": "declare class PluginRegistry {\n registerResolver(resolver: DidResolver): void;\n registerAuthProvider(provider: AuthProvider): void;\n setPolicyEngine(engine: PolicyEngine): void;\n resolverCount(): number;\n authProviderCount(): number;\n hasPolicyEngine(): boolean;\n getResolverFor(did: string): DidResolver | null;\n getAuthProvider(name: string): AuthProvider | null;\n getPolicyEngine(): PolicyEngine | null;\n resolveDid(did: string): Promise;\n validateCredential(credential: AuthCredential, providerName?: string | null): Promise;\n evaluatePolicy(request: PolicyRequest): Promise;\n checkPermission(check: PermissionCheck): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 116, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "pluginregistry" }, { "name": "PolicyContext", "declarationName": "PolicyContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyContext {\n authContext?: AuthContext | null;\n lineage?: LineageSummary | null;\n conformanceLevel?: number | null;\n session?: Session | null;\n extra: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 62, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policycontext" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n allowed: boolean;\n reason?: string | null;\n obligations: Obligation[];\n auditInfo: AuditInfo;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 92, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policydecision" }, { "name": "PolicyEngine", "declarationName": "PolicyEngine", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyEngine {\n evaluate(request: PolicyRequest): Promise;\n checkPermission(check: PermissionCheck): Promise;\n engineName(): string;\n getPolicies?(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 99, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "policyengine" }, { "name": "PolicyError", "declarationName": "PolicyError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyError = {\n kind: \"policy/evaluation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"policy/timeout\";\n timeoutMs: number;\n message: string;\n} | {\n kind: \"policy/engine_unavailable\";\n message: string;\n} | {\n kind: \"policy/no_engine\";\n message: string;\n} | {\n kind: \"policy/config_error\";\n reason: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 75, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "policyerror" }, { "name": "policyErrors", "declarationName": "policyErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const policyErrors: {\n evaluationFailed: (reason: string) => PolicyError;\n timeout: (timeoutMs: number) => PolicyError;\n engineUnavailable: () => PolicyError;\n noEngine: () => PolicyError;\n configError: (reason: string) => PolicyError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 272, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "policyerrors" }, { "name": "PolicyRequest", "declarationName": "PolicyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRequest {\n principal: string;\n action: string;\n resource: string;\n context: PolicyContext;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 74, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policyrequest" }, { "name": "RecoveryConfig", "declarationName": "RecoveryConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RecoveryConfig {\n guardians: Guardian[];\n threshold: number;\n timelock: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 197, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "recoveryconfig" }, { "name": "ResolverError", "declarationName": "ResolverError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ResolverError = {\n kind: \"resolver/not_found\";\n did: string;\n message: string;\n} | {\n kind: \"resolver/invalid_format\";\n reason: string;\n message: string;\n} | {\n kind: \"resolver/timeout\";\n did: string;\n timeoutMs: number;\n message: string;\n} | {\n kind: \"resolver/deactivated\";\n did: string;\n message: string;\n} | {\n kind: \"resolver/network\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"resolver/creation_not_supported\";\n message: string;\n} | {\n kind: \"resolver/update_not_supported\";\n message: string;\n} | {\n kind: \"resolver/deactivation_not_supported\";\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 6, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "resolvererror" }, { "name": "resolverErrors", "declarationName": "resolverErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const resolverErrors: {\n notFound: (did: string) => ResolverError;\n invalidFormat: (reason: string) => ResolverError;\n timeout: (did: string, timeoutMs: number) => ResolverError;\n deactivated: (did: string) => ResolverError;\n network: (did: string, reason: string) => ResolverError;\n creationNotSupported: () => ResolverError;\n updateNotSupported: () => ResolverError;\n deactivationNotSupported: () => ResolverError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 251, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "resolvererrors" }, { "name": "RevocationStatus", "declarationName": "RevocationStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevocationStatus = \"active\" | \"revoked\" | \"suspended\" | \"expired\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 103, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "revocationstatus" }, { "name": "Session", "declarationName": "Session", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Session token structure (AEGIS Spec §7.4).", "tags": [], "signatures": [ { "code": "interface Session {\n sessionId: string;\n did: string;\n provider: string;\n createdAt: string;\n expiresAt: string;\n scope: string[];\n deviceBinding?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 53, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "session" }, { "name": "SessionKey", "declarationName": "SessionKey", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionKey {\n sessionKey: string;\n principal: string;\n scope: DelegationScope;\n maxTransactions?: number | null;\n created: string;\n expires: string;\n proof: DelegationProof;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 167, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "sessionkey" }, { "name": "setCryptoBackend", "declarationName": "setCryptoBackend", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Inject a custom crypto backend implementation. Call this once at SDK\ninitialization (typically with the `@openagentid/crypto-wasm` exports).", "tags": [], "signatures": [ { "code": "declare function setCryptoBackend(impl: CryptoBackend): void;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 359, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "setcryptobackend" }, { "name": "SigningMode", "declarationName": "SigningMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SigningMode = \"direct\" | \"mpc\" | \"tee\" | \"external\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 183, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "signingmode" }, { "name": "SpendingLimits", "declarationName": "SpendingLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SpendingLimits {\n maxAmount?: string | null;\n dailyVolume?: string | null;\n assetAllowlist: string[];\n recipientAllowlist: string[];\n approvalThreshold?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 137, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "spendinglimits" }, { "name": "SpendingLimitsSchema", "declarationName": "SpendingLimitsSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SpendingLimitsSchema: z.ZodObject<{\n maxAmount: z.ZodOptional>;\n dailyVolume: z.ZodOptional>;\n assetAllowlist: z.ZodDefault>;\n recipientAllowlist: z.ZodDefault>;\n approvalThreshold: z.ZodOptional>;\n}, \"strip\", z.ZodTypeAny, {\n assetAllowlist: string[];\n recipientAllowlist: string[];\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n approvalThreshold?: string | null | undefined;\n}, {\n maxAmount?: string | null | undefined;\n dailyVolume?: string | null | undefined;\n assetAllowlist?: string[] | undefined;\n recipientAllowlist?: string[] | undefined;\n approvalThreshold?: string | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 213, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "spendinglimitsschema" }, { "name": "TemporalConstraints", "declarationName": "TemporalConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TemporalConstraints {\n validFrom?: string | null;\n validUntil?: string | null;\n activeHours?: ActiveHours | null;\n cooldown?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 131, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "temporalconstraints" }, { "name": "TemporalConstraintsSchema", "declarationName": "TemporalConstraintsSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const TemporalConstraintsSchema: z.ZodObject<{\n validFrom: z.ZodOptional>;\n validUntil: z.ZodOptional>;\n activeHours: z.ZodOptional>>;\n cooldown: z.ZodOptional>;\n}, \"strip\", z.ZodTypeAny, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n}, {\n validFrom?: string | null | undefined;\n validUntil?: string | null | undefined;\n activeHours?: {\n startHour: number;\n endHour: number;\n timezone: string;\n } | null | undefined;\n cooldown?: string | null | undefined;\n}>;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 245, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "temporalconstraintsschema" }, { "name": "ThresholdConfig", "declarationName": "ThresholdConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ThresholdConfig {\n threshold: number;\n totalShares: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 187, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "thresholdconfig" }, { "name": "u32BeBytes", "declarationName": "u32BeBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "big-endian u32 → 4 bytes", "tags": [], "signatures": [ { "code": "declare function u32BeBytes(n: number): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 11, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "u32bebytes" }, { "name": "utf8Decode", "declarationName": "utf8Decode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function utf8Decode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 8, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "utf8decode" }, { "name": "utf8Encode", "declarationName": "utf8Encode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function utf8Encode(s: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 7, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "utf8encode" }, { "name": "VerificationConfig", "declarationName": "VerificationConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationConfig {\n maxLineageDepth: number;\n perHopTimeoutSecs: number;\n totalTimeoutSecs: number;\n cacheTtlSecs: number;\n livenessPeriodDays: number;\n conformanceLevel: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 117, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "verificationconfig" }, { "name": "VerificationError", "declarationName": "VerificationError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerificationError = {\n kind: \"verify/resolution_failed\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"verify/invalid_schema\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"verify/invalid_signature\";\n did: string;\n message: string;\n} | {\n kind: \"verify/lineage_failed\";\n did: string;\n reason: string;\n message: string;\n} | {\n kind: \"verify/max_depth_exceeded\";\n did: string;\n depth: number;\n maxDepth: number;\n message: string;\n} | {\n kind: \"verify/revoked\";\n did: string;\n message: string;\n} | {\n kind: \"verify/suspended\";\n did: string;\n message: string;\n} | {\n kind: \"verify/human_root_revoked\";\n humanRoot: string;\n message: string;\n} | {\n kind: \"verify/generation_mismatch\";\n did: string;\n expected: number;\n found: number;\n message: string;\n} | {\n kind: \"verify/timeout\";\n did: string;\n message: string;\n} | {\n kind: \"verify/consistency_violation\";\n did: string;\n reason: string;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 94, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "verificationerror" }, { "name": "verificationErrors", "declarationName": "verificationErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const verificationErrors: {\n resolutionFailed: (did: string, reason: string) => VerificationError;\n invalidSchema: (did: string, reason: string) => VerificationError;\n invalidSignature: (did: string) => VerificationError;\n lineageFailed: (did: string, reason: string) => VerificationError;\n maxDepthExceeded: (did: string, depth: number, maxDepth: number) => VerificationError;\n revoked: (did: string) => VerificationError;\n suspended: (did: string) => VerificationError;\n humanRootRevoked: (humanRoot: string) => VerificationError;\n timeout: (did: string) => VerificationError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 279, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "verificationerrors" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Verification method per W3C DID-Core.", "tags": [], "signatures": [ { "code": "interface VerificationMethod {\n id: string;\n type: string;\n controller: string;\n publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 6, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "verificationmethod" }, { "name": "VerificationResult", "declarationName": "VerificationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationResult {\n did: string;\n signatureValid: boolean;\n lineageValid: boolean;\n lineageDepth: number;\n humanRoot?: string | null;\n revocationStatus: RevocationStatus;\n livenessStatus: LivenessStatus;\n conformanceLevel: number;\n warnings: string[];\n verifiedAt: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 105, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "verificationresult" }, { "name": "WalletError", "declarationName": "WalletError", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type WalletError = {\n kind: \"wallet/authorization_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/signing_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/unsupported_chain\";\n chain: string;\n message: string;\n} | {\n kind: \"wallet/derivation_failed\";\n chain: string;\n reason: string;\n message: string;\n} | {\n kind: \"wallet/policy_denied\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/obligation_failed\";\n reason: string;\n message: string;\n} | {\n kind: \"wallet/batch_partial_failure\";\n succeeded: number;\n total: number;\n message: string;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 214, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "walleterror" }, { "name": "walletErrors", "declarationName": "walletErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const walletErrors: {\n authorizationFailed: (reason: string) => WalletError;\n signingFailed: (reason: string) => WalletError;\n unsupportedChain: (chain: string) => WalletError;\n derivationFailed: (chain: string, reason: string) => WalletError;\n policyDenied: (reason: string) => WalletError;\n obligationFailed: (reason: string) => WalletError;\n batchPartialFailure: (succeeded: number, total: number) => WalletError;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 310, "sha256": "b22e8dddbbafc86f21ae1817f1490b8d4eac4e5f74f5eebb05b3857c324ad449" } } ], "anchor": "walleterrors" }, { "name": "WalletType", "declarationName": "WalletType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type WalletType = \"eoa\" | \"smart\" | \"abstract\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 176, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "wallettype" } ], "supportingDeclarations": [], "coverage": { "discovered": 97, "documented": 97, "missing": [] } }, { "subpath": "./verify", "importSpecifier": "@openagentid/aegis-sdk/verify", "page": "/reference/typescript/aegis-sdk/verify", "kind": "declarations", "conditions": { "types": "./dist/verify/index.d.ts", "import": "./dist/verify/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/verify/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/verify/index.js" } ], "exports": [ { "name": "base64UrlEncode", "declarationName": "base64UrlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes as URL-safe base64 without padding.", "tags": [], "signatures": [ { "code": "declare function base64UrlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/encoding-OdOrLVsv.d.ts", "line": 2, "sha256": "a72e7b80b1f32d0a377beb97ee0d654d37012531d4d867f55887d59874da8485" } } ], "anchor": "base64urlencode" }, { "name": "InMemoryVerificationCacheStore", "declarationName": "InMemoryVerificationCacheStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryVerificationCacheStore implements VerificationCacheStore {\n constructor(ttlSecs: number);\n ttlSecs(): number;\n getCached(did: string): Promise;\n storeCached(did: string, result: VerificationResult): Promise;\n invalidate(did: string): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 54, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "inmemoryverificationcachestore" }, { "name": "VerificationCache", "declarationName": "VerificationCache", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class VerificationCache {\n constructor(ttlSecs: number);\n ttl(): number;\n size(): number;\n isEmpty(): boolean;\n get(did: string): VerificationResult | null;\n insert(did: string, result: VerificationResult): void;\n invalidate(did: string): void;\n clear(): void;\n cleanupExpired(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 4, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "verificationcache" }, { "name": "VerificationCacheStore", "declarationName": "VerificationCacheStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationCacheStore {\n getCached(did: string): Promise;\n storeCached(did: string, result: VerificationResult): Promise;\n invalidate(did: string): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 48, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "verificationcachestore" }, { "name": "VerificationPipeline", "declarationName": "VerificationPipeline", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The AEGIS Verification Pipeline.\n\nPerforms complete verification of OAS identity documents per AEGIS\nSpecification §5. Results are cached with a configurable TTL (max\n300 seconds per spec).", "tags": [], "signatures": [ { "code": "declare class VerificationPipeline {\n constructor(registry: PluginRegistry, config?: VerificationConfig);\n cache(): VerificationCache;\n verify(did: string): Promise;\n verifyForceRefresh(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-D8FECMQ_.d.ts", "line": 26, "sha256": "8ab529725fd9c020cd484f926f0f4447d94f41d60502449c0032df63482cede2" } } ], "anchor": "verificationpipeline" } ], "supportingDeclarations": [ { "name": "AegisIdentity", "declarationName": "AegisIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Identity information extracted from authentication.", "tags": [], "signatures": [ { "code": "interface AegisIdentity {\n did: string;\n identityType: IdentityType;\n displayName?: string | null;\n conformanceLevel?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 6, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "aegisidentity" }, { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentLineageProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 19, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "agentlineageproof" }, { "name": "AuditInfo", "declarationName": "AuditInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuditInfo {\n auditId: string;\n timestamp: string;\n engine: string;\n policiesEvaluated: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 86, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "auditinfo" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The output of successful authentication (AEGIS Spec §7.1).", "tags": [], "signatures": [ { "code": "interface AuthContext {\n provider: string;\n subject: string;\n did?: string | null;\n sessionId?: string | null;\n expiresAt?: string | null;\n claims: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 13, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcontext" }, { "name": "AuthCredential", "declarationName": "AuthCredential", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Discriminated union of credentials accepted by AEGIS auth providers (§7.2).", "tags": [], "signatures": [ { "code": "type AuthCredential = {\n type: \"bearer_token\";\n token: string;\n} | {\n type: \"session_cookie\";\n cookie: string;\n} | {\n type: \"api_key\";\n key: string;\n} | {\n type: \"signed_challenge\";\n did: string;\n challenge: string;\n signature: string;\n timestamp: string;\n nonce: string;\n} | {\n type: \"capability_token\";\n token: string;\n} | {\n type: \"passkey_assertion\";\n credentialId: string;\n authenticatorData: string;\n clientDataJson: string;\n signature: string;\n} | {\n type: \"custom\";\n provider: string;\n data: unknown;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 22, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcredential" }, { "name": "AuthProvider", "declarationName": "AuthProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuthProvider {\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n providerName(): string;\n refresh?(ctx: AuthContext): Promise;\n revoke?(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 92, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "authprovider" }, { "name": "CreateDidParams", "declarationName": "CreateDidParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreateDidParams {\n entityKind: string;\n namespace: string;\n identifier: string;\n metadata: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 66, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "createdidparams" }, { "name": "DidCreationResult", "declarationName": "DidCreationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DidCreationResult {\n did: string;\n document: OasDocument;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 72, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didcreationresult" }, { "name": "DidResolver", "declarationName": "DidResolver", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "DID Resolver plugin interface (§4.1).\n\nEnables AEGIS to resolve any DID method without coupling to a specific\nresolution mechanism. Each resolver handles one or more DID methods.\n\nImplementations MUST resolve within 5 seconds.", "tags": [], "signatures": [ { "code": "interface DidResolver {\n resolve(did: string): Promise;\n handles(did: string): boolean;\n supportedMethods(): readonly string[];\n create?(params: CreateDidParams): Promise;\n update?(did: string, document: OasDocument): Promise;\n deactivate?(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 84, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didresolver" }, { "name": "DocumentMetadata", "declarationName": "DocumentMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentMetadata {\n created: string;\n updated?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 25, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentmetadata" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws?: string;\n proofValue?: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 29, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentproof" }, { "name": "IdentityType", "declarationName": "IdentityType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The type of entity being authenticated.", "tags": [], "signatures": [ { "code": "type IdentityType = \"human\" | \"agent\" | \"organization\" | \"enterprise\" | \"delegated\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 4, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "identitytype" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LifecycleStatus = \"active\" | \"suspended\" | \"terminated\" | \"deprecated\" | \"draft\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 3, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Optional lineage section for non-root entities.", "tags": [], "signatures": [ { "code": "interface LineageSection {\n parent: string;\n generation: number;\n humanRootChain: string[];\n proof?: AgentLineageProof | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 13, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lineagesection" }, { "name": "LineageSummary", "declarationName": "LineageSummary", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LineageSummary {\n depth: number;\n humanRoot: string;\n verified: boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 69, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "lineagesummary" }, { "name": "LivenessStatus", "declarationName": "LivenessStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LivenessStatus = \"active\" | \"warning\" | \"stale\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 104, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "livenessstatus" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal OAS Identity Document interface.", "tags": [], "signatures": [ { "code": "interface OasDocument {\n id: string;\n oasVersion: string;\n kind: string;\n verificationMethod: VerificationMethod[];\n authentication?: string[];\n assertionMethod?: string[];\n delegationMethod?: string[];\n metadata: DocumentMetadata;\n lineage?: LineageSection | null;\n lifecycleStatus?: LifecycleStatus | null;\n revoked?: boolean;\n proof?: DocumentProof | null;\n [key: string]: unknown;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 37, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "oasdocument" }, { "name": "Obligation", "declarationName": "Obligation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Obligation {\n obligationType: ObligationType;\n params: Record;\n deadline?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 81, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligation" }, { "name": "ObligationType", "declarationName": "ObligationType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ObligationType = \"log\" | \"notify\" | \"approve\" | \"escrow\" | \"limit\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 80, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligationtype" }, { "name": "PermissionCheck", "declarationName": "PermissionCheck", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PermissionCheck {\n principal: string;\n permission: string;\n resource?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 98, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "permissioncheck" }, { "name": "PluginRegistry", "declarationName": "PluginRegistry", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The Plugin Registry manages all loaded plugins and routes requests\nto the appropriate plugin (AEGIS Spec §4.4).\n\n- Multiple DID Resolvers (routed by `handles()` matching)\n- Multiple Auth Providers (keyed by `providerName()`)\n- Exactly one Policy Engine\n\nPlugin registration order is deterministic. Resolvers are tried in\nregistration order; the first whose `handles()` returns true is used.", "tags": [], "signatures": [ { "code": "declare class PluginRegistry {\n registerResolver(resolver: DidResolver): void;\n registerAuthProvider(provider: AuthProvider): void;\n setPolicyEngine(engine: PolicyEngine): void;\n resolverCount(): number;\n authProviderCount(): number;\n hasPolicyEngine(): boolean;\n getResolverFor(did: string): DidResolver | null;\n getAuthProvider(name: string): AuthProvider | null;\n getPolicyEngine(): PolicyEngine | null;\n resolveDid(did: string): Promise;\n validateCredential(credential: AuthCredential, providerName?: string | null): Promise;\n evaluatePolicy(request: PolicyRequest): Promise;\n checkPermission(check: PermissionCheck): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 116, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "pluginregistry" }, { "name": "PolicyContext", "declarationName": "PolicyContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyContext {\n authContext?: AuthContext | null;\n lineage?: LineageSummary | null;\n conformanceLevel?: number | null;\n session?: Session | null;\n extra: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 62, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policycontext" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n allowed: boolean;\n reason?: string | null;\n obligations: Obligation[];\n auditInfo: AuditInfo;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 92, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policydecision" }, { "name": "PolicyEngine", "declarationName": "PolicyEngine", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyEngine {\n evaluate(request: PolicyRequest): Promise;\n checkPermission(check: PermissionCheck): Promise;\n engineName(): string;\n getPolicies?(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 99, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "policyengine" }, { "name": "PolicyRequest", "declarationName": "PolicyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRequest {\n principal: string;\n action: string;\n resource: string;\n context: PolicyContext;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 74, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policyrequest" }, { "name": "RevocationStatus", "declarationName": "RevocationStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevocationStatus = \"active\" | \"revoked\" | \"suspended\" | \"expired\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 103, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "revocationstatus" }, { "name": "Session", "declarationName": "Session", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Session token structure (AEGIS Spec §7.4).", "tags": [], "signatures": [ { "code": "interface Session {\n sessionId: string;\n did: string;\n provider: string;\n createdAt: string;\n expiresAt: string;\n scope: string[];\n deviceBinding?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 53, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "session" }, { "name": "VerificationConfig", "declarationName": "VerificationConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationConfig {\n maxLineageDepth: number;\n perHopTimeoutSecs: number;\n totalTimeoutSecs: number;\n cacheTtlSecs: number;\n livenessPeriodDays: number;\n conformanceLevel: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 117, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "verificationconfig" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Verification method per W3C DID-Core.", "tags": [], "signatures": [ { "code": "interface VerificationMethod {\n id: string;\n type: string;\n controller: string;\n publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 6, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "verificationmethod" }, { "name": "VerificationResult", "declarationName": "VerificationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationResult {\n did: string;\n signatureValid: boolean;\n lineageValid: boolean;\n lineageDepth: number;\n humanRoot?: string | null;\n revocationStatus: RevocationStatus;\n livenessStatus: LivenessStatus;\n conformanceLevel: number;\n warnings: string[];\n verifiedAt: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 105, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "verificationresult" } ], "coverage": { "discovered": 5, "documented": 5, "missing": [] } }, { "subpath": "./keys", "importSpecifier": "@openagentid/aegis-sdk/keys", "page": "/reference/typescript/aegis-sdk/keys", "kind": "declarations", "conditions": { "types": "./dist/keys/index.d.ts", "import": "./dist/keys/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/keys/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/keys/index.js" } ], "exports": [ { "name": "derivationPath", "declarationName": "derivationPath", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a BIP-44 derivation path for a given blockchain chain.\n\nReturns the standard `m/44'/coin_type'/account'/0/index` path\nused for HD key derivation across most chains.", "tags": [], "signatures": [ { "code": "declare function derivationPath(chain: Chain, account: number, index: number): string;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 26, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "derivationpath" }, { "name": "deriveLineageKey", "declarationName": "deriveLineageKey", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derive a lineage key from a parent private key using HKDF-SHA256.\n\nAlgorithm:\n HKDF-SHA256(\n IKM = parent_private_key (32 bytes),\n Salt = child_did_utf8,\n Info = \"oas-lineage-v1\" || generation_be32,\n L = 32\n )", "tags": [ { "name": "returns", "text": "32 bytes of derived key material suitable for an Ed25519 signing key." } ], "signatures": [ { "code": "declare function deriveLineageKey(parentPrivate: Uint8Array, childDid: string, generation: number): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 19, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "derivelineagekey" }, { "name": "EncryptedKey", "declarationName": "EncryptedKey", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An encrypted private key blob.\n\nUses AES-256-GCM with a random 96-bit nonce. The ciphertext contains\nthe 32-byte Ed25519 signing key material plus a 16-byte authentication tag.", "tags": [], "signatures": [ { "code": "declare class EncryptedKey {\n readonly ciphertext: Uint8Array;\n readonly nonce: Uint8Array;\n static encrypt(signingKeyBytes: Uint8Array, encryptionKey: Uint8Array): EncryptedKey;\n decrypt(encryptionKey: Uint8Array): Uint8Array;\n static fromParts(ciphertext: Uint8Array, nonce: Uint8Array): EncryptedKey;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 9, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "encryptedkey" }, { "name": "FrostCeremony", "declarationName": "FrostCeremony", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "State of a distributed FROST signing ceremony, suitable for orchestrating\nthe protocol across multiple machines/processes. Each participant calls\nthe methods in order:\n\n 1. `addCommitment(id, commitments)` — gather round 1 outputs\n 2. `buildSigningPackage(message)` — build signing package once all\n participants have committed\n 3. `addSignatureShare(id, share)` — gather round 2 outputs\n 4. `aggregate()` — produce the final aggregated signature\n\nThe ceremony does NOT hold any participant key material — those remain\non the participant's own machine.", "tags": [], "signatures": [ { "code": "declare class FrostCeremony {\n constructor(publicKeyPackage: Uint8Array, threshold: number);\n addCommitment(id: number, commitments: Uint8Array): void;\n hasEnoughCommitments(): boolean;\n buildSigningPackage(message: Uint8Array): Uint8Array;\n addSignatureShare(id: number, share: Uint8Array): void;\n hasEnoughShares(): boolean;\n aggregate(): Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 123, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "frostceremony" }, { "name": "generateShares", "declarationName": "generateShares", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generate threshold key shares using FROST trusted dealer.\n\nCreates a `t-of-n` setup: any `minSigners` of `maxSigners` participants\nmay cooperate to produce a valid signature. The dealer is trusted to\ndestroy its copy of the master secret after distribution.", "tags": [], "signatures": [ { "code": "declare function generateShares(minSigners: number, maxSigners: number): ThresholdKeyPackages;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 92, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "generateshares" }, { "name": "GuardianAuthorization", "declarationName": "GuardianAuthorization", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface GuardianAuthorization {\n guardian: Guardian;\n authorizedAt: string;\n signature: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 51, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "guardianauthorization" }, { "name": "InMemoryKeyStore", "declarationName": "InMemoryKeyStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryKeyStore implements KeyStore {\n size(): number;\n isEmpty(): boolean;\n store(key: ManagedKey): Promise;\n load(keyId: string): Promise;\n delete(keyId: string): Promise;\n list(role: KeyRole | null, pagination?: Pagination): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 63, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "inmemorykeystore" }, { "name": "isRotationEligible", "declarationName": "isRotationEligible", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Convenience function: returns true if the role is eligible for standard\nrotation. Session and Recovery keys are excluded.", "tags": [], "signatures": [ { "code": "declare function isRotationEligible(role: KeyRole): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 49, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "isrotationeligible" }, { "name": "KeyGenerator", "declarationName": "KeyGenerator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Key generator supporting multiple generation modes (§6.2).\n\nCurrently implements `direct` generation via the WASM backend's CSPRNG.\nMPC, TEE, and HSM modes are stubs that throw an unsupported error.", "tags": [], "signatures": [ { "code": "declare class KeyGenerator {\n static generateDirect(role: KeyRole, encryptionKey: Uint8Array): ManagedKey;\n static generateKeyId(): string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 51, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "keygenerator" }, { "name": "KeyRotation", "declarationName": "KeyRotation", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class KeyRotation {\n static initiate(old: ManagedKey, encryptionKey: Uint8Array): RotationResult;\n static initiateWithGrace(old: ManagedKey, encryptionKey: Uint8Array, gracePeriodMs: number): RotationResult;\n static isGracePeriodExpired(result: RotationResult): boolean;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 39, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "keyrotation" }, { "name": "KeyStore", "declarationName": "KeyStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface KeyStore {\n store(key: ManagedKey): Promise;\n load(keyId: string): Promise;\n delete(keyId: string): Promise;\n list(role: KeyRole | null, pagination?: Pagination): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 57, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "keystore" }, { "name": "ManagedKey", "declarationName": "ManagedKey", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A managed key with metadata. The private key is stored encrypted; access\nto the raw signing key requires presenting the encryption key.", "tags": [], "signatures": [ { "code": "declare class ManagedKey {\n readonly keyId: string;\n readonly role: KeyRole;\n readonly generationMode: KeyGenerationMode;\n readonly publicKey: Uint8Array;\n readonly encryptedPrivate: EncryptedKey;\n readonly createdAt: string;\n constructor(params: {\n keyId: string;\n role: KeyRole;\n generationMode: KeyGenerationMode;\n publicKey: Uint8Array;\n encryptedPrivate: EncryptedKey;\n createdAt: string;\n });\n publicKeyMultibase(): string;\n decryptPrivate(encryptionKey: Uint8Array): Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/storage-BI8577zJ.d.ts", "line": 24, "sha256": "8466a8a8a1b3a58984b270adf3d51bb9beb4425630f474bd47063efb3ed8a3db" } } ], "anchor": "managedkey" }, { "name": "parseIso8601DurationMs", "declarationName": "parseIso8601DurationMs", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse a simplified ISO 8601 duration into milliseconds.\n\nSupports `PT{n}S`, `PT{n}M`, `PT{n}H`, and `P{n}D`. Falls back to 24 hours\nfor unrecognized formats.", "tags": [], "signatures": [ { "code": "declare function parseIso8601DurationMs(input: string): number;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 76, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "parseiso8601durationms" }, { "name": "RecoveryCeremony", "declarationName": "RecoveryCeremony", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class RecoveryCeremony {\n readonly ceremonyId: string;\n readonly config: RecoveryConfig;\n readonly authorizations: GuardianAuthorization[];\n readonly initiatedAt: string;\n readonly timelockUntil: string;\n constructor(config: RecoveryConfig);\n addAuthorization(auth: GuardianAuthorization): void;\n isThresholdMet(): boolean;\n isTimelockExpired(): boolean;\n canExecute(): boolean;\n accumulatedWeight(): number;\n authorizationCount(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 56, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "recoveryceremony" }, { "name": "RotationRequest", "declarationName": "RotationRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RotationRequest {\n keyId: string;\n gracePeriodMs: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 28, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "rotationrequest" }, { "name": "RotationResult", "declarationName": "RotationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RotationResult {\n oldKeyId: string;\n newKey: ManagedKey;\n gracePeriodEnds: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 33, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "rotationresult" }, { "name": "signWithThreshold", "declarationName": "signWithThreshold", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Run a complete FROST signing round in a single process.\n\nIn production, each participant would perform round1 and round2\nindependently. This helper executes the full 2-round protocol locally\nfor testing, validation, and single-process orchestration scenarios.", "tags": [ { "name": "param", "text": "message The bytes to sign." }, { "name": "param", "text": "keyPackages Map from FROST identifier to key package bytes\n(must contain at least `t` packages)." }, { "name": "param", "text": "publicKeyPackage The group public key package." }, { "name": "returns", "text": "The aggregated FROST signature (64 bytes)." } ], "signatures": [ { "code": "declare function signWithThreshold(message: Uint8Array, keyPackages: Map, publicKeyPackage: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 106, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "signwiththreshold" }, { "name": "ThresholdKeyPackages", "declarationName": "ThresholdKeyPackages", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of FROST trusted-dealer key generation.", "tags": [], "signatures": [ { "code": "interface ThresholdKeyPackages {\n keyPackages: Map;\n publicKeyPackage: Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 79, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "thresholdkeypackages" }, { "name": "verifyThresholdSignature", "declarationName": "verifyThresholdSignature", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify an aggregated FROST signature against the group public key.", "tags": [], "signatures": [ { "code": "declare function verifyThresholdSignature(message: Uint8Array, signature: Uint8Array, publicKeyPackage: Uint8Array): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/keys/index.d.ts", "line": 108, "sha256": "486d876cb72c15c397bab2bec39035afd864a3c06b515bfd596fb3d6dbf2441d" } } ], "anchor": "verifythresholdsignature" } ], "supportingDeclarations": [ { "name": "Chain", "declarationName": "Chain", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type Chain = \"ethereum\" | \"polygon\" | \"arbitrum\" | \"optimism\" | \"base\" | \"solana\" | \"bitcoin\" | \"cosmos\" | \"osmosis\" | \"aptos\" | \"sui\" | \"starknet\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 177, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chain" }, { "name": "Guardian", "declarationName": "Guardian", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Guardian {\n guardianType: GuardianType;\n identifier: string;\n weight: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 192, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "guardian" }, { "name": "GuardianType", "declarationName": "GuardianType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type GuardianType = \"identity\" | \"email\" | \"phone\" | \"hardware\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 191, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "guardiantype" }, { "name": "KeyGenerationMode", "declarationName": "KeyGenerationMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyGenerationMode = \"direct\" | \"mpc\" | \"tee\" | \"hsm\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 186, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keygenerationmode" }, { "name": "KeyRole", "declarationName": "KeyRole", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type KeyRole = \"identity\" | \"authentication\" | \"assertion\" | \"delegation\" | \"session\" | \"recovery\" | \"chain\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 185, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "keyrole" }, { "name": "Pagination", "declarationName": "Pagination", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Pagination {\n limit: number;\n offset: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 204, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "pagination" }, { "name": "RecoveryConfig", "declarationName": "RecoveryConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RecoveryConfig {\n guardians: Guardian[];\n threshold: number;\n timelock: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 197, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "recoveryconfig" } ], "coverage": { "discovered": 19, "documented": 19, "missing": [] } }, { "subpath": "./auth", "importSpecifier": "@openagentid/aegis-sdk/auth", "page": "/reference/typescript/aegis-sdk/auth", "kind": "declarations", "conditions": { "types": "./dist/auth/index.d.ts", "import": "./dist/auth/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/auth/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/auth/index.js" } ], "exports": [ { "name": "ApiKeyProvider", "declarationName": "ApiKeyProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Simple API key auth provider for service-to-service communication.\n\nMaps opaque API keys to DIDs. Suitable for internal services that\nauthenticate via pre-shared keys rather than challenge-response.", "tags": [], "signatures": [ { "code": "declare class ApiKeyProvider implements AuthProvider {\n constructor(initial?: Record);\n providerName(): string;\n registerKey(key: string, did: string): void;\n revokeKey(key: string): boolean;\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 77, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "apikeyprovider" }, { "name": "buildChallengePayload", "declarationName": "buildChallengePayload", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build the JCS-canonical payload bytes for challenge signing/verification.\n\nCanonical form is a JSON object with keys in alphabetical order:\n\n {\"challenge\":\"\",\"did\":\"\",\"nonce\":\"\",\"timestamp\":\"\"}\n\nThe WASM crypto backend's `jcsCanonicalize` handles RFC 8785 ordering.", "tags": [], "signatures": [ { "code": "declare function buildChallengePayload(challenge: Challenge, did: string): Uint8Array;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 28, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "buildchallengepayload" }, { "name": "Challenge", "declarationName": "Challenge", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A challenge issued by the verifier to an authenticating entity.", "tags": [], "signatures": [ { "code": "interface Challenge {\n challengeBytes: Uint8Array;\n timestamp: string;\n nonce: string;\n expiresAt: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 7, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "challenge" }, { "name": "ChallengeResponseProvider", "declarationName": "ChallengeResponseProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Auth provider implementing the AEGIS challenge-response protocol.\n\nValidates `signed_challenge` credentials by:\n 1. Resolving the DID via the registered DID resolver\n 2. Extracting the primary authentication public key\n 3. Reconstructing the challenge and verifying the Ed25519 signature", "tags": [], "signatures": [ { "code": "declare class ChallengeResponseProvider implements AuthProvider {\n constructor(resolver: DidResolver);\n providerName(): string;\n verifier(): ChallengeVerifier;\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 62, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "challengeresponseprovider" }, { "name": "ChallengeVerifier", "declarationName": "ChallengeVerifier", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Challenge-response verifier with in-memory nonce tracking.\n\nProduction deployments should swap the in-memory nonce set for a TTL-\nbacked cache or database via the {@link NonceStore } abstraction in\n`auth/store.ts`.", "tags": [], "signatures": [ { "code": "declare class ChallengeVerifier {\n verifyResponse(challenge: Challenge, did: string, signatureB64: string, publicKey: Uint8Array): void;\n clearNonces(): void;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 36, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "challengeverifier" }, { "name": "generateChallenge", "declarationName": "generateChallenge", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generate a new random challenge.", "tags": [], "signatures": [ { "code": "declare function generateChallenge(): Challenge;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/auth/index.d.ts", "line": 18, "sha256": "51fea37a584a0c729a265d3ad9aad97e5000e0a6b4082b6240d7f9d379e52ae3" } } ], "anchor": "generatechallenge" }, { "name": "InMemoryNonceStore", "declarationName": "InMemoryNonceStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryNonceStore implements NonceStore {\n recordNonce(nonce: string): Promise;\n hasNonce(nonce: string): Promise;\n cleanup(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 48, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "inmemorynoncestore" }, { "name": "InMemorySessionStore", "declarationName": "InMemorySessionStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemorySessionStore implements SessionStore {\n storeSession(session: Session): Promise;\n getSession(sessionId: string): Promise;\n deleteSession(sessionId: string): Promise;\n listByDid(did: string, pagination?: Pagination): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 34, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "inmemorysessionstore" }, { "name": "NonceStore", "declarationName": "NonceStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface NonceStore {\n recordNonce(nonce: string): Promise;\n hasNonce(nonce: string): Promise;\n cleanup(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 42, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "noncestore" }, { "name": "SessionManager", "declarationName": "SessionManager", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class SessionManager {\n readonly humanLifetimeMs: number;\n readonly agentLifetimeMs: number;\n constructor(opts?: SessionManagerOptions);\n createSession(params: {\n did: string;\n provider: string;\n scope?: string[];\n isAgent: boolean;\n deviceBinding?: string | null;\n }): Session;\n getSession(sessionId: string): Session;\n revokeSession(sessionId: string): void;\n isValid(sessionId: string): boolean;\n cleanupExpired(): number;\n sessionCount(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 7, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "sessionmanager" }, { "name": "SessionManagerOptions", "declarationName": "SessionManagerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionManagerOptions {\n humanLifetimeMs?: number;\n agentLifetimeMs?: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 3, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "sessionmanageroptions" }, { "name": "SessionStore", "declarationName": "SessionStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionStore {\n storeSession(session: Session): Promise;\n getSession(sessionId: string): Promise;\n deleteSession(sessionId: string): Promise;\n listByDid(did: string, pagination?: Pagination): Promise;\n cleanupExpired(): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-DM30q3CR.d.ts", "line": 27, "sha256": "70945c907eaa3cbf5fff5d8988a5c0ba0e2cfce96c8ccd2969348f4e58006ee2" } } ], "anchor": "sessionstore" } ], "supportingDeclarations": [ { "name": "AegisIdentity", "declarationName": "AegisIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Identity information extracted from authentication.", "tags": [], "signatures": [ { "code": "interface AegisIdentity {\n did: string;\n identityType: IdentityType;\n displayName?: string | null;\n conformanceLevel?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 6, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "aegisidentity" }, { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentLineageProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 19, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "agentlineageproof" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The output of successful authentication (AEGIS Spec §7.1).", "tags": [], "signatures": [ { "code": "interface AuthContext {\n provider: string;\n subject: string;\n did?: string | null;\n sessionId?: string | null;\n expiresAt?: string | null;\n claims: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 13, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcontext" }, { "name": "AuthCredential", "declarationName": "AuthCredential", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Discriminated union of credentials accepted by AEGIS auth providers (§7.2).", "tags": [], "signatures": [ { "code": "type AuthCredential = {\n type: \"bearer_token\";\n token: string;\n} | {\n type: \"session_cookie\";\n cookie: string;\n} | {\n type: \"api_key\";\n key: string;\n} | {\n type: \"signed_challenge\";\n did: string;\n challenge: string;\n signature: string;\n timestamp: string;\n nonce: string;\n} | {\n type: \"capability_token\";\n token: string;\n} | {\n type: \"passkey_assertion\";\n credentialId: string;\n authenticatorData: string;\n clientDataJson: string;\n signature: string;\n} | {\n type: \"custom\";\n provider: string;\n data: unknown;\n};", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 22, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcredential" }, { "name": "AuthProvider", "declarationName": "AuthProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuthProvider {\n validate(credential: AuthCredential): Promise;\n getIdentity(ctx: AuthContext): Promise;\n providerName(): string;\n refresh?(ctx: AuthContext): Promise;\n revoke?(ctx: AuthContext): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 92, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "authprovider" }, { "name": "CreateDidParams", "declarationName": "CreateDidParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreateDidParams {\n entityKind: string;\n namespace: string;\n identifier: string;\n metadata: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 66, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "createdidparams" }, { "name": "DidCreationResult", "declarationName": "DidCreationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DidCreationResult {\n did: string;\n document: OasDocument;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 72, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didcreationresult" }, { "name": "DidResolver", "declarationName": "DidResolver", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "DID Resolver plugin interface (§4.1).\n\nEnables AEGIS to resolve any DID method without coupling to a specific\nresolution mechanism. Each resolver handles one or more DID methods.\n\nImplementations MUST resolve within 5 seconds.", "tags": [], "signatures": [ { "code": "interface DidResolver {\n resolve(did: string): Promise;\n handles(did: string): boolean;\n supportedMethods(): readonly string[];\n create?(params: CreateDidParams): Promise;\n update?(did: string, document: OasDocument): Promise;\n deactivate?(did: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 84, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "didresolver" }, { "name": "DocumentMetadata", "declarationName": "DocumentMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentMetadata {\n created: string;\n updated?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 25, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentmetadata" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DocumentProof {\n type: string;\n verificationMethod: string;\n created: string;\n jws?: string;\n proofValue?: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 29, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "documentproof" }, { "name": "IdentityType", "declarationName": "IdentityType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The type of entity being authenticated.", "tags": [], "signatures": [ { "code": "type IdentityType = \"human\" | \"agent\" | \"organization\" | \"enterprise\" | \"delegated\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 4, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "identitytype" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LifecycleStatus = \"active\" | \"suspended\" | \"terminated\" | \"deprecated\" | \"draft\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 3, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Optional lineage section for non-root entities.", "tags": [], "signatures": [ { "code": "interface LineageSection {\n parent: string;\n generation: number;\n humanRootChain: string[];\n proof?: AgentLineageProof | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 13, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "lineagesection" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal OAS Identity Document interface.", "tags": [], "signatures": [ { "code": "interface OasDocument {\n id: string;\n oasVersion: string;\n kind: string;\n verificationMethod: VerificationMethod[];\n authentication?: string[];\n assertionMethod?: string[];\n delegationMethod?: string[];\n metadata: DocumentMetadata;\n lineage?: LineageSection | null;\n lifecycleStatus?: LifecycleStatus | null;\n revoked?: boolean;\n proof?: DocumentProof | null;\n [key: string]: unknown;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 37, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "oasdocument" }, { "name": "Pagination", "declarationName": "Pagination", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Pagination {\n limit: number;\n offset: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 204, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "pagination" }, { "name": "Session", "declarationName": "Session", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Session token structure (AEGIS Spec §7.4).", "tags": [], "signatures": [ { "code": "interface Session {\n sessionId: string;\n did: string;\n provider: string;\n createdAt: string;\n expiresAt: string;\n scope: string[];\n deviceBinding?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 53, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "session" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Verification method per W3C DID-Core.", "tags": [], "signatures": [ { "code": "interface VerificationMethod {\n id: string;\n type: string;\n controller: string;\n publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/plugin-CzTTSkdE.d.ts", "line": 6, "sha256": "295c570d1c2397869e7ca16d422533b8444c2e791ebfddb7c8da097ebcb48ef8" } } ], "anchor": "verificationmethod" } ], "coverage": { "discovered": 12, "documented": 12, "missing": [] } }, { "subpath": "./policy", "importSpecifier": "@openagentid/aegis-sdk/policy", "page": "/reference/typescript/aegis-sdk/policy", "kind": "declarations", "conditions": { "types": "./dist/policy/index.d.ts", "import": "./dist/policy/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/policy/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/policy/index.js" } ], "exports": [ { "name": "composeDecisions", "declarationName": "composeDecisions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function composeDecisions(decisions: readonly PolicyDecision[]): PolicyDecision;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 63, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "composedecisions" }, { "name": "ContractInteraction", "declarationName": "ContractInteraction", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ContractInteraction {\n contractAddress: string;\n functionName: string;\n chain: string;\n gasEstimate?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 53, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "contractinteraction" }, { "name": "ContractPolicy", "declarationName": "ContractPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ContractPolicy {\n contractAllowlist: string[];\n functionAllowlist: string[];\n chainAllowlist: string[];\n gasLimit?: number | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 47, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "contractpolicy" }, { "name": "ContractPolicyEvaluator", "declarationName": "ContractPolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class ContractPolicyEvaluator {\n static evaluate(policy: ContractPolicy, interaction: ContractInteraction): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 59, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "contractpolicyevaluator" }, { "name": "LineagePolicy", "declarationName": "LineagePolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LineagePolicy {\n minConformanceLevel?: number | null;\n maxLineageDepth?: number | null;\n requiredHumanRootLiveness?: number | null;\n requiredAttestations: string[];\n bannedHumanRoots: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 35, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "lineagepolicy" }, { "name": "LineagePolicyEvaluator", "declarationName": "LineagePolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class LineagePolicyEvaluator {\n static evaluate(policy: LineagePolicy, verification: VerificationResult): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 43, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "lineagepolicyevaluator" }, { "name": "parseAmount", "declarationName": "parseAmount", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse a decimal amount string. Throws PolicyError on invalid input.", "tags": [], "signatures": [ { "code": "declare function parseAmount(s: string): number;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 22, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "parseamount" }, { "name": "SpendingPolicyEvaluator", "declarationName": "SpendingPolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class SpendingPolicyEvaluator {\n static evaluate(limits: SpendingLimits, tx: TransactionInfo, dailySpent: string): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 10, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "spendingpolicyevaluator" }, { "name": "TemporalPolicyEvaluator", "declarationName": "TemporalPolicyEvaluator", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class TemporalPolicyEvaluator {\n static evaluate(constraints: TemporalConstraints, now?: Date): PolicyDecision;\n static evaluateWithCooldown(constraints: TemporalConstraints, now: Date, lastOperation: Date | null): PolicyDecision;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 24, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "temporalpolicyevaluator" }, { "name": "TransactionInfo", "declarationName": "TransactionInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TransactionInfo {\n asset: string;\n amount: string;\n recipient: string;\n chain: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 4, "sha256": "64d3a7a214b8d1e5abdfe1de390f041ada9d2e829e4ef99a16badfb9d82f8e8e" } } ], "anchor": "transactioninfo" } ], "supportingDeclarations": [ { "name": "ActiveHours", "declarationName": "ActiveHours", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ActiveHours {\n startHour: number;\n endHour: number;\n timezone: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 126, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "activehours" }, { "name": "AuditInfo", "declarationName": "AuditInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuditInfo {\n auditId: string;\n timestamp: string;\n engine: string;\n policiesEvaluated: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 86, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "auditinfo" }, { "name": "LivenessStatus", "declarationName": "LivenessStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LivenessStatus = \"active\" | \"warning\" | \"stale\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 104, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "livenessstatus" }, { "name": "Obligation", "declarationName": "Obligation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Obligation {\n obligationType: ObligationType;\n params: Record;\n deadline?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 81, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligation" }, { "name": "ObligationType", "declarationName": "ObligationType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ObligationType = \"log\" | \"notify\" | \"approve\" | \"escrow\" | \"limit\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 80, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligationtype" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n allowed: boolean;\n reason?: string | null;\n obligations: Obligation[];\n auditInfo: AuditInfo;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 92, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policydecision" }, { "name": "RevocationStatus", "declarationName": "RevocationStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevocationStatus = \"active\" | \"revoked\" | \"suspended\" | \"expired\" | \"unknown\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 103, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "revocationstatus" }, { "name": "SpendingLimits", "declarationName": "SpendingLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SpendingLimits {\n maxAmount?: string | null;\n dailyVolume?: string | null;\n assetAllowlist: string[];\n recipientAllowlist: string[];\n approvalThreshold?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 137, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "spendinglimits" }, { "name": "TemporalConstraints", "declarationName": "TemporalConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TemporalConstraints {\n validFrom?: string | null;\n validUntil?: string | null;\n activeHours?: ActiveHours | null;\n cooldown?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 131, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "temporalconstraints" }, { "name": "VerificationResult", "declarationName": "VerificationResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerificationResult {\n did: string;\n signatureValid: boolean;\n lineageValid: boolean;\n lineageDepth: number;\n humanRoot?: string | null;\n revocationStatus: RevocationStatus;\n livenessStatus: LivenessStatus;\n conformanceLevel: number;\n warnings: string[];\n verifiedAt: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 105, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "verificationresult" } ], "coverage": { "discovered": 10, "documented": 10, "missing": [] } }, { "subpath": "./delegate", "importSpecifier": "@openagentid/aegis-sdk/delegate", "page": "/reference/typescript/aegis-sdk/delegate", "kind": "declarations", "conditions": { "types": "./dist/delegate/index.d.ts", "import": "./dist/delegate/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/delegate/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/delegate/index.js" } ], "exports": [ { "name": "createDelegationProof", "declarationName": "createDelegationProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a delegation proof by signing the delegation with the delegator's key.\n\nSteps per spec §9.7:\n 1. Construct delegation object (excluding proof field)\n 2. Canonicalize via JCS (RFC 8785)\n 3. Sign canonical bytes with delegator's delegation key (Ed25519)", "tags": [ { "name": "param", "text": "signingKey 32-byte raw Ed25519 signing key." }, { "name": "returns", "text": "Fully formed Delegation with attached cryptographic proof." } ], "signatures": [ { "code": "declare function createDelegationProof(params: {\n delegatorDid: string;\n delegateDid: string;\n scope: DelegationScope;\n expires?: string | null;\n signingKey: Uint8Array;\n verificationMethod: string;\n}): Delegation;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 33, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "createdelegationproof" }, { "name": "CreatedSessionKey", "declarationName": "CreatedSessionKey", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreatedSessionKey {\n sessionKey: SessionKey;\n ephemeralSigningKey: Uint8Array;\n ephemeralVerifyingKey: Uint8Array;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 58, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "createdsessionkey" }, { "name": "createSessionKey", "declarationName": "createSessionKey", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a session key (temporary, scoped, max 24h).\n\nGenerates a fresh Ed25519 keypair for the session and signs the\ngrant with the principal's identity key.", "tags": [], "signatures": [ { "code": "declare function createSessionKey(params: {\n principalDid: string;\n scope: DelegationScope;\n maxTransactions?: number | null;\n lifetimeMs: number;\n principalSigningKey: Uint8Array;\n verificationMethod: string;\n}): CreatedSessionKey;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 70, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "createsessionkey" }, { "name": "DelegationStore", "declarationName": "DelegationStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationStore {\n storeDelegation(delegation: Delegation): Promise;\n getDelegation(id: string): Promise;\n listByDelegator(delegatorDid: string, pagination?: Pagination): Promise;\n listByDelegate(delegateDid: string, pagination?: Pagination): Promise;\n deleteDelegation(id: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 33, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "delegationstore" }, { "name": "DelegationTree", "declarationName": "DelegationTree", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class DelegationTree {\n readonly maxDepth: number;\n constructor(maxDepth?: number);\n addDelegation(delegation: Delegation): void;\n getDelegationChain(delegateDid: string): Delegation[];\n effectiveScope(delegateDid: string): DelegationScope | null;\n depth(delegateDid: string): number;\n revoke(delegationId: string): string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 3, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "delegationtree" }, { "name": "InMemoryDelegationStore", "declarationName": "InMemoryDelegationStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryDelegationStore implements DelegationStore {\n storeDelegation(delegation: Delegation): Promise;\n getDelegation(id: string): Promise;\n listByDelegator(delegatorDid: string, pagination?: Pagination): Promise;\n listByDelegate(delegateDid: string, pagination?: Pagination): Promise;\n deleteDelegation(id: string): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 40, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "inmemorydelegationstore" }, { "name": "InMemoryRevocationStore", "declarationName": "InMemoryRevocationStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class InMemoryRevocationStore implements RevocationStore {\n revoke(delegationId: string): Promise;\n isRevoked(delegationId: string): Promise;\n revokeBatch(ids: readonly string[]): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 53, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "inmemoryrevocationstore" }, { "name": "intersectScopes", "declarationName": "intersectScopes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compute the intersection of two scopes.\n\n- Empty list = wildcard, take the other side\n- Otherwise, set intersection\n- For limits, take the most restrictive value", "tags": [], "signatures": [ { "code": "declare function intersectScopes(a: DelegationScope, b: DelegationScope): DelegationScope;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 19, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "intersectscopes" }, { "name": "isScopeSubset", "declarationName": "isScopeSubset", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if `child` scope is a subset of `parent` scope.\n\nEmpty fields on `parent` mean \"wildcard\" — they accept any child value.\nLimits on `child` must be at least as restrictive as the parent's.", "tags": [], "signatures": [ { "code": "declare function isScopeSubset(child: DelegationScope, parent: DelegationScope): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 11, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "isscopesubset" }, { "name": "RevocationRegistry", "declarationName": "RevocationRegistry", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class RevocationRegistry {\n revoke(delegationId: string): void;\n isRevoked(delegationId: string): boolean;\n revokeCascade(ids: readonly string[]): void;\n size(): number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 49, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "revocationregistry" }, { "name": "RevocationStore", "declarationName": "RevocationStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RevocationStore {\n revoke(delegationId: string): Promise;\n isRevoked(delegationId: string): Promise;\n revokeBatch(ids: readonly string[]): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/store-BqzEijTF.d.ts", "line": 48, "sha256": "df96e9d84ce3d0020eae95c2889bb51b6af1ac84224342bb55d02eee9040e5ab" } } ], "anchor": "revocationstore" }, { "name": "validateScope", "declarationName": "validateScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function validateScope(scope: DelegationScope): void;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 20, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "validatescope" }, { "name": "verifyDelegationProof", "declarationName": "verifyDelegationProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify a delegation proof against the delegator's public key.\n\nReconstructs the canonical form of the delegation (without the proof),\nthen verifies the Ed25519 signature in the proof's JWS field.", "tags": [], "signatures": [ { "code": "declare function verifyDelegationProof(delegation: Delegation, delegatorPublicKey: Uint8Array): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/delegate/index.d.ts", "line": 47, "sha256": "544dba5e7721e1f8aac9b7fe77257af3e02c54ef3c8fb02edd0d5f9fc825eb7c" } } ], "anchor": "verifydelegationproof" } ], "supportingDeclarations": [ { "name": "ActiveHours", "declarationName": "ActiveHours", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ActiveHours {\n startHour: number;\n endHour: number;\n timezone: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 126, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "activehours" }, { "name": "Delegation", "declarationName": "Delegation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Delegation {\n id: string;\n delegator: string;\n delegate: string;\n scope: DelegationScope;\n created: string;\n expires?: string | null;\n revocable: boolean;\n proof: DelegationProof;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 157, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegation" }, { "name": "DelegationProof", "declarationName": "DelegationProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationProof {\n type: \"AegisDelegationProof2025\";\n verificationMethod: string;\n created: string;\n jws: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 151, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationproof" }, { "name": "DelegationScope", "declarationName": "DelegationScope", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationScope {\n actions: string[];\n resources: string[];\n chains: string[];\n limits?: SpendingLimits | null;\n temporal?: TemporalConstraints | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 144, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "delegationscope" }, { "name": "Pagination", "declarationName": "Pagination", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Pagination {\n limit: number;\n offset: number;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 204, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "pagination" }, { "name": "SessionKey", "declarationName": "SessionKey", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionKey {\n sessionKey: string;\n principal: string;\n scope: DelegationScope;\n maxTransactions?: number | null;\n created: string;\n expires: string;\n proof: DelegationProof;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 167, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "sessionkey" }, { "name": "SpendingLimits", "declarationName": "SpendingLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SpendingLimits {\n maxAmount?: string | null;\n dailyVolume?: string | null;\n assetAllowlist: string[];\n recipientAllowlist: string[];\n approvalThreshold?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 137, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "spendinglimits" }, { "name": "TemporalConstraints", "declarationName": "TemporalConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TemporalConstraints {\n validFrom?: string | null;\n validUntil?: string | null;\n activeHours?: ActiveHours | null;\n cooldown?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 131, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "temporalconstraints" } ], "coverage": { "discovered": 13, "documented": 13, "missing": [] } }, { "subpath": "./wallet", "importSpecifier": "@openagentid/aegis-sdk/wallet", "page": "/reference/typescript/aegis-sdk/wallet", "kind": "declarations", "conditions": { "types": "./dist/wallet/index.d.ts", "import": "./dist/wallet/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/wallet/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/wallet/index.js" } ], "exports": [ { "name": "AddressDeriver", "declarationName": "AddressDeriver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class AddressDeriver {\n static derivationPath(chain: Chain, account: number, index: number): string;\n static deriveAddress(chain: Chain, publicKeyBytes: Uint8Array): WalletAddress;\n static deriveAll(publicKeyBytes: Uint8Array, chains: readonly Chain[]): WalletAddress[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/wallet/index.d.ts", "line": 11, "sha256": "b9fcb67088060fec0eefaebce36a7aca2f6490dc507858d671ce6d8c084a774d" } } ], "anchor": "addressderiver" }, { "name": "AuthorizedTransaction", "declarationName": "AuthorizedTransaction", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuthorizedTransaction {\n transaction: Transaction;\n signature: Uint8Array;\n fulfilledObligations: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 50, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "authorizedtransaction" }, { "name": "DirectSigner", "declarationName": "DirectSigner", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Direct signing backend using a single Ed25519 key.\n\nThe signing key is stored in memory; callers should treat the instance\nas sensitive material and zeroize when done.", "tags": [], "signatures": [ { "code": "declare class DirectSigner implements SigningBackend {\n constructor(signingKey: Uint8Array);\n sign(request: SigningRequest): Promise;\n publicKey(): Uint8Array;\n mode(): SigningMode;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 24, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "directsigner" }, { "name": "makeTransaction", "declarationName": "makeTransaction", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function makeTransaction(params: {\n fromDid: string;\n to: string;\n chain: string;\n data: Uint8Array;\n value?: string | null;\n}): Transaction;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 43, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "maketransaction" }, { "name": "SigningBackend", "declarationName": "SigningBackend", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SigningBackend {\n sign(request: SigningRequest): Promise;\n publicKey(): Uint8Array;\n mode(): SigningMode;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 13, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "signingbackend" }, { "name": "SigningRequest", "declarationName": "SigningRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SigningRequest {\n message: Uint8Array;\n signerDid: string;\n chain?: Chain | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 3, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "signingrequest" }, { "name": "SigningResult", "declarationName": "SigningResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SigningResult {\n signature: Uint8Array;\n publicKey: Uint8Array;\n mode: SigningMode;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 8, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "signingresult" }, { "name": "Transaction", "declarationName": "Transaction", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Transaction {\n txId: string;\n fromDid: string;\n to: string;\n chain: string;\n data: Uint8Array;\n value?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 35, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "transaction" }, { "name": "TransactionPipeline", "declarationName": "TransactionPipeline", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Full transaction authorization pipeline per AEGIS Spec §10.4.\n\nEnforces a strict 5-step process; if any step fails the transaction\nis NOT signed.", "tags": [], "signatures": [ { "code": "declare class TransactionPipeline {\n constructor(signer: SigningBackend);\n authorizeAndSign(tx: Transaction, auth: AuthContext, policyDecision: PolicyDecision): Promise;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 61, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "transactionpipeline" }, { "name": "verifySignature", "declarationName": "verifySignature", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify an Ed25519 signature against a message and public key.", "tags": [], "signatures": [ { "code": "declare function verifySignature(publicKey: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/pipeline-u2tQgstP.d.ts", "line": 33, "sha256": "9871150df642bf11ab071672fff92672ea5565d44129e5efd2e9bc819c12919d" } } ], "anchor": "verifysignature" }, { "name": "WalletAddress", "declarationName": "WalletAddress", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface WalletAddress {\n chain: Chain;\n address: string;\n derivationPath: string;\n publicKeyHex: string;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/wallet/index.d.ts", "line": 5, "sha256": "b9fcb67088060fec0eefaebce36a7aca2f6490dc507858d671ce6d8c084a774d" } } ], "anchor": "walletaddress" } ], "supportingDeclarations": [ { "name": "AuditInfo", "declarationName": "AuditInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuditInfo {\n auditId: string;\n timestamp: string;\n engine: string;\n policiesEvaluated: string[];\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 86, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "auditinfo" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The output of successful authentication (AEGIS Spec §7.1).", "tags": [], "signatures": [ { "code": "interface AuthContext {\n provider: string;\n subject: string;\n did?: string | null;\n sessionId?: string | null;\n expiresAt?: string | null;\n claims: Record;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 13, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "authcontext" }, { "name": "Chain", "declarationName": "Chain", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type Chain = \"ethereum\" | \"polygon\" | \"arbitrum\" | \"optimism\" | \"base\" | \"solana\" | \"bitcoin\" | \"cosmos\" | \"osmosis\" | \"aptos\" | \"sui\" | \"starknet\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 177, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "chain" }, { "name": "Obligation", "declarationName": "Obligation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Obligation {\n obligationType: ObligationType;\n params: Record;\n deadline?: string | null;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 81, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligation" }, { "name": "ObligationType", "declarationName": "ObligationType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ObligationType = \"log\" | \"notify\" | \"approve\" | \"escrow\" | \"limit\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 80, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "obligationtype" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n allowed: boolean;\n reason?: string | null;\n obligations: Obligation[];\n auditInfo: AuditInfo;\n}", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 92, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "policydecision" }, { "name": "SigningMode", "declarationName": "SigningMode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SigningMode = \"direct\" | \"mpc\" | \"tee\" | \"external\";", "source": { "package": "@openagentid/aegis-sdk", "version": "0.1.1", "file": "dist/types-Ck8QCcs2.d.ts", "line": 183, "sha256": "77bea2b7b67c9c5e2d0c0058759dff72633f59b7d7e41d05c586f0660b77fbb2" } } ], "anchor": "signingmode" } ], "coverage": { "discovered": 11, "documented": 11, "missing": [] } } ] }, { "name": "@openagentid/anchor-eas", "version": "0.1.1", "status": "published", "notes": [ "Optional EAS anchoring adapter. Read calls require configured chain services; publishing requires an authorized signer and is a real on-chain transaction." ], "tarball": "https://registry.npmjs.org/@openagentid/anchor-eas/-/anchor-eas-0.1.1.tgz", "integrity": "sha512-+K5GDijPBfFDX6nbA4Oh88/CiiAva2YbT4jD9ERI3Bi/JLKMQAtGNaqBKgM6mSFnddSalsiErs/KN5VS4Ml6yw==", "packageJsonSha256": "3b64b4adcf033b9f39f3aa271d067acde8708f384561bb08e47b632c138b3b7a", "page": "/reference/typescript/anchor-eas", "engines": {}, "dependencies": { "@ethereum-attestation-service/eas-sdk": "^2.4.0", "@noble/hashes": "^1.4.0", "viem": "^2.21.0", "zod": "^3.23.8" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/anchor-eas", "page": "/reference/typescript/anchor-eas", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "AnchorData", "declarationName": "AnchorData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The attestation's decoded data fields.", "tags": [], "signatures": [ { "code": "interface AnchorData {\n did: string;\n kind: string;\n status: string;\n metadataCommitment: string;\n anchoredAtBlock: bigint;\n}", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 27, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "anchordata" }, { "name": "AnchorRecord", "declarationName": "AnchorRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The anchor record an anchor backend reports for a root.", "tags": [], "signatures": [ { "code": "interface AnchorRecord {\n did: string;\n status: string;\n anchoredAtBlock: number;\n metadataCommitment: string;\n}", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 35, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "anchorrecord" }, { "name": "didRecipient", "declarationName": "didRecipient", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derive the deterministic recipient address for a subject DID.", "tags": [], "signatures": [ { "code": "declare function didRecipient(did: string): string;", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 47, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "didrecipient" }, { "name": "EasAnchorPublisher", "declarationName": "EasAnchorPublisher", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The EAS publisher: writes anchors as attestations via the maintained SDK.", "tags": [], "signatures": [ { "code": "declare class EasAnchorPublisher {\n constructor(config: EasPublisherConfig);\n publishAnchor(data: AnchorData): Promise;\n revoke(uid: string): Promise;\n}", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 88, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "easanchorpublisher" }, { "name": "EasAnchorResolver", "declarationName": "EasAnchorResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The EAS resolver: reads lineage authority from attestations.", "tags": [], "signatures": [ { "code": "declare class EasAnchorResolver {\n constructor(config: EasResolverConfig);\n checkRevocation(did: string): Promise;\n getRoot(did: string, kind: \"hmr\" | \"mhr\" | \"enr\"): Promise;\n currentFinalizedBlock(): Promise;\n}", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 64, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "easanchorresolver" }, { "name": "EasPublisherConfig", "declarationName": "EasPublisherConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Signer shape the publisher needs: a viem-compatible account plus provider.", "tags": [], "signatures": [ { "code": "interface EasPublisherConfig {\n schemaUid: string;\n easContractAddress: string;\n signer: unknown;\n}", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 79, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "easpublisherconfig" }, { "name": "EasResolverConfig", "declarationName": "EasResolverConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for the resolver.", "tags": [], "signatures": [ { "code": "interface EasResolverConfig {\n schemaUid: string;\n graphqlUrl: string;\n rpcUrl: string;\n confirmationDepth?: number;\n fetch?: typeof fetch;\n}", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 51, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "easresolverconfig" }, { "name": "encodeAnchorData", "declarationName": "encodeAnchorData", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "ABI-encode the anchor data (same layout as the Rust adapter).", "tags": [], "signatures": [ { "code": "declare function encodeAnchorData(data: AnchorData): Uint8Array;", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 49, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "encodeanchordata" }, { "name": "RevocationStatus", "declarationName": "RevocationStatus", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The revocation status of a subject.", "tags": [], "signatures": [ { "code": "interface RevocationStatus {\n revoked: boolean;\n reasonCommitment?: string;\n}", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 42, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "revocationstatus" }, { "name": "SCHEMA_STRING", "declarationName": "SCHEMA_STRING", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The OAS lineage-root attestation schema registered on EAS.", "tags": [], "signatures": [ { "code": "declare const SCHEMA_STRING = \"string did,string kind,string status,string metadataCommitment,uint64 anchoredAtBlock\";", "source": { "package": "@openagentid/anchor-eas", "version": "0.1.1", "file": "dist/index.d.ts", "line": 25, "sha256": "9066b384077a95a9600f51578cd6239e07937d49dda05b04679cdde12f3d1545" } } ], "anchor": "schema_string" } ], "supportingDeclarations": [], "coverage": { "discovered": 10, "documented": 10, "missing": [] } } ] }, { "name": "@openagentid/arsenal-sdk", "version": "0.1.1", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/arsenal-sdk/-/arsenal-sdk-0.1.1.tgz", "integrity": "sha512-bqdIp1hFYeffqXDaTpq/JMJune81cNwrj23kaUl1OoXjp97Bf8kX47/EaOjCX7oLAbTk69SgD7q2p8nrMNeIeQ==", "packageJsonSha256": "3aa48974ea6883e09c105ef831f66048373746150c380737f82b82926dff42ed", "page": "/reference/typescript/arsenal-sdk", "engines": { "node": ">=20" }, "dependencies": { "uuid": "^11.0.3", "zod": "^3.23.8" }, "peerDependencies": { "@openagentid/crypto-wasm": "*" }, "peerDependenciesMeta": { "@openagentid/crypto-wasm": { "optional": true } }, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/arsenal-sdk", "page": "/reference/typescript/arsenal-sdk", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" }, { "conditions": [ "require" ], "path": "./dist/index.cjs" } ], "exports": [ { "name": "addPolicyRule", "declarationName": "addPolicyRule", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Append a rule to a policy, returning a new document.", "tags": [], "signatures": [ { "code": "declare function addPolicyRule(doc: PolicyDocument, rule: PolicyRule): PolicyDocument;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 112, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "addpolicyrule" }, { "name": "AgentCapabilityToken", "declarationName": "AgentCapabilityToken", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Immutable Agent Capability Token. Wraps a set of claims and an optional\nsignature, and provides validation + CBOR (de)serialization.", "tags": [], "signatures": [ { "code": "declare class AgentCapabilityToken {\n readonly claims: TokenClaims;\n readonly signature: TokenSignature | undefined;\n static fromClaims(claims: TokenClaims): AgentCapabilityToken;\n static fromClaimsAndSignature(claims: TokenClaims, signature: TokenSignature): AgentCapabilityToken;\n get id(): string;\n get subject(): string;\n get audience(): string;\n get scopes(): ScopeSet;\n isExpired(now?: Date): boolean;\n isNotYetValid(now?: Date): boolean;\n isTimeValid(now?: Date): boolean;\n remainingTtlMs(now?: Date): number;\n isSigned(): boolean;\n validateStructure(now?: Date): void;\n toCbor(): Uint8Array;\n claimsToCbor(): Uint8Array;\n toBase64Url(): string;\n static fromCbor(bytes: Uint8Array): AgentCapabilityToken;\n static fromBase64Url(s: string): AgentCapabilityToken;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 75, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "agentcapabilitytoken" }, { "name": "AgentId", "declarationName": "AgentId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Agent identifier (UUID v4).", "tags": [], "signatures": [ { "code": "declare class AgentId {\n static fromUuid(uuid: string): AgentId;\n static generate(): AgentId;\n asUuid(): string;\n toString(): string;\n toJSON(): string;\n equals(other: AgentId): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 184, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "agentid" }, { "name": "AgentIdentity", "declarationName": "AgentIdentity", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class AgentIdentity {\n static create(tenantId: TenantId, name: string, publicKeyFingerprint: KeyFingerprint): AgentIdentity;\n get id(): AgentId;\n get publicKeyFingerprint(): KeyFingerprint;\n get tenantId(): TenantId;\n get name(): string;\n get isActive(): boolean;\n get tags(): readonly string[];\n isValid(now?: Date): boolean;\n deactivate(): AgentIdentity;\n withExpiresAt(expiresAt: Date): AgentIdentity;\n withTag(tag: string): AgentIdentity;\n toJSON(): {\n id: string;\n public_key_fingerprint: string;\n tenant_id: string;\n name: string;\n created_at: string;\n expires_at: string | null;\n is_active: boolean;\n tags: readonly string[];\n };\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 237, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "agentidentity" }, { "name": "AgentIdentityData", "declarationName": "AgentIdentityData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Agent identity — the public cryptographic identity of an agent.\n\nContains only public key material — the private key is never stored.", "tags": [], "signatures": [ { "code": "interface AgentIdentityData {\n id: AgentId;\n publicKeyFingerprint: KeyFingerprint;\n tenantId: TenantId;\n name: string;\n createdAt: string;\n expiresAt: string | null;\n isActive: boolean;\n tags: readonly string[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 227, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "agentidentitydata" }, { "name": "allowDelegation", "declarationName": "allowDelegation", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Allow up to `depth` levels of delegation to any agent.", "tags": [], "signatures": [ { "code": "declare function allowDelegation(depth: number): DelegationConstraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 392, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "allowdelegation" }, { "name": "ApiErrorResponse", "declarationName": "ApiErrorResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ApiErrorResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 427, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "apierrorresponse" }, { "name": "ApiErrorResponseSchema", "declarationName": "ApiErrorResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ApiErrorResponseSchema: z.ZodObject<{\n code: z.ZodNumber;\n message: z.ZodString;\n correlation_id: z.ZodOptional;\n retry_after: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n code: z.ZodNumber;\n message: z.ZodString;\n correlation_id: z.ZodOptional;\n retry_after: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n code: z.ZodNumber;\n message: z.ZodString;\n correlation_id: z.ZodOptional;\n retry_after: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 411, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "apierrorresponseschema" }, { "name": "ArsenalClient", "declarationName": "ArsenalClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "High-level ARSENAL client. Combines session management, capability\nrequests, proxy calls, and consent operations.\n\nConstruct with `ArsenalClient.create({...})` and then:\n 1. `await client.startSession()`\n 2. `await client.requestCapabilityForScopes([...], 300)`\n 3. `await client.proxyHttp({...})` or other proxy calls\n 4. `await client.endSession()` when done", "tags": [], "signatures": [ { "code": "declare class ArsenalClient {\n static create(opts: ArsenalClientConfig): ArsenalClient;\n get identity(): AgentIdentity;\n get broker(): BrokerClient | undefined;\n startSession(): Promise;\n endSession(): Promise;\n revokeSession(): Promise;\n hasActiveSession(): boolean;\n sessionStats(): SessionStats;\n currentToken(): AgentCapabilityToken | undefined;\n requestCapability(request: CapabilityRequest): Promise;\n requestCapabilityForScopes(scopes: readonly string[], ttlSeconds: number): Promise;\n renewCurrentCapability(): Promise;\n proxyHttp(request: ProxyRequest): Promise;\n callToolSimple(_toolId: string, _method: string, params: unknown, opts?: {\n scopes?: readonly string[];\n ttlSeconds?: number;\n }): Promise;\n approveConsent(payload: ConsentApprovalPayload): Promise;\n denyConsent(payload: ConsentDenialPayload): Promise;\n revokeConsent(payload: ConsentRevocationPayload): Promise;\n listConsents(): Promise;\n requestSecret(secretId: string, capabilityToken: string, version?: number): Promise;\n verifyToken(tokenBase64: string): Promise<{\n valid: boolean;\n subject?: string;\n audience?: string;\n scopes?: string[];\n }>;\n revokeToken(tokenId: string, reason?: string): Promise;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 132, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "arsenalclient" }, { "name": "ArsenalClientConfig", "declarationName": "ArsenalClientConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for the Arsenal client.", "tags": [], "signatures": [ { "code": "interface ArsenalClientConfig {\n identity: AgentIdentity;\n broker?: BrokerClientOptions;\n sessionConfig?: SessionConfig;\n autoRenew?: boolean;\n issuer?: string;\n defaultAudience?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 108, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "arsenalclientconfig" }, { "name": "ArsenalError", "declarationName": "ArsenalError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Main error type for ARSENAL operations.\n\nExtends the native `Error` class so it interoperates with standard JS error\nhandling while carrying structured code/correlation/context fields.", "tags": [], "signatures": [ { "code": "declare class ArsenalError extends Error {\n readonly name = \"ArsenalError\";\n readonly code: number;\n readonly correlationId: string | undefined;\n readonly context: ErrorContext | undefined;\n constructor(code: number, message: string, options?: {\n correlationId?: string;\n context?: ErrorContext;\n cause?: unknown;\n });\n toString(): string;\n toJSON(): {\n code: number;\n message: string;\n correlation_id?: string;\n context?: ErrorContext;\n };\n withCorrelationId(id: string): ArsenalError;\n withContext(context: ErrorContext): ArsenalError;\n static authenticationFailed(): ArsenalError;\n static tokenExpired(): ArsenalError;\n static tokenSignatureInvalid(): ArsenalError;\n static tokenRevoked(): ArsenalError;\n static scopeExceeded(): ArsenalError;\n static insufficientPermissions(requiredScope: string): ArsenalError;\n static policyDenied(policyId: string): ArsenalError;\n static rateLimitExceeded(retryAfterSecs?: number): ArsenalError;\n static secretNotFound(): ArsenalError;\n static validationFailed(field: string, reason: string): ArsenalError;\n static internal(): ArsenalError;\n static sessionExpired(): ArsenalError;\n static proxyDestinationViolation(domain: string): ArsenalError;\n static ssrfBlocked(): ArsenalError;\n static templateVariableNotFound(variable: string): ArsenalError;\n static invalidTemplateVariable(name: string): ArsenalError;\n static consentRequired(): ArsenalError;\n static consentDenied(): ArsenalError;\n static fingerprintMismatch(): ArsenalError;\n static configurationError(component: string): ArsenalError;\n static cryptoOperationFailed(): ArsenalError;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 104, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "arsenalerror" }, { "name": "AuditEvent", "declarationName": "AuditEvent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuditEvent {\n id: string;\n timestamp: string;\n kind: AuditEventKindValue;\n severity: AuditSeverityValue;\n tenant_id: string;\n agent_id?: string;\n session_id?: string;\n token_id?: string;\n outcome: AuditOutcomeValue;\n description: string;\n metadata: Readonly>;\n client_ip?: string;\n user_agent?: string;\n request_id?: string;\n previous_hash?: Uint8Array;\n event_hash?: Uint8Array;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 485, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditevent" }, { "name": "AuditEventKind", "declarationName": "AuditEventKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Kind of audit event.", "tags": [], "signatures": [ { "code": "declare const AuditEventKind: {\n readonly AgentAuthenticated: \"agent_authenticated\";\n readonly AuthenticationFailed: \"authentication_failed\";\n readonly SessionStarted: \"session_started\";\n readonly SessionEnded: \"session_ended\";\n readonly CapabilityRequested: \"capability_requested\";\n readonly CapabilityGranted: \"capability_granted\";\n readonly CapabilityDenied: \"capability_denied\";\n readonly TokenRevoked: \"token_revoked\";\n readonly SecretRead: \"secret_read\";\n readonly SecretRotated: \"secret_rotated\";\n readonly ProxyRequest: \"proxy_request\";\n readonly ProxyDenied: \"proxy_denied\";\n readonly ConsentRequested: \"consent_requested\";\n readonly ConsentApproved: \"consent_approved\";\n readonly ConsentDenied: \"consent_denied\";\n readonly ConsentRevoked: \"consent_revoked\";\n readonly PolicyEvaluated: \"policy_evaluated\";\n readonly PolicyViolation: \"policy_violation\";\n readonly ConfigChanged: \"config_changed\";\n readonly KeyRotated: \"key_rotated\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 462, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditeventkind" }, { "name": "AuditEventKindValue", "declarationName": "AuditEventKindValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuditEventKindValue = (typeof AuditEventKind)[keyof typeof AuditEventKind];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 484, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditeventkindvalue" }, { "name": "AuditOutcome", "declarationName": "AuditOutcome", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const AuditOutcome: {\n readonly Success: \"success\";\n readonly Failure: \"failure\";\n readonly Partial: \"partial\";\n readonly Pending: \"pending\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 454, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditoutcome" }, { "name": "AuditOutcomeValue", "declarationName": "AuditOutcomeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuditOutcomeValue = (typeof AuditOutcome)[keyof typeof AuditOutcome];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 460, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditoutcomevalue" }, { "name": "AuditSeverity", "declarationName": "AuditSeverity", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Audit event types. The hash chain integrity checks are performed by the\nbroker, but the type shape is defined here for parity with\n`arsenal_core::audit`.", "tags": [], "signatures": [ { "code": "declare const AuditSeverity: {\n readonly Info: \"info\";\n readonly Warning: \"warning\";\n readonly Error: \"error\";\n readonly Critical: \"critical\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 447, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditseverity" }, { "name": "AuditSeverityValue", "declarationName": "AuditSeverityValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuditSeverityValue = (typeof AuditSeverity)[keyof typeof AuditSeverity];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 453, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditseverityvalue" }, { "name": "base64Decode", "declarationName": "base64Decode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a base64 string (standard or URL alphabet, with or without padding).", "tags": [], "signatures": [ { "code": "declare function base64Decode(s: string): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 534, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64decode" }, { "name": "base64Encode", "declarationName": "base64Encode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes to base64 (standard alphabet, no padding).", "tags": [], "signatures": [ { "code": "declare function base64Encode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 530, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64encode" }, { "name": "base64UrlDecode", "declarationName": "base64UrlDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a base64url string. Same as `base64Decode` for convenience.", "tags": [], "signatures": [ { "code": "declare function base64UrlDecode(s: string): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 536, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64urldecode" }, { "name": "base64UrlEncode", "declarationName": "base64UrlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes to base64url (URL-safe alphabet, no padding).", "tags": [], "signatures": [ { "code": "declare function base64UrlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 532, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64urlencode" }, { "name": "BindingType", "declarationName": "BindingType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Constraints that bind ACTs to specific contexts.\n\nTokens can be restricted to a specific device, session, origin, IP range,\ntime window, or environment. Constraints are evaluated at the broker and\nat the proxy boundary.", "tags": [], "signatures": [ { "code": "declare const BindingType: {\n readonly Required: \"required\";\n readonly Preferred: \"preferred\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 8, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtype" }, { "name": "BindingTypeValue", "declarationName": "BindingTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type BindingTypeValue = (typeof BindingType)[keyof typeof BindingType];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 12, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtypevalue" }, { "name": "BrokerClient", "declarationName": "BrokerClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Broker HTTP client.\n\nAll methods throw `ArsenalError` on failure. Response bodies are\nvalidated with Zod schemas at the boundary.", "tags": [], "signatures": [ { "code": "declare class BrokerClient {\n constructor(opts: BrokerClientOptions);\n health(): Promise;\n requestCapability(payload: CapabilityRequestPayload): Promise;\n requestSecret(payload: SecretRequestPayload): Promise;\n revokeToken(tokenId: string, reason?: string): Promise;\n verifyToken(token: string): Promise;\n proxyRequest(req: ProxyRequest, opts?: {\n fingerprintHex?: string;\n }): Promise;\n approveConsent(payload: ConsentApprovalPayload): Promise;\n denyConsent(payload: ConsentDenialPayload): Promise;\n revokeConsent(payload: ConsentRevocationPayload): Promise;\n listConsents(agentDid: string): Promise;\n static decodeCapabilityToken(response: CapabilityResponsePayload): AgentCapabilityToken;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 453, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "brokerclient" }, { "name": "BrokerClientOptions", "declarationName": "BrokerClientOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for the broker client.", "tags": [], "signatures": [ { "code": "interface BrokerClientOptions {\n baseUrl: string;\n timeoutMs?: number;\n defaultHeaders?: Record;\n fetch?: typeof globalThis.fetch;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 437, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "brokerclientoptions" }, { "name": "buildTokenClaims", "declarationName": "buildTokenClaims", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate and build a fresh set of token claims.", "tags": [], "signatures": [ { "code": "declare function buildTokenClaims(opts: TokenClaimsBuildOptions): TokenClaims;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 70, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "buildtokenclaims" }, { "name": "canDelegateTo", "declarationName": "canDelegateTo", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check whether a delegation to the given agent id is permitted.", "tags": [], "signatures": [ { "code": "declare function canDelegateTo(constraints: DelegationConstraints, agentId: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 394, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "candelegateto" }, { "name": "canTransitionTo", "declarationName": "canTransitionTo", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function canTransitionTo(from: SessionStateValue, to: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 427, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "cantransitionto" }, { "name": "CapabilityHandle", "declarationName": "CapabilityHandle", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Handle wrapping an issued capability token. Provides convenient\ninspection methods — the token itself is immutable.", "tags": [], "signatures": [ { "code": "declare class CapabilityHandle {\n readonly token: AgentCapabilityToken;\n constructor(token: AgentCapabilityToken);\n get tokenId(): string;\n get audience(): string;\n scopes(): ScopeSet;\n isExpired(now?: Date): boolean;\n remainingTtlMs(now?: Date): number;\n encode(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 39, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "capabilityhandle" }, { "name": "CapabilityRequest", "declarationName": "CapabilityRequest", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Builder for capability requests.", "tags": [], "signatures": [ { "code": "declare class CapabilityRequest {\n static create(): CapabilityRequest;\n scope(scope: string): CapabilityRequest;\n scopes(scopes: readonly string[]): CapabilityRequest;\n ttlSeconds(ttl: number): CapabilityRequest;\n audience(audience: string): CapabilityRequest;\n constraints(constraints: Constraints): CapabilityRequest;\n getScopes(): ScopeSet;\n getTtl(): number;\n getAudience(): string;\n getConstraints(): Constraints | undefined;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 19, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "capabilityrequest" }, { "name": "CapabilityRequestPayload", "declarationName": "CapabilityRequestPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CapabilityRequestPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 65, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityrequestpayload" }, { "name": "CapabilityRequestPayloadSchema", "declarationName": "CapabilityRequestPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CapabilityRequestPayloadSchema: z.ZodObject<{\n scopes: z.ZodArray;\n ttl_seconds: z.ZodOptional;\n audience: z.ZodString;\n constraints: z.ZodOptional>;\n device_id: z.ZodOptional;\n }, \"strict\", z.ZodTypeAny, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n }, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n }>>;\n pop_key_fingerprint: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n scopes: string[];\n audience: string;\n ttl_seconds?: number | undefined;\n constraints?: {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n } | undefined;\n pop_key_fingerprint?: string | undefined;\n}, {\n scopes: string[];\n audience: string;\n ttl_seconds?: number | undefined;\n constraints?: {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n } | undefined;\n pop_key_fingerprint?: string | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 26, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityrequestpayloadschema" }, { "name": "CapabilityResponsePayload", "declarationName": "CapabilityResponsePayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CapabilityResponsePayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 82, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityresponsepayload" }, { "name": "CapabilityResponsePayloadSchema", "declarationName": "CapabilityResponsePayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CapabilityResponsePayloadSchema: z.ZodObject<{\n token_id: z.ZodString;\n token: z.ZodString;\n expires_at: z.ZodString;\n granted_scopes: z.ZodArray;\n}, \"strict\", z.ZodTypeAny, {\n token: string;\n token_id: string;\n expires_at: string;\n granted_scopes: string[];\n}, {\n token: string;\n token_id: string;\n expires_at: string;\n granted_scopes: string[];\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 66, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityresponsepayloadschema" }, { "name": "compareOperator", "declarationName": "compareOperator", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compare two strings using a condition operator.", "tags": [], "signatures": [ { "code": "declare function compareOperator(operator: ConditionOperatorValue, actual: string, expected: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 38, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "compareoperator" }, { "name": "CompositeRateLimiter", "declarationName": "CompositeRateLimiter", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Composite rate limiter combining multiple time windows + concurrent cap.\n\nUse `acquire()` which returns a release function — call it when the\nrequest completes (e.g. in a `finally`) to decrement the concurrent\ncounter. If any individual limit rejects, already-consumed slots are\nrolled back.", "tags": [], "signatures": [ { "code": "declare class CompositeRateLimiter {\n constructor(limits: RateLimits);\n acquire(): () => void;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 175, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "compositeratelimiter" }, { "name": "ConditionOperator", "declarationName": "ConditionOperator", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConditionOperator: {\n readonly Equals: \"equals\";\n readonly NotEquals: \"not_equals\";\n readonly Contains: \"contains\";\n readonly StartsWith: \"starts_with\";\n readonly EndsWith: \"ends_with\";\n readonly Matches: \"matches\";\n readonly In: \"in\";\n readonly NotIn: \"not_in\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 25, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "conditionoperator" }, { "name": "ConditionOperatorValue", "declarationName": "ConditionOperatorValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConditionOperatorValue = (typeof ConditionOperator)[keyof typeof ConditionOperator];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 35, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "conditionoperatorvalue" }, { "name": "ConsentApprovalPayload", "declarationName": "ConsentApprovalPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentApprovalPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 330, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentapprovalpayload" }, { "name": "ConsentApprovalPayloadSchema", "declarationName": "ConsentApprovalPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentApprovalPayloadSchema: z.ZodObject<{\n agent_did: z.ZodString;\n human_root_did: z.ZodString;\n variables: z.ZodArray;\n destination_domains: z.ZodArray;\n scopes: z.ZodArray;\n granted_by: z.ZodString;\n expires_in_seconds: z.ZodOptional;\n signature: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n signature: string;\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n granted_by: string;\n expires_in_seconds?: number | undefined;\n}, {\n signature: string;\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n granted_by: string;\n expires_in_seconds?: number | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 302, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentapprovalpayloadschema" }, { "name": "ConsentDenialPayload", "declarationName": "ConsentDenialPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentDenialPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 385, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentdenialpayload" }, { "name": "ConsentDenialPayloadSchema", "declarationName": "ConsentDenialPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentDenialPayloadSchema: z.ZodObject<{\n agent_did: z.ZodString;\n human_root_did: z.ZodString;\n variables: z.ZodArray;\n destination_domains: z.ZodArray;\n scopes: z.ZodArray;\n}, \"strict\", z.ZodTypeAny, {\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n}, {\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 366, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentdenialpayloadschema" }, { "name": "ConsentPolicy", "declarationName": "ConsentPolicy", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentPolicy: {\n readonly PerVariable: \"per_variable\";\n readonly PerProvider: \"per_provider\";\n readonly PerAgent: \"per_agent\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 118, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentpolicy" }, { "name": "ConsentPolicyValue", "declarationName": "ConsentPolicyValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentPolicyValue = (typeof ConsentPolicy)[keyof typeof ConsentPolicy];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 123, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentpolicyvalue" }, { "name": "ConsentRecord", "declarationName": "ConsentRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ConsentRecord {\n consent_id: string;\n tenant_id: string;\n agent_did: string;\n human_root_did: string;\n variables: readonly string[];\n destination_domains: readonly string[];\n scopes: readonly string[];\n granted_by: string;\n granted_at: string;\n expires_at: string;\n signature: Uint8Array;\n revocable: boolean;\n revoked: boolean;\n revoked_at?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 124, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecord" }, { "name": "consentRecordCoversDomain", "declarationName": "consentRecordCoversDomain", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the record covers the given destination domain (case-insensitive).", "tags": [], "signatures": [ { "code": "declare function consentRecordCoversDomain(record: ConsentRecord, domain: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 146, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordcoversdomain" }, { "name": "consentRecordCoversVariable", "declarationName": "consentRecordCoversVariable", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the record covers the given variable name.", "tags": [], "signatures": [ { "code": "declare function consentRecordCoversVariable(record: ConsentRecord, variable: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 144, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordcoversvariable" }, { "name": "consentRecordIsValid", "declarationName": "consentRecordIsValid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validity check (not revoked and not expired).", "tags": [], "signatures": [ { "code": "declare function consentRecordIsValid(record: ConsentRecord, now?: Date): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 142, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordisvalid" }, { "name": "ConsentRecordPayload", "declarationName": "ConsentRecordPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentRecordPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 365, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrecordpayload" }, { "name": "ConsentRecordPayloadSchema", "declarationName": "ConsentRecordPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentRecordPayloadSchema: z.ZodObject<{\n consent_id: z.ZodString;\n agent_did: z.ZodString;\n human_root_did: z.ZodOptional;\n variables: z.ZodArray;\n destination_domains: z.ZodOptional>;\n scopes: z.ZodOptional>;\n granted_by: z.ZodOptional;\n granted_at: z.ZodString;\n expires_at: z.ZodString;\n revoked: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n consent_id: z.ZodString;\n agent_did: z.ZodString;\n human_root_did: z.ZodOptional;\n variables: z.ZodArray;\n destination_domains: z.ZodOptional>;\n scopes: z.ZodOptional>;\n granted_by: z.ZodOptional;\n granted_at: z.ZodString;\n expires_at: z.ZodString;\n revoked: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n consent_id: z.ZodString;\n agent_did: z.ZodString;\n human_root_did: z.ZodOptional;\n variables: z.ZodArray;\n destination_domains: z.ZodOptional>;\n scopes: z.ZodOptional>;\n granted_by: z.ZodOptional;\n granted_at: z.ZodString;\n expires_at: z.ZodString;\n revoked: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 331, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrecordpayloadschema" }, { "name": "consentRecordSigningBytes", "declarationName": "consentRecordSigningBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Canonical CBOR encoding of the signable subset (excludes signature,\nrevoked, revoked_at). This is the byte sequence a human root key signs\nwith Ed25519 to produce `record.signature`.", "tags": [], "signatures": [ { "code": "declare function consentRecordSigningBytes(record: ConsentRecord): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 154, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordsigningbytes" }, { "name": "ConsentRequest", "declarationName": "ConsentRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ConsentRequest {\n request_id: string;\n agent_did: string;\n human_root_did: string;\n variables: readonly string[];\n destination_domains: readonly string[];\n scopes: readonly string[];\n created_at: string;\n expires_at: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 155, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrequest" }, { "name": "consentRequestIsExpired", "declarationName": "consentRequestIsExpired", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function consentRequestIsExpired(req: ConsentRequest, now?: Date): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 174, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrequestisexpired" }, { "name": "ConsentRevocationPayload", "declarationName": "ConsentRevocationPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentRevocationPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 393, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrevocationpayload" }, { "name": "ConsentRevocationPayloadSchema", "declarationName": "ConsentRevocationPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentRevocationPayloadSchema: z.ZodObject<{\n consent_id: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n consent_id: string;\n}, {\n consent_id: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 386, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrevocationpayloadschema" }, { "name": "ConsentStatus", "declarationName": "ConsentStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Consent protocol types for human-in-the-loop credential authorization.", "tags": [], "signatures": [ { "code": "declare const ConsentStatus: {\n readonly PreApproved: \"pre_approved\";\n readonly Approved: \"approved\";\n readonly Pending: \"pending\";\n readonly Denied: \"denied\";\n readonly Revoked: \"revoked\";\n readonly NotRequired: \"not_required\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 108, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatus" }, { "name": "consentStatusAllowsOperation", "declarationName": "consentStatusAllowsOperation", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function consentStatusAllowsOperation(status: ConsentStatusValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 117, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatusallowsoperation" }, { "name": "ConsentStatusValue", "declarationName": "ConsentStatusValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentStatusValue = (typeof ConsentStatus)[keyof typeof ConsentStatus];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 116, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatusvalue" }, { "name": "ConstraintContext", "declarationName": "ConstraintContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ConstraintContext {\n current_time: Date;\n device_id?: string;\n session_id?: string;\n session_key_hash?: Uint8Array;\n origin?: string;\n client_ip?: string;\n environment?: string;\n tags: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 50, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "constraintcontext" }, { "name": "Constraints", "declarationName": "Constraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Constraints {\n device_binding?: DeviceBinding;\n session_binding?: SessionBinding;\n origin_binding?: OriginBinding;\n network_constraints?: NetworkConstraints;\n time_constraints?: TimeConstraints;\n environment_constraints?: EnvironmentConstraint;\n require_pop: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 41, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "constraints" }, { "name": "ConstraintsPayload", "declarationName": "ConstraintsPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConstraintsPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 25, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "constraintspayload" }, { "name": "ConstraintsPayloadSchema", "declarationName": "ConstraintsPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Broker wire types with Zod runtime validation.\n\nThese schemas must match the JSON payloads accepted and returned by the\nRust `arsenal-broker` HTTP handlers in `crates/arsenal-broker/src/handlers.rs`.", "tags": [], "signatures": [ { "code": "declare const ConstraintsPayloadSchema: z.ZodObject<{\n require_pop: z.ZodBoolean;\n allowed_origins: z.ZodOptional>;\n device_id: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n}, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 12, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "constraintspayloadschema" }, { "name": "contextNow", "declarationName": "contextNow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a fresh ConstraintContext with current_time=now().", "tags": [], "signatures": [ { "code": "declare function contextNow(): ConstraintContext;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 71, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "contextnow" }, { "name": "createAuditEvent", "declarationName": "createAuditEvent", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new audit event.", "tags": [], "signatures": [ { "code": "declare function createAuditEvent(opts: {\n kind: AuditEventKindValue;\n tenant_id: string;\n severity?: AuditSeverityValue;\n outcome?: AuditOutcomeValue;\n description?: string;\n metadata?: Record;\n agent_id?: string;\n session_id?: string;\n token_id?: string;\n client_ip?: string;\n user_agent?: string;\n request_id?: string;\n}): AuditEvent;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 504, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "createauditevent" }, { "name": "createConsentRequest", "declarationName": "createConsentRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new consent request with validation.", "tags": [], "signatures": [ { "code": "declare function createConsentRequest(opts: {\n agent_did: string;\n human_root_did: string;\n variables: readonly string[];\n destination_domains: readonly string[];\n scopes: readonly string[];\n ttl_seconds?: number;\n}): ConsentRequest;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 166, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "createconsentrequest" }, { "name": "createDestinationBinding", "declarationName": "createDestinationBinding", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create and validate a destination binding.", "tags": [], "signatures": [ { "code": "declare function createDestinationBinding(allowedDomains: readonly string[], opts?: Partial>): DestinationBinding;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 205, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "createdestinationbinding" }, { "name": "createPolicyDocument", "declarationName": "createPolicyDocument", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a new policy document (no rules yet).", "tags": [], "signatures": [ { "code": "declare function createPolicyDocument(tenantId: string, name: string): PolicyDocument;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 110, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "createpolicydocument" }, { "name": "createPolicyRequest", "declarationName": "createPolicyRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new policy request with current timestamp.", "tags": [], "signatures": [ { "code": "declare function createPolicyRequest(agentId: string, tenantId: string, requestedScope: string): PolicyRequest;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 123, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "createpolicyrequest" }, { "name": "createPolicyRule", "declarationName": "createPolicyRule", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a simple rule. Conditions are added via spread.", "tags": [], "signatures": [ { "code": "declare function createPolicyRule(id: string, effect: PolicyEffectValue, conditions?: readonly PolicyCondition[]): PolicyRule;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 87, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "createpolicyrule" }, { "name": "createSecretMetadata", "declarationName": "createSecretMetadata", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new secret metadata record.", "tags": [], "signatures": [ { "code": "declare function createSecretMetadata(tenantId: string, name: string, secretType: SecretTypeValue): SecretMetadata;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 340, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "createsecretmetadata" }, { "name": "createTemplateVariable", "declarationName": "createTemplateVariable", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a template variable, validating the name.", "tags": [], "signatures": [ { "code": "declare function createTemplateVariable(name: string): TemplateVariable;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 219, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "createtemplatevariable" }, { "name": "decisionIsAllowed", "declarationName": "decisionIsAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the decision allows the action.", "tags": [], "signatures": [ { "code": "declare function decisionIsAllowed(d: PolicyDecision): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 130, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "decisionisallowed" }, { "name": "decisionIsDenied", "declarationName": "decisionIsDenied", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the decision denies the action.", "tags": [], "signatures": [ { "code": "declare function decisionIsDenied(d: PolicyDecision): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 132, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "decisionisdenied" }, { "name": "decodeCbor", "declarationName": "decodeCbor", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a CBOR byte string into a plain JS value.", "tags": [], "signatures": [ { "code": "declare function decodeCbor(bytes: Uint8Array): unknown;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 566, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "decodecbor" }, { "name": "defaultRateLimits", "declarationName": "defaultRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Default moderate rate limits (same as Rust `RateLimits::default()`).", "tags": [], "signatures": [ { "code": "declare function defaultRateLimits(): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 95, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "defaultratelimits" }, { "name": "defaultSessionConfig", "declarationName": "defaultSessionConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function defaultSessionConfig(): SessionConfig;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 67, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "defaultsessionconfig" }, { "name": "defaultUsageBudget", "declarationName": "defaultUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function defaultUsageBudget(): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 109, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "defaultusagebudget" }, { "name": "DelegationConstraints", "declarationName": "DelegationConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationConstraints {\n allow_delegation: boolean;\n max_depth: number;\n delegatable_scopes?: ScopeSet;\n allowed_delegates: readonly string[];\n allow_any_delegate: boolean;\n min_ttl_reduction: number;\n require_approval: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 379, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "delegationconstraints" }, { "name": "denyDelegation", "declarationName": "denyDelegation", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Default: delegation denied.", "tags": [], "signatures": [ { "code": "declare function denyDelegation(): DelegationConstraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 390, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "denydelegation" }, { "name": "denyWith", "declarationName": "denyWith", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a deny decision with a reason string.", "tags": [], "signatures": [ { "code": "declare function denyWith(reason: string): PolicyDecision;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 42, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "denywith" }, { "name": "DestinationBinding", "declarationName": "DestinationBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Destination binding restricting which endpoints a credential can reach.", "tags": [], "signatures": [ { "code": "interface DestinationBinding {\n allowed_domains: readonly string[];\n allowed_paths?: readonly string[];\n allowed_methods?: readonly string[];\n allowed_ports?: readonly number[];\n require_tls: boolean;\n allow_subdomains: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 196, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "destinationbinding" }, { "name": "DeviceBinding", "declarationName": "DeviceBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DeviceBinding {\n device_id: string;\n binding_type: BindingTypeValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 13, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "devicebinding" }, { "name": "DeviceId", "declarationName": "DeviceId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Device identifier for device binding.", "tags": [], "signatures": [ { "code": "declare class DeviceId {\n static parse(id: string): DeviceId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 195, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "deviceid" }, { "name": "effectiveTimeoutMs", "declarationName": "effectiveTimeoutMs", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve the effective timeout, capped to MAX_TIMEOUT_MS.", "tags": [], "signatures": [ { "code": "declare function effectiveTimeoutMs(req: ProxyRequest): number;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 240, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "effectivetimeoutms" }, { "name": "encodeCbor", "declarationName": "encodeCbor", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode a value to deterministic CBOR bytes.", "tags": [], "signatures": [ { "code": "declare function encodeCbor(value: unknown): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 564, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "encodecbor" }, { "name": "EnvironmentConstraint", "declarationName": "EnvironmentConstraint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface EnvironmentConstraint {\n required_environment?: string;\n required_tags?: ReadonlySet;\n forbidden_tags?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 36, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "environmentconstraint" }, { "name": "ErrorCode", "declarationName": "ErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for programmatic handling. Numeric values match the Rust crate\n`arsenal_core::error::ErrorCode` so wire-level cross-language parity holds.", "tags": [], "signatures": [ { "code": "declare const ErrorCode: {\n readonly AuthenticationFailed: 1001;\n readonly TokenExpired: 1002;\n readonly TokenSignatureInvalid: 1003;\n readonly PopVerificationFailed: 1004;\n readonly IdentityInvalid: 1005;\n readonly SessionExpired: 1006;\n readonly InsufficientPermissions: 2001;\n readonly ScopeExceeded: 2002;\n readonly PolicyDenied: 2003;\n readonly DelegationInvalid: 2004;\n readonly RateLimitExceeded: 2005;\n readonly BudgetExhausted: 2006;\n readonly TimeConstraintViolation: 3001;\n readonly EnvironmentBindingViolation: 3002;\n readonly NetworkConstraintViolation: 3003;\n readonly DeviceBindingViolation: 3004;\n readonly OriginBindingViolation: 3005;\n readonly SecretNotFound: 4001;\n readonly SecretVersionNotFound: 4002;\n readonly SecretRevoked: 4003;\n readonly SecretRotationInProgress: 4004;\n readonly SecretUnwrapLimitExceeded: 4005;\n readonly CryptoOperationFailed: 4006;\n readonly ValidationFailed: 5001;\n readonly MalformedRequest: 5002;\n readonly InvalidTokenFormat: 5003;\n readonly InvalidScopeFormat: 5004;\n readonly InvalidConstraint: 5005;\n readonly InternalError: 6001;\n readonly StorageError: 6002;\n readonly ConfigurationError: 6003;\n readonly CryptoSubsystemError: 6004;\n readonly AuditError: 6005;\n readonly SerializationFailed: 6006;\n readonly TokenRevoked: 7001;\n readonly AgentDeactivated: 7002;\n readonly TenantSuspended: 7003;\n readonly RevocationStatusUnknown: 7004;\n readonly ProxyDestinationViolation: 8001;\n readonly ProxyRequestFailed: 8002;\n readonly ProxyTimeout: 8003;\n readonly SsrfBlocked: 8004;\n readonly TemplateVariableNotFound: 8005;\n readonly TemplateVariableAccessDenied: 8006;\n readonly InvalidTemplateVariable: 8007;\n readonly OAuthReauthRequired: 8008;\n readonly ConsentRequired: 9001;\n readonly ConsentDenied: 9002;\n readonly ConsentExpired: 9003;\n readonly ConsentRevoked: 9004;\n readonly FingerprintMismatch: 10001;\n readonly FingerprintStateNotFound: 10002;\n readonly DctScopeAmplification: 11001;\n readonly DctDepthExceeded: 11002;\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 19, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "errorcode" }, { "name": "ErrorCodeValue", "declarationName": "ErrorCodeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ErrorCodeValue = (typeof ErrorCode)[keyof typeof ErrorCode];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 75, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "errorcodevalue" }, { "name": "ErrorContext", "declarationName": "ErrorContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Additional structured context attached to an ArsenalError. All fields are\nsanitized — never include raw secrets or internal paths.", "tags": [], "signatures": [ { "code": "interface ErrorContext {\n operation?: string;\n resource?: string;\n constraint?: string;\n timestamp?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 92, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "errorcontext" }, { "name": "evaluatePolicy", "declarationName": "evaluatePolicy", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Evaluate a single policy against a request. Returns the first matching\nrule's decision or the policy's default effect.", "tags": [], "signatures": [ { "code": "declare function evaluatePolicy(policy: PolicyDocument, request: PolicyRequest): PolicyDecision;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 36, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "evaluatepolicy" }, { "name": "extractProxyRequestVariables", "declarationName": "extractProxyRequestVariables", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extract all template variables used anywhere in a proxy request.", "tags": [], "signatures": [ { "code": "declare function extractProxyRequestVariables(req: ProxyRequest): readonly TemplateVariable[];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 242, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "extractproxyrequestvariables" }, { "name": "hashAuditEvent", "declarationName": "hashAuditEvent", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compute a BLAKE3 hash of an audit event. The hash is used for chain\nlinkage and tamper detection. The result is a 32-byte `Uint8Array`.", "tags": [], "signatures": [ { "code": "declare function hashAuditEvent(event: AuditEvent): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 522, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "hashauditevent" }, { "name": "HealthResponse", "declarationName": "HealthResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type HealthResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 410, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "healthresponse" }, { "name": "HealthResponseSchema", "declarationName": "HealthResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const HealthResponseSchema: z.ZodObject<{\n status: z.ZodString;\n version: z.ZodString;\n registered_agents: z.ZodOptional;\n revoked_tokens: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n status: z.ZodString;\n version: z.ZodString;\n registered_agents: z.ZodOptional;\n revoked_tokens: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n status: z.ZodString;\n version: z.ZodString;\n registered_agents: z.ZodOptional;\n revoked_tokens: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 394, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "healthresponseschema" }, { "name": "hexDecode", "declarationName": "hexDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a hex string into bytes. Throws on invalid input.", "tags": [], "signatures": [ { "code": "declare function hexDecode(s: string): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 540, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "hexdecode" }, { "name": "hexEncode", "declarationName": "hexEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes as lowercase hex.", "tags": [], "signatures": [ { "code": "declare function hexEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 538, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "hexencode" }, { "name": "inferVariablePrefix", "declarationName": "inferVariablePrefix", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Infer the credential-type prefix from a variable name.", "tags": [], "signatures": [ { "code": "declare function inferVariablePrefix(name: string): VariablePrefixValue;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 222, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "infervariableprefix" }, { "name": "ipInCidrRange", "declarationName": "ipInCidrRange", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check if a dotted-quad or IPv6 address falls inside a CIDR range.\nSupports both IPv4 and IPv6. Invalid CIDR or IP input returns false.", "tags": [], "signatures": [ { "code": "declare function ipInCidrRange(ip: string, cidr: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 81, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "ipincidrrange" }, { "name": "isClientError", "declarationName": "isClientError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 1000..5999 client-error range.", "tags": [], "signatures": [ { "code": "declare function isClientError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 77, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isclienterror" }, { "name": "isConsentError", "declarationName": "isConsentError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 9000..9999 consent error range.", "tags": [], "signatures": [ { "code": "declare function isConsentError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 83, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isconsenterror" }, { "name": "isDomainAllowed", "declarationName": "isDomainAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check if a domain is allowed by the binding.", "tags": [], "signatures": [ { "code": "declare function isDomainAllowed(binding: DestinationBinding, domain: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 209, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "isdomainallowed" }, { "name": "isFingerprintError", "declarationName": "isFingerprintError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 10000..10999 fingerprint range.", "tags": [], "signatures": [ { "code": "declare function isFingerprintError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 85, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isfingerprinterror" }, { "name": "isMethodAllowed", "declarationName": "isMethodAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function isMethodAllowed(binding: DestinationBinding, method: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 210, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "ismethodallowed" }, { "name": "isPathAllowed", "declarationName": "isPathAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function isPathAllowed(binding: DestinationBinding, path: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 212, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "ispathallowed" }, { "name": "isPermanentError", "declarationName": "isPermanentError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error is permanent (retry will not help).", "tags": [], "signatures": [ { "code": "declare function isPermanentError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 87, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "ispermanenterror" }, { "name": "isPortAllowed", "declarationName": "isPortAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function isPortAllowed(binding: DestinationBinding, port: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 211, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "isportallowed" }, { "name": "isProxyError", "declarationName": "isProxyError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 8000..8999 proxy error range.", "tags": [], "signatures": [ { "code": "declare function isProxyError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 81, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isproxyerror" }, { "name": "isServerError", "declarationName": "isServerError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 6000..6999 server-error range.", "tags": [], "signatures": [ { "code": "declare function isServerError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 79, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isservererror" }, { "name": "KeyFingerprint", "declarationName": "KeyFingerprint", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Public-key fingerprint — BLAKE3 hash (32 bytes) of a public key.\n\nUses a constant-time compare for equality checks.", "tags": [], "signatures": [ { "code": "declare class KeyFingerprint {\n static fromBytes(bytes: Uint8Array): KeyFingerprint;\n static fromPublicKey(publicKey: Uint8Array): Promise;\n static fromHex(hex: string): KeyFingerprint;\n asBytes(): Uint8Array;\n toHex(): string;\n toString(): string;\n constantTimeEquals(other: KeyFingerprint): boolean;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 208, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "keyfingerprint" }, { "name": "latestSecretRef", "declarationName": "latestSecretRef", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Reference to the latest version.", "tags": [], "signatures": [ { "code": "declare function latestSecretRef(id: string): SecretRef;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 347, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "latestsecretref" }, { "name": "MAX_CHAIN_LENGTH", "declarationName": "MAX_CHAIN_LENGTH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Maximum number of tokens in a delegation chain.", "tags": [], "signatures": [ { "code": "declare const MAX_CHAIN_LENGTH = 10;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 378, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "max_chain_length" }, { "name": "MAX_CONDITION_DEPTH", "declarationName": "MAX_CONDITION_DEPTH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Maximum recursion depth for nested And/Or/Not conditions.", "tags": [], "signatures": [ { "code": "declare const MAX_CONDITION_DEPTH = 16;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 10, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "max_condition_depth" }, { "name": "MAX_DELEGATION_DEPTH", "declarationName": "MAX_DELEGATION_DEPTH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Maximum absolute delegation depth allowed anywhere in the system.", "tags": [], "signatures": [ { "code": "declare const MAX_DELEGATION_DEPTH = 5;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 376, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "max_delegation_depth" }, { "name": "mergeRateLimits", "declarationName": "mergeRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Merge two limit configs taking the more restrictive (minimum) value.", "tags": [], "signatures": [ { "code": "declare function mergeRateLimits(a: RateLimits, b: RateLimits): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 101, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "mergeratelimits" }, { "name": "mergeUsageBudget", "declarationName": "mergeUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function mergeUsageBudget(a: UsageBudget, b: UsageBudget): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 112, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "mergeusagebudget" }, { "name": "minimalUsageBudget", "declarationName": "minimalUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function minimalUsageBudget(): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 111, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "minimalusagebudget" }, { "name": "NetworkConstraints", "declarationName": "NetworkConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface NetworkConstraints {\n allowed_ips?: ReadonlySet;\n denied_ips?: ReadonlySet;\n allowed_cidrs?: readonly string[];\n allowed_asns?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 24, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "networkconstraints" }, { "name": "noConstraints", "declarationName": "noConstraints", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build an empty constraint object (no restrictions).", "tags": [], "signatures": [ { "code": "declare function noConstraints(): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 61, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "noconstraints" }, { "name": "OriginBinding", "declarationName": "OriginBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OriginBinding {\n allowed_origins: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 21, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "originbinding" }, { "name": "parsePermission", "declarationName": "parsePermission", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse a string into a Permission value. Throws on unknown input.", "tags": [], "signatures": [ { "code": "declare function parsePermission(s: string): PermissionValue;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 266, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "parsepermission" }, { "name": "parseTemplateVariables", "declarationName": "parseTemplateVariables", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse all `{{VARIABLE}}` placeholders from a string. Invalid names\ninside `{{}}` are silently skipped. Duplicates are deduplicated.", "tags": [], "signatures": [ { "code": "declare function parseTemplateVariables(input: string): readonly TemplateVariable[];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 227, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "parsetemplatevariables" }, { "name": "Permission", "declarationName": "Permission", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "CRUD permission classification.", "tags": [], "signatures": [ { "code": "declare const Permission: {\n readonly Read: \"read\";\n readonly Create: \"create\";\n readonly Update: \"update\";\n readonly Delete: \"delete\";\n readonly Admin: \"admin\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 255, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "permission" }, { "name": "permissionImplies", "declarationName": "permissionImplies", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check if permission `a` implies permission `b`.", "tags": [], "signatures": [ { "code": "declare function permissionImplies(a: PermissionValue, b: PermissionValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 264, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "permissionimplies" }, { "name": "PermissionValue", "declarationName": "PermissionValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PermissionValue = (typeof Permission)[keyof typeof Permission];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 262, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "permissionvalue" }, { "name": "policyAllows", "declarationName": "policyAllows", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Convenience alias: true if the policy decision allows the request.", "tags": [], "signatures": [ { "code": "declare function policyAllows(decision: PolicyDecision): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 40, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "policyallows" }, { "name": "PolicyCondition", "declarationName": "PolicyCondition", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyCondition = {\n type: \"agent_id\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"tenant_id\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"scope\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"environment\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"time_of_day\";\n allowed_hours: readonly number[];\n} | {\n type: \"day_of_week\";\n allowed_days: readonly number[];\n} | {\n type: \"ip_address\";\n allowed_cidrs: readonly string[];\n} | {\n type: \"attribute\";\n key: string;\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"and\";\n conditions: readonly PolicyCondition[];\n} | {\n type: \"or\";\n conditions: readonly PolicyCondition[];\n} | {\n type: \"not\";\n condition: PolicyCondition;\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 36, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policycondition" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n effect: PolicyEffectValue;\n matched_rule?: string;\n reason?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 124, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policydecision" }, { "name": "PolicyDocument", "declarationName": "PolicyDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDocument {\n id: string;\n version: number;\n tenant_id: string;\n name: string;\n description?: string;\n rules: readonly PolicyRule[];\n default_effect: PolicyEffectValue;\n is_active: boolean;\n priority: number;\n created_at: string;\n updated_at: string;\n signature?: PolicySignature;\n labels: Readonly>;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 94, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policydocument" }, { "name": "PolicyEffect", "declarationName": "PolicyEffect", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PolicyEffect: {\n readonly Allow: \"allow\";\n readonly Deny: \"deny\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 20, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyeffect" }, { "name": "PolicyEffectValue", "declarationName": "PolicyEffectValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyEffectValue = (typeof PolicyEffect)[keyof typeof PolicyEffect];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 24, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyeffectvalue" }, { "name": "PolicyEngine", "declarationName": "PolicyEngine", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A policy engine evaluates multiple policies in priority order.\n\nPolicies are added via `addPolicy` and removed via `removePolicy`. On\neach `evaluate(request)` call, policies are sorted by descending\npriority and the first matching rule's decision is returned. When no\nrule matches, the default effect of the first policy (ordered by\npriority) is used, and if there are no policies the engine returns\n`Deny`.", "tags": [], "signatures": [ { "code": "declare class PolicyEngine {\n addPolicy(policy: PolicyDocument): void;\n removePolicy(policyId: string): PolicyDocument | undefined;\n getPolicy(policyId: string): PolicyDocument | undefined;\n policyIds(): readonly string[];\n size(): number;\n evaluate(request: PolicyRequest): PolicyDecision;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 22, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "policyengine" }, { "name": "PolicyId", "declarationName": "PolicyId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class PolicyId {\n static parse(id: string): PolicyId;\n static generate(): PolicyId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 11, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyid" }, { "name": "PolicyRequest", "declarationName": "PolicyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRequest {\n agent_id: string;\n tenant_id: string;\n requested_scope: string;\n timestamp: Date;\n environment?: string;\n client_ip?: string;\n attributes: Readonly>;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 113, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyrequest" }, { "name": "PolicyRule", "declarationName": "PolicyRule", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRule {\n id: string;\n description?: string;\n effect: PolicyEffectValue;\n conditions: readonly PolicyCondition[];\n scopes?: ScopeSet;\n constraints?: Constraints;\n rate_limits?: RateLimits;\n budget?: UsageBudget;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 76, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyrule" }, { "name": "PolicySignature", "declarationName": "PolicySignature", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicySignature {\n bytes: Uint8Array;\n algorithm: string;\n key_id: string;\n signed_at: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 88, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policysignature" }, { "name": "PrincipalId", "declarationName": "PrincipalId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Principal identifier — user, service account, or system principal.", "tags": [], "signatures": [ { "code": "declare class PrincipalId {\n static parse(id: string): PrincipalId;\n static generate(): PrincipalId;\n static system(): PrincipalId;\n isSystem(): boolean;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 172, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "principalid" }, { "name": "ProofOfPossession", "declarationName": "ProofOfPossession", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ProofOfPossession {\n key_fingerprint: string;\n alg: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 23, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proofofpossession" }, { "name": "ProxyMetadata", "declarationName": "ProxyMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Metadata about proxy processing (never includes resolved values).", "tags": [], "signatures": [ { "code": "interface ProxyMetadata {\n variables_resolved: readonly string[];\n destination_verified: boolean;\n fingerprint_verified: boolean;\n consent_status: ConsentStatusValue;\n latency_ms: number;\n request_id: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 251, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxymetadata" }, { "name": "ProxyMetadataPayload", "declarationName": "ProxyMetadataPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProxyMetadataPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 221, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxymetadatapayload" }, { "name": "ProxyMetadataPayloadSchema", "declarationName": "ProxyMetadataPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ProxyMetadataPayloadSchema: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 199, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxymetadatapayloadschema" }, { "name": "ProxyRequest", "declarationName": "ProxyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Proxy request envelope sent to the broker.", "tags": [], "signatures": [ { "code": "interface ProxyRequest {\n method: string;\n url: string;\n headers?: Readonly>;\n body?: Uint8Array;\n capability_token: string;\n timeout_ms?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 229, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxyrequest" }, { "name": "ProxyRequestPayload", "declarationName": "ProxyRequestPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProxyRequestPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 198, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyrequestpayload" }, { "name": "ProxyRequestPayloadSchema", "declarationName": "ProxyRequestPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ProxyRequestPayloadSchema: z.ZodObject<{\n method: z.ZodString;\n url: z.ZodString;\n headers: z.ZodOptional>;\n body: z.ZodOptional;\n capability_token: z.ZodString;\n timeout_ms: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n url: string;\n capability_token: string;\n method: string;\n headers?: Record | undefined;\n body?: string | undefined;\n timeout_ms?: number | undefined;\n}, {\n url: string;\n capability_token: string;\n method: string;\n headers?: Record | undefined;\n body?: string | undefined;\n timeout_ms?: number | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 176, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyrequestpayloadschema" }, { "name": "ProxyResponse", "declarationName": "ProxyResponse", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Response from a proxy request.", "tags": [], "signatures": [ { "code": "interface ProxyResponse {\n status: number;\n headers: Readonly>;\n body: Uint8Array;\n proxy_metadata: ProxyMetadata;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 244, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxyresponse" }, { "name": "ProxyResponsePayload", "declarationName": "ProxyResponsePayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProxyResponsePayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 301, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyresponsepayload" }, { "name": "ProxyResponsePayloadSchema", "declarationName": "ProxyResponsePayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ProxyResponsePayloadSchema: z.ZodObject<{\n status: z.ZodNumber;\n headers: z.ZodRecord;\n body: z.ZodString;\n proxy_metadata: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">>;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n status: z.ZodNumber;\n headers: z.ZodRecord;\n body: z.ZodString;\n proxy_metadata: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">>;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n status: z.ZodNumber;\n headers: z.ZodRecord;\n body: z.ZodString;\n proxy_metadata: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">>;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 222, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyresponsepayloadschema" }, { "name": "RateLimits", "declarationName": "RateLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Rate limits, usage budgets, and runtime tracking primitives.", "tags": [], "signatures": [ { "code": "interface RateLimits {\n requests_per_second?: number;\n requests_per_minute?: number;\n requests_per_hour?: number;\n max_concurrent?: number;\n max_request_size?: number;\n max_response_size?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 86, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "ratelimits" }, { "name": "RemainingBudget", "declarationName": "RemainingBudget", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Remaining budget (undefined entries are unlimited).", "tags": [], "signatures": [ { "code": "interface RemainingBudget {\n requests?: number;\n bytes?: number;\n cost_units?: number;\n secret_unwraps?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 122, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "remainingbudget" }, { "name": "revokeConsentRecord", "declarationName": "revokeConsentRecord", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Return a revoked copy of the consent record.", "tags": [], "signatures": [ { "code": "declare function revokeConsentRecord(record: ConsentRecord, at?: Date): ConsentRecord;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 148, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "revokeconsentrecord" }, { "name": "RevokeTokenPayload", "declarationName": "RevokeTokenPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevokeTokenPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 130, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenpayload" }, { "name": "RevokeTokenPayloadSchema", "declarationName": "RevokeTokenPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const RevokeTokenPayloadSchema: z.ZodObject<{\n token_id: z.ZodString;\n reason: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n token_id: string;\n reason?: string | undefined;\n}, {\n token_id: string;\n reason?: string | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 120, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenpayloadschema" }, { "name": "RevokeTokenResponse", "declarationName": "RevokeTokenResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevokeTokenResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 141, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenresponse" }, { "name": "RevokeTokenResponseSchema", "declarationName": "RevokeTokenResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const RevokeTokenResponseSchema: z.ZodObject<{\n success: z.ZodBoolean;\n message: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n success: boolean;\n message: string;\n}, {\n success: boolean;\n message: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 131, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenresponseschema" }, { "name": "sanitizeFieldName", "declarationName": "sanitizeFieldName", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strip unsafe characters from a field name.", "tags": [], "signatures": [ { "code": "declare function sanitizeFieldName(field: string): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 152, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sanitizefieldname" }, { "name": "sanitizeResourceId", "declarationName": "sanitizeResourceId", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strip path-traversal characters and cap length.", "tags": [], "signatures": [ { "code": "declare function sanitizeResourceId(id: string): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 148, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sanitizeresourceid" }, { "name": "sanitizeScope", "declarationName": "sanitizeScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strip unsafe characters from a scope; keep separators.", "tags": [], "signatures": [ { "code": "declare function sanitizeScope(scope: string): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 150, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sanitizescope" }, { "name": "Scope", "declarationName": "Scope", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A single permission scope.", "tags": [], "signatures": [ { "code": "declare class Scope {\n static parse(scope: string): Scope;\n static wildcard(): Scope;\n static readOnly(service: string): Scope;\n static fullAccess(service: string): Scope;\n get service(): string;\n get resource(): string;\n get action(): string;\n isWildcard(): boolean;\n implies(other: Scope): boolean;\n asString(): string;\n toString(): string;\n toJSON(): string;\n equals(other: Scope): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 200, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scope" }, { "name": "ScopeSet", "declarationName": "ScopeSet", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A set of scopes, maintained as a sorted list for deterministic encoding.", "tags": [], "signatures": [ { "code": "declare class ScopeSet {\n static empty(): ScopeSet;\n static single(scope: Scope): ScopeSet;\n static fromStrings(scopes: readonly string[]): ScopeSet;\n static fromScopes(scopes: readonly Scope[]): ScopeSet;\n add(scope: Scope): ScopeSet;\n remove(scope: Scope): ScopeSet;\n contains(scope: Scope): boolean;\n allows(requested: Scope): boolean;\n isSupersetOf(other: ScopeSet): boolean;\n intersection(other: ScopeSet): ScopeSet;\n union(other: ScopeSet): ScopeSet;\n get length(): number;\n isEmpty(): boolean;\n toArray(): readonly Scope[];\n toStrings(): readonly string[];\n [Symbol.iterator](): Iterator;\n toJSON(): readonly string[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 228, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scopeset" }, { "name": "SecretId", "declarationName": "SecretId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Secret identifier.", "tags": [], "signatures": [ { "code": "declare class SecretId {\n static generate(): SecretId;\n static fromString(id: string): SecretId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 275, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretid" }, { "name": "SecretMetadata", "declarationName": "SecretMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SecretMetadata {\n id: string;\n tenant_id: string;\n name: string;\n description?: string;\n secret_type: SecretTypeValue;\n current_version: number;\n versions: readonly SecretVersionInfo[];\n created_at: string;\n updated_at: string;\n expires_at?: string;\n last_rotated_at?: string;\n next_rotation_at?: string;\n is_active: boolean;\n labels: Readonly>;\n service?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 322, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretmetadata" }, { "name": "SecretRef", "declarationName": "SecretRef", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Reference to a secret — used when the value shouldn't be inlined.", "tags": [], "signatures": [ { "code": "interface SecretRef {\n id: string;\n version?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 342, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretref" }, { "name": "SecretRequestPayload", "declarationName": "SecretRequestPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretRequestPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 96, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretrequestpayload" }, { "name": "SecretRequestPayloadSchema", "declarationName": "SecretRequestPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretRequestPayloadSchema: z.ZodObject<{\n secret_id: z.ZodString;\n version: z.ZodOptional;\n capability_token: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n secret_id: string;\n capability_token: string;\n version?: number | undefined;\n}, {\n secret_id: string;\n capability_token: string;\n version?: number | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 83, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretrequestpayloadschema" }, { "name": "SecretResponsePayload", "declarationName": "SecretResponsePayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretResponsePayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 119, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretresponsepayload" }, { "name": "SecretResponsePayloadSchema", "declarationName": "SecretResponsePayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretResponsePayloadSchema: z.ZodObject<{\n secret_id: z.ZodString;\n version: z.ZodNumber;\n wrapped_value: z.ZodString;\n wrap_key_id: z.ZodString;\n ephemeral_public_key: z.ZodString;\n expires_at: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n secret_id: string;\n expires_at: string;\n version: number;\n wrapped_value: string;\n wrap_key_id: string;\n ephemeral_public_key: string;\n}, {\n secret_id: string;\n expires_at: string;\n version: number;\n wrapped_value: string;\n wrap_key_id: string;\n ephemeral_public_key: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 97, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretresponsepayloadschema" }, { "name": "SecretType", "declarationName": "SecretType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretType: {\n readonly ApiKey: \"api_key\";\n readonly OAuthClientCredentials: \"o_auth_client_credentials\";\n readonly OAuthAccessToken: \"o_auth_access_token\";\n readonly OAuthRefreshToken: \"o_auth_refresh_token\";\n readonly DatabaseCredentials: \"database_credentials\";\n readonly SshKey: \"ssh_key\";\n readonly TlsCertificate: \"tls_certificate\";\n readonly SigningKey: \"signing_key\";\n readonly EncryptionKey: \"encryption_key\";\n readonly Generic: \"generic\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 296, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secrettype" }, { "name": "SecretTypeValue", "declarationName": "SecretTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretTypeValue = (typeof SecretType)[keyof typeof SecretType];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 308, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secrettypevalue" }, { "name": "SecretValue", "declarationName": "SecretValue", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Secret value holder that clears its internal buffer when `zeroize()` is\ncalled. JS has no destructors, so callers must explicitly invoke\n`zeroize()` in a `finally` block after use.", "tags": [], "signatures": [ { "code": "declare class SecretValue {\n static fromBytes(bytes: Uint8Array): SecretValue;\n static fromString(s: string): SecretValue;\n asBytes(): Uint8Array;\n asString(): string;\n get length(): number;\n isEmpty(): boolean;\n zeroize(): void;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 355, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretvalue" }, { "name": "SecretVersion", "declarationName": "SecretVersion", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Secret version number (1-based).", "tags": [], "signatures": [ { "code": "declare class SecretVersion {\n static initial(): SecretVersion;\n static fromNumber(n: number): SecretVersion;\n asNumber(): number;\n next(): SecretVersion;\n isInitial(): boolean;\n toString(): string;\n toJSON(): number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 285, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversion" }, { "name": "SecretVersionInfo", "declarationName": "SecretVersionInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SecretVersionInfo {\n version: number;\n created_at: string;\n created_by?: string;\n state: SecretVersionStateValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 316, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversioninfo" }, { "name": "SecretVersionState", "declarationName": "SecretVersionState", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretVersionState: {\n readonly Active: \"active\";\n readonly Previous: \"previous\";\n readonly Disabled: \"disabled\";\n readonly PendingDeletion: \"pending_deletion\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 309, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversionstate" }, { "name": "SecretVersionStateValue", "declarationName": "SecretVersionStateValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretVersionStateValue = (typeof SecretVersionState)[keyof typeof SecretVersionState];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 315, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversionstatevalue" }, { "name": "SessionBinding", "declarationName": "SessionBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionBinding {\n session_id: string;\n session_key_hash?: Uint8Array;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 17, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "sessionbinding" }, { "name": "SessionConfig", "declarationName": "SessionConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for session lifecycle.", "tags": [], "signatures": [ { "code": "interface SessionConfig {\n sessionTtlSeconds: number;\n renewalThresholdSeconds: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 58, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "sessionconfig" }, { "name": "SessionEndReason", "declarationName": "SessionEndReason", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SessionEndReason: {\n readonly Completed: \"completed\";\n readonly Logout: \"logout\";\n readonly Timeout: \"timeout\";\n readonly TokenExpired: \"token_expired\";\n readonly Revoked: \"revoked\";\n readonly SecurityViolation: \"security_violation\";\n readonly PolicyViolation: \"policy_violation\";\n readonly SystemShutdown: \"system_shutdown\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 428, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionendreason" }, { "name": "SessionEndReasonValue", "declarationName": "SessionEndReasonValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SessionEndReasonValue = (typeof SessionEndReason)[keyof typeof SessionEndReason] | {\n error: string;\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 438, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionendreasonvalue" }, { "name": "SessionId", "declarationName": "SessionId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Session identifier (UUID v7 in Rust; UUID v4 is acceptable here).", "tags": [], "signatures": [ { "code": "declare class SessionId {\n static generate(): SessionId;\n static fromString(s: string): SessionId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 402, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionid" }, { "name": "SessionManager", "declarationName": "SessionManager", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory session manager. Not thread-safe in the shared-memory sense,\nbut JavaScript is single-threaded so method calls cannot interleave.", "tags": [], "signatures": [ { "code": "declare class SessionManager {\n constructor(config?: SessionConfig);\n startSession(): Promise;\n sessionIdOrThrow(): SessionId;\n hasActiveSession(): boolean;\n stats(): SessionStats;\n setCurrentToken(token: AgentCapabilityToken): void;\n currentToken(): AgentCapabilityToken | undefined;\n recordActivity(): void;\n needsTokenRenewal(now?: Date): boolean;\n endSession(): Promise;\n revokeSession(): Promise;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 79, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "sessionmanager" }, { "name": "SessionState", "declarationName": "SessionState", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SessionState: {\n readonly AgentBootstrapped: \"agent_bootstrapped\";\n readonly SessionStarted: \"session_started\";\n readonly CapabilitiesGranted: \"capabilities_granted\";\n readonly ToolUse: \"tool_use\";\n readonly Renewal: \"renewal\";\n readonly Escalation: \"escalation\";\n readonly SessionEnded: \"session_ended\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 411, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstate" }, { "name": "sessionStateCanRequestCapabilities", "declarationName": "sessionStateCanRequestCapabilities", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateCanRequestCapabilities(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 422, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstatecanrequestcapabilities" }, { "name": "sessionStateCanUseTools", "declarationName": "sessionStateCanUseTools", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateCanUseTools(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 421, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstatecanusetools" }, { "name": "sessionStateIsActive", "declarationName": "sessionStateIsActive", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateIsActive(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 424, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstateisactive" }, { "name": "sessionStateIsTerminal", "declarationName": "sessionStateIsTerminal", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateIsTerminal(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 423, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstateisterminal" }, { "name": "SessionStateValue", "declarationName": "SessionStateValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SessionStateValue = (typeof SessionState)[keyof typeof SessionState];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 420, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstatevalue" }, { "name": "SessionStats", "declarationName": "SessionStats", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Aggregate session statistics.", "tags": [], "signatures": [ { "code": "interface SessionStats {\n state: SessionStateValue;\n created_at: string | null;\n last_activity_at: string | null;\n has_active_token: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 69, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "sessionstats" }, { "name": "SignatureAlgorithm", "declarationName": "SignatureAlgorithm", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Agent Capability Token (ACT) — the core credential type.\n\nACTs are short-lived (30s–24h), scoped, cryptographically-signed tokens\nthat grant an agent specific capabilities. They are encoded as CBOR on\nthe wire for deterministic signing, and base64url-encoded when sent\nover HTTP.", "tags": [], "signatures": [ { "code": "declare const SignatureAlgorithm: {\n readonly Ed25519: \"ED25519\";\n readonly Es256: \"ES256\";\n readonly Es384: \"ES384\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 12, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "signaturealgorithm" }, { "name": "SignatureAlgorithmValue", "declarationName": "SignatureAlgorithmValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SignatureAlgorithmValue = (typeof SignatureAlgorithm)[keyof typeof SignatureAlgorithm];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 17, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "signaturealgorithmvalue" }, { "name": "specificSecretRef", "declarationName": "specificSecretRef", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Reference to a specific version.", "tags": [], "signatures": [ { "code": "declare function specificSecretRef(id: string, version: number): SecretRef;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 349, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "specificsecretref" }, { "name": "strictRateLimits", "declarationName": "strictRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strict lockdown rate limits.", "tags": [], "signatures": [ { "code": "declare function strictRateLimits(): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 99, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "strictratelimits" }, { "name": "TemplateVariable", "declarationName": "TemplateVariable", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Parsed template variable reference.", "tags": [], "signatures": [ { "code": "interface TemplateVariable {\n name: string;\n prefix: VariablePrefixValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 214, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "templatevariable" }, { "name": "TenantId", "declarationName": "TenantId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Tenant identifier — represents an organization or customer.", "tags": [], "signatures": [ { "code": "declare class TenantId {\n static parse(id: string): TenantId;\n static generate(): TenantId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n equals(other: TenantId): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 161, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "tenantid" }, { "name": "TimeConstraints", "declarationName": "TimeConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TimeConstraints {\n not_before?: string;\n not_after?: string;\n allowed_hours?: readonly number[];\n allowed_days?: readonly number[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 30, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "timeconstraints" }, { "name": "TokenBucketLimiter", "declarationName": "TokenBucketLimiter", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Token-bucket rate limiter. Lock-free single-threaded (JS single-threaded\nexecution model) — refills on each try_acquire based on elapsed wall clock.", "tags": [], "signatures": [ { "code": "declare class TokenBucketLimiter {\n constructor(maxTokens: number, refillAmount: number, refillIntervalMs: number);\n static perSecond(rate: number): TokenBucketLimiter;\n static perMinute(rate: number): TokenBucketLimiter;\n static perHour(rate: number): TokenBucketLimiter;\n tryAcquire(): void;\n available(): number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 153, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "tokenbucketlimiter" }, { "name": "TokenClaims", "declarationName": "TokenClaims", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenClaims {\n jti: string;\n sub: string;\n iss: string;\n aud: string;\n iat: string;\n nbf: string;\n exp: string;\n tenant_id: string;\n scope: readonly string[];\n constraints?: Constraints;\n limits?: RateLimits;\n budget?: UsageBudget;\n trace?: TokenTrace;\n cnf?: ProofOfPossession;\n delegated_variables?: readonly string[];\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 35, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokenclaims" }, { "name": "TokenClaimsBuildOptions", "declarationName": "TokenClaimsBuildOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for building a fresh set of claims.", "tags": [], "signatures": [ { "code": "interface TokenClaimsBuildOptions {\n subject: string;\n issuer: string;\n audience: string;\n tenant_id: string;\n scopes: ScopeSet;\n ttl_seconds?: number;\n constraints?: Constraints;\n limits?: RateLimits;\n budget?: UsageBudget;\n parent_token_id?: string;\n cnf?: ProofOfPossession;\n delegated_variables?: readonly string[];\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 54, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokenclaimsbuildoptions" }, { "name": "TokenSignature", "declarationName": "TokenSignature", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenSignature {\n bytes: Uint8Array;\n algorithm: SignatureAlgorithmValue;\n key_id?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 18, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokensignature" }, { "name": "TokenTrace", "declarationName": "TokenTrace", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenTrace {\n issuance_id: string;\n parent_token_id?: string;\n policy_id?: string;\n delegation_depth: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 29, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokentrace" }, { "name": "unlimitedRateLimits", "declarationName": "unlimitedRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "All unlimited — use with care.", "tags": [], "signatures": [ { "code": "declare function unlimitedRateLimits(): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 97, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "unlimitedratelimits" }, { "name": "unlimitedUsageBudget", "declarationName": "unlimitedUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function unlimitedUsageBudget(): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 110, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "unlimitedusagebudget" }, { "name": "UsageBudget", "declarationName": "UsageBudget", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface UsageBudget {\n max_requests?: number;\n max_bytes?: number;\n max_cost_units?: number;\n max_secret_unwraps?: number;\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 102, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagebudget" }, { "name": "UsageStats", "declarationName": "UsageStats", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Current usage snapshot.", "tags": [], "signatures": [ { "code": "interface UsageStats {\n request_count: number;\n bytes_transferred: number;\n cost_units: number;\n secret_unwraps: number;\n elapsed_ms: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 114, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagestats" }, { "name": "UsageTracker", "declarationName": "UsageTracker", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Runtime usage tracker that enforces a budget.\n\nEach `record*` call either succeeds or throws an ArsenalError with code\n`BudgetExhausted` (or `SecretUnwrapLimitExceeded`).", "tags": [], "signatures": [ { "code": "declare class UsageTracker {\n constructor(budget: UsageBudget);\n recordRequest(): void;\n recordBytes(bytes: number): void;\n recordCost(units: number): void;\n recordSecretUnwrap(): void;\n getStats(): UsageStats;\n remaining(): RemainingBudget;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 134, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagetracker" }, { "name": "validateConstraints", "declarationName": "validateConstraints", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate a set of constraints against a request context. Throws an\n`ArsenalError` on the first violation.", "tags": [], "signatures": [ { "code": "declare function validateConstraints(constraints: Constraints, ctx: ConstraintContext): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 76, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "validateconstraints" }, { "name": "validateDelegationDepth", "declarationName": "validateDelegationDepth", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate a delegation chain length and scope non-amplification rule.", "tags": [], "signatures": [ { "code": "declare function validateDelegationDepth(depth: number): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 396, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "validatedelegationdepth" }, { "name": "validateDestinationBinding", "declarationName": "validateDestinationBinding", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Throws if the binding is malformed.", "tags": [], "signatures": [ { "code": "declare function validateDestinationBinding(binding: DestinationBinding): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 207, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "validatedestinationbinding" }, { "name": "validateProxyRequest", "declarationName": "validateProxyRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate structural fields of a proxy request.", "tags": [], "signatures": [ { "code": "declare function validateProxyRequest(req: ProxyRequest): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 238, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "validateproxyrequest" }, { "name": "validateVariableName", "declarationName": "validateVariableName", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function validateVariableName(name: string): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 220, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "validatevariablename" }, { "name": "validSessionStateTransitions", "declarationName": "validSessionStateTransitions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the set of valid transitions from a given state.", "tags": [], "signatures": [ { "code": "declare function validSessionStateTransitions(state: SessionStateValue): readonly SessionStateValue[];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 426, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "validsessionstatetransitions" }, { "name": "VariablePrefix", "declarationName": "VariablePrefix", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Credential proxy protocol types.\n\nThese types describe the wire shape for proxy requests, destination\nbindings, and template-variable resolution. Agents construct\n`ProxyRequest` objects with `{{VARIABLE}}` placeholders; the broker\nresolves them server-side and never discloses raw credentials.", "tags": [], "signatures": [ { "code": "declare const VariablePrefix: {\n readonly OAuth2: \"OAUTH2\";\n readonly OAuth1: \"OAUTH1\";\n readonly ApiKey: \"API_KEY\";\n readonly Basic: \"BASIC\";\n readonly Bearer: \"BEARER\";\n readonly Cert: \"CERT\";\n readonly Custom: \"CUSTOM\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 185, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "variableprefix" }, { "name": "VariablePrefixValue", "declarationName": "VariablePrefixValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VariablePrefixValue = (typeof VariablePrefix)[keyof typeof VariablePrefix];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 194, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "variableprefixvalue" }, { "name": "VariableResolutionTable", "declarationName": "VariableResolutionTable", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory variable → secret-ref table used by the broker.", "tags": [], "signatures": [ { "code": "declare class VariableResolutionTable {\n register(variableName: string, secretRef: {\n id: string;\n version?: number;\n }): void;\n unregister(variableName: string): boolean;\n resolve(variableName: string): {\n id: string;\n version?: number;\n } | undefined;\n variableNames(): readonly string[];\n get size(): number;\n isEmpty(): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 260, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "variableresolutiontable" }, { "name": "VerifyTokenPayload", "declarationName": "VerifyTokenPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerifyTokenPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 149, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenpayload" }, { "name": "VerifyTokenPayloadSchema", "declarationName": "VerifyTokenPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const VerifyTokenPayloadSchema: z.ZodObject<{\n token: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n token: string;\n}, {\n token: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 142, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenpayloadschema" }, { "name": "VerifyTokenResponse", "declarationName": "VerifyTokenResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerifyTokenResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 175, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenresponse" }, { "name": "VerifyTokenResponseSchema", "declarationName": "VerifyTokenResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const VerifyTokenResponseSchema: z.ZodObject<{\n valid: z.ZodBoolean;\n token_id: z.ZodOptional;\n subject: z.ZodOptional;\n audience: z.ZodOptional;\n expires_at: z.ZodOptional;\n scopes: z.ZodOptional>;\n error: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n valid: z.ZodBoolean;\n token_id: z.ZodOptional;\n subject: z.ZodOptional;\n audience: z.ZodOptional;\n expires_at: z.ZodOptional;\n scopes: z.ZodOptional>;\n error: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n valid: z.ZodBoolean;\n token_id: z.ZodOptional;\n subject: z.ZodOptional;\n audience: z.ZodOptional;\n expires_at: z.ZodOptional;\n scopes: z.ZodOptional>;\n error: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 150, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenresponseschema" }, { "name": "VERSION", "declarationName": "VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [ { "name": "openagentid", "text": "/arsenal-sdk — Arsenal agent SDK for TypeScript/JavaScript.\n\nARSENAL is an agent-native API key management and secure handoff\nframework. Agents never see raw credentials; they receive short-lived\nAgent Capability Tokens (ACTs) from a broker, and API calls are proxied\nserver-side so credentials are injected without ever reaching the\nagent's process.\n\nQuickstart:\n\n```typescript\nimport { ArsenalClient, TenantId, KeyFingerprint, AgentIdentity } from \"@openagentid/arsenal-sdk\";\n\nconst tenantId = TenantId.generate();\nconst fingerprint = KeyFingerprint.fromBytes(new Uint8Array(32));\nconst identity = AgentIdentity.create(tenantId, \"my-agent\", fingerprint);\n\nconst client = ArsenalClient.create({\nidentity,\nbroker: { baseUrl: \"https://broker.example.com\" },\n});\n\nawait client.startSession();\nconst capability = await client.requestCapabilityForScopes(\n[\"stripe:charges:read\"],\n300,\n);\n\nconst response = await client.proxyHttp({\nmethod: \"GET\",\nurl: \"https://api.stripe.com/v1/charges\",\nheaders: { Authorization: \"Bearer {{OAUTH2_STRIPE_TOKEN}}\" },\ncapability_token: capability.encode(),\n});\n```" } ], "signatures": [ { "code": "declare const VERSION = \"0.1.0\";", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/index.d.ts", "line": 230, "sha256": "9f9d9c9f687cafed872bf02c1f0fc0893987ed80708370986deebaa4040cc34f" } } ], "anchor": "version" }, { "name": "withDevice", "declarationName": "withDevice", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints with a required device binding.", "tags": [], "signatures": [ { "code": "declare function withDevice(base: Constraints, deviceId: string): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 65, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withdevice" }, { "name": "withOrigins", "declarationName": "withOrigins", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints with an allowed-origins binding.", "tags": [], "signatures": [ { "code": "declare function withOrigins(base: Constraints, origins: readonly string[]): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 67, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withorigins" }, { "name": "withPop", "declarationName": "withPop", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints requiring proof-of-possession.", "tags": [], "signatures": [ { "code": "declare function withPop(): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 63, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withpop" }, { "name": "withTimeWindow", "declarationName": "withTimeWindow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints with a time window.", "tags": [], "signatures": [ { "code": "declare function withTimeWindow(base: Constraints, notBefore: Date, notAfter: Date): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 69, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withtimewindow" }, { "name": "zeroize", "declarationName": "zeroize", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Zeroize a `Uint8Array` in place. Use in `finally` blocks for secret buffers.", "tags": [], "signatures": [ { "code": "declare function zeroize(bytes: Uint8Array): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 542, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "zeroize" } ], "supportingDeclarations": [], "coverage": { "discovered": 222, "documented": 222, "missing": [] } }, { "subpath": "./core", "importSpecifier": "@openagentid/arsenal-sdk/core", "page": "/reference/typescript/arsenal-sdk/core", "kind": "declarations", "conditions": { "types": "./dist/core/index.d.ts", "import": "./dist/core/index.js", "require": "./dist/core/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/core/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/core/index.js" }, { "conditions": [ "require" ], "path": "./dist/core/index.cjs" } ], "exports": [ { "name": "addPolicyRule", "declarationName": "addPolicyRule", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Append a rule to a policy, returning a new document.", "tags": [], "signatures": [ { "code": "declare function addPolicyRule(doc: PolicyDocument, rule: PolicyRule): PolicyDocument;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 112, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "addpolicyrule" }, { "name": "AgentCapabilityToken", "declarationName": "AgentCapabilityToken", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Immutable Agent Capability Token. Wraps a set of claims and an optional\nsignature, and provides validation + CBOR (de)serialization.", "tags": [], "signatures": [ { "code": "declare class AgentCapabilityToken {\n readonly claims: TokenClaims;\n readonly signature: TokenSignature | undefined;\n static fromClaims(claims: TokenClaims): AgentCapabilityToken;\n static fromClaimsAndSignature(claims: TokenClaims, signature: TokenSignature): AgentCapabilityToken;\n get id(): string;\n get subject(): string;\n get audience(): string;\n get scopes(): ScopeSet;\n isExpired(now?: Date): boolean;\n isNotYetValid(now?: Date): boolean;\n isTimeValid(now?: Date): boolean;\n remainingTtlMs(now?: Date): number;\n isSigned(): boolean;\n validateStructure(now?: Date): void;\n toCbor(): Uint8Array;\n claimsToCbor(): Uint8Array;\n toBase64Url(): string;\n static fromCbor(bytes: Uint8Array): AgentCapabilityToken;\n static fromBase64Url(s: string): AgentCapabilityToken;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 75, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "agentcapabilitytoken" }, { "name": "AgentId", "declarationName": "AgentId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Agent identifier (UUID v4).", "tags": [], "signatures": [ { "code": "declare class AgentId {\n static fromUuid(uuid: string): AgentId;\n static generate(): AgentId;\n asUuid(): string;\n toString(): string;\n toJSON(): string;\n equals(other: AgentId): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 184, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "agentid" }, { "name": "AgentIdentity", "declarationName": "AgentIdentity", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class AgentIdentity {\n static create(tenantId: TenantId, name: string, publicKeyFingerprint: KeyFingerprint): AgentIdentity;\n get id(): AgentId;\n get publicKeyFingerprint(): KeyFingerprint;\n get tenantId(): TenantId;\n get name(): string;\n get isActive(): boolean;\n get tags(): readonly string[];\n isValid(now?: Date): boolean;\n deactivate(): AgentIdentity;\n withExpiresAt(expiresAt: Date): AgentIdentity;\n withTag(tag: string): AgentIdentity;\n toJSON(): {\n id: string;\n public_key_fingerprint: string;\n tenant_id: string;\n name: string;\n created_at: string;\n expires_at: string | null;\n is_active: boolean;\n tags: readonly string[];\n };\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 237, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "agentidentity" }, { "name": "AgentIdentityData", "declarationName": "AgentIdentityData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Agent identity — the public cryptographic identity of an agent.\n\nContains only public key material — the private key is never stored.", "tags": [], "signatures": [ { "code": "interface AgentIdentityData {\n id: AgentId;\n publicKeyFingerprint: KeyFingerprint;\n tenantId: TenantId;\n name: string;\n createdAt: string;\n expiresAt: string | null;\n isActive: boolean;\n tags: readonly string[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 227, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "agentidentitydata" }, { "name": "allowDelegation", "declarationName": "allowDelegation", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Allow up to `depth` levels of delegation to any agent.", "tags": [], "signatures": [ { "code": "declare function allowDelegation(depth: number): DelegationConstraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 392, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "allowdelegation" }, { "name": "ArsenalError", "declarationName": "ArsenalError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Main error type for ARSENAL operations.\n\nExtends the native `Error` class so it interoperates with standard JS error\nhandling while carrying structured code/correlation/context fields.", "tags": [], "signatures": [ { "code": "declare class ArsenalError extends Error {\n readonly name = \"ArsenalError\";\n readonly code: number;\n readonly correlationId: string | undefined;\n readonly context: ErrorContext | undefined;\n constructor(code: number, message: string, options?: {\n correlationId?: string;\n context?: ErrorContext;\n cause?: unknown;\n });\n toString(): string;\n toJSON(): {\n code: number;\n message: string;\n correlation_id?: string;\n context?: ErrorContext;\n };\n withCorrelationId(id: string): ArsenalError;\n withContext(context: ErrorContext): ArsenalError;\n static authenticationFailed(): ArsenalError;\n static tokenExpired(): ArsenalError;\n static tokenSignatureInvalid(): ArsenalError;\n static tokenRevoked(): ArsenalError;\n static scopeExceeded(): ArsenalError;\n static insufficientPermissions(requiredScope: string): ArsenalError;\n static policyDenied(policyId: string): ArsenalError;\n static rateLimitExceeded(retryAfterSecs?: number): ArsenalError;\n static secretNotFound(): ArsenalError;\n static validationFailed(field: string, reason: string): ArsenalError;\n static internal(): ArsenalError;\n static sessionExpired(): ArsenalError;\n static proxyDestinationViolation(domain: string): ArsenalError;\n static ssrfBlocked(): ArsenalError;\n static templateVariableNotFound(variable: string): ArsenalError;\n static invalidTemplateVariable(name: string): ArsenalError;\n static consentRequired(): ArsenalError;\n static consentDenied(): ArsenalError;\n static fingerprintMismatch(): ArsenalError;\n static configurationError(component: string): ArsenalError;\n static cryptoOperationFailed(): ArsenalError;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 104, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "arsenalerror" }, { "name": "AuditEvent", "declarationName": "AuditEvent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AuditEvent {\n id: string;\n timestamp: string;\n kind: AuditEventKindValue;\n severity: AuditSeverityValue;\n tenant_id: string;\n agent_id?: string;\n session_id?: string;\n token_id?: string;\n outcome: AuditOutcomeValue;\n description: string;\n metadata: Readonly>;\n client_ip?: string;\n user_agent?: string;\n request_id?: string;\n previous_hash?: Uint8Array;\n event_hash?: Uint8Array;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 485, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditevent" }, { "name": "AuditEventKind", "declarationName": "AuditEventKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Kind of audit event.", "tags": [], "signatures": [ { "code": "declare const AuditEventKind: {\n readonly AgentAuthenticated: \"agent_authenticated\";\n readonly AuthenticationFailed: \"authentication_failed\";\n readonly SessionStarted: \"session_started\";\n readonly SessionEnded: \"session_ended\";\n readonly CapabilityRequested: \"capability_requested\";\n readonly CapabilityGranted: \"capability_granted\";\n readonly CapabilityDenied: \"capability_denied\";\n readonly TokenRevoked: \"token_revoked\";\n readonly SecretRead: \"secret_read\";\n readonly SecretRotated: \"secret_rotated\";\n readonly ProxyRequest: \"proxy_request\";\n readonly ProxyDenied: \"proxy_denied\";\n readonly ConsentRequested: \"consent_requested\";\n readonly ConsentApproved: \"consent_approved\";\n readonly ConsentDenied: \"consent_denied\";\n readonly ConsentRevoked: \"consent_revoked\";\n readonly PolicyEvaluated: \"policy_evaluated\";\n readonly PolicyViolation: \"policy_violation\";\n readonly ConfigChanged: \"config_changed\";\n readonly KeyRotated: \"key_rotated\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 462, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditeventkind" }, { "name": "AuditEventKindValue", "declarationName": "AuditEventKindValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuditEventKindValue = (typeof AuditEventKind)[keyof typeof AuditEventKind];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 484, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditeventkindvalue" }, { "name": "AuditOutcome", "declarationName": "AuditOutcome", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const AuditOutcome: {\n readonly Success: \"success\";\n readonly Failure: \"failure\";\n readonly Partial: \"partial\";\n readonly Pending: \"pending\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 454, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditoutcome" }, { "name": "AuditOutcomeValue", "declarationName": "AuditOutcomeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuditOutcomeValue = (typeof AuditOutcome)[keyof typeof AuditOutcome];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 460, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditoutcomevalue" }, { "name": "AuditSeverity", "declarationName": "AuditSeverity", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Audit event types. The hash chain integrity checks are performed by the\nbroker, but the type shape is defined here for parity with\n`arsenal_core::audit`.", "tags": [], "signatures": [ { "code": "declare const AuditSeverity: {\n readonly Info: \"info\";\n readonly Warning: \"warning\";\n readonly Error: \"error\";\n readonly Critical: \"critical\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 447, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditseverity" }, { "name": "AuditSeverityValue", "declarationName": "AuditSeverityValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AuditSeverityValue = (typeof AuditSeverity)[keyof typeof AuditSeverity];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 453, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "auditseverityvalue" }, { "name": "base64Decode", "declarationName": "base64Decode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a base64 string (standard or URL alphabet, with or without padding).", "tags": [], "signatures": [ { "code": "declare function base64Decode(s: string): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 534, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64decode" }, { "name": "base64Encode", "declarationName": "base64Encode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes to base64 (standard alphabet, no padding).", "tags": [], "signatures": [ { "code": "declare function base64Encode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 530, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64encode" }, { "name": "base64UrlDecode", "declarationName": "base64UrlDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a base64url string. Same as `base64Decode` for convenience.", "tags": [], "signatures": [ { "code": "declare function base64UrlDecode(s: string): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 536, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64urldecode" }, { "name": "base64UrlEncode", "declarationName": "base64UrlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes to base64url (URL-safe alphabet, no padding).", "tags": [], "signatures": [ { "code": "declare function base64UrlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 532, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "base64urlencode" }, { "name": "BindingType", "declarationName": "BindingType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Constraints that bind ACTs to specific contexts.\n\nTokens can be restricted to a specific device, session, origin, IP range,\ntime window, or environment. Constraints are evaluated at the broker and\nat the proxy boundary.", "tags": [], "signatures": [ { "code": "declare const BindingType: {\n readonly Required: \"required\";\n readonly Preferred: \"preferred\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 8, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtype" }, { "name": "BindingTypeValue", "declarationName": "BindingTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type BindingTypeValue = (typeof BindingType)[keyof typeof BindingType];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 12, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtypevalue" }, { "name": "buildTokenClaims", "declarationName": "buildTokenClaims", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate and build a fresh set of token claims.", "tags": [], "signatures": [ { "code": "declare function buildTokenClaims(opts: TokenClaimsBuildOptions): TokenClaims;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 70, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "buildtokenclaims" }, { "name": "canDelegateTo", "declarationName": "canDelegateTo", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check whether a delegation to the given agent id is permitted.", "tags": [], "signatures": [ { "code": "declare function canDelegateTo(constraints: DelegationConstraints, agentId: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 394, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "candelegateto" }, { "name": "canTransitionTo", "declarationName": "canTransitionTo", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function canTransitionTo(from: SessionStateValue, to: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 427, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "cantransitionto" }, { "name": "CompositeRateLimiter", "declarationName": "CompositeRateLimiter", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Composite rate limiter combining multiple time windows + concurrent cap.\n\nUse `acquire()` which returns a release function — call it when the\nrequest completes (e.g. in a `finally`) to decrement the concurrent\ncounter. If any individual limit rejects, already-consumed slots are\nrolled back.", "tags": [], "signatures": [ { "code": "declare class CompositeRateLimiter {\n constructor(limits: RateLimits);\n acquire(): () => void;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 175, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "compositeratelimiter" }, { "name": "ConditionOperator", "declarationName": "ConditionOperator", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConditionOperator: {\n readonly Equals: \"equals\";\n readonly NotEquals: \"not_equals\";\n readonly Contains: \"contains\";\n readonly StartsWith: \"starts_with\";\n readonly EndsWith: \"ends_with\";\n readonly Matches: \"matches\";\n readonly In: \"in\";\n readonly NotIn: \"not_in\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 25, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "conditionoperator" }, { "name": "ConditionOperatorValue", "declarationName": "ConditionOperatorValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConditionOperatorValue = (typeof ConditionOperator)[keyof typeof ConditionOperator];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 35, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "conditionoperatorvalue" }, { "name": "ConsentPolicy", "declarationName": "ConsentPolicy", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentPolicy: {\n readonly PerVariable: \"per_variable\";\n readonly PerProvider: \"per_provider\";\n readonly PerAgent: \"per_agent\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 118, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentpolicy" }, { "name": "ConsentPolicyValue", "declarationName": "ConsentPolicyValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentPolicyValue = (typeof ConsentPolicy)[keyof typeof ConsentPolicy];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 123, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentpolicyvalue" }, { "name": "ConsentRecord", "declarationName": "ConsentRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ConsentRecord {\n consent_id: string;\n tenant_id: string;\n agent_did: string;\n human_root_did: string;\n variables: readonly string[];\n destination_domains: readonly string[];\n scopes: readonly string[];\n granted_by: string;\n granted_at: string;\n expires_at: string;\n signature: Uint8Array;\n revocable: boolean;\n revoked: boolean;\n revoked_at?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 124, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecord" }, { "name": "consentRecordCoversDomain", "declarationName": "consentRecordCoversDomain", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the record covers the given destination domain (case-insensitive).", "tags": [], "signatures": [ { "code": "declare function consentRecordCoversDomain(record: ConsentRecord, domain: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 146, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordcoversdomain" }, { "name": "consentRecordCoversVariable", "declarationName": "consentRecordCoversVariable", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the record covers the given variable name.", "tags": [], "signatures": [ { "code": "declare function consentRecordCoversVariable(record: ConsentRecord, variable: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 144, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordcoversvariable" }, { "name": "consentRecordIsValid", "declarationName": "consentRecordIsValid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validity check (not revoked and not expired).", "tags": [], "signatures": [ { "code": "declare function consentRecordIsValid(record: ConsentRecord, now?: Date): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 142, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordisvalid" }, { "name": "consentRecordSigningBytes", "declarationName": "consentRecordSigningBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Canonical CBOR encoding of the signable subset (excludes signature,\nrevoked, revoked_at). This is the byte sequence a human root key signs\nwith Ed25519 to produce `record.signature`.", "tags": [], "signatures": [ { "code": "declare function consentRecordSigningBytes(record: ConsentRecord): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 154, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrecordsigningbytes" }, { "name": "ConsentRequest", "declarationName": "ConsentRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ConsentRequest {\n request_id: string;\n agent_did: string;\n human_root_did: string;\n variables: readonly string[];\n destination_domains: readonly string[];\n scopes: readonly string[];\n created_at: string;\n expires_at: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 155, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrequest" }, { "name": "consentRequestIsExpired", "declarationName": "consentRequestIsExpired", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function consentRequestIsExpired(req: ConsentRequest, now?: Date): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 174, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentrequestisexpired" }, { "name": "ConsentStatus", "declarationName": "ConsentStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Consent protocol types for human-in-the-loop credential authorization.", "tags": [], "signatures": [ { "code": "declare const ConsentStatus: {\n readonly PreApproved: \"pre_approved\";\n readonly Approved: \"approved\";\n readonly Pending: \"pending\";\n readonly Denied: \"denied\";\n readonly Revoked: \"revoked\";\n readonly NotRequired: \"not_required\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 108, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatus" }, { "name": "consentStatusAllowsOperation", "declarationName": "consentStatusAllowsOperation", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function consentStatusAllowsOperation(status: ConsentStatusValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 117, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatusallowsoperation" }, { "name": "ConsentStatusValue", "declarationName": "ConsentStatusValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentStatusValue = (typeof ConsentStatus)[keyof typeof ConsentStatus];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 116, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatusvalue" }, { "name": "ConstraintContext", "declarationName": "ConstraintContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ConstraintContext {\n current_time: Date;\n device_id?: string;\n session_id?: string;\n session_key_hash?: Uint8Array;\n origin?: string;\n client_ip?: string;\n environment?: string;\n tags: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 50, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "constraintcontext" }, { "name": "Constraints", "declarationName": "Constraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Constraints {\n device_binding?: DeviceBinding;\n session_binding?: SessionBinding;\n origin_binding?: OriginBinding;\n network_constraints?: NetworkConstraints;\n time_constraints?: TimeConstraints;\n environment_constraints?: EnvironmentConstraint;\n require_pop: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 41, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "constraints" }, { "name": "contextNow", "declarationName": "contextNow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a fresh ConstraintContext with current_time=now().", "tags": [], "signatures": [ { "code": "declare function contextNow(): ConstraintContext;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 71, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "contextnow" }, { "name": "createAuditEvent", "declarationName": "createAuditEvent", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new audit event.", "tags": [], "signatures": [ { "code": "declare function createAuditEvent(opts: {\n kind: AuditEventKindValue;\n tenant_id: string;\n severity?: AuditSeverityValue;\n outcome?: AuditOutcomeValue;\n description?: string;\n metadata?: Record;\n agent_id?: string;\n session_id?: string;\n token_id?: string;\n client_ip?: string;\n user_agent?: string;\n request_id?: string;\n}): AuditEvent;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 504, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "createauditevent" }, { "name": "createConsentRequest", "declarationName": "createConsentRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new consent request with validation.", "tags": [], "signatures": [ { "code": "declare function createConsentRequest(opts: {\n agent_did: string;\n human_root_did: string;\n variables: readonly string[];\n destination_domains: readonly string[];\n scopes: readonly string[];\n ttl_seconds?: number;\n}): ConsentRequest;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 166, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "createconsentrequest" }, { "name": "createDestinationBinding", "declarationName": "createDestinationBinding", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create and validate a destination binding.", "tags": [], "signatures": [ { "code": "declare function createDestinationBinding(allowedDomains: readonly string[], opts?: Partial>): DestinationBinding;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 205, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "createdestinationbinding" }, { "name": "createPolicyDocument", "declarationName": "createPolicyDocument", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a new policy document (no rules yet).", "tags": [], "signatures": [ { "code": "declare function createPolicyDocument(tenantId: string, name: string): PolicyDocument;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 110, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "createpolicydocument" }, { "name": "createPolicyRequest", "declarationName": "createPolicyRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new policy request with current timestamp.", "tags": [], "signatures": [ { "code": "declare function createPolicyRequest(agentId: string, tenantId: string, requestedScope: string): PolicyRequest;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 123, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "createpolicyrequest" }, { "name": "createPolicyRule", "declarationName": "createPolicyRule", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a simple rule. Conditions are added via spread.", "tags": [], "signatures": [ { "code": "declare function createPolicyRule(id: string, effect: PolicyEffectValue, conditions?: readonly PolicyCondition[]): PolicyRule;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 87, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "createpolicyrule" }, { "name": "createSecretMetadata", "declarationName": "createSecretMetadata", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a new secret metadata record.", "tags": [], "signatures": [ { "code": "declare function createSecretMetadata(tenantId: string, name: string, secretType: SecretTypeValue): SecretMetadata;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 340, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "createsecretmetadata" }, { "name": "createTemplateVariable", "declarationName": "createTemplateVariable", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a template variable, validating the name.", "tags": [], "signatures": [ { "code": "declare function createTemplateVariable(name: string): TemplateVariable;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 219, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "createtemplatevariable" }, { "name": "decisionIsAllowed", "declarationName": "decisionIsAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the decision allows the action.", "tags": [], "signatures": [ { "code": "declare function decisionIsAllowed(d: PolicyDecision): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 130, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "decisionisallowed" }, { "name": "decisionIsDenied", "declarationName": "decisionIsDenied", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the decision denies the action.", "tags": [], "signatures": [ { "code": "declare function decisionIsDenied(d: PolicyDecision): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 132, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "decisionisdenied" }, { "name": "decodeCbor", "declarationName": "decodeCbor", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a CBOR byte string into a plain JS value.", "tags": [], "signatures": [ { "code": "declare function decodeCbor(bytes: Uint8Array): unknown;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 566, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "decodecbor" }, { "name": "defaultRateLimits", "declarationName": "defaultRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Default moderate rate limits (same as Rust `RateLimits::default()`).", "tags": [], "signatures": [ { "code": "declare function defaultRateLimits(): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 95, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "defaultratelimits" }, { "name": "defaultUsageBudget", "declarationName": "defaultUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function defaultUsageBudget(): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 109, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "defaultusagebudget" }, { "name": "DelegationConstraints", "declarationName": "DelegationConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DelegationConstraints {\n allow_delegation: boolean;\n max_depth: number;\n delegatable_scopes?: ScopeSet;\n allowed_delegates: readonly string[];\n allow_any_delegate: boolean;\n min_ttl_reduction: number;\n require_approval: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 379, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "delegationconstraints" }, { "name": "denyDelegation", "declarationName": "denyDelegation", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Default: delegation denied.", "tags": [], "signatures": [ { "code": "declare function denyDelegation(): DelegationConstraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 390, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "denydelegation" }, { "name": "DestinationBinding", "declarationName": "DestinationBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Destination binding restricting which endpoints a credential can reach.", "tags": [], "signatures": [ { "code": "interface DestinationBinding {\n allowed_domains: readonly string[];\n allowed_paths?: readonly string[];\n allowed_methods?: readonly string[];\n allowed_ports?: readonly number[];\n require_tls: boolean;\n allow_subdomains: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 196, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "destinationbinding" }, { "name": "DeviceBinding", "declarationName": "DeviceBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DeviceBinding {\n device_id: string;\n binding_type: BindingTypeValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 13, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "devicebinding" }, { "name": "DeviceId", "declarationName": "DeviceId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Device identifier for device binding.", "tags": [], "signatures": [ { "code": "declare class DeviceId {\n static parse(id: string): DeviceId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 195, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "deviceid" }, { "name": "effectiveTimeoutMs", "declarationName": "effectiveTimeoutMs", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve the effective timeout, capped to MAX_TIMEOUT_MS.", "tags": [], "signatures": [ { "code": "declare function effectiveTimeoutMs(req: ProxyRequest): number;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 240, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "effectivetimeoutms" }, { "name": "encodeCbor", "declarationName": "encodeCbor", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode a value to deterministic CBOR bytes.", "tags": [], "signatures": [ { "code": "declare function encodeCbor(value: unknown): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 564, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "encodecbor" }, { "name": "EnvironmentConstraint", "declarationName": "EnvironmentConstraint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface EnvironmentConstraint {\n required_environment?: string;\n required_tags?: ReadonlySet;\n forbidden_tags?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 36, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "environmentconstraint" }, { "name": "ErrorCode", "declarationName": "ErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for programmatic handling. Numeric values match the Rust crate\n`arsenal_core::error::ErrorCode` so wire-level cross-language parity holds.", "tags": [], "signatures": [ { "code": "declare const ErrorCode: {\n readonly AuthenticationFailed: 1001;\n readonly TokenExpired: 1002;\n readonly TokenSignatureInvalid: 1003;\n readonly PopVerificationFailed: 1004;\n readonly IdentityInvalid: 1005;\n readonly SessionExpired: 1006;\n readonly InsufficientPermissions: 2001;\n readonly ScopeExceeded: 2002;\n readonly PolicyDenied: 2003;\n readonly DelegationInvalid: 2004;\n readonly RateLimitExceeded: 2005;\n readonly BudgetExhausted: 2006;\n readonly TimeConstraintViolation: 3001;\n readonly EnvironmentBindingViolation: 3002;\n readonly NetworkConstraintViolation: 3003;\n readonly DeviceBindingViolation: 3004;\n readonly OriginBindingViolation: 3005;\n readonly SecretNotFound: 4001;\n readonly SecretVersionNotFound: 4002;\n readonly SecretRevoked: 4003;\n readonly SecretRotationInProgress: 4004;\n readonly SecretUnwrapLimitExceeded: 4005;\n readonly CryptoOperationFailed: 4006;\n readonly ValidationFailed: 5001;\n readonly MalformedRequest: 5002;\n readonly InvalidTokenFormat: 5003;\n readonly InvalidScopeFormat: 5004;\n readonly InvalidConstraint: 5005;\n readonly InternalError: 6001;\n readonly StorageError: 6002;\n readonly ConfigurationError: 6003;\n readonly CryptoSubsystemError: 6004;\n readonly AuditError: 6005;\n readonly SerializationFailed: 6006;\n readonly TokenRevoked: 7001;\n readonly AgentDeactivated: 7002;\n readonly TenantSuspended: 7003;\n readonly RevocationStatusUnknown: 7004;\n readonly ProxyDestinationViolation: 8001;\n readonly ProxyRequestFailed: 8002;\n readonly ProxyTimeout: 8003;\n readonly SsrfBlocked: 8004;\n readonly TemplateVariableNotFound: 8005;\n readonly TemplateVariableAccessDenied: 8006;\n readonly InvalidTemplateVariable: 8007;\n readonly OAuthReauthRequired: 8008;\n readonly ConsentRequired: 9001;\n readonly ConsentDenied: 9002;\n readonly ConsentExpired: 9003;\n readonly ConsentRevoked: 9004;\n readonly FingerprintMismatch: 10001;\n readonly FingerprintStateNotFound: 10002;\n readonly DctScopeAmplification: 11001;\n readonly DctDepthExceeded: 11002;\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 19, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "errorcode" }, { "name": "ErrorCodeValue", "declarationName": "ErrorCodeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ErrorCodeValue = (typeof ErrorCode)[keyof typeof ErrorCode];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 75, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "errorcodevalue" }, { "name": "ErrorContext", "declarationName": "ErrorContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Additional structured context attached to an ArsenalError. All fields are\nsanitized — never include raw secrets or internal paths.", "tags": [], "signatures": [ { "code": "interface ErrorContext {\n operation?: string;\n resource?: string;\n constraint?: string;\n timestamp?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 92, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "errorcontext" }, { "name": "extractProxyRequestVariables", "declarationName": "extractProxyRequestVariables", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extract all template variables used anywhere in a proxy request.", "tags": [], "signatures": [ { "code": "declare function extractProxyRequestVariables(req: ProxyRequest): readonly TemplateVariable[];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 242, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "extractproxyrequestvariables" }, { "name": "hashAuditEvent", "declarationName": "hashAuditEvent", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compute a BLAKE3 hash of an audit event. The hash is used for chain\nlinkage and tamper detection. The result is a 32-byte `Uint8Array`.", "tags": [], "signatures": [ { "code": "declare function hashAuditEvent(event: AuditEvent): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 522, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "hashauditevent" }, { "name": "hexDecode", "declarationName": "hexDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode a hex string into bytes. Throws on invalid input.", "tags": [], "signatures": [ { "code": "declare function hexDecode(s: string): Uint8Array;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 540, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "hexdecode" }, { "name": "hexEncode", "declarationName": "hexEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encode bytes as lowercase hex.", "tags": [], "signatures": [ { "code": "declare function hexEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 538, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "hexencode" }, { "name": "inferVariablePrefix", "declarationName": "inferVariablePrefix", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Infer the credential-type prefix from a variable name.", "tags": [], "signatures": [ { "code": "declare function inferVariablePrefix(name: string): VariablePrefixValue;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 222, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "infervariableprefix" }, { "name": "ipInCidrRange", "declarationName": "ipInCidrRange", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check if a dotted-quad or IPv6 address falls inside a CIDR range.\nSupports both IPv4 and IPv6. Invalid CIDR or IP input returns false.", "tags": [], "signatures": [ { "code": "declare function ipInCidrRange(ip: string, cidr: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 81, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "ipincidrrange" }, { "name": "isClientError", "declarationName": "isClientError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 1000..5999 client-error range.", "tags": [], "signatures": [ { "code": "declare function isClientError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 77, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isclienterror" }, { "name": "isConsentError", "declarationName": "isConsentError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 9000..9999 consent error range.", "tags": [], "signatures": [ { "code": "declare function isConsentError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 83, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isconsenterror" }, { "name": "isDomainAllowed", "declarationName": "isDomainAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check if a domain is allowed by the binding.", "tags": [], "signatures": [ { "code": "declare function isDomainAllowed(binding: DestinationBinding, domain: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 209, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "isdomainallowed" }, { "name": "isFingerprintError", "declarationName": "isFingerprintError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 10000..10999 fingerprint range.", "tags": [], "signatures": [ { "code": "declare function isFingerprintError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 85, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isfingerprinterror" }, { "name": "isMethodAllowed", "declarationName": "isMethodAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function isMethodAllowed(binding: DestinationBinding, method: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 210, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "ismethodallowed" }, { "name": "isPathAllowed", "declarationName": "isPathAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function isPathAllowed(binding: DestinationBinding, path: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 212, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "ispathallowed" }, { "name": "isPermanentError", "declarationName": "isPermanentError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error is permanent (retry will not help).", "tags": [], "signatures": [ { "code": "declare function isPermanentError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 87, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "ispermanenterror" }, { "name": "isPortAllowed", "declarationName": "isPortAllowed", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function isPortAllowed(binding: DestinationBinding, port: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 211, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "isportallowed" }, { "name": "isProxyError", "declarationName": "isProxyError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 8000..8999 proxy error range.", "tags": [], "signatures": [ { "code": "declare function isProxyError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 81, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isproxyerror" }, { "name": "isServerError", "declarationName": "isServerError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the error code falls into the 6000..6999 server-error range.", "tags": [], "signatures": [ { "code": "declare function isServerError(code: number): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 79, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "isservererror" }, { "name": "KeyFingerprint", "declarationName": "KeyFingerprint", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Public-key fingerprint — BLAKE3 hash (32 bytes) of a public key.\n\nUses a constant-time compare for equality checks.", "tags": [], "signatures": [ { "code": "declare class KeyFingerprint {\n static fromBytes(bytes: Uint8Array): KeyFingerprint;\n static fromPublicKey(publicKey: Uint8Array): Promise;\n static fromHex(hex: string): KeyFingerprint;\n asBytes(): Uint8Array;\n toHex(): string;\n toString(): string;\n constantTimeEquals(other: KeyFingerprint): boolean;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 208, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "keyfingerprint" }, { "name": "latestSecretRef", "declarationName": "latestSecretRef", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Reference to the latest version.", "tags": [], "signatures": [ { "code": "declare function latestSecretRef(id: string): SecretRef;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 347, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "latestsecretref" }, { "name": "MAX_CHAIN_LENGTH", "declarationName": "MAX_CHAIN_LENGTH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Maximum number of tokens in a delegation chain.", "tags": [], "signatures": [ { "code": "declare const MAX_CHAIN_LENGTH = 10;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 378, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "max_chain_length" }, { "name": "MAX_CONDITION_DEPTH", "declarationName": "MAX_CONDITION_DEPTH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Maximum recursion depth for nested And/Or/Not conditions.", "tags": [], "signatures": [ { "code": "declare const MAX_CONDITION_DEPTH = 16;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 10, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "max_condition_depth" }, { "name": "MAX_DELEGATION_DEPTH", "declarationName": "MAX_DELEGATION_DEPTH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Maximum absolute delegation depth allowed anywhere in the system.", "tags": [], "signatures": [ { "code": "declare const MAX_DELEGATION_DEPTH = 5;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 376, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "max_delegation_depth" }, { "name": "mergeRateLimits", "declarationName": "mergeRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Merge two limit configs taking the more restrictive (minimum) value.", "tags": [], "signatures": [ { "code": "declare function mergeRateLimits(a: RateLimits, b: RateLimits): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 101, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "mergeratelimits" }, { "name": "mergeUsageBudget", "declarationName": "mergeUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function mergeUsageBudget(a: UsageBudget, b: UsageBudget): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 112, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "mergeusagebudget" }, { "name": "minimalUsageBudget", "declarationName": "minimalUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function minimalUsageBudget(): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 111, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "minimalusagebudget" }, { "name": "NetworkConstraints", "declarationName": "NetworkConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface NetworkConstraints {\n allowed_ips?: ReadonlySet;\n denied_ips?: ReadonlySet;\n allowed_cidrs?: readonly string[];\n allowed_asns?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 24, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "networkconstraints" }, { "name": "noConstraints", "declarationName": "noConstraints", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build an empty constraint object (no restrictions).", "tags": [], "signatures": [ { "code": "declare function noConstraints(): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 61, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "noconstraints" }, { "name": "OriginBinding", "declarationName": "OriginBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OriginBinding {\n allowed_origins: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 21, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "originbinding" }, { "name": "parsePermission", "declarationName": "parsePermission", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse a string into a Permission value. Throws on unknown input.", "tags": [], "signatures": [ { "code": "declare function parsePermission(s: string): PermissionValue;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 266, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "parsepermission" }, { "name": "parseTemplateVariables", "declarationName": "parseTemplateVariables", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse all `{{VARIABLE}}` placeholders from a string. Invalid names\ninside `{{}}` are silently skipped. Duplicates are deduplicated.", "tags": [], "signatures": [ { "code": "declare function parseTemplateVariables(input: string): readonly TemplateVariable[];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 227, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "parsetemplatevariables" }, { "name": "Permission", "declarationName": "Permission", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "CRUD permission classification.", "tags": [], "signatures": [ { "code": "declare const Permission: {\n readonly Read: \"read\";\n readonly Create: \"create\";\n readonly Update: \"update\";\n readonly Delete: \"delete\";\n readonly Admin: \"admin\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 255, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "permission" }, { "name": "permissionImplies", "declarationName": "permissionImplies", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Check if permission `a` implies permission `b`.", "tags": [], "signatures": [ { "code": "declare function permissionImplies(a: PermissionValue, b: PermissionValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 264, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "permissionimplies" }, { "name": "PermissionValue", "declarationName": "PermissionValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PermissionValue = (typeof Permission)[keyof typeof Permission];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 262, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "permissionvalue" }, { "name": "PolicyCondition", "declarationName": "PolicyCondition", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyCondition = {\n type: \"agent_id\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"tenant_id\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"scope\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"environment\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"time_of_day\";\n allowed_hours: readonly number[];\n} | {\n type: \"day_of_week\";\n allowed_days: readonly number[];\n} | {\n type: \"ip_address\";\n allowed_cidrs: readonly string[];\n} | {\n type: \"attribute\";\n key: string;\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"and\";\n conditions: readonly PolicyCondition[];\n} | {\n type: \"or\";\n conditions: readonly PolicyCondition[];\n} | {\n type: \"not\";\n condition: PolicyCondition;\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 36, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policycondition" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n effect: PolicyEffectValue;\n matched_rule?: string;\n reason?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 124, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policydecision" }, { "name": "PolicyDocument", "declarationName": "PolicyDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDocument {\n id: string;\n version: number;\n tenant_id: string;\n name: string;\n description?: string;\n rules: readonly PolicyRule[];\n default_effect: PolicyEffectValue;\n is_active: boolean;\n priority: number;\n created_at: string;\n updated_at: string;\n signature?: PolicySignature;\n labels: Readonly>;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 94, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policydocument" }, { "name": "PolicyEffect", "declarationName": "PolicyEffect", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PolicyEffect: {\n readonly Allow: \"allow\";\n readonly Deny: \"deny\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 20, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyeffect" }, { "name": "PolicyEffectValue", "declarationName": "PolicyEffectValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyEffectValue = (typeof PolicyEffect)[keyof typeof PolicyEffect];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 24, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyeffectvalue" }, { "name": "PolicyId", "declarationName": "PolicyId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class PolicyId {\n static parse(id: string): PolicyId;\n static generate(): PolicyId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 11, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyid" }, { "name": "PolicyRequest", "declarationName": "PolicyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRequest {\n agent_id: string;\n tenant_id: string;\n requested_scope: string;\n timestamp: Date;\n environment?: string;\n client_ip?: string;\n attributes: Readonly>;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 113, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyrequest" }, { "name": "PolicyRule", "declarationName": "PolicyRule", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRule {\n id: string;\n description?: string;\n effect: PolicyEffectValue;\n conditions: readonly PolicyCondition[];\n scopes?: ScopeSet;\n constraints?: Constraints;\n rate_limits?: RateLimits;\n budget?: UsageBudget;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 76, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyrule" }, { "name": "PolicySignature", "declarationName": "PolicySignature", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicySignature {\n bytes: Uint8Array;\n algorithm: string;\n key_id: string;\n signed_at: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 88, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policysignature" }, { "name": "PrincipalId", "declarationName": "PrincipalId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Principal identifier — user, service account, or system principal.", "tags": [], "signatures": [ { "code": "declare class PrincipalId {\n static parse(id: string): PrincipalId;\n static generate(): PrincipalId;\n static system(): PrincipalId;\n isSystem(): boolean;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 172, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "principalid" }, { "name": "ProofOfPossession", "declarationName": "ProofOfPossession", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ProofOfPossession {\n key_fingerprint: string;\n alg: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 23, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proofofpossession" }, { "name": "ProxyMetadata", "declarationName": "ProxyMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Metadata about proxy processing (never includes resolved values).", "tags": [], "signatures": [ { "code": "interface ProxyMetadata {\n variables_resolved: readonly string[];\n destination_verified: boolean;\n fingerprint_verified: boolean;\n consent_status: ConsentStatusValue;\n latency_ms: number;\n request_id: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 251, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxymetadata" }, { "name": "ProxyRequest", "declarationName": "ProxyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Proxy request envelope sent to the broker.", "tags": [], "signatures": [ { "code": "interface ProxyRequest {\n method: string;\n url: string;\n headers?: Readonly>;\n body?: Uint8Array;\n capability_token: string;\n timeout_ms?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 229, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxyrequest" }, { "name": "ProxyResponse", "declarationName": "ProxyResponse", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Response from a proxy request.", "tags": [], "signatures": [ { "code": "interface ProxyResponse {\n status: number;\n headers: Readonly>;\n body: Uint8Array;\n proxy_metadata: ProxyMetadata;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 244, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxyresponse" }, { "name": "RateLimits", "declarationName": "RateLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Rate limits, usage budgets, and runtime tracking primitives.", "tags": [], "signatures": [ { "code": "interface RateLimits {\n requests_per_second?: number;\n requests_per_minute?: number;\n requests_per_hour?: number;\n max_concurrent?: number;\n max_request_size?: number;\n max_response_size?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 86, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "ratelimits" }, { "name": "RemainingBudget", "declarationName": "RemainingBudget", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Remaining budget (undefined entries are unlimited).", "tags": [], "signatures": [ { "code": "interface RemainingBudget {\n requests?: number;\n bytes?: number;\n cost_units?: number;\n secret_unwraps?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 122, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "remainingbudget" }, { "name": "revokeConsentRecord", "declarationName": "revokeConsentRecord", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Return a revoked copy of the consent record.", "tags": [], "signatures": [ { "code": "declare function revokeConsentRecord(record: ConsentRecord, at?: Date): ConsentRecord;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 148, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "revokeconsentrecord" }, { "name": "sanitizeFieldName", "declarationName": "sanitizeFieldName", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strip unsafe characters from a field name.", "tags": [], "signatures": [ { "code": "declare function sanitizeFieldName(field: string): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 152, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sanitizefieldname" }, { "name": "sanitizeResourceId", "declarationName": "sanitizeResourceId", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strip path-traversal characters and cap length.", "tags": [], "signatures": [ { "code": "declare function sanitizeResourceId(id: string): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 148, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sanitizeresourceid" }, { "name": "sanitizeScope", "declarationName": "sanitizeScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strip unsafe characters from a scope; keep separators.", "tags": [], "signatures": [ { "code": "declare function sanitizeScope(scope: string): string;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 150, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sanitizescope" }, { "name": "Scope", "declarationName": "Scope", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A single permission scope.", "tags": [], "signatures": [ { "code": "declare class Scope {\n static parse(scope: string): Scope;\n static wildcard(): Scope;\n static readOnly(service: string): Scope;\n static fullAccess(service: string): Scope;\n get service(): string;\n get resource(): string;\n get action(): string;\n isWildcard(): boolean;\n implies(other: Scope): boolean;\n asString(): string;\n toString(): string;\n toJSON(): string;\n equals(other: Scope): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 200, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scope" }, { "name": "ScopeSet", "declarationName": "ScopeSet", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A set of scopes, maintained as a sorted list for deterministic encoding.", "tags": [], "signatures": [ { "code": "declare class ScopeSet {\n static empty(): ScopeSet;\n static single(scope: Scope): ScopeSet;\n static fromStrings(scopes: readonly string[]): ScopeSet;\n static fromScopes(scopes: readonly Scope[]): ScopeSet;\n add(scope: Scope): ScopeSet;\n remove(scope: Scope): ScopeSet;\n contains(scope: Scope): boolean;\n allows(requested: Scope): boolean;\n isSupersetOf(other: ScopeSet): boolean;\n intersection(other: ScopeSet): ScopeSet;\n union(other: ScopeSet): ScopeSet;\n get length(): number;\n isEmpty(): boolean;\n toArray(): readonly Scope[];\n toStrings(): readonly string[];\n [Symbol.iterator](): Iterator;\n toJSON(): readonly string[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 228, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scopeset" }, { "name": "SecretId", "declarationName": "SecretId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Secret identifier.", "tags": [], "signatures": [ { "code": "declare class SecretId {\n static generate(): SecretId;\n static fromString(id: string): SecretId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 275, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretid" }, { "name": "SecretMetadata", "declarationName": "SecretMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SecretMetadata {\n id: string;\n tenant_id: string;\n name: string;\n description?: string;\n secret_type: SecretTypeValue;\n current_version: number;\n versions: readonly SecretVersionInfo[];\n created_at: string;\n updated_at: string;\n expires_at?: string;\n last_rotated_at?: string;\n next_rotation_at?: string;\n is_active: boolean;\n labels: Readonly>;\n service?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 322, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretmetadata" }, { "name": "SecretRef", "declarationName": "SecretRef", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Reference to a secret — used when the value shouldn't be inlined.", "tags": [], "signatures": [ { "code": "interface SecretRef {\n id: string;\n version?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 342, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretref" }, { "name": "SecretType", "declarationName": "SecretType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretType: {\n readonly ApiKey: \"api_key\";\n readonly OAuthClientCredentials: \"o_auth_client_credentials\";\n readonly OAuthAccessToken: \"o_auth_access_token\";\n readonly OAuthRefreshToken: \"o_auth_refresh_token\";\n readonly DatabaseCredentials: \"database_credentials\";\n readonly SshKey: \"ssh_key\";\n readonly TlsCertificate: \"tls_certificate\";\n readonly SigningKey: \"signing_key\";\n readonly EncryptionKey: \"encryption_key\";\n readonly Generic: \"generic\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 296, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secrettype" }, { "name": "SecretTypeValue", "declarationName": "SecretTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretTypeValue = (typeof SecretType)[keyof typeof SecretType];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 308, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secrettypevalue" }, { "name": "SecretValue", "declarationName": "SecretValue", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Secret value holder that clears its internal buffer when `zeroize()` is\ncalled. JS has no destructors, so callers must explicitly invoke\n`zeroize()` in a `finally` block after use.", "tags": [], "signatures": [ { "code": "declare class SecretValue {\n static fromBytes(bytes: Uint8Array): SecretValue;\n static fromString(s: string): SecretValue;\n asBytes(): Uint8Array;\n asString(): string;\n get length(): number;\n isEmpty(): boolean;\n zeroize(): void;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 355, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretvalue" }, { "name": "SecretVersion", "declarationName": "SecretVersion", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Secret version number (1-based).", "tags": [], "signatures": [ { "code": "declare class SecretVersion {\n static initial(): SecretVersion;\n static fromNumber(n: number): SecretVersion;\n asNumber(): number;\n next(): SecretVersion;\n isInitial(): boolean;\n toString(): string;\n toJSON(): number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 285, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversion" }, { "name": "SecretVersionInfo", "declarationName": "SecretVersionInfo", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SecretVersionInfo {\n version: number;\n created_at: string;\n created_by?: string;\n state: SecretVersionStateValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 316, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversioninfo" }, { "name": "SecretVersionState", "declarationName": "SecretVersionState", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretVersionState: {\n readonly Active: \"active\";\n readonly Previous: \"previous\";\n readonly Disabled: \"disabled\";\n readonly PendingDeletion: \"pending_deletion\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 309, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversionstate" }, { "name": "SecretVersionStateValue", "declarationName": "SecretVersionStateValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretVersionStateValue = (typeof SecretVersionState)[keyof typeof SecretVersionState];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 315, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "secretversionstatevalue" }, { "name": "SessionBinding", "declarationName": "SessionBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionBinding {\n session_id: string;\n session_key_hash?: Uint8Array;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 17, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "sessionbinding" }, { "name": "SessionEndReason", "declarationName": "SessionEndReason", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SessionEndReason: {\n readonly Completed: \"completed\";\n readonly Logout: \"logout\";\n readonly Timeout: \"timeout\";\n readonly TokenExpired: \"token_expired\";\n readonly Revoked: \"revoked\";\n readonly SecurityViolation: \"security_violation\";\n readonly PolicyViolation: \"policy_violation\";\n readonly SystemShutdown: \"system_shutdown\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 428, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionendreason" }, { "name": "SessionEndReasonValue", "declarationName": "SessionEndReasonValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SessionEndReasonValue = (typeof SessionEndReason)[keyof typeof SessionEndReason] | {\n error: string;\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 438, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionendreasonvalue" }, { "name": "SessionId", "declarationName": "SessionId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Session identifier (UUID v7 in Rust; UUID v4 is acceptable here).", "tags": [], "signatures": [ { "code": "declare class SessionId {\n static generate(): SessionId;\n static fromString(s: string): SessionId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 402, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionid" }, { "name": "SessionState", "declarationName": "SessionState", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SessionState: {\n readonly AgentBootstrapped: \"agent_bootstrapped\";\n readonly SessionStarted: \"session_started\";\n readonly CapabilitiesGranted: \"capabilities_granted\";\n readonly ToolUse: \"tool_use\";\n readonly Renewal: \"renewal\";\n readonly Escalation: \"escalation\";\n readonly SessionEnded: \"session_ended\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 411, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstate" }, { "name": "sessionStateCanRequestCapabilities", "declarationName": "sessionStateCanRequestCapabilities", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateCanRequestCapabilities(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 422, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstatecanrequestcapabilities" }, { "name": "sessionStateCanUseTools", "declarationName": "sessionStateCanUseTools", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateCanUseTools(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 421, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstatecanusetools" }, { "name": "sessionStateIsActive", "declarationName": "sessionStateIsActive", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateIsActive(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 424, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstateisactive" }, { "name": "sessionStateIsTerminal", "declarationName": "sessionStateIsTerminal", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function sessionStateIsTerminal(state: SessionStateValue): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 423, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstateisterminal" }, { "name": "SessionStateValue", "declarationName": "SessionStateValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SessionStateValue = (typeof SessionState)[keyof typeof SessionState];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 420, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "sessionstatevalue" }, { "name": "SignatureAlgorithm", "declarationName": "SignatureAlgorithm", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Agent Capability Token (ACT) — the core credential type.\n\nACTs are short-lived (30s–24h), scoped, cryptographically-signed tokens\nthat grant an agent specific capabilities. They are encoded as CBOR on\nthe wire for deterministic signing, and base64url-encoded when sent\nover HTTP.", "tags": [], "signatures": [ { "code": "declare const SignatureAlgorithm: {\n readonly Ed25519: \"ED25519\";\n readonly Es256: \"ES256\";\n readonly Es384: \"ES384\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 12, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "signaturealgorithm" }, { "name": "SignatureAlgorithmValue", "declarationName": "SignatureAlgorithmValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SignatureAlgorithmValue = (typeof SignatureAlgorithm)[keyof typeof SignatureAlgorithm];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 17, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "signaturealgorithmvalue" }, { "name": "specificSecretRef", "declarationName": "specificSecretRef", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Reference to a specific version.", "tags": [], "signatures": [ { "code": "declare function specificSecretRef(id: string, version: number): SecretRef;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 349, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "specificsecretref" }, { "name": "strictRateLimits", "declarationName": "strictRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strict lockdown rate limits.", "tags": [], "signatures": [ { "code": "declare function strictRateLimits(): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 99, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "strictratelimits" }, { "name": "TemplateVariable", "declarationName": "TemplateVariable", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Parsed template variable reference.", "tags": [], "signatures": [ { "code": "interface TemplateVariable {\n name: string;\n prefix: VariablePrefixValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 214, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "templatevariable" }, { "name": "TenantId", "declarationName": "TenantId", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Tenant identifier — represents an organization or customer.", "tags": [], "signatures": [ { "code": "declare class TenantId {\n static parse(id: string): TenantId;\n static generate(): TenantId;\n asString(): string;\n toString(): string;\n toJSON(): string;\n equals(other: TenantId): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 161, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "tenantid" }, { "name": "TimeConstraints", "declarationName": "TimeConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TimeConstraints {\n not_before?: string;\n not_after?: string;\n allowed_hours?: readonly number[];\n allowed_days?: readonly number[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 30, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "timeconstraints" }, { "name": "TokenBucketLimiter", "declarationName": "TokenBucketLimiter", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Token-bucket rate limiter. Lock-free single-threaded (JS single-threaded\nexecution model) — refills on each try_acquire based on elapsed wall clock.", "tags": [], "signatures": [ { "code": "declare class TokenBucketLimiter {\n constructor(maxTokens: number, refillAmount: number, refillIntervalMs: number);\n static perSecond(rate: number): TokenBucketLimiter;\n static perMinute(rate: number): TokenBucketLimiter;\n static perHour(rate: number): TokenBucketLimiter;\n tryAcquire(): void;\n available(): number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 153, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "tokenbucketlimiter" }, { "name": "TokenClaims", "declarationName": "TokenClaims", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenClaims {\n jti: string;\n sub: string;\n iss: string;\n aud: string;\n iat: string;\n nbf: string;\n exp: string;\n tenant_id: string;\n scope: readonly string[];\n constraints?: Constraints;\n limits?: RateLimits;\n budget?: UsageBudget;\n trace?: TokenTrace;\n cnf?: ProofOfPossession;\n delegated_variables?: readonly string[];\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 35, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokenclaims" }, { "name": "TokenClaimsBuildOptions", "declarationName": "TokenClaimsBuildOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for building a fresh set of claims.", "tags": [], "signatures": [ { "code": "interface TokenClaimsBuildOptions {\n subject: string;\n issuer: string;\n audience: string;\n tenant_id: string;\n scopes: ScopeSet;\n ttl_seconds?: number;\n constraints?: Constraints;\n limits?: RateLimits;\n budget?: UsageBudget;\n parent_token_id?: string;\n cnf?: ProofOfPossession;\n delegated_variables?: readonly string[];\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 54, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokenclaimsbuildoptions" }, { "name": "TokenSignature", "declarationName": "TokenSignature", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenSignature {\n bytes: Uint8Array;\n algorithm: SignatureAlgorithmValue;\n key_id?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 18, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokensignature" }, { "name": "TokenTrace", "declarationName": "TokenTrace", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenTrace {\n issuance_id: string;\n parent_token_id?: string;\n policy_id?: string;\n delegation_depth: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 29, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokentrace" }, { "name": "unlimitedRateLimits", "declarationName": "unlimitedRateLimits", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "All unlimited — use with care.", "tags": [], "signatures": [ { "code": "declare function unlimitedRateLimits(): RateLimits;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 97, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "unlimitedratelimits" }, { "name": "unlimitedUsageBudget", "declarationName": "unlimitedUsageBudget", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function unlimitedUsageBudget(): UsageBudget;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 110, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "unlimitedusagebudget" }, { "name": "UsageBudget", "declarationName": "UsageBudget", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface UsageBudget {\n max_requests?: number;\n max_bytes?: number;\n max_cost_units?: number;\n max_secret_unwraps?: number;\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 102, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagebudget" }, { "name": "UsageStats", "declarationName": "UsageStats", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Current usage snapshot.", "tags": [], "signatures": [ { "code": "interface UsageStats {\n request_count: number;\n bytes_transferred: number;\n cost_units: number;\n secret_unwraps: number;\n elapsed_ms: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 114, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagestats" }, { "name": "UsageTracker", "declarationName": "UsageTracker", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Runtime usage tracker that enforces a budget.\n\nEach `record*` call either succeeds or throws an ArsenalError with code\n`BudgetExhausted` (or `SecretUnwrapLimitExceeded`).", "tags": [], "signatures": [ { "code": "declare class UsageTracker {\n constructor(budget: UsageBudget);\n recordRequest(): void;\n recordBytes(bytes: number): void;\n recordCost(units: number): void;\n recordSecretUnwrap(): void;\n getStats(): UsageStats;\n remaining(): RemainingBudget;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 134, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagetracker" }, { "name": "validateConstraints", "declarationName": "validateConstraints", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate a set of constraints against a request context. Throws an\n`ArsenalError` on the first violation.", "tags": [], "signatures": [ { "code": "declare function validateConstraints(constraints: Constraints, ctx: ConstraintContext): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 76, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "validateconstraints" }, { "name": "validateDelegationDepth", "declarationName": "validateDelegationDepth", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate a delegation chain length and scope non-amplification rule.", "tags": [], "signatures": [ { "code": "declare function validateDelegationDepth(depth: number): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 396, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "validatedelegationdepth" }, { "name": "validateDestinationBinding", "declarationName": "validateDestinationBinding", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Throws if the binding is malformed.", "tags": [], "signatures": [ { "code": "declare function validateDestinationBinding(binding: DestinationBinding): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 207, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "validatedestinationbinding" }, { "name": "validateProxyRequest", "declarationName": "validateProxyRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate structural fields of a proxy request.", "tags": [], "signatures": [ { "code": "declare function validateProxyRequest(req: ProxyRequest): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 238, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "validateproxyrequest" }, { "name": "validateVariableName", "declarationName": "validateVariableName", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function validateVariableName(name: string): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 220, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "validatevariablename" }, { "name": "validSessionStateTransitions", "declarationName": "validSessionStateTransitions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the set of valid transitions from a given state.", "tags": [], "signatures": [ { "code": "declare function validSessionStateTransitions(state: SessionStateValue): readonly SessionStateValue[];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 426, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "validsessionstatetransitions" }, { "name": "VariablePrefix", "declarationName": "VariablePrefix", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Credential proxy protocol types.\n\nThese types describe the wire shape for proxy requests, destination\nbindings, and template-variable resolution. Agents construct\n`ProxyRequest` objects with `{{VARIABLE}}` placeholders; the broker\nresolves them server-side and never discloses raw credentials.", "tags": [], "signatures": [ { "code": "declare const VariablePrefix: {\n readonly OAuth2: \"OAUTH2\";\n readonly OAuth1: \"OAUTH1\";\n readonly ApiKey: \"API_KEY\";\n readonly Basic: \"BASIC\";\n readonly Bearer: \"BEARER\";\n readonly Cert: \"CERT\";\n readonly Custom: \"CUSTOM\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 185, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "variableprefix" }, { "name": "VariablePrefixValue", "declarationName": "VariablePrefixValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VariablePrefixValue = (typeof VariablePrefix)[keyof typeof VariablePrefix];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 194, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "variableprefixvalue" }, { "name": "VariableResolutionTable", "declarationName": "VariableResolutionTable", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory variable → secret-ref table used by the broker.", "tags": [], "signatures": [ { "code": "declare class VariableResolutionTable {\n register(variableName: string, secretRef: {\n id: string;\n version?: number;\n }): void;\n unregister(variableName: string): boolean;\n resolve(variableName: string): {\n id: string;\n version?: number;\n } | undefined;\n variableNames(): readonly string[];\n get size(): number;\n isEmpty(): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 260, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "variableresolutiontable" }, { "name": "withDevice", "declarationName": "withDevice", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints with a required device binding.", "tags": [], "signatures": [ { "code": "declare function withDevice(base: Constraints, deviceId: string): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 65, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withdevice" }, { "name": "withOrigins", "declarationName": "withOrigins", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints with an allowed-origins binding.", "tags": [], "signatures": [ { "code": "declare function withOrigins(base: Constraints, origins: readonly string[]): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 67, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withorigins" }, { "name": "withPop", "declarationName": "withPop", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints requiring proof-of-possession.", "tags": [], "signatures": [ { "code": "declare function withPop(): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 63, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withpop" }, { "name": "withTimeWindow", "declarationName": "withTimeWindow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create constraints with a time window.", "tags": [], "signatures": [ { "code": "declare function withTimeWindow(base: Constraints, notBefore: Date, notAfter: Date): Constraints;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 69, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "withtimewindow" }, { "name": "zeroize", "declarationName": "zeroize", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Zeroize a `Uint8Array` in place. Use in `finally` blocks for secret buffers.", "tags": [], "signatures": [ { "code": "declare function zeroize(bytes: Uint8Array): void;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/core/index.d.ts", "line": 542, "sha256": "399c134cec6fab388d809571b4d381f89230f5ecf005aded34622e2b0a748698" } } ], "anchor": "zeroize" } ], "supportingDeclarations": [], "coverage": { "discovered": 170, "documented": 170, "missing": [] } }, { "subpath": "./policy", "importSpecifier": "@openagentid/arsenal-sdk/policy", "page": "/reference/typescript/arsenal-sdk/policy", "kind": "declarations", "conditions": { "types": "./dist/policy/index.d.ts", "import": "./dist/policy/index.js", "require": "./dist/policy/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/policy/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/policy/index.js" }, { "conditions": [ "require" ], "path": "./dist/policy/index.cjs" } ], "exports": [ { "name": "compareOperator", "declarationName": "compareOperator", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compare two strings using a condition operator.", "tags": [], "signatures": [ { "code": "declare function compareOperator(operator: ConditionOperatorValue, actual: string, expected: string): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 38, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "compareoperator" }, { "name": "denyWith", "declarationName": "denyWith", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a deny decision with a reason string.", "tags": [], "signatures": [ { "code": "declare function denyWith(reason: string): PolicyDecision;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 42, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "denywith" }, { "name": "evaluatePolicy", "declarationName": "evaluatePolicy", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Evaluate a single policy against a request. Returns the first matching\nrule's decision or the policy's default effect.", "tags": [], "signatures": [ { "code": "declare function evaluatePolicy(policy: PolicyDocument, request: PolicyRequest): PolicyDecision;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 36, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "evaluatepolicy" }, { "name": "policyAllows", "declarationName": "policyAllows", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Convenience alias: true if the policy decision allows the request.", "tags": [], "signatures": [ { "code": "declare function policyAllows(decision: PolicyDecision): boolean;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 40, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "policyallows" }, { "name": "PolicyEngine", "declarationName": "PolicyEngine", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A policy engine evaluates multiple policies in priority order.\n\nPolicies are added via `addPolicy` and removed via `removePolicy`. On\neach `evaluate(request)` call, policies are sorted by descending\npriority and the first matching rule's decision is returned. When no\nrule matches, the default effect of the first policy (ordered by\npriority) is used, and if there are no policies the engine returns\n`Deny`.", "tags": [], "signatures": [ { "code": "declare class PolicyEngine {\n addPolicy(policy: PolicyDocument): void;\n removePolicy(policyId: string): PolicyDocument | undefined;\n getPolicy(policyId: string): PolicyDocument | undefined;\n policyIds(): readonly string[];\n size(): number;\n evaluate(request: PolicyRequest): PolicyDecision;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy/index.d.ts", "line": 22, "sha256": "db515e0976a5e49771343b043cd1f31977dedf546062b388e0ae0218972176cc" } } ], "anchor": "policyengine" } ], "supportingDeclarations": [ { "name": "BindingType", "declarationName": "BindingType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Constraints that bind ACTs to specific contexts.\n\nTokens can be restricted to a specific device, session, origin, IP range,\ntime window, or environment. Constraints are evaluated at the broker and\nat the proxy boundary.", "tags": [], "signatures": [ { "code": "declare const BindingType: {\n readonly Required: \"required\";\n readonly Preferred: \"preferred\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 8, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtype" }, { "name": "BindingTypeValue", "declarationName": "BindingTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type BindingTypeValue = (typeof BindingType)[keyof typeof BindingType];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 12, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtypevalue" }, { "name": "ConditionOperator", "declarationName": "ConditionOperator", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConditionOperator: {\n readonly Equals: \"equals\";\n readonly NotEquals: \"not_equals\";\n readonly Contains: \"contains\";\n readonly StartsWith: \"starts_with\";\n readonly EndsWith: \"ends_with\";\n readonly Matches: \"matches\";\n readonly In: \"in\";\n readonly NotIn: \"not_in\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 25, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "conditionoperator" }, { "name": "ConditionOperatorValue", "declarationName": "ConditionOperatorValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConditionOperatorValue = (typeof ConditionOperator)[keyof typeof ConditionOperator];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 35, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "conditionoperatorvalue" }, { "name": "Constraints", "declarationName": "Constraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Constraints {\n device_binding?: DeviceBinding;\n session_binding?: SessionBinding;\n origin_binding?: OriginBinding;\n network_constraints?: NetworkConstraints;\n time_constraints?: TimeConstraints;\n environment_constraints?: EnvironmentConstraint;\n require_pop: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 41, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "constraints" }, { "name": "DeviceBinding", "declarationName": "DeviceBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DeviceBinding {\n device_id: string;\n binding_type: BindingTypeValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 13, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "devicebinding" }, { "name": "EnvironmentConstraint", "declarationName": "EnvironmentConstraint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface EnvironmentConstraint {\n required_environment?: string;\n required_tags?: ReadonlySet;\n forbidden_tags?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 36, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "environmentconstraint" }, { "name": "NetworkConstraints", "declarationName": "NetworkConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface NetworkConstraints {\n allowed_ips?: ReadonlySet;\n denied_ips?: ReadonlySet;\n allowed_cidrs?: readonly string[];\n allowed_asns?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 24, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "networkconstraints" }, { "name": "OriginBinding", "declarationName": "OriginBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OriginBinding {\n allowed_origins: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 21, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "originbinding" }, { "name": "PolicyCondition", "declarationName": "PolicyCondition", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyCondition = {\n type: \"agent_id\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"tenant_id\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"scope\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"environment\";\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"time_of_day\";\n allowed_hours: readonly number[];\n} | {\n type: \"day_of_week\";\n allowed_days: readonly number[];\n} | {\n type: \"ip_address\";\n allowed_cidrs: readonly string[];\n} | {\n type: \"attribute\";\n key: string;\n operator: ConditionOperatorValue;\n value: string;\n} | {\n type: \"and\";\n conditions: readonly PolicyCondition[];\n} | {\n type: \"or\";\n conditions: readonly PolicyCondition[];\n} | {\n type: \"not\";\n condition: PolicyCondition;\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 36, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policycondition" }, { "name": "PolicyDecision", "declarationName": "PolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDecision {\n effect: PolicyEffectValue;\n matched_rule?: string;\n reason?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 124, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policydecision" }, { "name": "PolicyDocument", "declarationName": "PolicyDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyDocument {\n id: string;\n version: number;\n tenant_id: string;\n name: string;\n description?: string;\n rules: readonly PolicyRule[];\n default_effect: PolicyEffectValue;\n is_active: boolean;\n priority: number;\n created_at: string;\n updated_at: string;\n signature?: PolicySignature;\n labels: Readonly>;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 94, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policydocument" }, { "name": "PolicyEffect", "declarationName": "PolicyEffect", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PolicyEffect: {\n readonly Allow: \"allow\";\n readonly Deny: \"deny\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 20, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyeffect" }, { "name": "PolicyEffectValue", "declarationName": "PolicyEffectValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PolicyEffectValue = (typeof PolicyEffect)[keyof typeof PolicyEffect];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 24, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyeffectvalue" }, { "name": "PolicyRequest", "declarationName": "PolicyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRequest {\n agent_id: string;\n tenant_id: string;\n requested_scope: string;\n timestamp: Date;\n environment?: string;\n client_ip?: string;\n attributes: Readonly>;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 113, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyrequest" }, { "name": "PolicyRule", "declarationName": "PolicyRule", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicyRule {\n id: string;\n description?: string;\n effect: PolicyEffectValue;\n conditions: readonly PolicyCondition[];\n scopes?: ScopeSet;\n constraints?: Constraints;\n rate_limits?: RateLimits;\n budget?: UsageBudget;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 76, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policyrule" }, { "name": "PolicySignature", "declarationName": "PolicySignature", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface PolicySignature {\n bytes: Uint8Array;\n algorithm: string;\n key_id: string;\n signed_at: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/policy-C-EX1HGX.d.ts", "line": 88, "sha256": "d96e6c78423ee169f13892bc4b0f66809c855c8af56d94f04ce1fa0dd8228f9a" } } ], "anchor": "policysignature" }, { "name": "RateLimits", "declarationName": "RateLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Rate limits, usage budgets, and runtime tracking primitives.", "tags": [], "signatures": [ { "code": "interface RateLimits {\n requests_per_second?: number;\n requests_per_minute?: number;\n requests_per_hour?: number;\n max_concurrent?: number;\n max_request_size?: number;\n max_response_size?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 86, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "ratelimits" }, { "name": "Scope", "declarationName": "Scope", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A single permission scope.", "tags": [], "signatures": [ { "code": "declare class Scope {\n static parse(scope: string): Scope;\n static wildcard(): Scope;\n static readOnly(service: string): Scope;\n static fullAccess(service: string): Scope;\n get service(): string;\n get resource(): string;\n get action(): string;\n isWildcard(): boolean;\n implies(other: Scope): boolean;\n asString(): string;\n toString(): string;\n toJSON(): string;\n equals(other: Scope): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 200, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scope" }, { "name": "ScopeSet", "declarationName": "ScopeSet", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A set of scopes, maintained as a sorted list for deterministic encoding.", "tags": [], "signatures": [ { "code": "declare class ScopeSet {\n static empty(): ScopeSet;\n static single(scope: Scope): ScopeSet;\n static fromStrings(scopes: readonly string[]): ScopeSet;\n static fromScopes(scopes: readonly Scope[]): ScopeSet;\n add(scope: Scope): ScopeSet;\n remove(scope: Scope): ScopeSet;\n contains(scope: Scope): boolean;\n allows(requested: Scope): boolean;\n isSupersetOf(other: ScopeSet): boolean;\n intersection(other: ScopeSet): ScopeSet;\n union(other: ScopeSet): ScopeSet;\n get length(): number;\n isEmpty(): boolean;\n toArray(): readonly Scope[];\n toStrings(): readonly string[];\n [Symbol.iterator](): Iterator;\n toJSON(): readonly string[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 228, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scopeset" }, { "name": "SessionBinding", "declarationName": "SessionBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionBinding {\n session_id: string;\n session_key_hash?: Uint8Array;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 17, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "sessionbinding" }, { "name": "TimeConstraints", "declarationName": "TimeConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TimeConstraints {\n not_before?: string;\n not_after?: string;\n allowed_hours?: readonly number[];\n allowed_days?: readonly number[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 30, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "timeconstraints" }, { "name": "UsageBudget", "declarationName": "UsageBudget", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface UsageBudget {\n max_requests?: number;\n max_bytes?: number;\n max_cost_units?: number;\n max_secret_unwraps?: number;\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 102, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagebudget" } ], "coverage": { "discovered": 5, "documented": 5, "missing": [] } }, { "subpath": "./broker", "importSpecifier": "@openagentid/arsenal-sdk/broker", "page": "/reference/typescript/arsenal-sdk/broker", "kind": "declarations", "conditions": { "types": "./dist/broker/index.d.ts", "import": "./dist/broker/index.js", "require": "./dist/broker/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/broker/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/broker/index.js" }, { "conditions": [ "require" ], "path": "./dist/broker/index.cjs" } ], "exports": [ { "name": "ApiErrorResponse", "declarationName": "ApiErrorResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ApiErrorResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 427, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "apierrorresponse" }, { "name": "ApiErrorResponseSchema", "declarationName": "ApiErrorResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ApiErrorResponseSchema: z.ZodObject<{\n code: z.ZodNumber;\n message: z.ZodString;\n correlation_id: z.ZodOptional;\n retry_after: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n code: z.ZodNumber;\n message: z.ZodString;\n correlation_id: z.ZodOptional;\n retry_after: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n code: z.ZodNumber;\n message: z.ZodString;\n correlation_id: z.ZodOptional;\n retry_after: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 411, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "apierrorresponseschema" }, { "name": "BrokerClient", "declarationName": "BrokerClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Broker HTTP client.\n\nAll methods throw `ArsenalError` on failure. Response bodies are\nvalidated with Zod schemas at the boundary.", "tags": [], "signatures": [ { "code": "declare class BrokerClient {\n constructor(opts: BrokerClientOptions);\n health(): Promise;\n requestCapability(payload: CapabilityRequestPayload): Promise;\n requestSecret(payload: SecretRequestPayload): Promise;\n revokeToken(tokenId: string, reason?: string): Promise;\n verifyToken(token: string): Promise;\n proxyRequest(req: ProxyRequest, opts?: {\n fingerprintHex?: string;\n }): Promise;\n approveConsent(payload: ConsentApprovalPayload): Promise;\n denyConsent(payload: ConsentDenialPayload): Promise;\n revokeConsent(payload: ConsentRevocationPayload): Promise;\n listConsents(agentDid: string): Promise;\n static decodeCapabilityToken(response: CapabilityResponsePayload): AgentCapabilityToken;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 453, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "brokerclient" }, { "name": "BrokerClientOptions", "declarationName": "BrokerClientOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for the broker client.", "tags": [], "signatures": [ { "code": "interface BrokerClientOptions {\n baseUrl: string;\n timeoutMs?: number;\n defaultHeaders?: Record;\n fetch?: typeof globalThis.fetch;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 437, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "brokerclientoptions" }, { "name": "CapabilityRequestPayload", "declarationName": "CapabilityRequestPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CapabilityRequestPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 65, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityrequestpayload" }, { "name": "CapabilityRequestPayloadSchema", "declarationName": "CapabilityRequestPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CapabilityRequestPayloadSchema: z.ZodObject<{\n scopes: z.ZodArray;\n ttl_seconds: z.ZodOptional;\n audience: z.ZodString;\n constraints: z.ZodOptional>;\n device_id: z.ZodOptional;\n }, \"strict\", z.ZodTypeAny, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n }, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n }>>;\n pop_key_fingerprint: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n scopes: string[];\n audience: string;\n ttl_seconds?: number | undefined;\n constraints?: {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n } | undefined;\n pop_key_fingerprint?: string | undefined;\n}, {\n scopes: string[];\n audience: string;\n ttl_seconds?: number | undefined;\n constraints?: {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n } | undefined;\n pop_key_fingerprint?: string | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 26, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityrequestpayloadschema" }, { "name": "CapabilityResponsePayload", "declarationName": "CapabilityResponsePayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CapabilityResponsePayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 82, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityresponsepayload" }, { "name": "CapabilityResponsePayloadSchema", "declarationName": "CapabilityResponsePayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CapabilityResponsePayloadSchema: z.ZodObject<{\n token_id: z.ZodString;\n token: z.ZodString;\n expires_at: z.ZodString;\n granted_scopes: z.ZodArray;\n}, \"strict\", z.ZodTypeAny, {\n token: string;\n token_id: string;\n expires_at: string;\n granted_scopes: string[];\n}, {\n token: string;\n token_id: string;\n expires_at: string;\n granted_scopes: string[];\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 66, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "capabilityresponsepayloadschema" }, { "name": "ConsentApprovalPayload", "declarationName": "ConsentApprovalPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentApprovalPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 330, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentapprovalpayload" }, { "name": "ConsentApprovalPayloadSchema", "declarationName": "ConsentApprovalPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentApprovalPayloadSchema: z.ZodObject<{\n agent_did: z.ZodString;\n human_root_did: z.ZodString;\n variables: z.ZodArray;\n destination_domains: z.ZodArray;\n scopes: z.ZodArray;\n granted_by: z.ZodString;\n expires_in_seconds: z.ZodOptional;\n signature: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n signature: string;\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n granted_by: string;\n expires_in_seconds?: number | undefined;\n}, {\n signature: string;\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n granted_by: string;\n expires_in_seconds?: number | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 302, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentapprovalpayloadschema" }, { "name": "ConsentDenialPayload", "declarationName": "ConsentDenialPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentDenialPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 385, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentdenialpayload" }, { "name": "ConsentDenialPayloadSchema", "declarationName": "ConsentDenialPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentDenialPayloadSchema: z.ZodObject<{\n agent_did: z.ZodString;\n human_root_did: z.ZodString;\n variables: z.ZodArray;\n destination_domains: z.ZodArray;\n scopes: z.ZodArray;\n}, \"strict\", z.ZodTypeAny, {\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n}, {\n variables: string[];\n destination_domains: string[];\n scopes: string[];\n agent_did: string;\n human_root_did: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 366, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentdenialpayloadschema" }, { "name": "ConsentRecordPayload", "declarationName": "ConsentRecordPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentRecordPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 365, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrecordpayload" }, { "name": "ConsentRecordPayloadSchema", "declarationName": "ConsentRecordPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentRecordPayloadSchema: z.ZodObject<{\n consent_id: z.ZodString;\n agent_did: z.ZodString;\n human_root_did: z.ZodOptional;\n variables: z.ZodArray;\n destination_domains: z.ZodOptional>;\n scopes: z.ZodOptional>;\n granted_by: z.ZodOptional;\n granted_at: z.ZodString;\n expires_at: z.ZodString;\n revoked: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n consent_id: z.ZodString;\n agent_did: z.ZodString;\n human_root_did: z.ZodOptional;\n variables: z.ZodArray;\n destination_domains: z.ZodOptional>;\n scopes: z.ZodOptional>;\n granted_by: z.ZodOptional;\n granted_at: z.ZodString;\n expires_at: z.ZodString;\n revoked: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n consent_id: z.ZodString;\n agent_did: z.ZodString;\n human_root_did: z.ZodOptional;\n variables: z.ZodArray;\n destination_domains: z.ZodOptional>;\n scopes: z.ZodOptional>;\n granted_by: z.ZodOptional;\n granted_at: z.ZodString;\n expires_at: z.ZodString;\n revoked: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 331, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrecordpayloadschema" }, { "name": "ConsentRevocationPayload", "declarationName": "ConsentRevocationPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentRevocationPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 393, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrevocationpayload" }, { "name": "ConsentRevocationPayloadSchema", "declarationName": "ConsentRevocationPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ConsentRevocationPayloadSchema: z.ZodObject<{\n consent_id: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n consent_id: string;\n}, {\n consent_id: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 386, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "consentrevocationpayloadschema" }, { "name": "ConstraintsPayload", "declarationName": "ConstraintsPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConstraintsPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 25, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "constraintspayload" }, { "name": "ConstraintsPayloadSchema", "declarationName": "ConstraintsPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Broker wire types with Zod runtime validation.\n\nThese schemas must match the JSON payloads accepted and returned by the\nRust `arsenal-broker` HTTP handlers in `crates/arsenal-broker/src/handlers.rs`.", "tags": [], "signatures": [ { "code": "declare const ConstraintsPayloadSchema: z.ZodObject<{\n require_pop: z.ZodBoolean;\n allowed_origins: z.ZodOptional>;\n device_id: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n}, {\n require_pop: boolean;\n device_id?: string | undefined;\n allowed_origins?: string[] | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 12, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "constraintspayloadschema" }, { "name": "HealthResponse", "declarationName": "HealthResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type HealthResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 410, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "healthresponse" }, { "name": "HealthResponseSchema", "declarationName": "HealthResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const HealthResponseSchema: z.ZodObject<{\n status: z.ZodString;\n version: z.ZodString;\n registered_agents: z.ZodOptional;\n revoked_tokens: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n status: z.ZodString;\n version: z.ZodString;\n registered_agents: z.ZodOptional;\n revoked_tokens: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n status: z.ZodString;\n version: z.ZodString;\n registered_agents: z.ZodOptional;\n revoked_tokens: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 394, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "healthresponseschema" }, { "name": "ProxyMetadataPayload", "declarationName": "ProxyMetadataPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProxyMetadataPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 221, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxymetadatapayload" }, { "name": "ProxyMetadataPayloadSchema", "declarationName": "ProxyMetadataPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ProxyMetadataPayloadSchema: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 199, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxymetadatapayloadschema" }, { "name": "ProxyRequestPayload", "declarationName": "ProxyRequestPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProxyRequestPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 198, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyrequestpayload" }, { "name": "ProxyRequestPayloadSchema", "declarationName": "ProxyRequestPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ProxyRequestPayloadSchema: z.ZodObject<{\n method: z.ZodString;\n url: z.ZodString;\n headers: z.ZodOptional>;\n body: z.ZodOptional;\n capability_token: z.ZodString;\n timeout_ms: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n url: string;\n capability_token: string;\n method: string;\n headers?: Record | undefined;\n body?: string | undefined;\n timeout_ms?: number | undefined;\n}, {\n url: string;\n capability_token: string;\n method: string;\n headers?: Record | undefined;\n body?: string | undefined;\n timeout_ms?: number | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 176, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyrequestpayloadschema" }, { "name": "ProxyResponsePayload", "declarationName": "ProxyResponsePayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProxyResponsePayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 301, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyresponsepayload" }, { "name": "ProxyResponsePayloadSchema", "declarationName": "ProxyResponsePayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ProxyResponsePayloadSchema: z.ZodObject<{\n status: z.ZodNumber;\n headers: z.ZodRecord;\n body: z.ZodString;\n proxy_metadata: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">>;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n status: z.ZodNumber;\n headers: z.ZodRecord;\n body: z.ZodString;\n proxy_metadata: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">>;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n status: z.ZodNumber;\n headers: z.ZodRecord;\n body: z.ZodString;\n proxy_metadata: z.ZodObject<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n variables_resolved: z.ZodArray;\n destination_verified: z.ZodBoolean;\n fingerprint_verified: z.ZodBoolean;\n consent_status: z.ZodString;\n latency_ms: z.ZodNumber;\n request_id: z.ZodOptional;\n }, z.ZodTypeAny, \"passthrough\">>;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 222, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "proxyresponsepayloadschema" }, { "name": "RevokeTokenPayload", "declarationName": "RevokeTokenPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevokeTokenPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 130, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenpayload" }, { "name": "RevokeTokenPayloadSchema", "declarationName": "RevokeTokenPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const RevokeTokenPayloadSchema: z.ZodObject<{\n token_id: z.ZodString;\n reason: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n token_id: string;\n reason?: string | undefined;\n}, {\n token_id: string;\n reason?: string | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 120, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenpayloadschema" }, { "name": "RevokeTokenResponse", "declarationName": "RevokeTokenResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type RevokeTokenResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 141, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenresponse" }, { "name": "RevokeTokenResponseSchema", "declarationName": "RevokeTokenResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const RevokeTokenResponseSchema: z.ZodObject<{\n success: z.ZodBoolean;\n message: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n success: boolean;\n message: string;\n}, {\n success: boolean;\n message: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 131, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "revoketokenresponseschema" }, { "name": "SecretRequestPayload", "declarationName": "SecretRequestPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretRequestPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 96, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretrequestpayload" }, { "name": "SecretRequestPayloadSchema", "declarationName": "SecretRequestPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretRequestPayloadSchema: z.ZodObject<{\n secret_id: z.ZodString;\n version: z.ZodOptional;\n capability_token: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n secret_id: string;\n capability_token: string;\n version?: number | undefined;\n}, {\n secret_id: string;\n capability_token: string;\n version?: number | undefined;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 83, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretrequestpayloadschema" }, { "name": "SecretResponsePayload", "declarationName": "SecretResponsePayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SecretResponsePayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 119, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretresponsepayload" }, { "name": "SecretResponsePayloadSchema", "declarationName": "SecretResponsePayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SecretResponsePayloadSchema: z.ZodObject<{\n secret_id: z.ZodString;\n version: z.ZodNumber;\n wrapped_value: z.ZodString;\n wrap_key_id: z.ZodString;\n ephemeral_public_key: z.ZodString;\n expires_at: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n secret_id: string;\n expires_at: string;\n version: number;\n wrapped_value: string;\n wrap_key_id: string;\n ephemeral_public_key: string;\n}, {\n secret_id: string;\n expires_at: string;\n version: number;\n wrapped_value: string;\n wrap_key_id: string;\n ephemeral_public_key: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 97, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "secretresponsepayloadschema" }, { "name": "VerifyTokenPayload", "declarationName": "VerifyTokenPayload", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerifyTokenPayload = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 149, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenpayload" }, { "name": "VerifyTokenPayloadSchema", "declarationName": "VerifyTokenPayloadSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const VerifyTokenPayloadSchema: z.ZodObject<{\n token: z.ZodString;\n}, \"strict\", z.ZodTypeAny, {\n token: string;\n}, {\n token: string;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 142, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenpayloadschema" }, { "name": "VerifyTokenResponse", "declarationName": "VerifyTokenResponse", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerifyTokenResponse = z.infer;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 175, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenresponse" }, { "name": "VerifyTokenResponseSchema", "declarationName": "VerifyTokenResponseSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const VerifyTokenResponseSchema: z.ZodObject<{\n valid: z.ZodBoolean;\n token_id: z.ZodOptional;\n subject: z.ZodOptional;\n audience: z.ZodOptional;\n expires_at: z.ZodOptional;\n scopes: z.ZodOptional>;\n error: z.ZodOptional;\n}, \"passthrough\", z.ZodTypeAny, z.objectOutputType<{\n valid: z.ZodBoolean;\n token_id: z.ZodOptional;\n subject: z.ZodOptional;\n audience: z.ZodOptional;\n expires_at: z.ZodOptional;\n scopes: z.ZodOptional>;\n error: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">, z.objectInputType<{\n valid: z.ZodBoolean;\n token_id: z.ZodOptional;\n subject: z.ZodOptional;\n audience: z.ZodOptional;\n expires_at: z.ZodOptional;\n scopes: z.ZodOptional>;\n error: z.ZodOptional;\n}, z.ZodTypeAny, \"passthrough\">>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/broker/index.d.ts", "line": 150, "sha256": "e7494f97e7c251d111d44989e473d9e1f55c93b50a4404b1e94efe20440f2e73" } } ], "anchor": "verifytokenresponseschema" } ], "supportingDeclarations": [ { "name": "AgentCapabilityToken", "declarationName": "AgentCapabilityToken", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Immutable Agent Capability Token. Wraps a set of claims and an optional\nsignature, and provides validation + CBOR (de)serialization.", "tags": [], "signatures": [ { "code": "declare class AgentCapabilityToken {\n readonly claims: TokenClaims;\n readonly signature: TokenSignature | undefined;\n static fromClaims(claims: TokenClaims): AgentCapabilityToken;\n static fromClaimsAndSignature(claims: TokenClaims, signature: TokenSignature): AgentCapabilityToken;\n get id(): string;\n get subject(): string;\n get audience(): string;\n get scopes(): ScopeSet;\n isExpired(now?: Date): boolean;\n isNotYetValid(now?: Date): boolean;\n isTimeValid(now?: Date): boolean;\n remainingTtlMs(now?: Date): number;\n isSigned(): boolean;\n validateStructure(now?: Date): void;\n toCbor(): Uint8Array;\n claimsToCbor(): Uint8Array;\n toBase64Url(): string;\n static fromCbor(bytes: Uint8Array): AgentCapabilityToken;\n static fromBase64Url(s: string): AgentCapabilityToken;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 75, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "agentcapabilitytoken" }, { "name": "BindingType", "declarationName": "BindingType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Constraints that bind ACTs to specific contexts.\n\nTokens can be restricted to a specific device, session, origin, IP range,\ntime window, or environment. Constraints are evaluated at the broker and\nat the proxy boundary.", "tags": [], "signatures": [ { "code": "declare const BindingType: {\n readonly Required: \"required\";\n readonly Preferred: \"preferred\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 8, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtype" }, { "name": "BindingTypeValue", "declarationName": "BindingTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type BindingTypeValue = (typeof BindingType)[keyof typeof BindingType];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 12, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "bindingtypevalue" }, { "name": "ConsentStatus", "declarationName": "ConsentStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Consent protocol types for human-in-the-loop credential authorization.", "tags": [], "signatures": [ { "code": "declare const ConsentStatus: {\n readonly PreApproved: \"pre_approved\";\n readonly Approved: \"approved\";\n readonly Pending: \"pending\";\n readonly Denied: \"denied\";\n readonly Revoked: \"revoked\";\n readonly NotRequired: \"not_required\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 108, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatus" }, { "name": "ConsentStatusValue", "declarationName": "ConsentStatusValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ConsentStatusValue = (typeof ConsentStatus)[keyof typeof ConsentStatus];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 116, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "consentstatusvalue" }, { "name": "Constraints", "declarationName": "Constraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface Constraints {\n device_binding?: DeviceBinding;\n session_binding?: SessionBinding;\n origin_binding?: OriginBinding;\n network_constraints?: NetworkConstraints;\n time_constraints?: TimeConstraints;\n environment_constraints?: EnvironmentConstraint;\n require_pop: boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 41, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "constraints" }, { "name": "DeviceBinding", "declarationName": "DeviceBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface DeviceBinding {\n device_id: string;\n binding_type: BindingTypeValue;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 13, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "devicebinding" }, { "name": "EnvironmentConstraint", "declarationName": "EnvironmentConstraint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface EnvironmentConstraint {\n required_environment?: string;\n required_tags?: ReadonlySet;\n forbidden_tags?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 36, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "environmentconstraint" }, { "name": "NetworkConstraints", "declarationName": "NetworkConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface NetworkConstraints {\n allowed_ips?: ReadonlySet;\n denied_ips?: ReadonlySet;\n allowed_cidrs?: readonly string[];\n allowed_asns?: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 24, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "networkconstraints" }, { "name": "OriginBinding", "declarationName": "OriginBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OriginBinding {\n allowed_origins: ReadonlySet;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 21, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "originbinding" }, { "name": "ProofOfPossession", "declarationName": "ProofOfPossession", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ProofOfPossession {\n key_fingerprint: string;\n alg: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 23, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proofofpossession" }, { "name": "ProxyMetadata", "declarationName": "ProxyMetadata", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Metadata about proxy processing (never includes resolved values).", "tags": [], "signatures": [ { "code": "interface ProxyMetadata {\n variables_resolved: readonly string[];\n destination_verified: boolean;\n fingerprint_verified: boolean;\n consent_status: ConsentStatusValue;\n latency_ms: number;\n request_id: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 251, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxymetadata" }, { "name": "ProxyRequest", "declarationName": "ProxyRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Proxy request envelope sent to the broker.", "tags": [], "signatures": [ { "code": "interface ProxyRequest {\n method: string;\n url: string;\n headers?: Readonly>;\n body?: Uint8Array;\n capability_token: string;\n timeout_ms?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 229, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxyrequest" }, { "name": "ProxyResponse", "declarationName": "ProxyResponse", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Response from a proxy request.", "tags": [], "signatures": [ { "code": "interface ProxyResponse {\n status: number;\n headers: Readonly>;\n body: Uint8Array;\n proxy_metadata: ProxyMetadata;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 244, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "proxyresponse" }, { "name": "RateLimits", "declarationName": "RateLimits", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Rate limits, usage budgets, and runtime tracking primitives.", "tags": [], "signatures": [ { "code": "interface RateLimits {\n requests_per_second?: number;\n requests_per_minute?: number;\n requests_per_hour?: number;\n max_concurrent?: number;\n max_request_size?: number;\n max_response_size?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 86, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "ratelimits" }, { "name": "Scope", "declarationName": "Scope", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A single permission scope.", "tags": [], "signatures": [ { "code": "declare class Scope {\n static parse(scope: string): Scope;\n static wildcard(): Scope;\n static readOnly(service: string): Scope;\n static fullAccess(service: string): Scope;\n get service(): string;\n get resource(): string;\n get action(): string;\n isWildcard(): boolean;\n implies(other: Scope): boolean;\n asString(): string;\n toString(): string;\n toJSON(): string;\n equals(other: Scope): boolean;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 200, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scope" }, { "name": "ScopeSet", "declarationName": "ScopeSet", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A set of scopes, maintained as a sorted list for deterministic encoding.", "tags": [], "signatures": [ { "code": "declare class ScopeSet {\n static empty(): ScopeSet;\n static single(scope: Scope): ScopeSet;\n static fromStrings(scopes: readonly string[]): ScopeSet;\n static fromScopes(scopes: readonly Scope[]): ScopeSet;\n add(scope: Scope): ScopeSet;\n remove(scope: Scope): ScopeSet;\n contains(scope: Scope): boolean;\n allows(requested: Scope): boolean;\n isSupersetOf(other: ScopeSet): boolean;\n intersection(other: ScopeSet): ScopeSet;\n union(other: ScopeSet): ScopeSet;\n get length(): number;\n isEmpty(): boolean;\n toArray(): readonly Scope[];\n toStrings(): readonly string[];\n [Symbol.iterator](): Iterator;\n toJSON(): readonly string[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 228, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "scopeset" }, { "name": "SessionBinding", "declarationName": "SessionBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SessionBinding {\n session_id: string;\n session_key_hash?: Uint8Array;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 17, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "sessionbinding" }, { "name": "SignatureAlgorithm", "declarationName": "SignatureAlgorithm", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Agent Capability Token (ACT) — the core credential type.\n\nACTs are short-lived (30s–24h), scoped, cryptographically-signed tokens\nthat grant an agent specific capabilities. They are encoded as CBOR on\nthe wire for deterministic signing, and base64url-encoded when sent\nover HTTP.", "tags": [], "signatures": [ { "code": "declare const SignatureAlgorithm: {\n readonly Ed25519: \"ED25519\";\n readonly Es256: \"ES256\";\n readonly Es384: \"ES384\";\n};", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 12, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "signaturealgorithm" }, { "name": "SignatureAlgorithmValue", "declarationName": "SignatureAlgorithmValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type SignatureAlgorithmValue = (typeof SignatureAlgorithm)[keyof typeof SignatureAlgorithm];", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 17, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "signaturealgorithmvalue" }, { "name": "TimeConstraints", "declarationName": "TimeConstraints", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TimeConstraints {\n not_before?: string;\n not_after?: string;\n allowed_hours?: readonly number[];\n allowed_days?: readonly number[];\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 30, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "timeconstraints" }, { "name": "TokenClaims", "declarationName": "TokenClaims", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenClaims {\n jti: string;\n sub: string;\n iss: string;\n aud: string;\n iat: string;\n nbf: string;\n exp: string;\n tenant_id: string;\n scope: readonly string[];\n constraints?: Constraints;\n limits?: RateLimits;\n budget?: UsageBudget;\n trace?: TokenTrace;\n cnf?: ProofOfPossession;\n delegated_variables?: readonly string[];\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 35, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokenclaims" }, { "name": "TokenSignature", "declarationName": "TokenSignature", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenSignature {\n bytes: Uint8Array;\n algorithm: SignatureAlgorithmValue;\n key_id?: string;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 18, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokensignature" }, { "name": "TokenTrace", "declarationName": "TokenTrace", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface TokenTrace {\n issuance_id: string;\n parent_token_id?: string;\n policy_id?: string;\n delegation_depth: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/proxy-DsVj9gLz.d.ts", "line": 29, "sha256": "74705f3132534e29ca7f5764abd5101c84585291606027fd0d91b5bca05f299d" } } ], "anchor": "tokentrace" }, { "name": "UsageBudget", "declarationName": "UsageBudget", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface UsageBudget {\n max_requests?: number;\n max_bytes?: number;\n max_cost_units?: number;\n max_secret_unwraps?: number;\n max_delegation_depth?: number;\n}", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/scope-CP8MvpbA.d.ts", "line": 102, "sha256": "654e40c1e9e8c606876e09957edc53c5dcd019bdb5d3f4a2bf04c6c776aa3b81" } } ], "anchor": "usagebudget" } ], "coverage": { "discovered": 38, "documented": 38, "missing": [] } }, { "subpath": "./crypto", "importSpecifier": "@openagentid/arsenal-sdk/crypto", "page": "/reference/typescript/arsenal-sdk/crypto", "kind": "declarations", "conditions": { "types": "./dist/crypto/index.d.ts", "import": "./dist/crypto/index.js", "require": "./dist/crypto/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/crypto/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/crypto/index.js" }, { "conditions": [ "require" ], "path": "./dist/crypto/index.cjs" } ], "exports": [ { "name": "aesGcmDecrypt", "declarationName": "aesGcmDecrypt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "AES-256-GCM decryption. `key` must be 32 bytes, `nonce` 12 bytes.", "tags": [], "signatures": [ { "code": "declare function aesGcmDecrypt(key: Uint8Array, nonce: Uint8Array, ciphertext: Uint8Array, aad?: Uint8Array): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 37, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "aesgcmdecrypt" }, { "name": "aesGcmEncrypt", "declarationName": "aesGcmEncrypt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "AES-256-GCM encryption. `key` must be 32 bytes, `nonce` 12 bytes.", "tags": [], "signatures": [ { "code": "declare function aesGcmEncrypt(key: Uint8Array, nonce: Uint8Array, plaintext: Uint8Array, aad?: Uint8Array): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 35, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "aesgcmencrypt" }, { "name": "blake3Hash", "declarationName": "blake3Hash", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "BLAKE3 keyed/unkeyed hash — returns a 32-byte digest.", "tags": [], "signatures": [ { "code": "declare function blake3Hash(input: Uint8Array): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 33, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "blake3hash" }, { "name": "ed25519Generate", "declarationName": "ed25519Generate", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generate a random Ed25519 keypair.", "tags": [], "signatures": [ { "code": "declare function ed25519Generate(): Promise<{\n publicKey: Uint8Array;\n secretKey: Uint8Array;\n}>;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 26, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "ed25519generate" }, { "name": "ed25519PublicKey", "declarationName": "ed25519PublicKey", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derive a public key from an Ed25519 secret-key seed.", "tags": [], "signatures": [ { "code": "declare function ed25519PublicKey(secretKey: Uint8Array): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 24, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "ed25519publickey" }, { "name": "ed25519Sign", "declarationName": "ed25519Sign", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Ed25519 signature — sign `message` with `secretKey` (32-byte seed).", "tags": [], "signatures": [ { "code": "declare function ed25519Sign(secretKey: Uint8Array, message: Uint8Array): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 20, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "ed25519sign" }, { "name": "ed25519Verify", "declarationName": "ed25519Verify", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Ed25519 signature verification — returns true if the signature is valid.", "tags": [], "signatures": [ { "code": "declare function ed25519Verify(publicKey: Uint8Array, message: Uint8Array, signature: Uint8Array): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 22, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "ed25519verify" }, { "name": "hkdfDerive", "declarationName": "hkdfDerive", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "HKDF-SHA256 key derivation. `length` is the number of output bytes.", "tags": [], "signatures": [ { "code": "declare function hkdfDerive(ikm: Uint8Array, salt: Uint8Array, info: Uint8Array, length: number): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 31, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "hkdfderive" }, { "name": "randomBytes", "declarationName": "randomBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generate cryptographically secure random bytes.", "tags": [], "signatures": [ { "code": "declare function randomBytes(length: number): Promise;", "source": { "package": "@openagentid/arsenal-sdk", "version": "0.1.1", "file": "dist/crypto/index.d.ts", "line": 39, "sha256": "dc682649df74749d213398781caec696186d77cf205e3362812bff078a3ea248" } } ], "anchor": "randombytes" } ], "supportingDeclarations": [], "coverage": { "discovered": 9, "documented": 9, "missing": [] } } ] }, { "name": "@openagentid/claude-agent", "version": "0.1.1", "status": "legacy-sdk-peer", "notes": [ "Declares an optional peer on @openagentid/sdk ^0.1.0, which excludes SDK 0.7.2. Reference describes the published contract; do not assume compatibility with the current SDK." ], "tarball": "https://registry.npmjs.org/@openagentid/claude-agent/-/claude-agent-0.1.1.tgz", "integrity": "sha512-kUX3T6aS6PYr0GqQmLG7t2DLeOquNBVAoDkXN1yk09ffh6S5TIuHQgA2jptxjgLetu4n3XXP0AmEFb+jgQ1Dow==", "packageJsonSha256": "6c30c5f4a056d610e6f521142df7a7483cc8dae8f0851f598a1fe34ca40842b2", "page": "/reference/typescript/claude-agent", "engines": { "node": ">=20" }, "dependencies": {}, "peerDependencies": { "@anthropic-ai/claude-agent-sdk": ">=0.1.0", "@openagentid/sdk": "^0.1.0" }, "peerDependenciesMeta": { "@anthropic-ai/claude-agent-sdk": { "optional": false }, "@openagentid/sdk": { "optional": true } }, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/claude-agent", "page": "/reference/typescript/claude-agent", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" }, { "conditions": [ "require" ], "path": "./dist/index.cjs" } ], "exports": [ { "name": "AllowListSkillsPolicy", "declarationName": "AllowListSkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Allow-listed skills policy: only the named skills are permitted, and the\nagent must additionally hold the right scope.", "tags": [], "signatures": [ { "code": "declare class AllowListSkillsPolicy implements SkillsPolicy {\n constructor(allowedSkills: Iterable, inner?: SkillsPolicy);\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 52, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "allowlistskillspolicy" }, { "name": "AuditChain", "declarationName": "AuditChain", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Builds and signs (hash-chains) audit records. The chain is owned by a\nsingle session — callers should construct one chain per session.", "tags": [], "signatures": [ { "code": "declare class AuditChain {\n constructor(opts: {\n sessionId: string;\n agentDid: string;\n sink: AuditSink;\n });\n append(input: {\n kind: AuditKind;\n name?: string;\n outcome: AuditRecord[\"outcome\"];\n inputHash?: string;\n outputHash?: string;\n context?: Record;\n }): Promise;\n head(): string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 24, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "auditchain" }, { "name": "AuditKind", "declarationName": "AuditKind", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Categories of audit events.", "tags": [], "signatures": [ { "code": "type AuditKind = 'session.start' | 'session.stop' | 'tool.preflight' | 'tool.complete' | 'skill.preflight' | 'skill.complete' | 'message.signed' | 'policy.deny';", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 83, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditkind" }, { "name": "AuditRecord", "declarationName": "AuditRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single tamper-evident audit record.", "tags": [], "signatures": [ { "code": "interface AuditRecord {\n seq: number;\n timestamp: string;\n sessionId: string;\n agentDid: string;\n kind: AuditKind;\n name?: string;\n outcome: 'allow' | 'deny' | 'ok' | 'error';\n inputHash?: string;\n outputHash?: string;\n prevHash: string;\n hash: string;\n context?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 56, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditrecord" }, { "name": "AuditSink", "declarationName": "AuditSink", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Audit sink — receives one record per tool / skill invocation.", "tags": [], "signatures": [ { "code": "interface AuditSink {\n append(record: AuditRecord): Promise | void;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 51, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditsink" }, { "name": "canonicalJson", "declarationName": "canonicalJson", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Stable JSON stringify (sorted keys) for deterministic hashing.", "tags": [], "signatures": [ { "code": "declare function canonicalJson(value: unknown): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 152, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "canonicaljson" }, { "name": "CapabilityChecker", "declarationName": "CapabilityChecker", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Anything implementing this can authorise tool / skill invocations.", "tags": [], "signatures": [ { "code": "interface CapabilityChecker {\n check(scope: string): Promise | ScopeDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 41, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "capabilitychecker" }, { "name": "CompositeSkillsPolicy", "declarationName": "CompositeSkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Compose multiple policies — a skill is allowed only if every policy\nallows it. Useful for stacking allow-list + scope + custom policies.", "tags": [], "signatures": [ { "code": "declare class CompositeSkillsPolicy implements SkillsPolicy {\n constructor(policies: readonly SkillsPolicy[]);\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 62, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "compositeskillspolicy" }, { "name": "ConfigError", "declarationName": "ConfigError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Configuration was invalid at plugin construction time.", "tags": [], "signatures": [ { "code": "declare class ConfigError extends PluginError {\n constructor(message: string, context?: Record);\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 130, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "configerror" }, { "name": "ConsoleAuditSink", "declarationName": "ConsoleAuditSink", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Audit sink that writes structured JSON to stdout — handy for dev.", "tags": [], "signatures": [ { "code": "declare class ConsoleAuditSink implements AuditSink {\n append(record: AuditRecord): void;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 62, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "consoleauditsink" }, { "name": "DenyUnlessScopedSkillsPolicy", "declarationName": "DenyUnlessScopedSkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Deny-unless-scoped skills policy.\n\nFor a skill named `foo`, requires the agent to hold `skills:invoke:foo`\n(or a wildcard that subsumes it). This is the default policy when the\ncaller passes `audit: true` without supplying their own.", "tags": [], "signatures": [ { "code": "declare class DenyUnlessScopedSkillsPolicy implements SkillsPolicy {\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 45, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "denyunlessscopedskillspolicy" }, { "name": "FanOutAuditSink", "declarationName": "FanOutAuditSink", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Compose multiple sinks (records are dispatched to all in order).", "tags": [], "signatures": [ { "code": "declare class FanOutAuditSink implements AuditSink {\n constructor(sinks: readonly AuditSink[]);\n append(record: AuditRecord): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 66, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "fanoutauditsink" }, { "name": "GENESIS_PREV_HASH", "declarationName": "GENESIS_PREV_HASH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Sentinel for the head of the chain.", "tags": [], "signatures": [ { "code": "declare const GENESIS_PREV_HASH: string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 19, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "genesis_prev_hash" }, { "name": "getHashAlgo", "declarationName": "getHashAlgo", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve which hash algorithm to use, attempting to load `blake3` once.\nSubsequent calls are cached.", "tags": [], "signatures": [ { "code": "declare function getHashAlgo(): HashAlgo;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 148, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "gethashalgo" }, { "name": "hashHex", "declarationName": "hashHex", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Hash a string or byte buffer and return lowercase hex.", "tags": [], "signatures": [ { "code": "declare function hashHex(data: string | Uint8Array): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 150, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "hashhex" }, { "name": "hashRecord", "declarationName": "hashRecord", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compute the hash of a record (excludes the hash field itself).", "tags": [], "signatures": [ { "code": "declare function hashRecord(record: AuditRecord): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 48, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "hashrecord" }, { "name": "HookContext", "declarationName": "HookContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Per-session state that the hooks share. Constructed once when the\nsession starts and disposed when it ends.", "tags": [], "signatures": [ { "code": "interface HookContext {\n readonly identity: OpenAgentIdentity;\n readonly capabilities: CapabilityChecker;\n readonly skillsPolicy: SkillsPolicy;\n readonly chain: AuditChain;\n readonly signMessages: boolean;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 21, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "hookcontext" }, { "name": "HookDecision", "declarationName": "HookDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Decision object returned by gating hooks (preToolUse, onSkillInvoke).", "tags": [], "signatures": [ { "code": "interface HookDecision {\n allow: boolean;\n reason?: string;\n inputHash?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 74, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "hookdecision" }, { "name": "InMemoryAuditSink", "declarationName": "InMemoryAuditSink", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory audit sink (handy for tests + dry runs).", "tags": [], "signatures": [ { "code": "declare class InMemoryAuditSink implements AuditSink {\n readonly records: AuditRecord[];\n append(record: AuditRecord): void;\n clear(): void;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 55, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "inmemoryauditsink" }, { "name": "MessageInput", "declarationName": "MessageInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link onMessage}.", "tags": [], "signatures": [ { "code": "interface MessageInput {\n body: string | Uint8Array;\n direction: 'in' | 'out';\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 98, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "messageinput" }, { "name": "onMessage", "declarationName": "onMessage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Sign an outbound message with the agent's Ed25519 key (if signing is\nenabled) and append an audit record.", "tags": [], "signatures": [ { "code": "declare function onMessage(input: MessageInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 115, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onmessage" }, { "name": "OnMessageResult", "declarationName": "OnMessageResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of {@link onMessage}.", "tags": [], "signatures": [ { "code": "interface OnMessageResult {\n signature?: string;\n record: AuditRecord;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 105, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onmessageresult" }, { "name": "onSessionEnd", "declarationName": "onSessionEnd", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Emit a closing record at session end.", "tags": [], "signatures": [ { "code": "declare function onSessionEnd(ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 138, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onsessionend" }, { "name": "onSessionStart", "declarationName": "onSessionStart", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Initialise the per-session hook context and emit the opening audit\nrecord. Call this once when the Claude Agent SDK fires the session\nstart hook.", "tags": [], "signatures": [ { "code": "declare function onSessionStart(input: SessionStartInput, ctx: Omit & {\n sink: AuditSink;\n}): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 44, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onsessionstart" }, { "name": "onSkillInvoke", "declarationName": "onSkillInvoke", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Consult the OpenAgent skills policy before a SKILLS.md skill runs.\n\nThe Claude Agent SDK loads skills from SKILLS.md files; we hook the\ninvocation point and refuse anything the policy denies. Default\npolicy is `DenyUnlessScopedSkillsPolicy`.", "tags": [], "signatures": [ { "code": "declare function onSkillInvoke(input: SkillInvokeInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 134, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onskillinvoke" }, { "name": "onSkillInvokeOrThrow", "declarationName": "onSkillInvokeOrThrow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Throw-on-deny variant of {@link onSkillInvoke}.", "tags": [], "signatures": [ { "code": "declare function onSkillInvokeOrThrow(input: SkillInvokeInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 136, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onskillinvokeorthrow" }, { "name": "OpenAgentIdentity", "declarationName": "OpenAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verified OpenAgent identity, anchored on a `did:oas:*` string.", "tags": [], "signatures": [ { "code": "interface OpenAgentIdentity {\n did: string;\n kind: string;\n displayName?: string;\n publicKey: string;\n sign(payload: Uint8Array): Promise | Uint8Array;\n lineage?: readonly string[];\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 12, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "openagentidentity" }, { "name": "openAgentPlugin", "declarationName": "openAgentPlugin", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a Claude Agent SDK plugin that wires OpenAgent identity,\ncapability control, and tamper-evident audit logging into the agent\nlifecycle.", "tags": [], "signatures": [ { "code": "declare function openAgentPlugin(opts: OpenAgentPluginOptions): OpenAgentPlugin;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 89, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "openagentplugin" }, { "name": "OpenAgentPlugin", "declarationName": "OpenAgentPlugin", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Shape returned by {@link openAgentPlugin}.", "tags": [], "signatures": [ { "code": "interface OpenAgentPlugin {\n readonly name: '@openagentid/claude-agent';\n readonly version: string;\n readonly hooks: PluginHooks;\n inspectAudit(): readonly AuditRecord[];\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 36, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "openagentplugin-1" }, { "name": "OpenAgentPluginOptions", "declarationName": "OpenAgentPluginOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration accepted by {@link openAgentPlugin}.", "tags": [], "signatures": [ { "code": "interface OpenAgentPluginOptions {\n agent: OpenAgentIdentity;\n capabilities: CapabilityChecker;\n skillsPolicy?: SkillsPolicy;\n audit?: boolean | AuditSink;\n signMessages?: boolean;\n denyMode?: 'throw' | 'block';\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 9, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "openagentpluginoptions" }, { "name": "PluginError", "declarationName": "PluginError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Base error for the plugin.", "tags": [], "signatures": [ { "code": "declare class PluginError extends Error {\n readonly code: PluginErrorCodeValue;\n readonly context?: Record;\n readonly cause?: unknown;\n constructor(message: string, code: PluginErrorCodeValue, options?: {\n context?: Record;\n cause?: unknown;\n });\n toJSON(): Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 109, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "pluginerror" }, { "name": "PluginErrorCode", "declarationName": "PluginErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Stable, machine-readable error codes.", "tags": [], "signatures": [ { "code": "declare const PluginErrorCode: {\n readonly CONFIG_INVALID: \"openagent/claude-agent/config-invalid\";\n readonly IDENTITY_MISSING: \"openagent/claude-agent/identity-missing\";\n readonly TOOL_DENIED: \"openagent/claude-agent/tool-denied\";\n readonly SKILL_DENIED: \"openagent/claude-agent/skill-denied\";\n readonly AUDIT_FAILED: \"openagent/claude-agent/audit-failed\";\n readonly HOOK_INTERNAL: \"openagent/claude-agent/hook-internal\";\n readonly SIGN_FAILED: \"openagent/claude-agent/sign-failed\";\n};", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 98, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "pluginerrorcode" }, { "name": "PluginErrorCodeValue", "declarationName": "PluginErrorCodeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type PluginErrorCodeValue = (typeof PluginErrorCode)[keyof typeof PluginErrorCode];", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 107, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "pluginerrorcodevalue" }, { "name": "PluginHooks", "declarationName": "PluginHooks", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Bound hook handlers. Each method receives the SDK's hook input plus the\nSDK-managed context object and returns a plain JS object the SDK can\nroute. The shapes below are the documented Claude Agent SDK hook\nsignatures; if Anthropic adds a new lifecycle stage we add a new method\nhere without breaking existing wiring.", "tags": [], "signatures": [ { "code": "interface PluginHooks {\n onSessionStart(input: SessionStartInput): Promise<{\n allow: true;\n }>;\n preToolUse(input: ToolUseInput): Promise;\n postToolUse(input: PostToolUseInput): Promise<{\n ok: true;\n }>;\n onMessage(input: MessageInput): Promise<{\n allow: true;\n signature?: string;\n }>;\n onSkillInvoke(input: SkillInvokeInput): Promise;\n onSessionEnd(): Promise<{\n ok: true;\n }>;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 56, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "pluginhooks" }, { "name": "postToolUse", "declarationName": "postToolUse", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Emit a post-tool-use audit record with input + output hashes.\n\nThe record's hash chain prevents post-hoc tampering: a verifier can\nreplay {@link import ('./audit.js').verifyChain} over an exported chain\nto detect any modification.", "tags": [], "signatures": [ { "code": "declare function postToolUse(input: PostToolUseInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 96, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "posttooluse" }, { "name": "PostToolUseInput", "declarationName": "PostToolUseInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link postToolUse}.", "tags": [], "signatures": [ { "code": "interface PostToolUseInput {\n toolName: string;\n result: unknown;\n ok: boolean;\n error?: string;\n inputHash?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 78, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "posttooluseinput" }, { "name": "preToolUse", "declarationName": "preToolUse", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify a tool call against Arsenal scopes and emit a preflight audit\nrecord.\n\nReturns `{ allow: false }` rather than throwing so the caller can\ndecide whether to short-circuit the SDK or surface an error to the\nmodel. The plugin's hook adapter throws {@link ToolDeniedError } when\nthe SDK requires an exception-based deny.", "tags": [], "signatures": [ { "code": "declare function preToolUse(input: ToolUseInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 74, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "pretooluse" }, { "name": "preToolUseOrThrow", "declarationName": "preToolUseOrThrow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Throw-on-deny variant of {@link preToolUse}.", "tags": [], "signatures": [ { "code": "declare function preToolUseOrThrow(input: ToolUseInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 76, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "pretooluseorthrow" }, { "name": "PreToolUseResult", "declarationName": "PreToolUseResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a pre-tool-use evaluation.", "tags": [], "signatures": [ { "code": "interface PreToolUseResult {\n allow: boolean;\n reason?: string;\n record: AuditRecord;\n inputHash: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 55, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "pretooluseresult" }, { "name": "ScopeDecision", "declarationName": "ScopeDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a credential / scope check.", "tags": [], "signatures": [ { "code": "interface ScopeDecision {\n allowed: boolean;\n matchedScope?: string;\n reason?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 32, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "scopedecision" }, { "name": "SessionStartInput", "declarationName": "SessionStartInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link onSessionStart}.", "tags": [], "signatures": [ { "code": "interface SessionStartInput {\n sessionId: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 29, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "sessionstartinput" }, { "name": "SessionStartResult", "declarationName": "SessionStartResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of {@link onSessionStart}.", "tags": [], "signatures": [ { "code": "interface SessionStartResult {\n record: AuditRecord;\n context: HookContext;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 33, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "sessionstartresult" }, { "name": "SKILL_SCOPE_PREFIX", "declarationName": "SKILL_SCOPE_PREFIX", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Scope grammar for skill invocations.", "tags": [], "signatures": [ { "code": "declare const SKILL_SCOPE_PREFIX = \"skills:invoke:\";", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 18, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "skill_scope_prefix" }, { "name": "SkillDecision", "declarationName": "SkillDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a skills policy evaluation.", "tags": [], "signatures": [ { "code": "interface SkillDecision {\n allowed: boolean;\n reason?: string;\n matchedScope?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 113, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skilldecision" }, { "name": "SkillDeniedError", "declarationName": "SkillDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A skill invocation was rejected by the skills policy.", "tags": [], "signatures": [ { "code": "declare class SkillDeniedError extends PluginError {\n readonly skill: string;\n constructor(skill: string, reason?: string, context?: Record);\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 125, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "skilldeniederror" }, { "name": "SkillEvaluationContext", "declarationName": "SkillEvaluationContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Context passed to a skills policy evaluation.", "tags": [], "signatures": [ { "code": "interface SkillEvaluationContext {\n identity: OpenAgentIdentity;\n capabilities: CapabilityChecker;\n metadata?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 104, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skillevaluationcontext" }, { "name": "SkillInvokeInput", "declarationName": "SkillInvokeInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link onSkillInvoke}.", "tags": [], "signatures": [ { "code": "interface SkillInvokeInput {\n skillName: string;\n args?: unknown;\n metadata?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 117, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "skillinvokeinput" }, { "name": "SkillInvokeResult", "declarationName": "SkillInvokeResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of {@link onSkillInvoke}.", "tags": [], "signatures": [ { "code": "interface SkillInvokeResult {\n decision: SkillDecision;\n record: AuditRecord;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 123, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "skillinvokeresult" }, { "name": "skillScope", "declarationName": "skillScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build the canonical scope string for a skill name.", "tags": [], "signatures": [ { "code": "declare function skillScope(name: string): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 22, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "skillscope" }, { "name": "SkillsManifestEntry", "declarationName": "SkillsManifestEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "SKILLS.md entry as parsed from a manifest.", "tags": [], "signatures": [ { "code": "interface SkillsManifestEntry {\n name: string;\n description?: string;\n requiredScope?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 85, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skillsmanifestentry" }, { "name": "SkillsPolicy", "declarationName": "SkillsPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Skills policy: decides whether a SKILLS.md skill may be invoked.", "tags": [], "signatures": [ { "code": "interface SkillsPolicy {\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise | SkillDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 94, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skillspolicy" }, { "name": "StaticCapabilityChecker", "declarationName": "StaticCapabilityChecker", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Capability checker backed by a fixed allowlist. Supports literal scopes\nand one wildcard form: `prefix:*` matches anything starting with `prefix:`.\n\nExample: `tools:invoke:*` allows every tool, `skills:invoke:web.*`\nallows every skill whose name starts with `web.`.", "tags": [], "signatures": [ { "code": "declare class StaticCapabilityChecker implements CapabilityChecker {\n constructor(scopes: Iterable);\n check(scope: string): ScopeDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 32, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "staticcapabilitychecker" }, { "name": "TOOL_SCOPE_PREFIX", "declarationName": "TOOL_SCOPE_PREFIX", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Scope grammar for tool invocations.", "tags": [], "signatures": [ { "code": "declare const TOOL_SCOPE_PREFIX = \"tools:invoke:\";", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 20, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "tool_scope_prefix" }, { "name": "ToolDeniedError", "declarationName": "ToolDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A tool call was rejected because the agent lacks the required scope.", "tags": [], "signatures": [ { "code": "declare class ToolDeniedError extends PluginError {\n readonly tool: string;\n constructor(tool: string, reason?: string, context?: Record);\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 120, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "tooldeniederror" }, { "name": "toolScope", "declarationName": "toolScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build the canonical scope string for a tool name.", "tags": [], "signatures": [ { "code": "declare function toolScope(name: string): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 24, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "toolscope" }, { "name": "ToolUseInput", "declarationName": "ToolUseInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link preToolUse}.", "tags": [], "signatures": [ { "code": "interface ToolUseInput {\n toolName: string;\n args: unknown;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 48, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "tooluseinput" }, { "name": "verifyChain", "declarationName": "verifyChain", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify that a previously emitted chain has not been tampered with.", "tags": [], "signatures": [ { "code": "declare function verifyChain(records: readonly AuditRecord[]): {\n valid: boolean;\n brokenAt?: number;\n};", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 50, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "verifychain" } ], "supportingDeclarations": [ { "name": "HashAlgo", "declarationName": "HashAlgo", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Identifier for the hash primitive in use.", "tags": [], "signatures": [ { "code": "type HashAlgo = 'blake3' | 'sha256';", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/index.d.ts", "line": 143, "sha256": "2b03e729a926723385604cb1d17385c49459d105d7721bcc0f32ff47c70c42c6" } } ], "anchor": "hashalgo" } ], "coverage": { "discovered": 57, "documented": 57, "missing": [] } }, { "subpath": "./hooks", "importSpecifier": "@openagentid/claude-agent/hooks", "page": "/reference/typescript/claude-agent/hooks", "kind": "declarations", "conditions": { "types": "./dist/hooks.d.ts", "import": "./dist/hooks.js", "require": "./dist/hooks.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/hooks.d.ts" }, { "conditions": [ "import" ], "path": "./dist/hooks.js" }, { "conditions": [ "require" ], "path": "./dist/hooks.cjs" } ], "exports": [ { "name": "HookContext", "declarationName": "HookContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Per-session state that the hooks share. Constructed once when the\nsession starts and disposed when it ends.", "tags": [], "signatures": [ { "code": "interface HookContext {\n readonly identity: OpenAgentIdentity;\n readonly capabilities: CapabilityChecker;\n readonly skillsPolicy: SkillsPolicy;\n readonly chain: AuditChain;\n readonly signMessages: boolean;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 21, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "hookcontext" }, { "name": "MessageInput", "declarationName": "MessageInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link onMessage}.", "tags": [], "signatures": [ { "code": "interface MessageInput {\n body: string | Uint8Array;\n direction: 'in' | 'out';\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 98, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "messageinput" }, { "name": "onMessage", "declarationName": "onMessage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Sign an outbound message with the agent's Ed25519 key (if signing is\nenabled) and append an audit record.", "tags": [], "signatures": [ { "code": "declare function onMessage(input: MessageInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 115, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onmessage" }, { "name": "OnMessageResult", "declarationName": "OnMessageResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of {@link onMessage}.", "tags": [], "signatures": [ { "code": "interface OnMessageResult {\n signature?: string;\n record: AuditRecord;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 105, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onmessageresult" }, { "name": "onSessionEnd", "declarationName": "onSessionEnd", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Emit a closing record at session end.", "tags": [], "signatures": [ { "code": "declare function onSessionEnd(ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 138, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onsessionend" }, { "name": "onSessionStart", "declarationName": "onSessionStart", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Initialise the per-session hook context and emit the opening audit\nrecord. Call this once when the Claude Agent SDK fires the session\nstart hook.", "tags": [], "signatures": [ { "code": "declare function onSessionStart(input: SessionStartInput, ctx: Omit & {\n sink: AuditSink;\n}): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 44, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onsessionstart" }, { "name": "onSkillInvoke", "declarationName": "onSkillInvoke", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Consult the OpenAgent skills policy before a SKILLS.md skill runs.\n\nThe Claude Agent SDK loads skills from SKILLS.md files; we hook the\ninvocation point and refuse anything the policy denies. Default\npolicy is `DenyUnlessScopedSkillsPolicy`.", "tags": [], "signatures": [ { "code": "declare function onSkillInvoke(input: SkillInvokeInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 134, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onskillinvoke" }, { "name": "onSkillInvokeOrThrow", "declarationName": "onSkillInvokeOrThrow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Throw-on-deny variant of {@link onSkillInvoke}.", "tags": [], "signatures": [ { "code": "declare function onSkillInvokeOrThrow(input: SkillInvokeInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 136, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "onskillinvokeorthrow" }, { "name": "postToolUse", "declarationName": "postToolUse", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Emit a post-tool-use audit record with input + output hashes.\n\nThe record's hash chain prevents post-hoc tampering: a verifier can\nreplay {@link import ('./audit.js').verifyChain} over an exported chain\nto detect any modification.", "tags": [], "signatures": [ { "code": "declare function postToolUse(input: PostToolUseInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 96, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "posttooluse" }, { "name": "PostToolUseInput", "declarationName": "PostToolUseInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link postToolUse}.", "tags": [], "signatures": [ { "code": "interface PostToolUseInput {\n toolName: string;\n result: unknown;\n ok: boolean;\n error?: string;\n inputHash?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 78, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "posttooluseinput" }, { "name": "preToolUse", "declarationName": "preToolUse", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify a tool call against Arsenal scopes and emit a preflight audit\nrecord.\n\nReturns `{ allow: false }` rather than throwing so the caller can\ndecide whether to short-circuit the SDK or surface an error to the\nmodel. The plugin's hook adapter throws {@link ToolDeniedError } when\nthe SDK requires an exception-based deny.", "tags": [], "signatures": [ { "code": "declare function preToolUse(input: ToolUseInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 74, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "pretooluse" }, { "name": "preToolUseOrThrow", "declarationName": "preToolUseOrThrow", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Throw-on-deny variant of {@link preToolUse}.", "tags": [], "signatures": [ { "code": "declare function preToolUseOrThrow(input: ToolUseInput, ctx: HookContext): Promise;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 76, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "pretooluseorthrow" }, { "name": "PreToolUseResult", "declarationName": "PreToolUseResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a pre-tool-use evaluation.", "tags": [], "signatures": [ { "code": "interface PreToolUseResult {\n allow: boolean;\n reason?: string;\n record: AuditRecord;\n inputHash: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 55, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "pretooluseresult" }, { "name": "SessionStartInput", "declarationName": "SessionStartInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link onSessionStart}.", "tags": [], "signatures": [ { "code": "interface SessionStartInput {\n sessionId: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 29, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "sessionstartinput" }, { "name": "SessionStartResult", "declarationName": "SessionStartResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of {@link onSessionStart}.", "tags": [], "signatures": [ { "code": "interface SessionStartResult {\n record: AuditRecord;\n context: HookContext;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 33, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "sessionstartresult" }, { "name": "SkillInvokeInput", "declarationName": "SkillInvokeInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link onSkillInvoke}.", "tags": [], "signatures": [ { "code": "interface SkillInvokeInput {\n skillName: string;\n args?: unknown;\n metadata?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 117, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "skillinvokeinput" }, { "name": "SkillInvokeResult", "declarationName": "SkillInvokeResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of {@link onSkillInvoke}.", "tags": [], "signatures": [ { "code": "interface SkillInvokeResult {\n decision: SkillDecision;\n record: AuditRecord;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 123, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "skillinvokeresult" }, { "name": "ToolUseInput", "declarationName": "ToolUseInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Input shape for {@link preToolUse}.", "tags": [], "signatures": [ { "code": "interface ToolUseInput {\n toolName: string;\n args: unknown;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/hooks.d.ts", "line": 48, "sha256": "356bb391374f619882301177d60fa9da728ab29983e8df5ac2172c0c9c1f4f7c" } } ], "anchor": "tooluseinput" } ], "supportingDeclarations": [ { "name": "AuditChain", "declarationName": "AuditChain", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Builds and signs (hash-chains) audit records. The chain is owned by a\nsingle session — callers should construct one chain per session.", "tags": [], "signatures": [ { "code": "declare class AuditChain {\n constructor(opts: {\n sessionId: string;\n agentDid: string;\n sink: AuditSink;\n });\n append(input: {\n kind: AuditKind;\n name?: string;\n outcome: AuditRecord[\"outcome\"];\n inputHash?: string;\n outputHash?: string;\n context?: Record;\n }): Promise;\n head(): string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 24, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "auditchain" }, { "name": "AuditKind", "declarationName": "AuditKind", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Categories of audit events.", "tags": [], "signatures": [ { "code": "type AuditKind = 'session.start' | 'session.stop' | 'tool.preflight' | 'tool.complete' | 'skill.preflight' | 'skill.complete' | 'message.signed' | 'policy.deny';", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 83, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditkind" }, { "name": "AuditRecord", "declarationName": "AuditRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single tamper-evident audit record.", "tags": [], "signatures": [ { "code": "interface AuditRecord {\n seq: number;\n timestamp: string;\n sessionId: string;\n agentDid: string;\n kind: AuditKind;\n name?: string;\n outcome: 'allow' | 'deny' | 'ok' | 'error';\n inputHash?: string;\n outputHash?: string;\n prevHash: string;\n hash: string;\n context?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 56, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditrecord" }, { "name": "AuditSink", "declarationName": "AuditSink", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Audit sink — receives one record per tool / skill invocation.", "tags": [], "signatures": [ { "code": "interface AuditSink {\n append(record: AuditRecord): Promise | void;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 51, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditsink" }, { "name": "CapabilityChecker", "declarationName": "CapabilityChecker", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Anything implementing this can authorise tool / skill invocations.", "tags": [], "signatures": [ { "code": "interface CapabilityChecker {\n check(scope: string): Promise | ScopeDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 41, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "capabilitychecker" }, { "name": "OpenAgentIdentity", "declarationName": "OpenAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verified OpenAgent identity, anchored on a `did:oas:*` string.", "tags": [], "signatures": [ { "code": "interface OpenAgentIdentity {\n did: string;\n kind: string;\n displayName?: string;\n publicKey: string;\n sign(payload: Uint8Array): Promise | Uint8Array;\n lineage?: readonly string[];\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 12, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "openagentidentity" }, { "name": "ScopeDecision", "declarationName": "ScopeDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a credential / scope check.", "tags": [], "signatures": [ { "code": "interface ScopeDecision {\n allowed: boolean;\n matchedScope?: string;\n reason?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 32, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "scopedecision" }, { "name": "SkillDecision", "declarationName": "SkillDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a skills policy evaluation.", "tags": [], "signatures": [ { "code": "interface SkillDecision {\n allowed: boolean;\n reason?: string;\n matchedScope?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 113, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skilldecision" }, { "name": "SkillEvaluationContext", "declarationName": "SkillEvaluationContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Context passed to a skills policy evaluation.", "tags": [], "signatures": [ { "code": "interface SkillEvaluationContext {\n identity: OpenAgentIdentity;\n capabilities: CapabilityChecker;\n metadata?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 104, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skillevaluationcontext" }, { "name": "SkillsPolicy", "declarationName": "SkillsPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Skills policy: decides whether a SKILLS.md skill may be invoked.", "tags": [], "signatures": [ { "code": "interface SkillsPolicy {\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise | SkillDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 94, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skillspolicy" } ], "coverage": { "discovered": 18, "documented": 18, "missing": [] } }, { "subpath": "./policy", "importSpecifier": "@openagentid/claude-agent/policy", "page": "/reference/typescript/claude-agent/policy", "kind": "declarations", "conditions": { "types": "./dist/policy.d.ts", "import": "./dist/policy.js", "require": "./dist/policy.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/policy.d.ts" }, { "conditions": [ "import" ], "path": "./dist/policy.js" }, { "conditions": [ "require" ], "path": "./dist/policy.cjs" } ], "exports": [ { "name": "AllowListSkillsPolicy", "declarationName": "AllowListSkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Allow-listed skills policy: only the named skills are permitted, and the\nagent must additionally hold the right scope.", "tags": [], "signatures": [ { "code": "declare class AllowListSkillsPolicy implements SkillsPolicy {\n constructor(allowedSkills: Iterable, inner?: SkillsPolicy);\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 52, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "allowlistskillspolicy" }, { "name": "CompositeSkillsPolicy", "declarationName": "CompositeSkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Compose multiple policies — a skill is allowed only if every policy\nallows it. Useful for stacking allow-list + scope + custom policies.", "tags": [], "signatures": [ { "code": "declare class CompositeSkillsPolicy implements SkillsPolicy {\n constructor(policies: readonly SkillsPolicy[]);\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 62, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "compositeskillspolicy" }, { "name": "DenyUnlessScopedSkillsPolicy", "declarationName": "DenyUnlessScopedSkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Deny-unless-scoped skills policy.\n\nFor a skill named `foo`, requires the agent to hold `skills:invoke:foo`\n(or a wildcard that subsumes it). This is the default policy when the\ncaller passes `audit: true` without supplying their own.", "tags": [], "signatures": [ { "code": "declare class DenyUnlessScopedSkillsPolicy implements SkillsPolicy {\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 45, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "denyunlessscopedskillspolicy" }, { "name": "SKILL_SCOPE_PREFIX", "declarationName": "SKILL_SCOPE_PREFIX", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Scope grammar for skill invocations.", "tags": [], "signatures": [ { "code": "declare const SKILL_SCOPE_PREFIX = \"skills:invoke:\";", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 18, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "skill_scope_prefix" }, { "name": "skillScope", "declarationName": "skillScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build the canonical scope string for a skill name.", "tags": [], "signatures": [ { "code": "declare function skillScope(name: string): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 22, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "skillscope" }, { "name": "StaticCapabilityChecker", "declarationName": "StaticCapabilityChecker", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Capability checker backed by a fixed allowlist. Supports literal scopes\nand one wildcard form: `prefix:*` matches anything starting with `prefix:`.\n\nExample: `tools:invoke:*` allows every tool, `skills:invoke:web.*`\nallows every skill whose name starts with `web.`.", "tags": [], "signatures": [ { "code": "declare class StaticCapabilityChecker implements CapabilityChecker {\n constructor(scopes: Iterable);\n check(scope: string): ScopeDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 32, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "staticcapabilitychecker" }, { "name": "TOOL_SCOPE_PREFIX", "declarationName": "TOOL_SCOPE_PREFIX", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Scope grammar for tool invocations.", "tags": [], "signatures": [ { "code": "declare const TOOL_SCOPE_PREFIX = \"tools:invoke:\";", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 20, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "tool_scope_prefix" }, { "name": "toolScope", "declarationName": "toolScope", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build the canonical scope string for a tool name.", "tags": [], "signatures": [ { "code": "declare function toolScope(name: string): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/policy.d.ts", "line": 24, "sha256": "e5e726855e380b1f171e44746fce2e2f67441af8149f76d8f1e4480b18e5c669" } } ], "anchor": "toolscope" } ], "supportingDeclarations": [ { "name": "CapabilityChecker", "declarationName": "CapabilityChecker", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Anything implementing this can authorise tool / skill invocations.", "tags": [], "signatures": [ { "code": "interface CapabilityChecker {\n check(scope: string): Promise | ScopeDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 41, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "capabilitychecker" }, { "name": "OpenAgentIdentity", "declarationName": "OpenAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verified OpenAgent identity, anchored on a `did:oas:*` string.", "tags": [], "signatures": [ { "code": "interface OpenAgentIdentity {\n did: string;\n kind: string;\n displayName?: string;\n publicKey: string;\n sign(payload: Uint8Array): Promise | Uint8Array;\n lineage?: readonly string[];\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 12, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "openagentidentity" }, { "name": "ScopeDecision", "declarationName": "ScopeDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a credential / scope check.", "tags": [], "signatures": [ { "code": "interface ScopeDecision {\n allowed: boolean;\n matchedScope?: string;\n reason?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 32, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "scopedecision" }, { "name": "SkillDecision", "declarationName": "SkillDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of a skills policy evaluation.", "tags": [], "signatures": [ { "code": "interface SkillDecision {\n allowed: boolean;\n reason?: string;\n matchedScope?: string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 113, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skilldecision" }, { "name": "SkillEvaluationContext", "declarationName": "SkillEvaluationContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Context passed to a skills policy evaluation.", "tags": [], "signatures": [ { "code": "interface SkillEvaluationContext {\n identity: OpenAgentIdentity;\n capabilities: CapabilityChecker;\n metadata?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 104, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skillevaluationcontext" }, { "name": "SkillsPolicy", "declarationName": "SkillsPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Skills policy: decides whether a SKILLS.md skill may be invoked.", "tags": [], "signatures": [ { "code": "interface SkillsPolicy {\n evaluate(skillName: string, ctx: SkillEvaluationContext): Promise | SkillDecision;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 94, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "skillspolicy" } ], "coverage": { "discovered": 8, "documented": 8, "missing": [] } }, { "subpath": "./audit", "importSpecifier": "@openagentid/claude-agent/audit", "page": "/reference/typescript/claude-agent/audit", "kind": "declarations", "conditions": { "types": "./dist/audit.d.ts", "import": "./dist/audit.js", "require": "./dist/audit.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/audit.d.ts" }, { "conditions": [ "import" ], "path": "./dist/audit.js" }, { "conditions": [ "require" ], "path": "./dist/audit.cjs" } ], "exports": [ { "name": "AuditChain", "declarationName": "AuditChain", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Builds and signs (hash-chains) audit records. The chain is owned by a\nsingle session — callers should construct one chain per session.", "tags": [], "signatures": [ { "code": "declare class AuditChain {\n constructor(opts: {\n sessionId: string;\n agentDid: string;\n sink: AuditSink;\n });\n append(input: {\n kind: AuditKind;\n name?: string;\n outcome: AuditRecord[\"outcome\"];\n inputHash?: string;\n outputHash?: string;\n context?: Record;\n }): Promise;\n head(): string;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 24, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "auditchain" }, { "name": "ConsoleAuditSink", "declarationName": "ConsoleAuditSink", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Audit sink that writes structured JSON to stdout — handy for dev.", "tags": [], "signatures": [ { "code": "declare class ConsoleAuditSink implements AuditSink {\n append(record: AuditRecord): void;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 62, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "consoleauditsink" }, { "name": "FanOutAuditSink", "declarationName": "FanOutAuditSink", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Compose multiple sinks (records are dispatched to all in order).", "tags": [], "signatures": [ { "code": "declare class FanOutAuditSink implements AuditSink {\n constructor(sinks: readonly AuditSink[]);\n append(record: AuditRecord): Promise;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 66, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "fanoutauditsink" }, { "name": "GENESIS_PREV_HASH", "declarationName": "GENESIS_PREV_HASH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Sentinel for the head of the chain.", "tags": [], "signatures": [ { "code": "declare const GENESIS_PREV_HASH: string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 19, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "genesis_prev_hash" }, { "name": "hashRecord", "declarationName": "hashRecord", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compute the hash of a record (excludes the hash field itself).", "tags": [], "signatures": [ { "code": "declare function hashRecord(record: AuditRecord): string;", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 48, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "hashrecord" }, { "name": "InMemoryAuditSink", "declarationName": "InMemoryAuditSink", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory audit sink (handy for tests + dry runs).", "tags": [], "signatures": [ { "code": "declare class InMemoryAuditSink implements AuditSink {\n readonly records: AuditRecord[];\n append(record: AuditRecord): void;\n clear(): void;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 55, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "inmemoryauditsink" }, { "name": "verifyChain", "declarationName": "verifyChain", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verify that a previously emitted chain has not been tampered with.", "tags": [], "signatures": [ { "code": "declare function verifyChain(records: readonly AuditRecord[]): {\n valid: boolean;\n brokenAt?: number;\n};", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 50, "sha256": "c905f76aa5d6cf55a70c6f46f5a16dedbf6e0aed145ce15c9109b4268e0f66b4" } } ], "anchor": "verifychain" } ], "supportingDeclarations": [ { "name": "AuditKind", "declarationName": "AuditKind", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Categories of audit events.", "tags": [], "signatures": [ { "code": "type AuditKind = 'session.start' | 'session.stop' | 'tool.preflight' | 'tool.complete' | 'skill.preflight' | 'skill.complete' | 'message.signed' | 'policy.deny';", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 83, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditkind" }, { "name": "AuditRecord", "declarationName": "AuditRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single tamper-evident audit record.", "tags": [], "signatures": [ { "code": "interface AuditRecord {\n seq: number;\n timestamp: string;\n sessionId: string;\n agentDid: string;\n kind: AuditKind;\n name?: string;\n outcome: 'allow' | 'deny' | 'ok' | 'error';\n inputHash?: string;\n outputHash?: string;\n prevHash: string;\n hash: string;\n context?: Record;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 56, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditrecord" }, { "name": "AuditSink", "declarationName": "AuditSink", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Audit sink — receives one record per tool / skill invocation.", "tags": [], "signatures": [ { "code": "interface AuditSink {\n append(record: AuditRecord): Promise | void;\n}", "source": { "package": "@openagentid/claude-agent", "version": "0.1.1", "file": "dist/types-BH6j5Zy9.d.ts", "line": 51, "sha256": "e2dd9c4531a57db18e2a709a582aa895932f332789590a72e96d6321ba9be526" } } ], "anchor": "auditsink" } ], "coverage": { "discovered": 7, "documented": 7, "missing": [] } } ] }, { "name": "@openagentid/client", "version": "0.1.1", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/client/-/client-0.1.1.tgz", "integrity": "sha512-0N/grSygK2RD59oOUOPUwJg+A6wHPC2RPk0ouuyjcDVnGkA2QR/tGQbEY6kzK/YjhORVN/3pXTtiivh9AjVI9Q==", "packageJsonSha256": "4d1e33290792ae008361f9fca6dcbe033d08f25c154ab794cc3689d8c66d5acc", "page": "/reference/typescript/client", "engines": { "node": ">=18" }, "dependencies": { "@noble/ed25519": "^2.1.0", "@noble/hashes": "^1.5.0", "canonicalize": "^2.0.0" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/client", "page": "/reference/typescript/client", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "AuthenticatedResponse", "declarationName": "AuthenticatedResponse", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of an authenticated request through {@link OpenAgentClient.fetch }.\n\nMirrors `AuthenticatedResponse` in the Rust client. Includes both the\nraw HTTP response (`status`, `headers`, `bodyBytes`) and the OpenAgent\nprincipal headers (`did`, `trustTier`, `sessionToken`) extracted from\nthe server's response.", "tags": [], "signatures": [ { "code": "export interface AuthenticatedResponse {\n status: number;\n headers: Headers;\n bodyBytes: Uint8Array;\n did?: string;\n trustTier?: number;\n sessionToken?: string;\n sessionExpires?: string;\n lineageAuthority?: LineageAuthorityContext;\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/types.d.ts", "line": 9, "sha256": "0d1b26823ad5466af127377c914015255eb84e40a5b098ff31b7a91d36bf6269" } } ], "anchor": "authenticatedresponse" }, { "name": "base64url", "declarationName": "base64url", "kind": "namespace", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export * as base64url from \"./base64url.js\";", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/index.d.ts", "line": 9, "sha256": "6cdc74016036f67756b5a15df737ab9af7de529cf3a25e4d75143766d4dcbe32" } } ], "namespaceExports": [ "decode", "decodeString", "encode", "encodeString" ], "anchor": "base64url" }, { "name": "bodyAsJson", "declarationName": "bodyAsJson", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Helper: parses the response body as JSON. Throws on parse failure.", "tags": [], "signatures": [ { "code": "export declare function bodyAsJson(response: AuthenticatedResponse): T;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/types.d.ts", "line": 64, "sha256": "0d1b26823ad5466af127377c914015255eb84e40a5b098ff31b7a91d36bf6269" } } ], "anchor": "bodyasjson" }, { "name": "bodyAsString", "declarationName": "bodyAsString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Helper: parses the response body as a UTF-8 string.", "tags": [], "signatures": [ { "code": "export declare function bodyAsString(response: AuthenticatedResponse): string;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/types.d.ts", "line": 60, "sha256": "0d1b26823ad5466af127377c914015255eb84e40a5b098ff31b7a91d36bf6269" } } ], "anchor": "bodyasstring" }, { "name": "canonicalizeChallenge", "declarationName": "canonicalizeChallenge", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "JCS-canonicalizes a challenge per RFC 8785 and returns the UTF-8 bytes.\n\nThe result MUST byte-equal what the openagent-server produces from\n`serde_jcs::to_string` over the same logical object.", "tags": [], "signatures": [ { "code": "export declare function canonicalizeChallenge(challenge: Challenge): Uint8Array;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/challenge.d.ts", "line": 43, "sha256": "233a346c5ea8f5e2ac3f7eb0422d92239980c82839939b3ad17f21fc26d67cbf" } } ], "anchor": "canonicalizechallenge" }, { "name": "Challenge", "declarationName": "Challenge", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A challenge issued by an OpenAgent server, decoded from the\n`WWW-Authenticate: OpenAgent challenge=\"\"` header.\n\nPer OPENAGENT-CORE-SPEC.md §4:\n- `type` MUST equal `\"openagent-challenge-v1\"`\n- `nonce` MUST be a 64-character hex string (32 random bytes)\n- `timestamp` MUST be RFC 3339 / ISO 8601 UTC\n- `origin` MUST be the server origin in `scheme://host[:port]` form\n- `realm` is optional", "tags": [], "signatures": [ { "code": "export interface Challenge {\n type: string;\n nonce: string;\n timestamp: string;\n origin: string;\n realm?: string;\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/challenge.d.ts", "line": 13, "sha256": "233a346c5ea8f5e2ac3f7eb0422d92239980c82839939b3ad17f21fc26d67cbf" } } ], "anchor": "challenge" }, { "name": "CHALLENGE_TYPE", "declarationName": "CHALLENGE_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CHALLENGE_TYPE = \"openagent-challenge-v1\";", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/challenge.d.ts", "line": 1, "sha256": "233a346c5ea8f5e2ac3f7eb0422d92239980c82839939b3ad17f21fc26d67cbf" } } ], "anchor": "challenge_type" }, { "name": "encodeDidKey", "declarationName": "encodeDidKey", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes an Ed25519 public key as a `did:key` URI per the W3C\n`did:key` method specification.\n\nMulticodec prefix for Ed25519 public keys: 0xed 0x01 (varint of 0xed).\nMultibase prefix: `z` for base58btc.", "tags": [], "signatures": [ { "code": "export declare function encodeDidKey(publicKey: Uint8Array): string;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/keypair.d.ts", "line": 64, "sha256": "1432c65d99bb0de3515a9d61cef506baab6e9ab53b5061358652293513e9996a" } } ], "anchor": "encodedidkey" }, { "name": "FetchOptions", "declarationName": "FetchOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for {@link OpenAgentClient.fetch }.", "tags": [], "signatures": [ { "code": "export interface FetchOptions {\n method?: string;\n body?: string | Uint8Array | Record;\n headers?: Record;\n forceChallenge?: boolean;\n signal?: AbortSignal;\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/types.d.ts", "line": 68, "sha256": "0d1b26823ad5466af127377c914015255eb84e40a5b098ff31b7a91d36bf6269" } } ], "anchor": "fetchoptions" }, { "name": "hex", "declarationName": "hex", "kind": "namespace", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export * as hex from \"./hex.js\";", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/index.d.ts", "line": 10, "sha256": "6cdc74016036f67756b5a15df737ab9af7de529cf3a25e4d75143766d4dcbe32" } } ], "namespaceExports": [ "decode", "encode" ], "anchor": "hex" }, { "name": "InvalidKeyError", "declarationName": "InvalidKeyError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The signing key is invalid (must be 32 raw bytes for Ed25519).", "tags": [], "signatures": [ { "code": "export declare class InvalidKeyError extends OpenAgentClientError {\n constructor(reason: string);\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 42, "sha256": "e51dbc1eb0aecc1e5490369315585cb00fe5ed8d0495a3f2f9a1a49d601598c9" } } ], "anchor": "invalidkeyerror" }, { "name": "InvalidUrlError", "declarationName": "InvalidUrlError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The URL passed to {@link OpenAgentClient.fetch } could not be parsed.", "tags": [], "signatures": [ { "code": "export declare class InvalidUrlError extends OpenAgentClientError {\n constructor(url: string);\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 14, "sha256": "e51dbc1eb0aecc1e5490369315585cb00fe5ed8d0495a3f2f9a1a49d601598c9" } } ], "anchor": "invalidurlerror" }, { "name": "isChallengeFresh", "declarationName": "isChallengeFresh", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Optional sanity check on the challenge timestamp.\n\nReturns `true` if the timestamp parses as a date and is within\n`maxAgeMs` of `now`. Implementations SHOULD reject stale challenges\nbefore signing them (per spec §3.3 step 3).", "tags": [], "signatures": [ { "code": "export declare function isChallengeFresh(challenge: Challenge, options?: {\n now?: Date;\n maxAgeMs?: number;\n}): boolean;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/challenge.d.ts", "line": 51, "sha256": "233a346c5ea8f5e2ac3f7eb0422d92239980c82839939b3ad17f21fc26d67cbf" } } ], "anchor": "ischallengefresh" }, { "name": "KeyPair", "declarationName": "KeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 signing key. Holds 32 raw secret bytes plus the lazily-derived\npublic key.\n\nInstances are immutable. Callers SHOULD NOT log or serialize the secret\nkey — use {@link KeyPair.publicKeyBytes} for the safe public half.", "tags": [], "signatures": [ { "code": "export declare class KeyPair {\n static fromSecretBytes(secretKey: Uint8Array): KeyPair;\n static fromSecretBase64Url(secretBase64Url: string): KeyPair;\n static generate(): KeyPair;\n publicKeyBytes(): Uint8Array;\n publicKeyBase64Url(): string;\n toDidKey(): string;\n sign(message: Uint8Array): Uint8Array;\n exportSecretBytes(): Uint8Array;\n exportSecretBase64Url(): string;\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/keypair.d.ts", "line": 8, "sha256": "1432c65d99bb0de3515a9d61cef506baab6e9ab53b5061358652293513e9996a" } } ], "anchor": "keypair" }, { "name": "MalformedChallengeError", "declarationName": "MalformedChallengeError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The `WWW-Authenticate` header was present but could not be parsed as\nan OpenAgent challenge.", "tags": [], "signatures": [ { "code": "export declare class MalformedChallengeError extends OpenAgentClientError {\n constructor(reason: string);\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 29, "sha256": "e51dbc1eb0aecc1e5490369315585cb00fe5ed8d0495a3f2f9a1a49d601598c9" } } ], "anchor": "malformedchallengeerror" }, { "name": "NetworkError", "declarationName": "NetworkError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Network error during the underlying `fetch` call. The original error is\nexposed as `cause` for inspection.", "tags": [], "signatures": [ { "code": "export declare class NetworkError extends OpenAgentClientError {\n constructor(cause: unknown);\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 36, "sha256": "e51dbc1eb0aecc1e5490369315585cb00fe5ed8d0495a3f2f9a1a49d601598c9" } } ], "anchor": "networkerror" }, { "name": "NoChallengeHeaderError", "declarationName": "NoChallengeHeaderError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The server returned 401 but no `WWW-Authenticate` header was present.\n\nThis indicates a server bug or a non-OpenAgent server returning 401.", "tags": [], "signatures": [ { "code": "export declare class NoChallengeHeaderError extends OpenAgentClientError {\n constructor();\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 22, "sha256": "e51dbc1eb0aecc1e5490369315585cb00fe5ed8d0495a3f2f9a1a49d601598c9" } } ], "anchor": "nochallengeheadererror" }, { "name": "OpenAgentClient", "declarationName": "OpenAgentClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Client for the OpenAgent Core challenge-response protocol.\n\nThe client owns an Ed25519 {@link KeyPair} and a per-origin session cache.\nOn each {@link OpenAgentClient.fetch} call:\n\n 1. If a non-expired cached session token exists for the request origin,\n it is sent as `Authorization: Bearer `. If that returns 401,\n the cache is cleared and the client falls through to a challenge.\n\n 2. Otherwise the client sends the request unauthenticated. If the\n server replies 401 with a `WWW-Authenticate: OpenAgent` header,\n the client decodes the challenge, freshness-checks the timestamp\n and origin, JCS-canonicalizes it (RFC 8785), signs the canonical\n bytes with Ed25519, and re-sends the request with the proof in the\n `Authorization` header.\n\n 3. The new session token from `X-OpenAgent-Session` is cached for\n subsequent calls.", "tags": [], "signatures": [ { "code": "export declare class OpenAgentClient {\n constructor(keyPair: KeyPair, options?: OpenAgentClientOptions);\n getKeyPair(): KeyPair;\n getCachedSession(origin: string): string | undefined;\n clearSession(): void;\n fetch(url: string, options?: FetchOptions): Promise;\n logout(): void;\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/client.d.ts", "line": 44, "sha256": "720d80467026234f5616488617ca1080660515227c87903de5d0f293640ab19b" } } ], "anchor": "openagentclient" }, { "name": "OpenAgentClientError", "declarationName": "OpenAgentClientError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Base class for all OpenAgent client errors.\n\nAll thrown errors from `OpenAgentClient` are instances of this class —\ncallers may rely on `instanceof OpenAgentClientError` for control flow.", "tags": [], "signatures": [ { "code": "export declare class OpenAgentClientError extends Error {\n readonly code: string;\n constructor(code: string, message: string, options?: ErrorOptions);\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 7, "sha256": "e51dbc1eb0aecc1e5490369315585cb00fe5ed8d0495a3f2f9a1a49d601598c9" } } ], "anchor": "openagentclienterror" }, { "name": "OpenAgentClientOptions", "declarationName": "OpenAgentClientOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Optional configuration for the {@link OpenAgentClient}.", "tags": [], "signatures": [ { "code": "export interface OpenAgentClientOptions {\n fetch?: typeof fetch;\n now?: () => Date;\n maxChallengeAgeMs?: number;\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/client.d.ts", "line": 6, "sha256": "720d80467026234f5616488617ca1080660515227c87903de5d0f293640ab19b" } } ], "anchor": "openagentclientoptions" }, { "name": "parseWwwAuthenticate", "declarationName": "parseWwwAuthenticate", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parses an OpenAgent challenge from a `WWW-Authenticate` header value.", "tags": [ { "name": "param", "text": "headerValue The full header value, e.g.\n`OpenAgent challenge=\"eyJ0eXBlIjoi...\"`" }, { "name": "throws", "text": "{MalformedChallengeError} if the header is missing the\n`OpenAgent` scheme, the `challenge` parameter is not present, the\nparameter value is not valid base64url JSON, or the decoded JSON does\nnot match the {@link Challenge} schema." } ], "signatures": [ { "code": "export declare function parseWwwAuthenticate(headerValue: string): Challenge;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/challenge.d.ts", "line": 31, "sha256": "233a346c5ea8f5e2ac3f7eb0422d92239980c82839939b3ad17f21fc26d67cbf" } } ], "anchor": "parsewwwauthenticate" }, { "name": "validateChallenge", "declarationName": "validateChallenge", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates a parsed JSON object against the {@link Challenge} schema and\nreturns it as a typed value.", "tags": [], "signatures": [ { "code": "export declare function validateChallenge(value: unknown): Challenge;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/challenge.d.ts", "line": 36, "sha256": "233a346c5ea8f5e2ac3f7eb0422d92239980c82839939b3ad17f21fc26d67cbf" } } ], "anchor": "validatechallenge" } ], "supportingDeclarations": [ { "name": "decode", "declarationName": "decode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a base64url (or base64) string to a Uint8Array.\n\nThrows if the input contains characters outside the alphabet.", "tags": [], "signatures": [ { "code": "export declare function decode(input: string): Uint8Array;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/base64url.d.ts", "line": 10, "sha256": "c5f48ab731d8e91bfee1d513b8a24df8cd1faf9bbd1b3973229c2d1ecaa58a7c" } } ], "anchor": "decode" }, { "name": "decode", "declarationName": "decode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a hex string into bytes. Accepts both upper and lowercase.\n\nThrows on odd length or non-hex characters.", "tags": [], "signatures": [ { "code": "export declare function decode(input: string): Uint8Array;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/hex.d.ts", "line": 10, "sha256": "facf33a3381e41f9e1815d0793cb1c4599f99874539d9de413020fe6b5589663" } } ], "anchor": "decode-1" }, { "name": "decodeString", "declarationName": "decodeString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a base64url string to a UTF-8 string.", "tags": [], "signatures": [ { "code": "export declare function decodeString(input: string): string;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/base64url.d.ts", "line": 18, "sha256": "c5f48ab731d8e91bfee1d513b8a24df8cd1faf9bbd1b3973229c2d1ecaa58a7c" } } ], "anchor": "decodestring" }, { "name": "encode", "declarationName": "encode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes a Uint8Array to a base64url string (no padding).", "tags": [], "signatures": [ { "code": "export declare function encode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/base64url.d.ts", "line": 4, "sha256": "c5f48ab731d8e91bfee1d513b8a24df8cd1faf9bbd1b3973229c2d1ecaa58a7c" } } ], "anchor": "encode" }, { "name": "encode", "declarationName": "encode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as a lowercase hex string.", "tags": [], "signatures": [ { "code": "export declare function encode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/hex.d.ts", "line": 4, "sha256": "facf33a3381e41f9e1815d0793cb1c4599f99874539d9de413020fe6b5589663" } } ], "anchor": "encode-1" }, { "name": "encodeString", "declarationName": "encodeString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes a UTF-8 string to base64url.", "tags": [], "signatures": [ { "code": "export declare function encodeString(input: string): string;", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/base64url.d.ts", "line": 14, "sha256": "c5f48ab731d8e91bfee1d513b8a24df8cd1faf9bbd1b3973229c2d1ecaa58a7c" } } ], "anchor": "encodestring" }, { "name": "LineageAuthorityContext", "declarationName": "LineageAuthorityContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "OAS/Sigil-backed privileged lineage authority attached by OpenAgentID.", "tags": [], "signatures": [ { "code": "export interface LineageAuthorityContext {\n subject: string;\n root: string;\n path_kind: string;\n source: string;\n path: string[];\n finalized_block: number;\n scopes: string[];\n generation: number;\n root_kind?: string;\n org_root_commitment?: string;\n expires_at?: string;\n}", "source": { "package": "@openagentid/client", "version": "0.1.1", "file": "dist/types.d.ts", "line": 44, "sha256": "0d1b26823ad5466af127377c914015255eb84e40a5b098ff31b7a91d36bf6269" } } ], "anchor": "lineageauthoritycontext" } ], "coverage": { "discovered": 22, "documented": 22, "missing": [] } } ] }, { "name": "@openagentid/crypto-wasm", "version": "0.1.1", "status": "published", "notes": [ "ACT verification requires trusted receiver current epoch seconds on every call. Pass BigInt(Math.floor(Date.now() / 1000)) as the positional seventh act_verify argument (now_unix_seconds), or use the SDK verifier builder .atTime(Math.floor(Date.now() / 1000)). Passing 0n invokes the default WASM system-clock path, which traps in Node. Never use token-supplied time or a timestamp captured once at startup. The complete ACT example covers this requirement." ], "tarball": "https://registry.npmjs.org/@openagentid/crypto-wasm/-/crypto-wasm-0.1.1.tgz", "integrity": "sha512-pfFVfABbYwfqneeB7EXhd9yPBqguDT2Qt8I67bmbpklsydg0Zb3x4uXU6O70IrjKCT+Jc2P/EC59NKDRZH8ifw==", "packageJsonSha256": "9c804c0cebbbdf81a73a8eb86450123f1935ae0d48800a9c4be560bac73b93cb", "page": "/reference/typescript/crypto-wasm", "engines": {}, "dependencies": {}, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/crypto-wasm", "page": "/reference/typescript/crypto-wasm", "kind": "declarations", "conditions": { "types": "./openagent_crypto_wasm.d.ts", "node": "./node/openagent_crypto_wasm.js", "default": "./openagent_crypto_wasm.js" }, "paths": [ { "conditions": [ "types" ], "path": "./openagent_crypto_wasm.d.ts" }, { "conditions": [ "node" ], "path": "./node/openagent_crypto_wasm.js" }, { "conditions": [ "default" ], "path": "./openagent_crypto_wasm.js" } ], "exports": [ { "name": "act_decode_unverified", "declarationName": "act_decode_unverified", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes an ACT envelope's claims WITHOUT verifying the signature, for\ndiagnostics and tooling. The returned string is prefixed so callers cannot\naccidentally treat the contents as verified.\n\nNever use this for authorization: unverified claims are attacker\ncontrolled. Authorization decisions go through [`act_verify`].", "tags": [], "signatures": [ { "code": "export function act_decode_unverified(token_bytes: Uint8Array): string;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 47, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "act_decode_unverified" }, { "name": "act_verify", "declarationName": "act_verify", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies an ACT envelope against the trusted key set and policy, and\nreturns the claims as a JSON string.\n\nThis is the full normative procedure from `agent-capability-token`, not a\nre-implementation: envelope decode, version/algorithm checks, Ed25519\nsignature verification (checked **before** any claim, so an attacker\ncannot plant unauthenticated claim content), temporal checks with leeway,\nand issuer/audience/scope policy.\n\nArguments:\n- `token_bytes`: the ACT envelope bytes (CBOR).\n- `trusted_keys`: concatenated raw 32-byte Ed25519 public keys (exactly 32\n bytes each, any count > 0). Keys are tried in order; `kid` is a hint for\n audit, never authoritative for selection.\n- `expected_issuer` / `expected_audience`: the policy bindings. Both are\n required, deliberately: a verifier that does not bind the token's\n intended audience accepts tokens meant for someone else.\n- `required_scopes`: each entry a `service:resource:action` scope string\n the token must grant; wildcards in the GRANT expand, in the REQUEST are\n literal.\n- `leeway_seconds`: symmetric clock-skew allowance on temporal checks.\n- `now_unix_seconds`: 0 for the system clock, or a pinned time for tests\n and for replaying a decision at a known instant.\n\nErrors (thrown on the JS side) are the canonical `ActError` reasons, so a\nforged token reports distinctly from an expired one and an unimplemented\nformat version distinctly from both.", "tags": [], "signatures": [ { "code": "export function act_verify(token_bytes: Uint8Array, trusted_keys: Uint8Array, expected_issuer: string, expected_audience: string, required_scopes: string[], leeway_seconds: bigint, now_unix_seconds: bigint): string;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 78, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "act_verify" }, { "name": "aes256gcm_decrypt", "declarationName": "aes256gcm_decrypt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "AES-256-GCM decryption.", "tags": [], "signatures": [ { "code": "export function aes256gcm_decrypt(key: Uint8Array, nonce: Uint8Array, ciphertext: Uint8Array, aad: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 83, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "aes256gcm_decrypt" }, { "name": "aes256gcm_encrypt", "declarationName": "aes256gcm_encrypt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "AES-256-GCM encryption. Returns `ciphertext || tag`.", "tags": [], "signatures": [ { "code": "export function aes256gcm_encrypt(key: Uint8Array, nonce: Uint8Array, plaintext: Uint8Array, aad: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 88, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "aes256gcm_encrypt" }, { "name": "argon2id_hash_password", "declarationName": "argon2id_hash_password", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Hashes `password` with Argon2id, returning a PHC-format string.", "tags": [], "signatures": [ { "code": "export function argon2id_hash_password(password: Uint8Array): string;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 93, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "argon2id_hash_password" }, { "name": "argon2id_verify_password", "declarationName": "argon2id_verify_password", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a password against a PHC-format Argon2id hash.", "tags": [], "signatures": [ { "code": "export function argon2id_verify_password(password: Uint8Array, encoded_hash: string): boolean;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 98, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "argon2id_verify_password" }, { "name": "blake3_derive_key", "declarationName": "blake3_derive_key", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "BLAKE3 KDF mode: `derive_key(context, key_material)`.", "tags": [], "signatures": [ { "code": "export function blake3_derive_key(context: string, key_material: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 103, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "blake3_derive_key" }, { "name": "blake3_hash_bytes", "declarationName": "blake3_hash_bytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "BLAKE3 hash of `data`.", "tags": [], "signatures": [ { "code": "export function blake3_hash_bytes(data: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 108, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "blake3_hash_bytes" }, { "name": "blake3_keyed_hash", "declarationName": "blake3_keyed_hash", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "BLAKE3 keyed hash.", "tags": [], "signatures": [ { "code": "export function blake3_keyed_hash(key: Uint8Array, data: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 113, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "blake3_keyed_hash" }, { "name": "ct_eq", "declarationName": "ct_eq", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Constant-time byte equality. Returns `false` for slices of differing length.", "tags": [], "signatures": [ { "code": "export function ct_eq(a: Uint8Array, b: Uint8Array): boolean;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 118, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "ct_eq" }, { "name": "ed25519_generate_keypair", "declarationName": "ed25519_generate_keypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generates a fresh Ed25519 keypair using the host CSPRNG.", "tags": [], "signatures": [ { "code": "export function ed25519_generate_keypair(): WasmKeypair;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 123, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "ed25519_generate_keypair" }, { "name": "ed25519_public_from_private", "declarationName": "ed25519_public_from_private", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives the Ed25519 verifying key from a signing key.", "tags": [], "signatures": [ { "code": "export function ed25519_public_from_private(signing_key: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 128, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "ed25519_public_from_private" }, { "name": "ed25519_sign", "declarationName": "ed25519_sign", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Signs `message` with the supplied 32-byte Ed25519 signing key.", "tags": [], "signatures": [ { "code": "export function ed25519_sign(signing_key: Uint8Array, message: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 133, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "ed25519_sign" }, { "name": "ed25519_verify", "declarationName": "ed25519_verify", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies an Ed25519 signature. Throws if verification fails.", "tags": [], "signatures": [ { "code": "export function ed25519_verify(verifying_key: Uint8Array, message: Uint8Array, signature: Uint8Array): void;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 138, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "ed25519_verify" }, { "name": "frost_aggregate", "declarationName": "frost_aggregate", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "FROST aggregation: combine signature shares into a 64-byte Ed25519 signature.", "tags": [], "signatures": [ { "code": "export function frost_aggregate(message: Uint8Array, commitments_json: string, shares_json: string, serialized_public_key_package: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 143, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "frost_aggregate" }, { "name": "frost_sign_round1", "declarationName": "frost_sign_round1", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "FROST round 1 for a single participant. Returns JSON of [`Round1Output`](crate::frost::Round1Output).", "tags": [], "signatures": [ { "code": "export function frost_sign_round1(serialized_key_package: Uint8Array): string;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 148, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "frost_sign_round1" }, { "name": "frost_sign_round2", "declarationName": "frost_sign_round2", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "FROST round 2 for a single participant.\n\n`commitments_json` is a JSON array of\n[`ParticipantCommitments`](crate::frost::ParticipantCommitments).", "tags": [], "signatures": [ { "code": "export function frost_sign_round2(serialized_key_package: Uint8Array, serialized_nonces: Uint8Array, message: Uint8Array, commitments_json: string): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 156, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "frost_sign_round2" }, { "name": "frost_trusted_keygen", "declarationName": "frost_trusted_keygen", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generates a t-of-n FROST key share bundle (trusted dealer).\n\nReturns a JSON string of [`KeyShareBundle`](crate::frost::KeyShareBundle).", "tags": [], "signatures": [ { "code": "export function frost_trusted_keygen(min_signers: number, max_signers: number): string;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 163, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "frost_trusted_keygen" }, { "name": "frost_verify", "declarationName": "frost_verify", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a FROST signature. Throws on failure.", "tags": [], "signatures": [ { "code": "export function frost_verify(message: Uint8Array, signature: Uint8Array, group_public_key: Uint8Array): void;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 168, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "frost_verify" }, { "name": "hkdf_sha256_derive", "declarationName": "hkdf_sha256_derive", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Combined extract + expand HKDF-SHA256 derivation.", "tags": [], "signatures": [ { "code": "export function hkdf_sha256_derive(salt: Uint8Array, ikm: Uint8Array, info: Uint8Array, length: number): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 173, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "hkdf_sha256_derive" }, { "name": "hkdf_sha256_expand", "declarationName": "hkdf_sha256_expand", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "`HKDF-Expand(PRK, info, length)`.", "tags": [], "signatures": [ { "code": "export function hkdf_sha256_expand(prk: Uint8Array, info: Uint8Array, length: number): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 178, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "hkdf_sha256_expand" }, { "name": "hkdf_sha256_extract", "declarationName": "hkdf_sha256_extract", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "`HKDF-Extract(salt, IKM)` — returns the 32-byte PRK.", "tags": [], "signatures": [ { "code": "export function hkdf_sha256_extract(salt: Uint8Array, ikm: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 183, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "hkdf_sha256_extract" }, { "name": "jcs_canonicalize", "declarationName": "jcs_canonicalize", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "JCS canonicalization (RFC 8785) of a JSON string.", "tags": [], "signatures": [ { "code": "export function jcs_canonicalize(json: string): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 188, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "jcs_canonicalize" }, { "name": "multibase_base58btc_decode", "declarationName": "multibase_base58btc_decode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Multibase base58btc decode.", "tags": [], "signatures": [ { "code": "export function multibase_base58btc_decode(input: string): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 193, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "multibase_base58btc_decode" }, { "name": "multibase_base58btc_encode", "declarationName": "multibase_base58btc_encode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Multibase base58btc encode.", "tags": [], "signatures": [ { "code": "export function multibase_base58btc_encode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 198, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "multibase_base58btc_encode" }, { "name": "random_bytes", "declarationName": "random_bytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `n` cryptographically random bytes.", "tags": [], "signatures": [ { "code": "export function random_bytes(n: number): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 203, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "random_bytes" }, { "name": "sha256", "declarationName": "sha256", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "SHA-256 hash of `data`.", "tags": [], "signatures": [ { "code": "export function sha256(data: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 208, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "sha256" }, { "name": "sha512", "declarationName": "sha512", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "SHA-512 hash of `data`.", "tags": [], "signatures": [ { "code": "export function sha512(data: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 213, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "sha512" }, { "name": "version", "declarationName": "version", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the crate version string.", "tags": [], "signatures": [ { "code": "export function version(): string;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 218, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "version" }, { "name": "WasmKeypair", "declarationName": "WasmKeypair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "JS-friendly Ed25519 keypair: `{ signing_key, verifying_key }` as\n`Uint8Array` byte arrays. Returned by [`ed25519_generate_keypair`].", "tags": [], "signatures": [ { "code": "export class WasmKeypair {\n free(): void;\n [Symbol.dispose](): void;\n readonly signing_key: Uint8Array;\n readonly verifying_key: Uint8Array;\n}", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 8, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "wasmkeypair" }, { "name": "WasmX25519Keypair", "declarationName": "WasmX25519Keypair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "JS-friendly X25519 keypair: `{ secret_key, public_key }`.", "tags": [], "signatures": [ { "code": "export class WasmX25519Keypair {\n free(): void;\n [Symbol.dispose](): void;\n readonly public_key: Uint8Array;\n readonly secret_key: Uint8Array;\n}", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 25, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "wasmx25519keypair" }, { "name": "x25519_diffie_hellman", "declarationName": "x25519_diffie_hellman", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes the X25519 raw shared secret. Callers MUST run this through HKDF\nbefore using it as keying material.", "tags": [], "signatures": [ { "code": "export function x25519_diffie_hellman(secret_key: Uint8Array, peer_public_key: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 224, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "x25519_diffie_hellman" }, { "name": "x25519_generate_keypair", "declarationName": "x25519_generate_keypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generates a fresh X25519 keypair using the host CSPRNG.", "tags": [], "signatures": [ { "code": "export function x25519_generate_keypair(): WasmX25519Keypair;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 229, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "x25519_generate_keypair" }, { "name": "xchacha20poly1305_decrypt", "declarationName": "xchacha20poly1305_decrypt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "XChaCha20-Poly1305 decryption.", "tags": [], "signatures": [ { "code": "export function xchacha20poly1305_decrypt(key: Uint8Array, nonce: Uint8Array, ciphertext: Uint8Array, aad: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 234, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "xchacha20poly1305_decrypt" }, { "name": "xchacha20poly1305_encrypt", "declarationName": "xchacha20poly1305_encrypt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "XChaCha20-Poly1305 encryption.", "tags": [], "signatures": [ { "code": "export function xchacha20poly1305_encrypt(key: Uint8Array, nonce: Uint8Array, plaintext: Uint8Array, aad: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/crypto-wasm", "version": "0.1.1", "file": "openagent_crypto_wasm.d.ts", "line": 239, "sha256": "aa41fecbfb9f1144cbf7f8a2fa4fc10be8ba952c3dd8fceb00100de30ddf173c" } } ], "anchor": "xchacha20poly1305_encrypt" } ], "supportingDeclarations": [], "coverage": { "discovered": 35, "documented": 35, "missing": [] } }, { "subpath": "./package.json", "importSpecifier": "@openagentid/crypto-wasm/package.json", "page": "/reference/typescript/crypto-wasm/package.json", "kind": "resource", "conditions": "./package.json", "paths": [ { "conditions": [], "path": "./package.json" } ], "exports": [], "supportingDeclarations": [], "coverage": { "discovered": 0, "documented": 0, "missing": [] } } ] }, { "name": "@openagentid/http", "version": "0.1.1", "status": "limited", "notes": [ "Declares an optional peer on @openagentid/auth-protocol ^0.1.0; the registry returns 404 for that peer package.", "Published adapter has not qualified for the current production path. Use current SDK identity verification and explicit receiver policy." ], "tarball": "https://registry.npmjs.org/@openagentid/http/-/http-0.1.1.tgz", "integrity": "sha512-Ecd1WkgKIlAusRSIeeyRuTXIMUka8QwTiWh8JRoxwA5i2MrT4xuza1kNXe4w+O0PTWMousqpc/Val2cNXKoNQQ==", "packageJsonSha256": "2f71b41103387d8e95965a28cdae7fc0f25b0986084ed792eed72a716004d1b3", "page": "/reference/typescript/http", "engines": { "node": ">=20" }, "dependencies": { "zod": "^3.23.8" }, "peerDependencies": { "@openagentid/auth-protocol": "^0.1.0" }, "peerDependenciesMeta": { "@openagentid/auth-protocol": { "optional": true } }, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/http", "page": "/reference/typescript/http", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" }, { "conditions": [ "require" ], "path": "./dist/index.cjs" } ], "exports": [ { "name": "AUTH_ENDPOINT_PATH", "declarationName": "AUTH_ENDPOINT_PATH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default auth endpoint path.", "tags": [], "signatures": [ { "code": "declare const AUTH_ENDPOINT_PATH = \"/.well-known/openagent/auth\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 40, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "auth_endpoint_path" }, { "name": "AuthenticatedSession", "declarationName": "AuthenticatedSession", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An authenticated HTTP session obtained after a successful Core Protocol identity flow.", "tags": [], "signatures": [ { "code": "declare class AuthenticatedSession {\n constructor(params: {\n baseUrl: string;\n sessionId: string;\n peerDid: string;\n sessionToken: string;\n expiresAt: number;\n });\n isExpired(): boolean;\n getSessionId(): string;\n getPeerDid(): string;\n getBaseUrl(): string;\n fetch(path: string, init?: RequestInit): Promise;\n get(path: string): Promise;\n post(path: string, body: unknown): Promise;\n put(path: string, body: unknown): Promise;\n delete(path: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/session.d.ts", "line": 8, "sha256": "09b06ba18f43ab58494d0e744db785e83ae581e634f0d0bd16716762a9be6462" } } ], "anchor": "authenticatedsession" }, { "name": "authenticateRequest", "declarationName": "authenticateRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Authenticate an incoming request by checking the session token.", "tags": [], "signatures": [ { "code": "declare function authenticateRequest(request: Request, store: SessionStore): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 117, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "authenticaterequest" }, { "name": "AuthResult", "declarationName": "AuthResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of authenticating an incoming request.", "tags": [], "signatures": [ { "code": "interface AuthResult {\n authenticated: boolean;\n peerDid?: string;\n sessionToken?: string;\n error?: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 110, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "authresult" }, { "name": "buildOpenAgentHeader", "declarationName": "buildOpenAgentHeader", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build an `Authorization: OpenAgent ` header value.", "tags": [], "signatures": [ { "code": "declare function buildOpenAgentHeader(token: string): string;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/headers.d.ts", "line": 19, "sha256": "a51e670b02a35915f3dfb2b966ec60bc6064acf130350b6a06f96125c5cc2571" } } ], "anchor": "buildopenagentheader" }, { "name": "canonicalChallengeBytes", "declarationName": "canonicalChallengeBytes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "The JCS-canonical (RFC 8785) UTF-8 bytes of a challenge object.\n\nScoped to the challenge shape: a flat object whose values are strings (or\nabsent). JCS for that shape is lexicographic key order, no whitespace, and\nJSON string escaping — which is exactly what this produces. Do not reuse\nfor nested or numeric payloads; pull in a full JCS implementation there.", "tags": [], "signatures": [ { "code": "declare function canonicalChallengeBytes(challenge: IdentityChallenge): Uint8Array;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 96, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "canonicalchallengebytes" }, { "name": "CHALLENGE_TYPE", "declarationName": "CHALLENGE_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The literal `type` value of an identity challenge (Section 15.2).", "tags": [], "signatures": [ { "code": "declare const CHALLENGE_TYPE = \"openagent-challenge-v1\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 12, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "challenge_type" }, { "name": "ClientConfig", "declarationName": "ClientConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Client configuration.", "tags": [], "signatures": [ { "code": "interface ClientConfig {\n did: string;\n keyType?: KeyType;\n timeoutMs?: number;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/client.d.ts", "line": 13, "sha256": "40cdd794feaf42a2acd1b9c31043e39958cbfeac249dcdcb4aa9e16453720922" } } ], "anchor": "clientconfig" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Conformance level enum values.", "tags": [], "signatures": [ { "code": "type ConformanceLevel = 'L0' | 'L1' | 'L2';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 12, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "conformancelevel" }, { "name": "CONTENT_TYPE_JSON", "declarationName": "CONTENT_TYPE_JSON", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Content-Type for all Core Protocol JSON payloads.", "tags": [], "signatures": [ { "code": "declare const CONTENT_TYPE_JSON = \"application/json\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/headers.d.ts", "line": 11, "sha256": "a51e670b02a35915f3dfb2b966ec60bc6064acf130350b6a06f96125c5cc2571" } } ], "anchor": "content_type_json" }, { "name": "CoreAuthError", "declarationName": "CoreAuthError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error returned by server handlers, carrying the HTTP status to render.", "tags": [], "signatures": [ { "code": "declare class CoreAuthError extends Error {\n readonly statusCode: number;\n constructor(message: string, statusCode: number);\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 70, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "coreautherror" }, { "name": "createOpenAgentHandler", "declarationName": "createOpenAgentHandler", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a generic OAAP middleware using the standard fetch Request/Response API.\n\nReturns a function that:\n- Handles OAAP well-known endpoints\n- Validates authenticated requests\n- Returns `undefined` for well-known routes (caller should send the JSON response)\n\nWorks with Hono, Cloudflare Workers, Deno, Bun, and any fetch-based framework.", "tags": [], "signatures": [ { "code": "declare function createOpenAgentHandler(options: MiddlewareOptions): {\n config: ServerConfig;\n store: SessionStore;\n handle: (request: Request) => Promise;\n};", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/middleware.d.ts", "line": 40, "sha256": "9fc1a86d4ab4ca87c55bd74e4db87d16473f304ce9509f744d784fa7a65ff11f" } } ], "anchor": "createopenagenthandler" }, { "name": "createOpenAgentMiddleware", "declarationName": "createOpenAgentMiddleware", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create Express-compatible middleware.\n\nUsage:\n```ts\napp.use(createOpenAgentMiddleware({\n serverDid: 'did:oas:l1fe:service:api',\n verifySignature: async (did, payload, sig) => { ... },\n}));\n```", "tags": [], "signatures": [ { "code": "declare function createOpenAgentMiddleware(options: MiddlewareOptions): (req: {\n url?: string;\n method?: string;\n headers: Record;\n path?: string;\n}, res: {\n status: (code: number) => {\n json: (body: unknown) => void;\n end: () => void;\n };\n}, next: () => void) => Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/middleware.d.ts", "line": 62, "sha256": "9fc1a86d4ab4ca87c55bd74e4db87d16473f304ce9509f744d784fa7a65ff11f" } } ], "anchor": "createopenagentmiddleware" }, { "name": "createServerConfig", "declarationName": "createServerConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a server config with sensible defaults.", "tags": [], "signatures": [ { "code": "declare function createServerConfig(origin: string, overrides?: Partial): Required> & ServerConfig;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 40, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "createserverconfig" }, { "name": "DEFAULT_CHALLENGE_TTL_SECS", "declarationName": "DEFAULT_CHALLENGE_TTL_SECS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default challenge TTL in seconds (Section 7: default 30s, max 300s).", "tags": [], "signatures": [ { "code": "declare const DEFAULT_CHALLENGE_TTL_SECS = 60;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 23, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "default_challenge_ttl_secs" }, { "name": "DEFAULT_SESSION_TTL_SECS", "declarationName": "DEFAULT_SESSION_TTL_SECS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default session TTL in seconds.", "tags": [], "signatures": [ { "code": "declare const DEFAULT_SESSION_TTL_SECS = 300;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 21, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "default_session_ttl_secs" }, { "name": "DiscoveryDocument", "declarationName": "DiscoveryDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Discovery document returned by the server.", "tags": [], "signatures": [ { "code": "interface DiscoveryDocument {\n auth_endpoint: string;\n supported_versions: number[];\n server_did: string;\n required_conformance_level: ConformanceLevel;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 14, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "discoverydocument" }, { "name": "discoveryDocumentSchema", "declarationName": "discoveryDocumentSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Zod schema for DiscoveryDocument.", "tags": [], "signatures": [ { "code": "declare const discoveryDocumentSchema: z.ZodObject<{\n auth_endpoint: z.ZodString;\n supported_versions: z.ZodArray;\n server_did: z.ZodString;\n required_conformance_level: z.ZodEnum<[\n \"L0\",\n \"L1\",\n \"L2\"\n ]>;\n}, \"strip\", z.ZodTypeAny, {\n auth_endpoint: string;\n supported_versions: number[];\n server_did: string;\n required_conformance_level: \"L0\" | \"L1\" | \"L2\";\n}, {\n auth_endpoint: string;\n supported_versions: number[];\n server_did: string;\n required_conformance_level: \"L0\" | \"L1\" | \"L2\";\n}>;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 21, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "discoverydocumentschema" }, { "name": "extractOpenAgentToken", "declarationName": "extractOpenAgentToken", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extract the session token from an `Authorization: OpenAgent `\nheader. Returns `undefined` if the header is missing, malformed, or uses a\ndifferent scheme.", "tags": [], "signatures": [ { "code": "declare function extractOpenAgentToken(authorization: string): string | undefined;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/headers.d.ts", "line": 17, "sha256": "a51e670b02a35915f3dfb2b966ec60bc6064acf130350b6a06f96125c5cc2571" } } ], "anchor": "extractopenagenttoken" }, { "name": "fetchDiscovery", "declarationName": "fetchDiscovery", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Fetch the discovery document from a server.", "tags": [ { "name": "param", "text": "baseUrl - Server base URL (e.g. `https://api.example.com`)" }, { "name": "param", "text": "timeoutMs - Request timeout (default: 10000)" } ], "signatures": [ { "code": "declare function fetchDiscovery(baseUrl: string, timeoutMs?: number): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 49, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "fetchdiscovery" }, { "name": "handleChallenge", "declarationName": "handleChallenge", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Handle the challenge step - issue an IdentityChallenge.\n\nRecords a pending session keyed by the nonce: the proof carries exactly\nthat correlation, and single-use-ness is enforced by removal.", "tags": [], "signatures": [ { "code": "declare function handleChallenge(config: ServerConfig & {\n requiredConformance?: ConformanceLevel;\n}, store: SessionStore): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 84, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "handlechallenge" }, { "name": "handleDiscovery", "declarationName": "handleDiscovery", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Handle `GET /.well-known/openagent` - returns the discovery document.", "tags": [], "signatures": [ { "code": "declare function handleDiscovery(config: ServerConfig & {\n requiredConformance?: ConformanceLevel;\n}): DiscoveryDocument;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 75, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "handlediscovery" }, { "name": "handleProve", "declarationName": "handleProve", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Handle the prove step - verify an IdentityProof and issue a session.\n\nVerification is normative-ordered: pending challenge first (present,\nunexpired), then shape checks (nonce echo), then the signature over the\nJCS-canonical challenge bytes. The nonce is consumed on success *and* on\nfailure - a failed answer must not be retryable, or a verifier becomes an\noracle.", "tags": [], "signatures": [ { "code": "declare function handleProve(config: ServerConfig & {\n requiredConformance?: ConformanceLevel;\n}, store: SessionStore, body: unknown, verifySignature: VerifySignatureFn): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 106, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "handleprove" }, { "name": "HEADER_OPENAGENT_DID", "declarationName": "HEADER_OPENAGENT_DID", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Header carrying the authenticated agent's DID.", "tags": [], "signatures": [ { "code": "declare const HEADER_OPENAGENT_DID = \"x-openagent-did\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/headers.d.ts", "line": 7, "sha256": "a51e670b02a35915f3dfb2b966ec60bc6064acf130350b6a06f96125c5cc2571" } } ], "anchor": "header_openagent_did" }, { "name": "HEADER_OPENAGENT_SESSION", "declarationName": "HEADER_OPENAGENT_SESSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Header carrying the session token (alternative to Authorization).", "tags": [], "signatures": [ { "code": "declare const HEADER_OPENAGENT_SESSION = \"x-openagent-session\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/headers.d.ts", "line": 9, "sha256": "a51e670b02a35915f3dfb2b966ec60bc6064acf130350b6a06f96125c5cc2571" } } ], "anchor": "header_openagent_session" }, { "name": "HttpAuthClient", "declarationName": "HttpAuthClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "HTTP client that performs the Core Protocol identity flow.\n\nUsage:\n```ts\nconst client = new HttpAuthClient({\n config: { did: 'did:oas:l1fe:agent:my-bot' },\n sign: async (payload) => base64url(ed25519Sign(privateKey, payload)),\n publicKey: async () => base64url(ed25519PublicKey(privateKey)),\n});\nconst session = await client.authenticate('https://api.example.com');\nconst resp = await session.get('/api/tools');\n```", "tags": [], "signatures": [ { "code": "declare class HttpAuthClient {\n constructor(params: {\n config: ClientConfig;\n sign: SignFn;\n publicKey: () => Promise;\n transport?: HttpTransport;\n });\n authenticate(baseUrl: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/client.d.ts", "line": 47, "sha256": "40cdd794feaf42a2acd1b9c31043e39958cbfeac249dcdcb4aa9e16453720922" } } ], "anchor": "httpauthclient" }, { "name": "HttpTransport", "declarationName": "HttpTransport", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "HTTP transport carrying the identity flow over REST.", "tags": [], "signatures": [ { "code": "declare class HttpTransport {\n constructor(config?: HttpTransportConfig);\n fetchChallenge(endpoint: string): Promise;\n prove(endpoint: string, proof: IdentityProof): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 111, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "httptransport" }, { "name": "HttpTransportConfig", "declarationName": "HttpTransportConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for the HTTP transport.", "tags": [], "signatures": [ { "code": "interface HttpTransportConfig {\n timeoutMs?: number;\n headers?: Record;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 104, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "httptransportconfig" }, { "name": "IdentityChallenge", "declarationName": "IdentityChallenge", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server → Agent: a cryptographic challenge (Section 15.2).", "tags": [], "signatures": [ { "code": "interface IdentityChallenge {\n type: string;\n nonce: string;\n timestamp: string;\n origin: string;\n realm?: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 14, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identitychallenge" }, { "name": "identityChallengeSchema", "declarationName": "identityChallengeSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Zod schema for challenge validation (agents MUST validate before signing).", "tags": [], "signatures": [ { "code": "declare const identityChallengeSchema: z.ZodObject<{\n type: z.ZodLiteral<\"openagent-challenge-v1\">;\n nonce: z.ZodString;\n timestamp: z.ZodString;\n origin: z.ZodString;\n realm: z.ZodOptional;\n}, \"strict\", z.ZodTypeAny, {\n origin: string;\n type: \"openagent-challenge-v1\";\n nonce: string;\n timestamp: string;\n realm?: string | undefined;\n}, {\n origin: string;\n type: \"openagent-challenge-v1\";\n nonce: string;\n timestamp: string;\n realm?: string | undefined;\n}>;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 49, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identitychallengeschema" }, { "name": "IdentityProof", "declarationName": "IdentityProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Agent → Server: the cryptographic proof of identity (Section 15.3).", "tags": [], "signatures": [ { "code": "interface IdentityProof {\n signature: string;\n public_key: string;\n key_type: KeyType;\n nonce: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 28, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identityproof" }, { "name": "IdentityVerified", "declarationName": "IdentityVerified", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server → Agent: identity confirmed; session issued (Section 15.4).", "tags": [], "signatures": [ { "code": "interface IdentityVerified {\n did: string;\n trust_tier: TrustTier;\n session_token: string;\n session_expires: string;\n capabilities?: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 40, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identityverified" }, { "name": "identityVerifiedSchema", "declarationName": "identityVerifiedSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Zod schema for the verified session message.", "tags": [], "signatures": [ { "code": "declare const identityVerifiedSchema: z.ZodObject<{\n did: z.ZodString;\n trust_tier: z.ZodEnum<[\n \"anonymous\",\n \"identified\",\n \"sovereign\"\n ]>;\n session_token: z.ZodString;\n session_expires: z.ZodString;\n capabilities: z.ZodOptional>;\n}, \"strip\", z.ZodTypeAny, {\n did: string;\n trust_tier: \"anonymous\" | \"identified\" | \"sovereign\";\n session_token: string;\n session_expires: string;\n capabilities?: string[] | undefined;\n}, {\n did: string;\n trust_tier: \"anonymous\" | \"identified\" | \"sovereign\";\n session_token: string;\n session_expires: string;\n capabilities?: string[] | undefined;\n}>;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 69, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identityverifiedschema" }, { "name": "InMemorySessionStore", "declarationName": "InMemorySessionStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory session store for development and testing.", "tags": [], "signatures": [ { "code": "declare class InMemorySessionStore implements SessionStore {\n put(session: StoredSession): Promise;\n get(sessionId: string): Promise;\n remove(sessionId: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 63, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "inmemorysessionstore" }, { "name": "KeyType", "declarationName": "KeyType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Signature scheme for a proof (Section 15.3).", "tags": [], "signatures": [ { "code": "type KeyType = 'ed25519' | 'secp256k1';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 26, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "keytype" }, { "name": "MiddlewareOptions", "declarationName": "MiddlewareOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for creating OAAP middleware.", "tags": [], "signatures": [ { "code": "interface MiddlewareOptions {\n serverDid: string;\n store?: SessionStore;\n requiredConformance?: 'L0' | 'L1' | 'L2';\n sessionTtlSecs?: number;\n challengeTtlSecs?: number;\n verifySignature: VerifySignatureFn;\n excludePaths?: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/middleware.d.ts", "line": 14, "sha256": "9fc1a86d4ab4ca87c55bd74e4db87d16473f304ce9509f744d784fa7a65ff11f" } } ], "anchor": "middlewareoptions" }, { "name": "OPENAGENT_AUTH_SCHEME", "declarationName": "OPENAGENT_AUTH_SCHEME", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The canonical authorization scheme for OpenAgent-authenticated requests.", "tags": [], "signatures": [ { "code": "declare const OPENAGENT_AUTH_SCHEME = \"OpenAgent\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/headers.d.ts", "line": 5, "sha256": "a51e670b02a35915f3dfb2b966ec60bc6064acf130350b6a06f96125c5cc2571" } } ], "anchor": "openagent_auth_scheme" }, { "name": "PROVE_ENDPOINT_PATH", "declarationName": "PROVE_ENDPOINT_PATH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default prove endpoint path.", "tags": [], "signatures": [ { "code": "declare const PROVE_ENDPOINT_PATH = \"/.well-known/openagent/auth/prove\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 42, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "prove_endpoint_path" }, { "name": "resolveAuthEndpoint", "declarationName": "resolveAuthEndpoint", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve the full auth endpoint URL from a base URL and discovery document.", "tags": [], "signatures": [ { "code": "declare function resolveAuthEndpoint(baseUrl: string, doc: DiscoveryDocument): string;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 51, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "resolveauthendpoint" }, { "name": "resolveProveEndpoint", "declarationName": "resolveProveEndpoint", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve the prove endpoint URL (auth endpoint + `/prove`).", "tags": [], "signatures": [ { "code": "declare function resolveProveEndpoint(baseUrl: string, doc: DiscoveryDocument): string;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 53, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "resolveproveendpoint" }, { "name": "ServerConfig", "declarationName": "ServerConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server configuration for the HTTP endpoints.", "tags": [], "signatures": [ { "code": "interface ServerConfig {\n origin: string;\n realm?: string;\n trustTier?: TrustTier;\n sessionTtlSecs?: number;\n challengeTtlSecs?: number;\n requiredConformance?: ConformanceLevel;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 25, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "serverconfig" }, { "name": "SessionState", "declarationName": "SessionState", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Session states.", "tags": [], "signatures": [ { "code": "type SessionState = 'awaiting_proof' | 'established' | 'closed';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 42, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "sessionstate" }, { "name": "SessionStore", "declarationName": "SessionStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Session store interface.", "tags": [], "signatures": [ { "code": "interface SessionStore {\n put(session: StoredSession): Promise;\n get(sessionId: string): Promise;\n remove(sessionId: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 57, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "sessionstore" }, { "name": "SignFn", "declarationName": "SignFn", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Function that signs a payload and returns a base64url (no padding)\nencoded signature.\n\nThe caller provides this — it may use", "tags": [ { "name": "openagentid", "text": "/crypto-wasm, Web Crypto,\nor any Ed25519 implementation." } ], "signatures": [ { "code": "type SignFn = (payload: Uint8Array) => Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/client.d.ts", "line": 32, "sha256": "40cdd794feaf42a2acd1b9c31043e39958cbfeac249dcdcb4aa9e16453720922" } } ], "anchor": "signfn" }, { "name": "StoredSession", "declarationName": "StoredSession", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A stored session.", "tags": [], "signatures": [ { "code": "interface StoredSession {\n id: string;\n state: SessionState;\n initiatorDid: string;\n responderDid: string;\n nonce: string;\n challengeTimestamp: string;\n createdAt: number;\n expiresAt: number;\n capabilities: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 44, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "storedsession" }, { "name": "TransportError", "declarationName": "TransportError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Transport error with HTTP context.", "tags": [], "signatures": [ { "code": "declare class TransportError extends Error {\n readonly statusCode: number | undefined;\n readonly responseBody: string | undefined;\n constructor(message: string, statusCode?: number, responseBody?: string);\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 98, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "transporterror" }, { "name": "TrustTier", "declarationName": "TrustTier", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The resolution tier the server assigns (Section 15.4).", "tags": [], "signatures": [ { "code": "type TrustTier = 'anonymous' | 'identified' | 'sovereign';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 38, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "trusttier" }, { "name": "VerifySignatureFn", "declarationName": "VerifySignatureFn", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Signature verifier function. The caller provides this (crypto-wasm,\nlibsodium, noble-ed25519, a KMS call) since Ed25519 verification is not in\nevery runtime's Web Crypto.", "tags": [], "signatures": [ { "code": "type VerifySignatureFn = (params: {\n publicKeyBase64Url: string;\n payload: Uint8Array;\n signatureBase64Url: string;\n}) => Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 92, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "verifysignaturefn" }, { "name": "VERSION", "declarationName": "VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SDK version — kept in sync with `package.json`.", "tags": [], "signatures": [ { "code": "declare const VERSION = \"0.1.1\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/index.d.ts", "line": 20, "sha256": "647a03f3fe338f8c0ae87140e3413bc13fdca8dd808c1a80a9144b2aca9c41b1" } } ], "anchor": "version" }, { "name": "WELL_KNOWN_PATH", "declarationName": "WELL_KNOWN_PATH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default well-known path.", "tags": [], "signatures": [ { "code": "declare const WELL_KNOWN_PATH = \"/.well-known/openagent\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 38, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "well_known_path" } ], "supportingDeclarations": [], "coverage": { "discovered": 50, "documented": 50, "missing": [] } }, { "subpath": "./client", "importSpecifier": "@openagentid/http/client", "page": "/reference/typescript/http/client", "kind": "declarations", "conditions": { "types": "./dist/client.d.ts", "import": "./dist/client.js", "require": "./dist/client.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/client.d.ts" }, { "conditions": [ "import" ], "path": "./dist/client.js" }, { "conditions": [ "require" ], "path": "./dist/client.cjs" } ], "exports": [ { "name": "ClientConfig", "declarationName": "ClientConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Client configuration.", "tags": [], "signatures": [ { "code": "interface ClientConfig {\n did: string;\n keyType?: KeyType;\n timeoutMs?: number;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/client.d.ts", "line": 13, "sha256": "40cdd794feaf42a2acd1b9c31043e39958cbfeac249dcdcb4aa9e16453720922" } } ], "anchor": "clientconfig" }, { "name": "HttpAuthClient", "declarationName": "HttpAuthClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "HTTP client that performs the Core Protocol identity flow.\n\nUsage:\n```ts\nconst client = new HttpAuthClient({\n config: { did: 'did:oas:l1fe:agent:my-bot' },\n sign: async (payload) => base64url(ed25519Sign(privateKey, payload)),\n publicKey: async () => base64url(ed25519PublicKey(privateKey)),\n});\nconst session = await client.authenticate('https://api.example.com');\nconst resp = await session.get('/api/tools');\n```", "tags": [], "signatures": [ { "code": "declare class HttpAuthClient {\n constructor(params: {\n config: ClientConfig;\n sign: SignFn;\n publicKey: () => Promise;\n transport?: HttpTransport;\n });\n authenticate(baseUrl: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/client.d.ts", "line": 47, "sha256": "40cdd794feaf42a2acd1b9c31043e39958cbfeac249dcdcb4aa9e16453720922" } } ], "anchor": "httpauthclient" }, { "name": "SignFn", "declarationName": "SignFn", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Function that signs a payload and returns a base64url (no padding)\nencoded signature.\n\nThe caller provides this — it may use", "tags": [ { "name": "openagentid", "text": "/crypto-wasm, Web Crypto,\nor any Ed25519 implementation." } ], "signatures": [ { "code": "type SignFn = (payload: Uint8Array) => Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/client.d.ts", "line": 32, "sha256": "40cdd794feaf42a2acd1b9c31043e39958cbfeac249dcdcb4aa9e16453720922" } } ], "anchor": "signfn" } ], "supportingDeclarations": [ { "name": "AuthenticatedSession", "declarationName": "AuthenticatedSession", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An authenticated HTTP session obtained after a successful Core Protocol identity flow.", "tags": [], "signatures": [ { "code": "declare class AuthenticatedSession {\n constructor(params: {\n baseUrl: string;\n sessionId: string;\n peerDid: string;\n sessionToken: string;\n expiresAt: number;\n });\n isExpired(): boolean;\n getSessionId(): string;\n getPeerDid(): string;\n getBaseUrl(): string;\n fetch(path: string, init?: RequestInit): Promise;\n get(path: string): Promise;\n post(path: string, body: unknown): Promise;\n put(path: string, body: unknown): Promise;\n delete(path: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/session.d.ts", "line": 8, "sha256": "09b06ba18f43ab58494d0e744db785e83ae581e634f0d0bd16716762a9be6462" } } ], "anchor": "authenticatedsession" }, { "name": "HttpTransport", "declarationName": "HttpTransport", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "HTTP transport carrying the identity flow over REST.", "tags": [], "signatures": [ { "code": "declare class HttpTransport {\n constructor(config?: HttpTransportConfig);\n fetchChallenge(endpoint: string): Promise;\n prove(endpoint: string, proof: IdentityProof): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 111, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "httptransport" }, { "name": "HttpTransportConfig", "declarationName": "HttpTransportConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for the HTTP transport.", "tags": [], "signatures": [ { "code": "interface HttpTransportConfig {\n timeoutMs?: number;\n headers?: Record;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 104, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "httptransportconfig" }, { "name": "IdentityChallenge", "declarationName": "IdentityChallenge", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server → Agent: a cryptographic challenge (Section 15.2).", "tags": [], "signatures": [ { "code": "interface IdentityChallenge {\n type: string;\n nonce: string;\n timestamp: string;\n origin: string;\n realm?: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 14, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identitychallenge" }, { "name": "IdentityProof", "declarationName": "IdentityProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Agent → Server: the cryptographic proof of identity (Section 15.3).", "tags": [], "signatures": [ { "code": "interface IdentityProof {\n signature: string;\n public_key: string;\n key_type: KeyType;\n nonce: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 28, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identityproof" }, { "name": "IdentityVerified", "declarationName": "IdentityVerified", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server → Agent: identity confirmed; session issued (Section 15.4).", "tags": [], "signatures": [ { "code": "interface IdentityVerified {\n did: string;\n trust_tier: TrustTier;\n session_token: string;\n session_expires: string;\n capabilities?: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 40, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identityverified" }, { "name": "KeyType", "declarationName": "KeyType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Signature scheme for a proof (Section 15.3).", "tags": [], "signatures": [ { "code": "type KeyType = 'ed25519' | 'secp256k1';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 26, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "keytype" }, { "name": "TrustTier", "declarationName": "TrustTier", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The resolution tier the server assigns (Section 15.4).", "tags": [], "signatures": [ { "code": "type TrustTier = 'anonymous' | 'identified' | 'sovereign';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 38, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "trusttier" } ], "coverage": { "discovered": 3, "documented": 3, "missing": [] } }, { "subpath": "./middleware", "importSpecifier": "@openagentid/http/middleware", "page": "/reference/typescript/http/middleware", "kind": "declarations", "conditions": { "types": "./dist/middleware.d.ts", "import": "./dist/middleware.js", "require": "./dist/middleware.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/middleware.d.ts" }, { "conditions": [ "import" ], "path": "./dist/middleware.js" }, { "conditions": [ "require" ], "path": "./dist/middleware.cjs" } ], "exports": [ { "name": "createOpenAgentHandler", "declarationName": "createOpenAgentHandler", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a generic OAAP middleware using the standard fetch Request/Response API.\n\nReturns a function that:\n- Handles OAAP well-known endpoints\n- Validates authenticated requests\n- Returns `undefined` for well-known routes (caller should send the JSON response)\n\nWorks with Hono, Cloudflare Workers, Deno, Bun, and any fetch-based framework.", "tags": [], "signatures": [ { "code": "declare function createOpenAgentHandler(options: MiddlewareOptions): {\n config: ServerConfig;\n store: SessionStore;\n handle: (request: Request) => Promise;\n};", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/middleware.d.ts", "line": 40, "sha256": "9fc1a86d4ab4ca87c55bd74e4db87d16473f304ce9509f744d784fa7a65ff11f" } } ], "anchor": "createopenagenthandler" }, { "name": "createOpenAgentMiddleware", "declarationName": "createOpenAgentMiddleware", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create Express-compatible middleware.\n\nUsage:\n```ts\napp.use(createOpenAgentMiddleware({\n serverDid: 'did:oas:l1fe:service:api',\n verifySignature: async (did, payload, sig) => { ... },\n}));\n```", "tags": [], "signatures": [ { "code": "declare function createOpenAgentMiddleware(options: MiddlewareOptions): (req: {\n url?: string;\n method?: string;\n headers: Record;\n path?: string;\n}, res: {\n status: (code: number) => {\n json: (body: unknown) => void;\n end: () => void;\n };\n}, next: () => void) => Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/middleware.d.ts", "line": 62, "sha256": "9fc1a86d4ab4ca87c55bd74e4db87d16473f304ce9509f744d784fa7a65ff11f" } } ], "anchor": "createopenagentmiddleware" }, { "name": "MiddlewareOptions", "declarationName": "MiddlewareOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for creating OAAP middleware.", "tags": [], "signatures": [ { "code": "interface MiddlewareOptions {\n serverDid: string;\n store?: SessionStore;\n requiredConformance?: 'L0' | 'L1' | 'L2';\n sessionTtlSecs?: number;\n challengeTtlSecs?: number;\n verifySignature: VerifySignatureFn;\n excludePaths?: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/middleware.d.ts", "line": 14, "sha256": "9fc1a86d4ab4ca87c55bd74e4db87d16473f304ce9509f744d784fa7a65ff11f" } } ], "anchor": "middlewareoptions" } ], "supportingDeclarations": [ { "name": "AuthResult", "declarationName": "AuthResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of authenticating an incoming request.", "tags": [], "signatures": [ { "code": "interface AuthResult {\n authenticated: boolean;\n peerDid?: string;\n sessionToken?: string;\n error?: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 110, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "authresult" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Conformance level enum values.", "tags": [], "signatures": [ { "code": "type ConformanceLevel = 'L0' | 'L1' | 'L2';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 12, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "conformancelevel" }, { "name": "ServerConfig", "declarationName": "ServerConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server configuration for the HTTP endpoints.", "tags": [], "signatures": [ { "code": "interface ServerConfig {\n origin: string;\n realm?: string;\n trustTier?: TrustTier;\n sessionTtlSecs?: number;\n challengeTtlSecs?: number;\n requiredConformance?: ConformanceLevel;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 25, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "serverconfig" }, { "name": "SessionState", "declarationName": "SessionState", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Session states.", "tags": [], "signatures": [ { "code": "type SessionState = 'awaiting_proof' | 'established' | 'closed';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 42, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "sessionstate" }, { "name": "SessionStore", "declarationName": "SessionStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Session store interface.", "tags": [], "signatures": [ { "code": "interface SessionStore {\n put(session: StoredSession): Promise;\n get(sessionId: string): Promise;\n remove(sessionId: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 57, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "sessionstore" }, { "name": "StoredSession", "declarationName": "StoredSession", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A stored session.", "tags": [], "signatures": [ { "code": "interface StoredSession {\n id: string;\n state: SessionState;\n initiatorDid: string;\n responderDid: string;\n nonce: string;\n challengeTimestamp: string;\n createdAt: number;\n expiresAt: number;\n capabilities: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 44, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "storedsession" }, { "name": "TrustTier", "declarationName": "TrustTier", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The resolution tier the server assigns (Section 15.4).", "tags": [], "signatures": [ { "code": "type TrustTier = 'anonymous' | 'identified' | 'sovereign';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 38, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "trusttier" }, { "name": "VerifySignatureFn", "declarationName": "VerifySignatureFn", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Signature verifier function. The caller provides this (crypto-wasm,\nlibsodium, noble-ed25519, a KMS call) since Ed25519 verification is not in\nevery runtime's Web Crypto.", "tags": [], "signatures": [ { "code": "type VerifySignatureFn = (params: {\n publicKeyBase64Url: string;\n payload: Uint8Array;\n signatureBase64Url: string;\n}) => Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 92, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "verifysignaturefn" } ], "coverage": { "discovered": 3, "documented": 3, "missing": [] } }, { "subpath": "./server", "importSpecifier": "@openagentid/http/server", "page": "/reference/typescript/http/server", "kind": "declarations", "conditions": { "types": "./dist/server.d.ts", "import": "./dist/server.js", "require": "./dist/server.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/server.d.ts" }, { "conditions": [ "import" ], "path": "./dist/server.js" }, { "conditions": [ "require" ], "path": "./dist/server.cjs" } ], "exports": [ { "name": "authenticateRequest", "declarationName": "authenticateRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Authenticate an incoming request by checking the session token.", "tags": [], "signatures": [ { "code": "declare function authenticateRequest(request: Request, store: SessionStore): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 117, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "authenticaterequest" }, { "name": "AuthResult", "declarationName": "AuthResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of authenticating an incoming request.", "tags": [], "signatures": [ { "code": "interface AuthResult {\n authenticated: boolean;\n peerDid?: string;\n sessionToken?: string;\n error?: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 110, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "authresult" }, { "name": "CoreAuthError", "declarationName": "CoreAuthError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error returned by server handlers, carrying the HTTP status to render.", "tags": [], "signatures": [ { "code": "declare class CoreAuthError extends Error {\n readonly statusCode: number;\n constructor(message: string, statusCode: number);\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 70, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "coreautherror" }, { "name": "createServerConfig", "declarationName": "createServerConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a server config with sensible defaults.", "tags": [], "signatures": [ { "code": "declare function createServerConfig(origin: string, overrides?: Partial): Required> & ServerConfig;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 40, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "createserverconfig" }, { "name": "DEFAULT_CHALLENGE_TTL_SECS", "declarationName": "DEFAULT_CHALLENGE_TTL_SECS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default challenge TTL in seconds (Section 7: default 30s, max 300s).", "tags": [], "signatures": [ { "code": "declare const DEFAULT_CHALLENGE_TTL_SECS = 60;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 23, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "default_challenge_ttl_secs" }, { "name": "DEFAULT_SESSION_TTL_SECS", "declarationName": "DEFAULT_SESSION_TTL_SECS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default session TTL in seconds.", "tags": [], "signatures": [ { "code": "declare const DEFAULT_SESSION_TTL_SECS = 300;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 21, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "default_session_ttl_secs" }, { "name": "handleChallenge", "declarationName": "handleChallenge", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Handle the challenge step - issue an IdentityChallenge.\n\nRecords a pending session keyed by the nonce: the proof carries exactly\nthat correlation, and single-use-ness is enforced by removal.", "tags": [], "signatures": [ { "code": "declare function handleChallenge(config: ServerConfig & {\n requiredConformance?: ConformanceLevel;\n}, store: SessionStore): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 84, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "handlechallenge" }, { "name": "handleDiscovery", "declarationName": "handleDiscovery", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Handle `GET /.well-known/openagent` - returns the discovery document.", "tags": [], "signatures": [ { "code": "declare function handleDiscovery(config: ServerConfig & {\n requiredConformance?: ConformanceLevel;\n}): DiscoveryDocument;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 75, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "handlediscovery" }, { "name": "handleProve", "declarationName": "handleProve", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Handle the prove step - verify an IdentityProof and issue a session.\n\nVerification is normative-ordered: pending challenge first (present,\nunexpired), then shape checks (nonce echo), then the signature over the\nJCS-canonical challenge bytes. The nonce is consumed on success *and* on\nfailure - a failed answer must not be retryable, or a verifier becomes an\noracle.", "tags": [], "signatures": [ { "code": "declare function handleProve(config: ServerConfig & {\n requiredConformance?: ConformanceLevel;\n}, store: SessionStore, body: unknown, verifySignature: VerifySignatureFn): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 106, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "handleprove" }, { "name": "InMemorySessionStore", "declarationName": "InMemorySessionStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory session store for development and testing.", "tags": [], "signatures": [ { "code": "declare class InMemorySessionStore implements SessionStore {\n put(session: StoredSession): Promise;\n get(sessionId: string): Promise;\n remove(sessionId: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 63, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "inmemorysessionstore" }, { "name": "ServerConfig", "declarationName": "ServerConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server configuration for the HTTP endpoints.", "tags": [], "signatures": [ { "code": "interface ServerConfig {\n origin: string;\n realm?: string;\n trustTier?: TrustTier;\n sessionTtlSecs?: number;\n challengeTtlSecs?: number;\n requiredConformance?: ConformanceLevel;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 25, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "serverconfig" }, { "name": "SessionState", "declarationName": "SessionState", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Session states.", "tags": [], "signatures": [ { "code": "type SessionState = 'awaiting_proof' | 'established' | 'closed';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 42, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "sessionstate" }, { "name": "SessionStore", "declarationName": "SessionStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Session store interface.", "tags": [], "signatures": [ { "code": "interface SessionStore {\n put(session: StoredSession): Promise;\n get(sessionId: string): Promise;\n remove(sessionId: string): Promise;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 57, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "sessionstore" }, { "name": "StoredSession", "declarationName": "StoredSession", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A stored session.", "tags": [], "signatures": [ { "code": "interface StoredSession {\n id: string;\n state: SessionState;\n initiatorDid: string;\n responderDid: string;\n nonce: string;\n challengeTimestamp: string;\n createdAt: number;\n expiresAt: number;\n capabilities: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 44, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "storedsession" }, { "name": "VerifySignatureFn", "declarationName": "VerifySignatureFn", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Signature verifier function. The caller provides this (crypto-wasm,\nlibsodium, noble-ed25519, a KMS call) since Ed25519 verification is not in\nevery runtime's Web Crypto.", "tags": [], "signatures": [ { "code": "type VerifySignatureFn = (params: {\n publicKeyBase64Url: string;\n payload: Uint8Array;\n signatureBase64Url: string;\n}) => Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/server.d.ts", "line": 92, "sha256": "1cb8b4f435aaf411ff6d29ab039a304ab48c2353dfbbfd8746cbd2c665854d4c" } } ], "anchor": "verifysignaturefn" } ], "supportingDeclarations": [ { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Conformance level enum values.", "tags": [], "signatures": [ { "code": "type ConformanceLevel = 'L0' | 'L1' | 'L2';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 12, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "conformancelevel" }, { "name": "DiscoveryDocument", "declarationName": "DiscoveryDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Discovery document returned by the server.", "tags": [], "signatures": [ { "code": "interface DiscoveryDocument {\n auth_endpoint: string;\n supported_versions: number[];\n server_did: string;\n required_conformance_level: ConformanceLevel;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 14, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "discoverydocument" }, { "name": "IdentityChallenge", "declarationName": "IdentityChallenge", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server → Agent: a cryptographic challenge (Section 15.2).", "tags": [], "signatures": [ { "code": "interface IdentityChallenge {\n type: string;\n nonce: string;\n timestamp: string;\n origin: string;\n realm?: string;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 14, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identitychallenge" }, { "name": "IdentityVerified", "declarationName": "IdentityVerified", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Server → Agent: identity confirmed; session issued (Section 15.4).", "tags": [], "signatures": [ { "code": "interface IdentityVerified {\n did: string;\n trust_tier: TrustTier;\n session_token: string;\n session_expires: string;\n capabilities?: string[];\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 40, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "identityverified" }, { "name": "TrustTier", "declarationName": "TrustTier", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The resolution tier the server assigns (Section 15.4).", "tags": [], "signatures": [ { "code": "type TrustTier = 'anonymous' | 'identified' | 'sovereign';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/transport.d.ts", "line": 38, "sha256": "151df686c9fee8b40db6a363eae581c590fd5cb04e1ac7e7f50c6b1921547f41" } } ], "anchor": "trusttier" } ], "coverage": { "discovered": 15, "documented": 15, "missing": [] } }, { "subpath": "./discovery", "importSpecifier": "@openagentid/http/discovery", "page": "/reference/typescript/http/discovery", "kind": "declarations", "conditions": { "types": "./dist/discovery.d.ts", "import": "./dist/discovery.js", "require": "./dist/discovery.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/discovery.d.ts" }, { "conditions": [ "import" ], "path": "./dist/discovery.js" }, { "conditions": [ "require" ], "path": "./dist/discovery.cjs" } ], "exports": [ { "name": "AUTH_ENDPOINT_PATH", "declarationName": "AUTH_ENDPOINT_PATH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default auth endpoint path.", "tags": [], "signatures": [ { "code": "declare const AUTH_ENDPOINT_PATH = \"/.well-known/openagent/auth\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 40, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "auth_endpoint_path" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Conformance level enum values.", "tags": [], "signatures": [ { "code": "type ConformanceLevel = 'L0' | 'L1' | 'L2';", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 12, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "conformancelevel" }, { "name": "DiscoveryDocument", "declarationName": "DiscoveryDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Discovery document returned by the server.", "tags": [], "signatures": [ { "code": "interface DiscoveryDocument {\n auth_endpoint: string;\n supported_versions: number[];\n server_did: string;\n required_conformance_level: ConformanceLevel;\n}", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 14, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "discoverydocument" }, { "name": "discoveryDocumentSchema", "declarationName": "discoveryDocumentSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Zod schema for DiscoveryDocument.", "tags": [], "signatures": [ { "code": "declare const discoveryDocumentSchema: z.ZodObject<{\n auth_endpoint: z.ZodString;\n supported_versions: z.ZodArray;\n server_did: z.ZodString;\n required_conformance_level: z.ZodEnum<[\n \"L0\",\n \"L1\",\n \"L2\"\n ]>;\n}, \"strip\", z.ZodTypeAny, {\n auth_endpoint: string;\n supported_versions: number[];\n server_did: string;\n required_conformance_level: \"L0\" | \"L1\" | \"L2\";\n}, {\n auth_endpoint: string;\n supported_versions: number[];\n server_did: string;\n required_conformance_level: \"L0\" | \"L1\" | \"L2\";\n}>;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 21, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "discoverydocumentschema" }, { "name": "fetchDiscovery", "declarationName": "fetchDiscovery", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Fetch the discovery document from a server.", "tags": [ { "name": "param", "text": "baseUrl - Server base URL (e.g. `https://api.example.com`)" }, { "name": "param", "text": "timeoutMs - Request timeout (default: 10000)" } ], "signatures": [ { "code": "declare function fetchDiscovery(baseUrl: string, timeoutMs?: number): Promise;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 49, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "fetchdiscovery" }, { "name": "PROVE_ENDPOINT_PATH", "declarationName": "PROVE_ENDPOINT_PATH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default prove endpoint path.", "tags": [], "signatures": [ { "code": "declare const PROVE_ENDPOINT_PATH = \"/.well-known/openagent/auth/prove\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 42, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "prove_endpoint_path" }, { "name": "resolveAuthEndpoint", "declarationName": "resolveAuthEndpoint", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve the full auth endpoint URL from a base URL and discovery document.", "tags": [], "signatures": [ { "code": "declare function resolveAuthEndpoint(baseUrl: string, doc: DiscoveryDocument): string;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 51, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "resolveauthendpoint" }, { "name": "resolveProveEndpoint", "declarationName": "resolveProveEndpoint", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve the prove endpoint URL (auth endpoint + `/prove`).", "tags": [], "signatures": [ { "code": "declare function resolveProveEndpoint(baseUrl: string, doc: DiscoveryDocument): string;", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 53, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "resolveproveendpoint" }, { "name": "WELL_KNOWN_PATH", "declarationName": "WELL_KNOWN_PATH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default well-known path.", "tags": [], "signatures": [ { "code": "declare const WELL_KNOWN_PATH = \"/.well-known/openagent\";", "source": { "package": "@openagentid/http", "version": "0.1.1", "file": "dist/discovery.d.ts", "line": 38, "sha256": "7420fc2aa7c895a8a0ea16ec564fad7e1310edbea53fe0cb072b977985ca4dc1" } } ], "anchor": "well_known_path" } ], "supportingDeclarations": [], "coverage": { "discovered": 9, "documented": 9, "missing": [] } } ] }, { "name": "@openagentid/mcp", "version": "0.1.1", "status": "legacy-sdk-peer", "notes": [ "Declares an optional peer on @openagentid/sdk ^0.1.0, which excludes SDK 0.7.2. Reference describes the published contract; do not assume compatibility with the current SDK." ], "tarball": "https://registry.npmjs.org/@openagentid/mcp/-/mcp-0.1.1.tgz", "integrity": "sha512-Kquw9MiLgfnmX5w7RK3FK1SYKcexe5wKJk8DtlOnEaN8k/0Z+WytXkEFWwj+W4+E9ug708jwfKHFlAjdNYSUWA==", "packageJsonSha256": "44c7968fa55c02ffab22cd6f6bd76580f3885d70c24a758efb54d95a33845232", "page": "/reference/typescript/mcp", "engines": { "node": ">=20" }, "dependencies": {}, "peerDependencies": { "@modelcontextprotocol/sdk": "^1.27.0", "@openagentid/sdk": "^0.1.0" }, "peerDependenciesMeta": { "@openagentid/sdk": { "optional": true } }, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/mcp", "page": "/reference/typescript/mcp", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" }, { "conditions": [ "require" ], "path": "./dist/index.cjs" } ], "exports": [ { "name": "Agent", "declarationName": "Agent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal Agent surface — only the parts of the OpenAgent SDK Agent that\nthe MCP middleware actually needs.", "tags": [], "signatures": [ { "code": "interface Agent {\n did: Did;\n verifier: IdentityVerifier;\n signRequest(toolName: string, audience?: Did): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 69, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "agent" }, { "name": "ANONYMOUS_IDENTITY", "declarationName": "ANONYMOUS_IDENTITY", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ANONYMOUS_IDENTITY: VerifiedIdentity;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/server.d.ts", "line": 64, "sha256": "a8cf0a626bef855b371b6f722306146a80d950c117ca4193d9bd39f9017b1fb0" } } ], "anchor": "anonymous_identity" }, { "name": "AuditedResultMeta", "declarationName": "AuditedResultMeta", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result envelope returned by an authenticated tool call. The `auditId` is\npushed into `_meta.openagent.audit_id` on the response, so callers can\ncorrelate logs end-to-end.", "tags": [], "signatures": [ { "code": "interface AuditedResultMeta {\n audit_id: string;\n verified_did: Did;\n scopes: ReadonlyArray;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 83, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "auditedresultmeta" }, { "name": "AuthorizationDeniedError", "declarationName": "AuthorizationDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Caller's verified identity does not hold the required scopes.", "tags": [], "signatures": [ { "code": "declare class AuthorizationDeniedError extends OpenAgentMcpError {\n constructor(toolName: string, requiredScopes: ReadonlyArray, heldScopes: ReadonlyArray);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 56, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "authorizationdeniederror" }, { "name": "buildIdentityMeta", "declarationName": "buildIdentityMeta", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Helper for tests and tools that want to construct the identity\nenvelope manually without going through a full Agent. Returns a `_meta`\nobject that can be merged into a CallToolRequest's params.", "tags": [], "signatures": [ { "code": "declare function buildIdentityMeta(identity: {\n did: string;\n proof: string;\n nonce?: string;\n context?: Record;\n}): Record;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 75, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "buildidentitymeta" }, { "name": "combineSkillsPolicies", "declarationName": "combineSkillsPolicies", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compose two skills policy hooks. The combined hook denies if either\nunderlying hook denies; allow decisions from `first` are forwarded to\n`second`.", "tags": [], "signatures": [ { "code": "declare function combineSkillsPolicies(first: SkillsPolicyHook, second: SkillsPolicyHook): SkillsPolicyHook;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 85, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "combineskillspolicies" }, { "name": "createSkillsPolicy", "declarationName": "createSkillsPolicy", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a {@link SkillsPolicyHook} from a store and matching options.\n\nThe returned hook always allows tools that are not skill-like; it only\nconsults the store when {@link CreateSkillsPolicyOptions.isSkillTool}\nreturns true.", "tags": [], "signatures": [ { "code": "declare function createSkillsPolicy(options: CreateSkillsPolicyOptions): SkillsPolicyHook;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 79, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "createskillspolicy" }, { "name": "CreateSkillsPolicyOptions", "declarationName": "CreateSkillsPolicyOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreateSkillsPolicyOptions {\n store: SkillsPolicyStore;\n isSkillTool?: (toolName: string) => boolean;\n extractSkillName?: (args: unknown) => string | null;\n defaultDecision?: SkillsPolicyDecision;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 52, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "createskillspolicyoptions" }, { "name": "DEFAULT_SKILL_TOOL_NAMES", "declarationName": "DEFAULT_SKILL_TOOL_NAMES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Tool name prefixes that the middleware treats as skill-like by default.\nHost applications can override the matcher entirely via\n{@link createSkillsPolicy}.", "tags": [], "signatures": [ { "code": "declare const DEFAULT_SKILL_TOOL_NAMES: ReadonlyArray;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 21, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "default_skill_tool_names" }, { "name": "defaultRequireScopes", "declarationName": "defaultRequireScopes", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default scope deriver used when {@link OpenAgentMcpConfig.requireScopes}\nis not supplied.", "tags": [], "signatures": [ { "code": "declare const defaultRequireScopes: (toolName: string) => ReadonlyArray;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 177, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "defaultrequirescopes" }, { "name": "defaultScopeFormat", "declarationName": "defaultScopeFormat", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default scope format used when {@link OpenAgentMcpConfig.scopeFormat} is\nnot supplied.", "tags": [], "signatures": [ { "code": "declare const defaultScopeFormat: (toolName: string) => string;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 172, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "defaultscopeformat" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A decentralized identifier following the `did:oas:*` method or any other\nDID method understood by the configured verifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 17, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "did" }, { "name": "ErrorHook", "declarationName": "ErrorHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired when the tool body or any earlier middleware step throws.\nThe middleware re-throws the error after running this hook so MCP\nclients still observe the original failure mode.", "tags": [], "signatures": [ { "code": "type ErrorHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity | null;\n error: unknown;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 130, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "errorhook" }, { "name": "IdentityVerificationError", "declarationName": "IdentityVerificationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Identity envelope was present but the verifier rejected it.", "tags": [], "signatures": [ { "code": "declare class IdentityVerificationError extends OpenAgentMcpError {\n constructor(toolName: string, cause: unknown);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 52, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "identityverificationerror" }, { "name": "IdentityVerifier", "declarationName": "IdentityVerifier", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The verifier interface — implemented by `@openagentid/sdk` (production) and\nby the in-memory test agent shipped here.\n\nImplementations MUST be deterministic for a given input and MUST NOT\nmutate the request identity object.", "tags": [], "signatures": [ { "code": "interface IdentityVerifier {\n verify(identity: OpenAgentRequestIdentity, requiredScopes: ReadonlyArray): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 62, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "identityverifier" }, { "name": "InMemorySkillsPolicyStore", "declarationName": "InMemorySkillsPolicyStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Trivial in-memory store useful in tests and as a starting point for\nproduction stores.", "tags": [], "signatures": [ { "code": "declare class InMemorySkillsPolicyStore implements SkillsPolicyStore {\n constructor(rules?: ReadonlyArray);\n lookup(skillName: string): SkillsRule | null;\n withRule(rule: SkillsRule): InMemorySkillsPolicyStore;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 45, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "inmemoryskillspolicystore" }, { "name": "McpClientLike", "declarationName": "McpClientLike", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal MCP client surface used by the interceptor. Like the server\nadapter, we describe just the methods we need to keep peer-dep\ncompatibility broad.", "tags": [], "signatures": [ { "code": "interface McpClientLike {\n callTool(params: {\n name: string;\n arguments?: Record;\n _meta?: Record;\n }, ...rest: unknown[]): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 30, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "mcpclientlike" }, { "name": "McpErrorCode", "declarationName": "McpErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard JSON-RPC + MCP error codes used by the middleware.", "tags": [], "signatures": [ { "code": "declare const McpErrorCode: {\n readonly InvalidRequest: -32600;\n readonly MethodNotFound: -32601;\n readonly InvalidParams: -32602;\n readonly InternalError: -32603;\n readonly ServerError: -32000;\n readonly AuthenticationFailed: -32001;\n readonly AuthorizationDenied: -32002;\n readonly SkillsPolicyDenied: -32003;\n};", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 10, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "mcperrorcode" }, { "name": "McpErrorCodeValue", "declarationName": "McpErrorCodeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type McpErrorCodeValue = (typeof McpErrorCode)[keyof typeof McpErrorCode];", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 28, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "mcperrorcodevalue" }, { "name": "McpServerLike", "declarationName": "McpServerLike", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal McpServer surface used by the middleware. We avoid importing\nconcrete types from `@modelcontextprotocol/sdk` because peer-dep\nversions vary across host applications and the SDK's own type exports\nare subject to change. The shape below is the intersection of every\n`1.x` McpServer release.", "tags": [], "signatures": [ { "code": "interface McpServerLike {\n tool(...args: unknown[]): unknown;\n registerTool(...args: unknown[]): unknown;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/server.d.ts", "line": 39, "sha256": "a8cf0a626bef855b371b6f722306146a80d950c117ca4193d9bd39f9017b1fb0" } } ], "anchor": "mcpserverlike" }, { "name": "MissingIdentityError", "declarationName": "MissingIdentityError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Caller did not present an OpenAgent identity envelope.", "tags": [], "signatures": [ { "code": "declare class MissingIdentityError extends OpenAgentMcpError {\n constructor(toolName: string);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 48, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "missingidentityerror" }, { "name": "OpenAgentClientConfig", "declarationName": "OpenAgentClientConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OpenAgentClientConfig {\n agent: Agent;\n audience?: string;\n beforeCall?: (params: {\n name: string;\n arguments?: Record;\n _meta?: Record;\n }) => Promise<{\n name: string;\n arguments?: Record;\n _meta?: Record;\n } | void> | {\n name: string;\n arguments?: Record;\n _meta?: Record;\n } | void;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 37, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "openagentclientconfig" }, { "name": "OpenAgentMcpConfig", "declarationName": "OpenAgentMcpConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for {@link withOpenAgent }.", "tags": [], "signatures": [ { "code": "interface OpenAgentMcpConfig {\n agent: Agent;\n requireScopes?: ScopeDeriver;\n requireIdentity?: boolean;\n skillsPolicy?: SkillsPolicyHook;\n preCall?: PreCallHook;\n postCall?: PostCallHook;\n onError?: ErrorHook;\n scopeFormat?: (toolName: string) => string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 139, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "openagentmcpconfig" }, { "name": "OpenAgentMcpError", "declarationName": "OpenAgentMcpError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Base class for all middleware errors. Subclasses set a default\n{@link OpenAgentMcpError.code} that maps to a JSON-RPC error code.", "tags": [], "signatures": [ { "code": "declare class OpenAgentMcpError extends Error {\n readonly code: McpErrorCodeValue;\n readonly data?: Record;\n constructor(message: string, code: McpErrorCodeValue, data?: Record);\n toJsonRpcError(): {\n code: McpErrorCodeValue;\n message: string;\n data?: Record;\n };\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 33, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "openagentmcperror" }, { "name": "OpenAgentRequestIdentity", "declarationName": "OpenAgentRequestIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The four pieces of metadata an MCP request carries about the calling\nagent. Populated by the {@link createClientInterceptor } on the call site\nand consumed by the server middleware.", "tags": [], "signatures": [ { "code": "interface OpenAgentRequestIdentity {\n did: Did;\n proof: string;\n nonce?: string;\n context?: Record;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 23, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "openagentrequestidentity" }, { "name": "PostCallHook", "declarationName": "PostCallHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired after a tool body executes successfully. Use it for audit\nlogging, metrics, and trace propagation. Throwing from this hook does\nNOT roll back the tool call.", "tags": [], "signatures": [ { "code": "type PostCallHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n durationMs: number;\n result: unknown;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 118, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "postcallhook" }, { "name": "PreCallHook", "declarationName": "PreCallHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired before a tool body executes — after the identity has been\nverified and the skills policy has approved the call.", "tags": [], "signatures": [ { "code": "type PreCallHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 108, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "precallhook" }, { "name": "ScopeDeriver", "declarationName": "ScopeDeriver", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Per-tool scope deriver.", "tags": [], "signatures": [ { "code": "type ScopeDeriver = (toolName: string, args: unknown) => ReadonlyArray;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 89, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "scopederiver" }, { "name": "SkillsPolicyDecision", "declarationName": "SkillsPolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SkillsPolicyDecision {\n allow: boolean;\n reason?: string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 100, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicydecision" }, { "name": "SkillsPolicyDeniedError", "declarationName": "SkillsPolicyDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Skills policy hook returned `allow: false`.", "tags": [], "signatures": [ { "code": "declare class SkillsPolicyDeniedError extends OpenAgentMcpError {\n constructor(toolName: string, reason: string | undefined);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 60, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "skillspolicydeniederror" }, { "name": "SkillsPolicyHook", "declarationName": "SkillsPolicyHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook signature for the skills policy. The hook receives the tool name,\nthe arguments, and the verified identity, and decides whether the call\nshould be allowed.", "tags": [], "signatures": [ { "code": "type SkillsPolicyHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n}) => Promise | SkillsPolicyDecision;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 95, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicyhook" }, { "name": "SkillsPolicyStore", "declarationName": "SkillsPolicyStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Policy store interface — implementations may be in-memory, file-backed\nby `SKILLS.md`, or fetched from a remote service.", "tags": [], "signatures": [ { "code": "interface SkillsPolicyStore {\n lookup(skillName: string): Promise | SkillsRule | null;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 38, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "skillspolicystore" }, { "name": "SkillsRule", "declarationName": "SkillsRule", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single rule describing whether a `(skillName, did)` pair is allowed.\n`null` for `dids` means \"any verified caller\". An empty array means\n\"no caller\".", "tags": [], "signatures": [ { "code": "interface SkillsRule {\n skillName: string;\n dids: ReadonlyArray | null;\n reason?: string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 27, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "skillsrule" }, { "name": "VerifiedIdentity", "declarationName": "VerifiedIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of running the auth pipeline against an incoming MCP request.\nAvailable to post-call hooks and audit log emitters.", "tags": [], "signatures": [ { "code": "interface VerifiedIdentity {\n did: Did;\n scopes: ReadonlyArray;\n auditId: string;\n claims: Readonly>;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 47, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "verifiedidentity" }, { "name": "withOpenAgent", "declarationName": "withOpenAgent", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Wrap an MCP server so every tool call is authenticated against an\nOpenAgent identity.", "tags": [ { "name": "example", "text": "```ts\nimport { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';\nimport { withOpenAgent } from '@openagentid/mcp';\nimport { agent } from './my-agent.js';\n\nconst server = new McpServer({ name: 'my-tools', version: '0.1.0' });\nconst authedServer = withOpenAgent(server, { agent });\n\nauthedServer.tool('search_web', searchHandler);\n```\n\nThe returned proxy is type-compatible with the underlying server, so\nexisting code that calls `tool()`, `registerTool()`, `connect()`, etc.\nkeeps working without changes." } ], "signatures": [ { "code": "declare function withOpenAgent(server: T, config: OpenAgentMcpConfig): T;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/server.d.ts", "line": 63, "sha256": "a8cf0a626bef855b371b6f722306146a80d950c117ca4193d9bd39f9017b1fb0" } } ], "anchor": "withopenagent" }, { "name": "withOpenAgentClient", "declarationName": "withOpenAgentClient", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Wrap an MCP client so every outbound `callTool` carries an OpenAgent\nidentity envelope.", "tags": [], "signatures": [ { "code": "declare function withOpenAgentClient(client: T, config: OpenAgentClientConfig): T;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 69, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "withopenagentclient" } ], "supportingDeclarations": [], "coverage": { "discovered": 36, "documented": 36, "missing": [] } }, { "subpath": "./server", "importSpecifier": "@openagentid/mcp/server", "page": "/reference/typescript/mcp/server", "kind": "declarations", "conditions": { "types": "./dist/server.d.ts", "import": "./dist/server.js", "require": "./dist/server.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/server.d.ts" }, { "conditions": [ "import" ], "path": "./dist/server.js" }, { "conditions": [ "require" ], "path": "./dist/server.cjs" } ], "exports": [ { "name": "ANONYMOUS_IDENTITY", "declarationName": "ANONYMOUS_IDENTITY", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ANONYMOUS_IDENTITY: VerifiedIdentity;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/server.d.ts", "line": 64, "sha256": "a8cf0a626bef855b371b6f722306146a80d950c117ca4193d9bd39f9017b1fb0" } } ], "anchor": "anonymous_identity" }, { "name": "McpServerLike", "declarationName": "McpServerLike", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal McpServer surface used by the middleware. We avoid importing\nconcrete types from `@modelcontextprotocol/sdk` because peer-dep\nversions vary across host applications and the SDK's own type exports\nare subject to change. The shape below is the intersection of every\n`1.x` McpServer release.", "tags": [], "signatures": [ { "code": "interface McpServerLike {\n tool(...args: unknown[]): unknown;\n registerTool(...args: unknown[]): unknown;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/server.d.ts", "line": 39, "sha256": "a8cf0a626bef855b371b6f722306146a80d950c117ca4193d9bd39f9017b1fb0" } } ], "anchor": "mcpserverlike" }, { "name": "withOpenAgent", "declarationName": "withOpenAgent", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Wrap an MCP server so every tool call is authenticated against an\nOpenAgent identity.", "tags": [ { "name": "example", "text": "```ts\nimport { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';\nimport { withOpenAgent } from '@openagentid/mcp';\nimport { agent } from './my-agent.js';\n\nconst server = new McpServer({ name: 'my-tools', version: '0.1.0' });\nconst authedServer = withOpenAgent(server, { agent });\n\nauthedServer.tool('search_web', searchHandler);\n```\n\nThe returned proxy is type-compatible with the underlying server, so\nexisting code that calls `tool()`, `registerTool()`, `connect()`, etc.\nkeeps working without changes." } ], "signatures": [ { "code": "declare function withOpenAgent(server: T, config: OpenAgentMcpConfig): T;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/server.d.ts", "line": 63, "sha256": "a8cf0a626bef855b371b6f722306146a80d950c117ca4193d9bd39f9017b1fb0" } } ], "anchor": "withopenagent" } ], "supportingDeclarations": [ { "name": "Agent", "declarationName": "Agent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal Agent surface — only the parts of the OpenAgent SDK Agent that\nthe MCP middleware actually needs.", "tags": [], "signatures": [ { "code": "interface Agent {\n did: Did;\n verifier: IdentityVerifier;\n signRequest(toolName: string, audience?: Did): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 69, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "agent" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A decentralized identifier following the `did:oas:*` method or any other\nDID method understood by the configured verifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 17, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "did" }, { "name": "ErrorHook", "declarationName": "ErrorHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired when the tool body or any earlier middleware step throws.\nThe middleware re-throws the error after running this hook so MCP\nclients still observe the original failure mode.", "tags": [], "signatures": [ { "code": "type ErrorHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity | null;\n error: unknown;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 130, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "errorhook" }, { "name": "IdentityVerifier", "declarationName": "IdentityVerifier", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The verifier interface — implemented by `@openagentid/sdk` (production) and\nby the in-memory test agent shipped here.\n\nImplementations MUST be deterministic for a given input and MUST NOT\nmutate the request identity object.", "tags": [], "signatures": [ { "code": "interface IdentityVerifier {\n verify(identity: OpenAgentRequestIdentity, requiredScopes: ReadonlyArray): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 62, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "identityverifier" }, { "name": "OpenAgentMcpConfig", "declarationName": "OpenAgentMcpConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for {@link withOpenAgent }.", "tags": [], "signatures": [ { "code": "interface OpenAgentMcpConfig {\n agent: Agent;\n requireScopes?: ScopeDeriver;\n requireIdentity?: boolean;\n skillsPolicy?: SkillsPolicyHook;\n preCall?: PreCallHook;\n postCall?: PostCallHook;\n onError?: ErrorHook;\n scopeFormat?: (toolName: string) => string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 139, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "openagentmcpconfig" }, { "name": "OpenAgentRequestIdentity", "declarationName": "OpenAgentRequestIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The four pieces of metadata an MCP request carries about the calling\nagent. Populated by the {@link createClientInterceptor } on the call site\nand consumed by the server middleware.", "tags": [], "signatures": [ { "code": "interface OpenAgentRequestIdentity {\n did: Did;\n proof: string;\n nonce?: string;\n context?: Record;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 23, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "openagentrequestidentity" }, { "name": "PostCallHook", "declarationName": "PostCallHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired after a tool body executes successfully. Use it for audit\nlogging, metrics, and trace propagation. Throwing from this hook does\nNOT roll back the tool call.", "tags": [], "signatures": [ { "code": "type PostCallHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n durationMs: number;\n result: unknown;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 118, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "postcallhook" }, { "name": "PreCallHook", "declarationName": "PreCallHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired before a tool body executes — after the identity has been\nverified and the skills policy has approved the call.", "tags": [], "signatures": [ { "code": "type PreCallHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 108, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "precallhook" }, { "name": "ScopeDeriver", "declarationName": "ScopeDeriver", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Per-tool scope deriver.", "tags": [], "signatures": [ { "code": "type ScopeDeriver = (toolName: string, args: unknown) => ReadonlyArray;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 89, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "scopederiver" }, { "name": "SkillsPolicyDecision", "declarationName": "SkillsPolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SkillsPolicyDecision {\n allow: boolean;\n reason?: string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 100, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicydecision" }, { "name": "SkillsPolicyHook", "declarationName": "SkillsPolicyHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook signature for the skills policy. The hook receives the tool name,\nthe arguments, and the verified identity, and decides whether the call\nshould be allowed.", "tags": [], "signatures": [ { "code": "type SkillsPolicyHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n}) => Promise | SkillsPolicyDecision;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 95, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicyhook" }, { "name": "VerifiedIdentity", "declarationName": "VerifiedIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of running the auth pipeline against an incoming MCP request.\nAvailable to post-call hooks and audit log emitters.", "tags": [], "signatures": [ { "code": "interface VerifiedIdentity {\n did: Did;\n scopes: ReadonlyArray;\n auditId: string;\n claims: Readonly>;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 47, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "verifiedidentity" } ], "coverage": { "discovered": 3, "documented": 3, "missing": [] } }, { "subpath": "./client", "importSpecifier": "@openagentid/mcp/client", "page": "/reference/typescript/mcp/client", "kind": "declarations", "conditions": { "types": "./dist/client.d.ts", "import": "./dist/client.js", "require": "./dist/client.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/client.d.ts" }, { "conditions": [ "import" ], "path": "./dist/client.js" }, { "conditions": [ "require" ], "path": "./dist/client.cjs" } ], "exports": [ { "name": "buildIdentityMeta", "declarationName": "buildIdentityMeta", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Helper for tests and tools that want to construct the identity\nenvelope manually without going through a full Agent. Returns a `_meta`\nobject that can be merged into a CallToolRequest's params.", "tags": [], "signatures": [ { "code": "declare function buildIdentityMeta(identity: {\n did: string;\n proof: string;\n nonce?: string;\n context?: Record;\n}): Record;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 75, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "buildidentitymeta" }, { "name": "McpClientLike", "declarationName": "McpClientLike", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal MCP client surface used by the interceptor. Like the server\nadapter, we describe just the methods we need to keep peer-dep\ncompatibility broad.", "tags": [], "signatures": [ { "code": "interface McpClientLike {\n callTool(params: {\n name: string;\n arguments?: Record;\n _meta?: Record;\n }, ...rest: unknown[]): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 30, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "mcpclientlike" }, { "name": "OpenAgentClientConfig", "declarationName": "OpenAgentClientConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OpenAgentClientConfig {\n agent: Agent;\n audience?: string;\n beforeCall?: (params: {\n name: string;\n arguments?: Record;\n _meta?: Record;\n }) => Promise<{\n name: string;\n arguments?: Record;\n _meta?: Record;\n } | void> | {\n name: string;\n arguments?: Record;\n _meta?: Record;\n } | void;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 37, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "openagentclientconfig" }, { "name": "withOpenAgentClient", "declarationName": "withOpenAgentClient", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Wrap an MCP client so every outbound `callTool` carries an OpenAgent\nidentity envelope.", "tags": [], "signatures": [ { "code": "declare function withOpenAgentClient(client: T, config: OpenAgentClientConfig): T;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/client.d.ts", "line": 69, "sha256": "4c18af8d4b528b1fcdcce16a77eabaa281198b6112bee1946a8cec019dc7af04" } } ], "anchor": "withopenagentclient" } ], "supportingDeclarations": [ { "name": "Agent", "declarationName": "Agent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal Agent surface — only the parts of the OpenAgent SDK Agent that\nthe MCP middleware actually needs.", "tags": [], "signatures": [ { "code": "interface Agent {\n did: Did;\n verifier: IdentityVerifier;\n signRequest(toolName: string, audience?: Did): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 69, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "agent" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A decentralized identifier following the `did:oas:*` method or any other\nDID method understood by the configured verifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 17, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "did" }, { "name": "IdentityVerifier", "declarationName": "IdentityVerifier", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The verifier interface — implemented by `@openagentid/sdk` (production) and\nby the in-memory test agent shipped here.\n\nImplementations MUST be deterministic for a given input and MUST NOT\nmutate the request identity object.", "tags": [], "signatures": [ { "code": "interface IdentityVerifier {\n verify(identity: OpenAgentRequestIdentity, requiredScopes: ReadonlyArray): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 62, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "identityverifier" }, { "name": "OpenAgentRequestIdentity", "declarationName": "OpenAgentRequestIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The four pieces of metadata an MCP request carries about the calling\nagent. Populated by the {@link createClientInterceptor } on the call site\nand consumed by the server middleware.", "tags": [], "signatures": [ { "code": "interface OpenAgentRequestIdentity {\n did: Did;\n proof: string;\n nonce?: string;\n context?: Record;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 23, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "openagentrequestidentity" }, { "name": "VerifiedIdentity", "declarationName": "VerifiedIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of running the auth pipeline against an incoming MCP request.\nAvailable to post-call hooks and audit log emitters.", "tags": [], "signatures": [ { "code": "interface VerifiedIdentity {\n did: Did;\n scopes: ReadonlyArray;\n auditId: string;\n claims: Readonly>;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 47, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "verifiedidentity" } ], "coverage": { "discovered": 4, "documented": 4, "missing": [] } }, { "subpath": "./errors", "importSpecifier": "@openagentid/mcp/errors", "page": "/reference/typescript/mcp/errors", "kind": "declarations", "conditions": { "types": "./dist/errors.d.ts", "import": "./dist/errors.js", "require": "./dist/errors.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/errors.d.ts" }, { "conditions": [ "import" ], "path": "./dist/errors.js" }, { "conditions": [ "require" ], "path": "./dist/errors.cjs" } ], "exports": [ { "name": "AuthorizationDeniedError", "declarationName": "AuthorizationDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Caller's verified identity does not hold the required scopes.", "tags": [], "signatures": [ { "code": "declare class AuthorizationDeniedError extends OpenAgentMcpError {\n constructor(toolName: string, requiredScopes: ReadonlyArray, heldScopes: ReadonlyArray);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 56, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "authorizationdeniederror" }, { "name": "IdentityVerificationError", "declarationName": "IdentityVerificationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Identity envelope was present but the verifier rejected it.", "tags": [], "signatures": [ { "code": "declare class IdentityVerificationError extends OpenAgentMcpError {\n constructor(toolName: string, cause: unknown);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 52, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "identityverificationerror" }, { "name": "McpErrorCode", "declarationName": "McpErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard JSON-RPC + MCP error codes used by the middleware.", "tags": [], "signatures": [ { "code": "declare const McpErrorCode: {\n readonly InvalidRequest: -32600;\n readonly MethodNotFound: -32601;\n readonly InvalidParams: -32602;\n readonly InternalError: -32603;\n readonly ServerError: -32000;\n readonly AuthenticationFailed: -32001;\n readonly AuthorizationDenied: -32002;\n readonly SkillsPolicyDenied: -32003;\n};", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 10, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "mcperrorcode" }, { "name": "McpErrorCodeValue", "declarationName": "McpErrorCodeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type McpErrorCodeValue = (typeof McpErrorCode)[keyof typeof McpErrorCode];", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 28, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "mcperrorcodevalue" }, { "name": "MissingIdentityError", "declarationName": "MissingIdentityError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Caller did not present an OpenAgent identity envelope.", "tags": [], "signatures": [ { "code": "declare class MissingIdentityError extends OpenAgentMcpError {\n constructor(toolName: string);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 48, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "missingidentityerror" }, { "name": "OpenAgentMcpError", "declarationName": "OpenAgentMcpError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Base class for all middleware errors. Subclasses set a default\n{@link OpenAgentMcpError.code} that maps to a JSON-RPC error code.", "tags": [], "signatures": [ { "code": "declare class OpenAgentMcpError extends Error {\n readonly code: McpErrorCodeValue;\n readonly data?: Record;\n constructor(message: string, code: McpErrorCodeValue, data?: Record);\n toJsonRpcError(): {\n code: McpErrorCodeValue;\n message: string;\n data?: Record;\n };\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 33, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "openagentmcperror" }, { "name": "SkillsPolicyDeniedError", "declarationName": "SkillsPolicyDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Skills policy hook returned `allow: false`.", "tags": [], "signatures": [ { "code": "declare class SkillsPolicyDeniedError extends OpenAgentMcpError {\n constructor(toolName: string, reason: string | undefined);\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 60, "sha256": "43733d3f3b094e70ac7c87c80d31d46bb8852ac8f4f36beee5c4b7bce2fa9a72" } } ], "anchor": "skillspolicydeniederror" } ], "supportingDeclarations": [], "coverage": { "discovered": 7, "documented": 7, "missing": [] } }, { "subpath": "./skills", "importSpecifier": "@openagentid/mcp/skills", "page": "/reference/typescript/mcp/skills", "kind": "declarations", "conditions": { "types": "./dist/skills.d.ts", "import": "./dist/skills.js", "require": "./dist/skills.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/skills.d.ts" }, { "conditions": [ "import" ], "path": "./dist/skills.js" }, { "conditions": [ "require" ], "path": "./dist/skills.cjs" } ], "exports": [ { "name": "combineSkillsPolicies", "declarationName": "combineSkillsPolicies", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compose two skills policy hooks. The combined hook denies if either\nunderlying hook denies; allow decisions from `first` are forwarded to\n`second`.", "tags": [], "signatures": [ { "code": "declare function combineSkillsPolicies(first: SkillsPolicyHook, second: SkillsPolicyHook): SkillsPolicyHook;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 85, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "combineskillspolicies" }, { "name": "createSkillsPolicy", "declarationName": "createSkillsPolicy", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a {@link SkillsPolicyHook} from a store and matching options.\n\nThe returned hook always allows tools that are not skill-like; it only\nconsults the store when {@link CreateSkillsPolicyOptions.isSkillTool}\nreturns true.", "tags": [], "signatures": [ { "code": "declare function createSkillsPolicy(options: CreateSkillsPolicyOptions): SkillsPolicyHook;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 79, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "createskillspolicy" }, { "name": "CreateSkillsPolicyOptions", "declarationName": "CreateSkillsPolicyOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreateSkillsPolicyOptions {\n store: SkillsPolicyStore;\n isSkillTool?: (toolName: string) => boolean;\n extractSkillName?: (args: unknown) => string | null;\n defaultDecision?: SkillsPolicyDecision;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 52, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "createskillspolicyoptions" }, { "name": "DEFAULT_SKILL_TOOL_NAMES", "declarationName": "DEFAULT_SKILL_TOOL_NAMES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Tool name prefixes that the middleware treats as skill-like by default.\nHost applications can override the matcher entirely via\n{@link createSkillsPolicy}.", "tags": [], "signatures": [ { "code": "declare const DEFAULT_SKILL_TOOL_NAMES: ReadonlyArray;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 21, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "default_skill_tool_names" }, { "name": "InMemorySkillsPolicyStore", "declarationName": "InMemorySkillsPolicyStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Trivial in-memory store useful in tests and as a starting point for\nproduction stores.", "tags": [], "signatures": [ { "code": "declare class InMemorySkillsPolicyStore implements SkillsPolicyStore {\n constructor(rules?: ReadonlyArray);\n lookup(skillName: string): SkillsRule | null;\n withRule(rule: SkillsRule): InMemorySkillsPolicyStore;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 45, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "inmemoryskillspolicystore" }, { "name": "SkillsPolicyDecision", "declarationName": "SkillsPolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SkillsPolicyDecision {\n allow: boolean;\n reason?: string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 100, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicydecision" }, { "name": "SkillsPolicyHook", "declarationName": "SkillsPolicyHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook signature for the skills policy. The hook receives the tool name,\nthe arguments, and the verified identity, and decides whether the call\nshould be allowed.", "tags": [], "signatures": [ { "code": "type SkillsPolicyHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n}) => Promise | SkillsPolicyDecision;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 95, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicyhook" }, { "name": "SkillsPolicyStore", "declarationName": "SkillsPolicyStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Policy store interface — implementations may be in-memory, file-backed\nby `SKILLS.md`, or fetched from a remote service.", "tags": [], "signatures": [ { "code": "interface SkillsPolicyStore {\n lookup(skillName: string): Promise | SkillsRule | null;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 38, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "skillspolicystore" }, { "name": "SkillsRule", "declarationName": "SkillsRule", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single rule describing whether a `(skillName, did)` pair is allowed.\n`null` for `dids` means \"any verified caller\". An empty array means\n\"no caller\".", "tags": [], "signatures": [ { "code": "interface SkillsRule {\n skillName: string;\n dids: ReadonlyArray | null;\n reason?: string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/skills.d.ts", "line": 27, "sha256": "07e8cbf056603feb5a3fb12bfc90ee1848cdce2389a759112789ea471fa6a410" } } ], "anchor": "skillsrule" }, { "name": "VerifiedIdentity", "declarationName": "VerifiedIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of running the auth pipeline against an incoming MCP request.\nAvailable to post-call hooks and audit log emitters.", "tags": [], "signatures": [ { "code": "interface VerifiedIdentity {\n did: Did;\n scopes: ReadonlyArray;\n auditId: string;\n claims: Readonly>;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 47, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "verifiedidentity" } ], "supportingDeclarations": [ { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A decentralized identifier following the `did:oas:*` method or any other\nDID method understood by the configured verifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 17, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "did" } ], "coverage": { "discovered": 10, "documented": 10, "missing": [] } }, { "subpath": "./types", "importSpecifier": "@openagentid/mcp/types", "page": "/reference/typescript/mcp/types", "kind": "declarations", "conditions": { "types": "./dist/types.d.ts", "import": "./dist/types.js", "require": "./dist/types.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/types.d.ts" }, { "conditions": [ "import" ], "path": "./dist/types.js" }, { "conditions": [ "require" ], "path": "./dist/types.cjs" } ], "exports": [ { "name": "Agent", "declarationName": "Agent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Minimal Agent surface — only the parts of the OpenAgent SDK Agent that\nthe MCP middleware actually needs.", "tags": [], "signatures": [ { "code": "interface Agent {\n did: Did;\n verifier: IdentityVerifier;\n signRequest(toolName: string, audience?: Did): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 69, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "agent" }, { "name": "AuditedResultMeta", "declarationName": "AuditedResultMeta", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result envelope returned by an authenticated tool call. The `auditId` is\npushed into `_meta.openagent.audit_id` on the response, so callers can\ncorrelate logs end-to-end.", "tags": [], "signatures": [ { "code": "interface AuditedResultMeta {\n audit_id: string;\n verified_did: Did;\n scopes: ReadonlyArray;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 83, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "auditedresultmeta" }, { "name": "defaultRequireScopes", "declarationName": "defaultRequireScopes", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default scope deriver used when {@link OpenAgentMcpConfig.requireScopes}\nis not supplied.", "tags": [], "signatures": [ { "code": "declare const defaultRequireScopes: (toolName: string) => ReadonlyArray;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 177, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "defaultrequirescopes" }, { "name": "defaultScopeFormat", "declarationName": "defaultScopeFormat", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default scope format used when {@link OpenAgentMcpConfig.scopeFormat} is\nnot supplied.", "tags": [], "signatures": [ { "code": "declare const defaultScopeFormat: (toolName: string) => string;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 172, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "defaultscopeformat" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A decentralized identifier following the `did:oas:*` method or any other\nDID method understood by the configured verifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 17, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "did" }, { "name": "ErrorHook", "declarationName": "ErrorHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired when the tool body or any earlier middleware step throws.\nThe middleware re-throws the error after running this hook so MCP\nclients still observe the original failure mode.", "tags": [], "signatures": [ { "code": "type ErrorHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity | null;\n error: unknown;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 130, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "errorhook" }, { "name": "IdentityVerifier", "declarationName": "IdentityVerifier", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The verifier interface — implemented by `@openagentid/sdk` (production) and\nby the in-memory test agent shipped here.\n\nImplementations MUST be deterministic for a given input and MUST NOT\nmutate the request identity object.", "tags": [], "signatures": [ { "code": "interface IdentityVerifier {\n verify(identity: OpenAgentRequestIdentity, requiredScopes: ReadonlyArray): Promise;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 62, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "identityverifier" }, { "name": "OpenAgentMcpConfig", "declarationName": "OpenAgentMcpConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for {@link withOpenAgent }.", "tags": [], "signatures": [ { "code": "interface OpenAgentMcpConfig {\n agent: Agent;\n requireScopes?: ScopeDeriver;\n requireIdentity?: boolean;\n skillsPolicy?: SkillsPolicyHook;\n preCall?: PreCallHook;\n postCall?: PostCallHook;\n onError?: ErrorHook;\n scopeFormat?: (toolName: string) => string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 139, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "openagentmcpconfig" }, { "name": "OpenAgentRequestIdentity", "declarationName": "OpenAgentRequestIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The four pieces of metadata an MCP request carries about the calling\nagent. Populated by the {@link createClientInterceptor } on the call site\nand consumed by the server middleware.", "tags": [], "signatures": [ { "code": "interface OpenAgentRequestIdentity {\n did: Did;\n proof: string;\n nonce?: string;\n context?: Record;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 23, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "openagentrequestidentity" }, { "name": "PostCallHook", "declarationName": "PostCallHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired after a tool body executes successfully. Use it for audit\nlogging, metrics, and trace propagation. Throwing from this hook does\nNOT roll back the tool call.", "tags": [], "signatures": [ { "code": "type PostCallHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n durationMs: number;\n result: unknown;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 118, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "postcallhook" }, { "name": "PreCallHook", "declarationName": "PreCallHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook fired before a tool body executes — after the identity has been\nverified and the skills policy has approved the call.", "tags": [], "signatures": [ { "code": "type PreCallHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n}) => Promise | void;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 108, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "precallhook" }, { "name": "ScopeDeriver", "declarationName": "ScopeDeriver", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Per-tool scope deriver.", "tags": [], "signatures": [ { "code": "type ScopeDeriver = (toolName: string, args: unknown) => ReadonlyArray;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 89, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "scopederiver" }, { "name": "SkillsPolicyDecision", "declarationName": "SkillsPolicyDecision", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SkillsPolicyDecision {\n allow: boolean;\n reason?: string;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 100, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicydecision" }, { "name": "SkillsPolicyHook", "declarationName": "SkillsPolicyHook", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook signature for the skills policy. The hook receives the tool name,\nthe arguments, and the verified identity, and decides whether the call\nshould be allowed.", "tags": [], "signatures": [ { "code": "type SkillsPolicyHook = (input: {\n toolName: string;\n args: unknown;\n identity: VerifiedIdentity;\n}) => Promise | SkillsPolicyDecision;", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 95, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "skillspolicyhook" }, { "name": "VerifiedIdentity", "declarationName": "VerifiedIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of running the auth pipeline against an incoming MCP request.\nAvailable to post-call hooks and audit log emitters.", "tags": [], "signatures": [ { "code": "interface VerifiedIdentity {\n did: Did;\n scopes: ReadonlyArray;\n auditId: string;\n claims: Readonly>;\n}", "source": { "package": "@openagentid/mcp", "version": "0.1.1", "file": "dist/types.d.ts", "line": 47, "sha256": "d1447d44173214458afeb881b6679ee42f5e383f4a6b38b20fb77a116d0e5999" } } ], "anchor": "verifiedidentity" } ], "supportingDeclarations": [], "coverage": { "discovered": 15, "documented": 15, "missing": [] } } ] }, { "name": "@openagentid/oas-attestation", "version": "1.0.2", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oas-attestation/-/oas-attestation-1.0.2.tgz", "integrity": "sha512-hJnGTwMMCqdO0vN1CIuD/SX1vaTfqMC8DnY/0w9gQ139jirIFw/rkbQQCzzBNUn6RYfqs94egefZwefUbuSdjQ==", "packageJsonSha256": "1e0ea0aff663511d40b73730a5b7d2279560ea3e22d1fa7bd12ee038848cca0c", "page": "/reference/typescript/oas-attestation", "engines": { "node": ">=20" }, "dependencies": { "@openagentid/oas-did": "1.0.2", "@openagentid/oas-crypto": "1.0.2" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-attestation", "page": "/reference/typescript/oas-attestation", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "AttestationError", "declarationName": "AttestationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for attestation operations.", "tags": [], "signatures": [ { "code": "export declare class AttestationError extends Error {\n readonly code: AttestationErrorCode;\n readonly details: Readonly>;\n constructor(code: AttestationErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/error.d.ts", "line": 32, "sha256": "949a9230827528610d16752c10a687f956612c85a1a3cd64defdd6e81f339c9f" } } ], "anchor": "attestationerror" }, { "name": "AttestationErrorCode", "declarationName": "AttestationErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for attestation operations.", "tags": [], "signatures": [ { "code": "declare const AttestationErrorCode: {\n readonly InvalidIssuer: \"INVALID_ISSUER\";\n readonly InvalidSubject: \"INVALID_SUBJECT\";\n readonly UnknownAttestationType: \"UNKNOWN_ATTESTATION_TYPE\";\n readonly MissingProof: \"MISSING_PROOF\";\n readonly InvalidProofSignature: \"INVALID_PROOF_SIGNATURE\";\n readonly ProofGenerationFailed: \"PROOF_GENERATION_FAILED\";\n readonly Expired: \"EXPIRED\";\n readonly NotYetValid: \"NOT_YET_VALID\";\n readonly MissingField: \"MISSING_FIELD\";\n readonly Json: \"JSON_ERROR\";\n readonly Crypto: \"CRYPTO_ERROR\";\n};", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/error.d.ts", "line": 4, "sha256": "949a9230827528610d16752c10a687f956612c85a1a3cd64defdd6e81f339c9f" } }, { "code": "export type AttestationErrorCode = (typeof AttestationErrorCode)[keyof typeof AttestationErrorCode];", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/error.d.ts", "line": 28, "sha256": "949a9230827528610d16752c10a687f956612c85a1a3cd64defdd6e81f339c9f" } } ], "anchor": "attestationerrorcode" }, { "name": "AttestationType", "declarationName": "AttestationType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard OAS attestation types.\n\nThese represent the categories of verifiable claims that can be made\nabout OAS entities.", "tags": [], "signatures": [ { "code": "declare const AttestationType: {\n readonly SecurityAudit: \"SecurityAudit\";\n readonly BehaviorAttestation: \"BehaviorAttestation\";\n readonly CapabilityVerification: \"CapabilityVerification\";\n readonly ComplianceAttestation: \"ComplianceAttestation\";\n readonly ExpertEndorsement: \"ExpertEndorsement\";\n readonly CommunityReview: \"CommunityReview\";\n};", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 7, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "attestationtype" }, { "name": "AttestationTypeValue", "declarationName": "AttestationTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Union of standard attestation types and custom strings.", "tags": [], "signatures": [ { "code": "export type AttestationTypeValue = StandardAttestationType | `Custom:${string}`;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 25, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "attestationtypevalue" }, { "name": "CredentialBuilder", "declarationName": "CredentialBuilder", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Fluent builder for constructing OAS Verifiable Credentials.", "tags": [ { "name": "example", "text": "```ts\nimport { CredentialBuilder, AttestationType } from '@openagentid/oas-attestation';\n\nconst credential = new CredentialBuilder()\n .issuer('did:oas:l1fe:hmr:alice')\n .issuanceDate('2026-01-01T00:00:00Z')\n .attestationType(AttestationType.SecurityAudit)\n .subject({\n id: 'did:oas:l1fe:agent:bot',\n auditor: 'SecureCo',\n scope: 'full',\n findings: 'no critical issues',\n })\n .build();\n```" } ], "signatures": [ { "code": "export declare class CredentialBuilder {\n issuer(did: string): this;\n issuanceDate(date: string): this;\n expirationDate(date: string): this;\n subject(claims: Record): this;\n attestationType(type: AttestationTypeValue): this;\n build(): OasCredential;\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 69, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "credentialbuilder" }, { "name": "CredentialProof", "declarationName": "CredentialProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A proof attached to an OAS credential.", "tags": [], "signatures": [ { "code": "export interface CredentialProof {\n readonly type: 'Ed25519Signature2020';\n readonly created: string;\n readonly verificationMethod: string;\n readonly proofPurpose: 'assertionMethod';\n readonly proofValue: string;\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 13, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "credentialproof" }, { "name": "OAS_ATTESTATION_CONTEXT", "declarationName": "OAS_ATTESTATION_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS Attestation context.", "tags": [], "signatures": [ { "code": "declare const OAS_ATTESTATION_CONTEXT: \"https://openagent.id/ns/attestation/v1\";", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 9, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "oas_attestation_context" }, { "name": "OasCredential", "declarationName": "OasCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS Verifiable Credential.\n\nExtends the W3C Verifiable Credentials model with OAS-specific\nattestation types. Credentials are immutable once signed.", "tags": [], "signatures": [ { "code": "export interface OasCredential {\n readonly '@context': ReadonlyArray;\n readonly type: ReadonlyArray;\n readonly issuer: string;\n readonly issuanceDate: string;\n readonly expirationDate?: string | undefined;\n readonly credentialSubject: Readonly>;\n readonly oasAttestationType?: AttestationTypeValue | undefined;\n readonly proof?: CredentialProof | undefined;\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 31, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "oascredential" }, { "name": "requiredFields", "declarationName": "requiredFields", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the required fields for a given attestation type.", "tags": [ { "name": "param", "text": "type - The attestation type." }, { "name": "returns", "text": "An array of required field names, or an empty array for custom types." } ], "signatures": [ { "code": "export declare function requiredFields(type: AttestationTypeValue): ReadonlyArray;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 32, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "requiredfields" }, { "name": "signCredential", "declarationName": "signCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Signs an OAS Verifiable Credential with an Ed25519 keypair.\n\nThe credential is JCS-canonicalized (without the proof field), signed,\nand a proof is attached. The attestation type's required fields are\nvalidated before signing.", "tags": [ { "name": "param", "text": "credential - The unsigned credential to sign." }, { "name": "param", "text": "keypair - The issuer's Ed25519 keypair." }, { "name": "param", "text": "verificationMethodId - The VM ID to reference in the proof." }, { "name": "param", "text": "created - ISO 8601 timestamp for the proof." }, { "name": "returns", "text": "A new frozen {@link OasCredential} with proof attached." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} on validation or signing failure." }, { "name": "example", "text": "```ts\nimport { CredentialBuilder, signCredential, AttestationType } from '@openagentid/oas-attestation';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst kp = OasKeyPair.generate();\nconst unsigned = new CredentialBuilder()\n .issuer('did:oas:l1fe:hmr:alice')\n .issuanceDate('2026-01-01T00:00:00Z')\n .attestationType(AttestationType.SecurityAudit)\n .subject({\n id: 'did:oas:l1fe:agent:bot',\n auditor: 'SecureCo',\n scope: 'full',\n findings: 'none',\n })\n .build();\n\nconst signed = signCredential(\n unsigned,\n kp,\n 'did:oas:l1fe:hmr:alice#key-1',\n '2026-01-01T00:00:00Z',\n);\nconsole.log(signed.proof?.type); // 'Ed25519Signature2020'\n```" } ], "signatures": [ { "code": "export declare function signCredential(credential: OasCredential, keypair: OasKeyPair, verificationMethodId: string, created: string): Promise;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/sign.d.ts", "line": 44, "sha256": "a84d68e97287c255d5c6a7897135744849e8c2f8b6a0cd8d0e7679246c0cd897" } } ], "anchor": "signcredential" }, { "name": "StandardAttestationType", "declarationName": "StandardAttestationType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type StandardAttestationType = (typeof AttestationType)[keyof typeof AttestationType];", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 21, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "standardattestationtype" }, { "name": "validateSubject", "declarationName": "validateSubject", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates that a credential subject contains all required fields for its type.", "tags": [ { "name": "param", "text": "type - The attestation type." }, { "name": "param", "text": "subject - The credential subject claims." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} if required fields are missing." } ], "signatures": [ { "code": "export declare function validateSubject(type: AttestationTypeValue, subject: Record): void;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 40, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "validatesubject" }, { "name": "VC_CONTEXT", "declarationName": "VC_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "W3C Verifiable Credential context.", "tags": [], "signatures": [ { "code": "declare const VC_CONTEXT: \"https://www.w3.org/2018/credentials/v1\";", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 5, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "vc_context" }, { "name": "verifyCredential", "declarationName": "verifyCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies an OAS Verifiable Credential's proof signature.", "tags": [ { "name": "param", "text": "credential - The signed credential to verify." }, { "name": "param", "text": "issuerPublicKeyBytes - The issuer's 32-byte Ed25519 public key." }, { "name": "returns", "text": "`true` if the proof signature is valid." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} if the credential is missing a proof." }, { "name": "example", "text": "```ts\nimport { verifyCredential } from '@openagentid/oas-attestation';\n\nconst valid = verifyCredential(signedCredential, issuerPublicKey);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export declare function verifyCredential(credential: OasCredential, issuerPublicKeyBytes: Uint8Array): Promise;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 18, "sha256": "7eab3bec44bd35064586baa34aaa278ff90d8d41e798de09e55f84cbd6ac7b93" } } ], "anchor": "verifycredential" }, { "name": "verifyCredentialWithTime", "declarationName": "verifyCredentialWithTime", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a credential with temporal validation.\n\nIn addition to signature verification, checks:\n- The credential is not expired (if `expirationDate` is set)\n- The credential issuance date is not in the future", "tags": [ { "name": "param", "text": "credential - The signed credential to verify." }, { "name": "param", "text": "issuerPublicKeyBytes - The issuer's 32-byte Ed25519 public key." }, { "name": "param", "text": "now - The current time as an ISO 8601 string." }, { "name": "returns", "text": "`true` if the credential is valid (signature + temporal)." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} if temporal checks fail." } ], "signatures": [ { "code": "export declare function verifyCredentialWithTime(credential: OasCredential, issuerPublicKeyBytes: Uint8Array, now: string): Promise;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 32, "sha256": "7eab3bec44bd35064586baa34aaa278ff90d8d41e798de09e55f84cbd6ac7b93" } } ], "anchor": "verifycredentialwithtime" } ], "supportingDeclarations": [ { "name": "OasKeyPair", "declarationName": "OasKeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 keypair for an OAS entity.\n\nHolds both the signing (private) and verifying (public) keys. The signing key\nis stored as a `Uint8Array` and should be zeroed when no longer needed.\n\n## Security\n\n- Private key bytes are never exposed via `toString()` or `toJSON()`\n- All signature operations use constant-time comparison internally via `@noble/ed25519`\n- Callers should zero the signing key bytes when the keypair is no longer needed:\n `keypair.signingKeyBytes.fill(0)`", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst keypair = await OasKeyPair.generate();\nconst message = new TextEncoder().encode('hello OAS');\nconst signature = await keypair.sign(message);\nconst valid = await OasKeyPair.verifyWithKey(keypair.verifyingKeyBytes, message, signature);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export declare class OasKeyPair {\n static generate(): Promise;\n static fromSigningKeyBytes(bytes: Uint8Array): Promise;\n static verifyingKeyFromBytes(bytes: Uint8Array): Uint8Array;\n sign(message: Uint8Array): Promise;\n static verifyWithKey(publicKeyBytes: Uint8Array, message: Uint8Array, signatureBytes: Uint8Array): Promise;\n get signingKeyBytes(): Uint8Array;\n get verifyingKeyBytes(): Uint8Array;\n publicKeyMultibase(): string;\n toString(): string;\n toJSON(): {\n verifyingKey: string;\n };\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/keypair.d.ts", "line": 25, "sha256": "c143b2ad5ee896897ce3d3e1b554b720354d7351b408205370a4b7a9f8c2139b" } } ], "anchor": "oaskeypair" } ], "coverage": { "discovered": 15, "documented": 15, "missing": [] } } ] }, { "name": "@openagentid/oas-crypto", "version": "1.0.2", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oas-crypto/-/oas-crypto-1.0.2.tgz", "integrity": "sha512-wonLqeCyTwARFvroLOe8NoFfLOzmxXLABbTM4fxAZrVbb3cVkCunOx4N+IbhZjFYh6N1YPUbPa0QE8IJUkX5SA==", "packageJsonSha256": "d5634f32bef2594bdd35b8f3dcd3209782009d30eb8f939c63e238685ec5a62f", "page": "/reference/typescript/oas-crypto", "engines": { "node": ">=20" }, "dependencies": { "@noble/ed25519": "2.1.0", "@noble/hashes": "1.6.1", "@scure/base": "1.2.1" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-crypto", "page": "/reference/typescript/oas-crypto", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "AgentLineageProof provides generation and verification of OAS lineage proofs.\n\nSee OAS Specification §9.4 (generation) and §9.5 (verification).", "tags": [], "signatures": [ { "code": "declare const AgentLineageProof: {\n readonly generate: (parentKeypair: OasKeyPair, parentDid: string, childDid: string, derivationPath: string) => Promise;\n readonly verify: (proof: AgentLineageProofData) => Promise;\n readonly verifyWithKey: (proof: AgentLineageProofData, publicKeyMultibase: string) => Promise;\n readonly toJSON: (proof: AgentLineageProofData) => Record;\n readonly fromJSON: (obj: Record) => AgentLineageProofData;\n};", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 61, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "agentlineageproof" }, { "name": "AgentLineageProofData", "declarationName": "AgentLineageProofData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verifiable proof linking a child entity to its parent in the OAS lineage chain.\n\n`AgentLineageProof2025` establishes cryptographic accountability by proving that\na parent entity authorized the creation of a child entity at a specific derivation path.\n\nThe proof contains:\n- The parent and child DIDs\n- The derivation path used for HKDF key derivation\n- The parent's public key (multibase-encoded)\n- An Ed25519 signature over the canonical proof payload\n\nSee OAS Specification §9.4, §9.5 for the complete proof format.", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair, AgentLineageProof } from '@openagentid/oas-crypto';\n\nconst parent = await OasKeyPair.generate();\nconst proof = await AgentLineageProof.generate(\n parent,\n 'did:oas:l1fe:hmr:alice',\n 'did:oas:l1fe:agent:my-bot',\n '/agent-my-bot',\n);\n\nconst valid = await AgentLineageProof.verify(proof);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export interface AgentLineageProofData {\n readonly proofType: typeof PROOF_TYPE;\n readonly parentDid: string;\n readonly childDid: string;\n readonly derivationPath: string;\n readonly algorithm: typeof PROOF_ALGORITHM;\n readonly publicKeyMultibase: string;\n readonly signature: string;\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 40, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "agentlineageproofdata" }, { "name": "base64urlDecode", "declarationName": "base64urlDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a base64url string (RFC 4648 §5, no padding) to bytes.", "tags": [ { "name": "param", "text": "encoded - The base64url-encoded string." }, { "name": "returns", "text": "The decoded bytes." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.Base64DecodeFailed } on failure." }, { "name": "example", "text": "```ts\nimport { base64urlEncode, base64urlDecode } from '@openagentid/oas-crypto';\n\nconst original = new Uint8Array([72, 101, 108, 108, 111]);\nconst decoded = base64urlDecode(base64urlEncode(original));\n// decoded equals original\n```" } ], "signatures": [ { "code": "export declare function base64urlDecode(encoded: string): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 68, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "base64urldecode" }, { "name": "base64urlEncode", "declarationName": "base64urlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as base64url (RFC 4648 §5, no padding).", "tags": [ { "name": "param", "text": "bytes - The bytes to encode." }, { "name": "returns", "text": "The base64url-encoded string without padding." }, { "name": "example", "text": "```ts\nimport { base64urlEncode } from '@openagentid/oas-crypto';\n\nconst encoded = base64urlEncode(new Uint8Array([72, 101, 108, 108, 111]));\nconsole.log(encoded); // 'SGVsbG8'\n```" } ], "signatures": [ { "code": "export declare function base64urlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 51, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "base64urlencode" }, { "name": "blake3Hash", "declarationName": "blake3Hash", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes a BLAKE3 hash of the input bytes.\n\nBLAKE3 is the OAS-mandated content hashing algorithm, providing\nfast, cryptographically secure hashes.", "tags": [ { "name": "param", "text": "data - The bytes to hash." }, { "name": "returns", "text": "A 32-byte BLAKE3 hash." }, { "name": "example", "text": "```ts\nimport { blake3Hash } from '@openagentid/oas-crypto';\n\nconst hash = blake3Hash(new Uint8Array([72, 101, 108, 108, 111]));\nconsole.log(hash.length); // 32\n```" } ], "signatures": [ { "code": "export declare function blake3Hash(data: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/hashing.d.ts", "line": 18, "sha256": "8781459213c92c62e363bf15ed51b38bd54cdc1fdc06adae4cac4b37b4e701e2" } } ], "anchor": "blake3hash" }, { "name": "blake3HashHex", "declarationName": "blake3HashHex", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes a BLAKE3 hash and returns it as a lowercase hex string.", "tags": [ { "name": "param", "text": "data - The bytes to hash." }, { "name": "returns", "text": "A 64-character lowercase hex string." }, { "name": "example", "text": "```ts\nimport { blake3HashHex } from '@openagentid/oas-crypto';\n\nconst hex = blake3HashHex(new Uint8Array(0));\nconsole.log(hex); // 'af1349b9f5f9a1a6a0404dea36dcc9499bcb25c9adc112b7cc9a93cae41f3262'\n```" } ], "signatures": [ { "code": "export declare function blake3HashHex(data: Uint8Array): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/hashing.d.ts", "line": 33, "sha256": "8781459213c92c62e363bf15ed51b38bd54cdc1fdc06adae4cac4b37b4e701e2" } } ], "anchor": "blake3hashhex" }, { "name": "CryptoError", "declarationName": "CryptoError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for OAS cryptographic operations.\n\nEvery instance carries a machine-readable {@link CryptoErrorCode} and\na human-readable message with enough context to diagnose the issue\nwithout exposing sensitive key material.", "tags": [ { "name": "example", "text": "```ts\nimport { CryptoError, CryptoErrorCode } from '@openagentid/oas-crypto';\n\nconst err = new CryptoError(\n CryptoErrorCode.InvalidSignature,\n 'lineage proof verification'\n);\nconsole.log(err.code); // 'INVALID_SIGNATURE'\n```" } ], "signatures": [ { "code": "export declare class CryptoError extends Error {\n readonly code: CryptoErrorCode;\n readonly details: Readonly>;\n constructor(code: CryptoErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/error.d.ts", "line": 43, "sha256": "2a687f6333991709d6e3d3e190abb1d8c4f44560ed7a22c6ba6a1ef4aad9e07d" } } ], "anchor": "cryptoerror" }, { "name": "CryptoErrorCode", "declarationName": "CryptoErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS cryptographic operations.\n\nMachine-readable codes for programmatic error matching.", "tags": [], "signatures": [ { "code": "declare const CryptoErrorCode: {\n readonly InvalidSignature: \"INVALID_SIGNATURE\";\n readonly InvalidKeyLength: \"INVALID_KEY_LENGTH\";\n readonly DerivationFailed: \"DERIVATION_FAILED\";\n readonly MultibaseDecodeFailed: \"MULTIBASE_DECODE_FAILED\";\n readonly Base64DecodeFailed: \"BASE64_DECODE_FAILED\";\n readonly CanonicalizationFailed: \"CANONICALIZATION_FAILED\";\n readonly InvalidProofPayload: \"INVALID_PROOF_PAYLOAD\";\n readonly KeyConstructionFailed: \"KEY_CONSTRUCTION_FAILED\";\n};", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/error.d.ts", "line": 6, "sha256": "2a687f6333991709d6e3d3e190abb1d8c4f44560ed7a22c6ba6a1ef4aad9e07d" } }, { "code": "export type CryptoErrorCode = (typeof CryptoErrorCode)[keyof typeof CryptoErrorCode];", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/error.d.ts", "line": 24, "sha256": "2a687f6333991709d6e3d3e190abb1d8c4f44560ed7a22c6ba6a1ef4aad9e07d" } } ], "anchor": "cryptoerrorcode" }, { "name": "deriveChildKeypair", "declarationName": "deriveChildKeypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a child Ed25519 keypair from a parent keypair using HKDF-SHA256.\n\nThe derivation uses:\n- **IKM** (Input Keying Material): parent's signing (private) key bytes\n- **Salt**: parent's verifying (public) key bytes\n- **Info**: the derivation path string (UTF-8 encoded)\n\nThe output is 32 bytes of derived key material, used as the child's Ed25519\nsigning key. The child's verifying key is derived from the signing key.", "tags": [ { "name": "param", "text": "parent - The parent keypair providing the IKM and salt." }, { "name": "param", "text": "derivationPath - The derivation path string (e.g., `\"/agent-my-bot\"`)." }, { "name": "returns", "text": "A new {@link OasKeyPair} derived from the parent." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.DerivationFailed } on failure." }, { "name": "example", "text": "```ts\nimport { OasKeyPair, deriveChildKeypair } from '@openagentid/oas-crypto';\n\nconst parent = OasKeyPair.generate();\nconst child = deriveChildKeypair(parent, '/agent-my-bot');\n// child has a deterministic keypair derived from parent + path\n```" } ], "signatures": [ { "code": "export declare function deriveChildKeypair(parent: OasKeyPair, derivationPath: string): Promise;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/derivation.d.ts", "line": 27, "sha256": "0be2eef939c40a83569bdc5295bfd84f1552b8ec63b48b72ce3a65ea34201822" } } ], "anchor": "derivechildkeypair" }, { "name": "deriveKeyMaterial", "declarationName": "deriveKeyMaterial", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Low-level HKDF-SHA256 key material derivation.\n\nDerives 32 bytes of key material using HKDF-SHA256 (RFC 5869).", "tags": [ { "name": "param", "text": "ikm - Input Keying Material." }, { "name": "param", "text": "salt - Salt value." }, { "name": "param", "text": "info - Context and application-specific information." }, { "name": "returns", "text": "32 bytes of derived key material." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} on derivation failure." } ], "signatures": [ { "code": "export declare function deriveKeyMaterial(ikm: Uint8Array, salt: Uint8Array, info: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/derivation.d.ts", "line": 39, "sha256": "0be2eef939c40a83569bdc5295bfd84f1552b8ec63b48b72ce3a65ea34201822" } } ], "anchor": "derivekeymaterial" }, { "name": "jcsCanonicalize", "declarationName": "jcsCanonicalize", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Canonicalizes a JSON value to UTF-8 bytes according to RFC 8785.", "tags": [ { "name": "param", "text": "value - The JSON value to canonicalize." }, { "name": "returns", "text": "The JCS-canonicalized bytes." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.CanonicalizationFailed } on failure." }, { "name": "example", "text": "```ts\nimport { jcsCanonicalize } from '@openagentid/oas-crypto';\n\nconst bytes = jcsCanonicalize({ childDid: 'did:oas:l1fe:agent:bot' });\n// bytes is the UTF-8 encoding of the canonical JSON\n```" } ], "signatures": [ { "code": "export declare function jcsCanonicalize(value: unknown): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/jcs.d.ts", "line": 41, "sha256": "4834d038578cb7b07e800fc6ea5c6a58d96700f2f7270a91eae79dfb1afa0590" } } ], "anchor": "jcscanonicalize" }, { "name": "jcsCanonicalizeToString", "declarationName": "jcsCanonicalizeToString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Canonicalizes a JSON value according to RFC 8785 (JSON Canonicalization Scheme).\n\nJCS produces a deterministic, byte-for-byte identical serialization of\nany JSON value by applying these rules:\n- Object keys sorted lexicographically (by UTF-16 code units)\n- No whitespace between tokens\n- Numbers serialized per ES2015 `Number.toString()`\n- Strings escaped according to JSON spec (minimal escaping)\n- `null`, `true`, `false` as literals", "tags": [ { "name": "param", "text": "value - The JSON value to canonicalize." }, { "name": "returns", "text": "The JCS-canonicalized string." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.CanonicalizationFailed } if the value\n cannot be serialized (e.g., contains `undefined`, functions, or circular references)." }, { "name": "example", "text": "```ts\nimport { jcsCanonicalizeToString } from '@openagentid/oas-crypto';\n\nconst canonical = jcsCanonicalizeToString({ b: 2, a: 1 });\nconsole.log(canonical); // '{\"a\":1,\"b\":2}'\n```" } ], "signatures": [ { "code": "export declare function jcsCanonicalizeToString(value: unknown): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/jcs.d.ts", "line": 25, "sha256": "4834d038578cb7b07e800fc6ea5c6a58d96700f2f7270a91eae79dfb1afa0590" } } ], "anchor": "jcscanonicalizetostring" }, { "name": "multibaseDecode", "declarationName": "multibaseDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a multibase base58btc string (strips `z` prefix).", "tags": [ { "name": "param", "text": "encoded - The multibase-encoded string (must start with `z`)." }, { "name": "returns", "text": "The decoded bytes." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.MultibaseDecodeFailed } on failure." }, { "name": "example", "text": "```ts\nimport { multibaseEncode, multibaseDecode } from '@openagentid/oas-crypto';\n\nconst original = new Uint8Array([1, 2, 3]);\nconst encoded = multibaseEncode(original);\nconst decoded = multibaseDecode(encoded);\n// decoded equals original\n```" } ], "signatures": [ { "code": "export declare function multibaseDecode(encoded: string): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 36, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "multibasedecode" }, { "name": "multibaseEncode", "declarationName": "multibaseEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as multibase base58btc (with `z` prefix).\n\nThis is the canonical format for `publicKeyMultibase` in OAS Identity Documents.\nThe `z` prefix indicates base58btc encoding per the Multibase specification.", "tags": [ { "name": "param", "text": "bytes - The bytes to encode." }, { "name": "returns", "text": "The multibase-encoded string starting with `z`." }, { "name": "example", "text": "```ts\nimport { multibaseEncode } from '@openagentid/oas-crypto';\n\nconst encoded = multibaseEncode(new Uint8Array([1, 2, 3]));\nconsole.log(encoded.startsWith('z')); // true\n```" } ], "signatures": [ { "code": "export declare function multibaseEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 18, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "multibaseencode" }, { "name": "OasKeyPair", "declarationName": "OasKeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 keypair for an OAS entity.\n\nHolds both the signing (private) and verifying (public) keys. The signing key\nis stored as a `Uint8Array` and should be zeroed when no longer needed.\n\n## Security\n\n- Private key bytes are never exposed via `toString()` or `toJSON()`\n- All signature operations use constant-time comparison internally via `@noble/ed25519`\n- Callers should zero the signing key bytes when the keypair is no longer needed:\n `keypair.signingKeyBytes.fill(0)`", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst keypair = await OasKeyPair.generate();\nconst message = new TextEncoder().encode('hello OAS');\nconst signature = await keypair.sign(message);\nconst valid = await OasKeyPair.verifyWithKey(keypair.verifyingKeyBytes, message, signature);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export declare class OasKeyPair {\n static generate(): Promise;\n static fromSigningKeyBytes(bytes: Uint8Array): Promise;\n static verifyingKeyFromBytes(bytes: Uint8Array): Uint8Array;\n sign(message: Uint8Array): Promise;\n static verifyWithKey(publicKeyBytes: Uint8Array, message: Uint8Array, signatureBytes: Uint8Array): Promise;\n get signingKeyBytes(): Uint8Array;\n get verifyingKeyBytes(): Uint8Array;\n publicKeyMultibase(): string;\n toString(): string;\n toJSON(): {\n verifyingKey: string;\n };\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/keypair.d.ts", "line": 25, "sha256": "c143b2ad5ee896897ce3d3e1b554b720354d7351b408205370a4b7a9f8c2139b" } } ], "anchor": "oaskeypair" }, { "name": "PROOF_ALGORITHM", "declarationName": "PROOF_ALGORITHM", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The algorithm used for key derivation in lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_ALGORITHM: \"HKDF-SHA256-Ed25519\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 9, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_algorithm" }, { "name": "PROOF_TYPE", "declarationName": "PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The proof type identifier for OAS lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_TYPE: \"AgentLineageProof2025\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 5, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_type" } ], "supportingDeclarations": [], "coverage": { "discovered": 17, "documented": 17, "missing": [] } } ] }, { "name": "@openagentid/oas-did", "version": "1.0.2", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oas-did/-/oas-did-1.0.2.tgz", "integrity": "sha512-r2zBGPUb1/svcPNeCp54FABRz4J03XruDmzfeTwxQqHks9c2B7B5LJaLkn1E2P/1ub6uWVaIg6MnJkkTw8FRSA==", "packageJsonSha256": "ca8c269bc671f89945df8dff0bba40d92c0da725f42e7cfffa16dacc951907f7", "page": "/reference/typescript/oas-did", "engines": { "node": ">=20" }, "dependencies": {}, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-did", "page": "/reference/typescript/oas-did", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "deriveChildDidHkdf", "declarationName": "deriveChildDidHkdf", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Placeholder for HKDF-lineage child DID derivation.\n\nThe Rust SDK (`oas-sdk::lineage::derive_child`) performs HKDF-SHA256\nderivation to produce a child Ed25519 keypair from a parent. The TypeScript\nport lives inside `@forge-sdk/identity` as `deriveAgentIdentity` (via a\npluggable `CryptoBridge`) — this shim exists so callers importing from\n`@openagentid/oas-did` get an explicit, non-silent failure instead of a\nplaceholder DID.", "tags": [ { "name": "throws", "text": "Always — use `@forge-sdk/identity` or the Rust SDK instead." }, { "name": "internal", "text": "" } ], "signatures": [ { "code": "export declare function deriveChildDidHkdf(): never;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/generate.d.ts", "line": 122, "sha256": "294cd4754597a3c309121224ab606c903008d3d90ab03c551843390c27288149" } } ], "anchor": "derivechilddidhkdf" }, { "name": "DidError", "declarationName": "DidError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for DID parsing and validation failures.\n\nEvery instance carries a machine-readable {@link DidErrorCode} and a\nhuman-readable message with enough context to diagnose the issue.", "tags": [ { "name": "example", "text": "```ts\nimport { DidError, DidErrorCode } from '@openagentid/oas-did';\n\nconst err = new DidError(\n DidErrorCode.InvalidNamespace,\n \"namespace 'L1FE' contains uppercase characters; must be lowercase alphanumeric + hyphens\"\n);\nconsole.log(err.code); // 'INVALID_NAMESPACE'\n```" } ], "signatures": [ { "code": "export declare class DidError extends Error {\n readonly code: DidErrorCode;\n constructor(code: DidErrorCode, message: string);\n}", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/error.d.ts", "line": 39, "sha256": "ecdcd7c8a82aac16e7f1c9c436518911717cdd6a23b30a724594bd8623789408" } } ], "anchor": "diderror" }, { "name": "DidErrorCode", "declarationName": "DidErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for DID parsing and validation failures.\n\nThese string enum codes enable programmatic matching without\nrelying on error message string content.", "tags": [], "signatures": [ { "code": "declare const DidErrorCode: {\n readonly Empty: \"EMPTY\";\n readonly InvalidPrefix: \"INVALID_PREFIX\";\n readonly TooFewComponents: \"TOO_FEW_COMPONENTS\";\n readonly InvalidNamespace: \"INVALID_NAMESPACE\";\n readonly UnknownEntityKind: \"UNKNOWN_ENTITY_KIND\";\n readonly InvalidIdentifier: \"INVALID_IDENTIFIER\";\n};", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/error.d.ts", "line": 7, "sha256": "ecdcd7c8a82aac16e7f1c9c436518911717cdd6a23b30a724594bd8623789408" } }, { "code": "export type DidErrorCode = (typeof DidErrorCode)[keyof typeof DidErrorCode];", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/error.d.ts", "line": 21, "sha256": "ecdcd7c8a82aac16e7f1c9c436518911717cdd6a23b30a724594bd8623789408" } } ], "anchor": "diderrorcode" }, { "name": "ED25519_PUBLIC_KEY_LENGTH", "declarationName": "ED25519_PUBLIC_KEY_LENGTH", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Ed25519 public key length, in bytes (OAS Spec §11.1, RFC 8032 §5.1.5).", "tags": [], "signatures": [ { "code": "declare const ED25519_PUBLIC_KEY_LENGTH = 32;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/generate.d.ts", "line": 14, "sha256": "294cd4754597a3c309121224ab606c903008d3d90ab03c551843390c27288149" } } ], "anchor": "ed25519_public_key_length" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The set of recognized OAS entity kinds.\n\nEach entity kind represents a category of autonomous entity in the OAS\nidentity system. Root kinds ({@link EntityKind.Hmr}, {@link EntityKind.Mhr},\n{@link EntityKind.Enr}) are the trust anchors from which all other entities\nderive their lineage.", "tags": [ { "name": "example", "text": "```ts\nimport { EntityKind, entityKindFromString } from '@openagentid/oas-did';\n\nconst kind = entityKindFromString('agent');\nconsole.log(kind === EntityKind.Agent); // true\nconsole.log(isRootKind(kind)); // false\n```" } ], "signatures": [ { "code": "declare const EntityKind: {\n readonly Hmr: \"hmr\";\n readonly Mhr: \"mhr\";\n readonly Enr: \"enr\";\n readonly Ao: \"ao\";\n readonly Agent: \"agent\";\n readonly AgentInstance: \"agent:instance\";\n readonly Tool: \"tool\";\n readonly Skill: \"skill\";\n readonly Workflow: \"workflow\";\n readonly Model: \"model\";\n readonly Dataset: \"dataset\";\n readonly Service: \"service\";\n};", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 18, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } }, { "code": "export type EntityKind = (typeof EntityKind)[keyof typeof EntityKind];", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 44, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykind" }, { "name": "entityKindComponentCount", "declarationName": "entityKindComponentCount", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the number of colon-separated components in the kind string.\n\nSimple kinds (e.g., `\"agent\"`) have 1 component.\nCompound kinds (e.g., `\"agent:instance\"`) have 2 components.", "tags": [ { "name": "param", "text": "kind - The entity kind to inspect." }, { "name": "returns", "text": "The number of components (1 or 2)." } ], "signatures": [ { "code": "export declare function entityKindComponentCount(kind: EntityKind): number;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 101, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykindcomponentcount" }, { "name": "entityKindFromString", "declarationName": "entityKindFromString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parses a string into an {@link EntityKind}.\n\nHandles the compound `agent:instance` kind by accepting both\nthe full string and the two-part colon-separated form.", "tags": [ { "name": "param", "text": "s - The string to parse (e.g., `\"agent\"`, `\"agent:instance\"`, `\"hmr\"`)." }, { "name": "returns", "text": "The matching {@link EntityKind}, or `undefined` if the string is not recognized." }, { "name": "example", "text": "```ts\nimport { entityKindFromString, EntityKind } from '@openagentid/oas-did';\n\nconst kind = entityKindFromString('agent:instance');\nconsole.log(kind === EntityKind.AgentInstance); // true\n\nconst unknown = entityKindFromString('unknown');\nconsole.log(unknown); // undefined\n```" } ], "signatures": [ { "code": "export declare function entityKindFromString(s: string): EntityKind | undefined;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 65, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykindfromstring" }, { "name": "entityKindToString", "declarationName": "entityKindToString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the string representation of an entity kind.", "tags": [ { "name": "param", "text": "kind - The entity kind to convert." }, { "name": "returns", "text": "The canonical string form (e.g., `\"agent:instance\"`)." } ], "signatures": [ { "code": "export declare function entityKindToString(kind: EntityKind): string;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 72, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykindtostring" }, { "name": "generateDidOas", "declarationName": "generateDidOas", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Constructs a `did:oas:::` string.\n\nThe identifier is either taken verbatim from `options.identifier`, or\nderived from `options.publicKey` as multibase base58btc (prefix `z`).\n\nThis is a pure function — it does not touch I/O, crypto, or random state.\nOutput is byte-identical to the Rust SDK for the same inputs.", "tags": [ { "name": "param", "text": "options - See {@link GenerateDidOasOptions}." }, { "name": "returns", "text": "The canonical DID string." }, { "name": "throws", "text": "{DidError} If the namespace, identifier, or key length is invalid." }, { "name": "example", "text": "```ts\nimport { generateDidOas, EntityKind } from '@openagentid/oas-did';\n\n// Explicit identifier\nconst a = generateDidOas({\n namespace: 'prod',\n kind: EntityKind.Agent,\n identifier: 'analyzer',\n});\n// 'did:oas:prod:agent:analyzer'\n\n// Derived from a 32-byte Ed25519 public key\nconst b = generateDidOas({\n namespace: 'prod',\n kind: EntityKind.Hmr,\n publicKey: new Uint8Array(32),\n});\n// 'did:oas:prod:hmr:z11111111111111111111111111111111'\n```" } ], "signatures": [ { "code": "export declare function generateDidOas(options: GenerateDidOasOptions): string;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/generate.d.ts", "line": 94, "sha256": "294cd4754597a3c309121224ab606c903008d3d90ab03c551843390c27288149" } } ], "anchor": "generatedidoas" }, { "name": "GenerateDidOasOptions", "declarationName": "GenerateDidOasOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Arguments accepted by {@link generateDidOas}.\n\nEither provide an explicit human-readable `identifier` (e.g., `\"alice\"`,\n`\"my-bot\"`), or let the identifier be derived from the `publicKey` via\nmultibase base58btc encoding (OAS Spec §11.1).", "tags": [], "signatures": [ { "code": "export interface GenerateDidOasOptions {\n namespace: Namespace;\n kind: EntityKind;\n publicKey?: Uint8Array;\n identifier?: string;\n}", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/generate.d.ts", "line": 41, "sha256": "294cd4754597a3c309121224ab606c903008d3d90ab03c551843390c27288149" } } ], "anchor": "generatedidoasoptions" }, { "name": "generateFrostDid", "declarationName": "generateFrostDid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Placeholder for FROST threshold-signing DID derivation.\n\nFROST (`frost-ed25519`) is not yet ported to the TypeScript SDK. Callers\nthat require FROST-backed MHR or threshold-signed entities must use the\nRust SDK (`oas-crypto`) and hand the resulting DID back to the TypeScript\nsurface.", "tags": [ { "name": "throws", "text": "Always — FROST is not yet supported in the TS SDK." }, { "name": "internal", "text": "" } ], "signatures": [ { "code": "export declare function generateFrostDid(): never;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/generate.d.ts", "line": 107, "sha256": "294cd4754597a3c309121224ab606c903008d3d90ab03c551843390c27288149" } } ], "anchor": "generatefrostdid" }, { "name": "isReservedNamespace", "declarationName": "isReservedNamespace", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the namespace is in the reserved list.\n\nReserved namespaces (`oas`, `test`, `example`) are defined by the\nOAS specification and cannot be used for production entities.", "tags": [ { "name": "param", "text": "namespace - The namespace string to check." }, { "name": "returns", "text": "`true` if the namespace is reserved." }, { "name": "example", "text": "```ts\nimport { isReservedNamespace } from '@openagentid/oas-did';\n\nconsole.log(isReservedNamespace('test')); // true\nconsole.log(isReservedNamespace('l1fe')); // false\n```" } ], "signatures": [ { "code": "export declare function isReservedNamespace(namespace: string): boolean;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/namespace.d.ts", "line": 47, "sha256": "85af64a61c0e6bc5480d57074fff8d3eff1064f3c9ae5838480535a01a8f9be5" } } ], "anchor": "isreservednamespace" }, { "name": "isRootKind", "declarationName": "isRootKind", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the entity kind is a root kind (HMR, MHR, or ENR).\n\nRoot kinds are trust anchors — they do not derive from a parent entity.\nTheir lineage chain terminates at themselves.", "tags": [ { "name": "param", "text": "kind - The entity kind to check." }, { "name": "returns", "text": "`true` if the kind is {@link EntityKind.Hmr}, {@link EntityKind.Mhr}, or {@link EntityKind.Enr}." }, { "name": "example", "text": "```ts\nimport { EntityKind, isRootKind } from '@openagentid/oas-did';\n\nconsole.log(isRootKind(EntityKind.Hmr)); // true\nconsole.log(isRootKind(EntityKind.Enr)); // true\nconsole.log(isRootKind(EntityKind.Agent)); // false\n```" } ], "signatures": [ { "code": "export declare function isRootKind(kind: EntityKind): boolean;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 91, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "isrootkind" }, { "name": "multibaseEncodeBase58btc", "declarationName": "multibaseEncodeBase58btc", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as multibase base58btc with the `z` prefix.\n\nMatches the Rust SDK's `oas_crypto::encoding::multibase_encode` exactly on\nthe same input bytes. Used here to derive the identifier portion of a\n`did:oas` from a raw Ed25519 public key.", "tags": [ { "name": "param", "text": "bytes - Raw bytes (typically a 32-byte Ed25519 public key)." }, { "name": "returns", "text": "A string with the `z` prefix followed by base58btc-encoded data." }, { "name": "example", "text": "```ts\nimport { multibaseEncodeBase58btc } from '@openagentid/oas-did';\n\nconst encoded = multibaseEncodeBase58btc(new Uint8Array(32));\nconsole.log(encoded.startsWith('z')); // true\n```" } ], "signatures": [ { "code": "export declare function multibaseEncodeBase58btc(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/generate.d.ts", "line": 33, "sha256": "294cd4754597a3c309121224ab606c903008d3d90ab03c551843390c27288149" } } ], "anchor": "multibaseencodebase58btc" }, { "name": "Namespace", "declarationName": "Namespace", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "The supported OAS namespaces.\n\nThe reserved namespace set is enforced by {@link validateNamespace }; this\ntype narrows the common deployment-environment namespaces used by L1fe\nproduct surfaces. Application code that needs a custom namespace should\ncontinue using the string-accepting {@link OasDid.create } API directly.", "tags": [], "signatures": [ { "code": "export type Namespace = 'prod' | 'staging' | 'test' | 'l1fe' | string;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/generate.d.ts", "line": 10, "sha256": "294cd4754597a3c309121224ab606c903008d3d90ab03c551843390c27288149" } } ], "anchor": "namespace" }, { "name": "OasDid", "declarationName": "OasDid", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A parsed and validated OAS Decentralized Identifier.\n\n`OasDid` is an immutable value object representing a fully validated\n`did:oas:::` string. Once constructed,\nall components are guaranteed to be valid per the OAS specification.\n\nConstruction is via the static {@link OasDid.parse} method or the\n{@link OasDid.create} factory. Both perform full validation.", "tags": [ { "name": "example", "text": "```ts\nimport { OasDid } from '@openagentid/oas-did';\n\nconst did = OasDid.parse('did:oas:l1fe:agent:analyzer');\nconsole.log(did.namespace); // 'l1fe'\nconsole.log(did.kind); // 'agent'\nconsole.log(did.identifier); // 'analyzer'\nconsole.log(did.isRoot); // false\nconsole.log(did.toString()); // 'did:oas:l1fe:agent:analyzer'\n\nconst compound = OasDid.parse('did:oas:l1fe:agent:instance:bot-7');\nconsole.log(compound.kind); // 'agent:instance'\nconsole.log(compound.identifier); // 'bot-7'\n```" } ], "signatures": [ { "code": "export declare class OasDid {\n readonly namespace: string;\n readonly kind: EntityKind;\n readonly identifier: string;\n static create(namespace: string, kind: EntityKind, identifier: string): OasDid;\n static parse(input: string): OasDid;\n get isRoot(): boolean;\n get kindComponentCount(): number;\n toString(): string;\n toJSON(): string;\n equals(other: OasDid): boolean;\n}", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/did.d.ts", "line": 28, "sha256": "8435c4fd3b4b7ec4b7ff4bfe4db2a79f0e5803aff8c56af2420a0f359489e69d" } } ], "anchor": "oasdid" }, { "name": "RESERVED_NAMESPACES", "declarationName": "RESERVED_NAMESPACES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Reserved namespaces that cannot be used for production entities.\n\nThese namespaces are reserved by the OAS specification for testing,\nexamples, and internal specification use.", "tags": [], "signatures": [ { "code": "declare const RESERVED_NAMESPACES: ReadonlyArray;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/namespace.d.ts", "line": 7, "sha256": "85af64a61c0e6bc5480d57074fff8d3eff1064f3c9ae5838480535a01a8f9be5" } } ], "anchor": "reserved_namespaces" }, { "name": "validateIdentifier", "declarationName": "validateIdentifier", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates an identifier string against OAS Spec rules.\n\nA valid identifier:\n- Is 1-128 characters long\n- Contains only `[a-zA-Z0-9._-]` characters", "tags": [ { "name": "param", "text": "identifier - The identifier string to validate." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DidError} with code {@link DidErrorCode.InvalidIdentifier } if validation fails." }, { "name": "example", "text": "```ts\nimport { validateIdentifier } from '@openagentid/oas-did';\n\nvalidateIdentifier('alice'); // OK\nvalidateIdentifier('my-agent_v2.0'); // OK\nvalidateIdentifier(''); // throws DidError (empty)\nvalidateIdentifier('bad/chars'); // throws DidError (invalid chars)\n```" } ], "signatures": [ { "code": "export declare function validateIdentifier(identifier: string): void;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/validation.d.ts", "line": 21, "sha256": "3bd24eabc98960b1dbc25c80fc18783b7abfa84b445321e257b1420a07fc7533" } } ], "anchor": "validateidentifier" }, { "name": "validateNamespace", "declarationName": "validateNamespace", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates a namespace string against OAS Spec rules.\n\nA valid namespace:\n- Is 1-63 characters long\n- Contains only lowercase alphanumeric characters and hyphens\n- Does not start or end with a hyphen", "tags": [ { "name": "param", "text": "namespace - The namespace string to validate." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DidError} with code {@link DidErrorCode.InvalidNamespace } if validation fails." }, { "name": "example", "text": "```ts\nimport { validateNamespace } from '@openagentid/oas-did';\n\nvalidateNamespace('l1fe'); // OK\nvalidateNamespace('my-org'); // OK\nvalidateNamespace('L1FE'); // throws DidError (uppercase)\nvalidateNamespace('-bad'); // throws DidError (leading hyphen)\n```" } ], "signatures": [ { "code": "export declare function validateNamespace(namespace: string): void;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/namespace.d.ts", "line": 29, "sha256": "85af64a61c0e6bc5480d57074fff8d3eff1064f3c9ae5838480535a01a8f9be5" } } ], "anchor": "validatenamespace" } ], "supportingDeclarations": [], "coverage": { "discovered": 19, "documented": 19, "missing": [] } } ] }, { "name": "@openagentid/oas-document", "version": "1.0.2", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oas-document/-/oas-document-1.0.2.tgz", "integrity": "sha512-FCFQNuVXmYDVoDoR5+9S31CO6H4xdOUq4z7FlheHRxRRwNHTrZtCRRUwP4ycnblWXu7eT6cXdWOXeo1lx0Vm8A==", "packageJsonSha256": "492b75a424868fe08965305b12b4b24cc029966def656a41588202440552d397", "page": "/reference/typescript/oas-document", "engines": { "node": ">=20" }, "dependencies": { "@openagentid/oas-did": "1.0.2", "@openagentid/oas-crypto": "1.0.2" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-document", "page": "/reference/typescript/oas-document", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "Affiliation", "declarationName": "Affiliation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Affiliation {\n readonly did: string;\n readonly relationship: string;\n readonly label?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 1, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "affiliation" }, { "name": "ApiSchema", "declarationName": "ApiSchema", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ApiSchema {\n readonly schemaType: string;\n readonly url: string;\n readonly version?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 6, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "apischema" }, { "name": "AUTH_METHODS", "declarationName": "AUTH_METHODS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const AUTH_METHODS: {\n readonly DID_AUTH: \"did-auth\";\n readonly API_KEY: \"api-key\";\n readonly OAUTH2: \"oauth2\";\n readonly MTLS: \"mtls\";\n readonly BEARER_TOKEN: \"bearer-token\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 25, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "auth_methods" }, { "name": "BOOKING_TYPES", "declarationName": "BOOKING_TYPES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const BOOKING_TYPES: {\n readonly CONSULTATION: \"consultation\";\n readonly SUPPORT: \"support\";\n readonly MEETING: \"meeting\";\n readonly TASK: \"task\";\n readonly CUSTOM: \"custom\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 22, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "booking_types" }, { "name": "BookingEndpoint", "declarationName": "BookingEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface BookingEndpoint {\n readonly id: string;\n readonly url: string;\n readonly label?: string;\n readonly bookingType?: string;\n readonly visibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 8, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "bookingendpoint" }, { "name": "CalendarSection", "declarationName": "CalendarSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CalendarSection {\n readonly bookingEndpoints?: ReadonlyArray;\n readonly availabilityFeed?: string;\n readonly schedulingProtocol?: string;\n readonly officeHours?: ReadonlyArray;\n readonly timezone?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 15, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "calendarsection" }, { "name": "Certification", "declarationName": "Certification", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Certification {\n readonly standard: string;\n readonly issuer?: string;\n readonly validUntil?: string;\n readonly url?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 1, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "certification" }, { "name": "compareConformanceLevel", "declarationName": "compareConformanceLevel", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compares two conformance levels.", "tags": [ { "name": "param", "text": "a - First level." }, { "name": "param", "text": "b - Second level." }, { "name": "returns", "text": "Negative if a < b, zero if equal, positive if a > b." }, { "name": "example", "text": "```ts\nimport { ConformanceLevel, compareConformanceLevel } from '@openagentid/oas-document';\n\nconsole.log(compareConformanceLevel(ConformanceLevel.L0, ConformanceLevel.L1)); // -1\n```" } ], "signatures": [ { "code": "export declare function compareConformanceLevel(a: ConformanceLevel, b: ConformanceLevel): number;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 35, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "compareconformancelevel" }, { "name": "ComplianceSection", "declarationName": "ComplianceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ComplianceSection {\n readonly jurisdictions?: ReadonlyArray;\n readonly certifications?: ReadonlyArray;\n readonly termsOfServiceUrl?: string;\n readonly privacyPolicyUrl?: string;\n readonly dataHandlingPolicyUrl?: string;\n readonly dataResidency?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 7, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "compliancesection" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS conformance levels.\n\nEach level represents a tier of compliance with the OAS specification.\nHigher levels subsume lower levels: L2 includes all L1 requirements,\nwhich includes all L0 requirements.\n\n- **L0**: Basic identity (DID, verification method, proof)\n- **L1**: L0 + lineage, conformance declaration, lifecycle\n- **L2**: L2 + full attestation chain, WASM compilation", "tags": [], "signatures": [ { "code": "declare const ConformanceLevel: {\n readonly L0: \"L0\";\n readonly L1: \"L1\";\n readonly L2: \"L2\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 12, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } }, { "code": "export type ConformanceLevel = (typeof ConformanceLevel)[keyof typeof ConformanceLevel];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 20, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "conformancelevel" }, { "name": "ContactEntry", "declarationName": "ContactEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactEntry {\n readonly id: string;\n readonly entryType: string;\n readonly value: string;\n readonly label?: string;\n readonly platform?: string;\n readonly handle?: string;\n readonly visibility?: Visibility;\n readonly verified?: boolean;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 2, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactentry" }, { "name": "ContactSection", "declarationName": "ContactSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactSection {\n readonly entries: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 12, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactsection" }, { "name": "CostEntry", "declarationName": "CostEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CostEntry {\n readonly unit: string;\n readonly amount: string;\n readonly currency: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 2, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "costentry" }, { "name": "createVerificationMethod", "declarationName": "createVerificationMethod", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new verification method for a DID.", "tags": [ { "name": "param", "text": "did - The DID that controls this key." }, { "name": "param", "text": "keyNum - The key number for the fragment (e.g., 1 produces `#key-1`)." }, { "name": "param", "text": "keypair - The keypair providing the public key." }, { "name": "returns", "text": "A frozen {@link VerificationMethod}." } ], "signatures": [ { "code": "export declare function createVerificationMethod(did: string, keyNum: number, keypair: OasKeyPair): VerificationMethod;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 37, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "createverificationmethod" }, { "name": "defaultContext", "declarationName": "defaultContext", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the default JSON-LD context array for OAS documents.", "tags": [], "signatures": [ { "code": "export declare function defaultContext(): ReadonlyArray;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 119, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "defaultcontext" }, { "name": "defaultGovernancePolicy", "declarationName": "defaultGovernancePolicy", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a default governance policy with standard constraints.", "tags": [ { "name": "returns", "text": "A {@link GovernancePolicy} with `mhr_threshold` requirements,\n1 transition per day, and a 24-hour timelock." } ], "signatures": [ { "code": "export declare function defaultGovernancePolicy(): GovernancePolicy;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 42, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "defaultgovernancepolicy" }, { "name": "DID_CONTEXT", "declarationName": "DID_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "W3C DID Document context.", "tags": [], "signatures": [ { "code": "declare const DID_CONTEXT: \"https://www.w3.org/ns/did/v1\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 21, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "did_context" }, { "name": "DocumentBuilder", "declarationName": "DocumentBuilder", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Fluent builder for constructing OAS Identity Documents.\n\nThe builder enforces required fields and produces a signed, frozen\n{@link OasDocument} via the {@link DocumentBuilder.buildAndSign} method.", "tags": [ { "name": "example", "text": "```ts\nimport { DocumentBuilder, ConformanceLevel } from '@openagentid/oas-document';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\nimport { EntityKind } from '@openagentid/oas-did';\n\nconst keypair = OasKeyPair.generate();\nconst doc = new DocumentBuilder('did:oas:l1fe:hmr:alice', EntityKind.Hmr)\n .controller('did:oas:l1fe:hmr:alice')\n .addVerificationMethod(keypair)\n .conformanceLevel(ConformanceLevel.L0)\n .buildAndSign(keypair, new Date().toISOString());\n```" } ], "signatures": [ { "code": "export declare class DocumentBuilder {\n constructor(id: string, kind: EntityKind);\n controller(controller: string | ReadonlyArray): this;\n addVerificationMethod(keypair: OasKeyPair): this;\n conformanceLevel(level: ConformanceLevel): this;\n lifecycleStatus(status: LifecycleStatus): this;\n sequence(seq: number): this;\n name(name: string): this;\n description(description: string): this;\n lineage(lineage: LineageSection): this;\n addService(service: ServiceEndpoint): this;\n metadata(metadata: Record): this;\n buildAndSign(keypair: OasKeyPair, created: string): Promise;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/builder.d.ts", "line": 28, "sha256": "73e3ff394a7c2fadfb9f879255b977ba1b99d12c94f9e36573be41cbac40c19a" } } ], "anchor": "documentbuilder" }, { "name": "DocumentError", "declarationName": "DocumentError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for OAS document operations.", "tags": [ { "name": "example", "text": "```ts\nimport { DocumentError, DocumentErrorCode } from '@openagentid/oas-document';\n\nconst err = new DocumentError(\n DocumentErrorCode.MissingField,\n \"required field 'verificationMethod' is missing from document\"\n);\n```" } ], "signatures": [ { "code": "export declare class DocumentError extends Error {\n readonly code: DocumentErrorCode;\n readonly details: Readonly>;\n constructor(code: DocumentErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/error.d.ts", "line": 40, "sha256": "60683da469296c386d05363cd6ec1f51fdec62aaeda99b3b539a530ca6197a65" } } ], "anchor": "documenterror" }, { "name": "DocumentErrorCode", "declarationName": "DocumentErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS document operations.", "tags": [], "signatures": [ { "code": "declare const DocumentErrorCode: {\n readonly MissingField: \"MISSING_FIELD\";\n readonly InvalidField: \"INVALID_FIELD\";\n readonly ProofVerificationFailed: \"PROOF_VERIFICATION_FAILED\";\n readonly ProofGenerationFailed: \"PROOF_GENERATION_FAILED\";\n readonly ConformanceNotMet: \"CONFORMANCE_NOT_MET\";\n readonly Json: \"JSON_ERROR\";\n readonly Did: \"DID_ERROR\";\n readonly Crypto: \"CRYPTO_ERROR\";\n readonly InvalidLifecycleTransition: \"INVALID_LIFECYCLE_TRANSITION\";\n readonly InvalidSequence: \"INVALID_SEQUENCE\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/error.d.ts", "line": 4, "sha256": "60683da469296c386d05363cd6ec1f51fdec62aaeda99b3b539a530ca6197a65" } }, { "code": "export type DocumentErrorCode = (typeof DocumentErrorCode)[keyof typeof DocumentErrorCode];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/error.d.ts", "line": 26, "sha256": "60683da469296c386d05363cd6ec1f51fdec62aaeda99b3b539a530ca6197a65" } } ], "anchor": "documenterrorcode" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A document proof (Ed25519Signature2020) attached to an OAS Identity Document.\n\nThe proof authenticates the document content by signing the JCS-canonicalized\ndocument (excluding the proof itself) with the entity's Ed25519 key.", "tags": [], "signatures": [ { "code": "export interface DocumentProof {\n readonly type: 'Ed25519Signature2020';\n readonly created: string;\n readonly verificationMethod: string;\n readonly proofPurpose: 'assertionMethod';\n readonly proofValue: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 8, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "documentproof" }, { "name": "documentWithoutProof", "declarationName": "documentWithoutProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a plain JSON object from an OasDocument, suitable for\nJCS canonicalization or serialization.\n\nStrips the `proof` field to produce the unsigned document payload.", "tags": [ { "name": "param", "text": "doc - The document to convert." }, { "name": "returns", "text": "A plain object without the `proof` field." } ], "signatures": [ { "code": "export declare function documentWithoutProof(doc: OasDocument): Record;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 157, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "documentwithoutproof" }, { "name": "ED25519_CONTEXT", "declarationName": "ED25519_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Ed25519 Verification Key 2020 context.", "tags": [], "signatures": [ { "code": "declare const ED25519_CONTEXT: \"https://w3id.org/security/suites/ed25519-2020/v1\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 25, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "ed25519_context" }, { "name": "ENR_GOVERNANCE_PROOF_TYPE", "declarationName": "ENR_GOVERNANCE_PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The canonical proof type string for ENR governance transitions.", "tags": [], "signatures": [ { "code": "declare const ENR_GOVERNANCE_PROOF_TYPE: \"EnrGovernanceTransitionProof2025\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 13, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "enr_governance_proof_type" }, { "name": "ENTRY_TYPES", "declarationName": "ENTRY_TYPES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const ENTRY_TYPES: {\n readonly PHONE: \"phone\";\n readonly EMAIL: \"email\";\n readonly SOCIAL: \"social\";\n readonly WEBSITE: \"website\";\n readonly MESSAGING: \"messaging\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 15, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "entry_types" }, { "name": "extractKeyId", "declarationName": "extractKeyId", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extracts the key ID fragment from a verification method ID.", "tags": [ { "name": "param", "text": "vmId - The full verification method ID (e.g., `\"did:oas:l1fe:agent:bot#key-1\"`)." }, { "name": "returns", "text": "The fragment part (e.g., `\"key-1\"`), or `undefined` if no fragment." } ], "signatures": [ { "code": "export declare function extractKeyId(vmId: string): string | undefined;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 44, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "extractkeyid" }, { "name": "findVerificationMethod", "declarationName": "findVerificationMethod", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Finds a verification method by ID.", "tags": [ { "name": "param", "text": "doc - The document to search." }, { "name": "param", "text": "vmId - The verification method ID to find." }, { "name": "returns", "text": "The matching {@link VerificationMethod}, or `undefined`." } ], "signatures": [ { "code": "export declare function findVerificationMethod(doc: OasDocument, vmId: string): VerificationMethod | undefined;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 147, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "findverificationmethod" }, { "name": "generateDocumentProof", "declarationName": "generateDocumentProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generates a document proof by signing the JCS-canonicalized document.", "tags": [ { "name": "param", "text": "documentWithoutProof - The document object without the `proof` field." }, { "name": "param", "text": "keypair - The keypair to sign with." }, { "name": "param", "text": "verificationMethodId - The VM ID to reference." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "A frozen {@link DocumentProof}." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DocumentError} on signing or canonicalization failure." } ], "signatures": [ { "code": "export declare function generateDocumentProof(documentWithoutProof: Record, keypair: OasKeyPair, verificationMethodId: string, created: string): Promise;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 30, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "generatedocumentproof" }, { "name": "GovernancePolicy", "declarationName": "GovernancePolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Policy constraints governing how ENR transitions may occur.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernancePolicy, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst policy = defaultGovernancePolicy();\nconsole.log(policy.maxTransitionsPerDay); // 1\nconsole.log(policy.timelockHours); // 24\n```" } ], "signatures": [ { "code": "export interface GovernancePolicy {\n readonly transitionRequires: string;\n readonly signingKeyRotationRequires: string;\n readonly maxTransitionsPerDay: number;\n readonly timelockHours: number;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 26, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancepolicy" }, { "name": "GovernanceSection", "declarationName": "GovernanceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Governance section attached to ENR identity documents.\n\nTracks the governing MHR, monotonic epoch counter, transition history,\nand governance policy constraints.\n\n**Invariants:**\n- `epoch` MUST strictly increase (no gaps, no rewinds).\n- `currentMhr` MUST reference a valid, non-revoked MHR DID.\n- Each transition's `from` MUST match the previous transition's `to`.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernanceSection, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst gov: GovernanceSection = {\n currentMhr: 'did:oas:prod:mhr:council-alpha',\n epoch: 1,\n transitions: [],\n policy: defaultGovernancePolicy(),\n};\n```" } ], "signatures": [ { "code": "export interface GovernanceSection {\n readonly currentMhr: string;\n readonly epoch: number;\n readonly transitions: ReadonlyArray;\n readonly policy: GovernancePolicy;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 96, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancesection" }, { "name": "GovernanceTransition", "declarationName": "GovernanceTransition", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single governance transition record.\n\nRecords the handoff from one MHR to another, including the\ncryptographic proof (FROST threshold signature from the outgoing MHR).", "tags": [], "signatures": [ { "code": "export interface GovernanceTransition {\n readonly from?: string | undefined;\n readonly to: string;\n readonly epoch: number;\n readonly proof: GovernanceTransitionProof;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 63, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransition" }, { "name": "GovernanceTransitionProof", "declarationName": "GovernanceTransitionProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Proof that a governance transition was authorized.\n\nContains a FROST threshold signature from the outgoing MHR members,\nproving that a quorum approved the handoff.", "tags": [], "signatures": [ { "code": "export interface GovernanceTransitionProof {\n readonly type: string;\n readonly mhrThresholdSignature: string;\n readonly timestamp: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 49, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransitionproof" }, { "name": "InteroperabilitySection", "declarationName": "InteroperabilitySection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface InteroperabilitySection {\n readonly protocols?: ReadonlyArray;\n readonly apiSchemas?: ReadonlyArray;\n readonly authMethods?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 11, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "interoperabilitysection" }, { "name": "isRevoked", "declarationName": "isRevoked", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the document has been revoked.", "tags": [ { "name": "param", "text": "doc - The document to check." } ], "signatures": [ { "code": "export declare function isRevoked(doc: OasDocument): boolean;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 132, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "isrevoked" }, { "name": "isRootDocument", "declarationName": "isRootDocument", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the document represents a root entity (HMR, MHR, or ENR).", "tags": [ { "name": "param", "text": "doc - The document to check." }, { "name": "returns", "text": "`true` if the entity kind is a root kind." } ], "signatures": [ { "code": "export declare function isRootDocument(doc: OasDocument): boolean;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 126, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "isrootdocument" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS entity lifecycle statuses.\n\nEntities progress through these statuses during their lifetime.\nThe lifecycle is largely linear, but suspension and reactivation\ncreate branches.", "tags": [], "signatures": [ { "code": "declare const LifecycleStatus: {\n readonly Nascent: \"nascent\";\n readonly Active: \"active\";\n readonly Dormant: \"dormant\";\n readonly Suspended: \"suspended\";\n readonly Terminated: \"terminated\";\n readonly Archived: \"archived\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 8, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } }, { "code": "export type LifecycleStatus = (typeof LifecycleStatus)[keyof typeof LifecycleStatus];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 22, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The lineage section of an OAS Identity Document.\n\nDescribes the entity's position in the derivation chain, linking\nit back to its human root. Root entities (HMR, MHR) do not have\na lineage section.", "tags": [ { "name": "example", "text": "```ts\nimport { LineageSection } from '@openagentid/oas-document';\n\nconst lineage: LineageSection = {\n humanRootDid: 'did:oas:l1fe:hmr:alice',\n creatorDid: 'did:oas:l1fe:hmr:alice',\n generation: 1,\n humanRootChain: [\n 'did:oas:l1fe:agent:bot',\n 'did:oas:l1fe:hmr:alice',\n ],\n};\n```" } ], "signatures": [ { "code": "export interface LineageSection {\n readonly humanRootDid: string;\n readonly creatorDid: string;\n readonly generation: number;\n readonly derivationProof?: AgentLineageProofData | undefined;\n readonly humanRootChain: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lineage-section.d.ts", "line": 24, "sha256": "bf29b9bbbfcd3422bf07e21f841b4802ee05271346f881f637ee8f67e0bcb366" } } ], "anchor": "lineagesection" }, { "name": "meetsConformanceLevel", "declarationName": "meetsConformanceLevel", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if level `a` meets or exceeds the required level `b`.", "tags": [ { "name": "param", "text": "actual - The actual conformance level." }, { "name": "param", "text": "required - The required conformance level." }, { "name": "returns", "text": "`true` if `actual >= required`." } ], "signatures": [ { "code": "export declare function meetsConformanceLevel(actual: ConformanceLevel, required: ConformanceLevel): boolean;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 43, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "meetsconformancelevel" }, { "name": "OAS_CONTEXT", "declarationName": "OAS_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS-specific context.", "tags": [], "signatures": [ { "code": "declare const OAS_CONTEXT: \"https://openagent.id/ns/oas/v1\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 29, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oas_context" }, { "name": "OAS_VERSION", "declarationName": "OAS_VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Current OAS specification version.", "tags": [], "signatures": [ { "code": "declare const OAS_VERSION: \"1.0.0\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 33, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oas_version" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS Identity Document.\n\nThis is the core identity artifact in the OAS ecosystem. It extends the\nW3C DID Document format with OAS-specific properties for lineage,\nconformance, lifecycle, and entity classification.\n\nDocuments are immutable once created. Use {@link DocumentBuilder } to\nconstruct new documents.", "tags": [ { "name": "example", "text": "```ts\nimport { OasDocument, OAS_VERSION } from '@openagentid/oas-document';\n\n// Documents are created via DocumentBuilder, not constructed directly.\n// See DocumentBuilder for construction examples.\n```" } ], "signatures": [ { "code": "export interface OasDocument {\n readonly '@context': ReadonlyArray;\n readonly id: string;\n readonly controller: string | ReadonlyArray;\n readonly verificationMethod: ReadonlyArray;\n readonly authentication: ReadonlyArray;\n readonly assertionMethod: ReadonlyArray;\n readonly capabilityInvocation: ReadonlyArray;\n readonly capabilityDelegation: ReadonlyArray;\n readonly service: ReadonlyArray;\n readonly oasVersion: typeof OAS_VERSION;\n readonly kind: EntityKind;\n readonly name?: string | undefined;\n readonly description?: string | undefined;\n readonly lineage?: LineageSection | undefined;\n readonly conformanceLevel: ConformanceLevel;\n readonly lifecycleStatus?: LifecycleStatus | undefined;\n readonly sequence: number;\n readonly metadata: Readonly>;\n readonly proof?: DocumentProof | undefined;\n readonly revoked?: boolean | undefined;\n readonly revokedAt?: string | undefined;\n readonly profile?: ProfileSection | undefined;\n readonly contact?: ContactSection | undefined;\n readonly calendar?: CalendarSection | undefined;\n readonly operational?: OperationalSection | undefined;\n readonly pricing?: PricingSection | undefined;\n readonly interoperability?: InteroperabilitySection | undefined;\n readonly reputation?: ReputationSection | undefined;\n readonly compliance?: ComplianceSection | undefined;\n readonly relationships?: RelationshipsSection | undefined;\n readonly governance?: GovernanceSection | undefined;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 52, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oasdocument" }, { "name": "OperationalSection", "declarationName": "OperationalSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface OperationalSection {\n readonly availability?: string;\n readonly sla?: ReadonlyArray;\n readonly rateLimits?: ReadonlyArray;\n readonly supportedInputFormats?: ReadonlyArray;\n readonly supportedOutputFormats?: ReadonlyArray;\n readonly maxPayloadBytes?: number;\n readonly maxContextTokens?: number;\n readonly maintenanceWindows?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 11, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "operationalsection" }, { "name": "PLATFORMS", "declarationName": "PLATFORMS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PLATFORMS: {\n readonly X: \"x\";\n readonly LINKEDIN: \"linkedin\";\n readonly GITHUB: \"github\";\n readonly DISCORD: \"discord\";\n readonly TELEGRAM: \"telegram\";\n readonly SLACK: \"slack\";\n readonly WHATSAPP: \"whatsapp\";\n readonly SIGNAL: \"signal\";\n readonly MASTODON: \"mastodon\";\n readonly BLUESKY: \"bluesky\";\n readonly YOUTUBE: \"youtube\";\n readonly INSTAGRAM: \"instagram\";\n readonly TIKTOK: \"tiktok\";\n readonly REDDIT: \"reddit\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 22, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "platforms" }, { "name": "PRICING_MODELS", "declarationName": "PRICING_MODELS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PRICING_MODELS: {\n readonly FREE: \"free\";\n readonly PER_REQUEST: \"per_request\";\n readonly PER_TOKEN: \"per_token\";\n readonly SUBSCRIPTION: \"subscription\";\n readonly NEGOTIATED: \"negotiated\";\n readonly CUSTOM: \"custom\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 15, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "pricing_models" }, { "name": "PricingSection", "declarationName": "PricingSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface PricingSection {\n readonly model: string;\n readonly costs?: ReadonlyArray;\n readonly currenciesAccepted?: ReadonlyArray;\n readonly billingEndpoint?: string;\n readonly freeTierLimits?: string;\n readonly billingVisibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 7, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "pricingsection" }, { "name": "primaryPublicKeyMultibase", "declarationName": "primaryPublicKeyMultibase", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the primary public key multibase from the first verification method.", "tags": [ { "name": "param", "text": "doc - The document to inspect." }, { "name": "returns", "text": "The multibase-encoded public key, or `undefined` if no VM exists." } ], "signatures": [ { "code": "export declare function primaryPublicKeyMultibase(doc: OasDocument): string | undefined;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 139, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "primarypublickeymultibase" }, { "name": "ProfileSection", "declarationName": "ProfileSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProfileSection {\n readonly avatarUrl?: string;\n readonly bannerUrl?: string;\n readonly tagline?: string;\n readonly categories?: ReadonlyArray;\n readonly languages?: ReadonlyArray;\n readonly timezone?: string;\n readonly accentColor?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/profile.d.ts", "line": 1, "sha256": "fa4dc1aeee47ab1108c7bb120a44a1546e7188fb68b2cdf6ea6e32f96b2f575e" } } ], "anchor": "profilesection" }, { "name": "PROTOCOLS", "declarationName": "PROTOCOLS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROTOCOLS: {\n readonly MCP: \"mcp\";\n readonly A2A: \"a2a\";\n readonly REST: \"rest\";\n readonly GRAPHQL: \"graphql\";\n readonly GRPC: \"grpc\";\n readonly WEBSOCKET: \"websocket\";\n readonly OAS_MAP: \"oas-map\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 16, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "protocols" }, { "name": "ProtocolSupport", "declarationName": "ProtocolSupport", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProtocolSupport {\n readonly protocol: string;\n readonly version?: string;\n readonly endpoint?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 1, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "protocolsupport" }, { "name": "RateLimit", "declarationName": "RateLimit", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RateLimit {\n readonly resource: string;\n readonly limit: number;\n readonly window: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 6, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "ratelimit" }, { "name": "RELATIONSHIP_TYPES", "declarationName": "RELATIONSHIP_TYPES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const RELATIONSHIP_TYPES: {\n readonly MEMBER: \"member\";\n readonly PARTNER: \"partner\";\n readonly SUBSIDIARY: \"subsidiary\";\n readonly AFFILIATE: \"affiliate\";\n readonly DELEGATE: \"delegate\";\n readonly ADVISOR: \"advisor\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 11, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "relationship_types" }, { "name": "RelationshipsSection", "declarationName": "RelationshipsSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RelationshipsSection {\n readonly parentOrganization?: string;\n readonly affiliations?: ReadonlyArray;\n readonly blockedDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 6, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "relationshipssection" }, { "name": "ReputationSection", "declarationName": "ReputationSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ReputationSection {\n readonly totalInteractions?: number;\n readonly endorsementCount?: number;\n readonly trustScore?: string;\n readonly uptime30d?: string;\n readonly uptime90d?: string;\n readonly firstActive?: string;\n readonly endorserDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/reputation.d.ts", "line": 1, "sha256": "f7e4816a049d93e1c05d6f9a26150fa8e3656567bba68a9bddef244cd51c9aae" } } ], "anchor": "reputationsection" }, { "name": "ScheduleWindow", "declarationName": "ScheduleWindow", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ScheduleWindow {\n readonly day: string;\n readonly start: string;\n readonly end: string;\n readonly timezone: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 2, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "schedulewindow" }, { "name": "SCHEDULING_PROTOCOLS", "declarationName": "SCHEDULING_PROTOCOLS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SCHEDULING_PROTOCOLS: {\n readonly ICAL_INVITE: \"ical-invite\";\n readonly API: \"api\";\n readonly AGENT_NEGOTIATION: \"agent-negotiation\";\n readonly MANUAL: \"manual\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 29, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "scheduling_protocols" }, { "name": "SERVICE_TYPES", "declarationName": "SERVICE_TYPES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SERVICE_TYPES: {\n readonly OAS_ENTITY: \"OASEntity\";\n readonly OAS_COMMUNICATION: \"OASCommunication\";\n readonly OAS_LINEAGE_QUERY: \"OASLineageQuery\";\n readonly OAS_ATTESTATION: \"OASAttestationService\";\n readonly OAS_REVOCATION_STATUS: \"OASRevocationStatus\";\n readonly OAS_CAPABILITY_INVOCATION: \"OASCapabilityInvocation\";\n readonly OAS_GOVERNANCE: \"OASGovernance\";\n readonly OAS_PRIVATE_ENDPOINT: \"OASPrivateEndpointService\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/service.d.ts", "line": 32, "sha256": "760d3af9b43ea7ee9f9f4bf43edecda47987acee0492e1fbadb8c3f52549c0e4" } } ], "anchor": "service_types" }, { "name": "ServiceEndpoint", "declarationName": "ServiceEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A service endpoint declaration in an OAS Identity Document.\n\nServices describe how to interact with the entity — API endpoints,\ncommunication channels, discovery mechanisms, etc.", "tags": [ { "name": "example", "text": "```ts\nimport { ServiceEndpoint } from '@openagentid/oas-document';\n\nconst service: ServiceEndpoint = {\n id: 'did:oas:l1fe:agent:bot#api',\n type: 'AgentApi',\n serviceEndpoint: 'https://api.l1fe.ai/agents/bot',\n};\n```" } ], "signatures": [ { "code": "export interface ServiceEndpoint {\n readonly id: string;\n readonly type: string;\n readonly serviceEndpoint: string;\n readonly label?: string;\n readonly description?: string;\n readonly properties?: Readonly>;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/service.d.ts", "line": 18, "sha256": "760d3af9b43ea7ee9f9f4bf43edecda47987acee0492e1fbadb8c3f52549c0e4" } } ], "anchor": "serviceendpoint" }, { "name": "SlaCommitment", "declarationName": "SlaCommitment", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface SlaCommitment {\n readonly metric: string;\n readonly target: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 2, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "slacommitment" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An Ed25519 verification method in an OAS Identity Document.\n\nVerification methods bind public keys to the DID subject, enabling\nsignature verification on documents, proofs, and attestations.", "tags": [ { "name": "example", "text": "```ts\nimport { createVerificationMethod } from '@openagentid/oas-document';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst kp = OasKeyPair.generate();\nconst vm = createVerificationMethod('did:oas:l1fe:agent:bot', 1, kp);\nconsole.log(vm.id); // 'did:oas:l1fe:agent:bot#key-1'\nconsole.log(vm.type); // 'Ed25519VerificationKey2020'\n```" } ], "signatures": [ { "code": "export interface VerificationMethod {\n readonly id: string;\n readonly type: 'Ed25519VerificationKey2020';\n readonly controller: string;\n readonly publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 19, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "verificationmethod" }, { "name": "verifyDocumentProof", "declarationName": "verifyDocumentProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a document proof against the document content and a public key.", "tags": [ { "name": "param", "text": "documentWithoutProof - The document object without the `proof` field." }, { "name": "param", "text": "proof - The proof to verify." }, { "name": "param", "text": "publicKeyBytes - The 32-byte Ed25519 public key." }, { "name": "returns", "text": "`true` if the proof is valid." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DocumentError} on decoding or verification errors." } ], "signatures": [ { "code": "export declare function verifyDocumentProof(documentWithoutProof: Record, proof: DocumentProof, publicKeyBytes: Uint8Array): Promise;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 40, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "verifydocumentproof" }, { "name": "Visibility", "declarationName": "Visibility", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type Visibility = 'public' | 'authenticated' | 'organization' | 'private';", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/visibility.d.ts", "line": 1, "sha256": "1315dc096b8891ee4f8e89553cee8fd48686954d4fe4da52eae62dab8b53d2be" } } ], "anchor": "visibility" } ], "supportingDeclarations": [ { "name": "AgentLineageProofData", "declarationName": "AgentLineageProofData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verifiable proof linking a child entity to its parent in the OAS lineage chain.\n\n`AgentLineageProof2025` establishes cryptographic accountability by proving that\na parent entity authorized the creation of a child entity at a specific derivation path.\n\nThe proof contains:\n- The parent and child DIDs\n- The derivation path used for HKDF key derivation\n- The parent's public key (multibase-encoded)\n- An Ed25519 signature over the canonical proof payload\n\nSee OAS Specification §9.4, §9.5 for the complete proof format.", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair, AgentLineageProof } from '@openagentid/oas-crypto';\n\nconst parent = await OasKeyPair.generate();\nconst proof = await AgentLineageProof.generate(\n parent,\n 'did:oas:l1fe:hmr:alice',\n 'did:oas:l1fe:agent:my-bot',\n '/agent-my-bot',\n);\n\nconst valid = await AgentLineageProof.verify(proof);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export interface AgentLineageProofData {\n readonly proofType: typeof PROOF_TYPE;\n readonly parentDid: string;\n readonly childDid: string;\n readonly derivationPath: string;\n readonly algorithm: typeof PROOF_ALGORITHM;\n readonly publicKeyMultibase: string;\n readonly signature: string;\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 40, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "agentlineageproofdata" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The set of recognized OAS entity kinds.\n\nEach entity kind represents a category of autonomous entity in the OAS\nidentity system. Root kinds ({@link EntityKind.Hmr}, {@link EntityKind.Mhr},\n{@link EntityKind.Enr}) are the trust anchors from which all other entities\nderive their lineage.", "tags": [ { "name": "example", "text": "```ts\nimport { EntityKind, entityKindFromString } from '@openagentid/oas-did';\n\nconst kind = entityKindFromString('agent');\nconsole.log(kind === EntityKind.Agent); // true\nconsole.log(isRootKind(kind)); // false\n```" } ], "signatures": [ { "code": "declare const EntityKind: {\n readonly Hmr: \"hmr\";\n readonly Mhr: \"mhr\";\n readonly Enr: \"enr\";\n readonly Ao: \"ao\";\n readonly Agent: \"agent\";\n readonly AgentInstance: \"agent:instance\";\n readonly Tool: \"tool\";\n readonly Skill: \"skill\";\n readonly Workflow: \"workflow\";\n readonly Model: \"model\";\n readonly Dataset: \"dataset\";\n readonly Service: \"service\";\n};", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 18, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } }, { "code": "export type EntityKind = (typeof EntityKind)[keyof typeof EntityKind];", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 44, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykind" }, { "name": "OasKeyPair", "declarationName": "OasKeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 keypair for an OAS entity.\n\nHolds both the signing (private) and verifying (public) keys. The signing key\nis stored as a `Uint8Array` and should be zeroed when no longer needed.\n\n## Security\n\n- Private key bytes are never exposed via `toString()` or `toJSON()`\n- All signature operations use constant-time comparison internally via `@noble/ed25519`\n- Callers should zero the signing key bytes when the keypair is no longer needed:\n `keypair.signingKeyBytes.fill(0)`", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst keypair = await OasKeyPair.generate();\nconst message = new TextEncoder().encode('hello OAS');\nconst signature = await keypair.sign(message);\nconst valid = await OasKeyPair.verifyWithKey(keypair.verifyingKeyBytes, message, signature);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export declare class OasKeyPair {\n static generate(): Promise;\n static fromSigningKeyBytes(bytes: Uint8Array): Promise;\n static verifyingKeyFromBytes(bytes: Uint8Array): Uint8Array;\n sign(message: Uint8Array): Promise;\n static verifyWithKey(publicKeyBytes: Uint8Array, message: Uint8Array, signatureBytes: Uint8Array): Promise;\n get signingKeyBytes(): Uint8Array;\n get verifyingKeyBytes(): Uint8Array;\n publicKeyMultibase(): string;\n toString(): string;\n toJSON(): {\n verifyingKey: string;\n };\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/keypair.d.ts", "line": 25, "sha256": "c143b2ad5ee896897ce3d3e1b554b720354d7351b408205370a4b7a9f8c2139b" } } ], "anchor": "oaskeypair" }, { "name": "PROOF_ALGORITHM", "declarationName": "PROOF_ALGORITHM", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The algorithm used for key derivation in lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_ALGORITHM: \"HKDF-SHA256-Ed25519\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 9, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_algorithm" }, { "name": "PROOF_TYPE", "declarationName": "PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The proof type identifier for OAS lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_TYPE: \"AgentLineageProof2025\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 5, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_type" } ], "coverage": { "discovered": 61, "documented": 61, "missing": [] } } ] }, { "name": "@openagentid/oas-lineage", "version": "1.0.2", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oas-lineage/-/oas-lineage-1.0.2.tgz", "integrity": "sha512-adM9P4Xf6qYLbKeYTLsBYVok94bMVpedcTMtsqI2m6+cuFlLSoMfZYKiK1b19hini7qj+0OwdAzoM/ufHpgppw==", "packageJsonSha256": "2d55e2370acda82b9aeb61ee0f7352cee7d2f6a9e6732b25e0d02f4bf9a21f2c", "page": "/reference/typescript/oas-lineage", "engines": { "node": ">=20" }, "dependencies": { "@openagentid/oas-did": "1.0.2", "@openagentid/oas-crypto": "1.0.2", "@openagentid/oas-document": "1.0.2" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-lineage", "page": "/reference/typescript/oas-lineage", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "defaultVerifyConfig", "declarationName": "defaultVerifyConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a default verification configuration.", "tags": [ { "name": "returns", "text": "A frozen {@link VerifyConfig} with default values." } ], "signatures": [ { "code": "export declare function defaultVerifyConfig(): VerifyConfig;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 28, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "defaultverifyconfig" }, { "name": "deriveChildEntity", "declarationName": "deriveChildEntity", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a child entity from a parent entity's keypair and document.\n\nPerforms HKDF-SHA256 key derivation, generates a lineage proof signed\nby the parent, and constructs the lineage section for the child's\nidentity document.", "tags": [ { "name": "param", "text": "parentKeypair - The parent entity's keypair (must have signing key)." }, { "name": "param", "text": "parentDoc - The parent entity's identity document." }, { "name": "param", "text": "childDid - The child entity's DID string." }, { "name": "param", "text": "derivationPath - The HKDF derivation path (e.g., `\"/agent-my-bot\"`)." }, { "name": "returns", "text": "A {@link DerivedChild} with the keypair and lineage section." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "LineageError} on derivation or proof generation failure." }, { "name": "example", "text": "```ts\nimport { deriveChildEntity } from '@openagentid/oas-lineage';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst child = await deriveChildEntity(\n parentKeypair,\n parentDocument,\n 'did:oas:l1fe:agent:my-bot',\n '/agent-my-bot',\n);\n\nconsole.log(child.lineage.generation); // parent.generation + 1\n```" } ], "signatures": [ { "code": "export declare function deriveChildEntity(parentKeypair: OasKeyPair, parentDoc: OasDocument, childDid: string, derivationPath: string): Promise;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/derive.d.ts", "line": 44, "sha256": "af28f0710d6ba3d5a14bc95475739b5d7ac3cea5443e3cb528c02097b2432757" } } ], "anchor": "derivechildentity" }, { "name": "DerivedChild", "declarationName": "DerivedChild", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of a child entity derivation.\n\nContains the derived keypair and the lineage section to include\nin the child's identity document.", "tags": [], "signatures": [ { "code": "export interface DerivedChild {\n readonly keypair: OasKeyPair;\n readonly lineage: LineageSection;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/derive.d.ts", "line": 9, "sha256": "af28f0710d6ba3d5a14bc95475739b5d7ac3cea5443e3cb528c02097b2432757" } } ], "anchor": "derivedchild" }, { "name": "DocumentProvider", "declarationName": "DocumentProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Interface for resolving OAS Identity Documents by DID.\n\nImplementations provide documents from different sources: in-memory\nmaps, network resolution, caching layers, etc. The lineage verifier\nuses this interface to walk the chain.", "tags": [ { "name": "example", "text": "```ts\nimport { DocumentProvider, InMemoryProvider } from '@openagentid/oas-lineage';\n\nconst provider = new InMemoryProvider();\nprovider.register(doc);\nconst resolved = await provider.resolve('did:oas:l1fe:hmr:alice');\n```" } ], "signatures": [ { "code": "export interface DocumentProvider {\n resolve(did: string): Promise;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/provider.d.ts", "line": 18, "sha256": "ff17113607d489bcebcc7c0c6621120cc0ab48e0f5023ccbbcab00e3d1bd67cc" } } ], "anchor": "documentprovider" }, { "name": "InMemoryProvider", "declarationName": "InMemoryProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory document provider for testing and local verification.\n\nStores documents in a Map keyed by DID string. Thread-safe for\nconcurrent reads (JavaScript is single-threaded for sync operations,\nbut async operations are correctly sequenced).", "tags": [ { "name": "example", "text": "```ts\nimport { InMemoryProvider } from '@openagentid/oas-lineage';\n\nconst provider = new InMemoryProvider();\nprovider.register(document);\nconst doc = await provider.resolve('did:oas:l1fe:hmr:alice');\n```" } ], "signatures": [ { "code": "export declare class InMemoryProvider implements DocumentProvider {\n register(doc: OasDocument): void;\n remove(did: string): boolean;\n resolve(did: string): Promise;\n get size(): number;\n get isEmpty(): boolean;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/provider.d.ts", "line": 43, "sha256": "ff17113607d489bcebcc7c0c6621120cc0ab48e0f5023ccbbcab00e3d1bd67cc" } } ], "anchor": "inmemoryprovider" }, { "name": "LineageError", "declarationName": "LineageError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for lineage operations.", "tags": [ { "name": "example", "text": "```ts\nimport { LineageError, LineageErrorCode } from '@openagentid/oas-lineage';\n\nconst err = new LineageError(\n LineageErrorCode.ChainTooDeep,\n 'lineage chain depth 20 exceeds maximum 16'\n);\n```" } ], "signatures": [ { "code": "export declare class LineageError extends Error {\n readonly code: LineageErrorCode;\n readonly details: Readonly>;\n constructor(code: LineageErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/error.d.ts", "line": 52, "sha256": "0e15cc42c22eb426723735795b0051efbd2a02b56e826962a267c2fec2c12dfe" } } ], "anchor": "lineageerror" }, { "name": "LineageErrorCode", "declarationName": "LineageErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for lineage verification and derivation operations.", "tags": [], "signatures": [ { "code": "declare const LineageErrorCode: {\n readonly MissingLineage: \"MISSING_LINEAGE\";\n readonly EmptyChain: \"EMPTY_CHAIN\";\n readonly ChainNotTerminatingAtRoot: \"CHAIN_NOT_TERMINATING_AT_ROOT\";\n readonly GenerationMismatch: \"GENERATION_MISMATCH\";\n readonly ChainTooDeep: \"CHAIN_TOO_DEEP\";\n readonly ResolutionFailed: \"RESOLUTION_FAILED\";\n readonly ParentRevoked: \"PARENT_REVOKED\";\n readonly ParentSignatureInvalid: \"PARENT_SIGNATURE_INVALID\";\n readonly UnknownProofType: \"UNKNOWN_PROOF_TYPE\";\n readonly ProofParentMismatch: \"PROOF_PARENT_MISMATCH\";\n readonly ProofChildMismatch: \"PROOF_CHILD_MISMATCH\";\n readonly ProofSignatureInvalid: \"PROOF_SIGNATURE_INVALID\";\n readonly TotalTimeout: \"TOTAL_TIMEOUT\";\n readonly MissingDerivationProof: \"MISSING_DERIVATION_PROOF\";\n readonly ParentKeyNotFound: \"PARENT_KEY_NOT_FOUND\";\n readonly Crypto: \"CRYPTO_ERROR\";\n};", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/error.d.ts", "line": 4, "sha256": "0e15cc42c22eb426723735795b0051efbd2a02b56e826962a267c2fec2c12dfe" } }, { "code": "export type LineageErrorCode = (typeof LineageErrorCode)[keyof typeof LineageErrorCode];", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/error.d.ts", "line": 38, "sha256": "0e15cc42c22eb426723735795b0051efbd2a02b56e826962a267c2fec2c12dfe" } } ], "anchor": "lineageerrorcode" }, { "name": "VerifyConfig", "declarationName": "VerifyConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for lineage chain verification.\n\nControls maximum chain depth, timeouts, and signature verification behavior.", "tags": [ { "name": "example", "text": "```ts\nimport { VerifyConfig } from '@openagentid/oas-lineage';\n\nconst config = VerifyConfig.withMaxGeneration(8);\n```" } ], "signatures": [ { "code": "export interface VerifyConfig {\n readonly maxGeneration: number;\n readonly perHopTimeoutMs: number;\n readonly totalTimeoutMs: number;\n readonly verifyDocumentSignatures: boolean;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 13, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "verifyconfig" }, { "name": "verifyConfigWithMaxGeneration", "declarationName": "verifyConfigWithMaxGeneration", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a verification config with a custom max generation.", "tags": [ { "name": "param", "text": "maxGeneration - The maximum allowed generation depth." }, { "name": "returns", "text": "A frozen {@link VerifyConfig}." } ], "signatures": [ { "code": "export declare function verifyConfigWithMaxGeneration(maxGeneration: number): VerifyConfig;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 35, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "verifyconfigwithmaxgeneration" }, { "name": "verifyConfigWithTimeouts", "declarationName": "verifyConfigWithTimeouts", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a verification config with custom timeouts.", "tags": [ { "name": "param", "text": "perHopTimeoutMs - Timeout per hop in milliseconds." }, { "name": "param", "text": "totalTimeoutMs - Total timeout in milliseconds." }, { "name": "returns", "text": "A frozen {@link VerifyConfig}." } ], "signatures": [ { "code": "export declare function verifyConfigWithTimeouts(perHopTimeoutMs: number, totalTimeoutMs: number): VerifyConfig;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 43, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "verifyconfigwithtimeouts" }, { "name": "verifyLineage", "declarationName": "verifyLineage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies the full lineage chain of an OAS Identity Document.\n\nImplements the OAS Spec Appendix C verification algorithm:\n\n1. If the entity is a root, pass immediately\n2. Verify lineage section exists for non-root entities\n3. Verify chain terminates at a root entity\n4. Verify generation number matches chain length\n5. Verify chain depth does not exceed max generation\n6. Walk the chain, verifying each lineage proof cryptographically\n7. Verify root entity is not revoked", "tags": [ { "name": "param", "text": "doc - The document to verify." }, { "name": "param", "text": "provider - The document provider for resolving parent DIDs." }, { "name": "param", "text": "config - Verification configuration (optional, uses defaults)." }, { "name": "returns", "text": "A {@link VerifyResult} on success." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "LineageError} on verification failure." }, { "name": "example", "text": "```ts\nimport { verifyLineage, InMemoryProvider } from '@openagentid/oas-lineage';\n\nconst provider = new InMemoryProvider();\nprovider.register(parentDoc);\nprovider.register(childDoc);\n\nconst result = await verifyLineage(childDoc, provider);\nconsole.log(result.chainLength); // 1\nconsole.log(result.humanRootDid); // 'did:oas:l1fe:hmr:alice'\n```" } ], "signatures": [ { "code": "export declare function verifyLineage(doc: OasDocument, provider: DocumentProvider, config?: VerifyConfig): Promise;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 47, "sha256": "708ff879c2d3eafc3365a1894ab94c6d2ae714d512749c49c3680bfe04b728b1" } } ], "anchor": "verifylineage" }, { "name": "verifyLineageStructural", "declarationName": "verifyLineageStructural", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Performs structural (non-cryptographic) lineage verification.\n\nChecks shape and consistency of the lineage section without\nresolving parent documents or verifying cryptographic proofs.\nUseful for cheap pre-validation before full verification.", "tags": [ { "name": "param", "text": "doc - The document to verify structurally." }, { "name": "param", "text": "maxGeneration - Maximum allowed generation (default: 16)." }, { "name": "returns", "text": "A {@link VerifyResult} on success." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "LineageError} on structural validation failure." } ], "signatures": [ { "code": "export declare function verifyLineageStructural(doc: OasDocument, maxGeneration?: number): VerifyResult;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 60, "sha256": "708ff879c2d3eafc3365a1894ab94c6d2ae714d512749c49c3680bfe04b728b1" } } ], "anchor": "verifylineagestructural" }, { "name": "VerifyResult", "declarationName": "VerifyResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of a successful lineage verification.", "tags": [], "signatures": [ { "code": "export interface VerifyResult {\n readonly chainLength: number;\n readonly humanRootDid: string;\n readonly warnings: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 7, "sha256": "708ff879c2d3eafc3365a1894ab94c6d2ae714d512749c49c3680bfe04b728b1" } } ], "anchor": "verifyresult" } ], "supportingDeclarations": [ { "name": "Affiliation", "declarationName": "Affiliation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Affiliation {\n readonly did: string;\n readonly relationship: string;\n readonly label?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 1, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "affiliation" }, { "name": "AgentLineageProofData", "declarationName": "AgentLineageProofData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verifiable proof linking a child entity to its parent in the OAS lineage chain.\n\n`AgentLineageProof2025` establishes cryptographic accountability by proving that\na parent entity authorized the creation of a child entity at a specific derivation path.\n\nThe proof contains:\n- The parent and child DIDs\n- The derivation path used for HKDF key derivation\n- The parent's public key (multibase-encoded)\n- An Ed25519 signature over the canonical proof payload\n\nSee OAS Specification §9.4, §9.5 for the complete proof format.", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair, AgentLineageProof } from '@openagentid/oas-crypto';\n\nconst parent = await OasKeyPair.generate();\nconst proof = await AgentLineageProof.generate(\n parent,\n 'did:oas:l1fe:hmr:alice',\n 'did:oas:l1fe:agent:my-bot',\n '/agent-my-bot',\n);\n\nconst valid = await AgentLineageProof.verify(proof);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export interface AgentLineageProofData {\n readonly proofType: typeof PROOF_TYPE;\n readonly parentDid: string;\n readonly childDid: string;\n readonly derivationPath: string;\n readonly algorithm: typeof PROOF_ALGORITHM;\n readonly publicKeyMultibase: string;\n readonly signature: string;\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 40, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "agentlineageproofdata" }, { "name": "ApiSchema", "declarationName": "ApiSchema", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ApiSchema {\n readonly schemaType: string;\n readonly url: string;\n readonly version?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 6, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "apischema" }, { "name": "BookingEndpoint", "declarationName": "BookingEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface BookingEndpoint {\n readonly id: string;\n readonly url: string;\n readonly label?: string;\n readonly bookingType?: string;\n readonly visibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 8, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "bookingendpoint" }, { "name": "CalendarSection", "declarationName": "CalendarSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CalendarSection {\n readonly bookingEndpoints?: ReadonlyArray;\n readonly availabilityFeed?: string;\n readonly schedulingProtocol?: string;\n readonly officeHours?: ReadonlyArray;\n readonly timezone?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 15, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "calendarsection" }, { "name": "Certification", "declarationName": "Certification", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Certification {\n readonly standard: string;\n readonly issuer?: string;\n readonly validUntil?: string;\n readonly url?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 1, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "certification" }, { "name": "ComplianceSection", "declarationName": "ComplianceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ComplianceSection {\n readonly jurisdictions?: ReadonlyArray;\n readonly certifications?: ReadonlyArray;\n readonly termsOfServiceUrl?: string;\n readonly privacyPolicyUrl?: string;\n readonly dataHandlingPolicyUrl?: string;\n readonly dataResidency?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 7, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "compliancesection" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS conformance levels.\n\nEach level represents a tier of compliance with the OAS specification.\nHigher levels subsume lower levels: L2 includes all L1 requirements,\nwhich includes all L0 requirements.\n\n- **L0**: Basic identity (DID, verification method, proof)\n- **L1**: L0 + lineage, conformance declaration, lifecycle\n- **L2**: L2 + full attestation chain, WASM compilation", "tags": [], "signatures": [ { "code": "declare const ConformanceLevel: {\n readonly L0: \"L0\";\n readonly L1: \"L1\";\n readonly L2: \"L2\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 12, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } }, { "code": "export type ConformanceLevel = (typeof ConformanceLevel)[keyof typeof ConformanceLevel];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 20, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "conformancelevel" }, { "name": "ContactEntry", "declarationName": "ContactEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactEntry {\n readonly id: string;\n readonly entryType: string;\n readonly value: string;\n readonly label?: string;\n readonly platform?: string;\n readonly handle?: string;\n readonly visibility?: Visibility;\n readonly verified?: boolean;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 2, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactentry" }, { "name": "ContactSection", "declarationName": "ContactSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactSection {\n readonly entries: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 12, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactsection" }, { "name": "CostEntry", "declarationName": "CostEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CostEntry {\n readonly unit: string;\n readonly amount: string;\n readonly currency: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 2, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "costentry" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A document proof (Ed25519Signature2020) attached to an OAS Identity Document.\n\nThe proof authenticates the document content by signing the JCS-canonicalized\ndocument (excluding the proof itself) with the entity's Ed25519 key.", "tags": [], "signatures": [ { "code": "export interface DocumentProof {\n readonly type: 'Ed25519Signature2020';\n readonly created: string;\n readonly verificationMethod: string;\n readonly proofPurpose: 'assertionMethod';\n readonly proofValue: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 8, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "documentproof" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The set of recognized OAS entity kinds.\n\nEach entity kind represents a category of autonomous entity in the OAS\nidentity system. Root kinds ({@link EntityKind.Hmr}, {@link EntityKind.Mhr},\n{@link EntityKind.Enr}) are the trust anchors from which all other entities\nderive their lineage.", "tags": [ { "name": "example", "text": "```ts\nimport { EntityKind, entityKindFromString } from '@openagentid/oas-did';\n\nconst kind = entityKindFromString('agent');\nconsole.log(kind === EntityKind.Agent); // true\nconsole.log(isRootKind(kind)); // false\n```" } ], "signatures": [ { "code": "declare const EntityKind: {\n readonly Hmr: \"hmr\";\n readonly Mhr: \"mhr\";\n readonly Enr: \"enr\";\n readonly Ao: \"ao\";\n readonly Agent: \"agent\";\n readonly AgentInstance: \"agent:instance\";\n readonly Tool: \"tool\";\n readonly Skill: \"skill\";\n readonly Workflow: \"workflow\";\n readonly Model: \"model\";\n readonly Dataset: \"dataset\";\n readonly Service: \"service\";\n};", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 18, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } }, { "code": "export type EntityKind = (typeof EntityKind)[keyof typeof EntityKind];", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 44, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykind" }, { "name": "GovernancePolicy", "declarationName": "GovernancePolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Policy constraints governing how ENR transitions may occur.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernancePolicy, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst policy = defaultGovernancePolicy();\nconsole.log(policy.maxTransitionsPerDay); // 1\nconsole.log(policy.timelockHours); // 24\n```" } ], "signatures": [ { "code": "export interface GovernancePolicy {\n readonly transitionRequires: string;\n readonly signingKeyRotationRequires: string;\n readonly maxTransitionsPerDay: number;\n readonly timelockHours: number;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 26, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancepolicy" }, { "name": "GovernanceSection", "declarationName": "GovernanceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Governance section attached to ENR identity documents.\n\nTracks the governing MHR, monotonic epoch counter, transition history,\nand governance policy constraints.\n\n**Invariants:**\n- `epoch` MUST strictly increase (no gaps, no rewinds).\n- `currentMhr` MUST reference a valid, non-revoked MHR DID.\n- Each transition's `from` MUST match the previous transition's `to`.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernanceSection, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst gov: GovernanceSection = {\n currentMhr: 'did:oas:prod:mhr:council-alpha',\n epoch: 1,\n transitions: [],\n policy: defaultGovernancePolicy(),\n};\n```" } ], "signatures": [ { "code": "export interface GovernanceSection {\n readonly currentMhr: string;\n readonly epoch: number;\n readonly transitions: ReadonlyArray;\n readonly policy: GovernancePolicy;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 96, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancesection" }, { "name": "GovernanceTransition", "declarationName": "GovernanceTransition", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single governance transition record.\n\nRecords the handoff from one MHR to another, including the\ncryptographic proof (FROST threshold signature from the outgoing MHR).", "tags": [], "signatures": [ { "code": "export interface GovernanceTransition {\n readonly from?: string | undefined;\n readonly to: string;\n readonly epoch: number;\n readonly proof: GovernanceTransitionProof;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 63, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransition" }, { "name": "GovernanceTransitionProof", "declarationName": "GovernanceTransitionProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Proof that a governance transition was authorized.\n\nContains a FROST threshold signature from the outgoing MHR members,\nproving that a quorum approved the handoff.", "tags": [], "signatures": [ { "code": "export interface GovernanceTransitionProof {\n readonly type: string;\n readonly mhrThresholdSignature: string;\n readonly timestamp: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 49, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransitionproof" }, { "name": "InteroperabilitySection", "declarationName": "InteroperabilitySection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface InteroperabilitySection {\n readonly protocols?: ReadonlyArray;\n readonly apiSchemas?: ReadonlyArray;\n readonly authMethods?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 11, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "interoperabilitysection" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS entity lifecycle statuses.\n\nEntities progress through these statuses during their lifetime.\nThe lifecycle is largely linear, but suspension and reactivation\ncreate branches.", "tags": [], "signatures": [ { "code": "declare const LifecycleStatus: {\n readonly Nascent: \"nascent\";\n readonly Active: \"active\";\n readonly Dormant: \"dormant\";\n readonly Suspended: \"suspended\";\n readonly Terminated: \"terminated\";\n readonly Archived: \"archived\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 8, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } }, { "code": "export type LifecycleStatus = (typeof LifecycleStatus)[keyof typeof LifecycleStatus];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 22, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The lineage section of an OAS Identity Document.\n\nDescribes the entity's position in the derivation chain, linking\nit back to its human root. Root entities (HMR, MHR) do not have\na lineage section.", "tags": [ { "name": "example", "text": "```ts\nimport { LineageSection } from '@openagentid/oas-document';\n\nconst lineage: LineageSection = {\n humanRootDid: 'did:oas:l1fe:hmr:alice',\n creatorDid: 'did:oas:l1fe:hmr:alice',\n generation: 1,\n humanRootChain: [\n 'did:oas:l1fe:agent:bot',\n 'did:oas:l1fe:hmr:alice',\n ],\n};\n```" } ], "signatures": [ { "code": "export interface LineageSection {\n readonly humanRootDid: string;\n readonly creatorDid: string;\n readonly generation: number;\n readonly derivationProof?: AgentLineageProofData | undefined;\n readonly humanRootChain: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lineage-section.d.ts", "line": 24, "sha256": "bf29b9bbbfcd3422bf07e21f841b4802ee05271346f881f637ee8f67e0bcb366" } } ], "anchor": "lineagesection" }, { "name": "OAS_VERSION", "declarationName": "OAS_VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Current OAS specification version.", "tags": [], "signatures": [ { "code": "declare const OAS_VERSION: \"1.0.0\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 33, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oas_version" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS Identity Document.\n\nThis is the core identity artifact in the OAS ecosystem. It extends the\nW3C DID Document format with OAS-specific properties for lineage,\nconformance, lifecycle, and entity classification.\n\nDocuments are immutable once created. Use {@link DocumentBuilder } to\nconstruct new documents.", "tags": [ { "name": "example", "text": "```ts\nimport { OasDocument, OAS_VERSION } from '@openagentid/oas-document';\n\n// Documents are created via DocumentBuilder, not constructed directly.\n// See DocumentBuilder for construction examples.\n```" } ], "signatures": [ { "code": "export interface OasDocument {\n readonly '@context': ReadonlyArray;\n readonly id: string;\n readonly controller: string | ReadonlyArray;\n readonly verificationMethod: ReadonlyArray;\n readonly authentication: ReadonlyArray;\n readonly assertionMethod: ReadonlyArray;\n readonly capabilityInvocation: ReadonlyArray;\n readonly capabilityDelegation: ReadonlyArray;\n readonly service: ReadonlyArray;\n readonly oasVersion: typeof OAS_VERSION;\n readonly kind: EntityKind;\n readonly name?: string | undefined;\n readonly description?: string | undefined;\n readonly lineage?: LineageSection | undefined;\n readonly conformanceLevel: ConformanceLevel;\n readonly lifecycleStatus?: LifecycleStatus | undefined;\n readonly sequence: number;\n readonly metadata: Readonly>;\n readonly proof?: DocumentProof | undefined;\n readonly revoked?: boolean | undefined;\n readonly revokedAt?: string | undefined;\n readonly profile?: ProfileSection | undefined;\n readonly contact?: ContactSection | undefined;\n readonly calendar?: CalendarSection | undefined;\n readonly operational?: OperationalSection | undefined;\n readonly pricing?: PricingSection | undefined;\n readonly interoperability?: InteroperabilitySection | undefined;\n readonly reputation?: ReputationSection | undefined;\n readonly compliance?: ComplianceSection | undefined;\n readonly relationships?: RelationshipsSection | undefined;\n readonly governance?: GovernanceSection | undefined;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 52, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oasdocument" }, { "name": "OasKeyPair", "declarationName": "OasKeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 keypair for an OAS entity.\n\nHolds both the signing (private) and verifying (public) keys. The signing key\nis stored as a `Uint8Array` and should be zeroed when no longer needed.\n\n## Security\n\n- Private key bytes are never exposed via `toString()` or `toJSON()`\n- All signature operations use constant-time comparison internally via `@noble/ed25519`\n- Callers should zero the signing key bytes when the keypair is no longer needed:\n `keypair.signingKeyBytes.fill(0)`", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst keypair = await OasKeyPair.generate();\nconst message = new TextEncoder().encode('hello OAS');\nconst signature = await keypair.sign(message);\nconst valid = await OasKeyPair.verifyWithKey(keypair.verifyingKeyBytes, message, signature);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export declare class OasKeyPair {\n static generate(): Promise;\n static fromSigningKeyBytes(bytes: Uint8Array): Promise;\n static verifyingKeyFromBytes(bytes: Uint8Array): Uint8Array;\n sign(message: Uint8Array): Promise;\n static verifyWithKey(publicKeyBytes: Uint8Array, message: Uint8Array, signatureBytes: Uint8Array): Promise;\n get signingKeyBytes(): Uint8Array;\n get verifyingKeyBytes(): Uint8Array;\n publicKeyMultibase(): string;\n toString(): string;\n toJSON(): {\n verifyingKey: string;\n };\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/keypair.d.ts", "line": 25, "sha256": "c143b2ad5ee896897ce3d3e1b554b720354d7351b408205370a4b7a9f8c2139b" } } ], "anchor": "oaskeypair" }, { "name": "OperationalSection", "declarationName": "OperationalSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface OperationalSection {\n readonly availability?: string;\n readonly sla?: ReadonlyArray;\n readonly rateLimits?: ReadonlyArray;\n readonly supportedInputFormats?: ReadonlyArray;\n readonly supportedOutputFormats?: ReadonlyArray;\n readonly maxPayloadBytes?: number;\n readonly maxContextTokens?: number;\n readonly maintenanceWindows?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 11, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "operationalsection" }, { "name": "PricingSection", "declarationName": "PricingSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface PricingSection {\n readonly model: string;\n readonly costs?: ReadonlyArray;\n readonly currenciesAccepted?: ReadonlyArray;\n readonly billingEndpoint?: string;\n readonly freeTierLimits?: string;\n readonly billingVisibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 7, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "pricingsection" }, { "name": "ProfileSection", "declarationName": "ProfileSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProfileSection {\n readonly avatarUrl?: string;\n readonly bannerUrl?: string;\n readonly tagline?: string;\n readonly categories?: ReadonlyArray;\n readonly languages?: ReadonlyArray;\n readonly timezone?: string;\n readonly accentColor?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/profile.d.ts", "line": 1, "sha256": "fa4dc1aeee47ab1108c7bb120a44a1546e7188fb68b2cdf6ea6e32f96b2f575e" } } ], "anchor": "profilesection" }, { "name": "PROOF_ALGORITHM", "declarationName": "PROOF_ALGORITHM", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The algorithm used for key derivation in lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_ALGORITHM: \"HKDF-SHA256-Ed25519\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 9, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_algorithm" }, { "name": "PROOF_TYPE", "declarationName": "PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The proof type identifier for OAS lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_TYPE: \"AgentLineageProof2025\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 5, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_type" }, { "name": "ProtocolSupport", "declarationName": "ProtocolSupport", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProtocolSupport {\n readonly protocol: string;\n readonly version?: string;\n readonly endpoint?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 1, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "protocolsupport" }, { "name": "RateLimit", "declarationName": "RateLimit", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RateLimit {\n readonly resource: string;\n readonly limit: number;\n readonly window: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 6, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "ratelimit" }, { "name": "RelationshipsSection", "declarationName": "RelationshipsSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RelationshipsSection {\n readonly parentOrganization?: string;\n readonly affiliations?: ReadonlyArray;\n readonly blockedDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 6, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "relationshipssection" }, { "name": "ReputationSection", "declarationName": "ReputationSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ReputationSection {\n readonly totalInteractions?: number;\n readonly endorsementCount?: number;\n readonly trustScore?: string;\n readonly uptime30d?: string;\n readonly uptime90d?: string;\n readonly firstActive?: string;\n readonly endorserDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/reputation.d.ts", "line": 1, "sha256": "f7e4816a049d93e1c05d6f9a26150fa8e3656567bba68a9bddef244cd51c9aae" } } ], "anchor": "reputationsection" }, { "name": "ScheduleWindow", "declarationName": "ScheduleWindow", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ScheduleWindow {\n readonly day: string;\n readonly start: string;\n readonly end: string;\n readonly timezone: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 2, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "schedulewindow" }, { "name": "ServiceEndpoint", "declarationName": "ServiceEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A service endpoint declaration in an OAS Identity Document.\n\nServices describe how to interact with the entity — API endpoints,\ncommunication channels, discovery mechanisms, etc.", "tags": [ { "name": "example", "text": "```ts\nimport { ServiceEndpoint } from '@openagentid/oas-document';\n\nconst service: ServiceEndpoint = {\n id: 'did:oas:l1fe:agent:bot#api',\n type: 'AgentApi',\n serviceEndpoint: 'https://api.l1fe.ai/agents/bot',\n};\n```" } ], "signatures": [ { "code": "export interface ServiceEndpoint {\n readonly id: string;\n readonly type: string;\n readonly serviceEndpoint: string;\n readonly label?: string;\n readonly description?: string;\n readonly properties?: Readonly>;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/service.d.ts", "line": 18, "sha256": "760d3af9b43ea7ee9f9f4bf43edecda47987acee0492e1fbadb8c3f52549c0e4" } } ], "anchor": "serviceendpoint" }, { "name": "SlaCommitment", "declarationName": "SlaCommitment", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface SlaCommitment {\n readonly metric: string;\n readonly target: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 2, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "slacommitment" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An Ed25519 verification method in an OAS Identity Document.\n\nVerification methods bind public keys to the DID subject, enabling\nsignature verification on documents, proofs, and attestations.", "tags": [ { "name": "example", "text": "```ts\nimport { createVerificationMethod } from '@openagentid/oas-document';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst kp = OasKeyPair.generate();\nconst vm = createVerificationMethod('did:oas:l1fe:agent:bot', 1, kp);\nconsole.log(vm.id); // 'did:oas:l1fe:agent:bot#key-1'\nconsole.log(vm.type); // 'Ed25519VerificationKey2020'\n```" } ], "signatures": [ { "code": "export interface VerificationMethod {\n readonly id: string;\n readonly type: 'Ed25519VerificationKey2020';\n readonly controller: string;\n readonly publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 19, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "verificationmethod" }, { "name": "Visibility", "declarationName": "Visibility", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type Visibility = 'public' | 'authenticated' | 'organization' | 'private';", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/visibility.d.ts", "line": 1, "sha256": "1315dc096b8891ee4f8e89553cee8fd48686954d4fe4da52eae62dab8b53d2be" } } ], "anchor": "visibility" } ], "coverage": { "discovered": 13, "documented": 13, "missing": [] } } ] }, { "name": "@openagentid/oas-resolve", "version": "1.0.2", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oas-resolve/-/oas-resolve-1.0.2.tgz", "integrity": "sha512-aPu2d1VKAyj9Bgl+YmjoPt4YZKgx3qWXwAkv5VtsartpENCTlk1oYoUT6iirurOZfFE1LwSBloeiiCJBAjRGqg==", "packageJsonSha256": "973dfb6c64bbb8c150aca9a8e048bd70a25f34979b47c07624fc659bad964b8d", "page": "/reference/typescript/oas-resolve", "engines": { "node": ">=20" }, "dependencies": { "@openagentid/oas-document": "1.0.2" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-resolve", "page": "/reference/typescript/oas-resolve", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "CachingResolver", "declarationName": "CachingResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Caching wrapper for any {@link Resolver}.\n\nCaches resolved documents with a configurable TTL (time-to-live).\nCache misses are forwarded to the inner resolver. Expired entries\nare transparently refreshed.", "tags": [ { "name": "example", "text": "```ts\nimport { CachingResolver, InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst inner = new InMemoryResolver();\nconst cached = new CachingResolver(inner, 60_000); // 60s TTL\n```" } ], "signatures": [ { "code": "export declare class CachingResolver implements Resolver {\n constructor(inner: Resolver, ttlMs?: number);\n resolve(did: string): Promise;\n invalidate(did: string): void;\n clear(): void;\n get size(): number;\n get isEmpty(): boolean;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/cache.d.ts", "line": 18, "sha256": "0023f1c2db3a9e077c330b57c8b87b91ff3bceebc5aa2de0b56de52d72234264" } } ], "anchor": "cachingresolver" }, { "name": "FallbackResolver", "declarationName": "FallbackResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Fallback resolver that tries multiple resolvers in priority order.\n\nReturns the result from the first resolver that succeeds. If all\nresolvers fail, throws an error aggregating all failure reasons.", "tags": [ { "name": "example", "text": "```ts\nimport { FallbackResolver, InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst primary = new InMemoryResolver();\nconst secondary = new InMemoryResolver();\nconst resolver = new FallbackResolver([primary, secondary]);\n```" } ], "signatures": [ { "code": "export declare class FallbackResolver implements Resolver {\n constructor(resolvers: ReadonlyArray);\n resolve(did: string): Promise;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/fallback.d.ts", "line": 18, "sha256": "233ecda045fe84106f0b59d262cfd696afde37bb519255607662f36fc7ee3fd3" } } ], "anchor": "fallbackresolver" }, { "name": "InMemoryResolver", "declarationName": "InMemoryResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory DID resolver for testing and local usage.\n\nStores documents in a Map keyed by DID string. This is the standard\ntesting approach across the OAS stack.", "tags": [ { "name": "example", "text": "```ts\nimport { InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst resolver = new InMemoryResolver();\nresolver.register(document);\nconst doc = await resolver.resolve('did:oas:l1fe:hmr:alice');\n```" } ], "signatures": [ { "code": "export declare class InMemoryResolver implements Resolver {\n register(doc: OasDocument): void;\n remove(did: string): boolean;\n resolve(did: string): Promise;\n get size(): number;\n get isEmpty(): boolean;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/memory.d.ts", "line": 18, "sha256": "dc1d978e858372c1d635aac1f0dfc312b8ef8e053dd71e4a055231e183437330" } } ], "anchor": "inmemoryresolver" }, { "name": "ResolveError", "declarationName": "ResolveError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for resolution operations.\n\nCarries a machine-readable code from the OAS §12.5 error code registry\nand a human-readable message.", "tags": [ { "name": "example", "text": "```ts\nimport { ResolveError, ResolveErrorCode } from '@openagentid/oas-resolve';\n\nconst err = new ResolveError(\n ResolveErrorCode.NotFound,\n \"DID 'did:oas:l1fe:agent:unknown' not found in any configured resolver\"\n);\n```" } ], "signatures": [ { "code": "export declare class ResolveError extends Error {\n readonly code: ResolveErrorCode;\n readonly details: Readonly>;\n constructor(code: ResolveErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/error.d.ts", "line": 47, "sha256": "f09a1454c70a650b40585488ce7f14980a15bdc2bc372d4b6577c585904d6118" } } ], "anchor": "resolveerror" }, { "name": "ResolveErrorCode", "declarationName": "ResolveErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for DID resolution operations.\n\nThese codes map to the OAS Spec §12.5 error code registry.", "tags": [], "signatures": [ { "code": "declare const ResolveErrorCode: {\n readonly NotFound: \"NOT_FOUND\";\n readonly InvalidSignature: \"INVALID_SIGNATURE\";\n readonly Revoked: \"REVOKED\";\n readonly LineageInvalid: \"LINEAGE_INVALID\";\n readonly Timeout: \"TIMEOUT\";\n readonly NetworkError: \"NETWORK_ERROR\";\n readonly Unsupported: \"UNSUPPORTED\";\n readonly InternalError: \"INTERNAL_ERROR\";\n readonly InvalidDid: \"INVALID_DID\";\n readonly RateLimited: \"RATE_LIMITED\";\n readonly AllResolversFailed: \"ALL_RESOLVERS_FAILED\";\n};", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/error.d.ts", "line": 6, "sha256": "f09a1454c70a650b40585488ce7f14980a15bdc2bc372d4b6577c585904d6118" } }, { "code": "export type ResolveErrorCode = (typeof ResolveErrorCode)[keyof typeof ResolveErrorCode];", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/error.d.ts", "line": 30, "sha256": "f09a1454c70a650b40585488ce7f14980a15bdc2bc372d4b6577c585904d6118" } } ], "anchor": "resolveerrorcode" }, { "name": "Resolver", "declarationName": "Resolver", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Interface for asynchronous OAS DID resolution.\n\nImplementations resolve `did:oas:*` strings to their Identity Documents\nfrom various backends: in-memory maps, HTTP servers, DHT networks,\nMARS registries, etc.\n\nThe OAS SDK defines this interface; consumers implement it for their\ninfrastructure. This is the agnosticism boundary.", "tags": [ { "name": "example", "text": "```ts\nimport { Resolver, InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst resolver: Resolver = new InMemoryResolver();\n```" } ], "signatures": [ { "code": "export interface Resolver {\n resolve(did: string): Promise;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/resolver.d.ts", "line": 19, "sha256": "efc4dd6a39a82fdd27d95dfe46bcc08506b07c7efe0159b0277ef4d98577353a" } } ], "anchor": "resolver" } ], "supportingDeclarations": [ { "name": "Affiliation", "declarationName": "Affiliation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Affiliation {\n readonly did: string;\n readonly relationship: string;\n readonly label?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 1, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "affiliation" }, { "name": "AgentLineageProofData", "declarationName": "AgentLineageProofData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verifiable proof linking a child entity to its parent in the OAS lineage chain.\n\n`AgentLineageProof2025` establishes cryptographic accountability by proving that\na parent entity authorized the creation of a child entity at a specific derivation path.\n\nThe proof contains:\n- The parent and child DIDs\n- The derivation path used for HKDF key derivation\n- The parent's public key (multibase-encoded)\n- An Ed25519 signature over the canonical proof payload\n\nSee OAS Specification §9.4, §9.5 for the complete proof format.", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair, AgentLineageProof } from '@openagentid/oas-crypto';\n\nconst parent = await OasKeyPair.generate();\nconst proof = await AgentLineageProof.generate(\n parent,\n 'did:oas:l1fe:hmr:alice',\n 'did:oas:l1fe:agent:my-bot',\n '/agent-my-bot',\n);\n\nconst valid = await AgentLineageProof.verify(proof);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export interface AgentLineageProofData {\n readonly proofType: typeof PROOF_TYPE;\n readonly parentDid: string;\n readonly childDid: string;\n readonly derivationPath: string;\n readonly algorithm: typeof PROOF_ALGORITHM;\n readonly publicKeyMultibase: string;\n readonly signature: string;\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 40, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "agentlineageproofdata" }, { "name": "ApiSchema", "declarationName": "ApiSchema", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ApiSchema {\n readonly schemaType: string;\n readonly url: string;\n readonly version?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 6, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "apischema" }, { "name": "BookingEndpoint", "declarationName": "BookingEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface BookingEndpoint {\n readonly id: string;\n readonly url: string;\n readonly label?: string;\n readonly bookingType?: string;\n readonly visibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 8, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "bookingendpoint" }, { "name": "CalendarSection", "declarationName": "CalendarSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CalendarSection {\n readonly bookingEndpoints?: ReadonlyArray;\n readonly availabilityFeed?: string;\n readonly schedulingProtocol?: string;\n readonly officeHours?: ReadonlyArray;\n readonly timezone?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 15, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "calendarsection" }, { "name": "Certification", "declarationName": "Certification", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Certification {\n readonly standard: string;\n readonly issuer?: string;\n readonly validUntil?: string;\n readonly url?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 1, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "certification" }, { "name": "ComplianceSection", "declarationName": "ComplianceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ComplianceSection {\n readonly jurisdictions?: ReadonlyArray;\n readonly certifications?: ReadonlyArray;\n readonly termsOfServiceUrl?: string;\n readonly privacyPolicyUrl?: string;\n readonly dataHandlingPolicyUrl?: string;\n readonly dataResidency?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 7, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "compliancesection" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS conformance levels.\n\nEach level represents a tier of compliance with the OAS specification.\nHigher levels subsume lower levels: L2 includes all L1 requirements,\nwhich includes all L0 requirements.\n\n- **L0**: Basic identity (DID, verification method, proof)\n- **L1**: L0 + lineage, conformance declaration, lifecycle\n- **L2**: L2 + full attestation chain, WASM compilation", "tags": [], "signatures": [ { "code": "declare const ConformanceLevel: {\n readonly L0: \"L0\";\n readonly L1: \"L1\";\n readonly L2: \"L2\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 12, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } }, { "code": "export type ConformanceLevel = (typeof ConformanceLevel)[keyof typeof ConformanceLevel];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 20, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "conformancelevel" }, { "name": "ContactEntry", "declarationName": "ContactEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactEntry {\n readonly id: string;\n readonly entryType: string;\n readonly value: string;\n readonly label?: string;\n readonly platform?: string;\n readonly handle?: string;\n readonly visibility?: Visibility;\n readonly verified?: boolean;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 2, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactentry" }, { "name": "ContactSection", "declarationName": "ContactSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactSection {\n readonly entries: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 12, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactsection" }, { "name": "CostEntry", "declarationName": "CostEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CostEntry {\n readonly unit: string;\n readonly amount: string;\n readonly currency: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 2, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "costentry" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A document proof (Ed25519Signature2020) attached to an OAS Identity Document.\n\nThe proof authenticates the document content by signing the JCS-canonicalized\ndocument (excluding the proof itself) with the entity's Ed25519 key.", "tags": [], "signatures": [ { "code": "export interface DocumentProof {\n readonly type: 'Ed25519Signature2020';\n readonly created: string;\n readonly verificationMethod: string;\n readonly proofPurpose: 'assertionMethod';\n readonly proofValue: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 8, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "documentproof" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The set of recognized OAS entity kinds.\n\nEach entity kind represents a category of autonomous entity in the OAS\nidentity system. Root kinds ({@link EntityKind.Hmr}, {@link EntityKind.Mhr},\n{@link EntityKind.Enr}) are the trust anchors from which all other entities\nderive their lineage.", "tags": [ { "name": "example", "text": "```ts\nimport { EntityKind, entityKindFromString } from '@openagentid/oas-did';\n\nconst kind = entityKindFromString('agent');\nconsole.log(kind === EntityKind.Agent); // true\nconsole.log(isRootKind(kind)); // false\n```" } ], "signatures": [ { "code": "declare const EntityKind: {\n readonly Hmr: \"hmr\";\n readonly Mhr: \"mhr\";\n readonly Enr: \"enr\";\n readonly Ao: \"ao\";\n readonly Agent: \"agent\";\n readonly AgentInstance: \"agent:instance\";\n readonly Tool: \"tool\";\n readonly Skill: \"skill\";\n readonly Workflow: \"workflow\";\n readonly Model: \"model\";\n readonly Dataset: \"dataset\";\n readonly Service: \"service\";\n};", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 18, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } }, { "code": "export type EntityKind = (typeof EntityKind)[keyof typeof EntityKind];", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 44, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykind" }, { "name": "GovernancePolicy", "declarationName": "GovernancePolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Policy constraints governing how ENR transitions may occur.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernancePolicy, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst policy = defaultGovernancePolicy();\nconsole.log(policy.maxTransitionsPerDay); // 1\nconsole.log(policy.timelockHours); // 24\n```" } ], "signatures": [ { "code": "export interface GovernancePolicy {\n readonly transitionRequires: string;\n readonly signingKeyRotationRequires: string;\n readonly maxTransitionsPerDay: number;\n readonly timelockHours: number;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 26, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancepolicy" }, { "name": "GovernanceSection", "declarationName": "GovernanceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Governance section attached to ENR identity documents.\n\nTracks the governing MHR, monotonic epoch counter, transition history,\nand governance policy constraints.\n\n**Invariants:**\n- `epoch` MUST strictly increase (no gaps, no rewinds).\n- `currentMhr` MUST reference a valid, non-revoked MHR DID.\n- Each transition's `from` MUST match the previous transition's `to`.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernanceSection, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst gov: GovernanceSection = {\n currentMhr: 'did:oas:prod:mhr:council-alpha',\n epoch: 1,\n transitions: [],\n policy: defaultGovernancePolicy(),\n};\n```" } ], "signatures": [ { "code": "export interface GovernanceSection {\n readonly currentMhr: string;\n readonly epoch: number;\n readonly transitions: ReadonlyArray;\n readonly policy: GovernancePolicy;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 96, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancesection" }, { "name": "GovernanceTransition", "declarationName": "GovernanceTransition", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single governance transition record.\n\nRecords the handoff from one MHR to another, including the\ncryptographic proof (FROST threshold signature from the outgoing MHR).", "tags": [], "signatures": [ { "code": "export interface GovernanceTransition {\n readonly from?: string | undefined;\n readonly to: string;\n readonly epoch: number;\n readonly proof: GovernanceTransitionProof;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 63, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransition" }, { "name": "GovernanceTransitionProof", "declarationName": "GovernanceTransitionProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Proof that a governance transition was authorized.\n\nContains a FROST threshold signature from the outgoing MHR members,\nproving that a quorum approved the handoff.", "tags": [], "signatures": [ { "code": "export interface GovernanceTransitionProof {\n readonly type: string;\n readonly mhrThresholdSignature: string;\n readonly timestamp: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 49, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransitionproof" }, { "name": "InteroperabilitySection", "declarationName": "InteroperabilitySection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface InteroperabilitySection {\n readonly protocols?: ReadonlyArray;\n readonly apiSchemas?: ReadonlyArray;\n readonly authMethods?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 11, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "interoperabilitysection" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS entity lifecycle statuses.\n\nEntities progress through these statuses during their lifetime.\nThe lifecycle is largely linear, but suspension and reactivation\ncreate branches.", "tags": [], "signatures": [ { "code": "declare const LifecycleStatus: {\n readonly Nascent: \"nascent\";\n readonly Active: \"active\";\n readonly Dormant: \"dormant\";\n readonly Suspended: \"suspended\";\n readonly Terminated: \"terminated\";\n readonly Archived: \"archived\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 8, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } }, { "code": "export type LifecycleStatus = (typeof LifecycleStatus)[keyof typeof LifecycleStatus];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 22, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The lineage section of an OAS Identity Document.\n\nDescribes the entity's position in the derivation chain, linking\nit back to its human root. Root entities (HMR, MHR) do not have\na lineage section.", "tags": [ { "name": "example", "text": "```ts\nimport { LineageSection } from '@openagentid/oas-document';\n\nconst lineage: LineageSection = {\n humanRootDid: 'did:oas:l1fe:hmr:alice',\n creatorDid: 'did:oas:l1fe:hmr:alice',\n generation: 1,\n humanRootChain: [\n 'did:oas:l1fe:agent:bot',\n 'did:oas:l1fe:hmr:alice',\n ],\n};\n```" } ], "signatures": [ { "code": "export interface LineageSection {\n readonly humanRootDid: string;\n readonly creatorDid: string;\n readonly generation: number;\n readonly derivationProof?: AgentLineageProofData | undefined;\n readonly humanRootChain: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lineage-section.d.ts", "line": 24, "sha256": "bf29b9bbbfcd3422bf07e21f841b4802ee05271346f881f637ee8f67e0bcb366" } } ], "anchor": "lineagesection" }, { "name": "OAS_VERSION", "declarationName": "OAS_VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Current OAS specification version.", "tags": [], "signatures": [ { "code": "declare const OAS_VERSION: \"1.0.0\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 33, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oas_version" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS Identity Document.\n\nThis is the core identity artifact in the OAS ecosystem. It extends the\nW3C DID Document format with OAS-specific properties for lineage,\nconformance, lifecycle, and entity classification.\n\nDocuments are immutable once created. Use {@link DocumentBuilder } to\nconstruct new documents.", "tags": [ { "name": "example", "text": "```ts\nimport { OasDocument, OAS_VERSION } from '@openagentid/oas-document';\n\n// Documents are created via DocumentBuilder, not constructed directly.\n// See DocumentBuilder for construction examples.\n```" } ], "signatures": [ { "code": "export interface OasDocument {\n readonly '@context': ReadonlyArray;\n readonly id: string;\n readonly controller: string | ReadonlyArray;\n readonly verificationMethod: ReadonlyArray;\n readonly authentication: ReadonlyArray;\n readonly assertionMethod: ReadonlyArray;\n readonly capabilityInvocation: ReadonlyArray;\n readonly capabilityDelegation: ReadonlyArray;\n readonly service: ReadonlyArray;\n readonly oasVersion: typeof OAS_VERSION;\n readonly kind: EntityKind;\n readonly name?: string | undefined;\n readonly description?: string | undefined;\n readonly lineage?: LineageSection | undefined;\n readonly conformanceLevel: ConformanceLevel;\n readonly lifecycleStatus?: LifecycleStatus | undefined;\n readonly sequence: number;\n readonly metadata: Readonly>;\n readonly proof?: DocumentProof | undefined;\n readonly revoked?: boolean | undefined;\n readonly revokedAt?: string | undefined;\n readonly profile?: ProfileSection | undefined;\n readonly contact?: ContactSection | undefined;\n readonly calendar?: CalendarSection | undefined;\n readonly operational?: OperationalSection | undefined;\n readonly pricing?: PricingSection | undefined;\n readonly interoperability?: InteroperabilitySection | undefined;\n readonly reputation?: ReputationSection | undefined;\n readonly compliance?: ComplianceSection | undefined;\n readonly relationships?: RelationshipsSection | undefined;\n readonly governance?: GovernanceSection | undefined;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 52, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oasdocument" }, { "name": "OperationalSection", "declarationName": "OperationalSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface OperationalSection {\n readonly availability?: string;\n readonly sla?: ReadonlyArray;\n readonly rateLimits?: ReadonlyArray;\n readonly supportedInputFormats?: ReadonlyArray;\n readonly supportedOutputFormats?: ReadonlyArray;\n readonly maxPayloadBytes?: number;\n readonly maxContextTokens?: number;\n readonly maintenanceWindows?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 11, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "operationalsection" }, { "name": "PricingSection", "declarationName": "PricingSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface PricingSection {\n readonly model: string;\n readonly costs?: ReadonlyArray;\n readonly currenciesAccepted?: ReadonlyArray;\n readonly billingEndpoint?: string;\n readonly freeTierLimits?: string;\n readonly billingVisibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 7, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "pricingsection" }, { "name": "ProfileSection", "declarationName": "ProfileSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProfileSection {\n readonly avatarUrl?: string;\n readonly bannerUrl?: string;\n readonly tagline?: string;\n readonly categories?: ReadonlyArray;\n readonly languages?: ReadonlyArray;\n readonly timezone?: string;\n readonly accentColor?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/profile.d.ts", "line": 1, "sha256": "fa4dc1aeee47ab1108c7bb120a44a1546e7188fb68b2cdf6ea6e32f96b2f575e" } } ], "anchor": "profilesection" }, { "name": "PROOF_ALGORITHM", "declarationName": "PROOF_ALGORITHM", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The algorithm used for key derivation in lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_ALGORITHM: \"HKDF-SHA256-Ed25519\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 9, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_algorithm" }, { "name": "PROOF_TYPE", "declarationName": "PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The proof type identifier for OAS lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_TYPE: \"AgentLineageProof2025\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 5, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_type" }, { "name": "ProtocolSupport", "declarationName": "ProtocolSupport", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProtocolSupport {\n readonly protocol: string;\n readonly version?: string;\n readonly endpoint?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 1, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "protocolsupport" }, { "name": "RateLimit", "declarationName": "RateLimit", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RateLimit {\n readonly resource: string;\n readonly limit: number;\n readonly window: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 6, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "ratelimit" }, { "name": "RelationshipsSection", "declarationName": "RelationshipsSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RelationshipsSection {\n readonly parentOrganization?: string;\n readonly affiliations?: ReadonlyArray;\n readonly blockedDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 6, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "relationshipssection" }, { "name": "ReputationSection", "declarationName": "ReputationSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ReputationSection {\n readonly totalInteractions?: number;\n readonly endorsementCount?: number;\n readonly trustScore?: string;\n readonly uptime30d?: string;\n readonly uptime90d?: string;\n readonly firstActive?: string;\n readonly endorserDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/reputation.d.ts", "line": 1, "sha256": "f7e4816a049d93e1c05d6f9a26150fa8e3656567bba68a9bddef244cd51c9aae" } } ], "anchor": "reputationsection" }, { "name": "ScheduleWindow", "declarationName": "ScheduleWindow", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ScheduleWindow {\n readonly day: string;\n readonly start: string;\n readonly end: string;\n readonly timezone: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 2, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "schedulewindow" }, { "name": "ServiceEndpoint", "declarationName": "ServiceEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A service endpoint declaration in an OAS Identity Document.\n\nServices describe how to interact with the entity — API endpoints,\ncommunication channels, discovery mechanisms, etc.", "tags": [ { "name": "example", "text": "```ts\nimport { ServiceEndpoint } from '@openagentid/oas-document';\n\nconst service: ServiceEndpoint = {\n id: 'did:oas:l1fe:agent:bot#api',\n type: 'AgentApi',\n serviceEndpoint: 'https://api.l1fe.ai/agents/bot',\n};\n```" } ], "signatures": [ { "code": "export interface ServiceEndpoint {\n readonly id: string;\n readonly type: string;\n readonly serviceEndpoint: string;\n readonly label?: string;\n readonly description?: string;\n readonly properties?: Readonly>;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/service.d.ts", "line": 18, "sha256": "760d3af9b43ea7ee9f9f4bf43edecda47987acee0492e1fbadb8c3f52549c0e4" } } ], "anchor": "serviceendpoint" }, { "name": "SlaCommitment", "declarationName": "SlaCommitment", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface SlaCommitment {\n readonly metric: string;\n readonly target: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 2, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "slacommitment" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An Ed25519 verification method in an OAS Identity Document.\n\nVerification methods bind public keys to the DID subject, enabling\nsignature verification on documents, proofs, and attestations.", "tags": [ { "name": "example", "text": "```ts\nimport { createVerificationMethod } from '@openagentid/oas-document';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst kp = OasKeyPair.generate();\nconst vm = createVerificationMethod('did:oas:l1fe:agent:bot', 1, kp);\nconsole.log(vm.id); // 'did:oas:l1fe:agent:bot#key-1'\nconsole.log(vm.type); // 'Ed25519VerificationKey2020'\n```" } ], "signatures": [ { "code": "export interface VerificationMethod {\n readonly id: string;\n readonly type: 'Ed25519VerificationKey2020';\n readonly controller: string;\n readonly publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 19, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "verificationmethod" }, { "name": "Visibility", "declarationName": "Visibility", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type Visibility = 'public' | 'authenticated' | 'organization' | 'private';", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/visibility.d.ts", "line": 1, "sha256": "1315dc096b8891ee4f8e89553cee8fd48686954d4fe4da52eae62dab8b53d2be" } } ], "anchor": "visibility" } ], "coverage": { "discovered": 6, "documented": 6, "missing": [] } } ] }, { "name": "@openagentid/oas-sdk", "version": "1.0.2", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oas-sdk/-/oas-sdk-1.0.2.tgz", "integrity": "sha512-oU/OXqDSFZAcna7MJtd7Di98qphFON7L5ZZcpY6Ybln0GzWQaxT+hzkoxef6oy08unAOHxh9/t2w6ES5r7QCuw==", "packageJsonSha256": "b324d0cce364c972fbcc97bc446daf5cac2be63c32cf155c075b87cccb291cd8", "page": "/reference/typescript/oas-sdk", "engines": { "node": ">=20" }, "dependencies": { "@openagentid/oas-did": "1.0.2", "@openagentid/oas-crypto": "1.0.2", "@openagentid/oas-document": "1.0.2", "@openagentid/oas-lineage": "1.0.2", "@openagentid/oas-resolve": "1.0.2", "@openagentid/oas-attestation": "1.0.2" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-sdk", "page": "/reference/typescript/oas-sdk", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "AgentLineageProof provides generation and verification of OAS lineage proofs.\n\nSee OAS Specification §9.4 (generation) and §9.5 (verification).", "tags": [], "signatures": [ { "code": "declare const AgentLineageProof: {\n readonly generate: (parentKeypair: OasKeyPair, parentDid: string, childDid: string, derivationPath: string) => Promise;\n readonly verify: (proof: AgentLineageProofData) => Promise;\n readonly verifyWithKey: (proof: AgentLineageProofData, publicKeyMultibase: string) => Promise;\n readonly toJSON: (proof: AgentLineageProofData) => Record;\n readonly fromJSON: (obj: Record) => AgentLineageProofData;\n};", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 61, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "agentlineageproof" }, { "name": "AgentLineageProofData", "declarationName": "AgentLineageProofData", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A verifiable proof linking a child entity to its parent in the OAS lineage chain.\n\n`AgentLineageProof2025` establishes cryptographic accountability by proving that\na parent entity authorized the creation of a child entity at a specific derivation path.\n\nThe proof contains:\n- The parent and child DIDs\n- The derivation path used for HKDF key derivation\n- The parent's public key (multibase-encoded)\n- An Ed25519 signature over the canonical proof payload\n\nSee OAS Specification §9.4, §9.5 for the complete proof format.", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair, AgentLineageProof } from '@openagentid/oas-crypto';\n\nconst parent = await OasKeyPair.generate();\nconst proof = await AgentLineageProof.generate(\n parent,\n 'did:oas:l1fe:hmr:alice',\n 'did:oas:l1fe:agent:my-bot',\n '/agent-my-bot',\n);\n\nconst valid = await AgentLineageProof.verify(proof);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export interface AgentLineageProofData {\n readonly proofType: typeof PROOF_TYPE;\n readonly parentDid: string;\n readonly childDid: string;\n readonly derivationPath: string;\n readonly algorithm: typeof PROOF_ALGORITHM;\n readonly publicKeyMultibase: string;\n readonly signature: string;\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 40, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "agentlineageproofdata" }, { "name": "AttestationError", "declarationName": "AttestationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for attestation operations.", "tags": [], "signatures": [ { "code": "export declare class AttestationError extends Error {\n readonly code: AttestationErrorCode;\n readonly details: Readonly>;\n constructor(code: AttestationErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/error.d.ts", "line": 32, "sha256": "949a9230827528610d16752c10a687f956612c85a1a3cd64defdd6e81f339c9f" } } ], "anchor": "attestationerror" }, { "name": "AttestationErrorCode", "declarationName": "AttestationErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for attestation operations.", "tags": [], "signatures": [ { "code": "declare const AttestationErrorCode: {\n readonly InvalidIssuer: \"INVALID_ISSUER\";\n readonly InvalidSubject: \"INVALID_SUBJECT\";\n readonly UnknownAttestationType: \"UNKNOWN_ATTESTATION_TYPE\";\n readonly MissingProof: \"MISSING_PROOF\";\n readonly InvalidProofSignature: \"INVALID_PROOF_SIGNATURE\";\n readonly ProofGenerationFailed: \"PROOF_GENERATION_FAILED\";\n readonly Expired: \"EXPIRED\";\n readonly NotYetValid: \"NOT_YET_VALID\";\n readonly MissingField: \"MISSING_FIELD\";\n readonly Json: \"JSON_ERROR\";\n readonly Crypto: \"CRYPTO_ERROR\";\n};", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/error.d.ts", "line": 4, "sha256": "949a9230827528610d16752c10a687f956612c85a1a3cd64defdd6e81f339c9f" } }, { "code": "export type AttestationErrorCode = (typeof AttestationErrorCode)[keyof typeof AttestationErrorCode];", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/error.d.ts", "line": 28, "sha256": "949a9230827528610d16752c10a687f956612c85a1a3cd64defdd6e81f339c9f" } } ], "anchor": "attestationerrorcode" }, { "name": "AttestationType", "declarationName": "AttestationType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard OAS attestation types.\n\nThese represent the categories of verifiable claims that can be made\nabout OAS entities.", "tags": [], "signatures": [ { "code": "declare const AttestationType: {\n readonly SecurityAudit: \"SecurityAudit\";\n readonly BehaviorAttestation: \"BehaviorAttestation\";\n readonly CapabilityVerification: \"CapabilityVerification\";\n readonly ComplianceAttestation: \"ComplianceAttestation\";\n readonly ExpertEndorsement: \"ExpertEndorsement\";\n readonly CommunityReview: \"CommunityReview\";\n};", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 7, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "attestationtype" }, { "name": "AttestationTypeValue", "declarationName": "AttestationTypeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Union of standard attestation types and custom strings.", "tags": [], "signatures": [ { "code": "export type AttestationTypeValue = StandardAttestationType | `Custom:${string}`;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 25, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "attestationtypevalue" }, { "name": "AuthorityOrgRoot", "declarationName": "AuthorityOrgRoot", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Org root returned by a resolver/GAL authority backend.", "tags": [], "signatures": [ { "code": "export interface AuthorityOrgRoot {\n readonly orgDid: string;\n readonly commitment: string;\n readonly status: string;\n readonly anchoredAtBlock: number;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 95, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "authorityorgroot" }, { "name": "AuthorityPathKind", "declarationName": "AuthorityPathKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Required privileged authority path shape.", "tags": [], "signatures": [ { "code": "declare const AuthorityPathKind: {\n readonly HumanToAgent: \"human_to_agent\";\n readonly AgentToOrg: \"agent_to_org\";\n readonly OrgToAgent: \"org_to_agent\";\n readonly AgentToHuman: \"agent_to_human\";\n};", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 15, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } }, { "code": "export type AuthorityPathKind = (typeof AuthorityPathKind)[keyof typeof AuthorityPathKind] | (string & {});", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 21, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "authoritypathkind" }, { "name": "AuthorityPathKindValue", "declarationName": "AuthorityPathKind", "kind": "VariableDeclaration", "typeOnly": true, "documentation": "Required privileged authority path shape.", "tags": [], "signatures": [ { "code": "declare const AuthorityPathKind: {\n readonly HumanToAgent: \"human_to_agent\";\n readonly AgentToOrg: \"agent_to_org\";\n readonly OrgToAgent: \"org_to_agent\";\n readonly AgentToHuman: \"agent_to_human\";\n};", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 15, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } }, { "code": "export type AuthorityPathKind = (typeof AuthorityPathKind)[keyof typeof AuthorityPathKind] | (string & {});", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 21, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "authoritypathkindvalue" }, { "name": "AuthorityRevocationStatus", "declarationName": "AuthorityRevocationStatus", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Revocation result from a resolver/GAL authority backend.", "tags": [], "signatures": [ { "code": "export interface AuthorityRevocationStatus {\n readonly revoked: boolean;\n readonly reasonCommitment?: string;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 81, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "authorityrevocationstatus" }, { "name": "AuthorityRootAnchor", "declarationName": "AuthorityRootAnchor", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Root anchor returned by a resolver/GAL authority backend.", "tags": [], "signatures": [ { "code": "export interface AuthorityRootAnchor {\n readonly did: string;\n readonly kind: 'hmr' | 'mhr' | 'enr' | string;\n readonly status: string;\n readonly anchoredAtBlock: number;\n readonly source?: string;\n readonly scopes?: readonly string[];\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 86, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "authorityrootanchor" }, { "name": "base64urlDecode", "declarationName": "base64urlDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a base64url string (RFC 4648 §5, no padding) to bytes.", "tags": [ { "name": "param", "text": "encoded - The base64url-encoded string." }, { "name": "returns", "text": "The decoded bytes." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.Base64DecodeFailed } on failure." }, { "name": "example", "text": "```ts\nimport { base64urlEncode, base64urlDecode } from '@openagentid/oas-crypto';\n\nconst original = new Uint8Array([72, 101, 108, 108, 111]);\nconst decoded = base64urlDecode(base64urlEncode(original));\n// decoded equals original\n```" } ], "signatures": [ { "code": "export declare function base64urlDecode(encoded: string): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 68, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "base64urldecode" }, { "name": "base64urlEncode", "declarationName": "base64urlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as base64url (RFC 4648 §5, no padding).", "tags": [ { "name": "param", "text": "bytes - The bytes to encode." }, { "name": "returns", "text": "The base64url-encoded string without padding." }, { "name": "example", "text": "```ts\nimport { base64urlEncode } from '@openagentid/oas-crypto';\n\nconst encoded = base64urlEncode(new Uint8Array([72, 101, 108, 108, 111]));\nconsole.log(encoded); // 'SGVsbG8'\n```" } ], "signatures": [ { "code": "export declare function base64urlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 51, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "base64urlencode" }, { "name": "blake3Hash", "declarationName": "blake3Hash", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes a BLAKE3 hash of the input bytes.\n\nBLAKE3 is the OAS-mandated content hashing algorithm, providing\nfast, cryptographically secure hashes.", "tags": [ { "name": "param", "text": "data - The bytes to hash." }, { "name": "returns", "text": "A 32-byte BLAKE3 hash." }, { "name": "example", "text": "```ts\nimport { blake3Hash } from '@openagentid/oas-crypto';\n\nconst hash = blake3Hash(new Uint8Array([72, 101, 108, 108, 111]));\nconsole.log(hash.length); // 32\n```" } ], "signatures": [ { "code": "export declare function blake3Hash(data: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/hashing.d.ts", "line": 18, "sha256": "8781459213c92c62e363bf15ed51b38bd54cdc1fdc06adae4cac4b37b4e701e2" } } ], "anchor": "blake3hash" }, { "name": "blake3HashHex", "declarationName": "blake3HashHex", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes a BLAKE3 hash and returns it as a lowercase hex string.", "tags": [ { "name": "param", "text": "data - The bytes to hash." }, { "name": "returns", "text": "A 64-character lowercase hex string." }, { "name": "example", "text": "```ts\nimport { blake3HashHex } from '@openagentid/oas-crypto';\n\nconst hex = blake3HashHex(new Uint8Array(0));\nconsole.log(hex); // 'af1349b9f5f9a1a6a0404dea36dcc9499bcb25c9adc112b7cc9a93cae41f3262'\n```" } ], "signatures": [ { "code": "export declare function blake3HashHex(data: Uint8Array): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/hashing.d.ts", "line": 33, "sha256": "8781459213c92c62e363bf15ed51b38bd54cdc1fdc06adae4cac4b37b4e701e2" } } ], "anchor": "blake3hashhex" }, { "name": "CachingResolver", "declarationName": "CachingResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Caching wrapper for any {@link Resolver}.\n\nCaches resolved documents with a configurable TTL (time-to-live).\nCache misses are forwarded to the inner resolver. Expired entries\nare transparently refreshed.", "tags": [ { "name": "example", "text": "```ts\nimport { CachingResolver, InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst inner = new InMemoryResolver();\nconst cached = new CachingResolver(inner, 60_000); // 60s TTL\n```" } ], "signatures": [ { "code": "export declare class CachingResolver implements Resolver {\n constructor(inner: Resolver, ttlMs?: number);\n resolve(did: string): Promise;\n invalidate(did: string): void;\n clear(): void;\n get size(): number;\n get isEmpty(): boolean;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/cache.d.ts", "line": 18, "sha256": "0023f1c2db3a9e077c330b57c8b87b91ff3bceebc5aa2de0b56de52d72234264" } } ], "anchor": "cachingresolver" }, { "name": "compareConformanceLevel", "declarationName": "compareConformanceLevel", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compares two conformance levels.", "tags": [ { "name": "param", "text": "a - First level." }, { "name": "param", "text": "b - Second level." }, { "name": "returns", "text": "Negative if a < b, zero if equal, positive if a > b." }, { "name": "example", "text": "```ts\nimport { ConformanceLevel, compareConformanceLevel } from '@openagentid/oas-document';\n\nconsole.log(compareConformanceLevel(ConformanceLevel.L0, ConformanceLevel.L1)); // -1\n```" } ], "signatures": [ { "code": "export declare function compareConformanceLevel(a: ConformanceLevel, b: ConformanceLevel): number;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 35, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "compareconformancelevel" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS conformance levels.\n\nEach level represents a tier of compliance with the OAS specification.\nHigher levels subsume lower levels: L2 includes all L1 requirements,\nwhich includes all L0 requirements.\n\n- **L0**: Basic identity (DID, verification method, proof)\n- **L1**: L0 + lineage, conformance declaration, lifecycle\n- **L2**: L2 + full attestation chain, WASM compilation", "tags": [], "signatures": [ { "code": "declare const ConformanceLevel: {\n readonly L0: \"L0\";\n readonly L1: \"L1\";\n readonly L2: \"L2\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 12, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } }, { "code": "export type ConformanceLevel = (typeof ConformanceLevel)[keyof typeof ConformanceLevel];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 20, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "conformancelevel" }, { "name": "CreatedIdentity", "declarationName": "CreatedIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of creating a root identity.\n\nContains both the signed identity document and the keypair.\nThe keypair is needed for subsequent child derivations.", "tags": [], "signatures": [ { "code": "export interface CreatedIdentity {\n readonly document: OasDocument;\n readonly keypair: OasKeyPair;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/identity.d.ts", "line": 10, "sha256": "6242b999c72b2fc93387b5f78880c4a0b47e1b161a83c5a4d6256ae056e34c61" } } ], "anchor": "createdidentity" }, { "name": "createHmr", "declarationName": "createHmr", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new Human Root (HMR) identity.\n\nGenerates a random Ed25519 keypair, constructs a DID, builds and signs\nan OAS Identity Document with L0 conformance.", "tags": [ { "name": "param", "text": "namespace - The namespace (e.g., `\"l1fe\"`)." }, { "name": "param", "text": "identifier - The identifier (e.g., `\"alice\"`)." }, { "name": "param", "text": "created - ISO 8601 timestamp for the document proof." }, { "name": "returns", "text": "A {@link CreatedIdentity} with the document and keypair." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "OasError} on creation failure." }, { "name": "example", "text": "```ts\nimport { createHmr } from '@openagentid/oas-sdk';\n\nconst hmr = await createHmr('l1fe', 'alice', '2026-01-01T00:00:00Z');\nconsole.log(hmr.document.id); // 'did:oas:l1fe:hmr:alice'\nconsole.log(hmr.document.kind); // 'hmr'\n```" } ], "signatures": [ { "code": "export declare function createHmr(namespace: string, identifier: string, created: string): Promise;", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/identity.d.ts", "line": 37, "sha256": "6242b999c72b2fc93387b5f78880c4a0b47e1b161a83c5a4d6256ae056e34c61" } } ], "anchor": "createhmr" }, { "name": "createMhr", "declarationName": "createMhr", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new Multi-Human Root (MHR) identity.\n\nSame as {@link createHmr} but for multi-human threshold roots.", "tags": [ { "name": "param", "text": "namespace - The namespace." }, { "name": "param", "text": "identifier - The identifier." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "A {@link CreatedIdentity} with the document and keypair." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "OasError} on creation failure." }, { "name": "example", "text": "```ts\nimport { createMhr } from '@openagentid/oas-sdk';\n\nconst mhr = await createMhr('l1fe', 'sentinel', '2026-01-01T00:00:00Z');\nconsole.log(mhr.document.kind); // 'mhr'\n```" } ], "signatures": [ { "code": "export declare function createMhr(namespace: string, identifier: string, created: string): Promise;", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/identity.d.ts", "line": 57, "sha256": "6242b999c72b2fc93387b5f78880c4a0b47e1b161a83c5a4d6256ae056e34c61" } } ], "anchor": "createmhr" }, { "name": "createRootWithKeypair", "declarationName": "createRootWithKeypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a root identity with an externally provided keypair.\n\nUse this when you have an existing Ed25519 keypair (e.g., from a\nhardware security module or key management service).", "tags": [ { "name": "param", "text": "namespace - The namespace." }, { "name": "param", "text": "kind - The entity kind (must be HMR, MHR, or ENR)." }, { "name": "param", "text": "identifier - The identifier." }, { "name": "param", "text": "keypair - The pre-existing keypair." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "A {@link CreatedIdentity} with the document and keypair." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "OasError} if kind is not a root kind." } ], "signatures": [ { "code": "export declare function createRootWithKeypair(namespace: string, kind: typeof EntityKind.Hmr | typeof EntityKind.Mhr, identifier: string, keypair: OasKeyPair, created: string): Promise;", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/identity.d.ts", "line": 72, "sha256": "6242b999c72b2fc93387b5f78880c4a0b47e1b161a83c5a4d6256ae056e34c61" } } ], "anchor": "createrootwithkeypair" }, { "name": "createVerificationMethod", "declarationName": "createVerificationMethod", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new verification method for a DID.", "tags": [ { "name": "param", "text": "did - The DID that controls this key." }, { "name": "param", "text": "keyNum - The key number for the fragment (e.g., 1 produces `#key-1`)." }, { "name": "param", "text": "keypair - The keypair providing the public key." }, { "name": "returns", "text": "A frozen {@link VerificationMethod}." } ], "signatures": [ { "code": "export declare function createVerificationMethod(did: string, keyNum: number, keypair: OasKeyPair): VerificationMethod;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 37, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "createverificationmethod" }, { "name": "CredentialBuilder", "declarationName": "CredentialBuilder", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Fluent builder for constructing OAS Verifiable Credentials.", "tags": [ { "name": "example", "text": "```ts\nimport { CredentialBuilder, AttestationType } from '@openagentid/oas-attestation';\n\nconst credential = new CredentialBuilder()\n .issuer('did:oas:l1fe:hmr:alice')\n .issuanceDate('2026-01-01T00:00:00Z')\n .attestationType(AttestationType.SecurityAudit)\n .subject({\n id: 'did:oas:l1fe:agent:bot',\n auditor: 'SecureCo',\n scope: 'full',\n findings: 'no critical issues',\n })\n .build();\n```" } ], "signatures": [ { "code": "export declare class CredentialBuilder {\n issuer(did: string): this;\n issuanceDate(date: string): this;\n expirationDate(date: string): this;\n subject(claims: Record): this;\n attestationType(type: AttestationTypeValue): this;\n build(): OasCredential;\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 69, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "credentialbuilder" }, { "name": "CredentialProof", "declarationName": "CredentialProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A proof attached to an OAS credential.", "tags": [], "signatures": [ { "code": "export interface CredentialProof {\n readonly type: 'Ed25519Signature2020';\n readonly created: string;\n readonly verificationMethod: string;\n readonly proofPurpose: 'assertionMethod';\n readonly proofValue: string;\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 13, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "credentialproof" }, { "name": "CryptoError", "declarationName": "CryptoError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for OAS cryptographic operations.\n\nEvery instance carries a machine-readable {@link CryptoErrorCode} and\na human-readable message with enough context to diagnose the issue\nwithout exposing sensitive key material.", "tags": [ { "name": "example", "text": "```ts\nimport { CryptoError, CryptoErrorCode } from '@openagentid/oas-crypto';\n\nconst err = new CryptoError(\n CryptoErrorCode.InvalidSignature,\n 'lineage proof verification'\n);\nconsole.log(err.code); // 'INVALID_SIGNATURE'\n```" } ], "signatures": [ { "code": "export declare class CryptoError extends Error {\n readonly code: CryptoErrorCode;\n readonly details: Readonly>;\n constructor(code: CryptoErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/error.d.ts", "line": 43, "sha256": "2a687f6333991709d6e3d3e190abb1d8c4f44560ed7a22c6ba6a1ef4aad9e07d" } } ], "anchor": "cryptoerror" }, { "name": "CryptoErrorCode", "declarationName": "CryptoErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS cryptographic operations.\n\nMachine-readable codes for programmatic error matching.", "tags": [], "signatures": [ { "code": "declare const CryptoErrorCode: {\n readonly InvalidSignature: \"INVALID_SIGNATURE\";\n readonly InvalidKeyLength: \"INVALID_KEY_LENGTH\";\n readonly DerivationFailed: \"DERIVATION_FAILED\";\n readonly MultibaseDecodeFailed: \"MULTIBASE_DECODE_FAILED\";\n readonly Base64DecodeFailed: \"BASE64_DECODE_FAILED\";\n readonly CanonicalizationFailed: \"CANONICALIZATION_FAILED\";\n readonly InvalidProofPayload: \"INVALID_PROOF_PAYLOAD\";\n readonly KeyConstructionFailed: \"KEY_CONSTRUCTION_FAILED\";\n};", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/error.d.ts", "line": 6, "sha256": "2a687f6333991709d6e3d3e190abb1d8c4f44560ed7a22c6ba6a1ef4aad9e07d" } }, { "code": "export type CryptoErrorCode = (typeof CryptoErrorCode)[keyof typeof CryptoErrorCode];", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/error.d.ts", "line": 24, "sha256": "2a687f6333991709d6e3d3e190abb1d8c4f44560ed7a22c6ba6a1ef4aad9e07d" } } ], "anchor": "cryptoerrorcode" }, { "name": "defaultContext", "declarationName": "defaultContext", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the default JSON-LD context array for OAS documents.", "tags": [], "signatures": [ { "code": "export declare function defaultContext(): ReadonlyArray;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 119, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "defaultcontext" }, { "name": "defaultVerifyConfig", "declarationName": "defaultVerifyConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a default verification configuration.", "tags": [ { "name": "returns", "text": "A frozen {@link VerifyConfig} with default values." } ], "signatures": [ { "code": "export declare function defaultVerifyConfig(): VerifyConfig;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 28, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "defaultverifyconfig" }, { "name": "deriveChild", "declarationName": "deriveChild", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a child identity from a parent.\n\nThis is the high-level SDK workflow that:\n1. Constructs the child DID\n2. Derives a child keypair via HKDF-SHA256\n3. Generates a lineage proof\n4. Builds and signs the child's identity document", "tags": [ { "name": "param", "text": "parentKeypair - The parent entity's keypair." }, { "name": "param", "text": "parentDoc - The parent entity's identity document." }, { "name": "param", "text": "childNamespace - The child's namespace." }, { "name": "param", "text": "childKind - The child's entity kind." }, { "name": "param", "text": "childIdentifier - The child's identifier." }, { "name": "param", "text": "derivationPath - The HKDF derivation path." }, { "name": "param", "text": "created - ISO 8601 timestamp for the document proof." }, { "name": "returns", "text": "A {@link DerivedIdentity} with the child document and keypair." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "OasError} on derivation failure." }, { "name": "example", "text": "```ts\nimport { createHmr, deriveChild } from '@openagentid/oas-sdk';\nimport { EntityKind } from '@openagentid/oas-did';\n\nconst hmr = await createHmr('l1fe', 'alice', '2026-01-01T00:00:00Z');\nconst agent = await deriveChild(\n hmr.keypair,\n hmr.document,\n 'l1fe',\n EntityKind.Agent,\n 'analyzer',\n '/agent-analyzer',\n '2026-01-01T00:00:00Z',\n);\nconsole.log(agent.document.id); // 'did:oas:l1fe:agent:analyzer'\n```" } ], "signatures": [ { "code": "export declare function deriveChild(parentKeypair: OasKeyPair, parentDoc: OasDocument, childNamespace: string, childKind: EntityKind, childIdentifier: string, derivationPath: string, created: string): Promise;", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 164, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "derivechild" }, { "name": "deriveChildEntity", "declarationName": "deriveChildEntity", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a child entity from a parent entity's keypair and document.\n\nPerforms HKDF-SHA256 key derivation, generates a lineage proof signed\nby the parent, and constructs the lineage section for the child's\nidentity document.", "tags": [ { "name": "param", "text": "parentKeypair - The parent entity's keypair (must have signing key)." }, { "name": "param", "text": "parentDoc - The parent entity's identity document." }, { "name": "param", "text": "childDid - The child entity's DID string." }, { "name": "param", "text": "derivationPath - The HKDF derivation path (e.g., `\"/agent-my-bot\"`)." }, { "name": "returns", "text": "A {@link DerivedChild} with the keypair and lineage section." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "LineageError} on derivation or proof generation failure." }, { "name": "example", "text": "```ts\nimport { deriveChildEntity } from '@openagentid/oas-lineage';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst child = await deriveChildEntity(\n parentKeypair,\n parentDocument,\n 'did:oas:l1fe:agent:my-bot',\n '/agent-my-bot',\n);\n\nconsole.log(child.lineage.generation); // parent.generation + 1\n```" } ], "signatures": [ { "code": "export declare function deriveChildEntity(parentKeypair: OasKeyPair, parentDoc: OasDocument, childDid: string, derivationPath: string): Promise;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/derive.d.ts", "line": 44, "sha256": "af28f0710d6ba3d5a14bc95475739b5d7ac3cea5443e3cb528c02097b2432757" } } ], "anchor": "derivechildentity" }, { "name": "deriveChildKeypair", "declarationName": "deriveChildKeypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a child Ed25519 keypair from a parent keypair using HKDF-SHA256.\n\nThe derivation uses:\n- **IKM** (Input Keying Material): parent's signing (private) key bytes\n- **Salt**: parent's verifying (public) key bytes\n- **Info**: the derivation path string (UTF-8 encoded)\n\nThe output is 32 bytes of derived key material, used as the child's Ed25519\nsigning key. The child's verifying key is derived from the signing key.", "tags": [ { "name": "param", "text": "parent - The parent keypair providing the IKM and salt." }, { "name": "param", "text": "derivationPath - The derivation path string (e.g., `\"/agent-my-bot\"`)." }, { "name": "returns", "text": "A new {@link OasKeyPair} derived from the parent." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.DerivationFailed } on failure." }, { "name": "example", "text": "```ts\nimport { OasKeyPair, deriveChildKeypair } from '@openagentid/oas-crypto';\n\nconst parent = OasKeyPair.generate();\nconst child = deriveChildKeypair(parent, '/agent-my-bot');\n// child has a deterministic keypair derived from parent + path\n```" } ], "signatures": [ { "code": "export declare function deriveChildKeypair(parent: OasKeyPair, derivationPath: string): Promise;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/derivation.d.ts", "line": 27, "sha256": "0be2eef939c40a83569bdc5295bfd84f1552b8ec63b48b72ce3a65ea34201822" } } ], "anchor": "derivechildkeypair" }, { "name": "DerivedChild", "declarationName": "DerivedChild", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of a child entity derivation.\n\nContains the derived keypair and the lineage section to include\nin the child's identity document.", "tags": [], "signatures": [ { "code": "export interface DerivedChild {\n readonly keypair: OasKeyPair;\n readonly lineage: LineageSection;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/derive.d.ts", "line": 9, "sha256": "af28f0710d6ba3d5a14bc95475739b5d7ac3cea5443e3cb528c02097b2432757" } } ], "anchor": "derivedchild" }, { "name": "DerivedIdentity", "declarationName": "DerivedIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of deriving a child identity.", "tags": [], "signatures": [ { "code": "export interface DerivedIdentity {\n readonly document: OasDocument;\n readonly keypair: OasKeyPair;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 8, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "derivedidentity" }, { "name": "deriveKeyMaterial", "declarationName": "deriveKeyMaterial", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Low-level HKDF-SHA256 key material derivation.\n\nDerives 32 bytes of key material using HKDF-SHA256 (RFC 5869).", "tags": [ { "name": "param", "text": "ikm - Input Keying Material." }, { "name": "param", "text": "salt - Salt value." }, { "name": "param", "text": "info - Context and application-specific information." }, { "name": "returns", "text": "32 bytes of derived key material." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} on derivation failure." } ], "signatures": [ { "code": "export declare function deriveKeyMaterial(ikm: Uint8Array, salt: Uint8Array, info: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/derivation.d.ts", "line": 39, "sha256": "0be2eef939c40a83569bdc5295bfd84f1552b8ec63b48b72ce3a65ea34201822" } } ], "anchor": "derivekeymaterial" }, { "name": "DID_CONTEXT", "declarationName": "DID_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "W3C DID Document context.", "tags": [], "signatures": [ { "code": "declare const DID_CONTEXT: \"https://www.w3.org/ns/did/v1\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 21, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "did_context" }, { "name": "DidError", "declarationName": "DidError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for DID parsing and validation failures.\n\nEvery instance carries a machine-readable {@link DidErrorCode} and a\nhuman-readable message with enough context to diagnose the issue.", "tags": [ { "name": "example", "text": "```ts\nimport { DidError, DidErrorCode } from '@openagentid/oas-did';\n\nconst err = new DidError(\n DidErrorCode.InvalidNamespace,\n \"namespace 'L1FE' contains uppercase characters; must be lowercase alphanumeric + hyphens\"\n);\nconsole.log(err.code); // 'INVALID_NAMESPACE'\n```" } ], "signatures": [ { "code": "export declare class DidError extends Error {\n readonly code: DidErrorCode;\n constructor(code: DidErrorCode, message: string);\n}", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/error.d.ts", "line": 39, "sha256": "ecdcd7c8a82aac16e7f1c9c436518911717cdd6a23b30a724594bd8623789408" } } ], "anchor": "diderror" }, { "name": "DidErrorCode", "declarationName": "DidErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for DID parsing and validation failures.\n\nThese string enum codes enable programmatic matching without\nrelying on error message string content.", "tags": [], "signatures": [ { "code": "declare const DidErrorCode: {\n readonly Empty: \"EMPTY\";\n readonly InvalidPrefix: \"INVALID_PREFIX\";\n readonly TooFewComponents: \"TOO_FEW_COMPONENTS\";\n readonly InvalidNamespace: \"INVALID_NAMESPACE\";\n readonly UnknownEntityKind: \"UNKNOWN_ENTITY_KIND\";\n readonly InvalidIdentifier: \"INVALID_IDENTIFIER\";\n};", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/error.d.ts", "line": 7, "sha256": "ecdcd7c8a82aac16e7f1c9c436518911717cdd6a23b30a724594bd8623789408" } }, { "code": "export type DidErrorCode = (typeof DidErrorCode)[keyof typeof DidErrorCode];", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/error.d.ts", "line": 21, "sha256": "ecdcd7c8a82aac16e7f1c9c436518911717cdd6a23b30a724594bd8623789408" } } ], "anchor": "diderrorcode" }, { "name": "DocumentBuilder", "declarationName": "DocumentBuilder", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Fluent builder for constructing OAS Identity Documents.\n\nThe builder enforces required fields and produces a signed, frozen\n{@link OasDocument} via the {@link DocumentBuilder.buildAndSign} method.", "tags": [ { "name": "example", "text": "```ts\nimport { DocumentBuilder, ConformanceLevel } from '@openagentid/oas-document';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\nimport { EntityKind } from '@openagentid/oas-did';\n\nconst keypair = OasKeyPair.generate();\nconst doc = new DocumentBuilder('did:oas:l1fe:hmr:alice', EntityKind.Hmr)\n .controller('did:oas:l1fe:hmr:alice')\n .addVerificationMethod(keypair)\n .conformanceLevel(ConformanceLevel.L0)\n .buildAndSign(keypair, new Date().toISOString());\n```" } ], "signatures": [ { "code": "export declare class DocumentBuilder {\n constructor(id: string, kind: EntityKind);\n controller(controller: string | ReadonlyArray): this;\n addVerificationMethod(keypair: OasKeyPair): this;\n conformanceLevel(level: ConformanceLevel): this;\n lifecycleStatus(status: LifecycleStatus): this;\n sequence(seq: number): this;\n name(name: string): this;\n description(description: string): this;\n lineage(lineage: LineageSection): this;\n addService(service: ServiceEndpoint): this;\n metadata(metadata: Record): this;\n buildAndSign(keypair: OasKeyPair, created: string): Promise;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/builder.d.ts", "line": 28, "sha256": "73e3ff394a7c2fadfb9f879255b977ba1b99d12c94f9e36573be41cbac40c19a" } } ], "anchor": "documentbuilder" }, { "name": "DocumentError", "declarationName": "DocumentError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for OAS document operations.", "tags": [ { "name": "example", "text": "```ts\nimport { DocumentError, DocumentErrorCode } from '@openagentid/oas-document';\n\nconst err = new DocumentError(\n DocumentErrorCode.MissingField,\n \"required field 'verificationMethod' is missing from document\"\n);\n```" } ], "signatures": [ { "code": "export declare class DocumentError extends Error {\n readonly code: DocumentErrorCode;\n readonly details: Readonly>;\n constructor(code: DocumentErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/error.d.ts", "line": 40, "sha256": "60683da469296c386d05363cd6ec1f51fdec62aaeda99b3b539a530ca6197a65" } } ], "anchor": "documenterror" }, { "name": "DocumentErrorCode", "declarationName": "DocumentErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS document operations.", "tags": [], "signatures": [ { "code": "declare const DocumentErrorCode: {\n readonly MissingField: \"MISSING_FIELD\";\n readonly InvalidField: \"INVALID_FIELD\";\n readonly ProofVerificationFailed: \"PROOF_VERIFICATION_FAILED\";\n readonly ProofGenerationFailed: \"PROOF_GENERATION_FAILED\";\n readonly ConformanceNotMet: \"CONFORMANCE_NOT_MET\";\n readonly Json: \"JSON_ERROR\";\n readonly Did: \"DID_ERROR\";\n readonly Crypto: \"CRYPTO_ERROR\";\n readonly InvalidLifecycleTransition: \"INVALID_LIFECYCLE_TRANSITION\";\n readonly InvalidSequence: \"INVALID_SEQUENCE\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/error.d.ts", "line": 4, "sha256": "60683da469296c386d05363cd6ec1f51fdec62aaeda99b3b539a530ca6197a65" } }, { "code": "export type DocumentErrorCode = (typeof DocumentErrorCode)[keyof typeof DocumentErrorCode];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/error.d.ts", "line": 26, "sha256": "60683da469296c386d05363cd6ec1f51fdec62aaeda99b3b539a530ca6197a65" } } ], "anchor": "documenterrorcode" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A document proof (Ed25519Signature2020) attached to an OAS Identity Document.\n\nThe proof authenticates the document content by signing the JCS-canonicalized\ndocument (excluding the proof itself) with the entity's Ed25519 key.", "tags": [], "signatures": [ { "code": "export interface DocumentProof {\n readonly type: 'Ed25519Signature2020';\n readonly created: string;\n readonly verificationMethod: string;\n readonly proofPurpose: 'assertionMethod';\n readonly proofValue: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 8, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "documentproof" }, { "name": "DocumentProvider", "declarationName": "DocumentProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Interface for resolving OAS Identity Documents by DID.\n\nImplementations provide documents from different sources: in-memory\nmaps, network resolution, caching layers, etc. The lineage verifier\nuses this interface to walk the chain.", "tags": [ { "name": "example", "text": "```ts\nimport { DocumentProvider, InMemoryProvider } from '@openagentid/oas-lineage';\n\nconst provider = new InMemoryProvider();\nprovider.register(doc);\nconst resolved = await provider.resolve('did:oas:l1fe:hmr:alice');\n```" } ], "signatures": [ { "code": "export interface DocumentProvider {\n resolve(did: string): Promise;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/provider.d.ts", "line": 18, "sha256": "ff17113607d489bcebcc7c0c6621120cc0ab48e0f5023ccbbcab00e3d1bd67cc" } } ], "anchor": "documentprovider" }, { "name": "documentWithoutProof", "declarationName": "documentWithoutProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a plain JSON object from an OasDocument, suitable for\nJCS canonicalization or serialization.\n\nStrips the `proof` field to produce the unsigned document payload.", "tags": [ { "name": "param", "text": "doc - The document to convert." }, { "name": "returns", "text": "A plain object without the `proof` field." } ], "signatures": [ { "code": "export declare function documentWithoutProof(doc: OasDocument): Record;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 157, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "documentwithoutproof" }, { "name": "ED25519_CONTEXT", "declarationName": "ED25519_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Ed25519 Verification Key 2020 context.", "tags": [], "signatures": [ { "code": "declare const ED25519_CONTEXT: \"https://w3id.org/security/suites/ed25519-2020/v1\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 25, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "ed25519_context" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The set of recognized OAS entity kinds.\n\nEach entity kind represents a category of autonomous entity in the OAS\nidentity system. Root kinds ({@link EntityKind.Hmr}, {@link EntityKind.Mhr},\n{@link EntityKind.Enr}) are the trust anchors from which all other entities\nderive their lineage.", "tags": [ { "name": "example", "text": "```ts\nimport { EntityKind, entityKindFromString } from '@openagentid/oas-did';\n\nconst kind = entityKindFromString('agent');\nconsole.log(kind === EntityKind.Agent); // true\nconsole.log(isRootKind(kind)); // false\n```" } ], "signatures": [ { "code": "declare const EntityKind: {\n readonly Hmr: \"hmr\";\n readonly Mhr: \"mhr\";\n readonly Enr: \"enr\";\n readonly Ao: \"ao\";\n readonly Agent: \"agent\";\n readonly AgentInstance: \"agent:instance\";\n readonly Tool: \"tool\";\n readonly Skill: \"skill\";\n readonly Workflow: \"workflow\";\n readonly Model: \"model\";\n readonly Dataset: \"dataset\";\n readonly Service: \"service\";\n};", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 18, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } }, { "code": "export type EntityKind = (typeof EntityKind)[keyof typeof EntityKind];", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 44, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykind" }, { "name": "entityKindComponentCount", "declarationName": "entityKindComponentCount", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the number of colon-separated components in the kind string.\n\nSimple kinds (e.g., `\"agent\"`) have 1 component.\nCompound kinds (e.g., `\"agent:instance\"`) have 2 components.", "tags": [ { "name": "param", "text": "kind - The entity kind to inspect." }, { "name": "returns", "text": "The number of components (1 or 2)." } ], "signatures": [ { "code": "export declare function entityKindComponentCount(kind: EntityKind): number;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 101, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykindcomponentcount" }, { "name": "entityKindFromString", "declarationName": "entityKindFromString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parses a string into an {@link EntityKind}.\n\nHandles the compound `agent:instance` kind by accepting both\nthe full string and the two-part colon-separated form.", "tags": [ { "name": "param", "text": "s - The string to parse (e.g., `\"agent\"`, `\"agent:instance\"`, `\"hmr\"`)." }, { "name": "returns", "text": "The matching {@link EntityKind}, or `undefined` if the string is not recognized." }, { "name": "example", "text": "```ts\nimport { entityKindFromString, EntityKind } from '@openagentid/oas-did';\n\nconst kind = entityKindFromString('agent:instance');\nconsole.log(kind === EntityKind.AgentInstance); // true\n\nconst unknown = entityKindFromString('unknown');\nconsole.log(unknown); // undefined\n```" } ], "signatures": [ { "code": "export declare function entityKindFromString(s: string): EntityKind | undefined;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 65, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykindfromstring" }, { "name": "entityKindToString", "declarationName": "entityKindToString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the string representation of an entity kind.", "tags": [ { "name": "param", "text": "kind - The entity kind to convert." }, { "name": "returns", "text": "The canonical string form (e.g., `\"agent:instance\"`)." } ], "signatures": [ { "code": "export declare function entityKindToString(kind: EntityKind): string;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 72, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "entitykindtostring" }, { "name": "extractKeyId", "declarationName": "extractKeyId", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extracts the key ID fragment from a verification method ID.", "tags": [ { "name": "param", "text": "vmId - The full verification method ID (e.g., `\"did:oas:l1fe:agent:bot#key-1\"`)." }, { "name": "returns", "text": "The fragment part (e.g., `\"key-1\"`), or `undefined` if no fragment." } ], "signatures": [ { "code": "export declare function extractKeyId(vmId: string): string | undefined;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 44, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "extractkeyid" }, { "name": "FallbackResolver", "declarationName": "FallbackResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Fallback resolver that tries multiple resolvers in priority order.\n\nReturns the result from the first resolver that succeeds. If all\nresolvers fail, throws an error aggregating all failure reasons.", "tags": [ { "name": "example", "text": "```ts\nimport { FallbackResolver, InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst primary = new InMemoryResolver();\nconst secondary = new InMemoryResolver();\nconst resolver = new FallbackResolver([primary, secondary]);\n```" } ], "signatures": [ { "code": "export declare class FallbackResolver implements Resolver {\n constructor(resolvers: ReadonlyArray);\n resolve(did: string): Promise;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/fallback.d.ts", "line": 18, "sha256": "233ecda045fe84106f0b59d262cfd696afde37bb519255607662f36fc7ee3fd3" } } ], "anchor": "fallbackresolver" }, { "name": "findVerificationMethod", "declarationName": "findVerificationMethod", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Finds a verification method by ID.", "tags": [ { "name": "param", "text": "doc - The document to search." }, { "name": "param", "text": "vmId - The verification method ID to find." }, { "name": "returns", "text": "The matching {@link VerificationMethod}, or `undefined`." } ], "signatures": [ { "code": "export declare function findVerificationMethod(doc: OasDocument, vmId: string): VerificationMethod | undefined;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 147, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "findverificationmethod" }, { "name": "generateDocumentProof", "declarationName": "generateDocumentProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Generates a document proof by signing the JCS-canonicalized document.", "tags": [ { "name": "param", "text": "documentWithoutProof - The document object without the `proof` field." }, { "name": "param", "text": "keypair - The keypair to sign with." }, { "name": "param", "text": "verificationMethodId - The VM ID to reference." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "A frozen {@link DocumentProof}." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DocumentError} on signing or canonicalization failure." } ], "signatures": [ { "code": "export declare function generateDocumentProof(documentWithoutProof: Record, keypair: OasKeyPair, verificationMethodId: string, created: string): Promise;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 30, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "generatedocumentproof" }, { "name": "InMemoryProvider", "declarationName": "InMemoryProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory document provider for testing and local verification.\n\nStores documents in a Map keyed by DID string. Thread-safe for\nconcurrent reads (JavaScript is single-threaded for sync operations,\nbut async operations are correctly sequenced).", "tags": [ { "name": "example", "text": "```ts\nimport { InMemoryProvider } from '@openagentid/oas-lineage';\n\nconst provider = new InMemoryProvider();\nprovider.register(document);\nconst doc = await provider.resolve('did:oas:l1fe:hmr:alice');\n```" } ], "signatures": [ { "code": "export declare class InMemoryProvider implements DocumentProvider {\n register(doc: OasDocument): void;\n remove(did: string): boolean;\n resolve(did: string): Promise;\n get size(): number;\n get isEmpty(): boolean;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/provider.d.ts", "line": 43, "sha256": "ff17113607d489bcebcc7c0c6621120cc0ab48e0f5023ccbbcab00e3d1bd67cc" } } ], "anchor": "inmemoryprovider" }, { "name": "InMemoryResolver", "declarationName": "InMemoryResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory DID resolver for testing and local usage.\n\nStores documents in a Map keyed by DID string. This is the standard\ntesting approach across the OAS stack.", "tags": [ { "name": "example", "text": "```ts\nimport { InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst resolver = new InMemoryResolver();\nresolver.register(document);\nconst doc = await resolver.resolve('did:oas:l1fe:hmr:alice');\n```" } ], "signatures": [ { "code": "export declare class InMemoryResolver implements Resolver {\n register(doc: OasDocument): void;\n remove(did: string): boolean;\n resolve(did: string): Promise;\n get size(): number;\n get isEmpty(): boolean;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/memory.d.ts", "line": 18, "sha256": "dc1d978e858372c1d635aac1f0dfc312b8ef8e053dd71e4a055231e183437330" } } ], "anchor": "inmemoryresolver" }, { "name": "isReservedNamespace", "declarationName": "isReservedNamespace", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the namespace is in the reserved list.\n\nReserved namespaces (`oas`, `test`, `example`) are defined by the\nOAS specification and cannot be used for production entities.", "tags": [ { "name": "param", "text": "namespace - The namespace string to check." }, { "name": "returns", "text": "`true` if the namespace is reserved." }, { "name": "example", "text": "```ts\nimport { isReservedNamespace } from '@openagentid/oas-did';\n\nconsole.log(isReservedNamespace('test')); // true\nconsole.log(isReservedNamespace('l1fe')); // false\n```" } ], "signatures": [ { "code": "export declare function isReservedNamespace(namespace: string): boolean;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/namespace.d.ts", "line": 47, "sha256": "85af64a61c0e6bc5480d57074fff8d3eff1064f3c9ae5838480535a01a8f9be5" } } ], "anchor": "isreservednamespace" }, { "name": "isRevoked", "declarationName": "isRevoked", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the document has been revoked.", "tags": [ { "name": "param", "text": "doc - The document to check." } ], "signatures": [ { "code": "export declare function isRevoked(doc: OasDocument): boolean;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 132, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "isrevoked" }, { "name": "isRootDocument", "declarationName": "isRootDocument", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the document represents a root entity (HMR, MHR, or ENR).", "tags": [ { "name": "param", "text": "doc - The document to check." }, { "name": "returns", "text": "`true` if the entity kind is a root kind." } ], "signatures": [ { "code": "export declare function isRootDocument(doc: OasDocument): boolean;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 126, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "isrootdocument" }, { "name": "isRootKind", "declarationName": "isRootKind", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the entity kind is a root kind (HMR, MHR, or ENR).\n\nRoot kinds are trust anchors — they do not derive from a parent entity.\nTheir lineage chain terminates at themselves.", "tags": [ { "name": "param", "text": "kind - The entity kind to check." }, { "name": "returns", "text": "`true` if the kind is {@link EntityKind.Hmr}, {@link EntityKind.Mhr}, or {@link EntityKind.Enr}." }, { "name": "example", "text": "```ts\nimport { EntityKind, isRootKind } from '@openagentid/oas-did';\n\nconsole.log(isRootKind(EntityKind.Hmr)); // true\nconsole.log(isRootKind(EntityKind.Enr)); // true\nconsole.log(isRootKind(EntityKind.Agent)); // false\n```" } ], "signatures": [ { "code": "export declare function isRootKind(kind: EntityKind): boolean;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/kind.d.ts", "line": 91, "sha256": "e39d41e480b4c65b6b575256f0b0fa9e4d9ebac0c288f4d50c8355bfafbaaf0a" } } ], "anchor": "isrootkind" }, { "name": "jcsCanonicalize", "declarationName": "jcsCanonicalize", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Canonicalizes a JSON value to UTF-8 bytes according to RFC 8785.", "tags": [ { "name": "param", "text": "value - The JSON value to canonicalize." }, { "name": "returns", "text": "The JCS-canonicalized bytes." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.CanonicalizationFailed } on failure." }, { "name": "example", "text": "```ts\nimport { jcsCanonicalize } from '@openagentid/oas-crypto';\n\nconst bytes = jcsCanonicalize({ childDid: 'did:oas:l1fe:agent:bot' });\n// bytes is the UTF-8 encoding of the canonical JSON\n```" } ], "signatures": [ { "code": "export declare function jcsCanonicalize(value: unknown): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/jcs.d.ts", "line": 41, "sha256": "4834d038578cb7b07e800fc6ea5c6a58d96700f2f7270a91eae79dfb1afa0590" } } ], "anchor": "jcscanonicalize" }, { "name": "jcsCanonicalizeToString", "declarationName": "jcsCanonicalizeToString", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Canonicalizes a JSON value according to RFC 8785 (JSON Canonicalization Scheme).\n\nJCS produces a deterministic, byte-for-byte identical serialization of\nany JSON value by applying these rules:\n- Object keys sorted lexicographically (by UTF-16 code units)\n- No whitespace between tokens\n- Numbers serialized per ES2015 `Number.toString()`\n- Strings escaped according to JSON spec (minimal escaping)\n- `null`, `true`, `false` as literals", "tags": [ { "name": "param", "text": "value - The JSON value to canonicalize." }, { "name": "returns", "text": "The JCS-canonicalized string." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.CanonicalizationFailed } if the value\n cannot be serialized (e.g., contains `undefined`, functions, or circular references)." }, { "name": "example", "text": "```ts\nimport { jcsCanonicalizeToString } from '@openagentid/oas-crypto';\n\nconst canonical = jcsCanonicalizeToString({ b: 2, a: 1 });\nconsole.log(canonical); // '{\"a\":1,\"b\":2}'\n```" } ], "signatures": [ { "code": "export declare function jcsCanonicalizeToString(value: unknown): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/jcs.d.ts", "line": 25, "sha256": "4834d038578cb7b07e800fc6ea5c6a58d96700f2f7270a91eae79dfb1afa0590" } } ], "anchor": "jcscanonicalizetostring" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS entity lifecycle statuses.\n\nEntities progress through these statuses during their lifetime.\nThe lifecycle is largely linear, but suspension and reactivation\ncreate branches.", "tags": [], "signatures": [ { "code": "declare const LifecycleStatus: {\n readonly Nascent: \"nascent\";\n readonly Active: \"active\";\n readonly Dormant: \"dormant\";\n readonly Suspended: \"suspended\";\n readonly Terminated: \"terminated\";\n readonly Archived: \"archived\";\n};", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 8, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } }, { "code": "export type LifecycleStatus = (typeof LifecycleStatus)[keyof typeof LifecycleStatus];", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lifecycle.d.ts", "line": 22, "sha256": "c0506e375f38de41039f1fcbd97c84697772b970e06099a9a7ae176a8672129c" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageAuthorityRecord", "declarationName": "LineageAuthorityRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Sigil-backed authority record returned by a lineage finality source.", "tags": [], "signatures": [ { "code": "export interface LineageAuthorityRecord {\n readonly subjectDid: string;\n readonly rootDid: string;\n readonly finalizedPath: readonly string[];\n readonly finalizedBlock: number;\n readonly source: string;\n readonly scopes: readonly string[];\n readonly expiresAt?: string;\n readonly pathKind?: AuthorityPathKind;\n readonly rootKind?: 'hmr' | 'mhr' | 'enr' | string;\n readonly generation?: number;\n readonly orgRootCommitment?: string;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 38, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "lineageauthorityrecord" }, { "name": "LineageAuthorityRequest", "declarationName": "LineageAuthorityRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Request passed from OAS into a Sigil-backed lineage authority source.", "tags": [], "signatures": [ { "code": "export interface LineageAuthorityRequest {\n readonly subjectDid: string;\n readonly localRootDid: string;\n readonly localChain: readonly string[];\n readonly pathKind: AuthorityPathKind;\n readonly requiredScopes: readonly string[];\n readonly minFinalizedBlock?: number;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 23, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "lineageauthorityrequest" }, { "name": "LineageAuthorityResolver", "declarationName": "LineageAuthorityResolver", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Resolver-shaped authority backend - the TypeScript mirror of the Rust\n`LineageAnchor` trait (oas-resolve/src/anchored.rs).\n\nThis intentionally avoids Sigil-specific imports. Any anchor backend\n(Sigil GAL, an EAS adapter, a transparency log) plugs in through adapters\nthat satisfy this small read-only shape.", "tags": [], "signatures": [ { "code": "export interface LineageAuthorityResolver {\n currentFinalizedBlock(): Promise;\n checkRevocation(did: string): Promise;\n getRootAnchor(rootDid: string): Promise;\n getOrgRoot?(orgDid: string): Promise;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 109, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "lineageauthorityresolver" }, { "name": "LineageAuthoritySource", "declarationName": "LineageAuthoritySource", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Backend that proves privileged lineage authority.", "tags": [], "signatures": [ { "code": "export interface LineageAuthoritySource {\n verifyAuthority(request: LineageAuthorityRequest): Promise;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 70, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "lineageauthoritysource" }, { "name": "LineageAuthorityVerification", "declarationName": "LineageAuthorityVerification", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of privileged lineage authority verification.", "tags": [], "signatures": [ { "code": "export interface LineageAuthorityVerification {\n readonly portable: VerifyResult;\n readonly authority: LineageAuthorityRecord;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 63, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "lineageauthorityverification" }, { "name": "LineageError", "declarationName": "LineageError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for lineage operations.", "tags": [ { "name": "example", "text": "```ts\nimport { LineageError, LineageErrorCode } from '@openagentid/oas-lineage';\n\nconst err = new LineageError(\n LineageErrorCode.ChainTooDeep,\n 'lineage chain depth 20 exceeds maximum 16'\n);\n```" } ], "signatures": [ { "code": "export declare class LineageError extends Error {\n readonly code: LineageErrorCode;\n readonly details: Readonly>;\n constructor(code: LineageErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/error.d.ts", "line": 52, "sha256": "0e15cc42c22eb426723735795b0051efbd2a02b56e826962a267c2fec2c12dfe" } } ], "anchor": "lineageerror" }, { "name": "LineageErrorCode", "declarationName": "LineageErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for lineage verification and derivation operations.", "tags": [], "signatures": [ { "code": "declare const LineageErrorCode: {\n readonly MissingLineage: \"MISSING_LINEAGE\";\n readonly EmptyChain: \"EMPTY_CHAIN\";\n readonly ChainNotTerminatingAtRoot: \"CHAIN_NOT_TERMINATING_AT_ROOT\";\n readonly GenerationMismatch: \"GENERATION_MISMATCH\";\n readonly ChainTooDeep: \"CHAIN_TOO_DEEP\";\n readonly ResolutionFailed: \"RESOLUTION_FAILED\";\n readonly ParentRevoked: \"PARENT_REVOKED\";\n readonly ParentSignatureInvalid: \"PARENT_SIGNATURE_INVALID\";\n readonly UnknownProofType: \"UNKNOWN_PROOF_TYPE\";\n readonly ProofParentMismatch: \"PROOF_PARENT_MISMATCH\";\n readonly ProofChildMismatch: \"PROOF_CHILD_MISMATCH\";\n readonly ProofSignatureInvalid: \"PROOF_SIGNATURE_INVALID\";\n readonly TotalTimeout: \"TOTAL_TIMEOUT\";\n readonly MissingDerivationProof: \"MISSING_DERIVATION_PROOF\";\n readonly ParentKeyNotFound: \"PARENT_KEY_NOT_FOUND\";\n readonly Crypto: \"CRYPTO_ERROR\";\n};", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/error.d.ts", "line": 4, "sha256": "0e15cc42c22eb426723735795b0051efbd2a02b56e826962a267c2fec2c12dfe" } }, { "code": "export type LineageErrorCode = (typeof LineageErrorCode)[keyof typeof LineageErrorCode];", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/error.d.ts", "line": 38, "sha256": "0e15cc42c22eb426723735795b0051efbd2a02b56e826962a267c2fec2c12dfe" } } ], "anchor": "lineageerrorcode" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The lineage section of an OAS Identity Document.\n\nDescribes the entity's position in the derivation chain, linking\nit back to its human root. Root entities (HMR, MHR) do not have\na lineage section.", "tags": [ { "name": "example", "text": "```ts\nimport { LineageSection } from '@openagentid/oas-document';\n\nconst lineage: LineageSection = {\n humanRootDid: 'did:oas:l1fe:hmr:alice',\n creatorDid: 'did:oas:l1fe:hmr:alice',\n generation: 1,\n humanRootChain: [\n 'did:oas:l1fe:agent:bot',\n 'did:oas:l1fe:hmr:alice',\n ],\n};\n```" } ], "signatures": [ { "code": "export interface LineageSection {\n readonly humanRootDid: string;\n readonly creatorDid: string;\n readonly generation: number;\n readonly derivationProof?: AgentLineageProofData | undefined;\n readonly humanRootChain: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/lineage-section.d.ts", "line": 24, "sha256": "bf29b9bbbfcd3422bf07e21f841b4802ee05271346f881f637ee8f67e0bcb366" } } ], "anchor": "lineagesection" }, { "name": "meetsConformanceLevel", "declarationName": "meetsConformanceLevel", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if level `a` meets or exceeds the required level `b`.", "tags": [ { "name": "param", "text": "actual - The actual conformance level." }, { "name": "param", "text": "required - The required conformance level." }, { "name": "returns", "text": "`true` if `actual >= required`." } ], "signatures": [ { "code": "export declare function meetsConformanceLevel(actual: ConformanceLevel, required: ConformanceLevel): boolean;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/conformance.d.ts", "line": 43, "sha256": "16f57592e238384a8948b9bb5d075047b042f1b0755234bf3800379c9efe9e4a" } } ], "anchor": "meetsconformancelevel" }, { "name": "multibaseDecode", "declarationName": "multibaseDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a multibase base58btc string (strips `z` prefix).", "tags": [ { "name": "param", "text": "encoded - The multibase-encoded string (must start with `z`)." }, { "name": "returns", "text": "The decoded bytes." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "CryptoError} with code {@link CryptoErrorCode.MultibaseDecodeFailed } on failure." }, { "name": "example", "text": "```ts\nimport { multibaseEncode, multibaseDecode } from '@openagentid/oas-crypto';\n\nconst original = new Uint8Array([1, 2, 3]);\nconst encoded = multibaseEncode(original);\nconst decoded = multibaseDecode(encoded);\n// decoded equals original\n```" } ], "signatures": [ { "code": "export declare function multibaseDecode(encoded: string): Uint8Array;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 36, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "multibasedecode" }, { "name": "multibaseEncode", "declarationName": "multibaseEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as multibase base58btc (with `z` prefix).\n\nThis is the canonical format for `publicKeyMultibase` in OAS Identity Documents.\nThe `z` prefix indicates base58btc encoding per the Multibase specification.", "tags": [ { "name": "param", "text": "bytes - The bytes to encode." }, { "name": "returns", "text": "The multibase-encoded string starting with `z`." }, { "name": "example", "text": "```ts\nimport { multibaseEncode } from '@openagentid/oas-crypto';\n\nconst encoded = multibaseEncode(new Uint8Array([1, 2, 3]));\nconsole.log(encoded.startsWith('z')); // true\n```" } ], "signatures": [ { "code": "export declare function multibaseEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/encoding.d.ts", "line": 18, "sha256": "37552f649630bade255d506cea82b142b1adfb7b9191cb84e2a462f291c25ac3" } } ], "anchor": "multibaseencode" }, { "name": "OAS_ATTESTATION_CONTEXT", "declarationName": "OAS_ATTESTATION_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS Attestation context.", "tags": [], "signatures": [ { "code": "declare const OAS_ATTESTATION_CONTEXT: \"https://openagent.id/ns/attestation/v1\";", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 9, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "oas_attestation_context" }, { "name": "OAS_CONTEXT", "declarationName": "OAS_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS-specific context.", "tags": [], "signatures": [ { "code": "declare const OAS_CONTEXT: \"https://openagent.id/ns/oas/v1\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 29, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oas_context" }, { "name": "OAS_VERSION", "declarationName": "OAS_VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Current OAS specification version.", "tags": [], "signatures": [ { "code": "declare const OAS_VERSION: \"1.0.0\";", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 33, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oas_version" }, { "name": "OasCredential", "declarationName": "OasCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS Verifiable Credential.\n\nExtends the W3C Verifiable Credentials model with OAS-specific\nattestation types. Credentials are immutable once signed.", "tags": [], "signatures": [ { "code": "export interface OasCredential {\n readonly '@context': ReadonlyArray;\n readonly type: ReadonlyArray;\n readonly issuer: string;\n readonly issuanceDate: string;\n readonly expirationDate?: string | undefined;\n readonly credentialSubject: Readonly>;\n readonly oasAttestationType?: AttestationTypeValue | undefined;\n readonly proof?: CredentialProof | undefined;\n}", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 31, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "oascredential" }, { "name": "OasDid", "declarationName": "OasDid", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A parsed and validated OAS Decentralized Identifier.\n\n`OasDid` is an immutable value object representing a fully validated\n`did:oas:::` string. Once constructed,\nall components are guaranteed to be valid per the OAS specification.\n\nConstruction is via the static {@link OasDid.parse} method or the\n{@link OasDid.create} factory. Both perform full validation.", "tags": [ { "name": "example", "text": "```ts\nimport { OasDid } from '@openagentid/oas-did';\n\nconst did = OasDid.parse('did:oas:l1fe:agent:analyzer');\nconsole.log(did.namespace); // 'l1fe'\nconsole.log(did.kind); // 'agent'\nconsole.log(did.identifier); // 'analyzer'\nconsole.log(did.isRoot); // false\nconsole.log(did.toString()); // 'did:oas:l1fe:agent:analyzer'\n\nconst compound = OasDid.parse('did:oas:l1fe:agent:instance:bot-7');\nconsole.log(compound.kind); // 'agent:instance'\nconsole.log(compound.identifier); // 'bot-7'\n```" } ], "signatures": [ { "code": "export declare class OasDid {\n readonly namespace: string;\n readonly kind: EntityKind;\n readonly identifier: string;\n static create(namespace: string, kind: EntityKind, identifier: string): OasDid;\n static parse(input: string): OasDid;\n get isRoot(): boolean;\n get kindComponentCount(): number;\n toString(): string;\n toJSON(): string;\n equals(other: OasDid): boolean;\n}", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/did.d.ts", "line": 28, "sha256": "8435c4fd3b4b7ec4b7ff4bfe4db2a79f0e5803aff8c56af2420a0f359489e69d" } } ], "anchor": "oasdid" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS Identity Document.\n\nThis is the core identity artifact in the OAS ecosystem. It extends the\nW3C DID Document format with OAS-specific properties for lineage,\nconformance, lifecycle, and entity classification.\n\nDocuments are immutable once created. Use {@link DocumentBuilder } to\nconstruct new documents.", "tags": [ { "name": "example", "text": "```ts\nimport { OasDocument, OAS_VERSION } from '@openagentid/oas-document';\n\n// Documents are created via DocumentBuilder, not constructed directly.\n// See DocumentBuilder for construction examples.\n```" } ], "signatures": [ { "code": "export interface OasDocument {\n readonly '@context': ReadonlyArray;\n readonly id: string;\n readonly controller: string | ReadonlyArray;\n readonly verificationMethod: ReadonlyArray;\n readonly authentication: ReadonlyArray;\n readonly assertionMethod: ReadonlyArray;\n readonly capabilityInvocation: ReadonlyArray;\n readonly capabilityDelegation: ReadonlyArray;\n readonly service: ReadonlyArray;\n readonly oasVersion: typeof OAS_VERSION;\n readonly kind: EntityKind;\n readonly name?: string | undefined;\n readonly description?: string | undefined;\n readonly lineage?: LineageSection | undefined;\n readonly conformanceLevel: ConformanceLevel;\n readonly lifecycleStatus?: LifecycleStatus | undefined;\n readonly sequence: number;\n readonly metadata: Readonly>;\n readonly proof?: DocumentProof | undefined;\n readonly revoked?: boolean | undefined;\n readonly revokedAt?: string | undefined;\n readonly profile?: ProfileSection | undefined;\n readonly contact?: ContactSection | undefined;\n readonly calendar?: CalendarSection | undefined;\n readonly operational?: OperationalSection | undefined;\n readonly pricing?: PricingSection | undefined;\n readonly interoperability?: InteroperabilitySection | undefined;\n readonly reputation?: ReputationSection | undefined;\n readonly compliance?: ComplianceSection | undefined;\n readonly relationships?: RelationshipsSection | undefined;\n readonly governance?: GovernanceSection | undefined;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 52, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "oasdocument" }, { "name": "OasError", "declarationName": "OasError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Unified error type for the OAS SDK.\n\nWraps errors from all sub-packages with a unified code system.\nThe original error is available via the `cause` property.", "tags": [], "signatures": [ { "code": "export declare class OasError extends Error {\n readonly code: OasErrorCode;\n readonly details: Readonly>;\n constructor(code: OasErrorCode, message: string, details?: Record);\n static from(error: unknown): OasError;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/error.d.ts", "line": 29, "sha256": "984eb72aba25fbae41b930320466ada551059b9d92c309c60769d2a171221822" } } ], "anchor": "oaserror" }, { "name": "OasErrorCode", "declarationName": "OasErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for SDK-level operations.", "tags": [], "signatures": [ { "code": "declare const OasErrorCode: {\n readonly Did: \"DID_ERROR\";\n readonly Crypto: \"CRYPTO_ERROR\";\n readonly Document: \"DOCUMENT_ERROR\";\n readonly Lineage: \"LINEAGE_ERROR\";\n readonly LineageAuthority: \"LINEAGE_AUTHORITY_ERROR\";\n readonly Resolve: \"RESOLVE_ERROR\";\n readonly Attestation: \"ATTESTATION_ERROR\";\n readonly Sdk: \"SDK_ERROR\";\n};", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/error.d.ts", "line": 4, "sha256": "984eb72aba25fbae41b930320466ada551059b9d92c309c60769d2a171221822" } }, { "code": "export type OasErrorCode = (typeof OasErrorCode)[keyof typeof OasErrorCode];", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/error.d.ts", "line": 22, "sha256": "984eb72aba25fbae41b930320466ada551059b9d92c309c60769d2a171221822" } } ], "anchor": "oaserrorcode" }, { "name": "OasKeyPair", "declarationName": "OasKeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 keypair for an OAS entity.\n\nHolds both the signing (private) and verifying (public) keys. The signing key\nis stored as a `Uint8Array` and should be zeroed when no longer needed.\n\n## Security\n\n- Private key bytes are never exposed via `toString()` or `toJSON()`\n- All signature operations use constant-time comparison internally via `@noble/ed25519`\n- Callers should zero the signing key bytes when the keypair is no longer needed:\n `keypair.signingKeyBytes.fill(0)`", "tags": [ { "name": "example", "text": "```ts\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst keypair = await OasKeyPair.generate();\nconst message = new TextEncoder().encode('hello OAS');\nconst signature = await keypair.sign(message);\nconst valid = await OasKeyPair.verifyWithKey(keypair.verifyingKeyBytes, message, signature);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export declare class OasKeyPair {\n static generate(): Promise;\n static fromSigningKeyBytes(bytes: Uint8Array): Promise;\n static verifyingKeyFromBytes(bytes: Uint8Array): Uint8Array;\n sign(message: Uint8Array): Promise;\n static verifyWithKey(publicKeyBytes: Uint8Array, message: Uint8Array, signatureBytes: Uint8Array): Promise;\n get signingKeyBytes(): Uint8Array;\n get verifyingKeyBytes(): Uint8Array;\n publicKeyMultibase(): string;\n toString(): string;\n toJSON(): {\n verifyingKey: string;\n };\n}", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/keypair.d.ts", "line": 25, "sha256": "c143b2ad5ee896897ce3d3e1b554b720354d7351b408205370a4b7a9f8c2139b" } } ], "anchor": "oaskeypair" }, { "name": "primaryPublicKeyMultibase", "declarationName": "primaryPublicKeyMultibase", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the primary public key multibase from the first verification method.", "tags": [ { "name": "param", "text": "doc - The document to inspect." }, { "name": "returns", "text": "The multibase-encoded public key, or `undefined` if no VM exists." } ], "signatures": [ { "code": "export declare function primaryPublicKeyMultibase(doc: OasDocument): string | undefined;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/document.d.ts", "line": 139, "sha256": "359f80a73d6dc6baa48ee8f06156778e3f48190e6c1a35099603ae79f5ad4fbf" } } ], "anchor": "primarypublickeymultibase" }, { "name": "PROOF_ALGORITHM", "declarationName": "PROOF_ALGORITHM", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The algorithm used for key derivation in lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_ALGORITHM: \"HKDF-SHA256-Ed25519\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 9, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_algorithm" }, { "name": "PROOF_TYPE", "declarationName": "PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The proof type identifier for OAS lineage proofs.", "tags": [], "signatures": [ { "code": "declare const PROOF_TYPE: \"AgentLineageProof2025\";", "source": { "package": "@openagentid/oas-crypto", "version": "1.0.2", "file": "dist/proof.d.ts", "line": 5, "sha256": "20891c23148e0980ed07583ca2c4eb9f5e2de2b2af71290f8bc492b2a5e54f8a" } } ], "anchor": "proof_type" }, { "name": "requiredFields", "declarationName": "requiredFields", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the required fields for a given attestation type.", "tags": [ { "name": "param", "text": "type - The attestation type." }, { "name": "returns", "text": "An array of required field names, or an empty array for custom types." } ], "signatures": [ { "code": "export declare function requiredFields(type: AttestationTypeValue): ReadonlyArray;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 32, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "requiredfields" }, { "name": "RESERVED_NAMESPACES", "declarationName": "RESERVED_NAMESPACES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Reserved namespaces that cannot be used for production entities.\n\nThese namespaces are reserved by the OAS specification for testing,\nexamples, and internal specification use.", "tags": [], "signatures": [ { "code": "declare const RESERVED_NAMESPACES: ReadonlyArray;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/namespace.d.ts", "line": 7, "sha256": "85af64a61c0e6bc5480d57074fff8d3eff1064f3c9ae5838480535a01a8f9be5" } } ], "anchor": "reserved_namespaces" }, { "name": "ResolveError", "declarationName": "ResolveError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Structured error for resolution operations.\n\nCarries a machine-readable code from the OAS §12.5 error code registry\nand a human-readable message.", "tags": [ { "name": "example", "text": "```ts\nimport { ResolveError, ResolveErrorCode } from '@openagentid/oas-resolve';\n\nconst err = new ResolveError(\n ResolveErrorCode.NotFound,\n \"DID 'did:oas:l1fe:agent:unknown' not found in any configured resolver\"\n);\n```" } ], "signatures": [ { "code": "export declare class ResolveError extends Error {\n readonly code: ResolveErrorCode;\n readonly details: Readonly>;\n constructor(code: ResolveErrorCode, message: string, details?: Record);\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/error.d.ts", "line": 47, "sha256": "f09a1454c70a650b40585488ce7f14980a15bdc2bc372d4b6577c585904d6118" } } ], "anchor": "resolveerror" }, { "name": "ResolveErrorCode", "declarationName": "ResolveErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for DID resolution operations.\n\nThese codes map to the OAS Spec §12.5 error code registry.", "tags": [], "signatures": [ { "code": "declare const ResolveErrorCode: {\n readonly NotFound: \"NOT_FOUND\";\n readonly InvalidSignature: \"INVALID_SIGNATURE\";\n readonly Revoked: \"REVOKED\";\n readonly LineageInvalid: \"LINEAGE_INVALID\";\n readonly Timeout: \"TIMEOUT\";\n readonly NetworkError: \"NETWORK_ERROR\";\n readonly Unsupported: \"UNSUPPORTED\";\n readonly InternalError: \"INTERNAL_ERROR\";\n readonly InvalidDid: \"INVALID_DID\";\n readonly RateLimited: \"RATE_LIMITED\";\n readonly AllResolversFailed: \"ALL_RESOLVERS_FAILED\";\n};", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/error.d.ts", "line": 6, "sha256": "f09a1454c70a650b40585488ce7f14980a15bdc2bc372d4b6577c585904d6118" } }, { "code": "export type ResolveErrorCode = (typeof ResolveErrorCode)[keyof typeof ResolveErrorCode];", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/error.d.ts", "line": 30, "sha256": "f09a1454c70a650b40585488ce7f14980a15bdc2bc372d4b6577c585904d6118" } } ], "anchor": "resolveerrorcode" }, { "name": "Resolver", "declarationName": "Resolver", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Interface for asynchronous OAS DID resolution.\n\nImplementations resolve `did:oas:*` strings to their Identity Documents\nfrom various backends: in-memory maps, HTTP servers, DHT networks,\nMARS registries, etc.\n\nThe OAS SDK defines this interface; consumers implement it for their\ninfrastructure. This is the agnosticism boundary.", "tags": [ { "name": "example", "text": "```ts\nimport { Resolver, InMemoryResolver } from '@openagentid/oas-resolve';\n\nconst resolver: Resolver = new InMemoryResolver();\n```" } ], "signatures": [ { "code": "export interface Resolver {\n resolve(did: string): Promise;\n}", "source": { "package": "@openagentid/oas-resolve", "version": "1.0.2", "file": "dist/resolver.d.ts", "line": 19, "sha256": "efc4dd6a39a82fdd27d95dfe46bcc08506b07c7efe0159b0277ef4d98577353a" } } ], "anchor": "resolver" }, { "name": "ResolverBackedLineageAuthorityOptions", "declarationName": "ResolverBackedLineageAuthorityOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for {@link ResolverBackedLineageAuthoritySource}.", "tags": [], "signatures": [ { "code": "export interface ResolverBackedLineageAuthorityOptions {\n readonly acceptedRootKinds?: readonly string[];\n readonly source?: string;\n readonly expectedOrgRootCommitment?: string;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 116, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "resolverbackedlineageauthorityoptions" }, { "name": "ResolverBackedLineageAuthoritySource", "declarationName": "ResolverBackedLineageAuthoritySource", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "`LineageAuthoritySource` implementation backed by resolver/GAL-shaped reads.", "tags": [], "signatures": [ { "code": "export declare class ResolverBackedLineageAuthoritySource implements LineageAuthoritySource {\n constructor(resolver: LineageAuthorityResolver, options?: ResolverBackedLineageAuthorityOptions);\n verifyAuthority(request: LineageAuthorityRequest): Promise;\n}", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 122, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "resolverbackedlineageauthoritysource" }, { "name": "ServiceEndpoint", "declarationName": "ServiceEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A service endpoint declaration in an OAS Identity Document.\n\nServices describe how to interact with the entity — API endpoints,\ncommunication channels, discovery mechanisms, etc.", "tags": [ { "name": "example", "text": "```ts\nimport { ServiceEndpoint } from '@openagentid/oas-document';\n\nconst service: ServiceEndpoint = {\n id: 'did:oas:l1fe:agent:bot#api',\n type: 'AgentApi',\n serviceEndpoint: 'https://api.l1fe.ai/agents/bot',\n};\n```" } ], "signatures": [ { "code": "export interface ServiceEndpoint {\n readonly id: string;\n readonly type: string;\n readonly serviceEndpoint: string;\n readonly label?: string;\n readonly description?: string;\n readonly properties?: Readonly>;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/service.d.ts", "line": 18, "sha256": "760d3af9b43ea7ee9f9f4bf43edecda47987acee0492e1fbadb8c3f52549c0e4" } } ], "anchor": "serviceendpoint" }, { "name": "signCredential", "declarationName": "signCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Signs an OAS Verifiable Credential with an Ed25519 keypair.\n\nThe credential is JCS-canonicalized (without the proof field), signed,\nand a proof is attached. The attestation type's required fields are\nvalidated before signing.", "tags": [ { "name": "param", "text": "credential - The unsigned credential to sign." }, { "name": "param", "text": "keypair - The issuer's Ed25519 keypair." }, { "name": "param", "text": "verificationMethodId - The VM ID to reference in the proof." }, { "name": "param", "text": "created - ISO 8601 timestamp for the proof." }, { "name": "returns", "text": "A new frozen {@link OasCredential} with proof attached." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} on validation or signing failure." }, { "name": "example", "text": "```ts\nimport { CredentialBuilder, signCredential, AttestationType } from '@openagentid/oas-attestation';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst kp = OasKeyPair.generate();\nconst unsigned = new CredentialBuilder()\n .issuer('did:oas:l1fe:hmr:alice')\n .issuanceDate('2026-01-01T00:00:00Z')\n .attestationType(AttestationType.SecurityAudit)\n .subject({\n id: 'did:oas:l1fe:agent:bot',\n auditor: 'SecureCo',\n scope: 'full',\n findings: 'none',\n })\n .build();\n\nconst signed = signCredential(\n unsigned,\n kp,\n 'did:oas:l1fe:hmr:alice#key-1',\n '2026-01-01T00:00:00Z',\n);\nconsole.log(signed.proof?.type); // 'Ed25519Signature2020'\n```" } ], "signatures": [ { "code": "export declare function signCredential(credential: OasCredential, keypair: OasKeyPair, verificationMethodId: string, created: string): Promise;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/sign.d.ts", "line": 44, "sha256": "a84d68e97287c255d5c6a7897135744849e8c2f8b6a0cd8d0e7679246c0cd897" } } ], "anchor": "signcredential" }, { "name": "StandardAttestationType", "declarationName": "StandardAttestationType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type StandardAttestationType = (typeof AttestationType)[keyof typeof AttestationType];", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 21, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "standardattestationtype" }, { "name": "validateIdentifier", "declarationName": "validateIdentifier", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates an identifier string against OAS Spec rules.\n\nA valid identifier:\n- Is 1-128 characters long\n- Contains only `[a-zA-Z0-9._-]` characters", "tags": [ { "name": "param", "text": "identifier - The identifier string to validate." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DidError} with code {@link DidErrorCode.InvalidIdentifier } if validation fails." }, { "name": "example", "text": "```ts\nimport { validateIdentifier } from '@openagentid/oas-did';\n\nvalidateIdentifier('alice'); // OK\nvalidateIdentifier('my-agent_v2.0'); // OK\nvalidateIdentifier(''); // throws DidError (empty)\nvalidateIdentifier('bad/chars'); // throws DidError (invalid chars)\n```" } ], "signatures": [ { "code": "export declare function validateIdentifier(identifier: string): void;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/validation.d.ts", "line": 21, "sha256": "3bd24eabc98960b1dbc25c80fc18783b7abfa84b445321e257b1420a07fc7533" } } ], "anchor": "validateidentifier" }, { "name": "validateNamespace", "declarationName": "validateNamespace", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates a namespace string against OAS Spec rules.\n\nA valid namespace:\n- Is 1-63 characters long\n- Contains only lowercase alphanumeric characters and hyphens\n- Does not start or end with a hyphen", "tags": [ { "name": "param", "text": "namespace - The namespace string to validate." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DidError} with code {@link DidErrorCode.InvalidNamespace } if validation fails." }, { "name": "example", "text": "```ts\nimport { validateNamespace } from '@openagentid/oas-did';\n\nvalidateNamespace('l1fe'); // OK\nvalidateNamespace('my-org'); // OK\nvalidateNamespace('L1FE'); // throws DidError (uppercase)\nvalidateNamespace('-bad'); // throws DidError (leading hyphen)\n```" } ], "signatures": [ { "code": "export declare function validateNamespace(namespace: string): void;", "source": { "package": "@openagentid/oas-did", "version": "1.0.2", "file": "dist/namespace.d.ts", "line": 29, "sha256": "85af64a61c0e6bc5480d57074fff8d3eff1064f3c9ae5838480535a01a8f9be5" } } ], "anchor": "validatenamespace" }, { "name": "validateSubject", "declarationName": "validateSubject", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates that a credential subject contains all required fields for its type.", "tags": [ { "name": "param", "text": "type - The attestation type." }, { "name": "param", "text": "subject - The credential subject claims." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} if required fields are missing." } ], "signatures": [ { "code": "export declare function validateSubject(type: AttestationTypeValue, subject: Record): void;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/types.d.ts", "line": 40, "sha256": "d2017f05e0e8d9abb6277b5a10add9fee966d0e89ee25c305dccb8dbb003e3a3" } } ], "anchor": "validatesubject" }, { "name": "VC_CONTEXT", "declarationName": "VC_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "W3C Verifiable Credential context.", "tags": [], "signatures": [ { "code": "declare const VC_CONTEXT: \"https://www.w3.org/2018/credentials/v1\";", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/credential.d.ts", "line": 5, "sha256": "83eae80cd2f5a8fe81e4ed0e858fb50739e69671e12dd3cb14fe1ae4f0bba3c3" } } ], "anchor": "vc_context" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An Ed25519 verification method in an OAS Identity Document.\n\nVerification methods bind public keys to the DID subject, enabling\nsignature verification on documents, proofs, and attestations.", "tags": [ { "name": "example", "text": "```ts\nimport { createVerificationMethod } from '@openagentid/oas-document';\nimport { OasKeyPair } from '@openagentid/oas-crypto';\n\nconst kp = OasKeyPair.generate();\nconst vm = createVerificationMethod('did:oas:l1fe:agent:bot', 1, kp);\nconsole.log(vm.id); // 'did:oas:l1fe:agent:bot#key-1'\nconsole.log(vm.type); // 'Ed25519VerificationKey2020'\n```" } ], "signatures": [ { "code": "export interface VerificationMethod {\n readonly id: string;\n readonly type: 'Ed25519VerificationKey2020';\n readonly controller: string;\n readonly publicKeyMultibase: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/verification-method.d.ts", "line": 19, "sha256": "a0ecbaf43291b9516076bb7557a5c50b41197522b07ab712d403d87086ff612c" } } ], "anchor": "verificationmethod" }, { "name": "verifyChain", "declarationName": "verifyChain", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies the full lineage chain of an identity document.\n\nConvenience wrapper around `@openagentid/oas-lineage`'s `verifyLineage`.", "tags": [ { "name": "param", "text": "document - The document to verify." }, { "name": "param", "text": "provider - The document provider for resolving parent DIDs." }, { "name": "param", "text": "config - Optional verification configuration." }, { "name": "returns", "text": "A {@link VerifyResult} on success." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "OasError} on verification failure." }, { "name": "example", "text": "```ts\nimport { verifyChain, InMemoryProvider } from '@openagentid/oas-sdk';\n\nconst result = await verifyChain(childDoc, provider);\nconsole.log(result.chainLength); // 1\n```" } ], "signatures": [ { "code": "export declare function verifyChain(document: OasDocument, provider: DocumentProvider, config?: VerifyConfig): Promise;", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 184, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "verifychain" }, { "name": "VerifyConfig", "declarationName": "VerifyConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for lineage chain verification.\n\nControls maximum chain depth, timeouts, and signature verification behavior.", "tags": [ { "name": "example", "text": "```ts\nimport { VerifyConfig } from '@openagentid/oas-lineage';\n\nconst config = VerifyConfig.withMaxGeneration(8);\n```" } ], "signatures": [ { "code": "export interface VerifyConfig {\n readonly maxGeneration: number;\n readonly perHopTimeoutMs: number;\n readonly totalTimeoutMs: number;\n readonly verifyDocumentSignatures: boolean;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 13, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "verifyconfig" }, { "name": "verifyConfigWithMaxGeneration", "declarationName": "verifyConfigWithMaxGeneration", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a verification config with a custom max generation.", "tags": [ { "name": "param", "text": "maxGeneration - The maximum allowed generation depth." }, { "name": "returns", "text": "A frozen {@link VerifyConfig}." } ], "signatures": [ { "code": "export declare function verifyConfigWithMaxGeneration(maxGeneration: number): VerifyConfig;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 35, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "verifyconfigwithmaxgeneration" }, { "name": "verifyConfigWithTimeouts", "declarationName": "verifyConfigWithTimeouts", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a verification config with custom timeouts.", "tags": [ { "name": "param", "text": "perHopTimeoutMs - Timeout per hop in milliseconds." }, { "name": "param", "text": "totalTimeoutMs - Total timeout in milliseconds." }, { "name": "returns", "text": "A frozen {@link VerifyConfig}." } ], "signatures": [ { "code": "export declare function verifyConfigWithTimeouts(perHopTimeoutMs: number, totalTimeoutMs: number): VerifyConfig;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/config.d.ts", "line": 43, "sha256": "c61ba397e5b04c999d01ea488feb66ec642ab439b4e6abda8397cb41bebc91f3" } } ], "anchor": "verifyconfigwithtimeouts" }, { "name": "verifyCredential", "declarationName": "verifyCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies an OAS Verifiable Credential's proof signature.", "tags": [ { "name": "param", "text": "credential - The signed credential to verify." }, { "name": "param", "text": "issuerPublicKeyBytes - The issuer's 32-byte Ed25519 public key." }, { "name": "returns", "text": "`true` if the proof signature is valid." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} if the credential is missing a proof." }, { "name": "example", "text": "```ts\nimport { verifyCredential } from '@openagentid/oas-attestation';\n\nconst valid = verifyCredential(signedCredential, issuerPublicKey);\nconsole.log(valid); // true\n```" } ], "signatures": [ { "code": "export declare function verifyCredential(credential: OasCredential, issuerPublicKeyBytes: Uint8Array): Promise;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 18, "sha256": "7eab3bec44bd35064586baa34aaa278ff90d8d41e798de09e55f84cbd6ac7b93" } } ], "anchor": "verifycredential" }, { "name": "verifyCredentialWithTime", "declarationName": "verifyCredentialWithTime", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a credential with temporal validation.\n\nIn addition to signature verification, checks:\n- The credential is not expired (if `expirationDate` is set)\n- The credential issuance date is not in the future", "tags": [ { "name": "param", "text": "credential - The signed credential to verify." }, { "name": "param", "text": "issuerPublicKeyBytes - The issuer's 32-byte Ed25519 public key." }, { "name": "param", "text": "now - The current time as an ISO 8601 string." }, { "name": "returns", "text": "`true` if the credential is valid (signature + temporal)." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "AttestationError} if temporal checks fail." } ], "signatures": [ { "code": "export declare function verifyCredentialWithTime(credential: OasCredential, issuerPublicKeyBytes: Uint8Array, now: string): Promise;", "source": { "package": "@openagentid/oas-attestation", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 32, "sha256": "7eab3bec44bd35064586baa34aaa278ff90d8d41e798de09e55f84cbd6ac7b93" } } ], "anchor": "verifycredentialwithtime" }, { "name": "verifyDocumentProof", "declarationName": "verifyDocumentProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a document proof against the document content and a public key.", "tags": [ { "name": "param", "text": "documentWithoutProof - The document object without the `proof` field." }, { "name": "param", "text": "proof - The proof to verify." }, { "name": "param", "text": "publicKeyBytes - The 32-byte Ed25519 public key." }, { "name": "returns", "text": "`true` if the proof is valid." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "DocumentError} on decoding or verification errors." } ], "signatures": [ { "code": "export declare function verifyDocumentProof(documentWithoutProof: Record, proof: DocumentProof, publicKeyBytes: Uint8Array): Promise;", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/proof-format.d.ts", "line": 40, "sha256": "a3fee8bb989fef8b925b333a90040a86a1df93ab8107a92748ae16b0d419e187" } } ], "anchor": "verifydocumentproof" }, { "name": "verifyLineage", "declarationName": "verifyLineage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies the full lineage chain of an OAS Identity Document.\n\nImplements the OAS Spec Appendix C verification algorithm:\n\n1. If the entity is a root, pass immediately\n2. Verify lineage section exists for non-root entities\n3. Verify chain terminates at a root entity\n4. Verify generation number matches chain length\n5. Verify chain depth does not exceed max generation\n6. Walk the chain, verifying each lineage proof cryptographically\n7. Verify root entity is not revoked", "tags": [ { "name": "param", "text": "doc - The document to verify." }, { "name": "param", "text": "provider - The document provider for resolving parent DIDs." }, { "name": "param", "text": "config - Verification configuration (optional, uses defaults)." }, { "name": "returns", "text": "A {@link VerifyResult} on success." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "LineageError} on verification failure." }, { "name": "example", "text": "```ts\nimport { verifyLineage, InMemoryProvider } from '@openagentid/oas-lineage';\n\nconst provider = new InMemoryProvider();\nprovider.register(parentDoc);\nprovider.register(childDoc);\n\nconst result = await verifyLineage(childDoc, provider);\nconsole.log(result.chainLength); // 1\nconsole.log(result.humanRootDid); // 'did:oas:l1fe:hmr:alice'\n```" } ], "signatures": [ { "code": "export declare function verifyLineage(doc: OasDocument, provider: DocumentProvider, config?: VerifyConfig): Promise;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 47, "sha256": "708ff879c2d3eafc3365a1894ab94c6d2ae714d512749c49c3680bfe04b728b1" } } ], "anchor": "verifylineage" }, { "name": "verifyLineageStructural", "declarationName": "verifyLineageStructural", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Performs structural (non-cryptographic) lineage verification.\n\nChecks shape and consistency of the lineage section without\nresolving parent documents or verifying cryptographic proofs.\nUseful for cheap pre-validation before full verification.", "tags": [ { "name": "param", "text": "doc - The document to verify structurally." }, { "name": "param", "text": "maxGeneration - Maximum allowed generation (default: 16)." }, { "name": "returns", "text": "A {@link VerifyResult} on success." }, { "name": "throws", "text": "{" }, { "name": "link", "text": "LineageError} on structural validation failure." } ], "signatures": [ { "code": "export declare function verifyLineageStructural(doc: OasDocument, maxGeneration?: number): VerifyResult;", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 60, "sha256": "708ff879c2d3eafc3365a1894ab94c6d2ae714d512749c49c3680bfe04b728b1" } } ], "anchor": "verifylineagestructural" }, { "name": "verifyPrivilegedAuthority", "declarationName": "verifyPrivilegedAuthority", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies local lineage and then requires Sigil-backed privileged authority.\n\nDownstream systems should call this before issuing ACTs, credentials,\nsessions, org membership, wallet authority, or other privileged access.\nIf the authority source is unavailable or rejects the request, this function\nfails closed.", "tags": [], "signatures": [ { "code": "export declare function verifyPrivilegedAuthority(document: OasDocument, provider: DocumentProvider, authoritySource: LineageAuthoritySource, options: {\n readonly config?: VerifyConfig;\n readonly pathKind: AuthorityPathKind;\n readonly requiredScopes?: readonly string[];\n readonly minFinalizedBlock?: number;\n}): Promise;", "source": { "package": "@openagentid/oas-sdk", "version": "1.0.2", "file": "dist/lineage.d.ts", "line": 193, "sha256": "ca442e0816bd0917cc800d889e215b792549d349865b3c1ee2dc5760dd3cb503" } } ], "anchor": "verifyprivilegedauthority" }, { "name": "VerifyResult", "declarationName": "VerifyResult", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The result of a successful lineage verification.", "tags": [], "signatures": [ { "code": "export interface VerifyResult {\n readonly chainLength: number;\n readonly humanRootDid: string;\n readonly warnings: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-lineage", "version": "1.0.2", "file": "dist/verify.d.ts", "line": 7, "sha256": "708ff879c2d3eafc3365a1894ab94c6d2ae714d512749c49c3680bfe04b728b1" } } ], "anchor": "verifyresult" } ], "supportingDeclarations": [ { "name": "Affiliation", "declarationName": "Affiliation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Affiliation {\n readonly did: string;\n readonly relationship: string;\n readonly label?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 1, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "affiliation" }, { "name": "ApiSchema", "declarationName": "ApiSchema", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ApiSchema {\n readonly schemaType: string;\n readonly url: string;\n readonly version?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 6, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "apischema" }, { "name": "BookingEndpoint", "declarationName": "BookingEndpoint", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface BookingEndpoint {\n readonly id: string;\n readonly url: string;\n readonly label?: string;\n readonly bookingType?: string;\n readonly visibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 8, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "bookingendpoint" }, { "name": "CalendarSection", "declarationName": "CalendarSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CalendarSection {\n readonly bookingEndpoints?: ReadonlyArray;\n readonly availabilityFeed?: string;\n readonly schedulingProtocol?: string;\n readonly officeHours?: ReadonlyArray;\n readonly timezone?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 15, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "calendarsection" }, { "name": "Certification", "declarationName": "Certification", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Certification {\n readonly standard: string;\n readonly issuer?: string;\n readonly validUntil?: string;\n readonly url?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 1, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "certification" }, { "name": "ComplianceSection", "declarationName": "ComplianceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ComplianceSection {\n readonly jurisdictions?: ReadonlyArray;\n readonly certifications?: ReadonlyArray;\n readonly termsOfServiceUrl?: string;\n readonly privacyPolicyUrl?: string;\n readonly dataHandlingPolicyUrl?: string;\n readonly dataResidency?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/compliance.d.ts", "line": 7, "sha256": "cad08eb79e88791421b6b8b22c8d2b132a3519a551723550b61a2195ba8a8e1b" } } ], "anchor": "compliancesection" }, { "name": "ContactEntry", "declarationName": "ContactEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactEntry {\n readonly id: string;\n readonly entryType: string;\n readonly value: string;\n readonly label?: string;\n readonly platform?: string;\n readonly handle?: string;\n readonly visibility?: Visibility;\n readonly verified?: boolean;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 2, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactentry" }, { "name": "ContactSection", "declarationName": "ContactSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ContactSection {\n readonly entries: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/contact.d.ts", "line": 12, "sha256": "b26094b08172ea4844f113c0dd9165f9b77d1920fa10d0f321832adac6c1899c" } } ], "anchor": "contactsection" }, { "name": "CostEntry", "declarationName": "CostEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface CostEntry {\n readonly unit: string;\n readonly amount: string;\n readonly currency: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 2, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "costentry" }, { "name": "GovernancePolicy", "declarationName": "GovernancePolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Policy constraints governing how ENR transitions may occur.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernancePolicy, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst policy = defaultGovernancePolicy();\nconsole.log(policy.maxTransitionsPerDay); // 1\nconsole.log(policy.timelockHours); // 24\n```" } ], "signatures": [ { "code": "export interface GovernancePolicy {\n readonly transitionRequires: string;\n readonly signingKeyRotationRequires: string;\n readonly maxTransitionsPerDay: number;\n readonly timelockHours: number;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 26, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancepolicy" }, { "name": "GovernanceSection", "declarationName": "GovernanceSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Governance section attached to ENR identity documents.\n\nTracks the governing MHR, monotonic epoch counter, transition history,\nand governance policy constraints.\n\n**Invariants:**\n- `epoch` MUST strictly increase (no gaps, no rewinds).\n- `currentMhr` MUST reference a valid, non-revoked MHR DID.\n- Each transition's `from` MUST match the previous transition's `to`.", "tags": [ { "name": "example", "text": "```ts\nimport { GovernanceSection, defaultGovernancePolicy } from '@openagentid/oas-document';\n\nconst gov: GovernanceSection = {\n currentMhr: 'did:oas:prod:mhr:council-alpha',\n epoch: 1,\n transitions: [],\n policy: defaultGovernancePolicy(),\n};\n```" } ], "signatures": [ { "code": "export interface GovernanceSection {\n readonly currentMhr: string;\n readonly epoch: number;\n readonly transitions: ReadonlyArray;\n readonly policy: GovernancePolicy;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 96, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancesection" }, { "name": "GovernanceTransition", "declarationName": "GovernanceTransition", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single governance transition record.\n\nRecords the handoff from one MHR to another, including the\ncryptographic proof (FROST threshold signature from the outgoing MHR).", "tags": [], "signatures": [ { "code": "export interface GovernanceTransition {\n readonly from?: string | undefined;\n readonly to: string;\n readonly epoch: number;\n readonly proof: GovernanceTransitionProof;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 63, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransition" }, { "name": "GovernanceTransitionProof", "declarationName": "GovernanceTransitionProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Proof that a governance transition was authorized.\n\nContains a FROST threshold signature from the outgoing MHR members,\nproving that a quorum approved the handoff.", "tags": [], "signatures": [ { "code": "export interface GovernanceTransitionProof {\n readonly type: string;\n readonly mhrThresholdSignature: string;\n readonly timestamp: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/governance.d.ts", "line": 49, "sha256": "554ec5d63162d5cef11473e23b71f2ab5006ce39aa9ec37c25a06392b41b64aa" } } ], "anchor": "governancetransitionproof" }, { "name": "InteroperabilitySection", "declarationName": "InteroperabilitySection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface InteroperabilitySection {\n readonly protocols?: ReadonlyArray;\n readonly apiSchemas?: ReadonlyArray;\n readonly authMethods?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 11, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "interoperabilitysection" }, { "name": "OperationalSection", "declarationName": "OperationalSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface OperationalSection {\n readonly availability?: string;\n readonly sla?: ReadonlyArray;\n readonly rateLimits?: ReadonlyArray;\n readonly supportedInputFormats?: ReadonlyArray;\n readonly supportedOutputFormats?: ReadonlyArray;\n readonly maxPayloadBytes?: number;\n readonly maxContextTokens?: number;\n readonly maintenanceWindows?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 11, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "operationalsection" }, { "name": "PricingSection", "declarationName": "PricingSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface PricingSection {\n readonly model: string;\n readonly costs?: ReadonlyArray;\n readonly currenciesAccepted?: ReadonlyArray;\n readonly billingEndpoint?: string;\n readonly freeTierLimits?: string;\n readonly billingVisibility?: Visibility;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/pricing.d.ts", "line": 7, "sha256": "6a0c63b4a32df941fb2abf70ee83a5a249e668bfd1b4d5862c1c623d73d1f637" } } ], "anchor": "pricingsection" }, { "name": "ProfileSection", "declarationName": "ProfileSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProfileSection {\n readonly avatarUrl?: string;\n readonly bannerUrl?: string;\n readonly tagline?: string;\n readonly categories?: ReadonlyArray;\n readonly languages?: ReadonlyArray;\n readonly timezone?: string;\n readonly accentColor?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/profile.d.ts", "line": 1, "sha256": "fa4dc1aeee47ab1108c7bb120a44a1546e7188fb68b2cdf6ea6e32f96b2f575e" } } ], "anchor": "profilesection" }, { "name": "ProtocolSupport", "declarationName": "ProtocolSupport", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ProtocolSupport {\n readonly protocol: string;\n readonly version?: string;\n readonly endpoint?: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/interop.d.ts", "line": 1, "sha256": "2a8513c71e32c099aa45d537b086e47f8037ca6b236af241583774ff7bdeb08a" } } ], "anchor": "protocolsupport" }, { "name": "RateLimit", "declarationName": "RateLimit", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RateLimit {\n readonly resource: string;\n readonly limit: number;\n readonly window: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 6, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "ratelimit" }, { "name": "RelationshipsSection", "declarationName": "RelationshipsSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface RelationshipsSection {\n readonly parentOrganization?: string;\n readonly affiliations?: ReadonlyArray;\n readonly blockedDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/relationships.d.ts", "line": 6, "sha256": "c8e3e4ac43745a2dc29c78f0c5ac38726449e6b23ad9c923b875d36c6420ff57" } } ], "anchor": "relationshipssection" }, { "name": "ReputationSection", "declarationName": "ReputationSection", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ReputationSection {\n readonly totalInteractions?: number;\n readonly endorsementCount?: number;\n readonly trustScore?: string;\n readonly uptime30d?: string;\n readonly uptime90d?: string;\n readonly firstActive?: string;\n readonly endorserDids?: ReadonlyArray;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/reputation.d.ts", "line": 1, "sha256": "f7e4816a049d93e1c05d6f9a26150fa8e3656567bba68a9bddef244cd51c9aae" } } ], "anchor": "reputationsection" }, { "name": "ScheduleWindow", "declarationName": "ScheduleWindow", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface ScheduleWindow {\n readonly day: string;\n readonly start: string;\n readonly end: string;\n readonly timezone: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/calendar.d.ts", "line": 2, "sha256": "be85078501bde92c70a6cb4af0eab5d274b79a8a44d6896efe0f03e92f2454c8" } } ], "anchor": "schedulewindow" }, { "name": "SlaCommitment", "declarationName": "SlaCommitment", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface SlaCommitment {\n readonly metric: string;\n readonly target: string;\n}", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/operational.d.ts", "line": 2, "sha256": "8b2d001c9bdfebece45a56bf41596acec02385517ed936bf703744fd7efed342" } } ], "anchor": "slacommitment" }, { "name": "Visibility", "declarationName": "Visibility", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type Visibility = 'public' | 'authenticated' | 'organization' | 'private';", "source": { "package": "@openagentid/oas-document", "version": "1.0.2", "file": "dist/visibility.d.ts", "line": 1, "sha256": "1315dc096b8891ee4f8e89553cee8fd48686954d4fe4da52eae62dab8b53d2be" } } ], "anchor": "visibility" } ], "coverage": { "discovered": 111, "documented": 111, "missing": [] } } ] }, { "name": "@openagentid/oas-vanilla", "version": "1.0.2", "status": "published", "notes": [ "Publishes JavaScript with JSDoc, not TypeScript declarations. Inferred signatures are labeled separately." ], "tarball": "https://registry.npmjs.org/@openagentid/oas-vanilla/-/oas-vanilla-1.0.2.tgz", "integrity": "sha512-66sPTWDxCcQ55S9YvPbk4BxF8c92CNqAHOUv7jp1uC+3ygYzZKf5dbvK2/rQwvhP+3oi7T3n1Zn1K1PK99zvMQ==", "packageJsonSha256": "de53fc597f5c9474db7ce72fa18f0403804fb7802e4d9f9f46bba73846caddf4", "page": "/reference/typescript/oas-vanilla", "engines": { "node": ">=20.0.0" }, "dependencies": {}, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oas-vanilla", "page": "/reference/typescript/oas-vanilla", "kind": "javascript", "conditions": "./src/index.js", "paths": [ { "conditions": [], "path": "./src/index.js" } ], "exports": [ { "name": "Affiliation", "declarationName": "Affiliation", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An affiliation with another entity.", "tags": [], "signatures": [ { "code": "declare class Affiliation {\n constructor(fields: any);\n static fromJSON(obj: any): Affiliation;\n did: string;\n relationship: string;\n label: string;\n toJSON(): { did: string; relationship: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 522, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "affiliation" }, { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Agent lineage proof with migration-compatible optional security bindings.\n\nLegacy instances remain parseable, but every verification method rejects\nthem with `LegacyInsecureProof`.", "tags": [], "signatures": [ { "code": "declare class AgentLineageProof {\n constructor(fields: Record);\n static generate(parentKeypair: any, parentDid: any, childDid: any, derivationPath: any): Promise;\n static generateBound(parentKeypair: OasKeyPair, binding: { parentDid: string; childDid: string; derivationPath: string; verificationMethod: string; childVerificationMethod: string; childPublicKeyMultibase: string; parentDocumentDigest: string; parentDocumentSequence: number; generation: number; }): Promise;\n static fromJSON(input: any): AgentLineageProof;\n type: any;\n parentDid: any;\n childDid: any;\n derivationPath: any;\n algorithm: any;\n publicKeyMultibase: any;\n verificationMethod: any;\n proofPurpose: any;\n canonicalization: any;\n childVerificationMethod: any;\n childPublicKeyMultibase: any;\n parentDocumentDigest: any;\n parentDocumentSequence: any;\n generation: any;\n signature: any;\n verify(): Promise;\n verifyWithKey(trustedPublicKey: Uint8Array | string): Promise;\n toJSON(): Record;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 49, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "agentlineageproof" }, { "name": "ApiSchema", "declarationName": "ApiSchema", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An API schema reference.", "tags": [], "signatures": [ { "code": "declare class ApiSchema {\n constructor(fields: any);\n static fromJSON(obj: any): ApiSchema;\n schemaType: string;\n url: string;\n version: string;\n toJSON(): { schemaType: string; url: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 370, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "apischema" }, { "name": "AttestationError", "declarationName": "AttestationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error class for OAS attestation operations.", "tags": [ { "name": "extends", "text": "Error" } ], "signatures": [ { "code": "declare class AttestationError {\n constructor(code: string, message: string);\n code: string;\n name: string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/errors.js", "line": 19, "sha256": "013531d8af1563c2fdb061d9c828db78103450e9d1a154aa4dc08c6848756de4" } } ], "anchor": "attestationerror" }, { "name": "AttestationErrorCode", "declarationName": "AttestationErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS attestation operations.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const AttestationErrorCode: Readonly<{ INVALID_CREDENTIAL: \"INVALID_CREDENTIAL\"; SIGNING_FAILED: \"SIGNING_FAILED\"; VERIFICATION_FAILED: \"VERIFICATION_FAILED\"; MISSING_FIELD: \"MISSING_FIELD\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/errors.js", "line": 8, "sha256": "013531d8af1563c2fdb061d9c828db78103450e9d1a154aa4dc08c6848756de4" } } ], "anchor": "attestationerrorcode" }, { "name": "AttestationType", "declarationName": "AttestationType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard attestation types per OAS Specification §10.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const AttestationType: Readonly<{ LIVENESS: \"LivenessAttestation\"; CAPABILITY: \"CapabilityAttestation\"; CONFORMANCE: \"ConformanceAttestation\"; TRUST: \"TrustAttestation\"; MEMBERSHIP: \"MembershipAttestation\"; CLASSIFICATION: \"ClassificationAttestation\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/types.js", "line": 9, "sha256": "c39a485928776a65b6b6d759c7ef76d9bc42d185b68872492381bc42914ae394" } } ], "anchor": "attestationtype" }, { "name": "base58btcDecode", "declarationName": "base58btcDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a base58btc string to a Uint8Array.", "tags": [ { "name": "param", "text": "str - The base58btc-encoded string." }, { "name": "returns", "text": "The decoded bytes." }, { "name": "throws", "text": "{CryptoError} If the string contains invalid base58 characters." }, { "name": "example", "text": "base58btcDecode(\"Ldp\"); // Uint8Array [1, 2, 3]" } ], "signatures": [ { "code": "declare function base58btcDecode(str: string): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 80, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "base58btcdecode" }, { "name": "base58btcEncode", "declarationName": "base58btcEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes a Uint8Array as base58btc.", "tags": [ { "name": "param", "text": "bytes - The raw bytes to encode." }, { "name": "returns", "text": "The base58btc-encoded string." }, { "name": "example", "text": "base58btcEncode(new Uint8Array([1, 2, 3])); // \"Ldp\"" } ], "signatures": [ { "code": "declare function base58btcEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 24, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "base58btcencode" }, { "name": "base64urlDecode", "declarationName": "base64urlDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a base64url string (RFC 4648 §5) into raw bytes.\n\nAccepts input with or without padding.", "tags": [ { "name": "param", "text": "encoded - A base64url-encoded string." }, { "name": "returns", "text": "The decoded raw bytes." }, { "name": "throws", "text": "{CryptoError} If the input is not valid base64url." }, { "name": "example", "text": "base64urlDecode(\"AQID\"); // Uint8Array [1, 2, 3]" } ], "signatures": [ { "code": "declare function base64urlDecode(encoded: string): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 226, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "base64urldecode" }, { "name": "base64urlEncode", "declarationName": "base64urlEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as base64url without padding (RFC 4648 §5).\n\nThis is the canonical encoding for Ed25519 signatures in OAS.", "tags": [ { "name": "param", "text": "bytes - The raw bytes to encode." }, { "name": "returns", "text": "A base64url-encoded string without padding." }, { "name": "example", "text": "base64urlEncode(new Uint8Array([1, 2, 3])); // \"AQID\"" } ], "signatures": [ { "code": "declare function base64urlEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 184, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "base64urlencode" }, { "name": "blake3Hash", "declarationName": "blake3Hash", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes the BLAKE3 hash of the given data.\n\nReturns the 32-byte hash as a Uint8Array.", "tags": [ { "name": "param", "text": "data - The bytes to hash." }, { "name": "returns", "text": "A 32-byte BLAKE3 hash." }, { "name": "example", "text": "const hash = blake3Hash(new Uint8Array([104, 101, 108, 108, 111]));\nconsole.log(hash.length); // 32" } ], "signatures": [ { "code": "declare function blake3Hash(data: Uint8Array): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/hashing.js", "line": 170, "sha256": "0b5765f7154e8cabaf03bcad14a754088191aeb308b12340f2e4932764105272" } } ], "anchor": "blake3hash" }, { "name": "blake3HashHex", "declarationName": "blake3HashHex", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes the BLAKE3 hash and returns it as a hex string.", "tags": [ { "name": "param", "text": "data - The bytes to hash." }, { "name": "returns", "text": "A 64-character lowercase hex string of the BLAKE3 hash." }, { "name": "example", "text": "const hex = blake3HashHex(new TextEncoder().encode(\"hello world\"));\nconsole.log(hex.length); // 64" } ], "signatures": [ { "code": "declare function blake3HashHex(data: Uint8Array): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/hashing.js", "line": 302, "sha256": "0b5765f7154e8cabaf03bcad14a754088191aeb308b12340f2e4932764105272" } } ], "anchor": "blake3hashhex" }, { "name": "BookingEndpoint", "declarationName": "BookingEndpoint", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A booking endpoint for scheduling interactions.", "tags": [], "signatures": [ { "code": "declare class BookingEndpoint {\n constructor(fields: any);\n static fromJSON(obj: any): BookingEndpoint;\n id: string;\n url: string;\n label: string;\n bookingType: string;\n visibility: string;\n toJSON(): { id: string; url: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 130, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "bookingendpoint" }, { "name": "CachingResolver", "declarationName": "CachingResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A caching resolver that wraps another resolver.\n\nCaches resolved documents in memory to avoid redundant lookups.\nEntries expire after a configurable TTL.", "tags": [ { "name": "example", "text": "const cached = new CachingResolver(innerResolver, 60000); // 60s TTL\nconst doc = await cached.resolve(\"did:oas:test:hmr:alice\");" } ], "signatures": [ { "code": "declare class CachingResolver {\n constructor(inner: { resolve: (did: string) => Promise; }, ttlMs?: number);\n _inner: { resolve: (did: string) => Promise; };\n _ttlMs: number;\n _cache: Map;\n resolve(did: string): Promise;\n clear(): void;\n size: number;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/resolve/cache.js", "line": 14, "sha256": "927ea358f37ed5e22b13b1b88f2a6dd6fb2f13e8c01db9a6f36baf55eb14ccae" } } ], "anchor": "cachingresolver" }, { "name": "CalendarSection", "declarationName": "CalendarSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Calendar & scheduling section.", "tags": [], "signatures": [ { "code": "declare class CalendarSection {\n constructor(fields?: {});\n static fromJSON(obj: any): CalendarSection;\n bookingEndpoints: BookingEndpoint[];\n availabilityFeed: string;\n schedulingProtocol: string;\n officeHours: ScheduleWindow[];\n timezone: string;\n toJSON(): { bookingEndpoints: { id: string; url: string; }[]; availabilityFeed: string; schedulingProtocol: string; officeHours: { day: string; start: string; end: string; }[]; timezone: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 159, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "calendarsection" }, { "name": "canonicalDocumentDigest", "declarationName": "canonicalDocumentDigest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes a Rust-compatible digest of an OAS document's JSON wire form.", "tags": [ { "name": "param", "text": "document" }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function canonicalDocumentDigest(document: OasDocument | object): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 339, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "canonicaldocumentdigest" }, { "name": "canonicalize", "declarationName": "canonicalize", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Canonicalizes a JavaScript value using JCS (RFC 8785).\n\nProduces a deterministic byte representation where object keys are sorted\nlexicographically and no insignificant whitespace is present.\nNumbers are serialized according to ECMAScript's Number.toString() which\nmatches RFC 8785 requirements.", "tags": [ { "name": "param", "text": "value - A JSON-compatible value to canonicalize." }, { "name": "returns", "text": "The canonical JSON bytes (UTF-8)." }, { "name": "throws", "text": "{CryptoError} If the value cannot be canonicalized." }, { "name": "example", "text": "const bytes = canonicalize({ b: 1, a: 2 });\nnew TextDecoder().decode(bytes); // '{\"a\":2,\"b\":1}'" } ], "signatures": [ { "code": "declare function canonicalize(value: any): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/jcs.js", "line": 25, "sha256": "13f602162b662b2e104a1da18872e8385d9abd24605658978b4d881ee28fe438" } } ], "anchor": "canonicalize" }, { "name": "canonicalProofPayload", "declarationName": "canonicalProofPayload", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Constructs exact RFC 8785 UTF-8 bytes for a strict proof.", "tags": [ { "name": "param", "text": "proof" }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function canonicalProofPayload(proof: AgentLineageProof | Record): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 412, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "canonicalproofpayload" }, { "name": "Certification", "declarationName": "Certification", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A compliance certification.", "tags": [], "signatures": [ { "code": "declare class Certification {\n constructor(fields: any);\n static fromJSON(obj: any): Certification;\n standard: string;\n issuer: string;\n validUntil: string;\n toJSON(): { standard: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 461, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "certification" }, { "name": "ComplianceSection", "declarationName": "ComplianceSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Compliance & jurisdiction section.", "tags": [], "signatures": [ { "code": "declare class ComplianceSection {\n constructor(fields?: {});\n static fromJSON(obj: any): ComplianceSection;\n jurisdictions: string[];\n certifications: Certification[];\n termsOfServiceUrl: string;\n privacyPolicyUrl: string;\n dataHandlingPolicyUrl: string;\n dataResidency: string;\n toJSON(): { jurisdictions: string[]; certifications: { standard: string; }[]; termsOfServiceUrl: string; privacyPolicyUrl: string; dataHandlingPolicyUrl: string; dataResidency: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 485, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "compliancesection" }, { "name": "componentCount", "declarationName": "componentCount", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the number of DID components this kind consumes.\n\nMost kinds are a single component (e.g., `agent`), but `agent:instance`\nis a compound kind that consumes two components (`agent` + `instance`).", "tags": [ { "name": "param", "text": "kind - The entity kind string." }, { "name": "returns", "text": "2 for agent:instance, 1 for all others." }, { "name": "example", "text": "componentCount(EntityKind.AGENT_INSTANCE); // 2\ncomponentCount(EntityKind.AGENT); // 1" } ], "signatures": [ { "code": "declare function componentCount(kind: string): number;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/kind.js", "line": 103, "sha256": "fae49ea352c5ec64169339c8ce5e508a272db570fa250a0aeeafa758cef5af98" } } ], "anchor": "componentcount" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS conformance levels.\n\nL0 = Basic (identity + document structure)\nL1 = Accountable (L0 + lineage + proofs)\nL2 = Full (L1 + WASM + on-chain deployment)", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const ConformanceLevel: Readonly<{ L0: \"L0\"; L1: \"L1\"; L2: \"L2\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/conformance.js", "line": 13, "sha256": "0a07c517fe67cc1961d8dc3371f96b9687e1e754a42c78fbe27c06abaad4eca9" } } ], "anchor": "conformancelevel" }, { "name": "ContactEntry", "declarationName": "ContactEntry", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A single contact directory entry.", "tags": [], "signatures": [ { "code": "declare class ContactEntry {\n constructor(fields: any);\n static fromJSON(obj: any): ContactEntry;\n id: string;\n entryType: string;\n value: string;\n label: string;\n platform: string;\n handle: string;\n visibility: string;\n verified: boolean;\n toJSON(): { id: string; entryType: string; value: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 47, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "contactentry" }, { "name": "ContactSection", "declarationName": "ContactSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Contact directory section.", "tags": [], "signatures": [ { "code": "declare class ContactSection {\n constructor(fields?: {});\n static fromJSON(obj: any): ContactSection;\n entries: ContactEntry[];\n toJSON(): { entries?: undefined; } | { entries: { id: string; entryType: string; value: string; }[]; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 84, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "contactsection" }, { "name": "CostEntry", "declarationName": "CostEntry", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A cost/fee entry.", "tags": [], "signatures": [ { "code": "declare class CostEntry {\n constructor(fields: any);\n static fromJSON(obj: any): CostEntry;\n description: string;\n amount: string;\n currency: string;\n unit: string;\n toJSON(): { description: string; amount: string; currency: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 284, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "costentry" }, { "name": "CreatedIdentity", "declarationName": "CreatedIdentity", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The result of creating a new root identity.\n\nContains the signed identity document and the keypair used to sign it.\nThe caller is responsible for securely storing the keypair.", "tags": [], "signatures": [ { "code": "declare class CreatedIdentity {\n constructor(document: OasDocument, keypair: OasKeyPair);\n document: OasDocument;\n keypair: OasKeyPair;\n toString(): string;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 15, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createdidentity" }, { "name": "createGovernancePolicy", "declarationName": "createGovernancePolicy", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a GovernancePolicy with the given or default constraints.", "tags": [ { "name": "param", "text": "fields" }, { "name": "param", "text": "fields.transitionRequires - What is required to transition governance (default: \"mhr_threshold\")." }, { "name": "param", "text": "fields.signingKeyRotationRequires - What is required to rotate the ENR signing key (default: \"mhr_threshold\")." }, { "name": "param", "text": "fields.maxTransitionsPerDay - Maximum transitions per 24-hour period (default: 1)." }, { "name": "param", "text": "fields.timelockHours - Mandatory delay in hours between initiating and confirming (default: 24)." }, { "name": "returns", "text": "" }, { "name": "example", "text": "const policy = createGovernancePolicy();\nconsole.log(policy.transitionRequires); // \"mhr_threshold\"" } ], "signatures": [ { "code": "declare function createGovernancePolicy(fields?: { transitionRequires?: string; signingKeyRotationRequires?: string; maxTransitionsPerDay?: number; timelockHours?: number; }): GovernancePolicy;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 31, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "creategovernancepolicy" }, { "name": "createGovernanceSection", "declarationName": "createGovernanceSection", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a GovernanceSection for an ENR identity document.", "tags": [ { "name": "param", "text": "fields" }, { "name": "param", "text": "fields.currentMhr - DID of the MHR currently governing this ENR." }, { "name": "param", "text": "fields.epoch - Monotonically increasing epoch counter." }, { "name": "param", "text": "fields.transitions - Complete transition history." }, { "name": "param", "text": "fields.policy - Governance policy constraints." }, { "name": "returns", "text": "" }, { "name": "example", "text": "const gov = createGovernanceSection({\n currentMhr: 'did:oas:prod:mhr:council-alpha',\n epoch: 1,\n transitions: [],\n policy: createGovernancePolicy(),\n});" } ], "signatures": [ { "code": "declare function createGovernanceSection(fields: { currentMhr: string; epoch: number; transitions?: GovernanceTransition[]; policy: GovernancePolicy; }): GovernanceSection;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 117, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "creategovernancesection" }, { "name": "createGovernanceTransition", "declarationName": "createGovernanceTransition", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a GovernanceTransition record.", "tags": [ { "name": "param", "text": "fields" }, { "name": "param", "text": "fields.from - DID of the outgoing MHR (null for initial assignment)." }, { "name": "param", "text": "fields.to - DID of the incoming MHR." }, { "name": "param", "text": "fields.epoch - Epoch at which this transition occurred." }, { "name": "param", "text": "fields.proof - Cryptographic proof." }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function createGovernanceTransition(fields: { from?: string | null; to: string; epoch: number; proof: GovernanceTransitionProof; }): GovernanceTransition;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 82, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "creategovernancetransition" }, { "name": "createGovernanceTransitionProof", "declarationName": "createGovernanceTransitionProof", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a GovernanceTransitionProof.", "tags": [ { "name": "param", "text": "fields" }, { "name": "param", "text": "fields.type - Proof type identifier." }, { "name": "param", "text": "fields.mhrThresholdSignature - FROST threshold signature (base64url-encoded)." }, { "name": "param", "text": "fields.timestamp - ISO 8601 timestamp." }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function createGovernanceTransitionProof(fields: { type: string; mhrThresholdSignature: string; timestamp: string; }): GovernanceTransitionProof;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 57, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "creategovernancetransitionproof" }, { "name": "createHmr", "declarationName": "createHmr", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new Human Root (HMR) identity.\n\nGenerates a fresh Ed25519 keypair, constructs an OAS Identity Document\nfor a did:oas::hmr: DID, and signs it.", "tags": [ { "name": "param", "text": "namespace - The OAS namespace (e.g., \"l1fe\", \"test\")." }, { "name": "param", "text": "identifier - The unique identifier within the namespace." }, { "name": "param", "text": "created - ISO 8601 timestamp for the document metadata." }, { "name": "returns", "text": "The signed document and keypair." }, { "name": "throws", "text": "{OasError} If DID construction or document building fails." }, { "name": "example", "text": "const identity = await createHmr(\"test\", \"alice\", \"2026-01-15T00:00:00Z\");\nconsole.log(identity.document.id); // \"did:oas:test:hmr:alice\"" } ], "signatures": [ { "code": "declare function createHmr(namespace: string, identifier: string, created: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 63, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createhmr" }, { "name": "createMhr", "declarationName": "createMhr", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new Multi-Human Root (MHR) identity.\n\nSimilar to createHmr but for machine-originated root entities.", "tags": [ { "name": "param", "text": "namespace - The OAS namespace." }, { "name": "param", "text": "identifier - The unique identifier." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "The signed document and keypair." }, { "name": "throws", "text": "{OasError}" }, { "name": "example", "text": "const identity = await createMhr(\"test\", \"system1\", \"2026-01-15T00:00:00Z\");\nconsole.log(identity.document.id); // \"did:oas:test:mhr:system1\"" } ], "signatures": [ { "code": "declare function createMhr(namespace: string, identifier: string, created: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 99, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createmhr" }, { "name": "createRootWithKeypair", "declarationName": "createRootWithKeypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new root identity with a pre-existing keypair.", "tags": [ { "name": "param", "text": "namespace - The OAS namespace." }, { "name": "param", "text": "kind - The entity kind (\"hmr\" or \"mhr\")." }, { "name": "param", "text": "identifier - The unique identifier." }, { "name": "param", "text": "keypair - The Ed25519 keypair to use." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "The signed document." }, { "name": "throws", "text": "{OasError}" }, { "name": "example", "text": "const keypair = await OasKeyPair.generate();\nconst doc = await createRootWithKeypair(\"test\", \"hmr\", \"alice\", keypair, \"2026-01-15T00:00:00Z\");" } ], "signatures": [ { "code": "declare function createRootWithKeypair(namespace: string, kind: string, identifier: string, keypair: OasKeyPair, created: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 135, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createrootwithkeypair" }, { "name": "createVerifyLineageRequest", "declarationName": "createVerifyLineageRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Builds a frozen authorization request. Structural-only or migration results\ncannot be converted into this request shape.", "tags": [ { "name": "param", "text": "document" }, { "name": "param", "text": "provider" }, { "name": "param", "text": "options" }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function createVerifyLineageRequest(document: import(\"../document/document.js\").OasDocument, provider: any, options: VerifyConfig): Readonly;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/verify.js", "line": 43, "sha256": "9e8365fa5badb827f7d73e8b4a448e549cf3ca9fdc67e00cfd5fcf93aee7ffad" } } ], "anchor": "createverifylineagerequest" }, { "name": "CryptoError", "declarationName": "CryptoError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error class for OAS cryptographic operations.\n\nEvery variant includes enough context to diagnose the issue without\nrequiring access to private key material.", "tags": [ { "name": "extends", "text": "Error" }, { "name": "example", "text": "const err = new CryptoError(CryptoErrorCode.INVALID_SIGNATURE, \"lineage proof verification failed\");\nconsole.log(err.code); // \"INVALID_SIGNATURE\"" } ], "signatures": [ { "code": "declare class CryptoError {\n constructor(code: string, message: string);\n code: string;\n name: string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/errors.js", "line": 39, "sha256": "6872f50f3eb920b4f493502aa8676430976548ce9012e1f16a196d8786d4c9c1" } } ], "anchor": "cryptoerror" }, { "name": "CryptoErrorCode", "declarationName": "CryptoErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS cryptographic operations.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const CryptoErrorCode: Readonly<{ INVALID_SIGNATURE: \"INVALID_SIGNATURE\"; INVALID_KEY_LENGTH: \"INVALID_KEY_LENGTH\"; DERIVATION_FAILED: \"DERIVATION_FAILED\"; MULTIBASE_DECODE_FAILED: \"MULTIBASE_DECODE_FAILED\"; BASE64_DECODE_FAILED: \"BASE64_DECODE_FAILED\"; CANONICALIZATION_FAILED: \"CANONICALIZATION_FAILED\"; INVALID_PROOF_PAYLOAD: \"INVALID_PROOF_PAYLOAD\"; LEGACY_INSECURE_PROOF: \"LegacyInsecureProof\"; VERIFIER_TRUST_REQUIRED: \"VerifierTrustRequired\"; UNSUPPORTED_PROOF_TYPE: \"UnsupportedProofType\"; UNSUPPORTED_PROOF_ALGORITHM: \"UnsupportedProofAlgorithm\"; UNSUPPORTED_CANONICALIZATION: \"UnsupportedCanonicalization\"; UNSUPPORTED_PROOF_PURPOSE: \"UnsupportedProofPurpose\"; EMBEDDED_KEY_MISMATCH: \"EmbeddedKeyMismatch\"; KEY_CONSTRUCTION_FAILED: \"KEY_CONSTRUCTION_FAILED\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/errors.js", "line": 9, "sha256": "6872f50f3eb920b4f493502aa8676430976548ce9012e1f16a196d8786d4c9c1" } } ], "anchor": "cryptoerrorcode" }, { "name": "DEFAULT_MAX_TRANSITIONS_PER_DAY", "declarationName": "DEFAULT_MAX_TRANSITIONS_PER_DAY", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default maximum transitions per 24-hour period.", "tags": [], "signatures": [ { "code": "declare const DEFAULT_MAX_TRANSITIONS_PER_DAY: 1;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 12, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "default_max_transitions_per_day" }, { "name": "DEFAULT_TIMELOCK_HOURS", "declarationName": "DEFAULT_TIMELOCK_HOURS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Default timelock delay in hours.", "tags": [], "signatures": [ { "code": "declare const DEFAULT_TIMELOCK_HOURS: 24;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 15, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "default_timelock_hours" }, { "name": "defaultContext", "declarationName": "defaultContext", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the default JSON-LD context array for OAS documents.", "tags": [ { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function defaultContext(): string[];", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 42, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "defaultcontext" }, { "name": "deriveChild", "declarationName": "deriveChild", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a child entity from a parent, producing a complete signed document.\n\nThis is the highest-level derivation API. It:\n1. Derives a child keypair via HKDF-SHA256\n2. Generates an AgentLineageProof2025\n3. Builds and signs a complete OAS Identity Document", "tags": [ { "name": "param", "text": "parentKeypair - Parent's keypair." }, { "name": "param", "text": "parentDoc - Parent's identity document." }, { "name": "param", "text": "childKind - Entity kind (e.g., \"agent\", \"tool\", \"ao\")." }, { "name": "param", "text": "childIdentifier - Unique identifier for the child." }, { "name": "param", "text": "derivationPath - HKDF derivation path." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "param", "text": "options - Additional options." }, { "name": "param", "text": "options.conformanceLevel - Conformance level (default: L1)." }, { "name": "param", "text": "options.name - Human-readable name." }, { "name": "param", "text": "options.description - Description." }, { "name": "param", "text": "options.lifecycleStatus - Lifecycle status." }, { "name": "returns", "text": "" }, { "name": "throws", "text": "{OasError}" }, { "name": "example", "text": "const child = await deriveChild(parentKeypair, parentDoc, \"agent\", \"bot\", \"/agent-bot\", \"2026-01-15T00:00:00Z\");\nconsole.log(child.document.lineage.generation); // 1" } ], "signatures": [ { "code": "declare function deriveChild(parentKeypair: import(\"../crypto/keypair.js\").OasKeyPair, parentDoc: import(\"../document/document.js\").OasDocument, childKind: string, childIdentifier: string, derivationPath: string, created: string, options?: { conformanceLevel?: string; name?: string; description?: string; lifecycleStatus?: string; }): Promise<{ document: import(\"../document/document.js\").OasDocument; keypair: import(\"../crypto/keypair.js\").OasKeyPair; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/lineage.js", "line": 37, "sha256": "60245bc794d02a6e384bb013b02fa4283b958662aa0a5104d62526c850dd0af7" } } ], "anchor": "derivechild" }, { "name": "deriveChildEntity", "declarationName": "deriveChildEntity", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a new child entity from a parent, producing a keypair and lineage.\n\nPerforms the complete child entity derivation workflow per OAS Spec §9:\n1. Derives a child Ed25519 keypair using HKDF-SHA256 (§9.3).\n2. Generates an AgentLineageProof2025 (§9.4).\n3. Constructs a complete LineageSection with the correct\n humanRootDid, creatorDid, generation, and humanRootChain.", "tags": [ { "name": "param", "text": "parentKeypair - The parent entity's keypair." }, { "name": "param", "text": "parentDoc - The parent entity's identity document." }, { "name": "param", "text": "childDid - The DID for the new child entity." }, { "name": "param", "text": "derivationPath - The HKDF derivation path (e.g., \"/agent-bot-42\")." }, { "name": "returns", "text": "The derived keypair and lineage section." }, { "name": "throws", "text": "{LineageError} If the parent is a non-root entity without lineage,\nor if key derivation or proof generation fails." }, { "name": "example", "text": "const root = await OasKeyPair.generate();\nconst rootDoc = await new DocumentBuilder(\"did:oas:test:hmr:alice\", \"hmr\")\n .addVerificationMethod(root)\n .buildAndSign(root, \"2026-01-15T00:00:00Z\");\nconst child = await deriveChildEntity(root, rootDoc, \"did:oas:test:agent:bot\", \"/agent-bot\");\nconsole.log(child.lineage.generation); // 1" } ], "signatures": [ { "code": "declare function deriveChildEntity(parentKeypair: import(\"../crypto/keypair.js\").OasKeyPair, parentDoc: import(\"../document/document.js\").OasDocument, childDid: string, derivationPath: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/derive.js", "line": 54, "sha256": "aed8b71a962b83636f0fadc166b145325391bf26407e0c81a92683a4876ce45d" } } ], "anchor": "derivechildentity" }, { "name": "deriveChildKeypair", "declarationName": "deriveChildKeypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a child Ed25519 keypair from a parent keypair using HKDF-SHA256.\n\nImplements the key derivation algorithm from OAS Specification §9.3.", "tags": [ { "name": "param", "text": "parent - The parent entity's keypair." }, { "name": "param", "text": "derivationPath - The derivation path string (e.g., \"/agent-analyst-42\")." }, { "name": "returns", "text": "A new keypair for the child entity." }, { "name": "throws", "text": "{CryptoError} If HKDF expansion fails." }, { "name": "example", "text": "const parent = await OasKeyPair.generate();\nconst child = await deriveChildKeypair(parent, \"/agent-child-1\");" } ], "signatures": [ { "code": "declare function deriveChildKeypair(parent: OasKeyPair, derivationPath: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/derivation.js", "line": 100, "sha256": "f3cdb2a383e9741408b88a6b4bee39e8119a4b2a679bb284cf94085470572d02" } } ], "anchor": "derivechildkeypair" }, { "name": "DerivedChild", "declarationName": "DerivedChild", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The result of deriving a child entity.\n\nContains the child's Ed25519 keypair and a complete LineageSection\nready to be included in the child's identity document.", "tags": [], "signatures": [ { "code": "declare class DerivedChild {\n constructor(keypair: OasKeyPair, lineage: LineageSection);\n keypair: OasKeyPair;\n lineage: LineageSection;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/derive.js", "line": 16, "sha256": "aed8b71a962b83636f0fadc166b145325391bf26407e0c81a92683a4876ce45d" } } ], "anchor": "derivedchild" }, { "name": "deriveKeyMaterial", "declarationName": "deriveKeyMaterial", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives raw 32-byte key material using HKDF-SHA256 via Web Crypto API.\n\nThis is the lower-level function that performs the actual HKDF computation.\nUse {@link deriveChildKeypair} for the full keypair derivation workflow.\n\nOAS Spec §9.3 -- Key Derivation", "tags": [ { "name": "param", "text": "ikm - Input key material (parent private key, 32 bytes)." }, { "name": "param", "text": "salt - Salt (parent public key, 32 bytes)." }, { "name": "param", "text": "info - Info string (derivation path as UTF-8)." }, { "name": "returns", "text": "32 bytes of derived key material." }, { "name": "throws", "text": "{CryptoError} If HKDF fails." }, { "name": "example", "text": "const okm = await deriveKeyMaterial(new Uint8Array(32), new Uint8Array(32), \"/test\");\nconsole.log(okm.length); // 32" } ], "signatures": [ { "code": "declare function deriveKeyMaterial(ikm: Uint8Array, salt: Uint8Array, info: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/derivation.js", "line": 50, "sha256": "f3cdb2a383e9741408b88a6b4bee39e8119a4b2a679bb284cf94085470572d02" } } ], "anchor": "derivekeymaterial" }, { "name": "DID_CONTEXT", "declarationName": "DID_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The W3C DID context URI.", "tags": [], "signatures": [ { "code": "declare const DID_CONTEXT: \"https://www.w3.org/ns/did/v1\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 30, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "did_context" }, { "name": "DidError", "declarationName": "DidError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error class for DID parsing and validation failures.\n\nEvery instance includes a `code` property from {@link DidErrorCode}\nand an actionable error message describing what went wrong.", "tags": [ { "name": "extends", "text": "Error" }, { "name": "example", "text": "try {\n OasDid.parse(\"\");\n} catch (e) {\n console.log(e.code); // \"EMPTY\"\n}" } ], "signatures": [ { "code": "declare class DidError {\n constructor(code: string, message: string);\n code: string;\n name: string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/errors.js", "line": 34, "sha256": "057de61ada8a4405604a3f2034010975303f9f1e403ebe8fda3d6bbe8d42d319" } } ], "anchor": "diderror" }, { "name": "DidErrorCode", "declarationName": "DidErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for DID parsing and validation failures.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const DidErrorCode: Readonly<{ EMPTY: \"EMPTY\"; INVALID_PREFIX: \"INVALID_PREFIX\"; TOO_FEW_COMPONENTS: \"TOO_FEW_COMPONENTS\"; INVALID_NAMESPACE: \"INVALID_NAMESPACE\"; UNKNOWN_ENTITY_KIND: \"UNKNOWN_ENTITY_KIND\"; INVALID_IDENTIFIER: \"INVALID_IDENTIFIER\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/errors.js", "line": 10, "sha256": "057de61ada8a4405604a3f2034010975303f9f1e403ebe8fda3d6bbe8d42d319" } } ], "anchor": "diderrorcode" }, { "name": "DOCUMENT_PROOF_TYPE", "declarationName": "DOCUMENT_PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The fixed proof type for OAS document proofs.", "tags": [], "signatures": [ { "code": "declare const DOCUMENT_PROOF_TYPE: \"Ed25519Signature2020\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/proof-format.js", "line": 13, "sha256": "b8699e5f3d350f368f40d08f20422de29201c3ce098b39ce7608da1cc1c31abd" } } ], "anchor": "document_proof_type" }, { "name": "DocumentBuilder", "declarationName": "DocumentBuilder", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Builder for constructing OasDocument instances.\n\nProvides an ergonomic API for building OAS Identity Documents\nwith proper defaults and validation.", "tags": [ { "name": "example", "text": "const keypair = await OasKeyPair.generate();\nconst doc = await new DocumentBuilder(\"did:oas:test:hmr:alice\", \"hmr\")\n .controller(\"did:oas:test:hmr:alice\")\n .conformanceLevel(ConformanceLevel.L1)\n .addVerificationMethod(keypair)\n .name(\"Alice\")\n .buildAndSign(keypair, \"2026-01-15T00:00:00Z\");" } ], "signatures": [ { "code": "declare class DocumentBuilder {\n constructor(id: string, kind: string);\n _id: string;\n _kind: string;\n _controller: string;\n _verificationMethods: VerificationMethod[];\n _authentication: string[];\n _assertionMethod: string[];\n _capabilityInvocation: string[];\n _capabilityDelegation: string[];\n _services: ServiceEndpoint[];\n _name: string;\n _description: string;\n _lineage: LineageSection;\n _conformanceLevel: string;\n _lifecycleStatus: string;\n _sequence: number;\n _profile: ProfileSection;\n _contact: ContactSection;\n _calendar: CalendarSection;\n _operational: OperationalSection;\n _pricing: PricingSection;\n _interoperability: InteroperabilitySection;\n _reputation: ReputationSection;\n _compliance: ComplianceSection;\n _relationships: RelationshipsSection;\n controller(controller: string): DocumentBuilder;\n addVerificationMethod(keypair: OasKeyPair): DocumentBuilder;\n conformanceLevel(level: string): DocumentBuilder;\n name(name: string): DocumentBuilder;\n description(description: string): DocumentBuilder;\n lineage(lineage: import(\"./lineage-section.js\").LineageSection): DocumentBuilder;\n lifecycleStatus(status: string): DocumentBuilder;\n sequence(seq: number): DocumentBuilder;\n addService(service: import(\"./service.js\").ServiceEndpoint): DocumentBuilder;\n profile(profile: import(\"./extensions.js\").ProfileSection): DocumentBuilder;\n contact(contact: import(\"./extensions.js\").ContactSection): DocumentBuilder;\n calendar(calendar: import(\"./extensions.js\").CalendarSection): DocumentBuilder;\n operational(operational: import(\"./extensions.js\").OperationalSection): DocumentBuilder;\n pricing(pricing: import(\"./extensions.js\").PricingSection): DocumentBuilder;\n interoperability(interop: import(\"./extensions.js\").InteroperabilitySection): DocumentBuilder;\n reputation(reputation: import(\"./extensions.js\").ReputationSection): DocumentBuilder;\n compliance(compliance: import(\"./extensions.js\").ComplianceSection): DocumentBuilder;\n relationships(relationships: import(\"./extensions.js\").RelationshipsSection): DocumentBuilder;\n buildAndSign(signingKeypair: OasKeyPair, created: string): Promise;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/builder.js", "line": 26, "sha256": "4cfb156c3593fcb63997eebce7607b62d3b5a173e90f87dec70d5d00dc1dfba3" } } ], "anchor": "documentbuilder" }, { "name": "DocumentError", "declarationName": "DocumentError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error class for OAS document operations.", "tags": [ { "name": "extends", "text": "Error" }, { "name": "example", "text": "const err = new DocumentError(DocumentErrorCode.PROOF_GENERATION_FAILED, \"signing failed\");\nconsole.log(err.code); // \"PROOF_GENERATION_FAILED\"" } ], "signatures": [ { "code": "declare class DocumentError {\n constructor(code: string, message: string);\n code: string;\n name: string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/errors.js", "line": 25, "sha256": "b58925fda4612956e46dd1969c826787a1c184439c95dc180f3d7c94ee16dda5" } } ], "anchor": "documenterror" }, { "name": "DocumentErrorCode", "declarationName": "DocumentErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS document operations.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const DocumentErrorCode: Readonly<{ PROOF_GENERATION_FAILED: \"PROOF_GENERATION_FAILED\"; PROOF_VERIFICATION_FAILED: \"PROOF_VERIFICATION_FAILED\"; MISSING_VERIFICATION_METHOD: \"MISSING_VERIFICATION_METHOD\"; INVALID_DOCUMENT: \"INVALID_DOCUMENT\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/errors.js", "line": 9, "sha256": "b58925fda4612956e46dd1969c826787a1c184439c95dc180f3d7c94ee16dda5" } } ], "anchor": "documenterrorcode" }, { "name": "DocumentProof", "declarationName": "DocumentProof", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519Signature2020 document proof.\n\nOAS Spec §5.5", "tags": [ { "name": "example", "text": "const proof = await DocumentProof.generate(docObj, keypair, \"did:oas:ns:hmr:a#key-1\", \"2026-01-15T00:00:00Z\");\nconsole.log(proof.type); // \"Ed25519Signature2020\"" } ], "signatures": [ { "code": "declare class DocumentProof {\n constructor(fields: { type: string; created: string; verificationMethod: string; proofPurpose: string; proofValue: string; });\n static generate(documentObj: object, keypair: OasKeyPair, verificationMethodId: string, created: string): Promise;\n static fromJSON(obj: object): DocumentProof;\n type: string;\n created: string;\n verificationMethod: string;\n proofPurpose: string;\n proofValue: string;\n verify(documentObj: object, publicKeyBytes: Uint8Array): Promise;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/proof-format.js", "line": 24, "sha256": "b8699e5f3d350f368f40d08f20422de29201c3ce098b39ce7608da1cc1c31abd" } } ], "anchor": "documentproof" }, { "name": "ED25519_CONTEXT", "declarationName": "ED25519_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The Ed25519 2020 suite context URI.", "tags": [], "signatures": [ { "code": "declare const ED25519_CONTEXT: \"https://w3id.org/security/suites/ed25519-2020/v1\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 33, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "ed25519_context" }, { "name": "ENR_GOVERNANCE_PROOF_TYPE", "declarationName": "ENR_GOVERNANCE_PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The canonical proof type string for ENR governance transitions.", "tags": [], "signatures": [ { "code": "declare const ENR_GOVERNANCE_PROOF_TYPE: \"EnrGovernanceTransitionProof2025\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 9, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "enr_governance_proof_type" }, { "name": "EntityKind", "declarationName": "EntityKind", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The 12 entity kinds defined in OAS Specification §4.\n\nEach kind represents a category of autonomous entity with distinct\nidentity requirements and lineage constraints.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "*" }, { "name": "example", "text": "import { EntityKind } from './kind.js';\nconsole.log(EntityKind.AGENT); // \"agent\"\nconsole.log(EntityKind.AGENT_INSTANCE); // \"agent:instance\"" } ], "signatures": [ { "code": "declare const EntityKind: Readonly<{ HMR: \"hmr\"; MHR: \"mhr\"; ENR: \"enr\"; AO: \"ao\"; AGENT: \"agent\"; AGENT_INSTANCE: \"agent:instance\"; TOOL: \"tool\"; SKILL: \"skill\"; WORKFLOW: \"workflow\"; MODEL: \"model\"; DATASET: \"dataset\"; SERVICE: \"service\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/kind.js", "line": 19, "sha256": "fae49ea352c5ec64169339c8ce5e508a272db570fa250a0aeeafa758cef5af98" } } ], "anchor": "entitykind" }, { "name": "FallbackResolver", "declarationName": "FallbackResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A fallback resolver that tries multiple resolvers in sequence.\n\nAttempts each resolver in order until one succeeds. If all fail,\nthrows the last error encountered.", "tags": [ { "name": "example", "text": "const resolver = new FallbackResolver([primaryResolver, secondaryResolver]);\nconst doc = await resolver.resolve(\"did:oas:test:hmr:alice\");" } ], "signatures": [ { "code": "declare class FallbackResolver {\n constructor(resolvers: { resolve: (did: string) => Promise; }[]);\n _resolvers: { resolve: (did: string) => Promise; }[];\n resolve(did: string): Promise;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/resolve/fallback.js", "line": 16, "sha256": "891b27319552f550c728a05c929c55a095c9e0b7b75483b576b4489d76ca250d" } } ], "anchor": "fallbackresolver" }, { "name": "governanceSectionFromJSON", "declarationName": "governanceSectionFromJSON", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parses a GovernanceSection from a plain object.", "tags": [ { "name": "param", "text": "obj - Plain object (e.g., parsed JSON)." }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function governanceSectionFromJSON(obj: object): GovernanceSection;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/governance.js", "line": 166, "sha256": "3eeba41687057aa764baef5020191f0bc9298930ee45567d0b6ada1d6e64b91a" } } ], "anchor": "governancesectionfromjson" }, { "name": "hexDecode", "declarationName": "hexDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a hex string to a Uint8Array.", "tags": [ { "name": "param", "text": "hex - The hex string (must have even length)." }, { "name": "returns", "text": "The decoded bytes." } ], "signatures": [ { "code": "declare function hexDecode(hex: string): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 292, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "hexdecode" }, { "name": "hexEncode", "declarationName": "hexEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes a Uint8Array as a hex string.", "tags": [ { "name": "param", "text": "bytes - The bytes to encode." }, { "name": "returns", "text": "Lowercase hex string." } ], "signatures": [ { "code": "declare function hexEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 278, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "hexencode" }, { "name": "InMemoryProvider", "declarationName": "InMemoryProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An in-memory document provider for testing and development.\n\nStores documents in a Map keyed by DID string.\nUseful for unit tests that need to verify lineage chains\nwithout network access.", "tags": [ { "name": "example", "text": "const provider = new InMemoryProvider();\nprovider.register(myDocument);\nconst doc = provider.resolve(\"did:oas:test:hmr:alice\");" } ], "signatures": [ { "code": "declare class InMemoryProvider {\n constructor();\n _documents: Map;\n register(doc: import(\"../document/document.js\").OasDocument): void;\n resolve(did: string): import(\"../document/document.js\").OasDocument;\n size: number;\n isEmpty: boolean;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/provider.js", "line": 23, "sha256": "f0c6ac48b3961e27af6f75a4ec24018da2e39b778f26046b1dd6e3458de79d53" } } ], "anchor": "inmemoryprovider" }, { "name": "InMemoryResolver", "declarationName": "InMemoryResolver", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An in-memory resolver for testing and development.\n\nStores documents in a Map keyed by DID string.", "tags": [ { "name": "example", "text": "const resolver = new InMemoryResolver();\nresolver.register(doc);\nconst resolved = await resolver.resolve(\"did:oas:test:hmr:alice\");" } ], "signatures": [ { "code": "declare class InMemoryResolver {\n constructor();\n _documents: Map;\n register(doc: import(\"../document/document.js\").OasDocument): void;\n resolve(did: string): Promise;\n size: number;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/resolve/memory.js", "line": 16, "sha256": "fd7563336e93de8ea426cdb185f25e19ab32d1dd7e5c56af21db3414a83da388" } } ], "anchor": "inmemoryresolver" }, { "name": "InteroperabilitySection", "declarationName": "InteroperabilitySection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Interoperability section.", "tags": [], "signatures": [ { "code": "declare class InteroperabilitySection {\n constructor(fields?: {});\n static fromJSON(obj: any): InteroperabilitySection;\n protocols: ProtocolSupport[];\n apiSchemas: ApiSchema[];\n authMethods: string[];\n toJSON(): { protocols: { protocol: string; }[]; apiSchemas: { schemaType: string; url: string; }[]; authMethods: string[]; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 393, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "interoperabilitysection" }, { "name": "isPublicVisibility", "declarationName": "isPublicVisibility", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the visibility level is public (stored on DHT).", "tags": [ { "name": "param", "text": "visibility - A Visibility value." }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function isPublicVisibility(visibility: string): boolean;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/visibility.js", "line": 29, "sha256": "66065d579bf9b8c6fd4fbb54cec2754732acae69c42e8a907b4007b7f6b37ca1" } } ], "anchor": "ispublicvisibility" }, { "name": "isRedactedOnDht", "declarationName": "isRedactedOnDht", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns `true` if the field should be redacted on the DHT.", "tags": [ { "name": "param", "text": "visibility - A Visibility value." }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function isRedactedOnDht(visibility: string): boolean;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/visibility.js", "line": 38, "sha256": "66065d579bf9b8c6fd4fbb54cec2754732acae69c42e8a907b4007b7f6b37ca1" } } ], "anchor": "isredactedondht" }, { "name": "isRoot", "declarationName": "isRoot", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns true if the given kind is a root entity (HMR, MHR, or ENR).\n\nRoot entities have no parent and no lineage section.", "tags": [ { "name": "param", "text": "kind - The entity kind string to check." }, { "name": "returns", "text": "True if the kind is HMR, MHR, or ENR." }, { "name": "example", "text": "isRoot(EntityKind.HMR); // true\nisRoot(EntityKind.ENR); // true\nisRoot(EntityKind.AGENT); // false" } ], "signatures": [ { "code": "declare function isRoot(kind: string): boolean;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/kind.js", "line": 62, "sha256": "fae49ea352c5ec64169339c8ce5e508a272db570fa250a0aeeafa758cef5af98" } } ], "anchor": "isroot" }, { "name": "LifecycleStatus", "declarationName": "LifecycleStatus", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OAS identity lifecycle statuses.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const LifecycleStatus: Readonly<{ NASCENT: \"nascent\"; ACTIVE: \"active\"; DORMANT: \"dormant\"; SUSPENDED: \"suspended\"; TERMINATED: \"terminated\"; ARCHIVED: \"archived\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/lifecycle.js", "line": 9, "sha256": "25281c8e8e3701b776b3c77139671da80f8d6b37400d0f4e3bc306e645820b6b" } } ], "anchor": "lifecyclestatus" }, { "name": "LineageError", "declarationName": "LineageError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error class for OAS lineage operations.", "tags": [ { "name": "extends", "text": "Error" } ], "signatures": [ { "code": "declare class LineageError {\n constructor(code: string, message: string);\n code: string;\n name: string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/errors.js", "line": 47, "sha256": "be59016ec728e3eee417a5590b537401d4dadd4fc1250d58184dff650b6c1999" } } ], "anchor": "lineageerror" }, { "name": "LineageErrorCode", "declarationName": "LineageErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS lineage operations.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const LineageErrorCode: Readonly<{ MISSING_LINEAGE: \"MISSING_LINEAGE\"; EMPTY_CHAIN: \"EMPTY_CHAIN\"; CHAIN_NOT_TERMINATING_AT_ROOT: \"CHAIN_NOT_TERMINATING_AT_ROOT\"; GENERATION_MISMATCH: \"GENERATION_MISMATCH\"; CHAIN_TOO_DEEP: \"CHAIN_TOO_DEEP\"; MISSING_DERIVATION_PROOF: \"MISSING_DERIVATION_PROOF\"; UNKNOWN_PROOF_TYPE: \"UNKNOWN_PROOF_TYPE\"; PROOF_PARENT_MISMATCH: \"PROOF_PARENT_MISMATCH\"; PROOF_CHILD_MISMATCH: \"PROOF_CHILD_MISMATCH\"; PROOF_SIGNATURE_INVALID: \"PROOF_SIGNATURE_INVALID\"; PARENT_REVOKED: \"PARENT_REVOKED\"; PARENT_KEY_NOT_FOUND: \"PARENT_KEY_NOT_FOUND\"; PARENT_SIGNATURE_INVALID: \"PARENT_SIGNATURE_INVALID\"; RESOLUTION_FAILED: \"RESOLUTION_FAILED\"; TOTAL_TIMEOUT: \"TOTAL_TIMEOUT\"; CRYPTO_ERROR: \"CRYPTO_ERROR\"; LEGACY_INSECURE_PROOF: \"LegacyInsecureProof\"; UNTRUSTED_ROOT: \"UntrustedRoot\"; PARENT_KEY_MISMATCH: \"ParentKeyMismatch\"; CHILD_KEY_MISMATCH: \"ChildKeyMismatch\"; PARENT_DOCUMENT_MISMATCH: \"ParentDocumentMismatch\"; INVALID_KEY_PURPOSE: \"InvalidKeyPurpose\"; CHAIN_CYCLE: \"ChainCycle\"; DOCUMENT_REVOKED: \"DocumentRevoked\"; DOCUMENT_INACTIVE: \"DocumentInactive\"; CHAIN_CONTINUITY: \"ChainContinuity\"; UNSUPPORTED_PROOF_ALGORITHM: \"UnsupportedProofAlgorithm\"; UNSUPPORTED_CANONICALIZATION: \"UnsupportedCanonicalization\"; UNSUPPORTED_PROOF_PURPOSE: \"UnsupportedProofPurpose\"; VERIFIER_TRUST_REQUIRED: \"VerifierTrustRequired\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/errors.js", "line": 9, "sha256": "be59016ec728e3eee417a5590b537401d4dadd4fc1250d58184dff650b6c1999" } } ], "anchor": "lineageerrorcode" }, { "name": "LineageSection", "declarationName": "LineageSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The lineage section of an OAS Identity Document.\n\nContains the cryptographic chain linking an entity to its human root.\nRequired for L1+ conformance on non-root entities.\n\nOAS Spec §8", "tags": [ { "name": "example", "text": "const lineage = new LineageSection({\n humanRootDid: \"did:oas:acme:hmr:alice\",\n creatorDid: \"did:oas:acme:hmr:alice\",\n generation: 1,\n derivationProof: proof,\n humanRootChain: [\"did:oas:acme:agent:bot\", \"did:oas:acme:hmr:alice\"],\n});" } ], "signatures": [ { "code": "declare class LineageSection {\n constructor(fields: { humanRootDid: string; creatorDid: string; generation: number; derivationProof?: AgentLineageProof | null; humanRootChain: string[]; });\n static fromJSON(obj: object): LineageSection;\n humanRootDid: string;\n creatorDid: string;\n generation: number;\n derivationProof: AgentLineageProof;\n humanRootChain: string[];\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/lineage-section.js", "line": 23, "sha256": "bbc10c307c43fba4571c3896ab726c4d2e95a9c172901722e8767e028aba857f" } } ], "anchor": "lineagesection" }, { "name": "multibaseDecode", "declarationName": "multibaseDecode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decodes a multibase base58btc string (with `z` prefix) into raw bytes.", "tags": [ { "name": "param", "text": "encoded - A multibase-encoded string that MUST start with `z`." }, { "name": "returns", "text": "The decoded raw bytes." }, { "name": "throws", "text": "{CryptoError} If the string does not start with `z` or decoding fails." }, { "name": "example", "text": "const encoded = multibaseEncode(new Uint8Array([1, 2, 3]));\nconst decoded = multibaseDecode(encoded); // Uint8Array [1, 2, 3]" } ], "signatures": [ { "code": "declare function multibaseDecode(encoded: string): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 154, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "multibasedecode" }, { "name": "multibaseEncode", "declarationName": "multibaseEncode", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Encodes bytes as multibase base58btc with the `z` prefix.\n\nThis is the canonical encoding for Ed25519 public keys in OAS Identity Documents\nand AgentLineageProof2025 structures (OAS Spec §11.1).", "tags": [ { "name": "param", "text": "bytes - The raw bytes to encode." }, { "name": "returns", "text": "A string with the `z` prefix followed by base58btc-encoded data." }, { "name": "example", "text": "multibaseEncode(new Uint8Array([1, 2, 3])); // \"zLdp\"" } ], "signatures": [ { "code": "declare function multibaseEncode(bytes: Uint8Array): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/encoding.js", "line": 139, "sha256": "549c525d4980e181adc392dc7660e6ffc38dd01abb527fc891d01d4325788ddc" } } ], "anchor": "multibaseencode" }, { "name": "OAS_CONTEXT", "declarationName": "OAS_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The OAS JSON-LD context URI.", "tags": [], "signatures": [ { "code": "declare const OAS_CONTEXT: \"https://openagent.id/ns/oas/v1\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 27, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oas_context" }, { "name": "OAS_VERSION", "declarationName": "OAS_VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The current OAS specification version.", "tags": [], "signatures": [ { "code": "declare const OAS_VERSION: \"1.0.0\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 36, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oas_version" }, { "name": "OasCredential", "declarationName": "OasCredential", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An OAS Verifiable Credential.\n\nImplements W3C Verifiable Credentials adapted for OAS entities,\nwith Ed25519Signature2020 proofs.", "tags": [ { "name": "example", "text": "const cred = OasCredential.build()\n .issuer(\"did:oas:test:hmr:alice\")\n .subject(\"did:oas:test:agent:bot\")\n .attestationType(\"LivenessAttestation\")\n .claim(\"status\", \"active\")\n .finalize();" } ], "signatures": [ { "code": "declare class OasCredential {\n constructor(fields: { context: string[]; id: string; type: string[]; issuer: string; issuanceDate: string; expirationDate?: string | null; credentialSubject: { id: string; claims: object; }; proof?: object | null; });\n static build(): CredentialBuilder;\n static fromJSON(obj: object): OasCredential;\n context: string[];\n id: string;\n type: string[];\n issuer: string;\n issuanceDate: string;\n expirationDate: string;\n credentialSubject: { id: string; claims: object; };\n proof: any;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/credential.js", "line": 28, "sha256": "2b2fc02307e36d3cd8c9f64d6aec4f58e7b9ec890f87bbee59ea10385f866639" } } ], "anchor": "oascredential" }, { "name": "OasDid", "declarationName": "OasDid", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A parsed and validated `did:oas` decentralized identifier.\n\nAn OasDid guarantees that the contained identifier conforms to the syntax\nrules in OAS Specification §3.1. It is the primary type for working with\nOAS identifiers throughout the SDK.\n\nFormat: `did:oas:::`\nFor compound kind `agent:instance`: `did:oas::agent:instance:`", "tags": [ { "name": "example", "text": "const did = OasDid.parse(\"did:oas:acme:agent:support-bot-42\");\nconsole.log(did.namespace); // \"acme\"\nconsole.log(did.kind); // \"agent\"\nconsole.log(did.identifier); // \"support-bot-42\"" } ], "signatures": [ { "code": "declare class OasDid {\n constructor(namespace: string, kind: string, identifier: string);\n static parse(input: string): OasDid;\n namespace: string;\n kind: string;\n identifier: string;\n isRoot: boolean;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/did.js", "line": 24, "sha256": "40361ef67339850f7a33907d77ca014f09f3dee623b0fa71011b37cd318d97db" } } ], "anchor": "oasdid" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An OAS Identity Document as defined in OAS Specification §5.\n\nThis is the canonical representation of an autonomous entity's identity,\nextending the W3C DID Document with OAS-specific properties.", "tags": [ { "name": "example", "text": "const doc = OasDocument.fromJSON({\n \"@context\": [\"https://www.w3.org/ns/did/v1\", \"https://w3id.org/security/suites/ed25519-2020/v1\", \"https://openagent.id/ns/oas/v1\"],\n id: \"did:oas:test:hmr:alice\",\n controller: \"did:oas:test:hmr:alice\",\n verificationMethod: [{ id: \"did:oas:test:hmr:alice#key-1\", type: \"Ed25519VerificationKey2020\", controller: \"did:oas:test:hmr:alice\", publicKeyMultibase: \"zTest\" }],\n authentication: [\"did:oas:test:hmr:alice#key-1\"],\n oasVersion: \"1.0.0\",\n kind: \"hmr\",\n conformanceLevel: \"L0\",\n sequence: 1,\n metadata: { created: \"2026-01-15T00:00:00Z\" },\n});" } ], "signatures": [ { "code": "declare class OasDocument {\n constructor(fields: { context: string[]; id: string; controller: string; verificationMethod: VerificationMethod[]; authentication: string[]; assertionMethod?: string[]; capabilityInvocation?: string[]; capabilityDelegation?: string[]; service?: ServiceEndpoint[]; oasVersion: string; kind: string; name?: string | null; description?: string | null; lineage?: LineageSection | null; conformanceLevel: string; lifecycleStatus?: string | null; sequence: number; metadata: { created: string; updated?: string | null; version?: string | null;}; proof?: DocumentProof | null; revoked?: boolean | null; revokedAt?: string | null; });\n static fromJSON(obj: object): OasDocument;\n context: string[];\n id: string;\n controller: string;\n verificationMethod: VerificationMethod[];\n authentication: string[];\n assertionMethod: string[];\n capabilityInvocation: string[];\n capabilityDelegation: string[];\n service: ServiceEndpoint[];\n oasVersion: string;\n kind: string;\n name: string;\n description: string;\n lineage: LineageSection;\n conformanceLevel: string;\n lifecycleStatus: string;\n sequence: number;\n metadata: { created: string; updated: string | null; version: string | null; };\n proof: DocumentProof;\n revoked: boolean;\n revokedAt: string;\n governance: GovernanceSection;\n profile: ProfileSection;\n contact: ContactSection;\n calendar: CalendarSection;\n operational: OperationalSection;\n pricing: PricingSection;\n interoperability: InteroperabilitySection;\n reputation: ReputationSection;\n compliance: ComplianceSection;\n relationships: RelationshipsSection;\n isRoot(): boolean;\n isRevoked(): boolean;\n canonicalDigest(): string;\n primaryPublicKeyMultibase(): string | null;\n findVerificationMethod(idOrFragment: string): VerificationMethod | null;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 66, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oasdocument" }, { "name": "OasError", "declarationName": "OasError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Top-level error class for the OAS SDK.", "tags": [ { "name": "extends", "text": "Error" } ], "signatures": [ { "code": "declare class OasError {\n constructor(code: string, message: string, cause: Error);\n code: string;\n name: string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/errors.js", "line": 21, "sha256": "f8ae832e6d69c0b5cff86dcf6ad687f39fc18a4ec40b85e7243c8dbcc03316ce" } } ], "anchor": "oaserror" }, { "name": "OasErrorCode", "declarationName": "OasErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for the OAS SDK.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const OasErrorCode: Readonly<{ DOCUMENT_ERROR: \"DOCUMENT_ERROR\"; CRYPTO_ERROR: \"CRYPTO_ERROR\"; LINEAGE_ERROR: \"LINEAGE_ERROR\"; RESOLVE_ERROR: \"RESOLVE_ERROR\"; ATTESTATION_ERROR: \"ATTESTATION_ERROR\"; DID_ERROR: \"DID_ERROR\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/errors.js", "line": 8, "sha256": "f8ae832e6d69c0b5cff86dcf6ad687f39fc18a4ec40b85e7243c8dbcc03316ce" } } ], "anchor": "oaserrorcode" }, { "name": "OasKeyPair", "declarationName": "OasKeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 keypair for an OAS entity.\n\nHolds both the signing (private) and verifying (public) keys.\nCustom toString/toJSON redact private key material.\n\nOAS Spec §11.2 -- All entity keys MUST be Ed25519", "tags": [ { "name": "example", "text": "const kp = await OasKeyPair.generate();\nconst sig = await kp.sign(new TextEncoder().encode(\"hello\"));\nconst ok = await OasKeyPair.verifyWithKey(kp.verifyingKeyBytes(), new TextEncoder().encode(\"hello\"), sig);\nconsole.log(ok); // undefined (no error = valid)" } ], "signatures": [ { "code": "declare class OasKeyPair {\n constructor(signingKey: Uint8Array, verifyingKey: Uint8Array);\n static generate(): Promise;\n static fromSigningKeyBytes(bytes: Uint8Array): Promise;\n static verifyWithKey(publicKeyBytes: Uint8Array, message: Uint8Array, signatureBytes: Uint8Array): Promise;\n _signingKey: Uint8Array;\n _verifyingKey: Uint8Array;\n sign(message: Uint8Array): Promise;\n signingKeyBytes(): Uint8Array;\n verifyingKeyBytes(): Uint8Array;\n publicKeyMultibase(): string;\n destroy(): void;\n toString(): string;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/keypair.js", "line": 361, "sha256": "eeb7c9aafc22a5f83e589c452e132859bd286027ac1c2cc89a5cdf36af537fdc" } } ], "anchor": "oaskeypair" }, { "name": "OASServiceType", "declarationName": "OASServiceType", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard OAS service type constants.", "tags": [], "signatures": [ { "code": "declare const OASServiceType: Readonly<{ ENTITY: \"OASEntity\"; COMMUNICATION: \"OASCommunication\"; LINEAGE_QUERY: \"OASLineageQuery\"; ATTESTATION: \"OASAttestationService\"; REVOCATION_STATUS: \"OASRevocationStatus\"; CAPABILITY_INVOCATION: \"OASCapabilityInvocation\"; GOVERNANCE: \"OASGovernance\"; PRIVATE_ENDPOINT: \"OASPrivateEndpointService\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/service.js", "line": 4, "sha256": "89898d17ed4fd480067697b229e2e4bc9c14183ed85e25fd0cdd0b716a2ecf63" } } ], "anchor": "oasservicetype" }, { "name": "OperationalSection", "declarationName": "OperationalSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Operational specification section.", "tags": [], "signatures": [ { "code": "declare class OperationalSection {\n constructor(fields?: {});\n static fromJSON(obj: any): OperationalSection;\n availability: string;\n sla: SlaCommitment[];\n rateLimits: RateLimit[];\n supportedInputFormats: string[];\n supportedOutputFormats: string[];\n maxPayloadBytes: number;\n maxContextTokens: number;\n maintenanceWindows: string[];\n toJSON(): { availability: string; sla: { metric: string; target: string; }[]; rateLimits: { endpoint: string; requests: number; window: string; }[]; supportedInputFormats: string[]; supportedOutputFormats: string[]; maxPayloadBytes: number; maxContextTokens: number; maintenanceWindows: string[]; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 239, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "operationalsection" }, { "name": "parseKind", "declarationName": "parseKind", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parses an entity kind string, throwing on unrecognized values.\n\nAccepts the canonical kind names as defined in OAS Spec §4.", "tags": [ { "name": "param", "text": "str - The kind string to parse." }, { "name": "returns", "text": "The validated entity kind value." }, { "name": "throws", "text": "{DidError} If the string is not a recognized entity kind." }, { "name": "example", "text": "parseKind(\"agent\"); // \"agent\"\nparseKind(\"agent:instance\"); // \"agent:instance\"\nparseKind(\"robot\"); // throws DidError" } ], "signatures": [ { "code": "declare function parseKind(str: string): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/kind.js", "line": 80, "sha256": "fae49ea352c5ec64169339c8ce5e508a272db570fa250a0aeeafa758cef5af98" } } ], "anchor": "parsekind" }, { "name": "parseLineageProofForMigration", "declarationName": "parseLineageProofForMigration", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns migration diagnostics without establishing authority.", "tags": [ { "name": "param", "text": "input" } ], "signatures": [ { "code": "declare function parseLineageProofForMigration(input: any): Readonly<{ proof: AgentLineageProof; profile: \"strict\"; authorizes: false; }> | Readonly<{ proof: AgentLineageProof; profile: \"legacy\"; authorizes: false; diagnosticCode: \"LegacyInsecureProof\"; }> | Readonly<{ diagnosticCode?: string; proof: AgentLineageProof; profile: \"unsupported\"; authorizes: false; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 267, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "parselineageproofformigration" }, { "name": "PricingSection", "declarationName": "PricingSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Pricing & economics section.", "tags": [], "signatures": [ { "code": "declare class PricingSection {\n constructor(fields?: {});\n static fromJSON(obj: any): PricingSection;\n model: string;\n costs: CostEntry[];\n currenciesAccepted: string[];\n billingEndpoint: string;\n freeTierLimits: string;\n billingVisibility: string;\n toJSON(): { model: string; costs: { description: string; amount: string; currency: string; }[]; currenciesAccepted: string[]; billingEndpoint: string; freeTierLimits: string; billingVisibility: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 309, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "pricingsection" }, { "name": "ProfileSection", "declarationName": "ProfileSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Profile / presentation data for an OAS entity.", "tags": [], "signatures": [ { "code": "declare class ProfileSection {\n constructor(fields?: {});\n static fromJSON(obj: any): ProfileSection;\n avatarUrl: string;\n bannerUrl: string;\n tagline: string;\n categories: string[];\n languages: string[];\n timezone: string;\n accentColor: string;\n toJSON(): { avatarUrl: string; bannerUrl: string; tagline: string; categories: string[]; languages: string[]; timezone: string; accentColor: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 9, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "profilesection" }, { "name": "PROOF_ALGORITHM", "declarationName": "PROOF_ALGORITHM", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_ALGORITHM: \"HKDF-SHA256-Ed25519\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 12, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_algorithm" }, { "name": "PROOF_CANONICALIZATION", "declarationName": "PROOF_CANONICALIZATION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_CANONICALIZATION: \"JCS-RFC8785\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 13, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_canonicalization" }, { "name": "PROOF_PURPOSE", "declarationName": "PROOF_PURPOSE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_PURPOSE: \"capabilityDelegation\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 14, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_purpose" }, { "name": "PROOF_TYPE", "declarationName": "PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_TYPE: \"AgentLineageProof2025\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 11, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_type" }, { "name": "ProtocolSupport", "declarationName": "ProtocolSupport", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A supported protocol declaration.", "tags": [], "signatures": [ { "code": "declare class ProtocolSupport {\n constructor(fields: any);\n static fromJSON(obj: any): ProtocolSupport;\n protocol: string;\n version: string;\n endpoint: string;\n toJSON(): { protocol: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 346, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "protocolsupport" }, { "name": "RateLimit", "declarationName": "RateLimit", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A rate limit specification.", "tags": [], "signatures": [ { "code": "declare class RateLimit {\n constructor(fields: any);\n static fromJSON(obj: any): RateLimit;\n endpoint: string;\n requests: number;\n window: string;\n toJSON(): { endpoint: string; requests: number; window: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 218, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "ratelimit" }, { "name": "RelationshipsSection", "declarationName": "RelationshipsSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Relationships & affiliations section.", "tags": [], "signatures": [ { "code": "declare class RelationshipsSection {\n constructor(fields?: {});\n static fromJSON(obj: any): RelationshipsSection;\n parentOrganization: string;\n affiliations: Affiliation[];\n blockedDids: string[];\n toJSON(): { parentOrganization: string; affiliations: { did: string; relationship: string; }[]; blockedDids: string[]; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 545, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "relationshipssection" }, { "name": "ReputationSection", "declarationName": "ReputationSection", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Reputation summary section.", "tags": [], "signatures": [ { "code": "declare class ReputationSection {\n constructor(fields?: {});\n static fromJSON(obj: any): ReputationSection;\n totalInteractions: number;\n endorsementCount: number;\n trustScore: string;\n uptime30d: string;\n uptime90d: string;\n firstActive: string;\n endorserDids: string[];\n toJSON(): { totalInteractions: number; endorsementCount: number; trustScore: string; uptime30d: string; uptime90d: string; firstActive: string; endorserDids: string[]; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 423, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "reputationsection" }, { "name": "RESERVED_NAMESPACES", "declarationName": "RESERVED_NAMESPACES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Reserved namespaces per OAS Spec §3.2.", "tags": [ { "name": "type", "text": "{ReadonlyArray}" } ], "signatures": [ { "code": "declare const RESERVED_NAMESPACES: readonly string[];", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/namespace.js", "line": 9, "sha256": "c74d90d3eb813fb4c695dc74885da402d120d8cea0e52dd97b3bb3e2c3e7ce31" } } ], "anchor": "reserved_namespaces" }, { "name": "ResolveError", "declarationName": "ResolveError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Error class for OAS resolution operations.", "tags": [ { "name": "extends", "text": "Error" } ], "signatures": [ { "code": "declare class ResolveError {\n constructor(code: string, message: string);\n code: string;\n name: string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/resolve/errors.js", "line": 18, "sha256": "3a9709eb21be2705bd8750fa8a056c5f2bba46e2d72be4745fd1a5b0e4ac18bc" } } ], "anchor": "resolveerror" }, { "name": "ResolveErrorCode", "declarationName": "ResolveErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Error codes for OAS resolution operations.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const ResolveErrorCode: Readonly<{ NOT_FOUND: \"NOT_FOUND\"; RESOLUTION_FAILED: \"RESOLUTION_FAILED\"; CACHE_ERROR: \"CACHE_ERROR\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/resolve/errors.js", "line": 8, "sha256": "3a9709eb21be2705bd8750fa8a056c5f2bba46e2d72be4745fd1a5b0e4ac18bc" } } ], "anchor": "resolveerrorcode" }, { "name": "ScheduleWindow", "declarationName": "ScheduleWindow", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A time window in an agent's schedule.", "tags": [], "signatures": [ { "code": "declare class ScheduleWindow {\n constructor(fields: any);\n static fromJSON(obj: any): ScheduleWindow;\n day: string;\n start: string;\n end: string;\n timezone: string;\n toJSON(): { day: string; start: string; end: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 105, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "schedulewindow" }, { "name": "ServiceEndpoint", "declarationName": "ServiceEndpoint", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A service endpoint in an OAS Identity Document.\n\nOAS Spec §5.2", "tags": [ { "name": "example", "text": "const svc = new ServiceEndpoint({\n id: \"did:oas:ns:agent:bot#mars\",\n type: \"MARSResolution\",\n serviceEndpoint: \"https://mars.example.com\",\n label: \"MARS Registry\",\n});" } ], "signatures": [ { "code": "declare class ServiceEndpoint {\n constructor(fields: { id: string; type: string; serviceEndpoint: string; label?: string | null; description?: string | null; properties?: { [x: string]: string;} | null; });\n static fromJSON(obj: object): ServiceEndpoint;\n id: string;\n type: string;\n serviceEndpoint: string;\n label: string;\n description: string;\n properties: { [x: string]: string; };\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/service.js", "line": 28, "sha256": "89898d17ed4fd480067697b229e2e4bc9c14183ed85e25fd0cdd0b716a2ecf63" } } ], "anchor": "serviceendpoint" }, { "name": "signCredential", "declarationName": "signCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Signs a credential with the given keypair.", "tags": [ { "name": "param", "text": "credential - The unsigned credential." }, { "name": "param", "text": "keypair - The issuer's keypair." }, { "name": "param", "text": "verificationMethodId - The verification method ID for the proof." }, { "name": "returns", "text": "The signed credential." }, { "name": "throws", "text": "{AttestationError} If signing fails." } ], "signatures": [ { "code": "declare function signCredential(credential: OasCredential, keypair: OasKeyPair, verificationMethodId: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/credential.js", "line": 232, "sha256": "2b2fc02307e36d3cd8c9f64d6aec4f58e7b9ec890f87bbee59ea10385f866639" } } ], "anchor": "signcredential" }, { "name": "SlaCommitment", "declarationName": "SlaCommitment", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An SLA commitment metric.", "tags": [], "signatures": [ { "code": "declare class SlaCommitment {\n constructor(fields: any);\n static fromJSON(obj: any): SlaCommitment;\n metric: string;\n target: string;\n period: string;\n toJSON(): { metric: string; target: string; };\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/extensions.js", "line": 195, "sha256": "e9edebf0e956da9e3a8a2940ed89c77fa378dee990c21aef20e4356f48b2d23b" } } ], "anchor": "slacommitment" }, { "name": "TrustAnchor", "declarationName": "TrustAnchor", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Verifier-controlled authentication policy for an accepted root DID.", "tags": [], "signatures": [ { "code": "declare class TrustAnchor {\n constructor(rootDid: string, verificationMethod: string, publicKeyMultibase: string);\n rootDid: string;\n verificationMethod: string;\n publicKeyMultibase: string;\n documentDigest: string;\n withDocumentDigest(digest: string): TrustAnchor;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/config.js", "line": 5, "sha256": "da90f6996d5a69a51ebd3073d0e3fb122bdbd6ad5007ec91941eb6e8546a92a6" } } ], "anchor": "trustanchor" }, { "name": "validateIdentifier", "declarationName": "validateIdentifier", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates an OAS identifier string.\n\nPer OAS Specification §3.1, an identifier:\n- MUST be 1-128 characters long\n- MUST contain only characters from the set [a-zA-Z0-9._-]", "tags": [ { "name": "param", "text": "identifier - The identifier string to validate." }, { "name": "returns", "text": "" }, { "name": "throws", "text": "{DidError} With code INVALID_IDENTIFIER if validation fails." }, { "name": "example", "text": "validateIdentifier(\"support-bot-42\"); // ok\nvalidateIdentifier(\"my.model_v2\"); // ok\nvalidateIdentifier(\"\"); // throws DidError" } ], "signatures": [ { "code": "declare function validateIdentifier(identifier: string): void;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/validation.js", "line": 27, "sha256": "908a76f95edd7f0280dabf67d0182750a7123a7b47947904de45d37583315efd" } } ], "anchor": "validateidentifier" }, { "name": "validateLineageProofSecurityProfile", "declarationName": "validateLineageProofSecurityProfile", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates strict suite values and mandatory signed bindings.", "tags": [ { "name": "param", "text": "proof" } ], "signatures": [ { "code": "declare function validateLineageProofSecurityProfile(proof: AgentLineageProof | Record): void;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 304, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "validatelineageproofsecurityprofile" }, { "name": "validateNamespace", "declarationName": "validateNamespace", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates an OAS namespace string.\n\nPer OAS Specification §3.1, a namespace:\n- MUST be 1-63 characters long\n- MUST contain only lowercase alphanumeric characters and hyphens\n- MUST NOT begin or end with a hyphen", "tags": [ { "name": "param", "text": "namespace - The namespace string to validate." }, { "name": "returns", "text": "" }, { "name": "throws", "text": "{DidError} With code INVALID_NAMESPACE if validation fails." }, { "name": "example", "text": "validateNamespace(\"acme\"); // ok\nvalidateNamespace(\"my-org-123\"); // ok\nvalidateNamespace(\"-starts-with-hyphen\"); // throws DidError" } ], "signatures": [ { "code": "declare function validateNamespace(namespace: string): void;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/namespace.js", "line": 28, "sha256": "c74d90d3eb813fb4c695dc74885da402d120d8cea0e52dd97b3bb3e2c3e7ce31" } } ], "anchor": "validatenamespace" }, { "name": "VerificationMethod", "declarationName": "VerificationMethod", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 verification method as defined in OAS Identity Documents.\n\nOAS Spec §5.1", "tags": [ { "name": "example", "text": "const vm = VerificationMethod.create(\"did:oas:acme:hmr:alice\", 1, \"z6Mktest123\");\nconsole.log(vm.keyId()); // \"key-1\"" } ], "signatures": [ { "code": "declare class VerificationMethod {\n constructor(fields: { id: string; type: string; controller: string; publicKeyMultibase: string; });\n static create(did: string, keyNum: number, publicKeyMultibase: string): VerificationMethod;\n static fromJSON(obj: object): VerificationMethod;\n id: string;\n type: string;\n controller: string;\n publicKeyMultibase: string;\n keyId(): string;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/verification-method.js", "line": 15, "sha256": "e159cc01dec57bcc38e4df161ae67b165f4f9dc8667a36fdee864d85227d305c" } } ], "anchor": "verificationmethod" }, { "name": "verifyChain", "declarationName": "verifyChain", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [ { "name": "param", "text": "requestOrArgs" } ], "signatures": [ { "code": "declare function verifyChain(request: any): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/lineage.js", "line": 101, "sha256": "60245bc794d02a6e384bb013b02fa4283b958662aa0a5104d62526c850dd0af7" } } ], "anchor": "verifychain" }, { "name": "VerifyConfig", "declarationName": "VerifyConfig", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Configuration for the lineage verification algorithm.\n\nAll values have sensible defaults from the OAS Specification §8.3.", "tags": [ { "name": "example", "text": "const config = new VerifyConfig();\nconsole.log(config.maxGeneration); // 16\n\n// Or customize\nconst custom = new VerifyConfig()\n .withMaxGeneration(8)\n .withVerifySignatures(false);" } ], "signatures": [ { "code": "declare class VerifyConfig {\n constructor();\n maxGeneration: number;\n perHopTimeoutMs: number;\n totalTimeoutMs: number;\n verifyDocumentSignatures: boolean;\n trustAnchors: Readonly[];\n withMaxGeneration(depth: number): VerifyConfig;\n withPerHopTimeout(ms: number): VerifyConfig;\n withTotalTimeout(ms: number): VerifyConfig;\n withVerifySignatures(verify: boolean): VerifyConfig;\n withTrustAnchor(anchor: TrustAnchor | { rootDid: string; verificationMethod: string; publicKeyMultibase: string; documentDigest?: string; }): VerifyConfig;\n withTrustAnchors(anchors: Array): VerifyConfig;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/config.js", "line": 39, "sha256": "da90f6996d5a69a51ebd3073d0e3fb122bdbd6ad5007ec91941eb6e8546a92a6" } } ], "anchor": "verifyconfig" }, { "name": "verifyCredential", "declarationName": "verifyCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a signed credential.", "tags": [ { "name": "param", "text": "credential - The signed credential." }, { "name": "param", "text": "publicKeyBytes - The issuer's 32-byte Ed25519 public key." }, { "name": "returns", "text": "" }, { "name": "throws", "text": "{AttestationError} If verification fails." } ], "signatures": [ { "code": "declare function verifyCredential(credential: OasCredential, publicKeyBytes: Uint8Array): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/credential.js", "line": 284, "sha256": "2b2fc02307e36d3cd8c9f64d6aec4f58e7b9ec890f87bbee59ea10385f866639" } } ], "anchor": "verifycredential" }, { "name": "verifyLineage", "declarationName": "verifyLineage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies lineage against authenticated parent documents and local root\ntrust policy. Embedded proof keys never establish authority.", "tags": [ { "name": "param", "text": "request" } ], "signatures": [ { "code": "declare function verifyLineage(request: VerifyLineageRequest): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/verify.js", "line": 59, "sha256": "9e8365fa5badb827f7d73e8b4a448e549cf3ca9fdc67e00cfd5fcf93aee7ffad" } } ], "anchor": "verifylineage" }, { "name": "VerifyResult", "declarationName": "VerifyResult", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Result of a successful strict lineage verification.", "tags": [], "signatures": [ { "code": "declare class VerifyResult {\n constructor(chainLength: any, humanRootDid: any, warnings?: any[]);\n chainLength: any;\n humanRootDid: any;\n warnings: readonly any[];\n isClean(): boolean;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/verify.js", "line": 14, "sha256": "9e8365fa5badb827f7d73e8b4a448e549cf3ca9fdc67e00cfd5fcf93aee7ffad" } } ], "anchor": "verifyresult" }, { "name": "Visibility", "declarationName": "Visibility", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Visibility levels for access-controlled fields in OAS Identity Documents.\n\nDID documents are stored on the public Weave DHT. Fields with a visibility\nother than `PUBLIC` are redacted in the DHT-stored copy; actual values are\nserved via an authenticated `OASPrivateEndpointService`.", "tags": [ { "name": "readonly", "text": "" }, { "name": "enum", "text": "" } ], "signatures": [ { "code": "declare const Visibility: Readonly<{ PUBLIC: \"public\"; AUTHENTICATED: \"authenticated\"; ORGANIZATION: \"organization\"; PRIVATE: \"private\"; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/visibility.js", "line": 13, "sha256": "66065d579bf9b8c6fd4fbb54cec2754732acae69c42e8a907b4007b7f6b37ca1" } } ], "anchor": "visibility" } ], "supportingDeclarations": [], "coverage": { "discovered": 111, "documented": 111, "missing": [] } }, { "subpath": "./did", "importSpecifier": "@openagentid/oas-vanilla/did", "page": "/reference/typescript/oas-vanilla/did", "kind": "javascript", "conditions": "./src/did/did.js", "paths": [ { "conditions": [], "path": "./src/did/did.js" } ], "exports": [ { "name": "OasDid", "declarationName": "OasDid", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "A parsed and validated `did:oas` decentralized identifier.\n\nAn OasDid guarantees that the contained identifier conforms to the syntax\nrules in OAS Specification §3.1. It is the primary type for working with\nOAS identifiers throughout the SDK.\n\nFormat: `did:oas:::`\nFor compound kind `agent:instance`: `did:oas::agent:instance:`", "tags": [ { "name": "example", "text": "const did = OasDid.parse(\"did:oas:acme:agent:support-bot-42\");\nconsole.log(did.namespace); // \"acme\"\nconsole.log(did.kind); // \"agent\"\nconsole.log(did.identifier); // \"support-bot-42\"" } ], "signatures": [ { "code": "declare class OasDid {\n constructor(namespace: string, kind: string, identifier: string);\n static parse(input: string): OasDid;\n namespace: string;\n kind: string;\n identifier: string;\n isRoot: boolean;\n toString(): string;\n toJSON(): string;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/did/did.js", "line": 24, "sha256": "40361ef67339850f7a33907d77ca014f09f3dee623b0fa71011b37cd318d97db" } } ], "anchor": "oasdid" } ], "supportingDeclarations": [], "coverage": { "discovered": 1, "documented": 1, "missing": [] } }, { "subpath": "./crypto", "importSpecifier": "@openagentid/oas-vanilla/crypto", "page": "/reference/typescript/oas-vanilla/crypto", "kind": "javascript", "conditions": "./src/crypto/keypair.js", "paths": [ { "conditions": [], "path": "./src/crypto/keypair.js" } ], "exports": [ { "name": "ExtendedPoint", "declarationName": "ExtendedPoint", "kind": "JSDocTypedefTag", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ExtendedPoint = { x: bigint; y: bigint; z: bigint; t: bigint; };", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/keypair.js", "line": 68, "sha256": "eeb7c9aafc22a5f83e589c452e132859bd286027ac1c2cc89a5cdf36af537fdc" } } ], "anchor": "extendedpoint" }, { "name": "OasKeyPair", "declarationName": "OasKeyPair", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An Ed25519 keypair for an OAS entity.\n\nHolds both the signing (private) and verifying (public) keys.\nCustom toString/toJSON redact private key material.\n\nOAS Spec §11.2 -- All entity keys MUST be Ed25519", "tags": [ { "name": "example", "text": "const kp = await OasKeyPair.generate();\nconst sig = await kp.sign(new TextEncoder().encode(\"hello\"));\nconst ok = await OasKeyPair.verifyWithKey(kp.verifyingKeyBytes(), new TextEncoder().encode(\"hello\"), sig);\nconsole.log(ok); // undefined (no error = valid)" } ], "signatures": [ { "code": "declare class OasKeyPair {\n constructor(signingKey: Uint8Array, verifyingKey: Uint8Array);\n static generate(): Promise;\n static fromSigningKeyBytes(bytes: Uint8Array): Promise;\n static verifyWithKey(publicKeyBytes: Uint8Array, message: Uint8Array, signatureBytes: Uint8Array): Promise;\n _signingKey: Uint8Array;\n _verifyingKey: Uint8Array;\n sign(message: Uint8Array): Promise;\n signingKeyBytes(): Uint8Array;\n verifyingKeyBytes(): Uint8Array;\n publicKeyMultibase(): string;\n destroy(): void;\n toString(): string;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/keypair.js", "line": 361, "sha256": "eeb7c9aafc22a5f83e589c452e132859bd286027ac1c2cc89a5cdf36af537fdc" } } ], "anchor": "oaskeypair" } ], "supportingDeclarations": [], "coverage": { "discovered": 2, "documented": 2, "missing": [] } }, { "subpath": "./crypto/proof", "importSpecifier": "@openagentid/oas-vanilla/crypto/proof", "page": "/reference/typescript/oas-vanilla/crypto/proof", "kind": "javascript", "conditions": "./src/crypto/proof.js", "paths": [ { "conditions": [], "path": "./src/crypto/proof.js" } ], "exports": [ { "name": "AgentLineageProof", "declarationName": "AgentLineageProof", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Agent lineage proof with migration-compatible optional security bindings.\n\nLegacy instances remain parseable, but every verification method rejects\nthem with `LegacyInsecureProof`.", "tags": [], "signatures": [ { "code": "declare class AgentLineageProof {\n constructor(fields: Record);\n static generate(parentKeypair: any, parentDid: any, childDid: any, derivationPath: any): Promise;\n static generateBound(parentKeypair: OasKeyPair, binding: { parentDid: string; childDid: string; derivationPath: string; verificationMethod: string; childVerificationMethod: string; childPublicKeyMultibase: string; parentDocumentDigest: string; parentDocumentSequence: number; generation: number; }): Promise;\n static fromJSON(input: any): AgentLineageProof;\n type: any;\n parentDid: any;\n childDid: any;\n derivationPath: any;\n algorithm: any;\n publicKeyMultibase: any;\n verificationMethod: any;\n proofPurpose: any;\n canonicalization: any;\n childVerificationMethod: any;\n childPublicKeyMultibase: any;\n parentDocumentDigest: any;\n parentDocumentSequence: any;\n generation: any;\n signature: any;\n verify(): Promise;\n verifyWithKey(trustedPublicKey: Uint8Array | string): Promise;\n toJSON(): Record;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 49, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "agentlineageproof" }, { "name": "canonicalProofPayload", "declarationName": "canonicalProofPayload", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Constructs exact RFC 8785 UTF-8 bytes for a strict proof.", "tags": [ { "name": "param", "text": "proof" }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function canonicalProofPayload(proof: AgentLineageProof | Record): Uint8Array;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 412, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "canonicalproofpayload" }, { "name": "parseLineageProofForMigration", "declarationName": "parseLineageProofForMigration", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns migration diagnostics without establishing authority.", "tags": [ { "name": "param", "text": "input" } ], "signatures": [ { "code": "declare function parseLineageProofForMigration(input: any): Readonly<{ proof: AgentLineageProof; profile: \"strict\"; authorizes: false; }> | Readonly<{ proof: AgentLineageProof; profile: \"legacy\"; authorizes: false; diagnosticCode: \"LegacyInsecureProof\"; }> | Readonly<{ diagnosticCode?: string; proof: AgentLineageProof; profile: \"unsupported\"; authorizes: false; }>;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 267, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "parselineageproofformigration" }, { "name": "PROOF_ALGORITHM", "declarationName": "PROOF_ALGORITHM", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_ALGORITHM: \"HKDF-SHA256-Ed25519\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 12, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_algorithm" }, { "name": "PROOF_CANONICALIZATION", "declarationName": "PROOF_CANONICALIZATION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_CANONICALIZATION: \"JCS-RFC8785\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 13, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_canonicalization" }, { "name": "PROOF_PURPOSE", "declarationName": "PROOF_PURPOSE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_PURPOSE: \"capabilityDelegation\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 14, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_purpose" }, { "name": "PROOF_TYPE", "declarationName": "PROOF_TYPE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const PROOF_TYPE: \"AgentLineageProof2025\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 11, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "proof_type" }, { "name": "validateLineageProofSecurityProfile", "declarationName": "validateLineageProofSecurityProfile", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validates strict suite values and mandatory signed bindings.", "tags": [ { "name": "param", "text": "proof" } ], "signatures": [ { "code": "declare function validateLineageProofSecurityProfile(proof: AgentLineageProof | Record): void;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/crypto/proof.js", "line": 304, "sha256": "d094b4bef5cc3a615c60a0ee756128963f973fbfcacc908171c371e7ed8dfa33" } } ], "anchor": "validatelineageproofsecurityprofile" } ], "supportingDeclarations": [], "coverage": { "discovered": 8, "documented": 8, "missing": [] } }, { "subpath": "./document", "importSpecifier": "@openagentid/oas-vanilla/document", "page": "/reference/typescript/oas-vanilla/document", "kind": "javascript", "conditions": "./src/document/document.js", "paths": [ { "conditions": [], "path": "./src/document/document.js" } ], "exports": [ { "name": "canonicalDocumentDigest", "declarationName": "canonicalDocumentDigest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Computes a Rust-compatible digest of an OAS document's JSON wire form.", "tags": [ { "name": "param", "text": "document" }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function canonicalDocumentDigest(document: OasDocument | object): string;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 339, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "canonicaldocumentdigest" }, { "name": "defaultContext", "declarationName": "defaultContext", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Returns the default JSON-LD context array for OAS documents.", "tags": [ { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function defaultContext(): string[];", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 42, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "defaultcontext" }, { "name": "DID_CONTEXT", "declarationName": "DID_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The W3C DID context URI.", "tags": [], "signatures": [ { "code": "declare const DID_CONTEXT: \"https://www.w3.org/ns/did/v1\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 30, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "did_context" }, { "name": "ED25519_CONTEXT", "declarationName": "ED25519_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The Ed25519 2020 suite context URI.", "tags": [], "signatures": [ { "code": "declare const ED25519_CONTEXT: \"https://w3id.org/security/suites/ed25519-2020/v1\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 33, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "ed25519_context" }, { "name": "OAS_CONTEXT", "declarationName": "OAS_CONTEXT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The OAS JSON-LD context URI.", "tags": [], "signatures": [ { "code": "declare const OAS_CONTEXT: \"https://openagent.id/ns/oas/v1\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 27, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oas_context" }, { "name": "OAS_VERSION", "declarationName": "OAS_VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The current OAS specification version.", "tags": [], "signatures": [ { "code": "declare const OAS_VERSION: \"1.0.0\";", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 36, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oas_version" }, { "name": "OasDocument", "declarationName": "OasDocument", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An OAS Identity Document as defined in OAS Specification §5.\n\nThis is the canonical representation of an autonomous entity's identity,\nextending the W3C DID Document with OAS-specific properties.", "tags": [ { "name": "example", "text": "const doc = OasDocument.fromJSON({\n \"@context\": [\"https://www.w3.org/ns/did/v1\", \"https://w3id.org/security/suites/ed25519-2020/v1\", \"https://openagent.id/ns/oas/v1\"],\n id: \"did:oas:test:hmr:alice\",\n controller: \"did:oas:test:hmr:alice\",\n verificationMethod: [{ id: \"did:oas:test:hmr:alice#key-1\", type: \"Ed25519VerificationKey2020\", controller: \"did:oas:test:hmr:alice\", publicKeyMultibase: \"zTest\" }],\n authentication: [\"did:oas:test:hmr:alice#key-1\"],\n oasVersion: \"1.0.0\",\n kind: \"hmr\",\n conformanceLevel: \"L0\",\n sequence: 1,\n metadata: { created: \"2026-01-15T00:00:00Z\" },\n});" } ], "signatures": [ { "code": "declare class OasDocument {\n constructor(fields: { context: string[]; id: string; controller: string; verificationMethod: VerificationMethod[]; authentication: string[]; assertionMethod?: string[]; capabilityInvocation?: string[]; capabilityDelegation?: string[]; service?: ServiceEndpoint[]; oasVersion: string; kind: string; name?: string | null; description?: string | null; lineage?: LineageSection | null; conformanceLevel: string; lifecycleStatus?: string | null; sequence: number; metadata: { created: string; updated?: string | null; version?: string | null;}; proof?: DocumentProof | null; revoked?: boolean | null; revokedAt?: string | null; });\n static fromJSON(obj: object): OasDocument;\n context: string[];\n id: string;\n controller: string;\n verificationMethod: VerificationMethod[];\n authentication: string[];\n assertionMethod: string[];\n capabilityInvocation: string[];\n capabilityDelegation: string[];\n service: ServiceEndpoint[];\n oasVersion: string;\n kind: string;\n name: string;\n description: string;\n lineage: LineageSection;\n conformanceLevel: string;\n lifecycleStatus: string;\n sequence: number;\n metadata: { created: string; updated: string | null; version: string | null; };\n proof: DocumentProof;\n revoked: boolean;\n revokedAt: string;\n governance: GovernanceSection;\n profile: ProfileSection;\n contact: ContactSection;\n calendar: CalendarSection;\n operational: OperationalSection;\n pricing: PricingSection;\n interoperability: InteroperabilitySection;\n reputation: ReputationSection;\n compliance: ComplianceSection;\n relationships: RelationshipsSection;\n isRoot(): boolean;\n isRevoked(): boolean;\n canonicalDigest(): string;\n primaryPublicKeyMultibase(): string | null;\n findVerificationMethod(idOrFragment: string): VerificationMethod | null;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 66, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oasdocument" } ], "supportingDeclarations": [], "coverage": { "discovered": 7, "documented": 7, "missing": [] } }, { "subpath": "./lineage", "importSpecifier": "@openagentid/oas-vanilla/lineage", "page": "/reference/typescript/oas-vanilla/lineage", "kind": "javascript", "conditions": "./src/lineage/derive.js", "paths": [ { "conditions": [], "path": "./src/lineage/derive.js" } ], "exports": [ { "name": "deriveChildEntity", "declarationName": "deriveChildEntity", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Derives a new child entity from a parent, producing a keypair and lineage.\n\nPerforms the complete child entity derivation workflow per OAS Spec §9:\n1. Derives a child Ed25519 keypair using HKDF-SHA256 (§9.3).\n2. Generates an AgentLineageProof2025 (§9.4).\n3. Constructs a complete LineageSection with the correct\n humanRootDid, creatorDid, generation, and humanRootChain.", "tags": [ { "name": "param", "text": "parentKeypair - The parent entity's keypair." }, { "name": "param", "text": "parentDoc - The parent entity's identity document." }, { "name": "param", "text": "childDid - The DID for the new child entity." }, { "name": "param", "text": "derivationPath - The HKDF derivation path (e.g., \"/agent-bot-42\")." }, { "name": "returns", "text": "The derived keypair and lineage section." }, { "name": "throws", "text": "{LineageError} If the parent is a non-root entity without lineage,\nor if key derivation or proof generation fails." }, { "name": "example", "text": "const root = await OasKeyPair.generate();\nconst rootDoc = await new DocumentBuilder(\"did:oas:test:hmr:alice\", \"hmr\")\n .addVerificationMethod(root)\n .buildAndSign(root, \"2026-01-15T00:00:00Z\");\nconst child = await deriveChildEntity(root, rootDoc, \"did:oas:test:agent:bot\", \"/agent-bot\");\nconsole.log(child.lineage.generation); // 1" } ], "signatures": [ { "code": "declare function deriveChildEntity(parentKeypair: import(\"../crypto/keypair.js\").OasKeyPair, parentDoc: import(\"../document/document.js\").OasDocument, childDid: string, derivationPath: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/derive.js", "line": 54, "sha256": "aed8b71a962b83636f0fadc166b145325391bf26407e0c81a92683a4876ce45d" } } ], "anchor": "derivechildentity" }, { "name": "DerivedChild", "declarationName": "DerivedChild", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The result of deriving a child entity.\n\nContains the child's Ed25519 keypair and a complete LineageSection\nready to be included in the child's identity document.", "tags": [], "signatures": [ { "code": "declare class DerivedChild {\n constructor(keypair: OasKeyPair, lineage: LineageSection);\n keypair: OasKeyPair;\n lineage: LineageSection;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/derive.js", "line": 16, "sha256": "aed8b71a962b83636f0fadc166b145325391bf26407e0c81a92683a4876ce45d" } } ], "anchor": "derivedchild" } ], "supportingDeclarations": [], "coverage": { "discovered": 2, "documented": 2, "missing": [] } }, { "subpath": "./lineage/verify", "importSpecifier": "@openagentid/oas-vanilla/lineage/verify", "page": "/reference/typescript/oas-vanilla/lineage/verify", "kind": "javascript", "conditions": "./src/lineage/verify.js", "paths": [ { "conditions": [], "path": "./src/lineage/verify.js" } ], "exports": [ { "name": "createVerifyLineageRequest", "declarationName": "createVerifyLineageRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Builds a frozen authorization request. Structural-only or migration results\ncannot be converted into this request shape.", "tags": [ { "name": "param", "text": "document" }, { "name": "param", "text": "provider" }, { "name": "param", "text": "options" }, { "name": "returns", "text": "" } ], "signatures": [ { "code": "declare function createVerifyLineageRequest(document: import(\"../document/document.js\").OasDocument, provider: any, options: VerifyConfig): Readonly;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/verify.js", "line": 43, "sha256": "9e8365fa5badb827f7d73e8b4a448e549cf3ca9fdc67e00cfd5fcf93aee7ffad" } } ], "anchor": "createverifylineagerequest" }, { "name": "verifyLineage", "declarationName": "verifyLineage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies lineage against authenticated parent documents and local root\ntrust policy. Embedded proof keys never establish authority.", "tags": [ { "name": "param", "text": "request" } ], "signatures": [ { "code": "declare function verifyLineage(request: VerifyLineageRequest): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/verify.js", "line": 59, "sha256": "9e8365fa5badb827f7d73e8b4a448e549cf3ca9fdc67e00cfd5fcf93aee7ffad" } } ], "anchor": "verifylineage" }, { "name": "VerifyLineageRequest", "declarationName": "VerifyLineageRequest", "kind": "JSDocTypedefTag", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerifyLineageRequest = { document: import(\"../document/document.js\").OasDocument; provider: any; options: VerifyConfig; };", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/verify.js", "line": 28, "sha256": "9e8365fa5badb827f7d73e8b4a448e549cf3ca9fdc67e00cfd5fcf93aee7ffad" } } ], "anchor": "verifylineagerequest" }, { "name": "VerifyResult", "declarationName": "VerifyResult", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Result of a successful strict lineage verification.", "tags": [], "signatures": [ { "code": "declare class VerifyResult {\n constructor(chainLength: any, humanRootDid: any, warnings?: any[]);\n chainLength: any;\n humanRootDid: any;\n warnings: readonly any[];\n isClean(): boolean;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/verify.js", "line": 14, "sha256": "9e8365fa5badb827f7d73e8b4a448e549cf3ca9fdc67e00cfd5fcf93aee7ffad" } } ], "anchor": "verifyresult" } ], "supportingDeclarations": [ { "name": "OasDocument", "declarationName": "OasDocument", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An OAS Identity Document as defined in OAS Specification §5.\n\nThis is the canonical representation of an autonomous entity's identity,\nextending the W3C DID Document with OAS-specific properties.", "tags": [ { "name": "example", "text": "const doc = OasDocument.fromJSON({\n \"@context\": [\"https://www.w3.org/ns/did/v1\", \"https://w3id.org/security/suites/ed25519-2020/v1\", \"https://openagent.id/ns/oas/v1\"],\n id: \"did:oas:test:hmr:alice\",\n controller: \"did:oas:test:hmr:alice\",\n verificationMethod: [{ id: \"did:oas:test:hmr:alice#key-1\", type: \"Ed25519VerificationKey2020\", controller: \"did:oas:test:hmr:alice\", publicKeyMultibase: \"zTest\" }],\n authentication: [\"did:oas:test:hmr:alice#key-1\"],\n oasVersion: \"1.0.0\",\n kind: \"hmr\",\n conformanceLevel: \"L0\",\n sequence: 1,\n metadata: { created: \"2026-01-15T00:00:00Z\" },\n});" } ], "signatures": [ { "code": "declare class OasDocument {\n constructor(fields: { context: string[]; id: string; controller: string; verificationMethod: VerificationMethod[]; authentication: string[]; assertionMethod?: string[]; capabilityInvocation?: string[]; capabilityDelegation?: string[]; service?: ServiceEndpoint[]; oasVersion: string; kind: string; name?: string | null; description?: string | null; lineage?: LineageSection | null; conformanceLevel: string; lifecycleStatus?: string | null; sequence: number; metadata: { created: string; updated?: string | null; version?: string | null;}; proof?: DocumentProof | null; revoked?: boolean | null; revokedAt?: string | null; });\n static fromJSON(obj: object): OasDocument;\n context: string[];\n id: string;\n controller: string;\n verificationMethod: VerificationMethod[];\n authentication: string[];\n assertionMethod: string[];\n capabilityInvocation: string[];\n capabilityDelegation: string[];\n service: ServiceEndpoint[];\n oasVersion: string;\n kind: string;\n name: string;\n description: string;\n lineage: LineageSection;\n conformanceLevel: string;\n lifecycleStatus: string;\n sequence: number;\n metadata: { created: string; updated: string | null; version: string | null; };\n proof: DocumentProof;\n revoked: boolean;\n revokedAt: string;\n governance: GovernanceSection;\n profile: ProfileSection;\n contact: ContactSection;\n calendar: CalendarSection;\n operational: OperationalSection;\n pricing: PricingSection;\n interoperability: InteroperabilitySection;\n reputation: ReputationSection;\n compliance: ComplianceSection;\n relationships: RelationshipsSection;\n isRoot(): boolean;\n isRevoked(): boolean;\n canonicalDigest(): string;\n primaryPublicKeyMultibase(): string | null;\n findVerificationMethod(idOrFragment: string): VerificationMethod | null;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 66, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oasdocument" }, { "name": "VerifyConfig", "declarationName": "VerifyConfig", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Configuration for the lineage verification algorithm.\n\nAll values have sensible defaults from the OAS Specification §8.3.", "tags": [ { "name": "example", "text": "const config = new VerifyConfig();\nconsole.log(config.maxGeneration); // 16\n\n// Or customize\nconst custom = new VerifyConfig()\n .withMaxGeneration(8)\n .withVerifySignatures(false);" } ], "signatures": [ { "code": "declare class VerifyConfig {\n constructor();\n maxGeneration: number;\n perHopTimeoutMs: number;\n totalTimeoutMs: number;\n verifyDocumentSignatures: boolean;\n trustAnchors: Readonly[];\n withMaxGeneration(depth: number): VerifyConfig;\n withPerHopTimeout(ms: number): VerifyConfig;\n withTotalTimeout(ms: number): VerifyConfig;\n withVerifySignatures(verify: boolean): VerifyConfig;\n withTrustAnchor(anchor: TrustAnchor | { rootDid: string; verificationMethod: string; publicKeyMultibase: string; documentDigest?: string; }): VerifyConfig;\n withTrustAnchors(anchors: Array): VerifyConfig;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/config.js", "line": 39, "sha256": "da90f6996d5a69a51ebd3073d0e3fb122bdbd6ad5007ec91941eb6e8546a92a6" } } ], "anchor": "verifyconfig" } ], "coverage": { "discovered": 4, "documented": 4, "missing": [] } }, { "subpath": "./lineage/config", "importSpecifier": "@openagentid/oas-vanilla/lineage/config", "page": "/reference/typescript/oas-vanilla/lineage/config", "kind": "javascript", "conditions": "./src/lineage/config.js", "paths": [ { "conditions": [], "path": "./src/lineage/config.js" } ], "exports": [ { "name": "TrustAnchor", "declarationName": "TrustAnchor", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Verifier-controlled authentication policy for an accepted root DID.", "tags": [], "signatures": [ { "code": "declare class TrustAnchor {\n constructor(rootDid: string, verificationMethod: string, publicKeyMultibase: string);\n rootDid: string;\n verificationMethod: string;\n publicKeyMultibase: string;\n documentDigest: string;\n withDocumentDigest(digest: string): TrustAnchor;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/config.js", "line": 5, "sha256": "da90f6996d5a69a51ebd3073d0e3fb122bdbd6ad5007ec91941eb6e8546a92a6" } } ], "anchor": "trustanchor" }, { "name": "VerifyConfig", "declarationName": "VerifyConfig", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Configuration for the lineage verification algorithm.\n\nAll values have sensible defaults from the OAS Specification §8.3.", "tags": [ { "name": "example", "text": "const config = new VerifyConfig();\nconsole.log(config.maxGeneration); // 16\n\n// Or customize\nconst custom = new VerifyConfig()\n .withMaxGeneration(8)\n .withVerifySignatures(false);" } ], "signatures": [ { "code": "declare class VerifyConfig {\n constructor();\n maxGeneration: number;\n perHopTimeoutMs: number;\n totalTimeoutMs: number;\n verifyDocumentSignatures: boolean;\n trustAnchors: Readonly[];\n withMaxGeneration(depth: number): VerifyConfig;\n withPerHopTimeout(ms: number): VerifyConfig;\n withTotalTimeout(ms: number): VerifyConfig;\n withVerifySignatures(verify: boolean): VerifyConfig;\n withTrustAnchor(anchor: TrustAnchor | { rootDid: string; verificationMethod: string; publicKeyMultibase: string; documentDigest?: string; }): VerifyConfig;\n withTrustAnchors(anchors: Array): VerifyConfig;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/lineage/config.js", "line": 39, "sha256": "da90f6996d5a69a51ebd3073d0e3fb122bdbd6ad5007ec91941eb6e8546a92a6" } } ], "anchor": "verifyconfig" } ], "supportingDeclarations": [], "coverage": { "discovered": 2, "documented": 2, "missing": [] } }, { "subpath": "./resolve", "importSpecifier": "@openagentid/oas-vanilla/resolve", "page": "/reference/typescript/oas-vanilla/resolve", "kind": "javascript", "conditions": "./src/resolve/resolver.js", "paths": [ { "conditions": [], "path": "./src/resolve/resolver.js" } ], "exports": [ { "name": "Resolver", "declarationName": "Resolver", "kind": "JSDocTypedefTag", "typeOnly": true, "documentation": "A resolver that resolves did:oas identifiers to OasDocuments.\n\nThis is the abstract interface. Implementations provide actual\nresolution logic (in-memory, HTTP, DHT, etc.).", "tags": [], "signatures": [ { "code": "type Resolver = { resolve: (did: string) => Promise; };", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/resolve/resolver.js", "line": 10, "sha256": "0d96075f46bf060fb612963cd993344258757bbbee89b479bb3f1ea750f068a5" } } ], "anchor": "resolver" } ], "supportingDeclarations": [ { "name": "OasDocument", "declarationName": "OasDocument", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An OAS Identity Document as defined in OAS Specification §5.\n\nThis is the canonical representation of an autonomous entity's identity,\nextending the W3C DID Document with OAS-specific properties.", "tags": [ { "name": "example", "text": "const doc = OasDocument.fromJSON({\n \"@context\": [\"https://www.w3.org/ns/did/v1\", \"https://w3id.org/security/suites/ed25519-2020/v1\", \"https://openagent.id/ns/oas/v1\"],\n id: \"did:oas:test:hmr:alice\",\n controller: \"did:oas:test:hmr:alice\",\n verificationMethod: [{ id: \"did:oas:test:hmr:alice#key-1\", type: \"Ed25519VerificationKey2020\", controller: \"did:oas:test:hmr:alice\", publicKeyMultibase: \"zTest\" }],\n authentication: [\"did:oas:test:hmr:alice#key-1\"],\n oasVersion: \"1.0.0\",\n kind: \"hmr\",\n conformanceLevel: \"L0\",\n sequence: 1,\n metadata: { created: \"2026-01-15T00:00:00Z\" },\n});" } ], "signatures": [ { "code": "declare class OasDocument {\n constructor(fields: { context: string[]; id: string; controller: string; verificationMethod: VerificationMethod[]; authentication: string[]; assertionMethod?: string[]; capabilityInvocation?: string[]; capabilityDelegation?: string[]; service?: ServiceEndpoint[]; oasVersion: string; kind: string; name?: string | null; description?: string | null; lineage?: LineageSection | null; conformanceLevel: string; lifecycleStatus?: string | null; sequence: number; metadata: { created: string; updated?: string | null; version?: string | null;}; proof?: DocumentProof | null; revoked?: boolean | null; revokedAt?: string | null; });\n static fromJSON(obj: object): OasDocument;\n context: string[];\n id: string;\n controller: string;\n verificationMethod: VerificationMethod[];\n authentication: string[];\n assertionMethod: string[];\n capabilityInvocation: string[];\n capabilityDelegation: string[];\n service: ServiceEndpoint[];\n oasVersion: string;\n kind: string;\n name: string;\n description: string;\n lineage: LineageSection;\n conformanceLevel: string;\n lifecycleStatus: string;\n sequence: number;\n metadata: { created: string; updated: string | null; version: string | null; };\n proof: DocumentProof;\n revoked: boolean;\n revokedAt: string;\n governance: GovernanceSection;\n profile: ProfileSection;\n contact: ContactSection;\n calendar: CalendarSection;\n operational: OperationalSection;\n pricing: PricingSection;\n interoperability: InteroperabilitySection;\n reputation: ReputationSection;\n compliance: ComplianceSection;\n relationships: RelationshipsSection;\n isRoot(): boolean;\n isRevoked(): boolean;\n canonicalDigest(): string;\n primaryPublicKeyMultibase(): string | null;\n findVerificationMethod(idOrFragment: string): VerificationMethod | null;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/document/document.js", "line": 66, "sha256": "f0da705b906fb4833e321600af9ebbf62fc97984478f2b9e5acb3902a57ece99" } } ], "anchor": "oasdocument" } ], "coverage": { "discovered": 1, "documented": 1, "missing": [] } }, { "subpath": "./attestation", "importSpecifier": "@openagentid/oas-vanilla/attestation", "page": "/reference/typescript/oas-vanilla/attestation", "kind": "javascript", "conditions": "./src/attestation/credential.js", "paths": [ { "conditions": [], "path": "./src/attestation/credential.js" } ], "exports": [ { "name": "OasCredential", "declarationName": "OasCredential", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "An OAS Verifiable Credential.\n\nImplements W3C Verifiable Credentials adapted for OAS entities,\nwith Ed25519Signature2020 proofs.", "tags": [ { "name": "example", "text": "const cred = OasCredential.build()\n .issuer(\"did:oas:test:hmr:alice\")\n .subject(\"did:oas:test:agent:bot\")\n .attestationType(\"LivenessAttestation\")\n .claim(\"status\", \"active\")\n .finalize();" } ], "signatures": [ { "code": "declare class OasCredential {\n constructor(fields: { context: string[]; id: string; type: string[]; issuer: string; issuanceDate: string; expirationDate?: string | null; credentialSubject: { id: string; claims: object; }; proof?: object | null; });\n static build(): CredentialBuilder;\n static fromJSON(obj: object): OasCredential;\n context: string[];\n id: string;\n type: string[];\n issuer: string;\n issuanceDate: string;\n expirationDate: string;\n credentialSubject: { id: string; claims: object; };\n proof: any;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/credential.js", "line": 28, "sha256": "2b2fc02307e36d3cd8c9f64d6aec4f58e7b9ec890f87bbee59ea10385f866639" } } ], "anchor": "oascredential" }, { "name": "signCredential", "declarationName": "signCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Signs a credential with the given keypair.", "tags": [ { "name": "param", "text": "credential - The unsigned credential." }, { "name": "param", "text": "keypair - The issuer's keypair." }, { "name": "param", "text": "verificationMethodId - The verification method ID for the proof." }, { "name": "returns", "text": "The signed credential." }, { "name": "throws", "text": "{AttestationError} If signing fails." } ], "signatures": [ { "code": "declare function signCredential(credential: OasCredential, keypair: OasKeyPair, verificationMethodId: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/credential.js", "line": 232, "sha256": "2b2fc02307e36d3cd8c9f64d6aec4f58e7b9ec890f87bbee59ea10385f866639" } } ], "anchor": "signcredential" }, { "name": "verifyCredential", "declarationName": "verifyCredential", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Verifies a signed credential.", "tags": [ { "name": "param", "text": "credential - The signed credential." }, { "name": "param", "text": "publicKeyBytes - The issuer's 32-byte Ed25519 public key." }, { "name": "returns", "text": "" }, { "name": "throws", "text": "{AttestationError} If verification fails." } ], "signatures": [ { "code": "declare function verifyCredential(credential: OasCredential, publicKeyBytes: Uint8Array): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/attestation/credential.js", "line": 284, "sha256": "2b2fc02307e36d3cd8c9f64d6aec4f58e7b9ec890f87bbee59ea10385f866639" } } ], "anchor": "verifycredential" } ], "supportingDeclarations": [], "coverage": { "discovered": 3, "documented": 3, "missing": [] } }, { "subpath": "./sdk", "importSpecifier": "@openagentid/oas-vanilla/sdk", "page": "/reference/typescript/oas-vanilla/sdk", "kind": "javascript", "conditions": "./src/sdk/identity.js", "paths": [ { "conditions": [], "path": "./src/sdk/identity.js" } ], "exports": [ { "name": "CreatedIdentity", "declarationName": "CreatedIdentity", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "The result of creating a new root identity.\n\nContains the signed identity document and the keypair used to sign it.\nThe caller is responsible for securely storing the keypair.", "tags": [], "signatures": [ { "code": "declare class CreatedIdentity {\n constructor(document: OasDocument, keypair: OasKeyPair);\n document: OasDocument;\n keypair: OasKeyPair;\n toString(): string;\n toJSON(): object;\n}", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 15, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createdidentity" }, { "name": "createHmr", "declarationName": "createHmr", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new Human Root (HMR) identity.\n\nGenerates a fresh Ed25519 keypair, constructs an OAS Identity Document\nfor a did:oas::hmr: DID, and signs it.", "tags": [ { "name": "param", "text": "namespace - The OAS namespace (e.g., \"l1fe\", \"test\")." }, { "name": "param", "text": "identifier - The unique identifier within the namespace." }, { "name": "param", "text": "created - ISO 8601 timestamp for the document metadata." }, { "name": "returns", "text": "The signed document and keypair." }, { "name": "throws", "text": "{OasError} If DID construction or document building fails." }, { "name": "example", "text": "const identity = await createHmr(\"test\", \"alice\", \"2026-01-15T00:00:00Z\");\nconsole.log(identity.document.id); // \"did:oas:test:hmr:alice\"" } ], "signatures": [ { "code": "declare function createHmr(namespace: string, identifier: string, created: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 63, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createhmr" }, { "name": "createMhr", "declarationName": "createMhr", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new Multi-Human Root (MHR) identity.\n\nSimilar to createHmr but for machine-originated root entities.", "tags": [ { "name": "param", "text": "namespace - The OAS namespace." }, { "name": "param", "text": "identifier - The unique identifier." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "The signed document and keypair." }, { "name": "throws", "text": "{OasError}" }, { "name": "example", "text": "const identity = await createMhr(\"test\", \"system1\", \"2026-01-15T00:00:00Z\");\nconsole.log(identity.document.id); // \"did:oas:test:mhr:system1\"" } ], "signatures": [ { "code": "declare function createMhr(namespace: string, identifier: string, created: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 99, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createmhr" }, { "name": "createRootWithKeypair", "declarationName": "createRootWithKeypair", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Creates a new root identity with a pre-existing keypair.", "tags": [ { "name": "param", "text": "namespace - The OAS namespace." }, { "name": "param", "text": "kind - The entity kind (\"hmr\" or \"mhr\")." }, { "name": "param", "text": "identifier - The unique identifier." }, { "name": "param", "text": "keypair - The Ed25519 keypair to use." }, { "name": "param", "text": "created - ISO 8601 timestamp." }, { "name": "returns", "text": "The signed document." }, { "name": "throws", "text": "{OasError}" }, { "name": "example", "text": "const keypair = await OasKeyPair.generate();\nconst doc = await createRootWithKeypair(\"test\", \"hmr\", \"alice\", keypair, \"2026-01-15T00:00:00Z\");" } ], "signatures": [ { "code": "declare function createRootWithKeypair(namespace: string, kind: string, identifier: string, keypair: OasKeyPair, created: string): Promise;", "source": { "package": "@openagentid/oas-vanilla", "version": "1.0.2", "file": "src/sdk/identity.js", "line": 135, "sha256": "7698199c0abe77f1d91b09a02cc3919837f5b12f457fe578677381f78d89ccc4" } } ], "anchor": "createrootwithkeypair" } ], "supportingDeclarations": [], "coverage": { "discovered": 4, "documented": 4, "missing": [] } } ] }, { "name": "@openagentid/oidc", "version": "0.2.0", "status": "current", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/oidc/-/oidc-0.2.0.tgz", "integrity": "sha512-STeQ3hQ62m52e7uYNuyiDlO7f+MWdLekhZ8G9Yq0Dk6GcFYKBi6Bjwd1BJoKqg1FtJqm5ie3X2Ks7pbFMxTK0w==", "packageJsonSha256": "c3827855cf79be705cbe7f7ac252cea3ab531455a422d85e8ef31ddf8c5c8cb6", "page": "/reference/typescript/oidc", "engines": { "node": ">=20.19.0" }, "dependencies": { "jose": "^5.10.0", "zod": "^3.23.8", "oidc-provider": "9.12.2", "@types/oidc-provider": "9.12.1" }, "peerDependencies": { "@openagentid/arsenal-sdk": "^0.1.0", "@openagentid/oas-sdk": "^1.0.2" }, "peerDependenciesMeta": { "@openagentid/oas-sdk": { "optional": true }, "@openagentid/arsenal-sdk": { "optional": true } }, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/oidc", "page": "/reference/typescript/oidc", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" }, { "conditions": [ "require" ], "path": "./dist/index.cjs" } ], "exports": [ { "name": "ActJwtClaims", "declarationName": "ActJwtClaims", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Claims for an outbound JWT wrapping an Arsenal ACT (Flow 2).", "tags": [], "signatures": [ { "code": "interface ActJwtClaims {\n readonly sub: string;\n readonly iss: string;\n readonly aud?: string;\n readonly exp: number;\n readonly iat: number;\n readonly jti: string;\n readonly scope: string;\n readonly lineage_depth: number;\n readonly parent_hmr: string;\n readonly act: string;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 244, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "actjwtclaims" }, { "name": "AgentIdentityProof", "declarationName": "AgentIdentityProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentIdentityProof {\n readonly token: string;\n readonly delegations: readonly string[];\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 562, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "agentidentityproof" }, { "name": "AgentIdentityRoot", "declarationName": "AgentIdentityRoot", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentIdentityRoot = LifeIdAgentRoot | SelfAgentRoot;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 581, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "agentidentityroot" }, { "name": "AgentInteraction", "declarationName": "AgentInteraction", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentInteraction {\n readonly nonce: string;\n readonly audience: string;\n readonly clientId: string;\n readonly scopes: readonly string[];\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 641, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "agentinteraction" }, { "name": "AgentOidcProvider", "declarationName": "AgentOidcProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Complete OIDC code-flow provider with a mandatory verified agent login boundary.", "tags": [], "signatures": [ { "code": "declare class AgentOidcProvider {\n readonly provider: Provider;\n static create(options: AgentOidcProviderOptions): Promise;\n callback(): ReturnType;\n interaction(req: IncomingMessage, res: ServerResponse): Promise;\n completeInteraction(req: IncomingMessage, res: ServerResponse, input: {\n proof: AgentIdentityProof;\n consent: true;\n lifeIdToken?: string;\n }): Promise;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 648, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "agentoidcprovider" }, { "name": "AgentOidcProviderOptions", "declarationName": "AgentOidcProviderOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentOidcProviderOptions {\n readonly issuer: string;\n readonly clients: readonly ClientMetadata[];\n readonly jwks: {\n readonly keys: readonly JWK[];\n };\n readonly cookieKeys: readonly string[];\n readonly adapter: AdapterConstructor;\n readonly persistent: boolean;\n readonly mode?: 'production' | 'test';\n readonly trustProxy?: boolean;\n readonly tokenTtlSeconds?: number;\n readonly verifyAgent: (proof: AgentIdentityProof, context: VerifyAgentContext) => Promise;\n readonly resolveIdentity: (did: string) => Promise;\n readonly lifeId?: LifeIdFederationOptions;\n readonly requireLifeId?: boolean;\n readonly allowSelfRooted?: boolean;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 617, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "agentoidcprovideroptions" }, { "name": "AgentOwner", "declarationName": "AgentOwner", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Structural contract shared with the SDK's IdentityVerifier.", "tags": [], "signatures": [ { "code": "interface AgentOwner {\n readonly issuer: string;\n readonly subject: string;\n readonly organizationId?: string;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 557, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "agentowner" }, { "name": "BridgeIdentityHooks", "declarationName": "BridgeIdentityHooks", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The OIDC bridge -- maps between human OIDC tokens and OAS agent identities.", "tags": [ { "name": "example", "text": "```ts\nimport { OidcBridge } from '@openagentid/oidc';\n\nconst bridge = new OidcBridge({\n issuer: 'https://dev-123.okta.com/oauth2/default',\n audience: 'my-app',\n});\n\n// Flow 1: Human JWT -> Agent DID\nconst agent = await bridge.deriveAgentFromJwt(jwtString, 'my-bot');\n\n// Flow 2: Agent ACT -> JWT\nconst jwt = await bridge.actToJwt(actClaims, signingKey, 'EdDSA');\n\n// Flow 3: Token exchange\nconst response = await bridge.exchangeToken(humanJwt, ['openai:chat:completions']);\n```" } ], "signatures": [ { "code": "interface BridgeIdentityHooks {\n deriveAgent?: (namespace: string, claims: ValidatedClaims, agentName: string) => DerivedAgent | Promise;\n mintCapability?: (input: {\n agent: DerivedAgent;\n subject: ValidatedClaims;\n scopes: readonly string[];\n request: TokenExchangeRequest;\n }) => Promise<{\n actB64: string;\n scopes: readonly string[];\n expiresIn: number;\n }>;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 365, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "bridgeidentityhooks" }, { "name": "buildActClaims", "declarationName": "buildActClaims", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build ACT JWT claims.", "tags": [], "signatures": [ { "code": "declare function buildActClaims(opts: {\n agentDid: string;\n bridgeIssuer: string;\n audience?: string;\n scopes: readonly string[];\n lineageDepth: number;\n parentHmr: string;\n actB64: string;\n ttlSeconds: number;\n}): ActJwtClaims;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 280, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "buildactclaims" }, { "name": "createAgentOidcProvider", "declarationName": "createAgentOidcProvider", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const createAgentOidcProvider: typeof AgentOidcProvider.create;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 665, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "createagentoidcprovider" }, { "name": "createJwtToActRequest", "declarationName": "createJwtToActRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a token exchange request for JWT -> ACT exchange.", "tags": [], "signatures": [ { "code": "declare function createJwtToActRequest(subjectToken: string, scopes?: readonly string[]): TokenExchangeRequest;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 203, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "createjwttoactrequest" }, { "name": "decodeJwtHeader", "declarationName": "decodeJwtHeader", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Decode the JWT header without verification (to get kid/alg).", "tags": [], "signatures": [ { "code": "declare function decodeJwtHeader(token: string): {\n kid?: string;\n alg?: string;\n};", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 267, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "decodejwtheader" }, { "name": "deriveAgentFromClaims", "declarationName": "deriveAgentFromClaims", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "No fallback identity is issued when real custody/derivation is unconfigured.", "tags": [], "signatures": [ { "code": "declare function deriveAgentFromClaims(namespace: string, claims: ValidatedClaims, agentName: string, derive?: IdentityDeriver): DerivedAgent;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 327, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "deriveagentfromclaims" }, { "name": "DerivedAgent", "declarationName": "DerivedAgent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Result of deriving an agent DID from a human JWT.", "tags": [], "signatures": [ { "code": "interface DerivedAgent {\n readonly agentDid: string;\n readonly agentKeypair: {\n readonly publicKey: Uint8Array;\n readonly privateKey: Uint8Array;\n };\n readonly lineageProof: Record | null;\n readonly parentHmrDid: string;\n readonly lineageDepth: number;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 301, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "derivedagent" }, { "name": "DiscoveryClient", "declarationName": "DiscoveryClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "OIDC discovery client with per-issuer caching.", "tags": [], "signatures": [ { "code": "declare class DiscoveryClient {\n constructor(fetchImpl: typeof globalThis.fetch, timeoutMs?: number, cacheTtlMs?: number);\n discover(issuer: string): Promise;\n invalidate(issuer: string): void;\n invalidateAll(): void;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 488, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "discoveryclient" }, { "name": "DiscoveryDocument", "declarationName": "DiscoveryDocument", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type DiscoveryDocument = z.infer;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 484, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "discoverydocument" }, { "name": "discoveryDocumentSchema", "declarationName": "discoveryDocumentSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Subset of the OpenID Connect Discovery document we need.", "tags": [], "signatures": [ { "code": "declare const discoveryDocumentSchema: z.ZodObject<{\n issuer: z.ZodString;\n authorization_endpoint: z.ZodDefault;\n token_endpoint: z.ZodDefault;\n jwks_uri: z.ZodString;\n response_types_supported: z.ZodDefault>;\n subject_types_supported: z.ZodDefault>;\n id_token_signing_alg_values_supported: z.ZodDefault>;\n scopes_supported: z.ZodDefault>;\n token_exchange_endpoint: z.ZodOptional;\n}, \"strip\", z.ZodTypeAny, {\n issuer: string;\n authorization_endpoint: string;\n token_endpoint: string;\n jwks_uri: string;\n response_types_supported: string[];\n subject_types_supported: string[];\n id_token_signing_alg_values_supported: string[];\n scopes_supported: string[];\n token_exchange_endpoint?: string | undefined;\n}, {\n issuer: string;\n jwks_uri: string;\n authorization_endpoint?: string | undefined;\n token_endpoint?: string | undefined;\n response_types_supported?: string[] | undefined;\n subject_types_supported?: string[] | undefined;\n id_token_signing_alg_values_supported?: string[] | undefined;\n scopes_supported?: string[] | undefined;\n token_exchange_endpoint?: string | undefined;\n}>;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 453, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "discoverydocumentschema" }, { "name": "exchangeErrors", "declarationName": "exchangeErrors", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Create standard OAuth2 error responses.", "tags": [], "signatures": [ { "code": "declare const exchangeErrors: {\n readonly invalidRequest: (desc: string) => TokenExchangeError;\n readonly invalidGrant: (desc: string) => TokenExchangeError;\n readonly unsupportedTokenType: (desc: string) => TokenExchangeError;\n readonly invalidTarget: (desc: string) => TokenExchangeError;\n};", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 211, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "exchangeerrors" }, { "name": "extractUnverifiedIssuer", "declarationName": "extractUnverifiedIssuer", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extract the unverified `iss` claim from a JWT.", "tags": [], "signatures": [ { "code": "declare function extractUnverifiedIssuer(token: string): string;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 272, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "extractunverifiedissuer" }, { "name": "findProvider", "declarationName": "findProvider", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Find the provider config whose issuer matches the given string.", "tags": [], "signatures": [ { "code": "declare function findProvider(config: OidcConfig, issuer: string): ProviderConfig | undefined;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 137, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "findprovider" }, { "name": "GRANT_TYPE_TOKEN_EXCHANGE", "declarationName": "GRANT_TYPE_TOKEN_EXCHANGE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard grant type for RFC 8693 Token Exchange.", "tags": [], "signatures": [ { "code": "declare const GRANT_TYPE_TOKEN_EXCHANGE: \"urn:ietf:params:oauth:grant-type:token-exchange\";", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 149, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "grant_type_token_exchange" }, { "name": "hmrIdentifierFromClaims", "declarationName": "hmrIdentifierFromClaims", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Deterministic identifier for an HMR derived from an OIDC subject.\n\nUses issuer + subject to produce a stable, collision-resistant\nidentifier that doesn't leak PII.", "tags": [], "signatures": [ { "code": "declare function hmrIdentifierFromClaims(issuer: string, hmrValue: string): string;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 322, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "hmridentifierfromclaims" }, { "name": "IdentityDeriver", "declarationName": "IdentityDeriver", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Real identity custody/derivation hook. The host must authorize the human owner.", "tags": [], "signatures": [ { "code": "type IdentityDeriver = (namespace: string, claims: ValidatedClaims, agentName: string) => DerivedAgent;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 324, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "identityderiver" }, { "name": "JwksClient", "declarationName": "JwksClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "JWKS client with per-URI caching and rotation-aware refresh.", "tags": [], "signatures": [ { "code": "declare class JwksClient {\n constructor(fetchImpl: typeof globalThis.fetch, timeoutMs?: number, cacheTtlMs?: number);\n fetchJwks(jwksUri: string): Promise;\n refresh(jwksUri: string): Promise;\n static selectKey(jwks: jose.JSONWebKeySet, kid: string | undefined, alg: string | undefined): jose.JWK;\n invalidate(jwksUri: string): void;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 539, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "jwksclient" }, { "name": "LifeIdAgentRoot", "declarationName": "LifeIdAgentRoot", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LifeIdAgentRoot {\n readonly kind: 'lifeid';\n readonly did: string;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 571, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "lifeidagentroot" }, { "name": "LifeIdFederation", "declarationName": "LifeIdFederation", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class LifeIdFederation {\n constructor(options: LifeIdFederationOptions);\n verifyHumanToken(token: string, expectedOwner: AgentOwner): Promise;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 607, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "lifeidfederation" }, { "name": "LifeIdFederationOptions", "declarationName": "LifeIdFederationOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LifeIdFederationOptions {\n readonly issuer: string;\n readonly audience: string;\n readonly jwksUri: string;\n readonly algorithms?: readonly ('RS256' | 'EdDSA')[];\n readonly organizationClaim?: string;\n readonly fetch?: typeof globalThis.fetch;\n readonly test?: boolean;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 594, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "lifeidfederationoptions" }, { "name": "mapScopes", "declarationName": "mapScopes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Map OIDC scopes/roles to Arsenal capability scopes.\n\nUnmapped scopes are passed through as-is.", "tags": [], "signatures": [ { "code": "declare function mapScopes(oidcScopes: readonly string[], scopeMapping: Readonly>): string[];", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 333, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "mapscopes" }, { "name": "OidcBridge", "declarationName": "OidcBridge", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class OidcBridge {\n constructor(input: OidcConfig | SingleProviderInput, hooks?: BridgeIdentityHooks);\n getConfig(): Readonly;\n deriveAgentFromJwt(token: string, agentName: string): Promise;\n actToJwt(claims: ActJwtClaims, signingKey: jose.KeyLike | Uint8Array, algorithm: string, kid?: string): Promise;\n wrapActAsJwt(opts: {\n agentDid: string;\n bridgeIssuer: string;\n audience?: string;\n scopes: readonly string[];\n lineageDepth: number;\n parentHmr: string;\n actB64: string;\n signingKey: jose.KeyLike | Uint8Array;\n algorithm: string;\n kid?: string;\n }): Promise;\n exchangeToken(humanJwt: string, requestedScopes: readonly string[], signingKey?: jose.KeyLike | Uint8Array, algorithm?: string, bridgeIssuer?: string): Promise;\n executeExchange(request: TokenExchangeRequest, signingKey: jose.KeyLike | Uint8Array | undefined, algorithm: string, bridgeIssuer: string): Promise;\n validateJwt(token: string): Promise;\n refreshAllJwks(): Promise;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 380, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "oidcbridge" }, { "name": "OidcBridgeError", "declarationName": "OidcBridgeError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Base error class for all OIDC bridge errors.", "tags": [], "signatures": [ { "code": "declare class OidcBridgeError extends Error {\n readonly code: OidcErrorCode;\n constructor(code: OidcErrorCode, message: string);\n static config(message: string): OidcBridgeError;\n static discovery(message: string): OidcBridgeError;\n static jwks(message: string): OidcBridgeError;\n static jwtValidation(message: string): OidcBridgeError;\n static unknownIssuer(issuer: string): OidcBridgeError;\n static mapping(message: string): OidcBridgeError;\n static exchange(message: string): OidcBridgeError;\n static signing(message: string): OidcBridgeError;\n static transport(message: string): OidcBridgeError;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 508, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "oidcbridgeerror" }, { "name": "OidcConfig", "declarationName": "OidcConfig", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type OidcConfig = z.infer;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 110, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "oidcconfig" }, { "name": "oidcConfigSchema", "declarationName": "oidcConfigSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Top-level OIDC bridge configuration.", "tags": [], "signatures": [ { "code": "declare const oidcConfigSchema: z.ZodObject<{\n providers: z.ZodArray;\n jwksUrl: z.ZodOptional;\n hmrClaim: z.ZodDefault;\n scopeMapping: z.ZodDefault>>;\n }, \"strip\", z.ZodTypeAny, {\n name: string;\n issuer: string;\n hmrClaim: string;\n scopeMapping: Record;\n audience?: string | undefined;\n jwksUrl?: string | undefined;\n }, {\n name: string;\n issuer: string;\n audience?: string | undefined;\n jwksUrl?: string | undefined;\n hmrClaim?: string | undefined;\n scopeMapping?: Record | undefined;\n }>, \"many\">;\n namespace: z.ZodDefault;\n jwtTtlSeconds: z.ZodDefault;\n httpTimeoutMs: z.ZodDefault;\n fetch: z.ZodOptional, z.ZodUnknown>>;\n}, \"strip\", z.ZodTypeAny, {\n providers: {\n name: string;\n issuer: string;\n hmrClaim: string;\n scopeMapping: Record;\n audience?: string | undefined;\n jwksUrl?: string | undefined;\n }[];\n namespace: string;\n jwtTtlSeconds: number;\n httpTimeoutMs: number;\n fetch?: ((...args: unknown[]) => unknown) | undefined;\n}, {\n providers: {\n name: string;\n issuer: string;\n audience?: string | undefined;\n jwksUrl?: string | undefined;\n hmrClaim?: string | undefined;\n scopeMapping?: Record | undefined;\n }[];\n namespace?: string | undefined;\n jwtTtlSeconds?: number | undefined;\n httpTimeoutMs?: number | undefined;\n fetch?: ((...args: unknown[]) => unknown) | undefined;\n}>;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 45, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "oidcconfigschema" }, { "name": "OidcErrorCode", "declarationName": "OidcErrorCode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Error codes for OIDC bridge errors.", "tags": [], "signatures": [ { "code": "type OidcErrorCode = 'DISCOVERY_ERROR' | 'JWKS_ERROR' | 'JWT_VALIDATION_ERROR' | 'UNKNOWN_ISSUER' | 'MAPPING_ERROR' | 'EXCHANGE_ERROR' | 'SIGNING_ERROR' | 'CONFIG_ERROR' | 'TRANSPORT_ERROR';", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 506, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "oidcerrorcode" }, { "name": "ownerFromLifeIdClaims", "declarationName": "ownerFromLifeIdClaims", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Normalize known human owner aliases without inventing an agent principal.", "tags": [], "signatures": [ { "code": "declare function ownerFromLifeIdClaims(claims: JWTPayload, organizationClaim?: string): AgentOwner;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 606, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "ownerfromlifeidclaims" }, { "name": "parseScopes", "declarationName": "parseScopes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse scopes from a space-delimited string.", "tags": [], "signatures": [ { "code": "declare function parseScopes(scope: string | undefined): string[];", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 207, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "parsescopes" }, { "name": "ProviderConfig", "declarationName": "ProviderConfig", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProviderConfig = z.infer;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 43, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "providerconfig" }, { "name": "providerConfigSchema", "declarationName": "providerConfigSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Configuration for a single OIDC provider.", "tags": [], "signatures": [ { "code": "declare const providerConfigSchema: z.ZodObject<{\n name: z.ZodString;\n issuer: z.ZodString;\n audience: z.ZodOptional;\n jwksUrl: z.ZodOptional;\n hmrClaim: z.ZodDefault;\n scopeMapping: z.ZodDefault>>;\n}, \"strip\", z.ZodTypeAny, {\n name: string;\n issuer: string;\n hmrClaim: string;\n scopeMapping: Record;\n audience?: string | undefined;\n jwksUrl?: string | undefined;\n}, {\n name: string;\n issuer: string;\n audience?: string | undefined;\n jwksUrl?: string | undefined;\n hmrClaim?: string | undefined;\n scopeMapping?: Record | undefined;\n}>;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 15, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "providerconfigschema" }, { "name": "resolveFetch", "declarationName": "resolveFetch", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resolve the fetch implementation from config or globalThis.", "tags": [], "signatures": [ { "code": "declare function resolveFetch(config: OidcConfig): typeof globalThis.fetch;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 139, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "resolvefetch" }, { "name": "SelfAgentRoot", "declarationName": "SelfAgentRoot", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface SelfAgentRoot {\n readonly kind: 'self';\n readonly did: string;\n readonly authorizationId: string;\n readonly revision: string;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 575, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "selfagentroot" }, { "name": "signActJwt", "declarationName": "signActJwt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Sign a JWT wrapping an Arsenal ACT for OAuth2-only services.", "tags": [], "signatures": [ { "code": "declare function signActJwt(claims: ActJwtClaims, signingKey: jose.KeyLike | Uint8Array, algorithm: string, kid?: string): Promise;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 291, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "signactjwt" }, { "name": "singleProviderConfig", "declarationName": "singleProviderConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build an OidcConfig from a single-provider shorthand input.", "tags": [], "signatures": [ { "code": "declare function singleProviderConfig(input: SingleProviderInput): OidcConfig;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 135, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "singleproviderconfig" }, { "name": "SingleProviderInput", "declarationName": "SingleProviderInput", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Shorthand input for single-provider setup.", "tags": [], "signatures": [ { "code": "interface SingleProviderInput {\n name?: string;\n issuer: string;\n audience?: string;\n jwksUrl?: string;\n hmrClaim?: string;\n scopeMapping?: Record;\n namespace?: string;\n jwtTtlSeconds?: number;\n httpTimeoutMs?: number;\n fetch?: typeof globalThis.fetch;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 112, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "singleproviderinput" }, { "name": "successResponse", "declarationName": "successResponse", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build a successful token exchange response.", "tags": [], "signatures": [ { "code": "declare function successResponse(accessToken: string, issuedTokenType: string, expiresIn: number, scope?: string): TokenExchangeResponse;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 209, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "successresponse" }, { "name": "TOKEN_TYPE_ACCESS", "declarationName": "TOKEN_TYPE_ACCESS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard token type for access tokens.", "tags": [], "signatures": [ { "code": "declare const TOKEN_TYPE_ACCESS: \"urn:ietf:params:oauth:token-type:access_token\";", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 155, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "token_type_access" }, { "name": "TOKEN_TYPE_ACT", "declarationName": "TOKEN_TYPE_ACT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Custom token type for OpenAgent ACTs.", "tags": [], "signatures": [ { "code": "declare const TOKEN_TYPE_ACT: \"urn:openagent:token-type:act\";", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 153, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "token_type_act" }, { "name": "TOKEN_TYPE_JWT", "declarationName": "TOKEN_TYPE_JWT", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Standard token type for JWT subject tokens.", "tags": [], "signatures": [ { "code": "declare const TOKEN_TYPE_JWT: \"urn:ietf:params:oauth:token-type:jwt\";", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 151, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "token_type_jwt" }, { "name": "TokenExchangeError", "declarationName": "TokenExchangeError", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "RFC 8693 error response.", "tags": [], "signatures": [ { "code": "interface TokenExchangeError {\n readonly error: string;\n readonly errorDescription?: string;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 198, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "tokenexchangeerror" }, { "name": "TokenExchangeRequest", "declarationName": "TokenExchangeRequest", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type TokenExchangeRequest = z.infer;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 188, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "tokenexchangerequest" }, { "name": "tokenExchangeRequestSchema", "declarationName": "tokenExchangeRequestSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Token exchange request (RFC 8693 Section 2.1).", "tags": [], "signatures": [ { "code": "declare const tokenExchangeRequestSchema: z.ZodObject<{\n grantType: z.ZodLiteral<\"urn:ietf:params:oauth:grant-type:token-exchange\">;\n subjectToken: z.ZodString;\n subjectTokenType: z.ZodEnum<[\n \"urn:ietf:params:oauth:token-type:jwt\",\n \"urn:ietf:params:oauth:token-type:access_token\"\n ]>;\n requestedTokenType: z.ZodOptional>;\n scope: z.ZodOptional;\n audience: z.ZodOptional;\n resource: z.ZodOptional;\n actorToken: z.ZodOptional;\n actorTokenType: z.ZodOptional;\n}, \"strip\", z.ZodTypeAny, {\n grantType: \"urn:ietf:params:oauth:grant-type:token-exchange\";\n subjectToken: string;\n subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\" | \"urn:ietf:params:oauth:token-type:access_token\";\n audience?: string | undefined;\n requestedTokenType?: \"urn:ietf:params:oauth:token-type:jwt\" | \"urn:openagent:token-type:act\" | \"urn:ietf:params:oauth:token-type:access_token\" | undefined;\n scope?: string | undefined;\n resource?: string | undefined;\n actorToken?: string | undefined;\n actorTokenType?: string | undefined;\n}, {\n grantType: \"urn:ietf:params:oauth:grant-type:token-exchange\";\n subjectToken: string;\n subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\" | \"urn:ietf:params:oauth:token-type:access_token\";\n audience?: string | undefined;\n requestedTokenType?: \"urn:ietf:params:oauth:token-type:jwt\" | \"urn:openagent:token-type:act\" | \"urn:ietf:params:oauth:token-type:access_token\" | undefined;\n scope?: string | undefined;\n resource?: string | undefined;\n actorToken?: string | undefined;\n actorTokenType?: string | undefined;\n}>;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 157, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "tokenexchangerequestschema" }, { "name": "TokenExchangeResponse", "declarationName": "TokenExchangeResponse", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Token exchange response (RFC 8693 Section 2.2).", "tags": [], "signatures": [ { "code": "interface TokenExchangeResponse {\n readonly accessToken: string;\n readonly issuedTokenType: string;\n readonly tokenType: 'Bearer';\n readonly expiresIn: number;\n readonly scope?: string;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 190, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "tokenexchangeresponse" }, { "name": "ValidatedClaims", "declarationName": "ValidatedClaims", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Claims extracted from a validated human JWT.", "tags": [], "signatures": [ { "code": "interface ValidatedClaims {\n readonly issuer: string;\n readonly subject: string;\n readonly audience: readonly string[];\n readonly exp: number;\n readonly iat: number;\n readonly hmrValue: string;\n readonly scopes: readonly string[];\n readonly rawClaims: Readonly>;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 225, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "validatedclaims" }, { "name": "validateDerivedAgent", "declarationName": "validateDerivedAgent", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function validateDerivedAgent(agent: DerivedAgent): DerivedAgent;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 325, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "validatederivedagent" }, { "name": "validateExchangeRequest", "declarationName": "validateExchangeRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate a token exchange request.", "tags": [], "signatures": [ { "code": "declare function validateExchangeRequest(request: TokenExchangeRequest): void;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 205, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "validateexchangerequest" }, { "name": "validateJwt", "declarationName": "validateJwt", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate and decode a JWT using the given JWK.\n\nPerforms standard OIDC validation: issuer, audience, expiry, signature.", "tags": [], "signatures": [ { "code": "declare function validateJwt(token: string, jwk: jose.JWK, provider: ProviderConfig): Promise;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 278, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "validatejwt" }, { "name": "VerifiedAgentIdentity", "declarationName": "VerifiedAgentIdentity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type VerifiedAgentIdentity = VerifiedIdentityFields & ({\n readonly owner: AgentOwner;\n readonly root?: LifeIdAgentRoot;\n} | {\n readonly owner: null;\n readonly root: SelfAgentRoot;\n});", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 582, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "verifiedagentidentity" }, { "name": "VerifyAgentContext", "declarationName": "VerifyAgentContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifyAgentContext {\n readonly audience: string;\n readonly nonce: string;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 589, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "verifyagentcontext" }, { "name": "VERSION", "declarationName": "VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SDK version.", "tags": [], "signatures": [ { "code": "declare const VERSION = \"0.2.0\";", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 699, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "version" }, { "name": "wellKnownUrl", "declarationName": "wellKnownUrl", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Build the `.well-known/openid-configuration` URL from an issuer.", "tags": [], "signatures": [ { "code": "declare function wellKnownUrl(issuer: string): string;", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 486, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "wellknownurl" } ], "supportingDeclarations": [ { "name": "VerifiedIdentityFields", "declarationName": "VerifiedIdentityFields", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifiedIdentityFields {\n readonly did: string;\n readonly lineage: readonly string[];\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/oidc", "version": "0.2.0", "file": "dist/index.d.ts", "line": 566, "sha256": "97de5dd7056f148aa46b4cc2674f4ad9ff305ace3667b76efff7e1551b6e85cf" } } ], "anchor": "verifiedidentityfields" } ], "coverage": { "discovered": 58, "documented": 58, "missing": [] } } ] }, { "name": "@openagentid/scim", "version": "0.1.1", "status": "legacy-sdk-peer", "notes": [ "Declares an optional peer on @openagentid/sdk ^0.1.0, which excludes SDK 0.7.2. Reference describes the published contract; do not assume compatibility with the current SDK." ], "tarball": "https://registry.npmjs.org/@openagentid/scim/-/scim-0.1.1.tgz", "integrity": "sha512-RuFR244IbG3EOWSxReZMrzE0PLt1FX9z8MLqwGxcrnfsP7JiYM7WiJSmCXtM5WxgqS+PZvS8zgHlJyLLo5n2iw==", "packageJsonSha256": "0f511895d20921a663a6b16c93bfdf314fb6efd70c60513167f45a646eb7fe0d", "page": "/reference/typescript/scim", "engines": { "node": ">=20" }, "dependencies": { "zod": "^3.23.8" }, "peerDependencies": { "@openagentid/sdk": "^0.1.0" }, "peerDependenciesMeta": { "@openagentid/sdk": { "optional": true } }, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/scim", "page": "/reference/typescript/scim", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" }, { "conditions": [ "require" ], "path": "./dist/index.cjs" } ], "exports": [ { "name": "AgentExtension", "declarationName": "AgentExtension", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The OpenAgent agent extension attribute group.", "tags": [], "signatures": [ { "code": "interface AgentExtension {\n readonly parentDid: string;\n readonly conformanceLevel: ConformanceLevel;\n readonly scopes: readonly string[];\n readonly lineageDepth: number;\n readonly createdVia: string;\n readonly keypairFingerprint: string;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 72, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "agentextension" }, { "name": "AgentProvisioner", "declarationName": "AgentProvisioner", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class AgentProvisioner {\n constructor(config: ProvisionerConfig);\n createAgent(params: CreateAgentParams): Promise;\n replaceAgent(did: string, params: CreateAgentParams): Promise;\n updateAgent(did: string, record: AgentRecord): Promise;\n deprovisionAgent(did: string): Promise;\n findByDid(did: string): Promise;\n findByUserName(userName: string): Promise;\n listAgents(): Promise;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 379, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "agentprovisioner" }, { "name": "AgentRecord", "declarationName": "AgentRecord", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The canonical internal representation of a provisioned agent.", "tags": [], "signatures": [ { "code": "interface AgentRecord {\n readonly did: string;\n readonly userName: string;\n readonly displayName: string;\n readonly active: boolean;\n readonly parentDid: string;\n readonly conformanceLevel: ConformanceLevel;\n readonly scopes: readonly string[];\n readonly lineageDepth: number;\n readonly createdVia: string;\n readonly keypairFingerprint: string;\n readonly createdAt: string;\n readonly updatedAt: string;\n readonly version: string;\n readonly externalId?: string;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 130, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "agentrecord" }, { "name": "AgentStore", "declarationName": "AgentStore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Storage interface for agent records.\n\nAll methods return new objects — implementations must never return\nmutable references to internal state.", "tags": [], "signatures": [ { "code": "interface AgentStore {\n list(): Promise;\n findByDid(did: string): Promise;\n findByUserName(userName: string): Promise;\n findByExternalId(externalId: string): Promise;\n create(record: AgentRecord): Promise;\n update(did: string, record: AgentRecord): Promise;\n delete(did: string): Promise;\n countActive(): Promise;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 283, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "agentstore" }, { "name": "agentToScimResource", "declarationName": "agentToScimResource", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Convert an internal AgentRecord into a SCIM User resource.", "tags": [], "signatures": [ { "code": "declare function agentToScimResource(agent: AgentRecord, baseUrl: string): ScimAgentResource;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 263, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "agenttoscimresource" }, { "name": "applyPatchOperations", "declarationName": "applyPatchOperations", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Apply a set of SCIM PATCH operations to an agent record.\n\nReturns a new record with all operations applied. The original is never mutated.\nThrows on invalid paths or unsupported operations.", "tags": [], "signatures": [ { "code": "declare function applyPatchOperations(record: AgentRecord, operations: readonly PatchOperation[]): AgentRecord;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 557, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "applypatchoperations" }, { "name": "ArsenalSessionInvalidator", "declarationName": "ArsenalSessionInvalidator", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook invoked during deprovisioning to invalidate all active Arsenal\nsessions for the deprovisioned agent.\n\nProduction: wires to Arsenal SDK's session invalidation.\nDefault: no-op (logs a warning).", "tags": [], "signatures": [ { "code": "type ArsenalSessionInvalidator = (did: string) => Promise;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 361, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "arsenalsessioninvalidator" }, { "name": "AttributeFilter", "declarationName": "AttributeFilter", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single attribute filter expression.", "tags": [], "signatures": [ { "code": "interface AttributeFilter {\n readonly type: 'attribute';\n readonly attribute: string;\n readonly op: FilterOp;\n readonly value: string | boolean | number | null;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 478, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "attributefilter" }, { "name": "AuditEvent", "declarationName": "AuditEvent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Audit event emitted during agent lifecycle operations.", "tags": [], "signatures": [ { "code": "interface AuditEvent {\n readonly type: 'agent.created' | 'agent.updated' | 'agent.deprovisioned';\n readonly did: string;\n readonly timestamp: string;\n readonly details: Record;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 331, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "auditevent" }, { "name": "AuditSink", "declarationName": "AuditSink", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Callback invoked for each lifecycle audit event.", "tags": [], "signatures": [ { "code": "type AuditSink = (event: AuditEvent) => void | Promise;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 338, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "auditsink" }, { "name": "buildResourceTypes", "declarationName": "buildResourceTypes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Resource type discovery for User (Agent).", "tags": [], "signatures": [ { "code": "declare function buildResourceTypes(baseUrl: string): readonly Record[];", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 119, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "buildresourcetypes" }, { "name": "buildSchemas", "declarationName": "buildSchemas", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Schema discovery response for the User + Agent extension.", "tags": [], "signatures": [ { "code": "declare function buildSchemas(): readonly Record[];", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 117, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "buildschemas" }, { "name": "buildServiceProviderConfig", "declarationName": "buildServiceProviderConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Service Provider Configuration response.", "tags": [], "signatures": [ { "code": "declare function buildServiceProviderConfig(baseUrl: string): Record;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 115, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "buildserviceproviderconfig" }, { "name": "ConformanceLevel", "declarationName": "ConformanceLevel", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Conformance levels for OpenAgent agents.", "tags": [], "signatures": [ { "code": "type ConformanceLevel = 'L0' | 'L1' | 'L2';", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 70, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "conformancelevel" }, { "name": "CreateAgentFromScimInput", "declarationName": "CreateAgentFromScimInput", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CreateAgentFromScimInput = z.infer;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 203, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "createagentfromsciminput" }, { "name": "createAgentFromScimSchema", "declarationName": "createAgentFromScimSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const createAgentFromScimSchema: z.ZodObject<{\n schemas: z.ZodEffects, string[], string[]>;\n externalId: z.ZodOptional;\n userName: z.ZodString;\n displayName: z.ZodOptional;\n active: z.ZodDefault;\n \"urn:openagent:scim:1.0:Agent\": z.ZodObject<{\n parentDid: z.ZodString;\n conformanceLevel: z.ZodDefault>;\n scopes: z.ZodArray;\n lineageDepth: z.ZodOptional;\n createdVia: z.ZodOptional;\n keypairFingerprint: z.ZodOptional;\n }, \"strip\", z.ZodTypeAny, {\n parentDid: string;\n conformanceLevel: \"L0\" | \"L1\" | \"L2\";\n scopes: string[];\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n }, {\n parentDid: string;\n scopes: string[];\n conformanceLevel?: \"L0\" | \"L1\" | \"L2\" | undefined;\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n }>;\n}, \"strip\", z.ZodTypeAny, {\n \"urn:openagent:scim:1.0:Agent\": {\n parentDid: string;\n conformanceLevel: \"L0\" | \"L1\" | \"L2\";\n scopes: string[];\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n };\n schemas: string[];\n userName: string;\n active: boolean;\n displayName?: string | undefined;\n externalId?: string | undefined;\n}, {\n \"urn:openagent:scim:1.0:Agent\": {\n parentDid: string;\n scopes: string[];\n conformanceLevel?: \"L0\" | \"L1\" | \"L2\" | undefined;\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n };\n schemas: string[];\n userName: string;\n displayName?: string | undefined;\n active?: boolean | undefined;\n externalId?: string | undefined;\n}>;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 146, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "createagentfromscimschema" }, { "name": "CreateAgentParams", "declarationName": "CreateAgentParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CreateAgentParams {\n readonly userName: string;\n readonly displayName?: string;\n readonly parentDid: string;\n readonly conformanceLevel: ConformanceLevel;\n readonly scopes: readonly string[];\n readonly externalId?: string;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 371, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "createagentparams" }, { "name": "createScimRouter", "declarationName": "createScimRouter", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a SCIM 2.0 router with the given configuration.", "tags": [], "signatures": [ { "code": "declare function createScimRouter(routerConfig?: ScimRouterConfig): ScimRouter;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 459, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "createscimrouter" }, { "name": "DelegationCascadeRevoker", "declarationName": "DelegationCascadeRevoker", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook invoked during deprovisioning to cascade-revoke all delegation\nproofs issued by (or to) the deprovisioned agent.\n\nProduction: wires to AEGIS SDK's delegation tree walker.\nDefault: no-op (logs a warning).", "tags": [], "signatures": [ { "code": "type DelegationCascadeRevoker = (did: string) => Promise;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 353, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "delegationcascaderevoker" }, { "name": "DidRevoker", "declarationName": "DidRevoker", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Hook invoked during deprovisioning to revoke the agent's DID document.\n\nProduction: wires to OAS SDK's `revokeIdentity`.\nDefault: no-op (logs a warning).", "tags": [], "signatures": [ { "code": "type DidRevoker = (did: string) => Promise;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 345, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "didrevoker" }, { "name": "FilterOp", "declarationName": "FilterOp", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Supported comparison operators.", "tags": [], "signatures": [ { "code": "type FilterOp = 'eq' | 'ne' | 'co' | 'sw' | 'ew' | 'pr' | 'gt' | 'ge' | 'lt' | 'le';", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 476, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "filterop" }, { "name": "InMemoryAgentStore", "declarationName": "InMemoryAgentStore", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory store for testing and development.", "tags": [], "signatures": [ { "code": "declare class InMemoryAgentStore implements AgentStore {\n list(): Promise;\n findByDid(did: string): Promise;\n findByUserName(userName: string): Promise;\n findByExternalId(externalId: string): Promise;\n create(record: AgentRecord): Promise;\n update(did: string, record: AgentRecord): Promise;\n delete(did: string): Promise;\n countActive(): Promise;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 302, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "inmemoryagentstore" }, { "name": "Logger", "declarationName": "Logger", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Logger interface matching the OpenAgent SDK convention.", "tags": [], "signatures": [ { "code": "interface Logger {\n debug(msg: string, fields?: Record): void;\n info(msg: string, fields?: Record): void;\n warn(msg: string, fields?: Record): void;\n error(msg: string, fields?: Record): void;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 10, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "logger" }, { "name": "LogicalFilter", "declarationName": "LogicalFilter", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Logical combination of filters.", "tags": [], "signatures": [ { "code": "interface LogicalFilter {\n readonly type: 'and' | 'or';\n readonly filters: readonly ParsedFilter[];\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 485, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "logicalfilter" }, { "name": "matchesFilter", "declarationName": "matchesFilter", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Evaluate a parsed filter against an agent record. Returns true if the record matches.", "tags": [], "signatures": [ { "code": "declare function matchesFilter(record: AgentRecord, filter: ParsedFilter | undefined): boolean;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 498, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "matchesfilter" }, { "name": "OPENAGENT_AGENT_SCHEMA", "declarationName": "OPENAGENT_AGENT_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "OpenAgent agent extension schema URN.", "tags": [], "signatures": [ { "code": "declare const OPENAGENT_AGENT_SCHEMA: \"urn:openagent:scim:1.0:Agent\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 56, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "openagent_agent_schema" }, { "name": "paginateResults", "declarationName": "paginateResults", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Apply pagination to an array of items and return a SCIM ListResponse.\n\nItems are expected to be pre-filtered and pre-sorted. This function\nslices the array according to 1-based SCIM indexing.", "tags": [], "signatures": [ { "code": "declare function paginateResults(items: readonly T[], params: PaginationParams): ScimListResponse;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 529, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "paginateresults" }, { "name": "PaginationParams", "declarationName": "PaginationParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Parsed pagination parameters from a SCIM request.", "tags": [], "signatures": [ { "code": "interface PaginationParams {\n readonly startIndex: number;\n readonly count: number;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 511, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "paginationparams" }, { "name": "parseCreateInput", "declarationName": "parseCreateInput", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse and validate a SCIM create request body into typed input.", "tags": [], "signatures": [ { "code": "declare function parseCreateInput(body: unknown): CreateAgentFromScimInput;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 265, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "parsecreateinput" }, { "name": "ParsedFilter", "declarationName": "ParsedFilter", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ParsedFilter = AttributeFilter | LogicalFilter;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 489, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "parsedfilter" }, { "name": "parseFilter", "declarationName": "parseFilter", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse a SCIM filter string into a structured filter tree.\n\nReturns `undefined` for empty/missing filters (match all).\nThrows on malformed filters.", "tags": [], "signatures": [ { "code": "declare function parseFilter(filterStr: string | undefined | null): ParsedFilter | undefined;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 496, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "parsefilter" }, { "name": "parsePagination", "declarationName": "parsePagination", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extract pagination parameters from a SCIM request URL search params.\n\nReturns immutable params — never mutates the input.", "tags": [], "signatures": [ { "code": "declare function parsePagination(searchParams: URLSearchParams, maxPageSize: number): PaginationParams;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 522, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "parsepagination" }, { "name": "parsePatchRequest", "declarationName": "parsePatchRequest", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse and validate a SCIM PATCH request body.", "tags": [], "signatures": [ { "code": "declare function parsePatchRequest(body: unknown): PatchRequest;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 550, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "parsepatchrequest" }, { "name": "parseReplaceInput", "declarationName": "parseReplaceInput", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Parse and validate a SCIM replace (PUT) request body into typed input.", "tags": [], "signatures": [ { "code": "declare function parseReplaceInput(body: unknown): ReplaceAgentFromScimInput;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 267, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "parsereplaceinput" }, { "name": "PatchOperation", "declarationName": "PatchOperation", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A single SCIM PATCH operation.", "tags": [], "signatures": [ { "code": "interface PatchOperation {\n readonly op: 'add' | 'replace' | 'remove';\n readonly path?: string;\n readonly value?: unknown;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 539, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "patchoperation" }, { "name": "PatchRequest", "declarationName": "PatchRequest", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "SCIM PatchOp request body.", "tags": [], "signatures": [ { "code": "interface PatchRequest {\n readonly schemas: readonly string[];\n readonly Operations: readonly PatchOperation[];\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 545, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "patchrequest" }, { "name": "ProvisionerConfig", "declarationName": "ProvisionerConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ProvisionerConfig {\n readonly store: AgentStore;\n readonly namespace: string;\n readonly logger: Logger;\n readonly auditSink?: AuditSink;\n readonly revokeDidDocument?: DidRevoker;\n readonly cascadeRevokeDelegations?: DelegationCascadeRevoker;\n readonly invalidateArsenalSessions?: ArsenalSessionInvalidator;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 362, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "provisionerconfig" }, { "name": "ProvisionerError", "declarationName": "ProvisionerError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class ProvisionerError extends Error {\n readonly code: ProvisionerErrorCode;\n constructor(message: string, code: ProvisionerErrorCode);\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 418, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "provisionererror" }, { "name": "ReplaceAgentFromScimInput", "declarationName": "ReplaceAgentFromScimInput", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ReplaceAgentFromScimInput = z.infer;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 261, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "replaceagentfromsciminput" }, { "name": "ResolvedScimConfig", "declarationName": "ResolvedScimConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ResolvedScimConfig {\n readonly namespace: string;\n readonly bearerTokens: readonly string[];\n readonly baseUrl: string;\n readonly maxPageSize: number;\n readonly logger: Logger;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 38, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "resolvedscimconfig" }, { "name": "resolveScimConfig", "declarationName": "resolveScimConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function resolveScimConfig(config?: ScimBridgeConfig): ResolvedScimConfig;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 45, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "resolvescimconfig" }, { "name": "SCIM_ERROR_SCHEMA", "declarationName": "SCIM_ERROR_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SCIM Error schema URN.", "tags": [], "signatures": [ { "code": "declare const SCIM_ERROR_SCHEMA: \"urn:ietf:params:scim:api:messages:2.0:Error\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 60, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scim_error_schema" }, { "name": "SCIM_LIST_RESPONSE_SCHEMA", "declarationName": "SCIM_LIST_RESPONSE_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SCIM List Response schema URN.", "tags": [], "signatures": [ { "code": "declare const SCIM_LIST_RESPONSE_SCHEMA: \"urn:ietf:params:scim:api:messages:2.0:ListResponse\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 58, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scim_list_response_schema" }, { "name": "SCIM_PATCH_OP_SCHEMA", "declarationName": "SCIM_PATCH_OP_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SCIM Patch Operation schema URN.", "tags": [], "signatures": [ { "code": "declare const SCIM_PATCH_OP_SCHEMA: \"urn:ietf:params:scim:api:messages:2.0:PatchOp\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 62, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scim_patch_op_schema" }, { "name": "SCIM_RESOURCE_TYPE_SCHEMA", "declarationName": "SCIM_RESOURCE_TYPE_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SCIM ResourceType schema URN.", "tags": [], "signatures": [ { "code": "declare const SCIM_RESOURCE_TYPE_SCHEMA: \"urn:ietf:params:scim:schemas:core:2.0:ResourceType\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 68, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scim_resource_type_schema" }, { "name": "SCIM_SCHEMA_SCHEMA", "declarationName": "SCIM_SCHEMA_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SCIM Schema schema URN.", "tags": [], "signatures": [ { "code": "declare const SCIM_SCHEMA_SCHEMA: \"urn:ietf:params:scim:schemas:core:2.0:Schema\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 66, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scim_schema_schema" }, { "name": "SCIM_SPC_SCHEMA", "declarationName": "SCIM_SPC_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SCIM ServiceProviderConfig schema URN.", "tags": [], "signatures": [ { "code": "declare const SCIM_SPC_SCHEMA: \"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 64, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scim_spc_schema" }, { "name": "SCIM_USER_SCHEMA", "declarationName": "SCIM_USER_SCHEMA", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SCIM core User schema URN.", "tags": [], "signatures": [ { "code": "declare const SCIM_USER_SCHEMA: \"urn:ietf:params:scim:schemas:core:2.0:User\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 54, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scim_user_schema" }, { "name": "ScimAgentResource", "declarationName": "ScimAgentResource", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Full SCIM User resource with agent extension.", "tags": [], "signatures": [ { "code": "interface ScimAgentResource {\n readonly schemas: readonly string[];\n readonly id: string;\n readonly externalId?: string;\n readonly userName: string;\n readonly displayName: string;\n readonly active: boolean;\n readonly meta: ScimMeta;\n readonly [OPENAGENT_AGENT_SCHEMA]: AgentExtension;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 81, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimagentresource" }, { "name": "ScimBridgeConfig", "declarationName": "ScimBridgeConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Configuration for the SCIM provisioning bridge.", "tags": [], "signatures": [ { "code": "interface ScimBridgeConfig {\n readonly namespace?: string;\n readonly bearerTokens?: readonly string[];\n readonly baseUrl?: string;\n readonly maxPageSize?: number;\n readonly logger?: Logger;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 18, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimbridgeconfig" }, { "name": "ScimErrorResponse", "declarationName": "ScimErrorResponse", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "SCIM Error response.", "tags": [], "signatures": [ { "code": "interface ScimErrorResponse {\n readonly schemas: readonly string[];\n readonly status: string;\n readonly scimType?: string;\n readonly detail: string;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 108, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimerrorresponse" }, { "name": "ScimFilterError", "declarationName": "ScimFilterError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class ScimFilterError extends Error {\n constructor(message: string);\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 499, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimfiltererror" }, { "name": "ScimListResponse", "declarationName": "ScimListResponse", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "SCIM List Response envelope.", "tags": [], "signatures": [ { "code": "interface ScimListResponse {\n readonly schemas: readonly string[];\n readonly totalResults: number;\n readonly startIndex: number;\n readonly itemsPerPage: number;\n readonly Resources: readonly T[];\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 100, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimlistresponse" }, { "name": "ScimMeta", "declarationName": "ScimMeta", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "SCIM resource metadata.", "tags": [], "signatures": [ { "code": "interface ScimMeta {\n readonly resourceType: string;\n readonly created: string;\n readonly lastModified: string;\n readonly location: string;\n readonly version: string;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 92, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimmeta" }, { "name": "ScimPatchError", "declarationName": "ScimPatchError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class ScimPatchError extends Error {\n constructor(message: string);\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 558, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimpatcherror" }, { "name": "ScimRouter", "declarationName": "ScimRouter", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ScimRouter {\n handle(request: Request): Promise;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 454, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimrouter" }, { "name": "ScimRouterConfig", "declarationName": "ScimRouterConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "SCIM 2.0 endpoint handlers — framework-agnostic Request/Response API.\n\nThese handlers operate on WHATWG `Request` and `Response` objects,\nmaking them portable across Node (with fetch), Bun, Deno, Cloudflare\nWorkers, and any framework that exposes the standard Web API.\n\nUsage with a framework:\n```ts\nimport { createScimRouter } from '@openagentid/scim';\n\nconst scim = createScimRouter({ namespace: 'acme', bearerTokens: ['secret'] });\n\n// Express: app.all('/scim/v2/*', (req, res) => ...)\n// Hono: app.all('/scim/v2/*', (c) => scim.handle(c.req.raw))\n// Bun: Bun.serve({ fetch: scim.handle })\n```", "tags": [], "signatures": [ { "code": "interface ScimRouterConfig extends ScimBridgeConfig {\n readonly store?: AgentStore;\n readonly auditSink?: AuditSink;\n readonly revokeDidDocument?: DidRevoker;\n readonly cascadeRevokeDelegations?: DelegationCascadeRevoker;\n readonly invalidateArsenalSessions?: ArsenalSessionInvalidator;\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 442, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "scimrouterconfig" }, { "name": "silentLogger", "declarationName": "silentLogger", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const silentLogger: Logger;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 16, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "silentlogger" }, { "name": "StoreError", "declarationName": "StoreError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class StoreError extends Error {\n readonly code: StoreErrorCode;\n constructor(message: string, code: StoreErrorCode);\n}", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 314, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "storeerror" }, { "name": "StoreErrorCode", "declarationName": "StoreErrorCode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type StoreErrorCode = 'NOT_FOUND' | 'CONFLICT' | 'INTERNAL';", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 313, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "storeerrorcode" }, { "name": "VERSION", "declarationName": "VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Package version.", "tags": [], "signatures": [ { "code": "declare const VERSION = \"0.1.1\";", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 589, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "version" } ], "supportingDeclarations": [ { "name": "ProvisionerErrorCode", "declarationName": "ProvisionerErrorCode", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ProvisionerErrorCode = 'NOT_FOUND' | 'CONFLICT' | 'VALIDATION';", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 417, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "provisionererrorcode" }, { "name": "replaceAgentFromScimSchema", "declarationName": "replaceAgentFromScimSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const replaceAgentFromScimSchema: z.ZodObject<{\n schemas: z.ZodEffects, string[], string[]>;\n externalId: z.ZodOptional;\n userName: z.ZodString;\n displayName: z.ZodOptional;\n active: z.ZodDefault;\n \"urn:openagent:scim:1.0:Agent\": z.ZodObject<{\n parentDid: z.ZodString;\n conformanceLevel: z.ZodDefault>;\n scopes: z.ZodArray;\n lineageDepth: z.ZodOptional;\n createdVia: z.ZodOptional;\n keypairFingerprint: z.ZodOptional;\n }, \"strip\", z.ZodTypeAny, {\n parentDid: string;\n conformanceLevel: \"L0\" | \"L1\" | \"L2\";\n scopes: string[];\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n }, {\n parentDid: string;\n scopes: string[];\n conformanceLevel?: \"L0\" | \"L1\" | \"L2\" | undefined;\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n }>;\n}, \"strip\", z.ZodTypeAny, {\n \"urn:openagent:scim:1.0:Agent\": {\n parentDid: string;\n conformanceLevel: \"L0\" | \"L1\" | \"L2\";\n scopes: string[];\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n };\n schemas: string[];\n userName: string;\n active: boolean;\n displayName?: string | undefined;\n externalId?: string | undefined;\n}, {\n \"urn:openagent:scim:1.0:Agent\": {\n parentDid: string;\n scopes: string[];\n conformanceLevel?: \"L0\" | \"L1\" | \"L2\" | undefined;\n lineageDepth?: number | undefined;\n createdVia?: string | undefined;\n keypairFingerprint?: string | undefined;\n };\n schemas: string[];\n userName: string;\n displayName?: string | undefined;\n active?: boolean | undefined;\n externalId?: string | undefined;\n}>;", "source": { "package": "@openagentid/scim", "version": "0.1.1", "file": "dist/index.d.ts", "line": 204, "sha256": "1cfc3f4cf84308e404a409d3ae8c83461b0f3372a218b344835b5a3d4dc69b39" } } ], "anchor": "replaceagentfromscimschema" } ], "coverage": { "discovered": 61, "documented": 61, "missing": [] } } ] }, { "name": "@openagentid/sdk", "version": "0.7.2", "status": "current", "notes": [ "The published VERSION constant is still the literal \"0.6.0\" in the 0.7.2 archive. Use package metadata or your lockfile to identify the installed release; do not use VERSION as a release check.", "When using @openagentid/crypto-wasm 0.1.1 for ACT verification, call the SDK verifier builder .atTime(Math.floor(Date.now() / 1000)) on every verification. The default WASM system-clock path traps in Node. Supply trusted receiver current epoch seconds; never token-supplied time or a timestamp captured once at startup. The complete ACT example covers this requirement.", "In SDK 0.7.2, withAct and requireActExpress do not expose a verification-clock option. The raw crypto-wasm 0.1.1 binding alone therefore traps for these wrappers; use the tested fluent .atTime(...) example, or qualify a binding adapter that supplies fresh trusted receiver time on every verification." ], "tarball": "https://registry.npmjs.org/@openagentid/sdk/-/sdk-0.7.2.tgz", "integrity": "sha512-9YlDb02di8sGffhuMOwNAQa/M3oBrhaqPc7t+qBltdoQRCqlxDmYB/nTRSB4eZgwE4lvM4TKzI72nJtJSVm/ww==", "packageJsonSha256": "d30dfb87a07983d94cf044ca42940929ad720d2dbacb6ce538f9912751f7f49c", "page": "/reference/typescript/sdk", "engines": { "node": ">=20" }, "dependencies": { "zod": "^3.23.8", "jose": "^5.10.0", "@noble/hashes": "^1.8.0", "@scure/base": "^1.2.6" }, "peerDependencies": { "@openagentid/aegis-sdk": "^0.1.0", "@openagentid/arsenal-sdk": "^0.1.0", "@openagentid/crypto-wasm": "^0.1.0", "@openagentid/oas-sdk": "^1.0.2" }, "peerDependenciesMeta": { "@openagentid/aegis-sdk": { "optional": true }, "@openagentid/arsenal-sdk": { "optional": true }, "@openagentid/oas-sdk": { "optional": true }, "@openagentid/crypto-wasm": { "optional": true } }, "bin": { "oaid": "./dist/cli.js" }, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/sdk", "page": "/reference/typescript/sdk", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" }, { "conditions": [ "require" ], "path": "./dist/index.cjs" } ], "exports": [ { "name": "act", "declarationName": "act", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The ACT namespace.", "tags": [], "signatures": [ { "code": "declare const act: {\n readonly verify: (token: Uint8Array) => ActVerifierBuilder;\n readonly setCryptoBinding: typeof setActCryptoBinding;\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 124, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "act" }, { "name": "ActClaims", "declarationName": "ActClaims", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The claims of a verified ACT, as returned by the canonical verifier.", "tags": [], "signatures": [ { "code": "interface ActClaims {\n jti: string;\n sub: string;\n iss: string;\n aud: string[];\n iat: number;\n nbf: number;\n exp: number;\n tenant_id: string;\n scope: string[];\n cnf?: {\n key_fingerprint: string;\n alg: string;\n };\n delegation?: {\n allow_delegation: boolean;\n max_depth: number;\n };\n ext?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 44, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "actclaims" }, { "name": "ActVerifierBuilder", "declarationName": "ActVerifierBuilder", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Fluent ACT verifier, built by {@link act.verify}.", "tags": [], "signatures": [ { "code": "declare class ActVerifierBuilder {\n constructor(token: Uint8Array);\n issuer(iss: string): this;\n forAudience(audience: string): this;\n requireScope(scope: string): this;\n requireScopes(scopes: string[]): this;\n trustedKeys(keys: Uint8Array[]): this;\n withLeeway(seconds: number): this;\n atTime(unixSeconds: number): this;\n run(): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 102, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "actverifierbuilder" }, { "name": "ActVerifyOptions", "declarationName": "ActVerifyOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options accepted by the fluent verifier.", "tags": [], "signatures": [ { "code": "interface ActVerifyOptions {\n issuer?: string;\n audience?: string;\n scopes?: string[];\n trustedKeys?: Uint8Array[];\n leewaySeconds?: number;\n nowUnixSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 77, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "actverifyoptions" }, { "name": "AgentActivity", "declarationName": "AgentActivity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentActivity = 'idle' | 'listening' | 'reasoning' | 'working' | 'speaking' | 'success' | 'blocked' | 'error';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 4, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "agentactivity" }, { "name": "agentAvatar", "declarationName": "agentAvatar", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Return an external override or a self-contained deterministic SVG data URL.", "tags": [], "signatures": [ { "code": "declare function agentAvatar(did: string, profile?: AgentAvatar, options?: AvatarOptions): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 35, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "agentavatar" }, { "name": "AgentAvatar", "declarationName": "AgentAvatar", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentAvatar {\n avatarOverride?: string | null;\n avatarSkin?: CharacterAppearance | null;\n avatarExpression?: AvatarExpression;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 11, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "agentavatar-1" }, { "name": "AgentIdentityProof", "declarationName": "AgentIdentityProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentIdentityProof {\n readonly token: string;\n readonly delegations: readonly string[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 42, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "agentidentityproof" }, { "name": "AgentKeys", "declarationName": "AgentKeys", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An agent's key material, derived from one seed.", "tags": [], "signatures": [ { "code": "interface AgentKeys {\n readonly seed: Uint8Array;\n readonly signingKey: Uint8Array;\n readonly verifyingKey: Uint8Array;\n readonly encryptionSecretKey: Uint8Array;\n readonly encryptionPublicKey: Uint8Array;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 235, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "agentkeys" }, { "name": "allowAllSkills", "declarationName": "allowAllSkills", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Policy that allows any skill (dangerous — use only in tests).", "tags": [], "signatures": [ { "code": "declare const allowAllSkills: SkillsPolicy;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 47, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "allowallskills" }, { "name": "ArsenalClient", "declarationName": "ArsenalClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Arsenal broker client facade. The real client lives in `@openagentid/arsenal-sdk`\nand is injected by the application; see `INTEGRATION_NOTES.md`.", "tags": [], "signatures": [ { "code": "interface ArsenalClient {\n requestCredential(params: {\n agentDid: Did;\n provider: string;\n scopes?: readonly string[];\n }): Promise;\n release?(credentialProxyUrl: string): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 51, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "arsenalclient" }, { "name": "assertAncestor", "declarationName": "assertAncestor", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Assert that `ctx.lineage` contains `ancestor`.", "tags": [], "signatures": [ { "code": "declare function assertAncestor(ctx: AuthContext, ancestor: Did): void;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 110, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "assertancestor" }, { "name": "assertScopes", "declarationName": "assertScopes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Assert that `ctx` holds every scope in `required`.", "tags": [], "signatures": [ { "code": "declare function assertScopes(ctx: AuthContext, required: readonly string[]): void;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 108, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "assertscopes" }, { "name": "assertVerifiedIdentity", "declarationName": "assertVerifiedIdentity", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate an authority verdict's root binding; this does not verify a signature.", "tags": [], "signatures": [ { "code": "declare function assertVerifiedIdentity(value: unknown, expectedDid?: string, now?: number): asserts value is VerifiedAgentIdentity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 109, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "assertverifiedidentity" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A resolved, authenticated caller identity.", "tags": [], "signatures": [ { "code": "interface AuthContext {\n readonly did: Did;\n readonly root: Did;\n readonly lineage: readonly Did[];\n readonly lineageAuthority?: LineageAuthorityContext;\n readonly scopes: readonly string[];\n readonly expiresAt: number;\n readonly presentedToken?: string;\n readonly claims?: Readonly>;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 44, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "authcontext" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "avatarExpressionSchema", "declarationName": "avatarExpressionSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const avatarExpressionSchema: z.ZodEnum<[\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n]>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 100, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "avatarexpressionschema" }, { "name": "AvatarOptions", "declarationName": "AvatarOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AvatarOptions extends GlyphOptions {\n view?: CharacterView;\n expression?: AvatarExpression;\n animated?: boolean;\n state?: LiveEyeState;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 19, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "avataroptions" }, { "name": "AvatarStatus", "declarationName": "AvatarStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarStatus = AvatarExpression | AgentActivity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 5, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarstatus" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAccessoryDescription", "declarationName": "CharacterAccessoryDescription", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAccessoryDescription {\n readonly id: CharacterAccessory;\n readonly label: string;\n readonly description: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 7, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessorydescription" }, { "name": "CharacterAnimator", "declarationName": "CharacterAnimator", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAnimator {\n sample(atMs?: number): CharacterFrame;\n update(state: CharacterStateUpdate, atMs?: number): CharacterRuntimeState;\n getState(): CharacterRuntimeState;\n setReducedMotion(value: boolean, atMs?: number): void;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 23, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "characteranimator" }, { "name": "CharacterAnimatorOptions", "declarationName": "CharacterAnimatorOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAnimatorOptions extends CharacterOptions {\n readonly transitionMs?: number;\n readonly reducedMotion?: boolean;\n readonly now?: () => number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 4, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "characteranimatoroptions" }, { "name": "CharacterApiHandlerOptions", "declarationName": "CharacterApiHandlerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterApiHandlerOptions {\n readonly basePath?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-api.d.ts", "line": 1, "sha256": "92153cc80f9920afe6c93a5cd33b24f4107c13def3acb13a17092ba3260acd19" } } ], "anchor": "characterapihandleroptions" }, { "name": "characterApiOpenApi", "declarationName": "characterApiOpenApi", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Bundled OpenAPI 3.1 contract; mirrored in docs/character-api.openapi.json.", "tags": [], "signatures": [ { "code": "declare const characterApiOpenApi: {\n readonly openapi: \"3.1.0\";\n readonly info: {\n readonly title: \"OpenAgentID Character API\";\n readonly version: \"0.7.2\";\n readonly description: \"Public, unauthenticated stateless deterministic agent decoration. Autos is the default rounded pill family. The catalog contains 17 families and 62 distinct character kinds, including Halloween, Thanksgiving and Christmas. Avatar rendering frames the face by default; view=full restores the complete character. Skin controls body and face geometry; expressions and live-v1 eyes are shared across skins. This API neither mints identities nor verifies possession, ownership, lineage, revocation or permissions. No secrets, external assets, JavaScript, CSS or fonts. Every response including errors and 304 includes wildcard CORS; credentials are not required. Unknown and duplicate query parameters are rejected. Input, streamed body chunks and geometry are bounded; hosted infrastructure supplies request rate and duration limits. Runtime state resolves state.expression before status mapping, then outer preferred expression, then neutral. Status is presentation state only and establishes no agent activity or authority. Independent glasses and headphones can be combined on every family. Accessories default to an empty selection, do not change identity-derived shape/color or live-eye state, and normalize to catalog order. Unknown, duplicate or malformed selections are refused. Every family supports shared finish (plush default, flat optional) and eyePlacement (face default, raised optional). These strictly closed appearance selectors do not change identity-derived shape/color or runtime state. Descriptors include both resolved values.\";\n };\n readonly servers: readonly [\n {\n readonly url: \"/v1/characters\";\n }\n ];\n readonly security: readonly [\n ];\n readonly paths: {\n readonly \"/skins\": {\n readonly get: {\n readonly summary: \"List versioned character skins\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterSkinV1\";\n };\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for list versioned character skins\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/statuses\": {\n readonly get: {\n readonly summary: \"List runtime status-to-expression mappings\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterStatusV1\";\n };\n readonly minItems: 26;\n readonly maxItems: 26;\n readonly description: \"Immutable SDK mapping catalog serialized as JSON, including all expressions and runtime aliases.\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for runtime status-to-expression mappings\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/svg/{did}\": {\n readonly get: {\n readonly summary: \"Render a character SVG\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n readonly content: {\n readonly \"image/svg+xml\": {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for render a character svg\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/{did}\": {\n readonly get: {\n readonly summary: \"Generate a character descriptor\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterDescriptorV1\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for generate a character descriptor\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/generate\": {\n readonly post: {\n readonly summary: \"Generate a character descriptor from JSON\";\n readonly description: \"Stateless and unauthenticated; no query parameters. Unknown fields are rejected at every level. Streamed body size is checked independently of Content-Length.\";\n readonly \"x-max-body-bytes\": 16384;\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly requestBody: {\n readonly required: true;\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterGenerateRequestV1\";\n };\n };\n };\n };\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Generated descriptor; no-store, no ETag.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterDescriptorV1\";\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n readonly \"413\": {\n readonly $ref: \"#/components/responses/BodyTooLarge\";\n };\n readonly \"415\": {\n readonly $ref: \"#/components/responses/UnsupportedMediaType\";\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"POST, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/openapi.json\": {\n readonly get: {\n readonly summary: \"Read this OpenAPI schema\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"object\";\n readonly description: \"OpenAPI 3.1 document; servers[0].url reflects the configured mount path.\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for read this openapi schema\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/accessories\": {\n readonly get: {\n readonly summary: \"List combinable character accessories\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterAccessoryDescriptionV1\";\n };\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for the character accessory catalog\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Preflight for the character accessory catalog\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n };\n readonly components: {\n readonly schemas: {\n readonly AgentDid: {\n readonly type: \"string\";\n readonly maxLength: 512;\n readonly pattern: \"^did:(?:(?:oas:[a-z0-9][a-z0-9-]{0,63}|l1fe):agent(?::instance)?:[A-Za-z0-9._-]+|oas:agent-instance:[0-7][0-9A-HJKMNP-TV-Z]{25})(?![\\\\s\\\\S])\";\n readonly description: \"Existing agent or agent:instance DID, including the literal IAM did:oas:agent-instance: avatar format. Generation preserves the assigned DID and neither verifies nor registers a principal; authentication schemas are unchanged.\";\n };\n readonly CharacterAppearanceV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"skin\"\n ];\n readonly properties: {\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly GazeV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"x\",\n \"y\"\n ];\n readonly properties: {\n readonly x: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly y: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n };\n };\n readonly LiveEyeStateV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly properties: {\n readonly blink: {\n readonly type: \"number\";\n readonly minimum: 0;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly gaze: {\n readonly $ref: \"#/components/schemas/GazeV1\";\n };\n readonly status: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n readonly description: \"Runtime status alias or literal expression. Overrides the outer preferred expression.\";\n };\n readonly expression: {\n readonly $ref: \"#/components/schemas/AvatarExpression\";\n readonly description: \"Explicit runtime expression; overrides state.status mapping and outer preferred expression. Null is not accepted by this stateless API.\";\n };\n };\n readonly description: \"Optional stateless snapshot. Resolution: state.expression > state.status mapping > outer expression > neutral. Unknown fields and null values are refused.\";\n };\n readonly CharacterOptionsV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly properties: {\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly size: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly animated: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly state: {\n readonly $ref: \"#/components/schemas/LiveEyeStateV1\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly expression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Outer preferred expression fallback. Explicit state.expression wins, then state.status mapping, then this preference, then neutral.\";\n };\n readonly view: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly CharacterGenerateRequestV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"did\"\n ];\n readonly properties: {\n readonly did: {\n readonly $ref: \"#/components/schemas/AgentDid\";\n };\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly size: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly animated: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly state: {\n readonly $ref: \"#/components/schemas/LiveEyeStateV1\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly expression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Outer preferred expression fallback. Explicit state.expression wins, then state.status mapping, then this preference, then neutral.\";\n };\n readonly view: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly CharacterDescriptorV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"did\",\n \"skin\",\n \"skinVersion\",\n \"eyeStyle\",\n \"shape\",\n \"color\",\n \"size\",\n \"animated\",\n \"state\",\n \"svg\",\n \"expression\",\n \"view\",\n \"accessories\",\n \"finish\",\n \"eyePlacement\"\n ];\n readonly properties: {\n readonly did: {\n readonly $ref: \"#/components/schemas/AgentDid\";\n };\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly size: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly animated: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly state: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"blink\",\n \"gaze\"\n ];\n readonly properties: {\n readonly blink: {\n readonly type: \"number\";\n readonly minimum: 0;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly gaze: {\n readonly $ref: \"#/components/schemas/GazeV1\";\n };\n readonly status: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n };\n readonly expression: {\n readonly $ref: \"#/components/schemas/AvatarExpression\";\n };\n };\n readonly description: \"Normalized blink/gaze, retaining status/expression only when explicitly supplied in input state. Descriptor.expression is the resolved expression; old snapshots without state status/expression preserve their prior shape.\";\n };\n readonly color: {\n readonly type: \"string\";\n readonly pattern: \"^#[0-9a-fA-F]{6}$\";\n };\n readonly svg: {\n readonly type: \"string\";\n readonly description: \"Escaped, self-contained SVG on a transparent background. No external resources, JavaScript, CSS or fonts.\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly expression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Resolved expression: state.expression > state.status mapping > outer preferred expression > neutral. Body shape/color remain unchanged.\";\n };\n readonly view: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly CharacterSkinV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"id\",\n \"label\",\n \"version\",\n \"eyeStyles\",\n \"shapes\",\n \"expressions\"\n ];\n readonly properties: {\n readonly id: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly label: {\n readonly type: \"string\";\n };\n readonly version: {\n readonly type: \"integer\";\n readonly const: 1;\n };\n readonly eyeStyles: {\n readonly type: \"array\";\n readonly items: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly minItems: 1;\n readonly uniqueItems: true;\n };\n readonly shapes: {\n readonly type: \"array\";\n readonly items: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly minItems: 1;\n readonly uniqueItems: true;\n };\n readonly expressions: {\n readonly type: \"array\";\n readonly items: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Shared eye expression across all skins. Body shape and color remain unchanged. Explicit blink shrinks expression eye bars and gaze translates both together.\";\n };\n readonly minItems: 18;\n readonly maxItems: 18;\n readonly uniqueItems: true;\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"spacex\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n readonly minItems: 8;\n readonly maxItems: 8;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"fold\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"sprig\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"ripple\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"halo\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"purl\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"prism\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"coil\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"kiln\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"wisp\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"relay\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"cairn\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"tuft\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"halloween\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n readonly minItems: 5;\n readonly maxItems: 5;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"thanksgiving\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n readonly minItems: 5;\n readonly maxItems: 5;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"christmas\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n readonly minItems: 5;\n readonly maxItems: 5;\n };\n };\n };\n }\n ];\n };\n readonly CharacterApiError: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"error\"\n ];\n readonly properties: {\n readonly error: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"invalid_request\",\n \"body_too_large\",\n \"unsupported_media_type\",\n \"method_not_allowed\",\n \"not_found\"\n ];\n };\n };\n };\n readonly AvatarExpression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly description: \"Shared eye expression across all families; does not change identity-derived shape or color.\";\n };\n readonly AvatarStatus: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\",\n \"idle\",\n \"listening\",\n \"reasoning\",\n \"working\",\n \"speaking\",\n \"success\",\n \"blocked\",\n \"error\"\n ];\n readonly description: \"Expressions map to themselves. Aliases: idle→neutral, listening→attentive, reasoning→thoughtful, working→attentive, speaking/success→happy, blocked/error→concerned. Presentation only; not evidence of actual agent activity.\";\n };\n readonly CharacterStatusV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"status\",\n \"expression\"\n ];\n readonly properties: {\n readonly status: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n };\n readonly expression: {\n readonly $ref: \"#/components/schemas/AvatarExpression\";\n };\n };\n };\n readonly CharacterAccessory: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"glasses\",\n \"headphones\"\n ];\n readonly description: \"Closed package-owned accessory identifier; independent of character family.\";\n };\n readonly CharacterAccessoriesV1: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterAccessory\";\n };\n readonly maxItems: 2;\n readonly uniqueItems: true;\n readonly default: readonly [\n ];\n readonly description: \"Optional independent accessories, canonicalized to glasses then headphones. Omitted selection resolves to []; no null, unknown identifier or duplicate is accepted.\";\n };\n readonly CharacterAccessoryDescriptionV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"id\",\n \"label\",\n \"description\"\n ];\n readonly properties: {\n readonly id: {\n readonly $ref: \"#/components/schemas/CharacterAccessory\";\n };\n readonly label: {\n readonly type: \"string\";\n readonly minLength: 1;\n };\n readonly description: {\n readonly type: \"string\";\n readonly minLength: 1;\n };\n };\n };\n readonly CharacterFinish: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"plush\",\n \"flat\"\n ];\n readonly default: \"plush\";\n readonly description: \"Shared body finish on every family: plush by default, flat for the vector material. Appearance only; identity and live state stay independent.\";\n };\n readonly CharacterEyePlacement: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"face\",\n \"raised\"\n ];\n readonly default: \"face\";\n readonly description: \"Shared live-v1 eye placement on every family: on the face by default, or raised above the head. Appearance only; all eighteen expressions remain available.\";\n };\n };\n readonly parameters: {\n readonly did: {\n readonly name: \"did\";\n readonly in: \"path\";\n readonly required: true;\n readonly schema: {\n readonly $ref: \"#/components/schemas/AgentDid\";\n };\n readonly description: \"Percent-encode the entire DID as one path segment.\";\n };\n readonly IfNoneMatch: {\n readonly name: \"If-None-Match\";\n readonly in: \"header\";\n readonly schema: {\n readonly type: \"string\";\n readonly maxLength: 4096;\n };\n readonly description: \"GET/HEAD accepts a strong/weak validator, comma-separated list or *. Headers over 4096 characters are ignored.\";\n };\n readonly skin: {\n readonly name: \"skin\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n };\n readonly skinVersion: {\n readonly name: \"skinVersion\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n };\n readonly eyeStyle: {\n readonly name: \"eyeStyle\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n };\n readonly size: {\n readonly name: \"size\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly description: \"Unsigned decimal integer, no leading zeroes.\";\n };\n readonly animated: {\n readonly name: \"animated\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly description: \"Exactly true or false.\";\n };\n readonly blink: {\n readonly name: \"blink\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"number\";\n readonly minimum: 0;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly description: \"Finite ordinary decimal notation, no exponent, whitespace or leading +.\";\n };\n readonly gazeX: {\n readonly name: \"gazeX\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly description: \"Finite ordinary decimal notation, no exponent, whitespace or leading +. gazeX and gazeY must be supplied together.\";\n };\n readonly gazeY: {\n readonly name: \"gazeY\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly description: \"Finite ordinary decimal notation, no exponent, whitespace or leading +. gazeX and gazeY must be supplied together.\";\n };\n readonly shape: {\n readonly name: \"shape\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n };\n readonly expression: {\n readonly name: \"expression\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Shared eye expression across all skins. Body shape and color remain unchanged. Explicit blink shrinks expression eye bars and gaze translates both together.\";\n };\n readonly description: \"Outer preferred expression fallback. A status query is state.status and overrides this preference. Explicit runtime expression overrides can be supplied in POST state.expression.\";\n };\n readonly status: {\n readonly name: \"status\";\n readonly in: \"query\";\n readonly schema: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n };\n readonly description: \"Parsed as state.status. Overrides expression query preference with its mapped expression. Duplicate/unknown status values are refused before rendering or cache validation.\";\n };\n readonly view: {\n readonly name: \"view\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n };\n readonly accessories: {\n readonly name: \"accessories\";\n readonly in: \"query\";\n readonly required: false;\n readonly style: \"form\";\n readonly explode: false;\n readonly allowEmptyValue: true;\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly description: \"One comma-separated selection, for example glasses,headphones. Empty string means []; either input order normalizes to catalog order. Repeated query parameters, duplicates, unknown IDs, whitespace and empty elements are refused.\";\n };\n readonly finish: {\n readonly name: \"finish\";\n readonly in: \"query\";\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n };\n readonly eyePlacement: {\n readonly name: \"eyePlacement\";\n readonly in: \"query\";\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n };\n readonly headers: {\n readonly CorsOrigin: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"*\";\n };\n };\n readonly CorsExpose: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"ETag, Content-Length\";\n };\n };\n readonly NoSniff: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"nosniff\";\n };\n };\n readonly CacheControl: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n readonly ETag: {\n readonly schema: {\n readonly type: \"string\";\n };\n readonly description: \"Strong SHA-256 validator for exact response bytes.\";\n };\n readonly ContentLength: {\n readonly schema: {\n readonly type: \"integer\";\n readonly minimum: 0;\n };\n };\n readonly SvgCsp: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"default-src 'none'; img-src 'none'; style-src 'none'; sandbox\";\n };\n };\n };\n readonly responses: {\n readonly InvalidRequest: {\n readonly description: \"Invalid DID, malformed value or JSON, unknown field, unknown or duplicate query parameter.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly NotFound: {\n readonly description: \"Route outside this handler or unsupported route shape.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly MethodNotAllowed: {\n readonly description: \"Method not supported; Allow identifies allowed methods.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly BodyTooLarge: {\n readonly description: \"Announced or streamed body exceeds 16384 bytes.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly UnsupportedMediaType: {\n readonly description: \"Requires uncompressed UTF-8 application/json, optionally charset=utf-8.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n };\n };\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-api.d.ts", "line": 11, "sha256": "92153cc80f9920afe6c93a5cd33b24f4107c13def3acb13a17092ba3260acd19" } } ], "anchor": "characterapiopenapi" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "characterAppearanceSchema", "declarationName": "characterAppearanceSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Versioned body/face selection. Runtime expression and gaze are independent.", "tags": [], "signatures": [ { "code": "declare const characterAppearanceSchema: z.ZodEffects;\n skinVersion: z.ZodOptional>;\n eyeStyle: z.ZodOptional>;\n finish: z.ZodOptional>;\n eyePlacement: z.ZodOptional>;\n shape: z.ZodOptional,\n ...NonNullable[]\n ]>>;\n accessories: z.ZodOptional, \"many\">, readonly CharacterAccessory[], (\"glasses\" | \"headphones\")[]>>;\n}, \"strict\", z.ZodTypeAny, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n}, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n}>, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n}, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 59, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "characterappearanceschema" }, { "name": "CharacterDescriptor", "declarationName": "CharacterDescriptor", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterDescriptor {\n readonly did: string;\n readonly skin: CharacterSkin;\n readonly skinVersion: 1;\n readonly eyeStyle: CharacterEyeStyle;\n readonly finish: CharacterFinish;\n readonly eyePlacement: CharacterEyePlacement;\n readonly shape: CharacterShape;\n readonly accessories: readonly CharacterAccessory[];\n readonly expression: AvatarExpression;\n readonly color: string;\n readonly view: CharacterView;\n readonly size: number;\n readonly animated: boolean;\n readonly state: {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n };\n readonly svg: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 60, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterdescriptor" }, { "name": "CharacterEyeFrame", "declarationName": "CharacterEyeFrame", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterEyeFrame {\n readonly x: number;\n readonly y: number;\n readonly width: number;\n readonly height: number;\n readonly rx: number;\n readonly rotation: number;\n readonly centerX: number;\n readonly centerY: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 10, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "charactereyeframe" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterFrame", "declarationName": "CharacterFrame", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterFrame extends CharacterRuntimeState {\n readonly eyes: readonly [\n CharacterEyeFrame,\n CharacterEyeFrame\n ];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 20, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "characterframe" }, { "name": "CharacterOptions", "declarationName": "CharacterOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterOptions extends Omit {\n readonly skin?: CharacterSkin;\n readonly expression?: AvatarExpression;\n readonly view?: CharacterView;\n readonly size?: number;\n readonly animated?: boolean;\n readonly state?: LiveEyeState;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 41, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteroptions" }, { "name": "CharacterRuntimeState", "declarationName": "CharacterRuntimeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterRuntimeState {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 18, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterruntimestate" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CharacterSkinDescription", "declarationName": "CharacterSkinDescription", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterSkinDescription {\n readonly id: CharacterSkin;\n readonly label: string;\n readonly version: 1;\n readonly eyeStyles: readonly CharacterEyeStyle[];\n readonly shapes: readonly CharacterShape[];\n readonly expressions: readonly AvatarExpression[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 52, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskindescription" }, { "name": "CharacterStateUpdate", "declarationName": "CharacterStateUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A status update clears the previous override; null restores the status expression.", "tags": [], "signatures": [ { "code": "interface CharacterStateUpdate extends Omit {\n readonly expression?: AvatarExpression | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 28, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterstateupdate" }, { "name": "CharacterView", "declarationName": "CharacterView", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterView = 'avatar' | 'full';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 25, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterview" }, { "name": "ConfigError", "declarationName": "ConfigError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Configuration or usage violation (invalid input, missing dependency).", "tags": [], "signatures": [ { "code": "declare class ConfigError extends OpenAgentError {\n constructor(message: string, context?: Record);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 68, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "configerror" }, { "name": "CreateAgentInput", "declarationName": "CreateAgentInput", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CreateAgentInput = z.infer;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 56, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinput" }, { "name": "createAgentInputSchema", "declarationName": "createAgentInputSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Parameters accepted by {@link OpenAgent.createAgent }.", "tags": [], "signatures": [ { "code": "declare const createAgentInputSchema: z.ZodObject<{\n parent: z.ZodEffects;\n name: z.ZodString;\n scopes: z.ZodArray;\n namespace: z.ZodOptional;\n skills: z.ZodOptional>;\n metadata: z.ZodOptional>;\n}, \"strict\", z.ZodTypeAny, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 28, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinputschema" }, { "name": "createCharacterAnimator", "declarationName": "createCharacterAnimator", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "A single timeline: interruptions preserve both eye position and velocity.", "tags": [], "signatures": [ { "code": "declare function createCharacterAnimator(did: string, options?: CharacterAnimatorOptions): CharacterAnimator;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 30, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "createcharacteranimator" }, { "name": "createCharacterApiHandler", "declarationName": "createCharacterApiHandler", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Unauthenticated, stateless decoration only. This handler never resolves,\nregisters, authenticates or verifies the requested agent identity.", "tags": [], "signatures": [ { "code": "declare function createCharacterApiHandler(options?: CharacterApiHandlerOptions): (request: Request) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-api.d.ts", "line": 9, "sha256": "92153cc80f9920afe6c93a5cd33b24f4107c13def3acb13a17092ba3260acd19" } } ], "anchor": "createcharacterapihandler" }, { "name": "createCredentialHandle", "declarationName": "createCredentialHandle", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a {@link CredentialHandle} backed by an Arsenal client.", "tags": [], "signatures": [ { "code": "declare function createCredentialHandle(params: CreateCredentialHandleParams): Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 96, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "createcredentialhandle" }, { "name": "createIdentityVerificationHandler", "declarationName": "createIdentityVerificationHandler", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Host this handler at your chosen POST endpoint. No endpoint is auto-deployed.", "tags": [], "signatures": [ { "code": "declare function createIdentityVerificationHandler(verifier: IdentityVerifier, options: IdentityVerificationHandlerOptions): (request: Request) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 16, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "createidentityverificationhandler" }, { "name": "createOatsEvidenceVerifier", "declarationName": "createOatsEvidenceVerifier", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Concrete OAS Ed25519Signature2020 verifier. It verifies upstream JCS signing\nbytes, assertion-authorized issuer keys, authoritative owner chains and\ncurrent attestation revocation. No cryptographic work is delegated to callers.", "tags": [], "signatures": [ { "code": "declare function createOatsEvidenceVerifier(config: OatsEvidenceVerifierConfig): OatsEvidenceVerifier;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 99, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "createoatsevidenceverifier" }, { "name": "CredentialError", "declarationName": "CredentialError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Arsenal credentials subsystem failure.", "tags": [], "signatures": [ { "code": "declare class CredentialError extends OpenAgentError {\n constructor(message: string, details: ErrorDetails);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 80, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "credentialerror" }, { "name": "CredentialHandle", "declarationName": "CredentialHandle", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A live, fetch-ready credential bound to an agent DID + provider.\n\nThe fetch method is a drop-in replacement for `globalThis.fetch`. The\nunderlying credential is refreshed lazily when the caller invokes\n`refresh()` — auto-rotation stays out of the per-request hot path.", "tags": [], "signatures": [ { "code": "interface CredentialHandle {\n readonly provider: string;\n readonly agentDid: Did;\n readonly expiresAt: number;\n fetch: typeof fetch;\n refresh(): Promise;\n release(): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 68, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "credentialhandle" }, { "name": "DEFAULT_NAMESPACE", "declarationName": "DEFAULT_NAMESPACE", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_NAMESPACE = \"openagent\";", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 125, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "default_namespace" }, { "name": "DEFAULT_REQUEST_TIMEOUT_MS", "declarationName": "DEFAULT_REQUEST_TIMEOUT_MS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DEFAULT_REQUEST_TIMEOUT_MS = 30000;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 126, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "default_request_timeout_ms" }, { "name": "denyAllSkills", "declarationName": "denyAllSkills", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Empty policy that denies everything.", "tags": [], "signatures": [ { "code": "declare const denyAllSkills: SkillsPolicy;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 45, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "denyallskills" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Fully qualified `did:oas` identifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 7, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "did" }, { "name": "DID_REGEX", "declarationName": "DID_REGEX", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "DID regex for `did:oas:::`.\n\nMirrors the OAS v1.1.0 specification. We keep it deliberately permissive\nhere — strict validation belongs in the OAS SDK itself.", "tags": [], "signatures": [ { "code": "declare const DID_REGEX: RegExp;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 17, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "did_regex" }, { "name": "didSchema", "declarationName": "didSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const didSchema: z.ZodEffects;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 20, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "didschema" }, { "name": "ErrorCode", "declarationName": "ErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Stable machine-readable error codes. These are part of the SDK's public\ncontract and MUST stay in sync with the Rust reference implementation.", "tags": [], "signatures": [ { "code": "declare const ErrorCode: {\n readonly INVALID_CONFIG: \"openagent/invalid-config\";\n readonly INVALID_INPUT: \"openagent/invalid-input\";\n readonly NOT_INITIALIZED: \"openagent/not-initialized\";\n readonly IDENTITY_CREATE_FAILED: \"openagent/identity/create-failed\";\n readonly IDENTITY_RESOLVE_FAILED: \"openagent/identity/resolve-failed\";\n readonly IDENTITY_SIGNATURE_INVALID: \"openagent/identity/signature-invalid\";\n readonly IDENTITY_LINEAGE_INVALID: \"openagent/identity/lineage-invalid\";\n readonly CREDENTIAL_FETCH_FAILED: \"openagent/credentials/fetch-failed\";\n readonly CREDENTIAL_SCOPE_DENIED: \"openagent/credentials/scope-denied\";\n readonly CREDENTIAL_PROVIDER_UNKNOWN: \"openagent/credentials/provider-unknown\";\n readonly CREDENTIAL_EXPIRED: \"openagent/credentials/expired\";\n readonly VERIFICATION_FAILED: \"openagent/verification/failed\";\n readonly AUTH_REQUIRED: \"openagent/verification/auth-required\";\n readonly AUTH_CHALLENGE_INVALID: \"openagent/verification/challenge-invalid\";\n readonly SKILL_DENIED: \"openagent/skills/denied\";\n readonly SKILL_UNKNOWN: \"openagent/skills/unknown\";\n readonly NETWORK_ERROR: \"openagent/network-error\";\n readonly SERIALIZATION_ERROR: \"openagent/serialization-error\";\n readonly UNKNOWN: \"openagent/unknown\";\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 15, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "errorcode" }, { "name": "ErrorCodeValue", "declarationName": "ErrorCodeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ErrorCodeValue = (typeof ErrorCode)[keyof typeof ErrorCode];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 36, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "errorcodevalue" }, { "name": "ErrorDetails", "declarationName": "ErrorDetails", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Structured error metadata attached to every {@link OpenAgentError}.", "tags": [], "signatures": [ { "code": "interface ErrorDetails {\n code: ErrorCodeValue;\n cause?: unknown;\n context?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 38, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "errordetails" }, { "name": "expressionEyes", "declarationName": "expressionEyes", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const expressionEyes: Readonly>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 90, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "expressioneyes" }, { "name": "expressionForStatus", "declarationName": "expressionForStatus", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function expressionForStatus(value: unknown): AvatarExpression;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 37, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "expressionforstatus" }, { "name": "extractBearerToken", "declarationName": "extractBearerToken", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extract the bearer token from a `Request` without trusting it.\n\nChecks, in order: `Authorization: OpenAgent ...`,\n`Authorization: Bearer ...`, `X-OpenAgent-Token`, and an `oa_token`\nquery parameter. Returns `null` if absent.", "tags": [], "signatures": [ { "code": "declare function extractBearerToken(req: Request): string | null;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 106, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "extractbearertoken" }, { "name": "EyeGeometry", "declarationName": "EyeGeometry", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type EyeGeometry = readonly [\n width: number,\n height: number,\n centerY: number,\n rotation: number\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 89, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "eyegeometry" }, { "name": "generateCharacter", "declarationName": "generateCharacter", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Self-contained SVG character. Public DID-derived pixels are not identity proof.", "tags": [], "signatures": [ { "code": "declare function generateCharacter(did: string, options?: CharacterOptions): CharacterDescriptor;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 92, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "generatecharacter" }, { "name": "getCharacterAccessories", "declarationName": "getCharacterAccessories", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Immutable catalog. Accessories can be combined and default to none.", "tags": [], "signatures": [ { "code": "declare function getCharacterAccessories(): readonly CharacterAccessoryDescription[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 13, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "getcharacteraccessories" }, { "name": "getCharacterExpressions", "declarationName": "getCharacterExpressions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterExpressions(): readonly AvatarExpression[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 31, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "getcharacterexpressions" }, { "name": "getCharacterSkins", "declarationName": "getCharacterSkins", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Immutable versioned body/face skins. Eye expression is independent of skin.", "tags": [], "signatures": [ { "code": "declare function getCharacterSkins(): readonly CharacterSkinDescription[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 86, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "getcharacterskins" }, { "name": "getCharacterStatuses", "declarationName": "getCharacterStatuses", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterStatuses(): readonly {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n}[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 32, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "getcharacterstatuses" }, { "name": "getErrorMessage", "declarationName": "getErrorMessage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Narrow an unknown caught value to a human-readable message.", "tags": [], "signatures": [ { "code": "declare function getErrorMessage(err: unknown): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 95, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "geterrormessage" }, { "name": "glyphCodeword", "declarationName": "glyphCodeword", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compact payload and BLAKE3 detection parity matching upstream glyph format v1.\nThis parity is not Reed–Solomon correction and is never authentication proof.", "tags": [], "signatures": [ { "code": "declare function glyphCodeword(did: string): Uint8Array;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 30, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "glyphcodeword" }, { "name": "glyphEndpoint", "declarationName": "glyphEndpoint", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "GET /v1/glyph/svg/:did. This endpoint always renders identity-derived pixels;\nprofile overrides are resolved by the caller, never fetched by this service.", "tags": [], "signatures": [ { "code": "declare function glyphEndpoint(request: Request): Response;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 39, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "glyphendpoint" }, { "name": "GlyphOptions", "declarationName": "GlyphOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface GlyphOptions {\n size?: number;\n background?: boolean;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 5, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "glyphoptions" }, { "name": "IdentityDocument", "declarationName": "IdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "OAS identity document fragment — minimum fields needed by the SDK.", "tags": [], "signatures": [ { "code": "interface IdentityDocument {\n did: Did;\n parent: Did;\n publicKeyMultibase: string;\n kind: string;\n scopes: readonly string[];\n createdAt: string;\n avatarOverride?: string | null;\n avatarSkin?: CharacterAppearance | null;\n avatarExpression?: AvatarExpression;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 9, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identitydocument" }, { "name": "identityDocumentSchema", "declarationName": "identityDocumentSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Runtime-validated identity document schema.", "tags": [], "signatures": [ { "code": "declare const identityDocumentSchema: z.ZodObject<{\n did: z.ZodEffects;\n parent: z.ZodEffects;\n publicKeyMultibase: z.ZodString;\n kind: z.ZodString;\n scopes: z.ZodReadonly>;\n createdAt: z.ZodString;\n avatarOverride: z.ZodEffects>, string | null | undefined, string | null | undefined>;\n avatarSkin: z.ZodOptional;\n skinVersion: z.ZodOptional>;\n eyeStyle: z.ZodOptional>;\n finish: z.ZodOptional>;\n eyePlacement: z.ZodOptional>;\n shape: z.ZodOptional,\n ...NonNullable[]\n ]>>;\n accessories: z.ZodOptional, \"many\">, readonly CharacterAccessory[], (\"glasses\" | \"headphones\")[]>>;\n }, \"strict\", z.ZodTypeAny, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n }, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n }>, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n }, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n }>>>;\n avatarExpression: z.ZodOptional>;\n metadata: z.ZodOptional>;\n}, \"strict\", z.ZodTypeAny, {\n parent: string;\n scopes: readonly string[];\n kind: string;\n did: string;\n publicKeyMultibase: string;\n createdAt: string;\n metadata?: Record | undefined;\n avatarOverride?: string | null | undefined;\n avatarSkin?: {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n } | null | undefined;\n avatarExpression?: \"neutral\" | \"attentive\" | \"surprised\" | \"excited\" | \"happy\" | \"laughing\" | \"angry\" | \"sad\" | \"scared\" | \"suspicious\" | \"confused\" | \"curious\" | \"proud\" | \"shy\" | \"unimpressed\" | \"sleepy\" | \"thoughtful\" | \"concerned\" | undefined;\n}, {\n parent: string;\n scopes: readonly string[];\n kind: string;\n did: string;\n publicKeyMultibase: string;\n createdAt: string;\n metadata?: Record | undefined;\n avatarOverride?: string | null | undefined;\n avatarSkin?: {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n } | null | undefined;\n avatarExpression?: \"neutral\" | \"attentive\" | \"surprised\" | \"excited\" | \"happy\" | \"laughing\" | \"angry\" | \"sad\" | \"scared\" | \"suspicious\" | \"confused\" | \"curious\" | \"proud\" | \"shy\" | \"unimpressed\" | \"sleepy\" | \"thoughtful\" | \"concerned\" | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 102, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identitydocumentschema" }, { "name": "IdentityError", "declarationName": "IdentityError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "OAS identity subsystem failure.", "tags": [], "signatures": [ { "code": "declare class IdentityError extends OpenAgentError {\n constructor(message: string, details: ErrorDetails);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 76, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "identityerror" }, { "name": "IdentityKeyPurpose", "declarationName": "IdentityKeyPurpose", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "DID verification relationships authorized by the authoritative resolver.", "tags": [], "signatures": [ { "code": "type IdentityKeyPurpose = 'authentication' | 'capabilityDelegation' | 'assertionMethod' | 'capabilityInvocation' | 'keyAgreement';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 48, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identitykeypurpose" }, { "name": "IdentityProvider", "declarationName": "IdentityProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The OAS identity facade. Concrete providers come from `@openagentid/oas-sdk`\n(production) or from {@link StubIdentityProvider } (test / offline dev).", "tags": [], "signatures": [ { "code": "interface IdentityProvider {\n createAgentIdentity(input: CreateAgentInput): Promise;\n resolve(did: Did): Promise;\n signChallenge(did: Did, challenge: Uint8Array): Promise;\n publicKey(did: Did): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 48, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identityprovider" }, { "name": "IdentityVerificationError", "declarationName": "IdentityVerificationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class IdentityVerificationError extends Error {\n readonly code: IdentityVerificationFailure;\n readonly name = \"IdentityVerificationError\";\n constructor(code: IdentityVerificationFailure, message: string);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 103, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverificationerror" }, { "name": "IdentityVerificationFailure", "declarationName": "IdentityVerificationFailure", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type IdentityVerificationFailure = 'invalid_proof' | 'untrusted_owner' | 'revoked' | 'replayed' | 'authority_unavailable';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 102, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverificationfailure" }, { "name": "IdentityVerificationHandlerOptions", "declarationName": "IdentityVerificationHandlerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface IdentityVerificationHandlerOptions {\n readonly audience: string;\n resolveNonce(request: Request): Promise;\n readonly maxBodyBytes?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 4, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "identityverificationhandleroptions" }, { "name": "IdentityVerifier", "declarationName": "IdentityVerifier", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Signed possession, authorized roots, delegation and live revocation checks.", "tags": [], "signatures": [ { "code": "declare class IdentityVerifier {\n constructor(config: IdentityVerifierConfig);\n verify(proof: AgentIdentityProof, options: VerifyIdentityOptions): Promise;\n verifyLineage(did: string, delegations: readonly string[], options: {\n audience: string;\n }): Promise;\n resolve(did: string, options: {\n audience: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 111, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverifier" }, { "name": "IdentityVerifierConfig", "declarationName": "IdentityVerifierConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface IdentityVerifierConfig {\n resolveDid(did: string): Promise;\n authorizeOwner(rootDid: string): Promise;\n authorizeSelfRoot?(rootDid: string, options: {\n audience: string;\n }): Promise;\n checkRevocation(check: RevocationCheck): Promise<{\n revoked: boolean;\n checkedAt: number;\n }>;\n replay: {\n consume(claim: ReplayClaim): Promise;\n };\n resolveDelegations?(did: string, audience: string): Promise;\n now?: () => number;\n maxProofAgeSeconds?: number;\n maxDelegationAgeSeconds?: number;\n maxRevocationAgeSeconds?: number;\n maxDepth?: number;\n clockToleranceSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 70, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverifierconfig" }, { "name": "InMemorySkillsPolicy", "declarationName": "InMemorySkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory, immutable skills policy. Every mutation returns a new instance.\n\nSupports two match modes:\n - Exact: `frontend-design` matches only `frontend-design`\n - Wildcard suffix: `frontend-*` matches `frontend-design`, `frontend-test`, ...", "tags": [], "signatures": [ { "code": "declare class InMemorySkillsPolicy implements SkillsPolicy {\n constructor(skills?: readonly SkillId[]);\n canInvoke(skill: SkillId): boolean;\n assertCanInvoke(skill: SkillId): void;\n listAllowed(): readonly SkillId[];\n grant(skill: SkillId): SkillsPolicy;\n revoke(skill: SkillId): SkillsPolicy;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 35, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "inmemoryskillspolicy" }, { "name": "InputValidationError", "declarationName": "InputValidationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Runtime input validation failure (Zod, boundary checks).", "tags": [], "signatures": [ { "code": "declare class InputValidationError extends OpenAgentError {\n constructor(message: string, cause?: unknown, context?: Record);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 72, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "inputvalidationerror" }, { "name": "isAgentAvatarDid", "declarationName": "isAgentAvatarDid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Supported agent avatar input, not registration, authorization or identity proof.", "tags": [], "signatures": [ { "code": "declare function isAgentAvatarDid(value: unknown): value is string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 22, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "isagentavatardid" }, { "name": "IssuedCredential", "declarationName": "IssuedCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A short-lived credential minted by the Arsenal broker.", "tags": [], "signatures": [ { "code": "interface IssuedCredential {\n provider: string;\n proxyUrl: string;\n expiresAt: number;\n remainingCalls?: number;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 32, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "issuedcredential" }, { "name": "KeyCryptoBinding", "declarationName": "KeyCryptoBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The crypto-wasm binding shape key custody consumes.", "tags": [], "signatures": [ { "code": "interface KeyCryptoBinding {\n ed25519_generate_keypair(): {\n signing_key: Uint8Array;\n verifying_key: Uint8Array;\n };\n ed25519_public_from_private(signingKey: Uint8Array): Uint8Array;\n x25519_generate_keypair(): {\n secret_key: Uint8Array;\n public_key: Uint8Array;\n };\n x25519_public_from_secret?(secretKey: Uint8Array): Uint8Array;\n blake3_derive_key(context: string, keyMaterial: Uint8Array): Uint8Array;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 219, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "keycryptobinding" }, { "name": "keys", "declarationName": "keys", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "The key-custody namespace.", "tags": [], "signatures": [ { "code": "declare const keys: {\n readonly generate: () => Promise;\n readonly fromSeed: (seed: Uint8Array) => AgentKeys;\n readonly fromSeedHex: (hex: string) => AgentKeys;\n readonly fromEnv: (envVar: string) => AgentKeys;\n readonly saveSeed: (keys: AgentKeys, path: string) => Promise;\n readonly fromSeedFile: (path: string) => Promise;\n readonly seedToHex: typeof toHex;\n readonly setCryptoBinding: typeof setKeyCryptoBinding;\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 249, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "keys" }, { "name": "LEGACY_DID_REGEX", "declarationName": "LEGACY_DID_REGEX", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Read existing legacy identities without rewriting their signed identifiers.", "tags": [], "signatures": [ { "code": "declare const LEGACY_DID_REGEX: RegExp;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 19, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "legacy_did_regex" }, { "name": "LineageAuthorityContext", "declarationName": "LineageAuthorityContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Sigil-backed lineage authority attached by an OAS verifier.", "tags": [], "signatures": [ { "code": "interface LineageAuthorityContext {\n readonly subject: Did;\n readonly source: string;\n readonly root: Did;\n readonly path: readonly Did[];\n readonly finalizedBlock: number;\n readonly pathKind: string;\n readonly scopes: readonly string[];\n readonly generation: number;\n readonly rootKind?: string;\n readonly orgRootCommitment?: string;\n readonly expiresAt?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 19, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "lineageauthoritycontext" }, { "name": "LiveEyeState", "declarationName": "LiveEyeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LiveEyeState {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink?: number;\n readonly gaze?: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 6, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "liveeyestate" }, { "name": "Logger", "declarationName": "Logger", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Logger interface — structured, dependency-free.", "tags": [], "signatures": [ { "code": "interface Logger {\n debug(msg: string, fields?: Record): void;\n info(msg: string, fields?: Record): void;\n warn(msg: string, fields?: Record): void;\n error(msg: string, fields?: Record): void;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 58, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "logger" }, { "name": "oasGlyph", "declarationName": "oasGlyph", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Deterministic SVG avatar. No network calls, private keys or raw DID markup.", "tags": [], "signatures": [ { "code": "declare function oasGlyph(did: string, options?: GlyphOptions): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 32, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "oasglyph" }, { "name": "OATS_WEIGHTS", "declarationName": "OATS_WEIGHTS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const OATS_WEIGHTS: Readonly<{\n SecurityAudit: 0.3;\n BenchmarkResult: 0.25;\n ExpertEndorsement: 0.2;\n PublisherBond: 0.15;\n CommunityReview: 0.1;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 4, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oats_weights" }, { "name": "OatsComponentScore", "declarationName": "OatsComponentScore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsComponentScore {\n readonly rawScore: number;\n readonly weight: number;\n readonly evidenceCount: number;\n readonly latestEvidence: string | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 76, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatscomponentscore" }, { "name": "OatsCompositeScore", "declarationName": "OatsCompositeScore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsCompositeScore {\n readonly entityDid: string;\n readonly components: Readonly>;\n readonly composite: number;\n readonly confidence: number;\n readonly evidenceCount: number;\n readonly computedAt: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 82, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatscompositescore" }, { "name": "OatsCredential", "declarationName": "OatsCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS VC; the adapter verifies its complete signed body and proof.", "tags": [], "signatures": [ { "code": "interface OatsCredential {\n readonly id: string;\n readonly issuer: string;\n readonly issuanceDate: string;\n readonly expirationDate?: string;\n readonly type: readonly string[];\n readonly oasAttestationType?: OatsEvidenceType;\n readonly credentialSubject: Readonly> & {\n readonly id: string;\n };\n readonly proof: Readonly>;\n readonly [extension: string]: unknown;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 13, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatscredential" }, { "name": "OatsError", "declarationName": "OatsError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class OatsError extends Error {\n readonly code: string;\n constructor(code: string, message: string);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 90, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatserror" }, { "name": "OatsEvidenceType", "declarationName": "OatsEvidenceType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type OatsEvidenceType = keyof typeof OATS_WEIGHTS;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 11, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsevidencetype" }, { "name": "OatsEvidenceVerifier", "declarationName": "OatsEvidenceVerifier", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Resolve keys from an authoritative source, verify the entire credential, and\nverify current identity roots, signed lineage and revocation for issuer and subject. Never derive\ntrusted keys or owner bindings from the submitted credential itself.", "tags": [], "signatures": [ { "code": "type OatsEvidenceVerifier = (credential: OatsCredential, context: OatsVerificationContext) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 49, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsevidenceverifier" }, { "name": "OatsEvidenceVerifierConfig", "declarationName": "OatsEvidenceVerifierConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsEvidenceVerifierConfig {\n readonly audience: string;\n readonly identity: IdentityVerifierConfig & {\n resolveDelegations(did: string, audience: string): Promise;\n };\n resolveIssuerAssertionMethods(did: string): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 59, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsevidenceverifierconfig" }, { "name": "OatsIssuerAssertionDocument", "declarationName": "OatsIssuerAssertionDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Keys already authorized for assertionMethod by the authoritative OAS resolver.", "tags": [], "signatures": [ { "code": "interface OatsIssuerAssertionDocument {\n readonly did: string;\n readonly assertionMethods: readonly {\n readonly id: string;\n readonly controller: string;\n readonly publicKeyJwk: JWK;\n }[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 51, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsissuerassertiondocument" }, { "name": "oatsMeetsThreshold", "declarationName": "oatsMeetsThreshold", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Both verified composite and confidence must meet the bounded thresholds.", "tags": [], "signatures": [ { "code": "declare function oatsMeetsThreshold(score: OatsCompositeScore, minimumComposite: number, minimumConfidence: number): boolean;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 109, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsmeetsthreshold" }, { "name": "OatsScorerOptions", "declarationName": "OatsScorerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsScorerOptions {\n readonly trustedIssuers: readonly string[];\n readonly verifyEvidence: OatsEvidenceVerifier;\n readonly now?: () => Date;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 69, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsscoreroptions" }, { "name": "OatsVerificationContext", "declarationName": "OatsVerificationContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsVerificationContext {\n readonly credentialId: string;\n readonly issuerDid: string;\n readonly subjectDid: string;\n readonly now: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 26, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsverificationcontext" }, { "name": "OpenAgent", "declarationName": "OpenAgent", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "`OpenAgent` — the public namespace. All calls delegate to a singleton\nruntime created lazily on first use. Most apps never need more than this.", "tags": [], "signatures": [ { "code": "declare const OpenAgent: {\n readonly configure: (config?: OpenAgentConfig) => OpenAgentRuntime;\n readonly runtime: () => OpenAgentRuntime;\n readonly createAgent: (input: CreateAgentInput) => Promise;\n readonly loadAgent: (did: Did, skills?: readonly SkillId[]) => Promise;\n readonly authenticate: (req: Request, options?: VerifyRequestOptions) => Promise;\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/agent.d.ts", "line": 83, "sha256": "4e91dc781061167237c1a06a016c753b9000054299cb7fb283635870e15134a8" } } ], "anchor": "openagent" }, { "name": "OpenAgentClients", "declarationName": "OpenAgentClients", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Forward-declared clients for the three wrapped subsystems.\n\nConcrete interfaces live in the per-module files so that this config file\ndoes not depend on internal implementation details.", "tags": [], "signatures": [ { "code": "interface OpenAgentClients {\n readonly identity?: unknown;\n readonly credentials?: unknown;\n readonly verification?: unknown;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 72, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "openagentclients" }, { "name": "OpenAgentConfig", "declarationName": "OpenAgentConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Global SDK configuration.\n\nAll fields are optional at construction. Identity, credentials and request\nverification each require their configured client when used. For a complete\nfile-backed Node identity authority, use the separate SDK `./local` export.", "tags": [], "signatures": [ { "code": "interface OpenAgentConfig {\n namespace?: string;\n endpoints?: {\n oasResolver?: string;\n arsenalBroker?: string;\n aegisVerifier?: string;\n };\n fetch?: typeof fetch;\n logger?: Logger;\n requestTimeoutMs?: number;\n clients?: OpenAgentClients;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 84, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "openagentconfig" }, { "name": "OpenAgentError", "declarationName": "OpenAgentError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Root of the OpenAgent SDK error hierarchy.\n\n```ts\ntry {\n await OpenAgent.createAgent({ ... });\n} catch (err) {\n if (err instanceof OpenAgentError) {\n console.error(err.code, err.message);\n }\n}\n```", "tags": [], "signatures": [ { "code": "declare class OpenAgentError extends Error {\n readonly code: ErrorCodeValue;\n readonly cause?: unknown;\n readonly context?: Record;\n constructor(message: string, details: ErrorDetails);\n toJSON(): Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 59, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "openagenterror" }, { "name": "OpenAgentInstance", "declarationName": "OpenAgentInstance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A live, fully-authenticated agent handle.", "tags": [], "signatures": [ { "code": "interface OpenAgentInstance {\n readonly did: Did;\n readonly document: IdentityDocument;\n skillsPolicy(): SkillsPolicy;\n withSkillsPolicy(policy: SkillsPolicy): OpenAgentInstance;\n credentialsFor(provider: string, scopes?: readonly string[]): Promise;\n identity(): IdentityProvider;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/agent.d.ts", "line": 32, "sha256": "4e91dc781061167237c1a06a016c753b9000054299cb7fb283635870e15134a8" } } ], "anchor": "openagentinstance" }, { "name": "OpenAgentRuntime", "declarationName": "OpenAgentRuntime", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Global, lazily-initialized OpenAgent runtime.\n\nThe default instance is populated by {@link OpenAgent.configure}. Callers\nwho need multiple runtimes in one process can instantiate `OpenAgentRuntime`\ndirectly.", "tags": [], "signatures": [ { "code": "declare class OpenAgentRuntime {\n constructor(config?: OpenAgentConfig);\n config(): Readonly;\n identity(): IdentityProvider;\n arsenal(): ArsenalClient;\n verification(): VerificationClient;\n createAgent(input: CreateAgentInput): Promise;\n loadAgent(did: Did, skills?: readonly SkillId[]): Promise;\n authenticate(req: Request, options?: VerifyRequestOptions): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/agent.d.ts", "line": 53, "sha256": "4e91dc781061167237c1a06a016c753b9000054299cb7fb283635870e15134a8" } } ], "anchor": "openagentruntime" }, { "name": "parseAvatarOverride", "declarationName": "parseAvatarOverride", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function parseAvatarOverride(value: unknown): string | null;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 33, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "parseavataroverride" }, { "name": "parseCharacterAccessories", "declarationName": "parseCharacterAccessories", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strict selection with canonical ordering; never retains a caller-owned array.", "tags": [], "signatures": [ { "code": "declare function parseCharacterAccessories(value: unknown): readonly CharacterAccessory[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 15, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "parsecharacteraccessories" }, { "name": "parseCharacterAppearance", "declarationName": "parseCharacterAppearance", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strict stored body/face selection; expression and live state belong elsewhere.", "tags": [], "signatures": [ { "code": "declare function parseCharacterAppearance(value: unknown): CharacterAppearance;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 88, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "parsecharacterappearance" }, { "name": "parseCharacterState", "declarationName": "parseCharacterState", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate an untrusted status snapshot without changing any identity/profile state.", "tags": [], "signatures": [ { "code": "declare function parseCharacterState(input: unknown, fallbackExpression?: AvatarExpression): CharacterRuntimeState;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 40, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "parsecharacterstate" }, { "name": "parseIdentityDocument", "declarationName": "parseIdentityDocument", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate an untrusted identity document. Throws {@link IdentityError } on failure.", "tags": [], "signatures": [ { "code": "declare function parseIdentityDocument(raw: unknown): IdentityDocument;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 193, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "parseidentitydocument" }, { "name": "PrivilegedAuthorityVerificationClient", "declarationName": "PrivilegedAuthorityVerificationClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Wraps any verifier and requires OAS/Sigil authority for privileged requests.", "tags": [], "signatures": [ { "code": "declare class PrivilegedAuthorityVerificationClient implements VerificationClient {\n constructor(inner: VerificationClient, authorityVerifier: PrivilegedAuthorityVerifier);\n verifyRequest(req: Request, options?: VerifyRequestOptions): Promise;\n issueChallenge(): Promise<{\n challenge: Uint8Array;\n challengeId: string;\n }>;\n verifyChallengeResponse(params: {\n challengeId: string;\n agentDid: Did;\n signatureBase64: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 117, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "privilegedauthorityverificationclient" }, { "name": "PrivilegedAuthorityVerifier", "declarationName": "PrivilegedAuthorityVerifier", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Runtime hook that turns an authenticated context into OAS/Sigil authority.", "tags": [], "signatures": [ { "code": "interface PrivilegedAuthorityVerifier {\n verify(ctx: AuthContext, options: VerifyRequestOptions): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 96, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "privilegedauthorityverifier" }, { "name": "providerSchema", "declarationName": "providerSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Provider identifier (e.g. `openai`, `github`, `stripe`).", "tags": [], "signatures": [ { "code": "declare const providerSchema: z.ZodString;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 24, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "providerschema" }, { "name": "RemoteIdentityVerificationOptions", "declarationName": "RemoteIdentityVerificationOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RemoteIdentityVerificationOptions {\n readonly nonce: string;\n readonly fetch?: typeof fetch;\n readonly signal?: AbortSignal;\n readonly timeoutMs?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 17, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "remoteidentityverificationoptions" }, { "name": "renderCharacterSvg", "declarationName": "renderCharacterSvg", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Render a character without retaining its descriptor.", "tags": [], "signatures": [ { "code": "declare function renderCharacterSvg(did: string, options?: CharacterOptions): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 94, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "rendercharactersvg" }, { "name": "ReplayClaim", "declarationName": "ReplayClaim", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ReplayClaim {\n readonly issuer: string;\n readonly tokenId: string;\n readonly audience: string;\n readonly nonce: string;\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 63, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "replayclaim" }, { "name": "RequireActConfig", "declarationName": "RequireActConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Policy for the middleware: the verifier bindings plus optional scopes.", "tags": [], "signatures": [ { "code": "interface RequireActConfig {\n issuer: string;\n audience: string;\n scopes?: string[];\n trustedKeys: Uint8Array[];\n leewaySeconds?: number;\n extractToken?: (req: Request) => Uint8Array | undefined;\n onUnauthorized?: (req: Request, reason: string) => Response;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 152, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "requireactconfig" }, { "name": "requireActExpress", "declarationName": "requireActExpress", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Express-compatible middleware factory.\n\nOn success, the verified claims land on `req.actClaims`; on failure the\nrequest is rejected with a 401 and never reaches the route.", "tags": [], "signatures": [ { "code": "declare function requireActExpress(config: RequireActConfig): (req: {\n headers: Record;\n actClaims?: ActClaims;\n}, res: {\n status: (code: number) => {\n json: (body: unknown) => unknown;\n };\n}, next: () => void) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 189, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "requireactexpress" }, { "name": "resolveConfig", "declarationName": "resolveConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Merge user config with defaults. Pure function — does not mutate input.", "tags": [], "signatures": [ { "code": "declare function resolveConfig(config?: OpenAgentConfig): ResolvedOpenAgentConfig;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 128, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "resolveconfig" }, { "name": "ResolvedIdentityDocument", "declarationName": "ResolvedIdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ResolvedIdentityDocument {\n readonly did: string;\n readonly verificationMethods: readonly {\n readonly id: string;\n readonly publicKeyJwk: JWK;\n readonly purposes: readonly IdentityKeyPurpose[];\n }[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 49, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "resolvedidentitydocument" }, { "name": "ResolvedOpenAgentConfig", "declarationName": "ResolvedOpenAgentConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Resolved configuration with all defaults applied.", "tags": [], "signatures": [ { "code": "interface ResolvedOpenAgentConfig {\n namespace: string;\n endpoints: {\n oasResolver?: string;\n arsenalBroker?: string;\n aegisVerifier?: string;\n };\n fetch: typeof fetch;\n logger: Logger;\n requestTimeoutMs: number;\n clients: OpenAgentClients;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 113, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "resolvedopenagentconfig" }, { "name": "RevocationCheck", "declarationName": "RevocationCheck", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RevocationCheck {\n readonly did: string;\n readonly issuerDid?: string;\n readonly credentialId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 58, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "revocationcheck" }, { "name": "scopeSchema", "declarationName": "scopeSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "A parsed OAS scope string such as `openai:chat:completions`.", "tags": [], "signatures": [ { "code": "declare const scopeSchema: z.ZodString;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 22, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "scopeschema" }, { "name": "SelfRootAuthorization", "declarationName": "SelfRootAuthorization", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Current, server-authorized self-root registration; never supplied by the proof.", "tags": [], "signatures": [ { "code": "interface SelfRootAuthorization {\n readonly did: string;\n readonly audience: string;\n readonly authorizationId: string;\n readonly revision: string;\n readonly issuedAt: number;\n readonly notBefore: number;\n readonly expiresAt: number;\n readonly checkedAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 32, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "selfrootauthorization" }, { "name": "setActCryptoBinding", "declarationName": "setActCryptoBinding", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Inject the crypto-wasm binding. Called by consumers at startup (and by\ntests with a mock). The binding is the `@openagentid/crypto-wasm` module's\nnodejs or bundler build, already instantiated.", "tags": [], "signatures": [ { "code": "declare function setActCryptoBinding(binding: ActVerifyBinding): void;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 100, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "setactcryptobinding" }, { "name": "setKeyCryptoBinding", "declarationName": "setKeyCryptoBinding", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Inject the crypto-wasm binding (same one as {@link setActCryptoBinding}).", "tags": [], "signatures": [ { "code": "declare function setKeyCryptoBinding(binding: KeyCryptoBinding): void;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 233, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "setkeycryptobinding" }, { "name": "SignedAssertion", "declarationName": "SignedAssertion", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Signed credential returned by the identity provider.", "tags": [], "signatures": [ { "code": "interface SignedAssertion {\n token: string;\n signature: string;\n signer: Did;\n issuedAt: number;\n expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 32, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "signedassertion" }, { "name": "silentLogger", "declarationName": "silentLogger", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "No-op logger used by default.", "tags": [], "signatures": [ { "code": "declare const silentLogger: Logger;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 65, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "silentlogger" }, { "name": "SkillDeniedError", "declarationName": "SkillDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Skills policy denial.", "tags": [], "signatures": [ { "code": "declare class SkillDeniedError extends OpenAgentError {\n readonly skill: string;\n constructor(skill: string, reason?: string, context?: Record);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 88, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "skilldeniederror" }, { "name": "SkillId", "declarationName": "SkillId", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A skill identifier such as `frontend-design` or `sql-query`.", "tags": [], "signatures": [ { "code": "type SkillId = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 14, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "skillid" }, { "name": "SkillsPolicy", "declarationName": "SkillsPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The minimum contract the OpenAgent SDK expects from a skills policy.", "tags": [], "signatures": [ { "code": "interface SkillsPolicy {\n canInvoke(skill: SkillId): boolean;\n assertCanInvoke(skill: SkillId): void;\n listAllowed(): readonly SkillId[];\n grant(skill: SkillId): SkillsPolicy;\n revoke(skill: SkillId): SkillsPolicy;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 16, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "skillspolicy" }, { "name": "toIdentityProvider", "declarationName": "toIdentityProvider", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Narrow any unknown value into an {@link IdentityProvider}, or throw.\n\nThis is the integration point where `@openagentid/oas-sdk`'s client is adapted into\nour interface. When that SDK is finalized, replace the duck-typing below\nwith a direct import.", "tags": [], "signatures": [ { "code": "declare function toIdentityProvider(client: unknown): IdentityProvider;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 201, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "toidentityprovider" }, { "name": "toVerificationClient", "declarationName": "toVerificationClient", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Narrow any unknown value into a {@link VerificationClient}, or throw.\nDuck-typed for forward compatibility with `@openagentid/aegis-sdk`.", "tags": [], "signatures": [ { "code": "declare function toVerificationClient(client: unknown): VerificationClient;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 115, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "toverificationclient" }, { "name": "VerificationClient", "declarationName": "VerificationClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "AEGIS verifier facade. Concrete implementation lives in `@openagentid/aegis-sdk`.\n\nThe OpenAgent SDK never decodes assertions itself — it delegates to\nAEGIS for all verification, lineage walking, and policy evaluation.", "tags": [], "signatures": [ { "code": "interface VerificationClient {\n verifyRequest(req: Request, options?: VerifyRequestOptions): Promise;\n issueChallenge(): Promise<{\n challenge: Uint8Array;\n challengeId: string;\n }>;\n verifyChallengeResponse(params: {\n challengeId: string;\n agentDid: Did;\n signatureBase64: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 81, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verificationclient" }, { "name": "VerificationError", "declarationName": "VerificationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "AEGIS verification subsystem failure.", "tags": [], "signatures": [ { "code": "declare class VerificationError extends OpenAgentError {\n constructor(message: string, details: ErrorDetails);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 84, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "verificationerror" }, { "name": "VerifiedAgentIdentity", "declarationName": "VerifiedAgentIdentity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Current identity trust. This grants no application scopes or tenant access.", "tags": [], "signatures": [ { "code": "type VerifiedAgentIdentity = CommonAgentIdentity & ({\n readonly owner: VerifiedOwner;\n readonly root?: {\n readonly kind: 'lifeid';\n readonly did: string;\n };\n} | {\n readonly owner: null;\n readonly root: {\n readonly kind: 'self';\n readonly did: string;\n readonly authorizationId: string;\n readonly revision: string;\n };\n});", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 16, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedagentidentity" }, { "name": "VerifiedOatsEvidence", "declarationName": "VerifiedOatsEvidence", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Return only after the exact credential signature and both identities pass.", "tags": [], "signatures": [ { "code": "interface VerifiedOatsEvidence {\n readonly credentialId: string;\n readonly issuerDid: string;\n readonly subjectDid: string;\n readonly signatureVerified: true;\n readonly credentialRevocationChecked: true;\n readonly issuer: VerifiedAgentIdentity;\n readonly subject: VerifiedAgentIdentity;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 34, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "verifiedoatsevidence" }, { "name": "VerifiedOatsScorer", "declarationName": "VerifiedOatsScorer", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class VerifiedOatsScorer {\n constructor(options: OatsScorerOptions);\n score(entityDid: string, credentials: readonly unknown[]): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 100, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "verifiedoatsscorer" }, { "name": "VerifiedOwner", "declarationName": "VerifiedOwner", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifiedOwner {\n readonly issuer: string;\n readonly subject: string;\n readonly organizationId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 3, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedowner" }, { "name": "VerifyIdentityOptions", "declarationName": "VerifyIdentityOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifyIdentityOptions {\n readonly audience: string;\n readonly nonce: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 97, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifyidentityoptions" }, { "name": "verifyIdentityRemote", "declarationName": "verifyIdentityRemote", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "The configured service is a trust authority. HTTPS protects its returned verdict.", "tags": [], "signatures": [ { "code": "declare function verifyIdentityRemote(endpoint: string, proof: AgentIdentityProof, options: RemoteIdentityVerificationOptions): Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 24, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "verifyidentityremote" }, { "name": "VerifyRequestOptions", "declarationName": "VerifyRequestOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for {@link VerificationClient.verifyRequest}.", "tags": [], "signatures": [ { "code": "interface VerifyRequestOptions {\n requiredScopes?: readonly string[];\n requiredAncestor?: Did;\n requirePrivilegedAuthority?: boolean;\n requiredAuthorityPath?: string;\n clockSkewSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 63, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verifyrequestoptions" }, { "name": "VERSION", "declarationName": "VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "SDK version — kept in sync with `package.json`.", "tags": [], "signatures": [ { "code": "declare const VERSION = \"0.6.0\";", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 298, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "version" }, { "name": "withAct", "declarationName": "withAct", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Fetch-standard middleware factory.\n\nReturns a handler that takes `(request, claims)`. A request whose token is\nmissing, malformed, forged, expired, wrong-audience, or under-scoped gets\na 401 with the reason — the handler never runs, and unauthenticated claims\nnever reach the application.", "tags": [], "signatures": [ { "code": "declare function withAct(config: RequireActConfig, handler: (req: Request, claims: ActClaims) => Promise | Response): (req: Request) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 182, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "withact" }, { "name": "wrapError", "declarationName": "wrapError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Wraps any non-OpenAgentError into the SDK hierarchy without losing the cause.", "tags": [], "signatures": [ { "code": "declare function wrapError(err: unknown, fallbackMessage: string): OpenAgentError;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 93, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "wraperror" } ], "supportingDeclarations": [ { "name": "ActVerifyBinding", "declarationName": "ActVerifyBinding", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The crypto-wasm binding shape this module consumes.", "tags": [], "signatures": [ { "code": "interface ActVerifyBinding {\n act_verify(token: Uint8Array, trustedKeys: Uint8Array, issuer: string, audience: string, scopes: string[], leewaySeconds: bigint, nowUnixSeconds: bigint): string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 92, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "actverifybinding" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CommonAgentIdentity", "declarationName": "CommonAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CommonAgentIdentity {\n readonly did: string;\n readonly lineage: readonly string[];\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 8, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "commonagentidentity" }, { "name": "CreateCredentialHandleParams", "declarationName": "CreateCredentialHandleParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Arguments for constructing a credential handle.", "tags": [], "signatures": [ { "code": "interface CreateCredentialHandleParams {\n agentDid: Did;\n provider: string;\n arsenal: ArsenalClient;\n fetchImpl: typeof fetch;\n requestTimeoutMs: number;\n scopes?: readonly string[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 87, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "createcredentialhandleparams" }, { "name": "toHex", "declarationName": "toHex", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function toHex(bytes: Uint8Array): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/index.d.ts", "line": 247, "sha256": "cfa8f33043e68241e03fcecc06184058cbe6230f0e1d891c2f7227dd577be3d7" } } ], "anchor": "tohex" } ], "coverage": { "discovered": 151, "documented": 151, "missing": [] } }, { "subpath": "./agent", "importSpecifier": "@openagentid/sdk/agent", "page": "/reference/typescript/sdk/agent", "kind": "declarations", "conditions": { "types": "./dist/agent.d.ts", "import": "./dist/agent.js", "require": "./dist/agent.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/agent.d.ts" }, { "conditions": [ "import" ], "path": "./dist/agent.js" }, { "conditions": [ "require" ], "path": "./dist/agent.cjs" } ], "exports": [ { "name": "OpenAgent", "declarationName": "OpenAgent", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "`OpenAgent` — the public namespace. All calls delegate to a singleton\nruntime created lazily on first use. Most apps never need more than this.", "tags": [], "signatures": [ { "code": "declare const OpenAgent: {\n readonly configure: (config?: OpenAgentConfig) => OpenAgentRuntime;\n readonly runtime: () => OpenAgentRuntime;\n readonly createAgent: (input: CreateAgentInput) => Promise;\n readonly loadAgent: (did: Did, skills?: readonly SkillId[]) => Promise;\n readonly authenticate: (req: Request, options?: VerifyRequestOptions) => Promise;\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/agent.d.ts", "line": 83, "sha256": "4e91dc781061167237c1a06a016c753b9000054299cb7fb283635870e15134a8" } } ], "anchor": "openagent" }, { "name": "OpenAgentInstance", "declarationName": "OpenAgentInstance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A live, fully-authenticated agent handle.", "tags": [], "signatures": [ { "code": "interface OpenAgentInstance {\n readonly did: Did;\n readonly document: IdentityDocument;\n skillsPolicy(): SkillsPolicy;\n withSkillsPolicy(policy: SkillsPolicy): OpenAgentInstance;\n credentialsFor(provider: string, scopes?: readonly string[]): Promise;\n identity(): IdentityProvider;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/agent.d.ts", "line": 32, "sha256": "4e91dc781061167237c1a06a016c753b9000054299cb7fb283635870e15134a8" } } ], "anchor": "openagentinstance" }, { "name": "OpenAgentRuntime", "declarationName": "OpenAgentRuntime", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Global, lazily-initialized OpenAgent runtime.\n\nThe default instance is populated by {@link OpenAgent.configure}. Callers\nwho need multiple runtimes in one process can instantiate `OpenAgentRuntime`\ndirectly.", "tags": [], "signatures": [ { "code": "declare class OpenAgentRuntime {\n constructor(config?: OpenAgentConfig);\n config(): Readonly;\n identity(): IdentityProvider;\n arsenal(): ArsenalClient;\n verification(): VerificationClient;\n createAgent(input: CreateAgentInput): Promise;\n loadAgent(did: Did, skills?: readonly SkillId[]): Promise;\n authenticate(req: Request, options?: VerifyRequestOptions): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/agent.d.ts", "line": 53, "sha256": "4e91dc781061167237c1a06a016c753b9000054299cb7fb283635870e15134a8" } } ], "anchor": "openagentruntime" } ], "supportingDeclarations": [ { "name": "ArsenalClient", "declarationName": "ArsenalClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Arsenal broker client facade. The real client lives in `@openagentid/arsenal-sdk`\nand is injected by the application; see `INTEGRATION_NOTES.md`.", "tags": [], "signatures": [ { "code": "interface ArsenalClient {\n requestCredential(params: {\n agentDid: Did;\n provider: string;\n scopes?: readonly string[];\n }): Promise;\n release?(credentialProxyUrl: string): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 51, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "arsenalclient" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A resolved, authenticated caller identity.", "tags": [], "signatures": [ { "code": "interface AuthContext {\n readonly did: Did;\n readonly root: Did;\n readonly lineage: readonly Did[];\n readonly lineageAuthority?: LineageAuthorityContext;\n readonly scopes: readonly string[];\n readonly expiresAt: number;\n readonly presentedToken?: string;\n readonly claims?: Readonly>;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 44, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "authcontext" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CreateAgentInput", "declarationName": "CreateAgentInput", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CreateAgentInput = z.infer;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 56, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinput" }, { "name": "createAgentInputSchema", "declarationName": "createAgentInputSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Parameters accepted by {@link OpenAgent.createAgent }.", "tags": [], "signatures": [ { "code": "declare const createAgentInputSchema: z.ZodObject<{\n parent: z.ZodEffects;\n name: z.ZodString;\n scopes: z.ZodArray;\n namespace: z.ZodOptional;\n skills: z.ZodOptional>;\n metadata: z.ZodOptional>;\n}, \"strict\", z.ZodTypeAny, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 28, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinputschema" }, { "name": "CredentialHandle", "declarationName": "CredentialHandle", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A live, fetch-ready credential bound to an agent DID + provider.\n\nThe fetch method is a drop-in replacement for `globalThis.fetch`. The\nunderlying credential is refreshed lazily when the caller invokes\n`refresh()` — auto-rotation stays out of the per-request hot path.", "tags": [], "signatures": [ { "code": "interface CredentialHandle {\n readonly provider: string;\n readonly agentDid: Did;\n readonly expiresAt: number;\n fetch: typeof fetch;\n refresh(): Promise;\n release(): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 68, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "credentialhandle" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Fully qualified `did:oas` identifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 7, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "did" }, { "name": "IdentityDocument", "declarationName": "IdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "OAS identity document fragment — minimum fields needed by the SDK.", "tags": [], "signatures": [ { "code": "interface IdentityDocument {\n did: Did;\n parent: Did;\n publicKeyMultibase: string;\n kind: string;\n scopes: readonly string[];\n createdAt: string;\n avatarOverride?: string | null;\n avatarSkin?: CharacterAppearance | null;\n avatarExpression?: AvatarExpression;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 9, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identitydocument" }, { "name": "IdentityProvider", "declarationName": "IdentityProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The OAS identity facade. Concrete providers come from `@openagentid/oas-sdk`\n(production) or from {@link StubIdentityProvider } (test / offline dev).", "tags": [], "signatures": [ { "code": "interface IdentityProvider {\n createAgentIdentity(input: CreateAgentInput): Promise;\n resolve(did: Did): Promise;\n signChallenge(did: Did, challenge: Uint8Array): Promise;\n publicKey(did: Did): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 48, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identityprovider" }, { "name": "IssuedCredential", "declarationName": "IssuedCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A short-lived credential minted by the Arsenal broker.", "tags": [], "signatures": [ { "code": "interface IssuedCredential {\n provider: string;\n proxyUrl: string;\n expiresAt: number;\n remainingCalls?: number;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 32, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "issuedcredential" }, { "name": "LineageAuthorityContext", "declarationName": "LineageAuthorityContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Sigil-backed lineage authority attached by an OAS verifier.", "tags": [], "signatures": [ { "code": "interface LineageAuthorityContext {\n readonly subject: Did;\n readonly source: string;\n readonly root: Did;\n readonly path: readonly Did[];\n readonly finalizedBlock: number;\n readonly pathKind: string;\n readonly scopes: readonly string[];\n readonly generation: number;\n readonly rootKind?: string;\n readonly orgRootCommitment?: string;\n readonly expiresAt?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 19, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "lineageauthoritycontext" }, { "name": "Logger", "declarationName": "Logger", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Logger interface — structured, dependency-free.", "tags": [], "signatures": [ { "code": "interface Logger {\n debug(msg: string, fields?: Record): void;\n info(msg: string, fields?: Record): void;\n warn(msg: string, fields?: Record): void;\n error(msg: string, fields?: Record): void;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 58, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "logger" }, { "name": "OpenAgentClients", "declarationName": "OpenAgentClients", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Forward-declared clients for the three wrapped subsystems.\n\nConcrete interfaces live in the per-module files so that this config file\ndoes not depend on internal implementation details.", "tags": [], "signatures": [ { "code": "interface OpenAgentClients {\n readonly identity?: unknown;\n readonly credentials?: unknown;\n readonly verification?: unknown;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 72, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "openagentclients" }, { "name": "OpenAgentConfig", "declarationName": "OpenAgentConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Global SDK configuration.\n\nAll fields are optional at construction. Identity, credentials and request\nverification each require their configured client when used. For a complete\nfile-backed Node identity authority, use the separate SDK `./local` export.", "tags": [], "signatures": [ { "code": "interface OpenAgentConfig {\n namespace?: string;\n endpoints?: {\n oasResolver?: string;\n arsenalBroker?: string;\n aegisVerifier?: string;\n };\n fetch?: typeof fetch;\n logger?: Logger;\n requestTimeoutMs?: number;\n clients?: OpenAgentClients;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 84, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "openagentconfig" }, { "name": "ResolvedOpenAgentConfig", "declarationName": "ResolvedOpenAgentConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Resolved configuration with all defaults applied.", "tags": [], "signatures": [ { "code": "interface ResolvedOpenAgentConfig {\n namespace: string;\n endpoints: {\n oasResolver?: string;\n arsenalBroker?: string;\n aegisVerifier?: string;\n };\n fetch: typeof fetch;\n logger: Logger;\n requestTimeoutMs: number;\n clients: OpenAgentClients;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 113, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "resolvedopenagentconfig" }, { "name": "SignedAssertion", "declarationName": "SignedAssertion", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Signed credential returned by the identity provider.", "tags": [], "signatures": [ { "code": "interface SignedAssertion {\n token: string;\n signature: string;\n signer: Did;\n issuedAt: number;\n expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 32, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "signedassertion" }, { "name": "SkillId", "declarationName": "SkillId", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A skill identifier such as `frontend-design` or `sql-query`.", "tags": [], "signatures": [ { "code": "type SkillId = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 14, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "skillid" }, { "name": "SkillsPolicy", "declarationName": "SkillsPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The minimum contract the OpenAgent SDK expects from a skills policy.", "tags": [], "signatures": [ { "code": "interface SkillsPolicy {\n canInvoke(skill: SkillId): boolean;\n assertCanInvoke(skill: SkillId): void;\n listAllowed(): readonly SkillId[];\n grant(skill: SkillId): SkillsPolicy;\n revoke(skill: SkillId): SkillsPolicy;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 16, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "skillspolicy" }, { "name": "VerificationClient", "declarationName": "VerificationClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "AEGIS verifier facade. Concrete implementation lives in `@openagentid/aegis-sdk`.\n\nThe OpenAgent SDK never decodes assertions itself — it delegates to\nAEGIS for all verification, lineage walking, and policy evaluation.", "tags": [], "signatures": [ { "code": "interface VerificationClient {\n verifyRequest(req: Request, options?: VerifyRequestOptions): Promise;\n issueChallenge(): Promise<{\n challenge: Uint8Array;\n challengeId: string;\n }>;\n verifyChallengeResponse(params: {\n challengeId: string;\n agentDid: Did;\n signatureBase64: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 81, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verificationclient" }, { "name": "VerifyRequestOptions", "declarationName": "VerifyRequestOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for {@link VerificationClient.verifyRequest}.", "tags": [], "signatures": [ { "code": "interface VerifyRequestOptions {\n requiredScopes?: readonly string[];\n requiredAncestor?: Did;\n requirePrivilegedAuthority?: boolean;\n requiredAuthorityPath?: string;\n clockSkewSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 63, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verifyrequestoptions" } ], "coverage": { "discovered": 3, "documented": 3, "missing": [] } }, { "subpath": "./identity", "importSpecifier": "@openagentid/sdk/identity", "page": "/reference/typescript/sdk/identity", "kind": "declarations", "conditions": { "types": "./dist/identity.d.ts", "import": "./dist/identity.js", "require": "./dist/identity.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/identity.d.ts" }, { "conditions": [ "import" ], "path": "./dist/identity.js" }, { "conditions": [ "require" ], "path": "./dist/identity.cjs" } ], "exports": [ { "name": "avatarExpressionSchema", "declarationName": "avatarExpressionSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const avatarExpressionSchema: z.ZodEnum<[\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n]>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 100, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "avatarexpressionschema" }, { "name": "characterAppearanceSchema", "declarationName": "characterAppearanceSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Versioned body/face selection. Runtime expression and gaze are independent.", "tags": [], "signatures": [ { "code": "declare const characterAppearanceSchema: z.ZodEffects;\n skinVersion: z.ZodOptional>;\n eyeStyle: z.ZodOptional>;\n finish: z.ZodOptional>;\n eyePlacement: z.ZodOptional>;\n shape: z.ZodOptional,\n ...NonNullable[]\n ]>>;\n accessories: z.ZodOptional, \"many\">, readonly CharacterAccessory[], (\"glasses\" | \"headphones\")[]>>;\n}, \"strict\", z.ZodTypeAny, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n}, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n}>, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n}, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 59, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "characterappearanceschema" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Fully qualified `did:oas` identifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 7, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "did" }, { "name": "IdentityDocument", "declarationName": "IdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "OAS identity document fragment — minimum fields needed by the SDK.", "tags": [], "signatures": [ { "code": "interface IdentityDocument {\n did: Did;\n parent: Did;\n publicKeyMultibase: string;\n kind: string;\n scopes: readonly string[];\n createdAt: string;\n avatarOverride?: string | null;\n avatarSkin?: CharacterAppearance | null;\n avatarExpression?: AvatarExpression;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 9, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identitydocument" }, { "name": "identityDocumentSchema", "declarationName": "identityDocumentSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Runtime-validated identity document schema.", "tags": [], "signatures": [ { "code": "declare const identityDocumentSchema: z.ZodObject<{\n did: z.ZodEffects;\n parent: z.ZodEffects;\n publicKeyMultibase: z.ZodString;\n kind: z.ZodString;\n scopes: z.ZodReadonly>;\n createdAt: z.ZodString;\n avatarOverride: z.ZodEffects>, string | null | undefined, string | null | undefined>;\n avatarSkin: z.ZodOptional;\n skinVersion: z.ZodOptional>;\n eyeStyle: z.ZodOptional>;\n finish: z.ZodOptional>;\n eyePlacement: z.ZodOptional>;\n shape: z.ZodOptional,\n ...NonNullable[]\n ]>>;\n accessories: z.ZodOptional, \"many\">, readonly CharacterAccessory[], (\"glasses\" | \"headphones\")[]>>;\n }, \"strict\", z.ZodTypeAny, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n }, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n }>, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n }, {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n }>>>;\n avatarExpression: z.ZodOptional>;\n metadata: z.ZodOptional>;\n}, \"strict\", z.ZodTypeAny, {\n parent: string;\n scopes: readonly string[];\n kind: string;\n did: string;\n publicKeyMultibase: string;\n createdAt: string;\n metadata?: Record | undefined;\n avatarOverride?: string | null | undefined;\n avatarSkin?: {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: readonly CharacterAccessory[] | undefined;\n } | null | undefined;\n avatarExpression?: \"neutral\" | \"attentive\" | \"surprised\" | \"excited\" | \"happy\" | \"laughing\" | \"angry\" | \"sad\" | \"scared\" | \"suspicious\" | \"confused\" | \"curious\" | \"proud\" | \"shy\" | \"unimpressed\" | \"sleepy\" | \"thoughtful\" | \"concerned\" | undefined;\n}, {\n parent: string;\n scopes: readonly string[];\n kind: string;\n did: string;\n publicKeyMultibase: string;\n createdAt: string;\n metadata?: Record | undefined;\n avatarOverride?: string | null | undefined;\n avatarSkin?: {\n skin: CharacterSkin;\n skinVersion?: 1 | undefined;\n eyeStyle?: \"live-v1\" | undefined;\n finish?: \"flat\" | \"plush\" | undefined;\n eyePlacement?: \"face\" | \"raised\" | undefined;\n shape?: NonNullable | undefined;\n accessories?: (\"glasses\" | \"headphones\")[] | undefined;\n } | null | undefined;\n avatarExpression?: \"neutral\" | \"attentive\" | \"surprised\" | \"excited\" | \"happy\" | \"laughing\" | \"angry\" | \"sad\" | \"scared\" | \"suspicious\" | \"confused\" | \"curious\" | \"proud\" | \"shy\" | \"unimpressed\" | \"sleepy\" | \"thoughtful\" | \"concerned\" | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 102, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identitydocumentschema" }, { "name": "IdentityProvider", "declarationName": "IdentityProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The OAS identity facade. Concrete providers come from `@openagentid/oas-sdk`\n(production) or from {@link StubIdentityProvider } (test / offline dev).", "tags": [], "signatures": [ { "code": "interface IdentityProvider {\n createAgentIdentity(input: CreateAgentInput): Promise;\n resolve(did: Did): Promise;\n signChallenge(did: Did, challenge: Uint8Array): Promise;\n publicKey(did: Did): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 48, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identityprovider" }, { "name": "parseIdentityDocument", "declarationName": "parseIdentityDocument", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate an untrusted identity document. Throws {@link IdentityError } on failure.", "tags": [], "signatures": [ { "code": "declare function parseIdentityDocument(raw: unknown): IdentityDocument;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 193, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "parseidentitydocument" }, { "name": "SignedAssertion", "declarationName": "SignedAssertion", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Signed credential returned by the identity provider.", "tags": [], "signatures": [ { "code": "interface SignedAssertion {\n token: string;\n signature: string;\n signer: Did;\n issuedAt: number;\n expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 32, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "signedassertion" }, { "name": "toIdentityProvider", "declarationName": "toIdentityProvider", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Narrow any unknown value into an {@link IdentityProvider}, or throw.\n\nThis is the integration point where `@openagentid/oas-sdk`'s client is adapted into\nour interface. When that SDK is finalized, replace the duck-typing below\nwith a direct import.", "tags": [], "signatures": [ { "code": "declare function toIdentityProvider(client: unknown): IdentityProvider;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 201, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "toidentityprovider" } ], "supportingDeclarations": [ { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CreateAgentInput", "declarationName": "CreateAgentInput", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CreateAgentInput = z.infer;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 56, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinput" }, { "name": "createAgentInputSchema", "declarationName": "createAgentInputSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Parameters accepted by {@link OpenAgent.createAgent }.", "tags": [], "signatures": [ { "code": "declare const createAgentInputSchema: z.ZodObject<{\n parent: z.ZodEffects;\n name: z.ZodString;\n scopes: z.ZodArray;\n namespace: z.ZodOptional;\n skills: z.ZodOptional>;\n metadata: z.ZodOptional>;\n}, \"strict\", z.ZodTypeAny, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 28, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinputschema" } ], "coverage": { "discovered": 9, "documented": 9, "missing": [] } }, { "subpath": "./credentials", "importSpecifier": "@openagentid/sdk/credentials", "page": "/reference/typescript/sdk/credentials", "kind": "declarations", "conditions": { "types": "./dist/credentials.d.ts", "import": "./dist/credentials.js", "require": "./dist/credentials.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/credentials.d.ts" }, { "conditions": [ "import" ], "path": "./dist/credentials.js" }, { "conditions": [ "require" ], "path": "./dist/credentials.cjs" } ], "exports": [ { "name": "ArsenalClient", "declarationName": "ArsenalClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Arsenal broker client facade. The real client lives in `@openagentid/arsenal-sdk`\nand is injected by the application; see `INTEGRATION_NOTES.md`.", "tags": [], "signatures": [ { "code": "interface ArsenalClient {\n requestCredential(params: {\n agentDid: Did;\n provider: string;\n scopes?: readonly string[];\n }): Promise;\n release?(credentialProxyUrl: string): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 51, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "arsenalclient" }, { "name": "createCredentialHandle", "declarationName": "createCredentialHandle", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Create a {@link CredentialHandle} backed by an Arsenal client.", "tags": [], "signatures": [ { "code": "declare function createCredentialHandle(params: CreateCredentialHandleParams): Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 96, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "createcredentialhandle" }, { "name": "CreateCredentialHandleParams", "declarationName": "CreateCredentialHandleParams", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Arguments for constructing a credential handle.", "tags": [], "signatures": [ { "code": "interface CreateCredentialHandleParams {\n agentDid: Did;\n provider: string;\n arsenal: ArsenalClient;\n fetchImpl: typeof fetch;\n requestTimeoutMs: number;\n scopes?: readonly string[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 87, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "createcredentialhandleparams" }, { "name": "CredentialHandle", "declarationName": "CredentialHandle", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A live, fetch-ready credential bound to an agent DID + provider.\n\nThe fetch method is a drop-in replacement for `globalThis.fetch`. The\nunderlying credential is refreshed lazily when the caller invokes\n`refresh()` — auto-rotation stays out of the per-request hot path.", "tags": [], "signatures": [ { "code": "interface CredentialHandle {\n readonly provider: string;\n readonly agentDid: Did;\n readonly expiresAt: number;\n fetch: typeof fetch;\n refresh(): Promise;\n release(): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 68, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "credentialhandle" }, { "name": "IssuedCredential", "declarationName": "IssuedCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A short-lived credential minted by the Arsenal broker.", "tags": [], "signatures": [ { "code": "interface IssuedCredential {\n provider: string;\n proxyUrl: string;\n expiresAt: number;\n remainingCalls?: number;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 32, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "issuedcredential" } ], "supportingDeclarations": [ { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Fully qualified `did:oas` identifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 7, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "did" } ], "coverage": { "discovered": 5, "documented": 5, "missing": [] } }, { "subpath": "./verification", "importSpecifier": "@openagentid/sdk/verification", "page": "/reference/typescript/sdk/verification", "kind": "declarations", "conditions": { "types": "./dist/verification.d.ts", "import": "./dist/verification.js", "require": "./dist/verification.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/verification.d.ts" }, { "conditions": [ "import" ], "path": "./dist/verification.js" }, { "conditions": [ "require" ], "path": "./dist/verification.cjs" } ], "exports": [ { "name": "assertAncestor", "declarationName": "assertAncestor", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Assert that `ctx.lineage` contains `ancestor`.", "tags": [], "signatures": [ { "code": "declare function assertAncestor(ctx: AuthContext, ancestor: Did): void;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 110, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "assertancestor" }, { "name": "assertScopes", "declarationName": "assertScopes", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Assert that `ctx` holds every scope in `required`.", "tags": [], "signatures": [ { "code": "declare function assertScopes(ctx: AuthContext, required: readonly string[]): void;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 108, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "assertscopes" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A resolved, authenticated caller identity.", "tags": [], "signatures": [ { "code": "interface AuthContext {\n readonly did: Did;\n readonly root: Did;\n readonly lineage: readonly Did[];\n readonly lineageAuthority?: LineageAuthorityContext;\n readonly scopes: readonly string[];\n readonly expiresAt: number;\n readonly presentedToken?: string;\n readonly claims?: Readonly>;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 44, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "authcontext" }, { "name": "extractBearerToken", "declarationName": "extractBearerToken", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Extract the bearer token from a `Request` without trusting it.\n\nChecks, in order: `Authorization: OpenAgent ...`,\n`Authorization: Bearer ...`, `X-OpenAgent-Token`, and an `oa_token`\nquery parameter. Returns `null` if absent.", "tags": [], "signatures": [ { "code": "declare function extractBearerToken(req: Request): string | null;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 106, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "extractbearertoken" }, { "name": "LineageAuthorityContext", "declarationName": "LineageAuthorityContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Sigil-backed lineage authority attached by an OAS verifier.", "tags": [], "signatures": [ { "code": "interface LineageAuthorityContext {\n readonly subject: Did;\n readonly source: string;\n readonly root: Did;\n readonly path: readonly Did[];\n readonly finalizedBlock: number;\n readonly pathKind: string;\n readonly scopes: readonly string[];\n readonly generation: number;\n readonly rootKind?: string;\n readonly orgRootCommitment?: string;\n readonly expiresAt?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 19, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "lineageauthoritycontext" }, { "name": "PrivilegedAuthorityVerificationClient", "declarationName": "PrivilegedAuthorityVerificationClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Wraps any verifier and requires OAS/Sigil authority for privileged requests.", "tags": [], "signatures": [ { "code": "declare class PrivilegedAuthorityVerificationClient implements VerificationClient {\n constructor(inner: VerificationClient, authorityVerifier: PrivilegedAuthorityVerifier);\n verifyRequest(req: Request, options?: VerifyRequestOptions): Promise;\n issueChallenge(): Promise<{\n challenge: Uint8Array;\n challengeId: string;\n }>;\n verifyChallengeResponse(params: {\n challengeId: string;\n agentDid: Did;\n signatureBase64: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 117, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "privilegedauthorityverificationclient" }, { "name": "PrivilegedAuthorityVerifier", "declarationName": "PrivilegedAuthorityVerifier", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Runtime hook that turns an authenticated context into OAS/Sigil authority.", "tags": [], "signatures": [ { "code": "interface PrivilegedAuthorityVerifier {\n verify(ctx: AuthContext, options: VerifyRequestOptions): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 96, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "privilegedauthorityverifier" }, { "name": "toVerificationClient", "declarationName": "toVerificationClient", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Narrow any unknown value into a {@link VerificationClient}, or throw.\nDuck-typed for forward compatibility with `@openagentid/aegis-sdk`.", "tags": [], "signatures": [ { "code": "declare function toVerificationClient(client: unknown): VerificationClient;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 115, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "toverificationclient" }, { "name": "VerificationClient", "declarationName": "VerificationClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "AEGIS verifier facade. Concrete implementation lives in `@openagentid/aegis-sdk`.\n\nThe OpenAgent SDK never decodes assertions itself — it delegates to\nAEGIS for all verification, lineage walking, and policy evaluation.", "tags": [], "signatures": [ { "code": "interface VerificationClient {\n verifyRequest(req: Request, options?: VerifyRequestOptions): Promise;\n issueChallenge(): Promise<{\n challenge: Uint8Array;\n challengeId: string;\n }>;\n verifyChallengeResponse(params: {\n challengeId: string;\n agentDid: Did;\n signatureBase64: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 81, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verificationclient" }, { "name": "VerifyRequestOptions", "declarationName": "VerifyRequestOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for {@link VerificationClient.verifyRequest}.", "tags": [], "signatures": [ { "code": "interface VerifyRequestOptions {\n requiredScopes?: readonly string[];\n requiredAncestor?: Did;\n requirePrivilegedAuthority?: boolean;\n requiredAuthorityPath?: string;\n clockSkewSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 63, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verifyrequestoptions" } ], "supportingDeclarations": [ { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Fully qualified `did:oas` identifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 7, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "did" } ], "coverage": { "discovered": 10, "documented": 10, "missing": [] } }, { "subpath": "./skills", "importSpecifier": "@openagentid/sdk/skills", "page": "/reference/typescript/sdk/skills", "kind": "declarations", "conditions": { "types": "./dist/skills.d.ts", "import": "./dist/skills.js", "require": "./dist/skills.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/skills.d.ts" }, { "conditions": [ "import" ], "path": "./dist/skills.js" }, { "conditions": [ "require" ], "path": "./dist/skills.cjs" } ], "exports": [ { "name": "allowAllSkills", "declarationName": "allowAllSkills", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Policy that allows any skill (dangerous — use only in tests).", "tags": [], "signatures": [ { "code": "declare const allowAllSkills: SkillsPolicy;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 47, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "allowallskills" }, { "name": "denyAllSkills", "declarationName": "denyAllSkills", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Empty policy that denies everything.", "tags": [], "signatures": [ { "code": "declare const denyAllSkills: SkillsPolicy;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 45, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "denyallskills" }, { "name": "InMemorySkillsPolicy", "declarationName": "InMemorySkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory, immutable skills policy. Every mutation returns a new instance.\n\nSupports two match modes:\n - Exact: `frontend-design` matches only `frontend-design`\n - Wildcard suffix: `frontend-*` matches `frontend-design`, `frontend-test`, ...", "tags": [], "signatures": [ { "code": "declare class InMemorySkillsPolicy implements SkillsPolicy {\n constructor(skills?: readonly SkillId[]);\n canInvoke(skill: SkillId): boolean;\n assertCanInvoke(skill: SkillId): void;\n listAllowed(): readonly SkillId[];\n grant(skill: SkillId): SkillsPolicy;\n revoke(skill: SkillId): SkillsPolicy;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 35, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "inmemoryskillspolicy" }, { "name": "SkillId", "declarationName": "SkillId", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A skill identifier such as `frontend-design` or `sql-query`.", "tags": [], "signatures": [ { "code": "type SkillId = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 14, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "skillid" }, { "name": "SkillsPolicy", "declarationName": "SkillsPolicy", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The minimum contract the OpenAgent SDK expects from a skills policy.", "tags": [], "signatures": [ { "code": "interface SkillsPolicy {\n canInvoke(skill: SkillId): boolean;\n assertCanInvoke(skill: SkillId): void;\n listAllowed(): readonly SkillId[];\n grant(skill: SkillId): SkillsPolicy;\n revoke(skill: SkillId): SkillsPolicy;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/skills.d.ts", "line": 16, "sha256": "9882b53f92169820abc8993ed7671a88a8ffff7a1c0c46645df40c7cc40819c8" } } ], "anchor": "skillspolicy" } ], "supportingDeclarations": [], "coverage": { "discovered": 5, "documented": 5, "missing": [] } }, { "subpath": "./errors", "importSpecifier": "@openagentid/sdk/errors", "page": "/reference/typescript/sdk/errors", "kind": "declarations", "conditions": { "types": "./dist/errors.d.ts", "import": "./dist/errors.js", "require": "./dist/errors.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/errors.d.ts" }, { "conditions": [ "import" ], "path": "./dist/errors.js" }, { "conditions": [ "require" ], "path": "./dist/errors.cjs" } ], "exports": [ { "name": "ConfigError", "declarationName": "ConfigError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Configuration or usage violation (invalid input, missing dependency).", "tags": [], "signatures": [ { "code": "declare class ConfigError extends OpenAgentError {\n constructor(message: string, context?: Record);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 68, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "configerror" }, { "name": "CredentialError", "declarationName": "CredentialError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Arsenal credentials subsystem failure.", "tags": [], "signatures": [ { "code": "declare class CredentialError extends OpenAgentError {\n constructor(message: string, details: ErrorDetails);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 80, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "credentialerror" }, { "name": "ErrorCode", "declarationName": "ErrorCode", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Stable machine-readable error codes. These are part of the SDK's public\ncontract and MUST stay in sync with the Rust reference implementation.", "tags": [], "signatures": [ { "code": "declare const ErrorCode: {\n readonly INVALID_CONFIG: \"openagent/invalid-config\";\n readonly INVALID_INPUT: \"openagent/invalid-input\";\n readonly NOT_INITIALIZED: \"openagent/not-initialized\";\n readonly IDENTITY_CREATE_FAILED: \"openagent/identity/create-failed\";\n readonly IDENTITY_RESOLVE_FAILED: \"openagent/identity/resolve-failed\";\n readonly IDENTITY_SIGNATURE_INVALID: \"openagent/identity/signature-invalid\";\n readonly IDENTITY_LINEAGE_INVALID: \"openagent/identity/lineage-invalid\";\n readonly CREDENTIAL_FETCH_FAILED: \"openagent/credentials/fetch-failed\";\n readonly CREDENTIAL_SCOPE_DENIED: \"openagent/credentials/scope-denied\";\n readonly CREDENTIAL_PROVIDER_UNKNOWN: \"openagent/credentials/provider-unknown\";\n readonly CREDENTIAL_EXPIRED: \"openagent/credentials/expired\";\n readonly VERIFICATION_FAILED: \"openagent/verification/failed\";\n readonly AUTH_REQUIRED: \"openagent/verification/auth-required\";\n readonly AUTH_CHALLENGE_INVALID: \"openagent/verification/challenge-invalid\";\n readonly SKILL_DENIED: \"openagent/skills/denied\";\n readonly SKILL_UNKNOWN: \"openagent/skills/unknown\";\n readonly NETWORK_ERROR: \"openagent/network-error\";\n readonly SERIALIZATION_ERROR: \"openagent/serialization-error\";\n readonly UNKNOWN: \"openagent/unknown\";\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 15, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "errorcode" }, { "name": "ErrorCodeValue", "declarationName": "ErrorCodeValue", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type ErrorCodeValue = (typeof ErrorCode)[keyof typeof ErrorCode];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 36, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "errorcodevalue" }, { "name": "ErrorDetails", "declarationName": "ErrorDetails", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Structured error metadata attached to every {@link OpenAgentError}.", "tags": [], "signatures": [ { "code": "interface ErrorDetails {\n code: ErrorCodeValue;\n cause?: unknown;\n context?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 38, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "errordetails" }, { "name": "getErrorMessage", "declarationName": "getErrorMessage", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Narrow an unknown caught value to a human-readable message.", "tags": [], "signatures": [ { "code": "declare function getErrorMessage(err: unknown): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 95, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "geterrormessage" }, { "name": "IdentityError", "declarationName": "IdentityError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "OAS identity subsystem failure.", "tags": [], "signatures": [ { "code": "declare class IdentityError extends OpenAgentError {\n constructor(message: string, details: ErrorDetails);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 76, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "identityerror" }, { "name": "InputValidationError", "declarationName": "InputValidationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Runtime input validation failure (Zod, boundary checks).", "tags": [], "signatures": [ { "code": "declare class InputValidationError extends OpenAgentError {\n constructor(message: string, cause?: unknown, context?: Record);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 72, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "inputvalidationerror" }, { "name": "OpenAgentError", "declarationName": "OpenAgentError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Root of the OpenAgent SDK error hierarchy.\n\n```ts\ntry {\n await OpenAgent.createAgent({ ... });\n} catch (err) {\n if (err instanceof OpenAgentError) {\n console.error(err.code, err.message);\n }\n}\n```", "tags": [], "signatures": [ { "code": "declare class OpenAgentError extends Error {\n readonly code: ErrorCodeValue;\n readonly cause?: unknown;\n readonly context?: Record;\n constructor(message: string, details: ErrorDetails);\n toJSON(): Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 59, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "openagenterror" }, { "name": "SkillDeniedError", "declarationName": "SkillDeniedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Skills policy denial.", "tags": [], "signatures": [ { "code": "declare class SkillDeniedError extends OpenAgentError {\n readonly skill: string;\n constructor(skill: string, reason?: string, context?: Record);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 88, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "skilldeniederror" }, { "name": "VerificationError", "declarationName": "VerificationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "AEGIS verification subsystem failure.", "tags": [], "signatures": [ { "code": "declare class VerificationError extends OpenAgentError {\n constructor(message: string, details: ErrorDetails);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 84, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "verificationerror" }, { "name": "wrapError", "declarationName": "wrapError", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Wraps any non-OpenAgentError into the SDK hierarchy without losing the cause.", "tags": [], "signatures": [ { "code": "declare function wrapError(err: unknown, fallbackMessage: string): OpenAgentError;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/errors.d.ts", "line": 93, "sha256": "c6a0ccea7641ae95fbc9979a4c37376bc958c2bc857299969e510c30619dc70c" } } ], "anchor": "wraperror" } ], "supportingDeclarations": [], "coverage": { "discovered": 12, "documented": 12, "missing": [] } }, { "subpath": "./glyph", "importSpecifier": "@openagentid/sdk/glyph", "page": "/reference/typescript/sdk/glyph", "kind": "declarations", "conditions": { "types": "./dist/glyph.d.ts", "import": "./dist/glyph.js", "require": "./dist/glyph.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/glyph.d.ts" }, { "conditions": [ "import" ], "path": "./dist/glyph.js" }, { "conditions": [ "require" ], "path": "./dist/glyph.cjs" } ], "exports": [ { "name": "agentAvatar", "declarationName": "agentAvatar", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Return an external override or a self-contained deterministic SVG data URL.", "tags": [], "signatures": [ { "code": "declare function agentAvatar(did: string, profile?: AgentAvatar, options?: AvatarOptions): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 35, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "agentavatar" }, { "name": "AgentAvatar", "declarationName": "AgentAvatar", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentAvatar {\n avatarOverride?: string | null;\n avatarSkin?: CharacterAppearance | null;\n avatarExpression?: AvatarExpression;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 11, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "agentavatar-1" }, { "name": "AvatarOptions", "declarationName": "AvatarOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AvatarOptions extends GlyphOptions {\n view?: CharacterView;\n expression?: AvatarExpression;\n animated?: boolean;\n state?: LiveEyeState;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 19, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "avataroptions" }, { "name": "glyphCodeword", "declarationName": "glyphCodeword", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Compact payload and BLAKE3 detection parity matching upstream glyph format v1.\nThis parity is not Reed–Solomon correction and is never authentication proof.", "tags": [], "signatures": [ { "code": "declare function glyphCodeword(did: string): Uint8Array;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 30, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "glyphcodeword" }, { "name": "glyphEndpoint", "declarationName": "glyphEndpoint", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "GET /v1/glyph/svg/:did. This endpoint always renders identity-derived pixels;\nprofile overrides are resolved by the caller, never fetched by this service.", "tags": [], "signatures": [ { "code": "declare function glyphEndpoint(request: Request): Response;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 39, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "glyphendpoint" }, { "name": "GlyphOptions", "declarationName": "GlyphOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface GlyphOptions {\n size?: number;\n background?: boolean;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 5, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "glyphoptions" }, { "name": "isAgentAvatarDid", "declarationName": "isAgentAvatarDid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Supported agent avatar input, not registration, authorization or identity proof.", "tags": [], "signatures": [ { "code": "declare function isAgentAvatarDid(value: unknown): value is string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 22, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "isagentavatardid" }, { "name": "oasGlyph", "declarationName": "oasGlyph", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Deterministic SVG avatar. No network calls, private keys or raw DID markup.", "tags": [], "signatures": [ { "code": "declare function oasGlyph(did: string, options?: GlyphOptions): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 32, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "oasglyph" }, { "name": "parseAvatarOverride", "declarationName": "parseAvatarOverride", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function parseAvatarOverride(value: unknown): string | null;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/glyph.d.ts", "line": 33, "sha256": "2162cccf3aa39a3e9dfb80b0dc946f91811f86a2a08af1ff92602ea416b7cd9f" } } ], "anchor": "parseavataroverride" } ], "supportingDeclarations": [ { "name": "AgentActivity", "declarationName": "AgentActivity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentActivity = 'idle' | 'listening' | 'reasoning' | 'working' | 'speaking' | 'success' | 'blocked' | 'error';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 4, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "agentactivity" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "AvatarStatus", "declarationName": "AvatarStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarStatus = AvatarExpression | AgentActivity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 5, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarstatus" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CharacterView", "declarationName": "CharacterView", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterView = 'avatar' | 'full';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 25, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterview" }, { "name": "LiveEyeState", "declarationName": "LiveEyeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LiveEyeState {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink?: number;\n readonly gaze?: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 6, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "liveeyestate" } ], "coverage": { "discovered": 9, "documented": 9, "missing": [] } }, { "subpath": "./identity-verification", "importSpecifier": "@openagentid/sdk/identity-verification", "page": "/reference/typescript/sdk/identity-verification", "kind": "declarations", "conditions": { "types": "./dist/identity-verification.d.ts", "import": "./dist/identity-verification.js", "require": "./dist/identity-verification.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/identity-verification.d.ts" }, { "conditions": [ "import" ], "path": "./dist/identity-verification.js" }, { "conditions": [ "require" ], "path": "./dist/identity-verification.cjs" } ], "exports": [ { "name": "AgentIdentityProof", "declarationName": "AgentIdentityProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentIdentityProof {\n readonly token: string;\n readonly delegations: readonly string[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 42, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "agentidentityproof" }, { "name": "assertVerifiedIdentity", "declarationName": "assertVerifiedIdentity", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate an authority verdict's root binding; this does not verify a signature.", "tags": [], "signatures": [ { "code": "declare function assertVerifiedIdentity(value: unknown, expectedDid?: string, now?: number): asserts value is VerifiedAgentIdentity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 109, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "assertverifiedidentity" }, { "name": "IdentityKeyPurpose", "declarationName": "IdentityKeyPurpose", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "DID verification relationships authorized by the authoritative resolver.", "tags": [], "signatures": [ { "code": "type IdentityKeyPurpose = 'authentication' | 'capabilityDelegation' | 'assertionMethod' | 'capabilityInvocation' | 'keyAgreement';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 48, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identitykeypurpose" }, { "name": "IdentityVerificationError", "declarationName": "IdentityVerificationError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class IdentityVerificationError extends Error {\n readonly code: IdentityVerificationFailure;\n readonly name = \"IdentityVerificationError\";\n constructor(code: IdentityVerificationFailure, message: string);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 103, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverificationerror" }, { "name": "IdentityVerificationFailure", "declarationName": "IdentityVerificationFailure", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type IdentityVerificationFailure = 'invalid_proof' | 'untrusted_owner' | 'revoked' | 'replayed' | 'authority_unavailable';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 102, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverificationfailure" }, { "name": "IdentityVerifier", "declarationName": "IdentityVerifier", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Signed possession, authorized roots, delegation and live revocation checks.", "tags": [], "signatures": [ { "code": "declare class IdentityVerifier {\n constructor(config: IdentityVerifierConfig);\n verify(proof: AgentIdentityProof, options: VerifyIdentityOptions): Promise;\n verifyLineage(did: string, delegations: readonly string[], options: {\n audience: string;\n }): Promise;\n resolve(did: string, options: {\n audience: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 111, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverifier" }, { "name": "IdentityVerifierConfig", "declarationName": "IdentityVerifierConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface IdentityVerifierConfig {\n resolveDid(did: string): Promise;\n authorizeOwner(rootDid: string): Promise;\n authorizeSelfRoot?(rootDid: string, options: {\n audience: string;\n }): Promise;\n checkRevocation(check: RevocationCheck): Promise<{\n revoked: boolean;\n checkedAt: number;\n }>;\n replay: {\n consume(claim: ReplayClaim): Promise;\n };\n resolveDelegations?(did: string, audience: string): Promise;\n now?: () => number;\n maxProofAgeSeconds?: number;\n maxDelegationAgeSeconds?: number;\n maxRevocationAgeSeconds?: number;\n maxDepth?: number;\n clockToleranceSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 70, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverifierconfig" }, { "name": "ReplayClaim", "declarationName": "ReplayClaim", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ReplayClaim {\n readonly issuer: string;\n readonly tokenId: string;\n readonly audience: string;\n readonly nonce: string;\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 63, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "replayclaim" }, { "name": "ResolvedIdentityDocument", "declarationName": "ResolvedIdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ResolvedIdentityDocument {\n readonly did: string;\n readonly verificationMethods: readonly {\n readonly id: string;\n readonly publicKeyJwk: JWK;\n readonly purposes: readonly IdentityKeyPurpose[];\n }[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 49, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "resolvedidentitydocument" }, { "name": "RevocationCheck", "declarationName": "RevocationCheck", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RevocationCheck {\n readonly did: string;\n readonly issuerDid?: string;\n readonly credentialId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 58, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "revocationcheck" }, { "name": "SelfRootAuthorization", "declarationName": "SelfRootAuthorization", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Current, server-authorized self-root registration; never supplied by the proof.", "tags": [], "signatures": [ { "code": "interface SelfRootAuthorization {\n readonly did: string;\n readonly audience: string;\n readonly authorizationId: string;\n readonly revision: string;\n readonly issuedAt: number;\n readonly notBefore: number;\n readonly expiresAt: number;\n readonly checkedAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 32, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "selfrootauthorization" }, { "name": "VerifiedAgentIdentity", "declarationName": "VerifiedAgentIdentity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Current identity trust. This grants no application scopes or tenant access.", "tags": [], "signatures": [ { "code": "type VerifiedAgentIdentity = CommonAgentIdentity & ({\n readonly owner: VerifiedOwner;\n readonly root?: {\n readonly kind: 'lifeid';\n readonly did: string;\n };\n} | {\n readonly owner: null;\n readonly root: {\n readonly kind: 'self';\n readonly did: string;\n readonly authorizationId: string;\n readonly revision: string;\n };\n});", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 16, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedagentidentity" }, { "name": "VerifiedOwner", "declarationName": "VerifiedOwner", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifiedOwner {\n readonly issuer: string;\n readonly subject: string;\n readonly organizationId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 3, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedowner" }, { "name": "VerifyIdentityOptions", "declarationName": "VerifyIdentityOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifyIdentityOptions {\n readonly audience: string;\n readonly nonce: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 97, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifyidentityoptions" } ], "supportingDeclarations": [ { "name": "CommonAgentIdentity", "declarationName": "CommonAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CommonAgentIdentity {\n readonly did: string;\n readonly lineage: readonly string[];\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 8, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "commonagentidentity" } ], "coverage": { "discovered": 14, "documented": 14, "missing": [] } }, { "subpath": "./verification-api", "importSpecifier": "@openagentid/sdk/verification-api", "page": "/reference/typescript/sdk/verification-api", "kind": "declarations", "conditions": { "types": "./dist/verification-api.d.ts", "import": "./dist/verification-api.js", "require": "./dist/verification-api.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/verification-api.d.ts" }, { "conditions": [ "import" ], "path": "./dist/verification-api.js" }, { "conditions": [ "require" ], "path": "./dist/verification-api.cjs" } ], "exports": [ { "name": "createIdentityVerificationHandler", "declarationName": "createIdentityVerificationHandler", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Host this handler at your chosen POST endpoint. No endpoint is auto-deployed.", "tags": [], "signatures": [ { "code": "declare function createIdentityVerificationHandler(verifier: IdentityVerifier, options: IdentityVerificationHandlerOptions): (request: Request) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 16, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "createidentityverificationhandler" }, { "name": "IdentityVerificationHandlerOptions", "declarationName": "IdentityVerificationHandlerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface IdentityVerificationHandlerOptions {\n readonly audience: string;\n resolveNonce(request: Request): Promise;\n readonly maxBodyBytes?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 4, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "identityverificationhandleroptions" }, { "name": "RemoteIdentityVerificationOptions", "declarationName": "RemoteIdentityVerificationOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RemoteIdentityVerificationOptions {\n readonly nonce: string;\n readonly fetch?: typeof fetch;\n readonly signal?: AbortSignal;\n readonly timeoutMs?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 17, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "remoteidentityverificationoptions" }, { "name": "verifyIdentityRemote", "declarationName": "verifyIdentityRemote", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "The configured service is a trust authority. HTTPS protects its returned verdict.", "tags": [], "signatures": [ { "code": "declare function verifyIdentityRemote(endpoint: string, proof: AgentIdentityProof, options: RemoteIdentityVerificationOptions): Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification-api.d.ts", "line": 24, "sha256": "628bd9a67d93bc3719c88fec83588a84959ba0fca6fd6439748cac92e0facb5d" } } ], "anchor": "verifyidentityremote" } ], "supportingDeclarations": [ { "name": "AgentIdentityProof", "declarationName": "AgentIdentityProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentIdentityProof {\n readonly token: string;\n readonly delegations: readonly string[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 42, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "agentidentityproof" }, { "name": "CommonAgentIdentity", "declarationName": "CommonAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CommonAgentIdentity {\n readonly did: string;\n readonly lineage: readonly string[];\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 8, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "commonagentidentity" }, { "name": "IdentityKeyPurpose", "declarationName": "IdentityKeyPurpose", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "DID verification relationships authorized by the authoritative resolver.", "tags": [], "signatures": [ { "code": "type IdentityKeyPurpose = 'authentication' | 'capabilityDelegation' | 'assertionMethod' | 'capabilityInvocation' | 'keyAgreement';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 48, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identitykeypurpose" }, { "name": "IdentityVerifier", "declarationName": "IdentityVerifier", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Signed possession, authorized roots, delegation and live revocation checks.", "tags": [], "signatures": [ { "code": "declare class IdentityVerifier {\n constructor(config: IdentityVerifierConfig);\n verify(proof: AgentIdentityProof, options: VerifyIdentityOptions): Promise;\n verifyLineage(did: string, delegations: readonly string[], options: {\n audience: string;\n }): Promise;\n resolve(did: string, options: {\n audience: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 111, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverifier" }, { "name": "IdentityVerifierConfig", "declarationName": "IdentityVerifierConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface IdentityVerifierConfig {\n resolveDid(did: string): Promise;\n authorizeOwner(rootDid: string): Promise;\n authorizeSelfRoot?(rootDid: string, options: {\n audience: string;\n }): Promise;\n checkRevocation(check: RevocationCheck): Promise<{\n revoked: boolean;\n checkedAt: number;\n }>;\n replay: {\n consume(claim: ReplayClaim): Promise;\n };\n resolveDelegations?(did: string, audience: string): Promise;\n now?: () => number;\n maxProofAgeSeconds?: number;\n maxDelegationAgeSeconds?: number;\n maxRevocationAgeSeconds?: number;\n maxDepth?: number;\n clockToleranceSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 70, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverifierconfig" }, { "name": "ReplayClaim", "declarationName": "ReplayClaim", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ReplayClaim {\n readonly issuer: string;\n readonly tokenId: string;\n readonly audience: string;\n readonly nonce: string;\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 63, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "replayclaim" }, { "name": "ResolvedIdentityDocument", "declarationName": "ResolvedIdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ResolvedIdentityDocument {\n readonly did: string;\n readonly verificationMethods: readonly {\n readonly id: string;\n readonly publicKeyJwk: JWK;\n readonly purposes: readonly IdentityKeyPurpose[];\n }[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 49, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "resolvedidentitydocument" }, { "name": "RevocationCheck", "declarationName": "RevocationCheck", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RevocationCheck {\n readonly did: string;\n readonly issuerDid?: string;\n readonly credentialId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 58, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "revocationcheck" }, { "name": "SelfRootAuthorization", "declarationName": "SelfRootAuthorization", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Current, server-authorized self-root registration; never supplied by the proof.", "tags": [], "signatures": [ { "code": "interface SelfRootAuthorization {\n readonly did: string;\n readonly audience: string;\n readonly authorizationId: string;\n readonly revision: string;\n readonly issuedAt: number;\n readonly notBefore: number;\n readonly expiresAt: number;\n readonly checkedAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 32, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "selfrootauthorization" }, { "name": "VerifiedAgentIdentity", "declarationName": "VerifiedAgentIdentity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Current identity trust. This grants no application scopes or tenant access.", "tags": [], "signatures": [ { "code": "type VerifiedAgentIdentity = CommonAgentIdentity & ({\n readonly owner: VerifiedOwner;\n readonly root?: {\n readonly kind: 'lifeid';\n readonly did: string;\n };\n} | {\n readonly owner: null;\n readonly root: {\n readonly kind: 'self';\n readonly did: string;\n readonly authorizationId: string;\n readonly revision: string;\n };\n});", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 16, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedagentidentity" }, { "name": "VerifiedOwner", "declarationName": "VerifiedOwner", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifiedOwner {\n readonly issuer: string;\n readonly subject: string;\n readonly organizationId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 3, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedowner" }, { "name": "VerifyIdentityOptions", "declarationName": "VerifyIdentityOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifyIdentityOptions {\n readonly audience: string;\n readonly nonce: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 97, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifyidentityoptions" } ], "coverage": { "discovered": 4, "documented": 4, "missing": [] } }, { "subpath": "./oats", "importSpecifier": "@openagentid/sdk/oats", "page": "/reference/typescript/sdk/oats", "kind": "declarations", "conditions": { "types": "./dist/oats.d.ts", "import": "./dist/oats.js", "require": "./dist/oats.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/oats.d.ts" }, { "conditions": [ "import" ], "path": "./dist/oats.js" }, { "conditions": [ "require" ], "path": "./dist/oats.cjs" } ], "exports": [ { "name": "createOatsEvidenceVerifier", "declarationName": "createOatsEvidenceVerifier", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Concrete OAS Ed25519Signature2020 verifier. It verifies upstream JCS signing\nbytes, assertion-authorized issuer keys, authoritative owner chains and\ncurrent attestation revocation. No cryptographic work is delegated to callers.", "tags": [], "signatures": [ { "code": "declare function createOatsEvidenceVerifier(config: OatsEvidenceVerifierConfig): OatsEvidenceVerifier;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 99, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "createoatsevidenceverifier" }, { "name": "OATS_WEIGHTS", "declarationName": "OATS_WEIGHTS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const OATS_WEIGHTS: Readonly<{\n SecurityAudit: 0.3;\n BenchmarkResult: 0.25;\n ExpertEndorsement: 0.2;\n PublisherBond: 0.15;\n CommunityReview: 0.1;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 4, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oats_weights" }, { "name": "OatsComponentScore", "declarationName": "OatsComponentScore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsComponentScore {\n readonly rawScore: number;\n readonly weight: number;\n readonly evidenceCount: number;\n readonly latestEvidence: string | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 76, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatscomponentscore" }, { "name": "OatsCompositeScore", "declarationName": "OatsCompositeScore", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsCompositeScore {\n readonly entityDid: string;\n readonly components: Readonly>;\n readonly composite: number;\n readonly confidence: number;\n readonly evidenceCount: number;\n readonly computedAt: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 82, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatscompositescore" }, { "name": "OatsCredential", "declarationName": "OatsCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "An OAS VC; the adapter verifies its complete signed body and proof.", "tags": [], "signatures": [ { "code": "interface OatsCredential {\n readonly id: string;\n readonly issuer: string;\n readonly issuanceDate: string;\n readonly expirationDate?: string;\n readonly type: readonly string[];\n readonly oasAttestationType?: OatsEvidenceType;\n readonly credentialSubject: Readonly> & {\n readonly id: string;\n };\n readonly proof: Readonly>;\n readonly [extension: string]: unknown;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 13, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatscredential" }, { "name": "OatsError", "declarationName": "OatsError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class OatsError extends Error {\n readonly code: string;\n constructor(code: string, message: string);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 90, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatserror" }, { "name": "OatsEvidenceType", "declarationName": "OatsEvidenceType", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type OatsEvidenceType = keyof typeof OATS_WEIGHTS;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 11, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsevidencetype" }, { "name": "OatsEvidenceVerifier", "declarationName": "OatsEvidenceVerifier", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Resolve keys from an authoritative source, verify the entire credential, and\nverify current identity roots, signed lineage and revocation for issuer and subject. Never derive\ntrusted keys or owner bindings from the submitted credential itself.", "tags": [], "signatures": [ { "code": "type OatsEvidenceVerifier = (credential: OatsCredential, context: OatsVerificationContext) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 49, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsevidenceverifier" }, { "name": "OatsEvidenceVerifierConfig", "declarationName": "OatsEvidenceVerifierConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsEvidenceVerifierConfig {\n readonly audience: string;\n readonly identity: IdentityVerifierConfig & {\n resolveDelegations(did: string, audience: string): Promise;\n };\n resolveIssuerAssertionMethods(did: string): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 59, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsevidenceverifierconfig" }, { "name": "OatsIssuerAssertionDocument", "declarationName": "OatsIssuerAssertionDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Keys already authorized for assertionMethod by the authoritative OAS resolver.", "tags": [], "signatures": [ { "code": "interface OatsIssuerAssertionDocument {\n readonly did: string;\n readonly assertionMethods: readonly {\n readonly id: string;\n readonly controller: string;\n readonly publicKeyJwk: JWK;\n }[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 51, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsissuerassertiondocument" }, { "name": "oatsMeetsThreshold", "declarationName": "oatsMeetsThreshold", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Both verified composite and confidence must meet the bounded thresholds.", "tags": [], "signatures": [ { "code": "declare function oatsMeetsThreshold(score: OatsCompositeScore, minimumComposite: number, minimumConfidence: number): boolean;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 109, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsmeetsthreshold" }, { "name": "OatsScorerOptions", "declarationName": "OatsScorerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsScorerOptions {\n readonly trustedIssuers: readonly string[];\n readonly verifyEvidence: OatsEvidenceVerifier;\n readonly now?: () => Date;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 69, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsscoreroptions" }, { "name": "OatsVerificationContext", "declarationName": "OatsVerificationContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface OatsVerificationContext {\n readonly credentialId: string;\n readonly issuerDid: string;\n readonly subjectDid: string;\n readonly now: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 26, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "oatsverificationcontext" }, { "name": "VerifiedOatsEvidence", "declarationName": "VerifiedOatsEvidence", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Return only after the exact credential signature and both identities pass.", "tags": [], "signatures": [ { "code": "interface VerifiedOatsEvidence {\n readonly credentialId: string;\n readonly issuerDid: string;\n readonly subjectDid: string;\n readonly signatureVerified: true;\n readonly credentialRevocationChecked: true;\n readonly issuer: VerifiedAgentIdentity;\n readonly subject: VerifiedAgentIdentity;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 34, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "verifiedoatsevidence" }, { "name": "VerifiedOatsScorer", "declarationName": "VerifiedOatsScorer", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare class VerifiedOatsScorer {\n constructor(options: OatsScorerOptions);\n score(entityDid: string, credentials: readonly unknown[]): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/oats.d.ts", "line": 100, "sha256": "0bffd38bfec9e51e0622320c2bd34b55e9f8c298e74b3b2c2214853e5a190aaf" } } ], "anchor": "verifiedoatsscorer" } ], "supportingDeclarations": [ { "name": "CommonAgentIdentity", "declarationName": "CommonAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CommonAgentIdentity {\n readonly did: string;\n readonly lineage: readonly string[];\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 8, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "commonagentidentity" }, { "name": "IdentityKeyPurpose", "declarationName": "IdentityKeyPurpose", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "DID verification relationships authorized by the authoritative resolver.", "tags": [], "signatures": [ { "code": "type IdentityKeyPurpose = 'authentication' | 'capabilityDelegation' | 'assertionMethod' | 'capabilityInvocation' | 'keyAgreement';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 48, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identitykeypurpose" }, { "name": "IdentityVerifierConfig", "declarationName": "IdentityVerifierConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface IdentityVerifierConfig {\n resolveDid(did: string): Promise;\n authorizeOwner(rootDid: string): Promise;\n authorizeSelfRoot?(rootDid: string, options: {\n audience: string;\n }): Promise;\n checkRevocation(check: RevocationCheck): Promise<{\n revoked: boolean;\n checkedAt: number;\n }>;\n replay: {\n consume(claim: ReplayClaim): Promise;\n };\n resolveDelegations?(did: string, audience: string): Promise;\n now?: () => number;\n maxProofAgeSeconds?: number;\n maxDelegationAgeSeconds?: number;\n maxRevocationAgeSeconds?: number;\n maxDepth?: number;\n clockToleranceSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 70, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "identityverifierconfig" }, { "name": "ReplayClaim", "declarationName": "ReplayClaim", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ReplayClaim {\n readonly issuer: string;\n readonly tokenId: string;\n readonly audience: string;\n readonly nonce: string;\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 63, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "replayclaim" }, { "name": "ResolvedIdentityDocument", "declarationName": "ResolvedIdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface ResolvedIdentityDocument {\n readonly did: string;\n readonly verificationMethods: readonly {\n readonly id: string;\n readonly publicKeyJwk: JWK;\n readonly purposes: readonly IdentityKeyPurpose[];\n }[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 49, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "resolvedidentitydocument" }, { "name": "RevocationCheck", "declarationName": "RevocationCheck", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface RevocationCheck {\n readonly did: string;\n readonly issuerDid?: string;\n readonly credentialId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 58, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "revocationcheck" }, { "name": "SelfRootAuthorization", "declarationName": "SelfRootAuthorization", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Current, server-authorized self-root registration; never supplied by the proof.", "tags": [], "signatures": [ { "code": "interface SelfRootAuthorization {\n readonly did: string;\n readonly audience: string;\n readonly authorizationId: string;\n readonly revision: string;\n readonly issuedAt: number;\n readonly notBefore: number;\n readonly expiresAt: number;\n readonly checkedAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 32, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "selfrootauthorization" }, { "name": "VerifiedAgentIdentity", "declarationName": "VerifiedAgentIdentity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Current identity trust. This grants no application scopes or tenant access.", "tags": [], "signatures": [ { "code": "type VerifiedAgentIdentity = CommonAgentIdentity & ({\n readonly owner: VerifiedOwner;\n readonly root?: {\n readonly kind: 'lifeid';\n readonly did: string;\n };\n} | {\n readonly owner: null;\n readonly root: {\n readonly kind: 'self';\n readonly did: string;\n readonly authorizationId: string;\n readonly revision: string;\n };\n});", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 16, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedagentidentity" }, { "name": "VerifiedOwner", "declarationName": "VerifiedOwner", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifiedOwner {\n readonly issuer: string;\n readonly subject: string;\n readonly organizationId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 3, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedowner" } ], "coverage": { "discovered": 15, "documented": 15, "missing": [] } }, { "subpath": "./characters", "importSpecifier": "@openagentid/sdk/characters", "page": "/reference/typescript/sdk/characters", "kind": "declarations", "conditions": { "types": "./dist/characters.d.ts", "import": "./dist/characters.js", "require": "./dist/characters.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/characters.d.ts" }, { "conditions": [ "import" ], "path": "./dist/characters.js" }, { "conditions": [ "require" ], "path": "./dist/characters.cjs" } ], "exports": [ { "name": "AgentActivity", "declarationName": "AgentActivity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentActivity = 'idle' | 'listening' | 'reasoning' | 'working' | 'speaking' | 'success' | 'blocked' | 'error';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 4, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "agentactivity" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "AvatarStatus", "declarationName": "AvatarStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarStatus = AvatarExpression | AgentActivity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 5, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarstatus" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAccessoryDescription", "declarationName": "CharacterAccessoryDescription", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAccessoryDescription {\n readonly id: CharacterAccessory;\n readonly label: string;\n readonly description: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 7, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessorydescription" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "CharacterDescriptor", "declarationName": "CharacterDescriptor", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterDescriptor {\n readonly did: string;\n readonly skin: CharacterSkin;\n readonly skinVersion: 1;\n readonly eyeStyle: CharacterEyeStyle;\n readonly finish: CharacterFinish;\n readonly eyePlacement: CharacterEyePlacement;\n readonly shape: CharacterShape;\n readonly accessories: readonly CharacterAccessory[];\n readonly expression: AvatarExpression;\n readonly color: string;\n readonly view: CharacterView;\n readonly size: number;\n readonly animated: boolean;\n readonly state: {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n };\n readonly svg: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 60, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterdescriptor" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterOptions", "declarationName": "CharacterOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterOptions extends Omit {\n readonly skin?: CharacterSkin;\n readonly expression?: AvatarExpression;\n readonly view?: CharacterView;\n readonly size?: number;\n readonly animated?: boolean;\n readonly state?: LiveEyeState;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 41, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteroptions" }, { "name": "CharacterRuntimeState", "declarationName": "CharacterRuntimeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterRuntimeState {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 18, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterruntimestate" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CharacterSkinDescription", "declarationName": "CharacterSkinDescription", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterSkinDescription {\n readonly id: CharacterSkin;\n readonly label: string;\n readonly version: 1;\n readonly eyeStyles: readonly CharacterEyeStyle[];\n readonly shapes: readonly CharacterShape[];\n readonly expressions: readonly AvatarExpression[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 52, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskindescription" }, { "name": "CharacterStateUpdate", "declarationName": "CharacterStateUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A status update clears the previous override; null restores the status expression.", "tags": [], "signatures": [ { "code": "interface CharacterStateUpdate extends Omit {\n readonly expression?: AvatarExpression | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 28, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterstateupdate" }, { "name": "CharacterView", "declarationName": "CharacterView", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterView = 'avatar' | 'full';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 25, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterview" }, { "name": "expressionEyes", "declarationName": "expressionEyes", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const expressionEyes: Readonly>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 90, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "expressioneyes" }, { "name": "expressionForStatus", "declarationName": "expressionForStatus", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function expressionForStatus(value: unknown): AvatarExpression;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 37, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "expressionforstatus" }, { "name": "EyeGeometry", "declarationName": "EyeGeometry", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type EyeGeometry = readonly [\n width: number,\n height: number,\n centerY: number,\n rotation: number\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 89, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "eyegeometry" }, { "name": "generateCharacter", "declarationName": "generateCharacter", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Self-contained SVG character. Public DID-derived pixels are not identity proof.", "tags": [], "signatures": [ { "code": "declare function generateCharacter(did: string, options?: CharacterOptions): CharacterDescriptor;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 92, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "generatecharacter" }, { "name": "getCharacterAccessories", "declarationName": "getCharacterAccessories", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Immutable catalog. Accessories can be combined and default to none.", "tags": [], "signatures": [ { "code": "declare function getCharacterAccessories(): readonly CharacterAccessoryDescription[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 13, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "getcharacteraccessories" }, { "name": "getCharacterExpressions", "declarationName": "getCharacterExpressions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterExpressions(): readonly AvatarExpression[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 31, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "getcharacterexpressions" }, { "name": "getCharacterSkins", "declarationName": "getCharacterSkins", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Immutable versioned body/face skins. Eye expression is independent of skin.", "tags": [], "signatures": [ { "code": "declare function getCharacterSkins(): readonly CharacterSkinDescription[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 86, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "getcharacterskins" }, { "name": "getCharacterStatuses", "declarationName": "getCharacterStatuses", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterStatuses(): readonly {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n}[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 32, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "getcharacterstatuses" }, { "name": "isAgentAvatarDid", "declarationName": "isAgentAvatarDid", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Supported agent avatar input, not registration, authorization or identity proof.", "tags": [], "signatures": [ { "code": "declare function isAgentAvatarDid(value: unknown): value is string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 22, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "isagentavatardid" }, { "name": "LiveEyeState", "declarationName": "LiveEyeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LiveEyeState {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink?: number;\n readonly gaze?: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 6, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "liveeyestate" }, { "name": "parseCharacterAccessories", "declarationName": "parseCharacterAccessories", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strict selection with canonical ordering; never retains a caller-owned array.", "tags": [], "signatures": [ { "code": "declare function parseCharacterAccessories(value: unknown): readonly CharacterAccessory[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 15, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "parsecharacteraccessories" }, { "name": "parseCharacterAppearance", "declarationName": "parseCharacterAppearance", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Strict stored body/face selection; expression and live state belong elsewhere.", "tags": [], "signatures": [ { "code": "declare function parseCharacterAppearance(value: unknown): CharacterAppearance;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 88, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "parsecharacterappearance" }, { "name": "parseCharacterState", "declarationName": "parseCharacterState", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate an untrusted status snapshot without changing any identity/profile state.", "tags": [], "signatures": [ { "code": "declare function parseCharacterState(input: unknown, fallbackExpression?: AvatarExpression): CharacterRuntimeState;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 40, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "parsecharacterstate" }, { "name": "renderCharacterSvg", "declarationName": "renderCharacterSvg", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Render a character without retaining its descriptor.", "tags": [], "signatures": [ { "code": "declare function renderCharacterSvg(did: string, options?: CharacterOptions): string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 94, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "rendercharactersvg" } ], "supportingDeclarations": [ { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" } ], "coverage": { "discovered": 31, "documented": 31, "missing": [] } }, { "subpath": "./character-api", "importSpecifier": "@openagentid/sdk/character-api", "page": "/reference/typescript/sdk/character-api", "kind": "declarations", "conditions": { "types": "./dist/character-api.d.ts", "import": "./dist/character-api.js", "require": "./dist/character-api.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/character-api.d.ts" }, { "conditions": [ "import" ], "path": "./dist/character-api.js" }, { "conditions": [ "require" ], "path": "./dist/character-api.cjs" } ], "exports": [ { "name": "CharacterApiHandlerOptions", "declarationName": "CharacterApiHandlerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterApiHandlerOptions {\n readonly basePath?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-api.d.ts", "line": 1, "sha256": "92153cc80f9920afe6c93a5cd33b24f4107c13def3acb13a17092ba3260acd19" } } ], "anchor": "characterapihandleroptions" }, { "name": "characterApiOpenApi", "declarationName": "characterApiOpenApi", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Bundled OpenAPI 3.1 contract; mirrored in docs/character-api.openapi.json.", "tags": [], "signatures": [ { "code": "declare const characterApiOpenApi: {\n readonly openapi: \"3.1.0\";\n readonly info: {\n readonly title: \"OpenAgentID Character API\";\n readonly version: \"0.7.2\";\n readonly description: \"Public, unauthenticated stateless deterministic agent decoration. Autos is the default rounded pill family. The catalog contains 17 families and 62 distinct character kinds, including Halloween, Thanksgiving and Christmas. Avatar rendering frames the face by default; view=full restores the complete character. Skin controls body and face geometry; expressions and live-v1 eyes are shared across skins. This API neither mints identities nor verifies possession, ownership, lineage, revocation or permissions. No secrets, external assets, JavaScript, CSS or fonts. Every response including errors and 304 includes wildcard CORS; credentials are not required. Unknown and duplicate query parameters are rejected. Input, streamed body chunks and geometry are bounded; hosted infrastructure supplies request rate and duration limits. Runtime state resolves state.expression before status mapping, then outer preferred expression, then neutral. Status is presentation state only and establishes no agent activity or authority. Independent glasses and headphones can be combined on every family. Accessories default to an empty selection, do not change identity-derived shape/color or live-eye state, and normalize to catalog order. Unknown, duplicate or malformed selections are refused. Every family supports shared finish (plush default, flat optional) and eyePlacement (face default, raised optional). These strictly closed appearance selectors do not change identity-derived shape/color or runtime state. Descriptors include both resolved values.\";\n };\n readonly servers: readonly [\n {\n readonly url: \"/v1/characters\";\n }\n ];\n readonly security: readonly [\n ];\n readonly paths: {\n readonly \"/skins\": {\n readonly get: {\n readonly summary: \"List versioned character skins\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterSkinV1\";\n };\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for list versioned character skins\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/statuses\": {\n readonly get: {\n readonly summary: \"List runtime status-to-expression mappings\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterStatusV1\";\n };\n readonly minItems: 26;\n readonly maxItems: 26;\n readonly description: \"Immutable SDK mapping catalog serialized as JSON, including all expressions and runtime aliases.\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for runtime status-to-expression mappings\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/svg/{did}\": {\n readonly get: {\n readonly summary: \"Render a character SVG\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n readonly content: {\n readonly \"image/svg+xml\": {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for render a character svg\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n readonly \"Content-Security-Policy\": {\n readonly $ref: \"#/components/headers/SvgCsp\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/{did}\": {\n readonly get: {\n readonly summary: \"Generate a character descriptor\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterDescriptorV1\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for generate a character descriptor\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/did\";\n },\n {\n readonly $ref: \"#/components/parameters/skin\";\n },\n {\n readonly $ref: \"#/components/parameters/skinVersion\";\n },\n {\n readonly $ref: \"#/components/parameters/eyeStyle\";\n },\n {\n readonly $ref: \"#/components/parameters/size\";\n },\n {\n readonly $ref: \"#/components/parameters/animated\";\n },\n {\n readonly $ref: \"#/components/parameters/blink\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeX\";\n },\n {\n readonly $ref: \"#/components/parameters/gazeY\";\n },\n {\n readonly $ref: \"#/components/parameters/shape\";\n },\n {\n readonly $ref: \"#/components/parameters/expression\";\n },\n {\n readonly $ref: \"#/components/parameters/status\";\n },\n {\n readonly $ref: \"#/components/parameters/view\";\n },\n {\n readonly $ref: \"#/components/parameters/accessories\";\n },\n {\n readonly $ref: \"#/components/parameters/finish\";\n },\n {\n readonly $ref: \"#/components/parameters/eyePlacement\";\n }\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/generate\": {\n readonly post: {\n readonly summary: \"Generate a character descriptor from JSON\";\n readonly description: \"Stateless and unauthenticated; no query parameters. Unknown fields are rejected at every level. Streamed body size is checked independently of Content-Length.\";\n readonly \"x-max-body-bytes\": 16384;\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly requestBody: {\n readonly required: true;\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterGenerateRequestV1\";\n };\n };\n };\n };\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Generated descriptor; no-store, no ETag.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterDescriptorV1\";\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n readonly \"413\": {\n readonly $ref: \"#/components/responses/BodyTooLarge\";\n };\n readonly \"415\": {\n readonly $ref: \"#/components/responses/UnsupportedMediaType\";\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"POST, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/openapi.json\": {\n readonly get: {\n readonly summary: \"Read this OpenAPI schema\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"object\";\n readonly description: \"OpenAPI 3.1 document; servers[0].url reflects the configured mount path.\";\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for read this openapi schema\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Public CORS preflight\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n readonly \"/accessories\": {\n readonly get: {\n readonly summary: \"List combinable character accessories\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterAccessoryDescriptionV1\";\n };\n };\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n readonly head: {\n readonly summary: \"Headers for the character accessory catalog\";\n readonly parameters: readonly [\n {\n readonly $ref: \"#/components/parameters/IfNoneMatch\";\n }\n ];\n readonly \"x-reject-unknown-query-parameters\": true;\n readonly \"x-reject-duplicate-query-parameters\": true;\n readonly description: \"Same status, headers and Content-Length as GET, no response body.\";\n readonly responses: {\n readonly \"200\": {\n readonly description: \"Deterministic representation; public max-age=3600, must-revalidate.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"304\": {\n readonly description: \"Matching validator, no body. CORS, ETag and SVG security headers are preserved.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly ETag: {\n readonly $ref: \"#/components/headers/ETag\";\n };\n readonly \"Content-Length\": {\n readonly $ref: \"#/components/headers/ContentLength\";\n };\n };\n };\n readonly \"400\": {\n readonly description: \"Invalid request, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"404\": {\n readonly description: \"Not found, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n };\n readonly \"405\": {\n readonly description: \"Not allowed, no body.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n };\n };\n };\n readonly options: {\n readonly summary: \"Preflight for the character accessory catalog\";\n readonly parameters: readonly [\n ];\n readonly responses: {\n readonly \"204\": {\n readonly description: \"No body; schema-valid requests can be made cross-origin without credentials.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly \"Access-Control-Allow-Methods\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"GET, HEAD, OPTIONS\";\n };\n };\n readonly \"Access-Control-Allow-Headers\": {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"Content-Type, If-None-Match\";\n };\n };\n readonly \"Access-Control-Max-Age\": {\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 86400;\n };\n };\n };\n };\n readonly \"400\": {\n readonly $ref: \"#/components/responses/InvalidRequest\";\n };\n readonly \"404\": {\n readonly $ref: \"#/components/responses/NotFound\";\n };\n readonly \"405\": {\n readonly $ref: \"#/components/responses/MethodNotAllowed\";\n };\n };\n };\n };\n };\n readonly components: {\n readonly schemas: {\n readonly AgentDid: {\n readonly type: \"string\";\n readonly maxLength: 512;\n readonly pattern: \"^did:(?:(?:oas:[a-z0-9][a-z0-9-]{0,63}|l1fe):agent(?::instance)?:[A-Za-z0-9._-]+|oas:agent-instance:[0-7][0-9A-HJKMNP-TV-Z]{25})(?![\\\\s\\\\S])\";\n readonly description: \"Existing agent or agent:instance DID, including the literal IAM did:oas:agent-instance: avatar format. Generation preserves the assigned DID and neither verifies nor registers a principal; authentication schemas are unchanged.\";\n };\n readonly CharacterAppearanceV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"skin\"\n ];\n readonly properties: {\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly GazeV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"x\",\n \"y\"\n ];\n readonly properties: {\n readonly x: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly y: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n };\n };\n readonly LiveEyeStateV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly properties: {\n readonly blink: {\n readonly type: \"number\";\n readonly minimum: 0;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly gaze: {\n readonly $ref: \"#/components/schemas/GazeV1\";\n };\n readonly status: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n readonly description: \"Runtime status alias or literal expression. Overrides the outer preferred expression.\";\n };\n readonly expression: {\n readonly $ref: \"#/components/schemas/AvatarExpression\";\n readonly description: \"Explicit runtime expression; overrides state.status mapping and outer preferred expression. Null is not accepted by this stateless API.\";\n };\n };\n readonly description: \"Optional stateless snapshot. Resolution: state.expression > state.status mapping > outer expression > neutral. Unknown fields and null values are refused.\";\n };\n readonly CharacterOptionsV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly properties: {\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly size: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly animated: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly state: {\n readonly $ref: \"#/components/schemas/LiveEyeStateV1\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly expression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Outer preferred expression fallback. Explicit state.expression wins, then state.status mapping, then this preference, then neutral.\";\n };\n readonly view: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly CharacterGenerateRequestV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"did\"\n ];\n readonly properties: {\n readonly did: {\n readonly $ref: \"#/components/schemas/AgentDid\";\n };\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly size: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly animated: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly state: {\n readonly $ref: \"#/components/schemas/LiveEyeStateV1\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly expression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Outer preferred expression fallback. Explicit state.expression wins, then state.status mapping, then this preference, then neutral.\";\n };\n readonly view: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly CharacterDescriptorV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"did\",\n \"skin\",\n \"skinVersion\",\n \"eyeStyle\",\n \"shape\",\n \"color\",\n \"size\",\n \"animated\",\n \"state\",\n \"svg\",\n \"expression\",\n \"view\",\n \"accessories\",\n \"finish\",\n \"eyePlacement\"\n ];\n readonly properties: {\n readonly did: {\n readonly $ref: \"#/components/schemas/AgentDid\";\n };\n readonly skin: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly skinVersion: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n readonly eyeStyle: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly size: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly animated: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly state: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"blink\",\n \"gaze\"\n ];\n readonly properties: {\n readonly blink: {\n readonly type: \"number\";\n readonly minimum: 0;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly gaze: {\n readonly $ref: \"#/components/schemas/GazeV1\";\n };\n readonly status: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n };\n readonly expression: {\n readonly $ref: \"#/components/schemas/AvatarExpression\";\n };\n };\n readonly description: \"Normalized blink/gaze, retaining status/expression only when explicitly supplied in input state. Descriptor.expression is the resolved expression; old snapshots without state status/expression preserve their prior shape.\";\n };\n readonly color: {\n readonly type: \"string\";\n readonly pattern: \"^#[0-9a-fA-F]{6}$\";\n };\n readonly svg: {\n readonly type: \"string\";\n readonly description: \"Escaped, self-contained SVG on a transparent background. No external resources, JavaScript, CSS or fonts.\";\n };\n readonly shape: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly expression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Resolved expression: state.expression > state.status mapping > outer preferred expression > neutral. Body shape/color remain unchanged.\";\n };\n readonly view: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n readonly accessories: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly finish: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n readonly eyePlacement: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"spacex\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"fold\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"sprig\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"ripple\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halo\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"purl\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"prism\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"coil\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"kiln\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"wisp\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"relay\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"cairn\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"tuft\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"halloween\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"thanksgiving\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n };\n };\n },\n {\n readonly if: {\n readonly properties: {\n readonly skin: {\n readonly const: \"christmas\";\n };\n };\n readonly required: readonly [\n \"skin\"\n ];\n };\n readonly then: {\n readonly properties: {\n readonly shape: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n };\n };\n }\n ];\n };\n readonly CharacterSkinV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"id\",\n \"label\",\n \"version\",\n \"eyeStyles\",\n \"shapes\",\n \"expressions\"\n ];\n readonly properties: {\n readonly id: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n readonly label: {\n readonly type: \"string\";\n };\n readonly version: {\n readonly type: \"integer\";\n readonly const: 1;\n };\n readonly eyeStyles: {\n readonly type: \"array\";\n readonly items: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n readonly minItems: 1;\n readonly uniqueItems: true;\n };\n readonly shapes: {\n readonly type: \"array\";\n readonly items: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n readonly minItems: 1;\n readonly uniqueItems: true;\n };\n readonly expressions: {\n readonly type: \"array\";\n readonly items: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Shared eye expression across all skins. Body shape and color remain unchanged. Explicit blink shrinks expression eye bars and gaze translates both together.\";\n };\n readonly minItems: 18;\n readonly maxItems: 18;\n readonly uniqueItems: true;\n };\n };\n readonly allOf: readonly [\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"autos\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"spacex\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\"\n ];\n };\n readonly minItems: 8;\n readonly maxItems: 8;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"fold\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"kite\",\n \"fan\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"sprig\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"bud\",\n \"leaf\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"ripple\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"drop\",\n \"wave\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"halo\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"comet\",\n \"satellite\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"purl\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"mitt\",\n \"hood\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"prism\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"crystal\",\n \"obelisk\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"coil\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"spring\",\n \"bellows\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"kiln\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"vase\",\n \"teapot\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"wisp\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"flame\",\n \"curl\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"relay\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"radio\",\n \"beacon\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"cairn\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"tower\",\n \"arch\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"tuft\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"standard\",\n \"pom\",\n \"bear\"\n ];\n };\n readonly minItems: 3;\n readonly maxItems: 3;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"halloween\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\"\n ];\n };\n readonly minItems: 5;\n readonly maxItems: 5;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"thanksgiving\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\"\n ];\n };\n readonly minItems: 5;\n readonly maxItems: 5;\n };\n };\n };\n },\n {\n readonly if: {\n readonly required: readonly [\n \"id\"\n ];\n readonly properties: {\n readonly id: {\n readonly const: \"christmas\";\n };\n };\n };\n readonly then: {\n readonly properties: {\n readonly shapes: {\n readonly items: {\n readonly enum: readonly [\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n };\n readonly minItems: 5;\n readonly maxItems: 5;\n };\n };\n };\n }\n ];\n };\n readonly CharacterApiError: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"error\"\n ];\n readonly properties: {\n readonly error: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"invalid_request\",\n \"body_too_large\",\n \"unsupported_media_type\",\n \"method_not_allowed\",\n \"not_found\"\n ];\n };\n };\n };\n readonly AvatarExpression: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly description: \"Shared eye expression across all families; does not change identity-derived shape or color.\";\n };\n readonly AvatarStatus: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\",\n \"idle\",\n \"listening\",\n \"reasoning\",\n \"working\",\n \"speaking\",\n \"success\",\n \"blocked\",\n \"error\"\n ];\n readonly description: \"Expressions map to themselves. Aliases: idle→neutral, listening→attentive, reasoning→thoughtful, working→attentive, speaking/success→happy, blocked/error→concerned. Presentation only; not evidence of actual agent activity.\";\n };\n readonly CharacterStatusV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"status\",\n \"expression\"\n ];\n readonly properties: {\n readonly status: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n };\n readonly expression: {\n readonly $ref: \"#/components/schemas/AvatarExpression\";\n };\n };\n };\n readonly CharacterAccessory: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"glasses\",\n \"headphones\"\n ];\n readonly description: \"Closed package-owned accessory identifier; independent of character family.\";\n };\n readonly CharacterAccessoriesV1: {\n readonly type: \"array\";\n readonly items: {\n readonly $ref: \"#/components/schemas/CharacterAccessory\";\n };\n readonly maxItems: 2;\n readonly uniqueItems: true;\n readonly default: readonly [\n ];\n readonly description: \"Optional independent accessories, canonicalized to glasses then headphones. Omitted selection resolves to []; no null, unknown identifier or duplicate is accepted.\";\n };\n readonly CharacterAccessoryDescriptionV1: {\n readonly type: \"object\";\n readonly additionalProperties: false;\n readonly required: readonly [\n \"id\",\n \"label\",\n \"description\"\n ];\n readonly properties: {\n readonly id: {\n readonly $ref: \"#/components/schemas/CharacterAccessory\";\n };\n readonly label: {\n readonly type: \"string\";\n readonly minLength: 1;\n };\n readonly description: {\n readonly type: \"string\";\n readonly minLength: 1;\n };\n };\n };\n readonly CharacterFinish: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"plush\",\n \"flat\"\n ];\n readonly default: \"plush\";\n readonly description: \"Shared body finish on every family: plush by default, flat for the vector material. Appearance only; identity and live state stay independent.\";\n };\n readonly CharacterEyePlacement: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"face\",\n \"raised\"\n ];\n readonly default: \"face\";\n readonly description: \"Shared live-v1 eye placement on every family: on the face by default, or raised above the head. Appearance only; all eighteen expressions remain available.\";\n };\n };\n readonly parameters: {\n readonly did: {\n readonly name: \"did\";\n readonly in: \"path\";\n readonly required: true;\n readonly schema: {\n readonly $ref: \"#/components/schemas/AgentDid\";\n };\n readonly description: \"Percent-encode the entire DID as one path segment.\";\n };\n readonly IfNoneMatch: {\n readonly name: \"If-None-Match\";\n readonly in: \"header\";\n readonly schema: {\n readonly type: \"string\";\n readonly maxLength: 4096;\n };\n readonly description: \"GET/HEAD accepts a strong/weak validator, comma-separated list or *. Headers over 4096 characters are ignored.\";\n };\n readonly skin: {\n readonly name: \"skin\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"autos\",\n \"spacex\",\n \"fold\",\n \"sprig\",\n \"ripple\",\n \"halo\",\n \"purl\",\n \"prism\",\n \"coil\",\n \"kiln\",\n \"wisp\",\n \"relay\",\n \"cairn\",\n \"tuft\",\n \"halloween\",\n \"thanksgiving\",\n \"christmas\"\n ];\n readonly default: \"autos\";\n };\n };\n readonly skinVersion: {\n readonly name: \"skinVersion\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"integer\";\n readonly const: 1;\n readonly default: 1;\n };\n };\n readonly eyeStyle: {\n readonly name: \"eyeStyle\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"live-v1\";\n readonly default: \"live-v1\";\n readonly description: \"Shared geometry across all families. Future eye geometries receive new identifiers.\";\n };\n };\n readonly size: {\n readonly name: \"size\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"integer\";\n readonly minimum: 32;\n readonly maximum: 2048;\n readonly default: 512;\n };\n readonly description: \"Unsigned decimal integer, no leading zeroes.\";\n };\n readonly animated: {\n readonly name: \"animated\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"boolean\";\n readonly default: true;\n readonly description: \"Native SMIL animation with no JavaScript or CSS.\";\n };\n readonly description: \"Exactly true or false.\";\n };\n readonly blink: {\n readonly name: \"blink\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"number\";\n readonly minimum: 0;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly description: \"Finite ordinary decimal notation, no exponent, whitespace or leading +.\";\n };\n readonly gazeX: {\n readonly name: \"gazeX\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly description: \"Finite ordinary decimal notation, no exponent, whitespace or leading +. gazeX and gazeY must be supplied together.\";\n };\n readonly gazeY: {\n readonly name: \"gazeY\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"number\";\n readonly minimum: -1;\n readonly maximum: 1;\n readonly default: 0;\n };\n readonly description: \"Finite ordinary decimal notation, no exponent, whitespace or leading +. gazeX and gazeY must be supplied together.\";\n };\n readonly shape: {\n readonly name: \"shape\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"standard\",\n \"slender\",\n \"wide\",\n \"circle\",\n \"pebble\",\n \"squircle\",\n \"capsule\",\n \"triangle\",\n \"hexagon\",\n \"cloud\",\n \"droplet\",\n \"kite\",\n \"fan\",\n \"bud\",\n \"leaf\",\n \"drop\",\n \"wave\",\n \"comet\",\n \"satellite\",\n \"mitt\",\n \"hood\",\n \"crystal\",\n \"obelisk\",\n \"spring\",\n \"bellows\",\n \"vase\",\n \"teapot\",\n \"flame\",\n \"curl\",\n \"radio\",\n \"beacon\",\n \"tower\",\n \"arch\",\n \"pom\",\n \"bear\",\n \"pumpkin\",\n \"ghost\",\n \"bat\",\n \"witch-hat\",\n \"candy-corn\",\n \"turkey\",\n \"acorn\",\n \"squash\",\n \"pie\",\n \"corn\",\n \"light\",\n \"tree\",\n \"snowman\",\n \"ornament\",\n \"gift\"\n ];\n readonly description: \"Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.\";\n };\n };\n readonly expression: {\n readonly name: \"expression\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n ];\n readonly default: \"neutral\";\n readonly description: \"Shared eye expression across all skins. Body shape and color remain unchanged. Explicit blink shrinks expression eye bars and gaze translates both together.\";\n };\n readonly description: \"Outer preferred expression fallback. A status query is state.status and overrides this preference. Explicit runtime expression overrides can be supplied in POST state.expression.\";\n };\n readonly status: {\n readonly name: \"status\";\n readonly in: \"query\";\n readonly schema: {\n readonly $ref: \"#/components/schemas/AvatarStatus\";\n };\n readonly description: \"Parsed as state.status. Overrides expression query preference with its mapped expression. Duplicate/unknown status values are refused before rendering or cache validation.\";\n };\n readonly view: {\n readonly name: \"view\";\n readonly in: \"query\";\n readonly schema: {\n readonly type: \"string\";\n readonly enum: readonly [\n \"avatar\",\n \"full\"\n ];\n readonly default: \"avatar\";\n readonly description: \"Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.\";\n };\n };\n readonly accessories: {\n readonly name: \"accessories\";\n readonly in: \"query\";\n readonly required: false;\n readonly style: \"form\";\n readonly explode: false;\n readonly allowEmptyValue: true;\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterAccessoriesV1\";\n };\n readonly description: \"One comma-separated selection, for example glasses,headphones. Empty string means []; either input order normalizes to catalog order. Repeated query parameters, duplicates, unknown IDs, whitespace and empty elements are refused.\";\n };\n readonly finish: {\n readonly name: \"finish\";\n readonly in: \"query\";\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterFinish\";\n };\n };\n readonly eyePlacement: {\n readonly name: \"eyePlacement\";\n readonly in: \"query\";\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterEyePlacement\";\n };\n };\n };\n readonly headers: {\n readonly CorsOrigin: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"*\";\n };\n };\n readonly CorsExpose: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"ETag, Content-Length\";\n };\n };\n readonly NoSniff: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"nosniff\";\n };\n };\n readonly CacheControl: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n readonly ETag: {\n readonly schema: {\n readonly type: \"string\";\n };\n readonly description: \"Strong SHA-256 validator for exact response bytes.\";\n };\n readonly ContentLength: {\n readonly schema: {\n readonly type: \"integer\";\n readonly minimum: 0;\n };\n };\n readonly SvgCsp: {\n readonly schema: {\n readonly type: \"string\";\n readonly const: \"default-src 'none'; img-src 'none'; style-src 'none'; sandbox\";\n };\n };\n };\n readonly responses: {\n readonly InvalidRequest: {\n readonly description: \"Invalid DID, malformed value or JSON, unknown field, unknown or duplicate query parameter.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly NotFound: {\n readonly description: \"Route outside this handler or unsupported route shape.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly MethodNotAllowed: {\n readonly description: \"Method not supported; Allow identifies allowed methods.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n readonly Allow: {\n readonly schema: {\n readonly type: \"string\";\n };\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly BodyTooLarge: {\n readonly description: \"Announced or streamed body exceeds 16384 bytes.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n readonly UnsupportedMediaType: {\n readonly description: \"Requires uncompressed UTF-8 application/json, optionally charset=utf-8.\";\n readonly headers: {\n readonly \"Access-Control-Allow-Origin\": {\n readonly $ref: \"#/components/headers/CorsOrigin\";\n };\n readonly \"Access-Control-Expose-Headers\": {\n readonly $ref: \"#/components/headers/CorsExpose\";\n };\n readonly \"X-Content-Type-Options\": {\n readonly $ref: \"#/components/headers/NoSniff\";\n };\n readonly \"Cache-Control\": {\n readonly $ref: \"#/components/headers/CacheControl\";\n };\n };\n readonly content: {\n readonly \"application/json\": {\n readonly schema: {\n readonly $ref: \"#/components/schemas/CharacterApiError\";\n };\n };\n };\n };\n };\n };\n};", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-api.d.ts", "line": 11, "sha256": "92153cc80f9920afe6c93a5cd33b24f4107c13def3acb13a17092ba3260acd19" } } ], "anchor": "characterapiopenapi" }, { "name": "createCharacterApiHandler", "declarationName": "createCharacterApiHandler", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Unauthenticated, stateless decoration only. This handler never resolves,\nregisters, authenticates or verifies the requested agent identity.", "tags": [], "signatures": [ { "code": "declare function createCharacterApiHandler(options?: CharacterApiHandlerOptions): (request: Request) => Promise;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-api.d.ts", "line": 9, "sha256": "92153cc80f9920afe6c93a5cd33b24f4107c13def3acb13a17092ba3260acd19" } } ], "anchor": "createcharacterapihandler" } ], "supportingDeclarations": [], "coverage": { "discovered": 3, "documented": 3, "missing": [] } }, { "subpath": "./character-state", "importSpecifier": "@openagentid/sdk/character-state", "page": "/reference/typescript/sdk/character-state", "kind": "declarations", "conditions": { "types": "./dist/character-state.d.ts", "import": "./dist/character-state.js", "require": "./dist/character-state.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/character-state.d.ts" }, { "conditions": [ "import" ], "path": "./dist/character-state.js" }, { "conditions": [ "require" ], "path": "./dist/character-state.cjs" } ], "exports": [ { "name": "AgentActivity", "declarationName": "AgentActivity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentActivity = 'idle' | 'listening' | 'reasoning' | 'working' | 'speaking' | 'success' | 'blocked' | 'error';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 4, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "agentactivity" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "AvatarStatus", "declarationName": "AvatarStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarStatus = AvatarExpression | AgentActivity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 5, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarstatus" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CharacterRuntimeState", "declarationName": "CharacterRuntimeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterRuntimeState {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 18, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterruntimestate" }, { "name": "characterStateRecord", "declarationName": "characterStateRecord", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function characterStateRecord(value: unknown): Record;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 38, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterstaterecord" }, { "name": "CharacterStateUpdate", "declarationName": "CharacterStateUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A status update clears the previous override; null restores the status expression.", "tags": [], "signatures": [ { "code": "interface CharacterStateUpdate extends Omit {\n readonly expression?: AvatarExpression | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 28, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterstateupdate" }, { "name": "expressionForStatus", "declarationName": "expressionForStatus", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function expressionForStatus(value: unknown): AvatarExpression;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 37, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "expressionforstatus" }, { "name": "getCharacterExpressions", "declarationName": "getCharacterExpressions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterExpressions(): readonly AvatarExpression[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 31, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "getcharacterexpressions" }, { "name": "getCharacterStatuses", "declarationName": "getCharacterStatuses", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterStatuses(): readonly {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n}[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 32, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "getcharacterstatuses" }, { "name": "LiveEyeState", "declarationName": "LiveEyeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LiveEyeState {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink?: number;\n readonly gaze?: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 6, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "liveeyestate" }, { "name": "parseAvatarExpression", "declarationName": "parseAvatarExpression", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function parseAvatarExpression(value: unknown): AvatarExpression;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 36, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "parseavatarexpression" }, { "name": "parseCharacterState", "declarationName": "parseCharacterState", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Validate an untrusted status snapshot without changing any identity/profile state.", "tags": [], "signatures": [ { "code": "declare function parseCharacterState(input: unknown, fallbackExpression?: AvatarExpression): CharacterRuntimeState;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 40, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "parsecharacterstate" } ], "supportingDeclarations": [], "coverage": { "discovered": 13, "documented": 13, "missing": [] } }, { "subpath": "./character-animation", "importSpecifier": "@openagentid/sdk/character-animation", "page": "/reference/typescript/sdk/character-animation", "kind": "declarations", "conditions": { "types": "./dist/character-animation.d.ts", "import": "./dist/character-animation.js", "require": "./dist/character-animation.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/character-animation.d.ts" }, { "conditions": [ "import" ], "path": "./dist/character-animation.js" }, { "conditions": [ "require" ], "path": "./dist/character-animation.cjs" } ], "exports": [ { "name": "CharacterAnimator", "declarationName": "CharacterAnimator", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAnimator {\n sample(atMs?: number): CharacterFrame;\n update(state: CharacterStateUpdate, atMs?: number): CharacterRuntimeState;\n getState(): CharacterRuntimeState;\n setReducedMotion(value: boolean, atMs?: number): void;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 23, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "characteranimator" }, { "name": "CharacterAnimatorOptions", "declarationName": "CharacterAnimatorOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAnimatorOptions extends CharacterOptions {\n readonly transitionMs?: number;\n readonly reducedMotion?: boolean;\n readonly now?: () => number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 4, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "characteranimatoroptions" }, { "name": "CharacterEyeFrame", "declarationName": "CharacterEyeFrame", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterEyeFrame {\n readonly x: number;\n readonly y: number;\n readonly width: number;\n readonly height: number;\n readonly rx: number;\n readonly rotation: number;\n readonly centerX: number;\n readonly centerY: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 10, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "charactereyeframe" }, { "name": "CharacterFrame", "declarationName": "CharacterFrame", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterFrame extends CharacterRuntimeState {\n readonly eyes: readonly [\n CharacterEyeFrame,\n CharacterEyeFrame\n ];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 20, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "characterframe" }, { "name": "createCharacterAnimator", "declarationName": "createCharacterAnimator", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "A single timeline: interruptions preserve both eye position and velocity.", "tags": [], "signatures": [ { "code": "declare function createCharacterAnimator(did: string, options?: CharacterAnimatorOptions): CharacterAnimator;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-animation.d.ts", "line": 30, "sha256": "c63309a6e63b8bb73515770dd2f8756052924027c304dc798bf396a2677019d9" } } ], "anchor": "createcharacteranimator" } ], "supportingDeclarations": [ { "name": "AgentActivity", "declarationName": "AgentActivity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentActivity = 'idle' | 'listening' | 'reasoning' | 'working' | 'speaking' | 'success' | 'blocked' | 'error';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 4, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "agentactivity" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "AvatarStatus", "declarationName": "AvatarStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarStatus = AvatarExpression | AgentActivity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 5, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarstatus" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterOptions", "declarationName": "CharacterOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterOptions extends Omit {\n readonly skin?: CharacterSkin;\n readonly expression?: AvatarExpression;\n readonly view?: CharacterView;\n readonly size?: number;\n readonly animated?: boolean;\n readonly state?: LiveEyeState;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 41, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteroptions" }, { "name": "CharacterRuntimeState", "declarationName": "CharacterRuntimeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterRuntimeState {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 18, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterruntimestate" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CharacterStateUpdate", "declarationName": "CharacterStateUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A status update clears the previous override; null restores the status expression.", "tags": [], "signatures": [ { "code": "interface CharacterStateUpdate extends Omit {\n readonly expression?: AvatarExpression | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 28, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterstateupdate" }, { "name": "CharacterView", "declarationName": "CharacterView", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterView = 'avatar' | 'full';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 25, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterview" }, { "name": "LiveEyeState", "declarationName": "LiveEyeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LiveEyeState {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink?: number;\n readonly gaze?: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 6, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "liveeyestate" } ], "coverage": { "discovered": 5, "documented": 5, "missing": [] } }, { "subpath": "./character-player", "importSpecifier": "@openagentid/sdk/character-player", "page": "/reference/typescript/sdk/character-player", "kind": "declarations", "conditions": { "types": "./dist/character-player.d.ts", "import": "./dist/character-player.js", "require": "./dist/character-player.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/character-player.d.ts" }, { "conditions": [ "import" ], "path": "./dist/character-player.js" }, { "conditions": [ "require" ], "path": "./dist/character-player.cjs" } ], "exports": [ { "name": "CharacterAppearanceUpdate", "declarationName": "CharacterAppearanceUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearanceUpdate {\n readonly skin?: CharacterSkin;\n readonly shape?: CharacterShape | null;\n readonly size?: number;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly view?: CharacterView;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-player.d.ts", "line": 12, "sha256": "94b816130e4f7ec8acb27916c609c6d2fa308f81aac0c668ab5fc27cce1247fe" } } ], "anchor": "characterappearanceupdate" }, { "name": "CharacterMotionPreference", "declarationName": "CharacterMotionPreference", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A mounted inline-SVG character; importing this module does not require a DOM.", "tags": [], "signatures": [ { "code": "type CharacterMotionPreference = boolean | 'system';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-player.d.ts", "line": 6, "sha256": "94b816130e4f7ec8acb27916c609c6d2fa308f81aac0c668ab5fc27cce1247fe" } } ], "anchor": "charactermotionpreference" }, { "name": "CharacterPlayer", "declarationName": "CharacterPlayer", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterPlayer {\n update(state: CharacterStateUpdate): CharacterRuntimeState;\n setAppearance(appearance: CharacterAppearanceUpdate): void;\n setReducedMotion(preference: CharacterMotionPreference): void;\n getState(): CharacterRuntimeState;\n dispose(): void;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-player.d.ts", "line": 23, "sha256": "94b816130e4f7ec8acb27916c609c6d2fa308f81aac0c668ab5fc27cce1247fe" } } ], "anchor": "characterplayer" }, { "name": "CharacterPlayerOptions", "declarationName": "CharacterPlayerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterPlayerOptions extends CharacterOptions {\n readonly transitionMs?: number;\n readonly reducedMotion?: CharacterMotionPreference;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-player.d.ts", "line": 7, "sha256": "94b816130e4f7ec8acb27916c609c6d2fa308f81aac0c668ab5fc27cce1247fe" } } ], "anchor": "characterplayeroptions" }, { "name": "mountCharacter", "declarationName": "mountCharacter", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Hosts deliver authorized state updates; this renderer never writes an agent profile.", "tags": [], "signatures": [ { "code": "declare function mountCharacter(element: Element, did: string, options?: CharacterPlayerOptions): CharacterPlayer;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-player.d.ts", "line": 31, "sha256": "94b816130e4f7ec8acb27916c609c6d2fa308f81aac0c668ab5fc27cce1247fe" } } ], "anchor": "mountcharacter" } ], "supportingDeclarations": [ { "name": "AgentActivity", "declarationName": "AgentActivity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentActivity = 'idle' | 'listening' | 'reasoning' | 'working' | 'speaking' | 'success' | 'blocked' | 'error';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 4, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "agentactivity" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "AvatarStatus", "declarationName": "AvatarStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarStatus = AvatarExpression | AgentActivity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 5, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarstatus" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterOptions", "declarationName": "CharacterOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterOptions extends Omit {\n readonly skin?: CharacterSkin;\n readonly expression?: AvatarExpression;\n readonly view?: CharacterView;\n readonly size?: number;\n readonly animated?: boolean;\n readonly state?: LiveEyeState;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 41, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteroptions" }, { "name": "CharacterRuntimeState", "declarationName": "CharacterRuntimeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterRuntimeState {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 18, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterruntimestate" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CharacterStateUpdate", "declarationName": "CharacterStateUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A status update clears the previous override; null restores the status expression.", "tags": [], "signatures": [ { "code": "interface CharacterStateUpdate extends Omit {\n readonly expression?: AvatarExpression | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 28, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "characterstateupdate" }, { "name": "CharacterView", "declarationName": "CharacterView", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterView = 'avatar' | 'full';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 25, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterview" }, { "name": "LiveEyeState", "declarationName": "LiveEyeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LiveEyeState {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink?: number;\n readonly gaze?: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 6, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "liveeyestate" } ], "coverage": { "discovered": 5, "documented": 5, "missing": [] } }, { "subpath": "./browser", "importSpecifier": "@openagentid/sdk/browser", "page": "/reference/typescript/sdk/browser", "kind": "declarations", "conditions": { "types": "./dist/browser/character-player.d.ts", "import": "./dist/browser/character-player.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/browser/character-player.d.ts" }, { "conditions": [ "import" ], "path": "./dist/browser/character-player.js" } ], "exports": [ { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 3, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "avatarexpression" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 39, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 57, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterappearance" }, { "name": "CharacterAppearanceUpdate", "declarationName": "CharacterAppearanceUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearanceUpdate {\n readonly skin?: CharacterSkin;\n readonly shape?: CharacterShape | null;\n readonly size?: number;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly view?: CharacterView;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 124, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterappearanceupdate" }, { "name": "CharacterDescriptor", "declarationName": "CharacterDescriptor", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterDescriptor {\n readonly did: string;\n readonly skin: CharacterSkin;\n readonly skinVersion: 1;\n readonly eyeStyle: CharacterEyeStyle;\n readonly finish: CharacterFinish;\n readonly eyePlacement: CharacterEyePlacement;\n readonly shape: CharacterShape;\n readonly accessories: readonly CharacterAccessory[];\n readonly expression: AvatarExpression;\n readonly color: string;\n readonly view: CharacterView;\n readonly size: number;\n readonly animated: boolean;\n readonly state: {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n };\n readonly svg: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 88, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterdescriptor" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 55, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 50, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterfinish" }, { "name": "CharacterOptions", "declarationName": "CharacterOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterOptions extends Omit {\n readonly skin?: CharacterSkin;\n readonly expression?: AvatarExpression;\n readonly view?: CharacterView;\n readonly size?: number;\n readonly animated?: boolean;\n readonly state?: LiveEyeState;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 69, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characteroptions" }, { "name": "CharacterPlayer", "declarationName": "CharacterPlayer", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterPlayer {\n update(state: CharacterStateUpdate): CharacterRuntimeState;\n setAppearance(appearance: CharacterAppearanceUpdate): void;\n setReducedMotion(preference: CharacterMotionPreference): void;\n getState(): CharacterRuntimeState;\n dispose(): void;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 135, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterplayer" }, { "name": "CharacterPlayerOptions", "declarationName": "CharacterPlayerOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterPlayerOptions extends CharacterOptions {\n readonly transitionMs?: number;\n readonly reducedMotion?: CharacterMotionPreference;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 119, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterplayeroptions" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 56, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 52, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterskin" }, { "name": "CharacterView", "declarationName": "CharacterView", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterView = 'avatar' | 'full';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 53, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterview" }, { "name": "getCharacterAccessories", "declarationName": "getCharacterAccessories", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Immutable catalog. Accessories can be combined and default to none.", "tags": [], "signatures": [ { "code": "declare function getCharacterAccessories(): readonly CharacterAccessoryDescription[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 46, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "getcharacteraccessories" }, { "name": "getCharacterExpressions", "declarationName": "getCharacterExpressions", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterExpressions(): readonly AvatarExpression[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 31, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "getcharacterexpressions" }, { "name": "getCharacterSkins", "declarationName": "getCharacterSkins", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Immutable versioned body/face skins. Eye expression is independent of skin.", "tags": [], "signatures": [ { "code": "declare function getCharacterSkins(): readonly CharacterSkinDescription[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 114, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "getcharacterskins" }, { "name": "getCharacterStatuses", "declarationName": "getCharacterStatuses", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare function getCharacterStatuses(): readonly {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n}[];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 32, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "getcharacterstatuses" }, { "name": "LiveEyeState", "declarationName": "LiveEyeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface LiveEyeState {\n readonly status?: AvatarStatus;\n readonly expression?: AvatarExpression;\n readonly blink?: number;\n readonly gaze?: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 6, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "liveeyestate" }, { "name": "mountCharacter", "declarationName": "mountCharacter", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "Hosts deliver authorized state updates; this renderer never writes an agent profile.", "tags": [], "signatures": [ { "code": "declare function mountCharacter(element: Element, did: string, options?: CharacterPlayerOptions): CharacterPlayer;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 143, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "mountcharacter" } ], "supportingDeclarations": [ { "name": "AgentActivity", "declarationName": "AgentActivity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AgentActivity = 'idle' | 'listening' | 'reasoning' | 'working' | 'speaking' | 'success' | 'blocked' | 'error';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 4, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "agentactivity" }, { "name": "AvatarStatus", "declarationName": "AvatarStatus", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarStatus = AvatarExpression | AgentActivity;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 5, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "avatarstatus" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 2, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "character_expressions" }, { "name": "CharacterAccessoryDescription", "declarationName": "CharacterAccessoryDescription", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAccessoryDescription {\n readonly id: CharacterAccessory;\n readonly label: string;\n readonly description: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 40, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characteraccessorydescription" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 54, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterMotionPreference", "declarationName": "CharacterMotionPreference", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "A mounted inline-SVG character; importing this module does not require a DOM.", "tags": [], "signatures": [ { "code": "type CharacterMotionPreference = boolean | 'system';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 118, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "charactermotionpreference" }, { "name": "CharacterRuntimeState", "declarationName": "CharacterRuntimeState", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterRuntimeState {\n readonly status: AvatarStatus;\n readonly expression: AvatarExpression;\n readonly blink: number;\n readonly gaze: {\n readonly x: number;\n readonly y: number;\n };\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 18, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterruntimestate" }, { "name": "CharacterSkinDescription", "declarationName": "CharacterSkinDescription", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterSkinDescription {\n readonly id: CharacterSkin;\n readonly label: string;\n readonly version: 1;\n readonly eyeStyles: readonly CharacterEyeStyle[];\n readonly shapes: readonly CharacterShape[];\n readonly expressions: readonly AvatarExpression[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 80, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterskindescription" }, { "name": "CharacterStateUpdate", "declarationName": "CharacterStateUpdate", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A status update clears the previous override; null restores the status expression.", "tags": [], "signatures": [ { "code": "interface CharacterStateUpdate extends Omit {\n readonly expression?: AvatarExpression | null;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/browser/character-player.d.ts", "line": 28, "sha256": "1c55528f2b77f477a29b746cf69548559055b4df97735c3766983f31e9d029ef" } } ], "anchor": "characterstateupdate" } ], "coverage": { "discovered": 19, "documented": 19, "missing": [] } }, { "subpath": "./local", "importSpecifier": "@openagentid/sdk/local", "page": "/reference/typescript/sdk/local", "kind": "declarations", "conditions": { "types": "./dist/local-workspace.d.ts", "import": "./dist/local-workspace.js", "require": "./dist/local-workspace.cjs" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/local-workspace.d.ts" }, { "conditions": [ "import" ], "path": "./dist/local-workspace.js" }, { "conditions": [ "require" ], "path": "./dist/local-workspace.cjs" } ], "exports": [ { "name": "LocalAgent", "declarationName": "LocalAgent", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Local receiver registration metadata; this is not a global owner record.", "tags": [], "signatures": [ { "code": "interface LocalAgent {\n readonly did: string;\n readonly name: string;\n readonly publicKeyJwk: LocalPublicKeyJwk;\n readonly createdAt: number;\n readonly revoked: boolean;\n readonly hasPrivateKey: boolean;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/local-workspace.d.ts", "line": 11, "sha256": "9bd3b42a12d5f52088296161a184c3aec403aec8ad6b1d55032d50afb5997dc6" } } ], "anchor": "localagent" }, { "name": "LocalAgentDocument", "declarationName": "LocalAgentDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Portable public identity document. Importing it requires explicit trust.", "tags": [], "signatures": [ { "code": "interface LocalAgentDocument {\n readonly schemaVersion: 1;\n readonly did: string;\n readonly name: string;\n readonly publicKeyJwk: LocalPublicKeyJwk;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/local-workspace.d.ts", "line": 21, "sha256": "9bd3b42a12d5f52088296161a184c3aec403aec8ad6b1d55032d50afb5997dc6" } } ], "anchor": "localagentdocument" }, { "name": "LocalChallenge", "declarationName": "LocalChallenge", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Existing, receiver-issued challenge. All times are Unix seconds.", "tags": [], "signatures": [ { "code": "interface LocalChallenge {\n readonly nonce: string;\n readonly audience: string;\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/local-workspace.d.ts", "line": 28, "sha256": "9bd3b42a12d5f52088296161a184c3aec403aec8ad6b1d55032d50afb5997dc6" } } ], "anchor": "localchallenge" }, { "name": "LocalPublicKeyJwk", "declarationName": "LocalPublicKeyJwk", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Public Ed25519 material. Private JWK parameters are never exported.", "tags": [], "signatures": [ { "code": "interface LocalPublicKeyJwk {\n readonly kty: 'OKP';\n readonly crv: 'Ed25519';\n readonly x: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/local-workspace.d.ts", "line": 5, "sha256": "9bd3b42a12d5f52088296161a184c3aec403aec8ad6b1d55032d50afb5997dc6" } } ], "anchor": "localpublickeyjwk" }, { "name": "LocalWorkspaceError", "declarationName": "LocalWorkspaceError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Workspace failures never include private material or state-file contents.", "tags": [], "signatures": [ { "code": "declare class LocalWorkspaceError extends Error {\n readonly code: LocalWorkspaceFailure;\n readonly name = \"LocalWorkspaceError\";\n constructor(code: LocalWorkspaceFailure, message: string);\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/local-workspace.d.ts", "line": 35, "sha256": "9bd3b42a12d5f52088296161a184c3aec403aec8ad6b1d55032d50afb5997dc6" } } ], "anchor": "localworkspaceerror" }, { "name": "LocalWorkspaceFailure", "declarationName": "LocalWorkspaceFailure", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type LocalWorkspaceFailure = 'invalid_input' | 'invalid_state' | 'unavailable' | 'locked' | 'untrusted_identity' | 'no_signer' | 'revoked' | 'capacity';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/local-workspace.d.ts", "line": 33, "sha256": "9bd3b42a12d5f52088296161a184c3aec403aec8ad6b1d55032d50afb5997dc6" } } ], "anchor": "localworkspacefailure" }, { "name": "OpenAgentWorkspace", "declarationName": "OpenAgentWorkspace", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Durable, explicitly local trust and private signing-key custody.", "tags": [], "signatures": [ { "code": "declare class OpenAgentWorkspace {\n static initialize(directory: string, options: {\n audience: string;\n namespace?: string;\n }): Promise;\n static open(directory: string): Promise;\n createAgent(name: string): Promise;\n listAgents(): Promise;\n exportIdentity(did: string): Promise;\n trustIdentity(document: LocalAgentDocument): Promise;\n issueChallenge(did: string): Promise;\n prove(did: string, options: {\n nonce: string;\n audience: string;\n }): Promise;\n verify(proof: AgentIdentityProof, options: {\n nonce: string;\n }): Promise;\n revoke(did: string): Promise;\n inspect(): Promise<{\n audience: string;\n namespace: string;\n agents: number;\n signers: number;\n revoked: number;\n }>;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/local-workspace.d.ts", "line": 41, "sha256": "9bd3b42a12d5f52088296161a184c3aec403aec8ad6b1d55032d50afb5997dc6" } } ], "anchor": "openagentworkspace" } ], "supportingDeclarations": [ { "name": "AgentIdentityProof", "declarationName": "AgentIdentityProof", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface AgentIdentityProof {\n readonly token: string;\n readonly delegations: readonly string[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 42, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "agentidentityproof" }, { "name": "CommonAgentIdentity", "declarationName": "CommonAgentIdentity", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CommonAgentIdentity {\n readonly did: string;\n readonly lineage: readonly string[];\n readonly expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 8, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "commonagentidentity" }, { "name": "VerifiedAgentIdentity", "declarationName": "VerifiedAgentIdentity", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Current identity trust. This grants no application scopes or tenant access.", "tags": [], "signatures": [ { "code": "type VerifiedAgentIdentity = CommonAgentIdentity & ({\n readonly owner: VerifiedOwner;\n readonly root?: {\n readonly kind: 'lifeid';\n readonly did: string;\n };\n} | {\n readonly owner: null;\n readonly root: {\n readonly kind: 'self';\n readonly did: string;\n readonly authorizationId: string;\n readonly revision: string;\n };\n});", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 16, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedagentidentity" }, { "name": "VerifiedOwner", "declarationName": "VerifiedOwner", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface VerifiedOwner {\n readonly issuer: string;\n readonly subject: string;\n readonly organizationId?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity-verification.d.ts", "line": 3, "sha256": "dd00e3e0a2469835b629cb6751756db96d4036fdba8b74910c92613658a1f37f" } } ], "anchor": "verifiedowner" } ], "coverage": { "discovered": 7, "documented": 7, "missing": [] } } ] }, { "name": "@openagentid/sdk-testing", "version": "0.1.1", "status": "testing-only", "notes": [ "Fabricates identities and accepts stub tokens. Never use as a real signer or verifier.", "Declares a required peer on @openagentid/sdk ^0.1.0, which excludes SDK 0.7.2." ], "tarball": "https://registry.npmjs.org/@openagentid/sdk-testing/-/sdk-testing-0.1.1.tgz", "integrity": "sha512-+9TXTWFWNxn9dyZLZTK5GEsUIYdGS2rUCHubsy+WGGCbrVaKRwAvEW+bOQV5Nr6dd/EmQE3jum6XKB1DvffCPA==", "packageJsonSha256": "2d484a0378bf305e08f82b4845b49cc6c89ae7acf812640645aacfb19fc3345f", "page": "/reference/typescript/sdk-testing", "engines": {}, "dependencies": { "zod": "^3.23.8" }, "peerDependencies": { "@openagentid/sdk": "^0.1.0" }, "peerDependenciesMeta": {}, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/sdk-testing", "page": "/reference/typescript/sdk-testing", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "createTestingConfig", "declarationName": "createTestingConfig", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "An {@link OpenAgentConfig} with all three in-memory backends wired in.\n\nThe production SDK requires real protocol clients and fails closed when one\nis missing; tests opt into the fakes explicitly through this helper.", "tags": [], "signatures": [ { "code": "declare function createTestingConfig(overrides?: Partial): OpenAgentConfig;", "source": { "package": "@openagentid/sdk-testing", "version": "0.1.1", "file": "dist/index.d.ts", "line": 73, "sha256": "be716f31207cb672e208885d80004694101c74035103a8c904c99282ecfca8e6" } } ], "anchor": "createtestingconfig" }, { "name": "stubArsenalClient", "declarationName": "stubArsenalClient", "kind": "FunctionDeclaration", "typeOnly": false, "documentation": "In-memory Arsenal client for tests. Echoes a deterministic proxy URL per\nprovider without minting any credential.", "tags": [], "signatures": [ { "code": "declare function stubArsenalClient(): ArsenalClient;", "source": { "package": "@openagentid/sdk-testing", "version": "0.1.1", "file": "dist/index.d.ts", "line": 46, "sha256": "be716f31207cb672e208885d80004694101c74035103a8c904c99282ecfca8e6" } } ], "anchor": "stubarsenalclient" }, { "name": "StubIdentityProvider", "declarationName": "StubIdentityProvider", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory identity provider for tests.\n\nGenerates deterministic-looking DIDs and public keys. NOT cryptographically\nsound for production - `signChallenge` returns a tagged base64 blob, not an\nEd25519 signature.", "tags": [], "signatures": [ { "code": "declare class StubIdentityProvider implements IdentityProvider {\n constructor(namespace?: string);\n createAgentIdentity(input: CreateAgentInput): Promise;\n resolve(did: Did): Promise;\n signChallenge(did: Did, challenge: Uint8Array): Promise;\n publicKey(did: Did): Promise;\n}", "source": { "package": "@openagentid/sdk-testing", "version": "0.1.1", "file": "dist/index.d.ts", "line": 33, "sha256": "be716f31207cb672e208885d80004694101c74035103a8c904c99282ecfca8e6" } } ], "anchor": "stubidentityprovider" }, { "name": "StubVerificationClient", "declarationName": "StubVerificationClient", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "In-memory verification client for tests.\n\nAccepts any request carrying `Authorization: OpenAgent stub:` or\n`Authorization: Bearer stub:` and returns a synthetic\n{@link AuthContext}. NOT a real verifier: any well-formed stub token passes.", "tags": [], "signatures": [ { "code": "declare class StubVerificationClient implements VerificationClient {\n verifyRequest(req: Request, options?: VerifyRequestOptions): Promise;\n issueChallenge(): Promise<{\n challenge: Uint8Array;\n challengeId: string;\n }>;\n verifyChallengeResponse(params: {\n challengeId: string;\n agentDid: Did;\n signatureBase64: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk-testing", "version": "0.1.1", "file": "dist/index.d.ts", "line": 54, "sha256": "be716f31207cb672e208885d80004694101c74035103a8c904c99282ecfca8e6" } } ], "anchor": "stubverificationclient" } ], "supportingDeclarations": [ { "name": "ArsenalClient", "declarationName": "ArsenalClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Arsenal broker client facade. The real client lives in `@openagentid/arsenal-sdk`\nand is injected by the application; see `INTEGRATION_NOTES.md`.", "tags": [], "signatures": [ { "code": "interface ArsenalClient {\n requestCredential(params: {\n agentDid: Did;\n provider: string;\n scopes?: readonly string[];\n }): Promise;\n release?(credentialProxyUrl: string): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 51, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "arsenalclient" }, { "name": "AuthContext", "declarationName": "AuthContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A resolved, authenticated caller identity.", "tags": [], "signatures": [ { "code": "interface AuthContext {\n readonly did: Did;\n readonly root: Did;\n readonly lineage: readonly Did[];\n readonly lineageAuthority?: LineageAuthorityContext;\n readonly scopes: readonly string[];\n readonly expiresAt: number;\n readonly presentedToken?: string;\n readonly claims?: Readonly>;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 44, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "authcontext" }, { "name": "AvatarExpression", "declarationName": "AvatarExpression", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type AvatarExpression = typeof CHARACTER_EXPRESSIONS[number];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 3, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "avatarexpression" }, { "name": "CHARACTER_EXPRESSIONS", "declarationName": "CHARACTER_EXPRESSIONS", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Portable presentation state. Status never grants identity or application authority.", "tags": [], "signatures": [ { "code": "declare const CHARACTER_EXPRESSIONS: readonly [\n \"neutral\",\n \"attentive\",\n \"surprised\",\n \"excited\",\n \"happy\",\n \"laughing\",\n \"angry\",\n \"sad\",\n \"scared\",\n \"suspicious\",\n \"confused\",\n \"curious\",\n \"proud\",\n \"shy\",\n \"unimpressed\",\n \"sleepy\",\n \"thoughtful\",\n \"concerned\"\n];", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/character-state.d.ts", "line": 2, "sha256": "221a0c3460864f6910489f467d352b93d8d76200b88b13a532314012d360e7f8" } } ], "anchor": "character_expressions" }, { "name": "CharacterAccessory", "declarationName": "CharacterAccessory", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Independent, package-owned wearables in the shared face coordinate space.", "tags": [], "signatures": [ { "code": "type CharacterAccessory = 'glasses' | 'headphones';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 6, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characteraccessory" }, { "name": "CharacterAppearance", "declarationName": "CharacterAppearance", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "interface CharacterAppearance {\n readonly skin: CharacterSkin;\n readonly skinVersion?: 1;\n readonly eyeStyle?: CharacterEyeStyle;\n readonly finish?: CharacterFinish;\n readonly eyePlacement?: CharacterEyePlacement;\n readonly shape?: CharacterShape;\n readonly accessories?: readonly CharacterAccessory[];\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 29, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterappearance" }, { "name": "CharacterEyePlacement", "declarationName": "CharacterEyePlacement", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyePlacement = 'face' | 'raised';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 27, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyeplacement" }, { "name": "CharacterEyeStyle", "declarationName": "CharacterEyeStyle", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterEyeStyle = 'live-v1';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 26, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactereyestyle" }, { "name": "CharacterFinish", "declarationName": "CharacterFinish", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "One self-contained material for every package-owned silhouette.", "tags": [], "signatures": [ { "code": "type CharacterFinish = 'plush' | 'flat';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 19, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterfinish" }, { "name": "CharacterShape", "declarationName": "CharacterShape", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterShape = 'standard' | 'slender' | 'wide' | 'circle' | 'pebble' | 'squircle' | 'capsule' | 'triangle' | 'hexagon' | 'cloud' | 'droplet' | 'kite' | 'fan' | 'bud' | 'leaf' | 'drop' | 'wave' | 'comet' | 'satellite' | 'mitt' | 'hood' | 'crystal' | 'obelisk' | 'spring' | 'bellows' | 'vase' | 'teapot' | 'flame' | 'curl' | 'radio' | 'beacon' | 'tower' | 'arch' | 'pom' | 'bear' | 'pumpkin' | 'ghost' | 'bat' | 'witch-hat' | 'candy-corn' | 'turkey' | 'acorn' | 'squash' | 'pie' | 'corn' | 'light' | 'tree' | 'snowman' | 'ornament' | 'gift';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 28, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "charactershape" }, { "name": "CharacterSkin", "declarationName": "CharacterSkin", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CharacterSkin = 'autos' | 'spacex' | 'fold' | 'sprig' | 'ripple' | 'halo' | 'purl' | 'prism' | 'coil' | 'kiln' | 'wisp' | 'relay' | 'cairn' | 'tuft' | 'halloween' | 'thanksgiving' | 'christmas';", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/characters.d.ts", "line": 24, "sha256": "4c6ee8986a091c3e69843dd900d268ffaa541e594c927c6b349826043cfb8f9d" } } ], "anchor": "characterskin" }, { "name": "CreateAgentInput", "declarationName": "CreateAgentInput", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "type CreateAgentInput = z.infer;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 56, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinput" }, { "name": "createAgentInputSchema", "declarationName": "createAgentInputSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "Parameters accepted by {@link OpenAgent.createAgent }.", "tags": [], "signatures": [ { "code": "declare const createAgentInputSchema: z.ZodObject<{\n parent: z.ZodEffects;\n name: z.ZodString;\n scopes: z.ZodArray;\n namespace: z.ZodOptional;\n skills: z.ZodOptional>;\n metadata: z.ZodOptional>;\n}, \"strict\", z.ZodTypeAny, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}, {\n parent: string;\n name: string;\n scopes: string[];\n namespace?: string | undefined;\n skills?: string[] | undefined;\n metadata?: Record | undefined;\n}>;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 28, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "createagentinputschema" }, { "name": "Did", "declarationName": "Did", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "Fully qualified `did:oas` identifier.", "tags": [], "signatures": [ { "code": "type Did = string;", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 7, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "did" }, { "name": "IdentityDocument", "declarationName": "IdentityDocument", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "OAS identity document fragment — minimum fields needed by the SDK.", "tags": [], "signatures": [ { "code": "interface IdentityDocument {\n did: Did;\n parent: Did;\n publicKeyMultibase: string;\n kind: string;\n scopes: readonly string[];\n createdAt: string;\n avatarOverride?: string | null;\n avatarSkin?: CharacterAppearance | null;\n avatarExpression?: AvatarExpression;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 9, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identitydocument" }, { "name": "IdentityProvider", "declarationName": "IdentityProvider", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "The OAS identity facade. Concrete providers come from `@openagentid/oas-sdk`\n(production) or from {@link StubIdentityProvider } (test / offline dev).", "tags": [], "signatures": [ { "code": "interface IdentityProvider {\n createAgentIdentity(input: CreateAgentInput): Promise;\n resolve(did: Did): Promise;\n signChallenge(did: Did, challenge: Uint8Array): Promise;\n publicKey(did: Did): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 48, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "identityprovider" }, { "name": "IssuedCredential", "declarationName": "IssuedCredential", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "A short-lived credential minted by the Arsenal broker.", "tags": [], "signatures": [ { "code": "interface IssuedCredential {\n provider: string;\n proxyUrl: string;\n expiresAt: number;\n remainingCalls?: number;\n metadata?: Record;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/credentials.d.ts", "line": 32, "sha256": "fe0eccc41e824e7b33aa60624ba171def8bd43eb7f9ec3d5814dd4104160b299" } } ], "anchor": "issuedcredential" }, { "name": "LineageAuthorityContext", "declarationName": "LineageAuthorityContext", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Sigil-backed lineage authority attached by an OAS verifier.", "tags": [], "signatures": [ { "code": "interface LineageAuthorityContext {\n readonly subject: Did;\n readonly source: string;\n readonly root: Did;\n readonly path: readonly Did[];\n readonly finalizedBlock: number;\n readonly pathKind: string;\n readonly scopes: readonly string[];\n readonly generation: number;\n readonly rootKind?: string;\n readonly orgRootCommitment?: string;\n readonly expiresAt?: string;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 19, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "lineageauthoritycontext" }, { "name": "Logger", "declarationName": "Logger", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Logger interface — structured, dependency-free.", "tags": [], "signatures": [ { "code": "interface Logger {\n debug(msg: string, fields?: Record): void;\n info(msg: string, fields?: Record): void;\n warn(msg: string, fields?: Record): void;\n error(msg: string, fields?: Record): void;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 58, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "logger" }, { "name": "OpenAgentClients", "declarationName": "OpenAgentClients", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Forward-declared clients for the three wrapped subsystems.\n\nConcrete interfaces live in the per-module files so that this config file\ndoes not depend on internal implementation details.", "tags": [], "signatures": [ { "code": "interface OpenAgentClients {\n readonly identity?: unknown;\n readonly credentials?: unknown;\n readonly verification?: unknown;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 72, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "openagentclients" }, { "name": "OpenAgentConfig", "declarationName": "OpenAgentConfig", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Global SDK configuration.\n\nAll fields are optional at construction. Identity, credentials and request\nverification each require their configured client when used. For a complete\nfile-backed Node identity authority, use the separate SDK `./local` export.", "tags": [], "signatures": [ { "code": "interface OpenAgentConfig {\n namespace?: string;\n endpoints?: {\n oasResolver?: string;\n arsenalBroker?: string;\n aegisVerifier?: string;\n };\n fetch?: typeof fetch;\n logger?: Logger;\n requestTimeoutMs?: number;\n clients?: OpenAgentClients;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/config.d.ts", "line": 84, "sha256": "5168a38045953b98e56c1054d014e6491833f584c87ca2ac71c0898c12bb3cc8" } } ], "anchor": "openagentconfig" }, { "name": "SignedAssertion", "declarationName": "SignedAssertion", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Signed credential returned by the identity provider.", "tags": [], "signatures": [ { "code": "interface SignedAssertion {\n token: string;\n signature: string;\n signer: Did;\n issuedAt: number;\n expiresAt: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/identity.d.ts", "line": 32, "sha256": "f677e3df5c9e199fc5445c2e534739cbcd50bfaa1e2e749e7821f6cc52b8ea89" } } ], "anchor": "signedassertion" }, { "name": "VerificationClient", "declarationName": "VerificationClient", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "AEGIS verifier facade. Concrete implementation lives in `@openagentid/aegis-sdk`.\n\nThe OpenAgent SDK never decodes assertions itself — it delegates to\nAEGIS for all verification, lineage walking, and policy evaluation.", "tags": [], "signatures": [ { "code": "interface VerificationClient {\n verifyRequest(req: Request, options?: VerifyRequestOptions): Promise;\n issueChallenge(): Promise<{\n challenge: Uint8Array;\n challengeId: string;\n }>;\n verifyChallengeResponse(params: {\n challengeId: string;\n agentDid: Did;\n signatureBase64: string;\n }): Promise;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 81, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verificationclient" }, { "name": "VerifyRequestOptions", "declarationName": "VerifyRequestOptions", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Options for {@link VerificationClient.verifyRequest}.", "tags": [], "signatures": [ { "code": "interface VerifyRequestOptions {\n requiredScopes?: readonly string[];\n requiredAncestor?: Did;\n requirePrivilegedAuthority?: boolean;\n requiredAuthorityPath?: string;\n clockSkewSeconds?: number;\n}", "source": { "package": "@openagentid/sdk", "version": "0.7.2", "file": "dist/verification.d.ts", "line": 63, "sha256": "da4be0578a790b861f44bae9a7478ea0fe4b44b65b14ff685eb5959c86c7a07e" } } ], "anchor": "verifyrequestoptions" } ], "coverage": { "discovered": 4, "documented": 4, "missing": [] } } ] }, { "name": "@openagentid/skills-policy", "version": "0.1.1", "status": "published", "notes": [], "tarball": "https://registry.npmjs.org/@openagentid/skills-policy/-/skills-policy-0.1.1.tgz", "integrity": "sha512-6coVAx4Mz4ajRXk1CXN58F9fcOoYTWYRzAeTIOSRwBNV2u4I9AQ4NiCy1Mvi98+7okNZ6nxg7C/6r8XVVf73uQ==", "packageJsonSha256": "8c50153053dc44997ae1aebcb0f76cb6e38271f60fa05a75253dadf43033a7ff", "page": "/reference/typescript/skills-policy", "engines": {}, "dependencies": { "@noble/hashes": "^1.4.0", "ajv": "^8.17.1", "ajv-formats": "^3.0.1", "yaml": "^2.6.0", "zod": "^3.23.8" }, "peerDependencies": { "@openagentid/arsenal-sdk": "^0.1.0" }, "peerDependenciesMeta": { "@openagentid/arsenal-sdk": { "optional": true } }, "bin": {}, "entryPoints": [ { "subpath": ".", "importSpecifier": "@openagentid/skills-policy", "page": "/reference/typescript/skills-policy", "kind": "declarations", "conditions": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "paths": [ { "conditions": [ "types" ], "path": "./dist/index.d.ts" }, { "conditions": [ "import" ], "path": "./dist/index.js" } ], "exports": [ { "name": "ArgumentConstraintError", "declarationName": "ArgumentConstraintError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class ArgumentConstraintError extends SkillsPolicyError {\n readonly name = \"ArgumentConstraintError\";\n readonly skill: string;\n readonly details: string;\n constructor(skill: string, details: string);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 33, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "argumentconstrainterror" }, { "name": "AuditChain", "declarationName": "AuditChain", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class AuditChain {\n get length(): number;\n get isEmpty(): boolean;\n head(): string;\n get(sequence: number): Receipt | undefined;\n all(): readonly Receipt[];\n verify(): boolean;\n append(skill: string, agent: string, session: string, invokedAt: Date, level: AuditLevel, args: unknown): Receipt;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 26, "sha256": "aa0f2a6b37f9179e5b890028582c0eb991be3df7e6b0b82acdf871d8fa9ea6e9" } } ], "anchor": "auditchain" }, { "name": "AuditLevel", "declarationName": "AuditLevel", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type AuditLevel = z.infer;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 12, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "auditlevel" }, { "name": "ConsentRequiredError", "declarationName": "ConsentRequiredError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class ConsentRequiredError extends SkillsPolicyError {\n readonly name = \"ConsentRequiredError\";\n readonly skill: string;\n constructor(skill: string);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 44, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "consentrequirederror" }, { "name": "CURRENT_VERSION", "declarationName": "CURRENT_VERSION", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const CURRENT_VERSION: 1;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 9, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "current_version" }, { "name": "DefaultRule", "declarationName": "DefaultRule", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type DefaultRule = z.infer;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 106, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "defaultrule" }, { "name": "Did", "declarationName": "Did", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Minimal DID wrapper used for binding a policy to an agent.\n\nMirrors `openagent_skills_policy::Did` in Rust. A full W3C DID parser\nlives in the OAS SDK; for this narrow use case we only need enough\nvalidation to reject obviously malformed values.", "tags": [], "signatures": [ { "code": "export declare class Did {\n static parse(input: string): Did;\n toString(): string;\n equals(other: Did): boolean;\n asString(): string;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/did.d.ts", "line": 8, "sha256": "b4d1678b6188b73eb5ed9eba39e350550650a3ccfebaa22fc9197b690b7de24c" } } ], "anchor": "did" }, { "name": "HASH_LEN", "declarationName": "HASH_LEN", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const HASH_LEN = 32;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 13, "sha256": "aa0f2a6b37f9179e5b890028582c0eb991be3df7e6b0b82acdf871d8fa9ea6e9" } } ], "anchor": "hash_len" }, { "name": "InvalidPolicyError", "declarationName": "InvalidPolicyError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class InvalidPolicyError extends SkillsPolicyError {\n readonly name = \"InvalidPolicyError\";\n constructor(message: string);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 11, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "invalidpolicyerror" }, { "name": "InvalidSkillsMarkdownError", "declarationName": "InvalidSkillsMarkdownError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class InvalidSkillsMarkdownError extends SkillsPolicyError {\n readonly name = \"InvalidSkillsMarkdownError\";\n constructor(message: string);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 15, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "invalidskillsmarkdownerror" }, { "name": "InvocationContext", "declarationName": "InvocationContext", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Context describing a single attempted skill invocation. Immutable;\nbuilder-style helpers return new instances.", "tags": [], "signatures": [ { "code": "export declare class InvocationContext {\n readonly agentDid: Did;\n readonly sessionId: string;\n readonly arguments: unknown;\n readonly invokedAt: Date;\n readonly consentGranted: boolean;\n constructor(init: InvocationContextInit);\n withConsent(): InvocationContext;\n withInvokedAt(invokedAt: Date): InvocationContext;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/engine.d.ts", "line": 25, "sha256": "c1146fdd0e4e69ff19d0e55d315eae2307adadd025c71d744e050c55bfb702cd" } } ], "anchor": "invocationcontext" }, { "name": "MAX_SKILL_RULES", "declarationName": "MAX_SKILL_RULES", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const MAX_SKILL_RULES = 256;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 10, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "max_skill_rules" }, { "name": "NotAllowedError", "declarationName": "NotAllowedError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class NotAllowedError extends SkillsPolicyError {\n readonly name = \"NotAllowedError\";\n readonly skill: string;\n readonly reason: string;\n constructor(skill: string, reason: string);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 19, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "notallowederror" }, { "name": "OutsideTimeWindowError", "declarationName": "OutsideTimeWindowError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class OutsideTimeWindowError extends SkillsPolicyError {\n readonly name = \"OutsideTimeWindowError\";\n readonly skill: string;\n constructor(skill: string);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 39, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "outsidetimewindowerror" }, { "name": "RateLimit", "declarationName": "RateLimit", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type RateLimit = z.infer;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 23, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "ratelimit" }, { "name": "RateLimitDecision", "declarationName": "RateLimitDecision", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type RateLimitDecision = {\n kind: \"allowed\";\n} | {\n kind: \"denied\";\n used: number;\n};", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/rate.d.ts", "line": 9, "sha256": "9acdf2689d7ac9442e52847585c5e7a736a4b5f942804cfd73ff2e822e6bab50" } } ], "anchor": "ratelimitdecision" }, { "name": "RateLimiter", "declarationName": "RateLimiter", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class RateLimiter {\n checkAndRecord(skill: string, limit: RateLimit, nowSecs: number): RateLimitDecision;\n reset(skill: string): void;\n snapshot(): Array<[\n string,\n number\n ]>;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/rate.d.ts", "line": 15, "sha256": "9acdf2689d7ac9442e52847585c5e7a736a4b5f942804cfd73ff2e822e6bab50" } } ], "anchor": "ratelimiter" }, { "name": "RateLimitExceededError", "declarationName": "RateLimitExceededError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class RateLimitExceededError extends SkillsPolicyError {\n readonly name = \"RateLimitExceededError\";\n readonly skill: string;\n readonly used: number;\n readonly max: number;\n readonly windowSecs: number;\n constructor(skill: string, used: number, max: number, windowSecs: number);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 25, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "ratelimitexceedederror" }, { "name": "Receipt", "declarationName": "Receipt", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface Receipt {\n sequence: number;\n skill: string;\n agent: string;\n session: string;\n invokedAt: string;\n auditLevel: AuditLevel;\n argumentsHash: string;\n arguments?: unknown;\n previousHash: string;\n receiptHash: string;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/audit.d.ts", "line": 14, "sha256": "aa0f2a6b37f9179e5b890028582c0eb991be3df7e6b0b82acdf871d8fa9ea6e9" } } ], "anchor": "receipt" }, { "name": "SkillEntry", "declarationName": "SkillEntry", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "Parser for `SKILLS.md` files.\n\nA `SKILLS.md` file is a simple Markdown document where each `##`-level\nheading names a skill and the paragraphs beneath describe it. We use a\nline-based scanner — matching the Rust implementation exactly — to keep\nboth parsers auditable.", "tags": [], "signatures": [ { "code": "export interface SkillEntry {\n readonly name: string;\n readonly description: string;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/skillsMd.d.ts", "line": 9, "sha256": "4c134a45ff8c519af26f26d800adaa2fab155c7f182d404a18016a13bd355a65" } } ], "anchor": "skillentry" }, { "name": "SkillRule", "declarationName": "SkillRule", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type SkillRule = z.infer;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 95, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "skillrule" }, { "name": "SkillsManifest", "declarationName": "SkillsManifest", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class SkillsManifest {\n readonly skills: readonly SkillEntry[];\n static fromMarkdown(input: string): SkillsManifest;\n static fromFile(path: string): Promise;\n get length(): number;\n get isEmpty(): boolean;\n get(name: string): SkillEntry | undefined;\n names(): string[];\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/skillsMd.d.ts", "line": 13, "sha256": "4c134a45ff8c519af26f26d800adaa2fab155c7f182d404a18016a13bd355a65" } } ], "anchor": "skillsmanifest" }, { "name": "SkillsPolicy", "declarationName": "SkillsPolicy", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "export declare class SkillsPolicy {\n static fromYaml(yaml: string): SkillsPolicy;\n static fromFile(path: string): Promise;\n agent(): Did;\n hasRule(skill: string): boolean;\n auditChain(): AuditChain;\n resetRateLimit(skill: string): void;\n canInvoke(skill: string, ctx: InvocationContext): void;\n recordInvocation(skill: string, ctx: InvocationContext): Receipt;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/engine.d.ts", "line": 35, "sha256": "c1146fdd0e4e69ff19d0e55d315eae2307adadd025c71d744e050c55bfb702cd" } } ], "anchor": "skillspolicy" }, { "name": "SkillsPolicyDoc", "declarationName": "SkillsPolicyDoc", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type SkillsPolicyDoc = z.infer;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 271, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "skillspolicydoc" }, { "name": "SkillsPolicyError", "declarationName": "SkillsPolicyError", "kind": "ClassDeclaration", "typeOnly": false, "documentation": "Typed error hierarchy for the skills policy engine.\n\nEach failing dimension has its own subclass so callers can pattern-match\nwith `instanceof` rather than parsing error messages.", "tags": [], "signatures": [ { "code": "export declare class SkillsPolicyError extends Error {\n readonly name: string;\n constructor(message: string);\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/errors.d.ts", "line": 7, "sha256": "0674168d21cfe41b70b746a28c0c84a8b2a53f1b27603dc99c80aebdf0bdfda4" } } ], "anchor": "skillspolicyerror" }, { "name": "TimeWindow", "declarationName": "TimeWindow", "kind": "TypeAliasDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export type TimeWindow = z.infer;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 37, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "timewindow" } ], "supportingDeclarations": [ { "name": "AuditLevelSchema", "declarationName": "AuditLevelSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const AuditLevelSchema: z.ZodEnum<[\n \"none\",\n \"hash\",\n \"full\"\n]>;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 11, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "auditlevelschema" }, { "name": "DefaultRuleSchema", "declarationName": "DefaultRuleSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const DefaultRuleSchema: z.ZodObject<{\n allow: z.ZodDefault;\n audit_level: z.ZodDefault>;\n}, \"strict\", z.ZodTypeAny, {\n allow: boolean;\n audit_level: \"none\" | \"hash\" | \"full\";\n}, {\n allow?: boolean | undefined;\n audit_level?: \"none\" | \"hash\" | \"full\" | undefined;\n}>;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 96, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "defaultruleschema" }, { "name": "InvocationContextInit", "declarationName": "InvocationContextInit", "kind": "InterfaceDeclaration", "typeOnly": true, "documentation": "", "tags": [], "signatures": [ { "code": "export interface InvocationContextInit {\n agentDid: Did;\n sessionId: string;\n arguments: unknown;\n invokedAt?: Date;\n consentGranted?: boolean;\n}", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/engine.d.ts", "line": 14, "sha256": "c1146fdd0e4e69ff19d0e55d315eae2307adadd025c71d744e050c55bfb702cd" } } ], "anchor": "invocationcontextinit" }, { "name": "RateLimitSchema", "declarationName": "RateLimitSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const RateLimitSchema: z.ZodObject<{\n window: z.ZodString;\n max: z.ZodNumber;\n}, \"strip\", z.ZodTypeAny, {\n window: string;\n max: number;\n}, {\n window: string;\n max: number;\n}>;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 13, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "ratelimitschema" }, { "name": "SkillRuleSchema", "declarationName": "SkillRuleSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SkillRuleSchema: z.ZodObject<{\n allow: z.ZodDefault;\n rate_limit: z.ZodOptional>;\n arg_constraints: z.ZodOptional;\n time_windows: z.ZodDefault>;\n }, \"strip\", z.ZodTypeAny, {\n start_hour: number;\n end_hour: number;\n weekdays: number[];\n }, {\n start_hour: number;\n end_hour: number;\n weekdays?: number[] | undefined;\n }>, \"many\">>;\n require_consent: z.ZodDefault;\n audit_level: z.ZodDefault>;\n}, \"strict\", z.ZodTypeAny, {\n allow: boolean;\n time_windows: {\n start_hour: number;\n end_hour: number;\n weekdays: number[];\n }[];\n require_consent: boolean;\n audit_level: \"none\" | \"hash\" | \"full\";\n rate_limit?: {\n window: string;\n max: number;\n } | undefined;\n arg_constraints?: unknown;\n}, {\n allow?: boolean | undefined;\n rate_limit?: {\n window: string;\n max: number;\n } | undefined;\n arg_constraints?: unknown;\n time_windows?: {\n start_hour: number;\n end_hour: number;\n weekdays?: number[] | undefined;\n }[] | undefined;\n require_consent?: boolean | undefined;\n audit_level?: \"none\" | \"hash\" | \"full\" | undefined;\n}>;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 38, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "skillruleschema" }, { "name": "SkillsPolicyDocSchema", "declarationName": "SkillsPolicyDocSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const SkillsPolicyDocSchema: z.ZodEffects;\n agent: z.ZodString;\n description: z.ZodOptional;\n skills: z.ZodDefault;\n rate_limit: z.ZodOptional>;\n arg_constraints: z.ZodOptional;\n time_windows: z.ZodDefault>;\n }, \"strip\", z.ZodTypeAny, {\n start_hour: number;\n end_hour: number;\n weekdays: number[];\n }, {\n start_hour: number;\n end_hour: number;\n weekdays?: number[] | undefined;\n }>, \"many\">>;\n require_consent: z.ZodDefault;\n audit_level: z.ZodDefault>;\n }, \"strict\", z.ZodTypeAny, {\n allow: boolean;\n time_windows: {\n start_hour: number;\n end_hour: number;\n weekdays: number[];\n }[];\n require_consent: boolean;\n audit_level: \"none\" | \"hash\" | \"full\";\n rate_limit?: {\n window: string;\n max: number;\n } | undefined;\n arg_constraints?: unknown;\n }, {\n allow?: boolean | undefined;\n rate_limit?: {\n window: string;\n max: number;\n } | undefined;\n arg_constraints?: unknown;\n time_windows?: {\n start_hour: number;\n end_hour: number;\n weekdays?: number[] | undefined;\n }[] | undefined;\n require_consent?: boolean | undefined;\n audit_level?: \"none\" | \"hash\" | \"full\" | undefined;\n }>>>;\n default: z.ZodDefault;\n audit_level: z.ZodDefault>;\n }, \"strict\", z.ZodTypeAny, {\n allow: boolean;\n audit_level: \"none\" | \"hash\" | \"full\";\n }, {\n allow?: boolean | undefined;\n audit_level?: \"none\" | \"hash\" | \"full\" | undefined;\n }>>;\n}, \"strict\", z.ZodTypeAny, {\n version: 1;\n agent: string;\n skills: Record;\n default: {\n allow: boolean;\n audit_level: \"none\" | \"hash\" | \"full\";\n };\n description?: string | undefined;\n}, {\n version: 1;\n agent: string;\n description?: string | undefined;\n skills?: Record | undefined;\n default?: {\n allow?: boolean | undefined;\n audit_level?: \"none\" | \"hash\" | \"full\" | undefined;\n } | undefined;\n}>, {\n version: 1;\n agent: string;\n skills: Record;\n default: {\n allow: boolean;\n audit_level: \"none\" | \"hash\" | \"full\";\n };\n description?: string | undefined;\n}, {\n version: 1;\n agent: string;\n description?: string | undefined;\n skills?: Record | undefined;\n default?: {\n allow?: boolean | undefined;\n audit_level?: \"none\" | \"hash\" | \"full\" | undefined;\n } | undefined;\n}>;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 107, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "skillspolicydocschema" }, { "name": "TimeWindowSchema", "declarationName": "TimeWindowSchema", "kind": "VariableDeclaration", "typeOnly": false, "documentation": "", "tags": [], "signatures": [ { "code": "declare const TimeWindowSchema: z.ZodObject<{\n start_hour: z.ZodNumber;\n end_hour: z.ZodNumber;\n weekdays: z.ZodDefault>;\n}, \"strip\", z.ZodTypeAny, {\n start_hour: number;\n end_hour: number;\n weekdays: number[];\n}, {\n start_hour: number;\n end_hour: number;\n weekdays?: number[] | undefined;\n}>;", "source": { "package": "@openagentid/skills-policy", "version": "0.1.1", "file": "dist/schema.d.ts", "line": 24, "sha256": "38767049b9971f06fef60c3ddf0c9da02edaa272607182eaf7b53d23e8c35c73" } } ], "anchor": "timewindowschema" } ], "coverage": { "discovered": 26, "documented": 26, "missing": [] } } ] }, { "name": "create-openagent", "version": "0.5.2", "status": "current", "notes": [], "tarball": "https://registry.npmjs.org/create-openagent/-/create-openagent-0.5.2.tgz", "integrity": "sha512-gVlCbHZEv7o/jIE7jQ4U7ss/ILD5Zeyx3GtzbeeGGgO9uc0wz2A/A5GnKYB9OCqGA0eg7fmWnR4rwOL8bpcqXA==", "packageJsonSha256": "059029c4fe2cb5905200d352bd33772458bebeca92850ea7a2e5f86712120bcd", "page": "/reference/typescript/create-openagent", "engines": { "node": ">=20" }, "dependencies": { "@clack/prompts": "^0.7.0", "picocolors": "^1.0.0" }, "peerDependencies": {}, "peerDependenciesMeta": {}, "bin": { "create-openagent": "./dist/index.js" }, "entryPoints": [ { "subpath": ".", "importSpecifier": "create-openagent", "page": "/reference/typescript/create-openagent", "kind": "cli", "conditions": null, "paths": [], "exports": [], "supportingDeclarations": [], "coverage": { "discovered": 0, "documented": 0, "missing": [] } } ] } ], "totals": { "packages": 22, "entryPoints": 73, "exports": 1955, "supportingDeclarations": 460 } }