@yarlisai/contracts

Shared TypeScript contracts, interfaces, and cross-platform identifiers (YPID) for the Yarlis AI ecosystem.

Install

npm install @yarlisai/contracts

Quick Start

import { createYPID, parseYPID, isYPID } from "@yarlisai/contracts";
import type { ModelRequest, AgentDefinition, MemoryEntry } from "@yarlisai/contracts";

// Create a cross-platform unique identifier
const userId = createYPID("rtm", "user");
// => "ypid_rtm_user_01HXYZ..."

// Parse a YPID
const { domain, type, ulid } = parseYPID(userId);

// Validate a string as YPID
if (isYPID(someString)) {
  // TypeScript narrows to YPID type
}

Modules

• ypid — Cross-platform unique identifiers (YPID)
• model — Model definitions, requests, responses, token usage
• agent — Agent definitions, runs, steps, workflows
• memory — Memory entries, queries, store interface
• router — Router config, strategies, provider config, metrics
• events — Cross-platform event types and emitter interface

YPID Format

ypid_<domain>_<type>_<ulid>

| Domain Code | Site | |---|---| | yrl | yarlis.com | | yai | yarlis.ai | | mbx | mybotbox.com | | sdo | sdods.com | | rtm | rapidtriage.me | | yio | yarlis.io |

License

MIT