chore: remove references to any in src/keri/core directory

.gitignore

@@ -7,3 +7,4 @@ dist
 # IntelliJ Project Files
 .idea
 coverage/*
+

README.md

@@ -45,6 +45,12 @@ Typescript source files needs to be transpiled before running scripts or integra
     npm run build
     ```
 
+    To build and generate TypeScript types from KERIA OpenAPI docs dynamically
+
+    ```
+    SPEC_URL=http://localhost:3902/spec.yaml npm run build
+    ```
+
 - ready() must be called before library is useable. Example minimum viable client code.
 
     ```javascript

package.json

@@ -31,7 +31,8 @@
   ],
   "scripts": {
     "start": "npm run build -- --watch",
-    "build": "tsc -p tsconfig.build.json && tsc -p tsconfig.json --noEmit",
+    "generate:types": "node scripts/generate-types.js",
+    "build": "npm run generate:types && tsc -p tsconfig.build.json && tsc -p tsconfig.json --noEmit",
     "test": "vitest",
     "prepare": "tsc -p tsconfig.build.json",
     "test:integration": "vitest -c vitest.integration.ts",

scripts/generate-types.js

@@ -0,0 +1,36 @@
+import { execSync } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+
+const specUrl = process.env.SPEC_URL;
+const outputFile = path.resolve('src/types/keria-api-schema.ts');
+
+if (!specUrl) {
+    console.log('⚠️  Skipping OpenAPI type generation: SPEC_URL is not set.');
+    process.exit(0);
+}
+
+console.log(`📦 Generating types from ${specUrl}`);
+execSync(`npx openapi-typescript "${specUrl}" --output ${outputFile} --enum`, {
+    stdio: 'inherit',
+});
+
+// Read the full file
+const fullContent = fs.readFileSync(outputFile, 'utf8');
+
+// Extract the `export interface components { ... }` block
+const componentsMatch = fullContent.match(/export interface components \{[\s\S]+?\n\}/);
+
+// Extract all `export enum ... { ... }` blocks
+const enumMatches = [...fullContent.matchAll(/export enum [\w\d_]+ \{[\s\S]+?\n\}/g)];
+
+if (!componentsMatch) {
+    console.error("❌ Could not find 'export interface components' block.");
+    process.exit(1);
+}
+
+// Combine the interface and enums
+const enumsText = enumMatches.map(m => m[0]).join('\n\n');
+const cleaned = `// AUTO-GENERATED: Only components and enums retained from OpenAPI schema\n\n${enumsText}\n\n${componentsMatch[0]}\n`;
+
+fs.writeFileSync(outputFile, cleaned, 'utf8');

src/keri/app/aiding.ts

@@ -1,13 +1,14 @@
-import { Tier } from '../core/salter.ts';
-import { Algos } from '../core/manager.ts';
-import { incept, interact, reply, rotate } from '../core/eventing.ts';
+import { components } from '../../types/keria-api-schema.ts';
 import { b, Ilks, Serials, Vrsn_1_0 } from '../core/core.ts';
-import { Tholder } from '../core/tholder.ts';
-import { MtrDex } from '../core/matter.ts';
-import { Serder } from '../core/serder.ts';
+import { incept, interact, reply, EndRoleAddAttributes, rotate } from '../core/eventing.ts';
 import { parseRangeHeaders } from '../core/httping.ts';
 import { IdentifierManagerFactory } from '../core/keeping.ts';
 import { HabState } from '../core/keyState.ts';
+import { Algos } from '../core/manager.ts';
+import { MtrDex } from '../core/matter.ts';
+import { Tier } from '../core/salter.ts';
+import { Serder } from '../core/serder.ts';
+import { Tholder } from '../core/tholder.ts';
 
 /** Arguments required to create an identfier */
 export interface CreateIdentiferArgs {
@@ -73,6 +74,8 @@ export interface IdentifierInfo {
     name: string;
 }
 
+export type GroupMember = components['schemas']['GroupMember'];
+
 /** Identifier */
 export class Identifier {
     public client: IdentifierDeps;
@@ -472,7 +475,7 @@ export class Identifier {
         eid?: string,
         stamp?: string
     ): Serder {
-        const data: any = {
+        const data: EndRoleAddAttributes = {
             cid: pre,
             role: role,
         };
@@ -487,9 +490,9 @@ export class Identifier {
      * Get the members of a group identifier
      * @async
      * @param {string} name - Name or alias of the identifier
-     * @returns {Promise<any>} - A promise to the list of members
+     * @returns {Promise<GroupMember>} - A promise to the list of members
      */
-    async members(name: string): Promise<any> {
+    async members(name: string): Promise<GroupMember> {
         const res = await this.client.fetch(
             '/identifiers/' + name + '/members',
             'GET',

src/keri/app/clienting.ts

@@ -1,12 +1,13 @@
+import { components } from '../../types/keria-api-schema.ts';
 import { Authenticater } from '../core/authing.ts';
 import { HEADER_SIG_TIME } from '../core/httping.ts';
 import { ExternalModule, IdentifierManagerFactory } from '../core/keeping.ts';
 import { Tier } from '../core/salter.ts';
 
 import { Identifier } from './aiding.ts';
-import { Contacts, Challenges } from './contacting.ts';
+import { Challenges, Contacts } from './contacting.ts';
 import { Agent, Controller } from './controller.ts';
-import { Oobis, Operations, KeyEvents, KeyStates, Config } from './coring.ts';
+import { Config, KeyEvents, KeyStates, Oobis, Operations } from './coring.ts';
 import { Credentials, Ipex, Registries, Schemas } from './credentialing.ts';
 import { Delegations } from './delegating.ts';
 import { Escrows } from './escrowing.ts';
@@ -16,6 +17,9 @@ import { Notifications } from './notifying.ts';
 
 const DEFAULT_BOOT_URL = 'http://localhost:3903';
 
+// Export type outside the class
+export type AgentResourceResult = components["schemas"]["AgentResourceResult"];
+
 class State {
     agent: any | null;
     controller: any | null;
@@ -117,7 +121,7 @@ export class SignifyClient {
             throw new Error(`agent does not exist for controller ${caid}`);
         }
 
-        const data = await res.json();
+        const data = await res.json() as AgentResourceResult;
         const state = new State();
         state.agent = data.agent ?? {};
         state.controller = data.controller ?? {};
@@ -172,7 +176,7 @@ export class SignifyClient {
     async fetch(
         path: string,
         method: string,
-        data: any,
+        data: unknown | null | undefined,
         extraHeaders?: Headers
     ): Promise<Response> {
         const headers = new Headers();

src/keri/app/contacting.ts

@@ -1,12 +1,9 @@
 import { SignifyClient } from './clienting.ts';
 import { Operation } from './coring.ts';
+import { components } from '../../types/keria-api-schema.ts';
 
-export interface Contact {
-    alias: string;
-    oobi: string;
-    id: string;
-    [key: string]: unknown;
-}
+
+export type Contact = components['schemas']['Contact'];
 
 export interface ContactInfo {
     [key: string]: unknown;
@@ -111,9 +108,7 @@ export class Contacts {
     }
 }
 
-export interface Challenge {
-    words: string[];
-}
+export type Challenge = components['schemas']['Challenge'];
 
 /**
  * Challenges
@@ -189,15 +184,15 @@ export class Challenges {
      * Mark challenge response as signed and accepted
      * @param source Prefix of the identifier that was challenged
      * @param said qb64 AID of exn message representing the signed response
-     * @returns {Promise<Response>} A promise to the result
+     * @returns {Promise<Operation<any>>} A promise to the result
      */
-    async responded(source: string, said: string): Promise<Response> {
+    async responded(source: string, said: string): Promise<Operation<any>> {
         const path = `/challenges_verify/${source}`;
         const method = 'PUT';
         const data = {
             said: said,
         };
         const res = await this.client.fetch(path, method, data);
-        return res;
+        return await res.json() as Operation<any>;
     }
 }

src/keri/app/controller.ts

@@ -1,17 +1,18 @@
+import { Cipher } from '../core/cipher.ts';
+import { b, Ilks, Serials, Vrsn_1_0 } from '../core/core.ts';
+import { Decrypter } from '../core/decrypter.ts';
+import { Diger } from '../core/diger.ts';
+import { Encrypter } from '../core/encrypter.ts';
+import { incept, InceptEventSAD, interact, InteractEventSAD, rotate } from '../core/eventing.ts';
 import { SaltyCreator } from '../core/manager.ts';
-import { Salter, Tier } from '../core/salter.ts';
 import { MtrDex } from '../core/matter.ts';
-import { Diger } from '../core/diger.ts';
-import { incept, rotate, interact } from '../core/eventing.ts';
+import { CesrNumber } from '../core/number.ts';
+import { Salter, Tier } from '../core/salter.ts';
+import { Seqner } from '../core/seqner.ts';
 import { Serder } from '../core/serder.ts';
+import { Signer } from '../core/signer.ts';
 import { Tholder } from '../core/tholder.ts';
-import { Ilks, b, Serials, Vrsn_1_0 } from '../core/core.ts';
 import { Verfer } from '../core/verfer.ts';
-import { Encrypter } from '../core/encrypter.ts';
-import { Decrypter } from '../core/decrypter.ts';
-import { Cipher } from '../core/cipher.ts';
-import { Seqner } from '../core/seqner.ts';
-import { CesrNumber } from '../core/number.ts';
 
 /**
  * Agent is a custodial entity that can be used in conjuntion with a local Client to establish the
@@ -128,7 +129,7 @@ export class Controller {
     /**
      * Either the current establishment event, inception or rotation, or the interaction event used for delegation approval.
      */
-    public serder: Serder;
+    public serder: Serder<InteractEventSAD | InceptEventSAD>;
     /**
      * Current public keys formatted in fully-qualified Base64.
      * @private
@@ -227,11 +228,12 @@ export class Controller {
 
     approveDelegation(_agent: Agent) {
         const seqner = new Seqner({ sn: _agent.sn });
-        const anchor = { i: _agent.pre, s: seqner.snh, d: _agent.said };
-        const sn = new CesrNumber({}, undefined, this.serder.sad['s']).num + 1;
+        const anchor = { i: _agent.pre, s: seqner.snh, d: _agent.said! };
+        const sn =
+            new CesrNumber({}, undefined, String(this.serder.sad['s'])).num + 1;
         this.serder = interact({
             pre: this.serder.pre,
-            dig: this.serder.sad['d'],
+            dig: this.serder.sad['d']!,
             sn: sn,
             data: [anchor],
             version: Vrsn_1_0,
@@ -265,7 +267,10 @@ export class Controller {
                 wits: [],
             });
         } else {
-            return new Serder({ sad: state.controller['ee'] });
+            return new Serder({
+                sad: state.controller['ee'],
+                d: '',
+            });
         }
     }
 
@@ -386,7 +391,7 @@ export class Controller {
                 const signers = [];
                 for (const prx of prxs) {
                     const cipher = new Cipher({ qb64: prx });
-                    const dsigner = decrypter.decrypt(null, cipher, true);
+                    const dsigner = decrypter.decrypt(null, cipher, true) as Signer;
                     signers.push(dsigner);
                     nprxs.push(encrypter.encrypt(b(dsigner.qb64)).qb64);
                 }

src/keri/app/coring.ts

@@ -2,6 +2,13 @@ import { SignifyClient } from './clienting.ts';
 import libsodium from 'libsodium-wrappers-sumo';
 import { Salter } from '../core/salter.ts';
 import { Matter, MtrDex } from '../core/matter.ts';
+import { components } from '../../types/keria-api-schema.ts';
+
+type OperationBase = components['schemas']['OperationBase'];
+type OOBI = components['schemas']['OOBI'];
+type KeyState = components['schemas']['KeyStateRecord'];
+type KeyEventRecord = components['schemas']['KeyEventRecord'];
+type AgentConfig = components['schemas']['AgentConfig'];
 
 export function randomPasscode(): string {
     const raw = libsodium.randombytes_buf(16);
@@ -33,7 +40,7 @@ export class Oobis {
      * @param {string} role Authorized role
      * @returns {Promise<any>} A promise to the OOBI(s)
      */
-    async get(name: string, role: string = 'agent'): Promise<any> {
+    async get(name: string, role: string = 'agent'): Promise<OOBI> {
         const path = `/identifiers/${name}/oobis?role=${role}`;
         const method = 'GET';
         const res = await this.client.fetch(path, method, null);
@@ -45,9 +52,9 @@ export class Oobis {
      * @async
      * @param {string} oobi The OOBI to be resolver
      * @param {string} [alias] Optional name or alias to link the OOBI resolution to a contact
-     * @returns {Promise<any>} A promise to the long-running operation
+     * @returns {Promise<Operation<any>>} A promise to the long-running operation
      */
-    async resolve(oobi: string, alias?: string): Promise<any> {
+    async resolve(oobi: string, alias?: string): Promise<Operation<any>> {
         const path = `/oobis`;
         const data: any = {
             url: oobi,
@@ -61,16 +68,13 @@ export class Oobis {
     }
 }
 
-export interface Operation<T = unknown> {
-    name: string;
+export type Operation<T = unknown> = OperationBase & {
+    response?: T;
     metadata?: {
         depends?: Operation;
         [property: string]: any;
     };
-    done?: boolean;
-    error?: any;
-    response?: T;
-}
+};
 
 export interface OperationsDeps {
     fetch(
@@ -81,10 +85,6 @@ export interface OperationsDeps {
     ): Promise<Response>;
 }
 
-export interface AgentConfig {
-    iurls?: string[];
-}
-
 /**
  * Operations
  * @remarks
@@ -204,9 +204,9 @@ export class KeyEvents {
      * Retrieve key events for an identifier
      * @async
      * @param {string} pre Identifier prefix
-     * @returns {Promise<any>} A promise to the key events
+     * @returns {Promise<KeyEventRecord[]>} A promise to the key events
      */
-    async get(pre: string): Promise<any> {
+    async get(pre: string): Promise<KeyEventRecord[]> {
         const path = `/events?pre=${pre}`;
         const data = null;
         const method = 'GET';
@@ -232,9 +232,9 @@ export class KeyStates {
      * Retriene the key state for an identifier
      * @async
      * @param {string} pre Identifier prefix
-     * @returns {Promise<any>} A promise to the key states
+     * @returns {Promise<KeyState[]>} A promise to the key states
      */
-    async get(pre: string): Promise<any> {
+    async get(pre: string): Promise<KeyState[]> {
         const path = `/states?pre=${pre}`;
         const data = null;
         const method = 'GET';
@@ -248,7 +248,7 @@ export class KeyStates {
      * @param {Array<string>} pres List of identifier prefixes
      * @returns {Promise<any>} A promise to the key states
      */
-    async list(pres: string[]): Promise<any> {
+    async list(pres: string[]): Promise<KeyState[]> {
         const path = `/states?${pres.map((pre) => `pre=${pre}`).join('&')}`;
         const data = null;
         const method = 'GET';
@@ -262,9 +262,9 @@ export class KeyStates {
      * @param {string} pre Identifier prefix
      * @param {number} [sn] Optional sequence number
      * @param {any} [anchor] Optional anchor
-     * @returns {Promise<any>} A promise to the long-running operation
+     * @returns {Promise<Operation<any>>} A promise to the long-running operation
      */
-    async query(pre: string, sn?: string, anchor?: any): Promise<any> {
+    async query(pre: string, sn?: string, anchor?: any): Promise<Operation<any>> {
         const path = `/queries`;
         const data: any = {
             pre: pre,