Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

@sms/baseline

Interfaces

Baseline

Defined in: packages/baseline/src/create-baseline.ts:70

Properties

handle
handle: RequestHandler;

Defined in: packages/baseline/src/create-baseline.ts:75

http.handle bound — hand it to a Host driver.

http
http: HttpService;

Defined in: packages/baseline/src/create-baseline.ts:73

kernel
kernel: Kernel;

Defined in: packages/baseline/src/create-baseline.ts:71

store
store: Store;

Defined in: packages/baseline/src/create-baseline.ts:72

Methods

close()
close(): Promise<void>;

Defined in: packages/baseline/src/create-baseline.ts:78

Returns

Promise<void>

tick()
tick(now?): Promise<TickResult>;

Defined in: packages/baseline/src/create-baseline.ts:77

Run due scheduled jobs (@sms/plugin-scheduler). The host decides the cadence: cron trigger, interval…

Parameters
ParameterType
now?number
Returns

Promise<TickResult>


BaselineOptions

Defined in: packages/baseline/src/create-baseline.ts:23

Properties

admin?
optional admin?: Omit<AdminApiOptions, "token">;

Defined in: packages/baseline/src/create-baseline.ts:66

Admin API options beyond the token (prefix).

adminToken?
optional adminToken?: string;

Defined in: packages/baseline/src/create-baseline.ts:64

Bearer token for mutating admin routes. Omit to leave them open (local dev only).

auth?
optional auth?: false | AuthOptions;

Defined in: packages/baseline/src/create-baseline.ts:37

Users, sessions and permissions (@sms/plugin-auth + @sms/plugin-rbac, wired into the ORM’s guard). Default: installed, no users until bootstrapAdmin or identity-admin.create. false = no auth and no rbac: every ORM request runs as sudo — local development only.

autoApprove?
optional autoApprove?: boolean;

Defined in: packages/baseline/src/create-baseline.ts:62

Skip human approval entirely (tests / unattended). Shorthand for judge.autoApprove.

executor
executor: Executor;

Defined in: packages/baseline/src/create-baseline.ts:29

Runs agent-written code. @sms/executor-node (worker threads) or @sms/executor-quickjs (WASM interpreter).

identity?
optional identity?: string;

Defined in: packages/baseline/src/create-baseline.ts:48

First line of the agent’s system prompt.

judge?
optional judge?: Omit<JudgeOptions, "executor">;

Defined in: packages/baseline/src/create-baseline.ts:60

Judge policy. Default: scope net and the route / schedule points need a human (an agent plugin that answers HTTP or runs unattended is not metadata); nothing auto-approved. Pass your own sensitivePoints to replace the default list.

logger?
optional logger?: (...args) => void;

Defined in: packages/baseline/src/create-baseline.ts:67

Parameters
ParameterType
argsunknown[]
Returns

void

meta?
optional meta?: boolean;

Defined in: packages/baseline/src/create-baseline.ts:44

@sms/plugin-meta: headless views / actions / menus (view, action, menu points). Off by default.

model
model: ModelService;

Defined in: packages/baseline/src/create-baseline.ts:31

The language model behind agent.chat().

name?
optional name?: string;

Defined in: packages/baseline/src/create-baseline.ts:25

Kernel name (shows up in logs and /api/state).

plugins?
optional plugins?: SystemPlugin[];

Defined in: packages/baseline/src/create-baseline.ts:46

Your application’s own system-trust plugins (collections, routes, tools, prompts, gates, invariants…).

rpc?
optional rpc?: 
  | boolean
| Omit<RpcOptions, "contextOf">;

Defined in: packages/baseline/src/create-baseline.ts:42

@sms/plugin-rpc: batched JSON-RPC over the ORM at /api/rpc (+ /api/rpc/meta), sharing the ORM’s caller resolution. Off by default; true or options (prefix).

sessionStore?
optional sessionStore?: (kernel) => AgentSessionStore;

Defined in: packages/baseline/src/create-baseline.ts:54

Rehydrates chat sessions the agent loop does not hold in memory (fresh process, evicted Durable Object). A factory because the loop installs before your plugins: load() runs at chat time, after settle(), so it may read any key from the kernel it is given.

Parameters
ParameterType
kernelKernel
Returns

AgentSessionStore

store
store: Store;

Defined in: packages/baseline/src/create-baseline.ts:27

Persistence driver. The baseline owns it and closes it on close().


TenantPool

Defined in: packages/baseline/src/tenant-pool.ts:17

Properties

handle
handle: RequestHandler;

Defined in: packages/baseline/src/tenant-pool.ts:18

Methods

close()
close(): Promise<void>;

Defined in: packages/baseline/src/tenant-pool.ts:26

Returns

Promise<void>

evict()
evict(tenantId): Promise<void>;

Defined in: packages/baseline/src/tenant-pool.ts:25

Close one tenant’s kernel (it will boot again on the next request).

Parameters
ParameterType
tenantIdstring
Returns

Promise<void>

get()
get(tenantId): Promise<Baseline>;

Defined in: packages/baseline/src/tenant-pool.ts:20

Get (or boot) a tenant’s kernel.

Parameters
ParameterType
tenantIdstring
Returns

Promise<Baseline>

tenants()
tenants(): string[];

Defined in: packages/baseline/src/tenant-pool.ts:21

Returns

string[]

tick()
tick(now?): Promise<Record<string, TickResult>>;

Defined in: packages/baseline/src/tenant-pool.ts:23

Run due scheduled jobs on every booted tenant (idle tenants are not woken).

Parameters
ParameterType
now?number
Returns

Promise<Record<string, TickResult>>


TenantPoolOptions

Defined in: packages/baseline/src/tenant-pool.ts:6

Properties

idleMs?
optional idleMs?: number;

Defined in: packages/baseline/src/tenant-pool.ts:14

Close kernels idle for this long (ms). Default: never.

onMissing?
optional onMissing?: (request) => Response | Promise<Response>;

Defined in: packages/baseline/src/tenant-pool.ts:12

Response for requests with no tenant. Default: 400.

Parameters
ParameterType
requestRequest
Returns

Response | Promise<Response>

resolve
resolve: TenantResolver;

Defined in: packages/baseline/src/tenant-pool.ts:8

Which tenant a request belongs to.

tenant
tenant: (tenantId) => 
  | BaselineOptions
| Promise<BaselineOptions>;

Defined in: packages/baseline/src/tenant-pool.ts:10

Build the options for a tenant’s kernel: its own store (file / schema / DO), plugins, model…

Parameters
ParameterType
tenantIdstring
Returns

| BaselineOptions | Promise<BaselineOptions>

Variables

DEFAULT_SENSITIVE_POINTS

const DEFAULT_SENSITIVE_POINTS: string[];

Defined in: packages/baseline/src/create-baseline.ts:21

Extension points whose agent contributions need a human by default.

Functions

createBaseline()

function createBaseline(opts): Promise<Baseline>;

Defined in: packages/baseline/src/create-baseline.ts:114

Compose one kernel: database key → http → collections → scheduler → auth → rbac → orm → [meta, rpc] → judge → model → agent loop → admin api → your plugins, then settle and restore agent plugins from the log. Throws if any system plugin is not active.

Parameters

ParameterType
optsBaselineOptions

Returns

Promise<Baseline>


createTenantPool()

function createTenantPool(opts): TenantPool;

Defined in: packages/baseline/src/tenant-pool.ts:33

Kernel-per-tenant. The kernel itself is single-tenant by design (one log, one plugin set, one database); tenancy is a host concern. On Cloudflare a Durable Object plays this role instead.

Parameters

ParameterType
optsTenantPoolOptions

Returns

TenantPool

References

Access

Re-exports Access


ACCESS_POINT

Re-exports ACCESS_POINT


ACTION_POINT

Re-exports ACTION_POINT


ActionSpec

Re-exports ActionSpec


Activate

Re-exports Activate


ADMIN_AUTHORIZER_POINT

Re-exports ADMIN_AUTHORIZER_POINT


ADMIN_ROUTES

Re-exports ADMIN_ROUTES


AdminApiOptions

Re-exports AdminApiOptions


AdminAuthorizer

Re-exports AdminAuthorizer


AGENT_KEY

Re-exports AGENT_KEY


AgentEvent

Re-exports AgentEvent


AgentLoopOptions

Re-exports AgentLoopOptions


AgentService

Re-exports AgentService


AgentSessionStore

Re-exports AgentSessionStore


AppliedEffect

Re-exports AppliedEffect


applyOps

Re-exports applyOps


assertObjectKey

Re-exports assertObjectKey


assertTenantId

Re-exports assertTenantId


assertTrust

Re-exports assertTrust


AsyncQueue

Re-exports AsyncQueue


AuthOptions

Re-exports AuthOptions


BlobStore

Re-exports BlobStore


bodyOf

Re-exports bodyOf


bodyToBytes

Re-exports bodyToBytes


buildMenuTree

Re-exports buildMenuTree


CallRequest

Re-exports CallRequest


Cap

Re-exports Cap


catalog

Re-exports catalog


Channel

Re-exports Channel


ChatResult

Re-exports ChatResult


ChatStep

Re-exports ChatStep


cloneNode

Re-exports cloneNode


COLLECTION_FIELD_POINT

Re-exports COLLECTION_FIELD_POINT


COLLECTION_HOOK_POINT

Re-exports COLLECTION_HOOK_POINT


COLLECTION_POINT

Re-exports COLLECTION_POINT


CollectionFieldContribution

Re-exports CollectionFieldContribution


CollectionHook

Re-exports CollectionHook


COLLECTIONS_KEY

Re-exports COLLECTIONS_KEY


CollectionSchema

Re-exports CollectionSchema


collectionsPlugin

Re-exports collectionsPlugin


CollectionsService

Re-exports CollectionsService


Command

Re-exports Command


CompiledView

Re-exports CompiledView


compileFromBase

Re-exports compileFromBase


ComputedField

Re-exports ComputedField


ComputedReturns

Re-exports ComputedReturns


Contribution

Re-exports Contribution


conversationKey

Re-exports conversationKey


cookieValue

Re-exports cookieValue


createAdminApiPlugin

Re-exports createAdminApiPlugin


createAgentLoopPlugin

Re-exports createAgentLoopPlugin


createAuthPlugin

Re-exports createAuthPlugin


createChannel

Re-exports createChannel


createJudgePlugin

Re-exports createJudgePlugin


createMemoryObjectStore

Re-exports createMemoryObjectStore


createMetaService

Re-exports createMetaService


createModelPlugin

Re-exports createModelPlugin


createOrmPlugin

Re-exports createOrmPlugin


createPluginRuntime

Re-exports createPluginRuntime


createReasoningCache

Re-exports createReasoningCache


createRpcPlugin

Re-exports createRpcPlugin


createScriptedModel

Re-exports createScriptedModel


createSessionModel

Re-exports createSessionModel


createSqlStore

Re-exports createSqlStore


Database

Re-exports Database


DATABASE_KEY

Re-exports DATABASE_KEY


deferred

Re-exports deferred


Deferred

Re-exports Deferred


Dialect

Re-exports Dialect


Domain

Re-exports Domain


DomainLeaf

Re-exports DomainLeaf


DomainOp

Re-exports DomainOp


DSL_PROMPT

Re-exports DSL_PROMPT


EffectKind

Re-exports EffectKind


ErrorBody

Re-exports ErrorBody


errorJson

Re-exports errorJson


EventLog

Re-exports EventLog


eventsOf

Re-exports eventsOf


Executor

Re-exports Executor


ExecutorInstance

Re-exports ExecutorInstance


expandGroups

Re-exports expandGroups


ExtensionPointMeta

Re-exports ExtensionPointMeta


FiberState

Re-exports FiberState


FiberView

Re-exports FiberView


Field

Re-exports Field


FieldBase

Re-exports FieldBase


FieldKind

Re-exports FieldKind


FieldSpec

Re-exports FieldSpec


FieldType

Re-exports FieldType


findNode

Re-exports findNode


firstToolUseId

Re-exports firstToolUseId


FN_MARKER

Re-exports FN_MARKER


foldTarget

Re-exports foldTarget


Gate

Re-exports Gate


GATE_POINT

Re-exports GATE_POINT


GateContext

Re-exports GateContext


GateResult

Re-exports GateResult


Group

Re-exports Group


GROUP_POINT

Re-exports GROUP_POINT


GroupRow

Re-exports GroupRow


groupsOf

Re-exports groupsOf


hashPassword

Re-exports hashPassword


HOOK_POINT

Re-exports HOOK_POINT


HookEvent

Re-exports HookEvent


HookPayload

Re-exports HookPayload


Host

Re-exports Host


HostBridge

Re-exports HostBridge


HostServer

Re-exports HostServer


html

Re-exports html


HTTP_KEY

Re-exports HTTP_KEY


HttpError

Re-exports HttpError


httpErrorOf

Re-exports httpErrorOf


httpPlugin

Re-exports httpPlugin


HttpService

Re-exports HttpService


IDENTITY_ADMIN_KEY

Re-exports IDENTITY_ADMIN_KEY


IDENTITY_KEY

Re-exports IDENTITY_KEY


IdentityAdminService

Re-exports IdentityAdminService


IdentityService

Re-exports IdentityService


Invariant

Re-exports Invariant


INVARIANT_POINT

Re-exports INVARIANT_POINT


json

Re-exports json


JUDGE_KEY

Re-exports JUDGE_KEY


JudgeOptions

Re-exports JudgeOptions


JudgeService

Re-exports JudgeService


Kernel

Re-exports Kernel


KernelApi

Re-exports KernelApi


KernelError

Re-exports KernelError


KernelErrorCode

Re-exports KernelErrorCode


KernelEvent

Re-exports KernelEvent


KernelOptions

Re-exports KernelOptions


KeyMeta

Re-exports KeyMeta


KeyObserver

Re-exports KeyObserver


KINDS

Re-exports KINDS


listKeys

Re-exports listKeys


ListObjectsOptions

Re-exports ListObjectsOptions


lowerKeys

Re-exports lowerKeys


Many2manyField

Re-exports Many2manyField


Many2oneField

Re-exports Many2oneField


matchPath

Re-exports matchPath


MemoryBlobStore

Re-exports MemoryBlobStore


MemoryEventLog

Re-exports MemoryEventLog


Re-exports MENU_POINT


Re-exports MenuNode


Re-exports MenuSpec


META_KEY

Re-exports META_KEY


metaPlugin

Re-exports metaPlugin


MetaService

Re-exports MetaService


METHOD_POINT

Re-exports METHOD_POINT


MethodEnv

Re-exports MethodEnv


MODEL_FIELD_POINT

Re-exports MODEL_FIELD_POINT


MODEL_KEY

Re-exports MODEL_KEY


MODEL_POINT

Re-exports MODEL_POINT


ModelContent

Re-exports ModelContent


ModelEvent

Re-exports ModelEvent


ModelFieldContribution

Re-exports ModelFieldContribution


ModelHook

Re-exports ModelHook


ModelMessage

Re-exports ModelMessage


ModelMethod

Re-exports ModelMethod


ModelOnchange

Re-exports ModelOnchange


ModelRequest

Re-exports ModelRequest


ModelResponse

Re-exports ModelResponse


ModelService

Re-exports ModelService


ModelSpec

Re-exports ModelSpec


ModelTool

Re-exports ModelTool


MountAuthorization

Re-exports MountAuthorization


ObjectBody

Re-exports ObjectBody


objectContent

Re-exports objectContent


ObjectContent

Re-exports ObjectContent


ObjectList

Re-exports ObjectList


ObjectMeta

Re-exports ObjectMeta


OBJECTS_KEY

Re-exports OBJECTS_KEY


ObjectStore

Re-exports ObjectStore


ONCHANGE_POINT

Re-exports ONCHANGE_POINT


One2manyField

Re-exports One2manyField


Op

Re-exports Op


OpContext

Re-exports OpContext


OPS

Re-exports OPS


orDomains

Re-exports orDomains


ORM_KEY

Re-exports ORM_KEY


OrmError

Re-exports OrmError


OrmErrorKind

Re-exports OrmErrorKind


OrmEvent

Re-exports OrmEvent


OrmEventPayload

Re-exports OrmEventPayload


OrmGuard

Re-exports OrmGuard


OrmListener

Re-exports OrmListener


OrmOptions

Re-exports OrmOptions


ormPlugin

Re-exports ormPlugin


OrmService

Re-exports OrmService


parseCall

Re-exports parseCall


parseSelector

Re-exports parseSelector


parseToolArgs

Re-exports parseToolArgs


PendingApproval

Re-exports PendingApproval


pickBase

Re-exports pickBase


PluginBundle

Re-exports PluginBundle


PluginContext

Re-exports PluginContext


PluginManifest

Re-exports PluginManifest


PluginModule

Re-exports PluginModule


PluginRuntime

Re-exports PluginRuntime


PointObserver

Re-exports PointObserver


PROMPT_POINT

Re-exports PROMPT_POINT


PromptSection

Re-exports PromptSection


PutObjectOptions

Re-exports PutObjectOptions


Query

Re-exports Query


RBAC_ADMIN_KEY

Re-exports RBAC_ADMIN_KEY


RBAC_KEY

Re-exports RBAC_KEY


RbacAdminService

Re-exports RbacAdminService


rbacPlugin

Re-exports rbacPlugin


RbacService

Re-exports RbacService


ReadGroupRequest

Re-exports ReadGroupRequest


ReadSpec

Re-exports ReadSpec


Rec

Re-exports Rec


Record_

Re-exports Record_


RelatedField

Re-exports RelatedField


replayPrompt

Re-exports replayPrompt


RequestHandler

Re-exports RequestHandler


resolveActivate

Re-exports resolveActivate


Rights

Re-exports Rights


rightsOf

Re-exports rightsOf


Route

Re-exports Route


ROUTE_POINT

Re-exports ROUTE_POINT


RouteRequest

Re-exports RouteRequest


RouteResult

Re-exports RouteResult


RPC_METHODS

Re-exports RPC_METHODS


RpcCall

Re-exports RpcCall


RpcEnv

Re-exports RpcEnv


RpcMessage

Re-exports RpcMessage


RpcMethod

Re-exports RpcMethod


RpcOptions

Re-exports RpcOptions


rpcPlugin

Re-exports rpcPlugin


RpcResult

Re-exports RpcResult


Rule

Re-exports Rule


RULE_POINT

Re-exports RULE_POINT


runOne

Re-exports runOne


ScalarField

Re-exports ScalarField


ScalarKind

Re-exports ScalarKind


Schedule

Re-exports Schedule


SCHEDULE_POINT

Re-exports SCHEDULE_POINT


ScheduledJob

Re-exports ScheduledJob


SCHEDULER_KEY

Re-exports SCHEDULER_KEY


schedulerPlugin

Re-exports schedulerPlugin


SchedulerService

Re-exports SchedulerService


SearchOptions

Re-exports SearchOptions


SearchReadRequest

Re-exports SearchReadRequest


SelectionField

Re-exports SelectionField


serializeCookie

Re-exports serializeCookie


Session

Re-exports Session


Re-exports SESSION_COOKIE


SessionBackend

Re-exports SessionBackend


SessionBridge

Re-exports SessionBridge


SessionBridgeOptions

Re-exports SessionBridgeOptions


sha256

Re-exports sha256


sqlDialect

Re-exports sqlDialect


sse

Re-exports sse


Store

Re-exports Store


streamOf

Re-exports streamOf


SubdomainOptions

Re-exports SubdomainOptions


Subject

Re-exports Subject


sudo

Re-exports sudo


SystemPlugin

Re-exports SystemPlugin


TargetEntry

Re-exports TargetEntry


tenantFromHeader

Re-exports tenantFromHeader


tenantFromSubdomain

Re-exports tenantFromSubdomain


TenantResolver

Re-exports TenantResolver


text

Re-exports text


TickResult

Re-exports TickResult


toJson

Re-exports toJson


tokenOf

Re-exports tokenOf


Tool

Re-exports Tool


TOOL_POINT

Re-exports TOOL_POINT


ToolCallResult

Re-exports ToolCallResult


toolSignature

Re-exports toolSignature


toResponse

Re-exports toResponse


transcript

Re-exports transcript


Trust

Re-exports Trust


TRUST_RANK

Re-exports TRUST_RANK


unmarshal

Re-exports unmarshal


User

Re-exports User


validateAccess

Re-exports validateAccess


validateAction

Re-exports validateAction


validateField

Re-exports validateField


validateGroup

Re-exports validateGroup


validateMenu

Re-exports validateMenu


validateModel

Re-exports validateModel


validateModelField

Re-exports validateModelField


validateModelFieldSpec

Renames and re-exports validateField


validateRoute

Re-exports validateRoute


validateRule

Re-exports validateRule


validateSchedule

Re-exports validateSchedule


validateSchema

Re-exports validateSchema


validateView

Re-exports validateView


Values

Re-exports Values


Verdict

Re-exports Verdict


VerdictStatus

Re-exports VerdictStatus


verifyPassword

Re-exports verifyPassword


VIEW_POINT

Re-exports VIEW_POINT


ViewKind

Re-exports ViewKind


ViewNode

Re-exports ViewNode


ViewOp

Re-exports ViewOp


ViewSpec

Re-exports ViewSpec