@happyvertical/smrt-profiles

pnpm add @happyvertical/smrt-profiles

npm install @happyvertical/smrt-profiles

import {
  ProfileCollection,
  ProfileTypeCollection
} from '@happyvertical/smrt-profiles';

const typeCollection = await ProfileTypeCollection.create({ db });
const humanType = await typeCollection.create({ name: 'Human' });
await humanType.save();

const profileCollection = await ProfileCollection.create({ db });
const person = await profileCollection.create({
  typeId: humanType.id,
  name: 'Alice Johnson',
  email: 'alice@example.com', // globally unique
  description: 'Software engineer'
});
await person.save();

// Uses the smrtProfiles.profile.generateBio prompt via @happyvertical/smrt-prompts.
// Tenants can override the template/model/params at runtime.
const bio = await person.generateBio();
console.log(bio);

// Check whether a profile matches a description (delegates to is())
const isEngineer = await person.matches('a senior software engineer with TypeScript expertise');

// profile_assets is the canonical join for profile-owned assets.
// AssetAssociation is reserved for generic / provenance links only.
// addAsset(asset, relationship?, sortOrder?) -- takes an Asset instance.
await person.addAsset(headshotAsset, 'avatar', 0);

const assets = await person.getAssets('avatar'); // relationship filter (string)
await person.removeAsset(headshotAsset.id);

// Reads via the collection (per profile id)
const ownedAssets = await profileCollection.getAssets(person.id, 'avatar');

import { ProfileMetafieldCollection } from '@happyvertical/smrt-profiles';

const fieldCollection = await ProfileMetafieldCollection.create({ db });
const phone = await fieldCollection.create({
  name: 'Phone Number',
  validation: { type: 'string', pattern: '^\\+?[0-9]{10,15}$' }
});
await phone.save();

await person.addMetadata('phone-number', '+14155551234');
const metadata = await person.getMetadata();
// { 'phone-number': '+14155551234' }

// Bulk reads/writes
await profileCollection.batchGetMetadata([person.id, bob.id]);
await profileCollection.batchUpdateMetadata([{ profileId: person.id, data: { location: 'SF' } }]);

import { ProfileRelationshipTypeCollection } from '@happyvertical/smrt-profiles';

const relTypeCollection = await ProfileRelationshipTypeCollection.create({ db });
const friendType = await relTypeCollection.create({
  name: 'Friend',
  reciprocal: true // auto-creates inverse
});
await friendType.save();

await person.addRelationship(bob, 'friend');
const friends = await person.getRelationships({ direction: 'all' });

import { smrtProfilesGenerateBioPrompt } from '@happyvertical/smrt-profiles';

// key: 'smrtProfiles.profile.generateBio'
// Variables passed to the prompt (PII-conscious surface):
//   name, description, profileType, relationshipsSummary (counts only)
//
// Intentionally excluded: email, tenantId, ownerId, raw metadata blobs.

import { resolveIdentity } from '@happyvertical/smrt-profiles';

// Top-level dispatcher: returns/creates a Profile from
// Nostr signatures, OIDC claims, magic link tokens, or API keys.
const result = await resolveIdentity({
  oidcSession: event.locals.session,
  apiKey: event.request.headers.get('X-API-Key'),
  db: event.locals.db
});
// Returns ResolveIdentityResult: { profile: Profile | null, source, ... }
// source: 'api_key' | 'oidc' | 'nostr' | 'actor' | 'none'

import {
  createProfileFromOidc,
  createProfileFromNostr,
  ApiKey,
} from '@happyvertical/smrt-profiles';

// First-time OIDC sign-in -- (claims, provider, options)
const { profile, oidcIdentity, created } = await createProfileFromOidc(claims, provider, { db });

// Nostr-authenticated user -- (email, nostrData, options)
const { profile, nostrIdentity } = await createProfileFromNostr(email, nostrData, { db });

// Issue an API key -- plaintext returned ONCE
// generate(profile, { name, scopes?, expiresAt?, db? })
const { key, apiKey } = await ApiKey.generate(profile, {
  name: 'CI deploy key',
  scopes: ['read:profiles'],
  expiresAt: new Date('2026-12-31'),
});
console.log(key);             // store now, never returned again
console.log(apiKey.keyPrefix); // visible identifier later

await profile.recordAction({
  action: 'patient_viewed',
  resourceType: 'Patient',
  resourceId: 'patient-123',
  source: 'web',           // web | cli | ci | webhook | mcp
  onBehalfOfId: actorProfileId, // CI bots run as a service account, log the human too
  metadata: { reason: 'Follow-up appointment' },
});