Quickstart and API

npm install          # TypeScript and Node types, for `npm run typecheck` only
npm run demo         # full story, you approve in the terminal
npm run demo -- --yes
npm start            # gateway on http://127.0.0.1:8080 plus the mock network, until Ctrl+C
npm test             # 126 tests
npm run lint
npm run check        # typecheck + lint + tests (what CI runs)
npm run serve        # production entry (src/main.ts), configured by environment variables
docker compose up --build

import { PersonalAgent } from './agent/personal-agent.ts';

const agent = await new PersonalAgent({ name: 'My agent' }).start(); // serves agent.json + jwks.json
const company = await agent.discover('http://127.0.0.1:8080');
const sid = agent.newSession();

const search = await agent.call(company, sid, 'GET', '/api/v1/search?q=' + encodeURIComponent('2 kilo atta aur 1 litre doodh'));
const b = search.body.suggested_basket;

const order = await agent.callWithApproval(company, sid, 'POST', '/api/v1/orders', {
  bpp_id: b.bpp_id,
  provider_id: b.provider_id,
  items: b.items.map((i) => ({ id: i.id, count: i.count })),
  delivery: { name: 'Asha', phone: '9876543210', address: { city: 'Varanasi', state: 'Uttar Pradesh', area_code: '221005' } },
}, async (op) => {
  console.log(op.summary);          // show this to the person
  return true;                      // only if they said yes
});

import { personSignsIn } from './agent/personal-agent.ts';

// In real use the person opens this URL in their browser. personSignsIn plays that part locally.
await agent.signIn(company, ['orders:read', 'orders:write', 'addresses'], (url) =>
  personSignsIn(url, { phone: '9876543210', otp: '123456' }), // the development code; never in production
);
await agent.call(company, sid, 'GET', '/api/v1/orders', { signedIn: true });
await agent.signOut(company);