@byokit/accounts weekly downloads statistics

<h1 align="center">@byokit/accounts</h1> <p align="center"> <a href="https://www.npmjs.com/package/@byokit/accounts"><img alt="npm" src="https://img.shields.io/npm/v/@byokit/accounts?style=flat&label=npm" /></a> <a href="https://github.com/umeranjum17/byokit/actions/workflows/ci.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/umeranjum17/byokit/ci.yml?style=flat&branch=main" /></a> <a href="LICENSE"><img alt="Apache 2.0" src="https://img.shields.io/badge/license-Apache--2.0-666?style=flat" /></a> <img alt="Node | Electron | browsers | React Native" src="https://img.shields.io/badge/platform-Node%20%7C%20Electron%20%7C%20browsers%20%7C%20React%20Native-666?style=flat" /> </p> <p align="center"><strong>Sign in with the AI plan you already pay for, inside your own app.</strong><br/> Plans work on every platform; computer-only plans work on computers, and some plans need Web Crypto. API keys are billed per use and require explicit app opt-in ([which sign-in works where](#which-sign-in-works-where)). Sign-ins go into your app's own store: on a computer (Node, Electron), in a browser (a PWA, Electron's renderer) and on a phone (React Native and Expo, iOS and Android). One import; your bundler picks the platform's side (`package.json`'s `react-native` and `browser` conditions).</p> <p align="center"> <img src="https://raw.githubusercontent.com/umeranjum17/byokit/main/docs/images/pwa-1-signed-out.png" width="240" alt="The page &quot;Umer's AI plans&quot;, signed out: the ChatGPT card with a Plan chip, &quot;ChatGPT isn't signed in yet.&quot; and a Sign in with ChatGPT button" /> <img src="https://raw.githubusercontent.com/umeranjum17/byokit/main/docs/images/pwa-2-code.png" width="240" alt="The same page signing in: &quot;Signing in to ChatGPT…&quot;, &quot;On the ChatGPT page, type this code:&quot; MOCK-10001 with a Copy button, &quot;Code expires in 14:59&quot;, and Open ChatGPT and Cancel buttons" /> <img src="https://raw.githubusercontent.com/umeranjum17/byokit/main/docs/images/pwa-3-connected.png" width="240" alt="The same page signed in: &quot;ChatGPT is connected.&quot;, umer@example.com, a ChatGPT Plus chip, an Auto (most room) selector, an Ask ChatGPT something box and Sign out / Add another ChatGPT" /> </p> <p align="center">_{<a href="../../examples/pwa"><code>examples/pwa</code></a> signing in by device code in headless Chromium (Playwright), against the kit's stand-in OpenAI (<code>mockOpenAI()</code>), not the real one; the pictured code is the stand-in's own <code>MOCK-…</code> shape.}</p>

Install

npm install @byokit/accounts

· Latest release · All releases

Quickstart

npm install @byokit/accounts

The whole ChatGPT flow, run against the stand-in OpenAI so it needs no account and no network beyond loopback: sign in by device code, see the status, ask.

import { Accounts, memoryStore, portable } from '@byokit/accounts';
import { mockOpenAI } from '@byokit/accounts/testing';

const openai = await mockOpenAI(); // a stand-in OpenAI on 127.0.0.1, no account needed
const accounts = new Accounts(
  { authBase: openai.base, apiBase: openai.base, store: () => memoryStore() }, // in memory: this demo ends with it
  portable, // device code with fetch alone, as on a phone or in a browser
);

const shown = await accounts.login(1, 'chatgpt');
console.log(shown?.state, shown?.via, shown?.code);
openai.approve(shown!.code!); // the person types the code on the provider's page

await accounts.finished(1, 'chatgpt'); // the whole sign-in, once the code is approved
console.log((await accounts.status(1, 'chatgpt')).words);

const answer = await accounts.respond(1, { model: 'gpt-6-sol', instructions: 'Answer briefly.', input: 'Plan my day', onText: (d) => process.stdout.write(d) });
console.log('\nfinal:', answer);
await openai.close();

waiting code MOCK-10001
ChatGPT is connected.
You said: Plan my day
final: You said: Plan my day

The stand-in echoes the question. In an app, drop authBase, apiBase and portable, and give each person a store, as below.

On a computer

On a computer it uses Pi's @earendil-works/pi-ai sign-in flows, pinned exactly:

import { isolate, launchEnv } from '@byokit/accounts/isolate';
const dir = isolate('/path/to/app/engine'); // creates the folder; never changes process.env
const launch = launchEnv({ set: { PI_CODING_AGENT_DIR: dir, PI_OFFLINE: '1',
  PI_TELEMETRY: '0', PI_SKIP_VERSION_CHECK: '1' } });
// Pass launch.env to spawn(), or launch to Herdr's startAgent({ env: launch, ... }).

// Every BYOKit app on this computer keeps sign-ins at one machine store under one seal, so the person signs in once.
export async function connect() {
  const { Accounts, machineStore } = await import('@byokit/accounts');
  const { osKeyringSeal } = await import('@byokit/secrets');
  const seal = osKeyringSeal({ service: 'byokit' });
  const accounts = new Accounts({ store: (member) => machineStore(member, seal) });
  const shown = await accounts.login(1, 'chatgpt', { via: 'code' }); // { state: 'waiting', code, url }
  // show shown.code and shown.url; the sign-in finishes by itself
  return { shown, status: await accounts.status(1, 'chatgpt') };
}

On a phone or in a browser…